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
94
hooks = Branch.hooks['open']
99
"""Called by init to allow simpler extension of the base class."""
101
def break_lock(self):
102
"""Break a lock if one is present from another instance.
104
Uses the ui factory to ask for confirmation if the lock may be from
107
This will probe the repository for its lock as well.
109
self.control_files.break_lock()
110
self.repository.break_lock()
111
master = self.get_master_branch()
112
if master is not None:
116
def open(base, _unsupported=False, possible_transports=None):
117
"""Open the branch rooted at base.
119
For instance, if the branch is at URL/.bzr/branch,
120
Branch.open(URL) -> a Branch instance.
122
control = bzrdir.BzrDir.open(base, _unsupported,
123
possible_transports=possible_transports)
124
return control.open_branch(_unsupported)
127
def open_from_transport(transport, _unsupported=False):
128
"""Open the branch rooted at transport"""
129
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
130
return control.open_branch(_unsupported)
133
def open_containing(url, possible_transports=None):
134
"""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.
136
This probes for a branch at url, and searches upwards from there.
138
Basically we keep looking up until we find the control directory or
139
run into the root. If there isn't one, raises NotBranchError.
140
If there is one and it is either an unrecognised format or an unsupported
141
format, UnknownFormatError or UnsupportedFormatError are raised.
142
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)
144
control, relpath = bzrdir.BzrDir.open_containing(url,
146
return control.open_branch(), relpath
148
def get_config(self):
149
return BranchConfig(self)
151
def _get_nick(self, local=False, possible_transports=None):
152
config = self.get_config()
153
# explicit overrides master, but don't look for master if local is True
154
if not local and not config.has_explicit_nickname():
156
master = self.get_master_branch(possible_transports)
157
if master is not None:
158
# return the master branch value
160
except errors.BzrError, e:
161
# Silently fall back to local implicit nick if the master is
163
mutter("Could not connect to bound branch, "
164
"falling back to local nick.\n " + str(e))
165
return config.get_nickname()
167
def _set_nick(self, nick):
168
self.get_config().set_user_option('nickname', nick, warn_masked=True)
170
nick = property(_get_nick, _set_nick)
173
raise NotImplementedError(self.is_locked)
212
175
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'
176
raise NotImplementedError(self.lock_write)
228
178
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'
179
raise NotImplementedError(self.lock_read)
242
181
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
252
self._lock_mode = self._lock_count = None
255
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
182
raise NotImplementedError(self.unlock)
184
def peek_lock_mode(self):
185
"""Return lock mode for the Branch: 'r', 'w' or None"""
186
raise NotImplementedError(self.peek_lock_mode)
188
def get_physical_lock_status(self):
189
raise NotImplementedError(self.get_physical_lock_status)
192
def get_revision_id_to_revno_map(self):
193
"""Return the revision_id => dotted revno map.
195
This will be regenerated on demand, but will be cached.
197
:return: A dictionary mapping revision_id => dotted revno.
198
This dictionary should not be modified by the caller.
200
if self._revision_id_to_revno_cache is not None:
201
mapping = self._revision_id_to_revno_cache
203
mapping = self._gen_revno_map()
204
self._cache_revision_id_to_revno(mapping)
205
# TODO: jam 20070417 Since this is being cached, should we be returning
207
# I would rather not, and instead just declare that users should not
208
# modify the return value.
211
def _gen_revno_map(self):
212
"""Create a new mapping from revision ids to dotted revnos.
214
Dotted revnos are generated based on the current tip in the revision
216
This is the worker function for get_revision_id_to_revno_map, which
217
just caches the return value.
219
:return: A dictionary mapping revision_id => dotted revno.
221
last_revision = self.last_revision()
222
revision_graph = repository._old_get_graph(self.repository,
224
merge_sorted_revisions = tsort.merge_sort(
229
revision_id_to_revno = dict((rev_id, revno)
230
for seq_num, rev_id, depth, revno, end_of_merge
231
in merge_sorted_revisions)
232
return revision_id_to_revno
234
def leave_lock_in_place(self):
235
"""Tell this branch object not to release the physical lock when this
238
If lock_write doesn't return a token, then this method is not supported.
240
self.control_files.leave_in_place()
242
def dont_leave_lock_in_place(self):
243
"""Tell this branch object to release the physical lock when this
244
object is unlocked, even if it didn't originally acquire it.
246
If lock_write doesn't return a token, then this method is not supported.
248
self.control_files.dont_leave_in_place()
250
def bind(self, other):
251
"""Bind the local branch the other branch.
253
:param other: The branch to bind to
256
raise errors.UpgradeRequired(self.base)
259
def fetch(self, from_branch, last_revision=None, pb=None):
260
"""Copy revisions from from_branch into this branch.
262
:param from_branch: Where to copy from.
263
:param last_revision: What revision to stop at (None for at the end
265
:param pb: An optional progress bar to use.
267
Returns the copied revision count and the failed revisions in a tuple:
270
if self.base == from_branch.base:
273
nested_pb = ui.ui_factory.nested_progress_bar()
278
from_branch.lock_read()
280
if last_revision is None:
281
pb.update('get source history')
282
last_revision = from_branch.last_revision()
283
last_revision = _mod_revision.ensure_null(last_revision)
284
return self.repository.fetch(from_branch.repository,
285
revision_id=last_revision,
288
if nested_pb is not None:
292
def get_bound_location(self):
293
"""Return the URL of the branch we are bound to.
295
Older format branches cannot bind, please be sure to use a metadir
300
def get_old_bound_location(self):
301
"""Return the URL of the branch we used to be bound to
303
raise errors.UpgradeRequired(self.base)
305
def get_commit_builder(self, parents, config=None, timestamp=None,
306
timezone=None, committer=None, revprops=None,
308
"""Obtain a CommitBuilder for this branch.
310
:param parents: Revision ids of the parents of the new revision.
311
:param config: Optional configuration to use.
312
:param timestamp: Optional timestamp recorded for commit.
313
:param timezone: Optional timezone for timestamp.
314
:param committer: Optional committer to set for commit.
315
:param revprops: Optional dictionary of revision properties.
316
:param revision_id: Optional revision id.
320
config = self.get_config()
322
return self.repository.get_commit_builder(self, parents, config,
323
timestamp, timezone, committer, revprops, revision_id)
325
def get_master_branch(self, possible_transports=None):
326
"""Return the branch we are bound to.
328
:return: Either a Branch, or None
617
332
def get_revision_delta(self, revno):
618
333
"""Return the delta for one revision.
789
481
common_index = min(self_len, other_len) -1
790
482
if common_index >= 0 and \
791
483
self_history[common_index] != other_history[common_index]:
792
raise DivergedBranches(self, other)
484
raise errors.DivergedBranches(self, other)
794
486
if stop_revision is None:
795
487
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
489
if stop_revision > other_len:
490
raise errors.NoSuchRevision(self, stop_revision)
799
491
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())
1053
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))
1066
def rename_one(self, from_rel, to_rel):
1069
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)
1117
def move(self, from_paths, to_name):
1120
to_name must exist as a versioned directory.
1122
If to_name exists and is a directory, the files are moved into
1123
it, keeping their old names. If it is a directory,
1125
Note that to_name is only the last component of the new name;
1126
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)
494
def update_revisions(self, other, stop_revision=None, overwrite=False,
496
"""Pull in new perfect-fit revisions.
498
:param other: Another Branch to pull from
499
:param stop_revision: Updated until the given revision
500
:param overwrite: Always set the branch pointer, rather than checking
501
to see if it is a proper descendant.
502
:param graph: A Graph object that can be used to query history
503
information. This can be None.
508
other_revno, other_last_revision = other.last_revision_info()
509
stop_revno = None # unknown
510
if stop_revision is None:
511
stop_revision = other_last_revision
512
if _mod_revision.is_null(stop_revision):
513
# if there are no commits, we're done.
515
stop_revno = other_revno
517
# what's the current last revision, before we fetch [and change it
519
last_rev = _mod_revision.ensure_null(self.last_revision())
520
# we fetch here so that we don't process data twice in the common
521
# case of having something to pull, and so that the check for
522
# already merged can operate on the just fetched graph, which will
523
# be cached in memory.
524
self.fetch(other, stop_revision)
525
# Check to see if one is an ancestor of the other
528
graph = self.repository.get_graph()
529
if self._check_if_descendant_or_diverged(
530
stop_revision, last_rev, graph, other):
531
# stop_revision is a descendant of last_rev, but we aren't
532
# overwriting, so we're done.
534
if stop_revno is None:
536
graph = self.repository.get_graph()
537
this_revno, this_last_revision = self.last_revision_info()
538
stop_revno = graph.find_distance_to_null(stop_revision,
539
[(other_last_revision, other_revno),
540
(this_last_revision, this_revno)])
541
self.set_last_revision_info(stop_revno, stop_revision)
545
def revision_id_to_revno(self, revision_id):
546
"""Given a revision id, return its revno"""
547
if _mod_revision.is_null(revision_id):
549
history = self.revision_history()
551
return history.index(revision_id) + 1
553
raise errors.NoSuchRevision(self, revision_id)
555
def get_rev_id(self, revno, history=None):
556
"""Find the revision id of the specified revno."""
558
return _mod_revision.NULL_REVISION
560
history = self.revision_history()
561
if revno <= 0 or revno > len(history):
562
raise errors.NoSuchRevision(self, revno)
563
return history[revno - 1]
565
def pull(self, source, overwrite=False, stop_revision=None,
566
possible_transports=None, _override_hook_target=None):
567
"""Mirror source into this branch.
569
This branch is considered to be 'local', having low latency.
571
:returns: PullResult instance
573
raise NotImplementedError(self.pull)
575
def push(self, target, overwrite=False, stop_revision=None):
576
"""Mirror this branch into target.
578
This branch is considered to be 'local', having low latency.
580
raise NotImplementedError(self.push)
582
def basis_tree(self):
583
"""Return `Tree` object for last revision."""
584
return self.repository.revision_tree(self.last_revision())
586
def get_parent(self):
587
"""Return the parent location of the branch.
589
This is the default location for push/pull/missing. The usual
590
pattern is that the user can override it by specifying a
593
raise NotImplementedError(self.get_parent)
595
def _set_config_location(self, name, url, config=None,
596
make_relative=False):
598
config = self.get_config()
602
url = urlutils.relative_url(self.base, url)
603
config.set_user_option(name, url, warn_masked=True)
605
def _get_config_location(self, name, config=None):
607
config = self.get_config()
608
location = config.get_user_option(name)
613
def get_submit_branch(self):
614
"""Return the submit location of the branch.
616
This is the default location for bundle. The usual
617
pattern is that the user can override it by specifying a
620
return self.get_config().get_user_option('submit_branch')
622
def set_submit_branch(self, location):
623
"""Return the submit location of the branch.
625
This is the default location for bundle. The usual
626
pattern is that the user can override it by specifying a
629
self.get_config().set_user_option('submit_branch', location,
632
def get_public_branch(self):
633
"""Return the public location of the branch.
635
This is is used by merge directives.
637
return self._get_config_location('public_branch')
639
def set_public_branch(self, location):
640
"""Return the submit location of the branch.
642
This is the default location for bundle. The usual
643
pattern is that the user can override it by specifying a
646
self._set_config_location('public_branch', location)
648
def get_push_location(self):
649
"""Return the None or the location to push this branch to."""
650
push_loc = self.get_config().get_user_option('push_location')
653
def set_push_location(self, location):
654
"""Set a new push location for this branch."""
655
raise NotImplementedError(self.set_push_location)
657
def set_parent(self, url):
658
raise NotImplementedError(self.set_parent)
662
"""Synchronise this branch with the master branch if any.
664
:return: None or the last_revision pivoted out during the update.
668
def check_revno(self, revno):
670
Check whether a revno corresponds to any revision.
671
Zero (the NULL revision) is considered valid.
674
self.check_real_revno(revno)
676
def check_real_revno(self, revno):
678
Check whether a revno corresponds to a real revision.
679
Zero (the NULL revision) is considered invalid
681
if revno < 1 or revno > self.revno():
682
raise errors.InvalidRevisionNumber(revno)
685
def clone(self, to_bzrdir, revision_id=None):
686
"""Clone this branch into to_bzrdir preserving all semantic values.
688
revision_id: if not None, the revision history in the new branch will
689
be truncated to end with revision_id.
691
result = to_bzrdir.create_branch()
692
self.copy_content_into(result, revision_id=revision_id)
696
def sprout(self, to_bzrdir, revision_id=None):
697
"""Create a new line of development from the branch, into to_bzrdir.
699
to_bzrdir controls the branch format.
701
revision_id: if not None, the revision history in the new branch will
702
be truncated to end with revision_id.
704
result = to_bzrdir.create_branch()
705
self.copy_content_into(result, revision_id=revision_id)
706
result.set_parent(self.bzrdir.root_transport.base)
709
def _synchronize_history(self, destination, revision_id):
710
"""Synchronize last revision and revision history between branches.
712
This version is most efficient when the destination is also a
713
BzrBranch6, but works for BzrBranch5, as long as the destination's
714
repository contains all the lefthand ancestors of the intended
715
last_revision. If not, set_last_revision_info will fail.
717
:param destination: The branch to copy the history into
718
:param revision_id: The revision-id to truncate history at. May
719
be None to copy complete history.
721
source_revno, source_revision_id = self.last_revision_info()
722
if revision_id is None:
723
revno, revision_id = source_revno, source_revision_id
724
elif source_revision_id == revision_id:
725
# we know the revno without needing to walk all of history
728
# To figure out the revno for a random revision, we need to build
729
# the revision history, and count its length.
730
# We don't care about the order, just how long it is.
731
# Alternatively, we could start at the current location, and count
732
# backwards. But there is no guarantee that we will find it since
733
# it may be a merged revision.
734
revno = len(list(self.repository.iter_reverse_revision_history(
736
destination.set_last_revision_info(revno, revision_id)
739
def copy_content_into(self, destination, revision_id=None):
740
"""Copy the content of self into destination.
742
revision_id: if not None, the revision history in the new branch will
743
be truncated to end with revision_id.
745
self._synchronize_history(destination, revision_id)
747
parent = self.get_parent()
748
except errors.InaccessibleParent, e:
749
mutter('parent was not accessible to copy: %s', e)
752
destination.set_parent(parent)
753
self.tags.merge_to(destination.tags)
757
"""Check consistency of the branch.
759
In particular this checks that revisions given in the revision-history
760
do actually match up in the revision graph, and that they're all
761
present in the repository.
763
Callers will typically also want to check the repository.
765
:return: A BranchCheckResult.
767
mainline_parent_id = None
768
last_revno, last_revision_id = self.last_revision_info()
769
real_rev_history = list(self.repository.iter_reverse_revision_history(
771
real_rev_history.reverse()
772
if len(real_rev_history) != last_revno:
773
raise errors.BzrCheckError('revno does not match len(mainline)'
774
' %s != %s' % (last_revno, len(real_rev_history)))
775
# TODO: We should probably also check that real_rev_history actually
776
# matches self.revision_history()
777
for revision_id in real_rev_history:
779
revision = self.repository.get_revision(revision_id)
780
except errors.NoSuchRevision, e:
781
raise errors.BzrCheckError("mainline revision {%s} not in repository"
783
# In general the first entry on the revision history has no parents.
784
# But it's not illegal for it to have parents listed; this can happen
785
# in imports from Arch when the parents weren't reachable.
786
if mainline_parent_id is not None:
787
if mainline_parent_id not in revision.parent_ids:
788
raise errors.BzrCheckError("previous revision {%s} not listed among "
790
% (mainline_parent_id, revision_id))
791
mainline_parent_id = revision_id
792
return BranchCheckResult(self)
794
def _get_checkout_format(self):
795
"""Return the most suitable metadir for a checkout of this branch.
796
Weaves are used if this branch's repository uses weaves.
798
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
799
from bzrlib.repofmt import weaverepo
800
format = bzrdir.BzrDirMetaFormat1()
801
format.repository_format = weaverepo.RepositoryFormat7()
803
format = self.repository.bzrdir.checkout_metadir()
804
format.set_branch_format(self._format)
807
def create_checkout(self, to_location, revision_id=None,
808
lightweight=False, accelerator_tree=None,
810
"""Create a checkout of a branch.
812
:param to_location: The url to produce the checkout at
813
:param revision_id: The revision to check out
814
:param lightweight: If True, produce a lightweight checkout, otherwise,
815
produce a bound branch (heavyweight checkout)
816
:param accelerator_tree: A tree which can be used for retrieving file
817
contents more quickly than the revision tree, i.e. a workingtree.
818
The revision tree will be used for cases where accelerator_tree's
819
content is different.
820
:param hardlink: If true, hard-link files from accelerator_tree,
822
:return: The tree of the created checkout
824
t = transport.get_transport(to_location)
827
format = self._get_checkout_format()
828
checkout = format.initialize_on_transport(t)
829
from_branch = BranchReferenceFormat().initialize(checkout, self)
831
format = self._get_checkout_format()
832
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
833
to_location, force_new_tree=False, format=format)
834
checkout = checkout_branch.bzrdir
835
checkout_branch.bind(self)
836
# pull up to the specified revision_id to set the initial
837
# branch tip correctly, and seed it with history.
838
checkout_branch.pull(self, stop_revision=revision_id)
840
tree = checkout.create_workingtree(revision_id,
841
from_branch=from_branch,
842
accelerator_tree=accelerator_tree,
844
basis_tree = tree.basis_tree()
845
basis_tree.lock_read()
847
for path, file_id in basis_tree.iter_references():
848
reference_parent = self.reference_parent(file_id, path)
849
reference_parent.create_checkout(tree.abspath(path),
850
basis_tree.get_reference_revision(file_id, path),
857
def reconcile(self, thorough=True):
858
"""Make sure the data stored in this branch is consistent."""
859
from bzrlib.reconcile import BranchReconciler
860
reconciler = BranchReconciler(self, thorough=thorough)
861
reconciler.reconcile()
864
def reference_parent(self, file_id, path):
865
"""Return the parent branch for a tree-reference file_id
866
:param file_id: The file_id of the tree reference
867
:param path: The path of the file_id in the tree
868
:return: A branch associated with the file_id
870
# FIXME should provide multiple branches, based on config
871
return Branch.open(self.bzrdir.root_transport.clone(path).base)
873
def supports_tags(self):
874
return self._format.supports_tags()
876
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
878
"""Ensure that revision_b is a descendant of revision_a.
880
This is a helper function for update_revisions.
882
:raises: DivergedBranches if revision_b has diverged from revision_a.
883
:returns: True if revision_b is a descendant of revision_a.
885
relation = self._revision_relations(revision_a, revision_b, graph)
886
if relation == 'b_descends_from_a':
888
elif relation == 'diverged':
889
raise errors.DivergedBranches(self, other_branch)
890
elif relation == 'a_descends_from_b':
893
raise AssertionError("invalid relation: %r" % (relation,))
895
def _revision_relations(self, revision_a, revision_b, graph):
896
"""Determine the relationship between two revisions.
898
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
900
heads = graph.heads([revision_a, revision_b])
901
if heads == set([revision_b]):
902
return 'b_descends_from_a'
903
elif heads == set([revision_a, revision_b]):
904
# These branches have diverged
906
elif heads == set([revision_a]):
907
return 'a_descends_from_b'
909
raise AssertionError("invalid heads: %r" % (heads,))
912
class BranchFormat(object):
913
"""An encapsulation of the initialization and open routines for a format.
915
Formats provide three things:
916
* An initialization routine,
920
Formats are placed in an dict by their format string for reference
921
during branch opening. Its not required that these be instances, they
922
can be classes themselves with class methods - it simply depends on
923
whether state is needed for a given format or not.
925
Once a format is deprecated, just deprecate the initialize and open
926
methods on the format class. Do not deprecate the object, as the
927
object will be created every time regardless.
930
_default_format = None
931
"""The default format used for new branches."""
934
"""The known formats."""
936
def __eq__(self, other):
937
return self.__class__ is other.__class__
939
def __ne__(self, other):
940
return not (self == other)
943
def find_format(klass, a_bzrdir):
944
"""Return the format for the branch object in a_bzrdir."""
946
transport = a_bzrdir.get_branch_transport(None)
947
format_string = transport.get("format").read()
948
return klass._formats[format_string]
949
except errors.NoSuchFile:
950
raise errors.NotBranchError(path=transport.base)
952
raise errors.UnknownFormatError(format=format_string, kind='branch')
955
def get_default_format(klass):
956
"""Return the current default format."""
957
return klass._default_format
959
def get_reference(self, a_bzrdir):
960
"""Get the target reference of the branch in a_bzrdir.
962
format probing must have been completed before calling
963
this method - it is assumed that the format of the branch
964
in a_bzrdir is correct.
966
:param a_bzrdir: The bzrdir to get the branch data from.
967
:return: None if the branch is not a reference branch.
972
def set_reference(self, a_bzrdir, to_branch):
973
"""Set the target reference of the branch in a_bzrdir.
975
format probing must have been completed before calling
976
this method - it is assumed that the format of the branch
977
in a_bzrdir is correct.
979
:param a_bzrdir: The bzrdir to set the branch reference for.
980
:param to_branch: branch that the checkout is to reference
982
raise NotImplementedError(self.set_reference)
984
def get_format_string(self):
985
"""Return the ASCII format string that identifies this format."""
986
raise NotImplementedError(self.get_format_string)
988
def get_format_description(self):
989
"""Return the short format description for this format."""
990
raise NotImplementedError(self.get_format_description)
992
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
994
"""Initialize a branch in a bzrdir, with specified files
996
:param a_bzrdir: The bzrdir to initialize the branch in
997
:param utf8_files: The files to create as a list of
998
(filename, content) tuples
999
:param set_format: If True, set the format with
1000
self.get_format_string. (BzrBranch4 has its format set
1002
:return: a branch in this format
1004
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1005
branch_transport = a_bzrdir.get_branch_transport(self)
1007
'metadir': ('lock', lockdir.LockDir),
1008
'branch4': ('branch-lock', lockable_files.TransportLock),
1010
lock_name, lock_class = lock_map[lock_type]
1011
control_files = lockable_files.LockableFiles(branch_transport,
1012
lock_name, lock_class)
1013
control_files.create_lock()
1014
control_files.lock_write()
1016
utf8_files += [('format', self.get_format_string())]
1018
for (filename, content) in utf8_files:
1019
branch_transport.put_bytes(
1021
mode=a_bzrdir._get_file_mode())
1023
control_files.unlock()
1024
return self.open(a_bzrdir, _found=True)
1026
def initialize(self, a_bzrdir):
1027
"""Create a branch of this format in a_bzrdir."""
1028
raise NotImplementedError(self.initialize)
1030
def is_supported(self):
1031
"""Is this format supported?
1033
Supported formats can be initialized and opened.
1034
Unsupported formats may not support initialization or committing or
1035
some other features depending on the reason for not being supported.
1039
def open(self, a_bzrdir, _found=False):
1040
"""Return the branch object for a_bzrdir
1042
_found is a private parameter, do not use it. It is used to indicate
1043
if format probing has already be done.
1045
raise NotImplementedError(self.open)
1048
def register_format(klass, format):
1049
klass._formats[format.get_format_string()] = format
1052
def set_default_format(klass, format):
1053
klass._default_format = format
1055
def supports_stacking(self):
1056
"""True if this format records a stacked-on branch."""
1060
def unregister_format(klass, format):
1061
del klass._formats[format.get_format_string()]
1064
return self.get_format_string().rstrip()
1066
def supports_tags(self):
1067
"""True if this format supports tags stored in the branch"""
1068
return False # by default
1071
class BranchHooks(Hooks):
1072
"""A dictionary mapping hook name to a list of callables for branch hooks.
1074
e.g. ['set_rh'] Is the list of items to be called when the
1075
set_revision_history function is invoked.
1079
"""Create the default hooks.
1081
These are all empty initially, because by default nothing should get
1084
Hooks.__init__(self)
1085
# Introduced in 0.15:
1086
# invoked whenever the revision history has been set
1087
# with set_revision_history. The api signature is
1088
# (branch, revision_history), and the branch will
1091
# Invoked after a branch is opened. The api signature is (branch).
1093
# invoked after a push operation completes.
1094
# the api signature is
1096
# containing the members
1097
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1098
# where local is the local target branch or None, master is the target
1099
# master branch, and the rest should be self explanatory. The source
1100
# is read locked and the target branches write locked. Source will
1101
# be the local low-latency branch.
1102
self['post_push'] = []
1103
# invoked after a pull operation completes.
1104
# the api signature is
1106
# containing the members
1107
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1108
# where local is the local branch or None, master is the target
1109
# master branch, and the rest should be self explanatory. The source
1110
# is read locked and the target branches write locked. The local
1111
# branch is the low-latency branch.
1112
self['post_pull'] = []
1113
# invoked before a commit operation takes place.
1114
# the api signature is
1115
# (local, master, old_revno, old_revid, future_revno, future_revid,
1116
# tree_delta, future_tree).
1117
# old_revid is NULL_REVISION for the first commit to a branch
1118
# tree_delta is a TreeDelta object describing changes from the basis
1119
# revision, hooks MUST NOT modify this delta
1120
# future_tree is an in-memory tree obtained from
1121
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1122
self['pre_commit'] = []
1123
# invoked after a commit operation completes.
1124
# the api signature is
1125
# (local, master, old_revno, old_revid, new_revno, new_revid)
1126
# old_revid is NULL_REVISION for the first commit to a branch.
1127
self['post_commit'] = []
1128
# invoked after a uncommit operation completes.
1129
# the api signature is
1130
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1131
# local is the local branch or None, master is the target branch,
1132
# and an empty branch recieves new_revno of 0, new_revid of None.
1133
self['post_uncommit'] = []
1135
# Invoked before the tip of a branch changes.
1136
# the api signature is
1137
# (params) where params is a ChangeBranchTipParams with the members
1138
# (branch, old_revno, new_revno, old_revid, new_revid)
1139
self['pre_change_branch_tip'] = []
1141
# Invoked after the tip of a branch changes.
1142
# the api signature is
1143
# (params) where params is a ChangeBranchTipParams with the members
1144
# (branch, old_revno, new_revno, old_revid, new_revid)
1145
self['post_change_branch_tip'] = []
1147
# Invoked when a stacked branch activates its fallback locations and
1148
# allows the transformation of the url of said location.
1149
# the api signature is
1150
# (branch, url) where branch is the branch having its fallback
1151
# location activated and url is the url for the fallback location.
1152
# The hook should return a url.
1153
self['transform_fallback_location'] = []
1156
# install the default hooks into the Branch class.
1157
Branch.hooks = BranchHooks()
1160
class ChangeBranchTipParams(object):
1161
"""Object holding parameters passed to *_change_branch_tip hooks.
1163
There are 5 fields that hooks may wish to access:
1165
:ivar branch: the branch being changed
1166
:ivar old_revno: revision number before the change
1167
:ivar new_revno: revision number after the change
1168
:ivar old_revid: revision id before the change
1169
:ivar new_revid: revision id after the change
1171
The revid fields are strings. The revno fields are integers.
1174
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1175
"""Create a group of ChangeBranchTip parameters.
1177
:param branch: The branch being changed.
1178
:param old_revno: Revision number before the change.
1179
:param new_revno: Revision number after the change.
1180
:param old_revid: Tip revision id before the change.
1181
:param new_revid: Tip revision id after the change.
1183
self.branch = branch
1184
self.old_revno = old_revno
1185
self.new_revno = new_revno
1186
self.old_revid = old_revid
1187
self.new_revid = new_revid
1189
def __eq__(self, other):
1190
return self.__dict__ == other.__dict__
1193
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1194
self.__class__.__name__, self.branch,
1195
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1198
class BzrBranchFormat4(BranchFormat):
1199
"""Bzr branch format 4.
1202
- a revision-history file.
1203
- a branch-lock lock file [ to be shared with the bzrdir ]
1206
def get_format_description(self):
1207
"""See BranchFormat.get_format_description()."""
1208
return "Branch format 4"
1210
def initialize(self, a_bzrdir):
1211
"""Create a branch of this format in a_bzrdir."""
1212
utf8_files = [('revision-history', ''),
1213
('branch-name', ''),
1215
return self._initialize_helper(a_bzrdir, utf8_files,
1216
lock_type='branch4', set_format=False)
1219
super(BzrBranchFormat4, self).__init__()
1220
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1222
def open(self, a_bzrdir, _found=False):
1223
"""Return the branch object for a_bzrdir
1225
_found is a private parameter, do not use it. It is used to indicate
1226
if format probing has already be done.
1229
# we are being called directly and must probe.
1230
raise NotImplementedError
1231
return BzrBranch(_format=self,
1232
_control_files=a_bzrdir._control_files,
1234
_repository=a_bzrdir.open_repository())
1237
return "Bazaar-NG branch format 4"
1240
class BranchFormatMetadir(BranchFormat):
1241
"""Common logic for meta-dir based branch formats."""
1243
def _branch_class(self):
1244
"""What class to instantiate on open calls."""
1245
raise NotImplementedError(self._branch_class)
1247
def open(self, a_bzrdir, _found=False):
1248
"""Return the branch object for a_bzrdir.
1250
_found is a private parameter, do not use it. It is used to indicate
1251
if format probing has already be done.
1254
format = BranchFormat.find_format(a_bzrdir)
1255
if format.__class__ != self.__class__:
1256
raise AssertionError("wrong format %r found for %r" %
1259
transport = a_bzrdir.get_branch_transport(None)
1260
control_files = lockable_files.LockableFiles(transport, 'lock',
1262
return self._branch_class()(_format=self,
1263
_control_files=control_files,
1265
_repository=a_bzrdir.find_repository())
1266
except errors.NoSuchFile:
1267
raise errors.NotBranchError(path=transport.base)
1270
super(BranchFormatMetadir, self).__init__()
1271
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1272
self._matchingbzrdir.set_branch_format(self)
1274
def supports_tags(self):
1278
class BzrBranchFormat5(BranchFormatMetadir):
1279
"""Bzr branch format 5.
1282
- a revision-history file.
1284
- a lock dir guarding the branch itself
1285
- all of this stored in a branch/ subdirectory
1286
- works with shared repositories.
1288
This format is new in bzr 0.8.
1291
def _branch_class(self):
1294
def get_format_string(self):
1295
"""See BranchFormat.get_format_string()."""
1296
return "Bazaar-NG branch format 5\n"
1298
def get_format_description(self):
1299
"""See BranchFormat.get_format_description()."""
1300
return "Branch format 5"
1302
def initialize(self, a_bzrdir):
1303
"""Create a branch of this format in a_bzrdir."""
1304
utf8_files = [('revision-history', ''),
1305
('branch-name', ''),
1307
return self._initialize_helper(a_bzrdir, utf8_files)
1309
def supports_tags(self):
1313
class BzrBranchFormat6(BranchFormatMetadir):
1314
"""Branch format with last-revision and tags.
1316
Unlike previous formats, this has no explicit revision history. Instead,
1317
this just stores the last-revision, and the left-hand history leading
1318
up to there is the history.
1320
This format was introduced in bzr 0.15
1321
and became the default in 0.91.
1324
def _branch_class(self):
1327
def get_format_string(self):
1328
"""See BranchFormat.get_format_string()."""
1329
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1331
def get_format_description(self):
1332
"""See BranchFormat.get_format_description()."""
1333
return "Branch format 6"
1335
def initialize(self, a_bzrdir):
1336
"""Create a branch of this format in a_bzrdir."""
1337
utf8_files = [('last-revision', '0 null:\n'),
1338
('branch.conf', ''),
1341
return self._initialize_helper(a_bzrdir, utf8_files)
1344
class BzrBranchFormat7(BranchFormatMetadir):
1345
"""Branch format with last-revision, tags, and a stacked location pointer.
1347
The stacked location pointer is passed down to the repository and requires
1348
a repository format with supports_external_lookups = True.
1350
This format was introduced in bzr 1.6.
1353
def _branch_class(self):
1356
def get_format_string(self):
1357
"""See BranchFormat.get_format_string()."""
1358
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1360
def get_format_description(self):
1361
"""See BranchFormat.get_format_description()."""
1362
return "Branch format 7"
1364
def initialize(self, a_bzrdir):
1365
"""Create a branch of this format in a_bzrdir."""
1366
utf8_files = [('last-revision', '0 null:\n'),
1367
('branch.conf', ''),
1370
return self._initialize_helper(a_bzrdir, utf8_files)
1373
super(BzrBranchFormat7, self).__init__()
1374
self._matchingbzrdir.repository_format = \
1375
RepositoryFormatKnitPack5RichRoot()
1377
def supports_stacking(self):
1381
class BranchReferenceFormat(BranchFormat):
1382
"""Bzr branch reference format.
1384
Branch references are used in implementing checkouts, they
1385
act as an alias to the real branch which is at some other url.
1392
def get_format_string(self):
1393
"""See BranchFormat.get_format_string()."""
1394
return "Bazaar-NG Branch Reference Format 1\n"
1396
def get_format_description(self):
1397
"""See BranchFormat.get_format_description()."""
1398
return "Checkout reference format 1"
1400
def get_reference(self, a_bzrdir):
1401
"""See BranchFormat.get_reference()."""
1402
transport = a_bzrdir.get_branch_transport(None)
1403
return transport.get('location').read()
1405
def set_reference(self, a_bzrdir, to_branch):
1406
"""See BranchFormat.set_reference()."""
1407
transport = a_bzrdir.get_branch_transport(None)
1408
location = transport.put_bytes('location', to_branch.base)
1410
def initialize(self, a_bzrdir, target_branch=None):
1411
"""Create a branch of this format in a_bzrdir."""
1412
if target_branch is None:
1413
# this format does not implement branch itself, thus the implicit
1414
# creation contract must see it as uninitializable
1415
raise errors.UninitializableFormat(self)
1416
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1417
branch_transport = a_bzrdir.get_branch_transport(self)
1418
branch_transport.put_bytes('location',
1419
target_branch.bzrdir.root_transport.base)
1420
branch_transport.put_bytes('format', self.get_format_string())
1422
a_bzrdir, _found=True,
1423
possible_transports=[target_branch.bzrdir.root_transport])
1426
super(BranchReferenceFormat, self).__init__()
1427
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1428
self._matchingbzrdir.set_branch_format(self)
1430
def _make_reference_clone_function(format, a_branch):
1431
"""Create a clone() routine for a branch dynamically."""
1432
def clone(to_bzrdir, revision_id=None):
1433
"""See Branch.clone()."""
1434
return format.initialize(to_bzrdir, a_branch)
1435
# cannot obey revision_id limits when cloning a reference ...
1436
# FIXME RBC 20060210 either nuke revision_id for clone, or
1437
# emit some sort of warning/error to the caller ?!
1440
def open(self, a_bzrdir, _found=False, location=None,
1441
possible_transports=None):
1442
"""Return the branch that the branch reference in a_bzrdir points at.
1444
_found is a private parameter, do not use it. It is used to indicate
1445
if format probing has already be done.
1448
format = BranchFormat.find_format(a_bzrdir)
1449
if format.__class__ != self.__class__:
1450
raise AssertionError("wrong format %r found for %r" %
1452
if location is None:
1453
location = self.get_reference(a_bzrdir)
1454
real_bzrdir = bzrdir.BzrDir.open(
1455
location, possible_transports=possible_transports)
1456
result = real_bzrdir.open_branch()
1457
# this changes the behaviour of result.clone to create a new reference
1458
# rather than a copy of the content of the branch.
1459
# I did not use a proxy object because that needs much more extensive
1460
# testing, and we are only changing one behaviour at the moment.
1461
# If we decide to alter more behaviours - i.e. the implicit nickname
1462
# then this should be refactored to introduce a tested proxy branch
1463
# and a subclass of that for use in overriding clone() and ....
1465
result.clone = self._make_reference_clone_function(result)
1469
# formats which have no format string are not discoverable
1470
# and not independently creatable, so are not registered.
1471
__format5 = BzrBranchFormat5()
1472
__format6 = BzrBranchFormat6()
1473
__format7 = BzrBranchFormat7()
1474
BranchFormat.register_format(__format5)
1475
BranchFormat.register_format(BranchReferenceFormat())
1476
BranchFormat.register_format(__format6)
1477
BranchFormat.register_format(__format7)
1478
BranchFormat.set_default_format(__format6)
1479
_legacy_formats = [BzrBranchFormat4(),
1482
class BzrBranch(Branch):
1483
"""A branch stored in the actual filesystem.
1485
Note that it's "local" in the context of the filesystem; it doesn't
1486
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1487
it's writable, and can be accessed via the normal filesystem API.
1489
:ivar _transport: Transport for file operations on this branch's
1490
control files, typically pointing to the .bzr/branch directory.
1491
:ivar repository: Repository for this branch.
1492
:ivar base: The url of the base directory for this branch; the one
1493
containing the .bzr directory.
1496
def __init__(self, _format=None,
1497
_control_files=None, a_bzrdir=None, _repository=None):
1498
"""Create new branch object at a particular location."""
1499
if a_bzrdir is None:
1500
raise ValueError('a_bzrdir must be supplied')
1502
self.bzrdir = a_bzrdir
1503
self._base = self.bzrdir.transport.clone('..').base
1504
# XXX: We should be able to just do
1505
# self.base = self.bzrdir.root_transport.base
1506
# but this does not quite work yet -- mbp 20080522
1507
self._format = _format
1508
if _control_files is None:
1509
raise ValueError('BzrBranch _control_files is None')
1510
self.control_files = _control_files
1511
self._transport = _control_files._transport
1512
self.repository = _repository
1513
Branch.__init__(self)
1516
return '%s(%r)' % (self.__class__.__name__, self.base)
1520
def _get_base(self):
1521
"""Returns the directory containing the control directory."""
1524
base = property(_get_base, doc="The URL for the root of this branch.")
1526
def is_locked(self):
1527
return self.control_files.is_locked()
1529
def lock_write(self, token=None):
1530
repo_token = self.repository.lock_write()
1532
token = self.control_files.lock_write(token=token)
1534
self.repository.unlock()
1538
def lock_read(self):
1539
self.repository.lock_read()
1541
self.control_files.lock_read()
1543
self.repository.unlock()
1547
# TODO: test for failed two phase locks. This is known broken.
1549
self.control_files.unlock()
1551
self.repository.unlock()
1552
if not self.control_files.is_locked():
1553
# we just released the lock
1554
self._clear_cached_state()
1556
def peek_lock_mode(self):
1557
if self.control_files._lock_count == 0:
1560
return self.control_files._lock_mode
1562
def get_physical_lock_status(self):
1563
return self.control_files.get_physical_lock_status()
1566
def print_file(self, file, revision_id):
1567
"""See Branch.print_file."""
1568
return self.repository.print_file(file, revision_id)
1570
def _write_revision_history(self, history):
1571
"""Factored out of set_revision_history.
1573
This performs the actual writing to disk.
1574
It is intended to be called by BzrBranch5.set_revision_history."""
1575
self._transport.put_bytes(
1576
'revision-history', '\n'.join(history),
1577
mode=self.bzrdir._get_file_mode())
1580
def set_revision_history(self, rev_history):
1581
"""See Branch.set_revision_history."""
1582
if 'evil' in debug.debug_flags:
1583
mutter_callsite(3, "set_revision_history scales with history.")
1584
check_not_reserved_id = _mod_revision.check_not_reserved_id
1585
for rev_id in rev_history:
1586
check_not_reserved_id(rev_id)
1587
if Branch.hooks['post_change_branch_tip']:
1588
# Don't calculate the last_revision_info() if there are no hooks
1590
old_revno, old_revid = self.last_revision_info()
1591
if len(rev_history) == 0:
1592
revid = _mod_revision.NULL_REVISION
1594
revid = rev_history[-1]
1595
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1596
self._write_revision_history(rev_history)
1597
self._clear_cached_state()
1598
self._cache_revision_history(rev_history)
1599
for hook in Branch.hooks['set_rh']:
1600
hook(self, rev_history)
1601
if Branch.hooks['post_change_branch_tip']:
1602
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1604
def _synchronize_history(self, destination, revision_id):
1605
"""Synchronize last revision and revision history between branches.
1607
This version is most efficient when the destination is also a
1608
BzrBranch5, but works for BzrBranch6 as long as the revision
1609
history is the true lefthand parent history, and all of the revisions
1610
are in the destination's repository. If not, set_revision_history
1613
:param destination: The branch to copy the history into
1614
:param revision_id: The revision-id to truncate history at. May
1615
be None to copy complete history.
1617
if revision_id == _mod_revision.NULL_REVISION:
1620
new_history = self.revision_history()
1621
if revision_id is not None and new_history != []:
1623
new_history = new_history[:new_history.index(revision_id) + 1]
1625
rev = self.repository.get_revision(revision_id)
1626
new_history = rev.get_history(self.repository)[1:]
1627
destination.set_revision_history(new_history)
1629
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1630
"""Run the pre_change_branch_tip hooks."""
1631
hooks = Branch.hooks['pre_change_branch_tip']
1634
old_revno, old_revid = self.last_revision_info()
1635
params = ChangeBranchTipParams(
1636
self, old_revno, new_revno, old_revid, new_revid)
1640
except errors.TipChangeRejected:
1643
exc_info = sys.exc_info()
1644
hook_name = Branch.hooks.get_hook_name(hook)
1645
raise errors.HookFailed(
1646
'pre_change_branch_tip', hook_name, exc_info)
1648
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1649
"""Run the post_change_branch_tip hooks."""
1650
hooks = Branch.hooks['post_change_branch_tip']
1653
new_revno, new_revid = self.last_revision_info()
1654
params = ChangeBranchTipParams(
1655
self, old_revno, new_revno, old_revid, new_revid)
1660
def set_last_revision_info(self, revno, revision_id):
1661
"""Set the last revision of this branch.
1663
The caller is responsible for checking that the revno is correct
1664
for this revision id.
1666
It may be possible to set the branch last revision to an id not
1667
present in the repository. However, branches can also be
1668
configured to check constraints on history, in which case this may not
1671
revision_id = _mod_revision.ensure_null(revision_id)
1672
# this old format stores the full history, but this api doesn't
1673
# provide it, so we must generate, and might as well check it's
1675
history = self._lefthand_history(revision_id)
1676
if len(history) != revno:
1677
raise AssertionError('%d != %d' % (len(history), revno))
1678
self.set_revision_history(history)
1680
def _gen_revision_history(self):
1681
history = self._transport.get_bytes('revision-history').split('\n')
1682
if history[-1:] == ['']:
1683
# There shouldn't be a trailing newline, but just in case.
1687
def _lefthand_history(self, revision_id, last_rev=None,
1689
if 'evil' in debug.debug_flags:
1690
mutter_callsite(4, "_lefthand_history scales with history.")
1691
# stop_revision must be a descendant of last_revision
1692
graph = self.repository.get_graph()
1693
if last_rev is not None:
1694
if not graph.is_ancestor(last_rev, revision_id):
1695
# our previous tip is not merged into stop_revision
1696
raise errors.DivergedBranches(self, other_branch)
1697
# make a new revision history from the graph
1698
parents_map = graph.get_parent_map([revision_id])
1699
if revision_id not in parents_map:
1700
raise errors.NoSuchRevision(self, revision_id)
1701
current_rev_id = revision_id
1703
check_not_reserved_id = _mod_revision.check_not_reserved_id
1704
# Do not include ghosts or graph origin in revision_history
1705
while (current_rev_id in parents_map and
1706
len(parents_map[current_rev_id]) > 0):
1707
check_not_reserved_id(current_rev_id)
1708
new_history.append(current_rev_id)
1709
current_rev_id = parents_map[current_rev_id][0]
1710
parents_map = graph.get_parent_map([current_rev_id])
1711
new_history.reverse()
1715
def generate_revision_history(self, revision_id, last_rev=None,
1717
"""Create a new revision history that will finish with revision_id.
1719
:param revision_id: the new tip to use.
1720
:param last_rev: The previous last_revision. If not None, then this
1721
must be a ancestory of revision_id, or DivergedBranches is raised.
1722
:param other_branch: The other branch that DivergedBranches should
1723
raise with respect to.
1725
self.set_revision_history(self._lefthand_history(revision_id,
1726
last_rev, other_branch))
1728
def basis_tree(self):
1729
"""See Branch.basis_tree."""
1730
return self.repository.revision_tree(self.last_revision())
1733
def pull(self, source, overwrite=False, stop_revision=None,
1734
_hook_master=None, run_hooks=True, possible_transports=None,
1735
_override_hook_target=None):
1738
:param _hook_master: Private parameter - set the branch to
1739
be supplied as the master to pull hooks.
1740
:param run_hooks: Private parameter - if false, this branch
1741
is being called because it's the master of the primary branch,
1742
so it should not run its hooks.
1743
:param _override_hook_target: Private parameter - set the branch to be
1744
supplied as the target_branch to pull hooks.
1746
result = PullResult()
1747
result.source_branch = source
1748
if _override_hook_target is None:
1749
result.target_branch = self
1751
result.target_branch = _override_hook_target
1754
# We assume that during 'pull' the local repository is closer than
1756
graph = self.repository.get_graph(source.repository)
1757
result.old_revno, result.old_revid = self.last_revision_info()
1758
self.update_revisions(source, stop_revision, overwrite=overwrite,
1760
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1761
result.new_revno, result.new_revid = self.last_revision_info()
1763
result.master_branch = _hook_master
1764
result.local_branch = result.target_branch
1766
result.master_branch = result.target_branch
1767
result.local_branch = None
1769
for hook in Branch.hooks['post_pull']:
1775
def _get_parent_location(self):
1776
_locs = ['parent', 'pull', 'x-pull']
1779
return self._transport.get_bytes(l).strip('\n')
1780
except errors.NoSuchFile:
1785
def push(self, target, overwrite=False, stop_revision=None,
1786
_override_hook_source_branch=None):
1789
This is the basic concrete implementation of push()
1791
:param _override_hook_source_branch: If specified, run
1792
the hooks passing this Branch as the source, rather than self.
1793
This is for use of RemoteBranch, where push is delegated to the
1794
underlying vfs-based Branch.
1796
# TODO: Public option to disable running hooks - should be trivial but
1798
return _run_with_write_locked_target(
1799
target, self._push_with_bound_branches, target, overwrite,
1801
_override_hook_source_branch=_override_hook_source_branch)
1803
def _push_with_bound_branches(self, target, overwrite,
1805
_override_hook_source_branch=None):
1806
"""Push from self into target, and into target's master if any.
1808
This is on the base BzrBranch class even though it doesn't support
1809
bound branches because the *target* might be bound.
1812
if _override_hook_source_branch:
1813
result.source_branch = _override_hook_source_branch
1814
for hook in Branch.hooks['post_push']:
1817
bound_location = target.get_bound_location()
1818
if bound_location and target.base != bound_location:
1819
# there is a master branch.
1821
# XXX: Why the second check? Is it even supported for a branch to
1822
# be bound to itself? -- mbp 20070507
1823
master_branch = target.get_master_branch()
1824
master_branch.lock_write()
1826
# push into the master from this branch.
1827
self._basic_push(master_branch, overwrite, stop_revision)
1828
# and push into the target branch from this. Note that we push from
1829
# this branch again, because its considered the highest bandwidth
1831
result = self._basic_push(target, overwrite, stop_revision)
1832
result.master_branch = master_branch
1833
result.local_branch = target
1837
master_branch.unlock()
1840
result = self._basic_push(target, overwrite, stop_revision)
1841
# TODO: Why set master_branch and local_branch if there's no
1842
# binding? Maybe cleaner to just leave them unset? -- mbp
1844
result.master_branch = target
1845
result.local_branch = None
1849
def _basic_push(self, target, overwrite, stop_revision):
1850
"""Basic implementation of push without bound branches or hooks.
1852
Must be called with self read locked and target write locked.
1854
result = PushResult()
1855
result.source_branch = self
1856
result.target_branch = target
1857
result.old_revno, result.old_revid = target.last_revision_info()
1858
if result.old_revid != self.last_revision():
1859
# We assume that during 'push' this repository is closer than
1861
graph = self.repository.get_graph(target.repository)
1862
target.update_revisions(self, stop_revision, overwrite=overwrite,
1864
if self._push_should_merge_tags():
1865
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1866
result.new_revno, result.new_revid = target.last_revision_info()
1869
def _push_should_merge_tags(self):
1870
"""Should _basic_push merge this branch's tags into the target?
1872
The default implementation returns False if this branch has no tags,
1873
and True the rest of the time. Subclasses may override this.
1875
return self.tags.supports_tags() and self.tags.get_tag_dict()
1877
def get_parent(self):
1878
"""See Branch.get_parent."""
1879
parent = self._get_parent_location()
1882
# This is an old-format absolute path to a local branch
1883
# turn it into a url
1884
if parent.startswith('/'):
1885
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1887
return urlutils.join(self.base[:-1], parent)
1888
except errors.InvalidURLJoin, e:
1889
raise errors.InaccessibleParent(parent, self.base)
1891
def get_stacked_on_url(self):
1892
raise errors.UnstackableBranchFormat(self._format, self.base)
1894
def set_push_location(self, location):
1895
"""See Branch.set_push_location."""
1896
self.get_config().set_user_option(
1897
'push_location', location,
1898
store=_mod_config.STORE_LOCATION_NORECURSE)
1901
def set_parent(self, url):
1902
"""See Branch.set_parent."""
1903
# TODO: Maybe delete old location files?
1904
# URLs should never be unicode, even on the local fs,
1905
# FIXUP this and get_parent in a future branch format bump:
1906
# read and rewrite the file. RBC 20060125
1908
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)
1910
url = url.encode('ascii')
1911
except UnicodeEncodeError:
1912
raise errors.InvalidURL(url,
1913
"Urls must be 7-bit ascii, "
1914
"use bzrlib.urlutils.escape")
1915
url = urlutils.relative_url(self.base, url)
1916
self._set_parent_location(url)
1918
def _set_parent_location(self, url):
1920
self._transport.delete('parent')
1922
self._transport.put_bytes('parent', url + '\n',
1923
mode=self.bzrdir._get_file_mode())
1925
def set_stacked_on_url(self, url):
1926
raise errors.UnstackableBranchFormat(self._format, self.base)
1929
class BzrBranch5(BzrBranch):
1930
"""A format 5 branch. This supports new features over plain branches.
1932
It has support for a master_branch which is the data for bound branches.
1936
def pull(self, source, overwrite=False, stop_revision=None,
1937
run_hooks=True, possible_transports=None,
1938
_override_hook_target=None):
1939
"""Pull from source into self, updating my master if any.
1941
:param run_hooks: Private parameter - if false, this branch
1942
is being called because it's the master of the primary branch,
1943
so it should not run its hooks.
1945
bound_location = self.get_bound_location()
1946
master_branch = None
1947
if bound_location and source.base != bound_location:
1948
# not pulling from master, so we need to update master.
1949
master_branch = self.get_master_branch(possible_transports)
1950
master_branch.lock_write()
1953
# pull from source into master.
1954
master_branch.pull(source, overwrite, stop_revision,
1956
return super(BzrBranch5, self).pull(source, overwrite,
1957
stop_revision, _hook_master=master_branch,
1958
run_hooks=run_hooks,
1959
_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
1962
master_branch.unlock()
1964
def get_bound_location(self):
1966
return self._transport.get_bytes('bound')[:-1]
1967
except errors.NoSuchFile:
1971
def get_master_branch(self, possible_transports=None):
1972
"""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')
1974
:return: Either a Branch, or None
1976
This could memoise the branch, but if thats done
1977
it must be revalidated on each new lock.
1978
So for now we just don't memoise it.
1979
# RBC 20060304 review this decision.
1981
bound_loc = self.get_bound_location()
1985
return Branch.open(bound_loc,
1986
possible_transports=possible_transports)
1987
except (errors.NotBranchError, errors.ConnectionError), e:
1988
raise errors.BoundBranchConnectionFailure(
1992
def set_bound_location(self, location):
1993
"""Set the target where this branch is bound to.
1995
:param location: URL to the target branch
1998
self._transport.put_bytes('bound', location+'\n',
1999
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:
2002
self._transport.delete('bound')
2003
except errors.NoSuchFile:
2008
def bind(self, other):
2009
"""Bind this branch to the branch other.
2011
This does not push or pull data between the branches, though it does
2012
check for divergence to raise an error when the branches are not
2013
either the same, or one a prefix of the other. That behaviour may not
2014
be useful, so that check may be removed in future.
2016
:param other: The branch to bind to
2019
# TODO: jam 20051230 Consider checking if the target is bound
2020
# It is debatable whether you should be able to bind to
2021
# a branch which is itself bound.
2022
# Committing is obviously forbidden,
2023
# but binding itself may not be.
2024
# Since we *have* to check at commit time, we don't
2025
# *need* to check here
2027
# we want to raise diverged if:
2028
# last_rev is not in the other_last_rev history, AND
2029
# other_last_rev is not in our history, and do it without pulling
2031
self.set_bound_location(other.base)
2035
"""If bound, unbind"""
2036
return self.set_bound_location(None)
2039
def update(self, possible_transports=None):
2040
"""Synchronise this branch with the master branch if any.
2042
:return: None or the last_revision that was pivoted out during the
2045
master = self.get_master_branch(possible_transports)
2046
if master is not None:
2047
old_tip = _mod_revision.ensure_null(self.last_revision())
2048
self.pull(master, overwrite=True)
2049
if self.repository.get_graph().is_ancestor(old_tip,
2050
_mod_revision.ensure_null(self.last_revision())):
2056
class BzrBranch7(BzrBranch5):
2057
"""A branch with support for a fallback repository."""
2059
def _get_fallback_repository(self, url):
2060
"""Get the repository we fallback to at url."""
2061
url = urlutils.join(self.base, url)
2062
return bzrdir.BzrDir.open(url).open_branch().repository
2064
def _activate_fallback_location(self, url):
2065
"""Activate the branch/repository from url as a fallback repository."""
2066
self.repository.add_fallback_repository(
2067
self._get_fallback_repository(url))
2069
def _open_hook(self):
2071
url = self.get_stacked_on_url()
2072
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2073
errors.UnstackableBranchFormat):
2076
for hook in Branch.hooks['transform_fallback_location']:
2077
url = hook(self, url)
2079
hook_name = Branch.hooks.get_hook_name(hook)
2080
raise AssertionError(
2081
"'transform_fallback_location' hook %s returned "
2082
"None, not a URL." % hook_name)
2083
self._activate_fallback_location(url)
2085
def _check_stackable_repo(self):
2086
if not self.repository._format.supports_external_lookups:
2087
raise errors.UnstackableRepositoryFormat(self.repository._format,
2088
self.repository.base)
2090
def __init__(self, *args, **kwargs):
2091
super(BzrBranch7, self).__init__(*args, **kwargs)
2092
self._last_revision_info_cache = None
2093
self._partial_revision_history_cache = []
2095
def _clear_cached_state(self):
2096
super(BzrBranch7, self)._clear_cached_state()
2097
self._last_revision_info_cache = None
2098
self._partial_revision_history_cache = []
2100
def _last_revision_info(self):
2101
revision_string = self._transport.get_bytes('last-revision')
2102
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2103
revision_id = cache_utf8.get_cached_utf8(revision_id)
2105
return revno, revision_id
2107
def _write_last_revision_info(self, revno, revision_id):
2108
"""Simply write out the revision id, with no checks.
2110
Use set_last_revision_info to perform this safely.
2112
Does not update the revision_history cache.
2113
Intended to be called by set_last_revision_info and
2114
_write_revision_history.
2116
revision_id = _mod_revision.ensure_null(revision_id)
2117
out_string = '%d %s\n' % (revno, revision_id)
2118
self._transport.put_bytes('last-revision', out_string,
2119
mode=self.bzrdir._get_file_mode())
2122
def set_last_revision_info(self, revno, revision_id):
2123
revision_id = _mod_revision.ensure_null(revision_id)
2124
old_revno, old_revid = self.last_revision_info()
2125
if self._get_append_revisions_only():
2126
self._check_history_violation(revision_id)
2127
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2128
self._write_last_revision_info(revno, revision_id)
2129
self._clear_cached_state()
2130
self._last_revision_info_cache = revno, revision_id
2131
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2133
def _synchronize_history(self, destination, revision_id):
2134
"""Synchronize last revision and revision history between branches.
2136
:see: Branch._synchronize_history
2138
# XXX: The base Branch has a fast implementation of this method based
2139
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2140
# that uses set_revision_history. This class inherits from BzrBranch5,
2141
# but wants the fast implementation, so it calls
2142
# Branch._synchronize_history directly.
2143
Branch._synchronize_history(self, destination, revision_id)
2145
def _check_history_violation(self, revision_id):
2146
last_revision = _mod_revision.ensure_null(self.last_revision())
2147
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'))
2149
if last_revision not in self._lefthand_history(revision_id):
2150
raise errors.AppendRevisionsOnlyViolation(self.base)
2152
def _gen_revision_history(self):
2153
"""Generate the revision history from last revision
2155
last_revno, last_revision = self.last_revision_info()
2156
self._extend_partial_history(stop_index=last_revno-1)
2157
return list(reversed(self._partial_revision_history_cache))
2159
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2160
"""Extend the partial history to include a given index
2162
If a stop_index is supplied, stop when that index has been reached.
2163
If a stop_revision is supplied, stop when that revision is
2164
encountered. Otherwise, stop when the beginning of history is
2167
:param stop_index: The index which should be present. When it is
2168
present, history extension will stop.
2169
:param revision_id: The revision id which should be present. When
2170
it is encountered, history extension will stop.
2172
repo = self.repository
2173
if len(self._partial_revision_history_cache) == 0:
2174
iterator = repo.iter_reverse_revision_history(self.last_revision())
2176
start_revision = self._partial_revision_history_cache[-1]
2177
iterator = repo.iter_reverse_revision_history(start_revision)
2178
#skip the last revision in the list
2179
next_revision = iterator.next()
2180
for revision_id in iterator:
2181
self._partial_revision_history_cache.append(revision_id)
2182
if (stop_index is not None and
2183
len(self._partial_revision_history_cache) > stop_index):
2185
if revision_id == stop_revision:
2188
def _write_revision_history(self, history):
2189
"""Factored out of set_revision_history.
2191
This performs the actual writing to disk, with format-specific checks.
2192
It is intended to be called by BzrBranch5.set_revision_history.
2194
if len(history) == 0:
2195
last_revision = 'null:'
2197
if history != self._lefthand_history(history[-1]):
2198
raise errors.NotLefthandHistory(history)
2199
last_revision = history[-1]
2200
if self._get_append_revisions_only():
2201
self._check_history_violation(last_revision)
2202
self._write_last_revision_info(len(history), last_revision)
2205
def _set_parent_location(self, url):
2206
"""Set the parent branch"""
2207
self._set_config_location('parent_location', url, make_relative=True)
2210
def _get_parent_location(self):
2211
"""Set the parent branch"""
2212
return self._get_config_location('parent_location')
2214
def set_push_location(self, location):
2215
"""See Branch.set_push_location."""
2216
self._set_config_location('push_location', location)
2218
def set_bound_location(self, location):
2219
"""See Branch.set_push_location."""
2221
config = self.get_config()
2222
if location is None:
2223
if config.get_user_option('bound') != 'True':
2226
config.set_user_option('bound', 'False', warn_masked=True)
2229
self._set_config_location('bound_location', location,
2231
config.set_user_option('bound', 'True', warn_masked=True)
2234
def _get_bound_location(self, bound):
2235
"""Return the bound location in the config file.
2237
Return None if the bound parameter does not match"""
2238
config = self.get_config()
2239
config_bound = (config.get_user_option('bound') == 'True')
2240
if config_bound != bound:
2242
return self._get_config_location('bound_location', config=config)
2244
def get_bound_location(self):
2245
"""See Branch.set_push_location."""
2246
return self._get_bound_location(True)
2248
def get_old_bound_location(self):
2249
"""See Branch.get_old_bound_location"""
2250
return self._get_bound_location(False)
2252
def get_stacked_on_url(self):
2253
# you can always ask for the URL; but you might not be able to use it
2254
# if the repo can't support stacking.
2255
## self._check_stackable_repo()
2256
stacked_url = self._get_config_location('stacked_on_location')
2257
if stacked_url is None:
2258
raise errors.NotStacked(self)
2261
def set_append_revisions_only(self, enabled):
2266
self.get_config().set_user_option('append_revisions_only', value,
2269
def set_stacked_on_url(self, url):
2270
self._check_stackable_repo()
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1271
>>> b = ScratchBranch()
2273
old_url = self.get_stacked_on_url()
2274
except (errors.NotStacked, errors.UnstackableBranchFormat,
2275
errors.UnstackableRepositoryFormat):
2278
# repositories don't offer an interface to remove fallback
2279
# repositories today; take the conceptually simpler option and just
2281
self.repository = self.bzrdir.find_repository()
2282
# for every revision reference the branch has, ensure it is pulled
2284
source_repository = self._get_fallback_repository(old_url)
2285
for revision_id in chain([self.last_revision()],
2286
self.tags.get_reverse_tag_dict()):
2287
self.repository.fetch(source_repository, revision_id,
2290
self._activate_fallback_location(url)
2291
# write this out after the repository is stacked to avoid setting a
2292
# stacked config that doesn't work.
2293
self._set_config_location('stacked_on_location', url)
2295
def _get_append_revisions_only(self):
2296
value = self.get_config().get_user_option('append_revisions_only')
2297
return value == 'True'
2299
def _make_tags(self):
2300
return BasicTags(self)
2303
def generate_revision_history(self, revision_id, last_rev=None,
2305
"""See BzrBranch5.generate_revision_history"""
2306
history = self._lefthand_history(revision_id, last_rev, other_branch)
2307
revno = len(history)
2308
self.set_last_revision_info(revno, revision_id)
2311
def get_rev_id(self, revno, history=None):
2312
"""Find the revision id of the specified revno."""
2314
return _mod_revision.NULL_REVISION
2316
last_revno, last_revision_id = self.last_revision_info()
2317
if revno <= 0 or revno > last_revno:
2318
raise errors.NoSuchRevision(self, revno)
2320
if history is not None:
2321
return history[revno - 1]
2323
index = last_revno - revno
2324
if len(self._partial_revision_history_cache) <= index:
2325
self._extend_partial_history(stop_index=index)
2326
if len(self._partial_revision_history_cache) > index:
2327
return self._partial_revision_history_cache[index]
2329
raise errors.NoSuchRevision(self, revno)
2332
def revision_id_to_revno(self, revision_id):
2333
"""Given a revision id, return its revno"""
2334
if _mod_revision.is_null(revision_id):
2337
index = self._partial_revision_history_cache.index(revision_id)
2339
self._extend_partial_history(stop_revision=revision_id)
2340
index = len(self._partial_revision_history_cache) - 1
2341
if self._partial_revision_history_cache[index] != revision_id:
2342
raise errors.NoSuchRevision(self, revision_id)
2343
return self.revno() - index
2346
class BzrBranch6(BzrBranch7):
2347
"""See BzrBranchFormat6 for the capabilities of this branch.
2349
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)
2353
def get_stacked_on_url(self):
2354
raise errors.UnstackableBranchFormat(self._format, self.base)
2356
def set_stacked_on_url(self, url):
2357
raise errors.UnstackableBranchFormat(self._format, self.base)
1337
2360
######################################################################
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')
2361
# results of operations
2364
class _Result(object):
2366
def _show_tag_conficts(self, to_file):
2367
if not getattr(self, 'tag_conflicts', None):
2369
to_file.write('Conflicting tags:\n')
2370
for name, value1, value2 in self.tag_conflicts:
2371
to_file.write(' %s\n' % (name, ))
2374
class PullResult(_Result):
2375
"""Result of a Branch.pull operation.
2377
:ivar old_revno: Revision number before pull.
2378
:ivar new_revno: Revision number after pull.
2379
:ivar old_revid: Tip revision id before pull.
2380
:ivar new_revid: Tip revision id after pull.
2381
:ivar source_branch: Source (local) branch object.
2382
:ivar master_branch: Master branch of the target, or the target if no
2384
:ivar local_branch: target branch if there is a Master, else None
2385
:ivar target_branch: Target/destination branch object.
2386
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2390
# DEPRECATED: pull used to return the change in revno
2391
return self.new_revno - self.old_revno
2393
def report(self, to_file):
2395
if self.old_revid == self.new_revid:
2396
to_file.write('No revisions to pull.\n')
2398
to_file.write('Now on revision %d.\n' % self.new_revno)
2399
self._show_tag_conficts(to_file)
2402
class PushResult(_Result):
2403
"""Result of a Branch.push operation.
2405
:ivar old_revno: Revision number before push.
2406
:ivar new_revno: Revision number after push.
2407
:ivar old_revid: Tip revision id before push.
2408
:ivar new_revid: Tip revision id after push.
2409
:ivar source_branch: Source branch object.
2410
:ivar master_branch: Master branch of the target, or None.
2411
:ivar target_branch: Target/destination branch object.
2415
# DEPRECATED: push used to return the change in revno
2416
return self.new_revno - self.old_revno
2418
def report(self, to_file):
2419
"""Write a human-readable description of the result."""
2420
if self.old_revid == self.new_revid:
2421
to_file.write('No new revisions to push.\n')
2423
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2424
self._show_tag_conficts(to_file)
2427
class BranchCheckResult(object):
2428
"""Results of checking branch consistency.
2433
def __init__(self, branch):
2434
self.branch = branch
2436
def report_results(self, verbose):
2437
"""Report the check results via trace.note.
2439
:param verbose: Requests more detailed display of what was checked,
2442
note('checked branch %s format %s',
2444
self.branch._format)
2447
class Converter5to6(object):
2448
"""Perform an in-place upgrade of format 5 to format 6"""
2450
def convert(self, branch):
2451
# Data for 5 and 6 can peacefully coexist.
2452
format = BzrBranchFormat6()
2453
new_branch = format.open(branch.bzrdir, _found=True)
2455
# Copy source data into target
2456
new_branch._write_last_revision_info(*branch.last_revision_info())
2457
new_branch.set_parent(branch.get_parent())
2458
new_branch.set_bound_location(branch.get_bound_location())
2459
new_branch.set_push_location(branch.get_push_location())
2461
# New branch has no tags by default
2462
new_branch.tags._set_tag_dict({})
2464
# Copying done; now update target format
2465
new_branch._transport.put_bytes('format',
2466
format.get_format_string(),
2467
mode=new_branch.bzrdir._get_file_mode())
2469
# Clean up old files
2470
new_branch._transport.delete('revision-history')
2472
branch.set_parent(None)
2473
except errors.NoSuchFile:
2475
branch.set_bound_location(None)
2478
class Converter6to7(object):
2479
"""Perform an in-place upgrade of format 6 to format 7"""
2481
def convert(self, branch):
2482
format = BzrBranchFormat7()
2483
branch._set_config_location('stacked_on_location', '')
2484
# update target format
2485
branch._transport.put_bytes('format', format.get_format_string())
2489
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2490
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2493
_run_with_write_locked_target will attempt to release the lock it acquires.
2495
If an exception is raised by callable, then that exception *will* be
2496
propagated, even if the unlock attempt raises its own error. Thus
2497
_run_with_write_locked_target should be preferred to simply doing::
2501
return callable(*args, **kwargs)
2506
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2507
# should share code?
2510
result = callable(*args, **kwargs)
2512
exc_info = sys.exc_info()
2516
raise exc_info[0], exc_info[1], exc_info[2]
added
removed
bzrlib/branch.py
