/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

Changing final merge message to All changes applied successfully, rather than 0 conflicts applied.

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