← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: aaron.bentley at utoronto
  • Date: 2005-08-09 02:34:50 UTC
  • mto: (1092.1.41) (1185.3.4) (974.1.47)
  • mto: This revision was merged to the branch mainline in revision 1110.
  • Revision ID: aaron.bentley@utoronto.ca-20050809023450-ddb4910cc8d810cd
Removed use of patch and diff in merge, removed patch.diff

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
from sets import Set
19
 
 
20
 
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
 
import traceback, socket, fnmatch, difflib, time
22
 
from binascii import hexlify
 
18
import sys, os
23
19
 
24
20
import bzrlib
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, chomp, \
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
 
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
37
25
 
38
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
27
## TODO: Maybe include checks for common corruption of newlines, etc?
40
28
 
41
29
 
42
30
 
 
31
def find_branch(f, **args):
 
32
    if f and (f.startswith('http://') or f.startswith('https://')):
 
33
        import remotebranch 
 
34
        return remotebranch.RemoteBranch(f, **args)
 
35
    else:
 
36
        return Branch(f, **args)
 
37
 
 
38
 
 
39
def find_cached_branch(f, cache_root, **args):
 
40
    from remotebranch import RemoteBranch
 
41
    br = find_branch(f, **args)
 
42
    def cacheify(br, store_name):
 
43
        from meta_store import CachedStore
 
44
        cache_path = os.path.join(cache_root, store_name)
 
45
        os.mkdir(cache_path)
 
46
        new_store = CachedStore(getattr(br, store_name), cache_path)
 
47
        setattr(br, store_name, new_store)
 
48
 
 
49
    if isinstance(br, RemoteBranch):
 
50
        cacheify(br, 'inventory_store')
 
51
        cacheify(br, 'text_store')
 
52
        cacheify(br, 'revision_store')
 
53
    return br
 
54
 
 
55
 
 
56
def _relpath(base, path):
 
57
    """Return path relative to base, or raise exception.
 
58
 
 
59
    The path may be either an absolute path or a path relative to the
 
60
    current working directory.
 
61
 
 
62
    Lifted out of Branch.relpath for ease of testing.
 
63
 
 
64
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
65
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
66
    avoids that problem."""
 
67
    rp = os.path.abspath(path)
 
68
 
 
69
    s = []
 
70
    head = rp
 
71
    while len(head) >= len(base):
 
72
        if head == base:
 
73
            break
 
74
        head, tail = os.path.split(head)
 
75
        if tail:
 
76
            s.insert(0, tail)
 
77
    else:
 
78
        from errors import NotBranchError
 
79
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
 
80
 
 
81
    return os.sep.join(s)
 
82
        
 
83
 
43
84
def find_branch_root(f=None):
44
85
    """Find the branch root enclosing f, or pwd.
45
86
 
 
87
    f may be a filename or a URL.
 
88
 
46
89
    It is not necessary that f exists.
47
90
 
48
91
    Basically we keep looking up until we find the control directory or
53
96
        f = os.path.realpath(f)
54
97
    else:
55
98
        f = os.path.abspath(f)
 
99
    if not os.path.exists(f):
 
100
        raise BzrError('%r does not exist' % f)
 
101
        
56
102
 
57
103
    orig_f = f
58
104
 
65
111
            raise BzrError('%r is not in a branch' % orig_f)
66
112
        f = head
67
113
    
 
114
class DivergedBranches(Exception):
 
115
    def __init__(self, branch1, branch2):
 
116
        self.branch1 = branch1
 
117
        self.branch2 = branch2
 
118
        Exception.__init__(self, "These branches have diverged.")
 
119
 
 
120
 
 
121
class NoSuchRevision(BzrError):
 
122
    def __init__(self, branch, revision):
 
123
        self.branch = branch
 
124
        self.revision = revision
 
125
        msg = "Branch %s has no revision %d" % (branch, revision)
 
126
        BzrError.__init__(self, msg)
68
127
 
69
128
 
70
129
######################################################################
71
130
# branch objects
72
131
 
73
 
class Branch:
 
132
class Branch(object):
74
133
    """Branch holding a history of revisions.
75
134
 
76
 
    TODO: Perhaps use different stores for different classes of object,
77
 
           so that we can keep track of how much space each one uses,
78
 
           or garbage-collect them.
79
 
 
80
 
    TODO: Add a RemoteBranch subclass.  For the basic case of read-only
81
 
           HTTP access this should be very easy by, 
82
 
           just redirecting controlfile access into HTTP requests.
83
 
           We would need a RemoteStore working similarly.
84
 
 
85
 
    TODO: Keep the on-disk branch locked while the object exists.
86
 
 
87
 
    TODO: mkdir() method.
 
135
    base
 
136
        Base directory of the branch.
 
137
 
 
138
    _lock_mode
 
139
        None, or 'r' or 'w'
 
140
 
 
141
    _lock_count
 
142
        If _lock_mode is true, a positive count of the number of times the
 
143
        lock has been taken.
 
144
 
 
145
    _lock
 
146
        Lock object from bzrlib.lock.
88
147
    """
 
148
    base = None
 
149
    _lock_mode = None
 
150
    _lock_count = None
 
151
    _lock = None
 
152
    
 
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
 
89
158
    def __init__(self, base, init=False, find_root=True):
90
159
        """Create new branch object at a particular location.
91
160
 
101
170
        In the test suite, creation of new trees is tested using the
102
171
        `ScratchBranch` class.
