70
102
Base directory/url of the branch.
72
hooks: An instance of BranchHooks.
74
# this is really an instance variable - FIXME move it there
78
# override this to set the strategy for storing tags
80
return DisabledTags(self)
82
106
def __init__(self, *ignored, **ignored_too):
83
self.tags = self._make_tags()
84
self._revision_history_cache = None
85
self._revision_id_to_revno_cache = None
88
"""Break a lock if one is present from another instance.
90
Uses the ui factory to ask for confirmation if the lock may be from
93
This will probe the repository for its lock as well.
95
self.control_files.break_lock()
96
self.repository.break_lock()
97
master = self.get_master_branch()
98
if master is not None:
102
def open(base, _unsupported=False, possible_transports=None):
103
"""Open the branch rooted at base.
105
For instance, if the branch is at URL/.bzr/branch,
106
Branch.open(URL) -> a Branch instance.
108
control = bzrdir.BzrDir.open(base, _unsupported,
109
possible_transports=possible_transports)
110
return control.open_branch(_unsupported)
113
def open_from_transport(transport, _unsupported=False):
114
"""Open the branch rooted at transport"""
115
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
116
return control.open_branch(_unsupported)
119
def open_containing(url, possible_transports=None):
107
raise NotImplementedError('The Branch class is abstract')
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format.
113
Only local branches are supported."""
114
return _Branch(get_transport(base), relax_version_check=True)
118
"""Open an existing branch, rooted at 'base' (url)"""
119
t = get_transport(base)
120
mutter("trying to open %r with transport %r", base, t)
124
def open_containing(url):
120
125
"""Open an existing branch which contains url.
122
127
This probes for a branch at url, and searches upwards from there.
124
129
Basically we keep looking up until we find the control directory or
125
130
run into the root. If there isn't one, raises NotBranchError.
126
If there is one and it is either an unrecognised format or an unsupported
127
format, UnknownFormatError or UnsupportedFormatError are raised.
128
131
If there is one, it is returned, along with the unused portion of url.
130
control, relpath = bzrdir.BzrDir.open_containing(url,
132
return control.open_branch(), relpath
134
def get_config(self):
135
return BranchConfig(self)
138
return self.get_config().get_nickname()
140
def _set_nick(self, nick):
141
self.get_config().set_user_option('nickname', nick, warn_masked=True)
143
nick = property(_get_nick, _set_nick)
146
raise NotImplementedError(self.is_locked)
133
t = get_transport(url)
136
return _Branch(t), t.relpath(url)
137
except NotBranchError:
139
new_t = t.clone('..')
140
if new_t.base == t.base:
141
# reached the root, whatever that may be
142
raise NotBranchError(path=url)
146
def initialize(base):
147
"""Create a new branch, rooted at 'base' (url)"""
148
t = get_transport(base)
149
return _Branch(t, init=True)
151
def setup_caching(self, cache_root):
152
"""Subclasses that care about caching should override this, and set
153
up cached stores located under cache_root.
155
self.cache_root = cache_root
158
class _Branch(Branch):
159
"""A branch stored in the actual filesystem.
161
Note that it's "local" in the context of the filesystem; it doesn't
162
really matter if it's on an nfs/smb/afs/coda/... share, as long as
163
it's writable, and can be accessed via the normal filesystem API.
169
If _lock_mode is true, a positive count of the number of times the
173
Lock object from bzrlib.lock.
175
# We actually expect this class to be somewhat short-lived; part of its
176
# purpose is to try to isolate what bits of the branch logic are tied to
177
# filesystem access, so that in a later step, we can extricate them to
178
# a separarte ("storage") class.
182
_inventory_weave = None
184
# Map some sort of prefix into a namespace
185
# stuff like "revno:10", "revid:", etc.
186
# This should match a prefix with a function which accepts
187
REVISION_NAMESPACES = {}
189
def push_stores(self, branch_to):
190
"""Copy the content of this branches store to branch_to."""
191
if (self._branch_format != branch_to._branch_format
192
or self._branch_format != 4):
193
from bzrlib.fetch import greedy_fetch
194
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
195
self, self._branch_format, branch_to, branch_to._branch_format)
196
greedy_fetch(to_branch=branch_to, from_branch=self,
197
revision=self.last_revision())
200
store_pairs = ((self.text_store, branch_to.text_store),
201
(self.inventory_store, branch_to.inventory_store),
202
(self.revision_store, branch_to.revision_store))
204
for from_store, to_store in store_pairs:
205
copy_all(from_store, to_store)
206
except UnlistableStore:
207
raise UnlistableBranch(from_store)
209
def __init__(self, transport, init=False,
210
relax_version_check=False):
211
"""Create new branch object at a particular location.
213
transport -- A Transport object, defining how to access files.
215
init -- If True, create new control files in a previously
216
unversioned directory. If False, the branch must already
219
relax_version_check -- If true, the usual check for the branch
220
version is not applied. This is intended only for
221
upgrade/recovery type use; it's not guaranteed that
222
all operations will work on old format branches.
224
In the test suite, creation of new trees is tested using the
225
`ScratchBranch` class.
227
assert isinstance(transport, Transport), \
228
"%r is not a Transport" % transport
229
self._transport = transport
232
self._check_format(relax_version_check)
234
def get_store(name, compressed=True, prefixed=False):
235
# FIXME: This approach of assuming stores are all entirely compressed
236
# or entirely uncompressed is tidy, but breaks upgrade from
237
# some existing branches where there's a mixture; we probably
238
# still want the option to look for both.
239
relpath = self._rel_controlfilename(name)
241
store = CompressedTextStore(self._transport.clone(relpath),
244
store = TextStore(self._transport.clone(relpath),
246
#if self._transport.should_cache():
247
# cache_path = os.path.join(self.cache_root, name)
248
# os.mkdir(cache_path)
249
# store = bzrlib.store.CachedStore(store, cache_path)
251
def get_weave(name, prefixed=False):
252
relpath = self._rel_controlfilename(name)
253
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
254
if self._transport.should_cache():
255
ws.enable_cache = True
258
if self._branch_format == 4:
259
self.inventory_store = get_store('inventory-store')
260
self.text_store = get_store('text-store')
261
self.revision_store = get_store('revision-store')
262
elif self._branch_format == 5:
263
self.control_weaves = get_weave('')
264
self.weave_store = get_weave('weaves')
265
self.revision_store = get_store('revision-store', compressed=False)
266
elif self._branch_format == 6:
267
self.control_weaves = get_weave('')
268
self.weave_store = get_weave('weaves', prefixed=True)
269
self.revision_store = get_store('revision-store', compressed=False,
271
self.revision_store.register_suffix('sig')
272
self._transaction = None
275
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
280
if self._lock_mode or self._lock:
281
# XXX: This should show something every time, and be suitable for
282
# headless operation and embedding
283
warn("branch %r was not explicitly unlocked" % self)
286
# TODO: It might be best to do this somewhere else,
287
# but it is nice for a Branch object to automatically
288
# cache it's information.
289
# Alternatively, we could have the Transport objects cache requests
290
# See the earlier discussion about how major objects (like Branch)
291
# should never expect their __del__ function to run.
292
if hasattr(self, 'cache_root') and self.cache_root is not None:
294
shutil.rmtree(self.cache_root)
297
self.cache_root = None
301
return self._transport.base
304
base = property(_get_base, doc="The URL for the root of this branch.")
306
def _finish_transaction(self):
307
"""Exit the current transaction."""
308
if self._transaction is None:
309
raise errors.LockError('Branch %s is not in a transaction' %
311
transaction = self._transaction
312
self._transaction = None
315
def get_transaction(self):
316
"""Return the current active transaction.
318
If no transaction is active, this returns a passthrough object
319
for which all data is immediately flushed and no caching happens.
321
if self._transaction is None:
322
return transactions.PassThroughTransaction()
324
return self._transaction
326
def _set_transaction(self, new_transaction):
327
"""Set a new active transaction."""
328
if self._transaction is not None:
329
raise errors.LockError('Branch %s is in a transaction already.' %
331
self._transaction = new_transaction
148
333
def lock_write(self):
149
raise NotImplementedError(self.lock_write)
334
mutter("lock write: %s (%s)", self, self._lock_count)
335
# TODO: Upgrade locking to support using a Transport,
336
# and potentially a remote locking protocol
338
if self._lock_mode != 'w':
339
raise LockError("can't upgrade to a write lock from %r" %
341
self._lock_count += 1
343
self._lock = self._transport.lock_write(
344
self._rel_controlfilename('branch-lock'))
345
self._lock_mode = 'w'
347
self._set_transaction(transactions.PassThroughTransaction())
151
349
def lock_read(self):
152
raise NotImplementedError(self.lock_read)
350
mutter("lock read: %s (%s)", self, self._lock_count)
352
assert self._lock_mode in ('r', 'w'), \
353
"invalid lock mode %r" % self._lock_mode
354
self._lock_count += 1
356
self._lock = self._transport.lock_read(
357
self._rel_controlfilename('branch-lock'))
358
self._lock_mode = 'r'
360
self._set_transaction(transactions.ReadOnlyTransaction())
361
# 5K may be excessive, but hey, its a knob.
362
self.get_transaction().set_cache_size(5000)
154
364
def unlock(self):
155
raise NotImplementedError(self.unlock)
157
def peek_lock_mode(self):
158
"""Return lock mode for the Branch: 'r', 'w' or None"""
159
raise NotImplementedError(self.peek_lock_mode)
161
def get_physical_lock_status(self):
162
raise NotImplementedError(self.get_physical_lock_status)
165
def get_revision_id_to_revno_map(self):
166
"""Return the revision_id => dotted revno map.
168
This will be regenerated on demand, but will be cached.
170
:return: A dictionary mapping revision_id => dotted revno.
171
This dictionary should not be modified by the caller.
173
if self._revision_id_to_revno_cache is not None:
174
mapping = self._revision_id_to_revno_cache
365
mutter("unlock: %s (%s)", self, self._lock_count)
366
if not self._lock_mode:
367
raise LockError('branch %r is not locked' % (self))
369
if self._lock_count > 1:
370
self._lock_count -= 1
176
mapping = self._gen_revno_map()
177
self._cache_revision_id_to_revno(mapping)
178
# TODO: jam 20070417 Since this is being cached, should we be returning
180
# I would rather not, and instead just declare that users should not
181
# modify the return value.
184
def _gen_revno_map(self):
185
"""Create a new mapping from revision ids to dotted revnos.
187
Dotted revnos are generated based on the current tip in the revision
189
This is the worker function for get_revision_id_to_revno_map, which
190
just caches the return value.
192
:return: A dictionary mapping revision_id => dotted revno.
194
last_revision = self.last_revision()
195
revision_graph = self.repository.get_revision_graph(last_revision)
196
merge_sorted_revisions = tsort.merge_sort(
201
revision_id_to_revno = dict((rev_id, revno)
202
for seq_num, rev_id, depth, revno, end_of_merge
203
in merge_sorted_revisions)
204
return revision_id_to_revno
206
def leave_lock_in_place(self):
207
"""Tell this branch object not to release the physical lock when this
210
If lock_write doesn't return a token, then this method is not supported.
212
self.control_files.leave_in_place()
214
def dont_leave_lock_in_place(self):
215
"""Tell this branch object to release the physical lock when this
216
object is unlocked, even if it didn't originally acquire it.
218
If lock_write doesn't return a token, then this method is not supported.
220
self.control_files.dont_leave_in_place()
372
self._finish_transaction()
375
self._lock_mode = self._lock_count = None
222
377
def abspath(self, name):
223
378
"""Return absolute filename for something in the branch
225
380
XXX: Robert Collins 20051017 what is this used for? why is it a branch
226
381
method and not a tree method.
228
raise NotImplementedError(self.abspath)
230
def bind(self, other):
231
"""Bind the local branch the other branch.
233
:param other: The branch to bind to
236
raise errors.UpgradeRequired(self.base)
239
def fetch(self, from_branch, last_revision=None, pb=None):
240
"""Copy revisions from from_branch into this branch.
242
:param from_branch: Where to copy from.
243
:param last_revision: What revision to stop at (None for at the end
245
:param pb: An optional progress bar to use.
247
Returns the copied revision count and the failed revisions in a tuple:
250
if self.base == from_branch.base:
253
nested_pb = ui.ui_factory.nested_progress_bar()
258
from_branch.lock_read()
260
if last_revision is None:
261
pb.update('get source history')
262
last_revision = from_branch.last_revision()
263
last_revision = _mod_revision.ensure_null(last_revision)
264
return self.repository.fetch(from_branch.repository,
265
revision_id=last_revision,
268
if nested_pb is not None:
272
def get_bound_location(self):
273
"""Return the URL of the branch we are bound to.
275
Older format branches cannot bind, please be sure to use a metadir
280
def get_old_bound_location(self):
281
"""Return the URL of the branch we used to be bound to
283
raise errors.UpgradeRequired(self.base)
285
def get_commit_builder(self, parents, config=None, timestamp=None,
286
timezone=None, committer=None, revprops=None,
288
"""Obtain a CommitBuilder for this branch.
290
:param parents: Revision ids of the parents of the new revision.
291
:param config: Optional configuration to use.
292
:param timestamp: Optional timestamp recorded for commit.
293
:param timezone: Optional timezone for timestamp.
294
:param committer: Optional committer to set for commit.
295
:param revprops: Optional dictionary of revision properties.
296
:param revision_id: Optional revision id.
300
config = self.get_config()
302
return self.repository.get_commit_builder(self, parents, config,
303
timestamp, timezone, committer, revprops, revision_id)
305
def get_master_branch(self, possible_transports=None):
306
"""Return the branch we are bound to.
308
:return: Either a Branch, or None
383
return self._transport.abspath(name)
385
def _rel_controlfilename(self, file_or_path):
386
if not isinstance(file_or_path, basestring):
387
file_or_path = '/'.join(file_or_path)
388
if file_or_path == '':
390
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
392
def controlfilename(self, file_or_path):
393
"""Return location relative to branch."""
394
return self._transport.abspath(self._rel_controlfilename(file_or_path))
396
def controlfile(self, file_or_path, mode='r'):
397
"""Open a control file for this branch.
399
There are two classes of file in the control directory: text
400
and binary. binary files are untranslated byte streams. Text
401
control files are stored with Unix newlines and in UTF-8, even
402
if the platform or locale defaults are different.
404
Controlfiles should almost never be opened in write mode but
405
rather should be atomically copied and replaced using atomicfile.
409
relpath = self._rel_controlfilename(file_or_path)
410
#TODO: codecs.open() buffers linewise, so it was overloaded with
411
# a much larger buffer, do we need to do the same for getreader/getwriter?
413
return self._transport.get(relpath)
415
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
417
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
419
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
421
raise BzrError("invalid controlfile mode %r" % mode)
423
def put_controlfile(self, path, f, encode=True):
424
"""Write an entry as a controlfile.
426
:param path: The path to put the file, relative to the .bzr control
428
:param f: A file-like or string object whose contents should be copied.
429
:param encode: If true, encode the contents as utf-8
431
self.put_controlfiles([(path, f)], encode=encode)
433
def put_controlfiles(self, files, encode=True):
434
"""Write several entries as controlfiles.
436
:param files: A list of [(path, file)] pairs, where the path is the directory
437
underneath the bzr control directory
438
:param encode: If true, encode the contents as utf-8
442
for path, f in files:
444
if isinstance(f, basestring):
445
f = f.encode('utf-8', 'replace')
447
f = codecs.getwriter('utf-8')(f, errors='replace')
448
path = self._rel_controlfilename(path)
449
ctrl_files.append((path, f))
450
self._transport.put_multi(ctrl_files)
452
def _make_control(self):
453
from bzrlib.inventory import Inventory
454
from bzrlib.weavefile import write_weave_v5
455
from bzrlib.weave import Weave
457
# Create an empty inventory
459
# if we want per-tree root ids then this is the place to set
460
# them; they're not needed for now and so ommitted for
462
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
463
empty_inv = sio.getvalue()
465
bzrlib.weavefile.write_weave_v5(Weave(), sio)
466
empty_weave = sio.getvalue()
468
dirs = [[], 'revision-store', 'weaves']
470
"This is a Bazaar-NG control directory.\n"
471
"Do not change any files in this directory.\n"),
472
('branch-format', BZR_BRANCH_FORMAT_6),
473
('revision-history', ''),
476
('pending-merges', ''),
477
('inventory', empty_inv),
478
('inventory.weave', empty_weave),
479
('ancestry.weave', empty_weave)
481
cfn = self._rel_controlfilename
482
self._transport.mkdir_multi([cfn(d) for d in dirs])
483
self.put_controlfiles(files)
484
mutter('created control directory in ' + self._transport.base)
486
def _check_format(self, relax_version_check):
487
"""Check this branch format is supported.
489
The format level is stored, as an integer, in
490
self._branch_format for code that needs to check it later.
492
In the future, we might need different in-memory Branch
493
classes to support downlevel branches. But not yet.
496
fmt = self.controlfile('branch-format', 'r').read()
498
raise NotBranchError(path=self.base)
499
mutter("got branch format %r", fmt)
500
if fmt == BZR_BRANCH_FORMAT_6:
501
self._branch_format = 6
502
elif fmt == BZR_BRANCH_FORMAT_5:
503
self._branch_format = 5
504
elif fmt == BZR_BRANCH_FORMAT_4:
505
self._branch_format = 4
507
if (not relax_version_check
508
and self._branch_format not in (5, 6)):
509
raise errors.UnsupportedFormatError(
510
'sorry, branch format %r not supported' % fmt,
511
['use a different bzr version',
512
'or remove the .bzr directory'
513
' and "bzr init" again'])
515
def get_root_id(self):
516
"""Return the id of this branches root"""
517
inv = self.get_inventory(self.last_revision())
518
return inv.root.file_id
521
def set_root_id(self, file_id):
522
inv = self.working_tree().read_working_inventory()
523
orig_root_id = inv.root.file_id
524
del inv._byid[inv.root.file_id]
525
inv.root.file_id = file_id
526
inv._byid[inv.root.file_id] = inv.root
529
if entry.parent_id in (None, orig_root_id):
530
entry.parent_id = inv.root.file_id
531
self._write_inventory(inv)
534
def _write_inventory(self, inv):
535
"""Update the working inventory.
537
That is to say, the inventory describing changes underway, that
538
will be committed to the next revision.
540
from cStringIO import StringIO
542
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
544
# Transport handles atomicity
545
self.put_controlfile('inventory', sio)
547
mutter('wrote working inventory')
550
def add(self, files, ids=None):
551
"""Make files versioned.
553
Note that the command line normally calls smart_add instead,
554
which can automatically recurse.
556
This puts the files in the Added state, so that they will be
557
recorded by the next commit.
560
List of paths to add, relative to the base of the tree.
563
If set, use these instead of automatically generated ids.
564
Must be the same length as the list of files, but may
565
contain None for ids that are to be autogenerated.
567
TODO: Perhaps have an option to add the ids even if the files do
570
TODO: Perhaps yield the ids and paths as they're added.
572
# TODO: Re-adding a file that is removed in the working copy
573
# should probably put it back with the previous ID.
574
if isinstance(files, basestring):
575
assert(ids is None or isinstance(ids, basestring))
581
ids = [None] * len(files)
583
assert(len(ids) == len(files))
585
inv = self.working_tree().read_working_inventory()
586
for f,file_id in zip(files, ids):
587
if is_control_file(f):
588
raise BzrError("cannot add control file %s" % quotefn(f))
593
raise BzrError("cannot add top-level %r" % f)
595
fullpath = os.path.normpath(self.abspath(f))
598
kind = file_kind(fullpath)
600
# maybe something better?
601
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
603
if not InventoryEntry.versionable_kind(kind):
604
raise BzrError('cannot add: not a versionable file ('
605
'i.e. regular file, symlink or directory): %s' % quotefn(f))
608
file_id = gen_file_id(f)
609
inv.add_path(f, kind=kind, file_id=file_id)
611
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
613
self._write_inventory(inv)
616
def print_file(self, file, revno):
617
"""Print `file` to stdout."""
618
tree = self.revision_tree(self.get_rev_id(revno))
619
# use inventory as it was in that revision
620
file_id = tree.inventory.path2id(file)
622
raise BzrError("%r is not present in revision %s" % (file, revno))
623
tree.print_file(file_id)
626
"""Return all unknown files.
628
These are files in the working directory that are not versioned or
629
control files or ignored.
631
>>> from bzrlib.workingtree import WorkingTree
632
>>> b = ScratchBranch(files=['foo', 'foo~'])
633
>>> map(str, b.unknowns())
636
>>> list(b.unknowns())
638
>>> WorkingTree(b.base, b).remove('foo')
639
>>> list(b.unknowns())
642
return self.working_tree().unknowns()
645
def append_revision(self, *revision_ids):
646
for revision_id in revision_ids:
647
mutter("add {%s} to revision-history" % revision_id)
648
rev_history = self.revision_history()
649
rev_history.extend(revision_ids)
650
self.set_revision_history(rev_history)
653
def set_revision_history(self, rev_history):
654
self.put_controlfile('revision-history', '\n'.join(rev_history))
656
def has_revision(self, revision_id):
657
"""True if this branch has a copy of the revision.
659
This does not necessarily imply the revision is merge
660
or on the mainline."""
661
return (revision_id is None
662
or self.revision_store.has_id(revision_id))
665
def get_revision_xml_file(self, revision_id):
666
"""Return XML file object for revision object."""
667
if not revision_id or not isinstance(revision_id, basestring):
668
raise InvalidRevisionId(revision_id=revision_id, branch=self)
670
return self.revision_store.get(revision_id)
671
except (IndexError, KeyError):
672
raise bzrlib.errors.NoSuchRevision(self, revision_id)
675
get_revision_xml = get_revision_xml_file
677
def get_revision_xml(self, revision_id):
678
return self.get_revision_xml_file(revision_id).read()
681
def get_revision(self, revision_id):
682
"""Return the Revision object for a named revision"""
683
xml_file = self.get_revision_xml_file(revision_id)
686
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
687
except SyntaxError, e:
688
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
692
assert r.revision_id == revision_id
312
695
def get_revision_delta(self, revno):
313
696
"""Return the delta for one revision.
623
1190
Zero (the NULL revision) is considered invalid
625
1192
if revno < 1 or revno > self.revno():
626
raise errors.InvalidRevisionNumber(revno)
629
def clone(self, to_bzrdir, revision_id=None):
630
"""Clone this branch into to_bzrdir preserving all semantic values.
632
revision_id: if not None, the revision history in the new branch will
633
be truncated to end with revision_id.
635
result = self._format.initialize(to_bzrdir)
636
self.copy_content_into(result, revision_id=revision_id)
640
def sprout(self, to_bzrdir, revision_id=None):
641
"""Create a new line of development from the branch, into to_bzrdir.
643
revision_id: if not None, the revision history in the new branch will
644
be truncated to end with revision_id.
646
result = self._format.initialize(to_bzrdir)
647
self.copy_content_into(result, revision_id=revision_id)
648
result.set_parent(self.bzrdir.root_transport.base)
651
def _synchronize_history(self, destination, revision_id):
652
"""Synchronize last revision and revision history between branches.
654
This version is most efficient when the destination is also a
655
BzrBranch5, but works for BzrBranch6 as long as the revision
656
history is the true lefthand parent history, and all of the revisions
657
are in the destination's repository. If not, set_revision_history
660
:param destination: The branch to copy the history into
661
:param revision_id: The revision-id to truncate history at. May
662
be None to copy complete history.
664
if revision_id == _mod_revision.NULL_REVISION:
666
new_history = self.revision_history()
667
if revision_id is not None and new_history != []:
669
new_history = new_history[:new_history.index(revision_id) + 1]
671
rev = self.repository.get_revision(revision_id)
672
new_history = rev.get_history(self.repository)[1:]
673
destination.set_revision_history(new_history)
676
def copy_content_into(self, destination, revision_id=None):
677
"""Copy the content of self into destination.
679
revision_id: if not None, the revision history in the new branch will
680
be truncated to end with revision_id.
682
self._synchronize_history(destination, revision_id)
684
parent = self.get_parent()
685
except errors.InaccessibleParent, e:
686
mutter('parent was not accessible to copy: %s', e)
689
destination.set_parent(parent)
690
self.tags.merge_to(destination.tags)
694
"""Check consistency of the branch.
696
In particular this checks that revisions given in the revision-history
697
do actually match up in the revision graph, and that they're all
698
present in the repository.
700
Callers will typically also want to check the repository.
702
:return: A BranchCheckResult.
704
mainline_parent_id = None
705
for revision_id in self.revision_history():
707
revision = self.repository.get_revision(revision_id)
708
except errors.NoSuchRevision, e:
709
raise errors.BzrCheckError("mainline revision {%s} not in repository"
711
# In general the first entry on the revision history has no parents.
712
# But it's not illegal for it to have parents listed; this can happen
713
# in imports from Arch when the parents weren't reachable.
714
if mainline_parent_id is not None:
715
if mainline_parent_id not in revision.parent_ids:
716
raise errors.BzrCheckError("previous revision {%s} not listed among "
718
% (mainline_parent_id, revision_id))
719
mainline_parent_id = revision_id
720
return BranchCheckResult(self)
722
def _get_checkout_format(self):
723
"""Return the most suitable metadir for a checkout of this branch.
724
Weaves are used if this branch's repository uses weaves.
726
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
727
from bzrlib.repofmt import weaverepo
728
format = bzrdir.BzrDirMetaFormat1()
729
format.repository_format = weaverepo.RepositoryFormat7()
731
format = self.repository.bzrdir.checkout_metadir()
732
format.set_branch_format(self._format)
735
def create_checkout(self, to_location, revision_id=None,
736
lightweight=False, accelerator_tree=None,
738
"""Create a checkout of a branch.
740
:param to_location: The url to produce the checkout at
741
:param revision_id: The revision to check out
742
:param lightweight: If True, produce a lightweight checkout, otherwise,
743
produce a bound branch (heavyweight checkout)
744
:param accelerator_tree: A tree which can be used for retrieving file
745
contents more quickly than the revision tree, i.e. a workingtree.
746
The revision tree will be used for cases where accelerator_tree's
747
content is different.
748
:param hardlink: If true, hard-link files from accelerator_tree,
750
:return: The tree of the created checkout
752
t = transport.get_transport(to_location)
755
format = self._get_checkout_format()
756
checkout = format.initialize_on_transport(t)
757
from_branch = BranchReferenceFormat().initialize(checkout, self)
759
format = self._get_checkout_format()
760
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
761
to_location, force_new_tree=False, format=format)
762
checkout = checkout_branch.bzrdir
763
checkout_branch.bind(self)
764
# pull up to the specified revision_id to set the initial
765
# branch tip correctly, and seed it with history.
766
checkout_branch.pull(self, stop_revision=revision_id)
768
tree = checkout.create_workingtree(revision_id,
769
from_branch=from_branch,
770
accelerator_tree=accelerator_tree,
772
basis_tree = tree.basis_tree()
773
basis_tree.lock_read()
775
for path, file_id in basis_tree.iter_references():
776
reference_parent = self.reference_parent(file_id, path)
777
reference_parent.create_checkout(tree.abspath(path),
778
basis_tree.get_reference_revision(file_id, path),
784
def reference_parent(self, file_id, path):
785
"""Return the parent branch for a tree-reference file_id
786
:param file_id: The file_id of the tree reference
787
:param path: The path of the file_id in the tree
788
:return: A branch associated with the file_id
790
# FIXME should provide multiple branches, based on config
791
return Branch.open(self.bzrdir.root_transport.clone(path).base)
793
def supports_tags(self):
794
return self._format.supports_tags()
797
class BranchFormat(object):
798
"""An encapsulation of the initialization and open routines for a format.
800
Formats provide three things:
801
* An initialization routine,
805
Formats are placed in an dict by their format string for reference
806
during branch opening. Its not required that these be instances, they
807
can be classes themselves with class methods - it simply depends on
808
whether state is needed for a given format or not.
810
Once a format is deprecated, just deprecate the initialize and open
811
methods on the format class. Do not deprecate the object, as the
812
object will be created every time regardless.
815
_default_format = None
816
"""The default format used for new branches."""
819
"""The known formats."""
821
def __eq__(self, other):
822
return self.__class__ is other.__class__
824
def __ne__(self, other):
825
return not (self == other)
828
def find_format(klass, a_bzrdir):
829
"""Return the format for the branch object in a_bzrdir."""
831
transport = a_bzrdir.get_branch_transport(None)
832
format_string = transport.get("format").read()
833
return klass._formats[format_string]
834
except errors.NoSuchFile:
835
raise errors.NotBranchError(path=transport.base)
837
raise errors.UnknownFormatError(format=format_string, kind='branch')
840
def get_default_format(klass):
841
"""Return the current default format."""
842
return klass._default_format
844
def get_reference(self, a_bzrdir):
845
"""Get the target reference of the branch in a_bzrdir.
847
format probing must have been completed before calling
848
this method - it is assumed that the format of the branch
849
in a_bzrdir is correct.
851
:param a_bzrdir: The bzrdir to get the branch data from.
852
:return: None if the branch is not a reference branch.
857
def set_reference(self, a_bzrdir, to_branch):
858
"""Set the target reference of the branch in a_bzrdir.
860
format probing must have been completed before calling
861
this method - it is assumed that the format of the branch
862
in a_bzrdir is correct.
864
:param a_bzrdir: The bzrdir to set the branch reference for.
865
:param to_branch: branch that the checkout is to reference
867
raise NotImplementedError(self.set_reference)
869
def get_format_string(self):
870
"""Return the ASCII format string that identifies this format."""
871
raise NotImplementedError(self.get_format_string)
873
def get_format_description(self):
874
"""Return the short format description for this format."""
875
raise NotImplementedError(self.get_format_description)
877
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
879
"""Initialize a branch in a bzrdir, with specified files
881
:param a_bzrdir: The bzrdir to initialize the branch in
882
:param utf8_files: The files to create as a list of
883
(filename, content) tuples
884
:param set_format: If True, set the format with
885
self.get_format_string. (BzrBranch4 has its format set
887
:return: a branch in this format
889
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
890
branch_transport = a_bzrdir.get_branch_transport(self)
892
'metadir': ('lock', lockdir.LockDir),
893
'branch4': ('branch-lock', lockable_files.TransportLock),
895
lock_name, lock_class = lock_map[lock_type]
896
control_files = lockable_files.LockableFiles(branch_transport,
897
lock_name, lock_class)
898
control_files.create_lock()
899
control_files.lock_write()
901
control_files.put_utf8('format', self.get_format_string())
903
for file, content in utf8_files:
904
control_files.put_utf8(file, content)
906
control_files.unlock()
907
return self.open(a_bzrdir, _found=True)
909
def initialize(self, a_bzrdir):
910
"""Create a branch of this format in a_bzrdir."""
911
raise NotImplementedError(self.initialize)
913
def is_supported(self):
914
"""Is this format supported?
916
Supported formats can be initialized and opened.
917
Unsupported formats may not support initialization or committing or
918
some other features depending on the reason for not being supported.
922
def open(self, a_bzrdir, _found=False):
923
"""Return the branch object for a_bzrdir
925
_found is a private parameter, do not use it. It is used to indicate
926
if format probing has already be done.
928
raise NotImplementedError(self.open)
931
def register_format(klass, format):
932
klass._formats[format.get_format_string()] = format
935
def set_default_format(klass, format):
936
klass._default_format = format
939
def unregister_format(klass, format):
940
assert klass._formats[format.get_format_string()] is format
941
del klass._formats[format.get_format_string()]
944
return self.get_format_string().rstrip()
946
def supports_tags(self):
947
"""True if this format supports tags stored in the branch"""
948
return False # by default
950
# XXX: Probably doesn't really belong here -- mbp 20070212
951
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
953
branch_transport = a_bzrdir.get_branch_transport(self)
954
control_files = lockable_files.LockableFiles(branch_transport,
955
lock_filename, lock_class)
956
control_files.create_lock()
957
control_files.lock_write()
959
for filename, content in utf8_files:
960
control_files.put_utf8(filename, content)
962
control_files.unlock()
965
class BranchHooks(Hooks):
966
"""A dictionary mapping hook name to a list of callables for branch hooks.
968
e.g. ['set_rh'] Is the list of items to be called when the
969
set_revision_history function is invoked.
973
"""Create the default hooks.
975
These are all empty initially, because by default nothing should get
979
# Introduced in 0.15:
980
# invoked whenever the revision history has been set
981
# with set_revision_history. The api signature is
982
# (branch, revision_history), and the branch will
985
# invoked after a push operation completes.
986
# the api signature is
988
# containing the members
989
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
990
# where local is the local target branch or None, master is the target
991
# master branch, and the rest should be self explanatory. The source
992
# is read locked and the target branches write locked. Source will
993
# be the local low-latency branch.
994
self['post_push'] = []
995
# invoked after a pull operation completes.
996
# the api signature is
998
# containing the members
999
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1000
# where local is the local branch or None, master is the target
1001
# master branch, and the rest should be self explanatory. The source
1002
# is read locked and the target branches write locked. The local
1003
# branch is the low-latency branch.
1004
self['post_pull'] = []
1005
# invoked before a commit operation takes place.
1006
# the api signature is
1007
# (local, master, old_revno, old_revid, future_revno, future_revid,
1008
# tree_delta, future_tree).
1009
# old_revid is NULL_REVISION for the first commit to a branch
1010
# tree_delta is a TreeDelta object describing changes from the basis
1011
# revision, hooks MUST NOT modify this delta
1012
# future_tree is an in-memory tree obtained from
1013
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1014
self['pre_commit'] = []
1015
# invoked after a commit operation completes.
1016
# the api signature is
1017
# (local, master, old_revno, old_revid, new_revno, new_revid)
1018
# old_revid is NULL_REVISION for the first commit to a branch.
1019
self['post_commit'] = []
1020
# invoked after a uncommit operation completes.
1021
# the api signature is
1022
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1023
# local is the local branch or None, master is the target branch,
1024
# and an empty branch recieves new_revno of 0, new_revid of None.
1025
self['post_uncommit'] = []
1028
# install the default hooks into the Branch class.
1029
Branch.hooks = BranchHooks()
1032
class BzrBranchFormat4(BranchFormat):
1033
"""Bzr branch format 4.
1036
- a revision-history file.
1037
- a branch-lock lock file [ to be shared with the bzrdir ]
1040
def get_format_description(self):
1041
"""See BranchFormat.get_format_description()."""
1042
return "Branch format 4"
1044
def initialize(self, a_bzrdir):
1045
"""Create a branch of this format in a_bzrdir."""
1046
utf8_files = [('revision-history', ''),
1047
('branch-name', ''),
1049
return self._initialize_helper(a_bzrdir, utf8_files,
1050
lock_type='branch4', set_format=False)
1053
super(BzrBranchFormat4, self).__init__()
1054
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1056
def open(self, a_bzrdir, _found=False):
1057
"""Return the branch object for a_bzrdir
1059
_found is a private parameter, do not use it. It is used to indicate
1060
if format probing has already be done.
1063
# we are being called directly and must probe.
1064
raise NotImplementedError
1065
return BzrBranch(_format=self,
1066
_control_files=a_bzrdir._control_files,
1068
_repository=a_bzrdir.open_repository())
1071
return "Bazaar-NG branch format 4"
1074
class BzrBranchFormat5(BranchFormat):
1075
"""Bzr branch format 5.
1078
- a revision-history file.
1080
- a lock dir guarding the branch itself
1081
- all of this stored in a branch/ subdirectory
1082
- works with shared repositories.
1084
This format is new in bzr 0.8.
1087
def get_format_string(self):
1088
"""See BranchFormat.get_format_string()."""
1089
return "Bazaar-NG branch format 5\n"
1091
def get_format_description(self):
1092
"""See BranchFormat.get_format_description()."""
1093
return "Branch format 5"
1095
def initialize(self, a_bzrdir):
1096
"""Create a branch of this format in a_bzrdir."""
1097
utf8_files = [('revision-history', ''),
1098
('branch-name', ''),
1100
return self._initialize_helper(a_bzrdir, utf8_files)
1103
super(BzrBranchFormat5, self).__init__()
1104
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1106
def open(self, a_bzrdir, _found=False):
1107
"""Return the branch object for a_bzrdir
1109
_found is a private parameter, do not use it. It is used to indicate
1110
if format probing has already be done.
1113
format = BranchFormat.find_format(a_bzrdir)
1114
assert format.__class__ == self.__class__
1116
transport = a_bzrdir.get_branch_transport(None)
1117
control_files = lockable_files.LockableFiles(transport, 'lock',
1119
return BzrBranch5(_format=self,
1120
_control_files=control_files,
1122
_repository=a_bzrdir.find_repository())
1123
except errors.NoSuchFile:
1124
raise errors.NotBranchError(path=transport.base)
1127
class BzrBranchFormat6(BzrBranchFormat5):
1128
"""Branch format with last-revision and tags.
1130
Unlike previous formats, this has no explicit revision history. Instead,
1131
this just stores the last-revision, and the left-hand history leading
1132
up to there is the history.
1134
This format was introduced in bzr 0.15
1135
and became the default in 0.91.
1138
def get_format_string(self):
1139
"""See BranchFormat.get_format_string()."""
1140
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1142
def get_format_description(self):
1143
"""See BranchFormat.get_format_description()."""
1144
return "Branch format 6"
1146
def initialize(self, a_bzrdir):
1147
"""Create a branch of this format in a_bzrdir."""
1148
utf8_files = [('last-revision', '0 null:\n'),
1149
('branch.conf', ''),
1152
return self._initialize_helper(a_bzrdir, utf8_files)
1154
def open(self, a_bzrdir, _found=False):
1155
"""Return the branch object for a_bzrdir
1157
_found is a private parameter, do not use it. It is used to indicate
1158
if format probing has already be done.
1161
format = BranchFormat.find_format(a_bzrdir)
1162
assert format.__class__ == self.__class__
1163
transport = a_bzrdir.get_branch_transport(None)
1164
control_files = lockable_files.LockableFiles(transport, 'lock',
1166
return BzrBranch6(_format=self,
1167
_control_files=control_files,
1169
_repository=a_bzrdir.find_repository())
1171
def supports_tags(self):
1175
class BranchReferenceFormat(BranchFormat):
1176
"""Bzr branch reference format.
1178
Branch references are used in implementing checkouts, they
1179
act as an alias to the real branch which is at some other url.
1186
def get_format_string(self):
1187
"""See BranchFormat.get_format_string()."""
1188
return "Bazaar-NG Branch Reference Format 1\n"
1190
def get_format_description(self):
1191
"""See BranchFormat.get_format_description()."""
1192
return "Checkout reference format 1"
1194
def get_reference(self, a_bzrdir):
1195
"""See BranchFormat.get_reference()."""
1196
transport = a_bzrdir.get_branch_transport(None)
1197
return transport.get('location').read()
1199
def set_reference(self, a_bzrdir, to_branch):
1200
"""See BranchFormat.set_reference()."""
1201
transport = a_bzrdir.get_branch_transport(None)
1202
location = transport.put_bytes('location', to_branch.base)
1204
def initialize(self, a_bzrdir, target_branch=None):
1205
"""Create a branch of this format in a_bzrdir."""
1206
if target_branch is None:
1207
# this format does not implement branch itself, thus the implicit
1208
# creation contract must see it as uninitializable
1209
raise errors.UninitializableFormat(self)
1210
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1211
branch_transport = a_bzrdir.get_branch_transport(self)
1212
branch_transport.put_bytes('location',
1213
target_branch.bzrdir.root_transport.base)
1214
branch_transport.put_bytes('format', self.get_format_string())
1216
a_bzrdir, _found=True,
1217
possible_transports=[target_branch.bzrdir.root_transport])
1220
super(BranchReferenceFormat, self).__init__()
1221
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1223
def _make_reference_clone_function(format, a_branch):
1224
"""Create a clone() routine for a branch dynamically."""
1225
def clone(to_bzrdir, revision_id=None):
1226
"""See Branch.clone()."""
1227
return format.initialize(to_bzrdir, a_branch)
1228
# cannot obey revision_id limits when cloning a reference ...
1229
# FIXME RBC 20060210 either nuke revision_id for clone, or
1230
# emit some sort of warning/error to the caller ?!
1233
def open(self, a_bzrdir, _found=False, location=None,
1234
possible_transports=None):
1235
"""Return the branch that the branch reference in a_bzrdir points at.
1237
_found is a private parameter, do not use it. It is used to indicate
1238
if format probing has already be done.
1241
format = BranchFormat.find_format(a_bzrdir)
1242
assert format.__class__ == self.__class__
1243
if location is None:
1244
location = self.get_reference(a_bzrdir)
1245
real_bzrdir = bzrdir.BzrDir.open(
1246
location, possible_transports=possible_transports)
1247
result = real_bzrdir.open_branch()
1248
# this changes the behaviour of result.clone to create a new reference
1249
# rather than a copy of the content of the branch.
1250
# I did not use a proxy object because that needs much more extensive
1251
# testing, and we are only changing one behaviour at the moment.
1252
# If we decide to alter more behaviours - i.e. the implicit nickname
1253
# then this should be refactored to introduce a tested proxy branch
1254
# and a subclass of that for use in overriding clone() and ....
1256
result.clone = self._make_reference_clone_function(result)
1260
# formats which have no format string are not discoverable
1261
# and not independently creatable, so are not registered.
1262
__format5 = BzrBranchFormat5()
1263
__format6 = BzrBranchFormat6()
1264
BranchFormat.register_format(__format5)
1265
BranchFormat.register_format(BranchReferenceFormat())
1266
BranchFormat.register_format(__format6)
1267
BranchFormat.set_default_format(__format6)
1268
_legacy_formats = [BzrBranchFormat4(),
1271
class BzrBranch(Branch):
1272
"""A branch stored in the actual filesystem.
1274
Note that it's "local" in the context of the filesystem; it doesn't
1275
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1276
it's writable, and can be accessed via the normal filesystem API.
1279
def __init__(self, _format=None,
1280
_control_files=None, a_bzrdir=None, _repository=None):
1281
"""Create new branch object at a particular location."""
1282
Branch.__init__(self)
1283
if a_bzrdir is None:
1284
raise ValueError('a_bzrdir must be supplied')
1286
self.bzrdir = a_bzrdir
1287
# self._transport used to point to the directory containing the
1288
# control directory, but was not used - now it's just the transport
1289
# for the branch control files. mbp 20070212
1290
self._base = self.bzrdir.transport.clone('..').base
1291
self._format = _format
1292
if _control_files is None:
1293
raise ValueError('BzrBranch _control_files is None')
1294
self.control_files = _control_files
1295
self._transport = _control_files._transport
1296
self.repository = _repository
1299
return '%s(%r)' % (self.__class__.__name__, self.base)
1303
def _get_base(self):
1304
"""Returns the directory containing the control directory."""
1307
base = property(_get_base, doc="The URL for the root of this branch.")
1309
def abspath(self, name):
1310
"""See Branch.abspath."""
1311
return self.control_files._transport.abspath(name)
1314
@deprecated_method(zero_sixteen)
1316
def get_root_id(self):
1317
"""See Branch.get_root_id."""
1318
tree = self.repository.revision_tree(self.last_revision())
1319
return tree.get_root_id()
1321
def is_locked(self):
1322
return self.control_files.is_locked()
1324
def lock_write(self, token=None):
1325
repo_token = self.repository.lock_write()
1327
token = self.control_files.lock_write(token=token)
1329
self.repository.unlock()
1333
def lock_read(self):
1334
self.repository.lock_read()
1336
self.control_files.lock_read()
1338
self.repository.unlock()
1342
# TODO: test for failed two phase locks. This is known broken.
1344
self.control_files.unlock()
1346
self.repository.unlock()
1347
if not self.control_files.is_locked():
1348
# we just released the lock
1349
self._clear_cached_state()
1351
def peek_lock_mode(self):
1352
if self.control_files._lock_count == 0:
1355
return self.control_files._lock_mode
1357
def get_physical_lock_status(self):
1358
return self.control_files.get_physical_lock_status()
1361
def print_file(self, file, revision_id):
1362
"""See Branch.print_file."""
1363
return self.repository.print_file(file, revision_id)
1365
def _write_revision_history(self, history):
1366
"""Factored out of set_revision_history.
1368
This performs the actual writing to disk.
1369
It is intended to be called by BzrBranch5.set_revision_history."""
1370
self.control_files.put_bytes(
1371
'revision-history', '\n'.join(history))
1374
def set_revision_history(self, rev_history):
1375
"""See Branch.set_revision_history."""
1376
if 'evil' in debug.debug_flags:
1377
mutter_callsite(3, "set_revision_history scales with history.")
1378
self._clear_cached_state()
1379
self._write_revision_history(rev_history)
1380
self._cache_revision_history(rev_history)
1381
for hook in Branch.hooks['set_rh']:
1382
hook(self, rev_history)
1385
def set_last_revision_info(self, revno, revision_id):
1386
"""Set the last revision of this branch.
1388
The caller is responsible for checking that the revno is correct
1389
for this revision id.
1391
It may be possible to set the branch last revision to an id not
1392
present in the repository. However, branches can also be
1393
configured to check constraints on history, in which case this may not
1396
revision_id = _mod_revision.ensure_null(revision_id)
1397
history = self._lefthand_history(revision_id)
1398
assert len(history) == revno, '%d != %d' % (len(history), revno)
1399
self.set_revision_history(history)
1401
def _gen_revision_history(self):
1402
history = self.control_files.get('revision-history').read().split('\n')
1403
if history[-1:] == ['']:
1404
# There shouldn't be a trailing newline, but just in case.
1408
def _lefthand_history(self, revision_id, last_rev=None,
1410
if 'evil' in debug.debug_flags:
1411
mutter_callsite(4, "_lefthand_history scales with history.")
1412
# stop_revision must be a descendant of last_revision
1413
graph = self.repository.get_graph()
1414
if last_rev is not None:
1415
if not graph.is_ancestor(last_rev, revision_id):
1416
# our previous tip is not merged into stop_revision
1417
raise errors.DivergedBranches(self, other_branch)
1418
# make a new revision history from the graph
1419
parents_map = graph.get_parent_map([revision_id])
1420
if revision_id not in parents_map:
1421
raise errors.NoSuchRevision(self, revision_id)
1422
current_rev_id = revision_id
1424
# Do not include ghosts or graph origin in revision_history
1425
while (current_rev_id in parents_map and
1426
len(parents_map[current_rev_id]) > 0):
1427
new_history.append(current_rev_id)
1428
current_rev_id = parents_map[current_rev_id][0]
1429
parents_map = graph.get_parent_map([current_rev_id])
1430
new_history.reverse()
1434
def generate_revision_history(self, revision_id, last_rev=None,
1436
"""Create a new revision history that will finish with revision_id.
1438
:param revision_id: the new tip to use.
1439
:param last_rev: The previous last_revision. If not None, then this
1440
must be a ancestory of revision_id, or DivergedBranches is raised.
1441
:param other_branch: The other branch that DivergedBranches should
1442
raise with respect to.
1444
self.set_revision_history(self._lefthand_history(revision_id,
1445
last_rev, other_branch))
1448
def update_revisions(self, other, stop_revision=None, overwrite=False):
1449
"""See Branch.update_revisions."""
1452
other_last_revno, other_last_revision = other.last_revision_info()
1453
if stop_revision is None:
1454
stop_revision = other_last_revision
1455
if _mod_revision.is_null(stop_revision):
1456
# if there are no commits, we're done.
1458
# whats the current last revision, before we fetch [and change it
1460
last_rev = _mod_revision.ensure_null(self.last_revision())
1461
# we fetch here so that we don't process data twice in the common
1462
# case of having something to pull, and so that the check for
1463
# already merged can operate on the just fetched graph, which will
1464
# be cached in memory.
1465
self.fetch(other, stop_revision)
1466
# Check to see if one is an ancestor of the other
1468
heads = self.repository.get_graph().heads([stop_revision,
1470
if heads == set([last_rev]):
1471
# The current revision is a decendent of the target,
1474
elif heads == set([stop_revision, last_rev]):
1475
# These branches have diverged
1476
raise errors.DivergedBranches(self, other)
1477
assert heads == set([stop_revision])
1478
if other_last_revision == stop_revision:
1479
self.set_last_revision_info(other_last_revno,
1480
other_last_revision)
1482
# TODO: jam 2007-11-29 Is there a way to determine the
1483
# revno without searching all of history??
1485
self.generate_revision_history(stop_revision)
1487
self.generate_revision_history(stop_revision,
1488
last_rev=last_rev, other_branch=other)
1492
def basis_tree(self):
1493
"""See Branch.basis_tree."""
1494
return self.repository.revision_tree(self.last_revision())
1497
def pull(self, source, overwrite=False, stop_revision=None,
1498
_hook_master=None, run_hooks=True, possible_transports=None):
1501
:param _hook_master: Private parameter - set the branch to
1502
be supplied as the master to push hooks.
1503
:param run_hooks: Private parameter - if false, this branch
1504
is being called because it's the master of the primary branch,
1505
so it should not run its hooks.
1507
result = PullResult()
1508
result.source_branch = source
1509
result.target_branch = self
1512
result.old_revno, result.old_revid = self.last_revision_info()
1513
self.update_revisions(source, stop_revision, overwrite=overwrite)
1514
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1515
result.new_revno, result.new_revid = self.last_revision_info()
1517
result.master_branch = _hook_master
1518
result.local_branch = self
1520
result.master_branch = self
1521
result.local_branch = None
1523
for hook in Branch.hooks['post_pull']:
1529
def _get_parent_location(self):
1530
_locs = ['parent', 'pull', 'x-pull']
1533
return self.control_files.get(l).read().strip('\n')
1534
except errors.NoSuchFile:
1539
def push(self, target, overwrite=False, stop_revision=None,
1540
_override_hook_source_branch=None):
1543
This is the basic concrete implementation of push()
1545
:param _override_hook_source_branch: If specified, run
1546
the hooks passing this Branch as the source, rather than self.
1547
This is for use of RemoteBranch, where push is delegated to the
1548
underlying vfs-based Branch.
1550
# TODO: Public option to disable running hooks - should be trivial but
1554
result = self._push_with_bound_branches(target, overwrite,
1556
_override_hook_source_branch=_override_hook_source_branch)
1561
def _push_with_bound_branches(self, target, overwrite,
1563
_override_hook_source_branch=None):
1564
"""Push from self into target, and into target's master if any.
1566
This is on the base BzrBranch class even though it doesn't support
1567
bound branches because the *target* might be bound.
1570
if _override_hook_source_branch:
1571
result.source_branch = _override_hook_source_branch
1572
for hook in Branch.hooks['post_push']:
1575
bound_location = target.get_bound_location()
1576
if bound_location and target.base != bound_location:
1577
# there is a master branch.
1579
# XXX: Why the second check? Is it even supported for a branch to
1580
# be bound to itself? -- mbp 20070507
1581
master_branch = target.get_master_branch()
1582
master_branch.lock_write()
1584
# push into the master from this branch.
1585
self._basic_push(master_branch, overwrite, stop_revision)
1586
# and push into the target branch from this. Note that we push from
1587
# this branch again, because its considered the highest bandwidth
1589
result = self._basic_push(target, overwrite, stop_revision)
1590
result.master_branch = master_branch
1591
result.local_branch = target
1595
master_branch.unlock()
1598
result = self._basic_push(target, overwrite, stop_revision)
1599
# TODO: Why set master_branch and local_branch if there's no
1600
# binding? Maybe cleaner to just leave them unset? -- mbp
1602
result.master_branch = target
1603
result.local_branch = None
1607
def _basic_push(self, target, overwrite, stop_revision):
1608
"""Basic implementation of push without bound branches or hooks.
1610
Must be called with self read locked and target write locked.
1612
result = PushResult()
1613
result.source_branch = self
1614
result.target_branch = target
1615
result.old_revno, result.old_revid = target.last_revision_info()
1617
target.update_revisions(self, stop_revision)
1618
except errors.DivergedBranches:
1622
target.set_revision_history(self.revision_history())
1623
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1624
result.new_revno, result.new_revid = target.last_revision_info()
1627
def get_parent(self):
1628
"""See Branch.get_parent."""
1630
assert self.base[-1] == '/'
1631
parent = self._get_parent_location()
1634
# This is an old-format absolute path to a local branch
1635
# turn it into a url
1636
if parent.startswith('/'):
1637
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1639
return urlutils.join(self.base[:-1], parent)
1640
except errors.InvalidURLJoin, e:
1641
raise errors.InaccessibleParent(parent, self.base)
1643
def set_push_location(self, location):
1644
"""See Branch.set_push_location."""
1645
self.get_config().set_user_option(
1646
'push_location', location,
1647
store=_mod_config.STORE_LOCATION_NORECURSE)
1650
def set_parent(self, url):
1651
"""See Branch.set_parent."""
1652
# TODO: Maybe delete old location files?
1653
# URLs should never be unicode, even on the local fs,
1654
# FIXUP this and get_parent in a future branch format bump:
1655
# read and rewrite the file, and have the new format code read
1656
# using .get not .get_utf8. RBC 20060125
1658
if isinstance(url, unicode):
1660
url = url.encode('ascii')
1661
except UnicodeEncodeError:
1662
raise errors.InvalidURL(url,
1663
"Urls must be 7-bit ascii, "
1664
"use bzrlib.urlutils.escape")
1665
url = urlutils.relative_url(self.base, url)
1666
self._set_parent_location(url)
1668
def _set_parent_location(self, url):
1670
self.control_files._transport.delete('parent')
1672
assert isinstance(url, str)
1673
self.control_files.put_bytes('parent', url + '\n')
1676
class BzrBranch5(BzrBranch):
1677
"""A format 5 branch. This supports new features over plain branches.
1679
It has support for a master_branch which is the data for bound branches.
1687
super(BzrBranch5, self).__init__(_format=_format,
1688
_control_files=_control_files,
1690
_repository=_repository)
1693
def pull(self, source, overwrite=False, stop_revision=None,
1694
run_hooks=True, possible_transports=None):
1695
"""Pull from source into self, updating my master if any.
1697
:param run_hooks: Private parameter - if false, this branch
1698
is being called because it's the master of the primary branch,
1699
so it should not run its hooks.
1701
bound_location = self.get_bound_location()
1702
master_branch = None
1703
if bound_location and source.base != bound_location:
1704
# not pulling from master, so we need to update master.
1705
master_branch = self.get_master_branch(possible_transports)
1706
master_branch.lock_write()
1709
# pull from source into master.
1710
master_branch.pull(source, overwrite, stop_revision,
1712
return super(BzrBranch5, self).pull(source, overwrite,
1713
stop_revision, _hook_master=master_branch,
1714
run_hooks=run_hooks)
1717
master_branch.unlock()
1719
def get_bound_location(self):
1721
return self.control_files.get_utf8('bound').read()[:-1]
1722
except errors.NoSuchFile:
1726
def get_master_branch(self, possible_transports=None):
1727
"""Return the branch we are bound to.
1729
:return: Either a Branch, or None
1731
This could memoise the branch, but if thats done
1732
it must be revalidated on each new lock.
1733
So for now we just don't memoise it.
1734
# RBC 20060304 review this decision.
1736
bound_loc = self.get_bound_location()
1740
return Branch.open(bound_loc,
1741
possible_transports=possible_transports)
1742
except (errors.NotBranchError, errors.ConnectionError), e:
1743
raise errors.BoundBranchConnectionFailure(
1747
def set_bound_location(self, location):
1748
"""Set the target where this branch is bound to.
1750
:param location: URL to the target branch
1753
self.control_files.put_utf8('bound', location+'\n')
1756
self.control_files._transport.delete('bound')
1757
except errors.NoSuchFile:
1193
raise InvalidRevisionNumber(revno)
1195
def sign_revision(self, revision_id, gpg_strategy):
1196
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1197
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1200
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1201
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1205
class ScratchBranch(_Branch):
1206
"""Special test class: a branch that cleans up after itself.
1208
>>> b = ScratchBranch()
1212
>>> b._transport.__del__()
1217
def __init__(self, files=[], dirs=[], transport=None):
1218
"""Make a test branch.
1220
This creates a temporary directory and runs init-tree in it.
1222
If any files are listed, they are created in the working copy.
1224
if transport is None:
1225
transport = bzrlib.transport.local.ScratchTransport()
1226
super(ScratchBranch, self).__init__(transport, init=True)
1228
super(ScratchBranch, self).__init__(transport)
1231
self._transport.mkdir(d)
1234
self._transport.put(f, 'content of %s' % f)
1239
>>> orig = ScratchBranch(files=["file1", "file2"])
1240
>>> clone = orig.clone()
1241
>>> if os.name != 'nt':
1242
... os.path.samefile(orig.base, clone.base)
1244
... 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(
1256
transport=bzrlib.transport.local.ScratchTransport(base))
1259
######################################################################
1263
def is_control_file(filename):
1264
## FIXME: better check
1265
filename = os.path.normpath(filename)
1266
while filename != '':
1267
head, tail = os.path.split(filename)
1268
## mutter('check %r for control file' % ((head, tail), ))
1269
if tail == bzrlib.BZRDIR:
1762
def bind(self, other):
1763
"""Bind this branch to the branch other.
1765
This does not push or pull data between the branches, though it does
1766
check for divergence to raise an error when the branches are not
1767
either the same, or one a prefix of the other. That behaviour may not
1768
be useful, so that check may be removed in future.
1770
:param other: The branch to bind to
1773
# TODO: jam 20051230 Consider checking if the target is bound
1774
# It is debatable whether you should be able to bind to
1775
# a branch which is itself bound.
1776
# Committing is obviously forbidden,
1777
# but binding itself may not be.
1778
# Since we *have* to check at commit time, we don't
1779
# *need* to check here
1781
# we want to raise diverged if:
1782
# last_rev is not in the other_last_rev history, AND
1783
# other_last_rev is not in our history, and do it without pulling
1785
self.set_bound_location(other.base)
1789
"""If bound, unbind"""
1790
return self.set_bound_location(None)
1793
def update(self, possible_transports=None):
1794
"""Synchronise this branch with the master branch if any.
1796
:return: None or the last_revision that was pivoted out during the
1799
master = self.get_master_branch(possible_transports)
1800
if master is not None:
1801
old_tip = _mod_revision.ensure_null(self.last_revision())
1802
self.pull(master, overwrite=True)
1803
if self.repository.get_graph().is_ancestor(old_tip,
1804
_mod_revision.ensure_null(self.last_revision())):
1810
class BzrBranch6(BzrBranch5):
1813
def last_revision_info(self):
1814
revision_string = self.control_files.get('last-revision').read()
1815
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1816
revision_id = cache_utf8.get_cached_utf8(revision_id)
1818
return revno, revision_id
1820
def _write_last_revision_info(self, revno, revision_id):
1821
"""Simply write out the revision id, with no checks.
1823
Use set_last_revision_info to perform this safely.
1825
Does not update the revision_history cache.
1826
Intended to be called by set_last_revision_info and
1827
_write_revision_history.
1829
assert revision_id is not None, "Use NULL_REVISION, not None"
1830
out_string = '%d %s\n' % (revno, revision_id)
1831
self.control_files.put_bytes('last-revision', out_string)
1834
def set_last_revision_info(self, revno, revision_id):
1835
revision_id = _mod_revision.ensure_null(revision_id)
1836
if self._get_append_revisions_only():
1837
self._check_history_violation(revision_id)
1838
self._write_last_revision_info(revno, revision_id)
1839
self._clear_cached_state()
1841
def _check_history_violation(self, revision_id):
1842
last_revision = _mod_revision.ensure_null(self.last_revision())
1843
if _mod_revision.is_null(last_revision):
1845
if last_revision not in self._lefthand_history(revision_id):
1846
raise errors.AppendRevisionsOnlyViolation(self.base)
1848
def _gen_revision_history(self):
1849
"""Generate the revision history from last revision
1851
history = list(self.repository.iter_reverse_revision_history(
1852
self.last_revision()))
1856
def _write_revision_history(self, history):
1857
"""Factored out of set_revision_history.
1859
This performs the actual writing to disk, with format-specific checks.
1860
It is intended to be called by BzrBranch5.set_revision_history.
1862
if len(history) == 0:
1863
last_revision = 'null:'
1865
if history != self._lefthand_history(history[-1]):
1866
raise errors.NotLefthandHistory(history)
1867
last_revision = history[-1]
1868
if self._get_append_revisions_only():
1869
self._check_history_violation(last_revision)
1870
self._write_last_revision_info(len(history), last_revision)
1873
def _set_parent_location(self, url):
1874
"""Set the parent branch"""
1875
self._set_config_location('parent_location', url, make_relative=True)
1878
def _get_parent_location(self):
1879
"""Set the parent branch"""
1880
return self._get_config_location('parent_location')
1882
def set_push_location(self, location):
1883
"""See Branch.set_push_location."""
1884
self._set_config_location('push_location', location)
1886
def set_bound_location(self, location):
1887
"""See Branch.set_push_location."""
1889
config = self.get_config()
1890
if location is None:
1891
if config.get_user_option('bound') != 'True':
1894
config.set_user_option('bound', 'False', warn_masked=True)
1897
self._set_config_location('bound_location', location,
1899
config.set_user_option('bound', 'True', warn_masked=True)
1902
def _get_bound_location(self, bound):
1903
"""Return the bound location in the config file.
1905
Return None if the bound parameter does not match"""
1906
config = self.get_config()
1907
config_bound = (config.get_user_option('bound') == 'True')
1908
if config_bound != bound:
1910
return self._get_config_location('bound_location', config=config)
1912
def get_bound_location(self):
1913
"""See Branch.set_push_location."""
1914
return self._get_bound_location(True)
1916
def get_old_bound_location(self):
1917
"""See Branch.get_old_bound_location"""
1918
return self._get_bound_location(False)
1920
def set_append_revisions_only(self, enabled):
1925
self.get_config().set_user_option('append_revisions_only', value,
1928
def _get_append_revisions_only(self):
1929
value = self.get_config().get_user_option('append_revisions_only')
1930
return value == 'True'
1932
def _synchronize_history(self, destination, revision_id):
1933
"""Synchronize last revision and revision history between branches.
1935
This version is most efficient when the destination is also a
1936
BzrBranch6, but works for BzrBranch5, as long as the destination's
1937
repository contains all the lefthand ancestors of the intended
1938
last_revision. If not, set_last_revision_info will fail.
1940
:param destination: The branch to copy the history into
1941
:param revision_id: The revision-id to truncate history at. May
1942
be None to copy complete history.
1944
source_revno, source_revision_id = self.last_revision_info()
1945
if revision_id is None:
1946
revno, revision_id = source_revno, source_revision_id
1947
elif source_revision_id == revision_id:
1948
# we know the revno without needing to walk all of history
1949
revno = source_revno
1951
# To figure out the revno for a random revision, we need to build
1952
# the revision history, and count its length.
1953
# We don't care about the order, just how long it is.
1954
# Alternatively, we could start at the current location, and count
1955
# backwards. But there is no guarantee that we will find it since
1956
# it may be a merged revision.
1957
revno = len(list(self.repository.iter_reverse_revision_history(
1959
destination.set_last_revision_info(revno, revision_id)
1961
def _make_tags(self):
1962
return BasicTags(self)
1965
def generate_revision_history(self, revision_id, last_rev=None,
1967
"""See BzrBranch5.generate_revision_history"""
1968
history = self._lefthand_history(revision_id, last_rev, other_branch)
1969
revno = len(history)
1970
self.set_last_revision_info(revno, revision_id)
1973
######################################################################
1974
# results of operations
1977
class _Result(object):
1979
def _show_tag_conficts(self, to_file):
1980
if not getattr(self, 'tag_conflicts', None):
1982
to_file.write('Conflicting tags:\n')
1983
for name, value1, value2 in self.tag_conflicts:
1984
to_file.write(' %s\n' % (name, ))
1987
class PullResult(_Result):
1988
"""Result of a Branch.pull operation.
1990
:ivar old_revno: Revision number before pull.
1991
:ivar new_revno: Revision number after pull.
1992
:ivar old_revid: Tip revision id before pull.
1993
:ivar new_revid: Tip revision id after pull.
1994
:ivar source_branch: Source (local) branch object.
1995
:ivar master_branch: Master branch of the target, or None.
1996
:ivar target_branch: Target/destination branch object.
2000
# DEPRECATED: pull used to return the change in revno
2001
return self.new_revno - self.old_revno
2003
def report(self, to_file):
2005
if self.old_revid == self.new_revid:
2006
to_file.write('No revisions to pull.\n')
2008
to_file.write('Now on revision %d.\n' % self.new_revno)
2009
self._show_tag_conficts(to_file)
2012
class PushResult(_Result):
2013
"""Result of a Branch.push operation.
2015
:ivar old_revno: Revision number before push.
2016
:ivar new_revno: Revision number after push.
2017
:ivar old_revid: Tip revision id before push.
2018
:ivar new_revid: Tip revision id after push.
2019
:ivar source_branch: Source branch object.
2020
:ivar master_branch: Master branch of the target, or None.
2021
:ivar target_branch: Target/destination branch object.
2025
# DEPRECATED: push used to return the change in revno
2026
return self.new_revno - self.old_revno
2028
def report(self, to_file):
2029
"""Write a human-readable description of the result."""
2030
if self.old_revid == self.new_revid:
2031
to_file.write('No new revisions to push.\n')
2033
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2034
self._show_tag_conficts(to_file)
2037
class BranchCheckResult(object):
2038
"""Results of checking branch consistency.
2043
def __init__(self, branch):
2044
self.branch = branch
2046
def report_results(self, verbose):
2047
"""Report the check results via trace.note.
2049
:param verbose: Requests more detailed display of what was checked,
2052
note('checked branch %s format %s',
2054
self.branch._format)
2057
class Converter5to6(object):
2058
"""Perform an in-place upgrade of format 5 to format 6"""
2060
def convert(self, branch):
2061
# Data for 5 and 6 can peacefully coexist.
2062
format = BzrBranchFormat6()
2063
new_branch = format.open(branch.bzrdir, _found=True)
2065
# Copy source data into target
2066
new_branch.set_last_revision_info(*branch.last_revision_info())
2067
new_branch.set_parent(branch.get_parent())
2068
new_branch.set_bound_location(branch.get_bound_location())
2069
new_branch.set_push_location(branch.get_push_location())
2071
# New branch has no tags by default
2072
new_branch.tags._set_tag_dict({})
2074
# Copying done; now update target format
2075
new_branch.control_files.put_utf8('format',
2076
format.get_format_string())
2078
# Clean up old files
2079
new_branch.control_files._transport.delete('revision-history')
2081
branch.set_parent(None)
2082
except errors.NoSuchFile:
2084
branch.set_bound_location(None)
1271
if filename == head:
1278
def gen_file_id(name):
1279
"""Return new file id.
1281
This should probably generate proper UUIDs, but for the moment we
1282
cope with just randomness because running uuidgen every time is
1285
from binascii import hexlify
1286
from time import time
1288
# get last component
1289
idx = name.rfind('/')
1291
name = name[idx+1 : ]
1292
idx = name.rfind('\\')
1294
name = name[idx+1 : ]
1296
# make it not a hidden file
1297
name = name.lstrip('.')
1299
# remove any wierd characters; we don't escape them but rather
1300
# just pull them out
1301
name = re.sub(r'[^\w.]', '', name)
1303
s = hexlify(rand_bytes(8))
1304
return '-'.join((name, compact_date(time()), s))
1308
"""Return a new tree-root file id."""
1309
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
