~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-05 10:27:33 UTC
  • mto: (5008.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5009.
  • Revision ID: v.ladeuil+lp@free.fr-20100205102733-8wpjnqz6g4nvrbfu
All Conflict action method names start with 'action_' to avoid potential namespace collisions

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
from sets import Set
19
 
 
20
 
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
 
import traceback, socket, fnmatch, difflib, time
22
 
from binascii import hexlify
23
 
 
24
 
import bzrlib
25
 
from inventory import Inventory
26
 
from trace import mutter, note
27
 
from tree import Tree, EmptyTree, RevisionTree
28
 
from inventory import InventoryEntry, Inventory
29
 
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
30
 
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
 
     joinpath, sha_string, file_kind, local_time_offset, appendpath
32
 
from store import ImmutableStore
33
 
from revision import Revision
34
 
from errors import bailout, BzrError
35
 
from textui import show_status
36
 
from diff import diff_trees
37
 
 
38
 
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
 
## TODO: Maybe include checks for common corruption of newlines, etc?
40
 
 
41
 
 
42
 
 
43
 
def find_branch(f, **args):
44
 
    if f and (f.startswith('http://') or f.startswith('https://')):
45
 
        import remotebranch 
46
 
        return remotebranch.RemoteBranch(f, **args)
47
 
    else:
48
 
        return Branch(f, **args)
49
 
        
50
 
 
51
 
def find_branch_root(f=None):
52
 
    """Find the branch root enclosing f, or pwd.
53
 
 
54
 
    f may be a filename or a URL.
55
 
 
56
 
    It is not necessary that f exists.
57
 
 
58
 
    Basically we keep looking up until we find the control directory or
59
 
    run into the root."""
60
 
    if f == None:
61
 
        f = os.getcwd()
62
 
    elif hasattr(os.path, 'realpath'):
63
 
        f = os.path.realpath(f)
64
 
    else:
65
 
        f = os.path.abspath(f)
66
 
    if not os.path.exists(f):
67
 
        raise BzrError('%r does not exist' % f)
68
 
        
69
 
 
70
 
    orig_f = f
71
 
 
72
 
    while True:
73
 
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
74
 
            return f
75
 
        head, tail = os.path.split(f)
76
 
        if head == f:
77
 
            # reached the root, whatever that may be
78
 
            raise BzrError('%r is not in a branch' % orig_f)
79
 
        f = head
80
 
    
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
 
 
18
from cStringIO import StringIO
 
19
import sys
 
20
 
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
 
23
from itertools import chain
 
24
from bzrlib import (
 
25
        bzrdir,
 
26
        cache_utf8,
 
27
        config as _mod_config,
 
28
        debug,
 
29
        errors,
 
30
        lockdir,
 
31
        lockable_files,
 
32
        repository,
 
33
        revision as _mod_revision,
 
34
        rio,
 
35
        symbol_versioning,
 
36
        transport,
 
37
        tsort,
 
38
        ui,
 
39
        urlutils,
 
40
        )
 
41
from bzrlib.config import BranchConfig, TransportConfig
 
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
 
43
from bzrlib.tag import (
 
44
    BasicTags,
 
45
    DisabledTags,
 
46
    )
 
47
""")
 
48
 
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
50
from bzrlib.hooks import HookPoint, Hooks
 
51
from bzrlib.inter import InterObject
 
52
from bzrlib.lock import _RelockDebugMixin
 
53
from bzrlib import registry
 
54
from bzrlib.symbol_versioning import (
 
55
    deprecated_in,
 
56
    deprecated_method,
 
57
    )
 
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
 
59
 
 
60
 
 
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
 
64
 
 
65
 
 
66
# TODO: Maybe include checks for common corruption of newlines, etc?
 
67
 
 
68
# TODO: Some operations like log might retrieve the same revisions
 
69
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
70
# cache in memory to make this faster.  In general anything can be
 
71
# cached in memory between lock and unlock operations. .. nb thats
 
72
# what the transaction identity map provides
81
73
 
82
74
 
83
75
######################################################################
84
76
# branch objects
85
77
 
86
 
class Branch:
 
78
class Branch(object):
87
79
    """Branch holding a history of revisions.
88
80
 
89
81
    base
90
 
        Base directory of the branch.
 
82
        Base directory/url of the branch.
 
83
 
 
84
    hooks: An instance of BranchHooks.
91
85
    """
92
 
    _lockmode = None
93
 
    
94
 
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
95
 
        """Create new branch object at a particular location.
96
 
 
97
 
        base -- Base directory for the branch.
98
 
        
99
 
        init -- If True, create new control files in a previously
100
 
             unversioned directory.  If False, the branch must already
101
 
             be versioned.
102
 
 
103
 
        find_root -- If true and init is false, find the root of the
104
 
             existing branch containing base.
105
 
 
106
 
        In the test suite, creation of new trees is tested using the
107
 
        `ScratchBranch` class.
108
 
        """
109
 
        if init:
110
 
            self.base = os.path.realpath(base)
111
 
            self._make_control()
112
 
        elif find_root:
113
 
            self.base = find_branch_root(base)
 
86
    # this is really an instance variable - FIXME move it there
 
87
    # - RBC 20060112
 
88
    base = None
 
89
 
 
90
    def __init__(self, *ignored, **ignored_too):
 
91
        self.tags = self._format.make_tags(self)
 
92
        self._revision_history_cache = None
 
93
        self._revision_id_to_revno_cache = None
 
94
        self._partial_revision_id_to_revno_cache = {}
 
95
        self._partial_revision_history_cache = []
 
96
        self._last_revision_info_cache = None
 
97
        self._merge_sorted_revisions_cache = None
 
98
        self._open_hook()
 
99
        hooks = Branch.hooks['open']
 
100
        for hook in hooks:
 
101
            hook(self)
 
102
 
 
103
    def _open_hook(self):
 
104
        """Called by init to allow simpler extension of the base class."""
 
105
 
 
106
    def _activate_fallback_location(self, url):
 
107
        """Activate the branch/repository from url as a fallback repository."""
 
108
        repo = self._get_fallback_repository(url)
 
109
        if repo.has_same_location(self.repository):
 
110
            raise errors.UnstackableLocationError(self.base, url)
 
111
        self.repository.add_fallback_repository(repo)
 
112
 
 
113
    def break_lock(self):
 
114
        """Break a lock if one is present from another instance.
 
115
 
 
116
        Uses the ui factory to ask for confirmation if the lock may be from
 
117
        an active process.
 
118
 
 
119
        This will probe the repository for its lock as well.
 
120
        """
 
121
        self.control_files.break_lock()
 
122
        self.repository.break_lock()
 
123
        master = self.get_master_branch()
 
124
        if master is not None:
 
125
            master.break_lock()
 
126
 
 
127
    def _check_stackable_repo(self):
 
128
        if not self.repository._format.supports_external_lookups:
 
129
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
130
                self.repository.base)
 
131
 
 
132
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
133
        """Extend the partial history to include a given index
 
134
 
 
135
        If a stop_index is supplied, stop when that index has been reached.
 
136
        If a stop_revision is supplied, stop when that revision is
 
137
        encountered.  Otherwise, stop when the beginning of history is
 
138
        reached.
 
139
 
 
140
        :param stop_index: The index which should be present.  When it is
 
141
            present, history extension will stop.
 
142
        :param stop_revision: The revision id which should be present.  When
 
143
            it is encountered, history extension will stop.
 
144
        """
 
145
        if len(self._partial_revision_history_cache) == 0:
 
146
            self._partial_revision_history_cache = [self.last_revision()]
 
147
        repository._iter_for_revno(
 
148
            self.repository, self._partial_revision_history_cache,
 
149
            stop_index=stop_index, stop_revision=stop_revision)
 
150
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
 
151
            self._partial_revision_history_cache.pop()
 
152
 
 
153
    def _get_check_refs(self):
 
154
        """Get the references needed for check().
 
155
 
 
156
        See bzrlib.check.
 
157
        """
 
158
        revid = self.last_revision()
 
159
        return [('revision-existence', revid), ('lefthand-distance', revid)]
 
160
 
 
161
    @staticmethod
 
162
    def open(base, _unsupported=False, possible_transports=None):
 
163
        """Open the branch rooted at base.
 
164
 
 
165
        For instance, if the branch is at URL/.bzr/branch,
 
166
        Branch.open(URL) -> a Branch instance.
 
167
        """
 
168
        control = bzrdir.BzrDir.open(base, _unsupported,
 
169
                                     possible_transports=possible_transports)
 
170
        return control.open_branch(_unsupported)
 
171
 
 
172
    @staticmethod
 
173
    def open_from_transport(transport, _unsupported=False):
 
174
        """Open the branch rooted at transport"""
 
175
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
 
176
        return control.open_branch(_unsupported)
 
177
 
 
178
    @staticmethod
 
179
    def open_containing(url, possible_transports=None):
 
180
        """Open an existing branch which contains url.
 
181
 
 
182
        This probes for a branch at url, and searches upwards from there.
 
183
 
 
184
        Basically we keep looking up until we find the control directory or
 
185
        run into the root.  If there isn't one, raises NotBranchError.
 
186
        If there is one and it is either an unrecognised format or an unsupported
 
187
        format, UnknownFormatError or UnsupportedFormatError are raised.
 
188
        If there is one, it is returned, along with the unused portion of url.
 
189
        """
 
190
        control, relpath = bzrdir.BzrDir.open_containing(url,
 
191
                                                         possible_transports)
 
192
        return control.open_branch(), relpath
 
193
 
 
194
    def _push_should_merge_tags(self):
 
195
        """Should _basic_push merge this branch's tags into the target?
 
196
 
 
197
        The default implementation returns False if this branch has no tags,
 
198
        and True the rest of the time.  Subclasses may override this.
 
199
        """
 
200
        return self.supports_tags() and self.tags.get_tag_dict()
 
201
 
 
202
    def get_config(self):
 
203
        return BranchConfig(self)
 
204
 
 
205
    def _get_config(self):
 
206
        """Get the concrete config for just the config in this branch.
 
207
 
 
208
        This is not intended for client use; see Branch.get_config for the
 
209
        public API.
 
210
 
 
211
        Added in 1.14.
 
212
 
 
213
        :return: An object supporting get_option and set_option.
 
214
        """
 
215
        raise NotImplementedError(self._get_config)
 
216
 
 
217
    def _get_fallback_repository(self, url):
 
218
        """Get the repository we fallback to at url."""
 
219
        url = urlutils.join(self.base, url)
 
220
        a_bzrdir = bzrdir.BzrDir.open(url,
 
221
            possible_transports=[self.bzrdir.root_transport])
 
222
        return a_bzrdir.open_branch().repository
 
223
 
 
224
    def _get_tags_bytes(self):
 
225
        """Get the bytes of a serialised tags dict.
 
226
 
 
227
        Note that not all branches support tags, nor do all use the same tags
 
228
        logic: this method is specific to BasicTags. Other tag implementations
 
229
        may use the same method name and behave differently, safely, because
 
230
        of the double-dispatch via
 
231
        format.make_tags->tags_instance->get_tags_dict.
 
232
 
 
233
        :return: The bytes of the tags file.
 
234
        :seealso: Branch._set_tags_bytes.
 
235
        """
 
236
        return self._transport.get_bytes('tags')
 
237
 
 
238
    def _get_nick(self, local=False, possible_transports=None):
 
239
        config = self.get_config()
 
240
        # explicit overrides master, but don't look for master if local is True
 
241
        if not local and not config.has_explicit_nickname():
 
242
            try:
 
243
                master = self.get_master_branch(possible_transports)
 
244
                if master is not None:
 
245
                    # return the master branch value
 
246
                    return master.nick
 
247
            except errors.BzrError, e:
 
248
                # Silently fall back to local implicit nick if the master is
 
249
                # unavailable
 
250
                mutter("Could not connect to bound branch, "
 
251
                    "falling back to local nick.\n " + str(e))
 
252
        return config.get_nickname()
 
253
 
 
254
    def _set_nick(self, nick):
 
255
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
 
256
 
 
257
    nick = property(_get_nick, _set_nick)
 
258
 
 
259
    def is_locked(self):
 
260
        raise NotImplementedError(self.is_locked)
 
261
 
 
262
    def _lefthand_history(self, revision_id, last_rev=None,
 
263
                          other_branch=None):
 
264
        if 'evil' in debug.debug_flags:
 
265
            mutter_callsite(4, "_lefthand_history scales with history.")
 
266
        # stop_revision must be a descendant of last_revision
 
267
        graph = self.repository.get_graph()
 
268
        if last_rev is not None:
 
269
            if not graph.is_ancestor(last_rev, revision_id):
 
270
                # our previous tip is not merged into stop_revision
 
271
                raise errors.DivergedBranches(self, other_branch)
 
272
        # make a new revision history from the graph
 
273
        parents_map = graph.get_parent_map([revision_id])
 
274
        if revision_id not in parents_map:
 
275
            raise errors.NoSuchRevision(self, revision_id)
 
276
        current_rev_id = revision_id
 
277
        new_history = []
 
278
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
279
        # Do not include ghosts or graph origin in revision_history
 
280
        while (current_rev_id in parents_map and
 
281
               len(parents_map[current_rev_id]) > 0):
 
282
            check_not_reserved_id(current_rev_id)
 
283
            new_history.append(current_rev_id)
 
284
            current_rev_id = parents_map[current_rev_id][0]
 
285
            parents_map = graph.get_parent_map([current_rev_id])
 
286
        new_history.reverse()
 
287
        return new_history
 
288
 
 
289
    def lock_write(self):
 
290
        raise NotImplementedError(self.lock_write)
 
291
 
 
292
    def lock_read(self):
 
293
        raise NotImplementedError(self.lock_read)
 
294
 
 
295
    def unlock(self):
 
296
        raise NotImplementedError(self.unlock)
 
297
 
 
298
    def peek_lock_mode(self):
 
299
        """Return lock mode for the Branch: 'r', 'w' or None"""
 
300
        raise NotImplementedError(self.peek_lock_mode)
 
301
 
 
302
    def get_physical_lock_status(self):
 
303
        raise NotImplementedError(self.get_physical_lock_status)
 
304
 
 
305
    @needs_read_lock
 
306
    def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
 
307
        """Return the revision_id for a dotted revno.
 
308
 
 
309
        :param revno: a tuple like (1,) or (1,1,2)
 
310
        :param _cache_reverse: a private parameter enabling storage
 
311
           of the reverse mapping in a top level cache. (This should
 
312
           only be done in selective circumstances as we want to
 
313
           avoid having the mapping cached multiple times.)
 
314
        :return: the revision_id
 
315
        :raises errors.NoSuchRevision: if the revno doesn't exist
 
316
        """
 
317
        rev_id = self._do_dotted_revno_to_revision_id(revno)
 
318
        if _cache_reverse:
 
319
            self._partial_revision_id_to_revno_cache[rev_id] = revno
 
320
        return rev_id
 
321
 
 
322
    def _do_dotted_revno_to_revision_id(self, revno):
 
323
        """Worker function for dotted_revno_to_revision_id.
 
324
 
 
325
        Subclasses should override this if they wish to
 
326
        provide a more efficient implementation.
 
327
        """
 
328
        if len(revno) == 1:
 
329
            return self.get_rev_id(revno[0])
 
330
        revision_id_to_revno = self.get_revision_id_to_revno_map()
 
331
        revision_ids = [revision_id for revision_id, this_revno
 
332
                        in revision_id_to_revno.iteritems()
 
333
                        if revno == this_revno]
 
334
        if len(revision_ids) == 1:
 
335
            return revision_ids[0]
114
336
        else:
115
 
            self.base = os.path.realpath(base)
116
 
            if not isdir(self.controlfilename('.')):
117
 
                bailout("not a bzr branch: %s" % quotefn(base),
118
 
                        ['use "bzr init" to initialize a new working tree',
119
 
                         'current bzr can only operate from top-of-tree'])
120
 
        self._check_format()
121
 
        self.lock(lock_mode)
122
 
 
123
 
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
124
 
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
125
 
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
126
 
 
127
 
 
128
 
    def __str__(self):
129
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
130
 
 
131
 
 
132
 
    __repr__ = __str__
133
 
 
134
 
 
135
 
 
136
 
    def lock(self, mode='w'):
137
 
        """Lock the on-disk branch, excluding other processes."""
 
337
            revno_str = '.'.join(map(str, revno))
 
338
            raise errors.NoSuchRevision(self, revno_str)
 
339
 
 
340
    @needs_read_lock
 
341
    def revision_id_to_dotted_revno(self, revision_id):
 
342
        """Given a revision id, return its dotted revno.
 
343
 
 
344
        :return: a tuple like (1,) or (400,1,3).
 
345
        """
 
346
        return self._do_revision_id_to_dotted_revno(revision_id)
 
347
 
 
348
    def _do_revision_id_to_dotted_revno(self, revision_id):
 
349
        """Worker function for revision_id_to_revno."""
 
350
        # Try the caches if they are loaded
 
351
        result = self._partial_revision_id_to_revno_cache.get(revision_id)
 
352
        if result is not None:
 
353
            return result
 
354
        if self._revision_id_to_revno_cache:
 
355
            result = self._revision_id_to_revno_cache.get(revision_id)
 
356
            if result is None:
 
357
                raise errors.NoSuchRevision(self, revision_id)
 
358
        # Try the mainline as it's optimised
138
359
        try:
139
 
            import fcntl, errno
140
 
 
141
 
            if mode == 'w':
142
 
                lm = fcntl.LOCK_EX
143
 
                om = os.O_WRONLY | os.O_CREAT
144
 
            elif mode == 'r':
145
 
                lm = fcntl.LOCK_SH
146
 
                om = os.O_RDONLY
 
360
            revno = self.revision_id_to_revno(revision_id)
 
361
            return (revno,)
 
362
        except errors.NoSuchRevision:
 
363
            # We need to load and use the full revno map after all
 
364
            result = self.get_revision_id_to_revno_map().get(revision_id)
 
365
            if result is None:
 
366
                raise errors.NoSuchRevision(self, revision_id)
 
367
        return result
 
368
 
 
369
    @needs_read_lock
 
370
    def get_revision_id_to_revno_map(self):
 
371
        """Return the revision_id => dotted revno map.
 
372
 
 
373
        This will be regenerated on demand, but will be cached.
 
374
 
 
375
        :return: A dictionary mapping revision_id => dotted revno.
 
376
            This dictionary should not be modified by the caller.
 
377
        """
 
378
        if self._revision_id_to_revno_cache is not None:
 
379
            mapping = self._revision_id_to_revno_cache
 
380
        else:
 
381
            mapping = self._gen_revno_map()
 
382
            self._cache_revision_id_to_revno(mapping)
 
383
        # TODO: jam 20070417 Since this is being cached, should we be returning
 
384
        #       a copy?
 
385
        # I would rather not, and instead just declare that users should not
 
386
        # modify the return value.
 
387
        return mapping
 
388
 
 
389
    def _gen_revno_map(self):
 
390
        """Create a new mapping from revision ids to dotted revnos.
 
391
 
 
392
        Dotted revnos are generated based on the current tip in the revision
 
393
        history.
 
394
        This is the worker function for get_revision_id_to_revno_map, which
 
395
        just caches the return value.
 
396
 
 
397
        :return: A dictionary mapping revision_id => dotted revno.
 
398
        """
 
399
        revision_id_to_revno = dict((rev_id, revno)
 
400
            for rev_id, depth, revno, end_of_merge
 
401
             in self.iter_merge_sorted_revisions())
 
402
        return revision_id_to_revno
 
403
 
 
404
    @needs_read_lock
 
405
    def iter_merge_sorted_revisions(self, start_revision_id=None,
 
406
            stop_revision_id=None, stop_rule='exclude', direction='reverse'):
 
407
        """Walk the revisions for a branch in merge sorted order.
 
408
 
 
409
        Merge sorted order is the output from a merge-aware,
 
410
        topological sort, i.e. all parents come before their
 
411
        children going forward; the opposite for reverse.
 
412
 
 
413
        :param start_revision_id: the revision_id to begin walking from.
 
414
            If None, the branch tip is used.
 
415
        :param stop_revision_id: the revision_id to terminate the walk
 
416
            after. If None, the rest of history is included.
 
417
        :param stop_rule: if stop_revision_id is not None, the precise rule
 
418
            to use for termination:
 
419
            * 'exclude' - leave the stop revision out of the result (default)
 
420
            * 'include' - the stop revision is the last item in the result
 
421
            * 'with-merges' - include the stop revision and all of its
 
422
              merged revisions in the result
 
423
        :param direction: either 'reverse' or 'forward':
 
424
            * reverse means return the start_revision_id first, i.e.
 
425
              start at the most recent revision and go backwards in history
 
426
            * forward returns tuples in the opposite order to reverse.
 
427
              Note in particular that forward does *not* do any intelligent
 
428
              ordering w.r.t. depth as some clients of this API may like.
 
429
              (If required, that ought to be done at higher layers.)
 
430
 
 
431
        :return: an iterator over (revision_id, depth, revno, end_of_merge)
 
432
            tuples where:
 
433
 
 
434
            * revision_id: the unique id of the revision
 
435
            * depth: How many levels of merging deep this node has been
 
436
              found.
 
437
            * revno_sequence: This field provides a sequence of
 
438
              revision numbers for all revisions. The format is:
 
439
              (REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
 
440
              branch that the revno is on. From left to right the REVNO numbers
 
441
              are the sequence numbers within that branch of the revision.
 
442
            * end_of_merge: When True the next node (earlier in history) is
 
443
              part of a different merge.
 
444
        """
 
445
        # Note: depth and revno values are in the context of the branch so
 
446
        # we need the full graph to get stable numbers, regardless of the
 
447
        # start_revision_id.
 
448
        if self._merge_sorted_revisions_cache is None:
 
449
            last_revision = self.last_revision()
 
450
            last_key = (last_revision,)
 
451
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
452
                [last_key])
 
453
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
 
454
                last_key)
 
455
        filtered = self._filter_merge_sorted_revisions(
 
456
            self._merge_sorted_revisions_cache, start_revision_id,
 
457
            stop_revision_id, stop_rule)
 
458
        if direction == 'reverse':
 
459
            return filtered
 
460
        if direction == 'forward':
 
461
            return reversed(list(filtered))
 
462
        else:
 
463
            raise ValueError('invalid direction %r' % direction)
 
464
 
 
465
    def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
 
466
        start_revision_id, stop_revision_id, stop_rule):
 
467
        """Iterate over an inclusive range of sorted revisions."""
 
468
        rev_iter = iter(merge_sorted_revisions)
 
469
        if start_revision_id is not None:
 
470
            for node in rev_iter:
 
471
                rev_id = node.key[-1]
 
472
                if rev_id != start_revision_id:
 
473
                    continue
 
474
                else:
 
475
                    # The decision to include the start or not
 
476
                    # depends on the stop_rule if a stop is provided
 
477
                    # so pop this node back into the iterator
 
478
                    rev_iter = chain(iter([node]), rev_iter)
 
479
                    break
 
480
        if stop_revision_id is None:
 
481
            # Yield everything
 
482
            for node in rev_iter:
 
483
                rev_id = node.key[-1]
 
484
                yield (rev_id, node.merge_depth, node.revno,
 
485
                       node.end_of_merge)
 
486
        elif stop_rule == 'exclude':
 
487
            for node in rev_iter:
 
488
                rev_id = node.key[-1]
 
489
                if rev_id == stop_revision_id:
 
490
                    return
 
491
                yield (rev_id, node.merge_depth, node.revno,
 
492
                       node.end_of_merge)
 
493
        elif stop_rule == 'include':
 
494
            for node in rev_iter:
 
495
                rev_id = node.key[-1]
 
496
                yield (rev_id, node.merge_depth, node.revno,
 
497
                       node.end_of_merge)
 
498
                if rev_id == stop_revision_id:
 
499
                    return
 
500
        elif stop_rule == 'with-merges':
 
501
            stop_rev = self.repository.get_revision(stop_revision_id)
 
502
            if stop_rev.parent_ids:
 
503
                left_parent = stop_rev.parent_ids[0]
147
504
            else:
148
 
                raise BzrError("invalid locking mode %r" % mode)
149
 
 
150
 
            try:
151
 
                lockfile = os.open(self.controlfilename('branch-lock'), om)
152
 
            except OSError, e:
153
 
                if e.errno == errno.ENOENT:
154
 
                    # might not exist on branches from <0.0.4
155
 
                    self.controlfile('branch-lock', 'w').close()
156
 
                    lockfile = os.open(self.controlfilename('branch-lock'), om)
157
 
                else:
158
 
                    raise e
159
 
            
160
 
            fcntl.lockf(lockfile, lm)
161
 
            def unlock():
162
 
                fcntl.lockf(lockfile, fcntl.LOCK_UN)
163
 
                os.close(lockfile)
164
 
                self._lockmode = None
165
 
            self.unlock = unlock
166
 
            self._lockmode = mode
167
 
        except ImportError:
168
 
            warning("please write a locking method for platform %r" % sys.platform)
169
 
            def unlock():
170
 
                self._lockmode = None
171
 
            self.unlock = unlock
172
 
            self._lockmode = mode
173
 
 
174
 
 
175
 
    def _need_readlock(self):
176
 
        if self._lockmode not in ['r', 'w']:
177
 
            raise BzrError('need read lock on branch, only have %r' % self._lockmode)
178
 
 
179
 
    def _need_writelock(self):
180
 
        if self._lockmode not in ['w']:
181
 
            raise BzrError('need write lock on branch, only have %r' % self._lockmode)
182
 
 
183
 
 
184
 
    def abspath(self, name):
185
 
        """Return absolute filename for something in the branch"""
186
 
        return os.path.join(self.base, name)
187
 
 
188
 
 
189
 
    def relpath(self, path):
190
 
        """Return path relative to this branch of something inside it.
191
 
 
192
 
        Raises an error if path is not in this branch."""
193
 
        rp = os.path.realpath(path)
194
 
        # FIXME: windows
195
 
        if not rp.startswith(self.base):
196
 
            bailout("path %r is not within branch %r" % (rp, self.base))
197
 
        rp = rp[len(self.base):]
198
 
        rp = rp.lstrip(os.sep)
199
 
        return rp
200
 
 
201
 
 
202
 
    def controlfilename(self, file_or_path):
203
 
        """Return location relative to branch."""
204
 
        if isinstance(file_or_path, types.StringTypes):
205
 
            file_or_path = [file_or_path]
206
 
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
207
 
 
208
 
 
209
 
    def controlfile(self, file_or_path, mode='r'):
210
 
        """Open a control file for this branch.
211
 
 
212
 
        There are two classes of file in the control directory: text
213
 
        and binary.  binary files are untranslated byte streams.  Text
214
 
        control files are stored with Unix newlines and in UTF-8, even
215
 
        if the platform or locale defaults are different.
216
 
 
217
 
        Controlfiles should almost never be opened in write mode but
218
 
        rather should be atomically copied and replaced using atomicfile.
219
 
        """
220
 
 
221
 
        fn = self.controlfilename(file_or_path)
222
 
 
223
 
        if mode == 'rb' or mode == 'wb':
224
 
            return file(fn, mode)
225
 
        elif mode == 'r' or mode == 'w':
226
 
            # open in binary mode anyhow so there's no newline translation;
227
 
            # codecs uses line buffering by default; don't want that.
228
 
            import codecs
229
 
            return codecs.open(fn, mode + 'b', 'utf-8',
230
 
                               buffering=60000)
231
 
        else:
232
 
            raise BzrError("invalid controlfile mode %r" % mode)
233
 
 
234
 
 
235
 
 
236
 
    def _make_control(self):
237
 
        os.mkdir(self.controlfilename([]))
238
 
        self.controlfile('README', 'w').write(
239
 
            "This is a Bazaar-NG control directory.\n"
240
 
            "Do not change any files in this directory.")
241
 
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
242
 
        for d in ('text-store', 'inventory-store', 'revision-store'):
243
 
            os.mkdir(self.controlfilename(d))
244
 
        for f in ('revision-history', 'merged-patches',
245
 
                  'pending-merged-patches', 'branch-name',
246
 
                  'branch-lock'):
247
 
            self.controlfile(f, 'w').write('')
248
 
        mutter('created control directory in ' + self.base)
249
 
        Inventory().write_xml(self.controlfile('inventory','w'))
250
 
 
251
 
 
252
 
    def _check_format(self):
253
 
        """Check this branch format is supported.
254
 
 
255
 
        The current tool only supports the current unstable format.
256
 
 
257
 
        In the future, we might need different in-memory Branch
258
 
        classes to support downlevel branches.  But not yet.
259
 
        """
260
 
        # This ignores newlines so that we can open branches created
261
 
        # on Windows from Linux and so on.  I think it might be better
262
 
        # to always make all internal files in unix format.
263
 
        fmt = self.controlfile('branch-format', 'r').read()
264
 
        fmt.replace('\r\n', '')
265
 
        if fmt != BZR_BRANCH_FORMAT:
266
 
            bailout('sorry, branch format %r not supported' % fmt,
267
 
                    ['use a different bzr version',
268
 
                     'or remove the .bzr directory and "bzr init" again'])
269
 
 
270
 
 
271
 
    def read_working_inventory(self):
272
 
        """Read the working inventory."""
273
 
        self._need_readlock()
274
 
        before = time.time()
275
 
        # ElementTree does its own conversion from UTF-8, so open in
276
 
        # binary.
277
 
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
278
 
        mutter("loaded inventory of %d items in %f"
279
 
               % (len(inv), time.time() - before))
280
 
        return inv
281
 
 
282
 
 
283
 
    def _write_inventory(self, inv):
284
 
        """Update the working inventory.
285
 
 
286
 
        That is to say, the inventory describing changes underway, that
287
 
        will be committed to the next revision.
288
 
        """
289
 
        self._need_writelock()
290
 
        ## TODO: factor out to atomicfile?  is rename safe on windows?
291
 
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
292
 
        tmpfname = self.controlfilename('inventory.tmp')
293
 
        tmpf = file(tmpfname, 'wb')
294
 
        inv.write_xml(tmpf)
295
 
        tmpf.close()
296
 
        inv_fname = self.controlfilename('inventory')
297
 
        if sys.platform == 'win32':
298
 
            os.remove(inv_fname)
299
 
        os.rename(tmpfname, inv_fname)
300
 
        mutter('wrote working inventory')
301
 
 
302
 
 
303
 
    inventory = property(read_working_inventory, _write_inventory, None,
304
 
                         """Inventory for the working copy.""")
305
 
 
306
 
 
307
 
    def add(self, files, verbose=False):
308
 
        """Make files versioned.
309
 
 
310
 
        Note that the command line normally calls smart_add instead.
311
 
 
312
 
        This puts the files in the Added state, so that they will be
313
 
        recorded by the next commit.
314
 
 
315
 
        TODO: Perhaps have an option to add the ids even if the files do
316
 
               not (yet) exist.
317
 
 
318
 
        TODO: Perhaps return the ids of the files?  But then again it
319
 
               is easy to retrieve them if they're needed.
320
 
 
321
 
        TODO: Option to specify file id.
322
 
 
323
 
        TODO: Adding a directory should optionally recurse down and
324
 
               add all non-ignored children.  Perhaps do that in a
325
 
               higher-level method.
326
 
 
327
 
        >>> b = ScratchBranch(files=['foo'])
328
 
        >>> 'foo' in b.unknowns()
329
 
        True
330
 
        >>> b.show_status()
331
 
        ?       foo
332
 
        >>> b.add('foo')
333
 
        >>> 'foo' in b.unknowns()
334
 
        False
335
 
        >>> bool(b.inventory.path2id('foo'))
336
 
        True
337
 
        >>> b.show_status()
338
 
        A       foo
339
 
 
340
 
        >>> b.add('foo')
341
 
        Traceback (most recent call last):
342
 
        ...
343
 
        BzrError: ('foo is already versioned', [])
344
 
 
345
 
        >>> b.add(['nothere'])
346
 
        Traceback (most recent call last):
347
 
        BzrError: ('cannot add: not a regular file or directory: nothere', [])
348
 
        """
349
 
        self._need_writelock()
350
 
 
351
 
        # TODO: Re-adding a file that is removed in the working copy
352
 
        # should probably put it back with the previous ID.
353
 
        if isinstance(files, types.StringTypes):
354
 
            files = [files]
355
 
        
356
 
        inv = self.read_working_inventory()
357
 
        for f in files:
358
 
            if is_control_file(f):
359
 
                bailout("cannot add control file %s" % quotefn(f))
360
 
 
361
 
            fp = splitpath(f)
362
 
 
363
 
            if len(fp) == 0:
364
 
                bailout("cannot add top-level %r" % f)
365
 
                
366
 
            fullpath = os.path.normpath(self.abspath(f))
367
 
 
368
 
            try:
369
 
                kind = file_kind(fullpath)
370
 
            except OSError:
371
 
                # maybe something better?
372
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
373
 
            
374
 
            if kind != 'file' and kind != 'directory':
375
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
376
 
 
377
 
            file_id = gen_file_id(f)
378
 
            inv.add_path(f, kind=kind, file_id=file_id)
379
 
 
380
 
            if verbose:
381
 
                show_status('A', kind, quotefn(f))
382
 
                
383
 
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
384
 
            
385
 
        self._write_inventory(inv)
386
 
 
387
 
 
388
 
    def print_file(self, file, revno):
 
505
                left_parent = _mod_revision.NULL_REVISION
 
506
            # left_parent is the actual revision we want to stop logging at,
 
507
            # since we want to show the merged revisions after the stop_rev too
 
508
            reached_stop_revision_id = False
 
509
            revision_id_whitelist = []
 
510
            for node in rev_iter:
 
511
                rev_id = node.key[-1]
 
512
                if rev_id == left_parent:
 
513
                    # reached the left parent after the stop_revision
 
514
                    return
 
515
                if (not reached_stop_revision_id or
 
516
                        rev_id in revision_id_whitelist):
 
517
                    yield (rev_id, node.merge_depth, node.revno,
 
518
                       node.end_of_merge)
 
519
                    if reached_stop_revision_id or rev_id == stop_revision_id:
 
520
                        # only do the merged revs of rev_id from now on
 
521
                        rev = self.repository.get_revision(rev_id)
 
522
                        if rev.parent_ids:
 
523
                            reached_stop_revision_id = True
 
524
                            revision_id_whitelist.extend(rev.parent_ids)
 
525
        else:
 
526
            raise ValueError('invalid stop_rule %r' % stop_rule)
 
527
 
 
528
    def leave_lock_in_place(self):
 
529
        """Tell this branch object not to release the physical lock when this
 
530
        object is unlocked.
 
531
 
 
532
        If lock_write doesn't return a token, then this method is not supported.
 
533
        """
 
534
        self.control_files.leave_in_place()
 
535
 
 
536
    def dont_leave_lock_in_place(self):
 
537
        """Tell this branch object to release the physical lock when this
 
538
        object is unlocked, even if it didn't originally acquire it.
 
539
 
 
540
        If lock_write doesn't return a token, then this method is not supported.
 
541
        """
 
542
        self.control_files.dont_leave_in_place()
 
543
 
 
544
    def bind(self, other):
 
545
        """Bind the local branch the other branch.
 
546
 
 
547
        :param other: The branch to bind to
 
548
        :type other: Branch
 
549
        """
 
550
        raise errors.UpgradeRequired(self.base)
 
551
 
 
552
    def set_append_revisions_only(self, enabled):
 
553
        if not self._format.supports_set_append_revisions_only():
 
554
            raise errors.UpgradeRequired(self.base)
 
555
        if enabled:
 
556
            value = 'True'
 
557
        else:
 
558
            value = 'False'
 
559
        self.get_config().set_user_option('append_revisions_only', value,
 
560
            warn_masked=True)
 
561
 
 
562
    def set_reference_info(self, file_id, tree_path, branch_location):
 
563
        """Set the branch location to use for a tree reference."""
 
564
        raise errors.UnsupportedOperation(self.set_reference_info, self)
 
565
 
 
566
    def get_reference_info(self, file_id):
 
567
        """Get the tree_path and branch_location for a tree reference."""
 
568
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
569
 
 
570
    @needs_write_lock
 
571
    def fetch(self, from_branch, last_revision=None, pb=None):
 
572
        """Copy revisions from from_branch into this branch.
 
573
 
 
574
        :param from_branch: Where to copy from.
 
575
        :param last_revision: What revision to stop at (None for at the end
 
576
                              of the branch.
 
577
        :param pb: An optional progress bar to use.
 
578
        :return: None
 
579
        """
 
580
        if self.base == from_branch.base:
 
581
            return (0, [])
 
582
        if pb is not None:
 
583
            symbol_versioning.warn(
 
584
                symbol_versioning.deprecated_in((1, 14, 0))
 
585
                % "pb parameter to fetch()")
 
586
        from_branch.lock_read()
 
587
        try:
 
588
            if last_revision is None:
 
589
                last_revision = from_branch.last_revision()
 
590
                last_revision = _mod_revision.ensure_null(last_revision)
 
591
            return self.repository.fetch(from_branch.repository,
 
592
                                         revision_id=last_revision,
 
593
                                         pb=pb)
 
594
        finally:
 
595
            from_branch.unlock()
 
596
 
 
597
    def get_bound_location(self):
 
598
        """Return the URL of the branch we are bound to.
 
599
 
 
600
        Older format branches cannot bind, please be sure to use a metadir
 
601
        branch.
 
602
        """
 
603
        return None
 
604
 
 
605
    def get_old_bound_location(self):
 
606
        """Return the URL of the branch we used to be bound to
 
607
        """
 
608
        raise errors.UpgradeRequired(self.base)
 
609
 
 
610
    def get_commit_builder(self, parents, config=None, timestamp=None,
 
611
                           timezone=None, committer=None, revprops=None,
 
612
                           revision_id=None):
 
613
        """Obtain a CommitBuilder for this branch.
 
614
 
 
615
        :param parents: Revision ids of the parents of the new revision.
 
616
        :param config: Optional configuration to use.
 
617
        :param timestamp: Optional timestamp recorded for commit.
 
618
        :param timezone: Optional timezone for timestamp.
 
619
        :param committer: Optional committer to set for commit.
 
620
        :param revprops: Optional dictionary of revision properties.
 
621
        :param revision_id: Optional revision id.
 
622
        """
 
623
 
 
624
        if config is None:
 
625
            config = self.get_config()
 
626
 
 
627
        return self.repository.get_commit_builder(self, parents, config,
 
628
            timestamp, timezone, committer, revprops, revision_id)
 
629
 
 
630
    def get_master_branch(self, possible_transports=None):
 
631
        """Return the branch we are bound to.
 
632
 
 
633
        :return: Either a Branch, or None
 
634
        """
 
635
        return None
 
636
 
 
637
    def get_revision_delta(self, revno):
 
638
        """Return the delta for one revision.
 
639
 
 
640
        The delta is relative to its mainline predecessor, or the
 
641
        empty tree for revision 1.
 
642
        """
 
643
        rh = self.revision_history()
 
644
        if not (1 <= revno <= len(rh)):
 
645
            raise errors.InvalidRevisionNumber(revno)
 
646
        return self.repository.get_revision_delta(rh[revno-1])
 
647
 
 
648
    def get_stacked_on_url(self):
 
649
        """Get the URL this branch is stacked against.
 
650
 
 
651
        :raises NotStacked: If the branch is not stacked.
 
652
        :raises UnstackableBranchFormat: If the branch does not support
 
653
            stacking.
 
654
        """
 
655
        raise NotImplementedError(self.get_stacked_on_url)
 
656
 
 
657
    def print_file(self, file, revision_id):
389
658
        """Print `file` to stdout."""
390
 
        self._need_readlock()
391
 
        tree = self.revision_tree(self.lookup_revision(revno))
392
 
        # use inventory as it was in that revision
393
 
        file_id = tree.inventory.path2id(file)
394
 
        if not file_id:
395
 
            bailout("%r is not present in revision %d" % (file, revno))
396
 
        tree.print_file(file_id)
397
 
        
398
 
 
399
 
    def remove(self, files, verbose=False):
400
 
        """Mark nominated files for removal from the inventory.
401
 
 
402
 
        This does not remove their text.  This does not run on 
403
 
 
404
 
        TODO: Refuse to remove modified files unless --force is given?
405
 
 
406
 
        >>> b = ScratchBranch(files=['foo'])
407
 
        >>> b.add('foo')
408
 
        >>> b.inventory.has_filename('foo')
409
 
        True
410
 
        >>> b.remove('foo')
411
 
        >>> b.working_tree().has_filename('foo')
412
 
        True
413
 
        >>> b.inventory.has_filename('foo')
414
 
        False
415
 
        
416
 
        >>> b = ScratchBranch(files=['foo'])
417
 
        >>> b.add('foo')
418
 
        >>> b.commit('one')
419
 
        >>> b.remove('foo')
420
 
        >>> b.commit('two')
421
 
        >>> b.inventory.has_filename('foo') 
422
 
        False
423
 
        >>> b.basis_tree().has_filename('foo') 
424
 
        False
425
 
        >>> b.working_tree().has_filename('foo') 
426
 
        True
427
 
 
428
 
        TODO: Do something useful with directories.
429
 
 
430
 
        TODO: Should this remove the text or not?  Tough call; not
431
 
        removing may be useful and the user can just use use rm, and
432
 
        is the opposite of add.  Removing it is consistent with most
433
 
        other tools.  Maybe an option.
434
 
        """
435
 
        ## TODO: Normalize names
436
 
        ## TODO: Remove nested loops; better scalability
437
 
        self._need_writelock()
438
 
 
439
 
        if isinstance(files, types.StringTypes):
440
 
            files = [files]
441
 
        
442
 
        tree = self.working_tree()
443
 
        inv = tree.inventory
444
 
 
445
 
        # do this before any modifications
446
 
        for f in files:
447
 
            fid = inv.path2id(f)
448
 
            if not fid:
449
 
                bailout("cannot remove unversioned file %s" % quotefn(f))
450
 
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
451
 
            if verbose:
452
 
                # having remove it, it must be either ignored or unknown
453
 
                if tree.is_ignored(f):
454
 
                    new_status = 'I'
455
 
                else:
456
 
                    new_status = '?'
457
 
                show_status(new_status, inv[fid].kind, quotefn(f))
458
 
            del inv[fid]
459
 
 
460
 
        self._write_inventory(inv)
461
 
 
462
 
 
463
 
    def unknowns(self):
464
 
        """Return all unknown files.
465
 
 
466
 
        These are files in the working directory that are not versioned or
467
 
        control files or ignored.
468
 
        
469
 
        >>> b = ScratchBranch(files=['foo', 'foo~'])
470
 
        >>> list(b.unknowns())
471
 
        ['foo']
472
 
        >>> b.add('foo')
473
 
        >>> list(b.unknowns())
474
 
        []
475
 
        >>> b.remove('foo')
476
 
        >>> list(b.unknowns())
477
 
        ['foo']
478
 
        """
479
 
        return self.working_tree().unknowns()
480
 
 
481
 
 
482
 
    def commit(self, message, timestamp=None, timezone=None,
483
 
               committer=None,
484
 
               verbose=False):
485
 
        """Commit working copy as a new revision.
486
 
        
487
 
        The basic approach is to add all the file texts into the
488
 
        store, then the inventory, then make a new revision pointing
489
 
        to that inventory and store that.
490
 
        
491
 
        This is not quite safe if the working copy changes during the
492
 
        commit; for the moment that is simply not allowed.  A better
493
 
        approach is to make a temporary copy of the files before
494
 
        computing their hashes, and then add those hashes in turn to
495
 
        the inventory.  This should mean at least that there are no
496
 
        broken hash pointers.  There is no way we can get a snapshot
497
 
        of the whole directory at an instant.  This would also have to
498
 
        be robust against files disappearing, moving, etc.  So the
499
 
        whole thing is a bit hard.
500
 
 
501
 
        timestamp -- if not None, seconds-since-epoch for a
502
 
             postdated/predated commit.
503
 
        """
504
 
        self._need_writelock()
505
 
 
506
 
        ## TODO: Show branch names
507
 
 
508
 
        # TODO: Don't commit if there are no changes, unless forced?
509
 
 
510
 
        # First walk over the working inventory; and both update that
511
 
        # and also build a new revision inventory.  The revision
512
 
        # inventory needs to hold the text-id, sha1 and size of the
513
 
        # actual file versions committed in the revision.  (These are
514
 
        # not present in the working inventory.)  We also need to
515
 
        # detect missing/deleted files, and remove them from the
516
 
        # working inventory.
517
 
 
518
 
        work_inv = self.read_working_inventory()
519
 
        inv = Inventory()
520
 
        basis = self.basis_tree()
521
 
        basis_inv = basis.inventory
522
 
        missing_ids = []
523
 
        for path, entry in work_inv.iter_entries():
524
 
            ## TODO: Cope with files that have gone missing.
525
 
 
526
 
            ## TODO: Check that the file kind has not changed from the previous
527
 
            ## revision of this file (if any).
528
 
 
529
 
            entry = entry.copy()
530
 
 
531
 
            p = self.abspath(path)
532
 
            file_id = entry.file_id
533
 
            mutter('commit prep file %s, id %r ' % (p, file_id))
534
 
 
535
 
            if not os.path.exists(p):
536
 
                mutter("    file is missing, removing from inventory")
537
 
                if verbose:
538
 
                    show_status('D', entry.kind, quotefn(path))
539
 
                missing_ids.append(file_id)
540
 
                continue
541
 
 
542
 
            # TODO: Handle files that have been deleted
543
 
 
544
 
            # TODO: Maybe a special case for empty files?  Seems a
545
 
            # waste to store them many times.
546
 
 
547
 
            inv.add(entry)
548
 
 
549
 
            if basis_inv.has_id(file_id):
550
 
                old_kind = basis_inv[file_id].kind
551
 
                if old_kind != entry.kind:
552
 
                    bailout("entry %r changed kind from %r to %r"
553
 
                            % (file_id, old_kind, entry.kind))
554
 
 
555
 
            if entry.kind == 'directory':
556
 
                if not isdir(p):
557
 
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
558
 
            elif entry.kind == 'file':
559
 
                if not isfile(p):
560
 
                    bailout("%s is entered as file but is not a file" % quotefn(p))
561
 
 
562
 
                content = file(p, 'rb').read()
563
 
 
564
 
                entry.text_sha1 = sha_string(content)
565
 
                entry.text_size = len(content)
566
 
 
567
 
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
568
 
                if (old_ie
569
 
                    and (old_ie.text_size == entry.text_size)
570
 
                    and (old_ie.text_sha1 == entry.text_sha1)):
571
 
                    ## assert content == basis.get_file(file_id).read()
572
 
                    entry.text_id = basis_inv[file_id].text_id
573
 
                    mutter('    unchanged from previous text_id {%s}' %
574
 
                           entry.text_id)
575
 
                    
576
 
                else:
577
 
                    entry.text_id = gen_file_id(entry.name)
578
 
                    self.text_store.add(content, entry.text_id)
579
 
                    mutter('    stored with text_id {%s}' % entry.text_id)
580
 
                    if verbose:
581
 
                        if not old_ie:
582
 
                            state = 'A'
583
 
                        elif (old_ie.name == entry.name
584
 
                              and old_ie.parent_id == entry.parent_id):
585
 
                            state = 'M'
586
 
                        else:
587
 
                            state = 'R'
588
 
 
589
 
                        show_status(state, entry.kind, quotefn(path))
590
 
 
591
 
        for file_id in missing_ids:
592
 
            # have to do this later so we don't mess up the iterator.
593
 
            # since parents may be removed before their children we
594
 
            # have to test.
595
 
 
596
 
            # FIXME: There's probably a better way to do this; perhaps
597
 
            # the workingtree should know how to filter itself.
598
 
            if work_inv.has_id(file_id):
599
 
                del work_inv[file_id]
600
 
 
601
 
 
602
 
        inv_id = rev_id = _gen_revision_id(time.time())
603
 
        
604
 
        inv_tmp = tempfile.TemporaryFile()
605
 
        inv.write_xml(inv_tmp)
606
 
        inv_tmp.seek(0)
607
 
        self.inventory_store.add(inv_tmp, inv_id)
608
 
        mutter('new inventory_id is {%s}' % inv_id)
609
 
 
610
 
        self._write_inventory(work_inv)
611
 
 
612
 
        if timestamp == None:
613
 
            timestamp = time.time()
614
 
 
615
 
        if committer == None:
616
 
            committer = username()
617
 
 
618
 
        if timezone == None:
619
 
            timezone = local_time_offset()
620
 
 
621
 
        mutter("building commit log message")
622
 
        rev = Revision(timestamp=timestamp,
623
 
                       timezone=timezone,
624
 
                       committer=committer,
625
 
                       precursor = self.last_patch(),
626
 
                       message = message,
627
 
                       inventory_id=inv_id,
628
 
                       revision_id=rev_id)
629
 
 
630
 
        rev_tmp = tempfile.TemporaryFile()
631
 
        rev.write_xml(rev_tmp)
632
 
        rev_tmp.seek(0)
633
 
        self.revision_store.add(rev_tmp, rev_id)
634
 
        mutter("new revision_id is {%s}" % rev_id)
635
 
        
636
 
        ## XXX: Everything up to here can simply be orphaned if we abort
637
 
        ## the commit; it will leave junk files behind but that doesn't
638
 
        ## matter.
639
 
 
640
 
        ## TODO: Read back the just-generated changeset, and make sure it
641
 
        ## applies and recreates the right state.
642
 
 
643
 
        ## TODO: Also calculate and store the inventory SHA1
644
 
        mutter("committing patch r%d" % (self.revno() + 1))
645
 
 
646
 
 
647
 
        self.append_revision(rev_id)
648
 
        
649
 
        if verbose:
650
 
            note("commited r%d" % self.revno())
651
 
 
652
 
 
653
 
    def append_revision(self, revision_id):
654
 
        mutter("add {%s} to revision-history" % revision_id)
655
 
        rev_history = self.revision_history()
656
 
 
657
 
        tmprhname = self.controlfilename('revision-history.tmp')
658
 
        rhname = self.controlfilename('revision-history')
659
 
        
660
 
        f = file(tmprhname, 'wt')
661
 
        rev_history.append(revision_id)
662
 
        f.write('\n'.join(rev_history))
663
 
        f.write('\n')
664
 
        f.close()
665
 
 
666
 
        if sys.platform == 'win32':
667
 
            os.remove(rhname)
668
 
        os.rename(tmprhname, rhname)
669
 
        
670
 
 
671
 
 
672
 
    def get_revision(self, revision_id):
673
 
        """Return the Revision object for a named revision"""
674
 
        self._need_readlock()
675
 
        r = Revision.read_xml(self.revision_store[revision_id])
676
 
        assert r.revision_id == revision_id
677
 
        return r
678
 
 
679
 
 
680
 
    def get_inventory(self, inventory_id):
681
 
        """Get Inventory object by hash.
682
 
 
683
 
        TODO: Perhaps for this and similar methods, take a revision
684
 
               parameter which can be either an integer revno or a
685
 
               string hash."""
686
 
        self._need_readlock()
687
 
        i = Inventory.read_xml(self.inventory_store[inventory_id])
688
 
        return i
689
 
 
690
 
 
691
 
    def get_revision_inventory(self, revision_id):
692
 
        """Return inventory of a past revision."""
693
 
        self._need_readlock()
694
 
        if revision_id == None:
695
 
            return Inventory()
 
659
        raise NotImplementedError(self.print_file)
 
660
 
 
661
    def set_revision_history(self, rev_history):
 
662
        raise NotImplementedError(self.set_revision_history)
 
663
 
 
664
    @needs_write_lock
 
665
    def set_parent(self, url):
 
666
        """See Branch.set_parent."""
 
667
        # TODO: Maybe delete old location files?
 
668
        # URLs should never be unicode, even on the local fs,
 
669
        # FIXUP this and get_parent in a future branch format bump:
 
670
        # read and rewrite the file. RBC 20060125
 
671
        if url is not None:
 
672
            if isinstance(url, unicode):
 
673
                try:
 
674
                    url = url.encode('ascii')
 
675
                except UnicodeEncodeError:
 
676
                    raise errors.InvalidURL(url,
 
677
                        "Urls must be 7-bit ascii, "
 
678
                        "use bzrlib.urlutils.escape")
 
679
            url = urlutils.relative_url(self.base, url)
 
680
        self._set_parent_location(url)
 
681
 
 
682
    @needs_write_lock
 
683
    def set_stacked_on_url(self, url):
 
684
        """Set the URL this branch is stacked against.
 
685
 
 
686
        :raises UnstackableBranchFormat: If the branch does not support
 
687
            stacking.
 
688
        :raises UnstackableRepositoryFormat: If the repository does not support
 
689
            stacking.
 
690
        """
 
691
        if not self._format.supports_stacking():
 
692
            raise errors.UnstackableBranchFormat(self._format, self.base)
 
693
        # XXX: Changing from one fallback repository to another does not check
 
694
        # that all the data you need is present in the new fallback.
 
695
        # Possibly it should.
 
696
        self._check_stackable_repo()
 
697
        if not url:
 
698
            try:
 
699
                old_url = self.get_stacked_on_url()
 
700
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
701
                errors.UnstackableRepositoryFormat):
 
702
                return
 
703
            self._unstack()
696
704
        else:
697
 
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
698
 
 
699
 
 
 
705
            self._activate_fallback_location(url)
 
706
        # write this out after the repository is stacked to avoid setting a
 
707
        # stacked config that doesn't work.
 
708
        self._set_config_location('stacked_on_location', url)
 
709
 
 
710
    def _unstack(self):
 
711
        """Change a branch to be unstacked, copying data as needed.
 
712
        
 
713
        Don't call this directly, use set_stacked_on_url(None).
 
714
        """
 
715
        pb = ui.ui_factory.nested_progress_bar()
 
716
        try:
 
717
            pb.update("Unstacking")
 
718
            # The basic approach here is to fetch the tip of the branch,
 
719
            # including all available ghosts, from the existing stacked
 
720
            # repository into a new repository object without the fallbacks. 
 
721
            #
 
722
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
 
723
            # correct for CHKMap repostiories
 
724
            old_repository = self.repository
 
725
            if len(old_repository._fallback_repositories) != 1:
 
726
                raise AssertionError("can't cope with fallback repositories "
 
727
                    "of %r" % (self.repository,))
 
728
            # unlock it, including unlocking the fallback
 
729
            old_repository.unlock()
 
730
            old_repository.lock_read()
 
731
            try:
 
732
                # Repositories don't offer an interface to remove fallback
 
733
                # repositories today; take the conceptually simpler option and just
 
734
                # reopen it.  We reopen it starting from the URL so that we
 
735
                # get a separate connection for RemoteRepositories and can
 
736
                # stream from one of them to the other.  This does mean doing
 
737
                # separate SSH connection setup, but unstacking is not a
 
738
                # common operation so it's tolerable.
 
739
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
740
                new_repository = new_bzrdir.find_repository()
 
741
                self.repository = new_repository
 
742
                if self.repository._fallback_repositories:
 
743
                    raise AssertionError("didn't expect %r to have "
 
744
                        "fallback_repositories"
 
745
                        % (self.repository,))
 
746
                # this is not paired with an unlock because it's just restoring
 
747
                # the previous state; the lock's released when set_stacked_on_url
 
748
                # returns
 
749
                self.repository.lock_write()
 
750
                # XXX: If you unstack a branch while it has a working tree
 
751
                # with a pending merge, the pending-merged revisions will no
 
752
                # longer be present.  You can (probably) revert and remerge.
 
753
                #
 
754
                # XXX: This only fetches up to the tip of the repository; it
 
755
                # doesn't bring across any tags.  That's fairly consistent
 
756
                # with how branch works, but perhaps not ideal.
 
757
                self.repository.fetch(old_repository,
 
758
                    revision_id=self.last_revision(),
 
759
                    find_ghosts=True)
 
760
            finally:
 
761
                old_repository.unlock()
 
762
        finally:
 
763
            pb.finished()
 
764
 
 
765
    def _set_tags_bytes(self, bytes):
 
766
        """Mirror method for _get_tags_bytes.
 
767
 
 
768
        :seealso: Branch._get_tags_bytes.
 
769
        """
 
770
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
771
            'tags', bytes)
 
772
 
 
773
    def _cache_revision_history(self, rev_history):
 
774
        """Set the cached revision history to rev_history.
 
775
 
 
776
        The revision_history method will use this cache to avoid regenerating
 
777
        the revision history.
 
778
 
 
779
        This API is semi-public; it only for use by subclasses, all other code
 
780
        should consider it to be private.
 
781
        """
 
782
        self._revision_history_cache = rev_history
 
783
 
 
784
    def _cache_revision_id_to_revno(self, revision_id_to_revno):
 
785
        """Set the cached revision_id => revno map to revision_id_to_revno.
 
786
 
 
787
        This API is semi-public; it only for use by subclasses, all other code
 
788
        should consider it to be private.
 
789
        """
 
790
        self._revision_id_to_revno_cache = revision_id_to_revno
 
791
 
 
792
    def _clear_cached_state(self):
 
793
        """Clear any cached data on this branch, e.g. cached revision history.
 
794
 
 
795
        This means the next call to revision_history will need to call
 
796
        _gen_revision_history.
 
797
 
 
798
        This API is semi-public; it only for use by subclasses, all other code
 
799
        should consider it to be private.
 
800
        """
 
801
        self._revision_history_cache = None
 
802
        self._revision_id_to_revno_cache = None
 
803
        self._last_revision_info_cache = None
 
804
        self._merge_sorted_revisions_cache = None
 
805
        self._partial_revision_history_cache = []
 
806
        self._partial_revision_id_to_revno_cache = {}
 
807
 
 
808
    def _gen_revision_history(self):
 
809
        """Return sequence of revision hashes on to this branch.
 
810
 
 
811
        Unlike revision_history, this method always regenerates or rereads the
 
812
        revision history, i.e. it does not cache the result, so repeated calls
 
813
        may be expensive.
 
814
 
 
815
        Concrete subclasses should override this instead of revision_history so
 
816
        that subclasses do not need to deal with caching logic.
 
817
 
 
818
        This API is semi-public; it only for use by subclasses, all other code
 
819
        should consider it to be private.
 
820
        """
 
821
        raise NotImplementedError(self._gen_revision_history)
 
822
 
 
823
    @needs_read_lock
700
824
    def revision_history(self):
701
 
        """Return sequence of revision hashes on to this branch.
702
 
 
703
 
        >>> ScratchBranch().revision_history()
704
 
        []
705
 
        """
706
 
        self._need_readlock()
707
 
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
708
 
 
709
 
 
710
 
    def enum_history(self, direction):
711
 
        """Return (revno, revision_id) for history of branch.
712
 
 
713
 
        direction
714
 
            'forward' is from earliest to latest
715
 
            'reverse' is from latest to earliest
716
 
        """
717
 
        rh = self.revision_history()
718
 
        if direction == 'forward':
719
 
            i = 1
720
 
            for rid in rh:
721
 
                yield i, rid
722
 
                i += 1
723
 
        elif direction == 'reverse':
724
 
            i = len(rh)
725
 
            while i > 0:
726
 
                yield i, rh[i-1]
727
 
                i -= 1
 
825
        """Return sequence of revision ids on this branch.
 
826
 
 
827
        This method will cache the revision history for as long as it is safe to
 
828
        do so.
 
829
        """
 
830
        if 'evil' in debug.debug_flags:
 
831
            mutter_callsite(3, "revision_history scales with history.")
 
832
        if self._revision_history_cache is not None:
 
833
            history = self._revision_history_cache
728
834
        else:
729
 
            raise BzrError('invalid history direction %r' % direction)
730
 
 
 
835
            history = self._gen_revision_history()
 
836
            self._cache_revision_history(history)
 
837
        return list(history)
731
838
 
732
839
    def revno(self):
733
840
        """Return current revision number for this branch.
734
841
 
735
842
        That is equivalent to the number of revisions committed to
736
843
        this branch.
737
 
 
738
 
        >>> b = ScratchBranch()
739
 
        >>> b.revno()
740
 
        0
741
 
        >>> b.commit('no foo')
742
 
        >>> b.revno()
743
 
        1
744
 
        """
745
 
        return len(self.revision_history())
746
 
 
747
 
 
748
 
    def last_patch(self):
749
 
        """Return last patch hash, or None if no history.
750
 
 
751
 
        >>> ScratchBranch().last_patch() == None
752
 
        True
753
 
        """
754
 
        ph = self.revision_history()
755
 
        if ph:
756
 
            return ph[-1]
757
 
        else:
758
 
            return None
759
 
        
760
 
 
761
 
    def lookup_revision(self, revno):
762
 
        """Return revision hash for revision number."""
763
 
        if revno == 0:
764
 
            return None
765
 
 
766
 
        try:
767
 
            # list is 0-based; revisions are 1-based
768
 
            return self.revision_history()[revno-1]
769
 
        except IndexError:
770
 
            raise BzrError("no such revision %s" % revno)
771
 
 
772
 
 
773
 
    def revision_tree(self, revision_id):
774
 
        """Return Tree for a revision on this branch.
775
 
 
776
 
        `revision_id` may be None for the null revision, in which case
777
 
        an `EmptyTree` is returned."""
778
 
        self._need_readlock()
779
 
        if revision_id == None:
780
 
            return EmptyTree()
781
 
        else:
782
 
            inv = self.get_revision_inventory(revision_id)
783
 
            return RevisionTree(self.text_store, inv)
784
 
 
785
 
 
786
 
    def working_tree(self):
787
 
        """Return a `Tree` for the working copy."""
788
 
        from workingtree import WorkingTree
789
 
        return WorkingTree(self.base, self.read_working_inventory())
790
 
 
791
 
 
792
 
    def basis_tree(self):
793
 
        """Return `Tree` object for last revision.
794
 
 
795
 
        If there are no revisions yet, return an `EmptyTree`.
796
 
 
797
 
        >>> b = ScratchBranch(files=['foo'])
798
 
        >>> b.basis_tree().has_filename('foo')
799
 
        False
800
 
        >>> b.working_tree().has_filename('foo')
801
 
        True
802
 
        >>> b.add('foo')
803
 
        >>> b.commit('add foo')
804
 
        >>> b.basis_tree().has_filename('foo')
805
 
        True
806
 
        """
807
 
        r = self.last_patch()
808
 
        if r == None:
809
 
            return EmptyTree()
810
 
        else:
811
 
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
812
 
 
813
 
 
814
 
 
815
 
    def rename_one(self, from_rel, to_rel):
816
 
        """Rename one file.
817
 
 
818
 
        This can change the directory or the filename or both.
819
 
        """
820
 
        self._need_writelock()
821
 
        tree = self.working_tree()
822
 
        inv = tree.inventory
823
 
        if not tree.has_filename(from_rel):
824
 
            bailout("can't rename: old working file %r does not exist" % from_rel)
825
 
        if tree.has_filename(to_rel):
826
 
            bailout("can't rename: new working file %r already exists" % to_rel)
827
 
            
828
 
        file_id = inv.path2id(from_rel)
829
 
        if file_id == None:
830
 
            bailout("can't rename: old name %r is not versioned" % from_rel)
831
 
 
832
 
        if inv.path2id(to_rel):
833
 
            bailout("can't rename: new name %r is already versioned" % to_rel)
834
 
 
835
 
        to_dir, to_tail = os.path.split(to_rel)
836
 
        to_dir_id = inv.path2id(to_dir)
837
 
        if to_dir_id == None and to_dir != '':
838
 
            bailout("can't determine destination directory id for %r" % to_dir)
839
 
 
840
 
        mutter("rename_one:")
841
 
        mutter("  file_id    {%s}" % file_id)
842
 
        mutter("  from_rel   %r" % from_rel)
843
 
        mutter("  to_rel     %r" % to_rel)
844
 
        mutter("  to_dir     %r" % to_dir)
845
 
        mutter("  to_dir_id  {%s}" % to_dir_id)
846
 
            
847
 
        inv.rename(file_id, to_dir_id, to_tail)
848
 
 
849
 
        print "%s => %s" % (from_rel, to_rel)
850
 
        
851
 
        from_abs = self.abspath(from_rel)
852
 
        to_abs = self.abspath(to_rel)
853
 
        try:
854
 
            os.rename(from_abs, to_abs)
855
 
        except OSError, e:
856
 
            bailout("failed to rename %r to %r: %s"
857
 
                    % (from_abs, to_abs, e[1]),
858
 
                    ["rename rolled back"])
859
 
 
860
 
        self._write_inventory(inv)
861
 
            
862
 
 
863
 
 
864
 
    def move(self, from_paths, to_name):
865
 
        """Rename files.
866
 
 
867
 
        to_name must exist as a versioned directory.
868
 
 
869
 
        If to_name exists and is a directory, the files are moved into
870
 
        it, keeping their old names.  If it is a directory, 
871
 
 
872
 
        Note that to_name is only the last component of the new name;
873
 
        this doesn't change the directory.
874
 
        """
875
 
        self._need_writelock()
876
 
        ## TODO: Option to move IDs only
877
 
        assert not isinstance(from_paths, basestring)
878
 
        tree = self.working_tree()
879
 
        inv = tree.inventory
880
 
        to_abs = self.abspath(to_name)
881
 
        if not isdir(to_abs):
882
 
            bailout("destination %r is not a directory" % to_abs)
883
 
        if not tree.has_filename(to_name):
884
 
            bailout("destination %r not in working directory" % to_abs)
885
 
        to_dir_id = inv.path2id(to_name)
886
 
        if to_dir_id == None and to_name != '':
887
 
            bailout("destination %r is not a versioned directory" % to_name)
888
 
        to_dir_ie = inv[to_dir_id]
889
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
890
 
            bailout("destination %r is not a directory" % to_abs)
891
 
 
892
 
        to_idpath = Set(inv.get_idpath(to_dir_id))
893
 
 
894
 
        for f in from_paths:
895
 
            if not tree.has_filename(f):
896
 
                bailout("%r does not exist in working tree" % f)
897
 
            f_id = inv.path2id(f)
898
 
            if f_id == None:
899
 
                bailout("%r is not versioned" % f)
900
 
            name_tail = splitpath(f)[-1]
901
 
            dest_path = appendpath(to_name, name_tail)
902
 
            if tree.has_filename(dest_path):
903
 
                bailout("destination %r already exists" % dest_path)
904
 
            if f_id in to_idpath:
905
 
                bailout("can't move %r to a subdirectory of itself" % f)
906
 
 
907
 
        # OK, so there's a race here, it's possible that someone will
908
 
        # create a file in this interval and then the rename might be
909
 
        # left half-done.  But we should have caught most problems.
910
 
 
911
 
        for f in from_paths:
912
 
            name_tail = splitpath(f)[-1]
913
 
            dest_path = appendpath(to_name, name_tail)
914
 
            print "%s => %s" % (f, dest_path)
915
 
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
916
 
            try:
917
 
                os.rename(self.abspath(f), self.abspath(dest_path))
918
 
            except OSError, e:
919
 
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
920
 
                        ["rename rolled back"])
921
 
 
922
 
        self._write_inventory(inv)
923
 
 
924
 
 
925
 
 
926
 
 
927
 
class ScratchBranch(Branch):
928
 
    """Special test class: a branch that cleans up after itself.
929
 
 
930
 
    >>> b = ScratchBranch()
931
 
    >>> isdir(b.base)
932
 
    True
933
 
    >>> bd = b.base
934
 
    >>> b.destroy()
935
 
    >>> isdir(bd)
936
 
    False
937
 
    """
938
 
    def __init__(self, files=[], dirs=[]):
939
 
        """Make a test branch.
940
 
 
941
 
        This creates a temporary directory and runs init-tree in it.
942
 
 
943
 
        If any files are listed, they are created in the working copy.
944
 
        """
945
 
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
946
 
        for d in dirs:
947
 
            os.mkdir(self.abspath(d))
948
 
            
949
 
        for f in files:
950
 
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
951
 
 
952
 
 
953
 
    def __del__(self):
954
 
        self.destroy()
955
 
 
956
 
    def destroy(self):
957
 
        """Destroy the test branch, removing the scratch directory."""
958
 
        try:
959
 
            mutter("delete ScratchBranch %s" % self.base)
960
 
            shutil.rmtree(self.base)
961
 
        except OSError, e:
962
 
            # Work around for shutil.rmtree failing on Windows when
963
 
            # readonly files are encountered
964
 
            mutter("hit exception in destroying ScratchBranch: %s" % e)
965
 
            for root, dirs, files in os.walk(self.base, topdown=False):
966
 
                for name in files:
967
 
                    os.chmod(os.path.join(root, name), 0700)
968
 
            shutil.rmtree(self.base)
969
 
        self.base = None
970
 
 
971
 
    
 
844
        """
 
845
        return self.last_revision_info()[0]
 
846
 
 
847
    def unbind(self):
 
848
        """Older format branches cannot bind or unbind."""
 
849
        raise errors.UpgradeRequired(self.base)
 
850
 
 
851
    def last_revision(self):
 
852
        """Return last revision id, or NULL_REVISION."""
 
853
        return self.last_revision_info()[1]
 
854
 
 
855
    @needs_read_lock
 
856
    def last_revision_info(self):
 
857
        """Return information about the last revision.
 
858
 
 
859
        :return: A tuple (revno, revision_id).
 
860
        """
 
861
        if self._last_revision_info_cache is None:
 
862
            self._last_revision_info_cache = self._last_revision_info()
 
863
        return self._last_revision_info_cache
 
864
 
 
865
    def _last_revision_info(self):
 
866
        rh = self.revision_history()
 
867
        revno = len(rh)
 
868
        if revno:
 
869
            return (revno, rh[-1])
 
870
        else:
 
871
            return (0, _mod_revision.NULL_REVISION)
 
872
 
 
873
    @deprecated_method(deprecated_in((1, 6, 0)))
 
874
    def missing_revisions(self, other, stop_revision=None):
 
875
        """Return a list of new revisions that would perfectly fit.
 
876
 
 
877
        If self and other have not diverged, return a list of the revisions
 
878
        present in other, but missing from self.
 
879
        """
 
880
        self_history = self.revision_history()
 
881
        self_len = len(self_history)
 
882
        other_history = other.revision_history()
 
883
        other_len = len(other_history)
 
884
        common_index = min(self_len, other_len) -1
 
885
        if common_index >= 0 and \
 
886
            self_history[common_index] != other_history[common_index]:
 
887
            raise errors.DivergedBranches(self, other)
 
888
 
 
889
        if stop_revision is None:
 
890
            stop_revision = other_len
 
891
        else:
 
892
            if stop_revision > other_len:
 
893
                raise errors.NoSuchRevision(self, stop_revision)
 
894
        return other_history[self_len:stop_revision]
 
895
 
 
896
    @needs_write_lock
 
897
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
898
                         graph=None):
 
899
        """Pull in new perfect-fit revisions.
 
900
 
 
901
        :param other: Another Branch to pull from
 
902
        :param stop_revision: Updated until the given revision
 
903
        :param overwrite: Always set the branch pointer, rather than checking
 
904
            to see if it is a proper descendant.
 
905
        :param graph: A Graph object that can be used to query history
 
906
            information. This can be None.
 
907
        :return: None
 
908
        """
 
909
        return InterBranch.get(other, self).update_revisions(stop_revision,
 
910
            overwrite, graph)
 
911
 
 
912
    def import_last_revision_info(self, source_repo, revno, revid):
 
913
        """Set the last revision info, importing from another repo if necessary.
 
914
 
 
915
        This is used by the bound branch code to upload a revision to
 
916
        the master branch first before updating the tip of the local branch.
 
917
 
 
918
        :param source_repo: Source repository to optionally fetch from
 
919
        :param revno: Revision number of the new tip
 
920
        :param revid: Revision id of the new tip
 
921
        """
 
922
        if not self.repository.has_same_location(source_repo):
 
923
            self.repository.fetch(source_repo, revision_id=revid)
 
924
        self.set_last_revision_info(revno, revid)
 
925
 
 
926
    def revision_id_to_revno(self, revision_id):
 
927
        """Given a revision id, return its revno"""
 
928
        if _mod_revision.is_null(revision_id):
 
929
            return 0
 
930
        history = self.revision_history()
 
931
        try:
 
932
            return history.index(revision_id) + 1
 
933
        except ValueError:
 
934
            raise errors.NoSuchRevision(self, revision_id)
 
935
 
 
936
    @needs_read_lock
 
937
    def get_rev_id(self, revno, history=None):
 
938
        """Find the revision id of the specified revno."""
 
939
        if revno == 0:
 
940
            return _mod_revision.NULL_REVISION
 
941
        last_revno, last_revid = self.last_revision_info()
 
942
        if revno == last_revno:
 
943
            return last_revid
 
944
        if revno <= 0 or revno > last_revno:
 
945
            raise errors.NoSuchRevision(self, revno)
 
946
        distance_from_last = last_revno - revno
 
947
        if len(self._partial_revision_history_cache) <= distance_from_last:
 
948
            self._extend_partial_history(distance_from_last)
 
949
        return self._partial_revision_history_cache[distance_from_last]
 
950
 
 
951
    @needs_write_lock
 
952
    def pull(self, source, overwrite=False, stop_revision=None,
 
953
             possible_transports=None, *args, **kwargs):
 
954
        """Mirror source into this branch.
 
955
 
 
956
        This branch is considered to be 'local', having low latency.
 
957
 
 
958
        :returns: PullResult instance
 
959
        """
 
960
        return InterBranch.get(source, self).pull(overwrite=overwrite,
 
961
            stop_revision=stop_revision,
 
962
            possible_transports=possible_transports, *args, **kwargs)
 
963
 
 
964
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
965
        **kwargs):
 
966
        """Mirror this branch into target.
 
967
 
 
968
        This branch is considered to be 'local', having low latency.
 
969
        """
 
970
        return InterBranch.get(self, target).push(overwrite, stop_revision,
 
971
            *args, **kwargs)
 
972
 
 
973
    def lossy_push(self, target, stop_revision=None):
 
974
        """Push deltas into another branch.
 
975
 
 
976
        :note: This does not, like push, retain the revision ids from 
 
977
            the source branch and will, rather than adding bzr-specific 
 
978
            metadata, push only those semantics of the revision that can be 
 
979
            natively represented by this branch' VCS.
 
980
 
 
981
        :param target: Target branch
 
982
        :param stop_revision: Revision to push, defaults to last revision.
 
983
        :return: BranchPushResult with an extra member revidmap: 
 
984
            A dictionary mapping revision ids from the target branch 
 
985
            to new revision ids in the target branch, for each 
 
986
            revision that was pushed.
 
987
        """
 
988
        inter = InterBranch.get(self, target)
 
989
        lossy_push = getattr(inter, "lossy_push", None)
 
990
        if lossy_push is None:
 
991
            raise errors.LossyPushToSameVCS(self, target)
 
992
        return lossy_push(stop_revision)
 
993
 
 
994
    def basis_tree(self):
 
995
        """Return `Tree` object for last revision."""
 
996
        return self.repository.revision_tree(self.last_revision())
 
997
 
 
998
    def get_parent(self):
 
999
        """Return the parent location of the branch.
 
1000
 
 
1001
        This is the default location for pull/missing.  The usual
 
1002
        pattern is that the user can override it by specifying a
 
1003
        location.
 
1004
        """
 
1005
        parent = self._get_parent_location()
 
1006
        if parent is None:
 
1007
            return parent
 
1008
        # This is an old-format absolute path to a local branch
 
1009
        # turn it into a url
 
1010
        if parent.startswith('/'):
 
1011
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
1012
        try:
 
1013
            return urlutils.join(self.base[:-1], parent)
 
1014
        except errors.InvalidURLJoin, e:
 
1015
            raise errors.InaccessibleParent(parent, self.base)
 
1016
 
 
1017
    def _get_parent_location(self):
 
1018
        raise NotImplementedError(self._get_parent_location)
 
1019
 
 
1020
    def _set_config_location(self, name, url, config=None,
 
1021
                             make_relative=False):
 
1022
        if config is None:
 
1023
            config = self.get_config()
 
1024
        if url is None:
 
1025
            url = ''
 
1026
        elif make_relative:
 
1027
            url = urlutils.relative_url(self.base, url)
 
1028
        config.set_user_option(name, url, warn_masked=True)
 
1029
 
 
1030
    def _get_config_location(self, name, config=None):
 
1031
        if config is None:
 
1032
            config = self.get_config()
 
1033
        location = config.get_user_option(name)
 
1034
        if location == '':
 
1035
            location = None
 
1036
        return location
 
1037
 
 
1038
    def get_child_submit_format(self):
 
1039
        """Return the preferred format of submissions to this branch."""
 
1040
        return self.get_config().get_user_option("child_submit_format")
 
1041
 
 
1042
    def get_submit_branch(self):
 
1043
        """Return the submit location of the branch.
 
1044
 
 
1045
        This is the default location for bundle.  The usual
 
1046
        pattern is that the user can override it by specifying a
 
1047
        location.
 
1048
        """
 
1049
        return self.get_config().get_user_option('submit_branch')
 
1050
 
 
1051
    def set_submit_branch(self, location):
 
1052
        """Return the submit location of the branch.
 
1053
 
 
1054
        This is the default location for bundle.  The usual
 
1055
        pattern is that the user can override it by specifying a
 
1056
        location.
 
1057
        """
 
1058
        self.get_config().set_user_option('submit_branch', location,
 
1059
            warn_masked=True)
 
1060
 
 
1061
    def get_public_branch(self):
 
1062
        """Return the public location of the branch.
 
1063
 
 
1064
        This is used by merge directives.
 
1065
        """
 
1066
        return self._get_config_location('public_branch')
 
1067
 
 
1068
    def set_public_branch(self, location):
 
1069
        """Return the submit location of the branch.
 
1070
 
 
1071
        This is the default location for bundle.  The usual
 
1072
        pattern is that the user can override it by specifying a
 
1073
        location.
 
1074
        """
 
1075
        self._set_config_location('public_branch', location)
 
1076
 
 
1077
    def get_push_location(self):
 
1078
        """Return the None or the location to push this branch to."""
 
1079
        push_loc = self.get_config().get_user_option('push_location')
 
1080
        return push_loc
 
1081
 
 
1082
    def set_push_location(self, location):
 
1083
        """Set a new push location for this branch."""
 
1084
        raise NotImplementedError(self.set_push_location)
 
1085
 
 
1086
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
 
1087
        """Run the post_change_branch_tip hooks."""
 
1088
        hooks = Branch.hooks['post_change_branch_tip']
 
1089
        if not hooks:
 
1090
            return
 
1091
        new_revno, new_revid = self.last_revision_info()
 
1092
        params = ChangeBranchTipParams(
 
1093
            self, old_revno, new_revno, old_revid, new_revid)
 
1094
        for hook in hooks:
 
1095
            hook(params)
 
1096
 
 
1097
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
 
1098
        """Run the pre_change_branch_tip hooks."""
 
1099
        hooks = Branch.hooks['pre_change_branch_tip']
 
1100
        if not hooks:
 
1101
            return
 
1102
        old_revno, old_revid = self.last_revision_info()
 
1103
        params = ChangeBranchTipParams(
 
1104
            self, old_revno, new_revno, old_revid, new_revid)
 
1105
        for hook in hooks:
 
1106
            hook(params)
 
1107
 
 
1108
    @needs_write_lock
 
1109
    def update(self):
 
1110
        """Synchronise this branch with the master branch if any.
 
1111
 
 
1112
        :return: None or the last_revision pivoted out during the update.
 
1113
        """
 
1114
        return None
 
1115
 
 
1116
    def check_revno(self, revno):
 
1117
        """\
 
1118
        Check whether a revno corresponds to any revision.
 
1119
        Zero (the NULL revision) is considered valid.
 
1120
        """
 
1121
        if revno != 0:
 
1122
            self.check_real_revno(revno)
 
1123
 
 
1124
    def check_real_revno(self, revno):
 
1125
        """\
 
1126
        Check whether a revno corresponds to a real revision.
 
1127
        Zero (the NULL revision) is considered invalid
 
1128
        """
 
1129
        if revno < 1 or revno > self.revno():
 
1130
            raise errors.InvalidRevisionNumber(revno)
 
1131
 
 
1132
    @needs_read_lock
 
1133
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1134
        """Clone this branch into to_bzrdir preserving all semantic values.
 
1135
 
 
1136
        Most API users will want 'create_clone_on_transport', which creates a
 
1137
        new bzrdir and branch on the fly.
 
1138
 
 
1139
        revision_id: if not None, the revision history in the new branch will
 
1140
                     be truncated to end with revision_id.
 
1141
        """
 
1142
        result = to_bzrdir.create_branch()
 
1143
        result.lock_write()
 
1144
        try:
 
1145
            if repository_policy is not None:
 
1146
                repository_policy.configure_branch(result)
 
1147
            self.copy_content_into(result, revision_id=revision_id)
 
1148
        finally:
 
1149
            result.unlock()
 
1150
        return result
 
1151
 
 
1152
    @needs_read_lock
 
1153
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1154
        """Create a new line of development from the branch, into to_bzrdir.
 
1155
 
 
1156
        to_bzrdir controls the branch format.
 
1157
 
 
1158
        revision_id: if not None, the revision history in the new branch will
 
1159
                     be truncated to end with revision_id.
 
1160
        """
 
1161
        if (repository_policy is not None and
 
1162
            repository_policy.requires_stacking()):
 
1163
            to_bzrdir._format.require_stacking(_skip_repo=True)
 
1164
        result = to_bzrdir.create_branch()
 
1165
        result.lock_write()
 
1166
        try:
 
1167
            if repository_policy is not None:
 
1168
                repository_policy.configure_branch(result)
 
1169
            self.copy_content_into(result, revision_id=revision_id)
 
1170
            result.set_parent(self.bzrdir.root_transport.base)
 
1171
        finally:
 
1172
            result.unlock()
 
1173
        return result
 
1174
 
 
1175
    def _synchronize_history(self, destination, revision_id):
 
1176
        """Synchronize last revision and revision history between branches.
 
1177
 
 
1178
        This version is most efficient when the destination is also a
 
1179
        BzrBranch6, but works for BzrBranch5, as long as the destination's
 
1180
        repository contains all the lefthand ancestors of the intended
 
1181
        last_revision.  If not, set_last_revision_info will fail.
 
1182
 
 
1183
        :param destination: The branch to copy the history into
 
1184
        :param revision_id: The revision-id to truncate history at.  May
 
1185
          be None to copy complete history.
 
1186
        """
 
1187
        source_revno, source_revision_id = self.last_revision_info()
 
1188
        if revision_id is None:
 
1189
            revno, revision_id = source_revno, source_revision_id
 
1190
        else:
 
1191
            graph = self.repository.get_graph()
 
1192
            try:
 
1193
                revno = graph.find_distance_to_null(revision_id, 
 
1194
                    [(source_revision_id, source_revno)])
 
1195
            except errors.GhostRevisionsHaveNoRevno:
 
1196
                # Default to 1, if we can't find anything else
 
1197
                revno = 1
 
1198
        destination.set_last_revision_info(revno, revision_id)
 
1199
 
 
1200
    @needs_read_lock
 
1201
    def copy_content_into(self, destination, revision_id=None):
 
1202
        """Copy the content of self into destination.
 
1203
 
 
1204
        revision_id: if not None, the revision history in the new branch will
 
1205
                     be truncated to end with revision_id.
 
1206
        """
 
1207
        self.update_references(destination)
 
1208
        self._synchronize_history(destination, revision_id)
 
1209
        try:
 
1210
            parent = self.get_parent()
 
1211
        except errors.InaccessibleParent, e:
 
1212
            mutter('parent was not accessible to copy: %s', e)
 
1213
        else:
 
1214
            if parent:
 
1215
                destination.set_parent(parent)
 
1216
        if self._push_should_merge_tags():
 
1217
            self.tags.merge_to(destination.tags)
 
1218
 
 
1219
    def update_references(self, target):
 
1220
        if not getattr(self._format, 'supports_reference_locations', False):
 
1221
            return
 
1222
        reference_dict = self._get_all_reference_info()
 
1223
        if len(reference_dict) == 0:
 
1224
            return
 
1225
        old_base = self.base
 
1226
        new_base = target.base
 
1227
        target_reference_dict = target._get_all_reference_info()
 
1228
        for file_id, (tree_path, branch_location) in (
 
1229
            reference_dict.items()):
 
1230
            branch_location = urlutils.rebase_url(branch_location,
 
1231
                                                  old_base, new_base)
 
1232
            target_reference_dict.setdefault(
 
1233
                file_id, (tree_path, branch_location))
 
1234
        target._set_all_reference_info(target_reference_dict)
 
1235
 
 
1236
    @needs_read_lock
 
1237
    def check(self, refs):
 
1238
        """Check consistency of the branch.
 
1239
 
 
1240
        In particular this checks that revisions given in the revision-history
 
1241
        do actually match up in the revision graph, and that they're all
 
1242
        present in the repository.
 
1243
 
 
1244
        Callers will typically also want to check the repository.
 
1245
 
 
1246
        :param refs: Calculated refs for this branch as specified by
 
1247
            branch._get_check_refs()
 
1248
        :return: A BranchCheckResult.
 
1249
        """
 
1250
        result = BranchCheckResult(self)
 
1251
        last_revno, last_revision_id = self.last_revision_info()
 
1252
        actual_revno = refs[('lefthand-distance', last_revision_id)]
 
1253
        if actual_revno != last_revno:
 
1254
            result.errors.append(errors.BzrCheckError(
 
1255
                'revno does not match len(mainline) %s != %s' % (
 
1256
                last_revno, actual_revno)))
 
1257
        # TODO: We should probably also check that self.revision_history
 
1258
        # matches the repository for older branch formats.
 
1259
        # If looking for the code that cross-checks repository parents against
 
1260
        # the iter_reverse_revision_history output, that is now a repository
 
1261
        # specific check.
 
1262
        return result
 
1263
 
 
1264
    def _get_checkout_format(self):
 
1265
        """Return the most suitable metadir for a checkout of this branch.
 
1266
        Weaves are used if this branch's repository uses weaves.
 
1267
        """
 
1268
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
1269
            from bzrlib.repofmt import weaverepo
 
1270
            format = bzrdir.BzrDirMetaFormat1()
 
1271
            format.repository_format = weaverepo.RepositoryFormat7()
 
1272
        else:
 
1273
            format = self.repository.bzrdir.checkout_metadir()
 
1274
            format.set_branch_format(self._format)
 
1275
        return format
 
1276
 
 
1277
    def create_clone_on_transport(self, to_transport, revision_id=None,
 
1278
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1279
        """Create a clone of this branch and its bzrdir.
 
1280
 
 
1281
        :param to_transport: The transport to clone onto.
 
1282
        :param revision_id: The revision id to use as tip in the new branch.
 
1283
            If None the tip is obtained from this branch.
 
1284
        :param stacked_on: An optional URL to stack the clone on.
 
1285
        :param create_prefix: Create any missing directories leading up to
 
1286
            to_transport.
 
1287
        :param use_existing_dir: Use an existing directory if one exists.
 
1288
        """
 
1289
        # XXX: Fix the bzrdir API to allow getting the branch back from the
 
1290
        # clone call. Or something. 20090224 RBC/spiv.
 
1291
        if revision_id is None:
 
1292
            revision_id = self.last_revision()
 
1293
        dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1294
            revision_id=revision_id, stacked_on=stacked_on,
 
1295
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1296
        return dir_to.open_branch()
 
1297
 
 
1298
    def create_checkout(self, to_location, revision_id=None,
 
1299
                        lightweight=False, accelerator_tree=None,
 
1300
                        hardlink=False):
 
1301
        """Create a checkout of a branch.
 
1302
 
 
1303
        :param to_location: The url to produce the checkout at
 
1304
        :param revision_id: The revision to check out
 
1305
        :param lightweight: If True, produce a lightweight checkout, otherwise,
 
1306
        produce a bound branch (heavyweight checkout)
 
1307
        :param accelerator_tree: A tree which can be used for retrieving file
 
1308
            contents more quickly than the revision tree, i.e. a workingtree.
 
1309
            The revision tree will be used for cases where accelerator_tree's
 
1310
            content is different.
 
1311
        :param hardlink: If true, hard-link files from accelerator_tree,
 
1312
            where possible.
 
1313
        :return: The tree of the created checkout
 
1314
        """
 
1315
        t = transport.get_transport(to_location)
 
1316
        t.ensure_base()
 
1317
        if lightweight:
 
1318
            format = self._get_checkout_format()
 
1319
            checkout = format.initialize_on_transport(t)
 
1320
            from_branch = BranchReferenceFormat().initialize(checkout, self)
 
1321
        else:
 
1322
            format = self._get_checkout_format()
 
1323
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
 
1324
                to_location, force_new_tree=False, format=format)
 
1325
            checkout = checkout_branch.bzrdir
 
1326
            checkout_branch.bind(self)
 
1327
            # pull up to the specified revision_id to set the initial
 
1328
            # branch tip correctly, and seed it with history.
 
1329
            checkout_branch.pull(self, stop_revision=revision_id)
 
1330
            from_branch=None
 
1331
        tree = checkout.create_workingtree(revision_id,
 
1332
                                           from_branch=from_branch,
 
1333
                                           accelerator_tree=accelerator_tree,
 
1334
                                           hardlink=hardlink)
 
1335
        basis_tree = tree.basis_tree()
 
1336
        basis_tree.lock_read()
 
1337
        try:
 
1338
            for path, file_id in basis_tree.iter_references():
 
1339
                reference_parent = self.reference_parent(file_id, path)
 
1340
                reference_parent.create_checkout(tree.abspath(path),
 
1341
                    basis_tree.get_reference_revision(file_id, path),
 
1342
                    lightweight)
 
1343
        finally:
 
1344
            basis_tree.unlock()
 
1345
        return tree
 
1346
 
 
1347
    @needs_write_lock
 
1348
    def reconcile(self, thorough=True):
 
1349
        """Make sure the data stored in this branch is consistent."""
 
1350
        from bzrlib.reconcile import BranchReconciler
 
1351
        reconciler = BranchReconciler(self, thorough=thorough)
 
1352
        reconciler.reconcile()
 
1353
        return reconciler
 
1354
 
 
1355
    def reference_parent(self, file_id, path, possible_transports=None):
 
1356
        """Return the parent branch for a tree-reference file_id
 
1357
        :param file_id: The file_id of the tree reference
 
1358
        :param path: The path of the file_id in the tree
 
1359
        :return: A branch associated with the file_id
 
1360
        """
 
1361
        # FIXME should provide multiple branches, based on config
 
1362
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
 
1363
                           possible_transports=possible_transports)
 