103
172
        """
 
173
        from bzrlib.store import ImmutableStore
104
174
        if init:
105
175
            self.base = os.path.realpath(base)
106
176
            self._make_control()
109
179
        else:
110
180
            self.base = os.path.realpath(base)
111
181
            if not isdir(self.controlfilename('.')):
112
 
                bailout("not a bzr branch: %s" % quotefn(base),
113
 
                        ['use "bzr init" to initialize a new working tree',
114
 
                         'current bzr can only operate from top-of-tree'])
 
182
                from errors import NotBranchError
 
183
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
 
184
                                     ['use "bzr init" to initialize a new working tree',
 
185
                                      'current bzr can only operate from top-of-tree'])
115
186
        self._check_format()
116
187
 
117
188
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
126
197
    __repr__ = __str__
127
198
 
128
199
 
 
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
 
 
237
            
 
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
 
249
 
 
250
 
129
251
    def abspath(self, name):
130
252
        """Return absolute filename for something in the branch"""
131
253
        return os.path.join(self.base, name)
135
257
        """Return path relative to this branch of something inside it.
136
258
 
137
259
        Raises an error if path is not in this branch."""
138
 
        rp = os.path.realpath(path)
139
 
        # FIXME: windows
140
 
        if not rp.startswith(self.base):
141
 
            bailout("path %r is not within branch %r" % (rp, self.base))
142
 
        rp = rp[len(self.base):]
143
 
        rp = rp.lstrip(os.sep)
144
 
        return rp
 
260
        return _relpath(self.base, path)
145
261
 
146
262
 
147
263
    def controlfilename(self, file_or_path):
148
264
        """Return location relative to branch."""
149
 
        if isinstance(file_or_path, types.StringTypes):
 
265
        if isinstance(file_or_path, basestring):
150
266
            file_or_path = [file_or_path]
151
267
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
152
268
 
158
274
        and binary.  binary files are untranslated byte streams.  Text
159
275
        control files are stored with Unix newlines and in UTF-8, even
160
276
        if the platform or locale defaults are different.
 
277
 
 
278
        Controlfiles should almost never be opened in write mode but
 
279
        rather should be atomically copied and replaced using atomicfile.
161
280
        """
162
281
 
163
282
        fn = self.controlfilename(file_or_path)
176
295
 
177
296
 
178
297
    def _make_control(self):
 
298
        from bzrlib.inventory import Inventory
 
299
        from bzrlib.xml import pack_xml
 
300
        
179
301
        os.mkdir(self.controlfilename([]))
180
302
        self.controlfile('README', 'w').write(
181
303
            "This is a Bazaar-NG control directory.\n"
182
 
            "Do not change any files in this directory.")
 
304
            "Do not change any files in this directory.\n")
183
305
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
184
306
        for d in ('text-store', 'inventory-store', 'revision-store'):
185
307
            os.mkdir(self.controlfilename(d))
186
308
        for f in ('revision-history', 'merged-patches',
187
 
                  'pending-merged-patches', 'branch-name'):
 
309
                  'pending-merged-patches', 'branch-name',
 
310
                  'branch-lock',
 
311
                  'pending-merges'):
188
312
            self.controlfile(f, 'w').write('')
189
313
        mutter('created control directory in ' + self.base)
190
 
        Inventory().write_xml(self.controlfile('inventory','w'))
 
314
 
 
315
        pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
191
316
 
192
317
 
193
318
    def _check_format(self):
204
329
        fmt = self.controlfile('branch-format', 'r').read()
205
330
        fmt.replace('\r\n', '')
206
331
        if fmt != BZR_BRANCH_FORMAT:
207
 
            bailout('sorry, branch format %r not supported' % fmt,
208
 
                    ['use a different bzr version',
209
 
                     'or remove the .bzr directory and "bzr init" again'])
210
 
 
 
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)
211
352
 
212
353
    def read_working_inventory(self):
213
354
        """Read the working inventory."""
214
 
        before = time.time()
215
 
        # ElementTree does its own conversion from UTF-8, so open in
216
 
        # binary.
217
 
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
218
 
        mutter("loaded inventory of %d items in %f"
219
 
               % (len(inv), time.time() - before))
220
 
        return inv
221
 
 
 
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
            
222
371
 
223
372
    def _write_inventory(self, inv):
224
373
        """Update the working inventory.
226
375
        That is to say, the inventory describing changes underway, that
227
376
        will be committed to the next revision.
228
377
        """
229
 
        ## TODO: factor out to atomicfile?  is rename safe on windows?
230
 
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
231
 
        tmpfname = self.controlfilename('inventory.tmp')
232
 
        tmpf = file(tmpfname, 'wb')
233
 
        inv.write_xml(tmpf)
234
 
        tmpf.close()
235
 
        inv_fname = self.controlfilename('inventory')
236
 
        if sys.platform == 'win32':
237
 
            os.remove(inv_fname)
238
 
        os.rename(tmpfname, inv_fname)
 
378
        from bzrlib.atomicfile import AtomicFile
 
379
        from bzrlib.xml import pack_xml
 
380
        
 
381
        self.lock_write()
 
382
        try:
 
383
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
 
384
            try:
 
385
                pack_xml(inv, f)
 
386
                f.commit()
 
387
            finally:
 
388
                f.close()
 
389
        finally:
 
390
            self.unlock()
 
391
        
239
392
        mutter('wrote working inventory')
240
 
 
 
393
            
241
394
 
242
395
    inventory = property(read_working_inventory, _write_inventory, None,
243
396
                         """Inventory for the working copy.""")
244
397
 
245
398
 
246
 
    def add(self, files, verbose=False):
 
399
    def add(self, files, verbose=False, ids=None):
