~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Aaron Bentley
  • Date: 2005-07-29 17:19:16 UTC
  • mto: (1092.1.41) (1185.3.4) (974.1.47)
  • mto: This revision was merged to the branch mainline in revision 1020.
  • Revision ID: abentley@panoramicfeedback.com-20050729171916-322fd81b451d2e3e
Added merge-type parameter to merge.

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
19
 
import traceback, socket, fnmatch, difflib, time
20
 
from binascii import hexlify
 
18
import sys, os
21
19
 
22
20
import bzrlib
23
 
from inventory import Inventory
24
 
from trace import mutter, note
25
 
from tree import Tree, EmptyTree, RevisionTree
26
 
from inventory import InventoryEntry, Inventory
27
 
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
28
 
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
29
 
     joinpath, sha_string, file_kind, local_time_offset, appendpath
30
 
from store import ImmutableStore
31
 
from revision import Revision
32
 
from errors import bailout, BzrError
33
 
from textui import show_status
 
21
from bzrlib.trace import mutter, note
 
22
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, splitpath, \
 
23
     sha_file, appendpath, file_kind
 
24
from bzrlib.errors import BzrError
34
25
 
35
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
36
27
## TODO: Maybe include checks for common corruption of newlines, etc?
43
34
        return remotebranch.RemoteBranch(f, **args)
44
35
    else:
45
36
        return Branch(f, **args)
 
37
 
 
38
 
 
39
def find_cached_branch(f, cache_root, **args):
 
40
    from remotebranch import RemoteBranch
 
41
    br = find_branch(f, **args)
 
42
    def cacheify(br, store_name):
 
43
        from meta_store import CachedStore
 
44
        cache_path = os.path.join(cache_root, store_name)
 
45
        os.mkdir(cache_path)
 
46
        new_store = CachedStore(getattr(br, store_name), cache_path)
 
47
        setattr(br, store_name, new_store)
 
48
 
 
49
    if isinstance(br, RemoteBranch):
 
50
        cacheify(br, 'inventory_store')
 
51
        cacheify(br, 'text_store')
 
52
        cacheify(br, 'revision_store')
 
53
    return br
 
54
 
 
55
 
 
56
def _relpath(base, path):
 
57
    """Return path relative to base, or raise exception.
 
58
 
 
59
    The path may be either an absolute path or a path relative to the
 
60
    current working directory.
 
61
 
 
62
    Lifted out of Branch.relpath for ease of testing.
 
63
 
 
64
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
65
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
66
    avoids that problem."""
 
67
    rp = os.path.abspath(path)
 
68
 
 
69
    s = []
 
70
    head = rp
 
71
    while len(head) >= len(base):
 
72
        if head == base:
 
73
            break
 
74
        head, tail = os.path.split(head)
 
75
        if tail:
 
76
            s.insert(0, tail)
 
77
    else:
 
78
        from errors import NotBranchError
 
79
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
 
80
 
 
81
    return os.sep.join(s)
46
82
        
47
83
 
48
84
def find_branch_root(f=None):
75
111
            raise BzrError('%r is not in a branch' % orig_f)
76
112
        f = head
77
113
    
 
114
class DivergedBranches(Exception):
 
115
    def __init__(self, branch1, branch2):
 
116
        self.branch1 = branch1
 
117
        self.branch2 = branch2
 
118
        Exception.__init__(self, "These branches have diverged.")
 
119
 
 
120
 
 
121
class NoSuchRevision(BzrError):
 
122
    def __init__(self, branch, revision):
 
123
        self.branch = branch
 
124
        self.revision = revision
 
125
        msg = "Branch %s has no revision %d" % (branch, revision)
 
126
        BzrError.__init__(self, msg)
78
127
 
79
128
 
80
129
######################################################################
85
134
 
86
135
    base
87
136
        Base directory of the branch.
 
137
 
 
138
    _lock_mode
 
139
        None, or 'r' or 'w'
 
140
 
 
141
    _lock_count
 
142
        If _lock_mode is true, a positive count of the number of times the
 
143
        lock has been taken.
 
144
 
 
145
    _lock
 
146
        Lock object from bzrlib.lock.
88
147
    """
89
 
    _lockmode = None
90
148
    base = None
 
149
    _lock_mode = None
 
150
    _lock_count = None
 
151
    _lock = None
91
152
    
92
 
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
 
153
    # Map some sort of prefix into a namespace
 
154
    # stuff like "revno:10", "revid:", etc.
 
155
    # This should match a prefix with a function which accepts
 
156
    REVISION_NAMESPACES = {}
 
157
 
 
158
    def __init__(self, base, init=False, find_root=True):
93
159
        """Create new branch object at a particular location.
94
160
 
95
161
        base -- Base directory for the branch.
104
170
        In the test suite, creation of new trees is tested using the
105
171
        `ScratchBranch` class.
