~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Aaron Bentley
  • Date: 2005-09-29 04:59:47 UTC
  • mto: (1393.1.21) (1185.14.1)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: aaron.bentley@utoronto.ca-20050929045947-ff08a7f6578f9657
Conflict handling where OTHER is deleted

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
 
from sets import Set
19
 
 
20
 
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
 
import traceback, socket, fnmatch, difflib, time
22
 
from binascii import hexlify
 
18
import sys
 
19
import os
23
20
 
24
21
import bzrlib
25
 
from inventory import Inventory
26
 
from trace import mutter, note
27
 
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
28
 
from inventory import InventoryEntry, Inventory
29
 
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
30
 
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
 
     joinpath, sha_string, file_kind, local_time_offset, appendpath
32
 
from store import ImmutableStore
33
 
from revision import Revision
34
 
from errors import bailout, BzrError
35
 
from textui import show_status
36
 
from diff import diff_trees
 
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.store import copy_all
 
28
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId, \
 
29
     DivergedBranches, NotBranchError, UnlistableStore, UnlistableBranch
 
30
from bzrlib.textui import show_status
 
31
from bzrlib.revision import Revision, is_ancestor
 
32
from bzrlib.delta import compare_trees
 
33
from bzrlib.tree import EmptyTree, RevisionTree
 
34
import bzrlib.xml
 
35
import bzrlib.ui
 
36
 
 
37
 
37
38
 
38
39
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
40
## TODO: Maybe include checks for common corruption of newlines, etc?
40
41
 
41
42
 
 
43
# TODO: Some operations like log might retrieve the same revisions
 
44
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
45
# cache in memory to make this faster.
 
46
 
 
47
def find_branch(*ignored, **ignored_too):
 
48
    # XXX: leave this here for about one release, then remove it
 
49
    raise NotImplementedError('find_branch() is not supported anymore, '
 
50
                              'please use one of the new branch constructors')
 
51
 
 
52
def _relpath(base, path):
 
53
    """Return path relative to base, or raise exception.
 
54
 
 
55
    The path may be either an absolute path or a path relative to the
 
56
    current working directory.
 
57
 
 
58
    Lifted out of Branch.relpath for ease of testing.
 
59
 
 
60
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
61
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
62
    avoids that problem."""
 
63
    rp = os.path.abspath(path)
 
64
 
 
65
    s = []
 
66
    head = rp
 
67
    while len(head) >= len(base):
 
68
        if head == base:
 
69
            break
 
70
        head, tail = os.path.split(head)
 
71
        if tail:
 
72
            s.insert(0, tail)
 
73
    else:
 
74
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
 
75
 
 
76
    return os.sep.join(s)
 
77
        
42
78
 
43
79
def find_branch_root(f=None):
44
80
    """Find the branch root enclosing f, or pwd.
45
81
 
 
82
    f may be a filename or a URL.
 
83
 
46
84
    It is not necessary that f exists.
47
85
 
48
86
    Basically we keep looking up until we find the control directory or
49
 
    run into the root."""
 
87
    run into the root.  If there isn't one, raises NotBranchError.
 
88
    """
50
89
    if f == None:
51
90
        f = os.getcwd()
52
91
    elif hasattr(os.path, 'realpath'):
53
92
        f = os.path.realpath(f)
54
93
    else:
55
94
        f = os.path.abspath(f)
 
95
    if not os.path.exists(f):
 
96
        raise BzrError('%r does not exist' % f)
 
97
        
56
98
 
57
99
    orig_f = f
58
100
 
62
104
        head, tail = os.path.split(f)
63
105
        if head == f:
64
106
            # reached the root, whatever that may be
65
 
            raise BzrError('%r is not in a branch' % orig_f)
 
107
            raise NotBranchError('%s is not in a branch' % orig_f)
66
108
        f = head
67
 
    
 
109
 
 
110
 
68
111
 
69
112
 
70
113
######################################################################
71
114
# branch objects
72
115
 
73
 
class Branch:
 
116
class Branch(object):
74
117
    """Branch holding a history of revisions.
75
118
 
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.
88
 
    """
 
119
    base
 
120
        Base directory/url of the branch.
 
121
    """
 
122
    base = None
 
123
 
 
124
    def __init__(self, *ignored, **ignored_too):
 
125
        raise NotImplementedError('The Branch class is abstract')
 
126
 
 
127
    @staticmethod
 
128
    def open(base):
 
129
        """Open an existing branch, rooted at 'base' (url)"""
 
130
        if base and (base.startswith('http://') or base.startswith('https://')):
 
131
            from bzrlib.remotebranch import RemoteBranch
 
132
            return RemoteBranch(base, find_root=False)
 
133
        else:
 
134
            return LocalBranch(base, find_root=False)
 
135
 
 
136
    @staticmethod
 
137
    def open_containing(url):
 
138
        """Open an existing branch, containing url (search upwards for the root)
 
139
        """
 
140
        if url and (url.startswith('http://') or url.startswith('https://')):
 
141
            from bzrlib.remotebranch import RemoteBranch
 
142
            return RemoteBranch(url)
 
143
        else:
 
144
            return LocalBranch(url)
 
145
 
 
146
    @staticmethod
 
147
    def initialize(base):
 
148
        """Create a new branch, rooted at 'base' (url)"""
 
149
        if base and (base.startswith('http://') or base.startswith('https://')):
 
150
            from bzrlib.remotebranch import RemoteBranch
 
151
            return RemoteBranch(base, init=True)
 
152
        else:
 
153
            return LocalBranch(base, init=True)
 
154
 
 
155
    def setup_caching(self, cache_root):
 
156
        """Subclasses that care about caching should override this, and set
 
157
        up cached stores located under cache_root.
 
158
        """
 
159
 
 
160
 
 
161
class LocalBranch(Branch):
 
162
    """A branch stored in the actual filesystem.
 
163
 
 
164
    Note that it's "local" in the context of the filesystem; it doesn't
 
165
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
166
    it's writable, and can be accessed via the normal filesystem API.
 
167
 
 
168
    _lock_mode
 
169
        None, or 'r' or 'w'
 
170
 
 
171
    _lock_count
 
172
        If _lock_mode is true, a positive count of the number of times the
 
173
        lock has been taken.
 
174
 
 
175
    _lock
 
176
        Lock object from bzrlib.lock.
 
177
    """
 
178
    # We actually expect this class to be somewhat short-lived; part of its
 
179
    # purpose is to try to isolate what bits of the branch logic are tied to
 
180
    # filesystem access, so that in a later step, we can extricate them to
 
181
    # a separarte ("storage") class.
 
182
    _lock_mode = None
 
183
    _lock_count = None
 
184
    _lock = None
 
185
 
89
186
    def __init__(self, base, init=False, find_root=True):
