← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

merge from aaron - fixes bare excepts, adds ancestor namespace

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
 
import shutil
19
18
import sys
20
19
import os
21
 
import errno
22
 
from warnings import warn
23
 
from cStringIO import StringIO
24
 
 
25
20
 
26
21
import bzrlib
27
22
from bzrlib.trace import mutter, note
28
 
from bzrlib.osutils import (isdir, quotefn,
29
 
                            rename, splitpath, sha_file,
30
 
                            file_kind, abspath, normpath, pathjoin)
31
 
import bzrlib.errors as errors
32
 
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
33
 
                           NoSuchRevision, HistoryMissing, NotBranchError,
34
 
                           DivergedBranches, LockError, UnlistableStore,
35
 
                           UnlistableBranch, NoSuchFile, NotVersionedError,
36
 
                           NoWorkingTree)
 
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
     DivergedBranches, NotBranchError
37
29
from bzrlib.textui import show_status
38
 
from bzrlib.config import TreeConfig
 
30
from bzrlib.revision import Revision
39
31
from bzrlib.delta import compare_trees
40
 
import bzrlib.inventory as inventory
41
 
from bzrlib.inventory import Inventory
42
 
from bzrlib.lockable_files import LockableFiles
43
 
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions)
44
 
from bzrlib.repository import Repository
45
 
from bzrlib.store import copy_all
46
 
import bzrlib.transactions as transactions
47
 
from bzrlib.transport import Transport, get_transport
48
32
from bzrlib.tree import EmptyTree, RevisionTree
 
33
import bzrlib.xml
49
34
import bzrlib.ui
50
 
import bzrlib.xml5
51
 
 
52
 
 
53
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
54
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
55
 
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
 
35
 
 
36
 
 
37
 
 
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
56
39
## TODO: Maybe include checks for common corruption of newlines, etc?
57
40
 
58
41
 
59
42
# TODO: Some operations like log might retrieve the same revisions
60
43
# repeatedly to calculate deltas.  We could perhaps have a weakref
61
 
# cache in memory to make this faster.  In general anything can be
62
 
# cached in memory between lock and unlock operations.
63
 
 
64
 
def find_branch(*ignored, **ignored_too):
65
 
    # XXX: leave this here for about one release, then remove it
66
 
    raise NotImplementedError('find_branch() is not supported anymore, '
67
 
                              'please use one of the new branch constructors')
68
 
 
69
 
 
70
 
def needs_read_lock(unbound):
71
 
    """Decorate unbound to take out and release a read lock."""
72
 
    def decorated(self, *args, **kwargs):
73
 
        self.lock_read()
74
 
        try:
75
 
            return unbound(self, *args, **kwargs)
76
 
        finally:
77
 
            self.unlock()
78
 
    return decorated
79
 
 
80
 
 
81
 
def needs_write_lock(unbound):
82
 
    """Decorate unbound to take out and release a write lock."""
83
 
    def decorated(self, *args, **kwargs):
84
 
        self.lock_write()
85
 
        try:
86
 
            return unbound(self, *args, **kwargs)
87
 
        finally:
88
 
            self.unlock()
89
 
    return decorated
 
44
# cache in memory to make this faster.
 
45
 
 
46
# TODO: please move the revision-string syntax stuff out of the branch
 
47
# object; it's clutter
 
48
 
 
49
 
 
50
def find_branch(f, **args):
 
51
    if f and (f.startswith('http://') or f.startswith('https://')):
 
52
        from bzrlib.remotebranch import RemoteBranch
 
53
        return RemoteBranch(f, **args)
 
54
    else:
 
55
        return Branch(f, **args)
 
56
 
 
57
 
 
58
def find_cached_branch(f, cache_root, **args):
 
59
    from bzrlib.remotebranch import RemoteBranch
 
60
    br = find_branch(f, **args)
 
61
    def cacheify(br, store_name):
 
62
        from bzrlib.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
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
 
98
 
 
99
    return os.sep.join(s)
 
100
        
 
101
 
 
102
def find_branch_root(f=None):
 
103
    """Find the branch root enclosing f, or pwd.
 
104
 
 
105
    f may be a filename or a URL.
 
106
 
 
107
    It is not necessary that f exists.
 
108
 
 
109
    Basically we keep looking up until we find the control directory or
 
110
    run into the root.  If there isn't one, raises NotBranchError.
 
111
    """
 
112
    if f == None:
 
113
        f = os.getcwd()
 
114
    elif hasattr(os.path, 'realpath'):
 
115
        f = os.path.realpath(f)
 
116
    else:
 
117
        f = os.path.abspath(f)
 
118
    if not os.path.exists(f):
 
119
        raise BzrError('%r does not exist' % f)
 
120
        
 
121
 
 
122
    orig_f = f
 
123
 
 
124
    while True:
 
125
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
 
126
            return f
 
127
        head, tail = os.path.split(f)
 
128
        if head == f:
 
129
            # reached the root, whatever that may be
 
130
            raise NotBranchError('%s is not in a branch' % orig_f)
 
131
        f = head
 
132
 
 
133
 
 
134
 
90
135
 
91
136
######################################################################
92
137
# branch objects
95
140
    """Branch holding a history of revisions.
96
141
 
97
142
    base
98
 
        Base directory/url of the branch.
 
143
        Base directory of the branch.
 
144
 
 
145
    _lock_mode
 
146
        None, or 'r' or 'w'
 
147
 
 
148
    _lock_count
 
149
        If _lock_mode is true, a positive count of the number of times the
 
150
        lock has been taken.
 
151
 
 
152
    _lock
 
153
        Lock object from bzrlib.lock.
99
154
    """
100
155
    base = None
101
 
 
102
 
    def __init__(self, *ignored, **ignored_too):
103
 
        raise NotImplementedError('The Branch class is abstract')
104
 
 
105
 
    @staticmethod
106
 
    def open_downlevel(base):
107
 
        """Open a branch which may be of an old format.
108
 
        
109
 
        Only local branches are supported."""
110
 
        return BzrBranch(get_transport(base), relax_version_check=True)
111
 
        
112
 
    @staticmethod
113
 
    def open(base):
114
 
        """Open an existing branch, rooted at 'base' (url)"""
115
 
        t = get_transport(base)
116
 
        mutter("trying to open %r with transport %r", base, t)
117
 
        return BzrBranch(t)
118
 
 
119
 
    @staticmethod
120
 
    def open_containing(url):
121
 
        """Open an existing branch which contains url.
122
 
        
123
 
        This probes for a branch at url, and searches upwards from there.
124
 
 
125
 
        Basically we keep looking up until we find the control directory or
126
 
        run into the root.  If there isn't one, raises NotBranchError.
127
 
        If there is one, it is returned, along with the unused portion of url.
128
 
        """
129
 
        t = get_transport(url)
130
 
        while True:
131
 
            try:
132
 
                return BzrBranch(t), t.relpath(url)
133
 
            except NotBranchError, e:
134
 
                mutter('not a branch in: %r %s', t.base, e)
135
 
            new_t = t.clone('..')
136
 
            if new_t.base == t.base:
137
 
                # reached the root, whatever that may be
138
 
                raise NotBranchError(path=url)
139
 
            t = new_t
140
 
 
141
 
    @staticmethod
142
 
    def initialize(base):
143
 
        """Create a new branch, rooted at 'base' (url)"""
144
 
        t = get_transport(unicode(base))
145
 
        return BzrBranch(t, init=True)
146
 
 
147
 
    def setup_caching(self, cache_root):
148
 
        """Subclasses that care about caching should override this, and set
149
 
        up cached stores located under cache_root.
150
 
        """
151
 
        self.cache_root = cache_root
152
 
 
153
 
    def _get_nick(self):
154
 
        cfg = self.tree_config()
155
 
        return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
156
 
 
157
 
    def _set_nick(self, nick):
158
 
        cfg = self.tree_config()
159
 
        cfg.set_option(nick, "nickname")
160
 
        assert cfg.get_option("nickname") == nick
161
 
 
162
 
    nick = property(_get_nick, _set_nick)
163
 
        
164
 
    def push_stores(self, branch_to):
165
 
        """Copy the content of this branches store to branch_to."""
166
 
        raise NotImplementedError('push_stores is abstract')
 
156
    _lock_mode = None
 
157
    _lock_count = None
 
158
    _lock = None
 
159
    
 
160
    # Map some sort of prefix into a namespace
 
161
    # stuff like "revno:10", "revid:", etc.
 
162
    # This should match a prefix with a function which accepts
 
163
    REVISION_NAMESPACES = {}
 
164
 
 
165
    def __init__(self, base, init=False, find_root=True):
 
166
        """Create new branch object at a particular location.
 
167
 
 
168
        base -- Base directory for the branch. May be a file:// url.
 
169
        
 
170
        init -- If True, create new control files in a previously
 
171
             unversioned directory.  If False, the branch must already
 
172
             be versioned.
 
173
 
 
174
        find_root -- If true and init is false, find the root of the
 
175
             existing branch containing base.
 
176
 
 
177
        In the test suite, creation of new trees is tested using the
 
178
        `ScratchBranch` class.
 
179
        """
 
180
        from bzrlib.store import ImmutableStore
 
181
        if init:
 
182
            self.base = os.path.realpath(base)
 
183
            self._make_control()
 
184
        elif find_root:
 
185
            self.base = find_branch_root(base)
 
186
        else:
 
187
            if base.startswith("file://"):
 
188
                base = base[7:]
 
189
            self.base = os.path.realpath(base)
 
190
            if not isdir(self.controlfilename('.')):
 
191
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
 
192
                                     ['use "bzr init" to initialize a new working tree',
 
193
                                      'current bzr can only operate from top-of-tree'])
 
194
        self._check_format()
 
195
 
 
196
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
 
197
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
 
198
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
 
199
 
 
200
 
 
201
    def __str__(self):
 
202
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
203
 
 
204
 
 
205
    __repr__ = __str__
 
206
 
 
207
 
 
208
    def __del__(self):
 
209
        if self._lock_mode or self._lock:
 
210
            from bzrlib.warnings import warn
 
211
            warn("branch %r was not explicitly unlocked" % self)
 
212
            self._lock.unlock()
167
213
 
168
214
    def lock_write(self):
169
 
        raise NotImplementedError('lock_write is abstract')
170
 
        
 
215
        if self._lock_mode:
 
216
            if self._lock_mode != 'w':
 
