~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2006-02-26 07:54:02 UTC
  • mto: (1587.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 1588.
  • Revision ID: robertc@robertcollins.net-20060226075402-92fca9fdb7b0070d
Check for incorrect revision parentage in the weave during revision access.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
 
18
from copy import deepcopy
 
19
from cStringIO import StringIO
 
20
import errno
 
21
import os
 
22
import shutil
18
23
import sys
19
 
 
20
 
from bzrlib.lazy_import import lazy_import
21
 
lazy_import(globals(), """
22
 
from itertools import chain
23
 
from bzrlib import (
24
 
        bzrdir,
25
 
        cache_utf8,
26
 
        config as _mod_config,
27
 
        debug,
28
 
        errors,
29
 
        lockdir,
30
 
        lockable_files,
31
 
        repository,
32
 
        revision as _mod_revision,
33
 
        transport,
34
 
        tsort,
35
 
        ui,
36
 
        urlutils,
37
 
        )
38
 
from bzrlib.config import BranchConfig
39
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
40
 
from bzrlib.tag import (
41
 
    BasicTags,
42
 
    DisabledTags,
43
 
    )
44
 
""")
45
 
 
 
24
from unittest import TestSuite
 
25
from warnings import warn
 
26
try:
 
27
    import xml.sax.saxutils
 
28
except ImportError:
 
29
    raise ImportError("We were unable to import 'xml.sax.saxutils',"
 
30
                      " most likely you have an xml.pyc or xml.pyo file"
 
31
                      " lying around in your bzrlib directory."
 
32
                      " Please remove it.")
 
33
 
 
34
 
 
35
import bzrlib
 
36
import bzrlib.bzrdir as bzrdir
 
37
from bzrlib.config import TreeConfig
46
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
 
from bzrlib.hooks import Hooks
48
 
from bzrlib.symbol_versioning import (
49
 
    deprecated_in,
50
 
    deprecated_method,
51
 
    )
52
 
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
 
39
from bzrlib.delta import compare_trees
 
40
import bzrlib.errors as errors
 
41
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
 
42
                           NoSuchRevision, HistoryMissing, NotBranchError,
 
43
                           DivergedBranches, LockError,
 
44
                           UninitializableFormat,
 
45
                           UnlistableStore,
 
46
                           UnlistableBranch, NoSuchFile, NotVersionedError,
 
47
                           NoWorkingTree)
 
48
import bzrlib.inventory as inventory
 
49
from bzrlib.inventory import Inventory
 
50
from bzrlib.lockable_files import LockableFiles
 
51
from bzrlib.osutils import (isdir, quotefn,
 
52
                            rename, splitpath, sha_file,
 
53
                            file_kind, abspath, normpath, pathjoin,
 
54
                            safe_unicode,
 
55
                            )
 
56
from bzrlib.textui import show_status
 
57
from bzrlib.trace import mutter, note
 
58
from bzrlib.tree import EmptyTree, RevisionTree
 
59
from bzrlib.repository import Repository
 
60
from bzrlib.revision import (
 
61
                             get_intervening_revisions,
 
62
                             is_ancestor,
 
63
                             NULL_REVISION,
 
64
                             Revision,
 
65
                             )
 
66
from bzrlib.store import copy_all
 
67
from bzrlib.symbol_versioning import *
 
68
import bzrlib.transactions as transactions
 
69
from bzrlib.transport import Transport, get_transport
 
70
from bzrlib.tree import EmptyTree, RevisionTree
 
71
import bzrlib.ui
 
72
import bzrlib.xml5
53
73
 
54
74
 
55
75
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
56
76
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
57
 
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
 
77
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
58
78
 
59
79
 
60
80
# TODO: Maybe include checks for common corruption of newlines, etc?
74
94
 
75
95
    base
76
96
        Base directory/url of the branch.
77
 
 
78
 
    hooks: An instance of BranchHooks.
79
97
    """
80
98
    # this is really an instance variable - FIXME move it there
81
99
    # - RBC 20060112
82
100
    base = None
83
101
 
84
 
    # override this to set the strategy for storing tags
85
 
    def _make_tags(self):
86
 
        return DisabledTags(self)
87
 
 
88
102
    def __init__(self, *ignored, **ignored_too):
89
 
        self.tags = self._make_tags()
90
 
        self._revision_history_cache = None
91
 
        self._revision_id_to_revno_cache = None
92
 
        self._last_revision_info_cache = None
93
 
        self._open_hook()
94
 
        hooks = Branch.hooks['open']
95
 
        for hook in hooks:
96
 
            hook(self)
97
 
 
98
 
    def _open_hook(self):
99
 
        """Called by init to allow simpler extension of the base class."""
100
 
 
101
 
    def break_lock(self):
102
 
        """Break a lock if one is present from another instance.
103
 
 
104
 
        Uses the ui factory to ask for confirmation if the lock may be from
105
 
        an active process.
106
 
 
107
 
        This will probe the repository for its lock as well.
108
 
        """
109
 
        self.control_files.break_lock()
110
 
        self.repository.break_lock()
111
 
        master = self.get_master_branch()
112
 
        if master is not None:
113
 
            master.break_lock()
114
 
 
115
 
    @staticmethod
116
 
    def open(base, _unsupported=False, possible_transports=None):
117
 
        """Open the branch rooted at base.
118
 
 
119
 
        For instance, if the branch is at URL/.bzr/branch,
120
 
        Branch.open(URL) -> a Branch instance.
121
 
        """
122
 
        control = bzrdir.BzrDir.open(base, _unsupported,
123
 
                                     possible_transports=possible_transports)
124
 
        return control.open_branch(_unsupported)
125
 
 
126
 
    @staticmethod
127
 
    def open_from_transport(transport, _unsupported=False):
128
 
        """Open the branch rooted at transport"""
129
 
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
130
 
        return control.open_branch(_unsupported)
131
 
 
132
 
    @staticmethod
133
 
    def open_containing(url, possible_transports=None):
 
103
        raise NotImplementedError('The Branch class is abstract')
 
104
 
 
105
    @staticmethod
 
106
    @deprecated_method(zero_eight)
 
107
    def open_downlevel(base):
 
108
        """Open a branch which may be of an old format."""
 
109
        return Branch.open(base, _unsupported=True)
 
110
        
 
111
    @staticmethod
 
112
    def open(base, _unsupported=False):
 
113
        """Open the repository rooted at base.
 
114
 
 
115
        For instance, if the repository is at URL/.bzr/repository,
 
116
        Repository.open(URL) -> a Repository instance.
 
117
        """
 
118
        control = bzrdir.BzrDir.open(base, _unsupported)
 
119
        return control.open_branch(_unsupported)
 
120
 
 
121
    @staticmethod
 
122
    def open_containing(url):
134
123
        """Open an existing branch which contains url.
135
124
        
136
125
        This probes for a branch at url, and searches upwards from there.
141
130
        format, UnknownFormatError or UnsupportedFormatError are raised.
142
131
        If there is one, it is returned, along with the unused portion of url.
143
132
        """
144
 
        control, relpath = bzrdir.BzrDir.open_containing(url,
145
 
                                                         possible_transports)
 
133
        control, relpath = bzrdir.BzrDir.open_containing(url)
146
134
        return control.open_branch(), relpath
147
135
 
148
 
    def get_config(self):
149
 
        return BranchConfig(self)
150
 
 
151
 
    def _get_nick(self, local=False, possible_transports=None):
152
 
        config = self.get_config()
153
 
        # explicit overrides master, but don't look for master if local is True
154
 
        if not local and not config.has_explicit_nickname():
155
 
            try:
156
 
                master = self.get_master_branch(possible_transports)
157
 
                if master is not None:
158
 
                    # return the master branch value
159
 
                    return master.nick
160
 
            except errors.BzrError, e:
161
 
                # Silently fall back to local implicit nick if the master is
162
 
                # unavailable
163
 
                mutter("Could not connect to bound branch, "
164
 
                    "falling back to local nick.\n " + str(e))
165
 
        return config.get_nickname()
 
136
    @staticmethod
 
137
    @deprecated_function(zero_eight)
 
138
    def initialize(base):
 
139
        """Create a new working tree and branch, rooted at 'base' (url)
 
140
 
 
141
        NOTE: This will soon be deprecated in favour of creation
 
142
        through a BzrDir.
 
143
        """
 
144
        return bzrdir.BzrDir.create_standalone_workingtree(base).branch
 
145
 
 
146
    def setup_caching(self, cache_root):
 
147
        """Subclasses that care about caching should override this, and set
 
148
        up cached stores located under cache_root.
 
149
        """
 
150
        # seems to be unused, 2006-01-13 mbp
 
151
        warn('%s is deprecated' % self.setup_caching)
 
152
        self.cache_root = cache_root
 
153
 
 
154
    def _get_nick(self):
 
155
        cfg = self.tree_config()
 
156
        return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
166
157
 
167
158
    def _set_nick(self, nick):
168
 
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
 
159
        cfg = self.tree_config()
 
160
        cfg.set_option(nick, "nickname")
 
161
        assert cfg.get_option("nickname") == nick
169
162
 
170
163
    nick = property(_get_nick, _set_nick)
171
 
 
172
 
    def is_locked(self):
173
 
        raise NotImplementedError(self.is_locked)
174
 
 
 
164
        
175
165
    def lock_write(self):
176
 
        raise NotImplementedError(self.lock_write)
177
 
 
 
166
        raise NotImplementedError('lock_write is abstract')
 
167
        
178
168
    def lock_read(self):
179
 
        raise NotImplementedError(self.lock_read)
 
169
        raise NotImplementedError('lock_read is abstract')
180
170
 
181
171
    def unlock(self):
182
 
        raise NotImplementedError(self.unlock)
 
172
        raise NotImplementedError('unlock is abstract')
183
173
 
184
174
    def peek_lock_mode(self):
185
175
        """Return lock mode for the Branch: 'r', 'w' or None"""
186
176
        raise NotImplementedError(self.peek_lock_mode)
187
177
 
188
 
    def get_physical_lock_status(self):
189
 
        raise NotImplementedError(self.get_physical_lock_status)
190
 
 
191
 
    @needs_read_lock
192
 
    def get_revision_id_to_revno_map(self):
193
 
        """Return the revision_id => dotted revno map.
194
 
 
195
 
        This will be regenerated on demand, but will be cached.
196
 
 
197
 
        :return: A dictionary mapping revision_id => dotted revno.
198
 
            This dictionary should not be modified by the caller.
199
 
        """
200
 
        if self._revision_id_to_revno_cache is not None:
201
 
            mapping = self._revision_id_to_revno_cache
202
 
        else:
203
 
            mapping = self._gen_revno_map()
204
 
            self._cache_revision_id_to_revno(mapping)
205
 
        # TODO: jam 20070417 Since this is being cached, should we be returning
206
 
        #       a copy?
207
 
        # I would rather not, and instead just declare that users should not
208
 
        # modify the return value.
209
 
        return mapping
210
 
 
211
 
    def _gen_revno_map(self):
212
 
        """Create a new mapping from revision ids to dotted revnos.
213
 
 
214
 
        Dotted revnos are generated based on the current tip in the revision
215
 
        history.
216
 
        This is the worker function for get_revision_id_to_revno_map, which
217
 
        just caches the return value.
218
 
 
219
 
        :return: A dictionary mapping revision_id => dotted revno.
220
 
        """
221
 
        last_revision = self.last_revision()
222
 
        revision_graph = repository._old_get_graph(self.repository,
223
 
            last_revision)
224
 
        merge_sorted_revisions = tsort.merge_sort(
225
 
            revision_graph,
226
 
            last_revision,
227
 
            None,
228
 
            generate_revno=True)
229
 
        revision_id_to_revno = dict((rev_id, revno)
230
 
                                    for seq_num, rev_id, depth, revno, end_of_merge
231
 
                                     in merge_sorted_revisions)
232
 
        return revision_id_to_revno
233
 
 
234
 
    def leave_lock_in_place(self):
235
 
        """Tell this branch object not to release the physical lock when this
236
 
        object is unlocked.
 
178
    def abspath(self, name):
 
179
        """Return absolute filename for something in the branch
237
180
        
238
 
        If lock_write doesn't return a token, then this method is not supported.
239
 
        """
240
 
        self.control_files.leave_in_place()
241
 
 
242
 
    def dont_leave_lock_in_place(self):
243
 
        """Tell this branch object to release the physical lock when this
244
 
        object is unlocked, even if it didn't originally acquire it.
245
 
 
246
 
        If lock_write doesn't return a token, then this method is not supported.
247
 
        """
248
 
        self.control_files.dont_leave_in_place()
249
 
 
250
 
    def bind(self, other):
251
 
        """Bind the local branch the other branch.
252
 
 
253
 
        :param other: The branch to bind to
254
 
        :type other: Branch
255
 
        """
256
 
        raise errors.UpgradeRequired(self.base)
 
181
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
 
182
        method and not a tree method.
 
183
        """
 
184
        raise NotImplementedError('abspath is abstract')
257
185
 
258
186
    @needs_write_lock
259
187
    def fetch(self, from_branch, last_revision=None, pb=None):
268
196
        (copied, failures).
269
197
        """
270
198
        if self.base == from_branch.base:
271
 
            return (0, [])
 
199
            raise Exception("can't fetch from a branch to itself %s, %s" % 
 
200
                            (self.base, to_branch.base))
272
201
        if pb is None:
273
 
            nested_pb = ui.ui_factory.nested_progress_bar()
274
 
            pb = nested_pb
275
 
        else:
276
 
            nested_pb = None
 
202
            pb = bzrlib.ui.ui_factory.progress_bar()
277
203
 
278
204
        from_branch.lock_read()
279
205
        try:
280
206
            if last_revision is None:
281
207
                pb.update('get source history')
282
 
                last_revision = from_branch.last_revision()
283
 
                last_revision = _mod_revision.ensure_null(last_revision)
 
208
                from_history = from_branch.revision_history()
 
209
                if from_history:
 
210
                    last_revision = from_history[-1]
 
211
                else:
 
212
                    # no history in the source branch
 
213
                    last_revision = NULL_REVISION
284
214
            return self.repository.fetch(from_branch.repository,
285
215
                                         revision_id=last_revision,
286
 
                                         pb=nested_pb)
 
216
                                         pb=pb)
287
217
        finally:
288
 
            if nested_pb is not None:
289
 
                nested_pb.finished()
290
218
            from_branch.unlock()
291
219
 
292
 
    def get_bound_location(self):
293
 
        """Return the URL of the branch we are bound to.
294
 
 
295
 
        Older format branches cannot bind, please be sure to use a metadir
296
 
        branch.
297
 
        """
298
 
        return None
299
 
    
300
 
    def get_old_bound_location(self):
301
 
        """Return the URL of the branch we used to be bound to
302
 
        """
303
 
        raise errors.UpgradeRequired(self.base)
304
 
 
305
 
    def get_commit_builder(self, parents, config=None, timestamp=None, 
306
 
                           timezone=None, committer=None, revprops=None, 
307
 
                           revision_id=None):
308
 
        """Obtain a CommitBuilder for this branch.
309
 
        
310
 
        :param parents: Revision ids of the parents of the new revision.
311
 
        :param config: Optional configuration to use.
312
 
        :param timestamp: Optional timestamp recorded for commit.
313
 
        :param timezone: Optional timezone for timestamp.
314
 
        :param committer: Optional committer to set for commit.
315
 
        :param revprops: Optional dictionary of revision properties.
316
 
        :param revision_id: Optional revision id.
317
 
        """
318
 
 
319
 
        if config is None:
320
 
            config = self.get_config()
321
 
        
322
 
        return self.repository.get_commit_builder(self, parents, config,
323
 
            timestamp, timezone, committer, revprops, revision_id)
324
 
 
325
 
    def get_master_branch(self, possible_transports=None):
326
 
        """Return the branch we are bound to.
327
 
        
328
 
        :return: Either a Branch, or None
329
 
        """
330
 
        return None