90
187
        """Create new branch object at a particular location.
91
188
 
92
 
        base -- Base directory for the branch.
 
189
        base -- Base directory for the branch. May be a file:// url.
93
190
        
94
191
        init -- If True, create new control files in a previously
95
192
             unversioned directory.  If False, the branch must already
101
198
        In the test suite, creation of new trees is tested using the
102
199
        `ScratchBranch` class.
103
200
        """
 
201
        from bzrlib.store import ImmutableStore
104
202
        if init:
105
203
            self.base = os.path.realpath(base)
106
204
            self._make_control()
107
205
        elif find_root:
108
206
            self.base = find_branch_root(base)
109
207
        else:
 
208
            if base.startswith("file://"):
 
209
                base = base[7:]
110
210
            self.base = os.path.realpath(base)
111
211
            if not isdir(self.controlfilename('.')):
112
 
                bailout("not a bzr branch: %s" % quotefn(base),
113
 
                        ['use "bzr init" to initialize a new working tree',
114
 
                         'current bzr can only operate from top-of-tree'])
 
212
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
 
213
                                     ['use "bzr init" to initialize a new working tree',
 
214
                                      'current bzr can only operate from top-of-tree'])
115
215
        self._check_format()
116
216
 
117
217
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
126
226
    __repr__ = __str__
127
227
 
128
228
 
 
229
    def __del__(self):
 
230
        if self._lock_mode or self._lock:
 
231
            from bzrlib.warnings import warn
 
232
            warn("branch %r was not explicitly unlocked" % self)
 
233
            self._lock.unlock()
 
234
 
 
235
    def lock_write(self):
 
236
        if self._lock_mode:
 
237
            if self._lock_mode != 'w':
 
238
                from bzrlib.errors import LockError
 
239
                raise LockError("can't upgrade to a write lock from %r" %
 
240
                                self._lock_mode)
 
241
            self._lock_count += 1
 
242
        else:
 
243
            from bzrlib.lock import WriteLock
 
244
 
 
245
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
246
            self._lock_mode = 'w'
 
247
            self._lock_count = 1
 
248
 
 
249
 
 
250
    def lock_read(self):
 
251
        if self._lock_mode:
 
252
            assert self._lock_mode in ('r', 'w'), \
 
253
                   "invalid lock mode %r" % self._lock_mode
 
254
            self._lock_count += 1
 
255
        else:
 
256
            from bzrlib.lock import ReadLock
 
257
 
 
258
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
259
            self._lock_mode = 'r'
 
260
            self._lock_count = 1
 
261
                        
 
262
    def unlock(self):
 
263
        if not self._lock_mode:
 
264
            from bzrlib.errors import LockError
 
265
            raise LockError('branch %r is not locked' % (self))
 
266
 
 
267
        if self._lock_count > 1:
 
268
            self._lock_count -= 1
 
269
        else:
 
270
            self._lock.unlock()
 
271
            self._lock = None
 
272
            self._lock_mode = self._lock_count = None
 
273
 
129
274
    def abspath(self, name):
130
275
        """Return absolute filename for something in the branch"""
131
276
        return os.path.join(self.base, name)
132
277
 
133
 
 
134
278
    def relpath(self, path):
135
279
        """Return path relative to this branch of something inside it.
136
280
 
137
281
        Raises an error if path is not in this branch."""
138
 
        rp = os.path.realpath(path)
139
 
        # FIXME: windows
140
 
        if not rp.startswith(self.base):
141
 
            bailout("path %r is not within branch %r" % (rp, self.base))
142
 
        rp = rp[len(self.base):]
143
 
        rp = rp.lstrip(os.sep)
144
 
        return rp
145
 
 
 
282
        return _relpath(self.base, path)
146
283
 
147
284
    def controlfilename(self, file_or_path):
148
285
        """Return location relative to branch."""
149
 
        if isinstance(file_or_path, types.StringTypes):
 
286
        if isinstance(file_or_path, basestring):
150
287
            file_or_path = [file_or_path]
151
288
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
152
289
 
158
295
        and binary.  binary files are untranslated byte streams.  Text
159
296
        control files are stored with Unix newlines and in UTF-8, even
160
297
        if the platform or locale defaults are different.
 
298
 
 
299
        Controlfiles should almost never be opened in write mode but
 
300
        rather should be atomically copied and replaced using atomicfile.
161
301
        """
162
302
 
163
303
        fn = self.controlfilename(file_or_path)
173
313
        else:
174
314
            raise BzrError("invalid controlfile mode %r" % mode)
175
315
 
176
 
 
177
 
 
178
316
    def _make_control(self):
 
317
        from bzrlib.inventory import Inventory
 
318
        
179
319
        os.mkdir(self.controlfilename([]))
180
320
        self.controlfile('README', 'w').write(
181
321
            "This is a Bazaar-NG control directory.\n"
182
 
            "Do not change any files in this directory.")
 
322
            "Do not change any files in this directory.\n")
183
323
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
184
324
        for d in ('text-store', 'inventory-store', 'revision-store'):
185
325
            os.mkdir(self.controlfilename(d))
186
326
        for f in ('revision-history', 'merged-patches',
187
 
                  'pending-merged-patches', 'branch-name'):
 
327
                  'pending-merged-patches', 'branch-name',
 
328
                  'branch-lock',
 
329
                  'pending-merges'):
188
330
            self.controlfile(f, 'w').write('')
189
331
        mutter('created control directory in ' + self.base)
190
 
        Inventory().write_xml(self.controlfile('inventory','w'))
 
332
 
 
333
        # if we want per-tree root ids then this is the place to set
 
334
        # them; they're not needed for now and so ommitted for
 
335
        # simplicity.
 
336
        f = self.controlfile('inventory','w')
 
337
        bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
191
338
 
192
339
 
193
340
    def _check_format(self):
202
349
        # on Windows from Linux and so on.  I think it might be better
203
350
        # to always make all internal files in unix format.
204
351
        fmt = self.controlfile('branch-format', 'r').read()
205
 
        fmt.replace('\r\n', '')
 
352
        fmt = fmt.replace('\r\n', '\n')
206
353
        if fmt != BZR_BRANCH_FORMAT:
207
 
            bailout('sorry, branch format %r not supported' % fmt,
208
 
                    ['use a different bzr version',
209
 
                     'or remove the .bzr directory and "bzr init" again'])
210
 
 
 
354
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
355
                           ['use a different bzr version',
 
356
                            'or remove the .bzr directory and "bzr init" again'])
 
357
 
 
358
    def get_root_id(self):
 
359
        """Return the id of this branches root"""
 
360
        inv = self.read_working_inventory()
 
361
        return inv.root.file_id
 
362
 
 
363
    def set_root_id(self, file_id):
 
364
        inv = self.read_working_inventory()
 
365
        orig_root_id = inv.root.file_id
 
366
        del inv._byid[inv.root.file_id]
 
367
        inv.root.file_id = file_id
 
368
        inv._byid[inv.root.file_id] = inv.root
 
369
        for fid in inv:
 
370
            entry = inv[fid]
 
371
            if entry.parent_id in (None, orig_root_id):
 
372
                entry.parent_id = inv.root.file_id
 
373
        self._write_inventory(inv)
211
374
 
212
375
    def read_working_inventory(self):
213
376
        """Read the working inventory."""
214
 
        before = time.time()
215
 
        # ElementTree does its own conversion from UTF-8, so open in
216
 
        # binary.
217
 
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
218
 
        mutter("loaded inventory of %d items in %f"
219
 
               % (len(inv), time.time() - before))
220
 
        return inv
221
 
 
 
377
        from bzrlib.inventory import Inventory
 
378
        self.lock_read()
 
379
        try:
 
380
            # ElementTree does its own conversion from UTF-8, so open in
 
381
            # binary.
 
382
            f = self.controlfile('inventory', 'rb')
 
383
            return bzrlib.xml.serializer_v4.read_inventory(f)
 
384
        finally:
 
385
            self.unlock()
 
386
            
222
387
 
223
388
    def _write_inventory(self, inv):
224
389
        """Update the working inventory.
