/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Arbash Meinel
  • Date: 2006-01-19 21:25:01 UTC
  • mto: (1185.50.49 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1549.
  • Revision ID: john@arbash-meinel.com-20060119212501-cb28cf532a878c41
fileid_involved needs to unescape the file id and revision id

Show diffs side-by-side

added added

removed removed

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