217
                from bzrlib.errors import LockError
 
218
                raise LockError("can't upgrade to a write lock from %r" %
 
219
                                self._lock_mode)
 
220
            self._lock_count += 1
 
221
        else:
 
222
            from bzrlib.lock import WriteLock
 
223
 
 
224
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
225
            self._lock_mode = 'w'
 
226
            self._lock_count = 1
 
227
 
 
228
 
171
229
    def lock_read(self):
172
 
        raise NotImplementedError('lock_read is abstract')
 
230
        if self._lock_mode:
 
231
            assert self._lock_mode in ('r', 'w'), \
 
232
                   "invalid lock mode %r" % self._lock_mode
 
233
            self._lock_count += 1
 
234
        else:
 
235
            from bzrlib.lock import ReadLock
173
236
 
 
237
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
238
            self._lock_mode = 'r'
 
239
            self._lock_count = 1
 
240
                        
174
241
    def unlock(self):
175
 
        raise NotImplementedError('unlock is abstract')
 
242
        if not self._lock_mode:
 
243
            from bzrlib.errors import LockError
 
244
            raise LockError('branch %r is not locked' % (self))
 
245
 
 
246
        if self._lock_count > 1:
 
247
            self._lock_count -= 1
 
248
        else:
 
249
            self._lock.unlock()
 
250
            self._lock = None
 
251
            self._lock_mode = self._lock_count = None
176
252
 
177
253
    def abspath(self, name):
178
 
        """Return absolute filename for something in the branch
 
254
        """Return absolute filename for something in the branch"""
 
255
        return os.path.join(self.base, name)
 
256
 
 
257
    def relpath(self, path):
 
258
        """Return path relative to this branch of something inside it.
 
259
 
 
260
        Raises an error if path is not in this branch."""
 
261
        return _relpath(self.base, path)
 
262
 
 
263
    def controlfilename(self, file_or_path):
 
264
        """Return location relative to branch."""
 
265
        if isinstance(file_or_path, basestring):
 
266
            file_or_path = [file_or_path]
 
267
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
268
 
 
269
 
 
270
    def controlfile(self, file_or_path, mode='r'):
 
271
        """Open a control file for this branch.
 
272
 
 
273
        There are two classes of file in the control directory: text
 
274
        and binary.  binary files are untranslated byte streams.  Text
 
275
        control files are stored with Unix newlines and in UTF-8, even
 
276
        if the platform or locale defaults are different.
 
277
 
 
278
        Controlfiles should almost never be opened in write mode but
 
279
        rather should be atomically copied and replaced using atomicfile.
 
280
        """
 
281
 
 
282
        fn = self.controlfilename(file_or_path)
 
283
 
 
284
        if mode == 'rb' or mode == 'wb':
 
285
            return file(fn, mode)
 
286
        elif mode == 'r' or mode == 'w':
 
287
            # open in binary mode anyhow so there's no newline translation;
 
288
            # codecs uses line buffering by default; don't want that.
 
289
            import codecs
 
290
            return codecs.open(fn, mode + 'b', 'utf-8',
 
291
                               buffering=60000)
 
292
        else:
 
293
            raise BzrError("invalid controlfile mode %r" % mode)
 
294
 
 
295
    def _make_control(self):
 
296
        from bzrlib.inventory import Inventory
179
297
        
180
 
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
181
 
        method and not a tree method.
 
298
        os.mkdir(self.controlfilename([]))
 
299
        self.controlfile('README', 'w').write(
 
300
            "This is a Bazaar-NG control directory.\n"
 
301
            "Do not change any files in this directory.\n")
 
302
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
 
303
        for d in ('text-store', 'inventory-store', 'revision-store'):
 
304
            os.mkdir(self.controlfilename(d))
 
305
        for f in ('revision-history', 'merged-patches',
 
306
                  'pending-merged-patches', 'branch-name',
 
307
                  'branch-lock',
 
308
                  'pending-merges'):
 
309
            self.controlfile(f, 'w').write('')
 
310
        mutter('created control directory in ' + self.base)
 
311
 
 
312
        # if we want per-tree root ids then this is the place to set
 
313
        # them; they're not needed for now and so ommitted for
 
314
        # simplicity.
 
315
        f = self.controlfile('inventory','w')
 
316
        bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
 
317
 
 
318
 
 
319
    def _check_format(self):
 
320
        """Check this branch format is supported.
 
321
 
 
322
        The current tool only supports the current unstable format.
 
323
 
 
324
        In the future, we might need different in-memory Branch
 
325
        classes to support downlevel branches.  But not yet.
182
326
        """
183
 
        raise NotImplementedError('abspath is abstract')
 
327
        # This ignores newlines so that we can open branches created
 
328
        # on Windows from Linux and so on.  I think it might be better
 
329
        # to always make all internal files in unix format.
 
330
        fmt = self.controlfile('branch-format', 'r').read()
 
331
        fmt = fmt.replace('\r\n', '\n')
 
332
        if fmt != BZR_BRANCH_FORMAT:
 
333
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
334
                           ['use a different bzr version',
 
335
                            'or remove the .bzr directory and "bzr init" again'])
184
336
 
185
337
    def get_root_id(self):
186
338
        """Return the id of this branches root"""
187
 
        raise NotImplementedError('get_root_id is abstract')
188
 
 
189
 
    def print_file(self, file, revision_id):
 
339
        inv = self.read_working_inventory()
 
340
        return inv.root.file_id
 
341
 
 
342
    def set_root_id(self, file_id):
 
343
        inv = self.read_working_inventory()
 
344
        orig_root_id = inv.root.file_id
 
345
        del inv._byid[inv.root.file_id]
 
346
        inv.root.file_id = file_id
 
347
        inv._byid[inv.root.file_id] = inv.root
 
348
        for fid in inv:
 
349
            entry = inv[fid]
 
350
            if entry.parent_id in (None, orig_root_id):
 
351
                entry.parent_id = inv.root.file_id
 
352
        self._write_inventory(inv)
 
353
 
 
354
    def read_working_inventory(self):
 
355
        """Read the working inventory."""
 
356
        from bzrlib.inventory import Inventory
 
357
        self.lock_read()
 
358
        try:
 
359
            # ElementTree does its own conversion from UTF-8, so open in
 
360
            # binary.
 
361
            f = self.controlfile('inventory', 'rb')
 
362
            return bzrlib.xml.serializer_v4.read_inventory(f)
 
363
        finally:
 
364
            self.unlock()
 
365
            
 
366
 
 
367
    def _write_inventory(self, inv):
 
368
        """Update the working inventory.
 
369
 
 
370
        That is to say, the inventory describing changes underway, that
 
371
        will be committed to the next revision.
 
372
        """
 
373
        from bzrlib.atomicfile import AtomicFile
 
374
        
 
375
        self.lock_write()
 
376
        try:
 
377
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
 
378
            try:
 
379
                bzrlib.xml.serializer_v4.write_inventory(inv, f)
 
380
                f.commit()
 
381
            finally:
 
382
                f.close()
 
383
        finally:
 
384
            self.unlock()
 
385
        
 
386
        mutter('wrote working inventory')
 
387
            
 
388
 
 
389
    inventory = property(read_working_inventory, _write_inventory, None,
 
390
                         """Inventory for the working copy.""")
 
391
 
 
392
 
 
393
    def add(self, files, ids=None):
 
394
        """Make files versioned.
 
395
 
 
396
        Note that the command line normally calls smart_add instead,
 
397
        which can automatically recurse.
 
398
 
 
399
        This puts the files in the Added state, so that they will be
 
400
        recorded by the next commit.
 
401
 
 
402
        files
 
403
            List of paths to add, relative to the base of the tree.
 
404
 
 
405
        ids
 
406
            If set, use these instead of automatically generated ids.
 
407
            Must be the same length as the list of files, but may
 
408
            contain None for ids that are to be autogenerated.
 
409
 
 
410
        TODO: Perhaps have an option to add the ids even if the files do
 
411
              not (yet) exist.
 
412
 
 
413
        TODO: Perhaps yield the ids and paths as they're added.
 
414
        """
 
415
        # TODO: Re-adding a file that is removed in the working copy
 
416
        # should probably put it back with the previous ID.
 
417
        if isinstance(files, basestring):
 
418
            assert(ids is None or isinstance(ids, basestring))
 
419
            files = [files]
 
420
            if ids is not None:
 
421
                ids = [ids]
 
422
 
 
423
        if ids is None:
 
424
            ids = [None] * len(files)
 
425
        else:
 
426
            assert(len(ids) == len(files))
 
427
 
 
428
        self.lock_write()
 
429
        try:
 
430
            inv = self.read_working_inventory()
 
431
            for f,file_id in zip(files, ids):
 
432
                if is_control_file(f):
 
433
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
434
 
 
435
                fp = splitpath(f)
 
436
 
 
437
                if len(fp) == 0:
 
438
                    raise BzrError("cannot add top-level %r" % f)
 
439
 
 
440
                fullpath = os.path.normpath(self.abspath(f))
 
441
 
 
442
                try:
 
443
                    kind = file_kind(fullpath)
 
444
                except OSError:
 
445
                    # maybe something better?
 
446
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
447
 
 
448
                if kind != 'file' and kind != 'directory':
 
449
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
450
 
 
451
                if file_id is None:
 
452
                    file_id = gen_file_id(f)
 
453
                inv.add_path(f, kind=kind, file_id=file_id)
 
454
 
 
455
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
456
 
 
457
            self._write_inventory(inv)
 
458
        finally:
 
459
            self.unlock()
 
460
            
 
461
 
 
462
    def print_file(self, file, revno):
190
463
        """Print `file` to stdout."""
191
 
        raise NotImplementedError('print_file is abstract')
 
464
        self.lock_read()
 
465
        try:
 
466
            tree = self.revision_tree(self.lookup_revision(revno))
 
467
            # use inventory as it was in that revision
 
468
            file_id = tree.inventory.path2id(file)
 
469
            if not file_id:
 
470
                raise BzrError("%r is not present in revision %s" % (file, revno))
 
471
            tree.print_file(file_id)
 
472
        finally:
 
473
            self.unlock()
 
474
 
 
475
 
 
476
    def remove(self, files, verbose=False):
 
477
        """Mark nominated files for removal from the inventory.
 
478
 
 
479
        This does not remove their text.  This does not run on 
 