247
400
        """Make files versioned.
248
401
 
249
402
        Note that the command line normally calls smart_add instead.
251
404
        This puts the files in the Added state, so that they will be
252
405
        recorded by the next commit.
253
406
 
 
407
        files
 
408
            List of paths to add, relative to the base of the tree.
 
409
 
 
410
        ids
 
411
            If set, use these instead of automatically generated ids.
 
412
            Must be the same length as the list of files, but may
 
413
            contain None for ids that are to be autogenerated.
 
414
 
254
415
        TODO: Perhaps have an option to add the ids even if the files do
255
 
               not (yet) exist.
 
416
              not (yet) exist.
256
417
 
257
418
        TODO: Perhaps return the ids of the files?  But then again it
258
 
               is easy to retrieve them if they're needed.
259
 
 
260
 
        TODO: Option to specify file id.
 
419
              is easy to retrieve them if they're needed.
261
420
 
262
421
        TODO: Adding a directory should optionally recurse down and
263
 
               add all non-ignored children.  Perhaps do that in a
264
 
               higher-level method.
265
 
 
266
 
        >>> b = ScratchBranch(files=['foo'])
267
 
        >>> 'foo' in b.unknowns()
268
 
        True
269
 
        >>> b.show_status()
270
 
        ?       foo
271
 
        >>> b.add('foo')
272
 
        >>> 'foo' in b.unknowns()
273
 
        False
274
 
        >>> bool(b.inventory.path2id('foo'))
275
 
        True
276
 
        >>> b.show_status()
277
 
        A       foo
278
 
 
279
 
        >>> b.add('foo')
280
 
        Traceback (most recent call last):
281
 
        ...
282
 
        BzrError: ('foo is already versioned', [])
283
 
 
284
 
        >>> b.add(['nothere'])
285
 
        Traceback (most recent call last):
286
 
        BzrError: ('cannot add: not a regular file or directory: nothere', [])
 
422
              add all non-ignored children.  Perhaps do that in a
 
423
              higher-level method.
287
424
        """
288
 
 
 
425
        from bzrlib.textui import show_status
289
426
        # TODO: Re-adding a file that is removed in the working copy
290
427
        # should probably put it back with the previous ID.
291
 
        if isinstance(files, types.StringTypes):
 
428
        if isinstance(files, basestring):
 
429
            assert(ids is None or isinstance(ids, basestring))
292
430
            files = [files]
293
 
        
294
 
        inv = self.read_working_inventory()
295
 
        for f in files:
296
 
            if is_control_file(f):
297
 
                bailout("cannot add control file %s" % quotefn(f))
298
 
 
299
 
            fp = splitpath(f)
300
 
 
301
 
            if len(fp) == 0:
302
 
                bailout("cannot add top-level %r" % f)
303
 
                
304
 
            fullpath = os.path.normpath(self.abspath(f))
305
 
 
306
 
            try:
307
 
                kind = file_kind(fullpath)
308
 
            except OSError:
309
 
                # maybe something better?
310
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
311
 
            
312
 
            if kind != 'file' and kind != 'directory':
313
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
314
 
 
315
 
            file_id = gen_file_id(f)
316
 
            inv.add_path(f, kind=kind, file_id=file_id)
317
 
 
318
 
            if verbose:
319
 
                show_status('A', kind, quotefn(f))
320
 
                
321
 
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
322
 
            
323
 
        self._write_inventory(inv)
324
 
 
 
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
            
325
475
 
326
476
    def print_file(self, file, revno):
327
477
        """Print `file` to stdout."""
328
 
        tree = self.revision_tree(self.lookup_revision(revno))
329
 
        # use inventory as it was in that revision
330
 
        file_id = tree.inventory.path2id(file)
331
 
        if not file_id:
332
 
            bailout("%r is not present in revision %d" % (file, revno))
333
 
        tree.print_file(file_id)
334
 
        
 
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
 
335
489
 
336
490
    def remove(self, files, verbose=False):
337
491
        """Mark nominated files for removal from the inventory.
340
494
 
341
495
        TODO: Refuse to remove modified files unless --force is given?
342
496
 
343
 
        >>> b = ScratchBranch(files=['foo'])
344
 
        >>> b.add('foo')
345
 
        >>> b.inventory.has_filename('foo')
346
 
        True
347
 
        >>> b.remove('foo')
348
 
        >>> b.working_tree().has_filename('foo')
349
 
        True
350
 
        >>> b.inventory.has_filename('foo')
351
 
        False
352
 
        
353
 
        >>> b = ScratchBranch(files=['foo'])
354
 
        >>> b.add('foo')
355
 
        >>> b.commit('one')
356
 
        >>> b.remove('foo')
357
 
        >>> b.commit('two')
358
 
        >>> b.inventory.has_filename('foo') 
359
 
        False
360
 
        >>> b.basis_tree().has_filename('foo') 
361
 
        False
362
 
        >>> b.working_tree().has_filename('foo') 
363
 
        True
364
 
 
365
497
        TODO: Do something useful with directories.
366
498
 
367
499
        TODO: Should this remove the text or not?  Tough call; not
369
501
        is the opposite of add.  Removing it is consistent with most
370
502
        other tools.  Maybe an option.
371
503
        """
 
504
        from bzrlib.textui import show_status
372
505
        ## TODO: Normalize names
373
506
        ## TODO: Remove nested loops; better scalability
374
 
 
375
 
        if isinstance(files, types.StringTypes):
 
507
        if isinstance(files, basestring):
376
508
            files = [files]
