← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

- merge improved merge base selection from aaron
aaron.bentley@utoronto.ca-20050912025534-43d7275dd948e4ad

Show diffs side-by-side

added added

removed removed

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