/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

Nearly complete .bzr/checkout splitout.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
 
18
from copy import deepcopy
 
19
from cStringIO import StringIO
 
20
import errno
 
21
import os
 
22
import shutil
18
23
import sys
19
 
import os
 
24
from unittest import TestSuite
 
25
from warnings import warn
 
26
try:
 
27
    import xml.sax.saxutils
 
28
except ImportError:
 
29
    raise ImportError("We were unable to import 'xml.sax.saxutils',"
 
30
                      " most likely you have an xml.pyc or xml.pyo file"
 
31
                      " lying around in your bzrlib directory."
 
32
                      " Please remove it.")
 
33
 
20
34
 
21
35
import bzrlib
 
36
import bzrlib.bzrdir as bzrdir
 
37
from bzrlib.config import TreeConfig
 
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
39
from bzrlib.delta import compare_trees
 
40
import bzrlib.errors as errors
 
41
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
 
42
                           NoSuchRevision, HistoryMissing, NotBranchError,
 
43
                           DivergedBranches, LockError,
 
44
                           UninitializableFormat,
 
45
                           UnlistableStore,
 
46
                           UnlistableBranch, NoSuchFile, NotVersionedError,
 
47
                           NoWorkingTree)
 
48
import bzrlib.inventory as inventory
 
49
from bzrlib.inventory import Inventory
 
50
from bzrlib.lockable_files import LockableFiles
 
51
from bzrlib.osutils import (isdir, quotefn,
 
52
                            rename, splitpath, sha_file,
 
53
                            file_kind, abspath, normpath, pathjoin,
 
54
                            safe_unicode,
 
55
                            )
 
56
from bzrlib.textui import show_status
22
57
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
28
 
from bzrlib.textui import show_status
29
 
from bzrlib.revision import Revision
30
 
from bzrlib.xml import unpack_xml
31
 
from bzrlib.delta import compare_trees
32
 
from bzrlib.tree import EmptyTree, RevisionTree
33
 
        
34
 
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
35
 
## TODO: Maybe include checks for common corruption of newlines, etc?
36
 
 
 
58
from bzrlib.tree import EmptyTree, RevisionTree
 
59
from bzrlib.repository import Repository
 
60
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions)
 
61
from bzrlib.store import copy_all
 
62
from bzrlib.symbol_versioning import *
 
63
import bzrlib.transactions as transactions
 
64
from bzrlib.transport import Transport, get_transport
 
65
from bzrlib.tree import EmptyTree, RevisionTree
 
66
import bzrlib.ui
 
67
import bzrlib.xml5
 
68
 
 
69
 
 
70
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
71
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
72
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
 
73
 
 
74
 
 
75
# TODO: Maybe include checks for common corruption of newlines, etc?
37
76
 
38
77
# TODO: Some operations like log might retrieve the same revisions
39
78
# 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.")
 
79
# cache in memory to make this faster.  In general anything can be
 
80
# cached in memory between lock and unlock operations. .. nb thats
 
81
# what the transaction identity map provides
131
82
 
132
83
 
133
84
######################################################################
137
88
    """Branch holding a history of revisions.
138
89
 
139
90
    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.
 
91
        Base directory/url of the branch.
151
92
    """
 
93
    # this is really an instance variable - FIXME move it there
 
94
    # - RBC 20060112
152
95
    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
 
 
211
 
 
 
96
 
 
97
    @staticmethod
 
98
    def create(base):
 
99
        """Construct the current default format branch in a_bzrdir.
 
100
 
 
101
        This creates the current default BzrDir format, and if that 
 
102
        supports multiple Branch formats, then the default Branch format
 
103
        will take effect.
 
104
        """
 
105
        print "not usable until we have repositories"
 
106
        raise NotImplementedError("not usable right now")
 
107
        return bzrdir.BzrDir.create(base)
 
108
 
 
109
    def __init__(self, *ignored, **ignored_too):
 
110
        raise NotImplementedError('The Branch class is abstract')
 
111
 
 
112
    @staticmethod
 
113
    @deprecated_method(zero_eight)
 
114
    def open_downlevel(base):
 
115
        """Open a branch which may be of an old format."""
 
116
        return Branch.open(base, _unsupported=True)
 
117
        
 
118
    @staticmethod
 
119
    def open(base, _unsupported=False):
 
120
        """Open the repository rooted at base.
 
121
 
 
122
        For instance, if the repository is at URL/.bzr/repository,
 
123
        Repository.open(URL) -> a Repository instance.
 
124
        """
 
125
        control = bzrdir.BzrDir.open(base, _unsupported)
 
126
        return control.open_branch(_unsupported)
 
127
 
 
128
    @staticmethod
 
129
    def open_containing(url):
 
130
        """Open an existing branch which contains url.
 
131
        
 
132
        This probes for a branch at url, and searches upwards from there.
 
133
 
 
134
        Basically we keep looking up until we find the control directory or
 
135
        run into the root.  If there isn't one, raises NotBranchError.
 
136
        If there is one and it is either an unrecognised format or an unsupported 
 
137
        format, UnknownFormatError or UnsupportedFormatError are raised.
 
138
        If there is one, it is returned, along with the unused portion of url.
 
139
        """
 
140
        control, relpath = bzrdir.BzrDir.open_containing(url)
 
141
        return control.open_branch(), relpath
 
142
 
 
143
    @staticmethod
 
144
    @deprecated_function(zero_eight)
 
145
    def initialize(base):
 
146
        """Create a new working tree and branch, rooted at 'base' (url)
 
147
 
 
148
        NOTE: This will soon be deprecated in favour of creation
 
149
        through a BzrDir.
 
150
        """
 
151
        # imported here to prevent scope creep as this is going.
 
152
        from bzrlib.workingtree import WorkingTree
 
153
        return WorkingTree.create_standalone(safe_unicode(base)).branch
 