331
 
 
332
 
    def get_revision_delta(self, revno):
333
 
        """Return the delta for one revision.
334
 
 
335
 
        The delta is relative to its mainline predecessor, or the
336
 
        empty tree for revision 1.
337
 
        """
338
 
        rh = self.revision_history()
339
 
        if not (1 <= revno <= len(rh)):
340
 
            raise errors.InvalidRevisionNumber(revno)
341
 
        return self.repository.get_revision_delta(rh[revno-1])
342
 
 
343
 
    def get_stacked_on_url(self):
344
 
        """Get the URL this branch is stacked against.
345
 
 
346
 
        :raises NotStacked: If the branch is not stacked.
347
 
        :raises UnstackableBranchFormat: If the branch does not support
348
 
            stacking.
349
 
        """
350
 
        raise NotImplementedError(self.get_stacked_on_url)
 
220
    def get_root_id(self):
 
221
        """Return the id of this branches root"""
 
222
        raise NotImplementedError('get_root_id is abstract')
351
223
 
352
224
    def print_file(self, file, revision_id):
353
225
        """Print `file` to stdout."""
354
 
        raise NotImplementedError(self.print_file)
 
226
        raise NotImplementedError('print_file is abstract')
 
227
 
 
228
    def append_revision(self, *revision_ids):
 
229
        raise NotImplementedError('append_revision is abstract')
355
230
 
356
231
    def set_revision_history(self, rev_history):
357
 
        raise NotImplementedError(self.set_revision_history)
358
 
 
359
 
    def set_stacked_on_url(self, url):
360
 
        """Set the URL this branch is stacked against.
361
 
 
362
 
        :raises UnstackableBranchFormat: If the branch does not support
363
 
            stacking.
364
 
        :raises UnstackableRepositoryFormat: If the repository does not support
365
 
            stacking.
366
 
        """
367
 
        raise NotImplementedError(self.set_stacked_on_url)
368
 
 
369
 
    def _cache_revision_history(self, rev_history):
370
 
        """Set the cached revision history to rev_history.
371
 
 
372
 
        The revision_history method will use this cache to avoid regenerating
373
 
        the revision history.
374
 
 
375
 
        This API is semi-public; it only for use by subclasses, all other code
376
 
        should consider it to be private.
377
 
        """
378
 
        self._revision_history_cache = rev_history
379
 
 
380
 
    def _cache_revision_id_to_revno(self, revision_id_to_revno):
381
 
        """Set the cached revision_id => revno map to revision_id_to_revno.
382
 
 
383
 
        This API is semi-public; it only for use by subclasses, all other code
384
 
        should consider it to be private.
385
 
        """
386
 
        self._revision_id_to_revno_cache = revision_id_to_revno
387
 
 
388
 
    def _clear_cached_state(self):
389
 
        """Clear any cached data on this branch, e.g. cached revision history.
390
 
 
391
 
        This means the next call to revision_history will need to call
392
 
        _gen_revision_history.
393
 
 
394
 
        This API is semi-public; it only for use by subclasses, all other code
395
 
        should consider it to be private.
396
 
        """
397
 
        self._revision_history_cache = None
398
 
        self._revision_id_to_revno_cache = None
399
 
        self._last_revision_info_cache = None
400
 
 
401
 
    def _gen_revision_history(self):
402
 
        """Return sequence of revision hashes on to this branch.
403
 
        
404
 
        Unlike revision_history, this method always regenerates or rereads the
405
 
        revision history, i.e. it does not cache the result, so repeated calls
406
 
        may be expensive.
407
 
 
408
 
        Concrete subclasses should override this instead of revision_history so
409
 
        that subclasses do not need to deal with caching logic.
410
 
        
411
 
        This API is semi-public; it only for use by subclasses, all other code
412
 
        should consider it to be private.
413
 
        """
414
 
        raise NotImplementedError(self._gen_revision_history)
415
 
 
416
 
    @needs_read_lock
 
232
        raise NotImplementedError('set_revision_history is abstract')
 
233
 
417
234
    def revision_history(self):
418
 
        """Return sequence of revision ids on this branch.
419
 
        
420
 
        This method will cache the revision history for as long as it is safe to
421
 
        do so.
422
 
        """
423
 
        if 'evil' in debug.debug_flags:
424
 
            mutter_callsite(3, "revision_history scales with history.")
425
 
        if self._revision_history_cache is not None:
426
 
            history = self._revision_history_cache
427
 
        else:
428
 
            history = self._gen_revision_history()
429
 
            self._cache_revision_history(history)
430
 
        return list(history)
 
235
        """Return sequence of revision hashes on to this branch."""
 
236
        raise NotImplementedError('revision_history is abstract')
431
237
 
432
238
    def revno(self):
433
239
        """Return current revision number for this branch.
435
241
        That is equivalent to the number of revisions committed to
436
242
        this branch.
437
243
        """
438
 
        return self.last_revision_info()[0]
439
 
 
440
 
    def unbind(self):
441
 
        """Older format branches cannot bind or unbind."""
442
 
        raise errors.UpgradeRequired(self.base)
443
 
 
444
 
    def set_append_revisions_only(self, enabled):
445
 
        """Older format branches are never restricted to append-only"""
446
 
        raise errors.UpgradeRequired(self.base)
 
244
        return len(self.revision_history())
447
245
 
448
246
    def last_revision(self):
449
 
        """Return last revision id, or NULL_REVISION."""
450
 
        return self.last_revision_info()[1]
451
 
 
452
 
    @needs_read_lock
453
 
    def last_revision_info(self):
454
 
        """Return information about the last revision.
455
 
 
456
 
        :return: A tuple (revno, revision_id).
457
 
        """
458
 
        if self._last_revision_info_cache is None:
459
 
            self._last_revision_info_cache = self._last_revision_info()
460
 
        return self._last_revision_info_cache
461
 
 
462
 
    def _last_revision_info(self):
463
 
        rh = self.revision_history()
464
 
        revno = len(rh)
465
 
        if revno:
466
 
            return (revno, rh[-1])
 
247
        """Return last patch hash, or None if no history."""
 
248
        ph = self.revision_history()
 
249
        if ph:
 
250
            return ph[-1]
467
251
        else:
468
 
            return (0, _mod_revision.NULL_REVISION)
 
252
            return None
469
253
 
470
 
    @deprecated_method(deprecated_in((1, 6, 0)))
471
 
    def missing_revisions(self, other, stop_revision=None):
 
254
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
472
255
        """Return a list of new revisions that would perfectly fit.
473
256
        
474
257
        If self and other have not diverged, return a list of the revisions
475
258
        present in other, but missing from self.
 
259
 
 
260
        >>> from bzrlib.workingtree import WorkingTree
 
261
        >>> bzrlib.trace.silent = True
 
262
        >>> d1 = bzrdir.ScratchDir()
 
263
        >>> br1 = d1.open_branch()
 
264
        >>> wt1 = d1.open_workingtree()
 
265
        >>> d2 = bzrdir.ScratchDir()
 
266
        >>> br2 = d2.open_branch()
 
267
        >>> wt2 = d2.open_workingtree()
 
268
        >>> br1.missing_revisions(br2)
 
269
        []
 
270
        >>> wt2.commit("lala!", rev_id="REVISION-ID-1")
 
271
        >>> br1.missing_revisions(br2)
 
272
        [u'REVISION-ID-1']
 
273
        >>> br2.missing_revisions(br1)
 
274
        []
 
275
        >>> wt1.commit("lala!", rev_id="REVISION-ID-1")
 
276
        >>> br1.missing_revisions(br2)
 
277
        []
 
278
        >>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
 
279
        >>> br1.missing_revisions(br2)
 
280
        [u'REVISION-ID-2A']
 
281
        >>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
 
282
        >>> br1.missing_revisions(br2)
 
283
        Traceback (most recent call last):
 
284
        DivergedBranches: These branches have diverged.  Try merge.
476
285
        """
477
286
        self_history = self.revision_history()
478
287
        self_len = len(self_history)
481
290
        common_index = min(self_len, other_len) -1
482
291
        if common_index >= 0 and \
483
292
            self_history[common_index] != other_history[common_index]:
484
 
            raise errors.DivergedBranches(self, other)
 
293
            raise DivergedBranches(self, other)
485
294
 
486
295
        if stop_revision is None:
487
296
            stop_revision = other_len
488
297
        else:
 
298
            assert isinstance(stop_revision, int)
489
299
            if stop_revision > other_len:
490
 
                raise errors.NoSuchRevision(self, stop_revision)
 
300
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
491
301
        return other_history[self_len:stop_revision]
492
302
 
493
 
    @needs_write_lock
494
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
495
 
                         graph=None):
496
 
        """Pull in new perfect-fit revisions.
497
 
 
498
 
        :param other: Another Branch to pull from
499
 
        :param stop_revision: Updated until the given revision
500
 
        :param overwrite: Always set the branch pointer, rather than checking
501
 
            to see if it is a proper descendant.
502
 
        :param graph: A Graph object that can be used to query history
503
 
            information. This can be None.
504
 
        :return: None
505
 
        """
506
 
        other.lock_read()
507
 
        try:
508
 
            other_revno, other_last_revision = other.last_revision_info()
509
 
            stop_revno = None # unknown
510
 
            if stop_revision is None:
511
 
                stop_revision = other_last_revision
512
 
                if _mod_revision.is_null(stop_revision):
513
 
                    # if there are no commits, we're done.
514
 
                    return
515
 
                stop_revno = other_revno
516
 
 
517
 
            # what's the current last revision, before we fetch [and change it
518
 
            # possibly]
519
 
            last_rev = _mod_revision.ensure_null(self.last_revision())
520
 
            # we fetch here so that we don't process data twice in the common
521
 
            # case of having something to pull, and so that the check for 
522
 
            # already merged can operate on the just fetched graph, which will
523
 
            # be cached in memory.
524
 
            self.fetch(other, stop_revision)
525
 
            # Check to see if one is an ancestor of the other
526
 
            if not overwrite:
527
 
                if graph is None:
528
 
                    graph = self.repository.get_graph()
529
 
                if self._check_if_descendant_or_diverged(
530
 
                        stop_revision, last_rev, graph, other):
531
 
                    # stop_revision is a descendant of last_rev, but we aren't
532
 
                    # overwriting, so we're done.
533
 
                    return
534
 
            if stop_revno is None:
535
 
                if graph is None:
536
 
                    graph = self.repository.get_graph()
537
 
                this_revno, this_last_revision = self.last_revision_info()
538
 
                stop_revno = graph.find_distance_to_null(stop_revision,
539
 
                                [(other_last_revision, other_revno),
540
 
                                 (this_last_revision, this_revno)])
541
 
            self.set_last_revision_info(stop_revno, stop_revision)
542
 
        finally:
543
 
            other.unlock()
544
 
 
 
303
    def update_revisions(self, other, stop_revision=None):
 
304
        """Pull in new perfect-fit revisions."""
 
305
        raise NotImplementedError('update_revisions is abstract')
 
306
 
 
307
    def pullable_revisions(self, other, stop_revision):
 
308
        raise NotImplementedError('pullable_revisions is abstract')
 
309
        
545
310
    def revision_id_to_revno(self, revision_id):
546
311
        """Given a revision id, return its revno"""
547
 
        if _mod_revision.is_null(revision_id):
 
312
        if revision_id is None:
548
313
            return 0
549
314
        history = self.revision_history()
550
315
        try:
551
316
            return history.index(revision_id) + 1
552
317
        except ValueError:
553
 
            raise errors.NoSuchRevision(self, revision_id)
 
318
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
554
319
 
555
320
    def get_rev_id(self, revno, history=None):
556
321
        """Find the revision id of the specified revno."""
557
322
        if revno == 0:
558
 
            return _mod_revision.NULL_REVISION
 
323
            return None
559
324
        if history is None:
560
325
            history = self.revision_history()
561
 
        if revno <= 0 or revno > len(history):
562
 
            raise errors.NoSuchRevision(self, revno)
 
326
        elif revno <= 0 or revno > len(history):
 
327
            raise bzrlib.errors.NoSuchRevision(self, revno)
563
328
        return history[revno - 1]
564
329
 
565
 
    def pull(self, source, overwrite=False, stop_revision=None,
566
 
             possible_transports=None, _override_hook_target=None):
567
 
        """Mirror source into this branch.
568
 
 
569
 
        This branch is considered to be 'local', having low latency.
570
 
 
571
 
        :returns: PullResult instance
572
 
        """
573
 
        raise NotImplementedError(self.pull)
574
 
 
575
 
    def push(self, target, overwrite=False, stop_revision=None):
576
 
        """Mirror this branch into target.
577
 
 
578
 
        This branch is considered to be 'local', having low latency.
579
 
        """
580
 
        raise NotImplementedError(self.push)
 
330
    def pull(self, source, overwrite=False, stop_revision=None):
 
331
        raise NotImplementedError('pull is abstract')
581
332
 
582
333
    def basis_tree(self):
583
 
        """Return `Tree` object for last revision."""
 
334
        """Return `Tree` object for last revision.
 
335
 
 
336
        If there are no revisions yet, return an `EmptyTree`.
 
337
        """
584
338
        return self.repository.revision_tree(self.last_revision())
585
339
 
 
340
    def rename_one(self, from_rel, to_rel):
 
341
        """Rename one file.
 
342
 
 
343
        This can change the directory or the filename or both.
 
344
        """
 
345
        raise NotImplementedError('rename_one is abstract')
 
346
 
 
347
    def move(self, from_paths, to_name):
 
348
        """Rename files.
 
349
 
 
350
        to_name must exist as a versioned directory.
 
351
 
 
352
        If to_name exists and is a directory, the files are moved into
 
353
        it, keeping their old names.  If it is a directory, 
 
354
 
 
355
        Note that to_name is only the last component of the new name;
 
356
        this doesn't change the directory.
 
357
 
 
358
        This returns a list of (from_path, to_path) pairs for each
 
359
        entry that is moved.
 
360
        """
 
361
        raise NotImplementedError('move is abstract')
 
362
 
586
363
    def get_parent(self):
587
364
        """Return the parent location of the branch.
588
365
 
590
367
        pattern is that the user can override it by specifying a
591
368
        location.
592
369
        """
593
 
        raise NotImplementedError(self.get_parent)
594
 
 
595
 
    def _set_config_location(self, name, url, config=None,
596
 
                             make_relative=False):
597
 
        if config is None:
598
 
            config = self.get_config()
599
 
        if url is None:
600
 
            url = ''
601
 
        elif make_relative:
602
 
            url = urlutils.relative_url(self.base, url)
603
 
        config.set_user_option(name, url, warn_masked=True)
604
 
 
605
 
    def _get_config_location(self, name, config=None):
606
 
        if config is None:
607
 
            config = self.get_config()
608
 
        location = config.get_user_option(name)
609
 
        if location == '':
610
 
            location = None
611
 
        return location
612
 
 
613
 
    def get_submit_branch(self):
614
 
        """Return the submit location of the branch.
615
 
 
616
 
        This is the default location for bundle.  The usual
617
 
        pattern is that the user can override it by specifying a
618
 
        location.
619
 
        """
620
 
        return self.get_config().get_user_option('submit_branch')
621
 
 
622
 
    def set_submit_branch(self, location):
623
 
        """Return the submit location of the branch.
624
 
 
625
 
        This is the default location for bundle.  The usual
626
 
        pattern is that the user can override it by specifying a
627
 
        location.
628
 
        """
629
 
        self.get_config().set_user_option('submit_branch', location,
630
 
            warn_masked=True)
631
 
 
632
 
    def get_public_branch(self):
633
 
        """Return the public location of the branch.
634
 
 
635
 
        This is is used by merge directives.
636
 
        """
637
 
        return self._get_config_location('public_branch')
638
 
 
639
 
    def set_public_branch(self, location):
640
 
        """Return the submit location of the branch.
641
 
 
642
 
        This is the default location for bundle.  The usual
643
 
        pattern is that the user can override it by specifying a
644
 
        location.
645
 
        """
