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)
509
def revision_id_to_dotted_revno(self, revision_id):
510
"""Given a revision id, return its dotted revno."""
511
if revision_id in (None, _mod_revision.NULL_REVISION):
513
revision_id = osutils.safe_revision_id(revision_id)
515
revision_id_to_revno = self.get_revision_id_to_revno_map()
516
if revision_id not in revision_id_to_revno:
517
raise errors.NoSuchRevision(self, revision_id)
518
return revision_id_to_revno[revision_id]
520
def revision_id_to_revno(self, revision_id):
521
"""Given a revision id, return its revno"""
522
if revision_id is None:
524
revision_id = osutils.safe_revision_id(revision_id)
525
history = self.revision_history()
527
return history.index(revision_id) + 1
529
raise errors.NoSuchRevision(self, revision_id)
531
def get_rev_id(self, revno, history=None):
532
"""Find the revision id of the specified revno."""
536
history = self.revision_history()
537
if revno <= 0 or revno > len(history):
538
raise errors.NoSuchRevision(self, revno)
539
return history[revno - 1]
541
def pull(self, source, overwrite=False, stop_revision=None):
542
"""Mirror source into this branch.
544
This branch is considered to be 'local', having low latency.
546
:returns: PullResult instance
548
raise NotImplementedError(self.pull)
550
def push(self, target, overwrite=False, stop_revision=None):
551
"""Mirror this branch into target.
553
This branch is considered to be 'local', having low latency.
555
raise NotImplementedError(self.push)
557
def basis_tree(self):
558
"""Return `Tree` object for last revision."""
559
return self.repository.revision_tree(self.last_revision())
561
def rename_one(self, from_rel, to_rel):
564
This can change the directory or the filename or both.
566
raise NotImplementedError(self.rename_one)
568
def move(self, from_paths, to_name):
571
to_name must exist as a versioned directory.
573
If to_name exists and is a directory, the files are moved into
574
it, keeping their old names. If it is a directory,
576
Note that to_name is only the last component of the new name;
577
this doesn't change the directory.
579
This returns a list of (from_path, to_path) pairs for each
582
raise NotImplementedError(self.move)
584
def get_parent(self):
585
"""Return the parent location of the branch.
587
This is the default location for push/pull/missing. The usual
588
pattern is that the user can override it by specifying a
591
raise NotImplementedError(self.get_parent)
593
def _set_config_location(self, name, url, config=None,
594
make_relative=False):
596
config = self.get_config()
600
url = urlutils.relative_url(self.base, url)
601
config.set_user_option(name, url)
603
def _get_config_location(self, name, config=None):
605
config = self.get_config()
606
location = config.get_user_option(name)
611
def get_submit_branch(self):
612
"""Return the submit location of the branch.
614
This is the default location for bundle. The usual
615
pattern is that the user can override it by specifying a
618
return self.get_config().get_user_option('submit_branch')
620
def set_submit_branch(self, location):
621
"""Return the submit location of the branch.
623
This is the default location for bundle. The usual
624
pattern is that the user can override it by specifying a
627
self.get_config().set_user_option('submit_branch', location)
629
def get_public_branch(self):
630
"""Return the public location of the branch.
632
This is is used by merge directives.
634
return self._get_config_location('public_branch')
636
def set_public_branch(self, location):
637
"""Return the submit location of the branch.
639
This is the default location for bundle. The usual
640
pattern is that the user can override it by specifying a
643
self._set_config_location('public_branch', location)
645
def get_push_location(self):
646
"""Return the None or the location to push this branch to."""
647
push_loc = self.get_config().get_user_option('push_location')
650
def set_push_location(self, location):
651
"""Set a new push location for this branch."""
652
raise NotImplementedError(self.set_push_location)
654
def set_parent(self, url):
655
raise NotImplementedError(self.set_parent)
659
"""Synchronise this branch with the master branch if any.
661
:return: None or the last_revision pivoted out during the update.
665
def check_revno(self, revno):
667
Check whether a revno corresponds to any revision.
668
Zero (the NULL revision) is considered valid.
671
self.check_real_revno(revno)
673
def check_real_revno(self, revno):
675
Check whether a revno corresponds to a real revision.
676
Zero (the NULL revision) is considered invalid
678
if revno < 1 or revno > self.revno():
679
raise InvalidRevisionNumber(revno)
682
def clone(self, to_bzrdir, revision_id=None):
683
"""Clone this branch into to_bzrdir preserving all semantic values.
685
revision_id: if not None, the revision history in the new branch will
686
be truncated to end with revision_id.
688
result = self._format.initialize(to_bzrdir)
689
self.copy_content_into(result, revision_id=revision_id)
693
def sprout(self, to_bzrdir, revision_id=None):
694
"""Create a new line of development from the branch, into to_bzrdir.
696
revision_id: if not None, the revision history in the new branch will
697
be truncated to end with revision_id.
699
result = self._format.initialize(to_bzrdir)
700
self.copy_content_into(result, revision_id=revision_id)
701
result.set_parent(self.bzrdir.root_transport.base)
704
def _synchronize_history(self, destination, revision_id):
705
"""Synchronize last revision and revision history between branches.
707
This version is most efficient when the destination is also a
708
BzrBranch5, but works for BzrBranch6 as long as the revision
709
history is the true lefthand parent history, and all of the revisions
710
are in the destination's repository. If not, set_revision_history
713
:param destination: The branch to copy the history into
714
:param revision_id: The revision-id to truncate history at. May
715
be None to copy complete history.
717
new_history = self.revision_history()
718
if revision_id is not None:
719
revision_id = osutils.safe_revision_id(revision_id)
721
new_history = new_history[:new_history.index(revision_id) + 1]
723
rev = self.repository.get_revision(revision_id)
724
new_history = rev.get_history(self.repository)[1:]
725
destination.set_revision_history(new_history)
728
def copy_content_into(self, destination, revision_id=None):
729
"""Copy the content of self into destination.
731
revision_id: if not None, the revision history in the new branch will
732
be truncated to end with revision_id.
734
self._synchronize_history(destination, revision_id)
736
parent = self.get_parent()
737
except errors.InaccessibleParent, e:
738
mutter('parent was not accessible to copy: %s', e)
741
destination.set_parent(parent)
742
self.tags.merge_to(destination.tags)
746
"""Check consistency of the branch.
748
In particular this checks that revisions given in the revision-history
749
do actually match up in the revision graph, and that they're all
750
present in the repository.
752
Callers will typically also want to check the repository.
754
:return: A BranchCheckResult.
756
mainline_parent_id = None
757
for revision_id in self.revision_history():
759
revision = self.repository.get_revision(revision_id)
760
except errors.NoSuchRevision, e:
761
raise errors.BzrCheckError("mainline revision {%s} not in repository"
763
# In general the first entry on the revision history has no parents.
764
# But it's not illegal for it to have parents listed; this can happen
765
# in imports from Arch when the parents weren't reachable.
766
if mainline_parent_id is not None:
767
if mainline_parent_id not in revision.parent_ids:
768
raise errors.BzrCheckError("previous revision {%s} not listed among "
770
% (mainline_parent_id, revision_id))
771
mainline_parent_id = revision_id
772
return BranchCheckResult(self)
774
def _get_checkout_format(self):
775
"""Return the most suitable metadir for a checkout of this branch.
776
Weaves are used if this branch's repository uses weaves.
778
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
779
from bzrlib.repofmt import weaverepo
780
format = bzrdir.BzrDirMetaFormat1()
781
format.repository_format = weaverepo.RepositoryFormat7()
783
format = self.repository.bzrdir.checkout_metadir()
784
format.set_branch_format(self._format)
787
def create_checkout(self, to_location, revision_id=None,
789
"""Create a checkout of a branch.
791
:param to_location: The url to produce the checkout at
792
:param revision_id: The revision to check out
793
:param lightweight: If True, produce a lightweight checkout, otherwise,
794
produce a bound branch (heavyweight checkout)
795
:return: The tree of the created checkout
797
t = transport.get_transport(to_location)
800
except errors.FileExists:
803
format = self._get_checkout_format()
804
checkout = format.initialize_on_transport(t)
805
BranchReferenceFormat().initialize(checkout, self)
807
format = self._get_checkout_format()
808
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
809
to_location, force_new_tree=False, format=format)
810
checkout = checkout_branch.bzrdir
811
checkout_branch.bind(self)
812
# pull up to the specified revision_id to set the initial
813
# branch tip correctly, and seed it with history.
814
checkout_branch.pull(self, stop_revision=revision_id)
815
tree = checkout.create_workingtree(revision_id)
816
basis_tree = tree.basis_tree()
817
basis_tree.lock_read()
819
for path, file_id in basis_tree.iter_references():
820
reference_parent = self.reference_parent(file_id, path)
821
reference_parent.create_checkout(tree.abspath(path),
822
basis_tree.get_reference_revision(file_id, path),
828
def reference_parent(self, file_id, path):
829
"""Return the parent branch for a tree-reference file_id
830
:param file_id: The file_id of the tree reference
831
:param path: The path of the file_id in the tree
832
:return: A branch associated with the file_id
834
# FIXME should provide multiple branches, based on config
835
return Branch.open(self.bzrdir.root_transport.clone(path).base)
837
def supports_tags(self):
838
return self._format.supports_tags()
841
class BranchFormat(object):
842
"""An encapsulation of the initialization and open routines for a format.
844
Formats provide three things:
845
* An initialization routine,
849
Formats are placed in an dict by their format string for reference
850
during branch opening. Its not required that these be instances, they
851
can be classes themselves with class methods - it simply depends on
852
whether state is needed for a given format or not.
854
Once a format is deprecated, just deprecate the initialize and open
855
methods on the format class. Do not deprecate the object, as the
856
object will be created every time regardless.
859
_default_format = None
860
"""The default format used for new branches."""
863
"""The known formats."""
866
def find_format(klass, a_bzrdir):
867
"""Return the format for the branch object in a_bzrdir."""
869
transport = a_bzrdir.get_branch_transport(None)
870
format_string = transport.get("format").read()
871
return klass._formats[format_string]
873
raise NotBranchError(path=transport.base)
875
raise errors.UnknownFormatError(format=format_string)
878
def get_default_format(klass):
879
"""Return the current default format."""
880
return klass._default_format
882
def get_reference(self, a_bzrdir):
883
"""Get the target reference of the branch in a_bzrdir.
885
format probing must have been completed before calling
886
this method - it is assumed that the format of the branch
887
in a_bzrdir is correct.
889
:param a_bzrdir: The bzrdir to get the branch data from.
890
:return: None if the branch is not a reference branch.
894
def get_format_string(self):
895
"""Return the ASCII format string that identifies this format."""
896
raise NotImplementedError(self.get_format_string)
898
def get_format_description(self):
899
"""Return the short format description for this format."""
900
raise NotImplementedError(self.get_format_description)
902
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
904
"""Initialize a branch in a bzrdir, with specified files
906
:param a_bzrdir: The bzrdir to initialize the branch in
907
:param utf8_files: The files to create as a list of
908
(filename, content) tuples
909
:param set_format: If True, set the format with
910
self.get_format_string. (BzrBranch4 has its format set
912
:return: a branch in this format
914
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
915
branch_transport = a_bzrdir.get_branch_transport(self)
917
'metadir': ('lock', lockdir.LockDir),
918
'branch4': ('branch-lock', lockable_files.TransportLock),
920
lock_name, lock_class = lock_map[lock_type]
921
control_files = lockable_files.LockableFiles(branch_transport,
922
lock_name, lock_class)
923
control_files.create_lock()
924
control_files.lock_write()
926
control_files.put_utf8('format', self.get_format_string())
928
for file, content in utf8_files:
929
control_files.put_utf8(file, content)
931
control_files.unlock()
932
return self.open(a_bzrdir, _found=True)
934
def initialize(self, a_bzrdir):
935
"""Create a branch of this format in a_bzrdir."""
936
raise NotImplementedError(self.initialize)
938
def is_supported(self):
939
"""Is this format supported?
941
Supported formats can be initialized and opened.
942
Unsupported formats may not support initialization or committing or
943
some other features depending on the reason for not being supported.
947
def open(self, a_bzrdir, _found=False):
948
"""Return the branch object for a_bzrdir
950
_found is a private parameter, do not use it. It is used to indicate
951
if format probing has already be done.
953
raise NotImplementedError(self.open)
956
def register_format(klass, format):
957
klass._formats[format.get_format_string()] = format
960
def set_default_format(klass, format):
961
klass._default_format = format
964
def unregister_format(klass, format):
965
assert klass._formats[format.get_format_string()] is format
966
del klass._formats[format.get_format_string()]
969
return self.get_format_string().rstrip()
971
def supports_tags(self):
972
"""True if this format supports tags stored in the branch"""
973
return False # by default
975
# XXX: Probably doesn't really belong here -- mbp 20070212
976
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
978
branch_transport = a_bzrdir.get_branch_transport(self)
979
control_files = lockable_files.LockableFiles(branch_transport,
980
lock_filename, lock_class)
981
control_files.create_lock()
982
control_files.lock_write()
984
for filename, content in utf8_files:
985
control_files.put_utf8(filename, content)
987
control_files.unlock()
990
class BranchHooks(Hooks):
991
"""A dictionary mapping hook name to a list of callables for branch hooks.
993
e.g. ['set_rh'] Is the list of items to be called when the
994
set_revision_history function is invoked.
998
"""Create the default hooks.
1000
These are all empty initially, because by default nothing should get
1003
Hooks.__init__(self)
1004
# Introduced in 0.15:
1005
# invoked whenever the revision history has been set
1006
# with set_revision_history. The api signature is
1007
# (branch, revision_history), and the branch will
1010
# invoked after a push operation completes.
1011
# the api signature is
1013
# containing the members
1014
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1015
# where local is the local branch or None, master is the target
1016
# master branch, and the rest should be self explanatory. The source
1017
# is read locked and the target branches write locked. Source will
1018
# be the local low-latency branch.
1019
self['post_push'] = []
1020
# invoked after a pull operation completes.
1021
# the api signature is
1023
# containing the members
1024
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1025
# where local is the local branch or None, master is the target
1026
# master branch, and the rest should be self explanatory. The source
1027
# is read locked and the target branches write locked. The local
1028
# branch is the low-latency branch.
1029
self['post_pull'] = []
1030
# invoked after a commit operation completes.
1031
# the api signature is
1032
# (local, master, old_revno, old_revid, new_revno, new_revid)
1033
# old_revid is NULL_REVISION for the first commit to a branch.
1034
self['post_commit'] = []
1035
# invoked after a uncommit operation completes.
1036
# the api signature is
1037
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1038
# local is the local branch or None, master is the target branch,
1039
# and an empty branch recieves new_revno of 0, new_revid of None.
1040
self['post_uncommit'] = []
1043
# install the default hooks into the Branch class.
1044
Branch.hooks = BranchHooks()
1047
class BzrBranchFormat4(BranchFormat):
1048
"""Bzr branch format 4.
1051
- a revision-history file.
1052
- a branch-lock lock file [ to be shared with the bzrdir ]
1055
def get_format_description(self):
1056
"""See BranchFormat.get_format_description()."""
1057
return "Branch format 4"
1059
def initialize(self, a_bzrdir):
1060
"""Create a branch of this format in a_bzrdir."""
1061
utf8_files = [('revision-history', ''),
1062
('branch-name', ''),
1064
return self._initialize_helper(a_bzrdir, utf8_files,
1065
lock_type='branch4', set_format=False)
1068
super(BzrBranchFormat4, self).__init__()
1069
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1071
def open(self, a_bzrdir, _found=False):
1072
"""Return the branch object for a_bzrdir
1074
_found is a private parameter, do not use it. It is used to indicate
1075
if format probing has already be done.
1078
# we are being called directly and must probe.
1079
raise NotImplementedError
1080
return BzrBranch(_format=self,
1081
_control_files=a_bzrdir._control_files,
1083
_repository=a_bzrdir.open_repository())
1086
return "Bazaar-NG branch format 4"
1089
class BzrBranchFormat5(BranchFormat):
1090
"""Bzr branch format 5.
1093
- a revision-history file.
1095
- a lock dir guarding the branch itself
1096
- all of this stored in a branch/ subdirectory
1097
- works with shared repositories.
1099
This format is new in bzr 0.8.
1102
def get_format_string(self):
1103
"""See BranchFormat.get_format_string()."""
1104
return "Bazaar-NG branch format 5\n"
1106
def get_format_description(self):
1107
"""See BranchFormat.get_format_description()."""
1108
return "Branch format 5"
1110
def initialize(self, a_bzrdir):
1111
"""Create a branch of this format in a_bzrdir."""
1112
utf8_files = [('revision-history', ''),
1113
('branch-name', ''),
1115
return self._initialize_helper(a_bzrdir, utf8_files)
1118
super(BzrBranchFormat5, self).__init__()
1119
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1121
def open(self, a_bzrdir, _found=False):
1122
"""Return the branch object for a_bzrdir
1124
_found is a private parameter, do not use it. It is used to indicate
1125
if format probing has already be done.
1128
format = BranchFormat.find_format(a_bzrdir)
1129
assert format.__class__ == self.__class__
1131
transport = a_bzrdir.get_branch_transport(None)
1132
control_files = lockable_files.LockableFiles(transport, 'lock',
1134
return BzrBranch5(_format=self,
1135
_control_files=control_files,
1137
_repository=a_bzrdir.find_repository())
1139
raise NotBranchError(path=transport.base)
1142
class BzrBranchFormat6(BzrBranchFormat5):
1143
"""Branch format with last-revision
1145
Unlike previous formats, this has no explicit revision history. Instead,
1146
this just stores the last-revision, and the left-hand history leading
1147
up to there is the history.
1149
This format was introduced in bzr 0.15
1152
def get_format_string(self):
1153
"""See BranchFormat.get_format_string()."""
1154
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1156
def get_format_description(self):
1157
"""See BranchFormat.get_format_description()."""
1158
return "Branch format 6"
1160
def initialize(self, a_bzrdir):
1161
"""Create a branch of this format in a_bzrdir."""
1162
utf8_files = [('last-revision', '0 null:\n'),
1163
('branch-name', ''),
1164
('branch.conf', ''),
1167
return self._initialize_helper(a_bzrdir, utf8_files)
1169
def open(self, a_bzrdir, _found=False):
1170
"""Return the branch object for a_bzrdir
1172
_found is a private parameter, do not use it. It is used to indicate
1173
if format probing has already be done.
1176
format = BranchFormat.find_format(a_bzrdir)
1177
assert format.__class__ == self.__class__
1178
transport = a_bzrdir.get_branch_transport(None)
1179
control_files = lockable_files.LockableFiles(transport, 'lock',
1181
return BzrBranch6(_format=self,
1182
_control_files=control_files,
1184
_repository=a_bzrdir.find_repository())
1186
def supports_tags(self):
1190
class BranchReferenceFormat(BranchFormat):
1191
"""Bzr branch reference format.
1193
Branch references are used in implementing checkouts, they
1194
act as an alias to the real branch which is at some other url.
1201
def get_format_string(self):
1202
"""See BranchFormat.get_format_string()."""
1203
return "Bazaar-NG Branch Reference Format 1\n"
1205
def get_format_description(self):
1206
"""See BranchFormat.get_format_description()."""
1207
return "Checkout reference format 1"
1209
def get_reference(self, a_bzrdir):
1210
"""See BranchFormat.get_reference()."""
1211
transport = a_bzrdir.get_branch_transport(None)
1212
return transport.get('location').read()
1214
def initialize(self, a_bzrdir, target_branch=None):
1215
"""Create a branch of this format in a_bzrdir."""
1216
if target_branch is None:
1217
# this format does not implement branch itself, thus the implicit
1218
# creation contract must see it as uninitializable
1219
raise errors.UninitializableFormat(self)
1220
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1221
branch_transport = a_bzrdir.get_branch_transport(self)
1222
branch_transport.put_bytes('location',
1223
target_branch.bzrdir.root_transport.base)
1224
branch_transport.put_bytes('format', self.get_format_string())
1225
return self.open(a_bzrdir, _found=True)
1228
super(BranchReferenceFormat, self).__init__()
1229
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1231
def _make_reference_clone_function(format, a_branch):
1232
"""Create a clone() routine for a branch dynamically."""
1233
def clone(to_bzrdir, revision_id=None):
1234
"""See Branch.clone()."""
1235
return format.initialize(to_bzrdir, a_branch)
1236
# cannot obey revision_id limits when cloning a reference ...
1237
# FIXME RBC 20060210 either nuke revision_id for clone, or
1238
# emit some sort of warning/error to the caller ?!
1241
def open(self, a_bzrdir, _found=False, location=None):
1242
"""Return the branch that the branch reference in a_bzrdir points at.
1244
_found is a private parameter, do not use it. It is used to indicate
1245
if format probing has already be done.
1248
format = BranchFormat.find_format(a_bzrdir)
1249
assert format.__class__ == self.__class__
1250
if location is None:
1251
location = self.get_reference(a_bzrdir)
1252
real_bzrdir = bzrdir.BzrDir.open(location)
1253
result = real_bzrdir.open_branch()
1254
# this changes the behaviour of result.clone to create a new reference
1255
# rather than a copy of the content of the branch.
1256
# I did not use a proxy object because that needs much more extensive
1257
# testing, and we are only changing one behaviour at the moment.
1258
# If we decide to alter more behaviours - i.e. the implicit nickname
1259
# then this should be refactored to introduce a tested proxy branch
1260
# and a subclass of that for use in overriding clone() and ....
1262
result.clone = self._make_reference_clone_function(result)
1266
# formats which have no format string are not discoverable
1267
# and not independently creatable, so are not registered.
1268
__default_format = BzrBranchFormat5()
1269
BranchFormat.register_format(__default_format)
1270
BranchFormat.register_format(BranchReferenceFormat())
1271
BranchFormat.register_format(BzrBranchFormat6())
1272
BranchFormat.set_default_format(__default_format)
1273
_legacy_formats = [BzrBranchFormat4(),
1276
class BzrBranch(Branch):
1277
"""A branch stored in the actual filesystem.
1279
Note that it's "local" in the context of the filesystem; it doesn't
1280
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1281
it's writable, and can be accessed via the normal filesystem API.
1284
def __init__(self, _format=None,
1285
_control_files=None, a_bzrdir=None, _repository=None):
1286
"""Create new branch object at a particular location."""
1287
Branch.__init__(self)
1288
if a_bzrdir is None:
1289
raise ValueError('a_bzrdir must be supplied')
1291
self.bzrdir = a_bzrdir
1292
# self._transport used to point to the directory containing the
1293
# control directory, but was not used - now it's just the transport
1294
# for the branch control files. mbp 20070212
1295
self._base = self.bzrdir.transport.clone('..').base
1296
self._format = _format
1297
if _control_files is None:
1298
raise ValueError('BzrBranch _control_files is None')
1299
self.control_files = _control_files
1300
self._transport = _control_files._transport
1301
self.repository = _repository
1304
return '%s(%r)' % (self.__class__.__name__, self.base)
1308
def _get_base(self):
1309
"""Returns the directory containing the control directory."""
1312
base = property(_get_base, doc="The URL for the root of this branch.")
1314
def abspath(self, name):
1315
"""See Branch.abspath."""
1316
return self.control_files._transport.abspath(name)
1319
@deprecated_method(zero_sixteen)
1321
def get_root_id(self):
1322
"""See Branch.get_root_id."""
1323
tree = self.repository.revision_tree(self.last_revision())
1324
return tree.inventory.root.file_id
1326
def is_locked(self):
1327
return self.control_files.is_locked()
1329
def lock_write(self, token=None):
1330
repo_token = self.repository.lock_write()
1332
token = self.control_files.lock_write(token=token)
1334
self.repository.unlock()
1338
def lock_read(self):
1339
self.repository.lock_read()
1341
self.control_files.lock_read()
1343
self.repository.unlock()
1347
# TODO: test for failed two phase locks. This is known broken.
1349
self.control_files.unlock()
1351
self.repository.unlock()
1352
if not self.control_files.is_locked():
1353
# we just released the lock
1354
self._clear_cached_state()
1356
def peek_lock_mode(self):
1357
if self.control_files._lock_count == 0:
1360
return self.control_files._lock_mode
1362
def get_physical_lock_status(self):
1363
return self.control_files.get_physical_lock_status()
1366
def print_file(self, file, revision_id):
1367
"""See Branch.print_file."""
1368
return self.repository.print_file(file, revision_id)
1371
def append_revision(self, *revision_ids):
1372
"""See Branch.append_revision."""
1373
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1374
for revision_id in revision_ids:
1375
_mod_revision.check_not_reserved_id(revision_id)
1376
mutter("add {%s} to revision-history" % revision_id)
1377
rev_history = self.revision_history()
1378
rev_history.extend(revision_ids)
1379
self.set_revision_history(rev_history)
1381
def _write_revision_history(self, history):
1382
"""Factored out of set_revision_history.
1384
This performs the actual writing to disk.
1385
It is intended to be called by BzrBranch5.set_revision_history."""
1386
self.control_files.put_bytes(
1387
'revision-history', '\n'.join(history))
1390
def set_revision_history(self, rev_history):
1391
"""See Branch.set_revision_history."""
1392
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1393
self._clear_cached_state()
1394
self._write_revision_history(rev_history)
1395
self._cache_revision_history(rev_history)
1396
for hook in Branch.hooks['set_rh']:
1397
hook(self, rev_history)
1400
def set_last_revision_info(self, revno, revision_id):
1401
revision_id = osutils.safe_revision_id(revision_id)
1402
history = self._lefthand_history(revision_id)
1403
assert len(history) == revno, '%d != %d' % (len(history), revno)
1404
self.set_revision_history(history)
1406
def _gen_revision_history(self):
1407
history = self.control_files.get('revision-history').read().split('\n')
1408
if history[-1:] == ['']:
1409
# There shouldn't be a trailing newline, but just in case.
1413
def _lefthand_history(self, revision_id, last_rev=None,
1415
# stop_revision must be a descendant of last_revision
1416
stop_graph = self.repository.get_revision_graph(revision_id)
1417
if last_rev is not None and last_rev not in stop_graph:
1418
# our previous tip is not merged into stop_revision
1419
raise errors.DivergedBranches(self, other_branch)
1420
# make a new revision history from the graph
1421
current_rev_id = revision_id
1423
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1424
new_history.append(current_rev_id)
1425
current_rev_id_parents = stop_graph[current_rev_id]
1427
current_rev_id = current_rev_id_parents[0]
1429
current_rev_id = None
1430
new_history.reverse()
1434
def generate_revision_history(self, revision_id, last_rev=None,
1436
"""Create a new revision history that will finish with revision_id.
1438
:param revision_id: the new tip to use.
1439
:param last_rev: The previous last_revision. If not None, then this
1440
must be a ancestory of revision_id, or DivergedBranches is raised.
1441
:param other_branch: The other branch that DivergedBranches should
1442
raise with respect to.
1444
revision_id = osutils.safe_revision_id(revision_id)
1445
self.set_revision_history(self._lefthand_history(revision_id,
1446
last_rev, other_branch))
1449
def update_revisions(self, other, stop_revision=None):
1450
"""See Branch.update_revisions."""
1453
if stop_revision is None:
1454
stop_revision = other.last_revision()
1455
if stop_revision is None:
1456
# if there are no commits, we're done.
1459
stop_revision = osutils.safe_revision_id(stop_revision)
1460
# whats the current last revision, before we fetch [and change it
1462
last_rev = self.last_revision()
1463
# we fetch here regardless of whether we need to so that we pickup
1465
self.fetch(other, stop_revision)
1466
my_ancestry = self.repository.get_ancestry(last_rev)
1467
if stop_revision in my_ancestry:
1468
# last_revision is a descendant of stop_revision
1470
self.generate_revision_history(stop_revision, last_rev=last_rev,
1475
def basis_tree(self):
1476
"""See Branch.basis_tree."""
1477
return self.repository.revision_tree(self.last_revision())
1479
@deprecated_method(zero_eight)
1480
def working_tree(self):
1481
"""Create a Working tree object for this branch."""
1483
from bzrlib.transport.local import LocalTransport
1484
if (self.base.find('://') != -1 or
1485
not isinstance(self._transport, LocalTransport)):
1486
raise NoWorkingTree(self.base)
1487
return self.bzrdir.open_workingtree()
1490
def pull(self, source, overwrite=False, stop_revision=None,
1491
_hook_master=None, _run_hooks=True):
1494
:param _hook_master: Private parameter - set the branch to
1495
be supplied as the master to push hooks.
1496
:param _run_hooks: Private parameter - allow disabling of
1497
hooks, used when pushing to a master branch.
1499
result = PullResult()
1500
result.source_branch = source
1501
result.target_branch = self
1504
result.old_revno, result.old_revid = self.last_revision_info()
1506
self.update_revisions(source, stop_revision)
1507
except DivergedBranches:
1511
if stop_revision is None:
1512
stop_revision = source.last_revision()
1513
self.generate_revision_history(stop_revision)
1514
result.tag_conflicts = source.tags.merge_to(self.tags)
1515
result.new_revno, result.new_revid = self.last_revision_info()
1517
result.master_branch = _hook_master
1518
result.local_branch = self
1520
result.master_branch = self
1521
result.local_branch = None
1523
for hook in Branch.hooks['post_pull']:
1529
def _get_parent_location(self):
1530
_locs = ['parent', 'pull', 'x-pull']
1533
return self.control_files.get(l).read().strip('\n')
1539
def push(self, target, overwrite=False, stop_revision=None,
1540
_hook_master=None, _run_hooks=True):
1543
:param _hook_master: Private parameter - set the branch to
1544
be supplied as the master to push hooks.
1545
:param _run_hooks: Private parameter - allow disabling of
1546
hooks, used when pushing to a master branch.
1548
result = PushResult()
1549
result.source_branch = self
1550
result.target_branch = target
1553
result.old_revno, result.old_revid = target.last_revision_info()
1555
target.update_revisions(self, stop_revision)
1556
except DivergedBranches:
1560
target.set_revision_history(self.revision_history())
1561
result.tag_conflicts = self.tags.merge_to(target.tags)
1562
result.new_revno, result.new_revid = target.last_revision_info()
1564
result.master_branch = _hook_master
1565
result.local_branch = target
1567
result.master_branch = target
1568
result.local_branch = None
1570
for hook in Branch.hooks['post_push']:
1576
def get_parent(self):
1577
"""See Branch.get_parent."""
1579
assert self.base[-1] == '/'
1580
parent = self._get_parent_location()
1583
# This is an old-format absolute path to a local branch
1584
# turn it into a url
1585
if parent.startswith('/'):
1586
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1588
return urlutils.join(self.base[:-1], parent)
1589
except errors.InvalidURLJoin, e:
1590
raise errors.InaccessibleParent(parent, self.base)
1592
def set_push_location(self, location):
1593
"""See Branch.set_push_location."""
1594
self.get_config().set_user_option(
1595
'push_location', location,
1596
store=_mod_config.STORE_LOCATION_NORECURSE)
1599
def set_parent(self, url):
1600
"""See Branch.set_parent."""
1601
# TODO: Maybe delete old location files?
1602
# URLs should never be unicode, even on the local fs,
1603
# FIXUP this and get_parent in a future branch format bump:
1604
# read and rewrite the file, and have the new format code read
1605
# using .get not .get_utf8. RBC 20060125
1607
if isinstance(url, unicode):
1609
url = url.encode('ascii')
1610
except UnicodeEncodeError:
1611
raise errors.InvalidURL(url,
1612
"Urls must be 7-bit ascii, "
1613
"use bzrlib.urlutils.escape")
1614
url = urlutils.relative_url(self.base, url)
1615
self._set_parent_location(url)
1617
def _set_parent_location(self, url):
1619
self.control_files._transport.delete('parent')
1621
assert isinstance(url, str)
1622
self.control_files.put_bytes('parent', url + '\n')
1624
@deprecated_function(zero_nine)
1625
def tree_config(self):
1626
"""DEPRECATED; call get_config instead.
1627
TreeConfig has become part of BranchConfig."""
1628
return TreeConfig(self)
1631
class BzrBranch5(BzrBranch):
1632
"""A format 5 branch. This supports new features over plan branches.
1634
It has support for a master_branch which is the data for bound branches.
1642
super(BzrBranch5, self).__init__(_format=_format,
1643
_control_files=_control_files,
1645
_repository=_repository)
1648
def pull(self, source, overwrite=False, stop_revision=None,
1650
"""Extends branch.pull to be bound branch aware.
1652
:param _run_hooks: Private parameter used to force hook running
1653
off during bound branch double-pushing.
1655
bound_location = self.get_bound_location()
1656
master_branch = None
1657
if bound_location and source.base != bound_location:
1658
# not pulling from master, so we need to update master.
1659
master_branch = self.get_master_branch()
1660
master_branch.lock_write()
1663
# pull from source into master.
1664
master_branch.pull(source, overwrite, stop_revision,
1666
return super(BzrBranch5, self).pull(source, overwrite,
1667
stop_revision, _hook_master=master_branch,
1668
_run_hooks=_run_hooks)
1671
master_branch.unlock()
1674
def push(self, target, overwrite=False, stop_revision=None):
1675
"""Updates branch.push to be bound branch aware."""
1676
bound_location = target.get_bound_location()
1677
master_branch = None
1678
if bound_location and target.base != bound_location:
1679
# not pushing to master, so we need to update master.
1680
master_branch = target.get_master_branch()
1681
master_branch.lock_write()
1684
# push into the master from this branch.
1685
super(BzrBranch5, self).push(master_branch, overwrite,
1686
stop_revision, _run_hooks=False)
1687
# and push into the target branch from this. Note that we push from
1688
# this branch again, because its considered the highest bandwidth
1690
return super(BzrBranch5, self).push(target, overwrite,
1691
stop_revision, _hook_master=master_branch)
1694
master_branch.unlock()
1696
def get_bound_location(self):
1698
return self.control_files.get_utf8('bound').read()[:-1]
1699
except errors.NoSuchFile:
1703
def get_master_branch(self):
1704
"""Return the branch we are bound to.
1706
:return: Either a Branch, or None
1708
This could memoise the branch, but if thats done
1709
it must be revalidated on each new lock.
1710
So for now we just don't memoise it.
1711
# RBC 20060304 review this decision.
1713
bound_loc = self.get_bound_location()
1717
return Branch.open(bound_loc)
1718
except (errors.NotBranchError, errors.ConnectionError), e:
1719
raise errors.BoundBranchConnectionFailure(
1723
def set_bound_location(self, location):
1724
"""Set the target where this branch is bound to.
1726
:param location: URL to the target branch
1729
self.control_files.put_utf8('bound', location+'\n')
1732
self.control_files._transport.delete('bound')
1738
def bind(self, other):
1739
"""Bind this branch to the branch other.
1741
This does not push or pull data between the branches, though it does
1742
check for divergence to raise an error when the branches are not
1743
either the same, or one a prefix of the other. That behaviour may not
1744
be useful, so that check may be removed in future.
1746
:param other: The branch to bind to
1749
# TODO: jam 20051230 Consider checking if the target is bound
1750
# It is debatable whether you should be able to bind to
1751
# a branch which is itself bound.
1752
# Committing is obviously forbidden,
1753
# but binding itself may not be.
1754
# Since we *have* to check at commit time, we don't
1755
# *need* to check here
1757
# we want to raise diverged if:
1758
# last_rev is not in the other_last_rev history, AND
1759
# other_last_rev is not in our history, and do it without pulling
1761
last_rev = self.last_revision()
1762
if last_rev is not None:
1765
other_last_rev = other.last_revision()
1766
if other_last_rev is not None:
1767
# neither branch is new, we have to do some work to
1768
# ascertain diversion.
1769
remote_graph = other.repository.get_revision_graph(
1771
local_graph = self.repository.get_revision_graph(last_rev)
1772
if (last_rev not in remote_graph and
1773
other_last_rev not in local_graph):
1774
raise errors.DivergedBranches(self, other)
1777
self.set_bound_location(other.base)
1781
"""If bound, unbind"""
1782
return self.set_bound_location(None)
1786
"""Synchronise this branch with the master branch if any.
1788
:return: None or the last_revision that was pivoted out during the
1791
master = self.get_master_branch()
1792
if master is not None:
1793
old_tip = self.last_revision()
1794
self.pull(master, overwrite=True)
1795
if old_tip in self.repository.get_ancestry(self.last_revision()):
1801
class BzrBranchExperimental(BzrBranch5):
1802
"""Bzr experimental branch format
1805
- a revision-history file.
1807
- a lock dir guarding the branch itself
1808
- all of this stored in a branch/ subdirectory
1809
- works with shared repositories.
1810
- a tag dictionary in the branch
1812
This format is new in bzr 0.15, but shouldn't be used for real data,
1815
This class acts as it's own BranchFormat.
1818
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1821
def get_format_string(cls):
1822
"""See BranchFormat.get_format_string()."""
1823
return "Bazaar-NG branch format experimental\n"
1826
def get_format_description(cls):
1827
"""See BranchFormat.get_format_description()."""
1828
return "Experimental branch format"
1831
def get_reference(cls, a_bzrdir):
1832
"""Get the target reference of the branch in a_bzrdir.
1834
format probing must have been completed before calling
1835
this method - it is assumed that the format of the branch
1836
in a_bzrdir is correct.
1838
:param a_bzrdir: The bzrdir to get the branch data from.
1839
:return: None if the branch is not a reference branch.
1844
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1846
branch_transport = a_bzrdir.get_branch_transport(cls)
1847
control_files = lockable_files.LockableFiles(branch_transport,
1848
lock_filename, lock_class)
1849
control_files.create_lock()
1850
control_files.lock_write()
1852
for filename, content in utf8_files:
1853
control_files.put_utf8(filename, content)
1855
control_files.unlock()
1858
def initialize(cls, a_bzrdir):
1859
"""Create a branch of this format in a_bzrdir."""
1860
utf8_files = [('format', cls.get_format_string()),
1861
('revision-history', ''),
1862
('branch-name', ''),
1865
cls._initialize_control_files(a_bzrdir, utf8_files,
1866
'lock', lockdir.LockDir)
1867
return cls.open(a_bzrdir, _found=True)
1870
def open(cls, a_bzrdir, _found=False):
1871
"""Return the branch object for a_bzrdir
1873
_found is a private parameter, do not use it. It is used to indicate
1874
if format probing has already be done.
1877
format = BranchFormat.find_format(a_bzrdir)
1878
assert format.__class__ == cls
1879
transport = a_bzrdir.get_branch_transport(None)
1880
control_files = lockable_files.LockableFiles(transport, 'lock',
1882
return cls(_format=cls,
1883
_control_files=control_files,
1885
_repository=a_bzrdir.find_repository())
1888
def is_supported(cls):
1891
def _make_tags(self):
1892
return BasicTags(self)
1895
def supports_tags(cls):
1899
BranchFormat.register_format(BzrBranchExperimental)
1902
class BzrBranch6(BzrBranch5):
1905
def last_revision_info(self):
1906
revision_string = self.control_files.get('last-revision').read()
1907
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1908
revision_id = cache_utf8.get_cached_utf8(revision_id)
1910
return revno, revision_id
1912
def last_revision(self):
1913
"""Return last revision id, or None"""
1914
revision_id = self.last_revision_info()[1]
1915
if revision_id == _mod_revision.NULL_REVISION:
1919
def _write_last_revision_info(self, revno, revision_id):
1920
"""Simply write out the revision id, with no checks.
1922
Use set_last_revision_info to perform this safely.
1924
Does not update the revision_history cache.
1925
Intended to be called by set_last_revision_info and
1926
_write_revision_history.
1928
if revision_id is None:
1929
revision_id = 'null:'
1930
out_string = '%d %s\n' % (revno, revision_id)
1931
self.control_files.put_bytes('last-revision', out_string)
1934
def set_last_revision_info(self, revno, revision_id):
1935
revision_id = osutils.safe_revision_id(revision_id)
1936
if self._get_append_revisions_only():
1937
self._check_history_violation(revision_id)
1938
self._write_last_revision_info(revno, revision_id)
1939
self._clear_cached_state()
1941
def _check_history_violation(self, revision_id):
1942
last_revision = self.last_revision()
1943
if last_revision is None:
1945
if last_revision not in self._lefthand_history(revision_id):
1946
raise errors.AppendRevisionsOnlyViolation(self.base)
1948
def _gen_revision_history(self):
1949
"""Generate the revision history from last revision
1951
history = list(self.repository.iter_reverse_revision_history(
1952
self.last_revision()))
1956
def _write_revision_history(self, history):
1957
"""Factored out of set_revision_history.
1959
This performs the actual writing to disk, with format-specific checks.
1960
It is intended to be called by BzrBranch5.set_revision_history.
1962
if len(history) == 0:
1963
last_revision = 'null:'
1965
if history != self._lefthand_history(history[-1]):
1966
raise errors.NotLefthandHistory(history)
1967
last_revision = history[-1]
1968
if self._get_append_revisions_only():
1969
self._check_history_violation(last_revision)
1970
self._write_last_revision_info(len(history), last_revision)
1973
def append_revision(self, *revision_ids):
1974
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1975
if len(revision_ids) == 0:
1977
prev_revno, prev_revision = self.last_revision_info()
1978
for revision in self.repository.get_revisions(revision_ids):
1979
if prev_revision == _mod_revision.NULL_REVISION:
1980
if revision.parent_ids != []:
1981
raise errors.NotLeftParentDescendant(self, prev_revision,
1982
revision.revision_id)
1984
if revision.parent_ids[0] != prev_revision:
1985
raise errors.NotLeftParentDescendant(self, prev_revision,
1986
revision.revision_id)
1987
prev_revision = revision.revision_id
1988
self.set_last_revision_info(prev_revno + len(revision_ids),
1992
def _set_parent_location(self, url):
1993
"""Set the parent branch"""
1994
self._set_config_location('parent_location', url, make_relative=True)
1997
def _get_parent_location(self):
1998
"""Set the parent branch"""
1999
return self._get_config_location('parent_location')
2001
def set_push_location(self, location):
2002
"""See Branch.set_push_location."""
2003
self._set_config_location('push_location', location)
2005
def set_bound_location(self, location):
2006
"""See Branch.set_push_location."""
2008
config = self.get_config()
2009
if location is None:
2010
if config.get_user_option('bound') != 'True':
2013
config.set_user_option('bound', 'False')
2016
self._set_config_location('bound_location', location,
2018
config.set_user_option('bound', 'True')
2021
def _get_bound_location(self, bound):
2022
"""Return the bound location in the config file.
2024
Return None if the bound parameter does not match"""
2025
config = self.get_config()
2026
config_bound = (config.get_user_option('bound') == 'True')
2027
if config_bound != bound:
2029
return self._get_config_location('bound_location', config=config)
2031
def get_bound_location(self):
2032
"""See Branch.set_push_location."""
2033
return self._get_bound_location(True)
2035
def get_old_bound_location(self):
2036
"""See Branch.get_old_bound_location"""
2037
return self._get_bound_location(False)
2039
def set_append_revisions_only(self, enabled):
2044
self.get_config().set_user_option('append_revisions_only', value)
2046
def _get_append_revisions_only(self):
2047
value = self.get_config().get_user_option('append_revisions_only')
2048
return value == 'True'
2050
def _synchronize_history(self, destination, revision_id):
2051
"""Synchronize last revision and revision history between branches.
2053
This version is most efficient when the destination is also a
2054
BzrBranch6, but works for BzrBranch5, as long as the destination's
2055
repository contains all the lefthand ancestors of the intended
2056
last_revision. If not, set_last_revision_info will fail.
2058
:param destination: The branch to copy the history into
2059
:param revision_id: The revision-id to truncate history at. May
2060
be None to copy complete history.
2062
if revision_id is None:
2063
revno, revision_id = self.last_revision_info()
2065
revno = self.revision_id_to_revno(revision_id)
2066
destination.set_last_revision_info(revno, revision_id)
2068
def _make_tags(self):
2069
return BasicTags(self)
2072
class BranchTestProviderAdapter(object):
2073
"""A tool to generate a suite testing multiple branch formats at once.
2075
This is done by copying the test once for each transport and injecting
2076
the transport_server, transport_readonly_server, and branch_format
2077
classes into each copy. Each copy is also given a new id() to make it
2081
def __init__(self, transport_server, transport_readonly_server, formats,
2082
vfs_transport_factory=None):
2083
self._transport_server = transport_server
2084
self._transport_readonly_server = transport_readonly_server
2085
self._formats = formats
2087
def adapt(self, test):
2088
result = TestSuite()
2089
for branch_format, bzrdir_format in self._formats:
2090
new_test = deepcopy(test)
2091
new_test.transport_server = self._transport_server
2092
new_test.transport_readonly_server = self._transport_readonly_server
2093
new_test.bzrdir_format = bzrdir_format
2094
new_test.branch_format = branch_format
2095
def make_new_test_id():
2096
# the format can be either a class or an instance
2097
name = getattr(branch_format, '__name__',
2098
branch_format.__class__.__name__)
2099
new_id = "%s(%s)" % (new_test.id(), name)
2100
return lambda: new_id
2101
new_test.id = make_new_test_id()
2102
result.addTest(new_test)
2106
######################################################################
2107
# results of operations
2110
class _Result(object):
2112
def _show_tag_conficts(self, to_file):
2113
if not getattr(self, 'tag_conflicts', None):
2115
to_file.write('Conflicting tags:\n')
2116
for name, value1, value2 in self.tag_conflicts:
2117
to_file.write(' %s\n' % (name, ))
2120
class PullResult(_Result):
2121
"""Result of a Branch.pull operation.
2123
:ivar old_revno: Revision number before pull.
2124
:ivar new_revno: Revision number after pull.
2125
:ivar old_revid: Tip revision id before pull.
2126
:ivar new_revid: Tip revision id after pull.
2127
:ivar source_branch: Source (local) branch object.
2128
:ivar master_branch: Master branch of the target, or None.
2129
:ivar target_branch: Target/destination branch object.
2133
# DEPRECATED: pull used to return the change in revno
2134
return self.new_revno - self.old_revno
2136
def report(self, to_file):
2137
if self.old_revid == self.new_revid:
2138
to_file.write('No revisions to pull.\n')
2140
to_file.write('Now on revision %d.\n' % self.new_revno)
2141
self._show_tag_conficts(to_file)
2144
class PushResult(_Result):
2145
"""Result of a Branch.push operation.
2147
:ivar old_revno: Revision number before push.
2148
:ivar new_revno: Revision number after push.
2149
:ivar old_revid: Tip revision id before push.
2150
:ivar new_revid: Tip revision id after push.
2151
:ivar source_branch: Source branch object.
2152
:ivar master_branch: Master branch of the target, or None.
2153
:ivar target_branch: Target/destination branch object.
2157
# DEPRECATED: push used to return the change in revno
2158
return self.new_revno - self.old_revno
2160
def report(self, to_file):
2161
"""Write a human-readable description of the result."""
2162
if self.old_revid == self.new_revid:
2163
to_file.write('No new revisions to push.\n')
2165
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2166
self._show_tag_conficts(to_file)
2169
class BranchCheckResult(object):
2170
"""Results of checking branch consistency.
2175
def __init__(self, branch):
2176
self.branch = branch
2178
def report_results(self, verbose):
2179
"""Report the check results via trace.note.
2181
:param verbose: Requests more detailed display of what was checked,
2184
note('checked branch %s format %s',
2186
self.branch._format)
2189
class Converter5to6(object):
2190
"""Perform an in-place upgrade of format 5 to format 6"""
2192
def convert(self, branch):
2193
# Data for 5 and 6 can peacefully coexist.
2194
format = BzrBranchFormat6()
2195
new_branch = format.open(branch.bzrdir, _found=True)
2197
# Copy source data into target
2198
new_branch.set_last_revision_info(*branch.last_revision_info())
2199
new_branch.set_parent(branch.get_parent())
2200
new_branch.set_bound_location(branch.get_bound_location())
2201
new_branch.set_push_location(branch.get_push_location())
2203
# New branch has no tags by default
2204
new_branch.tags._set_tag_dict({})
2206
# Copying done; now update target format
2207
new_branch.control_files.put_utf8('format',
2208
format.get_format_string())
2210
# Clean up old files
2211
new_branch.control_files._transport.delete('revision-history')
2213
branch.set_parent(None)
2216
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
