1
# Copyright (C) 2005, 2006, 2007 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 (deprecated_method,
47
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
50
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
51
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
52
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
55
# TODO: Maybe include checks for common corruption of newlines, etc?
57
# TODO: Some operations like log might retrieve the same revisions
58
# repeatedly to calculate deltas. We could perhaps have a weakref
59
# cache in memory to make this faster. In general anything can be
60
# cached in memory between lock and unlock operations. .. nb thats
61
# what the transaction identity map provides
64
######################################################################
68
"""Branch holding a history of revisions.
71
Base directory/url of the branch.
73
hooks: An instance of BranchHooks.
75
# this is really an instance variable - FIXME move it there
79
# override this to set the strategy for storing tags
81
return DisabledTags(self)
83
def __init__(self, *ignored, **ignored_too):
84
self.tags = self._make_tags()
85
self._revision_history_cache = None
86
self._revision_id_to_revno_cache = None
89
"""Break a lock if one is present from another instance.
91
Uses the ui factory to ask for confirmation if the lock may be from
94
This will probe the repository for its lock as well.
96
self.control_files.break_lock()
97
self.repository.break_lock()
98
master = self.get_master_branch()
99
if master is not None:
103
def open(base, _unsupported=False, possible_transports=None):
104
"""Open the branch rooted at base.
106
For instance, if the branch is at URL/.bzr/branch,
107
Branch.open(URL) -> a Branch instance.
109
control = bzrdir.BzrDir.open(base, _unsupported,
110
possible_transports=possible_transports)
111
return control.open_branch(_unsupported)
114
def open_from_transport(transport, _unsupported=False):
115
"""Open the branch rooted at transport"""
116
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
117
return control.open_branch(_unsupported)
120
def open_containing(url, possible_transports=None):
121
"""Open an existing branch which contains url.
123
This probes for a branch at url, and searches upwards from there.
125
Basically we keep looking up until we find the control directory or
126
run into the root. If there isn't one, raises NotBranchError.
127
If there is one and it is either an unrecognised format or an unsupported
128
format, UnknownFormatError or UnsupportedFormatError are raised.
129
If there is one, it is returned, along with the unused portion of url.
131
control, relpath = bzrdir.BzrDir.open_containing(url,
133
return control.open_branch(), relpath
135
def get_config(self):
136
return BranchConfig(self)
139
return self.get_config().get_nickname()
141
def _set_nick(self, nick):
142
self.get_config().set_user_option('nickname', nick, warn_masked=True)
144
nick = property(_get_nick, _set_nick)
147
raise NotImplementedError(self.is_locked)
149
def lock_write(self):
150
raise NotImplementedError(self.lock_write)
153
raise NotImplementedError(self.lock_read)
156
raise NotImplementedError(self.unlock)
158
def peek_lock_mode(self):
159
"""Return lock mode for the Branch: 'r', 'w' or None"""
160
raise NotImplementedError(self.peek_lock_mode)
162
def get_physical_lock_status(self):
163
raise NotImplementedError(self.get_physical_lock_status)
166
def get_revision_id_to_revno_map(self):
167
"""Return the revision_id => dotted revno map.
169
This will be regenerated on demand, but will be cached.
171
:return: A dictionary mapping revision_id => dotted revno.
172
This dictionary should not be modified by the caller.
174
if self._revision_id_to_revno_cache is not None:
175
mapping = self._revision_id_to_revno_cache
177
mapping = self._gen_revno_map()
178
self._cache_revision_id_to_revno(mapping)
179
# TODO: jam 20070417 Since this is being cached, should we be returning
181
# I would rather not, and instead just declare that users should not
182
# modify the return value.
185
def _gen_revno_map(self):
186
"""Create a new mapping from revision ids to dotted revnos.
188
Dotted revnos are generated based on the current tip in the revision
190
This is the worker function for get_revision_id_to_revno_map, which
191
just caches the return value.
193
:return: A dictionary mapping revision_id => dotted revno.
195
last_revision = self.last_revision()
196
revision_graph = repository._old_get_graph(self.repository,
198
merge_sorted_revisions = tsort.merge_sort(
203
revision_id_to_revno = dict((rev_id, revno)
204
for seq_num, rev_id, depth, revno, end_of_merge
205
in merge_sorted_revisions)
206
return revision_id_to_revno
208
def leave_lock_in_place(self):
209
"""Tell this branch object not to release the physical lock when this
212
If lock_write doesn't return a token, then this method is not supported.
214
self.control_files.leave_in_place()
216
def dont_leave_lock_in_place(self):
217
"""Tell this branch object to release the physical lock when this
218
object is unlocked, even if it didn't originally acquire it.
220
If lock_write doesn't return a token, then this method is not supported.
222
self.control_files.dont_leave_in_place()
224
def abspath(self, name):
225
"""Return absolute filename for something in the branch
227
XXX: Robert Collins 20051017 what is this used for? why is it a branch
228
method and not a tree method.
230
raise NotImplementedError(self.abspath)
232
def bind(self, other):
233
"""Bind the local branch the other branch.
235
:param other: The branch to bind to
238
raise errors.UpgradeRequired(self.base)
241
def fetch(self, from_branch, last_revision=None, pb=None):
242
"""Copy revisions from from_branch into this branch.
244
:param from_branch: Where to copy from.
245
:param last_revision: What revision to stop at (None for at the end
247
:param pb: An optional progress bar to use.
249
Returns the copied revision count and the failed revisions in a tuple:
252
if self.base == from_branch.base:
255
nested_pb = ui.ui_factory.nested_progress_bar()
260
from_branch.lock_read()
262
if last_revision is None:
263
pb.update('get source history')
264
last_revision = from_branch.last_revision()
265
last_revision = _mod_revision.ensure_null(last_revision)
266
return self.repository.fetch(from_branch.repository,
267
revision_id=last_revision,
270
if nested_pb is not None:
274
def get_bound_location(self):
275
"""Return the URL of the branch we are bound to.
277
Older format branches cannot bind, please be sure to use a metadir
282
def get_old_bound_location(self):
283
"""Return the URL of the branch we used to be bound to
285
raise errors.UpgradeRequired(self.base)
287
def get_commit_builder(self, parents, config=None, timestamp=None,
288
timezone=None, committer=None, revprops=None,
290
"""Obtain a CommitBuilder for this branch.
292
:param parents: Revision ids of the parents of the new revision.
293
:param config: Optional configuration to use.
294
:param timestamp: Optional timestamp recorded for commit.
295
:param timezone: Optional timezone for timestamp.
296
:param committer: Optional committer to set for commit.
297
:param revprops: Optional dictionary of revision properties.
298
:param revision_id: Optional revision id.
302
config = self.get_config()
304
return self.repository.get_commit_builder(self, parents, config,
305
timestamp, timezone, committer, revprops, revision_id)
307
def get_master_branch(self, possible_transports=None):
308
"""Return the branch we are bound to.
310
:return: Either a Branch, or None
314
def get_revision_delta(self, revno):
315
"""Return the delta for one revision.
317
The delta is relative to its mainline predecessor, or the
318
empty tree for revision 1.
320
assert isinstance(revno, int)
321
rh = self.revision_history()
322
if not (1 <= revno <= len(rh)):
323
raise errors.InvalidRevisionNumber(revno)
324
return self.repository.get_revision_delta(rh[revno-1])
326
@deprecated_method(zero_sixteen)
327
def get_root_id(self):
328
"""Return the id of this branches root
330
Deprecated: branches don't have root ids-- trees do.
331
Use basis_tree().get_root_id() instead.
333
raise NotImplementedError(self.get_root_id)
335
def print_file(self, file, revision_id):
336
"""Print `file` to stdout."""
337
raise NotImplementedError(self.print_file)
339
def set_revision_history(self, rev_history):
340
raise NotImplementedError(self.set_revision_history)
342
def _cache_revision_history(self, rev_history):
343
"""Set the cached revision history to rev_history.
345
The revision_history method will use this cache to avoid regenerating
346
the revision history.
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_history_cache = rev_history
353
def _cache_revision_id_to_revno(self, revision_id_to_revno):
354
"""Set the cached revision_id => revno map to revision_id_to_revno.
356
This API is semi-public; it only for use by subclasses, all other code
357
should consider it to be private.
359
self._revision_id_to_revno_cache = revision_id_to_revno
361
def _clear_cached_state(self):
362
"""Clear any cached data on this branch, e.g. cached revision history.
364
This means the next call to revision_history will need to call
365
_gen_revision_history.
367
This API is semi-public; it only for use by subclasses, all other code
368
should consider it to be private.
370
self._revision_history_cache = None
371
self._revision_id_to_revno_cache = None
373
def _gen_revision_history(self):
374
"""Return sequence of revision hashes on to this branch.
376
Unlike revision_history, this method always regenerates or rereads the
377
revision history, i.e. it does not cache the result, so repeated calls
380
Concrete subclasses should override this instead of revision_history so
381
that subclasses do not need to deal with caching logic.
383
This API is semi-public; it only for use by subclasses, all other code
384
should consider it to be private.
386
raise NotImplementedError(self._gen_revision_history)
389
def revision_history(self):
390
"""Return sequence of revision ids on this branch.
392
This method will cache the revision history for as long as it is safe to
395
if 'evil' in debug.debug_flags:
396
mutter_callsite(3, "revision_history scales with history.")
397
if self._revision_history_cache is not None:
398
history = self._revision_history_cache
400
history = self._gen_revision_history()
401
self._cache_revision_history(history)
405
"""Return current revision number for this branch.
407
That is equivalent to the number of revisions committed to
410
return self.last_revision_info()[0]
413
"""Older format branches cannot bind or unbind."""
414
raise errors.UpgradeRequired(self.base)
416
def set_append_revisions_only(self, enabled):
417
"""Older format branches are never restricted to append-only"""
418
raise errors.UpgradeRequired(self.base)
420
def last_revision(self):
421
"""Return last revision id, or NULL_REVISION."""
422
return self.last_revision_info()[1]
424
def last_revision_info(self):
425
"""Return information about the last revision.
427
:return: A tuple (revno, last_revision_id).
429
rh = self.revision_history()
432
return (revno, rh[-1])
434
return (0, _mod_revision.NULL_REVISION)
436
def missing_revisions(self, other, stop_revision=None):
437
"""Return a list of new revisions that would perfectly fit.
439
If self and other have not diverged, return a list of the revisions
440
present in other, but missing from self.
442
self_history = self.revision_history()
443
self_len = len(self_history)
444
other_history = other.revision_history()
445
other_len = len(other_history)
446
common_index = min(self_len, other_len) -1
447
if common_index >= 0 and \
448
self_history[common_index] != other_history[common_index]:
449
raise errors.DivergedBranches(self, other)
451
if stop_revision is None:
452
stop_revision = other_len
454
assert isinstance(stop_revision, int)
455
if stop_revision > other_len:
456
raise errors.NoSuchRevision(self, stop_revision)
457
return other_history[self_len:stop_revision]
459
def update_revisions(self, other, stop_revision=None):
460
"""Pull in new perfect-fit revisions.
462
:param other: Another Branch to pull from
463
:param stop_revision: Updated until the given revision
466
raise NotImplementedError(self.update_revisions)
468
def revision_id_to_revno(self, revision_id):
469
"""Given a revision id, return its revno"""
470
if _mod_revision.is_null(revision_id):
472
history = self.revision_history()
474
return history.index(revision_id) + 1
476
raise errors.NoSuchRevision(self, revision_id)
478
def get_rev_id(self, revno, history=None):
479
"""Find the revision id of the specified revno."""
481
return _mod_revision.NULL_REVISION
483
history = self.revision_history()
484
if revno <= 0 or revno > len(history):
485
raise errors.NoSuchRevision(self, revno)
486
return history[revno - 1]
488
def pull(self, source, overwrite=False, stop_revision=None,
489
possible_transports=None):
490
"""Mirror source into this branch.
492
This branch is considered to be 'local', having low latency.
494
:returns: PullResult instance
496
raise NotImplementedError(self.pull)
498
def push(self, target, overwrite=False, stop_revision=None):
499
"""Mirror this branch into target.
501
This branch is considered to be 'local', having low latency.
503
raise NotImplementedError(self.push)
505
def basis_tree(self):
506
"""Return `Tree` object for last revision."""
507
return self.repository.revision_tree(self.last_revision())
509
def rename_one(self, from_rel, to_rel):
512
This can change the directory or the filename or both.
514
raise NotImplementedError(self.rename_one)
516
def move(self, from_paths, to_name):
519
to_name must exist as a versioned directory.
521
If to_name exists and is a directory, the files are moved into
522
it, keeping their old names. If it is a directory,
524
Note that to_name is only the last component of the new name;
525
this doesn't change the directory.
527
This returns a list of (from_path, to_path) pairs for each
530
raise NotImplementedError(self.move)
532
def get_parent(self):
533
"""Return the parent location of the branch.
535
This is the default location for push/pull/missing. The usual
536
pattern is that the user can override it by specifying a
539
raise NotImplementedError(self.get_parent)
541
def _set_config_location(self, name, url, config=None,
542
make_relative=False):
544
config = self.get_config()
548
url = urlutils.relative_url(self.base, url)
549
config.set_user_option(name, url, warn_masked=True)
551
def _get_config_location(self, name, config=None):
553
config = self.get_config()
554
location = config.get_user_option(name)
559
def get_submit_branch(self):
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
return self.get_config().get_user_option('submit_branch')
568
def set_submit_branch(self, location):
569
"""Return the submit location of the branch.
571
This is the default location for bundle. The usual
572
pattern is that the user can override it by specifying a
575
self.get_config().set_user_option('submit_branch', location,
578
def get_public_branch(self):
579
"""Return the public location of the branch.
581
This is is used by merge directives.
583
return self._get_config_location('public_branch')
585
def set_public_branch(self, location):
586
"""Return the submit location of the branch.
588
This is the default location for bundle. The usual
589
pattern is that the user can override it by specifying a
592
self._set_config_location('public_branch', location)
594
def get_push_location(self):
595
"""Return the None or the location to push this branch to."""
596
push_loc = self.get_config().get_user_option('push_location')
599
def set_push_location(self, location):
600
"""Set a new push location for this branch."""
601
raise NotImplementedError(self.set_push_location)
603
def set_parent(self, url):
604
raise NotImplementedError(self.set_parent)
608
"""Synchronise this branch with the master branch if any.
610
:return: None or the last_revision pivoted out during the update.
614
def check_revno(self, revno):
616
Check whether a revno corresponds to any revision.
617
Zero (the NULL revision) is considered valid.
620
self.check_real_revno(revno)
622
def check_real_revno(self, revno):
624
Check whether a revno corresponds to a real revision.
625
Zero (the NULL revision) is considered invalid
627
if revno < 1 or revno > self.revno():
628
raise errors.InvalidRevisionNumber(revno)
631
def clone(self, to_bzrdir, revision_id=None):
632
"""Clone this branch into to_bzrdir preserving all semantic values.
634
revision_id: if not None, the revision history in the new branch will
635
be truncated to end with revision_id.
637
result = self._format.initialize(to_bzrdir)
638
self.copy_content_into(result, revision_id=revision_id)
642
def sprout(self, to_bzrdir, revision_id=None):
643
"""Create a new line of development from the branch, into to_bzrdir.
645
revision_id: if not None, the revision history in the new branch will
646
be truncated to end with revision_id.
648
result = self._format.initialize(to_bzrdir)
649
self.copy_content_into(result, revision_id=revision_id)
650
result.set_parent(self.bzrdir.root_transport.base)
653
def _synchronize_history(self, destination, revision_id):
654
"""Synchronize last revision and revision history between branches.
656
This version is most efficient when the destination is also a
657
BzrBranch5, but works for BzrBranch6 as long as the revision
658
history is the true lefthand parent history, and all of the revisions
659
are in the destination's repository. If not, set_revision_history
662
:param destination: The branch to copy the history into
663
:param revision_id: The revision-id to truncate history at. May
664
be None to copy complete history.
666
if revision_id == _mod_revision.NULL_REVISION:
668
new_history = self.revision_history()
669
if revision_id is not None and new_history != []:
671
new_history = new_history[:new_history.index(revision_id) + 1]
673
rev = self.repository.get_revision(revision_id)
674
new_history = rev.get_history(self.repository)[1:]
675
destination.set_revision_history(new_history)
678
def copy_content_into(self, destination, revision_id=None):
679
"""Copy the content of self into destination.
681
revision_id: if not None, the revision history in the new branch will
682
be truncated to end with revision_id.
684
self._synchronize_history(destination, revision_id)
686
parent = self.get_parent()
687
except errors.InaccessibleParent, e:
688
mutter('parent was not accessible to copy: %s', e)
691
destination.set_parent(parent)
692
self.tags.merge_to(destination.tags)
696
"""Check consistency of the branch.
698
In particular this checks that revisions given in the revision-history
699
do actually match up in the revision graph, and that they're all
700
present in the repository.
702
Callers will typically also want to check the repository.
704
:return: A BranchCheckResult.
706
mainline_parent_id = None
707
for revision_id in self.revision_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),
786
def reference_parent(self, file_id, path):
787
"""Return the parent branch for a tree-reference file_id
788
:param file_id: The file_id of the tree reference
789
:param path: The path of the file_id in the tree
790
:return: A branch associated with the file_id
792
# FIXME should provide multiple branches, based on config
793
return Branch.open(self.bzrdir.root_transport.clone(path).base)
795
def supports_tags(self):
796
return self._format.supports_tags()
799
class BranchFormat(object):
800
"""An encapsulation of the initialization and open routines for a format.
802
Formats provide three things:
803
* An initialization routine,
807
Formats are placed in an dict by their format string for reference
808
during branch opening. Its not required that these be instances, they
809
can be classes themselves with class methods - it simply depends on
810
whether state is needed for a given format or not.
812
Once a format is deprecated, just deprecate the initialize and open
813
methods on the format class. Do not deprecate the object, as the
814
object will be created every time regardless.
817
_default_format = None
818
"""The default format used for new branches."""
821
"""The known formats."""
823
def __eq__(self, other):
824
return self.__class__ is other.__class__
826
def __ne__(self, other):
827
return not (self == other)
830
def find_format(klass, a_bzrdir):
831
"""Return the format for the branch object in a_bzrdir."""
833
transport = a_bzrdir.get_branch_transport(None)
834
format_string = transport.get("format").read()
835
return klass._formats[format_string]
836
except errors.NoSuchFile:
837
raise errors.NotBranchError(path=transport.base)
839
raise errors.UnknownFormatError(format=format_string, kind='branch')
842
def get_default_format(klass):
843
"""Return the current default format."""
844
return klass._default_format
846
def get_reference(self, a_bzrdir):
847
"""Get the target reference of the branch in a_bzrdir.
849
format probing must have been completed before calling
850
this method - it is assumed that the format of the branch
851
in a_bzrdir is correct.
853
:param a_bzrdir: The bzrdir to get the branch data from.
854
:return: None if the branch is not a reference branch.
859
def set_reference(self, a_bzrdir, to_branch):
860
"""Set the target reference of the branch in a_bzrdir.
862
format probing must have been completed before calling
863
this method - it is assumed that the format of the branch
864
in a_bzrdir is correct.
866
:param a_bzrdir: The bzrdir to set the branch reference for.
867
:param to_branch: branch that the checkout is to reference
869
raise NotImplementedError(self.set_reference)
871
def get_format_string(self):
872
"""Return the ASCII format string that identifies this format."""
873
raise NotImplementedError(self.get_format_string)
875
def get_format_description(self):
876
"""Return the short format description for this format."""
877
raise NotImplementedError(self.get_format_description)
879
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
881
"""Initialize a branch in a bzrdir, with specified files
883
:param a_bzrdir: The bzrdir to initialize the branch in
884
:param utf8_files: The files to create as a list of
885
(filename, content) tuples
886
:param set_format: If True, set the format with
887
self.get_format_string. (BzrBranch4 has its format set
889
:return: a branch in this format
891
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
892
branch_transport = a_bzrdir.get_branch_transport(self)
894
'metadir': ('lock', lockdir.LockDir),
895
'branch4': ('branch-lock', lockable_files.TransportLock),
897
lock_name, lock_class = lock_map[lock_type]
898
control_files = lockable_files.LockableFiles(branch_transport,
899
lock_name, lock_class)
900
control_files.create_lock()
901
control_files.lock_write()
903
control_files.put_utf8('format', self.get_format_string())
905
for file, content in utf8_files:
906
control_files.put_utf8(file, content)
908
control_files.unlock()
909
return self.open(a_bzrdir, _found=True)
911
def initialize(self, a_bzrdir):
912
"""Create a branch of this format in a_bzrdir."""
913
raise NotImplementedError(self.initialize)
915
def is_supported(self):
916
"""Is this format supported?
918
Supported formats can be initialized and opened.
919
Unsupported formats may not support initialization or committing or
920
some other features depending on the reason for not being supported.
924
def open(self, a_bzrdir, _found=False):
925
"""Return the branch object for a_bzrdir
927
_found is a private parameter, do not use it. It is used to indicate
928
if format probing has already be done.
930
raise NotImplementedError(self.open)
933
def register_format(klass, format):
934
klass._formats[format.get_format_string()] = format
937
def set_default_format(klass, format):
938
klass._default_format = format
941
def unregister_format(klass, format):
942
assert klass._formats[format.get_format_string()] is format
943
del klass._formats[format.get_format_string()]
946
return self.get_format_string().rstrip()
948
def supports_tags(self):
949
"""True if this format supports tags stored in the branch"""
950
return False # by default
952
# XXX: Probably doesn't really belong here -- mbp 20070212
953
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
955
branch_transport = a_bzrdir.get_branch_transport(self)
956
control_files = lockable_files.LockableFiles(branch_transport,
957
lock_filename, lock_class)
958
control_files.create_lock()
959
control_files.lock_write()
961
for filename, content in utf8_files:
962
control_files.put_utf8(filename, content)
964
control_files.unlock()
967
class BranchHooks(Hooks):
968
"""A dictionary mapping hook name to a list of callables for branch hooks.
970
e.g. ['set_rh'] Is the list of items to be called when the
971
set_revision_history function is invoked.
975
"""Create the default hooks.
977
These are all empty initially, because by default nothing should get
981
# Introduced in 0.15:
982
# invoked whenever the revision history has been set
983
# with set_revision_history. The api signature is
984
# (branch, revision_history), and the branch will
987
# invoked after a push operation completes.
988
# the api signature is
990
# containing the members
991
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
992
# where local is the local target branch or None, master is the target
993
# master branch, and the rest should be self explanatory. The source
994
# is read locked and the target branches write locked. Source will
995
# be the local low-latency branch.
996
self['post_push'] = []
997
# invoked after a pull operation completes.
998
# the api signature is
1000
# containing the members
1001
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1002
# where local is the local branch or None, master is the target
1003
# master branch, and the rest should be self explanatory. The source
1004
# is read locked and the target branches write locked. The local
1005
# branch is the low-latency branch.
1006
self['post_pull'] = []
1007
# invoked before a commit operation takes place.
1008
# the api signature is
1009
# (local, master, old_revno, old_revid, future_revno, future_revid,
1010
# tree_delta, future_tree).
1011
# old_revid is NULL_REVISION for the first commit to a branch
1012
# tree_delta is a TreeDelta object describing changes from the basis
1013
# revision, hooks MUST NOT modify this delta
1014
# future_tree is an in-memory tree obtained from
1015
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1016
self['pre_commit'] = []
1017
# invoked after a commit operation completes.
1018
# the api signature is
1019
# (local, master, old_revno, old_revid, new_revno, new_revid)
1020
# old_revid is NULL_REVISION for the first commit to a branch.
1021
self['post_commit'] = []
1022
# invoked after a uncommit operation completes.
1023
# the api signature is
1024
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1025
# local is the local branch or None, master is the target branch,
1026
# and an empty branch recieves new_revno of 0, new_revid of None.
1027
self['post_uncommit'] = []
1029
# Invoked after the tip of a branch changes.
1030
# the api signature is
1031
# (params) where params is a ChangeBranchTipParams with the members
1032
# (branch, old_revno, new_revno, old_revid, new_revid)
1033
self['post_change_branch_tip'] = []
1036
# install the default hooks into the Branch class.
1037
Branch.hooks = BranchHooks()
1040
class ChangeBranchTipParams(object):
1041
"""Object holding parameters passed to *_change_branch_tip hooks.
1043
There are 5 fields that hooks may wish to access:
1045
:ivar branch: the branch being changed
1046
:ivar old_revno: revision number before the change
1047
:ivar new_revno: revision number after the change
1048
:ivar old_revid: revision id before the change
1049
:ivar new_revid: revision id after the change
1051
The revid fields are strings. The revno fields are integers.
1054
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1055
"""Create a group of ChangeBranchTip parameters.
1057
:param branch: The branch being changed.
1058
:param old_revno: Revision number before the change.
1059
:param new_revno: Revision number after the change.
1060
:param old_revid: Tip revision id before the change.
1061
:param new_revid: Tip revision id after the change.
1063
self.branch = branch
1064
self.old_revno = old_revno
1065
self.new_revno = new_revno
1066
self.old_revid = old_revid
1067
self.new_revid = new_revid
1070
class BzrBranchFormat4(BranchFormat):
1071
"""Bzr branch format 4.
1074
- a revision-history file.
1075
- a branch-lock lock file [ to be shared with the bzrdir ]
1078
def get_format_description(self):
1079
"""See BranchFormat.get_format_description()."""
1080
return "Branch format 4"
1082
def initialize(self, a_bzrdir):
1083
"""Create a branch of this format in a_bzrdir."""
1084
utf8_files = [('revision-history', ''),
1085
('branch-name', ''),
1087
return self._initialize_helper(a_bzrdir, utf8_files,
1088
lock_type='branch4', set_format=False)
1091
super(BzrBranchFormat4, self).__init__()
1092
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1094
def open(self, a_bzrdir, _found=False):
1095
"""Return the branch object for a_bzrdir
1097
_found is a private parameter, do not use it. It is used to indicate
1098
if format probing has already be done.
1101
# we are being called directly and must probe.
1102
raise NotImplementedError
1103
return BzrBranch(_format=self,
1104
_control_files=a_bzrdir._control_files,
1106
_repository=a_bzrdir.open_repository())
1109
return "Bazaar-NG branch format 4"
1112
class BzrBranchFormat5(BranchFormat):
1113
"""Bzr branch format 5.
1116
- a revision-history file.
1118
- a lock dir guarding the branch itself
1119
- all of this stored in a branch/ subdirectory
1120
- works with shared repositories.
1122
This format is new in bzr 0.8.
1125
def get_format_string(self):
1126
"""See BranchFormat.get_format_string()."""
1127
return "Bazaar-NG branch format 5\n"
1129
def get_format_description(self):
1130
"""See BranchFormat.get_format_description()."""
1131
return "Branch format 5"
1133
def initialize(self, a_bzrdir):
1134
"""Create a branch of this format in a_bzrdir."""
1135
utf8_files = [('revision-history', ''),
1136
('branch-name', ''),
1138
return self._initialize_helper(a_bzrdir, utf8_files)
1141
super(BzrBranchFormat5, self).__init__()
1142
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1144
def open(self, a_bzrdir, _found=False):
1145
"""Return the branch object for a_bzrdir
1147
_found is a private parameter, do not use it. It is used to indicate
1148
if format probing has already be done.
1151
format = BranchFormat.find_format(a_bzrdir)
1152
assert format.__class__ == self.__class__
1154
transport = a_bzrdir.get_branch_transport(None)
1155
control_files = lockable_files.LockableFiles(transport, 'lock',
1157
return BzrBranch5(_format=self,
1158
_control_files=control_files,
1160
_repository=a_bzrdir.find_repository())
1161
except errors.NoSuchFile:
1162
raise errors.NotBranchError(path=transport.base)
1165
class BzrBranchFormat6(BzrBranchFormat5):
1166
"""Branch format with last-revision and tags.
1168
Unlike previous formats, this has no explicit revision history. Instead,
1169
this just stores the last-revision, and the left-hand history leading
1170
up to there is the history.
1172
This format was introduced in bzr 0.15
1173
and became the default in 0.91.
1176
def get_format_string(self):
1177
"""See BranchFormat.get_format_string()."""
1178
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1180
def get_format_description(self):
1181
"""See BranchFormat.get_format_description()."""
1182
return "Branch format 6"
1184
def initialize(self, a_bzrdir):
1185
"""Create a branch of this format in a_bzrdir."""
1186
utf8_files = [('last-revision', '0 null:\n'),
1187
('branch.conf', ''),
1190
return self._initialize_helper(a_bzrdir, utf8_files)
1192
def open(self, a_bzrdir, _found=False):
1193
"""Return the branch object for a_bzrdir
1195
_found is a private parameter, do not use it. It is used to indicate
1196
if format probing has already be done.
1199
format = BranchFormat.find_format(a_bzrdir)
1200
assert format.__class__ == self.__class__
1201
transport = a_bzrdir.get_branch_transport(None)
1202
control_files = lockable_files.LockableFiles(transport, 'lock',
1204
return BzrBranch6(_format=self,
1205
_control_files=control_files,
1207
_repository=a_bzrdir.find_repository())
1209
def supports_tags(self):
1213
class BranchReferenceFormat(BranchFormat):
1214
"""Bzr branch reference format.
1216
Branch references are used in implementing checkouts, they
1217
act as an alias to the real branch which is at some other url.
1224
def get_format_string(self):
1225
"""See BranchFormat.get_format_string()."""
1226
return "Bazaar-NG Branch Reference Format 1\n"
1228
def get_format_description(self):
1229
"""See BranchFormat.get_format_description()."""
1230
return "Checkout reference format 1"
1232
def get_reference(self, a_bzrdir):
1233
"""See BranchFormat.get_reference()."""
1234
transport = a_bzrdir.get_branch_transport(None)
1235
return transport.get('location').read()
1237
def set_reference(self, a_bzrdir, to_branch):
1238
"""See BranchFormat.set_reference()."""
1239
transport = a_bzrdir.get_branch_transport(None)
1240
location = transport.put_bytes('location', to_branch.base)
1242
def initialize(self, a_bzrdir, target_branch=None):
1243
"""Create a branch of this format in a_bzrdir."""
1244
if target_branch is None:
1245
# this format does not implement branch itself, thus the implicit
1246
# creation contract must see it as uninitializable
1247
raise errors.UninitializableFormat(self)
1248
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1249
branch_transport = a_bzrdir.get_branch_transport(self)
1250
branch_transport.put_bytes('location',
1251
target_branch.bzrdir.root_transport.base)
1252
branch_transport.put_bytes('format', self.get_format_string())
1254
a_bzrdir, _found=True,
1255
possible_transports=[target_branch.bzrdir.root_transport])
1258
super(BranchReferenceFormat, self).__init__()
1259
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1261
def _make_reference_clone_function(format, a_branch):
1262
"""Create a clone() routine for a branch dynamically."""
1263
def clone(to_bzrdir, revision_id=None):
1264
"""See Branch.clone()."""
1265
return format.initialize(to_bzrdir, a_branch)
1266
# cannot obey revision_id limits when cloning a reference ...
1267
# FIXME RBC 20060210 either nuke revision_id for clone, or
1268
# emit some sort of warning/error to the caller ?!
1271
def open(self, a_bzrdir, _found=False, location=None,
1272
possible_transports=None):
1273
"""Return the branch that the branch reference in a_bzrdir points at.
1275
_found is a private parameter, do not use it. It is used to indicate
1276
if format probing has already be done.
1279
format = BranchFormat.find_format(a_bzrdir)
1280
assert format.__class__ == self.__class__
1281
if location is None:
1282
location = self.get_reference(a_bzrdir)
1283
real_bzrdir = bzrdir.BzrDir.open(
1284
location, possible_transports=possible_transports)
1285
result = real_bzrdir.open_branch()
1286
# this changes the behaviour of result.clone to create a new reference
1287
# rather than a copy of the content of the branch.
1288
# I did not use a proxy object because that needs much more extensive
1289
# testing, and we are only changing one behaviour at the moment.
1290
# If we decide to alter more behaviours - i.e. the implicit nickname
1291
# then this should be refactored to introduce a tested proxy branch
1292
# and a subclass of that for use in overriding clone() and ....
1294
result.clone = self._make_reference_clone_function(result)
1298
# formats which have no format string are not discoverable
1299
# and not independently creatable, so are not registered.
1300
__format5 = BzrBranchFormat5()
1301
__format6 = BzrBranchFormat6()
1302
BranchFormat.register_format(__format5)
1303
BranchFormat.register_format(BranchReferenceFormat())
1304
BranchFormat.register_format(__format6)
1305
BranchFormat.set_default_format(__format6)
1306
_legacy_formats = [BzrBranchFormat4(),
1309
class BzrBranch(Branch):
1310
"""A branch stored in the actual filesystem.
1312
Note that it's "local" in the context of the filesystem; it doesn't
1313
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1314
it's writable, and can be accessed via the normal filesystem API.
1317
def __init__(self, _format=None,
1318
_control_files=None, a_bzrdir=None, _repository=None):
1319
"""Create new branch object at a particular location."""
1320
Branch.__init__(self)
1321
if a_bzrdir is None:
1322
raise ValueError('a_bzrdir must be supplied')
1324
self.bzrdir = a_bzrdir
1325
# self._transport used to point to the directory containing the
1326
# control directory, but was not used - now it's just the transport
1327
# for the branch control files. mbp 20070212
1328
self._base = self.bzrdir.transport.clone('..').base
1329
self._format = _format
1330
if _control_files is None:
1331
raise ValueError('BzrBranch _control_files is None')
1332
self.control_files = _control_files
1333
self._transport = _control_files._transport
1334
self.repository = _repository
1337
return '%s(%r)' % (self.__class__.__name__, self.base)
1341
def _get_base(self):
1342
"""Returns the directory containing the control directory."""
1345
base = property(_get_base, doc="The URL for the root of this branch.")
1347
def abspath(self, name):
1348
"""See Branch.abspath."""
1349
return self.control_files._transport.abspath(name)
1352
@deprecated_method(zero_sixteen)
1354
def get_root_id(self):
1355
"""See Branch.get_root_id."""
1356
tree = self.repository.revision_tree(self.last_revision())
1357
return tree.get_root_id()
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.control_files.put_bytes(
1409
'revision-history', '\n'.join(history))
1412
def set_revision_history(self, rev_history):
1413
"""See Branch.set_revision_history."""
1414
if 'evil' in debug.debug_flags:
1415
mutter_callsite(3, "set_revision_history scales with history.")
1416
self._write_revision_history(rev_history)
1417
self._clear_cached_state()
1418
self._cache_revision_history(rev_history)
1419
for hook in Branch.hooks['set_rh']:
1420
hook(self, rev_history)
1422
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1423
"""Run the post_change_branch_tip hooks."""
1424
hooks = Branch.hooks['post_change_branch_tip']
1427
new_revno, new_revid = self.last_revision_info()
1428
params = ChangeBranchTipParams(
1429
self, old_revno, new_revno, old_revid, new_revid)
1434
def set_last_revision_info(self, revno, revision_id):
1435
"""Set the last revision of this branch.
1437
The caller is responsible for checking that the revno is correct
1438
for this revision id.
1440
It may be possible to set the branch last revision to an id not
1441
present in the repository. However, branches can also be
1442
configured to check constraints on history, in which case this may not
1445
revision_id = _mod_revision.ensure_null(revision_id)
1446
old_revno, old_revid = self.last_revision_info()
1447
history = self._lefthand_history(revision_id)
1448
assert len(history) == revno, '%d != %d' % (len(history), revno)
1449
self.set_revision_history(history)
1450
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1452
def _gen_revision_history(self):
1453
history = self.control_files.get('revision-history').read().split('\n')
1454
if history[-1:] == ['']:
1455
# There shouldn't be a trailing newline, but just in case.
1459
def _lefthand_history(self, revision_id, last_rev=None,
1461
if 'evil' in debug.debug_flags:
1462
mutter_callsite(4, "_lefthand_history scales with history.")
1463
# stop_revision must be a descendant of last_revision
1464
graph = self.repository.get_graph()
1465
if last_rev is not None:
1466
if not graph.is_ancestor(last_rev, revision_id):
1467
# our previous tip is not merged into stop_revision
1468
raise errors.DivergedBranches(self, other_branch)
1469
# make a new revision history from the graph
1470
parents_map = graph.get_parent_map([revision_id])
1471
if revision_id not in parents_map:
1472
raise errors.NoSuchRevision(self, revision_id)
1473
current_rev_id = revision_id
1475
# Do not include ghosts or graph origin in revision_history
1476
while (current_rev_id in parents_map and
1477
len(parents_map[current_rev_id]) > 0):
1478
new_history.append(current_rev_id)
1479
current_rev_id = parents_map[current_rev_id][0]
1480
parents_map = graph.get_parent_map([current_rev_id])
1481
new_history.reverse()
1485
def generate_revision_history(self, revision_id, last_rev=None,
1487
"""Create a new revision history that will finish with revision_id.
1489
:param revision_id: the new tip to use.
1490
:param last_rev: The previous last_revision. If not None, then this
1491
must be a ancestory of revision_id, or DivergedBranches is raised.
1492
:param other_branch: The other branch that DivergedBranches should
1493
raise with respect to.
1495
self.set_revision_history(self._lefthand_history(revision_id,
1496
last_rev, other_branch))
1499
def update_revisions(self, other, stop_revision=None, overwrite=False):
1500
"""See Branch.update_revisions."""
1503
other_last_revno, other_last_revision = other.last_revision_info()
1504
if stop_revision is None:
1505
stop_revision = other_last_revision
1506
if _mod_revision.is_null(stop_revision):
1507
# if there are no commits, we're done.
1509
# whats the current last revision, before we fetch [and change it
1511
last_rev = _mod_revision.ensure_null(self.last_revision())
1512
# we fetch here so that we don't process data twice in the common
1513
# case of having something to pull, and so that the check for
1514
# already merged can operate on the just fetched graph, which will
1515
# be cached in memory.
1516
self.fetch(other, stop_revision)
1517
# Check to see if one is an ancestor of the other
1519
heads = self.repository.get_graph().heads([stop_revision,
1521
if heads == set([last_rev]):
1522
# The current revision is a decendent of the target,
1525
elif heads == set([stop_revision, last_rev]):
1526
# These branches have diverged
1527
raise errors.DivergedBranches(self, other)
1528
assert heads == set([stop_revision])
1529
if other_last_revision == stop_revision:
1530
self.set_last_revision_info(other_last_revno,
1531
other_last_revision)
1533
# TODO: jam 2007-11-29 Is there a way to determine the
1534
# revno without searching all of history??
1536
self.generate_revision_history(stop_revision)
1538
self.generate_revision_history(stop_revision,
1539
last_rev=last_rev, other_branch=other)
1543
def basis_tree(self):
1544
"""See Branch.basis_tree."""
1545
return self.repository.revision_tree(self.last_revision())
1548
def pull(self, source, overwrite=False, stop_revision=None,
1549
_hook_master=None, run_hooks=True, possible_transports=None):
1552
:param _hook_master: Private parameter - set the branch to
1553
be supplied as the master to push hooks.
1554
:param run_hooks: Private parameter - if false, this branch
1555
is being called because it's the master of the primary branch,
1556
so it should not run its hooks.
1558
result = PullResult()
1559
result.source_branch = source
1560
result.target_branch = self
1563
result.old_revno, result.old_revid = self.last_revision_info()
1564
self.update_revisions(source, stop_revision, overwrite=overwrite)
1565
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1566
result.new_revno, result.new_revid = self.last_revision_info()
1568
result.master_branch = _hook_master
1569
result.local_branch = self
1571
result.master_branch = self
1572
result.local_branch = None
1574
for hook in Branch.hooks['post_pull']:
1580
def _get_parent_location(self):
1581
_locs = ['parent', 'pull', 'x-pull']
1584
return self.control_files.get(l).read().strip('\n')
1585
except errors.NoSuchFile:
1590
def push(self, target, overwrite=False, stop_revision=None,
1591
_override_hook_source_branch=None):
1594
This is the basic concrete implementation of push()
1596
:param _override_hook_source_branch: If specified, run
1597
the hooks passing this Branch as the source, rather than self.
1598
This is for use of RemoteBranch, where push is delegated to the
1599
underlying vfs-based Branch.
1601
# TODO: Public option to disable running hooks - should be trivial but
1605
result = self._push_with_bound_branches(target, overwrite,
1607
_override_hook_source_branch=_override_hook_source_branch)
1612
def _push_with_bound_branches(self, target, overwrite,
1614
_override_hook_source_branch=None):
1615
"""Push from self into target, and into target's master if any.
1617
This is on the base BzrBranch class even though it doesn't support
1618
bound branches because the *target* might be bound.
1621
if _override_hook_source_branch:
1622
result.source_branch = _override_hook_source_branch
1623
for hook in Branch.hooks['post_push']:
1626
bound_location = target.get_bound_location()
1627
if bound_location and target.base != bound_location:
1628
# there is a master branch.
1630
# XXX: Why the second check? Is it even supported for a branch to
1631
# be bound to itself? -- mbp 20070507
1632
master_branch = target.get_master_branch()
1633
master_branch.lock_write()
1635
# push into the master from this branch.
1636
self._basic_push(master_branch, overwrite, stop_revision)
1637
# and push into the target branch from this. Note that we push from
1638
# this branch again, because its considered the highest bandwidth
1640
result = self._basic_push(target, overwrite, stop_revision)
1641
result.master_branch = master_branch
1642
result.local_branch = target
1646
master_branch.unlock()
1649
result = self._basic_push(target, overwrite, stop_revision)
1650
# TODO: Why set master_branch and local_branch if there's no
1651
# binding? Maybe cleaner to just leave them unset? -- mbp
1653
result.master_branch = target
1654
result.local_branch = None
1658
def _basic_push(self, target, overwrite, stop_revision):
1659
"""Basic implementation of push without bound branches or hooks.
1661
Must be called with self read locked and target write locked.
1663
result = PushResult()
1664
result.source_branch = self
1665
result.target_branch = target
1666
result.old_revno, result.old_revid = target.last_revision_info()
1668
target.update_revisions(self, stop_revision)
1669
except errors.DivergedBranches:
1673
target.set_revision_history(self.revision_history())
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."""
1681
assert self.base[-1] == '/'
1682
parent = self._get_parent_location()
1685
# This is an old-format absolute path to a local branch
1686
# turn it into a url
1687
if parent.startswith('/'):
1688
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1690
return urlutils.join(self.base[:-1], parent)
1691
except errors.InvalidURLJoin, e:
1692
raise errors.InaccessibleParent(parent, self.base)
1694
def set_push_location(self, location):
1695
"""See Branch.set_push_location."""
1696
self.get_config().set_user_option(
1697
'push_location', location,
1698
store=_mod_config.STORE_LOCATION_NORECURSE)
1701
def set_parent(self, url):
1702
"""See Branch.set_parent."""
1703
# TODO: Maybe delete old location files?
1704
# URLs should never be unicode, even on the local fs,
1705
# FIXUP this and get_parent in a future branch format bump:
1706
# read and rewrite the file, and have the new format code read
1707
# using .get not .get_utf8. RBC 20060125
1709
if isinstance(url, unicode):
1711
url = url.encode('ascii')
1712
except UnicodeEncodeError:
1713
raise errors.InvalidURL(url,
1714
"Urls must be 7-bit ascii, "
1715
"use bzrlib.urlutils.escape")
1716
url = urlutils.relative_url(self.base, url)
1717
self._set_parent_location(url)
1719
def _set_parent_location(self, url):
1721
self.control_files._transport.delete('parent')
1723
assert isinstance(url, str)
1724
self.control_files.put_bytes('parent', url + '\n')
1727
class BzrBranch5(BzrBranch):
1728
"""A format 5 branch. This supports new features over plain branches.
1730
It has support for a master_branch which is the data for bound branches.
1738
super(BzrBranch5, self).__init__(_format=_format,
1739
_control_files=_control_files,
1741
_repository=_repository)
1744
def pull(self, source, overwrite=False, stop_revision=None,
1745
run_hooks=True, possible_transports=None):
1746
"""Pull from source into self, updating my master if any.
1748
:param run_hooks: Private parameter - if false, this branch
1749
is being called because it's the master of the primary branch,
1750
so it should not run its hooks.
1752
bound_location = self.get_bound_location()
1753
master_branch = None
1754
if bound_location and source.base != bound_location:
1755
# not pulling from master, so we need to update master.
1756
master_branch = self.get_master_branch(possible_transports)
1757
master_branch.lock_write()
1760
# pull from source into master.
1761
master_branch.pull(source, overwrite, stop_revision,
1763
return super(BzrBranch5, self).pull(source, overwrite,
1764
stop_revision, _hook_master=master_branch,
1765
run_hooks=run_hooks)
1768
master_branch.unlock()
1770
def get_bound_location(self):
1772
return self.control_files.get_utf8('bound').read()[:-1]
1773
except errors.NoSuchFile:
1777
def get_master_branch(self, possible_transports=None):
1778
"""Return the branch we are bound to.
1780
:return: Either a Branch, or None
1782
This could memoise the branch, but if thats done
1783
it must be revalidated on each new lock.
1784
So for now we just don't memoise it.
1785
# RBC 20060304 review this decision.
1787
bound_loc = self.get_bound_location()
1791
return Branch.open(bound_loc,
1792
possible_transports=possible_transports)
1793
except (errors.NotBranchError, errors.ConnectionError), e:
1794
raise errors.BoundBranchConnectionFailure(
1798
def set_bound_location(self, location):
1799
"""Set the target where this branch is bound to.
1801
:param location: URL to the target branch
1804
self.control_files.put_utf8('bound', location+'\n')
1807
self.control_files._transport.delete('bound')
1808
except errors.NoSuchFile:
1813
def bind(self, other):
1814
"""Bind this branch to the branch other.
1816
This does not push or pull data between the branches, though it does
1817
check for divergence to raise an error when the branches are not
1818
either the same, or one a prefix of the other. That behaviour may not
1819
be useful, so that check may be removed in future.
1821
:param other: The branch to bind to
1824
# TODO: jam 20051230 Consider checking if the target is bound
1825
# It is debatable whether you should be able to bind to
1826
# a branch which is itself bound.
1827
# Committing is obviously forbidden,
1828
# but binding itself may not be.
1829
# Since we *have* to check at commit time, we don't
1830
# *need* to check here
1832
# we want to raise diverged if:
1833
# last_rev is not in the other_last_rev history, AND
1834
# other_last_rev is not in our history, and do it without pulling
1836
self.set_bound_location(other.base)
1840
"""If bound, unbind"""
1841
return self.set_bound_location(None)
1844
def update(self, possible_transports=None):
1845
"""Synchronise this branch with the master branch if any.
1847
:return: None or the last_revision that was pivoted out during the
1850
master = self.get_master_branch(possible_transports)
1851
if master is not None:
1852
old_tip = _mod_revision.ensure_null(self.last_revision())
1853
self.pull(master, overwrite=True)
1854
if self.repository.get_graph().is_ancestor(old_tip,
1855
_mod_revision.ensure_null(self.last_revision())):
1861
class BzrBranch6(BzrBranch5):
1863
def __init__(self, *args, **kwargs):
1864
super(BzrBranch6, self).__init__(*args, **kwargs)
1865
self._last_revision_info_cache = None
1866
self._partial_revision_history_cache = []
1868
def _clear_cached_state(self):
1869
super(BzrBranch6, self)._clear_cached_state()
1870
self._last_revision_info_cache = None
1871
self._partial_revision_history_cache = []
1874
def last_revision_info(self):
1875
"""Return information about the last revision.
1877
:return: A tuple (revno, revision_id).
1879
if self._last_revision_info_cache is None:
1880
self._last_revision_info_cache = self._last_revision_info()
1881
return self._last_revision_info_cache
1883
def _last_revision_info(self):
1884
revision_string = self.control_files.get('last-revision').read()
1885
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1886
revision_id = cache_utf8.get_cached_utf8(revision_id)
1888
return revno, revision_id
1890
def _write_last_revision_info(self, revno, revision_id):
1891
"""Simply write out the revision id, with no checks.
1893
Use set_last_revision_info to perform this safely.
1895
Does not update the revision_history cache.
1896
Intended to be called by set_last_revision_info and
1897
_write_revision_history.
1899
assert revision_id is not None, "Use NULL_REVISION, not None"
1900
out_string = '%d %s\n' % (revno, revision_id)
1901
self.control_files.put_bytes('last-revision', out_string)
1904
def set_last_revision_info(self, revno, revision_id):
1905
revision_id = _mod_revision.ensure_null(revision_id)
1906
old_revno, old_revid = self.last_revision_info()
1907
if self._get_append_revisions_only():
1908
self._check_history_violation(revision_id)
1909
self._write_last_revision_info(revno, revision_id)
1910
self._clear_cached_state()
1911
self._last_revision_info_cache = revno, revision_id
1912
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1914
def _check_history_violation(self, revision_id):
1915
last_revision = _mod_revision.ensure_null(self.last_revision())
1916
if _mod_revision.is_null(last_revision):
1918
if last_revision not in self._lefthand_history(revision_id):
1919
raise errors.AppendRevisionsOnlyViolation(self.base)
1921
def _gen_revision_history(self):
1922
"""Generate the revision history from last revision
1924
self._extend_partial_history()
1925
return list(reversed(self._partial_revision_history_cache))
1927
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1928
"""Extend the partial history to include a given index
1930
If a stop_index is supplied, stop when that index has been reached.
1931
If a stop_revision is supplied, stop when that revision is
1932
encountered. Otherwise, stop when the beginning of history is
1935
:param stop_index: The index which should be present. When it is
1936
present, history extension will stop.
1937
:param revision_id: The revision id which should be present. When
1938
it is encountered, history extension will stop.
1940
repo = self.repository
1941
if len(self._partial_revision_history_cache) == 0:
1942
iterator = repo.iter_reverse_revision_history(self.last_revision())
1944
start_revision = self._partial_revision_history_cache[-1]
1945
iterator = repo.iter_reverse_revision_history(start_revision)
1946
#skip the last revision in the list
1947
next_revision = iterator.next()
1948
assert next_revision == start_revision
1949
for revision_id in iterator:
1950
self._partial_revision_history_cache.append(revision_id)
1951
if (stop_index is not None and
1952
len(self._partial_revision_history_cache) > stop_index):
1954
if revision_id == stop_revision:
1957
def _write_revision_history(self, history):
1958
"""Factored out of set_revision_history.
1960
This performs the actual writing to disk, with format-specific checks.
1961
It is intended to be called by BzrBranch5.set_revision_history.
1963
if len(history) == 0:
1964
last_revision = 'null:'
1966
if history != self._lefthand_history(history[-1]):
1967
raise errors.NotLefthandHistory(history)
1968
last_revision = history[-1]
1969
if self._get_append_revisions_only():
1970
self._check_history_violation(last_revision)
1971
self._write_last_revision_info(len(history), last_revision)
1974
def _set_parent_location(self, url):
1975
"""Set the parent branch"""
1976
self._set_config_location('parent_location', url, make_relative=True)
1979
def _get_parent_location(self):
1980
"""Set the parent branch"""
1981
return self._get_config_location('parent_location')
1983
def set_push_location(self, location):
1984
"""See Branch.set_push_location."""
1985
self._set_config_location('push_location', location)
1987
def set_bound_location(self, location):
1988
"""See Branch.set_push_location."""
1990
config = self.get_config()
1991
if location is None:
1992
if config.get_user_option('bound') != 'True':
1995
config.set_user_option('bound', 'False', warn_masked=True)
1998
self._set_config_location('bound_location', location,
2000
config.set_user_option('bound', 'True', warn_masked=True)
2003
def _get_bound_location(self, bound):
2004
"""Return the bound location in the config file.
2006
Return None if the bound parameter does not match"""
2007
config = self.get_config()
2008
config_bound = (config.get_user_option('bound') == 'True')
2009
if config_bound != bound:
2011
return self._get_config_location('bound_location', config=config)
2013
def get_bound_location(self):
2014
"""See Branch.set_push_location."""
2015
return self._get_bound_location(True)
2017
def get_old_bound_location(self):
2018
"""See Branch.get_old_bound_location"""
2019
return self._get_bound_location(False)
2021
def set_append_revisions_only(self, enabled):
2026
self.get_config().set_user_option('append_revisions_only', value,
2029
def _get_append_revisions_only(self):
2030
value = self.get_config().get_user_option('append_revisions_only')
2031
return value == 'True'
2033
def _synchronize_history(self, destination, revision_id):
2034
"""Synchronize last revision and revision history between branches.
2036
This version is most efficient when the destination is also a
2037
BzrBranch6, but works for BzrBranch5, as long as the destination's
2038
repository contains all the lefthand ancestors of the intended
2039
last_revision. If not, set_last_revision_info will fail.
2041
:param destination: The branch to copy the history into
2042
:param revision_id: The revision-id to truncate history at. May
2043
be None to copy complete history.
2045
source_revno, source_revision_id = self.last_revision_info()
2046
if revision_id is None:
2047
revno, revision_id = source_revno, source_revision_id
2048
elif source_revision_id == revision_id:
2049
# we know the revno without needing to walk all of history
2050
revno = source_revno
2052
# To figure out the revno for a random revision, we need to build
2053
# the revision history, and count its length.
2054
# We don't care about the order, just how long it is.
2055
# Alternatively, we could start at the current location, and count
2056
# backwards. But there is no guarantee that we will find it since
2057
# it may be a merged revision.
2058
revno = len(list(self.repository.iter_reverse_revision_history(
2060
destination.set_last_revision_info(revno, revision_id)
2062
def _make_tags(self):
2063
return BasicTags(self)
2066
def generate_revision_history(self, revision_id, last_rev=None,
2068
"""See BzrBranch5.generate_revision_history"""
2069
history = self._lefthand_history(revision_id, last_rev, other_branch)
2070
revno = len(history)
2071
self.set_last_revision_info(revno, revision_id)
2074
def get_rev_id(self, revno, history=None):
2075
"""Find the revision id of the specified revno."""
2077
return _mod_revision.NULL_REVISION
2079
last_revno, last_revision_id = self.last_revision_info()
2080
if revno <= 0 or revno > last_revno:
2081
raise errors.NoSuchRevision(self, revno)
2083
if history is not None:
2084
assert len(history) == last_revno, 'revno/history mismatch'
2085
return history[revno - 1]
2087
index = last_revno - revno
2088
if len(self._partial_revision_history_cache) <= index:
2089
self._extend_partial_history(stop_index=index)
2090
if len(self._partial_revision_history_cache) > index:
2091
return self._partial_revision_history_cache[index]
2093
raise errors.NoSuchRevision(self, revno)
2096
def revision_id_to_revno(self, revision_id):
2097
"""Given a revision id, return its revno"""
2098
if _mod_revision.is_null(revision_id):
2101
index = self._partial_revision_history_cache.index(revision_id)
2103
self._extend_partial_history(stop_revision=revision_id)
2104
index = len(self._partial_revision_history_cache) - 1
2105
if self._partial_revision_history_cache[index] != revision_id:
2106
raise errors.NoSuchRevision(self, revision_id)
2107
return self.revno() - index
2110
######################################################################
2111
# results of operations
2114
class _Result(object):
2116
def _show_tag_conficts(self, to_file):
2117
if not getattr(self, 'tag_conflicts', None):
2119
to_file.write('Conflicting tags:\n')
2120
for name, value1, value2 in self.tag_conflicts:
2121
to_file.write(' %s\n' % (name, ))
2124
class PullResult(_Result):
2125
"""Result of a Branch.pull operation.
2127
:ivar old_revno: Revision number before pull.
2128
:ivar new_revno: Revision number after pull.
2129
:ivar old_revid: Tip revision id before pull.
2130
:ivar new_revid: Tip revision id after pull.
2131
:ivar source_branch: Source (local) branch object.
2132
:ivar master_branch: Master branch of the target, or None.
2133
:ivar target_branch: Target/destination branch object.
2137
# DEPRECATED: pull used to return the change in revno
2138
return self.new_revno - self.old_revno
2140
def report(self, to_file):
2142
if self.old_revid == self.new_revid:
2143
to_file.write('No revisions to pull.\n')
2145
to_file.write('Now on revision %d.\n' % self.new_revno)
2146
self._show_tag_conficts(to_file)
2149
class PushResult(_Result):
2150
"""Result of a Branch.push operation.
2152
:ivar old_revno: Revision number before push.
2153
:ivar new_revno: Revision number after push.
2154
:ivar old_revid: Tip revision id before push.
2155
:ivar new_revid: Tip revision id after push.
2156
:ivar source_branch: Source branch object.
2157
:ivar master_branch: Master branch of the target, or None.
2158
:ivar target_branch: Target/destination branch object.
2162
# DEPRECATED: push used to return the change in revno
2163
return self.new_revno - self.old_revno
2165
def report(self, to_file):
2166
"""Write a human-readable description of the result."""
2167
if self.old_revid == self.new_revid:
2168
to_file.write('No new revisions to push.\n')
2170
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2171
self._show_tag_conficts(to_file)
2174
class BranchCheckResult(object):
2175
"""Results of checking branch consistency.
2180
def __init__(self, branch):
2181
self.branch = branch
2183
def report_results(self, verbose):
2184
"""Report the check results via trace.note.
2186
:param verbose: Requests more detailed display of what was checked,
2189
note('checked branch %s format %s',
2191
self.branch._format)
2194
class Converter5to6(object):
2195
"""Perform an in-place upgrade of format 5 to format 6"""
2197
def convert(self, branch):
2198
# Data for 5 and 6 can peacefully coexist.
2199
format = BzrBranchFormat6()
2200
new_branch = format.open(branch.bzrdir, _found=True)
2202
# Copy source data into target
2203
new_branch._write_last_revision_info(*branch.last_revision_info())
2204
new_branch.set_parent(branch.get_parent())
2205
new_branch.set_bound_location(branch.get_bound_location())
2206
new_branch.set_push_location(branch.get_push_location())
2208
# New branch has no tags by default
2209
new_branch.tags._set_tag_dict({})
2211
# Copying done; now update target format
2212
new_branch.control_files.put_utf8('format',
2213
format.get_format_string())
2215
# Clean up old files
2216
new_branch.control_files._transport.delete('revision-history')
2218
branch.set_parent(None)
2219
except errors.NoSuchFile:
2221
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