480
 
 
481
        TODO: Refuse to remove modified files unless --force is given?
 
482
 
 
483
        TODO: Do something useful with directories.
 
484
 
 
485
        TODO: Should this remove the text or not?  Tough call; not
 
486
        removing may be useful and the user can just use use rm, and
 
487
        is the opposite of add.  Removing it is consistent with most
 
488
        other tools.  Maybe an option.
 
489
        """
 
490
        ## TODO: Normalize names
 
491
        ## TODO: Remove nested loops; better scalability
 
492
        if isinstance(files, basestring):
 
493
            files = [files]
 
494
 
 
495
        self.lock_write()
 
496
 
 
497
        try:
 
498
            tree = self.working_tree()
 
499
            inv = tree.inventory
 
500
 
 
501
            # do this before any modifications
 
502
            for f in files:
 
503
                fid = inv.path2id(f)
 
504
                if not fid:
 
505
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
 
506
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
507
                if verbose:
 
508
                    # having remove it, it must be either ignored or unknown
 
509
                    if tree.is_ignored(f):
 
510
                        new_status = 'I'
 
511
                    else:
 
512
                        new_status = '?'
 
513
                    show_status(new_status, inv[fid].kind, quotefn(f))
 
514
                del inv[fid]
 
515
 
 
516
            self._write_inventory(inv)
 
517
        finally:
 
518
            self.unlock()
 
519
 
 
520
 
 
521
    # FIXME: this doesn't need to be a branch method
 
522
    def set_inventory(self, new_inventory_list):
 
523
        from bzrlib.inventory import Inventory, InventoryEntry
 
524
        inv = Inventory(self.get_root_id())
 
525
        for path, file_id, parent, kind in new_inventory_list:
 
526
            name = os.path.basename(path)
 
527
            if name == "":
 
528
                continue
 
529
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
530
        self._write_inventory(inv)
 
531
 
 
532
 
 
533
    def unknowns(self):
 
534
        """Return all unknown files.
 
535
 
 
536
        These are files in the working directory that are not versioned or
 
537
        control files or ignored.
 
538
        
 
539
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
540
        >>> list(b.unknowns())
 
541
        ['foo']
 
542
        >>> b.add('foo')
 
543
        >>> list(b.unknowns())
 
544
        []
 
545
        >>> b.remove('foo')
 
546
        >>> list(b.unknowns())
 
547
        ['foo']
 
548
        """
 
549
        return self.working_tree().unknowns()
 
550
 
192
551
 
193
552
    def append_revision(self, *revision_ids):
194
 
        raise NotImplementedError('append_revision is abstract')
195
 
 
196
 
    def set_revision_history(self, rev_history):
197
 
        raise NotImplementedError('set_revision_history is abstract')
 
553
        from bzrlib.atomicfile import AtomicFile
 
554
 
 
555
        for revision_id in revision_ids:
 
556
            mutter("add {%s} to revision-history" % revision_id)
 
557
 
 
558
        rev_history = self.revision_history()
 
559
        rev_history.extend(revision_ids)
 
560
 
 
561
        f = AtomicFile(self.controlfilename('revision-history'))
 
562
        try:
 
563
            for rev_id in rev_history:
 
564
                print >>f, rev_id
 
565
            f.commit()
 
566
        finally:
 
567
            f.close()
 
568
 
 
569
 
 
570
    def get_revision_xml_file(self, revision_id):
 
571
        """Return XML file object for revision object."""
 
572
        if not revision_id or not isinstance(revision_id, basestring):
 
573
            raise InvalidRevisionId(revision_id)
 
574
 
 
575
        self.lock_read()
 
576
        try:
 
577
            try:
 
578
                return self.revision_store[revision_id]
 
579
            except KeyError:
 
580
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
581
        finally:
 
582
            self.unlock()
 
583
 
 
584
 
 
585
    #deprecated
 
586
    get_revision_xml = get_revision_xml_file
 
587
 
 
588
 
 
589
    def get_revision(self, revision_id):
 
590
        """Return the Revision object for a named revision"""
 
591
        xml_file = self.get_revision_xml_file(revision_id)
 
592
 
 
593
        try:
 
594
            r = bzrlib.xml.serializer_v4.read_revision(xml_file)
 
595
        except SyntaxError, e:
 
596
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
 
597
                                         [revision_id,
 
598
                                          str(e)])
 
599
            
 
600
        assert r.revision_id == revision_id
 
601
        return r
 
602
 
 
603
 
 
604
    def get_revision_delta(self, revno):
 
605
        """Return the delta for one revision.
 
606
 
 
607
        The delta is relative to its mainline predecessor, or the
 
608
        empty tree for revision 1.
 
609
        """
 
610
        assert isinstance(revno, int)
 
611
        rh = self.revision_history()
 
612
        if not (1 <= revno <= len(rh)):
 
613
            raise InvalidRevisionNumber(revno)
 
614
 
 
615
        # revno is 1-based; list is 0-based
 
616
 
 
617
        new_tree = self.revision_tree(rh[revno-1])
 
618
        if revno == 1:
 
619
            old_tree = EmptyTree()
 
620
        else:
 
621
            old_tree = self.revision_tree(rh[revno-2])
 
622
 
 
623
        return compare_trees(old_tree, new_tree)
 
624
 
 
625
        
 
626
 
 
627
    def get_revision_sha1(self, revision_id):
 
628
        """Hash the stored value of a revision, and return it."""
 
629
        # In the future, revision entries will be signed. At that
 
630
        # point, it is probably best *not* to include the signature
 
631
        # in the revision hash. Because that lets you re-sign
 
632
        # the revision, (add signatures/remove signatures) and still
 
633
        # have all hash pointers stay consistent.
 
634
        # But for now, just hash the contents.
 
635
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
 
636
 
 
637
 
 
638
    def get_inventory(self, inventory_id):
 
639
        """Get Inventory object by hash.
 
640
 
 
641
        TODO: Perhaps for this and similar methods, take a revision
 
642
               parameter which can be either an integer revno or a
 
643
               string hash."""
 
644
        from bzrlib.inventory import Inventory
 
645
 
 
646
        f = self.get_inventory_xml_file(inventory_id)
 
647
        return bzrlib.xml.serializer_v4.read_inventory(f)
 
648
 
 
649
 
 
650
    def get_inventory_xml(self, inventory_id):
 
651
        """Get inventory XML as a file object."""
 
652
        return self.inventory_store[inventory_id]
 
653
 
 
654
    get_inventory_xml_file = get_inventory_xml
 
655
            
 
656
 
 
657
    def get_inventory_sha1(self, inventory_id):
 
658
        """Return the sha1 hash of the inventory entry
 
659
        """
 
660
        return sha_file(self.get_inventory_xml(inventory_id))
 
661
 
 
662
 
 
663
    def get_revision_inventory(self, revision_id):
 
664
        """Return inventory of a past revision."""
 
665
        # bzr 0.0.6 imposes the constraint that the inventory_id
 
666
        # must be the same as its revision, so this is trivial.
 
667
        if revision_id == None:
 
668
            from bzrlib.inventory import Inventory
 
669
            return Inventory(self.get_root_id())
 
670
        else:
 
671
            return self.get_inventory(revision_id)
 
672
 
198
673
 
199
674
    def revision_history(self):
200
 
        """Return sequence of revision hashes on to this branch."""
201
 
        raise NotImplementedError('revision_history is abstract')
 
675
        """Return sequence of revision hashes on to this branch.
 
676
 
 
677
        >>> ScratchBranch().revision_history()
 
678
        []
 
679
        """
 
680
        self.lock_read()
 
681
        try:
 
682
            return [l.rstrip('\r\n') for l in
 
683
                    self.controlfile('revision-history', 'r').readlines()]
 
684
        finally:
 
685
            self.unlock()
 
686
 
 
687
 
 
688
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
689
        """
 
690
        >>> from bzrlib.commit import commit
 
691
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
692
        >>> sb.common_ancestor(sb) == (None, None)
 
693
        True
 
694
        >>> commit(sb, "Committing first revision", verbose=False)
 
695
        >>> sb.common_ancestor(sb)[0]
 
696
        1
 
697
        >>> clone = sb.clone()
 
698
        >>> commit(sb, "Committing second revision", verbose=False)
 
699
        >>> sb.common_ancestor(sb)[0]
 
700
        2
 
701
        >>> sb.common_ancestor(clone)[0]
 
702
        1
 
703
        >>> commit(clone, "Committing divergent second revision", 
 
704
        ...               verbose=False)
 
705
        >>> sb.common_ancestor(clone)[0]
 
706
        1
 
707
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
708
        True
 
709
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
710
        True
 
711
        >>> clone2 = sb.clone()
 
712
        >>> sb.common_ancestor(clone2)[0]
 
713
        2
 
714
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
715
        1
 
716
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
717
        1
 
718
        """
 
719
        my_history = self.revision_history()
 
720
        other_history = other.revision_history()
 
721
        if self_revno is None:
 
722
            self_revno = len(my_history)
 
723
        if other_revno is None:
 
724
            other_revno = len(other_history)
 
725
        indices = range(min((self_revno, other_revno)))
 
726
        indices.reverse()
 
727
        for r in indices:
 
728
            if my_history[r] == other_history[r]:
 
729
                return r+1, my_history[r]
 
730
        return None, None
 
731
 
202
732
 
203
733
    def revno(self):
204
734
        """Return current revision number for this branch.
208
738
        """
209
739
        return len(self.revision_history())
210
740
 
211
 
    def last_revision(self):
212
 
        """Return last patch hash, or None if no history."""
 
741
 
 
742
    def last_patch(self):
 
743
        """Return last patch hash, or None if no history.
 
744
        """
213
745
        ph = self.revision_history()
214
746
        if ph:
215
747
            return ph[-1]
216
748
        else:
217
749
            return None
218
750
 
 
751
 
219
752
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
220
 
        """Return a list of new revisions that would perfectly fit.
221
 
        
 
753
        """
222
754
        If self and other have not diverged, return a list of the revisions
223
755
        present in other, but missing from self.
224
756
 
242
774
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
243
775
        >>> br1.missing_revisions(br2)
244
776
        Traceback (most recent call last):
245
 
        DivergedBranches: These branches have diverged.  Try merge.
 
777
        DivergedBranches: These branches have diverged.
246
778
        """
247
779
        self_history = self.revision_history()
248
780
        self_len = len(self_history)
255
787
 
