~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-03 08:00:27 UTC
  • Revision ID: mbp@sourcefrog.net-20050503080027-908edb5b39982198
doc

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