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,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
45
from bzrlib.decorators import needs_read_lock, needs_write_lock
46
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
47
HistoryMissing, InvalidRevisionId,
48
InvalidRevisionNumber, LockError, NoSuchFile,
49
NoSuchRevision, NoWorkingTree, NotVersionedError,
50
NotBranchError, UninitializableFormat,
51
UnlistableStore, UnlistableBranch,
53
from bzrlib.symbol_versioning import (deprecated_function,
57
zero_eight, zero_nine,
59
from bzrlib.trace import mutter, note
62
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
63
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
64
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
67
# TODO: Maybe include checks for common corruption of newlines, etc?
69
# TODO: Some operations like log might retrieve the same revisions
70
# repeatedly to calculate deltas. We could perhaps have a weakref
71
# cache in memory to make this faster. In general anything can be
72
# cached in memory between lock and unlock operations. .. nb thats
73
# what the transaction identity map provides
76
######################################################################
80
"""Branch holding a history of revisions.
83
Base directory/url of the branch.
85
hooks: An instance of BranchHooks.
87
# this is really an instance variable - FIXME move it there
91
def __init__(self, *ignored, **ignored_too):
92
raise NotImplementedError('The Branch class is abstract')
95
"""Break a lock if one is present from another instance.
97
Uses the ui factory to ask for confirmation if the lock may be from
100
This will probe the repository for its lock as well.
102
self.control_files.break_lock()
103
self.repository.break_lock()
104
master = self.get_master_branch()
105
if master is not None:
109
@deprecated_method(zero_eight)
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format."""
112
return Branch.open(base, _unsupported=True)
115
def open(base, _unsupported=False):
116
"""Open the branch rooted at base.
118
For instance, if the branch is at URL/.bzr/branch,
119
Branch.open(URL) -> a Branch instance.
121
control = bzrdir.BzrDir.open(base, _unsupported)
122
return control.open_branch(_unsupported)
125
def open_containing(url):
126
"""Open an existing branch which contains url.
128
This probes for a branch at url, and searches upwards from there.
130
Basically we keep looking up until we find the control directory or
131
run into the root. If there isn't one, raises NotBranchError.
132
If there is one and it is either an unrecognised format or an unsupported
133
format, UnknownFormatError or UnsupportedFormatError are raised.
134
If there is one, it is returned, along with the unused portion of url.
136
control, relpath = bzrdir.BzrDir.open_containing(url)
137
return control.open_branch(), relpath
140
@deprecated_function(zero_eight)
141
def initialize(base):
142
"""Create a new working tree and branch, rooted at 'base' (url)
144
NOTE: This will soon be deprecated in favour of creation
147
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
149
@deprecated_function(zero_eight)
150
def setup_caching(self, cache_root):
151
"""Subclasses that care about caching should override this, and set
152
up cached stores located under cache_root.
154
NOTE: This is unused.
158
def get_config(self):
159
return BranchConfig(self)
162
return self.get_config().get_nickname()
164
def _set_nick(self, nick):
165
self.get_config().set_user_option('nickname', nick)
167
nick = property(_get_nick, _set_nick)
170
raise NotImplementedError(self.is_locked)
172
def lock_write(self):
173
raise NotImplementedError(self.lock_write)
176
raise NotImplementedError(self.lock_read)
179
raise NotImplementedError(self.unlock)
181
def peek_lock_mode(self):
182
"""Return lock mode for the Branch: 'r', 'w' or None"""
183
raise NotImplementedError(self.peek_lock_mode)
185
def get_physical_lock_status(self):
186
raise NotImplementedError(self.get_physical_lock_status)
188
def abspath(self, name):
189
"""Return absolute filename for something in the branch
191
XXX: Robert Collins 20051017 what is this used for? why is it a branch
192
method and not a tree method.
194
raise NotImplementedError(self.abspath)
196
def bind(self, other):
197
"""Bind the local branch the other branch.
199
:param other: The branch to bind to
202
raise errors.UpgradeRequired(self.base)
205
def fetch(self, from_branch, last_revision=None, pb=None):
206
"""Copy revisions from from_branch into this branch.
208
:param from_branch: Where to copy from.
209
:param last_revision: What revision to stop at (None for at the end
211
:param pb: An optional progress bar to use.
213
Returns the copied revision count and the failed revisions in a tuple:
216
if self.base == from_branch.base:
219
nested_pb = ui.ui_factory.nested_progress_bar()
224
from_branch.lock_read()
226
if last_revision is None:
227
pb.update('get source history')
228
last_revision = from_branch.last_revision()
229
if last_revision is None:
230
last_revision = _mod_revision.NULL_REVISION
231
return self.repository.fetch(from_branch.repository,
232
revision_id=last_revision,
235
if nested_pb is not None:
239
def get_bound_location(self):
240
"""Return the URL of the branch we are bound to.
242
Older format branches cannot bind, please be sure to use a metadir
247
def get_old_bound_location(self):
248
"""Return the URL of the branch we used to be bound to
250
raise errors.UpgradeRequired(self.base)
252
def get_commit_builder(self, parents, config=None, timestamp=None,
253
timezone=None, committer=None, revprops=None,
255
"""Obtain a CommitBuilder for this branch.
257
:param parents: Revision ids of the parents of the new revision.
258
:param config: Optional configuration to use.
259
:param timestamp: Optional timestamp recorded for commit.
260
:param timezone: Optional timezone for timestamp.
261
:param committer: Optional committer to set for commit.
262
:param revprops: Optional dictionary of revision properties.
263
:param revision_id: Optional revision id.
267
config = self.get_config()
269
return self.repository.get_commit_builder(self, parents, config,
270
timestamp, timezone, committer, revprops, revision_id)
272
def get_master_branch(self):
273
"""Return the branch we are bound to.
275
:return: Either a Branch, or None
279
def get_revision_delta(self, revno):
280
"""Return the delta for one revision.
282
The delta is relative to its mainline predecessor, or the
283
empty tree for revision 1.
285
assert isinstance(revno, int)
286
rh = self.revision_history()
287
if not (1 <= revno <= len(rh)):
288
raise InvalidRevisionNumber(revno)
289
return self.repository.get_revision_delta(rh[revno-1])
291
def get_root_id(self):
292
"""Return the id of this branches root"""
293
raise NotImplementedError(self.get_root_id)
295
def print_file(self, file, revision_id):
296
"""Print `file` to stdout."""
297
raise NotImplementedError(self.print_file)
299
def append_revision(self, *revision_ids):
300
raise NotImplementedError(self.append_revision)
302
def set_revision_history(self, rev_history):
303
raise NotImplementedError(self.set_revision_history)
305
def revision_history(self):
306
"""Return sequence of revision hashes on to this branch."""
307
raise NotImplementedError(self.revision_history)
310
"""Return current revision number for this branch.
312
That is equivalent to the number of revisions committed to
315
return len(self.revision_history())
318
"""Older format branches cannot bind or unbind."""
319
raise errors.UpgradeRequired(self.base)
321
def set_append_revisions_only(self, enabled):
322
"""Older format branches are never restricted to append-only"""
323
raise errors.UpgradeRequired(self.base)
325
def last_revision(self):
326
"""Return last revision id, or None"""
327
ph = self.revision_history()
333
def last_revision_info(self):
334
"""Return information about the last revision.
336
:return: A tuple (revno, last_revision_id).
338
rh = self.revision_history()
341
return (revno, rh[-1])
343
return (0, _mod_revision.NULL_REVISION)
345
def missing_revisions(self, other, stop_revision=None):
346
"""Return a list of new revisions that would perfectly fit.
348
If self and other have not diverged, return a list of the revisions
349
present in other, but missing from self.
351
self_history = self.revision_history()
352
self_len = len(self_history)
353
other_history = other.revision_history()
354
other_len = len(other_history)
355
common_index = min(self_len, other_len) -1
356
if common_index >= 0 and \
357
self_history[common_index] != other_history[common_index]:
358
raise DivergedBranches(self, other)
360
if stop_revision is None:
361
stop_revision = other_len
363
assert isinstance(stop_revision, int)
364
if stop_revision > other_len:
365
raise errors.NoSuchRevision(self, stop_revision)
366
return other_history[self_len:stop_revision]
368
def update_revisions(self, other, stop_revision=None):
369
"""Pull in new perfect-fit revisions.
371
:param other: Another Branch to pull from
372
:param stop_revision: Updated until the given revision
375
raise NotImplementedError(self.update_revisions)
377
def revision_id_to_revno(self, revision_id):
378
"""Given a revision id, return its revno"""
379
if revision_id is None:
381
revision_id = osutils.safe_revision_id(revision_id)
382
history = self.revision_history()
384
return history.index(revision_id) + 1
386
raise bzrlib.errors.NoSuchRevision(self, revision_id)
388
def get_rev_id(self, revno, history=None):
389
"""Find the revision id of the specified revno."""
393
history = self.revision_history()
394
if revno <= 0 or revno > len(history):
395
raise bzrlib.errors.NoSuchRevision(self, revno)
396
return history[revno - 1]
398
def pull(self, source, overwrite=False, stop_revision=None):
399
"""Mirror source into this branch.
401
This branch is considered to be 'local', having low latency.
403
raise NotImplementedError(self.pull)
405
def push(self, target, overwrite=False, stop_revision=None):
406
"""Mirror this branch into target.
408
This branch is considered to be 'local', having low latency.
410
raise NotImplementedError(self.push)
412
def basis_tree(self):
413
"""Return `Tree` object for last revision."""
414
return self.repository.revision_tree(self.last_revision())
416
def rename_one(self, from_rel, to_rel):
419
This can change the directory or the filename or both.
421
raise NotImplementedError(self.rename_one)
423
def move(self, from_paths, to_name):
426
to_name must exist as a versioned directory.
428
If to_name exists and is a directory, the files are moved into
429
it, keeping their old names. If it is a directory,
431
Note that to_name is only the last component of the new name;
432
this doesn't change the directory.
434
This returns a list of (from_path, to_path) pairs for each
437
raise NotImplementedError(self.move)
439
def get_parent(self):
440
"""Return the parent location of the branch.
442
This is the default location for push/pull/missing. The usual
443
pattern is that the user can override it by specifying a
446
raise NotImplementedError(self.get_parent)
448
def get_submit_branch(self):
449
"""Return the submit location of the branch.
451
This is the default location for bundle. The usual
452
pattern is that the user can override it by specifying a
455
return self.get_config().get_user_option('submit_branch')
457
def set_submit_branch(self, location):
458
"""Return the submit location of the branch.
460
This is the default location for bundle. The usual
461
pattern is that the user can override it by specifying a
464
self.get_config().set_user_option('submit_branch', location)
466
def get_push_location(self):
467
"""Return the None or the location to push this branch to."""
468
raise NotImplementedError(self.get_push_location)
470
def set_push_location(self, location):
471
"""Set a new push location for this branch."""
472
raise NotImplementedError(self.set_push_location)
474
def set_parent(self, url):
475
raise NotImplementedError(self.set_parent)
479
"""Synchronise this branch with the master branch if any.
481
:return: None or the last_revision pivoted out during the update.
485
def check_revno(self, revno):
487
Check whether a revno corresponds to any revision.
488
Zero (the NULL revision) is considered valid.
491
self.check_real_revno(revno)
493
def check_real_revno(self, revno):
495
Check whether a revno corresponds to a real revision.
496
Zero (the NULL revision) is considered invalid
498
if revno < 1 or revno > self.revno():
499
raise InvalidRevisionNumber(revno)
502
def clone(self, *args, **kwargs):
503
"""Clone this branch into to_bzrdir preserving all semantic values.
505
revision_id: if not None, the revision history in the new branch will
506
be truncated to end with revision_id.
508
# for API compatibility, until 0.8 releases we provide the old api:
509
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
510
# after 0.8 releases, the *args and **kwargs should be changed:
511
# def clone(self, to_bzrdir, revision_id=None):
512
if (kwargs.get('to_location', None) or
513
kwargs.get('revision', None) or
514
kwargs.get('basis_branch', None) or
515
(len(args) and isinstance(args[0], basestring))):
516
# backwards compatibility api:
517
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
518
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
521
basis_branch = args[2]
523
basis_branch = kwargs.get('basis_branch', None)
525
basis = basis_branch.bzrdir
530
revision_id = args[1]
532
revision_id = kwargs.get('revision', None)
537
# no default to raise if not provided.
538
url = kwargs.get('to_location')
539
return self.bzrdir.clone(url,
540
revision_id=revision_id,
541
basis=basis).open_branch()
543
# generate args by hand
545
revision_id = args[1]
547
revision_id = kwargs.get('revision_id', None)
551
# no default to raise if not provided.
552
to_bzrdir = kwargs.get('to_bzrdir')
553
result = self._format.initialize(to_bzrdir)
554
self.copy_content_into(result, revision_id=revision_id)
558
def sprout(self, to_bzrdir, revision_id=None):
559
"""Create a new line of development from the branch, into to_bzrdir.
561
revision_id: if not None, the revision history in the new branch will
562
be truncated to end with revision_id.
564
result = self._format.initialize(to_bzrdir)
565
self.copy_content_into(result, revision_id=revision_id)
566
result.set_parent(self.bzrdir.root_transport.base)
569
def _synchronize_history(self, destination, revision_id):
570
"""Synchronize last revision and revision history between branches.
572
This version is most efficient when the destination is also a
573
BzrBranch5, but works for BzrBranch6 as long as the revision
574
history is the true lefthand parent history, and all of the revisions
575
are in the destination's repository. If not, set_revision_history
578
:param destination: The branch to copy the history into
579
:param revision_id: The revision-id to truncate history at. May
580
be None to copy complete history.
582
new_history = self.revision_history()
583
if revision_id is not None:
584
revision_id = osutils.safe_revision_id(revision_id)
586
new_history = new_history[:new_history.index(revision_id) + 1]
588
rev = self.repository.get_revision(revision_id)
589
new_history = rev.get_history(self.repository)[1:]
590
destination.set_revision_history(new_history)
593
def copy_content_into(self, destination, revision_id=None):
594
"""Copy the content of self into destination.
596
revision_id: if not None, the revision history in the new branch will
597
be truncated to end with revision_id.
599
self._synchronize_history(destination, revision_id)
601
parent = self.get_parent()
602
except errors.InaccessibleParent, e:
603
mutter('parent was not accessible to copy: %s', e)
606
destination.set_parent(parent)
610
"""Check consistency of the branch.
612
In particular this checks that revisions given in the revision-history
613
do actually match up in the revision graph, and that they're all
614
present in the repository.
616
Callers will typically also want to check the repository.
618
:return: A BranchCheckResult.
620
mainline_parent_id = None
621
for revision_id in self.revision_history():
623
revision = self.repository.get_revision(revision_id)
624
except errors.NoSuchRevision, e:
625
raise errors.BzrCheckError("mainline revision {%s} not in repository"
627
# In general the first entry on the revision history has no parents.
628
# But it's not illegal for it to have parents listed; this can happen
629
# in imports from Arch when the parents weren't reachable.
630
if mainline_parent_id is not None:
631
if mainline_parent_id not in revision.parent_ids:
632
raise errors.BzrCheckError("previous revision {%s} not listed among "
634
% (mainline_parent_id, revision_id))
635
mainline_parent_id = revision_id
636
return BranchCheckResult(self)
638
def _get_checkout_format(self):
639
"""Return the most suitable metadir for a checkout of this branch.
640
Weaves are used if this branch's repostory uses weaves.
642
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
643
from bzrlib.repofmt import weaverepo
644
format = bzrdir.BzrDirMetaFormat1()
645
format.repository_format = weaverepo.RepositoryFormat7()
647
format = self.repository.bzrdir.checkout_metadir()
648
format.branch_format = self._format
651
def create_checkout(self, to_location, revision_id=None,
653
"""Create a checkout of a branch.
655
:param to_location: The url to produce the checkout at
656
:param revision_id: The revision to check out
657
:param lightweight: If True, produce a lightweight checkout, otherwise,
658
produce a bound branch (heavyweight checkout)
659
:return: The tree of the created checkout
661
t = transport.get_transport(to_location)
664
except errors.FileExists:
667
format = self._get_checkout_format()
668
checkout = format.initialize_on_transport(t)
669
BranchReferenceFormat().initialize(checkout, self)
671
format = self._get_checkout_format()
672
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
673
to_location, force_new_tree=False, format=format)
674
checkout = checkout_branch.bzrdir
675
checkout_branch.bind(self)
676
# pull up to the specified revision_id to set the initial
677
# branch tip correctly, and seed it with history.
678
checkout_branch.pull(self, stop_revision=revision_id)
679
tree = checkout.create_workingtree(revision_id)
680
for path, entry in tree.iter_reference_entries():
681
path = tree.id2path(entry.file_id)
682
reference_parent = self.reference_parent(entry.file_id, path)
683
reference_parent.create_checkout(tree.abspath(path),
684
entry.reference_revision,
688
def reference_parent(self, file_id, path):
689
"""Return the parent branch for a tree-reference file_id
690
:param file_id: The file_id of the tree reference
691
:param path: The path of the file_id in the tree
692
:return: A branch associated with the file_id
694
# FIXME should provide multiple branches, based on config
695
return Branch.open(self.bzrdir.root_transport.clone(path).base)
698
class BranchFormat(object):
699
"""An encapsulation of the initialization and open routines for a format.
701
Formats provide three things:
702
* An initialization routine,
706
Formats are placed in an dict by their format string for reference
707
during branch opening. Its not required that these be instances, they
708
can be classes themselves with class methods - it simply depends on
709
whether state is needed for a given format or not.
711
Once a format is deprecated, just deprecate the initialize and open
712
methods on the format class. Do not deprecate the object, as the
713
object will be created every time regardless.
716
_default_format = None
717
"""The default format used for new branches."""
720
"""The known formats."""
723
def find_format(klass, a_bzrdir):
724
"""Return the format for the branch object in a_bzrdir."""
726
transport = a_bzrdir.get_branch_transport(None)
727
format_string = transport.get("format").read()
728
return klass._formats[format_string]
730
raise NotBranchError(path=transport.base)
732
raise errors.UnknownFormatError(format=format_string)
735
def get_default_format(klass):
736
"""Return the current default format."""
737
return klass._default_format
739
def get_format_string(self):
740
"""Return the ASCII format string that identifies this format."""
741
raise NotImplementedError(self.get_format_string)
743
def get_format_description(self):
744
"""Return the short format description for this format."""
745
raise NotImplementedError(self.get_format_description)
747
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
749
"""Initialize a branch in a bzrdir, with specified files
751
:param a_bzrdir: The bzrdir to initialize the branch in
752
:param utf8_files: The files to create as a list of
753
(filename, content) tuples
754
:param set_format: If True, set the format with
755
self.get_format_string. (BzrBranch4 has its format set
757
:return: a branch in this format
759
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
760
branch_transport = a_bzrdir.get_branch_transport(self)
762
'metadir': ('lock', lockdir.LockDir),
763
'branch4': ('branch-lock', lockable_files.TransportLock),
765
lock_name, lock_class = lock_map[lock_type]
766
control_files = lockable_files.LockableFiles(branch_transport,
767
lock_name, lock_class)
768
control_files.create_lock()
769
control_files.lock_write()
771
control_files.put_utf8('format', self.get_format_string())
773
for file, content in utf8_files:
774
control_files.put_utf8(file, content)
776
control_files.unlock()
777
return self.open(a_bzrdir, _found=True)
779
def initialize(self, a_bzrdir):
780
"""Create a branch of this format in a_bzrdir."""
781
raise NotImplementedError(self.initialize)
783
def is_supported(self):
784
"""Is this format supported?
786
Supported formats can be initialized and opened.
787
Unsupported formats may not support initialization or committing or
788
some other features depending on the reason for not being supported.
792
def open(self, a_bzrdir, _found=False):
793
"""Return the branch object for a_bzrdir
795
_found is a private parameter, do not use it. It is used to indicate
796
if format probing has already be done.
798
raise NotImplementedError(self.open)
801
def register_format(klass, format):
802
klass._formats[format.get_format_string()] = format
805
def set_default_format(klass, format):
806
klass._default_format = format
809
def unregister_format(klass, format):
810
assert klass._formats[format.get_format_string()] is format
811
del klass._formats[format.get_format_string()]
814
return self.get_format_string().rstrip()
817
class BranchHooks(dict):
818
"""A dictionary mapping hook name to a list of callables for branch hooks.
820
e.g. ['set_rh'] Is the list of items to be called when the
821
set_revision_history function is invoked.
825
"""Create the default hooks.
827
These are all empty initially, because by default nothing should get
831
# Introduced in 0.15:
832
# invoked whenever the revision history has been set
833
# with set_revision_history. The api signature is
834
# (branch, revision_history), and the branch will
837
# invoked after a push operation completes.
838
# the api signature is
839
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
840
# where local is the local branch or None, master is the target
841
# master branch, and the rest should be self explanatory. The source
842
# is read locked and the target branches write locked. Source will
843
# be the local low-latency branch.
844
self['post_push'] = []
845
# invoked after a pull operation completes.
846
# the api signature is
847
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
848
# where local is the local branch or None, master is the target
849
# master branch, and the rest should be self explanatory. The source
850
# is read locked and the target branches write locked. The local
851
# branch is the low-latency branch.
852
self['post_pull'] = []
853
# invoked after a commit operation completes.
854
# the api signature is
855
# (local, master, old_revno, old_revid, new_revno, new_revid)
856
# old_revid is NULL_REVISION for the first commit to a branch.
857
self['post_commit'] = []
858
# invoked after a uncommit operation completes.
859
# the api signature is
860
# (local, master, old_revno, old_revid, new_revno, new_revid) where
861
# local is the local branch or None, master is the target branch,
862
# and an empty branch recieves new_revno of 0, new_revid of None.
863
self['post_uncommit'] = []
865
def install_hook(self, hook_name, a_callable):
866
"""Install a_callable in to the hook hook_name.
868
:param hook_name: A hook name. See the __init__ method of BranchHooks
869
for the complete list of hooks.
870
:param a_callable: The callable to be invoked when the hook triggers.
871
The exact signature will depend on the hook - see the __init__
872
method of BranchHooks for details on each hook.
875
self[hook_name].append(a_callable)
877
raise errors.UnknownHook('branch', hook_name)
880
# install the default hooks into the Branch class.
881
Branch.hooks = BranchHooks()
884
class BzrBranchFormat4(BranchFormat):
885
"""Bzr branch format 4.
888
- a revision-history file.
889
- a branch-lock lock file [ to be shared with the bzrdir ]
892
def get_format_description(self):
893
"""See BranchFormat.get_format_description()."""
894
return "Branch format 4"
896
def initialize(self, a_bzrdir):
897
"""Create a branch of this format in a_bzrdir."""
898
utf8_files = [('revision-history', ''),
901
return self._initialize_helper(a_bzrdir, utf8_files,
902
lock_type='branch4', set_format=False)
905
super(BzrBranchFormat4, self).__init__()
906
self._matchingbzrdir = bzrdir.BzrDirFormat6()
908
def open(self, a_bzrdir, _found=False):
909
"""Return the branch object for a_bzrdir
911
_found is a private parameter, do not use it. It is used to indicate
912
if format probing has already be done.
915
# we are being called directly and must probe.
916
raise NotImplementedError
917
return BzrBranch(_format=self,
918
_control_files=a_bzrdir._control_files,
920
_repository=a_bzrdir.open_repository())
923
return "Bazaar-NG branch format 4"
926
class BzrBranchFormat5(BranchFormat):
927
"""Bzr branch format 5.
930
- a revision-history file.
932
- a lock dir guarding the branch itself
933
- all of this stored in a branch/ subdirectory
934
- works with shared repositories.
936
This format is new in bzr 0.8.
939
def get_format_string(self):
940
"""See BranchFormat.get_format_string()."""
941
return "Bazaar-NG branch format 5\n"
943
def get_format_description(self):
944
"""See BranchFormat.get_format_description()."""
945
return "Branch format 5"
947
def initialize(self, a_bzrdir):
948
"""Create a branch of this format in a_bzrdir."""
949
utf8_files = [('revision-history', ''),
952
return self._initialize_helper(a_bzrdir, utf8_files)
955
super(BzrBranchFormat5, self).__init__()
956
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
958
def open(self, a_bzrdir, _found=False):
959
"""Return the branch object for a_bzrdir
961
_found is a private parameter, do not use it. It is used to indicate
962
if format probing has already be done.
965
format = BranchFormat.find_format(a_bzrdir)
966
assert format.__class__ == self.__class__
967
transport = a_bzrdir.get_branch_transport(None)
968
control_files = lockable_files.LockableFiles(transport, 'lock',
970
return BzrBranch5(_format=self,
971
_control_files=control_files,
973
_repository=a_bzrdir.find_repository())
976
return "Bazaar-NG Metadir branch format 5"
979
class BzrBranchFormat6(BzrBranchFormat5):
980
"""Branch format with last-revision
982
Unlike previous formats, this has no explicit revision history. Instead,
983
this just stores the last-revision, and the left-hand history leading
984
up to there is the history.
986
This format was introduced in bzr 0.15
989
def get_format_string(self):
990
"""See BranchFormat.get_format_string()."""
991
return "Bazaar-NG branch format 6\n"
993
def get_format_description(self):
994
"""See BranchFormat.get_format_description()."""
995
return "Branch format 6"
997
def initialize(self, a_bzrdir):
998
"""Create a branch of this format in a_bzrdir."""
999
utf8_files = [('last-revision', '0 null:\n'),
1000
('branch-name', ''),
1003
return self._initialize_helper(a_bzrdir, utf8_files)
1005
def open(self, a_bzrdir, _found=False):
1006
"""Return the branch object for a_bzrdir
1008
_found is a private parameter, do not use it. It is used to indicate
1009
if format probing has already be done.
1012
format = BranchFormat.find_format(a_bzrdir)
1013
assert format.__class__ == self.__class__
1014
transport = a_bzrdir.get_branch_transport(None)
1015
control_files = lockable_files.LockableFiles(transport, 'lock',
1017
return BzrBranch6(_format=self,
1018
_control_files=control_files,
1020
_repository=a_bzrdir.find_repository())
1023
class BranchReferenceFormat(BranchFormat):
1024
"""Bzr branch reference format.
1026
Branch references are used in implementing checkouts, they
1027
act as an alias to the real branch which is at some other url.
1034
def get_format_string(self):
1035
"""See BranchFormat.get_format_string()."""
1036
return "Bazaar-NG Branch Reference Format 1\n"
1038
def get_format_description(self):
1039
"""See BranchFormat.get_format_description()."""
1040
return "Checkout reference format 1"
1042
def initialize(self, a_bzrdir, target_branch=None):
1043
"""Create a branch of this format in a_bzrdir."""
1044
if target_branch is None:
1045
# this format does not implement branch itself, thus the implicit
1046
# creation contract must see it as uninitializable
1047
raise errors.UninitializableFormat(self)
1048
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1049
branch_transport = a_bzrdir.get_branch_transport(self)
1050
branch_transport.put_bytes('location',
1051
target_branch.bzrdir.root_transport.base)
1052
branch_transport.put_bytes('format', self.get_format_string())
1053
return self.open(a_bzrdir, _found=True)
1056
super(BranchReferenceFormat, self).__init__()
1057
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1059
def _make_reference_clone_function(format, a_branch):
1060
"""Create a clone() routine for a branch dynamically."""
1061
def clone(to_bzrdir, revision_id=None):
1062
"""See Branch.clone()."""
1063
return format.initialize(to_bzrdir, a_branch)
1064
# cannot obey revision_id limits when cloning a reference ...
1065
# FIXME RBC 20060210 either nuke revision_id for clone, or
1066
# emit some sort of warning/error to the caller ?!
1069
def open(self, a_bzrdir, _found=False):
1070
"""Return the branch that the branch reference in a_bzrdir points at.
1072
_found is a private parameter, do not use it. It is used to indicate
1073
if format probing has already be done.
1076
format = BranchFormat.find_format(a_bzrdir)
1077
assert format.__class__ == self.__class__
1078
transport = a_bzrdir.get_branch_transport(None)
1079
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1080
result = real_bzrdir.open_branch()
1081
# this changes the behaviour of result.clone to create a new reference
1082
# rather than a copy of the content of the branch.
1083
# I did not use a proxy object because that needs much more extensive
1084
# testing, and we are only changing one behaviour at the moment.
1085
# If we decide to alter more behaviours - i.e. the implicit nickname
1086
# then this should be refactored to introduce a tested proxy branch
1087
# and a subclass of that for use in overriding clone() and ....
1089
result.clone = self._make_reference_clone_function(result)
1093
# formats which have no format string are not discoverable
1094
# and not independently creatable, so are not registered.
1095
__default_format = BzrBranchFormat5()
1096
BranchFormat.register_format(__default_format)
1097
BranchFormat.register_format(BranchReferenceFormat())
1098
BranchFormat.register_format(BzrBranchFormat6())
1099
BranchFormat.set_default_format(__default_format)
1100
_legacy_formats = [BzrBranchFormat4(),
1103
class BzrBranch(Branch):
1104
"""A branch stored in the actual filesystem.
1106
Note that it's "local" in the context of the filesystem; it doesn't
1107
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1108
it's writable, and can be accessed via the normal filesystem API.
1111
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1112
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1113
_control_files=None, a_bzrdir=None, _repository=None):
1114
"""Create new branch object at a particular location.
1116
transport -- A Transport object, defining how to access files.
1118
init -- If True, create new control files in a previously
1119
unversioned directory. If False, the branch must already
1122
relax_version_check -- If true, the usual check for the branch
1123
version is not applied. This is intended only for
1124
upgrade/recovery type use; it's not guaranteed that
1125
all operations will work on old format branches.
1127
if a_bzrdir is None:
1128
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1130
self.bzrdir = a_bzrdir
1131
self._transport = self.bzrdir.transport.clone('..')
1132
self._base = self._transport.base
1133
self._format = _format
1134
if _control_files is None:
1135
raise ValueError('BzrBranch _control_files is None')
1136
self.control_files = _control_files
1137
if deprecated_passed(init):
1138
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1139
"deprecated as of bzr 0.8. Please use Branch.create().",
1143
# this is slower than before deprecation, oh well never mind.
1144
# -> its deprecated.
1145
self._initialize(transport.base)
1146
self._check_format(_format)
1147
if deprecated_passed(relax_version_check):
1148
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1149
"relax_version_check parameter is deprecated as of bzr 0.8. "
1150
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1154
if (not relax_version_check
1155
and not self._format.is_supported()):
1156
raise errors.UnsupportedFormatError(format=fmt)
1157
if deprecated_passed(transport):
1158
warn("BzrBranch.__init__(transport=XXX...): The transport "
1159
"parameter is deprecated as of bzr 0.8. "
1160
"Please use Branch.open, or bzrdir.open_branch().",
1163
self.repository = _repository
1166
return '%s(%r)' % (self.__class__.__name__, self.base)
1170
def _get_base(self):
1173
base = property(_get_base, doc="The URL for the root of this branch.")
1175
def _finish_transaction(self):
1176
"""Exit the current transaction."""
1177
return self.control_files._finish_transaction()
1179
def get_transaction(self):
1180
"""Return the current active transaction.
1182
If no transaction is active, this returns a passthrough object
1183
for which all data is immediately flushed and no caching happens.
1185
# this is an explicit function so that we can do tricky stuff
1186
# when the storage in rev_storage is elsewhere.
1187
# we probably need to hook the two 'lock a location' and
1188
# 'have a transaction' together more delicately, so that
1189
# we can have two locks (branch and storage) and one transaction
1190
# ... and finishing the transaction unlocks both, but unlocking
1191
# does not. - RBC 20051121
1192
return self.control_files.get_transaction()
1194
def _set_transaction(self, transaction):
1195
"""Set a new active transaction."""
1196
return self.control_files._set_transaction(transaction)
1198
def abspath(self, name):
1199
"""See Branch.abspath."""
1200
return self.control_files._transport.abspath(name)
1202
def _check_format(self, format):
1203
"""Identify the branch format if needed.
1205
The format is stored as a reference to the format object in
1206
self._format for code that needs to check it later.
1208
The format parameter is either None or the branch format class
1209
used to open this branch.
1211
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1214
format = BranchFormat.find_format(self.bzrdir)
1215
self._format = format
1216
mutter("got branch format %s", self._format)
1219
def get_root_id(self):
1220
"""See Branch.get_root_id."""
1221
tree = self.repository.revision_tree(self.last_revision())
1222
return tree.inventory.root.file_id
1224
def is_locked(self):
1225
return self.control_files.is_locked()
1227
def lock_write(self):
1228
self.repository.lock_write()
1230
self.control_files.lock_write()
1232
self.repository.unlock()
1235
def lock_read(self):
1236
self.repository.lock_read()
1238
self.control_files.lock_read()
1240
self.repository.unlock()
1244
# TODO: test for failed two phase locks. This is known broken.
1246
self.control_files.unlock()
1248
self.repository.unlock()
1250
def peek_lock_mode(self):
1251
if self.control_files._lock_count == 0:
1254
return self.control_files._lock_mode
1256
def get_physical_lock_status(self):
1257
return self.control_files.get_physical_lock_status()
1260
def print_file(self, file, revision_id):
1261
"""See Branch.print_file."""
1262
return self.repository.print_file(file, revision_id)
1265
def append_revision(self, *revision_ids):
1266
"""See Branch.append_revision."""
1267
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1268
for revision_id in revision_ids:
1269
_mod_revision.check_not_reserved_id(revision_id)
1270
mutter("add {%s} to revision-history" % revision_id)
1271
rev_history = self.revision_history()
1272
rev_history.extend(revision_ids)
1273
self.set_revision_history(rev_history)
1275
def _write_revision_history(self, history):
1276
"""Factored out of set_revision_history.
1278
This performs the actual writing to disk.
1279
It is intended to be called by BzrBranch5.set_revision_history."""
1280
self.control_files.put_bytes(
1281
'revision-history', '\n'.join(history))
1284
def set_revision_history(self, rev_history):
1285
"""See Branch.set_revision_history."""
1286
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1287
self._write_revision_history(rev_history)
1288
transaction = self.get_transaction()
1289
history = transaction.map.find_revision_history()
1290
if history is not None:
1291
# update the revision history in the identity map.
1292
history[:] = list(rev_history)
1293
# this call is disabled because revision_history is
1294
# not really an object yet, and the transaction is for objects.
1295
# transaction.register_dirty(history)
1297
transaction.map.add_revision_history(rev_history)
1298
# this call is disabled because revision_history is
1299
# not really an object yet, and the transaction is for objects.
1300
# transaction.register_clean(history)
1301
for hook in Branch.hooks['set_rh']:
1302
hook(self, rev_history)
1305
def set_last_revision_info(self, revno, revision_id):
1306
revision_id = osutils.safe_revision_id(revision_id)
1307
history = self._lefthand_history(revision_id)
1308
assert len(history) == revno, '%d != %d' % (len(history), revno)
1309
self.set_revision_history(history)
1311
def _gen_revision_history(self):
1312
get_cached_utf8 = cache_utf8.get_cached_utf8
1313
history = [get_cached_utf8(l.rstrip('\r\n')) for l in
1314
self.control_files.get('revision-history').readlines()]
1318
def revision_history(self):
1319
"""See Branch.revision_history."""
1320
transaction = self.get_transaction()
1321
history = transaction.map.find_revision_history()
1322
if history is not None:
1323
# mutter("cache hit for revision-history in %s", self)
1324
return list(history)
1325
history = self._gen_revision_history()
1326
transaction.map.add_revision_history(history)
1327
# this call is disabled because revision_history is
1328
# not really an object yet, and the transaction is for objects.
1329
# transaction.register_clean(history, precious=True)
1330
return list(history)
1332
def _lefthand_history(self, revision_id, last_rev=None,
1334
# stop_revision must be a descendant of last_revision
1335
stop_graph = self.repository.get_revision_graph(revision_id)
1336
if last_rev is not None and last_rev not in stop_graph:
1337
# our previous tip is not merged into stop_revision
1338
raise errors.DivergedBranches(self, other_branch)
1339
# make a new revision history from the graph
1340
current_rev_id = revision_id
1342
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1343
new_history.append(current_rev_id)
1344
current_rev_id_parents = stop_graph[current_rev_id]
1346
current_rev_id = current_rev_id_parents[0]
1348
current_rev_id = None
1349
new_history.reverse()
1353
def generate_revision_history(self, revision_id, last_rev=None,
1355
"""Create a new revision history that will finish with revision_id.
1357
:param revision_id: the new tip to use.
1358
:param last_rev: The previous last_revision. If not None, then this
1359
must be a ancestory of revision_id, or DivergedBranches is raised.
1360
:param other_branch: The other branch that DivergedBranches should
1361
raise with respect to.
1363
revision_id = osutils.safe_revision_id(revision_id)
1364
self.set_revision_history(self._lefthand_history(revision_id,
1365
last_rev, other_branch))
1368
def update_revisions(self, other, stop_revision=None):
1369
"""See Branch.update_revisions."""
1372
if stop_revision is None:
1373
stop_revision = other.last_revision()
1374
if stop_revision is None:
1375
# if there are no commits, we're done.
1378
stop_revision = osutils.safe_revision_id(stop_revision)
1379
# whats the current last revision, before we fetch [and change it
1381
last_rev = self.last_revision()
1382
# we fetch here regardless of whether we need to so that we pickup
1384
self.fetch(other, stop_revision)
1385
my_ancestry = self.repository.get_ancestry(last_rev)
1386
if stop_revision in my_ancestry:
1387
# last_revision is a descendant of stop_revision
1389
self.generate_revision_history(stop_revision, last_rev=last_rev,
1394
def basis_tree(self):
1395
"""See Branch.basis_tree."""
1396
return self.repository.revision_tree(self.last_revision())
1398
@deprecated_method(zero_eight)
1399
def working_tree(self):
1400
"""Create a Working tree object for this branch."""
1402
from bzrlib.transport.local import LocalTransport
1403
if (self.base.find('://') != -1 or
1404
not isinstance(self._transport, LocalTransport)):
1405
raise NoWorkingTree(self.base)
1406
return self.bzrdir.open_workingtree()
1409
def pull(self, source, overwrite=False, stop_revision=None,
1410
_hook_master=None, _run_hooks=True):
1413
:param _hook_master: Private parameter - set the branch to
1414
be supplied as the master to push hooks.
1415
:param _run_hooks: Private parameter - allow disabling of
1416
hooks, used when pushing to a master branch.
1420
old_count, old_tip = self.last_revision_info()
1422
self.update_revisions(source, stop_revision)
1423
except DivergedBranches:
1427
self.set_revision_history(source.revision_history())
1428
new_count, new_tip = self.last_revision_info()
1435
for hook in Branch.hooks['post_pull']:
1436
hook(source, _hook_local, _hook_master, old_count, old_tip,
1438
return new_count - old_count
1442
def _get_parent_location(self):
1443
_locs = ['parent', 'pull', 'x-pull']
1446
return self.control_files.get(l).read().strip('\n')
1452
def push(self, target, overwrite=False, stop_revision=None,
1453
_hook_master=None, _run_hooks=True):
1456
:param _hook_master: Private parameter - set the branch to
1457
be supplied as the master to push hooks.
1458
:param _run_hooks: Private parameter - allow disabling of
1459
hooks, used when pushing to a master branch.
1463
old_count, old_tip = target.last_revision_info()
1465
target.update_revisions(self, stop_revision)
1466
except DivergedBranches:
1470
target.set_revision_history(self.revision_history())
1471
new_count, new_tip = target.last_revision_info()
1474
_hook_local = target
1476
_hook_master = target
1478
for hook in Branch.hooks['post_push']:
1479
hook(self, _hook_local, _hook_master, old_count, old_tip,
1481
return new_count - old_count
1485
def get_parent(self):
1486
"""See Branch.get_parent."""
1488
assert self.base[-1] == '/'
1489
parent = self._get_parent_location()
1492
# This is an old-format absolute path to a local branch
1493
# turn it into a url
1494
if parent.startswith('/'):
1495
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1497
return urlutils.join(self.base[:-1], parent)
1498
except errors.InvalidURLJoin, e:
1499
raise errors.InaccessibleParent(parent, self.base)
1501
def get_push_location(self):
1502
"""See Branch.get_push_location."""
1503
push_loc = self.get_config().get_user_option('push_location')
1506
def set_push_location(self, location):
1507
"""See Branch.set_push_location."""
1508
self.get_config().set_user_option(
1509
'push_location', location,
1510
store=_mod_config.STORE_LOCATION_NORECURSE)
1513
def set_parent(self, url):
1514
"""See Branch.set_parent."""
1515
# TODO: Maybe delete old location files?
1516
# URLs should never be unicode, even on the local fs,
1517
# FIXUP this and get_parent in a future branch format bump:
1518
# read and rewrite the file, and have the new format code read
1519
# using .get not .get_utf8. RBC 20060125
1521
if isinstance(url, unicode):
1523
url = url.encode('ascii')
1524
except UnicodeEncodeError:
1525
raise bzrlib.errors.InvalidURL(url,
1526
"Urls must be 7-bit ascii, "
1527
"use bzrlib.urlutils.escape")
1528
url = urlutils.relative_url(self.base, url)
1529
self._set_parent_location(url)
1531
def _set_parent_location(self, url):
1533
self.control_files._transport.delete('parent')
1535
assert isinstance(url, str)
1536
self.control_files.put_bytes('parent', url + '\n')
1538
@deprecated_function(zero_nine)
1539
def tree_config(self):
1540
"""DEPRECATED; call get_config instead.
1541
TreeConfig has become part of BranchConfig."""
1542
return TreeConfig(self)
1545
class BzrBranch5(BzrBranch):
1546
"""A format 5 branch. This supports new features over plan branches.
1548
It has support for a master_branch which is the data for bound branches.
1556
super(BzrBranch5, self).__init__(_format=_format,
1557
_control_files=_control_files,
1559
_repository=_repository)
1562
def pull(self, source, overwrite=False, stop_revision=None,
1564
"""Extends branch.pull to be bound branch aware.
1566
:param _run_hooks: Private parameter used to force hook running
1567
off during bound branch double-pushing.
1569
bound_location = self.get_bound_location()
1570
master_branch = None
1571
if bound_location and source.base != bound_location:
1572
# not pulling from master, so we need to update master.
1573
master_branch = self.get_master_branch()
1574
master_branch.lock_write()
1577
# pull from source into master.
1578
master_branch.pull(source, overwrite, stop_revision,
1580
return super(BzrBranch5, self).pull(source, overwrite,
1581
stop_revision, _hook_master=master_branch,
1582
_run_hooks=_run_hooks)
1585
master_branch.unlock()
1588
def push(self, target, overwrite=False, stop_revision=None):
1589
"""Updates branch.push to be bound branch aware."""
1590
bound_location = target.get_bound_location()
1591
master_branch = None
1592
if bound_location and target.base != bound_location:
1593
# not pushing to master, so we need to update master.
1594
master_branch = target.get_master_branch()
1595
master_branch.lock_write()
1598
# push into the master from this branch.
1599
super(BzrBranch5, self).push(master_branch, overwrite,
1600
stop_revision, _run_hooks=False)
1601
# and push into the target branch from this. Note that we push from
1602
# this branch again, because its considered the highest bandwidth
1604
return super(BzrBranch5, self).push(target, overwrite,
1605
stop_revision, _hook_master=master_branch)
1608
master_branch.unlock()
1610
def get_bound_location(self):
1612
return self.control_files.get_utf8('bound').read()[:-1]
1613
except errors.NoSuchFile:
1617
def get_master_branch(self):
1618
"""Return the branch we are bound to.
1620
:return: Either a Branch, or None
1622
This could memoise the branch, but if thats done
1623
it must be revalidated on each new lock.
1624
So for now we just don't memoise it.
1625
# RBC 20060304 review this decision.
1627
bound_loc = self.get_bound_location()
1631
return Branch.open(bound_loc)
1632
except (errors.NotBranchError, errors.ConnectionError), e:
1633
raise errors.BoundBranchConnectionFailure(
1637
def set_bound_location(self, location):
1638
"""Set the target where this branch is bound to.
1640
:param location: URL to the target branch
1643
self.control_files.put_utf8('bound', location+'\n')
1646
self.control_files._transport.delete('bound')
1652
def bind(self, other):
1653
"""Bind this branch to the branch other.
1655
This does not push or pull data between the branches, though it does
1656
check for divergence to raise an error when the branches are not
1657
either the same, or one a prefix of the other. That behaviour may not
1658
be useful, so that check may be removed in future.
1660
:param other: The branch to bind to
1663
# TODO: jam 20051230 Consider checking if the target is bound
1664
# It is debatable whether you should be able to bind to
1665
# a branch which is itself bound.
1666
# Committing is obviously forbidden,
1667
# but binding itself may not be.
1668
# Since we *have* to check at commit time, we don't
1669
# *need* to check here
1671
# we want to raise diverged if:
1672
# last_rev is not in the other_last_rev history, AND
1673
# other_last_rev is not in our history, and do it without pulling
1675
last_rev = self.last_revision()
1676
if last_rev is not None:
1679
other_last_rev = other.last_revision()
1680
if other_last_rev is not None:
1681
# neither branch is new, we have to do some work to
1682
# ascertain diversion.
1683
remote_graph = other.repository.get_revision_graph(
1685
local_graph = self.repository.get_revision_graph(last_rev)
1686
if (last_rev not in remote_graph and
1687
other_last_rev not in local_graph):
1688
raise errors.DivergedBranches(self, other)
1691
self.set_bound_location(other.base)
1695
"""If bound, unbind"""
1696
return self.set_bound_location(None)
1700
"""Synchronise this branch with the master branch if any.
1702
:return: None or the last_revision that was pivoted out during the
1705
master = self.get_master_branch()
1706
if master is not None:
1707
old_tip = self.last_revision()
1708
self.pull(master, overwrite=True)
1709
if old_tip in self.repository.get_ancestry(self.last_revision()):
1715
class BzrBranch6(BzrBranch5):
1718
def last_revision_info(self):
1719
revision_string = self.control_files.get('last-revision').read()
1720
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1721
revision_id = cache_utf8.get_cached_utf8(revision_id)
1723
return revno, revision_id
1725
def last_revision(self):
1726
"""Return last revision id, or None"""
1727
revision_id = self.last_revision_info()[1]
1728
if revision_id == _mod_revision.NULL_REVISION:
1732
def _write_last_revision_info(self, revno, revision_id):
1733
"""Simply write out the revision id, with no checks.
1735
Use set_last_revision_info to perform this safely.
1737
Does not update the revision_history cache.
1738
Intended to be called by set_last_revision_info and
1739
_write_revision_history.
1741
if revision_id is None:
1742
revision_id = 'null:'
1743
out_string = '%d %s\n' % (revno, revision_id)
1744
self.control_files.put_bytes('last-revision', out_string)
1747
def set_last_revision_info(self, revno, revision_id):
1748
revision_id = osutils.safe_revision_id(revision_id)
1749
if self._get_append_revisions_only():
1750
self._check_history_violation(revision_id)
1751
self._write_last_revision_info(revno, revision_id)
1752
transaction = self.get_transaction()
1753
cached_history = transaction.map.find_revision_history()
1754
if cached_history is not None:
1755
transaction.map.remove_object(cached_history)
1757
def _check_history_violation(self, revision_id):
1758
last_revision = self.last_revision()
1759
if last_revision is None:
1761
if last_revision not in self._lefthand_history(revision_id):
1762
raise errors.AppendRevisionsOnlyViolation(self.base)
1764
def _gen_revision_history(self):
1765
"""Generate the revision history from last revision
1767
history = list(self.repository.iter_reverse_revision_history(
1768
self.last_revision()))
1772
def _write_revision_history(self, history):
1773
"""Factored out of set_revision_history.
1775
This performs the actual writing to disk, with format-specific checks.
1776
It is intended to be called by BzrBranch5.set_revision_history.
1778
if len(history) == 0:
1779
last_revision = 'null:'
1781
if history != self._lefthand_history(history[-1]):
1782
raise errors.NotLefthandHistory(history)
1783
last_revision = history[-1]
1784
if self._get_append_revisions_only():
1785
self._check_history_violation(last_revision)
1786
self._write_last_revision_info(len(history), last_revision)
1789
def append_revision(self, *revision_ids):
1790
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1791
if len(revision_ids) == 0:
1793
prev_revno, prev_revision = self.last_revision_info()
1794
for revision in self.repository.get_revisions(revision_ids):
1795
if prev_revision == _mod_revision.NULL_REVISION:
1796
if revision.parent_ids != []:
1797
raise errors.NotLeftParentDescendant(self, prev_revision,
1798
revision.revision_id)
1800
if revision.parent_ids[0] != prev_revision:
1801
raise errors.NotLeftParentDescendant(self, prev_revision,
1802
revision.revision_id)
1803
prev_revision = revision.revision_id
1804
self.set_last_revision_info(prev_revno + len(revision_ids),
1807
def _set_config_location(self, name, url, config=None,
1808
make_relative=False):
1810
config = self.get_config()
1814
url = urlutils.relative_url(self.base, url)
1815
config.set_user_option(name, url)
1818
def _get_config_location(self, name, config=None):
1820
config = self.get_config()
1821
location = config.get_user_option(name)
1827
def _set_parent_location(self, url):
1828
"""Set the parent branch"""
1829
self._set_config_location('parent_location', url, make_relative=True)
1832
def _get_parent_location(self):
1833
"""Set the parent branch"""
1834
return self._get_config_location('parent_location')
1836
def set_push_location(self, location):
1837
"""See Branch.set_push_location."""
1838
self._set_config_location('push_location', location)
1840
def set_bound_location(self, location):
1841
"""See Branch.set_push_location."""
1843
config = self.get_config()
1844
if location is None:
1845
if config.get_user_option('bound') != 'True':
1848
config.set_user_option('bound', 'False')
1851
self._set_config_location('bound_location', location,
1853
config.set_user_option('bound', 'True')
1856
def _get_bound_location(self, bound):
1857
"""Return the bound location in the config file.
1859
Return None if the bound parameter does not match"""
1860
config = self.get_config()
1861
config_bound = (config.get_user_option('bound') == 'True')
1862
if config_bound != bound:
1864
return self._get_config_location('bound_location', config=config)
1866
def get_bound_location(self):
1867
"""See Branch.set_push_location."""
1868
return self._get_bound_location(True)
1870
def get_old_bound_location(self):
1871
"""See Branch.get_old_bound_location"""
1872
return self._get_bound_location(False)
1874
def set_append_revisions_only(self, enabled):
1879
self.get_config().set_user_option('append_revisions_only', value)
1881
def _get_append_revisions_only(self):
1882
value = self.get_config().get_user_option('append_revisions_only')
1883
return value == 'True'
1885
def _synchronize_history(self, destination, revision_id):
1886
"""Synchronize last revision and revision history between branches.
1888
This version is most efficient when the destination is also a
1889
BzrBranch6, but works for BzrBranch5, as long as the destination's
1890
repository contains all the lefthand ancestors of the intended
1891
last_revision. If not, set_last_revision_info will fail.
1893
:param destination: The branch to copy the history into
1894
:param revision_id: The revision-id to truncate history at. May
1895
be None to copy complete history.
1897
if revision_id is None:
1898
revno, revision_id = self.last_revision_info()
1900
revno = self.revision_id_to_revno(revision_id)
1901
destination.set_last_revision_info(revno, revision_id)
1904
class BranchTestProviderAdapter(object):
1905
"""A tool to generate a suite testing multiple branch formats at once.
1907
This is done by copying the test once for each transport and injecting
1908
the transport_server, transport_readonly_server, and branch_format
1909
classes into each copy. Each copy is also given a new id() to make it
1913
def __init__(self, transport_server, transport_readonly_server, formats):
1914
self._transport_server = transport_server
1915
self._transport_readonly_server = transport_readonly_server
1916
self._formats = formats
1918
def adapt(self, test):
1919
result = TestSuite()
1920
for branch_format, bzrdir_format in self._formats:
1921
new_test = deepcopy(test)
1922
new_test.transport_server = self._transport_server
1923
new_test.transport_readonly_server = self._transport_readonly_server
1924
new_test.bzrdir_format = bzrdir_format
1925
new_test.branch_format = branch_format
1926
def make_new_test_id():
1927
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1928
return lambda: new_id
1929
new_test.id = make_new_test_id()
1930
result.addTest(new_test)
1934
class BranchCheckResult(object):
1935
"""Results of checking branch consistency.
1940
def __init__(self, branch):
1941
self.branch = branch
1943
def report_results(self, verbose):
1944
"""Report the check results via trace.note.
1946
:param verbose: Requests more detailed display of what was checked,
1949
note('checked branch %s format %s',
1951
self.branch._format)
1954
######################################################################
1958
@deprecated_function(zero_eight)
1959
def is_control_file(*args, **kwargs):
1960
"""See bzrlib.workingtree.is_control_file."""
1961
from bzrlib import workingtree
1962
return workingtree.is_control_file(*args, **kwargs)
1965
class Converter5to6(object):
1966
"""Perform an in-place upgrade of format 5 to format 6"""
1968
def convert(self, branch):
1969
# Data for 5 and 6 can peacefully coexist.
1970
format = BzrBranchFormat6()
1971
new_branch = format.open(branch.bzrdir, _found=True)
1973
# Copy source data into target
1974
new_branch.set_last_revision_info(*branch.last_revision_info())
1975
new_branch.set_parent(branch.get_parent())
1976
new_branch.set_bound_location(branch.get_bound_location())
1977
new_branch.set_push_location(branch.get_push_location())
1979
# Copying done; now update target format
1980
new_branch.control_files.put_utf8('format',
1981
format.get_format_string())
1983
# Clean up old files
1984
new_branch.control_files._transport.delete('revision-history')
1986
branch.set_parent(None)
1989
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
