~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-09-13 23:08:19 UTC
  • Revision ID: mbp@sourcefrog.net-20050913230819-6ceae96050d32faa
ignore .bzr-shelf

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 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
import sys
 
19
import os
18
20
from cStringIO import StringIO
19
21
 
20
 
from bzrlib.lazy_import import lazy_import
21
 
lazy_import(globals(), """
22
 
from warnings import warn
23
 
 
24
22
import bzrlib
25
 
from bzrlib import (
26
 
        bzrdir,
27
 
        cache_utf8,
28
 
        config as _mod_config,
29
 
        errors,
30
 
        lockdir,
31
 
        lockable_files,
32
 
        osutils,
33
 
        revision as _mod_revision,
34
 
        transport,
35
 
        tree,
36
 
        tsort,
37
 
        ui,
38
 
        urlutils,
39
 
        )
40
 
from bzrlib.config import BranchConfig, TreeConfig
41
 
from bzrlib.lockable_files import LockableFiles, TransportLock
42
 
from bzrlib.tag import (
43
 
    BasicTags,
44
 
    DisabledTags,
45
 
    )
46
 
""")
47
 
 
48
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
49
 
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
50
 
                           HistoryMissing, InvalidRevisionId,
51
 
                           InvalidRevisionNumber, LockError, NoSuchFile,
52
 
                           NoSuchRevision, NotVersionedError,
53
 
                           NotBranchError, UninitializableFormat,
54
 
                           UnlistableStore, UnlistableBranch,
55
 
                           )
56
 
from bzrlib.hooks import Hooks
57
 
from bzrlib.symbol_versioning import (deprecated_function,
58
 
                                      deprecated_method,
59
 
                                      DEPRECATED_PARAMETER,
60
 
                                      deprecated_passed,
61
 
                                      zero_eight, zero_nine, zero_sixteen,
62
 
                                      zero_ninetyone,
63
 
                                      )
64
23
from bzrlib.trace import mutter, note
 
24
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
 
25
     splitpath, \
 
26
     sha_file, appendpath, file_kind
 
27
 
 
28
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
 
29
                           NoSuchRevision)
 
30
from bzrlib.textui import show_status
 
31
from bzrlib.revision import Revision
 
32
from bzrlib.delta import compare_trees
 
33
from bzrlib.tree import EmptyTree, RevisionTree
 
34
from bzrlib.inventory import Inventory
 
35
from bzrlib.weavestore import WeaveStore
 
36
from bzrlib.store import ImmutableStore
 
37
import bzrlib.xml5
 
38
import bzrlib.ui
 
39
 
 
40
 
 
41
INVENTORY_FILEID = '__inventory'
 
42
ANCESTRY_FILEID = '__ancestry'
65
43
 
66
44
 
67
45
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
68
46
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
69
 
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
70
 
 
71
 
 
72
 
# TODO: Maybe include checks for common corruption of newlines, etc?
 
47
## TODO: Maybe include checks for common corruption of newlines, etc?
 
48
 
73
49
 
74
50
# TODO: Some operations like log might retrieve the same revisions
75
51
# repeatedly to calculate deltas.  We could perhaps have a weakref
76
52
# cache in memory to make this faster.  In general anything can be
77
 
# cached in memory between lock and unlock operations. .. nb thats
78
 
# what the transaction identity map provides
 
53
# cached in memory between lock and unlock operations.
 
54
 
 
55
# TODO: please move the revision-string syntax stuff out of the branch
 
56
# object; it's clutter
 
57
 
 
58
 
 
59
def find_branch(f, **args):
 
60
    if f and (f.startswith('http://') or f.startswith('https://')):
 
61
        import remotebranch 
 
62
        return remotebranch.RemoteBranch(f, **args)
 
63
    else:
 
64
        return Branch(f, **args)
 
65
 
 
66
 
 
67
def find_cached_branch(f, cache_root, **args):
 
68
    from remotebranch import RemoteBranch
 
69
    br = find_branch(f, **args)
 
70
    def cacheify(br, store_name):
 
71
        from meta_store import CachedStore
 
72
        cache_path = os.path.join(cache_root, store_name)
 
73
        os.mkdir(cache_path)
 
74
        new_store = CachedStore(getattr(br, store_name), cache_path)
 
75
        setattr(br, store_name, new_store)
 
76
 
 
77
    if isinstance(br, RemoteBranch):
 
78
        cacheify(br, 'inventory_store')
 
79
        cacheify(br, 'text_store')
 
80
        cacheify(br, 'revision_store')
 
81
    return br
 
82
 
 
83
 
 
84
def _relpath(base, path):
 
85
    """Return path relative to base, or raise exception.
 
86
 
 
87
    The path may be either an absolute path or a path relative to the
 
88
    current working directory.
 
89
 
 
90
    Lifted out of Branch.relpath for ease of testing.
 
91
 
 
92
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
93
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
94
    avoids that problem."""
 
95
    rp = os.path.abspath(path)
 
96
 
 
97
    s = []
 
98
    head = rp
 
99
    while len(head) >= len(base):
 
100
        if head == base:
 
101
            break
 
102
        head, tail = os.path.split(head)
 
103
        if tail:
 
104
            s.insert(0, tail)
 
105
    else:
 
106
        from errors import NotBranchError
 
107
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
 
108
 
 
109
    return os.sep.join(s)
 
110
        
 
111
 
 
112
def find_branch_root(f=None):
 
113
    """Find the branch root enclosing f, or pwd.
 
114
 
 
115
    f may be a filename or a URL.
 
116
 
 
117
    It is not necessary that f exists.
 
118
 
 
119
    Basically we keep looking up until we find the control directory or
 
120
    run into the root.  If there isn't one, raises NotBranchError.
 
121
    """
 
122
    if f == None:
 
123
        f = os.getcwd()
 
124
    elif hasattr(os.path, 'realpath'):
 
125
        f = os.path.realpath(f)
 
126
    else:
 
127
        f = os.path.abspath(f)
 
128
    if not os.path.exists(f):
 
129
        raise BzrError('%r does not exist' % f)
 
130
        
 
131
 
 
132
    orig_f = f
 
133
 
 
134
    while True:
 
135
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
 
136
            return f
 
137
        head, tail = os.path.split(f)
 
138
        if head == f:
 
139
            # reached the root, whatever that may be
 
140
            raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
 
141
        f = head
 
142
 
 
143
 
 
144
 
 
145
# XXX: move into bzrlib.errors; subclass BzrError    
 
146
class DivergedBranches(Exception):
 
147
    def __init__(self, branch1, branch2):
 
148
        self.branch1 = branch1
 
149
        self.branch2 = branch2
 
150
        Exception.__init__(self, "These branches have diverged.")
79
151
 
80
152
 
81
153
######################################################################
85
157
    """Branch holding a history of revisions.
86
158
 
87
159
    base
88
 
        Base directory/url of the branch.
89
 
 
90
 
    hooks: An instance of BranchHooks.
 
160
        Base directory of the branch.
 
161
 
 
162
    _lock_mode
 
163
        None, or 'r' or 'w'
 
164
 
 
165
    _lock_count
 
166
        If _lock_mode is true, a positive count of the number of times the
 
167
        lock has been taken.
 
168
 
 
169
    _lock
 
170
        Lock object from bzrlib.lock.
91
171
    """
92
 
    # this is really an instance variable - FIXME move it there
93
 
    # - RBC 20060112
94
172
    base = None
95
 
 
96
 
    # override this to set the strategy for storing tags
97
 
    def _make_tags(self):
98
 
        return DisabledTags(self)
99
 
 
100
 
    def __init__(self, *ignored, **ignored_too):
101
 
        self.tags = self._make_tags()
102
 
        self._revision_history_cache = None
103
 
        self._revision_id_to_revno_cache = None
104
 
 
105
 
    def break_lock(self):
106
 
        """Break a lock if one is present from another instance.
107
 
 
108
 
        Uses the ui factory to ask for confirmation if the lock may be from
109
 
        an active process.
110
 
 
111
 
        This will probe the repository for its lock as well.
112
 
        """
113
 
        self.control_files.break_lock()
114
 
        self.repository.break_lock()
115
 
        master = self.get_master_branch()
116
 
        if master is not None:
117
 
            master.break_lock()
118
 
 
119
 
    @staticmethod
120
 
    def open(base, _unsupported=False, possible_transports=None):
121
 
        """Open the branch rooted at base.
122
 
 
123
 
        For instance, if the branch is at URL/.bzr/branch,
124
 
        Branch.open(URL) -> a Branch instance.
125
 
        """
126
 
        control = bzrdir.BzrDir.open(base, _unsupported,
127
 
                                     possible_transports=possible_transports)
128
 
        return control.open_branch(_unsupported)
129
 
 
130
 
    @staticmethod
131
 
    def open_from_transport(transport, _unsupported=False):
132
 
        """Open the branch rooted at transport"""
133
 
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
134
 
        return control.open_branch(_unsupported)
135
 
 
136
 
    @staticmethod
137
 
    def open_containing(url, possible_transports=None):
138
 
        """Open an existing branch which contains url.
 
173
    _lock_mode = None
 
174
    _lock_count = None
 
175
    _lock = None
 
176
    _inventory_weave = None
 
177
    
 
178
    # Map some sort of prefix into a namespace
 
179
    # stuff like "revno:10", "revid:", etc.
 
180
    # This should match a prefix with a function which accepts
 
181
    REVISION_NAMESPACES = {}
 
182
 
 
183
    def __init__(self, base, init=False, find_root=True):
 
184
        """Create new branch object at a particular location.
 
185
 
 
186
        base -- Base directory for the branch.
139
187
        
140
 
        This probes for a branch at url, and searches upwards from there.
141
 
 
142
 
        Basically we keep looking up until we find the control directory or
143
 
        run into the root.  If there isn't one, raises NotBranchError.
144
 
        If there is one and it is either an unrecognised format or an unsupported 
145
 
        format, UnknownFormatError or UnsupportedFormatError are raised.
146
 
        If there is one, it is returned, along with the unused portion of url.
 
188
        init -- If True, create new control files in a previously
 
189
             unversioned directory.  If False, the branch must already
 
190
             be versioned.
 
191
 
 
192
        find_root -- If true and init is false, find the root of the
 
193
             existing branch containing base.
 
194
 
 
195
        In the test suite, creation of new trees is tested using the
 
196
        `ScratchBranch` class.
147
197
        """
148
 
        control, relpath = bzrdir.BzrDir.open_containing(url,
149
 
                                                         possible_transports)
150
 
        return control.open_branch(), relpath
151
 
 
152
 
    def get_config(self):
153
 
        return BranchConfig(self)
154
 
 
155
 
    def _get_nick(self):
156
 
        return self.get_config().get_nickname()
157
 
 
158
 
    def _set_nick(self, nick):
159
 
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
160
 
 
161
 
    nick = property(_get_nick, _set_nick)
162
 
 
163
 
    def is_locked(self):
164
 
        raise NotImplementedError(self.is_locked)
 
198
        if init:
 
199
            self.base = os.path.realpath(base)
 
200
            self._make_control()
 
201
        elif find_root:
 
202
            self.base = find_branch_root(base)
 
203
        else:
 
204
            self.base = os.path.realpath(base)
 
205
            if not isdir(self.controlfilename('.')):
 
206
                from errors import NotBranchError
 
207
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
 
208
                                     ['use "bzr init" to initialize a new working tree',
 
209
                                      'current bzr can only operate from top-of-tree'])
 
210
        self._check_format()
 
211
 
 
212
        self.weave_store = WeaveStore(self.controlfilename('weaves'))
 
213
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
 
214
 
 
215
 
 
216
    def __str__(self):
 
217
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
218
 
 
219
 
 
220
    __repr__ = __str__
 
221
 
 
222
 
 
223
    def __del__(self):
 
224
        if self._lock_mode or self._lock:
 
225
            from warnings import warn
 
226
            warn("branch %r was not explicitly unlocked" % self)
 
227
            self._lock.unlock()
 
228
 
165
229
 
166
230
    def lock_write(self):
167
 
        raise NotImplementedError(self.lock_write)
 
231
        if self._lock_mode:
 
232
            if self._lock_mode != 'w':
 
233
                from errors import LockError
 
234
                raise LockError("can't upgrade to a write lock from %r" %
 
235
                                self._lock_mode)
 
236
            self._lock_count += 1
 
237
        else:
 
238
            from bzrlib.lock import WriteLock
 
239
 
 
240
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
241
            self._lock_mode = 'w'
 
242
            self._lock_count = 1
 
243
 
168
244
 
169
245
    def lock_read(self):
170
 
        raise NotImplementedError(self.lock_read)
 
246
        if self._lock_mode:
 
247
            assert self._lock_mode in ('r', 'w'), \
 
248
                   "invalid lock mode %r" % self._lock_mode
 
249
            self._lock_count += 1
 
250
        else:
 
251
            from bzrlib.lock import ReadLock
171
252
 
 
253
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
254
            self._lock_mode = 'r'
 
255
            self._lock_count = 1
 
256
                        
172
257
    def unlock(self):
173
 
        raise NotImplementedError(self.unlock)
174
 
 
175
 
    def peek_lock_mode(self):
176
 
        """Return lock mode for the Branch: 'r', 'w' or None"""
177
 
        raise NotImplementedError(self.peek_lock_mode)
178
 
 
179
 
    def get_physical_lock_status(self):
180
 
        raise NotImplementedError(self.get_physical_lock_status)
181
 
 
182
 
    @needs_read_lock
183
 
    def get_revision_id_to_revno_map(self):
184
 
        """Return the revision_id => dotted revno map.
185
 
 
186
 
        This will be regenerated on demand, but will be cached.
187
 
 
188
 
        :return: A dictionary mapping revision_id => dotted revno.
189
 
            This dictionary should not be modified by the caller.
190
 
        """
191
 
        if self._revision_id_to_revno_cache is not None:
192
 
            mapping = self._revision_id_to_revno_cache
 
258
        if not self._lock_mode:
 
259
            from errors import LockError
 
260
            raise LockError('branch %r is not locked' % (self))
 
261
 
 
262
        if self._lock_count > 1:
 
263
            self._lock_count -= 1
193
264
        else:
194
 
            mapping = self._gen_revno_map()
195
 
            self._cache_revision_id_to_revno(mapping)
196
 
        # TODO: jam 20070417 Since this is being cached, should we be returning
197
 
        #       a copy?
198
 
        # I would rather not, and instead just declare that users should not
199
 
        # modify the return value.
200
 
        return mapping
201
 
 
202
 
    def _gen_revno_map(self):
203
 
        """Create a new mapping from revision ids to dotted revnos.
204
 
 
205
 
        Dotted revnos are generated based on the current tip in the revision
206
 
        history.
207
 
        This is the worker function for get_revision_id_to_revno_map, which
208
 
        just caches the return value.
209
 
 
210
 
        :return: A dictionary mapping revision_id => dotted revno.
211
 
        """
212
 
        last_revision = self.last_revision()
213
 
        revision_graph = self.repository.get_revision_graph(last_revision)
214
 
        merge_sorted_revisions = tsort.merge_sort(
215
 
            revision_graph,
216
 
            last_revision,
217
 
            None,
218
 
            generate_revno=True)
219
 
        revision_id_to_revno = dict((rev_id, revno)
220
 
                                    for seq_num, rev_id, depth, revno, end_of_merge
221
 
                                     in merge_sorted_revisions)
222
 
        return revision_id_to_revno
223
 
 
224
 
    def leave_lock_in_place(self):
225
 
        """Tell this branch object not to release the physical lock when this
226
 
        object is unlocked.
227
 
        
228
 
        If lock_write doesn't return a token, then this method is not supported.
229
 
        """
230
 
        self.control_files.leave_in_place()
231
 
 
232
 
    def dont_leave_lock_in_place(self):
233
 
        """Tell this branch object to release the physical lock when this
234
 
        object is unlocked, even if it didn't originally acquire it.
235
 
 
236
 
        If lock_write doesn't return a token, then this method is not supported.
237
 
        """
238
 
        self.control_files.dont_leave_in_place()
 
265
            self._lock.unlock()
 
266
            self._lock = None
 
267
            self._lock_mode = self._lock_count = None
239
268
 
240
269
    def abspath(self, name):
241
 
        """Return absolute filename for something in the branch
242
 
        
243
 
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
244
 
        method and not a tree method.
245
 
        """
246
 
        raise NotImplementedError(self.abspath)
247
 
 
248
 
    def bind(self, other):
249
 
        """Bind the local branch the other branch.
250
 
 
251
 
        :param other: The branch to bind to
252
 
        :type other: Branch
253
 
        """
254
 
        raise errors.UpgradeRequired(self.base)
255
 
 
256
 
    @needs_write_lock
257
 
    def fetch(self, from_branch, last_revision=None, pb=None):
258
 
        """Copy revisions from from_branch into this branch.
