137
73
"""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.
76
Base directory/url of the branch.
78
hooks: An instance of BranchHooks.
80
# 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.
84
# override this to set the strategy for storing tags
86
return DisabledTags(self)
88
def __init__(self, *ignored, **ignored_too):
89
self.tags = self._make_tags()
90
self._revision_history_cache = None
91
self._revision_id_to_revno_cache = None
92
self._last_revision_info_cache = None
96
"""Called by init to allow simpler extension of the base class."""
99
"""Break a lock if one is present from another instance.
101
Uses the ui factory to ask for confirmation if the lock may be from
104
This will probe the repository for its lock as well.
106
self.control_files.break_lock()
107
self.repository.break_lock()
108
master = self.get_master_branch()
109
if master is not None:
113
def open(base, _unsupported=False, possible_transports=None):
114
"""Open the branch rooted at base.
116
For instance, if the branch is at URL/.bzr/branch,
117
Branch.open(URL) -> a Branch instance.
119
control = bzrdir.BzrDir.open(base, _unsupported,
120
possible_transports=possible_transports)
121
return control.open_branch(_unsupported)
124
def open_from_transport(transport, _unsupported=False):
125
"""Open the branch rooted at transport"""
126
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
127
return control.open_branch(_unsupported)
130
def open_containing(url, possible_transports=None):
131
"""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.
133
This probes for a branch at url, and searches upwards from there.
135
Basically we keep looking up until we find the control directory or
136
run into the root. If there isn't one, raises NotBranchError.
137
If there is one and it is either an unrecognised format or an unsupported
138
format, UnknownFormatError or UnsupportedFormatError are raised.
139
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)
141
control, relpath = bzrdir.BzrDir.open_containing(url,
143
return control.open_branch(), relpath
145
def get_config(self):
146
return BranchConfig(self)
149
return self.get_config().get_nickname()
151
def _set_nick(self, nick):
152
self.get_config().set_user_option('nickname', nick, warn_masked=True)
154
nick = property(_get_nick, _set_nick)
157
raise NotImplementedError(self.is_locked)
212
159
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'
160
raise NotImplementedError(self.lock_write)
228
162
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'
163
raise NotImplementedError(self.lock_read)
242
165
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
166
raise NotImplementedError(self.unlock)
168
def peek_lock_mode(self):
169
"""Return lock mode for the Branch: 'r', 'w' or None"""
170
raise NotImplementedError(self.peek_lock_mode)
172
def get_physical_lock_status(self):
173
raise NotImplementedError(self.get_physical_lock_status)
176
def get_revision_id_to_revno_map(self):
177
"""Return the revision_id => dotted revno map.
179
This will be regenerated on demand, but will be cached.
181
:return: A dictionary mapping revision_id => dotted revno.
182
This dictionary should not be modified by the caller.
184
if self._revision_id_to_revno_cache is not None:
185
mapping = self._revision_id_to_revno_cache
252
self._lock_mode = self._lock_count = None
187
mapping = self._gen_revno_map()
188
self._cache_revision_id_to_revno(mapping)
189
# TODO: jam 20070417 Since this is being cached, should we be returning
191
# I would rather not, and instead just declare that users should not
192
# modify the return value.
195
def _gen_revno_map(self):
196
"""Create a new mapping from revision ids to dotted revnos.
198
Dotted revnos are generated based on the current tip in the revision
200
This is the worker function for get_revision_id_to_revno_map, which
201
just caches the return value.
203
:return: A dictionary mapping revision_id => dotted revno.
205
last_revision = self.last_revision()
206
revision_graph = repository._old_get_graph(self.repository,
208
merge_sorted_revisions = tsort.merge_sort(
213
revision_id_to_revno = dict((rev_id, revno)
214
for seq_num, rev_id, depth, revno, end_of_merge
215
in merge_sorted_revisions)
216
return revision_id_to_revno
218
def leave_lock_in_place(self):
219
"""Tell this branch object not to release the physical lock when this
222
If lock_write doesn't return a token, then this method is not supported.
224
self.control_files.leave_in_place()
226
def dont_leave_lock_in_place(self):
227
"""Tell this branch object to release the physical lock when this
228
object is unlocked, even if it didn't originally acquire it.
230
If lock_write doesn't return a token, then this method is not supported.
232
self.control_files.dont_leave_in_place()
234
@deprecated_method(deprecated_in((0, 16, 0)))
255
235
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
236
"""Return absolute filename for something in the branch
238
XXX: Robert Collins 20051017 what is this used for? why is it a branch
239
method and not a tree method.
241
raise NotImplementedError(self.abspath)
243
def bind(self, other):
244
"""Bind the local branch the other branch.
246
:param other: The branch to bind to
249
raise errors.UpgradeRequired(self.base)
252
def fetch(self, from_branch, last_revision=None, pb=None):
253
"""Copy revisions from from_branch into this branch.
255
:param from_branch: Where to copy from.
256
:param last_revision: What revision to stop at (None for at the end
258
:param pb: An optional progress bar to use.
260
Returns the copied revision count and the failed revisions in a tuple:
263
if self.base == from_branch.base:
266
nested_pb = ui.ui_factory.nested_progress_bar()
271
from_branch.lock_read()
273
if last_revision is None:
274
pb.update('get source history')
275
last_revision = from_branch.last_revision()
276
last_revision = _mod_revision.ensure_null(last_revision)
277
return self.repository.fetch(from_branch.repository,
278
revision_id=last_revision,
281
if nested_pb is not None:
285
def get_bound_location(self):
286
"""Return the URL of the branch we are bound to.
288
Older format branches cannot bind, please be sure to use a metadir
293
def get_old_bound_location(self):
294
"""Return the URL of the branch we used to be bound to
296
raise errors.UpgradeRequired(self.base)
298
def get_commit_builder(self, parents, config=None, timestamp=None,
299
timezone=None, committer=None, revprops=None,
301
"""Obtain a CommitBuilder for this branch.
303
:param parents: Revision ids of the parents of the new revision.
304
:param config: Optional configuration to use.
305
:param timestamp: Optional timestamp recorded for commit.
306
:param timezone: Optional timezone for timestamp.
307
:param committer: Optional committer to set for commit.
308
:param revprops: Optional dictionary of revision properties.
309
:param revision_id: Optional revision id.
313
config = self.get_config()
315
return self.repository.get_commit_builder(self, parents, config,
316
timestamp, timezone, committer, revprops, revision_id)
318
def get_master_branch(self, possible_transports=None):
319
"""Return the branch we are bound to.
321
:return: Either a Branch, or None
617
325
def get_revision_delta(self, revno):
618
326
"""Return the delta for one revision.
789
474
common_index = min(self_len, other_len) -1
790
475
if common_index >= 0 and \
791
476
self_history[common_index] != other_history[common_index]:
792
raise DivergedBranches(self, other)
477
raise errors.DivergedBranches(self, other)
794
479
if stop_revision is None:
795
480
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
482
if stop_revision > other_len:
483
raise errors.NoSuchRevision(self, stop_revision)
799
484
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())
487
def update_revisions(self, other, stop_revision=None, overwrite=False,
489
"""Pull in new perfect-fit revisions.
491
:param other: Another Branch to pull from
492
:param stop_revision: Updated until the given revision
493
:param overwrite: Always set the branch pointer, rather than checking
494
to see if it is a proper descendant.
495
:param graph: A Graph object that can be used to query history
496
information. This can be None.
501
other_revno, other_last_revision = other.last_revision_info()
502
stop_revno = None # unknown
503
if stop_revision is None:
504
stop_revision = other_last_revision
505
if _mod_revision.is_null(stop_revision):
506
# if there are no commits, we're done.
508
stop_revno = other_revno
510
# what's the current last revision, before we fetch [and change it
512
last_rev = _mod_revision.ensure_null(self.last_revision())
513
# we fetch here so that we don't process data twice in the common
514
# case of having something to pull, and so that the check for
515
# already merged can operate on the just fetched graph, which will
516
# be cached in memory.
517
self.fetch(other, stop_revision)
518
# Check to see if one is an ancestor of the other
521
graph = self.repository.get_graph()
522
if self._check_if_descendant_or_diverged(
523
stop_revision, last_rev, graph, other):
524
# stop_revision is a descendant of last_rev, but we aren't
525
# overwriting, so we're done.
527
if stop_revno is None:
529
graph = self.repository.get_graph()
530
this_revno, this_last_revision = self.last_revision_info()
531
stop_revno = graph.find_distance_to_null(stop_revision,
532
[(other_last_revision, other_revno),
533
(this_last_revision, this_revno)])
534
self.set_last_revision_info(stop_revno, stop_revision)
538
def revision_id_to_revno(self, revision_id):
539
"""Given a revision id, return its revno"""
540
if _mod_revision.is_null(revision_id):
542
history = self.revision_history()
544
return history.index(revision_id) + 1
546
raise errors.NoSuchRevision(self, revision_id)
548
def get_rev_id(self, revno, history=None):
549
"""Find the revision id of the specified revno."""
551
return _mod_revision.NULL_REVISION
553
history = self.revision_history()
554
if revno <= 0 or revno > len(history):
555
raise errors.NoSuchRevision(self, revno)
556
return history[revno - 1]
558
def pull(self, source, overwrite=False, stop_revision=None,
559
possible_transports=None, _override_hook_target=None):
560
"""Mirror source into this branch.
562
This branch is considered to be 'local', having low latency.
564
:returns: PullResult instance
566
raise NotImplementedError(self.pull)
568
def push(self, target, overwrite=False, stop_revision=None):
569
"""Mirror this branch into target.
571
This branch is considered to be 'local', having low latency.
573
raise NotImplementedError(self.push)
1053
575
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))
576
"""Return `Tree` object for last revision."""
577
return self.repository.revision_tree(self.last_revision())
1066
579
def rename_one(self, from_rel, to_rel):
1067
580
"""Rename one file.
1069
582
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)
584
raise NotImplementedError(self.rename_one)
1117
586
def move(self, from_paths, to_name):
1118
587
"""Rename files.
1125
594
Note that to_name is only the last component of the new name;
1126
595
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)
597
This returns a list of (from_path, to_path) pairs for each
600
raise NotImplementedError(self.move)
602
def get_parent(self):
603
"""Return the parent location of the branch.
605
This is the default location for push/pull/missing. The usual
606
pattern is that the user can override it by specifying a
609
raise NotImplementedError(self.get_parent)
611
def _set_config_location(self, name, url, config=None,
612
make_relative=False):
614
config = self.get_config()
618
url = urlutils.relative_url(self.base, url)
619
config.set_user_option(name, url, warn_masked=True)
621
def _get_config_location(self, name, config=None):
623
config = self.get_config()
624
location = config.get_user_option(name)
629
def get_submit_branch(self):
630
"""Return the submit location of the branch.
632
This is the default location for bundle. The usual
633
pattern is that the user can override it by specifying a
636
return self.get_config().get_user_option('submit_branch')
638
def set_submit_branch(self, location):
639
"""Return the submit location of the branch.
641
This is the default location for bundle. The usual
642
pattern is that the user can override it by specifying a
645
self.get_config().set_user_option('submit_branch', location,
648
def get_public_branch(self):
649
"""Return the public location of the branch.
651
This is is used by merge directives.
653
return self._get_config_location('public_branch')
655
def set_public_branch(self, location):
656
"""Return the submit location of the branch.
658
This is the default location for bundle. The usual
659
pattern is that the user can override it by specifying a
662
self._set_config_location('public_branch', location)
664
def get_push_location(self):
665
"""Return the None or the location to push this branch to."""
666
push_loc = self.get_config().get_user_option('push_location')
669
def set_push_location(self, location):
670
"""Set a new push location for this branch."""
671
raise NotImplementedError(self.set_push_location)
673
def set_parent(self, url):
674
raise NotImplementedError(self.set_parent)
678
"""Synchronise this branch with the master branch if any.
680
:return: None or the last_revision pivoted out during the update.
684
def check_revno(self, revno):
686
Check whether a revno corresponds to any revision.
687
Zero (the NULL revision) is considered valid.
690
self.check_real_revno(revno)
692
def check_real_revno(self, revno):
694
Check whether a revno corresponds to a real revision.
695
Zero (the NULL revision) is considered invalid
697
if revno < 1 or revno > self.revno():
698
raise errors.InvalidRevisionNumber(revno)
701
def clone(self, to_bzrdir, revision_id=None):
702
"""Clone this branch into to_bzrdir preserving all semantic values.
704
revision_id: if not None, the revision history in the new branch will
705
be truncated to end with revision_id.
707
result = self._format.initialize(to_bzrdir)
708
self.copy_content_into(result, revision_id=revision_id)
712
def sprout(self, to_bzrdir, revision_id=None):
713
"""Create a new line of development from the branch, into to_bzrdir.
715
revision_id: if not None, the revision history in the new branch will
716
be truncated to end with revision_id.
718
result = self._format.initialize(to_bzrdir)
719
self.copy_content_into(result, revision_id=revision_id)
720
result.set_parent(self.bzrdir.root_transport.base)
723
def _synchronize_history(self, destination, revision_id):
724
"""Synchronize last revision and revision history between branches.
726
This version is most efficient when the destination is also a
727
BzrBranch5, but works for BzrBranch6 as long as the revision
728
history is the true lefthand parent history, and all of the revisions
729
are in the destination's repository. If not, set_revision_history
732
:param destination: The branch to copy the history into
733
:param revision_id: The revision-id to truncate history at. May
734
be None to copy complete history.
736
if revision_id == _mod_revision.NULL_REVISION:
738
new_history = self.revision_history()
739
if revision_id is not None and new_history != []:
741
new_history = new_history[:new_history.index(revision_id) + 1]
743
rev = self.repository.get_revision(revision_id)
744
new_history = rev.get_history(self.repository)[1:]
745
destination.set_revision_history(new_history)
748
def copy_content_into(self, destination, revision_id=None):
749
"""Copy the content of self into destination.
751
revision_id: if not None, the revision history in the new branch will
752
be truncated to end with revision_id.
754
self._synchronize_history(destination, revision_id)
756
parent = self.get_parent()
757
except errors.InaccessibleParent, e:
758
mutter('parent was not accessible to copy: %s', e)
761
destination.set_parent(parent)
762
self.tags.merge_to(destination.tags)
766
"""Check consistency of the branch.
768
In particular this checks that revisions given in the revision-history
769
do actually match up in the revision graph, and that they're all
770
present in the repository.
772
Callers will typically also want to check the repository.
774
:return: A BranchCheckResult.
776
mainline_parent_id = None
777
last_revno, last_revision_id = self.last_revision_info()
778
real_rev_history = list(self.repository.iter_reverse_revision_history(
780
real_rev_history.reverse()
781
if len(real_rev_history) != last_revno:
782
raise errors.BzrCheckError('revno does not match len(mainline)'
783
' %s != %s' % (last_revno, len(real_rev_history)))
784
# TODO: We should probably also check that real_rev_history actually
785
# matches self.revision_history()
786
for revision_id in real_rev_history:
788
revision = self.repository.get_revision(revision_id)
789
except errors.NoSuchRevision, e:
790
raise errors.BzrCheckError("mainline revision {%s} not in repository"
792
# In general the first entry on the revision history has no parents.
793
# But it's not illegal for it to have parents listed; this can happen
794
# in imports from Arch when the parents weren't reachable.
795
if mainline_parent_id is not None:
796
if mainline_parent_id not in revision.parent_ids:
797
raise errors.BzrCheckError("previous revision {%s} not listed among "
799
% (mainline_parent_id, revision_id))
800
mainline_parent_id = revision_id
801
return BranchCheckResult(self)
803
def _get_checkout_format(self):
804
"""Return the most suitable metadir for a checkout of this branch.
805
Weaves are used if this branch's repository uses weaves.
807
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
808
from bzrlib.repofmt import weaverepo
809
format = bzrdir.BzrDirMetaFormat1()
810
format.repository_format = weaverepo.RepositoryFormat7()
812
format = self.repository.bzrdir.checkout_metadir()
813
format.set_branch_format(self._format)
816
def create_checkout(self, to_location, revision_id=None,
817
lightweight=False, accelerator_tree=None,
819
"""Create a checkout of a branch.
821
:param to_location: The url to produce the checkout at
822
:param revision_id: The revision to check out
823
:param lightweight: If True, produce a lightweight checkout, otherwise,
824
produce a bound branch (heavyweight checkout)
825
:param accelerator_tree: A tree which can be used for retrieving file
826
contents more quickly than the revision tree, i.e. a workingtree.
827
The revision tree will be used for cases where accelerator_tree's
828
content is different.
829
:param hardlink: If true, hard-link files from accelerator_tree,
831
:return: The tree of the created checkout
833
t = transport.get_transport(to_location)
836
format = self._get_checkout_format()
837
checkout = format.initialize_on_transport(t)
838
from_branch = BranchReferenceFormat().initialize(checkout, self)
840
format = self._get_checkout_format()
841
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
842
to_location, force_new_tree=False, format=format)
843
checkout = checkout_branch.bzrdir
844
checkout_branch.bind(self)
845
# pull up to the specified revision_id to set the initial
846
# branch tip correctly, and seed it with history.
847
checkout_branch.pull(self, stop_revision=revision_id)
849
tree = checkout.create_workingtree(revision_id,
850
from_branch=from_branch,
851
accelerator_tree=accelerator_tree,
853
basis_tree = tree.basis_tree()
854
basis_tree.lock_read()
856
for path, file_id in basis_tree.iter_references():
857
reference_parent = self.reference_parent(file_id, path)
858
reference_parent.create_checkout(tree.abspath(path),
859
basis_tree.get_reference_revision(file_id, path),
866
def reconcile(self, thorough=True):
867
"""Make sure the data stored in this branch is consistent."""
868
from bzrlib.reconcile import BranchReconciler
869
reconciler = BranchReconciler(self, thorough=thorough)
870
reconciler.reconcile()
873
def reference_parent(self, file_id, path):
874
"""Return the parent branch for a tree-reference file_id
875
:param file_id: The file_id of the tree reference
876
:param path: The path of the file_id in the tree
877
:return: A branch associated with the file_id
879
# FIXME should provide multiple branches, based on config
880
return Branch.open(self.bzrdir.root_transport.clone(path).base)
882
def supports_tags(self):
883
return self._format.supports_tags()
885
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
887
"""Ensure that revision_b is a descendant of revision_a.
889
This is a helper function for update_revisions.
891
:raises: DivergedBranches if revision_b has diverged from revision_a.
892
:returns: True if revision_b is a descendant of revision_a.
894
relation = self._revision_relations(revision_a, revision_b, graph)
895
if relation == 'b_descends_from_a':
897
elif relation == 'diverged':
898
raise errors.DivergedBranches(self, other_branch)
899
elif relation == 'a_descends_from_b':
902
raise AssertionError("invalid relation: %r" % (relation,))
904
def _revision_relations(self, revision_a, revision_b, graph):
905
"""Determine the relationship between two revisions.
907
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
909
heads = graph.heads([revision_a, revision_b])
910
if heads == set([revision_b]):
911
return 'b_descends_from_a'
912
elif heads == set([revision_a, revision_b]):
913
# These branches have diverged
915
elif heads == set([revision_a]):
916
return 'a_descends_from_b'
918
raise AssertionError("invalid heads: %r" % (heads,))
921
class BranchFormat(object):
922
"""An encapsulation of the initialization and open routines for a format.
924
Formats provide three things:
925
* An initialization routine,
929
Formats are placed in an dict by their format string for reference
930
during branch opening. Its not required that these be instances, they
931
can be classes themselves with class methods - it simply depends on
932
whether state is needed for a given format or not.
934
Once a format is deprecated, just deprecate the initialize and open
935
methods on the format class. Do not deprecate the object, as the
936
object will be created every time regardless.
939
_default_format = None
940
"""The default format used for new branches."""
943
"""The known formats."""
945
def __eq__(self, other):
946
return self.__class__ is other.__class__
948
def __ne__(self, other):
949
return not (self == other)
952
def find_format(klass, a_bzrdir):
953
"""Return the format for the branch object in a_bzrdir."""
955
transport = a_bzrdir.get_branch_transport(None)
956
format_string = transport.get("format").read()
957
return klass._formats[format_string]
958
except errors.NoSuchFile:
959
raise errors.NotBranchError(path=transport.base)
961
raise errors.UnknownFormatError(format=format_string, kind='branch')
964
def get_default_format(klass):
965
"""Return the current default format."""
966
return klass._default_format
968
def get_reference(self, a_bzrdir):
969
"""Get the target reference of the branch in a_bzrdir.
971
format probing must have been completed before calling
972
this method - it is assumed that the format of the branch
973
in a_bzrdir is correct.
975
:param a_bzrdir: The bzrdir to get the branch data from.
976
:return: None if the branch is not a reference branch.
981
def set_reference(self, a_bzrdir, to_branch):
982
"""Set the target reference of the branch in a_bzrdir.
984
format probing must have been completed before calling
985
this method - it is assumed that the format of the branch
986
in a_bzrdir is correct.
988
:param a_bzrdir: The bzrdir to set the branch reference for.
989
:param to_branch: branch that the checkout is to reference
991
raise NotImplementedError(self.set_reference)
993
def get_format_string(self):
994
"""Return the ASCII format string that identifies this format."""
995
raise NotImplementedError(self.get_format_string)
997
def get_format_description(self):
998
"""Return the short format description for this format."""
999
raise NotImplementedError(self.get_format_description)
1001
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1003
"""Initialize a branch in a bzrdir, with specified files
1005
:param a_bzrdir: The bzrdir to initialize the branch in
1006
:param utf8_files: The files to create as a list of
1007
(filename, content) tuples
1008
:param set_format: If True, set the format with
1009
self.get_format_string. (BzrBranch4 has its format set
1011
:return: a branch in this format
1013
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1014
branch_transport = a_bzrdir.get_branch_transport(self)
1016
'metadir': ('lock', lockdir.LockDir),
1017
'branch4': ('branch-lock', lockable_files.TransportLock),
1019
lock_name, lock_class = lock_map[lock_type]
1020
control_files = lockable_files.LockableFiles(branch_transport,
1021
lock_name, lock_class)
1022
control_files.create_lock()
1023
control_files.lock_write()
1025
utf8_files += [('format', self.get_format_string())]
1027
for (filename, content) in utf8_files:
1028
branch_transport.put_bytes(
1030
mode=a_bzrdir._get_file_mode())
1032
control_files.unlock()
1033
return self.open(a_bzrdir, _found=True)
1035
def initialize(self, a_bzrdir):
1036
"""Create a branch of this format in a_bzrdir."""
1037
raise NotImplementedError(self.initialize)
1039
def is_supported(self):
1040
"""Is this format supported?
1042
Supported formats can be initialized and opened.
1043
Unsupported formats may not support initialization or committing or
1044
some other features depending on the reason for not being supported.
1048
def open(self, a_bzrdir, _found=False):
1049
"""Return the branch object for a_bzrdir
1051
_found is a private parameter, do not use it. It is used to indicate
1052
if format probing has already be done.
1054
raise NotImplementedError(self.open)
1057
def register_format(klass, format):
1058
klass._formats[format.get_format_string()] = format
1061
def set_default_format(klass, format):
1062
klass._default_format = format
1064
def supports_stacking(self):
1065
"""True if this format records a stacked-on branch."""
1069
def unregister_format(klass, format):
1070
del klass._formats[format.get_format_string()]
1073
return self.get_format_string().rstrip()
1075
def supports_tags(self):
1076
"""True if this format supports tags stored in the branch"""
1077
return False # by default
1080
class BranchHooks(Hooks):
1081
"""A dictionary mapping hook name to a list of callables for branch hooks.
1083
e.g. ['set_rh'] Is the list of items to be called when the
1084
set_revision_history function is invoked.
1088
"""Create the default hooks.
1090
These are all empty initially, because by default nothing should get
1093
Hooks.__init__(self)
1094
# Introduced in 0.15:
1095
# invoked whenever the revision history has been set
1096
# with set_revision_history. The api signature is
1097
# (branch, revision_history), and the branch will
1100
# invoked after a push operation completes.
1101
# the api signature is
1103
# containing the members
1104
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1105
# where local is the local target branch or None, master is the target
1106
# master branch, and the rest should be self explanatory. The source
1107
# is read locked and the target branches write locked. Source will
1108
# be the local low-latency branch.
1109
self['post_push'] = []
1110
# invoked after a pull operation completes.
1111
# the api signature is
1113
# containing the members
1114
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1115
# where local is the local branch or None, master is the target
1116
# master branch, and the rest should be self explanatory. The source
1117
# is read locked and the target branches write locked. The local
1118
# branch is the low-latency branch.
1119
self['post_pull'] = []
1120
# invoked before a commit operation takes place.
1121
# the api signature is
1122
# (local, master, old_revno, old_revid, future_revno, future_revid,
1123
# tree_delta, future_tree).
1124
# old_revid is NULL_REVISION for the first commit to a branch
1125
# tree_delta is a TreeDelta object describing changes from the basis
1126
# revision, hooks MUST NOT modify this delta
1127
# future_tree is an in-memory tree obtained from
1128
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1129
self['pre_commit'] = []
1130
# invoked after a commit operation completes.
1131
# the api signature is
1132
# (local, master, old_revno, old_revid, new_revno, new_revid)
1133
# old_revid is NULL_REVISION for the first commit to a branch.
1134
self['post_commit'] = []
1135
# invoked after a uncommit operation completes.
1136
# the api signature is
1137
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1138
# local is the local branch or None, master is the target branch,
1139
# and an empty branch recieves new_revno of 0, new_revid of None.
1140
self['post_uncommit'] = []
1142
# Invoked before the tip of a branch changes.
1143
# the api signature is
1144
# (params) where params is a ChangeBranchTipParams with the members
1145
# (branch, old_revno, new_revno, old_revid, new_revid)
1146
self['pre_change_branch_tip'] = []
1148
# Invoked after the tip of a branch changes.
1149
# the api signature is
1150
# (params) where params is a ChangeBranchTipParams with the members
1151
# (branch, old_revno, new_revno, old_revid, new_revid)
1152
self['post_change_branch_tip'] = []
1155
# install the default hooks into the Branch class.
1156
Branch.hooks = BranchHooks()
1159
class ChangeBranchTipParams(object):
1160
"""Object holding parameters passed to *_change_branch_tip hooks.
1162
There are 5 fields that hooks may wish to access:
1164
:ivar branch: the branch being changed
1165
:ivar old_revno: revision number before the change
1166
:ivar new_revno: revision number after the change
1167
:ivar old_revid: revision id before the change
1168
:ivar new_revid: revision id after the change
1170
The revid fields are strings. The revno fields are integers.
1173
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1174
"""Create a group of ChangeBranchTip parameters.
1176
:param branch: The branch being changed.
1177
:param old_revno: Revision number before the change.
1178
:param new_revno: Revision number after the change.
1179
:param old_revid: Tip revision id before the change.
1180
:param new_revid: Tip revision id after the change.
1182
self.branch = branch
1183
self.old_revno = old_revno
1184
self.new_revno = new_revno
1185
self.old_revid = old_revid
1186
self.new_revid = new_revid
1188
def __eq__(self, other):
1189
return self.__dict__ == other.__dict__
1192
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1193
self.__class__.__name__, self.branch,
1194
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1197
class BzrBranchFormat4(BranchFormat):
1198
"""Bzr branch format 4.
1201
- a revision-history file.
1202
- a branch-lock lock file [ to be shared with the bzrdir ]
1205
def get_format_description(self):
1206
"""See BranchFormat.get_format_description()."""
1207
return "Branch format 4"
1209
def initialize(self, a_bzrdir):
1210
"""Create a branch of this format in a_bzrdir."""
1211
utf8_files = [('revision-history', ''),
1212
('branch-name', ''),
1214
return self._initialize_helper(a_bzrdir, utf8_files,
1215
lock_type='branch4', set_format=False)
1218
super(BzrBranchFormat4, self).__init__()
1219
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1221
def open(self, a_bzrdir, _found=False):
1222
"""Return the branch object for a_bzrdir
1224
_found is a private parameter, do not use it. It is used to indicate
1225
if format probing has already be done.
1228
# we are being called directly and must probe.
1229
raise NotImplementedError
1230
return BzrBranch(_format=self,
1231
_control_files=a_bzrdir._control_files,
1233
_repository=a_bzrdir.open_repository())
1236
return "Bazaar-NG branch format 4"
1239
class BranchFormatMetadir(BranchFormat):
1240
"""Common logic for meta-dir based branch formats."""
1242
def _branch_class(self):
1243
"""What class to instantiate on open calls."""
1244
raise NotImplementedError(self._branch_class)
1246
def open(self, a_bzrdir, _found=False):
1247
"""Return the branch object for a_bzrdir.
1249
_found is a private parameter, do not use it. It is used to indicate
1250
if format probing has already be done.
1253
format = BranchFormat.find_format(a_bzrdir)
1254
if format.__class__ != self.__class__:
1255
raise AssertionError("wrong format %r found for %r" %
1258
transport = a_bzrdir.get_branch_transport(None)
1259
control_files = lockable_files.LockableFiles(transport, 'lock',
1261
return self._branch_class()(_format=self,
1262
_control_files=control_files,
1264
_repository=a_bzrdir.find_repository())
1265
except errors.NoSuchFile:
1266
raise errors.NotBranchError(path=transport.base)
1269
super(BranchFormatMetadir, self).__init__()
1270
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1272
def supports_tags(self):
1276
class BzrBranchFormat5(BranchFormatMetadir):
1277
"""Bzr branch format 5.
1280
- a revision-history file.
1282
- a lock dir guarding the branch itself
1283
- all of this stored in a branch/ subdirectory
1284
- works with shared repositories.
1286
This format is new in bzr 0.8.
1289
def _branch_class(self):
1292
def get_format_string(self):
1293
"""See BranchFormat.get_format_string()."""
1294
return "Bazaar-NG branch format 5\n"
1296
def get_format_description(self):
1297
"""See BranchFormat.get_format_description()."""
1298
return "Branch format 5"
1300
def initialize(self, a_bzrdir):
1301
"""Create a branch of this format in a_bzrdir."""
1302
utf8_files = [('revision-history', ''),
1303
('branch-name', ''),
1305
return self._initialize_helper(a_bzrdir, utf8_files)
1307
def supports_tags(self):
1311
class BzrBranchFormat6(BranchFormatMetadir):
1312
"""Branch format with last-revision and tags.
1314
Unlike previous formats, this has no explicit revision history. Instead,
1315
this just stores the last-revision, and the left-hand history leading
1316
up to there is the history.
1318
This format was introduced in bzr 0.15
1319
and became the default in 0.91.
1322
def _branch_class(self):
1325
def get_format_string(self):
1326
"""See BranchFormat.get_format_string()."""
1327
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1329
def get_format_description(self):
1330
"""See BranchFormat.get_format_description()."""
1331
return "Branch format 6"
1333
def initialize(self, a_bzrdir):
1334
"""Create a branch of this format in a_bzrdir."""
1335
utf8_files = [('last-revision', '0 null:\n'),
1336
('branch.conf', ''),
1339
return self._initialize_helper(a_bzrdir, utf8_files)
1342
class BzrBranchFormat7(BranchFormatMetadir):
1343
"""Branch format with last-revision, tags, and a stacked location pointer.
1345
The stacked location pointer is passed down to the repository and requires
1346
a repository format with supports_external_lookups = True.
1348
This format was introduced in bzr 1.6.
1351
def _branch_class(self):
1354
def get_format_string(self):
1355
"""See BranchFormat.get_format_string()."""
1356
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1358
def get_format_description(self):
1359
"""See BranchFormat.get_format_description()."""
1360
return "Branch format 7"
1362
def initialize(self, a_bzrdir):
1363
"""Create a branch of this format in a_bzrdir."""
1364
utf8_files = [('last-revision', '0 null:\n'),
1365
('branch.conf', ''),
1368
return self._initialize_helper(a_bzrdir, utf8_files)
1371
super(BzrBranchFormat7, self).__init__()
1372
self._matchingbzrdir.repository_format = \
1373
RepositoryFormatPackDevelopment1Subtree()
1375
def supports_stacking(self):
1379
class BranchReferenceFormat(BranchFormat):
1380
"""Bzr branch reference format.
1382
Branch references are used in implementing checkouts, they
1383
act as an alias to the real branch which is at some other url.
1390
def get_format_string(self):
1391
"""See BranchFormat.get_format_string()."""
1392
return "Bazaar-NG Branch Reference Format 1\n"
1394
def get_format_description(self):
1395
"""See BranchFormat.get_format_description()."""
1396
return "Checkout reference format 1"
1398
def get_reference(self, a_bzrdir):
1399
"""See BranchFormat.get_reference()."""
1400
transport = a_bzrdir.get_branch_transport(None)
1401
return transport.get('location').read()
1403
def set_reference(self, a_bzrdir, to_branch):
1404
"""See BranchFormat.set_reference()."""
1405
transport = a_bzrdir.get_branch_transport(None)
1406
location = transport.put_bytes('location', to_branch.base)
1408
def initialize(self, a_bzrdir, target_branch=None):
1409
"""Create a branch of this format in a_bzrdir."""
1410
if target_branch is None:
1411
# this format does not implement branch itself, thus the implicit
1412
# creation contract must see it as uninitializable
1413
raise errors.UninitializableFormat(self)
1414
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1415
branch_transport = a_bzrdir.get_branch_transport(self)
1416
branch_transport.put_bytes('location',
1417
target_branch.bzrdir.root_transport.base)
1418
branch_transport.put_bytes('format', self.get_format_string())
1420
a_bzrdir, _found=True,
1421
possible_transports=[target_branch.bzrdir.root_transport])
1424
super(BranchReferenceFormat, self).__init__()
1425
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1427
def _make_reference_clone_function(format, a_branch):
1428
"""Create a clone() routine for a branch dynamically."""
1429
def clone(to_bzrdir, revision_id=None):
1430
"""See Branch.clone()."""
1431
return format.initialize(to_bzrdir, a_branch)
1432
# cannot obey revision_id limits when cloning a reference ...
1433
# FIXME RBC 20060210 either nuke revision_id for clone, or
1434
# emit some sort of warning/error to the caller ?!
1437
def open(self, a_bzrdir, _found=False, location=None,
1438
possible_transports=None):
1439
"""Return the branch that the branch reference in a_bzrdir points at.
1441
_found is a private parameter, do not use it. It is used to indicate
1442
if format probing has already be done.
1445
format = BranchFormat.find_format(a_bzrdir)
1446
if format.__class__ != self.__class__:
1447
raise AssertionError("wrong format %r found for %r" %
1449
if location is None:
1450
location = self.get_reference(a_bzrdir)
1451
real_bzrdir = bzrdir.BzrDir.open(
1452
location, possible_transports=possible_transports)
1453
result = real_bzrdir.open_branch()
1454
# this changes the behaviour of result.clone to create a new reference
1455
# rather than a copy of the content of the branch.
1456
# I did not use a proxy object because that needs much more extensive
1457
# testing, and we are only changing one behaviour at the moment.
1458
# If we decide to alter more behaviours - i.e. the implicit nickname
1459
# then this should be refactored to introduce a tested proxy branch
1460
# and a subclass of that for use in overriding clone() and ....
1462
result.clone = self._make_reference_clone_function(result)
1466
# formats which have no format string are not discoverable
1467
# and not independently creatable, so are not registered.
1468
__format5 = BzrBranchFormat5()
1469
__format6 = BzrBranchFormat6()
1470
__format7 = BzrBranchFormat7()
1471
BranchFormat.register_format(__format5)
1472
BranchFormat.register_format(BranchReferenceFormat())
1473
BranchFormat.register_format(__format6)
1474
BranchFormat.register_format(__format7)
1475
BranchFormat.set_default_format(__format6)
1476
_legacy_formats = [BzrBranchFormat4(),
1479
class BzrBranch(Branch):
1480
"""A branch stored in the actual filesystem.
1482
Note that it's "local" in the context of the filesystem; it doesn't
1483
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1484
it's writable, and can be accessed via the normal filesystem API.
1486
:ivar _transport: Transport for file operations on this branch's
1487
control files, typically pointing to the .bzr/branch directory.
1488
:ivar repository: Repository for this branch.
1489
:ivar base: The url of the base directory for this branch; the one
1490
containing the .bzr directory.
1493
def __init__(self, _format=None,
1494
_control_files=None, a_bzrdir=None, _repository=None):
1495
"""Create new branch object at a particular location."""
1496
if a_bzrdir is None:
1497
raise ValueError('a_bzrdir must be supplied')
1499
self.bzrdir = a_bzrdir
1500
self._base = self.bzrdir.transport.clone('..').base
1501
# XXX: We should be able to just do
1502
# self.base = self.bzrdir.root_transport.base
1503
# but this does not quite work yet -- mbp 20080522
1504
self._format = _format
1505
if _control_files is None:
1506
raise ValueError('BzrBranch _control_files is None')
1507
self.control_files = _control_files
1508
self._transport = _control_files._transport
1509
self.repository = _repository
1510
Branch.__init__(self)
1513
return '%s(%r)' % (self.__class__.__name__, self.base)
1517
def _get_base(self):
1518
"""Returns the directory containing the control directory."""
1521
base = property(_get_base, doc="The URL for the root of this branch.")
1523
@deprecated_method(deprecated_in((0, 16, 0)))
1524
def abspath(self, name):
1525
"""See Branch.abspath."""
1526
return self._transport.abspath(name)
1528
def is_locked(self):
1529
return self.control_files.is_locked()
1531
def lock_write(self, token=None):
1532
repo_token = self.repository.lock_write()
1534
token = self.control_files.lock_write(token=token)
1536
self.repository.unlock()
1540
def lock_read(self):
1541
self.repository.lock_read()
1543
self.control_files.lock_read()
1545
self.repository.unlock()
1549
# TODO: test for failed two phase locks. This is known broken.
1551
self.control_files.unlock()
1553
self.repository.unlock()
1554
if not self.control_files.is_locked():
1555
# we just released the lock
1556
self._clear_cached_state()
1558
def peek_lock_mode(self):
1559
if self.control_files._lock_count == 0:
1562
return self.control_files._lock_mode
1564
def get_physical_lock_status(self):
1565
return self.control_files.get_physical_lock_status()
1568
def print_file(self, file, revision_id):
1569
"""See Branch.print_file."""
1570
return self.repository.print_file(file, revision_id)
1572
def _write_revision_history(self, history):
1573
"""Factored out of set_revision_history.
1575
This performs the actual writing to disk.
1576
It is intended to be called by BzrBranch5.set_revision_history."""
1577
self._transport.put_bytes(
1578
'revision-history', '\n'.join(history),
1579
mode=self.bzrdir._get_file_mode())
1582
def set_revision_history(self, rev_history):
1583
"""See Branch.set_revision_history."""
1584
if 'evil' in debug.debug_flags:
1585
mutter_callsite(3, "set_revision_history scales with history.")
1586
check_not_reserved_id = _mod_revision.check_not_reserved_id
1587
for rev_id in rev_history:
1588
check_not_reserved_id(rev_id)
1589
if Branch.hooks['post_change_branch_tip']:
1590
# Don't calculate the last_revision_info() if there are no hooks
1592
old_revno, old_revid = self.last_revision_info()
1593
if len(rev_history) == 0:
1594
revid = _mod_revision.NULL_REVISION
1596
revid = rev_history[-1]
1597
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1598
self._write_revision_history(rev_history)
1599
self._clear_cached_state()
1600
self._cache_revision_history(rev_history)
1601
for hook in Branch.hooks['set_rh']:
1602
hook(self, rev_history)
1603
if Branch.hooks['post_change_branch_tip']:
1604
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1606
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1607
"""Run the pre_change_branch_tip hooks."""
1608
hooks = Branch.hooks['pre_change_branch_tip']
1611
old_revno, old_revid = self.last_revision_info()
1612
params = ChangeBranchTipParams(
1613
self, old_revno, new_revno, old_revid, new_revid)
1617
except errors.TipChangeRejected:
1620
exc_info = sys.exc_info()
1621
hook_name = Branch.hooks.get_hook_name(hook)
1622
raise errors.HookFailed(
1623
'pre_change_branch_tip', hook_name, exc_info)
1625
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1626
"""Run the post_change_branch_tip hooks."""
1627
hooks = Branch.hooks['post_change_branch_tip']
1630
new_revno, new_revid = self.last_revision_info()
1631
params = ChangeBranchTipParams(
1632
self, old_revno, new_revno, old_revid, new_revid)
1637
def set_last_revision_info(self, revno, revision_id):
1638
"""Set the last revision of this branch.
1640
The caller is responsible for checking that the revno is correct
1641
for this revision id.
1643
It may be possible to set the branch last revision to an id not
1644
present in the repository. However, branches can also be
1645
configured to check constraints on history, in which case this may not
1648
revision_id = _mod_revision.ensure_null(revision_id)
1649
# this old format stores the full history, but this api doesn't
1650
# provide it, so we must generate, and might as well check it's
1652
history = self._lefthand_history(revision_id)
1653
if len(history) != revno:
1654
raise AssertionError('%d != %d' % (len(history), revno))
1655
self.set_revision_history(history)
1657
def _gen_revision_history(self):
1658
history = self._transport.get_bytes('revision-history').split('\n')
1659
if history[-1:] == ['']:
1660
# There shouldn't be a trailing newline, but just in case.
1664
def _lefthand_history(self, revision_id, last_rev=None,
1666
if 'evil' in debug.debug_flags:
1667
mutter_callsite(4, "_lefthand_history scales with history.")
1668
# stop_revision must be a descendant of last_revision
1669
graph = self.repository.get_graph()
1670
if last_rev is not None:
1671
if not graph.is_ancestor(last_rev, revision_id):
1672
# our previous tip is not merged into stop_revision
1673
raise errors.DivergedBranches(self, other_branch)
1674
# make a new revision history from the graph
1675
parents_map = graph.get_parent_map([revision_id])
1676
if revision_id not in parents_map:
1677
raise errors.NoSuchRevision(self, revision_id)
1678
current_rev_id = revision_id
1680
check_not_reserved_id = _mod_revision.check_not_reserved_id
1681
# Do not include ghosts or graph origin in revision_history
1682
while (current_rev_id in parents_map and
1683
len(parents_map[current_rev_id]) > 0):
1684
check_not_reserved_id(current_rev_id)
1685
new_history.append(current_rev_id)
1686
current_rev_id = parents_map[current_rev_id][0]
1687
parents_map = graph.get_parent_map([current_rev_id])
1688
new_history.reverse()
1692
def generate_revision_history(self, revision_id, last_rev=None,
1694
"""Create a new revision history that will finish with revision_id.
1696
:param revision_id: the new tip to use.
1697
:param last_rev: The previous last_revision. If not None, then this
1698
must be a ancestory of revision_id, or DivergedBranches is raised.
1699
:param other_branch: The other branch that DivergedBranches should
1700
raise with respect to.
1702
self.set_revision_history(self._lefthand_history(revision_id,
1703
last_rev, other_branch))
1705
def basis_tree(self):
1706
"""See Branch.basis_tree."""
1707
return self.repository.revision_tree(self.last_revision())
1710
def pull(self, source, overwrite=False, stop_revision=None,
1711
_hook_master=None, run_hooks=True, possible_transports=None,
1712
_override_hook_target=None):
1715
:param _hook_master: Private parameter - set the branch to
1716
be supplied as the master to pull hooks.
1717
:param run_hooks: Private parameter - if false, this branch
1718
is being called because it's the master of the primary branch,
1719
so it should not run its hooks.
1720
:param _override_hook_target: Private parameter - set the branch to be
1721
supplied as the target_branch to pull hooks.
1723
result = PullResult()
1724
result.source_branch = source
1725
if _override_hook_target is None:
1726
result.target_branch = self
1728
result.target_branch = _override_hook_target
1731
# We assume that during 'pull' the local repository is closer than
1733
graph = self.repository.get_graph(source.repository)
1734
result.old_revno, result.old_revid = self.last_revision_info()
1735
self.update_revisions(source, stop_revision, overwrite=overwrite,
1737
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1738
result.new_revno, result.new_revid = self.last_revision_info()
1740
result.master_branch = _hook_master
1741
result.local_branch = result.target_branch
1743
result.master_branch = result.target_branch
1744
result.local_branch = None
1746
for hook in Branch.hooks['post_pull']:
1752
def _get_parent_location(self):
1753
_locs = ['parent', 'pull', 'x-pull']
1756
return self._transport.get_bytes(l).strip('\n')
1757
except errors.NoSuchFile:
1762
def push(self, target, overwrite=False, stop_revision=None,
1763
_override_hook_source_branch=None):
1766
This is the basic concrete implementation of push()
1768
:param _override_hook_source_branch: If specified, run
1769
the hooks passing this Branch as the source, rather than self.
1770
This is for use of RemoteBranch, where push is delegated to the
1771
underlying vfs-based Branch.
1773
# TODO: Public option to disable running hooks - should be trivial but
1777
result = self._push_with_bound_branches(target, overwrite,
1779
_override_hook_source_branch=_override_hook_source_branch)
1784
def _push_with_bound_branches(self, target, overwrite,
1786
_override_hook_source_branch=None):
1787
"""Push from self into target, and into target's master if any.
1789
This is on the base BzrBranch class even though it doesn't support
1790
bound branches because the *target* might be bound.
1793
if _override_hook_source_branch:
1794
result.source_branch = _override_hook_source_branch
1795
for hook in Branch.hooks['post_push']:
1798
bound_location = target.get_bound_location()
1799
if bound_location and target.base != bound_location:
1800
# there is a master branch.
1802
# XXX: Why the second check? Is it even supported for a branch to
1803
# be bound to itself? -- mbp 20070507
1804
master_branch = target.get_master_branch()
1805
master_branch.lock_write()
1807
# push into the master from this branch.
1808
self._basic_push(master_branch, overwrite, stop_revision)
1809
# and push into the target branch from this. Note that we push from
1810
# this branch again, because its considered the highest bandwidth
1812
result = self._basic_push(target, overwrite, stop_revision)
1813
result.master_branch = master_branch
1814
result.local_branch = target
1818
master_branch.unlock()
1821
result = self._basic_push(target, overwrite, stop_revision)
1822
# TODO: Why set master_branch and local_branch if there's no
1823
# binding? Maybe cleaner to just leave them unset? -- mbp
1825
result.master_branch = target
1826
result.local_branch = None
1830
def _basic_push(self, target, overwrite, stop_revision):
1831
"""Basic implementation of push without bound branches or hooks.
1833
Must be called with self read locked and target write locked.
1835
result = PushResult()
1836
result.source_branch = self
1837
result.target_branch = target
1838
result.old_revno, result.old_revid = target.last_revision_info()
1840
# We assume that during 'push' this repository is closer than
1842
graph = self.repository.get_graph(target.repository)
1843
target.update_revisions(self, stop_revision, overwrite=overwrite,
1845
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1846
result.new_revno, result.new_revid = target.last_revision_info()
1849
def get_parent(self):
1850
"""See Branch.get_parent."""
1851
parent = self._get_parent_location()
1854
# This is an old-format absolute path to a local branch
1855
# turn it into a url
1856
if parent.startswith('/'):
1857
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1859
return urlutils.join(self.base[:-1], parent)
1860
except errors.InvalidURLJoin, e:
1861
raise errors.InaccessibleParent(parent, self.base)
1863
def get_stacked_on_url(self):
1864
raise errors.UnstackableBranchFormat(self._format, self.base)
1866
def set_push_location(self, location):
1867
"""See Branch.set_push_location."""
1868
self.get_config().set_user_option(
1869
'push_location', location,
1870
store=_mod_config.STORE_LOCATION_NORECURSE)
1873
def set_parent(self, url):
1874
"""See Branch.set_parent."""
1875
# TODO: Maybe delete old location files?
1876
# URLs should never be unicode, even on the local fs,
1877
# FIXUP this and get_parent in a future branch format bump:
1878
# read and rewrite the file. RBC 20060125
1880
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)
1882
url = url.encode('ascii')
1883
except UnicodeEncodeError:
1884
raise errors.InvalidURL(url,
1885
"Urls must be 7-bit ascii, "
1886
"use bzrlib.urlutils.escape")
1887
url = urlutils.relative_url(self.base, url)
1888
self._set_parent_location(url)
1890
def _set_parent_location(self, url):
1892
self._transport.delete('parent')
1894
self._transport.put_bytes('parent', url + '\n',
1895
mode=self.bzrdir._get_file_mode())
1897
def set_stacked_on_url(self, url):
1898
raise errors.UnstackableBranchFormat(self._format, self.base)
1901
class BzrBranch5(BzrBranch):
1902
"""A format 5 branch. This supports new features over plain branches.
1904
It has support for a master_branch which is the data for bound branches.
1908
def pull(self, source, overwrite=False, stop_revision=None,
1909
run_hooks=True, possible_transports=None,
1910
_override_hook_target=None):
1911
"""Pull from source into self, updating my master if any.
1913
:param run_hooks: Private parameter - if false, this branch
1914
is being called because it's the master of the primary branch,
1915
so it should not run its hooks.
1917
bound_location = self.get_bound_location()
1918
master_branch = None
1919
if bound_location and source.base != bound_location:
1920
# not pulling from master, so we need to update master.
1921
master_branch = self.get_master_branch(possible_transports)
1922
master_branch.lock_write()
1925
# pull from source into master.
1926
master_branch.pull(source, overwrite, stop_revision,
1928
return super(BzrBranch5, self).pull(source, overwrite,
1929
stop_revision, _hook_master=master_branch,
1930
run_hooks=run_hooks,
1931
_override_hook_target=_override_hook_target)
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
1934
master_branch.unlock()
1936
def get_bound_location(self):
1938
return self._transport.get_bytes('bound')[:-1]
1939
except errors.NoSuchFile:
1943
def get_master_branch(self, possible_transports=None):
1944
"""Return the branch we are bound to.
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')
1946
:return: Either a Branch, or None
1948
This could memoise the branch, but if thats done
1949
it must be revalidated on each new lock.
1950
So for now we just don't memoise it.
1951
# RBC 20060304 review this decision.
1953
bound_loc = self.get_bound_location()
1957
return Branch.open(bound_loc,
1958
possible_transports=possible_transports)
1959
except (errors.NotBranchError, errors.ConnectionError), e:
1960
raise errors.BoundBranchConnectionFailure(
1964
def set_bound_location(self, location):
1965
"""Set the target where this branch is bound to.
1967
:param location: URL to the target branch
1970
self._transport.put_bytes('bound', location+'\n',
1971
mode=self.bzrdir._get_file_mode())
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:
1974
self._transport.delete('bound')
1975
except errors.NoSuchFile:
1980
def bind(self, other):
1981
"""Bind this branch to the branch other.
1983
This does not push or pull data between the branches, though it does
1984
check for divergence to raise an error when the branches are not
1985
either the same, or one a prefix of the other. That behaviour may not
1986
be useful, so that check may be removed in future.
1988
:param other: The branch to bind to
1991
# TODO: jam 20051230 Consider checking if the target is bound
1992
# It is debatable whether you should be able to bind to
1993
# a branch which is itself bound.
1994
# Committing is obviously forbidden,
1995
# but binding itself may not be.
1996
# Since we *have* to check at commit time, we don't
1997
# *need* to check here
1999
# we want to raise diverged if:
2000
# last_rev is not in the other_last_rev history, AND
2001
# other_last_rev is not in our history, and do it without pulling
2003
self.set_bound_location(other.base)
2007
"""If bound, unbind"""
2008
return self.set_bound_location(None)
2011
def update(self, possible_transports=None):
2012
"""Synchronise this branch with the master branch if any.
2014
:return: None or the last_revision that was pivoted out during the
2017
master = self.get_master_branch(possible_transports)
2018
if master is not None:
2019
old_tip = _mod_revision.ensure_null(self.last_revision())
2020
self.pull(master, overwrite=True)
2021
if self.repository.get_graph().is_ancestor(old_tip,
2022
_mod_revision.ensure_null(self.last_revision())):
2028
class BzrBranch7(BzrBranch5):
2029
"""A branch with support for a fallback repository."""
2031
def _get_fallback_repository(self, url):
2032
"""Get the repository we fallback to at url."""
2033
url = urlutils.join(self.base, url)
2034
return bzrdir.BzrDir.open(url).open_branch().repository
2036
def _activate_fallback_location(self, url):
2037
"""Activate the branch/repository from url as a fallback repository."""
2038
self.repository.add_fallback_repository(
2039
self._get_fallback_repository(url))
2041
def _open_hook(self):
2043
url = self.get_stacked_on_url()
2044
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2045
errors.UnstackableBranchFormat):
2048
self._activate_fallback_location(url)
2050
def _check_stackable_repo(self):
2051
if not self.repository._format.supports_external_lookups:
2052
raise errors.UnstackableRepositoryFormat(self.repository._format,
2053
self.repository.base)
2055
def __init__(self, *args, **kwargs):
2056
super(BzrBranch7, self).__init__(*args, **kwargs)
2057
self._last_revision_info_cache = None
2058
self._partial_revision_history_cache = []
2060
def _clear_cached_state(self):
2061
super(BzrBranch7, self)._clear_cached_state()
2062
self._last_revision_info_cache = None
2063
self._partial_revision_history_cache = []
2065
def _last_revision_info(self):
2066
revision_string = self._transport.get_bytes('last-revision')
2067
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2068
revision_id = cache_utf8.get_cached_utf8(revision_id)
2070
return revno, revision_id
2072
def _write_last_revision_info(self, revno, revision_id):
2073
"""Simply write out the revision id, with no checks.
2075
Use set_last_revision_info to perform this safely.
2077
Does not update the revision_history cache.
2078
Intended to be called by set_last_revision_info and
2079
_write_revision_history.
2081
revision_id = _mod_revision.ensure_null(revision_id)
2082
out_string = '%d %s\n' % (revno, revision_id)
2083
self._transport.put_bytes('last-revision', out_string,
2084
mode=self.bzrdir._get_file_mode())
2087
def set_last_revision_info(self, revno, revision_id):
2088
revision_id = _mod_revision.ensure_null(revision_id)
2089
old_revno, old_revid = self.last_revision_info()
2090
if self._get_append_revisions_only():
2091
self._check_history_violation(revision_id)
2092
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2093
self._write_last_revision_info(revno, revision_id)
2094
self._clear_cached_state()
2095
self._last_revision_info_cache = revno, revision_id
2096
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2098
def _check_history_violation(self, revision_id):
2099
last_revision = _mod_revision.ensure_null(self.last_revision())
2100
if _mod_revision.is_null(last_revision):
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'))
2102
if last_revision not in self._lefthand_history(revision_id):
2103
raise errors.AppendRevisionsOnlyViolation(self.base)
2105
def _gen_revision_history(self):
2106
"""Generate the revision history from last revision
2108
last_revno, last_revision = self.last_revision_info()
2109
self._extend_partial_history(stop_index=last_revno-1)
2110
return list(reversed(self._partial_revision_history_cache))
2112
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2113
"""Extend the partial history to include a given index
2115
If a stop_index is supplied, stop when that index has been reached.
2116
If a stop_revision is supplied, stop when that revision is
2117
encountered. Otherwise, stop when the beginning of history is
2120
:param stop_index: The index which should be present. When it is
2121
present, history extension will stop.
2122
:param revision_id: The revision id which should be present. When
2123
it is encountered, history extension will stop.
2125
repo = self.repository
2126
if len(self._partial_revision_history_cache) == 0:
2127
iterator = repo.iter_reverse_revision_history(self.last_revision())
2129
start_revision = self._partial_revision_history_cache[-1]
2130
iterator = repo.iter_reverse_revision_history(start_revision)
2131
#skip the last revision in the list
2132
next_revision = iterator.next()
2133
for revision_id in iterator:
2134
self._partial_revision_history_cache.append(revision_id)
2135
if (stop_index is not None and
2136
len(self._partial_revision_history_cache) > stop_index):
2138
if revision_id == stop_revision:
2141
def _write_revision_history(self, history):
2142
"""Factored out of set_revision_history.
2144
This performs the actual writing to disk, with format-specific checks.
2145
It is intended to be called by BzrBranch5.set_revision_history.
2147
if len(history) == 0:
2148
last_revision = 'null:'
2150
if history != self._lefthand_history(history[-1]):
2151
raise errors.NotLefthandHistory(history)
2152
last_revision = history[-1]
2153
if self._get_append_revisions_only():
2154
self._check_history_violation(last_revision)
2155
self._write_last_revision_info(len(history), last_revision)
2158
def _set_parent_location(self, url):
2159
"""Set the parent branch"""
2160
self._set_config_location('parent_location', url, make_relative=True)
2163
def _get_parent_location(self):
2164
"""Set the parent branch"""
2165
return self._get_config_location('parent_location')
2167
def set_push_location(self, location):
2168
"""See Branch.set_push_location."""
2169
self._set_config_location('push_location', location)
2171
def set_bound_location(self, location):
2172
"""See Branch.set_push_location."""
2174
config = self.get_config()
2175
if location is None:
2176
if config.get_user_option('bound') != 'True':
2179
config.set_user_option('bound', 'False', warn_masked=True)
2182
self._set_config_location('bound_location', location,
2184
config.set_user_option('bound', 'True', warn_masked=True)
2187
def _get_bound_location(self, bound):
2188
"""Return the bound location in the config file.
2190
Return None if the bound parameter does not match"""
2191
config = self.get_config()
2192
config_bound = (config.get_user_option('bound') == 'True')
2193
if config_bound != bound:
2195
return self._get_config_location('bound_location', config=config)
2197
def get_bound_location(self):
2198
"""See Branch.set_push_location."""
2199
return self._get_bound_location(True)
2201
def get_old_bound_location(self):
2202
"""See Branch.get_old_bound_location"""
2203
return self._get_bound_location(False)
2205
def get_stacked_on_url(self):
2206
self._check_stackable_repo()
2207
stacked_url = self._get_config_location('stacked_on_location')
2208
if stacked_url is None:
2209
raise errors.NotStacked(self)
2212
def set_append_revisions_only(self, enabled):
2217
self.get_config().set_user_option('append_revisions_only', value,
2220
def set_stacked_on_url(self, url):
2221
self._check_stackable_repo()
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1271
>>> b = ScratchBranch()
2224
old_url = self.get_stacked_on_url()
2225
except (errors.NotStacked, errors.UnstackableBranchFormat,
2226
errors.UnstackableRepositoryFormat):
2229
# repositories don't offer an interface to remove fallback
2230
# repositories today; take the conceptually simpler option and just
2232
self.repository = self.bzrdir.find_repository()
2233
# for every revision reference the branch has, ensure it is pulled
2235
source_repository = self._get_fallback_repository(old_url)
2236
for revision_id in chain([self.last_revision()],
2237
self.tags.get_reverse_tag_dict()):
2238
self.repository.fetch(source_repository, revision_id,
2241
self._activate_fallback_location(url)
2242
# write this out after the repository is stacked to avoid setting a
2243
# stacked config that doesn't work.
2244
self._set_config_location('stacked_on_location', url)
2246
def _get_append_revisions_only(self):
2247
value = self.get_config().get_user_option('append_revisions_only')
2248
return value == 'True'
2250
def _synchronize_history(self, destination, revision_id):
2251
"""Synchronize last revision and revision history between branches.
2253
This version is most efficient when the destination is also a
2254
BzrBranch6, but works for BzrBranch5, as long as the destination's
2255
repository contains all the lefthand ancestors of the intended
2256
last_revision. If not, set_last_revision_info will fail.
2258
:param destination: The branch to copy the history into
2259
:param revision_id: The revision-id to truncate history at. May
2260
be None to copy complete history.
2262
source_revno, source_revision_id = self.last_revision_info()
2263
if revision_id is None:
2264
revno, revision_id = source_revno, source_revision_id
2265
elif source_revision_id == revision_id:
2266
# we know the revno without needing to walk all of history
2267
revno = source_revno
2269
# To figure out the revno for a random revision, we need to build
2270
# the revision history, and count its length.
2271
# We don't care about the order, just how long it is.
2272
# Alternatively, we could start at the current location, and count
2273
# backwards. But there is no guarantee that we will find it since
2274
# it may be a merged revision.
2275
revno = len(list(self.repository.iter_reverse_revision_history(
2277
destination.set_last_revision_info(revno, revision_id)
2279
def _make_tags(self):
2280
return BasicTags(self)
2283
def generate_revision_history(self, revision_id, last_rev=None,
2285
"""See BzrBranch5.generate_revision_history"""
2286
history = self._lefthand_history(revision_id, last_rev, other_branch)
2287
revno = len(history)
2288
self.set_last_revision_info(revno, revision_id)
2291
def get_rev_id(self, revno, history=None):
2292
"""Find the revision id of the specified revno."""
2294
return _mod_revision.NULL_REVISION
2296
last_revno, last_revision_id = self.last_revision_info()
2297
if revno <= 0 or revno > last_revno:
2298
raise errors.NoSuchRevision(self, revno)
2300
if history is not None:
2301
return history[revno - 1]
2303
index = last_revno - revno
2304
if len(self._partial_revision_history_cache) <= index:
2305
self._extend_partial_history(stop_index=index)
2306
if len(self._partial_revision_history_cache) > index:
2307
return self._partial_revision_history_cache[index]
2309
raise errors.NoSuchRevision(self, revno)
2312
def revision_id_to_revno(self, revision_id):
2313
"""Given a revision id, return its revno"""
2314
if _mod_revision.is_null(revision_id):
2317
index = self._partial_revision_history_cache.index(revision_id)
2319
self._extend_partial_history(stop_revision=revision_id)
2320
index = len(self._partial_revision_history_cache) - 1
2321
if self._partial_revision_history_cache[index] != revision_id:
2322
raise errors.NoSuchRevision(self, revision_id)
2323
return self.revno() - index
2326
class BzrBranch6(BzrBranch7):
2327
"""See BzrBranchFormat6 for the capabilities of this branch.
2329
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
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)
2333
def get_stacked_on_url(self):
2334
raise errors.UnstackableBranchFormat(self._format, self.base)
2336
def set_stacked_on_url(self, url):
2337
raise errors.UnstackableBranchFormat(self._format, self.base)
1337
2340
######################################################################
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:
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')
2341
# results of operations
2344
class _Result(object):
2346
def _show_tag_conficts(self, to_file):
2347
if not getattr(self, 'tag_conflicts', None):
2349
to_file.write('Conflicting tags:\n')
2350
for name, value1, value2 in self.tag_conflicts:
2351
to_file.write(' %s\n' % (name, ))
2354
class PullResult(_Result):
2355
"""Result of a Branch.pull operation.
2357
:ivar old_revno: Revision number before pull.
2358
:ivar new_revno: Revision number after pull.
2359
:ivar old_revid: Tip revision id before pull.
2360
:ivar new_revid: Tip revision id after pull.
2361
:ivar source_branch: Source (local) branch object.
2362
:ivar master_branch: Master branch of the target, or the target if no
2364
:ivar local_branch: target branch if there is a Master, else None
2365
:ivar target_branch: Target/destination branch object.
2366
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2370
# DEPRECATED: pull used to return the change in revno
2371
return self.new_revno - self.old_revno
2373
def report(self, to_file):
2375
if self.old_revid == self.new_revid:
2376
to_file.write('No revisions to pull.\n')
2378
to_file.write('Now on revision %d.\n' % self.new_revno)
2379
self._show_tag_conficts(to_file)
2382
class PushResult(_Result):
2383
"""Result of a Branch.push operation.
2385
:ivar old_revno: Revision number before push.
2386
:ivar new_revno: Revision number after push.
2387
:ivar old_revid: Tip revision id before push.
2388
:ivar new_revid: Tip revision id after push.
2389
:ivar source_branch: Source branch object.
2390
:ivar master_branch: Master branch of the target, or None.
2391
:ivar target_branch: Target/destination branch object.
2395
# DEPRECATED: push used to return the change in revno
2396
return self.new_revno - self.old_revno
2398
def report(self, to_file):
2399
"""Write a human-readable description of the result."""
2400
if self.old_revid == self.new_revid:
2401
to_file.write('No new revisions to push.\n')
2403
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2404
self._show_tag_conficts(to_file)
2407
class BranchCheckResult(object):
2408
"""Results of checking branch consistency.
2413
def __init__(self, branch):
2414
self.branch = branch
2416
def report_results(self, verbose):
2417
"""Report the check results via trace.note.
2419
:param verbose: Requests more detailed display of what was checked,
2422
note('checked branch %s format %s',
2424
self.branch._format)
2427
class Converter5to6(object):
2428
"""Perform an in-place upgrade of format 5 to format 6"""
2430
def convert(self, branch):
2431
# Data for 5 and 6 can peacefully coexist.
2432
format = BzrBranchFormat6()
2433
new_branch = format.open(branch.bzrdir, _found=True)
2435
# Copy source data into target
2436
new_branch._write_last_revision_info(*branch.last_revision_info())
2437
new_branch.set_parent(branch.get_parent())
2438
new_branch.set_bound_location(branch.get_bound_location())
2439
new_branch.set_push_location(branch.get_push_location())
2441
# New branch has no tags by default
2442
new_branch.tags._set_tag_dict({})
2444
# Copying done; now update target format
2445
new_branch._transport.put_bytes('format',
2446
format.get_format_string(),
2447
mode=new_branch.bzrdir._get_file_mode())
2449
# Clean up old files
2450
new_branch._transport.delete('revision-history')
2452
branch.set_parent(None)
2453
except errors.NoSuchFile:
2455
branch.set_bound_location(None)
2458
class Converter6to7(object):
2459
"""Perform an in-place upgrade of format 6 to format 7"""
2461
def convert(self, branch):
2462
format = BzrBranchFormat7()
2463
branch._set_config_location('stacked_on_location', '')
2464
# update target format
2465
branch._transport.put_bytes('format', format.get_format_string())
added
removed
bzrlib/branch.py