154
 
 
155
    def setup_caching(self, cache_root):
 
156
        """Subclasses that care about caching should override this, and set
 
157
        up cached stores located under cache_root.
 
158
        """
 
159
        # seems to be unused, 2006-01-13 mbp
 
160
        warn('%s is deprecated' % self.setup_caching)
 
161
        self.cache_root = cache_root
 
162
 
 
163
    def _get_nick(self):
 
164
        cfg = self.tree_config()
 
165
        return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
 
166
 
 
167
    def _set_nick(self, nick):
 
168
        cfg = self.tree_config()
 
169
        cfg.set_option(nick, "nickname")
 
170
        assert cfg.get_option("nickname") == nick
 
171
 
 
172
    nick = property(_get_nick, _set_nick)
 
173
        
212
174
    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
 
 
 
175
        raise NotImplementedError('lock_write is abstract')
 
176
        
228
177
    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
 
            
 
178
        raise NotImplementedError('lock_read is abstract')
 
179
 
242
180
    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
 
 
 
181
        raise NotImplementedError('unlock is abstract')
 
182
 
 
183
    def peek_lock_mode(self):
 
184
        """Return lock mode for the Branch: 'r', 'w' or None"""
 
185
        raise NotImplementedError(self.peek_lock_mode)
254
186
 
255
187
    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
 
 
266
 
 
267
 
    def controlfilename(self, file_or_path):
268
 
        """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
 
 
273
 
 
274
 
    def controlfile(self, file_or_path, mode='r'):
275
 
        """Open a control file for this branch.
276
 
 
277
 
        There are two classes of file in the control directory: text
278
 
        and binary.  binary files are untranslated byte streams.  Text
279
 
        control files are stored with Unix newlines and in UTF-8, even
280
 
        if the platform or locale defaults are different.
281
 
 
282
 
        Controlfiles should almost never be opened in write mode but
283
 
        rather should be atomically copied and replaced using atomicfile.
284
 
        """
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
 
188
        """Return absolute filename for something in the branch
304
189
        
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.
 
190
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
 
191
        method and not a tree method.
329
192
        """
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'])
 
193
        raise NotImplementedError('abspath is abstract')
339
194
 
340
195
    def get_root_id(self):
341
196
        """Return the id of this branches root"""
342
 
        inv = self.read_working_inventory()
343
 
        return inv.root.file_id
344
 
 
345
 
    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):
 
197
        raise NotImplementedError('get_root_id is abstract')
 
198
 
 
199
    def print_file(self, file, revision_id):
480
200
        """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
 
 
 
201
        raise NotImplementedError('print_file is abstract')
568
202
 
569
203
    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
 
 
586
 
 
587
 
    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
 
 
601
 
 
602
 
    def get_revision(self, revision_id):
603
 
        """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
 
 
616
 
 
617
 
    def get_revision_delta(self, revno):
618
 
        """Return the delta for one revision.
619
 
 
620
 
        The delta is relative to its mainline predecessor, or the
621
 
        empty tree for revision 1.
622
 
        """
623
 
        assert isinstance(revno, int)
624
 
        rh = self.revision_history()
625
 
        if not (1 <= revno <= len(rh)):
626
 
            raise InvalidRevisionNumber(revno)
627
 
 
628
 
        # revno is 1-based; list is 0-based
629
 
 
630
 
        new_tree = self.revision_tree(rh[revno-1])
631
 
        if revno == 1:
632
 
            old_tree = EmptyTree()
633
 
        else:
634
 
            old_tree = self.revision_tree(rh[revno-2])
635
 
 
636
 
        return compare_trees(old_tree, new_tree)
637
 
 
638
 
        
639
 
 
640
 
    def get_revision_sha1(self, revision_id):
641
 
        """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
665
 
        """
666
 
        return sha_file(self.inventory_store[inventory_id])
667
 
 
668
 
 
669
 
    def get_revision_inventory(self, revision_id):
670
 
        """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
 
 
 
204
        raise NotImplementedError('append_revision is abstract')
 
205
 
 
206
    def set_revision_history(self, rev_history):
 
207
        raise NotImplementedError('set_revision_history is abstract')
679
208
 
680
209
    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
 
 
 
210
        """Return sequence of revision hashes on to this branch."""
 
211
        raise NotImplementedError('revision_history is abstract')
738
212
 
739
213
    def revno(self):
740
214
        """Return current revision number for this branch.
744
218
        """
745
219
        return len(self.revision_history())
746
220
 
747
 
 
748
 
    def last_patch(self):
749
 
        """Return last patch hash, or None if no history.
750
 
        """
 
221
    def last_revision(self):
 
222
        """Return last patch hash, or None if no history."""
751
223
        ph = self.revision_history()
752
224
        if ph:
753
225
            return ph[-1]
754
226
        else:
755
227
            return None
756
228
 
757
 
 
758
 
    def missing_revisions(self, other, stop_revision=None):
759
 
        """
 
229
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
 
230
        """Return a list of new revisions that would perfectly fit.
 
231
        
760
232
        If self and other have not diverged, return a list of the revisions
761
233
        present in other, but missing from self.
762
234
 
763
 
        >>> from bzrlib.commit import commit
 
235
        >>> from bzrlib.workingtree import WorkingTree
764
236
        >>> bzrlib.trace.silent = True
765
 
        >>> br1 = ScratchBranch()
766
 
        >>> br2 = ScratchBranch()
 
237
        >>> d1 = bzrdir.ScratchDir()
 
238
        >>> br1 = d1.open_branch()
 
239
        >>> wt1 = WorkingTree(br1.base, br1)
 
240
        >>> d2 = bzrdir.ScratchDir()
 
241
        >>> br2 = d2.open_branch()
 
242
        >>> wt2 = WorkingTree(br2.base, br2)
767
243
        >>> br1.missing_revisions(br2)
768
244
        []
769
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
245
        >>> wt2.commit("lala!", rev_id="REVISION-ID-1")
