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, possible_transports=None):
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
possible_transports=possible_transports)
128
return control.open_branch(_unsupported)
131
def open_from_transport(transport, _unsupported=False):
132
"""Open the branch rooted at transport"""
133
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
134
return control.open_branch(_unsupported)
137
def open_containing(url, possible_transports=None):
138
"""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.
140
This probes for a branch at url, and searches upwards from there.
142
Basically we keep looking up until we find the control directory or
143
run into the root. If there isn't one, raises NotBranchError.
144
If there is one and it is either an unrecognised format or an unsupported
145
format, UnknownFormatError or UnsupportedFormatError are raised.
146
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)
148
control, relpath = bzrdir.BzrDir.open_containing(url,
150
return control.open_branch(), relpath
152
def get_config(self):
153
return BranchConfig(self)
156
return self.get_config().get_nickname()
158
def _set_nick(self, nick):
159
self.get_config().set_user_option('nickname', nick, warn_masked=True)
161
nick = property(_get_nick, _set_nick)
164
raise NotImplementedError(self.is_locked)
212
166
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'
167
raise NotImplementedError(self.lock_write)
228
169
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'
170
raise NotImplementedError(self.lock_read)
242
172
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
173
raise NotImplementedError(self.unlock)
175
def peek_lock_mode(self):
176
"""Return lock mode for the Branch: 'r', 'w' or None"""
177
raise NotImplementedError(self.peek_lock_mode)
179
def get_physical_lock_status(self):
180
raise NotImplementedError(self.get_physical_lock_status)
183
def get_revision_id_to_revno_map(self):
184
"""Return the revision_id => dotted revno map.
186
This will be regenerated on demand, but will be cached.
188
:return: A dictionary mapping revision_id => dotted revno.
189
This dictionary should not be modified by the caller.
191
if self._revision_id_to_revno_cache is not None:
192
mapping = self._revision_id_to_revno_cache
252
self._lock_mode = self._lock_count = None
194
mapping = self._gen_revno_map()
195
self._cache_revision_id_to_revno(mapping)
196
# TODO: jam 20070417 Since this is being cached, should we be returning
198
# I would rather not, and instead just declare that users should not
199
# modify the return value.
202
def _gen_revno_map(self):
203
"""Create a new mapping from revision ids to dotted revnos.
205
Dotted revnos are generated based on the current tip in the revision
207
This is the worker function for get_revision_id_to_revno_map, which
208
just caches the return value.
210
:return: A dictionary mapping revision_id => dotted revno.
212
last_revision = self.last_revision()
213
revision_graph = self.repository.get_revision_graph(last_revision)
214
merge_sorted_revisions = tsort.merge_sort(
219
revision_id_to_revno = dict((rev_id, revno)
220
for seq_num, rev_id, depth, revno, end_of_merge
221
in merge_sorted_revisions)
222
return revision_id_to_revno
224
def leave_lock_in_place(self):
225
"""Tell this branch object not to release the physical lock when this
228
If lock_write doesn't return a token, then this method is not supported.
230
self.control_files.leave_in_place()
232
def dont_leave_lock_in_place(self):
233
"""Tell this branch object to release the physical lock when this
234
object is unlocked, even if it didn't originally acquire it.
236
If lock_write doesn't return a token, then this method is not supported.
238
self.control_files.dont_leave_in_place()
255
240
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
241
"""Return absolute filename for something in the branch
243
XXX: Robert Collins 20051017 what is this used for? why is it a branch
244
method and not a tree method.
246
raise NotImplementedError(self.abspath)
248
def bind(self, other):
249
"""Bind the local branch the other branch.
251
:param other: The branch to bind to
254
raise errors.UpgradeRequired(self.base)
257
def fetch(self, from_branch, last_revision=None, pb=None):
258
"""Copy revisions from from_branch into this branch.
260
:param from_branch: Where to copy from.
261
:param last_revision: What revision to stop at (None for at the end
263
:param pb: An optional progress bar to use.
265
Returns the copied revision count and the failed revisions in a tuple:
268
if self.base == from_branch.base:
271
nested_pb = ui.ui_factory.nested_progress_bar()
276
from_branch.lock_read()
278
if last_revision is None:
279
pb.update('get source history')
280
last_revision = from_branch.last_revision()
281
if last_revision is None:
282
last_revision = _mod_revision.NULL_REVISION
283
return self.repository.fetch(from_branch.repository,
284
revision_id=last_revision,
287
if nested_pb is not None:
291
def get_bound_location(self):
292
"""Return the URL of the branch we are bound to.
294
Older format branches cannot bind, please be sure to use a metadir
299
def get_old_bound_location(self):
300
"""Return the URL of the branch we used to be bound to
302
raise errors.UpgradeRequired(self.base)
304
def get_commit_builder(self, parents, config=None, timestamp=None,
305
timezone=None, committer=None, revprops=None,
307
"""Obtain a CommitBuilder for this branch.
309
:param parents: Revision ids of the parents of the new revision.
310
:param config: Optional configuration to use.
311
:param timestamp: Optional timestamp recorded for commit.
312
:param timezone: Optional timezone for timestamp.
313
:param committer: Optional committer to set for commit.
314
:param revprops: Optional dictionary of revision properties.
315
:param revision_id: Optional revision id.
319
config = self.get_config()
321
return self.repository.get_commit_builder(self, parents, config,
322
timestamp, timezone, committer, revprops, revision_id)
324
def get_master_branch(self, possible_transports=None):
325
"""Return the branch we are bound to.
327
:return: Either a Branch, or None
617
331
def get_revision_delta(self, revno):
618
332
"""Return the delta for one revision.
794
470
if stop_revision is None:
795
471
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
473
assert isinstance(stop_revision, int)
474
if stop_revision > other_len:
475
raise errors.NoSuchRevision(self, stop_revision)
799
476
return other_history[self_len:stop_revision]
802
478
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())
479
"""Pull in new perfect-fit revisions.
481
:param other: Another Branch to pull from
482
:param stop_revision: Updated until the given revision
485
raise NotImplementedError(self.update_revisions)
487
def revision_id_to_revno(self, revision_id):
488
"""Given a revision id, return its revno"""
489
if _mod_revision.is_null(revision_id):
491
revision_id = osutils.safe_revision_id(revision_id)
492
history = self.revision_history()
494
return history.index(revision_id) + 1
496
raise errors.NoSuchRevision(self, revision_id)
498
def get_rev_id(self, revno, history=None):
499
"""Find the revision id of the specified revno."""
501
return _mod_revision.NULL_REVISION
503
history = self.revision_history()
504
if revno <= 0 or revno > len(history):
505
raise errors.NoSuchRevision(self, revno)
506
return history[revno - 1]
508
def pull(self, source, overwrite=False, stop_revision=None):
509
"""Mirror source into this branch.
511
This branch is considered to be 'local', having low latency.
513
:returns: PullResult instance
515
raise NotImplementedError(self.pull)
517
def push(self, target, overwrite=False, stop_revision=None):
518
"""Mirror this branch into target.
520
This branch is considered to be 'local', having low latency.
522
raise NotImplementedError(self.push)
1053
524
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))
525
"""Return `Tree` object for last revision."""
526
return self.repository.revision_tree(self.last_revision())
1066
528
def rename_one(self, from_rel, to_rel):
1067
529
"""Rename one file.
1069
531
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)
533
raise NotImplementedError(self.rename_one)
1117
535
def move(self, from_paths, to_name):
1118
536
"""Rename files.
1125
543
Note that to_name is only the last component of the new name;
1126
544
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:
546
This returns a list of (from_path, to_path) pairs for each
549
raise NotImplementedError(self.move)
551
def get_parent(self):
552
"""Return the parent location of the branch.
554
This is the default location for push/pull/missing. The usual
555
pattern is that the user can override it by specifying a
558
raise NotImplementedError(self.get_parent)
560
def _set_config_location(self, name, url, config=None,
561
make_relative=False):
563
config = self.get_config()
567
url = urlutils.relative_url(self.base, url)
568
config.set_user_option(name, url, warn_masked=True)
570
def _get_config_location(self, name, config=None):
572
config = self.get_config()
573
location = config.get_user_option(name)
578
def get_submit_branch(self):
579
"""Return the submit location of the branch.
581
This is the default location for bundle. The usual
582
pattern is that the user can override it by specifying a
585
return self.get_config().get_user_option('submit_branch')
587
def set_submit_branch(self, location):
588
"""Return the submit location of the branch.
590
This is the default location for bundle. The usual
591
pattern is that the user can override it by specifying a
594
self.get_config().set_user_option('submit_branch', location,
597
def get_public_branch(self):
598
"""Return the public location of the branch.
600
This is is used by merge directives.
602
return self._get_config_location('public_branch')
604
def set_public_branch(self, location):
605
"""Return the submit location of the branch.
607
This is the default location for bundle. The usual
608
pattern is that the user can override it by specifying a
611
self._set_config_location('public_branch', location)
613
def get_push_location(self):
614
"""Return the None or the location to push this branch to."""
615
push_loc = self.get_config().get_user_option('push_location')
618
def set_push_location(self, location):
619
"""Set a new push location for this branch."""
620
raise NotImplementedError(self.set_push_location)
622
def set_parent(self, url):
623
raise NotImplementedError(self.set_parent)
627
"""Synchronise this branch with the master branch if any.
629
:return: None or the last_revision pivoted out during the update.
633
def check_revno(self, revno):
635
Check whether a revno corresponds to any revision.
636
Zero (the NULL revision) is considered valid.
639
self.check_real_revno(revno)
641
def check_real_revno(self, revno):
643
Check whether a revno corresponds to a real revision.
644
Zero (the NULL revision) is considered invalid
646
if revno < 1 or revno > self.revno():
647
raise InvalidRevisionNumber(revno)
650
def clone(self, to_bzrdir, revision_id=None):
651
"""Clone this branch into to_bzrdir preserving all semantic values.
653
revision_id: if not None, the revision history in the new branch will
654
be truncated to end with revision_id.
656
result = self._format.initialize(to_bzrdir)
657
self.copy_content_into(result, revision_id=revision_id)
661
def sprout(self, to_bzrdir, revision_id=None):
662
"""Create a new line of development from the branch, into to_bzrdir.
664
revision_id: if not None, the revision history in the new branch will
665
be truncated to end with revision_id.
667
result = self._format.initialize(to_bzrdir)
668
self.copy_content_into(result, revision_id=revision_id)
669
result.set_parent(self.bzrdir.root_transport.base)
672
def _synchronize_history(self, destination, revision_id):
673
"""Synchronize last revision and revision history between branches.
675
This version is most efficient when the destination is also a
676
BzrBranch5, but works for BzrBranch6 as long as the revision
677
history is the true lefthand parent history, and all of the revisions
678
are in the destination's repository. If not, set_revision_history
681
:param destination: The branch to copy the history into
682
:param revision_id: The revision-id to truncate history at. May
683
be None to copy complete history.
685
if revision_id == _mod_revision.NULL_REVISION:
687
new_history = self.revision_history()
688
if revision_id is not None and new_history != []:
689
revision_id = osutils.safe_revision_id(revision_id)
691
new_history = new_history[:new_history.index(revision_id) + 1]
693
rev = self.repository.get_revision(revision_id)
694
new_history = rev.get_history(self.repository)[1:]
695
destination.set_revision_history(new_history)
698
def copy_content_into(self, destination, revision_id=None):
699
"""Copy the content of self into destination.
701
revision_id: if not None, the revision history in the new branch will
702
be truncated to end with revision_id.
704
self._synchronize_history(destination, revision_id)
706
parent = self.get_parent()
707
except errors.InaccessibleParent, e:
708
mutter('parent was not accessible to copy: %s', e)
711
destination.set_parent(parent)
712
self.tags.merge_to(destination.tags)
716
"""Check consistency of the branch.
718
In particular this checks that revisions given in the revision-history
719
do actually match up in the revision graph, and that they're all
720
present in the repository.
722
Callers will typically also want to check the repository.
724
:return: A BranchCheckResult.
726
mainline_parent_id = None
727
for revision_id in self.revision_history():
729
revision = self.repository.get_revision(revision_id)
730
except errors.NoSuchRevision, e:
731
raise errors.BzrCheckError("mainline revision {%s} not in repository"
733
# In general the first entry on the revision history has no parents.
734
# But it's not illegal for it to have parents listed; this can happen
735
# in imports from Arch when the parents weren't reachable.
736
if mainline_parent_id is not None:
737
if mainline_parent_id not in revision.parent_ids:
738
raise errors.BzrCheckError("previous revision {%s} not listed among "
740
% (mainline_parent_id, revision_id))
741
mainline_parent_id = revision_id
742
return BranchCheckResult(self)
744
def _get_checkout_format(self):
745
"""Return the most suitable metadir for a checkout of this branch.
746
Weaves are used if this branch's repository uses weaves.
748
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
749
from bzrlib.repofmt import weaverepo
750
format = bzrdir.BzrDirMetaFormat1()
751
format.repository_format = weaverepo.RepositoryFormat7()
753
format = self.repository.bzrdir.checkout_metadir()
754
format.set_branch_format(self._format)
757
def create_checkout(self, to_location, revision_id=None,
759
"""Create a checkout of a branch.
761
:param to_location: The url to produce the checkout at
762
:param revision_id: The revision to check out
763
:param lightweight: If True, produce a lightweight checkout, otherwise,
764
produce a bound branch (heavyweight checkout)
765
:return: The tree of the created checkout
767
t = transport.get_transport(to_location)
770
format = self._get_checkout_format()
771
checkout = format.initialize_on_transport(t)
772
BranchReferenceFormat().initialize(checkout, self)
774
format = self._get_checkout_format()
775
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
776
to_location, force_new_tree=False, format=format)
777
checkout = checkout_branch.bzrdir
778
checkout_branch.bind(self)
779
# pull up to the specified revision_id to set the initial
780
# branch tip correctly, and seed it with history.
781
checkout_branch.pull(self, stop_revision=revision_id)
782
tree = checkout.create_workingtree(revision_id)
783
basis_tree = tree.basis_tree()
784
basis_tree.lock_read()
786
for path, file_id in basis_tree.iter_references():
787
reference_parent = self.reference_parent(file_id, path)
788
reference_parent.create_checkout(tree.abspath(path),
789
basis_tree.get_reference_revision(file_id, path),
795
def reference_parent(self, file_id, path):
796
"""Return the parent branch for a tree-reference file_id
797
:param file_id: The file_id of the tree reference
798
:param path: The path of the file_id in the tree
799
:return: A branch associated with the file_id
801
# FIXME should provide multiple branches, based on config
802
return Branch.open(self.bzrdir.root_transport.clone(path).base)
804
def supports_tags(self):
805
return self._format.supports_tags()
808
class BranchFormat(object):
809
"""An encapsulation of the initialization and open routines for a format.
811
Formats provide three things:
812
* An initialization routine,
816
Formats are placed in an dict by their format string for reference
817
during branch opening. Its not required that these be instances, they
818
can be classes themselves with class methods - it simply depends on
819
whether state is needed for a given format or not.
821
Once a format is deprecated, just deprecate the initialize and open
822
methods on the format class. Do not deprecate the object, as the
823
object will be created every time regardless.
826
_default_format = None
827
"""The default format used for new branches."""
830
"""The known formats."""
832
def __eq__(self, other):
833
return self.__class__ is other.__class__
835
def __ne__(self, other):
836
return not (self == other)
839
def find_format(klass, a_bzrdir):
840
"""Return the format for the branch object in a_bzrdir."""
842
transport = a_bzrdir.get_branch_transport(None)
843
format_string = transport.get("format").read()
844
return klass._formats[format_string]
846
raise NotBranchError(path=transport.base)
848
raise errors.UnknownFormatError(format=format_string)
851
def get_default_format(klass):
852
"""Return the current default format."""
853
return klass._default_format
855
def get_reference(self, a_bzrdir):
856
"""Get the target reference of the branch in a_bzrdir.
858
format probing must have been completed before calling
859
this method - it is assumed that the format of the branch
860
in a_bzrdir is correct.
862
:param a_bzrdir: The bzrdir to get the branch data from.
863
:return: None if the branch is not a reference branch.
867
def get_format_string(self):
868
"""Return the ASCII format string that identifies this format."""
869
raise NotImplementedError(self.get_format_string)
871
def get_format_description(self):
872
"""Return the short format description for this format."""
873
raise NotImplementedError(self.get_format_description)
875
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
877
"""Initialize a branch in a bzrdir, with specified files
879
:param a_bzrdir: The bzrdir to initialize the branch in
880
:param utf8_files: The files to create as a list of
881
(filename, content) tuples
882
:param set_format: If True, set the format with
883
self.get_format_string. (BzrBranch4 has its format set
885
:return: a branch in this format
887
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
888
branch_transport = a_bzrdir.get_branch_transport(self)
890
'metadir': ('lock', lockdir.LockDir),
891
'branch4': ('branch-lock', lockable_files.TransportLock),
893
lock_name, lock_class = lock_map[lock_type]
894
control_files = lockable_files.LockableFiles(branch_transport,
895
lock_name, lock_class)
896
control_files.create_lock()
897
control_files.lock_write()
899
control_files.put_utf8('format', self.get_format_string())
901
for file, content in utf8_files:
902
control_files.put_utf8(file, content)
904
control_files.unlock()
905
return self.open(a_bzrdir, _found=True)
907
def initialize(self, a_bzrdir):
908
"""Create a branch of this format in a_bzrdir."""
909
raise NotImplementedError(self.initialize)
911
def is_supported(self):
912
"""Is this format supported?
914
Supported formats can be initialized and opened.
915
Unsupported formats may not support initialization or committing or
916
some other features depending on the reason for not being supported.
920
def open(self, a_bzrdir, _found=False):
921
"""Return the branch object for a_bzrdir
923
_found is a private parameter, do not use it. It is used to indicate
924
if format probing has already be done.
926
raise NotImplementedError(self.open)
929
def register_format(klass, format):
930
klass._formats[format.get_format_string()] = format
933
def set_default_format(klass, format):
934
klass._default_format = format
937
def unregister_format(klass, format):
938
assert klass._formats[format.get_format_string()] is format
939
del klass._formats[format.get_format_string()]
942
return self.get_format_string().rstrip()
944
def supports_tags(self):
945
"""True if this format supports tags stored in the branch"""
946
return False # by default
948
# XXX: Probably doesn't really belong here -- mbp 20070212
949
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
951
branch_transport = a_bzrdir.get_branch_transport(self)
952
control_files = lockable_files.LockableFiles(branch_transport,
953
lock_filename, lock_class)
954
control_files.create_lock()
955
control_files.lock_write()
957
for filename, content in utf8_files:
958
control_files.put_utf8(filename, content)
960
control_files.unlock()
963
class BranchHooks(Hooks):
964
"""A dictionary mapping hook name to a list of callables for branch hooks.
966
e.g. ['set_rh'] Is the list of items to be called when the
967
set_revision_history function is invoked.
971
"""Create the default hooks.
973
These are all empty initially, because by default nothing should get
977
# Introduced in 0.15:
978
# invoked whenever the revision history has been set
979
# with set_revision_history. The api signature is
980
# (branch, revision_history), and the branch will
983
# invoked after a push operation completes.
984
# the api signature is
986
# containing the members
987
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
988
# where local is the local target branch or None, master is the target
989
# master branch, and the rest should be self explanatory. The source
990
# is read locked and the target branches write locked. Source will
991
# be the local low-latency branch.
992
self['post_push'] = []
993
# invoked after a pull operation completes.
994
# the api signature is
996
# containing the members
997
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
998
# where local is the local branch or None, master is the target
999
# master branch, and the rest should be self explanatory. The source
1000
# is read locked and the target branches write locked. The local
1001
# branch is the low-latency branch.
1002
self['post_pull'] = []
1003
# invoked before a commit operation takes place.
1004
# the api signature is
1005
# (local, master, old_revno, old_revid, future_revno, future_revid,
1006
# tree_delta, future_tree).
1007
# old_revid is NULL_REVISION for the first commit to a branch
1008
# tree_delta is a TreeDelta object describing changes from the basis
1009
# revision, hooks MUST NOT modify this delta
1010
# future_tree is an in-memory tree obtained from
1011
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1012
self['pre_commit'] = []
1013
# invoked after a commit operation completes.
1014
# the api signature is
1015
# (local, master, old_revno, old_revid, new_revno, new_revid)
1016
# old_revid is NULL_REVISION for the first commit to a branch.
1017
self['post_commit'] = []
1018
# invoked after a uncommit operation completes.
1019
# the api signature is
1020
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1021
# local is the local branch or None, master is the target branch,
1022
# and an empty branch recieves new_revno of 0, new_revid of None.
1023
self['post_uncommit'] = []
1026
# install the default hooks into the Branch class.
1027
Branch.hooks = BranchHooks()
1030
class BzrBranchFormat4(BranchFormat):
1031
"""Bzr branch format 4.
1034
- a revision-history file.
1035
- a branch-lock lock file [ to be shared with the bzrdir ]
1038
def get_format_description(self):
1039
"""See BranchFormat.get_format_description()."""
1040
return "Branch format 4"
1042
def initialize(self, a_bzrdir):
1043
"""Create a branch of this format in a_bzrdir."""
1044
utf8_files = [('revision-history', ''),
1045
('branch-name', ''),
1047
return self._initialize_helper(a_bzrdir, utf8_files,
1048
lock_type='branch4', set_format=False)
1051
super(BzrBranchFormat4, self).__init__()
1052
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1054
def open(self, a_bzrdir, _found=False):
1055
"""Return the branch object for a_bzrdir
1057
_found is a private parameter, do not use it. It is used to indicate
1058
if format probing has already be done.
1061
# we are being called directly and must probe.
1062
raise NotImplementedError
1063
return BzrBranch(_format=self,
1064
_control_files=a_bzrdir._control_files,
1066
_repository=a_bzrdir.open_repository())
1069
return "Bazaar-NG branch format 4"
1072
class BzrBranchFormat5(BranchFormat):
1073
"""Bzr branch format 5.
1076
- a revision-history file.
1078
- a lock dir guarding the branch itself
1079
- all of this stored in a branch/ subdirectory
1080
- works with shared repositories.
1082
This format is new in bzr 0.8.
1085
def get_format_string(self):
1086
"""See BranchFormat.get_format_string()."""
1087
return "Bazaar-NG branch format 5\n"
1089
def get_format_description(self):
1090
"""See BranchFormat.get_format_description()."""
1091
return "Branch format 5"
1093
def initialize(self, a_bzrdir):
1094
"""Create a branch of this format in a_bzrdir."""
1095
utf8_files = [('revision-history', ''),
1096
('branch-name', ''),
1098
return self._initialize_helper(a_bzrdir, utf8_files)
1101
super(BzrBranchFormat5, self).__init__()
1102
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1104
def open(self, a_bzrdir, _found=False):
1105
"""Return the branch object for a_bzrdir
1107
_found is a private parameter, do not use it. It is used to indicate
1108
if format probing has already be done.
1111
format = BranchFormat.find_format(a_bzrdir)
1112
assert format.__class__ == self.__class__
1114
transport = a_bzrdir.get_branch_transport(None)
1115
control_files = lockable_files.LockableFiles(transport, 'lock',
1117
return BzrBranch5(_format=self,
1118
_control_files=control_files,
1120
_repository=a_bzrdir.find_repository())
1122
raise NotBranchError(path=transport.base)
1125
class BzrBranchFormat6(BzrBranchFormat5):
1126
"""Branch format with last-revision and tags.
1128
Unlike previous formats, this has no explicit revision history. Instead,
1129
this just stores the last-revision, and the left-hand history leading
1130
up to there is the history.
1132
This format was introduced in bzr 0.15
1133
and became the default in 0.91.
1136
def get_format_string(self):
1137
"""See BranchFormat.get_format_string()."""
1138
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1140
def get_format_description(self):
1141
"""See BranchFormat.get_format_description()."""
1142
return "Branch format 6"
1144
def initialize(self, a_bzrdir):
1145
"""Create a branch of this format in a_bzrdir."""
1146
utf8_files = [('last-revision', '0 null:\n'),
1147
('branch-name', ''),
1148
('branch.conf', ''),
1151
return self._initialize_helper(a_bzrdir, utf8_files)
1153
def open(self, a_bzrdir, _found=False):
1154
"""Return the branch object for a_bzrdir
1156
_found is a private parameter, do not use it. It is used to indicate
1157
if format probing has already be done.
1160
format = BranchFormat.find_format(a_bzrdir)
1161
assert format.__class__ == self.__class__
1162
transport = a_bzrdir.get_branch_transport(None)
1163
control_files = lockable_files.LockableFiles(transport, 'lock',
1165
return BzrBranch6(_format=self,
1166
_control_files=control_files,
1168
_repository=a_bzrdir.find_repository())
1170
def supports_tags(self):
1174
class BranchReferenceFormat(BranchFormat):
1175
"""Bzr branch reference format.
1177
Branch references are used in implementing checkouts, they
1178
act as an alias to the real branch which is at some other url.
1185
def get_format_string(self):
1186
"""See BranchFormat.get_format_string()."""
1187
return "Bazaar-NG Branch Reference Format 1\n"
1189
def get_format_description(self):
1190
"""See BranchFormat.get_format_description()."""
1191
return "Checkout reference format 1"
1193
def get_reference(self, a_bzrdir):
1194
"""See BranchFormat.get_reference()."""
1195
transport = a_bzrdir.get_branch_transport(None)
1196
return transport.get('location').read()
1198
def initialize(self, a_bzrdir, target_branch=None):
1199
"""Create a branch of this format in a_bzrdir."""
1200
if target_branch is None:
1201
# this format does not implement branch itself, thus the implicit
1202
# creation contract must see it as uninitializable
1203
raise errors.UninitializableFormat(self)
1204
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1205
branch_transport = a_bzrdir.get_branch_transport(self)
1206
branch_transport.put_bytes('location',
1207
target_branch.bzrdir.root_transport.base)
1208
branch_transport.put_bytes('format', self.get_format_string())
1209
return self.open(a_bzrdir, _found=True)
1212
super(BranchReferenceFormat, self).__init__()
1213
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1215
def _make_reference_clone_function(format, a_branch):
1216
"""Create a clone() routine for a branch dynamically."""
1217
def clone(to_bzrdir, revision_id=None):
1218
"""See Branch.clone()."""
1219
return format.initialize(to_bzrdir, a_branch)
1220
# cannot obey revision_id limits when cloning a reference ...
1221
# FIXME RBC 20060210 either nuke revision_id for clone, or
1222
# emit some sort of warning/error to the caller ?!
1225
def open(self, a_bzrdir, _found=False, location=None):
1226
"""Return the branch that the branch reference in a_bzrdir points at.
1228
_found is a private parameter, do not use it. It is used to indicate
1229
if format probing has already be done.
1232
format = BranchFormat.find_format(a_bzrdir)
1233
assert format.__class__ == self.__class__
1234
if location is None:
1235
location = self.get_reference(a_bzrdir)
1236
real_bzrdir = bzrdir.BzrDir.open(location)
1237
result = real_bzrdir.open_branch()
1238
# this changes the behaviour of result.clone to create a new reference
1239
# rather than a copy of the content of the branch.
1240
# I did not use a proxy object because that needs much more extensive
1241
# testing, and we are only changing one behaviour at the moment.
1242
# If we decide to alter more behaviours - i.e. the implicit nickname
1243
# then this should be refactored to introduce a tested proxy branch
1244
# and a subclass of that for use in overriding clone() and ....
1246
result.clone = self._make_reference_clone_function(result)
1250
# formats which have no format string are not discoverable
1251
# and not independently creatable, so are not registered.
1252
__format5 = BzrBranchFormat5()
1253
__format6 = BzrBranchFormat6()
1254
BranchFormat.register_format(__format5)
1255
BranchFormat.register_format(BranchReferenceFormat())
1256
BranchFormat.register_format(__format6)
1257
BranchFormat.set_default_format(__format6)
1258
_legacy_formats = [BzrBranchFormat4(),
1261
class BzrBranch(Branch):
1262
"""A branch stored in the actual filesystem.
1264
Note that it's "local" in the context of the filesystem; it doesn't
1265
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1266
it's writable, and can be accessed via the normal filesystem API.
1269
def __init__(self, _format=None,
1270
_control_files=None, a_bzrdir=None, _repository=None):
1271
"""Create new branch object at a particular location."""
1272
Branch.__init__(self)
1273
if a_bzrdir is None:
1274
raise ValueError('a_bzrdir must be supplied')
1276
self.bzrdir = a_bzrdir
1277
# self._transport used to point to the directory containing the
1278
# control directory, but was not used - now it's just the transport
1279
# for the branch control files. mbp 20070212
1280
self._base = self.bzrdir.transport.clone('..').base
1281
self._format = _format
1282
if _control_files is None:
1283
raise ValueError('BzrBranch _control_files is None')
1284
self.control_files = _control_files
1285
self._transport = _control_files._transport
1286
self.repository = _repository
1289
return '%s(%r)' % (self.__class__.__name__, self.base)
1293
def _get_base(self):
1294
"""Returns the directory containing the control directory."""
1297
base = property(_get_base, doc="The URL for the root of this branch.")
1299
def abspath(self, name):
1300
"""See Branch.abspath."""
1301
return self.control_files._transport.abspath(name)
1304
@deprecated_method(zero_sixteen)
1306
def get_root_id(self):
1307
"""See Branch.get_root_id."""
1308
tree = self.repository.revision_tree(self.last_revision())
1309
return tree.inventory.root.file_id
1311
def is_locked(self):
1312
return self.control_files.is_locked()
1314
def lock_write(self, token=None):
1315
repo_token = self.repository.lock_write()
1317
token = self.control_files.lock_write(token=token)
1319
self.repository.unlock()
1323
def lock_read(self):
1324
self.repository.lock_read()
1326
self.control_files.lock_read()
1328
self.repository.unlock()
1332
# TODO: test for failed two phase locks. This is known broken.
1334
self.control_files.unlock()
1336
self.repository.unlock()
1337
if not self.control_files.is_locked():
1338
# we just released the lock
1339
self._clear_cached_state()
1341
def peek_lock_mode(self):
1342
if self.control_files._lock_count == 0:
1345
return self.control_files._lock_mode
1347
def get_physical_lock_status(self):
1348
return self.control_files.get_physical_lock_status()
1351
def print_file(self, file, revision_id):
1352
"""See Branch.print_file."""
1353
return self.repository.print_file(file, revision_id)
1355
def _write_revision_history(self, history):
1356
"""Factored out of set_revision_history.
1358
This performs the actual writing to disk.
1359
It is intended to be called by BzrBranch5.set_revision_history."""
1360
self.control_files.put_bytes(
1361
'revision-history', '\n'.join(history))
1364
def set_revision_history(self, rev_history):
1365
"""See Branch.set_revision_history."""
1366
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1367
self._clear_cached_state()
1368
self._write_revision_history(rev_history)
1369
self._cache_revision_history(rev_history)
1370
for hook in Branch.hooks['set_rh']:
1371
hook(self, rev_history)
1374
def set_last_revision_info(self, revno, revision_id):
1375
"""Set the last revision of this branch.
1377
The caller is responsible for checking that the revno is correct
1378
for this revision id.
1380
It may be possible to set the branch last revision to an id not
1381
present in the repository. However, branches can also be
1382
configured to check constraints on history, in which case this may not
1385
revision_id = osutils.safe_revision_id(revision_id)
1386
history = self._lefthand_history(revision_id)
1387
assert len(history) == revno, '%d != %d' % (len(history), revno)
1388
self.set_revision_history(history)
1390
def _gen_revision_history(self):
1391
history = self.control_files.get('revision-history').read().split('\n')
1392
if history[-1:] == ['']:
1393
# There shouldn't be a trailing newline, but just in case.
1397
def _lefthand_history(self, revision_id, last_rev=None,
1399
# stop_revision must be a descendant of last_revision
1400
stop_graph = self.repository.get_revision_graph(revision_id)
1401
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1402
and last_rev not in stop_graph):
1403
# our previous tip is not merged into stop_revision
1404
raise errors.DivergedBranches(self, other_branch)
1405
# make a new revision history from the graph
1406
current_rev_id = revision_id
1408
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1409
new_history.append(current_rev_id)
1410
current_rev_id_parents = stop_graph[current_rev_id]
1412
current_rev_id = current_rev_id_parents[0]
1414
current_rev_id = None
1415
new_history.reverse()
1419
def generate_revision_history(self, revision_id, last_rev=None,
1421
"""Create a new revision history that will finish with revision_id.
1423
:param revision_id: the new tip to use.
1424
:param last_rev: The previous last_revision. If not None, then this
1425
must be a ancestory of revision_id, or DivergedBranches is raised.
1426
:param other_branch: The other branch that DivergedBranches should
1427
raise with respect to.
1429
revision_id = osutils.safe_revision_id(revision_id)
1430
self.set_revision_history(self._lefthand_history(revision_id,
1431
last_rev, other_branch))
1434
def update_revisions(self, other, stop_revision=None):
1435
"""See Branch.update_revisions."""
1438
if stop_revision is None:
1439
stop_revision = other.last_revision()
1440
if stop_revision is None:
1441
# if there are no commits, we're done.
1444
stop_revision = osutils.safe_revision_id(stop_revision)
1445
# whats the current last revision, before we fetch [and change it
1447
last_rev = _mod_revision.ensure_null(self.last_revision())
1448
# we fetch here regardless of whether we need to so that we pickup
1450
self.fetch(other, stop_revision)
1451
if self.repository.get_graph().is_ancestor(stop_revision,
1454
self.generate_revision_history(stop_revision, last_rev=last_rev,
1459
def basis_tree(self):
1460
"""See Branch.basis_tree."""
1461
return self.repository.revision_tree(self.last_revision())
1464
def pull(self, source, overwrite=False, stop_revision=None,
1465
_hook_master=None, run_hooks=True):
1468
:param _hook_master: Private parameter - set the branch to
1469
be supplied as the master to push hooks.
1470
:param run_hooks: Private parameter - if false, this branch
1471
is being called because it's the master of the primary branch,
1472
so it should not run its hooks.
1474
result = PullResult()
1475
result.source_branch = source
1476
result.target_branch = self
1479
result.old_revno, result.old_revid = self.last_revision_info()
1481
self.update_revisions(source, stop_revision)
1482
except DivergedBranches:
1486
if stop_revision is None:
1487
stop_revision = source.last_revision()
1488
self.generate_revision_history(stop_revision)
1489
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1490
result.new_revno, result.new_revid = self.last_revision_info()
1492
result.master_branch = _hook_master
1493
result.local_branch = self
1495
result.master_branch = self
1496
result.local_branch = None
1498
for hook in Branch.hooks['post_pull']:
1504
def _get_parent_location(self):
1505
_locs = ['parent', 'pull', 'x-pull']
1508
return self.control_files.get(l).read().strip('\n')
1514
def push(self, target, overwrite=False, stop_revision=None,
1515
_override_hook_source_branch=None):
1518
This is the basic concrete implementation of push()
1520
:param _override_hook_source_branch: If specified, run
1521
the hooks passing this Branch as the source, rather than self.
1522
This is for use of RemoteBranch, where push is delegated to the
1523
underlying vfs-based Branch.
1525
# TODO: Public option to disable running hooks - should be trivial but
1529
result = self._push_with_bound_branches(target, overwrite,
1531
_override_hook_source_branch=_override_hook_source_branch)
1536
def _push_with_bound_branches(self, target, overwrite,
1538
_override_hook_source_branch=None):
1539
"""Push from self into target, and into target's master if any.
1541
This is on the base BzrBranch class even though it doesn't support
1542
bound branches because the *target* might be bound.
1545
if _override_hook_source_branch:
1546
result.source_branch = _override_hook_source_branch
1547
for hook in Branch.hooks['post_push']:
1550
bound_location = target.get_bound_location()
1551
if bound_location and target.base != bound_location:
1552
# there is a master branch.
1554
# XXX: Why the second check? Is it even supported for a branch to
1555
# be bound to itself? -- mbp 20070507
1556
master_branch = target.get_master_branch()
1557
master_branch.lock_write()
1559
# push into the master from this branch.
1560
self._basic_push(master_branch, overwrite, stop_revision)
1561
# and push into the target branch from this. Note that we push from
1562
# this branch again, because its considered the highest bandwidth
1564
result = self._basic_push(target, overwrite, stop_revision)
1565
result.master_branch = master_branch
1566
result.local_branch = target
1570
master_branch.unlock()
1573
result = self._basic_push(target, overwrite, stop_revision)
1574
# TODO: Why set master_branch and local_branch if there's no
1575
# binding? Maybe cleaner to just leave them unset? -- mbp
1577
result.master_branch = target
1578
result.local_branch = None
1582
def _basic_push(self, target, overwrite, stop_revision):
1583
"""Basic implementation of push without bound branches or hooks.
1585
Must be called with self read locked and target write locked.
1587
result = PushResult()
1588
result.source_branch = self
1589
result.target_branch = target
1590
result.old_revno, result.old_revid = target.last_revision_info()
1592
target.update_revisions(self, stop_revision)
1593
except DivergedBranches:
1597
target.set_revision_history(self.revision_history())
1598
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1599
result.new_revno, result.new_revid = target.last_revision_info()
1602
def get_parent(self):
1603
"""See Branch.get_parent."""
1605
assert self.base[-1] == '/'
1606
parent = self._get_parent_location()
1609
# This is an old-format absolute path to a local branch
1610
# turn it into a url
1611
if parent.startswith('/'):
1612
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1614
return urlutils.join(self.base[:-1], parent)
1615
except errors.InvalidURLJoin, e:
1616
raise errors.InaccessibleParent(parent, self.base)
1618
def set_push_location(self, location):
1619
"""See Branch.set_push_location."""
1620
self.get_config().set_user_option(
1621
'push_location', location,
1622
store=_mod_config.STORE_LOCATION_NORECURSE)
1625
def set_parent(self, url):
1626
"""See Branch.set_parent."""
1627
# TODO: Maybe delete old location files?
1628
# URLs should never be unicode, even on the local fs,
1629
# FIXUP this and get_parent in a future branch format bump:
1630
# read and rewrite the file, and have the new format code read
1631
# using .get not .get_utf8. RBC 20060125
1633
if isinstance(url, unicode):
1635
url = url.encode('ascii')
1636
except UnicodeEncodeError:
1637
raise errors.InvalidURL(url,
1638
"Urls must be 7-bit ascii, "
1639
"use bzrlib.urlutils.escape")
1640
url = urlutils.relative_url(self.base, url)
1641
self._set_parent_location(url)
1643
def _set_parent_location(self, url):
1645
self.control_files._transport.delete('parent')
1647
assert isinstance(url, str)
1648
self.control_files.put_bytes('parent', url + '\n')
1651
class BzrBranch5(BzrBranch):
1652
"""A format 5 branch. This supports new features over plain branches.
1654
It has support for a master_branch which is the data for bound branches.
1662
super(BzrBranch5, self).__init__(_format=_format,
1663
_control_files=_control_files,
1665
_repository=_repository)
1668
def pull(self, source, overwrite=False, stop_revision=None,
1670
"""Pull from source into self, updating my master if any.
1672
:param run_hooks: Private parameter - if false, this branch
1673
is being called because it's the master of the primary branch,
1674
so it should not run its hooks.
1676
bound_location = self.get_bound_location()
1677
master_branch = None
1678
if bound_location and source.base != bound_location:
1679
# not pulling from master, so we need to update master.
1680
master_branch = self.get_master_branch()
1681
master_branch.lock_write()
1684
# pull from source into master.
1685
master_branch.pull(source, overwrite, stop_revision,
1687
return super(BzrBranch5, self).pull(source, overwrite,
1688
stop_revision, _hook_master=master_branch,
1689
run_hooks=run_hooks)
1692
master_branch.unlock()
1694
def get_bound_location(self):
1696
return self.control_files.get_utf8('bound').read()[:-1]
1697
except errors.NoSuchFile:
1701
def get_master_branch(self, possible_transports=None):
1702
"""Return the branch we are bound to.
1704
:return: Either a Branch, or None
1706
This could memoise the branch, but if thats done
1707
it must be revalidated on each new lock.
1708
So for now we just don't memoise it.
1709
# RBC 20060304 review this decision.
1711
bound_loc = self.get_bound_location()
1715
return Branch.open(bound_loc,
1716
possible_transports=possible_transports)
1717
except (errors.NotBranchError, errors.ConnectionError), e:
1718
raise errors.BoundBranchConnectionFailure(
1722
def set_bound_location(self, location):
1723
"""Set the target where this branch is bound to.
1725
:param location: URL to the target branch
1728
self.control_files.put_utf8('bound', location+'\n')
1731
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')
1737
def bind(self, other):
1738
"""Bind this branch to the branch other.
1740
This does not push or pull data between the branches, though it does
1741
check for divergence to raise an error when the branches are not
1742
either the same, or one a prefix of the other. That behaviour may not
1743
be useful, so that check may be removed in future.
1745
:param other: The branch to bind to
1748
# TODO: jam 20051230 Consider checking if the target is bound
1749
# It is debatable whether you should be able to bind to
1750
# a branch which is itself bound.
1751
# Committing is obviously forbidden,
1752
# but binding itself may not be.
1753
# Since we *have* to check at commit time, we don't
1754
# *need* to check here
1756
# we want to raise diverged if:
1757
# last_rev is not in the other_last_rev history, AND
1758
# other_last_rev is not in our history, and do it without pulling
1760
last_rev = _mod_revision.ensure_null(self.last_revision())
1761
if last_rev != _mod_revision.NULL_REVISION:
1764
other_last_rev = other.last_revision()
1765
if not _mod_revision.is_null(other_last_rev):
1766
# neither branch is new, we have to do some work to
1767
# ascertain diversion.
1768
remote_graph = other.repository.get_revision_graph(
1770
local_graph = self.repository.get_revision_graph(last_rev)
1771
if (last_rev not in remote_graph and
1772
other_last_rev not in local_graph):
1773
raise errors.DivergedBranches(self, other)
1776
self.set_bound_location(other.base)
1780
"""If bound, unbind"""
1781
return self.set_bound_location(None)
1784
def update(self, possible_transports=None):
1785
"""Synchronise this branch with the master branch if any.
1787
:return: None or the last_revision that was pivoted out during the
1790
master = self.get_master_branch(possible_transports)
1791
if master is not None:
1792
old_tip = _mod_revision.ensure_null(self.last_revision())
1793
self.pull(master, overwrite=True)
1794
if self.repository.get_graph().is_ancestor(old_tip,
1795
_mod_revision.ensure_null(self.last_revision())):
1801
class BzrBranchExperimental(BzrBranch5):
1802
"""Bzr experimental branch format
1805
- a revision-history file.
1807
- a lock dir guarding the branch itself
1808
- all of this stored in a branch/ subdirectory
1809
- works with shared repositories.
1810
- a tag dictionary in the branch
1812
This format is new in bzr 0.15, but shouldn't be used for real data,
1815
This class acts as it's own BranchFormat.
1818
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1821
def get_format_string(cls):
1822
"""See BranchFormat.get_format_string()."""
1823
return "Bazaar-NG branch format experimental\n"
1826
def get_format_description(cls):
1827
"""See BranchFormat.get_format_description()."""
1828
return "Experimental branch format"
1831
def get_reference(cls, a_bzrdir):
1832
"""Get the target reference of the branch in a_bzrdir.
1834
format probing must have been completed before calling
1835
this method - it is assumed that the format of the branch
1836
in a_bzrdir is correct.
1838
:param a_bzrdir: The bzrdir to get the branch data from.
1839
:return: None if the branch is not a reference branch.
1844
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1846
branch_transport = a_bzrdir.get_branch_transport(cls)
1847
control_files = lockable_files.LockableFiles(branch_transport,
1848
lock_filename, lock_class)
1849
control_files.create_lock()
1850
control_files.lock_write()
1852
for filename, content in utf8_files:
1853
control_files.put_utf8(filename, content)
1855
control_files.unlock()
1858
def initialize(cls, a_bzrdir):
1859
"""Create a branch of this format in a_bzrdir."""
1860
utf8_files = [('format', cls.get_format_string()),
1861
('revision-history', ''),
1862
('branch-name', ''),
1865
cls._initialize_control_files(a_bzrdir, utf8_files,
1866
'lock', lockdir.LockDir)
1867
return cls.open(a_bzrdir, _found=True)
1870
def open(cls, a_bzrdir, _found=False):
1871
"""Return the branch object for a_bzrdir
1873
_found is a private parameter, do not use it. It is used to indicate
1874
if format probing has already be done.
1877
format = BranchFormat.find_format(a_bzrdir)
1878
assert format.__class__ == cls
1879
transport = a_bzrdir.get_branch_transport(None)
1880
control_files = lockable_files.LockableFiles(transport, 'lock',
1882
return cls(_format=cls,
1883
_control_files=control_files,
1885
_repository=a_bzrdir.find_repository())
1888
def is_supported(cls):
1891
def _make_tags(self):
1892
return BasicTags(self)
1895
def supports_tags(cls):
1899
BranchFormat.register_format(BzrBranchExperimental)
1902
class BzrBranch6(BzrBranch5):
1905
def last_revision_info(self):
1906
revision_string = self.control_files.get('last-revision').read()
1907
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1908
revision_id = cache_utf8.get_cached_utf8(revision_id)
1910
return revno, revision_id
1912
def last_revision(self):
1913
"""Return last revision id, or None"""
1914
revision_id = self.last_revision_info()[1]
1917
def _write_last_revision_info(self, revno, revision_id):
1918
"""Simply write out the revision id, with no checks.
1920
Use set_last_revision_info to perform this safely.
1922
Does not update the revision_history cache.
1923
Intended to be called by set_last_revision_info and
1924
_write_revision_history.
1926
if revision_id is None:
1927
revision_id = 'null:'
1928
out_string = '%d %s\n' % (revno, revision_id)
1929
self.control_files.put_bytes('last-revision', out_string)
1932
def set_last_revision_info(self, revno, revision_id):
1933
revision_id = osutils.safe_revision_id(revision_id)
1934
if self._get_append_revisions_only():
1935
self._check_history_violation(revision_id)
1936
self._write_last_revision_info(revno, revision_id)
1937
self._clear_cached_state()
1939
def _check_history_violation(self, revision_id):
1940
last_revision = _mod_revision.ensure_null(self.last_revision())
1941
if _mod_revision.is_null(last_revision):
1943
if last_revision not in self._lefthand_history(revision_id):
1944
raise errors.AppendRevisionsOnlyViolation(self.base)
1946
def _gen_revision_history(self):
1947
"""Generate the revision history from last revision
1949
history = list(self.repository.iter_reverse_revision_history(
1950
self.last_revision()))
1954
def _write_revision_history(self, history):
1955
"""Factored out of set_revision_history.
1957
This performs the actual writing to disk, with format-specific checks.
1958
It is intended to be called by BzrBranch5.set_revision_history.
1960
if len(history) == 0:
1961
last_revision = 'null:'
1963
if history != self._lefthand_history(history[-1]):
1964
raise errors.NotLefthandHistory(history)
1965
last_revision = history[-1]
1966
if self._get_append_revisions_only():
1967
self._check_history_violation(last_revision)
1968
self._write_last_revision_info(len(history), last_revision)
1971
def _set_parent_location(self, url):
1972
"""Set the parent branch"""
1973
self._set_config_location('parent_location', url, make_relative=True)
1976
def _get_parent_location(self):
1977
"""Set the parent branch"""
1978
return self._get_config_location('parent_location')
1980
def set_push_location(self, location):
1981
"""See Branch.set_push_location."""
1982
self._set_config_location('push_location', location)
1984
def set_bound_location(self, location):
1985
"""See Branch.set_push_location."""
1987
config = self.get_config()
1988
if location is None:
1989
if config.get_user_option('bound') != 'True':
1992
config.set_user_option('bound', 'False', warn_masked=True)
1995
self._set_config_location('bound_location', location,
1997
config.set_user_option('bound', 'True', warn_masked=True)
2000
def _get_bound_location(self, bound):
2001
"""Return the bound location in the config file.
2003
Return None if the bound parameter does not match"""
2004
config = self.get_config()
2005
config_bound = (config.get_user_option('bound') == 'True')
2006
if config_bound != bound:
2008
return self._get_config_location('bound_location', config=config)
2010
def get_bound_location(self):
2011
"""See Branch.set_push_location."""
2012
return self._get_bound_location(True)
2014
def get_old_bound_location(self):
2015
"""See Branch.get_old_bound_location"""
2016
return self._get_bound_location(False)
2018
def set_append_revisions_only(self, enabled):
2023
self.get_config().set_user_option('append_revisions_only', value,
2026
def _get_append_revisions_only(self):
2027
value = self.get_config().get_user_option('append_revisions_only')
2028
return value == 'True'
2030
def _synchronize_history(self, destination, revision_id):
2031
"""Synchronize last revision and revision history between branches.
2033
This version is most efficient when the destination is also a
2034
BzrBranch6, but works for BzrBranch5, as long as the destination's
2035
repository contains all the lefthand ancestors of the intended
2036
last_revision. If not, set_last_revision_info will fail.
2038
:param destination: The branch to copy the history into
2039
:param revision_id: The revision-id to truncate history at. May
2040
be None to copy complete history.
2042
source_revno, source_revision_id = self.last_revision_info()
2043
if revision_id is None:
2044
revno, revision_id = source_revno, source_revision_id
2045
elif source_revision_id == revision_id:
2046
# we know the revno without needing to walk all of history
2047
revno = source_revno
2049
# To figure out the revno for a random revision, we need to build
2050
# the revision history, and count its length.
2051
# We don't care about the order, just how long it is.
2052
# Alternatively, we could start at the current location, and count
2053
# backwards. But there is no guarantee that we will find it since
2054
# it may be a merged revision.
2055
revno = len(list(self.repository.iter_reverse_revision_history(
2057
destination.set_last_revision_info(revno, revision_id)
2059
def _make_tags(self):
2060
return BasicTags(self)
2063
######################################################################
2064
# results of operations
2067
class _Result(object):
2069
def _show_tag_conficts(self, to_file):
2070
if not getattr(self, 'tag_conflicts', None):
2072
to_file.write('Conflicting tags:\n')
2073
for name, value1, value2 in self.tag_conflicts:
2074
to_file.write(' %s\n' % (name, ))
2077
class PullResult(_Result):
2078
"""Result of a Branch.pull operation.
2080
:ivar old_revno: Revision number before pull.
2081
:ivar new_revno: Revision number after pull.
2082
:ivar old_revid: Tip revision id before pull.
2083
:ivar new_revid: Tip revision id after pull.
2084
:ivar source_branch: Source (local) branch object.
2085
:ivar master_branch: Master branch of the target, or None.
2086
:ivar target_branch: Target/destination branch object.
2090
# DEPRECATED: pull used to return the change in revno
2091
return self.new_revno - self.old_revno
2093
def report(self, to_file):
2094
if self.old_revid == self.new_revid:
2095
to_file.write('No revisions to pull.\n')
2097
to_file.write('Now on revision %d.\n' % self.new_revno)
2098
self._show_tag_conficts(to_file)
2101
class PushResult(_Result):
2102
"""Result of a Branch.push operation.
2104
:ivar old_revno: Revision number before push.
2105
:ivar new_revno: Revision number after push.
2106
:ivar old_revid: Tip revision id before push.
2107
:ivar new_revid: Tip revision id after push.
2108
:ivar source_branch: Source branch object.
2109
:ivar master_branch: Master branch of the target, or None.
2110
:ivar target_branch: Target/destination branch object.
2114
# DEPRECATED: push used to return the change in revno
2115
return self.new_revno - self.old_revno
2117
def report(self, to_file):
2118
"""Write a human-readable description of the result."""
2119
if self.old_revid == self.new_revid:
2120
to_file.write('No new revisions to push.\n')
2122
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2123
self._show_tag_conficts(to_file)
2126
class BranchCheckResult(object):
2127
"""Results of checking branch consistency.
2132
def __init__(self, branch):
2133
self.branch = branch
2135
def report_results(self, verbose):
2136
"""Report the check results via trace.note.
2138
:param verbose: Requests more detailed display of what was checked,
2141
note('checked branch %s format %s',
2143
self.branch._format)
2146
class Converter5to6(object):
2147
"""Perform an in-place upgrade of format 5 to format 6"""
2149
def convert(self, branch):
2150
# Data for 5 and 6 can peacefully coexist.
2151
format = BzrBranchFormat6()
2152
new_branch = format.open(branch.bzrdir, _found=True)
2154
# Copy source data into target
2155
new_branch.set_last_revision_info(*branch.last_revision_info())
2156
new_branch.set_parent(branch.get_parent())
2157
new_branch.set_bound_location(branch.get_bound_location())
2158
new_branch.set_push_location(branch.get_push_location())
2160
# New branch has no tags by default
2161
new_branch.tags._set_tag_dict({})
2163
# Copying done; now update target format
2164
new_branch.control_files.put_utf8('format',
2165
format.get_format_string())
2167
# Clean up old files
2168
new_branch.control_files._transport.delete('revision-history')
2170
branch.set_parent(None)
2173
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
