~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-17 06:56:16 UTC
  • Revision ID: mbp@sourcefrog.net-20050517065616-6f23381d6184a8aa
- add space for un-merged patches

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
 
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
25
36
 
26
37
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
38
## TODO: Maybe include checks for common corruption of newlines, etc?
34
45
        return remotebranch.RemoteBranch(f, **args)
35
46
    else:
36
47
        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
48
        
83
49
 
84
50
def find_branch_root(f=None):
111
77
            raise BzrError('%r is not in a branch' % orig_f)
112
78
        f = head
113
79
    
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
80
 
128
81
 
129
82
######################################################################
130
83
# branch objects
131
84
 
132
 
class Branch(object):
 
85
class Branch:
133
86
    """Branch holding a history of revisions.
134
87
 
135
88
    base
136
89
        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
90
    """
148
 
    base = None
149
 
    _lock_mode = None
150
 
    _lock_count = None
151
 
    _lock = None
 
91
    _lockmode = None
152
92
    
153
 
    def __init__(self, base, init=False, find_root=True):
 
93
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
154
94
        """Create new branch object at a particular location.
155
95
 
156
96
        base -- Base directory for the branch.
165
105
        In the test suite, creation of new trees is tested using the
166
106
        `ScratchBranch` class.
167
107
        """
168
 
        from bzrlib.store import ImmutableStore
169
108
        if init:
170
109
            self.base = os.path.realpath(base)
171
110
            self._make_control()
174
113
        else:
175
114
            self.base = os.path.realpath(base)
176
115
            if not isdir(self.controlfilename('.')):
177
 
                from errors import NotBranchError
178
 
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
179
 
                                     ['use "bzr init" to initialize a new working tree',
180
 
                                      'current bzr can only operate from top-of-tree'])
 
116
                bailout("not a bzr branch: %s" % quotefn(base),
 
117
                        ['use "bzr init" to initialize a new working tree',
 
118
                         'current bzr can only operate from top-of-tree'])
181
119
        self._check_format()
 
120
        self.lock(lock_mode)
182
121
 
183
122
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
184
123
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
192
131
    __repr__ = __str__
193
132
 
194
133
 
195
 
    def __del__(self):
196
 
        if self._lock_mode or self._lock:
197
 
            from warnings import warn
198
 
            warn("branch %r was not explicitly unlocked" % self)
199
 
            self._lock.unlock()
200
 
 
201
 
 
202
 
 
203
 
    def lock_write(self):
204
 
        if self._lock_mode:
205
 
            if self._lock_mode != 'w':
206
 
                from errors import LockError
207
 
                raise LockError("can't upgrade to a write lock from %r" %
208
 
                                self._lock_mode)
209
 
            self._lock_count += 1
210
 
        else:
211
 
            from bzrlib.lock import WriteLock
212
 
 
213
 
            self._lock = WriteLock(self.controlfilename('branch-lock'))
214
 
            self._lock_mode = 'w'
215
 
            self._lock_count = 1
216
 
 
217
 
 
218
 
 
219
 
    def lock_read(self):
220
 
        if self._lock_mode:
221
 
            assert self._lock_mode in ('r', 'w'), \
222
 
                   "invalid lock mode %r" % self._lock_mode
223
 
            self._lock_count += 1
224
 
        else:
225
 
            from bzrlib.lock import ReadLock
226
 
 
227
 
            self._lock = ReadLock(self.controlfilename('branch-lock'))
228
 
            self._lock_mode = 'r'
229
 
            self._lock_count = 1
230
 
                        
231
 
 
 
134
 
 
135
    def lock(self, mode='w'):
 
136
        """Lock the on-disk branch, excluding other processes."""
 
137
        try:
 
138
            import fcntl, errno
 
139
 
 
140
            if mode == 'w':
 
141
                lm = fcntl.LOCK_EX
 
142
                om = os.O_WRONLY | os.O_CREAT
 
143
            elif mode == 'r':
 
144
                lm = fcntl.LOCK_SH
 
145
                om = os.O_RDONLY
 
146
            else:
 
147
                raise BzrError("invalid locking mode %r" % mode)
 
148
 
 
149
            try:
 
150
                lockfile = os.open(self.controlfilename('branch-lock'), om)
 
151
            except OSError, e:
 
152
                if e.errno == errno.ENOENT:
 
153
                    # might not exist on branches from <0.0.4
 
154
                    self.controlfile('branch-lock', 'w').close()
 
155
                    lockfile = os.open(self.controlfilename('branch-lock'), om)
 
156
                else:
 
157
                    raise e
232
158
            
233
 
    def unlock(self):
234
 
        if not self._lock_mode:
235
 
            from errors import LockError
236
 
            raise LockError('branch %r is not locked' % (self))
237
 
 
238
 
        if self._lock_count > 1:
239
 
            self._lock_count -= 1
240
 
        else:
241
 
            self._lock.unlock()
242
 
            self._lock = None
243
 
            self._lock_mode = self._lock_count = None
 
159
            fcntl.lockf(lockfile, lm)
 
160
            def unlock():
 
161
                fcntl.lockf(lockfile, fcntl.LOCK_UN)
 
162
                os.close(lockfile)
 
163
                self._lockmode = None
 
164
            self.unlock = unlock
 
165
            self._lockmode = mode
 
166
        except ImportError:
 
167
            warning("please write a locking method for platform %r" % sys.platform)
 
168
            def unlock():
 
169
                self._lockmode = None
 