256
788
        if stop_revision is None:
257
789
            stop_revision = other_len
258
 
        else:
259
 
            assert isinstance(stop_revision, int)
260
 
            if stop_revision > other_len:
261
 
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
 
790
        elif stop_revision > other_len:
 
791
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
 
792
        
262
793
        return other_history[self_len:stop_revision]
263
794
 
264
 
    
 
795
 
265
796
    def update_revisions(self, other, stop_revision=None):
266
 
        """Pull in new perfect-fit revisions."""
267
 
        raise NotImplementedError('update_revisions is abstract')
268
 
 
269
 
    def pullable_revisions(self, other, stop_revision):
270
 
        raise NotImplementedError('pullable_revisions is abstract')
 
797
        """Pull in all new revisions from other branch.
 
798
        """
 
799
        from bzrlib.fetch import greedy_fetch
 
800
        from bzrlib.revision import get_intervening_revisions
 
801
 
 
802
        pb = bzrlib.ui.ui_factory.progress_bar()
 
803
        pb.update('comparing histories')
 
804
        if stop_revision is None:
 
805
            other_revision = other.last_patch()
 
806
        else:
 
807
            other_revision = other.lookup_revision(stop_revision)
 
808
        count = greedy_fetch(self, other, other_revision, pb)[0]
 
809
        try:
 
810
            revision_ids = self.missing_revisions(other, stop_revision)
 
811
        except DivergedBranches, e:
 
812
            try:
 
813
                revision_ids = get_intervening_revisions(self.last_patch(), 
 
814
                                                         other_revision, self)
 
815
                assert self.last_patch() not in revision_ids
 
816
            except bzrlib.errors.NotAncestor:
 
817
                raise e
 
818
 
 
819
        self.append_revision(*revision_ids)
 
820
        pb.clear()
 
821
 
 
822
    def install_revisions(self, other, revision_ids, pb):
 
823
        if hasattr(other.revision_store, "prefetch"):
 
824
            other.revision_store.prefetch(revision_ids)
 
825
        if hasattr(other.inventory_store, "prefetch"):
 
826
            inventory_ids = []
 
827
            for rev_id in revision_ids:
 
828
                try:
 
829
                    revision = other.get_revision(rev_id).inventory_id
 
830
                    inventory_ids.append(revision)
 
831
                except bzrlib.errors.NoSuchRevision:
 
832
                    pass
 
833
            other.inventory_store.prefetch(inventory_ids)
 
834
 
 
835
        if pb is None:
 
836
            pb = bzrlib.ui.ui_factory.progress_bar()
 
837
                
 
838
        revisions = []
 
839
        needed_texts = set()
 
840
        i = 0
 
841
 
 
842
        failures = set()
 
843
        for i, rev_id in enumerate(revision_ids):
 
844
            pb.update('fetching revision', i+1, len(revision_ids))
 
845
            try:
 
846
                rev = other.get_revision(rev_id)
 
847
            except bzrlib.errors.NoSuchRevision:
 
848
                failures.add(rev_id)
 
849
                continue
 
850
 
 
851
            revisions.append(rev)
 
852
            inv = other.get_inventory(str(rev.inventory_id))
 
853
            for key, entry in inv.iter_entries():
 
854
                if entry.text_id is None:
 
855
                    continue
 
856
                if entry.text_id not in self.text_store:
 
857
                    needed_texts.add(entry.text_id)
 
858
 
 
859
        pb.clear()
 
860
                    
 
861
        count, cp_fail = self.text_store.copy_multi(other.text_store, 
 
862
                                                    needed_texts)
 
863
        #print "Added %d texts." % count 
 
864
        inventory_ids = [ f.inventory_id for f in revisions ]
 
865
        count, cp_fail = self.inventory_store.copy_multi(other.inventory_store, 
 
866
                                                         inventory_ids)
 
867
        #print "Added %d inventories." % count 
 
868
        revision_ids = [ f.revision_id for f in revisions]
 
869
 
 
870
        count, cp_fail = self.revision_store.copy_multi(other.revision_store, 
 
871
                                                          revision_ids,
 
872
                                                          permit_failure=True)
 
873
        assert len(cp_fail) == 0 
 
874
        return count, failures
 
875
       
 
876
 
 
877
    def commit(self, *args, **kw):
 
878
        from bzrlib.commit import commit
 
879
        commit(self, *args, **kw)
271
880
        
 
881
 
 
882
    def lookup_revision(self, revision):
 
883
        """Return the revision identifier for a given revision information."""
 
884
        revno, info = self._get_revision_info(revision)
 
885
        return info
 
886
 
 
887
 
272
888
    def revision_id_to_revno(self, revision_id):
273
889
        """Given a revision id, return its revno"""
274
 
        if revision_id is None:
275
 
            return 0
276
890
        history = self.revision_history()
277
891
        try:
278
892
            return history.index(revision_id) + 1
279
893
        except ValueError:
280
894
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
281
895
 
 
896
 
 
897
    def get_revision_info(self, revision):
 
898
        """Return (revno, revision id) for revision identifier.
 
899
 
 
900
        revision can be an integer, in which case it is assumed to be revno (though
 
901
            this will translate negative values into positive ones)
 
902
        revision can also be a string, in which case it is parsed for something like
 
903
            'date:' or 'revid:' etc.
 
904
        """
 
905
        revno, rev_id = self._get_revision_info(revision)
 
906
        if revno is None:
 
907
            raise bzrlib.errors.NoSuchRevision(self, revision)
 
908
        return revno, rev_id
 
909
 
282
910
    def get_rev_id(self, revno, history=None):
283
911
        """Find the revision id of the specified revno."""
284
912
        if revno == 0:
289
917
            raise bzrlib.errors.NoSuchRevision(self, revno)
290
918
        return history[revno - 1]
291
919
 
 
920
    def _get_revision_info(self, revision):
 
921
        """Return (revno, revision id) for revision specifier.
 
922
 
 
923
        revision can be an integer, in which case it is assumed to be revno
 
924
        (though this will translate negative values into positive ones)
 
925
        revision can also be a string, in which case it is parsed for something
 
926
        like 'date:' or 'revid:' etc.
 
927
 
 
928
        A revid is always returned.  If it is None, the specifier referred to
 
929
        the null revision.  If the revid does not occur in the revision
 
930
        history, revno will be None.
 
931
        """
 
932
        
 
933
        if revision is None:
 
934
            return 0, None
 
935
        revno = None
 
936
        try:# Convert to int if possible
 
937
            revision = int(revision)
 
938
        except ValueError:
 
939
            pass
 
940
        revs = self.revision_history()
 
941
        if isinstance(revision, int):
 
942
            if revision < 0:
 
943
                revno = len(revs) + revision + 1
 
944
            else:
 
945
                revno = revision
 
946
            rev_id = self.get_rev_id(revno, revs)
 
947
        elif isinstance(revision, basestring):
 
948
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
 
949
                if revision.startswith(prefix):
 
950
                    result = func(self, revs, revision)
 
951
                    if len(result) > 1:
 
952
                        revno, rev_id = result
 
953
                    else:
 
954
                        revno = result[0]
 
955
                        rev_id = self.get_rev_id(revno, revs)
 
956
                    break
 
957
            else:
 
958
                raise BzrError('No namespace registered for string: %r' %
 
959
                               revision)
 
960
        else:
 
961
            raise TypeError('Unhandled revision type %s' % revision)
 
962
 
 
963
        if revno is None:
 
964
            if rev_id is None:
 
965
                raise bzrlib.errors.NoSuchRevision(self, revision)
 
966
        return revno, rev_id
 
967
 
 
968
    def _namespace_revno(self, revs, revision):
 
969
        """Lookup a revision by revision number"""
 
970
        assert revision.startswith('revno:')
 
971
        try:
 
972
            return (int(revision[6:]),)
 
973
        except ValueError:
 
974
            return None
 
975
    REVISION_NAMESPACES['revno:'] = _namespace_revno
 
976
 
 
977
    def _namespace_revid(self, revs, revision):
 
978
        assert revision.startswith('revid:')
 
979
        rev_id = revision[len('revid:'):]
 
980
        try:
 
981
            return revs.index(rev_id) + 1, rev_id
 
982
        except ValueError:
 
983
            return None, rev_id
 
984
    REVISION_NAMESPACES['revid:'] = _namespace_revid
 
985
 
 
986
    def _namespace_last(self, revs, revision):
 
987
        assert revision.startswith('last:')
 
988
        try:
 
989
            offset = int(revision[5:])
 
990
        except ValueError:
 
991
            return (None,)
 
992
        else:
 
993
            if offset <= 0:
 
994
                raise BzrError('You must supply a positive value for --revision last:XXX')
 
995
            return (len(revs) - offset + 1,)
 
996
    REVISION_NAMESPACES['last:'] = _namespace_last
 
997
 
 
998
    def _namespace_tag(self, revs, revision):
 
999
        assert revision.startswith('tag:')
 
1000
        raise BzrError('tag: namespace registered, but not implemented.')
 
1001
    REVISION_NAMESPACES['tag:'] = _namespace_tag
 
1002
 
 
1003
    def _namespace_date(self, revs, revision):
 
1004
        assert revision.startswith('date:')
 
1005
        import datetime
 
1006
        # Spec for date revisions:
 
1007
        #   date:value
 
1008
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
 
1009
        #   it can also start with a '+/-/='. '+' says match the first
 
1010
        #   entry after the given date. '-' is match the first entry before the date
 
1011
        #   '=' is match the first entry after, but still on the given date.
 
1012
        #
 
1013
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
 
1014
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
 
1015
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
 
1016
        #       May 13th, 2005 at 0:00
 
1017
        #
 
1018
        #   So the proper way of saying 'give me all entries for today' is:
 
1019
        #       -r {date:+today}:{date:-tomorrow}
 
1020
        #   The default is '=' when not supplied
 
1021
        val = revision[5:]
 
1022
        match_style = '='
 
1023
        if val[:1] in ('+', '-', '='):
 
1024
            match_style = val[:1]
 
1025
            val = val[1:]
 
1026
 
 
1027
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
 
1028
        if val.lower() == 'yesterday':
 
1029
            dt = today - datetime.timedelta(days=1)
 
1030
        elif val.lower() == 'today':
 
1031
            dt = today
 
1032
        elif val.lower() == 'tomorrow':
 
1033
            dt = today + datetime.timedelta(days=1)
 