226
391
        That is to say, the inventory describing changes underway, that
227
392
        will be committed to the next revision.
228
393
        """
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)
 
394
        from bzrlib.atomicfile import AtomicFile
 
395
        
 
396
        self.lock_write()
 
397
        try:
 
398
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
 
399
            try:
 
400
                bzrlib.xml.serializer_v4.write_inventory(inv, f)
 
401
                f.commit()
 
402
            finally:
 
403
                f.close()
 
404
        finally:
 
405
            self.unlock()
 
406
        
239
407
        mutter('wrote working inventory')
240
 
 
 
408
            
241
409
 
242
410
    inventory = property(read_working_inventory, _write_inventory, None,
243
411
                         """Inventory for the working copy.""")
244
412
 
245
413
 
246
 
    def add(self, files, verbose=False):
 
414
    def add(self, files, ids=None):
247
415
        """Make files versioned.
248
416
 
249
 
        Note that the command line normally calls smart_add instead.
 
417
        Note that the command line normally calls smart_add instead,
 
418
        which can automatically recurse.
250
419
 
251
420
        This puts the files in the Added state, so that they will be
252
421
        recorded by the next commit.
253
422
 
 
423
        files
 
424
            List of paths to add, relative to the base of the tree.
 
425
 
 
426
        ids
 
427
            If set, use these instead of automatically generated ids.
 
428
            Must be the same length as the list of files, but may
 
429
            contain None for ids that are to be autogenerated.
 
430
 
254
431
        TODO: Perhaps have an option to add the ids even if the files do
255
 
               not (yet) exist.
256
 
 
257
 
        TODO: Perhaps return the ids of the files?  But then again it
258
 
               is easy to retrieve them if they're needed.
259
 
 
260
 
        TODO: Option to specify file id.
261
 
 
262
 
        TODO: Adding a directory should optionally recurse down and
263
 
               add all non-ignored children.  Perhaps do that in a
264
 
               higher-level method.
265
 
 
266
 
        >>> b = ScratchBranch(files=['foo'])
267
 
        >>> 'foo' in b.unknowns()
268
 
        True
269
 
        >>> b.show_status()
270
 
        ?       foo
271
 
        >>> b.add('foo')
272
 
        >>> 'foo' in b.unknowns()
273
 
        False
274
 
        >>> bool(b.inventory.path2id('foo'))
275
 
        True
276
 
        >>> b.show_status()
277
 
        A       foo
278
 
 
279
 
        >>> b.add('foo')
280
 
        Traceback (most recent call last):
281
 
        ...
282
 
        BzrError: ('foo is already versioned', [])
283
 
 
284
 
        >>> b.add(['nothere'])
285
 
        Traceback (most recent call last):
286
 
        BzrError: ('cannot add: not a regular file or directory: nothere', [])
 
432
              not (yet) exist.
 
433
 
 
434
        TODO: Perhaps yield the ids and paths as they're added.
287
435
        """
288
 
 
289
436
        # TODO: Re-adding a file that is removed in the working copy
290
437
        # should probably put it back with the previous ID.
291
 
        if isinstance(files, types.StringTypes):
 
438
        if isinstance(files, basestring):
 
439
            assert(ids is None or isinstance(ids, basestring))
292
440
            files = [files]
293
 
        
294
 
        inv = self.read_working_inventory()
295
 
        for f in files:
296
 
            if is_control_file(f):
297
 
                bailout("cannot add control file %s" % quotefn(f))
298
 
 
299
 
            fp = splitpath(f)
300
 
 
301
 
            if len(fp) == 0:
302
 
                bailout("cannot add top-level %r" % f)
303
 
                
304
 
            fullpath = os.path.normpath(self.abspath(f))
305
 
 
306
 
            try:
307
 
                kind = file_kind(fullpath)
308
 
            except OSError:
309
 
                # maybe something better?
310
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
311
 
            
312
 
            if kind != 'file' and kind != 'directory':
313
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
314
 
 
315
 
            file_id = gen_file_id(f)
316
 
            inv.add_path(f, kind=kind, file_id=file_id)
317
 
 
318
 
            if verbose:
319
 
                show_status('A', kind, quotefn(f))
320
 
                
321
 
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
322
 
            
323
 
        self._write_inventory(inv)
324
 
 
 
441
            if ids is not None:
 
442
                ids = [ids]
 
443
 
 
444
        if ids is None:
 
445
            ids = [None] * len(files)
 
446
        else:
 
447
            assert(len(ids) == len(files))
 
448
 
 
449
        self.lock_write()
 
450
        try:
 
451
            inv = self.read_working_inventory()
 
452
            for f,file_id in zip(files, ids):
 
453
                if is_control_file(f):
 
454
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
455
 
 
456
                fp = splitpath(f)
 
457
 
 
458
                if len(fp) == 0:
 
459
                    raise BzrError("cannot add top-level %r" % f)
 
460
 
 
461
                fullpath = os.path.normpath(self.abspath(f))
 
462
 
 
463
                try:
 
464
                    kind = file_kind(fullpath)
 
465
                except OSError:
 
466
                    # maybe something better?
 
467
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
468
 
 
469
                if kind != 'file' and kind != 'directory':
 
470
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
471
 
 
472
                if file_id is None:
 
473
                    file_id = gen_file_id(f)
 
474
                inv.add_path(f, kind=kind, file_id=file_id)
 
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
            
325
482
 
326
483
    def print_file(self, file, revno):
327
484
        """Print `file` to stdout."""
328
 
        tree = self.revision_tree(self.lookup_revision(revno))
329
 
        # use inventory as it was in that revision
330
 
        file_id = tree.inventory.path2id(file)
331
 
        if not file_id:
332
 
            bailout("%r is not present in revision %d" % (file, revno))
333
 
        tree.print_file(file_id)
334
 
        
 
485
        self.lock_read()
 
486
        try:
 
487
            tree = self.revision_tree(self.get_rev_id(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
 
335
496
 
336
497
    def remove(self, files, verbose=False):
337
498
        """Mark nominated files for removal from the inventory.