770
246
        >>> br1.missing_revisions(br2)
771
247
        [u'REVISION-ID-1']
772
248
        >>> br2.missing_revisions(br1)
773
249
        []
774
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
250
        >>> wt1.commit("lala!", rev_id="REVISION-ID-1")
775
251
        >>> br1.missing_revisions(br2)
776
252
        []
777
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
253
        >>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
778
254
        >>> br1.missing_revisions(br2)
779
255
        [u'REVISION-ID-2A']
780
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
256
        >>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
781
257
        >>> br1.missing_revisions(br2)
782
258
        Traceback (most recent call last):
783
 
        DivergedBranches: These branches have diverged.
 
259
        DivergedBranches: These branches have diverged.  Try merge.
784
260
        """
785
261
        self_history = self.revision_history()
786
262
        self_len = len(self_history)
793
269
 
794
270
        if stop_revision is None:
795
271
            stop_revision = other_len
796
 
        elif stop_revision > other_len:
797
 
            raise NoSuchRevision(self, stop_revision)
798
 
        
 
272
        else:
 
273
            assert isinstance(stop_revision, int)
 
274
            if stop_revision > other_len:
 
275
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
799
276
        return other_history[self_len:stop_revision]
800
277
 
801
 
 
802
278
    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
1032
 
 
1033
 
    def revision_tree(self, revision_id):
1034
 
        """Return Tree for a revision on this branch.
1035
 
 
1036
 
        `revision_id` may be None for the null revision, in which case
1037
 
        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
 
 
1046
 
 
1047
 
    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())
1051
 
 
 
279
        """Pull in new perfect-fit revisions."""
 
280
        raise NotImplementedError('update_revisions is abstract')
 
281
 
 
282
    def pullable_revisions(self, other, stop_revision):
 
283
        raise NotImplementedError('pullable_revisions is abstract')
 
284
        
 
285
    def revision_id_to_revno(self, revision_id):
 
286
        """Given a revision id, return its revno"""
 
287
        if revision_id is None:
 
288
            return 0
 
289
        history = self.revision_history()
 
290
        try:
 
291
            return history.index(revision_id) + 1
 
292
        except ValueError:
 
293
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
294
 
 
295
    def get_rev_id(self, revno, history=None):
 
296
        """Find the revision id of the specified revno."""
 
297
        if revno == 0:
 
298
            return None
 
299
        if history is None:
 
300
            history = self.revision_history()
 
301
        elif revno <= 0 or revno > len(history):
 
302
            raise bzrlib.errors.NoSuchRevision(self, revno)
 
303
        return history[revno - 1]
 
304
 
 
305
    def pull(self, source, overwrite=False):
 
306
        raise NotImplementedError('pull is abstract')
1052
307
 
1053
308
    def basis_tree(self):
1054
309
        """Return `Tree` object for last revision.
1055
310
 
1056
311
        If there are no revisions yet, return an `EmptyTree`.
1057
312
        """
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
 
 
 
313
        return self.repository.revision_tree(self.last_revision())
1065
314
 
1066
315
    def rename_one(self, from_rel, to_rel):
1067
316
        """Rename one file.
1068
317
 
1069
318
        This can change the directory or the filename or both.
1070
319
        """
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
 
 
 
320
        raise NotImplementedError('rename_one is abstract')
1116
321
 
1117
322
    def move(self, from_paths, to_name):
1118
323
        """Rename files.
1124
329
 
1125
330
        Note that to_name is only the last component of the new name;
1126
331
        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:
 
332
 
 
333
        This returns a list of (from_path, to_path) pairs for each
 
334
        entry that is moved.
 
335
        """
 
336
        raise NotImplementedError('move is abstract')
 
337
 
 
338
    def get_parent(self):
 
339
        """Return the parent location of the branch.
 
340
 
 
341
        This is the default location for push/pull/missing.  The usual
 
342
        pattern is that the user can override it by specifying a
 
343
        location.
 
344
        """
 
345
        raise NotImplementedError('get_parent is abstract')
 
346
 
 
347
    def get_push_location(self):
 
348
        """Return the None or the location to push this branch to."""
 
349
        raise NotImplementedError('get_push_location is abstract')
 
350
 
 
351
    def set_push_location(self, location):
 
352
        """Set a new push location for this branch."""
 
353
        raise NotImplementedError('set_push_location is abstract')
 
354
 
 
355
    def set_parent(self, url):
 
356
        raise NotImplementedError('set_parent is abstract')
 
357
 
 
358
    def check_revno(self, revno):
 
359
        """\
 
360
        Check whether a revno corresponds to any revision.
 
361
        Zero (the NULL revision) is considered valid.
 
362
        """
 
363
        if revno != 0:
 
364
            self.check_real_revno(revno)
 
365
            
 
366
    def check_real_revno(self, revno):
 
367
        """\
 
368
        Check whether a revno corresponds to a real revision.
 
369
        Zero (the NULL revision) is considered invalid
 
370
        """
 
371
        if revno < 1 or revno > self.revno():
 
372
            raise InvalidRevisionNumber(revno)
 
373
        
 
374
    def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
 
375
        """Copy this branch into the existing directory to_location.
 
376
 
 
377
        Returns the newly created branch object.
 
378
 
 
379
        revision
 
380
            If not None, only revisions up to this point will be copied.
 
381
            The head of the new branch will be that revision.  Must be a
 
382
            revid or None.
 
383
    
 
384
        to_location -- The destination directory; must either exist and be 
 
385
            empty, or not exist, in which case it is created.
 
386
    
 
387
        basis_branch
 
388
            A local branch to copy revisions from, related to this branch. 
 
389
            This is used when branching from a remote (slow) branch, and we have
 
390
            a local branch that might contain some relevant revisions.
 
391
    
 
392
        to_branch_type
 
393
            Branch type of destination branch
 
394
        """
 