170
            self.unlock = unlock
 
171
            self._lockmode = mode
 
172
 
 
173
 
 
174
    def _need_readlock(self):
 
175
        if self._lockmode not in ['r', 'w']:
 
176
            raise BzrError('need read lock on branch, only have %r' % self._lockmode)
 
177
 
 
178
    def _need_writelock(self):
 
179
        if self._lockmode not in ['w']:
 
180
            raise BzrError('need write lock on branch, only have %r' % self._lockmode)
244
181
 
245
182
 
246
183
    def abspath(self, name):
252
189
        """Return path relative to this branch of something inside it.
253
190
 
254
191
        Raises an error if path is not in this branch."""
255
 
        return _relpath(self.base, path)
 
192
        rp = os.path.realpath(path)
 
193
        # FIXME: windows
 
194
        if not rp.startswith(self.base):
 
195
            bailout("path %r is not within branch %r" % (rp, self.base))
 
196
        rp = rp[len(self.base):]
 
197
        rp = rp.lstrip(os.sep)
 
198
        return rp
256
199
 
257
200
 
258
201
    def controlfilename(self, file_or_path):
259
202
        """Return location relative to branch."""
260
 
        if isinstance(file_or_path, basestring):
 
203
        if isinstance(file_or_path, types.StringTypes):
261
204
            file_or_path = [file_or_path]
262
205
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
263
206
 
290
233
 
291
234
 
292
235
    def _make_control(self):
293
 
        from bzrlib.inventory import Inventory
294
 
        from bzrlib.xml import pack_xml
295
 
        
296
236
        os.mkdir(self.controlfilename([]))
297
237
        self.controlfile('README', 'w').write(
298
238
            "This is a Bazaar-NG control directory.\n"
299
 
            "Do not change any files in this directory.\n")
 
239
            "Do not change any files in this directory.")
300
240
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
301
241
        for d in ('text-store', 'inventory-store', 'revision-store'):
302
242
            os.mkdir(self.controlfilename(d))
305
245
                  'branch-lock'):
306
246
            self.controlfile(f, 'w').write('')
307
247
        mutter('created control directory in ' + self.base)
308
 
 
309
 
        pack_xml(Inventory(), self.controlfile('inventory','w'))
 
248
        Inventory().write_xml(self.controlfile('inventory','w'))
310
249
 
311
250
 
312
251
    def _check_format(self):
323
262
        fmt = self.controlfile('branch-format', 'r').read()
324
263
        fmt.replace('\r\n', '')
325
264
        if fmt != BZR_BRANCH_FORMAT:
326
 
            raise BzrError('sorry, branch format %r not supported' % fmt,
327
 
                           ['use a different bzr version',
328
 
                            'or remove the .bzr directory and "bzr init" again'])
329
 
 
 
265
            bailout('sorry, branch format %r not supported' % fmt,
 
266
                    ['use a different bzr version',
 
267
                     'or remove the .bzr directory and "bzr init" again'])
330
268
 
331
269
 
332
270
    def read_working_inventory(self):
333
271
        """Read the working inventory."""
334
 
        from bzrlib.inventory import Inventory
335
 
        from bzrlib.xml import unpack_xml
336
 
        from time import time
337
 
        before = time()
338
 
        self.lock_read()
339
 
        try:
340
 
            # ElementTree does its own conversion from UTF-8, so open in
341
 
            # binary.
342
 
            inv = unpack_xml(Inventory,
343
 
                                  self.controlfile('inventory', 'rb'))
344
 
            mutter("loaded inventory of %d items in %f"
345
 
                   % (len(inv), time() - before))
346
 
            return inv
347
 
        finally:
348
 
            self.unlock()
349
 
            
 
272
        self._need_readlock()
 
273
        before = time.time()
 
274
        # ElementTree does its own conversion from UTF-8, so open in
 
275
        # binary.
 
276
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
277
        mutter("loaded inventory of %d items in %f"
 
278
               % (len(inv), time.time() - before))
 
279
        return inv
 
280
 
350
281
 
351
282
    def _write_inventory(self, inv):
352
283
        """Update the working inventory.
354
285
        That is to say, the inventory describing changes underway, that
355
286
        will be committed to the next revision.
356
287
        """
357
 
        from bzrlib.atomicfile import AtomicFile
358
 
        from bzrlib.xml import pack_xml
359
 
        
360
 
        self.lock_write()
361
 
        try:
362
 
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
363
 
            try:
364
 
                pack_xml(inv, f)
365
 
                f.commit()
366
 
            finally:
367
 
                f.close()
368
 
        finally:
369
 
            self.unlock()
370
 
        
 
288
        self._need_writelock()
 
289
        ## TODO: factor out to atomicfile?  is rename safe on windows?
 
290
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
 
291
        tmpfname = self.controlfilename('inventory.tmp')
 
292
        tmpf = file(tmpfname, 'wb')
 
293
        inv.write_xml(tmpf)
 
294
        tmpf.close()
 
295
        inv_fname = self.controlfilename('inventory')
 
296
        if sys.platform == 'win32':
 
297
            os.remove(inv_fname)
 
298
        os.rename(tmpfname, inv_fname)
371
299
        mutter('wrote working inventory')
372
 
            
 
300
 
373
301
 
374
302
    inventory = property(read_working_inventory, _write_inventory, None,
375
303
                         """Inventory for the working copy.""")
383
311
        This puts the files in the Added state, so that they will be
