~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-04-21 01:30:22 UTC
  • Revision ID: mbp@sourcefrog.net-20050421013022-858a70691455e1dc
todo

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