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,
28
revision as _mod_revision,
34
from bzrlib.config import BranchConfig
35
from bzrlib.tag import (
41
from bzrlib.decorators import needs_read_lock, needs_write_lock
42
from bzrlib.hooks import Hooks
43
from bzrlib.symbol_versioning import (deprecated_method,
46
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
49
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
50
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
51
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
54
# TODO: Maybe include checks for common corruption of newlines, etc?
56
# TODO: Some operations like log might retrieve the same revisions
57
# repeatedly to calculate deltas. We could perhaps have a weakref
58
# cache in memory to make this faster. In general anything can be
59
# cached in memory between lock and unlock operations. .. nb thats
60
# what the transaction identity map provides
63
######################################################################
67
"""Branch holding a history of revisions.
70
Base directory/url of the branch.
72
hooks: An instance of BranchHooks.
74
# this is really an instance variable - FIXME move it there
78
# override this to set the strategy for storing tags
80
return DisabledTags(self)
82
def __init__(self, *ignored, **ignored_too):
83
self.tags = self._make_tags()
84
self._revision_history_cache = None
85
self._revision_id_to_revno_cache = None
88
"""Break a lock if one is present from another instance.
90
Uses the ui factory to ask for confirmation if the lock may be from
93
This will probe the repository for its lock as well.
95
self.control_files.break_lock()
96
self.repository.break_lock()
97
master = self.get_master_branch()
98
if master is not None:
102
def open(base, _unsupported=False, possible_transports=None):
103
"""Open the branch rooted at base.
105
For instance, if the branch is at URL/.bzr/branch,
106
Branch.open(URL) -> a Branch instance.
108
control = bzrdir.BzrDir.open(base, _unsupported,
109
possible_transports=possible_transports)
110
return control.open_branch(_unsupported)
113
def open_from_transport(transport, _unsupported=False):
114
"""Open the branch rooted at transport"""
115
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
116
return control.open_branch(_unsupported)
119
def open_containing(url, possible_transports=None):
120
"""Open an existing branch which contains url.
122
This probes for a branch at url, and searches upwards from there.
124
Basically we keep looking up until we find the control directory or
125
run into the root. If there isn't one, raises NotBranchError.
126
If there is one and it is either an unrecognised format or an unsupported
127
format, UnknownFormatError or UnsupportedFormatError are raised.
128
If there is one, it is returned, along with the unused portion of url.
130
control, relpath = bzrdir.BzrDir.open_containing(url,
132
return control.open_branch(), relpath
134
def get_config(self):
135
return BranchConfig(self)
138
return self.get_config().get_nickname()
140
def _set_nick(self, nick):
141
self.get_config().set_user_option('nickname', nick, warn_masked=True)
143
nick = property(_get_nick, _set_nick)
146
raise NotImplementedError(self.is_locked)
148
def lock_write(self):
149
raise NotImplementedError(self.lock_write)
152
raise NotImplementedError(self.lock_read)
155
raise NotImplementedError(self.unlock)
157
def peek_lock_mode(self):
158
"""Return lock mode for the Branch: 'r', 'w' or None"""
159
raise NotImplementedError(self.peek_lock_mode)
161
def get_physical_lock_status(self):
162
raise NotImplementedError(self.get_physical_lock_status)
165
def get_revision_id_to_revno_map(self):
166
"""Return the revision_id => dotted revno map.
168
This will be regenerated on demand, but will be cached.
170
:return: A dictionary mapping revision_id => dotted revno.
171
This dictionary should not be modified by the caller.
173
if self._revision_id_to_revno_cache is not None:
174
mapping = self._revision_id_to_revno_cache
176
mapping = self._gen_revno_map()
177
self._cache_revision_id_to_revno(mapping)
178
# TODO: jam 20070417 Since this is being cached, should we be returning
180
# I would rather not, and instead just declare that users should not
181
# modify the return value.
184
def _gen_revno_map(self):
185
"""Create a new mapping from revision ids to dotted revnos.
187
Dotted revnos are generated based on the current tip in the revision
189
This is the worker function for get_revision_id_to_revno_map, which
190
just caches the return value.
192
:return: A dictionary mapping revision_id => dotted revno.
194
last_revision = self.last_revision()
195
graph = self.repository.get_graph()
196
search = graph._make_breadth_first_searcher([last_revision])
197
transitive_ids = set()
198
map(transitive_ids.update, list(search))
199
revision_graph = graph.get_parent_map(transitive_ids)
200
# Filter ghosts, and null:
201
if _mod_revision.NULL_REVISION in revision_graph:
202
del revision_graph[_mod_revision.NULL_REVISION]
203
for key, parents in revision_graph.items():
204
revision_graph[key] = tuple(parent for parent in parents if parent
206
merge_sorted_revisions = tsort.merge_sort(
211
revision_id_to_revno = dict((rev_id, revno)
212
for seq_num, rev_id, depth, revno, end_of_merge
213
in merge_sorted_revisions)
214
return revision_id_to_revno
216
def leave_lock_in_place(self):
217
"""Tell this branch object not to release the physical lock when this
220
If lock_write doesn't return a token, then this method is not supported.
222
self.control_files.leave_in_place()
224
def dont_leave_lock_in_place(self):
225
"""Tell this branch object to release the physical lock when this
226
object is unlocked, even if it didn't originally acquire it.
228
If lock_write doesn't return a token, then this method is not supported.
230
self.control_files.dont_leave_in_place()
232
def abspath(self, name):
233
"""Return absolute filename for something in the branch
235
XXX: Robert Collins 20051017 what is this used for? why is it a branch
236
method and not a tree method.
238
raise NotImplementedError(self.abspath)
240
def bind(self, other):
241
"""Bind the local branch the other branch.
243
:param other: The branch to bind to
246
raise errors.UpgradeRequired(self.base)
249
def fetch(self, from_branch, last_revision=None, pb=None):
250
"""Copy revisions from from_branch into this branch.
252
:param from_branch: Where to copy from.
253
:param last_revision: What revision to stop at (None for at the end
255
:param pb: An optional progress bar to use.
257
Returns the copied revision count and the failed revisions in a tuple:
260
if self.base == from_branch.base:
263
nested_pb = ui.ui_factory.nested_progress_bar()
268
from_branch.lock_read()
270
if last_revision is None:
271
pb.update('get source history')
272
last_revision = from_branch.last_revision()
273
last_revision = _mod_revision.ensure_null(last_revision)
274
return self.repository.fetch(from_branch.repository,
275
revision_id=last_revision,
278
if nested_pb is not None:
282
def get_bound_location(self):
283
"""Return the URL of the branch we are bound to.
285
Older format branches cannot bind, please be sure to use a metadir
290
def get_old_bound_location(self):
291
"""Return the URL of the branch we used to be bound to
293
raise errors.UpgradeRequired(self.base)
295
def get_commit_builder(self, parents, config=None, timestamp=None,
296
timezone=None, committer=None, revprops=None,
298
"""Obtain a CommitBuilder for this branch.
300
:param parents: Revision ids of the parents of the new revision.
301
:param config: Optional configuration to use.
302
:param timestamp: Optional timestamp recorded for commit.
303
:param timezone: Optional timezone for timestamp.
304
:param committer: Optional committer to set for commit.
305
:param revprops: Optional dictionary of revision properties.
306
:param revision_id: Optional revision id.
310
config = self.get_config()
312
return self.repository.get_commit_builder(self, parents, config,
313
timestamp, timezone, committer, revprops, revision_id)
315
def get_master_branch(self, possible_transports=None):
316
"""Return the branch we are bound to.
318
:return: Either a Branch, or None
322
def get_revision_delta(self, revno):
323
"""Return the delta for one revision.
325
The delta is relative to its mainline predecessor, or the
326
empty tree for revision 1.
328
assert isinstance(revno, int)
329
rh = self.revision_history()
330
if not (1 <= revno <= len(rh)):
331
raise errors.InvalidRevisionNumber(revno)
332
return self.repository.get_revision_delta(rh[revno-1])
334
@deprecated_method(zero_sixteen)
335
def get_root_id(self):
336
"""Return the id of this branches root
338
Deprecated: branches don't have root ids-- trees do.
339
Use basis_tree().get_root_id() instead.
341
raise NotImplementedError(self.get_root_id)
343
def print_file(self, file, revision_id):
344
"""Print `file` to stdout."""
345
raise NotImplementedError(self.print_file)
347
def set_revision_history(self, rev_history):
348
raise NotImplementedError(self.set_revision_history)
350
def _cache_revision_history(self, rev_history):
351
"""Set the cached revision history to rev_history.
353
The revision_history method will use this cache to avoid regenerating
354
the revision history.
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_history_cache = rev_history
361
def _cache_revision_id_to_revno(self, revision_id_to_revno):
362
"""Set the cached revision_id => revno map to revision_id_to_revno.
364
This API is semi-public; it only for use by subclasses, all other code
365
should consider it to be private.
367
self._revision_id_to_revno_cache = revision_id_to_revno
369
def _clear_cached_state(self):
370
"""Clear any cached data on this branch, e.g. cached revision history.
372
This means the next call to revision_history will need to call
373
_gen_revision_history.
375
This API is semi-public; it only for use by subclasses, all other code
376
should consider it to be private.
378
self._revision_history_cache = None
379
self._revision_id_to_revno_cache = None
381
def _gen_revision_history(self):
382
"""Return sequence of revision hashes on to this branch.
384
Unlike revision_history, this method always regenerates or rereads the
385
revision history, i.e. it does not cache the result, so repeated calls
388
Concrete subclasses should override this instead of revision_history so
389
that subclasses do not need to deal with caching logic.
391
This API is semi-public; it only for use by subclasses, all other code
392
should consider it to be private.
394
raise NotImplementedError(self._gen_revision_history)
397
def revision_history(self):
398
"""Return sequence of revision ids on this branch.
400
This method will cache the revision history for as long as it is safe to
403
if 'evil' in debug.debug_flags:
404
mutter_callsite(3, "revision_history scales with history.")
405
if self._revision_history_cache is not None:
406
history = self._revision_history_cache
408
history = self._gen_revision_history()
409
self._cache_revision_history(history)
413
"""Return current revision number for this branch.
415
That is equivalent to the number of revisions committed to
418
return self.last_revision_info()[0]
421
"""Older format branches cannot bind or unbind."""
422
raise errors.UpgradeRequired(self.base)
424
def set_append_revisions_only(self, enabled):
425
"""Older format branches are never restricted to append-only"""
426
raise errors.UpgradeRequired(self.base)
428
def last_revision(self):
429
"""Return last revision id, or NULL_REVISION."""
430
return self.last_revision_info()[1]
432
def last_revision_info(self):
433
"""Return information about the last revision.
435
:return: A tuple (revno, last_revision_id).
437
rh = self.revision_history()
440
return (revno, rh[-1])
442
return (0, _mod_revision.NULL_REVISION)
444
def missing_revisions(self, other, stop_revision=None):
445
"""Return a list of new revisions that would perfectly fit.
447
If self and other have not diverged, return a list of the revisions
448
present in other, but missing from self.
450
self_history = self.revision_history()
451
self_len = len(self_history)
452
other_history = other.revision_history()
453
other_len = len(other_history)
454
common_index = min(self_len, other_len) -1
455
if common_index >= 0 and \
456
self_history[common_index] != other_history[common_index]:
457
raise errors.DivergedBranches(self, other)
459
if stop_revision is None:
460
stop_revision = other_len
462
assert isinstance(stop_revision, int)
463
if stop_revision > other_len:
464
raise errors.NoSuchRevision(self, stop_revision)
465
return other_history[self_len:stop_revision]
467
def update_revisions(self, other, stop_revision=None):
468
"""Pull in new perfect-fit revisions.
470
:param other: Another Branch to pull from
471
:param stop_revision: Updated until the given revision
474
raise NotImplementedError(self.update_revisions)
476
def revision_id_to_revno(self, revision_id):
477
"""Given a revision id, return its revno"""
478
if _mod_revision.is_null(revision_id):
480
history = self.revision_history()
482
return history.index(revision_id) + 1
484
raise errors.NoSuchRevision(self, revision_id)
486
def get_rev_id(self, revno, history=None):
487
"""Find the revision id of the specified revno."""
489
return _mod_revision.NULL_REVISION
491
history = self.revision_history()
492
if revno <= 0 or revno > len(history):
493
raise errors.NoSuchRevision(self, revno)
494
return history[revno - 1]
496
def pull(self, source, overwrite=False, stop_revision=None,
497
possible_transports=None):
498
"""Mirror source into this branch.
500
This branch is considered to be 'local', having low latency.
502
:returns: PullResult instance
504
raise NotImplementedError(self.pull)
506
def push(self, target, overwrite=False, stop_revision=None):
507
"""Mirror this branch into target.
509
This branch is considered to be 'local', having low latency.
511
raise NotImplementedError(self.push)
513
def basis_tree(self):
514
"""Return `Tree` object for last revision."""
515
return self.repository.revision_tree(self.last_revision())
517
def rename_one(self, from_rel, to_rel):
520
This can change the directory or the filename or both.
522
raise NotImplementedError(self.rename_one)
524
def move(self, from_paths, to_name):
527
to_name must exist as a versioned directory.
529
If to_name exists and is a directory, the files are moved into
530
it, keeping their old names. If it is a directory,
532
Note that to_name is only the last component of the new name;
533
this doesn't change the directory.
535
This returns a list of (from_path, to_path) pairs for each
538
raise NotImplementedError(self.move)
540
def get_parent(self):
541
"""Return the parent location of the branch.
543
This is the default location for push/pull/missing. The usual
544
pattern is that the user can override it by specifying a
547
raise NotImplementedError(self.get_parent)
549
def _set_config_location(self, name, url, config=None,
550
make_relative=False):
552
config = self.get_config()
556
url = urlutils.relative_url(self.base, url)
557
config.set_user_option(name, url, warn_masked=True)
559
def _get_config_location(self, name, config=None):
561
config = self.get_config()
562
location = config.get_user_option(name)
567
def get_submit_branch(self):
568
"""Return the submit location of the branch.
570
This is the default location for bundle. The usual
571
pattern is that the user can override it by specifying a
574
return self.get_config().get_user_option('submit_branch')
576
def set_submit_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.get_config().set_user_option('submit_branch', location,
586
def get_public_branch(self):
587
"""Return the public location of the branch.
589
This is is used by merge directives.
591
return self._get_config_location('public_branch')
593
def set_public_branch(self, location):
594
"""Return the submit location of the branch.
596
This is the default location for bundle. The usual
597
pattern is that the user can override it by specifying a
600
self._set_config_location('public_branch', location)
602
def get_push_location(self):
603
"""Return the None or the location to push this branch to."""
604
push_loc = self.get_config().get_user_option('push_location')
607
def set_push_location(self, location):
608
"""Set a new push location for this branch."""
609
raise NotImplementedError(self.set_push_location)
611
def set_parent(self, url):
612
raise NotImplementedError(self.set_parent)
616
"""Synchronise this branch with the master branch if any.
618
:return: None or the last_revision pivoted out during the update.
622
def check_revno(self, revno):
624
Check whether a revno corresponds to any revision.
625
Zero (the NULL revision) is considered valid.
628
self.check_real_revno(revno)
630
def check_real_revno(self, revno):
632
Check whether a revno corresponds to a real revision.
633
Zero (the NULL revision) is considered invalid
635
if revno < 1 or revno > self.revno():
636
raise errors.InvalidRevisionNumber(revno)
639
def clone(self, to_bzrdir, revision_id=None):
640
"""Clone this branch into to_bzrdir preserving all semantic values.
642
revision_id: if not None, the revision history in the new branch will
643
be truncated to end with revision_id.
645
result = self._format.initialize(to_bzrdir)
646
self.copy_content_into(result, revision_id=revision_id)
650
def sprout(self, to_bzrdir, revision_id=None):
651
"""Create a new line of development from the branch, into to_bzrdir.
653
revision_id: if not None, the revision history in the new branch will
654
be truncated to end with revision_id.
656
result = self._format.initialize(to_bzrdir)
657
self.copy_content_into(result, revision_id=revision_id)
658
result.set_parent(self.bzrdir.root_transport.base)
661
def _synchronize_history(self, destination, revision_id):
662
"""Synchronize last revision and revision history between branches.
664
This version is most efficient when the destination is also a
665
BzrBranch5, but works for BzrBranch6 as long as the revision
666
history is the true lefthand parent history, and all of the revisions
667
are in the destination's repository. If not, set_revision_history
670
:param destination: The branch to copy the history into
671
:param revision_id: The revision-id to truncate history at. May
672
be None to copy complete history.
674
if revision_id == _mod_revision.NULL_REVISION:
676
new_history = self.revision_history()
677
if revision_id is not None and new_history != []:
679
new_history = new_history[:new_history.index(revision_id) + 1]
681
rev = self.repository.get_revision(revision_id)
682
new_history = rev.get_history(self.repository)[1:]
683
destination.set_revision_history(new_history)
686
def copy_content_into(self, destination, revision_id=None):
687
"""Copy the content of self into destination.
689
revision_id: if not None, the revision history in the new branch will
690
be truncated to end with revision_id.
692
self._synchronize_history(destination, revision_id)
694
parent = self.get_parent()
695
except errors.InaccessibleParent, e:
696
mutter('parent was not accessible to copy: %s', e)
699
destination.set_parent(parent)
700
self.tags.merge_to(destination.tags)
704
"""Check consistency of the branch.
706
In particular this checks that revisions given in the revision-history
707
do actually match up in the revision graph, and that they're all
708
present in the repository.
710
Callers will typically also want to check the repository.
712
:return: A BranchCheckResult.
714
mainline_parent_id = None
715
for revision_id in self.revision_history():
717
revision = self.repository.get_revision(revision_id)
718
except errors.NoSuchRevision, e:
719
raise errors.BzrCheckError("mainline revision {%s} not in repository"
721
# In general the first entry on the revision history has no parents.
722
# But it's not illegal for it to have parents listed; this can happen
723
# in imports from Arch when the parents weren't reachable.
724
if mainline_parent_id is not None:
725
if mainline_parent_id not in revision.parent_ids:
726
raise errors.BzrCheckError("previous revision {%s} not listed among "
728
% (mainline_parent_id, revision_id))
729
mainline_parent_id = revision_id
730
return BranchCheckResult(self)
732
def _get_checkout_format(self):
733
"""Return the most suitable metadir for a checkout of this branch.
734
Weaves are used if this branch's repository uses weaves.
736
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
737
from bzrlib.repofmt import weaverepo
738
format = bzrdir.BzrDirMetaFormat1()
739
format.repository_format = weaverepo.RepositoryFormat7()
741
format = self.repository.bzrdir.checkout_metadir()
742
format.set_branch_format(self._format)
745
def create_checkout(self, to_location, revision_id=None,
746
lightweight=False, accelerator_tree=None,
748
"""Create a checkout of a branch.
750
:param to_location: The url to produce the checkout at
751
:param revision_id: The revision to check out
752
:param lightweight: If True, produce a lightweight checkout, otherwise,
753
produce a bound branch (heavyweight checkout)
754
:param accelerator_tree: A tree which can be used for retrieving file
755
contents more quickly than the revision tree, i.e. a workingtree.
756
The revision tree will be used for cases where accelerator_tree's
757
content is different.
758
:param hardlink: If true, hard-link files from accelerator_tree,
760
:return: The tree of the created checkout
762
t = transport.get_transport(to_location)
765
format = self._get_checkout_format()
766
checkout = format.initialize_on_transport(t)
767
from_branch = BranchReferenceFormat().initialize(checkout, self)
769
format = self._get_checkout_format()
770
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
771
to_location, force_new_tree=False, format=format)
772
checkout = checkout_branch.bzrdir
773
checkout_branch.bind(self)
774
# pull up to the specified revision_id to set the initial
775
# branch tip correctly, and seed it with history.
776
checkout_branch.pull(self, stop_revision=revision_id)
778
tree = checkout.create_workingtree(revision_id,
779
from_branch=from_branch,
780
accelerator_tree=accelerator_tree,
782
basis_tree = tree.basis_tree()
783
basis_tree.lock_read()
785
for path, file_id in basis_tree.iter_references():
786
reference_parent = self.reference_parent(file_id, path)
787
reference_parent.create_checkout(tree.abspath(path),
788
basis_tree.get_reference_revision(file_id, path),
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
control_files.put_utf8('format', self.get_format_string())
913
for file, content in utf8_files:
914
control_files.put_utf8(file, content)
916
control_files.unlock()
917
return self.open(a_bzrdir, _found=True)
919
def initialize(self, a_bzrdir):
920
"""Create a branch of this format in a_bzrdir."""
921
raise NotImplementedError(self.initialize)
923
def is_supported(self):
924
"""Is this format supported?
926
Supported formats can be initialized and opened.
927
Unsupported formats may not support initialization or committing or
928
some other features depending on the reason for not being supported.
932
def open(self, a_bzrdir, _found=False):
933
"""Return the branch object for a_bzrdir
935
_found is a private parameter, do not use it. It is used to indicate
936
if format probing has already be done.
938
raise NotImplementedError(self.open)
941
def register_format(klass, format):
942
klass._formats[format.get_format_string()] = format
945
def set_default_format(klass, format):
946
klass._default_format = format
949
def unregister_format(klass, format):
950
assert klass._formats[format.get_format_string()] is format
951
del klass._formats[format.get_format_string()]
954
return self.get_format_string().rstrip()
956
def supports_tags(self):
957
"""True if this format supports tags stored in the branch"""
958
return False # by default
960
# XXX: Probably doesn't really belong here -- mbp 20070212
961
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
963
branch_transport = a_bzrdir.get_branch_transport(self)
964
control_files = lockable_files.LockableFiles(branch_transport,
965
lock_filename, lock_class)
966
control_files.create_lock()
967
control_files.lock_write()
969
for filename, content in utf8_files:
970
control_files.put_utf8(filename, content)
972
control_files.unlock()
975
class BranchHooks(Hooks):
976
"""A dictionary mapping hook name to a list of callables for branch hooks.
978
e.g. ['set_rh'] Is the list of items to be called when the
979
set_revision_history function is invoked.
983
"""Create the default hooks.
985
These are all empty initially, because by default nothing should get
989
# Introduced in 0.15:
990
# invoked whenever the revision history has been set
991
# with set_revision_history. The api signature is
992
# (branch, revision_history), and the branch will
995
# invoked after a push operation completes.
996
# the api signature is
998
# containing the members
999
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1000
# where local is the local target branch or None, master is the target
1001
# master branch, and the rest should be self explanatory. The source
1002
# is read locked and the target branches write locked. Source will
1003
# be the local low-latency branch.
1004
self['post_push'] = []
1005
# invoked after a pull operation completes.
1006
# the api signature is
1008
# containing the members
1009
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1010
# where local is the local branch or None, master is the target
1011
# master branch, and the rest should be self explanatory. The source
1012
# is read locked and the target branches write locked. The local
1013
# branch is the low-latency branch.
1014
self['post_pull'] = []
1015
# invoked before a commit operation takes place.
1016
# the api signature is
1017
# (local, master, old_revno, old_revid, future_revno, future_revid,
1018
# tree_delta, future_tree).
1019
# old_revid is NULL_REVISION for the first commit to a branch
1020
# tree_delta is a TreeDelta object describing changes from the basis
1021
# revision, hooks MUST NOT modify this delta
1022
# future_tree is an in-memory tree obtained from
1023
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1024
self['pre_commit'] = []
1025
# invoked after a commit operation completes.
1026
# the api signature is
1027
# (local, master, old_revno, old_revid, new_revno, new_revid)
1028
# old_revid is NULL_REVISION for the first commit to a branch.
1029
self['post_commit'] = []
1030
# invoked after a uncommit operation completes.
1031
# the api signature is
1032
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1033
# local is the local branch or None, master is the target branch,
1034
# and an empty branch recieves new_revno of 0, new_revid of None.
1035
self['post_uncommit'] = []
1038
# install the default hooks into the Branch class.
1039
Branch.hooks = BranchHooks()
1042
class BzrBranchFormat4(BranchFormat):
1043
"""Bzr branch format 4.
1046
- a revision-history file.
1047
- a branch-lock lock file [ to be shared with the bzrdir ]
1050
def get_format_description(self):
1051
"""See BranchFormat.get_format_description()."""
1052
return "Branch format 4"
1054
def initialize(self, a_bzrdir):
1055
"""Create a branch of this format in a_bzrdir."""
1056
utf8_files = [('revision-history', ''),
1057
('branch-name', ''),
1059
return self._initialize_helper(a_bzrdir, utf8_files,
1060
lock_type='branch4', set_format=False)
1063
super(BzrBranchFormat4, self).__init__()
1064
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1066
def open(self, a_bzrdir, _found=False):
1067
"""Return the branch object for a_bzrdir
1069
_found is a private parameter, do not use it. It is used to indicate
1070
if format probing has already be done.
1073
# we are being called directly and must probe.
1074
raise NotImplementedError
1075
return BzrBranch(_format=self,
1076
_control_files=a_bzrdir._control_files,
1078
_repository=a_bzrdir.open_repository())
1081
return "Bazaar-NG branch format 4"
1084
class BzrBranchFormat5(BranchFormat):
1085
"""Bzr branch format 5.
1088
- a revision-history file.
1090
- a lock dir guarding the branch itself
1091
- all of this stored in a branch/ subdirectory
1092
- works with shared repositories.
1094
This format is new in bzr 0.8.
1097
def get_format_string(self):
1098
"""See BranchFormat.get_format_string()."""
1099
return "Bazaar-NG branch format 5\n"
1101
def get_format_description(self):
1102
"""See BranchFormat.get_format_description()."""
1103
return "Branch format 5"
1105
def initialize(self, a_bzrdir):
1106
"""Create a branch of this format in a_bzrdir."""
1107
utf8_files = [('revision-history', ''),
1108
('branch-name', ''),
1110
return self._initialize_helper(a_bzrdir, utf8_files)
1113
super(BzrBranchFormat5, self).__init__()
1114
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1116
def open(self, a_bzrdir, _found=False):
1117
"""Return the branch object for a_bzrdir
1119
_found is a private parameter, do not use it. It is used to indicate
1120
if format probing has already be done.
1123
format = BranchFormat.find_format(a_bzrdir)
1124
assert format.__class__ == self.__class__
1126
transport = a_bzrdir.get_branch_transport(None)
1127
control_files = lockable_files.LockableFiles(transport, 'lock',
1129
return BzrBranch5(_format=self,
1130
_control_files=control_files,
1132
_repository=a_bzrdir.find_repository())
1133
except errors.NoSuchFile:
1134
raise errors.NotBranchError(path=transport.base)
1137
class BzrBranchFormat6(BzrBranchFormat5):
1138
"""Branch format with last-revision and tags.
1140
Unlike previous formats, this has no explicit revision history. Instead,
1141
this just stores the last-revision, and the left-hand history leading
1142
up to there is the history.
1144
This format was introduced in bzr 0.15
1145
and became the default in 0.91.
1148
def get_format_string(self):
1149
"""See BranchFormat.get_format_string()."""
1150
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1152
def get_format_description(self):
1153
"""See BranchFormat.get_format_description()."""
1154
return "Branch format 6"
1156
def initialize(self, a_bzrdir):
1157
"""Create a branch of this format in a_bzrdir."""
1158
utf8_files = [('last-revision', '0 null:\n'),
1159
('branch.conf', ''),
1162
return self._initialize_helper(a_bzrdir, utf8_files)
1164
def open(self, a_bzrdir, _found=False):
1165
"""Return the branch object for a_bzrdir
1167
_found is a private parameter, do not use it. It is used to indicate
1168
if format probing has already be done.
1171
format = BranchFormat.find_format(a_bzrdir)
1172
assert format.__class__ == self.__class__
1173
transport = a_bzrdir.get_branch_transport(None)
1174
control_files = lockable_files.LockableFiles(transport, 'lock',
1176
return BzrBranch6(_format=self,
1177
_control_files=control_files,
1179
_repository=a_bzrdir.find_repository())
1181
def supports_tags(self):
1185
class BranchReferenceFormat(BranchFormat):
1186
"""Bzr branch reference format.
1188
Branch references are used in implementing checkouts, they
1189
act as an alias to the real branch which is at some other url.
1196
def get_format_string(self):
1197
"""See BranchFormat.get_format_string()."""
1198
return "Bazaar-NG Branch Reference Format 1\n"
1200
def get_format_description(self):
1201
"""See BranchFormat.get_format_description()."""
1202
return "Checkout reference format 1"
1204
def get_reference(self, a_bzrdir):
1205
"""See BranchFormat.get_reference()."""
1206
transport = a_bzrdir.get_branch_transport(None)
1207
return transport.get('location').read()
1209
def set_reference(self, a_bzrdir, to_branch):
1210
"""See BranchFormat.set_reference()."""
1211
transport = a_bzrdir.get_branch_transport(None)
1212
location = transport.put_bytes('location', to_branch.base)
1214
def initialize(self, a_bzrdir, target_branch=None):
1215
"""Create a branch of this format in a_bzrdir."""
1216
if target_branch is None:
1217
# this format does not implement branch itself, thus the implicit
1218
# creation contract must see it as uninitializable
1219
raise errors.UninitializableFormat(self)
1220
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1221
branch_transport = a_bzrdir.get_branch_transport(self)
1222
branch_transport.put_bytes('location',
1223
target_branch.bzrdir.root_transport.base)
1224
branch_transport.put_bytes('format', self.get_format_string())
1226
a_bzrdir, _found=True,
1227
possible_transports=[target_branch.bzrdir.root_transport])
1230
super(BranchReferenceFormat, self).__init__()
1231
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1233
def _make_reference_clone_function(format, a_branch):
1234
"""Create a clone() routine for a branch dynamically."""
1235
def clone(to_bzrdir, revision_id=None):
1236
"""See Branch.clone()."""
1237
return format.initialize(to_bzrdir, a_branch)
1238
# cannot obey revision_id limits when cloning a reference ...
1239
# FIXME RBC 20060210 either nuke revision_id for clone, or
1240
# emit some sort of warning/error to the caller ?!
1243
def open(self, a_bzrdir, _found=False, location=None,
1244
possible_transports=None):
1245
"""Return the branch that the branch reference in a_bzrdir points at.
1247
_found is a private parameter, do not use it. It is used to indicate
1248
if format probing has already be done.
1251
format = BranchFormat.find_format(a_bzrdir)
1252
assert format.__class__ == self.__class__
1253
if location is None:
1254
location = self.get_reference(a_bzrdir)
1255
real_bzrdir = bzrdir.BzrDir.open(
1256
location, possible_transports=possible_transports)
1257
result = real_bzrdir.open_branch()
1258
# this changes the behaviour of result.clone to create a new reference
1259
# rather than a copy of the content of the branch.
1260
# I did not use a proxy object because that needs much more extensive
1261
# testing, and we are only changing one behaviour at the moment.
1262
# If we decide to alter more behaviours - i.e. the implicit nickname
1263
# then this should be refactored to introduce a tested proxy branch
1264
# and a subclass of that for use in overriding clone() and ....
1266
result.clone = self._make_reference_clone_function(result)
1270
# formats which have no format string are not discoverable
1271
# and not independently creatable, so are not registered.
1272
__format5 = BzrBranchFormat5()
1273
__format6 = BzrBranchFormat6()
1274
BranchFormat.register_format(__format5)
1275
BranchFormat.register_format(BranchReferenceFormat())
1276
BranchFormat.register_format(__format6)
1277
BranchFormat.set_default_format(__format6)
1278
_legacy_formats = [BzrBranchFormat4(),
1281
class BzrBranch(Branch):
1282
"""A branch stored in the actual filesystem.
1284
Note that it's "local" in the context of the filesystem; it doesn't
1285
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1286
it's writable, and can be accessed via the normal filesystem API.
1289
def __init__(self, _format=None,
1290
_control_files=None, a_bzrdir=None, _repository=None):
1291
"""Create new branch object at a particular location."""
1292
Branch.__init__(self)
1293
if a_bzrdir is None:
1294
raise ValueError('a_bzrdir must be supplied')
1296
self.bzrdir = a_bzrdir
1297
# self._transport used to point to the directory containing the
1298
# control directory, but was not used - now it's just the transport
1299
# for the branch control files. mbp 20070212
1300
self._base = self.bzrdir.transport.clone('..').base
1301
self._format = _format
1302
if _control_files is None:
1303
raise ValueError('BzrBranch _control_files is None')
1304
self.control_files = _control_files
1305
self._transport = _control_files._transport
1306
self.repository = _repository
1309
return '%s(%r)' % (self.__class__.__name__, self.base)
1313
def _get_base(self):
1314
"""Returns the directory containing the control directory."""
1317
base = property(_get_base, doc="The URL for the root of this branch.")
1319
def abspath(self, name):
1320
"""See Branch.abspath."""
1321
return self.control_files._transport.abspath(name)
1324
@deprecated_method(zero_sixteen)
1326
def get_root_id(self):
1327
"""See Branch.get_root_id."""
1328
tree = self.repository.revision_tree(self.last_revision())
1329
return tree.get_root_id()
1331
def is_locked(self):
1332
return self.control_files.is_locked()
1334
def lock_write(self, token=None):
1335
repo_token = self.repository.lock_write()
1337
token = self.control_files.lock_write(token=token)
1339
self.repository.unlock()
1343
def lock_read(self):
1344
self.repository.lock_read()
1346
self.control_files.lock_read()
1348
self.repository.unlock()
1352
# TODO: test for failed two phase locks. This is known broken.
1354
self.control_files.unlock()
1356
self.repository.unlock()
1357
if not self.control_files.is_locked():
1358
# we just released the lock
1359
self._clear_cached_state()
1361
def peek_lock_mode(self):
1362
if self.control_files._lock_count == 0:
1365
return self.control_files._lock_mode
1367
def get_physical_lock_status(self):
1368
return self.control_files.get_physical_lock_status()
1371
def print_file(self, file, revision_id):
1372
"""See Branch.print_file."""
1373
return self.repository.print_file(file, revision_id)
1375
def _write_revision_history(self, history):
1376
"""Factored out of set_revision_history.
1378
This performs the actual writing to disk.
1379
It is intended to be called by BzrBranch5.set_revision_history."""
1380
self.control_files.put_bytes(
1381
'revision-history', '\n'.join(history))
1384
def set_revision_history(self, rev_history):
1385
"""See Branch.set_revision_history."""
1386
if 'evil' in debug.debug_flags:
1387
mutter_callsite(3, "set_revision_history scales with history.")
1388
self._clear_cached_state()
1389
self._write_revision_history(rev_history)
1390
self._cache_revision_history(rev_history)
1391
for hook in Branch.hooks['set_rh']:
1392
hook(self, rev_history)
1395
def set_last_revision_info(self, revno, revision_id):
1396
"""Set the last revision of this branch.
1398
The caller is responsible for checking that the revno is correct
1399
for this revision id.
1401
It may be possible to set the branch last revision to an id not
1402
present in the repository. However, branches can also be
1403
configured to check constraints on history, in which case this may not
1406
revision_id = _mod_revision.ensure_null(revision_id)
1407
history = self._lefthand_history(revision_id)
1408
assert len(history) == revno, '%d != %d' % (len(history), revno)
1409
self.set_revision_history(history)
1411
def _gen_revision_history(self):
1412
history = self.control_files.get('revision-history').read().split('\n')
1413
if history[-1:] == ['']:
1414
# There shouldn't be a trailing newline, but just in case.
1418
def _lefthand_history(self, revision_id, last_rev=None,
1420
if 'evil' in debug.debug_flags:
1421
mutter_callsite(4, "_lefthand_history scales with history.")
1422
# stop_revision must be a descendant of last_revision
1423
graph = self.repository.get_graph()
1424
if last_rev is not None:
1425
if not graph.is_ancestor(last_rev, revision_id):
1426
# our previous tip is not merged into stop_revision
1427
raise errors.DivergedBranches(self, other_branch)
1428
# make a new revision history from the graph
1429
parents_map = graph.get_parent_map([revision_id])
1430
if revision_id not in parents_map:
1431
raise errors.NoSuchRevision(self, revision_id)
1432
current_rev_id = revision_id
1434
# Do not include ghosts or graph origin in revision_history
1435
while (current_rev_id in parents_map and
1436
len(parents_map[current_rev_id]) > 0):
1437
new_history.append(current_rev_id)
1438
current_rev_id = parents_map[current_rev_id][0]
1439
parents_map = graph.get_parent_map([current_rev_id])
1440
new_history.reverse()
1444
def generate_revision_history(self, revision_id, last_rev=None,
1446
"""Create a new revision history that will finish with revision_id.
1448
:param revision_id: the new tip to use.
1449
:param last_rev: The previous last_revision. If not None, then this
1450
must be a ancestory of revision_id, or DivergedBranches is raised.
1451
:param other_branch: The other branch that DivergedBranches should
1452
raise with respect to.
1454
self.set_revision_history(self._lefthand_history(revision_id,
1455
last_rev, other_branch))
1458
def update_revisions(self, other, stop_revision=None, overwrite=False):
1459
"""See Branch.update_revisions."""
1462
other_last_revno, other_last_revision = other.last_revision_info()
1463
if stop_revision is None:
1464
stop_revision = other_last_revision
1465
if _mod_revision.is_null(stop_revision):
1466
# if there are no commits, we're done.
1468
# whats the current last revision, before we fetch [and change it
1470
last_rev = _mod_revision.ensure_null(self.last_revision())
1471
# we fetch here so that we don't process data twice in the common
1472
# case of having something to pull, and so that the check for
1473
# already merged can operate on the just fetched graph, which will
1474
# be cached in memory.
1475
self.fetch(other, stop_revision)
1476
# Check to see if one is an ancestor of the other
1478
heads = self.repository.get_graph().heads([stop_revision,
1480
if heads == set([last_rev]):
1481
# The current revision is a decendent of the target,
1484
elif heads == set([stop_revision, last_rev]):
1485
# These branches have diverged
1486
raise errors.DivergedBranches(self, other)
1487
assert heads == set([stop_revision])
1488
if other_last_revision == stop_revision:
1489
self.set_last_revision_info(other_last_revno,
1490
other_last_revision)
1492
# TODO: jam 2007-11-29 Is there a way to determine the
1493
# revno without searching all of history??
1495
self.generate_revision_history(stop_revision)
1497
self.generate_revision_history(stop_revision,
1498
last_rev=last_rev, other_branch=other)
1502
def basis_tree(self):
1503
"""See Branch.basis_tree."""
1504
return self.repository.revision_tree(self.last_revision())
1507
def pull(self, source, overwrite=False, stop_revision=None,
1508
_hook_master=None, run_hooks=True, possible_transports=None):
1511
:param _hook_master: Private parameter - set the branch to
1512
be supplied as the master to push hooks.
1513
:param run_hooks: Private parameter - if false, this branch
1514
is being called because it's the master of the primary branch,
1515
so it should not run its hooks.
1517
result = PullResult()
1518
result.source_branch = source
1519
result.target_branch = self
1522
result.old_revno, result.old_revid = self.last_revision_info()
1523
self.update_revisions(source, stop_revision, overwrite=overwrite)
1524
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1525
result.new_revno, result.new_revid = self.last_revision_info()
1527
result.master_branch = _hook_master
1528
result.local_branch = self
1530
result.master_branch = self
1531
result.local_branch = None
1533
for hook in Branch.hooks['post_pull']:
1539
def _get_parent_location(self):
1540
_locs = ['parent', 'pull', 'x-pull']
1543
return self.control_files.get(l).read().strip('\n')
1544
except errors.NoSuchFile:
1549
def push(self, target, overwrite=False, stop_revision=None,
1550
_override_hook_source_branch=None):
1553
This is the basic concrete implementation of push()
1555
:param _override_hook_source_branch: If specified, run
1556
the hooks passing this Branch as the source, rather than self.
1557
This is for use of RemoteBranch, where push is delegated to the
1558
underlying vfs-based Branch.
1560
# TODO: Public option to disable running hooks - should be trivial but
1564
result = self._push_with_bound_branches(target, overwrite,
1566
_override_hook_source_branch=_override_hook_source_branch)
1571
def _push_with_bound_branches(self, target, overwrite,
1573
_override_hook_source_branch=None):
1574
"""Push from self into target, and into target's master if any.
1576
This is on the base BzrBranch class even though it doesn't support
1577
bound branches because the *target* might be bound.
1580
if _override_hook_source_branch:
1581
result.source_branch = _override_hook_source_branch
1582
for hook in Branch.hooks['post_push']:
1585
bound_location = target.get_bound_location()
1586
if bound_location and target.base != bound_location:
1587
# there is a master branch.
1589
# XXX: Why the second check? Is it even supported for a branch to
1590
# be bound to itself? -- mbp 20070507
1591
master_branch = target.get_master_branch()
1592
master_branch.lock_write()
1594
# push into the master from this branch.
1595
self._basic_push(master_branch, overwrite, stop_revision)
1596
# and push into the target branch from this. Note that we push from
1597
# this branch again, because its considered the highest bandwidth
1599
result = self._basic_push(target, overwrite, stop_revision)
1600
result.master_branch = master_branch
1601
result.local_branch = target
1605
master_branch.unlock()
1608
result = self._basic_push(target, overwrite, stop_revision)
1609
# TODO: Why set master_branch and local_branch if there's no
1610
# binding? Maybe cleaner to just leave them unset? -- mbp
1612
result.master_branch = target
1613
result.local_branch = None
1617
def _basic_push(self, target, overwrite, stop_revision):
1618
"""Basic implementation of push without bound branches or hooks.
1620
Must be called with self read locked and target write locked.
1622
result = PushResult()
1623
result.source_branch = self
1624
result.target_branch = target
1625
result.old_revno, result.old_revid = target.last_revision_info()
1627
target.update_revisions(self, stop_revision)
1628
except errors.DivergedBranches:
1632
target.set_revision_history(self.revision_history())
1633
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1634
result.new_revno, result.new_revid = target.last_revision_info()
1637
def get_parent(self):
1638
"""See Branch.get_parent."""
1640
assert self.base[-1] == '/'
1641
parent = self._get_parent_location()
1644
# This is an old-format absolute path to a local branch
1645
# turn it into a url
1646
if parent.startswith('/'):
1647
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1649
return urlutils.join(self.base[:-1], parent)
1650
except errors.InvalidURLJoin, e:
1651
raise errors.InaccessibleParent(parent, self.base)
1653
def set_push_location(self, location):
1654
"""See Branch.set_push_location."""
1655
self.get_config().set_user_option(
1656
'push_location', location,
1657
store=_mod_config.STORE_LOCATION_NORECURSE)
1660
def set_parent(self, url):
1661
"""See Branch.set_parent."""
1662
# TODO: Maybe delete old location files?
1663
# URLs should never be unicode, even on the local fs,
1664
# FIXUP this and get_parent in a future branch format bump:
1665
# read and rewrite the file, and have the new format code read
1666
# using .get not .get_utf8. RBC 20060125
1668
if isinstance(url, unicode):
1670
url = url.encode('ascii')
1671
except UnicodeEncodeError:
1672
raise errors.InvalidURL(url,
1673
"Urls must be 7-bit ascii, "
1674
"use bzrlib.urlutils.escape")
1675
url = urlutils.relative_url(self.base, url)
1676
self._set_parent_location(url)
1678
def _set_parent_location(self, url):
1680
self.control_files._transport.delete('parent')
1682
assert isinstance(url, str)
1683
self.control_files.put_bytes('parent', url + '\n')
1686
class BzrBranch5(BzrBranch):
1687
"""A format 5 branch. This supports new features over plain branches.
1689
It has support for a master_branch which is the data for bound branches.
1697
super(BzrBranch5, self).__init__(_format=_format,
1698
_control_files=_control_files,
1700
_repository=_repository)
1703
def pull(self, source, overwrite=False, stop_revision=None,
1704
run_hooks=True, possible_transports=None):
1705
"""Pull from source into self, updating my master if any.
1707
:param run_hooks: Private parameter - if false, this branch
1708
is being called because it's the master of the primary branch,
1709
so it should not run its hooks.
1711
bound_location = self.get_bound_location()
1712
master_branch = None
1713
if bound_location and source.base != bound_location:
1714
# not pulling from master, so we need to update master.
1715
master_branch = self.get_master_branch(possible_transports)
1716
master_branch.lock_write()
1719
# pull from source into master.
1720
master_branch.pull(source, overwrite, stop_revision,
1722
return super(BzrBranch5, self).pull(source, overwrite,
1723
stop_revision, _hook_master=master_branch,
1724
run_hooks=run_hooks)
1727
master_branch.unlock()
1729
def get_bound_location(self):
1731
return self.control_files.get_utf8('bound').read()[:-1]
1732
except errors.NoSuchFile:
1736
def get_master_branch(self, possible_transports=None):
1737
"""Return the branch we are bound to.
1739
:return: Either a Branch, or None
1741
This could memoise the branch, but if thats done
1742
it must be revalidated on each new lock.
1743
So for now we just don't memoise it.
1744
# RBC 20060304 review this decision.
1746
bound_loc = self.get_bound_location()
1750
return Branch.open(bound_loc,
1751
possible_transports=possible_transports)
1752
except (errors.NotBranchError, errors.ConnectionError), e:
1753
raise errors.BoundBranchConnectionFailure(
1757
def set_bound_location(self, location):
1758
"""Set the target where this branch is bound to.
1760
:param location: URL to the target branch
1763
self.control_files.put_utf8('bound', location+'\n')
1766
self.control_files._transport.delete('bound')
1767
except errors.NoSuchFile:
1772
def bind(self, other):
1773
"""Bind this branch to the branch other.
1775
This does not push or pull data between the branches, though it does
1776
check for divergence to raise an error when the branches are not
1777
either the same, or one a prefix of the other. That behaviour may not
1778
be useful, so that check may be removed in future.
1780
:param other: The branch to bind to
1783
# TODO: jam 20051230 Consider checking if the target is bound
1784
# It is debatable whether you should be able to bind to
1785
# a branch which is itself bound.
1786
# Committing is obviously forbidden,
1787
# but binding itself may not be.
1788
# Since we *have* to check at commit time, we don't
1789
# *need* to check here
1791
# we want to raise diverged if:
1792
# last_rev is not in the other_last_rev history, AND
1793
# other_last_rev is not in our history, and do it without pulling
1795
self.set_bound_location(other.base)
1799
"""If bound, unbind"""
1800
return self.set_bound_location(None)
1803
def update(self, possible_transports=None):
1804
"""Synchronise this branch with the master branch if any.
1806
:return: None or the last_revision that was pivoted out during the
1809
master = self.get_master_branch(possible_transports)
1810
if master is not None:
1811
old_tip = _mod_revision.ensure_null(self.last_revision())
1812
self.pull(master, overwrite=True)
1813
if self.repository.get_graph().is_ancestor(old_tip,
1814
_mod_revision.ensure_null(self.last_revision())):
1820
class BzrBranch6(BzrBranch5):
1823
def last_revision_info(self):
1824
revision_string = self.control_files.get('last-revision').read()
1825
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1826
revision_id = cache_utf8.get_cached_utf8(revision_id)
1828
return revno, revision_id
1830
def _write_last_revision_info(self, revno, revision_id):
1831
"""Simply write out the revision id, with no checks.
1833
Use set_last_revision_info to perform this safely.
1835
Does not update the revision_history cache.
1836
Intended to be called by set_last_revision_info and
1837
_write_revision_history.
1839
assert revision_id is not None, "Use NULL_REVISION, not None"
1840
out_string = '%d %s\n' % (revno, revision_id)
1841
self.control_files.put_bytes('last-revision', out_string)
1844
def set_last_revision_info(self, revno, revision_id):
1845
revision_id = _mod_revision.ensure_null(revision_id)
1846
if self._get_append_revisions_only():
1847
self._check_history_violation(revision_id)
1848
self._write_last_revision_info(revno, revision_id)
1849
self._clear_cached_state()
1851
def _check_history_violation(self, revision_id):
1852
last_revision = _mod_revision.ensure_null(self.last_revision())
1853
if _mod_revision.is_null(last_revision):
1855
if last_revision not in self._lefthand_history(revision_id):
1856
raise errors.AppendRevisionsOnlyViolation(self.base)
1858
def _gen_revision_history(self):
1859
"""Generate the revision history from last revision
1861
history = list(self.repository.iter_reverse_revision_history(
1862
self.last_revision()))
1866
def _write_revision_history(self, history):
1867
"""Factored out of set_revision_history.
1869
This performs the actual writing to disk, with format-specific checks.
1870
It is intended to be called by BzrBranch5.set_revision_history.
1872
if len(history) == 0:
1873
last_revision = 'null:'
1875
if history != self._lefthand_history(history[-1]):
1876
raise errors.NotLefthandHistory(history)
1877
last_revision = history[-1]
1878
if self._get_append_revisions_only():
1879
self._check_history_violation(last_revision)
1880
self._write_last_revision_info(len(history), last_revision)
1883
def _set_parent_location(self, url):
1884
"""Set the parent branch"""
1885
self._set_config_location('parent_location', url, make_relative=True)
1888
def _get_parent_location(self):
1889
"""Set the parent branch"""
1890
return self._get_config_location('parent_location')
1892
def set_push_location(self, location):
1893
"""See Branch.set_push_location."""
1894
self._set_config_location('push_location', location)
1896
def set_bound_location(self, location):
1897
"""See Branch.set_push_location."""
1899
config = self.get_config()
1900
if location is None:
1901
if config.get_user_option('bound') != 'True':
1904
config.set_user_option('bound', 'False', warn_masked=True)
1907
self._set_config_location('bound_location', location,
1909
config.set_user_option('bound', 'True', warn_masked=True)
1912
def _get_bound_location(self, bound):
1913
"""Return the bound location in the config file.
1915
Return None if the bound parameter does not match"""
1916
config = self.get_config()
1917
config_bound = (config.get_user_option('bound') == 'True')
1918
if config_bound != bound:
1920
return self._get_config_location('bound_location', config=config)
1922
def get_bound_location(self):
1923
"""See Branch.set_push_location."""
1924
return self._get_bound_location(True)
1926
def get_old_bound_location(self):
1927
"""See Branch.get_old_bound_location"""
1928
return self._get_bound_location(False)
1930
def set_append_revisions_only(self, enabled):
1935
self.get_config().set_user_option('append_revisions_only', value,
1938
def _get_append_revisions_only(self):
1939
value = self.get_config().get_user_option('append_revisions_only')
1940
return value == 'True'
1942
def _synchronize_history(self, destination, revision_id):
1943
"""Synchronize last revision and revision history between branches.
1945
This version is most efficient when the destination is also a
1946
BzrBranch6, but works for BzrBranch5, as long as the destination's
1947
repository contains all the lefthand ancestors of the intended
1948
last_revision. If not, set_last_revision_info will fail.
1950
:param destination: The branch to copy the history into
1951
:param revision_id: The revision-id to truncate history at. May
1952
be None to copy complete history.
1954
source_revno, source_revision_id = self.last_revision_info()
1955
if revision_id is None:
1956
revno, revision_id = source_revno, source_revision_id
1957
elif source_revision_id == revision_id:
1958
# we know the revno without needing to walk all of history
1959
revno = source_revno
1961
# To figure out the revno for a random revision, we need to build
1962
# the revision history, and count its length.
1963
# We don't care about the order, just how long it is.
1964
# Alternatively, we could start at the current location, and count
1965
# backwards. But there is no guarantee that we will find it since
1966
# it may be a merged revision.
1967
revno = len(list(self.repository.iter_reverse_revision_history(
1969
destination.set_last_revision_info(revno, revision_id)
1971
def _make_tags(self):
1972
return BasicTags(self)
1975
def generate_revision_history(self, revision_id, last_rev=None,
1977
"""See BzrBranch5.generate_revision_history"""
1978
history = self._lefthand_history(revision_id, last_rev, other_branch)
1979
revno = len(history)
1980
self.set_last_revision_info(revno, revision_id)
1983
######################################################################
1984
# results of operations
1987
class _Result(object):
1989
def _show_tag_conficts(self, to_file):
1990
if not getattr(self, 'tag_conflicts', None):
1992
to_file.write('Conflicting tags:\n')
1993
for name, value1, value2 in self.tag_conflicts:
1994
to_file.write(' %s\n' % (name, ))
1997
class PullResult(_Result):
1998
"""Result of a Branch.pull operation.
2000
:ivar old_revno: Revision number before pull.
2001
:ivar new_revno: Revision number after pull.
2002
:ivar old_revid: Tip revision id before pull.
2003
:ivar new_revid: Tip revision id after pull.
2004
:ivar source_branch: Source (local) branch object.
2005
:ivar master_branch: Master branch of the target, or None.
2006
:ivar target_branch: Target/destination branch object.
2010
# DEPRECATED: pull used to return the change in revno
2011
return self.new_revno - self.old_revno
2013
def report(self, to_file):
2015
if self.old_revid == self.new_revid:
2016
to_file.write('No revisions to pull.\n')
2018
to_file.write('Now on revision %d.\n' % self.new_revno)
2019
self._show_tag_conficts(to_file)
2022
class PushResult(_Result):
2023
"""Result of a Branch.push operation.
2025
:ivar old_revno: Revision number before push.
2026
:ivar new_revno: Revision number after push.
2027
:ivar old_revid: Tip revision id before push.
2028
:ivar new_revid: Tip revision id after push.
2029
:ivar source_branch: Source branch object.
2030
:ivar master_branch: Master branch of the target, or None.
2031
:ivar target_branch: Target/destination branch object.
2035
# DEPRECATED: push used to return the change in revno
2036
return self.new_revno - self.old_revno
2038
def report(self, to_file):
2039
"""Write a human-readable description of the result."""
2040
if self.old_revid == self.new_revid:
2041
to_file.write('No new revisions to push.\n')
2043
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2044
self._show_tag_conficts(to_file)
2047
class BranchCheckResult(object):
2048
"""Results of checking branch consistency.
2053
def __init__(self, branch):
2054
self.branch = branch
2056
def report_results(self, verbose):
2057
"""Report the check results via trace.note.
2059
:param verbose: Requests more detailed display of what was checked,
2062
note('checked branch %s format %s',
2064
self.branch._format)
2067
class Converter5to6(object):
2068
"""Perform an in-place upgrade of format 5 to format 6"""
2070
def convert(self, branch):
2071
# Data for 5 and 6 can peacefully coexist.
2072
format = BzrBranchFormat6()
2073
new_branch = format.open(branch.bzrdir, _found=True)
2075
# Copy source data into target
2076
new_branch.set_last_revision_info(*branch.last_revision_info())
2077
new_branch.set_parent(branch.get_parent())
2078
new_branch.set_bound_location(branch.get_bound_location())
2079
new_branch.set_push_location(branch.get_push_location())
2081
# New branch has no tags by default
2082
new_branch.tags._set_tag_dict({})
2084
# Copying done; now update target format
2085
new_branch.control_files.put_utf8('format',
2086
format.get_format_string())
2088
# Clean up old files
2089
new_branch.control_files._transport.delete('revision-history')
2091
branch.set_parent(None)
2092
except errors.NoSuchFile:
2094
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