384
312
        recorded by the next commit.
385
313
 
386
 
        files
387
 
            List of paths to add, relative to the base of the tree.
388
 
 
389
 
        ids
390
 
            If set, use these instead of automatically generated ids.
391
 
            Must be the same length as the list of files, but may
392
 
            contain None for ids that are to be autogenerated.
393
 
 
394
314
        TODO: Perhaps have an option to add the ids even if the files do
395
 
              not (yet) exist.
 
315
               not (yet) exist.
396
316
 
397
317
        TODO: Perhaps return the ids of the files?  But then again it
398
 
              is easy to retrieve them if they're needed.
 
318
               is easy to retrieve them if they're needed.
 
319
 
 
320
        TODO: Option to specify file id.
399
321
 
400
322
        TODO: Adding a directory should optionally recurse down and
401
 
              add all non-ignored children.  Perhaps do that in a
402
 
              higher-level method.
 
323
               add all non-ignored children.  Perhaps do that in a
 
324
               higher-level method.
403
325
        """
404
 
        from bzrlib.textui import show_status
 
326
        self._need_writelock()
 
327
 
405
328
        # TODO: Re-adding a file that is removed in the working copy
406
329
        # should probably put it back with the previous ID.
407
 
        if isinstance(files, basestring):
408
 
            assert(ids is None or isinstance(ids, basestring))
 
330
        if isinstance(files, types.StringTypes):
 
331
            assert(ids is None or isinstance(ids, types.StringTypes))
409
332
            files = [files]
410
333
            if ids is not None:
411
334
                ids = [ids]
414
337
            ids = [None] * len(files)
415
338
        else:
416
339
            assert(len(ids) == len(files))
417
 
 
418
 
        self.lock_write()
419
 
        try:
420
 
            inv = self.read_working_inventory()
421
 
            for f,file_id in zip(files, ids):
422
 
                if is_control_file(f):
423
 
                    raise BzrError("cannot add control file %s" % quotefn(f))
424
 
 
425
 
                fp = splitpath(f)
426
 
 
427
 
                if len(fp) == 0:
428
 
                    raise BzrError("cannot add top-level %r" % f)
429
 
 
430
 
                fullpath = os.path.normpath(self.abspath(f))
431
 
 
432
 
                try:
433
 
                    kind = file_kind(fullpath)
434
 
                except OSError:
435
 
                    # maybe something better?
436
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
437
 
 
438
 
                if kind != 'file' and kind != 'directory':
439
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
440
 
 
441
 
                if file_id is None:
442
 
                    file_id = gen_file_id(f)
443
 
                inv.add_path(f, kind=kind, file_id=file_id)
444
 
 
445
 
                if verbose:
446
 
                    print 'added', quotefn(f)
447
 
 
448
 
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
449
 
 
450
 
            self._write_inventory(inv)
451
 
        finally:
452
 
            self.unlock()
453
 
            
 
340
        
 
341
        inv = self.read_working_inventory()
 
342
        for f,file_id in zip(files, ids):
 
343
            if is_control_file(f):
 
344
                bailout("cannot add control file %s" % quotefn(f))
 
345
 
 
346
            fp = splitpath(f)
 
347
 
 
348
            if len(fp) == 0:
 
349
                bailout("cannot add top-level %r" % f)
 
350
                
 
351
            fullpath = os.path.normpath(self.abspath(f))
 
352
 
 
353
            try:
 
354
                kind = file_kind(fullpath)
 
355
            except OSError:
 
356
                # maybe something better?
 
357
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
358
            
 
359
            if kind != 'file' and kind != 'directory':
 
360
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
361
 
 
362
            if file_id is None:
 
363
                file_id = gen_file_id(f)
 
364
            inv.add_path(f, kind=kind, file_id=file_id)
 
365
 
 
366
            if verbose:
 
367
                show_status('A', kind, quotefn(f))
 
368
                
 
369
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
370
            
 
371
        self._write_inventory(inv)
 
372
 
454
373
 
455
374
    def print_file(self, file, revno):
456
375
        """Print `file` to stdout."""
457
 
        self.lock_read()
458
 
        try:
459
 
            tree = self.revision_tree(self.lookup_revision(revno))
460
 
            # use inventory as it was in that revision
461
 
            file_id = tree.inventory.path2id(file)
462
 
            if not file_id:
463
 
                raise BzrError("%r is not present in revision %d" % (file, revno))
464
 
            tree.print_file(file_id)
465
 
        finally:
466
 
            self.unlock()
467
 
 
 
376
        self._need_readlock()
 
377
        tree = self.revision_tree(self.lookup_revision(revno))
 
378
        # use inventory as it was in that revision
 
379
        file_id = tree.inventory.path2id(file)
 
380
        if not file_id:
 
381
            bailout("%r is not present in revision %d" % (file, revno))
 
382
        tree.print_file(file_id)
 
383
        
468
384
 
469
385
    def remove(self, files, verbose=False):
470
386
        """Mark nominated files for removal from the inventory.
480
396
        is the opposite of add.  Removing it is consistent with most
481
397
        other tools.  Maybe an option.