1034
        else:
 
1035
            import re
 
1036
            # This should be done outside the function to avoid recompiling it.
 
1037
            _date_re = re.compile(
 
1038
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
 
1039
                    r'(,|T)?\s*'
 
1040
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
 
1041
                )
 
1042
            m = _date_re.match(val)
 
1043
            if not m or (not m.group('date') and not m.group('time')):
 
1044
                raise BzrError('Invalid revision date %r' % revision)
 
1045
 
 
1046
            if m.group('date'):
 
1047
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
 
1048
            else:
 
1049
                year, month, day = today.year, today.month, today.day
 
1050
            if m.group('time'):
 
1051
                hour = int(m.group('hour'))
 
1052
                minute = int(m.group('minute'))
 
1053
                if m.group('second'):
 
1054
                    second = int(m.group('second'))
 
1055
                else:
 
1056
                    second = 0
 
1057
            else:
 
1058
                hour, minute, second = 0,0,0
 
1059
 
 
1060
            dt = datetime.datetime(year=year, month=month, day=day,
 
1061
                    hour=hour, minute=minute, second=second)
 
1062
        first = dt
 
1063
        last = None
 
1064
        reversed = False
 
1065
        if match_style == '-':
 
1066
            reversed = True
 
1067
        elif match_style == '=':
 
1068
            last = dt + datetime.timedelta(days=1)
 
1069
 
 
1070
        if reversed:
 
1071
            for i in range(len(revs)-1, -1, -1):
 
1072
                r = self.get_revision(revs[i])
 
1073
                # TODO: Handle timezone.
 
1074
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1075
                if first >= dt and (last is None or dt >= last):
 
1076
                    return (i+1,)
 
1077
        else:
 
1078
            for i in range(len(revs)):
 
1079
                r = self.get_revision(revs[i])
 
1080
                # TODO: Handle timezone.
 
1081
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1082
                if first <= dt and (last is None or dt <= last):
 
1083
                    return (i+1,)
 
1084
    REVISION_NAMESPACES['date:'] = _namespace_date
 
1085
 
 
1086
 
 
1087
    def _namespace_ancestor(self, revs, revision):
 
1088
        from revision import common_ancestor, MultipleRevisionSources
 
1089
        other_branch = find_branch(_trim_namespace('ancestor', revision))
 
1090
        revision_a = self.last_patch()
 
1091
        revision_b = other_branch.last_patch()
 
1092
        for r, b in ((revision_a, self), (revision_b, other_branch)):
 
1093
            if r is None:
 
1094
                raise bzrlib.errors.NoCommits(b)
 
1095
        revision_source = MultipleRevisionSources(self, other_branch)
 
1096
        result = common_ancestor(revision_a, revision_b, revision_source)
 
1097
        try:
 
1098
            revno = self.revision_id_to_revno(result)
 
1099
        except bzrlib.errors.NoSuchRevision:
 
1100
            revno = None
 
1101
        return revno,result
 
1102
        
 
1103
 
 
1104
    REVISION_NAMESPACES['ancestor:'] = _namespace_ancestor
 
1105
 
 
1106
    def revision_tree(self, revision_id):
 
1107
        """Return Tree for a revision on this branch.
 
1108
 
 
1109
        `revision_id` may be None for the null revision, in which case
 
1110
        an `EmptyTree` is returned."""
 
1111
        # TODO: refactor this to use an existing revision object
 
1112
        # so we don't need to read it in twice.
 
1113
        if revision_id == None:
 
1114
            return EmptyTree()
 
1115
        else:
 
1116
            inv = self.get_revision_inventory(revision_id)
 
1117
            return RevisionTree(self.text_store, inv)
 
1118
 
 
1119
 
292
1120
    def working_tree(self):
293
 
        """Return a `Tree` for the working copy if this is a local branch."""
294
 
        raise NotImplementedError('working_tree is abstract')
 
1121
        """Return a `Tree` for the working copy."""
 
1122
        from bzrlib.workingtree import WorkingTree
 
1123
        return WorkingTree(self.base, self.read_working_inventory())
295
1124
 
296
 
    def pull(self, source, overwrite=False):
297
 
        raise NotImplementedError('pull is abstract')
298
1125
 
299
1126
    def basis_tree(self):
300
1127
        """Return `Tree` object for last revision.
301
1128
 
302
1129
        If there are no revisions yet, return an `EmptyTree`.
303
1130
        """
304
 
        return self.repository.revision_tree(self.last_revision())
 
1131
        r = self.last_patch()
 
1132
        if r == None:
 
1133
            return EmptyTree()
 
1134
        else:
 
1135
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
1136
 
 
1137
 
305
1138
 
306
1139
    def rename_one(self, from_rel, to_rel):
307
1140
        """Rename one file.
308
1141
 
309
1142
        This can change the directory or the filename or both.
310
1143
        """
311
 
        raise NotImplementedError('rename_one is abstract')
 
1144
        self.lock_write()
 
1145
        try:
 
1146
            tree = self.working_tree()
 
1147
            inv = tree.inventory
 
1148
            if not tree.has_filename(from_rel):
 
1149
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
1150
            if tree.has_filename(to_rel):
 
1151
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
1152
 
 
1153
            file_id = inv.path2id(from_rel)
 
1154
            if file_id == None:
 
1155
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
1156
 
 
1157
            if inv.path2id(to_rel):
 
1158
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
1159
 
 
1160
            to_dir, to_tail = os.path.split(to_rel)
 
1161
            to_dir_id = inv.path2id(to_dir)
 
1162
            if to_dir_id == None and to_dir != '':
 
1163
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
1164
 
 
1165
            mutter("rename_one:")
 
1166
            mutter("  file_id    {%s}" % file_id)
 
1167
            mutter("  from_rel   %r" % from_rel)
 
1168
            mutter("  to_rel     %r" % to_rel)
 
1169
            mutter("  to_dir     %r" % to_dir)
 
1170
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
1171
 
 
1172
            inv.rename(file_id, to_dir_id, to_tail)
 
1173
 
 
1174
            from_abs = self.abspath(from_rel)
 
1175
            to_abs = self.abspath(to_rel)
 
1176
            try:
 
1177
                os.rename(from_abs, to_abs)
 
1178
            except OSError, e:
 
1179
                raise BzrError("failed to rename %r to %r: %s"
 
1180
                        % (from_abs, to_abs, e[1]),
 
1181
                        ["rename rolled back"])
 
1182
 
 
1183
            self._write_inventory(inv)
 
1184
        finally:
 
1185
            self.unlock()
 
1186
 
312
1187
 
313
1188
    def move(self, from_paths, to_name):
314
1189
        """Rename files.
324
1199
        This returns a list of (from_path, to_path) pairs for each
325
1200
        entry that is moved.
326
1201
        """
327
 
        raise NotImplementedError('move is abstract')
 
1202
        result = []
 
1203
        self.lock_write()
 
1204
        try:
 
1205
            ## TODO: Option to move IDs only
 
1206
            assert not isinstance(from_paths, basestring)
 
1207
            tree = self.working_tree()
 
1208
            inv = tree.inventory
 
1209
            to_abs = self.abspath(to_name)
 
1210
            if not isdir(to_abs):
 
1211
                raise BzrError("destination %r is not a directory" % to_abs)
 
1212
            if not tree.has_filename(to_name):
 
1213
                raise BzrError("destination %r not in working directory" % to_abs)
 
1214
            to_dir_id = inv.path2id(to_name)
 
1215
            if to_dir_id == None and to_name != '':
 
1216
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
1217
            to_dir_ie = inv[to_dir_id]
 
1218
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1219
                raise BzrError("destination %r is not a directory" % to_abs)
 
1220
 
 
1221
            to_idpath = inv.get_idpath(to_dir_id)
 
1222
 
 
1223
            for f in from_paths:
 
1224
                if not tree.has_filename(f):
 
1225
                    raise BzrError("%r does not exist in working tree" % f)
 
1226
                f_id = inv.path2id(f)
 
1227
                if f_id == None:
 
1228
                    raise BzrError("%r is not versioned" % f)
 
1229
                name_tail = splitpath(f)[-1]
 
1230
                dest_path = appendpath(to_name, name_tail)
 
1231
                if tree.has_filename(dest_path):
 
1232
                    raise BzrError("destination %r already exists" % dest_path)
 
1233
                if f_id in to_idpath:
 
1234
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1235
 
 
1236
            # OK, so there's a race here, it's possible that someone will
 
1237
            # create a file in this interval and then the rename might be
 
1238
            # left half-done.  But we should have caught most problems.
 
1239
 
 
1240
            for f in from_paths:
 
1241
                name_tail = splitpath(f)[-1]
 
1242
                dest_path = appendpath(to_name, name_tail)
 
1243
                result.append((f, dest_path))
 
1244
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1245
                try:
 
1246
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
1247
                except OSError, e:
 
1248
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1249
                            ["rename rolled back"])
 
1250
 
 
1251
            self._write_inventory(inv)
 
1252
        finally:
 
1253
            self.unlock()
 
1254
 
 
1255
        return result
 
1256
 
 
1257
 
 
1258
    def revert(self, filenames, old_tree=None, backups=True):
 
1259
        """Restore selected files to the versions from a previous tree.
 
1260
 
 
1261
        backups
 
1262
            If true (default) backups are made of files before
 
1263
            they're renamed.
 
1264
        """
 
1265
        from bzrlib.errors import NotVersionedError, BzrError
 
1266
        from bzrlib.atomicfile import AtomicFile
 
1267
        from bzrlib.osutils import backup_file
 
1268
        
 
1269
        inv = self.read_working_inventory()
 
1270
        if old_tree is None:
 
1271
            old_tree = self.basis_tree()
 
1272
        old_inv = old_tree.inventory
 
1273
 
 
1274
        nids = []
 
1275
        for fn in filenames:
 
1276
            file_id = inv.path2id(fn)
 
1277
            if not file_id:
 
1278
                raise NotVersionedError("not a versioned file", fn)
 
1279
            if not old_inv.has_id(file_id):
 
1280
                raise BzrError("file not present in old tree", fn, file_id)
 
1281
            nids.append((fn, file_id))
 
1282
            
 
1283
        # TODO: Rename back if it was previously at a different location
 
1284
 
 
1285
        # TODO: If given a directory, restore the entire contents from
 
1286
        # the previous version.
 
1287
 
 
1288
        # TODO: Make a backup to a temporary file.
 