1364
 
 
1365
    def supports_tags(self):
 
1366
        return self._format.supports_tags()
 
1367
 
 
1368
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
 
1369
                                         other_branch):
 
1370
        """Ensure that revision_b is a descendant of revision_a.
 
1371
 
 
1372
        This is a helper function for update_revisions.
 
1373
 
 
1374
        :raises: DivergedBranches if revision_b has diverged from revision_a.
 
1375
        :returns: True if revision_b is a descendant of revision_a.
 
1376
        """
 
1377
        relation = self._revision_relations(revision_a, revision_b, graph)
 
1378
        if relation == 'b_descends_from_a':
 
1379
            return True
 
1380
        elif relation == 'diverged':
 
1381
            raise errors.DivergedBranches(self, other_branch)
 
1382
        elif relation == 'a_descends_from_b':
 
1383
            return False
 
1384
        else:
 
1385
            raise AssertionError("invalid relation: %r" % (relation,))
 
1386
 
 
1387
    def _revision_relations(self, revision_a, revision_b, graph):
 
1388
        """Determine the relationship between two revisions.
 
1389
 
 
1390
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
 
1391
        """
 
1392
        heads = graph.heads([revision_a, revision_b])
 
1393
        if heads == set([revision_b]):
 
1394
            return 'b_descends_from_a'
 
