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 cStringIO import StringIO
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
30
config as _mod_config,
35
revision as _mod_revision,
42
from bzrlib.config import BranchConfig, TreeConfig
43
from bzrlib.lockable_files import LockableFiles, TransportLock
44
from bzrlib.tag import (
50
from bzrlib.decorators import needs_read_lock, needs_write_lock
51
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
52
HistoryMissing, InvalidRevisionId,
53
InvalidRevisionNumber, LockError, NoSuchFile,
54
NoSuchRevision, NoWorkingTree, NotVersionedError,
55
NotBranchError, UninitializableFormat,
56
UnlistableStore, UnlistableBranch,
58
from bzrlib.hooks import Hooks
59
from bzrlib.symbol_versioning import (deprecated_function,
63
zero_eight, zero_nine, zero_sixteen,
65
from bzrlib.trace import mutter, note
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
73
# TODO: Maybe include checks for common corruption of newlines, etc?
75
# TODO: Some operations like log might retrieve the same revisions
76
# repeatedly to calculate deltas. We could perhaps have a weakref
77
# cache in memory to make this faster. In general anything can be
78
# cached in memory between lock and unlock operations. .. nb thats
79
# what the transaction identity map provides
82
######################################################################
86
"""Branch holding a history of revisions.
89
Base directory/url of the branch.
91
hooks: An instance of BranchHooks.
93
# this is really an instance variable - FIXME move it there
97
# override this to set the strategy for storing tags
99
return DisabledTags(self)
101
def __init__(self, *ignored, **ignored_too):
102
self.tags = self._make_tags()
103
self._revision_history_cache = None
104
self._revision_id_to_revno_cache = None
106
def break_lock(self):
107
"""Break a lock if one is present from another instance.
109
Uses the ui factory to ask for confirmation if the lock may be from
112
This will probe the repository for its lock as well.
114
self.control_files.break_lock()
115
self.repository.break_lock()
116
master = self.get_master_branch()
117
if master is not None:
121
@deprecated_method(zero_eight)
122
def open_downlevel(base):
123
"""Open a branch which may be of an old format."""
124
return Branch.open(base, _unsupported=True)
127
def open(base, _unsupported=False):
128
"""Open the branch rooted at base.
130
For instance, if the branch is at URL/.bzr/branch,
131
Branch.open(URL) -> a Branch instance.
133
control = bzrdir.BzrDir.open(base, _unsupported)
134
return control.open_branch(_unsupported)
137
def open_containing(url):
138
"""Open an existing branch which contains url.
140
This probes for a branch at url, and searches upwards from there.
142
Basically we keep looking up until we find the control directory or
143
run into the root. If there isn't one, raises NotBranchError.
144
If there is one and it is either an unrecognised format or an unsupported
145
format, UnknownFormatError or UnsupportedFormatError are raised.
146
If there is one, it is returned, along with the unused portion of url.
148
control, relpath = bzrdir.BzrDir.open_containing(url)
149
return control.open_branch(), relpath
152
@deprecated_function(zero_eight)
153
def initialize(base):
154
"""Create a new working tree and branch, rooted at 'base' (url)
156
NOTE: This will soon be deprecated in favour of creation
159
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
161
@deprecated_function(zero_eight)
162
def setup_caching(self, cache_root):
163
"""Subclasses that care about caching should override this, and set
164
up cached stores located under cache_root.
166
NOTE: This is unused.
170
def get_config(self):
171
return BranchConfig(self)
174
return self.get_config().get_nickname()
176
def _set_nick(self, nick):
177
self.get_config().set_user_option('nickname', nick)
179
nick = property(_get_nick, _set_nick)
182
raise NotImplementedError(self.is_locked)
184
def lock_write(self):
185
raise NotImplementedError(self.lock_write)
188
raise NotImplementedError(self.lock_read)
191
raise NotImplementedError(self.unlock)
193
def peek_lock_mode(self):
194
"""Return lock mode for the Branch: 'r', 'w' or None"""
195
raise NotImplementedError(self.peek_lock_mode)
197
def get_physical_lock_status(self):
198
raise NotImplementedError(self.get_physical_lock_status)
201
def get_revision_id_to_revno_map(self):
202
"""Return the revision_id => dotted revno map.
204
This will be regenerated on demand, but will be cached.
206
:return: A dictionary mapping revision_id => dotted revno.
207
This dictionary should not be modified by the caller.
209
if self._revision_id_to_revno_cache is not None:
210
mapping = self._revision_id_to_revno_cache
212
mapping = self._gen_revno_map()
213
self._cache_revision_id_to_revno(mapping)
214
# TODO: jam 20070417 Since this is being cached, should we be returning
216
# I would rather not, and instead just declare that users should not
217
# modify the return value.
220
def _gen_revno_map(self):
221
"""Create a new mapping from revision ids to dotted revnos.
223
Dotted revnos are generated based on the current tip in the revision
225
This is the worker function for get_revision_id_to_revno_map, which
226
just caches the return value.
228
:return: A dictionary mapping revision_id => dotted revno.
230
last_revision = self.last_revision()
231
revision_graph = self.repository.get_revision_graph(last_revision)
232
merge_sorted_revisions = tsort.merge_sort(
237
revision_id_to_revno = dict((rev_id, revno)
238
for seq_num, rev_id, depth, revno, end_of_merge
239
in merge_sorted_revisions)
240
return revision_id_to_revno
242
def leave_lock_in_place(self):
243
"""Tell this branch object not to release the physical lock when this
246
If lock_write doesn't return a token, then this method is not supported.
248
self.control_files.leave_in_place()
250
def dont_leave_lock_in_place(self):
251
"""Tell this branch object to release the physical lock when this
252
object is unlocked, even if it didn't originally acquire it.
254
If lock_write doesn't return a token, then this method is not supported.
256
self.control_files.dont_leave_in_place()
258
def abspath(self, name):
259
"""Return absolute filename for something in the branch
261
XXX: Robert Collins 20051017 what is this used for? why is it a branch
262
method and not a tree method.
264
raise NotImplementedError(self.abspath)
266
def bind(self, other):
267
"""Bind the local branch the other branch.
269
:param other: The branch to bind to
272
raise errors.UpgradeRequired(self.base)
275
def fetch(self, from_branch, last_revision=None, pb=None):
276
"""Copy revisions from from_branch into this branch.
278
:param from_branch: Where to copy from.
279
:param last_revision: What revision to stop at (None for at the end
281
:param pb: An optional progress bar to use.
283
Returns the copied revision count and the failed revisions in a tuple:
286
if self.base == from_branch.base:
289
nested_pb = ui.ui_factory.nested_progress_bar()
294
from_branch.lock_read()
296
if last_revision is None:
297
pb.update('get source history')
298
last_revision = from_branch.last_revision()
299
if last_revision is None:
300
last_revision = _mod_revision.NULL_REVISION
301
return self.repository.fetch(from_branch.repository,
302
revision_id=last_revision,
305
if nested_pb is not None:
309
def get_bound_location(self):
310
"""Return the URL of the branch we are bound to.
312
Older format branches cannot bind, please be sure to use a metadir
317
def get_old_bound_location(self):
318
"""Return the URL of the branch we used to be bound to
320
raise errors.UpgradeRequired(self.base)
322
def get_commit_builder(self, parents, config=None, timestamp=None,
323
timezone=None, committer=None, revprops=None,
325
"""Obtain a CommitBuilder for this branch.
327
:param parents: Revision ids of the parents of the new revision.
328
:param config: Optional configuration to use.
329
:param timestamp: Optional timestamp recorded for commit.
330
:param timezone: Optional timezone for timestamp.
331
:param committer: Optional committer to set for commit.
332
:param revprops: Optional dictionary of revision properties.
333
:param revision_id: Optional revision id.
337
config = self.get_config()
339
return self.repository.get_commit_builder(self, parents, config,
340
timestamp, timezone, committer, revprops, revision_id)
342
def get_master_branch(self):
343
"""Return the branch we are bound to.
345
:return: Either a Branch, or None
349
def get_revision_delta(self, revno):
350
"""Return the delta for one revision.
352
The delta is relative to its mainline predecessor, or the
353
empty tree for revision 1.
355
assert isinstance(revno, int)
356
rh = self.revision_history()
357
if not (1 <= revno <= len(rh)):
358
raise InvalidRevisionNumber(revno)
359
return self.repository.get_revision_delta(rh[revno-1])
361
@deprecated_method(zero_sixteen)
362
def get_root_id(self):
363
"""Return the id of this branches root
365
Deprecated: branches don't have root ids-- trees do.
366
Use basis_tree().get_root_id() instead.
368
raise NotImplementedError(self.get_root_id)
370
def print_file(self, file, revision_id):
371
"""Print `file` to stdout."""
372
raise NotImplementedError(self.print_file)
374
def append_revision(self, *revision_ids):
375
raise NotImplementedError(self.append_revision)
377
def set_revision_history(self, rev_history):
378
raise NotImplementedError(self.set_revision_history)
380
def _cache_revision_history(self, rev_history):
381
"""Set the cached revision history to rev_history.
383
The revision_history method will use this cache to avoid regenerating
384
the revision history.
386
This API is semi-public; it only for use by subclasses, all other code
387
should consider it to be private.
389
self._revision_history_cache = rev_history
391
def _cache_revision_id_to_revno(self, revision_id_to_revno):
392
"""Set the cached revision_id => revno map to revision_id_to_revno.
394
This API is semi-public; it only for use by subclasses, all other code
395
should consider it to be private.
397
self._revision_id_to_revno_cache = revision_id_to_revno
399
def _clear_cached_state(self):
400
"""Clear any cached data on this branch, e.g. cached revision history.
402
This means the next call to revision_history will need to call
403
_gen_revision_history.
405
This API is semi-public; it only for use by subclasses, all other code
406
should consider it to be private.
408
self._revision_history_cache = None
409
self._revision_id_to_revno_cache = None
411
def _gen_revision_history(self):
412
"""Return sequence of revision hashes on to this branch.
414
Unlike revision_history, this method always regenerates or rereads the
415
revision history, i.e. it does not cache the result, so repeated calls
418
Concrete subclasses should override this instead of revision_history so
419
that subclasses do not need to deal with caching logic.
421
This API is semi-public; it only for use by subclasses, all other code
422
should consider it to be private.
424
raise NotImplementedError(self._gen_revision_history)
427
def revision_history(self):
428
"""Return sequence of revision hashes on to this branch.
430
This method will cache the revision history for as long as it is safe to
433
if self._revision_history_cache is not None:
434
history = self._revision_history_cache
436
history = self._gen_revision_history()
437
self._cache_revision_history(history)
441
"""Return current revision number for this branch.
443
That is equivalent to the number of revisions committed to
446
return len(self.revision_history())
449
"""Older format branches cannot bind or unbind."""
450
raise errors.UpgradeRequired(self.base)
452
def set_append_revisions_only(self, enabled):
453
"""Older format branches are never restricted to append-only"""
454
raise errors.UpgradeRequired(self.base)
456
def last_revision(self):
457
"""Return last revision id, or None"""
458
ph = self.revision_history()
464
def last_revision_info(self):
465
"""Return information about the last revision.
467
:return: A tuple (revno, last_revision_id).
469
rh = self.revision_history()
472
return (revno, rh[-1])
474
return (0, _mod_revision.NULL_REVISION)
476
def missing_revisions(self, other, stop_revision=None):
477
"""Return a list of new revisions that would perfectly fit.
479
If self and other have not diverged, return a list of the revisions
480
present in other, but missing from self.
482
self_history = self.revision_history()
483
self_len = len(self_history)
484
other_history = other.revision_history()
485
other_len = len(other_history)
486
common_index = min(self_len, other_len) -1
487
if common_index >= 0 and \
488
self_history[common_index] != other_history[common_index]:
489
raise DivergedBranches(self, other)
491
if stop_revision is None:
492
stop_revision = other_len
494
assert isinstance(stop_revision, int)
495
if stop_revision > other_len:
496
raise errors.NoSuchRevision(self, stop_revision)
497
return other_history[self_len:stop_revision]
499
def update_revisions(self, other, stop_revision=None):
500
"""Pull in new perfect-fit revisions.
502
:param other: Another Branch to pull from
503
:param stop_revision: Updated until the given revision
506
raise NotImplementedError(self.update_revisions)
508
def revision_id_to_revno(self, revision_id):
509
"""Given a revision id, return its revno"""
510
if revision_id is None:
512
revision_id = osutils.safe_revision_id(revision_id)
513
history = self.revision_history()
515
return history.index(revision_id) + 1
517
raise errors.NoSuchRevision(self, revision_id)
519
def get_rev_id(self, revno, history=None):
520
"""Find the revision id of the specified revno."""
524
history = self.revision_history()
525
if revno <= 0 or revno > len(history):
526
raise errors.NoSuchRevision(self, revno)
527
return history[revno - 1]
529
def pull(self, source, overwrite=False, stop_revision=None):
530
"""Mirror source into this branch.
532
This branch is considered to be 'local', having low latency.
534
:returns: PullResult instance
536
raise NotImplementedError(self.pull)
538
def push(self, target, overwrite=False, stop_revision=None):
539
"""Mirror this branch into target.
541
This branch is considered to be 'local', having low latency.
543
raise NotImplementedError(self.push)
545
def basis_tree(self):
546
"""Return `Tree` object for last revision."""
547
return self.repository.revision_tree(self.last_revision())
549
def rename_one(self, from_rel, to_rel):
552
This can change the directory or the filename or both.
554
raise NotImplementedError(self.rename_one)
556
def move(self, from_paths, to_name):
559
to_name must exist as a versioned directory.
561
If to_name exists and is a directory, the files are moved into
562
it, keeping their old names. If it is a directory,
564
Note that to_name is only the last component of the new name;
565
this doesn't change the directory.
567
This returns a list of (from_path, to_path) pairs for each
570
raise NotImplementedError(self.move)
572
def get_parent(self):
573
"""Return the parent location of the branch.
575
This is the default location for push/pull/missing. The usual
576
pattern is that the user can override it by specifying a
579
raise NotImplementedError(self.get_parent)
581
def _set_config_location(self, name, url, config=None,
582
make_relative=False):
584
config = self.get_config()
588
url = urlutils.relative_url(self.base, url)
589
config.set_user_option(name, url)
591
def _get_config_location(self, name, config=None):
593
config = self.get_config()
594
location = config.get_user_option(name)
599
def get_submit_branch(self):
600
"""Return the submit location of the branch.
602
This is the default location for bundle. The usual
603
pattern is that the user can override it by specifying a
606
return self.get_config().get_user_option('submit_branch')
608
def set_submit_branch(self, location):
609
"""Return the submit location of the branch.
611
This is the default location for bundle. The usual
612
pattern is that the user can override it by specifying a
615
self.get_config().set_user_option('submit_branch', location)
617
def get_public_branch(self):
618
"""Return the public location of the branch.
620
This is is used by merge directives.
622
return self._get_config_location('public_branch')
624
def set_public_branch(self, location):
625
"""Return the submit location of the branch.
627
This is the default location for bundle. The usual
628
pattern is that the user can override it by specifying a
631
self._set_config_location('public_branch', location)
633
def get_push_location(self):
634
"""Return the None or the location to push this branch to."""
635
push_loc = self.get_config().get_user_option('push_location')
638
def set_push_location(self, location):
639
"""Set a new push location for this branch."""
640
raise NotImplementedError(self.set_push_location)
642
def set_parent(self, url):
643
raise NotImplementedError(self.set_parent)
647
"""Synchronise this branch with the master branch if any.
649
:return: None or the last_revision pivoted out during the update.
653
def check_revno(self, revno):
655
Check whether a revno corresponds to any revision.
656
Zero (the NULL revision) is considered valid.
659
self.check_real_revno(revno)
661
def check_real_revno(self, revno):
663
Check whether a revno corresponds to a real revision.
664
Zero (the NULL revision) is considered invalid
666
if revno < 1 or revno > self.revno():
667
raise InvalidRevisionNumber(revno)
670
def clone(self, to_bzrdir, revision_id=None):
671
"""Clone this branch into to_bzrdir preserving all semantic values.
673
revision_id: if not None, the revision history in the new branch will
674
be truncated to end with revision_id.
676
result = self._format.initialize(to_bzrdir)
677
self.copy_content_into(result, revision_id=revision_id)
681
def sprout(self, to_bzrdir, revision_id=None):
682
"""Create a new line of development from the branch, into to_bzrdir.
684
revision_id: if not None, the revision history in the new branch will
685
be truncated to end with revision_id.
687
result = self._format.initialize(to_bzrdir)
688
self.copy_content_into(result, revision_id=revision_id)
689
result.set_parent(self.bzrdir.root_transport.base)
692
def _synchronize_history(self, destination, revision_id):
693
"""Synchronize last revision and revision history between branches.
695
This version is most efficient when the destination is also a
696
BzrBranch5, but works for BzrBranch6 as long as the revision
697
history is the true lefthand parent history, and all of the revisions
698
are in the destination's repository. If not, set_revision_history
701
:param destination: The branch to copy the history into
702
:param revision_id: The revision-id to truncate history at. May
703
be None to copy complete history.
705
new_history = self.revision_history()
706
if revision_id is not None:
707
revision_id = osutils.safe_revision_id(revision_id)
709
new_history = new_history[:new_history.index(revision_id) + 1]
711
rev = self.repository.get_revision(revision_id)
712
new_history = rev.get_history(self.repository)[1:]
713
destination.set_revision_history(new_history)
716
def copy_content_into(self, destination, revision_id=None):
717
"""Copy the content of self into destination.
719
revision_id: if not None, the revision history in the new branch will
720
be truncated to end with revision_id.
722
self._synchronize_history(destination, revision_id)
724
parent = self.get_parent()
725
except errors.InaccessibleParent, e:
726
mutter('parent was not accessible to copy: %s', e)
729
destination.set_parent(parent)
730
self.tags.merge_to(destination.tags)
734
"""Check consistency of the branch.
736
In particular this checks that revisions given in the revision-history
737
do actually match up in the revision graph, and that they're all
738
present in the repository.
740
Callers will typically also want to check the repository.
742
:return: A BranchCheckResult.
744
mainline_parent_id = None
745
for revision_id in self.revision_history():
747
revision = self.repository.get_revision(revision_id)
748
except errors.NoSuchRevision, e:
749
raise errors.BzrCheckError("mainline revision {%s} not in repository"
751
# In general the first entry on the revision history has no parents.
752
# But it's not illegal for it to have parents listed; this can happen
753
# in imports from Arch when the parents weren't reachable.
754
if mainline_parent_id is not None:
755
if mainline_parent_id not in revision.parent_ids:
756
raise errors.BzrCheckError("previous revision {%s} not listed among "
758
% (mainline_parent_id, revision_id))
759
mainline_parent_id = revision_id
760
return BranchCheckResult(self)
762
def _get_checkout_format(self):
763
"""Return the most suitable metadir for a checkout of this branch.
764
Weaves are used if this branch's repository uses weaves.
766
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
767
from bzrlib.repofmt import weaverepo
768
format = bzrdir.BzrDirMetaFormat1()
769
format.repository_format = weaverepo.RepositoryFormat7()
771
format = self.repository.bzrdir.checkout_metadir()
772
format.set_branch_format(self._format)
775
def create_checkout(self, to_location, revision_id=None,
777
"""Create a checkout of a branch.
779
:param to_location: The url to produce the checkout at
780
:param revision_id: The revision to check out
781
:param lightweight: If True, produce a lightweight checkout, otherwise,
782
produce a bound branch (heavyweight checkout)
783
:return: The tree of the created checkout
785
t = transport.get_transport(to_location)
788
format = self._get_checkout_format()
789
checkout = format.initialize_on_transport(t)
790
BranchReferenceFormat().initialize(checkout, self)
792
format = self._get_checkout_format()
793
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
794
to_location, force_new_tree=False, format=format)
795
checkout = checkout_branch.bzrdir
796
checkout_branch.bind(self)
797
# pull up to the specified revision_id to set the initial
798
# branch tip correctly, and seed it with history.
799
checkout_branch.pull(self, stop_revision=revision_id)
800
tree = checkout.create_workingtree(revision_id)
801
basis_tree = tree.basis_tree()
802
basis_tree.lock_read()
804
for path, file_id in basis_tree.iter_references():
805
reference_parent = self.reference_parent(file_id, path)
806
reference_parent.create_checkout(tree.abspath(path),
807
basis_tree.get_reference_revision(file_id, path),
813
def reference_parent(self, file_id, path):
814
"""Return the parent branch for a tree-reference file_id
815
:param file_id: The file_id of the tree reference
816
:param path: The path of the file_id in the tree
817
:return: A branch associated with the file_id
819
# FIXME should provide multiple branches, based on config
820
return Branch.open(self.bzrdir.root_transport.clone(path).base)
822
def supports_tags(self):
823
return self._format.supports_tags()
826
class BranchFormat(object):
827
"""An encapsulation of the initialization and open routines for a format.
829
Formats provide three things:
830
* An initialization routine,
834
Formats are placed in an dict by their format string for reference
835
during branch opening. Its not required that these be instances, they
836
can be classes themselves with class methods - it simply depends on
837
whether state is needed for a given format or not.
839
Once a format is deprecated, just deprecate the initialize and open
840
methods on the format class. Do not deprecate the object, as the
841
object will be created every time regardless.
844
_default_format = None
845
"""The default format used for new branches."""
848
"""The known formats."""
851
def find_format(klass, a_bzrdir):
852
"""Return the format for the branch object in a_bzrdir."""
854
transport = a_bzrdir.get_branch_transport(None)
855
format_string = transport.get("format").read()
856
return klass._formats[format_string]
858
raise NotBranchError(path=transport.base)
860
raise errors.UnknownFormatError(format=format_string)
863
def get_default_format(klass):
864
"""Return the current default format."""
865
return klass._default_format
867
def get_reference(self, a_bzrdir):
868
"""Get the target reference of the branch in a_bzrdir.
870
format probing must have been completed before calling
871
this method - it is assumed that the format of the branch
872
in a_bzrdir is correct.
874
:param a_bzrdir: The bzrdir to get the branch data from.
875
:return: None if the branch is not a reference branch.
879
def get_format_string(self):
880
"""Return the ASCII format string that identifies this format."""
881
raise NotImplementedError(self.get_format_string)
883
def get_format_description(self):
884
"""Return the short format description for this format."""
885
raise NotImplementedError(self.get_format_description)
887
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
889
"""Initialize a branch in a bzrdir, with specified files
891
:param a_bzrdir: The bzrdir to initialize the branch in
892
:param utf8_files: The files to create as a list of
893
(filename, content) tuples
894
:param set_format: If True, set the format with
895
self.get_format_string. (BzrBranch4 has its format set
897
:return: a branch in this format
899
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
900
branch_transport = a_bzrdir.get_branch_transport(self)
902
'metadir': ('lock', lockdir.LockDir),
903
'branch4': ('branch-lock', lockable_files.TransportLock),
905
lock_name, lock_class = lock_map[lock_type]
906
control_files = lockable_files.LockableFiles(branch_transport,
907
lock_name, lock_class)
908
control_files.create_lock()
909
control_files.lock_write()
911
control_files.put_utf8('format', self.get_format_string())
913
for file, content in utf8_files:
914
control_files.put_utf8(file, content)
916
control_files.unlock()
917
return self.open(a_bzrdir, _found=True)
919
def initialize(self, a_bzrdir):
920
"""Create a branch of this format in a_bzrdir."""
921
raise NotImplementedError(self.initialize)
923
def is_supported(self):
924
"""Is this format supported?
926
Supported formats can be initialized and opened.
927
Unsupported formats may not support initialization or committing or
928
some other features depending on the reason for not being supported.
932
def open(self, a_bzrdir, _found=False):
933
"""Return the branch object for a_bzrdir
935
_found is a private parameter, do not use it. It is used to indicate
936
if format probing has already be done.
938
raise NotImplementedError(self.open)
941
def register_format(klass, format):
942
klass._formats[format.get_format_string()] = format
945
def set_default_format(klass, format):
946
klass._default_format = format
949
def unregister_format(klass, format):
950
assert klass._formats[format.get_format_string()] is format
951
del klass._formats[format.get_format_string()]
954
return self.get_format_string().rstrip()
956
def supports_tags(self):
957
"""True if this format supports tags stored in the branch"""
958
return False # by default
960
# XXX: Probably doesn't really belong here -- mbp 20070212
961
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
963
branch_transport = a_bzrdir.get_branch_transport(self)
964
control_files = lockable_files.LockableFiles(branch_transport,
965
lock_filename, lock_class)
966
control_files.create_lock()
967
control_files.lock_write()
969
for filename, content in utf8_files:
970
control_files.put_utf8(filename, content)
972
control_files.unlock()
975
class BranchHooks(Hooks):
976
"""A dictionary mapping hook name to a list of callables for branch hooks.
978
e.g. ['set_rh'] Is the list of items to be called when the
979
set_revision_history function is invoked.
983
"""Create the default hooks.
985
These are all empty initially, because by default nothing should get
989
# Introduced in 0.15:
990
# invoked whenever the revision history has been set
991
# with set_revision_history. The api signature is
992
# (branch, revision_history), and the branch will
995
# invoked after a push operation completes.
996
# the api signature is
998
# containing the members
999
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1000
# where local is the local target branch or None, master is the target
1001
# master branch, and the rest should be self explanatory. The source
1002
# is read locked and the target branches write locked. Source will
1003
# be the local low-latency branch.
1004
self['post_push'] = []
1005
# invoked after a pull operation completes.
1006
# the api signature is
1008
# containing the members
1009
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1010
# where local is the local branch or None, master is the target
1011
# master branch, and the rest should be self explanatory. The source
1012
# is read locked and the target branches write locked. The local
1013
# branch is the low-latency branch.
1014
self['post_pull'] = []
1015
# invoked after a commit operation completes.
1016
# the api signature is
1017
# (local, master, old_revno, old_revid, new_revno, new_revid)
1018
# old_revid is NULL_REVISION for the first commit to a branch.
1019
self['post_commit'] = []
1020
# invoked after a uncommit operation completes.
1021
# the api signature is
1022
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1023
# local is the local branch or None, master is the target branch,
1024
# and an empty branch recieves new_revno of 0, new_revid of None.
1025
self['post_uncommit'] = []
1028
# install the default hooks into the Branch class.
1029
Branch.hooks = BranchHooks()
1032
class BzrBranchFormat4(BranchFormat):
1033
"""Bzr branch format 4.
1036
- a revision-history file.
1037
- a branch-lock lock file [ to be shared with the bzrdir ]
1040
def get_format_description(self):
1041
"""See BranchFormat.get_format_description()."""
1042
return "Branch format 4"
1044
def initialize(self, a_bzrdir):
1045
"""Create a branch of this format in a_bzrdir."""
1046
utf8_files = [('revision-history', ''),
1047
('branch-name', ''),
1049
return self._initialize_helper(a_bzrdir, utf8_files,
1050
lock_type='branch4', set_format=False)
1053
super(BzrBranchFormat4, self).__init__()
1054
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1056
def open(self, a_bzrdir, _found=False):
1057
"""Return the branch object for a_bzrdir
1059
_found is a private parameter, do not use it. It is used to indicate
1060
if format probing has already be done.
1063
# we are being called directly and must probe.
1064
raise NotImplementedError
1065
return BzrBranch(_format=self,
1066
_control_files=a_bzrdir._control_files,
1068
_repository=a_bzrdir.open_repository())
1071
return "Bazaar-NG branch format 4"
1074
class BzrBranchFormat5(BranchFormat):
1075
"""Bzr branch format 5.
1078
- a revision-history file.
1080
- a lock dir guarding the branch itself
1081
- all of this stored in a branch/ subdirectory
1082
- works with shared repositories.
1084
This format is new in bzr 0.8.
1087
def get_format_string(self):
1088
"""See BranchFormat.get_format_string()."""
1089
return "Bazaar-NG branch format 5\n"
1091
def get_format_description(self):
1092
"""See BranchFormat.get_format_description()."""
1093
return "Branch format 5"
1095
def initialize(self, a_bzrdir):
1096
"""Create a branch of this format in a_bzrdir."""
1097
utf8_files = [('revision-history', ''),
1098
('branch-name', ''),
1100
return self._initialize_helper(a_bzrdir, utf8_files)
1103
super(BzrBranchFormat5, self).__init__()
1104
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1106
def open(self, a_bzrdir, _found=False):
1107
"""Return the branch object for a_bzrdir
1109
_found is a private parameter, do not use it. It is used to indicate
1110
if format probing has already be done.
1113
format = BranchFormat.find_format(a_bzrdir)
1114
assert format.__class__ == self.__class__
1116
transport = a_bzrdir.get_branch_transport(None)
1117
control_files = lockable_files.LockableFiles(transport, 'lock',
1119
return BzrBranch5(_format=self,
1120
_control_files=control_files,
1122
_repository=a_bzrdir.find_repository())
1124
raise NotBranchError(path=transport.base)
1127
class BzrBranchFormat6(BzrBranchFormat5):
1128
"""Branch format with last-revision
1130
Unlike previous formats, this has no explicit revision history. Instead,
1131
this just stores the last-revision, and the left-hand history leading
1132
up to there is the history.
1134
This format was introduced in bzr 0.15
1137
def get_format_string(self):
1138
"""See BranchFormat.get_format_string()."""
1139
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1141
def get_format_description(self):
1142
"""See BranchFormat.get_format_description()."""
1143
return "Branch format 6"
1145
def initialize(self, a_bzrdir):
1146
"""Create a branch of this format in a_bzrdir."""
1147
utf8_files = [('last-revision', '0 null:\n'),
1148
('branch-name', ''),
1149
('branch.conf', ''),
1152
return self._initialize_helper(a_bzrdir, utf8_files)
1154
def open(self, a_bzrdir, _found=False):
1155
"""Return the branch object for a_bzrdir
1157
_found is a private parameter, do not use it. It is used to indicate
1158
if format probing has already be done.
1161
format = BranchFormat.find_format(a_bzrdir)
1162
assert format.__class__ == self.__class__
1163
transport = a_bzrdir.get_branch_transport(None)
1164
control_files = lockable_files.LockableFiles(transport, 'lock',
1166
return BzrBranch6(_format=self,
1167
_control_files=control_files,
1169
_repository=a_bzrdir.find_repository())
1171
def supports_tags(self):
1175
class BranchReferenceFormat(BranchFormat):
1176
"""Bzr branch reference format.
1178
Branch references are used in implementing checkouts, they
1179
act as an alias to the real branch which is at some other url.
1186
def get_format_string(self):
1187
"""See BranchFormat.get_format_string()."""
1188
return "Bazaar-NG Branch Reference Format 1\n"
1190
def get_format_description(self):
1191
"""See BranchFormat.get_format_description()."""
1192
return "Checkout reference format 1"
1194
def get_reference(self, a_bzrdir):
1195
"""See BranchFormat.get_reference()."""
1196
transport = a_bzrdir.get_branch_transport(None)
1197
return transport.get('location').read()
1199
def initialize(self, a_bzrdir, target_branch=None):
1200
"""Create a branch of this format in a_bzrdir."""
1201
if target_branch is None:
1202
# this format does not implement branch itself, thus the implicit
1203
# creation contract must see it as uninitializable
1204
raise errors.UninitializableFormat(self)
1205
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1206
branch_transport = a_bzrdir.get_branch_transport(self)
1207
branch_transport.put_bytes('location',
1208
target_branch.bzrdir.root_transport.base)
1209
branch_transport.put_bytes('format', self.get_format_string())
1210
return self.open(a_bzrdir, _found=True)
1213
super(BranchReferenceFormat, self).__init__()
1214
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1216
def _make_reference_clone_function(format, a_branch):
1217
"""Create a clone() routine for a branch dynamically."""
1218
def clone(to_bzrdir, revision_id=None):
1219
"""See Branch.clone()."""
1220
return format.initialize(to_bzrdir, a_branch)
1221
# cannot obey revision_id limits when cloning a reference ...
1222
# FIXME RBC 20060210 either nuke revision_id for clone, or
1223
# emit some sort of warning/error to the caller ?!
1226
def open(self, a_bzrdir, _found=False, location=None):
1227
"""Return the branch that the branch reference in a_bzrdir points at.
1229
_found is a private parameter, do not use it. It is used to indicate
1230
if format probing has already be done.
1233
format = BranchFormat.find_format(a_bzrdir)
1234
assert format.__class__ == self.__class__
1235
if location is None:
1236
location = self.get_reference(a_bzrdir)
1237
real_bzrdir = bzrdir.BzrDir.open(location)
1238
result = real_bzrdir.open_branch()
1239
# this changes the behaviour of result.clone to create a new reference
1240
# rather than a copy of the content of the branch.
1241
# I did not use a proxy object because that needs much more extensive
1242
# testing, and we are only changing one behaviour at the moment.
1243
# If we decide to alter more behaviours - i.e. the implicit nickname
1244
# then this should be refactored to introduce a tested proxy branch
1245
# and a subclass of that for use in overriding clone() and ....
1247
result.clone = self._make_reference_clone_function(result)
1251
# formats which have no format string are not discoverable
1252
# and not independently creatable, so are not registered.
1253
__default_format = BzrBranchFormat5()
1254
BranchFormat.register_format(__default_format)
1255
BranchFormat.register_format(BranchReferenceFormat())
1256
BranchFormat.register_format(BzrBranchFormat6())
1257
BranchFormat.set_default_format(__default_format)
1258
_legacy_formats = [BzrBranchFormat4(),
1261
class BzrBranch(Branch):
1262
"""A branch stored in the actual filesystem.
1264
Note that it's "local" in the context of the filesystem; it doesn't
1265
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1266
it's writable, and can be accessed via the normal filesystem API.
1269
def __init__(self, _format=None,
1270
_control_files=None, a_bzrdir=None, _repository=None):
1271
"""Create new branch object at a particular location."""
1272
Branch.__init__(self)
1273
if a_bzrdir is None:
1274
raise ValueError('a_bzrdir must be supplied')
1276
self.bzrdir = a_bzrdir
1277
# self._transport used to point to the directory containing the
1278
# control directory, but was not used - now it's just the transport
1279
# for the branch control files. mbp 20070212
1280
self._base = self.bzrdir.transport.clone('..').base
1281
self._format = _format
1282
if _control_files is None:
1283
raise ValueError('BzrBranch _control_files is None')
1284
self.control_files = _control_files
1285
self._transport = _control_files._transport
1286
self.repository = _repository
1289
return '%s(%r)' % (self.__class__.__name__, self.base)
1293
def _get_base(self):
1294
"""Returns the directory containing the control directory."""
1297
base = property(_get_base, doc="The URL for the root of this branch.")
1299
def abspath(self, name):
1300
"""See Branch.abspath."""
1301
return self.control_files._transport.abspath(name)
1304
@deprecated_method(zero_sixteen)
1306
def get_root_id(self):
1307
"""See Branch.get_root_id."""
1308
tree = self.repository.revision_tree(self.last_revision())
1309
return tree.inventory.root.file_id
1311
def is_locked(self):
1312
return self.control_files.is_locked()
1314
def lock_write(self, token=None):
1315
repo_token = self.repository.lock_write()
1317
token = self.control_files.lock_write(token=token)
1319
self.repository.unlock()
1323
def lock_read(self):
1324
self.repository.lock_read()
1326
self.control_files.lock_read()
1328
self.repository.unlock()
1332
# TODO: test for failed two phase locks. This is known broken.
1334
self.control_files.unlock()
1336
self.repository.unlock()
1337
if not self.control_files.is_locked():
1338
# we just released the lock
1339
self._clear_cached_state()
1341
def peek_lock_mode(self):
1342
if self.control_files._lock_count == 0:
1345
return self.control_files._lock_mode
1347
def get_physical_lock_status(self):
1348
return self.control_files.get_physical_lock_status()
1351
def print_file(self, file, revision_id):
1352
"""See Branch.print_file."""
1353
return self.repository.print_file(file, revision_id)
1356
def append_revision(self, *revision_ids):
1357
"""See Branch.append_revision."""
1358
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1359
for revision_id in revision_ids:
1360
_mod_revision.check_not_reserved_id(revision_id)
1361
mutter("add {%s} to revision-history" % revision_id)
1362
rev_history = self.revision_history()
1363
rev_history.extend(revision_ids)
1364
self.set_revision_history(rev_history)
1366
def _write_revision_history(self, history):
1367
"""Factored out of set_revision_history.
1369
This performs the actual writing to disk.
1370
It is intended to be called by BzrBranch5.set_revision_history."""
1371
self.control_files.put_bytes(
1372
'revision-history', '\n'.join(history))
1375
def set_revision_history(self, rev_history):
1376
"""See Branch.set_revision_history."""
1377
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1378
self._clear_cached_state()
1379
self._write_revision_history(rev_history)
1380
self._cache_revision_history(rev_history)
1381
for hook in Branch.hooks['set_rh']:
1382
hook(self, rev_history)
1385
def set_last_revision_info(self, revno, revision_id):
1386
revision_id = osutils.safe_revision_id(revision_id)
1387
history = self._lefthand_history(revision_id)
1388
assert len(history) == revno, '%d != %d' % (len(history), revno)
1389
self.set_revision_history(history)
1391
def _gen_revision_history(self):
1392
history = self.control_files.get('revision-history').read().split('\n')
1393
if history[-1:] == ['']:
1394
# There shouldn't be a trailing newline, but just in case.
1398
def _lefthand_history(self, revision_id, last_rev=None,
1400
# stop_revision must be a descendant of last_revision
1401
stop_graph = self.repository.get_revision_graph(revision_id)
1402
if last_rev is not None and last_rev not in stop_graph:
1403
# our previous tip is not merged into stop_revision
1404
raise errors.DivergedBranches(self, other_branch)
1405
# make a new revision history from the graph
1406
current_rev_id = revision_id
1408
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1409
new_history.append(current_rev_id)
1410
current_rev_id_parents = stop_graph[current_rev_id]
1412
current_rev_id = current_rev_id_parents[0]
1414
current_rev_id = None
1415
new_history.reverse()
1419
def generate_revision_history(self, revision_id, last_rev=None,
1421
"""Create a new revision history that will finish with revision_id.
1423
:param revision_id: the new tip to use.
1424
:param last_rev: The previous last_revision. If not None, then this
1425
must be a ancestory of revision_id, or DivergedBranches is raised.
1426
:param other_branch: The other branch that DivergedBranches should
1427
raise with respect to.
1429
revision_id = osutils.safe_revision_id(revision_id)
1430
self.set_revision_history(self._lefthand_history(revision_id,
1431
last_rev, other_branch))
1434
def update_revisions(self, other, stop_revision=None):
1435
"""See Branch.update_revisions."""
1438
if stop_revision is None:
1439
stop_revision = other.last_revision()
1440
if stop_revision is None:
1441
# if there are no commits, we're done.
1444
stop_revision = osutils.safe_revision_id(stop_revision)
1445
# whats the current last revision, before we fetch [and change it
1447
last_rev = self.last_revision()
1448
# we fetch here regardless of whether we need to so that we pickup
1450
self.fetch(other, stop_revision)
1451
my_ancestry = self.repository.get_ancestry(last_rev)
1452
if stop_revision in my_ancestry:
1453
# last_revision is a descendant of stop_revision
1455
self.generate_revision_history(stop_revision, last_rev=last_rev,
1460
def basis_tree(self):
1461
"""See Branch.basis_tree."""
1462
return self.repository.revision_tree(self.last_revision())
1464
@deprecated_method(zero_eight)
1465
def working_tree(self):
1466
"""Create a Working tree object for this branch."""
1468
from bzrlib.transport.local import LocalTransport
1469
if (self.base.find('://') != -1 or
1470
not isinstance(self._transport, LocalTransport)):
1471
raise NoWorkingTree(self.base)
1472
return self.bzrdir.open_workingtree()
1475
def pull(self, source, overwrite=False, stop_revision=None,
1476
_hook_master=None, run_hooks=True):
1479
:param _hook_master: Private parameter - set the branch to
1480
be supplied as the master to push hooks.
1481
:param run_hooks: Private parameter - if false, this branch
1482
is being called because it's the master of the primary branch,
1483
so it should not run its hooks.
1485
result = PullResult()
1486
result.source_branch = source
1487
result.target_branch = self
1490
result.old_revno, result.old_revid = self.last_revision_info()
1492
self.update_revisions(source, stop_revision)
1493
except DivergedBranches:
1497
if stop_revision is None:
1498
stop_revision = source.last_revision()
1499
self.generate_revision_history(stop_revision)
1500
result.tag_conflicts = source.tags.merge_to(self.tags)
1501
result.new_revno, result.new_revid = self.last_revision_info()
1503
result.master_branch = _hook_master
1504
result.local_branch = self
1506
result.master_branch = self
1507
result.local_branch = None
1509
for hook in Branch.hooks['post_pull']:
1515
def _get_parent_location(self):
1516
_locs = ['parent', 'pull', 'x-pull']
1519
return self.control_files.get(l).read().strip('\n')
1525
def push(self, target, overwrite=False, stop_revision=None,
1526
_override_hook_source_branch=None):
1529
This is the basic concrete implementation of push()
1531
:param _override_hook_source_branch: If specified, run
1532
the hooks passing this Branch as the source, rather than self.
1533
This is for use of RemoteBranch, where push is delegated to the
1534
underlying vfs-based Branch.
1536
# TODO: Public option to disable running hooks - should be trivial but
1540
result = self._push_with_bound_branches(target, overwrite,
1542
_override_hook_source_branch=_override_hook_source_branch)
1547
def _push_with_bound_branches(self, target, overwrite,
1549
_override_hook_source_branch=None):
1550
"""Push from self into target, and into target's master if any.
1552
This is on the base BzrBranch class even though it doesn't support
1553
bound branches because the *target* might be bound.
1556
if _override_hook_source_branch:
1557
result.source_branch = _override_hook_source_branch
1558
for hook in Branch.hooks['post_push']:
1561
bound_location = target.get_bound_location()
1562
if bound_location and target.base != bound_location:
1563
# there is a master branch.
1565
# XXX: Why the second check? Is it even supported for a branch to
1566
# be bound to itself? -- mbp 20070507
1567
master_branch = target.get_master_branch()
1568
master_branch.lock_write()
1570
# push into the master from this branch.
1571
self._basic_push(master_branch, overwrite, stop_revision)
1572
# and push into the target branch from this. Note that we push from
1573
# this branch again, because its considered the highest bandwidth
1575
result = self._basic_push(target, overwrite, stop_revision)
1576
result.master_branch = master_branch
1577
result.local_branch = target
1581
master_branch.unlock()
1584
result = self._basic_push(target, overwrite, stop_revision)
1585
# TODO: Why set master_branch and local_branch if there's no
1586
# binding? Maybe cleaner to just leave them unset? -- mbp
1588
result.master_branch = target
1589
result.local_branch = None
1593
def _basic_push(self, target, overwrite, stop_revision):
1594
"""Basic implementation of push without bound branches or hooks.
1596
Must be called with self read locked and target write locked.
1598
result = PushResult()
1599
result.source_branch = self
1600
result.target_branch = target
1601
result.old_revno, result.old_revid = target.last_revision_info()
1603
target.update_revisions(self, stop_revision)
1604
except DivergedBranches:
1608
target.set_revision_history(self.revision_history())
1609
result.tag_conflicts = self.tags.merge_to(target.tags)
1610
result.new_revno, result.new_revid = target.last_revision_info()
1613
def get_parent(self):
1614
"""See Branch.get_parent."""
1616
assert self.base[-1] == '/'
1617
parent = self._get_parent_location()
1620
# This is an old-format absolute path to a local branch
1621
# turn it into a url
1622
if parent.startswith('/'):
1623
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1625
return urlutils.join(self.base[:-1], parent)
1626
except errors.InvalidURLJoin, e:
1627
raise errors.InaccessibleParent(parent, self.base)
1629
def set_push_location(self, location):
1630
"""See Branch.set_push_location."""
1631
self.get_config().set_user_option(
1632
'push_location', location,
1633
store=_mod_config.STORE_LOCATION_NORECURSE)
1636
def set_parent(self, url):
1637
"""See Branch.set_parent."""
1638
# TODO: Maybe delete old location files?
1639
# URLs should never be unicode, even on the local fs,
1640
# FIXUP this and get_parent in a future branch format bump:
1641
# read and rewrite the file, and have the new format code read
1642
# using .get not .get_utf8. RBC 20060125
1644
if isinstance(url, unicode):
1646
url = url.encode('ascii')
1647
except UnicodeEncodeError:
1648
raise errors.InvalidURL(url,
1649
"Urls must be 7-bit ascii, "
1650
"use bzrlib.urlutils.escape")
1651
url = urlutils.relative_url(self.base, url)
1652
self._set_parent_location(url)
1654
def _set_parent_location(self, url):
1656
self.control_files._transport.delete('parent')
1658
assert isinstance(url, str)
1659
self.control_files.put_bytes('parent', url + '\n')
1661
@deprecated_function(zero_nine)
1662
def tree_config(self):
1663
"""DEPRECATED; call get_config instead.
1664
TreeConfig has become part of BranchConfig."""
1665
return TreeConfig(self)
1668
class BzrBranch5(BzrBranch):
1669
"""A format 5 branch. This supports new features over plan branches.
1671
It has support for a master_branch which is the data for bound branches.
1679
super(BzrBranch5, self).__init__(_format=_format,
1680
_control_files=_control_files,
1682
_repository=_repository)
1685
def pull(self, source, overwrite=False, stop_revision=None,
1687
"""Pull from source into self, updating my master if any.
1689
:param run_hooks: Private parameter - if false, this branch
1690
is being called because it's the master of the primary branch,
1691
so it should not run its hooks.
1693
bound_location = self.get_bound_location()
1694
master_branch = None
1695
if bound_location and source.base != bound_location:
1696
# not pulling from master, so we need to update master.
1697
master_branch = self.get_master_branch()
1698
master_branch.lock_write()
1701
# pull from source into master.
1702
master_branch.pull(source, overwrite, stop_revision,
1704
return super(BzrBranch5, self).pull(source, overwrite,
1705
stop_revision, _hook_master=master_branch,
1706
run_hooks=run_hooks)
1709
master_branch.unlock()
1711
def get_bound_location(self):
1713
return self.control_files.get_utf8('bound').read()[:-1]
1714
except errors.NoSuchFile:
1718
def get_master_branch(self):
1719
"""Return the branch we are bound to.
1721
:return: Either a Branch, or None
1723
This could memoise the branch, but if thats done
1724
it must be revalidated on each new lock.
1725
So for now we just don't memoise it.
1726
# RBC 20060304 review this decision.
1728
bound_loc = self.get_bound_location()
1732
return Branch.open(bound_loc)
1733
except (errors.NotBranchError, errors.ConnectionError), e:
1734
raise errors.BoundBranchConnectionFailure(
1738
def set_bound_location(self, location):
1739
"""Set the target where this branch is bound to.
1741
:param location: URL to the target branch
1744
self.control_files.put_utf8('bound', location+'\n')
1747
self.control_files._transport.delete('bound')
1753
def bind(self, other):
1754
"""Bind this branch to the branch other.
1756
This does not push or pull data between the branches, though it does
1757
check for divergence to raise an error when the branches are not
1758
either the same, or one a prefix of the other. That behaviour may not
1759
be useful, so that check may be removed in future.
1761
:param other: The branch to bind to
1764
# TODO: jam 20051230 Consider checking if the target is bound
1765
# It is debatable whether you should be able to bind to
1766
# a branch which is itself bound.
1767
# Committing is obviously forbidden,
1768
# but binding itself may not be.
1769
# Since we *have* to check at commit time, we don't
1770
# *need* to check here
1772
# we want to raise diverged if:
1773
# last_rev is not in the other_last_rev history, AND
1774
# other_last_rev is not in our history, and do it without pulling
1776
last_rev = self.last_revision()
1777
if last_rev is not None:
1780
other_last_rev = other.last_revision()
1781
if other_last_rev is not None:
1782
# neither branch is new, we have to do some work to
1783
# ascertain diversion.
1784
remote_graph = other.repository.get_revision_graph(
1786
local_graph = self.repository.get_revision_graph(last_rev)
1787
if (last_rev not in remote_graph and
1788
other_last_rev not in local_graph):
1789
raise errors.DivergedBranches(self, other)
1792
self.set_bound_location(other.base)
1796
"""If bound, unbind"""
1797
return self.set_bound_location(None)
1801
"""Synchronise this branch with the master branch if any.
1803
:return: None or the last_revision that was pivoted out during the
1806
master = self.get_master_branch()
1807
if master is not None:
1808
old_tip = self.last_revision()
1809
self.pull(master, overwrite=True)
1810
if old_tip in self.repository.get_ancestry(self.last_revision()):
1816
class BzrBranchExperimental(BzrBranch5):
1817
"""Bzr experimental branch format
1820
- a revision-history file.
1822
- a lock dir guarding the branch itself
1823
- all of this stored in a branch/ subdirectory
1824
- works with shared repositories.
1825
- a tag dictionary in the branch
1827
This format is new in bzr 0.15, but shouldn't be used for real data,
1830
This class acts as it's own BranchFormat.
1833
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1836
def get_format_string(cls):
1837
"""See BranchFormat.get_format_string()."""
1838
return "Bazaar-NG branch format experimental\n"
1841
def get_format_description(cls):
1842
"""See BranchFormat.get_format_description()."""
1843
return "Experimental branch format"
1846
def get_reference(cls, a_bzrdir):
1847
"""Get the target reference of the branch in a_bzrdir.
1849
format probing must have been completed before calling
1850
this method - it is assumed that the format of the branch
1851
in a_bzrdir is correct.
1853
:param a_bzrdir: The bzrdir to get the branch data from.
1854
:return: None if the branch is not a reference branch.
1859
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1861
branch_transport = a_bzrdir.get_branch_transport(cls)
1862
control_files = lockable_files.LockableFiles(branch_transport,
1863
lock_filename, lock_class)
1864
control_files.create_lock()
1865
control_files.lock_write()
1867
for filename, content in utf8_files:
1868
control_files.put_utf8(filename, content)
1870
control_files.unlock()
1873
def initialize(cls, a_bzrdir):
1874
"""Create a branch of this format in a_bzrdir."""
1875
utf8_files = [('format', cls.get_format_string()),
1876
('revision-history', ''),
1877
('branch-name', ''),
1880
cls._initialize_control_files(a_bzrdir, utf8_files,
1881
'lock', lockdir.LockDir)
1882
return cls.open(a_bzrdir, _found=True)
1885
def open(cls, a_bzrdir, _found=False):
1886
"""Return the branch object for a_bzrdir
1888
_found is a private parameter, do not use it. It is used to indicate
1889
if format probing has already be done.
1892
format = BranchFormat.find_format(a_bzrdir)
1893
assert format.__class__ == cls
1894
transport = a_bzrdir.get_branch_transport(None)
1895
control_files = lockable_files.LockableFiles(transport, 'lock',
1897
return cls(_format=cls,
1898
_control_files=control_files,
1900
_repository=a_bzrdir.find_repository())
1903
def is_supported(cls):
1906
def _make_tags(self):
1907
return BasicTags(self)
1910
def supports_tags(cls):
1914
BranchFormat.register_format(BzrBranchExperimental)
1917
class BzrBranch6(BzrBranch5):
1920
def last_revision_info(self):
1921
revision_string = self.control_files.get('last-revision').read()
1922
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1923
revision_id = cache_utf8.get_cached_utf8(revision_id)
1925
return revno, revision_id
1927
def last_revision(self):
1928
"""Return last revision id, or None"""
1929
revision_id = self.last_revision_info()[1]
1930
if revision_id == _mod_revision.NULL_REVISION:
1934
def _write_last_revision_info(self, revno, revision_id):
1935
"""Simply write out the revision id, with no checks.
1937
Use set_last_revision_info to perform this safely.
1939
Does not update the revision_history cache.
1940
Intended to be called by set_last_revision_info and
1941
_write_revision_history.
1943
if revision_id is None:
1944
revision_id = 'null:'
1945
out_string = '%d %s\n' % (revno, revision_id)
1946
self.control_files.put_bytes('last-revision', out_string)
1949
def set_last_revision_info(self, revno, revision_id):
1950
revision_id = osutils.safe_revision_id(revision_id)
1951
if self._get_append_revisions_only():
1952
self._check_history_violation(revision_id)
1953
self._write_last_revision_info(revno, revision_id)
1954
self._clear_cached_state()
1956
def _check_history_violation(self, revision_id):
1957
last_revision = self.last_revision()
1958
if last_revision is None:
1960
if last_revision not in self._lefthand_history(revision_id):
1961
raise errors.AppendRevisionsOnlyViolation(self.base)
1963
def _gen_revision_history(self):
1964
"""Generate the revision history from last revision
1966
history = list(self.repository.iter_reverse_revision_history(
1967
self.last_revision()))
1971
def _write_revision_history(self, history):
1972
"""Factored out of set_revision_history.
1974
This performs the actual writing to disk, with format-specific checks.
1975
It is intended to be called by BzrBranch5.set_revision_history.
1977
if len(history) == 0:
1978
last_revision = 'null:'
1980
if history != self._lefthand_history(history[-1]):
1981
raise errors.NotLefthandHistory(history)
1982
last_revision = history[-1]
1983
if self._get_append_revisions_only():
1984
self._check_history_violation(last_revision)
1985
self._write_last_revision_info(len(history), last_revision)
1988
def append_revision(self, *revision_ids):
1989
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1990
if len(revision_ids) == 0:
1992
prev_revno, prev_revision = self.last_revision_info()
1993
for revision in self.repository.get_revisions(revision_ids):
1994
if prev_revision == _mod_revision.NULL_REVISION:
1995
if revision.parent_ids != []:
1996
raise errors.NotLeftParentDescendant(self, prev_revision,
1997
revision.revision_id)
1999
if revision.parent_ids[0] != prev_revision:
2000
raise errors.NotLeftParentDescendant(self, prev_revision,
2001
revision.revision_id)
2002
prev_revision = revision.revision_id
2003
self.set_last_revision_info(prev_revno + len(revision_ids),
2007
def _set_parent_location(self, url):
2008
"""Set the parent branch"""
2009
self._set_config_location('parent_location', url, make_relative=True)
2012
def _get_parent_location(self):
2013
"""Set the parent branch"""
2014
return self._get_config_location('parent_location')
2016
def set_push_location(self, location):
2017
"""See Branch.set_push_location."""
2018
self._set_config_location('push_location', location)
2020
def set_bound_location(self, location):
2021
"""See Branch.set_push_location."""
2023
config = self.get_config()
2024
if location is None:
2025
if config.get_user_option('bound') != 'True':
2028
config.set_user_option('bound', 'False')
2031
self._set_config_location('bound_location', location,
2033
config.set_user_option('bound', 'True')
2036
def _get_bound_location(self, bound):
2037
"""Return the bound location in the config file.
2039
Return None if the bound parameter does not match"""
2040
config = self.get_config()
2041
config_bound = (config.get_user_option('bound') == 'True')
2042
if config_bound != bound:
2044
return self._get_config_location('bound_location', config=config)
2046
def get_bound_location(self):
2047
"""See Branch.set_push_location."""
2048
return self._get_bound_location(True)
2050
def get_old_bound_location(self):
2051
"""See Branch.get_old_bound_location"""
2052
return self._get_bound_location(False)
2054
def set_append_revisions_only(self, enabled):
2059
self.get_config().set_user_option('append_revisions_only', value)
2061
def _get_append_revisions_only(self):
2062
value = self.get_config().get_user_option('append_revisions_only')
2063
return value == 'True'
2065
def _synchronize_history(self, destination, revision_id):
2066
"""Synchronize last revision and revision history between branches.
2068
This version is most efficient when the destination is also a
2069
BzrBranch6, but works for BzrBranch5, as long as the destination's
2070
repository contains all the lefthand ancestors of the intended
2071
last_revision. If not, set_last_revision_info will fail.
2073
:param destination: The branch to copy the history into
2074
:param revision_id: The revision-id to truncate history at. May
2075
be None to copy complete history.
2077
if revision_id is None:
2078
revno, revision_id = self.last_revision_info()
2080
revno = self.revision_id_to_revno(revision_id)
2081
destination.set_last_revision_info(revno, revision_id)
2083
def _make_tags(self):
2084
return BasicTags(self)
2087
class BranchTestProviderAdapter(object):
2088
"""A tool to generate a suite testing multiple branch formats at once.
2090
This is done by copying the test once for each transport and injecting
2091
the transport_server, transport_readonly_server, and branch_format
2092
classes into each copy. Each copy is also given a new id() to make it
2096
def __init__(self, transport_server, transport_readonly_server, formats,
2097
vfs_transport_factory=None):
2098
self._transport_server = transport_server
2099
self._transport_readonly_server = transport_readonly_server
2100
self._formats = formats
2102
def adapt(self, test):
2103
result = TestSuite()
2104
for branch_format, bzrdir_format in self._formats:
2105
new_test = deepcopy(test)
2106
new_test.transport_server = self._transport_server
2107
new_test.transport_readonly_server = self._transport_readonly_server
2108
new_test.bzrdir_format = bzrdir_format
2109
new_test.branch_format = branch_format
2110
def make_new_test_id():
2111
# the format can be either a class or an instance
2112
name = getattr(branch_format, '__name__',
2113
branch_format.__class__.__name__)
2114
new_id = "%s(%s)" % (new_test.id(), name)
2115
return lambda: new_id
2116
new_test.id = make_new_test_id()
2117
result.addTest(new_test)
2121
######################################################################
2122
# results of operations
2125
class _Result(object):
2127
def _show_tag_conficts(self, to_file):
2128
if not getattr(self, 'tag_conflicts', None):
2130
to_file.write('Conflicting tags:\n')
2131
for name, value1, value2 in self.tag_conflicts:
2132
to_file.write(' %s\n' % (name, ))
2135
class PullResult(_Result):
2136
"""Result of a Branch.pull operation.
2138
:ivar old_revno: Revision number before pull.
2139
:ivar new_revno: Revision number after pull.
2140
:ivar old_revid: Tip revision id before pull.
2141
:ivar new_revid: Tip revision id after pull.
2142
:ivar source_branch: Source (local) branch object.
2143
:ivar master_branch: Master branch of the target, or None.
2144
:ivar target_branch: Target/destination branch object.
2148
# DEPRECATED: pull used to return the change in revno
2149
return self.new_revno - self.old_revno
2151
def report(self, to_file):
2152
if self.old_revid == self.new_revid:
2153
to_file.write('No revisions to pull.\n')
2155
to_file.write('Now on revision %d.\n' % self.new_revno)
2156
self._show_tag_conficts(to_file)
2159
class PushResult(_Result):
2160
"""Result of a Branch.push operation.
2162
:ivar old_revno: Revision number before push.
2163
:ivar new_revno: Revision number after push.
2164
:ivar old_revid: Tip revision id before push.
2165
:ivar new_revid: Tip revision id after push.
2166
:ivar source_branch: Source branch object.
2167
:ivar master_branch: Master branch of the target, or None.
2168
:ivar target_branch: Target/destination branch object.
2172
# DEPRECATED: push used to return the change in revno
2173
return self.new_revno - self.old_revno
2175
def report(self, to_file):
2176
"""Write a human-readable description of the result."""
2177
if self.old_revid == self.new_revid:
2178
to_file.write('No new revisions to push.\n')
2180
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2181
self._show_tag_conficts(to_file)
2184
class BranchCheckResult(object):
2185
"""Results of checking branch consistency.
2190
def __init__(self, branch):
2191
self.branch = branch
2193
def report_results(self, verbose):
2194
"""Report the check results via trace.note.
2196
:param verbose: Requests more detailed display of what was checked,
2199
note('checked branch %s format %s',
2201
self.branch._format)
2204
class Converter5to6(object):
2205
"""Perform an in-place upgrade of format 5 to format 6"""
2207
def convert(self, branch):
2208
# Data for 5 and 6 can peacefully coexist.
2209
format = BzrBranchFormat6()
2210
new_branch = format.open(branch.bzrdir, _found=True)
2212
# Copy source data into target
2213
new_branch.set_last_revision_info(*branch.last_revision_info())
2214
new_branch.set_parent(branch.get_parent())
2215
new_branch.set_bound_location(branch.get_bound_location())
2216
new_branch.set_push_location(branch.get_push_location())
2218
# New branch has no tags by default
2219
new_branch.tags._set_tag_dict({})
2221
# Copying done; now update target format
2222
new_branch.control_files.put_utf8('format',
2223
format.get_format_string())
2225
# Clean up old files
2226
new_branch.control_files._transport.delete('revision-history')
2228
branch.set_parent(None)
2231
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