377
 
        
378
 
        tree = self.working_tree()
379
 
        inv = tree.inventory
380
 
 
381
 
        # do this before any modifications
382
 
        for f in files:
383
 
            fid = inv.path2id(f)
384
 
            if not fid:
385
 
                bailout("cannot remove unversioned file %s" % quotefn(f))
386
 
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
387
 
            if verbose:
388
 
                # having remove it, it must be either ignored or unknown
389
 
                if tree.is_ignored(f):
390
 
                    new_status = 'I'
391
 
                else:
392
 
                    new_status = '?'
393
 
                show_status(new_status, inv[fid].kind, quotefn(f))
394
 
            del inv[fid]
395
 
 
 
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))
396
545
        self._write_inventory(inv)
397
546
 
398
547
 
415
564
        return self.working_tree().unknowns()
416
565
 
417
566
 
418
 
    def commit(self, message, timestamp=None, timezone=None,
419
 
               committer=None,
420
 
               verbose=False):
421
 
        """Commit working copy as a new revision.
422
 
        
423
 
        The basic approach is to add all the file texts into the
424
 
        store, then the inventory, then make a new revision pointing
425
 
        to that inventory and store that.
426
 
        
427
 
        This is not quite safe if the working copy changes during the
428
 
        commit; for the moment that is simply not allowed.  A better
429
 
        approach is to make a temporary copy of the files before
430
 
        computing their hashes, and then add those hashes in turn to
431
 
        the inventory.  This should mean at least that there are no
432
 
        broken hash pointers.  There is no way we can get a snapshot
433
 
        of the whole directory at an instant.  This would also have to
434
 
        be robust against files disappearing, moving, etc.  So the
435
 
        whole thing is a bit hard.
436
 
 
437
 
        timestamp -- if not None, seconds-since-epoch for a
438
 
             postdated/predated commit.
439
 
        """
440
 
 
441
 
        ## TODO: Show branch names
442
 
 
443
 
        # TODO: Don't commit if there are no changes, unless forced?
444
 
 
445
 
        # First walk over the working inventory; and both update that
446
 
        # and also build a new revision inventory.  The revision
447
 
        # inventory needs to hold the text-id, sha1 and size of the
448
 
        # actual file versions committed in the revision.  (These are
449
 
        # not present in the working inventory.)  We also need to
450
 
        # detect missing/deleted files, and remove them from the
451
 
        # working inventory.
452
 
 
453
 
        work_inv = self.read_working_inventory()
454
 
        inv = Inventory()
455
 
        basis = self.basis_tree()
456
 
        basis_inv = basis.inventory
457
 
        missing_ids = []
458
 
        for path, entry in work_inv.iter_entries():
459
 
            ## TODO: Cope with files that have gone missing.
460
 
 
461
 
            ## TODO: Check that the file kind has not changed from the previous
462
 
            ## revision of this file (if any).
463
 
 
464
 
            entry = entry.copy()
465
 
 
466
 
            p = self.abspath(path)
467
 
            file_id = entry.file_id
468
 
            mutter('commit prep file %s, id %r ' % (p, file_id))
469
 
 
470
 
            if not os.path.exists(p):
471
 
                mutter("    file is missing, removing from inventory")
472
 
                if verbose:
473
 
                    show_status('D', entry.kind, quotefn(path))
474
 
                missing_ids.append(file_id)
475
 
                continue
476
 
 
477
 
            # TODO: Handle files that have been deleted
478
 
 
479
 
            # TODO: Maybe a special case for empty files?  Seems a
480
 
            # waste to store them many times.
481
 
 
482
 
            inv.add(entry)
483
 
 
484
 
            if basis_inv.has_id(file_id):
485
 
                old_kind = basis_inv[file_id].kind
486
 
                if old_kind != entry.kind:
487
 
                    bailout("entry %r changed kind from %r to %r"
488
 
                            % (file_id, old_kind, entry.kind))
489
 
 
490
 
            if entry.kind == 'directory':
491
 
                if not isdir(p):
492
 
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
493
 
            elif entry.kind == 'file':
494
 
                if not isfile(p):
495
 
                    bailout("%s is entered as file but is not a file" % quotefn(p))
496
 
 
497
 
                content = file(p, 'rb').read()
498
 
 
499
 
                entry.text_sha1 = sha_string(content)
500
 
                entry.text_size = len(content)
501
 
 
502
 
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
503
 
                if (old_ie
504
 
                    and (old_ie.text_size == entry.text_size)
505
 
                    and (old_ie.text_sha1 == entry.text_sha1)):
506
 
                    ## assert content == basis.get_file(file_id).read()
507
 
                    entry.text_id = basis_inv[file_id].text_id
508
 
                    mutter('    unchanged from previous text_id {%s}' %
509
 
                           entry.text_id)
510
 
                    
511
 
                else:
512
 
                    entry.text_id = gen_file_id(entry.name)
513
 
                    self.text_store.add(content, entry.text_id)
514
 
                    mutter('    stored with text_id {%s}' % entry.text_id)
515
 
                    if verbose:
516
 
                        if not old_ie:
517
 
                            state = 'A'
518
 
                        elif (old_ie.name == entry.name
519
 
                              and old_ie.parent_id == entry.parent_id):
520
 
                            state = 'M'
521
 
                        else:
522
 
                            state = 'R'
523
 
 
524
 
                        show_status(state, entry.kind, quotefn(path))
525
 
 
526
 
        for file_id in missing_ids:
527
 
            # have to do this later so we don't mess up the iterator.
528
 
            # since parents may be removed before their children we
529
 
            # have to test.