395
        from bzrlib.workingtree import WorkingTree
 
396
        assert isinstance(to_location, basestring)
 
397
        segments = to_location.split('/')
 
398
        if segments and segments[-1] not in ('', '.'):
 
399
            parent = '/'.join(segments[:-1])
 
400
            t = get_transport(parent)
 
401
            try:
 
402
                t.mkdir(segments[-1])
 
403
            except errors.FileExists:
 
404
                pass
 
405
        if to_branch_format is None:
 
406
            # use the default
 
407
            br_to = bzrdir.BzrDir.create_branch_and_repo(to_location)
 
408
        else:
 
409
            br_to = to_branch_format.initialize(to_location)
 
410
        mutter("copy branch from %s to %s", self, br_to)
 
411
        if revision is None:
 
412
            revision = self.last_revision()
 
413
        if basis_branch is not None:
 
414
            basis_branch.repository.push_stores(br_to.repository,
 
415
                                                revision=revision)
 
416
        br_to.update_revisions(self, stop_revision=revision)
 
417
        br_to.set_parent(self.base)
 
418
        mutter("copied")
 
419
        return br_to
 
420
 
 
421
 
 
422
class BranchFormat(object):
 
423
    """An encapsulation of the initialization and open routines for a format.
 
424
 
 
425
    Formats provide three things:
 
426
     * An initialization routine,
 
427
     * a format string,
 
428
     * an open routine.
 
429
 
 
430
    Formats are placed in an dict by their format string for reference 
 
431
    during branch opening. Its not required that these be instances, they
 
432
    can be classes themselves with class methods - it simply depends on 
 
433
    whether state is needed for a given format or not.
 
434
 
 
435
    Once a format is deprecated, just deprecate the initialize and open
 
436
    methods on the format class. Do not deprecate the object, as the 
 
437
    object will be created every time regardless.
 
438
    """
 
439
 
 
440
    _default_format = None
 
441
    """The default format used for new branches."""
 
442
 
 
443
    _formats = {}
 
444
    """The known formats."""
 
445
 
 
446
    @classmethod
 
447
    def find_format(klass, a_bzrdir):
 
448
        """Return the format for the branch object in a_bzrdir."""
 
449
        try:
 
450
            transport = a_bzrdir.get_branch_transport(None)
 
451
            format_string = transport.get("format").read()
 
452
            return klass._formats[format_string]
 
453
        except NoSuchFile:
 
454
            raise NotBranchError(path=transport.base)
 
455
        except KeyError:
 
456
            raise errors.UnknownFormatError(format_string)
 
457
 
 
458
    @classmethod
 
459
    def get_default_format(klass):
 
460
        """Return the current default format."""
 
461
        return klass._default_format
 
462
 
 
463
    def get_format_string(self):
 
464
        """Return the ASCII format string that identifies this format."""
 
465
        raise NotImplementedError(self.get_format_string)
 
466
 
 
467
    def _find_modes(self, t):
 
468
        """Determine the appropriate modes for files and directories.
 
469
        
 
470
        FIXME: When this merges into, or from storage,
 
471
        this code becomes delgatable to a LockableFiles instance.
 
472
 
 
473
        For now its cribbed and returns (dir_mode, file_mode)
 
474
        """
 
475
        try:
 
476
            st = t.stat('.')
 
477
        except errors.TransportNotPossible:
 
478
            dir_mode = 0755
 
479
            file_mode = 0644
 
480
        else:
 
481
            dir_mode = st.st_mode & 07777
 
482
            # Remove the sticky and execute bits for files
 
483
            file_mode = dir_mode & ~07111
 
484
        if not BzrBranch._set_dir_mode:
 
485
            dir_mode = None
 
486
        if not BzrBranch._set_file_mode:
 
487
            file_mode = None
 
488
        return dir_mode, file_mode
 
489
 
 
490
    def initialize(self, a_bzrdir):
 
491
        """Create a branch of this format in a_bzrdir."""
 
492
        raise NotImplementedError(self.initialized)
 
493
 
 
494
    def is_supported(self):
 
495
        """Is this format supported?
 
496
 
 
497
        Supported formats can be initialized and opened.
 
498
        Unsupported formats may not support initialization or committing or 
 
499
        some other features depending on the reason for not being supported.
 
500
        """
 
501
        return True
 
502
 
 
503
    def open(self, a_bzrdir, _found=False):
 
504
        """Return the branch object for a_bzrdir
 
505
 
 
506
        _found is a private parameter, do not use it. It is used to indicate
 
507
               if format probing has already be done.
 
508
        """
 
509
        raise NotImplementedError(self.open)
 
510
 
 
511
    @classmethod
 
512
    def register_format(klass, format):
 
513
        klass._formats[format.get_format_string()] = format
 
514
 
 
515
    @classmethod
 
516
    def set_default_format(klass, format):
 
517
        klass._default_format = format
 
518
 
 
519
    @classmethod
 
520
    def unregister_format(klass, format):
 
521
        assert klass._formats[format.get_format_string()] is format
 
522
        del klass._formats[format.get_format_string()]
 
523
 
 
524
 
 
525
class BzrBranchFormat4(BranchFormat):
 
526
    """Bzr branch format 4.
 
527
 
 
528
    This format has:
 
529
     - a revision-history file.
 
530
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
531
    """
 
532
 
 
533
    def initialize(self, a_bzrdir):
 
534
        """Create a branch of this format in a_bzrdir."""
 
535
        mutter('creating branch in %s', a_bzrdir.transport.base)
 
536
        branch_transport = a_bzrdir.get_branch_transport(self)
 
537
        utf8_files = [('revision-history', ''),
 
538
                      ('branch-name', ''),
 
539
                      ]
 
540
        control_files = LockableFiles(branch_transport, 'branch-lock')
 
541
        control_files.lock_write()
 
542
        try:
 
543
            for file, content in utf8_files:
 
