~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Arbash Meinel
  • Date: 2005-09-15 21:35:53 UTC
  • mfrom: (907.1.57)
  • mto: (1393.2.1)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: john@arbash-meinel.com-20050915213552-a6c83a5ef1e20897
(broken) Transport work is merged in. Tests do not pass yet.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
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
 
from unittest import TestSuite
21
 
from warnings import warn
 
18
import sys
 
19
import os
22
20
 
23
21
import bzrlib
24
 
from bzrlib import bzrdir, errors, lockdir, osutils, revision, \
25
 
        tree, \
26
 
        ui, \
27
 
        urlutils
28
 
from bzrlib.config import TreeConfig
29
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
30
 
import bzrlib.errors as errors
31
 
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches, 
32
 
                           HistoryMissing, InvalidRevisionId, 
33
 
                           InvalidRevisionNumber, LockError, NoSuchFile, 
34
 
                           NoSuchRevision, NoWorkingTree, NotVersionedError,
35
 
                           NotBranchError, UninitializableFormat, 
36
 
                           UnlistableStore, UnlistableBranch, 
37
 
                           )
38
 
from bzrlib.lockable_files import LockableFiles, TransportLock
39
 
from bzrlib.symbol_versioning import (deprecated_function,
40
 
                                      deprecated_method,
41
 
                                      DEPRECATED_PARAMETER,
42
 
                                      deprecated_passed,
43
 
                                      zero_eight, zero_nine,
44
 
                                      )
45
22
from bzrlib.trace import mutter, note
46
 
 
47
 
 
48
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
49
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
50
 
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
51
 
 
52
 
 
53
 
# TODO: Maybe include checks for common corruption of newlines, etc?
 
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
 
24
     splitpath, \
 
25
     sha_file, appendpath, file_kind
 
26
 
 
27
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId, \
 
28
     DivergedBranches, NotBranchError
 
29
from bzrlib.textui import show_status
 
30
from bzrlib.revision import Revision
 
31
from bzrlib.delta import compare_trees
 
32
from bzrlib.tree import EmptyTree, RevisionTree
 
33
import bzrlib.xml
 
34
import bzrlib.ui
 
35
 
 
36
 
 
37
 
 
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
 
39
## TODO: Maybe include checks for common corruption of newlines, etc?
 
40
 
54
41
 
55
42
# TODO: Some operations like log might retrieve the same revisions
56
43
# repeatedly to calculate deltas.  We could perhaps have a weakref
57
 
# cache in memory to make this faster.  In general anything can be
58
 
# cached in memory between lock and unlock operations. .. nb thats
59
 
# what the transaction identity map provides
 
44
# cache in memory to make this faster.
 
45
 
 
46
# TODO: please move the revision-string syntax stuff out of the branch
 
47
# object; it's clutter
 
48
 
 
49
 
 
50
def find_branch(f, **args):
 
51
    from bzrlib.transport import transport
 
52
    from bzrlib.local_transport import LocalTransport
 
53
    t = transport(f)
 
54
    # FIXME: This is a hack around transport so that
 
55
    #        We can search the local directories for
 
56
    #        a branch root.
 
57
    if args.has_key('init') and args['init']:
 
58
        # Don't search if we are init-ing
 
59
        return Branch(t, **args)
 
60
    if isinstance(t, LocalTransport):
 
61
        root = find_branch_root(f)
 
62
        if root != f:
 
63
            t = transport(root)
 
64
    return Branch(t, **args)
 
65
 
 
66
def _relpath(base, path):
 
67
    """Return path relative to base, or raise exception.
 
68
 
 
69
    The path may be either an absolute path or a path relative to the
 
70
    current working directory.
 
71
 
 
72
    Lifted out of Branch.relpath for ease of testing.
 
73
 
 
74
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
75
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
76
    avoids that problem."""
 
77
    rp = os.path.abspath(path)
 
78
 
 
79
    s = []
 
80
    head = rp
 
81
    while len(head) >= len(base):
 
82
        if head == base:
 
83
            break
 
84
        head, tail = os.path.split(head)
 
85
        if tail:
 
86
            s.insert(0, tail)
 
87
    else:
 
88
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
 
89
 
 
90
    return os.sep.join(s)
 
91
        
 
92
 
 
93
def find_branch_root(f=None):
 
94
    """Find the branch root enclosing f, or pwd.
 
95
 
 
96
    f may be a filename or a URL.
 
97
 
 
98
    It is not necessary that f exists.
 
99
 
 
100
    Basically we keep looking up until we find the control directory or
 
101
    run into the root.  If there isn't one, raises NotBranchError.
 
102
    """
 
103
    if f == None:
 
104
        f = os.getcwd()
 
105
    else:
 
106
        f = os.path.realpath(f)
 
107
    if not os.path.exists(f):
 
108
        raise BzrError('%r does not exist' % f)
 
109
        
 
110
 
 
111
    orig_f = f
 
112
 
 
113
    while True:
 
114
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
 
115
            return f
 
116
        head, tail = os.path.split(f)
 
117
        if head == f:
 
118
            # reached the root, whatever that may be
 
119
            raise NotBranchError('%s is not in a branch' % orig_f)
 
120
        f = head
 
121
 
 
122
 
60
123
 
61
124
 
62
125
######################################################################
66
129
    """Branch holding a history of revisions.
67
130
 
68
131
    base
69
 
        Base directory/url of the branch.
 
132
        Base directory of the branch.
 
133
 
 
134
    _lock_mode
 
135
        None, or 'r' or 'w'
 
136
 
 
137
    _lock_count
 
138
        If _lock_mode is true, a positive count of the number of times the
 
139
        lock has been taken.
 
140
 
 
141
    _lock
 
142
        Lock object from bzrlib.lock.
70
143
    """
71
 
    # this is really an instance variable - FIXME move it there
72
 
    # - RBC 20060112
73
144
    base = None
74
 
 
75
 
    def __init__(self, *ignored, **ignored_too):
76
 
        raise NotImplementedError('The Branch class is abstract')
77
 
 
78
 
    def break_lock(self):
79
 
        """Break a lock if one is present from another instance.
80
 
 
81
 
        Uses the ui factory to ask for confirmation if the lock may be from
82
 
        an active process.
83
 
 
84
 
        This will probe the repository for its lock as well.
85
 
        """
86
 
        self.control_files.break_lock()
87
 
        self.repository.break_lock()
88
 
        master = self.get_master_branch()
89
 
        if master is not None:
90
 
            master.break_lock()
91
 
 
92
 
    @staticmethod
93
 
    @deprecated_method(zero_eight)
94
 
    def open_downlevel(base):
95
 
        """Open a branch which may be of an old format."""
96
 
        return Branch.open(base, _unsupported=True)
97
 
        
98
 
    @staticmethod
99
 
    def open(base, _unsupported=False):
100
 
        """Open the repository rooted at base.
101
 
 
102
 
        For instance, if the repository is at URL/.bzr/repository,
103
 
        Repository.open(URL) -> a Repository instance.
104
 
        """
105
 
        control = bzrdir.BzrDir.open(base, _unsupported)
106
 
        return control.open_branch(_unsupported)
107
 
 
108
 
    @staticmethod
109
 
    def open_containing(url):
110
 
        """Open an existing branch which contains url.
111
 
        
112
 
        This probes for a branch at url, and searches upwards from there.
113
 
 
114
 
        Basically we keep looking up until we find the control directory or
115
 
        run into the root.  If there isn't one, raises NotBranchError.
116
 
        If there is one and it is either an unrecognised format or an unsupported 
117
 
        format, UnknownFormatError or UnsupportedFormatError are raised.
118
 
        If there is one, it is returned, along with the unused portion of url.
119
 
        """
120
 
        control, relpath = bzrdir.BzrDir.open_containing(url)
121
 
        return control.open_branch(), relpath
122
 
 
123
 
    @staticmethod
124
 
    @deprecated_function(zero_eight)
125
 
    def initialize(base):
126
 
        """Create a new working tree and branch, rooted at 'base' (url)
127
 
 
128
 
        NOTE: This will soon be deprecated in favour of creation
129
 
        through a BzrDir.
130
 
        """
131
 
        return bzrdir.BzrDir.create_standalone_workingtree(base).branch
132
 
 
133
 
    def setup_caching(self, cache_root):
134
 
        """Subclasses that care about caching should override this, and set
135
 
        up cached stores located under cache_root.
136
 
        """
137
 
        # seems to be unused, 2006-01-13 mbp
138
 
        warn('%s is deprecated' % self.setup_caching)
139
 
        self.cache_root = cache_root
140
 
 
141
 
    def get_config(self):
142
 
        return bzrlib.config.BranchConfig(self)
143
 
 
144
 
    def _get_nick(self):
145
 
        return self.get_config().get_nickname()
146
 
 
147
 
    def _set_nick(self, nick):
148
 
        self.get_config().set_user_option('nickname', nick)
149
 
 
150
 
    nick = property(_get_nick, _set_nick)
151
 
 
152
 
    def is_locked(self):
153
 
        raise NotImplementedError('is_locked is abstract')
 
145
    _lock_mode = None
 
146
    _lock_count = None
 
147
    _lock = None
 
148
    cache_root = None
 
149
    
 
150
    # Map some sort of prefix into a namespace
 
151
    # stuff like "revno:10", "revid:", etc.
 
152
    # This should match a prefix with a function which accepts
 
153
    REVISION_NAMESPACES = {}
 
154
 
 
155
    def __init__(self, transport, init=False):
 
156
        """Create new branch object at a particular location.
 
157
 
 
158
        transport -- A Transport object, defining how to access files.
 
159
                (If a string, transport.transport() will be used to
 
160
                create a Transport object)
 
161
        
 
162
        init -- If True, create new control files in a previously
 
163
             unversioned directory.  If False, the branch must already
 
164
             be versioned.
 
165
 
 
166
        In the test suite, creation of new trees is tested using the
 
167
        `ScratchBranch` class.
 
168
        """
 
169
        if isinstance(transport, basestring):
 
170
            from transport import transport as get_transport
 
171
            transport = get_transport(transport)
 
172
 
 
173
        self._transport = transport
 
174
        if init:
 
175
            self._make_control()
 
176
        self._check_format()
 
177
 
 
178
 
 
179
    def __str__(self):
 
180
        return '%s(%r)' % (self.__class__.__name__, self._transport.base)
 
181
 
 
182
 
 
183
    __repr__ = __str__
 
184
 
 
185
 
 
186
    def __del__(self):
 
187
        if self._lock_mode or self._lock:
 
188
            from bzrlib.warnings import warn
 
189
            warn("branch %r was not explicitly unlocked" % self)
 
190
            self._lock.unlock()
 
191
 
 
192
        # TODO: It might be best to do this somewhere else,
 
193
        # but it is nice for a Branch object to automatically
 
194
        # cache it's information.
 
195
        # Alternatively, we could have the Transport objects cache requests
 
196
        # See the earlier discussion about how major objects (like Branch)
 
197
        # should never expect their __del__ function to run.
 
198
        if self.cache_root is not None:
 
199
            #from warnings import warn
 
200
            #warn("branch %r auto-cleanup of cache files" % self)
 
201
            try:
 
202
                import shutil
 
203
                shutil.rmtree(self.cache_root)
 
204
            except:
 
205
                pass
 
206
            self.cache_root = None
 
207
 
 
208
    def _get_base(self):
 
209
        if self._transport:
 
210
            return self._transport.base
 
211
        return None
 
212
 
 
213
    base = property(_get_base)
 
214
 
154
215
 
155
216
    def lock_write(self):
156
 
        raise NotImplementedError('lock_write is abstract')
 
217
        # TODO: Upgrade locking to support using a Transport,
 
218
        # and potentially a remote locking protocol
 
219
        if self._lock_mode:
 
220
            if self._lock_mode != 'w':
 
221
                from bzrlib.errors import LockError
 
222
                raise LockError("can't upgrade to a write lock from %r" %
 
223
                                self._lock_mode)
 
224
            self._lock_count += 1
 
225
        else:
 
226
            self._lock = self._transport.lock_write(
 
227
                    self._rel_controlfilename('branch-lock'))
 
228
            self._lock_mode = 'w'
 
229
            self._lock_count = 1
 
230
 
157
231
 
158
232
    def lock_read(self):
159
 
        raise NotImplementedError('lock_read is abstract')
160
 
 
 
233
        if self._lock_mode:
 
234
            assert self._lock_mode in ('r', 'w'), \
 
235
                   "invalid lock mode %r" % self._lock_mode
 
236
            self._lock_count += 1
 
237
        else:
 
238
            self._lock = self._transport.lock_read(
 
239
                    self._rel_controlfilename('branch-lock'))
 
240
            self._lock_mode = 'r'
 
241
            self._lock_count = 1
 
242
                        
161
243
    def unlock(self):
162
 
        raise NotImplementedError('unlock is abstract')
163
 
 
164
 
    def peek_lock_mode(self):
165
 
        """Return lock mode for the Branch: 'r', 'w' or None"""
166
 
        raise NotImplementedError(self.peek_lock_mode)
167
 
 
168
 
    def get_physical_lock_status(self):
169
 
        raise NotImplementedError('get_physical_lock_status is abstract')
 
244
        if not self._lock_mode:
 
245
            from bzrlib.errors import LockError
 
246
            raise LockError('branch %r is not locked' % (self))
 
247
 
 
248
        if self._lock_count > 1:
 
249
            self._lock_count -= 1
 
250
        else:
 
251
            self._lock.unlock()
 
252
            self._lock = None
 
253
            self._lock_mode = self._lock_count = None
170
254
 
171
255
    def abspath(self, name):
172
 
        """Return absolute filename for something in the branch
173
 
        
174
 
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
175
 
        method and not a tree method.
176
 
        """
177
 
        raise NotImplementedError('abspath is abstract')
178
 
 
179
 
    def bind(self, other):
180
 
        """Bind the local branch the other branch.
181
 
 
182
 
        :param other: The branch to bind to
183
 
        :type other: Branch
184
 
        """