646
 
        self._set_config_location('public_branch', location)
 
370
        raise NotImplementedError('get_parent is abstract')
647
371
 
648
372
    def get_push_location(self):
649
373
        """Return the None or the location to push this branch to."""
650
 
        push_loc = self.get_config().get_user_option('push_location')
651
 
        return push_loc
 
374
        raise NotImplementedError('get_push_location is abstract')
652
375
 
653
376
    def set_push_location(self, location):
654
377
        """Set a new push location for this branch."""
655
 
        raise NotImplementedError(self.set_push_location)
 
378
        raise NotImplementedError('set_push_location is abstract')
656
379
 
657
380
    def set_parent(self, url):
658
 
        raise NotImplementedError(self.set_parent)
659
 
 
660
 
    @needs_write_lock
661
 
    def update(self):
662
 
        """Synchronise this branch with the master branch if any. 
663
 
 
664
 
        :return: None or the last_revision pivoted out during the update.
665
 
        """
666
 
        return None
 
381
        raise NotImplementedError('set_parent is abstract')
667
382
 
668
383
    def check_revno(self, revno):
669
384
        """\
679
394
        Zero (the NULL revision) is considered invalid
680
395
        """
681
396
        if revno < 1 or revno > self.revno():
682
 
            raise errors.InvalidRevisionNumber(revno)
 
397
            raise InvalidRevisionNumber(revno)
683
398
 
684
399
    @needs_read_lock
685
 
    def clone(self, to_bzrdir, revision_id=None):
 
400
    def clone(self, *args, **kwargs):
686
401
        """Clone this branch into to_bzrdir preserving all semantic values.
687
402
        
688
403
        revision_id: if not None, the revision history in the new branch will
689
404
                     be truncated to end with revision_id.
690
405
        """
691
 
        result = to_bzrdir.create_branch()
 
406
        # for API compatability, until 0.8 releases we provide the old api:
 
407
        # def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
 
408
        # after 0.8 releases, the *args and **kwargs should be changed:
 
409
        # def clone(self, to_bzrdir, revision_id=None):
 
410
        if (kwargs.get('to_location', None) or
 
411
            kwargs.get('revision', None) or
 
412
            kwargs.get('basis_branch', None) or
 
413
            (len(args) and isinstance(args[0], basestring))):
 
414
            # backwards compatability api:
 
415
            warn("Branch.clone() has been deprecated for BzrDir.clone() from"
 
416
                 " bzrlib 0.8.", DeprecationWarning, stacklevel=3)
 
417
            # get basis_branch
 
418
            if len(args) > 2:
 
419
                basis_branch = args[2]
 
420
            else:
 
421
                basis_branch = kwargs.get('basis_branch', None)
 
422
            if basis_branch:
 
423
                basis = basis_branch.bzrdir
 
424
            else:
 
425
                basis = None
 
426
            # get revision
 
427
            if len(args) > 1:
 
428
                revision_id = args[1]
 
429
            else:
 
430
                revision_id = kwargs.get('revision', None)
 
431
            # get location
 
432
            if len(args):
 
433
                url = args[0]
 
434
            else:
 
435
                # no default to raise if not provided.
 
436
                url = kwargs.get('to_location')
 
437
            return self.bzrdir.clone(url,
 
438
                                     revision_id=revision_id,
 
439
                                     basis=basis).open_branch()
 
440
        # new cleaner api.
 
441
        # generate args by hand 
 
442
        if len(args) > 1:
 
443
            revision_id = args[1]
 
444
        else:
 
445
            revision_id = kwargs.get('revision_id', None)
 
446
        if len(args):
 
447
            to_bzrdir = args[0]
 
448
        else:
 
449
            # no default to raise if not provided.
 
450
            to_bzrdir = kwargs.get('to_bzrdir')
 
451
        result = self._format.initialize(to_bzrdir)
692
452
        self.copy_content_into(result, revision_id=revision_id)
693
453
        return  result
694
454
 
695
455
    @needs_read_lock
696
456
    def sprout(self, to_bzrdir, revision_id=None):
697
457
        """Create a new line of development from the branch, into to_bzrdir.
698
 
 
699
 
        to_bzrdir controls the branch format.
700
 
 
 
458
        
701
459
        revision_id: if not None, the revision history in the new branch will
702
460
                     be truncated to end with revision_id.
703
461
        """
704
 
        result = to_bzrdir.create_branch()
 
462
        result = self._format.initialize(to_bzrdir)
705
463
        self.copy_content_into(result, revision_id=revision_id)
706
464
        result.set_parent(self.bzrdir.root_transport.base)
707
465
        return result
708
466
 
709
 
    def _synchronize_history(self, destination, revision_id):
710
 
        """Synchronize last revision and revision history between branches.
711
 
 
712
 
        This version is most efficient when the destination is also a
713
 
        BzrBranch6, but works for BzrBranch5, as long as the destination's
714
 
        repository contains all the lefthand ancestors of the intended
715
 
        last_revision.  If not, set_last_revision_info will fail.
716
 
 
717
 
        :param destination: The branch to copy the history into
718
 
        :param revision_id: The revision-id to truncate history at.  May
719
 
          be None to copy complete history.
720
 
        """
721
 
        source_revno, source_revision_id = self.last_revision_info()
722
 
        if revision_id is None:
723
 
            revno, revision_id = source_revno, source_revision_id
724
 
        elif source_revision_id == revision_id:
725
 
            # we know the revno without needing to walk all of history
726
 
            revno = source_revno
727
 
        else:
728
 
            # To figure out the revno for a random revision, we need to build
729
 
            # the revision history, and count its length.
730
 
            # We don't care about the order, just how long it is.
731
 
            # Alternatively, we could start at the current location, and count
732
 
            # backwards. But there is no guarantee that we will find it since
733
 
            # it may be a merged revision.
734
 
            revno = len(list(self.repository.iter_reverse_revision_history(
735
 
                                                                revision_id)))
736
 
        destination.set_last_revision_info(revno, revision_id)
737
 
    
738
467
    @needs_read_lock
739
468
    def copy_content_into(self, destination, revision_id=None):
740
469
        """Copy the content of self into destination.
742
471
        revision_id: if not None, the revision history in the new branch will
743
472
                     be truncated to end with revision_id.
744
473
        """
745
 
        self._synchronize_history(destination, revision_id)
746
 
        try:
747
 
            parent = self.get_parent()
748
 
        except errors.InaccessibleParent, e:
749
 
            mutter('parent was not accessible to copy: %s', e)
750
 
        else:
751
 
            if parent:
752
 
                destination.set_parent(parent)
753
 
        self.tags.merge_to(destination.tags)
754
 
 
755
 
    @needs_read_lock
756
 
    def check(self):
757
 
        """Check consistency of the branch.
758
 
 
759
 
        In particular this checks that revisions given in the revision-history
760
 
        do actually match up in the revision graph, and that they're all 
761
 
        present in the repository.
762
 
        
763
 
        Callers will typically also want to check the repository.
764
 
 
765
 
        :return: A BranchCheckResult.
766
 
        """
767
 
        mainline_parent_id = None
768
 
        last_revno, last_revision_id = self.last_revision_info()
769
 
        real_rev_history = list(self.repository.iter_reverse_revision_history(
770
 
                                last_revision_id))
771
 
        real_rev_history.reverse()
772
 
        if len(real_rev_history) != last_revno:
773
 
            raise errors.BzrCheckError('revno does not match len(mainline)'
774
 
                ' %s != %s' % (last_revno, len(real_rev_history)))
775
 
        # TODO: We should probably also check that real_rev_history actually
776
 
        #       matches self.revision_history()
777
 
        for revision_id in real_rev_history:
 
474
        new_history = self.revision_history()
 
475
        if revision_id is not None:
778
476
            try:
779
 
                revision = self.repository.get_revision(revision_id)
780
 
            except errors.NoSuchRevision, e:
781
 
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
782
 
                            % revision_id)
783
 
            # In general the first entry on the revision history has no parents.
784
 
            # But it's not illegal for it to have parents listed; this can happen
785
 
            # in imports from Arch when the parents weren't reachable.
786
 
            if mainline_parent_id is not None:
787
 
                if mainline_parent_id not in revision.parent_ids:
788
 
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
789
 
                                        "parents of {%s}"
790
 
                                        % (mainline_parent_id, revision_id))
791
 
            mainline_parent_id = revision_id
792
 
        return BranchCheckResult(self)
793
 
 
794
 
    def _get_checkout_format(self):
795
 
        """Return the most suitable metadir for a checkout of this branch.
796
 
        Weaves are used if this branch's repository uses weaves.
797
 
        """
798
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
799
 
            from bzrlib.repofmt import weaverepo
800
 
            format = bzrdir.BzrDirMetaFormat1()
801
 
            format.repository_format = weaverepo.RepositoryFormat7()
802
 
        else:
803
 
            format = self.repository.bzrdir.checkout_metadir()
804
 
            format.set_branch_format(self._format)
805
 
        return format
806
 
 
807
 
    def create_checkout(self, to_location, revision_id=None,
808
 
                        lightweight=False, accelerator_tree=None,
809
 
                        hardlink=False):
810
 
        """Create a checkout of a branch.
811
 
        
812
 
        :param to_location: The url to produce the checkout at
813
 
        :param revision_id: The revision to check out
814
 
        :param lightweight: If True, produce a lightweight checkout, otherwise,
815
 
        produce a bound branch (heavyweight checkout)
816
 
        :param accelerator_tree: A tree which can be used for retrieving file
817
 
            contents more quickly than the revision tree, i.e. a workingtree.
818
 
            The revision tree will be used for cases where accelerator_tree's
819
 
            content is different.
820
 
        :param hardlink: If true, hard-link files from accelerator_tree,
821
 
            where possible.
822
 
        :return: The tree of the created checkout
823
 
        """
824
 
        t = transport.get_transport(to_location)
825
 
        t.ensure_base()
826
 
        if lightweight:
827
 
            format = self._get_checkout_format()
828
 
            checkout = format.initialize_on_transport(t)
829
 
            from_branch = BranchReferenceFormat().initialize(checkout, self)
830
 
        else:
831
 
            format = self._get_checkout_format()
832
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
833
 
                to_location, force_new_tree=False, format=format)
834
 
            checkout = checkout_branch.bzrdir
835
 
            checkout_branch.bind(self)
836
 
            # pull up to the specified revision_id to set the initial 
837
 
            # branch tip correctly, and seed it with history.
838
 
            checkout_branch.pull(self, stop_revision=revision_id)
839
 
            from_branch=None
840
 
        tree = checkout.create_workingtree(revision_id,
841
 
                                           from_branch=from_branch,
842
 
                                           accelerator_tree=accelerator_tree,
843
 
                                           hardlink=hardlink)
844
 
        basis_tree = tree.basis_tree()
845
 
        basis_tree.lock_read()
846
 
        try:
847
 
            for path, file_id in basis_tree.iter_references():
848
 
                reference_parent = self.reference_parent(file_id, path)
849
 
                reference_parent.create_checkout(tree.abspath(path),
850
 
                    basis_tree.get_reference_revision(file_id, path),
851
 
                    lightweight)
852
 
        finally:
853
 
            basis_tree.unlock()
854
 
        return tree
855
 
 
856
 
    @needs_write_lock
857
 
    def reconcile(self, thorough=True):
858
 
        """Make sure the data stored in this branch is consistent."""
859
 
        from bzrlib.reconcile import BranchReconciler
860
 
        reconciler = BranchReconciler(self, thorough=thorough)
861
 
        reconciler.reconcile()
862
 
        return reconciler
863
 
 
864
 
    def reference_parent(self, file_id, path):
865
 
        """Return the parent branch for a tree-reference file_id
866
 
        :param file_id: The file_id of the tree reference
867
 
        :param path: The path of the file_id in the tree
868
 
        :return: A branch associated with the file_id
869
 
        """
870
 
        # FIXME should provide multiple branches, based on config
871
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
872
 
 
873
 
    def supports_tags(self):
874
 
        return self._format.supports_tags()
875
 
 
876
 
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
877
 
                                         other_branch):
878
 
        """Ensure that revision_b is a descendant of revision_a.
879
 
 
880
 
        This is a helper function for update_revisions.
881
 
        
882
 
        :raises: DivergedBranches if revision_b has diverged from revision_a.
883
 
        :returns: True if revision_b is a descendant of revision_a.
884
 
        """
885
 
        relation = self._revision_relations(revision_a, revision_b, graph)
886
 
        if relation == 'b_descends_from_a':
887
 
            return True
888
 
        elif relation == 'diverged':
889
 
            raise errors.DivergedBranches(self, other_branch)
890
 
        elif relation == 'a_descends_from_b':
891
 
            return False
892
 
        else:
893
 
            raise AssertionError("invalid relation: %r" % (relation,))
894
 
 
895
 
    def _revision_relations(self, revision_a, revision_b, graph):
896
 
        """Determine the relationship between two revisions.
897
 
        
898
 
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
899
 
        """
900
 
        heads = graph.heads([revision_a, revision_b])
901
 
        if heads == set([revision_b]):
902
 
            return 'b_descends_from_a'
903
 
        elif heads == set([revision_a, revision_b]):
904
 
            # These branches have diverged
905
 
            return 'diverged'
906
 
        elif heads == set([revision_a]):
907
 
            return 'a_descends_from_b'
908
 
        else:
909
 
            raise AssertionError("invalid heads: %r" % (heads,))
 
477
                new_history = new_history[:new_history.index(revision_id) + 1]
 
478
            except ValueError:
 
479
                rev = self.repository.get_revision(revision_id)
 
480
                new_history = rev.get_history(self.repository)[1:]
 
481
        destination.set_revision_history(new_history)
 
482
        parent = self.get_parent()
 
483
        if parent:
 
484
            destination.set_parent(parent)
910
485
 
911
486
 
912
487
class BranchFormat(object):
933
508
    _formats = {}
934
509
    """The known formats."""
935
510
 
936
 
    def __eq__(self, other):
937
 
        return self.__class__ is other.__class__
938
 
 
939
 
    def __ne__(self, other):
940
 
        return not (self == other)
941
 
 
942
511
    @classmethod
943
512
    def find_format(klass, a_bzrdir):
944
513
        """Return the format for the branch object in a_bzrdir."""
946
515
            transport = a_bzrdir.get_branch_transport(None)
947
516
            format_string = transport.get("format").read()
948
517
            return klass._formats[format_string]
949
 
        except errors.NoSuchFile:
950
 
            raise errors.NotBranchError(path=transport.base)
 
518
        except NoSuchFile:
 
519
            raise NotBranchError(path=transport.base)
951
520
        except KeyError:
952
 
            raise errors.UnknownFormatError(format=format_string, kind='branch')
 
521
            raise errors.UnknownFormatError(format_string)
953
522
 
954
523
    @classmethod
955
524
    def get_default_format(klass):
956
525
        """Return the current default format."""
957
526
        return klass._default_format
958
527
 
959
 
    def get_reference(self, a_bzrdir):
960
 
        """Get the target reference of the branch in a_bzrdir.
961
 
 
962
 
        format probing must have been completed before calling
963
 
        this method - it is assumed that the format of the branch
964
 
        in a_bzrdir is correct.
965
 
 
966
 
        :param a_bzrdir: The bzrdir to get the branch data from.
967
 
        :return: None if the branch is not a reference branch.
968
 
        """
969
 
        return None
970
 
 
971
 
    @classmethod
972
 
    def set_reference(self, a_bzrdir, to_branch):
973
 
        """Set the target reference of the branch in a_bzrdir.
974
 
 
975
 
        format probing must have been completed before calling
976
 
        this method - it is assumed that the format of the branch
977
 
        in a_bzrdir is correct.
978
 
 
979
 
        :param a_bzrdir: The bzrdir to set the branch reference for.
980
 
        :param to_branch: branch that the checkout is to reference
981
 
        """
