86
157
"""Branch holding a history of revisions.
89
Base directory/url of the branch.
91
hooks: An instance of BranchHooks.
160
Base directory of the branch.
166
If _lock_mode is true, a positive count of the number of times the
170
Lock object from bzrlib.lock.
93
# this is really an instance variable - FIXME move it there
97
# override this to set the strategy for storing tags
99
return DisabledTags(self)
101
def __init__(self, *ignored, **ignored_too):
102
self.tags = self._make_tags()
103
self._revision_history_cache = None
104
self._revision_id_to_revno_cache = None
106
def break_lock(self):
107
"""Break a lock if one is present from another instance.
109
Uses the ui factory to ask for confirmation if the lock may be from
112
This will probe the repository for its lock as well.
114
self.control_files.break_lock()
115
self.repository.break_lock()
116
master = self.get_master_branch()
117
if master is not None:
121
@deprecated_method(zero_eight)
122
def open_downlevel(base):
123
"""Open a branch which may be of an old format."""
124
return Branch.open(base, _unsupported=True)
127
def open(base, _unsupported=False):
128
"""Open the branch rooted at base.
130
For instance, if the branch is at URL/.bzr/branch,
131
Branch.open(URL) -> a Branch instance.
133
control = bzrdir.BzrDir.open(base, _unsupported)
134
return control.open_branch(_unsupported)
137
def open_containing(url):
138
"""Open an existing branch which contains url.
140
This probes for a branch at url, and searches upwards from there.
142
Basically we keep looking up until we find the control directory or
143
run into the root. If there isn't one, raises NotBranchError.
144
If there is one and it is either an unrecognised format or an unsupported
145
format, UnknownFormatError or UnsupportedFormatError are raised.
146
If there is one, it is returned, along with the unused portion of url.
148
control, relpath = bzrdir.BzrDir.open_containing(url)
149
return control.open_branch(), relpath
152
@deprecated_function(zero_eight)
153
def initialize(base):
154
"""Create a new working tree and branch, rooted at 'base' (url)
156
NOTE: This will soon be deprecated in favour of creation
159
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
161
@deprecated_function(zero_eight)
162
def setup_caching(self, cache_root):
163
"""Subclasses that care about caching should override this, and set
164
up cached stores located under cache_root.
166
NOTE: This is unused.
170
def get_config(self):
171
return BranchConfig(self)
174
return self.get_config().get_nickname()
176
def _set_nick(self, nick):
177
self.get_config().set_user_option('nickname', nick)
179
nick = property(_get_nick, _set_nick)
182
raise NotImplementedError(self.is_locked)
176
_inventory_weave = None
178
# Map some sort of prefix into a namespace
179
# stuff like "revno:10", "revid:", etc.
180
# This should match a prefix with a function which accepts
181
REVISION_NAMESPACES = {}
183
def __init__(self, base, init=False, find_root=True,
184
relax_version_check=False):
185
"""Create new branch object at a particular location.
187
base -- Base directory for the branch.
189
init -- If True, create new control files in a previously
190
unversioned directory. If False, the branch must already
193
find_root -- If true and init is false, find the root of the
194
existing branch containing base.
196
relax_version_check -- If true, the usual check for the branch
197
version is not applied. This is intended only for
198
upgrade/recovery type use; it's not guaranteed that
199
all operations will work on old format branches.
201
In the test suite, creation of new trees is tested using the
202
`ScratchBranch` class.
205
self.base = os.path.realpath(base)
208
self.base = find_branch_root(base)
210
self.base = os.path.realpath(base)
211
if not isdir(self.controlfilename('.')):
212
raise NotBranchError('not a bzr branch: %s' % quotefn(base),
213
['use "bzr init" to initialize a '
216
self._check_format(relax_version_check)
217
if self._branch_format == 4:
218
self.inventory_store = \
219
ImmutableStore(self.controlfilename('inventory-store'))
221
ImmutableStore(self.controlfilename('text-store'))
222
self.weave_store = WeaveStore(self.controlfilename('weaves'))
223
self.revision_store = \
224
ImmutableStore(self.controlfilename('revision-store'))
228
return '%s(%r)' % (self.__class__.__name__, self.base)
235
if self._lock_mode or self._lock:
236
from warnings import warn
237
warn("branch %r was not explicitly unlocked" % self)
184
241
def lock_write(self):
185
raise NotImplementedError(self.lock_write)
243
if self._lock_mode != 'w':
244
raise LockError("can't upgrade to a write lock from %r" %
246
self._lock_count += 1
248
from bzrlib.lock import WriteLock
250
self._lock = WriteLock(self.controlfilename('branch-lock'))
251
self._lock_mode = 'w'
187
255
def lock_read(self):
188
raise NotImplementedError(self.lock_read)
257
assert self._lock_mode in ('r', 'w'), \
258
"invalid lock mode %r" % self._lock_mode
259
self._lock_count += 1
261
from bzrlib.lock import ReadLock
263
self._lock = ReadLock(self.controlfilename('branch-lock'))
264
self._lock_mode = 'r'
190
267
def unlock(self):
191
raise NotImplementedError(self.unlock)
193
def peek_lock_mode(self):
194
"""Return lock mode for the Branch: 'r', 'w' or None"""
195
raise NotImplementedError(self.peek_lock_mode)
197
def get_physical_lock_status(self):
198
raise NotImplementedError(self.get_physical_lock_status)
201
def get_revision_id_to_revno_map(self):
202
"""Return the revision_id => dotted revno map.
204
This will be regenerated on demand, but will be cached.
206
:return: A dictionary mapping revision_id => dotted revno.
207
This dictionary should not be modified by the caller.
209
if self._revision_id_to_revno_cache is not None:
210
mapping = self._revision_id_to_revno_cache
268
if not self._lock_mode:
269
raise LockError('branch %r is not locked' % (self))
271
if self._lock_count > 1:
272
self._lock_count -= 1
212
mapping = self._gen_revno_map()
213
self._cache_revision_id_to_revno(mapping)
214
# TODO: jam 20070417 Since this is being cached, should we be returning
216
# I would rather not, and instead just declare that users should not
217
# modify the return value.
220
def _gen_revno_map(self):
221
"""Create a new mapping from revision ids to dotted revnos.
223
Dotted revnos are generated based on the current tip in the revision
225
This is the worker function for get_revision_id_to_revno_map, which
226
just caches the return value.
228
:return: A dictionary mapping revision_id => dotted revno.
230
last_revision = self.last_revision()
231
revision_graph = self.repository.get_revision_graph(last_revision)
232
merge_sorted_revisions = tsort.merge_sort(
237
revision_id_to_revno = dict((rev_id, revno)
238
for seq_num, rev_id, depth, revno, end_of_merge
239
in merge_sorted_revisions)
240
return revision_id_to_revno
242
def leave_lock_in_place(self):
243
"""Tell this branch object not to release the physical lock when this
246
If lock_write doesn't return a token, then this method is not supported.
248
self.control_files.leave_in_place()
250
def dont_leave_lock_in_place(self):
251
"""Tell this branch object to release the physical lock when this
252
object is unlocked, even if it didn't originally acquire it.
254
If lock_write doesn't return a token, then this method is not supported.
256
self.control_files.dont_leave_in_place()
276
self._lock_mode = self._lock_count = None
258
278
def abspath(self, name):
259
"""Return absolute filename for something in the branch
261
XXX: Robert Collins 20051017 what is this used for? why is it a branch
262
method and not a tree method.
264
raise NotImplementedError(self.abspath)
266
def bind(self, other):
267
"""Bind the local branch the other branch.
269
:param other: The branch to bind to
272
raise errors.UpgradeRequired(self.base)
275
def fetch(self, from_branch, last_revision=None, pb=None):
276
"""Copy revisions from from_branch into this branch.
278
:param from_branch: Where to copy from.
279
:param last_revision: What revision to stop at (None for at the end
281
:param pb: An optional progress bar to use.
283
Returns the copied revision count and the failed revisions in a tuple:
286
if self.base == from_branch.base:
289
nested_pb = ui.ui_factory.nested_progress_bar()
294
from_branch.lock_read()
296
if last_revision is None:
297
pb.update('get source history')
298
last_revision = from_branch.last_revision()
299
if last_revision is None:
300
last_revision = _mod_revision.NULL_REVISION
301
return self.repository.fetch(from_branch.repository,
302
revision_id=last_revision,
305
if nested_pb is not None:
309
def get_bound_location(self):
310
"""Return the URL of the branch we are bound to.
312
Older format branches cannot bind, please be sure to use a metadir
317
def get_old_bound_location(self):
318
"""Return the URL of the branch we used to be bound to
320
raise errors.UpgradeRequired(self.base)
322
def get_commit_builder(self, parents, config=None, timestamp=None,
323
timezone=None, committer=None, revprops=None,
325
"""Obtain a CommitBuilder for this branch.
327
:param parents: Revision ids of the parents of the new revision.
328
:param config: Optional configuration to use.
329
:param timestamp: Optional timestamp recorded for commit.
330
:param timezone: Optional timezone for timestamp.
331
:param committer: Optional committer to set for commit.
332
:param revprops: Optional dictionary of revision properties.
333
:param revision_id: Optional revision id.
337
config = self.get_config()
339
return self.repository.get_commit_builder(self, parents, config,
340
timestamp, timezone, committer, revprops, revision_id)
342
def get_master_branch(self):
343
"""Return the branch we are bound to.
345
:return: Either a Branch, or None
279
"""Return absolute filename for something in the branch"""
280
return os.path.join(self.base, name)
282
def relpath(self, path):
283
"""Return path relative to this branch of something inside it.
285
Raises an error if path is not in this branch."""
286
return _relpath(self.base, path)
288
def controlfilename(self, file_or_path):
289
"""Return location relative to branch."""
290
if isinstance(file_or_path, basestring):
291
file_or_path = [file_or_path]
292
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
295
def controlfile(self, file_or_path, mode='r'):
296
"""Open a control file for this branch.
298
There are two classes of file in the control directory: text
299
and binary. binary files are untranslated byte streams. Text
300
control files are stored with Unix newlines and in UTF-8, even
301
if the platform or locale defaults are different.
303
Controlfiles should almost never be opened in write mode but
304
rather should be atomically copied and replaced using atomicfile.
307
fn = self.controlfilename(file_or_path)
309
if mode == 'rb' or mode == 'wb':
310
return file(fn, mode)
311
elif mode == 'r' or mode == 'w':
312
# open in binary mode anyhow so there's no newline translation;
313
# codecs uses line buffering by default; don't want that.
315
return codecs.open(fn, mode + 'b', 'utf-8',
318
raise BzrError("invalid controlfile mode %r" % mode)
320
def _make_control(self):
321
os.mkdir(self.controlfilename([]))
322
self.controlfile('README', 'w').write(
323
"This is a Bazaar-NG control directory.\n"
324
"Do not change any files in this directory.\n")
325
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
326
for d in ('text-store', 'revision-store',
328
os.mkdir(self.controlfilename(d))
329
for f in ('revision-history', 'merged-patches',
330
'pending-merged-patches', 'branch-name',
333
self.controlfile(f, 'w').write('')
334
mutter('created control directory in ' + self.base)
336
# if we want per-tree root ids then this is the place to set
337
# them; they're not needed for now and so ommitted for
339
f = self.controlfile('inventory','w')
340
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
344
def _check_format(self, relax_version_check):
345
"""Check this branch format is supported.
347
The format level is stored, as an integer, in
348
self._branch_format for code that needs to check it later.
350
In the future, we might need different in-memory Branch
351
classes to support downlevel branches. But not yet.
353
fmt = self.controlfile('branch-format', 'r').read()
354
if fmt == BZR_BRANCH_FORMAT_5:
355
self._branch_format = 5
356
elif fmt == BZR_BRANCH_FORMAT_4:
357
self._branch_format = 4
359
if (not relax_version_check
360
and self._branch_format != 5):
361
raise BzrError('sorry, branch format "%s" not supported; '
362
'use a different bzr version, '
363
'or run "bzr upgrade"'
364
% fmt.rstrip('\n\r'))
367
def get_root_id(self):
368
"""Return the id of this branches root"""
369
inv = self.read_working_inventory()
370
return inv.root.file_id
372
def set_root_id(self, file_id):
373
inv = self.read_working_inventory()
374
orig_root_id = inv.root.file_id
375
del inv._byid[inv.root.file_id]
376
inv.root.file_id = file_id
377
inv._byid[inv.root.file_id] = inv.root
380
if entry.parent_id in (None, orig_root_id):
381
entry.parent_id = inv.root.file_id
382
self._write_inventory(inv)
384
def read_working_inventory(self):
385
"""Read the working inventory."""
388
# ElementTree does its own conversion from UTF-8, so open in
390
f = self.controlfile('inventory', 'rb')
391
return bzrlib.xml5.serializer_v5.read_inventory(f)
396
def _write_inventory(self, inv):
397
"""Update the working inventory.
399
That is to say, the inventory describing changes underway, that
400
will be committed to the next revision.
402
from bzrlib.atomicfile import AtomicFile
406
f = AtomicFile(self.controlfilename('inventory'), 'wb')
408
bzrlib.xml5.serializer_v5.write_inventory(inv, f)
415
mutter('wrote working inventory')
418
inventory = property(read_working_inventory, _write_inventory, None,
419
"""Inventory for the working copy.""")
422
def add(self, files, ids=None):
423
"""Make files versioned.
425
Note that the command line normally calls smart_add instead,
426
which can automatically recurse.
428
This puts the files in the Added state, so that they will be
429
recorded by the next commit.
432
List of paths to add, relative to the base of the tree.
435
If set, use these instead of automatically generated ids.
436
Must be the same length as the list of files, but may
437
contain None for ids that are to be autogenerated.
439
TODO: Perhaps have an option to add the ids even if the files do
442
TODO: Perhaps yield the ids and paths as they're added.
444
# TODO: Re-adding a file that is removed in the working copy
445
# should probably put it back with the previous ID.
446
if isinstance(files, basestring):
447
assert(ids is None or isinstance(ids, basestring))
453
ids = [None] * len(files)
455
assert(len(ids) == len(files))
459
inv = self.read_working_inventory()
460
for f,file_id in zip(files, ids):
461
if is_control_file(f):
462
raise BzrError("cannot add control file %s" % quotefn(f))
467
raise BzrError("cannot add top-level %r" % f)
469
fullpath = os.path.normpath(self.abspath(f))
472
kind = file_kind(fullpath)
474
# maybe something better?
475
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
477
if kind != 'file' and kind != 'directory':
478
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
481
file_id = gen_file_id(f)
482
inv.add_path(f, kind=kind, file_id=file_id)
484
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
486
self._write_inventory(inv)
491
def print_file(self, file, revno):
492
"""Print `file` to stdout."""
495
tree = self.revision_tree(self.lookup_revision(revno))
496
# use inventory as it was in that revision
497
file_id = tree.inventory.path2id(file)
499
raise BzrError("%r is not present in revision %s" % (file, revno))
500
tree.print_file(file_id)
505
def remove(self, files, verbose=False):
506
"""Mark nominated files for removal from the inventory.
508
This does not remove their text. This does not run on
510
TODO: Refuse to remove modified files unless --force is given?
512
TODO: Do something useful with directories.
514
TODO: Should this remove the text or not? Tough call; not
515
removing may be useful and the user can just use use rm, and
516
is the opposite of add. Removing it is consistent with most
517
other tools. Maybe an option.
519
## TODO: Normalize names
520
## TODO: Remove nested loops; better scalability
521
if isinstance(files, basestring):
527
tree = self.working_tree()
530
# do this before any modifications
534
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
535
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
537
# having remove it, it must be either ignored or unknown
538
if tree.is_ignored(f):
542
show_status(new_status, inv[fid].kind, quotefn(f))
545
self._write_inventory(inv)
550
# FIXME: this doesn't need to be a branch method
551
def set_inventory(self, new_inventory_list):
552
from bzrlib.inventory import Inventory, InventoryEntry
553
inv = Inventory(self.get_root_id())
554
for path, file_id, parent, kind in new_inventory_list:
555
name = os.path.basename(path)
558
inv.add(InventoryEntry(file_id, name, kind, parent))
559
self._write_inventory(inv)
563
"""Return all unknown files.
565
These are files in the working directory that are not versioned or
566
control files or ignored.
568
>>> b = ScratchBranch(files=['foo', 'foo~'])
569
>>> list(b.unknowns())
572
>>> list(b.unknowns())
575
>>> list(b.unknowns())
578
return self.working_tree().unknowns()
581
def append_revision(self, *revision_ids):
582
from bzrlib.atomicfile import AtomicFile
584
for revision_id in revision_ids:
585
mutter("add {%s} to revision-history" % revision_id)
587
rev_history = self.revision_history()
588
rev_history.extend(revision_ids)
590
f = AtomicFile(self.controlfilename('revision-history'))
592
for rev_id in rev_history:
599
def has_revision(self, revision_id):
600
"""True if this branch has a copy of the revision.
602
This does not necessarily imply the revision is merge
603
or on the mainline."""
604
return revision_id in self.revision_store
607
def get_revision_xml_file(self, revision_id):
608
"""Return XML file object for revision object."""
609
if not revision_id or not isinstance(revision_id, basestring):
610
raise InvalidRevisionId(revision_id)
615
return self.revision_store[revision_id]
617
raise bzrlib.errors.NoSuchRevision(self, revision_id)
622
def get_revision_xml(self, revision_id):
623
return self.get_revision_xml_file(revision_id).read()
626
def get_revision(self, revision_id):
627
"""Return the Revision object for a named revision"""
628
xml_file = self.get_revision_xml_file(revision_id)
631
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
632
except SyntaxError, e:
633
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
637
assert r.revision_id == revision_id
349
641
def get_revision_delta(self, revno):
350
642
"""Return the delta for one revision.
666
1344
if revno < 1 or revno > self.revno():
667
1345
raise InvalidRevisionNumber(revno)
670
def clone(self, to_bzrdir, revision_id=None):
671
"""Clone this branch into to_bzrdir preserving all semantic values.
673
revision_id: if not None, the revision history in the new branch will
674
be truncated to end with revision_id.
676
result = self._format.initialize(to_bzrdir)
677
self.copy_content_into(result, revision_id=revision_id)
681
def sprout(self, to_bzrdir, revision_id=None):
682
"""Create a new line of development from the branch, into to_bzrdir.
684
revision_id: if not None, the revision history in the new branch will
685
be truncated to end with revision_id.
687
result = self._format.initialize(to_bzrdir)
688
self.copy_content_into(result, revision_id=revision_id)
689
result.set_parent(self.bzrdir.root_transport.base)
692
def _synchronize_history(self, destination, revision_id):
693
"""Synchronize last revision and revision history between branches.
695
This version is most efficient when the destination is also a
696
BzrBranch5, but works for BzrBranch6 as long as the revision
697
history is the true lefthand parent history, and all of the revisions
698
are in the destination's repository. If not, set_revision_history
701
:param destination: The branch to copy the history into
702
:param revision_id: The revision-id to truncate history at. May
703
be None to copy complete history.
705
new_history = self.revision_history()
706
if revision_id is not None:
707
revision_id = osutils.safe_revision_id(revision_id)
709
new_history = new_history[:new_history.index(revision_id) + 1]
711
rev = self.repository.get_revision(revision_id)
712
new_history = rev.get_history(self.repository)[1:]
713
destination.set_revision_history(new_history)
716
def copy_content_into(self, destination, revision_id=None):
717
"""Copy the content of self into destination.
719
revision_id: if not None, the revision history in the new branch will
720
be truncated to end with revision_id.
722
self._synchronize_history(destination, revision_id)
724
parent = self.get_parent()
725
except errors.InaccessibleParent, e:
726
mutter('parent was not accessible to copy: %s', e)
729
destination.set_parent(parent)
730
self.tags.merge_to(destination.tags)
734
"""Check consistency of the branch.
736
In particular this checks that revisions given in the revision-history
737
do actually match up in the revision graph, and that they're all
738
present in the repository.
740
Callers will typically also want to check the repository.
742
:return: A BranchCheckResult.
744
mainline_parent_id = None
745
for revision_id in self.revision_history():
747
revision = self.repository.get_revision(revision_id)
748
except errors.NoSuchRevision, e:
749
raise errors.BzrCheckError("mainline revision {%s} not in repository"
751
# In general the first entry on the revision history has no parents.
752
# But it's not illegal for it to have parents listed; this can happen
753
# in imports from Arch when the parents weren't reachable.
754
if mainline_parent_id is not None:
755
if mainline_parent_id not in revision.parent_ids:
756
raise errors.BzrCheckError("previous revision {%s} not listed among "
758
% (mainline_parent_id, revision_id))
759
mainline_parent_id = revision_id
760
return BranchCheckResult(self)
762
def _get_checkout_format(self):
763
"""Return the most suitable metadir for a checkout of this branch.
764
Weaves are used if this branch's repository uses weaves.
766
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
767
from bzrlib.repofmt import weaverepo
768
format = bzrdir.BzrDirMetaFormat1()
769
format.repository_format = weaverepo.RepositoryFormat7()
771
format = self.repository.bzrdir.checkout_metadir()
772
format.set_branch_format(self._format)
775
def create_checkout(self, to_location, revision_id=None,
777
"""Create a checkout of a branch.
779
:param to_location: The url to produce the checkout at
780
:param revision_id: The revision to check out
781
:param lightweight: If True, produce a lightweight checkout, otherwise,
782
produce a bound branch (heavyweight checkout)
783
:return: The tree of the created checkout
785
t = transport.get_transport(to_location)
788
format = self._get_checkout_format()
789
checkout = format.initialize_on_transport(t)
790
BranchReferenceFormat().initialize(checkout, self)
792
format = self._get_checkout_format()
793
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
794
to_location, force_new_tree=False, format=format)
795
checkout = checkout_branch.bzrdir
796
checkout_branch.bind(self)
797
# pull up to the specified revision_id to set the initial
798
# branch tip correctly, and seed it with history.
799
checkout_branch.pull(self, stop_revision=revision_id)
800
tree = checkout.create_workingtree(revision_id)
801
basis_tree = tree.basis_tree()
802
basis_tree.lock_read()
804
for path, file_id in basis_tree.iter_references():
805
reference_parent = self.reference_parent(file_id, path)
806
reference_parent.create_checkout(tree.abspath(path),
807
basis_tree.get_reference_revision(file_id, path),
813
def reference_parent(self, file_id, path):
814
"""Return the parent branch for a tree-reference file_id
815
:param file_id: The file_id of the tree reference
816
:param path: The path of the file_id in the tree
817
:return: A branch associated with the file_id
819
# FIXME should provide multiple branches, based on config
820
return Branch.open(self.bzrdir.root_transport.clone(path).base)
822
def supports_tags(self):
823
return self._format.supports_tags()
826
class BranchFormat(object):
827
"""An encapsulation of the initialization and open routines for a format.
829
Formats provide three things:
830
* An initialization routine,
834
Formats are placed in an dict by their format string for reference
835
during branch opening. Its not required that these be instances, they
836
can be classes themselves with class methods - it simply depends on
837
whether state is needed for a given format or not.
839
Once a format is deprecated, just deprecate the initialize and open
840
methods on the format class. Do not deprecate the object, as the
841
object will be created every time regardless.
844
_default_format = None
845
"""The default format used for new branches."""
848
"""The known formats."""
850
def __eq__(self, other):
851
return self.__class__ is other.__class__
853
def __ne__(self, other):
854
return not (self == other)
857
def find_format(klass, a_bzrdir):
858
"""Return the format for the branch object in a_bzrdir."""
860
transport = a_bzrdir.get_branch_transport(None)
861
format_string = transport.get("format").read()
862
return klass._formats[format_string]
864
raise NotBranchError(path=transport.base)
866
raise errors.UnknownFormatError(format=format_string)
869
def get_default_format(klass):
870
"""Return the current default format."""
871
return klass._default_format
873
def get_reference(self, a_bzrdir):
874
"""Get the target reference of the branch in a_bzrdir.
876
format probing must have been completed before calling
877
this method - it is assumed that the format of the branch
878
in a_bzrdir is correct.
880
:param a_bzrdir: The bzrdir to get the branch data from.
881
:return: None if the branch is not a reference branch.
885
def get_format_string(self):
886
"""Return the ASCII format string that identifies this format."""
887
raise NotImplementedError(self.get_format_string)
889
def get_format_description(self):
890
"""Return the short format description for this format."""
891
raise NotImplementedError(self.get_format_description)
893
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
895
"""Initialize a branch in a bzrdir, with specified files
897
:param a_bzrdir: The bzrdir to initialize the branch in
898
:param utf8_files: The files to create as a list of
899
(filename, content) tuples
900
:param set_format: If True, set the format with
901
self.get_format_string. (BzrBranch4 has its format set
903
:return: a branch in this format
905
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
906
branch_transport = a_bzrdir.get_branch_transport(self)
908
'metadir': ('lock', lockdir.LockDir),
909
'branch4': ('branch-lock', lockable_files.TransportLock),
911
lock_name, lock_class = lock_map[lock_type]
912
control_files = lockable_files.LockableFiles(branch_transport,
913
lock_name, lock_class)
914
control_files.create_lock()
915
control_files.lock_write()
917
control_files.put_utf8('format', self.get_format_string())
919
for file, content in utf8_files:
920
control_files.put_utf8(file, content)
922
control_files.unlock()
923
return self.open(a_bzrdir, _found=True)
925
def initialize(self, a_bzrdir):
926
"""Create a branch of this format in a_bzrdir."""
927
raise NotImplementedError(self.initialize)
929
def is_supported(self):
930
"""Is this format supported?
932
Supported formats can be initialized and opened.
933
Unsupported formats may not support initialization or committing or
934
some other features depending on the reason for not being supported.
938
def open(self, a_bzrdir, _found=False):
939
"""Return the branch object for a_bzrdir
941
_found is a private parameter, do not use it. It is used to indicate
942
if format probing has already be done.
944
raise NotImplementedError(self.open)
947
def register_format(klass, format):
948
klass._formats[format.get_format_string()] = format
951
def set_default_format(klass, format):
952
klass._default_format = format
955
def unregister_format(klass, format):
956
assert klass._formats[format.get_format_string()] is format
957
del klass._formats[format.get_format_string()]
960
return self.get_format_string().rstrip()
962
def supports_tags(self):
963
"""True if this format supports tags stored in the branch"""
964
return False # by default
966
# XXX: Probably doesn't really belong here -- mbp 20070212
967
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
969
branch_transport = a_bzrdir.get_branch_transport(self)
970
control_files = lockable_files.LockableFiles(branch_transport,
971
lock_filename, lock_class)
972
control_files.create_lock()
973
control_files.lock_write()
975
for filename, content in utf8_files:
976
control_files.put_utf8(filename, content)
978
control_files.unlock()
981
class BranchHooks(Hooks):
982
"""A dictionary mapping hook name to a list of callables for branch hooks.
984
e.g. ['set_rh'] Is the list of items to be called when the
985
set_revision_history function is invoked.
989
"""Create the default hooks.
991
These are all empty initially, because by default nothing should get
995
# Introduced in 0.15:
996
# invoked whenever the revision history has been set
997
# with set_revision_history. The api signature is
998
# (branch, revision_history), and the branch will
1001
# invoked after a push operation completes.
1002
# the api signature is
1004
# containing the members
1005
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1006
# where local is the local target branch or None, master is the target
1007
# master branch, and the rest should be self explanatory. The source
1008
# is read locked and the target branches write locked. Source will
1009
# be the local low-latency branch.
1010
self['post_push'] = []
1011
# invoked after a pull operation completes.
1012
# the api signature is
1014
# containing the members
1015
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1016
# where local is the local branch or None, master is the target
1017
# master branch, and the rest should be self explanatory. The source
1018
# is read locked and the target branches write locked. The local
1019
# branch is the low-latency branch.
1020
self['post_pull'] = []
1021
# invoked after a commit operation completes.
1022
# the api signature is
1023
# (local, master, old_revno, old_revid, new_revno, new_revid)
1024
# old_revid is NULL_REVISION for the first commit to a branch.
1025
self['post_commit'] = []
1026
# invoked after a uncommit operation completes.
1027
# the api signature is
1028
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1029
# local is the local branch or None, master is the target branch,
1030
# and an empty branch recieves new_revno of 0, new_revid of None.
1031
self['post_uncommit'] = []
1034
# install the default hooks into the Branch class.
1035
Branch.hooks = BranchHooks()
1038
class BzrBranchFormat4(BranchFormat):
1039
"""Bzr branch format 4.
1042
- a revision-history file.
1043
- a branch-lock lock file [ to be shared with the bzrdir ]
1046
def get_format_description(self):
1047
"""See BranchFormat.get_format_description()."""
1048
return "Branch format 4"
1050
def initialize(self, a_bzrdir):
1051
"""Create a branch of this format in a_bzrdir."""
1052
utf8_files = [('revision-history', ''),
1053
('branch-name', ''),
1055
return self._initialize_helper(a_bzrdir, utf8_files,
1056
lock_type='branch4', set_format=False)
1059
super(BzrBranchFormat4, self).__init__()
1060
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1062
def open(self, a_bzrdir, _found=False):
1063
"""Return the branch object for a_bzrdir
1065
_found is a private parameter, do not use it. It is used to indicate
1066
if format probing has already be done.
1069
# we are being called directly and must probe.
1070
raise NotImplementedError
1071
return BzrBranch(_format=self,
1072
_control_files=a_bzrdir._control_files,
1074
_repository=a_bzrdir.open_repository())
1077
return "Bazaar-NG branch format 4"
1080
class BzrBranchFormat5(BranchFormat):
1081
"""Bzr branch format 5.
1084
- a revision-history file.
1086
- a lock dir guarding the branch itself
1087
- all of this stored in a branch/ subdirectory
1088
- works with shared repositories.
1090
This format is new in bzr 0.8.
1093
def get_format_string(self):
1094
"""See BranchFormat.get_format_string()."""
1095
return "Bazaar-NG branch format 5\n"
1097
def get_format_description(self):
1098
"""See BranchFormat.get_format_description()."""
1099
return "Branch format 5"
1101
def initialize(self, a_bzrdir):
1102
"""Create a branch of this format in a_bzrdir."""
1103
utf8_files = [('revision-history', ''),
1104
('branch-name', ''),
1106
return self._initialize_helper(a_bzrdir, utf8_files)
1109
super(BzrBranchFormat5, self).__init__()
1110
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1112
def open(self, a_bzrdir, _found=False):
1113
"""Return the branch object for a_bzrdir
1115
_found is a private parameter, do not use it. It is used to indicate
1116
if format probing has already be done.
1119
format = BranchFormat.find_format(a_bzrdir)
1120
assert format.__class__ == self.__class__
1122
transport = a_bzrdir.get_branch_transport(None)
1123
control_files = lockable_files.LockableFiles(transport, 'lock',
1125
return BzrBranch5(_format=self,
1126
_control_files=control_files,
1128
_repository=a_bzrdir.find_repository())
1130
raise NotBranchError(path=transport.base)
1133
class BzrBranchFormat6(BzrBranchFormat5):
1134
"""Branch format with last-revision
1136
Unlike previous formats, this has no explicit revision history. Instead,
1137
this just stores the last-revision, and the left-hand history leading
1138
up to there is the history.
1140
This format was introduced in bzr 0.15
1143
def get_format_string(self):
1144
"""See BranchFormat.get_format_string()."""
1145
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1147
def get_format_description(self):
1148
"""See BranchFormat.get_format_description()."""
1149
return "Branch format 6"
1151
def initialize(self, a_bzrdir):
1152
"""Create a branch of this format in a_bzrdir."""
1153
utf8_files = [('last-revision', '0 null:\n'),
1154
('branch-name', ''),
1155
('branch.conf', ''),
1158
return self._initialize_helper(a_bzrdir, utf8_files)
1160
def open(self, a_bzrdir, _found=False):
1161
"""Return the branch object for a_bzrdir
1163
_found is a private parameter, do not use it. It is used to indicate
1164
if format probing has already be done.
1167
format = BranchFormat.find_format(a_bzrdir)
1168
assert format.__class__ == self.__class__
1169
transport = a_bzrdir.get_branch_transport(None)
1170
control_files = lockable_files.LockableFiles(transport, 'lock',
1172
return BzrBranch6(_format=self,
1173
_control_files=control_files,
1175
_repository=a_bzrdir.find_repository())
1177
def supports_tags(self):
1181
class BranchReferenceFormat(BranchFormat):
1182
"""Bzr branch reference format.
1184
Branch references are used in implementing checkouts, they
1185
act as an alias to the real branch which is at some other url.
1192
def get_format_string(self):
1193
"""See BranchFormat.get_format_string()."""
1194
return "Bazaar-NG Branch Reference Format 1\n"
1196
def get_format_description(self):
1197
"""See BranchFormat.get_format_description()."""
1198
return "Checkout reference format 1"
1200
def get_reference(self, a_bzrdir):
1201
"""See BranchFormat.get_reference()."""
1202
transport = a_bzrdir.get_branch_transport(None)
1203
return transport.get('location').read()
1205
def initialize(self, a_bzrdir, target_branch=None):
1206
"""Create a branch of this format in a_bzrdir."""
1207
if target_branch is None:
1208
# this format does not implement branch itself, thus the implicit
1209
# creation contract must see it as uninitializable
1210
raise errors.UninitializableFormat(self)
1211
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1212
branch_transport = a_bzrdir.get_branch_transport(self)
1213
branch_transport.put_bytes('location',
1214
target_branch.bzrdir.root_transport.base)
1215
branch_transport.put_bytes('format', self.get_format_string())
1216
return self.open(a_bzrdir, _found=True)
1219
super(BranchReferenceFormat, self).__init__()
1220
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1222
def _make_reference_clone_function(format, a_branch):
1223
"""Create a clone() routine for a branch dynamically."""
1224
def clone(to_bzrdir, revision_id=None):
1225
"""See Branch.clone()."""
1226
return format.initialize(to_bzrdir, a_branch)
1227
# cannot obey revision_id limits when cloning a reference ...
1228
# FIXME RBC 20060210 either nuke revision_id for clone, or
1229
# emit some sort of warning/error to the caller ?!
1232
def open(self, a_bzrdir, _found=False, location=None):
1233
"""Return the branch that the branch reference in a_bzrdir points at.
1235
_found is a private parameter, do not use it. It is used to indicate
1236
if format probing has already be done.
1239
format = BranchFormat.find_format(a_bzrdir)
1240
assert format.__class__ == self.__class__
1241
if location is None:
1242
location = self.get_reference(a_bzrdir)
1243
real_bzrdir = bzrdir.BzrDir.open(location)
1244
result = real_bzrdir.open_branch()
1245
# this changes the behaviour of result.clone to create a new reference
1246
# rather than a copy of the content of the branch.
1247
# I did not use a proxy object because that needs much more extensive
1248
# testing, and we are only changing one behaviour at the moment.
1249
# If we decide to alter more behaviours - i.e. the implicit nickname
1250
# then this should be refactored to introduce a tested proxy branch
1251
# and a subclass of that for use in overriding clone() and ....
1253
result.clone = self._make_reference_clone_function(result)
1257
# formats which have no format string are not discoverable
1258
# and not independently creatable, so are not registered.
1259
__default_format = BzrBranchFormat5()
1260
BranchFormat.register_format(__default_format)
1261
BranchFormat.register_format(BranchReferenceFormat())
1262
BranchFormat.register_format(BzrBranchFormat6())
1263
BranchFormat.set_default_format(__default_format)
1264
_legacy_formats = [BzrBranchFormat4(),
1267
class BzrBranch(Branch):
1268
"""A branch stored in the actual filesystem.
1270
Note that it's "local" in the context of the filesystem; it doesn't
1271
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1272
it's writable, and can be accessed via the normal filesystem API.
1275
def __init__(self, _format=None,
1276
_control_files=None, a_bzrdir=None, _repository=None):
1277
"""Create new branch object at a particular location."""
1278
Branch.__init__(self)
1279
if a_bzrdir is None:
1280
raise ValueError('a_bzrdir must be supplied')
1282
self.bzrdir = a_bzrdir
1283
# self._transport used to point to the directory containing the
1284
# control directory, but was not used - now it's just the transport
1285
# for the branch control files. mbp 20070212
1286
self._base = self.bzrdir.transport.clone('..').base
1287
self._format = _format
1288
if _control_files is None:
1289
raise ValueError('BzrBranch _control_files is None')
1290
self.control_files = _control_files
1291
self._transport = _control_files._transport
1292
self.repository = _repository
1295
return '%s(%r)' % (self.__class__.__name__, self.base)
1299
def _get_base(self):
1300
"""Returns the directory containing the control directory."""
1303
base = property(_get_base, doc="The URL for the root of this branch.")
1305
def abspath(self, name):
1306
"""See Branch.abspath."""
1307
return self.control_files._transport.abspath(name)
1310
@deprecated_method(zero_sixteen)
1312
def get_root_id(self):
1313
"""See Branch.get_root_id."""
1314
tree = self.repository.revision_tree(self.last_revision())
1315
return tree.inventory.root.file_id
1317
def is_locked(self):
1318
return self.control_files.is_locked()
1320
def lock_write(self, token=None):
1321
repo_token = self.repository.lock_write()
1323
token = self.control_files.lock_write(token=token)
1325
self.repository.unlock()
1329
def lock_read(self):
1330
self.repository.lock_read()
1332
self.control_files.lock_read()
1334
self.repository.unlock()
1338
# TODO: test for failed two phase locks. This is known broken.
1340
self.control_files.unlock()
1342
self.repository.unlock()
1343
if not self.control_files.is_locked():
1344
# we just released the lock
1345
self._clear_cached_state()
1347
def peek_lock_mode(self):
1348
if self.control_files._lock_count == 0:
1351
return self.control_files._lock_mode
1353
def get_physical_lock_status(self):
1354
return self.control_files.get_physical_lock_status()
1357
def print_file(self, file, revision_id):
1358
"""See Branch.print_file."""
1359
return self.repository.print_file(file, revision_id)
1362
def append_revision(self, *revision_ids):
1363
"""See Branch.append_revision."""
1364
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1365
for revision_id in revision_ids:
1366
_mod_revision.check_not_reserved_id(revision_id)
1367
mutter("add {%s} to revision-history" % revision_id)
1368
rev_history = self.revision_history()
1369
rev_history.extend(revision_ids)
1370
self.set_revision_history(rev_history)
1372
def _write_revision_history(self, history):
1373
"""Factored out of set_revision_history.
1375
This performs the actual writing to disk.
1376
It is intended to be called by BzrBranch5.set_revision_history."""
1377
self.control_files.put_bytes(
1378
'revision-history', '\n'.join(history))
1381
def set_revision_history(self, rev_history):
1382
"""See Branch.set_revision_history."""
1383
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1384
self._clear_cached_state()
1385
self._write_revision_history(rev_history)
1386
self._cache_revision_history(rev_history)
1387
for hook in Branch.hooks['set_rh']:
1388
hook(self, rev_history)
1391
def set_last_revision_info(self, revno, revision_id):
1392
revision_id = osutils.safe_revision_id(revision_id)
1393
history = self._lefthand_history(revision_id)
1394
assert len(history) == revno, '%d != %d' % (len(history), revno)
1395
self.set_revision_history(history)
1397
def _gen_revision_history(self):
1398
history = self.control_files.get('revision-history').read().split('\n')
1399
if history[-1:] == ['']:
1400
# There shouldn't be a trailing newline, but just in case.
1404
def _lefthand_history(self, revision_id, last_rev=None,
1406
# stop_revision must be a descendant of last_revision
1407
stop_graph = self.repository.get_revision_graph(revision_id)
1408
if last_rev is not None and last_rev not in stop_graph:
1409
# our previous tip is not merged into stop_revision
1410
raise errors.DivergedBranches(self, other_branch)
1411
# make a new revision history from the graph
1412
current_rev_id = revision_id
1414
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1415
new_history.append(current_rev_id)
1416
current_rev_id_parents = stop_graph[current_rev_id]
1418
current_rev_id = current_rev_id_parents[0]
1420
current_rev_id = None
1421
new_history.reverse()
1425
def generate_revision_history(self, revision_id, last_rev=None,
1427
"""Create a new revision history that will finish with revision_id.
1429
:param revision_id: the new tip to use.
1430
:param last_rev: The previous last_revision. If not None, then this
1431
must be a ancestory of revision_id, or DivergedBranches is raised.
1432
:param other_branch: The other branch that DivergedBranches should
1433
raise with respect to.
1435
revision_id = osutils.safe_revision_id(revision_id)
1436
self.set_revision_history(self._lefthand_history(revision_id,
1437
last_rev, other_branch))
1440
def update_revisions(self, other, stop_revision=None):
1441
"""See Branch.update_revisions."""
1444
if stop_revision is None:
1445
stop_revision = other.last_revision()
1446
if stop_revision is None:
1447
# if there are no commits, we're done.
1450
stop_revision = osutils.safe_revision_id(stop_revision)
1451
# whats the current last revision, before we fetch [and change it
1453
last_rev = self.last_revision()
1454
# we fetch here regardless of whether we need to so that we pickup
1456
self.fetch(other, stop_revision)
1457
my_ancestry = self.repository.get_ancestry(last_rev,
1459
if stop_revision in my_ancestry:
1460
# last_revision is a descendant of stop_revision
1462
self.generate_revision_history(stop_revision, last_rev=last_rev,
1467
def basis_tree(self):
1468
"""See Branch.basis_tree."""
1469
return self.repository.revision_tree(self.last_revision())
1471
@deprecated_method(zero_eight)
1472
def working_tree(self):
1473
"""Create a Working tree object for this branch."""
1475
from bzrlib.transport.local import LocalTransport
1476
if (self.base.find('://') != -1 or
1477
not isinstance(self._transport, LocalTransport)):
1478
raise NoWorkingTree(self.base)
1479
return self.bzrdir.open_workingtree()
1482
def pull(self, source, overwrite=False, stop_revision=None,
1483
_hook_master=None, run_hooks=True):
1486
:param _hook_master: Private parameter - set the branch to
1487
be supplied as the master to push hooks.
1488
:param run_hooks: Private parameter - if false, this branch
1489
is being called because it's the master of the primary branch,
1490
so it should not run its hooks.
1492
result = PullResult()
1493
result.source_branch = source
1494
result.target_branch = self
1497
result.old_revno, result.old_revid = self.last_revision_info()
1499
self.update_revisions(source, stop_revision)
1500
except DivergedBranches:
1504
if stop_revision is None:
1505
stop_revision = source.last_revision()
1506
self.generate_revision_history(stop_revision)
1507
result.tag_conflicts = source.tags.merge_to(self.tags)
1508
result.new_revno, result.new_revid = self.last_revision_info()
1510
result.master_branch = _hook_master
1511
result.local_branch = self
1513
result.master_branch = self
1514
result.local_branch = None
1516
for hook in Branch.hooks['post_pull']:
1522
def _get_parent_location(self):
1523
_locs = ['parent', 'pull', 'x-pull']
1526
return self.control_files.get(l).read().strip('\n')
1532
def push(self, target, overwrite=False, stop_revision=None,
1533
_override_hook_source_branch=None):
1536
This is the basic concrete implementation of push()
1538
:param _override_hook_source_branch: If specified, run
1539
the hooks passing this Branch as the source, rather than self.
1540
This is for use of RemoteBranch, where push is delegated to the
1541
underlying vfs-based Branch.
1543
# TODO: Public option to disable running hooks - should be trivial but
1547
result = self._push_with_bound_branches(target, overwrite,
1549
_override_hook_source_branch=_override_hook_source_branch)
1554
def _push_with_bound_branches(self, target, overwrite,
1556
_override_hook_source_branch=None):
1557
"""Push from self into target, and into target's master if any.
1559
This is on the base BzrBranch class even though it doesn't support
1560
bound branches because the *target* might be bound.
1563
if _override_hook_source_branch:
1564
result.source_branch = _override_hook_source_branch
1565
for hook in Branch.hooks['post_push']:
1568
bound_location = target.get_bound_location()
1569
if bound_location and target.base != bound_location:
1570
# there is a master branch.
1572
# XXX: Why the second check? Is it even supported for a branch to
1573
# be bound to itself? -- mbp 20070507
1574
master_branch = target.get_master_branch()
1575
master_branch.lock_write()
1577
# push into the master from this branch.
1578
self._basic_push(master_branch, overwrite, stop_revision)
1579
# and push into the target branch from this. Note that we push from
1580
# this branch again, because its considered the highest bandwidth
1582
result = self._basic_push(target, overwrite, stop_revision)
1583
result.master_branch = master_branch
1584
result.local_branch = target
1588
master_branch.unlock()
1591
result = self._basic_push(target, overwrite, stop_revision)
1592
# TODO: Why set master_branch and local_branch if there's no
1593
# binding? Maybe cleaner to just leave them unset? -- mbp
1595
result.master_branch = target
1596
result.local_branch = None
1600
def _basic_push(self, target, overwrite, stop_revision):
1601
"""Basic implementation of push without bound branches or hooks.
1603
Must be called with self read locked and target write locked.
1605
result = PushResult()
1606
result.source_branch = self
1607
result.target_branch = target
1608
result.old_revno, result.old_revid = target.last_revision_info()
1610
target.update_revisions(self, stop_revision)
1611
except DivergedBranches:
1615
target.set_revision_history(self.revision_history())
1616
result.tag_conflicts = self.tags.merge_to(target.tags)
1617
result.new_revno, result.new_revid = target.last_revision_info()
1620
def get_parent(self):
1621
"""See Branch.get_parent."""
1623
assert self.base[-1] == '/'
1624
parent = self._get_parent_location()
1627
# This is an old-format absolute path to a local branch
1628
# turn it into a url
1629
if parent.startswith('/'):
1630
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1632
return urlutils.join(self.base[:-1], parent)
1633
except errors.InvalidURLJoin, e:
1634
raise errors.InaccessibleParent(parent, self.base)
1636
def set_push_location(self, location):
1637
"""See Branch.set_push_location."""
1638
self.get_config().set_user_option(
1639
'push_location', location,
1640
store=_mod_config.STORE_LOCATION_NORECURSE)
1643
def set_parent(self, url):
1644
"""See Branch.set_parent."""
1645
# TODO: Maybe delete old location files?
1646
# URLs should never be unicode, even on the local fs,
1647
# FIXUP this and get_parent in a future branch format bump:
1648
# read and rewrite the file, and have the new format code read
1649
# using .get not .get_utf8. RBC 20060125
1651
if isinstance(url, unicode):
1653
url = url.encode('ascii')
1654
except UnicodeEncodeError:
1655
raise errors.InvalidURL(url,
1656
"Urls must be 7-bit ascii, "
1657
"use bzrlib.urlutils.escape")
1658
url = urlutils.relative_url(self.base, url)
1659
self._set_parent_location(url)
1661
def _set_parent_location(self, url):
1663
self.control_files._transport.delete('parent')
1665
assert isinstance(url, str)
1666
self.control_files.put_bytes('parent', url + '\n')
1668
@deprecated_function(zero_nine)
1669
def tree_config(self):
1670
"""DEPRECATED; call get_config instead.
1671
TreeConfig has become part of BranchConfig."""
1672
return TreeConfig(self)
1675
class BzrBranch5(BzrBranch):
1676
"""A format 5 branch. This supports new features over plan branches.
1678
It has support for a master_branch which is the data for bound branches.
1686
super(BzrBranch5, self).__init__(_format=_format,
1687
_control_files=_control_files,
1689
_repository=_repository)
1692
def pull(self, source, overwrite=False, stop_revision=None,
1694
"""Pull from source into self, updating my master if any.
1696
:param run_hooks: Private parameter - if false, this branch
1697
is being called because it's the master of the primary branch,
1698
so it should not run its hooks.
1700
bound_location = self.get_bound_location()
1701
master_branch = None
1702
if bound_location and source.base != bound_location:
1703
# not pulling from master, so we need to update master.
1704
master_branch = self.get_master_branch()
1705
master_branch.lock_write()
1708
# pull from source into master.
1709
master_branch.pull(source, overwrite, stop_revision,
1711
return super(BzrBranch5, self).pull(source, overwrite,
1712
stop_revision, _hook_master=master_branch,
1713
run_hooks=run_hooks)
1716
master_branch.unlock()
1718
def get_bound_location(self):
1720
return self.control_files.get_utf8('bound').read()[:-1]
1721
except errors.NoSuchFile:
1725
def get_master_branch(self):
1726
"""Return the branch we are bound to.
1728
:return: Either a Branch, or None
1730
This could memoise the branch, but if thats done
1731
it must be revalidated on each new lock.
1732
So for now we just don't memoise it.
1733
# RBC 20060304 review this decision.
1735
bound_loc = self.get_bound_location()
1739
return Branch.open(bound_loc)
1740
except (errors.NotBranchError, errors.ConnectionError), e:
1741
raise errors.BoundBranchConnectionFailure(
1745
def set_bound_location(self, location):
1746
"""Set the target where this branch is bound to.
1748
:param location: URL to the target branch
1751
self.control_files.put_utf8('bound', location+'\n')
1754
self.control_files._transport.delete('bound')
1350
class ScratchBranch(Branch):
1351
"""Special test class: a branch that cleans up after itself.
1353
>>> b = ScratchBranch()
1361
def __init__(self, files=[], dirs=[], base=None):
1362
"""Make a test branch.
1364
This creates a temporary directory and runs init-tree in it.
1366
If any files are listed, they are created in the working copy.
1368
from tempfile import mkdtemp
1373
Branch.__init__(self, base, init=init)
1375
os.mkdir(self.abspath(d))
1378
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1383
>>> orig = ScratchBranch(files=["file1", "file2"])
1384
>>> clone = orig.clone()
1385
>>> os.path.samefile(orig.base, clone.base)
1387
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1390
from shutil import copytree
1391
from tempfile import mkdtemp
1394
copytree(self.base, base, symlinks=True)
1395
return ScratchBranch(base=base)
1403
"""Destroy the test branch, removing the scratch directory."""
1404
from shutil import rmtree
1407
mutter("delete ScratchBranch %s" % self.base)
1410
# Work around for shutil.rmtree failing on Windows when
1411
# readonly files are encountered
1412
mutter("hit exception in destroying ScratchBranch: %s" % e)
1413
for root, dirs, files in os.walk(self.base, topdown=False):
1415
os.chmod(os.path.join(root, name), 0700)
1421
######################################################################
1425
def is_control_file(filename):
1426
## FIXME: better check
1427
filename = os.path.normpath(filename)
1428
while filename != '':
1429
head, tail = os.path.split(filename)
1430
## mutter('check %r for control file' % ((head, tail), ))
1431
if tail == bzrlib.BZRDIR:
1760
def bind(self, other):
1761
"""Bind this branch to the branch other.
1763
This does not push or pull data between the branches, though it does
1764
check for divergence to raise an error when the branches are not
1765
either the same, or one a prefix of the other. That behaviour may not
1766
be useful, so that check may be removed in future.
1768
:param other: The branch to bind to
1771
# TODO: jam 20051230 Consider checking if the target is bound
1772
# It is debatable whether you should be able to bind to
1773
# a branch which is itself bound.
1774
# Committing is obviously forbidden,
1775
# but binding itself may not be.
1776
# Since we *have* to check at commit time, we don't
1777
# *need* to check here
1779
# we want to raise diverged if:
1780
# last_rev is not in the other_last_rev history, AND
1781
# other_last_rev is not in our history, and do it without pulling
1783
last_rev = self.last_revision()
1784
if last_rev is not None:
1787
other_last_rev = other.last_revision()
1788
if other_last_rev is not None:
1789
# neither branch is new, we have to do some work to
1790
# ascertain diversion.
1791
remote_graph = other.repository.get_revision_graph(
1793
local_graph = self.repository.get_revision_graph(last_rev)
1794
if (last_rev not in remote_graph and
1795
other_last_rev not in local_graph):
1796
raise errors.DivergedBranches(self, other)
1799
self.set_bound_location(other.base)
1803
"""If bound, unbind"""
1804
return self.set_bound_location(None)
1808
"""Synchronise this branch with the master branch if any.
1810
:return: None or the last_revision that was pivoted out during the
1813
master = self.get_master_branch()
1814
if master is not None:
1815
old_tip = self.last_revision()
1816
self.pull(master, overwrite=True)
1817
if old_tip in self.repository.get_ancestry(self.last_revision(),
1824
class BzrBranchExperimental(BzrBranch5):
1825
"""Bzr experimental branch format
1828
- a revision-history file.
1830
- a lock dir guarding the branch itself
1831
- all of this stored in a branch/ subdirectory
1832
- works with shared repositories.
1833
- a tag dictionary in the branch
1835
This format is new in bzr 0.15, but shouldn't be used for real data,
1838
This class acts as it's own BranchFormat.
1841
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1844
def get_format_string(cls):
1845
"""See BranchFormat.get_format_string()."""
1846
return "Bazaar-NG branch format experimental\n"
1849
def get_format_description(cls):
1850
"""See BranchFormat.get_format_description()."""
1851
return "Experimental branch format"
1854
def get_reference(cls, a_bzrdir):
1855
"""Get the target reference of the branch in a_bzrdir.
1857
format probing must have been completed before calling
1858
this method - it is assumed that the format of the branch
1859
in a_bzrdir is correct.
1861
:param a_bzrdir: The bzrdir to get the branch data from.
1862
:return: None if the branch is not a reference branch.
1867
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1869
branch_transport = a_bzrdir.get_branch_transport(cls)
1870
control_files = lockable_files.LockableFiles(branch_transport,
1871
lock_filename, lock_class)
1872
control_files.create_lock()
1873
control_files.lock_write()
1875
for filename, content in utf8_files:
1876
control_files.put_utf8(filename, content)
1878
control_files.unlock()
1881
def initialize(cls, a_bzrdir):
1882
"""Create a branch of this format in a_bzrdir."""
1883
utf8_files = [('format', cls.get_format_string()),
1884
('revision-history', ''),
1885
('branch-name', ''),
1888
cls._initialize_control_files(a_bzrdir, utf8_files,
1889
'lock', lockdir.LockDir)
1890
return cls.open(a_bzrdir, _found=True)
1893
def open(cls, a_bzrdir, _found=False):
1894
"""Return the branch object for a_bzrdir
1896
_found is a private parameter, do not use it. It is used to indicate
1897
if format probing has already be done.
1900
format = BranchFormat.find_format(a_bzrdir)
1901
assert format.__class__ == cls
1902
transport = a_bzrdir.get_branch_transport(None)
1903
control_files = lockable_files.LockableFiles(transport, 'lock',
1905
return cls(_format=cls,
1906
_control_files=control_files,
1908
_repository=a_bzrdir.find_repository())
1911
def is_supported(cls):
1914
def _make_tags(self):
1915
return BasicTags(self)
1918
def supports_tags(cls):
1922
BranchFormat.register_format(BzrBranchExperimental)
1925
class BzrBranch6(BzrBranch5):
1928
def last_revision_info(self):
1929
revision_string = self.control_files.get('last-revision').read()
1930
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1931
revision_id = cache_utf8.get_cached_utf8(revision_id)
1933
return revno, revision_id
1935
def last_revision(self):
1936
"""Return last revision id, or None"""
1937
revision_id = self.last_revision_info()[1]
1938
if revision_id == _mod_revision.NULL_REVISION:
1942
def _write_last_revision_info(self, revno, revision_id):
1943
"""Simply write out the revision id, with no checks.
1945
Use set_last_revision_info to perform this safely.
1947
Does not update the revision_history cache.
1948
Intended to be called by set_last_revision_info and
1949
_write_revision_history.
1951
if revision_id is None:
1952
revision_id = 'null:'
1953
out_string = '%d %s\n' % (revno, revision_id)
1954
self.control_files.put_bytes('last-revision', out_string)
1957
def set_last_revision_info(self, revno, revision_id):
1958
revision_id = osutils.safe_revision_id(revision_id)
1959
if self._get_append_revisions_only():
1960
self._check_history_violation(revision_id)
1961
self._write_last_revision_info(revno, revision_id)
1962
self._clear_cached_state()
1964
def _check_history_violation(self, revision_id):
1965
last_revision = self.last_revision()
1966
if last_revision is None:
1968
if last_revision not in self._lefthand_history(revision_id):
1969
raise errors.AppendRevisionsOnlyViolation(self.base)
1971
def _gen_revision_history(self):
1972
"""Generate the revision history from last revision
1974
history = list(self.repository.iter_reverse_revision_history(
1975
self.last_revision()))
1979
def _write_revision_history(self, history):
1980
"""Factored out of set_revision_history.
1982
This performs the actual writing to disk, with format-specific checks.
1983
It is intended to be called by BzrBranch5.set_revision_history.
1985
if len(history) == 0:
1986
last_revision = 'null:'
1988
if history != self._lefthand_history(history[-1]):
1989
raise errors.NotLefthandHistory(history)
1990
last_revision = history[-1]
1991
if self._get_append_revisions_only():
1992
self._check_history_violation(last_revision)
1993
self._write_last_revision_info(len(history), last_revision)
1996
def append_revision(self, *revision_ids):
1997
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1998
if len(revision_ids) == 0:
2000
prev_revno, prev_revision = self.last_revision_info()
2001
for revision in self.repository.get_revisions(revision_ids):
2002
if prev_revision == _mod_revision.NULL_REVISION:
2003
if revision.parent_ids != []:
2004
raise errors.NotLeftParentDescendant(self, prev_revision,
2005
revision.revision_id)
2007
if revision.parent_ids[0] != prev_revision:
2008
raise errors.NotLeftParentDescendant(self, prev_revision,
2009
revision.revision_id)
2010
prev_revision = revision.revision_id
2011
self.set_last_revision_info(prev_revno + len(revision_ids),
2015
def _set_parent_location(self, url):
2016
"""Set the parent branch"""
2017
self._set_config_location('parent_location', url, make_relative=True)
2020
def _get_parent_location(self):
2021
"""Set the parent branch"""
2022
return self._get_config_location('parent_location')
2024
def set_push_location(self, location):
2025
"""See Branch.set_push_location."""
2026
self._set_config_location('push_location', location)
2028
def set_bound_location(self, location):
2029
"""See Branch.set_push_location."""
2031
config = self.get_config()
2032
if location is None:
2033
if config.get_user_option('bound') != 'True':
2036
config.set_user_option('bound', 'False')
2039
self._set_config_location('bound_location', location,
2041
config.set_user_option('bound', 'True')
2044
def _get_bound_location(self, bound):
2045
"""Return the bound location in the config file.
2047
Return None if the bound parameter does not match"""
2048
config = self.get_config()
2049
config_bound = (config.get_user_option('bound') == 'True')
2050
if config_bound != bound:
2052
return self._get_config_location('bound_location', config=config)
2054
def get_bound_location(self):
2055
"""See Branch.set_push_location."""
2056
return self._get_bound_location(True)
2058
def get_old_bound_location(self):
2059
"""See Branch.get_old_bound_location"""
2060
return self._get_bound_location(False)
2062
def set_append_revisions_only(self, enabled):
2067
self.get_config().set_user_option('append_revisions_only', value)
2069
def _get_append_revisions_only(self):
2070
value = self.get_config().get_user_option('append_revisions_only')
2071
return value == 'True'
2073
def _synchronize_history(self, destination, revision_id):
2074
"""Synchronize last revision and revision history between branches.
2076
This version is most efficient when the destination is also a
2077
BzrBranch6, but works for BzrBranch5, as long as the destination's
2078
repository contains all the lefthand ancestors of the intended
2079
last_revision. If not, set_last_revision_info will fail.
2081
:param destination: The branch to copy the history into
2082
:param revision_id: The revision-id to truncate history at. May
2083
be None to copy complete history.
2085
if revision_id is None:
2086
revno, revision_id = self.last_revision_info()
2088
# To figure out the revno for a random revision, we need to build
2089
# the revision history, and count its length.
2090
# We don't care about the order, just how long it is.
2091
# Alternatively, we could start at the current location, and count
2092
# backwards. But there is no guarantee that we will find it since
2093
# it may be a merged revision.
2094
revno = len(list(self.repository.iter_reverse_revision_history(
2096
destination.set_last_revision_info(revno, revision_id)
2098
def _make_tags(self):
2099
return BasicTags(self)
2102
class BranchTestProviderAdapter(object):
2103
"""A tool to generate a suite testing multiple branch formats at once.
2105
This is done by copying the test once for each transport and injecting
2106
the transport_server, transport_readonly_server, and branch_format
2107
classes into each copy. Each copy is also given a new id() to make it
2111
def __init__(self, transport_server, transport_readonly_server, formats,
2112
vfs_transport_factory=None):
2113
self._transport_server = transport_server
2114
self._transport_readonly_server = transport_readonly_server
2115
self._formats = formats
2117
def adapt(self, test):
2118
result = TestSuite()
2119
for branch_format, bzrdir_format in self._formats:
2120
new_test = deepcopy(test)
2121
new_test.transport_server = self._transport_server
2122
new_test.transport_readonly_server = self._transport_readonly_server
2123
new_test.bzrdir_format = bzrdir_format
2124
new_test.branch_format = branch_format
2125
def make_new_test_id():
2126
# the format can be either a class or an instance
2127
name = getattr(branch_format, '__name__',
2128
branch_format.__class__.__name__)
2129
new_id = "%s(%s)" % (new_test.id(), name)
2130
return lambda: new_id
2131
new_test.id = make_new_test_id()
2132
result.addTest(new_test)
2136
######################################################################
2137
# results of operations
2140
class _Result(object):
2142
def _show_tag_conficts(self, to_file):
2143
if not getattr(self, 'tag_conflicts', None):
2145
to_file.write('Conflicting tags:\n')
2146
for name, value1, value2 in self.tag_conflicts:
2147
to_file.write(' %s\n' % (name, ))
2150
class PullResult(_Result):
2151
"""Result of a Branch.pull operation.
2153
:ivar old_revno: Revision number before pull.
2154
:ivar new_revno: Revision number after pull.
2155
:ivar old_revid: Tip revision id before pull.
2156
:ivar new_revid: Tip revision id after pull.
2157
:ivar source_branch: Source (local) branch object.
2158
:ivar master_branch: Master branch of the target, or None.
2159
:ivar target_branch: Target/destination branch object.
2163
# DEPRECATED: pull used to return the change in revno
2164
return self.new_revno - self.old_revno
2166
def report(self, to_file):
2167
if self.old_revid == self.new_revid:
2168
to_file.write('No revisions to pull.\n')
2170
to_file.write('Now on revision %d.\n' % self.new_revno)
2171
self._show_tag_conficts(to_file)
2174
class PushResult(_Result):
2175
"""Result of a Branch.push operation.
2177
:ivar old_revno: Revision number before push.
2178
:ivar new_revno: Revision number after push.
2179
:ivar old_revid: Tip revision id before push.
2180
:ivar new_revid: Tip revision id after push.
2181
:ivar source_branch: Source branch object.
2182
:ivar master_branch: Master branch of the target, or None.
2183
:ivar target_branch: Target/destination branch object.
2187
# DEPRECATED: push used to return the change in revno
2188
return self.new_revno - self.old_revno
2190
def report(self, to_file):
2191
"""Write a human-readable description of the result."""
2192
if self.old_revid == self.new_revid:
2193
to_file.write('No new revisions to push.\n')
2195
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2196
self._show_tag_conficts(to_file)
2199
class BranchCheckResult(object):
2200
"""Results of checking branch consistency.
2205
def __init__(self, branch):
2206
self.branch = branch
2208
def report_results(self, verbose):
2209
"""Report the check results via trace.note.
2211
:param verbose: Requests more detailed display of what was checked,
2214
note('checked branch %s format %s',
2216
self.branch._format)
2219
class Converter5to6(object):
2220
"""Perform an in-place upgrade of format 5 to format 6"""
2222
def convert(self, branch):
2223
# Data for 5 and 6 can peacefully coexist.
2224
format = BzrBranchFormat6()
2225
new_branch = format.open(branch.bzrdir, _found=True)
2227
# Copy source data into target
2228
new_branch.set_last_revision_info(*branch.last_revision_info())
2229
new_branch.set_parent(branch.get_parent())
2230
new_branch.set_bound_location(branch.get_bound_location())
2231
new_branch.set_push_location(branch.get_push_location())
2233
# New branch has no tags by default
2234
new_branch.tags._set_tag_dict({})
2236
# Copying done; now update target format
2237
new_branch.control_files.put_utf8('format',
2238
format.get_format_string())
2240
# Clean up old files
2241
new_branch.control_files._transport.delete('revision-history')
2243
branch.set_parent(None)
2246
branch.set_bound_location(None)
1433
if filename == head:
1440
def gen_file_id(name):
1441
"""Return new file id.
1443
This should probably generate proper UUIDs, but for the moment we
1444
cope with just randomness because running uuidgen every time is
1447
from binascii import hexlify
1448
from time import time
1450
# get last component
1451
idx = name.rfind('/')
1453
name = name[idx+1 : ]
1454
idx = name.rfind('\\')
1456
name = name[idx+1 : ]
1458
# make it not a hidden file
1459
name = name.lstrip('.')
1461
# remove any wierd characters; we don't escape them but rather
1462
# just pull them out
1463
name = re.sub(r'[^\w.]', '', name)
1465
s = hexlify(rand_bytes(8))
1466
return '-'.join((name, compact_date(time()), s))
1470
"""Return a new tree-root file id."""
1471
return gen_file_id('TREE_ROOT')
1474
def pull_loc(branch):
1475
# TODO: Should perhaps just make attribute be 'base' in
1476
# RemoteBranch and Branch?
1477
if hasattr(branch, "baseurl"):
1478
return branch.baseurl
1483
def copy_branch(branch_from, to_location, revision=None):
1484
"""Copy branch_from into the existing directory to_location.
1487
If not None, only revisions up to this point will be copied.
1488
The head of the new branch will be that revision. Can be a
1492
The name of a local directory that exists but is empty.
1494
# TODO: This could be done *much* more efficiently by just copying
1495
# all the whole weaves and revisions, rather than getting one
1496
# revision at a time.
1497
from bzrlib.merge import merge
1498
from bzrlib.branch import Branch
1500
assert isinstance(branch_from, Branch)
1501
assert isinstance(to_location, basestring)
1503
br_to = Branch(to_location, init=True)
1504
br_to.set_root_id(branch_from.get_root_id())
1505
if revision is None:
1508
revno, rev_id = branch_from.get_revision_info(revision)
1509
br_to.update_revisions(branch_from, stop_revno=revno)
1510
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1511
check_clean=False, ignore_zero=True)
1513
from_location = pull_loc(branch_from)
1514
br_to.set_parent(pull_loc(branch_from))
added
removed
bzrlib/branch.py