185
 
        raise errors.UpgradeRequired(self.base)
186
 
 
187
 
    @needs_write_lock
188
 
    def fetch(self, from_branch, last_revision=None, pb=None):
189
 
        """Copy revisions from from_branch into this branch.
190
 
 
191
 
        :param from_branch: Where to copy from.
192
 
        :param last_revision: What revision to stop at (None for at the end
193
 
                              of the branch.
194
 
        :param pb: An optional progress bar to use.
195
 
 
196
 
        Returns the copied revision count and the failed revisions in a tuple:
197
 
        (copied, failures).
198
 
        """
199
 
        if self.base == from_branch.base:
200
 
            return (0, [])
201
 
        if pb is None:
202
 
            nested_pb = ui.ui_factory.nested_progress_bar()
203
 
            pb = nested_pb
 
256
        """Return absolute filename for something in the branch"""
 
257
        return self._transport.abspath(name)
 
258
 
 
259
    def relpath(self, path):
 
260
        """Return path relative to this branch of something inside it.
 
261
 
 
262
        Raises an error if path is not in this branch."""
 
263
        return self._transport.relpath(path)
 
264
 
 
265
 
 
266
    def _rel_controlfilename(self, file_or_path):
 
267
        if isinstance(file_or_path, basestring):
 
268
            file_or_path = [file_or_path]
 
269
        return [bzrlib.BZRDIR] + file_or_path
 
270
 
 
271
    def controlfilename(self, file_or_path):
 
272
        """Return location relative to branch."""
 
273
        return self._transport.abspath(self._rel_controlfilename(file_or_path))
 
274
 
 
275
 
 
276
    def controlfile(self, file_or_path, mode='r'):
 
277
        """Open a control file for this branch.
 
278
 
 
279
        There are two classes of file in the control directory: text
 
280
        and binary.  binary files are untranslated byte streams.  Text
 
281
        control files are stored with Unix newlines and in UTF-8, even
 
282
        if the platform or locale defaults are different.
 
283
 
 
284
        Controlfiles should almost never be opened in write mode but
 
285
        rather should be atomically copied and replaced using atomicfile.
 
286
        """
 
287
        import codecs
 
288
 
 
289
        relpath = self._rel_controlfilename(file_or_path)
 
290
        #TODO: codecs.open() buffers linewise, so it was overloaded with
 
291
        # a much larger buffer, do we need to do the same for getreader/getwriter?
 
292
        if mode == 'rb': 
 
293
            return self._transport.get(relpath)
 
294
        elif mode == 'wb':
 
295
            raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
 
296
        elif mode == 'r':
 
297
            return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
 
298
        elif mode == 'w':
 
299
            raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
204
300
        else:
205
 
            nested_pb = None
206
 
 
207
 
        from_branch.lock_read()
208
 
        try:
209
 
            if last_revision is None:
210
 
                pb.update('get source history')
211
 
                from_history = from_branch.revision_history()
212
 
                if from_history:
213
 
                    last_revision = from_history[-1]
 
301
            raise BzrError("invalid controlfile mode %r" % mode)
 
302
 
 
303
    def put_controlfile(self, path, f, encode=True):
 
304
        """Write an entry as a controlfile.
 
305
 
 
306
        :param path: The path to put the file, relative to the .bzr control
 
307
                     directory
 
308
        :param f: A file-like or string object whose contents should be copied.
 
309
        :param encode:  If true, encode the contents as utf-8
 
310
        """
 
311
        self.put_controlfiles([(path, f)], encode=encode)
 
312
 
 
313
    def put_controlfiles(self, files, encode=True):
 
314
        """Write several entries as controlfiles.
 
315
 
 
316
        :param files: A list of [(path, file)] pairs, where the path is the directory
 
317
                      underneath the bzr control directory
 
318
        :param encode:  If true, encode the contents as utf-8
 
319
        """
 
320
        import codecs
 
321
        ctrl_files = []
 
322
        for path, f in files:
 
323
            if encode:
 
324
                if isinstance(f, basestring):
 
325
                    f = f.encode('utf-8', 'replace')
214
326
                else:
215
 
                    # no history in the source branch
216
 
                    last_revision = revision.NULL_REVISION
217
 
            return self.repository.fetch(from_branch.repository,
218
 
                                         revision_id=last_revision,
219
 
                                         pb=nested_pb)
220
 
        finally:
221
 
            if nested_pb is not None:
222
 
                nested_pb.finished()
223
 
            from_branch.unlock()
224
 
 
225
 
    def get_bound_location(self):
226
 
        """Return the URL of the branch we are bound to.
227
 
 
228
 
        Older format branches cannot bind, please be sure to use a metadir
229
 
        branch.
230
 
        """
231
 
        return None
232
 
    
233
 
    def get_commit_builder(self, parents, config=None, timestamp=None, 
234
 
                           timezone=None, committer=None, revprops=None, 
235
 
                           revision_id=None):
236
 
        """Obtain a CommitBuilder for this branch.
237
 
        
238
 
        :param parents: Revision ids of the parents of the new revision.
239
 
        :param config: Optional configuration to use.
240
 
        :param timestamp: Optional timestamp recorded for commit.
241
 
        :param timezone: Optional timezone for timestamp.
242
 
        :param committer: Optional committer to set for commit.
243
 
        :param revprops: Optional dictionary of revision properties.
244
 
        :param revision_id: Optional revision id.
245
 
        """
246
 
 
247
 
        if config is None:
248
 
            config = self.get_config()
249
 
        
250
 
        return self.repository.get_commit_builder(self, parents, config, 
251
 
            timestamp, timezone, committer, revprops, revision_id)
252
 
 
253
 
    def get_master_branch(self):
254
 
        """Return the branch we are bound to.
255
 
        
256
 
        :return: Either a Branch, or None
257
 
        """
258
 
        return None
 
327
                    f = codecs.getwriter('utf-8')(f, errors='replace')
 
328
            path = self._rel_controlfilename(path)
 
329
            ctrl_files.append((path, f))
 
330
        self._transport.put_multi(ctrl_files)
 
331
 
 
332
    def _make_control(self):
 
333
        from bzrlib.inventory import Inventory
 
334
        from cStringIO import StringIO
 
335
        
 
336
        # Create an empty inventory
 
337
        sio = StringIO()
 
338
        # if we want per-tree root ids then this is the place to set
 
339
        # them; they're not needed for now and so ommitted for
 
340
        # simplicity.
 
341
        bzrlib.xml.serializer_v4.write_inventory(Inventory(), sio)
 
342
 
 
343
        dirs = [[], 'text-store', 'inventory-store', 'revision-store']
 
344
        files = [('README', 
 
345
            "This is a Bazaar-NG control directory.\n"
 
346
            "Do not change any files in this directory.\n"),
 
347
            ('branch-format', BZR_BRANCH_FORMAT),
 
348
            ('revision-history', ''),
 
349
            ('merged-patches', ''),
 
350
            ('pending-merged-patches', ''),
 
351
            ('branch-name', ''),
 
352
            ('branch-lock', ''),
 
353
            ('pending-merges', ''),
 
354
            ('inventory', sio.getvalue())
 
355
        ]
 
356
        self._transport.mkdir_multi([self._rel_controlfilename(d) for d in dirs])
 
357
        self.put_controlfiles(files)
 
358
        mutter('created control directory in ' + self._transport.base)
 
359
 
 
360
    def _check_format(self):
 
361
        """Check this branch format is supported.
 
362
 
 
363
        The current tool only supports the current unstable format.
 
364
 
 
365
        In the future, we might need different in-memory Branch
 
366
        classes to support downlevel branches.  But not yet.
 
367
        """
 
368
        # This ignores newlines so that we can open branches created
 
369
        # on Windows from Linux and so on.  I think it might be better
 
370
        # to always make all internal files in unix format.
 
371
        fmt = self.controlfile('branch-format', 'r').read()
 
372
        fmt = fmt.replace('\r\n', '\n')
 
373
        if fmt != BZR_BRANCH_FORMAT:
 
374
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
375
                           ['use a different bzr version',
 
376
                            'or remove the .bzr directory and "bzr init" again'])
 
377
 
 
378
        # We know that the format is the currently supported one.
 
379
        # So create the rest of the entries.
 
380
        from bzrlib.store.compressed_text import CompressedTextStore
 
381
 
 
382
        if self._transport.should_cache():
 
383
            import tempfile
 
384
            self.cache_root = tempfile.mkdtemp(prefix='bzr-cache')
 
385
            mutter('Branch %r using caching in %r' % (self, self.cache_root))
 
386
        else:
 
387
            self.cache_root = None
 
388
 
 
389
        def get_store(name):
 
390
            relpath = self._rel_controlfilename(name)
 
391
            store = CompressedTextStore(self._transport.clone(relpath))
 
392
            if self._transport.should_cache():
 
393
                from meta_store import CachedStore
 
394
                cache_path = os.path.join(self.cache_root, name)
 
395
                os.mkdir(cache_path)
 
396
                store = CachedStore(store, cache_path)
 
397
            return store
 
398
 
 
399
        self.text_store = get_store('text-store')
 
400
        self.revision_store = get_store('revision-store')
 
401
        self.inventory_store = get_store('inventory-store')
 
402
 
 
403
    def get_root_id(self):
 
404
        """Return the id of this branches root"""
 
405
        inv = self.read_working_inventory()
 
406
        return inv.root.file_id
 
407
 
 
408
    def set_root_id(self, file_id):
 
409
        inv = self.read_working_inventory()
 
410
        orig_root_id = inv.root.file_id
 
411
        del inv._byid[inv.root.file_id]
 
412
        inv.root.file_id = file_id
 
413
        inv._byid[inv.root.file_id] = inv.root
 
414
        for fid in inv:
 
415
            entry = inv[fid]
 
416
            if entry.parent_id in (None, orig_root_id):
 
417
                entry.parent_id = inv.root.file_id
 
418
        self._write_inventory(inv)
 
419
 
 
420
    def read_working_inventory(self):
 
421
        """Read the working inventory."""
 
422
        from bzrlib.inventory import Inventory
 
423
        self.lock_read()
 
424
        try:
 
425
            # ElementTree does its own conversion from UTF-8, so open in
 
426
            # binary.
 
427
            f = self.controlfile('inventory', 'rb')
 
428
            return bzrlib.xml.serializer_v4.read_inventory(f)
 
429
        finally:
 
430
            self.unlock()
 
431
            
 
432
 
 
433
    def _write_inventory(self, inv):
 
434
        """Update the working inventory.
 
435
 
 
436
        That is to say, the inventory describing changes underway, that
 
437
        will be committed to the next revision.
 
438
        """
 
439
        from cStringIO import StringIO
 
440
        self.lock_write()
 
441
        try:
 
442
            sio = StringIO()
 
443
            bzrlib.xml.serializer_v4.write_inventory(inv, sio)
 
444
            sio.seek(0)
 
445
            # Transport handles atomicity
 
446
            self.put_controlfile('inventory', sio)
 
447
        finally:
 
448
            self.unlock()
 
449
        
 
450
        mutter('wrote working inventory')
 
451
            
 
452
 
 
453
    inventory = property(read_working_inventory, _write_inventory, None,
 
454
                         """Inventory for the working copy.""")
 
455
 
 
456
 
 
457
    def add(self, files, ids=None):
 
458
        """Make files versioned.
 
459
 
 
460
        Note that the command line normally calls smart_add instead,
 
461
        which can automatically recurse.
 
462
 
 
463
        This puts the files in the Added state, so that they will be
 
464
        recorded by the next commit.
 
465
 
 
466
        files
 
467
            List of paths to add, relative to the base of the tree.
 
468
 
 
469
        ids
 
470
            If set, use these instead of automatically generated ids.
 
471
            Must be the same length as the list of files, but may
 
472
            contain None for ids that are to be autogenerated.
 
473
 
 
474
        TODO: Perhaps have an option to add the ids even if the files do
 
475
              not (yet) exist.
 
476
 
 
477
        TODO: Perhaps yield the ids and paths as they're added.
 
478
        """
 
479
        # TODO: Re-adding a file that is removed in the working copy
 
480
        # should probably put it back with the previous ID.
 
481
        if isinstance(files, basestring):
 
482
            assert(ids is None or isinstance(ids, basestring))
 
483
            files = [files]
 
484
            if ids is not None:
 
485
                ids = [ids]
 
486
 
 
487
        if ids is None:
 
488
            ids = [None] * len(files)
 
489
        else:
 
490
            assert(len(ids) == len(files))
 
491
 
 
492
        self.lock_write()
 
493
        try:
 
494
            inv = self.read_working_inventory()
 
495
            for f,file_id in zip(files, ids):
 
496
                if is_control_file(f):
 
497
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
498
 
 
499
                fp = splitpath(f)
 
500
 
 
501
                if len(fp) == 0:
 
502
                    raise BzrError("cannot add top-level %r" % f)
 
503
 
 
504
                fullpath = os.path.normpath(self.abspath(f))
 
505
 
 
506
                try:
 
507
                    kind = file_kind(fullpath)
 
508
                except OSError:
 
509
                    # maybe something better?
 
510
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
511
 
 
512
                if kind != 'file' and kind != 'directory':
 
513
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
514
 
 
515
                if file_id is None:
 
516
                    file_id = gen_file_id(f)
 
517
                inv.add_path(f, kind=kind, file_id=file_id)
 
518
 
 
519
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
520
 
 
521
            self._write_inventory(inv)
 
522
        finally:
 
523
            self.unlock()
 
524
            
 
525
 
 
526
    def print_file(self, file, revno):
 
527
        """Print `file` to stdout."""
 
528
        self.lock_read()
 
529
        try:
 
530
            tree = self.revision_tree(self.lookup_revision(revno))
 
531
            # use inventory as it was in that revision
 
532
            file_id = tree.inventory.path2id(file)
 
533
            if not file_id:
 
534
                raise BzrError("%r is not present in revision %s" % (file, revno))
 
535
            tree.print_file(file_id)
 