259
 
 
260
 
        :param from_branch: Where to copy from.
261
 
        :param last_revision: What revision to stop at (None for at the end
262
 
                              of the branch.
263
 
        :param pb: An optional progress bar to use.
264
 
 
265
 
        Returns the copied revision count and the failed revisions in a tuple:
266
 
        (copied, failures).
267
 
        """
268
 
        if self.base == from_branch.base:
269
 
            return (0, [])
270
 
        if pb is None:
271
 
            nested_pb = ui.ui_factory.nested_progress_bar()
272
 
            pb = nested_pb
273
 
        else:
274
 
            nested_pb = None
275
 
 
276
 
        from_branch.lock_read()
277
 
        try:
278
 
            if last_revision is None:
279
 
                pb.update('get source history')
280
 
                last_revision = from_branch.last_revision()
281
 
                if last_revision is None:
282
 
                    last_revision = _mod_revision.NULL_REVISION
283
 
            return self.repository.fetch(from_branch.repository,
284
 
                                         revision_id=last_revision,
285
 
                                         pb=nested_pb)
286
 
        finally:
287
 
            if nested_pb is not None:
288
 
                nested_pb.finished()
289
 
            from_branch.unlock()
290
 
 
291
 
    def get_bound_location(self):
292
 
        """Return the URL of the branch we are bound to.
293
 
 
294
 
        Older format branches cannot bind, please be sure to use a metadir
295
 
        branch.
296
 
        """
297
 
        return None
298
 
    
299
 
    def get_old_bound_location(self):
300
 
        """Return the URL of the branch we used to be bound to
301
 
        """
302
 
        raise errors.UpgradeRequired(self.base)
303
 
 
304
 
    def get_commit_builder(self, parents, config=None, timestamp=None, 
305
 
                           timezone=None, committer=None, revprops=None, 
306
 
                           revision_id=None):
307
 
        """Obtain a CommitBuilder for this branch.
308
 
        
309
 
        :param parents: Revision ids of the parents of the new revision.
310
 
        :param config: Optional configuration to use.
311
 
        :param timestamp: Optional timestamp recorded for commit.
312
 
        :param timezone: Optional timezone for timestamp.
313
 
        :param committer: Optional committer to set for commit.
314
 
        :param revprops: Optional dictionary of revision properties.
315
 
        :param revision_id: Optional revision id.
316
 
        """
317
 
 
318
 
        if config is None:
319
 
            config = self.get_config()
320
 
        
321
 
        return self.repository.get_commit_builder(self, parents, config,
322
 
            timestamp, timezone, committer, revprops, revision_id)
323
 
 
324
 
    def get_master_branch(self, possible_transports=None):
325
 
        """Return the branch we are bound to.
326
 
        
327
 
        :return: Either a Branch, or None
328
 
        """
329
 
        return None
 
270
        """Return absolute filename for something in the branch"""
 
271
        return os.path.join(self.base, name)
 
272
 
 
273
    def relpath(self, path):
 
274
        """Return path relative to this branch of something inside it.
 
275
 
 
276
        Raises an error if path is not in this branch."""
 
277
        return _relpath(self.base, path)
 
278
 
 
279
    def controlfilename(self, file_or_path):
 
280
        """Return location relative to branch."""
 
281
        if isinstance(file_or_path, basestring):
 
282
            file_or_path = [file_or_path]
 
283
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
284
 
 
285
 
 
286
    def controlfile(self, file_or_path, mode='r'):
 
287
        """Open a control file for this branch.
 
288
 
 
289
        There are two classes of file in the control directory: text
 
290
        and binary.  binary files are untranslated byte streams.  Text
 
291
        control files are stored with Unix newlines and in UTF-8, even
 
292
        if the platform or locale defaults are different.
 
293
 
 
294
        Controlfiles should almost never be opened in write mode but
 
295
        rather should be atomically copied and replaced using atomicfile.
 
296
        """
 
297
 
 
298
        fn = self.controlfilename(file_or_path)
 
299
 
 
300
        if mode == 'rb' or mode == 'wb':
 
301
            return file(fn, mode)
 
302
        elif mode == 'r' or mode == 'w':
 
303
            # open in binary mode anyhow so there's no newline translation;
 
304
            # codecs uses line buffering by default; don't want that.
 
305
            import codecs
 
306
            return codecs.open(fn, mode + 'b', 'utf-8',
 
307
                               buffering=60000)
 
308
        else:
 
309
            raise BzrError("invalid controlfile mode %r" % mode)
 
310
 
 
311
    def _make_control(self):
 
312
        os.mkdir(self.controlfilename([]))
 
313
        self.controlfile('README', 'w').write(
 
314
            "This is a Bazaar-NG control directory.\n"
 
315
            "Do not change any files in this directory.\n")
 
316
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
 
317
        for d in ('text-store', 'revision-store',
 
318
                  'weaves'):
 
319
            os.mkdir(self.controlfilename(d))
 
320
        for f in ('revision-history', 'merged-patches',
 
321
                  'pending-merged-patches', 'branch-name',
 
322
                  'branch-lock',
 
323
                  'pending-merges'):
 
324
            self.controlfile(f, 'w').write('')
 
325
        mutter('created control directory in ' + self.base)
 
326
 
 
327
        # if we want per-tree root ids then this is the place to set
 
328
        # them; they're not needed for now and so ommitted for
 
329
        # simplicity.
 
330
        f = self.controlfile('inventory','w')
 
331
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
 
332
        
 
333
 
 
334
 
 
335
    def _check_format(self):
 
336
        """Check this branch format is supported.
 
337
 
 
338
        The format level is stored, as an integer, in
 
339
        self._branch_format for code that needs to check it later.
 
340
 
 
341
        In the future, we might need different in-memory Branch
 
342
        classes to support downlevel branches.  But not yet.
 
343
        """
 
344
        fmt = self.controlfile('branch-format', 'r').read()
 
345
        if fmt == BZR_BRANCH_FORMAT_5:
 
346
            self._branch_format = 5
 
347
        else:
 
348
            raise BzrError('sorry, branch format "%s" not supported; ' 
 
349
                           'use a different bzr version, '
 
350
                           'or run "bzr upgrade", '
 
351
                           'or remove the .bzr directory and "bzr init" again'
 
352
                           % fmt.rstrip('\n\r'))
 
353
 
 
354
    def get_root_id(self):
 
355
        """Return the id of this branches root"""
 
356
        inv = self.read_working_inventory()
 
357
        return inv.root.file_id
 
358
 
 
359
    def set_root_id(self, file_id):
 
360
        inv = self.read_working_inventory()
 
361
        orig_root_id = inv.root.file_id
 
362
        del inv._byid[inv.root.file_id]
 
363
        inv.root.file_id = file_id
 
364
        inv._byid[inv.root.file_id] = inv.root
 
365
        for fid in inv:
 
366
            entry = inv[fid]
 
367
            if entry.parent_id in (None, orig_root_id):
 
368
                entry.parent_id = inv.root.file_id
 
369
        self._write_inventory(inv)
 
370
 
 
371
    def read_working_inventory(self):
 
372
        """Read the working inventory."""
 
373
        self.lock_read()
 
374
        try:
 
375
            # ElementTree does its own conversion from UTF-8, so open in
 
376
            # binary.
 
377
            f = self.controlfile('inventory', 'rb')
 
378
            return bzrlib.xml5.serializer_v5.read_inventory(f)
 
379
        finally:
 
380
            self.unlock()
 
381
            
 
382
 
 
383
    def _write_inventory(self, inv):
 
384
        """Update the working inventory.
 
385
 
 
386
        That is to say, the inventory describing changes underway, that
 
387
        will be committed to the next revision.
 
388
        """
 
389
        from bzrlib.atomicfile import AtomicFile
 
390
        
 
391
        self.lock_write()
 
392
        try:
 
393
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
 
394
            try:
 
395
                bzrlib.xml5.serializer_v5.write_inventory(inv, f)
 
396
                f.commit()
 
397
            finally:
 
398
                f.close()
 
399
        finally:
 
400
            self.unlock()
 
401
        
 
402
        mutter('wrote working inventory')
 
403
            
 
404
 
 
405
    inventory = property(read_working_inventory, _write_inventory, None,
 
406
                         """Inventory for the working copy.""")
 
407
 
 
408
 
 
409
    def add(self, files, ids=None):
 
410
        """Make files versioned.
 
411
 
 
412
        Note that the command line normally calls smart_add instead,
 
413
        which can automatically recurse.
 
414
 
 
415
        This puts the files in the Added state, so that they will be
 
416
        recorded by the next commit.
 
417
 
 
418
        files
 
419
            List of paths to add, relative to the base of the tree.
 
420
 
 
421
        ids
 
422
            If set, use these instead of automatically generated ids.
 
423
            Must be the same length as the list of files, but may
 
424
            contain None for ids that are to be autogenerated.
 
425
 
 
426
        TODO: Perhaps have an option to add the ids even if the files do
 
427
              not (yet) exist.
 
428
 
 
429
        TODO: Perhaps yield the ids and paths as they're added.
 
430
        """
 
431
        # TODO: Re-adding a file that is removed in the working copy
 
432
        # should probably put it back with the previous ID.
 
433
        if isinstance(files, basestring):
 
434
            assert(ids is None or isinstance(ids, basestring))
 
435
            files = [files]
 
436
            if ids is not None:
 
437
                ids = [ids]
 
438
 
 
439
        if ids is None:
 
440
            ids = [None] * len(files)
 
441
        else:
 
442
            assert(len(ids) == len(files))
 
443
 
 
444
        self.lock_write()
 
445
        try:
 
446
            inv = self.read_working_inventory()
 
447
            for f,file_id in zip(files, ids):
 
448
                if is_control_file(f):
 
449
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
450
 
 
451
                fp = splitpath(f)
 
452
 
 
453
                if len(fp) == 0:
 
454
                    raise BzrError("cannot add top-level %r" % f)
 
455
 
 
456
                fullpath = os.path.normpath(self.abspath(f))
 
457
 
 
458
                try:
 
459
                    kind = file_kind(fullpath)
 
460
                except OSError:
 
461
                    # maybe something better?
 
462
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
463
 
 
464
                if kind != 'file' and kind != 'directory':
 
465
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
466
 
 
467
                if file_id is None:
 
468
                    file_id = gen_file_id(f)
 
469
                inv.add_path(f, kind=kind, file_id=file_id)
 
470
 
 
471
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
472
 
 
473
            self._write_inventory(inv)
 
474
        finally:
 
475
            self.unlock()
 
476
            
 
477
 
 
478
    def print_file(self, file, revno):
 
479
        """Print `file` to stdout."""
 
480
        self.lock_read()
 
481
        try:
 
482
            tree = self.revision_tree(self.lookup_revision(revno))
 
483
            # use inventory as it was in that revision
 
484
            file_id = tree.inventory.path2id(file)
 
485
            if not file_id:
 
486
                raise BzrError("%r is not present in revision %s" % (file, revno))
 
487
            tree.print_file(file_id)
 
488
        finally:
 
489
            self.unlock()
 
490
 
 
491
 
 
492
    def remove(self, files, verbose=False):
 
493
        """Mark nominated files for removal from the inventory.
 
494
 
 
495
        This does not remove their text.  This does not run on 
 
496
 
 
497
        TODO: Refuse to remove modified files unless --force is given?
 
498
 
 
499
        TODO: Do something useful with directories.
 
500
 
 
501
        TODO: Should this remove the text or not?  Tough call; not
 
502
        removing may be useful and the user can just use use rm, and
 
503
        is the opposite of add.  Removing it is consistent with most
 
504
        other tools.  Maybe an option.
 
505
        """
 
506
        ## TODO: Normalize names
 
507
        ## TODO: Remove nested loops; better scalability
 
508
        if isinstance(files, basestring):
 
509
            files = [files]
 
510
 
 
511
        self.lock_write()
 
512
 
 
513
        try:
 
514
            tree = self.working_tree()
 
515
            inv = tree.inventory
 
516
 
 
517
            # do this before any modifications
 
518
            for f in files:
 
519
                fid = inv.path2id(f)
 
520
                if not fid:
 
521
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
 
522
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
523
                if verbose:
 
524
                    # having remove it, it must be either ignored or unknown
 
525
                    if tree.is_ignored(f):
 
526
                        new_status = 'I'
 
527
                    else:
 
528
                        new_status = '?'
 
529
                    show_status(new_status, inv[fid].kind, quotefn(f))
 
530
                del inv[fid]
 
531
 
 
532
            self._write_inventory(inv)
 
533
        finally:
 
534
            self.unlock()
 
535
 
 
536
 
 
537
    # FIXME: this doesn't need to be a branch method
 
538
    def set_inventory(self, new_inventory_list):
 
539
        from bzrlib.inventory import Inventory, InventoryEntry
 
540
        inv = Inventory(self.get_root_id())
 
541
        for path, file_id, parent, kind in new_inventory_list:
 
542
            name = os.path.basename(path)
 
543
            if name == "":
 
544
                continue
 
545
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
546
        self._write_inventory(inv)
 
547
 
 
548
 
 
549
    def unknowns(self):
 
550
        """Return all unknown files.
 
551
 
 
552
        These are files in the working directory that are not versioned or
 
553
        control files or ignored.
 
554
        
 
555
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
556
        >>> list(b.unknowns())
 
557
        ['foo']
 
558
        >>> b.add('foo')
 
559
        >>> list(b.unknowns())
 
560
        []
 
561
        >>> b.remove('foo')
 
562
        >>> list(b.unknowns())
 
563
        ['foo']
 
564
        """
 
565
        return self.working_tree().unknowns()
 
566
 
 
567
 
 
568
    def append_revision(self, *revision_ids):
 
569
        from bzrlib.atomicfile import AtomicFile
 
570
 
 
571
        for revision_id in revision_ids:
 
572
            mutter("add {%s} to revision-history" % revision_id)
 
573
 
 
574
        rev_history = self.revision_history()
 
575
        rev_history.extend(revision_ids)
 
576
 
 
577
        f = AtomicFile(self.controlfilename('revision-history'))
 
578
        try:
 
579
            for rev_id in rev_history:
 
580
                print >>f, rev_id
 
581
            f.commit()
 
582
        finally:
 
583
            f.close()
 
584
 
 
585
 
 
586
    def get_revision_xml_file(self, revision_id):
 
587
        """Return XML file object for revision object."""
 
588
        if not revision_id or not isinstance(revision_id, basestring):
 
589
            raise InvalidRevisionId(revision_id)
 
590
 
 
591
        self.lock_read()
 
592
        try:
 
593
            try:
 
594
                return self.revision_store[revision_id]
 
595
            except IndexError:
 
596
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
597
        finally:
 
598
            self.unlock()
 
599
 
 
600
 
 
601
    def get_revision_xml(self, revision_id):
 
602
        return self.get_revision_xml_file(revision_id).read()
 
603
 
 
604
 
 
605
    def get_revision(self, revision_id):
 
606
        """Return the Revision object for a named revision"""
 
607
        xml_file = self.get_revision_xml_file(revision_id)
 
608
 
 
609
        try:
 
610
            r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
 
611
        except SyntaxError, e:
 
612
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
 
613
                                         [revision_id,
 
614
                                          str(e)])
 
615
            
 
616
        assert r.revision_id == revision_id
 
617
        return r
 
618
 
330
619
 
331
620
    def get_revision_delta(self, revno):
332
621
        """Return the delta for one revision.
338
627
        rh = self.revision_history()
339
628
        if not (1 <= revno <= len(rh)):
340
629
            raise InvalidRevisionNumber(revno)
341
 
        return self.repository.get_revision_delta(rh[revno-1])
342
 
 
343
 
    @deprecated_method(zero_sixteen)
344
 
    def get_root_id(self):
345
 
        """Return the id of this branches root
346
 
 
347
 
        Deprecated: branches don't have root ids-- trees do.
348
 
        Use basis_tree().get_root_id() instead.
349
 
        """
350
 
        raise NotImplementedError(self.get_root_id)
351
 
 
352
 
    def print_file(self, file, revision_id):
353
 
        """Print `file` to stdout."""
354
 
        raise NotImplementedError(self.print_file)
355
 
 
356
 
    def set_revision_history(self, rev_history):
357
 
        raise NotImplementedError(self.set_revision_history)
358
 
 
359
 
    def _cache_revision_history(self, rev_history):
360
 
        """Set the cached revision history to rev_history.
361
 
 
362
 
        The revision_history method will use this cache to avoid regenerating
363
 
        the revision history.
364
 
 
365
 
        This API is semi-public; it only for use by subclasses, all other code
366
 
        should consider it to be private.
367
 
        """
368
 
        self._revision_history_cache = rev_history
369
 
 
370
 
    def _cache_revision_id_to_revno(self, revision_id_to_revno):
371
 
        """Set the cached revision_id => revno map to revision_id_to_revno.
372
 
 
373
 
        This API is semi-public; it only for use by subclasses, all other code
374
 
        should consider it to be private.
375
 
        """
376
 
        self._revision_id_to_revno_cache = revision_id_to_revno
377
 
 
378
 
    def _clear_cached_state(self):
379
 
        """Clear any cached data on this branch, e.g. cached revision history.
380
 
 
381
 
        This means the next call to revision_history will need to call
382
 
        _gen_revision_history.
383
 
 
384
 
        This API is semi-public; it only for use by subclasses, all other code
385
 
        should consider it to be private.
386
 
        """
387
 
        self._revision_history_cache = None
388
 
        self._revision_id_to_revno_cache = None
389
 
 
390
 
    def _gen_revision_history(self):
391
 
        """Return sequence of revision hashes on to this branch.
392
 
        
393
 
        Unlike revision_history, this method always regenerates or rereads the
394
 
        revision history, i.e. it does not cache the result, so repeated calls
395
 
        may be expensive.
396
 
 
397
 
        Concrete subclasses should override this instead of revision_history so
398
 
        that subclasses do not need to deal with caching logic.
399
 
        
400
 
        This API is semi-public; it only for use by subclasses, all other code
401
 
        should consider it to be private.
402
 
        """
403
 
        raise NotImplementedError(self._gen_revision_history)
404
 
 
405
 
    @needs_read_lock
 
630
 
 
631
        # revno is 1-based; list is 0-based
 
632
 
 
633
        new_tree = self.revision_tree(rh[revno-1])
 
634
        if revno == 1:
 
635
            old_tree = EmptyTree()
 
636
        else:
 
637
            old_tree = self.revision_tree(rh[revno-2])
 
638
 
 
639
        return compare_trees(old_tree, new_tree)
 
640
 
 
641
        
 
642
 
 
643
    def get_revision_sha1(self, revision_id):
 
644
        """Hash the stored value of a revision, and return it."""
 
645
        return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
 
646
 
 
647
 
 
648
    def get_ancestry(self, revision_id):
 
649
        """Return a list of revision-ids integrated by a revision.
 
650
        """
 
651
        w = self.weave_store.get_weave(ANCESTRY_FILEID)
 
652
        # strip newlines
 
653
        return [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
 
654
 
 
655
 
 
656
    def get_inventory_weave(self):
 
657
        return self.weave_store.get_weave(INVENTORY_FILEID)
 
658
 
 
659
 
 
660
    def get_inventory(self, revision_id):
 
661
        """Get Inventory object by hash."""
 
662
        # FIXME: The text gets passed around a lot coming from the weave.
 
663
        f = StringIO(self.get_inventory_xml(revision_id))
 
664
        return bzrlib.xml5.serializer_v5.read_inventory(f)
 
665
 
 
666
 
 
667
    def get_inventory_xml(self, revision_id):
 
668
        """Get inventory XML as a file object."""
 
669
        try:
 
670
            assert isinstance(revision_id, basestring), type(revision_id)
 
671
            iw = self.get_inventory_weave()
 
672
            return iw.get_text(iw.lookup(revision_id))
 
673
        except IndexError:
 
674
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
 
675
 
 
676
 
 
677
    def get_inventory_sha1(self, revision_id):
 
678
        """Return the sha1 hash of the inventory entry
 
679
        """
 
680
        return self.get_revision(revision_id).inventory_sha1
 
681
 
 
682
 
 
683
    def get_revision_inventory(self, revision_id):
 
684
        """Return inventory of a past revision."""
 
685
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
686
        # must be the same as its revision, so this is trivial.
 
687
        if revision_id == None:
 
688
            return Inventory(self.get_root_id())
 
689
        else:
 
690
            return self.get_inventory(revision_id)
 
691
 
 
692
 
406
693
    def revision_history(self):
407
694
        """Return sequence of revision hashes on to this branch.
408
 
        
409
 
        This method will cache the revision history for as long as it is safe to
410
 
        do so.
411
 
        """
412
 
        if self._revision_history_cache is not None:
413
 
            history = self._revision_history_cache
414
 
        else:
415
 
            history = self._gen_revision_history()
416
 
            self._cache_revision_history(history)
417
 
        return list(history)
 
695
 
 
696
        >>> ScratchBranch().revision_history()
 
697
        []
 
698
        """
 
699
        self.lock_read()
 
700
        try:
 
701
            return [l.rstrip('\r\n') for l in
 
702
                    self.controlfile('revision-history', 'r').readlines()]
 
703
        finally:
 
704
            self.unlock()
 
705
 
 
706
 
 
707
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
708
        """
 
709
        >>> import commit
 
710
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
711
        >>> sb.common_ancestor(sb) == (None, None)
 
712
        True
 
713
        >>> commit.commit(sb, "Committing first revision")
 
714
        >>> sb.common_ancestor(sb)[0]
 
715
        1
 
716
        >>> clone = sb.clone()
 
717
        >>> commit.commit(sb, "Committing second revision")
 
718
        >>> sb.common_ancestor(sb)[0]
 
719
        2
 
720
        >>> sb.common_ancestor(clone)[0]
 
721
        1
 
722
        >>> commit.commit(clone, "Committing divergent second revision")
 
723
        >>> sb.common_ancestor(clone)[0]
 
724
        1
 
725
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
726
        True
 
727
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
728
        True
 
729
        >>> clone2 = sb.clone()
 
730
        >>> sb.common_ancestor(clone2)[0]
 
731
        2
 
732
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
733
        1
 
734
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
735
        1
 
736
        """
 
737
        my_history = self.revision_history()
 
738
        other_history = other.revision_history()
 
739
        if self_revno is None:
 
740
            self_revno = len(my_history)
 
741
        if other_revno is None:
 
742
            other_revno = len(other_history)
 
743
        indices = range(min((self_revno, other_revno)))
 
744
        indices.reverse()
 
745
        for r in indices:
 
746
            if my_history[r] == other_history[r]:
 
747
                return r+1, my_history[r]
 
748
        return None, None
 
749
 
418
750
 
419
751
    def revno(self):
420
752
        """Return current revision number for this branch.
424
756
        """
425
757
        return len(self.revision_history())
426
758
 
427
 
    def unbind(self):
428
 
        """Older format branches cannot bind or unbind."""
429
 
        raise errors.UpgradeRequired(self.base)
430
 
 
431
 
    def set_append_revisions_only(self, enabled):
432
 
        """Older format branches are never restricted to append-only"""
433
 
        raise errors.UpgradeRequired(self.base)
434
 
 
435
 
    def last_revision(self):
436
 
        """Return last revision id, or None"""
 
759
 
 
760
    def last_patch(self):
 
761
        """Return last patch hash, or None if no history.
 
762
        """
437
763
        ph = self.revision_history()
438
764
        if ph:
439
765
            return ph[-1]
440
766
        else:
441
 
            return _mod_revision.NULL_REVISION
442
 
 
443
 
    def last_revision_info(self):
444
 
        """Return information about the last revision.
445
 
 
446
 
        :return: A tuple (revno, last_revision_id).
 
767
            return None
 
768
 
 
769
 
 
770
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
447
771
        """
448
 
        rh = self.revision_history()
449
 
        revno = len(rh)
450
 
        if revno:
451
 
            return (revno, rh[-1])
452
 
        else:
453
 
            return (0, _mod_revision.NULL_REVISION)
454
 
 
455
 
    def missing_revisions(self, other, stop_revision=None):
456
 
        """Return a list of new revisions that would perfectly fit.
457
 
        
458
772
        If self and other have not diverged, return a list of the revisions
459
773
        present in other, but missing from self.
 
774
 
 
775
        >>> from bzrlib.commit import commit
 
776
        >>> bzrlib.trace.silent = True
 
777
        >>> br1 = ScratchBranch()
 
778
        >>> br2 = ScratchBranch()
 
779
        >>> br1.missing_revisions(br2)
 
780
        []
 
781
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
782
        >>> br1.missing_revisions(br2)
 
783
        [u'REVISION-ID-1']
 
784
        >>> br2.missing_revisions(br1)
 
785
        []
 
786
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
787
        >>> br1.missing_revisions(br2)
 
788
        []
 
789
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
790
        >>> br1.missing_revisions(br2)
 
791
        [u'REVISION-ID-2A']
 
792
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
793
        >>> br1.missing_revisions(br2)
 
794
        Traceback (most recent call last):
 
795
        DivergedBranches: These branches have diverged.
460
796
        """
461
797
        self_history = self.revision_history()
462
798
        self_len = len(self_history)
469
805
 
470
806
        if stop_revision is None:
471
807
            stop_revision = other_len
472
 
        else:
473
 
            assert isinstance(stop_revision, int)
474
 
            if stop_revision > other_len:
475
 
                raise errors.NoSuchRevision(self, stop_revision)
 
808
        elif stop_revision > other_len:
 
809
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
 
810
        
476
811
        return other_history[self_len:stop_revision]
477
812
 
 
813
 
478
814
    def update_revisions(self, other, stop_revision=None):
479
 
        """Pull in new perfect-fit revisions.
480
 
 
481
 
        :param other: Another Branch to pull from
482
 
        :param stop_revision: Updated until the given revision
483
 
        :return: None
 
815
        """Pull in all new revisions from other branch.
484
816
        """
485
 
        raise NotImplementedError(self.update_revisions)
 
817
        from bzrlib.fetch import greedy_fetch
 
818
 
 
819
        pb = bzrlib.ui.ui_factory.progress_bar()
 
820
        pb.update('comparing histories')
 
821
 
 
822
        revision_ids = self.missing_revisions(other, stop_revision)
 
823
 
 
824
        if len(revision_ids) > 0:
 
825
            count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
 
826
        else:
 
827
            count = 0
 
828
        self.append_revision(*revision_ids)
 
829
        ## note("Added %d revisions." % count)
 
830
        pb.clear()
 
831
 
 
832
 
 
833
    def commit(self, *args, **kw):
 
834
        from bzrlib.commit import Commit
 
835
        Commit().commit(self, *args, **kw)
 
836
        
 
837
 
 
838
    def lookup_revision(self, revision):
 
839
        """Return the revision identifier for a given revision information."""
 
840
        revno, info = self._get_revision_info(revision)
 
841
        return info
 
842
 
486
843
 
487
844
    def revision_id_to_revno(self, revision_id):
488
845
        """Given a revision id, return its revno"""
489
 
        if _mod_revision.is_null(revision_id):
490
 
            return 0
491
 
        revision_id = osutils.safe_revision_id(revision_id)
492
846
        history = self.revision_history()
493
847
        try:
494
848
            return history.index(revision_id) + 1
495
849
        except ValueError:
496
 
            raise errors.NoSuchRevision(self, revision_id)
 
850
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
851
 
 
852
 
 
853
    def get_revision_info(self, revision):
 
854
        """Return (revno, revision id) for revision identifier.
 
855
 
 
856
        revision can be an integer, in which case it is assumed to be revno (though
 
857
            this will translate negative values into positive ones)
 
858
        revision can also be a string, in which case it is parsed for something like
 
859
            'date:' or 'revid:' etc.
 
860
        """
 
861
        revno, rev_id = self._get_revision_info(revision)
 
862
        if revno is None:
 
863
            raise bzrlib.errors.NoSuchRevision(self, revision)
 
864
        return revno, rev_id
497
865
 
498
866
    def get_rev_id(self, revno, history=None):
499
867
        """Find the revision id of the specified revno."""
500
868
        if revno == 0:
501
 
            return _mod_revision.NULL_REVISION
 
869
            return None
502
870
        if history is None:
503
871
            history = self.revision_history()
504
 
        if revno <= 0 or revno > len(history):
505
 
            raise errors.NoSuchRevision(self, revno)
 
872
        elif revno <= 0 or revno > len(history):
 
873
            raise bzrlib.errors.NoSuchRevision(self, revno)
506
874
        return history[revno - 1]
507
875
 
508
 
    def pull(self, source, overwrite=False, stop_revision=None):
509
 
        """Mirror source into this branch.
510
 
 
511
 
        This branch is considered to be 'local', having low latency.
512
 
 
513
 
        :returns: PullResult instance
514
 
        """
515
 
        raise NotImplementedError(self.pull)
516
 
 
517
 
    def push(self, target, overwrite=False, stop_revision=None):
518
 
        """Mirror this branch into target.
519
 
 
520
 
        This branch is considered to be 'local', having low latency.
521
 
        """
522
 
        raise NotImplementedError(self.push)
 
876
    def _get_revision_info(self, revision):
 
877
        """Return (revno, revision id) for revision specifier.
 
878
 
 
879
        revision can be an integer, in which case it is assumed to be revno
 
880
        (though this will translate negative values into positive ones)
 
881
        revision can also be a string, in which case it is parsed for something
 
882
        like 'date:' or 'revid:' etc.
 
883
 
 
884
        A revid is always returned.  If it is None, the specifier referred to
 
885
        the null revision.  If the revid does not occur in the revision
 
886
        history, revno will be None.
 
887
        """
 
888
        
 
889
        if revision is None:
 
890
            return 0, None
 
891
        revno = None
 
892
        try:# Convert to int if possible
 
893
            revision = int(revision)
 
894
        except ValueError:
 
895
            pass
 
896
        revs = self.revision_history()
 
897
        if isinstance(revision, int):
 
898
            if revision < 0:
 
899
                revno = len(revs) + revision + 1
 
900
            else:
 
901
                revno = revision
 
902
            rev_id = self.get_rev_id(revno, revs)
 
903
        elif isinstance(revision, basestring):
 
904
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
 
905
                if revision.startswith(prefix):
 
906
                    result = func(self, revs, revision)
 
907
                    if len(result) > 1:
 
908
                        revno, rev_id = result
 
909
                    else:
 
910
                        revno = result[0]
 
911
                        rev_id = self.get_rev_id(revno, revs)
 
912
                    break
 
913
            else:
 
914
                raise BzrError('No namespace registered for string: %r' %
 
915
                               revision)
 
916
        else:
 
917
            raise TypeError('Unhandled revision type %s' % revision)
 
918
 
 
919
        if revno is None:
 
920
            if rev_id is None:
 
921
                raise bzrlib.errors.NoSuchRevision(self, revision)
 
922
        return revno, rev_id
 
923
 
 
924
    def _namespace_revno(self, revs, revision):
 
925
        """Lookup a revision by revision number"""
 
926
        assert revision.startswith('revno:')
 
927
        try:
 
928
            return (int(revision[6:]),)
 
929
        except ValueError:
 
930
            return None
 
931
    REVISION_NAMESPACES['revno:'] = _namespace_revno
 
932
 
 
933
    def _namespace_revid(self, revs, revision):
 
934
        assert revision.startswith('revid:')
 
935
        rev_id = revision[len('revid:'):]
 
936
        try:
 
937
            return revs.index(rev_id) + 1, rev_id
 
938
        except ValueError:
 
939
            return None, rev_id
 
940
    REVISION_NAMESPACES['revid:'] = _namespace_revid
 
941
 
 
942
    def _namespace_last(self, revs, revision):
 
943
        assert revision.startswith('last:')
 
944
        try:
 
945
            offset = int(revision[5:])
 
946
        except ValueError:
 
947
            return (None,)
 
948
        else:
 
949
            if offset <= 0:
 
950
                raise BzrError('You must supply a positive value for --revision last:XXX')
 
951
            return (len(revs) - offset + 1,)
 
952
    REVISION_NAMESPACES['last:'] = _namespace_last
 
953
 
 
954
    def _namespace_tag(self, revs, revision):
 
955
        assert revision.startswith('tag:')
 
956
        raise BzrError('tag: namespace registered, but not implemented.')
 
957
    REVISION_NAMESPACES['tag:'] = _namespace_tag
 
958
 
 
959
    def _namespace_date(self, revs, revision):
 
960
        assert revision.startswith('date:')
 
961
        import datetime
 
962
        # Spec for date revisions:
 
963
        #   date:value
 
964
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
 
965
        #   it can also start with a '+/-/='. '+' says match the first
 
966
        #   entry after the given date. '-' is match the first entry before the date
 
967
        #   '=' is match the first entry after, but still on the given date.
 
968
        #
 
969
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
 
970
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
 
971
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
 
972
        #       May 13th, 2005 at 0:00
 
973
        #
 
974
        #   So the proper way of saying 'give me all entries for today' is:
 
975
        #       -r {date:+today}:{date:-tomorrow}
 
976
        #   The default is '=' when not supplied
 
977
        val = revision[5:]
 
978
        match_style = '='
 
979
        if val[:1] in ('+', '-', '='):
 
980
            match_style = val[:1]
 
981
            val = val[1:]
 
982
 
 
983
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
 
984
        if val.lower() == 'yesterday':
 
985
            dt = today - datetime.timedelta(days=1)
 
986
        elif val.lower() == 'today':
 
987
            dt = today
 
988
        elif val.lower() == 'tomorrow':
 
989
            dt = today + datetime.timedelta(days=1)
 
990
        else:
 
991
            import re
 
992
            # This should be done outside the function to avoid recompiling it.
 
993
            _date_re = re.compile(
 
994
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
 
995
                    r'(,|T)?\s*'
 
996
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
 
997
                )
 
998
            m = _date_re.match(val)
 
999
            if not m or (not m.group('date') and not m.group('time')):
 
1000
                raise BzrError('Invalid revision date %r' % revision)
 
1001
 
 
1002
            if m.group('date'):
 
1003
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
 
1004
            else:
 
1005
                year, month, day = today.year, today.month, today.day
 
1006
            if m.group('time'):
 
1007
                hour = int(m.group('hour'))
 
1008
                minute = int(m.group('minute'))
 
1009
                if m.group('second'):
 
1010
                    second = int(m.group('second'))
 
1011
                else:
 
1012
                    second = 0
 
1013
            else:
 
1014
                hour, minute, second = 0,0,0
 
1015
 
 
1016
            dt = datetime.datetime(year=year, month=month, day=day,
 
1017
                    hour=hour, minute=minute, second=second)
 
1018
        first = dt
 
1019
        last = None
 
1020
        reversed = False
 
1021
        if match_style == '-':
 
1022
            reversed = True
 
1023
        elif match_style == '=':
 
1024
            last = dt + datetime.timedelta(days=1)
 
1025
 
 
1026
        if reversed:
 
1027
            for i in range(len(revs)-1, -1, -1):
 
1028
                r = self.get_revision(revs[i])
 
1029
                # TODO: Handle timezone.
 
1030
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1031
                if first >= dt and (last is None or dt >= last):
 
1032
                    return (i+1,)
 
1033
        else:
 
1034
            for i in range(len(revs)):
 
1035
                r = self.get_revision(revs[i])
 
1036
                # TODO: Handle timezone.
 
1037
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1038
                if first <= dt and (last is None or dt <= last):
 
1039
                    return (i+1,)
 
1040
    REVISION_NAMESPACES['date:'] = _namespace_date
 
1041
 
 
1042
    def revision_tree(self, revision_id):
 
1043
        """Return Tree for a revision on this branch.
 
1044
 
 
1045
        `revision_id` may be None for the null revision, in which case
 
1046
        an `EmptyTree` is returned."""
 
1047
        # TODO: refactor this to use an existing revision object
 
1048
        # so we don't need to read it in twice.
 
1049
        if revision_id == None:
 
1050
            return EmptyTree()
 
1051
        else:
 
1052
            inv = self.get_revision_inventory(revision_id)
 
1053
            return RevisionTree(self.weave_store, inv, revision_id)
 
1054
 
 
1055
 
 
1056
    def working_tree(self):
 
1057
        """Return a `Tree` for the working copy."""
 
1058
        from workingtree import WorkingTree
 
1059
        return WorkingTree(self.base, self.read_working_inventory())
 
1060
 
523
1061
 
524
1062
    def basis_tree(self):
525
 
        """Return `Tree` object for last revision."""
526
 
        return self.repository.revision_tree(self.last_revision())
 
1063
        """Return `Tree` object for last revision.
 
1064
 
 
1065
        If there are no revisions yet, return an `EmptyTree`.
 
1066
        """
 
1067
        return self.revision_tree(self.last_patch())
 
1068
 
527
1069
 
528
1070
    def rename_one(self, from_rel, to_rel):
529
1071
        """Rename one file.
530
1072
 
531
1073
        This can change the directory or the filename or both.
532
1074
        """
533
 
        raise NotImplementedError(self.rename_one)
 
1075
        self.lock_write()
 
1076
        try:
 
1077
            tree = self.working_tree()
 
1078
            inv = tree.inventory
 
1079
            if not tree.has_filename(from_rel):
 
1080
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
1081
            if tree.has_filename(to_rel):
 
1082
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
1083
 
 
1084
            file_id = inv.path2id(from_rel)
 
1085
            if file_id == None:
 
1086
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
1087
 
 
1088
            if inv.path2id(to_rel):
 
1089
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
1090
 
 
1091
            to_dir, to_tail = os.path.split(to_rel)
 
1092
            to_dir_id = inv.path2id(to_dir)
 
1093
            if to_dir_id == None and to_dir != '':
 
1094
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
1095
 
 
1096
            mutter("rename_one:")
 
1097
            mutter("  file_id    {%s}" % file_id)
 
1098
            mutter("  from_rel   %r" % from_rel)
 
1099
            mutter("  to_rel     %r" % to_rel)
 
1100
            mutter("  to_dir     %r" % to_dir)
 
1101
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
1102
 
 
1103
            inv.rename(file_id, to_dir_id, to_tail)
 
1104
 
 
1105
            from_abs = self.abspath(from_rel)
 
1106
            to_abs = self.abspath(to_rel)
 
1107
            try:
 
1108
                os.rename(from_abs, to_abs)
 
1109
            except OSError, e:
 
1110
                raise BzrError("failed to rename %r to %r: %s"
 
1111
                        % (from_abs, to_abs, e[1]),
 
1112
                        ["rename rolled back"])
 
1113
 
 
1114
            self._write_inventory(inv)
 
1115
        finally:
 
1116
            self.unlock()
 
1117
 
534
1118
 
535
1119
    def move(self, from_paths, to_name):
536
1120
        """Rename files.
546
1130
        This returns a list of (from_path, to_path) pairs for each
547
1131
        entry that is moved.
548
1132
        """
549
 
        raise NotImplementedError(self.move)
 
1133
        result = []
 
1134
        self.lock_write()
 
1135
        try:
 
1136
            ## TODO: Option to move IDs only
 
1137
            assert not isinstance(from_paths, basestring)
 
1138
            tree = self.working_tree()
 
1139
            inv = tree.inventory
 
1140
            to_abs = self.abspath(to_name)
 
1141
            if not isdir(to_abs):
 
1142
                raise BzrError("destination %r is not a directory" % to_abs)
 
1143
            if not tree.has_filename(to_name):
 
1144
                raise BzrError("destination %r not in working directory" % to_abs)
 
1145
            to_dir_id = inv.path2id(to_name)
 
1146
            if to_dir_id == None and to_name != '':
 
1147
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
1148
            to_dir_ie = inv[to_dir_id]
 
1149
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1150
                raise BzrError("destination %r is not a directory" % to_abs)
 
1151
 
 
1152
            to_idpath = inv.get_idpath(to_dir_id)
 
1153
 
 
1154
            for f in from_paths:
 
1155
                if not tree.has_filename(f):
 
1156
                    raise BzrError("%r does not exist in working tree" % f)
 
1157
                f_id = inv.path2id(f)
 
1158
                if f_id == None:
 
1159
                    raise BzrError("%r is not versioned" % f)
 
1160
                name_tail = splitpath(f)[-1]
 
1161
                dest_path = appendpath(to_name, name_tail)
 
1162
                if tree.has_filename(dest_path):
 
1163
                    raise BzrError("destination %r already exists" % dest_path)
 
1164
                if f_id in to_idpath:
 
1165
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1166
 
 
1167
            # OK, so there's a race here, it's possible that someone will
 
1168
            # create a file in this interval and then the rename might be
 
1169
            # left half-done.  But we should have caught most problems.
 
1170
 
 
1171
            for f in from_paths:
 
1172
                name_tail = splitpath(f)[-1]
 
1173
                dest_path = appendpath(to_name, name_tail)
 
1174
                result.append((f, dest_path))
 
1175
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1176
                try:
 
1177
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
1178
                except OSError, e:
 
1179
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1180
                            ["rename rolled back"])
 
1181
 
 
1182
            self._write_inventory(inv)
 
1183
        finally:
 
1184
            self.unlock()
 
1185
 
 
1186
        return result
 
1187
 
 
1188
 
 
1189
    def revert(self, filenames, old_tree=None, backups=True):
 
1190
        """Restore selected files to the versions from a previous tree.
 
1191
 
 
1192
        backups
 
1193
            If true (default) backups are made of files before
 
1194
            they're renamed.
 
1195
        """
 
1196
        from bzrlib.errors import NotVersionedError, BzrError
 
1197
        from bzrlib.atomicfile import AtomicFile
 
1198
        from bzrlib.osutils import backup_file
 
1199
        
 
1200
        inv = self.read_working_inventory()
 
1201
        if old_tree is None:
 
1202
            old_tree = self.basis_tree()
 
1203
        old_inv = old_tree.inventory
 
1204
 
 
1205
        nids = []
 
1206
        for fn in filenames:
 
1207
            file_id = inv.path2id(fn)
 
1208
            if not file_id:
 
1209
                raise NotVersionedError("not a versioned file", fn)
 
1210
            if not old_inv.has_id(file_id):
 
1211
                raise BzrError("file not present in old tree", fn, file_id)
 
1212
            nids.append((fn, file_id))
 
1213
            
 
1214
        # TODO: Rename back if it was previously at a different location
 
1215
 
 
1216
        # TODO: If given a directory, restore the entire contents from
 
1217
        # the previous version.
 
1218
 
 
1219
        # TODO: Make a backup to a temporary file.
 
1220
 
 
1221
        # TODO: If the file previously didn't exist, delete it?
 
1222
        for fn, file_id in nids:
 
1223
            backup_file(fn)
 
1224
            
 
1225
            f = AtomicFile(fn, 'wb')
 
1226
            try:
 
1227
                f.write(old_tree.get_file(file_id).read())
 
1228
                f.commit()
 
1229
            finally:
 
1230
                f.close()
 
1231
 
 
1232
 
 
1233
    def pending_merges(self):
 
1234
        """Return a list of pending merges.
 
1235
 
 
1236
        These are revisions that have been merged into the working
 
1237
        directory but not yet committed.
 
1238
        """
 
1239
        cfn = self.controlfilename('pending-merges')
 
1240
        if not os.path.exists(cfn):
 
1241
            return []
 
1242
        p = []
 
1243
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1244
            p.append(l.rstrip('\n'))
 
1245
        return p
 
1246
 
 
1247
 
 
1248
    def add_pending_merge(self, revision_id):
 
1249
        from bzrlib.revision import validate_revision_id
 
1250
 
 
1251
        validate_revision_id(revision_id)
 
1252
 
 
1253
        p = self.pending_merges()
 
1254
        if revision_id in p:
 
1255
            return
 
1256
        p.append(revision_id)
 
1257
        self.set_pending_merges(p)
 
1258
 
 
1259
 
 
1260
    def set_pending_merges(self, rev_list):
 
1261
        from bzrlib.atomicfile import AtomicFile
 
1262
        self.lock_write()
 
1263
        try:
 
1264
            f = AtomicFile(self.controlfilename('pending-merges'))
 
1265
            try:
 
1266
                for l in rev_list:
 
1267
                    print >>f, l
 
1268
                f.commit()
 
1269
            finally:
 
1270
                f.close()
 
1271
        finally:
 
1272
            self.unlock()
 
1273
 
550
1274
 
551
1275
    def get_parent(self):
552
1276
        """Return the parent location of the branch.
555
1279
        pattern is that the user can override it by specifying a
556
1280
        location.
557
1281
        """
558
 
        raise NotImplementedError(self.get_parent)
559
 
 
560
 
    def _set_config_location(self, name, url, config=None,
561
 
                             make_relative=False):
562
 
        if config is None:
563
 
            config = self.get_config()
564
 
        if url is None:
565
 
            url = ''
566
 
        elif make_relative:
567
 
            url = urlutils.relative_url(self.base, url)
568
 
        config.set_user_option(name, url, warn_masked=True)
569
 
 
570
 
    def _get_config_location(self, name, config=None):
571
 
        if config is None:
572
 
            config = self.get_config()
573
 
        location = config.get_user_option(name)
574
 
        if location == '':
575
 
            location = None
576
 
        return location
577
 
 
578
 
    def get_submit_branch(self):
579
 
        """Return the submit location of the branch.
580
 
 
581
 
        This is the default location for bundle.  The usual
582
 
        pattern is that the user can override it by specifying a
583
 
        location.
584
 
        """
585
 
        return self.get_config().get_user_option('submit_branch')
586
 
 
587
 
    def set_submit_branch(self, location):
588
 
        """Return the submit location of the branch.
589
 
 
590
 
        This is the default location for bundle.  The usual
591
 
        pattern is that the user can override it by specifying a
592
 
        location.
593
 
        """
594
 
        self.get_config().set_user_option('submit_branch', location,
595
 
            warn_masked=True)
596
 
 
597
 
    def get_public_branch(self):
598
 
        """Return the public location of the branch.
599
 
 
600
 
        This is is used by merge directives.
601
 
        """
602
 
        return self._get_config_location('public_branch')
603
 
 
604
 
    def set_public_branch(self, location):
605
 
        """Return the submit location of the branch.
606
 
 
607
 
        This is the default location for bundle.  The usual
608
 
        pattern is that the user can override it by specifying a
609
 
        location.
610
 
        """
611
 
        self._set_config_location('public_branch', location)
612
 
 
613
 
    def get_push_location(self):
614
 
        """Return the None or the location to push this branch to."""
615
 
        push_loc = self.get_config().get_user_option('push_location')
616
 
        return push_loc
617
 
 
618
 
    def set_push_location(self, location):
619
 
        """Set a new push location for this branch."""
620
 
        raise NotImplementedError(self.set_push_location)
 
1282
        import errno
 
1283
        _locs = ['parent', 'pull', 'x-pull']
 
1284
        for l in _locs:
 
1285
            try:
 
1286
                return self.controlfile(l, 'r').read().strip('\n')
 
1287
            except IOError, e:
 
1288
                if e.errno != errno.ENOENT:
 
1289
                    raise
 
1290
        return None
 
1291
 
621
1292
 
622
1293
    def set_parent(self, url):
623
 
        raise NotImplementedError(self.set_parent)
624
 
 
625
 
    @needs_write_lock
626
 
    def update(self):
627
 
        """Synchronise this branch with the master branch if any. 
628
 
 
629
 
        :return: None or the last_revision pivoted out during the update.
630
 
        """
631
 
        return None
 
1294
        # TODO: Maybe delete old location files?
 
1295
        from bzrlib.atomicfile import AtomicFile
 
1296
        self.lock_write()
 
1297
        try:
 
1298
            f = AtomicFile(self.controlfilename('parent'))
 
1299
            try:
 
1300
                f.write(url + '\n')
 
1301
                f.commit()
 
1302
            finally:
 
1303
                f.close()
 
1304
        finally:
 
1305
            self.unlock()
632
1306
 
633
1307
    def check_revno(self, revno):
634
1308
        """\
645
1319
        """
646
1320
        if revno < 1 or revno > self.revno():
647
1321
            raise InvalidRevisionNumber(revno)
648
 
 
649
 
    @needs_read_lock
650
 
    def clone(self, to_bzrdir, revision_id=None):
651
 
        """Clone this branch into to_bzrdir preserving all semantic values.
652
 
        
653
 
        revision_id: if not None, the revision history in the new branch will
654
 
                     be truncated to end with revision_id.
655
 
        """
656
 
        result = self._format.initialize(to_bzrdir)
657
 
        self.copy_content_into(result, revision_id=revision_id)
658
 
        return  result
659
 
 
660
 
    @needs_read_lock
661
 
    def sprout(self, to_bzrdir, revision_id=None):
662
 
        """Create a new line of development from the branch, into to_bzrdir.
663
 
        
664
 
        revision_id: if not None, the revision history in the new branch will
665
 
                     be truncated to end with revision_id.
666
 
        """
667
 
        result = self._format.initialize(to_bzrdir)
668
 
        self.copy_content_into(result, revision_id=revision_id)
669
 
        result.set_parent(self.bzrdir.root_transport.base)
670
 
        return result
671
 
 
672
 
    def _synchronize_history(self, destination, revision_id):
673
 
        """Synchronize last revision and revision history between branches.
674
 
 
675
 
        This version is most efficient when the destination is also a
676
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
677
 
        history is the true lefthand parent history, and all of the revisions
678
 
        are in the destination's repository.  If not, set_revision_history
679
 
        will fail.
680
 
 
681
 
        :param destination: The branch to copy the history into
682
 
        :param revision_id: The revision-id to truncate history at.  May
683
 
          be None to copy complete history.
684
 
        """
685
 
        if revision_id == _mod_revision.NULL_REVISION:
686
 
            new_history = []
687
 
        new_history = self.revision_history()
688
 
        if revision_id is not None and new_history != []:
689
 
            revision_id = osutils.safe_revision_id(revision_id)
690
 
            try:
691
 
                new_history = new_history[:new_history.index(revision_id) + 1]
692
 
            except ValueError:
693
 
                rev = self.repository.get_revision(revision_id)
694
 
                new_history = rev.get_history(self.repository)[1:]
695
 
        destination.set_revision_history(new_history)
696
 
 
697
 
    @needs_read_lock
698
 
    def copy_content_into(self, destination, revision_id=None):
699
 
        """Copy the content of self into destination.
700
 
 
701
 
        revision_id: if not None, the revision history in the new branch will
702
 
                     be truncated to end with revision_id.
703
 
        """
704
 
        self._synchronize_history(destination, revision_id)
705
 
        try:
706
 
            parent = self.get_parent()
707
 
        except errors.InaccessibleParent, e:
708
 
            mutter('parent was not accessible to copy: %s', e)
709
 
        else:
710
 
            if parent:
711
 
                destination.set_parent(parent)
712
 
        self.tags.merge_to(destination.tags)
713
 
 
714
 
    @needs_read_lock
715
 
    def check(self):
716
 
        """Check consistency of the branch.
717
 
 
718
 
        In particular this checks that revisions given in the revision-history
719
 
        do actually match up in the revision graph, and that they're all 
720
 
        present in the repository.
721
 
        
722
 
        Callers will typically also want to check the repository.
723
 
 
724
 
        :return: A BranchCheckResult.
725
 
        """
726
 
        mainline_parent_id = None
727
 
        for revision_id in self.revision_history():
728
 
            try:
729
 
                revision = self.repository.get_revision(revision_id)
730
 
            except errors.NoSuchRevision, e:
731
 
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
732
 
                            % revision_id)