530
 
 
531
 
            # FIXME: There's probably a better way to do this; perhaps
532
 
            # the workingtree should know how to filter itself.
533
 
            if work_inv.has_id(file_id):
534
 
                del work_inv[file_id]
535
 
 
536
 
 
537
 
        inv_id = rev_id = _gen_revision_id(time.time())
538
 
        
539
 
        inv_tmp = tempfile.TemporaryFile()
540
 
        inv.write_xml(inv_tmp)
541
 
        inv_tmp.seek(0)
542
 
        self.inventory_store.add(inv_tmp, inv_id)
543
 
        mutter('new inventory_id is {%s}' % inv_id)
544
 
 
545
 
        self._write_inventory(work_inv)
546
 
 
547
 
        if timestamp == None:
548
 
            timestamp = time.time()
549
 
 
550
 
        if committer == None:
551
 
            committer = username()
552
 
 
553
 
        if timezone == None:
554
 
            timezone = local_time_offset()
555
 
 
556
 
        mutter("building commit log message")
557
 
        rev = Revision(timestamp=timestamp,
558
 
                       timezone=timezone,
559
 
                       committer=committer,
560
 
                       precursor = self.last_patch(),
561
 
                       message = message,
562
 
                       inventory_id=inv_id,
563
 
                       revision_id=rev_id)
564
 
 
565
 
        rev_tmp = tempfile.TemporaryFile()
566
 
        rev.write_xml(rev_tmp)
567
 
        rev_tmp.seek(0)
568
 
        self.revision_store.add(rev_tmp, rev_id)
569
 
        mutter("new revision_id is {%s}" % rev_id)
570
 
        
571
 
        ## XXX: Everything up to here can simply be orphaned if we abort
572
 
        ## the commit; it will leave junk files behind but that doesn't
573
 
        ## matter.
574
 
 
575
 
        ## TODO: Read back the just-generated changeset, and make sure it
576
 
        ## applies and recreates the right state.
577
 
 
578
 
        ## TODO: Also calculate and store the inventory SHA1
579
 
        mutter("committing patch r%d" % (self.revno() + 1))
580
 
 
581
 
 
582
 
        self.append_revision(rev_id)
583
 
        
584
 
        if verbose:
585
 
            note("commited r%d" % self.revno())
586
 
 
587
 
 
588
 
    def append_revision(self, revision_id):
589
 
        mutter("add {%s} to revision-history" % revision_id)
 
567
    def append_revision(self, *revision_ids):
 
568
        from bzrlib.atomicfile import AtomicFile
 
569
 
 
570
        for revision_id in revision_ids:
 
571
            mutter("add {%s} to revision-history" % revision_id)
 
572
 
590
573
        rev_history = self.revision_history()
591
 
 
592
 
        tmprhname = self.controlfilename('revision-history.tmp')
593
 
        rhname = self.controlfilename('revision-history')
594
 
        
595
 
        f = file(tmprhname, 'wt')
596
 
        rev_history.append(revision_id)
597
 
        f.write('\n'.join(rev_history))
598
 
        f.write('\n')
599
 
        f.close()
600
 
 
601
 
        if sys.platform == 'win32':
602
 
            os.remove(rhname)
603
 
        os.rename(tmprhname, rhname)
604
 
        
 
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()
605
583
 
606
584
 
607
585
    def get_revision(self, revision_id):
608
586
        """Return the Revision object for a named revision"""
609
 
        r = Revision.read_xml(self.revision_store[revision_id])
 
587
        from bzrlib.revision import Revision
 
588
        from bzrlib.xml import unpack_xml
 
589
 
 
590
        self.lock_read()
 
591
        try:
 
592
            if not revision_id or not isinstance(revision_id, basestring):
 
593
                raise ValueError('invalid revision-id: %r' % revision_id)
 
594
            r = unpack_xml(Revision, self.revision_store[revision_id])
 
595
        finally:
 
596
            self.unlock()
 
597
            
610
598
        assert r.revision_id == revision_id
611
599
        return r
 
600
        
 
601
 
 
602
    def get_revision_sha1(self, revision_id):
 
603
        """Hash the stored value of a revision, and return it."""
 
604
        # In the future, revision entries will be signed. At that
 
605
        # point, it is probably best *not* to include the signature
 
606
        # in the revision hash. Because that lets you re-sign
 
607
        # the revision, (add signatures/remove signatures) and still
 
608
        # have all hash pointers stay consistent.
 
609
        # But for now, just hash the contents.
 
610
        return sha_file(self.revision_store[revision_id])
612
611
 
613
612
 
614
613
    def get_inventory(self, inventory_id):
617
616
        TODO: Perhaps for this and similar methods, take a revision
618
617
               parameter which can be either an integer revno or a
619
618
               string hash."""
620
 
        i = Inventory.read_xml(self.inventory_store[inventory_id])
621
 
        return i
 
619
        from bzrlib.inventory import Inventory
 
620
        from bzrlib.xml import unpack_xml
 
621
 
 
622
        return unpack_xml(Inventory, self.inventory_store[inventory_id])
 
623
            
 
624
 
 
625
    def get_inventory_sha1(self, inventory_id):
 
626
        """Return the sha1 hash of the inventory entry
 
627
        """
 
628
        return sha_file(self.inventory_store[inventory_id])
622
629
 
623
630
 
624
631
    def get_revision_inventory(self, revision_id):
625
632
        """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.
626
635
        if revision_id == None:
627
 
            return Inventory()
 
636
            from bzrlib.inventory import Inventory
 
637
            return Inventory(self.get_root_id())