106
172
        """
 
173
        from bzrlib.store import ImmutableStore
107
174
        if init:
108
175
            self.base = os.path.realpath(base)
109
176
            self._make_control()
112
179
        else:
113
180
            self.base = os.path.realpath(base)
114
181
            if not isdir(self.controlfilename('.')):
115
 
                bailout("not a bzr branch: %s" % quotefn(base),
116
 
                        ['use "bzr init" to initialize a new working tree',
117
 
                         'current bzr can only operate from top-of-tree'])
 
182
                from errors import NotBranchError
 
183
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
 
184
                                     ['use "bzr init" to initialize a new working tree',
 
185
                                      'current bzr can only operate from top-of-tree'])
118
186
        self._check_format()
119
 
        self.lock(lock_mode)
120
187
 
121
188
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
122
189
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
130
197
    __repr__ = __str__
131
198
 
132
199
 
133
 
 
134
 
    def lock(self, mode='w'):
135
 
        """Lock the on-disk branch, excluding other processes."""
136
 
        try:
137
 
            import fcntl, errno
138
 
 
139
 
            if mode == 'w':
140
 
                lm = fcntl.LOCK_EX
141
 
                om = os.O_WRONLY | os.O_CREAT
142
 
            elif mode == 'r':
143
 
                lm = fcntl.LOCK_SH
144
 
                om = os.O_RDONLY
145
 
            else:
146
 
                raise BzrError("invalid locking mode %r" % mode)
147
 
 
148
 
            try:
149
 
                lockfile = os.open(self.controlfilename('branch-lock'), om)
150
 
            except OSError, e:
151
 
                if e.errno == errno.ENOENT:
152
 
                    # might not exist on branches from <0.0.4
153
 
                    self.controlfile('branch-lock', 'w').close()
154
 
                    lockfile = os.open(self.controlfilename('branch-lock'), om)
155
 
                else:
156
 
                    raise e
 
200
    def __del__(self):
 
201
        if self._lock_mode or self._lock:
 
202
            from warnings import warn
 
203
            warn("branch %r was not explicitly unlocked" % self)
 
204
            self._lock.unlock()
 
205
 
 
206
 
 
207
 
 
208
    def lock_write(self):
 
209
        if self._lock_mode:
 
210
            if self._lock_mode != 'w':
 
211
                from errors import LockError
 
212
                raise LockError("can't upgrade to a write lock from %r" %
 
213
                                self._lock_mode)
 
214
            self._lock_count += 1
 
215
        else:
 
216
            from bzrlib.lock import WriteLock
 
217
 
 
218
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
219
            self._lock_mode = 'w'
 
220
            self._lock_count = 1
 
221
 
 
222
 
 
223
 
 
224
    def lock_read(self):
 
225
        if self._lock_mode:
 
226
            assert self._lock_mode in ('r', 'w'), \
 
227
                   "invalid lock mode %r" % self._lock_mode
 
228
            self._lock_count += 1
 
229
        else:
 
230
            from bzrlib.lock import ReadLock
 
231
 
 
232
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
233
            self._lock_mode = 'r'
 
234
            self._lock_count = 1
 
235
                        
 
236
 
157
237
            
158
 
            fcntl.lockf(lockfile, lm)
159
 
            def unlock():
160
 
                fcntl.lockf(lockfile, fcntl.LOCK_UN)
161
 
                os.close(lockfile)
162
 
                self._lockmode = None
163
 
            self.unlock = unlock
164
 
            self._lockmode = mode
165
 
        except ImportError:
166
 
            warning("please write a locking method for platform %r" % sys.platform)
167
 
            def unlock():
168
 
                self._lockmode = None
169
 
            self.unlock = unlock
170
 
            self._lockmode = mode
171
 
 
172
 
 
173
 
    def _need_readlock(self):
174
 
        if self._lockmode not in ['r', 'w']:
175
 
            raise BzrError('need read lock on branch, only have %r' % self._lockmode)
176
 
 
177
 
    def _need_writelock(self):
178
 
        if self._lockmode not in ['w']:
179
 
            raise BzrError('need write lock on branch, only have %r' % self._lockmode)
 
238
    def unlock(self):
 
239
        if not self._lock_mode:
 
240
            from errors import LockError
 
241
            raise LockError('branch %r is not locked' % (self))
 
242
 
 
243
        if self._lock_count > 1:
 
244
            self._lock_count -= 1
 
245
        else:
 
246
            self._lock.unlock()
 
247
            self._lock = None
 
248
            self._lock_mode = self._lock_count = None
180
249
 
181
250
 
182
251
    def abspath(self, name):
188
257
        """Return path relative to this branch of something inside it.
189
258
 
190
259
        Raises an error if path is not in this branch."""
191
 
        rp = os.path.realpath(path)
192
 
        # FIXME: windows
193
 
        if not rp.startswith(self.base):
194
 
            bailout("path %r is not within branch %r" % (rp, self.base))
195
 
        rp = rp[len(self.base):]
196
 
        rp = rp.lstrip(os.sep)
197
 
        return rp
 
260
        return _relpath(self.base, path)
198
261
 
199
262
 
200
263
    def controlfilename(self, file_or_path):
201
264
        """Return location relative to branch."""
202
 
        if isinstance(file_or_path, types.StringTypes):
 
265
        if isinstance(file_or_path, basestring):
203
266
            file_or_path = [file_or_path]
204
267
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
205
268
 
232
295
 
233
296
 
234
297
    def _make_control(self):
 
298
        from bzrlib.inventory import Inventory
 
299
        from bzrlib.xml import pack_xml
 
300
        
235
301
        os.mkdir(self.controlfilename([]))
236
302
        self.controlfile('README', 'w').write(
237
303
            "This is a Bazaar-NG control directory.\n"
238
 
            "Do not change any files in this directory.")
 
304
            "Do not change any files in this directory.\n")
239
305
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
240
306
        for d in ('text-store', 'inventory-store', 'revision-store'):
241
307
            os.mkdir(self.controlfilename(d))
242
308
        for f in ('revision-history', 'merged-patches',
243
309
                  'pending-merged-patches', 'branch-name',
244
 
                  'branch-lock'):
 
310
                  'branch-lock',
 
311
                  'pending-merges'):
245
312
            self.controlfile(f, 'w').write('')
246
313
        mutter('created control directory in ' + self.base)
247
 
        Inventory().write_xml(self.controlfile('inventory','w'))
 
314
 
 
315
        pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
248
316
 
249
317
 
250
318
    def _check_format(self):
261
329
        fmt = self.controlfile('branch-format', 'r').read()
262
330
        fmt.replace('\r\n', '')
263
331
        if fmt != BZR_BRANCH_FORMAT:
264
 
            bailout('sorry, branch format %r not supported' % fmt,
265
 
                    ['use a different bzr version',
266
 
                     'or remove the .bzr directory and "bzr init" again'])
267
 
 
 
332
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
333
                           ['use a different bzr version',
 
334
                            'or remove the .bzr directory and "bzr init" again'])
 
335
 
 
336
    def get_root_id(self):
 
337
        """Return the id of this branches root"""
 
338
        inv = self.read_working_inventory()
 
339
        return inv.root.file_id
 
340
 
 
341
    def set_root_id(self, file_id):
 
342
        inv = self.read_working_inventory()
 
343
        orig_root_id = inv.root.file_id
 
344
        del inv._byid[inv.root.file_id]
 
345
        inv.root.file_id = file_id
 
346
        inv._byid[inv.root.file_id] = inv.root
 
347
        for fid in inv:
 
348
            entry = inv[fid]
 
349
            if entry.parent_id in (None, orig_root_id):
 
350
                entry.parent_id = inv.root.file_id
 
351
        self._write_inventory(inv)
268
352
 
269
353
    def read_working_inventory(self):
270
354
        """Read the working inventory."""
271
 
        self._need_readlock()
272
 
        before = time.time()
273
 
        # ElementTree does its own conversion from UTF-8, so open in
274
 
        # binary.
275
 
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
276
 
        mutter("loaded inventory of %d items in %f"
277
 
               % (len(inv), time.time() - before))
278
 
        return inv
279
 
 
 
355
        from bzrlib.inventory import Inventory
 
356
        from bzrlib.xml import unpack_xml
 
357
        from time import time
 
358
        before = time()
 
359
        self.lock_read()
 
360
        try:
 
361
            # ElementTree does its own conversion from UTF-8, so open in
 
362
            # binary.
 
363
            inv = unpack_xml(Inventory,
 
364
                             self.controlfile('inventory', 'rb'))
 
365
            mutter("loaded inventory of %d items in %f"
 
366
                   % (len(inv), time() - before))
 
367
            return inv
 
368
        finally:
 
369
            self.unlock()
 
370
            
280
371
 
281
372
    def _write_inventory(self, inv):
282
373
        """Update the working inventory.
284
375
        That is to say, the inventory describing changes underway, that
285
376
        will be committed to the next revision.