982
 
        raise NotImplementedError(self.set_reference)
983
 
 
984
528
    def get_format_string(self):
985
529
        """Return the ASCII format string that identifies this format."""
986
530
        raise NotImplementedError(self.get_format_string)
987
531
 
988
 
    def get_format_description(self):
989
 
        """Return the short format description for this format."""
990
 
        raise NotImplementedError(self.get_format_description)
991
 
 
992
 
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
993
 
                           set_format=True):
994
 
        """Initialize a branch in a bzrdir, with specified files
995
 
 
996
 
        :param a_bzrdir: The bzrdir to initialize the branch in
997
 
        :param utf8_files: The files to create as a list of
998
 
            (filename, content) tuples
999
 
        :param set_format: If True, set the format with
1000
 
            self.get_format_string.  (BzrBranch4 has its format set
1001
 
            elsewhere)
1002
 
        :return: a branch in this format
1003
 
        """
1004
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1005
 
        branch_transport = a_bzrdir.get_branch_transport(self)
1006
 
        lock_map = {
1007
 
            'metadir': ('lock', lockdir.LockDir),
1008
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
1009
 
        }
1010
 
        lock_name, lock_class = lock_map[lock_type]
1011
 
        control_files = lockable_files.LockableFiles(branch_transport,
1012
 
            lock_name, lock_class)
1013
 
        control_files.create_lock()
1014
 
        control_files.lock_write()
1015
 
        if set_format:
1016
 
            utf8_files += [('format', self.get_format_string())]
1017
 
        try:
1018
 
            for (filename, content) in utf8_files:
1019
 
                branch_transport.put_bytes(
1020
 
                    filename, content,
1021
 
                    mode=a_bzrdir._get_file_mode())
1022
 
        finally:
1023
 
            control_files.unlock()
1024
 
        return self.open(a_bzrdir, _found=True)
1025
 
 
1026
532
    def initialize(self, a_bzrdir):
1027
533
        """Create a branch of this format in a_bzrdir."""
1028
 
        raise NotImplementedError(self.initialize)
 
534
        raise NotImplementedError(self.initialized)
1029
535
 
1030
536
    def is_supported(self):
1031
537
        """Is this format supported?
1052
558
    def set_default_format(klass, format):
1053
559
        klass._default_format = format
1054
560
 
1055
 
    def supports_stacking(self):
1056
 
        """True if this format records a stacked-on branch."""
1057
 
        return False
1058
 
 
1059
561
    @classmethod
1060
562
    def unregister_format(klass, format):
 
563
        assert klass._formats[format.get_format_string()] is format
1061
564
        del klass._formats[format.get_format_string()]
1062
565
 
1063
 
    def __str__(self):
1064
 
        return self.get_format_string().rstrip()
1065
 
 
1066
 
    def supports_tags(self):
1067
 
        """True if this format supports tags stored in the branch"""
1068
 
        return False  # by default
1069
 
 
1070
 
 
1071
 
class BranchHooks(Hooks):
1072
 
    """A dictionary mapping hook name to a list of callables for branch hooks.
1073
 
    
1074
 
    e.g. ['set_rh'] Is the list of items to be called when the
1075
 
    set_revision_history function is invoked.
1076
 
    """
1077
 
 
1078
 
    def __init__(self):
1079
 
        """Create the default hooks.
1080
 
 
1081
 
        These are all empty initially, because by default nothing should get
1082
 
        notified.
1083
 
        """
1084
 
        Hooks.__init__(self)
1085
 
        # Introduced in 0.15:
1086
 
        # invoked whenever the revision history has been set
1087
 
        # with set_revision_history. The api signature is
1088
 
        # (branch, revision_history), and the branch will
1089
 
        # be write-locked.
1090
 
        self['set_rh'] = []
1091
 
        # Invoked after a branch is opened. The api signature is (branch).
1092
 
        self['open'] = []
1093
 
        # invoked after a push operation completes.
1094
 
        # the api signature is
1095
 
        # (push_result)
1096
 
        # containing the members
1097
 
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
1098
 
        # where local is the local target branch or None, master is the target 
1099
 
        # master branch, and the rest should be self explanatory. The source
1100
 
        # is read locked and the target branches write locked. Source will
1101
 
        # be the local low-latency branch.
1102
 
        self['post_push'] = []
1103
 
        # invoked after a pull operation completes.
1104
 
        # the api signature is
1105
 
        # (pull_result)
1106
 
        # containing the members
1107
 
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
1108
 
        # where local is the local branch or None, master is the target 
1109
 
        # master branch, and the rest should be self explanatory. The source
1110
 
        # is read locked and the target branches write locked. The local
1111
 
        # branch is the low-latency branch.
1112
 
        self['post_pull'] = []
1113
 
        # invoked before a commit operation takes place.
1114
 
        # the api signature is
1115
 
        # (local, master, old_revno, old_revid, future_revno, future_revid,
1116
 
        #  tree_delta, future_tree).
1117
 
        # old_revid is NULL_REVISION for the first commit to a branch
1118
 
        # tree_delta is a TreeDelta object describing changes from the basis
1119
 
        # revision, hooks MUST NOT modify this delta
1120
 
        # future_tree is an in-memory tree obtained from
1121
 
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1122
 
        self['pre_commit'] = []
1123
 
        # invoked after a commit operation completes.
1124
 
        # the api signature is 
1125
 
        # (local, master, old_revno, old_revid, new_revno, new_revid)
1126
 
        # old_revid is NULL_REVISION for the first commit to a branch.
1127
 
        self['post_commit'] = []
1128
 
        # invoked after a uncommit operation completes.
1129
 
        # the api signature is
1130
 
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
1131
 
        # local is the local branch or None, master is the target branch,
1132
 
        # and an empty branch recieves new_revno of 0, new_revid of None.
1133
 
        self['post_uncommit'] = []
1134
 
        # Introduced in 1.6
1135
 
        # Invoked before the tip of a branch changes.
1136
 
        # the api signature is
1137
 
        # (params) where params is a ChangeBranchTipParams with the members
1138
 
        # (branch, old_revno, new_revno, old_revid, new_revid)
1139
 
        self['pre_change_branch_tip'] = []
1140
 
        # Introduced in 1.4
1141
 
        # Invoked after the tip of a branch changes.
1142
 
        # the api signature is
1143
 
        # (params) where params is a ChangeBranchTipParams with the members
1144
 
        # (branch, old_revno, new_revno, old_revid, new_revid)
1145
 
        self['post_change_branch_tip'] = []
1146
 
        # Introduced in 1.9
1147
 
        # Invoked when a stacked branch activates its fallback locations and
1148
 
        # allows the transformation of the url of said location.
1149
 
        # the api signature is
1150
 
        # (branch, url) where branch is the branch having its fallback
1151
 
        # location activated and url is the url for the fallback location.
1152
 
        # The hook should return a url.
1153
 
        self['transform_fallback_location'] = []
1154
 
 
1155
 
 
1156
 
# install the default hooks into the Branch class.
1157
 
Branch.hooks = BranchHooks()
1158
 
 
1159
 
 
1160
 
class ChangeBranchTipParams(object):
1161
 
    """Object holding parameters passed to *_change_branch_tip hooks.
1162
 
 
1163
 
    There are 5 fields that hooks may wish to access:
1164
 
 
1165
 
    :ivar branch: the branch being changed
1166
 
    :ivar old_revno: revision number before the change
1167
 
    :ivar new_revno: revision number after the change
1168
 
    :ivar old_revid: revision id before the change
1169
 
    :ivar new_revid: revision id after the change
1170
 
 
1171
 
    The revid fields are strings. The revno fields are integers.
1172
 
    """
1173
 
 
1174
 
    def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1175
 
        """Create a group of ChangeBranchTip parameters.
1176
 
 
1177
 
        :param branch: The branch being changed.
1178
 
        :param old_revno: Revision number before the change.
1179
 
        :param new_revno: Revision number after the change.
1180
 
        :param old_revid: Tip revision id before the change.
1181
 
        :param new_revid: Tip revision id after the change.
1182
 
        """
1183
 
        self.branch = branch
1184
 
        self.old_revno = old_revno
1185
 
        self.new_revno = new_revno
1186
 
        self.old_revid = old_revid
1187
 
        self.new_revid = new_revid
1188
 
 
1189
 
    def __eq__(self, other):
1190
 
        return self.__dict__ == other.__dict__
1191
 
    
1192
 
    def __repr__(self):
1193
 
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1194
 
            self.__class__.__name__, self.branch, 
1195
 
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1196
 
 
1197
566
 
1198
567
class BzrBranchFormat4(BranchFormat):
1199
568
    """Bzr branch format 4.
1203
572
     - a branch-lock lock file [ to be shared with the bzrdir ]
1204
573
    """
1205
574
 
1206
 
    def get_format_description(self):
1207
 
        """See BranchFormat.get_format_description()."""
1208
 
        return "Branch format 4"
1209
 
 
1210
575
    def initialize(self, a_bzrdir):
1211
576
        """Create a branch of this format in a_bzrdir."""
 
577
        mutter('creating branch in %s', a_bzrdir.transport.base)
 
578
        branch_transport = a_bzrdir.get_branch_transport(self)
1212
579
        utf8_files = [('revision-history', ''),
1213
580
                      ('branch-name', ''),
1214
581
                      ]
1215
 
        return self._initialize_helper(a_bzrdir, utf8_files,
1216
 
                                       lock_type='branch4', set_format=False)
 
582
        control_files = LockableFiles(branch_transport, 'branch-lock')
 
583
        control_files.lock_write()
 
584
        try:
 
585
            for file, content in utf8_files:
 
586
                control_files.put_utf8(file, content)
 
587
        finally:
 
588
            control_files.unlock()
 
589
        return self.open(a_bzrdir, _found=True)
1217
590
 
1218
591
    def __init__(self):
1219
592
        super(BzrBranchFormat4, self).__init__()
1233
606
                         a_bzrdir=a_bzrdir,
1234
607
                         _repository=a_bzrdir.open_repository())
1235
608
 
1236
 
    def __str__(self):
1237
 
        return "Bazaar-NG branch format 4"
1238
 
 
1239
 
 
1240
 
class BranchFormatMetadir(BranchFormat):
1241
 
    """Common logic for meta-dir based branch formats."""
1242
 
 
1243
 
    def _branch_class(self):
1244
 
        """What class to instantiate on open calls."""
1245
 
        raise NotImplementedError(self._branch_class)
1246
 
 
1247
 
    def open(self, a_bzrdir, _found=False):
1248
 
        """Return the branch object for a_bzrdir.
1249
 
 
1250
 
        _found is a private parameter, do not use it. It is used to indicate
1251
 
               if format probing has already be done.
1252
 
        """
1253
 
        if not _found:
1254
 
            format = BranchFormat.find_format(a_bzrdir)
1255
 
            if format.__class__ != self.__class__:
1256
 
                raise AssertionError("wrong format %r found for %r" %
1257
 
                    (format, self))
1258
 
        try:
1259
 
            transport = a_bzrdir.get_branch_transport(None)
1260
 
            control_files = lockable_files.LockableFiles(transport, 'lock',
1261
 
                                                         lockdir.LockDir)
1262
 
            return self._branch_class()(_format=self,
1263
 
                              _control_files=control_files,
1264
 
                              a_bzrdir=a_bzrdir,
1265
 
                              _repository=a_bzrdir.find_repository())
1266
 
        except errors.NoSuchFile:
1267
 
            raise errors.NotBranchError(path=transport.base)
1268
 
 
1269
 
    def __init__(self):
1270
 
        super(BranchFormatMetadir, self).__init__()
1271
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1272
 
 
1273
 
    def supports_tags(self):
1274
 
        return True
1275
 
 
1276
 
 
1277
 
class BzrBranchFormat5(BranchFormatMetadir):
 
609
 
 
610
class BzrBranchFormat5(BranchFormat):
1278
611
    """Bzr branch format 5.
1279
612
 
1280
613
    This format has:
1281
614
     - a revision-history file.
1282
615
     - a format string
1283
 
     - a lock dir guarding the branch itself
1284
 
     - all of this stored in a branch/ subdirectory
 
616
     - a lock file.
1285
617
     - works with shared repositories.
1286
 
 
1287
 
    This format is new in bzr 0.8.
1288
618
    """
1289
619
 
1290
 
    def _branch_class(self):
1291
 
        return BzrBranch5
1292
 
 
1293
620
    def get_format_string(self):
1294
621
        """See BranchFormat.get_format_string()."""
1295
622
        return "Bazaar-NG branch format 5\n"
1296
 
 
1297
 
    def get_format_description(self):
1298
 
        """See BranchFormat.get_format_description()."""
1299
 
        return "Branch format 5"
1300
623
        
1301
624
    def initialize(self, a_bzrdir):
1302
625
        """Create a branch of this format in a_bzrdir."""
 
626
        mutter('creating branch in %s', a_bzrdir.transport.base)
 
627
        branch_transport = a_bzrdir.get_branch_transport(self)
 
628
 
1303
629
        utf8_files = [('revision-history', ''),
1304
630
                      ('branch-name', ''),
1305
631
                      ]
1306
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1307
 
 
1308
 
    def supports_tags(self):
1309
 
        return False
1310
 
 
1311
 
 
1312
 
class BzrBranchFormat6(BranchFormatMetadir):
1313
 
    """Branch format with last-revision and tags.
1314
 
 
1315
 
    Unlike previous formats, this has no explicit revision history. Instead,
1316
 
    this just stores the last-revision, and the left-hand history leading
1317
 
    up to there is the history.
1318
 
 
1319
 
    This format was introduced in bzr 0.15
1320
 
    and became the default in 0.91.
1321
 
    """
1322
 
 
1323
 
    def _branch_class(self):
1324
 
        return BzrBranch6
1325
 
 
1326
 
    def get_format_string(self):
1327
 
        """See BranchFormat.get_format_string()."""
1328
 
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
1329
 
 
1330
 
    def get_format_description(self):
1331
 
        """See BranchFormat.get_format_description()."""
1332
 
        return "Branch format 6"
1333
 
 
1334
 
    def initialize(self, a_bzrdir):
1335
 
        """Create a branch of this format in a_bzrdir."""
1336
 
        utf8_files = [('last-revision', '0 null:\n'),
1337
 
                      ('branch.conf', ''),
1338
 
                      ('tags', ''),
1339
 
                      ]
1340
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1341
 
 
1342
 
 
1343
 
class BzrBranchFormat7(BranchFormatMetadir):
1344
 
    """Branch format with last-revision, tags, and a stacked location pointer.
1345
 
 
1346
 
    The stacked location pointer is passed down to the repository and requires
1347
 
    a repository format with supports_external_lookups = True.
1348
 
 
1349
 
    This format was introduced in bzr 1.6.
1350
 
    """
1351
 
 
1352
 
    def _branch_class(self):
1353
 
        return BzrBranch7
1354
 
 
1355
 
    def get_format_string(self):
1356
 
        """See BranchFormat.get_format_string()."""
1357
 
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1358
 
 
1359
 
    def get_format_description(self):
1360
 
        """See BranchFormat.get_format_description()."""
1361
 
        return "Branch format 7"
1362
 
 
1363
 
    def initialize(self, a_bzrdir):
1364
 
        """Create a branch of this format in a_bzrdir."""
1365
 
        utf8_files = [('last-revision', '0 null:\n'),
1366
 
                      ('branch.conf', ''),
1367
 
                      ('tags', ''),
1368
 
                      ]
1369
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
632
        lock_file = 'lock'
 
633
        branch_transport.put(lock_file, StringIO()) # TODO get the file mode from the bzrdir lock files., mode=file_mode)
 
634
        control_files = LockableFiles(branch_transport, 'lock')
 
635
        control_files.lock_write()
 
636
        control_files.put_utf8('format', self.get_format_string())
 
637
        try:
 
638
            for file, content in utf8_files:
 
639
                control_files.put_utf8(file, content)
 
640
        finally:
 
641
            control_files.unlock()
 
642
        return self.open(a_bzrdir, _found=True, )
1370
643
 
1371
644
    def __init__(self):
1372
 
        super(BzrBranchFormat7, self).__init__()
1373
 
        self._matchingbzrdir.repository_format = \
1374
 
            RepositoryFormatKnitPack5RichRoot()
1375
 
 
1376
 
    def supports_stacking(self):
1377
 
        return True
 
645
        super(BzrBranchFormat5, self).__init__()
 
646
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
647
 
 
648
    def open(self, a_bzrdir, _found=False):
 
649
        """Return the branch object for a_bzrdir
 
