← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

and the tutorial patch came back, the very next day

Show diffs side-by-side

added added

removed removed

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