628
638
        else:
629
 
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
639
            return self.get_inventory(revision_id)
630
640
 
631
641
 
632
642
    def revision_history(self):
635
645
        >>> ScratchBranch().revision_history()
636
646
        []
637
647
        """
638
 
        return [chomp(l) for l in self.controlfile('revision-history', 'r').readlines()]
 
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
 
699
 
 
700
    def enum_history(self, direction):
 
701
        """Return (revno, revision_id) for history of branch.
 
702
 
 
703
        direction
 
704
            'forward' is from earliest to latest
 
705
            'reverse' is from latest to earliest
 
706
        """
 
707
        rh = self.revision_history()
 
708
        if direction == 'forward':
 
709
            i = 1
 
710
            for rid in rh:
 
711
                yield i, rid
 
712
                i += 1
 
713
        elif direction == 'reverse':
 
714
            i = len(rh)
 
715
            while i > 0:
 
716
                yield i, rh[i-1]
 
717
                i -= 1
 
718
        else:
 
719
            raise ValueError('invalid history direction', direction)
639
720
 
640
721
 
641
722
    def revno(self):
643
724
 
644
725
        That is equivalent to the number of revisions committed to
645
726
        this branch.
646
 
 
647
 
        >>> b = ScratchBranch()
648
 
        >>> b.revno()
649
 
        0
650
 
        >>> b.commit('no foo')
651
 
        >>> b.revno()
652
 
        1
653
727
        """
654
728
        return len(self.revision_history())
655
729
 
656
730
 
657
731
    def last_patch(self):
658
732
        """Return last patch hash, or None if no history.
659
 
 
660
 
        >>> ScratchBranch().last_patch() == None
661
 
        True
662
733
        """
663
734
        ph = self.revision_history()
664
735
        if ph:
665
736
            return ph[-1]
666
737
        else:
667
738
            return None
668
 
        
669
 
 
670
 
    def lookup_revision(self, revno):
671
 
        """Return revision hash for revision number."""
672
 
        if revno == 0:
673
 
            return None
674
 
 
675
 
        try:
676
 
            # list is 0-based; revisions are 1-based
677
 
            return self.revision_history()[revno-1]
678
 
        except IndexError:
679
 
            raise BzrError("no such revision %s" % revno)
680
 
 
 
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
681
1015
 
682
1016
    def revision_tree(self, revision_id):
683
1017
        """Return Tree for a revision on this branch.
684
1018
 
685
1019
        `revision_id` may be None for the null revision, in which case
686
1020
        an `EmptyTree` is returned."""
687
 
 
 
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.
688
1024
        if revision_id == None:
689
 
            return EmptyTree()
 
1025
            return EmptyTree(self.get_root_id())
690
1026
        else:
691
1027
            inv = self.get_revision_inventory(revision_id)
692
1028
            return RevisionTree(self.text_store, inv)
694
1030
 
695
1031
    def working_tree(self):
696
1032
        """Return a `Tree` for the working copy."""
 
1033
        from workingtree import WorkingTree
697
1034
        return WorkingTree(self.base, self.read_working_inventory())
698
1035
 
699
1036
 
701
1038
        """Return `Tree` object for last revision.
702
1039
 
703
1040
        If there are no revisions yet, return an `EmptyTree`.
704
 
 
705
 
        >>> b = ScratchBranch(files=['foo'])
706
 
        >>> b.basis_tree().has_filename('foo')
707
 
        False
708
 
        >>> b.working_tree().has_filename('foo')
709
 
        True
710
 
        >>> b.add('foo')
711
 
        >>> b.commit('add foo')
712
 
        >>> b.basis_tree().has_filename('foo')
713
 
        True
714
1041
        """
 
1042
        from bzrlib.tree import EmptyTree, RevisionTree
715
1043
        r = self.last_patch()
716
1044
        if r == None:
717
 
            return EmptyTree()
 
1045
            return EmptyTree(self.get_root_id())
718
1046
        else:
719
1047
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
720
1048
 
721
1049
 
722
1050
 
723
 
    def write_log(self, show_timezone='original', verbose=False):
724
 
        """Write out human-readable log of commits to this branch
725
 
 
726
 
        utc -- If true, show dates in universal time, not local time."""
727
 
        ## TODO: Option to choose either original, utc or local timezone
728
 
        revno = 1
729
 
        precursor = None
730
 
        for p in self.revision_history():
731
 
            print '-' * 40
732
 
            print 'revno:', revno
733
 
            ## TODO: Show hash if --id is given.
734
 
            ##print 'revision-hash:', p
735
 
            rev = self.get_revision(p)
736
 
            print 'committer:', rev.committer
737
 
            print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
738
 
                                                 show_timezone))
739
 
 
740
 
            ## opportunistic consistency check, same as check_patch_chaining
741
 
            if rev.precursor != precursor:
742
 
                bailout("mismatched precursor!")
743
 
 
744
 
            print 'message:'
745
 
            if not rev.message:
746
 
                print '  (no message)'
747
 
            else:
748
 
                for l in rev.message.split('\n'):
749
 
                    print '  ' + l
750
 
 
751
 
            if verbose == True and precursor != None:
752
 
                print 'changed files:'
753
 
                tree = self.revision_tree(p)
754
 
                prevtree = self.revision_tree(precursor)
755
 
                
756
 
                for file_state, fid, old_name, new_name, kind in \
757
 
                                        diff_trees(prevtree, tree, ):
758
 
                    if file_state == 'A' or file_state == 'M':
759
 
                        show_status(file_state, kind, new_name)