1289
 
 
1290
        # TODO: If the file previously didn't exist, delete it?
 
1291
        for fn, file_id in nids:
 
1292
            backup_file(fn)
 
1293
            
 
1294
            f = AtomicFile(fn, 'wb')
 
1295
            try:
 
1296
                f.write(old_tree.get_file(file_id).read())
 
1297
                f.commit()
 
1298
            finally:
 
1299
                f.close()
 
1300
 
 
1301
 
 
1302
    def pending_merges(self):
 
1303
        """Return a list of pending merges.
 
1304
 
 
1305
        These are revisions that have been merged into the working
 
1306
        directory but not yet committed.
 
1307
        """
 
1308
        cfn = self.controlfilename('pending-merges')
 
1309
        if not os.path.exists(cfn):
 
1310
            return []
 
1311
        p = []
 
1312
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1313
            p.append(l.rstrip('\n'))
 
1314
        return p
 
1315
 
 
1316
 
 
1317
    def add_pending_merge(self, revision_id):
 
1318
        from bzrlib.revision import validate_revision_id
 
1319
 
 
1320
        validate_revision_id(revision_id)
 
1321
 
 
1322
        p = self.pending_merges()
 
1323
        if revision_id in p:
 
1324
            return
 
1325
        p.append(revision_id)
 
1326
        self.set_pending_merges(p)
 
1327
 
 
1328
 
 
1329
    def set_pending_merges(self, rev_list):
 
1330
        from bzrlib.atomicfile import AtomicFile
 
1331
        self.lock_write()
 
1332
        try:
 
1333
            f = AtomicFile(self.controlfilename('pending-merges'))
 
1334
            try:
 
1335
                for l in rev_list:
 
1336
                    print >>f, l
 
1337
                f.commit()
 
1338
            finally:
 
1339
                f.close()
 
1340
        finally:
 
1341
            self.unlock()
 
1342
 
328
1343
 
329
1344
    def get_parent(self):
330
1345
        """Return the parent location of the branch.
333
1348
        pattern is that the user can override it by specifying a
334
1349
        location.
335
1350
        """
336
 
        raise NotImplementedError('get_parent is abstract')
337
 
 
338
 
    def get_push_location(self):
339
 
        """Return the None or the location to push this branch to."""
340
 
        raise NotImplementedError('get_push_location is abstract')
341
 
 
342
 
    def set_push_location(self, location):
343
 
        """Set a new push location for this branch."""
344
 
        raise NotImplementedError('set_push_location is abstract')
 
1351
        import errno
 
1352
        _locs = ['parent', 'pull', 'x-pull']
 
1353
        for l in _locs:
 
1354
            try:
 
1355
                return self.controlfile(l, 'r').read().strip('\n')
 
1356
            except IOError, e:
 
1357
                if e.errno != errno.ENOENT:
 
1358
                    raise
 
1359
        return None
 
1360
 
345
1361
 
346
1362
    def set_parent(self, url):
347
 
        raise NotImplementedError('set_parent is abstract')
 
1363
        # TODO: Maybe delete old location files?
 
1364
        from bzrlib.atomicfile import AtomicFile
 
1365
        self.lock_write()
 
1366
        try:
 
1367
            f = AtomicFile(self.controlfilename('parent'))
 
1368
            try:
 
1369
                f.write(url + '\n')
 
1370
                f.commit()
 
1371
            finally:
 
1372
                f.close()
 
1373
        finally:
 
1374
            self.unlock()
348
1375
 
349
1376
    def check_revno(self, revno):
350
1377
        """\
362
1389
        if revno < 1 or revno > self.revno():
363
1390
            raise InvalidRevisionNumber(revno)
364
1391
        
365
 
    def sign_revision(self, revision_id, gpg_strategy):
366
 
        raise NotImplementedError('sign_revision is abstract')
367
 
 
368
 
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
369
 
        raise NotImplementedError('store_revision_signature is abstract')
370
 
 
371
 
    def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
372
 
        """Copy this branch into the existing directory to_location.
373
 
 
374
 
        Returns the newly created branch object.
375
 
 
376
 
        revision
377
 
            If not None, only revisions up to this point will be copied.
378
 
            The head of the new branch will be that revision.  Must be a
379
 
            revid or None.
380
 
    
381
 
        to_location -- The destination directory; must either exist and be 
382
 
            empty, or not exist, in which case it is created.
383
 
    
384
 
        basis_branch
385
 
            A local branch to copy revisions from, related to this branch. 
386
 
            This is used when branching from a remote (slow) branch, and we have
387
 
            a local branch that might contain some relevant revisions.
388
 
    
389
 
        to_branch_type
390
 
            Branch type of destination branch
391
 
        """
392
 
        assert isinstance(to_location, basestring)
393
 
        if not bzrlib.osutils.lexists(to_location):
394
 
            os.mkdir(to_location)
395
 
        if to_branch_type is None:
396
 
            to_branch_type = BzrBranch
397
 
        br_to = to_branch_type.initialize(to_location)
398
 
        mutter("copy branch from %s to %s", self, br_to)
399
 
        if basis_branch is not None:
400
 
            basis_branch.push_stores(br_to)
401
 
        br_to.working_tree().set_root_id(self.get_root_id())
402
 
        if revision is None:
403
 
            revision = self.last_revision()
404
 
        br_to.update_revisions(self, stop_revision=revision)
405
 
        br_to.set_parent(self.base)
406
 
        # circular import protection
407
 
        from bzrlib.merge import build_working_dir
408
 
        build_working_dir(to_location)
409
 
        mutter("copied")
410
 
        return br_to
411
 
 
412
 
class BzrBranch(Branch):
413
 
    """A branch stored in the actual filesystem.
414
 
 
415
 
    Note that it's "local" in the context of the filesystem; it doesn't
416
 
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
417
 
    it's writable, and can be accessed via the normal filesystem API.
418
 
 
419
 
    """
420
 
    # We actually expect this class to be somewhat short-lived; part of its
421
 
    # purpose is to try to isolate what bits of the branch logic are tied to
422
 
    # filesystem access, so that in a later step, we can extricate them to
423
 
    # a separarte ("storage") class.
424
 
    _inventory_weave = None
425
 
    
426
 
    # Map some sort of prefix into a namespace
427
 
    # stuff like "revno:10", "revid:", etc.
428
 
    # This should match a prefix with a function which accepts
429
 
    REVISION_NAMESPACES = {}
430
 
 
431
 
    def push_stores(self, branch_to):
432
 
        """See Branch.push_stores."""
433
 
        if (self._branch_format != branch_to._branch_format
434
 
            or self._branch_format != 4):
435
 
            from bzrlib.fetch import greedy_fetch
436
 
            mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
437
 
                   self, self._branch_format, branch_to, branch_to._branch_format)
438
 
            greedy_fetch(to_branch=branch_to, from_branch=self,
439
 
                         revision=self.last_revision())
440
 
            return
441
 
 
442
 
        store_pairs = ((self.text_store,      branch_to.text_store),
443
 
                       (self.inventory_store, branch_to.inventory_store),
444
 
                       (self.revision_store,  branch_to.revision_store))
445
 
        try:
446
 
            for from_store, to_store in store_pairs: 
447
 
                copy_all(from_store, to_store)
448
 
        except UnlistableStore:
449
 
            raise UnlistableBranch(from_store)
450
 
 
451
 
    def __init__(self, transport, init=False,
452
 
                 relax_version_check=False):
453
 
        """Create new branch object at a particular location.
454
 
 
455
 
        transport -- A Transport object, defining how to access files.
456
 
        
457
 
        init -- If True, create new control files in a previously
458
 
             unversioned directory.  If False, the branch must already
459
 
             be versioned.
460
 
 
461
 
        relax_version_check -- If true, the usual check for the branch
462
 
            version is not applied.  This is intended only for
463
 
            upgrade/recovery type use; it's not guaranteed that
464
 
            all operations will work on old format branches.
465
 
 
466
 
        In the test suite, creation of new trees is tested using the
467
 
        `ScratchBranch` class.
468
 
        """
469
 
        assert isinstance(transport, Transport), \
470
 
            "%r is not a Transport" % transport
471
 
        # TODO: jam 20060103 We create a clone of this transport at .bzr/
472
 
        #       and then we forget about it, should we keep a handle to it?
473
 
        self._base = transport.base
474
 
        self.control_files = LockableFiles(transport.clone(bzrlib.BZRDIR),
475
 
                                           'branch-lock')
476
 
        if init:
477
 
            self._make_control()
478
 
        self._check_format(relax_version_check)
479
 
        self.repository = Repository(transport, self._branch_format)
480
 
 
481
 
    def __str__(self):
482
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
483
 
 
484
 
    __repr__ = __str__
485
 
 
486
 
    def __del__(self):
487
 
        # TODO: It might be best to do this somewhere else,
488
 
        # but it is nice for a Branch object to automatically
489
 
        # cache it's information.
490
 
        # Alternatively, we could have the Transport objects cache requests
491
 
        # See the earlier discussion about how major objects (like Branch)
492
 
        # should never expect their __del__ function to run.
493
 
        if hasattr(self, 'cache_root') and self.cache_root is not None:
494
 
            try:
495
 
                shutil.rmtree(self.cache_root)
496
 
            except:
497
 
                pass
498
 
            self.cache_root = None
499
 
 
500
 
    def _get_base(self):
501
 
        return self._base
502
 
 
503
 
    base = property(_get_base, doc="The URL for the root of this branch.")
504
 
 
505
 
    def _finish_transaction(self):
506
 
        """Exit the current transaction."""
507
 
        return self.control_files._finish_transaction()
508
 
 
509
 
    def get_transaction(self):
510
 
        """Return the current active transaction.
511
 
 
512
 
        If no transaction is active, this returns a passthrough object
513
 
        for which all data is immediately flushed and no caching happens.
