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.trace import mutter, mutter_callsite, note, is_quiet
47
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
48
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
49
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
52
# TODO: Maybe include checks for common corruption of newlines, etc?
54
# TODO: Some operations like log might retrieve the same revisions
55
# repeatedly to calculate deltas. We could perhaps have a weakref
56
# cache in memory to make this faster. In general anything can be
57
# cached in memory between lock and unlock operations. .. nb thats
58
# what the transaction identity map provides
61
######################################################################
65
"""Branch holding a history of revisions.
68
Base directory/url of the branch.
70
hooks: An instance of BranchHooks.
72
# this is really an instance variable - FIXME move it there
76
# override this to set the strategy for storing tags
78
return DisabledTags(self)
80
def __init__(self, *ignored, **ignored_too):
81
self.tags = self._make_tags()
82
self._revision_history_cache = None
83
self._revision_id_to_revno_cache = None
86
"""Break a lock if one is present from another instance.
88
Uses the ui factory to ask for confirmation if the lock may be from
91
This will probe the repository for its lock as well.
93
self.control_files.break_lock()
94
self.repository.break_lock()
95
master = self.get_master_branch()
96
if master is not None:
100
def open(base, _unsupported=False, possible_transports=None):
101
"""Open the branch rooted at base.
103
For instance, if the branch is at URL/.bzr/branch,
104
Branch.open(URL) -> a Branch instance.
106
control = bzrdir.BzrDir.open(base, _unsupported,
107
possible_transports=possible_transports)
108
return control.open_branch(_unsupported)
111
def open_from_transport(transport, _unsupported=False):
112
"""Open the branch rooted at transport"""
113
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
114
return control.open_branch(_unsupported)
117
def open_containing(url, possible_transports=None):
118
"""Open an existing branch which contains url.
120
This probes for a branch at url, and searches upwards from there.
122
Basically we keep looking up until we find the control directory or
123
run into the root. If there isn't one, raises NotBranchError.
124
If there is one and it is either an unrecognised format or an unsupported
125
format, UnknownFormatError or UnsupportedFormatError are raised.
126
If there is one, it is returned, along with the unused portion of url.
128
control, relpath = bzrdir.BzrDir.open_containing(url,
130
return control.open_branch(), relpath
132
def get_config(self):
133
return BranchConfig(self)
136
return self.get_config().get_nickname()
138
def _set_nick(self, nick):
139
self.get_config().set_user_option('nickname', nick, warn_masked=True)
141
nick = property(_get_nick, _set_nick)
144
raise NotImplementedError(self.is_locked)
146
def lock_write(self):
147
raise NotImplementedError(self.lock_write)
150
raise NotImplementedError(self.lock_read)
153
raise NotImplementedError(self.unlock)
155
def peek_lock_mode(self):
156
"""Return lock mode for the Branch: 'r', 'w' or None"""
157
raise NotImplementedError(self.peek_lock_mode)
159
def get_physical_lock_status(self):
160
raise NotImplementedError(self.get_physical_lock_status)
163
def get_revision_id_to_revno_map(self):
164
"""Return the revision_id => dotted revno map.
166
This will be regenerated on demand, but will be cached.
168
:return: A dictionary mapping revision_id => dotted revno.
169
This dictionary should not be modified by the caller.
171
if self._revision_id_to_revno_cache is not None:
172
mapping = self._revision_id_to_revno_cache
174
mapping = self._gen_revno_map()
175
self._cache_revision_id_to_revno(mapping)
176
# TODO: jam 20070417 Since this is being cached, should we be returning
178
# I would rather not, and instead just declare that users should not
179
# modify the return value.
182
def _gen_revno_map(self):
183
"""Create a new mapping from revision ids to dotted revnos.
185
Dotted revnos are generated based on the current tip in the revision
187
This is the worker function for get_revision_id_to_revno_map, which
188
just caches the return value.
190
:return: A dictionary mapping revision_id => dotted revno.
192
last_revision = self.last_revision()
193
revision_graph = repository._old_get_graph(self.repository,
195
merge_sorted_revisions = tsort.merge_sort(
200
revision_id_to_revno = dict((rev_id, revno)
201
for seq_num, rev_id, depth, revno, end_of_merge
202
in merge_sorted_revisions)
203
return revision_id_to_revno
205
def leave_lock_in_place(self):
206
"""Tell this branch object not to release the physical lock when this
209
If lock_write doesn't return a token, then this method is not supported.
211
self.control_files.leave_in_place()
213
def dont_leave_lock_in_place(self):
214
"""Tell this branch object to release the physical lock when this
215
object is unlocked, even if it didn't originally acquire it.
217
If lock_write doesn't return a token, then this method is not supported.
219
self.control_files.dont_leave_in_place()
221
def abspath(self, name):
222
"""Return absolute filename for something in the branch
224
XXX: Robert Collins 20051017 what is this used for? why is it a branch
225
method and not a tree method.
227
raise NotImplementedError(self.abspath)
229
def bind(self, other):
230
"""Bind the local branch the other branch.
232
:param other: The branch to bind to
235
raise errors.UpgradeRequired(self.base)
238
def fetch(self, from_branch, last_revision=None, pb=None):
239
"""Copy revisions from from_branch into this branch.
241
:param from_branch: Where to copy from.
242
:param last_revision: What revision to stop at (None for at the end
244
:param pb: An optional progress bar to use.
246
Returns the copied revision count and the failed revisions in a tuple:
249
if self.base == from_branch.base:
252
nested_pb = ui.ui_factory.nested_progress_bar()
257
from_branch.lock_read()
259
if last_revision is None:
260
pb.update('get source history')
261
last_revision = from_branch.last_revision()
262
last_revision = _mod_revision.ensure_null(last_revision)
263
return self.repository.fetch(from_branch.repository,
264
revision_id=last_revision,
267
if nested_pb is not None:
271
def get_bound_location(self):
272
"""Return the URL of the branch we are bound to.
274
Older format branches cannot bind, please be sure to use a metadir
279
def get_old_bound_location(self):
280
"""Return the URL of the branch we used to be bound to
282
raise errors.UpgradeRequired(self.base)
284
def get_commit_builder(self, parents, config=None, timestamp=None,
285
timezone=None, committer=None, revprops=None,
287
"""Obtain a CommitBuilder for this branch.
289
:param parents: Revision ids of the parents of the new revision.
290
:param config: Optional configuration to use.
291
:param timestamp: Optional timestamp recorded for commit.
292
:param timezone: Optional timezone for timestamp.
293
:param committer: Optional committer to set for commit.
294
:param revprops: Optional dictionary of revision properties.
295
:param revision_id: Optional revision id.
299
config = self.get_config()
301
return self.repository.get_commit_builder(self, parents, config,
302
timestamp, timezone, committer, revprops, revision_id)
304
def get_master_branch(self, possible_transports=None):
305
"""Return the branch we are bound to.
307
:return: Either a Branch, or None
311
def get_revision_delta(self, revno):
312
"""Return the delta for one revision.
314
The delta is relative to its mainline predecessor, or the
315
empty tree for revision 1.
317
assert isinstance(revno, int)
318
rh = self.revision_history()
319
if not (1 <= revno <= len(rh)):
320
raise errors.InvalidRevisionNumber(revno)
321
return self.repository.get_revision_delta(rh[revno-1])
323
def print_file(self, file, revision_id):
324
"""Print `file` to stdout."""
325
raise NotImplementedError(self.print_file)
327
def set_revision_history(self, rev_history):
328
raise NotImplementedError(self.set_revision_history)
330
def _cache_revision_history(self, rev_history):
331
"""Set the cached revision history to rev_history.
333
The revision_history method will use this cache to avoid regenerating
334
the revision history.
336
This API is semi-public; it only for use by subclasses, all other code
337
should consider it to be private.
339
self._revision_history_cache = rev_history
341
def _cache_revision_id_to_revno(self, revision_id_to_revno):
342
"""Set the cached revision_id => revno map to revision_id_to_revno.
344
This API is semi-public; it only for use by subclasses, all other code
345
should consider it to be private.
347
self._revision_id_to_revno_cache = revision_id_to_revno
349
def _clear_cached_state(self):
350
"""Clear any cached data on this branch, e.g. cached revision history.
352
This means the next call to revision_history will need to call
353
_gen_revision_history.
355
This API is semi-public; it only for use by subclasses, all other code
356
should consider it to be private.
358
self._revision_history_cache = None
359
self._revision_id_to_revno_cache = None
361
def _gen_revision_history(self):
362
"""Return sequence of revision hashes on to this branch.
364
Unlike revision_history, this method always regenerates or rereads the
365
revision history, i.e. it does not cache the result, so repeated calls
368
Concrete subclasses should override this instead of revision_history so
369
that subclasses do not need to deal with caching logic.
371
This API is semi-public; it only for use by subclasses, all other code
372
should consider it to be private.
374
raise NotImplementedError(self._gen_revision_history)
377
def revision_history(self):
378
"""Return sequence of revision ids on this branch.
380
This method will cache the revision history for as long as it is safe to
383
if 'evil' in debug.debug_flags:
384
mutter_callsite(3, "revision_history scales with history.")
385
if self._revision_history_cache is not None:
386
history = self._revision_history_cache
388
history = self._gen_revision_history()
389
self._cache_revision_history(history)
393
"""Return current revision number for this branch.
395
That is equivalent to the number of revisions committed to
398
return self.last_revision_info()[0]
401
"""Older format branches cannot bind or unbind."""
402
raise errors.UpgradeRequired(self.base)
404
def set_append_revisions_only(self, enabled):
405
"""Older format branches are never restricted to append-only"""
406
raise errors.UpgradeRequired(self.base)
408
def last_revision(self):
409
"""Return last revision id, or NULL_REVISION."""
410
return self.last_revision_info()[1]
412
def last_revision_info(self):
413
"""Return information about the last revision.
415
:return: A tuple (revno, last_revision_id).
417
rh = self.revision_history()
420
return (revno, rh[-1])
422
return (0, _mod_revision.NULL_REVISION)
424
def missing_revisions(self, other, stop_revision=None):
425
"""Return a list of new revisions that would perfectly fit.
427
If self and other have not diverged, return a list of the revisions
428
present in other, but missing from self.
430
self_history = self.revision_history()
431
self_len = len(self_history)
432
other_history = other.revision_history()
433
other_len = len(other_history)
434
common_index = min(self_len, other_len) -1
435
if common_index >= 0 and \
436
self_history[common_index] != other_history[common_index]:
437
raise errors.DivergedBranches(self, other)
439
if stop_revision is None:
440
stop_revision = other_len
442
assert isinstance(stop_revision, int)
443
if stop_revision > other_len:
444
raise errors.NoSuchRevision(self, stop_revision)
445
return other_history[self_len:stop_revision]
447
def update_revisions(self, other, stop_revision=None):
448
"""Pull in new perfect-fit revisions.
450
:param other: Another Branch to pull from
451
:param stop_revision: Updated until the given revision
454
raise NotImplementedError(self.update_revisions)
456
def revision_id_to_revno(self, revision_id):
457
"""Given a revision id, return its revno"""
458
if _mod_revision.is_null(revision_id):
460
history = self.revision_history()
462
return history.index(revision_id) + 1
464
raise errors.NoSuchRevision(self, revision_id)
466
def get_rev_id(self, revno, history=None):
467
"""Find the revision id of the specified revno."""
469
return _mod_revision.NULL_REVISION
471
history = self.revision_history()
472
if revno <= 0 or revno > len(history):
473
raise errors.NoSuchRevision(self, revno)
474
return history[revno - 1]
476
def pull(self, source, overwrite=False, stop_revision=None,
477
possible_transports=None):
478
"""Mirror source into this branch.
480
This branch is considered to be 'local', having low latency.
482
:returns: PullResult instance
484
raise NotImplementedError(self.pull)
486
def push(self, target, overwrite=False, stop_revision=None):
487
"""Mirror this branch into target.
489
This branch is considered to be 'local', having low latency.
491
raise NotImplementedError(self.push)
493
def basis_tree(self):
494
"""Return `Tree` object for last revision."""
495
return self.repository.revision_tree(self.last_revision())
497
def rename_one(self, from_rel, to_rel):
500
This can change the directory or the filename or both.
502
raise NotImplementedError(self.rename_one)
504
def move(self, from_paths, to_name):
507
to_name must exist as a versioned directory.
509
If to_name exists and is a directory, the files are moved into
510
it, keeping their old names. If it is a directory,
512
Note that to_name is only the last component of the new name;
513
this doesn't change the directory.
515
This returns a list of (from_path, to_path) pairs for each
518
raise NotImplementedError(self.move)
520
def get_parent(self):
521
"""Return the parent location of the branch.
523
This is the default location for push/pull/missing. The usual
524
pattern is that the user can override it by specifying a
527
raise NotImplementedError(self.get_parent)
529
def _set_config_location(self, name, url, config=None,
530
make_relative=False):
532
config = self.get_config()
536
url = urlutils.relative_url(self.base, url)
537
config.set_user_option(name, url, warn_masked=True)
539
def _get_config_location(self, name, config=None):
541
config = self.get_config()
542
location = config.get_user_option(name)
547
def get_submit_branch(self):
548
"""Return the submit location of the branch.
550
This is the default location for bundle. The usual
551
pattern is that the user can override it by specifying a
554
return self.get_config().get_user_option('submit_branch')
556
def set_submit_branch(self, location):
557
"""Return the submit location of the branch.
559
This is the default location for bundle. The usual
560
pattern is that the user can override it by specifying a
563
self.get_config().set_user_option('submit_branch', location,
566
def get_public_branch(self):
567
"""Return the public location of the branch.
569
This is is used by merge directives.
571
return self._get_config_location('public_branch')
573
def set_public_branch(self, location):
574
"""Return the submit location of the branch.
576
This is the default location for bundle. The usual
577
pattern is that the user can override it by specifying a
580
self._set_config_location('public_branch', location)
582
def get_push_location(self):
583
"""Return the None or the location to push this branch to."""
584
push_loc = self.get_config().get_user_option('push_location')
587
def set_push_location(self, location):
588
"""Set a new push location for this branch."""
589
raise NotImplementedError(self.set_push_location)
591
def set_parent(self, url):
592
raise NotImplementedError(self.set_parent)
596
"""Synchronise this branch with the master branch if any.
598
:return: None or the last_revision pivoted out during the update.
602
def check_revno(self, revno):
604
Check whether a revno corresponds to any revision.
605
Zero (the NULL revision) is considered valid.
608
self.check_real_revno(revno)
610
def check_real_revno(self, revno):
612
Check whether a revno corresponds to a real revision.
613
Zero (the NULL revision) is considered invalid
615
if revno < 1 or revno > self.revno():
616
raise errors.InvalidRevisionNumber(revno)
619
def clone(self, to_bzrdir, revision_id=None):
620
"""Clone this branch into to_bzrdir preserving all semantic values.
622
revision_id: if not None, the revision history in the new branch will
623
be truncated to end with revision_id.
625
result = self._format.initialize(to_bzrdir)
626
self.copy_content_into(result, revision_id=revision_id)
630
def sprout(self, to_bzrdir, revision_id=None):
631
"""Create a new line of development from the branch, into to_bzrdir.
633
revision_id: if not None, the revision history in the new branch will
634
be truncated to end with revision_id.
636
result = self._format.initialize(to_bzrdir)
637
self.copy_content_into(result, revision_id=revision_id)
638
result.set_parent(self.bzrdir.root_transport.base)
641
def _synchronize_history(self, destination, revision_id):
642
"""Synchronize last revision and revision history between branches.
644
This version is most efficient when the destination is also a
645
BzrBranch5, but works for BzrBranch6 as long as the revision
646
history is the true lefthand parent history, and all of the revisions
647
are in the destination's repository. If not, set_revision_history
650
:param destination: The branch to copy the history into
651
:param revision_id: The revision-id to truncate history at. May
652
be None to copy complete history.
654
if revision_id == _mod_revision.NULL_REVISION:
656
new_history = self.revision_history()
657
if revision_id is not None and new_history != []:
659
new_history = new_history[:new_history.index(revision_id) + 1]
661
rev = self.repository.get_revision(revision_id)
662
new_history = rev.get_history(self.repository)[1:]
663
destination.set_revision_history(new_history)
666
def copy_content_into(self, destination, revision_id=None):
667
"""Copy the content of self into destination.
669
revision_id: if not None, the revision history in the new branch will
670
be truncated to end with revision_id.
672
self._synchronize_history(destination, revision_id)
674
parent = self.get_parent()
675
except errors.InaccessibleParent, e:
676
mutter('parent was not accessible to copy: %s', e)
679
destination.set_parent(parent)
680
self.tags.merge_to(destination.tags)
684
"""Check consistency of the branch.
686
In particular this checks that revisions given in the revision-history
687
do actually match up in the revision graph, and that they're all
688
present in the repository.
690
Callers will typically also want to check the repository.
692
:return: A BranchCheckResult.
694
mainline_parent_id = None
695
last_revno, last_revision_id = self.last_revision_info()
696
real_rev_history = list(self.repository.iter_reverse_revision_history(
698
real_rev_history.reverse()
699
if len(real_rev_history) != last_revno:
700
raise errors.BzrCheckError('revno does not match len(mainline)'
701
' %s != %s' % (last_revno, len(real_rev_history)))
702
# TODO: We should probably also check that real_rev_history actually
703
# matches self.revision_history()
704
for revision_id in real_rev_history:
706
revision = self.repository.get_revision(revision_id)
707
except errors.NoSuchRevision, e:
708
raise errors.BzrCheckError("mainline revision {%s} not in repository"
710
# In general the first entry on the revision history has no parents.
711
# But it's not illegal for it to have parents listed; this can happen
712
# in imports from Arch when the parents weren't reachable.
713
if mainline_parent_id is not None:
714
if mainline_parent_id not in revision.parent_ids:
715
raise errors.BzrCheckError("previous revision {%s} not listed among "
717
% (mainline_parent_id, revision_id))
718
mainline_parent_id = revision_id
719
return BranchCheckResult(self)
721
def _get_checkout_format(self):
722
"""Return the most suitable metadir for a checkout of this branch.
723
Weaves are used if this branch's repository uses weaves.
725
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
726
from bzrlib.repofmt import weaverepo
727
format = bzrdir.BzrDirMetaFormat1()
728
format.repository_format = weaverepo.RepositoryFormat7()
730
format = self.repository.bzrdir.checkout_metadir()
731
format.set_branch_format(self._format)
734
def create_checkout(self, to_location, revision_id=None,
735
lightweight=False, accelerator_tree=None,
737
"""Create a checkout of a branch.
739
:param to_location: The url to produce the checkout at
740
:param revision_id: The revision to check out
741
:param lightweight: If True, produce a lightweight checkout, otherwise,
742
produce a bound branch (heavyweight checkout)
743
:param accelerator_tree: A tree which can be used for retrieving file
744
contents more quickly than the revision tree, i.e. a workingtree.
745
The revision tree will be used for cases where accelerator_tree's
746
content is different.
747
:param hardlink: If true, hard-link files from accelerator_tree,
749
:return: The tree of the created checkout
751
t = transport.get_transport(to_location)
754
format = self._get_checkout_format()
755
checkout = format.initialize_on_transport(t)
756
from_branch = BranchReferenceFormat().initialize(checkout, self)
758
format = self._get_checkout_format()
759
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
760
to_location, force_new_tree=False, format=format)
761
checkout = checkout_branch.bzrdir
762
checkout_branch.bind(self)
763
# pull up to the specified revision_id to set the initial
764
# branch tip correctly, and seed it with history.
765
checkout_branch.pull(self, stop_revision=revision_id)
767
tree = checkout.create_workingtree(revision_id,
768
from_branch=from_branch,
769
accelerator_tree=accelerator_tree,
771
basis_tree = tree.basis_tree()
772
basis_tree.lock_read()
774
for path, file_id in basis_tree.iter_references():
775
reference_parent = self.reference_parent(file_id, path)
776
reference_parent.create_checkout(tree.abspath(path),
777
basis_tree.get_reference_revision(file_id, path),
784
def reconcile(self, thorough=True):
785
"""Make sure the data stored in this branch is consistent."""
786
from bzrlib.reconcile import BranchReconciler
787
reconciler = BranchReconciler(self, thorough=thorough)
788
reconciler.reconcile()
791
def reference_parent(self, file_id, path):
792
"""Return the parent branch for a tree-reference file_id
793
:param file_id: The file_id of the tree reference
794
:param path: The path of the file_id in the tree
795
:return: A branch associated with the file_id
797
# FIXME should provide multiple branches, based on config
798
return Branch.open(self.bzrdir.root_transport.clone(path).base)
800
def supports_tags(self):
801
return self._format.supports_tags()
804
class BranchFormat(object):
805
"""An encapsulation of the initialization and open routines for a format.
807
Formats provide three things:
808
* An initialization routine,
812
Formats are placed in an dict by their format string for reference
813
during branch opening. Its not required that these be instances, they
814
can be classes themselves with class methods - it simply depends on
815
whether state is needed for a given format or not.
817
Once a format is deprecated, just deprecate the initialize and open
818
methods on the format class. Do not deprecate the object, as the
819
object will be created every time regardless.
822
_default_format = None
823
"""The default format used for new branches."""
826
"""The known formats."""
828
def __eq__(self, other):
829
return self.__class__ is other.__class__
831
def __ne__(self, other):
832
return not (self == other)
835
def find_format(klass, a_bzrdir):
836
"""Return the format for the branch object in a_bzrdir."""
838
transport = a_bzrdir.get_branch_transport(None)
839
format_string = transport.get("format").read()
840
return klass._formats[format_string]
841
except errors.NoSuchFile:
842
raise errors.NotBranchError(path=transport.base)
844
raise errors.UnknownFormatError(format=format_string, kind='branch')
847
def get_default_format(klass):
848
"""Return the current default format."""
849
return klass._default_format
851
def get_reference(self, a_bzrdir):
852
"""Get the target reference of the branch in a_bzrdir.
854
format probing must have been completed before calling
855
this method - it is assumed that the format of the branch
856
in a_bzrdir is correct.
858
:param a_bzrdir: The bzrdir to get the branch data from.
859
:return: None if the branch is not a reference branch.
864
def set_reference(self, a_bzrdir, to_branch):
865
"""Set the target reference of the branch in a_bzrdir.
867
format probing must have been completed before calling
868
this method - it is assumed that the format of the branch
869
in a_bzrdir is correct.
871
:param a_bzrdir: The bzrdir to set the branch reference for.
872
:param to_branch: branch that the checkout is to reference
874
raise NotImplementedError(self.set_reference)
876
def get_format_string(self):
877
"""Return the ASCII format string that identifies this format."""
878
raise NotImplementedError(self.get_format_string)
880
def get_format_description(self):
881
"""Return the short format description for this format."""
882
raise NotImplementedError(self.get_format_description)
884
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
886
"""Initialize a branch in a bzrdir, with specified files
888
:param a_bzrdir: The bzrdir to initialize the branch in
889
:param utf8_files: The files to create as a list of
890
(filename, content) tuples
891
:param set_format: If True, set the format with
892
self.get_format_string. (BzrBranch4 has its format set
894
:return: a branch in this format
896
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
897
branch_transport = a_bzrdir.get_branch_transport(self)
899
'metadir': ('lock', lockdir.LockDir),
900
'branch4': ('branch-lock', lockable_files.TransportLock),
902
lock_name, lock_class = lock_map[lock_type]
903
control_files = lockable_files.LockableFiles(branch_transport,
904
lock_name, lock_class)
905
control_files.create_lock()
906
control_files.lock_write()
908
control_files.put_utf8('format', self.get_format_string())
910
for file, content in utf8_files:
911
control_files.put_utf8(file, content)
913
control_files.unlock()
914
return self.open(a_bzrdir, _found=True)
916
def initialize(self, a_bzrdir):
917
"""Create a branch of this format in a_bzrdir."""
918
raise NotImplementedError(self.initialize)
920
def is_supported(self):
921
"""Is this format supported?
923
Supported formats can be initialized and opened.
924
Unsupported formats may not support initialization or committing or
925
some other features depending on the reason for not being supported.
929
def open(self, a_bzrdir, _found=False):
930
"""Return the branch object for a_bzrdir
932
_found is a private parameter, do not use it. It is used to indicate
933
if format probing has already be done.
935
raise NotImplementedError(self.open)
938
def register_format(klass, format):
939
klass._formats[format.get_format_string()] = format
942
def set_default_format(klass, format):
943
klass._default_format = format
946
def unregister_format(klass, format):
947
assert klass._formats[format.get_format_string()] is format
948
del klass._formats[format.get_format_string()]
951
return self.get_format_string().rstrip()
953
def supports_tags(self):
954
"""True if this format supports tags stored in the branch"""
955
return False # by default
957
# XXX: Probably doesn't really belong here -- mbp 20070212
958
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
960
branch_transport = a_bzrdir.get_branch_transport(self)
961
control_files = lockable_files.LockableFiles(branch_transport,
962
lock_filename, lock_class)
963
control_files.create_lock()
964
control_files.lock_write()
966
for filename, content in utf8_files:
967
control_files.put_utf8(filename, content)
969
control_files.unlock()
972
class BranchHooks(Hooks):
973
"""A dictionary mapping hook name to a list of callables for branch hooks.
975
e.g. ['set_rh'] Is the list of items to be called when the
976
set_revision_history function is invoked.
980
"""Create the default hooks.
982
These are all empty initially, because by default nothing should get
986
# Introduced in 0.15:
987
# invoked whenever the revision history has been set
988
# with set_revision_history. The api signature is
989
# (branch, revision_history), and the branch will
992
# invoked after a push operation completes.
993
# the api signature is
995
# containing the members
996
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
997
# where local is the local target branch or None, master is the target
998
# master branch, and the rest should be self explanatory. The source
999
# is read locked and the target branches write locked. Source will
1000
# be the local low-latency branch.
1001
self['post_push'] = []
1002
# invoked after a pull operation completes.
1003
# the api signature is
1005
# containing the members
1006
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1007
# where local is the local branch or None, master is the target
1008
# master branch, and the rest should be self explanatory. The source
1009
# is read locked and the target branches write locked. The local
1010
# branch is the low-latency branch.
1011
self['post_pull'] = []
1012
# invoked before a commit operation takes place.
1013
# the api signature is
1014
# (local, master, old_revno, old_revid, future_revno, future_revid,
1015
# tree_delta, future_tree).
1016
# old_revid is NULL_REVISION for the first commit to a branch
1017
# tree_delta is a TreeDelta object describing changes from the basis
1018
# revision, hooks MUST NOT modify this delta
1019
# future_tree is an in-memory tree obtained from
1020
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1021
self['pre_commit'] = []
1022
# invoked after a commit operation completes.
1023
# the api signature is
1024
# (local, master, old_revno, old_revid, new_revno, new_revid)
1025
# old_revid is NULL_REVISION for the first commit to a branch.
1026
self['post_commit'] = []
1027
# invoked after a uncommit operation completes.
1028
# the api signature is
1029
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1030
# local is the local branch or None, master is the target branch,
1031
# and an empty branch recieves new_revno of 0, new_revid of None.
1032
self['post_uncommit'] = []
1034
# Invoked after the tip of a branch changes.
1035
# the api signature is
1036
# (params) where params is a ChangeBranchTipParams with the members
1037
# (branch, old_revno, new_revno, old_revid, new_revid)
1038
self['post_change_branch_tip'] = []
1041
# install the default hooks into the Branch class.
1042
Branch.hooks = BranchHooks()
1045
class ChangeBranchTipParams(object):
1046
"""Object holding parameters passed to *_change_branch_tip hooks.
1048
There are 5 fields that hooks may wish to access:
1050
:ivar branch: the branch being changed
1051
:ivar old_revno: revision number before the change
1052
:ivar new_revno: revision number after the change
1053
:ivar old_revid: revision id before the change
1054
:ivar new_revid: revision id after the change
1056
The revid fields are strings. The revno fields are integers.
1059
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1060
"""Create a group of ChangeBranchTip parameters.
1062
:param branch: The branch being changed.
1063
:param old_revno: Revision number before the change.
1064
:param new_revno: Revision number after the change.
1065
:param old_revid: Tip revision id before the change.
1066
:param new_revid: Tip revision id after the change.
1068
self.branch = branch
1069
self.old_revno = old_revno
1070
self.new_revno = new_revno
1071
self.old_revid = old_revid
1072
self.new_revid = new_revid
1075
class BzrBranchFormat4(BranchFormat):
1076
"""Bzr branch format 4.
1079
- a revision-history file.
1080
- a branch-lock lock file [ to be shared with the bzrdir ]
1083
def get_format_description(self):
1084
"""See BranchFormat.get_format_description()."""
1085
return "Branch format 4"
1087
def initialize(self, a_bzrdir):
1088
"""Create a branch of this format in a_bzrdir."""
1089
utf8_files = [('revision-history', ''),
1090
('branch-name', ''),
1092
return self._initialize_helper(a_bzrdir, utf8_files,
1093
lock_type='branch4', set_format=False)
1096
super(BzrBranchFormat4, self).__init__()
1097
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1099
def open(self, a_bzrdir, _found=False):
1100
"""Return the branch object for a_bzrdir
1102
_found is a private parameter, do not use it. It is used to indicate
1103
if format probing has already be done.
1106
# we are being called directly and must probe.
1107
raise NotImplementedError
1108
return BzrBranch(_format=self,
1109
_control_files=a_bzrdir._control_files,
1111
_repository=a_bzrdir.open_repository())
1114
return "Bazaar-NG branch format 4"
1117
class BzrBranchFormat5(BranchFormat):
1118
"""Bzr branch format 5.
1121
- a revision-history file.
1123
- a lock dir guarding the branch itself
1124
- all of this stored in a branch/ subdirectory
1125
- works with shared repositories.
1127
This format is new in bzr 0.8.
1130
def get_format_string(self):
1131
"""See BranchFormat.get_format_string()."""
1132
return "Bazaar-NG branch format 5\n"
1134
def get_format_description(self):
1135
"""See BranchFormat.get_format_description()."""
1136
return "Branch format 5"
1138
def initialize(self, a_bzrdir):
1139
"""Create a branch of this format in a_bzrdir."""
1140
utf8_files = [('revision-history', ''),
1141
('branch-name', ''),
1143
return self._initialize_helper(a_bzrdir, utf8_files)
1146
super(BzrBranchFormat5, self).__init__()
1147
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1149
def open(self, a_bzrdir, _found=False):
1150
"""Return the branch object for a_bzrdir
1152
_found is a private parameter, do not use it. It is used to indicate
1153
if format probing has already be done.
1156
format = BranchFormat.find_format(a_bzrdir)
1157
assert format.__class__ == self.__class__
1159
transport = a_bzrdir.get_branch_transport(None)
1160
control_files = lockable_files.LockableFiles(transport, 'lock',
1162
return BzrBranch5(_format=self,
1163
_control_files=control_files,
1165
_repository=a_bzrdir.find_repository())
1166
except errors.NoSuchFile:
1167
raise errors.NotBranchError(path=transport.base)
1170
class BzrBranchFormat6(BzrBranchFormat5):
1171
"""Branch format with last-revision and tags.
1173
Unlike previous formats, this has no explicit revision history. Instead,
1174
this just stores the last-revision, and the left-hand history leading
1175
up to there is the history.
1177
This format was introduced in bzr 0.15
1178
and became the default in 0.91.
1181
def get_format_string(self):
1182
"""See BranchFormat.get_format_string()."""
1183
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1185
def get_format_description(self):
1186
"""See BranchFormat.get_format_description()."""
1187
return "Branch format 6"
1189
def initialize(self, a_bzrdir):
1190
"""Create a branch of this format in a_bzrdir."""
1191
utf8_files = [('last-revision', '0 null:\n'),
1192
('branch.conf', ''),
1195
return self._initialize_helper(a_bzrdir, utf8_files)
1197
def open(self, a_bzrdir, _found=False):
1198
"""Return the branch object for a_bzrdir
1200
_found is a private parameter, do not use it. It is used to indicate
1201
if format probing has already be done.
1204
format = BranchFormat.find_format(a_bzrdir)
1205
assert format.__class__ == self.__class__
1206
transport = a_bzrdir.get_branch_transport(None)
1207
control_files = lockable_files.LockableFiles(transport, 'lock',
1209
return BzrBranch6(_format=self,
1210
_control_files=control_files,
1212
_repository=a_bzrdir.find_repository())
1214
def supports_tags(self):
1218
class BranchReferenceFormat(BranchFormat):
1219
"""Bzr branch reference format.
1221
Branch references are used in implementing checkouts, they
1222
act as an alias to the real branch which is at some other url.
1229
def get_format_string(self):
1230
"""See BranchFormat.get_format_string()."""
1231
return "Bazaar-NG Branch Reference Format 1\n"
1233
def get_format_description(self):
1234
"""See BranchFormat.get_format_description()."""
1235
return "Checkout reference format 1"
1237
def get_reference(self, a_bzrdir):
1238
"""See BranchFormat.get_reference()."""
1239
transport = a_bzrdir.get_branch_transport(None)
1240
return transport.get('location').read()
1242
def set_reference(self, a_bzrdir, to_branch):
1243
"""See BranchFormat.set_reference()."""
1244
transport = a_bzrdir.get_branch_transport(None)
1245
location = transport.put_bytes('location', to_branch.base)
1247
def initialize(self, a_bzrdir, target_branch=None):
1248
"""Create a branch of this format in a_bzrdir."""
1249
if target_branch is None:
1250
# this format does not implement branch itself, thus the implicit
1251
# creation contract must see it as uninitializable
1252
raise errors.UninitializableFormat(self)
1253
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1254
branch_transport = a_bzrdir.get_branch_transport(self)
1255
branch_transport.put_bytes('location',
1256
target_branch.bzrdir.root_transport.base)
1257
branch_transport.put_bytes('format', self.get_format_string())
1259
a_bzrdir, _found=True,
1260
possible_transports=[target_branch.bzrdir.root_transport])
1263
super(BranchReferenceFormat, self).__init__()
1264
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1266
def _make_reference_clone_function(format, a_branch):
1267
"""Create a clone() routine for a branch dynamically."""
1268
def clone(to_bzrdir, revision_id=None):
1269
"""See Branch.clone()."""
1270
return format.initialize(to_bzrdir, a_branch)
1271
# cannot obey revision_id limits when cloning a reference ...
1272
# FIXME RBC 20060210 either nuke revision_id for clone, or
1273
# emit some sort of warning/error to the caller ?!
1276
def open(self, a_bzrdir, _found=False, location=None,
1277
possible_transports=None):
1278
"""Return the branch that the branch reference in a_bzrdir points at.
1280
_found is a private parameter, do not use it. It is used to indicate
1281
if format probing has already be done.
1284
format = BranchFormat.find_format(a_bzrdir)
1285
assert format.__class__ == self.__class__
1286
if location is None:
1287
location = self.get_reference(a_bzrdir)
1288
real_bzrdir = bzrdir.BzrDir.open(
1289
location, possible_transports=possible_transports)
1290
result = real_bzrdir.open_branch()
1291
# this changes the behaviour of result.clone to create a new reference
1292
# rather than a copy of the content of the branch.
1293
# I did not use a proxy object because that needs much more extensive
1294
# testing, and we are only changing one behaviour at the moment.
1295
# If we decide to alter more behaviours - i.e. the implicit nickname
1296
# then this should be refactored to introduce a tested proxy branch
1297
# and a subclass of that for use in overriding clone() and ....
1299
result.clone = self._make_reference_clone_function(result)
1303
# formats which have no format string are not discoverable
1304
# and not independently creatable, so are not registered.
1305
__format5 = BzrBranchFormat5()
1306
__format6 = BzrBranchFormat6()
1307
BranchFormat.register_format(__format5)
1308
BranchFormat.register_format(BranchReferenceFormat())
1309
BranchFormat.register_format(__format6)
1310
BranchFormat.set_default_format(__format6)
1311
_legacy_formats = [BzrBranchFormat4(),
1314
class BzrBranch(Branch):
1315
"""A branch stored in the actual filesystem.
1317
Note that it's "local" in the context of the filesystem; it doesn't
1318
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1319
it's writable, and can be accessed via the normal filesystem API.
1322
def __init__(self, _format=None,
1323
_control_files=None, a_bzrdir=None, _repository=None):
1324
"""Create new branch object at a particular location."""
1325
Branch.__init__(self)
1326
if a_bzrdir is None:
1327
raise ValueError('a_bzrdir must be supplied')
1329
self.bzrdir = a_bzrdir
1330
# self._transport used to point to the directory containing the
1331
# control directory, but was not used - now it's just the transport
1332
# for the branch control files. mbp 20070212
1333
self._base = self.bzrdir.transport.clone('..').base
1334
self._format = _format
1335
if _control_files is None:
1336
raise ValueError('BzrBranch _control_files is None')
1337
self.control_files = _control_files
1338
self._transport = _control_files._transport
1339
self.repository = _repository
1342
return '%s(%r)' % (self.__class__.__name__, self.base)
1346
def _get_base(self):
1347
"""Returns the directory containing the control directory."""
1350
base = property(_get_base, doc="The URL for the root of this branch.")
1352
def abspath(self, name):
1353
"""See Branch.abspath."""
1354
return self.control_files._transport.abspath(name)
1356
def is_locked(self):
1357
return self.control_files.is_locked()
1359
def lock_write(self, token=None):
1360
repo_token = self.repository.lock_write()
1362
token = self.control_files.lock_write(token=token)
1364
self.repository.unlock()
1368
def lock_read(self):
1369
self.repository.lock_read()
1371
self.control_files.lock_read()
1373
self.repository.unlock()
1377
# TODO: test for failed two phase locks. This is known broken.
1379
self.control_files.unlock()
1381
self.repository.unlock()
1382
if not self.control_files.is_locked():
1383
# we just released the lock
1384
self._clear_cached_state()
1386
def peek_lock_mode(self):
1387
if self.control_files._lock_count == 0:
1390
return self.control_files._lock_mode
1392
def get_physical_lock_status(self):
1393
return self.control_files.get_physical_lock_status()
1396
def print_file(self, file, revision_id):
1397
"""See Branch.print_file."""
1398
return self.repository.print_file(file, revision_id)
1400
def _write_revision_history(self, history):
1401
"""Factored out of set_revision_history.
1403
This performs the actual writing to disk.
1404
It is intended to be called by BzrBranch5.set_revision_history."""
1405
self.control_files.put_bytes(
1406
'revision-history', '\n'.join(history))
1409
def set_revision_history(self, rev_history):
1410
"""See Branch.set_revision_history."""
1411
if 'evil' in debug.debug_flags:
1412
mutter_callsite(3, "set_revision_history scales with history.")
1413
self._write_revision_history(rev_history)
1414
self._clear_cached_state()
1415
self._cache_revision_history(rev_history)
1416
for hook in Branch.hooks['set_rh']:
1417
hook(self, rev_history)
1419
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1420
"""Run the post_change_branch_tip hooks."""
1421
hooks = Branch.hooks['post_change_branch_tip']
1424
new_revno, new_revid = self.last_revision_info()
1425
params = ChangeBranchTipParams(
1426
self, old_revno, new_revno, old_revid, new_revid)
1431
def set_last_revision_info(self, revno, revision_id):
1432
"""Set the last revision of this branch.
1434
The caller is responsible for checking that the revno is correct
1435
for this revision id.
1437
It may be possible to set the branch last revision to an id not
1438
present in the repository. However, branches can also be
1439
configured to check constraints on history, in which case this may not
1442
revision_id = _mod_revision.ensure_null(revision_id)
1443
old_revno, old_revid = self.last_revision_info()
1444
history = self._lefthand_history(revision_id)
1445
assert len(history) == revno, '%d != %d' % (len(history), revno)
1446
self.set_revision_history(history)
1447
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1449
def _gen_revision_history(self):
1450
history = self.control_files.get('revision-history').read().split('\n')
1451
if history[-1:] == ['']:
1452
# There shouldn't be a trailing newline, but just in case.
1456
def _lefthand_history(self, revision_id, last_rev=None,
1458
if 'evil' in debug.debug_flags:
1459
mutter_callsite(4, "_lefthand_history scales with history.")
1460
# stop_revision must be a descendant of last_revision
1461
graph = self.repository.get_graph()
1462
if last_rev is not None:
1463
if not graph.is_ancestor(last_rev, revision_id):
1464
# our previous tip is not merged into stop_revision
1465
raise errors.DivergedBranches(self, other_branch)
1466
# make a new revision history from the graph
1467
parents_map = graph.get_parent_map([revision_id])
1468
if revision_id not in parents_map:
1469
raise errors.NoSuchRevision(self, revision_id)
1470
current_rev_id = revision_id
1472
# Do not include ghosts or graph origin in revision_history
1473
while (current_rev_id in parents_map and
1474
len(parents_map[current_rev_id]) > 0):
1475
new_history.append(current_rev_id)
1476
current_rev_id = parents_map[current_rev_id][0]
1477
parents_map = graph.get_parent_map([current_rev_id])
1478
new_history.reverse()
1482
def generate_revision_history(self, revision_id, last_rev=None,
1484
"""Create a new revision history that will finish with revision_id.
1486
:param revision_id: the new tip to use.
1487
:param last_rev: The previous last_revision. If not None, then this
1488
must be a ancestory of revision_id, or DivergedBranches is raised.
1489
:param other_branch: The other branch that DivergedBranches should
1490
raise with respect to.
1492
self.set_revision_history(self._lefthand_history(revision_id,
1493
last_rev, other_branch))
1496
def update_revisions(self, other, stop_revision=None, overwrite=False):
1497
"""See Branch.update_revisions."""
1500
other_last_revno, other_last_revision = other.last_revision_info()
1501
if stop_revision is None:
1502
stop_revision = other_last_revision
1503
if _mod_revision.is_null(stop_revision):
1504
# if there are no commits, we're done.
1506
# whats the current last revision, before we fetch [and change it
1508
last_rev = _mod_revision.ensure_null(self.last_revision())
1509
# we fetch here so that we don't process data twice in the common
1510
# case of having something to pull, and so that the check for
1511
# already merged can operate on the just fetched graph, which will
1512
# be cached in memory.
1513
self.fetch(other, stop_revision)
1514
# Check to see if one is an ancestor of the other
1516
heads = self.repository.get_graph().heads([stop_revision,
1518
if heads == set([last_rev]):
1519
# The current revision is a decendent of the target,
1522
elif heads == set([stop_revision, last_rev]):
1523
# These branches have diverged
1524
raise errors.DivergedBranches(self, other)
1525
assert heads == set([stop_revision])
1526
if other_last_revision == stop_revision:
1527
self.set_last_revision_info(other_last_revno,
1528
other_last_revision)
1530
# TODO: jam 2007-11-29 Is there a way to determine the
1531
# revno without searching all of history??
1533
self.generate_revision_history(stop_revision)
1535
self.generate_revision_history(stop_revision,
1536
last_rev=last_rev, other_branch=other)
1540
def basis_tree(self):
1541
"""See Branch.basis_tree."""
1542
return self.repository.revision_tree(self.last_revision())
1545
def pull(self, source, overwrite=False, stop_revision=None,
1546
_hook_master=None, run_hooks=True, possible_transports=None):
1549
:param _hook_master: Private parameter - set the branch to
1550
be supplied as the master to push hooks.
1551
:param run_hooks: Private parameter - if false, this branch
1552
is being called because it's the master of the primary branch,
1553
so it should not run its hooks.
1555
result = PullResult()
1556
result.source_branch = source
1557
result.target_branch = self
1560
result.old_revno, result.old_revid = self.last_revision_info()
1561
self.update_revisions(source, stop_revision, overwrite=overwrite)
1562
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1563
result.new_revno, result.new_revid = self.last_revision_info()
1565
result.master_branch = _hook_master
1566
result.local_branch = self
1568
result.master_branch = self
1569
result.local_branch = None
1571
for hook in Branch.hooks['post_pull']:
1577
def _get_parent_location(self):
1578
_locs = ['parent', 'pull', 'x-pull']
1581
return self.control_files.get(l).read().strip('\n')
1582
except errors.NoSuchFile:
1587
def push(self, target, overwrite=False, stop_revision=None,
1588
_override_hook_source_branch=None):
1591
This is the basic concrete implementation of push()
1593
:param _override_hook_source_branch: If specified, run
1594
the hooks passing this Branch as the source, rather than self.
1595
This is for use of RemoteBranch, where push is delegated to the
1596
underlying vfs-based Branch.
1598
# TODO: Public option to disable running hooks - should be trivial but
1602
result = self._push_with_bound_branches(target, overwrite,
1604
_override_hook_source_branch=_override_hook_source_branch)
1609
def _push_with_bound_branches(self, target, overwrite,
1611
_override_hook_source_branch=None):
1612
"""Push from self into target, and into target's master if any.
1614
This is on the base BzrBranch class even though it doesn't support
1615
bound branches because the *target* might be bound.
1618
if _override_hook_source_branch:
1619
result.source_branch = _override_hook_source_branch
1620
for hook in Branch.hooks['post_push']:
1623
bound_location = target.get_bound_location()
1624
if bound_location and target.base != bound_location:
1625
# there is a master branch.
1627
# XXX: Why the second check? Is it even supported for a branch to
1628
# be bound to itself? -- mbp 20070507
1629
master_branch = target.get_master_branch()
1630
master_branch.lock_write()
1632
# push into the master from this branch.
1633
self._basic_push(master_branch, overwrite, stop_revision)
1634
# and push into the target branch from this. Note that we push from
1635
# this branch again, because its considered the highest bandwidth
1637
result = self._basic_push(target, overwrite, stop_revision)
1638
result.master_branch = master_branch
1639
result.local_branch = target
1643
master_branch.unlock()
1646
result = self._basic_push(target, overwrite, stop_revision)
1647
# TODO: Why set master_branch and local_branch if there's no
1648
# binding? Maybe cleaner to just leave them unset? -- mbp
1650
result.master_branch = target
1651
result.local_branch = None
1655
def _basic_push(self, target, overwrite, stop_revision):
1656
"""Basic implementation of push without bound branches or hooks.
1658
Must be called with self read locked and target write locked.
1660
result = PushResult()
1661
result.source_branch = self
1662
result.target_branch = target
1663
result.old_revno, result.old_revid = target.last_revision_info()
1665
target.update_revisions(self, stop_revision)
1666
except errors.DivergedBranches:
1670
target.set_revision_history(self.revision_history())
1671
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1672
result.new_revno, result.new_revid = target.last_revision_info()
1675
def get_parent(self):
1676
"""See Branch.get_parent."""
1678
assert self.base[-1] == '/'
1679
parent = self._get_parent_location()
1682
# This is an old-format absolute path to a local branch
1683
# turn it into a url
1684
if parent.startswith('/'):
1685
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1687
return urlutils.join(self.base[:-1], parent)
1688
except errors.InvalidURLJoin, e:
1689
raise errors.InaccessibleParent(parent, self.base)
1691
def set_push_location(self, location):
1692
"""See Branch.set_push_location."""
1693
self.get_config().set_user_option(
1694
'push_location', location,
1695
store=_mod_config.STORE_LOCATION_NORECURSE)
1698
def set_parent(self, url):
1699
"""See Branch.set_parent."""
1700
# TODO: Maybe delete old location files?
1701
# URLs should never be unicode, even on the local fs,
1702
# FIXUP this and get_parent in a future branch format bump:
1703
# read and rewrite the file. RBC 20060125
1705
if isinstance(url, unicode):
1707
url = url.encode('ascii')
1708
except UnicodeEncodeError:
1709
raise errors.InvalidURL(url,
1710
"Urls must be 7-bit ascii, "
1711
"use bzrlib.urlutils.escape")
1712
url = urlutils.relative_url(self.base, url)
1713
self._set_parent_location(url)
1715
def _set_parent_location(self, url):
1717
self.control_files._transport.delete('parent')
1719
assert isinstance(url, str)
1720
self.control_files.put_bytes('parent', url + '\n')
1723
class BzrBranch5(BzrBranch):
1724
"""A format 5 branch. This supports new features over plain branches.
1726
It has support for a master_branch which is the data for bound branches.
1734
super(BzrBranch5, self).__init__(_format=_format,
1735
_control_files=_control_files,
1737
_repository=_repository)
1740
def pull(self, source, overwrite=False, stop_revision=None,
1741
run_hooks=True, possible_transports=None):
1742
"""Pull from source into self, updating my master if any.
1744
:param run_hooks: Private parameter - if false, this branch
1745
is being called because it's the master of the primary branch,
1746
so it should not run its hooks.
1748
bound_location = self.get_bound_location()
1749
master_branch = None
1750
if bound_location and source.base != bound_location:
1751
# not pulling from master, so we need to update master.
1752
master_branch = self.get_master_branch(possible_transports)
1753
master_branch.lock_write()
1756
# pull from source into master.
1757
master_branch.pull(source, overwrite, stop_revision,
1759
return super(BzrBranch5, self).pull(source, overwrite,
1760
stop_revision, _hook_master=master_branch,
1761
run_hooks=run_hooks)
1764
master_branch.unlock()
1766
def get_bound_location(self):
1768
return self._transport.get_bytes('bound')[:-1]
1769
except errors.NoSuchFile:
1773
def get_master_branch(self, possible_transports=None):
1774
"""Return the branch we are bound to.
1776
:return: Either a Branch, or None
1778
This could memoise the branch, but if thats done
1779
it must be revalidated on each new lock.
1780
So for now we just don't memoise it.
1781
# RBC 20060304 review this decision.
1783
bound_loc = self.get_bound_location()
1787
return Branch.open(bound_loc,
1788
possible_transports=possible_transports)
1789
except (errors.NotBranchError, errors.ConnectionError), e:
1790
raise errors.BoundBranchConnectionFailure(
1794
def set_bound_location(self, location):
1795
"""Set the target where this branch is bound to.
1797
:param location: URL to the target branch
1800
self.control_files.put_utf8('bound', location+'\n')
1803
self.control_files._transport.delete('bound')
1804
except errors.NoSuchFile:
1809
def bind(self, other):
1810
"""Bind this branch to the branch other.
1812
This does not push or pull data between the branches, though it does
1813
check for divergence to raise an error when the branches are not
1814
either the same, or one a prefix of the other. That behaviour may not
1815
be useful, so that check may be removed in future.
1817
:param other: The branch to bind to
1820
# TODO: jam 20051230 Consider checking if the target is bound
1821
# It is debatable whether you should be able to bind to
1822
# a branch which is itself bound.
1823
# Committing is obviously forbidden,
1824
# but binding itself may not be.
1825
# Since we *have* to check at commit time, we don't
1826
# *need* to check here
1828
# we want to raise diverged if:
1829
# last_rev is not in the other_last_rev history, AND
1830
# other_last_rev is not in our history, and do it without pulling
1832
self.set_bound_location(other.base)
1836
"""If bound, unbind"""
1837
return self.set_bound_location(None)
1840
def update(self, possible_transports=None):
1841
"""Synchronise this branch with the master branch if any.
1843
:return: None or the last_revision that was pivoted out during the
1846
master = self.get_master_branch(possible_transports)
1847
if master is not None:
1848
old_tip = _mod_revision.ensure_null(self.last_revision())
1849
self.pull(master, overwrite=True)
1850
if self.repository.get_graph().is_ancestor(old_tip,
1851
_mod_revision.ensure_null(self.last_revision())):
1857
class BzrBranch6(BzrBranch5):
1859
def __init__(self, *args, **kwargs):
1860
super(BzrBranch6, self).__init__(*args, **kwargs)
1861
self._last_revision_info_cache = None
1862
self._partial_revision_history_cache = []
1864
def _clear_cached_state(self):
1865
super(BzrBranch6, self)._clear_cached_state()
1866
self._last_revision_info_cache = None
1867
self._partial_revision_history_cache = []
1870
def last_revision_info(self):
1871
"""Return information about the last revision.
1873
:return: A tuple (revno, revision_id).
1875
if self._last_revision_info_cache is None:
1876
self._last_revision_info_cache = self._last_revision_info()
1877
return self._last_revision_info_cache
1879
def _last_revision_info(self):
1880
revision_string = self.control_files.get('last-revision').read()
1881
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1882
revision_id = cache_utf8.get_cached_utf8(revision_id)
1884
return revno, revision_id
1886
def _write_last_revision_info(self, revno, revision_id):
1887
"""Simply write out the revision id, with no checks.
1889
Use set_last_revision_info to perform this safely.
1891
Does not update the revision_history cache.
1892
Intended to be called by set_last_revision_info and
1893
_write_revision_history.
1895
assert revision_id is not None, "Use NULL_REVISION, not None"
1896
out_string = '%d %s\n' % (revno, revision_id)
1897
self.control_files.put_bytes('last-revision', out_string)
1900
def set_last_revision_info(self, revno, revision_id):
1901
revision_id = _mod_revision.ensure_null(revision_id)
1902
old_revno, old_revid = self.last_revision_info()
1903
if self._get_append_revisions_only():
1904
self._check_history_violation(revision_id)
1905
self._write_last_revision_info(revno, revision_id)
1906
self._clear_cached_state()
1907
self._last_revision_info_cache = revno, revision_id
1908
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1910
def _check_history_violation(self, revision_id):
1911
last_revision = _mod_revision.ensure_null(self.last_revision())
1912
if _mod_revision.is_null(last_revision):
1914
if last_revision not in self._lefthand_history(revision_id):
1915
raise errors.AppendRevisionsOnlyViolation(self.base)
1917
def _gen_revision_history(self):
1918
"""Generate the revision history from last revision
1920
self._extend_partial_history()
1921
return list(reversed(self._partial_revision_history_cache))
1923
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1924
"""Extend the partial history to include a given index
1926
If a stop_index is supplied, stop when that index has been reached.
1927
If a stop_revision is supplied, stop when that revision is
1928
encountered. Otherwise, stop when the beginning of history is
1931
:param stop_index: The index which should be present. When it is
1932
present, history extension will stop.
1933
:param revision_id: The revision id which should be present. When
1934
it is encountered, history extension will stop.
1936
repo = self.repository
1937
if len(self._partial_revision_history_cache) == 0:
1938
iterator = repo.iter_reverse_revision_history(self.last_revision())
1940
start_revision = self._partial_revision_history_cache[-1]
1941
iterator = repo.iter_reverse_revision_history(start_revision)
1942
#skip the last revision in the list
1943
next_revision = iterator.next()
1944
assert next_revision == start_revision
1945
for revision_id in iterator:
1946
self._partial_revision_history_cache.append(revision_id)
1947
if (stop_index is not None and
1948
len(self._partial_revision_history_cache) > stop_index):
1950
if revision_id == stop_revision:
1953
def _write_revision_history(self, history):
1954
"""Factored out of set_revision_history.
1956
This performs the actual writing to disk, with format-specific checks.
1957
It is intended to be called by BzrBranch5.set_revision_history.
1959
if len(history) == 0:
1960
last_revision = 'null:'
1962
if history != self._lefthand_history(history[-1]):
1963
raise errors.NotLefthandHistory(history)
1964
last_revision = history[-1]
1965
if self._get_append_revisions_only():
1966
self._check_history_violation(last_revision)
1967
self._write_last_revision_info(len(history), last_revision)
1970
def _set_parent_location(self, url):
1971
"""Set the parent branch"""
1972
self._set_config_location('parent_location', url, make_relative=True)
1975
def _get_parent_location(self):
1976
"""Set the parent branch"""
1977
return self._get_config_location('parent_location')
1979
def set_push_location(self, location):
1980
"""See Branch.set_push_location."""
1981
self._set_config_location('push_location', location)
1983
def set_bound_location(self, location):
1984
"""See Branch.set_push_location."""
1986
config = self.get_config()
1987
if location is None:
1988
if config.get_user_option('bound') != 'True':
1991
config.set_user_option('bound', 'False', warn_masked=True)
1994
self._set_config_location('bound_location', location,
1996
config.set_user_option('bound', 'True', warn_masked=True)
1999
def _get_bound_location(self, bound):
2000
"""Return the bound location in the config file.
2002
Return None if the bound parameter does not match"""
2003
config = self.get_config()
2004
config_bound = (config.get_user_option('bound') == 'True')
2005
if config_bound != bound:
2007
return self._get_config_location('bound_location', config=config)
2009
def get_bound_location(self):
2010
"""See Branch.set_push_location."""
2011
return self._get_bound_location(True)
2013
def get_old_bound_location(self):
2014
"""See Branch.get_old_bound_location"""
2015
return self._get_bound_location(False)
2017
def set_append_revisions_only(self, enabled):
2022
self.get_config().set_user_option('append_revisions_only', value,
2025
def _get_append_revisions_only(self):
2026
value = self.get_config().get_user_option('append_revisions_only')
2027
return value == 'True'
2029
def _synchronize_history(self, destination, revision_id):
2030
"""Synchronize last revision and revision history between branches.
2032
This version is most efficient when the destination is also a
2033
BzrBranch6, but works for BzrBranch5, as long as the destination's
2034
repository contains all the lefthand ancestors of the intended
2035
last_revision. If not, set_last_revision_info will fail.
2037
:param destination: The branch to copy the history into
2038
:param revision_id: The revision-id to truncate history at. May
2039
be None to copy complete history.
2041
source_revno, source_revision_id = self.last_revision_info()
2042
if revision_id is None:
2043
revno, revision_id = source_revno, source_revision_id
2044
elif source_revision_id == revision_id:
2045
# we know the revno without needing to walk all of history
2046
revno = source_revno
2048
# To figure out the revno for a random revision, we need to build
2049
# the revision history, and count its length.
2050
# We don't care about the order, just how long it is.
2051
# Alternatively, we could start at the current location, and count
2052
# backwards. But there is no guarantee that we will find it since
2053
# it may be a merged revision.
2054
revno = len(list(self.repository.iter_reverse_revision_history(
2056
destination.set_last_revision_info(revno, revision_id)
2058
def _make_tags(self):
2059
return BasicTags(self)
2062
def generate_revision_history(self, revision_id, last_rev=None,
2064
"""See BzrBranch5.generate_revision_history"""
2065
history = self._lefthand_history(revision_id, last_rev, other_branch)
2066
revno = len(history)
2067
self.set_last_revision_info(revno, revision_id)
2070
def get_rev_id(self, revno, history=None):
2071
"""Find the revision id of the specified revno."""
2073
return _mod_revision.NULL_REVISION
2075
last_revno, last_revision_id = self.last_revision_info()
2076
if revno <= 0 or revno > last_revno:
2077
raise errors.NoSuchRevision(self, revno)
2079
if history is not None:
2080
assert len(history) == last_revno, 'revno/history mismatch'
2081
return history[revno - 1]
2083
index = last_revno - revno
2084
if len(self._partial_revision_history_cache) <= index:
2085
self._extend_partial_history(stop_index=index)
2086
if len(self._partial_revision_history_cache) > index:
2087
return self._partial_revision_history_cache[index]
2089
raise errors.NoSuchRevision(self, revno)
2092
def revision_id_to_revno(self, revision_id):
2093
"""Given a revision id, return its revno"""
2094
if _mod_revision.is_null(revision_id):
2097
index = self._partial_revision_history_cache.index(revision_id)
2099
self._extend_partial_history(stop_revision=revision_id)
2100
index = len(self._partial_revision_history_cache) - 1
2101
if self._partial_revision_history_cache[index] != revision_id:
2102
raise errors.NoSuchRevision(self, revision_id)
2103
return self.revno() - index
2106
######################################################################
2107
# results of operations
2110
class _Result(object):
2112
def _show_tag_conficts(self, to_file):
2113
if not getattr(self, 'tag_conflicts', None):
2115
to_file.write('Conflicting tags:\n')
2116
for name, value1, value2 in self.tag_conflicts:
2117
to_file.write(' %s\n' % (name, ))
2120
class PullResult(_Result):
2121
"""Result of a Branch.pull operation.
2123
:ivar old_revno: Revision number before pull.
2124
:ivar new_revno: Revision number after pull.
2125
:ivar old_revid: Tip revision id before pull.
2126
:ivar new_revid: Tip revision id after pull.
2127
:ivar source_branch: Source (local) branch object.
2128
:ivar master_branch: Master branch of the target, or None.
2129
:ivar target_branch: Target/destination branch object.
2133
# DEPRECATED: pull used to return the change in revno
2134
return self.new_revno - self.old_revno
2136
def report(self, to_file):
2138
if self.old_revid == self.new_revid:
2139
to_file.write('No revisions to pull.\n')
2141
to_file.write('Now on revision %d.\n' % self.new_revno)
2142
self._show_tag_conficts(to_file)
2145
class PushResult(_Result):
2146
"""Result of a Branch.push operation.
2148
:ivar old_revno: Revision number before push.
2149
:ivar new_revno: Revision number after push.
2150
:ivar old_revid: Tip revision id before push.
2151
:ivar new_revid: Tip revision id after push.
2152
:ivar source_branch: Source branch object.
2153
:ivar master_branch: Master branch of the target, or None.
2154
:ivar target_branch: Target/destination branch object.
2158
# DEPRECATED: push used to return the change in revno
2159
return self.new_revno - self.old_revno
2161
def report(self, to_file):
2162
"""Write a human-readable description of the result."""
2163
if self.old_revid == self.new_revid:
2164
to_file.write('No new revisions to push.\n')
2166
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2167
self._show_tag_conficts(to_file)
2170
class BranchCheckResult(object):
2171
"""Results of checking branch consistency.
2176
def __init__(self, branch):
2177
self.branch = branch
2179
def report_results(self, verbose):
2180
"""Report the check results via trace.note.
2182
:param verbose: Requests more detailed display of what was checked,
2185
note('checked branch %s format %s',
2187
self.branch._format)
2190
class Converter5to6(object):
2191
"""Perform an in-place upgrade of format 5 to format 6"""
2193
def convert(self, branch):
2194
# Data for 5 and 6 can peacefully coexist.
2195
format = BzrBranchFormat6()
2196
new_branch = format.open(branch.bzrdir, _found=True)
2198
# Copy source data into target
2199
new_branch._write_last_revision_info(*branch.last_revision_info())
2200
new_branch.set_parent(branch.get_parent())
2201
new_branch.set_bound_location(branch.get_bound_location())
2202
new_branch.set_push_location(branch.get_push_location())
2204
# New branch has no tags by default
2205
new_branch.tags._set_tag_dict({})
2207
# Copying done; now update target format
2208
new_branch.control_files.put_utf8('format',
2209
format.get_format_string())
2211
# Clean up old files
2212
new_branch.control_files._transport.delete('revision-history')
2214
branch.set_parent(None)
2215
except errors.NoSuchFile:
2217
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