286
377
        """
287
 
        self._need_writelock()
288
 
        ## TODO: factor out to atomicfile?  is rename safe on windows?
289
 
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
290
 
        tmpfname = self.controlfilename('inventory.tmp')
291
 
        tmpf = file(tmpfname, 'wb')
292
 
        inv.write_xml(tmpf)
293
 
        tmpf.close()
294
 
        inv_fname = self.controlfilename('inventory')
295
 
        if sys.platform == 'win32':
296
 
            os.remove(inv_fname)
297
 
        os.rename(tmpfname, inv_fname)
 
378
        from bzrlib.atomicfile import AtomicFile
 
379
        from bzrlib.xml import pack_xml
 
380
        
 
381
        self.lock_write()
 
382
        try:
 
383
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
 
384
            try:
 
385
                pack_xml(inv, f)
 
386
                f.commit()
 
387
            finally:
 
388
                f.close()
 
389
        finally:
 
390
            self.unlock()
 
391
        
298
392
        mutter('wrote working inventory')
299
 
 
 
393
            
300
394
 
301
395
    inventory = property(read_working_inventory, _write_inventory, None,
302
396
                         """Inventory for the working copy.""")
310
404
        This puts the files in the Added state, so that they will be
311
405
        recorded by the next commit.
312
406
 
 
407
        files
 
408
            List of paths to add, relative to the base of the tree.
 
409
 
 
410
        ids
 
411
            If set, use these instead of automatically generated ids.
 
412
            Must be the same length as the list of files, but may
 
413
            contain None for ids that are to be autogenerated.
 
414
 
313
415
        TODO: Perhaps have an option to add the ids even if the files do
314
 
               not (yet) exist.
 
416
              not (yet) exist.
315
417
 
316
418
        TODO: Perhaps return the ids of the files?  But then again it
317
 
               is easy to retrieve them if they're needed.
318
 
 
319
 
        TODO: Option to specify file id.
 
419
              is easy to retrieve them if they're needed.
320
420
 
321
421
        TODO: Adding a directory should optionally recurse down and
322
 
               add all non-ignored children.  Perhaps do that in a
323
 
               higher-level method.
 
422
              add all non-ignored children.  Perhaps do that in a
 
423
              higher-level method.
324
424
        """
325
 
        self._need_writelock()
326
 
 
 
425
        from bzrlib.textui import show_status
327
426
        # TODO: Re-adding a file that is removed in the working copy
328
427
        # should probably put it back with the previous ID.
329
 
        if isinstance(files, types.StringTypes):
330
 
            assert(ids is None or isinstance(ids, types.StringTypes))
 
428
        if isinstance(files, basestring):
 
429
            assert(ids is None or isinstance(ids, basestring))
331
430
            files = [files]
332
431
            if ids is not None:
333
432
                ids = [ids]
336
435
            ids = [None] * len(files)
337
436
        else:
338
437
            assert(len(ids) == len(files))
339
 
        
340
 
        inv = self.read_working_inventory()
341
 
        for f,file_id in zip(files, ids):
342
 
            if is_control_file(f):
343
 
                bailout("cannot add control file %s" % quotefn(f))
344
 
 
345
 
            fp = splitpath(f)
346
 
 
347
 
            if len(fp) == 0:
348
 
                bailout("cannot add top-level %r" % f)
349
 
                
350
 
            fullpath = os.path.normpath(self.abspath(f))
351
 
 
352
 
            try:
353
 
                kind = file_kind(fullpath)
354
 
            except OSError:
355
 
                # maybe something better?
356
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
357
 
            
358
 
            if kind != 'file' and kind != 'directory':
359
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
360
 
 
361
 
            if file_id is None:
362
 
                file_id = gen_file_id(f)
363
 
            inv.add_path(f, kind=kind, file_id=file_id)
364
 
 
365
 
            if verbose:
366
 
                show_status('A', kind, quotefn(f))
367
 
                
368
 
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
369
 
            
370
 
        self._write_inventory(inv)
371
 
 
 
438
 
 
439
        self.lock_write()
 
440
        try:
 
441
            inv = self.read_working_inventory()
 
442
            for f,file_id in zip(files, ids):
 
443
                if is_control_file(f):
 
444
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
445
 
 
446
                fp = splitpath(f)
 
447
 
 
448
                if len(fp) == 0:
 
449
                    raise BzrError("cannot add top-level %r" % f)
 
450
 
 
451
                fullpath = os.path.normpath(self.abspath(f))
 
452
 
 
453
                try:
 
454
                    kind = file_kind(fullpath)
 
455
                except OSError:
 
456
                    # maybe something better?
 
457
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
458
 
 
459
                if kind != 'file' and kind != 'directory':
 
460
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
461
 
 
462
                if file_id is None:
 
463
                    file_id = gen_file_id(f)
 
464
                inv.add_path(f, kind=kind, file_id=file_id)
 
465
 
 
466
                if verbose:
 
467
                    print 'added', quotefn(f)
 
468
 
 
469
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
470
 
 
471
            self._write_inventory(inv)
 
472
        finally:
 
473
            self.unlock()
 
474
            
372
475
 
373
476
    def print_file(self, file, revno):
374
477
        """Print `file` to stdout."""
375
 
        self._need_readlock()
376
 
        tree = self.revision_tree(self.lookup_revision(revno))
377
 
        # use inventory as it was in that revision
378
 
        file_id = tree.inventory.path2id(file)
379
 
        if not file_id:
380
 
            bailout("%r is not present in revision %d" % (file, revno))
381
 
        tree.print_file(file_id)
382
 
        
 
478
        self.lock_read()
 
479
        try:
 
480
            tree = self.revision_tree(self.lookup_revision(revno))
 
481
            # use inventory as it was in that revision
 
482
            file_id = tree.inventory.path2id(file)
 
483
            if not file_id:
 
484
                raise BzrError("%r is not present in revision %s" % (file, revno))
 
485
            tree.print_file(file_id)
 
486
        finally:
 
487
            self.unlock()
 
488
 
383
489
 
384
490
    def remove(self, files, verbose=False):
385
491
        """Mark nominated files for removal from the inventory.
395
501
        is the opposite of add.  Removing it is consistent with most
396
502
        other tools.  Maybe an option.
397
503
        """
 
504
        from bzrlib.textui import show_status
398
505
        ## TODO: Normalize names
399
506
        ## TODO: Remove nested loops; better scalability
400
 
        self._need_writelock()
401
 
 
402
 
        if isinstance(files, types.StringTypes):
 
507
        if isinstance(files, basestring):
403
508
            files = [files]
404
 
        
405
 
        tree = self.working_tree()
406
 
        inv = tree.inventory
407
 
 
408
 
        # do this before any modifications
409
 
        for f in files:
410
 
            fid = inv.path2id(f)
411
 
            if not fid:
412
 
                bailout("cannot remove unversioned file %s" % quotefn(f))
413
 
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
414
 
            if verbose:
415
 
                # having remove it, it must be either ignored or unknown
416
 
                if tree.is_ignored(f):
417
 
                    new_status = 'I'
418
 
                else:
419
 
                    new_status = '?'
420
 
                show_status(new_status, inv[fid].kind, quotefn(f))