514
 
        """
515
 
        # this is an explicit function so that we can do tricky stuff
516
 
        # when the storage in rev_storage is elsewhere.
517
 
        # we probably need to hook the two 'lock a location' and 
518
 
        # 'have a transaction' together more delicately, so that
519
 
        # we can have two locks (branch and storage) and one transaction
520
 
        # ... and finishing the transaction unlocks both, but unlocking
521
 
        # does not. - RBC 20051121
522
 
        return self.control_files.get_transaction()
523
 
 
524
 
    def _set_transaction(self, transaction):
525
 
        """Set a new active transaction."""
526
 
        return self.control_files._set_transaction(transaction)
527
 
 
528
 
    def abspath(self, name):
529
 
        """See Branch.abspath."""
530
 
        return self.control_files._transport.abspath(name)
531
 
 
532
 
    def _make_control(self):
533
 
        from bzrlib.inventory import Inventory
534
 
        from bzrlib.weavefile import write_weave_v5
535
 
        from bzrlib.weave import Weave
536
 
        
537
 
        # Create an empty inventory
538
 
        sio = StringIO()
539
 
        # if we want per-tree root ids then this is the place to set
540
 
        # them; they're not needed for now and so ommitted for
541
 
        # simplicity.
542
 
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
543
 
        empty_inv = sio.getvalue()
544
 
        sio = StringIO()
545
 
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
546
 
        empty_weave = sio.getvalue()
547
 
 
548
 
        dirs = ['', 'revision-store', 'weaves']
549
 
        files = [('README', 
550
 
            "This is a Bazaar-NG control directory.\n"
551
 
            "Do not change any files in this directory.\n"),
552
 
            ('branch-format', BZR_BRANCH_FORMAT_6),
553
 
            ('revision-history', ''),
554
 
            ('branch-name', ''),
555
 
            ('branch-lock', ''),
556
 
            ('pending-merges', ''),
557
 
            ('inventory', empty_inv),
558
 
            ('inventory.weave', empty_weave),
559
 
            ('ancestry.weave', empty_weave)
560
 
        ]
561
 
        cfe = self.control_files._escape
562
 
        self.control_files._transport.mkdir_multi([cfe(d) for d in dirs],
563
 
                mode=self.control_files._dir_mode)
564
 
        self.control_files.lock_write()
565
 
        try:
566
 
            for file, content in files:
567
 
                self.control_files.put_utf8(file, content)
568
 
            mutter('created control directory in ' + self.base)
569
 
        finally:
570
 
            self.control_files.unlock()
571
 
 
572
 
    def _check_format(self, relax_version_check):
573
 
        """Check this branch format is supported.
574
 
 
575
 
        The format level is stored, as an integer, in
576
 
        self._branch_format for code that needs to check it later.
577
 
 
578
 
        In the future, we might need different in-memory Branch
579
 
        classes to support downlevel branches.  But not yet.
580
 
        """
581
 
        try:
582
 
            fmt = self.control_files.controlfile('branch-format', 'r').read()
583
 
        except NoSuchFile:
584
 
            raise NotBranchError(path=self.base)
585
 
        mutter("got branch format %r", fmt)
586
 
        if fmt == BZR_BRANCH_FORMAT_6:
587
 
            self._branch_format = 6
588
 
        elif fmt == BZR_BRANCH_FORMAT_5:
589
 
            self._branch_format = 5
590
 
        elif fmt == BZR_BRANCH_FORMAT_4:
591
 
            self._branch_format = 4
592
 
 
593
 
        if (not relax_version_check
594
 
            and self._branch_format not in (5, 6)):
595
 
            raise errors.UnsupportedFormatError(
596
 
                           'sorry, branch format %r not supported' % fmt,
597
 
                           ['use a different bzr version',
598
 
                            'or remove the .bzr directory'
599
 
                            ' and "bzr init" again'])
600
 
 
601
 
    @needs_read_lock
602
 
    def get_root_id(self):
603
 
        """See Branch.get_root_id."""
604
 
        inv = self.repository.get_inventory(self.last_revision())
605
 
        return inv.root.file_id
606
 
 
607
 
    def lock_write(self):
608
 
        # TODO: test for failed two phase locks. This is known broken.
609
 
        self.control_files.lock_write()
610
 
        self.repository.lock_write()
611
 
 
612
 
    def lock_read(self):
613
 
        # TODO: test for failed two phase locks. This is known broken.
614
 
        self.control_files.lock_read()
615
 
        self.repository.lock_read()
616
 
 
617
 
    def unlock(self):
618
 
        # TODO: test for failed two phase locks. This is known broken.
619
 
        self.repository.unlock()
620
 
        self.control_files.unlock()
621
 
 
622
 
    @needs_read_lock
623
 
    def print_file(self, file, revision_id):
624
 
        """See Branch.print_file."""
625
 
        return self.repository.print_file(file, revision_id)
626
 
 
627
 
    @needs_write_lock
628
 
    def append_revision(self, *revision_ids):
629
 
        """See Branch.append_revision."""
630
 
        for revision_id in revision_ids:
631
 
            mutter("add {%s} to revision-history" % revision_id)
632
 
        rev_history = self.revision_history()
633
 
        rev_history.extend(revision_ids)
634
 
        self.set_revision_history(rev_history)
635
 
 
636
 
    @needs_write_lock
637
 
    def set_revision_history(self, rev_history):
638
 
        """See Branch.set_revision_history."""
639
 
        old_revision = self.last_revision()
640
 
        new_revision = rev_history[-1]
641
 
        self.control_files.put_utf8(
642
 
            'revision-history', '\n'.join(rev_history))
643
 
        try:
644
 
            # FIXME: RBC 20051207 this smells wrong, last_revision in the 
645
 
            # working tree may be != to last_revision in the branch - so
646
 
            # why is this passing in the branches last_revision ?
647
 
            self.working_tree().set_last_revision(new_revision, old_revision)
648
 
        except NoWorkingTree:
649
 
            mutter('Unable to set_last_revision without a working tree.')
650
 
 
651
 
    def get_revision_delta(self, revno):
652
 
        """Return the delta for one revision.
653
 
 
654
 
        The delta is relative to its mainline predecessor, or the
655
 
        empty tree for revision 1.
656
 
        """
657
 
        assert isinstance(revno, int)
658
 
        rh = self.revision_history()
659
 
        if not (1 <= revno <= len(rh)):
660
 
            raise InvalidRevisionNumber(revno)
661
 
 
662
 
        # revno is 1-based; list is 0-based
663
 
 
664
 
        new_tree = self.repository.revision_tree(rh[revno-1])
665
 
        if revno == 1:
666
 
            old_tree = EmptyTree()
667
 
        else:
668
 
            old_tree = self.repository.revision_tree(rh[revno-2])
669
 
        return compare_trees(old_tree, new_tree)
670
 
 
671
 
    @needs_read_lock
672
 
    def revision_history(self):
673
 
        """See Branch.revision_history."""
674
 
        # FIXME are transactions bound to control files ? RBC 20051121
675
 
        transaction = self.get_transaction()
676
 
        history = transaction.map.find_revision_history()
677
 
        if history is not None:
678
 
            mutter("cache hit for revision-history in %s", self)
679
 
            return list(history)
680
 
        history = [l.rstrip('\r\n') for l in
681
 
                self.control_files.controlfile('revision-history', 'r').readlines()]
682
 
        transaction.map.add_revision_history(history)
683
 
        # this call is disabled because revision_history is 
684
 
        # not really an object yet, and the transaction is for objects.
685
 
        # transaction.register_clean(history, precious=True)
686
 
        return list(history)
687
 
 
688
 
    def update_revisions(self, other, stop_revision=None):
689
 
        """See Branch.update_revisions."""
690
 
        from bzrlib.fetch import greedy_fetch
691
 
        if stop_revision is None:
692
 
            stop_revision = other.last_revision()
693
 
        ### Should this be checking is_ancestor instead of revision_history?
694
 
        if (stop_revision is not None and 
695
 
            stop_revision in self.revision_history()):
696
 
            return
697
 
        greedy_fetch(to_branch=self, from_branch=other,
698
 
                     revision=stop_revision)
699
 
        pullable_revs = self.pullable_revisions(other, stop_revision)
700
 
        if len(pullable_revs) > 0:
701
 
            self.append_revision(*pullable_revs)
702
 
 
703
 
    def pullable_revisions(self, other, stop_revision):
704
 
        """See Branch.pullable_revisions."""
705
 
        other_revno = other.revision_id_to_revno(stop_revision)
706
 
        try:
707
 
            return self.missing_revisions(other, other_revno)
708
 
        except DivergedBranches, e:
709
 
            try:
710
 
                pullable_revs = get_intervening_revisions(self.last_revision(),
711
 
                                                          stop_revision, 
712
 
                                                          self.repository)
713
 
                assert self.last_revision() not in pullable_revs
714
 
                return pullable_revs
715
 
            except bzrlib.errors.NotAncestor:
716
 
                if is_ancestor(self.last_revision(), stop_revision, self):
717
 
                    return []
718
 
                else:
719
 
                    raise e
720
 
        
721
 
    def basis_tree(self):
722
 
        """See Branch.basis_tree."""
723
 
        try:
724
 
            revision_id = self.revision_history()[-1]
725
 
            # FIXME: This is an abstraction violation, the basis tree 
726
 
            # here as defined is on the working tree, the method should
727
 
            # be too. The basis tree for a branch can be different than
728
 
            # that for a working tree. RBC 20051207
729
 
            xml = self.working_tree().read_basis_inventory(revision_id)
730
 
            inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
731
 
            return RevisionTree(self.repository, inv, revision_id)
732
 
        except (IndexError, NoSuchFile, NoWorkingTree), e:
733
 
            return self.repository.revision_tree(self.last_revision())
734
 
 
735
 
    def working_tree(self):
736
 
        """See Branch.working_tree."""
737
 
        from bzrlib.workingtree import WorkingTree
738
 
        if self.base.find('://') != -1:
739
 
            raise NoWorkingTree(self.base)
740
 
        return WorkingTree(self.base, branch=self)
741
 
 
742
 
    @needs_write_lock
743
 
    def pull(self, source, overwrite=False):
744
 
        """See Branch.pull."""
745
 
        source.lock_read()
746
 
        try:
747
 
            old_count = len(self.revision_history())
748
 
            try:
749
 
                self.update_revisions(source)
750
 
            except DivergedBranches:
751
 
                if not overwrite:
752
 
                    raise
753
 
            if overwrite:
754
 
                self.set_revision_history(source.revision_history())
755
 
            new_count = len(self.revision_history())
756
 
            return new_count - old_count
757
 
        finally:
758
 
            source.unlock()
759
 
 
760
 
    def get_parent(self):
761
 
        """See Branch.get_parent."""
762
 
        import errno
763
 
        _locs = ['parent', 'pull', 'x-pull']
764
 
        for l in _locs:
765
 
            try:
766
 
                return self.control_files.controlfile(l, 'r').read().strip('\n')
767
 
            except NoSuchFile:
768
 
                pass
769
 
        return None
770
 
 
771
 
    def get_push_location(self):
772
 
        """See Branch.get_push_location."""
773
 
        config = bzrlib.config.BranchConfig(self)
774
 
        push_loc = config.get_user_option('push_location')
775
 
        return push_loc
776
 
 
777
 
    def set_push_location(self, location):
778
 
        """See Branch.set_push_location."""
779
 
        config = bzrlib.config.LocationConfig(self.base)
780
 
        config.set_user_option('push_location', location)
781
 
 
782
 
    @needs_write_lock
783
 
    def set_parent(self, url):
784
 
        """See Branch.set_parent."""
785
 
        # TODO: Maybe delete old location files?
786
 
        from bzrlib.atomicfile import AtomicFile
787
 
        f = AtomicFile(self.control_files.controlfilename('parent'))
788
 
        try:
789
 
            f.write(url + '\n')
790
 
            f.commit()
791
 
        finally:
792
 
            f.close()
793
 
 
794
 
    def tree_config(self):
795
 
        return TreeConfig(self)
796
 
 
797
 
    def _get_truncated_history(self, revision_id):
798
 
        history = self.revision_history()
799
 
        if revision_id is None:
800
 
            return history
801
 
        try:
802
 
            idx = history.index(revision_id)
803
 
        except ValueError:
804
 
            raise InvalidRevisionId(revision_id=revision, branch=self)
805
 
        return history[:idx+1]
806
 
 
807
 
    @needs_read_lock
808
 
    def _clone_weave(self, to_location, revision=None, basis_branch=None):
809
 
        assert isinstance(to_location, basestring)
810
 
        if basis_branch is not None:
811
 
            note("basis_branch is not supported for fast weave copy yet.")
812
 
 
813
 
        history = self._get_truncated_history(revision)
814
 
        if not bzrlib.osutils.lexists(to_location):
815
 
            os.mkdir(to_location)
816
 
        branch_to = Branch.initialize(to_location)
817
 
        mutter("copy branch from %s to %s", self, branch_to)
818
 
        branch_to.working_tree().set_root_id(self.get_root_id())
819
 
 
820
 
        self.repository.copy(branch_to.repository)
821
 
        
822
 
        # must be done *after* history is copied across
823
 
        # FIXME duplicate code with base .clone().
824
 
        # .. would template method be useful here.  RBC 20051207
825
 
        branch_to.set_parent(self.base)
826
 
        branch_to.append_revision(*history)
827
 
        # circular import protection
828
 
        from bzrlib.merge import build_working_dir
829
 
        build_working_dir(to_location)
830
 
        mutter("copied")
831
 
        return branch_to
832
 
 
833
 
    def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
834
 
        if to_branch_type is None:
835
 
            to_branch_type = BzrBranch
836
 
 
837
 
        if to_branch_type == BzrBranch \
838
 
            and self.repository.weave_store.listable() \
839
 
            and self.repository.revision_store.listable():
840
 
            return self._clone_weave(to_location, revision, basis_branch)
841
 
 
842
 
        return Branch.clone(self, to_location, revision, basis_branch, to_branch_type)
843
 
 
844
 
 
845
 
class ScratchBranch(BzrBranch):
 
1392
        
 
1393
 
 
1394
 
 
1395
class ScratchBranch(Branch):
846
1396
    """Special test class: a branch that cleans up after itself.