650
 
 
651
        _found is a private parameter, do not use it. It is used to indicate
 
652
               if format probing has already be done.
 
653
        """
 
654
        if not _found:
 
655
            format = BranchFormat.find_format(a_bzrdir)
 
656
            assert format.__class__ == self.__class__
 
657
        transport = a_bzrdir.get_branch_transport(None)
 
658
        control_files = LockableFiles(transport, 'lock')
 
659
        return BzrBranch(_format=self,
 
660
                         _control_files=control_files,
 
661
                         a_bzrdir=a_bzrdir,
 
662
                         _repository=a_bzrdir.find_repository())
1378
663
 
1379
664
 
1380
665
class BranchReferenceFormat(BranchFormat):
1391
676
    def get_format_string(self):
1392
677
        """See BranchFormat.get_format_string()."""
1393
678
        return "Bazaar-NG Branch Reference Format 1\n"
1394
 
 
1395
 
    def get_format_description(self):
1396
 
        """See BranchFormat.get_format_description()."""
1397
 
        return "Checkout reference format 1"
1398
 
 
1399
 
    def get_reference(self, a_bzrdir):
1400
 
        """See BranchFormat.get_reference()."""
1401
 
        transport = a_bzrdir.get_branch_transport(None)
1402
 
        return transport.get('location').read()
1403
 
 
1404
 
    def set_reference(self, a_bzrdir, to_branch):
1405
 
        """See BranchFormat.set_reference()."""
1406
 
        transport = a_bzrdir.get_branch_transport(None)
1407
 
        location = transport.put_bytes('location', to_branch.base)
1408
 
 
 
679
        
1409
680
    def initialize(self, a_bzrdir, target_branch=None):
1410
681
        """Create a branch of this format in a_bzrdir."""
1411
682
        if target_branch is None:
1414
685
            raise errors.UninitializableFormat(self)
1415
686
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1416
687
        branch_transport = a_bzrdir.get_branch_transport(self)
1417
 
        branch_transport.put_bytes('location',
1418
 
            target_branch.bzrdir.root_transport.base)
1419
 
        branch_transport.put_bytes('format', self.get_format_string())
1420
 
        return self.open(
1421
 
            a_bzrdir, _found=True,
1422
 
            possible_transports=[target_branch.bzrdir.root_transport])
 
688
        # FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
 
689
        branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
 
690
        branch_transport.put('format', StringIO(self.get_format_string()))
 
691
        return self.open(a_bzrdir, _found=True)
1423
692
 
1424
693
    def __init__(self):
1425
694
        super(BranchReferenceFormat, self).__init__()
1435
704
            # emit some sort of warning/error to the caller ?!
1436
705
        return clone
1437
706
 
1438
 
    def open(self, a_bzrdir, _found=False, location=None,
1439
 
             possible_transports=None):
 
707
    def open(self, a_bzrdir, _found=False):
1440
708
        """Return the branch that the branch reference in a_bzrdir points at.
1441
709
 
1442
710
        _found is a private parameter, do not use it. It is used to indicate
1444
712
        """
1445
713
        if not _found:
1446
714
            format = BranchFormat.find_format(a_bzrdir)
1447
 
            if format.__class__ != self.__class__:
1448
 
                raise AssertionError("wrong format %r found for %r" %
1449
 
                    (format, self))
1450
 
        if location is None:
1451
 
            location = self.get_reference(a_bzrdir)
1452
 
        real_bzrdir = bzrdir.BzrDir.open(
1453
 
            location, possible_transports=possible_transports)
 
715
            assert format.__class__ == self.__class__
 
716
        transport = a_bzrdir.get_branch_transport(None)
 
717
        real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1454
718
        result = real_bzrdir.open_branch()
1455
719
        # this changes the behaviour of result.clone to create a new reference
1456
720
        # rather than a copy of the content of the branch.
1466
730
 
1467
731
# formats which have no format string are not discoverable
1468
732
# and not independently creatable, so are not registered.
1469
 
__format5 = BzrBranchFormat5()
1470
 
__format6 = BzrBranchFormat6()
1471
 
__format7 = BzrBranchFormat7()
1472
 
BranchFormat.register_format(__format5)
 
733
__default_format = BzrBranchFormat5()
 
734
BranchFormat.register_format(__default_format)
1473
735
BranchFormat.register_format(BranchReferenceFormat())
1474
 
BranchFormat.register_format(__format6)
1475
 
BranchFormat.register_format(__format7)
1476
 
BranchFormat.set_default_format(__format6)
 
736
BranchFormat.set_default_format(__default_format)
1477
737
_legacy_formats = [BzrBranchFormat4(),
1478
738
                   ]
1479
739
 
1483
743
    Note that it's "local" in the context of the filesystem; it doesn't
1484
744
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
1485
745
    it's writable, and can be accessed via the normal filesystem API.
1486
 
 
1487
 
    :ivar _transport: Transport for file operations on this branch's 
1488
 
        control files, typically pointing to the .bzr/branch directory.
1489
 
    :ivar repository: Repository for this branch.
1490
 
    :ivar base: The url of the base directory for this branch; the one 
1491
 
        containing the .bzr directory.
1492
746
    """
 
747
    # We actually expect this class to be somewhat short-lived; part of its
 
748
    # purpose is to try to isolate what bits of the branch logic are tied to
 
749
    # filesystem access, so that in a later step, we can extricate them to
 
750
    # a separarte ("storage") class.
 
751
    _inventory_weave = None
1493
752
    
1494
 
    def __init__(self, _format=None,
 
753
    # Map some sort of prefix into a namespace
 
754
    # stuff like "revno:10", "revid:", etc.
 
755
    # This should match a prefix with a function which accepts
 
756
    REVISION_NAMESPACES = {}
 
757
 
 
758
    def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
 
759
                 relax_version_check=DEPRECATED_PARAMETER, _format=None,
1495
760
                 _control_files=None, a_bzrdir=None, _repository=None):
1496
 
        """Create new branch object at a particular location."""
 
761
        """Create new branch object at a particular location.
 
762
 
 
763
        transport -- A Transport object, defining how to access files.
 
764
        
 
765
        init -- If True, create new control files in a previously
 
766
             unversioned directory.  If False, the branch must already
 
767
             be versioned.
 
768
 
 
769
        relax_version_check -- If true, the usual check for the branch
 
770
            version is not applied.  This is intended only for
 
771
            upgrade/recovery type use; it's not guaranteed that
 
772
            all operations will work on old format branches.
 
773
        """
1497
774
        if a_bzrdir is None:
1498
 
            raise ValueError('a_bzrdir must be supplied')
 
775
            self.bzrdir = bzrdir.BzrDir.open(transport.base)
1499
776
        else:
1500
777
            self.bzrdir = a_bzrdir
1501
 
        self._base = self.bzrdir.transport.clone('..').base
1502
 
        # XXX: We should be able to just do
1503
 
        #   self.base = self.bzrdir.root_transport.base
1504
 
        # but this does not quite work yet -- mbp 20080522
 
778
        self._transport = self.bzrdir.transport.clone('..')
 
779
        self._base = self._transport.base
1505
780
        self._format = _format
1506
781
        if _control_files is None:
1507
 
            raise ValueError('BzrBranch _control_files is None')
 
782
            raise BzrBadParameterMissing('_control_files')
1508
783
        self.control_files = _control_files
1509
 
        self._transport = _control_files._transport
 
784
        if deprecated_passed(init):
 
785
            warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
 
786
                 "deprecated as of bzr 0.8. Please use Branch.create().",
 
787
                 DeprecationWarning,
 
788
                 stacklevel=2)
 
789
            if init:
 
790
                # this is slower than before deprecation, oh well never mind.
 
791
                # -> its deprecated.
 
792
                self._initialize(transport.base)
 
793
        self._check_format(_format)
 
794
        if deprecated_passed(relax_version_check):
 
795
            warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
 
796
                 "relax_version_check parameter is deprecated as of bzr 0.8. "
 
797
                 "Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
 
798
                 "open() method.",
 
799
                 DeprecationWarning,
 
800
                 stacklevel=2)
 
801
            if (not relax_version_check
 
802
                and not self._format.is_supported()):
 
803
                raise errors.UnsupportedFormatError(
 
804
                        'sorry, branch format %r not supported' % fmt,
 
805
                        ['use a different bzr version',
 
806
                         'or remove the .bzr directory'
 
807
                         ' and "bzr init" again'])
 
808
        if deprecated_passed(transport):
 
809
            warn("BzrBranch.__init__(transport=XXX...): The transport "
 
810
                 "parameter is deprecated as of bzr 0.8. "
 
811
                 "Please use Branch.open, or bzrdir.open_branch().",
 
812
                 DeprecationWarning,
 
813
                 stacklevel=2)
1510
814
        self.repository = _repository
1511
 
        Branch.__init__(self)
1512
815
 
1513
816
    def __str__(self):
1514
817
        return '%s(%r)' % (self.__class__.__name__, self.base)
1515
818
 
1516
819
    __repr__ = __str__
1517
820
 
 
821
    def __del__(self):
 
822
        # TODO: It might be best to do this somewhere else,
 
823
        # but it is nice for a Branch object to automatically
 
824
        # cache it's information.
 
825
        # Alternatively, we could have the Transport objects cache requests
 
826
        # See the earlier discussion about how major objects (like Branch)
 
827
        # should never expect their __del__ function to run.
 
828
        # XXX: cache_root seems to be unused, 2006-01-13 mbp
 
829
        if hasattr(self, 'cache_root') and self.cache_root is not None:
 
830
            try:
 
831
                shutil.rmtree(self.cache_root)
 
832
            except:
 
833
                pass
 
834
            self.cache_root = None
 
835
 
1518
836
    def _get_base(self):
1519
 
        """Returns the directory containing the control directory."""
1520
837
        return self._base
1521
838
 
1522
839
    base = property(_get_base, doc="The URL for the root of this branch.")
1523
840
 
1524
 
    def is_locked(self):
1525
 
        return self.control_files.is_locked()
1526
 
 
1527
 
    def lock_write(self, token=None):
1528
 
        repo_token = self.repository.lock_write()
1529
 
        try:
1530
 
            token = self.control_files.lock_write(token=token)
1531
 
        except:
1532
 
            self.repository.unlock()
1533
 
            raise
1534
 
        return token
 
841
    def _finish_transaction(self):
 
842
        """Exit the current transaction."""
 
843
        return self.control_files._finish_transaction()
 
844
 
 
845
    def get_transaction(self):
 
846
        """Return the current active transaction.
 
847
 
 
848
        If no transaction is active, this returns a passthrough object
 
849
        for which all data is immediately flushed and no caching happens.
 
850
        """
 
851
        # this is an explicit function so that we can do tricky stuff
 
852
        # when the storage in rev_storage is elsewhere.
 
853
        # we probably need to hook the two 'lock a location' and 
 
854
        # 'have a transaction' together more delicately, so that
 
855
        # we can have two locks (branch and storage) and one transaction
 
856
        # ... and finishing the transaction unlocks both, but unlocking
 
857
        # does not. - RBC 20051121
 
858
        return self.control_files.get_transaction()
 
859
 
 
860
    def _set_transaction(self, transaction):
 
861
        """Set a new active transaction."""
 
862
        return self.control_files._set_transaction(transaction)
 
863
 
 
864
    def abspath(self, name):
 
865
        """See Branch.abspath."""
 
866
        return self.control_files._transport.abspath(name)
 
867
 
 
868
    def _check_format(self, format):
 
869
        """Identify the branch format if needed.
 
870
 
 
871
        The format is stored as a reference to the format object in
 
872
        self._format for code that needs to check it later.
 
873
 
 
874
        The format parameter is either None or the branch format class
 
875
        used to open this branch.
 
876
 
 
877
        FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
 
878
        """
 
879
        if format is None:
 
880
            format = BzrBranchFormat.find_format(self.bzrdir)
 
881
        self._format = format
 
882
        mutter("got branch format %s", self._format)
 
883
 
 
884
    @needs_read_lock
 
885
    def get_root_id(self):
 
886
        """See Branch.get_root_id."""
 
887
        tree = self.repository.revision_tree(self.last_revision())
 
888
        return tree.inventory.root.file_id
 
889
 
 
890
    def lock_write(self):
 
891
        # TODO: test for failed two phase locks. This is known broken.
 
892
        self.control_files.lock_write()
 
893
        self.repository.lock_write()
1535
894
 
1536
895
    def lock_read(self):
 
896
        # TODO: test for failed two phase locks. This is known broken.
 
897
        self.control_files.lock_read()
1537
898
        self.repository.lock_read()
1538
 
        try:
1539
 
            self.control_files.lock_read()
1540
 
        except:
1541
 
            self.repository.unlock()
1542
 
            raise
1543
899
 
1544
900
    def unlock(self):
1545
901
        # TODO: test for failed two phase locks. This is known broken.
1546
 
        try:
1547
 
            self.control_files.unlock()
1548
 
        finally:
1549
 
            self.repository.unlock()
1550
 
        if not self.control_files.is_locked():
1551
 
            # we just released the lock
1552
 
            self._clear_cached_state()
1553
 
        
 
902
        self.repository.unlock()
 
903
        self.control_files.unlock()
 
904
 
1554
905
    def peek_lock_mode(self):
1555
906
        if self.control_files._lock_count == 0:
1556
907
            return None
1557
908
        else:
1558
909
            return self.control_files._lock_mode
1559
910
 
1560
 
    def get_physical_lock_status(self):
1561
 
        return self.control_files.get_physical_lock_status()
1562
 
 
1563
911
    @needs_read_lock
1564
912
    def print_file(self, file, revision_id):
1565
913
        """See Branch.print_file."""
1566
914
        return self.repository.print_file(file, revision_id)
1567
915
 
1568
 
    def _write_revision_history(self, history):
1569
 
        """Factored out of set_revision_history.
1570
 
 
1571
 
        This performs the actual writing to disk.
1572
 
        It is intended to be called by BzrBranch5.set_revision_history."""
1573
 
        self._transport.put_bytes(
1574
 
            'revision-history', '\n'.join(history),
1575
 
            mode=self.bzrdir._get_file_mode())
 
916
    @needs_write_lock
 
917
    def append_revision(self, *revision_ids):
 
918
        """See Branch.append_revision."""
 
919
        for revision_id in revision_ids:
 
920
            mutter("add {%s} to revision-history" % revision_id)
 
921
        rev_history = self.revision_history()
 
922
        rev_history.extend(revision_ids)
 
923
        self.set_revision_history(rev_history)
1576
924
 
1577
925
    @needs_write_lock
1578
926
    def set_revision_history(self, rev_history):
1579
927
        """See Branch.set_revision_history."""
1580
 
        if 'evil' in debug.debug_flags:
1581
 
            mutter_callsite(3, "set_revision_history scales with history.")
1582
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
1583
 
        for rev_id in rev_history:
1584
 
            check_not_reserved_id(rev_id)
1585
 
        if Branch.hooks['post_change_branch_tip']:
1586
 
            # Don't calculate the last_revision_info() if there are no hooks
1587
 
            # that will use it.
1588
 
            old_revno, old_revid = self.last_revision_info()
1589
 
        if len(rev_history) == 0:
1590
 
            revid = _mod_revision.NULL_REVISION
1591
 
        else:
1592
 
            revid = rev_history[-1]
1593
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1594
 
        self._write_revision_history(rev_history)