733
 
            # In general the first entry on the revision history has no parents.
734
 
            # But it's not illegal for it to have parents listed; this can happen
735
 
            # in imports from Arch when the parents weren't reachable.
736
 
            if mainline_parent_id is not None:
737
 
                if mainline_parent_id not in revision.parent_ids:
738
 
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
739
 
                                        "parents of {%s}"
740
 
                                        % (mainline_parent_id, revision_id))
741
 
            mainline_parent_id = revision_id
742
 
        return BranchCheckResult(self)
743
 
 
744
 
    def _get_checkout_format(self):
745
 
        """Return the most suitable metadir for a checkout of this branch.
746
 
        Weaves are used if this branch's repository uses weaves.
747
 
        """
748
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
749
 
            from bzrlib.repofmt import weaverepo
750
 
            format = bzrdir.BzrDirMetaFormat1()
751
 
            format.repository_format = weaverepo.RepositoryFormat7()
752
 
        else:
753
 
            format = self.repository.bzrdir.checkout_metadir()
754
 
            format.set_branch_format(self._format)
755
 
        return format
756
 
 
757
 
    def create_checkout(self, to_location, revision_id=None,
758
 
                        lightweight=False):
759
 
        """Create a checkout of a branch.
760
 
        
761
 
        :param to_location: The url to produce the checkout at
762
 
        :param revision_id: The revision to check out
763
 
        :param lightweight: If True, produce a lightweight checkout, otherwise,
764
 
        produce a bound branch (heavyweight checkout)
765
 
        :return: The tree of the created checkout
766
 
        """
