/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

Merge from mbp.

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