421
 
            del inv[fid]
422
 
 
423
 
        self._write_inventory(inv)
424
 
 
 
509
 
 
510
        self.lock_write()
 
511
 
 
512
        try:
 
513
            tree = self.working_tree()
 
514
            inv = tree.inventory
 
515
 
 
516
            # do this before any modifications
 
517
            for f in files:
 
518
                fid = inv.path2id(f)
 
519
                if not fid:
 
520
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
 
521
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
522
                if verbose:
 
523
                    # having remove it, it must be either ignored or unknown
 
524
                    if tree.is_ignored(f):
 
525
                        new_status = 'I'
 
526
                    else:
 
527
                        new_status = '?'
 
528
                    show_status(new_status, inv[fid].kind, quotefn(f))
 
529
                del inv[fid]
 
530
 
 
531
            self._write_inventory(inv)
 
532
        finally:
 
533
            self.unlock()
 
534
 
 
535
 
 
536
    # FIXME: this doesn't need to be a branch method
425
537
    def set_inventory(self, new_inventory_list):
426
 
        inv = Inventory()
 
538
        from bzrlib.inventory import Inventory, InventoryEntry
 
539
        inv = Inventory(self.get_root_id())
427
540
        for path, file_id, parent, kind in new_inventory_list:
428
541
            name = os.path.basename(path)
429
542
            if name == "":
451
564
        return self.working_tree().unknowns()
452
565
 
453
566
 
454
 
    def append_revision(self, revision_id):
455
 
        mutter("add {%s} to revision-history" % revision_id)
 
567
    def append_revision(self, *revision_ids):
 
568
        from bzrlib.atomicfile import AtomicFile
 
569
 
 
570
        for revision_id in revision_ids:
 
571
            mutter("add {%s} to revision-history" % revision_id)
 
572
 
456
573
        rev_history = self.revision_history()
457
 
 
458
 
        tmprhname = self.controlfilename('revision-history.tmp')
459
 
        rhname = self.controlfilename('revision-history')
460
 
        
461
 
        f = file(tmprhname, 'wt')
462
 
        rev_history.append(revision_id)
463
 
        f.write('\n'.join(rev_history))
464
 
        f.write('\n')
465
 
        f.close()
466
 
 
467
 
        if sys.platform == 'win32':
468
 
            os.remove(rhname)
469
 
        os.rename(tmprhname, rhname)
470
 
        
 
574
        rev_history.extend(revision_ids)
 
575
 
 
576
        f = AtomicFile(self.controlfilename('revision-history'))
 
577
        try:
 
578
            for rev_id in rev_history:
 
579
                print >>f, rev_id
 
580
            f.commit()
 
581
        finally:
 
582
            f.close()
471
583
 
472
584
 
473
585
    def get_revision(self, revision_id):
474
586
        """Return the Revision object for a named revision"""
475
 
        self._need_readlock()
476
 
        r = Revision.read_xml(self.revision_store[revision_id])
 
587
        from bzrlib.revision import Revision
 
588
        from bzrlib.xml import unpack_xml
 
589
 
 
590
        self.lock_read()
 
591
        try:
 
592
            if not revision_id or not isinstance(revision_id, basestring):
 
593
                raise ValueError('invalid revision-id: %r' % revision_id)
 
594
            r = unpack_xml(Revision, self.revision_store[revision_id])
 
595
        finally:
 
596
            self.unlock()
 
597
            
477
598
        assert r.revision_id == revision_id
478
599
        return r
 
600
        
 
601
 
 
602
    def get_revision_sha1(self, revision_id):
 
603
        """Hash the stored value of a revision, and return it."""
 
604
        # In the future, revision entries will be signed. At that
 
605
        # point, it is probably best *not* to include the signature
 
606
        # in the revision hash. Because that lets you re-sign
 
607
        # the revision, (add signatures/remove signatures) and still
 
608
        # have all hash pointers stay consistent.
 
609
        # But for now, just hash the contents.
 
610
        return sha_file(self.revision_store[revision_id])
479
611
 
480
612
 
481
613
    def get_inventory(self, inventory_id):
484
616
        TODO: Perhaps for this and similar methods, take a revision
485
617
               parameter which can be either an integer revno or a
486
618
               string hash."""
487
 
        self._need_readlock()
488
 
        i = Inventory.read_xml(self.inventory_store[inventory_id])
489
 
        return i
 
619
        from bzrlib.inventory import Inventory
 
620
        from bzrlib.xml import unpack_xml
 
621
 
 
622
        return unpack_xml(Inventory, self.inventory_store[inventory_id])
 
623
            
 
624
 
 
625
    def get_inventory_sha1(self, inventory_id):
 
626
        """Return the sha1 hash of the inventory entry
 
627
        """
 
628
        return sha_file(self.inventory_store[inventory_id])
490
629
 
491
630
 
492
631
    def get_revision_inventory(self, revision_id):
493
632
        """Return inventory of a past revision."""
494
 
        self._need_readlock()
 
633
        # bzr 0.0.6 imposes the constraint that the inventory_id
 
634
        # must be the same as its revision, so this is trivial.
495
635
        if revision_id == None:
496
 
            return Inventory()
 
636
            from bzrlib.inventory import Inventory
 
637
            return Inventory(self.get_root_id())
497
638
        else:
498
 
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
639
            return self.get_inventory(revision_id)
499
640
 
500
641
 
501
642
    def revision_history(self):
504
645
        >>> ScratchBranch().revision_history()
505
646
        []
506
647
        """
507
 
        self._need_readlock()
508
 
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
509
 
 
 
648
        self.lock_read()
 
649
        try:
 
650
            return [l.rstrip('\r\n') for l in
 
651
                    self.controlfile('revision-history', 'r').readlines()]
 
652
        finally:
 
653
            self.unlock()
 
654
 
 
655
 
 
656
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
657
        """
 
658
        >>> import commit
 
659
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
660
        >>> sb.common_ancestor(sb) == (None, None)
 
661
        True
 
662
        >>> commit.commit(sb, "Committing first revision", verbose=False)
 
663
        >>> sb.common_ancestor(sb)[0]
 
664
        1
 
665
        >>> clone = sb.clone()
 
666
        >>> commit.commit(sb, "Committing second revision", verbose=False)
 
667
        >>> sb.common_ancestor(sb)[0]
 
668
        2
 
669
        >>> sb.common_ancestor(clone)[0]
 
670
        1
 
671
        >>> commit.commit(clone, "Committing divergent second revision", 
 
672
        ...               verbose=False)
 
673
        >>> sb.common_ancestor(clone)[0]
 
674
        1
 
675
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
676
        True
 
677
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
678
        True
 
679
        >>> clone2 = sb.clone()
 
680
        >>> sb.common_ancestor(clone2)[0]
 
681
        2
 
682
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
683
        1
 
684
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
685
        1
 
686
        """
 
687
        my_history = self.revision_history()
 
688
        other_history = other.revision_history()
 