340
501
 
341
502
        TODO: Refuse to remove modified files unless --force is given?
342
503
 
343
 
        >>> b = ScratchBranch(files=['foo'])
344
 
        >>> b.add('foo')
345
 
        >>> b.inventory.has_filename('foo')
346
 
        True
347
 
        >>> b.remove('foo')
348
 
        >>> b.working_tree().has_filename('foo')
349
 
        True
350
 
        >>> b.inventory.has_filename('foo')
351
 
        False
352
 
        
353
 
        >>> b = ScratchBranch(files=['foo'])
354
 
        >>> b.add('foo')
355
 
        >>> b.commit('one')
356
 
        >>> b.remove('foo')
357
 
        >>> b.commit('two')
358
 
        >>> b.inventory.has_filename('foo') 
359
 
        False
360
 
        >>> b.basis_tree().has_filename('foo') 
361
 
        False
362
 
        >>> b.working_tree().has_filename('foo') 
363
 
        True
364
 
 
365
504
        TODO: Do something useful with directories.
366
505
 
367
506
        TODO: Should this remove the text or not?  Tough call; not
371
510
        """
372
511
        ## TODO: Normalize names
373
512
        ## TODO: Remove nested loops; better scalability
374
 
 
375
 
        if isinstance(files, types.StringTypes):
 
513
        if isinstance(files, basestring):
376
514
            files = [files]
377
 
        
378
 
        tree = self.working_tree()
379
 
        inv = tree.inventory
380
 
 
381
 
        # do this before any modifications
382
 
        for f in files:
383
 
            fid = inv.path2id(f)
384
 
            if not fid:
385
 
                bailout("cannot remove unversioned file %s" % quotefn(f))
386
 
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
387
 
            if verbose:
388
 
                # having remove it, it must be either ignored or unknown
389
 
                if tree.is_ignored(f):
390
 
                    new_status = 'I'
391
 
                else:
392
 
                    new_status = '?'
393
 
                show_status(new_status, inv[fid].kind, quotefn(f))
394
 
            del inv[fid]
395
 
 
 
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))
396
551
        self._write_inventory(inv)
397
552
 
398
553
 
415
570
        return self.working_tree().unknowns()
416
571
 
417
572
 
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)
 
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
 
590
579
        rev_history = self.revision_history()
591
 
 
592
 
        tmprhname = self.controlfilename('revision-history.tmp')
593
 
        rhname = self.controlfilename('revision-history')
594
 
        
595
 
        f = file(tmprhname, 'wt')
596
 
        rev_history.append(revision_id)
597
 
        f.write('\n'.join(rev_history))
598
 
        f.write('\n')
599
 
        f.close()
600
 
 
601
 
        if sys.platform == 'win32':
602
 
            os.remove(rhname)
603
 
        os.rename(tmprhname, rhname)
604
 
        
 
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_file(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, KeyError):
 
601
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
602
        finally:
 
603
            self.unlock()
 
604
 
 
605
 
 
606
    #deprecated
 
607
    get_revision_xml = get_revision_xml_file
605
608
 
606
609
 
607
610
    def get_revision(self, revision_id):
608
611
        """Return the Revision object for a named revision"""
609
 
        r = Revision.read_xml(self.revision_store[revision_id])
 
612
        xml_file = self.get_revision_xml_file(revision_id)
 
613
 
 
614
        try:
 
615
            r = bzrlib.xml.serializer_v4.read_revision(xml_file)
 
616
        except SyntaxError, e:
 
617
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
 
618
                                         [revision_id,
 
619
                                          str(e)])
 
620
            
610
621
        assert r.revision_id == revision_id
611
622
        return r
612
623
 
613
624
 
 
625
    def get_revision_delta(self, revno):
 
626
        """Return the delta for one revision.
 
627
 
 
628
        The delta is relative to its mainline predecessor, or the
 
629
        empty tree for revision 1.
 
630
        """
 
631
        assert isinstance(revno, int)
 
632
        rh = self.revision_history()
 
633
        if not (1 <= revno <= len(rh)):
 
634
            raise InvalidRevisionNumber(revno)
 
635
 
 
636
        # revno is 1-based; list is 0-based
 
637
 
 
638
        new_tree = self.revision_tree(rh[revno-1])
 
639
        if revno == 1:
 
640
            old_tree = EmptyTree()
 
641
        else:
 
642
            old_tree = self.revision_tree(rh[revno-2])
 
643
 
 
644
        return compare_trees(old_tree, new_tree)
 
645
 
 
646
        
 
647
 
 
648
    def get_revision_sha1(self, revision_id):
 
649
        """Hash the stored value of a revision, and return it."""
 
650
        # In the future, revision entries will be signed. At that
 
651
        # point, it is probably best *not* to include the signature
 
652
        # in the revision hash. Because that lets you re-sign
 
653
        # the revision, (add signatures/remove signatures) and still
 
654
        # have all hash pointers stay consistent.
 
655
        # But for now, just hash the contents.
 
656
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
 
657
 
 
658
 
614
659
    def get_inventory(self, inventory_id):
615
660
        """Get Inventory object by hash.
616
661
 
617
662
        TODO: Perhaps for this and similar methods, take a revision
618
663
               parameter which can be either an integer revno or a
619
664
               string hash."""
620
 
        i = Inventory.read_xml(self.inventory_store[inventory_id])
621
 
        return i
 
665
        from bzrlib.inventory import Inventory
 
666
 
 
667
        f = self.get_inventory_xml_file(inventory_id)
 
668
        return bzrlib.xml.serializer_v4.read_inventory(f)
 
669
 
 
670
 
 
671
    def get_inventory_xml(self, inventory_id):
 
672
        """Get inventory XML as a file object."""
 
673
        return self.inventory_store[inventory_id]
 
674
 
 
675
    get_inventory_xml_file = get_inventory_xml
 
676
            
 
677
 
 
678
    def get_inventory_sha1(self, inventory_id):
 
679
        """Return the sha1 hash of the inventory entry
 
680
        """
 
681
        return sha_file(self.get_inventory_xml(inventory_id))
622
682
 
623
683
 
624
684
    def get_revision_inventory(self, revision_id):
625
685
        """Return inventory of a past revision."""
 
686
        # bzr 0.0.6 imposes the constraint that the inventory_id
 
687
        # must be the same as its revision, so this is trivial.
626
688
        if revision_id == None:
627
 
            return Inventory()
 
689
            from bzrlib.inventory import Inventory
 
690
            return Inventory(self.get_root_id())
628
691
        else:
629
 
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
692
            return self.get_inventory(revision_id)
630
693
 
631
694
 
632
695
    def revision_history(self):
635
698
        >>> ScratchBranch().revision_history()
636
699
        []
637
700
        """
638
 
        return [chomp(l) for l in self.controlfile('revision-history', 'r').readlines()]
 
701
        self.lock_read()
 
702
        try:
 