536
        finally:
 
537
            self.unlock()
 
538
 
 
539
 
 
540
    def remove(self, files, verbose=False):
 
541
        """Mark nominated files for removal from the inventory.
 
542
 
 
543
        This does not remove their text.  This does not run on 
 
544
 
 
545
        TODO: Refuse to remove modified files unless --force is given?
 
546
 
 
547
        TODO: Do something useful with directories.
 
548
 
 
549
        TODO: Should this remove the text or not?  Tough call; not
 
550
        removing may be useful and the user can just use use rm, and
 
551
        is the opposite of add.  Removing it is consistent with most
 
552
        other tools.  Maybe an option.
 
553
        """
 
554
        ## TODO: Normalize names
 
555
        ## TODO: Remove nested loops; better scalability
 
556
        if isinstance(files, basestring):
 
557
            files = [files]
 
558
 
 
559
        self.lock_write()
 
560
 
 
561
        try:
 
562
            tree = self.working_tree()
 
563
            inv = tree.inventory
 
564
 
 
565
            # do this before any modifications
 
566
            for f in files:
 
567
                fid = inv.path2id(f)
 
568
                if not fid:
 
569
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
 
570
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
571
                if verbose:
 
572
                    # having remove it, it must be either ignored or unknown
 
573
                    if tree.is_ignored(f):
 
574
                        new_status = 'I'
 
575
                    else:
 
576
                        new_status = '?'
 
577
                    show_status(new_status, inv[fid].kind, quotefn(f))
 
578
                del inv[fid]
 
579
 
 
580
            self._write_inventory(inv)
 
581
        finally:
 
582
            self.unlock()
 
583
 
 
584
 
 
585
    # FIXME: this doesn't need to be a branch method
 
586
    def set_inventory(self, new_inventory_list):
 
587
        from bzrlib.inventory import Inventory, InventoryEntry
 
588
        inv = Inventory(self.get_root_id())
 
589
        for path, file_id, parent, kind in new_inventory_list:
 
590
            name = os.path.basename(path)
 
591
            if name == "":
 
592
                continue
 
593
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
594
        self._write_inventory(inv)
 
595
 
 
596
 
 
597
    def unknowns(self):
 
598
        """Return all unknown files.
 
599
 
 
600
        These are files in the working directory that are not versioned or
 
601
        control files or ignored.
 
602
        
 
603
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
604
        >>> list(b.unknowns())
 
605
        ['foo']
 
606
        >>> b.add('foo')
 
607
        >>> list(b.unknowns())
 
608
        []
 
609
        >>> b.remove('foo')
 
610
        >>> list(b.unknowns())
 
611
        ['foo']
 
612
        """
 
613
        return self.working_tree().unknowns()
 
614
 
 
615
 
 
616
    def append_revision(self, *revision_ids):
 
617
        for revision_id in revision_ids:
 
618
            mutter("add {%s} to revision-history" % revision_id)
 
619
 
 
620
        rev_history = self.revision_history()
 
621
        rev_history.extend(revision_ids)
 
622
 
 
623
        self.lock_write()
 
624
        try:
 
625
            self.put_controlfile('revision-history', '\n'.join(rev_history))
 
626
        finally:
 
627
            self.unlock()
 
628
 
 
629
 
 
630
    def get_revision_xml_file(self, revision_id):
 
631
        """Return XML file object for revision object."""
 
632
        if not revision_id or not isinstance(revision_id, basestring):
 
633
            raise InvalidRevisionId(revision_id)
 
634
 
 
635
        self.lock_read()
 
636
        try:
 
637
            try:
 
638
                return self.revision_store[revision_id]
 
639
            except (IndexError, KeyError):
 
640
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
641
        finally:
 
642
            self.unlock()
 
643
 
 
644
 
 
645
    #deprecated
 
646
    get_revision_xml = get_revision_xml_file
 
647
 
 
648
 
 
649
    def get_revision(self, revision_id):
 
650
        """Return the Revision object for a named revision"""
 
651
        xml_file = self.get_revision_xml_file(revision_id)
 
652
 
 
653
        try:
 
654
            r = bzrlib.xml.serializer_v4.read_revision(xml_file)
 
655
        except SyntaxError, e:
 
656
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
 
657
                                         [revision_id,
 
658
                                          str(e)])
 
659
            
 
660
        assert r.revision_id == revision_id
 
661
        return r
 
662
 
259
663
 
260
664
    def get_revision_delta(self, revno):
261
665
        """Return the delta for one revision.
267
671
        rh = self.revision_history()
268
672
        if not (1 <= revno <= len(rh)):
269
673
            raise InvalidRevisionNumber(revno)
270
 
        return self.repository.get_revision_delta(rh[revno-1])
271
 
 
272
 
    def get_root_id(self):
273
 
        """Return the id of this branches root"""
274
 
        raise NotImplementedError('get_root_id is abstract')
275
 
 
276
 
    def print_file(self, file, revision_id):
277
 
        """Print `file` to stdout."""
278
 
        raise NotImplementedError('print_file is abstract')
279
 
 
280
 
    def append_revision(self, *revision_ids):
281
 
        raise NotImplementedError('append_revision is abstract')
282
 
 
283
 
    def set_revision_history(self, rev_history):
284
 
        raise NotImplementedError('set_revision_history is abstract')
 
674
 
 
675
        # revno is 1-based; list is 0-based
 
676
 
 
677
        new_tree = self.revision_tree(rh[revno-1])
 
678
        if revno == 1:
 
679
            old_tree = EmptyTree()
 
680
        else:
 
681
            old_tree = self.revision_tree(rh[revno-2])
 
682
 
 
683
        return compare_trees(old_tree, new_tree)
 
684
 
 
685
        
 
686
    def get_revisions(self, revision_ids, pb=None):
 
687
        """Return the Revision object for a set of named revisions"""
 
688
        from bzrlib.revision import Revision
 
689
        from bzrlib.xml import unpack_xml
 
690
 
 
691
        # TODO: We need to decide what to do here
 
692
        # we cannot use a generator with a try/finally, because
 
693
        # you cannot guarantee that the caller will iterate through
 
694
        # all entries.
 
695
        # in the past, get_inventory wasn't even wrapped in a
 
696
        # try/finally locking block.
 
697
        # We could either lock without the try/finally, or just
 
698
        # not lock at all. We are reading entries that should
 
699
        # never be updated.
 
700
        # I prefer locking with no finally, so that if someone
 
701
        # asks for a list of revisions, but doesn't consume them,
 
702
        # that is their problem, and they will suffer the consequences
 
703
        self.lock_read()
 
704
        for xml_file in self.revision_store.get(revision_ids, pb=pb):
 
705
            try:
 
706
                r = bzrlib.xml.serializer_v4.read_revision(xml_file)
 
707
            except SyntaxError, e:
 
708
                raise bzrlib.errors.BzrError('failed to unpack revision_xml',
 
709
                                             [revision_id,
 
710
                                              str(e)])
 
711
            yield r
 
712
        self.unlock()
 
713
            
 
714
    def get_revision_sha1(self, revision_id):
 
715
        """Hash the stored value of a revision, and return it."""
 
716
        # In the future, revision entries will be signed. At that
 
717
        # point, it is probably best *not* to include the signature
 
718
        # in the revision hash. Because that lets you re-sign
 
719
        # the revision, (add signatures/remove signatures) and still
 
720
        # have all hash pointers stay consistent.
 
721
        # But for now, just hash the contents.
 
722
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
 
723
 
 
724
 
 
725
    def get_inventory(self, inventory_id):
 
726
        """Get Inventory object by hash.
 
727
 
 
728
        TODO: Perhaps for this and similar methods, take a revision
 
729
               parameter which can be either an integer revno or a
 
730
               string hash.
 
731
        """
 
732
        f = self.get_inventory_xml_file(inventory_id)
 
733
        return bzrlib.xml.serializer_v4.read_inventory(f)
 
734
 
 
735
 
 
736
    def get_inventory_xml(self, inventory_id):
 
737
        """Get inventory XML as a file object."""
 
738
        # Shouldn't this have a read-lock around it?
 
739
        # As well as some sort of trap for missing ids?
 
740
        return self.inventory_store[inventory_id]
 
741
 
 
742
    get_inventory_xml_file = get_inventory_xml
 
743
            
 
744
    def get_inventories(self, inventory_ids, pb=None, ignore_missing=False):
 
745
        """Get Inventory objects by id
 
746
        """
 
747
        from bzrlib.inventory import Inventory
 
748
 
 
749
        # See the discussion in get_revisions for why
 
750
        # we don't use a try/finally block here
 
751
        self.lock_read()
 
752
        for f in self.inventory_store.get(inventory_ids, pb=pb, ignore_missing=ignore_missing):
 
753
            if f is not None:
 
754
                # TODO: Possibly put a try/except around this to handle
 
755
                # read serialization errors
 
756
                r = bzrlib.xml.serializer_v4.read_inventory(f)
 
757
                yield r
 
758
            elif ignore_missing:
 
759
                yield None
 
760
            else:
 
761
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
762
        self.unlock()
 
763
 
 
764
    def get_inventory_sha1(self, inventory_id):
 
765
        """Return the sha1 hash of the inventory entry
 
766
        """
 
767
        return sha_file(self.get_inventory_xml(inventory_id))
 
768
 
 
769
 
 
770
    def get_revision_inventory(self, revision_id):
 
771
        """Return inventory of a past revision."""
 
772
        # bzr 0.0.6 imposes the constraint that the inventory_id
 
773
        # must be the same as its revision, so this is trivial.
 
774
        if revision_id == None:
 
775
            from bzrlib.inventory import Inventory
 
776
            return Inventory(self.get_root_id())
 
777
        else:
 
778
            return self.get_inventory(revision_id)
 
779
 
285
780
 
286
781
    def revision_history(self):
287
 
        """Return sequence of revision hashes on to this branch."""
288
 
        raise NotImplementedError('revision_history is abstract')
 
782
        """Return sequence of revision hashes on to this branch.
 
783
 
 
784
        >>> ScratchBranch().revision_history()
 
785
        []
 
786
        """
 
787
        self.lock_read()
 
788
        try:
 
789
            return [l.rstrip('\r\n') for l in
 
790
                    self.controlfile('revision-history', 'r').readlines()]
 
791
        finally:
 
792
            self.unlock()
 
793
 
 
794
 
 
795
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
796
        """
 
797
        >>> from bzrlib.commit import commit
 
798
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
799
        >>> sb.common_ancestor(sb) == (None, None)
 
800
        True
 
801
        >>> commit(sb, "Committing first revision", verbose=False)
 
802
        >>> sb.common_ancestor(sb)[0]
 
803
        1
 
804
        >>> clone = sb.clone()
 
805
        >>> commit(sb, "Committing second revision", verbose=False)
 
806
        >>> sb.common_ancestor(sb)[0]
 
807
        2
 
808
        >>> sb.common_ancestor(clone)[0]
 
809
        1
 
810
        >>> commit(clone, "Committing divergent second revision", 
 
811
        ...               verbose=False)
 
812
        >>> sb.common_ancestor(clone)[0]
 
813
        1
 
814
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
815
        True
 
816
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
817
        True
 
818
        >>> clone2 = sb.clone()
 
819
        >>> sb.common_ancestor(clone2)[0]
 
820
        2
 
821
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
822
        1
 
823
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
824
        1
 
825
        """
 
826
        my_history = self.revision_history()
 
827
        other_history = other.revision_history()
 
828
        if self_revno is None:
 
829
            self_revno = len(my_history)
 
830
        if other_revno is None:
 
831
            other_revno = len(other_history)
 
832
        indices = range(min((self_revno, other_revno)))
 
833
        indices.reverse()
 
834
        for r in indices:
 
835
            if my_history[r] == other_history[r]:
 
836
                return r+1, my_history[r]
 
837
        return None, None
 
838
 
289
839
 
290
840
    def revno(self):
291
841
        """Return current revision number for this branch.
295
845
        """
296
846
        return len(self.revision_history())
297
847
 
298
 
    def unbind(self):
299
 
        """Older format branches cannot bind or unbind."""
300
 
        raise errors.UpgradeRequired(self.base)
301
848
 
302
 
    def last_revision(self):
303
 
        """Return last patch hash, or None if no history."""
 
849
    def last_patch(self):
 
850
        """Return last patch hash, or None if no history.
 
851
        """
304
852
        ph = self.revision_history()
305
853
        if ph:
306
854
            return ph[-1]
307
855
        else:
308
856
            return None
309
857
 
310
 
    def missing_revisions(self, other, stop_revision=None):
311
 
        """Return a list of new revisions that would perfectly fit.
312
 
        
 
858
 
 
859
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
 
860
        """
313
861
        If self and other have not diverged, return a list of the revisions
314
862
        present in other, but missing from self.
 
863
 
 
864
        >>> from bzrlib.commit import commit
 
865
        >>> bzrlib.trace.silent = True
 
866
        >>> br1 = ScratchBranch()
 
867
        >>> br2 = ScratchBranch()
 
868
        >>> br1.missing_revisions(br2)
 
869
        []
 
870
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
871
        >>> br1.missing_revisions(br2)
 
872
        [u'REVISION-ID-1']
 
873
        >>> br2.missing_revisions(br1)
 
874
        []
 
875
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
876
        >>> br1.missing_revisions(br2)
 
877
        []
 
878
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
879
        >>> br1.missing_revisions(br2)
 
880
        [u'REVISION-ID-2A']
 
881
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
882
        >>> br1.missing_revisions(br2)
 
883
        Traceback (most recent call last):
 
884
        DivergedBranches: These branches have diverged.
315
885
        """
316
886
        self_history = self.revision_history()
317
887
        self_len = len(self_history)
324
894
 
325
895
        if stop_revision is None:
326
896
            stop_revision = other_len
327
 
        else:
328
 
            assert isinstance(stop_revision, int)
329
 
            if stop_revision > other_len:
330
 
                raise errors.NoSuchRevision(self, stop_revision)
 