689
        if self_revno is None:
 
690
            self_revno = len(my_history)
 
691
        if other_revno is None:
 
692
            other_revno = len(other_history)
 
693
        indices = range(min((self_revno, other_revno)))
 
694
        indices.reverse()
 
695
        for r in indices:
 
696
            if my_history[r] == other_history[r]:
 
697
                return r+1, my_history[r]
 
698
        return None, None
510
699
 
511
700
    def enum_history(self, direction):
512
701
        """Return (revno, revision_id) for history of branch.
549
738
            return None
550
739
 
551
740
 
 
741
    def missing_revisions(self, other, stop_revision=None):
 
742
        """
 
743
        If self and other have not diverged, return a list of the revisions
 
744
        present in other, but missing from self.
 
745
 
 
746
        >>> from bzrlib.commit import commit
 
747
        >>> bzrlib.trace.silent = True
 
748
        >>> br1 = ScratchBranch()
 
749
        >>> br2 = ScratchBranch()
 
750
        >>> br1.missing_revisions(br2)
 
751
        []
 
752
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
753
        >>> br1.missing_revisions(br2)
 
754
        [u'REVISION-ID-1']
 
755
        >>> br2.missing_revisions(br1)
 
756
        []
 
757
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
758
        >>> br1.missing_revisions(br2)
 
759
        []
 
760
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
761
        >>> br1.missing_revisions(br2)
 
762
        [u'REVISION-ID-2A']
 
763
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
764
        >>> br1.missing_revisions(br2)
 
765
        Traceback (most recent call last):
 
766
        DivergedBranches: These branches have diverged.
 
767
        """
 
768
        self_history = self.revision_history()
 
769
        self_len = len(self_history)
 
770
        other_history = other.revision_history()
 
771
        other_len = len(other_history)
 
772
        common_index = min(self_len, other_len) -1
 
773
        if common_index >= 0 and \
 
774
            self_history[common_index] != other_history[common_index]:
 
775
            raise DivergedBranches(self, other)
 
776
 
 
777
        if stop_revision is None:
 
778
            stop_revision = other_len
 
779
        elif stop_revision > other_len:
 
780
            raise NoSuchRevision(self, stop_revision)
 
781
        
 
782
        return other_history[self_len:stop_revision]
 
783
 
 
784
 
 
785
    def update_revisions(self, other, stop_revision=None):
 
786
        """Pull in all new revisions from other branch.
 
787
        
 
788
        >>> from bzrlib.commit import commit
 
789
        >>> bzrlib.trace.silent = True
 
790
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
 
791
        >>> br1.add('foo')
 
792
        >>> br1.add('bar')
 
793
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
 
794
        >>> br2 = ScratchBranch()
 
795
        >>> br2.update_revisions(br1)
 
796
        Added 2 texts.
 
797
        Added 1 inventories.
 
798
        Added 1 revisions.
 
799
        >>> br2.revision_history()
 
800
        [u'REVISION-ID-1']
 
801
        >>> br2.update_revisions(br1)
 
802
        Added 0 texts.
 
803
        Added 0 inventories.
 
804
        Added 0 revisions.
 
805
        >>> br1.text_store.total_size() == br2.text_store.total_size()
 
806
        True
 
807
        """
 
808
        from bzrlib.progress import ProgressBar
 
809
 
 
810
        pb = ProgressBar()
 
811
 
 
812
        pb.update('comparing histories')
 
813
        revision_ids = self.missing_revisions(other, stop_revision)
 
814
 
 
815
        if hasattr(other.revision_store, "prefetch"):
 
816
            other.revision_store.prefetch(revision_ids)
 
817
        if hasattr(other.inventory_store, "prefetch"):
 
818
            inventory_ids = [other.get_revision(r).inventory_id
 
819
                             for r in revision_ids]
 
820
            other.inventory_store.prefetch(inventory_ids)
 
821
                
 
822
        revisions = []
 
823
        needed_texts = set()
 
824
        i = 0
 
825
        for rev_id in revision_ids:
 
826
            i += 1
 
827
            pb.update('fetching revision', i, len(revision_ids))
 
828
            rev = other.get_revision(rev_id)
 
829
            revisions.append(rev)
 
830
            inv = other.get_inventory(str(rev.inventory_id))
 
831
            for key, entry in inv.iter_entries():
 
832
                if entry.text_id is None:
 
833
                    continue
 
834
                if entry.text_id not in self.text_store:
 
835
                    needed_texts.add(entry.text_id)
 
836
 
 
837
        pb.clear()
 
838
                    
 
839
        count = self.text_store.copy_multi(other.text_store, needed_texts)
 
840
        print "Added %d texts." % count 
 
841
        inventory_ids = [ f.inventory_id for f in revisions ]
 
842
        count = self.inventory_store.copy_multi(other.inventory_store, 
 
843
                                                inventory_ids)
 
844
        print "Added %d inventories." % count 
 
845
        revision_ids = [ f.revision_id for f in revisions]
 
846
        count = self.revision_store.copy_multi(other.revision_store, 
 
847
                                               revision_ids)
 
848
        for revision_id in revision_ids:
 
849
            self.append_revision(revision_id)
 
850
        print "Added %d revisions." % count
 
851
                    
 
852
        
552
853
    def commit(self, *args, **kw):
553
 
        """Deprecated"""
554
854
        from bzrlib.commit import commit
555
855
        commit(self, *args, **kw)
556
856
        
557
857
 
558
 
    def lookup_revision(self, revno):
559
 
        """Return revision hash for revision number."""
560
 
        if revno == 0:
561
 
            return None
562
 
 
563
 
        try:
564
 
            # list is 0-based; revisions are 1-based
565
 
            return self.revision_history()[revno-1]
566
 
        except IndexError:
567
 
            raise BzrError("no such revision %s" % revno)
568
 
 
 
858
    def lookup_revision(self, revision):
 
859
        """Return the revision identifier for a given revision information."""
 
860
        revno, info = self.get_revision_info(revision)
 
861
        return info
 
862
 
 
863
    def get_revision_info(self, revision):
 
864
        """Return (revno, revision id) for revision identifier.
 
865
 
 
866
        revision can be an integer, in which case it is assumed to be revno (though
 
867
            this will translate negative values into positive ones)
 
868
        revision can also be a string, in which case it is parsed for something like
 
869
            'date:' or 'revid:' etc.
 