482
398
        """
483
 
        from bzrlib.textui import show_status
484
399
        ## TODO: Normalize names
485
400
        ## TODO: Remove nested loops; better scalability
486
 
        if isinstance(files, basestring):
 
401
        self._need_writelock()
 
402
 
 
403
        if isinstance(files, types.StringTypes):
487
404
            files = [files]
488
 
 
489
 
        self.lock_write()
490
 
 
491
 
        try:
492
 
            tree = self.working_tree()
493
 
            inv = tree.inventory
494
 
 
495
 
            # do this before any modifications
496
 
            for f in files:
497
 
                fid = inv.path2id(f)
498
 
                if not fid:
499
 
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
500
 
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
501
 
                if verbose:
502
 
                    # having remove it, it must be either ignored or unknown
503
 
                    if tree.is_ignored(f):
504
 
                        new_status = 'I'
505
 
                    else:
506
 
                        new_status = '?'
507
 
                    show_status(new_status, inv[fid].kind, quotefn(f))
508
 
                del inv[fid]
509
 
 
510
 
            self._write_inventory(inv)
511
 
        finally:
512
 
            self.unlock()
513
 
 
514
 
 
515
 
    # FIXME: this doesn't need to be a branch method
 
405
        
 
406
        tree = self.working_tree()
 
407
        inv = tree.inventory
 
408
 
 
409
        # do this before any modifications
 
410
        for f in files:
 
411
            fid = inv.path2id(f)
 
412
            if not fid:
 
413
                bailout("cannot remove unversioned file %s" % quotefn(f))
 
414
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
415
            if verbose:
 
416
                # having remove it, it must be either ignored or unknown
 
417
                if tree.is_ignored(f):
 
418
                    new_status = 'I'
 
419
                else:
 
420
                    new_status = '?'
 
421
                show_status(new_status, inv[fid].kind, quotefn(f))
 
422
            del inv[fid]
 
423
 
 
424
        self._write_inventory(inv)
 
425
 
516
426
    def set_inventory(self, new_inventory_list):
517
 
        from bzrlib.inventory import Inventory, InventoryEntry
518
427
        inv = Inventory()
519
428
        for path, file_id, parent, kind in new_inventory_list:
520
429
            name = os.path.basename(path)
544
453
 
545
454
 
546
455
    def append_revision(self, revision_id):
547
 
        from bzrlib.atomicfile import AtomicFile
548
 
 
549
456
        mutter("add {%s} to revision-history" % revision_id)
550
 
        rev_history = self.revision_history() + [revision_id]
551
 
 
552
 
        f = AtomicFile(self.controlfilename('revision-history'))
553
 
        try:
554
 
            for rev_id in rev_history:
555
 
                print >>f, rev_id
556
 
            f.commit()
557
 
        finally:
558
 
            f.close()
 
457
        rev_history = self.revision_history()
 
458
 
 
459
        tmprhname = self.controlfilename('revision-history.tmp')
 
460
        rhname = self.controlfilename('revision-history')
 
461
        
 
462
        f = file(tmprhname, 'wt')
 
463
        rev_history.append(revision_id)
 
464
        f.write('\n'.join(rev_history))
 
465
        f.write('\n')
 
466
        f.close()
 
467
 
 
468
        if sys.platform == 'win32':
 
469
            os.remove(rhname)
 
470
        os.rename(tmprhname, rhname)
 
471
        
559
472
 
560
473
 
561
474
    def get_revision(self, revision_id):
562
475
        """Return the Revision object for a named revision"""
563
 
        from bzrlib.revision import Revision
564
 
        from bzrlib.xml import unpack_xml
565
 
 
566
 
        self.lock_read()
567
 
        try:
568
 
            if not revision_id or not isinstance(revision_id, basestring):
569
 
                raise ValueError('invalid revision-id: %r' % revision_id)
570
 
            r = unpack_xml(Revision, self.revision_store[revision_id])
571
 
        finally:
572
 
            self.unlock()
573
 
            
 
476
        self._need_readlock()
 
477
        r = Revision.read_xml(self.revision_store[revision_id])
574
478
        assert r.revision_id == revision_id
575
479
        return r
576
 
        
577
 
 
578
 
    def get_revision_sha1(self, revision_id):
579
 
        """Hash the stored value of a revision, and return it."""
580
 
        # In the future, revision entries will be signed. At that
581
 
        # point, it is probably best *not* to include the signature
582
 
        # in the revision hash. Because that lets you re-sign
583
 
        # the revision, (add signatures/remove signatures) and still
584
 
        # have all hash pointers stay consistent.
585
 
        # But for now, just hash the contents.
586
 
        return sha_file(self.revision_store[revision_id])
587
480
 
588
481
 
589
482
    def get_inventory(self, inventory_id):
592
485
        TODO: Perhaps for this and similar methods, take a revision
593
486
               parameter which can be either an integer revno or a
594
487
               string hash."""
595
 
        from bzrlib.inventory import Inventory
596
 
        from bzrlib.xml import unpack_xml
597
 
 
598
 
        return unpack_xml(Inventory, self.inventory_store[inventory_id])
599
 
            
600
 
 
601
 
    def get_inventory_sha1(self, inventory_id):
602
 
        """Return the sha1 hash of the inventory entry
603
 
        """
604
 
        return sha_file(self.inventory_store[inventory_id])
 
488
        self._need_readlock()
 
489
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
490
        return i
605
491
 
606
492
 
607
493
    def get_revision_inventory(self, revision_id):
608
494
        """Return inventory of a past revision."""
 
495
        self._need_readlock()
609
496
        if revision_id == None:
610
 
            from bzrlib.inventory import Inventory
611
497
            return Inventory()
612
498
        else:
613
499
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
619
505
        >>> ScratchBranch().revision_history()
620
506
        []