897
        elif stop_revision > other_len:
 
898
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
 
899
        
331
900
        return other_history[self_len:stop_revision]
332
901
 
 
902
 
333
903
    def update_revisions(self, other, stop_revision=None):
334
 
        """Pull in new perfect-fit revisions.
335
 
 
336
 
        :param other: Another Branch to pull from
337
 
        :param stop_revision: Updated until the given revision
338
 
        :return: None
 
904
        """Pull in all new revisions from other branch.
339
905
        """
340
 
        raise NotImplementedError('update_revisions is abstract')
 
906
        from bzrlib.fetch import greedy_fetch
 
907
        from bzrlib.revision import get_intervening_revisions
 
908
 
 
909
        pb = bzrlib.ui.ui_factory.progress_bar()
 
910
        pb.update('comparing histories')
 
911
        if stop_revision is None:
 
912
            other_revision = other.last_patch()
 
913
        else:
 
914
            other_revision = other.lookup_revision(stop_revision)
 
915
        count = greedy_fetch(self, other, other_revision, pb)[0]
 
916
        try:
 
917
            revision_ids = self.missing_revisions(other, stop_revision)
 
918
        except DivergedBranches, e:
 
919
            try:
 
920
                revision_ids = get_intervening_revisions(self.last_patch(), 
 
921
                                                         other_revision, self)
 
922
                assert self.last_patch() not in revision_ids
 
923
            except bzrlib.errors.NotAncestor:
 
924
                raise e
 
925
 
 
926
        self.append_revision(*revision_ids)
 
927
        pb.clear()
 
928
 
 
929
    def install_revisions(self, other, revision_ids, pb):
 
930
        # We are going to iterate this many times, so make sure
 
931
        # that it is a list, and not a generator
 
932
        revision_ids = list(revision_ids)
 
933
        if hasattr(other.revision_store, "prefetch"):
 
934
            other.revision_store.prefetch(revision_ids)
 
935
        if hasattr(other.inventory_store, "prefetch"):
 
936
            other.inventory_store.prefetch(inventory_ids)
 
937
 
 
938
        if pb is None:
 
939
            pb = bzrlib.ui.ui_factory.progress_bar()
 
940
                
 
941
        # This entire next section is generally done
 
942
        # with either generators, or bulk updates
 
943
        inventories = other.get_inventories(revision_ids, ignore_missing=True)
 
944
        needed_texts = set()
 
945
 
 
946
        failures = set()
 
947
        good_revisions = set()
 
948
        for i, (inv, rev_id) in enumerate(zip(inventories, revision_ids)):
 
949
            pb.update('fetching revision', i+1, len(revision_ids))
 
950
 
 
951
            # We don't really need to get the revision here, because
 
952
            # the only thing we needed was the inventory_id, which now
 
953
            # is (by design) identical to the revision_id
 
954
            # try:
 
955
            #     rev = other.get_revision(rev_id)
 
956
            # except bzrlib.errors.NoSuchRevision:
 
957
            #     failures.add(rev_id)
 
958
            #     continue
 
959
 
 
960
            if inv is None:
 
961
                failures.add(rev_id)
 
962
                continue
 
963
            else:
 
964
                good_revisions.add(rev_id)
 
965
 
 
966
            text_ids = []
 
967
            for key, entry in inv.iter_entries():
 
968
                if entry.text_id is None:
 
969
                    continue
 
970
                text_ids.append(entry.text_id)
 
971
 
 
972
            has_ids = self.text_store.has(text_ids)
 
973
            for has, text_id in zip(has_ids, text_ids):
 
974
                if not has:
 
975
                    needed_texts.add(text_id)
 
976
 
 
977
        pb.clear()
 
978
                    
 
979
        count, cp_fail = self.text_store.copy_multi(other.text_store, 
 
980
                                                    needed_texts)
 
981
        #print "Added %d texts." % count 
 
982
        count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
 
983
                                                         good_revisions)
 
984
        #print "Added %d inventories." % count 
 
985
        count, cp_fail = self.revision_store.copy_multi(other.revision_store, 
 
986
                                                          good_revisions,
 
987
                                                          permit_failure=True)
 
988
        assert len(cp_fail) == 0 
 
989
        return count, failures
 
990
       
 
991
 
 
992
    def commit(self, *args, **kw):
 
993
        from bzrlib.commit import commit
 
994
        commit(self, *args, **kw)
 
995
        
 
996
 
 
997
    def lookup_revision(self, revision):
 
998
        """Return the revision identifier for a given revision information."""
 
999
        revno, info = self._get_revision_info(revision)
 
1000
        return info
 
1001
 
341
1002
 
342
1003
    def revision_id_to_revno(self, revision_id):
343
1004
        """Given a revision id, return its revno"""
344
 
        if revision_id is None:
345
 
            return 0
346
1005
        history = self.revision_history()
347
1006
        try:
348
1007
            return history.index(revision_id) + 1
349
1008
        except ValueError:
350
1009
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
351
1010
 
 
1011
 
 
1012
    def get_revision_info(self, revision):
 
1013
        """Return (revno, revision id) for revision identifier.
 
1014
 
 
1015
        revision can be an integer, in which case it is assumed to be revno (though
 
1016
            this will translate negative values into positive ones)
 
1017
        revision can also be a string, in which case it is parsed for something like
 
1018
            'date:' or 'revid:' etc.
 
1019
        """
 
1020
        revno, rev_id = self._get_revision_info(revision)
 
1021
        if revno is None:
 
1022
            raise bzrlib.errors.NoSuchRevision(self, revision)
 
1023
        return revno, rev_id
 
1024
 
352
1025
    def get_rev_id(self, revno, history=None):
353
1026
        """Find the revision id of the specified revno."""
354
1027
        if revno == 0:
359
1032
            raise bzrlib.errors.NoSuchRevision(self, revno)
360
1033
        return history[revno - 1]
361
1034
 
362
 
    def pull(self, source, overwrite=False, stop_revision=None):
363
 
        raise NotImplementedError('pull is abstract')
 
1035
    def _get_revision_info(self, revision):
 
1036
        """Return (revno, revision id) for revision specifier.
 
1037
 
 
1038
        revision can be an integer, in which case it is assumed to be revno
 
1039
        (though this will translate negative values into positive ones)
 
1040
        revision can also be a string, in which case it is parsed for something
 
1041
        like 'date:' or 'revid:' etc.
 
1042
 
 
1043
        A revid is always returned.  If it is None, the specifier referred to
 
1044
        the null revision.  If the revid does not occur in the revision
 
1045
        history, revno will be None.
 
1046
        """
 
1047
        
 
1048
        if revision is None:
 
1049
            return 0, None
 
1050
        revno = None
 
1051
        try:# Convert to int if possible
 
1052
            revision = int(revision)
 
1053
        except ValueError:
 
1054
            pass
 
1055
        revs = self.revision_history()
 
1056
        if isinstance(revision, int):
 
1057
            if revision < 0:
 
1058
                revno = len(revs) + revision + 1
 
1059
            else:
 
1060
                revno = revision
 
1061
            rev_id = self.get_rev_id(revno, revs)
 
1062
        elif isinstance(revision, basestring):
 
1063
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
 
1064
                if revision.startswith(prefix):
 
1065
                    result = func(self, revs, revision)
 
1066
                    if len(result) > 1:
 
1067
                        revno, rev_id = result
 
1068
                    else:
 
1069
                        revno = result[0]
 
1070
                        rev_id = self.get_rev_id(revno, revs)
 
1071
                    break
 
1072
            else:
 
1073
                raise BzrError('No namespace registered for string: %r' %
 
1074
                               revision)
 
1075
        else:
 
1076
            raise TypeError('Unhandled revision type %s' % revision)
 
1077
 
 
1078
        if revno is None:
 
1079
            if rev_id is None:
 
1080
                raise bzrlib.errors.NoSuchRevision(self, revision)
 
1081
        return revno, rev_id
 
1082
 
 
1083
    def _namespace_revno(self, revs, revision):
 
1084
        """Lookup a revision by revision number"""
 
1085
        assert revision.startswith('revno:')
 
1086
        try:
 
1087
            return (int(revision[6:]),)
 
1088
        except ValueError:
 
1089
            return None
 
1090
    REVISION_NAMESPACES['revno:'] = _namespace_revno
 
1091
 
 
1092
    def _namespace_revid(self, revs, revision):
 
1093
        assert revision.startswith('revid:')
 
1094
        rev_id = revision[len('revid:'):]
 
1095
        try:
 
1096
            return revs.index(rev_id) + 1, rev_id
 
1097
        except ValueError:
 
1098
            return None, rev_id
 
1099
    REVISION_NAMESPACES['revid:'] = _namespace_revid
 
1100
 
 
1101
    def _namespace_last(self, revs, revision):
 
1102
        assert revision.startswith('last:')
 
1103
        try:
 
1104
            offset = int(revision[5:])
 
1105
        except ValueError:
 
1106
            return (None,)
 
1107
        else:
 
1108
            if offset <= 0:
 
1109
                raise BzrError('You must supply a positive value for --revision last:XXX')
 
1110
            return (len(revs) - offset + 1,)
 
1111
    REVISION_NAMESPACES['last:'] = _namespace_last
 
1112
 
 
1113
    def _namespace_tag(self, revs, revision):
 
1114
        assert revision.startswith('tag:')
 
1115
        raise BzrError('tag: namespace registered, but not implemented.')
 
1116
    REVISION_NAMESPACES['tag:'] = _namespace_tag
 
1117
 
 
1118
    def _namespace_date(self, revs, revision):
 
1119
        assert revision.startswith('date:')
 
1120
        import datetime
 
1121
        # Spec for date revisions:
 
1122
        #   date:value
 
1123
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
 
1124
        #   it can also start with a '+/-/='. '+' says match the first
 
1125
        #   entry after the given date. '-' is match the first entry before the date
 
1126
        #   '=' is match the first entry after, but still on the given date.
 
1127
        #
 
1128
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
 
1129
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
 
1130
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
 
1131
        #       May 13th, 2005 at 0:00
 
1132
        #
 
1133
        #   So the proper way of saying 'give me all entries for today' is:
 
1134
        #       -r {date:+today}:{date:-tomorrow}
 
1135
        #   The default is '=' when not supplied
 
1136
        val = revision[5:]
 
1137
        match_style = '='
 
1138
        if val[:1] in ('+', '-', '='):
 
1139
            match_style = val[:1]
 
1140
            val = val[1:]
 
1141
 
 
1142
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
 
1143
        if val.lower() == 'yesterday':
 
1144
            dt = today - datetime.timedelta(days=1)
 
1145
        elif val.lower() == 'today':
 
1146
            dt = today
 
1147
        elif val.lower() == 'tomorrow':
 
1148
            dt = today + datetime.timedelta(days=1)
 
1149
        else:
 
1150
            import re
 
1151
            # This should be done outside the function to avoid recompiling it.
 
1152
            _date_re = re.compile(
 
1153
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
 
1154
                    r'(,|T)?\s*'
 
1155
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
 
1156
                )
 
1157
            m = _date_re.match(val)
 
1158
            if not m or (not m.group('date') and not m.group('time')):
 
1159
                raise BzrError('Invalid revision date %r' % revision)
 
1160
 
 
1161
            if m.group('date'):
 
1162
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
 
1163
            else:
 
1164
                year, month, day = today.year, today.month, today.day
 
1165
            if m.group('time'):
 
1166
                hour = int(m.group('hour'))
 
1167
                minute = int(m.group('minute'))
 
1168
                if m.group('second'):
 
1169
                    second = int(m.group('second'))
 
1170
                else:
 
1171
                    second = 0
 
1172
            else:
 
1173
                hour, minute, second = 0,0,0
 
1174
 
 
1175
            dt = datetime.datetime(year=year, month=month, day=day,
 
1176
                    hour=hour, minute=minute, second=second)
 
1177
        first = dt
 
1178
        last = None
 
1179
        reversed = False
 
1180
        if match_style == '-':
 
1181
            reversed = True
 
1182
        elif match_style == '=':
 
1183
            last = dt + datetime.timedelta(days=1)
 
1184
 
 
1185
        if reversed:
 
1186
            for i in range(len(revs)-1, -1, -1):
 
1187
                r = self.get_revision(revs[i])
 
1188
                # TODO: Handle timezone.
 
1189
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1190
                if first >= dt and (last is None or dt >= last):
 
1191
                    return (i+1,)
 
1192
        else:
 
1193
            for i in range(len(revs)):
 
1194
                r = self.get_revision(revs[i])
 
1195
                # TODO: Handle timezone.
 
1196
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1197
                if first <= dt and (last is None or dt <= last):
 
1198
                    return (i+1,)
 
1199
    REVISION_NAMESPACES['date:'] = _namespace_date
 
1200
 
 
1201
 
 
1202
    def _namespace_ancestor(self, revs, revision):
 
1203
        from revision import common_ancestor, MultipleRevisionSources
 
1204
        other_branch = find_branch(_trim_namespace('ancestor', revision))
 
1205
        revision_a = self.last_patch()
 
1206
        revision_b = other_branch.last_patch()
 
1207
        for r, b in ((revision_a, self), (revision_b, other_branch)):
 
1208
            if r is None:
 
1209
                raise bzrlib.errors.NoCommits(b)
 
1210
        revision_source = MultipleRevisionSources(self, other_branch)
 
1211
        result = common_ancestor(revision_a, revision_b, revision_source)
 
1212
        try:
 
1213
            revno = self.revision_id_to_revno(result)
 
1214
        except bzrlib.errors.NoSuchRevision:
 
1215
            revno = None
 
1216
        return revno,result
 
1217
        
 
1218
 
 
1219
    REVISION_NAMESPACES['ancestor:'] = _namespace_ancestor
 
1220
 
 
1221
    def revision_tree(self, revision_id):
 
1222
        """Return Tree for a revision on this branch.
 
1223
 
 
1224
        `revision_id` may be None for the null revision, in which case
 