1395
        elif heads == set([revision_a, revision_b]):
 
1396
            # These branches have diverged
 
1397
            return 'diverged'
 
1398
        elif heads == set([revision_a]):
 
1399
            return 'a_descends_from_b'
 
1400
        else:
 
1401
            raise AssertionError("invalid heads: %r" % (heads,))
 
1402
 
 
1403
 
 
1404
class BranchFormat(object):
 
1405
    """An encapsulation of the initialization and open routines for a format.
 
1406
 
 
1407
    Formats provide three things:
 
1408
     * An initialization routine,
 
1409
     * a format string,
 
1410
     * an open routine.
 
1411
 
 
1412
    Formats are placed in an dict by their format string for reference
 
1413
    during branch opening. Its not required that these be instances, they
 
1414
    can be classes themselves with class methods - it simply depends on
 
1415
    whether state is needed for a given format or not.
 
1416
 
 
1417
    Once a format is deprecated, just deprecate the initialize and open
 
1418
    methods on the format class. Do not deprecate the object, as the
 
1419
    object will be created every time regardless.
 
1420
    """
 
1421
 
 
1422
    _default_format = None
 
1423
    """The default format used for new branches."""
 
1424
 
 
1425
    _formats = {}
 
1426
    """The known formats."""
 
1427
 
 
1428
    can_set_append_revisions_only = True
 