621
507
        """
622
 
        self.lock_read()
623
 
        try:
624
 
            return [l.rstrip('\r\n') for l in
625
 
                    self.controlfile('revision-history', 'r').readlines()]
626
 
        finally:
627
 
            self.unlock()
628
 
 
629
 
 
630
 
    def common_ancestor(self, other, self_revno=None, other_revno=None):
631
 
        """
632
 
        >>> import commit
633
 
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
634
 
        >>> sb.common_ancestor(sb) == (None, None)
635
 
        True
636
 
        >>> commit.commit(sb, "Committing first revision", verbose=False)
637
 
        >>> sb.common_ancestor(sb)[0]
638
 
        1
639
 
        >>> clone = sb.clone()
640
 
        >>> commit.commit(sb, "Committing second revision", verbose=False)
641
 
        >>> sb.common_ancestor(sb)[0]
642
 
        2
643
 
        >>> sb.common_ancestor(clone)[0]
644
 
        1
645
 
        >>> commit.commit(clone, "Committing divergent second revision", 
646
 
        ...               verbose=False)
647
 
        >>> sb.common_ancestor(clone)[0]
648
 
        1
649
 
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
650
 
        True
651
 
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
652
 
        True
653
 
        >>> clone2 = sb.clone()
654
 
        >>> sb.common_ancestor(clone2)[0]
655
 
        2
656
 
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
657
 
        1
658
 
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
659
 
        1
660
 
        """
661
 
        my_history = self.revision_history()
662
 
        other_history = other.revision_history()
663
 
        if self_revno is None:
664
 
            self_revno = len(my_history)
665
 
        if other_revno is None:
666
 
            other_revno = len(other_history)
667
 
        indices = range(min((self_revno, other_revno)))
668
 
        indices.reverse()
669
 
        for r in indices:
670
 
            if my_history[r] == other_history[r]:
671
 
                return r+1, my_history[r]
672
 
        return None, None
 
508
        self._need_readlock()
 
509
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
 
510
 
673
511
 
674
512
    def enum_history(self, direction):
675
513
        """Return (revno, revision_id) for history of branch.
690
528
                yield i, rh[i-1]
691
529
                i -= 1
692
530
        else:
693
 
            raise ValueError('invalid history direction', direction)
 
531
            raise BzrError('invalid history direction %r' % direction)
694
532
 
695
533
 
696
534
    def revno(self):
712
550
            return None
713
551
 
714
552
 
715
 
    def missing_revisions(self, other, stop_revision=None):
716
 
        """
717
 
        If self and other have not diverged, return a list of the revisions
718
 
        present in other, but missing from self.
719
 
 
720
 
        >>> from bzrlib.commit import commit
721
 
        >>> bzrlib.trace.silent = True
722
 
        >>> br1 = ScratchBranch()
723
 
        >>> br2 = ScratchBranch()
724
 
        >>> br1.missing_revisions(br2)
725
 
        []
726
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
727
 
        >>> br1.missing_revisions(br2)
728
 
        [u'REVISION-ID-1']
729
 
        >>> br2.missing_revisions(br1)
730
 
        []
731
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
732
 
        >>> br1.missing_revisions(br2)
733
 
        []
734
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
735
 
        >>> br1.missing_revisions(br2)
736
 
        [u'REVISION-ID-2A']
737
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
738
 
        >>> br1.missing_revisions(br2)
739
 
        Traceback (most recent call last):
740
 
        DivergedBranches: These branches have diverged.
741
 
        """
742
 
        self_history = self.revision_history()
743
 
        self_len = len(self_history)
744
 
        other_history = other.revision_history()
745
 
        other_len = len(other_history)
746
 
        common_index = min(self_len, other_len) -1
747
 
        if common_index >= 0 and \
748
 
            self_history[common_index] != other_history[common_index]:
749
 
            raise DivergedBranches(self, other)
750
 
 
751
 
        if stop_revision is None:
752
 
            stop_revision = other_len
753
 
        elif stop_revision > other_len:
754
 
            raise NoSuchRevision(self, stop_revision)
755
 
        
756
 
        return other_history[self_len:stop_revision]
757
 
 
758
 
 
759
 
    def update_revisions(self, other, stop_revision=None):
760
 
        """Pull in all new revisions from other branch.
761
 
        
762
 
        >>> from bzrlib.commit import commit
763
 
        >>> bzrlib.trace.silent = True
764
 
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
765
 
        >>> br1.add('foo')
766
 
        >>> br1.add('bar')
767
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
768
 
        >>> br2 = ScratchBranch()
769
 
        >>> br2.update_revisions(br1)
770
 
        Added 2 texts.
771
 
        Added 1 inventories.
772
 
        Added 1 revisions.
773
 
        >>> br2.revision_history()
774
 
        [u'REVISION-ID-1']
775
 
        >>> br2.update_revisions(br1)
776
 
        Added 0 texts.
777
 
        Added 0 inventories.
778
 
        Added 0 revisions.
779
 
        >>> br1.text_store.total_size() == br2.text_store.total_size()
780
 
        True
781
 
        """
782
 
        from bzrlib.progress import ProgressBar
783
 
        try:
784
 
            set
785
 
        except NameError:
786
 
            from sets import Set as set
787
 
 
788
 
        pb = ProgressBar()
789
 
 
790
 
        pb.update('comparing histories')
791
 
        revision_ids = self.missing_revisions(other, stop_revision)
792
 
 
793
 
        if hasattr(other.revision_store, "prefetch"):