544
                control_files.put_utf8(file, content)
 
545
        finally:
 
546
            control_files.unlock()
 
547
        return self.open(a_bzrdir, _found=True)
 
548
 
 
549
    def __init__(self):
 
550
        super(BzrBranchFormat4, self).__init__()
 
551
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
552
 
 
553
    def open(self, a_bzrdir, _found=False):
 
554
        """Return the branch object for a_bzrdir
 
555
 
 
556
        _found is a private parameter, do not use it. It is used to indicate
 
557
               if format probing has already be done.
 
558
        """
 
559
        if not _found:
 
560
            # we are being called directly and must probe.
 
561
            raise NotImplementedError
 
562
        transport = a_bzrdir.get_branch_transport(self)
 
563
        control_files = LockableFiles(transport, 'branch-lock')
 
564
        return BzrBranch(_format=self,
 
565
                         _control_files=control_files,
 
566
                         a_bzrdir=a_bzrdir)
 
567
 
 
568
 
 
569
class BzrBranchFormat5(BranchFormat):
 
570
    """Bzr branch format 5.
 
571
 
 
572
    This format has:
 
573
     - a revision-history file.
 
574
     - a format string
 
575
     - a lock lock file.
 
576
    """
 
577
 
 
578
    def get_format_string(self):
 
579
        """See BranchFormat.get_format_string()."""
 
580
        return "Bazaar-NG branch format 5\n"
 
581
        
 
582
    def initialize(self, a_bzrdir):
 
583
        """Create a branch of this format in a_bzrdir."""
 
584
        mutter('creating branch in %s', a_bzrdir.transport.base)
 
585
        branch_transport = a_bzrdir.get_branch_transport(self)
 
586
 
 
587
        utf8_files = [('revision-history', ''),
 
588
                      ('branch-name', ''),
 
589
                      ]
 
590
        lock_file = 'lock'
 
591
        branch_transport.put(lock_file, StringIO()) # TODO get the file mode from the bzrdir lock files., mode=file_mode)
 
592
        control_files = LockableFiles(branch_transport, 'lock')
 
593
        control_files.lock_write()
 
594
        control_files.put_utf8('format', self.get_format_string())
 
595
        try:
 
596
            for file, content in utf8_files:
 
597
                control_files.put_utf8(file, content)
 
598
        finally:
 
599
            control_files.unlock()
 
600
        return self.open(a_bzrdir, _found=True, )
 
601
 
 
602
    def __init__(self):
 
603
        super(BzrBranchFormat5, self).__init__()
 
604
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
605
 
 
606
    def open(self, a_bzrdir, _found=False):
 
607
        """Return the branch object for a_bzrdir
 
608
 
 
609
        _found is a private parameter, do not use it. It is used to indicate
 
610
               if format probing has already be done.
 
611
        """
 
612
        if not _found:
 
613
            format = BranchFormat.find_format(a_bzrdir)
 
614
            assert format.__class__ == self.__class__
 
615
        transport = a_bzrdir.get_branch_transport(None)
 
616
        control_files = LockableFiles(transport, 'lock')
 
617
        return BzrBranch(_format=self,
 
618
                         _control_files=control_files,
 
619
                         a_bzrdir=a_bzrdir)
 
620
 
 
621
 
 
622
# formats which have no format string are not discoverable
 
623
# and not independently creatable, so are not registered.
 
624
__default_format = BzrBranchFormat5()
 
625
BranchFormat.register_format(__default_format)
 
626
BranchFormat.set_default_format(__default_format)
 
627
_legacy_formats = [BzrBranchFormat4(),
 
628
                   ]
 
629
 
 
630
class BzrBranch(Branch):
 
631
    """A branch stored in the actual filesystem.
 
632
 
 
633
    Note that it's "local" in the context of the filesystem; it doesn't
 
634
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
635
    it's writable, and can be accessed via the normal filesystem API.
 
636
 
 
637
    """
 
638
    # We actually expect this class to be somewhat short-lived; part of its
 
639
    # purpose is to try to isolate what bits of the branch logic are tied to
 
640
    # filesystem access, so that in a later step, we can extricate them to
 
641
    # a separarte ("storage") class.
 
642
    _inventory_weave = None
 
643
    
 
644
    # Map some sort of prefix into a namespace
 
645
    # stuff like "revno:10", "revid:", etc.
 
646
    # This should match a prefix with a function which accepts
 
647
    REVISION_NAMESPACES = {}
 
648
 
 
649
    def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
 
650
                 relax_version_check=DEPRECATED_PARAMETER, _format=None,
 
651
                 _control_files=None, a_bzrdir=None):
 
652
        """Create new branch object at a particular location.
 
653
 
 
654
        transport -- A Transport object, defining how to access files.
 
655
        
 
656
        init -- If True, create new control files in a previously
 
657
             unversioned directory.  If False, the branch must already
 
658
             be versioned.
 
659
 
 
660
        relax_version_check -- If true, the usual check for the branch
 
661
            version is not applied.  This is intended only for
 
662
            upgrade/recovery type use; it's not guaranteed that
 
663
            all operations will work on old format branches.
 
664
        """
 
665
        if a_bzrdir is None:
 
666
            self.bzrdir = bzrdir.BzrDir.open(transport.base)
 
667
        else:
 
668
            self.bzrdir = a_bzrdir
 
669
        self._transport = self.bzrdir.transport.clone('..')
 
670
        self._base = self._transport.base
 
671
        self._format = _format
 
672
        if _control_files is None:
 
673
            raise BzrBadParameterMissing('_control_files')
 
674
        self.control_files = _control_files
 
675
        if deprecated_passed(init):
 
676
            warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
 
677
                 "deprecated as of bzr 0.8. Please use Branch.create().",
 
678
                 DeprecationWarning,
 
679
                 stacklevel=2)
 
680
            if init:
 
