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
rh = self.revision_history()
318
if not (1 <= revno <= len(rh)):
319
raise errors.InvalidRevisionNumber(revno)
320
return self.repository.get_revision_delta(rh[revno-1])
322
def print_file(self, file, revision_id):
323
"""Print `file` to stdout."""
324
raise NotImplementedError(self.print_file)
326
def set_revision_history(self, rev_history):
327
raise NotImplementedError(self.set_revision_history)
329
def _cache_revision_history(self, rev_history):
330
"""Set the cached revision history to rev_history.
332
The revision_history method will use this cache to avoid regenerating
333
the revision history.
335
This API is semi-public; it only for use by subclasses, all other code
336
should consider it to be private.
338
self._revision_history_cache = rev_history
340
def _cache_revision_id_to_revno(self, revision_id_to_revno):
341
"""Set the cached revision_id => revno map to revision_id_to_revno.
343
This API is semi-public; it only for use by subclasses, all other code
344
should consider it to be private.
346
self._revision_id_to_revno_cache = revision_id_to_revno
348
def _clear_cached_state(self):
349
"""Clear any cached data on this branch, e.g. cached revision history.
351
This means the next call to revision_history will need to call
352
_gen_revision_history.
354
This API is semi-public; it only for use by subclasses, all other code
355
should consider it to be private.
357
self._revision_history_cache = None
358
self._revision_id_to_revno_cache = None
360
def _gen_revision_history(self):
361
"""Return sequence of revision hashes on to this branch.
363
Unlike revision_history, this method always regenerates or rereads the
364
revision history, i.e. it does not cache the result, so repeated calls
367
Concrete subclasses should override this instead of revision_history so
368
that subclasses do not need to deal with caching logic.
370
This API is semi-public; it only for use by subclasses, all other code
371
should consider it to be private.
373
raise NotImplementedError(self._gen_revision_history)
376
def revision_history(self):
377
"""Return sequence of revision ids on this branch.
379
This method will cache the revision history for as long as it is safe to
382
if 'evil' in debug.debug_flags:
383
mutter_callsite(3, "revision_history scales with history.")
384
if self._revision_history_cache is not None:
385
history = self._revision_history_cache
387
history = self._gen_revision_history()
388
self._cache_revision_history(history)
392
"""Return current revision number for this branch.
394
That is equivalent to the number of revisions committed to
397
return self.last_revision_info()[0]
400
"""Older format branches cannot bind or unbind."""
401
raise errors.UpgradeRequired(self.base)
403
def set_append_revisions_only(self, enabled):
404
"""Older format branches are never restricted to append-only"""
405
raise errors.UpgradeRequired(self.base)
407
def last_revision(self):
408
"""Return last revision id, or NULL_REVISION."""
409
return self.last_revision_info()[1]
411
def last_revision_info(self):
412
"""Return information about the last revision.
414
:return: A tuple (revno, last_revision_id).
416
rh = self.revision_history()
419
return (revno, rh[-1])
421
return (0, _mod_revision.NULL_REVISION)
423
def missing_revisions(self, other, stop_revision=None):
424
"""Return a list of new revisions that would perfectly fit.
426
If self and other have not diverged, return a list of the revisions
427
present in other, but missing from self.
429
self_history = self.revision_history()
430
self_len = len(self_history)
431
other_history = other.revision_history()
432
other_len = len(other_history)
433
common_index = min(self_len, other_len) -1
434
if common_index >= 0 and \
435
self_history[common_index] != other_history[common_index]:
436
raise errors.DivergedBranches(self, other)
438
if stop_revision is None:
439
stop_revision = other_len
441
if stop_revision > other_len:
442
raise errors.NoSuchRevision(self, stop_revision)
443
return other_history[self_len:stop_revision]
445
def update_revisions(self, other, stop_revision=None):
446
"""Pull in new perfect-fit revisions.
448
:param other: Another Branch to pull from
449
:param stop_revision: Updated until the given revision
452
raise NotImplementedError(self.update_revisions)
454
def revision_id_to_revno(self, revision_id):
455
"""Given a revision id, return its revno"""
456
if _mod_revision.is_null(revision_id):
458
history = self.revision_history()
460
return history.index(revision_id) + 1
462
raise errors.NoSuchRevision(self, revision_id)
464
def get_rev_id(self, revno, history=None):
465
"""Find the revision id of the specified revno."""
467
return _mod_revision.NULL_REVISION
469
history = self.revision_history()
470
if revno <= 0 or revno > len(history):
471
raise errors.NoSuchRevision(self, revno)
472
return history[revno - 1]
474
def pull(self, source, overwrite=False, stop_revision=None,
475
possible_transports=None):
476
"""Mirror source into this branch.
478
This branch is considered to be 'local', having low latency.
480
:returns: PullResult instance
482
raise NotImplementedError(self.pull)
484
def push(self, target, overwrite=False, stop_revision=None):
485
"""Mirror this branch into target.
487
This branch is considered to be 'local', having low latency.
489
raise NotImplementedError(self.push)
491
def basis_tree(self):
492
"""Return `Tree` object for last revision."""
493
return self.repository.revision_tree(self.last_revision())
495
def rename_one(self, from_rel, to_rel):
498
This can change the directory or the filename or both.
500
raise NotImplementedError(self.rename_one)
502
def move(self, from_paths, to_name):
505
to_name must exist as a versioned directory.
507
If to_name exists and is a directory, the files are moved into
508
it, keeping their old names. If it is a directory,
510
Note that to_name is only the last component of the new name;
511
this doesn't change the directory.
513
This returns a list of (from_path, to_path) pairs for each
516
raise NotImplementedError(self.move)
518
def get_parent(self):
519
"""Return the parent location of the branch.
521
This is the default location for push/pull/missing. The usual
522
pattern is that the user can override it by specifying a
525
raise NotImplementedError(self.get_parent)
527
def _set_config_location(self, name, url, config=None,
528
make_relative=False):
530
config = self.get_config()
534
url = urlutils.relative_url(self.base, url)
535
config.set_user_option(name, url, warn_masked=True)
537
def _get_config_location(self, name, config=None):
539
config = self.get_config()
540
location = config.get_user_option(name)
545
def get_submit_branch(self):
546
"""Return the submit location of the branch.
548
This is the default location for bundle. The usual
549
pattern is that the user can override it by specifying a
552
return self.get_config().get_user_option('submit_branch')
554
def set_submit_branch(self, location):
555
"""Return the submit location of the branch.
557
This is the default location for bundle. The usual
558
pattern is that the user can override it by specifying a
561
self.get_config().set_user_option('submit_branch', location,
564
def get_public_branch(self):
565
"""Return the public location of the branch.
567
This is is used by merge directives.
569
return self._get_config_location('public_branch')
571
def set_public_branch(self, location):
572
"""Return the submit location of the branch.
574
This is the default location for bundle. The usual
575
pattern is that the user can override it by specifying a
578
self._set_config_location('public_branch', location)
580
def get_push_location(self):
581
"""Return the None or the location to push this branch to."""
582
push_loc = self.get_config().get_user_option('push_location')
585
def set_push_location(self, location):
586
"""Set a new push location for this branch."""
587
raise NotImplementedError(self.set_push_location)
589
def set_parent(self, url):
590
raise NotImplementedError(self.set_parent)
594
"""Synchronise this branch with the master branch if any.
596
:return: None or the last_revision pivoted out during the update.
600
def check_revno(self, revno):
602
Check whether a revno corresponds to any revision.
603
Zero (the NULL revision) is considered valid.
606
self.check_real_revno(revno)
608
def check_real_revno(self, revno):
610
Check whether a revno corresponds to a real revision.
611
Zero (the NULL revision) is considered invalid
613
if revno < 1 or revno > self.revno():
614
raise errors.InvalidRevisionNumber(revno)
617
def clone(self, to_bzrdir, revision_id=None):
618
"""Clone this branch into to_bzrdir preserving all semantic values.
620
revision_id: if not None, the revision history in the new branch will
621
be truncated to end with revision_id.
623
result = self._format.initialize(to_bzrdir)
624
self.copy_content_into(result, revision_id=revision_id)
628
def sprout(self, to_bzrdir, revision_id=None):
629
"""Create a new line of development from the branch, into to_bzrdir.
631
revision_id: if not None, the revision history in the new branch will
632
be truncated to end with revision_id.
634
result = self._format.initialize(to_bzrdir)
635
self.copy_content_into(result, revision_id=revision_id)
636
result.set_parent(self.bzrdir.root_transport.base)
639
def _synchronize_history(self, destination, revision_id):
640
"""Synchronize last revision and revision history between branches.
642
This version is most efficient when the destination is also a
643
BzrBranch5, but works for BzrBranch6 as long as the revision
644
history is the true lefthand parent history, and all of the revisions
645
are in the destination's repository. If not, set_revision_history
648
:param destination: The branch to copy the history into
649
:param revision_id: The revision-id to truncate history at. May
650
be None to copy complete history.
652
if revision_id == _mod_revision.NULL_REVISION:
654
new_history = self.revision_history()
655
if revision_id is not None and new_history != []:
657
new_history = new_history[:new_history.index(revision_id) + 1]
659
rev = self.repository.get_revision(revision_id)
660
new_history = rev.get_history(self.repository)[1:]
661
destination.set_revision_history(new_history)
664
def copy_content_into(self, destination, revision_id=None):
665
"""Copy the content of self into destination.
667
revision_id: if not None, the revision history in the new branch will
668
be truncated to end with revision_id.
670
self._synchronize_history(destination, revision_id)
672
parent = self.get_parent()
673
except errors.InaccessibleParent, e:
674
mutter('parent was not accessible to copy: %s', e)
677
destination.set_parent(parent)
678
self.tags.merge_to(destination.tags)
682
"""Check consistency of the branch.
684
In particular this checks that revisions given in the revision-history
685
do actually match up in the revision graph, and that they're all
686
present in the repository.
688
Callers will typically also want to check the repository.
690
:return: A BranchCheckResult.
692
mainline_parent_id = None
693
last_revno, last_revision_id = self.last_revision_info()
694
real_rev_history = list(self.repository.iter_reverse_revision_history(
696
real_rev_history.reverse()
697
if len(real_rev_history) != last_revno:
698
raise errors.BzrCheckError('revno does not match len(mainline)'
699
' %s != %s' % (last_revno, len(real_rev_history)))
700
# TODO: We should probably also check that real_rev_history actually
701
# matches self.revision_history()
702
for revision_id in real_rev_history:
704
revision = self.repository.get_revision(revision_id)
705
except errors.NoSuchRevision, e:
706
raise errors.BzrCheckError("mainline revision {%s} not in repository"
708
# In general the first entry on the revision history has no parents.
709
# But it's not illegal for it to have parents listed; this can happen
710
# in imports from Arch when the parents weren't reachable.
711
if mainline_parent_id is not None:
712
if mainline_parent_id not in revision.parent_ids:
713
raise errors.BzrCheckError("previous revision {%s} not listed among "
715
% (mainline_parent_id, revision_id))
716
mainline_parent_id = revision_id
717
return BranchCheckResult(self)
719
def _get_checkout_format(self):
720
"""Return the most suitable metadir for a checkout of this branch.
721
Weaves are used if this branch's repository uses weaves.
723
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
724
from bzrlib.repofmt import weaverepo
725
format = bzrdir.BzrDirMetaFormat1()
726
format.repository_format = weaverepo.RepositoryFormat7()
728
format = self.repository.bzrdir.checkout_metadir()
729
format.set_branch_format(self._format)
732
def create_checkout(self, to_location, revision_id=None,
733
lightweight=False, accelerator_tree=None,
735
"""Create a checkout of a branch.
737
:param to_location: The url to produce the checkout at
738
:param revision_id: The revision to check out
739
:param lightweight: If True, produce a lightweight checkout, otherwise,
740
produce a bound branch (heavyweight checkout)
741
:param accelerator_tree: A tree which can be used for retrieving file
742
contents more quickly than the revision tree, i.e. a workingtree.
743
The revision tree will be used for cases where accelerator_tree's
744
content is different.
745
:param hardlink: If true, hard-link files from accelerator_tree,
747
:return: The tree of the created checkout
749
t = transport.get_transport(to_location)
752
format = self._get_checkout_format()
753
checkout = format.initialize_on_transport(t)
754
from_branch = BranchReferenceFormat().initialize(checkout, self)
756
format = self._get_checkout_format()
757
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
758
to_location, force_new_tree=False, format=format)
759
checkout = checkout_branch.bzrdir
760
checkout_branch.bind(self)
761
# pull up to the specified revision_id to set the initial
762
# branch tip correctly, and seed it with history.
763
checkout_branch.pull(self, stop_revision=revision_id)
765
tree = checkout.create_workingtree(revision_id,
766
from_branch=from_branch,
767
accelerator_tree=accelerator_tree,
769
basis_tree = tree.basis_tree()
770
basis_tree.lock_read()
772
for path, file_id in basis_tree.iter_references():
773
reference_parent = self.reference_parent(file_id, path)
774
reference_parent.create_checkout(tree.abspath(path),
775
basis_tree.get_reference_revision(file_id, path),
782
def reconcile(self, thorough=True):
783
"""Make sure the data stored in this branch is consistent."""
784
from bzrlib.reconcile import BranchReconciler
785
reconciler = BranchReconciler(self, thorough=thorough)
786
reconciler.reconcile()
789
def reference_parent(self, file_id, path):
790
"""Return the parent branch for a tree-reference file_id
791
:param file_id: The file_id of the tree reference
792
:param path: The path of the file_id in the tree
793
:return: A branch associated with the file_id
795
# FIXME should provide multiple branches, based on config
796
return Branch.open(self.bzrdir.root_transport.clone(path).base)
798
def supports_tags(self):
799
return self._format.supports_tags()
802
class BranchFormat(object):
803
"""An encapsulation of the initialization and open routines for a format.
805
Formats provide three things:
806
* An initialization routine,
810
Formats are placed in an dict by their format string for reference
811
during branch opening. Its not required that these be instances, they
812
can be classes themselves with class methods - it simply depends on
813
whether state is needed for a given format or not.
815
Once a format is deprecated, just deprecate the initialize and open
816
methods on the format class. Do not deprecate the object, as the
817
object will be created every time regardless.
820
_default_format = None
821
"""The default format used for new branches."""
824
"""The known formats."""
826
def __eq__(self, other):
827
return self.__class__ is other.__class__
829
def __ne__(self, other):
830
return not (self == other)
833
def find_format(klass, a_bzrdir):
834
"""Return the format for the branch object in a_bzrdir."""
836
transport = a_bzrdir.get_branch_transport(None)
837
format_string = transport.get("format").read()
838
return klass._formats[format_string]
839
except errors.NoSuchFile:
840
raise errors.NotBranchError(path=transport.base)
842
raise errors.UnknownFormatError(format=format_string, kind='branch')
845
def get_default_format(klass):
846
"""Return the current default format."""
847
return klass._default_format
849
def get_reference(self, a_bzrdir):
850
"""Get the target reference of the branch in a_bzrdir.
852
format probing must have been completed before calling
853
this method - it is assumed that the format of the branch
854
in a_bzrdir is correct.
856
:param a_bzrdir: The bzrdir to get the branch data from.
857
:return: None if the branch is not a reference branch.
862
def set_reference(self, a_bzrdir, to_branch):
863
"""Set the target reference of the branch in a_bzrdir.
865
format probing must have been completed before calling
866
this method - it is assumed that the format of the branch
867
in a_bzrdir is correct.
869
:param a_bzrdir: The bzrdir to set the branch reference for.
870
:param to_branch: branch that the checkout is to reference
872
raise NotImplementedError(self.set_reference)
874
def get_format_string(self):
875
"""Return the ASCII format string that identifies this format."""
876
raise NotImplementedError(self.get_format_string)
878
def get_format_description(self):
879
"""Return the short format description for this format."""
880
raise NotImplementedError(self.get_format_description)
882
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
884
"""Initialize a branch in a bzrdir, with specified files
886
:param a_bzrdir: The bzrdir to initialize the branch in
887
:param utf8_files: The files to create as a list of
888
(filename, content) tuples
889
:param set_format: If True, set the format with
890
self.get_format_string. (BzrBranch4 has its format set
892
:return: a branch in this format
894
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
895
branch_transport = a_bzrdir.get_branch_transport(self)
897
'metadir': ('lock', lockdir.LockDir),
898
'branch4': ('branch-lock', lockable_files.TransportLock),
900
lock_name, lock_class = lock_map[lock_type]
901
control_files = lockable_files.LockableFiles(branch_transport,
902
lock_name, lock_class)
903
control_files.create_lock()
904
control_files.lock_write()
906
control_files.put_utf8('format', self.get_format_string())
908
for file, content in utf8_files:
909
control_files.put_utf8(file, content)
911
control_files.unlock()
912
return self.open(a_bzrdir, _found=True)
914
def initialize(self, a_bzrdir):
915
"""Create a branch of this format in a_bzrdir."""
916
raise NotImplementedError(self.initialize)
918
def is_supported(self):
919
"""Is this format supported?
921
Supported formats can be initialized and opened.
922
Unsupported formats may not support initialization or committing or
923
some other features depending on the reason for not being supported.
927
def open(self, a_bzrdir, _found=False):
928
"""Return the branch object for a_bzrdir
930
_found is a private parameter, do not use it. It is used to indicate
931
if format probing has already be done.
933
raise NotImplementedError(self.open)
936
def register_format(klass, format):
937
klass._formats[format.get_format_string()] = format
940
def set_default_format(klass, format):
941
klass._default_format = format
944
def unregister_format(klass, format):
945
del klass._formats[format.get_format_string()]
948
return self.get_format_string().rstrip()
950
def supports_tags(self):
951
"""True if this format supports tags stored in the branch"""
952
return False # by default
954
# XXX: Probably doesn't really belong here -- mbp 20070212
955
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
957
branch_transport = a_bzrdir.get_branch_transport(self)
958
control_files = lockable_files.LockableFiles(branch_transport,
959
lock_filename, lock_class)
960
control_files.create_lock()
961
control_files.lock_write()
963
for filename, content in utf8_files:
964
control_files.put_utf8(filename, content)
966
control_files.unlock()
969
class BranchHooks(Hooks):
970
"""A dictionary mapping hook name to a list of callables for branch hooks.
972
e.g. ['set_rh'] Is the list of items to be called when the
973
set_revision_history function is invoked.
977
"""Create the default hooks.
979
These are all empty initially, because by default nothing should get
983
# Introduced in 0.15:
984
# invoked whenever the revision history has been set
985
# with set_revision_history. The api signature is
986
# (branch, revision_history), and the branch will
989
# invoked after a push operation completes.
990
# the api signature is
992
# containing the members
993
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
994
# where local is the local target branch or None, master is the target
995
# master branch, and the rest should be self explanatory. The source
996
# is read locked and the target branches write locked. Source will
997
# be the local low-latency branch.
998
self['post_push'] = []
999
# invoked after a pull operation completes.
1000
# the api signature is
1002
# containing the members
1003
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1004
# where local is the local branch or None, master is the target
1005
# master branch, and the rest should be self explanatory. The source
1006
# is read locked and the target branches write locked. The local
1007
# branch is the low-latency branch.
1008
self['post_pull'] = []
1009
# invoked before a commit operation takes place.
1010
# the api signature is
1011
# (local, master, old_revno, old_revid, future_revno, future_revid,
1012
# tree_delta, future_tree).
1013
# old_revid is NULL_REVISION for the first commit to a branch
1014
# tree_delta is a TreeDelta object describing changes from the basis
1015
# revision, hooks MUST NOT modify this delta
1016
# future_tree is an in-memory tree obtained from
1017
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1018
self['pre_commit'] = []
1019
# invoked after a commit operation completes.
1020
# the api signature is
1021
# (local, master, old_revno, old_revid, new_revno, new_revid)
1022
# old_revid is NULL_REVISION for the first commit to a branch.
1023
self['post_commit'] = []
1024
# invoked after a uncommit operation completes.
1025
# the api signature is
1026
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1027
# local is the local branch or None, master is the target branch,
1028
# and an empty branch recieves new_revno of 0, new_revid of None.
1029
self['post_uncommit'] = []
1031
# Invoked after the tip of a branch changes.
1032
# the api signature is
1033
# (params) where params is a ChangeBranchTipParams with the members
1034
# (branch, old_revno, new_revno, old_revid, new_revid)
1035
self['post_change_branch_tip'] = []
1038
# install the default hooks into the Branch class.
1039
Branch.hooks = BranchHooks()
1042
class ChangeBranchTipParams(object):
1043
"""Object holding parameters passed to *_change_branch_tip hooks.
1045
There are 5 fields that hooks may wish to access:
1047
:ivar branch: the branch being changed
1048
:ivar old_revno: revision number before the change
1049
:ivar new_revno: revision number after the change
1050
:ivar old_revid: revision id before the change
1051
:ivar new_revid: revision id after the change
1053
The revid fields are strings. The revno fields are integers.
1056
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1057
"""Create a group of ChangeBranchTip parameters.
1059
:param branch: The branch being changed.
1060
:param old_revno: Revision number before the change.
1061
:param new_revno: Revision number after the change.
1062
:param old_revid: Tip revision id before the change.
1063
:param new_revid: Tip revision id after the change.
1065
self.branch = branch
1066
self.old_revno = old_revno
1067
self.new_revno = new_revno
1068
self.old_revid = old_revid
1069
self.new_revid = new_revid
1072
class BzrBranchFormat4(BranchFormat):
1073
"""Bzr branch format 4.
1076
- a revision-history file.
1077
- a branch-lock lock file [ to be shared with the bzrdir ]
1080
def get_format_description(self):
1081
"""See BranchFormat.get_format_description()."""
1082
return "Branch format 4"
1084
def initialize(self, a_bzrdir):
1085
"""Create a branch of this format in a_bzrdir."""
1086
utf8_files = [('revision-history', ''),
1087
('branch-name', ''),
1089
return self._initialize_helper(a_bzrdir, utf8_files,
1090
lock_type='branch4', set_format=False)
1093
super(BzrBranchFormat4, self).__init__()
1094
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1096
def open(self, a_bzrdir, _found=False):
1097
"""Return the branch object for a_bzrdir
1099
_found is a private parameter, do not use it. It is used to indicate
1100
if format probing has already be done.
1103
# we are being called directly and must probe.
1104
raise NotImplementedError
1105
return BzrBranch(_format=self,
1106
_control_files=a_bzrdir._control_files,
1108
_repository=a_bzrdir.open_repository())
1111
return "Bazaar-NG branch format 4"
1114
class BzrBranchFormat5(BranchFormat):
1115
"""Bzr branch format 5.
1118
- a revision-history file.
1120
- a lock dir guarding the branch itself
1121
- all of this stored in a branch/ subdirectory
1122
- works with shared repositories.
1124
This format is new in bzr 0.8.
1127
def get_format_string(self):
1128
"""See BranchFormat.get_format_string()."""
1129
return "Bazaar-NG branch format 5\n"
1131
def get_format_description(self):
1132
"""See BranchFormat.get_format_description()."""
1133
return "Branch format 5"
1135
def initialize(self, a_bzrdir):
1136
"""Create a branch of this format in a_bzrdir."""
1137
utf8_files = [('revision-history', ''),
1138
('branch-name', ''),
1140
return self._initialize_helper(a_bzrdir, utf8_files)
1143
super(BzrBranchFormat5, self).__init__()
1144
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1146
def open(self, a_bzrdir, _found=False):
1147
"""Return the branch object for a_bzrdir
1149
_found is a private parameter, do not use it. It is used to indicate
1150
if format probing has already be done.
1153
format = BranchFormat.find_format(a_bzrdir)
1154
if format.__class__ != self.__class__:
1155
raise AssertionError("wrong format %r found for %r" %
1158
transport = a_bzrdir.get_branch_transport(None)
1159
control_files = lockable_files.LockableFiles(transport, 'lock',
1161
return BzrBranch5(_format=self,
1162
_control_files=control_files,
1164
_repository=a_bzrdir.find_repository())
1165
except errors.NoSuchFile:
1166
raise errors.NotBranchError(path=transport.base)
1169
class BzrBranchFormat6(BzrBranchFormat5):
1170
"""Branch format with last-revision and tags.
1172
Unlike previous formats, this has no explicit revision history. Instead,
1173
this just stores the last-revision, and the left-hand history leading
1174
up to there is the history.
1176
This format was introduced in bzr 0.15
1177
and became the default in 0.91.
1180
def get_format_string(self):
1181
"""See BranchFormat.get_format_string()."""
1182
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1184
def get_format_description(self):
1185
"""See BranchFormat.get_format_description()."""
1186
return "Branch format 6"
1188
def initialize(self, a_bzrdir):
1189
"""Create a branch of this format in a_bzrdir."""
1190
utf8_files = [('last-revision', '0 null:\n'),
1191
('branch.conf', ''),
1194
return self._initialize_helper(a_bzrdir, utf8_files)
1196
def open(self, a_bzrdir, _found=False):
1197
"""Return the branch object for a_bzrdir
1199
_found is a private parameter, do not use it. It is used to indicate
1200
if format probing has already be done.
1203
format = BranchFormat.find_format(a_bzrdir)
1204
if format.__class__ != self.__class__:
1205
raise AssertionError("wrong format %r found for %r" %
1207
transport = a_bzrdir.get_branch_transport(None)
1208
control_files = lockable_files.LockableFiles(transport, 'lock',
1210
return BzrBranch6(_format=self,
1211
_control_files=control_files,
1213
_repository=a_bzrdir.find_repository())
1215
def supports_tags(self):
1219
class BranchReferenceFormat(BranchFormat):
1220
"""Bzr branch reference format.
1222
Branch references are used in implementing checkouts, they
1223
act as an alias to the real branch which is at some other url.
1230
def get_format_string(self):
1231
"""See BranchFormat.get_format_string()."""
1232
return "Bazaar-NG Branch Reference Format 1\n"
1234
def get_format_description(self):
1235
"""See BranchFormat.get_format_description()."""
1236
return "Checkout reference format 1"
1238
def get_reference(self, a_bzrdir):
1239
"""See BranchFormat.get_reference()."""
1240
transport = a_bzrdir.get_branch_transport(None)
1241
return transport.get('location').read()
1243
def set_reference(self, a_bzrdir, to_branch):
1244
"""See BranchFormat.set_reference()."""
1245
transport = a_bzrdir.get_branch_transport(None)
1246
location = transport.put_bytes('location', to_branch.base)
1248
def initialize(self, a_bzrdir, target_branch=None):
1249
"""Create a branch of this format in a_bzrdir."""
1250
if target_branch is None:
1251
# this format does not implement branch itself, thus the implicit
1252
# creation contract must see it as uninitializable
1253
raise errors.UninitializableFormat(self)
1254
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1255
branch_transport = a_bzrdir.get_branch_transport(self)
1256
branch_transport.put_bytes('location',
1257
target_branch.bzrdir.root_transport.base)
1258
branch_transport.put_bytes('format', self.get_format_string())
1260
a_bzrdir, _found=True,
1261
possible_transports=[target_branch.bzrdir.root_transport])
1264
super(BranchReferenceFormat, self).__init__()
1265
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1267
def _make_reference_clone_function(format, a_branch):
1268
"""Create a clone() routine for a branch dynamically."""
1269
def clone(to_bzrdir, revision_id=None):
1270
"""See Branch.clone()."""
1271
return format.initialize(to_bzrdir, a_branch)
1272
# cannot obey revision_id limits when cloning a reference ...
1273
# FIXME RBC 20060210 either nuke revision_id for clone, or
1274
# emit some sort of warning/error to the caller ?!
1277
def open(self, a_bzrdir, _found=False, location=None,
1278
possible_transports=None):
1279
"""Return the branch that the branch reference in a_bzrdir points at.
1281
_found is a private parameter, do not use it. It is used to indicate
1282
if format probing has already be done.
1285
format = BranchFormat.find_format(a_bzrdir)
1286
if format.__class__ != self.__class__:
1287
raise AssertionError("wrong format %r found for %r" %
1289
if location is None:
1290
location = self.get_reference(a_bzrdir)
1291
real_bzrdir = bzrdir.BzrDir.open(
1292
location, possible_transports=possible_transports)
1293
result = real_bzrdir.open_branch()
1294
# this changes the behaviour of result.clone to create a new reference
1295
# rather than a copy of the content of the branch.
1296
# I did not use a proxy object because that needs much more extensive
1297
# testing, and we are only changing one behaviour at the moment.
1298
# If we decide to alter more behaviours - i.e. the implicit nickname
1299
# then this should be refactored to introduce a tested proxy branch
1300
# and a subclass of that for use in overriding clone() and ....
1302
result.clone = self._make_reference_clone_function(result)
1306
# formats which have no format string are not discoverable
1307
# and not independently creatable, so are not registered.
1308
__format5 = BzrBranchFormat5()
1309
__format6 = BzrBranchFormat6()
1310
BranchFormat.register_format(__format5)
1311
BranchFormat.register_format(BranchReferenceFormat())
1312
BranchFormat.register_format(__format6)
1313
BranchFormat.set_default_format(__format6)
1314
_legacy_formats = [BzrBranchFormat4(),
1317
class BzrBranch(Branch):
1318
"""A branch stored in the actual filesystem.
1320
Note that it's "local" in the context of the filesystem; it doesn't
1321
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1322
it's writable, and can be accessed via the normal filesystem API.
1325
def __init__(self, _format=None,
1326
_control_files=None, a_bzrdir=None, _repository=None):
1327
"""Create new branch object at a particular location."""
1328
Branch.__init__(self)
1329
if a_bzrdir is None:
1330
raise ValueError('a_bzrdir must be supplied')
1332
self.bzrdir = a_bzrdir
1333
# self._transport used to point to the directory containing the
1334
# control directory, but was not used - now it's just the transport
1335
# for the branch control files. mbp 20070212
1336
self._base = self.bzrdir.transport.clone('..').base
1337
self._format = _format
1338
if _control_files is None:
1339
raise ValueError('BzrBranch _control_files is None')
1340
self.control_files = _control_files
1341
self._transport = _control_files._transport
1342
self.repository = _repository
1345
return '%s(%r)' % (self.__class__.__name__, self.base)
1349
def _get_base(self):
1350
"""Returns the directory containing the control directory."""
1353
base = property(_get_base, doc="The URL for the root of this branch.")
1355
def abspath(self, name):
1356
"""See Branch.abspath."""
1357
return self.control_files._transport.abspath(name)
1359
def is_locked(self):
1360
return self.control_files.is_locked()
1362
def lock_write(self, token=None):
1363
repo_token = self.repository.lock_write()
1365
token = self.control_files.lock_write(token=token)
1367
self.repository.unlock()
1371
def lock_read(self):
1372
self.repository.lock_read()
1374
self.control_files.lock_read()
1376
self.repository.unlock()
1380
# TODO: test for failed two phase locks. This is known broken.
1382
self.control_files.unlock()
1384
self.repository.unlock()
1385
if not self.control_files.is_locked():
1386
# we just released the lock
1387
self._clear_cached_state()
1389
def peek_lock_mode(self):
1390
if self.control_files._lock_count == 0:
1393
return self.control_files._lock_mode
1395
def get_physical_lock_status(self):
1396
return self.control_files.get_physical_lock_status()
1399
def print_file(self, file, revision_id):
1400
"""See Branch.print_file."""
1401
return self.repository.print_file(file, revision_id)
1403
def _write_revision_history(self, history):
1404
"""Factored out of set_revision_history.
1406
This performs the actual writing to disk.
1407
It is intended to be called by BzrBranch5.set_revision_history."""
1408
self.control_files.put_bytes(
1409
'revision-history', '\n'.join(history))
1412
def set_revision_history(self, rev_history):
1413
"""See Branch.set_revision_history."""
1414
if 'evil' in debug.debug_flags:
1415
mutter_callsite(3, "set_revision_history scales with history.")
1416
self._write_revision_history(rev_history)
1417
self._clear_cached_state()
1418
self._cache_revision_history(rev_history)
1419
for hook in Branch.hooks['set_rh']:
1420
hook(self, rev_history)
1422
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1423
"""Run the post_change_branch_tip hooks."""
1424
hooks = Branch.hooks['post_change_branch_tip']
1427
new_revno, new_revid = self.last_revision_info()
1428
params = ChangeBranchTipParams(
1429
self, old_revno, new_revno, old_revid, new_revid)
1434
def set_last_revision_info(self, revno, revision_id):
1435
"""Set the last revision of this branch.
1437
The caller is responsible for checking that the revno is correct
1438
for this revision id.
1440
It may be possible to set the branch last revision to an id not
1441
present in the repository. However, branches can also be
1442
configured to check constraints on history, in which case this may not
1445
revision_id = _mod_revision.ensure_null(revision_id)
1446
old_revno, old_revid = self.last_revision_info()
1447
# this old format stores the full history, but this api doesn't
1448
# provide it, so we must generate, and might as well check it's
1450
history = self._lefthand_history(revision_id)
1451
if len(history) != revno:
1452
raise AssertionError('%d != %d' % (len(history), revno))
1453
self.set_revision_history(history)
1454
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1456
def _gen_revision_history(self):
1457
history = self.control_files.get('revision-history').read().split('\n')
1458
if history[-1:] == ['']:
1459
# There shouldn't be a trailing newline, but just in case.
1463
def _lefthand_history(self, revision_id, last_rev=None,
1465
if 'evil' in debug.debug_flags:
1466
mutter_callsite(4, "_lefthand_history scales with history.")
1467
# stop_revision must be a descendant of last_revision
1468
graph = self.repository.get_graph()
1469
if last_rev is not None:
1470
if not graph.is_ancestor(last_rev, revision_id):
1471
# our previous tip is not merged into stop_revision
1472
raise errors.DivergedBranches(self, other_branch)
1473
# make a new revision history from the graph
1474
parents_map = graph.get_parent_map([revision_id])
1475
if revision_id not in parents_map:
1476
raise errors.NoSuchRevision(self, revision_id)
1477
current_rev_id = revision_id
1479
# Do not include ghosts or graph origin in revision_history
1480
while (current_rev_id in parents_map and
1481
len(parents_map[current_rev_id]) > 0):
1482
new_history.append(current_rev_id)
1483
current_rev_id = parents_map[current_rev_id][0]
1484
parents_map = graph.get_parent_map([current_rev_id])
1485
new_history.reverse()
1489
def generate_revision_history(self, revision_id, last_rev=None,
1491
"""Create a new revision history that will finish with revision_id.
1493
:param revision_id: the new tip to use.
1494
:param last_rev: The previous last_revision. If not None, then this
1495
must be a ancestory of revision_id, or DivergedBranches is raised.
1496
:param other_branch: The other branch that DivergedBranches should
1497
raise with respect to.
1499
self.set_revision_history(self._lefthand_history(revision_id,
1500
last_rev, other_branch))
1503
def update_revisions(self, other, stop_revision=None, overwrite=False):
1504
"""See Branch.update_revisions."""
1507
other_last_revno, other_last_revision = other.last_revision_info()
1508
if stop_revision is None:
1509
stop_revision = other_last_revision
1510
if _mod_revision.is_null(stop_revision):
1511
# if there are no commits, we're done.
1513
# whats the current last revision, before we fetch [and change it
1515
last_rev = _mod_revision.ensure_null(self.last_revision())
1516
# we fetch here so that we don't process data twice in the common
1517
# case of having something to pull, and so that the check for
1518
# already merged can operate on the just fetched graph, which will
1519
# be cached in memory.
1520
self.fetch(other, stop_revision)
1521
# Check to see if one is an ancestor of the other
1523
heads = self.repository.get_graph().heads([stop_revision,
1525
if heads == set([last_rev]):
1526
# The current revision is a decendent of the target,
1529
elif heads == set([stop_revision, last_rev]):
1530
# These branches have diverged
1531
raise errors.DivergedBranches(self, other)
1532
elif heads != set([stop_revision]):
1533
raise AssertionError("invalid heads: %r" % heads)
1534
if other_last_revision == stop_revision:
1535
self.set_last_revision_info(other_last_revno,
1536
other_last_revision)
1538
# TODO: jam 2007-11-29 Is there a way to determine the
1539
# revno without searching all of history??
1541
self.generate_revision_history(stop_revision)
1543
self.generate_revision_history(stop_revision,
1544
last_rev=last_rev, other_branch=other)
1548
def basis_tree(self):
1549
"""See Branch.basis_tree."""
1550
return self.repository.revision_tree(self.last_revision())
1553
def pull(self, source, overwrite=False, stop_revision=None,
1554
_hook_master=None, run_hooks=True, possible_transports=None):
1557
:param _hook_master: Private parameter - set the branch to
1558
be supplied as the master to push hooks.
1559
:param run_hooks: Private parameter - if false, this branch
1560
is being called because it's the master of the primary branch,
1561
so it should not run its hooks.
1563
result = PullResult()
1564
result.source_branch = source
1565
result.target_branch = self
1568
result.old_revno, result.old_revid = self.last_revision_info()
1569
self.update_revisions(source, stop_revision, overwrite=overwrite)
1570
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1571
result.new_revno, result.new_revid = self.last_revision_info()
1573
result.master_branch = _hook_master
1574
result.local_branch = self
1576
result.master_branch = self
1577
result.local_branch = None
1579
for hook in Branch.hooks['post_pull']:
1585
def _get_parent_location(self):
1586
_locs = ['parent', 'pull', 'x-pull']
1589
return self.control_files.get(l).read().strip('\n')
1590
except errors.NoSuchFile:
1595
def push(self, target, overwrite=False, stop_revision=None,
1596
_override_hook_source_branch=None):
1599
This is the basic concrete implementation of push()
1601
:param _override_hook_source_branch: If specified, run
1602
the hooks passing this Branch as the source, rather than self.
1603
This is for use of RemoteBranch, where push is delegated to the
1604
underlying vfs-based Branch.
1606
# TODO: Public option to disable running hooks - should be trivial but
1610
result = self._push_with_bound_branches(target, overwrite,
1612
_override_hook_source_branch=_override_hook_source_branch)
1617
def _push_with_bound_branches(self, target, overwrite,
1619
_override_hook_source_branch=None):
1620
"""Push from self into target, and into target's master if any.
1622
This is on the base BzrBranch class even though it doesn't support
1623
bound branches because the *target* might be bound.
1626
if _override_hook_source_branch:
1627
result.source_branch = _override_hook_source_branch
1628
for hook in Branch.hooks['post_push']:
1631
bound_location = target.get_bound_location()
1632
if bound_location and target.base != bound_location:
1633
# there is a master branch.
1635
# XXX: Why the second check? Is it even supported for a branch to
1636
# be bound to itself? -- mbp 20070507
1637
master_branch = target.get_master_branch()
1638
master_branch.lock_write()
1640
# push into the master from this branch.
1641
self._basic_push(master_branch, overwrite, stop_revision)
1642
# and push into the target branch from this. Note that we push from
1643
# this branch again, because its considered the highest bandwidth
1645
result = self._basic_push(target, overwrite, stop_revision)
1646
result.master_branch = master_branch
1647
result.local_branch = target
1651
master_branch.unlock()
1654
result = self._basic_push(target, overwrite, stop_revision)
1655
# TODO: Why set master_branch and local_branch if there's no
1656
# binding? Maybe cleaner to just leave them unset? -- mbp
1658
result.master_branch = target
1659
result.local_branch = None
1663
def _basic_push(self, target, overwrite, stop_revision):
1664
"""Basic implementation of push without bound branches or hooks.
1666
Must be called with self read locked and target write locked.
1668
result = PushResult()
1669
result.source_branch = self
1670
result.target_branch = target
1671
result.old_revno, result.old_revid = target.last_revision_info()
1673
target.update_revisions(self, stop_revision)
1674
except errors.DivergedBranches:
1678
target.set_revision_history(self.revision_history())
1679
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1680
result.new_revno, result.new_revid = target.last_revision_info()
1683
def get_parent(self):
1684
"""See Branch.get_parent."""
1685
parent = self._get_parent_location()
1688
# This is an old-format absolute path to a local branch
1689
# turn it into a url
1690
if parent.startswith('/'):
1691
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1693
return urlutils.join(self.base[:-1], parent)
1694
except errors.InvalidURLJoin, e:
1695
raise errors.InaccessibleParent(parent, self.base)
1697
def set_push_location(self, location):
1698
"""See Branch.set_push_location."""
1699
self.get_config().set_user_option(
1700
'push_location', location,
1701
store=_mod_config.STORE_LOCATION_NORECURSE)
1704
def set_parent(self, url):
1705
"""See Branch.set_parent."""
1706
# TODO: Maybe delete old location files?
1707
# URLs should never be unicode, even on the local fs,
1708
# FIXUP this and get_parent in a future branch format bump:
1709
# read and rewrite the file. RBC 20060125
1711
if isinstance(url, unicode):
1713
url = url.encode('ascii')
1714
except UnicodeEncodeError:
1715
raise errors.InvalidURL(url,
1716
"Urls must be 7-bit ascii, "
1717
"use bzrlib.urlutils.escape")
1718
url = urlutils.relative_url(self.base, url)
1719
self._set_parent_location(url)
1721
def _set_parent_location(self, url):
1723
self.control_files._transport.delete('parent')
1725
self.control_files.put_bytes('parent', url + '\n')
1728
class BzrBranch5(BzrBranch):
1729
"""A format 5 branch. This supports new features over plain branches.
1731
It has support for a master_branch which is the data for bound branches.
1739
super(BzrBranch5, self).__init__(_format=_format,
1740
_control_files=_control_files,
1742
_repository=_repository)
1745
def pull(self, source, overwrite=False, stop_revision=None,
1746
run_hooks=True, possible_transports=None):
1747
"""Pull from source into self, updating my master if any.
1749
:param run_hooks: Private parameter - if false, this branch
1750
is being called because it's the master of the primary branch,
1751
so it should not run its hooks.
1753
bound_location = self.get_bound_location()
1754
master_branch = None
1755
if bound_location and source.base != bound_location:
1756
# not pulling from master, so we need to update master.
1757
master_branch = self.get_master_branch(possible_transports)
1758
master_branch.lock_write()
1761
# pull from source into master.
1762
master_branch.pull(source, overwrite, stop_revision,
1764
return super(BzrBranch5, self).pull(source, overwrite,
1765
stop_revision, _hook_master=master_branch,
1766
run_hooks=run_hooks)
1769
master_branch.unlock()
1771
def get_bound_location(self):
1773
return self._transport.get_bytes('bound')[:-1]
1774
except errors.NoSuchFile:
1778
def get_master_branch(self, possible_transports=None):
1779
"""Return the branch we are bound to.
1781
:return: Either a Branch, or None
1783
This could memoise the branch, but if thats done
1784
it must be revalidated on each new lock.
1785
So for now we just don't memoise it.
1786
# RBC 20060304 review this decision.
1788
bound_loc = self.get_bound_location()
1792
return Branch.open(bound_loc,
1793
possible_transports=possible_transports)
1794
except (errors.NotBranchError, errors.ConnectionError), e:
1795
raise errors.BoundBranchConnectionFailure(
1799
def set_bound_location(self, location):
1800
"""Set the target where this branch is bound to.
1802
:param location: URL to the target branch
1805
self.control_files.put_utf8('bound', location+'\n')
1808
self.control_files._transport.delete('bound')
1809
except errors.NoSuchFile:
1814
def bind(self, other):
1815
"""Bind this branch to the branch other.
1817
This does not push or pull data between the branches, though it does
1818
check for divergence to raise an error when the branches are not
1819
either the same, or one a prefix of the other. That behaviour may not
1820
be useful, so that check may be removed in future.
1822
:param other: The branch to bind to
1825
# TODO: jam 20051230 Consider checking if the target is bound
1826
# It is debatable whether you should be able to bind to
1827
# a branch which is itself bound.
1828
# Committing is obviously forbidden,
1829
# but binding itself may not be.
1830
# Since we *have* to check at commit time, we don't
1831
# *need* to check here
1833
# we want to raise diverged if:
1834
# last_rev is not in the other_last_rev history, AND
1835
# other_last_rev is not in our history, and do it without pulling
1837
self.set_bound_location(other.base)
1841
"""If bound, unbind"""
1842
return self.set_bound_location(None)
1845
def update(self, possible_transports=None):
1846
"""Synchronise this branch with the master branch if any.
1848
:return: None or the last_revision that was pivoted out during the
1851
master = self.get_master_branch(possible_transports)
1852
if master is not None:
1853
old_tip = _mod_revision.ensure_null(self.last_revision())
1854
self.pull(master, overwrite=True)
1855
if self.repository.get_graph().is_ancestor(old_tip,
1856
_mod_revision.ensure_null(self.last_revision())):
1862
class BzrBranch6(BzrBranch5):
1864
def __init__(self, *args, **kwargs):
1865
super(BzrBranch6, self).__init__(*args, **kwargs)
1866
self._last_revision_info_cache = None
1867
self._partial_revision_history_cache = []
1869
def _clear_cached_state(self):
1870
super(BzrBranch6, self)._clear_cached_state()
1871
self._last_revision_info_cache = None
1872
self._partial_revision_history_cache = []
1875
def last_revision_info(self):
1876
"""Return information about the last revision.
1878
:return: A tuple (revno, revision_id).
1880
if self._last_revision_info_cache is None:
1881
self._last_revision_info_cache = self._last_revision_info()
1882
return self._last_revision_info_cache
1884
def _last_revision_info(self):
1885
revision_string = self.control_files.get('last-revision').read()
1886
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1887
revision_id = cache_utf8.get_cached_utf8(revision_id)
1889
return revno, revision_id
1891
def _write_last_revision_info(self, revno, revision_id):
1892
"""Simply write out the revision id, with no checks.
1894
Use set_last_revision_info to perform this safely.
1896
Does not update the revision_history cache.
1897
Intended to be called by set_last_revision_info and
1898
_write_revision_history.
1900
revision_id = _mod_revision.ensure_null(revision_id)
1901
out_string = '%d %s\n' % (revno, revision_id)
1902
self.control_files.put_bytes('last-revision', out_string)
1905
def set_last_revision_info(self, revno, revision_id):
1906
revision_id = _mod_revision.ensure_null(revision_id)
1907
old_revno, old_revid = self.last_revision_info()
1908
if self._get_append_revisions_only():
1909
self._check_history_violation(revision_id)
1910
self._write_last_revision_info(revno, revision_id)
1911
self._clear_cached_state()
1912
self._last_revision_info_cache = revno, revision_id
1913
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1915
def _check_history_violation(self, revision_id):
1916
last_revision = _mod_revision.ensure_null(self.last_revision())
1917
if _mod_revision.is_null(last_revision):
1919
if last_revision not in self._lefthand_history(revision_id):
1920
raise errors.AppendRevisionsOnlyViolation(self.base)
1922
def _gen_revision_history(self):
1923
"""Generate the revision history from last revision
1925
self._extend_partial_history()
1926
return list(reversed(self._partial_revision_history_cache))
1928
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1929
"""Extend the partial history to include a given index
1931
If a stop_index is supplied, stop when that index has been reached.
1932
If a stop_revision is supplied, stop when that revision is
1933
encountered. Otherwise, stop when the beginning of history is
1936
:param stop_index: The index which should be present. When it is
1937
present, history extension will stop.
1938
:param revision_id: The revision id which should be present. When
1939
it is encountered, history extension will stop.
1941
repo = self.repository
1942
if len(self._partial_revision_history_cache) == 0:
1943
iterator = repo.iter_reverse_revision_history(self.last_revision())
1945
start_revision = self._partial_revision_history_cache[-1]
1946
iterator = repo.iter_reverse_revision_history(start_revision)
1947
#skip the last revision in the list
1948
next_revision = iterator.next()
1949
for revision_id in iterator:
1950
self._partial_revision_history_cache.append(revision_id)
1951
if (stop_index is not None and
1952
len(self._partial_revision_history_cache) > stop_index):
1954
if revision_id == stop_revision:
1957
def _write_revision_history(self, history):
1958
"""Factored out of set_revision_history.
1960
This performs the actual writing to disk, with format-specific checks.
1961
It is intended to be called by BzrBranch5.set_revision_history.
1963
if len(history) == 0:
1964
last_revision = 'null:'
1966
if history != self._lefthand_history(history[-1]):
1967
raise errors.NotLefthandHistory(history)
1968
last_revision = history[-1]
1969
if self._get_append_revisions_only():
1970
self._check_history_violation(last_revision)
1971
self._write_last_revision_info(len(history), last_revision)
1974
def _set_parent_location(self, url):
1975
"""Set the parent branch"""
1976
self._set_config_location('parent_location', url, make_relative=True)
1979
def _get_parent_location(self):
1980
"""Set the parent branch"""
1981
return self._get_config_location('parent_location')
1983
def set_push_location(self, location):
1984
"""See Branch.set_push_location."""
1985
self._set_config_location('push_location', location)
1987
def set_bound_location(self, location):
1988
"""See Branch.set_push_location."""
1990
config = self.get_config()
1991
if location is None:
1992
if config.get_user_option('bound') != 'True':
1995
config.set_user_option('bound', 'False', warn_masked=True)
1998
self._set_config_location('bound_location', location,
2000
config.set_user_option('bound', 'True', warn_masked=True)
2003
def _get_bound_location(self, bound):
2004
"""Return the bound location in the config file.
2006
Return None if the bound parameter does not match"""
2007
config = self.get_config()
2008
config_bound = (config.get_user_option('bound') == 'True')
2009
if config_bound != bound:
2011
return self._get_config_location('bound_location', config=config)
2013
def get_bound_location(self):
2014
"""See Branch.set_push_location."""
2015
return self._get_bound_location(True)
2017
def get_old_bound_location(self):
2018
"""See Branch.get_old_bound_location"""
2019
return self._get_bound_location(False)
2021
def set_append_revisions_only(self, enabled):
2026
self.get_config().set_user_option('append_revisions_only', value,
2029
def _get_append_revisions_only(self):
2030
value = self.get_config().get_user_option('append_revisions_only')
2031
return value == 'True'
2033
def _synchronize_history(self, destination, revision_id):
2034
"""Synchronize last revision and revision history between branches.
2036
This version is most efficient when the destination is also a
2037
BzrBranch6, but works for BzrBranch5, as long as the destination's
2038
repository contains all the lefthand ancestors of the intended
2039
last_revision. If not, set_last_revision_info will fail.
2041
:param destination: The branch to copy the history into
2042
:param revision_id: The revision-id to truncate history at. May
2043
be None to copy complete history.
2045
source_revno, source_revision_id = self.last_revision_info()
2046
if revision_id is None:
2047
revno, revision_id = source_revno, source_revision_id
2048
elif source_revision_id == revision_id:
2049
# we know the revno without needing to walk all of history
2050
revno = source_revno
2052
# To figure out the revno for a random revision, we need to build
2053
# the revision history, and count its length.
2054
# We don't care about the order, just how long it is.
2055
# Alternatively, we could start at the current location, and count
2056
# backwards. But there is no guarantee that we will find it since
2057
# it may be a merged revision.
2058
revno = len(list(self.repository.iter_reverse_revision_history(
2060
destination.set_last_revision_info(revno, revision_id)
2062
def _make_tags(self):
2063
return BasicTags(self)
2066
def generate_revision_history(self, revision_id, last_rev=None,
2068
"""See BzrBranch5.generate_revision_history"""
2069
history = self._lefthand_history(revision_id, last_rev, other_branch)
2070
revno = len(history)
2071
self.set_last_revision_info(revno, revision_id)
2074
def get_rev_id(self, revno, history=None):
2075
"""Find the revision id of the specified revno."""
2077
return _mod_revision.NULL_REVISION
2079
last_revno, last_revision_id = self.last_revision_info()
2080
if revno <= 0 or revno > last_revno:
2081
raise errors.NoSuchRevision(self, revno)
2083
if history is not None:
2084
return history[revno - 1]
2086
index = last_revno - revno
2087
if len(self._partial_revision_history_cache) <= index:
2088
self._extend_partial_history(stop_index=index)
2089
if len(self._partial_revision_history_cache) > index:
2090
return self._partial_revision_history_cache[index]
2092
raise errors.NoSuchRevision(self, revno)
2095
def revision_id_to_revno(self, revision_id):
2096
"""Given a revision id, return its revno"""
2097
if _mod_revision.is_null(revision_id):
2100
index = self._partial_revision_history_cache.index(revision_id)
2102
self._extend_partial_history(stop_revision=revision_id)
2103
index = len(self._partial_revision_history_cache) - 1
2104
if self._partial_revision_history_cache[index] != revision_id:
2105
raise errors.NoSuchRevision(self, revision_id)
2106
return self.revno() - index
2109
######################################################################
2110
# results of operations
2113
class _Result(object):
2115
def _show_tag_conficts(self, to_file):
2116
if not getattr(self, 'tag_conflicts', None):
2118
to_file.write('Conflicting tags:\n')
2119
for name, value1, value2 in self.tag_conflicts:
2120
to_file.write(' %s\n' % (name, ))
2123
class PullResult(_Result):
2124
"""Result of a Branch.pull operation.
2126
:ivar old_revno: Revision number before pull.
2127
:ivar new_revno: Revision number after pull.
2128
:ivar old_revid: Tip revision id before pull.
2129
:ivar new_revid: Tip revision id after pull.
2130
:ivar source_branch: Source (local) branch object.
2131
:ivar master_branch: Master branch of the target, or None.
2132
:ivar target_branch: Target/destination branch object.
2136
# DEPRECATED: pull used to return the change in revno
2137
return self.new_revno - self.old_revno
2139
def report(self, to_file):
2141
if self.old_revid == self.new_revid:
2142
to_file.write('No revisions to pull.\n')
2144
to_file.write('Now on revision %d.\n' % self.new_revno)
2145
self._show_tag_conficts(to_file)
2148
class PushResult(_Result):
2149
"""Result of a Branch.push operation.
2151
:ivar old_revno: Revision number before push.
2152
:ivar new_revno: Revision number after push.
2153
:ivar old_revid: Tip revision id before push.
2154
:ivar new_revid: Tip revision id after push.
2155
:ivar source_branch: Source branch object.
2156
:ivar master_branch: Master branch of the target, or None.
2157
:ivar target_branch: Target/destination branch object.
2161
# DEPRECATED: push used to return the change in revno
2162
return self.new_revno - self.old_revno
2164
def report(self, to_file):
2165
"""Write a human-readable description of the result."""
2166
if self.old_revid == self.new_revid:
2167
to_file.write('No new revisions to push.\n')
2169
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2170
self._show_tag_conficts(to_file)
2173
class BranchCheckResult(object):
2174
"""Results of checking branch consistency.
2179
def __init__(self, branch):
2180
self.branch = branch
2182
def report_results(self, verbose):
2183
"""Report the check results via trace.note.
2185
:param verbose: Requests more detailed display of what was checked,
2188
note('checked branch %s format %s',
2190
self.branch._format)
2193
class Converter5to6(object):
2194
"""Perform an in-place upgrade of format 5 to format 6"""
2196
def convert(self, branch):
2197
# Data for 5 and 6 can peacefully coexist.
2198
format = BzrBranchFormat6()
2199
new_branch = format.open(branch.bzrdir, _found=True)
2201
# Copy source data into target
2202
new_branch._write_last_revision_info(*branch.last_revision_info())
2203
new_branch.set_parent(branch.get_parent())
2204
new_branch.set_bound_location(branch.get_bound_location())
2205
new_branch.set_push_location(branch.get_push_location())
2207
# New branch has no tags by default
2208
new_branch.tags._set_tag_dict({})
2210
# Copying done; now update target format
2211
new_branch.control_files.put_utf8('format',
2212
format.get_format_string())
2214
# Clean up old files
2215
new_branch.control_files._transport.delete('revision-history')
2217
branch.set_parent(None)
2218
except errors.NoSuchFile:
2220
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