760
 
                    elif file_state == 'D':
761
 
                        show_status(file_state, kind, old_name)
762
 
                    elif file_state == 'R':
763
 
                        show_status(file_state, kind,
764
 
                            old_name + ' => ' + new_name)
765
 
                
766
 
            revno += 1
767
 
            precursor = p
768
 
 
769
 
 
770
1051
    def rename_one(self, from_rel, to_rel):
771
 
        tree = self.working_tree()
772
 
        inv = tree.inventory
773
 
        if not tree.has_filename(from_rel):
774
 
            bailout("can't rename: old working file %r does not exist" % from_rel)
775
 
        if tree.has_filename(to_rel):
776
 
            bailout("can't rename: new working file %r already exists" % to_rel)
777
 
            
778
 
        file_id = inv.path2id(from_rel)
779
 
        if file_id == None:
780
 
            bailout("can't rename: old name %r is not versioned" % from_rel)
781
 
 
782
 
        if inv.path2id(to_rel):
783
 
            bailout("can't rename: new name %r is already versioned" % to_rel)
784
 
 
785
 
        to_dir, to_tail = os.path.split(to_rel)
786
 
        to_dir_id = inv.path2id(to_dir)
787
 
        if to_dir_id == None and to_dir != '':
788
 
            bailout("can't determine destination directory id for %r" % to_dir)
789
 
 
790
 
        mutter("rename_one:")
791
 
        mutter("  file_id    {%s}" % file_id)
792
 
        mutter("  from_rel   %r" % from_rel)
793
 
        mutter("  to_rel     %r" % to_rel)
794
 
        mutter("  to_dir     %r" % to_dir)
795
 
        mutter("  to_dir_id  {%s}" % to_dir_id)
796
 
            
797
 
        inv.rename(file_id, to_dir_id, to_tail)
798
 
 
799
 
        print "%s => %s" % (from_rel, to_rel)
800
 
        
801
 
        from_abs = self.abspath(from_rel)
802
 
        to_abs = self.abspath(to_rel)
 
1052
        """Rename one file.
 
1053
 
 
1054
        This can change the directory or the filename or both.
 
1055
        """
 
1056
        self.lock_write()
803
1057
        try:
804
 
            os.rename(from_abs, to_abs)
805
 
        except OSError, e:
806
 
            bailout("failed to rename %r to %r: %s"
807
 
                    % (from_abs, to_abs, e[1]),
808
 
                    ["rename rolled back"])
809
 
 
810
 
        self._write_inventory(inv)
811
 
            
 
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()
812
1100
 
813
1101
 
814
1102
    def move(self, from_paths, to_name):
822
1110
        Note that to_name is only the last component of the new name;
823
1111
        this doesn't change the directory.
824
1112
        """
825
 
        ## TODO: Option to move IDs only
826
 
        assert not isinstance(from_paths, basestring)
827
 
        tree = self.working_tree()
828
 
        inv = tree.inventory
829
 
        to_abs = self.abspath(to_name)
830
 
        if not isdir(to_abs):
831
 
            bailout("destination %r is not a directory" % to_abs)
832
 
        if not tree.has_filename(to_name):
833
 
            bailout("destination %r not in working directory" % to_abs)
834
 
        to_dir_id = inv.path2id(to_name)
835
 
        if to_dir_id == None and to_name != '':
836
 
            bailout("destination %r is not a versioned directory" % to_name)
837
 
        to_dir_ie = inv[to_dir_id]
838
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
839
 
            bailout("destination %r is not a directory" % to_abs)
840
 
 
841
 
        to_idpath = Set(inv.get_idpath(to_dir_id))
842
 
 
843
 
        for f in from_paths:
844
 
            if not tree.has_filename(f):
845
 
                bailout("%r does not exist in working tree" % f)
846
 
            f_id = inv.path2id(f)
847
 
            if f_id == None:
848
 
                bailout("%r is not versioned" % f)
849
 
            name_tail = splitpath(f)[-1]
850
 
            dest_path = appendpath(to_name, name_tail)
851
 
            if tree.has_filename(dest_path):
852
 
                bailout("destination %r already exists" % dest_path)
853
 
            if f_id in to_idpath:
854
 
                bailout("can't move %r to a subdirectory of itself" % f)
855
 
 
856
 
        # OK, so there's a race here, it's possible that someone will
857
 
        # create a file in this interval and then the rename might be
858
 
        # left half-done.  But we should have caught most problems.
859
 
 
860
 
        for f in from_paths:
861
 
            name_tail = splitpath(f)[-1]
862
 
            dest_path = appendpath(to_name, name_tail)
863
 
            print "%s => %s" % (f, dest_path)
864
 
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
865
 
            try:
866
 
                os.rename(self.abspath(f), self.abspath(dest_path))
867
 
            except OSError, e:
868
 
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
869
 
                        ["rename rolled back"])
870
 
 
871
 
        self._write_inventory(inv)
872
 
 
873
 
 
874
 
 
875
 
    def show_status(self, show_all=False):
876
 
        """Display single-line status for non-ignored working files.
877
 
 
878
 
        The list is show sorted in order by file name.
879
 
 
880
 
        >>> b = ScratchBranch(files=['foo', 'foo~'])
881
 
        >>> b.show_status()
882
 
        ?       foo
883
 
        >>> b.add('foo')
884
 
        >>> b.show_status()
885
 
        A       foo
886
 
        >>> b.commit("add foo")
887
 
        >>> b.show_status()
888
 
        >>> os.unlink(b.abspath('foo'))
889
 
        >>> b.show_status()