767
 
        t = transport.get_transport(to_location)
768
 
        t.ensure_base()
769
 
        if lightweight:
770
 
            format = self._get_checkout_format()
771
 
            checkout = format.initialize_on_transport(t)
772
 
            BranchReferenceFormat().initialize(checkout, self)
773
 
        else:
774
 
            format = self._get_checkout_format()
775
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
776
 
                to_location, force_new_tree=False, format=format)
777
 
            checkout = checkout_branch.bzrdir
778
 
            checkout_branch.bind(self)
779
 
            # pull up to the specified revision_id to set the initial 
780
 
            # branch tip correctly, and seed it with history.
781
 
            checkout_branch.pull(self, stop_revision=revision_id)
782
 
        tree = checkout.create_workingtree(revision_id)
783
 
        basis_tree = tree.basis_tree()
784
 
        basis_tree.lock_read()
785
 
        try:
786
 
            for path, file_id in basis_tree.iter_references():
787
 
                reference_parent = self.reference_parent(file_id, path)
788
 
                reference_parent.create_checkout(tree.abspath(path),
789
 
                    basis_tree.get_reference_revision(file_id, path),
790
 
                    lightweight)
791
 
        finally:
792
 
            basis_tree.unlock()
793
 
        return tree
794
 
 
795
 
    def reference_parent(self, file_id, path):