703
            return [l.rstrip('\r\n') for l in
 
704
                    self.controlfile('revision-history', 'r').readlines()]
 
705
        finally:
 
706
            self.unlock()
 
707
 
 
708
 
 
709
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
710
        """
 
711
        >>> from bzrlib.commit import commit
 
712
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
713
        >>> sb.common_ancestor(sb) == (None, None)
 
714
        True
 
715
        >>> commit(sb, "Committing first revision", verbose=False)
 
716
        >>> sb.common_ancestor(sb)[0]
 
717
        1
 
718
        >>> clone = sb.clone()
 
719
        >>> commit(sb, "Committing second revision", verbose=False)
 
720
        >>> sb.common_ancestor(sb)[0]
 
721
        2
 
722
        >>> sb.common_ancestor(clone)[0]
 
723
        1
 
724
        >>> commit(clone, "Committing divergent second revision", 
 
725
        ...               verbose=False)
 
726
        >>> sb.common_ancestor(clone)[0]
 
727
        1
 
728
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
729
        True
 
730
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
731
        True
 
732
        >>> clone2 = sb.clone()
 
733
        >>> sb.common_ancestor(clone2)[0]
 
734
        2
 
735
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
736
        1
 
737
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
738
        1
 
739
        """
 
740
        my_history = self.revision_history()
 
741
        other_history = other.revision_history()
 
742
        if self_revno is None:
 
743
            self_revno = len(my_history)
 
744
        if other_revno is None:
 
745
            other_revno = len(other_history)
 
746
        indices = range(min((self_revno, other_revno)))
 
747
        indices.reverse()
 
748
        for r in indices:
 
749
            if my_history[r] == other_history[r]:
 
750
                return r+1, my_history[r]
 
751
        return None, None
639
752
 
640
753
 
641
754
    def revno(self):
643
756
 
644
757
        That is equivalent to the number of revisions committed to
645
758
        this branch.
646
 
 
647
 
        >>> b = ScratchBranch()
648
 
        >>> b.revno()
649
 
        0
650
 
        >>> b.commit('no foo')
651
 
        >>> b.revno()
652
 
        1
653
759
        """
654
760
        return len(self.revision_history())
655
761
 
656
762
 
657
763
    def last_patch(self):
658
764
        """Return last patch hash, or None if no history.
659
 
 
660
 
        >>> ScratchBranch().last_patch() == None
661
 
        True
662
765
        """
663
766
        ph = self.revision_history()
664
767
        if ph:
665
768
            return ph[-1]
666
769
        else:
667
770
            return None
668
 
        
669
 
 
670
 
    def lookup_revision(self, revno):
671
 
        """Return revision hash for revision number."""
 
771
 
 
772
 
 
773
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
 
774
        """
 
775
        If self and other have not diverged, return a list of the revisions
 
776
        present in other, but missing from self.
 
777
 
 
778
        >>> from bzrlib.commit import commit
 
779
        >>> bzrlib.trace.silent = True
 
780
        >>> br1 = ScratchBranch()
 
781
        >>> br2 = ScratchBranch()
 
782
        >>> br1.missing_revisions(br2)
 
783
        []
 
784
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
785
        >>> br1.missing_revisions(br2)
 
786
        [u'REVISION-ID-1']
 
787
        >>> br2.missing_revisions(br1)
 
788
        []
 
789
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
790
        >>> br1.missing_revisions(br2)
 
791
        []
 
792
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
793
        >>> br1.missing_revisions(br2)
 
794
        [u'REVISION-ID-2A']
 
795
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
796
        >>> br1.missing_revisions(br2)
 
797
        Traceback (most recent call last):
 
798
        DivergedBranches: These branches have diverged.
 
799
        """
 
800
        self_history = self.revision_history()
 
801
        self_len = len(self_history)
 
802
        other_history = other.revision_history()
 
803
        other_len = len(other_history)
 
804
        common_index = min(self_len, other_len) -1
 
805
        if common_index >= 0 and \
 
806
            self_history[common_index] != other_history[common_index]:
 
807
            raise DivergedBranches(self, other)
 
808
 
 
809
        if stop_revision is None:
 
810
            stop_revision = other_len
 
811
        elif stop_revision > other_len:
 
812
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
 
813
        
 
814
        return other_history[self_len:stop_revision]
 
815
 
 
816
 
 
817
    def update_revisions(self, other, stop_revision=None):
 
818
        """Pull in all new revisions from other branch.
 
819
        """
 
820
        from bzrlib.fetch import greedy_fetch
 
821
        from bzrlib.revision import get_intervening_revisions
 
822
 
 
823
        pb = bzrlib.ui.ui_factory.progress_bar()
 
824
        pb.update('comparing histories')
 
825
        if stop_revision is None:
 
826
            other_revision = other.last_patch()
 
827
        else:
 
828
            other_revision = other.get_rev_id(stop_revision)
 
829
        count = greedy_fetch(self, other, other_revision, pb)[0]
 
830
        try:
 
831
            revision_ids = self.missing_revisions(other, stop_revision)
 
832
        except DivergedBranches, e:
 
833
            try:
 
834
                revision_ids = get_intervening_revisions(self.last_patch(), 
 
835
                                                         other_revision, self)
 
836
                assert self.last_patch() not in revision_ids
 
837
            except bzrlib.errors.NotAncestor:
 
838
                if is_ancestor(self.last_patch(), other_revision, self):
 
839
                    revision_ids = []
 
840
                else:
 
841
                    raise e
 
842
 
 
843
        self.append_revision(*revision_ids)
 
844
        pb.clear()
 
845
 
 
846
    def install_revisions(self, other, revision_ids, pb):
 
847
        if hasattr(other.revision_store, "prefetch"):
 
848
            other.revision_store.prefetch(revision_ids)
 
849
        if hasattr(other.inventory_store, "prefetch"):
 
850
            inventory_ids = []
 
851
            for rev_id in revision_ids:
 
852
                try:
 
853
                    revision = other.get_revision(rev_id).inventory_id
 
854
                    inventory_ids.append(revision)
 
855
                except bzrlib.errors.NoSuchRevision:
 
856
                    pass
 
857
            other.inventory_store.prefetch(inventory_ids)
 
858
 
 
859
        if pb is None:
 
860
            pb = bzrlib.ui.ui_factory.progress_bar()
 
861
                
 
862
        revisions = []
 
863
        needed_texts = set()
 
864
        i = 0
 
865
 
 
866
        failures = set()
 
867
        for i, rev_id in enumerate(revision_ids):
 
868
            pb.update('fetching revision', i+1, len(revision_ids))
 
869
            try:
 
870
                rev = other.get_revision(rev_id)
 
871
            except bzrlib.errors.NoSuchRevision:
 
872
                failures.add(rev_id)
 
873
                continue
 
874
 
 
875
            revisions.append(rev)
 
876
            inv = other.get_inventory(str(rev.inventory_id))
 
877
            for key, entry in inv.iter_entries():
 
878
                if entry.text_id is None:
 
879
                    continue
 
880
                if entry.text_id not in self.text_store:
 
881
                    needed_texts.add(entry.text_id)
 
882
 
 
883
        pb.clear()
 
884
                    
 
885
        count, cp_fail = self.text_store.copy_multi(other.text_store, 
 
886
                                                    needed_texts)
 
887
        #print "Added %d texts." % count 
 
888
        inventory_ids = [ f.inventory_id for f in revisions ]
 
889
        count, cp_fail = self.inventory_store.copy_multi(other.inventory_store, 
 
890
                                                         inventory_ids)
 
891
        #print "Added %d inventories." % count 
 
892
        revision_ids = [ f.revision_id for f in revisions]
 
893
 
 
894
        count, cp_fail = self.revision_store.copy_multi(other.revision_store, 
 
895
                                                          revision_ids,
 
896
                                                          permit_failure=True)
 
897
        assert len(cp_fail) == 0 
 
898
        return count, failures
 
899
       
 
900
 
 
901
    def commit(self, *args, **kw):
 
902
        from bzrlib.commit import commit
 
903
        commit(self, *args, **kw)
 
904
        
 
905
    def revision_id_to_revno(self, revision_id):
 
906
        """Given a revision id, return its revno"""
 
907
        history = self.revision_history()
 
908
        try:
 
909
            return history.index(revision_id) + 1
 
910
        except ValueError:
 
911
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
912
 
 
913
    def get_rev_id(self, revno, history=None):
 
914
        """Find the revision id of the specified revno."""
672
915
        if revno == 0:
673
916
            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)
 
917
        if history is None:
 
918
            history = self.revision_history()
 
919
        elif revno <= 0 or revno > len(history):
 
920
            raise bzrlib.errors.NoSuchRevision(self, revno)
 
921
        return history[revno - 1]
680
922
 
681
923
 
682
924
    def revision_tree(self, revision_id):
684
926
 
685
927
        `revision_id` may be None for the null revision, in which case
686
928
        an `EmptyTree` is returned."""
