1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from bzrlib.lazy_import import lazy_import
19
lazy_import(globals(), """
23
config as _mod_config,
29
revision as _mod_revision,
35
from bzrlib.config import BranchConfig
36
from bzrlib.tag import (
42
from bzrlib.decorators import needs_read_lock, needs_write_lock
43
from bzrlib.hooks import Hooks
44
from bzrlib.symbol_versioning import (
48
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
51
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
52
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
53
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
56
# TODO: Maybe include checks for common corruption of newlines, etc?
58
# TODO: Some operations like log might retrieve the same revisions
59
# repeatedly to calculate deltas. We could perhaps have a weakref
60
# cache in memory to make this faster. In general anything can be
61
# cached in memory between lock and unlock operations. .. nb thats
62
# what the transaction identity map provides
65
######################################################################
69
"""Branch holding a history of revisions.
72
Base directory/url of the branch.
74
hooks: An instance of BranchHooks.
76
# this is really an instance variable - FIXME move it there
80
# override this to set the strategy for storing tags
82
return DisabledTags(self)
84
def __init__(self, *ignored, **ignored_too):
85
self.tags = self._make_tags()
86
self._revision_history_cache = None
87
self._revision_id_to_revno_cache = None
90
"""Break a lock if one is present from another instance.
92
Uses the ui factory to ask for confirmation if the lock may be from
95
This will probe the repository for its lock as well.
97
self.control_files.break_lock()
98
self.repository.break_lock()
99
master = self.get_master_branch()
100
if master is not None:
104
def open(base, _unsupported=False, possible_transports=None):
105
"""Open the branch rooted at base.
107
For instance, if the branch is at URL/.bzr/branch,
108
Branch.open(URL) -> a Branch instance.
110
control = bzrdir.BzrDir.open(base, _unsupported,
111
possible_transports=possible_transports)
112
return control.open_branch(_unsupported)
115
def open_from_transport(transport, _unsupported=False):
116
"""Open the branch rooted at transport"""
117
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
118
return control.open_branch(_unsupported)
121
def open_containing(url, possible_transports=None):
122
"""Open an existing branch which contains url.
124
This probes for a branch at url, and searches upwards from there.
126
Basically we keep looking up until we find the control directory or
127
run into the root. If there isn't one, raises NotBranchError.
128
If there is one and it is either an unrecognised format or an unsupported
129
format, UnknownFormatError or UnsupportedFormatError are raised.
130
If there is one, it is returned, along with the unused portion of url.
132
control, relpath = bzrdir.BzrDir.open_containing(url,
134
return control.open_branch(), relpath
136
def get_config(self):
137
return BranchConfig(self)
140
return self.get_config().get_nickname()
142
def _set_nick(self, nick):
143
self.get_config().set_user_option('nickname', nick, warn_masked=True)
145
nick = property(_get_nick, _set_nick)
148
raise NotImplementedError(self.is_locked)
150
def lock_write(self):
151
raise NotImplementedError(self.lock_write)
154
raise NotImplementedError(self.lock_read)
157
raise NotImplementedError(self.unlock)
159
def peek_lock_mode(self):
160
"""Return lock mode for the Branch: 'r', 'w' or None"""
161
raise NotImplementedError(self.peek_lock_mode)
163
def get_physical_lock_status(self):
164
raise NotImplementedError(self.get_physical_lock_status)
167
def get_revision_id_to_revno_map(self):
168
"""Return the revision_id => dotted revno map.
170
This will be regenerated on demand, but will be cached.
172
:return: A dictionary mapping revision_id => dotted revno.
173
This dictionary should not be modified by the caller.
175
if self._revision_id_to_revno_cache is not None:
176
mapping = self._revision_id_to_revno_cache
178
mapping = self._gen_revno_map()
179
self._cache_revision_id_to_revno(mapping)
180
# TODO: jam 20070417 Since this is being cached, should we be returning
182
# I would rather not, and instead just declare that users should not
183
# modify the return value.
186
def _gen_revno_map(self):
187
"""Create a new mapping from revision ids to dotted revnos.
189
Dotted revnos are generated based on the current tip in the revision
191
This is the worker function for get_revision_id_to_revno_map, which
192
just caches the return value.
194
:return: A dictionary mapping revision_id => dotted revno.
196
last_revision = self.last_revision()
197
revision_graph = repository._old_get_graph(self.repository,
199
merge_sorted_revisions = tsort.merge_sort(
204
revision_id_to_revno = dict((rev_id, revno)
205
for seq_num, rev_id, depth, revno, end_of_merge
206
in merge_sorted_revisions)
207
return revision_id_to_revno
209
def leave_lock_in_place(self):
210
"""Tell this branch object not to release the physical lock when this
213
If lock_write doesn't return a token, then this method is not supported.
215
self.control_files.leave_in_place()
217
def dont_leave_lock_in_place(self):
218
"""Tell this branch object to release the physical lock when this
219
object is unlocked, even if it didn't originally acquire it.
221
If lock_write doesn't return a token, then this method is not supported.
223
self.control_files.dont_leave_in_place()
225
@deprecated_method(deprecated_in((0, 16, 0)))
226
def abspath(self, name):
227
"""Return absolute filename for something in the branch
229
XXX: Robert Collins 20051017 what is this used for? why is it a branch
230
method and not a tree method.
232
raise NotImplementedError(self.abspath)
234
def bind(self, other):
235
"""Bind the local branch the other branch.
237
:param other: The branch to bind to
240
raise errors.UpgradeRequired(self.base)
243
def fetch(self, from_branch, last_revision=None, pb=None):
244
"""Copy revisions from from_branch into this branch.
246
:param from_branch: Where to copy from.
247
:param last_revision: What revision to stop at (None for at the end
249
:param pb: An optional progress bar to use.
251
Returns the copied revision count and the failed revisions in a tuple:
254
if self.base == from_branch.base:
257
nested_pb = ui.ui_factory.nested_progress_bar()
262
from_branch.lock_read()
264
if last_revision is None:
265
pb.update('get source history')
266
last_revision = from_branch.last_revision()
267
last_revision = _mod_revision.ensure_null(last_revision)
268
return self.repository.fetch(from_branch.repository,
269
revision_id=last_revision,
272
if nested_pb is not None:
276
def get_bound_location(self):
277
"""Return the URL of the branch we are bound to.
279
Older format branches cannot bind, please be sure to use a metadir
284
def get_old_bound_location(self):
285
"""Return the URL of the branch we used to be bound to
287
raise errors.UpgradeRequired(self.base)
289
def get_commit_builder(self, parents, config=None, timestamp=None,
290
timezone=None, committer=None, revprops=None,
292
"""Obtain a CommitBuilder for this branch.
294
:param parents: Revision ids of the parents of the new revision.
295
:param config: Optional configuration to use.
296
:param timestamp: Optional timestamp recorded for commit.
297
:param timezone: Optional timezone for timestamp.
298
:param committer: Optional committer to set for commit.
299
:param revprops: Optional dictionary of revision properties.
300
:param revision_id: Optional revision id.
304
config = self.get_config()
306
return self.repository.get_commit_builder(self, parents, config,
307
timestamp, timezone, committer, revprops, revision_id)
309
def get_master_branch(self, possible_transports=None):
310
"""Return the branch we are bound to.
312
:return: Either a Branch, or None
316
def get_revision_delta(self, revno):
317
"""Return the delta for one revision.
319
The delta is relative to its mainline predecessor, or the
320
empty tree for revision 1.
322
rh = self.revision_history()
323
if not (1 <= revno <= len(rh)):
324
raise errors.InvalidRevisionNumber(revno)
325
return self.repository.get_revision_delta(rh[revno-1])
327
def print_file(self, file, revision_id):
328
"""Print `file` to stdout."""
329
raise NotImplementedError(self.print_file)
331
def set_revision_history(self, rev_history):
332
raise NotImplementedError(self.set_revision_history)
334
def _cache_revision_history(self, rev_history):
335
"""Set the cached revision history to rev_history.
337
The revision_history method will use this cache to avoid regenerating
338
the revision history.
340
This API is semi-public; it only for use by subclasses, all other code
341
should consider it to be private.
343
self._revision_history_cache = rev_history
345
def _cache_revision_id_to_revno(self, revision_id_to_revno):
346
"""Set the cached revision_id => revno map to revision_id_to_revno.
348
This API is semi-public; it only for use by subclasses, all other code
349
should consider it to be private.
351
self._revision_id_to_revno_cache = revision_id_to_revno
353
def _clear_cached_state(self):
354
"""Clear any cached data on this branch, e.g. cached revision history.
356
This means the next call to revision_history will need to call
357
_gen_revision_history.
359
This API is semi-public; it only for use by subclasses, all other code
360
should consider it to be private.
362
self._revision_history_cache = None
363
self._revision_id_to_revno_cache = None
365
def _gen_revision_history(self):
366
"""Return sequence of revision hashes on to this branch.
368
Unlike revision_history, this method always regenerates or rereads the
369
revision history, i.e. it does not cache the result, so repeated calls
372
Concrete subclasses should override this instead of revision_history so
373
that subclasses do not need to deal with caching logic.
375
This API is semi-public; it only for use by subclasses, all other code
376
should consider it to be private.
378
raise NotImplementedError(self._gen_revision_history)
381
def revision_history(self):
382
"""Return sequence of revision ids on this branch.
384
This method will cache the revision history for as long as it is safe to
387
if 'evil' in debug.debug_flags:
388
mutter_callsite(3, "revision_history scales with history.")
389
if self._revision_history_cache is not None:
390
history = self._revision_history_cache
392
history = self._gen_revision_history()
393
self._cache_revision_history(history)
397
"""Return current revision number for this branch.
399
That is equivalent to the number of revisions committed to
402
return self.last_revision_info()[0]
405
"""Older format branches cannot bind or unbind."""
406
raise errors.UpgradeRequired(self.base)
408
def set_append_revisions_only(self, enabled):
409
"""Older format branches are never restricted to append-only"""
410
raise errors.UpgradeRequired(self.base)
412
def last_revision(self):
413
"""Return last revision id, or NULL_REVISION."""
414
return self.last_revision_info()[1]
416
def last_revision_info(self):
417
"""Return information about the last revision.
419
:return: A tuple (revno, last_revision_id).
421
rh = self.revision_history()
424
return (revno, rh[-1])
426
return (0, _mod_revision.NULL_REVISION)
428
def missing_revisions(self, other, stop_revision=None):
429
"""Return a list of new revisions that would perfectly fit.
431
If self and other have not diverged, return a list of the revisions
432
present in other, but missing from self.
434
self_history = self.revision_history()
435
self_len = len(self_history)
436
other_history = other.revision_history()
437
other_len = len(other_history)
438
common_index = min(self_len, other_len) -1
439
if common_index >= 0 and \
440
self_history[common_index] != other_history[common_index]:
441
raise errors.DivergedBranches(self, other)
443
if stop_revision is None:
444
stop_revision = other_len
446
if stop_revision > other_len:
447
raise errors.NoSuchRevision(self, stop_revision)
448
return other_history[self_len:stop_revision]
450
def update_revisions(self, other, stop_revision=None):
451
"""Pull in new perfect-fit revisions.
453
:param other: Another Branch to pull from
454
:param stop_revision: Updated until the given revision
457
raise NotImplementedError(self.update_revisions)
459
def revision_id_to_revno(self, revision_id):
460
"""Given a revision id, return its revno"""
461
if _mod_revision.is_null(revision_id):
463
history = self.revision_history()
465
return history.index(revision_id) + 1
467
raise errors.NoSuchRevision(self, revision_id)
469
def get_rev_id(self, revno, history=None):
470
"""Find the revision id of the specified revno."""
472
return _mod_revision.NULL_REVISION
474
history = self.revision_history()
475
if revno <= 0 or revno > len(history):
476
raise errors.NoSuchRevision(self, revno)
477
return history[revno - 1]
479
def pull(self, source, overwrite=False, stop_revision=None,
480
possible_transports=None):
481
"""Mirror source into this branch.
483
This branch is considered to be 'local', having low latency.
485
:returns: PullResult instance
487
raise NotImplementedError(self.pull)
489
def push(self, target, overwrite=False, stop_revision=None):
490
"""Mirror this branch into target.
492
This branch is considered to be 'local', having low latency.
494
raise NotImplementedError(self.push)
496
def basis_tree(self):
497
"""Return `Tree` object for last revision."""
498
return self.repository.revision_tree(self.last_revision())
500
def rename_one(self, from_rel, to_rel):
503
This can change the directory or the filename or both.
505
raise NotImplementedError(self.rename_one)
507
def move(self, from_paths, to_name):
510
to_name must exist as a versioned directory.
512
If to_name exists and is a directory, the files are moved into
513
it, keeping their old names. If it is a directory,
515
Note that to_name is only the last component of the new name;
516
this doesn't change the directory.
518
This returns a list of (from_path, to_path) pairs for each
521
raise NotImplementedError(self.move)
523
def get_parent(self):
524
"""Return the parent location of the branch.
526
This is the default location for push/pull/missing. The usual
527
pattern is that the user can override it by specifying a
530
raise NotImplementedError(self.get_parent)
532
def _set_config_location(self, name, url, config=None,
533
make_relative=False):
535
config = self.get_config()
539
url = urlutils.relative_url(self.base, url)
540
config.set_user_option(name, url, warn_masked=True)
542
def _get_config_location(self, name, config=None):
544
config = self.get_config()
545
location = config.get_user_option(name)
550
def get_submit_branch(self):
551
"""Return the submit location of the branch.
553
This is the default location for bundle. The usual
554
pattern is that the user can override it by specifying a
557
return self.get_config().get_user_option('submit_branch')
559
def set_submit_branch(self, location):
560
"""Return the submit location of the branch.
562
This is the default location for bundle. The usual
563
pattern is that the user can override it by specifying a
566
self.get_config().set_user_option('submit_branch', location,
569
def get_public_branch(self):
570
"""Return the public location of the branch.
572
This is is used by merge directives.
574
return self._get_config_location('public_branch')
576
def set_public_branch(self, location):
577
"""Return the submit location of the branch.
579
This is the default location for bundle. The usual
580
pattern is that the user can override it by specifying a
583
self._set_config_location('public_branch', location)
585
def get_push_location(self):
586
"""Return the None or the location to push this branch to."""
587
push_loc = self.get_config().get_user_option('push_location')
590
def set_push_location(self, location):
591
"""Set a new push location for this branch."""
592
raise NotImplementedError(self.set_push_location)
594
def set_parent(self, url):
595
raise NotImplementedError(self.set_parent)
599
"""Synchronise this branch with the master branch if any.
601
:return: None or the last_revision pivoted out during the update.
605
def check_revno(self, revno):
607
Check whether a revno corresponds to any revision.
608
Zero (the NULL revision) is considered valid.
611
self.check_real_revno(revno)
613
def check_real_revno(self, revno):
615
Check whether a revno corresponds to a real revision.
616
Zero (the NULL revision) is considered invalid
618
if revno < 1 or revno > self.revno():
619
raise errors.InvalidRevisionNumber(revno)
622
def clone(self, to_bzrdir, revision_id=None):
623
"""Clone this branch into to_bzrdir preserving all semantic values.
625
revision_id: if not None, the revision history in the new branch will
626
be truncated to end with revision_id.
628
result = self._format.initialize(to_bzrdir)
629
self.copy_content_into(result, revision_id=revision_id)
633
def sprout(self, to_bzrdir, revision_id=None):
634
"""Create a new line of development from the branch, into to_bzrdir.
636
revision_id: if not None, the revision history in the new branch will
637
be truncated to end with revision_id.
639
result = self._format.initialize(to_bzrdir)
640
self.copy_content_into(result, revision_id=revision_id)
641
result.set_parent(self.bzrdir.root_transport.base)
644
def _synchronize_history(self, destination, revision_id):
645
"""Synchronize last revision and revision history between branches.
647
This version is most efficient when the destination is also a
648
BzrBranch5, but works for BzrBranch6 as long as the revision
649
history is the true lefthand parent history, and all of the revisions
650
are in the destination's repository. If not, set_revision_history
653
:param destination: The branch to copy the history into
654
:param revision_id: The revision-id to truncate history at. May
655
be None to copy complete history.
657
if revision_id == _mod_revision.NULL_REVISION:
659
new_history = self.revision_history()
660
if revision_id is not None and new_history != []:
662
new_history = new_history[:new_history.index(revision_id) + 1]
664
rev = self.repository.get_revision(revision_id)
665
new_history = rev.get_history(self.repository)[1:]
666
destination.set_revision_history(new_history)
669
def copy_content_into(self, destination, revision_id=None):
670
"""Copy the content of self into destination.
672
revision_id: if not None, the revision history in the new branch will
673
be truncated to end with revision_id.
675
self._synchronize_history(destination, revision_id)
677
parent = self.get_parent()
678
except errors.InaccessibleParent, e:
679
mutter('parent was not accessible to copy: %s', e)
682
destination.set_parent(parent)
683
self.tags.merge_to(destination.tags)
687
"""Check consistency of the branch.
689
In particular this checks that revisions given in the revision-history
690
do actually match up in the revision graph, and that they're all
691
present in the repository.
693
Callers will typically also want to check the repository.
695
:return: A BranchCheckResult.
697
mainline_parent_id = None
698
last_revno, last_revision_id = self.last_revision_info()
699
real_rev_history = list(self.repository.iter_reverse_revision_history(
701
real_rev_history.reverse()
702
if len(real_rev_history) != last_revno:
703
raise errors.BzrCheckError('revno does not match len(mainline)'
704
' %s != %s' % (last_revno, len(real_rev_history)))
705
# TODO: We should probably also check that real_rev_history actually
706
# matches self.revision_history()
707
for revision_id in real_rev_history:
709
revision = self.repository.get_revision(revision_id)
710
except errors.NoSuchRevision, e:
711
raise errors.BzrCheckError("mainline revision {%s} not in repository"
713
# In general the first entry on the revision history has no parents.
714
# But it's not illegal for it to have parents listed; this can happen
715
# in imports from Arch when the parents weren't reachable.
716
if mainline_parent_id is not None:
717
if mainline_parent_id not in revision.parent_ids:
718
raise errors.BzrCheckError("previous revision {%s} not listed among "
720
% (mainline_parent_id, revision_id))
721
mainline_parent_id = revision_id
722
return BranchCheckResult(self)
724
def _get_checkout_format(self):
725
"""Return the most suitable metadir for a checkout of this branch.
726
Weaves are used if this branch's repository uses weaves.
728
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
729
from bzrlib.repofmt import weaverepo
730
format = bzrdir.BzrDirMetaFormat1()
731
format.repository_format = weaverepo.RepositoryFormat7()
733
format = self.repository.bzrdir.checkout_metadir()
734
format.set_branch_format(self._format)
737
def create_checkout(self, to_location, revision_id=None,
738
lightweight=False, accelerator_tree=None,
740
"""Create a checkout of a branch.
742
:param to_location: The url to produce the checkout at
743
:param revision_id: The revision to check out
744
:param lightweight: If True, produce a lightweight checkout, otherwise,
745
produce a bound branch (heavyweight checkout)
746
:param accelerator_tree: A tree which can be used for retrieving file
747
contents more quickly than the revision tree, i.e. a workingtree.
748
The revision tree will be used for cases where accelerator_tree's
749
content is different.
750
:param hardlink: If true, hard-link files from accelerator_tree,
752
:return: The tree of the created checkout
754
t = transport.get_transport(to_location)
757
format = self._get_checkout_format()
758
checkout = format.initialize_on_transport(t)
759
from_branch = BranchReferenceFormat().initialize(checkout, self)
761
format = self._get_checkout_format()
762
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
763
to_location, force_new_tree=False, format=format)
764
checkout = checkout_branch.bzrdir
765
checkout_branch.bind(self)
766
# pull up to the specified revision_id to set the initial
767
# branch tip correctly, and seed it with history.
768
checkout_branch.pull(self, stop_revision=revision_id)
770
tree = checkout.create_workingtree(revision_id,
771
from_branch=from_branch,
772
accelerator_tree=accelerator_tree,
774
basis_tree = tree.basis_tree()
775
basis_tree.lock_read()
777
for path, file_id in basis_tree.iter_references():
778
reference_parent = self.reference_parent(file_id, path)
779
reference_parent.create_checkout(tree.abspath(path),
780
basis_tree.get_reference_revision(file_id, path),
787
def reconcile(self, thorough=True):
788
"""Make sure the data stored in this branch is consistent."""
789
from bzrlib.reconcile import BranchReconciler
790
reconciler = BranchReconciler(self, thorough=thorough)
791
reconciler.reconcile()
794
def reference_parent(self, file_id, path):
795
"""Return the parent branch for a tree-reference file_id
796
:param file_id: The file_id of the tree reference
797
:param path: The path of the file_id in the tree
798
:return: A branch associated with the file_id
800
# FIXME should provide multiple branches, based on config
801
return Branch.open(self.bzrdir.root_transport.clone(path).base)
803
def supports_tags(self):
804
return self._format.supports_tags()
807
class BranchFormat(object):
808
"""An encapsulation of the initialization and open routines for a format.
810
Formats provide three things:
811
* An initialization routine,
815
Formats are placed in an dict by their format string for reference
816
during branch opening. Its not required that these be instances, they
817
can be classes themselves with class methods - it simply depends on
818
whether state is needed for a given format or not.
820
Once a format is deprecated, just deprecate the initialize and open
821
methods on the format class. Do not deprecate the object, as the
822
object will be created every time regardless.
825
_default_format = None
826
"""The default format used for new branches."""
829
"""The known formats."""
831
def __eq__(self, other):
832
return self.__class__ is other.__class__
834
def __ne__(self, other):
835
return not (self == other)
838
def find_format(klass, a_bzrdir):
839
"""Return the format for the branch object in a_bzrdir."""
841
transport = a_bzrdir.get_branch_transport(None)
842
format_string = transport.get("format").read()
843
return klass._formats[format_string]
844
except errors.NoSuchFile:
845
raise errors.NotBranchError(path=transport.base)
847
raise errors.UnknownFormatError(format=format_string, kind='branch')
850
def get_default_format(klass):
851
"""Return the current default format."""
852
return klass._default_format
854
def get_reference(self, a_bzrdir):
855
"""Get the target reference of the branch in a_bzrdir.
857
format probing must have been completed before calling
858
this method - it is assumed that the format of the branch
859
in a_bzrdir is correct.
861
:param a_bzrdir: The bzrdir to get the branch data from.
862
:return: None if the branch is not a reference branch.
867
def set_reference(self, a_bzrdir, to_branch):
868
"""Set the target reference of the branch in a_bzrdir.
870
format probing must have been completed before calling
871
this method - it is assumed that the format of the branch
872
in a_bzrdir is correct.
874
:param a_bzrdir: The bzrdir to set the branch reference for.
875
:param to_branch: branch that the checkout is to reference
877
raise NotImplementedError(self.set_reference)
879
def get_format_string(self):
880
"""Return the ASCII format string that identifies this format."""
881
raise NotImplementedError(self.get_format_string)
883
def get_format_description(self):
884
"""Return the short format description for this format."""
885
raise NotImplementedError(self.get_format_description)
887
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
889
"""Initialize a branch in a bzrdir, with specified files
891
:param a_bzrdir: The bzrdir to initialize the branch in
892
:param utf8_files: The files to create as a list of
893
(filename, content) tuples
894
:param set_format: If True, set the format with
895
self.get_format_string. (BzrBranch4 has its format set
897
:return: a branch in this format
899
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
900
branch_transport = a_bzrdir.get_branch_transport(self)
902
'metadir': ('lock', lockdir.LockDir),
903
'branch4': ('branch-lock', lockable_files.TransportLock),
905
lock_name, lock_class = lock_map[lock_type]
906
control_files = lockable_files.LockableFiles(branch_transport,
907
lock_name, lock_class)
908
control_files.create_lock()
909
control_files.lock_write()
911
utf8_files += [('format', self.get_format_string())]
913
for (filename, content) in utf8_files:
914
branch_transport.put_bytes(
916
mode=control_files._file_mode)
918
control_files.unlock()
919
return self.open(a_bzrdir, _found=True)
921
def initialize(self, a_bzrdir):
922
"""Create a branch of this format in a_bzrdir."""
923
raise NotImplementedError(self.initialize)
925
def is_supported(self):
926
"""Is this format supported?
928
Supported formats can be initialized and opened.
929
Unsupported formats may not support initialization or committing or
930
some other features depending on the reason for not being supported.
934
def open(self, a_bzrdir, _found=False):
935
"""Return the branch object for a_bzrdir
937
_found is a private parameter, do not use it. It is used to indicate
938
if format probing has already be done.
940
raise NotImplementedError(self.open)
943
def register_format(klass, format):
944
klass._formats[format.get_format_string()] = format
947
def set_default_format(klass, format):
948
klass._default_format = format
951
def unregister_format(klass, format):
952
del klass._formats[format.get_format_string()]
955
return self.get_format_string().rstrip()
957
def supports_tags(self):
958
"""True if this format supports tags stored in the branch"""
959
return False # by default
962
class BranchHooks(Hooks):
963
"""A dictionary mapping hook name to a list of callables for branch hooks.
965
e.g. ['set_rh'] Is the list of items to be called when the
966
set_revision_history function is invoked.
970
"""Create the default hooks.
972
These are all empty initially, because by default nothing should get
976
# Introduced in 0.15:
977
# invoked whenever the revision history has been set
978
# with set_revision_history. The api signature is
979
# (branch, revision_history), and the branch will
982
# invoked after a push operation completes.
983
# the api signature is
985
# containing the members
986
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
987
# where local is the local target branch or None, master is the target
988
# master branch, and the rest should be self explanatory. The source
989
# is read locked and the target branches write locked. Source will
990
# be the local low-latency branch.
991
self['post_push'] = []
992
# invoked after a pull operation completes.
993
# the api signature is
995
# containing the members
996
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
997
# where local is the local branch or None, master is the target
998
# master branch, and the rest should be self explanatory. The source
999
# is read locked and the target branches write locked. The local
1000
# branch is the low-latency branch.
1001
self['post_pull'] = []
1002
# invoked before a commit operation takes place.
1003
# the api signature is
1004
# (local, master, old_revno, old_revid, future_revno, future_revid,
1005
# tree_delta, future_tree).
1006
# old_revid is NULL_REVISION for the first commit to a branch
1007
# tree_delta is a TreeDelta object describing changes from the basis
1008
# revision, hooks MUST NOT modify this delta
1009
# future_tree is an in-memory tree obtained from
1010
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1011
self['pre_commit'] = []
1012
# invoked after a commit operation completes.
1013
# the api signature is
1014
# (local, master, old_revno, old_revid, new_revno, new_revid)
1015
# old_revid is NULL_REVISION for the first commit to a branch.
1016
self['post_commit'] = []
1017
# invoked after a uncommit operation completes.
1018
# the api signature is
1019
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1020
# local is the local branch or None, master is the target branch,
1021
# and an empty branch recieves new_revno of 0, new_revid of None.
1022
self['post_uncommit'] = []
1024
# Invoked after the tip of a branch changes.
1025
# the api signature is
1026
# (params) where params is a ChangeBranchTipParams with the members
1027
# (branch, old_revno, new_revno, old_revid, new_revid)
1028
self['post_change_branch_tip'] = []
1031
# install the default hooks into the Branch class.
1032
Branch.hooks = BranchHooks()
1035
class ChangeBranchTipParams(object):
1036
"""Object holding parameters passed to *_change_branch_tip hooks.
1038
There are 5 fields that hooks may wish to access:
1040
:ivar branch: the branch being changed
1041
:ivar old_revno: revision number before the change
1042
:ivar new_revno: revision number after the change
1043
:ivar old_revid: revision id before the change
1044
:ivar new_revid: revision id after the change
1046
The revid fields are strings. The revno fields are integers.
1049
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1050
"""Create a group of ChangeBranchTip parameters.
1052
:param branch: The branch being changed.
1053
:param old_revno: Revision number before the change.
1054
:param new_revno: Revision number after the change.
1055
:param old_revid: Tip revision id before the change.
1056
:param new_revid: Tip revision id after the change.
1058
self.branch = branch
1059
self.old_revno = old_revno
1060
self.new_revno = new_revno
1061
self.old_revid = old_revid
1062
self.new_revid = new_revid
1065
class BzrBranchFormat4(BranchFormat):
1066
"""Bzr branch format 4.
1069
- a revision-history file.
1070
- a branch-lock lock file [ to be shared with the bzrdir ]
1073
def get_format_description(self):
1074
"""See BranchFormat.get_format_description()."""
1075
return "Branch format 4"
1077
def initialize(self, a_bzrdir):
1078
"""Create a branch of this format in a_bzrdir."""
1079
utf8_files = [('revision-history', ''),
1080
('branch-name', ''),
1082
return self._initialize_helper(a_bzrdir, utf8_files,
1083
lock_type='branch4', set_format=False)
1086
super(BzrBranchFormat4, self).__init__()
1087
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1089
def open(self, a_bzrdir, _found=False):
1090
"""Return the branch object for a_bzrdir
1092
_found is a private parameter, do not use it. It is used to indicate
1093
if format probing has already be done.
1096
# we are being called directly and must probe.
1097
raise NotImplementedError
1098
return BzrBranch(_format=self,
1099
_control_files=a_bzrdir._control_files,
1101
_repository=a_bzrdir.open_repository())
1104
return "Bazaar-NG branch format 4"
1107
class BzrBranchFormat5(BranchFormat):
1108
"""Bzr branch format 5.
1111
- a revision-history file.
1113
- a lock dir guarding the branch itself
1114
- all of this stored in a branch/ subdirectory
1115
- works with shared repositories.
1117
This format is new in bzr 0.8.
1120
def get_format_string(self):
1121
"""See BranchFormat.get_format_string()."""
1122
return "Bazaar-NG branch format 5\n"
1124
def get_format_description(self):
1125
"""See BranchFormat.get_format_description()."""
1126
return "Branch format 5"
1128
def initialize(self, a_bzrdir):
1129
"""Create a branch of this format in a_bzrdir."""
1130
utf8_files = [('revision-history', ''),
1131
('branch-name', ''),
1133
return self._initialize_helper(a_bzrdir, utf8_files)
1136
super(BzrBranchFormat5, self).__init__()
1137
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1139
def open(self, a_bzrdir, _found=False):
1140
"""Return the branch object for a_bzrdir
1142
_found is a private parameter, do not use it. It is used to indicate
1143
if format probing has already be done.
1146
format = BranchFormat.find_format(a_bzrdir)
1147
if format.__class__ != self.__class__:
1148
raise AssertionError("wrong format %r found for %r" %
1151
transport = a_bzrdir.get_branch_transport(None)
1152
control_files = lockable_files.LockableFiles(transport, 'lock',
1154
return BzrBranch5(_format=self,
1155
_control_files=control_files,
1157
_repository=a_bzrdir.find_repository())
1158
except errors.NoSuchFile:
1159
raise errors.NotBranchError(path=transport.base)
1162
class BzrBranchFormat6(BzrBranchFormat5):
1163
"""Branch format with last-revision and tags.
1165
Unlike previous formats, this has no explicit revision history. Instead,
1166
this just stores the last-revision, and the left-hand history leading
1167
up to there is the history.
1169
This format was introduced in bzr 0.15
1170
and became the default in 0.91.
1173
def get_format_string(self):
1174
"""See BranchFormat.get_format_string()."""
1175
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1177
def get_format_description(self):
1178
"""See BranchFormat.get_format_description()."""
1179
return "Branch format 6"
1181
def initialize(self, a_bzrdir):
1182
"""Create a branch of this format in a_bzrdir."""
1183
utf8_files = [('last-revision', '0 null:\n'),
1184
('branch.conf', ''),
1187
return self._initialize_helper(a_bzrdir, utf8_files)
1189
def open(self, a_bzrdir, _found=False):
1190
"""Return the branch object for a_bzrdir
1192
_found is a private parameter, do not use it. It is used to indicate
1193
if format probing has already be done.
1196
format = BranchFormat.find_format(a_bzrdir)
1197
if format.__class__ != self.__class__:
1198
raise AssertionError("wrong format %r found for %r" %
1200
transport = a_bzrdir.get_branch_transport(None)
1201
control_files = lockable_files.LockableFiles(transport, 'lock',
1203
return BzrBranch6(_format=self,
1204
_control_files=control_files,
1206
_repository=a_bzrdir.find_repository())
1208
def supports_tags(self):
1212
class BranchReferenceFormat(BranchFormat):
1213
"""Bzr branch reference format.
1215
Branch references are used in implementing checkouts, they
1216
act as an alias to the real branch which is at some other url.
1223
def get_format_string(self):
1224
"""See BranchFormat.get_format_string()."""
1225
return "Bazaar-NG Branch Reference Format 1\n"
1227
def get_format_description(self):
1228
"""See BranchFormat.get_format_description()."""
1229
return "Checkout reference format 1"
1231
def get_reference(self, a_bzrdir):
1232
"""See BranchFormat.get_reference()."""
1233
transport = a_bzrdir.get_branch_transport(None)
1234
return transport.get('location').read()
1236
def set_reference(self, a_bzrdir, to_branch):
1237
"""See BranchFormat.set_reference()."""
1238
transport = a_bzrdir.get_branch_transport(None)
1239
location = transport.put_bytes('location', to_branch.base)
1241
def initialize(self, a_bzrdir, target_branch=None):
1242
"""Create a branch of this format in a_bzrdir."""
1243
if target_branch is None:
1244
# this format does not implement branch itself, thus the implicit
1245
# creation contract must see it as uninitializable
1246
raise errors.UninitializableFormat(self)
1247
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1248
branch_transport = a_bzrdir.get_branch_transport(self)
1249
branch_transport.put_bytes('location',
1250
target_branch.bzrdir.root_transport.base)
1251
branch_transport.put_bytes('format', self.get_format_string())
1253
a_bzrdir, _found=True,
1254
possible_transports=[target_branch.bzrdir.root_transport])
1257
super(BranchReferenceFormat, self).__init__()
1258
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1260
def _make_reference_clone_function(format, a_branch):
1261
"""Create a clone() routine for a branch dynamically."""
1262
def clone(to_bzrdir, revision_id=None):
1263
"""See Branch.clone()."""
1264
return format.initialize(to_bzrdir, a_branch)
1265
# cannot obey revision_id limits when cloning a reference ...
1266
# FIXME RBC 20060210 either nuke revision_id for clone, or
1267
# emit some sort of warning/error to the caller ?!
1270
def open(self, a_bzrdir, _found=False, location=None,
1271
possible_transports=None):
1272
"""Return the branch that the branch reference in a_bzrdir points at.
1274
_found is a private parameter, do not use it. It is used to indicate
1275
if format probing has already be done.
1278
format = BranchFormat.find_format(a_bzrdir)
1279
if format.__class__ != self.__class__:
1280
raise AssertionError("wrong format %r found for %r" %
1282
if location is None:
1283
location = self.get_reference(a_bzrdir)
1284
real_bzrdir = bzrdir.BzrDir.open(
1285
location, possible_transports=possible_transports)
1286
result = real_bzrdir.open_branch()
1287
# this changes the behaviour of result.clone to create a new reference
1288
# rather than a copy of the content of the branch.
1289
# I did not use a proxy object because that needs much more extensive
1290
# testing, and we are only changing one behaviour at the moment.
1291
# If we decide to alter more behaviours - i.e. the implicit nickname
1292
# then this should be refactored to introduce a tested proxy branch
1293
# and a subclass of that for use in overriding clone() and ....
1295
result.clone = self._make_reference_clone_function(result)
1299
# formats which have no format string are not discoverable
1300
# and not independently creatable, so are not registered.
1301
__format5 = BzrBranchFormat5()
1302
__format6 = BzrBranchFormat6()
1303
BranchFormat.register_format(__format5)
1304
BranchFormat.register_format(BranchReferenceFormat())
1305
BranchFormat.register_format(__format6)
1306
BranchFormat.set_default_format(__format6)
1307
_legacy_formats = [BzrBranchFormat4(),
1310
class BzrBranch(Branch):
1311
"""A branch stored in the actual filesystem.
1313
Note that it's "local" in the context of the filesystem; it doesn't
1314
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1315
it's writable, and can be accessed via the normal filesystem API.
1317
:ivar _transport: Transport for file operations on this branch's
1318
control files, typically pointing to the .bzr/branch directory.
1319
:ivar repository: Repository for this branch.
1320
:ivar base: The url of the base directory for this branch; the one
1321
containing the .bzr directory.
1324
def __init__(self, _format=None,
1325
_control_files=None, a_bzrdir=None, _repository=None):
1326
"""Create new branch object at a particular location."""
1327
Branch.__init__(self)
1328
if a_bzrdir is None:
1329
raise ValueError('a_bzrdir must be supplied')
1331
self.bzrdir = a_bzrdir
1332
self._base = self.bzrdir.transport.clone('..').base
1333
# XXX: We should be able to just do
1334
# self.base = self.bzrdir.root_transport.base
1335
# but this does not quite work yet -- mbp 20080522
1336
self._format = _format
1337
if _control_files is None:
1338
raise ValueError('BzrBranch _control_files is None')
1339
self.control_files = _control_files
1340
self._transport = _control_files._transport
1341
self.repository = _repository
1344
return '%s(%r)' % (self.__class__.__name__, self.base)
1348
def _get_base(self):
1349
"""Returns the directory containing the control directory."""
1352
base = property(_get_base, doc="The URL for the root of this branch.")
1354
@deprecated_method(deprecated_in((0, 16, 0)))
1355
def abspath(self, name):
1356
"""See Branch.abspath."""
1357
return self._transport.abspath(name)
1359
def is_locked(self):
1360
return self.control_files.is_locked()
1362
def lock_write(self, token=None):
1363
repo_token = self.repository.lock_write()
1365
token = self.control_files.lock_write(token=token)
1367
self.repository.unlock()
1371
def lock_read(self):
1372
self.repository.lock_read()
1374
self.control_files.lock_read()
1376
self.repository.unlock()
1380
# TODO: test for failed two phase locks. This is known broken.
1382
self.control_files.unlock()
1384
self.repository.unlock()
1385
if not self.control_files.is_locked():
1386
# we just released the lock
1387
self._clear_cached_state()
1389
def peek_lock_mode(self):
1390
if self.control_files._lock_count == 0:
1393
return self.control_files._lock_mode
1395
def get_physical_lock_status(self):
1396
return self.control_files.get_physical_lock_status()
1399
def print_file(self, file, revision_id):
1400
"""See Branch.print_file."""
1401
return self.repository.print_file(file, revision_id)
1403
def _write_revision_history(self, history):
1404
"""Factored out of set_revision_history.
1406
This performs the actual writing to disk.
1407
It is intended to be called by BzrBranch5.set_revision_history."""
1408
self._transport.put_bytes(
1409
'revision-history', '\n'.join(history),
1410
mode=self.control_files._file_mode)
1413
def set_revision_history(self, rev_history):
1414
"""See Branch.set_revision_history."""
1415
if 'evil' in debug.debug_flags:
1416
mutter_callsite(3, "set_revision_history scales with history.")
1417
self._write_revision_history(rev_history)
1418
self._clear_cached_state()
1419
self._cache_revision_history(rev_history)
1420
for hook in Branch.hooks['set_rh']:
1421
hook(self, rev_history)
1423
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1424
"""Run the post_change_branch_tip hooks."""
1425
hooks = Branch.hooks['post_change_branch_tip']
1428
new_revno, new_revid = self.last_revision_info()
1429
params = ChangeBranchTipParams(
1430
self, old_revno, new_revno, old_revid, new_revid)
1435
def set_last_revision_info(self, revno, revision_id):
1436
"""Set the last revision of this branch.
1438
The caller is responsible for checking that the revno is correct
1439
for this revision id.
1441
It may be possible to set the branch last revision to an id not
1442
present in the repository. However, branches can also be
1443
configured to check constraints on history, in which case this may not
1446
revision_id = _mod_revision.ensure_null(revision_id)
1447
old_revno, old_revid = self.last_revision_info()
1448
# this old format stores the full history, but this api doesn't
1449
# provide it, so we must generate, and might as well check it's
1451
history = self._lefthand_history(revision_id)
1452
if len(history) != revno:
1453
raise AssertionError('%d != %d' % (len(history), revno))
1454
self.set_revision_history(history)
1455
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1457
def _gen_revision_history(self):
1458
history = self._transport.get_bytes('revision-history').split('\n')
1459
if history[-1:] == ['']:
1460
# There shouldn't be a trailing newline, but just in case.
1464
def _lefthand_history(self, revision_id, last_rev=None,
1466
if 'evil' in debug.debug_flags:
1467
mutter_callsite(4, "_lefthand_history scales with history.")
1468
# stop_revision must be a descendant of last_revision
1469
graph = self.repository.get_graph()
1470
if last_rev is not None:
1471
if not graph.is_ancestor(last_rev, revision_id):
1472
# our previous tip is not merged into stop_revision
1473
raise errors.DivergedBranches(self, other_branch)
1474
# make a new revision history from the graph
1475
parents_map = graph.get_parent_map([revision_id])
1476
if revision_id not in parents_map:
1477
raise errors.NoSuchRevision(self, revision_id)
1478
current_rev_id = revision_id
1480
# Do not include ghosts or graph origin in revision_history
1481
while (current_rev_id in parents_map and
1482
len(parents_map[current_rev_id]) > 0):
1483
new_history.append(current_rev_id)
1484
current_rev_id = parents_map[current_rev_id][0]
1485
parents_map = graph.get_parent_map([current_rev_id])
1486
new_history.reverse()
1490
def generate_revision_history(self, revision_id, last_rev=None,
1492
"""Create a new revision history that will finish with revision_id.
1494
:param revision_id: the new tip to use.
1495
:param last_rev: The previous last_revision. If not None, then this
1496
must be a ancestory of revision_id, or DivergedBranches is raised.
1497
:param other_branch: The other branch that DivergedBranches should
1498
raise with respect to.
1500
self.set_revision_history(self._lefthand_history(revision_id,
1501
last_rev, other_branch))
1504
def update_revisions(self, other, stop_revision=None, overwrite=False):
1505
"""See Branch.update_revisions."""
1508
other_last_revno, other_last_revision = other.last_revision_info()
1509
if stop_revision is None:
1510
stop_revision = other_last_revision
1511
if _mod_revision.is_null(stop_revision):
1512
# if there are no commits, we're done.
1514
# whats the current last revision, before we fetch [and change it
1516
last_rev = _mod_revision.ensure_null(self.last_revision())
1517
# we fetch here so that we don't process data twice in the common
1518
# case of having something to pull, and so that the check for
1519
# already merged can operate on the just fetched graph, which will
1520
# be cached in memory.
1521
self.fetch(other, stop_revision)
1522
# Check to see if one is an ancestor of the other
1524
heads = self.repository.get_graph().heads([stop_revision,
1526
if heads == set([last_rev]):
1527
# The current revision is a decendent of the target,
1530
elif heads == set([stop_revision, last_rev]):
1531
# These branches have diverged
1532
raise errors.DivergedBranches(self, other)
1533
elif heads != set([stop_revision]):
1534
raise AssertionError("invalid heads: %r" % heads)
1535
if other_last_revision == stop_revision:
1536
self.set_last_revision_info(other_last_revno,
1537
other_last_revision)
1539
# TODO: jam 2007-11-29 Is there a way to determine the
1540
# revno without searching all of history??
1542
self.generate_revision_history(stop_revision)
1544
self.generate_revision_history(stop_revision,
1545
last_rev=last_rev, other_branch=other)
1549
def basis_tree(self):
1550
"""See Branch.basis_tree."""
1551
return self.repository.revision_tree(self.last_revision())
1554
def pull(self, source, overwrite=False, stop_revision=None,
1555
_hook_master=None, run_hooks=True, possible_transports=None):
1558
:param _hook_master: Private parameter - set the branch to
1559
be supplied as the master to push hooks.
1560
:param run_hooks: Private parameter - if false, this branch
1561
is being called because it's the master of the primary branch,
1562
so it should not run its hooks.
1564
result = PullResult()
1565
result.source_branch = source
1566
result.target_branch = self
1569
result.old_revno, result.old_revid = self.last_revision_info()
1570
self.update_revisions(source, stop_revision, overwrite=overwrite)
1571
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1572
result.new_revno, result.new_revid = self.last_revision_info()
1574
result.master_branch = _hook_master
1575
result.local_branch = self
1577
result.master_branch = self
1578
result.local_branch = None
1580
for hook in Branch.hooks['post_pull']:
1586
def _get_parent_location(self):
1587
_locs = ['parent', 'pull', 'x-pull']
1590
return self._transport.get_bytes(l).strip('\n')
1591
except errors.NoSuchFile:
1596
def push(self, target, overwrite=False, stop_revision=None,
1597
_override_hook_source_branch=None):
1600
This is the basic concrete implementation of push()
1602
:param _override_hook_source_branch: If specified, run
1603
the hooks passing this Branch as the source, rather than self.
1604
This is for use of RemoteBranch, where push is delegated to the
1605
underlying vfs-based Branch.
1607
# TODO: Public option to disable running hooks - should be trivial but
1611
result = self._push_with_bound_branches(target, overwrite,
1613
_override_hook_source_branch=_override_hook_source_branch)
1618
def _push_with_bound_branches(self, target, overwrite,
1620
_override_hook_source_branch=None):
1621
"""Push from self into target, and into target's master if any.
1623
This is on the base BzrBranch class even though it doesn't support
1624
bound branches because the *target* might be bound.
1627
if _override_hook_source_branch:
1628
result.source_branch = _override_hook_source_branch
1629
for hook in Branch.hooks['post_push']:
1632
bound_location = target.get_bound_location()
1633
if bound_location and target.base != bound_location:
1634
# there is a master branch.
1636
# XXX: Why the second check? Is it even supported for a branch to
1637
# be bound to itself? -- mbp 20070507
1638
master_branch = target.get_master_branch()
1639
master_branch.lock_write()
1641
# push into the master from this branch.
1642
self._basic_push(master_branch, overwrite, stop_revision)
1643
# and push into the target branch from this. Note that we push from
1644
# this branch again, because its considered the highest bandwidth
1646
result = self._basic_push(target, overwrite, stop_revision)
1647
result.master_branch = master_branch
1648
result.local_branch = target
1652
master_branch.unlock()
1655
result = self._basic_push(target, overwrite, stop_revision)
1656
# TODO: Why set master_branch and local_branch if there's no
1657
# binding? Maybe cleaner to just leave them unset? -- mbp
1659
result.master_branch = target
1660
result.local_branch = None
1664
def _basic_push(self, target, overwrite, stop_revision):
1665
"""Basic implementation of push without bound branches or hooks.
1667
Must be called with self read locked and target write locked.
1669
result = PushResult()
1670
result.source_branch = self
1671
result.target_branch = target
1672
result.old_revno, result.old_revid = target.last_revision_info()
1673
target.update_revisions(self, stop_revision, overwrite)
1674
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1675
result.new_revno, result.new_revid = target.last_revision_info()
1678
def get_parent(self):
1679
"""See Branch.get_parent."""
1680
parent = self._get_parent_location()
1683
# This is an old-format absolute path to a local branch
1684
# turn it into a url
1685
if parent.startswith('/'):
1686
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1688
return urlutils.join(self.base[:-1], parent)
1689
except errors.InvalidURLJoin, e:
1690
raise errors.InaccessibleParent(parent, self.base)
1692
def set_push_location(self, location):
1693
"""See Branch.set_push_location."""
1694
self.get_config().set_user_option(
1695
'push_location', location,
1696
store=_mod_config.STORE_LOCATION_NORECURSE)
1699
def set_parent(self, url):
1700
"""See Branch.set_parent."""
1701
# TODO: Maybe delete old location files?
1702
# URLs should never be unicode, even on the local fs,
1703
# FIXUP this and get_parent in a future branch format bump:
1704
# read and rewrite the file. RBC 20060125
1706
if isinstance(url, unicode):
1708
url = url.encode('ascii')
1709
except UnicodeEncodeError:
1710
raise errors.InvalidURL(url,
1711
"Urls must be 7-bit ascii, "
1712
"use bzrlib.urlutils.escape")
1713
url = urlutils.relative_url(self.base, url)
1714
self._set_parent_location(url)
1716
def _set_parent_location(self, url):
1718
self._transport.delete('parent')
1720
self._transport.put_bytes('parent', url + '\n',
1721
mode=self.control_files._file_mode)
1724
class BzrBranch5(BzrBranch):
1725
"""A format 5 branch. This supports new features over plain branches.
1727
It has support for a master_branch which is the data for bound branches.
1735
super(BzrBranch5, self).__init__(_format=_format,
1736
_control_files=_control_files,
1738
_repository=_repository)
1741
def pull(self, source, overwrite=False, stop_revision=None,
1742
run_hooks=True, possible_transports=None):
1743
"""Pull from source into self, updating my master if any.
1745
:param run_hooks: Private parameter - if false, this branch
1746
is being called because it's the master of the primary branch,
1747
so it should not run its hooks.
1749
bound_location = self.get_bound_location()
1750
master_branch = None
1751
if bound_location and source.base != bound_location:
1752
# not pulling from master, so we need to update master.
1753
master_branch = self.get_master_branch(possible_transports)
1754
master_branch.lock_write()
1757
# pull from source into master.
1758
master_branch.pull(source, overwrite, stop_revision,
1760
return super(BzrBranch5, self).pull(source, overwrite,
1761
stop_revision, _hook_master=master_branch,
1762
run_hooks=run_hooks)
1765
master_branch.unlock()
1767
def get_bound_location(self):
1769
return self._transport.get_bytes('bound')[:-1]
1770
except errors.NoSuchFile:
1774
def get_master_branch(self, possible_transports=None):
1775
"""Return the branch we are bound to.
1777
:return: Either a Branch, or None
1779
This could memoise the branch, but if thats done
1780
it must be revalidated on each new lock.
1781
So for now we just don't memoise it.
1782
# RBC 20060304 review this decision.
1784
bound_loc = self.get_bound_location()
1788
return Branch.open(bound_loc,
1789
possible_transports=possible_transports)
1790
except (errors.NotBranchError, errors.ConnectionError), e:
1791
raise errors.BoundBranchConnectionFailure(
1795
def set_bound_location(self, location):
1796
"""Set the target where this branch is bound to.
1798
:param location: URL to the target branch
1801
self._transport.put_bytes('bound', location+'\n',
1802
mode=self.bzrdir._get_file_mode())
1805
self._transport.delete('bound')
1806
except errors.NoSuchFile:
1811
def bind(self, other):
1812
"""Bind this branch to the branch other.
1814
This does not push or pull data between the branches, though it does
1815
check for divergence to raise an error when the branches are not
1816
either the same, or one a prefix of the other. That behaviour may not
1817
be useful, so that check may be removed in future.
1819
:param other: The branch to bind to
1822
# TODO: jam 20051230 Consider checking if the target is bound
1823
# It is debatable whether you should be able to bind to
1824
# a branch which is itself bound.
1825
# Committing is obviously forbidden,
1826
# but binding itself may not be.
1827
# Since we *have* to check at commit time, we don't
1828
# *need* to check here
1830
# we want to raise diverged if:
1831
# last_rev is not in the other_last_rev history, AND
1832
# other_last_rev is not in our history, and do it without pulling
1834
self.set_bound_location(other.base)
1838
"""If bound, unbind"""
1839
return self.set_bound_location(None)
1842
def update(self, possible_transports=None):
1843
"""Synchronise this branch with the master branch if any.
1845
:return: None or the last_revision that was pivoted out during the
1848
master = self.get_master_branch(possible_transports)
1849
if master is not None:
1850
old_tip = _mod_revision.ensure_null(self.last_revision())
1851
self.pull(master, overwrite=True)
1852
if self.repository.get_graph().is_ancestor(old_tip,
1853
_mod_revision.ensure_null(self.last_revision())):
1859
class BzrBranch6(BzrBranch5):
1861
def __init__(self, *args, **kwargs):
1862
super(BzrBranch6, self).__init__(*args, **kwargs)
1863
self._last_revision_info_cache = None
1864
self._partial_revision_history_cache = []
1866
def _clear_cached_state(self):
1867
super(BzrBranch6, self)._clear_cached_state()
1868
self._last_revision_info_cache = None
1869
self._partial_revision_history_cache = []
1872
def last_revision_info(self):
1873
"""Return information about the last revision.
1875
:return: A tuple (revno, revision_id).
1877
if self._last_revision_info_cache is None:
1878
self._last_revision_info_cache = self._last_revision_info()
1879
return self._last_revision_info_cache
1881
def _last_revision_info(self):
1882
revision_string = self._transport.get_bytes('last-revision')
1883
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1884
revision_id = cache_utf8.get_cached_utf8(revision_id)
1886
return revno, revision_id
1888
def _write_last_revision_info(self, revno, revision_id):
1889
"""Simply write out the revision id, with no checks.
1891
Use set_last_revision_info to perform this safely.
1893
Does not update the revision_history cache.
1894
Intended to be called by set_last_revision_info and
1895
_write_revision_history.
1897
revision_id = _mod_revision.ensure_null(revision_id)
1898
out_string = '%d %s\n' % (revno, revision_id)
1899
self._transport.put_bytes('last-revision', out_string,
1900
mode=self.control_files._file_mode)
1903
def set_last_revision_info(self, revno, revision_id):
1904
revision_id = _mod_revision.ensure_null(revision_id)
1905
old_revno, old_revid = self.last_revision_info()
1906
if self._get_append_revisions_only():
1907
self._check_history_violation(revision_id)
1908
self._write_last_revision_info(revno, revision_id)
1909
self._clear_cached_state()
1910
self._last_revision_info_cache = revno, revision_id
1911
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1913
def _check_history_violation(self, revision_id):
1914
last_revision = _mod_revision.ensure_null(self.last_revision())
1915
if _mod_revision.is_null(last_revision):
1917
if last_revision not in self._lefthand_history(revision_id):
1918
raise errors.AppendRevisionsOnlyViolation(self.base)
1920
def _gen_revision_history(self):
1921
"""Generate the revision history from last revision
1923
self._extend_partial_history()
1924
return list(reversed(self._partial_revision_history_cache))
1926
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1927
"""Extend the partial history to include a given index
1929
If a stop_index is supplied, stop when that index has been reached.
1930
If a stop_revision is supplied, stop when that revision is
1931
encountered. Otherwise, stop when the beginning of history is
1934
:param stop_index: The index which should be present. When it is
1935
present, history extension will stop.
1936
:param revision_id: The revision id which should be present. When
1937
it is encountered, history extension will stop.
1939
repo = self.repository
1940
if len(self._partial_revision_history_cache) == 0:
1941
iterator = repo.iter_reverse_revision_history(self.last_revision())
1943
start_revision = self._partial_revision_history_cache[-1]
1944
iterator = repo.iter_reverse_revision_history(start_revision)
1945
#skip the last revision in the list
1946
next_revision = iterator.next()
1947
for revision_id in iterator:
1948
self._partial_revision_history_cache.append(revision_id)
1949
if (stop_index is not None and
1950
len(self._partial_revision_history_cache) > stop_index):
1952
if revision_id == stop_revision:
1955
def _write_revision_history(self, history):
1956
"""Factored out of set_revision_history.
1958
This performs the actual writing to disk, with format-specific checks.
1959
It is intended to be called by BzrBranch5.set_revision_history.
1961
if len(history) == 0:
1962
last_revision = 'null:'
1964
if history != self._lefthand_history(history[-1]):
1965
raise errors.NotLefthandHistory(history)
1966
last_revision = history[-1]
1967
if self._get_append_revisions_only():
1968
self._check_history_violation(last_revision)
1969
self._write_last_revision_info(len(history), last_revision)
1972
def _set_parent_location(self, url):
1973
"""Set the parent branch"""
1974
self._set_config_location('parent_location', url, make_relative=True)
1977
def _get_parent_location(self):
1978
"""Set the parent branch"""
1979
return self._get_config_location('parent_location')
1981
def set_push_location(self, location):
1982
"""See Branch.set_push_location."""
1983
self._set_config_location('push_location', location)
1985
def set_bound_location(self, location):
1986
"""See Branch.set_push_location."""
1988
config = self.get_config()
1989
if location is None:
1990
if config.get_user_option('bound') != 'True':
1993
config.set_user_option('bound', 'False', warn_masked=True)
1996
self._set_config_location('bound_location', location,
1998
config.set_user_option('bound', 'True', warn_masked=True)
2001
def _get_bound_location(self, bound):
2002
"""Return the bound location in the config file.
2004
Return None if the bound parameter does not match"""
2005
config = self.get_config()
2006
config_bound = (config.get_user_option('bound') == 'True')
2007
if config_bound != bound:
2009
return self._get_config_location('bound_location', config=config)
2011
def get_bound_location(self):
2012
"""See Branch.set_push_location."""
2013
return self._get_bound_location(True)
2015
def get_old_bound_location(self):
2016
"""See Branch.get_old_bound_location"""
2017
return self._get_bound_location(False)
2019
def set_append_revisions_only(self, enabled):
2024
self.get_config().set_user_option('append_revisions_only', value,
2027
def _get_append_revisions_only(self):
2028
value = self.get_config().get_user_option('append_revisions_only')
2029
return value == 'True'
2031
def _synchronize_history(self, destination, revision_id):
2032
"""Synchronize last revision and revision history between branches.
2034
This version is most efficient when the destination is also a
2035
BzrBranch6, but works for BzrBranch5, as long as the destination's
2036
repository contains all the lefthand ancestors of the intended
2037
last_revision. If not, set_last_revision_info will fail.
2039
:param destination: The branch to copy the history into
2040
:param revision_id: The revision-id to truncate history at. May
2041
be None to copy complete history.
2043
source_revno, source_revision_id = self.last_revision_info()
2044
if revision_id is None:
2045
revno, revision_id = source_revno, source_revision_id
2046
elif source_revision_id == revision_id:
2047
# we know the revno without needing to walk all of history
2048
revno = source_revno
2050
# To figure out the revno for a random revision, we need to build
2051
# the revision history, and count its length.
2052
# We don't care about the order, just how long it is.
2053
# Alternatively, we could start at the current location, and count
2054
# backwards. But there is no guarantee that we will find it since
2055
# it may be a merged revision.
2056
revno = len(list(self.repository.iter_reverse_revision_history(
2058
destination.set_last_revision_info(revno, revision_id)
2060
def _make_tags(self):
2061
return BasicTags(self)
2064
def generate_revision_history(self, revision_id, last_rev=None,
2066
"""See BzrBranch5.generate_revision_history"""
2067
history = self._lefthand_history(revision_id, last_rev, other_branch)
2068
revno = len(history)
2069
self.set_last_revision_info(revno, revision_id)
2072
def get_rev_id(self, revno, history=None):
2073
"""Find the revision id of the specified revno."""
2075
return _mod_revision.NULL_REVISION
2077
last_revno, last_revision_id = self.last_revision_info()
2078
if revno <= 0 or revno > last_revno:
2079
raise errors.NoSuchRevision(self, revno)
2081
if history is not None:
2082
return history[revno - 1]
2084
index = last_revno - revno
2085
if len(self._partial_revision_history_cache) <= index:
2086
self._extend_partial_history(stop_index=index)
2087
if len(self._partial_revision_history_cache) > index:
2088
return self._partial_revision_history_cache[index]
2090
raise errors.NoSuchRevision(self, revno)
2093
def revision_id_to_revno(self, revision_id):
2094
"""Given a revision id, return its revno"""
2095
if _mod_revision.is_null(revision_id):
2098
index = self._partial_revision_history_cache.index(revision_id)
2100
self._extend_partial_history(stop_revision=revision_id)
2101
index = len(self._partial_revision_history_cache) - 1
2102
if self._partial_revision_history_cache[index] != revision_id:
2103
raise errors.NoSuchRevision(self, revision_id)
2104
return self.revno() - index
2107
######################################################################
2108
# results of operations
2111
class _Result(object):
2113
def _show_tag_conficts(self, to_file):
2114
if not getattr(self, 'tag_conflicts', None):
2116
to_file.write('Conflicting tags:\n')
2117
for name, value1, value2 in self.tag_conflicts:
2118
to_file.write(' %s\n' % (name, ))
2121
class PullResult(_Result):
2122
"""Result of a Branch.pull operation.
2124
:ivar old_revno: Revision number before pull.
2125
:ivar new_revno: Revision number after pull.
2126
:ivar old_revid: Tip revision id before pull.
2127
:ivar new_revid: Tip revision id after pull.
2128
:ivar source_branch: Source (local) branch object.
2129
:ivar master_branch: Master branch of the target, or None.
2130
:ivar target_branch: Target/destination branch object.
2134
# DEPRECATED: pull used to return the change in revno
2135
return self.new_revno - self.old_revno
2137
def report(self, to_file):
2139
if self.old_revid == self.new_revid:
2140
to_file.write('No revisions to pull.\n')
2142
to_file.write('Now on revision %d.\n' % self.new_revno)
2143
self._show_tag_conficts(to_file)
2146
class PushResult(_Result):
2147
"""Result of a Branch.push operation.
2149
:ivar old_revno: Revision number before push.
2150
:ivar new_revno: Revision number after push.
2151
:ivar old_revid: Tip revision id before push.
2152
:ivar new_revid: Tip revision id after push.
2153
:ivar source_branch: Source branch object.
2154
:ivar master_branch: Master branch of the target, or None.
2155
:ivar target_branch: Target/destination branch object.
2159
# DEPRECATED: push used to return the change in revno
2160
return self.new_revno - self.old_revno
2162
def report(self, to_file):
2163
"""Write a human-readable description of the result."""
2164
if self.old_revid == self.new_revid:
2165
to_file.write('No new revisions to push.\n')
2167
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2168
self._show_tag_conficts(to_file)
2171
class BranchCheckResult(object):
2172
"""Results of checking branch consistency.
2177
def __init__(self, branch):
2178
self.branch = branch
2180
def report_results(self, verbose):
2181
"""Report the check results via trace.note.
2183
:param verbose: Requests more detailed display of what was checked,
2186
note('checked branch %s format %s',
2188
self.branch._format)
2191
class Converter5to6(object):
2192
"""Perform an in-place upgrade of format 5 to format 6"""
2194
def convert(self, branch):
2195
# Data for 5 and 6 can peacefully coexist.
2196
format = BzrBranchFormat6()
2197
new_branch = format.open(branch.bzrdir, _found=True)
2199
# Copy source data into target
2200
new_branch._write_last_revision_info(*branch.last_revision_info())
2201
new_branch.set_parent(branch.get_parent())
2202
new_branch.set_bound_location(branch.get_bound_location())
2203
new_branch.set_push_location(branch.get_push_location())
2205
# New branch has no tags by default
2206
new_branch.tags._set_tag_dict({})
2208
# Copying done; now update target format
2209
new_branch._transport.put_bytes('format',
2210
format.get_format_string(),
2211
mode=new_branch.control_files._file_mode)
2213
# Clean up old files
2214
new_branch._transport.delete('revision-history')
2216
branch.set_parent(None)
2217
except errors.NoSuchFile:
2219
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
