~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2005-08-24 05:51:34 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050824055134-708a7ee78516ecbc
remove TEST_CLASSES dead code and provide a bzrlib.test_suite() convenience method

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