137
86
"""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.
89
Base directory/url of the branch.
91
hooks: An instance of BranchHooks.
93
# 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.
97
# override this to set the strategy for storing tags
99
return DisabledTags(self)
101
def __init__(self, *ignored, **ignored_too):
102
self.tags = self._make_tags()
103
self._revision_history_cache = None
104
self._revision_id_to_revno_cache = None
106
def break_lock(self):
107
"""Break a lock if one is present from another instance.
109
Uses the ui factory to ask for confirmation if the lock may be from
112
This will probe the repository for its lock as well.
114
self.control_files.break_lock()
115
self.repository.break_lock()
116
master = self.get_master_branch()
117
if master is not None:
121
def open(base, _unsupported=False, possible_transports=None):
122
"""Open the branch rooted at base.
124
For instance, if the branch is at URL/.bzr/branch,
125
Branch.open(URL) -> a Branch instance.
127
control = bzrdir.BzrDir.open(base, _unsupported,
128
possible_transports=possible_transports)
129
return control.open_branch(_unsupported)
132
def open_from_transport(transport, _unsupported=False):
133
"""Open the branch rooted at transport"""
134
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
135
return control.open_branch(_unsupported)
138
def open_containing(url, possible_transports=None):
139
"""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.
141
This probes for a branch at url, and searches upwards from there.
143
Basically we keep looking up until we find the control directory or
144
run into the root. If there isn't one, raises NotBranchError.
145
If there is one and it is either an unrecognised format or an unsupported
146
format, UnknownFormatError or UnsupportedFormatError are raised.
147
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)
149
control, relpath = bzrdir.BzrDir.open_containing(url,
151
return control.open_branch(), relpath
153
def get_config(self):
154
return BranchConfig(self)
157
return self.get_config().get_nickname()
159
def _set_nick(self, nick):
160
self.get_config().set_user_option('nickname', nick, warn_masked=True)
162
nick = property(_get_nick, _set_nick)
165
raise NotImplementedError(self.is_locked)
212
167
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'
168
raise NotImplementedError(self.lock_write)
228
170
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'
171
raise NotImplementedError(self.lock_read)
242
173
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
174
raise NotImplementedError(self.unlock)
176
def peek_lock_mode(self):
177
"""Return lock mode for the Branch: 'r', 'w' or None"""
178
raise NotImplementedError(self.peek_lock_mode)
180
def get_physical_lock_status(self):
181
raise NotImplementedError(self.get_physical_lock_status)
184
def get_revision_id_to_revno_map(self):
185
"""Return the revision_id => dotted revno map.
187
This will be regenerated on demand, but will be cached.
189
:return: A dictionary mapping revision_id => dotted revno.
190
This dictionary should not be modified by the caller.
192
if self._revision_id_to_revno_cache is not None:
193
mapping = self._revision_id_to_revno_cache
252
self._lock_mode = self._lock_count = None
195
mapping = self._gen_revno_map()
196
self._cache_revision_id_to_revno(mapping)
197
# TODO: jam 20070417 Since this is being cached, should we be returning
199
# I would rather not, and instead just declare that users should not
200
# modify the return value.
203
def _gen_revno_map(self):
204
"""Create a new mapping from revision ids to dotted revnos.
206
Dotted revnos are generated based on the current tip in the revision
208
This is the worker function for get_revision_id_to_revno_map, which
209
just caches the return value.
211
:return: A dictionary mapping revision_id => dotted revno.
213
last_revision = self.last_revision()
214
revision_graph = self.repository.get_revision_graph(last_revision)
215
merge_sorted_revisions = tsort.merge_sort(
220
revision_id_to_revno = dict((rev_id, revno)
221
for seq_num, rev_id, depth, revno, end_of_merge
222
in merge_sorted_revisions)
223
return revision_id_to_revno
225
def leave_lock_in_place(self):
226
"""Tell this branch object not to release the physical lock when this
229
If lock_write doesn't return a token, then this method is not supported.
231
self.control_files.leave_in_place()
233
def dont_leave_lock_in_place(self):
234
"""Tell this branch object to release the physical lock when this
235
object is unlocked, even if it didn't originally acquire it.
237
If lock_write doesn't return a token, then this method is not supported.
239
self.control_files.dont_leave_in_place()
255
241
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
242
"""Return absolute filename for something in the branch
244
XXX: Robert Collins 20051017 what is this used for? why is it a branch
245
method and not a tree method.
247
raise NotImplementedError(self.abspath)
249
def bind(self, other):
250
"""Bind the local branch the other branch.
252
:param other: The branch to bind to
255
raise errors.UpgradeRequired(self.base)
258
def fetch(self, from_branch, last_revision=None, pb=None):
259
"""Copy revisions from from_branch into this branch.
261
:param from_branch: Where to copy from.
262
:param last_revision: What revision to stop at (None for at the end
264
:param pb: An optional progress bar to use.
266
Returns the copied revision count and the failed revisions in a tuple:
269
if self.base == from_branch.base:
272
nested_pb = ui.ui_factory.nested_progress_bar()
277
from_branch.lock_read()
279
if last_revision is None:
280
pb.update('get source history')
281
last_revision = from_branch.last_revision()
282
if last_revision is None:
283
last_revision = _mod_revision.NULL_REVISION
284
return self.repository.fetch(from_branch.repository,
285
revision_id=last_revision,
288
if nested_pb is not None:
292
def get_bound_location(self):
293
"""Return the URL of the branch we are bound to.
295
Older format branches cannot bind, please be sure to use a metadir
300
def get_old_bound_location(self):
301
"""Return the URL of the branch we used to be bound to
303
raise errors.UpgradeRequired(self.base)
305
def get_commit_builder(self, parents, config=None, timestamp=None,
306
timezone=None, committer=None, revprops=None,
308
"""Obtain a CommitBuilder for this branch.
310
:param parents: Revision ids of the parents of the new revision.
311
:param config: Optional configuration to use.
312
:param timestamp: Optional timestamp recorded for commit.
313
:param timezone: Optional timezone for timestamp.
314
:param committer: Optional committer to set for commit.
315
:param revprops: Optional dictionary of revision properties.
316
:param revision_id: Optional revision id.
320
config = self.get_config()
322
return self.repository.get_commit_builder(self, parents, config,
323
timestamp, timezone, committer, revprops, revision_id)
325
def get_master_branch(self, possible_transports=None):
326
"""Return the branch we are bound to.
328
:return: Either a Branch, or None
617
332
def get_revision_delta(self, revno):
618
333
"""Return the delta for one revision.
794
473
if stop_revision is None:
795
474
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
476
assert isinstance(stop_revision, int)
477
if stop_revision > other_len:
478
raise errors.NoSuchRevision(self, stop_revision)
799
479
return other_history[self_len:stop_revision]
802
481
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())
482
"""Pull in new perfect-fit revisions.
484
:param other: Another Branch to pull from
485
:param stop_revision: Updated until the given revision
488
raise NotImplementedError(self.update_revisions)
490
def revision_id_to_revno(self, revision_id):
491
"""Given a revision id, return its revno"""
492
if _mod_revision.is_null(revision_id):
494
revision_id = osutils.safe_revision_id(revision_id)
495
history = self.revision_history()
497
return history.index(revision_id) + 1
499
raise errors.NoSuchRevision(self, revision_id)
501
def get_rev_id(self, revno, history=None):
502
"""Find the revision id of the specified revno."""
504
return _mod_revision.NULL_REVISION
506
history = self.revision_history()
507
if revno <= 0 or revno > len(history):
508
raise errors.NoSuchRevision(self, revno)
509
return history[revno - 1]
511
def pull(self, source, overwrite=False, stop_revision=None,
512
possible_transports=None):
513
"""Mirror source into this branch.
515
This branch is considered to be 'local', having low latency.
517
:returns: PullResult instance
519
raise NotImplementedError(self.pull)
521
def push(self, target, overwrite=False, stop_revision=None):
522
"""Mirror this branch into target.
524
This branch is considered to be 'local', having low latency.
526
raise NotImplementedError(self.push)
1053
528
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))
529
"""Return `Tree` object for last revision."""
530
return self.repository.revision_tree(self.last_revision())
1066
532
def rename_one(self, from_rel, to_rel):
1067
533
"""Rename one file.
1069
535
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)
537
raise NotImplementedError(self.rename_one)
1117
539
def move(self, from_paths, to_name):
1118
540
"""Rename files.
1125
547
Note that to_name is only the last component of the new name;
1126
548
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:
550
This returns a list of (from_path, to_path) pairs for each
553
raise NotImplementedError(self.move)
555
def get_parent(self):
556
"""Return the parent location of the branch.
558
This is the default location for push/pull/missing. The usual
559
pattern is that the user can override it by specifying a
562
raise NotImplementedError(self.get_parent)
564
def _set_config_location(self, name, url, config=None,
565
make_relative=False):
567
config = self.get_config()
571
url = urlutils.relative_url(self.base, url)
572
config.set_user_option(name, url, warn_masked=True)
574
def _get_config_location(self, name, config=None):
576
config = self.get_config()
577
location = config.get_user_option(name)
582
def get_submit_branch(self):
583
"""Return the submit location of the branch.
585
This is the default location for bundle. The usual
586
pattern is that the user can override it by specifying a
589
return self.get_config().get_user_option('submit_branch')
591
def set_submit_branch(self, location):
592
"""Return the submit location of the branch.
594
This is the default location for bundle. The usual
595
pattern is that the user can override it by specifying a
598
self.get_config().set_user_option('submit_branch', location,
601
def get_public_branch(self):
602
"""Return the public location of the branch.
604
This is is used by merge directives.
606
return self._get_config_location('public_branch')
608
def set_public_branch(self, location):
609
"""Return the submit location of the branch.
611
This is the default location for bundle. The usual
612
pattern is that the user can override it by specifying a
615
self._set_config_location('public_branch', location)
617
def get_push_location(self):
618
"""Return the None or the location to push this branch to."""
619
push_loc = self.get_config().get_user_option('push_location')
622
def set_push_location(self, location):
623
"""Set a new push location for this branch."""
624
raise NotImplementedError(self.set_push_location)
626
def set_parent(self, url):
627
raise NotImplementedError(self.set_parent)
631
"""Synchronise this branch with the master branch if any.
633
:return: None or the last_revision pivoted out during the update.
637
def check_revno(self, revno):
639
Check whether a revno corresponds to any revision.
640
Zero (the NULL revision) is considered valid.
643
self.check_real_revno(revno)
645
def check_real_revno(self, revno):
647
Check whether a revno corresponds to a real revision.
648
Zero (the NULL revision) is considered invalid
650
if revno < 1 or revno > self.revno():
651
raise InvalidRevisionNumber(revno)
654
def clone(self, to_bzrdir, revision_id=None):
655
"""Clone this branch into to_bzrdir preserving all semantic values.
657
revision_id: if not None, the revision history in the new branch will
658
be truncated to end with revision_id.
660
result = self._format.initialize(to_bzrdir)
661
self.copy_content_into(result, revision_id=revision_id)
665
def sprout(self, to_bzrdir, revision_id=None):
666
"""Create a new line of development from the branch, into to_bzrdir.
668
revision_id: if not None, the revision history in the new branch will
669
be truncated to end with revision_id.
671
result = self._format.initialize(to_bzrdir)
672
self.copy_content_into(result, revision_id=revision_id)
673
result.set_parent(self.bzrdir.root_transport.base)
676
def _synchronize_history(self, destination, revision_id):
677
"""Synchronize last revision and revision history between branches.
679
This version is most efficient when the destination is also a
680
BzrBranch5, but works for BzrBranch6 as long as the revision
681
history is the true lefthand parent history, and all of the revisions
682
are in the destination's repository. If not, set_revision_history
685
:param destination: The branch to copy the history into
686
:param revision_id: The revision-id to truncate history at. May
687
be None to copy complete history.
689
if revision_id == _mod_revision.NULL_REVISION:
691
new_history = self.revision_history()
692
if revision_id is not None and new_history != []:
693
revision_id = osutils.safe_revision_id(revision_id)
695
new_history = new_history[:new_history.index(revision_id) + 1]
697
rev = self.repository.get_revision(revision_id)
698
new_history = rev.get_history(self.repository)[1:]
699
destination.set_revision_history(new_history)
702
def copy_content_into(self, destination, revision_id=None):
703
"""Copy the content of self into destination.
705
revision_id: if not None, the revision history in the new branch will
706
be truncated to end with revision_id.
708
self._synchronize_history(destination, revision_id)
710
parent = self.get_parent()
711
except errors.InaccessibleParent, e:
712
mutter('parent was not accessible to copy: %s', e)
715
destination.set_parent(parent)
716
self.tags.merge_to(destination.tags)
720
"""Check consistency of the branch.
722
In particular this checks that revisions given in the revision-history
723
do actually match up in the revision graph, and that they're all
724
present in the repository.
726
Callers will typically also want to check the repository.
728
:return: A BranchCheckResult.
730
mainline_parent_id = None
731
for revision_id in self.revision_history():
733
revision = self.repository.get_revision(revision_id)
734
except errors.NoSuchRevision, e:
735
raise errors.BzrCheckError("mainline revision {%s} not in repository"
737
# In general the first entry on the revision history has no parents.
738
# But it's not illegal for it to have parents listed; this can happen
739
# in imports from Arch when the parents weren't reachable.
740
if mainline_parent_id is not None:
741
if mainline_parent_id not in revision.parent_ids:
742
raise errors.BzrCheckError("previous revision {%s} not listed among "
744
% (mainline_parent_id, revision_id))
745
mainline_parent_id = revision_id
746
return BranchCheckResult(self)
748
def _get_checkout_format(self):
749
"""Return the most suitable metadir for a checkout of this branch.
750
Weaves are used if this branch's repository uses weaves.
752
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
753
from bzrlib.repofmt import weaverepo
754
format = bzrdir.BzrDirMetaFormat1()
755
format.repository_format = weaverepo.RepositoryFormat7()
757
format = self.repository.bzrdir.checkout_metadir()
758
format.set_branch_format(self._format)
761
def create_checkout(self, to_location, revision_id=None,
763
"""Create a checkout of a branch.
765
:param to_location: The url to produce the checkout at
766
:param revision_id: The revision to check out
767
:param lightweight: If True, produce a lightweight checkout, otherwise,
768
produce a bound branch (heavyweight checkout)
769
:return: The tree of the created checkout
771
t = transport.get_transport(to_location)
774
format = self._get_checkout_format()
775
checkout = format.initialize_on_transport(t)
776
BranchReferenceFormat().initialize(checkout, self)
778
format = self._get_checkout_format()
779
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
780
to_location, force_new_tree=False, format=format)
781
checkout = checkout_branch.bzrdir
782
checkout_branch.bind(self)
783
# pull up to the specified revision_id to set the initial
784
# branch tip correctly, and seed it with history.
785
checkout_branch.pull(self, stop_revision=revision_id)
786
tree = checkout.create_workingtree(revision_id)
787
basis_tree = tree.basis_tree()
788
basis_tree.lock_read()
790
for path, file_id in basis_tree.iter_references():
791
reference_parent = self.reference_parent(file_id, path)
792
reference_parent.create_checkout(tree.abspath(path),
793
basis_tree.get_reference_revision(file_id, path),
799
def reference_parent(self, file_id, path):
800
"""Return the parent branch for a tree-reference file_id
801
:param file_id: The file_id of the tree reference
802
:param path: The path of the file_id in the tree
803
:return: A branch associated with the file_id
805
# FIXME should provide multiple branches, based on config
806
return Branch.open(self.bzrdir.root_transport.clone(path).base)
808
def supports_tags(self):
809
return self._format.supports_tags()
812
class BranchFormat(object):
813
"""An encapsulation of the initialization and open routines for a format.
815
Formats provide three things:
816
* An initialization routine,
820
Formats are placed in an dict by their format string for reference
821
during branch opening. Its not required that these be instances, they
822
can be classes themselves with class methods - it simply depends on
823
whether state is needed for a given format or not.
825
Once a format is deprecated, just deprecate the initialize and open
826
methods on the format class. Do not deprecate the object, as the
827
object will be created every time regardless.
830
_default_format = None
831
"""The default format used for new branches."""
834
"""The known formats."""
836
def __eq__(self, other):
837
return self.__class__ is other.__class__
839
def __ne__(self, other):
840
return not (self == other)
843
def find_format(klass, a_bzrdir):
844
"""Return the format for the branch object in a_bzrdir."""
846
transport = a_bzrdir.get_branch_transport(None)
847
format_string = transport.get("format").read()
848
return klass._formats[format_string]
850
raise NotBranchError(path=transport.base)
852
raise errors.UnknownFormatError(format=format_string)
855
def get_default_format(klass):
856
"""Return the current default format."""
857
return klass._default_format
859
def get_reference(self, a_bzrdir):
860
"""Get the target reference of the branch in a_bzrdir.
862
format probing must have been completed before calling
863
this method - it is assumed that the format of the branch
864
in a_bzrdir is correct.
866
:param a_bzrdir: The bzrdir to get the branch data from.
867
:return: None if the branch is not a reference branch.
871
def get_format_string(self):
872
"""Return the ASCII format string that identifies this format."""
873
raise NotImplementedError(self.get_format_string)
875
def get_format_description(self):
876
"""Return the short format description for this format."""
877
raise NotImplementedError(self.get_format_description)
879
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
881
"""Initialize a branch in a bzrdir, with specified files
883
:param a_bzrdir: The bzrdir to initialize the branch in
884
:param utf8_files: The files to create as a list of
885
(filename, content) tuples
886
:param set_format: If True, set the format with
887
self.get_format_string. (BzrBranch4 has its format set
889
:return: a branch in this format
891
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
892
branch_transport = a_bzrdir.get_branch_transport(self)
894
'metadir': ('lock', lockdir.LockDir),
895
'branch4': ('branch-lock', lockable_files.TransportLock),
897
lock_name, lock_class = lock_map[lock_type]
898
control_files = lockable_files.LockableFiles(branch_transport,
899
lock_name, lock_class)
900
control_files.create_lock()
901
control_files.lock_write()
903
control_files.put_utf8('format', self.get_format_string())
905
for file, content in utf8_files:
906
control_files.put_utf8(file, content)
908
control_files.unlock()
909
return self.open(a_bzrdir, _found=True)
911
def initialize(self, a_bzrdir):
912
"""Create a branch of this format in a_bzrdir."""
913
raise NotImplementedError(self.initialize)
915
def is_supported(self):
916
"""Is this format supported?
918
Supported formats can be initialized and opened.
919
Unsupported formats may not support initialization or committing or
920
some other features depending on the reason for not being supported.
924
def open(self, a_bzrdir, _found=False):
925
"""Return the branch object for a_bzrdir
927
_found is a private parameter, do not use it. It is used to indicate
928
if format probing has already be done.
930
raise NotImplementedError(self.open)
933
def register_format(klass, format):
934
klass._formats[format.get_format_string()] = format
937
def set_default_format(klass, format):
938
klass._default_format = format
941
def unregister_format(klass, format):
942
assert klass._formats[format.get_format_string()] is format
943
del klass._formats[format.get_format_string()]
946
return self.get_format_string().rstrip()
948
def supports_tags(self):
949
"""True if this format supports tags stored in the branch"""
950
return False # by default
952
# XXX: Probably doesn't really belong here -- mbp 20070212
953
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
955
branch_transport = a_bzrdir.get_branch_transport(self)
956
control_files = lockable_files.LockableFiles(branch_transport,
957
lock_filename, lock_class)
958
control_files.create_lock()
959
control_files.lock_write()
961
for filename, content in utf8_files:
962
control_files.put_utf8(filename, content)
964
control_files.unlock()
967
class BranchHooks(Hooks):
968
"""A dictionary mapping hook name to a list of callables for branch hooks.
970
e.g. ['set_rh'] Is the list of items to be called when the
971
set_revision_history function is invoked.
975
"""Create the default hooks.
977
These are all empty initially, because by default nothing should get
981
# Introduced in 0.15:
982
# invoked whenever the revision history has been set
983
# with set_revision_history. The api signature is
984
# (branch, revision_history), and the branch will
987
# invoked after a push operation completes.
988
# the api signature is
990
# containing the members
991
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
992
# where local is the local target branch or None, master is the target
993
# master branch, and the rest should be self explanatory. The source
994
# is read locked and the target branches write locked. Source will
995
# be the local low-latency branch.
996
self['post_push'] = []
997
# invoked after a pull operation completes.
998
# the api signature is
1000
# containing the members
1001
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1002
# where local is the local branch or None, master is the target
1003
# master branch, and the rest should be self explanatory. The source
1004
# is read locked and the target branches write locked. The local
1005
# branch is the low-latency branch.
1006
self['post_pull'] = []
1007
# invoked before a commit operation takes place.
1008
# the api signature is
1009
# (local, master, old_revno, old_revid, future_revno, future_revid,
1010
# tree_delta, future_tree).
1011
# old_revid is NULL_REVISION for the first commit to a branch
1012
# tree_delta is a TreeDelta object describing changes from the basis
1013
# revision, hooks MUST NOT modify this delta
1014
# future_tree is an in-memory tree obtained from
1015
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1016
self['pre_commit'] = []
1017
# invoked after a commit operation completes.
1018
# the api signature is
1019
# (local, master, old_revno, old_revid, new_revno, new_revid)
1020
# old_revid is NULL_REVISION for the first commit to a branch.
1021
self['post_commit'] = []
1022
# invoked after a uncommit operation completes.
1023
# the api signature is
1024
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1025
# local is the local branch or None, master is the target branch,
1026
# and an empty branch recieves new_revno of 0, new_revid of None.
1027
self['post_uncommit'] = []
1030
# install the default hooks into the Branch class.
1031
Branch.hooks = BranchHooks()
1034
class BzrBranchFormat4(BranchFormat):
1035
"""Bzr branch format 4.
1038
- a revision-history file.
1039
- a branch-lock lock file [ to be shared with the bzrdir ]
1042
def get_format_description(self):
1043
"""See BranchFormat.get_format_description()."""
1044
return "Branch format 4"
1046
def initialize(self, a_bzrdir):
1047
"""Create a branch of this format in a_bzrdir."""
1048
utf8_files = [('revision-history', ''),
1049
('branch-name', ''),
1051
return self._initialize_helper(a_bzrdir, utf8_files,
1052
lock_type='branch4', set_format=False)
1055
super(BzrBranchFormat4, self).__init__()
1056
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1058
def open(self, a_bzrdir, _found=False):
1059
"""Return the branch object for a_bzrdir
1061
_found is a private parameter, do not use it. It is used to indicate
1062
if format probing has already be done.
1065
# we are being called directly and must probe.
1066
raise NotImplementedError
1067
return BzrBranch(_format=self,
1068
_control_files=a_bzrdir._control_files,
1070
_repository=a_bzrdir.open_repository())
1073
return "Bazaar-NG branch format 4"
1076
class BzrBranchFormat5(BranchFormat):
1077
"""Bzr branch format 5.
1080
- a revision-history file.
1082
- a lock dir guarding the branch itself
1083
- all of this stored in a branch/ subdirectory
1084
- works with shared repositories.
1086
This format is new in bzr 0.8.
1089
def get_format_string(self):
1090
"""See BranchFormat.get_format_string()."""
1091
return "Bazaar-NG branch format 5\n"
1093
def get_format_description(self):
1094
"""See BranchFormat.get_format_description()."""
1095
return "Branch format 5"
1097
def initialize(self, a_bzrdir):
1098
"""Create a branch of this format in a_bzrdir."""
1099
utf8_files = [('revision-history', ''),
1100
('branch-name', ''),
1102
return self._initialize_helper(a_bzrdir, utf8_files)
1105
super(BzrBranchFormat5, self).__init__()
1106
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1108
def open(self, a_bzrdir, _found=False):
1109
"""Return the branch object for a_bzrdir
1111
_found is a private parameter, do not use it. It is used to indicate
1112
if format probing has already be done.
1115
format = BranchFormat.find_format(a_bzrdir)
1116
assert format.__class__ == self.__class__
1118
transport = a_bzrdir.get_branch_transport(None)
1119
control_files = lockable_files.LockableFiles(transport, 'lock',
1121
return BzrBranch5(_format=self,
1122
_control_files=control_files,
1124
_repository=a_bzrdir.find_repository())
1126
raise NotBranchError(path=transport.base)
1129
class BzrBranchFormat6(BzrBranchFormat5):
1130
"""Branch format with last-revision and tags.
1132
Unlike previous formats, this has no explicit revision history. Instead,
1133
this just stores the last-revision, and the left-hand history leading
1134
up to there is the history.
1136
This format was introduced in bzr 0.15
1137
and became the default in 0.91.
1140
def get_format_string(self):
1141
"""See BranchFormat.get_format_string()."""
1142
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1144
def get_format_description(self):
1145
"""See BranchFormat.get_format_description()."""
1146
return "Branch format 6"
1148
def initialize(self, a_bzrdir):
1149
"""Create a branch of this format in a_bzrdir."""
1150
utf8_files = [('last-revision', '0 null:\n'),
1151
('branch-name', ''),
1152
('branch.conf', ''),
1155
return self._initialize_helper(a_bzrdir, utf8_files)
1157
def open(self, a_bzrdir, _found=False):
1158
"""Return the branch object for a_bzrdir
1160
_found is a private parameter, do not use it. It is used to indicate
1161
if format probing has already be done.
1164
format = BranchFormat.find_format(a_bzrdir)
1165
assert format.__class__ == self.__class__
1166
transport = a_bzrdir.get_branch_transport(None)
1167
control_files = lockable_files.LockableFiles(transport, 'lock',
1169
return BzrBranch6(_format=self,
1170
_control_files=control_files,
1172
_repository=a_bzrdir.find_repository())
1174
def supports_tags(self):
1178
class BranchReferenceFormat(BranchFormat):
1179
"""Bzr branch reference format.
1181
Branch references are used in implementing checkouts, they
1182
act as an alias to the real branch which is at some other url.
1189
def get_format_string(self):
1190
"""See BranchFormat.get_format_string()."""
1191
return "Bazaar-NG Branch Reference Format 1\n"
1193
def get_format_description(self):
1194
"""See BranchFormat.get_format_description()."""
1195
return "Checkout reference format 1"
1197
def get_reference(self, a_bzrdir):
1198
"""See BranchFormat.get_reference()."""
1199
transport = a_bzrdir.get_branch_transport(None)
1200
return transport.get('location').read()
1202
def initialize(self, a_bzrdir, target_branch=None):
1203
"""Create a branch of this format in a_bzrdir."""
1204
if target_branch is None:
1205
# this format does not implement branch itself, thus the implicit
1206
# creation contract must see it as uninitializable
1207
raise errors.UninitializableFormat(self)
1208
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1209
branch_transport = a_bzrdir.get_branch_transport(self)
1210
branch_transport.put_bytes('location',
1211
target_branch.bzrdir.root_transport.base)
1212
branch_transport.put_bytes('format', self.get_format_string())
1213
return self.open(a_bzrdir, _found=True)
1216
super(BranchReferenceFormat, self).__init__()
1217
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1219
def _make_reference_clone_function(format, a_branch):
1220
"""Create a clone() routine for a branch dynamically."""
1221
def clone(to_bzrdir, revision_id=None):
1222
"""See Branch.clone()."""
1223
return format.initialize(to_bzrdir, a_branch)
1224
# cannot obey revision_id limits when cloning a reference ...
1225
# FIXME RBC 20060210 either nuke revision_id for clone, or
1226
# emit some sort of warning/error to the caller ?!
1229
def open(self, a_bzrdir, _found=False, location=None):
1230
"""Return the branch that the branch reference in a_bzrdir points at.
1232
_found is a private parameter, do not use it. It is used to indicate
1233
if format probing has already be done.
1236
format = BranchFormat.find_format(a_bzrdir)
1237
assert format.__class__ == self.__class__
1238
if location is None:
1239
location = self.get_reference(a_bzrdir)
1240
real_bzrdir = bzrdir.BzrDir.open(location)
1241
result = real_bzrdir.open_branch()
1242
# this changes the behaviour of result.clone to create a new reference
1243
# rather than a copy of the content of the branch.
1244
# I did not use a proxy object because that needs much more extensive
1245
# testing, and we are only changing one behaviour at the moment.
1246
# If we decide to alter more behaviours - i.e. the implicit nickname
1247
# then this should be refactored to introduce a tested proxy branch
1248
# and a subclass of that for use in overriding clone() and ....
1250
result.clone = self._make_reference_clone_function(result)
1254
# formats which have no format string are not discoverable
1255
# and not independently creatable, so are not registered.
1256
__format5 = BzrBranchFormat5()
1257
__format6 = BzrBranchFormat6()
1258
BranchFormat.register_format(__format5)
1259
BranchFormat.register_format(BranchReferenceFormat())
1260
BranchFormat.register_format(__format6)
1261
BranchFormat.set_default_format(__format6)
1262
_legacy_formats = [BzrBranchFormat4(),
1265
class BzrBranch(Branch):
1266
"""A branch stored in the actual filesystem.
1268
Note that it's "local" in the context of the filesystem; it doesn't
1269
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1270
it's writable, and can be accessed via the normal filesystem API.
1273
def __init__(self, _format=None,
1274
_control_files=None, a_bzrdir=None, _repository=None):
1275
"""Create new branch object at a particular location."""
1276
Branch.__init__(self)
1277
if a_bzrdir is None:
1278
raise ValueError('a_bzrdir must be supplied')
1280
self.bzrdir = a_bzrdir
1281
# self._transport used to point to the directory containing the
1282
# control directory, but was not used - now it's just the transport
1283
# for the branch control files. mbp 20070212
1284
self._base = self.bzrdir.transport.clone('..').base
1285
self._format = _format
1286
if _control_files is None:
1287
raise ValueError('BzrBranch _control_files is None')
1288
self.control_files = _control_files
1289
self._transport = _control_files._transport
1290
self.repository = _repository
1293
return '%s(%r)' % (self.__class__.__name__, self.base)
1297
def _get_base(self):
1298
"""Returns the directory containing the control directory."""
1301
base = property(_get_base, doc="The URL for the root of this branch.")
1303
def abspath(self, name):
1304
"""See Branch.abspath."""
1305
return self.control_files._transport.abspath(name)
1308
@deprecated_method(zero_sixteen)
1310
def get_root_id(self):
1311
"""See Branch.get_root_id."""
1312
tree = self.repository.revision_tree(self.last_revision())
1313
return tree.inventory.root.file_id
1315
def is_locked(self):
1316
return self.control_files.is_locked()
1318
def lock_write(self, token=None):
1319
repo_token = self.repository.lock_write()
1321
token = self.control_files.lock_write(token=token)
1323
self.repository.unlock()
1327
def lock_read(self):
1328
self.repository.lock_read()
1330
self.control_files.lock_read()
1332
self.repository.unlock()
1336
# TODO: test for failed two phase locks. This is known broken.
1338
self.control_files.unlock()
1340
self.repository.unlock()
1341
if not self.control_files.is_locked():
1342
# we just released the lock
1343
self._clear_cached_state()
1345
def peek_lock_mode(self):
1346
if self.control_files._lock_count == 0:
1349
return self.control_files._lock_mode
1351
def get_physical_lock_status(self):
1352
return self.control_files.get_physical_lock_status()
1355
def print_file(self, file, revision_id):
1356
"""See Branch.print_file."""
1357
return self.repository.print_file(file, revision_id)
1359
def _write_revision_history(self, history):
1360
"""Factored out of set_revision_history.
1362
This performs the actual writing to disk.
1363
It is intended to be called by BzrBranch5.set_revision_history."""
1364
self.control_files.put_bytes(
1365
'revision-history', '\n'.join(history))
1368
def set_revision_history(self, rev_history):
1369
"""See Branch.set_revision_history."""
1370
if 'evil' in debug.debug_flags:
1371
mutter_callsite(3, "set_revision_history scales with history.")
1372
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1373
self._clear_cached_state()
1374
self._write_revision_history(rev_history)
1375
self._cache_revision_history(rev_history)
1376
for hook in Branch.hooks['set_rh']:
1377
hook(self, rev_history)
1380
def set_last_revision_info(self, revno, revision_id):
1381
"""Set the last revision of this branch.
1383
The caller is responsible for checking that the revno is correct
1384
for this revision id.
1386
It may be possible to set the branch last revision to an id not
1387
present in the repository. However, branches can also be
1388
configured to check constraints on history, in which case this may not
1391
revision_id = osutils.safe_revision_id(revision_id)
1392
history = self._lefthand_history(revision_id)
1393
assert len(history) == revno, '%d != %d' % (len(history), revno)
1394
self.set_revision_history(history)
1396
def _gen_revision_history(self):
1397
history = self.control_files.get('revision-history').read().split('\n')
1398
if history[-1:] == ['']:
1399
# There shouldn't be a trailing newline, but just in case.
1403
def _lefthand_history(self, revision_id, last_rev=None,
1405
if 'evil' in debug.debug_flags:
1406
mutter_callsite(4, "_lefthand_history scales with history.")
1407
# stop_revision must be a descendant of last_revision
1408
stop_graph = self.repository.get_revision_graph(revision_id)
1409
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1410
and last_rev not in stop_graph):
1411
# our previous tip is not merged into stop_revision
1412
raise errors.DivergedBranches(self, other_branch)
1413
# make a new revision history from the graph
1414
current_rev_id = revision_id
1416
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1417
new_history.append(current_rev_id)
1418
current_rev_id_parents = stop_graph[current_rev_id]
1420
current_rev_id = current_rev_id_parents[0]
1422
current_rev_id = None
1423
new_history.reverse()
1427
def generate_revision_history(self, revision_id, last_rev=None,
1429
"""Create a new revision history that will finish with revision_id.
1431
:param revision_id: the new tip to use.
1432
:param last_rev: The previous last_revision. If not None, then this
1433
must be a ancestory of revision_id, or DivergedBranches is raised.
1434
:param other_branch: The other branch that DivergedBranches should
1435
raise with respect to.
1437
revision_id = osutils.safe_revision_id(revision_id)
1438
self.set_revision_history(self._lefthand_history(revision_id,
1439
last_rev, other_branch))
1442
def update_revisions(self, other, stop_revision=None):
1443
"""See Branch.update_revisions."""
1446
if stop_revision is None:
1447
stop_revision = other.last_revision()
1448
if stop_revision is None:
1449
# if there are no commits, we're done.
1452
stop_revision = osutils.safe_revision_id(stop_revision)
1453
# whats the current last revision, before we fetch [and change it
1455
last_rev = _mod_revision.ensure_null(self.last_revision())
1456
# we fetch here so that we don't process data twice in the common
1457
# case of having something to pull, and so that the check for
1458
# already merged can operate on the just fetched graph, which will
1459
# be cached in memory.
1460
self.fetch(other, stop_revision)
1461
if self.repository.get_graph().is_ancestor(stop_revision,
1464
self.generate_revision_history(stop_revision, last_rev=last_rev,
1469
def basis_tree(self):
1470
"""See Branch.basis_tree."""
1471
return self.repository.revision_tree(self.last_revision())
1474
def pull(self, source, overwrite=False, stop_revision=None,
1475
_hook_master=None, run_hooks=True, possible_transports=None):
1478
:param _hook_master: Private parameter - set the branch to
1479
be supplied as the master to push hooks.
1480
:param run_hooks: Private parameter - if false, this branch
1481
is being called because it's the master of the primary branch,
1482
so it should not run its hooks.
1484
result = PullResult()
1485
result.source_branch = source
1486
result.target_branch = self
1489
result.old_revno, result.old_revid = self.last_revision_info()
1491
self.update_revisions(source, stop_revision)
1492
except DivergedBranches:
1496
if stop_revision is None:
1497
stop_revision = source.last_revision()
1498
self.generate_revision_history(stop_revision)
1499
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1500
result.new_revno, result.new_revid = self.last_revision_info()
1502
result.master_branch = _hook_master
1503
result.local_branch = self
1505
result.master_branch = self
1506
result.local_branch = None
1508
for hook in Branch.hooks['post_pull']:
1514
def _get_parent_location(self):
1515
_locs = ['parent', 'pull', 'x-pull']
1518
return self.control_files.get(l).read().strip('\n')
1524
def push(self, target, overwrite=False, stop_revision=None,
1525
_override_hook_source_branch=None):
1528
This is the basic concrete implementation of push()
1530
:param _override_hook_source_branch: If specified, run
1531
the hooks passing this Branch as the source, rather than self.
1532
This is for use of RemoteBranch, where push is delegated to the
1533
underlying vfs-based Branch.
1535
# TODO: Public option to disable running hooks - should be trivial but
1539
result = self._push_with_bound_branches(target, overwrite,
1541
_override_hook_source_branch=_override_hook_source_branch)
1546
def _push_with_bound_branches(self, target, overwrite,
1548
_override_hook_source_branch=None):
1549
"""Push from self into target, and into target's master if any.
1551
This is on the base BzrBranch class even though it doesn't support
1552
bound branches because the *target* might be bound.
1555
if _override_hook_source_branch:
1556
result.source_branch = _override_hook_source_branch
1557
for hook in Branch.hooks['post_push']:
1560
bound_location = target.get_bound_location()
1561
if bound_location and target.base != bound_location:
1562
# there is a master branch.
1564
# XXX: Why the second check? Is it even supported for a branch to
1565
# be bound to itself? -- mbp 20070507
1566
master_branch = target.get_master_branch()
1567
master_branch.lock_write()
1569
# push into the master from this branch.
1570
self._basic_push(master_branch, overwrite, stop_revision)
1571
# and push into the target branch from this. Note that we push from
1572
# this branch again, because its considered the highest bandwidth
1574
result = self._basic_push(target, overwrite, stop_revision)
1575
result.master_branch = master_branch
1576
result.local_branch = target
1580
master_branch.unlock()
1583
result = self._basic_push(target, overwrite, stop_revision)
1584
# TODO: Why set master_branch and local_branch if there's no
1585
# binding? Maybe cleaner to just leave them unset? -- mbp
1587
result.master_branch = target
1588
result.local_branch = None
1592
def _basic_push(self, target, overwrite, stop_revision):
1593
"""Basic implementation of push without bound branches or hooks.
1595
Must be called with self read locked and target write locked.
1597
result = PushResult()
1598
result.source_branch = self
1599
result.target_branch = target
1600
result.old_revno, result.old_revid = target.last_revision_info()
1602
target.update_revisions(self, stop_revision)
1603
except DivergedBranches:
1607
target.set_revision_history(self.revision_history())
1608
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1609
result.new_revno, result.new_revid = target.last_revision_info()
1612
def get_parent(self):
1613
"""See Branch.get_parent."""
1615
assert self.base[-1] == '/'
1616
parent = self._get_parent_location()
1619
# This is an old-format absolute path to a local branch
1620
# turn it into a url
1621
if parent.startswith('/'):
1622
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1624
return urlutils.join(self.base[:-1], parent)
1625
except errors.InvalidURLJoin, e:
1626
raise errors.InaccessibleParent(parent, self.base)
1628
def set_push_location(self, location):
1629
"""See Branch.set_push_location."""
1630
self.get_config().set_user_option(
1631
'push_location', location,
1632
store=_mod_config.STORE_LOCATION_NORECURSE)
1635
def set_parent(self, url):
1636
"""See Branch.set_parent."""
1637
# TODO: Maybe delete old location files?
1638
# URLs should never be unicode, even on the local fs,
1639
# FIXUP this and get_parent in a future branch format bump:
1640
# read and rewrite the file, and have the new format code read
1641
# using .get not .get_utf8. RBC 20060125
1643
if isinstance(url, unicode):
1645
url = url.encode('ascii')
1646
except UnicodeEncodeError:
1647
raise errors.InvalidURL(url,
1648
"Urls must be 7-bit ascii, "
1649
"use bzrlib.urlutils.escape")
1650
url = urlutils.relative_url(self.base, url)
1651
self._set_parent_location(url)
1653
def _set_parent_location(self, url):
1655
self.control_files._transport.delete('parent')
1657
assert isinstance(url, str)
1658
self.control_files.put_bytes('parent', url + '\n')
1661
class BzrBranch5(BzrBranch):
1662
"""A format 5 branch. This supports new features over plain branches.
1664
It has support for a master_branch which is the data for bound branches.
1672
super(BzrBranch5, self).__init__(_format=_format,
1673
_control_files=_control_files,
1675
_repository=_repository)
1678
def pull(self, source, overwrite=False, stop_revision=None,
1679
run_hooks=True, possible_transports=None):
1680
"""Pull from source into self, updating my master if any.
1682
:param run_hooks: Private parameter - if false, this branch
1683
is being called because it's the master of the primary branch,
1684
so it should not run its hooks.
1686
bound_location = self.get_bound_location()
1687
master_branch = None
1688
if bound_location and source.base != bound_location:
1689
# not pulling from master, so we need to update master.
1690
master_branch = self.get_master_branch(possible_transports)
1691
master_branch.lock_write()
1694
# pull from source into master.
1695
master_branch.pull(source, overwrite, stop_revision,
1697
return super(BzrBranch5, self).pull(source, overwrite,
1698
stop_revision, _hook_master=master_branch,
1699
run_hooks=run_hooks)
1702
master_branch.unlock()
1704
def get_bound_location(self):
1706
return self.control_files.get_utf8('bound').read()[:-1]
1707
except errors.NoSuchFile:
1711
def get_master_branch(self, possible_transports=None):
1712
"""Return the branch we are bound to.
1714
:return: Either a Branch, or None
1716
This could memoise the branch, but if thats done
1717
it must be revalidated on each new lock.
1718
So for now we just don't memoise it.
1719
# RBC 20060304 review this decision.
1721
bound_loc = self.get_bound_location()
1725
return Branch.open(bound_loc,
1726
possible_transports=possible_transports)
1727
except (errors.NotBranchError, errors.ConnectionError), e:
1728
raise errors.BoundBranchConnectionFailure(
1732
def set_bound_location(self, location):
1733
"""Set the target where this branch is bound to.
1735
:param location: URL to the target branch
1738
self.control_files.put_utf8('bound', location+'\n')
1741
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')
1747
def bind(self, other):
1748
"""Bind this branch to the branch other.
1750
This does not push or pull data between the branches, though it does
1751
check for divergence to raise an error when the branches are not
1752
either the same, or one a prefix of the other. That behaviour may not
1753
be useful, so that check may be removed in future.
1755
:param other: The branch to bind to
1758
# TODO: jam 20051230 Consider checking if the target is bound
1759
# It is debatable whether you should be able to bind to
1760
# a branch which is itself bound.
1761
# Committing is obviously forbidden,
1762
# but binding itself may not be.
1763
# Since we *have* to check at commit time, we don't
1764
# *need* to check here
1766
# we want to raise diverged if:
1767
# last_rev is not in the other_last_rev history, AND
1768
# other_last_rev is not in our history, and do it without pulling
1770
last_rev = _mod_revision.ensure_null(self.last_revision())
1771
if last_rev != _mod_revision.NULL_REVISION:
1774
other_last_rev = other.last_revision()
1775
if not _mod_revision.is_null(other_last_rev):
1776
# neither branch is new, we have to do some work to
1777
# ascertain diversion.
1778
remote_graph = other.repository.get_revision_graph(
1780
local_graph = self.repository.get_revision_graph(last_rev)
1781
if (last_rev not in remote_graph and
1782
other_last_rev not in local_graph):
1783
raise errors.DivergedBranches(self, other)
1786
self.set_bound_location(other.base)
1790
"""If bound, unbind"""
1791
return self.set_bound_location(None)
1794
def update(self, possible_transports=None):
1795
"""Synchronise this branch with the master branch if any.
1797
:return: None or the last_revision that was pivoted out during the
1800
master = self.get_master_branch(possible_transports)
1801
if master is not None:
1802
old_tip = _mod_revision.ensure_null(self.last_revision())
1803
self.pull(master, overwrite=True)
1804
if self.repository.get_graph().is_ancestor(old_tip,
1805
_mod_revision.ensure_null(self.last_revision())):
1811
class BzrBranchExperimental(BzrBranch5):
1812
"""Bzr experimental branch format
1815
- a revision-history file.
1817
- a lock dir guarding the branch itself
1818
- all of this stored in a branch/ subdirectory
1819
- works with shared repositories.
1820
- a tag dictionary in the branch
1822
This format is new in bzr 0.15, but shouldn't be used for real data,
1825
This class acts as it's own BranchFormat.
1828
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1831
def get_format_string(cls):
1832
"""See BranchFormat.get_format_string()."""
1833
return "Bazaar-NG branch format experimental\n"
1836
def get_format_description(cls):
1837
"""See BranchFormat.get_format_description()."""
1838
return "Experimental branch format"
1841
def get_reference(cls, a_bzrdir):
1842
"""Get the target reference of the branch in a_bzrdir.
1844
format probing must have been completed before calling
1845
this method - it is assumed that the format of the branch
1846
in a_bzrdir is correct.
1848
:param a_bzrdir: The bzrdir to get the branch data from.
1849
:return: None if the branch is not a reference branch.
1854
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1856
branch_transport = a_bzrdir.get_branch_transport(cls)
1857
control_files = lockable_files.LockableFiles(branch_transport,
1858
lock_filename, lock_class)
1859
control_files.create_lock()
1860
control_files.lock_write()
1862
for filename, content in utf8_files:
1863
control_files.put_utf8(filename, content)
1865
control_files.unlock()
1868
def initialize(cls, a_bzrdir):
1869
"""Create a branch of this format in a_bzrdir."""
1870
utf8_files = [('format', cls.get_format_string()),
1871
('revision-history', ''),
1872
('branch-name', ''),
1875
cls._initialize_control_files(a_bzrdir, utf8_files,
1876
'lock', lockdir.LockDir)
1877
return cls.open(a_bzrdir, _found=True)
1880
def open(cls, a_bzrdir, _found=False):
1881
"""Return the branch object for a_bzrdir
1883
_found is a private parameter, do not use it. It is used to indicate
1884
if format probing has already be done.
1887
format = BranchFormat.find_format(a_bzrdir)
1888
assert format.__class__ == cls
1889
transport = a_bzrdir.get_branch_transport(None)
1890
control_files = lockable_files.LockableFiles(transport, 'lock',
1892
return cls(_format=cls,
1893
_control_files=control_files,
1895
_repository=a_bzrdir.find_repository())
1898
def is_supported(cls):
1901
def _make_tags(self):
1902
return BasicTags(self)
1905
def supports_tags(cls):
1909
BranchFormat.register_format(BzrBranchExperimental)
1912
class BzrBranch6(BzrBranch5):
1915
def last_revision_info(self):
1916
revision_string = self.control_files.get('last-revision').read()
1917
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1918
revision_id = cache_utf8.get_cached_utf8(revision_id)
1920
return revno, revision_id
1922
def last_revision(self):
1923
"""Return last revision id, or None"""
1924
revision_id = self.last_revision_info()[1]
1927
def _write_last_revision_info(self, revno, revision_id):
1928
"""Simply write out the revision id, with no checks.
1930
Use set_last_revision_info to perform this safely.
1932
Does not update the revision_history cache.
1933
Intended to be called by set_last_revision_info and
1934
_write_revision_history.
1936
if revision_id is None:
1937
revision_id = 'null:'
1938
out_string = '%d %s\n' % (revno, revision_id)
1939
self.control_files.put_bytes('last-revision', out_string)
1942
def set_last_revision_info(self, revno, revision_id):
1943
revision_id = osutils.safe_revision_id(revision_id)
1944
if self._get_append_revisions_only():
1945
self._check_history_violation(revision_id)
1946
self._write_last_revision_info(revno, revision_id)
1947
self._clear_cached_state()
1949
def _check_history_violation(self, revision_id):
1950
last_revision = _mod_revision.ensure_null(self.last_revision())
1951
if _mod_revision.is_null(last_revision):
1953
if last_revision not in self._lefthand_history(revision_id):
1954
raise errors.AppendRevisionsOnlyViolation(self.base)
1956
def _gen_revision_history(self):
1957
"""Generate the revision history from last revision
1959
history = list(self.repository.iter_reverse_revision_history(
1960
self.last_revision()))
1964
def _write_revision_history(self, history):
1965
"""Factored out of set_revision_history.
1967
This performs the actual writing to disk, with format-specific checks.
1968
It is intended to be called by BzrBranch5.set_revision_history.
1970
if len(history) == 0:
1971
last_revision = 'null:'
1973
if history != self._lefthand_history(history[-1]):
1974
raise errors.NotLefthandHistory(history)
1975
last_revision = history[-1]
1976
if self._get_append_revisions_only():
1977
self._check_history_violation(last_revision)
1978
self._write_last_revision_info(len(history), last_revision)
1981
def _set_parent_location(self, url):
1982
"""Set the parent branch"""
1983
self._set_config_location('parent_location', url, make_relative=True)
1986
def _get_parent_location(self):
1987
"""Set the parent branch"""
1988
return self._get_config_location('parent_location')
1990
def set_push_location(self, location):
1991
"""See Branch.set_push_location."""
1992
self._set_config_location('push_location', location)
1994
def set_bound_location(self, location):
1995
"""See Branch.set_push_location."""
1997
config = self.get_config()
1998
if location is None:
1999
if config.get_user_option('bound') != 'True':
2002
config.set_user_option('bound', 'False', warn_masked=True)
2005
self._set_config_location('bound_location', location,
2007
config.set_user_option('bound', 'True', warn_masked=True)
2010
def _get_bound_location(self, bound):
2011
"""Return the bound location in the config file.
2013
Return None if the bound parameter does not match"""
2014
config = self.get_config()
2015
config_bound = (config.get_user_option('bound') == 'True')
2016
if config_bound != bound:
2018
return self._get_config_location('bound_location', config=config)
2020
def get_bound_location(self):
2021
"""See Branch.set_push_location."""
2022
return self._get_bound_location(True)
2024
def get_old_bound_location(self):
2025
"""See Branch.get_old_bound_location"""
2026
return self._get_bound_location(False)
2028
def set_append_revisions_only(self, enabled):
2033
self.get_config().set_user_option('append_revisions_only', value,
2036
def _get_append_revisions_only(self):
2037
value = self.get_config().get_user_option('append_revisions_only')
2038
return value == 'True'
2040
def _synchronize_history(self, destination, revision_id):
2041
"""Synchronize last revision and revision history between branches.
2043
This version is most efficient when the destination is also a
2044
BzrBranch6, but works for BzrBranch5, as long as the destination's
2045
repository contains all the lefthand ancestors of the intended
2046
last_revision. If not, set_last_revision_info will fail.
2048
:param destination: The branch to copy the history into
2049
:param revision_id: The revision-id to truncate history at. May
2050
be None to copy complete history.
2052
source_revno, source_revision_id = self.last_revision_info()
2053
if revision_id is None:
2054
revno, revision_id = source_revno, source_revision_id
2055
elif source_revision_id == revision_id:
2056
# we know the revno without needing to walk all of history
2057
revno = source_revno
2059
# To figure out the revno for a random revision, we need to build
2060
# the revision history, and count its length.
2061
# We don't care about the order, just how long it is.
2062
# Alternatively, we could start at the current location, and count
2063
# backwards. But there is no guarantee that we will find it since
2064
# it may be a merged revision.
2065
revno = len(list(self.repository.iter_reverse_revision_history(
2067
destination.set_last_revision_info(revno, revision_id)
2069
def _make_tags(self):
2070
return BasicTags(self)
2073
######################################################################
2074
# results of operations
2077
class _Result(object):
2079
def _show_tag_conficts(self, to_file):
2080
if not getattr(self, 'tag_conflicts', None):
2082
to_file.write('Conflicting tags:\n')
2083
for name, value1, value2 in self.tag_conflicts:
2084
to_file.write(' %s\n' % (name, ))
2087
class PullResult(_Result):
2088
"""Result of a Branch.pull operation.
2090
:ivar old_revno: Revision number before pull.
2091
:ivar new_revno: Revision number after pull.
2092
:ivar old_revid: Tip revision id before pull.
2093
:ivar new_revid: Tip revision id after pull.
2094
:ivar source_branch: Source (local) branch object.
2095
:ivar master_branch: Master branch of the target, or None.
2096
:ivar target_branch: Target/destination branch object.
2100
# DEPRECATED: pull used to return the change in revno
2101
return self.new_revno - self.old_revno
2103
def report(self, to_file):
2104
if self.old_revid == self.new_revid:
2105
to_file.write('No revisions to pull.\n')
2107
to_file.write('Now on revision %d.\n' % self.new_revno)
2108
self._show_tag_conficts(to_file)
2111
class PushResult(_Result):
2112
"""Result of a Branch.push operation.
2114
:ivar old_revno: Revision number before push.
2115
:ivar new_revno: Revision number after push.
2116
:ivar old_revid: Tip revision id before push.
2117
:ivar new_revid: Tip revision id after push.
2118
:ivar source_branch: Source branch object.
2119
:ivar master_branch: Master branch of the target, or None.
2120
:ivar target_branch: Target/destination branch object.
2124
# DEPRECATED: push used to return the change in revno
2125
return self.new_revno - self.old_revno
2127
def report(self, to_file):
2128
"""Write a human-readable description of the result."""
2129
if self.old_revid == self.new_revid:
2130
to_file.write('No new revisions to push.\n')
2132
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2133
self._show_tag_conficts(to_file)
2136
class BranchCheckResult(object):
2137
"""Results of checking branch consistency.
2142
def __init__(self, branch):
2143
self.branch = branch
2145
def report_results(self, verbose):
2146
"""Report the check results via trace.note.
2148
:param verbose: Requests more detailed display of what was checked,
2151
note('checked branch %s format %s',
2153
self.branch._format)
2156
class Converter5to6(object):
2157
"""Perform an in-place upgrade of format 5 to format 6"""
2159
def convert(self, branch):
2160
# Data for 5 and 6 can peacefully coexist.
2161
format = BzrBranchFormat6()
2162
new_branch = format.open(branch.bzrdir, _found=True)
2164
# Copy source data into target
2165
new_branch.set_last_revision_info(*branch.last_revision_info())
2166
new_branch.set_parent(branch.get_parent())
2167
new_branch.set_bound_location(branch.get_bound_location())
2168
new_branch.set_push_location(branch.get_push_location())
2170
# New branch has no tags by default
2171
new_branch.tags._set_tag_dict({})
2173
# Copying done; now update target format
2174
new_branch.control_files.put_utf8('format',
2175
format.get_format_string())
2177
# Clean up old files
2178
new_branch.control_files._transport.delete('revision-history')
2180
branch.set_parent(None)
2183
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
