~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-10 07:06:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050510070605-0a2453ae5db6fc3c
- new command 'bzr added'

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
 
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
19
23
 
20
24
import bzrlib
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
 
25
from inventory import Inventory
 
26
from trace import mutter, note
 
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
 
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
25
37
 
26
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
39
## TODO: Maybe include checks for common corruption of newlines, etc?
29
41
 
30
42
 
31
43
def find_branch(f, **args):
32
 
    if f and (f.startswith('http://') or f.startswith('https://')):
 
44
    if f.startswith('http://') or f.startswith('https://'):
33
45
        import remotebranch 
34
46
        return remotebranch.RemoteBranch(f, **args)
35
47
    else:
36
48
        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)
82
49
        
83
50
 
84
51
def find_branch_root(f=None):
111
78
            raise BzrError('%r is not in a branch' % orig_f)
112
79
        f = head
113
80
    
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)
127
81
 
128
82
 
129
83
######################################################################
130
84
# branch objects
131
85
 
132
 
class Branch(object):
 
86
class Branch:
133
87
    """Branch holding a history of revisions.
134
88
 
135
89
    base
136
90
        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.
147
91
    """
148
 
    base = None
149
 
    _lock_mode = None
150
 
    _lock_count = None
151
 
    _lock = None
 
92
    _lockmode = None
152
93
    
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):
 
94
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
159
95
        """Create new branch object at a particular location.
160
96
 
161
97
        base -- Base directory for the branch.
170
106
        In the test suite, creation of new trees is tested using the
171
107
        `ScratchBranch` class.
172
108
        """
173
 
        from bzrlib.store import ImmutableStore
174
109
        if init:
175
110
            self.base = os.path.realpath(base)
176
111
            self._make_control()
179
114
        else:
180
115
            self.base = os.path.realpath(base)
181
116
            if not isdir(self.controlfilename('.')):
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'])
 
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'])
186
120
        self._check_format()
 
121
        self.lock(lock_mode)
187
122
 
188
123
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
189
124
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
197
132
    __repr__ = __str__
198
133
 
199
134
 
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
 
 
 
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
237
159
            
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
 
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
182
 
250
183
 
251
184
    def abspath(self, name):
257
190
        """Return path relative to this branch of something inside it.
258
191
 
259
192
        Raises an error if path is not in this branch."""
260
 
        return _relpath(self.base, path)
 
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
261
200
 
262
201
 
263
202
    def controlfilename(self, file_or_path):
264
203
        """Return location relative to branch."""
265
 
        if isinstance(file_or_path, basestring):
 
204
        if isinstance(file_or_path, types.StringTypes):
266
205
            file_or_path = [file_or_path]
267
206
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
268
207
 
295
234
 
296
235
 
297
236
    def _make_control(self):
298
 
        from bzrlib.inventory import Inventory
299
 
        from bzrlib.xml import pack_xml
300
 
        
301
237
        os.mkdir(self.controlfilename([]))
302
238
        self.controlfile('README', 'w').write(
303
239
            "This is a Bazaar-NG control directory.\n"
304
 
            "Do not change any files in this directory.\n")
 
240
            "Do not change any files in this directory.")
305
241
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
306
242
        for d in ('text-store', 'inventory-store', 'revision-store'):
307
243
            os.mkdir(self.controlfilename(d))
308
244
        for f in ('revision-history', 'merged-patches',
309
245
                  'pending-merged-patches', 'branch-name',
310
 
                  'branch-lock',
311
 
                  'pending-merges'):
 
246
                  'branch-lock'):
312
247
            self.controlfile(f, 'w').write('')
313
248
        mutter('created control directory in ' + self.base)
314
 
 
315
 
        pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
 
249
        Inventory().write_xml(self.controlfile('inventory','w'))
316
250
 
317
251
 
318
252
    def _check_format(self):
329
263
        fmt = self.controlfile('branch-format', 'r').read()
330
264
        fmt.replace('\r\n', '')
331
265
        if fmt != BZR_BRANCH_FORMAT:
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)
 
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
 
352
270
 
353
271
    def read_working_inventory(self):
354
272
        """Read the working inventory."""
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
 
            
 
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
 
371
282
 
372
283
    def _write_inventory(self, inv):
373
284
        """Update the working inventory.
375
286
        That is to say, the inventory describing changes underway, that
376
287
        will be committed to the next revision.
377
288
        """
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
 
        
 
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
300
        mutter('wrote working inventory')
393
 
            
 