794
 
            other.revision_store.prefetch(revision_ids)
795
 
        if hasattr(other.inventory_store, "prefetch"):
796
 
            inventory_ids = [other.get_revision(r).inventory_id
797
 
                             for r in revision_ids]
798
 
            other.inventory_store.prefetch(inventory_ids)
799
 
                
800
 
        revisions = []
801
 
        needed_texts = set()
802
 
        i = 0
803
 
        for rev_id in revision_ids:
804
 
            i += 1
805
 
            pb.update('fetching revision', i, len(revision_ids))
806
 
            rev = other.get_revision(rev_id)
807
 
            revisions.append(rev)
808
 
            inv = other.get_inventory(str(rev.inventory_id))
809
 
            for key, entry in inv.iter_entries():
810
 
                if entry.text_id is None:
811
 
                    continue
812
 
                if entry.text_id not in self.text_store:
813
 
                    needed_texts.add(entry.text_id)
814
 
 
815
 
        pb.clear()
816
 
                    
817
 
        count = self.text_store.copy_multi(other.text_store, needed_texts)
818
 
        print "Added %d texts." % count 
819
 
        inventory_ids = [ f.inventory_id for f in revisions ]
820
 
        count = self.inventory_store.copy_multi(other.inventory_store, 
821
 
                                                inventory_ids)
822
 
        print "Added %d inventories." % count 
823
 
        revision_ids = [ f.revision_id for f in revisions]
824
 
        count = self.revision_store.copy_multi(other.revision_store, 
825
 
                                               revision_ids)
826
 
        for revision_id in revision_ids:
827
 
            self.append_revision(revision_id)
828
 
        print "Added %d revisions." % count
829
 
                    
830
 
        
831
553
    def commit(self, *args, **kw):
 
554
        """Deprecated"""
832
555
        from bzrlib.commit import commit
833
556
        commit(self, *args, **kw)
834
557
        
850
573
 
851
574
        `revision_id` may be None for the null revision, in which case
852
575
        an `EmptyTree` is returned."""
853
 
        from bzrlib.tree import EmptyTree, RevisionTree
854
 
        # TODO: refactor this to use an existing revision object
855
 
        # so we don't need to read it in twice.
 
576
        self._need_readlock()
856
577
        if revision_id == None:
857
578
            return EmptyTree()
858
579
        else:
871
592
 
872
593
        If there are no revisions yet, return an `EmptyTree`.
873
594
        """
874
 
        from bzrlib.tree import EmptyTree, RevisionTree
875
595
        r = self.last_patch()
876
596
        if r == None:
877
597
            return EmptyTree()
885
605
 
886
606
        This can change the directory or the filename or both.
887
607
        """
888
 
        self.lock_write()
 
608
        self._need_writelock()
 
609
        tree = self.working_tree()
 
610
        inv = tree.inventory
 
611
        if not tree.has_filename(from_rel):
 
612
            bailout("can't rename: old working file %r does not exist" % from_rel)
 
613
        if tree.has_filename(to_rel):
 
614
            bailout("can't rename: new working file %r already exists" % to_rel)
 
615
            
 
616
        file_id = inv.path2id(from_rel)
 
617
        if file_id == None:
 
618
            bailout("can't rename: old name %r is not versioned" % from_rel)
 
619
 
 
620
        if inv.path2id(to_rel):
 
621
            bailout("can't rename: new name %r is already versioned" % to_rel)
 
622
 
 
623
        to_dir, to_tail = os.path.split(to_rel)
 
624
        to_dir_id = inv.path2id(to_dir)
 
625
        if to_dir_id == None and to_dir != '':
 
626
            bailout("can't determine destination directory id for %r" % to_dir)
 
627
 
 
628
        mutter("rename_one:")
 
629
        mutter("  file_id    {%s}" % file_id)
 
630
        mutter("  from_rel   %r" % from_rel)
 
631
        mutter("  to_rel     %r" % to_rel)
 
632
        mutter("  to_dir     %r" % to_dir)
 
633
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
634
            
 
635
        inv.rename(file_id, to_dir_id, to_tail)
 
636
 
 
637
        print "%s => %s" % (from_rel, to_rel)
 
638
        
 
639
        from_abs = self.abspath(from_rel)
 
640
        to_abs = self.abspath(to_rel)
889
641
        try:
890
 
            tree = self.working_tree()
891
 
            inv = tree.inventory
892
 
            if not tree.has_filename(from_rel):
893
 
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
894
 
            if tree.has_filename(to_rel):
895
 
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
896
 
 
897
 
            file_id = inv.path2id(from_rel)
898
 
            if file_id == None:
899
 
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
900
 
 
901
 
            if inv.path2id(to_rel):
902
 
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
903
 
 
904
 
            to_dir, to_tail = os.path.split(to_rel)
905
 
            to_dir_id = inv.path2id(to_dir)
906
 
            if to_dir_id == None and to_dir != '':
907
 
                raise BzrError("can't determine destination directory id for %r" % to_dir)
908
 
 
909
 
            mutter("rename_one:")
910
 
            mutter("  file_id    {%s}" % file_id)
911
 
            mutter("  from_rel   %r" % from_rel)
912
 
            mutter("  to_rel     %r" % to_rel)
913
 
            mutter("  to_dir     %r" % to_dir)
914
 
            mutter("  to_dir_id  {%s}" % to_dir_id)
915
 
 
916
 
            inv.rename(file_id, to_dir_id, to_tail)
917
 
 
918
 
            print "%s => %s" % (from_rel, to_rel)
919
 
 
920
 
            from_abs = self.abspath(from_rel)
921
 
            to_abs = self.abspath(to_rel)
922
 
            try:
923
 
                os.rename(from_abs, to_abs)
924
 
            except OSError, e:
925
 
                raise BzrError("failed to rename %r to %r: %s"
926
 
                        % (from_abs, to_abs, e[1]),
927
 
                        ["rename rolled back"])
928
 
 
929
 
            self._write_inventory(inv)
930
 
        finally:
931
 
            self.unlock()
 
642
            os.rename(from_abs, to_abs)
 
643
        except OSError, e:
 
644
            bailout("failed to rename %r to %r: %s"
 
645
                    % (from_abs, to_abs, e[1]),
 
646
                    ["rename rolled back"])
 
647
 
 
648
        self._write_inventory(inv)
 
649
            
932
650
 
933
651
 
934
652
    def move(self, from_paths, to_name):
942
660
        Note that to_name is only the last component of the new name;
943
661
        this doesn't change the directory.
944
662
        """