847
1397
 
848
1398
    >>> b = ScratchBranch()
849
1399
    >>> isdir(b.base)
850
1400
    True
851
1401
    >>> bd = b.base
852
 
    >>> b._transport.__del__()
 
1402
    >>> b.destroy()
853
1403
    >>> isdir(bd)
854
1404
    False
855
1405
    """
856
 
 
857
 
    def __init__(self, files=[], dirs=[], transport=None):
 
1406
    def __init__(self, files=[], dirs=[], base=None):
858
1407
        """Make a test branch.
859
1408
 
860
1409
        This creates a temporary directory and runs init-tree in it.
861
1410
 
862
1411
        If any files are listed, they are created in the working copy.
863
1412
        """
864
 
        if transport is None:
865
 
            transport = bzrlib.transport.local.ScratchTransport()
866
 
            super(ScratchBranch, self).__init__(transport, init=True)
867
 
        else:
868
 
            super(ScratchBranch, self).__init__(transport)
869
 
 
870
 
        # BzrBranch creates a clone to .bzr and then forgets about the
871
 
        # original transport. A ScratchTransport() deletes itself and
872
 
        # everything underneath it when it goes away, so we need to
873
 
        # grab a local copy to prevent that from happening
874
 
        self._transport = transport
875
 
 
 
1413
        from tempfile import mkdtemp
 
1414
        init = False
 
1415
        if base is None:
 
1416
            base = mkdtemp()
 
1417
            init = True
 
1418
        Branch.__init__(self, base, init=init)
876
1419
        for d in dirs:
877
 
            self._transport.mkdir(d)
 
1420
            os.mkdir(self.abspath(d))
878
1421
            
879
1422
        for f in files:
880
 
            self._transport.put(f, 'content of %s' % f)
 
1423
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1424
 
881
1425
 
882
1426
    def clone(self):
883
1427
        """
884
1428
        >>> orig = ScratchBranch(files=["file1", "file2"])
885
 
        >>> os.listdir(orig.base)
886
 
        [u'.bzr', u'file1', u'file2']
887
1429
        >>> clone = orig.clone()
888
 
        >>> if os.name != 'nt':
889
 
        ...   os.path.samefile(orig.base, clone.base)
890
 
        ... else:
891
 
        ...   orig.base == clone.base
892
 
        ...
 
1430
        >>> os.path.samefile(orig.base, clone.base)
893
1431
        False
894
 
        >>> os.listdir(clone.base)
895
 
        [u'.bzr', u'file1', u'file2']
 
1432
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1433
        True
896
1434
        """
897
1435
        from shutil import copytree
898
 
        from bzrlib.osutils import mkdtemp
 
1436
        from tempfile import mkdtemp
899
1437
        base = mkdtemp()
900
1438
        os.rmdir(base)
901
1439
        copytree(self.base, base, symlinks=True)
902
 
        return ScratchBranch(
903
 
            transport=bzrlib.transport.local.ScratchTransport(base))
 
1440
        return ScratchBranch(base=base)
 
1441
 
 
1442
 
 
1443
        
 
1444
    def __del__(self):
 
1445
        self.destroy()
 
1446
 
 
1447
    def destroy(self):
 
1448
        """Destroy the test branch, removing the scratch directory."""
 
1449
        from shutil import rmtree
 
1450
        try:
 
1451
            if self.base:
 
1452
                mutter("delete ScratchBranch %s" % self.base)
 
1453
                rmtree(self.base)
 
1454
        except OSError, e:
 
1455
            # Work around for shutil.rmtree failing on Windows when
 
1456
            # readonly files are encountered
 
1457
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
1458
            for root, dirs, files in os.walk(self.base, topdown=False):
 
1459
                for name in files:
 
1460
                    os.chmod(os.path.join(root, name), 0700)
 
1461
            rmtree(self.base)
 
1462
        self.base = None
 
1463
 
904
1464
    
905
1465
 
906
1466
######################################################################
909
1469
 
910
1470
def is_control_file(filename):
911
1471
    ## FIXME: better check
912
 
    filename = normpath(filename)
 
1472
    filename = os.path.normpath(filename)
913
1473
    while filename != '':
914
1474
        head, tail = os.path.split(filename)
915
1475
        ## mutter('check %r for control file' % ((head, tail), ))
919
1479
            break
920
1480
        filename = head
921
1481
    return False
 
1482
 
 
1483
 
 
1484
 
 
1485
def gen_file_id(name):
 
1486
    """Return new file id.
 
1487
 
 
1488
    This should probably generate proper UUIDs, but for the moment we
 
1489
    cope with just randomness because running uuidgen every time is
 
1490
    slow."""
 
1491
    import re
 
1492
    from binascii import hexlify
 
1493
    from time import time
 
1494
 
 
1495
    # get last component
 
1496
    idx = name.rfind('/')
 
1497
    if idx != -1:
 
1498
        name = name[idx+1 : ]
 
1499
    idx = name.rfind('\\')
 
1500
    if idx != -1:
 
1501
        name = name[idx+1 : ]
 
1502
 
 
1503
    # make it not a hidden file
 
1504
    name = name.lstrip('.')
 
1505
 
 
1506
    # remove any wierd characters; we don't escape them but rather
 
1507
    # just pull them out
 
1508
    name = re.sub(r'[^\w.]', '', name)
 
1509
 
 
1510
    s = hexlify(rand_bytes(8))
 
1511
    return '-'.join((name, compact_date(time()), s))
 
1512
 
 
1513
 
 
1514
def gen_root_id():
 
1515
    """Return a new tree-root file id."""
 
1516
    return gen_file_id('TREE_ROOT')
 
1517
 
 
1518
 
 
1519
def copy_branch(branch_from, to_location, revision=None):
 
1520
    """Copy branch_from into the existing directory to_location.
 
1521
 
 
1522
    revision
 
1523
        If not None, only revisions up to this point will be copied.
 
1524
        The head of the new branch will be that revision.
 
1525
 
 
1526
    to_location
 
1527
        The name of a local directory that exists but is empty.
 
1528
    """
 
1529
    from bzrlib.merge import merge
 
1530
 
 
1531
    assert isinstance(branch_from, Branch)
 
1532
    assert isinstance(to_location, basestring)
 
1533
    
 
1534
    br_to = Branch(to_location, init=True)
 
1535
    br_to.set_root_id(branch_from.get_root_id())
 
1536
    if revision is None:
 
1537
        revno = branch_from.revno()
 
1538
    else:
 
1539
        revno, rev_id = branch_from.get_revision_info(revision)
 
1540
    br_to.update_revisions(branch_from, stop_revision=revno)
 
1541
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
1542
          check_clean=False, ignore_zero=True)
 
1543
    br_to.set_parent(branch_from.base)
 
1544
    return br_to
 
1545
 
 
1546
def _trim_namespace(namespace, spec):
 
1547
    full_namespace = namespace + ':'
 
1548
    assert spec.startswith(full_namespace)
 
1549
    return spec[len(full_namespace):]