1225
        an `EmptyTree` is returned."""
 
1226
        # TODO: refactor this to use an existing revision object
 
1227
        # so we don't need to read it in twice.
 
1228
        if revision_id == None:
 
1229
            return EmptyTree()
 
1230
        else:
 
1231
            inv = self.get_revision_inventory(revision_id)
 
1232
            return RevisionTree(self.text_store, inv)
 
1233
 
 
1234
 
 
1235
    def working_tree(self):
 
1236
        """Return a `Tree` for the working copy."""
 
1237
        from bzrlib.workingtree import WorkingTree
 
1238
        # TODO: In the future, WorkingTree should utilize Transport
 
1239
        return WorkingTree(self._transport.base, self.read_working_inventory())
 
1240
 
364
1241
 
365
1242
    def basis_tree(self):
366
1243
        """Return `Tree` object for last revision.
367
1244
 
368
1245
        If there are no revisions yet, return an `EmptyTree`.
369
1246
        """
370
 
        return self.repository.revision_tree(self.last_revision())
 
1247
        r = self.last_patch()
 
1248
        if r == None:
 
1249
            return EmptyTree()
 
1250
        else:
 
1251
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
1252
 
 
1253
 
371
1254
 
372
1255
    def rename_one(self, from_rel, to_rel):
373
1256
        """Rename one file.
374
1257
 
375
1258
        This can change the directory or the filename or both.
376
1259
        """
377
 
        raise NotImplementedError('rename_one is abstract')
 
1260
        self.lock_write()
 
1261
        try:
 
1262
            tree = self.working_tree()
 
1263
            inv = tree.inventory
 
1264
            if not tree.has_filename(from_rel):
 
1265
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
1266
            if tree.has_filename(to_rel):
 
1267
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
1268
 
 
1269
            file_id = inv.path2id(from_rel)
 
1270
            if file_id == None:
 
1271
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
1272
 
 
1273
            if inv.path2id(to_rel):
 
1274
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
1275
 
 
1276
            to_dir, to_tail = os.path.split(to_rel)
 
1277
            to_dir_id = inv.path2id(to_dir)
 
1278
            if to_dir_id == None and to_dir != '':
 
1279
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
1280
 
 
1281
            mutter("rename_one:")
 
1282
            mutter("  file_id    {%s}" % file_id)
 
1283
            mutter("  from_rel   %r" % from_rel)
 
1284
            mutter("  to_rel     %r" % to_rel)
 
1285
            mutter("  to_dir     %r" % to_dir)
 
1286
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
1287
 
 
1288
            inv.rename(file_id, to_dir_id, to_tail)
 
1289
 
 
1290
            from_abs = self.abspath(from_rel)
 
1291
            to_abs = self.abspath(to_rel)
 
1292
            try:
 
1293
                os.rename(from_abs, to_abs)
 
1294
            except OSError, e:
 
1295
                raise BzrError("failed to rename %r to %r: %s"
 
1296
                        % (from_abs, to_abs, e[1]),
 
1297
                        ["rename rolled back"])
 
1298
 
 
1299
            self._write_inventory(inv)
 
1300
        finally:
 
1301
            self.unlock()
 
1302
 
378
1303
 
379
1304
    def move(self, from_paths, to_name):
380
1305
        """Rename files.
390
1315
        This returns a list of (from_path, to_path) pairs for each
391
1316
        entry that is moved.
392
1317
        """
393
 
        raise NotImplementedError('move is abstract')
 
1318
        result = []
 
1319
        self.lock_write()
 
1320
        try:
 
1321
            ## TODO: Option to move IDs only
 
1322
            assert not isinstance(from_paths, basestring)
 
1323
            tree = self.working_tree()
 
1324
            inv = tree.inventory
 
1325
            to_abs = self.abspath(to_name)
 
1326
            if not isdir(to_abs):
 
1327
                raise BzrError("destination %r is not a directory" % to_abs)
 
1328
            if not tree.has_filename(to_name):
 
1329
                raise BzrError("destination %r not in working directory" % to_abs)
 
1330
            to_dir_id = inv.path2id(to_name)
 
1331
            if to_dir_id == None and to_name != '':
 
1332
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
1333
            to_dir_ie = inv[to_dir_id]
 
1334
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1335
                raise BzrError("destination %r is not a directory" % to_abs)
 
1336
 
 
1337
            to_idpath = inv.get_idpath(to_dir_id)
 
1338
 
 
1339
            for f in from_paths:
 
1340
                if not tree.has_filename(f):
 
1341
                    raise BzrError("%r does not exist in working tree" % f)
 
1342
                f_id = inv.path2id(f)
 
1343
                if f_id == None:
 
1344
                    raise BzrError("%r is not versioned" % f)
 
1345
                name_tail = splitpath(f)[-1]
 
1346
                dest_path = appendpath(to_name, name_tail)
 
1347
                if tree.has_filename(dest_path):
 
1348
                    raise BzrError("destination %r already exists" % dest_path)
 
1349
                if f_id in to_idpath:
 
1350
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1351
 
 
1352
            # OK, so there's a race here, it's possible that someone will
 
1353
            # create a file in this interval and then the rename might be
 
1354
            # left half-done.  But we should have caught most problems.
 
1355
 
 
1356
            for f in from_paths:
 
1357
                name_tail = splitpath(f)[-1]
 
1358
                dest_path = appendpath(to_name, name_tail)
 
1359
                result.append((f, dest_path))
 
1360
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1361
                try:
 
1362
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
1363
                except OSError, e:
 
1364
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1365
                            ["rename rolled back"])
 
1366
 
 
1367
            self._write_inventory(inv)
 
1368
        finally:
 
1369
            self.unlock()
 
1370
 
 
1371
        return result
 
1372
 
 
1373
 
 
1374
    def revert(self, filenames, old_tree=None, backups=True):
 
1375
        """Restore selected files to the versions from a previous tree.
 
1376
 
 
1377
        backups
 
1378
            If true (default) backups are made of files before
 
1379
            they're renamed.
 
1380
        """
 
1381
        from bzrlib.errors import NotVersionedError, BzrError
 
1382
        from bzrlib.atomicfile import AtomicFile
 
1383
        from bzrlib.osutils import backup_file
 
1384
        
 
1385
        inv = self.read_working_inventory()
 
1386
        if old_tree is None:
 
1387
            old_tree = self.basis_tree()
 
1388
        old_inv = old_tree.inventory
 
1389
 
 
1390
        nids = []
 
1391
        for fn in filenames:
 
1392
            file_id = inv.path2id(fn)
 
1393
            if not file_id:
 
1394
                raise NotVersionedError("not a versioned file", fn)
 
1395
            if not old_inv.has_id(file_id):
 
1396
                raise BzrError("file not present in old tree", fn, file_id)
 
1397
            nids.append((fn, file_id))
 
1398
            
 
1399
        # TODO: Rename back if it was previously at a different location
 
1400
 
 
1401
        # TODO: If given a directory, restore the entire contents from
 
1402
        # the previous version.
 
1403
 
 
1404
        # TODO: Make a backup to a temporary file.
 
1405
 
 
1406
        # TODO: If the file previously didn't exist, delete it?
 
1407
        for fn, file_id in nids:
 
1408
            backup_file(fn)
 
1409
            
 
1410
            f = AtomicFile(fn, 'wb')
 
1411
            try:
 
1412
                f.write(old_tree.get_file(file_id).read())
 
1413
                f.commit()
 
1414
            finally:
 
1415
                f.close()
 
1416
 
 
1417
 
 
1418
    def pending_merges(self):
 
1419
        """Return a list of pending merges.
 
1420
 
 
1421
        These are revisions that have been merged into the working
 
1422
        directory but not yet committed.
 
1423
        """
 
1424
        cfn = self._rel_controlfilename('pending-merges')
 
1425
        if not self._transport.has(cfn):
 
1426
            return []
 
1427
        p = []
 
1428
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1429
            p.append(l.rstrip('\n'))
 
1430
        return p
 
1431
 
 
1432
 
 
1433
    def add_pending_merge(self, *revision_ids):
 
1434
        from bzrlib.revision import validate_revision_id
 
1435
 
 
1436
        for rev_id in revision_ids:
 
1437
            validate_revision_id(rev_id)
 
1438
 
 
1439
        p = self.pending_merges()
 
1440
        updated = False
 
1441
        for rev_id in revision_ids:
 
1442
            if rev_id in p:
 
1443
                continue
 
1444
            p.append(rev_id)
 
1445
            updated = True
 
1446
        if updated:
 
1447
            self.set_pending_merges(p)
 
1448
 
 
1449
    def set_pending_merges(self, rev_list):
 
1450
        self.lock_write()
 
1451
        try:
 
1452
            self.put_controlfile('pending-merges', '\n'.join(rev_list))
 
1453
        finally:
 
1454
            self.unlock()
 
1455
 
394
1456
 
395
1457
    def get_parent(self):
396
1458
        """Return the parent location of the branch.
399
1461
        pattern is that the user can override it by specifying a
400
1462
        location.
401
1463
        """
402
 
        raise NotImplementedError('get_parent is abstract')
403
 
 
404
 
    def get_submit_branch(self):
405
 
        """Return the submit location of the branch.
406
 
 
407
 
        This is the default location for bundle.  The usual
408
 
        pattern is that the user can override it by specifying a
409
 
        location.
410
 
        """
411
 
        return self.get_config().get_user_option('submit_branch')
412
 
 
413
 
    def set_submit_branch(self, location):
414
 
        """Return the submit location of the branch.
415
 
 
416
 
        This is the default location for bundle.  The usual
417
 
        pattern is that the user can override it by specifying a
418
 
        location.
419
 
        """
420
 
        self.get_config().set_user_option('submit_branch', location)
421
 
 
422
 
    def get_push_location(self):
423
 
        """Return the None or the location to push this branch to."""
424
 
        raise NotImplementedError('get_push_location is abstract')
425
 
 
426
 
    def set_push_location(self, location):
427
 
        """Set a new push location for this branch."""
428
 
        raise NotImplementedError('set_push_location is abstract')
 
1464
        import errno
 
1465
        _locs = ['parent', 'pull', 'x-pull']
 
1466
        for l in _locs:
 
1467
            try:
 
1468
                return self.controlfile(l, 'r').read().strip('\n')
 
1469
            except IOError, e:
 
1470
                if e.errno != errno.ENOENT:
 
1471
                    raise
 
1472
        return None
 
1473
 
429
1474
 
430
1475
    def set_parent(self, url):
431
 
        raise NotImplementedError('set_parent is abstract')
432
 
 
433
 
    @needs_write_lock
434
 
    def update(self):
435
 
        """Synchronise this branch with the master branch if any. 
436
 
 
437
 
        :return: None or the last_revision pivoted out during the update.
438
 
        """
439
 
        return None
 
1476
        # TODO: Maybe delete old location files?
 
1477
        from bzrlib.atomicfile import AtomicFile
 
1478
        self.lock_write()
 
1479
        try:
 
1480
            f = AtomicFile(self.controlfilename('parent'))
 
1481
            try:
 
1482
                f.write(url + '\n')
 
1483
                f.commit()
 
1484
            finally:
 
1485
                f.close()
 
1486
        finally:
 
1487
            self.unlock()
440
1488
 
441
1489
    def check_revno(self, revno):
442
1490
        """\
453
1501
        """
454
1502
        if revno < 1 or revno > self.revno():
455
1503
            raise InvalidRevisionNumber(revno)
456
 
 
457
 
    @needs_read_lock
458
 
    def clone(self, *args, **kwargs):
459
 
        """Clone this branch into to_bzrdir preserving all semantic values.
460
 
        
461
 
        revision_id: if not None, the revision history in the new branch will
462
 
                     be truncated to end with revision_id.
463
 
        """
464
 
        # for API compatibility, until 0.8 releases we provide the old api:
465
 
        # def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
466
 
        # after 0.8 releases, the *args and **kwargs should be changed:
467
 
        # def clone(self, to_bzrdir, revision_id=None):
468
 
        if (kwargs.get('to_location', None) or
469
 
            kwargs.get('revision', None) or
470
 
            kwargs.get('basis_branch', None) or
471
 
            (len(args) and isinstance(args[0], basestring))):
472
 
            # backwards compatibility api:
473
 
            warn("Branch.clone() has been deprecated for BzrDir.clone() from"
474
 
                 " bzrlib 0.8.", DeprecationWarning, stacklevel=3)
475
 
            # get basis_branch
476
 
            if len(args) > 2:
477
 
                basis_branch = args[2]
478
 
            else:
479
 
                basis_branch = kwargs.get('basis_branch', None)
480
 
            if basis_branch:
481
 
                basis = basis_branch.bzrdir
482
 
            else:
483
 
                basis = None
484
 
            # get revision
485
 
            if len(args) > 1:
486
 
                revision_id = args[1]
487
 
            else:
488
 
                revision_id = kwargs.get('revision', None)
489
 
            # get location
490
 
            if len(args):
491
 
                url = args[0]
492
 
            else:
493
 
                # no default to raise if not provided.
494
 
                url = kwargs.get('to_location')
495
 
            return self.bzrdir.clone(url,
496
 
                                     revision_id=revision_id,
497
 
                                     basis=basis).open_branch()
498
 
        # new cleaner api.
499
 
        # generate args by hand 
500
 
        if len(args) > 1:
501
 
            revision_id = args[1]
502
 
        else:
503
 
            revision_id = kwargs.get('revision_id', None)
504
 
        if len(args):
505
 
            to_bzrdir = args[0]
506
 
        else:
507
 
            # no default to raise if not provided.
508
 
            to_bzrdir = kwargs.get('to_bzrdir')
509
 
        result = self._format.initialize(to_bzrdir)
510
 
        self.copy_content_into(result, revision_id=revision_id)
511
 
        return  result
512
 
 
513
 
    @needs_read_lock
514
 
    def sprout(self, to_bzrdir, revision_id=None):
515
 
        """Create a new line of development from the branch, into to_bzrdir.
516
 
        
517
 
        revision_id: if not None, the revision history in the new branch will