687
 
 
 
929
        # TODO: refactor this to use an existing revision object
 
930
        # so we don't need to read it in twice.
688
931
        if revision_id == None:
689
932
            return EmptyTree()
690
933
        else:
694
937
 
695
938
    def working_tree(self):
696
939
        """Return a `Tree` for the working copy."""
 
940
        from bzrlib.workingtree import WorkingTree
697
941
        return WorkingTree(self.base, self.read_working_inventory())
698
942
 
699
943
 
701
945
        """Return `Tree` object for last revision.
702
946
 
703
947
        If there are no revisions yet, return an `EmptyTree`.
704
 
 
705
 
        >>> b = ScratchBranch(files=['foo'])
706
 
        >>> b.basis_tree().has_filename('foo')
707
 
        False
708
 
        >>> b.working_tree().has_filename('foo')
709
 
        True
710
 
        >>> b.add('foo')
711
 
        >>> b.commit('add foo')
712
 
        >>> b.basis_tree().has_filename('foo')
713
 
        True
714
948
        """
715
949
        r = self.last_patch()
716
950
        if r == None:
720
954
 
721
955
 
722
956
 
723
 
    def write_log(self, show_timezone='original', verbose=False):
724
 
        """Write out human-readable log of commits to this branch
725
 
 
726
 
        utc -- If true, show dates in universal time, not local time."""
727
 
        ## TODO: Option to choose either original, utc or local timezone
728
 
        revno = 1
729
 
        precursor = None
730
 
        for p in self.revision_history():
731
 
            print '-' * 40
732
 
            print 'revno:', revno
733
 
            ## TODO: Show hash if --id is given.
734
 
            ##print 'revision-hash:', p
735
 
            rev = self.get_revision(p)
736
 
            print 'committer:', rev.committer
737
 
            print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
738
 
                                                 show_timezone))
739
 
 
740
 
            ## opportunistic consistency check, same as check_patch_chaining
741
 
            if rev.precursor != precursor:
742
 
                bailout("mismatched precursor!")
743
 
 
744
 
            print 'message:'
745
 
            if not rev.message:
746
 
                print '  (no message)'
747
 
            else:
748
 
                for l in rev.message.split('\n'):
749
 
                    print '  ' + l
750
 
 
751
 
            if verbose == True and precursor != None:
752
 
                print 'changed files:'
753
 
                tree = self.revision_tree(p)
754
 
                prevtree = self.revision_tree(precursor)
755
 
                
756
 
                for file_state, fid, old_name, new_name, kind in \
757
 
                                        diff_trees(prevtree, tree, ):
758
 
                    if file_state == 'A' or file_state == 'M':
759
 
                        show_status(file_state, kind, new_name)
760
 
                    elif file_state == 'D':
761
 
                        show_status(file_state, kind, old_name)
762
 
                    elif file_state == 'R':
763
 
                        show_status(file_state, kind,
764
 
                            old_name + ' => ' + new_name)
765
 
                
766
 
            revno += 1
767
 
            precursor = p
768
 
 
769
 
 
770
957
    def rename_one(self, from_rel, to_rel):
771
958
        """Rename one file.
772
959
 
773
960
        This can change the directory or the filename or both.
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)
 
961
        """
 
962
        self.lock_write()
807
963
        try:
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
 
            
 
964
            tree = self.working_tree()
 
965
            inv = tree.inventory
 
966
            if not tree.has_filename(from_rel):
 
967
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
968
            if tree.has_filename(to_rel):
 
969
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
970
 
 
971
            file_id = inv.path2id(from_rel)
 
972
            if file_id == None:
 
973
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
974
 
 
975
            if inv.path2id(to_rel):
 
976
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
977
 
 
978
            to_dir, to_tail = os.path.split(to_rel)
 
979
            to_dir_id = inv.path2id(to_dir)
 
980
            if to_dir_id == None and to_dir != '':
 
981
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
982
 
 
983
            mutter("rename_one:")
 
984
            mutter("  file_id    {%s}" % file_id)
 
985
            mutter("  from_rel   %r" % from_rel)
 
986
            mutter("  to_rel     %r" % to_rel)
 
987
            mutter("  to_dir     %r" % to_dir)
 
988
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
989
 
 
990
            inv.rename(file_id, to_dir_id, to_tail)
 
991
 
 
992
            from_abs = self.abspath(from_rel)
 
993
            to_abs = self.abspath(to_rel)
 
994
            try:
 
995
                os.rename(from_abs, to_abs)
 
996
            except OSError, e:
 
997
                raise BzrError("failed to rename %r to %r: %s"
 
998
                        % (from_abs, to_abs, e[1]),
 
999
                        ["rename rolled back"])
 
1000
 
 
1001
            self._write_inventory(inv)
 
1002
        finally:
 
1003
            self.unlock()
816
1004
 
817
1005
 
818
1006
    def move(self, from_paths, to_name):
825
1013
 
826
1014
        Note that to_name is only the last component of the new name;
827
1015
        this doesn't change the directory.