796
 
        """Return the parent branch for a tree-reference file_id
797
 
        :param file_id: The file_id of the tree reference
798
 
        :param path: The path of the file_id in the tree
799
 
        :return: A branch associated with the file_id
800
 
        """
801
 
        # FIXME should provide multiple branches, based on config
802
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
803
 
 
804
 
    def supports_tags(self):
805
 
        return self._format.supports_tags()
806
 
 
807
 
 
808
 
class BranchFormat(object):
809
 
    """An encapsulation of the initialization and open routines for a format.
810
 
 
811
 
    Formats provide three things:
812
 
     * An initialization routine,
813
 
     * a format string,
814
 
     * an open routine.
815
 
 
816
 
    Formats are placed in an dict by their format string for reference 
817
 
    during branch opening. Its not required that these be instances, they
818
 
    can be classes themselves with class methods - it simply depends on 
819
 
    whether state is needed for a given format or not.
820
 
 
821
 
    Once a format is deprecated, just deprecate the initialize and open
822
 
    methods on the format class. Do not deprecate the object, as the 
823
 
    object will be created every time regardless.
824
 
    """
825
 
 
826
 
    _default_format = None
827
 
    """The default format used for new branches."""
828
 
 
829
 
    _formats = {}
830
 
    """The known formats."""
831
 
 
832
 
    def __eq__(self, other):
833
 
        return self.__class__ is other.__class__
834
 
 
835
 
    def __ne__(self, other):
836
 
        return not (self == other)
837
 
 
838
 
    @classmethod
839
 
    def find_format(klass, a_bzrdir):
840
 
        """Return the format for the branch object in a_bzrdir."""
841
 
        try:
842
 
            transport = a_bzrdir.get_branch_transport(None)
843
 
            format_string = transport.get("format").read()
844
 
            return klass._formats[format_string]
845
 
        except NoSuchFile:
846
 
            raise NotBranchError(path=transport.base)
847
 
        except KeyError:
848
 
            raise errors.UnknownFormatError(format=format_string)
849
 
 
850
 
    @classmethod
851
 
    def get_default_format(klass):
852
 
        """Return the current default format."""
853
 
        return klass._default_format
854
 
 
855
 
    def get_reference(self, a_bzrdir):
856
 
        """Get the target reference of the branch in a_bzrdir.
857
 
 
858
 
        format probing must have been completed before calling
859
 
        this method - it is assumed that the format of the branch
860
 
        in a_bzrdir is correct.
861
 
 
862
 
        :param a_bzrdir: The bzrdir to get the branch data from.
863
 
        :return: None if the branch is not a reference branch.
864
 
        """
865
 
        return None
866
 
 
867
 
    def get_format_string(self):
868
 
        """Return the ASCII format string that identifies this format."""
869
 
        raise NotImplementedError(self.get_format_string)
870
 
 
871
 
    def get_format_description(self):
872
 
        """Return the short format description for this format."""
873
 
        raise NotImplementedError(self.get_format_description)
874
 
 
875
 
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
876
 
                           set_format=True):
877
 
        """Initialize a branch in a bzrdir, with specified files
878
 
 
879
 
        :param a_bzrdir: The bzrdir to initialize the branch in
880
 
        :param utf8_files: The files to create as a list of
881
 
            (filename, content) tuples
882
 
        :param set_format: If True, set the format with
883
 
            self.get_format_string.  (BzrBranch4 has its format set
884
 
            elsewhere)
885
 
        :return: a branch in this format
886
 
        """
887
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
888
 
        branch_transport = a_bzrdir.get_branch_transport(self)
889
 
        lock_map = {
890
 
            'metadir': ('lock', lockdir.LockDir),
891
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
892
 
        }
893
 
        lock_name, lock_class = lock_map[lock_type]
894
 
        control_files = lockable_files.LockableFiles(branch_transport,
895
 
            lock_name, lock_class)
896
 
        control_files.create_lock()
897
 
        control_files.lock_write()
898
 
        if set_format:
899
 
            control_files.put_utf8('format', self.get_format_string())
900
 
        try:
901
 
            for file, content in utf8_files:
902
 
                control_files.put_utf8(file, content)
903
 
        finally:
904
 
            control_files.unlock()
905
 
        return self.open(a_bzrdir, _found=True)
906
 
 
907
 
    def initialize(self, a_bzrdir):
908
 
        """Create a branch of this format in a_bzrdir."""
909
 
        raise NotImplementedError(self.initialize)
910
 
 
911
 
    def is_supported(self):
912
 
        """Is this format supported?
913
 
 
914
 
        Supported formats can be initialized and opened.
915
 
        Unsupported formats may not support initialization or committing or 
916
 
        some other features depending on the reason for not being supported.
917
 
        """
918
 
        return True
919
 
 
920
 
    def open(self, a_bzrdir, _found=False):
921
 
        """Return the branch object for a_bzrdir
922
 
 
923
 
        _found is a private parameter, do not use it. It is used to indicate
924
 
               if format probing has already be done.
925
 
        """
926
 
        raise NotImplementedError(self.open)
927
 
 
928
 
    @classmethod
929
 
    def register_format(klass, format):
930
 
        klass._formats[format.get_format_string()] = format
931
 
 
932
 
    @classmethod
933
 
    def set_default_format(klass, format):
934
 
        klass._default_format = format
935
 
 
936
 
    @classmethod
937
 
    def unregister_format(klass, format):
938
 
        assert klass._formats[format.get_format_string()] is format
939
 
        del klass._formats[format.get_format_string()]
940
 
 
941
 
    def __str__(self):
942
 
        return self.get_format_string().rstrip()
943
 
 
944
 
    def supports_tags(self):
945
 
        """True if this format supports tags stored in the branch"""
946
 
        return False  # by default
947
 
 
948
 
    # XXX: Probably doesn't really belong here -- mbp 20070212
949
 
    def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
950
 
            lock_class):
951
 
        branch_transport = a_bzrdir.get_branch_transport(self)
952
 
        control_files = lockable_files.LockableFiles(branch_transport,
953
 
            lock_filename, lock_class)
954
 
        control_files.create_lock()
955
 
        control_files.lock_write()
956
 
        try:
957
 
            for filename, content in utf8_files:
958
 
                control_files.put_utf8(filename, content)
959
 
        finally:
960
 
            control_files.unlock()
961
 
 
962
 
 
963
 
class BranchHooks(Hooks):
964
 
    """A dictionary mapping hook name to a list of callables for branch hooks.
965
 
    
966
 
    e.g. ['set_rh'] Is the list of items to be called when the
967
 
    set_revision_history function is invoked.
968
 
    """
969
 
 
970
 
    def __init__(self):
971
 
        """Create the default hooks.
972
 
 
973
 
        These are all empty initially, because by default nothing should get
974
 
        notified.
975
 
        """
976
 
        Hooks.__init__(self)
977
 
        # Introduced in 0.15:
978
 
        # invoked whenever the revision history has been set
979
 
        # with set_revision_history. The api signature is
980
 
        # (branch, revision_history), and the branch will
981
 
        # be write-locked.
982
 
        self['set_rh'] = []
983
 
        # invoked after a push operation completes.
984
 
        # the api signature is
985
 
        # (push_result)
986
 
        # containing the members
987
 
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
988
 
        # where local is the local target branch or None, master is the target 
989
 
        # master branch, and the rest should be self explanatory. The source
990
 
        # is read locked and the target branches write locked. Source will
991
 
        # be the local low-latency branch.
992
 
        self['post_push'] = []
993
 
        # invoked after a pull operation completes.
994
 
        # the api signature is
995
 
        # (pull_result)
996
 
        # containing the members
997
 
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
998
 
        # where local is the local branch or None, master is the target 
999
 
        # master branch, and the rest should be self explanatory. The source
1000
 
        # is read locked and the target branches write locked. The local
1001
 
        # branch is the low-latency branch.
1002
 
        self['post_pull'] = []
1003
 
        # invoked before a commit operation takes place.
1004
 
        # the api signature is
1005
 
        # (local, master, old_revno, old_revid, future_revno, future_revid,
1006
 
        #  tree_delta, future_tree).
1007
 
        # old_revid is NULL_REVISION for the first commit to a branch
1008
 
        # tree_delta is a TreeDelta object describing changes from the basis
1009
 
        # revision, hooks MUST NOT modify this delta
1010
 
        # future_tree is an in-memory tree obtained from
1011
 
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1012
 
        self['pre_commit'] = []
1013
 
        # invoked after a commit operation completes.
1014
 
        # the api signature is 
1015
 
        # (local, master, old_revno, old_revid, new_revno, new_revid)
1016
 
        # old_revid is NULL_REVISION for the first commit to a branch.
1017
 
        self['post_commit'] = []
1018
 
        # invoked after a uncommit operation completes.
1019
 
        # the api signature is
1020
 
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
1021
 
        # local is the local branch or None, master is the target branch,
1022
 
        # and an empty branch recieves new_revno of 0, new_revid of None.
1023
 
        self['post_uncommit'] = []
1024
 
 
1025
 
 
1026
 
# install the default hooks into the Branch class.
1027
 
Branch.hooks = BranchHooks()
1028
 
 
1029
 
 
1030
 
class BzrBranchFormat4(BranchFormat):
1031
 
    """Bzr branch format 4.
1032
 
 
1033
 
    This format has:
1034
 
     - a revision-history file.
1035
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
1036
 
    """
1037
 
 
1038
 
    def get_format_description(self):
1039
 
        """See BranchFormat.get_format_description()."""
1040
 
        return "Branch format 4"
1041
 
 
1042
 
    def initialize(self, a_bzrdir):
1043
 
        """Create a branch of this format in a_bzrdir."""
1044
 
        utf8_files = [('revision-history', ''),
1045
 
                      ('branch-name', ''),
1046
 
                      ]
1047
 
        return self._initialize_helper(a_bzrdir, utf8_files,
1048
 
                                       lock_type='branch4', set_format=False)
1049
 
 
1050
 
    def __init__(self):
1051
 
        super(BzrBranchFormat4, self).__init__()
1052
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1053
 
 
1054
 
    def open(self, a_bzrdir, _found=False):
1055
 
        """Return the branch object for a_bzrdir
1056
 
 
1057
 
        _found is a private parameter, do not use it. It is used to indicate
1058
 
               if format probing has already be done.
1059
 
        """
1060
 
        if not _found:
1061
 
            # we are being called directly and must probe.
1062
 
            raise NotImplementedError
1063
 
        return BzrBranch(_format=self,
1064
 
                         _control_files=a_bzrdir._control_files,
1065
 
                         a_bzrdir=a_bzrdir,
1066
 
                         _repository=a_bzrdir.open_repository())
1067
 
 
1068
 
    def __str__(self):
1069
 
        return "Bazaar-NG branch format 4"
1070
 
 
1071
 
 
1072
 
class BzrBranchFormat5(BranchFormat):
1073
 
    """Bzr branch format 5.
1074
 
 
1075
 
    This format has:
1076
 
     - a revision-history file.
1077
 
     - a format string
1078
 
     - a lock dir guarding the branch itself
1079
 
     - all of this stored in a branch/ subdirectory
1080
 
     - works with shared repositories.
1081
 
 
1082
 
    This format is new in bzr 0.8.
1083
 
    """
1084
 
 
1085
 
    def get_format_string(self):
1086
 
        """See BranchFormat.get_format_string()."""
1087
 
        return "Bazaar-NG branch format 5\n"
1088
 
 
1089
 
    def get_format_description(self):
1090
 
        """See BranchFormat.get_format_description()."""
1091
 
        return "Branch format 5"
1092
 
        
1093
 
    def initialize(self, a_bzrdir):
1094
 
        """Create a branch of this format in a_bzrdir."""
1095
 
        utf8_files = [('revision-history', ''),
1096
 
                      ('branch-name', ''),
1097
 
                      ]
1098
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1099
 
 
1100
 
    def __init__(self):
1101
 
        super(BzrBranchFormat5, self).__init__()
1102
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1103
 
 
1104
 
    def open(self, a_bzrdir, _found=False):
1105
 
        """Return the branch object for a_bzrdir
1106
 
 
1107
 
        _found is a private parameter, do not use it. It is used to indicate
1108
 
               if format probing has already be done.
1109
 
        """
1110
 
        if not _found:
1111
 
            format = BranchFormat.find_format(a_bzrdir)
1112
 
            assert format.__class__ == self.__class__
1113
 
        try:
1114
 
            transport = a_bzrdir.get_branch_transport(None)
