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.
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
103
self._revision_id_to_revno_cache = None
105
def break_lock(self):
106
"""Break a lock if one is present from another instance.
108
Uses the ui factory to ask for confirmation if the lock may be from
111
This will probe the repository for its lock as well.
113
self.control_files.break_lock()
114
self.repository.break_lock()
115
master = self.get_master_branch()
116
if master is not None:
120
def open(base, _unsupported=False):
121
"""Open the branch rooted at base.
123
For instance, if the branch is at URL/.bzr/branch,
124
Branch.open(URL) -> a Branch instance.
126
control = bzrdir.BzrDir.open(base, _unsupported)
127
return control.open_branch(_unsupported)
130
def open_from_transport(transport, _unsupported=False):
131
"""Open the branch rooted at transport"""
132
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
133
return control.open_branch(_unsupported)
136
def open_containing(url, possible_transports=None):
137
"""Open an existing branch which contains url.
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.
139
This probes for a branch at url, and searches upwards from there.
141
Basically we keep looking up until we find the control directory or
142
run into the root. If there isn't one, raises NotBranchError.
143
If there is one and it is either an unrecognised format or an unsupported
144
format, UnknownFormatError or UnsupportedFormatError are raised.
145
If there is one, it is returned, along with the unused portion of url.
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)
147
control, relpath = bzrdir.BzrDir.open_containing(url,
149
return control.open_branch(), relpath
151
def get_config(self):
152
return BranchConfig(self)
155
return self.get_config().get_nickname()
157
def _set_nick(self, nick):
158
self.get_config().set_user_option('nickname', nick, warn_masked=True)
160
nick = property(_get_nick, _set_nick)
163
raise NotImplementedError(self.is_locked)
212
165
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'
166
raise NotImplementedError(self.lock_write)
228
168
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'
169
raise NotImplementedError(self.lock_read)
242
171
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
172
raise NotImplementedError(self.unlock)
174
def peek_lock_mode(self):
175
"""Return lock mode for the Branch: 'r', 'w' or None"""
176
raise NotImplementedError(self.peek_lock_mode)
178
def get_physical_lock_status(self):
179
raise NotImplementedError(self.get_physical_lock_status)
182
def get_revision_id_to_revno_map(self):
183
"""Return the revision_id => dotted revno map.
185
This will be regenerated on demand, but will be cached.
187
:return: A dictionary mapping revision_id => dotted revno.
188
This dictionary should not be modified by the caller.
190
if self._revision_id_to_revno_cache is not None:
191
mapping = self._revision_id_to_revno_cache
252
self._lock_mode = self._lock_count = None
193
mapping = self._gen_revno_map()
194
self._cache_revision_id_to_revno(mapping)
195
# TODO: jam 20070417 Since this is being cached, should we be returning
197
# I would rather not, and instead just declare that users should not
198
# modify the return value.
201
def _gen_revno_map(self):
202
"""Create a new mapping from revision ids to dotted revnos.
204
Dotted revnos are generated based on the current tip in the revision
206
This is the worker function for get_revision_id_to_revno_map, which
207
just caches the return value.
209
:return: A dictionary mapping revision_id => dotted revno.
211
last_revision = self.last_revision()
212
revision_graph = self.repository.get_revision_graph(last_revision)
213
merge_sorted_revisions = tsort.merge_sort(
218
revision_id_to_revno = dict((rev_id, revno)
219
for seq_num, rev_id, depth, revno, end_of_merge
220
in merge_sorted_revisions)
221
return revision_id_to_revno
223
def leave_lock_in_place(self):
224
"""Tell this branch object not to release the physical lock when this
227
If lock_write doesn't return a token, then this method is not supported.
229
self.control_files.leave_in_place()
231
def dont_leave_lock_in_place(self):
232
"""Tell this branch object to release the physical lock when this
233
object is unlocked, even if it didn't originally acquire it.
235
If lock_write doesn't return a token, then this method is not supported.
237
self.control_files.dont_leave_in_place()
255
239
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
240
"""Return absolute filename for something in the branch
242
XXX: Robert Collins 20051017 what is this used for? why is it a branch
243
method and not a tree method.
245
raise NotImplementedError(self.abspath)
247
def bind(self, other):
248
"""Bind the local branch the other branch.
250
:param other: The branch to bind to
253
raise errors.UpgradeRequired(self.base)
256
def fetch(self, from_branch, last_revision=None, pb=None):
257
"""Copy revisions from from_branch into this branch.
259
:param from_branch: Where to copy from.
260
:param last_revision: What revision to stop at (None for at the end
262
:param pb: An optional progress bar to use.
264
Returns the copied revision count and the failed revisions in a tuple:
267
if self.base == from_branch.base:
270
nested_pb = ui.ui_factory.nested_progress_bar()
275
from_branch.lock_read()
277
if last_revision is None:
278
pb.update('get source history')
279
last_revision = from_branch.last_revision()
280
if last_revision is None:
281
last_revision = _mod_revision.NULL_REVISION
282
return self.repository.fetch(from_branch.repository,
283
revision_id=last_revision,
286
if nested_pb is not None:
290
def get_bound_location(self):
291
"""Return the URL of the branch we are bound to.
293
Older format branches cannot bind, please be sure to use a metadir
298
def get_old_bound_location(self):
299
"""Return the URL of the branch we used to be bound to
301
raise errors.UpgradeRequired(self.base)
303
def get_commit_builder(self, parents, config=None, timestamp=None,
304
timezone=None, committer=None, revprops=None,
306
"""Obtain a CommitBuilder for this branch.
308
:param parents: Revision ids of the parents of the new revision.
309
:param config: Optional configuration to use.
310
:param timestamp: Optional timestamp recorded for commit.
311
:param timezone: Optional timezone for timestamp.
312
:param committer: Optional committer to set for commit.
313
:param revprops: Optional dictionary of revision properties.
314
:param revision_id: Optional revision id.
318
config = self.get_config()
320
return self.repository.get_commit_builder(self, parents, config,
321
timestamp, timezone, committer, revprops, revision_id)
323
def get_master_branch(self):
324
"""Return the branch we are bound to.
326
:return: Either a Branch, or None
617
330
def get_revision_delta(self, revno):
618
331
"""Return the delta for one revision.
794
469
if stop_revision is None:
795
470
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
472
assert isinstance(stop_revision, int)
473
if stop_revision > other_len:
474
raise errors.NoSuchRevision(self, stop_revision)
799
475
return other_history[self_len:stop_revision]
802
477
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())
478
"""Pull in new perfect-fit revisions.
480
:param other: Another Branch to pull from
481
:param stop_revision: Updated until the given revision
484
raise NotImplementedError(self.update_revisions)
486
def revision_id_to_revno(self, revision_id):
487
"""Given a revision id, return its revno"""
488
if _mod_revision.is_null(revision_id):
490
revision_id = osutils.safe_revision_id(revision_id)
491
history = self.revision_history()
493
return history.index(revision_id) + 1
495
raise errors.NoSuchRevision(self, revision_id)
497
def get_rev_id(self, revno, history=None):
498
"""Find the revision id of the specified revno."""
500
return _mod_revision.NULL_REVISION
502
history = self.revision_history()
503
if revno <= 0 or revno > len(history):
504
raise errors.NoSuchRevision(self, revno)
505
return history[revno - 1]
507
def pull(self, source, overwrite=False, stop_revision=None):
508
"""Mirror source into this branch.
510
This branch is considered to be 'local', having low latency.
512
:returns: PullResult instance
514
raise NotImplementedError(self.pull)
516
def push(self, target, overwrite=False, stop_revision=None):
517
"""Mirror this branch into target.
519
This branch is considered to be 'local', having low latency.
521
raise NotImplementedError(self.push)
1053
523
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))
524
"""Return `Tree` object for last revision."""
525
return self.repository.revision_tree(self.last_revision())
1066
527
def rename_one(self, from_rel, to_rel):
1067
528
"""Rename one file.
1069
530
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)
532
raise NotImplementedError(self.rename_one)
1117
534
def move(self, from_paths, to_name):
1118
535
"""Rename files.
1125
542
Note that to_name is only the last component of the new name;
1126
543
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:
545
This returns a list of (from_path, to_path) pairs for each
548
raise NotImplementedError(self.move)
550
def get_parent(self):
551
"""Return the parent location of the branch.
553
This is the default location for push/pull/missing. The usual
554
pattern is that the user can override it by specifying a
557
raise NotImplementedError(self.get_parent)
559
def _set_config_location(self, name, url, config=None,
560
make_relative=False):
562
config = self.get_config()
566
url = urlutils.relative_url(self.base, url)
567
config.set_user_option(name, url, warn_masked=True)
569
def _get_config_location(self, name, config=None):
571
config = self.get_config()
572
location = config.get_user_option(name)
577
def get_submit_branch(self):
578
"""Return the submit location of the branch.
580
This is the default location for bundle. The usual
581
pattern is that the user can override it by specifying a
584
return self.get_config().get_user_option('submit_branch')
586
def set_submit_branch(self, location):
587
"""Return the submit location of the branch.
589
This is the default location for bundle. The usual
590
pattern is that the user can override it by specifying a
593
self.get_config().set_user_option('submit_branch', location,
596
def get_public_branch(self):
597
"""Return the public location of the branch.
599
This is is used by merge directives.
601
return self._get_config_location('public_branch')
603
def set_public_branch(self, location):
604
"""Return the submit location of the branch.
606
This is the default location for bundle. The usual
607
pattern is that the user can override it by specifying a
610
self._set_config_location('public_branch', location)
612
def get_push_location(self):
613
"""Return the None or the location to push this branch to."""
614
push_loc = self.get_config().get_user_option('push_location')
617
def set_push_location(self, location):
618
"""Set a new push location for this branch."""
619
raise NotImplementedError(self.set_push_location)
621
def set_parent(self, url):
622
raise NotImplementedError(self.set_parent)
626
"""Synchronise this branch with the master branch if any.
628
:return: None or the last_revision pivoted out during the update.
632
def check_revno(self, revno):
634
Check whether a revno corresponds to any revision.
635
Zero (the NULL revision) is considered valid.
638
self.check_real_revno(revno)
640
def check_real_revno(self, revno):
642
Check whether a revno corresponds to a real revision.
643
Zero (the NULL revision) is considered invalid
645
if revno < 1 or revno > self.revno():
646
raise InvalidRevisionNumber(revno)
649
def clone(self, to_bzrdir, revision_id=None):
650
"""Clone this branch into to_bzrdir preserving all semantic values.
652
revision_id: if not None, the revision history in the new branch will
653
be truncated to end with revision_id.
655
result = self._format.initialize(to_bzrdir)
656
self.copy_content_into(result, revision_id=revision_id)
660
def sprout(self, to_bzrdir, revision_id=None):
661
"""Create a new line of development from the branch, into to_bzrdir.
663
revision_id: if not None, the revision history in the new branch will
664
be truncated to end with revision_id.
666
result = self._format.initialize(to_bzrdir)
667
self.copy_content_into(result, revision_id=revision_id)
668
result.set_parent(self.bzrdir.root_transport.base)
671
def _synchronize_history(self, destination, revision_id):
672
"""Synchronize last revision and revision history between branches.
674
This version is most efficient when the destination is also a
675
BzrBranch5, but works for BzrBranch6 as long as the revision
676
history is the true lefthand parent history, and all of the revisions
677
are in the destination's repository. If not, set_revision_history
680
:param destination: The branch to copy the history into
681
:param revision_id: The revision-id to truncate history at. May
682
be None to copy complete history.
684
if revision_id == _mod_revision.NULL_REVISION:
686
new_history = self.revision_history()
687
if revision_id is not None and new_history != []:
688
revision_id = osutils.safe_revision_id(revision_id)
690
new_history = new_history[:new_history.index(revision_id) + 1]
692
rev = self.repository.get_revision(revision_id)
693
new_history = rev.get_history(self.repository)[1:]
694
destination.set_revision_history(new_history)
697
def copy_content_into(self, destination, revision_id=None):
698
"""Copy the content of self into destination.
700
revision_id: if not None, the revision history in the new branch will
701
be truncated to end with revision_id.
703
self._synchronize_history(destination, revision_id)
705
parent = self.get_parent()
706
except errors.InaccessibleParent, e:
707
mutter('parent was not accessible to copy: %s', e)
710
destination.set_parent(parent)
711
self.tags.merge_to(destination.tags)
715
"""Check consistency of the branch.
717
In particular this checks that revisions given in the revision-history
718
do actually match up in the revision graph, and that they're all
719
present in the repository.
721
Callers will typically also want to check the repository.
723
:return: A BranchCheckResult.
725
mainline_parent_id = None
726
for revision_id in self.revision_history():
728
revision = self.repository.get_revision(revision_id)
729
except errors.NoSuchRevision, e:
730
raise errors.BzrCheckError("mainline revision {%s} not in repository"
732
# In general the first entry on the revision history has no parents.
733
# But it's not illegal for it to have parents listed; this can happen
734
# in imports from Arch when the parents weren't reachable.
735
if mainline_parent_id is not None:
736
if mainline_parent_id not in revision.parent_ids:
737
raise errors.BzrCheckError("previous revision {%s} not listed among "
739
% (mainline_parent_id, revision_id))
740
mainline_parent_id = revision_id
741
return BranchCheckResult(self)
743
def _get_checkout_format(self):
744
"""Return the most suitable metadir for a checkout of this branch.
745
Weaves are used if this branch's repository uses weaves.
747
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
748
from bzrlib.repofmt import weaverepo
749
format = bzrdir.BzrDirMetaFormat1()
750
format.repository_format = weaverepo.RepositoryFormat7()
752
format = self.repository.bzrdir.checkout_metadir()
753
format.set_branch_format(self._format)
756
def create_checkout(self, to_location, revision_id=None,
758
"""Create a checkout of a branch.
760
:param to_location: The url to produce the checkout at
761
:param revision_id: The revision to check out
762
:param lightweight: If True, produce a lightweight checkout, otherwise,
763
produce a bound branch (heavyweight checkout)
764
:return: The tree of the created checkout
766
t = transport.get_transport(to_location)
769
format = self._get_checkout_format()
770
checkout = format.initialize_on_transport(t)
771
BranchReferenceFormat().initialize(checkout, self)
773
format = self._get_checkout_format()
774
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
775
to_location, force_new_tree=False, format=format)
776
checkout = checkout_branch.bzrdir
777
checkout_branch.bind(self)
778
# pull up to the specified revision_id to set the initial
779
# branch tip correctly, and seed it with history.
780
checkout_branch.pull(self, stop_revision=revision_id)
781
tree = checkout.create_workingtree(revision_id)
782
basis_tree = tree.basis_tree()
783
basis_tree.lock_read()
785
for path, file_id in basis_tree.iter_references():
786
reference_parent = self.reference_parent(file_id, path)
787
reference_parent.create_checkout(tree.abspath(path),
788
basis_tree.get_reference_revision(file_id, path),
794
def reference_parent(self, file_id, path):
795
"""Return the parent branch for a tree-reference file_id
796
:param file_id: The file_id of the tree reference
797
:param path: The path of the file_id in the tree
798
:return: A branch associated with the file_id
800
# FIXME should provide multiple branches, based on config
801
return Branch.open(self.bzrdir.root_transport.clone(path).base)
803
def supports_tags(self):
804
return self._format.supports_tags()
807
class BranchFormat(object):
808
"""An encapsulation of the initialization and open routines for a format.
810
Formats provide three things:
811
* An initialization routine,
815
Formats are placed in an dict by their format string for reference
816
during branch opening. Its not required that these be instances, they
817
can be classes themselves with class methods - it simply depends on
818
whether state is needed for a given format or not.
820
Once a format is deprecated, just deprecate the initialize and open
821
methods on the format class. Do not deprecate the object, as the
822
object will be created every time regardless.
825
_default_format = None
826
"""The default format used for new branches."""
829
"""The known formats."""
831
def __eq__(self, other):
832
return self.__class__ is other.__class__
834
def __ne__(self, other):
835
return not (self == other)
838
def find_format(klass, a_bzrdir):
839
"""Return the format for the branch object in a_bzrdir."""
841
transport = a_bzrdir.get_branch_transport(None)
842
format_string = transport.get("format").read()
843
return klass._formats[format_string]
845
raise NotBranchError(path=transport.base)
847
raise errors.UnknownFormatError(format=format_string)
850
def get_default_format(klass):
851
"""Return the current default format."""
852
return klass._default_format
854
def get_reference(self, a_bzrdir):
855
"""Get the target reference of the branch in a_bzrdir.
857
format probing must have been completed before calling
858
this method - it is assumed that the format of the branch
859
in a_bzrdir is correct.
861
:param a_bzrdir: The bzrdir to get the branch data from.
862
:return: None if the branch is not a reference branch.
866
def get_format_string(self):
867
"""Return the ASCII format string that identifies this format."""
868
raise NotImplementedError(self.get_format_string)
870
def get_format_description(self):
871
"""Return the short format description for this format."""
872
raise NotImplementedError(self.get_format_description)
874
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
876
"""Initialize a branch in a bzrdir, with specified files
878
:param a_bzrdir: The bzrdir to initialize the branch in
879
:param utf8_files: The files to create as a list of
880
(filename, content) tuples
881
:param set_format: If True, set the format with
882
self.get_format_string. (BzrBranch4 has its format set
884
:return: a branch in this format
886
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
887
branch_transport = a_bzrdir.get_branch_transport(self)
889
'metadir': ('lock', lockdir.LockDir),
890
'branch4': ('branch-lock', lockable_files.TransportLock),
892
lock_name, lock_class = lock_map[lock_type]
893
control_files = lockable_files.LockableFiles(branch_transport,
894
lock_name, lock_class)
895
control_files.create_lock()
896
control_files.lock_write()
898
control_files.put_utf8('format', self.get_format_string())
900
for file, content in utf8_files:
901
control_files.put_utf8(file, content)
903
control_files.unlock()
904
return self.open(a_bzrdir, _found=True)
906
def initialize(self, a_bzrdir):
907
"""Create a branch of this format in a_bzrdir."""
908
raise NotImplementedError(self.initialize)
910
def is_supported(self):
911
"""Is this format supported?
913
Supported formats can be initialized and opened.
914
Unsupported formats may not support initialization or committing or
915
some other features depending on the reason for not being supported.
919
def open(self, a_bzrdir, _found=False):
920
"""Return the branch object for a_bzrdir
922
_found is a private parameter, do not use it. It is used to indicate
923
if format probing has already be done.
925
raise NotImplementedError(self.open)
928
def register_format(klass, format):
929
klass._formats[format.get_format_string()] = format
932
def set_default_format(klass, format):
933
klass._default_format = format
936
def unregister_format(klass, format):
937
assert klass._formats[format.get_format_string()] is format
938
del klass._formats[format.get_format_string()]
941
return self.get_format_string().rstrip()
943
def supports_tags(self):
944
"""True if this format supports tags stored in the branch"""
945
return False # by default
947
# XXX: Probably doesn't really belong here -- mbp 20070212
948
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
950
branch_transport = a_bzrdir.get_branch_transport(self)
951
control_files = lockable_files.LockableFiles(branch_transport,
952
lock_filename, lock_class)
953
control_files.create_lock()
954
control_files.lock_write()
956
for filename, content in utf8_files:
957
control_files.put_utf8(filename, content)
959
control_files.unlock()
962
class BranchHooks(Hooks):
963
"""A dictionary mapping hook name to a list of callables for branch hooks.
965
e.g. ['set_rh'] Is the list of items to be called when the
966
set_revision_history function is invoked.
970
"""Create the default hooks.
972
These are all empty initially, because by default nothing should get
976
# Introduced in 0.15:
977
# invoked whenever the revision history has been set
978
# with set_revision_history. The api signature is
979
# (branch, revision_history), and the branch will
982
# invoked after a push operation completes.
983
# the api signature is
985
# containing the members
986
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
987
# where local is the local target branch or None, master is the target
988
# master branch, and the rest should be self explanatory. The source
989
# is read locked and the target branches write locked. Source will
990
# be the local low-latency branch.
991
self['post_push'] = []
992
# invoked after a pull operation completes.
993
# the api signature is
995
# containing the members
996
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
997
# where local is the local branch or None, master is the target
998
# master branch, and the rest should be self explanatory. The source
999
# is read locked and the target branches write locked. The local
1000
# branch is the low-latency branch.
1001
self['post_pull'] = []
1002
# invoked before a commit operation takes place.
1003
# the api signature is
1004
# (local, master, old_revno, old_revid, future_revno, future_revid,
1005
# tree_delta, future_tree).
1006
# old_revid is NULL_REVISION for the first commit to a branch
1007
# tree_delta is a TreeDelta object describing changes from the basis
1008
# revision, hooks MUST NOT modify this delta
1009
# future_tree is an in-memory tree obtained from
1010
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1011
self['pre_commit'] = []
1012
# invoked after a commit operation completes.
1013
# the api signature is
1014
# (local, master, old_revno, old_revid, new_revno, new_revid)
1015
# old_revid is NULL_REVISION for the first commit to a branch.
1016
self['post_commit'] = []
1017
# invoked after a uncommit operation completes.
1018
# the api signature is
1019
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1020
# local is the local branch or None, master is the target branch,
1021
# and an empty branch recieves new_revno of 0, new_revid of None.
1022
self['post_uncommit'] = []
1025
# install the default hooks into the Branch class.
1026
Branch.hooks = BranchHooks()
1029
class BzrBranchFormat4(BranchFormat):
1030
"""Bzr branch format 4.
1033
- a revision-history file.
1034
- a branch-lock lock file [ to be shared with the bzrdir ]
1037
def get_format_description(self):
1038
"""See BranchFormat.get_format_description()."""
1039
return "Branch format 4"
1041
def initialize(self, a_bzrdir):
1042
"""Create a branch of this format in a_bzrdir."""
1043
utf8_files = [('revision-history', ''),
1044
('branch-name', ''),
1046
return self._initialize_helper(a_bzrdir, utf8_files,
1047
lock_type='branch4', set_format=False)
1050
super(BzrBranchFormat4, self).__init__()
1051
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1053
def open(self, a_bzrdir, _found=False):
1054
"""Return the branch object for a_bzrdir
1056
_found is a private parameter, do not use it. It is used to indicate
1057
if format probing has already be done.
1060
# we are being called directly and must probe.
1061
raise NotImplementedError
1062
return BzrBranch(_format=self,
1063
_control_files=a_bzrdir._control_files,
1065
_repository=a_bzrdir.open_repository())
1068
return "Bazaar-NG branch format 4"
1071
class BzrBranchFormat5(BranchFormat):
1072
"""Bzr branch format 5.
1075
- a revision-history file.
1077
- a lock dir guarding the branch itself
1078
- all of this stored in a branch/ subdirectory
1079
- works with shared repositories.
1081
This format is new in bzr 0.8.
1084
def get_format_string(self):
1085
"""See BranchFormat.get_format_string()."""
1086
return "Bazaar-NG branch format 5\n"
1088
def get_format_description(self):
1089
"""See BranchFormat.get_format_description()."""
1090
return "Branch format 5"
1092
def initialize(self, a_bzrdir):
1093
"""Create a branch of this format in a_bzrdir."""
1094
utf8_files = [('revision-history', ''),
1095
('branch-name', ''),
1097
return self._initialize_helper(a_bzrdir, utf8_files)
1100
super(BzrBranchFormat5, self).__init__()
1101
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1103
def open(self, a_bzrdir, _found=False):
1104
"""Return the branch object for a_bzrdir
1106
_found is a private parameter, do not use it. It is used to indicate
1107
if format probing has already be done.
1110
format = BranchFormat.find_format(a_bzrdir)
1111
assert format.__class__ == self.__class__
1113
transport = a_bzrdir.get_branch_transport(None)
1114
control_files = lockable_files.LockableFiles(transport, 'lock',
1116
return BzrBranch5(_format=self,
1117
_control_files=control_files,
1119
_repository=a_bzrdir.find_repository())
1121
raise NotBranchError(path=transport.base)
1124
class BzrBranchFormat6(BzrBranchFormat5):
1125
"""Branch format with last-revision and tags.
1127
Unlike previous formats, this has no explicit revision history. Instead,
1128
this just stores the last-revision, and the left-hand history leading
1129
up to there is the history.
1131
This format was introduced in bzr 0.15
1132
and became the default in 0.91.
1135
def get_format_string(self):
1136
"""See BranchFormat.get_format_string()."""
1137
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1139
def get_format_description(self):
1140
"""See BranchFormat.get_format_description()."""
1141
return "Branch format 6"
1143
def initialize(self, a_bzrdir):
1144
"""Create a branch of this format in a_bzrdir."""
1145
utf8_files = [('last-revision', '0 null:\n'),
1146
('branch-name', ''),
1147
('branch.conf', ''),
1150
return self._initialize_helper(a_bzrdir, utf8_files)
1152
def open(self, a_bzrdir, _found=False):
1153
"""Return the branch object for a_bzrdir
1155
_found is a private parameter, do not use it. It is used to indicate
1156
if format probing has already be done.
1159
format = BranchFormat.find_format(a_bzrdir)
1160
assert format.__class__ == self.__class__
1161
transport = a_bzrdir.get_branch_transport(None)
1162
control_files = lockable_files.LockableFiles(transport, 'lock',
1164
return BzrBranch6(_format=self,
1165
_control_files=control_files,
1167
_repository=a_bzrdir.find_repository())
1169
def supports_tags(self):
1173
class BranchReferenceFormat(BranchFormat):
1174
"""Bzr branch reference format.
1176
Branch references are used in implementing checkouts, they
1177
act as an alias to the real branch which is at some other url.
1184
def get_format_string(self):
1185
"""See BranchFormat.get_format_string()."""
1186
return "Bazaar-NG Branch Reference Format 1\n"
1188
def get_format_description(self):
1189
"""See BranchFormat.get_format_description()."""
1190
return "Checkout reference format 1"
1192
def get_reference(self, a_bzrdir):
1193
"""See BranchFormat.get_reference()."""
1194
transport = a_bzrdir.get_branch_transport(None)
1195
return transport.get('location').read()
1197
def initialize(self, a_bzrdir, target_branch=None):
1198
"""Create a branch of this format in a_bzrdir."""
1199
if target_branch is None:
1200
# this format does not implement branch itself, thus the implicit
1201
# creation contract must see it as uninitializable
1202
raise errors.UninitializableFormat(self)
1203
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1204
branch_transport = a_bzrdir.get_branch_transport(self)
1205
branch_transport.put_bytes('location',
1206
target_branch.bzrdir.root_transport.base)
1207
branch_transport.put_bytes('format', self.get_format_string())
1208
return self.open(a_bzrdir, _found=True)
1211
super(BranchReferenceFormat, self).__init__()
1212
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1214
def _make_reference_clone_function(format, a_branch):
1215
"""Create a clone() routine for a branch dynamically."""
1216
def clone(to_bzrdir, revision_id=None):
1217
"""See Branch.clone()."""
1218
return format.initialize(to_bzrdir, a_branch)
1219
# cannot obey revision_id limits when cloning a reference ...
1220
# FIXME RBC 20060210 either nuke revision_id for clone, or
1221
# emit some sort of warning/error to the caller ?!
1224
def open(self, a_bzrdir, _found=False, location=None):
1225
"""Return the branch that the branch reference in a_bzrdir points at.
1227
_found is a private parameter, do not use it. It is used to indicate
1228
if format probing has already be done.
1231
format = BranchFormat.find_format(a_bzrdir)
1232
assert format.__class__ == self.__class__
1233
if location is None:
1234
location = self.get_reference(a_bzrdir)
1235
real_bzrdir = bzrdir.BzrDir.open(location)
1236
result = real_bzrdir.open_branch()
1237
# this changes the behaviour of result.clone to create a new reference
1238
# rather than a copy of the content of the branch.
1239
# I did not use a proxy object because that needs much more extensive
1240
# testing, and we are only changing one behaviour at the moment.
1241
# If we decide to alter more behaviours - i.e. the implicit nickname
1242
# then this should be refactored to introduce a tested proxy branch
1243
# and a subclass of that for use in overriding clone() and ....
1245
result.clone = self._make_reference_clone_function(result)
1249
# formats which have no format string are not discoverable
1250
# and not independently creatable, so are not registered.
1251
__format5 = BzrBranchFormat5()
1252
__format6 = BzrBranchFormat6()
1253
BranchFormat.register_format(__format5)
1254
BranchFormat.register_format(BranchReferenceFormat())
1255
BranchFormat.register_format(__format6)
1256
BranchFormat.set_default_format(__format6)
1257
_legacy_formats = [BzrBranchFormat4(),
1260
class BzrBranch(Branch):
1261
"""A branch stored in the actual filesystem.
1263
Note that it's "local" in the context of the filesystem; it doesn't
1264
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1265
it's writable, and can be accessed via the normal filesystem API.
1268
def __init__(self, _format=None,
1269
_control_files=None, a_bzrdir=None, _repository=None):
1270
"""Create new branch object at a particular location."""
1271
Branch.__init__(self)
1272
if a_bzrdir is None:
1273
raise ValueError('a_bzrdir must be supplied')
1275
self.bzrdir = a_bzrdir
1276
# self._transport used to point to the directory containing the
1277
# control directory, but was not used - now it's just the transport
1278
# for the branch control files. mbp 20070212
1279
self._base = self.bzrdir.transport.clone('..').base
1280
self._format = _format
1281
if _control_files is None:
1282
raise ValueError('BzrBranch _control_files is None')
1283
self.control_files = _control_files
1284
self._transport = _control_files._transport
1285
self.repository = _repository
1288
return '%s(%r)' % (self.__class__.__name__, self.base)
1292
def _get_base(self):
1293
"""Returns the directory containing the control directory."""
1296
base = property(_get_base, doc="The URL for the root of this branch.")
1298
def abspath(self, name):
1299
"""See Branch.abspath."""
1300
return self.control_files._transport.abspath(name)
1303
@deprecated_method(zero_sixteen)
1305
def get_root_id(self):
1306
"""See Branch.get_root_id."""
1307
tree = self.repository.revision_tree(self.last_revision())
1308
return tree.inventory.root.file_id
1310
def is_locked(self):
1311
return self.control_files.is_locked()
1313
def lock_write(self, token=None):
1314
repo_token = self.repository.lock_write()
1316
token = self.control_files.lock_write(token=token)
1318
self.repository.unlock()
1322
def lock_read(self):
1323
self.repository.lock_read()
1325
self.control_files.lock_read()
1327
self.repository.unlock()
1331
# TODO: test for failed two phase locks. This is known broken.
1333
self.control_files.unlock()
1335
self.repository.unlock()
1336
if not self.control_files.is_locked():
1337
# we just released the lock
1338
self._clear_cached_state()
1340
def peek_lock_mode(self):
1341
if self.control_files._lock_count == 0:
1344
return self.control_files._lock_mode
1346
def get_physical_lock_status(self):
1347
return self.control_files.get_physical_lock_status()
1350
def print_file(self, file, revision_id):
1351
"""See Branch.print_file."""
1352
return self.repository.print_file(file, revision_id)
1354
def _write_revision_history(self, history):
1355
"""Factored out of set_revision_history.
1357
This performs the actual writing to disk.
1358
It is intended to be called by BzrBranch5.set_revision_history."""
1359
self.control_files.put_bytes(
1360
'revision-history', '\n'.join(history))
1363
def set_revision_history(self, rev_history):
1364
"""See Branch.set_revision_history."""
1365
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1366
self._clear_cached_state()
1367
self._write_revision_history(rev_history)
1368
self._cache_revision_history(rev_history)
1369
for hook in Branch.hooks['set_rh']:
1370
hook(self, rev_history)
1373
def set_last_revision_info(self, revno, revision_id):
1374
"""Set the last revision of this branch.
1376
The caller is responsible for checking that the revno is correct
1377
for this revision id.
1379
It may be possible to set the branch last revision to an id not
1380
present in the repository. However, branches can also be
1381
configured to check constraints on history, in which case this may not
1384
revision_id = osutils.safe_revision_id(revision_id)
1385
history = self._lefthand_history(revision_id)
1386
assert len(history) == revno, '%d != %d' % (len(history), revno)
1387
self.set_revision_history(history)
1389
def _gen_revision_history(self):
1390
history = self.control_files.get('revision-history').read().split('\n')
1391
if history[-1:] == ['']:
1392
# There shouldn't be a trailing newline, but just in case.
1396
def _lefthand_history(self, revision_id, last_rev=None,
1398
# stop_revision must be a descendant of last_revision
1399
stop_graph = self.repository.get_revision_graph(revision_id)
1400
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1401
and last_rev not in stop_graph):
1402
# our previous tip is not merged into stop_revision
1403
raise errors.DivergedBranches(self, other_branch)
1404
# make a new revision history from the graph
1405
current_rev_id = revision_id
1407
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1408
new_history.append(current_rev_id)
1409
current_rev_id_parents = stop_graph[current_rev_id]
1411
current_rev_id = current_rev_id_parents[0]
1413
current_rev_id = None
1414
new_history.reverse()
1418
def generate_revision_history(self, revision_id, last_rev=None,
1420
"""Create a new revision history that will finish with revision_id.
1422
:param revision_id: the new tip to use.
1423
:param last_rev: The previous last_revision. If not None, then this
1424
must be a ancestory of revision_id, or DivergedBranches is raised.
1425
:param other_branch: The other branch that DivergedBranches should
1426
raise with respect to.
1428
revision_id = osutils.safe_revision_id(revision_id)
1429
self.set_revision_history(self._lefthand_history(revision_id,
1430
last_rev, other_branch))
1433
def update_revisions(self, other, stop_revision=None):
1434
"""See Branch.update_revisions."""
1437
if stop_revision is None:
1438
stop_revision = other.last_revision()
1439
if stop_revision is None:
1440
# if there are no commits, we're done.
1443
stop_revision = osutils.safe_revision_id(stop_revision)
1444
# whats the current last revision, before we fetch [and change it
1446
last_rev = _mod_revision.ensure_null(self.last_revision())
1447
# we fetch here regardless of whether we need to so that we pickup
1449
self.fetch(other, stop_revision)
1450
if self.repository.get_graph().is_ancestor(stop_revision,
1453
self.generate_revision_history(stop_revision, last_rev=last_rev,
1458
def basis_tree(self):
1459
"""See Branch.basis_tree."""
1460
return self.repository.revision_tree(self.last_revision())
1463
def pull(self, source, overwrite=False, stop_revision=None,
1464
_hook_master=None, run_hooks=True):
1467
:param _hook_master: Private parameter - set the branch to
1468
be supplied as the master to push hooks.
1469
:param run_hooks: Private parameter - if false, this branch
1470
is being called because it's the master of the primary branch,
1471
so it should not run its hooks.
1473
result = PullResult()
1474
result.source_branch = source
1475
result.target_branch = self
1478
result.old_revno, result.old_revid = self.last_revision_info()
1480
self.update_revisions(source, stop_revision)
1481
except DivergedBranches:
1485
if stop_revision is None:
1486
stop_revision = source.last_revision()
1487
self.generate_revision_history(stop_revision)
1488
result.tag_conflicts = source.tags.merge_to(self.tags)
1489
result.new_revno, result.new_revid = self.last_revision_info()
1491
result.master_branch = _hook_master
1492
result.local_branch = self
1494
result.master_branch = self
1495
result.local_branch = None
1497
for hook in Branch.hooks['post_pull']:
1503
def _get_parent_location(self):
1504
_locs = ['parent', 'pull', 'x-pull']
1507
return self.control_files.get(l).read().strip('\n')
1513
def push(self, target, overwrite=False, stop_revision=None,
1514
_override_hook_source_branch=None):
1517
This is the basic concrete implementation of push()
1519
:param _override_hook_source_branch: If specified, run
1520
the hooks passing this Branch as the source, rather than self.
1521
This is for use of RemoteBranch, where push is delegated to the
1522
underlying vfs-based Branch.
1524
# TODO: Public option to disable running hooks - should be trivial but
1528
result = self._push_with_bound_branches(target, overwrite,
1530
_override_hook_source_branch=_override_hook_source_branch)
1535
def _push_with_bound_branches(self, target, overwrite,
1537
_override_hook_source_branch=None):
1538
"""Push from self into target, and into target's master if any.
1540
This is on the base BzrBranch class even though it doesn't support
1541
bound branches because the *target* might be bound.
1544
if _override_hook_source_branch:
1545
result.source_branch = _override_hook_source_branch
1546
for hook in Branch.hooks['post_push']:
1549
bound_location = target.get_bound_location()
1550
if bound_location and target.base != bound_location:
1551
# there is a master branch.
1553
# XXX: Why the second check? Is it even supported for a branch to
1554
# be bound to itself? -- mbp 20070507
1555
master_branch = target.get_master_branch()
1556
master_branch.lock_write()
1558
# push into the master from this branch.
1559
self._basic_push(master_branch, overwrite, stop_revision)
1560
# and push into the target branch from this. Note that we push from
1561
# this branch again, because its considered the highest bandwidth
1563
result = self._basic_push(target, overwrite, stop_revision)
1564
result.master_branch = master_branch
1565
result.local_branch = target
1569
master_branch.unlock()
1572
result = self._basic_push(target, overwrite, stop_revision)
1573
# TODO: Why set master_branch and local_branch if there's no
1574
# binding? Maybe cleaner to just leave them unset? -- mbp
1576
result.master_branch = target
1577
result.local_branch = None
1581
def _basic_push(self, target, overwrite, stop_revision):
1582
"""Basic implementation of push without bound branches or hooks.
1584
Must be called with self read locked and target write locked.
1586
result = PushResult()
1587
result.source_branch = self
1588
result.target_branch = target
1589
result.old_revno, result.old_revid = target.last_revision_info()
1591
target.update_revisions(self, stop_revision)
1592
except DivergedBranches:
1596
target.set_revision_history(self.revision_history())
1597
result.tag_conflicts = self.tags.merge_to(target.tags)
1598
result.new_revno, result.new_revid = target.last_revision_info()
1601
def get_parent(self):
1602
"""See Branch.get_parent."""
1604
assert self.base[-1] == '/'
1605
parent = self._get_parent_location()
1608
# This is an old-format absolute path to a local branch
1609
# turn it into a url
1610
if parent.startswith('/'):
1611
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1613
return urlutils.join(self.base[:-1], parent)
1614
except errors.InvalidURLJoin, e:
1615
raise errors.InaccessibleParent(parent, self.base)
1617
def set_push_location(self, location):
1618
"""See Branch.set_push_location."""
1619
self.get_config().set_user_option(
1620
'push_location', location,
1621
store=_mod_config.STORE_LOCATION_NORECURSE)
1624
def set_parent(self, url):
1625
"""See Branch.set_parent."""
1626
# TODO: Maybe delete old location files?
1627
# URLs should never be unicode, even on the local fs,
1628
# FIXUP this and get_parent in a future branch format bump:
1629
# read and rewrite the file, and have the new format code read
1630
# using .get not .get_utf8. RBC 20060125
1632
if isinstance(url, unicode):
1634
url = url.encode('ascii')
1635
except UnicodeEncodeError:
1636
raise errors.InvalidURL(url,
1637
"Urls must be 7-bit ascii, "
1638
"use bzrlib.urlutils.escape")
1639
url = urlutils.relative_url(self.base, url)
1640
self._set_parent_location(url)
1642
def _set_parent_location(self, url):
1644
self.control_files._transport.delete('parent')
1646
assert isinstance(url, str)
1647
self.control_files.put_bytes('parent', url + '\n')
1650
class BzrBranch5(BzrBranch):
1651
"""A format 5 branch. This supports new features over plan branches.
1653
It has support for a master_branch which is the data for bound branches.
1661
super(BzrBranch5, self).__init__(_format=_format,
1662
_control_files=_control_files,
1664
_repository=_repository)
1667
def pull(self, source, overwrite=False, stop_revision=None,
1669
"""Pull from source into self, updating my master if any.
1671
:param run_hooks: Private parameter - if false, this branch
1672
is being called because it's the master of the primary branch,
1673
so it should not run its hooks.
1675
bound_location = self.get_bound_location()
1676
master_branch = None
1677
if bound_location and source.base != bound_location:
1678
# not pulling from master, so we need to update master.
1679
master_branch = self.get_master_branch()
1680
master_branch.lock_write()
1683
# pull from source into master.
1684
master_branch.pull(source, overwrite, stop_revision,
1686
return super(BzrBranch5, self).pull(source, overwrite,
1687
stop_revision, _hook_master=master_branch,
1688
run_hooks=run_hooks)
1691
master_branch.unlock()
1693
def get_bound_location(self):
1695
return self.control_files.get_utf8('bound').read()[:-1]
1696
except errors.NoSuchFile:
1700
def get_master_branch(self):
1701
"""Return the branch we are bound to.
1703
:return: Either a Branch, or None
1705
This could memoise the branch, but if thats done
1706
it must be revalidated on each new lock.
1707
So for now we just don't memoise it.
1708
# RBC 20060304 review this decision.
1710
bound_loc = self.get_bound_location()
1714
return Branch.open(bound_loc)
1715
except (errors.NotBranchError, errors.ConnectionError), e:
1716
raise errors.BoundBranchConnectionFailure(
1720
def set_bound_location(self, location):
1721
"""Set the target where this branch is bound to.
1723
:param location: URL to the target branch
1726
self.control_files.put_utf8('bound', location+'\n')
1729
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')
1735
def bind(self, other):
1736
"""Bind this branch to the branch other.
1738
This does not push or pull data between the branches, though it does
1739
check for divergence to raise an error when the branches are not
1740
either the same, or one a prefix of the other. That behaviour may not
1741
be useful, so that check may be removed in future.
1743
:param other: The branch to bind to
1746
# TODO: jam 20051230 Consider checking if the target is bound
1747
# It is debatable whether you should be able to bind to
1748
# a branch which is itself bound.
1749
# Committing is obviously forbidden,
1750
# but binding itself may not be.
1751
# Since we *have* to check at commit time, we don't
1752
# *need* to check here
1754
# we want to raise diverged if:
1755
# last_rev is not in the other_last_rev history, AND
1756
# other_last_rev is not in our history, and do it without pulling
1758
last_rev = _mod_revision.ensure_null(self.last_revision())
1759
if last_rev != _mod_revision.NULL_REVISION:
1762
other_last_rev = other.last_revision()
1763
if not _mod_revision.is_null(other_last_rev):
1764
# neither branch is new, we have to do some work to
1765
# ascertain diversion.
1766
remote_graph = other.repository.get_revision_graph(
1768
local_graph = self.repository.get_revision_graph(last_rev)
1769
if (last_rev not in remote_graph and
1770
other_last_rev not in local_graph):
1771
raise errors.DivergedBranches(self, other)
1774
self.set_bound_location(other.base)
1778
"""If bound, unbind"""
1779
return self.set_bound_location(None)
1783
"""Synchronise this branch with the master branch if any.
1785
:return: None or the last_revision that was pivoted out during the
1788
master = self.get_master_branch()
1789
if master is not None:
1790
old_tip = _mod_revision.ensure_null(self.last_revision())
1791
self.pull(master, overwrite=True)
1792
if self.repository.get_graph().is_ancestor(old_tip,
1793
_mod_revision.ensure_null(self.last_revision())):
1799
class BzrBranchExperimental(BzrBranch5):
1800
"""Bzr experimental branch format
1803
- a revision-history file.
1805
- a lock dir guarding the branch itself
1806
- all of this stored in a branch/ subdirectory
1807
- works with shared repositories.
1808
- a tag dictionary in the branch
1810
This format is new in bzr 0.15, but shouldn't be used for real data,
1813
This class acts as it's own BranchFormat.
1816
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1819
def get_format_string(cls):
1820
"""See BranchFormat.get_format_string()."""
1821
return "Bazaar-NG branch format experimental\n"
1824
def get_format_description(cls):
1825
"""See BranchFormat.get_format_description()."""
1826
return "Experimental branch format"
1829
def get_reference(cls, a_bzrdir):
1830
"""Get the target reference of the branch in a_bzrdir.
1832
format probing must have been completed before calling
1833
this method - it is assumed that the format of the branch
1834
in a_bzrdir is correct.
1836
:param a_bzrdir: The bzrdir to get the branch data from.
1837
:return: None if the branch is not a reference branch.
1842
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1844
branch_transport = a_bzrdir.get_branch_transport(cls)
1845
control_files = lockable_files.LockableFiles(branch_transport,
1846
lock_filename, lock_class)
1847
control_files.create_lock()
1848
control_files.lock_write()
1850
for filename, content in utf8_files:
1851
control_files.put_utf8(filename, content)
1853
control_files.unlock()
1856
def initialize(cls, a_bzrdir):
1857
"""Create a branch of this format in a_bzrdir."""
1858
utf8_files = [('format', cls.get_format_string()),
1859
('revision-history', ''),
1860
('branch-name', ''),
1863
cls._initialize_control_files(a_bzrdir, utf8_files,
1864
'lock', lockdir.LockDir)
1865
return cls.open(a_bzrdir, _found=True)
1868
def open(cls, a_bzrdir, _found=False):
1869
"""Return the branch object for a_bzrdir
1871
_found is a private parameter, do not use it. It is used to indicate
1872
if format probing has already be done.
1875
format = BranchFormat.find_format(a_bzrdir)
1876
assert format.__class__ == cls
1877
transport = a_bzrdir.get_branch_transport(None)
1878
control_files = lockable_files.LockableFiles(transport, 'lock',
1880
return cls(_format=cls,
1881
_control_files=control_files,
1883
_repository=a_bzrdir.find_repository())
1886
def is_supported(cls):
1889
def _make_tags(self):
1890
return BasicTags(self)
1893
def supports_tags(cls):
1897
BranchFormat.register_format(BzrBranchExperimental)
1900
class BzrBranch6(BzrBranch5):
1903
def last_revision_info(self):
1904
revision_string = self.control_files.get('last-revision').read()
1905
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1906
revision_id = cache_utf8.get_cached_utf8(revision_id)
1908
return revno, revision_id
1910
def last_revision(self):
1911
"""Return last revision id, or None"""
1912
revision_id = self.last_revision_info()[1]
1915
def _write_last_revision_info(self, revno, revision_id):
1916
"""Simply write out the revision id, with no checks.
1918
Use set_last_revision_info to perform this safely.
1920
Does not update the revision_history cache.
1921
Intended to be called by set_last_revision_info and
1922
_write_revision_history.
1924
if revision_id is None:
1925
revision_id = 'null:'
1926
out_string = '%d %s\n' % (revno, revision_id)
1927
self.control_files.put_bytes('last-revision', out_string)
1930
def set_last_revision_info(self, revno, revision_id):
1931
revision_id = osutils.safe_revision_id(revision_id)
1932
if self._get_append_revisions_only():
1933
self._check_history_violation(revision_id)
1934
self._write_last_revision_info(revno, revision_id)
1935
self._clear_cached_state()
1937
def _check_history_violation(self, revision_id):
1938
last_revision = _mod_revision.ensure_null(self.last_revision())
1939
if _mod_revision.is_null(last_revision):
1941
if last_revision not in self._lefthand_history(revision_id):
1942
raise errors.AppendRevisionsOnlyViolation(self.base)
1944
def _gen_revision_history(self):
1945
"""Generate the revision history from last revision
1947
history = list(self.repository.iter_reverse_revision_history(
1948
self.last_revision()))
1952
def _write_revision_history(self, history):
1953
"""Factored out of set_revision_history.
1955
This performs the actual writing to disk, with format-specific checks.
1956
It is intended to be called by BzrBranch5.set_revision_history.
1958
if len(history) == 0:
1959
last_revision = 'null:'
1961
if history != self._lefthand_history(history[-1]):
1962
raise errors.NotLefthandHistory(history)
1963
last_revision = history[-1]
1964
if self._get_append_revisions_only():
1965
self._check_history_violation(last_revision)
1966
self._write_last_revision_info(len(history), last_revision)
1969
def _set_parent_location(self, url):
1970
"""Set the parent branch"""
1971
self._set_config_location('parent_location', url, make_relative=True)
1974
def _get_parent_location(self):
1975
"""Set the parent branch"""
1976
return self._get_config_location('parent_location')
1978
def set_push_location(self, location):
1979
"""See Branch.set_push_location."""
1980
self._set_config_location('push_location', location)
1982
def set_bound_location(self, location):
1983
"""See Branch.set_push_location."""
1985
config = self.get_config()
1986
if location is None:
1987
if config.get_user_option('bound') != 'True':
1990
config.set_user_option('bound', 'False', warn_masked=True)
1993
self._set_config_location('bound_location', location,
1995
config.set_user_option('bound', 'True', warn_masked=True)
1998
def _get_bound_location(self, bound):
1999
"""Return the bound location in the config file.
2001
Return None if the bound parameter does not match"""
2002
config = self.get_config()
2003
config_bound = (config.get_user_option('bound') == 'True')
2004
if config_bound != bound:
2006
return self._get_config_location('bound_location', config=config)
2008
def get_bound_location(self):
2009
"""See Branch.set_push_location."""
2010
return self._get_bound_location(True)
2012
def get_old_bound_location(self):
2013
"""See Branch.get_old_bound_location"""
2014
return self._get_bound_location(False)
2016
def set_append_revisions_only(self, enabled):
2021
self.get_config().set_user_option('append_revisions_only', value,
2024
def _get_append_revisions_only(self):
2025
value = self.get_config().get_user_option('append_revisions_only')
2026
return value == 'True'
2028
def _synchronize_history(self, destination, revision_id):
2029
"""Synchronize last revision and revision history between branches.
2031
This version is most efficient when the destination is also a
2032
BzrBranch6, but works for BzrBranch5, as long as the destination's
2033
repository contains all the lefthand ancestors of the intended
2034
last_revision. If not, set_last_revision_info will fail.
2036
:param destination: The branch to copy the history into
2037
:param revision_id: The revision-id to truncate history at. May
2038
be None to copy complete history.
2040
source_revno, source_revision_id = self.last_revision_info()
2041
if revision_id is None:
2042
revno, revision_id = source_revno, source_revision_id
2043
elif source_revision_id == revision_id:
2044
# we know the revno without needing to walk all of history
2045
revno = source_revno
2047
# To figure out the revno for a random revision, we need to build
2048
# the revision history, and count its length.
2049
# We don't care about the order, just how long it is.
2050
# Alternatively, we could start at the current location, and count
2051
# backwards. But there is no guarantee that we will find it since
2052
# it may be a merged revision.
2053
revno = len(list(self.repository.iter_reverse_revision_history(
2055
destination.set_last_revision_info(revno, revision_id)
2057
def _make_tags(self):
2058
return BasicTags(self)
2061
######################################################################
2062
# results of operations
2065
class _Result(object):
2067
def _show_tag_conficts(self, to_file):
2068
if not getattr(self, 'tag_conflicts', None):
2070
to_file.write('Conflicting tags:\n')
2071
for name, value1, value2 in self.tag_conflicts:
2072
to_file.write(' %s\n' % (name, ))
2075
class PullResult(_Result):
2076
"""Result of a Branch.pull operation.
2078
:ivar old_revno: Revision number before pull.
2079
:ivar new_revno: Revision number after pull.
2080
:ivar old_revid: Tip revision id before pull.
2081
:ivar new_revid: Tip revision id after pull.
2082
:ivar source_branch: Source (local) branch object.
2083
:ivar master_branch: Master branch of the target, or None.
2084
:ivar target_branch: Target/destination branch object.
2088
# DEPRECATED: pull used to return the change in revno
2089
return self.new_revno - self.old_revno
2091
def report(self, to_file):
2092
if self.old_revid == self.new_revid:
2093
to_file.write('No revisions to pull.\n')
2095
to_file.write('Now on revision %d.\n' % self.new_revno)
2096
self._show_tag_conficts(to_file)
2099
class PushResult(_Result):
2100
"""Result of a Branch.push operation.
2102
:ivar old_revno: Revision number before push.
2103
:ivar new_revno: Revision number after push.
2104
:ivar old_revid: Tip revision id before push.
2105
:ivar new_revid: Tip revision id after push.
2106
:ivar source_branch: Source branch object.
2107
:ivar master_branch: Master branch of the target, or None.
2108
:ivar target_branch: Target/destination branch object.
2112
# DEPRECATED: push used to return the change in revno
2113
return self.new_revno - self.old_revno
2115
def report(self, to_file):
2116
"""Write a human-readable description of the result."""
2117
if self.old_revid == self.new_revid:
2118
to_file.write('No new revisions to push.\n')
2120
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2121
self._show_tag_conficts(to_file)
2124
class BranchCheckResult(object):
2125
"""Results of checking branch consistency.
2130
def __init__(self, branch):
2131
self.branch = branch
2133
def report_results(self, verbose):
2134
"""Report the check results via trace.note.
2136
:param verbose: Requests more detailed display of what was checked,
2139
note('checked branch %s format %s',
2141
self.branch._format)
2144
class Converter5to6(object):
2145
"""Perform an in-place upgrade of format 5 to format 6"""
2147
def convert(self, branch):
2148
# Data for 5 and 6 can peacefully coexist.
2149
format = BzrBranchFormat6()
2150
new_branch = format.open(branch.bzrdir, _found=True)
2152
# Copy source data into target
2153
new_branch.set_last_revision_info(*branch.last_revision_info())
2154
new_branch.set_parent(branch.get_parent())
2155
new_branch.set_bound_location(branch.get_bound_location())
2156
new_branch.set_push_location(branch.get_push_location())
2158
# New branch has no tags by default
2159
new_branch.tags._set_tag_dict({})
2161
# Copying done; now update target format
2162
new_branch.control_files.put_utf8('format',
2163
format.get_format_string())
2165
# Clean up old files
2166
new_branch.control_files._transport.delete('revision-history')
2168
branch.set_parent(None)
2171
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