301
 
394
302
 
395
303
    inventory = property(read_working_inventory, _write_inventory, None,
396
304
                         """Inventory for the working copy.""")
397
305
 
398
306
 
399
 
    def add(self, files, verbose=False, ids=None):
 
307
    def add(self, files, verbose=False):
400
308
        """Make files versioned.
401
309
 
402
310
        Note that the command line normally calls smart_add instead.
404
312
        This puts the files in the Added state, so that they will be
405
313
        recorded by the next commit.
406
314
 
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
 
 
415
315
        TODO: Perhaps have an option to add the ids even if the files do
416
 
              not (yet) exist.
 
316
               not (yet) exist.
417
317
 
418
318
        TODO: Perhaps return the ids of the files?  But then again it
419
 
              is easy to retrieve them if they're needed.
 
319
               is easy to retrieve them if they're needed.
 
320
 
 
321
        TODO: Option to specify file id.
420
322
 
421
323
        TODO: Adding a directory should optionally recurse down and
422
 
              add all non-ignored children.  Perhaps do that in a
423
 
              higher-level method.
 
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', [])
424
348
        """
425
 
        from bzrlib.textui import show_status
 
349
        self._need_writelock()
 
350
 
426
351
        # TODO: Re-adding a file that is removed in the working copy
427
352
        # should probably put it back with the previous ID.
428
 
        if isinstance(files, basestring):
429
 
            assert(ids is None or isinstance(ids, basestring))
 
353
        if isinstance(files, types.StringTypes):
430
354
            files = [files]
431
 
            if ids is not None:
432
 
                ids = [ids]
433
 
 
434
 
        if ids is None:
435
 
            ids = [None] * len(files)
436
 
        else:
437
 
            assert(len(ids) == len(files))
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
 
            
 
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
 
475
387
 
476
388
    def print_file(self, file, revno):
477
389
        """Print `file` to stdout."""
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
 
 
 
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
        
489
398
 
490
399
    def remove(self, files, verbose=False):
491
400
        """Mark nominated files for removal from the inventory.
494
403
 
495
404
        TODO: Refuse to remove modified files unless --force is given?
496
405
 
 
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
 
497
428
        TODO: Do something useful with directories.
498
429
 
499
430
        TODO: Should this remove the text or not?  Tough call; not
501
432
        is the opposite of add.  Removing it is consistent with most
502
433
        other tools.  Maybe an option.
503
434
        """
504
 
        from bzrlib.textui import show_status
505
435
        ## TODO: Normalize names
506
436
        ## TODO: Remove nested loops; better scalability
507
 
        if isinstance(files, basestring):
 
437
        self._need_writelock()
 
438
 
 
439
        if isinstance(files, types.StringTypes):
508
440
            files = [files]
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
537
 
    def set_inventory(self, new_inventory_list):
538
 
        from bzrlib.inventory import Inventory, InventoryEntry
539
 
        inv = Inventory(self.get_root_id())
540
 
        for path, file_id, parent, kind in new_inventory_list:
541
 
            name = os.path.basename(path)
542
 
            if name == "":
543
 
                continue
544
 
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
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
 
545
460
        self._write_inventory(inv)
546
461
 
547
462
 
564
479
        return self.working_tree().unknowns()
565
480
 
566
481
 
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
 
 
 
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)
573
655
        rev_history = self.revision_history()
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()
 
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
        
583
670
 
584
671
 
585
672
    def get_revision(self, revision_id):
586
673
        """Return the Revision object for a named revision"""
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
 
            
 
674
        self._need_readlock()
 
675
        r = Revision.read_xml(self.revision_store[revision_id])
598
676
        assert r.revision_id == revision_id
599
677
        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])
611
678
 
612
679
 
613
680
    def get_inventory(self, inventory_id):
616
683
        TODO: Perhaps for this and similar methods, take a revision
617
684
               parameter which can be either an integer revno or a
618
685
               string hash."""
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])
 
686
        self._need_readlock()
 
687
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
688
        return i
629
689
 
630
690
 
631
691
    def get_revision_inventory(self, revision_id):
632
692
        """Return inventory of a past revision."""
633
 
        # bzr 0.0.6 imposes the constraint that the inventory_id
634
 
        # must be the same as its revision, so this is trivial.
 
693
        self._need_readlock()
635
694
        if revision_id == None:
636
 
            from bzrlib.inventory import Inventory
637
 
            return Inventory(self.get_root_id())
 
695
            return Inventory()
638
696
        else:
639
 
            return self.get_inventory(revision_id)
 
697
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
640
698
 
641
699
 
642
700
    def revision_history(self):
645
703
        >>> ScratchBranch().revision_history()
646
704
        []
647
705
        """
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
 