828
 
        """
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
895
 
        
896
 
        TODO: Get state for single files.
897
 
        """
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
 
                
930
 
 
931
 
 
932
 
class ScratchBranch(Branch):
 
1016
 
 
1017
        This returns a list of (from_path, to_path) pairs for each
 
1018
        entry that is moved.
 
1019
        """
 
1020
        result = []
 
1021
        self.lock_write()
 
1022
        try:
 
1023
            ## TODO: Option to move IDs only
 
1024
            assert not isinstance(from_paths, basestring)
 
1025
            tree = self.working_tree()
 
1026
            inv = tree.inventory
 
1027
            to_abs = self.abspath(to_name)
 
1028
            if not isdir(to_abs):
 
1029
                raise BzrError("destination %r is not a directory" % to_abs)
 
1030
            if not tree.has_filename(to_name):
 
1031
                raise BzrError("destination %r not in working directory" % to_abs)
 
1032
            to_dir_id = inv.path2id(to_name)
 
1033
            if to_dir_id == None and to_name != '':
 
1034
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
1035
            to_dir_ie = inv[to_dir_id]
 
1036
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1037
                raise BzrError("destination %r is not a directory" % to_abs)
 
1038
 
 
1039
            to_idpath = inv.get_idpath(to_dir_id)
 
1040
 
 
1041
            for f in from_paths:
 
1042
                if not tree.has_filename(f):
 
1043
                    raise BzrError("%r does not exist in working tree" % f)
 
1044
                f_id = inv.path2id(f)
 
1045
                if f_id == None:
 
1046
                    raise BzrError("%r is not versioned" % f)
 
1047
                name_tail = splitpath(f)[-1]
 
1048
                dest_path = appendpath(to_name, name_tail)
 
1049
                if tree.has_filename(dest_path):
 
1050
                    raise BzrError("destination %r already exists" % dest_path)
 
1051
                if f_id in to_idpath:
 
1052
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1053
 
 
1054
            # OK, so there's a race here, it's possible that someone will
 
1055
            # create a file in this interval and then the rename might be
 
1056
            # left half-done.  But we should have caught most problems.
 
1057
 
 
1058
            for f in from_paths:
 
1059
                name_tail = splitpath(f)[-1]
 
1060
                dest_path = appendpath(to_name, name_tail)
 
1061
                result.append((f, dest_path))
 
1062
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1063
                try:
 
1064
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
1065
                except OSError, e:
 
1066
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1067
                            ["rename rolled back"])
 
1068
 
 
1069
            self._write_inventory(inv)
 
1070
        finally:
 
1071
            self.unlock()
 
1072
 
 
1073
        return result
 
1074
 
 
1075
 
 
1076
    def revert(self, filenames, old_tree=None, backups=True):
 
1077
        """Restore selected files to the versions from a previous tree.
 
1078
 
 
1079
        backups
 
1080
            If true (default) backups are made of files before
 
1081
            they're renamed.
 
1082
        """
 
1083
        from bzrlib.errors import NotVersionedError, BzrError
 
1084
        from bzrlib.atomicfile import AtomicFile
 
1085
        from bzrlib.osutils import backup_file
 
1086
        
 
1087
        inv = self.read_working_inventory()
 
1088
        if old_tree is None:
 
1089
            old_tree = self.basis_tree()
 
1090
        old_inv = old_tree.inventory
 
1091
 
 
1092
        nids = []
 
1093
        for fn in filenames:
 
1094
            file_id = inv.path2id(fn)
 
1095
            if not file_id:
 
1096
                raise NotVersionedError("not a versioned file", fn)
 
1097
            if not old_inv.has_id(file_id):
 
1098
                raise BzrError("file not present in old tree", fn, file_id)
 
1099
            nids.append((fn, file_id))
 
1100
            
 
1101
        # TODO: Rename back if it was previously at a different location
 
1102
 
 
1103
        # TODO: If given a directory, restore the entire contents from
 
1104
        # the previous version.
 
1105
 
 
1106
        # TODO: Make a backup to a temporary file.
 
1107
 
 
1108
        # TODO: If the file previously didn't exist, delete it?
 
1109
        for fn, file_id in nids:
 
1110
            backup_file(fn)
 
1111
            
 
1112
            f = AtomicFile(fn, 'wb')
 
1113
            try:
 
1114
                f.write(old_tree.get_file(file_id).read())
 
1115
                f.commit()
 
1116
            finally:
 
1117
                f.close()
 
1118
 
 
1119
 
 
1120
    def pending_merges(self):
 
1121
        """Return a list of pending merges.
 
1122
 
 
1123
        These are revisions that have been merged into the working
 
1124
        directory but not yet committed.
 
1125
        """
 
1126
        cfn = self.controlfilename('pending-merges')
 
1127
        if not os.path.exists(cfn):
 
1128
            return []
 
1129
        p = []
 
1130
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1131
            p.append(l.rstrip('\n'))
 
1132
        return p
 
1133
 
 
1134
 
 
1135
    def add_pending_merge(self, revision_id):
 
1136
        from bzrlib.revision import validate_revision_id
 
1137
 
 
1138
        validate_revision_id(revision_id)
 
1139
 
 
1140
        p = self.pending_merges()
 
1141
        if revision_id in p:
 
1142
            return
 
1143
        p.append(revision_id)
 
1144
        self.set_pending_merges(p)
 
1145
 
 
1146
 
 
1147
    def set_pending_merges(self, rev_list):
 
1148
        from bzrlib.atomicfile import AtomicFile
 
1149
        self.lock_write()
 
1150
        try:
 
1151
            f = AtomicFile(self.controlfilename('pending-merges'))
 
1152
            try:
 
1153
                for l in rev_list:
 
1154
                    print >>f, l
 
1155
                f.commit()
 
1156
            finally:
 
1157
                f.close()
 
1158
        finally:
 
1159
            self.unlock()
 
1160
 
 
1161
 
 
1162
    def get_parent(self):
 
1163
        """Return the parent location of the branch.
 
1164
 
 
1165
        This is the default location for push/pull/missing.  The usual
 
1166
        pattern is that the user can override it by specifying a
 
1167
        location.
 
1168
        """
 
1169
        import errno
 
1170
        _locs = ['parent', 'pull', 'x-pull']
 
1171
        for l in _locs:
 
1172
            try:
 
1173
                return self.controlfile(l, 'r').read().strip('\n')
 
1174
            except IOError, e:
 
1175
                if e.errno != errno.ENOENT:
 
1176
                    raise
 
1177
        return None
 
1178
 
 
1179
 
 
1180
    def set_parent(self, url):
 
1181
        # TODO: Maybe delete old location files?
 
1182
        from bzrlib.atomicfile import AtomicFile
 
1183
        self.lock_write()
 
1184
        try:
 
1185
            f = AtomicFile(self.controlfilename('parent'))
 
1186
            try:
 
1187
                f.write(url + '\n')
 
1188
                f.commit()
 
1189
            finally:
 
1190
                f.close()
 
1191
        finally:
 
1192
            self.unlock()
 
1193
 
 
1194
    def check_revno(self, revno):
 
1195
        """\
 