1115
 
            control_files = lockable_files.LockableFiles(transport, 'lock',
1116
 
                                                         lockdir.LockDir)
1117
 
            return BzrBranch5(_format=self,
1118
 
                              _control_files=control_files,
1119
 
                              a_bzrdir=a_bzrdir,
1120
 
                              _repository=a_bzrdir.find_repository())
1121
 
        except NoSuchFile:
1122
 
            raise NotBranchError(path=transport.base)
1123
 
 
1124
 
 
1125
 
class BzrBranchFormat6(BzrBranchFormat5):
1126
 
    """Branch format with last-revision and tags.
1127
 
 
1128
 
    Unlike previous formats, this has no explicit revision history. Instead,
1129
 
    this just stores the last-revision, and the left-hand history leading
1130
 
    up to there is the history.
1131
 
 
1132
 
    This format was introduced in bzr 0.15
1133
 
    and became the default in 0.91.
1134
 
    """
1135
 
 
1136
 
    def get_format_string(self):
1137
 
        """See BranchFormat.get_format_string()."""
1138
 
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
1139
 
 
1140
 
    def get_format_description(self):
1141
 
        """See BranchFormat.get_format_description()."""
1142
 
        return "Branch format 6"
1143
 
 
1144
 
    def initialize(self, a_bzrdir):
1145
 
        """Create a branch of this format in a_bzrdir."""
1146
 
        utf8_files = [('last-revision', '0 null:\n'),
1147
 
                      ('branch-name', ''),
1148
 
                      ('branch.conf', ''),
1149
 
                      ('tags', ''),
1150
 
                      ]
1151
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1152
 
 
1153
 
    def open(self, a_bzrdir, _found=False):
1154
 
        """Return the branch object for a_bzrdir
1155
 
 
1156
 
        _found is a private parameter, do not use it. It is used to indicate
1157
 
               if format probing has already be done.
1158
 
        """
1159
 
        if not _found:
1160
 
            format = BranchFormat.find_format(a_bzrdir)
1161
 
            assert format.__class__ == self.__class__
1162
 
        transport = a_bzrdir.get_branch_transport(None)
1163
 
        control_files = lockable_files.LockableFiles(transport, 'lock',
1164
 
                                                     lockdir.LockDir)
1165
 
        return BzrBranch6(_format=self,
1166
 
                          _control_files=control_files,
1167
 
                          a_bzrdir=a_bzrdir,
1168
 
                          _repository=a_bzrdir.find_repository())
1169
 
 
1170
 
    def supports_tags(self):
1171
 
        return True
1172
 
 
1173
 
 
1174
 
class BranchReferenceFormat(BranchFormat):
1175
 
    """Bzr branch reference format.
1176
 
 
1177
 
    Branch references are used in implementing checkouts, they
1178
 
    act as an alias to the real branch which is at some other url.
1179
 
 
1180
 
    This format has:
1181
 
     - A location file
1182
 
     - a format string
1183
 
    """
1184
 
 
1185
 
    def get_format_string(self):
1186
 
        """See BranchFormat.get_format_string()."""
1187
 
        return "Bazaar-NG Branch Reference Format 1\n"
1188
 
 
1189
 
    def get_format_description(self):
1190
 
        """See BranchFormat.get_format_description()."""
1191
 
        return "Checkout reference format 1"
1192
 
        
1193
 
    def get_reference(self, a_bzrdir):
1194
 
        """See BranchFormat.get_reference()."""
1195
 
        transport = a_bzrdir.get_branch_transport(None)
1196
 
        return transport.get('location').read()
1197
 
 
1198
 
    def initialize(self, a_bzrdir, target_branch=None):
1199
 
        """Create a branch of this format in a_bzrdir."""
1200
 
        if target_branch is None:
1201
 
            # this format does not implement branch itself, thus the implicit
1202
 
            # creation contract must see it as uninitializable
1203
 
            raise errors.UninitializableFormat(self)
1204
 
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1205
 
        branch_transport = a_bzrdir.get_branch_transport(self)
1206
 
        branch_transport.put_bytes('location',
1207
 
            target_branch.bzrdir.root_transport.base)
1208
 
        branch_transport.put_bytes('format', self.get_format_string())
1209
 
        return self.open(a_bzrdir, _found=True)
1210
 
 
1211
 
    def __init__(self):
1212
 
        super(BranchReferenceFormat, self).__init__()
1213
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1214
 
 
1215
 
    def _make_reference_clone_function(format, a_branch):
1216
 
        """Create a clone() routine for a branch dynamically."""
1217
 
        def clone(to_bzrdir, revision_id=None):
1218
 
            """See Branch.clone()."""
1219
 
            return format.initialize(to_bzrdir, a_branch)
1220
 
            # cannot obey revision_id limits when cloning a reference ...
1221
 
            # FIXME RBC 20060210 either nuke revision_id for clone, or
1222
 
            # emit some sort of warning/error to the caller ?!
1223
 
        return clone
1224
 
 
1225
 
    def open(self, a_bzrdir, _found=False, location=None):
1226
 
        """Return the branch that the branch reference in a_bzrdir points at.
1227
 
 
1228
 
        _found is a private parameter, do not use it. It is used to indicate
1229
 
               if format probing has already be done.
1230
 
        """
1231
 
        if not _found:
1232
 
            format = BranchFormat.find_format(a_bzrdir)
1233
 
            assert format.__class__ == self.__class__
1234
 
        if location is None:
1235
 
            location = self.get_reference(a_bzrdir)
1236
 
        real_bzrdir = bzrdir.BzrDir.open(location)
1237
 
        result = real_bzrdir.open_branch()
1238
 
        # this changes the behaviour of result.clone to create a new reference
1239
 
        # rather than a copy of the content of the branch.
1240
 
        # I did not use a proxy object because that needs much more extensive
1241
 
        # testing, and we are only changing one behaviour at the moment.
1242
 
        # If we decide to alter more behaviours - i.e. the implicit nickname
1243
 
        # then this should be refactored to introduce a tested proxy branch
1244
 
        # and a subclass of that for use in overriding clone() and ....
1245
 
        # - RBC 20060210
1246
 
        result.clone = self._make_reference_clone_function(result)
1247
 
        return result
1248
 
 
1249
 
 
1250
 
# formats which have no format string are not discoverable
1251
 
# and not independently creatable, so are not registered.
1252
 
__format5 = BzrBranchFormat5()
1253
 
__format6 = BzrBranchFormat6()
1254
 
BranchFormat.register_format(__format5)
1255
 
BranchFormat.register_format(BranchReferenceFormat())
1256
 
BranchFormat.register_format(__format6)
1257
 
BranchFormat.set_default_format(__format6)
1258
 
_legacy_formats = [BzrBranchFormat4(),
1259
 
                   ]
1260
 
 
1261
 
class BzrBranch(Branch):
1262
 
    """A branch stored in the actual filesystem.
1263
 
 
1264
 
    Note that it's "local" in the context of the filesystem; it doesn't
1265
 
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
1266
 
    it's writable, and can be accessed via the normal filesystem API.
1267
 
    """
1268
 
    
1269
 
    def __init__(self, _format=None,
1270
 
                 _control_files=None, a_bzrdir=None, _repository=None):
1271
 
        """Create new branch object at a particular location."""
1272
 
        Branch.__init__(self)
1273
 
        if a_bzrdir is None:
1274
 
            raise ValueError('a_bzrdir must be supplied')
1275
 
        else:
1276
 
            self.bzrdir = a_bzrdir
1277
 
        # self._transport used to point to the directory containing the
1278
 
        # control directory, but was not used - now it's just the transport
1279
 
        # for the branch control files.  mbp 20070212
1280
 
        self._base = self.bzrdir.transport.clone('..').base
1281
 
        self._format = _format
1282
 
        if _control_files is None:
1283
 
            raise ValueError('BzrBranch _control_files is None')
1284
 
        self.control_files = _control_files
1285
 
        self._transport = _control_files._transport
1286
 
        self.repository = _repository
1287
 
 
1288
 
    def __str__(self):
1289
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
1290
 
 
1291
 
    __repr__ = __str__
1292
 
 
1293
 
    def _get_base(self):
1294
 
        """Returns the directory containing the control directory."""
1295
 
        return self._base
1296
 
 
1297
 
    base = property(_get_base, doc="The URL for the root of this branch.")
1298
 
 
1299
 
    def abspath(self, name):
1300
 
        """See Branch.abspath."""
1301
 
        return self.control_files._transport.abspath(name)
1302
 
 
1303
 
 
1304
 
    @deprecated_method(zero_sixteen)
1305
 
    @needs_read_lock
1306
 
    def get_root_id(self):
1307
 
        """See Branch.get_root_id."""
1308
 
        tree = self.repository.revision_tree(self.last_revision())
1309
 
        return tree.inventory.root.file_id
1310
 
 
1311
 
    def is_locked(self):
1312
 
        return self.control_files.is_locked()
1313
 
 
1314
 
    def lock_write(self, token=None):
1315
 
        repo_token = self.repository.lock_write()
1316
 
        try:
1317
 
            token = self.control_files.lock_write(token=token)
1318
 
        except:
1319
 
            self.repository.unlock()
1320
 
            raise
1321
 
        return token
1322
 
 
1323
 
    def lock_read(self):
1324
 
        self.repository.lock_read()
1325
 
        try:
1326
 
            self.control_files.lock_read()
1327
 
        except:
1328
 
            self.repository.unlock()
1329
 
            raise
1330
 
 
1331
 
    def unlock(self):
1332
 
        # TODO: test for failed two phase locks. This is known broken.
1333
 
        try:
1334
 
            self.control_files.unlock()
1335
 
        finally:
1336
 
            self.repository.unlock()
1337
 
        if not self.control_files.is_locked():
1338
 
            # we just released the lock
1339
 
            self._clear_cached_state()
1340
 
        
1341
 
    def peek_lock_mode(self):
1342
 
        if self.control_files._lock_count == 0:
1343
 
            return None
1344
 
        else:
1345
 
            return self.control_files._lock_mode
1346
 
 
1347
 
    def get_physical_lock_status(self):
1348
 
        return self.control_files.get_physical_lock_status()
1349
 
 
1350
 
    @needs_read_lock
1351
 
    def print_file(self, file, revision_id):
1352
 
        """See Branch.print_file."""
1353
 
        return self.repository.print_file(file, revision_id)
1354
 
 
1355
 
    def _write_revision_history(self, history):
1356
 
        """Factored out of set_revision_history.
1357
 
 
1358
 
        This performs the actual writing to disk.
1359
 
        It is intended to be called by BzrBranch5.set_revision_history."""
1360
 
        self.control_files.put_bytes(
1361
 
            'revision-history', '\n'.join(history))
1362
 
 
1363
 
    @needs_write_lock
1364
 
    def set_revision_history(self, rev_history):
1365
 
        """See Branch.set_revision_history."""
1366
 
        rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1367
 
        self._clear_cached_state()
1368
 
        self._write_revision_history(rev_history)
1369
 
        self._cache_revision_history(rev_history)
1370
 
        for hook in Branch.hooks['set_rh']:
1371
 
            hook(self, rev_history)
1372
 
 
1373
 
    @needs_write_lock
1374
 
    def set_last_revision_info(self, revno, revision_id):
1375
 
        """Set the last revision of this branch.
1376
 
 
1377
 
        The caller is responsible for checking that the revno is correct
1378
 
        for this revision id.
1379
 
 
1380
 
        It may be possible to set the branch last revision to an id not
1381
 
        present in the repository.  However, branches can also be 
1382
 
        configured to check constraints on history, in which case this may not
1383
 
        be permitted.
1384
 
        """
1385
 
        revision_id = osutils.safe_revision_id(revision_id)
1386
 
        history = self._lefthand_history(revision_id)
1387
 
        assert len(history) == revno, '%d != %d' % (len(history), revno)
1388
 
        self.set_revision_history(history)
1389
 
 
1390
 
    def _gen_revision_history(self):
1391
 
        history = self.control_files.get('revision-history').read().split('\n')
1392
 
        if history[-1:] == ['']:
1393
 
            # There shouldn't be a trailing newline, but just in case.
1394
 
            history.pop()
1395
 
        return history
1396
 
 
1397
 
    def _lefthand_history(self, revision_id, last_rev=None,
1398
 
                          other_branch=None):
1399
 
        # stop_revision must be a descendant of last_revision
1400
 
        stop_graph = self.repository.get_revision_graph(revision_id)
1401
 
        if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1402
 
            and last_rev not in stop_graph):
1403
 
            # our previous tip is not merged into stop_revision
1404
 
            raise errors.DivergedBranches(self, other_branch)
1405
 
        # make a new revision history from the graph
1406
 
        current_rev_id = revision_id
1407
 
        new_history = []
1408
 
        while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1409
 
            new_history.append(current_rev_id)
1410
 
            current_rev_id_parents = stop_graph[current_rev_id]
1411
 
            try:
1412
 
                current_rev_id = current_rev_id_parents[0]
1413
 
            except IndexError:
1414
 
                current_rev_id = None
1415
 
        new_history.reverse()
1416
 
        return new_history
1417
 
 
1418
 
    @needs_write_lock
1419
 
    def generate_revision_history(self, revision_id, last_rev=None,
1420
 
        other_branch=None):
1421
 
        """Create a new revision history that will finish with revision_id.
1422
 
 
1423
 
        :param revision_id: the new tip to use.
1424
 
        :param last_rev: The previous last_revision. If not None, then this
1425
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
1426
 
        :param other_branch: The other branch that DivergedBranches should
1427
 
            raise with respect to.
1428
 
        """
1429
 
        revision_id = osutils.safe_revision_id(revision_id)
1430
 
        self.set_revision_history(self._lefthand_history(revision_id,
1431
 
            last_rev, other_branch))
1432
 
 
1433
 
    @needs_write_lock
1434
 
    def update_revisions(self, other, stop_revision=None):
1435
 
        """See Branch.update_revisions."""
1436
 
        other.lock_read()
1437
 
        try:
1438
 
            if stop_revision is None:
1439
 
                stop_revision = other.last_revision()
1440
 
                if stop_revision is None:
1441
 
                    # if there are no commits, we're done.
1442
 
                    return
1443
 
            else:
1444
 
                stop_revision = osutils.safe_revision_id(stop_revision)
1445
 
            # whats the current last revision, before we fetch [and change it
1446
 
            # possibly]
1447
 
            last_rev = _mod_revision.ensure_null(self.last_revision())
1448
 
            # we fetch here regardless of whether we need to so that we pickup
1449
 
            # filled in ghosts.
1450
 
            self.fetch(other, stop_revision)
1451
 
            if self.repository.get_graph().is_ancestor(stop_revision,
1452
 
                                                       last_rev):
1453
 
                return
1454
 
            self.generate_revision_history(stop_revision, last_rev=last_rev,
1455
 
                other_branch=other)
1456
 
        finally:
1457
 
            other.unlock()
1458
 
 
1459
 
    def basis_tree(self):
1460
 
        """See Branch.basis_tree."""
1461
 
        return self.repository.revision_tree(self.last_revision())
1462
 
 
1463
 
    @needs_write_lock
1464
 
    def pull(self, source, overwrite=False, stop_revision=None,
1465
 
             _hook_master=None, run_hooks=True):
1466
 
        """See Branch.pull.
1467
 
 
1468
 
        :param _hook_master: Private parameter - set the branch to 
1469
 
            be supplied as the master to push hooks.
1470
 
        :param run_hooks: Private parameter - if false, this branch
1471
 
            is being called because it's the master of the primary branch,
1472
 
            so it should not run its hooks.
1473
 
        """
1474
 
        result = PullResult()
1475
 
        result.source_branch = source
1476
 
        result.target_branch = self
1477
 
        source.lock_read()
1478
 
        try:
1479
 
            result.old_revno, result.old_revid = self.last_revision_info()
1480
 
            try:
1481
 
                self.update_revisions(source, stop_revision)
1482
 
            except DivergedBranches:
1483
 
                if not overwrite:
1484
 
                    raise
1485
 
            if overwrite:
1486
 
                if stop_revision is None:
1487
 
                    stop_revision = source.last_revision()
1488
 
                self.generate_revision_history(stop_revision)
1489
 
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1490
 
            result.new_revno, result.new_revid = self.last_revision_info()
1491
 
            if _hook_master:
1492
 
                result.master_branch = _hook_master
1493
 
                result.local_branch = self
1494
 
            else:
1495
 
                result.master_branch = self
1496
 
                result.local_branch = None
1497
 
            if run_hooks:
1498
 
                for hook in Branch.hooks['post_pull']:
1499
 
                    hook(result)
1500
 
        finally:
1501
 
            source.unlock()
1502
 
        return result
1503
 
 
1504
 
    def _get_parent_location(self):
1505
 
        _locs = ['parent', 'pull', 'x-pull']