518
 
                     be truncated to end with revision_id.
519
 
        """
520
 
        result = self._format.initialize(to_bzrdir)
521
 
        self.copy_content_into(result, revision_id=revision_id)
522
 
        result.set_parent(self.bzrdir.root_transport.base)
523
 
        return result
524
 
 
525
 
    @needs_read_lock
526
 
    def copy_content_into(self, destination, revision_id=None):
527
 
        """Copy the content of self into destination.
528
 
 
529
 
        revision_id: if not None, the revision history in the new branch will
530
 
                     be truncated to end with revision_id.
531
 
        """
532
 
        new_history = self.revision_history()
533
 
        if revision_id is not None:
534
 
            try:
535
 
                new_history = new_history[:new_history.index(revision_id) + 1]
536
 
            except ValueError:
537
 
                rev = self.repository.get_revision(revision_id)
538
 
                new_history = rev.get_history(self.repository)[1:]
539
 
        destination.set_revision_history(new_history)
540
 
        parent = self.get_parent()
541
 
        if parent:
542
 
            destination.set_parent(parent)
543
 
 
544
 
    @needs_read_lock
545
 
    def check(self):
546
 
        """Check consistency of the branch.
547
 
 
548
 
        In particular this checks that revisions given in the revision-history
549
 
        do actually match up in the revision graph, and that they're all 
550
 
        present in the repository.
551
 
        
552
 
        Callers will typically also want to check the repository.
553
 
 
554
 
        :return: A BranchCheckResult.
555
 
        """
556
 
        mainline_parent_id = None
557
 
        for revision_id in self.revision_history():
558
 
            try:
559
 
                revision = self.repository.get_revision(revision_id)
560
 
            except errors.NoSuchRevision, e:
561
 
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
562
 
                            % revision_id)
563
 
            # In general the first entry on the revision history has no parents.
564
 
            # But it's not illegal for it to have parents listed; this can happen
565
 
            # in imports from Arch when the parents weren't reachable.
566
 
            if mainline_parent_id is not None:
567
 
                if mainline_parent_id not in revision.parent_ids:
568
 
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
569
 
                                        "parents of {%s}"
570
 
                                        % (mainline_parent_id, revision_id))
571
 
            mainline_parent_id = revision_id
572
 
        return BranchCheckResult(self)
573
 
 
574
 
 
575
 
class BranchFormat(object):
576
 
    """An encapsulation of the initialization and open routines for a format.
577
 
 
578
 
    Formats provide three things:
579
 
     * An initialization routine,
580
 
     * a format string,
581
 
     * an open routine.
582
 
 
583
 
    Formats are placed in an dict by their format string for reference 
584
 
    during branch opening. Its not required that these be instances, they
585
 
    can be classes themselves with class methods - it simply depends on 
586
 
    whether state is needed for a given format or not.
587
 
 
588
 
    Once a format is deprecated, just deprecate the initialize and open
589
 
    methods on the format class. Do not deprecate the object, as the 
590
 
    object will be created every time regardless.
591
 
    """
592
 
 
593
 
    _default_format = None
594
 
    """The default format used for new branches."""
595
 
 
596
 
    _formats = {}
597
 
    """The known formats."""
598
 
 
599
 
    @classmethod
600
 
    def find_format(klass, a_bzrdir):
601
 
        """Return the format for the branch object in a_bzrdir."""
602
 
        try:
603
 
            transport = a_bzrdir.get_branch_transport(None)
604
 
            format_string = transport.get("format").read()
605
 
            return klass._formats[format_string]
606
 
        except NoSuchFile:
607
 
            raise NotBranchError(path=transport.base)
608
 
        except KeyError:
609
 
            raise errors.UnknownFormatError(format=format_string)
610
 
 
611
 
    @classmethod
612
 
    def get_default_format(klass):
613
 
        """Return the current default format."""
614
 
        return klass._default_format
615
 
 
616
 
    def get_format_string(self):
617
 
        """Return the ASCII format string that identifies this format."""
618
 
        raise NotImplementedError(self.get_format_string)
619
 
 
620
 
    def get_format_description(self):
621
 
        """Return the short format description for this format."""
622
 
        raise NotImplementedError(self.get_format_string)
623
 
 
624
 
    def initialize(self, a_bzrdir):
625
 
        """Create a branch of this format in a_bzrdir."""
626
 
        raise NotImplementedError(self.initialize)
627
 
 
628
 
    def is_supported(self):
629
 
        """Is this format supported?
630
 
 
631
 
        Supported formats can be initialized and opened.
632
 
        Unsupported formats may not support initialization or committing or 
633
 
        some other features depending on the reason for not being supported.
634
 
        """
635
 
        return True
636
 
 
637
 
    def open(self, a_bzrdir, _found=False):
638
 
        """Return the branch object for a_bzrdir
639
 
 
640
 
        _found is a private parameter, do not use it. It is used to indicate
641
 
               if format probing has already be done.
642
 
        """
643
 
        raise NotImplementedError(self.open)
644
 
 
645
 
    @classmethod
646
 
    def register_format(klass, format):
647
 
        klass._formats[format.get_format_string()] = format
648
 
 
649
 
    @classmethod
650
 
    def set_default_format(klass, format):
651
 
        klass._default_format = format
652
 
 
653
 
    @classmethod
654
 
    def unregister_format(klass, format):
655
 
        assert klass._formats[format.get_format_string()] is format
656
 
        del klass._formats[format.get_format_string()]
657
 
 
658
 
    def __str__(self):
659
 
        return self.get_format_string().rstrip()
660
 
 
661
 
 
662
 
class BzrBranchFormat4(BranchFormat):
663
 
    """Bzr branch format 4.
664
 
 
665
 
    This format has:
666
 
     - a revision-history file.
667
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
668
 
    """
669
 
 
670
 
    def get_format_description(self):
671
 
        """See BranchFormat.get_format_description()."""
672
 
        return "Branch format 4"
673
 
 
674
 
    def initialize(self, a_bzrdir):
675
 
        """Create a branch of this format in a_bzrdir."""
676
 
        mutter('creating branch in %s', a_bzrdir.transport.base)
677
 
        branch_transport = a_bzrdir.get_branch_transport(self)
678
 
        utf8_files = [('revision-history', ''),
679
 
                      ('branch-name', ''),
680
 
                      ]
681
 
        control_files = LockableFiles(branch_transport, 'branch-lock',
682
 
                                      TransportLock)
683
 
        control_files.create_lock()
684
 
        control_files.lock_write()
685
 
        try:
686
 
            for file, content in utf8_files:
687
 
                control_files.put_utf8(file, content)
688
 
        finally:
689
 
            control_files.unlock()
690
 
        return self.open(a_bzrdir, _found=True)
691
 
 
692
 
    def __init__(self):
693
 
        super(BzrBranchFormat4, self).__init__()
694
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
695
 
 
696
 
    def open(self, a_bzrdir, _found=False):
697
 
        """Return the branch object for a_bzrdir
698
 
 
699
 
        _found is a private parameter, do not use it. It is used to indicate
700
 
               if format probing has already be done.
701
 
        """
702
 
        if not _found:
703
 
            # we are being called directly and must probe.
704
 
            raise NotImplementedError
705
 
        return BzrBranch(_format=self,
706
 
                         _control_files=a_bzrdir._control_files,
707
 
                         a_bzrdir=a_bzrdir,
708
 
                         _repository=a_bzrdir.open_repository())
709
 
 
710
 
    def __str__(self):
711
 
        return "Bazaar-NG branch format 4"
712
 
 
713
 
 
714
 
class BzrBranchFormat5(BranchFormat):
715
 
    """Bzr branch format 5.
716
 
 
717
 
    This format has:
718
 
     - a revision-history file.
719
 
     - a format string
720
 
     - a lock dir guarding the branch itself
721
 
     - all of this stored in a branch/ subdirectory
722
 
     - works with shared repositories.
723
 
 
724
 
    This format is new in bzr 0.8.
725
 
    """
726
 
 
727
 
    def get_format_string(self):
728
 
        """See BranchFormat.get_format_string()."""
729
 
        return "Bazaar-NG branch format 5\n"
730
 
 
731
 
    def get_format_description(self):
732
 
        """See BranchFormat.get_format_description()."""
733
 
        return "Branch format 5"
734
 
        
735
 
    def initialize(self, a_bzrdir):
736
 
        """Create a branch of this format in a_bzrdir."""
737
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
738
 
        branch_transport = a_bzrdir.get_branch_transport(self)
739
 
        utf8_files = [('revision-history', ''),
740
 
                      ('branch-name', ''),
741
 
                      ]
742
 
        control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
743
 
        control_files.create_lock()
744
 
        control_files.lock_write()
745
 
        control_files.put_utf8('format', self.get_format_string())
746
 
        try:
747
 
            for file, content in utf8_files:
748
 
                control_files.put_utf8(file, content)
749
 
        finally:
750
 
            control_files.unlock()
751
 
        return self.open(a_bzrdir, _found=True, )
752
 
 
753
 
    def __init__(self):
754
 
        super(BzrBranchFormat5, self).__init__()
755
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
756
 
 
757
 
    def open(self, a_bzrdir, _found=False):
758
 
        """Return the branch object for a_bzrdir
759
 
 
760
 
        _found is a private parameter, do not use it. It is used to indicate
761
 
               if format probing has already be done.
762
 
        """
763
 
        if not _found:
764
 
            format = BranchFormat.find_format(a_bzrdir)
765
 
            assert format.__class__ == self.__class__
766
 
        transport = a_bzrdir.get_branch_transport(None)
767
 
        control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
768
 
        return BzrBranch5(_format=self,
769
 
                          _control_files=control_files,
770
 
                          a_bzrdir=a_bzrdir,
771
 
                          _repository=a_bzrdir.find_repository())
772
 
 
773
 
    def __str__(self):
774
 
        return "Bazaar-NG Metadir branch format 5"
775
 
 
776
 
 
777
 
class BranchReferenceFormat(BranchFormat):
778
 
    """Bzr branch reference format.
779
 
 
780
 
    Branch references are used in implementing checkouts, they
781
 
    act as an alias to the real branch which is at some other url.
782
 
 
783
 
    This format has:
784
 
     - A location file
785
 
     - a format string
786
 
    """
787
 
 
788
 
    def get_format_string(self):
789
 
        """See BranchFormat.get_format_string()."""
790
 
        return "Bazaar-NG Branch Reference Format 1\n"
791
 
 
792
 
    def get_format_description(self):
793
 
        """See BranchFormat.get_format_description()."""
794
 
        return "Checkout reference format 1"
795
 
        
796
 
    def initialize(self, a_bzrdir, target_branch=None):
797
 
        """Create a branch of this format in a_bzrdir."""
798
 
        if target_branch is None:
799
 
            # this format does not implement branch itself, thus the implicit
800
 
            # creation contract must see it as uninitializable
801
 
            raise errors.UninitializableFormat(self)
802
 
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
803
 
        branch_transport = a_bzrdir.get_branch_transport(self)
804
 
        # FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
805
 
        branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
806
 
        branch_transport.put('format', StringIO(self.get_format_string()))
807
 
        return self.open(a_bzrdir, _found=True)
808
 
 
809
 
    def __init__(self):
810
 
        super(BranchReferenceFormat, self).__init__()
811
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
812
 
 
813
 
    def _make_reference_clone_function(format, a_branch):
814
 
        """Create a clone() routine for a branch dynamically."""
815
 
        def clone(to_bzrdir, revision_id=None):
816
 
            """See Branch.clone()."""
817
 
            return format.initialize(to_bzrdir, a_branch)
818
 
            # cannot obey revision_id limits when cloning a reference ...
819
 
            # FIXME RBC 20060210 either nuke revision_id for clone, or
820
 
            # emit some sort of warning/error to the caller ?!
821
 
        return clone
822
 
 
823
 
    def open(self, a_bzrdir, _found=False):
824
 
        """Return the branch that the branch reference in a_bzrdir points at.
825
 
 
826
 
        _found is a private parameter, do not use it. It is used to indicate
827
 
               if format probing has already be done.
828
 
        """
829
 
        if not _found:
830
 
            format = BranchFormat.find_format(a_bzrdir)
831
 
            assert format.__class__ == self.__class__
832
 
        transport = a_bzrdir.get_branch_transport(None)
833
 
        real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
834
 
        result = real_bzrdir.open_branch()
835
 
        # this changes the behaviour of result.clone to create a new reference
836
 
        # rather than a copy of the content of the branch.
837
 
        # I did not use a proxy object because that needs much more extensive
838
 
        # testing, and we are only changing one behaviour at the moment.
839
 
        # If we decide to alter more behaviours - i.e. the implicit nickname
840
 
        # then this should be refactored to introduce a tested proxy branch
841
 
        # and a subclass of that for use in overriding clone() and ....
842
 
        # - RBC 20060210
843
 
        result.clone = self._make_reference_clone_function(result)
844
 
        return result
845
 
 
846
 
 
847
 
# formats which have no format string are not discoverable
848
 
# and not independently creatable, so are not registered.
849
 
__default_format = BzrBranchFormat5()
850
 
BranchFormat.register_format(__default_format)
851
 
BranchFormat.register_format(BranchReferenceFormat())
852
 
BranchFormat.set_default_format(__default_format)
853
 
_legacy_formats = [BzrBranchFormat4(),
854
 
                   ]
855
 
 
856
 
class BzrBranch(Branch):
857
 
    """A branch stored in the actual filesystem.
858
 
 
859
 
    Note that it's "local" in the context of the filesystem; it doesn't
860
 
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
861
 
    it's writable, and can be accessed via the normal filesystem API.
862
 
    """
 
1504
        
 
1505
        
 
1506
 
 
1507
 
 
1508
class ScratchBranch(Branch):
 
1509
    """Special test class: a branch that cleans up after itself.
 
1510
 
 
1511
    >>> b = ScratchBranch()
 
1512
    >>> isdir(b.base)
 
1513
    True
 
1514
    >>> bd = b.base
 