870
        """
 
871
        if revision is None:
 
872
            return 0, None
 
873
        revno = None
 
874
        try:# Convert to int if possible
 
875
            revision = int(revision)
 
876
        except ValueError:
 
877
            pass
 
878
        revs = self.revision_history()
 
879
        if isinstance(revision, int):
 
880
            if revision == 0:
 
881
                return 0, None
 
882
            # Mabye we should do this first, but we don't need it if revision == 0
 
883
            if revision < 0:
 
884
                revno = len(revs) + revision + 1
 
885
            else:
 
886
                revno = revision
 
887
        elif isinstance(revision, basestring):
 
888
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
 
889
                if revision.startswith(prefix):
 
890
                    revno = func(self, revs, revision)
 
891
                    break
 
892
            else:
 
893
                raise BzrError('No namespace registered for string: %r' % revision)
 
894
 
 
895
        if revno is None or revno <= 0 or revno > len(revs):
 
896
            raise BzrError("no such revision %s" % revision)
 
897
        return revno, revs[revno-1]
 
898
 
 
899
    def _namespace_revno(self, revs, revision):
 
900
        """Lookup a revision by revision number"""
 
901
        assert revision.startswith('revno:')
 
902
        try:
 
903
            return int(revision[6:])
 
904
        except ValueError:
 
905
            return None
 
906
    REVISION_NAMESPACES['revno:'] = _namespace_revno
 
907
 
 
908
    def _namespace_revid(self, revs, revision):
 
909
        assert revision.startswith('revid:')
 
910
        try:
 
911
            return revs.index(revision[6:]) + 1
 
912
        except ValueError:
 
913
            return None
 
914
    REVISION_NAMESPACES['revid:'] = _namespace_revid
 
915
 
 
916
    def _namespace_last(self, revs, revision):
 
917
        assert revision.startswith('last:')
 
918
        try:
 
919
            offset = int(revision[5:])
 
920
        except ValueError:
 
921
            return None
 
922
        else:
 
923
            if offset <= 0:
 
924
                raise BzrError('You must supply a positive value for --revision last:XXX')
 
925
            return len(revs) - offset + 1
 
926
    REVISION_NAMESPACES['last:'] = _namespace_last
 
927
 
 
928
    def _namespace_tag(self, revs, revision):
 
929
        assert revision.startswith('tag:')
 
930
        raise BzrError('tag: namespace registered, but not implemented.')
 
931
    REVISION_NAMESPACES['tag:'] = _namespace_tag
 
932
 
 
933
    def _namespace_date(self, revs, revision):
 
934
        assert revision.startswith('date:')
 
935
        import datetime
 
936
        # Spec for date revisions:
 
937
        #   date:value
 
938
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
 
939
        #   it can also start with a '+/-/='. '+' says match the first
 
940
        #   entry after the given date. '-' is match the first entry before the date
 
941
        #   '=' is match the first entry after, but still on the given date.
 
942
        #
 
943
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
 
944
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
 
945
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
 
946
        #       May 13th, 2005 at 0:00
 
947
        #
 
948
        #   So the proper way of saying 'give me all entries for today' is:
 
949
        #       -r {date:+today}:{date:-tomorrow}
 
950
        #   The default is '=' when not supplied
 
951
        val = revision[5:]
 
952
        match_style = '='
 
953
        if val[:1] in ('+', '-', '='):
 
954
            match_style = val[:1]
 
955
            val = val[1:]
 
956
 
 
957
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
 
958
        if val.lower() == 'yesterday':
 
959
            dt = today - datetime.timedelta(days=1)
 
960
        elif val.lower() == 'today':
 
961
            dt = today
 
962
        elif val.lower() == 'tomorrow':
 
963
            dt = today + datetime.timedelta(days=1)
 
964
        else:
 
965
            import re
 
966
            # This should be done outside the function to avoid recompiling it.
 
967
            _date_re = re.compile(
 
968
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
 
969
                    r'(,|T)?\s*'
 
970
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
 
971
                )
 
972
            m = _date_re.match(val)
 
973
            if not m or (not m.group('date') and not m.group('time')):
 
974
                raise BzrError('Invalid revision date %r' % revision)
 
975
 
 
976
            if m.group('date'):
 
977
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
 
978
            else:
 
979
                year, month, day = today.year, today.month, today.day
 
980
            if m.group('time'):
 
981
                hour = int(m.group('hour'))
 
982
                minute = int(m.group('minute'))
 
983
                if m.group('second'):
 
984
                    second = int(m.group('second'))
 
985
                else:
 
986
                    second = 0
 
987
            else:
 
988
                hour, minute, second = 0,0,0
 
989
 
 
990
            dt = datetime.datetime(year=year, month=month, day=day,
 
991
                    hour=hour, minute=minute, second=second)
 
992
        first = dt
 
993
        last = None
 
994
        reversed = False
 
995
        if match_style == '-':
 
996
            reversed = True
 
997
        elif match_style == '=':
 
998
            last = dt + datetime.timedelta(days=1)
 
999
 
 
1000
        if reversed:
 
1001
            for i in range(len(revs)-1, -1, -1):
 
1002
                r = self.get_revision(revs[i])
 
1003
                # TODO: Handle timezone.
 
1004
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1005
                if first >= dt and (last is None or dt >= last):
 
1006
                    return i+1
 
1007
        else:
 
1008
            for i in range(len(revs)):
 
1009
                r = self.get_revision(revs[i])
 
1010
                # TODO: Handle timezone.
 
1011
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1012
                if first <= dt and (last is None or dt <= last):
 
1013
                    return i+1
 
1014
    REVISION_NAMESPACES['date:'] = _namespace_date
569
1015
 
570
1016
    def revision_tree(self, revision_id):
571
1017
        """Return Tree for a revision on this branch.
572
1018
 
573
1019
        `revision_id` may be None for the null revision, in which case
574
1020
        an `EmptyTree` is returned."""
 
1021
        from bzrlib.tree import EmptyTree, RevisionTree
575
1022
        # TODO: refactor this to use an existing revision object
576
1023
        # so we don't need to read it in twice.
577
 
        self._need_readlock()
578
1024
        if revision_id == None:
579
 
            return EmptyTree()
 
1025
            return EmptyTree(self.get_root_id())
580
1026
        else:
581
1027
            inv = self.get_revision_inventory(revision_id)
582
1028
            return RevisionTree(self.text_store, inv)
593
1039
 
594
1040
        If there are no revisions yet, return an `EmptyTree`.
595
1041
        """
 
1042
        from bzrlib.tree import EmptyTree, RevisionTree
596
1043
        r = self.last_patch()
597
1044
        if r == None:
598
 
            return EmptyTree()
 
1045
            return EmptyTree(self.get_root_id())
599
1046
        else:
600
1047
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
601
1048
 
606
1053
 
607
1054
        This can change the directory or the filename or both.