681
                # this is slower than before deprecation, oh well never mind.
 
682
                # -> its deprecated.
 
683
                self._initialize(transport.base)
 
684
        self._check_format(_format)
 
685
        if deprecated_passed(relax_version_check):
 
686
            warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
 
687
                 "relax_version_check parameter is deprecated as of bzr 0.8. "
 
688
                 "Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
 
689
                 "open() method.",
 
690
                 DeprecationWarning,
 
691
                 stacklevel=2)
 
692
            if (not relax_version_check
 
693
                and not self._format.is_supported()):
 
694
                raise errors.UnsupportedFormatError(
 
695
                        'sorry, branch format %r not supported' % fmt,
 
696
                        ['use a different bzr version',
 
697
                         'or remove the .bzr directory'
 
698
                         ' and "bzr init" again'])
 
699
        if deprecated_passed(transport):
 
700
            warn("BzrBranch.__init__(transport=XXX...): The transport "
 
701
                 "parameter is deprecated as of bzr 0.8. "
 
702
                 "Please use Branch.open, or bzrdir.open_branch().",
 
703
                 DeprecationWarning,
 
704
                 stacklevel=2)
 
705
        self.repository = self.bzrdir.open_repository()
 
706
 
 
707
    def __str__(self):
 
708
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
709
 
 
710
    __repr__ = __str__
 
711
 
 
712
    def __del__(self):
 
713
        # TODO: It might be best to do this somewhere else,
 
714
        # but it is nice for a Branch object to automatically
 
715
        # cache it's information.
 
716
        # Alternatively, we could have the Transport objects cache requests
 
717
        # See the earlier discussion about how major objects (like Branch)
 
718
        # should never expect their __del__ function to run.
 
719
        # XXX: cache_root seems to be unused, 2006-01-13 mbp
 
720
        if hasattr(self, 'cache_root') and self.cache_root is not None:
 
721
            try:
 
722
                shutil.rmtree(self.cache_root)
 
723
            except:
 
724
                pass
 
725
            self.cache_root = None
 
726
 
 
727
    def _get_base(self):
 
728
        return self._base
 
729
 
 
730
    base = property(_get_base, doc="The URL for the root of this branch.")
 
731
 
 
732
    def _finish_transaction(self):
 
733
        """Exit the current transaction."""
 
734
        return self.control_files._finish_transaction()
 
735
 
 
736
    def get_transaction(self):
 
737
        """Return the current active transaction.
 
738
 
 
739
        If no transaction is active, this returns a passthrough object
 
740
        for which all data is immediately flushed and no caching happens.
 
741
        """
 
742
        # this is an explicit function so that we can do tricky stuff
 
743
        # when the storage in rev_storage is elsewhere.
 
744
        # we probably need to hook the two 'lock a location' and 
 
745
        # 'have a transaction' together more delicately, so that
 
746
        # we can have two locks (branch and storage) and one transaction
 
747
        # ... and finishing the transaction unlocks both, but unlocking
 
748
        # does not. - RBC 20051121
 
749
        return self.control_files.get_transaction()
 
750
 
 
751
    def _set_transaction(self, transaction):
 
752
        """Set a new active transaction."""
 
753
        return self.control_files._set_transaction(transaction)
 
754
 
 
755
    def abspath(self, name):
 
756
        """See Branch.abspath."""
 
757
        return self.control_files._transport.abspath(name)
 
758
 
 
759
    def _check_format(self, format):
 
760
        """Identify the branch format if needed.
 
761
 
 
762
        The format is stored as a reference to the format object in
 
763
        self._format for code that needs to check it later.
 
764
 
 
765
        The format parameter is either None or the branch format class
 
766
        used to open this branch.
 
767
 
 
768
        FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
 
769
        """
 
770
        if format is None:
 
771
            format = BzrBranchFormat.find_format(self.bzrdir)
 
772
        self._format = format
 
773
        mutter("got branch format %s", self._format)
 
774
 
 
775
    @needs_read_lock
 
776
    def get_root_id(self):
 
777
        """See Branch.get_root_id."""
 
778
        tree = self.repository.revision_tree(self.last_revision())
 
779
        return tree.inventory.root.file_id
 
780
 
 
781
    def lock_write(self):
 
782
        # TODO: test for failed two phase locks. This is known broken.
 
783
        self.control_files.lock_write()
 
784
        self.repository.lock_write()
 
785
 
 
786
    def lock_read(self):
 
787
        # TODO: test for failed two phase locks. This is known broken.
 
788
        self.control_files.lock_read()
 
789
        self.repository.lock_read()
 
790
 
 
791
    def unlock(self):
 
792
        # TODO: test for failed two phase locks. This is known broken.
 
793
        self.repository.unlock()
 
794
        self.control_files.unlock()
 
795
 
 
796
    def peek_lock_mode(self):
 
797
        if self.control_files._lock_count == 0:
 
798
            return None
 
799
        else:
 
800
            return self.control_files._lock_mode
 
801
 
 
802
    @needs_read_lock
 
803
    def print_file(self, file, revision_id):
 
804
        """See Branch.print_file."""
 
805
        return self.repository.print_file(file, revision_id)
 
806
 
 
807
    @needs_write_lock
 
808
    def append_revision(self, *revision_ids):
 
809
        """See Branch.append_revision."""
 
810
        for revision_id in revision_ids:
 
811
            mutter("add {%s} to revision-history" % revision_id)
 
812
        rev_history = self.revision_history()
 
813
        rev_history.extend(revision_ids)
 
814
        self.set_revision_history(rev_history)
 
815
 
 
816
    @needs_write_lock
 
817
    def set_revision_history(self, rev_history):
 
818
        """See Branch.set_revision_history."""
 
819
        self.control_files.put_utf8(
 
820
            'revision-history', '\n'.join(rev_history))
 
821
 
 
822
    def get_revision_delta(self, revno):
 