706
        self._need_readlock()
 
707
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
 
708
 
699
709
 
700
710
    def enum_history(self, direction):
701
711
        """Return (revno, revision_id) for history of branch.
716
726
                yield i, rh[i-1]
717
727
                i -= 1
718
728
        else:
719
 
            raise ValueError('invalid history direction', direction)
 
729
            raise BzrError('invalid history direction %r' % direction)
720
730
 
721
731
 
722
732
    def revno(self):
724
734
 
725
735
        That is equivalent to the number of revisions committed to
726
736
        this branch.
 
737
 
 
738
        >>> b = ScratchBranch()
 
739
        >>> b.revno()
 
740
        0
 
741
        >>> b.commit('no foo')
 
742
        >>> b.revno()
 
743
        1
727
744
        """
728
745
        return len(self.revision_history())
729
746
 
730
747
 
731
748
    def last_patch(self):
732
749
        """Return last patch hash, or None if no history.
 
750
 
 
751
        >>> ScratchBranch().last_patch() == None
 
752
        True
733
753
        """
734
754
        ph = self.revision_history()
735
755
        if ph:
736
756
            return ph[-1]
737
757
        else:
738
758
            return None
739
 
 
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
 
        
853
 
    def commit(self, *args, **kw):
854
 
        from bzrlib.commit import commit
855
 
        commit(self, *args, **kw)
856
 
        
857
 
 
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
 
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
 
1015
772
 
1016
773
    def revision_tree(self, revision_id):
1017
774
        """Return Tree for a revision on this branch.
1018
775
 
1019
776
        `revision_id` may be None for the null revision, in which case
1020
777
        an `EmptyTree` is returned."""
1021
 
        from bzrlib.tree import EmptyTree, RevisionTree
1022
 
        # TODO: refactor this to use an existing revision object
1023
 
        # so we don't need to read it in twice.
 
778
        self._need_readlock()
1024
779
        if revision_id == None:
1025
 
            return EmptyTree(self.get_root_id())
 
780
            return EmptyTree()
1026
781
        else:
1027
782
            inv = self.get_revision_inventory(revision_id)
1028
783
            return RevisionTree(self.text_store, inv)
1030
785
 
1031
786
    def working_tree(self):
1032
787
        """Return a `Tree` for the working copy."""
1033
 
        from workingtree import WorkingTree
1034
788
        return WorkingTree(self.base, self.read_working_inventory())
1035
789
 
1036
790
 
1038
792
        """Return `Tree` object for last revision.
1039
793
 
1040
794
        If there are no revisions yet, return an `EmptyTree`.
 
795
 
 
796
        >>> b = ScratchBranch(files=['foo'])
 
797
        >>> b.basis_tree().has_filename('foo')
 
798
        False
 
799
        >>> b.working_tree().has_filename('foo')
 
800
        True
 
801
        >>> b.add('foo')
 
802
        >>> b.commit('add foo')
 
803
        >>> b.basis_tree().has_filename('foo')
 
804
        True
1041
805
        """
1042
 
        from bzrlib.tree import EmptyTree, RevisionTree
1043
806
        r = self.last_patch()
1044
807
        if r == None:
1045
 
            return EmptyTree(self.get_root_id())
 
808
            return EmptyTree()
1046
809
        else:
1047
810
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
1048
811
 
1053
816
 
1054
817
        This can change the directory or the filename or both.
