137
85
"""Branch holding a history of revisions.
140
Base directory of the branch.
146
If _lock_mode is true, a positive count of the number of times the
150
Lock object from bzrlib.lock.
88
Base directory/url of the branch.
90
hooks: An instance of BranchHooks.
92
# this is really an instance variable - FIXME move it there
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
162
def __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
165
base -- Base directory for the branch.
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
177
from bzrlib.store import ImmutableStore
179
self.base = os.path.realpath(base)
182
self.base = find_branch_root(base)
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
198
return '%s(%r)' % (self.__class__.__name__, self.base)
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
warn("branch %r was not explicitly unlocked" % self)
96
# override this to set the strategy for storing tags
98
return DisabledTags(self)
100
def __init__(self, *ignored, **ignored_too):
101
self.tags = self._make_tags()
102
self._revision_history_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)
177
nick = property(_get_nick, _set_nick)
180
raise NotImplementedError(self.is_locked)
212
182
def lock_write(self):
214
if self._lock_mode != 'w':
215
from errors import LockError
216
raise LockError("can't upgrade to a write lock from %r" %
218
self._lock_count += 1
220
from bzrlib.lock import WriteLock
222
self._lock = WriteLock(self.controlfilename('branch-lock'))
223
self._lock_mode = 'w'
183
raise NotImplementedError(self.lock_write)
228
185
def lock_read(self):
230
assert self._lock_mode in ('r', 'w'), \
231
"invalid lock mode %r" % self._lock_mode
232
self._lock_count += 1
234
from bzrlib.lock import ReadLock
236
self._lock = ReadLock(self.controlfilename('branch-lock'))
237
self._lock_mode = 'r'
186
raise NotImplementedError(self.lock_read)
242
188
def unlock(self):
243
if not self._lock_mode:
244
from errors import LockError
245
raise LockError('branch %r is not locked' % (self))
247
if self._lock_count > 1:
248
self._lock_count -= 1
252
self._lock_mode = self._lock_count = None
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)
198
def leave_lock_in_place(self):
199
"""Tell this branch object not to release the physical lock when this
202
If lock_write doesn't return a token, then this method is not supported.
204
self.control_files.leave_in_place()
206
def dont_leave_lock_in_place(self):
207
"""Tell this branch object to release the physical lock when this
208
object is unlocked, even if it didn't originally acquire it.
210
If lock_write doesn't return a token, then this method is not supported.
212
self.control_files.dont_leave_in_place()
255
214
def abspath(self, name):
256
"""Return absolute filename for something in the branch"""
257
return os.path.join(self.base, name)
260
def relpath(self, path):
261
"""Return path relative to this branch of something inside it.
263
Raises an error if path is not in this branch."""
264
return _relpath(self.base, path)
267
def controlfilename(self, file_or_path):
268
"""Return location relative to branch."""
269
if isinstance(file_or_path, basestring):
270
file_or_path = [file_or_path]
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
274
def controlfile(self, file_or_path, mode='r'):
275
"""Open a control file for this branch.
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
286
fn = self.controlfilename(file_or_path)
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
294
return codecs.open(fn, mode + 'b', 'utf-8',
297
raise BzrError("invalid controlfile mode %r" % mode)
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
305
os.mkdir(self.controlfilename([]))
306
self.controlfile('README', 'w').write(
307
"This is a Bazaar-NG control directory.\n"
308
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
311
os.mkdir(self.controlfilename(d))
312
for f in ('revision-history', 'merged-patches',
313
'pending-merged-patches', 'branch-name',
316
self.controlfile(f, 'w').write('')
317
mutter('created control directory in ' + self.base)
319
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
322
def _check_format(self):
323
"""Check this branch format is supported.
325
The current tool only supports the current unstable format.
327
In the future, we might need different in-memory Branch
328
classes to support downlevel branches. But not yet.
330
# This ignores newlines so that we can open branches created
331
# on Windows from Linux and so on. I think it might be better
332
# to always make all internal files in unix format.
333
fmt = self.controlfile('branch-format', 'r').read()
334
fmt.replace('\r\n', '')
335
if fmt != BZR_BRANCH_FORMAT:
336
raise BzrError('sorry, branch format %r not supported' % fmt,
337
['use a different bzr version',
338
'or remove the .bzr directory and "bzr init" again'])
340
def get_root_id(self):
341
"""Return the id of this branches root"""
342
inv = self.read_working_inventory()
343
return inv.root.file_id
345
def set_root_id(self, file_id):
346
inv = self.read_working_inventory()
347
orig_root_id = inv.root.file_id
348
del inv._byid[inv.root.file_id]
349
inv.root.file_id = file_id
350
inv._byid[inv.root.file_id] = inv.root
353
if entry.parent_id in (None, orig_root_id):
354
entry.parent_id = inv.root.file_id
355
self._write_inventory(inv)
357
def read_working_inventory(self):
358
"""Read the working inventory."""
359
from bzrlib.inventory import Inventory
360
from bzrlib.xml import unpack_xml
361
from time import time
365
# ElementTree does its own conversion from UTF-8, so open in
367
inv = unpack_xml(Inventory,
368
self.controlfile('inventory', 'rb'))
369
mutter("loaded inventory of %d items in %f"
370
% (len(inv), time() - before))
376
def _write_inventory(self, inv):
377
"""Update the working inventory.
379
That is to say, the inventory describing changes underway, that
380
will be committed to the next revision.
382
from bzrlib.atomicfile import AtomicFile
383
from bzrlib.xml import pack_xml
387
f = AtomicFile(self.controlfilename('inventory'), 'wb')
396
mutter('wrote working inventory')
399
inventory = property(read_working_inventory, _write_inventory, None,
400
"""Inventory for the working copy.""")
403
def add(self, files, verbose=False, ids=None):
404
"""Make files versioned.
406
Note that the command line normally calls smart_add instead.
408
This puts the files in the Added state, so that they will be
409
recorded by the next commit.
412
List of paths to add, relative to the base of the tree.
415
If set, use these instead of automatically generated ids.
416
Must be the same length as the list of files, but may
417
contain None for ids that are to be autogenerated.
419
TODO: Perhaps have an option to add the ids even if the files do
422
TODO: Perhaps return the ids of the files? But then again it
423
is easy to retrieve them if they're needed.
425
TODO: Adding a directory should optionally recurse down and
426
add all non-ignored children. Perhaps do that in a
429
# TODO: Re-adding a file that is removed in the working copy
430
# should probably put it back with the previous ID.
431
if isinstance(files, basestring):
432
assert(ids is None or isinstance(ids, basestring))
438
ids = [None] * len(files)
440
assert(len(ids) == len(files))
444
inv = self.read_working_inventory()
445
for f,file_id in zip(files, ids):
446
if is_control_file(f):
447
raise BzrError("cannot add control file %s" % quotefn(f))
452
raise BzrError("cannot add top-level %r" % f)
454
fullpath = os.path.normpath(self.abspath(f))
457
kind = file_kind(fullpath)
459
# maybe something better?
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
462
if kind != 'file' and kind != 'directory':
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
466
file_id = gen_file_id(f)
467
inv.add_path(f, kind=kind, file_id=file_id)
470
print 'added', quotefn(f)
472
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
474
self._write_inventory(inv)
479
def print_file(self, file, revno):
480
"""Print `file` to stdout."""
483
tree = self.revision_tree(self.lookup_revision(revno))
484
# use inventory as it was in that revision
485
file_id = tree.inventory.path2id(file)
487
raise BzrError("%r is not present in revision %s" % (file, revno))
488
tree.print_file(file_id)
493
def remove(self, files, verbose=False):
494
"""Mark nominated files for removal from the inventory.
496
This does not remove their text. This does not run on
498
TODO: Refuse to remove modified files unless --force is given?
500
TODO: Do something useful with directories.
502
TODO: Should this remove the text or not? Tough call; not
503
removing may be useful and the user can just use use rm, and
504
is the opposite of add. Removing it is consistent with most
505
other tools. Maybe an option.
507
## TODO: Normalize names
508
## TODO: Remove nested loops; better scalability
509
if isinstance(files, basestring):
515
tree = self.working_tree()
518
# do this before any modifications
522
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
523
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
525
# having remove it, it must be either ignored or unknown
526
if tree.is_ignored(f):
530
show_status(new_status, inv[fid].kind, quotefn(f))
533
self._write_inventory(inv)
538
# FIXME: this doesn't need to be a branch method
539
def set_inventory(self, new_inventory_list):
540
from bzrlib.inventory import Inventory, InventoryEntry
541
inv = Inventory(self.get_root_id())
542
for path, file_id, parent, kind in new_inventory_list:
543
name = os.path.basename(path)
546
inv.add(InventoryEntry(file_id, name, kind, parent))
547
self._write_inventory(inv)
551
"""Return all unknown files.
553
These are files in the working directory that are not versioned or
554
control files or ignored.
556
>>> b = ScratchBranch(files=['foo', 'foo~'])
557
>>> list(b.unknowns())
560
>>> list(b.unknowns())
563
>>> list(b.unknowns())
566
return self.working_tree().unknowns()
569
def append_revision(self, *revision_ids):
570
from bzrlib.atomicfile import AtomicFile
572
for revision_id in revision_ids:
573
mutter("add {%s} to revision-history" % revision_id)
575
rev_history = self.revision_history()
576
rev_history.extend(revision_ids)
578
f = AtomicFile(self.controlfilename('revision-history'))
580
for rev_id in rev_history:
587
def get_revision_xml(self, revision_id):
588
"""Return XML file object for revision object."""
589
if not revision_id or not isinstance(revision_id, basestring):
590
raise InvalidRevisionId(revision_id)
595
return self.revision_store[revision_id]
597
raise bzrlib.errors.NoSuchRevision(revision_id)
602
def get_revision(self, revision_id):
603
"""Return the Revision object for a named revision"""
604
xml_file = self.get_revision_xml(revision_id)
607
r = unpack_xml(Revision, xml_file)
608
except SyntaxError, e:
609
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
assert r.revision_id == revision_id
215
"""Return absolute filename for something in the branch
217
XXX: Robert Collins 20051017 what is this used for? why is it a branch
218
method and not a tree method.
220
raise NotImplementedError(self.abspath)
222
def bind(self, other):
223
"""Bind the local branch the other branch.
225
:param other: The branch to bind to
228
raise errors.UpgradeRequired(self.base)
231
def fetch(self, from_branch, last_revision=None, pb=None):
232
"""Copy revisions from from_branch into this branch.
234
:param from_branch: Where to copy from.
235
:param last_revision: What revision to stop at (None for at the end
237
:param pb: An optional progress bar to use.
239
Returns the copied revision count and the failed revisions in a tuple:
242
if self.base == from_branch.base:
245
nested_pb = ui.ui_factory.nested_progress_bar()
250
from_branch.lock_read()
252
if last_revision is None:
253
pb.update('get source history')
254
last_revision = from_branch.last_revision()
255
if last_revision is None:
256
last_revision = _mod_revision.NULL_REVISION
257
return self.repository.fetch(from_branch.repository,
258
revision_id=last_revision,
261
if nested_pb is not None:
265
def get_bound_location(self):
266
"""Return the URL of the branch we are bound to.
268
Older format branches cannot bind, please be sure to use a metadir
273
def get_old_bound_location(self):
274
"""Return the URL of the branch we used to be bound to
276
raise errors.UpgradeRequired(self.base)
278
def get_commit_builder(self, parents, config=None, timestamp=None,
279
timezone=None, committer=None, revprops=None,
281
"""Obtain a CommitBuilder for this branch.
283
:param parents: Revision ids of the parents of the new revision.
284
:param config: Optional configuration to use.
285
:param timestamp: Optional timestamp recorded for commit.
286
:param timezone: Optional timezone for timestamp.
287
:param committer: Optional committer to set for commit.
288
:param revprops: Optional dictionary of revision properties.
289
:param revision_id: Optional revision id.
293
config = self.get_config()
295
return self.repository.get_commit_builder(self, parents, config,
296
timestamp, timezone, committer, revprops, revision_id)
298
def get_master_branch(self):
299
"""Return the branch we are bound to.
301
:return: Either a Branch, or None
617
305
def get_revision_delta(self, revno):
618
306
"""Return the delta for one revision.
794
438
if stop_revision is None:
795
439
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
441
assert isinstance(stop_revision, int)
442
if stop_revision > other_len:
443
raise errors.NoSuchRevision(self, stop_revision)
799
444
return other_history[self_len:stop_revision]
802
446
def update_revisions(self, other, stop_revision=None):
803
"""Pull in all new revisions from other branch.
805
>>> from bzrlib.commit import commit
806
>>> bzrlib.trace.silent = True
807
>>> br1 = ScratchBranch(files=['foo', 'bar'])
810
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
811
>>> br2 = ScratchBranch()
812
>>> br2.update_revisions(br1)
816
>>> br2.revision_history()
818
>>> br2.update_revisions(br1)
822
>>> br1.text_store.total_size() == br2.text_store.total_size()
825
from bzrlib.progress import ProgressBar
829
pb.update('comparing histories')
830
revision_ids = self.missing_revisions(other, stop_revision)
832
if hasattr(other.revision_store, "prefetch"):
833
other.revision_store.prefetch(revision_ids)
834
if hasattr(other.inventory_store, "prefetch"):
835
inventory_ids = [other.get_revision(r).inventory_id
836
for r in revision_ids]
837
other.inventory_store.prefetch(inventory_ids)
842
for rev_id in revision_ids:
844
pb.update('fetching revision', i, len(revision_ids))
845
rev = other.get_revision(rev_id)
846
revisions.append(rev)
847
inv = other.get_inventory(str(rev.inventory_id))
848
for key, entry in inv.iter_entries():
849
if entry.text_id is None:
851
if entry.text_id not in self.text_store:
852
needed_texts.add(entry.text_id)
856
count = self.text_store.copy_multi(other.text_store, needed_texts)
857
print "Added %d texts." % count
858
inventory_ids = [ f.inventory_id for f in revisions ]
859
count = self.inventory_store.copy_multi(other.inventory_store,
861
print "Added %d inventories." % count
862
revision_ids = [ f.revision_id for f in revisions]
863
count = self.revision_store.copy_multi(other.revision_store,
865
for revision_id in revision_ids:
866
self.append_revision(revision_id)
867
print "Added %d revisions." % count
870
def commit(self, *args, **kw):
871
from bzrlib.commit import commit
872
commit(self, *args, **kw)
875
def lookup_revision(self, revision):
876
"""Return the revision identifier for a given revision information."""
877
revno, info = self.get_revision_info(revision)
880
def get_revision_info(self, revision):
881
"""Return (revno, revision id) for revision identifier.
883
revision can be an integer, in which case it is assumed to be revno (though
884
this will translate negative values into positive ones)
885
revision can also be a string, in which case it is parsed for something like
886
'date:' or 'revid:' etc.
891
try:# Convert to int if possible
892
revision = int(revision)
895
revs = self.revision_history()
896
if isinstance(revision, int):
899
# Mabye we should do this first, but we don't need it if revision == 0
901
revno = len(revs) + revision + 1
904
elif isinstance(revision, basestring):
905
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
906
if revision.startswith(prefix):
907
revno = func(self, revs, revision)
910
raise BzrError('No namespace registered for string: %r' % revision)
912
if revno is None or revno <= 0 or revno > len(revs):
913
raise BzrError("no such revision %s" % revision)
914
return revno, revs[revno-1]
916
def _namespace_revno(self, revs, revision):
917
"""Lookup a revision by revision number"""
918
assert revision.startswith('revno:')
920
return int(revision[6:])
923
REVISION_NAMESPACES['revno:'] = _namespace_revno
925
def _namespace_revid(self, revs, revision):
926
assert revision.startswith('revid:')
928
return revs.index(revision[6:]) + 1
931
REVISION_NAMESPACES['revid:'] = _namespace_revid
933
def _namespace_last(self, revs, revision):
934
assert revision.startswith('last:')
936
offset = int(revision[5:])
941
raise BzrError('You must supply a positive value for --revision last:XXX')
942
return len(revs) - offset + 1
943
REVISION_NAMESPACES['last:'] = _namespace_last
945
def _namespace_tag(self, revs, revision):
946
assert revision.startswith('tag:')
947
raise BzrError('tag: namespace registered, but not implemented.')
948
REVISION_NAMESPACES['tag:'] = _namespace_tag
950
def _namespace_date(self, revs, revision):
951
assert revision.startswith('date:')
953
# Spec for date revisions:
955
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
956
# it can also start with a '+/-/='. '+' says match the first
957
# entry after the given date. '-' is match the first entry before the date
958
# '=' is match the first entry after, but still on the given date.
960
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
961
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
962
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
963
# May 13th, 2005 at 0:00
965
# So the proper way of saying 'give me all entries for today' is:
966
# -r {date:+today}:{date:-tomorrow}
967
# The default is '=' when not supplied
970
if val[:1] in ('+', '-', '='):
971
match_style = val[:1]
974
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
975
if val.lower() == 'yesterday':
976
dt = today - datetime.timedelta(days=1)
977
elif val.lower() == 'today':
979
elif val.lower() == 'tomorrow':
980
dt = today + datetime.timedelta(days=1)
983
# This should be done outside the function to avoid recompiling it.
984
_date_re = re.compile(
985
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
987
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
989
m = _date_re.match(val)
990
if not m or (not m.group('date') and not m.group('time')):
991
raise BzrError('Invalid revision date %r' % revision)
994
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
996
year, month, day = today.year, today.month, today.day
998
hour = int(m.group('hour'))
999
minute = int(m.group('minute'))
1000
if m.group('second'):
1001
second = int(m.group('second'))
1005
hour, minute, second = 0,0,0
1007
dt = datetime.datetime(year=year, month=month, day=day,
1008
hour=hour, minute=minute, second=second)
1012
if match_style == '-':
1014
elif match_style == '=':
1015
last = dt + datetime.timedelta(days=1)
1018
for i in range(len(revs)-1, -1, -1):
1019
r = self.get_revision(revs[i])
1020
# TODO: Handle timezone.
1021
dt = datetime.datetime.fromtimestamp(r.timestamp)
1022
if first >= dt and (last is None or dt >= last):
1025
for i in range(len(revs)):
1026
r = self.get_revision(revs[i])
1027
# TODO: Handle timezone.
1028
dt = datetime.datetime.fromtimestamp(r.timestamp)
1029
if first <= dt and (last is None or dt <= last):
1031
REVISION_NAMESPACES['date:'] = _namespace_date
1033
def revision_tree(self, revision_id):
1034
"""Return Tree for a revision on this branch.
1036
`revision_id` may be None for the null revision, in which case
1037
an `EmptyTree` is returned."""
1038
# TODO: refactor this to use an existing revision object
1039
# so we don't need to read it in twice.
1040
if revision_id == None:
1043
inv = self.get_revision_inventory(revision_id)
1044
return RevisionTree(self.text_store, inv)
1047
def working_tree(self):
1048
"""Return a `Tree` for the working copy."""
1049
from workingtree import WorkingTree
1050
return WorkingTree(self.base, self.read_working_inventory())
447
"""Pull in new perfect-fit revisions.
449
:param other: Another Branch to pull from
450
:param stop_revision: Updated until the given revision
453
raise NotImplementedError(self.update_revisions)
455
def revision_id_to_revno(self, revision_id):
456
"""Given a revision id, return its revno"""
457
if revision_id is None:
459
revision_id = osutils.safe_revision_id(revision_id)
460
history = self.revision_history()
462
return history.index(revision_id) + 1
464
raise bzrlib.errors.NoSuchRevision(self, revision_id)
466
def get_rev_id(self, revno, history=None):
467
"""Find the revision id of the specified revno."""
471
history = self.revision_history()
472
if revno <= 0 or revno > len(history):
473
raise bzrlib.errors.NoSuchRevision(self, revno)
474
return history[revno - 1]
476
def pull(self, source, overwrite=False, stop_revision=None):
477
"""Mirror source into this branch.
479
This branch is considered to be 'local', having low latency.
481
:returns: PullResult instance
483
raise NotImplementedError(self.pull)
485
def push(self, target, overwrite=False, stop_revision=None):
486
"""Mirror this branch into target.
488
This branch is considered to be 'local', having low latency.
490
raise NotImplementedError(self.push)
1053
492
def basis_tree(self):
1054
"""Return `Tree` object for last revision.
1056
If there are no revisions yet, return an `EmptyTree`.
1058
r = self.last_patch()
1062
return RevisionTree(self.text_store, self.get_revision_inventory(r))
493
"""Return `Tree` object for last revision."""
494
return self.repository.revision_tree(self.last_revision())
1066
496
def rename_one(self, from_rel, to_rel):
1067
497
"""Rename one file.
1069
499
This can change the directory or the filename or both.
1073
tree = self.working_tree()
1074
inv = tree.inventory
1075
if not tree.has_filename(from_rel):
1076
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1077
if tree.has_filename(to_rel):
1078
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1080
file_id = inv.path2id(from_rel)
1082
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1084
if inv.path2id(to_rel):
1085
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1087
to_dir, to_tail = os.path.split(to_rel)
1088
to_dir_id = inv.path2id(to_dir)
1089
if to_dir_id == None and to_dir != '':
1090
raise BzrError("can't determine destination directory id for %r" % to_dir)
1092
mutter("rename_one:")
1093
mutter(" file_id {%s}" % file_id)
1094
mutter(" from_rel %r" % from_rel)
1095
mutter(" to_rel %r" % to_rel)
1096
mutter(" to_dir %r" % to_dir)
1097
mutter(" to_dir_id {%s}" % to_dir_id)
1099
inv.rename(file_id, to_dir_id, to_tail)
1101
print "%s => %s" % (from_rel, to_rel)
1103
from_abs = self.abspath(from_rel)
1104
to_abs = self.abspath(to_rel)
1106
os.rename(from_abs, to_abs)
1108
raise BzrError("failed to rename %r to %r: %s"
1109
% (from_abs, to_abs, e[1]),
1110
["rename rolled back"])
1112
self._write_inventory(inv)
501
raise NotImplementedError(self.rename_one)
1117
503
def move(self, from_paths, to_name):
1118
504
"""Rename files.
1125
511
Note that to_name is only the last component of the new name;
1126
512
this doesn't change the directory.
1130
## TODO: Option to move IDs only
1131
assert not isinstance(from_paths, basestring)
1132
tree = self.working_tree()
1133
inv = tree.inventory
1134
to_abs = self.abspath(to_name)
1135
if not isdir(to_abs):
1136
raise BzrError("destination %r is not a directory" % to_abs)
1137
if not tree.has_filename(to_name):
1138
raise BzrError("destination %r not in working directory" % to_abs)
1139
to_dir_id = inv.path2id(to_name)
1140
if to_dir_id == None and to_name != '':
1141
raise BzrError("destination %r is not a versioned directory" % to_name)
1142
to_dir_ie = inv[to_dir_id]
1143
if to_dir_ie.kind not in ('directory', 'root_directory'):
1144
raise BzrError("destination %r is not a directory" % to_abs)
1146
to_idpath = inv.get_idpath(to_dir_id)
1148
for f in from_paths:
1149
if not tree.has_filename(f):
1150
raise BzrError("%r does not exist in working tree" % f)
1151
f_id = inv.path2id(f)
1153
raise BzrError("%r is not versioned" % f)
1154
name_tail = splitpath(f)[-1]
1155
dest_path = appendpath(to_name, name_tail)
1156
if tree.has_filename(dest_path):
1157
raise BzrError("destination %r already exists" % dest_path)
1158
if f_id in to_idpath:
1159
raise BzrError("can't move %r to a subdirectory of itself" % f)
1161
# OK, so there's a race here, it's possible that someone will
1162
# create a file in this interval and then the rename might be
1163
# left half-done. But we should have caught most problems.
1165
for f in from_paths:
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
print "%s => %s" % (f, dest_path)
1169
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1171
os.rename(self.abspath(f), self.abspath(dest_path))
1173
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
["rename rolled back"])
1176
self._write_inventory(inv)
1181
def revert(self, filenames, old_tree=None, backups=True):
1182
"""Restore selected files to the versions from a previous tree.
1185
If true (default) backups are made of files before
1188
from bzrlib.errors import NotVersionedError, BzrError
1189
from bzrlib.atomicfile import AtomicFile
1190
from bzrlib.osutils import backup_file
1192
inv = self.read_working_inventory()
1193
if old_tree is None:
1194
old_tree = self.basis_tree()
1195
old_inv = old_tree.inventory
1198
for fn in filenames:
1199
file_id = inv.path2id(fn)
1201
raise NotVersionedError("not a versioned file", fn)
1202
if not old_inv.has_id(file_id):
1203
raise BzrError("file not present in old tree", fn, file_id)
1204
nids.append((fn, file_id))
1206
# TODO: Rename back if it was previously at a different location
1208
# TODO: If given a directory, restore the entire contents from
1209
# the previous version.
1211
# TODO: Make a backup to a temporary file.
1213
# TODO: If the file previously didn't exist, delete it?
1214
for fn, file_id in nids:
1217
f = AtomicFile(fn, 'wb')
1219
f.write(old_tree.get_file(file_id).read())
1225
def pending_merges(self):
1226
"""Return a list of pending merges.
1228
These are revisions that have been merged into the working
1229
directory but not yet committed.
1231
cfn = self.controlfilename('pending-merges')
1232
if not os.path.exists(cfn):
1235
for l in self.controlfile('pending-merges', 'r').readlines():
1236
p.append(l.rstrip('\n'))
1240
def add_pending_merge(self, revision_id):
1241
from bzrlib.revision import validate_revision_id
1243
validate_revision_id(revision_id)
1245
p = self.pending_merges()
1246
if revision_id in p:
1248
p.append(revision_id)
1249
self.set_pending_merges(p)
1252
def set_pending_merges(self, rev_list):
1253
from bzrlib.atomicfile import AtomicFile
1256
f = AtomicFile(self.controlfilename('pending-merges'))
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1271
>>> b = ScratchBranch()
1279
def __init__(self, files=[], dirs=[], base=None):
1280
"""Make a test branch.
1282
This creates a temporary directory and runs init-tree in it.
1284
If any files are listed, they are created in the working copy.
1286
from tempfile import mkdtemp
1291
Branch.__init__(self, base, init=init)
1293
os.mkdir(self.abspath(d))
1296
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1301
>>> orig = ScratchBranch(files=["file1", "file2"])
1302
>>> clone = orig.clone()
1303
>>> os.path.samefile(orig.base, clone.base)
1305
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1308
from shutil import copytree
1309
from tempfile import mkdtemp
1312
copytree(self.base, base, symlinks=True)
1313
return ScratchBranch(base=base)
1319
"""Destroy the test branch, removing the scratch directory."""
1320
from shutil import rmtree
1323
mutter("delete ScratchBranch %s" % self.base)
1326
# Work around for shutil.rmtree failing on Windows when
1327
# readonly files are encountered
1328
mutter("hit exception in destroying ScratchBranch: %s" % e)
1329
for root, dirs, files in os.walk(self.base, topdown=False):
1331
os.chmod(os.path.join(root, name), 0700)
1337
######################################################################
1341
def is_control_file(filename):
1342
## FIXME: better check
1343
filename = os.path.normpath(filename)
1344
while filename != '':
1345
head, tail = os.path.split(filename)
1346
## mutter('check %r for control file' % ((head, tail), ))
1347
if tail == bzrlib.BZRDIR:
514
This returns a list of (from_path, to_path) pairs for each
517
raise NotImplementedError(self.move)
519
def get_parent(self):
520
"""Return the parent location of the branch.
522
This is the default location for push/pull/missing. The usual
523
pattern is that the user can override it by specifying a
526
raise NotImplementedError(self.get_parent)
528
def _set_config_location(self, name, url, config=None,
529
make_relative=False):
531
config = self.get_config()
535
url = urlutils.relative_url(self.base, url)
536
config.set_user_option(name, url)
538
def _get_config_location(self, name, config=None):
540
config = self.get_config()
541
location = config.get_user_option(name)
546
def get_submit_branch(self):
547
"""Return the submit location of the branch.
549
This is the default location for bundle. The usual
550
pattern is that the user can override it by specifying a
553
return self.get_config().get_user_option('submit_branch')
555
def set_submit_branch(self, location):
556
"""Return the submit location of the branch.
558
This is the default location for bundle. The usual
559
pattern is that the user can override it by specifying a
562
self.get_config().set_user_option('submit_branch', location)
564
def get_public_branch(self):
565
"""Return the public location of the branch.
567
This is is used by merge directives.
569
return self._get_config_location('public_branch')
571
def set_public_branch(self, location):
572
"""Return the submit location of the branch.
574
This is the default location for bundle. The usual
575
pattern is that the user can override it by specifying a
578
self._set_config_location('public_branch', location)
580
def get_push_location(self):
581
"""Return the None or the location to push this branch to."""
582
push_loc = self.get_config().get_user_option('push_location')
585
def set_push_location(self, location):
586
"""Set a new push location for this branch."""
587
raise NotImplementedError(self.set_push_location)
589
def set_parent(self, url):
590
raise NotImplementedError(self.set_parent)
594
"""Synchronise this branch with the master branch if any.
596
:return: None or the last_revision pivoted out during the update.
600
def check_revno(self, revno):
602
Check whether a revno corresponds to any revision.
603
Zero (the NULL revision) is considered valid.
606
self.check_real_revno(revno)
608
def check_real_revno(self, revno):
610
Check whether a revno corresponds to a real revision.
611
Zero (the NULL revision) is considered invalid
613
if revno < 1 or revno > self.revno():
614
raise InvalidRevisionNumber(revno)
617
def clone(self, to_bzrdir, revision_id=None):
618
"""Clone this branch into to_bzrdir preserving all semantic values.
620
revision_id: if not None, the revision history in the new branch will
621
be truncated to end with revision_id.
623
result = self._format.initialize(to_bzrdir)
624
self.copy_content_into(result, revision_id=revision_id)
628
def sprout(self, to_bzrdir, revision_id=None):
629
"""Create a new line of development from the branch, into to_bzrdir.
631
revision_id: if not None, the revision history in the new branch will
632
be truncated to end with revision_id.
634
result = self._format.initialize(to_bzrdir)
635
self.copy_content_into(result, revision_id=revision_id)
636
result.set_parent(self.bzrdir.root_transport.base)
639
def _synchronize_history(self, destination, revision_id):
640
"""Synchronize last revision and revision history between branches.
642
This version is most efficient when the destination is also a
643
BzrBranch5, but works for BzrBranch6 as long as the revision
644
history is the true lefthand parent history, and all of the revisions
645
are in the destination's repository. If not, set_revision_history
648
:param destination: The branch to copy the history into
649
:param revision_id: The revision-id to truncate history at. May
650
be None to copy complete history.
652
new_history = self.revision_history()
653
if revision_id is not None:
654
revision_id = osutils.safe_revision_id(revision_id)
656
new_history = new_history[:new_history.index(revision_id) + 1]
658
rev = self.repository.get_revision(revision_id)
659
new_history = rev.get_history(self.repository)[1:]
660
destination.set_revision_history(new_history)
663
def copy_content_into(self, destination, revision_id=None):
664
"""Copy the content of self into destination.
666
revision_id: if not None, the revision history in the new branch will
667
be truncated to end with revision_id.
669
self._synchronize_history(destination, revision_id)
671
parent = self.get_parent()
672
except errors.InaccessibleParent, e:
673
mutter('parent was not accessible to copy: %s', e)
676
destination.set_parent(parent)
677
self.tags.merge_to(destination.tags)
681
"""Check consistency of the branch.
683
In particular this checks that revisions given in the revision-history
684
do actually match up in the revision graph, and that they're all
685
present in the repository.
687
Callers will typically also want to check the repository.
689
:return: A BranchCheckResult.
691
mainline_parent_id = None
692
for revision_id in self.revision_history():
694
revision = self.repository.get_revision(revision_id)
695
except errors.NoSuchRevision, e:
696
raise errors.BzrCheckError("mainline revision {%s} not in repository"
698
# In general the first entry on the revision history has no parents.
699
# But it's not illegal for it to have parents listed; this can happen
700
# in imports from Arch when the parents weren't reachable.
701
if mainline_parent_id is not None:
702
if mainline_parent_id not in revision.parent_ids:
703
raise errors.BzrCheckError("previous revision {%s} not listed among "
705
% (mainline_parent_id, revision_id))
706
mainline_parent_id = revision_id
707
return BranchCheckResult(self)
709
def _get_checkout_format(self):
710
"""Return the most suitable metadir for a checkout of this branch.
711
Weaves are used if this branch's repository uses weaves.
713
from bzrlib.remote import RemoteBzrDir
714
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
715
from bzrlib.repofmt import weaverepo
716
format = bzrdir.BzrDirMetaFormat1()
717
format.repository_format = weaverepo.RepositoryFormat7()
718
elif isinstance(self.bzrdir, RemoteBzrDir):
719
format = bzrdir.BzrDirMetaFormat1()
721
format = self.repository.bzrdir.checkout_metadir()
722
format.set_branch_format(self._format)
725
def create_checkout(self, to_location, revision_id=None,
727
"""Create a checkout of a branch.
729
:param to_location: The url to produce the checkout at
730
:param revision_id: The revision to check out
731
:param lightweight: If True, produce a lightweight checkout, otherwise,
732
produce a bound branch (heavyweight checkout)
733
:return: The tree of the created checkout
735
t = transport.get_transport(to_location)
738
except errors.FileExists:
741
format = self._get_checkout_format()
742
checkout = format.initialize_on_transport(t)
743
BranchReferenceFormat().initialize(checkout, self)
745
format = self._get_checkout_format()
746
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
747
to_location, force_new_tree=False, format=format)
748
checkout = checkout_branch.bzrdir
749
checkout_branch.bind(self)
750
# pull up to the specified revision_id to set the initial
751
# branch tip correctly, and seed it with history.
752
checkout_branch.pull(self, stop_revision=revision_id)
753
tree = checkout.create_workingtree(revision_id)
754
basis_tree = tree.basis_tree()
755
basis_tree.lock_read()
757
for path, file_id in basis_tree.iter_references():
758
reference_parent = self.reference_parent(file_id, path)
759
reference_parent.create_checkout(tree.abspath(path),
760
basis_tree.get_reference_revision(file_id, path),
766
def reference_parent(self, file_id, path):
767
"""Return the parent branch for a tree-reference file_id
768
:param file_id: The file_id of the tree reference
769
:param path: The path of the file_id in the tree
770
:return: A branch associated with the file_id
772
# FIXME should provide multiple branches, based on config
773
return Branch.open(self.bzrdir.root_transport.clone(path).base)
775
def supports_tags(self):
776
return self._format.supports_tags()
779
class BranchFormat(object):
780
"""An encapsulation of the initialization and open routines for a format.
782
Formats provide three things:
783
* An initialization routine,
787
Formats are placed in an dict by their format string for reference
788
during branch opening. Its not required that these be instances, they
789
can be classes themselves with class methods - it simply depends on
790
whether state is needed for a given format or not.
792
Once a format is deprecated, just deprecate the initialize and open
793
methods on the format class. Do not deprecate the object, as the
794
object will be created every time regardless.
797
_default_format = None
798
"""The default format used for new branches."""
801
"""The known formats."""
804
def find_format(klass, a_bzrdir):
805
"""Return the format for the branch object in a_bzrdir."""
807
transport = a_bzrdir.get_branch_transport(None)
808
format_string = transport.get("format").read()
809
return klass._formats[format_string]
811
raise NotBranchError(path=transport.base)
813
raise errors.UnknownFormatError(format=format_string)
816
def get_default_format(klass):
817
"""Return the current default format."""
818
return klass._default_format
820
def get_reference(self, a_bzrdir):
821
"""Get the target reference of the branch in a_bzrdir.
823
format probing must have been completed before calling
824
this method - it is assumed that the format of the branch
825
in a_bzrdir is correct.
827
:param a_bzrdir: The bzrdir to get the branch data from.
828
:return: None if the branch is not a reference branch.
832
def get_format_string(self):
833
"""Return the ASCII format string that identifies this format."""
834
raise NotImplementedError(self.get_format_string)
836
def get_format_description(self):
837
"""Return the short format description for this format."""
838
raise NotImplementedError(self.get_format_description)
840
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
842
"""Initialize a branch in a bzrdir, with specified files
844
:param a_bzrdir: The bzrdir to initialize the branch in
845
:param utf8_files: The files to create as a list of
846
(filename, content) tuples
847
:param set_format: If True, set the format with
848
self.get_format_string. (BzrBranch4 has its format set
850
:return: a branch in this format
852
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
853
branch_transport = a_bzrdir.get_branch_transport(self)
855
'metadir': ('lock', lockdir.LockDir),
856
'branch4': ('branch-lock', lockable_files.TransportLock),
858
lock_name, lock_class = lock_map[lock_type]
859
control_files = lockable_files.LockableFiles(branch_transport,
860
lock_name, lock_class)
861
control_files.create_lock()
862
control_files.lock_write()
864
control_files.put_utf8('format', self.get_format_string())
866
for file, content in utf8_files:
867
control_files.put_utf8(file, content)
869
control_files.unlock()
870
return self.open(a_bzrdir, _found=True)
872
def initialize(self, a_bzrdir):
873
"""Create a branch of this format in a_bzrdir."""
874
raise NotImplementedError(self.initialize)
876
def is_supported(self):
877
"""Is this format supported?
879
Supported formats can be initialized and opened.
880
Unsupported formats may not support initialization or committing or
881
some other features depending on the reason for not being supported.
885
def open(self, a_bzrdir, _found=False):
886
"""Return the branch object for a_bzrdir
888
_found is a private parameter, do not use it. It is used to indicate
889
if format probing has already be done.
891
raise NotImplementedError(self.open)
894
def register_format(klass, format):
895
klass._formats[format.get_format_string()] = format
898
def set_default_format(klass, format):
899
klass._default_format = format
902
def unregister_format(klass, format):
903
assert klass._formats[format.get_format_string()] is format
904
del klass._formats[format.get_format_string()]
907
return self.get_format_string().rstrip()
909
def supports_tags(self):
910
"""True if this format supports tags stored in the branch"""
911
return False # by default
913
# XXX: Probably doesn't really belong here -- mbp 20070212
914
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
916
branch_transport = a_bzrdir.get_branch_transport(self)
917
control_files = lockable_files.LockableFiles(branch_transport,
918
lock_filename, lock_class)
919
control_files.create_lock()
920
control_files.lock_write()
922
for filename, content in utf8_files:
923
control_files.put_utf8(filename, content)
925
control_files.unlock()
928
class BranchHooks(Hooks):
929
"""A dictionary mapping hook name to a list of callables for branch hooks.
931
e.g. ['set_rh'] Is the list of items to be called when the
932
set_revision_history function is invoked.
936
"""Create the default hooks.
938
These are all empty initially, because by default nothing should get
942
# Introduced in 0.15:
943
# invoked whenever the revision history has been set
944
# with set_revision_history. The api signature is
945
# (branch, revision_history), and the branch will
948
# invoked after a push operation completes.
949
# the api signature is
951
# containing the members
952
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
953
# where local is the local branch or None, master is the target
954
# master branch, and the rest should be self explanatory. The source
955
# is read locked and the target branches write locked. Source will
956
# be the local low-latency branch.
957
self['post_push'] = []
958
# invoked after a pull operation completes.
959
# the api signature is
961
# containing the members
962
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
963
# where local is the local branch or None, master is the target
964
# master branch, and the rest should be self explanatory. The source
965
# is read locked and the target branches write locked. The local
966
# branch is the low-latency branch.
967
self['post_pull'] = []
968
# invoked after a commit operation completes.
969
# the api signature is
970
# (local, master, old_revno, old_revid, new_revno, new_revid)
971
# old_revid is NULL_REVISION for the first commit to a branch.
972
self['post_commit'] = []
973
# invoked after a uncommit operation completes.
974
# the api signature is
975
# (local, master, old_revno, old_revid, new_revno, new_revid) where
976
# local is the local branch or None, master is the target branch,
977
# and an empty branch recieves new_revno of 0, new_revid of None.
978
self['post_uncommit'] = []
981
# install the default hooks into the Branch class.
982
Branch.hooks = BranchHooks()
985
class BzrBranchFormat4(BranchFormat):
986
"""Bzr branch format 4.
989
- a revision-history file.
990
- a branch-lock lock file [ to be shared with the bzrdir ]
993
def get_format_description(self):
994
"""See BranchFormat.get_format_description()."""
995
return "Branch format 4"
997
def initialize(self, a_bzrdir):
998
"""Create a branch of this format in a_bzrdir."""
999
utf8_files = [('revision-history', ''),
1000
('branch-name', ''),
1002
return self._initialize_helper(a_bzrdir, utf8_files,
1003
lock_type='branch4', set_format=False)
1006
super(BzrBranchFormat4, self).__init__()
1007
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1009
def open(self, a_bzrdir, _found=False):
1010
"""Return the branch object for a_bzrdir
1012
_found is a private parameter, do not use it. It is used to indicate
1013
if format probing has already be done.
1016
# we are being called directly and must probe.
1017
raise NotImplementedError
1018
return BzrBranch(_format=self,
1019
_control_files=a_bzrdir._control_files,
1021
_repository=a_bzrdir.open_repository())
1024
return "Bazaar-NG branch format 4"
1027
class BzrBranchFormat5(BranchFormat):
1028
"""Bzr branch format 5.
1031
- a revision-history file.
1033
- a lock dir guarding the branch itself
1034
- all of this stored in a branch/ subdirectory
1035
- works with shared repositories.
1037
This format is new in bzr 0.8.
1040
def get_format_string(self):
1041
"""See BranchFormat.get_format_string()."""
1042
return "Bazaar-NG branch format 5\n"
1044
def get_format_description(self):
1045
"""See BranchFormat.get_format_description()."""
1046
return "Branch format 5"
1048
def initialize(self, a_bzrdir):
1049
"""Create a branch of this format in a_bzrdir."""
1050
utf8_files = [('revision-history', ''),
1051
('branch-name', ''),
1053
return self._initialize_helper(a_bzrdir, utf8_files)
1056
super(BzrBranchFormat5, self).__init__()
1057
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1059
def open(self, a_bzrdir, _found=False):
1060
"""Return the branch object for a_bzrdir
1062
_found is a private parameter, do not use it. It is used to indicate
1063
if format probing has already be done.
1066
format = BranchFormat.find_format(a_bzrdir)
1067
assert format.__class__ == self.__class__
1069
transport = a_bzrdir.get_branch_transport(None)
1070
control_files = lockable_files.LockableFiles(transport, 'lock',
1072
return BzrBranch5(_format=self,
1073
_control_files=control_files,
1075
_repository=a_bzrdir.find_repository())
1077
raise NotBranchError(path=transport.base)
1080
class BzrBranchFormat6(BzrBranchFormat5):
1081
"""Branch format with last-revision
1083
Unlike previous formats, this has no explicit revision history. Instead,
1084
this just stores the last-revision, and the left-hand history leading
1085
up to there is the history.
1087
This format was introduced in bzr 0.15
1090
def get_format_string(self):
1091
"""See BranchFormat.get_format_string()."""
1092
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1094
def get_format_description(self):
1095
"""See BranchFormat.get_format_description()."""
1096
return "Branch format 6"
1098
def initialize(self, a_bzrdir):
1099
"""Create a branch of this format in a_bzrdir."""
1100
utf8_files = [('last-revision', '0 null:\n'),
1101
('branch-name', ''),
1102
('branch.conf', ''),
1105
return self._initialize_helper(a_bzrdir, utf8_files)
1107
def open(self, a_bzrdir, _found=False):
1108
"""Return the branch object for a_bzrdir
1110
_found is a private parameter, do not use it. It is used to indicate
1111
if format probing has already be done.
1114
format = BranchFormat.find_format(a_bzrdir)
1115
assert format.__class__ == self.__class__
1116
transport = a_bzrdir.get_branch_transport(None)
1117
control_files = lockable_files.LockableFiles(transport, 'lock',
1119
return BzrBranch6(_format=self,
1120
_control_files=control_files,
1122
_repository=a_bzrdir.find_repository())
1124
def supports_tags(self):
1128
class BranchReferenceFormat(BranchFormat):
1129
"""Bzr branch reference format.
1131
Branch references are used in implementing checkouts, they
1132
act as an alias to the real branch which is at some other url.
1139
def get_format_string(self):
1140
"""See BranchFormat.get_format_string()."""
1141
return "Bazaar-NG Branch Reference Format 1\n"
1143
def get_format_description(self):
1144
"""See BranchFormat.get_format_description()."""
1145
return "Checkout reference format 1"
1147
def get_reference(self, a_bzrdir):
1148
"""See BranchFormat.get_reference()."""
1149
transport = a_bzrdir.get_branch_transport(None)
1150
return transport.get('location').read()
1152
def initialize(self, a_bzrdir, target_branch=None):
1153
"""Create a branch of this format in a_bzrdir."""
1154
if target_branch is None:
1155
# this format does not implement branch itself, thus the implicit
1156
# creation contract must see it as uninitializable
1157
raise errors.UninitializableFormat(self)
1158
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1159
branch_transport = a_bzrdir.get_branch_transport(self)
1160
branch_transport.put_bytes('location',
1161
target_branch.bzrdir.root_transport.base)
1162
branch_transport.put_bytes('format', self.get_format_string())
1163
return self.open(a_bzrdir, _found=True)
1166
super(BranchReferenceFormat, self).__init__()
1167
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1169
def _make_reference_clone_function(format, a_branch):
1170
"""Create a clone() routine for a branch dynamically."""
1171
def clone(to_bzrdir, revision_id=None):
1172
"""See Branch.clone()."""
1173
return format.initialize(to_bzrdir, a_branch)
1174
# cannot obey revision_id limits when cloning a reference ...
1175
# FIXME RBC 20060210 either nuke revision_id for clone, or
1176
# emit some sort of warning/error to the caller ?!
1179
def open(self, a_bzrdir, _found=False, location=None):
1180
"""Return the branch that the branch reference in a_bzrdir points at.
1182
_found is a private parameter, do not use it. It is used to indicate
1183
if format probing has already be done.
1186
format = BranchFormat.find_format(a_bzrdir)
1187
assert format.__class__ == self.__class__
1188
if location is None:
1189
location = self.get_reference(a_bzrdir)
1190
real_bzrdir = bzrdir.BzrDir.open(location)
1191
result = real_bzrdir.open_branch()
1192
# this changes the behaviour of result.clone to create a new reference
1193
# rather than a copy of the content of the branch.
1194
# I did not use a proxy object because that needs much more extensive
1195
# testing, and we are only changing one behaviour at the moment.
1196
# If we decide to alter more behaviours - i.e. the implicit nickname
1197
# then this should be refactored to introduce a tested proxy branch
1198
# and a subclass of that for use in overriding clone() and ....
1200
result.clone = self._make_reference_clone_function(result)
1204
# formats which have no format string are not discoverable
1205
# and not independently creatable, so are not registered.
1206
__default_format = BzrBranchFormat5()
1207
BranchFormat.register_format(__default_format)
1208
BranchFormat.register_format(BranchReferenceFormat())
1209
BranchFormat.register_format(BzrBranchFormat6())
1210
BranchFormat.set_default_format(__default_format)
1211
_legacy_formats = [BzrBranchFormat4(),
1214
class BzrBranch(Branch):
1215
"""A branch stored in the actual filesystem.
1217
Note that it's "local" in the context of the filesystem; it doesn't
1218
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1219
it's writable, and can be accessed via the normal filesystem API.
1222
def __init__(self, _format=None,
1223
_control_files=None, a_bzrdir=None, _repository=None):
1224
"""Create new branch object at a particular location."""
1225
Branch.__init__(self)
1226
if a_bzrdir is None:
1227
raise ValueError('a_bzrdir must be supplied')
1229
self.bzrdir = a_bzrdir
1230
# self._transport used to point to the directory containing the
1231
# control directory, but was not used - now it's just the transport
1232
# for the branch control files. mbp 20070212
1233
self._base = self.bzrdir.transport.clone('..').base
1234
self._format = _format
1235
if _control_files is None:
1236
raise ValueError('BzrBranch _control_files is None')
1237
self.control_files = _control_files
1238
self._transport = _control_files._transport
1239
self.repository = _repository
1242
return '%s(%r)' % (self.__class__.__name__, self.base)
1246
def _get_base(self):
1247
"""Returns the directory containing the control directory."""
1250
base = property(_get_base, doc="The URL for the root of this branch.")
1252
def abspath(self, name):
1253
"""See Branch.abspath."""
1254
return self.control_files._transport.abspath(name)
1257
@deprecated_method(zero_sixteen)
1259
def get_root_id(self):
1260
"""See Branch.get_root_id."""
1261
tree = self.repository.revision_tree(self.last_revision())
1262
return tree.inventory.root.file_id
1264
def is_locked(self):
1265
return self.control_files.is_locked()
1267
def lock_write(self, token=None):
1268
repo_token = self.repository.lock_write()
1270
token = self.control_files.lock_write(token=token)
1272
self.repository.unlock()
1276
def lock_read(self):
1277
self.repository.lock_read()
1279
self.control_files.lock_read()
1281
self.repository.unlock()
1285
# TODO: test for failed two phase locks. This is known broken.
1287
self.control_files.unlock()
1289
self.repository.unlock()
1290
if not self.control_files.is_locked():
1291
# we just released the lock
1292
self._clear_cached_state()
1294
def peek_lock_mode(self):
1295
if self.control_files._lock_count == 0:
1298
return self.control_files._lock_mode
1300
def get_physical_lock_status(self):
1301
return self.control_files.get_physical_lock_status()
1304
def print_file(self, file, revision_id):
1305
"""See Branch.print_file."""
1306
return self.repository.print_file(file, revision_id)
1309
def append_revision(self, *revision_ids):
1310
"""See Branch.append_revision."""
1311
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1312
for revision_id in revision_ids:
1313
_mod_revision.check_not_reserved_id(revision_id)
1314
mutter("add {%s} to revision-history" % revision_id)
1315
rev_history = self.revision_history()
1316
rev_history.extend(revision_ids)
1317
self.set_revision_history(rev_history)
1319
def _write_revision_history(self, history):
1320
"""Factored out of set_revision_history.
1322
This performs the actual writing to disk.
1323
It is intended to be called by BzrBranch5.set_revision_history."""
1324
self.control_files.put_bytes(
1325
'revision-history', '\n'.join(history))
1328
def set_revision_history(self, rev_history):
1329
"""See Branch.set_revision_history."""
1330
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1331
self._write_revision_history(rev_history)
1332
self._cache_revision_history(rev_history)
1333
for hook in Branch.hooks['set_rh']:
1334
hook(self, rev_history)
1337
def set_last_revision_info(self, revno, revision_id):
1338
revision_id = osutils.safe_revision_id(revision_id)
1339
history = self._lefthand_history(revision_id)
1340
assert len(history) == revno, '%d != %d' % (len(history), revno)
1341
self.set_revision_history(history)
1343
def _gen_revision_history(self):
1344
history = self.control_files.get('revision-history').read().split('\n')
1345
if history[-1:] == ['']:
1346
# There shouldn't be a trailing newline, but just in case.
1350
def _lefthand_history(self, revision_id, last_rev=None,
1352
# stop_revision must be a descendant of last_revision
1353
stop_graph = self.repository.get_revision_graph(revision_id)
1354
if last_rev is not None and last_rev not in stop_graph:
1355
# our previous tip is not merged into stop_revision
1356
raise errors.DivergedBranches(self, other_branch)
1357
# make a new revision history from the graph
1358
current_rev_id = revision_id
1360
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1361
new_history.append(current_rev_id)
1362
current_rev_id_parents = stop_graph[current_rev_id]
1364
current_rev_id = current_rev_id_parents[0]
1366
current_rev_id = None
1367
new_history.reverse()
1371
def generate_revision_history(self, revision_id, last_rev=None,
1373
"""Create a new revision history that will finish with revision_id.
1375
:param revision_id: the new tip to use.
1376
:param last_rev: The previous last_revision. If not None, then this
1377
must be a ancestory of revision_id, or DivergedBranches is raised.
1378
:param other_branch: The other branch that DivergedBranches should
1379
raise with respect to.
1381
revision_id = osutils.safe_revision_id(revision_id)
1382
self.set_revision_history(self._lefthand_history(revision_id,
1383
last_rev, other_branch))
1386
def update_revisions(self, other, stop_revision=None):
1387
"""See Branch.update_revisions."""
1390
if stop_revision is None:
1391
stop_revision = other.last_revision()
1392
if stop_revision is None:
1393
# if there are no commits, we're done.
1396
stop_revision = osutils.safe_revision_id(stop_revision)
1397
# whats the current last revision, before we fetch [and change it
1399
last_rev = self.last_revision()
1400
# we fetch here regardless of whether we need to so that we pickup
1402
self.fetch(other, stop_revision)
1403
my_ancestry = self.repository.get_ancestry(last_rev)
1404
if stop_revision in my_ancestry:
1405
# last_revision is a descendant of stop_revision
1407
self.generate_revision_history(stop_revision, last_rev=last_rev,
1412
def basis_tree(self):
1413
"""See Branch.basis_tree."""
1414
return self.repository.revision_tree(self.last_revision())
1416
@deprecated_method(zero_eight)
1417
def working_tree(self):
1418
"""Create a Working tree object for this branch."""
1420
from bzrlib.transport.local import LocalTransport
1421
if (self.base.find('://') != -1 or
1422
not isinstance(self._transport, LocalTransport)):
1423
raise NoWorkingTree(self.base)
1424
return self.bzrdir.open_workingtree()
1427
def pull(self, source, overwrite=False, stop_revision=None,
1428
_hook_master=None, _run_hooks=True):
1431
:param _hook_master: Private parameter - set the branch to
1432
be supplied as the master to push hooks.
1433
:param _run_hooks: Private parameter - allow disabling of
1434
hooks, used when pushing to a master branch.
1436
result = PullResult()
1437
result.source_branch = source
1438
result.target_branch = self
1441
result.old_revno, result.old_revid = self.last_revision_info()
1443
self.update_revisions(source, stop_revision)
1444
except DivergedBranches:
1448
if stop_revision is None:
1449
stop_revision = source.last_revision()
1450
self.generate_revision_history(stop_revision)
1451
result.tag_conflicts = source.tags.merge_to(self.tags)
1452
result.new_revno, result.new_revid = self.last_revision_info()
1454
result.master_branch = _hook_master
1455
result.local_branch = self
1457
result.master_branch = self
1458
result.local_branch = None
1460
for hook in Branch.hooks['post_pull']:
1466
def _get_parent_location(self):
1467
_locs = ['parent', 'pull', 'x-pull']
1470
return self.control_files.get(l).read().strip('\n')
1476
def push(self, target, overwrite=False, stop_revision=None,
1477
_hook_master=None, _run_hooks=True):
1480
:param _hook_master: Private parameter - set the branch to
1481
be supplied as the master to push hooks.
1482
:param _run_hooks: Private parameter - allow disabling of
1483
hooks, used when pushing to a master branch.
1485
result = PushResult()
1486
result.source_branch = self
1487
result.target_branch = target
1490
result.old_revno, result.old_revid = target.last_revision_info()
1492
target.update_revisions(self, stop_revision)
1493
except DivergedBranches:
1497
target.set_revision_history(self.revision_history())
1498
result.tag_conflicts = self.tags.merge_to(target.tags)
1499
result.new_revno, result.new_revid = target.last_revision_info()
1501
result.master_branch = _hook_master
1502
result.local_branch = target
1504
result.master_branch = target
1505
result.local_branch = None
1507
for hook in Branch.hooks['post_push']:
1513
def get_parent(self):
1514
"""See Branch.get_parent."""
1516
assert self.base[-1] == '/'
1517
parent = self._get_parent_location()
1520
# This is an old-format absolute path to a local branch
1521
# turn it into a url
1522
if parent.startswith('/'):
1523
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1525
return urlutils.join(self.base[:-1], parent)
1526
except errors.InvalidURLJoin, e:
1527
raise errors.InaccessibleParent(parent, self.base)
1529
def set_push_location(self, location):
1530
"""See Branch.set_push_location."""
1531
self.get_config().set_user_option(
1532
'push_location', location,
1533
store=_mod_config.STORE_LOCATION_NORECURSE)
1536
def set_parent(self, url):
1537
"""See Branch.set_parent."""
1538
# TODO: Maybe delete old location files?
1539
# URLs should never be unicode, even on the local fs,
1540
# FIXUP this and get_parent in a future branch format bump:
1541
# read and rewrite the file, and have the new format code read
1542
# using .get not .get_utf8. RBC 20060125
1544
if isinstance(url, unicode):
1546
url = url.encode('ascii')
1547
except UnicodeEncodeError:
1548
raise bzrlib.errors.InvalidURL(url,
1549
"Urls must be 7-bit ascii, "
1550
"use bzrlib.urlutils.escape")
1551
url = urlutils.relative_url(self.base, url)
1552
self._set_parent_location(url)
1554
def _set_parent_location(self, url):
1556
self.control_files._transport.delete('parent')
1558
assert isinstance(url, str)
1559
self.control_files.put_bytes('parent', url + '\n')
1561
@deprecated_function(zero_nine)
1562
def tree_config(self):
1563
"""DEPRECATED; call get_config instead.
1564
TreeConfig has become part of BranchConfig."""
1565
return TreeConfig(self)
1568
class BzrBranch5(BzrBranch):
1569
"""A format 5 branch. This supports new features over plan branches.
1571
It has support for a master_branch which is the data for bound branches.
1579
super(BzrBranch5, self).__init__(_format=_format,
1580
_control_files=_control_files,
1582
_repository=_repository)
1585
def pull(self, source, overwrite=False, stop_revision=None,
1587
"""Extends branch.pull to be bound branch aware.
1589
:param _run_hooks: Private parameter used to force hook running
1590
off during bound branch double-pushing.
1592
bound_location = self.get_bound_location()
1593
master_branch = None
1594
if bound_location and source.base != bound_location:
1595
# not pulling from master, so we need to update master.
1596
master_branch = self.get_master_branch()
1597
master_branch.lock_write()
1600
# pull from source into master.
1601
master_branch.pull(source, overwrite, stop_revision,
1603
return super(BzrBranch5, self).pull(source, overwrite,
1604
stop_revision, _hook_master=master_branch,
1605
_run_hooks=_run_hooks)
1608
master_branch.unlock()
1611
def push(self, target, overwrite=False, stop_revision=None):
1612
"""Updates branch.push to be bound branch aware."""
1613
bound_location = target.get_bound_location()
1614
master_branch = None
1615
if bound_location and target.base != bound_location:
1616
# not pushing to master, so we need to update master.
1617
master_branch = target.get_master_branch()
1618
master_branch.lock_write()
1621
# push into the master from this branch.
1622
super(BzrBranch5, self).push(master_branch, overwrite,
1623
stop_revision, _run_hooks=False)
1624
# and push into the target branch from this. Note that we push from
1625
# this branch again, because its considered the highest bandwidth
1627
return super(BzrBranch5, self).push(target, overwrite,
1628
stop_revision, _hook_master=master_branch)
1631
master_branch.unlock()
1633
def get_bound_location(self):
1635
return self.control_files.get_utf8('bound').read()[:-1]
1636
except errors.NoSuchFile:
1640
def get_master_branch(self):
1641
"""Return the branch we are bound to.
1643
:return: Either a Branch, or None
1645
This could memoise the branch, but if thats done
1646
it must be revalidated on each new lock.
1647
So for now we just don't memoise it.
1648
# RBC 20060304 review this decision.
1650
bound_loc = self.get_bound_location()
1654
return Branch.open(bound_loc)
1655
except (errors.NotBranchError, errors.ConnectionError), e:
1656
raise errors.BoundBranchConnectionFailure(
1660
def set_bound_location(self, location):
1661
"""Set the target where this branch is bound to.
1663
:param location: URL to the target branch
1666
self.control_files.put_utf8('bound', location+'\n')
1669
self.control_files._transport.delete('bound')
1349
if filename == head:
1356
def gen_file_id(name):
1357
"""Return new file id.
1359
This should probably generate proper UUIDs, but for the moment we
1360
cope with just randomness because running uuidgen every time is
1363
from binascii import hexlify
1364
from time import time
1366
# get last component
1367
idx = name.rfind('/')
1369
name = name[idx+1 : ]
1370
idx = name.rfind('\\')
1372
name = name[idx+1 : ]
1374
# make it not a hidden file
1375
name = name.lstrip('.')
1377
# remove any wierd characters; we don't escape them but rather
1378
# just pull them out
1379
name = re.sub(r'[^\w.]', '', name)
1381
s = hexlify(rand_bytes(8))
1382
return '-'.join((name, compact_date(time()), s))
1386
"""Return a new tree-root file id."""
1387
return gen_file_id('TREE_ROOT')
1675
def bind(self, other):
1676
"""Bind this branch to the branch other.
1678
This does not push or pull data between the branches, though it does
1679
check for divergence to raise an error when the branches are not
1680
either the same, or one a prefix of the other. That behaviour may not
1681
be useful, so that check may be removed in future.
1683
:param other: The branch to bind to
1686
# TODO: jam 20051230 Consider checking if the target is bound
1687
# It is debatable whether you should be able to bind to
1688
# a branch which is itself bound.
1689
# Committing is obviously forbidden,
1690
# but binding itself may not be.
1691
# Since we *have* to check at commit time, we don't
1692
# *need* to check here
1694
# we want to raise diverged if:
1695
# last_rev is not in the other_last_rev history, AND
1696
# other_last_rev is not in our history, and do it without pulling
1698
last_rev = self.last_revision()
1699
if last_rev is not None:
1702
other_last_rev = other.last_revision()
1703
if other_last_rev is not None:
1704
# neither branch is new, we have to do some work to
1705
# ascertain diversion.
1706
remote_graph = other.repository.get_revision_graph(
1708
local_graph = self.repository.get_revision_graph(last_rev)
1709
if (last_rev not in remote_graph and
1710
other_last_rev not in local_graph):
1711
raise errors.DivergedBranches(self, other)
1714
self.set_bound_location(other.base)
1718
"""If bound, unbind"""
1719
return self.set_bound_location(None)
1723
"""Synchronise this branch with the master branch if any.
1725
:return: None or the last_revision that was pivoted out during the
1728
master = self.get_master_branch()
1729
if master is not None:
1730
old_tip = self.last_revision()
1731
self.pull(master, overwrite=True)
1732
if old_tip in self.repository.get_ancestry(self.last_revision()):
1738
class BzrBranchExperimental(BzrBranch5):
1739
"""Bzr experimental branch format
1742
- a revision-history file.
1744
- a lock dir guarding the branch itself
1745
- all of this stored in a branch/ subdirectory
1746
- works with shared repositories.
1747
- a tag dictionary in the branch
1749
This format is new in bzr 0.15, but shouldn't be used for real data,
1752
This class acts as it's own BranchFormat.
1755
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1758
def get_format_string(cls):
1759
"""See BranchFormat.get_format_string()."""
1760
return "Bazaar-NG branch format experimental\n"
1763
def get_format_description(cls):
1764
"""See BranchFormat.get_format_description()."""
1765
return "Experimental branch format"
1768
def get_reference(cls, a_bzrdir):
1769
"""Get the target reference of the branch in a_bzrdir.
1771
format probing must have been completed before calling
1772
this method - it is assumed that the format of the branch
1773
in a_bzrdir is correct.
1775
:param a_bzrdir: The bzrdir to get the branch data from.
1776
:return: None if the branch is not a reference branch.
1781
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1783
branch_transport = a_bzrdir.get_branch_transport(cls)
1784
control_files = lockable_files.LockableFiles(branch_transport,
1785
lock_filename, lock_class)
1786
control_files.create_lock()
1787
control_files.lock_write()
1789
for filename, content in utf8_files:
1790
control_files.put_utf8(filename, content)
1792
control_files.unlock()
1795
def initialize(cls, a_bzrdir):
1796
"""Create a branch of this format in a_bzrdir."""
1797
utf8_files = [('format', cls.get_format_string()),
1798
('revision-history', ''),
1799
('branch-name', ''),
1802
cls._initialize_control_files(a_bzrdir, utf8_files,
1803
'lock', lockdir.LockDir)
1804
return cls.open(a_bzrdir, _found=True)
1807
def open(cls, a_bzrdir, _found=False):
1808
"""Return the branch object for a_bzrdir
1810
_found is a private parameter, do not use it. It is used to indicate
1811
if format probing has already be done.
1814
format = BranchFormat.find_format(a_bzrdir)
1815
assert format.__class__ == cls
1816
transport = a_bzrdir.get_branch_transport(None)
1817
control_files = lockable_files.LockableFiles(transport, 'lock',
1819
return cls(_format=cls,
1820
_control_files=control_files,
1822
_repository=a_bzrdir.find_repository())
1825
def is_supported(cls):
1828
def _make_tags(self):
1829
return BasicTags(self)
1832
def supports_tags(cls):
1836
BranchFormat.register_format(BzrBranchExperimental)
1839
class BzrBranch6(BzrBranch5):
1842
def last_revision_info(self):
1843
revision_string = self.control_files.get('last-revision').read()
1844
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1845
revision_id = cache_utf8.get_cached_utf8(revision_id)
1847
return revno, revision_id
1849
def last_revision(self):
1850
"""Return last revision id, or None"""
1851
revision_id = self.last_revision_info()[1]
1852
if revision_id == _mod_revision.NULL_REVISION:
1856
def _write_last_revision_info(self, revno, revision_id):
1857
"""Simply write out the revision id, with no checks.
1859
Use set_last_revision_info to perform this safely.
1861
Does not update the revision_history cache.
1862
Intended to be called by set_last_revision_info and
1863
_write_revision_history.
1865
if revision_id is None:
1866
revision_id = 'null:'
1867
out_string = '%d %s\n' % (revno, revision_id)
1868
self.control_files.put_bytes('last-revision', out_string)
1871
def set_last_revision_info(self, revno, revision_id):
1872
revision_id = osutils.safe_revision_id(revision_id)
1873
if self._get_append_revisions_only():
1874
self._check_history_violation(revision_id)
1875
self._write_last_revision_info(revno, revision_id)
1876
self._clear_cached_state()
1878
def _check_history_violation(self, revision_id):
1879
last_revision = self.last_revision()
1880
if last_revision is None:
1882
if last_revision not in self._lefthand_history(revision_id):
1883
raise errors.AppendRevisionsOnlyViolation(self.base)
1885
def _gen_revision_history(self):
1886
"""Generate the revision history from last revision
1888
history = list(self.repository.iter_reverse_revision_history(
1889
self.last_revision()))
1893
def _write_revision_history(self, history):
1894
"""Factored out of set_revision_history.
1896
This performs the actual writing to disk, with format-specific checks.
1897
It is intended to be called by BzrBranch5.set_revision_history.
1899
if len(history) == 0:
1900
last_revision = 'null:'
1902
if history != self._lefthand_history(history[-1]):
1903
raise errors.NotLefthandHistory(history)
1904
last_revision = history[-1]
1905
if self._get_append_revisions_only():
1906
self._check_history_violation(last_revision)
1907
self._write_last_revision_info(len(history), last_revision)
1910
def append_revision(self, *revision_ids):
1911
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1912
if len(revision_ids) == 0:
1914
prev_revno, prev_revision = self.last_revision_info()
1915
for revision in self.repository.get_revisions(revision_ids):
1916
if prev_revision == _mod_revision.NULL_REVISION:
1917
if revision.parent_ids != []:
1918
raise errors.NotLeftParentDescendant(self, prev_revision,
1919
revision.revision_id)
1921
if revision.parent_ids[0] != prev_revision:
1922
raise errors.NotLeftParentDescendant(self, prev_revision,
1923
revision.revision_id)
1924
prev_revision = revision.revision_id
1925
self.set_last_revision_info(prev_revno + len(revision_ids),
1929
def _set_parent_location(self, url):
1930
"""Set the parent branch"""
1931
self._set_config_location('parent_location', url, make_relative=True)
1934
def _get_parent_location(self):
1935
"""Set the parent branch"""
1936
return self._get_config_location('parent_location')
1938
def set_push_location(self, location):
1939
"""See Branch.set_push_location."""
1940
self._set_config_location('push_location', location)
1942
def set_bound_location(self, location):
1943
"""See Branch.set_push_location."""
1945
config = self.get_config()
1946
if location is None:
1947
if config.get_user_option('bound') != 'True':
1950
config.set_user_option('bound', 'False')
1953
self._set_config_location('bound_location', location,
1955
config.set_user_option('bound', 'True')
1958
def _get_bound_location(self, bound):
1959
"""Return the bound location in the config file.
1961
Return None if the bound parameter does not match"""
1962
config = self.get_config()
1963
config_bound = (config.get_user_option('bound') == 'True')
1964
if config_bound != bound:
1966
return self._get_config_location('bound_location', config=config)
1968
def get_bound_location(self):
1969
"""See Branch.set_push_location."""
1970
return self._get_bound_location(True)
1972
def get_old_bound_location(self):
1973
"""See Branch.get_old_bound_location"""
1974
return self._get_bound_location(False)
1976
def set_append_revisions_only(self, enabled):
1981
self.get_config().set_user_option('append_revisions_only', value)
1983
def _get_append_revisions_only(self):
1984
value = self.get_config().get_user_option('append_revisions_only')
1985
return value == 'True'
1987
def _synchronize_history(self, destination, revision_id):
1988
"""Synchronize last revision and revision history between branches.
1990
This version is most efficient when the destination is also a
1991
BzrBranch6, but works for BzrBranch5, as long as the destination's
1992
repository contains all the lefthand ancestors of the intended
1993
last_revision. If not, set_last_revision_info will fail.
1995
:param destination: The branch to copy the history into
1996
:param revision_id: The revision-id to truncate history at. May
1997
be None to copy complete history.
1999
if revision_id is None:
2000
revno, revision_id = self.last_revision_info()
2002
revno = self.revision_id_to_revno(revision_id)
2003
destination.set_last_revision_info(revno, revision_id)
2005
def _make_tags(self):
2006
return BasicTags(self)
2009
class BranchTestProviderAdapter(object):
2010
"""A tool to generate a suite testing multiple branch formats at once.
2012
This is done by copying the test once for each transport and injecting
2013
the transport_server, transport_readonly_server, and branch_format
2014
classes into each copy. Each copy is also given a new id() to make it
2018
def __init__(self, transport_server, transport_readonly_server, formats,
2019
vfs_transport_factory=None):
2020
self._transport_server = transport_server
2021
self._transport_readonly_server = transport_readonly_server
2022
self._formats = formats
2024
def adapt(self, test):
2025
result = TestSuite()
2026
for branch_format, bzrdir_format in self._formats:
2027
new_test = deepcopy(test)
2028
new_test.transport_server = self._transport_server
2029
new_test.transport_readonly_server = self._transport_readonly_server
2030
new_test.bzrdir_format = bzrdir_format
2031
new_test.branch_format = branch_format
2032
def make_new_test_id():
2033
# the format can be either a class or an instance
2034
name = getattr(branch_format, '__name__',
2035
branch_format.__class__.__name__)
2036
new_id = "%s(%s)" % (new_test.id(), name)
2037
return lambda: new_id
2038
new_test.id = make_new_test_id()
2039
result.addTest(new_test)
2043
######################################################################
2044
# results of operations
2047
class _Result(object):
2049
def _show_tag_conficts(self, to_file):
2050
if not getattr(self, 'tag_conflicts', None):
2052
to_file.write('Conflicting tags:\n')
2053
for name, value1, value2 in self.tag_conflicts:
2054
to_file.write(' %s\n' % (name, ))
2057
class PullResult(_Result):
2058
"""Result of a Branch.pull operation.
2060
:ivar old_revno: Revision number before pull.
2061
:ivar new_revno: Revision number after pull.
2062
:ivar old_revid: Tip revision id before pull.
2063
:ivar new_revid: Tip revision id after pull.
2064
:ivar source_branch: Source (local) branch object.
2065
:ivar master_branch: Master branch of the target, or None.
2066
:ivar target_branch: Target/destination branch object.
2070
# DEPRECATED: pull used to return the change in revno
2071
return self.new_revno - self.old_revno
2073
def report(self, to_file):
2074
if self.old_revid == self.new_revid:
2075
to_file.write('No revisions to pull.\n')
2077
to_file.write('Now on revision %d.\n' % self.new_revno)
2078
self._show_tag_conficts(to_file)
2081
class PushResult(_Result):
2082
"""Result of a Branch.push operation.
2084
:ivar old_revno: Revision number before push.
2085
:ivar new_revno: Revision number after push.
2086
:ivar old_revid: Tip revision id before push.
2087
:ivar new_revid: Tip revision id after push.
2088
:ivar source_branch: Source branch object.
2089
:ivar master_branch: Master branch of the target, or None.
2090
:ivar target_branch: Target/destination branch object.
2094
# DEPRECATED: push used to return the change in revno
2095
return self.new_revno - self.old_revno
2097
def report(self, to_file):
2098
"""Write a human-readable description of the result."""
2099
if self.old_revid == self.new_revid:
2100
to_file.write('No new revisions to push.\n')
2102
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2103
self._show_tag_conficts(to_file)
2106
class BranchCheckResult(object):
2107
"""Results of checking branch consistency.
2112
def __init__(self, branch):
2113
self.branch = branch
2115
def report_results(self, verbose):
2116
"""Report the check results via trace.note.
2118
:param verbose: Requests more detailed display of what was checked,
2121
note('checked branch %s format %s',
2123
self.branch._format)
2126
class Converter5to6(object):
2127
"""Perform an in-place upgrade of format 5 to format 6"""
2129
def convert(self, branch):
2130
# Data for 5 and 6 can peacefully coexist.
2131
format = BzrBranchFormat6()
2132
new_branch = format.open(branch.bzrdir, _found=True)
2134
# Copy source data into target
2135
new_branch.set_last_revision_info(*branch.last_revision_info())
2136
new_branch.set_parent(branch.get_parent())
2137
new_branch.set_bound_location(branch.get_bound_location())
2138
new_branch.set_push_location(branch.get_push_location())
2140
# New branch has no tags by default
2141
new_branch.tags._set_tag_dict({})
2143
# Copying done; now update target format
2144
new_branch.control_files.put_utf8('format',
2145
format.get_format_string())
2147
# Clean up old files
2148
new_branch.control_files._transport.delete('revision-history')
2150
branch.set_parent(None)
2153
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