1196
        Check whether a revno corresponds to any revision.
 
1197
        Zero (the NULL revision) is considered valid.
 
1198
        """
 
1199
        if revno != 0:
 
1200
            self.check_real_revno(revno)
 
1201
            
 
1202
    def check_real_revno(self, revno):
 
1203
        """\
 
1204
        Check whether a revno corresponds to a real revision.
 
1205
        Zero (the NULL revision) is considered invalid
 
1206
        """
 
1207
        if revno < 1 or revno > self.revno():
 
1208
            raise InvalidRevisionNumber(revno)
 
1209
        
 
1210
        
 
1211
        
 
1212
 
 
1213
 
 
1214
class ScratchBranch(LocalBranch):
933
1215
    """Special test class: a branch that cleans up after itself.
934
1216
 
935
1217
    >>> b = ScratchBranch()
936
1218
    >>> isdir(b.base)
937
1219
    True
938
1220
    >>> bd = b.base
939
 
    >>> del b
 
1221
    >>> b.destroy()
940
1222
    >>> isdir(bd)
941
1223
    False
942
1224
    """
943
 
    def __init__(self, files=[], dirs=[]):
 
1225
    def __init__(self, files=[], dirs=[], base=None):
944
1226
        """Make a test branch.
945
1227
 
946
1228
        This creates a temporary directory and runs init-tree in it.
947
1229
 
948
1230
        If any files are listed, they are created in the working copy.
949
1231
        """
950
 
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
 
1232
        from tempfile import mkdtemp
 
1233
        init = False
 
1234
        if base is None:
 
1235
            base = mkdtemp()
 
1236
            init = True
 
1237
        LocalBranch.__init__(self, base, init=init)
951
1238
        for d in dirs:
952
1239
            os.mkdir(self.abspath(d))
953
1240
            
955
1242
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
956
1243
 
957
1244
 
 
1245
    def clone(self):
 
1246
        """
 
1247
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1248
        >>> clone = orig.clone()
 
1249
        >>> os.path.samefile(orig.base, clone.base)
 
1250
        False
 
1251
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1252
        True
 
1253
        """
 
1254
        from shutil import copytree
 
1255
        from tempfile import mkdtemp
 
1256
        base = mkdtemp()
 
1257
        os.rmdir(base)
 
1258
        copytree(self.base, base, symlinks=True)
 
1259
        return ScratchBranch(base=base)
 
1260
 
 
1261
 
 
1262
        
958
1263
    def __del__(self):
 
1264
        self.destroy()
 
1265
 
 
1266
    def destroy(self):
959
1267
        """Destroy the test branch, removing the scratch directory."""
 
1268
        from shutil import rmtree
960
1269
        try:
961
 
            shutil.rmtree(self.base)
962
 
        except OSError:
 
1270
            if self.base:
 
1271
                mutter("delete ScratchBranch %s" % self.base)
 
1272
                rmtree(self.base)
 
1273
        except OSError, e:
963
1274
            # Work around for shutil.rmtree failing on Windows when
964
1275
            # readonly files are encountered
 
1276
            mutter("hit exception in destroying ScratchBranch: %s" % e)
965
1277
            for root, dirs, files in os.walk(self.base, topdown=False):
966
1278
                for name in files:
967
1279
                    os.chmod(os.path.join(root, name), 0700)
968
 
            shutil.rmtree(self.base)
 
1280
            rmtree(self.base)
 
1281
        self.base = None
969
1282
 
970
1283
    
971
1284
 
988
1301
 
989
1302
 
990
1303
 
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
 
 
998
1304
def gen_file_id(name):
999
1305
    """Return new file id.
1000
1306
 
1001
1307
    This should probably generate proper UUIDs, but for the moment we
1002
1308
    cope with just randomness because running uuidgen every time is
1003
1309
    slow."""
 
1310
    import re
 
1311
    from binascii import hexlify
 
1312
    from time import time
 
1313
 
 
1314
    # get last component
1004
1315
    idx = name.rfind('/')
1005
1316
    if idx != -1:
1006
1317
        name = name[idx+1 : ]
1008
1319
    if idx != -1:
1009
1320
        name = name[idx+1 : ]
1010
1321
 
 
1322
    # make it not a hidden file
1011
1323
    name = name.lstrip('.')
1012
1324
 
 
1325
    # remove any wierd characters; we don't escape them but rather
 
1326
    # just pull them out
 
1327
    name = re.sub(r'[^\w.]', '', name)
 
1328
 
1013
1329
    s = hexlify(rand_bytes(8))
1014
 
    return '-'.join((name, compact_date(time.time()), s))
 
1330
    return '-'.join((name, compact_date(time()), s))
 
1331
 
 
1332
 
 
1333
def gen_root_id():
 
1334
    """Return a new tree-root file id."""
 
1335
    return gen_file_id('TREE_ROOT')
 
1336
 
 
1337
 
 
1338
def copy_branch(branch_from, to_location, revno=None, basis_branch=None):
 
1339
    """Copy branch_from into the existing directory to_location.
 
1340
 
 
1341
    revision
 
1342
        If not None, only revisions up to this point will be copied.
 
1343
        The head of the new branch will be that revision.
 
1344
 
 
1345
    to_location
 
1346
        The name of a local directory that exists but is empty.
 
1347
 
 
1348
    revno
 
1349
        The revision to copy up to
 
1350
 
 
1351
    basis_branch
 
1352
        A local branch to copy revisions from, related to branch_from
 
1353
    """
 
1354
    from bzrlib.merge import merge
 
1355
 
 
1356
    assert isinstance(branch_from, Branch)
 
1357
    assert isinstance(to_location, basestring)
 
1358
    
 
1359
    br_to = Branch.initialize(to_location)
 
1360
    if basis_branch is not None:
 
1361
        copy_stores(basis_branch, br_to)
 
1362
    br_to.set_root_id(branch_from.get_root_id())
 
1363
    if revno is None:
 
1364
        revno = branch_from.revno()
 
1365
    br_to.update_revisions(branch_from, stop_revision=revno)
 
1366
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
1367
          check_clean=False, ignore_zero=True)
 
1368
    br_to.set_parent(branch_from.base)
 
1369
    return br_to
 
1370
 
 
1371
def copy_stores(branch_from, branch_to):
 
1372
    """Copies all entries from branch stores to another branch's stores.
 
1373
    """
 
1374
    store_pairs = ((branch_from.text_store,      branch_to.text_store),
 
1375
                   (branch_from.inventory_store, branch_to.inventory_store),
 
1376
                   (branch_from.revision_store,  branch_to.revision_store))
 
1377
    try:
 
1378
        for from_store, to_store in store_pairs: 
 
1379
            copy_all(from_store, to_store)
 
1380
    except UnlistableStore:
 
1381
        raise UnlistableBranch(from_store)