~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-05 06:38:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050505063818-3eb3260343878325
- do upload CHANGELOG to web server, even though it's autogenerated

Show diffs side-by-side

added added

removed removed

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