1506
 
        for l in _locs:
1507
 
            try:
1508
 
                return self.control_files.get(l).read().strip('\n')
1509
 
            except NoSuchFile:
1510
 
                pass
1511
 
        return None
1512
 
 
1513
 
    @needs_read_lock
1514
 
    def push(self, target, overwrite=False, stop_revision=None,
1515
 
             _override_hook_source_branch=None):
1516
 
        """See Branch.push.
1517
 
 
1518
 
        This is the basic concrete implementation of push()
1519
 
 
1520
 
        :param _override_hook_source_branch: If specified, run
1521
 
        the hooks passing this Branch as the source, rather than self.  
1522
 
        This is for use of RemoteBranch, where push is delegated to the
1523
 
        underlying vfs-based Branch. 
1524
 
        """
1525
 
        # TODO: Public option to disable running hooks - should be trivial but
1526
 
        # needs tests.
1527
 
        target.lock_write()
1528
 
        try:
1529
 
            result = self._push_with_bound_branches(target, overwrite,
1530
 
                    stop_revision,
1531
 
                    _override_hook_source_branch=_override_hook_source_branch)
1532
 
            return result
1533
 
        finally:
1534
 
            target.unlock()
1535
 
 
1536
 
    def _push_with_bound_branches(self, target, overwrite,
1537
 
            stop_revision,
1538
 
            _override_hook_source_branch=None):
1539
 
        """Push from self into target, and into target's master if any.
1540
 
        
1541
 
        This is on the base BzrBranch class even though it doesn't support 
1542
 
        bound branches because the *target* might be bound.
1543
 
        """
1544
 
        def _run_hooks():
1545
 
            if _override_hook_source_branch:
1546
 
                result.source_branch = _override_hook_source_branch
1547
 
            for hook in Branch.hooks['post_push']:
1548
 
                hook(result)
1549
 
 
1550
 
        bound_location = target.get_bound_location()
1551
 
        if bound_location and target.base != bound_location:
1552
 
            # there is a master branch.
1553
 
            #
1554
 
            # XXX: Why the second check?  Is it even supported for a branch to
1555
 
            # be bound to itself? -- mbp 20070507
1556
 
            master_branch = target.get_master_branch()
1557
 
            master_branch.lock_write()
1558
 
            try:
1559
 
                # push into the master from this branch.
1560
 
                self._basic_push(master_branch, overwrite, stop_revision)
1561
 
                # and push into the target branch from this. Note that we push from
1562
 
                # this branch again, because its considered the highest bandwidth
1563
 
                # repository.
1564
 
                result = self._basic_push(target, overwrite, stop_revision)
1565
 
                result.master_branch = master_branch
1566
 
                result.local_branch = target
1567
 
                _run_hooks()
1568
 
                return result
1569
 
            finally:
1570
 
                master_branch.unlock()
1571
 
        else:
1572
 
            # no master branch
1573
 
            result = self._basic_push(target, overwrite, stop_revision)
1574
 
            # TODO: Why set master_branch and local_branch if there's no
1575
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
1576
 
            # 20070504
1577
 
            result.master_branch = target
1578
 
            result.local_branch = None
1579
 
            _run_hooks()
1580
 
            return result
1581
 
 
1582
 
    def _basic_push(self, target, overwrite, stop_revision):
1583
 
        """Basic implementation of push without bound branches or hooks.
1584
 
 
1585
 
        Must be called with self read locked and target write locked.
1586
 
        """
1587
 
        result = PushResult()
1588
 
        result.source_branch = self
1589
 
        result.target_branch = target
1590
 
        result.old_revno, result.old_revid = target.last_revision_info()
1591
 
        try:
1592
 
            target.update_revisions(self, stop_revision)
1593
 
        except DivergedBranches:
1594
 
            if not overwrite:
1595
 
                raise
1596
 
        if overwrite:
1597
 
            target.set_revision_history(self.revision_history())
1598
 
        result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1599
 
        result.new_revno, result.new_revid = target.last_revision_info()
1600
 
        return result
1601
 
 
1602
 
    def get_parent(self):
1603
 
        """See Branch.get_parent."""
1604
 
 
1605
 
        assert self.base[-1] == '/'
1606
 
        parent = self._get_parent_location()
1607
 
        if parent is None:
1608
 
            return parent
1609
 
        # This is an old-format absolute path to a local branch
1610
 
        # turn it into a url
1611
 
        if parent.startswith('/'):
1612
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1613
 
        try:
1614
 
            return urlutils.join(self.base[:-1], parent)
1615
 
        except errors.InvalidURLJoin, e:
1616
 
            raise errors.InaccessibleParent(parent, self.base)
1617
 
 
1618
 
    def set_push_location(self, location):
1619
 
        """See Branch.set_push_location."""
1620
 
        self.get_config().set_user_option(
1621
 
            'push_location', location,
1622
 
            store=_mod_config.STORE_LOCATION_NORECURSE)
1623
 
 
1624
 
    @needs_write_lock
1625
 
    def set_parent(self, url):
1626
 
        """See Branch.set_parent."""
1627
 
        # TODO: Maybe delete old location files?
1628
 
        # URLs should never be unicode, even on the local fs,
1629
 
        # FIXUP this and get_parent in a future branch format bump:
1630
 
        # read and rewrite the file, and have the new format code read
1631
 
        # using .get not .get_utf8. RBC 20060125
1632
 
        if url is not None:
1633
 
            if isinstance(url, unicode):
1634
 
                try: 
1635
 
                    url = url.encode('ascii')
1636
 
                except UnicodeEncodeError:
1637
 
                    raise errors.InvalidURL(url,
1638
 
                        "Urls must be 7-bit ascii, "
1639
 
                        "use bzrlib.urlutils.escape")
1640
 
            url = urlutils.relative_url(self.base, url)
1641
 
        self._set_parent_location(url)
1642
 
 
1643
 
    def _set_parent_location(self, url):
1644
 
        if url is None:
1645
 
            self.control_files._transport.delete('parent')
1646
 
        else:
1647
 
            assert isinstance(url, str)
1648
 
            self.control_files.put_bytes('parent', url + '\n')
1649
 
 
1650
 
 
1651
 
class BzrBranch5(BzrBranch):
1652
 
    """A format 5 branch. This supports new features over plain branches.
1653
 
 
1654
 
    It has support for a master_branch which is the data for bound branches.
1655
 
    """
1656
 
 
1657
 
    def __init__(self,
1658
 
                 _format,
1659
 
                 _control_files,
1660
 
                 a_bzrdir,
1661
 
                 _repository):
1662
 
        super(BzrBranch5, self).__init__(_format=_format,
1663
 
                                         _control_files=_control_files,
1664
 
                                         a_bzrdir=a_bzrdir,
1665
 
                                         _repository=_repository)
1666
 
        
1667
 
    @needs_write_lock
1668
 
    def pull(self, source, overwrite=False, stop_revision=None,
1669
 
             run_hooks=True):
1670
 
        """Pull from source into self, updating my master if any.
1671
 
        
1672
 
        :param run_hooks: Private parameter - if false, this branch
1673
 
            is being called because it's the master of the primary branch,
1674
 
            so it should not run its hooks.
1675
 
        """
1676
 
        bound_location = self.get_bound_location()
1677
 
        master_branch = None
1678
 
        if bound_location and source.base != bound_location:
1679
 
            # not pulling from master, so we need to update master.
1680
 
            master_branch = self.get_master_branch()
1681
 
            master_branch.lock_write()
1682
 
        try:
1683
 
            if master_branch:
1684
 
                # pull from source into master.
1685
 
                master_branch.pull(source, overwrite, stop_revision,
1686
 
                    run_hooks=False)
1687
 
            return super(BzrBranch5, self).pull(source, overwrite,
1688
 
                stop_revision, _hook_master=master_branch,
1689
 
                run_hooks=run_hooks)
1690
 
        finally:
1691
 
            if master_branch:
1692
 
                master_branch.unlock()
1693
 
 
1694
 
    def get_bound_location(self):
1695
 
        try:
1696
 
            return self.control_files.get_utf8('bound').read()[:-1]
1697
 
        except errors.NoSuchFile:
1698
 
            return None
1699
 
 
1700
 
    @needs_read_lock
1701
 
    def get_master_branch(self, possible_transports=None):
1702
 
        """Return the branch we are bound to.
1703
 
        
1704
 
        :return: Either a Branch, or None
1705
 
 
1706
 
        This could memoise the branch, but if thats done
1707
 
        it must be revalidated on each new lock.
1708
 
        So for now we just don't memoise it.
1709
 
        # RBC 20060304 review this decision.
1710
 
        """
1711
 
        bound_loc = self.get_bound_location()
1712
 
        if not bound_loc:
1713
 
            return None
1714
 
        try:
1715
 
            return Branch.open(bound_loc,
1716
 
                               possible_transports=possible_transports)
1717
 
        except (errors.NotBranchError, errors.ConnectionError), e:
1718
 
            raise errors.BoundBranchConnectionFailure(
1719
 
                    self, bound_loc, e)
1720
 
 
1721
 
    @needs_write_lock
1722
 
    def set_bound_location(self, location):
1723
 
        """Set the target where this branch is bound to.
1724
 
 
1725
 
        :param location: URL to the target branch
1726
 
        """
1727
 
        if location:
1728
 
            self.control_files.put_utf8('bound', location+'\n')
1729
 
        else:
1730
 
            try:
1731
 
                self.control_files._transport.delete('bound')
1732
 
            except NoSuchFile:
1733
 
                return False
 
1322
        
 
1323
        
 
1324
 
 
1325
 
 
1326
class ScratchBranch(Branch):
 
1327
    """Special test class: a branch that cleans up after itself.
 
1328
 
 
1329
    >>> b = ScratchBranch()
 
1330
    >>> isdir(b.base)
 
1331
    True
 
1332
    >>> bd = b.base
 
1333
    >>> b.destroy()
 
1334
    >>> isdir(bd)
 
1335
    False
 
1336
    """
 
1337
    def __init__(self, files=[], dirs=[], base=None):
 
1338
        """Make a test branch.
 
1339
 
 
1340
        This creates a temporary directory and runs init-tree in it.
 
1341
 
 
1342
        If any files are listed, they are created in the working copy.
 
1343
        """
 
1344
        from tempfile import mkdtemp
 
1345
        init = False
 
1346
        if base is None:
 
1347
            base = mkdtemp()
 
1348
            init = True
 
1349
        Branch.__init__(self, base, init=init)
 
1350
        for d in dirs:
 
1351
            os.mkdir(self.abspath(d))
 
1352
            
 
1353
        for f in files:
 
1354
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1355
 
 
1356
 
 
1357
    def clone(self):
 
1358
        """
 
1359
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1360
        >>> clone = orig.clone()
 
1361
        >>> os.path.samefile(orig.base, clone.base)
 
1362
        False
 
1363
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1364
        True
 
1365
        """
 
1366
        from shutil import copytree
 
1367
        from tempfile import mkdtemp
 
1368
        base = mkdtemp()
 
1369
        os.rmdir(base)
 
1370
        copytree(self.base, base, symlinks=True)
 
1371
        return ScratchBranch(base=base)
 
1372
 
 
1373
 
 
1374
        
 
1375
    def __del__(self):
 
1376
        self.destroy()
 
1377
 
 
1378
    def destroy(self):
 
1379
        """Destroy the test branch, removing the scratch directory."""
 
1380
        from shutil import rmtree
 
1381
        try:
 
1382
            if self.base:
 
1383
                mutter("delete ScratchBranch %s" % self.base)
 
1384
                rmtree(self.base)
 
1385
        except OSError, e:
 
1386
            # Work around for shutil.rmtree failing on Windows when
 
1387
            # readonly files are encountered
 
1388
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
1389
            for root, dirs, files in os.walk(self.base, topdown=False):
 
1390
                for name in files:
 
1391
                    os.chmod(os.path.join(root, name), 0700)
 
1392
            rmtree(self.base)
 
1393
        self.base = None
 
1394
 
 
1395
    
 
1396
 
 
1397
######################################################################
 
1398
# predicates
 
1399
 
 
1400
 
 
1401
def is_control_file(filename):
 
1402
    ## FIXME: better check
 
1403
    filename = os.path.normpath(filename)
 
1404
    while filename != '':
 
1405
        head, tail = os.path.split(filename)
 
1406
        ## mutter('check %r for control file' % ((head, tail), ))
 
1407
        if tail == bzrlib.BZRDIR:
1734
1408
            return True
1735
 
 
1736
 
    @needs_write_lock
1737
 
    def bind(self, other):
1738
 
        """Bind this branch to the branch other.
1739
 
 
1740
 
        This does not push or pull data between the branches, though it does
1741
 
        check for divergence to raise an error when the branches are not
1742
 
        either the same, or one a prefix of the other. That behaviour may not
1743
 
        be useful, so that check may be removed in future.
1744
 
        
1745
 
        :param other: The branch to bind to
1746
 
        :type other: Branch
1747
 
        """
1748
 
        # TODO: jam 20051230 Consider checking if the target is bound
1749
 
        #       It is debatable whether you should be able to bind to
1750
 
        #       a branch which is itself bound.
1751
 
        #       Committing is obviously forbidden,
1752
 
        #       but binding itself may not be.
1753
 
        #       Since we *have* to check at commit time, we don't
1754
 
        #       *need* to check here
1755
 
 
1756
 
        # we want to raise diverged if:
1757
 
        # last_rev is not in the other_last_rev history, AND
1758
 
        # other_last_rev is not in our history, and do it without pulling
1759
 
        # history around
1760
 
        last_rev = _mod_revision.ensure_null(self.last_revision())
1761
 
        if last_rev != _mod_revision.NULL_REVISION:
1762
 
            other.lock_read()
1763
 
            try:
1764
 
                other_last_rev = other.last_revision()
1765
 
                if not _mod_revision.is_null(other_last_rev):
1766
 
                    # neither branch is new, we have to do some work to
1767
 
                    # ascertain diversion.
1768
 
                    remote_graph = other.repository.get_revision_graph(
1769
 
                        other_last_rev)
1770
 
                    local_graph = self.repository.get_revision_graph(last_rev)
1771
 
                    if (last_rev not in remote_graph and
1772
 
                        other_last_rev not in local_graph):
1773
 
                        raise errors.DivergedBranches(self, other)
1774
 
            finally:
1775
 
                other.unlock()
1776
 
        self.set_bound_location(other.base)
1777
 
 
1778
 
    @needs_write_lock
1779
 
    def unbind(self):
1780
 
        """If bound, unbind"""
1781
 
        return self.set_bound_location(None)
1782
 
 
1783
 
    @needs_write_lock
1784
 
    def update(self, possible_transports=None):
1785
 
        """Synchronise this branch with the master branch if any. 
1786
 
 
1787
 
        :return: None or the last_revision that was pivoted out during the
1788
 
                 update.
1789
 
        """
1790
 
        master = self.get_master_branch(possible_transports)
1791
 
        if master is not None:
1792
 
            old_tip = _mod_revision.ensure_null(self.last_revision())
1793
 
            self.pull(master, overwrite=True)
1794
 
            if self.repository.get_graph().is_ancestor(old_tip,
1795
 
                _mod_revision.ensure_null(self.last_revision())):
1796
 
                return None
1797
 
            return old_tip
1798
 
        return None
1799
 
 
1800
 
 
1801
 
class BzrBranchExperimental(BzrBranch5):
1802
 
    """Bzr experimental branch format
1803
 
 
1804
 
    This format has:
1805
 
     - a revision-history file.
1806
 
     - a format string
1807
 
     - a lock dir guarding the branch itself
1808
 
     - all of this stored in a branch/ subdirectory
1809
 
     - works with shared repositories.
1810
 
     - a tag dictionary in the branch
1811
 
 
1812
 
    This format is new in bzr 0.15, but shouldn't be used for real data, 
1813
 
    only for testing.
1814
 
 
1815
 
    This class acts as it's own BranchFormat.
1816
 
    """
1817
 
 
1818
 
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1819
 
 
1820
 
    @classmethod
1821
 
    def get_format_string(cls):
1822
 
        """See BranchFormat.get_format_string()."""
1823
 
        return "Bazaar-NG branch format experimental\n"
1824
 
 
1825
 
    @classmethod
1826
 
    def get_format_description(cls):
1827
 
        """See BranchFormat.get_format_description()."""
1828
 
        return "Experimental branch format"
1829
 
 
1830
 
    @classmethod
1831
 
    def get_reference(cls, a_bzrdir):
1832
 
        """Get the target reference of the branch in a_bzrdir.
1833
 
 
1834
 
        format probing must have been completed before calling
1835
 
        this method - it is assumed that the format of the branch
1836
 
        in a_bzrdir is correct.
1837
 
 
1838
 
        :param a_bzrdir: The bzrdir to get the branch data from.
1839
 
        :return: None if the branch is not a reference branch.
1840
 
        """
