129
80
"""Branch holding a history of revisions.
132
Base directory of the branch.
138
If _lock_mode is true, a positive count of the number of times the
142
Lock object from bzrlib.lock.
83
Base directory/url of the branch.
85
# this is really an instance variable - FIXME move it there
150
# Map some sort of prefix into a namespace
151
# stuff like "revno:10", "revid:", etc.
152
# This should match a prefix with a function which accepts
153
REVISION_NAMESPACES = {}
155
def __init__(self, transport, init=False):
156
"""Create new branch object at a particular location.
158
transport -- A Transport object, defining how to access files.
159
(If a string, transport.transport() will be used to
160
create a Transport object)
162
init -- If True, create new control files in a previously
163
unversioned directory. If False, the branch must already
166
In the test suite, creation of new trees is tested using the
167
`ScratchBranch` class.
169
if isinstance(transport, basestring):
170
from transport import transport as get_transport
171
transport = get_transport(transport)
173
self._transport = transport
180
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
187
if self._lock_mode or self._lock:
188
from bzrlib.warnings import warn
189
warn("branch %r was not explicitly unlocked" % self)
192
# TODO: It might be best to do this somewhere else,
193
# but it is nice for a Branch object to automatically
194
# cache it's information.
195
# Alternatively, we could have the Transport objects cache requests
196
# See the earlier discussion about how major objects (like Branch)
197
# should never expect their __del__ function to run.
198
if self.cache_root is not None:
199
#from warnings import warn
200
#warn("branch %r auto-cleanup of cache files" % self)
203
shutil.rmtree(self.cache_root)
206
self.cache_root = None
210
return self._transport.base
213
base = property(_get_base)
89
def __init__(self, *ignored, **ignored_too):
90
raise NotImplementedError('The Branch class is abstract')
93
"""Break a lock if one is present from another instance.
95
Uses the ui factory to ask for confirmation if the lock may be from
98
This will probe the repository for its lock as well.
100
self.control_files.break_lock()
101
self.repository.break_lock()
102
master = self.get_master_branch()
103
if master is not None:
107
@deprecated_method(zero_eight)
108
def open_downlevel(base):
109
"""Open a branch which may be of an old format."""
110
return Branch.open(base, _unsupported=True)
113
def open(base, _unsupported=False):
114
"""Open the branch rooted at base.
116
For instance, if the branch is at URL/.bzr/branch,
117
Branch.open(URL) -> a Branch instance.
119
control = bzrdir.BzrDir.open(base, _unsupported)
120
return control.open_branch(_unsupported)
123
def open_containing(url):
124
"""Open an existing branch which contains url.
126
This probes for a branch at url, and searches upwards from there.
128
Basically we keep looking up until we find the control directory or
129
run into the root. If there isn't one, raises NotBranchError.
130
If there is one and it is either an unrecognised format or an unsupported
131
format, UnknownFormatError or UnsupportedFormatError are raised.
132
If there is one, it is returned, along with the unused portion of url.
134
control, relpath = bzrdir.BzrDir.open_containing(url)
135
return control.open_branch(), relpath
138
@deprecated_function(zero_eight)
139
def initialize(base):
140
"""Create a new working tree and branch, rooted at 'base' (url)
142
NOTE: This will soon be deprecated in favour of creation
145
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
147
@deprecated_function(zero_eight)
148
def setup_caching(self, cache_root):
149
"""Subclasses that care about caching should override this, and set
150
up cached stores located under cache_root.
152
NOTE: This is unused.
156
def get_config(self):
157
return BranchConfig(self)
160
return self.get_config().get_nickname()
162
def _set_nick(self, nick):
163
self.get_config().set_user_option('nickname', nick)
165
nick = property(_get_nick, _set_nick)
168
raise NotImplementedError(self.is_locked)
216
170
def lock_write(self):
217
# TODO: Upgrade locking to support using a Transport,
218
# and potentially a remote locking protocol
220
if self._lock_mode != 'w':
221
from bzrlib.errors import LockError
222
raise LockError("can't upgrade to a write lock from %r" %
224
self._lock_count += 1
226
self._lock = self._transport.lock_write(
227
self._rel_controlfilename('branch-lock'))
228
self._lock_mode = 'w'
171
raise NotImplementedError(self.lock_write)
232
173
def lock_read(self):
234
assert self._lock_mode in ('r', 'w'), \
235
"invalid lock mode %r" % self._lock_mode
236
self._lock_count += 1
238
self._lock = self._transport.lock_read(
239
self._rel_controlfilename('branch-lock'))
240
self._lock_mode = 'r'
174
raise NotImplementedError(self.lock_read)
243
176
def unlock(self):
244
if not self._lock_mode:
245
from bzrlib.errors import LockError
246
raise LockError('branch %r is not locked' % (self))
248
if self._lock_count > 1:
249
self._lock_count -= 1
253
self._lock_mode = self._lock_count = None
177
raise NotImplementedError(self.unlock)
179
def peek_lock_mode(self):
180
"""Return lock mode for the Branch: 'r', 'w' or None"""
181
raise NotImplementedError(self.peek_lock_mode)
183
def get_physical_lock_status(self):
184
raise NotImplementedError(self.get_physical_lock_status)
255
186
def abspath(self, name):
256
"""Return absolute filename for something in the branch"""
257
return self._transport.abspath(name)
259
def relpath(self, path):
260
"""Return path relative to this branch of something inside it.
262
Raises an error if path is not in this branch."""
263
return self._transport.relpath(path)
266
def _rel_controlfilename(self, file_or_path):
267
if isinstance(file_or_path, basestring):
268
file_or_path = [file_or_path]
269
return [bzrlib.BZRDIR] + file_or_path
271
def controlfilename(self, file_or_path):
272
"""Return location relative to branch."""
273
return self._transport.abspath(self._rel_controlfilename(file_or_path))
276
def controlfile(self, file_or_path, mode='r'):
277
"""Open a control file for this branch.
279
There are two classes of file in the control directory: text
280
and binary. binary files are untranslated byte streams. Text
281
control files are stored with Unix newlines and in UTF-8, even
282
if the platform or locale defaults are different.
284
Controlfiles should almost never be opened in write mode but
285
rather should be atomically copied and replaced using atomicfile.
289
relpath = self._rel_controlfilename(file_or_path)
290
#TODO: codecs.open() buffers linewise, so it was overloaded with
291
# a much larger buffer, do we need to do the same for getreader/getwriter?
293
return self._transport.get(relpath)
295
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
297
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
299
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
187
"""Return absolute filename for something in the branch
189
XXX: Robert Collins 20051017 what is this used for? why is it a branch
190
method and not a tree method.
192
raise NotImplementedError(self.abspath)
194
def bind(self, other):
195
"""Bind the local branch the other branch.
197
:param other: The branch to bind to
200
raise errors.UpgradeRequired(self.base)
203
def fetch(self, from_branch, last_revision=None, pb=None):
204
"""Copy revisions from from_branch into this branch.
206
:param from_branch: Where to copy from.
207
:param last_revision: What revision to stop at (None for at the end
209
:param pb: An optional progress bar to use.
211
Returns the copied revision count and the failed revisions in a tuple:
214
if self.base == from_branch.base:
217
nested_pb = ui.ui_factory.nested_progress_bar()
301
raise BzrError("invalid controlfile mode %r" % mode)
303
def put_controlfile(self, path, f, encode=True):
304
"""Write an entry as a controlfile.
306
:param path: The path to put the file, relative to the .bzr control
308
:param f: A file-like or string object whose contents should be copied.
309
:param encode: If true, encode the contents as utf-8
311
self.put_controlfiles([(path, f)], encode=encode)
313
def put_controlfiles(self, files, encode=True):
314
"""Write several entries as controlfiles.
316
:param files: A list of [(path, file)] pairs, where the path is the directory
317
underneath the bzr control directory
318
:param encode: If true, encode the contents as utf-8
322
for path, f in files:
324
if isinstance(f, basestring):
325
f = f.encode('utf-8', 'replace')
222
from_branch.lock_read()
224
if last_revision is None:
225
pb.update('get source history')
226
from_history = from_branch.revision_history()
228
last_revision = from_history[-1]
327
f = codecs.getwriter('utf-8')(f, errors='replace')
328
path = self._rel_controlfilename(path)
329
ctrl_files.append((path, f))
330
self._transport.put_multi(ctrl_files)
332
def _make_control(self):
333
from bzrlib.inventory import Inventory
334
from cStringIO import StringIO
336
# Create an empty inventory
338
# if we want per-tree root ids then this is the place to set
339
# them; they're not needed for now and so ommitted for
341
bzrlib.xml.serializer_v4.write_inventory(Inventory(), sio)
343
dirs = [[], 'text-store', 'inventory-store', 'revision-store']
345
"This is a Bazaar-NG control directory.\n"
346
"Do not change any files in this directory.\n"),
347
('branch-format', BZR_BRANCH_FORMAT),
348
('revision-history', ''),
349
('merged-patches', ''),
350
('pending-merged-patches', ''),
353
('pending-merges', ''),
354
('inventory', sio.getvalue())
356
self._transport.mkdir_multi([self._rel_controlfilename(d) for d in dirs])
357
self.put_controlfiles(files)
358
mutter('created control directory in ' + self._transport.base)
360
def _check_format(self):
361
"""Check this branch format is supported.
363
The current tool only supports the current unstable format.
365
In the future, we might need different in-memory Branch
366
classes to support downlevel branches. But not yet.
368
# This ignores newlines so that we can open branches created
369
# on Windows from Linux and so on. I think it might be better
370
# to always make all internal files in unix format.
371
fmt = self.controlfile('branch-format', 'r').read()
372
fmt = fmt.replace('\r\n', '\n')
373
if fmt != BZR_BRANCH_FORMAT:
374
raise BzrError('sorry, branch format %r not supported' % fmt,
375
['use a different bzr version',
376
'or remove the .bzr directory and "bzr init" again'])
378
# We know that the format is the currently supported one.
379
# So create the rest of the entries.
380
from bzrlib.store.compressed_text import CompressedTextStore
382
if self._transport.should_cache():
384
self.cache_root = tempfile.mkdtemp(prefix='bzr-cache')
385
mutter('Branch %r using caching in %r' % (self, self.cache_root))
387
self.cache_root = None
390
relpath = self._rel_controlfilename(name)
391
store = CompressedTextStore(self._transport.clone(relpath))
392
if self._transport.should_cache():
393
from meta_store import CachedStore
394
cache_path = os.path.join(self.cache_root, name)
396
store = CachedStore(store, cache_path)
399
self.text_store = get_store('text-store')
400
self.revision_store = get_store('revision-store')
401
self.inventory_store = get_store('inventory-store')
403
def get_root_id(self):
404
"""Return the id of this branches root"""
405
inv = self.read_working_inventory()
406
return inv.root.file_id
408
def set_root_id(self, file_id):
409
inv = self.read_working_inventory()
410
orig_root_id = inv.root.file_id
411
del inv._byid[inv.root.file_id]
412
inv.root.file_id = file_id
413
inv._byid[inv.root.file_id] = inv.root
416
if entry.parent_id in (None, orig_root_id):
417
entry.parent_id = inv.root.file_id
418
self._write_inventory(inv)
420
def read_working_inventory(self):
421
"""Read the working inventory."""
422
from bzrlib.inventory import Inventory
425
# ElementTree does its own conversion from UTF-8, so open in
427
f = self.controlfile('inventory', 'rb')
428
return bzrlib.xml.serializer_v4.read_inventory(f)
433
def _write_inventory(self, inv):
434
"""Update the working inventory.
436
That is to say, the inventory describing changes underway, that
437
will be committed to the next revision.
439
from cStringIO import StringIO
443
bzrlib.xml.serializer_v4.write_inventory(inv, sio)
445
# Transport handles atomicity
446
self.put_controlfile('inventory', sio)
450
mutter('wrote working inventory')
453
inventory = property(read_working_inventory, _write_inventory, None,
454
"""Inventory for the working copy.""")
457
def add(self, files, ids=None):
458
"""Make files versioned.
460
Note that the command line normally calls smart_add instead,
461
which can automatically recurse.
463
This puts the files in the Added state, so that they will be
464
recorded by the next commit.
467
List of paths to add, relative to the base of the tree.
470
If set, use these instead of automatically generated ids.
471
Must be the same length as the list of files, but may
472
contain None for ids that are to be autogenerated.
474
TODO: Perhaps have an option to add the ids even if the files do
477
TODO: Perhaps yield the ids and paths as they're added.
479
# TODO: Re-adding a file that is removed in the working copy
480
# should probably put it back with the previous ID.
481
if isinstance(files, basestring):
482
assert(ids is None or isinstance(ids, basestring))
488
ids = [None] * len(files)
490
assert(len(ids) == len(files))
494
inv = self.read_working_inventory()
495
for f,file_id in zip(files, ids):
496
if is_control_file(f):
497
raise BzrError("cannot add control file %s" % quotefn(f))
502
raise BzrError("cannot add top-level %r" % f)
504
fullpath = os.path.normpath(self.abspath(f))
507
kind = file_kind(fullpath)
509
# maybe something better?
510
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
512
if kind != 'file' and kind != 'directory':
513
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
516
file_id = gen_file_id(f)
517
inv.add_path(f, kind=kind, file_id=file_id)
519
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
521
self._write_inventory(inv)
526
def print_file(self, file, revno):
527
"""Print `file` to stdout."""
530
tree = self.revision_tree(self.lookup_revision(revno))
531
# use inventory as it was in that revision
532
file_id = tree.inventory.path2id(file)
534
raise BzrError("%r is not present in revision %s" % (file, revno))
535
tree.print_file(file_id)
540
def remove(self, files, verbose=False):
541
"""Mark nominated files for removal from the inventory.
543
This does not remove their text. This does not run on
545
TODO: Refuse to remove modified files unless --force is given?
547
TODO: Do something useful with directories.
549
TODO: Should this remove the text or not? Tough call; not
550
removing may be useful and the user can just use use rm, and
551
is the opposite of add. Removing it is consistent with most
552
other tools. Maybe an option.
554
## TODO: Normalize names
555
## TODO: Remove nested loops; better scalability
556
if isinstance(files, basestring):
562
tree = self.working_tree()
565
# do this before any modifications
569
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
570
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
572
# having remove it, it must be either ignored or unknown
573
if tree.is_ignored(f):
577
show_status(new_status, inv[fid].kind, quotefn(f))
580
self._write_inventory(inv)
585
# FIXME: this doesn't need to be a branch method
586
def set_inventory(self, new_inventory_list):
587
from bzrlib.inventory import Inventory, InventoryEntry
588
inv = Inventory(self.get_root_id())
589
for path, file_id, parent, kind in new_inventory_list:
590
name = os.path.basename(path)
593
inv.add(InventoryEntry(file_id, name, kind, parent))
594
self._write_inventory(inv)
598
"""Return all unknown files.
600
These are files in the working directory that are not versioned or
601
control files or ignored.
603
>>> b = ScratchBranch(files=['foo', 'foo~'])
604
>>> list(b.unknowns())
607
>>> list(b.unknowns())
610
>>> list(b.unknowns())
613
return self.working_tree().unknowns()
616
def append_revision(self, *revision_ids):
617
for revision_id in revision_ids:
618
mutter("add {%s} to revision-history" % revision_id)
620
rev_history = self.revision_history()
621
rev_history.extend(revision_ids)
625
self.put_controlfile('revision-history', '\n'.join(rev_history))
630
def get_revision_xml_file(self, revision_id):
631
"""Return XML file object for revision object."""
632
if not revision_id or not isinstance(revision_id, basestring):
633
raise InvalidRevisionId(revision_id)
638
return self.revision_store[revision_id]
639
except (IndexError, KeyError):
640
raise bzrlib.errors.NoSuchRevision(self, revision_id)
646
get_revision_xml = get_revision_xml_file
649
def get_revision(self, revision_id):
650
"""Return the Revision object for a named revision"""
651
xml_file = self.get_revision_xml_file(revision_id)
654
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
655
except SyntaxError, e:
656
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
660
assert r.revision_id == revision_id
230
# no history in the source branch
231
last_revision = _mod_revision.NULL_REVISION
232
return self.repository.fetch(from_branch.repository,
233
revision_id=last_revision,
236
if nested_pb is not None:
240
def get_bound_location(self):
241
"""Return the URL of the branch we are bound to.
243
Older format branches cannot bind, please be sure to use a metadir
248
def get_commit_builder(self, parents, config=None, timestamp=None,
249
timezone=None, committer=None, revprops=None,
251
"""Obtain a CommitBuilder for this branch.
253
:param parents: Revision ids of the parents of the new revision.
254
:param config: Optional configuration to use.
255
:param timestamp: Optional timestamp recorded for commit.
256
:param timezone: Optional timezone for timestamp.
257
:param committer: Optional committer to set for commit.
258
:param revprops: Optional dictionary of revision properties.
259
:param revision_id: Optional revision id.
263
config = self.get_config()
265
return self.repository.get_commit_builder(self, parents, config,
266
timestamp, timezone, committer, revprops, revision_id)
268
def get_master_branch(self):
269
"""Return the branch we are bound to.
271
:return: Either a Branch, or None
664
275
def get_revision_delta(self, revno):
665
276
"""Return the delta for one revision.
895
340
if stop_revision is None:
896
341
stop_revision = other_len
897
elif stop_revision > other_len:
898
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
343
assert isinstance(stop_revision, int)
344
if stop_revision > other_len:
345
raise errors.NoSuchRevision(self, stop_revision)
900
346
return other_history[self_len:stop_revision]
903
348
def update_revisions(self, other, stop_revision=None):
904
"""Pull in all new revisions from other branch.
349
"""Pull in new perfect-fit revisions.
351
:param other: Another Branch to pull from
352
:param stop_revision: Updated until the given revision
906
from bzrlib.fetch import greedy_fetch
907
from bzrlib.revision import get_intervening_revisions
909
pb = bzrlib.ui.ui_factory.progress_bar()
910
pb.update('comparing histories')
911
if stop_revision is None:
912
other_revision = other.last_patch()
914
other_revision = other.lookup_revision(stop_revision)
915
count = greedy_fetch(self, other, other_revision, pb)[0]
917
revision_ids = self.missing_revisions(other, stop_revision)
918
except DivergedBranches, e:
920
revision_ids = get_intervening_revisions(self.last_patch(),
921
other_revision, self)
922
assert self.last_patch() not in revision_ids
923
except bzrlib.errors.NotAncestor:
926
self.append_revision(*revision_ids)
929
def install_revisions(self, other, revision_ids, pb):
930
# We are going to iterate this many times, so make sure
931
# that it is a list, and not a generator
932
revision_ids = list(revision_ids)
933
if hasattr(other.revision_store, "prefetch"):
934
other.revision_store.prefetch(revision_ids)
935
if hasattr(other.inventory_store, "prefetch"):
936
other.inventory_store.prefetch(inventory_ids)
939
pb = bzrlib.ui.ui_factory.progress_bar()
941
# This entire next section is generally done
942
# with either generators, or bulk updates
943
inventories = other.get_inventories(revision_ids, ignore_missing=True)
947
good_revisions = set()
948
for i, (inv, rev_id) in enumerate(zip(inventories, revision_ids)):
949
pb.update('fetching revision', i+1, len(revision_ids))
951
# We don't really need to get the revision here, because
952
# the only thing we needed was the inventory_id, which now
953
# is (by design) identical to the revision_id
955
# rev = other.get_revision(rev_id)
956
# except bzrlib.errors.NoSuchRevision:
957
# failures.add(rev_id)
964
good_revisions.add(rev_id)
967
for key, entry in inv.iter_entries():
968
if entry.text_id is None:
970
text_ids.append(entry.text_id)
972
has_ids = self.text_store.has(text_ids)
973
for has, text_id in zip(has_ids, text_ids):
975
needed_texts.add(text_id)
979
count, cp_fail = self.text_store.copy_multi(other.text_store,
981
#print "Added %d texts." % count
982
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
984
#print "Added %d inventories." % count
985
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
988
assert len(cp_fail) == 0
989
return count, failures
992
def commit(self, *args, **kw):
993
from bzrlib.commit import commit
994
commit(self, *args, **kw)
997
def lookup_revision(self, revision):
998
"""Return the revision identifier for a given revision information."""
999
revno, info = self._get_revision_info(revision)
355
raise NotImplementedError(self.update_revisions)
1003
357
def revision_id_to_revno(self, revision_id):
1004
358
"""Given a revision id, return its revno"""
359
if revision_id is None:
1005
361
history = self.revision_history()
1007
363
return history.index(revision_id) + 1
1008
364
except ValueError:
1009
365
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1012
def get_revision_info(self, revision):
1013
"""Return (revno, revision id) for revision identifier.
1015
revision can be an integer, in which case it is assumed to be revno (though
1016
this will translate negative values into positive ones)
1017
revision can also be a string, in which case it is parsed for something like
1018
'date:' or 'revid:' etc.
1020
revno, rev_id = self._get_revision_info(revision)
1022
raise bzrlib.errors.NoSuchRevision(self, revision)
1023
return revno, rev_id
1025
367
def get_rev_id(self, revno, history=None):
1026
368
"""Find the revision id of the specified revno."""
1029
371
if history is None:
1030
372
history = self.revision_history()
1031
elif revno <= 0 or revno > len(history):
373
if revno <= 0 or revno > len(history):
1032
374
raise bzrlib.errors.NoSuchRevision(self, revno)
1033
375
return history[revno - 1]
1035
def _get_revision_info(self, revision):
1036
"""Return (revno, revision id) for revision specifier.
1038
revision can be an integer, in which case it is assumed to be revno
1039
(though this will translate negative values into positive ones)
1040
revision can also be a string, in which case it is parsed for something
1041
like 'date:' or 'revid:' etc.
1043
A revid is always returned. If it is None, the specifier referred to
1044
the null revision. If the revid does not occur in the revision
1045
history, revno will be None.
1048
if revision is None:
1051
try:# Convert to int if possible
1052
revision = int(revision)
1055
revs = self.revision_history()
1056
if isinstance(revision, int):
1058
revno = len(revs) + revision + 1
1061
rev_id = self.get_rev_id(revno, revs)
1062
elif isinstance(revision, basestring):
1063
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
1064
if revision.startswith(prefix):
1065
result = func(self, revs, revision)
1067
revno, rev_id = result
1070
rev_id = self.get_rev_id(revno, revs)
1073
raise BzrError('No namespace registered for string: %r' %
1076
raise TypeError('Unhandled revision type %s' % revision)
1080
raise bzrlib.errors.NoSuchRevision(self, revision)
1081
return revno, rev_id
1083
def _namespace_revno(self, revs, revision):
1084
"""Lookup a revision by revision number"""
1085
assert revision.startswith('revno:')
1087
return (int(revision[6:]),)
1090
REVISION_NAMESPACES['revno:'] = _namespace_revno
1092
def _namespace_revid(self, revs, revision):
1093
assert revision.startswith('revid:')
1094
rev_id = revision[len('revid:'):]
1096
return revs.index(rev_id) + 1, rev_id
1099
REVISION_NAMESPACES['revid:'] = _namespace_revid
1101
def _namespace_last(self, revs, revision):
1102
assert revision.startswith('last:')
1104
offset = int(revision[5:])
1109
raise BzrError('You must supply a positive value for --revision last:XXX')
1110
return (len(revs) - offset + 1,)
1111
REVISION_NAMESPACES['last:'] = _namespace_last
1113
def _namespace_tag(self, revs, revision):
1114
assert revision.startswith('tag:')
1115
raise BzrError('tag: namespace registered, but not implemented.')
1116
REVISION_NAMESPACES['tag:'] = _namespace_tag
1118
def _namespace_date(self, revs, revision):
1119
assert revision.startswith('date:')
1121
# Spec for date revisions:
1123
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
1124
# it can also start with a '+/-/='. '+' says match the first
1125
# entry after the given date. '-' is match the first entry before the date
1126
# '=' is match the first entry after, but still on the given date.
1128
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
1129
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
1130
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
1131
# May 13th, 2005 at 0:00
1133
# So the proper way of saying 'give me all entries for today' is:
1134
# -r {date:+today}:{date:-tomorrow}
1135
# The default is '=' when not supplied
1138
if val[:1] in ('+', '-', '='):
1139
match_style = val[:1]
1142
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1143
if val.lower() == 'yesterday':
1144
dt = today - datetime.timedelta(days=1)
1145
elif val.lower() == 'today':
1147
elif val.lower() == 'tomorrow':
1148
dt = today + datetime.timedelta(days=1)
1151
# This should be done outside the function to avoid recompiling it.
1152
_date_re = re.compile(
1153
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1155
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1157
m = _date_re.match(val)
1158
if not m or (not m.group('date') and not m.group('time')):
1159
raise BzrError('Invalid revision date %r' % revision)
1162
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1164
year, month, day = today.year, today.month, today.day
1166
hour = int(m.group('hour'))
1167
minute = int(m.group('minute'))
1168
if m.group('second'):
1169
second = int(m.group('second'))
1173
hour, minute, second = 0,0,0
1175
dt = datetime.datetime(year=year, month=month, day=day,
1176
hour=hour, minute=minute, second=second)
1180
if match_style == '-':
1182
elif match_style == '=':
1183
last = dt + datetime.timedelta(days=1)
1186
for i in range(len(revs)-1, -1, -1):
1187
r = self.get_revision(revs[i])
1188
# TODO: Handle timezone.
1189
dt = datetime.datetime.fromtimestamp(r.timestamp)
1190
if first >= dt and (last is None or dt >= last):
1193
for i in range(len(revs)):
1194
r = self.get_revision(revs[i])
1195
# TODO: Handle timezone.
1196
dt = datetime.datetime.fromtimestamp(r.timestamp)
1197
if first <= dt and (last is None or dt <= last):
1199
REVISION_NAMESPACES['date:'] = _namespace_date
1202
def _namespace_ancestor(self, revs, revision):
1203
from revision import common_ancestor, MultipleRevisionSources
1204
other_branch = find_branch(_trim_namespace('ancestor', revision))
1205
revision_a = self.last_patch()
1206
revision_b = other_branch.last_patch()
1207
for r, b in ((revision_a, self), (revision_b, other_branch)):
1209
raise bzrlib.errors.NoCommits(b)
1210
revision_source = MultipleRevisionSources(self, other_branch)
1211
result = common_ancestor(revision_a, revision_b, revision_source)
1213
revno = self.revision_id_to_revno(result)
1214
except bzrlib.errors.NoSuchRevision:
1219
REVISION_NAMESPACES['ancestor:'] = _namespace_ancestor
1221
def revision_tree(self, revision_id):
1222
"""Return Tree for a revision on this branch.
1224
`revision_id` may be None for the null revision, in which case
1225
an `EmptyTree` is returned."""
1226
# TODO: refactor this to use an existing revision object
1227
# so we don't need to read it in twice.
1228
if revision_id == None:
1231
inv = self.get_revision_inventory(revision_id)
1232
return RevisionTree(self.text_store, inv)
1235
def working_tree(self):
1236
"""Return a `Tree` for the working copy."""
1237
from bzrlib.workingtree import WorkingTree
1238
# TODO: In the future, WorkingTree should utilize Transport
1239
return WorkingTree(self._transport.base, self.read_working_inventory())
377
def pull(self, source, overwrite=False, stop_revision=None):
378
raise NotImplementedError(self.pull)
1242
380
def basis_tree(self):
1243
"""Return `Tree` object for last revision.
1245
If there are no revisions yet, return an `EmptyTree`.
1247
r = self.last_patch()
1251
return RevisionTree(self.text_store, self.get_revision_inventory(r))
381
"""Return `Tree` object for last revision."""
382
return self.repository.revision_tree(self.last_revision())
1255
384
def rename_one(self, from_rel, to_rel):
1256
385
"""Rename one file.
1258
387
This can change the directory or the filename or both.
1262
tree = self.working_tree()
1263
inv = tree.inventory
1264
if not tree.has_filename(from_rel):
1265
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1266
if tree.has_filename(to_rel):
1267
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1269
file_id = inv.path2id(from_rel)
1271
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1273
if inv.path2id(to_rel):
1274
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1276
to_dir, to_tail = os.path.split(to_rel)
1277
to_dir_id = inv.path2id(to_dir)
1278
if to_dir_id == None and to_dir != '':
1279
raise BzrError("can't determine destination directory id for %r" % to_dir)
1281
mutter("rename_one:")
1282
mutter(" file_id {%s}" % file_id)
1283
mutter(" from_rel %r" % from_rel)
1284
mutter(" to_rel %r" % to_rel)
1285
mutter(" to_dir %r" % to_dir)
1286
mutter(" to_dir_id {%s}" % to_dir_id)
1288
inv.rename(file_id, to_dir_id, to_tail)
1290
from_abs = self.abspath(from_rel)
1291
to_abs = self.abspath(to_rel)
1293
os.rename(from_abs, to_abs)
1295
raise BzrError("failed to rename %r to %r: %s"
1296
% (from_abs, to_abs, e[1]),
1297
["rename rolled back"])
1299
self._write_inventory(inv)
389
raise NotImplementedError(self.rename_one)
1304
391
def move(self, from_paths, to_name):
1305
392
"""Rename files.
1502
466
if revno < 1 or revno > self.revno():
1503
467
raise InvalidRevisionNumber(revno)
1508
class ScratchBranch(Branch):
1509
"""Special test class: a branch that cleans up after itself.
1511
>>> b = ScratchBranch()
1519
def __init__(self, files=[], dirs=[], base=None):
1520
"""Make a test branch.
1522
This creates a temporary directory and runs init-tree in it.
1524
If any files are listed, they are created in the working copy.
1526
from tempfile import mkdtemp
1531
Branch.__init__(self, base, init=init)
1533
self._transport.mkdir(d)
1536
self._transport.put(f, 'content of %s' % f)
1541
>>> orig = ScratchBranch(files=["file1", "file2"])
1542
>>> clone = orig.clone()
1543
>>> os.path.samefile(orig.base, clone.base)
1545
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1548
from shutil import copytree
1549
from tempfile import mkdtemp
1552
copytree(self.base, base, symlinks=True)
1553
return ScratchBranch(base=base)
1561
"""Destroy the test branch, removing the scratch directory."""
1562
from shutil import rmtree
1565
mutter("delete ScratchBranch %s" % self.base)
1568
# Work around for shutil.rmtree failing on Windows when
1569
# readonly files are encountered
1570
mutter("hit exception in destroying ScratchBranch: %s" % e)
1571
for root, dirs, files in os.walk(self.base, topdown=False):
1573
os.chmod(os.path.join(root, name), 0700)
1575
self._transport = None
470
def clone(self, *args, **kwargs):
471
"""Clone this branch into to_bzrdir preserving all semantic values.
473
revision_id: if not None, the revision history in the new branch will
474
be truncated to end with revision_id.
476
# for API compatibility, until 0.8 releases we provide the old api:
477
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
478
# after 0.8 releases, the *args and **kwargs should be changed:
479
# def clone(self, to_bzrdir, revision_id=None):
480
if (kwargs.get('to_location', None) or
481
kwargs.get('revision', None) or
482
kwargs.get('basis_branch', None) or
483
(len(args) and isinstance(args[0], basestring))):
484
# backwards compatibility api:
485
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
486
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
489
basis_branch = args[2]
491
basis_branch = kwargs.get('basis_branch', None)
493
basis = basis_branch.bzrdir
498
revision_id = args[1]
500
revision_id = kwargs.get('revision', None)
505
# no default to raise if not provided.
506
url = kwargs.get('to_location')
507
return self.bzrdir.clone(url,
508
revision_id=revision_id,
509
basis=basis).open_branch()
511
# generate args by hand
513
revision_id = args[1]
515
revision_id = kwargs.get('revision_id', None)
519
# no default to raise if not provided.
520
to_bzrdir = kwargs.get('to_bzrdir')
521
result = self._format.initialize(to_bzrdir)
522
self.copy_content_into(result, revision_id=revision_id)
526
def sprout(self, to_bzrdir, revision_id=None):
527
"""Create a new line of development from the branch, into to_bzrdir.
529
revision_id: if not None, the revision history in the new branch will
530
be truncated to end with revision_id.
532
result = self._format.initialize(to_bzrdir)
533
self.copy_content_into(result, revision_id=revision_id)
534
result.set_parent(self.bzrdir.root_transport.base)
538
def copy_content_into(self, destination, revision_id=None):
539
"""Copy the content of self into destination.
541
revision_id: if not None, the revision history in the new branch will
542
be truncated to end with revision_id.
544
new_history = self.revision_history()
545
if revision_id is not None:
547
new_history = new_history[:new_history.index(revision_id) + 1]
549
rev = self.repository.get_revision(revision_id)
550
new_history = rev.get_history(self.repository)[1:]
551
destination.set_revision_history(new_history)
553
parent = self.get_parent()
554
except errors.InaccessibleParent, e:
555
mutter('parent was not accessible to copy: %s', e)
558
destination.set_parent(parent)
562
"""Check consistency of the branch.
564
In particular this checks that revisions given in the revision-history
565
do actually match up in the revision graph, and that they're all
566
present in the repository.
568
Callers will typically also want to check the repository.
570
:return: A BranchCheckResult.
572
mainline_parent_id = None
573
for revision_id in self.revision_history():
575
revision = self.repository.get_revision(revision_id)
576
except errors.NoSuchRevision, e:
577
raise errors.BzrCheckError("mainline revision {%s} not in repository"
579
# In general the first entry on the revision history has no parents.
580
# But it's not illegal for it to have parents listed; this can happen
581
# in imports from Arch when the parents weren't reachable.
582
if mainline_parent_id is not None:
583
if mainline_parent_id not in revision.parent_ids:
584
raise errors.BzrCheckError("previous revision {%s} not listed among "
586
% (mainline_parent_id, revision_id))
587
mainline_parent_id = revision_id
588
return BranchCheckResult(self)
590
def _get_checkout_format(self):
591
"""Return the most suitable metadir for a checkout of this branch.
592
Weaves are used if this branch's repostory uses weaves.
594
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
595
from bzrlib import repository
596
format = bzrdir.BzrDirMetaFormat1()
597
format.repository_format = repository.RepositoryFormat7()
599
format = self.repository.bzrdir.cloning_metadir()
602
def create_checkout(self, to_location, revision_id=None,
604
"""Create a checkout of a branch.
606
:param to_location: The url to produce the checkout at
607
:param revision_id: The revision to check out
608
:param lightweight: If True, produce a lightweight checkout, otherwise,
609
produce a bound branch (heavyweight checkout)
610
:return: The tree of the created checkout
612
t = transport.get_transport(to_location)
615
except errors.FileExists:
618
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
619
BranchReferenceFormat().initialize(checkout, self)
621
format = self._get_checkout_format()
622
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
623
to_location, force_new_tree=False, format=format)
624
checkout = checkout_branch.bzrdir
625
checkout_branch.bind(self)
626
# pull up to the specified revision_id to set the initial
627
# branch tip correctly, and seed it with history.
628
checkout_branch.pull(self, stop_revision=revision_id)
629
return checkout.create_workingtree(revision_id)
632
class BranchFormat(object):
633
"""An encapsulation of the initialization and open routines for a format.
635
Formats provide three things:
636
* An initialization routine,
640
Formats are placed in an dict by their format string for reference
641
during branch opening. Its not required that these be instances, they
642
can be classes themselves with class methods - it simply depends on
643
whether state is needed for a given format or not.
645
Once a format is deprecated, just deprecate the initialize and open
646
methods on the format class. Do not deprecate the object, as the
647
object will be created every time regardless.
650
_default_format = None
651
"""The default format used for new branches."""
654
"""The known formats."""
657
def find_format(klass, a_bzrdir):
658
"""Return the format for the branch object in a_bzrdir."""
660
transport = a_bzrdir.get_branch_transport(None)
661
format_string = transport.get("format").read()
662
return klass._formats[format_string]
664
raise NotBranchError(path=transport.base)
666
raise errors.UnknownFormatError(format=format_string)
669
def get_default_format(klass):
670
"""Return the current default format."""
671
return klass._default_format
673
def get_format_string(self):
674
"""Return the ASCII format string that identifies this format."""
675
raise NotImplementedError(self.get_format_string)
677
def get_format_description(self):
678
"""Return the short format description for this format."""
679
raise NotImplementedError(self.get_format_string)
681
def initialize(self, a_bzrdir):
682
"""Create a branch of this format in a_bzrdir."""
683
raise NotImplementedError(self.initialize)
685
def is_supported(self):
686
"""Is this format supported?
688
Supported formats can be initialized and opened.
689
Unsupported formats may not support initialization or committing or
690
some other features depending on the reason for not being supported.
694
def open(self, a_bzrdir, _found=False):
695
"""Return the branch object for a_bzrdir
697
_found is a private parameter, do not use it. It is used to indicate
698
if format probing has already be done.
700
raise NotImplementedError(self.open)
703
def register_format(klass, format):
704
klass._formats[format.get_format_string()] = format
707
def set_default_format(klass, format):
708
klass._default_format = format
711
def unregister_format(klass, format):
712
assert klass._formats[format.get_format_string()] is format
713
del klass._formats[format.get_format_string()]
716
return self.get_format_string().rstrip()
719
class BzrBranchFormat4(BranchFormat):
720
"""Bzr branch format 4.
723
- a revision-history file.
724
- a branch-lock lock file [ to be shared with the bzrdir ]
727
def get_format_description(self):
728
"""See BranchFormat.get_format_description()."""
729
return "Branch format 4"
731
def initialize(self, a_bzrdir):
732
"""Create a branch of this format in a_bzrdir."""
733
mutter('creating branch in %s', a_bzrdir.transport.base)
734
branch_transport = a_bzrdir.get_branch_transport(self)
735
utf8_files = [('revision-history', ''),
738
control_files = lockable_files.LockableFiles(branch_transport,
739
'branch-lock', lockable_files.TransportLock)
740
control_files.create_lock()
741
control_files.lock_write()
743
for file, content in utf8_files:
744
control_files.put_utf8(file, content)
746
control_files.unlock()
747
return self.open(a_bzrdir, _found=True)
750
super(BzrBranchFormat4, self).__init__()
751
self._matchingbzrdir = bzrdir.BzrDirFormat6()
753
def open(self, a_bzrdir, _found=False):
754
"""Return the branch object for a_bzrdir
756
_found is a private parameter, do not use it. It is used to indicate
757
if format probing has already be done.
760
# we are being called directly and must probe.
761
raise NotImplementedError
762
return BzrBranch(_format=self,
763
_control_files=a_bzrdir._control_files,
765
_repository=a_bzrdir.open_repository())
768
return "Bazaar-NG branch format 4"
771
class BzrBranchFormat5(BranchFormat):
772
"""Bzr branch format 5.
775
- a revision-history file.
777
- a lock dir guarding the branch itself
778
- all of this stored in a branch/ subdirectory
779
- works with shared repositories.
781
This format is new in bzr 0.8.
784
def get_format_string(self):
785
"""See BranchFormat.get_format_string()."""
786
return "Bazaar-NG branch format 5\n"
788
def get_format_description(self):
789
"""See BranchFormat.get_format_description()."""
790
return "Branch format 5"
792
def initialize(self, a_bzrdir):
793
"""Create a branch of this format in a_bzrdir."""
794
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
795
branch_transport = a_bzrdir.get_branch_transport(self)
796
utf8_files = [('revision-history', ''),
799
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
801
control_files.create_lock()
802
control_files.lock_write()
803
control_files.put_utf8('format', self.get_format_string())
805
for file, content in utf8_files:
806
control_files.put_utf8(file, content)
808
control_files.unlock()
809
return self.open(a_bzrdir, _found=True, )
812
super(BzrBranchFormat5, self).__init__()
813
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
815
def open(self, a_bzrdir, _found=False):
816
"""Return the branch object for a_bzrdir
818
_found is a private parameter, do not use it. It is used to indicate
819
if format probing has already be done.
822
format = BranchFormat.find_format(a_bzrdir)
823
assert format.__class__ == self.__class__
824
transport = a_bzrdir.get_branch_transport(None)
825
control_files = lockable_files.LockableFiles(transport, 'lock',
827
return BzrBranch5(_format=self,
828
_control_files=control_files,
830
_repository=a_bzrdir.find_repository())
833
return "Bazaar-NG Metadir branch format 5"
836
class BranchReferenceFormat(BranchFormat):
837
"""Bzr branch reference format.
839
Branch references are used in implementing checkouts, they
840
act as an alias to the real branch which is at some other url.
847
def get_format_string(self):
848
"""See BranchFormat.get_format_string()."""
849
return "Bazaar-NG Branch Reference Format 1\n"
851
def get_format_description(self):
852
"""See BranchFormat.get_format_description()."""
853
return "Checkout reference format 1"
855
def initialize(self, a_bzrdir, target_branch=None):
856
"""Create a branch of this format in a_bzrdir."""
857
if target_branch is None:
858
# this format does not implement branch itself, thus the implicit
859
# creation contract must see it as uninitializable
860
raise errors.UninitializableFormat(self)
861
mutter('creating branch reference in %s', a_bzrdir.transport.base)
862
branch_transport = a_bzrdir.get_branch_transport(self)
863
branch_transport.put_bytes('location',
864
target_branch.bzrdir.root_transport.base)
865
branch_transport.put_bytes('format', self.get_format_string())
866
return self.open(a_bzrdir, _found=True)
869
super(BranchReferenceFormat, self).__init__()
870
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
872
def _make_reference_clone_function(format, a_branch):
873
"""Create a clone() routine for a branch dynamically."""
874
def clone(to_bzrdir, revision_id=None):
875
"""See Branch.clone()."""
876
return format.initialize(to_bzrdir, a_branch)
877
# cannot obey revision_id limits when cloning a reference ...
878
# FIXME RBC 20060210 either nuke revision_id for clone, or
879
# emit some sort of warning/error to the caller ?!
882
def open(self, a_bzrdir, _found=False):
883
"""Return the branch that the branch reference in a_bzrdir points at.
885
_found is a private parameter, do not use it. It is used to indicate
886
if format probing has already be done.
889
format = BranchFormat.find_format(a_bzrdir)
890
assert format.__class__ == self.__class__
891
transport = a_bzrdir.get_branch_transport(None)
892
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
893
result = real_bzrdir.open_branch()
894
# this changes the behaviour of result.clone to create a new reference
895
# rather than a copy of the content of the branch.
896
# I did not use a proxy object because that needs much more extensive
897
# testing, and we are only changing one behaviour at the moment.
898
# If we decide to alter more behaviours - i.e. the implicit nickname
899
# then this should be refactored to introduce a tested proxy branch
900
# and a subclass of that for use in overriding clone() and ....
902
result.clone = self._make_reference_clone_function(result)
906
# formats which have no format string are not discoverable
907
# and not independently creatable, so are not registered.
908
__default_format = BzrBranchFormat5()
909
BranchFormat.register_format(__default_format)
910
BranchFormat.register_format(BranchReferenceFormat())
911
BranchFormat.set_default_format(__default_format)
912
_legacy_formats = [BzrBranchFormat4(),
915
class BzrBranch(Branch):
916
"""A branch stored in the actual filesystem.
918
Note that it's "local" in the context of the filesystem; it doesn't
919
really matter if it's on an nfs/smb/afs/coda/... share, as long as
920
it's writable, and can be accessed via the normal filesystem API.
923
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
924
relax_version_check=DEPRECATED_PARAMETER, _format=None,
925
_control_files=None, a_bzrdir=None, _repository=None):
926
"""Create new branch object at a particular location.
928
transport -- A Transport object, defining how to access files.
930
init -- If True, create new control files in a previously
931
unversioned directory. If False, the branch must already
934
relax_version_check -- If true, the usual check for the branch
935
version is not applied. This is intended only for
936
upgrade/recovery type use; it's not guaranteed that
937
all operations will work on old format branches.
940
self.bzrdir = bzrdir.BzrDir.open(transport.base)
942
self.bzrdir = a_bzrdir
943
self._transport = self.bzrdir.transport.clone('..')
944
self._base = self._transport.base
945
self._format = _format
946
if _control_files is None:
947
raise ValueError('BzrBranch _control_files is None')
948
self.control_files = _control_files
949
if deprecated_passed(init):
950
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
951
"deprecated as of bzr 0.8. Please use Branch.create().",
955
# this is slower than before deprecation, oh well never mind.
957
self._initialize(transport.base)
958
self._check_format(_format)
959
if deprecated_passed(relax_version_check):
960
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
961
"relax_version_check parameter is deprecated as of bzr 0.8. "
962
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
966
if (not relax_version_check
967
and not self._format.is_supported()):
968
raise errors.UnsupportedFormatError(format=fmt)
969
if deprecated_passed(transport):
970
warn("BzrBranch.__init__(transport=XXX...): The transport "
971
"parameter is deprecated as of bzr 0.8. "
972
"Please use Branch.open, or bzrdir.open_branch().",
975
self.repository = _repository
978
return '%s(%r)' % (self.__class__.__name__, self.base)
985
base = property(_get_base, doc="The URL for the root of this branch.")
987
def _finish_transaction(self):
988
"""Exit the current transaction."""
989
return self.control_files._finish_transaction()
991
def get_transaction(self):
992
"""Return the current active transaction.
994
If no transaction is active, this returns a passthrough object
995
for which all data is immediately flushed and no caching happens.
997
# this is an explicit function so that we can do tricky stuff
998
# when the storage in rev_storage is elsewhere.
999
# we probably need to hook the two 'lock a location' and
1000
# 'have a transaction' together more delicately, so that
1001
# we can have two locks (branch and storage) and one transaction
1002
# ... and finishing the transaction unlocks both, but unlocking
1003
# does not. - RBC 20051121
1004
return self.control_files.get_transaction()
1006
def _set_transaction(self, transaction):
1007
"""Set a new active transaction."""
1008
return self.control_files._set_transaction(transaction)
1010
def abspath(self, name):
1011
"""See Branch.abspath."""
1012
return self.control_files._transport.abspath(name)
1014
def _check_format(self, format):
1015
"""Identify the branch format if needed.
1017
The format is stored as a reference to the format object in
1018
self._format for code that needs to check it later.
1020
The format parameter is either None or the branch format class
1021
used to open this branch.
1023
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1026
format = BranchFormat.find_format(self.bzrdir)
1027
self._format = format
1028
mutter("got branch format %s", self._format)
1031
def get_root_id(self):
1032
"""See Branch.get_root_id."""
1033
tree = self.repository.revision_tree(self.last_revision())
1034
return tree.inventory.root.file_id
1036
def is_locked(self):
1037
return self.control_files.is_locked()
1039
def lock_write(self):
1040
self.repository.lock_write()
1042
self.control_files.lock_write()
1044
self.repository.unlock()
1047
def lock_read(self):
1048
self.repository.lock_read()
1050
self.control_files.lock_read()
1052
self.repository.unlock()
1056
# TODO: test for failed two phase locks. This is known broken.
1058
self.control_files.unlock()
1060
self.repository.unlock()
1062
def peek_lock_mode(self):
1063
if self.control_files._lock_count == 0:
1066
return self.control_files._lock_mode
1068
def get_physical_lock_status(self):
1069
return self.control_files.get_physical_lock_status()
1072
def print_file(self, file, revision_id):
1073
"""See Branch.print_file."""
1074
return self.repository.print_file(file, revision_id)
1077
def append_revision(self, *revision_ids):
1078
"""See Branch.append_revision."""
1079
for revision_id in revision_ids:
1080
_mod_revision.check_not_reserved_id(revision_id)
1081
mutter("add {%s} to revision-history" % revision_id)
1082
rev_history = self.revision_history()
1083
rev_history.extend(revision_ids)
1084
self.set_revision_history(rev_history)
1087
def set_revision_history(self, rev_history):
1088
"""See Branch.set_revision_history."""
1089
self.control_files.put_utf8(
1090
'revision-history', '\n'.join(rev_history))
1091
transaction = self.get_transaction()
1092
history = transaction.map.find_revision_history()
1093
if history is not None:
1094
# update the revision history in the identity map.
1095
history[:] = list(rev_history)
1096
# this call is disabled because revision_history is
1097
# not really an object yet, and the transaction is for objects.
1098
# transaction.register_dirty(history)
1100
transaction.map.add_revision_history(rev_history)
1101
# this call is disabled because revision_history is
1102
# not really an object yet, and the transaction is for objects.
1103
# transaction.register_clean(history)
1106
def revision_history(self):
1107
"""See Branch.revision_history."""
1108
transaction = self.get_transaction()
1109
history = transaction.map.find_revision_history()
1110
if history is not None:
1111
# mutter("cache hit for revision-history in %s", self)
1112
return list(history)
1113
decode_utf8 = cache_utf8.decode
1114
history = [decode_utf8(l.rstrip('\r\n')) for l in
1115
self.control_files.get('revision-history').readlines()]
1116
transaction.map.add_revision_history(history)
1117
# this call is disabled because revision_history is
1118
# not really an object yet, and the transaction is for objects.
1119
# transaction.register_clean(history, precious=True)
1120
return list(history)
1123
def generate_revision_history(self, revision_id, last_rev=None,
1125
"""Create a new revision history that will finish with revision_id.
1127
:param revision_id: the new tip to use.
1128
:param last_rev: The previous last_revision. If not None, then this
1129
must be a ancestory of revision_id, or DivergedBranches is raised.
1130
:param other_branch: The other branch that DivergedBranches should
1131
raise with respect to.
1133
# stop_revision must be a descendant of last_revision
1134
stop_graph = self.repository.get_revision_graph(revision_id)
1135
if last_rev is not None and last_rev not in stop_graph:
1136
# our previous tip is not merged into stop_revision
1137
raise errors.DivergedBranches(self, other_branch)
1138
# make a new revision history from the graph
1139
current_rev_id = revision_id
1141
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1142
new_history.append(current_rev_id)
1143
current_rev_id_parents = stop_graph[current_rev_id]
1145
current_rev_id = current_rev_id_parents[0]
1147
current_rev_id = None
1148
new_history.reverse()
1149
self.set_revision_history(new_history)
1152
def update_revisions(self, other, stop_revision=None):
1153
"""See Branch.update_revisions."""
1156
if stop_revision is None:
1157
stop_revision = other.last_revision()
1158
if stop_revision is None:
1159
# if there are no commits, we're done.
1161
# whats the current last revision, before we fetch [and change it
1163
last_rev = self.last_revision()
1164
# we fetch here regardless of whether we need to so that we pickup
1166
self.fetch(other, stop_revision)
1167
my_ancestry = self.repository.get_ancestry(last_rev)
1168
if stop_revision in my_ancestry:
1169
# last_revision is a descendant of stop_revision
1171
self.generate_revision_history(stop_revision, last_rev=last_rev,
1176
def basis_tree(self):
1177
"""See Branch.basis_tree."""
1178
return self.repository.revision_tree(self.last_revision())
1180
@deprecated_method(zero_eight)
1181
def working_tree(self):
1182
"""Create a Working tree object for this branch."""
1184
from bzrlib.transport.local import LocalTransport
1185
if (self.base.find('://') != -1 or
1186
not isinstance(self._transport, LocalTransport)):
1187
raise NoWorkingTree(self.base)
1188
return self.bzrdir.open_workingtree()
1191
def pull(self, source, overwrite=False, stop_revision=None):
1192
"""See Branch.pull."""
1195
old_count = len(self.revision_history())
1197
self.update_revisions(source, stop_revision)
1198
except DivergedBranches:
1202
self.set_revision_history(source.revision_history())
1203
new_count = len(self.revision_history())
1204
return new_count - old_count
1208
def get_parent(self):
1209
"""See Branch.get_parent."""
1211
_locs = ['parent', 'pull', 'x-pull']
1212
assert self.base[-1] == '/'
1215
parent = self.control_files.get(l).read().strip('\n')
1218
# This is an old-format absolute path to a local branch
1219
# turn it into a url
1220
if parent.startswith('/'):
1221
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1223
return urlutils.join(self.base[:-1], parent)
1224
except errors.InvalidURLJoin, e:
1225
raise errors.InaccessibleParent(parent, self.base)
1228
def get_push_location(self):
1229
"""See Branch.get_push_location."""
1230
push_loc = self.get_config().get_user_option('push_location')
1233
def set_push_location(self, location):
1234
"""See Branch.set_push_location."""
1235
self.get_config().set_user_option(
1236
'push_location', location,
1237
store=_mod_config.STORE_LOCATION_NORECURSE)
1240
def set_parent(self, url):
1241
"""See Branch.set_parent."""
1242
# TODO: Maybe delete old location files?
1243
# URLs should never be unicode, even on the local fs,
1244
# FIXUP this and get_parent in a future branch format bump:
1245
# read and rewrite the file, and have the new format code read
1246
# using .get not .get_utf8. RBC 20060125
1248
self.control_files._transport.delete('parent')
1250
if isinstance(url, unicode):
1252
url = url.encode('ascii')
1253
except UnicodeEncodeError:
1254
raise bzrlib.errors.InvalidURL(url,
1255
"Urls must be 7-bit ascii, "
1256
"use bzrlib.urlutils.escape")
1258
url = urlutils.relative_url(self.base, url)
1259
self.control_files.put('parent', StringIO(url + '\n'))
1261
@deprecated_function(zero_nine)
1262
def tree_config(self):
1263
"""DEPRECATED; call get_config instead.
1264
TreeConfig has become part of BranchConfig."""
1265
return TreeConfig(self)
1268
class BzrBranch5(BzrBranch):
1269
"""A format 5 branch. This supports new features over plan branches.
1271
It has support for a master_branch which is the data for bound branches.
1279
super(BzrBranch5, self).__init__(_format=_format,
1280
_control_files=_control_files,
1282
_repository=_repository)
1285
def pull(self, source, overwrite=False, stop_revision=None):
1286
"""Updates branch.pull to be bound branch aware."""
1287
bound_location = self.get_bound_location()
1288
if source.base != bound_location:
1289
# not pulling from master, so we need to update master.
1290
master_branch = self.get_master_branch()
1292
master_branch.pull(source)
1293
source = master_branch
1294
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1296
def get_bound_location(self):
1298
return self.control_files.get_utf8('bound').read()[:-1]
1299
except errors.NoSuchFile:
1303
def get_master_branch(self):
1304
"""Return the branch we are bound to.
1306
:return: Either a Branch, or None
1308
This could memoise the branch, but if thats done
1309
it must be revalidated on each new lock.
1310
So for now we just don't memoise it.
1311
# RBC 20060304 review this decision.
1313
bound_loc = self.get_bound_location()
1317
return Branch.open(bound_loc)
1318
except (errors.NotBranchError, errors.ConnectionError), e:
1319
raise errors.BoundBranchConnectionFailure(
1323
def set_bound_location(self, location):
1324
"""Set the target where this branch is bound to.
1326
:param location: URL to the target branch
1329
self.control_files.put_utf8('bound', location+'\n')
1332
self.control_files._transport.delete('bound')
1338
def bind(self, other):
1339
"""Bind this branch to the branch other.
1341
This does not push or pull data between the branches, though it does
1342
check for divergence to raise an error when the branches are not
1343
either the same, or one a prefix of the other. That behaviour may not
1344
be useful, so that check may be removed in future.
1346
:param other: The branch to bind to
1349
# TODO: jam 20051230 Consider checking if the target is bound
1350
# It is debatable whether you should be able to bind to
1351
# a branch which is itself bound.
1352
# Committing is obviously forbidden,
1353
# but binding itself may not be.
1354
# Since we *have* to check at commit time, we don't
1355
# *need* to check here
1357
# we want to raise diverged if:
1358
# last_rev is not in the other_last_rev history, AND
1359
# other_last_rev is not in our history, and do it without pulling
1361
last_rev = self.last_revision()
1362
if last_rev is not None:
1365
other_last_rev = other.last_revision()
1366
if other_last_rev is not None:
1367
# neither branch is new, we have to do some work to
1368
# ascertain diversion.
1369
remote_graph = other.repository.get_revision_graph(
1371
local_graph = self.repository.get_revision_graph(last_rev)
1372
if (last_rev not in remote_graph and
1373
other_last_rev not in local_graph):
1374
raise errors.DivergedBranches(self, other)
1377
self.set_bound_location(other.base)
1381
"""If bound, unbind"""
1382
return self.set_bound_location(None)
1386
"""Synchronise this branch with the master branch if any.
1388
:return: None or the last_revision that was pivoted out during the
1391
master = self.get_master_branch()
1392
if master is not None:
1393
old_tip = self.last_revision()
1394
self.pull(master, overwrite=True)
1395
if old_tip in self.repository.get_ancestry(self.last_revision()):
1401
class BranchTestProviderAdapter(object):
1402
"""A tool to generate a suite testing multiple branch formats at once.
1404
This is done by copying the test once for each transport and injecting
1405
the transport_server, transport_readonly_server, and branch_format
1406
classes into each copy. Each copy is also given a new id() to make it
1410
def __init__(self, transport_server, transport_readonly_server, formats):
1411
self._transport_server = transport_server
1412
self._transport_readonly_server = transport_readonly_server
1413
self._formats = formats
1415
def adapt(self, test):
1416
result = TestSuite()
1417
for branch_format, bzrdir_format in self._formats:
1418
new_test = deepcopy(test)
1419
new_test.transport_server = self._transport_server
1420
new_test.transport_readonly_server = self._transport_readonly_server
1421
new_test.bzrdir_format = bzrdir_format
1422
new_test.branch_format = branch_format
1423
def make_new_test_id():
1424
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1425
return lambda: new_id
1426
new_test.id = make_new_test_id()
1427
result.addTest(new_test)
1431
class BranchCheckResult(object):
1432
"""Results of checking branch consistency.
1437
def __init__(self, branch):
1438
self.branch = branch
1440
def report_results(self, verbose):
1441
"""Report the check results via trace.note.
1443
:param verbose: Requests more detailed display of what was checked,
1446
note('checked branch %s format %s',
1448
self.branch._format)
1579
1451
######################################################################
1583
def is_control_file(filename):
1584
## FIXME: better check
1585
filename = os.path.normpath(filename)
1586
while filename != '':
1587
head, tail = os.path.split(filename)
1588
## mutter('check %r for control file' % ((head, tail), ))
1589
if tail == bzrlib.BZRDIR:
1591
if filename == head:
1598
def gen_file_id(name):
1599
"""Return new file id.
1601
This should probably generate proper UUIDs, but for the moment we
1602
cope with just randomness because running uuidgen every time is
1605
from binascii import hexlify
1606
from time import time
1608
# get last component
1609
idx = name.rfind('/')
1611
name = name[idx+1 : ]
1612
idx = name.rfind('\\')
1614
name = name[idx+1 : ]
1616
# make it not a hidden file
1617
name = name.lstrip('.')
1619
# remove any wierd characters; we don't escape them but rather
1620
# just pull them out
1621
name = re.sub(r'[^\w.]', '', name)
1623
s = hexlify(rand_bytes(8))
1624
return '-'.join((name, compact_date(time()), s))
1628
"""Return a new tree-root file id."""
1629
return gen_file_id('TREE_ROOT')
1632
def copy_branch(branch_from, to_location, revision=None):
1633
"""Copy branch_from into the existing directory to_location.
1636
If not None, only revisions up to this point will be copied.
1637
The head of the new branch will be that revision.
1640
The name of a local directory that exists but is empty.
1642
from bzrlib.merge import merge
1644
assert isinstance(branch_from, Branch)
1645
assert isinstance(to_location, basestring)
1647
br_to = Branch(to_location, init=True)
1648
br_to.set_root_id(branch_from.get_root_id())
1649
if revision is None:
1650
revno = branch_from.revno()
1652
revno, rev_id = branch_from.get_revision_info(revision)
1653
br_to.update_revisions(branch_from, stop_revision=revno)
1654
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1655
check_clean=False, ignore_zero=True)
1656
br_to.set_parent(branch_from.base)
1659
def _trim_namespace(namespace, spec):
1660
full_namespace = namespace + ':'
1661
assert spec.startswith(full_namespace)
1662
return spec[len(full_namespace):]
1455
@deprecated_function(zero_eight)
1456
def is_control_file(*args, **kwargs):
1457
"""See bzrlib.workingtree.is_control_file."""
1458
from bzrlib import workingtree
1459
return workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