1515
    >>> b.destroy()
 
1516
    >>> isdir(bd)
 
1517
    False
 
1518
    """
 
1519
    def __init__(self, files=[], dirs=[], base=None):
 
1520
        """Make a test branch.
 
1521
 
 
1522
        This creates a temporary directory and runs init-tree in it.
 
1523
 
 
1524
        If any files are listed, they are created in the working copy.
 
1525
        """
 
1526
        from tempfile import mkdtemp
 
1527
        init = False
 
1528
        if base is None:
 
1529
            base = mkdtemp()
 
1530
            init = True
 
1531
        Branch.__init__(self, base, init=init)
 
1532
        for d in dirs:
 
1533
            self._transport.mkdir(d)
 
1534
            
 
1535
        for f in files:
 
1536
            self._transport.put(f, 'content of %s' % f)
 
1537
 
 
1538
 
 
1539
    def clone(self):
 
1540
        """
 
1541
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1542
        >>> clone = orig.clone()
 
1543
        >>> os.path.samefile(orig.base, clone.base)
 
1544
        False
 
1545
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1546
        True
 
1547
        """
 
1548
        from shutil import copytree
 
1549
        from tempfile import mkdtemp
 
1550
        base = mkdtemp()
 
1551
        os.rmdir(base)
 
1552
        copytree(self.base, base, symlinks=True)
 
1553
        return ScratchBranch(base=base)
 
1554
 
 
1555
 
 
1556
        
 
1557
    def __del__(self):
 
1558
        self.destroy()
 
1559
 
 
1560
    def destroy(self):
 
1561
        """Destroy the test branch, removing the scratch directory."""
 
1562
        from shutil import rmtree
 
1563
        try:
 
1564
            if self.base:
 
1565
                mutter("delete ScratchBranch %s" % self.base)
 
1566
                rmtree(self.base)
 
1567
        except OSError, e:
 
1568
            # Work around for shutil.rmtree failing on Windows when
 
1569
            # readonly files are encountered
 
1570
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
1571
            for root, dirs, files in os.walk(self.base, topdown=False):
 
1572
                for name in files:
 
1573
                    os.chmod(os.path.join(root, name), 0700)
 
1574
            rmtree(self.base)
 
1575
        self._transport = None
 
1576
 
863
1577
    
864
 
    def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
865
 
                 relax_version_check=DEPRECATED_PARAMETER, _format=None,
866
 
                 _control_files=None, a_bzrdir=None, _repository=None):
867
 
        """Create new branch object at a particular location.
868
 
 
869
 
        transport -- A Transport object, defining how to access files.
870
 
        
871
 
        init -- If True, create new control files in a previously
872
 
             unversioned directory.  If False, the branch must already
873
 
             be versioned.
874
 
 
875
 
        relax_version_check -- If true, the usual check for the branch
876
 
            version is not applied.  This is intended only for
877
 
            upgrade/recovery type use; it's not guaranteed that
878
 
            all operations will work on old format branches.
879
 
        """
880
 
        if a_bzrdir is None:
881
 
            self.bzrdir = bzrdir.BzrDir.open(transport.base)
882
 
        else:
883
 
            self.bzrdir = a_bzrdir
884
 
        self._transport = self.bzrdir.transport.clone('..')
885
 
        self._base = self._transport.base
886
 
        self._format = _format
887
 
        if _control_files is None:
888
 
            raise ValueError('BzrBranch _control_files is None')
889
 
        self.control_files = _control_files
890
 
        if deprecated_passed(init):
891
 
            warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
892
 
                 "deprecated as of bzr 0.8. Please use Branch.create().",
893
 
                 DeprecationWarning,
894
 
                 stacklevel=2)
895
 
            if init:
896
 
                # this is slower than before deprecation, oh well never mind.
897
 
                # -> its deprecated.
898
 
                self._initialize(transport.base)
899
 
        self._check_format(_format)
900
 
        if deprecated_passed(relax_version_check):
901
 
            warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
902
 
                 "relax_version_check parameter is deprecated as of bzr 0.8. "
903
 
                 "Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
904
 
                 "open() method.",
905
 
                 DeprecationWarning,
906
 
                 stacklevel=2)
907
 
            if (not relax_version_check
908
 
                and not self._format.is_supported()):
909
 
                raise errors.UnsupportedFormatError(format=fmt)
910
 
        if deprecated_passed(transport):
911
 
            warn("BzrBranch.__init__(transport=XXX...): The transport "
912
 
                 "parameter is deprecated as of bzr 0.8. "
913
 
                 "Please use Branch.open, or bzrdir.open_branch().",
914
 
                 DeprecationWarning,
915
 
                 stacklevel=2)
916
 
        self.repository = _repository
917
 
 
918
 
    def __str__(self):
919
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
920
 
 
921
 
    __repr__ = __str__
922
 
 
923
 
    def __del__(self):
924
 
        # TODO: It might be best to do this somewhere else,
925
 
        # but it is nice for a Branch object to automatically
926
 
        # cache it's information.
927
 
        # Alternatively, we could have the Transport objects cache requests
928
 
        # See the earlier discussion about how major objects (like Branch)
929
 
        # should never expect their __del__ function to run.
930
 
        # XXX: cache_root seems to be unused, 2006-01-13 mbp
931
 
        if hasattr(self, 'cache_root') and self.cache_root is not None:
932
 
            try:
933
 
                osutils.rmtree(self.cache_root)
934
 
            except:
935
 
                pass
936
 
            self.cache_root = None
937
 
 
938
 
    def _get_base(self):
939
 
        return self._base
940
 
 
941
 
    base = property(_get_base, doc="The URL for the root of this branch.")
942
 
 
943
 
    def _finish_transaction(self):
944
 
        """Exit the current transaction."""
945
 
        return self.control_files._finish_transaction()
946
 
 
947
 
    def get_transaction(self):
948
 
        """Return the current active transaction.
949
 
 
950
 
        If no transaction is active, this returns a passthrough object
951
 
        for which all data is immediately flushed and no caching happens.
952
 
        """
953
 
        # this is an explicit function so that we can do tricky stuff
954
 
        # when the storage in rev_storage is elsewhere.
955
 
        # we probably need to hook the two 'lock a location' and 
956
 
        # 'have a transaction' together more delicately, so that
957
 
        # we can have two locks (branch and storage) and one transaction
958
 
        # ... and finishing the transaction unlocks both, but unlocking
959
 
        # does not. - RBC 20051121
960
 
        return self.control_files.get_transaction()
961
 
 
962
 
    def _set_transaction(self, transaction):
963
 
        """Set a new active transaction."""
964
 
        return self.control_files._set_transaction(transaction)
965
 
 
966
 
    def abspath(self, name):
967
 
        """See Branch.abspath."""
968
 
        return self.control_files._transport.abspath(name)
969
 
 
970
 
    def _check_format(self, format):
971
 
        """Identify the branch format if needed.
972
 
 
973
 
        The format is stored as a reference to the format object in
974
 
        self._format for code that needs to check it later.
975
 
 
976
 
        The format parameter is either None or the branch format class
977
 
        used to open this branch.
978
 
 
979
 
        FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
980
 
        """
981
 
        if format is None:
982
 
            format = BranchFormat.find_format(self.bzrdir)
983
 
        self._format = format
984
 
        mutter("got branch format %s", self._format)
985
 
 
986
 
    @needs_read_lock
987
 
    def get_root_id(self):
988
 
        """See Branch.get_root_id."""
989
 
        tree = self.repository.revision_tree(self.last_revision())
990
 
        return tree.inventory.root.file_id
991
 
 
992
 
    def is_locked(self):
993
 
        return self.control_files.is_locked()
994
 
 
995
 
    def lock_write(self):
996
 
        # TODO: test for failed two phase locks. This is known broken.
997
 
        self.control_files.lock_write()
998
 
        self.repository.lock_write()
999
 
 
1000
 
    def lock_read(self):
1001
 
        # TODO: test for failed two phase locks. This is known broken.
1002
 
        self.control_files.lock_read()
1003
 
        self.repository.lock_read()
1004
 
 
1005
 
    def unlock(self):
1006
 
        # TODO: test for failed two phase locks. This is known broken.
1007
 
        try:
1008
 
            self.repository.unlock()
1009
 
        finally:
1010
 
            self.control_files.unlock()
1011
 
        
1012
 
    def peek_lock_mode(self):
1013
 
        if self.control_files._lock_count == 0:
1014
 
            return None
1015
 
        else:
1016
 
            return self.control_files._lock_mode
1017
 
 
1018
 
    def get_physical_lock_status(self):
1019
 
        return self.control_files.get_physical_lock_status()
1020
 
 
1021
 
    @needs_read_lock
1022
 
    def print_file(self, file, revision_id):
1023
 
        """See Branch.print_file."""
1024
 
        return self.repository.print_file(file, revision_id)
1025
 
 
1026
 
    @needs_write_lock
1027
 
    def append_revision(self, *revision_ids):
1028
 
        """See Branch.append_revision."""
1029
 
        for revision_id in revision_ids:
1030
 
            mutter("add {%s} to revision-history" % revision_id)
1031
 
        rev_history = self.revision_history()
1032
 
        rev_history.extend(revision_ids)
1033
 
        self.set_revision_history(rev_history)
1034
 
 
1035
 
    @needs_write_lock
1036
 
    def set_revision_history(self, rev_history):
1037
 
        """See Branch.set_revision_history."""
1038
 
        self.control_files.put_utf8(
1039
 
            'revision-history', '\n'.join(rev_history))
1040
 
        transaction = self.get_transaction()
1041
 
        history = transaction.map.find_revision_history()
1042
 
        if history is not None:
1043
 
            # update the revision history in the identity map.
1044
 
            history[:] = list(rev_history)
1045
 
            # this call is disabled because revision_history is 
1046
 
            # not really an object yet, and the transaction is for objects.
1047
 
            # transaction.register_dirty(history)
1048
 
        else:
1049
 
            transaction.map.add_revision_history(rev_history)
1050
 
            # this call is disabled because revision_history is 
1051
 
            # not really an object yet, and the transaction is for objects.
1052
 
            # transaction.register_clean(history)
1053
 
 
1054
 
    @needs_read_lock
1055
 
    def revision_history(self):
1056
 
        """See Branch.revision_history."""
1057
 
        transaction = self.get_transaction()
1058
 
        history = transaction.map.find_revision_history()
1059
 
        if history is not None:
1060
 
            mutter("cache hit for revision-history in %s", self)
1061
 
            return list(history)
1062
 
        history = [l.rstrip('\r\n') for l in
1063
 
                self.control_files.get_utf8('revision-history').readlines()]
1064
 
        transaction.map.add_revision_history(history)
1065
 
        # this call is disabled because revision_history is 
1066
 
        # not really an object yet, and the transaction is for objects.
1067
 
        # transaction.register_clean(history, precious=True)
1068
 
        return list(history)
1069
 
 
1070
 
    @needs_write_lock
1071
 
    def generate_revision_history(self, revision_id, last_rev=None, 
1072
 
        other_branch=None):
1073
 
        """Create a new revision history that will finish with revision_id.
1074
 
        
1075
 
        :param revision_id: the new tip to use.
1076
 
        :param last_rev: The previous last_revision. If not None, then this
1077
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
1078
 
        :param other_branch: The other branch that DivergedBranches should
1079
 
            raise with respect to.
