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
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
57
from bzrlib.hooks import Hooks
58
from bzrlib.symbol_versioning import (deprecated_function,
62
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
104
def break_lock(self):
105
"""Break a lock if one is present from another instance.
107
Uses the ui factory to ask for confirmation if the lock may be from
110
This will probe the repository for its lock as well.
112
self.control_files.break_lock()
113
self.repository.break_lock()
114
master = self.get_master_branch()
115
if master is not None:
119
@deprecated_method(zero_eight)
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
126
"""Open the branch rooted at base.
128
For instance, if the branch is at URL/.bzr/branch,
129
Branch.open(URL) -> a Branch instance.
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url):
136
"""Open an existing branch which contains url.
138
This probes for a branch at url, and searches upwards from there.
140
Basically we keep looking up until we find the control directory or
141
run into the root. If there isn't one, raises NotBranchError.
142
If there is one and it is either an unrecognised format or an unsupported
143
format, UnknownFormatError or UnsupportedFormatError are raised.
144
If there is one, it is returned, along with the unused portion of url.
146
control, relpath = bzrdir.BzrDir.open_containing(url)
147
return control.open_branch(), relpath
150
@deprecated_function(zero_eight)
151
def initialize(base):
152
"""Create a new working tree and branch, rooted at 'base' (url)
154
NOTE: This will soon be deprecated in favour of creation
157
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
159
@deprecated_function(zero_eight)
160
def setup_caching(self, cache_root):
161
"""Subclasses that care about caching should override this, and set
162
up cached stores located under cache_root.
164
NOTE: This is unused.
168
def get_config(self):
169
return BranchConfig(self)
172
return self.get_config().get_nickname()
174
def _set_nick(self, nick):
175
self.get_config().set_user_option('nickname', nick)
177
nick = property(_get_nick, _set_nick)
180
raise NotImplementedError(self.is_locked)
182
def lock_write(self):
183
raise NotImplementedError(self.lock_write)
186
raise NotImplementedError(self.lock_read)
189
raise NotImplementedError(self.unlock)
191
def peek_lock_mode(self):
192
"""Return lock mode for the Branch: 'r', 'w' or None"""
193
raise NotImplementedError(self.peek_lock_mode)
195
def get_physical_lock_status(self):
196
raise NotImplementedError(self.get_physical_lock_status)
198
def leave_lock_in_place(self):
199
"""Tell this branch object not to release the physical lock when this
202
If lock_write doesn't return a token, then this method is not supported.
204
self.control_files.leave_in_place()
206
def dont_leave_lock_in_place(self):
207
"""Tell this branch object to release the physical lock when this
208
object is unlocked, even if it didn't originally acquire it.
210
If lock_write doesn't return a token, then this method is not supported.
212
self.control_files.dont_leave_in_place()
214
def abspath(self, name):
215
"""Return absolute filename for something in the branch
217
XXX: Robert Collins 20051017 what is this used for? why is it a branch
218
method and not a tree method.
220
raise NotImplementedError(self.abspath)
222
def bind(self, other):
223
"""Bind the local branch the other branch.
225
:param other: The branch to bind to
228
raise errors.UpgradeRequired(self.base)
231
def fetch(self, from_branch, last_revision=None, pb=None):
232
"""Copy revisions from from_branch into this branch.
234
:param from_branch: Where to copy from.
235
:param last_revision: What revision to stop at (None for at the end
237
:param pb: An optional progress bar to use.
239
Returns the copied revision count and the failed revisions in a tuple:
242
if self.base == from_branch.base:
245
nested_pb = ui.ui_factory.nested_progress_bar()
250
from_branch.lock_read()
252
if last_revision is None:
253
pb.update('get source history')
254
last_revision = from_branch.last_revision()
255
if last_revision is None:
256
last_revision = _mod_revision.NULL_REVISION
257
return self.repository.fetch(from_branch.repository,
258
revision_id=last_revision,
261
if nested_pb is not None:
265
def get_bound_location(self):
266
"""Return the URL of the branch we are bound to.
268
Older format branches cannot bind, please be sure to use a metadir
273
def get_old_bound_location(self):
274
"""Return the URL of the branch we used to be bound to
276
raise errors.UpgradeRequired(self.base)
278
def get_commit_builder(self, parents, config=None, timestamp=None,
279
timezone=None, committer=None, revprops=None,
281
"""Obtain a CommitBuilder for this branch.
283
:param parents: Revision ids of the parents of the new revision.
284
:param config: Optional configuration to use.
285
:param timestamp: Optional timestamp recorded for commit.
286
:param timezone: Optional timezone for timestamp.
287
:param committer: Optional committer to set for commit.
288
:param revprops: Optional dictionary of revision properties.
289
:param revision_id: Optional revision id.
293
config = self.get_config()
295
return self.repository.get_commit_builder(self, parents, config,
296
timestamp, timezone, committer, revprops, revision_id)
298
def get_master_branch(self):
299
"""Return the branch we are bound to.
301
:return: Either a Branch, or None
305
def get_revision_delta(self, revno):
306
"""Return the delta for one revision.
308
The delta is relative to its mainline predecessor, or the
309
empty tree for revision 1.
311
assert isinstance(revno, int)
312
rh = self.revision_history()
313
if not (1 <= revno <= len(rh)):
314
raise InvalidRevisionNumber(revno)
315
return self.repository.get_revision_delta(rh[revno-1])
317
@deprecated_method(zero_sixteen)
318
def get_root_id(self):
319
"""Return the id of this branches root
321
Deprecated: branches don't have root ids-- trees do.
322
Use basis_tree().get_root_id() instead.
324
raise NotImplementedError(self.get_root_id)
326
def print_file(self, file, revision_id):
327
"""Print `file` to stdout."""
328
raise NotImplementedError(self.print_file)
330
def append_revision(self, *revision_ids):
331
raise NotImplementedError(self.append_revision)
333
def set_revision_history(self, rev_history):
334
raise NotImplementedError(self.set_revision_history)
336
def _cache_revision_history(self, rev_history):
337
"""Set the cached revision history to rev_history.
339
The revision_history method will use this cache to avoid regenerating
340
the revision history.
342
This API is semi-public; it only for use by subclasses, all other code
343
should consider it to be private.
345
self._revision_history_cache = rev_history
347
def _clear_cached_state(self):
348
"""Clear any cached data on this branch, e.g. cached revision history.
350
This means the next call to revision_history will need to call
351
_gen_revision_history.
353
This API is semi-public; it only for use by subclasses, all other code
354
should consider it to be private.
356
self._revision_history_cache = None
358
def _gen_revision_history(self):
359
"""Return sequence of revision hashes on to this branch.
361
Unlike revision_history, this method always regenerates or rereads the
362
revision history, i.e. it does not cache the result, so repeated calls
365
Concrete subclasses should override this instead of revision_history so
366
that subclasses do not need to deal with caching logic.
368
This API is semi-public; it only for use by subclasses, all other code
369
should consider it to be private.
371
raise NotImplementedError(self._gen_revision_history)
374
def revision_history(self):
375
"""Return sequence of revision hashes on to this branch.
377
This method will cache the revision history for as long as it is safe to
380
if self._revision_history_cache is not None:
381
history = self._revision_history_cache
383
history = self._gen_revision_history()
384
self._cache_revision_history(history)
388
"""Return current revision number for this branch.
390
That is equivalent to the number of revisions committed to
393
return len(self.revision_history())
396
"""Older format branches cannot bind or unbind."""
397
raise errors.UpgradeRequired(self.base)
399
def set_append_revisions_only(self, enabled):
400
"""Older format branches are never restricted to append-only"""
401
raise errors.UpgradeRequired(self.base)
403
def last_revision(self):
404
"""Return last revision id, or None"""
405
ph = self.revision_history()
411
def last_revision_info(self):
412
"""Return information about the last revision.
414
:return: A tuple (revno, last_revision_id).
416
rh = self.revision_history()
419
return (revno, rh[-1])
421
return (0, _mod_revision.NULL_REVISION)
423
def missing_revisions(self, other, stop_revision=None):
424
"""Return a list of new revisions that would perfectly fit.
426
If self and other have not diverged, return a list of the revisions
427
present in other, but missing from self.
429
self_history = self.revision_history()
430
self_len = len(self_history)
431
other_history = other.revision_history()
432
other_len = len(other_history)
433
common_index = min(self_len, other_len) -1
434
if common_index >= 0 and \
435
self_history[common_index] != other_history[common_index]:
436
raise DivergedBranches(self, other)
438
if stop_revision is None:
439
stop_revision = other_len
441
assert isinstance(stop_revision, int)
442
if stop_revision > other_len:
443
raise errors.NoSuchRevision(self, stop_revision)
444
return other_history[self_len:stop_revision]
446
def update_revisions(self, other, stop_revision=None):
447
"""Pull in new perfect-fit revisions.
449
:param other: Another Branch to pull from
450
:param stop_revision: Updated until the given revision
453
raise NotImplementedError(self.update_revisions)
455
def revision_id_to_revno(self, revision_id):
456
"""Given a revision id, return its revno"""
457
if revision_id is None:
459
revision_id = osutils.safe_revision_id(revision_id)
460
history = self.revision_history()
462
return history.index(revision_id) + 1
464
raise bzrlib.errors.NoSuchRevision(self, revision_id)
466
def get_rev_id(self, revno, history=None):
467
"""Find the revision id of the specified revno."""
471
history = self.revision_history()
472
if revno <= 0 or revno > len(history):
473
raise bzrlib.errors.NoSuchRevision(self, revno)
474
return history[revno - 1]
476
def pull(self, source, overwrite=False, stop_revision=None):
477
"""Mirror source into this branch.
479
This branch is considered to be 'local', having low latency.
481
:returns: PullResult instance
483
raise NotImplementedError(self.pull)
485
def push(self, target, overwrite=False, stop_revision=None):
486
"""Mirror this branch into target.
488
This branch is considered to be 'local', having low latency.
490
raise NotImplementedError(self.push)
492
def basis_tree(self):
493
"""Return `Tree` object for last revision."""
494
return self.repository.revision_tree(self.last_revision())
496
def rename_one(self, from_rel, to_rel):
499
This can change the directory or the filename or both.
501
raise NotImplementedError(self.rename_one)
503
def move(self, from_paths, to_name):
506
to_name must exist as a versioned directory.
508
If to_name exists and is a directory, the files are moved into
509
it, keeping their old names. If it is a directory,
511
Note that to_name is only the last component of the new name;
512
this doesn't change the directory.
514
This returns a list of (from_path, to_path) pairs for each
517
raise NotImplementedError(self.move)
519
def get_parent(self):
520
"""Return the parent location of the branch.
522
This is the default location for push/pull/missing. The usual
523
pattern is that the user can override it by specifying a
526
raise NotImplementedError(self.get_parent)
528
def _set_config_location(self, name, url, config=None,
529
make_relative=False):
531
config = self.get_config()
535
url = urlutils.relative_url(self.base, url)
536
config.set_user_option(name, url)
538
def _get_config_location(self, name, config=None):
540
config = self.get_config()
541
location = config.get_user_option(name)
546
def get_submit_branch(self):
547
"""Return the submit location of the branch.
549
This is the default location for bundle. The usual
550
pattern is that the user can override it by specifying a
553
return self.get_config().get_user_option('submit_branch')
555
def set_submit_branch(self, location):
556
"""Return the submit location of the branch.
558
This is the default location for bundle. The usual
559
pattern is that the user can override it by specifying a
562
self.get_config().set_user_option('submit_branch', location)
564
def get_public_branch(self):
565
"""Return the public location of the branch.
567
This is is used by merge directives.
569
return self._get_config_location('public_branch')
571
def set_public_branch(self, location):
572
"""Return the submit location of the branch.
574
This is the default location for bundle. The usual
575
pattern is that the user can override it by specifying a
578
self._set_config_location('public_branch', location)
580
def get_push_location(self):
581
"""Return the None or the location to push this branch to."""
582
push_loc = self.get_config().get_user_option('push_location')
585
def set_push_location(self, location):
586
"""Set a new push location for this branch."""
587
raise NotImplementedError(self.set_push_location)
589
def set_parent(self, url):
590
raise NotImplementedError(self.set_parent)
594
"""Synchronise this branch with the master branch if any.
596
:return: None or the last_revision pivoted out during the update.
600
def check_revno(self, revno):
602
Check whether a revno corresponds to any revision.
603
Zero (the NULL revision) is considered valid.
606
self.check_real_revno(revno)
608
def check_real_revno(self, revno):
610
Check whether a revno corresponds to a real revision.
611
Zero (the NULL revision) is considered invalid
613
if revno < 1 or revno > self.revno():
614
raise InvalidRevisionNumber(revno)
617
def clone(self, to_bzrdir, revision_id=None):
618
"""Clone this branch into to_bzrdir preserving all semantic values.
620
revision_id: if not None, the revision history in the new branch will
621
be truncated to end with revision_id.
623
result = self._format.initialize(to_bzrdir)
624
self.copy_content_into(result, revision_id=revision_id)
628
def sprout(self, to_bzrdir, revision_id=None):
629
"""Create a new line of development from the branch, into to_bzrdir.
631
revision_id: if not None, the revision history in the new branch will
632
be truncated to end with revision_id.
634
result = self._format.initialize(to_bzrdir)
635
self.copy_content_into(result, revision_id=revision_id)
636
result.set_parent(self.bzrdir.root_transport.base)
639
def _synchronize_history(self, destination, revision_id):
640
"""Synchronize last revision and revision history between branches.
642
This version is most efficient when the destination is also a
643
BzrBranch5, but works for BzrBranch6 as long as the revision
644
history is the true lefthand parent history, and all of the revisions
645
are in the destination's repository. If not, set_revision_history
648
:param destination: The branch to copy the history into
649
:param revision_id: The revision-id to truncate history at. May
650
be None to copy complete history.
652
new_history = self.revision_history()
653
if revision_id is not None:
654
revision_id = osutils.safe_revision_id(revision_id)
656
new_history = new_history[:new_history.index(revision_id) + 1]
658
rev = self.repository.get_revision(revision_id)
659
new_history = rev.get_history(self.repository)[1:]
660
destination.set_revision_history(new_history)
663
def copy_content_into(self, destination, revision_id=None):
664
"""Copy the content of self into destination.
666
revision_id: if not None, the revision history in the new branch will
667
be truncated to end with revision_id.
669
self._synchronize_history(destination, revision_id)
671
parent = self.get_parent()
672
except errors.InaccessibleParent, e:
673
mutter('parent was not accessible to copy: %s', e)
676
destination.set_parent(parent)
677
self.tags.merge_to(destination.tags)
681
"""Check consistency of the branch.
683
In particular this checks that revisions given in the revision-history
684
do actually match up in the revision graph, and that they're all
685
present in the repository.
687
Callers will typically also want to check the repository.
689
:return: A BranchCheckResult.
691
mainline_parent_id = None
692
for revision_id in self.revision_history():
694
revision = self.repository.get_revision(revision_id)
695
except errors.NoSuchRevision, e:
696
raise errors.BzrCheckError("mainline revision {%s} not in repository"
698
# In general the first entry on the revision history has no parents.
699
# But it's not illegal for it to have parents listed; this can happen
700
# in imports from Arch when the parents weren't reachable.
701
if mainline_parent_id is not None:
702
if mainline_parent_id not in revision.parent_ids:
703
raise errors.BzrCheckError("previous revision {%s} not listed among "
705
% (mainline_parent_id, revision_id))
706
mainline_parent_id = revision_id
707
return BranchCheckResult(self)
709
def _get_checkout_format(self):
710
"""Return the most suitable metadir for a checkout of this branch.
711
Weaves are used if this branch's repository uses weaves.
713
from bzrlib.remote import RemoteBzrDir
714
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
715
from bzrlib.repofmt import weaverepo
716
format = bzrdir.BzrDirMetaFormat1()
717
format.repository_format = weaverepo.RepositoryFormat7()
718
elif isinstance(self.bzrdir, RemoteBzrDir):
719
format = bzrdir.BzrDirMetaFormat1()
721
format = self.repository.bzrdir.checkout_metadir()
722
format.set_branch_format(self._format)
725
def create_checkout(self, to_location, revision_id=None,
727
"""Create a checkout of a branch.
729
:param to_location: The url to produce the checkout at
730
:param revision_id: The revision to check out
731
:param lightweight: If True, produce a lightweight checkout, otherwise,
732
produce a bound branch (heavyweight checkout)
733
:return: The tree of the created checkout
735
t = transport.get_transport(to_location)
738
except errors.FileExists:
741
format = self._get_checkout_format()
742
checkout = format.initialize_on_transport(t)
743
BranchReferenceFormat().initialize(checkout, self)
745
format = self._get_checkout_format()
746
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
747
to_location, force_new_tree=False, format=format)
748
checkout = checkout_branch.bzrdir
749
checkout_branch.bind(self)
750
# pull up to the specified revision_id to set the initial
751
# branch tip correctly, and seed it with history.
752
checkout_branch.pull(self, stop_revision=revision_id)
753
tree = checkout.create_workingtree(revision_id)
754
basis_tree = tree.basis_tree()
755
basis_tree.lock_read()
757
for path, file_id in basis_tree.iter_references():
758
reference_parent = self.reference_parent(file_id, path)
759
reference_parent.create_checkout(tree.abspath(path),
760
basis_tree.get_reference_revision(file_id, path),
766
def reference_parent(self, file_id, path):
767
"""Return the parent branch for a tree-reference file_id
768
:param file_id: The file_id of the tree reference
769
:param path: The path of the file_id in the tree
770
:return: A branch associated with the file_id
772
# FIXME should provide multiple branches, based on config
773
return Branch.open(self.bzrdir.root_transport.clone(path).base)
775
def supports_tags(self):
776
return self._format.supports_tags()
779
class BranchFormat(object):
780
"""An encapsulation of the initialization and open routines for a format.
782
Formats provide three things:
783
* An initialization routine,
787
Formats are placed in an dict by their format string for reference
788
during branch opening. Its not required that these be instances, they
789
can be classes themselves with class methods - it simply depends on
790
whether state is needed for a given format or not.
792
Once a format is deprecated, just deprecate the initialize and open
793
methods on the format class. Do not deprecate the object, as the
794
object will be created every time regardless.
797
_default_format = None
798
"""The default format used for new branches."""
801
"""The known formats."""
804
def find_format(klass, a_bzrdir):
805
"""Return the format for the branch object in a_bzrdir."""
807
transport = a_bzrdir.get_branch_transport(None)
808
format_string = transport.get("format").read()
809
return klass._formats[format_string]
811
raise NotBranchError(path=transport.base)
813
raise errors.UnknownFormatError(format=format_string)
816
def get_default_format(klass):
817
"""Return the current default format."""
818
return klass._default_format
820
def get_reference(self, a_bzrdir):
821
"""Get the target reference of the branch in a_bzrdir.
823
format probing must have been completed before calling
824
this method - it is assumed that the format of the branch
825
in a_bzrdir is correct.
827
:param a_bzrdir: The bzrdir to get the branch data from.
828
:return: None if the branch is not a reference branch.
832
def get_format_string(self):
833
"""Return the ASCII format string that identifies this format."""
834
raise NotImplementedError(self.get_format_string)
836
def get_format_description(self):
837
"""Return the short format description for this format."""
838
raise NotImplementedError(self.get_format_description)
840
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
842
"""Initialize a branch in a bzrdir, with specified files
844
:param a_bzrdir: The bzrdir to initialize the branch in
845
:param utf8_files: The files to create as a list of
846
(filename, content) tuples
847
:param set_format: If True, set the format with
848
self.get_format_string. (BzrBranch4 has its format set
850
:return: a branch in this format
852
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
853
branch_transport = a_bzrdir.get_branch_transport(self)
855
'metadir': ('lock', lockdir.LockDir),
856
'branch4': ('branch-lock', lockable_files.TransportLock),
858
lock_name, lock_class = lock_map[lock_type]
859
control_files = lockable_files.LockableFiles(branch_transport,
860
lock_name, lock_class)
861
control_files.create_lock()
862
control_files.lock_write()
864
control_files.put_utf8('format', self.get_format_string())
866
for file, content in utf8_files:
867
control_files.put_utf8(file, content)
869
control_files.unlock()
870
return self.open(a_bzrdir, _found=True)
872
def initialize(self, a_bzrdir):
873
"""Create a branch of this format in a_bzrdir."""
874
raise NotImplementedError(self.initialize)
876
def is_supported(self):
877
"""Is this format supported?
879
Supported formats can be initialized and opened.
880
Unsupported formats may not support initialization or committing or
881
some other features depending on the reason for not being supported.
885
def open(self, a_bzrdir, _found=False):
886
"""Return the branch object for a_bzrdir
888
_found is a private parameter, do not use it. It is used to indicate
889
if format probing has already be done.
891
raise NotImplementedError(self.open)
894
def register_format(klass, format):
895
klass._formats[format.get_format_string()] = format
898
def set_default_format(klass, format):
899
klass._default_format = format
902
def unregister_format(klass, format):
903
assert klass._formats[format.get_format_string()] is format
904
del klass._formats[format.get_format_string()]
907
return self.get_format_string().rstrip()
909
def supports_tags(self):
910
"""True if this format supports tags stored in the branch"""
911
return False # by default
913
# XXX: Probably doesn't really belong here -- mbp 20070212
914
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
916
branch_transport = a_bzrdir.get_branch_transport(self)
917
control_files = lockable_files.LockableFiles(branch_transport,
918
lock_filename, lock_class)
919
control_files.create_lock()
920
control_files.lock_write()
922
for filename, content in utf8_files:
923
control_files.put_utf8(filename, content)
925
control_files.unlock()
928
class BranchHooks(Hooks):
929
"""A dictionary mapping hook name to a list of callables for branch hooks.
931
e.g. ['set_rh'] Is the list of items to be called when the
932
set_revision_history function is invoked.
936
"""Create the default hooks.
938
These are all empty initially, because by default nothing should get
942
# Introduced in 0.15:
943
# invoked whenever the revision history has been set
944
# with set_revision_history. The api signature is
945
# (branch, revision_history), and the branch will
948
# invoked after a push operation completes.
949
# the api signature is
951
# containing the members
952
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
953
# where local is the local branch or None, master is the target
954
# master branch, and the rest should be self explanatory. The source
955
# is read locked and the target branches write locked. Source will
956
# be the local low-latency branch.
957
self['post_push'] = []
958
# invoked after a pull operation completes.
959
# the api signature is
961
# containing the members
962
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
963
# where local is the local branch or None, master is the target
964
# master branch, and the rest should be self explanatory. The source
965
# is read locked and the target branches write locked. The local
966
# branch is the low-latency branch.
967
self['post_pull'] = []
968
# invoked after a commit operation completes.
969
# the api signature is
970
# (local, master, old_revno, old_revid, new_revno, new_revid)
971
# old_revid is NULL_REVISION for the first commit to a branch.
972
self['post_commit'] = []
973
# invoked after a uncommit operation completes.
974
# the api signature is
975
# (local, master, old_revno, old_revid, new_revno, new_revid) where
976
# local is the local branch or None, master is the target branch,
977
# and an empty branch recieves new_revno of 0, new_revid of None.
978
self['post_uncommit'] = []
981
# install the default hooks into the Branch class.
982
Branch.hooks = BranchHooks()
985
class BzrBranchFormat4(BranchFormat):
986
"""Bzr branch format 4.
989
- a revision-history file.
990
- a branch-lock lock file [ to be shared with the bzrdir ]
993
def get_format_description(self):
994
"""See BranchFormat.get_format_description()."""
995
return "Branch format 4"
997
def initialize(self, a_bzrdir):
998
"""Create a branch of this format in a_bzrdir."""
999
utf8_files = [('revision-history', ''),
1000
('branch-name', ''),
1002
return self._initialize_helper(a_bzrdir, utf8_files,
1003
lock_type='branch4', set_format=False)
1006
super(BzrBranchFormat4, self).__init__()
1007
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1009
def open(self, a_bzrdir, _found=False):
1010
"""Return the branch object for a_bzrdir
1012
_found is a private parameter, do not use it. It is used to indicate
1013
if format probing has already be done.
1016
# we are being called directly and must probe.
1017
raise NotImplementedError
1018
return BzrBranch(_format=self,
1019
_control_files=a_bzrdir._control_files,
1021
_repository=a_bzrdir.open_repository())
1024
return "Bazaar-NG branch format 4"
1027
class BzrBranchFormat5(BranchFormat):
1028
"""Bzr branch format 5.
1031
- a revision-history file.
1033
- a lock dir guarding the branch itself
1034
- all of this stored in a branch/ subdirectory
1035
- works with shared repositories.
1037
This format is new in bzr 0.8.
1040
def get_format_string(self):
1041
"""See BranchFormat.get_format_string()."""
1042
return "Bazaar-NG branch format 5\n"
1044
def get_format_description(self):
1045
"""See BranchFormat.get_format_description()."""
1046
return "Branch format 5"
1048
def initialize(self, a_bzrdir):
1049
"""Create a branch of this format in a_bzrdir."""
1050
utf8_files = [('revision-history', ''),
1051
('branch-name', ''),
1053
return self._initialize_helper(a_bzrdir, utf8_files)
1056
super(BzrBranchFormat5, self).__init__()
1057
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1059
def open(self, a_bzrdir, _found=False):
1060
"""Return the branch object for a_bzrdir
1062
_found is a private parameter, do not use it. It is used to indicate
1063
if format probing has already be done.
1066
format = BranchFormat.find_format(a_bzrdir)
1067
assert format.__class__ == self.__class__
1069
transport = a_bzrdir.get_branch_transport(None)
1070
control_files = lockable_files.LockableFiles(transport, 'lock',
1072
return BzrBranch5(_format=self,
1073
_control_files=control_files,
1075
_repository=a_bzrdir.find_repository())
1077
raise NotBranchError(path=transport.base)
1080
class BzrBranchFormat6(BzrBranchFormat5):
1081
"""Branch format with last-revision
1083
Unlike previous formats, this has no explicit revision history. Instead,
1084
this just stores the last-revision, and the left-hand history leading
1085
up to there is the history.
1087
This format was introduced in bzr 0.15
1090
def get_format_string(self):
1091
"""See BranchFormat.get_format_string()."""
1092
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1094
def get_format_description(self):
1095
"""See BranchFormat.get_format_description()."""
1096
return "Branch format 6"
1098
def initialize(self, a_bzrdir):
1099
"""Create a branch of this format in a_bzrdir."""
1100
utf8_files = [('last-revision', '0 null:\n'),
1101
('branch-name', ''),
1102
('branch.conf', ''),
1105
return self._initialize_helper(a_bzrdir, utf8_files)
1107
def open(self, a_bzrdir, _found=False):
1108
"""Return the branch object for a_bzrdir
1110
_found is a private parameter, do not use it. It is used to indicate
1111
if format probing has already be done.
1114
format = BranchFormat.find_format(a_bzrdir)
1115
assert format.__class__ == self.__class__
1116
transport = a_bzrdir.get_branch_transport(None)
1117
control_files = lockable_files.LockableFiles(transport, 'lock',
1119
return BzrBranch6(_format=self,
1120
_control_files=control_files,
1122
_repository=a_bzrdir.find_repository())
1124
def supports_tags(self):
1128
class BranchReferenceFormat(BranchFormat):
1129
"""Bzr branch reference format.
1131
Branch references are used in implementing checkouts, they
1132
act as an alias to the real branch which is at some other url.
1139
def get_format_string(self):
1140
"""See BranchFormat.get_format_string()."""
1141
return "Bazaar-NG Branch Reference Format 1\n"
1143
def get_format_description(self):
1144
"""See BranchFormat.get_format_description()."""
1145
return "Checkout reference format 1"
1147
def get_reference(self, a_bzrdir):
1148
"""See BranchFormat.get_reference()."""
1149
transport = a_bzrdir.get_branch_transport(None)
1150
return transport.get('location').read()
1152
def initialize(self, a_bzrdir, target_branch=None):
1153
"""Create a branch of this format in a_bzrdir."""
1154
if target_branch is None:
1155
# this format does not implement branch itself, thus the implicit
1156
# creation contract must see it as uninitializable
1157
raise errors.UninitializableFormat(self)
1158
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1159
branch_transport = a_bzrdir.get_branch_transport(self)
1160
branch_transport.put_bytes('location',
1161
target_branch.bzrdir.root_transport.base)
1162
branch_transport.put_bytes('format', self.get_format_string())
1163
return self.open(a_bzrdir, _found=True)
1166
super(BranchReferenceFormat, self).__init__()
1167
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1169
def _make_reference_clone_function(format, a_branch):
1170
"""Create a clone() routine for a branch dynamically."""
1171
def clone(to_bzrdir, revision_id=None):
1172
"""See Branch.clone()."""
1173
return format.initialize(to_bzrdir, a_branch)
1174
# cannot obey revision_id limits when cloning a reference ...
1175
# FIXME RBC 20060210 either nuke revision_id for clone, or
1176
# emit some sort of warning/error to the caller ?!
1179
def open(self, a_bzrdir, _found=False, location=None):
1180
"""Return the branch that the branch reference in a_bzrdir points at.
1182
_found is a private parameter, do not use it. It is used to indicate
1183
if format probing has already be done.
1186
format = BranchFormat.find_format(a_bzrdir)
1187
assert format.__class__ == self.__class__
1188
if location is None:
1189
location = self.get_reference(a_bzrdir)
1190
real_bzrdir = bzrdir.BzrDir.open(location)
1191
result = real_bzrdir.open_branch()
1192
# this changes the behaviour of result.clone to create a new reference
1193
# rather than a copy of the content of the branch.
1194
# I did not use a proxy object because that needs much more extensive
1195
# testing, and we are only changing one behaviour at the moment.
1196
# If we decide to alter more behaviours - i.e. the implicit nickname
1197
# then this should be refactored to introduce a tested proxy branch
1198
# and a subclass of that for use in overriding clone() and ....
1200
result.clone = self._make_reference_clone_function(result)
1204
# formats which have no format string are not discoverable
1205
# and not independently creatable, so are not registered.
1206
__default_format = BzrBranchFormat5()
1207
BranchFormat.register_format(__default_format)
1208
BranchFormat.register_format(BranchReferenceFormat())
1209
BranchFormat.register_format(BzrBranchFormat6())
1210
BranchFormat.set_default_format(__default_format)
1211
_legacy_formats = [BzrBranchFormat4(),
1214
class BzrBranch(Branch):
1215
"""A branch stored in the actual filesystem.
1217
Note that it's "local" in the context of the filesystem; it doesn't
1218
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1219
it's writable, and can be accessed via the normal filesystem API.
1222
def __init__(self, _format=None,
1223
_control_files=None, a_bzrdir=None, _repository=None):
1224
"""Create new branch object at a particular location."""
1225
Branch.__init__(self)
1226
if a_bzrdir is None:
1227
raise ValueError('a_bzrdir must be supplied')
1229
self.bzrdir = a_bzrdir
1230
# self._transport used to point to the directory containing the
1231
# control directory, but was not used - now it's just the transport
1232
# for the branch control files. mbp 20070212
1233
self._base = self.bzrdir.transport.clone('..').base
1234
self._format = _format
1235
if _control_files is None:
1236
raise ValueError('BzrBranch _control_files is None')
1237
self.control_files = _control_files
1238
self._transport = _control_files._transport
1239
self.repository = _repository
1242
return '%s(%r)' % (self.__class__.__name__, self.base)
1246
def _get_base(self):
1247
"""Returns the directory containing the control directory."""
1250
base = property(_get_base, doc="The URL for the root of this branch.")
1252
def abspath(self, name):
1253
"""See Branch.abspath."""
1254
return self.control_files._transport.abspath(name)
1257
@deprecated_method(zero_sixteen)
1259
def get_root_id(self):
1260
"""See Branch.get_root_id."""
1261
tree = self.repository.revision_tree(self.last_revision())
1262
return tree.inventory.root.file_id
1264
def is_locked(self):
1265
return self.control_files.is_locked()
1267
def lock_write(self, tokens=None):
1268
if tokens is not None:
1269
branch_token, repo_token = tokens
1271
branch_token = repo_token = None
1272
repo_token = self.repository.lock_write(token=repo_token)
1274
branch_token = self.control_files.lock_write(token=branch_token)
1276
self.repository.unlock()
1279
tokens = (branch_token, repo_token)
1280
assert tokens == (None, None) or None not in tokens, (
1281
'Both branch and repository locks must return tokens, or else '
1282
'neither must return tokens. Got %r.' % (tokens,))
1283
if tokens == (None, None):
1288
def lock_read(self):
1289
self.repository.lock_read()
1291
self.control_files.lock_read()
1293
self.repository.unlock()
1297
# TODO: test for failed two phase locks. This is known broken.
1299
self.control_files.unlock()
1301
self.repository.unlock()
1302
if not self.control_files.is_locked():
1303
# we just released the lock
1304
self._clear_cached_state()
1306
def peek_lock_mode(self):
1307
if self.control_files._lock_count == 0:
1310
return self.control_files._lock_mode
1312
def get_physical_lock_status(self):
1313
return self.control_files.get_physical_lock_status()
1316
def print_file(self, file, revision_id):
1317
"""See Branch.print_file."""
1318
return self.repository.print_file(file, revision_id)
1321
def append_revision(self, *revision_ids):
1322
"""See Branch.append_revision."""
1323
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1324
for revision_id in revision_ids:
1325
_mod_revision.check_not_reserved_id(revision_id)
1326
mutter("add {%s} to revision-history" % revision_id)
1327
rev_history = self.revision_history()
1328
rev_history.extend(revision_ids)
1329
self.set_revision_history(rev_history)
1331
def _write_revision_history(self, history):
1332
"""Factored out of set_revision_history.
1334
This performs the actual writing to disk.
1335
It is intended to be called by BzrBranch5.set_revision_history."""
1336
self.control_files.put_bytes(
1337
'revision-history', '\n'.join(history))
1340
def set_revision_history(self, rev_history):
1341
"""See Branch.set_revision_history."""
1342
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1343
self._write_revision_history(rev_history)
1344
self._cache_revision_history(rev_history)
1345
for hook in Branch.hooks['set_rh']:
1346
hook(self, rev_history)
1349
def set_last_revision_info(self, revno, revision_id):
1350
revision_id = osutils.safe_revision_id(revision_id)
1351
history = self._lefthand_history(revision_id)
1352
assert len(history) == revno, '%d != %d' % (len(history), revno)
1353
self.set_revision_history(history)
1355
def _gen_revision_history(self):
1356
history = self.control_files.get('revision-history').read().split('\n')
1357
if history[-1:] == ['']:
1358
# There shouldn't be a trailing newline, but just in case.
1362
def _lefthand_history(self, revision_id, last_rev=None,
1364
# stop_revision must be a descendant of last_revision
1365
stop_graph = self.repository.get_revision_graph(revision_id)
1366
if last_rev is not None and last_rev not in stop_graph:
1367
# our previous tip is not merged into stop_revision
1368
raise errors.DivergedBranches(self, other_branch)
1369
# make a new revision history from the graph
1370
current_rev_id = revision_id
1372
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1373
new_history.append(current_rev_id)
1374
current_rev_id_parents = stop_graph[current_rev_id]
1376
current_rev_id = current_rev_id_parents[0]
1378
current_rev_id = None
1379
new_history.reverse()
1383
def generate_revision_history(self, revision_id, last_rev=None,
1385
"""Create a new revision history that will finish with revision_id.
1387
:param revision_id: the new tip to use.
1388
:param last_rev: The previous last_revision. If not None, then this
1389
must be a ancestory of revision_id, or DivergedBranches is raised.
1390
:param other_branch: The other branch that DivergedBranches should
1391
raise with respect to.
1393
revision_id = osutils.safe_revision_id(revision_id)
1394
self.set_revision_history(self._lefthand_history(revision_id,
1395
last_rev, other_branch))
1398
def update_revisions(self, other, stop_revision=None):
1399
"""See Branch.update_revisions."""
1402
if stop_revision is None:
1403
stop_revision = other.last_revision()
1404
if stop_revision is None:
1405
# if there are no commits, we're done.
1408
stop_revision = osutils.safe_revision_id(stop_revision)
1409
# whats the current last revision, before we fetch [and change it
1411
last_rev = self.last_revision()
1412
# we fetch here regardless of whether we need to so that we pickup
1414
self.fetch(other, stop_revision)
1415
my_ancestry = self.repository.get_ancestry(last_rev)
1416
if stop_revision in my_ancestry:
1417
# last_revision is a descendant of stop_revision
1419
self.generate_revision_history(stop_revision, last_rev=last_rev,
1424
def basis_tree(self):
1425
"""See Branch.basis_tree."""
1426
return self.repository.revision_tree(self.last_revision())
1428
@deprecated_method(zero_eight)
1429
def working_tree(self):
1430
"""Create a Working tree object for this branch."""
1432
from bzrlib.transport.local import LocalTransport
1433
if (self.base.find('://') != -1 or
1434
not isinstance(self._transport, LocalTransport)):
1435
raise NoWorkingTree(self.base)
1436
return self.bzrdir.open_workingtree()
1439
def pull(self, source, overwrite=False, stop_revision=None,
1440
_hook_master=None, _run_hooks=True):
1443
:param _hook_master: Private parameter - set the branch to
1444
be supplied as the master to push hooks.
1445
:param _run_hooks: Private parameter - allow disabling of
1446
hooks, used when pushing to a master branch.
1448
result = PullResult()
1449
result.source_branch = source
1450
result.target_branch = self
1453
result.old_revno, result.old_revid = self.last_revision_info()
1455
self.update_revisions(source, stop_revision)
1456
except DivergedBranches:
1460
if stop_revision is None:
1461
stop_revision = source.last_revision()
1462
self.generate_revision_history(stop_revision)
1463
result.tag_conflicts = source.tags.merge_to(self.tags)
1464
result.new_revno, result.new_revid = self.last_revision_info()
1466
result.master_branch = _hook_master
1467
result.local_branch = self
1469
result.master_branch = self
1470
result.local_branch = None
1472
for hook in Branch.hooks['post_pull']:
1478
def _get_parent_location(self):
1479
_locs = ['parent', 'pull', 'x-pull']
1482
return self.control_files.get(l).read().strip('\n')
1488
def push(self, target, overwrite=False, stop_revision=None,
1489
_hook_master=None, _run_hooks=True):
1492
:param _hook_master: Private parameter - set the branch to
1493
be supplied as the master to push hooks.
1494
:param _run_hooks: Private parameter - allow disabling of
1495
hooks, used when pushing to a master branch.
1497
result = PushResult()
1498
result.source_branch = self
1499
result.target_branch = target
1502
result.old_revno, result.old_revid = target.last_revision_info()
1504
target.update_revisions(self, stop_revision)
1505
except DivergedBranches:
1509
target.set_revision_history(self.revision_history())
1510
result.tag_conflicts = self.tags.merge_to(target.tags)
1511
result.new_revno, result.new_revid = target.last_revision_info()
1513
result.master_branch = _hook_master
1514
result.local_branch = target
1516
result.master_branch = target
1517
result.local_branch = None
1519
for hook in Branch.hooks['post_push']:
1525
def get_parent(self):
1526
"""See Branch.get_parent."""
1528
assert self.base[-1] == '/'
1529
parent = self._get_parent_location()
1532
# This is an old-format absolute path to a local branch
1533
# turn it into a url
1534
if parent.startswith('/'):
1535
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1537
return urlutils.join(self.base[:-1], parent)
1538
except errors.InvalidURLJoin, e:
1539
raise errors.InaccessibleParent(parent, self.base)
1541
def set_push_location(self, location):
1542
"""See Branch.set_push_location."""
1543
self.get_config().set_user_option(
1544
'push_location', location,
1545
store=_mod_config.STORE_LOCATION_NORECURSE)
1548
def set_parent(self, url):
1549
"""See Branch.set_parent."""
1550
# TODO: Maybe delete old location files?
1551
# URLs should never be unicode, even on the local fs,
1552
# FIXUP this and get_parent in a future branch format bump:
1553
# read and rewrite the file, and have the new format code read
1554
# using .get not .get_utf8. RBC 20060125
1556
if isinstance(url, unicode):
1558
url = url.encode('ascii')
1559
except UnicodeEncodeError:
1560
raise bzrlib.errors.InvalidURL(url,
1561
"Urls must be 7-bit ascii, "
1562
"use bzrlib.urlutils.escape")
1563
url = urlutils.relative_url(self.base, url)
1564
self._set_parent_location(url)
1566
def _set_parent_location(self, url):
1568
self.control_files._transport.delete('parent')
1570
assert isinstance(url, str)
1571
self.control_files.put_bytes('parent', url + '\n')
1573
@deprecated_function(zero_nine)
1574
def tree_config(self):
1575
"""DEPRECATED; call get_config instead.
1576
TreeConfig has become part of BranchConfig."""
1577
return TreeConfig(self)
1580
class BzrBranch5(BzrBranch):
1581
"""A format 5 branch. This supports new features over plan branches.
1583
It has support for a master_branch which is the data for bound branches.
1591
super(BzrBranch5, self).__init__(_format=_format,
1592
_control_files=_control_files,
1594
_repository=_repository)
1597
def pull(self, source, overwrite=False, stop_revision=None,
1599
"""Extends branch.pull to be bound branch aware.
1601
:param _run_hooks: Private parameter used to force hook running
1602
off during bound branch double-pushing.
1604
bound_location = self.get_bound_location()
1605
master_branch = None
1606
if bound_location and source.base != bound_location:
1607
# not pulling from master, so we need to update master.
1608
master_branch = self.get_master_branch()
1609
master_branch.lock_write()
1612
# pull from source into master.
1613
master_branch.pull(source, overwrite, stop_revision,
1615
return super(BzrBranch5, self).pull(source, overwrite,
1616
stop_revision, _hook_master=master_branch,
1617
_run_hooks=_run_hooks)
1620
master_branch.unlock()
1623
def push(self, target, overwrite=False, stop_revision=None):
1624
"""Updates branch.push to be bound branch aware."""
1625
bound_location = target.get_bound_location()
1626
master_branch = None
1627
if bound_location and target.base != bound_location:
1628
# not pushing to master, so we need to update master.
1629
master_branch = target.get_master_branch()
1630
master_branch.lock_write()
1633
# push into the master from this branch.
1634
super(BzrBranch5, self).push(master_branch, overwrite,
1635
stop_revision, _run_hooks=False)
1636
# and push into the target branch from this. Note that we push from
1637
# this branch again, because its considered the highest bandwidth
1639
return super(BzrBranch5, self).push(target, overwrite,
1640
stop_revision, _hook_master=master_branch)
1643
master_branch.unlock()
1645
def get_bound_location(self):
1647
return self.control_files.get_utf8('bound').read()[:-1]
1648
except errors.NoSuchFile:
1652
def get_master_branch(self):
1653
"""Return the branch we are bound to.
1655
:return: Either a Branch, or None
1657
This could memoise the branch, but if thats done
1658
it must be revalidated on each new lock.
1659
So for now we just don't memoise it.
1660
# RBC 20060304 review this decision.
1662
bound_loc = self.get_bound_location()
1666
return Branch.open(bound_loc)
1667
except (errors.NotBranchError, errors.ConnectionError), e:
1668
raise errors.BoundBranchConnectionFailure(
1672
def set_bound_location(self, location):
1673
"""Set the target where this branch is bound to.
1675
:param location: URL to the target branch
1678
self.control_files.put_utf8('bound', location+'\n')
1681
self.control_files._transport.delete('bound')
1687
def bind(self, other):
1688
"""Bind this branch to the branch other.
1690
This does not push or pull data between the branches, though it does
1691
check for divergence to raise an error when the branches are not
1692
either the same, or one a prefix of the other. That behaviour may not
1693
be useful, so that check may be removed in future.
1695
:param other: The branch to bind to
1698
# TODO: jam 20051230 Consider checking if the target is bound
1699
# It is debatable whether you should be able to bind to
1700
# a branch which is itself bound.
1701
# Committing is obviously forbidden,
1702
# but binding itself may not be.
1703
# Since we *have* to check at commit time, we don't
1704
# *need* to check here
1706
# we want to raise diverged if:
1707
# last_rev is not in the other_last_rev history, AND
1708
# other_last_rev is not in our history, and do it without pulling
1710
last_rev = self.last_revision()
1711
if last_rev is not None:
1714
other_last_rev = other.last_revision()
1715
if other_last_rev is not None:
1716
# neither branch is new, we have to do some work to
1717
# ascertain diversion.
1718
remote_graph = other.repository.get_revision_graph(
1720
local_graph = self.repository.get_revision_graph(last_rev)
1721
if (last_rev not in remote_graph and
1722
other_last_rev not in local_graph):
1723
raise errors.DivergedBranches(self, other)
1726
self.set_bound_location(other.base)
1730
"""If bound, unbind"""
1731
return self.set_bound_location(None)
1735
"""Synchronise this branch with the master branch if any.
1737
:return: None or the last_revision that was pivoted out during the
1740
master = self.get_master_branch()
1741
if master is not None:
1742
old_tip = self.last_revision()
1743
self.pull(master, overwrite=True)
1744
if old_tip in self.repository.get_ancestry(self.last_revision()):
1750
class BzrBranchExperimental(BzrBranch5):
1751
"""Bzr experimental branch format
1754
- a revision-history file.
1756
- a lock dir guarding the branch itself
1757
- all of this stored in a branch/ subdirectory
1758
- works with shared repositories.
1759
- a tag dictionary in the branch
1761
This format is new in bzr 0.15, but shouldn't be used for real data,
1764
This class acts as it's own BranchFormat.
1767
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1770
def get_format_string(cls):
1771
"""See BranchFormat.get_format_string()."""
1772
return "Bazaar-NG branch format experimental\n"
1775
def get_format_description(cls):
1776
"""See BranchFormat.get_format_description()."""
1777
return "Experimental branch format"
1780
def get_reference(cls, a_bzrdir):
1781
"""Get the target reference of the branch in a_bzrdir.
1783
format probing must have been completed before calling
1784
this method - it is assumed that the format of the branch
1785
in a_bzrdir is correct.
1787
:param a_bzrdir: The bzrdir to get the branch data from.
1788
:return: None if the branch is not a reference branch.
1793
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1795
branch_transport = a_bzrdir.get_branch_transport(cls)
1796
control_files = lockable_files.LockableFiles(branch_transport,
1797
lock_filename, lock_class)
1798
control_files.create_lock()
1799
control_files.lock_write()
1801
for filename, content in utf8_files:
1802
control_files.put_utf8(filename, content)
1804
control_files.unlock()
1807
def initialize(cls, a_bzrdir):
1808
"""Create a branch of this format in a_bzrdir."""
1809
utf8_files = [('format', cls.get_format_string()),
1810
('revision-history', ''),
1811
('branch-name', ''),
1814
cls._initialize_control_files(a_bzrdir, utf8_files,
1815
'lock', lockdir.LockDir)
1816
return cls.open(a_bzrdir, _found=True)
1819
def open(cls, a_bzrdir, _found=False):
1820
"""Return the branch object for a_bzrdir
1822
_found is a private parameter, do not use it. It is used to indicate
1823
if format probing has already be done.
1826
format = BranchFormat.find_format(a_bzrdir)
1827
assert format.__class__ == cls
1828
transport = a_bzrdir.get_branch_transport(None)
1829
control_files = lockable_files.LockableFiles(transport, 'lock',
1831
return cls(_format=cls,
1832
_control_files=control_files,
1834
_repository=a_bzrdir.find_repository())
1837
def is_supported(cls):
1840
def _make_tags(self):
1841
return BasicTags(self)
1844
def supports_tags(cls):
1848
BranchFormat.register_format(BzrBranchExperimental)
1851
class BzrBranch6(BzrBranch5):
1854
def last_revision_info(self):
1855
revision_string = self.control_files.get('last-revision').read()
1856
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1857
revision_id = cache_utf8.get_cached_utf8(revision_id)
1859
return revno, revision_id
1861
def last_revision(self):
1862
"""Return last revision id, or None"""
1863
revision_id = self.last_revision_info()[1]
1864
if revision_id == _mod_revision.NULL_REVISION:
1868
def _write_last_revision_info(self, revno, revision_id):
1869
"""Simply write out the revision id, with no checks.
1871
Use set_last_revision_info to perform this safely.
1873
Does not update the revision_history cache.
1874
Intended to be called by set_last_revision_info and
1875
_write_revision_history.
1877
if revision_id is None:
1878
revision_id = 'null:'
1879
out_string = '%d %s\n' % (revno, revision_id)
1880
self.control_files.put_bytes('last-revision', out_string)
1883
def set_last_revision_info(self, revno, revision_id):
1884
revision_id = osutils.safe_revision_id(revision_id)
1885
if self._get_append_revisions_only():
1886
self._check_history_violation(revision_id)
1887
self._write_last_revision_info(revno, revision_id)
1888
self._clear_cached_state()
1890
def _check_history_violation(self, revision_id):
1891
last_revision = self.last_revision()
1892
if last_revision is None:
1894
if last_revision not in self._lefthand_history(revision_id):
1895
raise errors.AppendRevisionsOnlyViolation(self.base)
1897
def _gen_revision_history(self):
1898
"""Generate the revision history from last revision
1900
history = list(self.repository.iter_reverse_revision_history(
1901
self.last_revision()))
1905
def _write_revision_history(self, history):
1906
"""Factored out of set_revision_history.
1908
This performs the actual writing to disk, with format-specific checks.
1909
It is intended to be called by BzrBranch5.set_revision_history.
1911
if len(history) == 0:
1912
last_revision = 'null:'
1914
if history != self._lefthand_history(history[-1]):
1915
raise errors.NotLefthandHistory(history)
1916
last_revision = history[-1]
1917
if self._get_append_revisions_only():
1918
self._check_history_violation(last_revision)
1919
self._write_last_revision_info(len(history), last_revision)
1922
def append_revision(self, *revision_ids):
1923
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1924
if len(revision_ids) == 0:
1926
prev_revno, prev_revision = self.last_revision_info()
1927
for revision in self.repository.get_revisions(revision_ids):
1928
if prev_revision == _mod_revision.NULL_REVISION:
1929
if revision.parent_ids != []:
1930
raise errors.NotLeftParentDescendant(self, prev_revision,
1931
revision.revision_id)
1933
if revision.parent_ids[0] != prev_revision:
1934
raise errors.NotLeftParentDescendant(self, prev_revision,
1935
revision.revision_id)
1936
prev_revision = revision.revision_id
1937
self.set_last_revision_info(prev_revno + len(revision_ids),
1941
def _set_parent_location(self, url):
1942
"""Set the parent branch"""
1943
self._set_config_location('parent_location', url, make_relative=True)
1946
def _get_parent_location(self):
1947
"""Set the parent branch"""
1948
return self._get_config_location('parent_location')
1950
def set_push_location(self, location):
1951
"""See Branch.set_push_location."""
1952
self._set_config_location('push_location', location)
1954
def set_bound_location(self, location):
1955
"""See Branch.set_push_location."""
1957
config = self.get_config()
1958
if location is None:
1959
if config.get_user_option('bound') != 'True':
1962
config.set_user_option('bound', 'False')
1965
self._set_config_location('bound_location', location,
1967
config.set_user_option('bound', 'True')
1970
def _get_bound_location(self, bound):
1971
"""Return the bound location in the config file.
1973
Return None if the bound parameter does not match"""
1974
config = self.get_config()
1975
config_bound = (config.get_user_option('bound') == 'True')
1976
if config_bound != bound:
1978
return self._get_config_location('bound_location', config=config)
1980
def get_bound_location(self):
1981
"""See Branch.set_push_location."""
1982
return self._get_bound_location(True)
1984
def get_old_bound_location(self):
1985
"""See Branch.get_old_bound_location"""
1986
return self._get_bound_location(False)
1988
def set_append_revisions_only(self, enabled):
1993
self.get_config().set_user_option('append_revisions_only', value)
1995
def _get_append_revisions_only(self):
1996
value = self.get_config().get_user_option('append_revisions_only')
1997
return value == 'True'
1999
def _synchronize_history(self, destination, revision_id):
2000
"""Synchronize last revision and revision history between branches.
2002
This version is most efficient when the destination is also a
2003
BzrBranch6, but works for BzrBranch5, as long as the destination's
2004
repository contains all the lefthand ancestors of the intended
2005
last_revision. If not, set_last_revision_info will fail.
2007
:param destination: The branch to copy the history into
2008
:param revision_id: The revision-id to truncate history at. May
2009
be None to copy complete history.
2011
if revision_id is None:
2012
revno, revision_id = self.last_revision_info()
2014
revno = self.revision_id_to_revno(revision_id)
2015
destination.set_last_revision_info(revno, revision_id)
2017
def _make_tags(self):
2018
return BasicTags(self)
2021
class BranchTestProviderAdapter(object):
2022
"""A tool to generate a suite testing multiple branch formats at once.
2024
This is done by copying the test once for each transport and injecting
2025
the transport_server, transport_readonly_server, and branch_format
2026
classes into each copy. Each copy is also given a new id() to make it
2030
def __init__(self, transport_server, transport_readonly_server, formats,
2031
vfs_transport_factory=None):
2032
self._transport_server = transport_server
2033
self._transport_readonly_server = transport_readonly_server
2034
self._formats = formats
2036
def adapt(self, test):
2037
result = TestSuite()
2038
for branch_format, bzrdir_format in self._formats:
2039
new_test = deepcopy(test)
2040
new_test.transport_server = self._transport_server
2041
new_test.transport_readonly_server = self._transport_readonly_server
2042
new_test.bzrdir_format = bzrdir_format
2043
new_test.branch_format = branch_format
2044
def make_new_test_id():
2045
# the format can be either a class or an instance
2046
name = getattr(branch_format, '__name__',
2047
branch_format.__class__.__name__)
2048
new_id = "%s(%s)" % (new_test.id(), name)
2049
return lambda: new_id
2050
new_test.id = make_new_test_id()
2051
result.addTest(new_test)
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
