~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-01-13 05:14:24 UTC
  • mfrom: (3936.1.3 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090113051424-nrk3zkfe09h46i9y
(mbp) merge 1.11 and advance to 1.12

Show diffs side-by-side

added added

removed removed

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