1
# Copyright (C) 2005, 2006 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 copy import deepcopy
19
from cStringIO import StringIO
24
from unittest import TestSuite
25
from warnings import warn
28
import bzrlib.bzrdir as bzrdir
29
from bzrlib.config import TreeConfig
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
from bzrlib.delta import compare_trees
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError,
36
UninitializableFormat,
38
UnlistableBranch, NoSuchFile, NotVersionedError,
40
import bzrlib.inventory as inventory
41
from bzrlib.inventory import Inventory
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.lockdir import LockDir
44
from bzrlib.osutils import (isdir, quotefn,
45
rename, splitpath, sha_file,
46
file_kind, abspath, normpath, pathjoin,
50
from bzrlib.repository import Repository
51
from bzrlib.revision import (
56
from bzrlib.store import copy_all
57
from bzrlib.symbol_versioning import *
58
from bzrlib.textui import show_status
59
from bzrlib.trace import mutter, note
60
import bzrlib.transactions as transactions
61
from bzrlib.transport import Transport, get_transport
62
from bzrlib.tree import EmptyTree, RevisionTree
64
import bzrlib.urlutils as urlutils
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
73
# TODO: Maybe include checks for common corruption of newlines, etc?
75
# TODO: Some operations like log might retrieve the same revisions
76
# repeatedly to calculate deltas. We could perhaps have a weakref
77
# cache in memory to make this faster. In general anything can be
78
# cached in memory between lock and unlock operations. .. nb thats
79
# what the transaction identity map provides
82
######################################################################
86
"""Branch holding a history of revisions.
89
Base directory/url of the branch.
91
# this is really an instance variable - FIXME move it there
95
def __init__(self, *ignored, **ignored_too):
96
raise NotImplementedError('The Branch class is abstract')
99
"""Break a lock if one is present from another instance.
101
Uses the ui factory to ask for confirmation if the lock may be from
104
This will probe the repository for its lock as well.
106
self.control_files.break_lock()
107
self.repository.break_lock()
108
master = self.get_master_branch()
109
if master is not None:
113
@deprecated_method(zero_eight)
114
def open_downlevel(base):
115
"""Open a branch which may be of an old format."""
116
return Branch.open(base, _unsupported=True)
119
def open(base, _unsupported=False):
120
"""Open the repository rooted at base.
122
For instance, if the repository is at URL/.bzr/repository,
123
Repository.open(URL) -> a Repository instance.
125
control = bzrdir.BzrDir.open(base, _unsupported)
126
return control.open_branch(_unsupported)
129
def open_containing(url):
130
"""Open an existing branch which contains url.
132
This probes for a branch at url, and searches upwards from there.
134
Basically we keep looking up until we find the control directory or
135
run into the root. If there isn't one, raises NotBranchError.
136
If there is one and it is either an unrecognised format or an unsupported
137
format, UnknownFormatError or UnsupportedFormatError are raised.
138
If there is one, it is returned, along with the unused portion of url.
140
control, relpath = bzrdir.BzrDir.open_containing(url)
141
return control.open_branch(), relpath
144
@deprecated_function(zero_eight)
145
def initialize(base):
146
"""Create a new working tree and branch, rooted at 'base' (url)
148
NOTE: This will soon be deprecated in favour of creation
151
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
153
def setup_caching(self, cache_root):
154
"""Subclasses that care about caching should override this, and set
155
up cached stores located under cache_root.
157
# seems to be unused, 2006-01-13 mbp
158
warn('%s is deprecated' % self.setup_caching)
159
self.cache_root = cache_root
162
cfg = self.tree_config()
163
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
165
def _set_nick(self, nick):
166
cfg = self.tree_config()
167
cfg.set_option(nick, "nickname")
168
assert cfg.get_option("nickname") == nick
170
nick = property(_get_nick, _set_nick)
173
raise NotImplementedError('is_locked is abstract')
175
def lock_write(self):
176
raise NotImplementedError('lock_write is abstract')
179
raise NotImplementedError('lock_read is abstract')
182
raise NotImplementedError('unlock is abstract')
184
def peek_lock_mode(self):
185
"""Return lock mode for the Branch: 'r', 'w' or None"""
186
raise NotImplementedError(self.peek_lock_mode)
188
def get_physical_lock_status(self):
189
raise NotImplementedError('get_physical_lock_status is abstract')
191
def abspath(self, name):
192
"""Return absolute filename for something in the branch
194
XXX: Robert Collins 20051017 what is this used for? why is it a branch
195
method and not a tree method.
197
raise NotImplementedError('abspath is abstract')
199
def bind(self, other):
200
"""Bind the local branch the other branch.
202
:param other: The branch to bind to
205
raise errors.UpgradeRequired(self.base)
208
def fetch(self, from_branch, last_revision=None, pb=None):
209
"""Copy revisions from from_branch into this branch.
211
:param from_branch: Where to copy from.
212
:param last_revision: What revision to stop at (None for at the end
214
:param pb: An optional progress bar to use.
216
Returns the copied revision count and the failed revisions in a tuple:
219
if self.base == from_branch.base:
222
nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
227
from_branch.lock_read()
229
if last_revision is None:
230
pb.update('get source history')
231
from_history = from_branch.revision_history()
233
last_revision = from_history[-1]
235
# no history in the source branch
236
last_revision = NULL_REVISION
237
return self.repository.fetch(from_branch.repository,
238
revision_id=last_revision,
241
if nested_pb is not None:
245
def get_bound_location(self):
246
"""Return the URL of the branch we are bound to.
248
Older format branches cannot bind, please be sure to use a metadir
253
def get_commit_builder(self, parents, config=None, timestamp=None,
254
timezone=None, committer=None, revprops=None,
256
"""Obtain a CommitBuilder for this branch.
258
:param parents: Revision ids of the parents of the new revision.
259
:param config: Optional configuration to use.
260
:param timestamp: Optional timestamp recorded for commit.
261
:param timezone: Optional timezone for timestamp.
262
:param committer: Optional committer to set for commit.
263
:param revprops: Optional dictionary of revision properties.
264
:param revision_id: Optional revision id.
268
config = bzrlib.config.BranchConfig(self)
270
return self.repository.get_commit_builder(self, parents, config,
271
timestamp, timezone, committer, revprops, revision_id)
273
def get_master_branch(self):
274
"""Return the branch we are bound to.
276
:return: Either a Branch, or None
280
def get_root_id(self):
281
"""Return the id of this branches root"""
282
raise NotImplementedError('get_root_id is abstract')
284
def print_file(self, file, revision_id):
285
"""Print `file` to stdout."""
286
raise NotImplementedError('print_file is abstract')
288
def append_revision(self, *revision_ids):
289
raise NotImplementedError('append_revision is abstract')
291
def set_revision_history(self, rev_history):
292
raise NotImplementedError('set_revision_history is abstract')
294
def revision_history(self):
295
"""Return sequence of revision hashes on to this branch."""
296
raise NotImplementedError('revision_history is abstract')
299
"""Return current revision number for this branch.
301
That is equivalent to the number of revisions committed to
304
return len(self.revision_history())
307
"""Older format branches cannot bind or unbind."""
308
raise errors.UpgradeRequired(self.base)
310
def last_revision(self):
311
"""Return last patch hash, or None if no history."""
312
ph = self.revision_history()
318
def missing_revisions(self, other, stop_revision=None):
319
"""Return a list of new revisions that would perfectly fit.
321
If self and other have not diverged, return a list of the revisions
322
present in other, but missing from self.
324
>>> from bzrlib.workingtree import WorkingTree
325
>>> bzrlib.trace.silent = True
326
>>> d1 = bzrdir.ScratchDir()
327
>>> br1 = d1.open_branch()
328
>>> wt1 = d1.open_workingtree()
329
>>> d2 = bzrdir.ScratchDir()
330
>>> br2 = d2.open_branch()
331
>>> wt2 = d2.open_workingtree()
332
>>> br1.missing_revisions(br2)
334
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
335
>>> br1.missing_revisions(br2)
337
>>> br2.missing_revisions(br1)
339
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
340
>>> br1.missing_revisions(br2)
342
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
343
>>> br1.missing_revisions(br2)
345
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
346
>>> br1.missing_revisions(br2)
347
Traceback (most recent call last):
348
DivergedBranches: These branches have diverged. Try merge.
350
self_history = self.revision_history()
351
self_len = len(self_history)
352
other_history = other.revision_history()
353
other_len = len(other_history)
354
common_index = min(self_len, other_len) -1
355
if common_index >= 0 and \
356
self_history[common_index] != other_history[common_index]:
357
raise DivergedBranches(self, other)
359
if stop_revision is None:
360
stop_revision = other_len
362
assert isinstance(stop_revision, int)
363
if stop_revision > other_len:
364
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
365
return other_history[self_len:stop_revision]
367
def update_revisions(self, other, stop_revision=None):
368
"""Pull in new perfect-fit revisions.
370
:param other: Another Branch to pull from
371
:param stop_revision: Updated until the given revision
374
raise NotImplementedError('update_revisions is abstract')
376
def revision_id_to_revno(self, revision_id):
377
"""Given a revision id, return its revno"""
378
if revision_id is None:
380
history = self.revision_history()
382
return history.index(revision_id) + 1
384
raise bzrlib.errors.NoSuchRevision(self, revision_id)
386
def get_rev_id(self, revno, history=None):
387
"""Find the revision id of the specified revno."""
391
history = self.revision_history()
392
elif revno <= 0 or revno > len(history):
393
raise bzrlib.errors.NoSuchRevision(self, revno)
394
return history[revno - 1]
396
def pull(self, source, overwrite=False, stop_revision=None):
397
raise NotImplementedError('pull is abstract')
399
def basis_tree(self):
400
"""Return `Tree` object for last revision.
402
If there are no revisions yet, return an `EmptyTree`.
404
return self.repository.revision_tree(self.last_revision())
406
def rename_one(self, from_rel, to_rel):
409
This can change the directory or the filename or both.
411
raise NotImplementedError('rename_one is abstract')
413
def move(self, from_paths, to_name):
416
to_name must exist as a versioned directory.
418
If to_name exists and is a directory, the files are moved into
419
it, keeping their old names. If it is a directory,
421
Note that to_name is only the last component of the new name;
422
this doesn't change the directory.
424
This returns a list of (from_path, to_path) pairs for each
427
raise NotImplementedError('move is abstract')
429
def get_parent(self):
430
"""Return the parent location of the branch.
432
This is the default location for push/pull/missing. The usual
433
pattern is that the user can override it by specifying a
436
raise NotImplementedError('get_parent is abstract')
438
def get_push_location(self):
439
"""Return the None or the location to push this branch to."""
440
raise NotImplementedError('get_push_location is abstract')
442
def set_push_location(self, location):
443
"""Set a new push location for this branch."""
444
raise NotImplementedError('set_push_location is abstract')
446
def set_parent(self, url):
447
raise NotImplementedError('set_parent is abstract')
451
"""Synchronise this branch with the master branch if any.
453
:return: None or the last_revision pivoted out during the update.
457
def check_revno(self, revno):
459
Check whether a revno corresponds to any revision.
460
Zero (the NULL revision) is considered valid.
463
self.check_real_revno(revno)
465
def check_real_revno(self, revno):
467
Check whether a revno corresponds to a real revision.
468
Zero (the NULL revision) is considered invalid
470
if revno < 1 or revno > self.revno():
471
raise InvalidRevisionNumber(revno)
474
def clone(self, *args, **kwargs):
475
"""Clone this branch into to_bzrdir preserving all semantic values.
477
revision_id: if not None, the revision history in the new branch will
478
be truncated to end with revision_id.
480
# for API compatibility, until 0.8 releases we provide the old api:
481
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
482
# after 0.8 releases, the *args and **kwargs should be changed:
483
# def clone(self, to_bzrdir, revision_id=None):
484
if (kwargs.get('to_location', None) or
485
kwargs.get('revision', None) or
486
kwargs.get('basis_branch', None) or
487
(len(args) and isinstance(args[0], basestring))):
488
# backwards compatibility api:
489
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
490
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
493
basis_branch = args[2]
495
basis_branch = kwargs.get('basis_branch', None)
497
basis = basis_branch.bzrdir
502
revision_id = args[1]
504
revision_id = kwargs.get('revision', None)
509
# no default to raise if not provided.
510
url = kwargs.get('to_location')
511
return self.bzrdir.clone(url,
512
revision_id=revision_id,
513
basis=basis).open_branch()
515
# generate args by hand
517
revision_id = args[1]
519
revision_id = kwargs.get('revision_id', None)
523
# no default to raise if not provided.
524
to_bzrdir = kwargs.get('to_bzrdir')
525
result = self._format.initialize(to_bzrdir)
526
self.copy_content_into(result, revision_id=revision_id)
530
def sprout(self, to_bzrdir, revision_id=None):
531
"""Create a new line of development from the branch, into to_bzrdir.
533
revision_id: if not None, the revision history in the new branch will
534
be truncated to end with revision_id.
536
result = self._format.initialize(to_bzrdir)
537
self.copy_content_into(result, revision_id=revision_id)
538
result.set_parent(self.bzrdir.root_transport.base)
542
def copy_content_into(self, destination, revision_id=None):
543
"""Copy the content of self into destination.
545
revision_id: if not None, the revision history in the new branch will
546
be truncated to end with revision_id.
548
new_history = self.revision_history()
549
if revision_id is not None:
551
new_history = new_history[:new_history.index(revision_id) + 1]
553
rev = self.repository.get_revision(revision_id)
554
new_history = rev.get_history(self.repository)[1:]
555
destination.set_revision_history(new_history)
556
parent = self.get_parent()
558
destination.set_parent(parent)
562
"""Check consistency of the branch.
564
In particular this checks that revisions given in the revision-history
565
do actually match up in the revision graph, and that they're all
566
present in the repository.
568
:return: A BranchCheckResult.
570
mainline_parent_id = None
571
for revision_id in self.revision_history():
573
revision = self.repository.get_revision(revision_id)
574
except errors.NoSuchRevision, e:
575
raise BzrCheckError("mainline revision {%s} not in repository"
577
# In general the first entry on the revision history has no parents.
578
# But it's not illegal for it to have parents listed; this can happen
579
# in imports from Arch when the parents weren't reachable.
580
if mainline_parent_id is not None:
581
if mainline_parent_id not in revision.parent_ids:
582
raise BzrCheckError("previous revision {%s} not listed among "
584
% (mainline_parent_id, revision_id))
585
mainline_parent_id = revision_id
586
return BranchCheckResult(self)
589
class BranchFormat(object):
590
"""An encapsulation of the initialization and open routines for a format.
592
Formats provide three things:
593
* An initialization routine,
597
Formats are placed in an dict by their format string for reference
598
during branch opening. Its not required that these be instances, they
599
can be classes themselves with class methods - it simply depends on
600
whether state is needed for a given format or not.
602
Once a format is deprecated, just deprecate the initialize and open
603
methods on the format class. Do not deprecate the object, as the
604
object will be created every time regardless.
607
_default_format = None
608
"""The default format used for new branches."""
611
"""The known formats."""
614
def find_format(klass, a_bzrdir):
615
"""Return the format for the branch object in a_bzrdir."""
617
transport = a_bzrdir.get_branch_transport(None)
618
format_string = transport.get("format").read()
619
return klass._formats[format_string]
621
raise NotBranchError(path=transport.base)
623
raise errors.UnknownFormatError(format_string)
626
def get_default_format(klass):
627
"""Return the current default format."""
628
return klass._default_format
630
def get_format_string(self):
631
"""Return the ASCII format string that identifies this format."""
632
raise NotImplementedError(self.get_format_string)
634
def get_format_description(self):
635
"""Return the short format description for this format."""
636
raise NotImplementedError(self.get_format_string)
638
def initialize(self, a_bzrdir):
639
"""Create a branch of this format in a_bzrdir."""
640
raise NotImplementedError(self.initialize)
642
def is_supported(self):
643
"""Is this format supported?
645
Supported formats can be initialized and opened.
646
Unsupported formats may not support initialization or committing or
647
some other features depending on the reason for not being supported.
651
def open(self, a_bzrdir, _found=False):
652
"""Return the branch object for a_bzrdir
654
_found is a private parameter, do not use it. It is used to indicate
655
if format probing has already be done.
657
raise NotImplementedError(self.open)
660
def register_format(klass, format):
661
klass._formats[format.get_format_string()] = format
664
def set_default_format(klass, format):
665
klass._default_format = format
668
def unregister_format(klass, format):
669
assert klass._formats[format.get_format_string()] is format
670
del klass._formats[format.get_format_string()]
673
return self.get_format_string().rstrip()
676
class BzrBranchFormat4(BranchFormat):
677
"""Bzr branch format 4.
680
- a revision-history file.
681
- a branch-lock lock file [ to be shared with the bzrdir ]
684
def get_format_description(self):
685
"""See BranchFormat.get_format_description()."""
686
return "Branch format 4"
688
def initialize(self, a_bzrdir):
689
"""Create a branch of this format in a_bzrdir."""
690
mutter('creating branch in %s', a_bzrdir.transport.base)
691
branch_transport = a_bzrdir.get_branch_transport(self)
692
utf8_files = [('revision-history', ''),
695
control_files = LockableFiles(branch_transport, 'branch-lock',
697
control_files.create_lock()
698
control_files.lock_write()
700
for file, content in utf8_files:
701
control_files.put_utf8(file, content)
703
control_files.unlock()
704
return self.open(a_bzrdir, _found=True)
707
super(BzrBranchFormat4, self).__init__()
708
self._matchingbzrdir = bzrdir.BzrDirFormat6()
710
def open(self, a_bzrdir, _found=False):
711
"""Return the branch object for a_bzrdir
713
_found is a private parameter, do not use it. It is used to indicate
714
if format probing has already be done.
717
# we are being called directly and must probe.
718
raise NotImplementedError
719
return BzrBranch(_format=self,
720
_control_files=a_bzrdir._control_files,
722
_repository=a_bzrdir.open_repository())
725
return "Bazaar-NG branch format 4"
728
class BzrBranchFormat5(BranchFormat):
729
"""Bzr branch format 5.
732
- a revision-history file.
734
- a lock dir guarding the branch itself
735
- all of this stored in a branch/ subdirectory
736
- works with shared repositories.
738
This format is new in bzr 0.8.
741
def get_format_string(self):
742
"""See BranchFormat.get_format_string()."""
743
return "Bazaar-NG branch format 5\n"
745
def get_format_description(self):
746
"""See BranchFormat.get_format_description()."""
747
return "Branch format 5"
749
def initialize(self, a_bzrdir):
750
"""Create a branch of this format in a_bzrdir."""
751
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
752
branch_transport = a_bzrdir.get_branch_transport(self)
753
utf8_files = [('revision-history', ''),
756
control_files = LockableFiles(branch_transport, 'lock', LockDir)
757
control_files.create_lock()
758
control_files.lock_write()
759
control_files.put_utf8('format', self.get_format_string())
761
for file, content in utf8_files:
762
control_files.put_utf8(file, content)
764
control_files.unlock()
765
return self.open(a_bzrdir, _found=True, )
768
super(BzrBranchFormat5, self).__init__()
769
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
771
def open(self, a_bzrdir, _found=False):
772
"""Return the branch object for a_bzrdir
774
_found is a private parameter, do not use it. It is used to indicate
775
if format probing has already be done.
778
format = BranchFormat.find_format(a_bzrdir)
779
assert format.__class__ == self.__class__
780
transport = a_bzrdir.get_branch_transport(None)
781
control_files = LockableFiles(transport, 'lock', LockDir)
782
return BzrBranch5(_format=self,
783
_control_files=control_files,
785
_repository=a_bzrdir.find_repository())
788
return "Bazaar-NG Metadir branch format 5"
791
class BranchReferenceFormat(BranchFormat):
792
"""Bzr branch reference format.
794
Branch references are used in implementing checkouts, they
795
act as an alias to the real branch which is at some other url.
802
def get_format_string(self):
803
"""See BranchFormat.get_format_string()."""
804
return "Bazaar-NG Branch Reference Format 1\n"
806
def get_format_description(self):
807
"""See BranchFormat.get_format_description()."""
808
return "Checkout reference format 1"
810
def initialize(self, a_bzrdir, target_branch=None):
811
"""Create a branch of this format in a_bzrdir."""
812
if target_branch is None:
813
# this format does not implement branch itself, thus the implicit
814
# creation contract must see it as uninitializable
815
raise errors.UninitializableFormat(self)
816
mutter('creating branch reference in %s', a_bzrdir.transport.base)
817
branch_transport = a_bzrdir.get_branch_transport(self)
818
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
819
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
820
branch_transport.put('format', StringIO(self.get_format_string()))
821
return self.open(a_bzrdir, _found=True)
824
super(BranchReferenceFormat, self).__init__()
825
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
827
def _make_reference_clone_function(format, a_branch):
828
"""Create a clone() routine for a branch dynamically."""
829
def clone(to_bzrdir, revision_id=None):
830
"""See Branch.clone()."""
831
return format.initialize(to_bzrdir, a_branch)
832
# cannot obey revision_id limits when cloning a reference ...
833
# FIXME RBC 20060210 either nuke revision_id for clone, or
834
# emit some sort of warning/error to the caller ?!
837
def open(self, a_bzrdir, _found=False):
838
"""Return the branch that the branch reference in a_bzrdir points at.
840
_found is a private parameter, do not use it. It is used to indicate
841
if format probing has already be done.
844
format = BranchFormat.find_format(a_bzrdir)
845
assert format.__class__ == self.__class__
846
transport = a_bzrdir.get_branch_transport(None)
847
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
848
result = real_bzrdir.open_branch()
849
# this changes the behaviour of result.clone to create a new reference
850
# rather than a copy of the content of the branch.
851
# I did not use a proxy object because that needs much more extensive
852
# testing, and we are only changing one behaviour at the moment.
853
# If we decide to alter more behaviours - i.e. the implicit nickname
854
# then this should be refactored to introduce a tested proxy branch
855
# and a subclass of that for use in overriding clone() and ....
857
result.clone = self._make_reference_clone_function(result)
861
# formats which have no format string are not discoverable
862
# and not independently creatable, so are not registered.
863
__default_format = BzrBranchFormat5()
864
BranchFormat.register_format(__default_format)
865
BranchFormat.register_format(BranchReferenceFormat())
866
BranchFormat.set_default_format(__default_format)
867
_legacy_formats = [BzrBranchFormat4(),
870
class BzrBranch(Branch):
871
"""A branch stored in the actual filesystem.
873
Note that it's "local" in the context of the filesystem; it doesn't
874
really matter if it's on an nfs/smb/afs/coda/... share, as long as
875
it's writable, and can be accessed via the normal filesystem API.
878
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
879
relax_version_check=DEPRECATED_PARAMETER, _format=None,
880
_control_files=None, a_bzrdir=None, _repository=None):
881
"""Create new branch object at a particular location.
883
transport -- A Transport object, defining how to access files.
885
init -- If True, create new control files in a previously
886
unversioned directory. If False, the branch must already
889
relax_version_check -- If true, the usual check for the branch
890
version is not applied. This is intended only for
891
upgrade/recovery type use; it's not guaranteed that
892
all operations will work on old format branches.
895
self.bzrdir = bzrdir.BzrDir.open(transport.base)
897
self.bzrdir = a_bzrdir
898
self._transport = self.bzrdir.transport.clone('..')
899
self._base = self._transport.base
900
self._format = _format
901
if _control_files is None:
902
raise BzrBadParameterMissing('_control_files')
903
self.control_files = _control_files
904
if deprecated_passed(init):
905
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
906
"deprecated as of bzr 0.8. Please use Branch.create().",
910
# this is slower than before deprecation, oh well never mind.
912
self._initialize(transport.base)
913
self._check_format(_format)
914
if deprecated_passed(relax_version_check):
915
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
916
"relax_version_check parameter is deprecated as of bzr 0.8. "
917
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
921
if (not relax_version_check
922
and not self._format.is_supported()):
923
raise errors.UnsupportedFormatError(
924
'sorry, branch format %r not supported' % fmt,
925
['use a different bzr version',
926
'or remove the .bzr directory'
927
' and "bzr init" again'])
928
if deprecated_passed(transport):
929
warn("BzrBranch.__init__(transport=XXX...): The transport "
930
"parameter is deprecated as of bzr 0.8. "
931
"Please use Branch.open, or bzrdir.open_branch().",
934
self.repository = _repository
937
return '%s(%r)' % (self.__class__.__name__, self.base)
942
# TODO: It might be best to do this somewhere else,
943
# but it is nice for a Branch object to automatically
944
# cache it's information.
945
# Alternatively, we could have the Transport objects cache requests
946
# See the earlier discussion about how major objects (like Branch)
947
# should never expect their __del__ function to run.
948
# XXX: cache_root seems to be unused, 2006-01-13 mbp
949
if hasattr(self, 'cache_root') and self.cache_root is not None:
951
rmtree(self.cache_root)
954
self.cache_root = None
959
base = property(_get_base, doc="The URL for the root of this branch.")
961
def _finish_transaction(self):
962
"""Exit the current transaction."""
963
return self.control_files._finish_transaction()
965
def get_transaction(self):
966
"""Return the current active transaction.
968
If no transaction is active, this returns a passthrough object
969
for which all data is immediately flushed and no caching happens.
971
# this is an explicit function so that we can do tricky stuff
972
# when the storage in rev_storage is elsewhere.
973
# we probably need to hook the two 'lock a location' and
974
# 'have a transaction' together more delicately, so that
975
# we can have two locks (branch and storage) and one transaction
976
# ... and finishing the transaction unlocks both, but unlocking
977
# does not. - RBC 20051121
978
return self.control_files.get_transaction()
980
def _set_transaction(self, transaction):
981
"""Set a new active transaction."""
982
return self.control_files._set_transaction(transaction)
984
def abspath(self, name):
985
"""See Branch.abspath."""
986
return self.control_files._transport.abspath(name)
988
def _check_format(self, format):
989
"""Identify the branch format if needed.
991
The format is stored as a reference to the format object in
992
self._format for code that needs to check it later.
994
The format parameter is either None or the branch format class
995
used to open this branch.
997
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1000
format = BzrBranchFormat.find_format(self.bzrdir)
1001
self._format = format
1002
mutter("got branch format %s", self._format)
1005
def get_root_id(self):
1006
"""See Branch.get_root_id."""
1007
tree = self.repository.revision_tree(self.last_revision())
1008
return tree.inventory.root.file_id
1010
def is_locked(self):
1011
return self.control_files.is_locked()
1013
def lock_write(self):
1014
# TODO: test for failed two phase locks. This is known broken.
1015
self.control_files.lock_write()
1016
self.repository.lock_write()
1018
def lock_read(self):
1019
# TODO: test for failed two phase locks. This is known broken.
1020
self.control_files.lock_read()
1021
self.repository.lock_read()
1024
# TODO: test for failed two phase locks. This is known broken.
1026
self.repository.unlock()
1028
self.control_files.unlock()
1030
def peek_lock_mode(self):
1031
if self.control_files._lock_count == 0:
1034
return self.control_files._lock_mode
1036
def get_physical_lock_status(self):
1037
return self.control_files.get_physical_lock_status()
1040
def print_file(self, file, revision_id):
1041
"""See Branch.print_file."""
1042
return self.repository.print_file(file, revision_id)
1045
def append_revision(self, *revision_ids):
1046
"""See Branch.append_revision."""
1047
for revision_id in revision_ids:
1048
mutter("add {%s} to revision-history" % revision_id)
1049
rev_history = self.revision_history()
1050
rev_history.extend(revision_ids)
1051
self.set_revision_history(rev_history)
1054
def set_revision_history(self, rev_history):
1055
"""See Branch.set_revision_history."""
1056
self.control_files.put_utf8(
1057
'revision-history', '\n'.join(rev_history))
1058
transaction = self.get_transaction()
1059
history = transaction.map.find_revision_history()
1060
if history is not None:
1061
# update the revision history in the identity map.
1062
history[:] = list(rev_history)
1063
# this call is disabled because revision_history is
1064
# not really an object yet, and the transaction is for objects.
1065
# transaction.register_dirty(history)
1067
transaction.map.add_revision_history(rev_history)
1068
# this call is disabled because revision_history is
1069
# not really an object yet, and the transaction is for objects.
1070
# transaction.register_clean(history)
1072
def get_revision_delta(self, revno):
1073
"""Return the delta for one revision.
1075
The delta is relative to its mainline predecessor, or the
1076
empty tree for revision 1.
1078
assert isinstance(revno, int)
1079
rh = self.revision_history()
1080
if not (1 <= revno <= len(rh)):
1081
raise InvalidRevisionNumber(revno)
1083
# revno is 1-based; list is 0-based
1085
new_tree = self.repository.revision_tree(rh[revno-1])
1087
old_tree = EmptyTree()
1089
old_tree = self.repository.revision_tree(rh[revno-2])
1090
return compare_trees(old_tree, new_tree)
1093
def revision_history(self):
1094
"""See Branch.revision_history."""
1095
transaction = self.get_transaction()
1096
history = transaction.map.find_revision_history()
1097
if history is not None:
1098
mutter("cache hit for revision-history in %s", self)
1099
return list(history)
1100
history = [l.rstrip('\r\n') for l in
1101
self.control_files.get_utf8('revision-history').readlines()]
1102
transaction.map.add_revision_history(history)
1103
# this call is disabled because revision_history is
1104
# not really an object yet, and the transaction is for objects.
1105
# transaction.register_clean(history, precious=True)
1106
return list(history)
1109
def update_revisions(self, other, stop_revision=None):
1110
"""See Branch.update_revisions."""
1113
if stop_revision is None:
1114
stop_revision = other.last_revision()
1115
if stop_revision is None:
1116
# if there are no commits, we're done.
1118
# whats the current last revision, before we fetch [and change it
1120
last_rev = self.last_revision()
1121
# we fetch here regardless of whether we need to so that we pickup
1123
self.fetch(other, stop_revision)
1124
my_ancestry = self.repository.get_ancestry(last_rev)
1125
if stop_revision in my_ancestry:
1126
# last_revision is a descendant of stop_revision
1128
# stop_revision must be a descendant of last_revision
1129
stop_graph = self.repository.get_revision_graph(stop_revision)
1130
if last_rev is not None and last_rev not in stop_graph:
1131
# our previous tip is not merged into stop_revision
1132
raise errors.DivergedBranches(self, other)
1133
# make a new revision history from the graph
1134
current_rev_id = stop_revision
1136
while current_rev_id not in (None, NULL_REVISION):
1137
new_history.append(current_rev_id)
1138
current_rev_id_parents = stop_graph[current_rev_id]
1140
current_rev_id = current_rev_id_parents[0]
1142
current_rev_id = None
1143
new_history.reverse()
1144
self.set_revision_history(new_history)
1148
def basis_tree(self):
1149
"""See Branch.basis_tree."""
1150
return self.repository.revision_tree(self.last_revision())
1152
@deprecated_method(zero_eight)
1153
def working_tree(self):
1154
"""Create a Working tree object for this branch."""
1155
from bzrlib.workingtree import WorkingTree
1156
from bzrlib.transport.local import LocalTransport
1157
if (self.base.find('://') != -1 or
1158
not isinstance(self._transport, LocalTransport)):
1159
raise NoWorkingTree(self.base)
1160
return self.bzrdir.open_workingtree()
1163
def pull(self, source, overwrite=False, stop_revision=None):
1164
"""See Branch.pull."""
1167
old_count = len(self.revision_history())
1169
self.update_revisions(source,stop_revision)
1170
except DivergedBranches:
1174
self.set_revision_history(source.revision_history())
1175
new_count = len(self.revision_history())
1176
return new_count - old_count
1180
def get_parent(self):
1181
"""See Branch.get_parent."""
1183
_locs = ['parent', 'pull', 'x-pull']
1184
assert self.base[-1] == '/'
1187
return urlutils.join(self.base[:-1],
1188
self.control_files.get(l).read().strip('\n'))
1193
def get_push_location(self):
1194
"""See Branch.get_push_location."""
1195
config = bzrlib.config.BranchConfig(self)
1196
push_loc = config.get_user_option('push_location')
1199
def set_push_location(self, location):
1200
"""See Branch.set_push_location."""
1201
config = bzrlib.config.LocationConfig(self.base)
1202
config.set_user_option('push_location', location)
1205
def set_parent(self, url):
1206
"""See Branch.set_parent."""
1207
# TODO: Maybe delete old location files?
1208
# URLs should never be unicode, even on the local fs,
1209
# FIXUP this and get_parent in a future branch format bump:
1210
# read and rewrite the file, and have the new format code read
1211
# using .get not .get_utf8. RBC 20060125
1213
self.control_files._transport.delete('parent')
1215
if isinstance(url, unicode):
1217
url = url.encode('ascii')
1218
except UnicodeEncodeError:
1219
raise bzrlib.errors.InvalidURL(url,
1220
"Urls must be 7-bit ascii, "
1221
"use bzrlib.urlutils.escape")
1223
url = urlutils.relative_url(self.base, url)
1224
self.control_files.put('parent', url + '\n')
1226
def tree_config(self):
1227
return TreeConfig(self)
1230
class BzrBranch5(BzrBranch):
1231
"""A format 5 branch. This supports new features over plan branches.
1233
It has support for a master_branch which is the data for bound branches.
1241
super(BzrBranch5, self).__init__(_format=_format,
1242
_control_files=_control_files,
1244
_repository=_repository)
1247
def pull(self, source, overwrite=False, stop_revision=None):
1248
"""Updates branch.pull to be bound branch aware."""
1249
bound_location = self.get_bound_location()
1250
if source.base != bound_location:
1251
# not pulling from master, so we need to update master.
1252
master_branch = self.get_master_branch()
1254
master_branch.pull(source)
1255
source = master_branch
1256
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1258
def get_bound_location(self):
1260
return self.control_files.get_utf8('bound').read()[:-1]
1261
except errors.NoSuchFile:
1265
def get_master_branch(self):
1266
"""Return the branch we are bound to.
1268
:return: Either a Branch, or None
1270
This could memoise the branch, but if thats done
1271
it must be revalidated on each new lock.
1272
So for now we just don't memoise it.
1273
# RBC 20060304 review this decision.
1275
bound_loc = self.get_bound_location()
1279
return Branch.open(bound_loc)
1280
except (errors.NotBranchError, errors.ConnectionError), e:
1281
raise errors.BoundBranchConnectionFailure(
1285
def set_bound_location(self, location):
1286
"""Set the target where this branch is bound to.
1288
:param location: URL to the target branch
1291
self.control_files.put_utf8('bound', location+'\n')
1294
self.control_files._transport.delete('bound')
1300
def bind(self, other):
1301
"""Bind the local branch the other branch.
1303
:param other: The branch to bind to
1306
# TODO: jam 20051230 Consider checking if the target is bound
1307
# It is debatable whether you should be able to bind to
1308
# a branch which is itself bound.
1309
# Committing is obviously forbidden,
1310
# but binding itself may not be.
1311
# Since we *have* to check at commit time, we don't
1312
# *need* to check here
1315
# we are now equal to or a suffix of other.
1317
# Since we have 'pulled' from the remote location,
1318
# now we should try to pull in the opposite direction
1319
# in case the local tree has more revisions than the
1321
# There may be a different check you could do here
1322
# rather than actually trying to install revisions remotely.
1323
# TODO: capture an exception which indicates the remote branch
1325
# If it is up-to-date, this probably should not be a failure
1327
# lock other for write so the revision-history syncing cannot race
1331
# if this does not error, other now has the same last rev we do
1332
# it can only error if the pull from other was concurrent with
1333
# a commit to other from someone else.
1335
# until we ditch revision-history, we need to sync them up:
1336
self.set_revision_history(other.revision_history())
1337
# now other and self are up to date with each other and have the
1338
# same revision-history.
1342
self.set_bound_location(other.base)
1346
"""If bound, unbind"""
1347
return self.set_bound_location(None)
1351
"""Synchronise this branch with the master branch if any.
1353
:return: None or the last_revision that was pivoted out during the
1356
master = self.get_master_branch()
1357
if master is not None:
1358
old_tip = self.last_revision()
1359
self.pull(master, overwrite=True)
1360
if old_tip in self.repository.get_ancestry(self.last_revision()):
1366
class BranchTestProviderAdapter(object):
1367
"""A tool to generate a suite testing multiple branch formats at once.
1369
This is done by copying the test once for each transport and injecting
1370
the transport_server, transport_readonly_server, and branch_format
1371
classes into each copy. Each copy is also given a new id() to make it
1375
def __init__(self, transport_server, transport_readonly_server, formats):
1376
self._transport_server = transport_server
1377
self._transport_readonly_server = transport_readonly_server
1378
self._formats = formats
1380
def adapt(self, test):
1381
result = TestSuite()
1382
for branch_format, bzrdir_format in self._formats:
1383
new_test = deepcopy(test)
1384
new_test.transport_server = self._transport_server
1385
new_test.transport_readonly_server = self._transport_readonly_server
1386
new_test.bzrdir_format = bzrdir_format
1387
new_test.branch_format = branch_format
1388
def make_new_test_id():
1389
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1390
return lambda: new_id
1391
new_test.id = make_new_test_id()
1392
result.addTest(new_test)
1396
class BranchCheckResult(object):
1397
"""Results of checking branch consistency.
1402
def __init__(self, branch):
1403
self.branch = branch
1405
def report_results(self, verbose):
1406
"""Report the check results via trace.note.
1408
:param verbose: Requests more detailed display of what was checked,
1411
note('checked branch %s format %s',
1413
self.branch._format)
1416
######################################################################
1420
@deprecated_function(zero_eight)
1421
def ScratchBranch(*args, **kwargs):
1422
"""See bzrlib.bzrdir.ScratchDir."""
1423
d = ScratchDir(*args, **kwargs)
1424
return d.open_branch()
1427
@deprecated_function(zero_eight)
1428
def is_control_file(*args, **kwargs):
1429
"""See bzrlib.workingtree.is_control_file."""
1430
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
