137
69
"""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.
72
Base directory/url of the branch.
74
hooks: An instance of BranchHooks.
76
# 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.
80
# override this to set the strategy for storing tags
82
return DisabledTags(self)
84
def __init__(self, *ignored, **ignored_too):
85
self.tags = self._make_tags()
86
self._revision_history_cache = None
87
self._revision_id_to_revno_cache = None
90
"""Break a lock if one is present from another instance.
92
Uses the ui factory to ask for confirmation if the lock may be from
95
This will probe the repository for its lock as well.
97
self.control_files.break_lock()
98
self.repository.break_lock()
99
master = self.get_master_branch()
100
if master is not None:
104
def open(base, _unsupported=False, possible_transports=None):
105
"""Open the branch rooted at base.
107
For instance, if the branch is at URL/.bzr/branch,
108
Branch.open(URL) -> a Branch instance.
110
control = bzrdir.BzrDir.open(base, _unsupported,
111
possible_transports=possible_transports)
112
return control.open_branch(_unsupported)
115
def open_from_transport(transport, _unsupported=False):
116
"""Open the branch rooted at transport"""
117
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
118
return control.open_branch(_unsupported)
121
def open_containing(url, possible_transports=None):
122
"""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.
124
This probes for a branch at url, and searches upwards from there.
126
Basically we keep looking up until we find the control directory or
127
run into the root. If there isn't one, raises NotBranchError.
128
If there is one and it is either an unrecognised format or an unsupported
129
format, UnknownFormatError or UnsupportedFormatError are raised.
130
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)
132
control, relpath = bzrdir.BzrDir.open_containing(url,
134
return control.open_branch(), relpath
136
def get_config(self):
137
return BranchConfig(self)
140
return self.get_config().get_nickname()
142
def _set_nick(self, nick):
143
self.get_config().set_user_option('nickname', nick, warn_masked=True)
145
nick = property(_get_nick, _set_nick)
148
raise NotImplementedError(self.is_locked)
212
150
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'
151
raise NotImplementedError(self.lock_write)
228
153
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'
154
raise NotImplementedError(self.lock_read)
242
156
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
157
raise NotImplementedError(self.unlock)
159
def peek_lock_mode(self):
160
"""Return lock mode for the Branch: 'r', 'w' or None"""
161
raise NotImplementedError(self.peek_lock_mode)
163
def get_physical_lock_status(self):
164
raise NotImplementedError(self.get_physical_lock_status)
167
def get_revision_id_to_revno_map(self):
168
"""Return the revision_id => dotted revno map.
170
This will be regenerated on demand, but will be cached.
172
:return: A dictionary mapping revision_id => dotted revno.
173
This dictionary should not be modified by the caller.
175
if self._revision_id_to_revno_cache is not None:
176
mapping = self._revision_id_to_revno_cache
252
self._lock_mode = self._lock_count = None
178
mapping = self._gen_revno_map()
179
self._cache_revision_id_to_revno(mapping)
180
# TODO: jam 20070417 Since this is being cached, should we be returning
182
# I would rather not, and instead just declare that users should not
183
# modify the return value.
186
def _gen_revno_map(self):
187
"""Create a new mapping from revision ids to dotted revnos.
189
Dotted revnos are generated based on the current tip in the revision
191
This is the worker function for get_revision_id_to_revno_map, which
192
just caches the return value.
194
:return: A dictionary mapping revision_id => dotted revno.
196
last_revision = self.last_revision()
197
revision_graph = repository._old_get_graph(self.repository,
199
merge_sorted_revisions = tsort.merge_sort(
204
revision_id_to_revno = dict((rev_id, revno)
205
for seq_num, rev_id, depth, revno, end_of_merge
206
in merge_sorted_revisions)
207
return revision_id_to_revno
209
def leave_lock_in_place(self):
210
"""Tell this branch object not to release the physical lock when this
213
If lock_write doesn't return a token, then this method is not supported.
215
self.control_files.leave_in_place()
217
def dont_leave_lock_in_place(self):
218
"""Tell this branch object to release the physical lock when this
219
object is unlocked, even if it didn't originally acquire it.
221
If lock_write doesn't return a token, then this method is not supported.
223
self.control_files.dont_leave_in_place()
225
@deprecated_method(deprecated_in((0, 16, 0)))
255
226
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
227
"""Return absolute filename for something in the branch
229
XXX: Robert Collins 20051017 what is this used for? why is it a branch
230
method and not a tree method.
232
raise NotImplementedError(self.abspath)
234
def bind(self, other):
235
"""Bind the local branch the other branch.
237
:param other: The branch to bind to
240
raise errors.UpgradeRequired(self.base)
243
def fetch(self, from_branch, last_revision=None, pb=None):
244
"""Copy revisions from from_branch into this branch.
246
:param from_branch: Where to copy from.
247
:param last_revision: What revision to stop at (None for at the end
249
:param pb: An optional progress bar to use.
251
Returns the copied revision count and the failed revisions in a tuple:
254
if self.base == from_branch.base:
257
nested_pb = ui.ui_factory.nested_progress_bar()
262
from_branch.lock_read()
264
if last_revision is None:
265
pb.update('get source history')
266
last_revision = from_branch.last_revision()
267
last_revision = _mod_revision.ensure_null(last_revision)
268
return self.repository.fetch(from_branch.repository,
269
revision_id=last_revision,
272
if nested_pb is not None:
276
def get_bound_location(self):
277
"""Return the URL of the branch we are bound to.
279
Older format branches cannot bind, please be sure to use a metadir
284
def get_old_bound_location(self):
285
"""Return the URL of the branch we used to be bound to
287
raise errors.UpgradeRequired(self.base)
289
def get_commit_builder(self, parents, config=None, timestamp=None,
290
timezone=None, committer=None, revprops=None,
292
"""Obtain a CommitBuilder for this branch.
294
:param parents: Revision ids of the parents of the new revision.
295
:param config: Optional configuration to use.
296
:param timestamp: Optional timestamp recorded for commit.
297
:param timezone: Optional timezone for timestamp.
298
:param committer: Optional committer to set for commit.
299
:param revprops: Optional dictionary of revision properties.
300
:param revision_id: Optional revision id.
304
config = self.get_config()
306
return self.repository.get_commit_builder(self, parents, config,
307
timestamp, timezone, committer, revprops, revision_id)
309
def get_master_branch(self, possible_transports=None):
310
"""Return the branch we are bound to.
312
:return: Either a Branch, or None
617
316
def get_revision_delta(self, revno):
618
317
"""Return the delta for one revision.
789
439
common_index = min(self_len, other_len) -1
790
440
if common_index >= 0 and \
791
441
self_history[common_index] != other_history[common_index]:
792
raise DivergedBranches(self, other)
442
raise errors.DivergedBranches(self, other)
794
444
if stop_revision is None:
795
445
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
447
if stop_revision > other_len:
448
raise errors.NoSuchRevision(self, stop_revision)
799
449
return other_history[self_len:stop_revision]
802
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())
452
def update_revisions(self, other, stop_revision=None, overwrite=False,
454
"""Pull in new perfect-fit revisions.
456
:param other: Another Branch to pull from
457
:param stop_revision: Updated until the given revision
458
:param overwrite: Always set the branch pointer, rather than checking
459
to see if it is a proper descendant.
460
:param graph: A Graph object that can be used to query history
461
information. This can be None.
466
other_revno, other_last_revision = other.last_revision_info()
467
stop_revno = None # unknown
468
if stop_revision is None:
469
stop_revision = other_last_revision
470
if _mod_revision.is_null(stop_revision):
471
# if there are no commits, we're done.
473
stop_revno = other_revno
475
# what's the current last revision, before we fetch [and change it
477
last_rev = _mod_revision.ensure_null(self.last_revision())
478
# we fetch here so that we don't process data twice in the common
479
# case of having something to pull, and so that the check for
480
# already merged can operate on the just fetched graph, which will
481
# be cached in memory.
482
self.fetch(other, stop_revision)
483
# Check to see if one is an ancestor of the other
486
graph = self.repository.get_graph()
487
heads = graph.heads([stop_revision, last_rev])
488
if heads == set([last_rev]):
489
# The current revision is a decendent of the target,
492
elif heads == set([stop_revision, last_rev]):
493
# These branches have diverged
494
raise errors.DivergedBranches(self, other)
495
elif heads != set([stop_revision]):
496
raise AssertionError("invalid heads: %r" % heads)
497
if stop_revno is None:
499
graph = self.repository.get_graph()
500
this_revno, this_last_revision = self.last_revision_info()
501
stop_revno = graph.find_distance_to_null(stop_revision,
502
[(other_last_revision, other_revno),
503
(this_last_revision, this_revno)])
504
self.set_last_revision_info(stop_revno, stop_revision)
510
def revision_id_to_revno(self, revision_id):
511
"""Given a revision id, return its revno"""
512
if _mod_revision.is_null(revision_id):
514
history = self.revision_history()
516
return history.index(revision_id) + 1
518
raise errors.NoSuchRevision(self, revision_id)
520
def get_rev_id(self, revno, history=None):
521
"""Find the revision id of the specified revno."""
523
return _mod_revision.NULL_REVISION
525
history = self.revision_history()
526
if revno <= 0 or revno > len(history):
527
raise errors.NoSuchRevision(self, revno)
528
return history[revno - 1]
530
def pull(self, source, overwrite=False, stop_revision=None,
531
possible_transports=None):
532
"""Mirror source into this branch.
534
This branch is considered to be 'local', having low latency.
536
:returns: PullResult instance
538
raise NotImplementedError(self.pull)
540
def push(self, target, overwrite=False, stop_revision=None):
541
"""Mirror this branch into target.
543
This branch is considered to be 'local', having low latency.
545
raise NotImplementedError(self.push)
1053
547
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))
548
"""Return `Tree` object for last revision."""
549
return self.repository.revision_tree(self.last_revision())
1066
551
def rename_one(self, from_rel, to_rel):
1067
552
"""Rename one file.
1069
554
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)
556
raise NotImplementedError(self.rename_one)
1117
558
def move(self, from_paths, to_name):
1118
559
"""Rename files.
1125
566
Note that to_name is only the last component of the new name;
1126
567
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)
569
This returns a list of (from_path, to_path) pairs for each
572
raise NotImplementedError(self.move)
574
def get_parent(self):
575
"""Return the parent location of the branch.
577
This is the default location for push/pull/missing. The usual
578
pattern is that the user can override it by specifying a
581
raise NotImplementedError(self.get_parent)
583
def _set_config_location(self, name, url, config=None,
584
make_relative=False):
586
config = self.get_config()
590
url = urlutils.relative_url(self.base, url)
591
config.set_user_option(name, url, warn_masked=True)
593
def _get_config_location(self, name, config=None):
595
config = self.get_config()
596
location = config.get_user_option(name)
601
def get_submit_branch(self):
602
"""Return the submit location of the branch.
604
This is the default location for bundle. The usual
605
pattern is that the user can override it by specifying a
608
return self.get_config().get_user_option('submit_branch')
610
def set_submit_branch(self, location):
611
"""Return the submit location of the branch.
613
This is the default location for bundle. The usual
614
pattern is that the user can override it by specifying a
617
self.get_config().set_user_option('submit_branch', location,
620
def get_public_branch(self):
621
"""Return the public location of the branch.
623
This is is used by merge directives.
625
return self._get_config_location('public_branch')
627
def set_public_branch(self, location):
628
"""Return the submit location of the branch.
630
This is the default location for bundle. The usual
631
pattern is that the user can override it by specifying a
634
self._set_config_location('public_branch', location)
636
def get_push_location(self):
637
"""Return the None or the location to push this branch to."""
638
push_loc = self.get_config().get_user_option('push_location')
641
def set_push_location(self, location):
642
"""Set a new push location for this branch."""
643
raise NotImplementedError(self.set_push_location)
645
def set_parent(self, url):
646
raise NotImplementedError(self.set_parent)
650
"""Synchronise this branch with the master branch if any.
652
:return: None or the last_revision pivoted out during the update.
656
def check_revno(self, revno):
658
Check whether a revno corresponds to any revision.
659
Zero (the NULL revision) is considered valid.
662
self.check_real_revno(revno)
664
def check_real_revno(self, revno):
666
Check whether a revno corresponds to a real revision.
667
Zero (the NULL revision) is considered invalid
669
if revno < 1 or revno > self.revno():
670
raise errors.InvalidRevisionNumber(revno)
673
def clone(self, to_bzrdir, revision_id=None):
674
"""Clone this branch into to_bzrdir preserving all semantic values.
676
revision_id: if not None, the revision history in the new branch will
677
be truncated to end with revision_id.
679
result = self._format.initialize(to_bzrdir)
680
self.copy_content_into(result, revision_id=revision_id)
684
def sprout(self, to_bzrdir, revision_id=None):
685
"""Create a new line of development from the branch, into to_bzrdir.
687
revision_id: if not None, the revision history in the new branch will
688
be truncated to end with revision_id.
690
result = self._format.initialize(to_bzrdir)
691
self.copy_content_into(result, revision_id=revision_id)
692
result.set_parent(self.bzrdir.root_transport.base)
695
def _synchronize_history(self, destination, revision_id):
696
"""Synchronize last revision and revision history between branches.
698
This version is most efficient when the destination is also a
699
BzrBranch5, but works for BzrBranch6 as long as the revision
700
history is the true lefthand parent history, and all of the revisions
701
are in the destination's repository. If not, set_revision_history
704
:param destination: The branch to copy the history into
705
:param revision_id: The revision-id to truncate history at. May
706
be None to copy complete history.
708
if revision_id == _mod_revision.NULL_REVISION:
710
new_history = self.revision_history()
711
if revision_id is not None and new_history != []:
713
new_history = new_history[:new_history.index(revision_id) + 1]
715
rev = self.repository.get_revision(revision_id)
716
new_history = rev.get_history(self.repository)[1:]
717
destination.set_revision_history(new_history)
720
def copy_content_into(self, destination, revision_id=None):
721
"""Copy the content of self into destination.
723
revision_id: if not None, the revision history in the new branch will
724
be truncated to end with revision_id.
726
self._synchronize_history(destination, revision_id)
728
parent = self.get_parent()
729
except errors.InaccessibleParent, e:
730
mutter('parent was not accessible to copy: %s', e)
733
destination.set_parent(parent)
734
self.tags.merge_to(destination.tags)
738
"""Check consistency of the branch.
740
In particular this checks that revisions given in the revision-history
741
do actually match up in the revision graph, and that they're all
742
present in the repository.
744
Callers will typically also want to check the repository.
746
:return: A BranchCheckResult.
748
mainline_parent_id = None
749
last_revno, last_revision_id = self.last_revision_info()
750
real_rev_history = list(self.repository.iter_reverse_revision_history(
752
real_rev_history.reverse()
753
if len(real_rev_history) != last_revno:
754
raise errors.BzrCheckError('revno does not match len(mainline)'
755
' %s != %s' % (last_revno, len(real_rev_history)))
756
# TODO: We should probably also check that real_rev_history actually
757
# matches self.revision_history()
758
for revision_id in real_rev_history:
760
revision = self.repository.get_revision(revision_id)
761
except errors.NoSuchRevision, e:
762
raise errors.BzrCheckError("mainline revision {%s} not in repository"
764
# In general the first entry on the revision history has no parents.
765
# But it's not illegal for it to have parents listed; this can happen
766
# in imports from Arch when the parents weren't reachable.
767
if mainline_parent_id is not None:
768
if mainline_parent_id not in revision.parent_ids:
769
raise errors.BzrCheckError("previous revision {%s} not listed among "
771
% (mainline_parent_id, revision_id))
772
mainline_parent_id = revision_id
773
return BranchCheckResult(self)
775
def _get_checkout_format(self):
776
"""Return the most suitable metadir for a checkout of this branch.
777
Weaves are used if this branch's repository uses weaves.
779
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
780
from bzrlib.repofmt import weaverepo
781
format = bzrdir.BzrDirMetaFormat1()
782
format.repository_format = weaverepo.RepositoryFormat7()
784
format = self.repository.bzrdir.checkout_metadir()
785
format.set_branch_format(self._format)
788
def create_checkout(self, to_location, revision_id=None,
789
lightweight=False, accelerator_tree=None,
791
"""Create a checkout of a branch.
793
:param to_location: The url to produce the checkout at
794
:param revision_id: The revision to check out
795
:param lightweight: If True, produce a lightweight checkout, otherwise,
796
produce a bound branch (heavyweight checkout)
797
:param accelerator_tree: A tree which can be used for retrieving file
798
contents more quickly than the revision tree, i.e. a workingtree.
799
The revision tree will be used for cases where accelerator_tree's
800
content is different.
801
:param hardlink: If true, hard-link files from accelerator_tree,
803
:return: The tree of the created checkout
805
t = transport.get_transport(to_location)
808
format = self._get_checkout_format()
809
checkout = format.initialize_on_transport(t)
810
from_branch = BranchReferenceFormat().initialize(checkout, self)
812
format = self._get_checkout_format()
813
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
814
to_location, force_new_tree=False, format=format)
815
checkout = checkout_branch.bzrdir
816
checkout_branch.bind(self)
817
# pull up to the specified revision_id to set the initial
818
# branch tip correctly, and seed it with history.
819
checkout_branch.pull(self, stop_revision=revision_id)
821
tree = checkout.create_workingtree(revision_id,
822
from_branch=from_branch,
823
accelerator_tree=accelerator_tree,
825
basis_tree = tree.basis_tree()
826
basis_tree.lock_read()
828
for path, file_id in basis_tree.iter_references():
829
reference_parent = self.reference_parent(file_id, path)
830
reference_parent.create_checkout(tree.abspath(path),
831
basis_tree.get_reference_revision(file_id, path),
838
def reconcile(self, thorough=True):
839
"""Make sure the data stored in this branch is consistent."""
840
from bzrlib.reconcile import BranchReconciler
841
reconciler = BranchReconciler(self, thorough=thorough)
842
reconciler.reconcile()
845
def reference_parent(self, file_id, path):
846
"""Return the parent branch for a tree-reference file_id
847
:param file_id: The file_id of the tree reference
848
:param path: The path of the file_id in the tree
849
:return: A branch associated with the file_id
851
# FIXME should provide multiple branches, based on config
852
return Branch.open(self.bzrdir.root_transport.clone(path).base)
854
def supports_tags(self):
855
return self._format.supports_tags()
858
class BranchFormat(object):
859
"""An encapsulation of the initialization and open routines for a format.
861
Formats provide three things:
862
* An initialization routine,
866
Formats are placed in an dict by their format string for reference
867
during branch opening. Its not required that these be instances, they
868
can be classes themselves with class methods - it simply depends on
869
whether state is needed for a given format or not.
871
Once a format is deprecated, just deprecate the initialize and open
872
methods on the format class. Do not deprecate the object, as the
873
object will be created every time regardless.
876
_default_format = None
877
"""The default format used for new branches."""
880
"""The known formats."""
882
def __eq__(self, other):
883
return self.__class__ is other.__class__
885
def __ne__(self, other):
886
return not (self == other)
889
def find_format(klass, a_bzrdir):
890
"""Return the format for the branch object in a_bzrdir."""
892
transport = a_bzrdir.get_branch_transport(None)
893
format_string = transport.get("format").read()
894
return klass._formats[format_string]
895
except errors.NoSuchFile:
896
raise errors.NotBranchError(path=transport.base)
898
raise errors.UnknownFormatError(format=format_string, kind='branch')
901
def get_default_format(klass):
902
"""Return the current default format."""
903
return klass._default_format
905
def get_reference(self, a_bzrdir):
906
"""Get the target reference of the branch in a_bzrdir.
908
format probing must have been completed before calling
909
this method - it is assumed that the format of the branch
910
in a_bzrdir is correct.
912
:param a_bzrdir: The bzrdir to get the branch data from.
913
:return: None if the branch is not a reference branch.
918
def set_reference(self, a_bzrdir, to_branch):
919
"""Set the target reference of the branch in a_bzrdir.
921
format probing must have been completed before calling
922
this method - it is assumed that the format of the branch
923
in a_bzrdir is correct.
925
:param a_bzrdir: The bzrdir to set the branch reference for.
926
:param to_branch: branch that the checkout is to reference
928
raise NotImplementedError(self.set_reference)
930
def get_format_string(self):
931
"""Return the ASCII format string that identifies this format."""
932
raise NotImplementedError(self.get_format_string)
934
def get_format_description(self):
935
"""Return the short format description for this format."""
936
raise NotImplementedError(self.get_format_description)
938
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
940
"""Initialize a branch in a bzrdir, with specified files
942
:param a_bzrdir: The bzrdir to initialize the branch in
943
:param utf8_files: The files to create as a list of
944
(filename, content) tuples
945
:param set_format: If True, set the format with
946
self.get_format_string. (BzrBranch4 has its format set
948
:return: a branch in this format
950
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
951
branch_transport = a_bzrdir.get_branch_transport(self)
953
'metadir': ('lock', lockdir.LockDir),
954
'branch4': ('branch-lock', lockable_files.TransportLock),
956
lock_name, lock_class = lock_map[lock_type]
957
control_files = lockable_files.LockableFiles(branch_transport,
958
lock_name, lock_class)
959
control_files.create_lock()
960
control_files.lock_write()
962
utf8_files += [('format', self.get_format_string())]
964
for (filename, content) in utf8_files:
965
branch_transport.put_bytes(
967
mode=a_bzrdir._get_file_mode())
969
control_files.unlock()
970
return self.open(a_bzrdir, _found=True)
972
def initialize(self, a_bzrdir):
973
"""Create a branch of this format in a_bzrdir."""
974
raise NotImplementedError(self.initialize)
976
def is_supported(self):
977
"""Is this format supported?
979
Supported formats can be initialized and opened.
980
Unsupported formats may not support initialization or committing or
981
some other features depending on the reason for not being supported.
985
def open(self, a_bzrdir, _found=False):
986
"""Return the branch object for a_bzrdir
988
_found is a private parameter, do not use it. It is used to indicate
989
if format probing has already be done.
991
raise NotImplementedError(self.open)
994
def register_format(klass, format):
995
klass._formats[format.get_format_string()] = format
998
def set_default_format(klass, format):
999
klass._default_format = format
1002
def unregister_format(klass, format):
1003
del klass._formats[format.get_format_string()]
1006
return self.get_format_string().rstrip()
1008
def supports_tags(self):
1009
"""True if this format supports tags stored in the branch"""
1010
return False # by default
1013
class BranchHooks(Hooks):
1014
"""A dictionary mapping hook name to a list of callables for branch hooks.
1016
e.g. ['set_rh'] Is the list of items to be called when the
1017
set_revision_history function is invoked.
1021
"""Create the default hooks.
1023
These are all empty initially, because by default nothing should get
1026
Hooks.__init__(self)
1027
# Introduced in 0.15:
1028
# invoked whenever the revision history has been set
1029
# with set_revision_history. The api signature is
1030
# (branch, revision_history), and the branch will
1033
# invoked after a push operation completes.
1034
# the api signature is
1036
# containing the members
1037
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1038
# where local is the local target branch or None, master is the target
1039
# master branch, and the rest should be self explanatory. The source
1040
# is read locked and the target branches write locked. Source will
1041
# be the local low-latency branch.
1042
self['post_push'] = []
1043
# invoked after a pull operation completes.
1044
# the api signature is
1046
# containing the members
1047
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1048
# where local is the local branch or None, master is the target
1049
# master branch, and the rest should be self explanatory. The source
1050
# is read locked and the target branches write locked. The local
1051
# branch is the low-latency branch.
1052
self['post_pull'] = []
1053
# invoked before a commit operation takes place.
1054
# the api signature is
1055
# (local, master, old_revno, old_revid, future_revno, future_revid,
1056
# tree_delta, future_tree).
1057
# old_revid is NULL_REVISION for the first commit to a branch
1058
# tree_delta is a TreeDelta object describing changes from the basis
1059
# revision, hooks MUST NOT modify this delta
1060
# future_tree is an in-memory tree obtained from
1061
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1062
self['pre_commit'] = []
1063
# invoked after a commit operation completes.
1064
# the api signature is
1065
# (local, master, old_revno, old_revid, new_revno, new_revid)
1066
# old_revid is NULL_REVISION for the first commit to a branch.
1067
self['post_commit'] = []
1068
# invoked after a uncommit operation completes.
1069
# the api signature is
1070
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1071
# local is the local branch or None, master is the target branch,
1072
# and an empty branch recieves new_revno of 0, new_revid of None.
1073
self['post_uncommit'] = []
1075
# Invoked after the tip of a branch changes.
1076
# the api signature is
1077
# (params) where params is a ChangeBranchTipParams with the members
1078
# (branch, old_revno, new_revno, old_revid, new_revid)
1079
self['post_change_branch_tip'] = []
1082
# install the default hooks into the Branch class.
1083
Branch.hooks = BranchHooks()
1086
class ChangeBranchTipParams(object):
1087
"""Object holding parameters passed to *_change_branch_tip hooks.
1089
There are 5 fields that hooks may wish to access:
1091
:ivar branch: the branch being changed
1092
:ivar old_revno: revision number before the change
1093
:ivar new_revno: revision number after the change
1094
:ivar old_revid: revision id before the change
1095
:ivar new_revid: revision id after the change
1097
The revid fields are strings. The revno fields are integers.
1100
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1101
"""Create a group of ChangeBranchTip parameters.
1103
:param branch: The branch being changed.
1104
:param old_revno: Revision number before the change.
1105
:param new_revno: Revision number after the change.
1106
:param old_revid: Tip revision id before the change.
1107
:param new_revid: Tip revision id after the change.
1109
self.branch = branch
1110
self.old_revno = old_revno
1111
self.new_revno = new_revno
1112
self.old_revid = old_revid
1113
self.new_revid = new_revid
1116
class BzrBranchFormat4(BranchFormat):
1117
"""Bzr branch format 4.
1120
- a revision-history file.
1121
- a branch-lock lock file [ to be shared with the bzrdir ]
1124
def get_format_description(self):
1125
"""See BranchFormat.get_format_description()."""
1126
return "Branch format 4"
1128
def initialize(self, a_bzrdir):
1129
"""Create a branch of this format in a_bzrdir."""
1130
utf8_files = [('revision-history', ''),
1131
('branch-name', ''),
1133
return self._initialize_helper(a_bzrdir, utf8_files,
1134
lock_type='branch4', set_format=False)
1137
super(BzrBranchFormat4, self).__init__()
1138
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1140
def open(self, a_bzrdir, _found=False):
1141
"""Return the branch object for a_bzrdir
1143
_found is a private parameter, do not use it. It is used to indicate
1144
if format probing has already be done.
1147
# we are being called directly and must probe.
1148
raise NotImplementedError
1149
return BzrBranch(_format=self,
1150
_control_files=a_bzrdir._control_files,
1152
_repository=a_bzrdir.open_repository())
1155
return "Bazaar-NG branch format 4"
1158
class BzrBranchFormat5(BranchFormat):
1159
"""Bzr branch format 5.
1162
- a revision-history file.
1164
- a lock dir guarding the branch itself
1165
- all of this stored in a branch/ subdirectory
1166
- works with shared repositories.
1168
This format is new in bzr 0.8.
1171
def get_format_string(self):
1172
"""See BranchFormat.get_format_string()."""
1173
return "Bazaar-NG branch format 5\n"
1175
def get_format_description(self):
1176
"""See BranchFormat.get_format_description()."""
1177
return "Branch format 5"
1179
def initialize(self, a_bzrdir):
1180
"""Create a branch of this format in a_bzrdir."""
1181
utf8_files = [('revision-history', ''),
1182
('branch-name', ''),
1184
return self._initialize_helper(a_bzrdir, utf8_files)
1187
super(BzrBranchFormat5, self).__init__()
1188
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1190
def open(self, a_bzrdir, _found=False):
1191
"""Return the branch object for a_bzrdir
1193
_found is a private parameter, do not use it. It is used to indicate
1194
if format probing has already be done.
1197
format = BranchFormat.find_format(a_bzrdir)
1198
if format.__class__ != self.__class__:
1199
raise AssertionError("wrong format %r found for %r" %
1202
transport = a_bzrdir.get_branch_transport(None)
1203
control_files = lockable_files.LockableFiles(transport, 'lock',
1205
return BzrBranch5(_format=self,
1206
_control_files=control_files,
1208
_repository=a_bzrdir.find_repository())
1209
except errors.NoSuchFile:
1210
raise errors.NotBranchError(path=transport.base)
1213
class BzrBranchFormat6(BzrBranchFormat5):
1214
"""Branch format with last-revision and tags.
1216
Unlike previous formats, this has no explicit revision history. Instead,
1217
this just stores the last-revision, and the left-hand history leading
1218
up to there is the history.
1220
This format was introduced in bzr 0.15
1221
and became the default in 0.91.
1224
def get_format_string(self):
1225
"""See BranchFormat.get_format_string()."""
1226
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1228
def get_format_description(self):
1229
"""See BranchFormat.get_format_description()."""
1230
return "Branch format 6"
1232
def initialize(self, a_bzrdir):
1233
"""Create a branch of this format in a_bzrdir."""
1234
utf8_files = [('last-revision', '0 null:\n'),
1235
('branch.conf', ''),
1238
return self._initialize_helper(a_bzrdir, utf8_files)
1240
def open(self, a_bzrdir, _found=False):
1241
"""Return the branch object for a_bzrdir
1243
_found is a private parameter, do not use it. It is used to indicate
1244
if format probing has already be done.
1247
format = BranchFormat.find_format(a_bzrdir)
1248
if format.__class__ != self.__class__:
1249
raise AssertionError("wrong format %r found for %r" %
1251
transport = a_bzrdir.get_branch_transport(None)
1252
control_files = lockable_files.LockableFiles(transport, 'lock',
1254
return BzrBranch6(_format=self,
1255
_control_files=control_files,
1257
_repository=a_bzrdir.find_repository())
1259
def supports_tags(self):
1263
class BranchReferenceFormat(BranchFormat):
1264
"""Bzr branch reference format.
1266
Branch references are used in implementing checkouts, they
1267
act as an alias to the real branch which is at some other url.
1274
def get_format_string(self):
1275
"""See BranchFormat.get_format_string()."""
1276
return "Bazaar-NG Branch Reference Format 1\n"
1278
def get_format_description(self):
1279
"""See BranchFormat.get_format_description()."""
1280
return "Checkout reference format 1"
1282
def get_reference(self, a_bzrdir):
1283
"""See BranchFormat.get_reference()."""
1284
transport = a_bzrdir.get_branch_transport(None)
1285
return transport.get('location').read()
1287
def set_reference(self, a_bzrdir, to_branch):
1288
"""See BranchFormat.set_reference()."""
1289
transport = a_bzrdir.get_branch_transport(None)
1290
location = transport.put_bytes('location', to_branch.base)
1292
def initialize(self, a_bzrdir, target_branch=None):
1293
"""Create a branch of this format in a_bzrdir."""
1294
if target_branch is None:
1295
# this format does not implement branch itself, thus the implicit
1296
# creation contract must see it as uninitializable
1297
raise errors.UninitializableFormat(self)
1298
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1299
branch_transport = a_bzrdir.get_branch_transport(self)
1300
branch_transport.put_bytes('location',
1301
target_branch.bzrdir.root_transport.base)
1302
branch_transport.put_bytes('format', self.get_format_string())
1304
a_bzrdir, _found=True,
1305
possible_transports=[target_branch.bzrdir.root_transport])
1308
super(BranchReferenceFormat, self).__init__()
1309
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1311
def _make_reference_clone_function(format, a_branch):
1312
"""Create a clone() routine for a branch dynamically."""
1313
def clone(to_bzrdir, revision_id=None):
1314
"""See Branch.clone()."""
1315
return format.initialize(to_bzrdir, a_branch)
1316
# cannot obey revision_id limits when cloning a reference ...
1317
# FIXME RBC 20060210 either nuke revision_id for clone, or
1318
# emit some sort of warning/error to the caller ?!
1321
def open(self, a_bzrdir, _found=False, location=None,
1322
possible_transports=None):
1323
"""Return the branch that the branch reference in a_bzrdir points at.
1325
_found is a private parameter, do not use it. It is used to indicate
1326
if format probing has already be done.
1329
format = BranchFormat.find_format(a_bzrdir)
1330
if format.__class__ != self.__class__:
1331
raise AssertionError("wrong format %r found for %r" %
1333
if location is None:
1334
location = self.get_reference(a_bzrdir)
1335
real_bzrdir = bzrdir.BzrDir.open(
1336
location, possible_transports=possible_transports)
1337
result = real_bzrdir.open_branch()
1338
# this changes the behaviour of result.clone to create a new reference
1339
# rather than a copy of the content of the branch.
1340
# I did not use a proxy object because that needs much more extensive
1341
# testing, and we are only changing one behaviour at the moment.
1342
# If we decide to alter more behaviours - i.e. the implicit nickname
1343
# then this should be refactored to introduce a tested proxy branch
1344
# and a subclass of that for use in overriding clone() and ....
1346
result.clone = self._make_reference_clone_function(result)
1350
# formats which have no format string are not discoverable
1351
# and not independently creatable, so are not registered.
1352
__format5 = BzrBranchFormat5()
1353
__format6 = BzrBranchFormat6()
1354
BranchFormat.register_format(__format5)
1355
BranchFormat.register_format(BranchReferenceFormat())
1356
BranchFormat.register_format(__format6)
1357
BranchFormat.set_default_format(__format6)
1358
_legacy_formats = [BzrBranchFormat4(),
1361
class BzrBranch(Branch):
1362
"""A branch stored in the actual filesystem.
1364
Note that it's "local" in the context of the filesystem; it doesn't
1365
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1366
it's writable, and can be accessed via the normal filesystem API.
1368
:ivar _transport: Transport for file operations on this branch's
1369
control files, typically pointing to the .bzr/branch directory.
1370
:ivar repository: Repository for this branch.
1371
:ivar base: The url of the base directory for this branch; the one
1372
containing the .bzr directory.
1375
def __init__(self, _format=None,
1376
_control_files=None, a_bzrdir=None, _repository=None):
1377
"""Create new branch object at a particular location."""
1378
Branch.__init__(self)
1379
if a_bzrdir is None:
1380
raise ValueError('a_bzrdir must be supplied')
1382
self.bzrdir = a_bzrdir
1383
self._base = self.bzrdir.transport.clone('..').base
1384
# XXX: We should be able to just do
1385
# self.base = self.bzrdir.root_transport.base
1386
# but this does not quite work yet -- mbp 20080522
1387
self._format = _format
1388
if _control_files is None:
1389
raise ValueError('BzrBranch _control_files is None')
1390
self.control_files = _control_files
1391
self._transport = _control_files._transport
1392
self.repository = _repository
1395
return '%s(%r)' % (self.__class__.__name__, self.base)
1399
def _get_base(self):
1400
"""Returns the directory containing the control directory."""
1403
base = property(_get_base, doc="The URL for the root of this branch.")
1405
@deprecated_method(deprecated_in((0, 16, 0)))
1406
def abspath(self, name):
1407
"""See Branch.abspath."""
1408
return self._transport.abspath(name)
1410
def is_locked(self):
1411
return self.control_files.is_locked()
1413
def lock_write(self, token=None):
1414
repo_token = self.repository.lock_write()
1416
token = self.control_files.lock_write(token=token)
1418
self.repository.unlock()
1422
def lock_read(self):
1423
self.repository.lock_read()
1425
self.control_files.lock_read()
1427
self.repository.unlock()
1431
# TODO: test for failed two phase locks. This is known broken.
1433
self.control_files.unlock()
1435
self.repository.unlock()
1436
if not self.control_files.is_locked():
1437
# we just released the lock
1438
self._clear_cached_state()
1440
def peek_lock_mode(self):
1441
if self.control_files._lock_count == 0:
1444
return self.control_files._lock_mode
1446
def get_physical_lock_status(self):
1447
return self.control_files.get_physical_lock_status()
1450
def print_file(self, file, revision_id):
1451
"""See Branch.print_file."""
1452
return self.repository.print_file(file, revision_id)
1454
def _write_revision_history(self, history):
1455
"""Factored out of set_revision_history.
1457
This performs the actual writing to disk.
1458
It is intended to be called by BzrBranch5.set_revision_history."""
1459
self._transport.put_bytes(
1460
'revision-history', '\n'.join(history),
1461
mode=self.bzrdir._get_file_mode())
1464
def set_revision_history(self, rev_history):
1465
"""See Branch.set_revision_history."""
1466
if 'evil' in debug.debug_flags:
1467
mutter_callsite(3, "set_revision_history scales with history.")
1468
check_not_reserved_id = _mod_revision.check_not_reserved_id
1469
for rev_id in rev_history:
1470
check_not_reserved_id(rev_id)
1471
self._write_revision_history(rev_history)
1472
self._clear_cached_state()
1473
self._cache_revision_history(rev_history)
1474
for hook in Branch.hooks['set_rh']:
1475
hook(self, rev_history)
1477
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1478
"""Run the post_change_branch_tip hooks."""
1479
hooks = Branch.hooks['post_change_branch_tip']
1482
new_revno, new_revid = self.last_revision_info()
1483
params = ChangeBranchTipParams(
1484
self, old_revno, new_revno, old_revid, new_revid)
1489
def set_last_revision_info(self, revno, revision_id):
1490
"""Set the last revision of this branch.
1492
The caller is responsible for checking that the revno is correct
1493
for this revision id.
1495
It may be possible to set the branch last revision to an id not
1496
present in the repository. However, branches can also be
1497
configured to check constraints on history, in which case this may not
1500
revision_id = _mod_revision.ensure_null(revision_id)
1501
old_revno, old_revid = self.last_revision_info()
1502
# this old format stores the full history, but this api doesn't
1503
# provide it, so we must generate, and might as well check it's
1505
history = self._lefthand_history(revision_id)
1506
if len(history) != revno:
1507
raise AssertionError('%d != %d' % (len(history), revno))
1508
self.set_revision_history(history)
1509
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1511
def _gen_revision_history(self):
1512
history = self._transport.get_bytes('revision-history').split('\n')
1513
if history[-1:] == ['']:
1514
# There shouldn't be a trailing newline, but just in case.
1518
def _lefthand_history(self, revision_id, last_rev=None,
1520
if 'evil' in debug.debug_flags:
1521
mutter_callsite(4, "_lefthand_history scales with history.")
1522
# stop_revision must be a descendant of last_revision
1523
graph = self.repository.get_graph()
1524
if last_rev is not None:
1525
if not graph.is_ancestor(last_rev, revision_id):
1526
# our previous tip is not merged into stop_revision
1527
raise errors.DivergedBranches(self, other_branch)
1528
# make a new revision history from the graph
1529
parents_map = graph.get_parent_map([revision_id])
1530
if revision_id not in parents_map:
1531
raise errors.NoSuchRevision(self, revision_id)
1532
current_rev_id = revision_id
1534
check_not_reserved_id = _mod_revision.check_not_reserved_id
1535
# Do not include ghosts or graph origin in revision_history
1536
while (current_rev_id in parents_map and
1537
len(parents_map[current_rev_id]) > 0):
1538
check_not_reserved_id(current_rev_id)
1539
new_history.append(current_rev_id)
1540
current_rev_id = parents_map[current_rev_id][0]
1541
parents_map = graph.get_parent_map([current_rev_id])
1542
new_history.reverse()
1546
def generate_revision_history(self, revision_id, last_rev=None,
1548
"""Create a new revision history that will finish with revision_id.
1550
:param revision_id: the new tip to use.
1551
:param last_rev: The previous last_revision. If not None, then this
1552
must be a ancestory of revision_id, or DivergedBranches is raised.
1553
:param other_branch: The other branch that DivergedBranches should
1554
raise with respect to.
1556
self.set_revision_history(self._lefthand_history(revision_id,
1557
last_rev, other_branch))
1559
def basis_tree(self):
1560
"""See Branch.basis_tree."""
1561
return self.repository.revision_tree(self.last_revision())
1564
def pull(self, source, overwrite=False, stop_revision=None,
1565
_hook_master=None, run_hooks=True, possible_transports=None):
1568
:param _hook_master: Private parameter - set the branch to
1569
be supplied as the master to push hooks.
1570
:param run_hooks: Private parameter - if false, this branch
1571
is being called because it's the master of the primary branch,
1572
so it should not run its hooks.
1574
result = PullResult()
1575
result.source_branch = source
1576
result.target_branch = self
1579
# We assume that during 'pull' the local repository is closer than
1581
graph = self.repository.get_graph(source.repository)
1582
result.old_revno, result.old_revid = self.last_revision_info()
1583
self.update_revisions(source, stop_revision, overwrite=overwrite,
1585
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1586
result.new_revno, result.new_revid = self.last_revision_info()
1588
result.master_branch = _hook_master
1589
result.local_branch = self
1591
result.master_branch = self
1592
result.local_branch = None
1594
for hook in Branch.hooks['post_pull']:
1600
def _get_parent_location(self):
1601
_locs = ['parent', 'pull', 'x-pull']
1604
return self._transport.get_bytes(l).strip('\n')
1605
except errors.NoSuchFile:
1610
def push(self, target, overwrite=False, stop_revision=None,
1611
_override_hook_source_branch=None):
1614
This is the basic concrete implementation of push()
1616
:param _override_hook_source_branch: If specified, run
1617
the hooks passing this Branch as the source, rather than self.
1618
This is for use of RemoteBranch, where push is delegated to the
1619
underlying vfs-based Branch.
1621
# TODO: Public option to disable running hooks - should be trivial but
1625
result = self._push_with_bound_branches(target, overwrite,
1627
_override_hook_source_branch=_override_hook_source_branch)
1632
def _push_with_bound_branches(self, target, overwrite,
1634
_override_hook_source_branch=None):
1635
"""Push from self into target, and into target's master if any.
1637
This is on the base BzrBranch class even though it doesn't support
1638
bound branches because the *target* might be bound.
1641
if _override_hook_source_branch:
1642
result.source_branch = _override_hook_source_branch
1643
for hook in Branch.hooks['post_push']:
1646
bound_location = target.get_bound_location()
1647
if bound_location and target.base != bound_location:
1648
# there is a master branch.
1650
# XXX: Why the second check? Is it even supported for a branch to
1651
# be bound to itself? -- mbp 20070507
1652
master_branch = target.get_master_branch()
1653
master_branch.lock_write()
1655
# push into the master from this branch.
1656
self._basic_push(master_branch, overwrite, stop_revision)
1657
# and push into the target branch from this. Note that we push from
1658
# this branch again, because its considered the highest bandwidth
1660
result = self._basic_push(target, overwrite, stop_revision)
1661
result.master_branch = master_branch
1662
result.local_branch = target
1666
master_branch.unlock()
1669
result = self._basic_push(target, overwrite, stop_revision)
1670
# TODO: Why set master_branch and local_branch if there's no
1671
# binding? Maybe cleaner to just leave them unset? -- mbp
1673
result.master_branch = target
1674
result.local_branch = None
1678
def _basic_push(self, target, overwrite, stop_revision):
1679
"""Basic implementation of push without bound branches or hooks.
1681
Must be called with self read locked and target write locked.
1683
result = PushResult()
1684
result.source_branch = self
1685
result.target_branch = target
1686
result.old_revno, result.old_revid = target.last_revision_info()
1688
# We assume that during 'push' this repository is closer than
1690
graph = self.repository.get_graph(target.repository)
1691
target.update_revisions(self, stop_revision, overwrite=overwrite,
1693
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1694
result.new_revno, result.new_revid = target.last_revision_info()
1697
def get_parent(self):
1698
"""See Branch.get_parent."""
1699
parent = self._get_parent_location()
1702
# This is an old-format absolute path to a local branch
1703
# turn it into a url
1704
if parent.startswith('/'):
1705
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1707
return urlutils.join(self.base[:-1], parent)
1708
except errors.InvalidURLJoin, e:
1709
raise errors.InaccessibleParent(parent, self.base)
1711
def set_push_location(self, location):
1712
"""See Branch.set_push_location."""
1713
self.get_config().set_user_option(
1714
'push_location', location,
1715
store=_mod_config.STORE_LOCATION_NORECURSE)
1718
def set_parent(self, url):
1719
"""See Branch.set_parent."""
1720
# TODO: Maybe delete old location files?
1721
# URLs should never be unicode, even on the local fs,
1722
# FIXUP this and get_parent in a future branch format bump:
1723
# read and rewrite the file. RBC 20060125
1725
if isinstance(url, unicode):
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()
1727
url = url.encode('ascii')
1728
except UnicodeEncodeError:
1729
raise errors.InvalidURL(url,
1730
"Urls must be 7-bit ascii, "
1731
"use bzrlib.urlutils.escape")
1732
url = urlutils.relative_url(self.base, url)
1733
self._set_parent_location(url)
1735
def _set_parent_location(self, url):
1737
self._transport.delete('parent')
1739
self._transport.put_bytes('parent', url + '\n',
1740
mode=self.bzrdir._get_file_mode())
1743
class BzrBranch5(BzrBranch):
1744
"""A format 5 branch. This supports new features over plain branches.
1746
It has support for a master_branch which is the data for bound branches.
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:
1754
super(BzrBranch5, self).__init__(_format=_format,
1755
_control_files=_control_files,
1757
_repository=_repository)
1760
def pull(self, source, overwrite=False, stop_revision=None,
1761
run_hooks=True, possible_transports=None):
1762
"""Pull from source into self, updating my master if any.
1764
:param run_hooks: Private parameter - if false, this branch
1765
is being called because it's the master of the primary branch,
1766
so it should not run its hooks.
1768
bound_location = self.get_bound_location()
1769
master_branch = None
1770
if bound_location and source.base != bound_location:
1771
# not pulling from master, so we need to update master.
1772
master_branch = self.get_master_branch(possible_transports)
1773
master_branch.lock_write()
1776
# pull from source into master.
1777
master_branch.pull(source, overwrite, stop_revision,
1779
return super(BzrBranch5, self).pull(source, overwrite,
1780
stop_revision, _hook_master=master_branch,
1781
run_hooks=run_hooks)
1784
master_branch.unlock()
1786
def get_bound_location(self):
1788
return self._transport.get_bytes('bound')[:-1]
1789
except errors.NoSuchFile:
1793
def get_master_branch(self, possible_transports=None):
1794
"""Return the branch we are bound to.
1796
:return: Either a Branch, or None
1798
This could memoise the branch, but if thats done
1799
it must be revalidated on each new lock.
1800
So for now we just don't memoise it.
1801
# RBC 20060304 review this decision.
1803
bound_loc = self.get_bound_location()
1807
return Branch.open(bound_loc,
1808
possible_transports=possible_transports)
1809
except (errors.NotBranchError, errors.ConnectionError), e:
1810
raise errors.BoundBranchConnectionFailure(
1814
def set_bound_location(self, location):
1815
"""Set the target where this branch is bound to.
1817
:param location: URL to the target branch
1820
self._transport.put_bytes('bound', location+'\n',
1821
mode=self.bzrdir._get_file_mode())
1824
self._transport.delete('bound')
1825
except errors.NoSuchFile:
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')
1830
def bind(self, other):
1831
"""Bind this branch to the branch other.
1833
This does not push or pull data between the branches, though it does
1834
check for divergence to raise an error when the branches are not
1835
either the same, or one a prefix of the other. That behaviour may not
1836
be useful, so that check may be removed in future.
1838
:param other: The branch to bind to
1841
# TODO: jam 20051230 Consider checking if the target is bound
1842
# It is debatable whether you should be able to bind to
1843
# a branch which is itself bound.
1844
# Committing is obviously forbidden,
1845
# but binding itself may not be.
1846
# Since we *have* to check at commit time, we don't
1847
# *need* to check here
1849
# we want to raise diverged if:
1850
# last_rev is not in the other_last_rev history, AND
1851
# other_last_rev is not in our history, and do it without pulling
1853
self.set_bound_location(other.base)
1857
"""If bound, unbind"""
1858
return self.set_bound_location(None)
1861
def update(self, possible_transports=None):
1862
"""Synchronise this branch with the master branch if any.
1864
:return: None or the last_revision that was pivoted out during the
1867
master = self.get_master_branch(possible_transports)
1868
if master is not None:
1869
old_tip = _mod_revision.ensure_null(self.last_revision())
1870
self.pull(master, overwrite=True)
1871
if self.repository.get_graph().is_ancestor(old_tip,
1872
_mod_revision.ensure_null(self.last_revision())):
1878
class BzrBranch6(BzrBranch5):
1880
def __init__(self, *args, **kwargs):
1881
super(BzrBranch6, self).__init__(*args, **kwargs)
1882
self._last_revision_info_cache = None
1883
self._partial_revision_history_cache = []
1885
def _clear_cached_state(self):
1886
super(BzrBranch6, self)._clear_cached_state()
1887
self._last_revision_info_cache = None
1888
self._partial_revision_history_cache = []
1891
def last_revision_info(self):
1892
"""Return information about the last revision.
1894
:return: A tuple (revno, revision_id).
1896
if self._last_revision_info_cache is None:
1897
self._last_revision_info_cache = self._last_revision_info()
1898
return self._last_revision_info_cache
1900
def _last_revision_info(self):
1901
revision_string = self._transport.get_bytes('last-revision')
1902
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1903
revision_id = cache_utf8.get_cached_utf8(revision_id)
1905
return revno, revision_id
1907
def _write_last_revision_info(self, revno, revision_id):
1908
"""Simply write out the revision id, with no checks.
1910
Use set_last_revision_info to perform this safely.
1912
Does not update the revision_history cache.
1913
Intended to be called by set_last_revision_info and
1914
_write_revision_history.
1916
revision_id = _mod_revision.ensure_null(revision_id)
1917
out_string = '%d %s\n' % (revno, revision_id)
1918
self._transport.put_bytes('last-revision', out_string,
1919
mode=self.bzrdir._get_file_mode())
1922
def set_last_revision_info(self, revno, revision_id):
1923
revision_id = _mod_revision.ensure_null(revision_id)
1924
old_revno, old_revid = self.last_revision_info()
1925
if self._get_append_revisions_only():
1926
self._check_history_violation(revision_id)
1927
self._write_last_revision_info(revno, revision_id)
1928
self._clear_cached_state()
1929
self._last_revision_info_cache = revno, revision_id
1930
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1932
def _check_history_violation(self, revision_id):
1933
last_revision = _mod_revision.ensure_null(self.last_revision())
1934
if _mod_revision.is_null(last_revision):
1936
if last_revision not in self._lefthand_history(revision_id):
1937
raise errors.AppendRevisionsOnlyViolation(self.base)
1939
def _gen_revision_history(self):
1940
"""Generate the revision history from last revision
1942
self._extend_partial_history()
1943
return list(reversed(self._partial_revision_history_cache))
1945
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1946
"""Extend the partial history to include a given index
1948
If a stop_index is supplied, stop when that index has been reached.
1949
If a stop_revision is supplied, stop when that revision is
1950
encountered. Otherwise, stop when the beginning of history is
1953
:param stop_index: The index which should be present. When it is
1954
present, history extension will stop.
1955
:param revision_id: The revision id which should be present. When
1956
it is encountered, history extension will stop.
1958
repo = self.repository
1959
if len(self._partial_revision_history_cache) == 0:
1960
iterator = repo.iter_reverse_revision_history(self.last_revision())
1962
start_revision = self._partial_revision_history_cache[-1]
1963
iterator = repo.iter_reverse_revision_history(start_revision)
1964
#skip the last revision in the list
1965
next_revision = iterator.next()
1966
for revision_id in iterator:
1967
self._partial_revision_history_cache.append(revision_id)
1968
if (stop_index is not None and
1969
len(self._partial_revision_history_cache) > stop_index):
1971
if revision_id == stop_revision:
1974
def _write_revision_history(self, history):
1975
"""Factored out of set_revision_history.
1977
This performs the actual writing to disk, with format-specific checks.
1978
It is intended to be called by BzrBranch5.set_revision_history.
1980
if len(history) == 0:
1981
last_revision = 'null:'
1983
if history != self._lefthand_history(history[-1]):
1984
raise errors.NotLefthandHistory(history)
1985
last_revision = history[-1]
1986
if self._get_append_revisions_only():
1987
self._check_history_violation(last_revision)
1988
self._write_last_revision_info(len(history), last_revision)
1991
def _set_parent_location(self, url):
1992
"""Set the parent branch"""
1993
self._set_config_location('parent_location', url, make_relative=True)
1996
def _get_parent_location(self):
1997
"""Set the parent branch"""
1998
return self._get_config_location('parent_location')
2000
def set_push_location(self, location):
2001
"""See Branch.set_push_location."""
2002
self._set_config_location('push_location', location)
2004
def set_bound_location(self, location):
2005
"""See Branch.set_push_location."""
2007
config = self.get_config()
2008
if location is None:
2009
if config.get_user_option('bound') != 'True':
2012
config.set_user_option('bound', 'False', warn_masked=True)
2015
self._set_config_location('bound_location', location,
2017
config.set_user_option('bound', 'True', warn_masked=True)
2020
def _get_bound_location(self, bound):
2021
"""Return the bound location in the config file.
2023
Return None if the bound parameter does not match"""
2024
config = self.get_config()
2025
config_bound = (config.get_user_option('bound') == 'True')
2026
if config_bound != bound:
2028
return self._get_config_location('bound_location', config=config)
2030
def get_bound_location(self):
2031
"""See Branch.set_push_location."""
2032
return self._get_bound_location(True)
2034
def get_old_bound_location(self):
2035
"""See Branch.get_old_bound_location"""
2036
return self._get_bound_location(False)
2038
def set_append_revisions_only(self, enabled):
2043
self.get_config().set_user_option('append_revisions_only', value,
2046
def _get_append_revisions_only(self):
2047
value = self.get_config().get_user_option('append_revisions_only')
2048
return value == 'True'
2050
def _synchronize_history(self, destination, revision_id):
2051
"""Synchronize last revision and revision history between branches.
2053
This version is most efficient when the destination is also a
2054
BzrBranch6, but works for BzrBranch5, as long as the destination's
2055
repository contains all the lefthand ancestors of the intended
2056
last_revision. If not, set_last_revision_info will fail.
2058
:param destination: The branch to copy the history into
2059
:param revision_id: The revision-id to truncate history at. May
2060
be None to copy complete history.
2062
source_revno, source_revision_id = self.last_revision_info()
2063
if revision_id is None:
2064
revno, revision_id = source_revno, source_revision_id
2065
elif source_revision_id == revision_id:
2066
# we know the revno without needing to walk all of history
2067
revno = source_revno
2069
# To figure out the revno for a random revision, we need to build
2070
# the revision history, and count its length.
2071
# We don't care about the order, just how long it is.
2072
# Alternatively, we could start at the current location, and count
2073
# backwards. But there is no guarantee that we will find it since
2074
# it may be a merged revision.
2075
revno = len(list(self.repository.iter_reverse_revision_history(
2077
destination.set_last_revision_info(revno, revision_id)
2079
def _make_tags(self):
2080
return BasicTags(self)
2083
def generate_revision_history(self, revision_id, last_rev=None,
2085
"""See BzrBranch5.generate_revision_history"""
2086
history = self._lefthand_history(revision_id, last_rev, other_branch)
2087
revno = len(history)
2088
self.set_last_revision_info(revno, revision_id)
2091
def get_rev_id(self, revno, history=None):
2092
"""Find the revision id of the specified revno."""
2094
return _mod_revision.NULL_REVISION
2096
last_revno, last_revision_id = self.last_revision_info()
2097
if revno <= 0 or revno > last_revno:
2098
raise errors.NoSuchRevision(self, revno)
2100
if history is not None:
2101
return history[revno - 1]
2103
index = last_revno - revno
2104
if len(self._partial_revision_history_cache) <= index:
2105
self._extend_partial_history(stop_index=index)
2106
if len(self._partial_revision_history_cache) > index:
2107
return self._partial_revision_history_cache[index]
2109
raise errors.NoSuchRevision(self, revno)
2112
def revision_id_to_revno(self, revision_id):
2113
"""Given a revision id, return its revno"""
2114
if _mod_revision.is_null(revision_id):
2117
index = self._partial_revision_history_cache.index(revision_id)
2119
self._extend_partial_history(stop_revision=revision_id)
2120
index = len(self._partial_revision_history_cache) - 1
2121
if self._partial_revision_history_cache[index] != revision_id:
2122
raise errors.NoSuchRevision(self, revision_id)
2123
return self.revno() - index
2126
######################################################################
2127
# results of operations
2130
class _Result(object):
2132
def _show_tag_conficts(self, to_file):
2133
if not getattr(self, 'tag_conflicts', None):
2135
to_file.write('Conflicting tags:\n')
2136
for name, value1, value2 in self.tag_conflicts:
2137
to_file.write(' %s\n' % (name, ))
2140
class PullResult(_Result):
2141
"""Result of a Branch.pull operation.
2143
:ivar old_revno: Revision number before pull.
2144
:ivar new_revno: Revision number after pull.
2145
:ivar old_revid: Tip revision id before pull.
2146
:ivar new_revid: Tip revision id after pull.
2147
:ivar source_branch: Source (local) branch object.
2148
:ivar master_branch: Master branch of the target, or the target if no
2150
:ivar local_branch: target branch if there is a Master, else None
2151
:ivar target_branch: Target/destination branch object.
2152
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2156
# DEPRECATED: pull used to return the change in revno
2157
return self.new_revno - self.old_revno
2159
def report(self, to_file):
2161
if self.old_revid == self.new_revid:
2162
to_file.write('No revisions to pull.\n')
2164
to_file.write('Now on revision %d.\n' % self.new_revno)
2165
self._show_tag_conficts(to_file)
2168
class PushResult(_Result):
2169
"""Result of a Branch.push operation.
2171
:ivar old_revno: Revision number before push.
2172
:ivar new_revno: Revision number after push.
2173
:ivar old_revid: Tip revision id before push.
2174
:ivar new_revid: Tip revision id after push.
2175
:ivar source_branch: Source branch object.
2176
:ivar master_branch: Master branch of the target, or None.
2177
:ivar target_branch: Target/destination branch object.
2181
# DEPRECATED: push used to return the change in revno
2182
return self.new_revno - self.old_revno
2184
def report(self, to_file):
2185
"""Write a human-readable description of the result."""
2186
if self.old_revid == self.new_revid:
2187
to_file.write('No new revisions to push.\n')
2189
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2190
self._show_tag_conficts(to_file)
2193
class BranchCheckResult(object):
2194
"""Results of checking branch consistency.
2199
def __init__(self, branch):
2200
self.branch = branch
2202
def report_results(self, verbose):
2203
"""Report the check results via trace.note.
2205
:param verbose: Requests more detailed display of what was checked,
2208
note('checked branch %s format %s',
2210
self.branch._format)
2213
class Converter5to6(object):
2214
"""Perform an in-place upgrade of format 5 to format 6"""
2216
def convert(self, branch):
2217
# Data for 5 and 6 can peacefully coexist.
2218
format = BzrBranchFormat6()
2219
new_branch = format.open(branch.bzrdir, _found=True)
2221
# Copy source data into target
2222
new_branch._write_last_revision_info(*branch.last_revision_info())
2223
new_branch.set_parent(branch.get_parent())
2224
new_branch.set_bound_location(branch.get_bound_location())
2225
new_branch.set_push_location(branch.get_push_location())
2227
# New branch has no tags by default
2228
new_branch.tags._set_tag_dict({})
2230
# Copying done; now update target format
2231
new_branch._transport.put_bytes('format',
2232
format.get_format_string(),
2233
mode=new_branch.bzrdir._get_file_mode())
2235
# Clean up old files
2236
new_branch._transport.delete('revision-history')
2238
branch.set_parent(None)
2239
except errors.NoSuchFile:
2241
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