1080
 
        """
1081
 
        # stop_revision must be a descendant of last_revision
1082
 
        stop_graph = self.repository.get_revision_graph(revision_id)
1083
 
        if last_rev is not None and last_rev not in stop_graph:
1084
 
            # our previous tip is not merged into stop_revision
1085
 
            raise errors.DivergedBranches(self, other_branch)
1086
 
        # make a new revision history from the graph
1087
 
        current_rev_id = revision_id
1088
 
        new_history = []
1089
 
        while current_rev_id not in (None, revision.NULL_REVISION):
1090
 
            new_history.append(current_rev_id)
1091
 
            current_rev_id_parents = stop_graph[current_rev_id]
1092
 
            try:
1093
 
                current_rev_id = current_rev_id_parents[0]
1094
 
            except IndexError:
1095
 
                current_rev_id = None
1096
 
        new_history.reverse()
1097
 
        self.set_revision_history(new_history)
1098
 
 
1099
 
    @needs_write_lock
1100
 
    def update_revisions(self, other, stop_revision=None):
1101
 
        """See Branch.update_revisions."""
1102
 
        other.lock_read()
1103
 
        try:
1104
 
            if stop_revision is None:
1105
 
                stop_revision = other.last_revision()
1106
 
                if stop_revision is None:
1107
 
                    # if there are no commits, we're done.
1108
 
                    return
1109
 
            # whats the current last revision, before we fetch [and change it
1110
 
            # possibly]
1111
 
            last_rev = self.last_revision()
1112
 
            # we fetch here regardless of whether we need to so that we pickup
1113
 
            # filled in ghosts.
1114
 
            self.fetch(other, stop_revision)
1115
 
            my_ancestry = self.repository.get_ancestry(last_rev)
1116
 
            if stop_revision in my_ancestry:
1117
 
                # last_revision is a descendant of stop_revision
1118
 
                return
1119
 
            self.generate_revision_history(stop_revision, last_rev=last_rev,
1120
 
                other_branch=other)
1121
 
        finally:
1122
 
            other.unlock()
1123
 
 
1124
 
    def basis_tree(self):
1125
 
        """See Branch.basis_tree."""
1126
 
        return self.repository.revision_tree(self.last_revision())
1127
 
 
1128
 
    @deprecated_method(zero_eight)
1129
 
    def working_tree(self):
1130
 
        """Create a Working tree object for this branch."""
1131
 
 
1132
 
        from bzrlib.transport.local import LocalTransport
1133
 
        if (self.base.find('://') != -1 or 
1134
 
            not isinstance(self._transport, LocalTransport)):
1135
 
            raise NoWorkingTree(self.base)
1136
 
        return self.bzrdir.open_workingtree()
1137
 
 
1138
 
    @needs_write_lock
1139
 
    def pull(self, source, overwrite=False, stop_revision=None):
1140
 
        """See Branch.pull."""
1141
 
        source.lock_read()
1142
 
        try:
1143
 
            old_count = len(self.revision_history())
1144
 
            try:
1145
 
                self.update_revisions(source,stop_revision)
1146
 
            except DivergedBranches:
1147
 
                if not overwrite:
1148
 
                    raise
1149
 
            if overwrite:
1150
 
                self.set_revision_history(source.revision_history())
1151
 
            new_count = len(self.revision_history())
1152
 
            return new_count - old_count
1153
 
        finally:
1154
 
            source.unlock()
1155
 
 
1156
 
    def get_parent(self):
1157
 
        """See Branch.get_parent."""
1158
 
 
1159
 
        _locs = ['parent', 'pull', 'x-pull']
1160
 
        assert self.base[-1] == '/'
1161
 
        for l in _locs:
1162
 
            try:
1163
 
                parent = self.control_files.get(l).read().strip('\n')
1164
 
            except NoSuchFile:
1165
 
                continue
1166
 
            # This is an old-format absolute path to a local branch
1167
 
            # turn it into a url
1168
 
            if parent.startswith('/'):
1169
 
                parent = urlutils.local_path_to_url(parent.decode('utf8'))
1170
 
            return urlutils.join(self.base[:-1], parent)
1171
 
        return None
1172
 
 
1173
 
    def get_push_location(self):
1174
 
        """See Branch.get_push_location."""
1175
 
        push_loc = self.get_config().get_user_option('push_location')
1176
 
        return push_loc
1177
 
 
1178
 
    def set_push_location(self, location):
1179
 
        """See Branch.set_push_location."""
1180
 
        self.get_config().set_user_option('push_location', location, 
1181
 
                                          local=True)
1182
 
 
1183
 
    @needs_write_lock
1184
 
    def set_parent(self, url):
1185
 
        """See Branch.set_parent."""
1186
 
        # TODO: Maybe delete old location files?
1187
 
        # URLs should never be unicode, even on the local fs,
1188
 
        # FIXUP this and get_parent in a future branch format bump:
1189
 
        # read and rewrite the file, and have the new format code read
1190
 
        # using .get not .get_utf8. RBC 20060125
1191
 
        if url is None:
1192
 
            self.control_files._transport.delete('parent')
1193
 
        else:
1194
 
            if isinstance(url, unicode):
1195
 
                try: 
1196
 
                    url = url.encode('ascii')
1197
 
                except UnicodeEncodeError:
1198
 
                    raise bzrlib.errors.InvalidURL(url,
1199
 
                        "Urls must be 7-bit ascii, "
1200
 
                        "use bzrlib.urlutils.escape")
1201
 
                    
1202
 
            url = urlutils.relative_url(self.base, url)
1203
 
            self.control_files.put('parent', url + '\n')
1204
 
 
1205
 
    @deprecated_function(zero_nine)
1206
 
    def tree_config(self):
1207
 
        """DEPRECATED; call get_config instead.  
1208
 
        TreeConfig has become part of BranchConfig."""
1209
 
        return TreeConfig(self)
1210
 
 
1211
 
 
1212
 
class BzrBranch5(BzrBranch):
1213
 
    """A format 5 branch. This supports new features over plan branches.
1214
 
 
1215
 
    It has support for a master_branch which is the data for bound branches.
1216
 
    """
1217
 
 
1218
 
    def __init__(self,
1219
 
                 _format,
1220
 
                 _control_files,
1221
 
                 a_bzrdir,
1222
 
                 _repository):
1223
 
        super(BzrBranch5, self).__init__(_format=_format,
1224
 
                                         _control_files=_control_files,
1225
 
                                         a_bzrdir=a_bzrdir,
1226
 
                                         _repository=_repository)
1227
 
        
1228
 
    @needs_write_lock
1229
 
    def pull(self, source, overwrite=False, stop_revision=None):
1230
 
        """Updates branch.pull to be bound branch aware."""
1231
 
        bound_location = self.get_bound_location()
1232
 
        if source.base != bound_location:
1233
 
            # not pulling from master, so we need to update master.
1234
 
            master_branch = self.get_master_branch()
1235
 
            if master_branch:
1236
 
                master_branch.pull(source)
1237
 
                source = master_branch
1238
 
        return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1239
 
 
1240
 
    def get_bound_location(self):
1241
 
        try:
1242
 
            return self.control_files.get_utf8('bound').read()[:-1]
1243
 
        except errors.NoSuchFile:
1244
 
            return None
1245
 
 
1246
 
    @needs_read_lock
1247
 
    def get_master_branch(self):
1248
 
        """Return the branch we are bound to.
1249
 
        
1250
 
        :return: Either a Branch, or None
1251
 
 
1252
 
        This could memoise the branch, but if thats done
1253
 
        it must be revalidated on each new lock.
1254
 
        So for now we just don't memoise it.
1255
 
        # RBC 20060304 review this decision.
1256
 
        """
1257
 
        bound_loc = self.get_bound_location()
1258
 
        if not bound_loc:
1259
 
            return None
1260
 
        try:
1261
 
            return Branch.open(bound_loc)
1262
 
        except (errors.NotBranchError, errors.ConnectionError), e:
1263
 
            raise errors.BoundBranchConnectionFailure(
1264
 
                    self, bound_loc, e)
1265
 
 
1266
 
    @needs_write_lock
1267
 
    def set_bound_location(self, location):
1268
 
        """Set the target where this branch is bound to.
1269
 
 
1270
 
        :param location: URL to the target branch
1271
 
        """
1272
 
        if location:
1273
 
            self.control_files.put_utf8('bound', location+'\n')
1274
 
        else:
1275
 
            try:
1276
 
                self.control_files._transport.delete('bound')
1277
 
            except NoSuchFile:
1278
 
                return False
 
1578
 
 
1579
######################################################################
 
1580
# predicates
 
1581
 
 
1582
 
 
1583
def is_control_file(filename):
 
1584
    ## FIXME: better check
 
1585
    filename = os.path.normpath(filename)
 
1586
    while filename != '':
 
1587
        head, tail = os.path.split(filename)
 
1588
        ## mutter('check %r for control file' % ((head, tail), ))
 
1589
        if tail == bzrlib.BZRDIR:
1279
1590
            return True
1280
 
 
1281
 
    @needs_write_lock
1282
 
    def bind(self, other):
1283
 
        """Bind the local branch the other branch.
1284
 
 
1285
 
        :param other: The branch to bind to
1286
 
        :type other: Branch
1287
 
        """
1288
 
        # TODO: jam 20051230 Consider checking if the target is bound
1289
 
        #       It is debatable whether you should be able to bind to
1290
 
        #       a branch which is itself bound.
1291
 
        #       Committing is obviously forbidden,
1292
 
        #       but binding itself may not be.
1293
 
        #       Since we *have* to check at commit time, we don't
1294
 
        #       *need* to check here
1295
 
        self.pull(other)
1296
 
 
1297
 
        # we are now equal to or a suffix of other.
1298
 
 
1299
 
        # Since we have 'pulled' from the remote location,
1300
 
        # now we should try to pull in the opposite direction
1301
 
        # in case the local tree has more revisions than the
1302
 
        # remote one.
1303
 
        # There may be a different check you could do here
1304
 
        # rather than actually trying to install revisions remotely.
1305
 
        # TODO: capture an exception which indicates the remote branch
1306
 
        #       is not writable. 
1307
 
        #       If it is up-to-date, this probably should not be a failure
1308
 
        
1309
 
        # lock other for write so the revision-history syncing cannot race
1310
 
        other.lock_write()
1311
 
        try:
1312
 
            other.pull(self)
1313
 
            # if this does not error, other now has the same last rev we do
1314
 
            # it can only error if the pull from other was concurrent with
1315
 
            # a commit to other from someone else.
1316
 
 
1317
 
            # until we ditch revision-history, we need to sync them up:
1318
 
            self.set_revision_history(other.revision_history())
1319
 
            # now other and self are up to date with each other and have the
1320
 
            # same revision-history.
1321
 
        finally:
1322
 
            other.unlock()
1323
 
 
1324
 
        self.set_bound_location(other.base)
1325
 
 
1326
 
    @needs_write_lock
1327
 
    def unbind(self):
1328
 
        """If bound, unbind"""
1329
 
        return self.set_bound_location(None)
1330
 
 
1331
 
    @needs_write_lock
1332
 
    def update(self):
1333
 
        """Synchronise this branch with the master branch if any. 
1334
 
 
1335
 
        :return: None or the last_revision that was pivoted out during the
1336
 
                 update.
1337
 
        """
1338
 
        master = self.get_master_branch()
1339
 
        if master is not None:
1340
 
            old_tip = self.last_revision()
1341
 
            self.pull(master, overwrite=True)
1342
 
            if old_tip in self.repository.get_ancestry(self.last_revision()):
1343
 
                return None
1344
 
            return old_tip
1345
 
        return None
1346
 
 
1347
 
 
1348
 
class BranchTestProviderAdapter(object):
1349
 
    """A tool to generate a suite testing multiple branch formats at once.
1350
 
 
1351
 
    This is done by copying the test once for each transport and injecting
1352
 
    the transport_server, transport_readonly_server, and branch_format
1353
 
    classes into each copy. Each copy is also given a new id() to make it
1354
 
    easy to identify.
 
1591
        if filename == head:
 
1592
            break
 
1593
        filename = head
 
1594
    return False
 
1595
 
 
1596
 
 
1597
 
 
1598
def gen_file_id(name):
 
1599
    """Return new file id.
 
1600
 
 
1601
    This should probably generate proper UUIDs, but for the moment we
 
1602
    cope with just randomness because running uuidgen every time is
 
1603
    slow."""
 
1604
    import re
 
1605
    from binascii import hexlify
 
1606
    from time import time
 
1607
 
 
1608
    # get last component
 
1609
    idx = name.rfind('/')
 
1610
    if idx != -1:
 
1611
        name = name[idx+1 : ]
 
1612
    idx = name.rfind('\\')
 
1613
    if idx != -1:
 
1614
        name = name[idx+1 : ]
 
1615
 
 
1616
    # make it not a hidden file
 
1617
    name = name.lstrip('.')
 
1618
 
 
1619
    # remove any wierd characters; we don't escape them but rather
 
1620
    # just pull them out
 
1621
    name = re.sub(r'[^\w.]', '', name)
 
1622
 
 
1623
    s = hexlify(rand_bytes(8))
 
1624
    return '-'.join((name, compact_date(time()), s))
 
1625
 
 
1626
 
 
1627
def gen_root_id():
 
1628
    """Return a new tree-root file id."""
 
1629
    return gen_file_id('TREE_ROOT')
 
1630
 
 
1631
 
 
1632
def copy_branch(branch_from, to_location, revision=None):
 
1633
    """Copy branch_from into the existing directory to_location.
 
1634
 
 
1635
    revision
 
1636
        If not None, only revisions up to this point will be copied.
 
1637
        The head of the new branch will be that revision.
 
1638
 
 
1639
    to_location
 
1640
        The name of a local directory that exists but is empty.
1355
1641
    """
 
1642
    from bzrlib.merge import merge
1356
1643
 
1357
 
    def __init__(self, transport_server, transport_readonly_server, formats):
1358
 
        self._transport_server = transport_server
1359
 
        self._transport_readonly_server = transport_readonly_server
1360
 
        self._formats = formats
 
1644
    assert isinstance(branch_from, Branch)
 
1645
    assert isinstance(to_location, basestring)
1361
1646
    
1362
 
    def adapt(self, test):
1363
 
        result = TestSuite()
1364
 
        for branch_format, bzrdir_format in self._formats:
1365
 
            new_test = deepcopy(test)
1366
 
            new_test.transport_server = self._transport_server
1367
 
            new_test.transport_readonly_server = self._transport_readonly_server
1368
 
            new_test.bzrdir_format = bzrdir_format
1369
 
            new_test.branch_format = branch_format
1370
 
            def make_new_test_id():
1371
 
                new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1372
 
                return lambda: new_id
1373
 
            new_test.id = make_new_test_id()
1374
 
            result.addTest(new_test)
1375
 
        return result
1376
 
 
1377
 
 
1378
 
class BranchCheckResult(object):
1379
 
    """Results of checking branch consistency.
1380
 
 
1381
 
    :see: Branch.check
1382
 
    """
1383
 
 
1384
 
    def __init__(self, branch):
1385
 
        self.branch = branch
1386
 
 
1387
 
    def report_results(self, verbose):
1388
 
        """Report the check results via trace.note.
1389
 
        
1390
 
        :param verbose: Requests more detailed display of what was checked,
1391
 
            if any.
1392
 
        """
1393
 
        note('checked branch %s format %s',
1394
 
             self.branch.base,
1395
 
             self.branch._format)
1396
 
 
1397
 
 
1398
 
######################################################################
1399
 
# predicates
1400
 
 
1401
 
 
1402
 
@deprecated_function(zero_eight)
1403
 
def is_control_file(*args, **kwargs):
1404
 
    """See bzrlib.workingtree.is_control_file."""
1405
 
    return bzrlib.workingtree.is_control_file(*args, **kwargs)
 
1647
    br_to = Branch(to_location, init=True)
 
1648
    br_to.set_root_id(branch_from.get_root_id())
 
1649
    if revision is None:
 
1650
        revno = branch_from.revno()
 
1651
    else:
 
1652
        revno, rev_id = branch_from.get_revision_info(revision)
 
1653
    br_to.update_revisions(branch_from, stop_revision=revno)
 
1654
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
1655
          check_clean=False, ignore_zero=True)
 
1656
    br_to.set_parent(branch_from.base)
 
1657
    return br_to
 
1658
 
 
1659
def _trim_namespace(namespace, spec):
 
1660
    full_namespace = namespace + ':'
 
1661
    assert spec.startswith(full_namespace)
 
1662
    return spec[len(full_namespace):]