1595
 
        self._clear_cached_state()
1596
 
        self._cache_revision_history(rev_history)
1597
 
        for hook in Branch.hooks['set_rh']:
1598
 
            hook(self, rev_history)
1599
 
        if Branch.hooks['post_change_branch_tip']:
1600
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1601
 
 
1602
 
    def _synchronize_history(self, destination, revision_id):
1603
 
        """Synchronize last revision and revision history between branches.
1604
 
 
1605
 
        This version is most efficient when the destination is also a
1606
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
1607
 
        history is the true lefthand parent history, and all of the revisions
1608
 
        are in the destination's repository.  If not, set_revision_history
1609
 
        will fail.
1610
 
 
1611
 
        :param destination: The branch to copy the history into
1612
 
        :param revision_id: The revision-id to truncate history at.  May
1613
 
          be None to copy complete history.
1614
 
        """
1615
 
        if revision_id == _mod_revision.NULL_REVISION:
1616
 
            new_history = []
1617
 
        else:
1618
 
            new_history = self.revision_history()
1619
 
        if revision_id is not None and new_history != []:
1620
 
            try:
1621
 
                new_history = new_history[:new_history.index(revision_id) + 1]
1622
 
            except ValueError:
1623
 
                rev = self.repository.get_revision(revision_id)
1624
 
                new_history = rev.get_history(self.repository)[1:]
1625
 
        destination.set_revision_history(new_history)
1626
 
 
1627
 
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1628
 
        """Run the pre_change_branch_tip hooks."""
1629
 
        hooks = Branch.hooks['pre_change_branch_tip']
1630
 
        if not hooks:
1631
 
            return
1632
 
        old_revno, old_revid = self.last_revision_info()
1633
 
        params = ChangeBranchTipParams(
1634
 
            self, old_revno, new_revno, old_revid, new_revid)
1635
 
        for hook in hooks:
1636
 
            try:
1637
 
                hook(params)
1638
 
            except errors.TipChangeRejected:
1639
 
                raise
1640
 
            except Exception:
1641
 
                exc_info = sys.exc_info()
1642
 
                hook_name = Branch.hooks.get_hook_name(hook)
1643
 
                raise errors.HookFailed(
1644
 
                    'pre_change_branch_tip', hook_name, exc_info)
1645
 
 
1646
 
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1647
 
        """Run the post_change_branch_tip hooks."""
1648
 
        hooks = Branch.hooks['post_change_branch_tip']
1649
 
        if not hooks:
1650
 
            return
1651
 
        new_revno, new_revid = self.last_revision_info()
1652
 
        params = ChangeBranchTipParams(
1653
 
            self, old_revno, new_revno, old_revid, new_revid)
1654
 
        for hook in hooks:
1655
 
            hook(params)
1656
 
 
1657
 
    @needs_write_lock
1658
 
    def set_last_revision_info(self, revno, revision_id):
1659
 
        """Set the last revision of this branch.
1660
 
 
1661
 
        The caller is responsible for checking that the revno is correct
1662
 
        for this revision id.
1663
 
 
1664
 
        It may be possible to set the branch last revision to an id not
1665
 
        present in the repository.  However, branches can also be 
1666
 
        configured to check constraints on history, in which case this may not
1667
 
        be permitted.
1668
 
        """
1669
 
        revision_id = _mod_revision.ensure_null(revision_id)
1670
 
        # this old format stores the full history, but this api doesn't
1671
 
        # provide it, so we must generate, and might as well check it's
1672
 
        # correct
1673
 
        history = self._lefthand_history(revision_id)
1674
 
        if len(history) != revno:
1675
 
            raise AssertionError('%d != %d' % (len(history), revno))
1676
 
        self.set_revision_history(history)
1677
 
 
1678
 
    def _gen_revision_history(self):
1679
 
        history = self._transport.get_bytes('revision-history').split('\n')
1680
 
        if history[-1:] == ['']:
1681
 
            # There shouldn't be a trailing newline, but just in case.
1682
 
            history.pop()
1683
 
        return history
1684
 
 
1685
 
    def _lefthand_history(self, revision_id, last_rev=None,
1686
 
                          other_branch=None):
1687
 
        if 'evil' in debug.debug_flags:
1688
 
            mutter_callsite(4, "_lefthand_history scales with history.")
1689
 
        # stop_revision must be a descendant of last_revision
1690
 
        graph = self.repository.get_graph()
1691
 
        if last_rev is not None:
1692
 
            if not graph.is_ancestor(last_rev, revision_id):
1693
 
                # our previous tip is not merged into stop_revision
1694
 
                raise errors.DivergedBranches(self, other_branch)
1695
 
        # make a new revision history from the graph
1696
 
        parents_map = graph.get_parent_map([revision_id])
1697
 
        if revision_id not in parents_map:
1698
 
            raise errors.NoSuchRevision(self, revision_id)
1699
 
        current_rev_id = revision_id
1700
 
        new_history = []
1701
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
1702
 
        # Do not include ghosts or graph origin in revision_history
1703
 
        while (current_rev_id in parents_map and
1704
 
               len(parents_map[current_rev_id]) > 0):
1705
 
            check_not_reserved_id(current_rev_id)
1706
 
            new_history.append(current_rev_id)
1707
 
            current_rev_id = parents_map[current_rev_id][0]
1708
 
            parents_map = graph.get_parent_map([current_rev_id])
1709
 
        new_history.reverse()
1710
 
        return new_history
1711
 
 
1712
 
    @needs_write_lock
1713
 
    def generate_revision_history(self, revision_id, last_rev=None,
1714
 
        other_branch=None):
1715
 
        """Create a new revision history that will finish with revision_id.
1716
 
 
1717
 
        :param revision_id: the new tip to use.
1718
 
        :param last_rev: The previous last_revision. If not None, then this
1719
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
1720
 
        :param other_branch: The other branch that DivergedBranches should
1721
 
            raise with respect to.
1722
 
        """
1723
 
        self.set_revision_history(self._lefthand_history(revision_id,
1724
 
            last_rev, other_branch))
1725
 
 
 
928
        self.control_files.put_utf8(
 
929
            'revision-history', '\n'.join(rev_history))
 
930
 
 
931
    def get_revision_delta(self, revno):
 
932
        """Return the delta for one revision.
 
933
 
 
934
        The delta is relative to its mainline predecessor, or the
 
935
        empty tree for revision 1.
 
936
        """
 
937
        assert isinstance(revno, int)
 
938
        rh = self.revision_history()
 
939
        if not (1 <= revno <= len(rh)):
 
940
            raise InvalidRevisionNumber(revno)
 
941
 
 
942
        # revno is 1-based; list is 0-based
 
943
 
 
944
        new_tree = self.repository.revision_tree(rh[revno-1])
 
945
        if revno == 1:
 
946
            old_tree = EmptyTree()
 
947
        else:
 
948
            old_tree = self.repository.revision_tree(rh[revno-2])
 
949
        return compare_trees(old_tree, new_tree)
 
950
 
 
951
    @needs_read_lock
 
952
    def revision_history(self):
 
953
        """See Branch.revision_history."""
 
954
        # FIXME are transactions bound to control files ? RBC 20051121
 
955
        transaction = self.get_transaction()
 
956
        history = transaction.map.find_revision_history()
 
957
        if history is not None:
 
958
            mutter("cache hit for revision-history in %s", self)
 
959
            return list(history)
 
960
        history = [l.rstrip('\r\n') for l in
 
961
                self.control_files.get_utf8('revision-history').readlines()]
 
962
        transaction.map.add_revision_history(history)
 
963
        # this call is disabled because revision_history is 
 
964
        # not really an object yet, and the transaction is for objects.
 
965
        # transaction.register_clean(history, precious=True)
 
966
        return list(history)
 
967
 
 
968
    def update_revisions(self, other, stop_revision=None):
 
969
        """See Branch.update_revisions."""
 
970
        if stop_revision is None:
 
971
            stop_revision = other.last_revision()
 
972
        ### Should this be checking is_ancestor instead of revision_history?
 
973
        if (stop_revision is not None and 
 
974
            stop_revision in self.revision_history()):
 
975
            return
 
976
        self.fetch(other, stop_revision)
 
977
        pullable_revs = self.pullable_revisions(other, stop_revision)
 
978
        if len(pullable_revs) > 0:
 
979
            self.append_revision(*pullable_revs)
 
980
 
 
981
    def pullable_revisions(self, other, stop_revision):
 
982
        """See Branch.pullable_revisions."""
 
983
        other_revno = other.revision_id_to_revno(stop_revision)
 
984
        try:
 
985
            return self.missing_revisions(other, other_revno)
 
986
        except DivergedBranches, e:
 
987
            try:
 
988
                pullable_revs = get_intervening_revisions(self.last_revision(),
 
989
                                                          stop_revision, 
 
990
                                                          self.repository)
 
991
                assert self.last_revision() not in pullable_revs
 
992
                return pullable_revs
 
993
            except bzrlib.errors.NotAncestor:
 
994
                if is_ancestor(self.last_revision(), stop_revision, self):
 
995
                    return []
 
996
                else:
 
997
                    raise e
 
998
        
1726
999
    def basis_tree(self):
1727
1000
        """See Branch.basis_tree."""
1728
1001
        return self.repository.revision_tree(self.last_revision())
1729
1002
 
 
1003
    @deprecated_method(zero_eight)
 
1004
    def working_tree(self):
 
1005
        """Create a Working tree object for this branch."""
 
1006
        from bzrlib.workingtree import WorkingTree
 
1007
        from bzrlib.transport.local import LocalTransport
 
1008
        if (self.base.find('://') != -1 or 
 
1009
            not isinstance(self._transport, LocalTransport)):
 
1010
            raise NoWorkingTree(self.base)
 
1011
        return self.bzrdir.open_workingtree()
 
1012
 
1730
1013
    @needs_write_lock
1731
 
    def pull(self, source, overwrite=False, stop_revision=None,
1732
 
             _hook_master=None, run_hooks=True, possible_transports=None,
1733
 
             _override_hook_target=None):
1734
 
        """See Branch.pull.
1735
 
 
1736
 
        :param _hook_master: Private parameter - set the branch to 
1737
 
            be supplied as the master to pull hooks.
1738
 
        :param run_hooks: Private parameter - if false, this branch
1739
 
            is being called because it's the master of the primary branch,
1740
 
            so it should not run its hooks.
1741
 
        :param _override_hook_target: Private parameter - set the branch to be
1742
 
            supplied as the target_branch to pull hooks.
1743
 
        """
1744
 
        result = PullResult()
1745
 
        result.source_branch = source
1746
 
        if _override_hook_target is None:
1747
 
            result.target_branch = self
1748
 
        else:
1749
 
            result.target_branch = _override_hook_target
 
1014
    def pull(self, source, overwrite=False, stop_revision=None):
 
1015
        """See Branch.pull."""
1750
1016
        source.lock_read()
1751
1017
        try:
1752
 
            # We assume that during 'pull' the local repository is closer than
1753
 
            # the remote one.
1754
 
            graph = self.repository.get_graph(source.repository)
1755
 
            result.old_revno, result.old_revid = self.last_revision_info()
1756
 
            self.update_revisions(source, stop_revision, overwrite=overwrite,
1757
 
                                  graph=graph)
1758
 
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1759
 
            result.new_revno, result.new_revid = self.last_revision_info()
1760
 
            if _hook_master:
1761
 
                result.master_branch = _hook_master
1762
 
                result.local_branch = result.target_branch
1763
 
            else:
1764
 
                result.master_branch = result.target_branch
1765
 
                result.local_branch = None
1766
 
            if run_hooks:
1767
 
                for hook in Branch.hooks['post_pull']:
1768
 
                    hook(result)
 
1018
            old_count = len(self.revision_history())
 
1019
            try:
 
1020
                self.update_revisions(source,stop_revision)
 
1021
            except DivergedBranches:
 
1022
                if not overwrite:
 
1023
                    raise
 
1024
            if overwrite:
 
1025
                self.set_revision_history(source.revision_history())
 
1026
            new_count = len(self.revision_history())
 
1027
            return new_count - old_count
1769
1028
        finally:
1770
1029
            source.unlock()
1771
 
        return result
1772
1030
 
1773
 
    def _get_parent_location(self):
 
1031
    def get_parent(self):
 
1032
        """See Branch.get_parent."""
 
1033
        import errno
1774
1034
        _locs = ['parent', 'pull', 'x-pull']
1775
1035
        for l in _locs:
1776
1036
            try:
1777
 
                return self._transport.get_bytes(l).strip('\n')
1778
 
            except errors.NoSuchFile:
 
1037
                return self.control_files.get_utf8(l).read().strip('\n')
 
1038
            except NoSuchFile:
1779
1039
                pass
1780
1040
        return None
1781
1041
 
1782
 
    @needs_read_lock
1783
 
    def push(self, target, overwrite=False, stop_revision=None,
1784
 
             _override_hook_source_branch=None):
1785
 
        """See Branch.push.
1786
 
 
1787
 
        This is the basic concrete implementation of push()
1788
 
 
1789
 
        :param _override_hook_source_branch: If specified, run
1790
 
        the hooks passing this Branch as the source, rather than self.  
1791
 
        This is for use of RemoteBranch, where push is delegated to the
1792
 
        underlying vfs-based Branch. 
1793
 
        """
1794
 
        # TODO: Public option to disable running hooks - should be trivial but
1795
 
        # needs tests.
1796
 
        return _run_with_write_locked_target(
1797
 
            target, self._push_with_bound_branches, target, overwrite,
1798
 
            stop_revision,
1799
 
            _override_hook_source_branch=_override_hook_source_branch)
1800
 
 
1801
 
    def _push_with_bound_branches(self, target, overwrite,
1802
 
            stop_revision,
1803
 
            _override_hook_source_branch=None):
1804
 
        """Push from self into target, and into target's master if any.
1805
 
        
1806
 
        This is on the base BzrBranch class even though it doesn't support 
1807
 
        bound branches because the *target* might be bound.
1808
 
        """
1809
 
        def _run_hooks():
1810
 
            if _override_hook_source_branch:
1811
 
                result.source_branch = _override_hook_source_branch
1812
 
            for hook in Branch.hooks['post_push']:
1813
 
                hook(result)
1814
 
 
1815
 
        bound_location = target.get_bound_location()
1816
 
        if bound_location and target.base != bound_location:
1817
 
            # there is a master branch.
1818
 
            #
1819
 
            # XXX: Why the second check?  Is it even supported for a branch to
1820
 
            # be bound to itself? -- mbp 20070507
1821
 
            master_branch = target.get_master_branch()
1822
 
            master_branch.lock_write()
1823
 
            try:
1824
 
                # push into the master from this branch.
1825
 
                self._basic_push(master_branch, overwrite, stop_revision)
1826
 
                # and push into the target branch from this. Note that we push from
1827
 
                # this branch again, because its considered the highest bandwidth
1828
 
                # repository.
1829
 
                result = self._basic_push(target, overwrite, stop_revision)
1830
 
                result.master_branch = master_branch
1831
 
                result.local_branch = target
1832
 
                _run_hooks()
1833
 
                return result
1834
 
            finally:
1835
 
                master_branch.unlock()
1836
 
        else:
1837
 
            # no master branch
1838
 
            result = self._basic_push(target, overwrite, stop_revision)
1839
 
            # TODO: Why set master_branch and local_branch if there's no
1840
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
1841
 
            # 20070504
1842
 
            result.master_branch = target
1843
 
            result.local_branch = None
1844
 
            _run_hooks()
1845
 
            return result
1846
 
 
1847
 
    def _basic_push(self, target, overwrite, stop_revision):
1848
 
        """Basic implementation of push without bound branches or hooks.
1849
 
 
1850
 
        Must be called with self read locked and target write locked.
1851
 
        """
1852
 
        result = PushResult()
1853
 
        result.source_branch = self
1854
 
        result.target_branch = target
1855
 
        result.old_revno, result.old_revid = target.last_revision_info()