945
 
        self.lock_write()
946
 
        try:
947
 
            ## TODO: Option to move IDs only
948
 
            assert not isinstance(from_paths, basestring)
949
 
            tree = self.working_tree()
950
 
            inv = tree.inventory
951
 
            to_abs = self.abspath(to_name)
952
 
            if not isdir(to_abs):
953
 
                raise BzrError("destination %r is not a directory" % to_abs)
954
 
            if not tree.has_filename(to_name):
955
 
                raise BzrError("destination %r not in working directory" % to_abs)
956
 
            to_dir_id = inv.path2id(to_name)
957
 
            if to_dir_id == None and to_name != '':
958
 
                raise BzrError("destination %r is not a versioned directory" % to_name)
959
 
            to_dir_ie = inv[to_dir_id]
960
 
            if to_dir_ie.kind not in ('directory', 'root_directory'):
961
 
                raise BzrError("destination %r is not a directory" % to_abs)
962
 
 
963
 
            to_idpath = inv.get_idpath(to_dir_id)
964
 
 
965
 
            for f in from_paths:
966
 
                if not tree.has_filename(f):
967
 
                    raise BzrError("%r does not exist in working tree" % f)
968
 
                f_id = inv.path2id(f)
969
 
                if f_id == None:
970
 
                    raise BzrError("%r is not versioned" % f)
971
 
                name_tail = splitpath(f)[-1]
972
 
                dest_path = appendpath(to_name, name_tail)
973
 
                if tree.has_filename(dest_path):
974
 
                    raise BzrError("destination %r already exists" % dest_path)
975
 
                if f_id in to_idpath:
976
 
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
977
 
 
978
 
            # OK, so there's a race here, it's possible that someone will
979
 
            # create a file in this interval and then the rename might be
980
 
            # left half-done.  But we should have caught most problems.
981
 
 
982
 
            for f in from_paths:
983
 
                name_tail = splitpath(f)[-1]
984
 
                dest_path = appendpath(to_name, name_tail)
985
 
                print "%s => %s" % (f, dest_path)
986
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
987
 
                try:
988
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
989
 
                except OSError, e:
990
 
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
991
 
                            ["rename rolled back"])
992
 
 
993
 
            self._write_inventory(inv)
994
 
        finally:
995
 
            self.unlock()
996
 
 
997
 
 
998
 
    def revert(self, filenames, old_tree=None, backups=True):
999
 
        """Restore selected files to the versions from a previous tree.
1000
 
 
1001
 
        backups
1002
 
            If true (default) backups are made of files before
1003
 
            they're renamed.
1004
 
        """
1005
 
        from bzrlib.errors import NotVersionedError, BzrError
1006
 
        from bzrlib.atomicfile import AtomicFile
1007
 
        from bzrlib.osutils import backup_file
1008
 
        
1009
 
        inv = self.read_working_inventory()
1010
 
        if old_tree is None:
1011
 
            old_tree = self.basis_tree()
1012
 
        old_inv = old_tree.inventory
1013
 
 
1014
 
        nids = []
1015
 
        for fn in filenames:
1016
 
            file_id = inv.path2id(fn)
1017
 
            if not file_id:
1018
 
                raise NotVersionedError("not a versioned file", fn)
1019
 
            if not old_inv.has_id(file_id):
1020
 
                raise BzrError("file not present in old tree", fn, file_id)
1021
 
            nids.append((fn, file_id))
1022
 
            
1023
 
        # TODO: Rename back if it was previously at a different location
1024
 
 
1025
 
        # TODO: If given a directory, restore the entire contents from
1026
 
        # the previous version.
1027
 
 
1028
 
        # TODO: Make a backup to a temporary file.
1029
 
 
1030
 
        # TODO: If the file previously didn't exist, delete it?
1031
 
        for fn, file_id in nids:
1032
 
            backup_file(fn)
1033
 
            
1034
 
            f = AtomicFile(fn, 'wb')
 
663
        self._need_writelock()
 
664
        ## TODO: Option to move IDs only
 
665
        assert not isinstance(from_paths, basestring)
 
666
        tree = self.working_tree()
 
667
        inv = tree.inventory
 
668
        to_abs = self.abspath(to_name)
 
669
        if not isdir(to_abs):
 
670
            bailout("destination %r is not a directory" % to_abs)
 