890
 
        D       foo
 
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
891
1176
        
892
 
        TODO: Get state for single files.
 
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.
893
1215
        """
894
 
 
895
 
        # We have to build everything into a list first so that it can
896
 
        # sorted by name, incorporating all the different sources.
897
 
 
898
 
        # FIXME: Rather than getting things in random order and then sorting,
899
 
        # just step through in order.
900
 
 
901
 
        # Interesting case: the old ID for a file has been removed,
902
 
        # but a new file has been created under that name.
903
 
 
904
 
        old = self.basis_tree()
905
 
        new = self.working_tree()
906
 
 
907
 
        for fs, fid, oldname, newname, kind in diff_trees(old, new):
908
 
            if fs == 'R':
909
 
                show_status(fs, kind,
910
 
                            oldname + ' => ' + newname)
911
 
            elif fs == 'A' or fs == 'M':
912
 
                show_status(fs, kind, newname)
913
 
            elif fs == 'D':
914
 
                show_status(fs, kind, oldname)
915
 
            elif fs == '.':
916
 
                if show_all:
917
 
                    show_status(fs, kind, newname)
918
 
            elif fs == 'I':
919
 
                if show_all:
920
 
                    show_status(fs, kind, newname)
921
 
            elif fs == '?':
922
 
                show_status(fs, kind, newname)
923
 
            else:
924
 
                bailout("weird file state %r" % ((fs, fid),))
925
 
                
 
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
 
926
1251
 
927
1252
 
928
1253
class ScratchBranch(Branch):
932
1257
    >>> isdir(b.base)
933
1258
    True
934
1259
    >>> bd = b.base
935
 
    >>> del b
 
1260
    >>> b.destroy()
936
1261
    >>> isdir(bd)
937
1262
    False
938
1263
    """
939
 
    def __init__(self, files=[], dirs=[]):
 
1264
    def __init__(self, files=[], dirs=[], base=None):
940
1265
        """Make a test branch.
941
1266
 
942
1267
        This creates a temporary directory and runs init-tree in it.
943
1268
 
944
1269
        If any files are listed, they are created in the working copy.
945
1270
        """
946
 
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
 
1271
        from tempfile import mkdtemp
 
1272
        init = False
 
1273
        if base is None:
 
1274
            base = mkdtemp()
 
1275
            init = True
 
1276
        Branch.__init__(self, base, init=init)
947
1277
        for d in dirs:
948
1278
            os.mkdir(self.abspath(d))
949
1279
            
951
1281
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
952
1282
 
953
1283
 
 
1284
    def clone(self):
 
1285
        """
 
1286
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1287
        >>> clone = orig.clone()
 
1288
        >>> os.path.samefile(orig.base, clone.base)
 
1289
        False
 
1290
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1291
        True
 
1292
        """
 
1293
        from shutil import copytree
 
1294
        from tempfile import mkdtemp
 
1295
        base = mkdtemp()
 
1296
        os.rmdir(base)
 
1297
        copytree(self.base, base, symlinks=True)
 
1298
        return ScratchBranch(base=base)
 
1299
        
954
1300
    def __del__(self):
 
1301
        self.destroy()
 
1302
 
 
1303
    def destroy(self):
955
1304
        """Destroy the test branch, removing the scratch directory."""
 
1305
        from shutil import rmtree
956
1306
        try:
957
 
            shutil.rmtree(self.base)
958
 
        except OSError:
 
1307
            if self.base:
 
1308
                mutter("delete ScratchBranch %s" % self.base)
 
1309
                rmtree(self.base)
 
1310
        except OSError, e:
959
1311
            # Work around for shutil.rmtree failing on Windows when
960
1312
            # readonly files are encountered
 
1313
            mutter("hit exception in destroying ScratchBranch: %s" % e)
961
1314
            for root, dirs, files in os.walk(self.base, topdown=False):
962
1315
                for name in files:
963
1316
                    os.chmod(os.path.join(root, name), 0700)
964
 
            shutil.rmtree(self.base)
 
1317
            rmtree(self.base)
 
1318
        self.base = None
965
1319
 
966
1320
    
967
1321
 
984
1338
 
985
1339
 
986
1340
 
987
 
def _gen_revision_id(when):
988
 
    """Return new revision-id."""
989
 
    s = '%s-%s-' % (user_email(), compact_date(when))
990
 
    s += hexlify(rand_bytes(8))
991
 
    return s
992
 
 
993
 
 
994
1341
def gen_file_id(name):
995
1342
    """Return new file id.
996
1343
 
997
1344
    This should probably generate proper UUIDs, but for the moment we
998
1345
    cope with just randomness because running uuidgen every time is
999
1346
    slow."""
 
1347
    import re
 
1348
    from binascii import hexlify
 
1349
    from time import time
 
1350
 
 
1351
    # get last component
1000
1352
    idx = name.rfind('/')
1001
1353
    if idx != -1:
1002
1354
        name = name[idx+1 : ]
1004
1356
    if idx != -1:
1005
1357
        name = name[idx+1 : ]
1006
1358
 
 
1359
    # make it not a hidden file
1007
1360
    name = name.lstrip('.')
1008
1361
 
 
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
 
1009
1366
    s = hexlify(rand_bytes(8))
1010
 
    return '-'.join((name, compact_date(time.time()), s))
 
1367
    return '-'.join((name, compact_date(time()), s))
 
1368
 
 
1369
 
 
1370
def gen_root_id():
 
1371
    """Return a new tree-root file id."""
 
1372
    return gen_file_id('TREE_ROOT')
 
1373