1429
 
 
1430
    def __eq__(self, other):
 
1431
        return self.__class__ is other.__class__
 
1432
 
 
1433
    def __ne__(self, other):
 
1434
        return not (self == other)
 
1435
 
 
1436
    @classmethod
 
1437
    def find_format(klass, a_bzrdir):
 
1438
        """Return the format for the branch object in a_bzrdir."""
 
1439
        try:
 
1440
            transport = a_bzrdir.get_branch_transport(None)
 
1441
            format_string = transport.get_bytes("format")
 
1442
            return klass._formats[format_string]
 
1443
        except errors.NoSuchFile:
 
1444
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1445
        except KeyError:
 
1446
            raise errors.UnknownFormatError(format=format_string, kind='branch')
 
1447
 
 
1448
    @classmethod
 
1449
    def get_default_format(klass):
 
1450
        """Return the current default format."""
 
1451
        return klass._default_format
 
1452
 
 
1453
    def get_reference(self, a_bzrdir):
 
1454
        """Get the target reference of the branch in a_bzrdir.
 
1455
 
 
1456
        format probing must have been completed before calling
 
1457
        this method - it is assumed that the format of the branch
 
1458
        in a_bzrdir is correct.
 
1459
 
 
1460
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1461
        :return: None if the branch is not a reference branch.
 
1462
        """
 