1841
 
        return None
1842
 
 
1843
 
    @classmethod
1844
 
    def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1845
 
            lock_class):
1846
 
        branch_transport = a_bzrdir.get_branch_transport(cls)
1847
 
        control_files = lockable_files.LockableFiles(branch_transport,
1848
 
            lock_filename, lock_class)
1849
 
        control_files.create_lock()
1850
 
        control_files.lock_write()
1851
 
        try:
1852
 
            for filename, content in utf8_files:
1853
 
                control_files.put_utf8(filename, content)
1854
 
        finally:
1855
 
            control_files.unlock()
1856
 
        
1857
 
    @classmethod
1858
 
    def initialize(cls, a_bzrdir):
1859
 
        """Create a branch of this format in a_bzrdir."""
1860
 
        utf8_files = [('format', cls.get_format_string()),
1861
 
                      ('revision-history', ''),
1862
 
                      ('branch-name', ''),
1863
 
                      ('tags', ''),
1864
 
                      ]
1865
 
        cls._initialize_control_files(a_bzrdir, utf8_files,
1866
 
            'lock', lockdir.LockDir)
1867
 
        return cls.open(a_bzrdir, _found=True)
1868
 
 
1869
 
    @classmethod
1870
 
    def open(cls, a_bzrdir, _found=False):
1871
 
        """Return the branch object for a_bzrdir
1872
 
 
1873
 
        _found is a private parameter, do not use it. It is used to indicate
1874
 
               if format probing has already be done.
1875
 
        """
1876
 
        if not _found:
1877
 
            format = BranchFormat.find_format(a_bzrdir)
1878
 
            assert format.__class__ == cls
1879
 
        transport = a_bzrdir.get_branch_transport(None)
1880
 
        control_files = lockable_files.LockableFiles(transport, 'lock',
1881
 
                                                     lockdir.LockDir)
1882
 
        return cls(_format=cls,
1883
 
            _control_files=control_files,
1884
 
            a_bzrdir=a_bzrdir,
1885
 
            _repository=a_bzrdir.find_repository())
1886
 
 
1887
 
    @classmethod
1888
 
    def is_supported(cls):
1889
 
        return True
1890
 
 
1891
 
    def _make_tags(self):
1892
 
        return BasicTags(self)
1893
 
 
1894
 
    @classmethod
1895
 
    def supports_tags(cls):
1896
 
        return True
1897
 
 
1898
 
 
1899
 
BranchFormat.register_format(BzrBranchExperimental)
1900
 
 
1901
 
 
1902
 
class BzrBranch6(BzrBranch5):
1903
 
 
1904
 
    @needs_read_lock
1905
 
    def last_revision_info(self):
1906
 
        revision_string = self.control_files.get('last-revision').read()
1907
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1908
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
1909
 
        revno = int(revno)
1910
 
        return revno, revision_id
1911
 
 
1912
 
    def last_revision(self):
1913
 
        """Return last revision id, or None"""
1914
 
        revision_id = self.last_revision_info()[1]
1915
 
        return revision_id
1916
 
 
1917
 
    def _write_last_revision_info(self, revno, revision_id):
1918
 
        """Simply write out the revision id, with no checks.
1919
 
 
1920
 
        Use set_last_revision_info to perform this safely.
1921
 
 
1922
 
        Does not update the revision_history cache.
1923
 
        Intended to be called by set_last_revision_info and
1924
 
        _write_revision_history.
1925
 
        """
1926
 
        if revision_id is None:
1927
 
            revision_id = 'null:'
1928
 
        out_string = '%d %s\n' % (revno, revision_id)
1929
 
        self.control_files.put_bytes('last-revision', out_string)
1930
 
 
1931
 
    @needs_write_lock
1932
 
    def set_last_revision_info(self, revno, revision_id):
1933
 
        revision_id = osutils.safe_revision_id(revision_id)
1934
 
        if self._get_append_revisions_only():
1935
 
            self._check_history_violation(revision_id)
1936
 
        self._write_last_revision_info(revno, revision_id)
1937
 
        self._clear_cached_state()
1938
 
 
1939
 
    def _check_history_violation(self, revision_id):
1940
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
1941
 
        if _mod_revision.is_null(last_revision):
1942
 
            return
1943
 
        if last_revision not in self._lefthand_history(revision_id):
1944
 
            raise errors.AppendRevisionsOnlyViolation(self.base)
1945
 
 
1946
 
    def _gen_revision_history(self):
1947
 
        """Generate the revision history from last revision
1948
 
        """
1949
 
        history = list(self.repository.iter_reverse_revision_history(
1950
 
            self.last_revision()))
1951
 
        history.reverse()
1952
 
        return history
1953
 
 
1954
 
    def _write_revision_history(self, history):
1955
 
        """Factored out of set_revision_history.
1956
 
 
1957
 
        This performs the actual writing to disk, with format-specific checks.
1958
 
        It is intended to be called by BzrBranch5.set_revision_history.
1959
 
        """
1960
 
        if len(history) == 0:
1961
 
            last_revision = 'null:'
1962
 
        else:
1963
 
            if history != self._lefthand_history(history[-1]):
1964
 
                raise errors.NotLefthandHistory(history)
1965
 
            last_revision = history[-1]
1966
 
        if self._get_append_revisions_only():
1967
 
            self._check_history_violation(last_revision)
1968
 
        self._write_last_revision_info(len(history), last_revision)
1969
 
 
1970
 
    @needs_write_lock
1971
 
    def _set_parent_location(self, url):
1972
 
        """Set the parent branch"""
1973
 
        self._set_config_location('parent_location', url, make_relative=True)
1974
 
 
1975
 
    @needs_read_lock
1976
 
    def _get_parent_location(self):
1977
 
        """Set the parent branch"""
1978
 
        return self._get_config_location('parent_location')
1979
 
 
1980
 
    def set_push_location(self, location):
1981
 
        """See Branch.set_push_location."""
1982
 
        self._set_config_location('push_location', location)
1983
 
 
1984
 
    def set_bound_location(self, location):
1985
 
        """See Branch.set_push_location."""
1986
 
        result = None
1987
 
        config = self.get_config()
1988
 
        if location is None:
1989
 
            if config.get_user_option('bound') != 'True':
1990
 
                return False
1991
 
            else:
1992
 
                config.set_user_option('bound', 'False', warn_masked=True)
1993
 
                return True
1994
 
        else:
1995
 
            self._set_config_location('bound_location', location,
1996
 
                                      config=config)
1997
 
            config.set_user_option('bound', 'True', warn_masked=True)
1998
 
        return True
1999
 
 
2000
 
    def _get_bound_location(self, bound):
2001
 
        """Return the bound location in the config file.
2002
 
 
2003
 
        Return None if the bound parameter does not match"""
2004
 
        config = self.get_config()
2005
 
        config_bound = (config.get_user_option('bound') == 'True')
2006
 
        if config_bound != bound:
2007
 
            return None
2008
 
        return self._get_config_location('bound_location', config=config)
2009
 
 
2010
 
    def get_bound_location(self):
2011
 
        """See Branch.set_push_location."""
2012
 
        return self._get_bound_location(True)
2013
 
 
2014
 
    def get_old_bound_location(self):
2015
 
        """See Branch.get_old_bound_location"""
2016
 
        return self._get_bound_location(False)
2017
 
 
2018
 
    def set_append_revisions_only(self, enabled):
2019
 
        if enabled:
2020
 
            value = 'True'
2021
 
        else:
2022
 
            value = 'False'
2023
 
        self.get_config().set_user_option('append_revisions_only', value,
2024
 
            warn_masked=True)
2025
 
 
2026
 
    def _get_append_revisions_only(self):
2027
 
        value = self.get_config().get_user_option('append_revisions_only')
2028
 
        return value == 'True'
2029
 
 
2030
 
    def _synchronize_history(self, destination, revision_id):
2031
 
        """Synchronize last revision and revision history between branches.
2032
 
 
2033
 
        This version is most efficient when the destination is also a
2034
 
        BzrBranch6, but works for BzrBranch5, as long as the destination's
2035
 
        repository contains all the lefthand ancestors of the intended
2036
 
        last_revision.  If not, set_last_revision_info will fail.
2037
 
 
2038
 
        :param destination: The branch to copy the history into
2039
 
        :param revision_id: The revision-id to truncate history at.  May
2040
 
          be None to copy complete history.
2041
 
        """
2042
 
        source_revno, source_revision_id = self.last_revision_info()
2043
 
        if revision_id is None:
2044
 
            revno, revision_id = source_revno, source_revision_id
2045
 
        elif source_revision_id == revision_id:
2046
 
            # we know the revno without needing to walk all of history
2047
 
            revno = source_revno
2048
 
        else:
2049
 
            # To figure out the revno for a random revision, we need to build
2050
 
            # the revision history, and count its length.
2051
 
            # We don't care about the order, just how long it is.
2052
 
            # Alternatively, we could start at the current location, and count
2053
 
            # backwards. But there is no guarantee that we will find it since
2054
 
            # it may be a merged revision.
2055
 
            revno = len(list(self.repository.iter_reverse_revision_history(
2056
 
                                                                revision_id)))
2057
 
        destination.set_last_revision_info(revno, revision_id)
2058
 
 
2059
 
    def _make_tags(self):
2060
 
        return BasicTags(self)
2061
 
 
2062
 
 
2063
 
######################################################################
2064
 
# results of operations
2065
 
 
2066
 
 
2067
 
class _Result(object):
2068
 
 
2069
 
    def _show_tag_conficts(self, to_file):
2070
 
        if not getattr(self, 'tag_conflicts', None):
2071
 
            return
2072
 
        to_file.write('Conflicting tags:\n')
2073
 
        for name, value1, value2 in self.tag_conflicts:
2074
 
            to_file.write('    %s\n' % (name, ))
2075
 
 
2076
 
 
2077
 
class PullResult(_Result):
2078
 
    """Result of a Branch.pull operation.
2079
 
 
2080
 
    :ivar old_revno: Revision number before pull.
2081
 
    :ivar new_revno: Revision number after pull.
2082
 
    :ivar old_revid: Tip revision id before pull.
2083
 
    :ivar new_revid: Tip revision id after pull.
2084
 
    :ivar source_branch: Source (local) branch object.
2085
 
    :ivar master_branch: Master branch of the target, or None.
2086
 
    :ivar target_branch: Target/destination branch object.
2087
 
    """
2088
 
 
2089
 
    def __int__(self):
2090
 
        # DEPRECATED: pull used to return the change in revno
2091
 
        return self.new_revno - self.old_revno
2092
 
 
2093
 
    def report(self, to_file):
2094
 
        if self.old_revid == self.new_revid:
2095
 
            to_file.write('No revisions to pull.\n')
2096
 
        else:
2097
 
            to_file.write('Now on revision %d.\n' % self.new_revno)
2098
 
        self._show_tag_conficts(to_file)
2099
 
 
2100
 
 
2101
 
class PushResult(_Result):
2102
 
    """Result of a Branch.push operation.
2103
 
 
2104
 
    :ivar old_revno: Revision number before push.
2105
 
    :ivar new_revno: Revision number after push.
2106
 
    :ivar old_revid: Tip revision id before push.
2107
 
    :ivar new_revid: Tip revision id after push.
2108
 
    :ivar source_branch: Source branch object.
2109
 
    :ivar master_branch: Master branch of the target, or None.
2110
 
    :ivar target_branch: Target/destination branch object.
2111
 
    """
2112
 
 
2113
 
    def __int__(self):
2114
 
        # DEPRECATED: push used to return the change in revno
2115
 
        return self.new_revno - self.old_revno
2116
 
 
2117
 
    def report(self, to_file):
2118
 
        """Write a human-readable description of the result."""
2119
 
        if self.old_revid == self.new_revid:
2120
 
            to_file.write('No new revisions to push.\n')
2121
 
        else:
2122
 
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2123
 
        self._show_tag_conficts(to_file)
2124
 
 
2125
 
 
2126
 
class BranchCheckResult(object):
2127
 
    """Results of checking branch consistency.
2128
 
 
2129
 
    :see: Branch.check
2130
 
    """
2131
 
 
2132
 
    def __init__(self, branch):
2133
 
        self.branch = branch
2134
 
 
2135
 
    def report_results(self, verbose):
2136
 
        """Report the check results via trace.note.
2137
 
        
2138
 
        :param verbose: Requests more detailed display of what was checked,
2139
 
            if any.
2140
 
        """
2141
 
        note('checked branch %s format %s',
2142
 
             self.branch.base,
2143
 
             self.branch._format)
2144
 
 
2145
 
 
2146
 
class Converter5to6(object):
2147
 
    """Perform an in-place upgrade of format 5 to format 6"""
2148
 
 
2149
 
    def convert(self, branch):
2150
 
        # Data for 5 and 6 can peacefully coexist.
2151
 
        format = BzrBranchFormat6()
2152
 
        new_branch = format.open(branch.bzrdir, _found=True)
2153
 
 
2154
 
        # Copy source data into target
2155
 
        new_branch.set_last_revision_info(*branch.last_revision_info())
2156
 
        new_branch.set_parent(branch.get_parent())
2157
 
        new_branch.set_bound_location(branch.get_bound_location())
2158
 
        new_branch.set_push_location(branch.get_push_location())
2159
 
 
2160
 
        # New branch has no tags by default
2161
 
        new_branch.tags._set_tag_dict({})
2162
 
 
2163
 
        # Copying done; now update target format
2164
 
        new_branch.control_files.put_utf8('format',
2165
 
            format.get_format_string())
2166
 
 
2167
 
        # Clean up old files
2168
 
        new_branch.control_files._transport.delete('revision-history')
2169
 
        try:
2170
 
            branch.set_parent(None)
2171
 
        except NoSuchFile:
2172
 
            pass
2173
 
        branch.set_bound_location(None)
 
1409
        if filename == head:
 
1410
            break
 
1411
        filename = head
 
1412
    return False
 
1413
 
 
1414
 
 
1415
 
 
1416
def gen_file_id(name):
 
1417
    """Return new file id.
 
1418
 
 
1419
    This should probably generate proper UUIDs, but for the moment we
 
1420
    cope with just randomness because running uuidgen every time is
 
1421
    slow."""
 
1422
    import re
 
1423
    from binascii import hexlify
 
1424
    from time import time
 
1425
 
 
1426
    # get last component
 
1427
    idx = name.rfind('/')
 
1428
    if idx != -1:
 
1429
        name = name[idx+1 : ]
 
1430
    idx = name.rfind('\\')
 
1431
    if idx != -1:
 
1432
        name = name[idx+1 : ]
 
1433
 
 
1434
    # make it not a hidden file
 
1435
    name = name.lstrip('.')
 
1436
 
 
1437
    # remove any wierd characters; we don't escape them but rather
 
1438
    # just pull them out
 
1439
    name = re.sub(r'[^\w.]', '', name)
 
1440
 
 
1441
    s = hexlify(rand_bytes(8))
 
1442
    return '-'.join((name, compact_date(time()), s))
 
1443
 
 
1444
 
 
1445
def gen_root_id():
 
1446
    """Return a new tree-root file id."""
 
1447
    return gen_file_id('TREE_ROOT')
 
1448
 
 
1449
 
 
1450
def pull_loc(branch):
 
1451
    # TODO: Should perhaps just make attribute be 'base' in
 
1452
    # RemoteBranch and Branch?
 
1453
    if hasattr(branch, "baseurl"):
 
1454
        return branch.baseurl
 
1455
    else:
 
1456
        return branch.base
 
1457
 
 
1458
 
 
1459
def copy_branch(branch_from, to_location, revision=None):
 
1460
    """Copy branch_from into the existing directory to_location.
 
1461
 
 
1462
    revision
 
1463
        If not None, only revisions up to this point will be copied.
 
1464
        The head of the new branch will be that revision.
 
1465
 
 
1466
    to_location
 
1467
        The name of a local directory that exists but is empty.
 
1468
    """
 
1469
    from bzrlib.merge import merge
 
1470
    from bzrlib.branch import Branch
 
1471
 
 
1472
    assert isinstance(branch_from, Branch)
 
1473
    assert isinstance(to_location, basestring)
 
1474
    
 
1475
    br_to = Branch(to_location, init=True)
 
1476
    br_to.set_root_id(branch_from.get_root_id())
 
1477
    if revision is None:
 
1478
        revno = branch_from.revno()
 
1479
    else:
 
1480
        revno, rev_id = branch_from.get_revision_info(revision)
 
1481
    br_to.update_revisions(branch_from, stop_revision=revno)
 
1482
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
1483
          check_clean=False, ignore_zero=True)
 
1484
    
 
1485
    from_location = pull_loc(branch_from)
 
1486
    br_to.set_parent(pull_loc(branch_from))
 
1487