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 warnings import warn
28
config as _mod_config,
33
revision as _mod_revision,
40
from bzrlib.config import BranchConfig, TreeConfig
41
from bzrlib.lockable_files import LockableFiles, TransportLock
42
from bzrlib.tag import (
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
49
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
50
HistoryMissing, InvalidRevisionId,
51
InvalidRevisionNumber, LockError, NoSuchFile,
52
NoSuchRevision, NotVersionedError,
53
NotBranchError, UninitializableFormat,
54
UnlistableStore, UnlistableBranch,
56
from bzrlib.hooks import Hooks
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine, zero_sixteen,
64
from bzrlib.trace import mutter, note
67
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
68
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
69
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
72
# TODO: Maybe include checks for common corruption of newlines, etc?
74
# TODO: Some operations like log might retrieve the same revisions
75
# repeatedly to calculate deltas. We could perhaps have a weakref
76
# cache in memory to make this faster. In general anything can be
77
# cached in memory between lock and unlock operations. .. nb thats
78
# what the transaction identity map provides
81
######################################################################
85
"""Branch holding a history of revisions.
88
Base directory/url of the branch.
90
hooks: An instance of BranchHooks.
92
# this is really an instance variable - FIXME move it there
96
# override this to set the strategy for storing tags
98
return DisabledTags(self)
100
def __init__(self, *ignored, **ignored_too):
101
self.tags = self._make_tags()
102
self._revision_history_cache = None
103
self._revision_id_to_revno_cache = None
105
def break_lock(self):
106
"""Break a lock if one is present from another instance.
108
Uses the ui factory to ask for confirmation if the lock may be from
111
This will probe the repository for its lock as well.
113
self.control_files.break_lock()
114
self.repository.break_lock()
115
master = self.get_master_branch()
116
if master is not None:
120
def open(base, _unsupported=False, possible_transports=None):
121
"""Open the branch rooted at base.
123
For instance, if the branch is at URL/.bzr/branch,
124
Branch.open(URL) -> a Branch instance.
126
control = bzrdir.BzrDir.open(base, _unsupported,
127
possible_transports=possible_transports)
128
return control.open_branch(_unsupported)
131
def open_from_transport(transport, _unsupported=False):
132
"""Open the branch rooted at transport"""
133
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
134
return control.open_branch(_unsupported)
137
def open_containing(url, possible_transports=None):
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,
150
return control.open_branch(), relpath
152
def get_config(self):
153
return BranchConfig(self)
156
return self.get_config().get_nickname()
158
def _set_nick(self, nick):
159
self.get_config().set_user_option('nickname', nick, warn_masked=True)
161
nick = property(_get_nick, _set_nick)
164
raise NotImplementedError(self.is_locked)
166
def lock_write(self):
167
raise NotImplementedError(self.lock_write)
170
raise NotImplementedError(self.lock_read)
173
raise NotImplementedError(self.unlock)
175
def peek_lock_mode(self):
176
"""Return lock mode for the Branch: 'r', 'w' or None"""
177
raise NotImplementedError(self.peek_lock_mode)
179
def get_physical_lock_status(self):
180
raise NotImplementedError(self.get_physical_lock_status)
183
def get_revision_id_to_revno_map(self):
184
"""Return the revision_id => dotted revno map.
186
This will be regenerated on demand, but will be cached.
188
:return: A dictionary mapping revision_id => dotted revno.
189
This dictionary should not be modified by the caller.
191
if self._revision_id_to_revno_cache is not None:
192
mapping = self._revision_id_to_revno_cache
194
mapping = self._gen_revno_map()
195
self._cache_revision_id_to_revno(mapping)
196
# TODO: jam 20070417 Since this is being cached, should we be returning
198
# I would rather not, and instead just declare that users should not
199
# modify the return value.
202
def _gen_revno_map(self):
203
"""Create a new mapping from revision ids to dotted revnos.
205
Dotted revnos are generated based on the current tip in the revision
207
This is the worker function for get_revision_id_to_revno_map, which
208
just caches the return value.
210
:return: A dictionary mapping revision_id => dotted revno.
212
last_revision = self.last_revision()
213
revision_graph = self.repository.get_revision_graph(last_revision)
214
merge_sorted_revisions = tsort.merge_sort(
219
revision_id_to_revno = dict((rev_id, revno)
220
for seq_num, rev_id, depth, revno, end_of_merge
221
in merge_sorted_revisions)
222
return revision_id_to_revno
224
def leave_lock_in_place(self):
225
"""Tell this branch object not to release the physical lock when this
228
If lock_write doesn't return a token, then this method is not supported.
230
self.control_files.leave_in_place()
232
def dont_leave_lock_in_place(self):
233
"""Tell this branch object to release the physical lock when this
234
object is unlocked, even if it didn't originally acquire it.
236
If lock_write doesn't return a token, then this method is not supported.
238
self.control_files.dont_leave_in_place()
240
def abspath(self, name):
241
"""Return absolute filename for something in the branch
243
XXX: Robert Collins 20051017 what is this used for? why is it a branch
244
method and not a tree method.
246
raise NotImplementedError(self.abspath)
248
def bind(self, other):
249
"""Bind the local branch the other branch.
251
:param other: The branch to bind to
254
raise errors.UpgradeRequired(self.base)
257
def fetch(self, from_branch, last_revision=None, pb=None):
258
"""Copy revisions from from_branch into this branch.
260
:param from_branch: Where to copy from.
261
:param last_revision: What revision to stop at (None for at the end
263
:param pb: An optional progress bar to use.
265
Returns the copied revision count and the failed revisions in a tuple:
268
if self.base == from_branch.base:
271
nested_pb = ui.ui_factory.nested_progress_bar()
276
from_branch.lock_read()
278
if last_revision is None:
279
pb.update('get source history')
280
last_revision = from_branch.last_revision()
281
if last_revision is None:
282
last_revision = _mod_revision.NULL_REVISION
283
return self.repository.fetch(from_branch.repository,
284
revision_id=last_revision,
287
if nested_pb is not None:
291
def get_bound_location(self):
292
"""Return the URL of the branch we are bound to.
294
Older format branches cannot bind, please be sure to use a metadir
299
def get_old_bound_location(self):
300
"""Return the URL of the branch we used to be bound to
302
raise errors.UpgradeRequired(self.base)
304
def get_commit_builder(self, parents, config=None, timestamp=None,
305
timezone=None, committer=None, revprops=None,
307
"""Obtain a CommitBuilder for this branch.
309
:param parents: Revision ids of the parents of the new revision.
310
:param config: Optional configuration to use.
311
:param timestamp: Optional timestamp recorded for commit.
312
:param timezone: Optional timezone for timestamp.
313
:param committer: Optional committer to set for commit.
314
:param revprops: Optional dictionary of revision properties.
315
:param revision_id: Optional revision id.
319
config = self.get_config()
321
return self.repository.get_commit_builder(self, parents, config,
322
timestamp, timezone, committer, revprops, revision_id)
324
def get_master_branch(self, possible_transports=None):
325
"""Return the branch we are bound to.
327
:return: Either a Branch, or None
331
def get_revision_delta(self, revno):
332
"""Return the delta for one revision.
334
The delta is relative to its mainline predecessor, or the
335
empty tree for revision 1.
337
assert isinstance(revno, int)
338
rh = self.revision_history()
339
if not (1 <= revno <= len(rh)):
340
raise InvalidRevisionNumber(revno)
341
return self.repository.get_revision_delta(rh[revno-1])
343
@deprecated_method(zero_sixteen)
344
def get_root_id(self):
345
"""Return the id of this branches root
347
Deprecated: branches don't have root ids-- trees do.
348
Use basis_tree().get_root_id() instead.
350
raise NotImplementedError(self.get_root_id)
352
def print_file(self, file, revision_id):
353
"""Print `file` to stdout."""
354
raise NotImplementedError(self.print_file)
356
def set_revision_history(self, rev_history):
357
raise NotImplementedError(self.set_revision_history)
359
def _cache_revision_history(self, rev_history):
360
"""Set the cached revision history to rev_history.
362
The revision_history method will use this cache to avoid regenerating
363
the revision history.
365
This API is semi-public; it only for use by subclasses, all other code
366
should consider it to be private.
368
self._revision_history_cache = rev_history
370
def _cache_revision_id_to_revno(self, revision_id_to_revno):
371
"""Set the cached revision_id => revno map to revision_id_to_revno.
373
This API is semi-public; it only for use by subclasses, all other code
374
should consider it to be private.
376
self._revision_id_to_revno_cache = revision_id_to_revno
378
def _clear_cached_state(self):
379
"""Clear any cached data on this branch, e.g. cached revision history.
381
This means the next call to revision_history will need to call
382
_gen_revision_history.
384
This API is semi-public; it only for use by subclasses, all other code
385
should consider it to be private.
387
self._revision_history_cache = None
388
self._revision_id_to_revno_cache = None
390
def _gen_revision_history(self):
391
"""Return sequence of revision hashes on to this branch.
393
Unlike revision_history, this method always regenerates or rereads the
394
revision history, i.e. it does not cache the result, so repeated calls
397
Concrete subclasses should override this instead of revision_history so
398
that subclasses do not need to deal with caching logic.
400
This API is semi-public; it only for use by subclasses, all other code
401
should consider it to be private.
403
raise NotImplementedError(self._gen_revision_history)
406
def revision_history(self):
407
"""Return sequence of revision hashes on to this branch.
409
This method will cache the revision history for as long as it is safe to
412
if self._revision_history_cache is not None:
413
history = self._revision_history_cache
415
history = self._gen_revision_history()
416
self._cache_revision_history(history)
420
"""Return current revision number for this branch.
422
That is equivalent to the number of revisions committed to
425
return len(self.revision_history())
428
"""Older format branches cannot bind or unbind."""
429
raise errors.UpgradeRequired(self.base)
431
def set_append_revisions_only(self, enabled):
432
"""Older format branches are never restricted to append-only"""
433
raise errors.UpgradeRequired(self.base)
435
def last_revision(self):
436
"""Return last revision id, or None"""
437
ph = self.revision_history()
441
return _mod_revision.NULL_REVISION
443
def last_revision_info(self):
444
"""Return information about the last revision.
446
:return: A tuple (revno, last_revision_id).
448
rh = self.revision_history()
451
return (revno, rh[-1])
453
return (0, _mod_revision.NULL_REVISION)
455
def missing_revisions(self, other, stop_revision=None):
456
"""Return a list of new revisions that would perfectly fit.
458
If self and other have not diverged, return a list of the revisions
459
present in other, but missing from self.
461
self_history = self.revision_history()
462
self_len = len(self_history)
463
other_history = other.revision_history()
464
other_len = len(other_history)
465
common_index = min(self_len, other_len) -1
466
if common_index >= 0 and \
467
self_history[common_index] != other_history[common_index]:
468
raise DivergedBranches(self, other)
470
if stop_revision is None:
471
stop_revision = other_len
473
assert isinstance(stop_revision, int)
474
if stop_revision > other_len:
475
raise errors.NoSuchRevision(self, stop_revision)
476
return other_history[self_len:stop_revision]
478
def update_revisions(self, other, stop_revision=None):
479
"""Pull in new perfect-fit revisions.
481
:param other: Another Branch to pull from
482
:param stop_revision: Updated until the given revision
485
raise NotImplementedError(self.update_revisions)
487
def revision_id_to_revno(self, revision_id):
488
"""Given a revision id, return its revno"""
489
if _mod_revision.is_null(revision_id):
491
history = self.revision_history()
493
return history.index(revision_id) + 1
495
raise errors.NoSuchRevision(self, revision_id)
497
def get_rev_id(self, revno, history=None):
498
"""Find the revision id of the specified revno."""
500
return _mod_revision.NULL_REVISION
502
history = self.revision_history()
503
if revno <= 0 or revno > len(history):
504
raise errors.NoSuchRevision(self, revno)
505
return history[revno - 1]
507
def pull(self, source, overwrite=False, stop_revision=None):
508
"""Mirror source into this branch.
510
This branch is considered to be 'local', having low latency.
512
:returns: PullResult instance
514
raise NotImplementedError(self.pull)
516
def push(self, target, overwrite=False, stop_revision=None):
517
"""Mirror this branch into target.
519
This branch is considered to be 'local', having low latency.
521
raise NotImplementedError(self.push)
523
def basis_tree(self):
524
"""Return `Tree` object for last revision."""
525
return self.repository.revision_tree(self.last_revision())
527
def rename_one(self, from_rel, to_rel):
530
This can change the directory or the filename or both.
532
raise NotImplementedError(self.rename_one)
534
def move(self, from_paths, to_name):
537
to_name must exist as a versioned directory.
539
If to_name exists and is a directory, the files are moved into
540
it, keeping their old names. If it is a directory,
542
Note that to_name is only the last component of the new name;
543
this doesn't change the directory.
545
This returns a list of (from_path, to_path) pairs for each
548
raise NotImplementedError(self.move)
550
def get_parent(self):
551
"""Return the parent location of the branch.
553
This is the default location for push/pull/missing. The usual
554
pattern is that the user can override it by specifying a
557
raise NotImplementedError(self.get_parent)
559
def _set_config_location(self, name, url, config=None,
560
make_relative=False):
562
config = self.get_config()
566
url = urlutils.relative_url(self.base, url)
567
config.set_user_option(name, url, warn_masked=True)
569
def _get_config_location(self, name, config=None):
571
config = self.get_config()
572
location = config.get_user_option(name)
577
def get_submit_branch(self):
578
"""Return the submit location of the branch.
580
This is the default location for bundle. The usual
581
pattern is that the user can override it by specifying a
584
return self.get_config().get_user_option('submit_branch')
586
def set_submit_branch(self, location):
587
"""Return the submit location of the branch.
589
This is the default location for bundle. The usual
590
pattern is that the user can override it by specifying a
593
self.get_config().set_user_option('submit_branch', location,
596
def get_public_branch(self):
597
"""Return the public location of the branch.
599
This is is used by merge directives.
601
return self._get_config_location('public_branch')
603
def set_public_branch(self, location):
604
"""Return the submit location of the branch.
606
This is the default location for bundle. The usual
607
pattern is that the user can override it by specifying a
610
self._set_config_location('public_branch', location)
612
def get_push_location(self):
613
"""Return the None or the location to push this branch to."""
614
push_loc = self.get_config().get_user_option('push_location')
617
def set_push_location(self, location):
618
"""Set a new push location for this branch."""
619
raise NotImplementedError(self.set_push_location)
621
def set_parent(self, url):
622
raise NotImplementedError(self.set_parent)
626
"""Synchronise this branch with the master branch if any.
628
:return: None or the last_revision pivoted out during the update.
632
def check_revno(self, revno):
634
Check whether a revno corresponds to any revision.
635
Zero (the NULL revision) is considered valid.
638
self.check_real_revno(revno)
640
def check_real_revno(self, revno):
642
Check whether a revno corresponds to a real revision.
643
Zero (the NULL revision) is considered invalid
645
if revno < 1 or revno > self.revno():
646
raise InvalidRevisionNumber(revno)
649
def clone(self, to_bzrdir, revision_id=None):
650
"""Clone this branch into to_bzrdir preserving all semantic values.
652
revision_id: if not None, the revision history in the new branch will
653
be truncated to end with revision_id.
655
result = self._format.initialize(to_bzrdir)
656
self.copy_content_into(result, revision_id=revision_id)
660
def sprout(self, to_bzrdir, revision_id=None):
661
"""Create a new line of development from the branch, into to_bzrdir.
663
revision_id: if not None, the revision history in the new branch will
664
be truncated to end with revision_id.
666
result = self._format.initialize(to_bzrdir)
667
self.copy_content_into(result, revision_id=revision_id)
668
result.set_parent(self.bzrdir.root_transport.base)
671
def _synchronize_history(self, destination, revision_id):
672
"""Synchronize last revision and revision history between branches.
674
This version is most efficient when the destination is also a
675
BzrBranch5, but works for BzrBranch6 as long as the revision
676
history is the true lefthand parent history, and all of the revisions
677
are in the destination's repository. If not, set_revision_history
680
:param destination: The branch to copy the history into
681
:param revision_id: The revision-id to truncate history at. May
682
be None to copy complete history.
684
if revision_id == _mod_revision.NULL_REVISION:
686
new_history = self.revision_history()
687
if revision_id is not None and new_history != []:
689
new_history = new_history[:new_history.index(revision_id) + 1]
691
rev = self.repository.get_revision(revision_id)
692
new_history = rev.get_history(self.repository)[1:]
693
destination.set_revision_history(new_history)
696
def copy_content_into(self, destination, revision_id=None):
697
"""Copy the content of self into destination.
699
revision_id: if not None, the revision history in the new branch will
700
be truncated to end with revision_id.
702
self._synchronize_history(destination, revision_id)
704
parent = self.get_parent()
705
except errors.InaccessibleParent, e:
706
mutter('parent was not accessible to copy: %s', e)
709
destination.set_parent(parent)
710
self.tags.merge_to(destination.tags)
714
"""Check consistency of the branch.
716
In particular this checks that revisions given in the revision-history
717
do actually match up in the revision graph, and that they're all
718
present in the repository.
720
Callers will typically also want to check the repository.
722
:return: A BranchCheckResult.
724
mainline_parent_id = None
725
for revision_id in self.revision_history():
727
revision = self.repository.get_revision(revision_id)
728
except errors.NoSuchRevision, e:
729
raise errors.BzrCheckError("mainline revision {%s} not in repository"
731
# In general the first entry on the revision history has no parents.
732
# But it's not illegal for it to have parents listed; this can happen
733
# in imports from Arch when the parents weren't reachable.
734
if mainline_parent_id is not None:
735
if mainline_parent_id not in revision.parent_ids:
736
raise errors.BzrCheckError("previous revision {%s} not listed among "
738
% (mainline_parent_id, revision_id))
739
mainline_parent_id = revision_id
740
return BranchCheckResult(self)
742
def _get_checkout_format(self):
743
"""Return the most suitable metadir for a checkout of this branch.
744
Weaves are used if this branch's repository uses weaves.
746
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
747
from bzrlib.repofmt import weaverepo
748
format = bzrdir.BzrDirMetaFormat1()
749
format.repository_format = weaverepo.RepositoryFormat7()
751
format = self.repository.bzrdir.checkout_metadir()
752
format.set_branch_format(self._format)
755
def create_checkout(self, to_location, revision_id=None,
757
"""Create a checkout of a branch.
759
:param to_location: The url to produce the checkout at
760
:param revision_id: The revision to check out
761
:param lightweight: If True, produce a lightweight checkout, otherwise,
762
produce a bound branch (heavyweight checkout)
763
:return: The tree of the created checkout
765
t = transport.get_transport(to_location)
768
format = self._get_checkout_format()
769
checkout = format.initialize_on_transport(t)
770
BranchReferenceFormat().initialize(checkout, self)
772
format = self._get_checkout_format()
773
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
774
to_location, force_new_tree=False, format=format)
775
checkout = checkout_branch.bzrdir
776
checkout_branch.bind(self)
777
# pull up to the specified revision_id to set the initial
778
# branch tip correctly, and seed it with history.
779
checkout_branch.pull(self, stop_revision=revision_id)
780
tree = checkout.create_workingtree(revision_id)
781
basis_tree = tree.basis_tree()
782
basis_tree.lock_read()
784
for path, file_id in basis_tree.iter_references():
785
reference_parent = self.reference_parent(file_id, path)
786
reference_parent.create_checkout(tree.abspath(path),
787
basis_tree.get_reference_revision(file_id, path),
793
def reference_parent(self, file_id, path):
794
"""Return the parent branch for a tree-reference file_id
795
:param file_id: The file_id of the tree reference
796
:param path: The path of the file_id in the tree
797
:return: A branch associated with the file_id
799
# FIXME should provide multiple branches, based on config
800
return Branch.open(self.bzrdir.root_transport.clone(path).base)
802
def supports_tags(self):
803
return self._format.supports_tags()
806
class BranchFormat(object):
807
"""An encapsulation of the initialization and open routines for a format.
809
Formats provide three things:
810
* An initialization routine,
814
Formats are placed in an dict by their format string for reference
815
during branch opening. Its not required that these be instances, they
816
can be classes themselves with class methods - it simply depends on
817
whether state is needed for a given format or not.
819
Once a format is deprecated, just deprecate the initialize and open
820
methods on the format class. Do not deprecate the object, as the
821
object will be created every time regardless.
824
_default_format = None
825
"""The default format used for new branches."""
828
"""The known formats."""
830
def __eq__(self, other):
831
return self.__class__ is other.__class__
833
def __ne__(self, other):
834
return not (self == other)
837
def find_format(klass, a_bzrdir):
838
"""Return the format for the branch object in a_bzrdir."""
840
transport = a_bzrdir.get_branch_transport(None)
841
format_string = transport.get("format").read()
842
return klass._formats[format_string]
844
raise NotBranchError(path=transport.base)
846
raise errors.UnknownFormatError(format=format_string)
849
def get_default_format(klass):
850
"""Return the current default format."""
851
return klass._default_format
853
def get_reference(self, a_bzrdir):
854
"""Get the target reference of the branch in a_bzrdir.
856
format probing must have been completed before calling
857
this method - it is assumed that the format of the branch
858
in a_bzrdir is correct.
860
:param a_bzrdir: The bzrdir to get the branch data from.
861
:return: None if the branch is not a reference branch.
865
def get_format_string(self):
866
"""Return the ASCII format string that identifies this format."""
867
raise NotImplementedError(self.get_format_string)
869
def get_format_description(self):
870
"""Return the short format description for this format."""
871
raise NotImplementedError(self.get_format_description)
873
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
875
"""Initialize a branch in a bzrdir, with specified files
877
:param a_bzrdir: The bzrdir to initialize the branch in
878
:param utf8_files: The files to create as a list of
879
(filename, content) tuples
880
:param set_format: If True, set the format with
881
self.get_format_string. (BzrBranch4 has its format set
883
:return: a branch in this format
885
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
886
branch_transport = a_bzrdir.get_branch_transport(self)
888
'metadir': ('lock', lockdir.LockDir),
889
'branch4': ('branch-lock', lockable_files.TransportLock),
891
lock_name, lock_class = lock_map[lock_type]
892
control_files = lockable_files.LockableFiles(branch_transport,
893
lock_name, lock_class)
894
control_files.create_lock()
895
control_files.lock_write()
897
control_files.put_utf8('format', self.get_format_string())
899
for file, content in utf8_files:
900
control_files.put_utf8(file, content)
902
control_files.unlock()
903
return self.open(a_bzrdir, _found=True)
905
def initialize(self, a_bzrdir):
906
"""Create a branch of this format in a_bzrdir."""
907
raise NotImplementedError(self.initialize)
909
def is_supported(self):
910
"""Is this format supported?
912
Supported formats can be initialized and opened.
913
Unsupported formats may not support initialization or committing or
914
some other features depending on the reason for not being supported.
918
def open(self, a_bzrdir, _found=False):
919
"""Return the branch object for a_bzrdir
921
_found is a private parameter, do not use it. It is used to indicate
922
if format probing has already be done.
924
raise NotImplementedError(self.open)
927
def register_format(klass, format):
928
klass._formats[format.get_format_string()] = format
931
def set_default_format(klass, format):
932
klass._default_format = format
935
def unregister_format(klass, format):
936
assert klass._formats[format.get_format_string()] is format
937
del klass._formats[format.get_format_string()]
940
return self.get_format_string().rstrip()
942
def supports_tags(self):
943
"""True if this format supports tags stored in the branch"""
944
return False # by default
946
# XXX: Probably doesn't really belong here -- mbp 20070212
947
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
949
branch_transport = a_bzrdir.get_branch_transport(self)
950
control_files = lockable_files.LockableFiles(branch_transport,
951
lock_filename, lock_class)
952
control_files.create_lock()
953
control_files.lock_write()
955
for filename, content in utf8_files:
956
control_files.put_utf8(filename, content)
958
control_files.unlock()
961
class BranchHooks(Hooks):
962
"""A dictionary mapping hook name to a list of callables for branch hooks.
964
e.g. ['set_rh'] Is the list of items to be called when the
965
set_revision_history function is invoked.
969
"""Create the default hooks.
971
These are all empty initially, because by default nothing should get
975
# Introduced in 0.15:
976
# invoked whenever the revision history has been set
977
# with set_revision_history. The api signature is
978
# (branch, revision_history), and the branch will
981
# invoked after a push operation completes.
982
# the api signature is
984
# containing the members
985
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
986
# where local is the local target branch or None, master is the target
987
# master branch, and the rest should be self explanatory. The source
988
# is read locked and the target branches write locked. Source will
989
# be the local low-latency branch.
990
self['post_push'] = []
991
# invoked after a pull operation completes.
992
# the api signature is
994
# containing the members
995
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
996
# where local is the local branch or None, master is the target
997
# master branch, and the rest should be self explanatory. The source
998
# is read locked and the target branches write locked. The local
999
# branch is the low-latency branch.
1000
self['post_pull'] = []
1001
# invoked before a commit operation takes place.
1002
# the api signature is
1003
# (local, master, old_revno, old_revid, future_revno, future_revid,
1004
# tree_delta, future_tree).
1005
# old_revid is NULL_REVISION for the first commit to a branch
1006
# tree_delta is a TreeDelta object describing changes from the basis
1007
# revision, hooks MUST NOT modify this delta
1008
# future_tree is an in-memory tree obtained from
1009
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1010
self['pre_commit'] = []
1011
# invoked after a commit operation completes.
1012
# the api signature is
1013
# (local, master, old_revno, old_revid, new_revno, new_revid)
1014
# old_revid is NULL_REVISION for the first commit to a branch.
1015
self['post_commit'] = []
1016
# invoked after a uncommit operation completes.
1017
# the api signature is
1018
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1019
# local is the local branch or None, master is the target branch,
1020
# and an empty branch recieves new_revno of 0, new_revid of None.
1021
self['post_uncommit'] = []
1024
# install the default hooks into the Branch class.
1025
Branch.hooks = BranchHooks()
1028
class BzrBranchFormat4(BranchFormat):
1029
"""Bzr branch format 4.
1032
- a revision-history file.
1033
- a branch-lock lock file [ to be shared with the bzrdir ]
1036
def get_format_description(self):
1037
"""See BranchFormat.get_format_description()."""
1038
return "Branch format 4"
1040
def initialize(self, a_bzrdir):
1041
"""Create a branch of this format in a_bzrdir."""
1042
utf8_files = [('revision-history', ''),
1043
('branch-name', ''),
1045
return self._initialize_helper(a_bzrdir, utf8_files,
1046
lock_type='branch4', set_format=False)
1049
super(BzrBranchFormat4, self).__init__()
1050
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1052
def open(self, a_bzrdir, _found=False):
1053
"""Return the branch object for a_bzrdir
1055
_found is a private parameter, do not use it. It is used to indicate
1056
if format probing has already be done.
1059
# we are being called directly and must probe.
1060
raise NotImplementedError
1061
return BzrBranch(_format=self,
1062
_control_files=a_bzrdir._control_files,
1064
_repository=a_bzrdir.open_repository())
1067
return "Bazaar-NG branch format 4"
1070
class BzrBranchFormat5(BranchFormat):
1071
"""Bzr branch format 5.
1074
- a revision-history file.
1076
- a lock dir guarding the branch itself
1077
- all of this stored in a branch/ subdirectory
1078
- works with shared repositories.
1080
This format is new in bzr 0.8.
1083
def get_format_string(self):
1084
"""See BranchFormat.get_format_string()."""
1085
return "Bazaar-NG branch format 5\n"
1087
def get_format_description(self):
1088
"""See BranchFormat.get_format_description()."""
1089
return "Branch format 5"
1091
def initialize(self, a_bzrdir):
1092
"""Create a branch of this format in a_bzrdir."""
1093
utf8_files = [('revision-history', ''),
1094
('branch-name', ''),
1096
return self._initialize_helper(a_bzrdir, utf8_files)
1099
super(BzrBranchFormat5, self).__init__()
1100
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1102
def open(self, a_bzrdir, _found=False):
1103
"""Return the branch object for a_bzrdir
1105
_found is a private parameter, do not use it. It is used to indicate
1106
if format probing has already be done.
1109
format = BranchFormat.find_format(a_bzrdir)
1110
assert format.__class__ == self.__class__
1112
transport = a_bzrdir.get_branch_transport(None)
1113
control_files = lockable_files.LockableFiles(transport, 'lock',
1115
return BzrBranch5(_format=self,
1116
_control_files=control_files,
1118
_repository=a_bzrdir.find_repository())
1120
raise NotBranchError(path=transport.base)
1123
class BzrBranchFormat6(BzrBranchFormat5):
1124
"""Branch format with last-revision and tags.
1126
Unlike previous formats, this has no explicit revision history. Instead,
1127
this just stores the last-revision, and the left-hand history leading
1128
up to there is the history.
1130
This format was introduced in bzr 0.15
1131
and became the default in 0.91.
1134
def get_format_string(self):
1135
"""See BranchFormat.get_format_string()."""
1136
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1138
def get_format_description(self):
1139
"""See BranchFormat.get_format_description()."""
1140
return "Branch format 6"
1142
def initialize(self, a_bzrdir):
1143
"""Create a branch of this format in a_bzrdir."""
1144
utf8_files = [('last-revision', '0 null:\n'),
1145
('branch-name', ''),
1146
('branch.conf', ''),
1149
return self._initialize_helper(a_bzrdir, utf8_files)
1151
def open(self, a_bzrdir, _found=False):
1152
"""Return the branch object for a_bzrdir
1154
_found is a private parameter, do not use it. It is used to indicate
1155
if format probing has already be done.
1158
format = BranchFormat.find_format(a_bzrdir)
1159
assert format.__class__ == self.__class__
1160
transport = a_bzrdir.get_branch_transport(None)
1161
control_files = lockable_files.LockableFiles(transport, 'lock',
1163
return BzrBranch6(_format=self,
1164
_control_files=control_files,
1166
_repository=a_bzrdir.find_repository())
1168
def supports_tags(self):
1172
class BranchReferenceFormat(BranchFormat):
1173
"""Bzr branch reference format.
1175
Branch references are used in implementing checkouts, they
1176
act as an alias to the real branch which is at some other url.
1183
def get_format_string(self):
1184
"""See BranchFormat.get_format_string()."""
1185
return "Bazaar-NG Branch Reference Format 1\n"
1187
def get_format_description(self):
1188
"""See BranchFormat.get_format_description()."""
1189
return "Checkout reference format 1"
1191
def get_reference(self, a_bzrdir):
1192
"""See BranchFormat.get_reference()."""
1193
transport = a_bzrdir.get_branch_transport(None)
1194
return transport.get('location').read()
1196
def initialize(self, a_bzrdir, target_branch=None):
1197
"""Create a branch of this format in a_bzrdir."""
1198
if target_branch is None:
1199
# this format does not implement branch itself, thus the implicit
1200
# creation contract must see it as uninitializable
1201
raise errors.UninitializableFormat(self)
1202
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1203
branch_transport = a_bzrdir.get_branch_transport(self)
1204
branch_transport.put_bytes('location',
1205
target_branch.bzrdir.root_transport.base)
1206
branch_transport.put_bytes('format', self.get_format_string())
1207
return self.open(a_bzrdir, _found=True)
1210
super(BranchReferenceFormat, self).__init__()
1211
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1213
def _make_reference_clone_function(format, a_branch):
1214
"""Create a clone() routine for a branch dynamically."""
1215
def clone(to_bzrdir, revision_id=None):
1216
"""See Branch.clone()."""
1217
return format.initialize(to_bzrdir, a_branch)
1218
# cannot obey revision_id limits when cloning a reference ...
1219
# FIXME RBC 20060210 either nuke revision_id for clone, or
1220
# emit some sort of warning/error to the caller ?!
1223
def open(self, a_bzrdir, _found=False, location=None):
1224
"""Return the branch that the branch reference in a_bzrdir points at.
1226
_found is a private parameter, do not use it. It is used to indicate
1227
if format probing has already be done.
1230
format = BranchFormat.find_format(a_bzrdir)
1231
assert format.__class__ == self.__class__
1232
if location is None:
1233
location = self.get_reference(a_bzrdir)
1234
real_bzrdir = bzrdir.BzrDir.open(location)
1235
result = real_bzrdir.open_branch()
1236
# this changes the behaviour of result.clone to create a new reference
1237
# rather than a copy of the content of the branch.
1238
# I did not use a proxy object because that needs much more extensive
1239
# testing, and we are only changing one behaviour at the moment.
1240
# If we decide to alter more behaviours - i.e. the implicit nickname
1241
# then this should be refactored to introduce a tested proxy branch
1242
# and a subclass of that for use in overriding clone() and ....
1244
result.clone = self._make_reference_clone_function(result)
1248
# formats which have no format string are not discoverable
1249
# and not independently creatable, so are not registered.
1250
__format5 = BzrBranchFormat5()
1251
__format6 = BzrBranchFormat6()
1252
BranchFormat.register_format(__format5)
1253
BranchFormat.register_format(BranchReferenceFormat())
1254
BranchFormat.register_format(__format6)
1255
BranchFormat.set_default_format(__format6)
1256
_legacy_formats = [BzrBranchFormat4(),
1259
class BzrBranch(Branch):
1260
"""A branch stored in the actual filesystem.
1262
Note that it's "local" in the context of the filesystem; it doesn't
1263
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1264
it's writable, and can be accessed via the normal filesystem API.
1267
def __init__(self, _format=None,
1268
_control_files=None, a_bzrdir=None, _repository=None):
1269
"""Create new branch object at a particular location."""
1270
Branch.__init__(self)
1271
if a_bzrdir is None:
1272
raise ValueError('a_bzrdir must be supplied')
1274
self.bzrdir = a_bzrdir
1275
# self._transport used to point to the directory containing the
1276
# control directory, but was not used - now it's just the transport
1277
# for the branch control files. mbp 20070212
1278
self._base = self.bzrdir.transport.clone('..').base
1279
self._format = _format
1280
if _control_files is None:
1281
raise ValueError('BzrBranch _control_files is None')
1282
self.control_files = _control_files
1283
self._transport = _control_files._transport
1284
self.repository = _repository
1287
return '%s(%r)' % (self.__class__.__name__, self.base)
1291
def _get_base(self):
1292
"""Returns the directory containing the control directory."""
1295
base = property(_get_base, doc="The URL for the root of this branch.")
1297
def abspath(self, name):
1298
"""See Branch.abspath."""
1299
return self.control_files._transport.abspath(name)
1302
@deprecated_method(zero_sixteen)
1304
def get_root_id(self):
1305
"""See Branch.get_root_id."""
1306
tree = self.repository.revision_tree(self.last_revision())
1307
return tree.inventory.root.file_id
1309
def is_locked(self):
1310
return self.control_files.is_locked()
1312
def lock_write(self, token=None):
1313
repo_token = self.repository.lock_write()
1315
token = self.control_files.lock_write(token=token)
1317
self.repository.unlock()
1321
def lock_read(self):
1322
self.repository.lock_read()
1324
self.control_files.lock_read()
1326
self.repository.unlock()
1330
# TODO: test for failed two phase locks. This is known broken.
1332
self.control_files.unlock()
1334
self.repository.unlock()
1335
if not self.control_files.is_locked():
1336
# we just released the lock
1337
self._clear_cached_state()
1339
def peek_lock_mode(self):
1340
if self.control_files._lock_count == 0:
1343
return self.control_files._lock_mode
1345
def get_physical_lock_status(self):
1346
return self.control_files.get_physical_lock_status()
1349
def print_file(self, file, revision_id):
1350
"""See Branch.print_file."""
1351
return self.repository.print_file(file, revision_id)
1353
def _write_revision_history(self, history):
1354
"""Factored out of set_revision_history.
1356
This performs the actual writing to disk.
1357
It is intended to be called by BzrBranch5.set_revision_history."""
1358
self.control_files.put_bytes(
1359
'revision-history', '\n'.join(history))
1362
def set_revision_history(self, rev_history):
1363
"""See Branch.set_revision_history."""
1364
self._clear_cached_state()
1365
self._write_revision_history(rev_history)
1366
self._cache_revision_history(rev_history)
1367
for hook in Branch.hooks['set_rh']:
1368
hook(self, rev_history)
1371
def set_last_revision_info(self, revno, revision_id):
1372
"""Set the last revision of this branch.
1374
The caller is responsible for checking that the revno is correct
1375
for this revision id.
1377
It may be possible to set the branch last revision to an id not
1378
present in the repository. However, branches can also be
1379
configured to check constraints on history, in which case this may not
1382
history = self._lefthand_history(revision_id)
1383
assert len(history) == revno, '%d != %d' % (len(history), revno)
1384
self.set_revision_history(history)
1386
def _gen_revision_history(self):
1387
history = self.control_files.get('revision-history').read().split('\n')
1388
if history[-1:] == ['']:
1389
# There shouldn't be a trailing newline, but just in case.
1393
def _lefthand_history(self, revision_id, last_rev=None,
1395
# stop_revision must be a descendant of last_revision
1396
stop_graph = self.repository.get_revision_graph(revision_id)
1397
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1398
and last_rev not in stop_graph):
1399
# our previous tip is not merged into stop_revision
1400
raise errors.DivergedBranches(self, other_branch)
1401
# make a new revision history from the graph
1402
current_rev_id = revision_id
1404
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1405
new_history.append(current_rev_id)
1406
current_rev_id_parents = stop_graph[current_rev_id]
1408
current_rev_id = current_rev_id_parents[0]
1410
current_rev_id = None
1411
new_history.reverse()
1415
def generate_revision_history(self, revision_id, last_rev=None,
1417
"""Create a new revision history that will finish with revision_id.
1419
:param revision_id: the new tip to use.
1420
:param last_rev: The previous last_revision. If not None, then this
1421
must be a ancestory of revision_id, or DivergedBranches is raised.
1422
:param other_branch: The other branch that DivergedBranches should
1423
raise with respect to.
1425
self.set_revision_history(self._lefthand_history(revision_id,
1426
last_rev, other_branch))
1429
def update_revisions(self, other, stop_revision=None):
1430
"""See Branch.update_revisions."""
1433
if stop_revision is None:
1434
stop_revision = other.last_revision()
1435
if stop_revision is None:
1436
# if there are no commits, we're done.
1438
# whats the current last revision, before we fetch [and change it
1440
last_rev = _mod_revision.ensure_null(self.last_revision())
1441
# we fetch here regardless of whether we need to so that we pickup
1443
self.fetch(other, stop_revision)
1444
if self.repository.get_graph().is_ancestor(stop_revision,
1447
self.generate_revision_history(stop_revision, last_rev=last_rev,
1452
def basis_tree(self):
1453
"""See Branch.basis_tree."""
1454
return self.repository.revision_tree(self.last_revision())
1457
def pull(self, source, overwrite=False, stop_revision=None,
1458
_hook_master=None, run_hooks=True):
1461
:param _hook_master: Private parameter - set the branch to
1462
be supplied as the master to push hooks.
1463
:param run_hooks: Private parameter - if false, this branch
1464
is being called because it's the master of the primary branch,
1465
so it should not run its hooks.
1467
result = PullResult()
1468
result.source_branch = source
1469
result.target_branch = self
1472
result.old_revno, result.old_revid = self.last_revision_info()
1474
self.update_revisions(source, stop_revision)
1475
except DivergedBranches:
1479
if stop_revision is None:
1480
stop_revision = source.last_revision()
1481
self.generate_revision_history(stop_revision)
1482
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1483
result.new_revno, result.new_revid = self.last_revision_info()
1485
result.master_branch = _hook_master
1486
result.local_branch = self
1488
result.master_branch = self
1489
result.local_branch = None
1491
for hook in Branch.hooks['post_pull']:
1497
def _get_parent_location(self):
1498
_locs = ['parent', 'pull', 'x-pull']
1501
return self.control_files.get(l).read().strip('\n')
1507
def push(self, target, overwrite=False, stop_revision=None,
1508
_override_hook_source_branch=None):
1511
This is the basic concrete implementation of push()
1513
:param _override_hook_source_branch: If specified, run
1514
the hooks passing this Branch as the source, rather than self.
1515
This is for use of RemoteBranch, where push is delegated to the
1516
underlying vfs-based Branch.
1518
# TODO: Public option to disable running hooks - should be trivial but
1522
result = self._push_with_bound_branches(target, overwrite,
1524
_override_hook_source_branch=_override_hook_source_branch)
1529
def _push_with_bound_branches(self, target, overwrite,
1531
_override_hook_source_branch=None):
1532
"""Push from self into target, and into target's master if any.
1534
This is on the base BzrBranch class even though it doesn't support
1535
bound branches because the *target* might be bound.
1538
if _override_hook_source_branch:
1539
result.source_branch = _override_hook_source_branch
1540
for hook in Branch.hooks['post_push']:
1543
bound_location = target.get_bound_location()
1544
if bound_location and target.base != bound_location:
1545
# there is a master branch.
1547
# XXX: Why the second check? Is it even supported for a branch to
1548
# be bound to itself? -- mbp 20070507
1549
master_branch = target.get_master_branch()
1550
master_branch.lock_write()
1552
# push into the master from this branch.
1553
self._basic_push(master_branch, overwrite, stop_revision)
1554
# and push into the target branch from this. Note that we push from
1555
# this branch again, because its considered the highest bandwidth
1557
result = self._basic_push(target, overwrite, stop_revision)
1558
result.master_branch = master_branch
1559
result.local_branch = target
1563
master_branch.unlock()
1566
result = self._basic_push(target, overwrite, stop_revision)
1567
# TODO: Why set master_branch and local_branch if there's no
1568
# binding? Maybe cleaner to just leave them unset? -- mbp
1570
result.master_branch = target
1571
result.local_branch = None
1575
def _basic_push(self, target, overwrite, stop_revision):
1576
"""Basic implementation of push without bound branches or hooks.
1578
Must be called with self read locked and target write locked.
1580
result = PushResult()
1581
result.source_branch = self
1582
result.target_branch = target
1583
result.old_revno, result.old_revid = target.last_revision_info()
1585
target.update_revisions(self, stop_revision)
1586
except DivergedBranches:
1590
target.set_revision_history(self.revision_history())
1591
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1592
result.new_revno, result.new_revid = target.last_revision_info()
1595
def get_parent(self):
1596
"""See Branch.get_parent."""
1598
assert self.base[-1] == '/'
1599
parent = self._get_parent_location()
1602
# This is an old-format absolute path to a local branch
1603
# turn it into a url
1604
if parent.startswith('/'):
1605
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1607
return urlutils.join(self.base[:-1], parent)
1608
except errors.InvalidURLJoin, e:
1609
raise errors.InaccessibleParent(parent, self.base)
1611
def set_push_location(self, location):
1612
"""See Branch.set_push_location."""
1613
self.get_config().set_user_option(
1614
'push_location', location,
1615
store=_mod_config.STORE_LOCATION_NORECURSE)
1618
def set_parent(self, url):
1619
"""See Branch.set_parent."""
1620
# TODO: Maybe delete old location files?
1621
# URLs should never be unicode, even on the local fs,
1622
# FIXUP this and get_parent in a future branch format bump:
1623
# read and rewrite the file, and have the new format code read
1624
# using .get not .get_utf8. RBC 20060125
1626
if isinstance(url, unicode):
1628
url = url.encode('ascii')
1629
except UnicodeEncodeError:
1630
raise errors.InvalidURL(url,
1631
"Urls must be 7-bit ascii, "
1632
"use bzrlib.urlutils.escape")
1633
url = urlutils.relative_url(self.base, url)
1634
self._set_parent_location(url)
1636
def _set_parent_location(self, url):
1638
self.control_files._transport.delete('parent')
1640
assert isinstance(url, str)
1641
self.control_files.put_bytes('parent', url + '\n')
1644
class BzrBranch5(BzrBranch):
1645
"""A format 5 branch. This supports new features over plain branches.
1647
It has support for a master_branch which is the data for bound branches.
1655
super(BzrBranch5, self).__init__(_format=_format,
1656
_control_files=_control_files,
1658
_repository=_repository)
1661
def pull(self, source, overwrite=False, stop_revision=None,
1663
"""Pull from source into self, updating my master if any.
1665
:param run_hooks: Private parameter - if false, this branch
1666
is being called because it's the master of the primary branch,
1667
so it should not run its hooks.
1669
bound_location = self.get_bound_location()
1670
master_branch = None
1671
if bound_location and source.base != bound_location:
1672
# not pulling from master, so we need to update master.
1673
master_branch = self.get_master_branch()
1674
master_branch.lock_write()
1677
# pull from source into master.
1678
master_branch.pull(source, overwrite, stop_revision,
1680
return super(BzrBranch5, self).pull(source, overwrite,
1681
stop_revision, _hook_master=master_branch,
1682
run_hooks=run_hooks)
1685
master_branch.unlock()
1687
def get_bound_location(self):
1689
return self.control_files.get_utf8('bound').read()[:-1]
1690
except errors.NoSuchFile:
1694
def get_master_branch(self, possible_transports=None):
1695
"""Return the branch we are bound to.
1697
:return: Either a Branch, or None
1699
This could memoise the branch, but if thats done
1700
it must be revalidated on each new lock.
1701
So for now we just don't memoise it.
1702
# RBC 20060304 review this decision.
1704
bound_loc = self.get_bound_location()
1708
return Branch.open(bound_loc,
1709
possible_transports=possible_transports)
1710
except (errors.NotBranchError, errors.ConnectionError), e:
1711
raise errors.BoundBranchConnectionFailure(
1715
def set_bound_location(self, location):
1716
"""Set the target where this branch is bound to.
1718
:param location: URL to the target branch
1721
self.control_files.put_utf8('bound', location+'\n')
1724
self.control_files._transport.delete('bound')
1730
def bind(self, other):
1731
"""Bind this branch to the branch other.
1733
This does not push or pull data between the branches, though it does
1734
check for divergence to raise an error when the branches are not
1735
either the same, or one a prefix of the other. That behaviour may not
1736
be useful, so that check may be removed in future.
1738
:param other: The branch to bind to
1741
# TODO: jam 20051230 Consider checking if the target is bound
1742
# It is debatable whether you should be able to bind to
1743
# a branch which is itself bound.
1744
# Committing is obviously forbidden,
1745
# but binding itself may not be.
1746
# Since we *have* to check at commit time, we don't
1747
# *need* to check here
1749
# we want to raise diverged if:
1750
# last_rev is not in the other_last_rev history, AND
1751
# other_last_rev is not in our history, and do it without pulling
1753
last_rev = _mod_revision.ensure_null(self.last_revision())
1754
if last_rev != _mod_revision.NULL_REVISION:
1757
other_last_rev = other.last_revision()
1758
if not _mod_revision.is_null(other_last_rev):
1759
# neither branch is new, we have to do some work to
1760
# ascertain diversion.
1761
remote_graph = other.repository.get_revision_graph(
1763
local_graph = self.repository.get_revision_graph(last_rev)
1764
if (last_rev not in remote_graph and
1765
other_last_rev not in local_graph):
1766
raise errors.DivergedBranches(self, other)
1769
self.set_bound_location(other.base)
1773
"""If bound, unbind"""
1774
return self.set_bound_location(None)
1777
def update(self, possible_transports=None):
1778
"""Synchronise this branch with the master branch if any.
1780
:return: None or the last_revision that was pivoted out during the
1783
master = self.get_master_branch(possible_transports)
1784
if master is not None:
1785
old_tip = _mod_revision.ensure_null(self.last_revision())
1786
self.pull(master, overwrite=True)
1787
if self.repository.get_graph().is_ancestor(old_tip,
1788
_mod_revision.ensure_null(self.last_revision())):
1794
class BzrBranchExperimental(BzrBranch5):
1795
"""Bzr experimental branch format
1798
- a revision-history file.
1800
- a lock dir guarding the branch itself
1801
- all of this stored in a branch/ subdirectory
1802
- works with shared repositories.
1803
- a tag dictionary in the branch
1805
This format is new in bzr 0.15, but shouldn't be used for real data,
1808
This class acts as it's own BranchFormat.
1811
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1814
def get_format_string(cls):
1815
"""See BranchFormat.get_format_string()."""
1816
return "Bazaar-NG branch format experimental\n"
1819
def get_format_description(cls):
1820
"""See BranchFormat.get_format_description()."""
1821
return "Experimental branch format"
1824
def get_reference(cls, a_bzrdir):
1825
"""Get the target reference of the branch in a_bzrdir.
1827
format probing must have been completed before calling
1828
this method - it is assumed that the format of the branch
1829
in a_bzrdir is correct.
1831
:param a_bzrdir: The bzrdir to get the branch data from.
1832
:return: None if the branch is not a reference branch.
1837
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1839
branch_transport = a_bzrdir.get_branch_transport(cls)
1840
control_files = lockable_files.LockableFiles(branch_transport,
1841
lock_filename, lock_class)
1842
control_files.create_lock()
1843
control_files.lock_write()
1845
for filename, content in utf8_files:
1846
control_files.put_utf8(filename, content)
1848
control_files.unlock()
1851
def initialize(cls, a_bzrdir):
1852
"""Create a branch of this format in a_bzrdir."""
1853
utf8_files = [('format', cls.get_format_string()),
1854
('revision-history', ''),
1855
('branch-name', ''),
1858
cls._initialize_control_files(a_bzrdir, utf8_files,
1859
'lock', lockdir.LockDir)
1860
return cls.open(a_bzrdir, _found=True)
1863
def open(cls, a_bzrdir, _found=False):
1864
"""Return the branch object for a_bzrdir
1866
_found is a private parameter, do not use it. It is used to indicate
1867
if format probing has already be done.
1870
format = BranchFormat.find_format(a_bzrdir)
1871
assert format.__class__ == cls
1872
transport = a_bzrdir.get_branch_transport(None)
1873
control_files = lockable_files.LockableFiles(transport, 'lock',
1875
return cls(_format=cls,
1876
_control_files=control_files,
1878
_repository=a_bzrdir.find_repository())
1881
def is_supported(cls):
1884
def _make_tags(self):
1885
return BasicTags(self)
1888
def supports_tags(cls):
1892
BranchFormat.register_format(BzrBranchExperimental)
1895
class BzrBranch6(BzrBranch5):
1898
def last_revision_info(self):
1899
revision_string = self.control_files.get('last-revision').read()
1900
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1901
revision_id = cache_utf8.get_cached_utf8(revision_id)
1903
return revno, revision_id
1905
def last_revision(self):
1906
"""Return last revision id, or None"""
1907
revision_id = self.last_revision_info()[1]
1910
def _write_last_revision_info(self, revno, revision_id):
1911
"""Simply write out the revision id, with no checks.
1913
Use set_last_revision_info to perform this safely.
1915
Does not update the revision_history cache.
1916
Intended to be called by set_last_revision_info and
1917
_write_revision_history.
1919
if revision_id is None:
1920
revision_id = 'null:'
1921
out_string = '%d %s\n' % (revno, revision_id)
1922
self.control_files.put_bytes('last-revision', out_string)
1925
def set_last_revision_info(self, revno, revision_id):
1926
if self._get_append_revisions_only():
1927
self._check_history_violation(revision_id)
1928
self._write_last_revision_info(revno, revision_id)
1929
self._clear_cached_state()
1931
def _check_history_violation(self, revision_id):
1932
last_revision = _mod_revision.ensure_null(self.last_revision())
1933
if _mod_revision.is_null(last_revision):
1935
if last_revision not in self._lefthand_history(revision_id):
1936
raise errors.AppendRevisionsOnlyViolation(self.base)
1938
def _gen_revision_history(self):
1939
"""Generate the revision history from last revision
1941
history = list(self.repository.iter_reverse_revision_history(
1942
self.last_revision()))
1946
def _write_revision_history(self, history):
1947
"""Factored out of set_revision_history.
1949
This performs the actual writing to disk, with format-specific checks.
1950
It is intended to be called by BzrBranch5.set_revision_history.
1952
if len(history) == 0:
1953
last_revision = 'null:'
1955
if history != self._lefthand_history(history[-1]):
1956
raise errors.NotLefthandHistory(history)
1957
last_revision = history[-1]
1958
if self._get_append_revisions_only():
1959
self._check_history_violation(last_revision)
1960
self._write_last_revision_info(len(history), last_revision)
1963
def _set_parent_location(self, url):
1964
"""Set the parent branch"""
1965
self._set_config_location('parent_location', url, make_relative=True)
1968
def _get_parent_location(self):
1969
"""Set the parent branch"""
1970
return self._get_config_location('parent_location')
1972
def set_push_location(self, location):
1973
"""See Branch.set_push_location."""
1974
self._set_config_location('push_location', location)
1976
def set_bound_location(self, location):
1977
"""See Branch.set_push_location."""
1979
config = self.get_config()
1980
if location is None:
1981
if config.get_user_option('bound') != 'True':
1984
config.set_user_option('bound', 'False', warn_masked=True)
1987
self._set_config_location('bound_location', location,
1989
config.set_user_option('bound', 'True', warn_masked=True)
1992
def _get_bound_location(self, bound):
1993
"""Return the bound location in the config file.
1995
Return None if the bound parameter does not match"""
1996
config = self.get_config()
1997
config_bound = (config.get_user_option('bound') == 'True')
1998
if config_bound != bound:
2000
return self._get_config_location('bound_location', config=config)
2002
def get_bound_location(self):
2003
"""See Branch.set_push_location."""
2004
return self._get_bound_location(True)
2006
def get_old_bound_location(self):
2007
"""See Branch.get_old_bound_location"""
2008
return self._get_bound_location(False)
2010
def set_append_revisions_only(self, enabled):
2015
self.get_config().set_user_option('append_revisions_only', value,
2018
def _get_append_revisions_only(self):
2019
value = self.get_config().get_user_option('append_revisions_only')
2020
return value == 'True'
2022
def _synchronize_history(self, destination, revision_id):
2023
"""Synchronize last revision and revision history between branches.
2025
This version is most efficient when the destination is also a
2026
BzrBranch6, but works for BzrBranch5, as long as the destination's
2027
repository contains all the lefthand ancestors of the intended
2028
last_revision. If not, set_last_revision_info will fail.
2030
:param destination: The branch to copy the history into
2031
:param revision_id: The revision-id to truncate history at. May
2032
be None to copy complete history.
2034
source_revno, source_revision_id = self.last_revision_info()
2035
if revision_id is None:
2036
revno, revision_id = source_revno, source_revision_id
2037
elif source_revision_id == revision_id:
2038
# we know the revno without needing to walk all of history
2039
revno = source_revno
2041
# To figure out the revno for a random revision, we need to build
2042
# the revision history, and count its length.
2043
# We don't care about the order, just how long it is.
2044
# Alternatively, we could start at the current location, and count
2045
# backwards. But there is no guarantee that we will find it since
2046
# it may be a merged revision.
2047
revno = len(list(self.repository.iter_reverse_revision_history(
2049
destination.set_last_revision_info(revno, revision_id)
2051
def _make_tags(self):
2052
return BasicTags(self)
2055
######################################################################
2056
# results of operations
2059
class _Result(object):
2061
def _show_tag_conficts(self, to_file):
2062
if not getattr(self, 'tag_conflicts', None):
2064
to_file.write('Conflicting tags:\n')
2065
for name, value1, value2 in self.tag_conflicts:
2066
to_file.write(' %s\n' % (name, ))
2069
class PullResult(_Result):
2070
"""Result of a Branch.pull operation.
2072
:ivar old_revno: Revision number before pull.
2073
:ivar new_revno: Revision number after pull.
2074
:ivar old_revid: Tip revision id before pull.
2075
:ivar new_revid: Tip revision id after pull.
2076
:ivar source_branch: Source (local) branch object.
2077
:ivar master_branch: Master branch of the target, or None.
2078
:ivar target_branch: Target/destination branch object.
2082
# DEPRECATED: pull used to return the change in revno
2083
return self.new_revno - self.old_revno
2085
def report(self, to_file):
2086
if self.old_revid == self.new_revid:
2087
to_file.write('No revisions to pull.\n')
2089
to_file.write('Now on revision %d.\n' % self.new_revno)
2090
self._show_tag_conficts(to_file)
2093
class PushResult(_Result):
2094
"""Result of a Branch.push operation.
2096
:ivar old_revno: Revision number before push.
2097
:ivar new_revno: Revision number after push.
2098
:ivar old_revid: Tip revision id before push.
2099
:ivar new_revid: Tip revision id after push.
2100
:ivar source_branch: Source branch object.
2101
:ivar master_branch: Master branch of the target, or None.
2102
:ivar target_branch: Target/destination branch object.
2106
# DEPRECATED: push used to return the change in revno
2107
return self.new_revno - self.old_revno
2109
def report(self, to_file):
2110
"""Write a human-readable description of the result."""
2111
if self.old_revid == self.new_revid:
2112
to_file.write('No new revisions to push.\n')
2114
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2115
self._show_tag_conficts(to_file)
2118
class BranchCheckResult(object):
2119
"""Results of checking branch consistency.
2124
def __init__(self, branch):
2125
self.branch = branch
2127
def report_results(self, verbose):
2128
"""Report the check results via trace.note.
2130
:param verbose: Requests more detailed display of what was checked,
2133
note('checked branch %s format %s',
2135
self.branch._format)
2138
class Converter5to6(object):
2139
"""Perform an in-place upgrade of format 5 to format 6"""
2141
def convert(self, branch):
2142
# Data for 5 and 6 can peacefully coexist.
2143
format = BzrBranchFormat6()
2144
new_branch = format.open(branch.bzrdir, _found=True)
2146
# Copy source data into target
2147
new_branch.set_last_revision_info(*branch.last_revision_info())
2148
new_branch.set_parent(branch.get_parent())
2149
new_branch.set_bound_location(branch.get_bound_location())
2150
new_branch.set_push_location(branch.get_push_location())
2152
# New branch has no tags by default
2153
new_branch.tags._set_tag_dict({})
2155
# Copying done; now update target format
2156
new_branch.control_files.put_utf8('format',
2157
format.get_format_string())
2159
# Clean up old files
2160
new_branch.control_files._transport.delete('revision-history')
2162
branch.set_parent(None)
2165
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