1055
818
        """
1056
 
        self.lock_write()
 
819
        self._need_writelock()
 
820
        tree = self.working_tree()
 
821
        inv = tree.inventory
 
822
        if not tree.has_filename(from_rel):
 
823
            bailout("can't rename: old working file %r does not exist" % from_rel)
 
824
        if tree.has_filename(to_rel):
 
825
            bailout("can't rename: new working file %r already exists" % to_rel)
 
826
            
 
827
        file_id = inv.path2id(from_rel)
 
828
        if file_id == None:
 
829
            bailout("can't rename: old name %r is not versioned" % from_rel)
 
830
 
 
831
        if inv.path2id(to_rel):
 
832
            bailout("can't rename: new name %r is already versioned" % to_rel)
 
833
 
 
834
        to_dir, to_tail = os.path.split(to_rel)
 
835
        to_dir_id = inv.path2id(to_dir)
 
836
        if to_dir_id == None and to_dir != '':
 
837
            bailout("can't determine destination directory id for %r" % to_dir)
 
838
 
 
839
        mutter("rename_one:")
 
840
        mutter("  file_id    {%s}" % file_id)
 
841
        mutter("  from_rel   %r" % from_rel)
 
842
        mutter("  to_rel     %r" % to_rel)
 
843
        mutter("  to_dir     %r" % to_dir)
 
844
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
845
            
 
846
        inv.rename(file_id, to_dir_id, to_tail)
 
847
 
 
848
        print "%s => %s" % (from_rel, to_rel)
 
849
        
 
850
        from_abs = self.abspath(from_rel)
 
851
        to_abs = self.abspath(to_rel)
1057
852
        try:
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()
 
853
            os.rename(from_abs, to_abs)
 
854
        except OSError, e:
 
855
            bailout("failed to rename %r to %r: %s"
 
856
                    % (from_abs, to_abs, e[1]),
 
857
                    ["rename rolled back"])
 
858
 
 
859
        self._write_inventory(inv)
 
860
            
1100
861
 
1101
862
 
1102
863
    def move(self, from_paths, to_name):
1110
871
        Note that to_name is only the last component of the new name;
1111
872
        this doesn't change the directory.
1112
873
        """
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()
1250
 
 
 
874
        self._need_writelock()
 
875
        ## TODO: Option to move IDs only
 
876
        assert not isinstance(from_paths, basestring)
 
877
        tree = self.working_tree()
 
878
        inv = tree.inventory
 
879
        to_abs = self.abspath(to_name)
 
880
        if not isdir(to_abs):
 
881
            bailout("destination %r is not a directory" % to_abs)
 
882
        if not tree.has_filename(to_name):
 
883
            bailout("destination %r not in working directory" % to_abs)
 
884
        to_dir_id = inv.path2id(to_name)
 
885
        if to_dir_id == None and to_name != '':
 
886
            bailout("destination %r is not a versioned directory" % to_name)
 
887
        to_dir_ie = inv[to_dir_id]
 
888
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
889
            bailout("destination %r is not a directory" % to_abs)
 
890
 
 
891
        to_idpath = Set(inv.get_idpath(to_dir_id))
 
892
 
 
893
        for f in from_paths:
 
894
            if not tree.has_filename(f):
 
895
                bailout("%r does not exist in working tree" % f)
 
896
            f_id = inv.path2id(f)
 
897
            if f_id == None:
 
898
                bailout("%r is not versioned" % f)
 
899
            name_tail = splitpath(f)[-1]
 
900
            dest_path = appendpath(to_name, name_tail)
 
901
            if tree.has_filename(dest_path):
 
902
                bailout("destination %r already exists" % dest_path)
 
903
            if f_id in to_idpath:
 
904
                bailout("can't move %r to a subdirectory of itself" % f)
 
905
 
 
906
        # OK, so there's a race here, it's possible that someone will
 
907
        # create a file in this interval and then the rename might be
 
908
        # left half-done.  But we should have caught most problems.
 
909
 
 
910
        for f in from_paths:
 
911
            name_tail = splitpath(f)[-1]
 
912
            dest_path = appendpath(to_name, name_tail)
 
913
            print "%s => %s" % (f, dest_path)
 
914
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
915
            try:
 
916
                os.rename(self.abspath(f), self.abspath(dest_path))
 
917
            except OSError, e:
 
918
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
919
                        ["rename rolled back"])
 
920
 
 
921
        self._write_inventory(inv)
 
922
 
 
923
 
 
924
 
 
925
    def show_status(self, show_all=False, file_list=None):
 
926
        """Display single-line status for non-ignored working files.
 
927
 
 
928
        The list is show sorted in order by file name.
 
929
 
 
930
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
931
        >>> b.show_status()
 
932
        ?       foo
 
933
        >>> b.add('foo')
 
934
        >>> b.show_status()
 
935
        A       foo
 
936
        >>> b.commit("add foo")
 
937
        >>> b.show_status()
 
938
        >>> os.unlink(b.abspath('foo'))
 
939
        >>> b.show_status()
 
940
        D       foo
 
941
        """
 
942
        self._need_readlock()
 
943
 
 
944
        # We have to build everything into a list first so that it can
 
945
        # sorted by name, incorporating all the different sources.
 
946
 
 
947
        # FIXME: Rather than getting things in random order and then sorting,
 