608
1055
        """
609
 
        self._need_writelock()
610
 
        tree = self.working_tree()
611
 
        inv = tree.inventory
612
 
        if not tree.has_filename(from_rel):
613
 
            bailout("can't rename: old working file %r does not exist" % from_rel)
614
 
        if tree.has_filename(to_rel):
615
 
            bailout("can't rename: new working file %r already exists" % to_rel)
616
 
            
617
 
        file_id = inv.path2id(from_rel)
618
 
        if file_id == None:
619
 
            bailout("can't rename: old name %r is not versioned" % from_rel)
620
 
 
621
 
        if inv.path2id(to_rel):
622
 
            bailout("can't rename: new name %r is already versioned" % to_rel)
623
 
 
624
 
        to_dir, to_tail = os.path.split(to_rel)
625
 
        to_dir_id = inv.path2id(to_dir)
626
 
        if to_dir_id == None and to_dir != '':
627
 
            bailout("can't determine destination directory id for %r" % to_dir)
628
 
 
629
 
        mutter("rename_one:")
630
 
        mutter("  file_id    {%s}" % file_id)
631
 
        mutter("  from_rel   %r" % from_rel)
632
 
        mutter("  to_rel     %r" % to_rel)
633
 
        mutter("  to_dir     %r" % to_dir)
634
 
        mutter("  to_dir_id  {%s}" % to_dir_id)
635
 
            
636
 
        inv.rename(file_id, to_dir_id, to_tail)
637
 
 
638
 
        print "%s => %s" % (from_rel, to_rel)
639
 
        
640
 
        from_abs = self.abspath(from_rel)
641
 
        to_abs = self.abspath(to_rel)
 
1056
        self.lock_write()
642
1057
        try:
643
 
            os.rename(from_abs, to_abs)
644
 
        except OSError, e:
645
 
            bailout("failed to rename %r to %r: %s"
646
 
                    % (from_abs, to_abs, e[1]),
647
 
                    ["rename rolled back"])
648
 
 
649
 
        self._write_inventory(inv)
650
 
            
 
1058
            tree = self.working_tree()
 
1059
            inv = tree.inventory
 
1060
            if not tree.has_filename(from_rel):
 
1061
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
1062
            if tree.has_filename(to_rel):
 
1063
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
1064
 
 
1065
            file_id = inv.path2id(from_rel)
 
1066
            if file_id == None:
 
1067
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
1068
 
 
1069
            if inv.path2id(to_rel):
 
1070
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
1071
 
 
1072
            to_dir, to_tail = os.path.split(to_rel)
 
1073
            to_dir_id = inv.path2id(to_dir)
 
1074
            if to_dir_id == None and to_dir != '':
 
1075
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
1076
 
 
1077
            mutter("rename_one:")
 
1078
            mutter("  file_id    {%s}" % file_id)
 
1079
            mutter("  from_rel   %r" % from_rel)
 
1080
            mutter("  to_rel     %r" % to_rel)
 
1081
            mutter("  to_dir     %r" % to_dir)
 
1082
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
1083
 
 
1084
            inv.rename(file_id, to_dir_id, to_tail)
 
1085
 
 
1086
            print "%s => %s" % (from_rel, to_rel)
 
1087
 
 
1088
            from_abs = self.abspath(from_rel)
 
1089
            to_abs = self.abspath(to_rel)
 
1090
            try:
 
1091
                os.rename(from_abs, to_abs)
 
1092
            except OSError, e:
 
1093
                raise BzrError("failed to rename %r to %r: %s"
 
1094
                        % (from_abs, to_abs, e[1]),
 
1095
                        ["rename rolled back"])
 
1096
 
 
1097
            self._write_inventory(inv)
 
1098
        finally:
 
1099
            self.unlock()
651
1100
 
652
1101
 
653
1102
    def move(self, from_paths, to_name):
661
1110
        Note that to_name is only the last component of the new name;
662
1111
        this doesn't change the directory.
663
1112
        """
664
 
        self._need_writelock()
665
 
        ## TODO: Option to move IDs only
666
 
        assert not isinstance(from_paths, basestring)
667
 
        tree = self.working_tree()
668
 
        inv = tree.inventory
669
 
        to_abs = self.abspath(to_name)
670
 
        if not isdir(to_abs):
671
 
            bailout("destination %r is not a directory" % to_abs)
672
 
        if not tree.has_filename(to_name):
673
 
            bailout("destination %r not in working directory" % to_abs)
674
 
        to_dir_id = inv.path2id(to_name)
675
 
        if to_dir_id == None and to_name != '':
676
 
            bailout("destination %r is not a versioned directory" % to_name)
677
 
        to_dir_ie = inv[to_dir_id]
678
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
679
 
            bailout("destination %r is not a directory" % to_abs)
680
 
 
681
 
        to_idpath = inv.get_idpath(to_dir_id)
682
 
 
683
 
        for f in from_paths:
684
 
            if not tree.has_filename(f):
685
 
                bailout("%r does not exist in working tree" % f)
686
 
            f_id = inv.path2id(f)
687
 
            if f_id == None:
688
 
                bailout("%r is not versioned" % f)
689
 
            name_tail = splitpath(f)[-1]
690
 
            dest_path = appendpath(to_name, name_tail)
691
 
            if tree.has_filename(dest_path):
692
 
                bailout("destination %r already exists" % dest_path)
693
 
            if f_id in to_idpath:
694
 
                bailout("can't move %r to a subdirectory of itself" % f)
695
 
 
696
 
        # OK, so there's a race here, it's possible that someone will
697
 
        # create a file in this interval and then the rename might be
698
 
        # left half-done.  But we should have caught most problems.
699
 
 
700
 
        for f in from_paths:
701
 
            name_tail = splitpath(f)[-1]
702
 
            dest_path = appendpath(to_name, name_tail)
703
 
            print "%s => %s" % (f, dest_path)
704
 
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
705
 
            try:
706
 
                os.rename(self.abspath(f), self.abspath(dest_path))
707
 
            except OSError, e:
708
 
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
709
 
                        ["rename rolled back"])
710
 
 
711
 
        self._write_inventory(inv)
712
 
 
 
1113
        self.lock_write()
 
1114
        try:
 
1115
            ## TODO: Option to move IDs only
 
1116
            assert not isinstance(from_paths, basestring)
 
1117
            tree = self.working_tree()
 
1118
            inv = tree.inventory
 
1119
            to_abs = self.abspath(to_name)
 
1120
            if not isdir(to_abs):
 
1121
                raise BzrError("destination %r is not a directory" % to_abs)
 
1122
            if not tree.has_filename(to_name):
 
1123
                raise BzrError("destination %r not in working directory" % to_abs)
 
1124
            to_dir_id = inv.path2id(to_name)
 
1125
            if to_dir_id == None and to_name != '':
 
1126
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
1127
            to_dir_ie = inv[to_dir_id]
 
1128
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1129
                raise BzrError("destination %r is not a directory" % to_abs)
 
1130
 
 
1131
            to_idpath = inv.get_idpath(to_dir_id)
 
1132
 
 
1133
            for f in from_paths:
 
1134
                if not tree.has_filename(f):
 
1135
                    raise BzrError("%r does not exist in working tree" % f)
 
1136
                f_id = inv.path2id(f)
 
1137
                if f_id == None:
 
1138
                    raise BzrError("%r is not versioned" % f)
 
1139
                name_tail = splitpath(f)[-1]
 
1140
                dest_path = appendpath(to_name, name_tail)
 
1141
                if tree.has_filename(dest_path):
 
1142
                    raise BzrError("destination %r already exists" % dest_path)
 
1143
                if f_id in to_idpath:
 
1144
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1145
 
 
1146
            # OK, so there's a race here, it's possible that someone will
 
