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
except errors.FileExists:
791
format = self._get_checkout_format()
792
checkout = format.initialize_on_transport(t)
793
BranchReferenceFormat().initialize(checkout, self)
795
format = self._get_checkout_format()
796
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
797
to_location, force_new_tree=False, format=format)
798
checkout = checkout_branch.bzrdir
799
checkout_branch.bind(self)
800
# pull up to the specified revision_id to set the initial
801
# branch tip correctly, and seed it with history.
802
checkout_branch.pull(self, stop_revision=revision_id)
803
tree = checkout.create_workingtree(revision_id)
804
basis_tree = tree.basis_tree()
805
basis_tree.lock_read()
807
for path, file_id in basis_tree.iter_references():
808
reference_parent = self.reference_parent(file_id, path)
809
reference_parent.create_checkout(tree.abspath(path),
810
basis_tree.get_reference_revision(file_id, path),
816
def reference_parent(self, file_id, path):
817
"""Return the parent branch for a tree-reference file_id
818
:param file_id: The file_id of the tree reference
819
:param path: The path of the file_id in the tree
820
:return: A branch associated with the file_id
822
# FIXME should provide multiple branches, based on config
823
return Branch.open(self.bzrdir.root_transport.clone(path).base)
825
def supports_tags(self):
826
return self._format.supports_tags()
829
class BranchFormat(object):
830
"""An encapsulation of the initialization and open routines for a format.
832
Formats provide three things:
833
* An initialization routine,
837
Formats are placed in an dict by their format string for reference
838
during branch opening. Its not required that these be instances, they
839
can be classes themselves with class methods - it simply depends on
840
whether state is needed for a given format or not.
842
Once a format is deprecated, just deprecate the initialize and open
843
methods on the format class. Do not deprecate the object, as the
844
object will be created every time regardless.
847
_default_format = None
848
"""The default format used for new branches."""
851
"""The known formats."""
854
def find_format(klass, a_bzrdir):
855
"""Return the format for the branch object in a_bzrdir."""
857
transport = a_bzrdir.get_branch_transport(None)
858
format_string = transport.get("format").read()
859
return klass._formats[format_string]
861
raise NotBranchError(path=transport.base)
863
raise errors.UnknownFormatError(format=format_string)
866
def get_default_format(klass):
867
"""Return the current default format."""
868
return klass._default_format
870
def get_reference(self, a_bzrdir):
871
"""Get the target reference of the branch in a_bzrdir.
873
format probing must have been completed before calling
874
this method - it is assumed that the format of the branch
875
in a_bzrdir is correct.
877
:param a_bzrdir: The bzrdir to get the branch data from.
878
:return: None if the branch is not a reference branch.
882
def get_format_string(self):
883
"""Return the ASCII format string that identifies this format."""
884
raise NotImplementedError(self.get_format_string)
886
def get_format_description(self):
887
"""Return the short format description for this format."""
888
raise NotImplementedError(self.get_format_description)
890
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
892
"""Initialize a branch in a bzrdir, with specified files
894
:param a_bzrdir: The bzrdir to initialize the branch in
895
:param utf8_files: The files to create as a list of
896
(filename, content) tuples
897
:param set_format: If True, set the format with
898
self.get_format_string. (BzrBranch4 has its format set
900
:return: a branch in this format
902
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
903
branch_transport = a_bzrdir.get_branch_transport(self)
905
'metadir': ('lock', lockdir.LockDir),
906
'branch4': ('branch-lock', lockable_files.TransportLock),
908
lock_name, lock_class = lock_map[lock_type]
909
control_files = lockable_files.LockableFiles(branch_transport,
910
lock_name, lock_class)
911
control_files.create_lock()
912
control_files.lock_write()
914
control_files.put_utf8('format', self.get_format_string())
916
for file, content in utf8_files:
917
control_files.put_utf8(file, content)
919
control_files.unlock()
920
return self.open(a_bzrdir, _found=True)
922
def initialize(self, a_bzrdir):
923
"""Create a branch of this format in a_bzrdir."""
924
raise NotImplementedError(self.initialize)
926
def is_supported(self):
927
"""Is this format supported?
929
Supported formats can be initialized and opened.
930
Unsupported formats may not support initialization or committing or
931
some other features depending on the reason for not being supported.
935
def open(self, a_bzrdir, _found=False):
936
"""Return the branch object for a_bzrdir
938
_found is a private parameter, do not use it. It is used to indicate
939
if format probing has already be done.
941
raise NotImplementedError(self.open)
944
def register_format(klass, format):
945
klass._formats[format.get_format_string()] = format
948
def set_default_format(klass, format):
949
klass._default_format = format
952
def unregister_format(klass, format):
953
assert klass._formats[format.get_format_string()] is format
954
del klass._formats[format.get_format_string()]
957
return self.get_format_string().rstrip()
959
def supports_tags(self):
960
"""True if this format supports tags stored in the branch"""
961
return False # by default
963
# XXX: Probably doesn't really belong here -- mbp 20070212
964
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
966
branch_transport = a_bzrdir.get_branch_transport(self)
967
control_files = lockable_files.LockableFiles(branch_transport,
968
lock_filename, lock_class)
969
control_files.create_lock()
970
control_files.lock_write()
972
for filename, content in utf8_files:
973
control_files.put_utf8(filename, content)
975
control_files.unlock()
978
class BranchHooks(Hooks):
979
"""A dictionary mapping hook name to a list of callables for branch hooks.
981
e.g. ['set_rh'] Is the list of items to be called when the
982
set_revision_history function is invoked.
986
"""Create the default hooks.
988
These are all empty initially, because by default nothing should get
992
# Introduced in 0.15:
993
# invoked whenever the revision history has been set
994
# with set_revision_history. The api signature is
995
# (branch, revision_history), and the branch will
998
# invoked after a push operation completes.
999
# the api signature is
1001
# containing the members
1002
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1003
# where local is the local target branch or None, master is the target
1004
# master branch, and the rest should be self explanatory. The source
1005
# is read locked and the target branches write locked. Source will
1006
# be the local low-latency branch.
1007
self['post_push'] = []
1008
# invoked after a pull operation completes.
1009
# the api signature is
1011
# containing the members
1012
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1013
# where local is the local branch or None, master is the target
1014
# master branch, and the rest should be self explanatory. The source
1015
# is read locked and the target branches write locked. The local
1016
# branch is the low-latency branch.
1017
self['post_pull'] = []
1018
# invoked after a commit operation completes.
1019
# the api signature is
1020
# (local, master, old_revno, old_revid, new_revno, new_revid)
1021
# old_revid is NULL_REVISION for the first commit to a branch.
1022
self['post_commit'] = []
1023
# invoked after a uncommit operation completes.
1024
# the api signature is
1025
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1026
# local is the local branch or None, master is the target branch,
1027
# and an empty branch recieves new_revno of 0, new_revid of None.
1028
self['post_uncommit'] = []
1031
# install the default hooks into the Branch class.
1032
Branch.hooks = BranchHooks()
1035
class BzrBranchFormat4(BranchFormat):
1036
"""Bzr branch format 4.
1039
- a revision-history file.
1040
- a branch-lock lock file [ to be shared with the bzrdir ]
1043
def get_format_description(self):
1044
"""See BranchFormat.get_format_description()."""
1045
return "Branch format 4"
1047
def initialize(self, a_bzrdir):
1048
"""Create a branch of this format in a_bzrdir."""
1049
utf8_files = [('revision-history', ''),
1050
('branch-name', ''),
1052
return self._initialize_helper(a_bzrdir, utf8_files,
1053
lock_type='branch4', set_format=False)
1056
super(BzrBranchFormat4, self).__init__()
1057
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1059
def open(self, a_bzrdir, _found=False):
1060
"""Return the branch object for a_bzrdir
1062
_found is a private parameter, do not use it. It is used to indicate
1063
if format probing has already be done.
1066
# we are being called directly and must probe.
1067
raise NotImplementedError
1068
return BzrBranch(_format=self,
1069
_control_files=a_bzrdir._control_files,
1071
_repository=a_bzrdir.open_repository())
1074
return "Bazaar-NG branch format 4"
1077
class BzrBranchFormat5(BranchFormat):
1078
"""Bzr branch format 5.
1081
- a revision-history file.
1083
- a lock dir guarding the branch itself
1084
- all of this stored in a branch/ subdirectory
1085
- works with shared repositories.
1087
This format is new in bzr 0.8.
1090
def get_format_string(self):
1091
"""See BranchFormat.get_format_string()."""
1092
return "Bazaar-NG branch format 5\n"
1094
def get_format_description(self):
1095
"""See BranchFormat.get_format_description()."""
1096
return "Branch format 5"
1098
def initialize(self, a_bzrdir):
1099
"""Create a branch of this format in a_bzrdir."""
1100
utf8_files = [('revision-history', ''),
1101
('branch-name', ''),
1103
return self._initialize_helper(a_bzrdir, utf8_files)
1106
super(BzrBranchFormat5, self).__init__()
1107
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1109
def open(self, a_bzrdir, _found=False):
1110
"""Return the branch object for a_bzrdir
1112
_found is a private parameter, do not use it. It is used to indicate
1113
if format probing has already be done.
1116
format = BranchFormat.find_format(a_bzrdir)
1117
assert format.__class__ == self.__class__
1119
transport = a_bzrdir.get_branch_transport(None)
1120
control_files = lockable_files.LockableFiles(transport, 'lock',
1122
return BzrBranch5(_format=self,
1123
_control_files=control_files,
1125
_repository=a_bzrdir.find_repository())
1127
raise NotBranchError(path=transport.base)
1130
class BzrBranchFormat6(BzrBranchFormat5):
1131
"""Branch format with last-revision
1133
Unlike previous formats, this has no explicit revision history. Instead,
1134
this just stores the last-revision, and the left-hand history leading
1135
up to there is the history.
1137
This format was introduced in bzr 0.15
1140
def get_format_string(self):
1141
"""See BranchFormat.get_format_string()."""
1142
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1144
def get_format_description(self):
1145
"""See BranchFormat.get_format_description()."""
1146
return "Branch format 6"
1148
def initialize(self, a_bzrdir):
1149
"""Create a branch of this format in a_bzrdir."""
1150
utf8_files = [('last-revision', '0 null:\n'),
1151
('branch-name', ''),
1152
('branch.conf', ''),
1155
return self._initialize_helper(a_bzrdir, utf8_files)
1157
def open(self, a_bzrdir, _found=False):
1158
"""Return the branch object for a_bzrdir
1160
_found is a private parameter, do not use it. It is used to indicate
1161
if format probing has already be done.
1164
format = BranchFormat.find_format(a_bzrdir)
1165
assert format.__class__ == self.__class__
1166
transport = a_bzrdir.get_branch_transport(None)
1167
control_files = lockable_files.LockableFiles(transport, 'lock',
1169
return BzrBranch6(_format=self,
1170
_control_files=control_files,
1172
_repository=a_bzrdir.find_repository())
1174
def supports_tags(self):
1178
class BranchReferenceFormat(BranchFormat):
1179
"""Bzr branch reference format.
1181
Branch references are used in implementing checkouts, they
1182
act as an alias to the real branch which is at some other url.
1189
def get_format_string(self):
1190
"""See BranchFormat.get_format_string()."""
1191
return "Bazaar-NG Branch Reference Format 1\n"
1193
def get_format_description(self):
1194
"""See BranchFormat.get_format_description()."""
1195
return "Checkout reference format 1"
1197
def get_reference(self, a_bzrdir):
1198
"""See BranchFormat.get_reference()."""
1199
transport = a_bzrdir.get_branch_transport(None)
1200
return transport.get('location').read()
1202
def initialize(self, a_bzrdir, target_branch=None):
1203
"""Create a branch of this format in a_bzrdir."""
1204
if target_branch is None:
1205
# this format does not implement branch itself, thus the implicit
1206
# creation contract must see it as uninitializable
1207
raise errors.UninitializableFormat(self)
1208
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1209
branch_transport = a_bzrdir.get_branch_transport(self)
1210
branch_transport.put_bytes('location',
1211
target_branch.bzrdir.root_transport.base)
1212
branch_transport.put_bytes('format', self.get_format_string())
1213
return self.open(a_bzrdir, _found=True)
1216
super(BranchReferenceFormat, self).__init__()
1217
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1219
def _make_reference_clone_function(format, a_branch):
1220
"""Create a clone() routine for a branch dynamically."""
1221
def clone(to_bzrdir, revision_id=None):
1222
"""See Branch.clone()."""
1223
return format.initialize(to_bzrdir, a_branch)
1224
# cannot obey revision_id limits when cloning a reference ...
1225
# FIXME RBC 20060210 either nuke revision_id for clone, or
1226
# emit some sort of warning/error to the caller ?!
1229
def open(self, a_bzrdir, _found=False, location=None):
1230
"""Return the branch that the branch reference in a_bzrdir points at.
1232
_found is a private parameter, do not use it. It is used to indicate
1233
if format probing has already be done.
1236
format = BranchFormat.find_format(a_bzrdir)
1237
assert format.__class__ == self.__class__
1238
if location is None:
1239
location = self.get_reference(a_bzrdir)
1240
real_bzrdir = bzrdir.BzrDir.open(location)
1241
result = real_bzrdir.open_branch()
1242
# this changes the behaviour of result.clone to create a new reference
1243
# rather than a copy of the content of the branch.
1244
# I did not use a proxy object because that needs much more extensive
1245
# testing, and we are only changing one behaviour at the moment.
1246
# If we decide to alter more behaviours - i.e. the implicit nickname
1247
# then this should be refactored to introduce a tested proxy branch
1248
# and a subclass of that for use in overriding clone() and ....
1250
result.clone = self._make_reference_clone_function(result)
1254
# formats which have no format string are not discoverable
1255
# and not independently creatable, so are not registered.
1256
__default_format = BzrBranchFormat5()
1257
BranchFormat.register_format(__default_format)
1258
BranchFormat.register_format(BranchReferenceFormat())
1259
BranchFormat.register_format(BzrBranchFormat6())
1260
BranchFormat.set_default_format(__default_format)
1261
_legacy_formats = [BzrBranchFormat4(),
1264
class BzrBranch(Branch):
1265
"""A branch stored in the actual filesystem.
1267
Note that it's "local" in the context of the filesystem; it doesn't
1268
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1269
it's writable, and can be accessed via the normal filesystem API.
1272
def __init__(self, _format=None,
1273
_control_files=None, a_bzrdir=None, _repository=None):
1274
"""Create new branch object at a particular location."""
1275
Branch.__init__(self)
1276
if a_bzrdir is None:
1277
raise ValueError('a_bzrdir must be supplied')
1279
self.bzrdir = a_bzrdir
1280
# self._transport used to point to the directory containing the
1281
# control directory, but was not used - now it's just the transport
1282
# for the branch control files. mbp 20070212
1283
self._base = self.bzrdir.transport.clone('..').base
1284
self._format = _format
1285
if _control_files is None:
1286
raise ValueError('BzrBranch _control_files is None')
1287
self.control_files = _control_files
1288
self._transport = _control_files._transport
1289
self.repository = _repository
1292
return '%s(%r)' % (self.__class__.__name__, self.base)
1296
def _get_base(self):
1297
"""Returns the directory containing the control directory."""
1300
base = property(_get_base, doc="The URL for the root of this branch.")
1302
def abspath(self, name):
1303
"""See Branch.abspath."""
1304
return self.control_files._transport.abspath(name)
1307
@deprecated_method(zero_sixteen)
1309
def get_root_id(self):
1310
"""See Branch.get_root_id."""
1311
tree = self.repository.revision_tree(self.last_revision())
1312
return tree.inventory.root.file_id
1314
def is_locked(self):
1315
return self.control_files.is_locked()
1317
def lock_write(self, token=None):
1318
repo_token = self.repository.lock_write()
1320
token = self.control_files.lock_write(token=token)
1322
self.repository.unlock()
1326
def lock_read(self):
1327
self.repository.lock_read()
1329
self.control_files.lock_read()
1331
self.repository.unlock()
1335
# TODO: test for failed two phase locks. This is known broken.
1337
self.control_files.unlock()
1339
self.repository.unlock()
1340
if not self.control_files.is_locked():
1341
# we just released the lock
1342
self._clear_cached_state()
1344
def peek_lock_mode(self):
1345
if self.control_files._lock_count == 0:
1348
return self.control_files._lock_mode
1350
def get_physical_lock_status(self):
1351
return self.control_files.get_physical_lock_status()
1354
def print_file(self, file, revision_id):
1355
"""See Branch.print_file."""
1356
return self.repository.print_file(file, revision_id)
1359
def append_revision(self, *revision_ids):
1360
"""See Branch.append_revision."""
1361
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1362
for revision_id in revision_ids:
1363
_mod_revision.check_not_reserved_id(revision_id)
1364
mutter("add {%s} to revision-history" % revision_id)
1365
rev_history = self.revision_history()
1366
rev_history.extend(revision_ids)
1367
self.set_revision_history(rev_history)
1369
def _write_revision_history(self, history):
1370
"""Factored out of set_revision_history.
1372
This performs the actual writing to disk.
1373
It is intended to be called by BzrBranch5.set_revision_history."""
1374
self.control_files.put_bytes(
1375
'revision-history', '\n'.join(history))
1378
def set_revision_history(self, rev_history):
1379
"""See Branch.set_revision_history."""
1380
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1381
self._clear_cached_state()
1382
self._write_revision_history(rev_history)
1383
self._cache_revision_history(rev_history)
1384
for hook in Branch.hooks['set_rh']:
1385
hook(self, rev_history)
1388
def set_last_revision_info(self, revno, revision_id):
1389
revision_id = osutils.safe_revision_id(revision_id)
1390
history = self._lefthand_history(revision_id)
1391
assert len(history) == revno, '%d != %d' % (len(history), revno)
1392
self.set_revision_history(history)
1394
def _gen_revision_history(self):
1395
history = self.control_files.get('revision-history').read().split('\n')
1396
if history[-1:] == ['']:
1397
# There shouldn't be a trailing newline, but just in case.
1401
def _lefthand_history(self, revision_id, last_rev=None,
1403
# stop_revision must be a descendant of last_revision
1404
stop_graph = self.repository.get_revision_graph(revision_id)
1405
if last_rev is not None and last_rev not in stop_graph:
1406
# our previous tip is not merged into stop_revision
1407
raise errors.DivergedBranches(self, other_branch)
1408
# make a new revision history from the graph
1409
current_rev_id = revision_id
1411
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1412
new_history.append(current_rev_id)
1413
current_rev_id_parents = stop_graph[current_rev_id]
1415
current_rev_id = current_rev_id_parents[0]
1417
current_rev_id = None
1418
new_history.reverse()
1422
def generate_revision_history(self, revision_id, last_rev=None,
1424
"""Create a new revision history that will finish with revision_id.
1426
:param revision_id: the new tip to use.
1427
:param last_rev: The previous last_revision. If not None, then this
1428
must be a ancestory of revision_id, or DivergedBranches is raised.
1429
:param other_branch: The other branch that DivergedBranches should
1430
raise with respect to.
1432
revision_id = osutils.safe_revision_id(revision_id)
1433
self.set_revision_history(self._lefthand_history(revision_id,
1434
last_rev, other_branch))
1437
def update_revisions(self, other, stop_revision=None):
1438
"""See Branch.update_revisions."""
1441
if stop_revision is None:
1442
stop_revision = other.last_revision()
1443
if stop_revision is None:
1444
# if there are no commits, we're done.
1447
stop_revision = osutils.safe_revision_id(stop_revision)
1448
# whats the current last revision, before we fetch [and change it
1450
last_rev = self.last_revision()
1451
# we fetch here regardless of whether we need to so that we pickup
1453
self.fetch(other, stop_revision)
1454
my_ancestry = self.repository.get_ancestry(last_rev)
1455
if stop_revision in my_ancestry:
1456
# last_revision is a descendant of stop_revision
1458
self.generate_revision_history(stop_revision, last_rev=last_rev,
1463
def basis_tree(self):
1464
"""See Branch.basis_tree."""
1465
return self.repository.revision_tree(self.last_revision())
1467
@deprecated_method(zero_eight)
1468
def working_tree(self):
1469
"""Create a Working tree object for this branch."""
1471
from bzrlib.transport.local import LocalTransport
1472
if (self.base.find('://') != -1 or
1473
not isinstance(self._transport, LocalTransport)):
1474
raise NoWorkingTree(self.base)
1475
return self.bzrdir.open_workingtree()
1478
def pull(self, source, overwrite=False, stop_revision=None,
1479
_hook_master=None, run_hooks=True):
1482
:param _hook_master: Private parameter - set the branch to
1483
be supplied as the master to push hooks.
1484
:param run_hooks: Private parameter - if false, this branch
1485
is being called because it's the master of the primary branch,
1486
so it should not run its hooks.
1488
result = PullResult()
1489
result.source_branch = source
1490
result.target_branch = self
1493
result.old_revno, result.old_revid = self.last_revision_info()
1495
self.update_revisions(source, stop_revision)
1496
except DivergedBranches:
1500
if stop_revision is None:
1501
stop_revision = source.last_revision()
1502
self.generate_revision_history(stop_revision)
1503
result.tag_conflicts = source.tags.merge_to(self.tags)
1504
result.new_revno, result.new_revid = self.last_revision_info()
1506
result.master_branch = _hook_master
1507
result.local_branch = self
1509
result.master_branch = self
1510
result.local_branch = None
1512
for hook in Branch.hooks['post_pull']:
1518
def _get_parent_location(self):
1519
_locs = ['parent', 'pull', 'x-pull']
1522
return self.control_files.get(l).read().strip('\n')
1528
def push(self, target, overwrite=False, stop_revision=None,
1529
_override_hook_source_branch=None):
1532
This is the basic concrete implementation of push()
1534
:param _override_hook_source_branch: If specified, run
1535
the hooks passing this Branch as the source, rather than self.
1536
This is for use of RemoteBranch, where push is delegated to the
1537
underlying vfs-based Branch.
1539
# TODO: Public option to disable running hooks - should be trivial but
1543
result = self._push_with_bound_branches(target, overwrite,
1545
_override_hook_source_branch=_override_hook_source_branch)
1550
def _push_with_bound_branches(self, target, overwrite,
1552
_override_hook_source_branch=None):
1553
"""Push from self into target, and into target's master if any.
1555
This is on the base BzrBranch class even though it doesn't support
1556
bound branches because the *target* might be bound.
1559
if _override_hook_source_branch:
1560
result.source_branch = _override_hook_source_branch
1561
for hook in Branch.hooks['post_push']:
1564
bound_location = target.get_bound_location()
1565
if bound_location and target.base != bound_location:
1566
# there is a master branch.
1568
# XXX: Why the second check? Is it even supported for a branch to
1569
# be bound to itself? -- mbp 20070507
1570
master_branch = target.get_master_branch()
1571
master_branch.lock_write()
1573
# push into the master from this branch.
1574
self._basic_push(master_branch, overwrite, stop_revision)
1575
# and push into the target branch from this. Note that we push from
1576
# this branch again, because its considered the highest bandwidth
1578
result = self._basic_push(target, overwrite, stop_revision)
1579
result.master_branch = master_branch
1580
result.local_branch = target
1584
master_branch.unlock()
1587
result = self._basic_push(target, overwrite, stop_revision)
1588
# TODO: Why set master_branch and local_branch if there's no
1589
# binding? Maybe cleaner to just leave them unset? -- mbp
1591
result.master_branch = target
1592
result.local_branch = None
1596
def _basic_push(self, target, overwrite, stop_revision):
1597
"""Basic implementation of push without bound branches or hooks.
1599
Must be called with self read locked and target write locked.
1601
result = PushResult()
1602
result.source_branch = self
1603
result.target_branch = target
1604
result.old_revno, result.old_revid = target.last_revision_info()
1606
target.update_revisions(self, stop_revision)
1607
except DivergedBranches:
1611
target.set_revision_history(self.revision_history())
1612
result.tag_conflicts = self.tags.merge_to(target.tags)
1613
result.new_revno, result.new_revid = target.last_revision_info()
1616
def get_parent(self):
1617
"""See Branch.get_parent."""
1619
assert self.base[-1] == '/'
1620
parent = self._get_parent_location()
1623
# This is an old-format absolute path to a local branch
1624
# turn it into a url
1625
if parent.startswith('/'):
1626
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1628
return urlutils.join(self.base[:-1], parent)
1629
except errors.InvalidURLJoin, e:
1630
raise errors.InaccessibleParent(parent, self.base)
1632
def set_push_location(self, location):
1633
"""See Branch.set_push_location."""
1634
self.get_config().set_user_option(
1635
'push_location', location,
1636
store=_mod_config.STORE_LOCATION_NORECURSE)
1639
def set_parent(self, url):
1640
"""See Branch.set_parent."""
1641
# TODO: Maybe delete old location files?
1642
# URLs should never be unicode, even on the local fs,
1643
# FIXUP this and get_parent in a future branch format bump:
1644
# read and rewrite the file, and have the new format code read
1645
# using .get not .get_utf8. RBC 20060125
1647
if isinstance(url, unicode):
1649
url = url.encode('ascii')
1650
except UnicodeEncodeError:
1651
raise errors.InvalidURL(url,
1652
"Urls must be 7-bit ascii, "
1653
"use bzrlib.urlutils.escape")
1654
url = urlutils.relative_url(self.base, url)
1655
self._set_parent_location(url)
1657
def _set_parent_location(self, url):
1659
self.control_files._transport.delete('parent')
1661
assert isinstance(url, str)
1662
self.control_files.put_bytes('parent', url + '\n')
1664
@deprecated_function(zero_nine)
1665
def tree_config(self):
1666
"""DEPRECATED; call get_config instead.
1667
TreeConfig has become part of BranchConfig."""
1668
return TreeConfig(self)
1671
class BzrBranch5(BzrBranch):
1672
"""A format 5 branch. This supports new features over plan branches.
1674
It has support for a master_branch which is the data for bound branches.
1682
super(BzrBranch5, self).__init__(_format=_format,
1683
_control_files=_control_files,
1685
_repository=_repository)
1688
def pull(self, source, overwrite=False, stop_revision=None,
1690
"""Pull from source into self, updating my master if any.
1692
:param run_hooks: Private parameter - if false, this branch
1693
is being called because it's the master of the primary branch,
1694
so it should not run its hooks.
1696
bound_location = self.get_bound_location()
1697
master_branch = None
1698
if bound_location and source.base != bound_location:
1699
# not pulling from master, so we need to update master.
1700
master_branch = self.get_master_branch()
1701
master_branch.lock_write()
1704
# pull from source into master.
1705
master_branch.pull(source, overwrite, stop_revision,
1707
return super(BzrBranch5, self).pull(source, overwrite,
1708
stop_revision, _hook_master=master_branch,
1709
run_hooks=run_hooks)
1712
master_branch.unlock()
1714
def get_bound_location(self):
1716
return self.control_files.get_utf8('bound').read()[:-1]
1717
except errors.NoSuchFile:
1721
def get_master_branch(self):
1722
"""Return the branch we are bound to.
1724
:return: Either a Branch, or None
1726
This could memoise the branch, but if thats done
1727
it must be revalidated on each new lock.
1728
So for now we just don't memoise it.
1729
# RBC 20060304 review this decision.
1731
bound_loc = self.get_bound_location()
1735
return Branch.open(bound_loc)
1736
except (errors.NotBranchError, errors.ConnectionError), e:
1737
raise errors.BoundBranchConnectionFailure(
1741
def set_bound_location(self, location):
1742
"""Set the target where this branch is bound to.
1744
:param location: URL to the target branch
1747
self.control_files.put_utf8('bound', location+'\n')
1750
self.control_files._transport.delete('bound')
1756
def bind(self, other):
1757
"""Bind this branch to the branch other.
1759
This does not push or pull data between the branches, though it does
1760
check for divergence to raise an error when the branches are not
1761
either the same, or one a prefix of the other. That behaviour may not
1762
be useful, so that check may be removed in future.
1764
:param other: The branch to bind to
1767
# TODO: jam 20051230 Consider checking if the target is bound
1768
# It is debatable whether you should be able to bind to
1769
# a branch which is itself bound.
1770
# Committing is obviously forbidden,
1771
# but binding itself may not be.
1772
# Since we *have* to check at commit time, we don't
1773
# *need* to check here
1775
# we want to raise diverged if:
1776
# last_rev is not in the other_last_rev history, AND
1777
# other_last_rev is not in our history, and do it without pulling
1779
last_rev = self.last_revision()
1780
if last_rev is not None:
1783
other_last_rev = other.last_revision()
1784
if other_last_rev is not None:
1785
# neither branch is new, we have to do some work to
1786
# ascertain diversion.
1787
remote_graph = other.repository.get_revision_graph(
1789
local_graph = self.repository.get_revision_graph(last_rev)
1790
if (last_rev not in remote_graph and
1791
other_last_rev not in local_graph):
1792
raise errors.DivergedBranches(self, other)
1795
self.set_bound_location(other.base)
1799
"""If bound, unbind"""
1800
return self.set_bound_location(None)
1804
"""Synchronise this branch with the master branch if any.
1806
:return: None or the last_revision that was pivoted out during the
1809
master = self.get_master_branch()
1810
if master is not None:
1811
old_tip = self.last_revision()
1812
self.pull(master, overwrite=True)
1813
if old_tip in self.repository.get_ancestry(self.last_revision()):
1819
class BzrBranchExperimental(BzrBranch5):
1820
"""Bzr experimental branch format
1823
- a revision-history file.
1825
- a lock dir guarding the branch itself
1826
- all of this stored in a branch/ subdirectory
1827
- works with shared repositories.
1828
- a tag dictionary in the branch
1830
This format is new in bzr 0.15, but shouldn't be used for real data,
1833
This class acts as it's own BranchFormat.
1836
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1839
def get_format_string(cls):
1840
"""See BranchFormat.get_format_string()."""
1841
return "Bazaar-NG branch format experimental\n"
1844
def get_format_description(cls):
1845
"""See BranchFormat.get_format_description()."""
1846
return "Experimental branch format"
1849
def get_reference(cls, a_bzrdir):
1850
"""Get the target reference of the branch in a_bzrdir.
1852
format probing must have been completed before calling
1853
this method - it is assumed that the format of the branch
1854
in a_bzrdir is correct.
1856
:param a_bzrdir: The bzrdir to get the branch data from.
1857
:return: None if the branch is not a reference branch.
1862
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1864
branch_transport = a_bzrdir.get_branch_transport(cls)
1865
control_files = lockable_files.LockableFiles(branch_transport,
1866
lock_filename, lock_class)
1867
control_files.create_lock()
1868
control_files.lock_write()
1870
for filename, content in utf8_files:
1871
control_files.put_utf8(filename, content)
1873
control_files.unlock()
1876
def initialize(cls, a_bzrdir):
1877
"""Create a branch of this format in a_bzrdir."""
1878
utf8_files = [('format', cls.get_format_string()),
1879
('revision-history', ''),
1880
('branch-name', ''),
1883
cls._initialize_control_files(a_bzrdir, utf8_files,
1884
'lock', lockdir.LockDir)
1885
return cls.open(a_bzrdir, _found=True)
1888
def open(cls, a_bzrdir, _found=False):
1889
"""Return the branch object for a_bzrdir
1891
_found is a private parameter, do not use it. It is used to indicate
1892
if format probing has already be done.
1895
format = BranchFormat.find_format(a_bzrdir)
1896
assert format.__class__ == cls
1897
transport = a_bzrdir.get_branch_transport(None)
1898
control_files = lockable_files.LockableFiles(transport, 'lock',
1900
return cls(_format=cls,
1901
_control_files=control_files,
1903
_repository=a_bzrdir.find_repository())
1906
def is_supported(cls):
1909
def _make_tags(self):
1910
return BasicTags(self)
1913
def supports_tags(cls):
1917
BranchFormat.register_format(BzrBranchExperimental)
1920
class BzrBranch6(BzrBranch5):
1923
def last_revision_info(self):
1924
revision_string = self.control_files.get('last-revision').read()
1925
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1926
revision_id = cache_utf8.get_cached_utf8(revision_id)
1928
return revno, revision_id
1930
def last_revision(self):
1931
"""Return last revision id, or None"""
1932
revision_id = self.last_revision_info()[1]
1933
if revision_id == _mod_revision.NULL_REVISION:
1937
def _write_last_revision_info(self, revno, revision_id):
1938
"""Simply write out the revision id, with no checks.
1940
Use set_last_revision_info to perform this safely.
1942
Does not update the revision_history cache.
1943
Intended to be called by set_last_revision_info and
1944
_write_revision_history.
1946
if revision_id is None:
1947
revision_id = 'null:'
1948
out_string = '%d %s\n' % (revno, revision_id)
1949
self.control_files.put_bytes('last-revision', out_string)
1952
def set_last_revision_info(self, revno, revision_id):
1953
revision_id = osutils.safe_revision_id(revision_id)
1954
if self._get_append_revisions_only():
1955
self._check_history_violation(revision_id)
1956
self._write_last_revision_info(revno, revision_id)
1957
self._clear_cached_state()
1959
def _check_history_violation(self, revision_id):
1960
last_revision = self.last_revision()
1961
if last_revision is None:
1963
if last_revision not in self._lefthand_history(revision_id):
1964
raise errors.AppendRevisionsOnlyViolation(self.base)
1966
def _gen_revision_history(self):
1967
"""Generate the revision history from last revision
1969
history = list(self.repository.iter_reverse_revision_history(
1970
self.last_revision()))
1974
def _write_revision_history(self, history):
1975
"""Factored out of set_revision_history.
1977
This performs the actual writing to disk, with format-specific checks.
1978
It is intended to be called by BzrBranch5.set_revision_history.
1980
if len(history) == 0:
1981
last_revision = 'null:'
1983
if history != self._lefthand_history(history[-1]):
1984
raise errors.NotLefthandHistory(history)
1985
last_revision = history[-1]
1986
if self._get_append_revisions_only():
1987
self._check_history_violation(last_revision)
1988
self._write_last_revision_info(len(history), last_revision)
1991
def append_revision(self, *revision_ids):
1992
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1993
if len(revision_ids) == 0:
1995
prev_revno, prev_revision = self.last_revision_info()
1996
for revision in self.repository.get_revisions(revision_ids):
1997
if prev_revision == _mod_revision.NULL_REVISION:
1998
if revision.parent_ids != []:
1999
raise errors.NotLeftParentDescendant(self, prev_revision,
2000
revision.revision_id)
2002
if revision.parent_ids[0] != prev_revision:
2003
raise errors.NotLeftParentDescendant(self, prev_revision,
2004
revision.revision_id)
2005
prev_revision = revision.revision_id
2006
self.set_last_revision_info(prev_revno + len(revision_ids),
2010
def _set_parent_location(self, url):
2011
"""Set the parent branch"""
2012
self._set_config_location('parent_location', url, make_relative=True)
2015
def _get_parent_location(self):
2016
"""Set the parent branch"""
2017
return self._get_config_location('parent_location')
2019
def set_push_location(self, location):
2020
"""See Branch.set_push_location."""
2021
self._set_config_location('push_location', location)
2023
def set_bound_location(self, location):
2024
"""See Branch.set_push_location."""
2026
config = self.get_config()
2027
if location is None:
2028
if config.get_user_option('bound') != 'True':
2031
config.set_user_option('bound', 'False')
2034
self._set_config_location('bound_location', location,
2036
config.set_user_option('bound', 'True')
2039
def _get_bound_location(self, bound):
2040
"""Return the bound location in the config file.
2042
Return None if the bound parameter does not match"""
2043
config = self.get_config()
2044
config_bound = (config.get_user_option('bound') == 'True')
2045
if config_bound != bound:
2047
return self._get_config_location('bound_location', config=config)
2049
def get_bound_location(self):
2050
"""See Branch.set_push_location."""
2051
return self._get_bound_location(True)
2053
def get_old_bound_location(self):
2054
"""See Branch.get_old_bound_location"""
2055
return self._get_bound_location(False)
2057
def set_append_revisions_only(self, enabled):
2062
self.get_config().set_user_option('append_revisions_only', value)
2064
def _get_append_revisions_only(self):
2065
value = self.get_config().get_user_option('append_revisions_only')
2066
return value == 'True'
2068
def _synchronize_history(self, destination, revision_id):
2069
"""Synchronize last revision and revision history between branches.
2071
This version is most efficient when the destination is also a
2072
BzrBranch6, but works for BzrBranch5, as long as the destination's
2073
repository contains all the lefthand ancestors of the intended
2074
last_revision. If not, set_last_revision_info will fail.
2076
:param destination: The branch to copy the history into
2077
:param revision_id: The revision-id to truncate history at. May
2078
be None to copy complete history.
2080
if revision_id is None:
2081
revno, revision_id = self.last_revision_info()
2083
revno = self.revision_id_to_revno(revision_id)
2084
destination.set_last_revision_info(revno, revision_id)
2086
def _make_tags(self):
2087
return BasicTags(self)
2090
class BranchTestProviderAdapter(object):
2091
"""A tool to generate a suite testing multiple branch formats at once.
2093
This is done by copying the test once for each transport and injecting
2094
the transport_server, transport_readonly_server, and branch_format
2095
classes into each copy. Each copy is also given a new id() to make it
2099
def __init__(self, transport_server, transport_readonly_server, formats,
2100
vfs_transport_factory=None):
2101
self._transport_server = transport_server
2102
self._transport_readonly_server = transport_readonly_server
2103
self._formats = formats
2105
def adapt(self, test):
2106
result = TestSuite()
2107
for branch_format, bzrdir_format in self._formats:
2108
new_test = deepcopy(test)
2109
new_test.transport_server = self._transport_server
2110
new_test.transport_readonly_server = self._transport_readonly_server
2111
new_test.bzrdir_format = bzrdir_format
2112
new_test.branch_format = branch_format
2113
def make_new_test_id():
2114
# the format can be either a class or an instance
2115
name = getattr(branch_format, '__name__',
2116
branch_format.__class__.__name__)
2117
new_id = "%s(%s)" % (new_test.id(), name)
2118
return lambda: new_id
2119
new_test.id = make_new_test_id()
2120
result.addTest(new_test)
2124
######################################################################
2125
# results of operations
2128
class _Result(object):
2130
def _show_tag_conficts(self, to_file):
2131
if not getattr(self, 'tag_conflicts', None):
2133
to_file.write('Conflicting tags:\n')
2134
for name, value1, value2 in self.tag_conflicts:
2135
to_file.write(' %s\n' % (name, ))
2138
class PullResult(_Result):
2139
"""Result of a Branch.pull operation.
2141
:ivar old_revno: Revision number before pull.
2142
:ivar new_revno: Revision number after pull.
2143
:ivar old_revid: Tip revision id before pull.
2144
:ivar new_revid: Tip revision id after pull.
2145
:ivar source_branch: Source (local) branch object.
2146
:ivar master_branch: Master branch of the target, or None.
2147
:ivar target_branch: Target/destination branch object.
2151
# DEPRECATED: pull used to return the change in revno
2152
return self.new_revno - self.old_revno
2154
def report(self, to_file):
2155
if self.old_revid == self.new_revid:
2156
to_file.write('No revisions to pull.\n')
2158
to_file.write('Now on revision %d.\n' % self.new_revno)
2159
self._show_tag_conficts(to_file)
2162
class PushResult(_Result):
2163
"""Result of a Branch.push operation.
2165
:ivar old_revno: Revision number before push.
2166
:ivar new_revno: Revision number after push.
2167
:ivar old_revid: Tip revision id before push.
2168
:ivar new_revid: Tip revision id after push.
2169
:ivar source_branch: Source branch object.
2170
:ivar master_branch: Master branch of the target, or None.
2171
:ivar target_branch: Target/destination branch object.
2175
# DEPRECATED: push used to return the change in revno
2176
return self.new_revno - self.old_revno
2178
def report(self, to_file):
2179
"""Write a human-readable description of the result."""
2180
if self.old_revid == self.new_revid:
2181
to_file.write('No new revisions to push.\n')
2183
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2184
self._show_tag_conficts(to_file)
2187
class BranchCheckResult(object):
2188
"""Results of checking branch consistency.
2193
def __init__(self, branch):
2194
self.branch = branch
2196
def report_results(self, verbose):
2197
"""Report the check results via trace.note.
2199
:param verbose: Requests more detailed display of what was checked,
2202
note('checked branch %s format %s',
2204
self.branch._format)
2207
class Converter5to6(object):
2208
"""Perform an in-place upgrade of format 5 to format 6"""
2210
def convert(self, branch):
2211
# Data for 5 and 6 can peacefully coexist.
2212
format = BzrBranchFormat6()
2213
new_branch = format.open(branch.bzrdir, _found=True)
2215
# Copy source data into target
2216
new_branch.set_last_revision_info(*branch.last_revision_info())
2217
new_branch.set_parent(branch.get_parent())
2218
new_branch.set_bound_location(branch.get_bound_location())
2219
new_branch.set_push_location(branch.get_push_location())
2221
# New branch has no tags by default
2222
new_branch.tags._set_tag_dict({})
2224
# Copying done; now update target format
2225
new_branch.control_files.put_utf8('format',
2226
format.get_format_string())
2228
# Clean up old files
2229
new_branch.control_files._transport.delete('revision-history')
2231
branch.set_parent(None)
2234
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