948
        # just step through in order.
 
949
 
 
950
        # Interesting case: the old ID for a file has been removed,
 
951
        # but a new file has been created under that name.
 
952
 
 
953
        old = self.basis_tree()
 
954
        new = self.working_tree()
 
955
 
 
956
        items = diff_trees(old, new)
 
957
        # We want to filter out only if any file was provided in the file_list.
 
958
        if isinstance(file_list, list) and len(file_list):
 
959
            items = [item for item in items if item[3] in file_list]
 
960
 
 
961
        for fs, fid, oldname, newname, kind in items:
 
962
            if fs == 'R':
 
963
                show_status(fs, kind,
 
964
                            oldname + ' => ' + newname)
 
965
            elif fs == 'A' or fs == 'M':
 
966
                show_status(fs, kind, newname)
 
967
            elif fs == 'D':
 
968
                show_status(fs, kind, oldname)
 
969
            elif fs == '.':
 
970
                if show_all:
 
971
                    show_status(fs, kind, newname)
 
972
            elif fs == 'I':
 
973
                if show_all:
 
974
                    show_status(fs, kind, newname)
 
975
            elif fs == '?':
 
976
                show_status(fs, kind, newname)
 
977
            else:
 
978
                bailout("weird file state %r" % ((fs, fid),))
 
979
                
1251
980
 
1252
981
 
1253
982
class ScratchBranch(Branch):
1261
990
    >>> isdir(bd)
1262
991
    False
1263
992
    """
1264
 
    def __init__(self, files=[], dirs=[], base=None):
 
993
    def __init__(self, files=[], dirs=[]):
1265
994
        """Make a test branch.
1266
995
 
1267
996
        This creates a temporary directory and runs init-tree in it.
1268
997
 
1269
998
        If any files are listed, they are created in the working copy.
1270
999
        """
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)
 
1000
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
1277
1001
        for d in dirs:
1278
1002
            os.mkdir(self.abspath(d))
1279
1003
            
1281
1005
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1282
1006
 
1283
1007
 
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
 
        
1300
1008
    def __del__(self):
1301
1009
        self.destroy()
1302
1010
 
1303
1011
    def destroy(self):
1304
1012
        """Destroy the test branch, removing the scratch directory."""
1305
 
        from shutil import rmtree
1306
1013
        try:
1307
 
            if self.base:
1308
 
                mutter("delete ScratchBranch %s" % self.base)
1309
 
                rmtree(self.base)
 
1014
            mutter("delete ScratchBranch %s" % self.base)
 
1015
            shutil.rmtree(self.base)
1310
1016
        except OSError, e:
1311
1017
            # Work around for shutil.rmtree failing on Windows when
1312
1018
            # readonly files are encountered
1314
1020
            for root, dirs, files in os.walk(self.base, topdown=False):
1315
1021
                for name in files:
1316
1022
                    os.chmod(os.path.join(root, name), 0700)
1317
 
            rmtree(self.base)
 
1023
            shutil.rmtree(self.base)
1318
1024
        self.base = None
1319
1025
 
1320
1026
    
1338
1044
 
1339
1045
 
1340
1046
 
 
1047
def _gen_revision_id(when):
 
1048
    """Return new revision-id."""
 
1049
    s = '%s-%s-' % (user_email(), compact_date(when))
 
1050
    s += hexlify(rand_bytes(8))
 
1051
    return s
 
1052
 
 
1053
 
1341
1054
def gen_file_id(name):
1342
1055
    """Return new file id.
1343
1056
 
1344
1057
    This should probably generate proper UUIDs, but for the moment we
1345
1058
    cope with just randomness because running uuidgen every time is
1346
1059
    slow."""
1347
 
    import re
1348
 
    from binascii import hexlify
1349
 
    from time import time
1350
 
 
1351
 
    # get last component
1352
1060
    idx = name.rfind('/')
1353
1061
    if idx != -1:
1354
1062
        name = name[idx+1 : ]
1356
1064
    if idx != -1:
1357
1065
        name = name[idx+1 : ]
1358
1066
 
1359
 
    # make it not a hidden file
1360
1067
    name = name.lstrip('.')
1361
1068
 
1362
 
    # remove any wierd characters; we don't escape them but rather
1363
 
    # just pull them out
1364
 
    name = re.sub(r'[^\w.]', '', name)
1365
 
 
1366
1069
    s = hexlify(rand_bytes(8))
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
 
 
 
1070
    return '-'.join((name, compact_date(time.time()), s))