1856
 
        if result.old_revid != self.last_revision():
1857
 
            # We assume that during 'push' this repository is closer than
1858
 
            # the target.
1859
 
            graph = self.repository.get_graph(target.repository)
1860
 
            target.update_revisions(self, stop_revision, overwrite=overwrite,
1861
 
                                    graph=graph)
1862
 
        if self._push_should_merge_tags():
1863
 
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1864
 
        result.new_revno, result.new_revid = target.last_revision_info()
1865
 
        return result
1866
 
 
1867
 
    def _push_should_merge_tags(self):
1868
 
        """Should _basic_push merge this branch's tags into the target?
1869
 
        
1870
 
        The default implementation returns False if this branch has no tags,
1871
 
        and True the rest of the time.  Subclasses may override this.
1872
 
        """
1873
 
        return self.tags.supports_tags() and self.tags.get_tag_dict()
1874
 
 
1875
 
    def get_parent(self):
1876
 
        """See Branch.get_parent."""
1877
 
        parent = self._get_parent_location()
1878
 
        if parent is None:
1879
 
            return parent
1880
 
        # This is an old-format absolute path to a local branch
1881
 
        # turn it into a url
1882
 
        if parent.startswith('/'):
1883
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1884
 
        try:
1885
 
            return urlutils.join(self.base[:-1], parent)
1886
 
        except errors.InvalidURLJoin, e:
1887
 
            raise errors.InaccessibleParent(parent, self.base)
1888
 
 
1889
 
    def get_stacked_on_url(self):
1890
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
1042
    def get_push_location(self):
 
1043
        """See Branch.get_push_location."""
 
1044
        config = bzrlib.config.BranchConfig(self)
 
1045
        push_loc = config.get_user_option('push_location')
 
1046
        return push_loc
1891
1047
 
1892
1048
    def set_push_location(self, location):
1893
1049
        """See Branch.set_push_location."""
1894
 
        self.get_config().set_user_option(
1895
 
            'push_location', location,
1896
 
            store=_mod_config.STORE_LOCATION_NORECURSE)
 
1050
        config = bzrlib.config.LocationConfig(self.base)
 
1051
        config.set_user_option('push_location', location)
1897
1052
 
1898
1053
    @needs_write_lock
1899
1054
    def set_parent(self, url):
1901
1056
        # TODO: Maybe delete old location files?
1902
1057
        # URLs should never be unicode, even on the local fs,
1903
1058
        # FIXUP this and get_parent in a future branch format bump:
1904
 
        # read and rewrite the file. RBC 20060125
1905
 
        if url is not None:
1906
 
            if isinstance(url, unicode):
1907
 
                try:
1908
 
                    url = url.encode('ascii')
1909
 
                except UnicodeEncodeError:
1910
 
                    raise errors.InvalidURL(url,
1911
 
                        "Urls must be 7-bit ascii, "
1912
 
                        "use bzrlib.urlutils.escape")
1913
 
            url = urlutils.relative_url(self.base, url)
1914
 
        self._set_parent_location(url)
1915
 
 
1916
 
    def _set_parent_location(self, url):
1917
 
        if url is None:
1918
 
            self._transport.delete('parent')
1919
 
        else:
1920
 
            self._transport.put_bytes('parent', url + '\n',
1921
 
                mode=self.bzrdir._get_file_mode())
1922
 
 
1923
 
    def set_stacked_on_url(self, url):
1924
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
1925
 
 
1926
 
 
1927
 
class BzrBranch5(BzrBranch):
1928
 
    """A format 5 branch. This supports new features over plain branches.
1929
 
 
1930
 
    It has support for a master_branch which is the data for bound branches.
1931
 
    """
1932
 
 
1933
 
    @needs_write_lock
1934
 
    def pull(self, source, overwrite=False, stop_revision=None,
1935
 
             run_hooks=True, possible_transports=None,
1936
 
             _override_hook_target=None):
1937
 
        """Pull from source into self, updating my master if any.
1938
 
        
1939
 
        :param run_hooks: Private parameter - if false, this branch
1940
 
            is being called because it's the master of the primary branch,
1941
 
            so it should not run its hooks.
1942
 
        """
1943
 
        bound_location = self.get_bound_location()
1944
 
        master_branch = None
1945
 
        if bound_location and source.base != bound_location:
1946
 
            # not pulling from master, so we need to update master.
1947
 
            master_branch = self.get_master_branch(possible_transports)
1948
 
            master_branch.lock_write()
1949
 
        try:
1950
 
            if master_branch:
1951
 
                # pull from source into master.
1952
 
                master_branch.pull(source, overwrite, stop_revision,
1953
 
                    run_hooks=False)
1954
 
            return super(BzrBranch5, self).pull(source, overwrite,
1955
 
                stop_revision, _hook_master=master_branch,
1956
 
                run_hooks=run_hooks,
1957
 
                _override_hook_target=_override_hook_target)
1958
 
        finally:
1959
 
            if master_branch:
1960
 
                master_branch.unlock()
1961
 
 
1962
 
    def get_bound_location(self):
1963
 
        try:
1964
 
            return self._transport.get_bytes('bound')[:-1]
1965
 
        except errors.NoSuchFile:
1966
 
            return None
1967
 
 
1968
 
    @needs_read_lock
1969
 
    def get_master_branch(self, possible_transports=None):
1970
 
        """Return the branch we are bound to.
1971
 
        
1972
 
        :return: Either a Branch, or None
1973
 
 
1974
 
        This could memoise the branch, but if thats done
1975
 
        it must be revalidated on each new lock.
1976
 
        So for now we just don't memoise it.
1977
 
        # RBC 20060304 review this decision.
1978
 
        """
1979
 
        bound_loc = self.get_bound_location()
1980
 
        if not bound_loc:
1981
 
            return None
1982
 
        try:
1983
 
            return Branch.open(bound_loc,
1984
 
                               possible_transports=possible_transports)
1985
 
        except (errors.NotBranchError, errors.ConnectionError), e:
1986
 
            raise errors.BoundBranchConnectionFailure(
1987
 
                    self, bound_loc, e)
1988
 
 
1989
 
    @needs_write_lock
1990
 
    def set_bound_location(self, location):
1991
 
        """Set the target where this branch is bound to.
1992
 
 
1993
 
        :param location: URL to the target branch
1994
 
        """
1995
 
        if location:
1996
 
            self._transport.put_bytes('bound', location+'\n',
1997
 
                mode=self.bzrdir._get_file_mode())
1998
 
        else:
1999
 
            try:
2000
 
                self._transport.delete('bound')
2001
 
            except errors.NoSuchFile:
2002
 
                return False
2003
 
            return True
2004
 
 
2005
 
    @needs_write_lock
2006
 
    def bind(self, other):
2007
 
        """Bind this branch to the branch other.
2008
 
 
2009
 
        This does not push or pull data between the branches, though it does
2010
 
        check for divergence to raise an error when the branches are not
2011
 
        either the same, or one a prefix of the other. That behaviour may not
2012
 
        be useful, so that check may be removed in future.
2013
 
        
2014
 
        :param other: The branch to bind to
2015
 
        :type other: Branch
2016
 
        """
2017
 
        # TODO: jam 20051230 Consider checking if the target is bound
2018
 
        #       It is debatable whether you should be able to bind to
2019
 
        #       a branch which is itself bound.
2020
 
        #       Committing is obviously forbidden,
2021
 
        #       but binding itself may not be.
2022
 
        #       Since we *have* to check at commit time, we don't
2023
 
        #       *need* to check here
2024
 
 
2025
 
        # we want to raise diverged if:
2026
 
        # last_rev is not in the other_last_rev history, AND
2027
 
        # other_last_rev is not in our history, and do it without pulling
2028
 
        # history around
2029
 
        self.set_bound_location(other.base)
2030
 
 
2031
 
    @needs_write_lock
2032
 
    def unbind(self):
2033
 
        """If bound, unbind"""
2034
 
        return self.set_bound_location(None)
2035
 
 
2036
 
    @needs_write_lock
2037
 
    def update(self, possible_transports=None):
2038
 
        """Synchronise this branch with the master branch if any. 
2039
 
 
2040
 
        :return: None or the last_revision that was pivoted out during the
2041
 
                 update.
2042
 
        """
2043
 
        master = self.get_master_branch(possible_transports)
2044
 
        if master is not None:
2045
 
            old_tip = _mod_revision.ensure_null(self.last_revision())
2046
 
            self.pull(master, overwrite=True)
2047
 
            if self.repository.get_graph().is_ancestor(old_tip,
2048
 
                _mod_revision.ensure_null(self.last_revision())):
2049
 
                return None
2050
 
            return old_tip
2051
 
        return None
2052
 
 
2053
 
 
2054
 
class BzrBranch7(BzrBranch5):
2055
 
    """A branch with support for a fallback repository."""
2056
 
 
2057
 
    def _get_fallback_repository(self, url):
2058
 
        """Get the repository we fallback to at url."""
2059
 
        url = urlutils.join(self.base, url)
2060
 
        return bzrdir.BzrDir.open(url).open_branch().repository
2061
 
 
2062
 
    def _activate_fallback_location(self, url):
2063
 
        """Activate the branch/repository from url as a fallback repository."""
2064
 
        self.repository.add_fallback_repository(
2065
 
            self._get_fallback_repository(url))
2066
 
 
2067
 
    def _open_hook(self):
2068
 
        try:
2069
 
            url = self.get_stacked_on_url()
2070
 
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2071
 
            errors.UnstackableBranchFormat):
2072
 
            pass
2073
 
        else:
2074
 
            for hook in Branch.hooks['transform_fallback_location']:
2075
 
                url = hook(self, url)
2076
 
                if url is None:
2077
 
                    hook_name = Branch.hooks.get_hook_name(hook)
2078
 
                    raise AssertionError(
2079
 
                        "'transform_fallback_location' hook %s returned "
2080
 
                        "None, not a URL." % hook_name)
2081
 
            self._activate_fallback_location(url)
2082
 
 
2083
 
    def _check_stackable_repo(self):
2084
 
        if not self.repository._format.supports_external_lookups:
2085
 
            raise errors.UnstackableRepositoryFormat(self.repository._format,
2086
 
                self.repository.base)
2087
 
 
2088
 
    def __init__(self, *args, **kwargs):
2089
 
        super(BzrBranch7, self).__init__(*args, **kwargs)
2090
 
        self._last_revision_info_cache = None
2091
 
        self._partial_revision_history_cache = []
2092
 
 
2093
 
    def _clear_cached_state(self):
2094
 
        super(BzrBranch7, self)._clear_cached_state()
2095
 
        self._last_revision_info_cache = None
2096
 
        self._partial_revision_history_cache = []
2097
 
 
2098
 
    def _last_revision_info(self):
2099
 
        revision_string = self._transport.get_bytes('last-revision')
2100
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2101
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2102
 
        revno = int(revno)
2103
 
        return revno, revision_id
2104
 
 
2105
 
    def _write_last_revision_info(self, revno, revision_id):
2106
 
        """Simply write out the revision id, with no checks.
2107
 
 
2108
 
        Use set_last_revision_info to perform this safely.
2109
 
 
2110
 
        Does not update the revision_history cache.
2111
 
        Intended to be called by set_last_revision_info and
2112
 
        _write_revision_history.
2113
 
        """
2114
 
        revision_id = _mod_revision.ensure_null(revision_id)
2115
 
        out_string = '%d %s\n' % (revno, revision_id)
2116
 
        self._transport.put_bytes('last-revision', out_string,
2117
 
            mode=self.bzrdir._get_file_mode())
2118
 
 
2119
 
    @needs_write_lock
2120
 
    def set_last_revision_info(self, revno, revision_id):
2121
 
        revision_id = _mod_revision.ensure_null(revision_id)
2122
 
        old_revno, old_revid = self.last_revision_info()
2123
 
        if self._get_append_revisions_only():
2124
 
            self._check_history_violation(revision_id)
2125
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2126
 
        self._write_last_revision_info(revno, revision_id)
2127
 
        self._clear_cached_state()
2128
 
        self._last_revision_info_cache = revno, revision_id
2129
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2130
 
 
2131
 
    def _synchronize_history(self, destination, revision_id):
2132
 
        """Synchronize last revision and revision history between branches.
2133
 
        
2134
 
        :see: Branch._synchronize_history
2135
 
        """
2136
 
        # XXX: The base Branch has a fast implementation of this method based
2137
 
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2138
 
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2139
 
        # but wants the fast implementation, so it calls
2140
 
        # Branch._synchronize_history directly.
2141
 
        Branch._synchronize_history(self, destination, revision_id)
2142
 
 
2143
 
    def _check_history_violation(self, revision_id):
2144
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
2145
 
        if _mod_revision.is_null(last_revision):
2146
 
            return
2147
 
        if last_revision not in self._lefthand_history(revision_id):
2148
 
            raise errors.AppendRevisionsOnlyViolation(self.base)
2149
 
 
2150
 
    def _gen_revision_history(self):
2151
 
        """Generate the revision history from last revision
2152
 
        """
2153
 
        last_revno, last_revision = self.last_revision_info()
2154
 
        self._extend_partial_history(stop_index=last_revno-1)
2155
 
        return list(reversed(self._partial_revision_history_cache))
2156
 
 
2157
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
2158
 
        """Extend the partial history to include a given index
2159
 
 
2160
 
        If a stop_index is supplied, stop when that index has been reached.
2161
 
        If a stop_revision is supplied, stop when that revision is
2162
 
        encountered.  Otherwise, stop when the beginning of history is
2163
 
        reached.
2164
 
 
2165
 
        :param stop_index: The index which should be present.  When it is
2166
 
            present, history extension will stop.
2167
 
        :param revision_id: The revision id which should be present.  When
2168
 
            it is encountered, history extension will stop.
2169
 
        """
2170
 
        repo = self.repository
2171
 
        if len(self._partial_revision_history_cache) == 0:
2172
 
            iterator = repo.iter_reverse_revision_history(self.last_revision())
2173
 
        else:
2174
 
            start_revision = self._partial_revision_history_cache[-1]
2175
 
            iterator = repo.iter_reverse_revision_history(start_revision)
2176
 
            #skip the last revision in the list
2177
 
            next_revision = iterator.next()
2178
 
        for revision_id in iterator:
2179
 
            self._partial_revision_history_cache.append(revision_id)
2180
 
            if (stop_index is not None and
2181
 
                len(self._partial_revision_history_cache) > stop_index):
2182
 
                break
2183
 
            if revision_id == stop_revision:
2184
 
                break
2185
 
 
2186
 
    def _write_revision_history(self, history):
2187
 
        """Factored out of set_revision_history.
2188
 
 
2189
 
        This performs the actual writing to disk, with format-specific checks.
2190
 
        It is intended to be called by BzrBranch5.set_revision_history.
2191
 
        """
2192
 
        if len(history) == 0:
2193
 
            last_revision = 'null:'
2194
 
        else:
2195
 
            if history != self._lefthand_history(history[-1]):
2196
 
                raise errors.NotLefthandHistory(history)
2197
 
            last_revision = history[-1]
2198
 
        if self._get_append_revisions_only():
2199
 
            self._check_history_violation(last_revision)
2200
 
        self._write_last_revision_info(len(history), last_revision)
2201
 
 
2202
 
    @needs_write_lock
2203
 
    def _set_parent_location(self, url):
2204
 
        """Set the parent branch"""
2205
 
        self._set_config_location('parent_location', url, make_relative=True)
2206
 
 
2207
 
    @needs_read_lock
2208
 
    def _get_parent_location(self):
2209
 
        """Set the parent branch"""
2210
 
        return self._get_config_location('parent_location')
2211
 
 
2212
 
    def set_push_location(self, location):
2213
 
        """See Branch.set_push_location."""
2214
 
        self._set_config_location('push_location', location)
2215
 
 
2216
 
    def set_bound_location(self, location):
2217
 
        """See Branch.set_push_location."""
2218
 
        result = None
