~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-03 07:48:16 UTC
  • Revision ID: mbp@sourcefrog.net-20050503074816-f404dfcae6acf6fe
- refactor command functions into command classes
- much more help
- better system for generating help from command descriptions
- split diff code into bzrlib.diff

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