1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from copy import deepcopy
19
from cStringIO import StringIO
20
from unittest import TestSuite
22
21
from warnings import warn
24
import xml.sax.saxutils
26
raise ImportError("We were unable to import 'xml.sax.saxutils',"
27
" most likely you have an xml.pyc or xml.pyo file"
28
" lying around in your bzrlib directory."
30
from cStringIO import StringIO
34
from bzrlib.trace import mutter, note
35
from bzrlib.osutils import (isdir, quotefn,
36
rename, splitpath, sha_file,
37
file_kind, abspath, normpath, pathjoin)
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
40
NoSuchRevision, HistoryMissing, NotBranchError,
41
DivergedBranches, LockError, UnlistableStore,
42
UnlistableBranch, NoSuchFile, NotVersionedError,
44
from bzrlib.textui import show_status
45
36
from bzrlib.config import TreeConfig
46
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
from bzrlib.delta import compare_trees
48
import bzrlib.inventory as inventory
49
from bzrlib.inventory import Inventory
50
from bzrlib.lockable_files import LockableFiles
51
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions)
52
from bzrlib.repository import Repository
53
from bzrlib.store import copy_all
54
import bzrlib.transactions as transactions
55
from bzrlib.transport import Transport, get_transport
56
from bzrlib.tree import EmptyTree, RevisionTree
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
40
HistoryMissing, InvalidRevisionId,
41
InvalidRevisionNumber, LockError, NoSuchFile,
42
NoSuchRevision, NoWorkingTree, NotVersionedError,
43
NotBranchError, UninitializableFormat,
44
UnlistableStore, UnlistableBranch,
46
from bzrlib.lockable_files import LockableFiles, TransportLock
47
from bzrlib.symbol_versioning import (deprecated_function,
51
zero_eight, zero_nine,
53
from bzrlib.trace import mutter, note
61
56
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
109
122
Basically we keep looking up until we find the control directory or
110
123
run into the root. If there isn't one, raises NotBranchError.
124
If there is one and it is either an unrecognised format or an unsupported
125
format, UnknownFormatError or UnsupportedFormatError are raised.
111
126
If there is one, it is returned, along with the unused portion of url.
113
t = get_transport(url)
116
return BzrBranch(t), t.relpath(url)
117
except NotBranchError, e:
118
mutter('not a branch in: %r %s', t.base, e)
119
new_t = t.clone('..')
120
if new_t.base == t.base:
121
# reached the root, whatever that may be
122
raise NotBranchError(path=url)
128
control, relpath = bzrdir.BzrDir.open_containing(url)
129
return control.open_branch(), relpath
132
@deprecated_function(zero_eight)
126
133
def initialize(base):
127
"""Create a new branch, rooted at 'base' (url)"""
128
t = get_transport(unicode(base))
129
return BzrBranch(t, init=True)
134
"""Create a new working tree and branch, rooted at 'base' (url)
136
NOTE: This will soon be deprecated in favour of creation
139
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
141
@deprecated_function(zero_eight)
131
142
def setup_caching(self, cache_root):
132
143
"""Subclasses that care about caching should override this, and set
133
144
up cached stores located under cache_root.
146
NOTE: This is unused.
135
# seems to be unused, 2006-01-13 mbp
136
warn('%s is deprecated' % self.setup_caching)
137
self.cache_root = cache_root
150
def get_config(self):
151
return bzrlib.config.BranchConfig(self)
139
153
def _get_nick(self):
140
cfg = self.tree_config()
141
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
154
return self.get_config().get_nickname()
143
156
def _set_nick(self, nick):
144
cfg = self.tree_config()
145
cfg.set_option(nick, "nickname")
146
assert cfg.get_option("nickname") == nick
157
self.get_config().set_user_option('nickname', nick)
148
159
nick = property(_get_nick, _set_nick)
150
def push_stores(self, branch_to):
151
"""Copy the content of this branches store to branch_to."""
152
raise NotImplementedError('push_stores is abstract')
162
raise NotImplementedError(self.is_locked)
154
164
def lock_write(self):
155
raise NotImplementedError('lock_write is abstract')
165
raise NotImplementedError(self.lock_write)
157
167
def lock_read(self):
158
raise NotImplementedError('lock_read is abstract')
168
raise NotImplementedError(self.lock_read)
160
170
def unlock(self):
161
raise NotImplementedError('unlock is abstract')
171
raise NotImplementedError(self.unlock)
163
173
def peek_lock_mode(self):
164
174
"""Return lock mode for the Branch: 'r', 'w' or None"""
165
175
raise NotImplementedError(self.peek_lock_mode)
177
def get_physical_lock_status(self):
178
raise NotImplementedError(self.get_physical_lock_status)
167
180
def abspath(self, name):
168
181
"""Return absolute filename for something in the branch
170
183
XXX: Robert Collins 20051017 what is this used for? why is it a branch
171
184
method and not a tree method.
173
raise NotImplementedError('abspath is abstract')
186
raise NotImplementedError(self.abspath)
188
def bind(self, other):
189
"""Bind the local branch the other branch.
191
:param other: The branch to bind to
194
raise errors.UpgradeRequired(self.base)
197
def fetch(self, from_branch, last_revision=None, pb=None):
198
"""Copy revisions from from_branch into this branch.
200
:param from_branch: Where to copy from.
201
:param last_revision: What revision to stop at (None for at the end
203
:param pb: An optional progress bar to use.
205
Returns the copied revision count and the failed revisions in a tuple:
208
if self.base == from_branch.base:
211
nested_pb = ui.ui_factory.nested_progress_bar()
216
from_branch.lock_read()
218
if last_revision is None:
219
pb.update('get source history')
220
from_history = from_branch.revision_history()
222
last_revision = from_history[-1]
224
# no history in the source branch
225
last_revision = revision.NULL_REVISION
226
return self.repository.fetch(from_branch.repository,
227
revision_id=last_revision,
230
if nested_pb is not None:
234
def get_bound_location(self):
235
"""Return the URL of the branch we are bound to.
237
Older format branches cannot bind, please be sure to use a metadir
242
def get_commit_builder(self, parents, config=None, timestamp=None,
243
timezone=None, committer=None, revprops=None,
245
"""Obtain a CommitBuilder for this branch.
247
:param parents: Revision ids of the parents of the new revision.
248
:param config: Optional configuration to use.
249
:param timestamp: Optional timestamp recorded for commit.
250
:param timezone: Optional timezone for timestamp.
251
:param committer: Optional committer to set for commit.
252
:param revprops: Optional dictionary of revision properties.
253
:param revision_id: Optional revision id.
257
config = self.get_config()
259
return self.repository.get_commit_builder(self, parents, config,
260
timestamp, timezone, committer, revprops, revision_id)
262
def get_master_branch(self):
263
"""Return the branch we are bound to.
265
:return: Either a Branch, or None
269
def get_revision_delta(self, revno):
270
"""Return the delta for one revision.
272
The delta is relative to its mainline predecessor, or the
273
empty tree for revision 1.
275
assert isinstance(revno, int)
276
rh = self.revision_history()
277
if not (1 <= revno <= len(rh)):
278
raise InvalidRevisionNumber(revno)
279
return self.repository.get_revision_delta(rh[revno-1])
175
281
def get_root_id(self):
176
282
"""Return the id of this branches root"""
177
raise NotImplementedError('get_root_id is abstract')
283
raise NotImplementedError(self.get_root_id)
179
285
def print_file(self, file, revision_id):
180
286
"""Print `file` to stdout."""
181
raise NotImplementedError('print_file is abstract')
287
raise NotImplementedError(self.print_file)
183
289
def append_revision(self, *revision_ids):
184
raise NotImplementedError('append_revision is abstract')
290
raise NotImplementedError(self.append_revision)
186
292
def set_revision_history(self, rev_history):
187
raise NotImplementedError('set_revision_history is abstract')
293
raise NotImplementedError(self.set_revision_history)
189
295
def revision_history(self):
190
296
"""Return sequence of revision hashes on to this branch."""
191
raise NotImplementedError('revision_history is abstract')
297
raise NotImplementedError(self.revision_history)
194
300
"""Return current revision number for this branch.
351
460
if revno < 1 or revno > self.revno():
352
461
raise InvalidRevisionNumber(revno)
354
def sign_revision(self, revision_id, gpg_strategy):
355
raise NotImplementedError('sign_revision is abstract')
357
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
358
raise NotImplementedError('store_revision_signature is abstract')
360
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
361
"""Copy this branch into the existing directory to_location.
363
Returns the newly created branch object.
366
If not None, only revisions up to this point will be copied.
367
The head of the new branch will be that revision. Must be a
370
to_location -- The destination directory; must either exist and be
371
empty, or not exist, in which case it is created.
374
A local branch to copy revisions from, related to this branch.
375
This is used when branching from a remote (slow) branch, and we have
376
a local branch that might contain some relevant revisions.
379
Branch type of destination branch
381
# circular import protection
382
from bzrlib.merge import build_working_dir
384
assert isinstance(to_location, basestring)
385
if not bzrlib.osutils.lexists(to_location):
386
os.mkdir(to_location)
387
if to_branch_type is None:
388
to_branch_type = BzrBranch
389
br_to = to_branch_type.initialize(to_location)
390
mutter("copy branch from %s to %s", self, br_to)
391
if basis_branch is not None:
392
basis_branch.push_stores(br_to)
393
br_to.working_tree().set_root_id(self.get_root_id())
395
revision = self.last_revision()
396
br_to.update_revisions(self, stop_revision=revision)
397
br_to.set_parent(self.base)
398
build_working_dir(to_location)
402
def fileid_involved_between_revs(self, from_revid, to_revid):
403
""" This function returns the file_id(s) involved in the
404
changes between the from_revid revision and the to_revid
407
raise NotImplementedError('fileid_involved_between_revs is abstract')
409
def fileid_involved(self, last_revid=None):
410
""" This function returns the file_id(s) involved in the
411
changes up to the revision last_revid
412
If no parametr is passed, then all file_id[s] present in the
413
repository are returned
415
raise NotImplementedError('fileid_involved is abstract')
417
def fileid_involved_by_set(self, changes):
418
""" This function returns the file_id(s) involved in the
419
changes present in the set 'changes'
421
raise NotImplementedError('fileid_involved_by_set is abstract')
423
def fileid_involved_between_revs(self, from_revid, to_revid):
424
""" This function returns the file_id(s) involved in the
425
changes between the from_revid revision and the to_revid
428
raise NotImplementedError('fileid_involved_between_revs is abstract')
430
def fileid_involved(self, last_revid=None):
431
""" This function returns the file_id(s) involved in the
432
changes up to the revision last_revid
433
If no parametr is passed, then all file_id[s] present in the
434
repository are returned
436
raise NotImplementedError('fileid_involved is abstract')
438
def fileid_involved_by_set(self, changes):
439
""" This function returns the file_id(s) involved in the
440
changes present in the set 'changes'
442
raise NotImplementedError('fileid_involved_by_set is abstract')
464
def clone(self, *args, **kwargs):
465
"""Clone this branch into to_bzrdir preserving all semantic values.
467
revision_id: if not None, the revision history in the new branch will
468
be truncated to end with revision_id.
470
# for API compatibility, until 0.8 releases we provide the old api:
471
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
472
# after 0.8 releases, the *args and **kwargs should be changed:
473
# def clone(self, to_bzrdir, revision_id=None):
474
if (kwargs.get('to_location', None) or
475
kwargs.get('revision', None) or
476
kwargs.get('basis_branch', None) or
477
(len(args) and isinstance(args[0], basestring))):
478
# backwards compatibility api:
479
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
480
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
483
basis_branch = args[2]
485
basis_branch = kwargs.get('basis_branch', None)
487
basis = basis_branch.bzrdir
492
revision_id = args[1]
494
revision_id = kwargs.get('revision', None)
499
# no default to raise if not provided.
500
url = kwargs.get('to_location')
501
return self.bzrdir.clone(url,
502
revision_id=revision_id,
503
basis=basis).open_branch()
505
# generate args by hand
507
revision_id = args[1]
509
revision_id = kwargs.get('revision_id', None)
513
# no default to raise if not provided.
514
to_bzrdir = kwargs.get('to_bzrdir')
515
result = self._format.initialize(to_bzrdir)
516
self.copy_content_into(result, revision_id=revision_id)
520
def sprout(self, to_bzrdir, revision_id=None):
521
"""Create a new line of development from the branch, into to_bzrdir.
523
revision_id: if not None, the revision history in the new branch will
524
be truncated to end with revision_id.
526
result = self._format.initialize(to_bzrdir)
527
self.copy_content_into(result, revision_id=revision_id)
528
result.set_parent(self.bzrdir.root_transport.base)
532
def copy_content_into(self, destination, revision_id=None):
533
"""Copy the content of self into destination.
535
revision_id: if not None, the revision history in the new branch will
536
be truncated to end with revision_id.
538
new_history = self.revision_history()
539
if revision_id is not None:
541
new_history = new_history[:new_history.index(revision_id) + 1]
543
rev = self.repository.get_revision(revision_id)
544
new_history = rev.get_history(self.repository)[1:]
545
destination.set_revision_history(new_history)
547
parent = self.get_parent()
548
except errors.InaccessibleParent, e:
549
mutter('parent was not accessible to copy: %s', e)
552
destination.set_parent(parent)
556
"""Check consistency of the branch.
558
In particular this checks that revisions given in the revision-history
559
do actually match up in the revision graph, and that they're all
560
present in the repository.
562
Callers will typically also want to check the repository.
564
:return: A BranchCheckResult.
566
mainline_parent_id = None
567
for revision_id in self.revision_history():
569
revision = self.repository.get_revision(revision_id)
570
except errors.NoSuchRevision, e:
571
raise errors.BzrCheckError("mainline revision {%s} not in repository"
573
# In general the first entry on the revision history has no parents.
574
# But it's not illegal for it to have parents listed; this can happen
575
# in imports from Arch when the parents weren't reachable.
576
if mainline_parent_id is not None:
577
if mainline_parent_id not in revision.parent_ids:
578
raise errors.BzrCheckError("previous revision {%s} not listed among "
580
% (mainline_parent_id, revision_id))
581
mainline_parent_id = revision_id
582
return BranchCheckResult(self)
584
def _get_checkout_format(self):
585
"""Return the most suitable metadir for a checkout of this branch.
586
Weaves are used if this branch's repostory uses weaves.
588
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
589
from bzrlib import repository
590
format = bzrdir.BzrDirMetaFormat1()
591
format.repository_format = repository.RepositoryFormat7()
593
format = self.repository.bzrdir.cloning_metadir()
596
def create_checkout(self, to_location, revision_id=None,
598
"""Create a checkout of a branch.
600
:param to_location: The url to produce the checkout at
601
:param revision_id: The revision to check out
602
:param lightweight: If True, produce a lightweight checkout, otherwise,
603
produce a bound branch (heavyweight checkout)
604
:return: The tree of the created checkout
606
t = transport.get_transport(to_location)
609
except errors.FileExists:
612
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
613
BranchReferenceFormat().initialize(checkout, self)
615
format = self._get_checkout_format()
616
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
617
to_location, force_new_tree=False, format=format)
618
checkout = checkout_branch.bzrdir
619
checkout_branch.bind(self)
620
# pull up to the specified revision_id to set the initial
621
# branch tip correctly, and seed it with history.
622
checkout_branch.pull(self, stop_revision=revision_id)
623
return checkout.create_workingtree(revision_id)
626
class BranchFormat(object):
627
"""An encapsulation of the initialization and open routines for a format.
629
Formats provide three things:
630
* An initialization routine,
634
Formats are placed in an dict by their format string for reference
635
during branch opening. Its not required that these be instances, they
636
can be classes themselves with class methods - it simply depends on
637
whether state is needed for a given format or not.
639
Once a format is deprecated, just deprecate the initialize and open
640
methods on the format class. Do not deprecate the object, as the
641
object will be created every time regardless.
644
_default_format = None
645
"""The default format used for new branches."""
648
"""The known formats."""
651
def find_format(klass, a_bzrdir):
652
"""Return the format for the branch object in a_bzrdir."""
654
transport = a_bzrdir.get_branch_transport(None)
655
format_string = transport.get("format").read()
656
return klass._formats[format_string]
658
raise NotBranchError(path=transport.base)
660
raise errors.UnknownFormatError(format=format_string)
663
def get_default_format(klass):
664
"""Return the current default format."""
665
return klass._default_format
667
def get_format_string(self):
668
"""Return the ASCII format string that identifies this format."""
669
raise NotImplementedError(self.get_format_string)
671
def get_format_description(self):
672
"""Return the short format description for this format."""
673
raise NotImplementedError(self.get_format_string)
675
def initialize(self, a_bzrdir):
676
"""Create a branch of this format in a_bzrdir."""
677
raise NotImplementedError(self.initialize)
679
def is_supported(self):
680
"""Is this format supported?
682
Supported formats can be initialized and opened.
683
Unsupported formats may not support initialization or committing or
684
some other features depending on the reason for not being supported.
688
def open(self, a_bzrdir, _found=False):
689
"""Return the branch object for a_bzrdir
691
_found is a private parameter, do not use it. It is used to indicate
692
if format probing has already be done.
694
raise NotImplementedError(self.open)
697
def register_format(klass, format):
698
klass._formats[format.get_format_string()] = format
701
def set_default_format(klass, format):
702
klass._default_format = format
705
def unregister_format(klass, format):
706
assert klass._formats[format.get_format_string()] is format
707
del klass._formats[format.get_format_string()]
710
return self.get_format_string().rstrip()
713
class BzrBranchFormat4(BranchFormat):
714
"""Bzr branch format 4.
717
- a revision-history file.
718
- a branch-lock lock file [ to be shared with the bzrdir ]
721
def get_format_description(self):
722
"""See BranchFormat.get_format_description()."""
723
return "Branch format 4"
725
def initialize(self, a_bzrdir):
726
"""Create a branch of this format in a_bzrdir."""
727
mutter('creating branch in %s', a_bzrdir.transport.base)
728
branch_transport = a_bzrdir.get_branch_transport(self)
729
utf8_files = [('revision-history', ''),
732
control_files = LockableFiles(branch_transport, 'branch-lock',
734
control_files.create_lock()
735
control_files.lock_write()
737
for file, content in utf8_files:
738
control_files.put_utf8(file, content)
740
control_files.unlock()
741
return self.open(a_bzrdir, _found=True)
744
super(BzrBranchFormat4, self).__init__()
745
self._matchingbzrdir = bzrdir.BzrDirFormat6()
747
def open(self, a_bzrdir, _found=False):
748
"""Return the branch object for a_bzrdir
750
_found is a private parameter, do not use it. It is used to indicate
751
if format probing has already be done.
754
# we are being called directly and must probe.
755
raise NotImplementedError
756
return BzrBranch(_format=self,
757
_control_files=a_bzrdir._control_files,
759
_repository=a_bzrdir.open_repository())
762
return "Bazaar-NG branch format 4"
765
class BzrBranchFormat5(BranchFormat):
766
"""Bzr branch format 5.
769
- a revision-history file.
771
- a lock dir guarding the branch itself
772
- all of this stored in a branch/ subdirectory
773
- works with shared repositories.
775
This format is new in bzr 0.8.
778
def get_format_string(self):
779
"""See BranchFormat.get_format_string()."""
780
return "Bazaar-NG branch format 5\n"
782
def get_format_description(self):
783
"""See BranchFormat.get_format_description()."""
784
return "Branch format 5"
786
def initialize(self, a_bzrdir):
787
"""Create a branch of this format in a_bzrdir."""
788
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
789
branch_transport = a_bzrdir.get_branch_transport(self)
790
utf8_files = [('revision-history', ''),
793
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
794
control_files.create_lock()
795
control_files.lock_write()
796
control_files.put_utf8('format', self.get_format_string())
798
for file, content in utf8_files:
799
control_files.put_utf8(file, content)
801
control_files.unlock()
802
return self.open(a_bzrdir, _found=True, )
805
super(BzrBranchFormat5, self).__init__()
806
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
808
def open(self, a_bzrdir, _found=False):
809
"""Return the branch object for a_bzrdir
811
_found is a private parameter, do not use it. It is used to indicate
812
if format probing has already be done.
815
format = BranchFormat.find_format(a_bzrdir)
816
assert format.__class__ == self.__class__
817
transport = a_bzrdir.get_branch_transport(None)
818
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
819
return BzrBranch5(_format=self,
820
_control_files=control_files,
822
_repository=a_bzrdir.find_repository())
825
return "Bazaar-NG Metadir branch format 5"
828
class BranchReferenceFormat(BranchFormat):
829
"""Bzr branch reference format.
831
Branch references are used in implementing checkouts, they
832
act as an alias to the real branch which is at some other url.
839
def get_format_string(self):
840
"""See BranchFormat.get_format_string()."""
841
return "Bazaar-NG Branch Reference Format 1\n"
843
def get_format_description(self):
844
"""See BranchFormat.get_format_description()."""
845
return "Checkout reference format 1"
847
def initialize(self, a_bzrdir, target_branch=None):
848
"""Create a branch of this format in a_bzrdir."""
849
if target_branch is None:
850
# this format does not implement branch itself, thus the implicit
851
# creation contract must see it as uninitializable
852
raise errors.UninitializableFormat(self)
853
mutter('creating branch reference in %s', a_bzrdir.transport.base)
854
branch_transport = a_bzrdir.get_branch_transport(self)
855
branch_transport.put_bytes('location',
856
target_branch.bzrdir.root_transport.base)
857
branch_transport.put_bytes('format', self.get_format_string())
858
return self.open(a_bzrdir, _found=True)
861
super(BranchReferenceFormat, self).__init__()
862
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
864
def _make_reference_clone_function(format, a_branch):
865
"""Create a clone() routine for a branch dynamically."""
866
def clone(to_bzrdir, revision_id=None):
867
"""See Branch.clone()."""
868
return format.initialize(to_bzrdir, a_branch)
869
# cannot obey revision_id limits when cloning a reference ...
870
# FIXME RBC 20060210 either nuke revision_id for clone, or
871
# emit some sort of warning/error to the caller ?!
874
def open(self, a_bzrdir, _found=False):
875
"""Return the branch that the branch reference in a_bzrdir points at.
877
_found is a private parameter, do not use it. It is used to indicate
878
if format probing has already be done.
881
format = BranchFormat.find_format(a_bzrdir)
882
assert format.__class__ == self.__class__
883
transport = a_bzrdir.get_branch_transport(None)
884
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
885
result = real_bzrdir.open_branch()
886
# this changes the behaviour of result.clone to create a new reference
887
# rather than a copy of the content of the branch.
888
# I did not use a proxy object because that needs much more extensive
889
# testing, and we are only changing one behaviour at the moment.
890
# If we decide to alter more behaviours - i.e. the implicit nickname
891
# then this should be refactored to introduce a tested proxy branch
892
# and a subclass of that for use in overriding clone() and ....
894
result.clone = self._make_reference_clone_function(result)
898
# formats which have no format string are not discoverable
899
# and not independently creatable, so are not registered.
900
__default_format = BzrBranchFormat5()
901
BranchFormat.register_format(__default_format)
902
BranchFormat.register_format(BranchReferenceFormat())
903
BranchFormat.set_default_format(__default_format)
904
_legacy_formats = [BzrBranchFormat4(),
445
907
class BzrBranch(Branch):
446
908
"""A branch stored in the actual filesystem.
563
1003
"""See Branch.abspath."""
564
1004
return self.control_files._transport.abspath(name)
566
def _make_control(self):
567
from bzrlib.inventory import Inventory
568
from bzrlib.weavefile import write_weave_v5
569
from bzrlib.weave import Weave
571
# Create an empty inventory
573
# if we want per-tree root ids then this is the place to set
574
# them; they're not needed for now and so ommitted for
576
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
577
empty_inv = sio.getvalue()
579
bzrlib.weavefile.write_weave_v5(Weave(), sio)
580
empty_weave = sio.getvalue()
582
dirs = ['', 'revision-store', 'weaves']
584
"This is a Bazaar-NG control directory.\n"
585
"Do not change any files in this directory.\n"),
586
('branch-format', BZR_BRANCH_FORMAT_6),
587
('revision-history', ''),
590
('pending-merges', ''),
591
('inventory', empty_inv),
592
('inventory.weave', empty_weave),
594
cfe = self.control_files._escape
595
# FIXME: RBC 20060125 dont peek under the covers
596
self.control_files._transport.mkdir_multi([cfe(d) for d in dirs],
597
mode=self.control_files._dir_mode)
598
self.control_files.lock_write()
600
for file, content in files:
601
self.control_files.put_utf8(file, content)
602
mutter('created control directory in ' + self.base)
604
self.control_files.unlock()
606
def _check_format(self, relax_version_check):
607
"""Check this branch format is supported.
609
The format level is stored, as an integer, in
610
self._branch_format for code that needs to check it later.
612
In the future, we might need different in-memory Branch
613
classes to support downlevel branches. But not yet.
1006
def _check_format(self, format):
1007
"""Identify the branch format if needed.
1009
The format is stored as a reference to the format object in
1010
self._format for code that needs to check it later.
1012
The format parameter is either None or the branch format class
1013
used to open this branch.
1015
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
616
fmt = self.control_files.get_utf8('branch-format').read()
618
raise NotBranchError(path=self.base)
619
mutter("got branch format %r", fmt)
620
if fmt == BZR_BRANCH_FORMAT_6:
621
self._branch_format = 6
622
elif fmt == BZR_BRANCH_FORMAT_5:
623
self._branch_format = 5
624
elif fmt == BZR_BRANCH_FORMAT_4:
625
self._branch_format = 4
627
if (not relax_version_check
628
and self._branch_format not in (5, 6)):
629
raise errors.UnsupportedFormatError(
630
'sorry, branch format %r not supported' % fmt,
631
['use a different bzr version',
632
'or remove the .bzr directory'
633
' and "bzr init" again'])
1018
format = BranchFormat.find_format(self.bzrdir)
1019
self._format = format
1020
mutter("got branch format %s", self._format)
635
1022
@needs_read_lock
636
1023
def get_root_id(self):
637
1024
"""See Branch.get_root_id."""
638
inv = self.repository.get_inventory(self.last_revision())
639
return inv.root.file_id
1025
tree = self.repository.revision_tree(self.last_revision())
1026
return tree.inventory.root.file_id
1028
def is_locked(self):
1029
return self.control_files.is_locked()
641
1031
def lock_write(self):
642
# TODO: test for failed two phase locks. This is known broken.
643
self.control_files.lock_write()
644
1032
self.repository.lock_write()
1034
self.control_files.lock_write()
1036
self.repository.unlock()
646
1039
def lock_read(self):
647
# TODO: test for failed two phase locks. This is known broken.
648
self.control_files.lock_read()
649
1040
self.repository.lock_read()
1042
self.control_files.lock_read()
1044
self.repository.unlock()
651
1047
def unlock(self):
652
1048
# TODO: test for failed two phase locks. This is known broken.
653
self.repository.unlock()
654
self.control_files.unlock()
1050
self.control_files.unlock()
1052
self.repository.unlock()
656
1054
def peek_lock_mode(self):
657
1055
if self.control_files._lock_count == 0:
660
1058
return self.control_files._lock_mode
1060
def get_physical_lock_status(self):
1061
return self.control_files.get_physical_lock_status()
662
1063
@needs_read_lock
663
1064
def print_file(self, file, revision_id):
664
1065
"""See Branch.print_file."""
676
1077
@needs_write_lock
677
1078
def set_revision_history(self, rev_history):
678
1079
"""See Branch.set_revision_history."""
679
old_revision = self.last_revision()
680
new_revision = rev_history[-1]
681
1080
self.control_files.put_utf8(
682
1081
'revision-history', '\n'.join(rev_history))
684
# FIXME: RBC 20051207 this smells wrong, last_revision in the
685
# working tree may be != to last_revision in the branch - so
686
# why is this passing in the branches last_revision ?
687
self.working_tree().set_last_revision(new_revision, old_revision)
688
except NoWorkingTree:
689
mutter('Unable to set_last_revision without a working tree.')
691
def get_revision_delta(self, revno):
692
"""Return the delta for one revision.
694
The delta is relative to its mainline predecessor, or the
695
empty tree for revision 1.
697
assert isinstance(revno, int)
698
rh = self.revision_history()
699
if not (1 <= revno <= len(rh)):
700
raise InvalidRevisionNumber(revno)
702
# revno is 1-based; list is 0-based
704
new_tree = self.repository.revision_tree(rh[revno-1])
706
old_tree = EmptyTree()
1082
transaction = self.get_transaction()
1083
history = transaction.map.find_revision_history()
1084
if history is not None:
1085
# update the revision history in the identity map.
1086
history[:] = list(rev_history)
1087
# this call is disabled because revision_history is
1088
# not really an object yet, and the transaction is for objects.
1089
# transaction.register_dirty(history)
708
old_tree = self.repository.revision_tree(rh[revno-2])
709
return compare_trees(old_tree, new_tree)
1091
transaction.map.add_revision_history(rev_history)
1092
# this call is disabled because revision_history is
1093
# not really an object yet, and the transaction is for objects.
1094
# transaction.register_clean(history)
711
1096
@needs_read_lock
712
1097
def revision_history(self):
713
1098
"""See Branch.revision_history."""
714
# FIXME are transactions bound to control files ? RBC 20051121
715
1099
transaction = self.get_transaction()
716
1100
history = transaction.map.find_revision_history()
717
1101
if history is not None:
718
mutter("cache hit for revision-history in %s", self)
1102
# mutter("cache hit for revision-history in %s", self)
719
1103
return list(history)
720
history = [l.rstrip('\r\n') for l in
721
self.control_files.get_utf8('revision-history').readlines()]
1104
decode_utf8 = cache_utf8.decode
1105
history = [decode_utf8(l.rstrip('\r\n')) for l in
1106
self.control_files.get('revision-history').readlines()]
722
1107
transaction.map.add_revision_history(history)
723
1108
# this call is disabled because revision_history is
724
1109
# not really an object yet, and the transaction is for objects.
725
1110
# transaction.register_clean(history, precious=True)
726
1111
return list(history)
1114
def generate_revision_history(self, revision_id, last_rev=None,
1116
"""Create a new revision history that will finish with revision_id.
1118
:param revision_id: the new tip to use.
1119
:param last_rev: The previous last_revision. If not None, then this
1120
must be a ancestory of revision_id, or DivergedBranches is raised.
1121
:param other_branch: The other branch that DivergedBranches should
1122
raise with respect to.
1124
# stop_revision must be a descendant of last_revision
1125
stop_graph = self.repository.get_revision_graph(revision_id)
1126
if last_rev is not None and last_rev not in stop_graph:
1127
# our previous tip is not merged into stop_revision
1128
raise errors.DivergedBranches(self, other_branch)
1129
# make a new revision history from the graph
1130
current_rev_id = revision_id
1132
while current_rev_id not in (None, revision.NULL_REVISION):
1133
new_history.append(current_rev_id)
1134
current_rev_id_parents = stop_graph[current_rev_id]
1136
current_rev_id = current_rev_id_parents[0]
1138
current_rev_id = None
1139
new_history.reverse()
1140
self.set_revision_history(new_history)
728
1143
def update_revisions(self, other, stop_revision=None):
729
1144
"""See Branch.update_revisions."""
730
from bzrlib.fetch import greedy_fetch
731
if stop_revision is None:
732
stop_revision = other.last_revision()
733
### Should this be checking is_ancestor instead of revision_history?
734
if (stop_revision is not None and
735
stop_revision in self.revision_history()):
737
greedy_fetch(to_branch=self, from_branch=other,
738
revision=stop_revision)
739
pullable_revs = self.pullable_revisions(other, stop_revision)
740
if len(pullable_revs) > 0:
741
self.append_revision(*pullable_revs)
1147
if stop_revision is None:
1148
stop_revision = other.last_revision()
1149
if stop_revision is None:
1150
# if there are no commits, we're done.
1152
# whats the current last revision, before we fetch [and change it
1154
last_rev = self.last_revision()
1155
# we fetch here regardless of whether we need to so that we pickup
1157
self.fetch(other, stop_revision)
1158
my_ancestry = self.repository.get_ancestry(last_rev)
1159
if stop_revision in my_ancestry:
1160
# last_revision is a descendant of stop_revision
1162
self.generate_revision_history(stop_revision, last_rev=last_rev,
743
def pullable_revisions(self, other, stop_revision):
744
"""See Branch.pullable_revisions."""
745
other_revno = other.revision_id_to_revno(stop_revision)
747
return self.missing_revisions(other, other_revno)
748
except DivergedBranches, e:
750
pullable_revs = get_intervening_revisions(self.last_revision(),
753
assert self.last_revision() not in pullable_revs
755
except bzrlib.errors.NotAncestor:
756
if is_ancestor(self.last_revision(), stop_revision, self):
761
1167
def basis_tree(self):
762
1168
"""See Branch.basis_tree."""
764
revision_id = self.revision_history()[-1]
765
# FIXME: This is an abstraction violation, the basis tree
766
# here as defined is on the working tree, the method should
767
# be too. The basis tree for a branch can be different than
768
# that for a working tree. RBC 20051207
769
xml = self.working_tree().read_basis_inventory(revision_id)
770
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
771
return RevisionTree(self.repository, inv, revision_id)
772
except (IndexError, NoSuchFile, NoWorkingTree), e:
773
return self.repository.revision_tree(self.last_revision())
1169
return self.repository.revision_tree(self.last_revision())
1171
@deprecated_method(zero_eight)
775
1172
def working_tree(self):
776
"""See Branch.working_tree."""
777
from bzrlib.workingtree import WorkingTree
778
if self.base.find('://') != -1:
1173
"""Create a Working tree object for this branch."""
1175
from bzrlib.transport.local import LocalTransport
1176
if (self.base.find('://') != -1 or
1177
not isinstance(self._transport, LocalTransport)):
779
1178
raise NoWorkingTree(self.base)
780
return WorkingTree(self.base, branch=self)
1179
return self.bzrdir.open_workingtree()
782
1181
@needs_write_lock
783
def pull(self, source, overwrite=False):
1182
def pull(self, source, overwrite=False, stop_revision=None):
784
1183
"""See Branch.pull."""
785
1184
source.lock_read()
787
1186
old_count = len(self.revision_history())
789
self.update_revisions(source)
1188
self.update_revisions(source, stop_revision)
790
1189
except DivergedBranches:
791
1190
if not overwrite:
827
1234
# FIXUP this and get_parent in a future branch format bump:
828
1235
# read and rewrite the file, and have the new format code read
829
1236
# using .get not .get_utf8. RBC 20060125
830
self.control_files.put_utf8('parent', url + '\n')
1238
self.control_files._transport.delete('parent')
1240
if isinstance(url, unicode):
1242
url = url.encode('ascii')
1243
except UnicodeEncodeError:
1244
raise bzrlib.errors.InvalidURL(url,
1245
"Urls must be 7-bit ascii, "
1246
"use bzrlib.urlutils.escape")
1248
url = urlutils.relative_url(self.base, url)
1249
self.control_files.put('parent', StringIO(url + '\n'))
1251
@deprecated_function(zero_nine)
832
1252
def tree_config(self):
1253
"""DEPRECATED; call get_config instead.
1254
TreeConfig has become part of BranchConfig."""
833
1255
return TreeConfig(self)
835
def _get_truncated_history(self, revision_id):
836
history = self.revision_history()
837
if revision_id is None:
1258
class BzrBranch5(BzrBranch):
1259
"""A format 5 branch. This supports new features over plan branches.
1261
It has support for a master_branch which is the data for bound branches.
1269
super(BzrBranch5, self).__init__(_format=_format,
1270
_control_files=_control_files,
1272
_repository=_repository)
1275
def pull(self, source, overwrite=False, stop_revision=None):
1276
"""Updates branch.pull to be bound branch aware."""
1277
bound_location = self.get_bound_location()
1278
if source.base != bound_location:
1279
# not pulling from master, so we need to update master.
1280
master_branch = self.get_master_branch()
1282
master_branch.pull(source)
1283
source = master_branch
1284
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1286
def get_bound_location(self):
840
idx = history.index(revision_id)
842
raise InvalidRevisionId(revision_id=revision, branch=self)
843
return history[:idx+1]
1288
return self.control_files.get_utf8('bound').read()[:-1]
1289
except errors.NoSuchFile:
845
1292
@needs_read_lock
846
def _clone_weave(self, to_location, revision=None, basis_branch=None):
847
assert isinstance(to_location, basestring)
848
if basis_branch is not None:
849
note("basis_branch is not supported for fast weave copy yet.")
851
history = self._get_truncated_history(revision)
852
if not bzrlib.osutils.lexists(to_location):
853
os.mkdir(to_location)
854
branch_to = Branch.initialize(to_location)
855
mutter("copy branch from %s to %s", self, branch_to)
856
branch_to.working_tree().set_root_id(self.get_root_id())
858
self.repository.copy(branch_to.repository)
1293
def get_master_branch(self):
1294
"""Return the branch we are bound to.
860
# must be done *after* history is copied across
861
# FIXME duplicate code with base .clone().
862
# .. would template method be useful here. RBC 20051207
863
branch_to.set_parent(self.base)
864
branch_to.append_revision(*history)
865
# circular import protection
866
from bzrlib.merge import build_working_dir
867
build_working_dir(to_location)
871
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
872
if to_branch_type is None:
873
to_branch_type = BzrBranch
875
if to_branch_type == BzrBranch \
876
and self.repository.weave_store.listable() \
877
and self.repository.revision_store.listable():
878
return self._clone_weave(to_location, revision, basis_branch)
880
return Branch.clone(self, to_location, revision, basis_branch, to_branch_type)
882
def fileid_involved_between_revs(self, from_revid, to_revid):
883
"""Find file_id(s) which are involved in the changes between revisions.
885
This determines the set of revisions which are involved, and then
886
finds all file ids affected by those revisions.
888
# TODO: jam 20060119 This code assumes that w.inclusions will
889
# always be correct. But because of the presence of ghosts
890
# it is possible to be wrong.
891
# One specific example from Robert Collins:
892
# Two branches, with revisions ABC, and AD
893
# C is a ghost merge of D.
894
# Inclusions doesn't recognize D as an ancestor.
895
# If D is ever merged in the future, the weave
896
# won't be fixed, because AD never saw revision C
897
# to cause a conflict which would force a reweave.
898
w = self.repository.get_inventory_weave()
899
from_set = set(w.inclusions([w.lookup(from_revid)]))
900
to_set = set(w.inclusions([w.lookup(to_revid)]))
901
included = to_set.difference(from_set)
902
changed = map(w.idx_to_name, included)
903
return self._fileid_involved_by_set(changed)
905
def fileid_involved(self, last_revid=None):
906
"""Find all file_ids modified in the ancestry of last_revid.
908
:param last_revid: If None, last_revision() will be used.
910
w = self.repository.get_inventory_weave()
912
changed = set(w._names)
1296
:return: Either a Branch, or None
1298
This could memoise the branch, but if thats done
1299
it must be revalidated on each new lock.
1300
So for now we just don't memoise it.
1301
# RBC 20060304 review this decision.
1303
bound_loc = self.get_bound_location()
1307
return Branch.open(bound_loc)
1308
except (errors.NotBranchError, errors.ConnectionError), e:
1309
raise errors.BoundBranchConnectionFailure(
1313
def set_bound_location(self, location):
1314
"""Set the target where this branch is bound to.
1316
:param location: URL to the target branch
1319
self.control_files.put_utf8('bound', location+'\n')
914
included = w.inclusions([w.lookup(last_revid)])
915
changed = map(w.idx_to_name, included)
916
return self._fileid_involved_by_set(changed)
918
def fileid_involved_by_set(self, changes):
919
"""Find all file_ids modified by the set of revisions passed in.
921
:param changes: A set() of revision ids
923
# TODO: jam 20060119 This line does *nothing*, remove it.
924
# or better yet, change _fileid_involved_by_set so
925
# that it takes the inventory weave, rather than
926
# pulling it out by itself.
927
w = self.repository.get_inventory_weave()
928
return self._fileid_involved_by_set(changes)
930
def _fileid_involved_by_set(self, changes):
931
"""Find the set of file-ids affected by the set of revisions.
933
:param changes: A set() of revision ids.
934
:return: A set() of file ids.
1322
self.control_files._transport.delete('bound')
1328
def bind(self, other):
1329
"""Bind this branch to the branch other.
1331
This does not push or pull data between the branches, though it does
1332
check for divergence to raise an error when the branches are not
1333
either the same, or one a prefix of the other. That behaviour may not
1334
be useful, so that check may be removed in future.
936
This peaks at the Weave, interpreting each line, looking to
937
see if it mentions one of the revisions. And if so, includes
938
the file id mentioned.
939
This expects both the Weave format, and the serialization
940
to have a single line per file/directory, and to have
941
fileid="" and revision="" on that line.
943
assert self._branch_format in (5, 6), \
944
"fileid_involved only supported for branches which store inventory as xml"
946
w = self.repository.get_inventory_weave()
948
for line in w._weave:
950
# it is ugly, but it is due to the weave structure
951
if not isinstance(line, basestring): continue
953
start = line.find('file_id="')+9
954
if start < 9: continue
955
end = line.find('"', start)
957
file_id = xml.sax.saxutils.unescape(line[start:end])
959
# check if file_id is already present
960
if file_id in file_ids: continue
962
start = line.find('revision="')+10
963
if start < 10: continue
964
end = line.find('"', start)
966
revision_id = xml.sax.saxutils.unescape(line[start:end])
968
if revision_id in changes:
969
file_ids.add(file_id)
974
class ScratchBranch(BzrBranch):
975
"""Special test class: a branch that cleans up after itself.
977
>>> b = ScratchBranch()
981
>>> b._transport.__del__()
1336
:param other: The branch to bind to
1339
# TODO: jam 20051230 Consider checking if the target is bound
1340
# It is debatable whether you should be able to bind to
1341
# a branch which is itself bound.
1342
# Committing is obviously forbidden,
1343
# but binding itself may not be.
1344
# Since we *have* to check at commit time, we don't
1345
# *need* to check here
1347
# we want to raise diverged if:
1348
# last_rev is not in the other_last_rev history, AND
1349
# other_last_rev is not in our history, and do it without pulling
1351
last_rev = self.last_revision()
1352
if last_rev is not None:
1355
other_last_rev = other.last_revision()
1356
if other_last_rev is not None:
1357
# neither branch is new, we have to do some work to
1358
# ascertain diversion.
1359
remote_graph = other.repository.get_revision_graph(
1361
local_graph = self.repository.get_revision_graph(last_rev)
1362
if (last_rev not in remote_graph and
1363
other_last_rev not in local_graph):
1364
raise errors.DivergedBranches(self, other)
1367
self.set_bound_location(other.base)
1371
"""If bound, unbind"""
1372
return self.set_bound_location(None)
1376
"""Synchronise this branch with the master branch if any.
1378
:return: None or the last_revision that was pivoted out during the
1381
master = self.get_master_branch()
1382
if master is not None:
1383
old_tip = self.last_revision()
1384
self.pull(master, overwrite=True)
1385
if old_tip in self.repository.get_ancestry(self.last_revision()):
1391
class BranchTestProviderAdapter(object):
1392
"""A tool to generate a suite testing multiple branch formats at once.
1394
This is done by copying the test once for each transport and injecting
1395
the transport_server, transport_readonly_server, and branch_format
1396
classes into each copy. Each copy is also given a new id() to make it
986
def __init__(self, files=[], dirs=[], transport=None):
987
"""Make a test branch.
989
This creates a temporary directory and runs init-tree in it.
991
If any files are listed, they are created in the working copy.
993
if transport is None:
994
transport = bzrlib.transport.local.ScratchTransport()
995
super(ScratchBranch, self).__init__(transport, init=True)
997
super(ScratchBranch, self).__init__(transport)
999
# BzrBranch creates a clone to .bzr and then forgets about the
1000
# original transport. A ScratchTransport() deletes itself and
1001
# everything underneath it when it goes away, so we need to
1002
# grab a local copy to prevent that from happening
1003
self._transport = transport
1006
self._transport.mkdir(d)
1009
self._transport.put(f, 'content of %s' % f)
1013
>>> orig = ScratchBranch(files=["file1", "file2"])
1014
>>> os.listdir(orig.base)
1015
[u'.bzr', u'file1', u'file2']
1016
>>> clone = orig.clone()
1017
>>> if os.name != 'nt':
1018
... os.path.samefile(orig.base, clone.base)
1020
... orig.base == clone.base
1023
>>> os.listdir(clone.base)
1024
[u'.bzr', u'file1', u'file2']
1026
from shutil import copytree
1027
from bzrlib.osutils import mkdtemp
1030
copytree(self.base, base, symlinks=True)
1031
return ScratchBranch(
1032
transport=bzrlib.transport.local.ScratchTransport(base))
1400
def __init__(self, transport_server, transport_readonly_server, formats):
1401
self._transport_server = transport_server
1402
self._transport_readonly_server = transport_readonly_server
1403
self._formats = formats
1405
def adapt(self, test):
1406
result = TestSuite()
1407
for branch_format, bzrdir_format in self._formats:
1408
new_test = deepcopy(test)
1409
new_test.transport_server = self._transport_server
1410
new_test.transport_readonly_server = self._transport_readonly_server
1411
new_test.bzrdir_format = bzrdir_format
1412
new_test.branch_format = branch_format
1413
def make_new_test_id():
1414
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1415
return lambda: new_id
1416
new_test.id = make_new_test_id()
1417
result.addTest(new_test)
1421
class BranchCheckResult(object):
1422
"""Results of checking branch consistency.
1427
def __init__(self, branch):
1428
self.branch = branch
1430
def report_results(self, verbose):
1431
"""Report the check results via trace.note.
1433
:param verbose: Requests more detailed display of what was checked,
1436
note('checked branch %s format %s',
1438
self.branch._format)
1035
1441
######################################################################
1039
def is_control_file(filename):
1040
## FIXME: better check
1041
filename = normpath(filename)
1042
while filename != '':
1043
head, tail = os.path.split(filename)
1044
## mutter('check %r for control file' % ((head, tail),))
1045
if tail == bzrlib.BZRDIR:
1047
if filename == head:
1445
@deprecated_function(zero_eight)
1446
def is_control_file(*args, **kwargs):
1447
"""See bzrlib.workingtree.is_control_file."""
1448
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