823
        """Return the delta for one revision.
 
824
 
 
825
        The delta is relative to its mainline predecessor, or the
 
826
        empty tree for revision 1.
 
827
        """
 
828
        assert isinstance(revno, int)
 
829
        rh = self.revision_history()
 
830
        if not (1 <= revno <= len(rh)):
 
831
            raise InvalidRevisionNumber(revno)
 
832
 
 
833
        # revno is 1-based; list is 0-based
 
834
 
 
835
        new_tree = self.repository.revision_tree(rh[revno-1])
 
836
        if revno == 1:
 
837
            old_tree = EmptyTree()
 
838
        else:
 
839
            old_tree = self.repository.revision_tree(rh[revno-2])
 
840
        return compare_trees(old_tree, new_tree)
 
841
 
 
842
    @needs_read_lock
 
843
    def revision_history(self):
 
844
        """See Branch.revision_history."""
 
845
        # FIXME are transactions bound to control files ? RBC 20051121
 
846
        transaction = self.get_transaction()
 
847
        history = transaction.map.find_revision_history()
 
848
        if history is not None:
 
849
            mutter("cache hit for revision-history in %s", self)
 
850
            return list(history)
 
851
        history = [l.rstrip('\r\n') for l in
 
852
                self.control_files.get_utf8('revision-history').readlines()]
 
853
        transaction.map.add_revision_history(history)
 
854
        # this call is disabled because revision_history is 
 
855
        # not really an object yet, and the transaction is for objects.
 
856
        # transaction.register_clean(history, precious=True)
 
857
        return list(history)
 
858
 
 
859
    def update_revisions(self, other, stop_revision=None):
 
860
        """See Branch.update_revisions."""
 
861
        from bzrlib.fetch import greedy_fetch
 
862
        if stop_revision is None:
 
863
            stop_revision = other.last_revision()
 
864
        ### Should this be checking is_ancestor instead of revision_history?
 
865
        if (stop_revision is not None and 
 
866
            stop_revision in self.revision_history()):
1247
867
            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()
 
868
        greedy_fetch(to_branch=self, from_branch=other,
 
869
                     revision=stop_revision)
 
870
        pullable_revs = self.pullable_revisions(other, stop_revision)
 
871
        if len(pullable_revs) > 0:
 
872
            self.append_revision(*pullable_revs)
 
873
 
 
874
    def pullable_revisions(self, other, stop_revision):
 
875
        """See Branch.pullable_revisions."""
 
876
        other_revno = other.revision_id_to_revno(stop_revision)
 
877
        try:
 
878
            return self.missing_revisions(other, other_revno)
 
879
        except DivergedBranches, e:
 
880
            try:
 
881
                pullable_revs = get_intervening_revisions(self.last_revision(),
 
882
                                                          stop_revision, 
 
883
                                                          self.repository)
 
884
                assert self.last_revision() not in pullable_revs
 
885
                return pullable_revs
 
886
            except bzrlib.errors.NotAncestor:
 
887
                if is_ancestor(self.last_revision(), stop_revision, self):
 
888
                    return []
 
889
                else:
 
890
                    raise e
 
891
        
 
892
    def basis_tree(self):
 
893
        """See Branch.basis_tree."""
 
894
        return self.repository.revision_tree(self.last_revision())
 
895
 
 
896
    @deprecated_method(zero_eight)
 
897
    def working_tree(self):
 
898
        """Create a Working tree object for this branch."""
 
899
        from bzrlib.workingtree import WorkingTree
 
900
        from bzrlib.transport.local import LocalTransport
 
901
        if (self.base.find('://') != -1 or 
 
902
            not isinstance(self._transport, LocalTransport)):
 
903
            raise NoWorkingTree(self.base)
 
904
        return WorkingTree(self.base, branch=self)
 
905
 
 
906
    @needs_write_lock
 
907
    def pull(self, source, overwrite=False):
 
908
        """See Branch.pull."""
 
909
        source.lock_read()
 
910
        try:
 
911
            old_count = len(self.revision_history())
 
912
            try:
 
913
                self.update_revisions(source)
 
914
            except DivergedBranches:
 
915
                if not overwrite:
 
916
                    raise
 
917
            if overwrite:
 
918
                self.set_revision_history(source.revision_history())
 
919
            new_count = len(self.revision_history())
 
920
            return new_count - old_count
1263
921
        finally:
1264
 
            self.unlock()
1265
 
 
1266
 
 
1267
 
 
1268
 
