133
84
"""Branch holding a history of revisions.
136
Base directory of the branch.
142
If _lock_mode is true, a positive count of the number of times the
146
Lock object from bzrlib.lock.
87
Base directory/url of the branch.
89
hooks: An instance of BranchHooks.
91
# this is really an instance variable - FIXME move it there
153
# Map some sort of prefix into a namespace
154
# stuff like "revno:10", "revid:", etc.
155
# This should match a prefix with a function which accepts
156
REVISION_NAMESPACES = {}
158
def __init__(self, base, init=False, find_root=True):
159
"""Create new branch object at a particular location.
161
base -- Base directory for the branch.
163
init -- If True, create new control files in a previously
164
unversioned directory. If False, the branch must already
167
find_root -- If true and init is false, find the root of the
168
existing branch containing base.
170
In the test suite, creation of new trees is tested using the
171
`ScratchBranch` class.
173
from bzrlib.store import ImmutableStore
175
self.base = os.path.realpath(base)
178
self.base = find_branch_root(base)
180
self.base = os.path.realpath(base)
181
if not isdir(self.controlfilename('.')):
182
from errors import NotBranchError
183
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
184
['use "bzr init" to initialize a new working tree',
185
'current bzr can only operate from top-of-tree'])
188
self.text_store = ImmutableStore(self.controlfilename('text-store'))
189
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
190
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
194
return '%s(%r)' % (self.__class__.__name__, self.base)
201
if self._lock_mode or self._lock:
202
from warnings import warn
203
warn("branch %r was not explicitly unlocked" % self)
95
# override this to set the strategy for storing tags
97
return DisabledTags(self)
99
def __init__(self, *ignored, **ignored_too):
100
self.tags = self._make_tags()
101
self._revision_history_cache = None
102
self._revision_id_to_revno_cache = None
104
def break_lock(self):
105
"""Break a lock if one is present from another instance.
107
Uses the ui factory to ask for confirmation if the lock may be from
110
This will probe the repository for its lock as well.
112
self.control_files.break_lock()
113
self.repository.break_lock()
114
master = self.get_master_branch()
115
if master is not None:
119
@deprecated_method(zero_eight)
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
126
"""Open the branch rooted at base.
128
For instance, if the branch is at URL/.bzr/branch,
129
Branch.open(URL) -> a Branch instance.
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url):
136
"""Open an existing branch which contains url.
138
This probes for a branch at url, and searches upwards from there.
140
Basically we keep looking up until we find the control directory or
141
run into the root. If there isn't one, raises NotBranchError.
142
If there is one and it is either an unrecognised format or an unsupported
143
format, UnknownFormatError or UnsupportedFormatError are raised.
144
If there is one, it is returned, along with the unused portion of url.
146
control, relpath = bzrdir.BzrDir.open_containing(url)
147
return control.open_branch(), relpath
150
@deprecated_function(zero_eight)
151
def initialize(base):
152
"""Create a new working tree and branch, rooted at 'base' (url)
154
NOTE: This will soon be deprecated in favour of creation
157
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
159
@deprecated_function(zero_eight)
160
def setup_caching(self, cache_root):
161
"""Subclasses that care about caching should override this, and set
162
up cached stores located under cache_root.
164
NOTE: This is unused.
168
def get_config(self):
169
return BranchConfig(self)
172
return self.get_config().get_nickname()
174
def _set_nick(self, nick):
175
self.get_config().set_user_option('nickname', nick, warn_masked=True)
177
nick = property(_get_nick, _set_nick)
180
raise NotImplementedError(self.is_locked)
208
182
def lock_write(self):
210
if self._lock_mode != 'w':
211
from errors import LockError
212
raise LockError("can't upgrade to a write lock from %r" %
214
self._lock_count += 1
216
from bzrlib.lock import WriteLock
218
self._lock = WriteLock(self.controlfilename('branch-lock'))
219
self._lock_mode = 'w'
183
raise NotImplementedError(self.lock_write)
224
185
def lock_read(self):
226
assert self._lock_mode in ('r', 'w'), \
227
"invalid lock mode %r" % self._lock_mode
228
self._lock_count += 1
230
from bzrlib.lock import ReadLock
232
self._lock = ReadLock(self.controlfilename('branch-lock'))
233
self._lock_mode = 'r'
186
raise NotImplementedError(self.lock_read)
238
188
def unlock(self):
239
if not self._lock_mode:
240
from errors import LockError
241
raise LockError('branch %r is not locked' % (self))
243
if self._lock_count > 1:
244
self._lock_count -= 1
189
raise NotImplementedError(self.unlock)
191
def peek_lock_mode(self):
192
"""Return lock mode for the Branch: 'r', 'w' or None"""
193
raise NotImplementedError(self.peek_lock_mode)
195
def get_physical_lock_status(self):
196
raise NotImplementedError(self.get_physical_lock_status)
199
def get_revision_id_to_revno_map(self):
200
"""Return the revision_id => dotted revno map.
202
This will be regenerated on demand, but will be cached.
204
:return: A dictionary mapping revision_id => dotted revno.
205
This dictionary should not be modified by the caller.
207
if self._revision_id_to_revno_cache is not None:
208
mapping = self._revision_id_to_revno_cache
248
self._lock_mode = self._lock_count = None
210
mapping = self._gen_revno_map()
211
self._cache_revision_id_to_revno(mapping)
212
# TODO: jam 20070417 Since this is being cached, should we be returning
214
# I would rather not, and instead just declare that users should not
215
# modify the return value.
218
def _gen_revno_map(self):
219
"""Create a new mapping from revision ids to dotted revnos.
221
Dotted revnos are generated based on the current tip in the revision
223
This is the worker function for get_revision_id_to_revno_map, which
224
just caches the return value.
226
:return: A dictionary mapping revision_id => dotted revno.
228
last_revision = self.last_revision()
229
revision_graph = self.repository.get_revision_graph(last_revision)
230
merge_sorted_revisions = tsort.merge_sort(
235
revision_id_to_revno = dict((rev_id, revno)
236
for seq_num, rev_id, depth, revno, end_of_merge
237
in merge_sorted_revisions)
238
return revision_id_to_revno
240
def leave_lock_in_place(self):
241
"""Tell this branch object not to release the physical lock when this
244
If lock_write doesn't return a token, then this method is not supported.
246
self.control_files.leave_in_place()
248
def dont_leave_lock_in_place(self):
249
"""Tell this branch object to release the physical lock when this
250
object is unlocked, even if it didn't originally acquire it.
252
If lock_write doesn't return a token, then this method is not supported.
254
self.control_files.dont_leave_in_place()
251
256
def abspath(self, name):
252
"""Return absolute filename for something in the branch"""
253
return os.path.join(self.base, name)
256
def relpath(self, path):
257
"""Return path relative to this branch of something inside it.
259
Raises an error if path is not in this branch."""
260
return _relpath(self.base, path)
263
def controlfilename(self, file_or_path):
264
"""Return location relative to branch."""
265
if isinstance(file_or_path, basestring):
266
file_or_path = [file_or_path]
267
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
270
def controlfile(self, file_or_path, mode='r'):
271
"""Open a control file for this branch.
273
There are two classes of file in the control directory: text
274
and binary. binary files are untranslated byte streams. Text
275
control files are stored with Unix newlines and in UTF-8, even
276
if the platform or locale defaults are different.
278
Controlfiles should almost never be opened in write mode but
279
rather should be atomically copied and replaced using atomicfile.
282
fn = self.controlfilename(file_or_path)
284
if mode == 'rb' or mode == 'wb':
285
return file(fn, mode)
286
elif mode == 'r' or mode == 'w':
287
# open in binary mode anyhow so there's no newline translation;
288
# codecs uses line buffering by default; don't want that.
290
return codecs.open(fn, mode + 'b', 'utf-8',
257
"""Return absolute filename for something in the branch
259
XXX: Robert Collins 20051017 what is this used for? why is it a branch
260
method and not a tree method.
262
raise NotImplementedError(self.abspath)
264
def bind(self, other):
265
"""Bind the local branch the other branch.
267
:param other: The branch to bind to
270
raise errors.UpgradeRequired(self.base)
273
def fetch(self, from_branch, last_revision=None, pb=None):
274
"""Copy revisions from from_branch into this branch.
276
:param from_branch: Where to copy from.
277
:param last_revision: What revision to stop at (None for at the end
279
:param pb: An optional progress bar to use.
281
Returns the copied revision count and the failed revisions in a tuple:
284
if self.base == from_branch.base:
287
nested_pb = ui.ui_factory.nested_progress_bar()
293
raise BzrError("invalid controlfile mode %r" % mode)
297
def _make_control(self):
298
from bzrlib.inventory import Inventory
299
from bzrlib.xml import pack_xml
301
os.mkdir(self.controlfilename([]))
302
self.controlfile('README', 'w').write(
303
"This is a Bazaar-NG control directory.\n"
304
"Do not change any files in this directory.\n")
305
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
306
for d in ('text-store', 'inventory-store', 'revision-store'):
307
os.mkdir(self.controlfilename(d))
308
for f in ('revision-history', 'merged-patches',
309
'pending-merged-patches', 'branch-name',
312
self.controlfile(f, 'w').write('')
313
mutter('created control directory in ' + self.base)
315
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
318
def _check_format(self):
319
"""Check this branch format is supported.
321
The current tool only supports the current unstable format.
323
In the future, we might need different in-memory Branch
324
classes to support downlevel branches. But not yet.
326
# This ignores newlines so that we can open branches created
327
# on Windows from Linux and so on. I think it might be better
328
# to always make all internal files in unix format.
329
fmt = self.controlfile('branch-format', 'r').read()
330
fmt.replace('\r\n', '')
331
if fmt != BZR_BRANCH_FORMAT:
332
raise BzrError('sorry, branch format %r not supported' % fmt,
333
['use a different bzr version',
334
'or remove the .bzr directory and "bzr init" again'])
292
from_branch.lock_read()
294
if last_revision is None:
295
pb.update('get source history')
296
last_revision = from_branch.last_revision()
297
if last_revision is None:
298
last_revision = _mod_revision.NULL_REVISION
299
return self.repository.fetch(from_branch.repository,
300
revision_id=last_revision,
303
if nested_pb is not None:
307
def get_bound_location(self):
308
"""Return the URL of the branch we are bound to.
310
Older format branches cannot bind, please be sure to use a metadir
315
def get_old_bound_location(self):
316
"""Return the URL of the branch we used to be bound to
318
raise errors.UpgradeRequired(self.base)
320
def get_commit_builder(self, parents, config=None, timestamp=None,
321
timezone=None, committer=None, revprops=None,
323
"""Obtain a CommitBuilder for this branch.
325
:param parents: Revision ids of the parents of the new revision.
326
:param config: Optional configuration to use.
327
:param timestamp: Optional timestamp recorded for commit.
328
:param timezone: Optional timezone for timestamp.
329
:param committer: Optional committer to set for commit.
330
:param revprops: Optional dictionary of revision properties.
331
:param revision_id: Optional revision id.
335
config = self.get_config()
337
return self.repository.get_commit_builder(self, parents, config,
338
timestamp, timezone, committer, revprops, revision_id)
340
def get_master_branch(self):
341
"""Return the branch we are bound to.
343
:return: Either a Branch, or None
347
def get_revision_delta(self, revno):
348
"""Return the delta for one revision.
350
The delta is relative to its mainline predecessor, or the
351
empty tree for revision 1.
353
assert isinstance(revno, int)
354
rh = self.revision_history()
355
if not (1 <= revno <= len(rh)):
356
raise InvalidRevisionNumber(revno)
357
return self.repository.get_revision_delta(rh[revno-1])
359
@deprecated_method(zero_sixteen)
336
360
def get_root_id(self):
337
"""Return the id of this branches root"""
338
inv = self.read_working_inventory()
339
return inv.root.file_id
341
def set_root_id(self, file_id):
342
inv = self.read_working_inventory()
343
orig_root_id = inv.root.file_id
344
del inv._byid[inv.root.file_id]
345
inv.root.file_id = file_id
346
inv._byid[inv.root.file_id] = inv.root
349
if entry.parent_id in (None, orig_root_id):
350
entry.parent_id = inv.root.file_id
351
self._write_inventory(inv)
353
def read_working_inventory(self):
354
"""Read the working inventory."""
355
from bzrlib.inventory import Inventory
356
from bzrlib.xml import unpack_xml
357
from time import time
361
# ElementTree does its own conversion from UTF-8, so open in
363
inv = unpack_xml(Inventory,
364
self.controlfile('inventory', 'rb'))
365
mutter("loaded inventory of %d items in %f"
366
% (len(inv), time() - before))
372
def _write_inventory(self, inv):
373
"""Update the working inventory.
375
That is to say, the inventory describing changes underway, that
376
will be committed to the next revision.
378
from bzrlib.atomicfile import AtomicFile
379
from bzrlib.xml import pack_xml
383
f = AtomicFile(self.controlfilename('inventory'), 'wb')
392
mutter('wrote working inventory')
395
inventory = property(read_working_inventory, _write_inventory, None,
396
"""Inventory for the working copy.""")
399
def add(self, files, verbose=False, ids=None):
400
"""Make files versioned.
402
Note that the command line normally calls smart_add instead.
404
This puts the files in the Added state, so that they will be
405
recorded by the next commit.
408
List of paths to add, relative to the base of the tree.
411
If set, use these instead of automatically generated ids.
412
Must be the same length as the list of files, but may
413
contain None for ids that are to be autogenerated.
415
TODO: Perhaps have an option to add the ids even if the files do
418
TODO: Perhaps return the ids of the files? But then again it
419
is easy to retrieve them if they're needed.
421
TODO: Adding a directory should optionally recurse down and
422
add all non-ignored children. Perhaps do that in a
425
from bzrlib.textui import show_status
426
# TODO: Re-adding a file that is removed in the working copy
427
# should probably put it back with the previous ID.
428
if isinstance(files, basestring):
429
assert(ids is None or isinstance(ids, basestring))
435
ids = [None] * len(files)
437
assert(len(ids) == len(files))
441
inv = self.read_working_inventory()
442
for f,file_id in zip(files, ids):
443
if is_control_file(f):
444
raise BzrError("cannot add control file %s" % quotefn(f))
449
raise BzrError("cannot add top-level %r" % f)
451
fullpath = os.path.normpath(self.abspath(f))
454
kind = file_kind(fullpath)
456
# maybe something better?
457
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
459
if kind != 'file' and kind != 'directory':
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
463
file_id = gen_file_id(f)
464
inv.add_path(f, kind=kind, file_id=file_id)
467
print 'added', quotefn(f)
469
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
471
self._write_inventory(inv)
476
def print_file(self, file, revno):
361
"""Return the id of this branches root
363
Deprecated: branches don't have root ids-- trees do.
364
Use basis_tree().get_root_id() instead.
366
raise NotImplementedError(self.get_root_id)
368
def print_file(self, file, revision_id):
477
369
"""Print `file` to stdout."""
480
tree = self.revision_tree(self.lookup_revision(revno))
481
# use inventory as it was in that revision
482
file_id = tree.inventory.path2id(file)
484
raise BzrError("%r is not present in revision %s" % (file, revno))
485
tree.print_file(file_id)
490
def remove(self, files, verbose=False):
491
"""Mark nominated files for removal from the inventory.
493
This does not remove their text. This does not run on
495
TODO: Refuse to remove modified files unless --force is given?
497
TODO: Do something useful with directories.
499
TODO: Should this remove the text or not? Tough call; not
500
removing may be useful and the user can just use use rm, and
501
is the opposite of add. Removing it is consistent with most
502
other tools. Maybe an option.
504
from bzrlib.textui import show_status
505
## TODO: Normalize names
506
## TODO: Remove nested loops; better scalability
507
if isinstance(files, basestring):
513
tree = self.working_tree()
516
# do this before any modifications
520
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
521
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
523
# having remove it, it must be either ignored or unknown
524
if tree.is_ignored(f):
528
show_status(new_status, inv[fid].kind, quotefn(f))
531
self._write_inventory(inv)
536
# FIXME: this doesn't need to be a branch method
537
def set_inventory(self, new_inventory_list):
538
from bzrlib.inventory import Inventory, InventoryEntry
539
inv = Inventory(self.get_root_id())
540
for path, file_id, parent, kind in new_inventory_list:
541
name = os.path.basename(path)
544
inv.add(InventoryEntry(file_id, name, kind, parent))
545
self._write_inventory(inv)
549
"""Return all unknown files.
551
These are files in the working directory that are not versioned or
552
control files or ignored.
554
>>> b = ScratchBranch(files=['foo', 'foo~'])
555
>>> list(b.unknowns())
558
>>> list(b.unknowns())
561
>>> list(b.unknowns())
564
return self.working_tree().unknowns()
370
raise NotImplementedError(self.print_file)
567
372
def append_revision(self, *revision_ids):
568
from bzrlib.atomicfile import AtomicFile
570
for revision_id in revision_ids:
571
mutter("add {%s} to revision-history" % revision_id)
573
rev_history = self.revision_history()
574
rev_history.extend(revision_ids)
576
f = AtomicFile(self.controlfilename('revision-history'))
578
for rev_id in rev_history:
585
def get_revision(self, revision_id):
586
"""Return the Revision object for a named revision"""
587
from bzrlib.revision import Revision
588
from bzrlib.xml import unpack_xml
592
if not revision_id or not isinstance(revision_id, basestring):
593
raise ValueError('invalid revision-id: %r' % revision_id)
594
r = unpack_xml(Revision, self.revision_store[revision_id])
598
assert r.revision_id == revision_id
602
def get_revision_sha1(self, revision_id):
603
"""Hash the stored value of a revision, and return it."""
604
# In the future, revision entries will be signed. At that
605
# point, it is probably best *not* to include the signature
606
# in the revision hash. Because that lets you re-sign
607
# the revision, (add signatures/remove signatures) and still
608
# have all hash pointers stay consistent.
609
# But for now, just hash the contents.
610
return sha_file(self.revision_store[revision_id])
613
def get_inventory(self, inventory_id):
614
"""Get Inventory object by hash.
616
TODO: Perhaps for this and similar methods, take a revision
617
parameter which can be either an integer revno or a
619
from bzrlib.inventory import Inventory
620
from bzrlib.xml import unpack_xml
622
return unpack_xml(Inventory, self.inventory_store[inventory_id])
625
def get_inventory_sha1(self, inventory_id):
626
"""Return the sha1 hash of the inventory entry
628
return sha_file(self.inventory_store[inventory_id])
631
def get_revision_inventory(self, revision_id):
632
"""Return inventory of a past revision."""
633
# bzr 0.0.6 imposes the constraint that the inventory_id
634
# must be the same as its revision, so this is trivial.
635
if revision_id == None:
636
from bzrlib.inventory import Inventory
637
return Inventory(self.get_root_id())
639
return self.get_inventory(revision_id)
373
raise NotImplementedError(self.append_revision)
375
def set_revision_history(self, rev_history):
376
raise NotImplementedError(self.set_revision_history)
378
def _cache_revision_history(self, rev_history):
379
"""Set the cached revision history to rev_history.
381
The revision_history method will use this cache to avoid regenerating
382
the revision history.
384
This API is semi-public; it only for use by subclasses, all other code
385
should consider it to be private.
387
self._revision_history_cache = rev_history
389
def _cache_revision_id_to_revno(self, revision_id_to_revno):
390
"""Set the cached revision_id => revno map to revision_id_to_revno.
392
This API is semi-public; it only for use by subclasses, all other code
393
should consider it to be private.
395
self._revision_id_to_revno_cache = revision_id_to_revno
397
def _clear_cached_state(self):
398
"""Clear any cached data on this branch, e.g. cached revision history.
400
This means the next call to revision_history will need to call
401
_gen_revision_history.
403
This API is semi-public; it only for use by subclasses, all other code
404
should consider it to be private.
406
self._revision_history_cache = None
407
self._revision_id_to_revno_cache = None
409
def _gen_revision_history(self):
410
"""Return sequence of revision hashes on to this branch.
412
Unlike revision_history, this method always regenerates or rereads the
413
revision history, i.e. it does not cache the result, so repeated calls
416
Concrete subclasses should override this instead of revision_history so
417
that subclasses do not need to deal with caching logic.
419
This API is semi-public; it only for use by subclasses, all other code
420
should consider it to be private.
422
raise NotImplementedError(self._gen_revision_history)
642
425
def revision_history(self):
643
426
"""Return sequence of revision hashes on to this branch.
645
>>> ScratchBranch().revision_history()
650
return [l.rstrip('\r\n') for l in
651
self.controlfile('revision-history', 'r').readlines()]
656
def common_ancestor(self, other, self_revno=None, other_revno=None):
659
>>> sb = ScratchBranch(files=['foo', 'foo~'])
660
>>> sb.common_ancestor(sb) == (None, None)
662
>>> commit.commit(sb, "Committing first revision", verbose=False)
663
>>> sb.common_ancestor(sb)[0]
665
>>> clone = sb.clone()
666
>>> commit.commit(sb, "Committing second revision", verbose=False)
667
>>> sb.common_ancestor(sb)[0]
669
>>> sb.common_ancestor(clone)[0]
671
>>> commit.commit(clone, "Committing divergent second revision",
673
>>> sb.common_ancestor(clone)[0]
675
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
677
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
679
>>> clone2 = sb.clone()
680
>>> sb.common_ancestor(clone2)[0]
682
>>> sb.common_ancestor(clone2, self_revno=1)[0]
684
>>> sb.common_ancestor(clone2, other_revno=1)[0]
687
my_history = self.revision_history()
688
other_history = other.revision_history()
689
if self_revno is None:
690
self_revno = len(my_history)
691
if other_revno is None:
692
other_revno = len(other_history)
693
indices = range(min((self_revno, other_revno)))
696
if my_history[r] == other_history[r]:
697
return r+1, my_history[r]
700
def enum_history(self, direction):
701
"""Return (revno, revision_id) for history of branch.
704
'forward' is from earliest to latest
705
'reverse' is from latest to earliest
707
rh = self.revision_history()
708
if direction == 'forward':
713
elif direction == 'reverse':
428
This method will cache the revision history for as long as it is safe to
431
if self._revision_history_cache is not None:
432
history = self._revision_history_cache
719
raise ValueError('invalid history direction', direction)
434
history = self._gen_revision_history()
435
self._cache_revision_history(history)
723
439
"""Return current revision number for this branch.
777
489
if stop_revision is None:
778
490
stop_revision = other_len
779
elif stop_revision > other_len:
780
raise NoSuchRevision(self, stop_revision)
492
assert isinstance(stop_revision, int)
493
if stop_revision > other_len:
494
raise errors.NoSuchRevision(self, stop_revision)
782
495
return other_history[self_len:stop_revision]
785
497
def update_revisions(self, other, stop_revision=None):
786
"""Pull in all new revisions from other branch.
788
>>> from bzrlib.commit import commit
789
>>> bzrlib.trace.silent = True
790
>>> br1 = ScratchBranch(files=['foo', 'bar'])
793
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
794
>>> br2 = ScratchBranch()
795
>>> br2.update_revisions(br1)
799
>>> br2.revision_history()
801
>>> br2.update_revisions(br1)
805
>>> br1.text_store.total_size() == br2.text_store.total_size()
808
from bzrlib.progress import ProgressBar
812
pb.update('comparing histories')
813
revision_ids = self.missing_revisions(other, stop_revision)
815
if hasattr(other.revision_store, "prefetch"):
816
other.revision_store.prefetch(revision_ids)
817
if hasattr(other.inventory_store, "prefetch"):
818
inventory_ids = [other.get_revision(r).inventory_id
819
for r in revision_ids]
820
other.inventory_store.prefetch(inventory_ids)
825
for rev_id in revision_ids:
827
pb.update('fetching revision', i, len(revision_ids))
828
rev = other.get_revision(rev_id)
829
revisions.append(rev)
830
inv = other.get_inventory(str(rev.inventory_id))
831
for key, entry in inv.iter_entries():
832
if entry.text_id is None:
834
if entry.text_id not in self.text_store:
835
needed_texts.add(entry.text_id)
839
count = self.text_store.copy_multi(other.text_store, needed_texts)
840
print "Added %d texts." % count
841
inventory_ids = [ f.inventory_id for f in revisions ]
842
count = self.inventory_store.copy_multi(other.inventory_store,
844
print "Added %d inventories." % count
845
revision_ids = [ f.revision_id for f in revisions]
846
count = self.revision_store.copy_multi(other.revision_store,
848
for revision_id in revision_ids:
849
self.append_revision(revision_id)
850
print "Added %d revisions." % count
853
def commit(self, *args, **kw):
854
from bzrlib.commit import commit
855
commit(self, *args, **kw)
858
def lookup_revision(self, revision):
859
"""Return the revision identifier for a given revision information."""
860
revno, info = self.get_revision_info(revision)
863
def get_revision_info(self, revision):
864
"""Return (revno, revision id) for revision identifier.
866
revision can be an integer, in which case it is assumed to be revno (though
867
this will translate negative values into positive ones)
868
revision can also be a string, in which case it is parsed for something like
869
'date:' or 'revid:' etc.
874
try:# Convert to int if possible
875
revision = int(revision)
878
revs = self.revision_history()
879
if isinstance(revision, int):
882
# Mabye we should do this first, but we don't need it if revision == 0
884
revno = len(revs) + revision + 1
887
elif isinstance(revision, basestring):
888
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
889
if revision.startswith(prefix):
890
revno = func(self, revs, revision)
893
raise BzrError('No namespace registered for string: %r' % revision)
895
if revno is None or revno <= 0 or revno > len(revs):
896
raise BzrError("no such revision %s" % revision)
897
return revno, revs[revno-1]
899
def _namespace_revno(self, revs, revision):
900
"""Lookup a revision by revision number"""
901
assert revision.startswith('revno:')
903
return int(revision[6:])
906
REVISION_NAMESPACES['revno:'] = _namespace_revno
908
def _namespace_revid(self, revs, revision):
909
assert revision.startswith('revid:')
911
return revs.index(revision[6:]) + 1
914
REVISION_NAMESPACES['revid:'] = _namespace_revid
916
def _namespace_last(self, revs, revision):
917
assert revision.startswith('last:')
919
offset = int(revision[5:])
924
raise BzrError('You must supply a positive value for --revision last:XXX')
925
return len(revs) - offset + 1
926
REVISION_NAMESPACES['last:'] = _namespace_last
928
def _namespace_tag(self, revs, revision):
929
assert revision.startswith('tag:')
930
raise BzrError('tag: namespace registered, but not implemented.')
931
REVISION_NAMESPACES['tag:'] = _namespace_tag
933
def _namespace_date(self, revs, revision):
934
assert revision.startswith('date:')
936
# Spec for date revisions:
938
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
939
# it can also start with a '+/-/='. '+' says match the first
940
# entry after the given date. '-' is match the first entry before the date
941
# '=' is match the first entry after, but still on the given date.
943
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
944
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
945
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
946
# May 13th, 2005 at 0:00
948
# So the proper way of saying 'give me all entries for today' is:
949
# -r {date:+today}:{date:-tomorrow}
950
# The default is '=' when not supplied
953
if val[:1] in ('+', '-', '='):
954
match_style = val[:1]
957
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
958
if val.lower() == 'yesterday':
959
dt = today - datetime.timedelta(days=1)
960
elif val.lower() == 'today':
962
elif val.lower() == 'tomorrow':
963
dt = today + datetime.timedelta(days=1)
966
# This should be done outside the function to avoid recompiling it.
967
_date_re = re.compile(
968
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
970
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
972
m = _date_re.match(val)
973
if not m or (not m.group('date') and not m.group('time')):
974
raise BzrError('Invalid revision date %r' % revision)
977
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
979
year, month, day = today.year, today.month, today.day
981
hour = int(m.group('hour'))
982
minute = int(m.group('minute'))
983
if m.group('second'):
984
second = int(m.group('second'))
988
hour, minute, second = 0,0,0
990
dt = datetime.datetime(year=year, month=month, day=day,
991
hour=hour, minute=minute, second=second)
995
if match_style == '-':
997
elif match_style == '=':
998
last = dt + datetime.timedelta(days=1)
1001
for i in range(len(revs)-1, -1, -1):
1002
r = self.get_revision(revs[i])
1003
# TODO: Handle timezone.
1004
dt = datetime.datetime.fromtimestamp(r.timestamp)
1005
if first >= dt and (last is None or dt >= last):
1008
for i in range(len(revs)):
1009
r = self.get_revision(revs[i])
1010
# TODO: Handle timezone.
1011
dt = datetime.datetime.fromtimestamp(r.timestamp)
1012
if first <= dt and (last is None or dt <= last):
1014
REVISION_NAMESPACES['date:'] = _namespace_date
1016
def revision_tree(self, revision_id):
1017
"""Return Tree for a revision on this branch.
1019
`revision_id` may be None for the null revision, in which case
1020
an `EmptyTree` is returned."""
1021
from bzrlib.tree import EmptyTree, RevisionTree
1022
# TODO: refactor this to use an existing revision object
1023
# so we don't need to read it in twice.
1024
if revision_id == None:
1025
return EmptyTree(self.get_root_id())
1027
inv = self.get_revision_inventory(revision_id)
1028
return RevisionTree(self.text_store, inv)
1031
def working_tree(self):
1032
"""Return a `Tree` for the working copy."""
1033
from workingtree import WorkingTree
1034
return WorkingTree(self.base, self.read_working_inventory())
498
"""Pull in new perfect-fit revisions.
500
:param other: Another Branch to pull from
501
:param stop_revision: Updated until the given revision
504
raise NotImplementedError(self.update_revisions)
506
def revision_id_to_revno(self, revision_id):
507
"""Given a revision id, return its revno"""
508
if _mod_revision.is_null(revision_id):
510
revision_id = osutils.safe_revision_id(revision_id)
511
history = self.revision_history()
513
return history.index(revision_id) + 1
515
raise errors.NoSuchRevision(self, revision_id)
517
def get_rev_id(self, revno, history=None):
518
"""Find the revision id of the specified revno."""
522
history = self.revision_history()
523
if revno <= 0 or revno > len(history):
524
raise errors.NoSuchRevision(self, revno)
525
return history[revno - 1]
527
def pull(self, source, overwrite=False, stop_revision=None):
528
"""Mirror source into this branch.
530
This branch is considered to be 'local', having low latency.
532
:returns: PullResult instance
534
raise NotImplementedError(self.pull)
536
def push(self, target, overwrite=False, stop_revision=None):
537
"""Mirror this branch into target.
539
This branch is considered to be 'local', having low latency.
541
raise NotImplementedError(self.push)
1037
543
def basis_tree(self):
1038
"""Return `Tree` object for last revision.
1040
If there are no revisions yet, return an `EmptyTree`.
1042
from bzrlib.tree import EmptyTree, RevisionTree
1043
r = self.last_patch()
1045
return EmptyTree(self.get_root_id())
1047
return RevisionTree(self.text_store, self.get_revision_inventory(r))
544
"""Return `Tree` object for last revision."""
545
return self.repository.revision_tree(self.last_revision())
1051
547
def rename_one(self, from_rel, to_rel):
1052
548
"""Rename one file.
1054
550
This can change the directory or the filename or both.
1058
tree = self.working_tree()
1059
inv = tree.inventory
1060
if not tree.has_filename(from_rel):
1061
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1062
if tree.has_filename(to_rel):
1063
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1065
file_id = inv.path2id(from_rel)
1067
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1069
if inv.path2id(to_rel):
1070
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1072
to_dir, to_tail = os.path.split(to_rel)
1073
to_dir_id = inv.path2id(to_dir)
1074
if to_dir_id == None and to_dir != '':
1075
raise BzrError("can't determine destination directory id for %r" % to_dir)
1077
mutter("rename_one:")
1078
mutter(" file_id {%s}" % file_id)
1079
mutter(" from_rel %r" % from_rel)
1080
mutter(" to_rel %r" % to_rel)
1081
mutter(" to_dir %r" % to_dir)
1082
mutter(" to_dir_id {%s}" % to_dir_id)
1084
inv.rename(file_id, to_dir_id, to_tail)
1086
print "%s => %s" % (from_rel, to_rel)
1088
from_abs = self.abspath(from_rel)
1089
to_abs = self.abspath(to_rel)
1091
os.rename(from_abs, to_abs)
1093
raise BzrError("failed to rename %r to %r: %s"
1094
% (from_abs, to_abs, e[1]),
1095
["rename rolled back"])
1097
self._write_inventory(inv)
552
raise NotImplementedError(self.rename_one)
1102
554
def move(self, from_paths, to_name):
1103
555
"""Rename files.
1110
562
Note that to_name is only the last component of the new name;
1111
563
this doesn't change the directory.
1115
## TODO: Option to move IDs only
1116
assert not isinstance(from_paths, basestring)
1117
tree = self.working_tree()
1118
inv = tree.inventory
1119
to_abs = self.abspath(to_name)
1120
if not isdir(to_abs):
1121
raise BzrError("destination %r is not a directory" % to_abs)
1122
if not tree.has_filename(to_name):
1123
raise BzrError("destination %r not in working directory" % to_abs)
1124
to_dir_id = inv.path2id(to_name)
1125
if to_dir_id == None and to_name != '':
1126
raise BzrError("destination %r is not a versioned directory" % to_name)
1127
to_dir_ie = inv[to_dir_id]
1128
if to_dir_ie.kind not in ('directory', 'root_directory'):
1129
raise BzrError("destination %r is not a directory" % to_abs)
1131
to_idpath = inv.get_idpath(to_dir_id)
1133
for f in from_paths:
1134
if not tree.has_filename(f):
1135
raise BzrError("%r does not exist in working tree" % f)
1136
f_id = inv.path2id(f)
1138
raise BzrError("%r is not versioned" % f)
1139
name_tail = splitpath(f)[-1]
1140
dest_path = appendpath(to_name, name_tail)
1141
if tree.has_filename(dest_path):
1142
raise BzrError("destination %r already exists" % dest_path)
1143
if f_id in to_idpath:
1144
raise BzrError("can't move %r to a subdirectory of itself" % f)
1146
# OK, so there's a race here, it's possible that someone will
1147
# create a file in this interval and then the rename might be
1148
# left half-done. But we should have caught most problems.
1150
for f in from_paths:
1151
name_tail = splitpath(f)[-1]
1152
dest_path = appendpath(to_name, name_tail)
1153
print "%s => %s" % (f, dest_path)
1154
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1156
os.rename(self.abspath(f), self.abspath(dest_path))
1158
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1159
["rename rolled back"])
1161
self._write_inventory(inv)
1166
def revert(self, filenames, old_tree=None, backups=True):
1167
"""Restore selected files to the versions from a previous tree.
1170
If true (default) backups are made of files before
1173
from bzrlib.errors import NotVersionedError, BzrError
1174
from bzrlib.atomicfile import AtomicFile
1175
from bzrlib.osutils import backup_file
1177
inv = self.read_working_inventory()
1178
if old_tree is None:
1179
old_tree = self.basis_tree()
1180
old_inv = old_tree.inventory
1183
for fn in filenames:
1184
file_id = inv.path2id(fn)
1186
raise NotVersionedError("not a versioned file", fn)
1187
if not old_inv.has_id(file_id):
1188
raise BzrError("file not present in old tree", fn, file_id)
1189
nids.append((fn, file_id))
1191
# TODO: Rename back if it was previously at a different location
1193
# TODO: If given a directory, restore the entire contents from
1194
# the previous version.
1196
# TODO: Make a backup to a temporary file.
1198
# TODO: If the file previously didn't exist, delete it?
1199
for fn, file_id in nids:
1202
f = AtomicFile(fn, 'wb')
1204
f.write(old_tree.get_file(file_id).read())
1210
def pending_merges(self):
1211
"""Return a list of pending merges.
1213
These are revisions that have been merged into the working
1214
directory but not yet committed.
1216
cfn = self.controlfilename('pending-merges')
1217
if not os.path.exists(cfn):
1220
for l in self.controlfile('pending-merges', 'r').readlines():
1221
p.append(l.rstrip('\n'))
1225
def add_pending_merge(self, revision_id):
1226
from bzrlib.revision import validate_revision_id
1228
validate_revision_id(revision_id)
1230
p = self.pending_merges()
1231
if revision_id in p:
1233
p.append(revision_id)
1234
self.set_pending_merges(p)
1237
def set_pending_merges(self, rev_list):
1238
from bzrlib.atomicfile import AtomicFile
1241
f = AtomicFile(self.controlfilename('pending-merges'))
1253
class ScratchBranch(Branch):
1254
"""Special test class: a branch that cleans up after itself.
1256
>>> b = ScratchBranch()
1264
def __init__(self, files=[], dirs=[], base=None):
1265
"""Make a test branch.
1267
This creates a temporary directory and runs init-tree in it.
1269
If any files are listed, they are created in the working copy.
1271
from tempfile import mkdtemp
1276
Branch.__init__(self, base, init=init)
1278
os.mkdir(self.abspath(d))
1281
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1286
>>> orig = ScratchBranch(files=["file1", "file2"])
1287
>>> clone = orig.clone()
1288
>>> os.path.samefile(orig.base, clone.base)
1290
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1293
from shutil import copytree
1294
from tempfile import mkdtemp
1297
copytree(self.base, base, symlinks=True)
1298
return ScratchBranch(base=base)
1304
"""Destroy the test branch, removing the scratch directory."""
1305
from shutil import rmtree
1308
mutter("delete ScratchBranch %s" % self.base)
1311
# Work around for shutil.rmtree failing on Windows when
1312
# readonly files are encountered
1313
mutter("hit exception in destroying ScratchBranch: %s" % e)
1314
for root, dirs, files in os.walk(self.base, topdown=False):
1316
os.chmod(os.path.join(root, name), 0700)
1322
######################################################################
1326
def is_control_file(filename):
1327
## FIXME: better check
1328
filename = os.path.normpath(filename)
1329
while filename != '':
1330
head, tail = os.path.split(filename)
1331
## mutter('check %r for control file' % ((head, tail), ))
1332
if tail == bzrlib.BZRDIR:
565
This returns a list of (from_path, to_path) pairs for each
568
raise NotImplementedError(self.move)
570
def get_parent(self):
571
"""Return the parent location of the branch.
573
This is the default location for push/pull/missing. The usual
574
pattern is that the user can override it by specifying a
577
raise NotImplementedError(self.get_parent)
579
def _set_config_location(self, name, url, config=None,
580
make_relative=False):
582
config = self.get_config()
586
url = urlutils.relative_url(self.base, url)
587
config.set_user_option(name, url, warn_masked=True)
589
def _get_config_location(self, name, config=None):
591
config = self.get_config()
592
location = config.get_user_option(name)
597
def get_submit_branch(self):
598
"""Return the submit location of the branch.
600
This is the default location for bundle. The usual
601
pattern is that the user can override it by specifying a
604
return self.get_config().get_user_option('submit_branch')
606
def set_submit_branch(self, location):
607
"""Return the submit location of the branch.
609
This is the default location for bundle. The usual
610
pattern is that the user can override it by specifying a
613
self.get_config().set_user_option('submit_branch', location,
616
def get_public_branch(self):
617
"""Return the public location of the branch.
619
This is is used by merge directives.
621
return self._get_config_location('public_branch')
623
def set_public_branch(self, location):
624
"""Return the submit location of the branch.
626
This is the default location for bundle. The usual
627
pattern is that the user can override it by specifying a
630
self._set_config_location('public_branch', location)
632
def get_push_location(self):
633
"""Return the None or the location to push this branch to."""
634
push_loc = self.get_config().get_user_option('push_location')
637
def set_push_location(self, location):
638
"""Set a new push location for this branch."""
639
raise NotImplementedError(self.set_push_location)
641
def set_parent(self, url):
642
raise NotImplementedError(self.set_parent)
646
"""Synchronise this branch with the master branch if any.
648
:return: None or the last_revision pivoted out during the update.
652
def check_revno(self, revno):
654
Check whether a revno corresponds to any revision.
655
Zero (the NULL revision) is considered valid.
658
self.check_real_revno(revno)
660
def check_real_revno(self, revno):
662
Check whether a revno corresponds to a real revision.
663
Zero (the NULL revision) is considered invalid
665
if revno < 1 or revno > self.revno():
666
raise InvalidRevisionNumber(revno)
669
def clone(self, to_bzrdir, revision_id=None):
670
"""Clone this branch into to_bzrdir preserving all semantic values.
672
revision_id: if not None, the revision history in the new branch will
673
be truncated to end with revision_id.
675
result = self._format.initialize(to_bzrdir)
676
self.copy_content_into(result, revision_id=revision_id)
680
def sprout(self, to_bzrdir, revision_id=None):
681
"""Create a new line of development from the branch, into to_bzrdir.
683
revision_id: if not None, the revision history in the new branch will
684
be truncated to end with revision_id.
686
result = self._format.initialize(to_bzrdir)
687
self.copy_content_into(result, revision_id=revision_id)
688
result.set_parent(self.bzrdir.root_transport.base)
691
def _synchronize_history(self, destination, revision_id):
692
"""Synchronize last revision and revision history between branches.
694
This version is most efficient when the destination is also a
695
BzrBranch5, but works for BzrBranch6 as long as the revision
696
history is the true lefthand parent history, and all of the revisions
697
are in the destination's repository. If not, set_revision_history
700
:param destination: The branch to copy the history into
701
:param revision_id: The revision-id to truncate history at. May
702
be None to copy complete history.
704
if revision_id == _mod_revision.NULL_REVISION:
706
new_history = self.revision_history()
707
if revision_id is not None and new_history != []:
708
revision_id = osutils.safe_revision_id(revision_id)
710
new_history = new_history[:new_history.index(revision_id) + 1]
712
rev = self.repository.get_revision(revision_id)
713
new_history = rev.get_history(self.repository)[1:]
714
destination.set_revision_history(new_history)
717
def copy_content_into(self, destination, revision_id=None):
718
"""Copy the content of self into destination.
720
revision_id: if not None, the revision history in the new branch will
721
be truncated to end with revision_id.
723
self._synchronize_history(destination, revision_id)
725
parent = self.get_parent()
726
except errors.InaccessibleParent, e:
727
mutter('parent was not accessible to copy: %s', e)
730
destination.set_parent(parent)
731
self.tags.merge_to(destination.tags)
735
"""Check consistency of the branch.
737
In particular this checks that revisions given in the revision-history
738
do actually match up in the revision graph, and that they're all
739
present in the repository.
741
Callers will typically also want to check the repository.
743
:return: A BranchCheckResult.
745
mainline_parent_id = None
746
for revision_id in self.revision_history():
748
revision = self.repository.get_revision(revision_id)
749
except errors.NoSuchRevision, e:
750
raise errors.BzrCheckError("mainline revision {%s} not in repository"
752
# In general the first entry on the revision history has no parents.
753
# But it's not illegal for it to have parents listed; this can happen
754
# in imports from Arch when the parents weren't reachable.
755
if mainline_parent_id is not None:
756
if mainline_parent_id not in revision.parent_ids:
757
raise errors.BzrCheckError("previous revision {%s} not listed among "
759
% (mainline_parent_id, revision_id))
760
mainline_parent_id = revision_id
761
return BranchCheckResult(self)
763
def _get_checkout_format(self):
764
"""Return the most suitable metadir for a checkout of this branch.
765
Weaves are used if this branch's repository uses weaves.
767
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
768
from bzrlib.repofmt import weaverepo
769
format = bzrdir.BzrDirMetaFormat1()
770
format.repository_format = weaverepo.RepositoryFormat7()
772
format = self.repository.bzrdir.checkout_metadir()
773
format.set_branch_format(self._format)
776
def create_checkout(self, to_location, revision_id=None,
778
"""Create a checkout of a branch.
780
:param to_location: The url to produce the checkout at
781
:param revision_id: The revision to check out
782
:param lightweight: If True, produce a lightweight checkout, otherwise,
783
produce a bound branch (heavyweight checkout)
784
:return: The tree of the created checkout
786
t = transport.get_transport(to_location)
789
format = self._get_checkout_format()
790
checkout = format.initialize_on_transport(t)
791
BranchReferenceFormat().initialize(checkout, self)
793
format = self._get_checkout_format()
794
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
795
to_location, force_new_tree=False, format=format)
796
checkout = checkout_branch.bzrdir
797
checkout_branch.bind(self)
798
# pull up to the specified revision_id to set the initial
799
# branch tip correctly, and seed it with history.
800
checkout_branch.pull(self, stop_revision=revision_id)
801
tree = checkout.create_workingtree(revision_id)
802
basis_tree = tree.basis_tree()
803
basis_tree.lock_read()
805
for path, file_id in basis_tree.iter_references():
806
reference_parent = self.reference_parent(file_id, path)
807
reference_parent.create_checkout(tree.abspath(path),
808
basis_tree.get_reference_revision(file_id, path),
814
def reference_parent(self, file_id, path):
815
"""Return the parent branch for a tree-reference file_id
816
:param file_id: The file_id of the tree reference
817
:param path: The path of the file_id in the tree
818
:return: A branch associated with the file_id
820
# FIXME should provide multiple branches, based on config
821
return Branch.open(self.bzrdir.root_transport.clone(path).base)
823
def supports_tags(self):
824
return self._format.supports_tags()
827
class BranchFormat(object):
828
"""An encapsulation of the initialization and open routines for a format.
830
Formats provide three things:
831
* An initialization routine,
835
Formats are placed in an dict by their format string for reference
836
during branch opening. Its not required that these be instances, they
837
can be classes themselves with class methods - it simply depends on
838
whether state is needed for a given format or not.
840
Once a format is deprecated, just deprecate the initialize and open
841
methods on the format class. Do not deprecate the object, as the
842
object will be created every time regardless.
845
_default_format = None
846
"""The default format used for new branches."""
849
"""The known formats."""
851
def __eq__(self, other):
852
return self.__class__ is other.__class__
854
def __ne__(self, other):
855
return not (self == other)
858
def find_format(klass, a_bzrdir):
859
"""Return the format for the branch object in a_bzrdir."""
861
transport = a_bzrdir.get_branch_transport(None)
862
format_string = transport.get("format").read()
863
return klass._formats[format_string]
865
raise NotBranchError(path=transport.base)
867
raise errors.UnknownFormatError(format=format_string)
870
def get_default_format(klass):
871
"""Return the current default format."""
872
return klass._default_format
874
def get_reference(self, a_bzrdir):
875
"""Get the target reference of the branch in a_bzrdir.
877
format probing must have been completed before calling
878
this method - it is assumed that the format of the branch
879
in a_bzrdir is correct.
881
:param a_bzrdir: The bzrdir to get the branch data from.
882
:return: None if the branch is not a reference branch.
886
def get_format_string(self):
887
"""Return the ASCII format string that identifies this format."""
888
raise NotImplementedError(self.get_format_string)
890
def get_format_description(self):
891
"""Return the short format description for this format."""
892
raise NotImplementedError(self.get_format_description)
894
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
896
"""Initialize a branch in a bzrdir, with specified files
898
:param a_bzrdir: The bzrdir to initialize the branch in
899
:param utf8_files: The files to create as a list of
900
(filename, content) tuples
901
:param set_format: If True, set the format with
902
self.get_format_string. (BzrBranch4 has its format set
904
:return: a branch in this format
906
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
907
branch_transport = a_bzrdir.get_branch_transport(self)
909
'metadir': ('lock', lockdir.LockDir),
910
'branch4': ('branch-lock', lockable_files.TransportLock),
912
lock_name, lock_class = lock_map[lock_type]
913
control_files = lockable_files.LockableFiles(branch_transport,
914
lock_name, lock_class)
915
control_files.create_lock()
916
control_files.lock_write()
918
control_files.put_utf8('format', self.get_format_string())
920
for file, content in utf8_files:
921
control_files.put_utf8(file, content)
923
control_files.unlock()
924
return self.open(a_bzrdir, _found=True)
926
def initialize(self, a_bzrdir):
927
"""Create a branch of this format in a_bzrdir."""
928
raise NotImplementedError(self.initialize)
930
def is_supported(self):
931
"""Is this format supported?
933
Supported formats can be initialized and opened.
934
Unsupported formats may not support initialization or committing or
935
some other features depending on the reason for not being supported.
939
def open(self, a_bzrdir, _found=False):
940
"""Return the branch object for a_bzrdir
942
_found is a private parameter, do not use it. It is used to indicate
943
if format probing has already be done.
945
raise NotImplementedError(self.open)
948
def register_format(klass, format):
949
klass._formats[format.get_format_string()] = format
952
def set_default_format(klass, format):
953
klass._default_format = format
956
def unregister_format(klass, format):
957
assert klass._formats[format.get_format_string()] is format
958
del klass._formats[format.get_format_string()]
961
return self.get_format_string().rstrip()
963
def supports_tags(self):
964
"""True if this format supports tags stored in the branch"""
965
return False # by default
967
# XXX: Probably doesn't really belong here -- mbp 20070212
968
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
970
branch_transport = a_bzrdir.get_branch_transport(self)
971
control_files = lockable_files.LockableFiles(branch_transport,
972
lock_filename, lock_class)
973
control_files.create_lock()
974
control_files.lock_write()
976
for filename, content in utf8_files:
977
control_files.put_utf8(filename, content)
979
control_files.unlock()
982
class BranchHooks(Hooks):
983
"""A dictionary mapping hook name to a list of callables for branch hooks.
985
e.g. ['set_rh'] Is the list of items to be called when the
986
set_revision_history function is invoked.
990
"""Create the default hooks.
992
These are all empty initially, because by default nothing should get
996
# Introduced in 0.15:
997
# invoked whenever the revision history has been set
998
# with set_revision_history. The api signature is
999
# (branch, revision_history), and the branch will
1002
# invoked after a push operation completes.
1003
# the api signature is
1005
# containing the members
1006
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1007
# where local is the local target branch or None, master is the target
1008
# master branch, and the rest should be self explanatory. The source
1009
# is read locked and the target branches write locked. Source will
1010
# be the local low-latency branch.
1011
self['post_push'] = []
1012
# invoked after a pull operation completes.
1013
# the api signature is
1015
# containing the members
1016
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1017
# where local is the local branch or None, master is the target
1018
# master branch, and the rest should be self explanatory. The source
1019
# is read locked and the target branches write locked. The local
1020
# branch is the low-latency branch.
1021
self['post_pull'] = []
1022
# invoked after a commit operation completes.
1023
# the api signature is
1024
# (local, master, old_revno, old_revid, new_revno, new_revid)
1025
# old_revid is NULL_REVISION for the first commit to a branch.
1026
self['post_commit'] = []
1027
# invoked after a uncommit operation completes.
1028
# the api signature is
1029
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1030
# local is the local branch or None, master is the target branch,
1031
# and an empty branch recieves new_revno of 0, new_revid of None.
1032
self['post_uncommit'] = []
1035
# install the default hooks into the Branch class.
1036
Branch.hooks = BranchHooks()
1039
class BzrBranchFormat4(BranchFormat):
1040
"""Bzr branch format 4.
1043
- a revision-history file.
1044
- a branch-lock lock file [ to be shared with the bzrdir ]
1047
def get_format_description(self):
1048
"""See BranchFormat.get_format_description()."""
1049
return "Branch format 4"
1051
def initialize(self, a_bzrdir):
1052
"""Create a branch of this format in a_bzrdir."""
1053
utf8_files = [('revision-history', ''),
1054
('branch-name', ''),
1056
return self._initialize_helper(a_bzrdir, utf8_files,
1057
lock_type='branch4', set_format=False)
1060
super(BzrBranchFormat4, self).__init__()
1061
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1063
def open(self, a_bzrdir, _found=False):
1064
"""Return the branch object for a_bzrdir
1066
_found is a private parameter, do not use it. It is used to indicate
1067
if format probing has already be done.
1070
# we are being called directly and must probe.
1071
raise NotImplementedError
1072
return BzrBranch(_format=self,
1073
_control_files=a_bzrdir._control_files,
1075
_repository=a_bzrdir.open_repository())
1078
return "Bazaar-NG branch format 4"
1081
class BzrBranchFormat5(BranchFormat):
1082
"""Bzr branch format 5.
1085
- a revision-history file.
1087
- a lock dir guarding the branch itself
1088
- all of this stored in a branch/ subdirectory
1089
- works with shared repositories.
1091
This format is new in bzr 0.8.
1094
def get_format_string(self):
1095
"""See BranchFormat.get_format_string()."""
1096
return "Bazaar-NG branch format 5\n"
1098
def get_format_description(self):
1099
"""See BranchFormat.get_format_description()."""
1100
return "Branch format 5"
1102
def initialize(self, a_bzrdir):
1103
"""Create a branch of this format in a_bzrdir."""
1104
utf8_files = [('revision-history', ''),
1105
('branch-name', ''),
1107
return self._initialize_helper(a_bzrdir, utf8_files)
1110
super(BzrBranchFormat5, self).__init__()
1111
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1113
def open(self, a_bzrdir, _found=False):
1114
"""Return the branch object for a_bzrdir
1116
_found is a private parameter, do not use it. It is used to indicate
1117
if format probing has already be done.
1120
format = BranchFormat.find_format(a_bzrdir)
1121
assert format.__class__ == self.__class__
1123
transport = a_bzrdir.get_branch_transport(None)
1124
control_files = lockable_files.LockableFiles(transport, 'lock',
1126
return BzrBranch5(_format=self,
1127
_control_files=control_files,
1129
_repository=a_bzrdir.find_repository())
1131
raise NotBranchError(path=transport.base)
1134
class BzrBranchFormat6(BzrBranchFormat5):
1135
"""Branch format with last-revision
1137
Unlike previous formats, this has no explicit revision history. Instead,
1138
this just stores the last-revision, and the left-hand history leading
1139
up to there is the history.
1141
This format was introduced in bzr 0.15
1144
def get_format_string(self):
1145
"""See BranchFormat.get_format_string()."""
1146
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1148
def get_format_description(self):
1149
"""See BranchFormat.get_format_description()."""
1150
return "Branch format 6"
1152
def initialize(self, a_bzrdir):
1153
"""Create a branch of this format in a_bzrdir."""
1154
utf8_files = [('last-revision', '0 null:\n'),
1155
('branch-name', ''),
1156
('branch.conf', ''),
1159
return self._initialize_helper(a_bzrdir, utf8_files)
1161
def open(self, a_bzrdir, _found=False):
1162
"""Return the branch object for a_bzrdir
1164
_found is a private parameter, do not use it. It is used to indicate
1165
if format probing has already be done.
1168
format = BranchFormat.find_format(a_bzrdir)
1169
assert format.__class__ == self.__class__
1170
transport = a_bzrdir.get_branch_transport(None)
1171
control_files = lockable_files.LockableFiles(transport, 'lock',
1173
return BzrBranch6(_format=self,
1174
_control_files=control_files,
1176
_repository=a_bzrdir.find_repository())
1178
def supports_tags(self):
1182
class BranchReferenceFormat(BranchFormat):
1183
"""Bzr branch reference format.
1185
Branch references are used in implementing checkouts, they
1186
act as an alias to the real branch which is at some other url.
1193
def get_format_string(self):
1194
"""See BranchFormat.get_format_string()."""
1195
return "Bazaar-NG Branch Reference Format 1\n"
1197
def get_format_description(self):
1198
"""See BranchFormat.get_format_description()."""
1199
return "Checkout reference format 1"
1201
def get_reference(self, a_bzrdir):
1202
"""See BranchFormat.get_reference()."""
1203
transport = a_bzrdir.get_branch_transport(None)
1204
return transport.get('location').read()
1206
def initialize(self, a_bzrdir, target_branch=None):
1207
"""Create a branch of this format in a_bzrdir."""
1208
if target_branch is None:
1209
# this format does not implement branch itself, thus the implicit
1210
# creation contract must see it as uninitializable
1211
raise errors.UninitializableFormat(self)
1212
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1213
branch_transport = a_bzrdir.get_branch_transport(self)
1214
branch_transport.put_bytes('location',
1215
target_branch.bzrdir.root_transport.base)
1216
branch_transport.put_bytes('format', self.get_format_string())
1217
return self.open(a_bzrdir, _found=True)
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
"""Return the branch that the branch reference in a_bzrdir points at.
1236
_found is a private parameter, do not use it. It is used to indicate
1237
if format probing has already be done.
1240
format = BranchFormat.find_format(a_bzrdir)
1241
assert format.__class__ == self.__class__
1242
if location is None:
1243
location = self.get_reference(a_bzrdir)
1244
real_bzrdir = bzrdir.BzrDir.open(location)
1245
result = real_bzrdir.open_branch()
1246
# this changes the behaviour of result.clone to create a new reference
1247
# rather than a copy of the content of the branch.
1248
# I did not use a proxy object because that needs much more extensive
1249
# testing, and we are only changing one behaviour at the moment.
1250
# If we decide to alter more behaviours - i.e. the implicit nickname
1251
# then this should be refactored to introduce a tested proxy branch
1252
# and a subclass of that for use in overriding clone() and ....
1254
result.clone = self._make_reference_clone_function(result)
1258
# formats which have no format string are not discoverable
1259
# and not independently creatable, so are not registered.
1260
__default_format = BzrBranchFormat5()
1261
BranchFormat.register_format(__default_format)
1262
BranchFormat.register_format(BranchReferenceFormat())
1263
BranchFormat.register_format(BzrBranchFormat6())
1264
BranchFormat.set_default_format(__default_format)
1265
_legacy_formats = [BzrBranchFormat4(),
1268
class BzrBranch(Branch):
1269
"""A branch stored in the actual filesystem.
1271
Note that it's "local" in the context of the filesystem; it doesn't
1272
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1273
it's writable, and can be accessed via the normal filesystem API.
1276
def __init__(self, _format=None,
1277
_control_files=None, a_bzrdir=None, _repository=None):
1278
"""Create new branch object at a particular location."""
1279
Branch.__init__(self)
1280
if a_bzrdir is None:
1281
raise ValueError('a_bzrdir must be supplied')
1283
self.bzrdir = a_bzrdir
1284
# self._transport used to point to the directory containing the
1285
# control directory, but was not used - now it's just the transport
1286
# for the branch control files. mbp 20070212
1287
self._base = self.bzrdir.transport.clone('..').base
1288
self._format = _format
1289
if _control_files is None:
1290
raise ValueError('BzrBranch _control_files is None')
1291
self.control_files = _control_files
1292
self._transport = _control_files._transport
1293
self.repository = _repository
1296
return '%s(%r)' % (self.__class__.__name__, self.base)
1300
def _get_base(self):
1301
"""Returns the directory containing the control directory."""
1304
base = property(_get_base, doc="The URL for the root of this branch.")
1306
def abspath(self, name):
1307
"""See Branch.abspath."""
1308
return self.control_files._transport.abspath(name)
1311
@deprecated_method(zero_sixteen)
1313
def get_root_id(self):
1314
"""See Branch.get_root_id."""
1315
tree = self.repository.revision_tree(self.last_revision())
1316
return tree.inventory.root.file_id
1318
def is_locked(self):
1319
return self.control_files.is_locked()
1321
def lock_write(self, token=None):
1322
repo_token = self.repository.lock_write()
1324
token = self.control_files.lock_write(token=token)
1326
self.repository.unlock()
1330
def lock_read(self):
1331
self.repository.lock_read()
1333
self.control_files.lock_read()
1335
self.repository.unlock()
1339
# TODO: test for failed two phase locks. This is known broken.
1341
self.control_files.unlock()
1343
self.repository.unlock()
1344
if not self.control_files.is_locked():
1345
# we just released the lock
1346
self._clear_cached_state()
1348
def peek_lock_mode(self):
1349
if self.control_files._lock_count == 0:
1352
return self.control_files._lock_mode
1354
def get_physical_lock_status(self):
1355
return self.control_files.get_physical_lock_status()
1358
def print_file(self, file, revision_id):
1359
"""See Branch.print_file."""
1360
return self.repository.print_file(file, revision_id)
1363
def append_revision(self, *revision_ids):
1364
"""See Branch.append_revision."""
1365
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1366
for revision_id in revision_ids:
1367
_mod_revision.check_not_reserved_id(revision_id)
1368
mutter("add {%s} to revision-history" % revision_id)
1369
rev_history = self.revision_history()
1370
rev_history.extend(revision_ids)
1371
self.set_revision_history(rev_history)
1373
def _write_revision_history(self, history):
1374
"""Factored out of set_revision_history.
1376
This performs the actual writing to disk.
1377
It is intended to be called by BzrBranch5.set_revision_history."""
1378
self.control_files.put_bytes(
1379
'revision-history', '\n'.join(history))
1382
def set_revision_history(self, rev_history):
1383
"""See Branch.set_revision_history."""
1384
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1385
self._clear_cached_state()
1386
self._write_revision_history(rev_history)
1387
self._cache_revision_history(rev_history)
1388
for hook in Branch.hooks['set_rh']:
1389
hook(self, rev_history)
1392
def set_last_revision_info(self, revno, revision_id):
1393
revision_id = osutils.safe_revision_id(revision_id)
1394
history = self._lefthand_history(revision_id)
1395
assert len(history) == revno, '%d != %d' % (len(history), revno)
1396
self.set_revision_history(history)
1398
def _gen_revision_history(self):
1399
history = self.control_files.get('revision-history').read().split('\n')
1400
if history[-1:] == ['']:
1401
# There shouldn't be a trailing newline, but just in case.
1405
def _lefthand_history(self, revision_id, last_rev=None,
1407
# stop_revision must be a descendant of last_revision
1408
stop_graph = self.repository.get_revision_graph(revision_id)
1409
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1410
and last_rev not in stop_graph):
1411
# our previous tip is not merged into stop_revision
1412
raise errors.DivergedBranches(self, other_branch)
1413
# make a new revision history from the graph
1414
current_rev_id = revision_id
1416
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1417
new_history.append(current_rev_id)
1418
current_rev_id_parents = stop_graph[current_rev_id]
1420
current_rev_id = current_rev_id_parents[0]
1422
current_rev_id = None
1423
new_history.reverse()
1427
def generate_revision_history(self, revision_id, last_rev=None,
1429
"""Create a new revision history that will finish with revision_id.
1431
:param revision_id: the new tip to use.
1432
:param last_rev: The previous last_revision. If not None, then this
1433
must be a ancestory of revision_id, or DivergedBranches is raised.
1434
:param other_branch: The other branch that DivergedBranches should
1435
raise with respect to.
1437
revision_id = osutils.safe_revision_id(revision_id)
1438
self.set_revision_history(self._lefthand_history(revision_id,
1439
last_rev, other_branch))
1442
def update_revisions(self, other, stop_revision=None):
1443
"""See Branch.update_revisions."""
1446
if stop_revision is None:
1447
stop_revision = other.last_revision()
1448
if stop_revision is None:
1449
# if there are no commits, we're done.
1452
stop_revision = osutils.safe_revision_id(stop_revision)
1453
# whats the current last revision, before we fetch [and change it
1455
last_rev = _mod_revision.ensure_null(self.last_revision())
1456
# we fetch here regardless of whether we need to so that we pickup
1458
self.fetch(other, stop_revision)
1459
my_ancestry = self.repository.get_ancestry(last_rev,
1461
if stop_revision in my_ancestry:
1462
# last_revision is a descendant of stop_revision
1464
self.generate_revision_history(stop_revision, last_rev=last_rev,
1469
def basis_tree(self):
1470
"""See Branch.basis_tree."""
1471
return self.repository.revision_tree(self.last_revision())
1473
@deprecated_method(zero_eight)
1474
def working_tree(self):
1475
"""Create a Working tree object for this branch."""
1477
from bzrlib.transport.local import LocalTransport
1478
if (self.base.find('://') != -1 or
1479
not isinstance(self._transport, LocalTransport)):
1480
raise NoWorkingTree(self.base)
1481
return self.bzrdir.open_workingtree()
1484
def pull(self, source, overwrite=False, stop_revision=None,
1485
_hook_master=None, run_hooks=True):
1488
:param _hook_master: Private parameter - set the branch to
1489
be supplied as the master to push hooks.
1490
:param run_hooks: Private parameter - if false, this branch
1491
is being called because it's the master of the primary branch,
1492
so it should not run its hooks.
1494
result = PullResult()
1495
result.source_branch = source
1496
result.target_branch = self
1499
result.old_revno, result.old_revid = self.last_revision_info()
1501
self.update_revisions(source, stop_revision)
1502
except DivergedBranches:
1506
if stop_revision is None:
1507
stop_revision = source.last_revision()
1508
self.generate_revision_history(stop_revision)
1509
result.tag_conflicts = source.tags.merge_to(self.tags)
1510
result.new_revno, result.new_revid = self.last_revision_info()
1512
result.master_branch = _hook_master
1513
result.local_branch = self
1515
result.master_branch = self
1516
result.local_branch = None
1518
for hook in Branch.hooks['post_pull']:
1524
def _get_parent_location(self):
1525
_locs = ['parent', 'pull', 'x-pull']
1528
return self.control_files.get(l).read().strip('\n')
1534
def push(self, target, overwrite=False, stop_revision=None,
1535
_override_hook_source_branch=None):
1538
This is the basic concrete implementation of push()
1540
:param _override_hook_source_branch: If specified, run
1541
the hooks passing this Branch as the source, rather than self.
1542
This is for use of RemoteBranch, where push is delegated to the
1543
underlying vfs-based Branch.
1545
# TODO: Public option to disable running hooks - should be trivial but
1549
result = self._push_with_bound_branches(target, overwrite,
1551
_override_hook_source_branch=_override_hook_source_branch)
1556
def _push_with_bound_branches(self, target, overwrite,
1558
_override_hook_source_branch=None):
1559
"""Push from self into target, and into target's master if any.
1561
This is on the base BzrBranch class even though it doesn't support
1562
bound branches because the *target* might be bound.
1565
if _override_hook_source_branch:
1566
result.source_branch = _override_hook_source_branch
1567
for hook in Branch.hooks['post_push']:
1570
bound_location = target.get_bound_location()
1571
if bound_location and target.base != bound_location:
1572
# there is a master branch.
1574
# XXX: Why the second check? Is it even supported for a branch to
1575
# be bound to itself? -- mbp 20070507
1576
master_branch = target.get_master_branch()
1577
master_branch.lock_write()
1579
# push into the master from this branch.
1580
self._basic_push(master_branch, overwrite, stop_revision)
1581
# and push into the target branch from this. Note that we push from
1582
# this branch again, because its considered the highest bandwidth
1584
result = self._basic_push(target, overwrite, stop_revision)
1585
result.master_branch = master_branch
1586
result.local_branch = target
1590
master_branch.unlock()
1593
result = self._basic_push(target, overwrite, stop_revision)
1594
# TODO: Why set master_branch and local_branch if there's no
1595
# binding? Maybe cleaner to just leave them unset? -- mbp
1597
result.master_branch = target
1598
result.local_branch = None
1602
def _basic_push(self, target, overwrite, stop_revision):
1603
"""Basic implementation of push without bound branches or hooks.
1605
Must be called with self read locked and target write locked.
1607
result = PushResult()
1608
result.source_branch = self
1609
result.target_branch = target
1610
result.old_revno, result.old_revid = target.last_revision_info()
1612
target.update_revisions(self, stop_revision)
1613
except DivergedBranches:
1617
target.set_revision_history(self.revision_history())
1618
result.tag_conflicts = self.tags.merge_to(target.tags)
1619
result.new_revno, result.new_revid = target.last_revision_info()
1622
def get_parent(self):
1623
"""See Branch.get_parent."""
1625
assert self.base[-1] == '/'
1626
parent = self._get_parent_location()
1629
# This is an old-format absolute path to a local branch
1630
# turn it into a url
1631
if parent.startswith('/'):
1632
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1634
return urlutils.join(self.base[:-1], parent)
1635
except errors.InvalidURLJoin, e:
1636
raise errors.InaccessibleParent(parent, self.base)
1638
def set_push_location(self, location):
1639
"""See Branch.set_push_location."""
1640
self.get_config().set_user_option(
1641
'push_location', location,
1642
store=_mod_config.STORE_LOCATION_NORECURSE)
1645
def set_parent(self, url):
1646
"""See Branch.set_parent."""
1647
# TODO: Maybe delete old location files?
1648
# URLs should never be unicode, even on the local fs,
1649
# FIXUP this and get_parent in a future branch format bump:
1650
# read and rewrite the file, and have the new format code read
1651
# using .get not .get_utf8. RBC 20060125
1653
if isinstance(url, unicode):
1655
url = url.encode('ascii')
1656
except UnicodeEncodeError:
1657
raise errors.InvalidURL(url,
1658
"Urls must be 7-bit ascii, "
1659
"use bzrlib.urlutils.escape")
1660
url = urlutils.relative_url(self.base, url)
1661
self._set_parent_location(url)
1663
def _set_parent_location(self, url):
1665
self.control_files._transport.delete('parent')
1667
assert isinstance(url, str)
1668
self.control_files.put_bytes('parent', url + '\n')
1670
@deprecated_function(zero_nine)
1671
def tree_config(self):
1672
"""DEPRECATED; call get_config instead.
1673
TreeConfig has become part of BranchConfig."""
1674
return TreeConfig(self)
1677
class BzrBranch5(BzrBranch):
1678
"""A format 5 branch. This supports new features over plan branches.
1680
It has support for a master_branch which is the data for bound branches.
1688
super(BzrBranch5, self).__init__(_format=_format,
1689
_control_files=_control_files,
1691
_repository=_repository)
1694
def pull(self, source, overwrite=False, stop_revision=None,
1696
"""Pull from source into self, updating my master if any.
1698
:param run_hooks: Private parameter - if false, this branch
1699
is being called because it's the master of the primary branch,
1700
so it should not run its hooks.
1702
bound_location = self.get_bound_location()
1703
master_branch = None
1704
if bound_location and source.base != bound_location:
1705
# not pulling from master, so we need to update master.
1706
master_branch = self.get_master_branch()
1707
master_branch.lock_write()
1710
# pull from source into master.
1711
master_branch.pull(source, overwrite, stop_revision,
1713
return super(BzrBranch5, self).pull(source, overwrite,
1714
stop_revision, _hook_master=master_branch,
1715
run_hooks=run_hooks)
1718
master_branch.unlock()
1720
def get_bound_location(self):
1722
return self.control_files.get_utf8('bound').read()[:-1]
1723
except errors.NoSuchFile:
1727
def get_master_branch(self):
1728
"""Return the branch we are bound to.
1730
:return: Either a Branch, or None
1732
This could memoise the branch, but if thats done
1733
it must be revalidated on each new lock.
1734
So for now we just don't memoise it.
1735
# RBC 20060304 review this decision.
1737
bound_loc = self.get_bound_location()
1741
return Branch.open(bound_loc)
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')
1334
if filename == head:
1341
def gen_file_id(name):
1342
"""Return new file id.
1344
This should probably generate proper UUIDs, but for the moment we
1345
cope with just randomness because running uuidgen every time is
1348
from binascii import hexlify
1349
from time import time
1351
# get last component
1352
idx = name.rfind('/')
1354
name = name[idx+1 : ]
1355
idx = name.rfind('\\')
1357
name = name[idx+1 : ]
1359
# make it not a hidden file
1360
name = name.lstrip('.')
1362
# remove any wierd characters; we don't escape them but rather
1363
# just pull them out
1364
name = re.sub(r'[^\w.]', '', name)
1366
s = hexlify(rand_bytes(8))
1367
return '-'.join((name, compact_date(time()), s))
1371
"""Return a new tree-root file id."""
1372
return gen_file_id('TREE_ROOT')
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
last_rev = _mod_revision.ensure_null(self.last_revision())
1786
if last_rev != _mod_revision.NULL_REVISION:
1789
other_last_rev = other.last_revision()
1790
if not _mod_revision.is_null(other_last_rev):
1791
# neither branch is new, we have to do some work to
1792
# ascertain diversion.
1793
remote_graph = other.repository.get_revision_graph(
1795
local_graph = self.repository.get_revision_graph(last_rev)
1796
if (last_rev not in remote_graph and
1797
other_last_rev not in local_graph):
1798
raise errors.DivergedBranches(self, other)
1801
self.set_bound_location(other.base)
1805
"""If bound, unbind"""
1806
return self.set_bound_location(None)
1810
"""Synchronise this branch with the master branch if any.
1812
:return: None or the last_revision that was pivoted out during the
1815
master = self.get_master_branch()
1816
if master is not None:
1817
old_tip = self.last_revision()
1818
self.pull(master, overwrite=True)
1819
if old_tip in self.repository.get_ancestry(
1820
_mod_revision.ensure_null(self.last_revision()),
1827
class BzrBranchExperimental(BzrBranch5):
1828
"""Bzr experimental branch format
1831
- a revision-history file.
1833
- a lock dir guarding the branch itself
1834
- all of this stored in a branch/ subdirectory
1835
- works with shared repositories.
1836
- a tag dictionary in the branch
1838
This format is new in bzr 0.15, but shouldn't be used for real data,
1841
This class acts as it's own BranchFormat.
1844
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1847
def get_format_string(cls):
1848
"""See BranchFormat.get_format_string()."""
1849
return "Bazaar-NG branch format experimental\n"
1852
def get_format_description(cls):
1853
"""See BranchFormat.get_format_description()."""
1854
return "Experimental branch format"
1857
def get_reference(cls, a_bzrdir):
1858
"""Get the target reference of the branch in a_bzrdir.
1860
format probing must have been completed before calling
1861
this method - it is assumed that the format of the branch
1862
in a_bzrdir is correct.
1864
:param a_bzrdir: The bzrdir to get the branch data from.
1865
:return: None if the branch is not a reference branch.
1870
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1872
branch_transport = a_bzrdir.get_branch_transport(cls)
1873
control_files = lockable_files.LockableFiles(branch_transport,
1874
lock_filename, lock_class)
1875
control_files.create_lock()
1876
control_files.lock_write()
1878
for filename, content in utf8_files:
1879
control_files.put_utf8(filename, content)
1881
control_files.unlock()
1884
def initialize(cls, a_bzrdir):
1885
"""Create a branch of this format in a_bzrdir."""
1886
utf8_files = [('format', cls.get_format_string()),
1887
('revision-history', ''),
1888
('branch-name', ''),
1891
cls._initialize_control_files(a_bzrdir, utf8_files,
1892
'lock', lockdir.LockDir)
1893
return cls.open(a_bzrdir, _found=True)
1896
def open(cls, a_bzrdir, _found=False):
1897
"""Return the branch object for a_bzrdir
1899
_found is a private parameter, do not use it. It is used to indicate
1900
if format probing has already be done.
1903
format = BranchFormat.find_format(a_bzrdir)
1904
assert format.__class__ == cls
1905
transport = a_bzrdir.get_branch_transport(None)
1906
control_files = lockable_files.LockableFiles(transport, 'lock',
1908
return cls(_format=cls,
1909
_control_files=control_files,
1911
_repository=a_bzrdir.find_repository())
1914
def is_supported(cls):
1917
def _make_tags(self):
1918
return BasicTags(self)
1921
def supports_tags(cls):
1925
BranchFormat.register_format(BzrBranchExperimental)
1928
class BzrBranch6(BzrBranch5):
1931
def last_revision_info(self):
1932
revision_string = self.control_files.get('last-revision').read()
1933
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1934
revision_id = cache_utf8.get_cached_utf8(revision_id)
1936
return revno, revision_id
1938
def last_revision(self):
1939
"""Return last revision id, or None"""
1940
revision_id = self.last_revision_info()[1]
1941
if revision_id == _mod_revision.NULL_REVISION:
1945
def _write_last_revision_info(self, revno, revision_id):
1946
"""Simply write out the revision id, with no checks.
1948
Use set_last_revision_info to perform this safely.
1950
Does not update the revision_history cache.
1951
Intended to be called by set_last_revision_info and
1952
_write_revision_history.
1954
if revision_id is None:
1955
revision_id = 'null:'
1956
out_string = '%d %s\n' % (revno, revision_id)
1957
self.control_files.put_bytes('last-revision', out_string)
1960
def set_last_revision_info(self, revno, revision_id):
1961
revision_id = osutils.safe_revision_id(revision_id)
1962
if self._get_append_revisions_only():
1963
self._check_history_violation(revision_id)
1964
self._write_last_revision_info(revno, revision_id)
1965
self._clear_cached_state()
1967
def _check_history_violation(self, revision_id):
1968
last_revision = _mod_revision.ensure_null(self.last_revision())
1969
if _mod_revision.is_null(last_revision):
1971
if last_revision not in self._lefthand_history(revision_id):
1972
raise errors.AppendRevisionsOnlyViolation(self.base)
1974
def _gen_revision_history(self):
1975
"""Generate the revision history from last revision
1977
history = list(self.repository.iter_reverse_revision_history(
1978
self.last_revision()))
1982
def _write_revision_history(self, history):
1983
"""Factored out of set_revision_history.
1985
This performs the actual writing to disk, with format-specific checks.
1986
It is intended to be called by BzrBranch5.set_revision_history.
1988
if len(history) == 0:
1989
last_revision = 'null:'
1991
if history != self._lefthand_history(history[-1]):
1992
raise errors.NotLefthandHistory(history)
1993
last_revision = history[-1]
1994
if self._get_append_revisions_only():
1995
self._check_history_violation(last_revision)
1996
self._write_last_revision_info(len(history), last_revision)
1999
def append_revision(self, *revision_ids):
2000
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
2001
if len(revision_ids) == 0:
2003
prev_revno, prev_revision = self.last_revision_info()
2004
for revision in self.repository.get_revisions(revision_ids):
2005
if prev_revision == _mod_revision.NULL_REVISION:
2006
if revision.parent_ids != []:
2007
raise errors.NotLeftParentDescendant(self, prev_revision,
2008
revision.revision_id)
2010
if revision.parent_ids[0] != prev_revision:
2011
raise errors.NotLeftParentDescendant(self, prev_revision,
2012
revision.revision_id)
2013
prev_revision = revision.revision_id
2014
self.set_last_revision_info(prev_revno + len(revision_ids),
2018
def _set_parent_location(self, url):
2019
"""Set the parent branch"""
2020
self._set_config_location('parent_location', url, make_relative=True)
2023
def _get_parent_location(self):
2024
"""Set the parent branch"""
2025
return self._get_config_location('parent_location')
2027
def set_push_location(self, location):
2028
"""See Branch.set_push_location."""
2029
self._set_config_location('push_location', location)
2031
def set_bound_location(self, location):
2032
"""See Branch.set_push_location."""
2034
config = self.get_config()
2035
if location is None:
2036
if config.get_user_option('bound') != 'True':
2039
config.set_user_option('bound', 'False', warn_masked=True)
2042
self._set_config_location('bound_location', location,
2044
config.set_user_option('bound', 'True', warn_masked=True)
2047
def _get_bound_location(self, bound):
2048
"""Return the bound location in the config file.
2050
Return None if the bound parameter does not match"""
2051
config = self.get_config()
2052
config_bound = (config.get_user_option('bound') == 'True')
2053
if config_bound != bound:
2055
return self._get_config_location('bound_location', config=config)
2057
def get_bound_location(self):
2058
"""See Branch.set_push_location."""
2059
return self._get_bound_location(True)
2061
def get_old_bound_location(self):
2062
"""See Branch.get_old_bound_location"""
2063
return self._get_bound_location(False)
2065
def set_append_revisions_only(self, enabled):
2070
self.get_config().set_user_option('append_revisions_only', value,
2073
def _get_append_revisions_only(self):
2074
value = self.get_config().get_user_option('append_revisions_only')
2075
return value == 'True'
2077
def _synchronize_history(self, destination, revision_id):
2078
"""Synchronize last revision and revision history between branches.
2080
This version is most efficient when the destination is also a
2081
BzrBranch6, but works for BzrBranch5, as long as the destination's
2082
repository contains all the lefthand ancestors of the intended
2083
last_revision. If not, set_last_revision_info will fail.
2085
:param destination: The branch to copy the history into
2086
:param revision_id: The revision-id to truncate history at. May
2087
be None to copy complete history.
2089
if revision_id is None:
2090
revno, revision_id = self.last_revision_info()
2092
# To figure out the revno for a random revision, we need to build
2093
# the revision history, and count its length.
2094
# We don't care about the order, just how long it is.
2095
# Alternatively, we could start at the current location, and count
2096
# backwards. But there is no guarantee that we will find it since
2097
# it may be a merged revision.
2098
revno = len(list(self.repository.iter_reverse_revision_history(
2100
destination.set_last_revision_info(revno, revision_id)
2102
def _make_tags(self):
2103
return BasicTags(self)
2106
######################################################################
2107
# results of operations
2110
class _Result(object):
2112
def _show_tag_conficts(self, to_file):
2113
if not getattr(self, 'tag_conflicts', None):
2115
to_file.write('Conflicting tags:\n')
2116
for name, value1, value2 in self.tag_conflicts:
2117
to_file.write(' %s\n' % (name, ))
2120
class PullResult(_Result):
2121
"""Result of a Branch.pull operation.
2123
:ivar old_revno: Revision number before pull.
2124
:ivar new_revno: Revision number after pull.
2125
:ivar old_revid: Tip revision id before pull.
2126
:ivar new_revid: Tip revision id after pull.
2127
:ivar source_branch: Source (local) branch object.
2128
:ivar master_branch: Master branch of the target, or None.
2129
:ivar target_branch: Target/destination branch object.
2133
# DEPRECATED: pull used to return the change in revno
2134
return self.new_revno - self.old_revno
2136
def report(self, to_file):
2137
if self.old_revid == self.new_revid:
2138
to_file.write('No revisions to pull.\n')
2140
to_file.write('Now on revision %d.\n' % self.new_revno)
2141
self._show_tag_conficts(to_file)
2144
class PushResult(_Result):
2145
"""Result of a Branch.push operation.
2147
:ivar old_revno: Revision number before push.
2148
:ivar new_revno: Revision number after push.
2149
:ivar old_revid: Tip revision id before push.
2150
:ivar new_revid: Tip revision id after push.
2151
:ivar source_branch: Source branch object.
2152
:ivar master_branch: Master branch of the target, or None.
2153
:ivar target_branch: Target/destination branch object.
2157
# DEPRECATED: push used to return the change in revno
2158
return self.new_revno - self.old_revno
2160
def report(self, to_file):
2161
"""Write a human-readable description of the result."""
2162
if self.old_revid == self.new_revid:
2163
to_file.write('No new revisions to push.\n')
2165
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2166
self._show_tag_conficts(to_file)
2169
class BranchCheckResult(object):
2170
"""Results of checking branch consistency.
2175
def __init__(self, branch):
2176
self.branch = branch
2178
def report_results(self, verbose):
2179
"""Report the check results via trace.note.
2181
:param verbose: Requests more detailed display of what was checked,
2184
note('checked branch %s format %s',
2186
self.branch._format)
2189
class Converter5to6(object):
2190
"""Perform an in-place upgrade of format 5 to format 6"""
2192
def convert(self, branch):
2193
# Data for 5 and 6 can peacefully coexist.
2194
format = BzrBranchFormat6()
2195
new_branch = format.open(branch.bzrdir, _found=True)
2197
# Copy source data into target
2198
new_branch.set_last_revision_info(*branch.last_revision_info())
2199
new_branch.set_parent(branch.get_parent())
2200
new_branch.set_bound_location(branch.get_bound_location())
2201
new_branch.set_push_location(branch.get_push_location())
2203
# New branch has no tags by default
2204
new_branch.tags._set_tag_dict({})
2206
# Copying done; now update target format
2207
new_branch.control_files.put_utf8('format',
2208
format.get_format_string())
2210
# Clean up old files
2211
new_branch.control_files._transport.delete('revision-history')
2213
branch.set_parent(None)
2216
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
