79
148
"""Branch holding a history of revisions.
82
Base directory/url of the branch.
151
Base directory of the branch.
157
If _lock_mode is true, a positive count of the number of times the
161
Lock object from bzrlib.lock.
84
# this is really an instance variable - FIXME move it there
88
def __init__(self, *ignored, **ignored_too):
89
raise NotImplementedError('The Branch class is abstract')
92
"""Break a lock if one is present from another instance.
94
Uses the ui factory to ask for confirmation if the lock may be from
97
This will probe the repository for its lock as well.
99
self.control_files.break_lock()
100
self.repository.break_lock()
101
master = self.get_master_branch()
102
if master is not None:
106
@deprecated_method(zero_eight)
107
def open_downlevel(base):
108
"""Open a branch which may be of an old format."""
109
return Branch.open(base, _unsupported=True)
112
def open(base, _unsupported=False):
113
"""Open the branch rooted at base.
115
For instance, if the branch is at URL/.bzr/branch,
116
Branch.open(URL) -> a Branch instance.
118
control = bzrdir.BzrDir.open(base, _unsupported)
119
return control.open_branch(_unsupported)
122
def open_containing(url):
123
"""Open an existing branch which contains url.
125
This probes for a branch at url, and searches upwards from there.
127
Basically we keep looking up until we find the control directory or
128
run into the root. If there isn't one, raises NotBranchError.
129
If there is one and it is either an unrecognised format or an unsupported
130
format, UnknownFormatError or UnsupportedFormatError are raised.
131
If there is one, it is returned, along with the unused portion of url.
133
control, relpath = bzrdir.BzrDir.open_containing(url)
134
return control.open_branch(), relpath
137
@deprecated_function(zero_eight)
138
def initialize(base):
139
"""Create a new working tree and branch, rooted at 'base' (url)
141
NOTE: This will soon be deprecated in favour of creation
144
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
146
@deprecated_function(zero_eight)
147
def setup_caching(self, cache_root):
148
"""Subclasses that care about caching should override this, and set
149
up cached stores located under cache_root.
151
NOTE: This is unused.
155
def get_config(self):
156
return BranchConfig(self)
159
return self.get_config().get_nickname()
161
def _set_nick(self, nick):
162
self.get_config().set_user_option('nickname', nick)
164
nick = property(_get_nick, _set_nick)
167
raise NotImplementedError(self.is_locked)
168
# Map some sort of prefix into a namespace
169
# stuff like "revno:10", "revid:", etc.
170
# This should match a prefix with a function which accepts
171
REVISION_NAMESPACES = {}
173
def __init__(self, base, init=False, find_root=True):
174
"""Create new branch object at a particular location.
176
base -- Base directory for the branch.
178
init -- If True, create new control files in a previously
179
unversioned directory. If False, the branch must already
182
find_root -- If true and init is false, find the root of the
183
existing branch containing base.
185
In the test suite, creation of new trees is tested using the
186
`ScratchBranch` class.
188
from bzrlib.store import ImmutableStore
190
self.base = os.path.realpath(base)
193
self.base = find_branch_root(base)
195
self.base = os.path.realpath(base)
196
if not isdir(self.controlfilename('.')):
197
from errors import NotBranchError
198
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
199
['use "bzr init" to initialize a new working tree',
200
'current bzr can only operate from top-of-tree'])
203
self.text_store = ImmutableStore(self.controlfilename('text-store'))
204
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
205
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
209
return '%s(%r)' % (self.__class__.__name__, self.base)
216
if self._lock_mode or self._lock:
217
from warnings import warn
218
warn("branch %r was not explicitly unlocked" % self)
169
222
def lock_write(self):
170
raise NotImplementedError(self.lock_write)
224
if self._lock_mode != 'w':
225
from errors import LockError
226
raise LockError("can't upgrade to a write lock from %r" %
228
self._lock_count += 1
230
from bzrlib.lock import WriteLock
232
self._lock = WriteLock(self.controlfilename('branch-lock'))
233
self._lock_mode = 'w'
172
237
def lock_read(self):
173
raise NotImplementedError(self.lock_read)
239
assert self._lock_mode in ('r', 'w'), \
240
"invalid lock mode %r" % self._lock_mode
241
self._lock_count += 1
243
from bzrlib.lock import ReadLock
245
self._lock = ReadLock(self.controlfilename('branch-lock'))
246
self._lock_mode = 'r'
175
249
def unlock(self):
176
raise NotImplementedError(self.unlock)
178
def peek_lock_mode(self):
179
"""Return lock mode for the Branch: 'r', 'w' or None"""
180
raise NotImplementedError(self.peek_lock_mode)
182
def get_physical_lock_status(self):
183
raise NotImplementedError(self.get_physical_lock_status)
250
if not self._lock_mode:
251
from errors import LockError
252
raise LockError('branch %r is not locked' % (self))
254
if self._lock_count > 1:
255
self._lock_count -= 1
259
self._lock_mode = self._lock_count = None
185
261
def abspath(self, name):
186
"""Return absolute filename for something in the branch
188
XXX: Robert Collins 20051017 what is this used for? why is it a branch
189
method and not a tree method.
191
raise NotImplementedError(self.abspath)
193
def bind(self, other):
194
"""Bind the local branch the other branch.
196
:param other: The branch to bind to
199
raise errors.UpgradeRequired(self.base)
202
def fetch(self, from_branch, last_revision=None, pb=None):
203
"""Copy revisions from from_branch into this branch.
205
:param from_branch: Where to copy from.
206
:param last_revision: What revision to stop at (None for at the end
208
:param pb: An optional progress bar to use.
210
Returns the copied revision count and the failed revisions in a tuple:
213
if self.base == from_branch.base:
216
nested_pb = ui.ui_factory.nested_progress_bar()
221
from_branch.lock_read()
223
if last_revision is None:
224
pb.update('get source history')
225
from_history = from_branch.revision_history()
227
last_revision = from_history[-1]
229
# no history in the source branch
230
last_revision = _mod_revision.NULL_REVISION
231
return self.repository.fetch(from_branch.repository,
232
revision_id=last_revision,
235
if nested_pb is not None:
239
def get_bound_location(self):
240
"""Return the URL of the branch we are bound to.
242
Older format branches cannot bind, please be sure to use a metadir
247
def get_commit_builder(self, parents, config=None, timestamp=None,
248
timezone=None, committer=None, revprops=None,
250
"""Obtain a CommitBuilder for this branch.
252
:param parents: Revision ids of the parents of the new revision.
253
:param config: Optional configuration to use.
254
:param timestamp: Optional timestamp recorded for commit.
255
:param timezone: Optional timezone for timestamp.
256
:param committer: Optional committer to set for commit.
257
:param revprops: Optional dictionary of revision properties.
258
:param revision_id: Optional revision id.
262
config = self.get_config()
264
return self.repository.get_commit_builder(self, parents, config,
265
timestamp, timezone, committer, revprops, revision_id)
267
def get_master_branch(self):
268
"""Return the branch we are bound to.
270
:return: Either a Branch, or None
262
"""Return absolute filename for something in the branch"""
263
return os.path.join(self.base, name)
265
def relpath(self, path):
266
"""Return path relative to this branch of something inside it.
268
Raises an error if path is not in this branch."""
269
return _relpath(self.base, path)
271
def controlfilename(self, file_or_path):
272
"""Return location relative to branch."""
273
if isinstance(file_or_path, basestring):
274
file_or_path = [file_or_path]
275
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
278
def controlfile(self, file_or_path, mode='r'):
279
"""Open a control file for this branch.
281
There are two classes of file in the control directory: text
282
and binary. binary files are untranslated byte streams. Text
283
control files are stored with Unix newlines and in UTF-8, even
284
if the platform or locale defaults are different.
286
Controlfiles should almost never be opened in write mode but
287
rather should be atomically copied and replaced using atomicfile.
290
fn = self.controlfilename(file_or_path)
292
if mode == 'rb' or mode == 'wb':
293
return file(fn, mode)
294
elif mode == 'r' or mode == 'w':
295
# open in binary mode anyhow so there's no newline translation;
296
# codecs uses line buffering by default; don't want that.
298
return codecs.open(fn, mode + 'b', 'utf-8',
301
raise BzrError("invalid controlfile mode %r" % mode)
303
def _make_control(self):
304
from bzrlib.inventory import Inventory
305
from bzrlib.xml import pack_xml
307
os.mkdir(self.controlfilename([]))
308
self.controlfile('README', 'w').write(
309
"This is a Bazaar-NG control directory.\n"
310
"Do not change any files in this directory.\n")
311
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
312
for d in ('text-store', 'inventory-store', 'revision-store'):
313
os.mkdir(self.controlfilename(d))
314
for f in ('revision-history', 'merged-patches',
315
'pending-merged-patches', 'branch-name',
318
self.controlfile(f, 'w').write('')
319
mutter('created control directory in ' + self.base)
321
# if we want per-tree root ids then this is the place to set
322
# them; they're not needed for now and so ommitted for
324
pack_xml(Inventory(), self.controlfile('inventory','w'))
326
def _check_format(self):
327
"""Check this branch format is supported.
329
The current tool only supports the current unstable format.
331
In the future, we might need different in-memory Branch
332
classes to support downlevel branches. But not yet.
334
# This ignores newlines so that we can open branches created
335
# on Windows from Linux and so on. I think it might be better
336
# to always make all internal files in unix format.
337
fmt = self.controlfile('branch-format', 'r').read()
338
fmt.replace('\r\n', '')
339
if fmt != BZR_BRANCH_FORMAT:
340
raise BzrError('sorry, branch format %r not supported' % fmt,
341
['use a different bzr version',
342
'or remove the .bzr directory and "bzr init" again'])
344
def get_root_id(self):
345
"""Return the id of this branches root"""
346
inv = self.read_working_inventory()
347
return inv.root.file_id
349
def set_root_id(self, file_id):
350
inv = self.read_working_inventory()
351
orig_root_id = inv.root.file_id
352
del inv._byid[inv.root.file_id]
353
inv.root.file_id = file_id
354
inv._byid[inv.root.file_id] = inv.root
357
if entry.parent_id in (None, orig_root_id):
358
entry.parent_id = inv.root.file_id
359
self._write_inventory(inv)
361
def read_working_inventory(self):
362
"""Read the working inventory."""
363
from bzrlib.inventory import Inventory
364
from bzrlib.xml import unpack_xml
365
from time import time
369
# ElementTree does its own conversion from UTF-8, so open in
371
inv = unpack_xml(Inventory,
372
self.controlfile('inventory', 'rb'))
373
mutter("loaded inventory of %d items in %f"
374
% (len(inv), time() - before))
380
def _write_inventory(self, inv):
381
"""Update the working inventory.
383
That is to say, the inventory describing changes underway, that
384
will be committed to the next revision.
386
from bzrlib.atomicfile import AtomicFile
387
from bzrlib.xml import pack_xml
391
f = AtomicFile(self.controlfilename('inventory'), 'wb')
400
mutter('wrote working inventory')
403
inventory = property(read_working_inventory, _write_inventory, None,
404
"""Inventory for the working copy.""")
407
def add(self, files, ids=None):
408
"""Make files versioned.
410
Note that the command line normally calls smart_add instead,
411
which can automatically recurse.
413
This puts the files in the Added state, so that they will be
414
recorded by the next commit.
417
List of paths to add, relative to the base of the tree.
420
If set, use these instead of automatically generated ids.
421
Must be the same length as the list of files, but may
422
contain None for ids that are to be autogenerated.
424
TODO: Perhaps have an option to add the ids even if the files do
427
TODO: Perhaps yield the ids and paths as they're added.
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)
469
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
471
self._write_inventory(inv)
476
def print_file(self, file, revno):
477
"""Print `file` to stdout."""
480
tree = self.revision_tree(self.lookup_revision(revno))
481
# use inventory as it was in that revision
482
file_id = tree.inventory.path2id(file)
484
raise BzrError("%r is not present in revision %s" % (file, revno))
485
tree.print_file(file_id)
490
def remove(self, files, verbose=False):
491
"""Mark nominated files for removal from the inventory.
493
This does not remove their text. This does not run on
495
TODO: Refuse to remove modified files unless --force is given?
497
TODO: Do something useful with directories.
499
TODO: Should this remove the text or not? Tough call; not
500
removing may be useful and the user can just use use rm, and
501
is the opposite of add. Removing it is consistent with most
502
other tools. Maybe an option.
504
## TODO: Normalize names
505
## TODO: Remove nested loops; better scalability
506
if isinstance(files, basestring):
512
tree = self.working_tree()
515
# do this before any modifications
519
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
520
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
522
# having remove it, it must be either ignored or unknown
523
if tree.is_ignored(f):
527
show_status(new_status, inv[fid].kind, quotefn(f))
530
self._write_inventory(inv)
535
# FIXME: this doesn't need to be a branch method
536
def set_inventory(self, new_inventory_list):
537
from bzrlib.inventory import Inventory, InventoryEntry
538
inv = Inventory(self.get_root_id())
539
for path, file_id, parent, kind in new_inventory_list:
540
name = os.path.basename(path)
543
inv.add(InventoryEntry(file_id, name, kind, parent))
544
self._write_inventory(inv)
548
"""Return all unknown files.
550
These are files in the working directory that are not versioned or
551
control files or ignored.
553
>>> b = ScratchBranch(files=['foo', 'foo~'])
554
>>> list(b.unknowns())
557
>>> list(b.unknowns())
560
>>> list(b.unknowns())
563
return self.working_tree().unknowns()
566
def append_revision(self, *revision_ids):
567
from bzrlib.atomicfile import AtomicFile
569
for revision_id in revision_ids:
570
mutter("add {%s} to revision-history" % revision_id)
572
rev_history = self.revision_history()
573
rev_history.extend(revision_ids)
575
f = AtomicFile(self.controlfilename('revision-history'))
577
for rev_id in rev_history:
584
def get_revision_xml(self, revision_id):
585
"""Return XML file object for revision object."""
586
if not revision_id or not isinstance(revision_id, basestring):
587
raise InvalidRevisionId(revision_id)
592
return self.revision_store[revision_id]
594
raise bzrlib.errors.NoSuchRevision(self, revision_id)
599
def get_revision(self, revision_id):
600
"""Return the Revision object for a named revision"""
601
xml_file = self.get_revision_xml(revision_id)
604
r = unpack_xml(Revision, xml_file)
605
except SyntaxError, e:
606
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
610
assert r.revision_id == revision_id
274
614
def get_revision_delta(self, revno):
275
615
"""Return the delta for one revision.
339
796
if stop_revision is None:
340
797
stop_revision = other_len
342
assert isinstance(stop_revision, int)
343
if stop_revision > other_len:
344
raise errors.NoSuchRevision(self, stop_revision)
798
elif stop_revision > other_len:
799
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
345
801
return other_history[self_len:stop_revision]
347
804
def update_revisions(self, other, stop_revision=None):
348
"""Pull in new perfect-fit revisions.
350
:param other: Another Branch to pull from
351
:param stop_revision: Updated until the given revision
805
"""Pull in all new revisions from other branch.
354
raise NotImplementedError(self.update_revisions)
807
from bzrlib.fetch import greedy_fetch
809
pb = bzrlib.ui.ui_factory.progress_bar()
810
pb.update('comparing histories')
812
revision_ids = self.missing_revisions(other, stop_revision)
814
if len(revision_ids) > 0:
815
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
818
self.append_revision(*revision_ids)
819
## note("Added %d revisions." % count)
822
def install_revisions(self, other, revision_ids, pb):
823
if hasattr(other.revision_store, "prefetch"):
824
other.revision_store.prefetch(revision_ids)
825
if hasattr(other.inventory_store, "prefetch"):
826
inventory_ids = [other.get_revision(r).inventory_id
827
for r in revision_ids]
828
other.inventory_store.prefetch(inventory_ids)
831
pb = bzrlib.ui.ui_factory.progress_bar()
838
for i, rev_id in enumerate(revision_ids):
839
pb.update('fetching revision', i+1, len(revision_ids))
841
rev = other.get_revision(rev_id)
842
except bzrlib.errors.NoSuchRevision:
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, cp_fail = self.text_store.copy_multi(other.text_store,
858
#print "Added %d texts." % count
859
inventory_ids = [ f.inventory_id for f in revisions ]
860
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
862
#print "Added %d inventories." % count
863
revision_ids = [ f.revision_id for f in revisions]
865
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
868
assert len(cp_fail) == 0
869
return count, failures
872
def commit(self, *args, **kw):
873
from bzrlib.commit import commit
874
commit(self, *args, **kw)
877
def lookup_revision(self, revision):
878
"""Return the revision identifier for a given revision information."""
879
revno, info = self.get_revision_info(revision)
356
883
def revision_id_to_revno(self, revision_id):
357
884
"""Given a revision id, return its revno"""
358
if revision_id is None:
360
885
history = self.revision_history()
362
887
return history.index(revision_id) + 1
363
888
except ValueError:
364
889
raise bzrlib.errors.NoSuchRevision(self, revision_id)
366
def get_rev_id(self, revno, history=None):
367
"""Find the revision id of the specified revno."""
371
history = self.revision_history()
372
if revno <= 0 or revno > len(history):
373
raise bzrlib.errors.NoSuchRevision(self, revno)
374
return history[revno - 1]
376
def pull(self, source, overwrite=False, stop_revision=None):
377
raise NotImplementedError(self.pull)
892
def get_revision_info(self, revision):
893
"""Return (revno, revision id) for revision identifier.
895
revision can be an integer, in which case it is assumed to be revno (though
896
this will translate negative values into positive ones)
897
revision can also be a string, in which case it is parsed for something like
898
'date:' or 'revid:' etc.
903
try:# Convert to int if possible
904
revision = int(revision)
907
revs = self.revision_history()
908
if isinstance(revision, int):
911
# Mabye we should do this first, but we don't need it if revision == 0
913
revno = len(revs) + revision + 1
916
elif isinstance(revision, basestring):
917
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
918
if revision.startswith(prefix):
919
revno = func(self, revs, revision)
922
raise BzrError('No namespace registered for string: %r' % revision)
924
if revno is None or revno <= 0 or revno > len(revs):
925
raise BzrError("no such revision %s" % revision)
926
return revno, revs[revno-1]
928
def _namespace_revno(self, revs, revision):
929
"""Lookup a revision by revision number"""
930
assert revision.startswith('revno:')
932
return int(revision[6:])
935
REVISION_NAMESPACES['revno:'] = _namespace_revno
937
def _namespace_revid(self, revs, revision):
938
assert revision.startswith('revid:')
940
return revs.index(revision[6:]) + 1
943
REVISION_NAMESPACES['revid:'] = _namespace_revid
945
def _namespace_last(self, revs, revision):
946
assert revision.startswith('last:')
948
offset = int(revision[5:])
953
raise BzrError('You must supply a positive value for --revision last:XXX')
954
return len(revs) - offset + 1
955
REVISION_NAMESPACES['last:'] = _namespace_last
957
def _namespace_tag(self, revs, revision):
958
assert revision.startswith('tag:')
959
raise BzrError('tag: namespace registered, but not implemented.')
960
REVISION_NAMESPACES['tag:'] = _namespace_tag
962
def _namespace_date(self, revs, revision):
963
assert revision.startswith('date:')
965
# Spec for date revisions:
967
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
968
# it can also start with a '+/-/='. '+' says match the first
969
# entry after the given date. '-' is match the first entry before the date
970
# '=' is match the first entry after, but still on the given date.
972
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
973
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
974
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
975
# May 13th, 2005 at 0:00
977
# So the proper way of saying 'give me all entries for today' is:
978
# -r {date:+today}:{date:-tomorrow}
979
# The default is '=' when not supplied
982
if val[:1] in ('+', '-', '='):
983
match_style = val[:1]
986
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
987
if val.lower() == 'yesterday':
988
dt = today - datetime.timedelta(days=1)
989
elif val.lower() == 'today':
991
elif val.lower() == 'tomorrow':
992
dt = today + datetime.timedelta(days=1)
995
# This should be done outside the function to avoid recompiling it.
996
_date_re = re.compile(
997
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
999
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1001
m = _date_re.match(val)
1002
if not m or (not m.group('date') and not m.group('time')):
1003
raise BzrError('Invalid revision date %r' % revision)
1006
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1008
year, month, day = today.year, today.month, today.day
1010
hour = int(m.group('hour'))
1011
minute = int(m.group('minute'))
1012
if m.group('second'):
1013
second = int(m.group('second'))
1017
hour, minute, second = 0,0,0
1019
dt = datetime.datetime(year=year, month=month, day=day,
1020
hour=hour, minute=minute, second=second)
1024
if match_style == '-':
1026
elif match_style == '=':
1027
last = dt + datetime.timedelta(days=1)
1030
for i in range(len(revs)-1, -1, -1):
1031
r = self.get_revision(revs[i])
1032
# TODO: Handle timezone.
1033
dt = datetime.datetime.fromtimestamp(r.timestamp)
1034
if first >= dt and (last is None or dt >= last):
1037
for i in range(len(revs)):
1038
r = self.get_revision(revs[i])
1039
# TODO: Handle timezone.
1040
dt = datetime.datetime.fromtimestamp(r.timestamp)
1041
if first <= dt and (last is None or dt <= last):
1043
REVISION_NAMESPACES['date:'] = _namespace_date
1045
def revision_tree(self, revision_id):
1046
"""Return Tree for a revision on this branch.
1048
`revision_id` may be None for the null revision, in which case
1049
an `EmptyTree` is returned."""
1050
# TODO: refactor this to use an existing revision object
1051
# so we don't need to read it in twice.
1052
if revision_id == None:
1055
inv = self.get_revision_inventory(revision_id)
1056
return RevisionTree(self.text_store, inv)
1059
def working_tree(self):
1060
"""Return a `Tree` for the working copy."""
1061
from workingtree import WorkingTree
1062
return WorkingTree(self.base, self.read_working_inventory())
379
1065
def basis_tree(self):
380
"""Return `Tree` object for last revision."""
381
return self.repository.revision_tree(self.last_revision())
1066
"""Return `Tree` object for last revision.
1068
If there are no revisions yet, return an `EmptyTree`.
1070
r = self.last_patch()
1074
return RevisionTree(self.text_store, self.get_revision_inventory(r))
383
1078
def rename_one(self, from_rel, to_rel):
384
1079
"""Rename one file.
386
1081
This can change the directory or the filename or both.
388
raise NotImplementedError(self.rename_one)
1085
tree = self.working_tree()
1086
inv = tree.inventory
1087
if not tree.has_filename(from_rel):
1088
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1089
if tree.has_filename(to_rel):
1090
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1092
file_id = inv.path2id(from_rel)
1094
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1096
if inv.path2id(to_rel):
1097
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1099
to_dir, to_tail = os.path.split(to_rel)
1100
to_dir_id = inv.path2id(to_dir)
1101
if to_dir_id == None and to_dir != '':
1102
raise BzrError("can't determine destination directory id for %r" % to_dir)
1104
mutter("rename_one:")
1105
mutter(" file_id {%s}" % file_id)
1106
mutter(" from_rel %r" % from_rel)
1107
mutter(" to_rel %r" % to_rel)
1108
mutter(" to_dir %r" % to_dir)
1109
mutter(" to_dir_id {%s}" % to_dir_id)
1111
inv.rename(file_id, to_dir_id, to_tail)
1113
from_abs = self.abspath(from_rel)
1114
to_abs = self.abspath(to_rel)
1116
os.rename(from_abs, to_abs)
1118
raise BzrError("failed to rename %r to %r: %s"
1119
% (from_abs, to_abs, e[1]),
1120
["rename rolled back"])
1122
self._write_inventory(inv)
390
1127
def move(self, from_paths, to_name):
391
1128
"""Rename files.
401
1138
This returns a list of (from_path, to_path) pairs for each
402
1139
entry that is moved.
404
raise NotImplementedError(self.move)
406
def get_parent(self):
407
"""Return the parent location of the branch.
409
This is the default location for push/pull/missing. The usual
410
pattern is that the user can override it by specifying a
413
raise NotImplementedError(self.get_parent)
415
def get_submit_branch(self):
416
"""Return the submit location of the branch.
418
This is the default location for bundle. The usual
419
pattern is that the user can override it by specifying a
422
return self.get_config().get_user_option('submit_branch')
424
def set_submit_branch(self, location):
425
"""Return the submit location of the branch.
427
This is the default location for bundle. The usual
428
pattern is that the user can override it by specifying a
431
self.get_config().set_user_option('submit_branch', location)
433
def get_push_location(self):
434
"""Return the None or the location to push this branch to."""
435
raise NotImplementedError(self.get_push_location)
437
def set_push_location(self, location):
438
"""Set a new push location for this branch."""
439
raise NotImplementedError(self.set_push_location)
441
def set_parent(self, url):
442
raise NotImplementedError(self.set_parent)
446
"""Synchronise this branch with the master branch if any.
448
:return: None or the last_revision pivoted out during the update.
452
def check_revno(self, revno):
454
Check whether a revno corresponds to any revision.
455
Zero (the NULL revision) is considered valid.
458
self.check_real_revno(revno)
460
def check_real_revno(self, revno):
462
Check whether a revno corresponds to a real revision.
463
Zero (the NULL revision) is considered invalid
465
if revno < 1 or revno > self.revno():
466
raise InvalidRevisionNumber(revno)
469
def clone(self, *args, **kwargs):
470
"""Clone this branch into to_bzrdir preserving all semantic values.
472
revision_id: if not None, the revision history in the new branch will
473
be truncated to end with revision_id.
475
# for API compatibility, until 0.8 releases we provide the old api:
476
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
477
# after 0.8 releases, the *args and **kwargs should be changed:
478
# def clone(self, to_bzrdir, revision_id=None):
479
if (kwargs.get('to_location', None) or
480
kwargs.get('revision', None) or
481
kwargs.get('basis_branch', None) or
482
(len(args) and isinstance(args[0], basestring))):
483
# backwards compatibility api:
484
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
485
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
488
basis_branch = args[2]
490
basis_branch = kwargs.get('basis_branch', None)
492
basis = basis_branch.bzrdir
497
revision_id = args[1]
499
revision_id = kwargs.get('revision', None)
504
# no default to raise if not provided.
505
url = kwargs.get('to_location')
506
return self.bzrdir.clone(url,
507
revision_id=revision_id,
508
basis=basis).open_branch()
510
# generate args by hand
512
revision_id = args[1]
514
revision_id = kwargs.get('revision_id', None)
518
# no default to raise if not provided.
519
to_bzrdir = kwargs.get('to_bzrdir')
520
result = self._format.initialize(to_bzrdir)
521
self.copy_content_into(result, revision_id=revision_id)
525
def sprout(self, to_bzrdir, revision_id=None):
526
"""Create a new line of development from the branch, into to_bzrdir.
528
revision_id: if not None, the revision history in the new branch will
529
be truncated to end with revision_id.
531
result = self._format.initialize(to_bzrdir)
532
self.copy_content_into(result, revision_id=revision_id)
533
result.set_parent(self.bzrdir.root_transport.base)
537
def copy_content_into(self, destination, revision_id=None):
538
"""Copy the content of self into destination.
540
revision_id: if not None, the revision history in the new branch will
541
be truncated to end with revision_id.
543
new_history = self.revision_history()
544
if revision_id is not None:
546
new_history = new_history[:new_history.index(revision_id) + 1]
548
rev = self.repository.get_revision(revision_id)
549
new_history = rev.get_history(self.repository)[1:]
550
destination.set_revision_history(new_history)
552
parent = self.get_parent()
553
except errors.InaccessibleParent, e:
554
mutter('parent was not accessible to copy: %s', e)
557
destination.set_parent(parent)
561
"""Check consistency of the branch.
563
In particular this checks that revisions given in the revision-history
564
do actually match up in the revision graph, and that they're all
565
present in the repository.
567
Callers will typically also want to check the repository.
569
:return: A BranchCheckResult.
571
mainline_parent_id = None
572
for revision_id in self.revision_history():
574
revision = self.repository.get_revision(revision_id)
575
except errors.NoSuchRevision, e:
576
raise errors.BzrCheckError("mainline revision {%s} not in repository"
578
# In general the first entry on the revision history has no parents.
579
# But it's not illegal for it to have parents listed; this can happen
580
# in imports from Arch when the parents weren't reachable.
581
if mainline_parent_id is not None:
582
if mainline_parent_id not in revision.parent_ids:
583
raise errors.BzrCheckError("previous revision {%s} not listed among "
585
% (mainline_parent_id, revision_id))
586
mainline_parent_id = revision_id
587
return BranchCheckResult(self)
589
def _get_checkout_format(self):
590
"""Return the most suitable metadir for a checkout of this branch.
591
Weaves are used if this branch's repostory uses weaves.
593
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
594
from bzrlib import repository
595
format = bzrdir.BzrDirMetaFormat1()
596
format.repository_format = repository.RepositoryFormat7()
598
format = self.repository.bzrdir.cloning_metadir()
601
def create_checkout(self, to_location, revision_id=None,
603
"""Create a checkout of a branch.
605
:param to_location: The url to produce the checkout at
606
:param revision_id: The revision to check out
607
:param lightweight: If True, produce a lightweight checkout, otherwise,
608
produce a bound branch (heavyweight checkout)
609
:return: The tree of the created checkout
611
t = transport.get_transport(to_location)
614
except errors.FileExists:
617
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
618
BranchReferenceFormat().initialize(checkout, self)
620
format = self._get_checkout_format()
621
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
622
to_location, force_new_tree=False, format=format)
623
checkout = checkout_branch.bzrdir
624
checkout_branch.bind(self)
625
# pull up to the specified revision_id to set the initial
626
# branch tip correctly, and seed it with history.
627
checkout_branch.pull(self, stop_revision=revision_id)
628
return checkout.create_workingtree(revision_id)
631
class BranchFormat(object):
632
"""An encapsulation of the initialization and open routines for a format.
634
Formats provide three things:
635
* An initialization routine,
639
Formats are placed in an dict by their format string for reference
640
during branch opening. Its not required that these be instances, they
641
can be classes themselves with class methods - it simply depends on
642
whether state is needed for a given format or not.
644
Once a format is deprecated, just deprecate the initialize and open
645
methods on the format class. Do not deprecate the object, as the
646
object will be created every time regardless.
649
_default_format = None
650
"""The default format used for new branches."""
653
"""The known formats."""
656
def find_format(klass, a_bzrdir):
657
"""Return the format for the branch object in a_bzrdir."""
659
transport = a_bzrdir.get_branch_transport(None)
660
format_string = transport.get("format").read()
661
return klass._formats[format_string]
663
raise NotBranchError(path=transport.base)
665
raise errors.UnknownFormatError(format=format_string)
668
def get_default_format(klass):
669
"""Return the current default format."""
670
return klass._default_format
672
def get_format_string(self):
673
"""Return the ASCII format string that identifies this format."""
674
raise NotImplementedError(self.get_format_string)
676
def get_format_description(self):
677
"""Return the short format description for this format."""
678
raise NotImplementedError(self.get_format_string)
680
def initialize(self, a_bzrdir):
681
"""Create a branch of this format in a_bzrdir."""
682
raise NotImplementedError(self.initialize)
684
def is_supported(self):
685
"""Is this format supported?
687
Supported formats can be initialized and opened.
688
Unsupported formats may not support initialization or committing or
689
some other features depending on the reason for not being supported.
693
def open(self, a_bzrdir, _found=False):
694
"""Return the branch object for a_bzrdir
696
_found is a private parameter, do not use it. It is used to indicate
697
if format probing has already be done.
699
raise NotImplementedError(self.open)
702
def register_format(klass, format):
703
klass._formats[format.get_format_string()] = format
706
def set_default_format(klass, format):
707
klass._default_format = format
710
def unregister_format(klass, format):
711
assert klass._formats[format.get_format_string()] is format
712
del klass._formats[format.get_format_string()]
715
return self.get_format_string().rstrip()
718
class BzrBranchFormat4(BranchFormat):
719
"""Bzr branch format 4.
722
- a revision-history file.
723
- a branch-lock lock file [ to be shared with the bzrdir ]
726
def get_format_description(self):
727
"""See BranchFormat.get_format_description()."""
728
return "Branch format 4"
730
def initialize(self, a_bzrdir):
731
"""Create a branch of this format in a_bzrdir."""
732
mutter('creating branch in %s', a_bzrdir.transport.base)
733
branch_transport = a_bzrdir.get_branch_transport(self)
734
utf8_files = [('revision-history', ''),
737
control_files = lockable_files.LockableFiles(branch_transport,
738
'branch-lock', lockable_files.TransportLock)
739
control_files.create_lock()
740
control_files.lock_write()
742
for file, content in utf8_files:
743
control_files.put_utf8(file, content)
745
control_files.unlock()
746
return self.open(a_bzrdir, _found=True)
749
super(BzrBranchFormat4, self).__init__()
750
self._matchingbzrdir = bzrdir.BzrDirFormat6()
752
def open(self, a_bzrdir, _found=False):
753
"""Return the branch object for a_bzrdir
755
_found is a private parameter, do not use it. It is used to indicate
756
if format probing has already be done.
759
# we are being called directly and must probe.
760
raise NotImplementedError
761
return BzrBranch(_format=self,
762
_control_files=a_bzrdir._control_files,
764
_repository=a_bzrdir.open_repository())
767
return "Bazaar-NG branch format 4"
770
class BzrBranchFormat5(BranchFormat):
771
"""Bzr branch format 5.
774
- a revision-history file.
776
- a lock dir guarding the branch itself
777
- all of this stored in a branch/ subdirectory
778
- works with shared repositories.
780
This format is new in bzr 0.8.
783
def get_format_string(self):
784
"""See BranchFormat.get_format_string()."""
785
return "Bazaar-NG branch format 5\n"
787
def get_format_description(self):
788
"""See BranchFormat.get_format_description()."""
789
return "Branch format 5"
791
def initialize(self, a_bzrdir):
792
"""Create a branch of this format in a_bzrdir."""
793
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
794
branch_transport = a_bzrdir.get_branch_transport(self)
795
utf8_files = [('revision-history', ''),
798
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
800
control_files.create_lock()
801
control_files.lock_write()
802
control_files.put_utf8('format', self.get_format_string())
804
for file, content in utf8_files:
805
control_files.put_utf8(file, content)
807
control_files.unlock()
808
return self.open(a_bzrdir, _found=True, )
811
super(BzrBranchFormat5, self).__init__()
812
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
814
def open(self, a_bzrdir, _found=False):
815
"""Return the branch object for a_bzrdir
817
_found is a private parameter, do not use it. It is used to indicate
818
if format probing has already be done.
821
format = BranchFormat.find_format(a_bzrdir)
822
assert format.__class__ == self.__class__
823
transport = a_bzrdir.get_branch_transport(None)
824
control_files = lockable_files.LockableFiles(transport, 'lock',
826
return BzrBranch5(_format=self,
827
_control_files=control_files,
829
_repository=a_bzrdir.find_repository())
832
return "Bazaar-NG Metadir branch format 5"
835
class BranchReferenceFormat(BranchFormat):
836
"""Bzr branch reference format.
838
Branch references are used in implementing checkouts, they
839
act as an alias to the real branch which is at some other url.
846
def get_format_string(self):
847
"""See BranchFormat.get_format_string()."""
848
return "Bazaar-NG Branch Reference Format 1\n"
850
def get_format_description(self):
851
"""See BranchFormat.get_format_description()."""
852
return "Checkout reference format 1"
854
def initialize(self, a_bzrdir, target_branch=None):
855
"""Create a branch of this format in a_bzrdir."""
856
if target_branch is None:
857
# this format does not implement branch itself, thus the implicit
858
# creation contract must see it as uninitializable
859
raise errors.UninitializableFormat(self)
860
mutter('creating branch reference in %s', a_bzrdir.transport.base)
861
branch_transport = a_bzrdir.get_branch_transport(self)
862
branch_transport.put_bytes('location',
863
target_branch.bzrdir.root_transport.base)
864
branch_transport.put_bytes('format', self.get_format_string())
865
return self.open(a_bzrdir, _found=True)
868
super(BranchReferenceFormat, self).__init__()
869
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
871
def _make_reference_clone_function(format, a_branch):
872
"""Create a clone() routine for a branch dynamically."""
873
def clone(to_bzrdir, revision_id=None):
874
"""See Branch.clone()."""
875
return format.initialize(to_bzrdir, a_branch)
876
# cannot obey revision_id limits when cloning a reference ...
877
# FIXME RBC 20060210 either nuke revision_id for clone, or
878
# emit some sort of warning/error to the caller ?!
881
def open(self, a_bzrdir, _found=False):
882
"""Return the branch that the branch reference in a_bzrdir points at.
884
_found is a private parameter, do not use it. It is used to indicate
885
if format probing has already be done.
888
format = BranchFormat.find_format(a_bzrdir)
889
assert format.__class__ == self.__class__
890
transport = a_bzrdir.get_branch_transport(None)
891
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
892
result = real_bzrdir.open_branch()
893
# this changes the behaviour of result.clone to create a new reference
894
# rather than a copy of the content of the branch.
895
# I did not use a proxy object because that needs much more extensive
896
# testing, and we are only changing one behaviour at the moment.
897
# If we decide to alter more behaviours - i.e. the implicit nickname
898
# then this should be refactored to introduce a tested proxy branch
899
# and a subclass of that for use in overriding clone() and ....
901
result.clone = self._make_reference_clone_function(result)
905
# formats which have no format string are not discoverable
906
# and not independently creatable, so are not registered.
907
__default_format = BzrBranchFormat5()
908
BranchFormat.register_format(__default_format)
909
BranchFormat.register_format(BranchReferenceFormat())
910
BranchFormat.set_default_format(__default_format)
911
_legacy_formats = [BzrBranchFormat4(),
914
class BzrBranch(Branch):
915
"""A branch stored in the actual filesystem.
917
Note that it's "local" in the context of the filesystem; it doesn't
918
really matter if it's on an nfs/smb/afs/coda/... share, as long as
919
it's writable, and can be accessed via the normal filesystem API.
1144
## TODO: Option to move IDs only
1145
assert not isinstance(from_paths, basestring)
1146
tree = self.working_tree()
1147
inv = tree.inventory
1148
to_abs = self.abspath(to_name)
1149
if not isdir(to_abs):
1150
raise BzrError("destination %r is not a directory" % to_abs)
1151
if not tree.has_filename(to_name):
1152
raise BzrError("destination %r not in working directory" % to_abs)
1153
to_dir_id = inv.path2id(to_name)
1154
if to_dir_id == None and to_name != '':
1155
raise BzrError("destination %r is not a versioned directory" % to_name)
1156
to_dir_ie = inv[to_dir_id]
1157
if to_dir_ie.kind not in ('directory', 'root_directory'):
1158
raise BzrError("destination %r is not a directory" % to_abs)
1160
to_idpath = inv.get_idpath(to_dir_id)
1162
for f in from_paths:
1163
if not tree.has_filename(f):
1164
raise BzrError("%r does not exist in working tree" % f)
1165
f_id = inv.path2id(f)
1167
raise BzrError("%r is not versioned" % f)
1168
name_tail = splitpath(f)[-1]
1169
dest_path = appendpath(to_name, name_tail)
1170
if tree.has_filename(dest_path):
1171
raise BzrError("destination %r already exists" % dest_path)
1172
if f_id in to_idpath:
1173
raise BzrError("can't move %r to a subdirectory of itself" % f)
1175
# OK, so there's a race here, it's possible that someone will
1176
# create a file in this interval and then the rename might be
1177
# left half-done. But we should have caught most problems.
1179
for f in from_paths:
1180
name_tail = splitpath(f)[-1]
1181
dest_path = appendpath(to_name, name_tail)
1182
result.append((f, dest_path))
1183
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1185
os.rename(self.abspath(f), self.abspath(dest_path))
1187
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1188
["rename rolled back"])
1190
self._write_inventory(inv)
1197
def revert(self, filenames, old_tree=None, backups=True):
1198
"""Restore selected files to the versions from a previous tree.
1201
If true (default) backups are made of files before
1204
from bzrlib.errors import NotVersionedError, BzrError
1205
from bzrlib.atomicfile import AtomicFile
1206
from bzrlib.osutils import backup_file
1208
inv = self.read_working_inventory()
1209
if old_tree is None:
1210
old_tree = self.basis_tree()
1211
old_inv = old_tree.inventory
1214
for fn in filenames:
1215
file_id = inv.path2id(fn)
1217
raise NotVersionedError("not a versioned file", fn)
1218
if not old_inv.has_id(file_id):
1219
raise BzrError("file not present in old tree", fn, file_id)
1220
nids.append((fn, file_id))
1222
# TODO: Rename back if it was previously at a different location
1224
# TODO: If given a directory, restore the entire contents from
1225
# the previous version.
1227
# TODO: Make a backup to a temporary file.
1229
# TODO: If the file previously didn't exist, delete it?
1230
for fn, file_id in nids:
1233
f = AtomicFile(fn, 'wb')
1235
f.write(old_tree.get_file(file_id).read())
1241
def pending_merges(self):
1242
"""Return a list of pending merges.
1244
These are revisions that have been merged into the working
1245
directory but not yet committed.
1247
cfn = self.controlfilename('pending-merges')
1248
if not os.path.exists(cfn):
1251
for l in self.controlfile('pending-merges', 'r').readlines():
1252
p.append(l.rstrip('\n'))
1256
def add_pending_merge(self, revision_id):
1257
from bzrlib.revision import validate_revision_id
1259
validate_revision_id(revision_id)
1261
p = self.pending_merges()
1262
if revision_id in p:
1264
p.append(revision_id)
1265
self.set_pending_merges(p)
1268
def set_pending_merges(self, rev_list):
1269
from bzrlib.atomicfile import AtomicFile
1272
f = AtomicFile(self.controlfilename('pending-merges'))
1284
class ScratchBranch(Branch):
1285
"""Special test class: a branch that cleans up after itself.
1287
>>> b = ScratchBranch()
1295
def __init__(self, files=[], dirs=[], base=None):
1296
"""Make a test branch.
1298
This creates a temporary directory and runs init-tree in it.
1300
If any files are listed, they are created in the working copy.
1302
from tempfile import mkdtemp
1307
Branch.__init__(self, base, init=init)
1309
os.mkdir(self.abspath(d))
1312
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1317
>>> orig = ScratchBranch(files=["file1", "file2"])
1318
>>> clone = orig.clone()
1319
>>> os.path.samefile(orig.base, clone.base)
1321
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1324
from shutil import copytree
1325
from tempfile import mkdtemp
1328
copytree(self.base, base, symlinks=True)
1329
return ScratchBranch(base=base)
1335
"""Destroy the test branch, removing the scratch directory."""
1336
from shutil import rmtree
1339
mutter("delete ScratchBranch %s" % self.base)
1342
# Work around for shutil.rmtree failing on Windows when
1343
# readonly files are encountered
1344
mutter("hit exception in destroying ScratchBranch: %s" % e)
1345
for root, dirs, files in os.walk(self.base, topdown=False):
1347
os.chmod(os.path.join(root, name), 0700)
922
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
923
relax_version_check=DEPRECATED_PARAMETER, _format=None,
924
_control_files=None, a_bzrdir=None, _repository=None):
925
"""Create new branch object at a particular location.
927
transport -- A Transport object, defining how to access files.
929
init -- If True, create new control files in a previously
930
unversioned directory. If False, the branch must already
933
relax_version_check -- If true, the usual check for the branch
934
version is not applied. This is intended only for
935
upgrade/recovery type use; it's not guaranteed that
936
all operations will work on old format branches.
939
self.bzrdir = bzrdir.BzrDir.open(transport.base)
941
self.bzrdir = a_bzrdir
942
self._transport = self.bzrdir.transport.clone('..')
943
self._base = self._transport.base
944
self._format = _format
945
if _control_files is None:
946
raise ValueError('BzrBranch _control_files is None')
947
self.control_files = _control_files
948
if deprecated_passed(init):
949
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
950
"deprecated as of bzr 0.8. Please use Branch.create().",
954
# this is slower than before deprecation, oh well never mind.
956
self._initialize(transport.base)
957
self._check_format(_format)
958
if deprecated_passed(relax_version_check):
959
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
960
"relax_version_check parameter is deprecated as of bzr 0.8. "
961
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
965
if (not relax_version_check
966
and not self._format.is_supported()):
967
raise errors.UnsupportedFormatError(format=fmt)
968
if deprecated_passed(transport):
969
warn("BzrBranch.__init__(transport=XXX...): The transport "
970
"parameter is deprecated as of bzr 0.8. "
971
"Please use Branch.open, or bzrdir.open_branch().",
974
self.repository = _repository
977
return '%s(%r)' % (self.__class__.__name__, self.base)
984
base = property(_get_base, doc="The URL for the root of this branch.")
986
def _finish_transaction(self):
987
"""Exit the current transaction."""
988
return self.control_files._finish_transaction()
990
def get_transaction(self):
991
"""Return the current active transaction.
993
If no transaction is active, this returns a passthrough object
994
for which all data is immediately flushed and no caching happens.
996
# this is an explicit function so that we can do tricky stuff
997
# when the storage in rev_storage is elsewhere.
998
# we probably need to hook the two 'lock a location' and
999
# 'have a transaction' together more delicately, so that
1000
# we can have two locks (branch and storage) and one transaction
1001
# ... and finishing the transaction unlocks both, but unlocking
1002
# does not. - RBC 20051121
1003
return self.control_files.get_transaction()
1005
def _set_transaction(self, transaction):
1006
"""Set a new active transaction."""
1007
return self.control_files._set_transaction(transaction)
1009
def abspath(self, name):
1010
"""See Branch.abspath."""
1011
return self.control_files._transport.abspath(name)
1013
def _check_format(self, format):
1014
"""Identify the branch format if needed.
1016
The format is stored as a reference to the format object in
1017
self._format for code that needs to check it later.
1019
The format parameter is either None or the branch format class
1020
used to open this branch.
1022
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1025
format = BranchFormat.find_format(self.bzrdir)
1026
self._format = format
1027
mutter("got branch format %s", self._format)
1030
def get_root_id(self):
1031
"""See Branch.get_root_id."""
1032
tree = self.repository.revision_tree(self.last_revision())
1033
return tree.inventory.root.file_id
1035
def is_locked(self):
1036
return self.control_files.is_locked()
1038
def lock_write(self):
1039
self.repository.lock_write()
1041
self.control_files.lock_write()
1043
self.repository.unlock()
1046
def lock_read(self):
1047
self.repository.lock_read()
1049
self.control_files.lock_read()
1051
self.repository.unlock()
1055
# TODO: test for failed two phase locks. This is known broken.
1057
self.control_files.unlock()
1059
self.repository.unlock()
1061
def peek_lock_mode(self):
1062
if self.control_files._lock_count == 0:
1065
return self.control_files._lock_mode
1067
def get_physical_lock_status(self):
1068
return self.control_files.get_physical_lock_status()
1071
def print_file(self, file, revision_id):
1072
"""See Branch.print_file."""
1073
return self.repository.print_file(file, revision_id)
1076
def append_revision(self, *revision_ids):
1077
"""See Branch.append_revision."""
1078
for revision_id in revision_ids:
1079
mutter("add {%s} to revision-history" % revision_id)
1080
rev_history = self.revision_history()
1081
rev_history.extend(revision_ids)
1082
self.set_revision_history(rev_history)
1085
def set_revision_history(self, rev_history):
1086
"""See Branch.set_revision_history."""
1087
self.control_files.put_utf8(
1088
'revision-history', '\n'.join(rev_history))
1089
transaction = self.get_transaction()
1090
history = transaction.map.find_revision_history()
1091
if history is not None:
1092
# update the revision history in the identity map.
1093
history[:] = list(rev_history)
1094
# this call is disabled because revision_history is
1095
# not really an object yet, and the transaction is for objects.
1096
# transaction.register_dirty(history)
1098
transaction.map.add_revision_history(rev_history)
1099
# this call is disabled because revision_history is
1100
# not really an object yet, and the transaction is for objects.
1101
# transaction.register_clean(history)
1104
def revision_history(self):
1105
"""See Branch.revision_history."""
1106
transaction = self.get_transaction()
1107
history = transaction.map.find_revision_history()
1108
if history is not None:
1109
# mutter("cache hit for revision-history in %s", self)
1110
return list(history)
1111
decode_utf8 = cache_utf8.decode
1112
history = [decode_utf8(l.rstrip('\r\n')) for l in
1113
self.control_files.get('revision-history').readlines()]
1114
transaction.map.add_revision_history(history)
1115
# this call is disabled because revision_history is
1116
# not really an object yet, and the transaction is for objects.
1117
# transaction.register_clean(history, precious=True)
1118
return list(history)
1121
def generate_revision_history(self, revision_id, last_rev=None,
1123
"""Create a new revision history that will finish with revision_id.
1125
:param revision_id: the new tip to use.
1126
:param last_rev: The previous last_revision. If not None, then this
1127
must be a ancestory of revision_id, or DivergedBranches is raised.
1128
:param other_branch: The other branch that DivergedBranches should
1129
raise with respect to.
1131
# stop_revision must be a descendant of last_revision
1132
stop_graph = self.repository.get_revision_graph(revision_id)
1133
if last_rev is not None and last_rev not in stop_graph:
1134
# our previous tip is not merged into stop_revision
1135
raise errors.DivergedBranches(self, other_branch)
1136
# make a new revision history from the graph
1137
current_rev_id = revision_id
1139
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1140
new_history.append(current_rev_id)
1141
current_rev_id_parents = stop_graph[current_rev_id]
1143
current_rev_id = current_rev_id_parents[0]
1145
current_rev_id = None
1146
new_history.reverse()
1147
self.set_revision_history(new_history)
1150
def update_revisions(self, other, stop_revision=None):
1151
"""See Branch.update_revisions."""
1154
if stop_revision is None:
1155
stop_revision = other.last_revision()
1156
if stop_revision is None:
1157
# if there are no commits, we're done.
1159
# whats the current last revision, before we fetch [and change it
1161
last_rev = self.last_revision()
1162
# we fetch here regardless of whether we need to so that we pickup
1164
self.fetch(other, stop_revision)
1165
my_ancestry = self.repository.get_ancestry(last_rev)
1166
if stop_revision in my_ancestry:
1167
# last_revision is a descendant of stop_revision
1169
self.generate_revision_history(stop_revision, last_rev=last_rev,
1174
def basis_tree(self):
1175
"""See Branch.basis_tree."""
1176
return self.repository.revision_tree(self.last_revision())
1178
@deprecated_method(zero_eight)
1179
def working_tree(self):
1180
"""Create a Working tree object for this branch."""
1182
from bzrlib.transport.local import LocalTransport
1183
if (self.base.find('://') != -1 or
1184
not isinstance(self._transport, LocalTransport)):
1185
raise NoWorkingTree(self.base)
1186
return self.bzrdir.open_workingtree()
1189
def pull(self, source, overwrite=False, stop_revision=None):
1190
"""See Branch.pull."""
1193
old_count = len(self.revision_history())
1195
self.update_revisions(source, stop_revision)
1196
except DivergedBranches:
1200
self.set_revision_history(source.revision_history())
1201
new_count = len(self.revision_history())
1202
return new_count - old_count
1206
def get_parent(self):
1207
"""See Branch.get_parent."""
1209
_locs = ['parent', 'pull', 'x-pull']
1210
assert self.base[-1] == '/'
1213
parent = self.control_files.get(l).read().strip('\n')
1216
# This is an old-format absolute path to a local branch
1217
# turn it into a url
1218
if parent.startswith('/'):
1219
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1221
return urlutils.join(self.base[:-1], parent)
1222
except errors.InvalidURLJoin, e:
1223
raise errors.InaccessibleParent(parent, self.base)
1226
def get_push_location(self):
1227
"""See Branch.get_push_location."""
1228
push_loc = self.get_config().get_user_option('push_location')
1231
def set_push_location(self, location):
1232
"""See Branch.set_push_location."""
1233
self.get_config().set_user_option('push_location', location,
1237
def set_parent(self, url):
1238
"""See Branch.set_parent."""
1239
# TODO: Maybe delete old location files?
1240
# URLs should never be unicode, even on the local fs,
1241
# FIXUP this and get_parent in a future branch format bump:
1242
# read and rewrite the file, and have the new format code read
1243
# using .get not .get_utf8. RBC 20060125
1245
self.control_files._transport.delete('parent')
1247
if isinstance(url, unicode):
1249
url = url.encode('ascii')
1250
except UnicodeEncodeError:
1251
raise bzrlib.errors.InvalidURL(url,
1252
"Urls must be 7-bit ascii, "
1253
"use bzrlib.urlutils.escape")
1255
url = urlutils.relative_url(self.base, url)
1256
self.control_files.put('parent', StringIO(url + '\n'))
1258
@deprecated_function(zero_nine)
1259
def tree_config(self):
1260
"""DEPRECATED; call get_config instead.
1261
TreeConfig has become part of BranchConfig."""
1262
return TreeConfig(self)
1265
class BzrBranch5(BzrBranch):
1266
"""A format 5 branch. This supports new features over plan branches.
1268
It has support for a master_branch which is the data for bound branches.
1276
super(BzrBranch5, self).__init__(_format=_format,
1277
_control_files=_control_files,
1279
_repository=_repository)
1282
def pull(self, source, overwrite=False, stop_revision=None):
1283
"""Updates branch.pull to be bound branch aware."""
1284
bound_location = self.get_bound_location()
1285
if source.base != bound_location:
1286
# not pulling from master, so we need to update master.
1287
master_branch = self.get_master_branch()
1289
master_branch.pull(source)
1290
source = master_branch
1291
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1293
def get_bound_location(self):
1295
return self.control_files.get_utf8('bound').read()[:-1]
1296
except errors.NoSuchFile:
1300
def get_master_branch(self):
1301
"""Return the branch we are bound to.
1303
:return: Either a Branch, or None
1305
This could memoise the branch, but if thats done
1306
it must be revalidated on each new lock.
1307
So for now we just don't memoise it.
1308
# RBC 20060304 review this decision.
1310
bound_loc = self.get_bound_location()
1314
return Branch.open(bound_loc)
1315
except (errors.NotBranchError, errors.ConnectionError), e:
1316
raise errors.BoundBranchConnectionFailure(
1320
def set_bound_location(self, location):
1321
"""Set the target where this branch is bound to.
1323
:param location: URL to the target branch
1326
self.control_files.put_utf8('bound', location+'\n')
1329
self.control_files._transport.delete('bound')
1353
######################################################################
1357
def is_control_file(filename):
1358
## FIXME: better check
1359
filename = os.path.normpath(filename)
1360
while filename != '':
1361
head, tail = os.path.split(filename)
1362
## mutter('check %r for control file' % ((head, tail), ))
1363
if tail == bzrlib.BZRDIR:
1335
def bind(self, other):
1336
"""Bind this branch to the branch other.
1338
This does not push or pull data between the branches, though it does
1339
check for divergence to raise an error when the branches are not
1340
either the same, or one a prefix of the other. That behaviour may not
1341
be useful, so that check may be removed in future.
1343
:param other: The branch to bind to
1346
# TODO: jam 20051230 Consider checking if the target is bound
1347
# It is debatable whether you should be able to bind to
1348
# a branch which is itself bound.
1349
# Committing is obviously forbidden,
1350
# but binding itself may not be.
1351
# Since we *have* to check at commit time, we don't
1352
# *need* to check here
1354
# we want to raise diverged if:
1355
# last_rev is not in the other_last_rev history, AND
1356
# other_last_rev is not in our history, and do it without pulling
1358
last_rev = self.last_revision()
1359
if last_rev is not None:
1362
other_last_rev = other.last_revision()
1363
if other_last_rev is not None:
1364
# neither branch is new, we have to do some work to
1365
# ascertain diversion.
1366
remote_graph = other.repository.get_revision_graph(
1368
local_graph = self.repository.get_revision_graph(last_rev)
1369
if (last_rev not in remote_graph and
1370
other_last_rev not in local_graph):
1371
raise errors.DivergedBranches(self, other)
1374
self.set_bound_location(other.base)
1378
"""If bound, unbind"""
1379
return self.set_bound_location(None)
1383
"""Synchronise this branch with the master branch if any.
1385
:return: None or the last_revision that was pivoted out during the
1388
master = self.get_master_branch()
1389
if master is not None:
1390
old_tip = self.last_revision()
1391
self.pull(master, overwrite=True)
1392
if old_tip in self.repository.get_ancestry(self.last_revision()):
1398
class BranchTestProviderAdapter(object):
1399
"""A tool to generate a suite testing multiple branch formats at once.
1401
This is done by copying the test once for each transport and injecting
1402
the transport_server, transport_readonly_server, and branch_format
1403
classes into each copy. Each copy is also given a new id() to make it
1407
def __init__(self, transport_server, transport_readonly_server, formats):
1408
self._transport_server = transport_server
1409
self._transport_readonly_server = transport_readonly_server
1410
self._formats = formats
1412
def adapt(self, test):
1413
result = TestSuite()
1414
for branch_format, bzrdir_format in self._formats:
1415
new_test = deepcopy(test)
1416
new_test.transport_server = self._transport_server
1417
new_test.transport_readonly_server = self._transport_readonly_server
1418
new_test.bzrdir_format = bzrdir_format
1419
new_test.branch_format = branch_format
1420
def make_new_test_id():
1421
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1422
return lambda: new_id
1423
new_test.id = make_new_test_id()
1424
result.addTest(new_test)
1428
class BranchCheckResult(object):
1429
"""Results of checking branch consistency.
1434
def __init__(self, branch):
1435
self.branch = branch
1437
def report_results(self, verbose):
1438
"""Report the check results via trace.note.
1440
:param verbose: Requests more detailed display of what was checked,
1443
note('checked branch %s format %s',
1445
self.branch._format)
1448
######################################################################
1452
@deprecated_function(zero_eight)
1453
def is_control_file(*args, **kwargs):
1454
"""See bzrlib.workingtree.is_control_file."""
1455
return bzrlib.workingtree.is_control_file(*args, **kwargs)
1365
if filename == head:
1372
def gen_file_id(name):
1373
"""Return new file id.
1375
This should probably generate proper UUIDs, but for the moment we
1376
cope with just randomness because running uuidgen every time is
1379
from binascii import hexlify
1380
from time import time
1382
# get last component
1383
idx = name.rfind('/')
1385
name = name[idx+1 : ]
1386
idx = name.rfind('\\')
1388
name = name[idx+1 : ]
1390
# make it not a hidden file
1391
name = name.lstrip('.')
1393
# remove any wierd characters; we don't escape them but rather
1394
# just pull them out
1395
name = re.sub(r'[^\w.]', '', name)
1397
s = hexlify(rand_bytes(8))
1398
return '-'.join((name, compact_date(time()), s))
1402
"""Return a new tree-root file id."""
1403
return gen_file_id('TREE_ROOT')
1406
def pull_loc(branch):
1407
# TODO: Should perhaps just make attribute be 'base' in
1408
# RemoteBranch and Branch?
1409
if hasattr(branch, "baseurl"):
1410
return branch.baseurl
1415
def copy_branch(branch_from, to_location, revision=None):
1416
"""Copy branch_from into the existing directory to_location.
1418
If revision is not None, the head of the new branch will be revision.
1420
from bzrlib.merge import merge
1421
from bzrlib.branch import Branch
1422
br_to = Branch(to_location, init=True)
1423
br_to.set_root_id(branch_from.get_root_id())
1424
if revision is None:
1425
revno = branch_from.revno()
1427
revno, rev_id = branch_from.get_revision_info(revision)
1428
br_to.update_revisions(branch_from, stop_revision=revno)
1429
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1430
check_clean=False, ignore_zero=True)
1431
from_location = pull_loc(branch_from)
1432
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
added
removed
bzrlib/branch.py