1463
        return None
 
1464
 
 
1465
    @classmethod
 
1466
    def set_reference(self, a_bzrdir, to_branch):
 
1467
        """Set the target reference of the branch in a_bzrdir.
 
1468
 
 
1469
        format probing must have been completed before calling
 
1470
        this method - it is assumed that the format of the branch
 
1471
        in a_bzrdir is correct.
 
1472
 
 
1473
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1474
        :param to_branch: branch that the checkout is to reference
 
1475
        """
 
1476
        raise NotImplementedError(self.set_reference)
 
1477
 
 
1478
    def get_format_string(self):
 
1479
        """Return the ASCII format string that identifies this format."""
 
1480
        raise NotImplementedError(self.get_format_string)
 
1481
 
 
1482
    def get_format_description(self):
 
1483
        """Return the short format description for this format."""
 
1484
        raise NotImplementedError(self.get_format_description)
 
1485
 
 
1486
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1487
                           set_format=True):
 
1488
        """Initialize a branch in a bzrdir, with specified files
 
1489
 
 
1490
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1491
        :param utf8_files: The files to create as a list of
 
1492
            (filename, content) tuples
 
1493
        :param set_format: If True, set the format with
 
1494
            self.get_format_string.  (BzrBranch4 has its format set
 
1495
            elsewhere)
 
1496
        :return: a branch in this format
 
1497
        """
 
1498
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1499
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1500
        lock_map = {
 
1501
            'metadir': ('lock', lockdir.LockDir),
 
1502
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
1503
        }
 
1504
        lock_name, lock_class = lock_map[lock_type]
 
1505
        control_files = lockable_files.LockableFiles(branch_transport,
 
1506
            lock_name, lock_class)
 
1507
        control_files.create_lock()
 
1508
        try:
 
1509
            control_files.lock_write()
 
1510
        except errors.LockContention:
 
1511
            if lock_type != 'branch4':
 
1512
                raise
 
1513
            lock_taken = False
 
1514
        else:
 
1515
            lock_taken = True
 
1516
        if set_format:
 
1517
            utf8_files += [('format', self.get_format_string())]
 
1518
        try:
 
1519
            for (filename, content) in utf8_files:
 
1520
                branch_transport.put_bytes(
 
1521
                    filename, content,
 
1522
                    mode=a_bzrdir._get_file_mode())
 
1523
        finally:
 
1524
            if lock_taken:
 
1525
                control_files.unlock()
 
1526
        return self.open(a_bzrdir, _found=True)
 
1527
 
 
1528
    def initialize(self, a_bzrdir):
 
1529
        """Create a branch of this format in a_bzrdir."""
 
1530
        raise NotImplementedError(self.initialize)
 
1531
 
 
1532
    def is_supported(self):
 
1533
        """Is this format supported?
 
1534
 
 
1535
        Supported formats can be initialized and opened.
 
1536
        Unsupported formats may not support initialization or committing or
 
1537
        some other features depending on the reason for not being supported.
 
1538
        """
 
1539
        return True
 
1540
 
 
1541
    def make_tags(self, branch):
 
1542
        """Create a tags object for branch.
 
1543
 
 
1544
        This method is on BranchFormat, because BranchFormats are reflected
 
1545
        over the wire via network_name(), whereas full Branch instances require
 
1546
        multiple VFS method calls to operate at all.
 
1547
 
 
1548
        The default implementation returns a disabled-tags instance.
 
1549
 
 
1550
        Note that it is normal for branch to be a RemoteBranch when using tags
 
1551
        on a RemoteBranch.
 
1552
        """
 
1553
        return DisabledTags(branch)
 
1554
 
 
1555
    def network_name(self):
 
1556
        """A simple byte string uniquely identifying this format for RPC calls.
 
1557
 
 
1558
        MetaDir branch formats use their disk format string to identify the
 
1559
        repository over the wire. All in one formats such as bzr < 0.8, and
 
1560
        foreign formats like svn/git and hg should use some marker which is
 
1561
        unique and immutable.
 
1562
        """
 
1563
        raise NotImplementedError(self.network_name)
 
1564
 
 
1565
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1566
        """Return the branch object for a_bzrdir
 
1567
 
 
1568
        :param a_bzrdir: A BzrDir that contains a branch.
 
1569
        :param _found: a private parameter, do not use it. It is used to
 
1570
            indicate if format probing has already be done.
 
1571
        :param ignore_fallbacks: when set, no fallback branches will be opened
 
1572
            (if there are any).  Default is to open fallbacks.
 
1573
        """
 
1574
        raise NotImplementedError(self.open)
 
1575
 
 
1576
    @classmethod
 
1577
    def register_format(klass, format):
 
1578
        """Register a metadir format."""
 
1579
        klass._formats[format.get_format_string()] = format
 
1580
        # Metadir formats have a network name of their format string, and get
 
1581
        # registered as class factories.
 
1582
        network_format_registry.register(format.get_format_string(), format.__class__)
 
1583
 
 
1584
    @classmethod
 
1585
    def set_default_format(klass, format):
 
1586
        klass._default_format = format
 
1587
 
 
1588
    def supports_set_append_revisions_only(self):
 
1589
        """True if this format supports set_append_revisions_only."""
 
1590
        return False
 
1591
 
 
1592
    def supports_stacking(self):
 
1593
        """True if this format records a stacked-on branch."""
 
1594
        return False
 
1595
 
 
1596
    @classmethod
 
1597
    def unregister_format(klass, format):
 
1598
        del klass._formats[format.get_format_string()]
 
1599
 
 
1600
    def __str__(self):
 
1601
        return self.get_format_description().rstrip()
 
1602
 
 
1603
    def supports_tags(self):
 
1604
        """True if this format supports tags stored in the branch"""
 
1605
        return False  # by default
 
1606
 
 
1607
 
 
1608
class BranchHooks(Hooks):
 
1609
    """A dictionary mapping hook name to a list of callables for branch hooks.
 
1610
 
 
1611
    e.g. ['set_rh'] Is the list of items to be called when the
 
1612
    set_revision_history function is invoked.
 
1613
    """
 
1614
 
 
1615
    def __init__(self):
 
1616
        """Create the default hooks.
 
1617
 
 
1618
        These are all empty initially, because by default nothing should get
 
1619
        notified.
 
1620
        """
 
1621
        Hooks.__init__(self)
 