671
        if not tree.has_filename(to_name):
 
672
            bailout("destination %r not in working directory" % to_abs)
 
673
        to_dir_id = inv.path2id(to_name)
 
674
        if to_dir_id == None and to_name != '':
 
675
            bailout("destination %r is not a versioned directory" % to_name)
 
676
        to_dir_ie = inv[to_dir_id]
 
677
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
678
            bailout("destination %r is not a directory" % to_abs)
 
679
 
 
680
        to_idpath = Set(inv.get_idpath(to_dir_id))
 
681
 
 
682
        for f in from_paths:
 
683
            if not tree.has_filename(f):
 
684
                bailout("%r does not exist in working tree" % f)
 
685
            f_id = inv.path2id(f)
 
686
            if f_id == None:
 
687
                bailout("%r is not versioned" % f)
 
688
            name_tail = splitpath(f)[-1]
 
689
            dest_path = appendpath(to_name, name_tail)
 
690
            if tree.has_filename(dest_path):
 
691
                bailout("destination %r already exists" % dest_path)
 
692
            if f_id in to_idpath:
 
693
                bailout("can't move %r to a subdirectory of itself" % f)
 
694
 
 
695
        # OK, so there's a race here, it's possible that someone will
 
696
        # create a file in this interval and then the rename might be
 
697
        # left half-done.  But we should have caught most problems.
 
698
 
 
699
        for f in from_paths:
 
700
            name_tail = splitpath(f)[-1]
 
701
            dest_path = appendpath(to_name, name_tail)
 
702
            print "%s => %s" % (f, dest_path)
 
703
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
1035
704
            try:
1036
 
                f.write(old_tree.get_file(file_id).read())
1037
 
                f.commit()
1038
 
            finally:
1039
 
                f.close()
 
705
                os.rename(self.abspath(f), self.abspath(dest_path))
 
706
            except OSError, e:
 
707
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
708
                        ["rename rolled back"])
 
709
 
 
710
        self._write_inventory(inv)
 
711
 
1040
712
 
1041
713
 
1042
714
 
1051
723
    >>> isdir(bd)
1052
724
    False
1053
725
    """
1054
 
    def __init__(self, files=[], dirs=[], base=None):
 
726
    def __init__(self, files=[], dirs=[]):
1055
727
        """Make a test branch.
1056
728
 
1057
729
        This creates a temporary directory and runs init-tree in it.
1058
730
 
1059
731
        If any files are listed, they are created in the working copy.
1060
732
        """
1061
 
        from tempfile import mkdtemp
1062
 
        init = False
1063
 
        if base is None:
1064
 
            base = mkdtemp()
1065
 
            init = True
1066
 
        Branch.__init__(self, base, init=init)
 
733
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
1067
734
        for d in dirs:
1068
735
            os.mkdir(self.abspath(d))
1069
736
            
1071
738
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1072
739
 
1073
740
 
1074
 
    def clone(self):
1075
 
        """
1076
 
        >>> orig = ScratchBranch(files=["file1", "file2"])
1077
 
        >>> clone = orig.clone()
1078
 
        >>> os.path.samefile(orig.base, clone.base)
1079
 
        False
1080
 
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1081
 
        True
1082
 
        """
1083
 
        from shutil import copytree
1084
 
        from tempfile import mkdtemp
1085
 
        base = mkdtemp()
1086
 
        os.rmdir(base)
1087
 
        copytree(self.base, base, symlinks=True)
1088
 
        return ScratchBranch(base=base)
1089
 
        
1090
741
    def __del__(self):
1091
742
        self.destroy()
1092
743
 
1093
744
    def destroy(self):
1094
745
        """Destroy the test branch, removing the scratch directory."""
1095
 
        from shutil import rmtree
1096
746
        try:
1097
 
            if self.base:
1098
 
                mutter("delete ScratchBranch %s" % self.base)
1099
 
                rmtree(self.base)
 
747
            mutter("delete ScratchBranch %s" % self.base)
 
748
            shutil.rmtree(self.base)
1100
749
        except OSError, e:
1101
750
            # Work around for shutil.rmtree failing on Windows when
1102
751
            # readonly files are encountered
1104
753
            for root, dirs, files in os.walk(self.base, topdown=False):
1105
754
                for name in files:
1106
755
                    os.chmod(os.path.join(root, name), 0700)
1107
 
            rmtree(self.base)
 
756
            shutil.rmtree(self.base)
1108
757
        self.base = None
1109
758
 
1110
759
    
1134
783
    This should probably generate proper UUIDs, but for the moment we
1135
784
    cope with just randomness because running uuidgen every time is
1136
785
    slow."""
1137
 
    import re
1138
 
    from binascii import hexlify
1139
 
    from time import time
1140
 
 
1141
 
    # get last component
1142
786
    idx = name.rfind('/')
1143
787
    if idx != -1:
1144
788
        name = name[idx+1 : ]
1146
790
    if idx != -1:
1147
791
        name = name[idx+1 : ]
1148
792
 
1149
 
    # make it not a hidden file
1150
793
    name = name.lstrip('.')
1151
794
 
1152
 
    # remove any wierd characters; we don't escape them but rather
1153
 
    # just pull them out
1154
 
    name = re.sub(r'[^\w.]', '', name)
1155
 
 
1156
795
    s = hexlify(rand_bytes(8))
1157
 
    return '-'.join((name, compact_date(time()), s))
 
796
    return '-'.join((name, compact_date(time.time()), s))