class ScratchBranch(Branch):
1269
 
    """Special test class: a branch that cleans up after itself.
1270
 
 
1271
 
    >>> b = ScratchBranch()
1272
 
    >>> isdir(b.base)
1273
 
    True
1274
 
    >>> bd = b.base
1275
 
    >>> b.destroy()
1276
 
    >>> isdir(bd)
1277
 
    False
 
922
            source.unlock()
 
923
 
 
924
    def get_parent(self):
 
925
        """See Branch.get_parent."""
 
926
        import errno
 
927
        _locs = ['parent', 'pull', 'x-pull']
 
928
        for l in _locs:
 
929
            try:
 
930
                return self.control_files.get_utf8(l).read().strip('\n')
 
931
            except NoSuchFile:
 
932
                pass
 
933
        return None
 
934
 
 
935
    def get_push_location(self):
 
936
        """See Branch.get_push_location."""
 
937
        config = bzrlib.config.BranchConfig(self)
 
938
        push_loc = config.get_user_option('push_location')
 
939
        return push_loc
 
940
 
 
941
    def set_push_location(self, location):
 
942
        """See Branch.set_push_location."""
 
943
        config = bzrlib.config.LocationConfig(self.base)
 
944
        config.set_user_option('push_location', location)
 
945
 
 
946
    @needs_write_lock
 
947
    def set_parent(self, url):
 
948
        """See Branch.set_parent."""
 
949
        # TODO: Maybe delete old location files?
 
950
        # URLs should never be unicode, even on the local fs,
 
951
        # FIXUP this and get_parent in a future branch format bump:
 
952
        # read and rewrite the file, and have the new format code read
 
953
        # using .get not .get_utf8. RBC 20060125
 
954
        self.control_files.put_utf8('parent', url + '\n')
 
955
 
 
956
    def tree_config(self):
 
957
        return TreeConfig(self)
 
958
 
 
959
    def _get_truncated_history(self, revision_id):
 
960
        history = self.revision_history()
 
961
        if revision_id is None:
 
962
            return history
 
963
        try:
 
964
            idx = history.index(revision_id)
 
965
        except ValueError:
 
966
            raise InvalidRevisionId(revision_id=revision, branch=self)
 
967
        return history[:idx+1]
 
968
 
 
969
    @needs_read_lock
 
970
    def _clone_weave(self, to_location, revision=None, basis_branch=None):
 
971
        # prevent leakage
 
972
        from bzrlib.workingtree import WorkingTree
 
973
        assert isinstance(to_location, basestring)
 
974
        if basis_branch is not None:
 
975
            note("basis_branch is not supported for fast weave copy yet.")
 
976
 
 
977
        history = self._get_truncated_history(revision)
 
978
        if not bzrlib.osutils.lexists(to_location):
 
979
            os.mkdir(to_location)
 
980
        bzrdir_to = self.bzrdir._format.initialize(to_location)
 
981
        self.repository.clone(bzrdir_to)
 
982
        branch_to = bzrdir_to.create_branch()
 
983
        mutter("copy branch from %s to %s", self, branch_to)
 
984
 
 
985
        # FIXME duplicate code with base .clone().
 
986
        # .. would template method be useful here?  RBC 20051207
 
987
        branch_to.set_parent(self.base)
 
988
        branch_to.append_revision(*history)
 
989
        WorkingTree.create(branch_to, branch_to.base)
 
990
        mutter("copied")
 
991
        return branch_to
 
992
 
 
993
    def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
 
994
        print "FIXME: clone via create and fetch is probably faster when versioned file comes in."
 
995
        if (to_branch_type is None
 
996
            and self.repository.weave_store.listable()
 
997
            and self.repository.revision_store.listable()):
 
998
            return self._clone_weave(to_location, revision, basis_branch)
 
999
        else:
 
1000
            return Branch.clone(self, to_location, revision, basis_branch, to_branch_type)
 
1001
 
 
1002
 
 
1003
class BranchTestProviderAdapter(object):
 
1004
    """A tool to generate a suite testing multiple branch formats at once.
 
1005
 
 
1006
    This is done by copying the test once for each transport and injecting
 
1007
    the transport_server, transport_readonly_server, and branch_format
 
1008
    classes into each copy. Each copy is also given a new id() to make it
 
1009
    easy to identify.
1278
1010
    """
1279
 
    def __init__(self, files=[], dirs=[], base=None):
1280
 
        """Make a test branch.
1281
 
 
1282
 
        This creates a temporary directory and runs init-tree in it.
1283
 
 
1284
 
        If any files are listed, they are created in the working copy.
1285
 
        """
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)
1292
 
        for d in dirs:
1293
 
            os.mkdir(self.abspath(d))
1294
 
            
1295
 
        for f in files:
1296
 
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1297
 
 
1298
 
 
1299
 
    def clone(self):
1300
 
        """
1301
 
        >>> orig = ScratchBranch(files=["file1", "file2"])
1302
 
        >>> clone = orig.clone()
1303
 
        >>> os.path.samefile(orig.base, clone.base)
1304
 
        False
1305
 
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1306
 
        True
1307
 
        """
1308
 
        from shutil import copytree
1309
 
        from tempfile import mkdtemp
1310
 
        base = mkdtemp()
1311
 
        os.rmdir(base)
1312
 
        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
 
 
 
1011
 
 
1012
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1013
        self._transport_server = transport_server
 
1014
        self._transport_readonly_server = transport_readonly_server
 
1015
        self._formats = formats
1335
1016
    
 
1017
    def adapt(self, test):
 
1018
        result = TestSuite()
 
1019
        for branch_format, bzrdir_format in self._formats:
 
1020
            new_test = deepcopy(test)
 
1021
            new_test.transport_server = self._transport_server
 
1022
            new_test.transport_readonly_server = self._transport_readonly_server
 
1023
            new_test.bzrdir_format = bzrdir_format
 
1024
            new_test.branch_format = branch_format
 
1025
            def make_new_test_id():
 
1026
                new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
 
1027
                return lambda: new_id
 
1028
            new_test.id = make_new_test_id()
 
1029
            result.addTest(new_test)
 
1030
        return result
 
1031
 
1336
1032
 
1337
1033
######################################################################
1338
1034
# predicates
1339
1035
 
1340
1036
 
1341
 
def is_control_file(filename):
1342
 
    ## FIXME: better check
1343
 
    filename = os.path.normpath(filename)
1344
 
    while filename != '':
1345
 
        head, tail = os.path.split(filename)
1346
 
        ## mutter('check %r for control file' % ((head, tail), ))
1347
 
        if tail == bzrlib.BZRDIR:
1348
 
            return True
1349
 
        if filename == head:
1350
 
            break
1351
 
        filename = head
1352
 
    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
 
 
 
1037
@deprecated_function(zero_eight)
 
1038
def ScratchBranch(*args, **kwargs):
 
1039
    """See bzrlib.bzrdir.ScratchDir."""
 
1040
    d = ScratchDir(*args, **kwargs)
 
1041
    return d.open_branch()
 
1042
 
 
1043
 
 
1044
@deprecated_function(zero_eight)
 
1045
def is_control_file(*args, **kwargs):
 
1046
    """See bzrlib.workingtree.is_control_file."""
 
1047
    return bzrlib.workingtree.is_control_file(*args, **kwargs)