1622
        self.create_hook(HookPoint('set_rh',
 
1623
            "Invoked whenever the revision history has been set via "
 
1624
            "set_revision_history. The api signature is (branch, "
 
1625
            "revision_history), and the branch will be write-locked. "
 
1626
            "The set_rh hook can be expensive for bzr to trigger, a better "
 
1627
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1628
        self.create_hook(HookPoint('open',
 
1629
            "Called with the Branch object that has been opened after a "
 
1630
            "branch is opened.", (1, 8), None))
 
1631
        self.create_hook(HookPoint('post_push',
 
1632
            "Called after a push operation completes. post_push is called "
 
1633
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
 
1634
            "bzr client.", (0, 15), None))
 
1635
        self.create_hook(HookPoint('post_pull',
 
1636
            "Called after a pull operation completes. post_pull is called "
 
1637
            "with a bzrlib.branch.PullResult object and only runs in the "
 
1638
            "bzr client.", (0, 15), None))
 
1639
        self.create_hook(HookPoint('pre_commit',
 
1640
            "Called after a commit is calculated but before it is is "
 
1641
            "completed. pre_commit is called with (local, master, old_revno, "
 
1642
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
 
1643
            "). old_revid is NULL_REVISION for the first commit to a branch, "
 
1644
            "tree_delta is a TreeDelta object describing changes from the "
 
1645
            "basis revision. hooks MUST NOT modify this delta. "
 
1646
            " future_tree is an in-memory tree obtained from "
 
1647
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
 
1648
            "tree.", (0,91), None))
 
1649
        self.create_hook(HookPoint('post_commit',
 
1650
            "Called in the bzr client after a commit has completed. "
 
1651
            "post_commit is called with (local, master, old_revno, old_revid, "
 
1652
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
 
1653
            "commit to a branch.", (0, 15), None))
 
1654
        self.create_hook(HookPoint('post_uncommit',
 
1655
            "Called in the bzr client after an uncommit completes. "
 
1656
            "post_uncommit is called with (local, master, old_revno, "
 
1657
            "old_revid, new_revno, new_revid) where local is the local branch "
 
1658
            "or None, master is the target branch, and an empty branch "
 
1659
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1660
        self.create_hook(HookPoint('pre_change_branch_tip',
 
1661
            "Called in bzr client and server before a change to the tip of a "
 
1662
            "branch is made. pre_change_branch_tip is called with a "
 
1663
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
 
1664
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1665
        self.create_hook(HookPoint('post_change_branch_tip',
 
1666
            "Called in bzr client and server after a change to the tip of a "
 
1667
            "branch is made. post_change_branch_tip is called with a "
 
1668
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
 
1669
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1670
        self.create_hook(HookPoint('transform_fallback_location',
 
1671
            "Called when a stacked branch is activating its fallback "
 
1672
            "locations. transform_fallback_location is called with (branch, "
 
1673
            "url), and should return a new url. Returning the same url "
 
1674
            "allows it to be used as-is, returning a different one can be "
 
1675
            "used to cause the branch to stack on a closer copy of that "
 
1676
            "fallback_location. Note that the branch cannot have history "
 
1677
            "accessing methods called on it during this hook because the "
 
1678
            "fallback locations have not been activated. When there are "
 
1679
            "multiple hooks installed for transform_fallback_location, "
 
1680
            "all are called with the url returned from the previous hook."
 
1681
            "The order is however undefined.", (1, 9), None))
 
1682
 
 
1683
 
 
1684
# install the default hooks into the Branch class.
 
1685
Branch.hooks = BranchHooks()
 
1686
 
 
1687
 
 
1688
class ChangeBranchTipParams(object):
 
1689
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1690
 
 
1691
    There are 5 fields that hooks may wish to access:
 
1692
 
 
1693
    :ivar branch: the branch being changed
 
1694
    :ivar old_revno: revision number before the change
 
1695
    :ivar new_revno: revision number after the change
 
1696
    :ivar old_revid: revision id before the change
 
1697
    :ivar new_revid: revision id after the change
 
1698
 
 
1699
    The revid fields are strings. The revno fields are integers.
 
1700
    """
 
1701
 
 
1702
    def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
 
1703
        """Create a group of ChangeBranchTip parameters.
 
1704
 
 
1705
        :param branch: The branch being changed.
 
1706
        :param old_revno: Revision number before the change.
 
1707
        :param new_revno: Revision number after the change.
 
1708
        :param old_revid: Tip revision id before the change.
 
1709
        :param new_revid: Tip revision id after the change.
 
1710
        """
 
1711
        self.branch = branch
 
1712
        self.old_revno = old_revno
 
1713
        self.new_revno = new_revno
 
1714
        self.old_revid = old_revid
 
1715
        self.new_revid = new_revid
 
1716
 
 
1717
    def __eq__(self, other):
 
1718
        return self.__dict__ == other.__dict__
 
1719
 
 
1720
    def __repr__(self):
 
1721
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
 
1722
            self.__class__.__name__, self.branch,
 
1723
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
 
1724
 
 
1725
 
 
1726
class BzrBranchFormat4(BranchFormat):
 
1727
    """Bzr branch format 4.
 
1728
 
 
1729
    This format has:
 
1730
     - a revision-history file.
 
1731
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
1732
    """
 
1733
 
 
1734
    def get_format_description(self):
 
1735
        """See BranchFormat.get_format_description()."""
 
1736
        return "Branch format 4"
 
1737
 
 
1738
    def initialize(self, a_bzrdir):
 
1739
        """Create a branch of this format in a_bzrdir."""
 
1740
        utf8_files = [('revision-history', ''),
 
1741
                      ('branch-name', ''),
 
1742
                      ]
 
1743
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1744
                                       lock_type='branch4', set_format=False)
 
1745
 
 
1746
    def __init__(self):
 
1747
        super(BzrBranchFormat4, self).__init__()
 
1748
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1749
 
 
1750
    def network_name(self):
 
1751
        """The network name for this format is the control dirs disk label."""
 
1752
        return self._matchingbzrdir.get_format_string()
 
1753
 
 
1754
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1755
        """See BranchFormat.open()."""
 
1756
        if not _found:
 
1757
            # we are being called directly and must probe.
 
1758
            raise NotImplementedError
 
1759
        return BzrBranch(_format=self,
 
1760
                         _control_files=a_bzrdir._control_files,
 
1761
                         a_bzrdir=a_bzrdir,
 
1762
                         _repository=a_bzrdir.open_repository())
 
1763
 
 
1764
    def __str__(self):
 
1765
        return "Bazaar-NG branch format 4"
 
1766
 
 
1767
 
 
1768
class BranchFormatMetadir(BranchFormat):
 
1769
    """Common logic for meta-dir based branch formats."""
 
1770
 
 
1771
    def _branch_class(self):
 
1772
        """What class to instantiate on open calls."""
 
1773
        raise NotImplementedError(self._branch_class)
 
1774
 
 
1775
    def network_name(self):
 
1776
        """A simple byte string uniquely identifying this format for RPC calls.
 
1777
 
 
1778
        Metadir branch formats use their format string.
 
1779
        """
 
1780
        return self.get_format_string()
 
1781
 
 
1782
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1783
        """See BranchFormat.open()."""
 
1784
        if not _found:
 
1785
            format = BranchFormat.find_format(a_bzrdir)
 
1786
            if format.__class__ != self.__class__:
 
1787
                raise AssertionError("wrong format %r found for %r" %
 
1788
                    (format, self))
 
1789
        try:
 
1790
            transport = a_bzrdir.get_branch_transport(None)
 
1791
            control_files = lockable_files.LockableFiles(transport, 'lock',
 
1792
                                                         lockdir.LockDir)
 
1793
            return self._branch_class()(_format=self,
 
1794
                              _control_files=control_files,
 
1795
                              a_bzrdir=a_bzrdir,
 
1796
                              _repository=a_bzrdir.find_repository(),
 
1797
                              ignore_fallbacks=ignore_fallbacks)
 
1798
        except errors.NoSuchFile:
 
1799
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1800
 
 
1801
    def __init__(self):
 
1802
        super(BranchFormatMetadir, self).__init__()
 
1803
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1804
        self._matchingbzrdir.set_branch_format(self)
 
1805
 
 
1806
    def supports_tags(self):
 
1807
        return True
 
1808
 
 
1809
 
 
1810
class BzrBranchFormat5(BranchFormatMetadir):
 
1811
    """Bzr branch format 5.
 
1812
 
 
1813
    This format has:
 
1814
     - a revision-history file.
 
1815
     - a format string
 
1816
     - a lock dir guarding the branch itself
 
1817
     - all of this stored in a branch/ subdirectory
 
1818
     - works with shared repositories.
 
1819
 
 
1820
    This format is new in bzr 0.8.
 
1821
    """
 
1822
 
 
1823
    def _branch_class(self):
 
1824
        return BzrBranch5
 
1825
 
 
1826
    def get_format_string(self):
 
1827
        """See BranchFormat.get_format_string()."""
 
1828
        return "Bazaar-NG branch format 5\n"
 
1829
 
 
1830
    def get_format_description(self):
 
1831
        """See BranchFormat.get_format_description()."""
 
1832
        return "Branch format 5"
 
1833
 
 
1834
    def initialize(self, a_bzrdir):
 
1835
        """Create a branch of this format in a_bzrdir."""
 
1836
        utf8_files = [('revision-history', ''),
 
1837
                      ('branch-name', ''),
 
1838
                      ]
 
1839
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1840
 
 
1841
    def supports_tags(self):
 
1842
        return False
 
1843
 
 
1844
 
 
1845
class BzrBranchFormat6(BranchFormatMetadir):
 
1846
    """Branch format with last-revision and tags.
 
1847
 
 
1848
    Unlike previous formats, this has no explicit revision history. Instead,
 
1849
    this just stores the last-revision, and the left-hand history leading
 
1850
    up to there is the history.
 
1851
 
 
1852
    This format was introduced in bzr 0.15
 
1853
    and became the default in 0.91.
 
1854
    """
 
1855
 
 
1856
    def _branch_class(self):
 
1857
        return BzrBranch6
 
1858
 
 
1859
    def get_format_string(self):
 
1860
        """See BranchFormat.get_format_string()."""
 
1861
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
 
1862
 
 
1863
    def get_format_description(self):
 
1864
        """See BranchFormat.get_format_description()."""
 
1865
        return "Branch format 6"
 
1866
 
 
1867
    def initialize(self, a_bzrdir):
 
1868
        """Create a branch of this format in a_bzrdir."""
 
1869
        utf8_files = [('last-revision', '0 null:\n'),
 
1870
                      ('branch.conf', ''),
 
1871
                      ('tags', ''),
 
1872
                      ]
 
1873
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1874
 
 
1875
    def make_tags(self, branch):
 
1876
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1877
        return BasicTags(branch)
 
1878
 
 
1879
    def supports_set_append_revisions_only(self):
 
1880
        return True
 
1881
 
 
1882
 
 
1883
class BzrBranchFormat8(BranchFormatMetadir):
 
1884
    """Metadir format supporting storing locations of subtree branches."""
 
1885
 
 
1886
    def _branch_class(self):
 
1887
        return BzrBranch8
 
1888
 
 
1889
    def get_format_string(self):
 
1890
        """See BranchFormat.get_format_string()."""
 
1891
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
 
1892
 
 
1893
    def get_format_description(self):
 
1894
        """See BranchFormat.get_format_description()."""
 
1895
        return "Branch format 8"
 
1896
 
 
1897
    def initialize(self, a_bzrdir):
 
1898
        """Create a branch of this format in a_bzrdir."""
 
1899
        utf8_files = [('last-revision', '0 null:\n'),
 
1900
                      ('branch.conf', ''),
 
1901
                      ('tags', ''),
 
1902
                      ('references', '')
 
1903
                      ]
 
1904
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1905
 
 
1906
    def __init__(self):
 
1907
        super(BzrBranchFormat8, self).__init__()
 
1908
        self._matchingbzrdir.repository_format = \
 
1909
            RepositoryFormatKnitPack5RichRoot()
 
1910
 
 
1911
    def make_tags(self, branch):
 
1912
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1913
        return BasicTags(branch)
 
1914
 
 
1915
    def supports_set_append_revisions_only(self):
 
1916
        return True
 
1917
 
 
1918
    def supports_stacking(self):
 
1919
        return True
 
1920
 
 
1921
    supports_reference_locations = True
 
1922
 
 
1923
 
 
1924
class BzrBranchFormat7(BzrBranchFormat8):
 
1925
    """Branch format with last-revision, tags, and a stacked location pointer.
 
1926
 
 
1927
    The stacked location pointer is passed down to the repository and requires
 
1928
    a repository format with supports_external_lookups = True.
 
1929
 
 
1930
    This format was introduced in bzr 1.6.
 
1931
    """
 
1932
 
 
1933
    def initialize(self, a_bzrdir):
 
1934
        """Create a branch of this format in a_bzrdir."""
 
1935
        utf8_files = [('last-revision', '0 null:\n'),
 
1936
                      ('branch.conf', ''),
 
1937
                      ('tags', ''),
 
1938
                      ]
 
1939
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1940
 
 
1941
    def _branch_class(self):
 
1942
        return BzrBranch7
 
1943
 
 
1944
    def get_format_string(self):
 
1945
        """See BranchFormat.get_format_string()."""
 
1946
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
 
1947
 
 
1948
    def get_format_description(self):
 
1949
        """See BranchFormat.get_format_description()."""
 
1950
        return "Branch format 7"
 
1951
 
 
1952
    def supports_set_append_revisions_only(self):
 
1953
        return True
 
1954
 
 
1955
    supports_reference_locations = False
 
1956
 
 
1957
 
 
1958
class BranchReferenceFormat(BranchFormat):
 
1959
    """Bzr branch reference format.
 
1960
 
 
1961
    Branch references are used in implementing checkouts, they
 
1962
    act as an alias to the real branch which is at some other url.
 
1963
 
 
1964
    This format has:
 
1965
     - A location file
 
1966
     - a format string
 
1967
    """
 
1968
 
 
1969
    def get_format_string(self):
 
1970
        """See BranchFormat.get_format_string()."""
 
1971
        return "Bazaar-NG Branch Reference Format 1\n"
 
1972
 
 
1973
    def get_format_description(self):
 
1974
        """See BranchFormat.get_format_description()."""
 
1975
        return "Checkout reference format 1"
 
1976
 
 
1977
    def get_reference(self, a_bzrdir):
 
1978
        """See BranchFormat.get_reference()."""
 
1979
        transport = a_bzrdir.get_branch_transport(None)
 
1980
        return transport.get_bytes('location')
 
1981
 
 
1982
    def set_reference(self, a_bzrdir, to_branch):
 
1983
        """See BranchFormat.set_reference()."""
 
1984
        transport = a_bzrdir.get_branch_transport(None)
 
1985
        location = transport.put_bytes('location', to_branch.base)
 
1986
 
 
1987
    def initialize(self, a_bzrdir, target_branch=None):
 
1988
        """Create a branch of this format in a_bzrdir."""
 
1989
        if target_branch is None:
 
1990
            # this format does not implement branch itself, thus the implicit
 
1991
            # creation contract must see it as uninitializable
 
1992
            raise errors.UninitializableFormat(self)
 
1993
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1994
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1995
        branch_transport.put_bytes('location',
 
1996
            target_branch.bzrdir.root_transport.base)
 
1997
        branch_transport.put_bytes('format', self.get_format_string())
 
1998
        return self.open(
 
1999
            a_bzrdir, _found=True,
 
2000
            possible_transports=[target_branch.bzrdir.root_transport])
 
2001
 
 
2002
    def __init__(self):
 
2003
        super(BranchReferenceFormat, self).__init__()
 
2004
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
2005
        self._matchingbzrdir.set_branch_format(self)
 
2006
 
 
2007
    def _make_reference_clone_function(format, a_branch):
 
2008
        """Create a clone() routine for a branch dynamically."""
 
2009
        def clone(to_bzrdir, revision_id=None,
 
2010
            repository_policy=None):
 
2011
            """See Branch.clone()."""
 
2012
            return format.initialize(to_bzrdir, a_branch)
 
2013
            # cannot obey revision_id limits when cloning a reference ...
 
2014
            # FIXME RBC 20060210 either nuke revision_id for clone, or
 
2015
            # emit some sort of warning/error to the caller ?!
 
2016
        return clone
 
2017
 
 
2018
    def open(self, a_bzrdir, _found=False, location=None,
 
2019
             possible_transports=None, ignore_fallbacks=False):
 
2020
        """Return the branch that the branch reference in a_bzrdir points at.
 
2021
 
 
2022
        :param a_bzrdir: A BzrDir that contains a branch.
 
2023
        :param _found: a private parameter, do not use it. It is used to
 
2024
            indicate if format probing has already be done.
 
2025
        :param ignore_fallbacks: when set, no fallback branches will be opened
 
2026
            (if there are any).  Default is to open fallbacks.
 
2027
        :param location: The location of the referenced branch.  If
 
2028
            unspecified, this will be determined from the branch reference in
 
2029
            a_bzrdir.
 
2030
        :param possible_transports: An optional reusable transports list.
 
2031
        """
 
2032
        if not _found:
 
2033
            format = BranchFormat.find_format(a_bzrdir)
 
2034
            if format.__class__ != self.__class__:
 
2035
                raise AssertionError("wrong format %r found for %r" %
 
2036
                    (format, self))
 
2037
        if location is None:
 
2038
            location = self.get_reference(a_bzrdir)
 
2039
        real_bzrdir = bzrdir.BzrDir.open(
 
2040
            location, possible_transports=possible_transports)
 
2041
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
2042
        # this changes the behaviour of result.clone to create a new reference
 
2043
        # rather than a copy of the content of the branch.
 
2044
        # I did not use a proxy object because that needs much more extensive
 
2045
        # testing, and we are only changing one behaviour at the moment.
 
2046
        # If we decide to alter more behaviours - i.e. the implicit nickname
 
2047
        # then this should be refactored to introduce a tested proxy branch
 
2048
        # and a subclass of that for use in overriding clone() and ....
 
2049
        # - RBC 20060210
 
2050
        result.clone = self._make_reference_clone_function(result)
 
2051
        return result
 
2052
 
 
2053
 
 
2054
network_format_registry = registry.FormatRegistry()
 
2055
"""Registry of formats indexed by their network name.
 
2056
 
 
2057
The network name for a branch format is an identifier that can be used when
 
2058
referring to formats with smart server operations. See
 
2059
BranchFormat.network_name() for more detail.
 
2060
"""
 
2061
 
 
2062
 
 
2063
# formats which have no format string are not discoverable
 
2064
# and not independently creatable, so are not registered.
 
2065
__format5 = BzrBranchFormat5()
 
2066
__format6 = BzrBranchFormat6()
 
2067
__format7 = BzrBranchFormat7()
 
2068
__format8 = BzrBranchFormat8()
 
2069
BranchFormat.register_format(__format5)
 
2070
BranchFormat.register_format(BranchReferenceFormat())
 
2071
BranchFormat.register_format(__format6)
 
2072
BranchFormat.register_format(__format7)
 
2073
BranchFormat.register_format(__format8)
 
2074
BranchFormat.set_default_format(__format7)
 
2075
_legacy_formats = [BzrBranchFormat4(),
 
2076
    ]
 
2077
network_format_registry.register(
 
2078
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
2079
 
 
2080
 
 
2081
class BzrBranch(Branch, _RelockDebugMixin):
 
2082
    """A branch stored in the actual filesystem.
 
2083
 
 
2084
    Note that it's "local" in the context of the filesystem; it doesn't
 
2085
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
2086
    it's writable, and can be accessed via the normal filesystem API.
 
2087
 
 
2088
    :ivar _transport: Transport for file operations on this branch's
 
2089
        control files, typically pointing to the .bzr/branch directory.
 
2090
    :ivar repository: Repository for this branch.
 
2091
    :ivar base: The url of the base directory for this branch; the one
 
2092
        containing the .bzr directory.
 
2093
    """
 
2094
 
 
2095
    def __init__(self, _format=None,
 
2096
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2097
                 ignore_fallbacks=False):
 
2098
        """Create new branch object at a particular location."""
 
2099
        if a_bzrdir is None:
 
2100
            raise ValueError('a_bzrdir must be supplied')
 
2101
        else:
 
2102
            self.bzrdir = a_bzrdir
 
2103
        self._base = self.bzrdir.transport.clone('..').base
 
2104
        # XXX: We should be able to just do
 
2105
        #   self.base = self.bzrdir.root_transport.base
 
2106
        # but this does not quite work yet -- mbp 20080522
 
2107
        self._format = _format
 
2108
        if _control_files is None:
 
2109
            raise ValueError('BzrBranch _control_files is None')
 
2110
        self.control_files = _control_files
 
2111
        self._transport = _control_files._transport
 
2112
        self.repository = _repository
 
2113
        Branch.__init__(self)
 
2114
 
 
2115
    def __str__(self):
 
2116
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
2117
 
 
2118
    __repr__ = __str__
 
2119
 
 
2120
    def _get_base(self):
 
2121
        """Returns the directory containing the control directory."""
 
2122
        return self._base
 
2123
 
 
2124
    base = property(_get_base, doc="The URL for the root of this branch.")
 
2125
 
 
2126
    def _get_config(self):
 
2127
        return TransportConfig(self._transport, 'branch.conf')
 
2128
 
 
2129
    def is_locked(self):
 
2130
        return self.control_files.is_locked()
 
2131
 
 
2132
    def lock_write(self, token=None):
 
2133
        if not self.is_locked():
 
2134
            self._note_lock('w')
 
2135
        # All-in-one needs to always unlock/lock.
 
2136
        repo_control = getattr(self.repository, 'control_files', None)
 
2137
        if self.control_files == repo_control or not self.is_locked():
 
2138
            self.repository._warn_if_deprecated(self)
 
2139
            self.repository.lock_write()
 
2140
            took_lock = True
 
2141
        else:
 
2142
            took_lock = False
 
2143
        try:
 
2144
            return self.control_files.lock_write(token=token)
 
2145
        except:
 
2146
            if took_lock:
 
2147
                self.repository.unlock()
 
2148
            raise
 
2149
 
 
2150
    def lock_read(self):
 
2151
        if not self.is_locked():
 
2152
            self._note_lock('r')
 
2153
        # All-in-one needs to always unlock/lock.
 
2154
        repo_control = getattr(self.repository, 'control_files', None)
 
2155
        if self.control_files == repo_control or not self.is_locked():
 
2156
            self.repository._warn_if_deprecated(self)
 
2157
            self.repository.lock_read()
 
2158
            took_lock = True
 
2159
        else:
 
2160
            took_lock = False
 
2161
        try:
 
2162
            self.control_files.lock_read()
 
2163
        except:
 
2164
            if took_lock:
 
2165
                self.repository.unlock()
 
2166
            raise
 
2167
 
 
2168
    @only_raises(errors.LockNotHeld, errors.LockBroken)
 
2169
    def unlock(self):
 
2170
        try:
 
2171
            self.control_files.unlock()
 
2172
        finally:
 
2173
            # All-in-one needs to always unlock/lock.
 
2174
            repo_control = getattr(self.repository, 'control_files', None)
 
2175
            if (self.control_files == repo_control or
 
2176
                not self.control_files.is_locked()):
 
2177
                self.repository.unlock()
 
2178
            if not self.control_files.is_locked():
 
2179
                # we just released the lock
 
2180
                self._clear_cached_state()
 
2181
 
 
2182
    def peek_lock_mode(self):
 
2183
        if self.control_files._lock_count == 0:
 
2184
            return None
 
2185
        else:
 
2186
            return self.control_files._lock_mode
 
2187
 
 
2188
    def get_physical_lock_status(self):
 
2189
        return self.control_files.get_physical_lock_status()
 
2190
 
 
2191
    @needs_read_lock
 
2192
    def print_file(self, file, revision_id):
 
2193
        """See Branch.print_file."""
 
2194
        return self.repository.print_file(file, revision_id)
 
2195
 
 
2196
    def _write_revision_history(self, history):
 
2197
        """Factored out of set_revision_history.
 
2198
 
 
2199
        This performs the actual writing to disk.
 
2200
        It is intended to be called by BzrBranch5.set_revision_history."""
 
2201
        self._transport.put_bytes(
 
2202
            'revision-history', '\n'.join(history),
 
2203
            mode=self.bzrdir._get_file_mode())
 
2204
 
 
2205
    @needs_write_lock
 
2206
    def set_revision_history(self, rev_history):
 
2207
        """See Branch.set_revision_history."""
 
2208
        if 'evil' in debug.debug_flags:
 
2209
            mutter_callsite(3, "set_revision_history scales with history.")
 
2210
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2211
        for rev_id in rev_history:
 
2212
            check_not_reserved_id(rev_id)
 
2213
        if Branch.hooks['post_change_branch_tip']:
 
2214
            # Don't calculate the last_revision_info() if there are no hooks
 
2215
            # that will use it.
 
2216
            old_revno, old_revid = self.last_revision_info()
 
2217
        if len(rev_history) == 0:
 
2218
            revid = _mod_revision.NULL_REVISION
 
2219
        else:
 
2220
            revid = rev_history[-1]
 
2221
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2222
        self._write_revision_history(rev_history)
 
2223
        self._clear_cached_state()
 
2224
        self._cache_revision_history(rev_history)
 
2225
        for hook in Branch.hooks['set_rh']:
 
2226
            hook(self, rev_history)
 
2227
        if Branch.hooks['post_change_branch_tip']:
 
2228
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2229
 
 
2230
    def _synchronize_history(self, destination, revision_id):
 
2231
        """Synchronize last revision and revision history between branches.
 
2232
 
 
2233
        This version is most efficient when the destination is also a
 
2234
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
2235
        history is the true lefthand parent history, and all of the revisions
 
2236
        are in the destination's repository.  If not, set_revision_history
 
2237
        will fail.
 
2238
 
 
2239
        :param destination: The branch to copy the history into
 
2240
        :param revision_id: The revision-id to truncate history at.  May
 
2241
          be None to copy complete history.
 
2242
        """
 
2243
        if not isinstance(destination._format, BzrBranchFormat5):
 
2244
            super(BzrBranch, self)._synchronize_history(
 
2245
                destination, revision_id)
 
2246
            return
 
2247
        if revision_id == _mod_revision.NULL_REVISION:
 
2248
            new_history = []
 
2249
        else:
 
2250
            new_history = self.revision_history()
 
2251
        if revision_id is not None and new_history != []:
 
2252
            try:
 
2253
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2254
            except ValueError:
 
2255
                rev = self.repository.get_revision(revision_id)
 
2256
                new_history = rev.get_history(self.repository)[1:]
 
2257
        destination.set_revision_history(new_history)
 
2258
 
 
2259
    @needs_write_lock
 
2260
    def set_last_revision_info(self, revno, revision_id):
 
2261
        """Set the last revision of this branch.
 
2262
 
 
2263
        The caller is responsible for checking that the revno is correct
 
2264
        for this revision id.
 
2265
 
 
2266
        It may be possible to set the branch last revision to an id not
 
2267
        present in the repository.  However, branches can also be
 
2268
        configured to check constraints on history, in which case this may not
 
2269
        be permitted.
 
2270
        """
 
2271
        revision_id = _mod_revision.ensure_null(revision_id)
 
2272
        # this old format stores the full history, but this api doesn't
 
2273
        # provide it, so we must generate, and might as well check it's
 
2274
        # correct
 
2275
        history = self._lefthand_history(revision_id)
 
2276
        if len(history) != revno:
 
2277
            raise AssertionError('%d != %d' % (len(history), revno))
 
2278
        self.set_revision_history(history)
 
2279
 
 
2280
    def _gen_revision_history(self):
 
2281
        history = self._transport.get_bytes('revision-history').split('\n')
 
2282
        if history[-1:] == ['']:
 
2283
            # There shouldn't be a trailing newline, but just in case.
 
2284
            history.pop()
 
2285
        return history
 
2286
 
 
2287
    @needs_write_lock
 
2288
    def generate_revision_history(self, revision_id, last_rev=None,
 
2289
        other_branch=None):
 
2290
        """Create a new revision history that will finish with revision_id.
 
2291
 
 
2292
        :param revision_id: the new tip to use.
 
2293
        :param last_rev: The previous last_revision. If not None, then this
 
2294
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2295
        :param other_branch: The other branch that DivergedBranches should
 
2296
            raise with respect to.
 
2297
        """
 
2298
        self.set_revision_history(self._lefthand_history(revision_id,
 
2299
            last_rev, other_branch))
 
2300
 
 
2301
    def basis_tree(self):
 
2302
        """See Branch.basis_tree."""
 
2303
        return self.repository.revision_tree(self.last_revision())
 
2304
 
 
2305
    def _get_parent_location(self):
 
2306
        _locs = ['parent', 'pull', 'x-pull']
 
2307
        for l in _locs:
 
2308
            try:
 
2309
                return self._transport.get_bytes(l).strip('\n')
 
2310
            except errors.NoSuchFile:
 
2311
                pass
 
2312
        return None
 
2313
 
 
2314
    def _basic_push(self, target, overwrite, stop_revision):
 
2315
        """Basic implementation of push without bound branches or hooks.
 
2316
 
 
2317
        Must be called with source read locked and target write locked.
 
2318
        """
 
2319
        result = BranchPushResult()
 
2320
        result.source_branch = self
 
2321
        result.target_branch = target
 
2322
        result.old_revno, result.old_revid = target.last_revision_info()
 
2323
        self.update_references(target)
 
2324
        if result.old_revid != self.last_revision():
 
2325
            # We assume that during 'push' this repository is closer than
 
2326
            # the target.
 
2327
            graph = self.repository.get_graph(target.repository)
 
2328
            target.update_revisions(self, stop_revision,
 
2329
                overwrite=overwrite, graph=graph)
 
2330
        if self._push_should_merge_tags():
 
2331
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2332
                overwrite)
 
2333
        result.new_revno, result.new_revid = target.last_revision_info()
 
2334
        return result
 
2335
 
 
2336
    def get_stacked_on_url(self):
 
2337
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2338
 
 
2339
    def set_push_location(self, location):
 
2340
        """See Branch.set_push_location."""
 
2341
        self.get_config().set_user_option(
 
2342
            'push_location', location,
 
2343
            store=_mod_config.STORE_LOCATION_NORECURSE)
 
2344
 
 
2345
    def _set_parent_location(self, url):
 
2346
        if url is None:
 
2347
            self._transport.delete('parent')
 
2348
        else:
 
2349
            self._transport.put_bytes('parent', url + '\n',
 
2350
                mode=self.bzrdir._get_file_mode())
 
2351
 
 
2352
 
 
2353
class BzrBranch5(BzrBranch):
 
2354
    """A format 5 branch. This supports new features over plain branches.
 
2355
 
 
2356
    It has support for a master_branch which is the data for bound branches.
 
2357
    """
 
2358
 
 
2359
    def get_bound_location(self):
 
2360
        try:
 
2361
            return self._transport.get_bytes('bound')[:-1]
 
2362
        except errors.NoSuchFile:
 
2363
            return None
 
2364
 
 
2365
    @needs_read_lock
 
2366
    def get_master_branch(self, possible_transports=None):
 
2367
        """Return the branch we are bound to.
 
2368
 
 
2369
        :return: Either a Branch, or None
 
2370
 
 
2371
        This could memoise the branch, but if thats done
 
2372
        it must be revalidated on each new lock.
 
2373
        So for now we just don't memoise it.
 
2374
        # RBC 20060304 review this decision.
 
2375
        """
 
2376
        bound_loc = self.get_bound_location()
 
2377
        if not bound_loc:
 
2378
            return None
 
2379
        try:
 
2380
            return Branch.open(bound_loc,
 
2381
                               possible_transports=possible_transports)
 
2382
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2383
            raise errors.BoundBranchConnectionFailure(
 
2384
                    self, bound_loc, e)
 
2385
 
 
2386
    @needs_write_lock
 
2387
    def set_bound_location(self, location):
 
2388
        """Set the target where this branch is bound to.
 
2389
 
 
2390
        :param location: URL to the target branch
 
2391
        """
 
2392
        if location:
 
2393
            self._transport.put_bytes('bound', location+'\n',
 
2394
                mode=self.bzrdir._get_file_mode())
 
2395
        else:
 
2396
            try:
 
2397
                self._transport.delete('bound')
 
2398
            except errors.NoSuchFile:
 
2399
                return False
 
2400
            return True
 
2401
 
 
2402
    @needs_write_lock
 
2403
    def bind(self, other):
 
2404
        """Bind this branch to the branch other.
 
2405
 
 
2406
        This does not push or pull data between the branches, though it does
 
2407
        check for divergence to raise an error when the branches are not
 
2408
        either the same, or one a prefix of the other. That behaviour may not
 
2409
        be useful, so that check may be removed in future.
 
2410
 
 
2411
        :param other: The branch to bind to
 
2412
        :type other: Branch
 
2413
        """
 
2414
        # TODO: jam 20051230 Consider checking if the target is bound
 
2415
        #       It is debatable whether you should be able to bind to
 
2416
        #       a branch which is itself bound.
 
2417
        #       Committing is obviously forbidden,
 
2418
        #       but binding itself may not be.
 
2419
        #       Since we *have* to check at commit time, we don't
 
2420
        #       *need* to check here
 
2421
 
 
2422
        # we want to raise diverged if:
 
2423
        # last_rev is not in the other_last_rev history, AND
 
2424
        # other_last_rev is not in our history, and do it without pulling
 
2425
        # history around
 
2426
        self.set_bound_location(other.base)
 
2427
 
 
2428
    @needs_write_lock
 
2429
    def unbind(self):
 
2430
        """If bound, unbind"""
 
2431
        return self.set_bound_location(None)
 
2432
 
 
2433
    @needs_write_lock
 
2434
    def update(self, possible_transports=None):
 
2435
        """Synchronise this branch with the master branch if any.
 
2436
 
 
2437
        :return: None or the last_revision that was pivoted out during the
 
2438
                 update.
 
2439
        """
 
2440
        master = self.get_master_branch(possible_transports)
 
2441
        if master is not None:
 
2442
            old_tip = _mod_revision.ensure_null(self.last_revision())
 
2443
            self.pull(master, overwrite=True)
 
2444
            if self.repository.get_graph().is_ancestor(old_tip,
 
2445
                _mod_revision.ensure_null(self.last_revision())):
 
2446
                return None
 
2447
            return old_tip
 
2448
        return None
 
2449
 
 
2450
 
 
2451
class BzrBranch8(BzrBranch5):
 
2452
    """A branch that stores tree-reference locations."""
 
2453
 
 
2454
    def _open_hook(self):
 
2455
        if self._ignore_fallbacks:
 
2456
            return
 
2457
        try:
 
2458
            url = self.get_stacked_on_url()
 
2459
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
 
2460
            errors.UnstackableBranchFormat):
 
2461
            pass
 
2462
        else:
 
2463
            for hook in Branch.hooks['transform_fallback_location']:
 
2464
                url = hook(self, url)
 
2465
                if url is None:
 
2466
                    hook_name = Branch.hooks.get_hook_name(hook)
 
2467
                    raise AssertionError(
 
2468
                        "'transform_fallback_location' hook %s returned "
 
2469
                        "None, not a URL." % hook_name)
 
2470
            self._activate_fallback_location(url)
 
2471
 
 
2472
    def __init__(self, *args, **kwargs):
 
2473
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
 
2474
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2475
        self._last_revision_info_cache = None
 
2476
        self._reference_info = None
 
2477
 
 
2478
    def _clear_cached_state(self):
 
2479
        super(BzrBranch8, self)._clear_cached_state()
 
2480
        self._last_revision_info_cache = None
 
2481
        self._reference_info = None
 
2482
 
 
2483
    def _last_revision_info(self):
 
2484
        revision_string = self._transport.get_bytes('last-revision')
 
2485
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2486
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2487
        revno = int(revno)
 
2488
        return revno, revision_id
 
2489
 
 
2490
    def _write_last_revision_info(self, revno, revision_id):
 
2491
        """Simply write out the revision id, with no checks.
 
2492
 
 
2493
        Use set_last_revision_info to perform this safely.
 
2494
 
 
2495
        Does not update the revision_history cache.
 
2496
        Intended to be called by set_last_revision_info and
 
2497
        _write_revision_history.
 
2498
        """
 
2499
        revision_id = _mod_revision.ensure_null(revision_id)
 
2500
        out_string = '%d %s\n' % (revno, revision_id)
 
2501
        self._transport.put_bytes('last-revision', out_string,
 
2502
            mode=self.bzrdir._get_file_mode())
 
2503
 
 
2504
    @needs_write_lock
 
2505
    def set_last_revision_info(self, revno, revision_id):
 
2506
        revision_id = _mod_revision.ensure_null(revision_id)
 
2507
        old_revno, old_revid = self.last_revision_info()
 
2508
        if self._get_append_revisions_only():
 
2509
            self._check_history_violation(revision_id)
 
2510
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2511
        self._write_last_revision_info(revno, revision_id)
 
2512
        self._clear_cached_state()
 
2513
        self._last_revision_info_cache = revno, revision_id
 
2514
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2515
 
 
2516
    def _synchronize_history(self, destination, revision_id):
 
2517
        """Synchronize last revision and revision history between branches.
 
2518
 
 
2519
        :see: Branch._synchronize_history
 
2520
        """
 
2521
        # XXX: The base Branch has a fast implementation of this method based
 
2522
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
 
2523
        # that uses set_revision_history.  This class inherits from BzrBranch5,
 
2524
        # but wants the fast implementation, so it calls
 
2525
        # Branch._synchronize_history directly.
 
2526
        Branch._synchronize_history(self, destination, revision_id)
 
2527
 
 
2528
    def _check_history_violation(self, revision_id):
 
2529
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2530
        if _mod_revision.is_null(last_revision):
 
2531
            return
 
2532
        if last_revision not in self._lefthand_history(revision_id):
 
2533
            raise errors.AppendRevisionsOnlyViolation(self.base)
 
2534
 
 
2535
    def _gen_revision_history(self):
 
2536
        """Generate the revision history from last revision
 
2537
        """
 
2538
        last_revno, last_revision = self.last_revision_info()
 
2539
        self._extend_partial_history(stop_index=last_revno-1)
 
2540
        return list(reversed(self._partial_revision_history_cache))
 
2541
 
 
2542
    def _write_revision_history(self, history):
 
2543
        """Factored out of set_revision_history.
 
2544
 
 
2545
        This performs the actual writing to disk, with format-specific checks.
 
2546
        It is intended to be called by BzrBranch5.set_revision_history.
 
2547
        """
 
2548
        if len(history) == 0:
 
2549
            last_revision = 'null:'
 
2550
        else:
 
2551
            if history != self._lefthand_history(history[-1]):
 
2552
                raise errors.NotLefthandHistory(history)
 
2553
            last_revision = history[-1]
 
2554
        if self._get_append_revisions_only():
 
2555
            self._check_history_violation(last_revision)
 
2556
        self._write_last_revision_info(len(history), last_revision)
 
2557
 
 
2558
    @needs_write_lock
 
2559
    def _set_parent_location(self, url):
 
2560
        """Set the parent branch"""
 
2561
        self._set_config_location('parent_location', url, make_relative=True)
 
2562
 
 
2563
    @needs_read_lock
 
2564
    def _get_parent_location(self):
 
2565
        """Set the parent branch"""
 
2566
        return self._get_config_location('parent_location')
 
2567
 
 
2568
    @needs_write_lock
 
2569
    def _set_all_reference_info(self, info_dict):
 
2570
        """Replace all reference info stored in a branch.
 
2571
 
 
2572
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
 
2573
        """
 
2574
        s = StringIO()
 
2575
        writer = rio.RioWriter(s)
 
2576
        for key, (tree_path, branch_location) in info_dict.iteritems():
 
2577
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
 
2578
                                branch_location=branch_location)
 
2579
            writer.write_stanza(stanza)
 
2580
        self._transport.put_bytes('references', s.getvalue())
 
2581
        self._reference_info = info_dict
 
2582
 
 
2583
    @needs_read_lock
 
2584
    def _get_all_reference_info(self):
 
2585
        """Return all the reference info stored in a branch.
 
2586
 
 
2587
        :return: A dict of {file_id: (tree_path, branch_location)}
 
2588
        """
 
2589
        if self._reference_info is not None:
 
2590
            return self._reference_info
 
2591
        rio_file = self._transport.get('references')
 
2592
        try:
 
2593
            stanzas = rio.read_stanzas(rio_file)
 
2594
            info_dict = dict((s['file_id'], (s['tree_path'],
 
2595
                             s['branch_location'])) for s in stanzas)
 
2596
        finally:
 
2597
            rio_file.close()
 
2598
        self._reference_info = info_dict
 
2599
        return info_dict
 
2600
 
 
2601
    def set_reference_info(self, file_id, tree_path, branch_location):
 
2602
        """Set the branch location to use for a tree reference.
 
2603
 
 
2604
        :param file_id: The file-id of the tree reference.
 
2605
        :param tree_path: The path of the tree reference in the tree.
 
2606
        :param branch_location: The location of the branch to retrieve tree
 
2607
            references from.
 
2608
        """
 
2609
        info_dict = self._get_all_reference_info()
 
2610
        info_dict[file_id] = (tree_path, branch_location)
 
2611
        if None in (tree_path, branch_location):
 
2612
            if tree_path is not None:
 
2613
                raise ValueError('tree_path must be None when branch_location'
 
2614
                                 ' is None.')
 
2615
            if branch_location is not None:
 
2616
                raise ValueError('branch_location must be None when tree_path'
 
2617
                                 ' is None.')
 
2618
            del info_dict[file_id]
 
2619
        self._set_all_reference_info(info_dict)
 
2620
 
 
2621
    def get_reference_info(self, file_id):
 
2622
        """Get the tree_path and branch_location for a tree reference.
 
2623
 
 
2624
        :return: a tuple of (tree_path, branch_location)
 
2625
        """
 
2626
        return self._get_all_reference_info().get(file_id, (None, None))
 
2627
 
 
2628
    def reference_parent(self, file_id, path, possible_transports=None):
 
2629
        """Return the parent branch for a tree-reference file_id.
 
2630
 
 
2631
        :param file_id: The file_id of the tree reference
 
2632
        :param path: The path of the file_id in the tree
 
2633
        :return: A branch associated with the file_id
 
2634
        """
 
2635
        branch_location = self.get_reference_info(file_id)[1]
 
2636
        if branch_location is None:
 
2637
            return Branch.reference_parent(self, file_id, path,
 
2638
                                           possible_transports)
 
2639
        branch_location = urlutils.join(self.base, branch_location)
 
2640
        return Branch.open(branch_location,
 
2641
                           possible_transports=possible_transports)
 
2642
 
 
2643
    def set_push_location(self, location):
 
2644
        """See Branch.set_push_location."""
 
2645
        self._set_config_location('push_location', location)
 
2646
 
 
2647
    def set_bound_location(self, location):
 
2648
        """See Branch.set_push_location."""
 
2649
        result = None
 
2650
        config = self.get_config()
 
2651
        if location is None:
 
2652
            if config.get_user_option('bound') != 'True':
 
2653
                return False
 
2654
            else:
 
2655
                config.set_user_option('bound', 'False', warn_masked=True)
 
2656
                return True
 
2657
        else:
 
2658
            self._set_config_location('bound_location', location,
 
2659
                                      config=config)
 
2660
            config.set_user_option('bound', 'True', warn_masked=True)
 
2661
        return True
 
2662
 
 
2663
    def _get_bound_location(self, bound):
 
2664
        """Return the bound location in the config file.
 
2665
 
 
2666
        Return None if the bound parameter does not match"""
 
2667
        config = self.get_config()
 
2668
        config_bound = (config.get_user_option('bound') == 'True')
 
2669
        if config_bound != bound:
 
2670
            return None
 
2671
        return self._get_config_location('bound_location', config=config)
 
2672
 
 
2673
    def get_bound_location(self):
 
2674
        """See Branch.set_push_location."""
 
2675
        return self._get_bound_location(True)
 
2676
 
 
2677
    def get_old_bound_location(self):
 
2678
        """See Branch.get_old_bound_location"""
 
2679
        return self._get_bound_location(False)
 
2680
 
 
2681
    def get_stacked_on_url(self):
 
2682
        # you can always ask for the URL; but you might not be able to use it
 
2683
        # if the repo can't support stacking.
 
2684
        ## self._check_stackable_repo()
 
2685
        stacked_url = self._get_config_location('stacked_on_location')
 
2686
        if stacked_url is None:
 
2687
            raise errors.NotStacked(self)
 
2688
        return stacked_url
 
2689
 
 
2690
    def _get_append_revisions_only(self):
 
2691
        value = self.get_config().get_user_option('append_revisions_only')
 
2692
        return value == 'True'
 
2693
 
 
2694
    @needs_write_lock
 
2695
    def generate_revision_history(self, revision_id, last_rev=None,
 
2696
                                  other_branch=None):
 
2697
        """See BzrBranch5.generate_revision_history"""
 
2698
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
2699
        revno = len(history)
 
2700
        self.set_last_revision_info(revno, revision_id)
 
2701
 
 
2702
    @needs_read_lock
 
2703
    def get_rev_id(self, revno, history=None):
 
2704
        """Find the revision id of the specified revno."""
 
2705
        if revno == 0:
 
2706
            return _mod_revision.NULL_REVISION
 
2707
 
 
2708
        last_revno, last_revision_id = self.last_revision_info()
 
2709
        if revno <= 0 or revno > last_revno:
 
2710
            raise errors.NoSuchRevision(self, revno)
 
2711
 
 
2712
        if history is not None:
 
2713
            return history[revno - 1]
 
2714
 
 
2715
        index = last_revno - revno
 
2716
        if len(self._partial_revision_history_cache) <= index:
 
2717
            self._extend_partial_history(stop_index=index)
 
2718
        if len(self._partial_revision_history_cache) > index:
 
2719
            return self._partial_revision_history_cache[index]
 
2720
        else:
 
2721
            raise errors.NoSuchRevision(self, revno)
 
2722
 
 
2723
    @needs_read_lock
 
2724
    def revision_id_to_revno(self, revision_id):
 
2725
        """Given a revision id, return its revno"""
 
2726
        if _mod_revision.is_null(revision_id):
 
2727
            return 0
 
2728
        try:
 
2729
            index = self._partial_revision_history_cache.index(revision_id)
 
2730
        except ValueError:
 
2731
            self._extend_partial_history(stop_revision=revision_id)
 
2732
            index = len(self._partial_revision_history_cache) - 1
 
2733
            if self._partial_revision_history_cache[index] != revision_id:
 
2734
                raise errors.NoSuchRevision(self, revision_id)
 
2735
        return self.revno() - index
 
2736
 
 
2737
 
 
2738
class BzrBranch7(BzrBranch8):
 
2739
    """A branch with support for a fallback repository."""
 
2740
 
 
2741
    def set_reference_info(self, file_id, tree_path, branch_location):
 
2742
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
 
2743
 
 
2744
    def get_reference_info(self, file_id):
 
2745
        Branch.get_reference_info(self, file_id)
 
2746
 
 
2747
    def reference_parent(self, file_id, path, possible_transports=None):
 
2748
        return Branch.reference_parent(self, file_id, path,
 
2749
                                       possible_transports)
 
2750
 
 
2751
 
 
2752
class BzrBranch6(BzrBranch7):
 
2753
    """See BzrBranchFormat6 for the capabilities of this branch.
 
2754
 
 
2755
    This subclass of BzrBranch7 disables the new features BzrBranch7 added,
 
2756
    i.e. stacking.
 
2757
    """
 
2758
 
 
2759
    def get_stacked_on_url(self):
 
2760
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2761
 
972
2762
 
973
2763
######################################################################
974
 
# predicates
975
 
 
976
 
 
977
 
def is_control_file(filename):
978
 
    ## FIXME: better check
979
 
    filename = os.path.normpath(filename)
980
 
    while filename != '':
981
 
        head, tail = os.path.split(filename)
982
 
        ## mutter('check %r for control file' % ((head, tail), ))
983
 
        if tail == bzrlib.BZRDIR:
984
 
            return True
985
 
        if filename == head:
986
 
            break
987
 
        filename = head
988
 
    return False
989
 
 
990
 
 
991
 
 
992
 
def _gen_revision_id(when):
993
 
    """Return new revision-id."""
994
 
    s = '%s-%s-' % (user_email(), compact_date(when))
995
 
    s += hexlify(rand_bytes(8))
996
 
    return s
997
 
 
998
 
 
999
 
def gen_file_id(name):
1000
 
    """Return new file id.
1001
 
 
1002
 
    This should probably generate proper UUIDs, but for the moment we
1003
 
    cope with just randomness because running uuidgen every time is
1004
 
    slow."""
1005
 
    idx = name.rfind('/')
1006
 
    if idx != -1:
1007
 
        name = name[idx+1 : ]
1008
 
    idx = name.rfind('\\')
1009
 
    if idx != -1:
1010
 
        name = name[idx+1 : ]
1011
 
 
1012
 
    name = name.lstrip('.')
1013
 
 
1014
 
    s = hexlify(rand_bytes(8))
1015
 
    return '-'.join((name, compact_date(time.time()), s))
 
2764
# results of operations
 
2765
 
 
2766
 
 
2767
class _Result(object):
 
2768
 
 
2769
    def _show_tag_conficts(self, to_file):
 
2770
        if not getattr(self, 'tag_conflicts', None):
 
2771
            return
 
2772
        to_file.write('Conflicting tags:\n')
 
2773
        for name, value1, value2 in self.tag_conflicts:
 
2774
            to_file.write('    %s\n' % (name, ))
 
2775
 
 
2776
 
 
2777
class PullResult(_Result):
 
2778
    """Result of a Branch.pull operation.
 
2779
 
 
2780
    :ivar old_revno: Revision number before pull.
 
2781
    :ivar new_revno: Revision number after pull.
 
2782
    :ivar old_revid: Tip revision id before pull.
 
2783
    :ivar new_revid: Tip revision id after pull.
 
2784
    :ivar source_branch: Source (local) branch object. (read locked)
 
2785
    :ivar master_branch: Master branch of the target, or the target if no
 
2786
        Master
 
2787
    :ivar local_branch: target branch if there is a Master, else None
 
2788
    :ivar target_branch: Target/destination branch object. (write locked)
 
2789
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
2790
    """
 
2791
 
 
2792
    def __int__(self):
 
2793
        # DEPRECATED: pull used to return the change in revno
 
2794
        return self.new_revno - self.old_revno
 
2795
 
 
2796
    def report(self, to_file):
 
2797
        if not is_quiet():
 
2798
            if self.old_revid == self.new_revid:
 
2799
                to_file.write('No revisions to pull.\n')
 
2800
            else:
 
2801
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
2802
        self._show_tag_conficts(to_file)
 
2803
 
 
2804
 
 
2805
class BranchPushResult(_Result):
 
2806
    """Result of a Branch.push operation.
 
2807
 
 
2808
    :ivar old_revno: Revision number (eg 10) of the target before push.
 
2809
    :ivar new_revno: Revision number (eg 12) of the target after push.
 
2810
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
 
2811
        before the push.
 
2812
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
 
2813
        after the push.
 
2814
    :ivar source_branch: Source branch object that the push was from. This is
 
2815
        read locked, and generally is a local (and thus low latency) branch.
 
2816
    :ivar master_branch: If target is a bound branch, the master branch of
 
2817
        target, or target itself. Always write locked.
 
2818
    :ivar target_branch: The direct Branch where data is being sent (write
 
2819
        locked).
 
2820
    :ivar local_branch: If the target is a bound branch this will be the
 
2821
        target, otherwise it will be None.
 
2822
    """
 
2823
 
 
2824
    def __int__(self):
 
2825
        # DEPRECATED: push used to return the change in revno
 
2826
        return self.new_revno - self.old_revno
 
2827
 
 
2828
    def report(self, to_file):
 
2829
        """Write a human-readable description of the result."""
 
2830
        if self.old_revid == self.new_revid:
 
2831
            note('No new revisions to push.')
 
2832
        else:
 
2833
            note('Pushed up to revision %d.' % self.new_revno)
 
2834
        self._show_tag_conficts(to_file)
 
2835
 
 
2836
 
 
2837
class BranchCheckResult(object):
 
2838
    """Results of checking branch consistency.
 
2839
 
 
2840
    :see: Branch.check
 
2841
    """
 
2842
 
 
2843
    def __init__(self, branch):
 
2844
        self.branch = branch
 
2845
        self.errors = []
 
2846
 
 
2847
    def report_results(self, verbose):
 
2848
        """Report the check results via trace.note.
 
2849
 
 
2850
        :param verbose: Requests more detailed display of what was checked,
 
2851
            if any.
 
2852
        """
 
2853
        note('checked branch %s format %s', self.branch.base,
 
2854
            self.branch._format)
 
2855
        for error in self.errors:
 
2856
            note('found error:%s', error)
 
2857
 
 
2858
 
 
2859
class Converter5to6(object):
 
2860
    """Perform an in-place upgrade of format 5 to format 6"""
 
2861
 
 
2862
    def convert(self, branch):
 
2863
        # Data for 5 and 6 can peacefully coexist.
 
2864
        format = BzrBranchFormat6()
 
2865
        new_branch = format.open(branch.bzrdir, _found=True)
 
2866
 
 
2867
        # Copy source data into target
 
2868
        new_branch._write_last_revision_info(*branch.last_revision_info())
 
2869
        new_branch.set_parent(branch.get_parent())
 
2870
        new_branch.set_bound_location(branch.get_bound_location())
 
2871
        new_branch.set_push_location(branch.get_push_location())
 
2872
 
 
2873
        # New branch has no tags by default
 
2874
        new_branch.tags._set_tag_dict({})
 
2875
 
 
2876
        # Copying done; now update target format
 
2877
        new_branch._transport.put_bytes('format',
 
2878
            format.get_format_string(),
 
2879
            mode=new_branch.bzrdir._get_file_mode())
 
2880
 
 
2881
        # Clean up old files
 
2882
        new_branch._transport.delete('revision-history')
 
2883
        try:
 
2884
            branch.set_parent(None)
 
2885
        except errors.NoSuchFile:
 
2886
            pass
 
2887
        branch.set_bound_location(None)
 
2888
 
 
2889
 
 
2890
class Converter6to7(object):
 
2891
    """Perform an in-place upgrade of format 6 to format 7"""
 
2892
 
 
2893
    def convert(self, branch):
 
2894
        format = BzrBranchFormat7()
 
2895
        branch._set_config_location('stacked_on_location', '')
 
2896
        # update target format
 
2897
        branch._transport.put_bytes('format', format.get_format_string())
 
2898
 
 
2899
 
 
2900
class Converter7to8(object):
 
2901
    """Perform an in-place upgrade of format 6 to format 7"""
 
2902
 
 
2903
    def convert(self, branch):
 
2904
        format = BzrBranchFormat8()
 
2905
        branch._transport.put_bytes('references', '')
 
2906
        # update target format
 
2907
        branch._transport.put_bytes('format', format.get_format_string())
 
2908
 
 
2909
 
 
2910
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
2911
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
2912
    duration.
 
2913
 
 
2914
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
2915
 
 
2916
    If an exception is raised by callable, then that exception *will* be
 
2917
    propagated, even if the unlock attempt raises its own error.  Thus
 
2918
    _run_with_write_locked_target should be preferred to simply doing::
 
2919
 
 
2920
        target.lock_write()
 
2921
        try:
 
2922
            return callable(*args, **kwargs)
 
2923
        finally:
 
2924
            target.unlock()
 
2925
 
 
2926
    """
 
2927
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
2928
    # should share code?
 
2929
    target.lock_write()
 
2930
    try:
 
2931
        result = callable(*args, **kwargs)
 
2932
    except:
 
2933
        exc_info = sys.exc_info()
 
2934
        try:
 
2935
            target.unlock()
 
2936
        finally:
 
2937
            raise exc_info[0], exc_info[1], exc_info[2]
 
2938
    else:
 
2939
        target.unlock()
 
2940
        return result
 
2941
 
 
2942
 
 
2943
class InterBranch(InterObject):
 
2944
    """This class represents operations taking place between two branches.
 
2945
 
 
2946
    Its instances have methods like pull() and push() and contain
 
2947
    references to the source and target repositories these operations
 
2948
    can be carried out on.
 
2949
    """
 
2950
 
 
2951
    _optimisers = []
 
2952
    """The available optimised InterBranch types."""
 
2953
 
 
2954
    @staticmethod
 
2955
    def _get_branch_formats_to_test():
 
2956
        """Return a tuple with the Branch formats to use when testing."""
 
2957
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2958
 
 
2959
    def pull(self, overwrite=False, stop_revision=None,
 
2960
             possible_transports=None, local=False):
 
2961
        """Mirror source into target branch.
 
2962
 
 
2963
        The target branch is considered to be 'local', having low latency.
 
2964
 
 
2965
        :returns: PullResult instance
 
2966
        """
 
2967
        raise NotImplementedError(self.pull)
 
2968
 
 
2969
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2970
                         graph=None):
 
2971
        """Pull in new perfect-fit revisions.
 
2972
 
 
2973
        :param stop_revision: Updated until the given revision
 
2974
        :param overwrite: Always set the branch pointer, rather than checking
 
2975
            to see if it is a proper descendant.
 
2976
        :param graph: A Graph object that can be used to query history
 
2977
            information. This can be None.
 
2978
        :return: None
 
2979
        """
 
2980
        raise NotImplementedError(self.update_revisions)
 
2981
 
 
2982
    def push(self, overwrite=False, stop_revision=None,
 
2983
             _override_hook_source_branch=None):
 
2984
        """Mirror the source branch into the target branch.
 
2985
 
 
2986
        The source branch is considered to be 'local', having low latency.
 
2987
        """
 
2988
        raise NotImplementedError(self.push)
 
2989
 
 
2990
 
 
2991
class GenericInterBranch(InterBranch):
 
2992
    """InterBranch implementation that uses public Branch functions.
 
2993
    """
 
2994
 
 
2995
    @staticmethod
 
2996
    def _get_branch_formats_to_test():
 
2997
        return BranchFormat._default_format, BranchFormat._default_format
 
2998
 
 
2999
    def update_revisions(self, stop_revision=None, overwrite=False,
 
3000
        graph=None):
 
3001
        """See InterBranch.update_revisions()."""
 
3002
        self.source.lock_read()
 
3003
        try:
 
3004
            other_revno, other_last_revision = self.source.last_revision_info()
 
3005
            stop_revno = None # unknown
 
3006
            if stop_revision is None:
 
3007
                stop_revision = other_last_revision
 
3008
                if _mod_revision.is_null(stop_revision):
 
3009
                    # if there are no commits, we're done.
 
3010
                    return
 
3011
                stop_revno = other_revno
 
3012
 
 
3013
            # what's the current last revision, before we fetch [and change it
 
3014
            # possibly]
 
3015
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3016
            # we fetch here so that we don't process data twice in the common
 
3017
            # case of having something to pull, and so that the check for
 
3018
            # already merged can operate on the just fetched graph, which will
 
3019
            # be cached in memory.
 
3020
            self.target.fetch(self.source, stop_revision)
 
3021
            # Check to see if one is an ancestor of the other
 
3022
            if not overwrite:
 
3023
                if graph is None:
 
3024
                    graph = self.target.repository.get_graph()
 
3025
                if self.target._check_if_descendant_or_diverged(
 
3026
                        stop_revision, last_rev, graph, self.source):
 
3027
                    # stop_revision is a descendant of last_rev, but we aren't
 
3028
                    # overwriting, so we're done.
 
3029
                    return
 
3030
            if stop_revno is None:
 
3031
                if graph is None:
 
3032
                    graph = self.target.repository.get_graph()
 
3033
                this_revno, this_last_revision = \
 
3034
                        self.target.last_revision_info()
 
3035
                stop_revno = graph.find_distance_to_null(stop_revision,
 
3036
                                [(other_last_revision, other_revno),
 
3037
                                 (this_last_revision, this_revno)])
 
3038
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
3039
        finally:
 
3040
            self.source.unlock()
 
3041
 
 
3042
    def pull(self, overwrite=False, stop_revision=None,
 
3043
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3044
             _override_hook_target=None, local=False):
 
3045
        """See Branch.pull.
 
3046
 
 
3047
        :param _hook_master: Private parameter - set the branch to
 
3048
            be supplied as the master to pull hooks.
 
3049
        :param run_hooks: Private parameter - if false, this branch
 
3050
            is being called because it's the master of the primary branch,
 
3051
            so it should not run its hooks.
 
3052
        :param _override_hook_target: Private parameter - set the branch to be
 
3053
            supplied as the target_branch to pull hooks.
 
3054
        :param local: Only update the local branch, and not the bound branch.
 
3055
        """
 
3056
        # This type of branch can't be bound.
 
3057
        if local:
 
3058
            raise errors.LocalRequiresBoundBranch()
 
3059
        result = PullResult()
 
3060
        result.source_branch = self.source
 
3061
        if _override_hook_target is None:
 
3062
            result.target_branch = self.target
 
3063
        else:
 
3064
            result.target_branch = _override_hook_target
 
3065
        self.source.lock_read()
 
3066
        try:
 
3067
            # We assume that during 'pull' the target repository is closer than
 
3068
            # the source one.
 
3069
            self.source.update_references(self.target)
 
3070
            graph = self.target.repository.get_graph(self.source.repository)
 
3071
            # TODO: Branch formats should have a flag that indicates 
 
3072
            # that revno's are expensive, and pull() should honor that flag.
 
3073
            # -- JRV20090506
 
3074
            result.old_revno, result.old_revid = \
 
3075
                self.target.last_revision_info()
 
3076
            self.target.update_revisions(self.source, stop_revision,
 
3077
                overwrite=overwrite, graph=graph)
 
3078
            # TODO: The old revid should be specified when merging tags, 
 
3079
            # so a tags implementation that versions tags can only 
 
3080
            # pull in the most recent changes. -- JRV20090506
 
3081
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3082
                overwrite)
 
3083
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3084
            if _hook_master:
 
3085
                result.master_branch = _hook_master
 
3086
                result.local_branch = result.target_branch
 
3087
            else:
 
3088
                result.master_branch = result.target_branch
 
3089
                result.local_branch = None
 
3090
            if run_hooks:
 
3091
                for hook in Branch.hooks['post_pull']:
 
3092
                    hook(result)
 
3093
        finally:
 
3094
            self.source.unlock()
 
3095
        return result
 
3096
 
 
3097
    def push(self, overwrite=False, stop_revision=None,
 
3098
             _override_hook_source_branch=None):
 
3099
        """See InterBranch.push.
 
3100
 
 
3101
        This is the basic concrete implementation of push()
 
3102
 
 
3103
        :param _override_hook_source_branch: If specified, run
 
3104
        the hooks passing this Branch as the source, rather than self.
 
3105
        This is for use of RemoteBranch, where push is delegated to the
 
3106
        underlying vfs-based Branch.
 
3107
        """
 
3108
        # TODO: Public option to disable running hooks - should be trivial but
 
3109
        # needs tests.
 
3110
        self.source.lock_read()
 
3111
        try:
 
3112
            return _run_with_write_locked_target(
 
3113
                self.target, self._push_with_bound_branches, overwrite,
 
3114
                stop_revision,
 
3115
                _override_hook_source_branch=_override_hook_source_branch)
 
3116
        finally:
 
3117
            self.source.unlock()
 
3118
 
 
3119
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3120
            _override_hook_source_branch=None):
 
3121
        """Push from source into target, and into target's master if any.
 
3122
        """
 
3123
        def _run_hooks():
 
3124
            if _override_hook_source_branch:
 
3125
                result.source_branch = _override_hook_source_branch
 
3126
            for hook in Branch.hooks['post_push']:
 
3127
                hook(result)
 
3128
 
 
3129
        bound_location = self.target.get_bound_location()
 
3130
        if bound_location and self.target.base != bound_location:
 
3131
            # there is a master branch.
 
3132
            #
 
3133
            # XXX: Why the second check?  Is it even supported for a branch to
 
3134
            # be bound to itself? -- mbp 20070507
 
3135
            master_branch = self.target.get_master_branch()
 
3136
            master_branch.lock_write()
 
3137
            try:
 
3138
                # push into the master from the source branch.
 
3139
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3140
                # and push into the target branch from the source. Note that we
 
3141
                # push from the source branch again, because its considered the
 
3142
                # highest bandwidth repository.
 
3143
                result = self.source._basic_push(self.target, overwrite,
 
3144
                    stop_revision)
 
3145
                result.master_branch = master_branch
 
3146
                result.local_branch = self.target
 
3147
                _run_hooks()
 
3148
                return result
 
3149
            finally:
 
3150
                master_branch.unlock()
 
3151
        else:
 
3152
            # no master branch
 
3153
            result = self.source._basic_push(self.target, overwrite,
 
3154
                stop_revision)
 
3155
            # TODO: Why set master_branch and local_branch if there's no
 
3156
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3157
            # 20070504
 
3158
            result.master_branch = self.target
 
3159
            result.local_branch = None
 
3160
            _run_hooks()
 
3161
            return result
 
3162
 
 
3163
    @classmethod
 
3164
    def is_compatible(self, source, target):
 
3165
        # GenericBranch uses the public API, so always compatible
 
3166
        return True
 
3167
 
 
3168
 
 
3169
class InterToBranch5(GenericInterBranch):
 
3170
 
 
3171
    @staticmethod
 
3172
    def _get_branch_formats_to_test():
 
3173
        return BranchFormat._default_format, BzrBranchFormat5()
 
3174
 
 
3175
    def pull(self, overwrite=False, stop_revision=None,
 
3176
             possible_transports=None, run_hooks=True,
 
3177
             _override_hook_target=None, local=False):
 
3178
        """Pull from source into self, updating my master if any.
 
3179
 
 
3180
        :param run_hooks: Private parameter - if false, this branch
 
3181
            is being called because it's the master of the primary branch,
 
3182
            so it should not run its hooks.
 
3183
        """
 
3184
        bound_location = self.target.get_bound_location()
 
3185
        if local and not bound_location:
 
3186
            raise errors.LocalRequiresBoundBranch()
 
3187
        master_branch = None
 
3188
        if not local and bound_location and self.source.base != bound_location:
 
3189
            # not pulling from master, so we need to update master.
 
3190
            master_branch = self.target.get_master_branch(possible_transports)
 
3191
            master_branch.lock_write()
 
3192
        try:
 
3193
            if master_branch:
 
3194
                # pull from source into master.
 
3195
                master_branch.pull(self.source, overwrite, stop_revision,
 
3196
                    run_hooks=False)
 
3197
            return super(InterToBranch5, self).pull(overwrite,
 
3198
                stop_revision, _hook_master=master_branch,
 
3199
                run_hooks=run_hooks,
 
3200
                _override_hook_target=_override_hook_target)
 
3201
        finally:
 
3202
            if master_branch:
 
3203
                master_branch.unlock()
 
3204
 
 
3205
 
 
3206
InterBranch.register_optimiser(GenericInterBranch)
 
3207
InterBranch.register_optimiser(InterToBranch5)