2219
 
        config = self.get_config()
2220
 
        if location is None:
2221
 
            if config.get_user_option('bound') != 'True':
2222
 
                return False
2223
 
            else:
2224
 
                config.set_user_option('bound', 'False', warn_masked=True)
2225
 
                return True
2226
 
        else:
2227
 
            self._set_config_location('bound_location', location,
2228
 
                                      config=config)
2229
 
            config.set_user_option('bound', 'True', warn_masked=True)
2230
 
        return True
2231
 
 
2232
 
    def _get_bound_location(self, bound):
2233
 
        """Return the bound location in the config file.
2234
 
 
2235
 
        Return None if the bound parameter does not match"""
2236
 
        config = self.get_config()
2237
 
        config_bound = (config.get_user_option('bound') == 'True')
2238
 
        if config_bound != bound:
2239
 
            return None
2240
 
        return self._get_config_location('bound_location', config=config)
2241
 
 
2242
 
    def get_bound_location(self):
2243
 
        """See Branch.set_push_location."""
2244
 
        return self._get_bound_location(True)
2245
 
 
2246
 
    def get_old_bound_location(self):
2247
 
        """See Branch.get_old_bound_location"""
2248
 
        return self._get_bound_location(False)
2249
 
 
2250
 
    def get_stacked_on_url(self):
2251
 
        # you can always ask for the URL; but you might not be able to use it
2252
 
        # if the repo can't support stacking.
2253
 
        ## self._check_stackable_repo()
2254
 
        stacked_url = self._get_config_location('stacked_on_location')
2255
 
        if stacked_url is None:
2256
 
            raise errors.NotStacked(self)
2257
 
        return stacked_url
2258
 
 
2259
 
    def set_append_revisions_only(self, enabled):
2260
 
        if enabled:
2261
 
            value = 'True'
2262
 
        else:
2263
 
            value = 'False'
2264
 
        self.get_config().set_user_option('append_revisions_only', value,
2265
 
            warn_masked=True)
2266
 
 
2267
 
    def set_stacked_on_url(self, url):
2268
 
        self._check_stackable_repo()
2269
 
        if not url:
2270
 
            try:
2271
 
                old_url = self.get_stacked_on_url()
2272
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
2273
 
                errors.UnstackableRepositoryFormat):
2274
 
                return
2275
 
            url = ''
2276
 
            # repositories don't offer an interface to remove fallback
2277
 
            # repositories today; take the conceptually simpler option and just
2278
 
            # reopen it.
2279
 
            self.repository = self.bzrdir.find_repository()
2280
 
            # for every revision reference the branch has, ensure it is pulled
2281
 
            # in.
2282
 
            source_repository = self._get_fallback_repository(old_url)
2283
 
            for revision_id in chain([self.last_revision()],
2284
 
                self.tags.get_reverse_tag_dict()):
2285
 
                self.repository.fetch(source_repository, revision_id,
2286
 
                    find_ghosts=True)
2287
 
        else:
2288
 
            self._activate_fallback_location(url)
2289
 
        # write this out after the repository is stacked to avoid setting a
2290
 
        # stacked config that doesn't work.
2291
 
        self._set_config_location('stacked_on_location', url)
2292
 
 
2293
 
    def _get_append_revisions_only(self):
2294
 
        value = self.get_config().get_user_option('append_revisions_only')
2295
 
        return value == 'True'
2296
 
 
2297
 
    def _make_tags(self):
2298
 
        return BasicTags(self)
2299
 
 
2300
 
    @needs_write_lock
2301
 
    def generate_revision_history(self, revision_id, last_rev=None,
2302
 
                                  other_branch=None):
2303
 
        """See BzrBranch5.generate_revision_history"""
2304
 
        history = self._lefthand_history(revision_id, last_rev, other_branch)
2305
 
        revno = len(history)
2306
 
        self.set_last_revision_info(revno, revision_id)
2307
 
 
2308
 
    @needs_read_lock
2309
 
    def get_rev_id(self, revno, history=None):
2310
 
        """Find the revision id of the specified revno."""
2311
 
        if revno == 0:
2312
 
            return _mod_revision.NULL_REVISION
2313
 
 
2314
 
        last_revno, last_revision_id = self.last_revision_info()
2315
 
        if revno <= 0 or revno > last_revno:
2316
 
            raise errors.NoSuchRevision(self, revno)
2317
 
 
2318
 
        if history is not None:
2319
 
            return history[revno - 1]
2320
 
 
2321
 
        index = last_revno - revno
2322
 
        if len(self._partial_revision_history_cache) <= index:
2323
 
            self._extend_partial_history(stop_index=index)
2324
 
        if len(self._partial_revision_history_cache) > index:
2325
 
            return self._partial_revision_history_cache[index]
2326
 
        else:
2327
 
            raise errors.NoSuchRevision(self, revno)
2328
 
 
2329
 
    @needs_read_lock
2330
 
    def revision_id_to_revno(self, revision_id):
2331
 
        """Given a revision id, return its revno"""
2332
 
        if _mod_revision.is_null(revision_id):
2333
 
            return 0
2334
 
        try:
2335
 
            index = self._partial_revision_history_cache.index(revision_id)
 
1059
        # read and rewrite the file, and have the new format code read
 
1060
        # using .get not .get_utf8. RBC 20060125
 
1061
        self.control_files.put_utf8('parent', url + '\n')
 
1062
 
 
1063
    def tree_config(self):
 
1064
        return TreeConfig(self)
 
1065
 
 
1066
    def _get_truncated_history(self, revision_id):
 
1067
        history = self.revision_history()
 
1068
        if revision_id is None:
 
1069
            return history
 
1070
        try:
 
1071
            idx = history.index(revision_id)
2336
1072
        except ValueError:
2337
 
            self._extend_partial_history(stop_revision=revision_id)
2338
 
            index = len(self._partial_revision_history_cache) - 1
2339
 
            if self._partial_revision_history_cache[index] != revision_id:
2340
 
                raise errors.NoSuchRevision(self, revision_id)
2341
 
        return self.revno() - index
2342
 
 
2343
 
 
2344
 
class BzrBranch6(BzrBranch7):
2345
 
    """See BzrBranchFormat6 for the capabilities of this branch.
2346
 
 
2347
 
    This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2348
 
    i.e. stacking.
2349
 
    """
2350
 
 
2351
 
    def get_stacked_on_url(self):
2352
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
2353
 
 
2354
 
    def set_stacked_on_url(self, url):
2355
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
2356
 
 
2357
 
 
2358
 
######################################################################
2359
 
# results of operations
2360
 
 
2361
 
 
2362
 
class _Result(object):
2363
 
 
2364
 
    def _show_tag_conficts(self, to_file):
2365
 
        if not getattr(self, 'tag_conflicts', None):
2366
 
            return
2367
 
        to_file.write('Conflicting tags:\n')
2368
 
        for name, value1, value2 in self.tag_conflicts:
2369
 
            to_file.write('    %s\n' % (name, ))
2370
 
 
2371
 
 
2372
 
class PullResult(_Result):
2373
 
    """Result of a Branch.pull operation.
2374
 
 
2375
 
    :ivar old_revno: Revision number before pull.
2376
 
    :ivar new_revno: Revision number after pull.
2377
 
    :ivar old_revid: Tip revision id before pull.
2378
 
    :ivar new_revid: Tip revision id after pull.
2379
 
    :ivar source_branch: Source (local) branch object.
2380
 
    :ivar master_branch: Master branch of the target, or the target if no
2381
 
        Master
2382
 
    :ivar local_branch: target branch if there is a Master, else None
2383
 
    :ivar target_branch: Target/destination branch object.
2384
 
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2385
 
    """
2386
 
 
2387
 
    def __int__(self):
2388
 
        # DEPRECATED: pull used to return the change in revno
2389
 
        return self.new_revno - self.old_revno
2390
 
 
2391
 
    def report(self, to_file):
2392
 
        if not is_quiet():
2393
 
            if self.old_revid == self.new_revid:
2394
 
                to_file.write('No revisions to pull.\n')
2395
 
            else:
2396
 
                to_file.write('Now on revision %d.\n' % self.new_revno)
2397
 
        self._show_tag_conficts(to_file)
2398
 
 
2399
 
 
2400
 
class PushResult(_Result):
2401
 
    """Result of a Branch.push operation.
2402
 
 
2403
 
    :ivar old_revno: Revision number before push.
2404
 
    :ivar new_revno: Revision number after push.
2405
 
    :ivar old_revid: Tip revision id before push.
2406
 
    :ivar new_revid: Tip revision id after push.
2407
 
    :ivar source_branch: Source branch object.
2408
 
    :ivar master_branch: Master branch of the target, or None.
2409
 
    :ivar target_branch: Target/destination branch object.
2410
 
    """
2411
 
 
2412
 
    def __int__(self):
2413
 
        # DEPRECATED: push used to return the change in revno
2414
 
        return self.new_revno - self.old_revno
2415
 
 
2416
 
    def report(self, to_file):
2417
 
        """Write a human-readable description of the result."""
2418
 
        if self.old_revid == self.new_revid:
2419
 
            to_file.write('No new revisions to push.\n')
2420
 
        else:
2421
 
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2422
 
        self._show_tag_conficts(to_file)
2423
 
 
2424
 
 
2425
 
class BranchCheckResult(object):
2426
 
    """Results of checking branch consistency.
2427
 
 
2428
 
    :see: Branch.check
2429
 
    """
2430
 
 
2431
 
    def __init__(self, branch):
2432
 
        self.branch = branch
2433
 
 
2434
 
    def report_results(self, verbose):
2435
 
        """Report the check results via trace.note.
2436
 
        
2437
 
        :param verbose: Requests more detailed display of what was checked,
2438
 
            if any.
2439
 
        """
2440
 
        note('checked branch %s format %s',
2441
 
             self.branch.base,
2442
 
             self.branch._format)
2443
 
 
2444
 
 
2445
 
class Converter5to6(object):
2446
 
    """Perform an in-place upgrade of format 5 to format 6"""
2447
 
 
2448
 
    def convert(self, branch):
2449
 
        # Data for 5 and 6 can peacefully coexist.
2450
 
        format = BzrBranchFormat6()
2451
 
        new_branch = format.open(branch.bzrdir, _found=True)
2452
 
 
2453
 
        # Copy source data into target
2454
 
        new_branch._write_last_revision_info(*branch.last_revision_info())
2455
 
        new_branch.set_parent(branch.get_parent())
2456
 
        new_branch.set_bound_location(branch.get_bound_location())
2457
 
        new_branch.set_push_location(branch.get_push_location())
2458
 
 
2459
 
        # New branch has no tags by default
2460
 
        new_branch.tags._set_tag_dict({})
2461
 
 
2462
 
        # Copying done; now update target format
2463
 
        new_branch._transport.put_bytes('format',
2464
 
            format.get_format_string(),
2465
 
            mode=new_branch.bzrdir._get_file_mode())
2466
 
 
2467
 
        # Clean up old files
2468
 
        new_branch._transport.delete('revision-history')
2469
 
        try:
2470
 
            branch.set_parent(None)
2471
 
        except errors.NoSuchFile:
2472
 
            pass
2473
 
        branch.set_bound_location(None)
2474
 
 
2475
 
 
2476
 
class Converter6to7(object):
2477
 
    """Perform an in-place upgrade of format 6 to format 7"""
2478
 
 
2479
 
    def convert(self, branch):
2480
 
        format = BzrBranchFormat7()
2481
 
        branch._set_config_location('stacked_on_location', '')
2482
 
        # update target format
2483
 
        branch._transport.put_bytes('format', format.get_format_string())
2484
 
 
2485
 
 
2486
 
 
2487
 
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2488
 
    """Run ``callable(*args, **kwargs)``, write-locking target for the
2489
 
    duration.
2490
 
 
2491
 
    _run_with_write_locked_target will attempt to release the lock it acquires.
2492
 
 
2493
 
    If an exception is raised by callable, then that exception *will* be
2494
 
    propagated, even if the unlock attempt raises its own error.  Thus
2495
 
    _run_with_write_locked_target should be preferred to simply doing::
2496
 
 
2497
 
        target.lock_write()
2498
 
        try:
2499
 
            return callable(*args, **kwargs)
2500
 
        finally:
2501
 
            target.unlock()
 
1073
            raise InvalidRevisionId(revision_id=revision, branch=self)
 
1074
        return history[:idx+1]
 
1075
 
 
1076
    @needs_read_lock
 
1077
    def _clone_weave(self, to_location, revision=None, basis_branch=None):
 
1078
        # prevent leakage
 
1079
        from bzrlib.workingtree import WorkingTree
 
1080
        assert isinstance(to_location, basestring)
 
1081
        if basis_branch is not None:
 
1082
            note("basis_branch is not supported for fast weave copy yet.")
 
1083
 
 
1084
        history = self._get_truncated_history(revision)
 
1085
        if not bzrlib.osutils.lexists(to_location):
 
1086
            os.mkdir(to_location)
 
1087
        bzrdir_to = self.bzrdir._format.initialize(to_location)
 
1088
        self.repository.clone(bzrdir_to)
 
1089
        branch_to = bzrdir_to.create_branch()
 
1090
        mutter("copy branch from %s to %s", self, branch_to)
 
1091
 
 
1092
        # FIXME duplicate code with base .clone().
 
1093
        # .. would template method be useful here?  RBC 20051207
 
1094
        branch_to.set_parent(self.base)
 
1095
        branch_to.append_revision(*history)
 
1096
        WorkingTree.create(branch_to, branch_to.base)
 
1097
        mutter("copied")
 
1098
        return branch_to
 
1099
 
 
1100
 
 
1101
class BranchTestProviderAdapter(object):
 
1102
    """A tool to generate a suite testing multiple branch formats at once.
 
1103
 
 
1104
    This is done by copying the test once for each transport and injecting
 
1105
    the transport_server, transport_readonly_server, and branch_format
 
1106
    classes into each copy. Each copy is also given a new id() to make it
 
1107
    easy to identify.
 
1108
    """
 
1109
 
 
1110
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1111
        self._transport_server = transport_server
 
1112
        self._transport_readonly_server = transport_readonly_server
 
1113
        self._formats = formats
2502
1114
    
2503
 
    """
2504
 
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
2505
 
    # should share code?
2506
 
    target.lock_write()
2507
 
    try:
2508
 
        result = callable(*args, **kwargs)
2509
 
    except:
2510
 
        exc_info = sys.exc_info()
2511
 
        try:
2512
 
            target.unlock()
2513
 
        finally:
2514
 
            raise exc_info[0], exc_info[1], exc_info[2]
2515
 
    else:
2516
 
        target.unlock()
 
1115
    def adapt(self, test):
 
1116
        result = TestSuite()
 
1117
        for branch_format, bzrdir_format in self._formats:
 
1118
            new_test = deepcopy(test)
 
1119
            new_test.transport_server = self._transport_server
 
1120
            new_test.transport_readonly_server = self._transport_readonly_server
 
1121
            new_test.bzrdir_format = bzrdir_format
 
1122
            new_test.branch_format = branch_format
 
1123
            def make_new_test_id():
 
1124
                new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
 
1125
                return lambda: new_id
 
1126
            new_test.id = make_new_test_id()
 
1127
            result.addTest(new_test)
2517
1128
        return result
 
1129
 
 
1130
 
 
1131
######################################################################
 
1132
# predicates
 
1133
 
 
1134
 
 
1135
@deprecated_function(zero_eight)
 
1136
def ScratchBranch(*args, **kwargs):
 
1137
    """See bzrlib.bzrdir.ScratchDir."""
 
1138
    d = ScratchDir(*args, **kwargs)
 
1139
    return d.open_branch()
 
1140
 
 
1141
 
 
1142
@deprecated_function(zero_eight)
 
1143
def is_control_file(*args, **kwargs):
 
1144
    """See bzrlib.workingtree.is_control_file."""
 
1145
    return bzrlib.workingtree.is_control_file(*args, **kwargs)