72
119
Base directory/url of the branch.
74
hooks: An instance of BranchHooks.
76
# this is really an instance variable - FIXME move it there
80
# override this to set the strategy for storing tags
82
return DisabledTags(self)
84
123
def __init__(self, *ignored, **ignored_too):
85
self.tags = self._make_tags()
86
self._revision_history_cache = None
87
self._revision_id_to_revno_cache = None
90
"""Break a lock if one is present from another instance.
92
Uses the ui factory to ask for confirmation if the lock may be from
95
This will probe the repository for its lock as well.
97
self.control_files.break_lock()
98
self.repository.break_lock()
99
master = self.get_master_branch()
100
if master is not None:
104
def open(base, _unsupported=False, possible_transports=None):
105
"""Open the branch rooted at base.
107
For instance, if the branch is at URL/.bzr/branch,
108
Branch.open(URL) -> a Branch instance.
110
control = bzrdir.BzrDir.open(base, _unsupported,
111
possible_transports=possible_transports)
112
return control.open_branch(_unsupported)
115
def open_from_transport(transport, _unsupported=False):
116
"""Open the branch rooted at transport"""
117
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
118
return control.open_branch(_unsupported)
121
def open_containing(url, possible_transports=None):
122
"""Open an existing branch which contains url.
124
raise NotImplementedError('The Branch class is abstract')
128
"""Open an existing branch, rooted at 'base' (url)"""
129
if base and (base.startswith('http://') or base.startswith('https://')):
130
from bzrlib.remotebranch import RemoteBranch
131
return RemoteBranch(base, find_root=False)
133
return LocalBranch(base, find_root=False)
136
def open_containing(url):
137
"""Open an existing branch, containing url (search upwards for the root)
139
if url and (url.startswith('http://') or url.startswith('https://')):
140
from bzrlib.remotebranch import RemoteBranch
141
return RemoteBranch(url)
143
return LocalBranch(url)
146
def initialize(base):
147
"""Create a new branch, rooted at 'base' (url)"""
148
if base and (base.startswith('http://') or base.startswith('https://')):
149
from bzrlib.remotebranch import RemoteBranch
150
return RemoteBranch(base, init=True)
152
return LocalBranch(base, init=True)
154
def setup_caching(self, cache_root):
155
"""Subclasses that care about caching should override this, and set
156
up cached stores located under cache_root.
160
class LocalBranch(Branch):
161
"""A branch stored in the actual filesystem.
163
Note that it's "local" in the context of the filesystem; it doesn't
164
really matter if it's on an nfs/smb/afs/coda/... share, as long as
165
it's writable, and can be accessed via the normal filesystem API.
171
If _lock_mode is true, a positive count of the number of times the
175
Lock object from bzrlib.lock.
177
# We actually expect this class to be somewhat short-lived; part of its
178
# purpose is to try to isolate what bits of the branch logic are tied to
179
# filesystem access, so that in a later step, we can extricate them to
180
# a separarte ("storage") class.
185
def __init__(self, base, init=False, find_root=True):
186
"""Create new branch object at a particular location.
188
base -- Base directory for the branch. May be a file:// url.
124
This probes for a branch at url, and searches upwards from there.
126
Basically we keep looking up until we find the control directory or
127
run into the root. If there isn't one, raises NotBranchError.
128
If there is one and it is either an unrecognised format or an unsupported
129
format, UnknownFormatError or UnsupportedFormatError are raised.
130
If there is one, it is returned, along with the unused portion of url.
190
init -- If True, create new control files in a previously
191
unversioned directory. If False, the branch must already
194
find_root -- If true and init is false, find the root of the
195
existing branch containing base.
197
In the test suite, creation of new trees is tested using the
198
`ScratchBranch` class.
132
control, relpath = bzrdir.BzrDir.open_containing(url,
134
return control.open_branch(), relpath
136
def get_config(self):
137
return BranchConfig(self)
140
return self.get_config().get_nickname()
142
def _set_nick(self, nick):
143
self.get_config().set_user_option('nickname', nick, warn_masked=True)
145
nick = property(_get_nick, _set_nick)
148
raise NotImplementedError(self.is_locked)
200
from bzrlib.store import ImmutableStore
202
self.base = os.path.realpath(base)
205
self.base = find_branch_root(base)
207
if base.startswith("file://"):
209
self.base = os.path.realpath(base)
210
if not isdir(self.controlfilename('.')):
211
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
212
['use "bzr init" to initialize a new working tree',
213
'current bzr can only operate from top-of-tree'])
216
self.text_store = ImmutableStore(self.controlfilename('text-store'))
217
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
218
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
222
return '%s(%r)' % (self.__class__.__name__, self.base)
229
if self._lock_mode or self._lock:
230
from bzrlib.warnings import warn
231
warn("branch %r was not explicitly unlocked" % self)
150
234
def lock_write(self):
151
raise NotImplementedError(self.lock_write)
236
if self._lock_mode != 'w':
237
from bzrlib.errors import LockError
238
raise LockError("can't upgrade to a write lock from %r" %
240
self._lock_count += 1
242
from bzrlib.lock import WriteLock
244
self._lock = WriteLock(self.controlfilename('branch-lock'))
245
self._lock_mode = 'w'
153
249
def lock_read(self):
154
raise NotImplementedError(self.lock_read)
251
assert self._lock_mode in ('r', 'w'), \
252
"invalid lock mode %r" % self._lock_mode
253
self._lock_count += 1
255
from bzrlib.lock import ReadLock
257
self._lock = ReadLock(self.controlfilename('branch-lock'))
258
self._lock_mode = 'r'
156
261
def unlock(self):
157
raise NotImplementedError(self.unlock)
159
def peek_lock_mode(self):
160
"""Return lock mode for the Branch: 'r', 'w' or None"""
161
raise NotImplementedError(self.peek_lock_mode)
163
def get_physical_lock_status(self):
164
raise NotImplementedError(self.get_physical_lock_status)
167
def get_revision_id_to_revno_map(self):
168
"""Return the revision_id => dotted revno map.
170
This will be regenerated on demand, but will be cached.
172
:return: A dictionary mapping revision_id => dotted revno.
173
This dictionary should not be modified by the caller.
175
if self._revision_id_to_revno_cache is not None:
176
mapping = self._revision_id_to_revno_cache
262
if not self._lock_mode:
263
from bzrlib.errors import LockError
264
raise LockError('branch %r is not locked' % (self))
266
if self._lock_count > 1:
267
self._lock_count -= 1
178
mapping = self._gen_revno_map()
179
self._cache_revision_id_to_revno(mapping)
180
# TODO: jam 20070417 Since this is being cached, should we be returning
182
# I would rather not, and instead just declare that users should not
183
# modify the return value.
186
def _gen_revno_map(self):
187
"""Create a new mapping from revision ids to dotted revnos.
189
Dotted revnos are generated based on the current tip in the revision
191
This is the worker function for get_revision_id_to_revno_map, which
192
just caches the return value.
194
:return: A dictionary mapping revision_id => dotted revno.
196
last_revision = self.last_revision()
197
revision_graph = repository._old_get_graph(self.repository,
199
merge_sorted_revisions = tsort.merge_sort(
204
revision_id_to_revno = dict((rev_id, revno)
205
for seq_num, rev_id, depth, revno, end_of_merge
206
in merge_sorted_revisions)
207
return revision_id_to_revno
209
def leave_lock_in_place(self):
210
"""Tell this branch object not to release the physical lock when this
213
If lock_write doesn't return a token, then this method is not supported.
215
self.control_files.leave_in_place()
217
def dont_leave_lock_in_place(self):
218
"""Tell this branch object to release the physical lock when this
219
object is unlocked, even if it didn't originally acquire it.
221
If lock_write doesn't return a token, then this method is not supported.
223
self.control_files.dont_leave_in_place()
225
@deprecated_method(deprecated_in((0, 16, 0)))
271
self._lock_mode = self._lock_count = None
226
273
def abspath(self, name):
227
"""Return absolute filename for something in the branch
229
XXX: Robert Collins 20051017 what is this used for? why is it a branch
230
method and not a tree method.
232
raise NotImplementedError(self.abspath)
234
def bind(self, other):
235
"""Bind the local branch the other branch.
237
:param other: The branch to bind to
240
raise errors.UpgradeRequired(self.base)
243
def fetch(self, from_branch, last_revision=None, pb=None):
244
"""Copy revisions from from_branch into this branch.
246
:param from_branch: Where to copy from.
247
:param last_revision: What revision to stop at (None for at the end
249
:param pb: An optional progress bar to use.
251
Returns the copied revision count and the failed revisions in a tuple:
254
if self.base == from_branch.base:
257
nested_pb = ui.ui_factory.nested_progress_bar()
262
from_branch.lock_read()
264
if last_revision is None:
265
pb.update('get source history')
266
last_revision = from_branch.last_revision()
267
last_revision = _mod_revision.ensure_null(last_revision)
268
return self.repository.fetch(from_branch.repository,
269
revision_id=last_revision,
272
if nested_pb is not None:
276
def get_bound_location(self):
277
"""Return the URL of the branch we are bound to.
279
Older format branches cannot bind, please be sure to use a metadir
284
def get_old_bound_location(self):
285
"""Return the URL of the branch we used to be bound to
287
raise errors.UpgradeRequired(self.base)
289
def get_commit_builder(self, parents, config=None, timestamp=None,
290
timezone=None, committer=None, revprops=None,
292
"""Obtain a CommitBuilder for this branch.
294
:param parents: Revision ids of the parents of the new revision.
295
:param config: Optional configuration to use.
296
:param timestamp: Optional timestamp recorded for commit.
297
:param timezone: Optional timezone for timestamp.
298
:param committer: Optional committer to set for commit.
299
:param revprops: Optional dictionary of revision properties.
300
:param revision_id: Optional revision id.
304
config = self.get_config()
306
return self.repository.get_commit_builder(self, parents, config,
307
timestamp, timezone, committer, revprops, revision_id)
309
def get_master_branch(self, possible_transports=None):
310
"""Return the branch we are bound to.
312
:return: Either a Branch, or None
274
"""Return absolute filename for something in the branch"""
275
return os.path.join(self.base, name)
277
def relpath(self, path):
278
"""Return path relative to this branch of something inside it.
280
Raises an error if path is not in this branch."""
281
return _relpath(self.base, path)
283
def controlfilename(self, file_or_path):
284
"""Return location relative to branch."""
285
if isinstance(file_or_path, basestring):
286
file_or_path = [file_or_path]
287
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
290
def controlfile(self, file_or_path, mode='r'):
291
"""Open a control file for this branch.
293
There are two classes of file in the control directory: text
294
and binary. binary files are untranslated byte streams. Text
295
control files are stored with Unix newlines and in UTF-8, even
296
if the platform or locale defaults are different.
298
Controlfiles should almost never be opened in write mode but
299
rather should be atomically copied and replaced using atomicfile.
302
fn = self.controlfilename(file_or_path)
304
if mode == 'rb' or mode == 'wb':
305
return file(fn, mode)
306
elif mode == 'r' or mode == 'w':
307
# open in binary mode anyhow so there's no newline translation;
308
# codecs uses line buffering by default; don't want that.
310
return codecs.open(fn, mode + 'b', 'utf-8',
313
raise BzrError("invalid controlfile mode %r" % mode)
315
def _make_control(self):
316
from bzrlib.inventory import Inventory
318
os.mkdir(self.controlfilename([]))
319
self.controlfile('README', 'w').write(
320
"This is a Bazaar-NG control directory.\n"
321
"Do not change any files in this directory.\n")
322
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
323
for d in ('text-store', 'inventory-store', 'revision-store'):
324
os.mkdir(self.controlfilename(d))
325
for f in ('revision-history', 'merged-patches',
326
'pending-merged-patches', 'branch-name',
329
self.controlfile(f, 'w').write('')
330
mutter('created control directory in ' + self.base)
332
# if we want per-tree root ids then this is the place to set
333
# them; they're not needed for now and so ommitted for
335
f = self.controlfile('inventory','w')
336
bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
339
def _check_format(self):
340
"""Check this branch format is supported.
342
The current tool only supports the current unstable format.
344
In the future, we might need different in-memory Branch
345
classes to support downlevel branches. But not yet.
347
# This ignores newlines so that we can open branches created
348
# on Windows from Linux and so on. I think it might be better
349
# to always make all internal files in unix format.
350
fmt = self.controlfile('branch-format', 'r').read()
351
fmt = fmt.replace('\r\n', '\n')
352
if fmt != BZR_BRANCH_FORMAT:
353
raise BzrError('sorry, branch format %r not supported' % fmt,
354
['use a different bzr version',
355
'or remove the .bzr directory and "bzr init" again'])
357
def get_root_id(self):
358
"""Return the id of this branches root"""
359
inv = self.read_working_inventory()
360
return inv.root.file_id
362
def set_root_id(self, file_id):
363
inv = self.read_working_inventory()
364
orig_root_id = inv.root.file_id
365
del inv._byid[inv.root.file_id]
366
inv.root.file_id = file_id
367
inv._byid[inv.root.file_id] = inv.root
370
if entry.parent_id in (None, orig_root_id):
371
entry.parent_id = inv.root.file_id
372
self._write_inventory(inv)
374
def read_working_inventory(self):
375
"""Read the working inventory."""
376
from bzrlib.inventory import Inventory
379
# ElementTree does its own conversion from UTF-8, so open in
381
f = self.controlfile('inventory', 'rb')
382
return bzrlib.xml.serializer_v4.read_inventory(f)
387
def _write_inventory(self, inv):
388
"""Update the working inventory.
390
That is to say, the inventory describing changes underway, that
391
will be committed to the next revision.
393
from bzrlib.atomicfile import AtomicFile
397
f = AtomicFile(self.controlfilename('inventory'), 'wb')
399
bzrlib.xml.serializer_v4.write_inventory(inv, f)
406
mutter('wrote working inventory')
409
inventory = property(read_working_inventory, _write_inventory, None,
410
"""Inventory for the working copy.""")
413
def add(self, files, ids=None):
414
"""Make files versioned.
416
Note that the command line normally calls smart_add instead,
417
which can automatically recurse.
419
This puts the files in the Added state, so that they will be
420
recorded by the next commit.
423
List of paths to add, relative to the base of the tree.
426
If set, use these instead of automatically generated ids.
427
Must be the same length as the list of files, but may
428
contain None for ids that are to be autogenerated.
430
TODO: Perhaps have an option to add the ids even if the files do
433
TODO: Perhaps yield the ids and paths as they're added.
435
# TODO: Re-adding a file that is removed in the working copy
436
# should probably put it back with the previous ID.
437
if isinstance(files, basestring):
438
assert(ids is None or isinstance(ids, basestring))
444
ids = [None] * len(files)
446
assert(len(ids) == len(files))
450
inv = self.read_working_inventory()
451
for f,file_id in zip(files, ids):
452
if is_control_file(f):
453
raise BzrError("cannot add control file %s" % quotefn(f))
458
raise BzrError("cannot add top-level %r" % f)
460
fullpath = os.path.normpath(self.abspath(f))
463
kind = file_kind(fullpath)
465
# maybe something better?
466
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
468
if kind != 'file' and kind != 'directory':
469
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
472
file_id = gen_file_id(f)
473
inv.add_path(f, kind=kind, file_id=file_id)
475
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
477
self._write_inventory(inv)
482
def print_file(self, file, revno):
483
"""Print `file` to stdout."""
486
tree = self.revision_tree(self.get_rev_id(revno))
487
# use inventory as it was in that revision
488
file_id = tree.inventory.path2id(file)
490
raise BzrError("%r is not present in revision %s" % (file, revno))
491
tree.print_file(file_id)
496
def remove(self, files, verbose=False):
497
"""Mark nominated files for removal from the inventory.
499
This does not remove their text. This does not run on
501
TODO: Refuse to remove modified files unless --force is given?
503
TODO: Do something useful with directories.
505
TODO: Should this remove the text or not? Tough call; not
506
removing may be useful and the user can just use use rm, and
507
is the opposite of add. Removing it is consistent with most
508
other tools. Maybe an option.
510
## TODO: Normalize names
511
## TODO: Remove nested loops; better scalability
512
if isinstance(files, basestring):
518
tree = self.working_tree()
521
# do this before any modifications
525
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
526
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
528
# having remove it, it must be either ignored or unknown
529
if tree.is_ignored(f):
533
show_status(new_status, inv[fid].kind, quotefn(f))
536
self._write_inventory(inv)
541
# FIXME: this doesn't need to be a branch method
542
def set_inventory(self, new_inventory_list):
543
from bzrlib.inventory import Inventory, InventoryEntry
544
inv = Inventory(self.get_root_id())
545
for path, file_id, parent, kind in new_inventory_list:
546
name = os.path.basename(path)
549
inv.add(InventoryEntry(file_id, name, kind, parent))
550
self._write_inventory(inv)
554
"""Return all unknown files.
556
These are files in the working directory that are not versioned or
557
control files or ignored.
559
>>> b = ScratchBranch(files=['foo', 'foo~'])
560
>>> list(b.unknowns())
563
>>> list(b.unknowns())
566
>>> list(b.unknowns())
569
return self.working_tree().unknowns()
572
def append_revision(self, *revision_ids):
573
from bzrlib.atomicfile import AtomicFile
575
for revision_id in revision_ids:
576
mutter("add {%s} to revision-history" % revision_id)
578
rev_history = self.revision_history()
579
rev_history.extend(revision_ids)
581
f = AtomicFile(self.controlfilename('revision-history'))
583
for rev_id in rev_history:
590
def get_revision_xml_file(self, revision_id):
591
"""Return XML file object for revision object."""
592
if not revision_id or not isinstance(revision_id, basestring):
593
raise InvalidRevisionId(revision_id)
598
return self.revision_store[revision_id]
599
except (IndexError, KeyError):
600
raise bzrlib.errors.NoSuchRevision(self, revision_id)
606
get_revision_xml = get_revision_xml_file
609
def get_revision(self, revision_id):
610
"""Return the Revision object for a named revision"""
611
xml_file = self.get_revision_xml_file(revision_id)
614
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
615
except SyntaxError, e:
616
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
620
assert r.revision_id == revision_id
316
624
def get_revision_delta(self, revno):
317
625
"""Return the delta for one revision.
667
1201
Zero (the NULL revision) is considered invalid
669
1203
if revno < 1 or revno > self.revno():
670
raise errors.InvalidRevisionNumber(revno)
673
def clone(self, to_bzrdir, revision_id=None):
674
"""Clone this branch into to_bzrdir preserving all semantic values.
676
revision_id: if not None, the revision history in the new branch will
677
be truncated to end with revision_id.
679
result = self._format.initialize(to_bzrdir)
680
self.copy_content_into(result, revision_id=revision_id)
684
def sprout(self, to_bzrdir, revision_id=None):
685
"""Create a new line of development from the branch, into to_bzrdir.
687
revision_id: if not None, the revision history in the new branch will
688
be truncated to end with revision_id.
690
result = self._format.initialize(to_bzrdir)
691
self.copy_content_into(result, revision_id=revision_id)
692
result.set_parent(self.bzrdir.root_transport.base)
695
def _synchronize_history(self, destination, revision_id):
696
"""Synchronize last revision and revision history between branches.
698
This version is most efficient when the destination is also a
699
BzrBranch5, but works for BzrBranch6 as long as the revision
700
history is the true lefthand parent history, and all of the revisions
701
are in the destination's repository. If not, set_revision_history
704
:param destination: The branch to copy the history into
705
:param revision_id: The revision-id to truncate history at. May
706
be None to copy complete history.
708
if revision_id == _mod_revision.NULL_REVISION:
710
new_history = self.revision_history()
711
if revision_id is not None and new_history != []:
713
new_history = new_history[:new_history.index(revision_id) + 1]
715
rev = self.repository.get_revision(revision_id)
716
new_history = rev.get_history(self.repository)[1:]
717
destination.set_revision_history(new_history)
720
def copy_content_into(self, destination, revision_id=None):
721
"""Copy the content of self into destination.
723
revision_id: if not None, the revision history in the new branch will
724
be truncated to end with revision_id.
726
self._synchronize_history(destination, revision_id)
728
parent = self.get_parent()
729
except errors.InaccessibleParent, e:
730
mutter('parent was not accessible to copy: %s', e)
733
destination.set_parent(parent)
734
self.tags.merge_to(destination.tags)
738
"""Check consistency of the branch.
740
In particular this checks that revisions given in the revision-history
741
do actually match up in the revision graph, and that they're all
742
present in the repository.
744
Callers will typically also want to check the repository.
746
:return: A BranchCheckResult.
748
mainline_parent_id = None
749
last_revno, last_revision_id = self.last_revision_info()
750
real_rev_history = list(self.repository.iter_reverse_revision_history(
752
real_rev_history.reverse()
753
if len(real_rev_history) != last_revno:
754
raise errors.BzrCheckError('revno does not match len(mainline)'
755
' %s != %s' % (last_revno, len(real_rev_history)))
756
# TODO: We should probably also check that real_rev_history actually
757
# matches self.revision_history()
758
for revision_id in real_rev_history:
760
revision = self.repository.get_revision(revision_id)
761
except errors.NoSuchRevision, e:
762
raise errors.BzrCheckError("mainline revision {%s} not in repository"
764
# In general the first entry on the revision history has no parents.
765
# But it's not illegal for it to have parents listed; this can happen
766
# in imports from Arch when the parents weren't reachable.
767
if mainline_parent_id is not None:
768
if mainline_parent_id not in revision.parent_ids:
769
raise errors.BzrCheckError("previous revision {%s} not listed among "
771
% (mainline_parent_id, revision_id))
772
mainline_parent_id = revision_id
773
return BranchCheckResult(self)
775
def _get_checkout_format(self):
776
"""Return the most suitable metadir for a checkout of this branch.
777
Weaves are used if this branch's repository uses weaves.
779
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
780
from bzrlib.repofmt import weaverepo
781
format = bzrdir.BzrDirMetaFormat1()
782
format.repository_format = weaverepo.RepositoryFormat7()
784
format = self.repository.bzrdir.checkout_metadir()
785
format.set_branch_format(self._format)
788
def create_checkout(self, to_location, revision_id=None,
789
lightweight=False, accelerator_tree=None,
791
"""Create a checkout of a branch.
793
:param to_location: The url to produce the checkout at
794
:param revision_id: The revision to check out
795
:param lightweight: If True, produce a lightweight checkout, otherwise,
796
produce a bound branch (heavyweight checkout)
797
:param accelerator_tree: A tree which can be used for retrieving file
798
contents more quickly than the revision tree, i.e. a workingtree.
799
The revision tree will be used for cases where accelerator_tree's
800
content is different.
801
:param hardlink: If true, hard-link files from accelerator_tree,
803
:return: The tree of the created checkout
805
t = transport.get_transport(to_location)
808
format = self._get_checkout_format()
809
checkout = format.initialize_on_transport(t)
810
from_branch = BranchReferenceFormat().initialize(checkout, self)
812
format = self._get_checkout_format()
813
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
814
to_location, force_new_tree=False, format=format)
815
checkout = checkout_branch.bzrdir
816
checkout_branch.bind(self)
817
# pull up to the specified revision_id to set the initial
818
# branch tip correctly, and seed it with history.
819
checkout_branch.pull(self, stop_revision=revision_id)
821
tree = checkout.create_workingtree(revision_id,
822
from_branch=from_branch,
823
accelerator_tree=accelerator_tree,
825
basis_tree = tree.basis_tree()
826
basis_tree.lock_read()
828
for path, file_id in basis_tree.iter_references():
829
reference_parent = self.reference_parent(file_id, path)
830
reference_parent.create_checkout(tree.abspath(path),
831
basis_tree.get_reference_revision(file_id, path),
838
def reconcile(self, thorough=True):
839
"""Make sure the data stored in this branch is consistent."""
840
from bzrlib.reconcile import BranchReconciler
841
reconciler = BranchReconciler(self, thorough=thorough)
842
reconciler.reconcile()
845
def reference_parent(self, file_id, path):
846
"""Return the parent branch for a tree-reference file_id
847
:param file_id: The file_id of the tree reference
848
:param path: The path of the file_id in the tree
849
:return: A branch associated with the file_id
851
# FIXME should provide multiple branches, based on config
852
return Branch.open(self.bzrdir.root_transport.clone(path).base)
854
def supports_tags(self):
855
return self._format.supports_tags()
858
class BranchFormat(object):
859
"""An encapsulation of the initialization and open routines for a format.
861
Formats provide three things:
862
* An initialization routine,
866
Formats are placed in an dict by their format string for reference
867
during branch opening. Its not required that these be instances, they
868
can be classes themselves with class methods - it simply depends on
869
whether state is needed for a given format or not.
871
Once a format is deprecated, just deprecate the initialize and open
872
methods on the format class. Do not deprecate the object, as the
873
object will be created every time regardless.
876
_default_format = None
877
"""The default format used for new branches."""
880
"""The known formats."""
882
def __eq__(self, other):
883
return self.__class__ is other.__class__
885
def __ne__(self, other):
886
return not (self == other)
889
def find_format(klass, a_bzrdir):
890
"""Return the format for the branch object in a_bzrdir."""
892
transport = a_bzrdir.get_branch_transport(None)
893
format_string = transport.get("format").read()
894
return klass._formats[format_string]
895
except errors.NoSuchFile:
896
raise errors.NotBranchError(path=transport.base)
898
raise errors.UnknownFormatError(format=format_string, kind='branch')
901
def get_default_format(klass):
902
"""Return the current default format."""
903
return klass._default_format
905
def get_reference(self, a_bzrdir):
906
"""Get the target reference of the branch in a_bzrdir.
908
format probing must have been completed before calling
909
this method - it is assumed that the format of the branch
910
in a_bzrdir is correct.
912
:param a_bzrdir: The bzrdir to get the branch data from.
913
:return: None if the branch is not a reference branch.
918
def set_reference(self, a_bzrdir, to_branch):
919
"""Set the target reference of the branch in a_bzrdir.
921
format probing must have been completed before calling
922
this method - it is assumed that the format of the branch
923
in a_bzrdir is correct.
925
:param a_bzrdir: The bzrdir to set the branch reference for.
926
:param to_branch: branch that the checkout is to reference
928
raise NotImplementedError(self.set_reference)
930
def get_format_string(self):
931
"""Return the ASCII format string that identifies this format."""
932
raise NotImplementedError(self.get_format_string)
934
def get_format_description(self):
935
"""Return the short format description for this format."""
936
raise NotImplementedError(self.get_format_description)
938
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
940
"""Initialize a branch in a bzrdir, with specified files
942
:param a_bzrdir: The bzrdir to initialize the branch in
943
:param utf8_files: The files to create as a list of
944
(filename, content) tuples
945
:param set_format: If True, set the format with
946
self.get_format_string. (BzrBranch4 has its format set
948
:return: a branch in this format
950
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
951
branch_transport = a_bzrdir.get_branch_transport(self)
953
'metadir': ('lock', lockdir.LockDir),
954
'branch4': ('branch-lock', lockable_files.TransportLock),
956
lock_name, lock_class = lock_map[lock_type]
957
control_files = lockable_files.LockableFiles(branch_transport,
958
lock_name, lock_class)
959
control_files.create_lock()
960
control_files.lock_write()
962
utf8_files += [('format', self.get_format_string())]
964
for (filename, content) in utf8_files:
965
branch_transport.put_bytes(
967
mode=a_bzrdir._get_file_mode())
969
control_files.unlock()
970
return self.open(a_bzrdir, _found=True)
972
def initialize(self, a_bzrdir):
973
"""Create a branch of this format in a_bzrdir."""
974
raise NotImplementedError(self.initialize)
976
def is_supported(self):
977
"""Is this format supported?
979
Supported formats can be initialized and opened.
980
Unsupported formats may not support initialization or committing or
981
some other features depending on the reason for not being supported.
985
def open(self, a_bzrdir, _found=False):
986
"""Return the branch object for a_bzrdir
988
_found is a private parameter, do not use it. It is used to indicate
989
if format probing has already be done.
991
raise NotImplementedError(self.open)
994
def register_format(klass, format):
995
klass._formats[format.get_format_string()] = format
998
def set_default_format(klass, format):
999
klass._default_format = format
1002
def unregister_format(klass, format):
1003
del klass._formats[format.get_format_string()]
1006
return self.get_format_string().rstrip()
1008
def supports_tags(self):
1009
"""True if this format supports tags stored in the branch"""
1010
return False # by default
1013
class BranchHooks(Hooks):
1014
"""A dictionary mapping hook name to a list of callables for branch hooks.
1016
e.g. ['set_rh'] Is the list of items to be called when the
1017
set_revision_history function is invoked.
1021
"""Create the default hooks.
1023
These are all empty initially, because by default nothing should get
1026
Hooks.__init__(self)
1027
# Introduced in 0.15:
1028
# invoked whenever the revision history has been set
1029
# with set_revision_history. The api signature is
1030
# (branch, revision_history), and the branch will
1033
# invoked after a push operation completes.
1034
# the api signature is
1036
# containing the members
1037
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1038
# where local is the local target branch or None, master is the target
1039
# master branch, and the rest should be self explanatory. The source
1040
# is read locked and the target branches write locked. Source will
1041
# be the local low-latency branch.
1042
self['post_push'] = []
1043
# invoked after a pull operation completes.
1044
# the api signature is
1046
# containing the members
1047
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1048
# where local is the local branch or None, master is the target
1049
# master branch, and the rest should be self explanatory. The source
1050
# is read locked and the target branches write locked. The local
1051
# branch is the low-latency branch.
1052
self['post_pull'] = []
1053
# invoked before a commit operation takes place.
1054
# the api signature is
1055
# (local, master, old_revno, old_revid, future_revno, future_revid,
1056
# tree_delta, future_tree).
1057
# old_revid is NULL_REVISION for the first commit to a branch
1058
# tree_delta is a TreeDelta object describing changes from the basis
1059
# revision, hooks MUST NOT modify this delta
1060
# future_tree is an in-memory tree obtained from
1061
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1062
self['pre_commit'] = []
1063
# invoked after a commit operation completes.
1064
# the api signature is
1065
# (local, master, old_revno, old_revid, new_revno, new_revid)
1066
# old_revid is NULL_REVISION for the first commit to a branch.
1067
self['post_commit'] = []
1068
# invoked after a uncommit operation completes.
1069
# the api signature is
1070
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1071
# local is the local branch or None, master is the target branch,
1072
# and an empty branch recieves new_revno of 0, new_revid of None.
1073
self['post_uncommit'] = []
1075
# Invoked after the tip of a branch changes.
1076
# the api signature is
1077
# (params) where params is a ChangeBranchTipParams with the members
1078
# (branch, old_revno, new_revno, old_revid, new_revid)
1079
self['post_change_branch_tip'] = []
1082
# install the default hooks into the Branch class.
1083
Branch.hooks = BranchHooks()
1086
class ChangeBranchTipParams(object):
1087
"""Object holding parameters passed to *_change_branch_tip hooks.
1089
There are 5 fields that hooks may wish to access:
1091
:ivar branch: the branch being changed
1092
:ivar old_revno: revision number before the change
1093
:ivar new_revno: revision number after the change
1094
:ivar old_revid: revision id before the change
1095
:ivar new_revid: revision id after the change
1097
The revid fields are strings. The revno fields are integers.
1100
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1101
"""Create a group of ChangeBranchTip parameters.
1103
:param branch: The branch being changed.
1104
:param old_revno: Revision number before the change.
1105
:param new_revno: Revision number after the change.
1106
:param old_revid: Tip revision id before the change.
1107
:param new_revid: Tip revision id after the change.
1109
self.branch = branch
1110
self.old_revno = old_revno
1111
self.new_revno = new_revno
1112
self.old_revid = old_revid
1113
self.new_revid = new_revid
1116
class BzrBranchFormat4(BranchFormat):
1117
"""Bzr branch format 4.
1120
- a revision-history file.
1121
- a branch-lock lock file [ to be shared with the bzrdir ]
1124
def get_format_description(self):
1125
"""See BranchFormat.get_format_description()."""
1126
return "Branch format 4"
1128
def initialize(self, a_bzrdir):
1129
"""Create a branch of this format in a_bzrdir."""
1130
utf8_files = [('revision-history', ''),
1131
('branch-name', ''),
1133
return self._initialize_helper(a_bzrdir, utf8_files,
1134
lock_type='branch4', set_format=False)
1137
super(BzrBranchFormat4, self).__init__()
1138
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1140
def open(self, a_bzrdir, _found=False):
1141
"""Return the branch object for a_bzrdir
1143
_found is a private parameter, do not use it. It is used to indicate
1144
if format probing has already be done.
1147
# we are being called directly and must probe.
1148
raise NotImplementedError
1149
return BzrBranch(_format=self,
1150
_control_files=a_bzrdir._control_files,
1152
_repository=a_bzrdir.open_repository())
1155
return "Bazaar-NG branch format 4"
1158
class BzrBranchFormat5(BranchFormat):
1159
"""Bzr branch format 5.
1162
- a revision-history file.
1164
- a lock dir guarding the branch itself
1165
- all of this stored in a branch/ subdirectory
1166
- works with shared repositories.
1168
This format is new in bzr 0.8.
1171
def get_format_string(self):
1172
"""See BranchFormat.get_format_string()."""
1173
return "Bazaar-NG branch format 5\n"
1175
def get_format_description(self):
1176
"""See BranchFormat.get_format_description()."""
1177
return "Branch format 5"
1179
def initialize(self, a_bzrdir):
1180
"""Create a branch of this format in a_bzrdir."""
1181
utf8_files = [('revision-history', ''),
1182
('branch-name', ''),
1184
return self._initialize_helper(a_bzrdir, utf8_files)
1187
super(BzrBranchFormat5, self).__init__()
1188
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1190
def open(self, a_bzrdir, _found=False):
1191
"""Return the branch object for a_bzrdir
1193
_found is a private parameter, do not use it. It is used to indicate
1194
if format probing has already be done.
1197
format = BranchFormat.find_format(a_bzrdir)
1198
if format.__class__ != self.__class__:
1199
raise AssertionError("wrong format %r found for %r" %
1202
transport = a_bzrdir.get_branch_transport(None)
1203
control_files = lockable_files.LockableFiles(transport, 'lock',
1205
return BzrBranch5(_format=self,
1206
_control_files=control_files,
1208
_repository=a_bzrdir.find_repository())
1209
except errors.NoSuchFile:
1210
raise errors.NotBranchError(path=transport.base)
1213
class BzrBranchFormat6(BzrBranchFormat5):
1214
"""Branch format with last-revision and tags.
1216
Unlike previous formats, this has no explicit revision history. Instead,
1217
this just stores the last-revision, and the left-hand history leading
1218
up to there is the history.
1220
This format was introduced in bzr 0.15
1221
and became the default in 0.91.
1224
def get_format_string(self):
1225
"""See BranchFormat.get_format_string()."""
1226
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1228
def get_format_description(self):
1229
"""See BranchFormat.get_format_description()."""
1230
return "Branch format 6"
1232
def initialize(self, a_bzrdir):
1233
"""Create a branch of this format in a_bzrdir."""
1234
utf8_files = [('last-revision', '0 null:\n'),
1235
('branch.conf', ''),
1238
return self._initialize_helper(a_bzrdir, utf8_files)
1240
def open(self, a_bzrdir, _found=False):
1241
"""Return the branch object for a_bzrdir
1243
_found is a private parameter, do not use it. It is used to indicate
1244
if format probing has already be done.
1247
format = BranchFormat.find_format(a_bzrdir)
1248
if format.__class__ != self.__class__:
1249
raise AssertionError("wrong format %r found for %r" %
1251
transport = a_bzrdir.get_branch_transport(None)
1252
control_files = lockable_files.LockableFiles(transport, 'lock',
1254
return BzrBranch6(_format=self,
1255
_control_files=control_files,
1257
_repository=a_bzrdir.find_repository())
1259
def supports_tags(self):
1263
class BranchReferenceFormat(BranchFormat):
1264
"""Bzr branch reference format.
1266
Branch references are used in implementing checkouts, they
1267
act as an alias to the real branch which is at some other url.
1274
def get_format_string(self):
1275
"""See BranchFormat.get_format_string()."""
1276
return "Bazaar-NG Branch Reference Format 1\n"
1278
def get_format_description(self):
1279
"""See BranchFormat.get_format_description()."""
1280
return "Checkout reference format 1"
1282
def get_reference(self, a_bzrdir):
1283
"""See BranchFormat.get_reference()."""
1284
transport = a_bzrdir.get_branch_transport(None)
1285
return transport.get('location').read()
1287
def set_reference(self, a_bzrdir, to_branch):
1288
"""See BranchFormat.set_reference()."""
1289
transport = a_bzrdir.get_branch_transport(None)
1290
location = transport.put_bytes('location', to_branch.base)
1292
def initialize(self, a_bzrdir, target_branch=None):
1293
"""Create a branch of this format in a_bzrdir."""
1294
if target_branch is None:
1295
# this format does not implement branch itself, thus the implicit
1296
# creation contract must see it as uninitializable
1297
raise errors.UninitializableFormat(self)
1298
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1299
branch_transport = a_bzrdir.get_branch_transport(self)
1300
branch_transport.put_bytes('location',
1301
target_branch.bzrdir.root_transport.base)
1302
branch_transport.put_bytes('format', self.get_format_string())
1304
a_bzrdir, _found=True,
1305
possible_transports=[target_branch.bzrdir.root_transport])
1308
super(BranchReferenceFormat, self).__init__()
1309
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1311
def _make_reference_clone_function(format, a_branch):
1312
"""Create a clone() routine for a branch dynamically."""
1313
def clone(to_bzrdir, revision_id=None):
1314
"""See Branch.clone()."""
1315
return format.initialize(to_bzrdir, a_branch)
1316
# cannot obey revision_id limits when cloning a reference ...
1317
# FIXME RBC 20060210 either nuke revision_id for clone, or
1318
# emit some sort of warning/error to the caller ?!
1321
def open(self, a_bzrdir, _found=False, location=None,
1322
possible_transports=None):
1323
"""Return the branch that the branch reference in a_bzrdir points at.
1325
_found is a private parameter, do not use it. It is used to indicate
1326
if format probing has already be done.
1329
format = BranchFormat.find_format(a_bzrdir)
1330
if format.__class__ != self.__class__:
1331
raise AssertionError("wrong format %r found for %r" %
1333
if location is None:
1334
location = self.get_reference(a_bzrdir)
1335
real_bzrdir = bzrdir.BzrDir.open(
1336
location, possible_transports=possible_transports)
1337
result = real_bzrdir.open_branch()
1338
# this changes the behaviour of result.clone to create a new reference
1339
# rather than a copy of the content of the branch.
1340
# I did not use a proxy object because that needs much more extensive
1341
# testing, and we are only changing one behaviour at the moment.
1342
# If we decide to alter more behaviours - i.e. the implicit nickname
1343
# then this should be refactored to introduce a tested proxy branch
1344
# and a subclass of that for use in overriding clone() and ....
1346
result.clone = self._make_reference_clone_function(result)
1350
# formats which have no format string are not discoverable
1351
# and not independently creatable, so are not registered.
1352
__format5 = BzrBranchFormat5()
1353
__format6 = BzrBranchFormat6()
1354
BranchFormat.register_format(__format5)
1355
BranchFormat.register_format(BranchReferenceFormat())
1356
BranchFormat.register_format(__format6)
1357
BranchFormat.set_default_format(__format6)
1358
_legacy_formats = [BzrBranchFormat4(),
1361
class BzrBranch(Branch):
1362
"""A branch stored in the actual filesystem.
1364
Note that it's "local" in the context of the filesystem; it doesn't
1365
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1366
it's writable, and can be accessed via the normal filesystem API.
1368
:ivar _transport: Transport for file operations on this branch's
1369
control files, typically pointing to the .bzr/branch directory.
1370
:ivar repository: Repository for this branch.
1371
:ivar base: The url of the base directory for this branch; the one
1372
containing the .bzr directory.
1375
def __init__(self, _format=None,
1376
_control_files=None, a_bzrdir=None, _repository=None):
1377
"""Create new branch object at a particular location."""
1378
Branch.__init__(self)
1379
if a_bzrdir is None:
1380
raise ValueError('a_bzrdir must be supplied')
1382
self.bzrdir = a_bzrdir
1383
self._base = self.bzrdir.transport.clone('..').base
1384
# XXX: We should be able to just do
1385
# self.base = self.bzrdir.root_transport.base
1386
# but this does not quite work yet -- mbp 20080522
1387
self._format = _format
1388
if _control_files is None:
1389
raise ValueError('BzrBranch _control_files is None')
1390
self.control_files = _control_files
1391
self._transport = _control_files._transport
1392
self.repository = _repository
1395
return '%s(%r)' % (self.__class__.__name__, self.base)
1399
def _get_base(self):
1400
"""Returns the directory containing the control directory."""
1403
base = property(_get_base, doc="The URL for the root of this branch.")
1405
@deprecated_method(deprecated_in((0, 16, 0)))
1406
def abspath(self, name):
1407
"""See Branch.abspath."""
1408
return self._transport.abspath(name)
1410
def is_locked(self):
1411
return self.control_files.is_locked()
1413
def lock_write(self, token=None):
1414
repo_token = self.repository.lock_write()
1416
token = self.control_files.lock_write(token=token)
1418
self.repository.unlock()
1422
def lock_read(self):
1423
self.repository.lock_read()
1425
self.control_files.lock_read()
1427
self.repository.unlock()
1431
# TODO: test for failed two phase locks. This is known broken.
1433
self.control_files.unlock()
1435
self.repository.unlock()
1436
if not self.control_files.is_locked():
1437
# we just released the lock
1438
self._clear_cached_state()
1440
def peek_lock_mode(self):
1441
if self.control_files._lock_count == 0:
1444
return self.control_files._lock_mode
1446
def get_physical_lock_status(self):
1447
return self.control_files.get_physical_lock_status()
1450
def print_file(self, file, revision_id):
1451
"""See Branch.print_file."""
1452
return self.repository.print_file(file, revision_id)
1454
def _write_revision_history(self, history):
1455
"""Factored out of set_revision_history.
1457
This performs the actual writing to disk.
1458
It is intended to be called by BzrBranch5.set_revision_history."""
1459
self._transport.put_bytes(
1460
'revision-history', '\n'.join(history),
1461
mode=self.bzrdir._get_file_mode())
1464
def set_revision_history(self, rev_history):
1465
"""See Branch.set_revision_history."""
1466
if 'evil' in debug.debug_flags:
1467
mutter_callsite(3, "set_revision_history scales with history.")
1468
self._write_revision_history(rev_history)
1469
self._clear_cached_state()
1470
self._cache_revision_history(rev_history)
1471
for hook in Branch.hooks['set_rh']:
1472
hook(self, rev_history)
1474
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1475
"""Run the post_change_branch_tip hooks."""
1476
hooks = Branch.hooks['post_change_branch_tip']
1479
new_revno, new_revid = self.last_revision_info()
1480
params = ChangeBranchTipParams(
1481
self, old_revno, new_revno, old_revid, new_revid)
1486
def set_last_revision_info(self, revno, revision_id):
1487
"""Set the last revision of this branch.
1489
The caller is responsible for checking that the revno is correct
1490
for this revision id.
1492
It may be possible to set the branch last revision to an id not
1493
present in the repository. However, branches can also be
1494
configured to check constraints on history, in which case this may not
1497
revision_id = _mod_revision.ensure_null(revision_id)
1498
old_revno, old_revid = self.last_revision_info()
1499
# this old format stores the full history, but this api doesn't
1500
# provide it, so we must generate, and might as well check it's
1502
history = self._lefthand_history(revision_id)
1503
if len(history) != revno:
1504
raise AssertionError('%d != %d' % (len(history), revno))
1505
self.set_revision_history(history)
1506
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1508
def _gen_revision_history(self):
1509
history = self._transport.get_bytes('revision-history').split('\n')
1510
if history[-1:] == ['']:
1511
# There shouldn't be a trailing newline, but just in case.
1515
def _lefthand_history(self, revision_id, last_rev=None,
1517
if 'evil' in debug.debug_flags:
1518
mutter_callsite(4, "_lefthand_history scales with history.")
1519
# stop_revision must be a descendant of last_revision
1520
graph = self.repository.get_graph()
1521
if last_rev is not None:
1522
if not graph.is_ancestor(last_rev, revision_id):
1523
# our previous tip is not merged into stop_revision
1524
raise errors.DivergedBranches(self, other_branch)
1525
# make a new revision history from the graph
1526
parents_map = graph.get_parent_map([revision_id])
1527
if revision_id not in parents_map:
1528
raise errors.NoSuchRevision(self, revision_id)
1529
current_rev_id = revision_id
1531
# Do not include ghosts or graph origin in revision_history
1532
while (current_rev_id in parents_map and
1533
len(parents_map[current_rev_id]) > 0):
1534
new_history.append(current_rev_id)
1535
current_rev_id = parents_map[current_rev_id][0]
1536
parents_map = graph.get_parent_map([current_rev_id])
1537
new_history.reverse()
1541
def generate_revision_history(self, revision_id, last_rev=None,
1543
"""Create a new revision history that will finish with revision_id.
1545
:param revision_id: the new tip to use.
1546
:param last_rev: The previous last_revision. If not None, then this
1547
must be a ancestory of revision_id, or DivergedBranches is raised.
1548
:param other_branch: The other branch that DivergedBranches should
1549
raise with respect to.
1551
self.set_revision_history(self._lefthand_history(revision_id,
1552
last_rev, other_branch))
1554
def basis_tree(self):
1555
"""See Branch.basis_tree."""
1556
return self.repository.revision_tree(self.last_revision())
1559
def pull(self, source, overwrite=False, stop_revision=None,
1560
_hook_master=None, run_hooks=True, possible_transports=None):
1563
:param _hook_master: Private parameter - set the branch to
1564
be supplied as the master to push hooks.
1565
:param run_hooks: Private parameter - if false, this branch
1566
is being called because it's the master of the primary branch,
1567
so it should not run its hooks.
1569
result = PullResult()
1570
result.source_branch = source
1571
result.target_branch = self
1574
# We assume that during 'pull' the local repository is closer than
1576
graph = self.repository.get_graph(source.repository)
1577
result.old_revno, result.old_revid = self.last_revision_info()
1578
self.update_revisions(source, stop_revision, overwrite=overwrite,
1580
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1581
result.new_revno, result.new_revid = self.last_revision_info()
1583
result.master_branch = _hook_master
1584
result.local_branch = self
1586
result.master_branch = self
1587
result.local_branch = None
1589
for hook in Branch.hooks['post_pull']:
1595
def _get_parent_location(self):
1596
_locs = ['parent', 'pull', 'x-pull']
1599
return self._transport.get_bytes(l).strip('\n')
1600
except errors.NoSuchFile:
1605
def push(self, target, overwrite=False, stop_revision=None,
1606
_override_hook_source_branch=None):
1609
This is the basic concrete implementation of push()
1611
:param _override_hook_source_branch: If specified, run
1612
the hooks passing this Branch as the source, rather than self.
1613
This is for use of RemoteBranch, where push is delegated to the
1614
underlying vfs-based Branch.
1616
# TODO: Public option to disable running hooks - should be trivial but
1620
result = self._push_with_bound_branches(target, overwrite,
1622
_override_hook_source_branch=_override_hook_source_branch)
1627
def _push_with_bound_branches(self, target, overwrite,
1629
_override_hook_source_branch=None):
1630
"""Push from self into target, and into target's master if any.
1632
This is on the base BzrBranch class even though it doesn't support
1633
bound branches because the *target* might be bound.
1636
if _override_hook_source_branch:
1637
result.source_branch = _override_hook_source_branch
1638
for hook in Branch.hooks['post_push']:
1641
bound_location = target.get_bound_location()
1642
if bound_location and target.base != bound_location:
1643
# there is a master branch.
1645
# XXX: Why the second check? Is it even supported for a branch to
1646
# be bound to itself? -- mbp 20070507
1647
master_branch = target.get_master_branch()
1648
master_branch.lock_write()
1650
# push into the master from this branch.
1651
self._basic_push(master_branch, overwrite, stop_revision)
1652
# and push into the target branch from this. Note that we push from
1653
# this branch again, because its considered the highest bandwidth
1655
result = self._basic_push(target, overwrite, stop_revision)
1656
result.master_branch = master_branch
1657
result.local_branch = target
1661
master_branch.unlock()
1664
result = self._basic_push(target, overwrite, stop_revision)
1665
# TODO: Why set master_branch and local_branch if there's no
1666
# binding? Maybe cleaner to just leave them unset? -- mbp
1668
result.master_branch = target
1669
result.local_branch = None
1673
def _basic_push(self, target, overwrite, stop_revision):
1674
"""Basic implementation of push without bound branches or hooks.
1676
Must be called with self read locked and target write locked.
1678
result = PushResult()
1679
result.source_branch = self
1680
result.target_branch = target
1681
result.old_revno, result.old_revid = target.last_revision_info()
1683
# We assume that during 'push' this repository is closer than
1685
graph = self.repository.get_graph(target.repository)
1686
target.update_revisions(self, stop_revision, overwrite=overwrite,
1688
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1689
result.new_revno, result.new_revid = target.last_revision_info()
1692
def get_parent(self):
1693
"""See Branch.get_parent."""
1694
parent = self._get_parent_location()
1697
# This is an old-format absolute path to a local branch
1698
# turn it into a url
1699
if parent.startswith('/'):
1700
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1702
return urlutils.join(self.base[:-1], parent)
1703
except errors.InvalidURLJoin, e:
1704
raise errors.InaccessibleParent(parent, self.base)
1706
def set_push_location(self, location):
1707
"""See Branch.set_push_location."""
1708
self.get_config().set_user_option(
1709
'push_location', location,
1710
store=_mod_config.STORE_LOCATION_NORECURSE)
1713
def set_parent(self, url):
1714
"""See Branch.set_parent."""
1715
# TODO: Maybe delete old location files?
1716
# URLs should never be unicode, even on the local fs,
1717
# FIXUP this and get_parent in a future branch format bump:
1718
# read and rewrite the file. RBC 20060125
1720
if isinstance(url, unicode):
1722
url = url.encode('ascii')
1723
except UnicodeEncodeError:
1724
raise errors.InvalidURL(url,
1725
"Urls must be 7-bit ascii, "
1726
"use bzrlib.urlutils.escape")
1727
url = urlutils.relative_url(self.base, url)
1728
self._set_parent_location(url)
1730
def _set_parent_location(self, url):
1732
self._transport.delete('parent')
1734
self._transport.put_bytes('parent', url + '\n',
1735
mode=self.bzrdir._get_file_mode())
1738
class BzrBranch5(BzrBranch):
1739
"""A format 5 branch. This supports new features over plain branches.
1741
It has support for a master_branch which is the data for bound branches.
1749
super(BzrBranch5, self).__init__(_format=_format,
1750
_control_files=_control_files,
1752
_repository=_repository)
1755
def pull(self, source, overwrite=False, stop_revision=None,
1756
run_hooks=True, possible_transports=None):
1757
"""Pull from source into self, updating my master if any.
1759
:param run_hooks: Private parameter - if false, this branch
1760
is being called because it's the master of the primary branch,
1761
so it should not run its hooks.
1763
bound_location = self.get_bound_location()
1764
master_branch = None
1765
if bound_location and source.base != bound_location:
1766
# not pulling from master, so we need to update master.
1767
master_branch = self.get_master_branch(possible_transports)
1768
master_branch.lock_write()
1771
# pull from source into master.
1772
master_branch.pull(source, overwrite, stop_revision,
1774
return super(BzrBranch5, self).pull(source, overwrite,
1775
stop_revision, _hook_master=master_branch,
1776
run_hooks=run_hooks)
1779
master_branch.unlock()
1781
def get_bound_location(self):
1783
return self._transport.get_bytes('bound')[:-1]
1784
except errors.NoSuchFile:
1788
def get_master_branch(self, possible_transports=None):
1789
"""Return the branch we are bound to.
1791
:return: Either a Branch, or None
1793
This could memoise the branch, but if thats done
1794
it must be revalidated on each new lock.
1795
So for now we just don't memoise it.
1796
# RBC 20060304 review this decision.
1798
bound_loc = self.get_bound_location()
1802
return Branch.open(bound_loc,
1803
possible_transports=possible_transports)
1804
except (errors.NotBranchError, errors.ConnectionError), e:
1805
raise errors.BoundBranchConnectionFailure(
1809
def set_bound_location(self, location):
1810
"""Set the target where this branch is bound to.
1812
:param location: URL to the target branch
1815
self._transport.put_bytes('bound', location+'\n',
1816
mode=self.bzrdir._get_file_mode())
1819
self._transport.delete('bound')
1820
except errors.NoSuchFile:
1204
raise InvalidRevisionNumber(revno)
1210
class ScratchBranch(LocalBranch):
1211
"""Special test class: a branch that cleans up after itself.
1213
>>> b = ScratchBranch()
1221
def __init__(self, files=[], dirs=[], base=None):
1222
"""Make a test branch.
1224
This creates a temporary directory and runs init-tree in it.
1226
If any files are listed, they are created in the working copy.
1228
from tempfile import mkdtemp
1233
LocalBranch.__init__(self, base, init=init)
1235
os.mkdir(self.abspath(d))
1238
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1243
>>> orig = ScratchBranch(files=["file1", "file2"])
1244
>>> clone = orig.clone()
1245
>>> os.path.samefile(orig.base, clone.base)
1247
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1250
from shutil import copytree
1251
from tempfile import mkdtemp
1254
copytree(self.base, base, symlinks=True)
1255
return ScratchBranch(base=base)
1263
"""Destroy the test branch, removing the scratch directory."""
1264
from shutil import rmtree
1267
mutter("delete ScratchBranch %s" % self.base)
1270
# Work around for shutil.rmtree failing on Windows when
1271
# readonly files are encountered
1272
mutter("hit exception in destroying ScratchBranch: %s" % e)
1273
for root, dirs, files in os.walk(self.base, topdown=False):
1275
os.chmod(os.path.join(root, name), 0700)
1281
######################################################################
1285
def is_control_file(filename):
1286
## FIXME: better check
1287
filename = os.path.normpath(filename)
1288
while filename != '':
1289
head, tail = os.path.split(filename)
1290
## mutter('check %r for control file' % ((head, tail), ))
1291
if tail == bzrlib.BZRDIR:
1825
def bind(self, other):
1826
"""Bind this branch to the branch other.
1828
This does not push or pull data between the branches, though it does
1829
check for divergence to raise an error when the branches are not
1830
either the same, or one a prefix of the other. That behaviour may not
1831
be useful, so that check may be removed in future.
1833
:param other: The branch to bind to
1836
# TODO: jam 20051230 Consider checking if the target is bound
1837
# It is debatable whether you should be able to bind to
1838
# a branch which is itself bound.
1839
# Committing is obviously forbidden,
1840
# but binding itself may not be.
1841
# Since we *have* to check at commit time, we don't
1842
# *need* to check here
1844
# we want to raise diverged if:
1845
# last_rev is not in the other_last_rev history, AND
1846
# other_last_rev is not in our history, and do it without pulling
1848
self.set_bound_location(other.base)
1852
"""If bound, unbind"""
1853
return self.set_bound_location(None)
1856
def update(self, possible_transports=None):
1857
"""Synchronise this branch with the master branch if any.
1859
:return: None or the last_revision that was pivoted out during the
1862
master = self.get_master_branch(possible_transports)
1863
if master is not None:
1864
old_tip = _mod_revision.ensure_null(self.last_revision())
1865
self.pull(master, overwrite=True)
1866
if self.repository.get_graph().is_ancestor(old_tip,
1867
_mod_revision.ensure_null(self.last_revision())):
1873
class BzrBranch6(BzrBranch5):
1875
def __init__(self, *args, **kwargs):
1876
super(BzrBranch6, self).__init__(*args, **kwargs)
1877
self._last_revision_info_cache = None
1878
self._partial_revision_history_cache = []
1880
def _clear_cached_state(self):
1881
super(BzrBranch6, self)._clear_cached_state()
1882
self._last_revision_info_cache = None
1883
self._partial_revision_history_cache = []
1886
def last_revision_info(self):
1887
"""Return information about the last revision.
1889
:return: A tuple (revno, revision_id).
1891
if self._last_revision_info_cache is None:
1892
self._last_revision_info_cache = self._last_revision_info()
1893
return self._last_revision_info_cache
1895
def _last_revision_info(self):
1896
revision_string = self._transport.get_bytes('last-revision')
1897
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1898
revision_id = cache_utf8.get_cached_utf8(revision_id)
1900
return revno, revision_id
1902
def _write_last_revision_info(self, revno, revision_id):
1903
"""Simply write out the revision id, with no checks.
1905
Use set_last_revision_info to perform this safely.
1907
Does not update the revision_history cache.
1908
Intended to be called by set_last_revision_info and
1909
_write_revision_history.
1911
revision_id = _mod_revision.ensure_null(revision_id)
1912
out_string = '%d %s\n' % (revno, revision_id)
1913
self._transport.put_bytes('last-revision', out_string,
1914
mode=self.bzrdir._get_file_mode())
1917
def set_last_revision_info(self, revno, revision_id):
1918
revision_id = _mod_revision.ensure_null(revision_id)
1919
old_revno, old_revid = self.last_revision_info()
1920
if self._get_append_revisions_only():
1921
self._check_history_violation(revision_id)
1922
self._write_last_revision_info(revno, revision_id)
1923
self._clear_cached_state()
1924
self._last_revision_info_cache = revno, revision_id
1925
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1927
def _check_history_violation(self, revision_id):
1928
last_revision = _mod_revision.ensure_null(self.last_revision())
1929
if _mod_revision.is_null(last_revision):
1931
if last_revision not in self._lefthand_history(revision_id):
1932
raise errors.AppendRevisionsOnlyViolation(self.base)
1934
def _gen_revision_history(self):
1935
"""Generate the revision history from last revision
1937
self._extend_partial_history()
1938
return list(reversed(self._partial_revision_history_cache))
1940
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1941
"""Extend the partial history to include a given index
1943
If a stop_index is supplied, stop when that index has been reached.
1944
If a stop_revision is supplied, stop when that revision is
1945
encountered. Otherwise, stop when the beginning of history is
1948
:param stop_index: The index which should be present. When it is
1949
present, history extension will stop.
1950
:param revision_id: The revision id which should be present. When
1951
it is encountered, history extension will stop.
1953
repo = self.repository
1954
if len(self._partial_revision_history_cache) == 0:
1955
iterator = repo.iter_reverse_revision_history(self.last_revision())
1957
start_revision = self._partial_revision_history_cache[-1]
1958
iterator = repo.iter_reverse_revision_history(start_revision)
1959
#skip the last revision in the list
1960
next_revision = iterator.next()
1961
for revision_id in iterator:
1962
self._partial_revision_history_cache.append(revision_id)
1963
if (stop_index is not None and
1964
len(self._partial_revision_history_cache) > stop_index):
1966
if revision_id == stop_revision:
1969
def _write_revision_history(self, history):
1970
"""Factored out of set_revision_history.
1972
This performs the actual writing to disk, with format-specific checks.
1973
It is intended to be called by BzrBranch5.set_revision_history.
1975
if len(history) == 0:
1976
last_revision = 'null:'
1978
if history != self._lefthand_history(history[-1]):
1979
raise errors.NotLefthandHistory(history)
1980
last_revision = history[-1]
1981
if self._get_append_revisions_only():
1982
self._check_history_violation(last_revision)
1983
self._write_last_revision_info(len(history), last_revision)
1986
def _set_parent_location(self, url):
1987
"""Set the parent branch"""
1988
self._set_config_location('parent_location', url, make_relative=True)
1991
def _get_parent_location(self):
1992
"""Set the parent branch"""
1993
return self._get_config_location('parent_location')
1995
def set_push_location(self, location):
1996
"""See Branch.set_push_location."""
1997
self._set_config_location('push_location', location)
1999
def set_bound_location(self, location):
2000
"""See Branch.set_push_location."""
2002
config = self.get_config()
2003
if location is None:
2004
if config.get_user_option('bound') != 'True':
2007
config.set_user_option('bound', 'False', warn_masked=True)
2010
self._set_config_location('bound_location', location,
2012
config.set_user_option('bound', 'True', warn_masked=True)
2015
def _get_bound_location(self, bound):
2016
"""Return the bound location in the config file.
2018
Return None if the bound parameter does not match"""
2019
config = self.get_config()
2020
config_bound = (config.get_user_option('bound') == 'True')
2021
if config_bound != bound:
2023
return self._get_config_location('bound_location', config=config)
2025
def get_bound_location(self):
2026
"""See Branch.set_push_location."""
2027
return self._get_bound_location(True)
2029
def get_old_bound_location(self):
2030
"""See Branch.get_old_bound_location"""
2031
return self._get_bound_location(False)
2033
def set_append_revisions_only(self, enabled):
2038
self.get_config().set_user_option('append_revisions_only', value,
2041
def _get_append_revisions_only(self):
2042
value = self.get_config().get_user_option('append_revisions_only')
2043
return value == 'True'
2045
def _synchronize_history(self, destination, revision_id):
2046
"""Synchronize last revision and revision history between branches.
2048
This version is most efficient when the destination is also a
2049
BzrBranch6, but works for BzrBranch5, as long as the destination's
2050
repository contains all the lefthand ancestors of the intended
2051
last_revision. If not, set_last_revision_info will fail.
2053
:param destination: The branch to copy the history into
2054
:param revision_id: The revision-id to truncate history at. May
2055
be None to copy complete history.
2057
source_revno, source_revision_id = self.last_revision_info()
2058
if revision_id is None:
2059
revno, revision_id = source_revno, source_revision_id
2060
elif source_revision_id == revision_id:
2061
# we know the revno without needing to walk all of history
2062
revno = source_revno
2064
# To figure out the revno for a random revision, we need to build
2065
# the revision history, and count its length.
2066
# We don't care about the order, just how long it is.
2067
# Alternatively, we could start at the current location, and count
2068
# backwards. But there is no guarantee that we will find it since
2069
# it may be a merged revision.
2070
revno = len(list(self.repository.iter_reverse_revision_history(
2072
destination.set_last_revision_info(revno, revision_id)
2074
def _make_tags(self):
2075
return BasicTags(self)
2078
def generate_revision_history(self, revision_id, last_rev=None,
2080
"""See BzrBranch5.generate_revision_history"""
2081
history = self._lefthand_history(revision_id, last_rev, other_branch)
2082
revno = len(history)
2083
self.set_last_revision_info(revno, revision_id)
2086
def get_rev_id(self, revno, history=None):
2087
"""Find the revision id of the specified revno."""
2089
return _mod_revision.NULL_REVISION
2091
last_revno, last_revision_id = self.last_revision_info()
2092
if revno <= 0 or revno > last_revno:
2093
raise errors.NoSuchRevision(self, revno)
2095
if history is not None:
2096
return history[revno - 1]
2098
index = last_revno - revno
2099
if len(self._partial_revision_history_cache) <= index:
2100
self._extend_partial_history(stop_index=index)
2101
if len(self._partial_revision_history_cache) > index:
2102
return self._partial_revision_history_cache[index]
2104
raise errors.NoSuchRevision(self, revno)
2107
def revision_id_to_revno(self, revision_id):
2108
"""Given a revision id, return its revno"""
2109
if _mod_revision.is_null(revision_id):
2112
index = self._partial_revision_history_cache.index(revision_id)
2114
self._extend_partial_history(stop_revision=revision_id)
2115
index = len(self._partial_revision_history_cache) - 1
2116
if self._partial_revision_history_cache[index] != revision_id:
2117
raise errors.NoSuchRevision(self, revision_id)
2118
return self.revno() - index
2121
######################################################################
2122
# results of operations
2125
class _Result(object):
2127
def _show_tag_conficts(self, to_file):
2128
if not getattr(self, 'tag_conflicts', None):
2130
to_file.write('Conflicting tags:\n')
2131
for name, value1, value2 in self.tag_conflicts:
2132
to_file.write(' %s\n' % (name, ))
2135
class PullResult(_Result):
2136
"""Result of a Branch.pull operation.
2138
:ivar old_revno: Revision number before pull.
2139
:ivar new_revno: Revision number after pull.
2140
:ivar old_revid: Tip revision id before pull.
2141
:ivar new_revid: Tip revision id after pull.
2142
:ivar source_branch: Source (local) branch object.
2143
:ivar master_branch: Master branch of the target, or the target if no
2145
:ivar local_branch: target branch if there is a Master, else None
2146
:ivar target_branch: Target/destination branch object.
2147
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2151
# DEPRECATED: pull used to return the change in revno
2152
return self.new_revno - self.old_revno
2154
def report(self, to_file):
2156
if self.old_revid == self.new_revid:
2157
to_file.write('No revisions to pull.\n')
2159
to_file.write('Now on revision %d.\n' % self.new_revno)
2160
self._show_tag_conficts(to_file)
2163
class PushResult(_Result):
2164
"""Result of a Branch.push operation.
2166
:ivar old_revno: Revision number before push.
2167
:ivar new_revno: Revision number after push.
2168
:ivar old_revid: Tip revision id before push.
2169
:ivar new_revid: Tip revision id after push.
2170
:ivar source_branch: Source branch object.
2171
:ivar master_branch: Master branch of the target, or None.
2172
:ivar target_branch: Target/destination branch object.
2176
# DEPRECATED: push used to return the change in revno
2177
return self.new_revno - self.old_revno
2179
def report(self, to_file):
2180
"""Write a human-readable description of the result."""
2181
if self.old_revid == self.new_revid:
2182
to_file.write('No new revisions to push.\n')
2184
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2185
self._show_tag_conficts(to_file)
2188
class BranchCheckResult(object):
2189
"""Results of checking branch consistency.
2194
def __init__(self, branch):
2195
self.branch = branch
2197
def report_results(self, verbose):
2198
"""Report the check results via trace.note.
2200
:param verbose: Requests more detailed display of what was checked,
2203
note('checked branch %s format %s',
2205
self.branch._format)
2208
class Converter5to6(object):
2209
"""Perform an in-place upgrade of format 5 to format 6"""
2211
def convert(self, branch):
2212
# Data for 5 and 6 can peacefully coexist.
2213
format = BzrBranchFormat6()
2214
new_branch = format.open(branch.bzrdir, _found=True)
2216
# Copy source data into target
2217
new_branch._write_last_revision_info(*branch.last_revision_info())
2218
new_branch.set_parent(branch.get_parent())
2219
new_branch.set_bound_location(branch.get_bound_location())
2220
new_branch.set_push_location(branch.get_push_location())
2222
# New branch has no tags by default
2223
new_branch.tags._set_tag_dict({})
2225
# Copying done; now update target format
2226
new_branch._transport.put_bytes('format',
2227
format.get_format_string(),
2228
mode=new_branch.bzrdir._get_file_mode())
2230
# Clean up old files
2231
new_branch._transport.delete('revision-history')
2233
branch.set_parent(None)
2234
except errors.NoSuchFile:
2236
branch.set_bound_location(None)
1293
if filename == head:
1300
def gen_file_id(name):
1301
"""Return new file id.
1303
This should probably generate proper UUIDs, but for the moment we
1304
cope with just randomness because running uuidgen every time is
1307
from binascii import hexlify
1308
from time import time
1310
# get last component
1311
idx = name.rfind('/')
1313
name = name[idx+1 : ]
1314
idx = name.rfind('\\')
1316
name = name[idx+1 : ]
1318
# make it not a hidden file
1319
name = name.lstrip('.')
1321
# remove any wierd characters; we don't escape them but rather
1322
# just pull them out
1323
name = re.sub(r'[^\w.]', '', name)
1325
s = hexlify(rand_bytes(8))
1326
return '-'.join((name, compact_date(time()), s))
1330
"""Return a new tree-root file id."""
1331
return gen_file_id('TREE_ROOT')
1334
def copy_branch(branch_from, to_location, revision=None):
1335
"""Copy branch_from into the existing directory to_location.
1338
If not None, only revisions up to this point will be copied.
1339
The head of the new branch will be that revision.
1342
The name of a local directory that exists but is empty.
1344
from bzrlib.merge import merge
1345
from bzrlib.revisionspec import RevisionSpec
1347
assert isinstance(branch_from, Branch)
1348
assert isinstance(to_location, basestring)
1350
br_to = Branch.initialize(to_location)
1351
br_to.set_root_id(branch_from.get_root_id())
1352
if revision is None:
1353
revno = branch_from.revno()
1355
revno, rev_id = RevisionSpec(revision).in_history(branch_from)
1356
br_to.update_revisions(branch_from, stop_revision=revno)
1357
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1358
check_clean=False, ignore_zero=True)
1359
br_to.set_parent(branch_from.base)
added
removed
bzrlib/branch.py