1147
            # create a file in this interval and then the rename might be
 
1148
            # left half-done.  But we should have caught most problems.
 
1149
 
 
1150
            for f in from_paths:
 
1151
                name_tail = splitpath(f)[-1]
 
1152
                dest_path = appendpath(to_name, name_tail)
 
1153
                print "%s => %s" % (f, dest_path)
 
1154
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1155
                try:
 
1156
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
1157
                except OSError, e:
 
1158
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1159
                            ["rename rolled back"])
 
1160
 
 
1161
            self._write_inventory(inv)
 
1162
        finally:
 
1163
            self.unlock()
 
1164
 
 
1165
 
 
1166
    def revert(self, filenames, old_tree=None, backups=True):
 
1167
        """Restore selected files to the versions from a previous tree.
 
1168
 
 
1169
        backups
 
1170
            If true (default) backups are made of files before
 
1171
            they're renamed.
 
1172
        """
 
1173
        from bzrlib.errors import NotVersionedError, BzrError
 
1174
        from bzrlib.atomicfile import AtomicFile
 
1175
        from bzrlib.osutils import backup_file
 
1176
        
 
1177
        inv = self.read_working_inventory()
 
1178
        if old_tree is None:
 
1179
            old_tree = self.basis_tree()
 
1180
        old_inv = old_tree.inventory
 
1181
 
 
1182
        nids = []
 
1183
        for fn in filenames:
 
1184
            file_id = inv.path2id(fn)
 
1185
            if not file_id:
 
1186
                raise NotVersionedError("not a versioned file", fn)
 
1187
            if not old_inv.has_id(file_id):
 
1188
                raise BzrError("file not present in old tree", fn, file_id)
 
1189
            nids.append((fn, file_id))
 
1190
            
 
1191
        # TODO: Rename back if it was previously at a different location
 
1192
 
 
1193
        # TODO: If given a directory, restore the entire contents from
 
1194
        # the previous version.
 
1195
 
 
1196
        # TODO: Make a backup to a temporary file.
 
1197
 
 
1198
        # TODO: If the file previously didn't exist, delete it?
 
1199
        for fn, file_id in nids:
 
1200
            backup_file(fn)
 
1201
            
 
1202
            f = AtomicFile(fn, 'wb')
 
1203
            try:
 
1204
                f.write(old_tree.get_file(file_id).read())
 
1205
                f.commit()
 
1206
            finally:
 
1207
                f.close()
 
1208
 
 
1209
 
 
1210
    def pending_merges(self):
 
1211
        """Return a list of pending merges.
 
1212
 
 
1213
        These are revisions that have been merged into the working
 
1214
        directory but not yet committed.
 
1215
        """
 
1216
        cfn = self.controlfilename('pending-merges')
 
1217
        if not os.path.exists(cfn):
 
1218
            return []
 
1219
        p = []
 
1220
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1221
            p.append(l.rstrip('\n'))
 
1222
        return p
 
1223
 
 
1224
 
 
1225
    def add_pending_merge(self, revision_id):
 
1226
        from bzrlib.revision import validate_revision_id
 
1227
 
 
1228
        validate_revision_id(revision_id)
 
1229
 
 
1230
        p = self.pending_merges()
 
1231
        if revision_id in p:
 
1232
            return
 
1233
        p.append(revision_id)
 
1234
        self.set_pending_merges(p)
 
1235
 
 
1236
 
 
1237
    def set_pending_merges(self, rev_list):
 
1238
        from bzrlib.atomicfile import AtomicFile
 
1239
        self.lock_write()
 
1240
        try:
 
1241
            f = AtomicFile(self.controlfilename('pending-merges'))
 
1242
            try:
 
1243
                for l in rev_list:
 
1244
                    print >>f, l
 
1245
                f.commit()
 
1246
            finally:
 
1247
                f.close()
 
1248
        finally:
 
1249
            self.unlock()
713
1250
 
714
1251
 
715
1252
 
724
1261
    >>> isdir(bd)
725
1262
    False
726
1263
    """
727
 
    def __init__(self, files=[], dirs=[]):
 
1264
    def __init__(self, files=[], dirs=[], base=None):
728
1265
        """Make a test branch.
729
1266
 
730
1267
        This creates a temporary directory and runs init-tree in it.
731
1268
 
732
1269
        If any files are listed, they are created in the working copy.
733
1270
        """
734
 
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
 
1271
        from tempfile import mkdtemp
 
1272
        init = False
 
1273
        if base is None:
 
1274
            base = mkdtemp()
 
1275
            init = True
 
1276
        Branch.__init__(self, base, init=init)
735
1277
        for d in dirs:
736
1278
            os.mkdir(self.abspath(d))
737
1279
            
739
1281
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
740
1282
 
741
1283
 
 
1284
    def clone(self):
 
1285
        """
 
1286
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1287
        >>> clone = orig.clone()
 
1288
        >>> os.path.samefile(orig.base, clone.base)
 
1289
        False
 
1290
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1291
        True
 
1292
        """
 
1293
        from shutil import copytree
 
1294
        from tempfile import mkdtemp
 
1295
        base = mkdtemp()
 
1296
        os.rmdir(base)
 
1297
        copytree(self.base, base, symlinks=True)
 
1298
        return ScratchBranch(base=base)
 
1299
        
742
1300
    def __del__(self):
743
1301
        self.destroy()
744
1302
 
745
1303
    def destroy(self):
746
1304
        """Destroy the test branch, removing the scratch directory."""
 
1305
        from shutil import rmtree
747
1306
        try:
748
 
            mutter("delete ScratchBranch %s" % self.base)
749
 
            shutil.rmtree(self.base)
 
1307
            if self.base:
 
1308
                mutter("delete ScratchBranch %s" % self.base)
 
1309
                rmtree(self.base)
750
1310
        except OSError, e:
751
1311
            # Work around for shutil.rmtree failing on Windows when
752
1312
            # readonly files are encountered
754
1314
            for root, dirs, files in os.walk(self.base, topdown=False):
755
1315
                for name in files:
756
1316
                    os.chmod(os.path.join(root, name), 0700)
757
 
            shutil.rmtree(self.base)
 
1317
            rmtree(self.base)
758
1318
        self.base = None
759
1319
 
760
1320
    
785
1345
    cope with just randomness because running uuidgen every time is
786
1346
    slow."""
787
1347
    import re
 
1348
    from binascii import hexlify
 
1349
    from time import time
788
1350
 
789
1351
    # get last component
790
1352
    idx = name.rfind('/')
802
1364
    name = re.sub(r'[^\w.]', '', name)
803
1365
 
804
1366
    s = hexlify(rand_bytes(8))
805
 
    return '-'.join((name, compact_date(time.time()), s))
 
1367
    return '-'.join((name, compact_date(time()), s))
 
1368
 
 
1369
 
 
1370
def gen_root_id():
 
1371
    """Return a new tree-root file id."""
 
1372
    return gen_file_id('TREE_ROOT')
 
1373