84
144
"""Branch holding a history of revisions.
87
Base directory/url of the branch.
89
hooks: An instance of BranchHooks.
147
Base directory of the branch.
153
If _lock_mode is true, a positive count of the number of times the
157
Lock object from bzrlib.lock.
91
# this is really an instance variable - FIXME move it there
95
# override this to set the strategy for storing tags
97
return DisabledTags(self)
99
def __init__(self, *ignored, **ignored_too):
100
self.tags = self._make_tags()
101
self._revision_history_cache = None
102
self._revision_id_to_revno_cache = None
104
def break_lock(self):
105
"""Break a lock if one is present from another instance.
107
Uses the ui factory to ask for confirmation if the lock may be from
110
This will probe the repository for its lock as well.
112
self.control_files.break_lock()
113
self.repository.break_lock()
114
master = self.get_master_branch()
115
if master is not None:
119
@deprecated_method(zero_eight)
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
126
"""Open the branch rooted at base.
128
For instance, if the branch is at URL/.bzr/branch,
129
Branch.open(URL) -> a Branch instance.
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_from_transport(transport, _unsupported=False):
136
"""Open the branch rooted at transport"""
137
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
138
return control.open_branch(_unsupported)
141
def open_containing(url, possible_transports=None):
142
"""Open an existing branch which contains url.
144
This probes for a branch at url, and searches upwards from there.
146
Basically we keep looking up until we find the control directory or
147
run into the root. If there isn't one, raises NotBranchError.
148
If there is one and it is either an unrecognised format or an unsupported
149
format, UnknownFormatError or UnsupportedFormatError are raised.
150
If there is one, it is returned, along with the unused portion of url.
152
control, relpath = bzrdir.BzrDir.open_containing(url,
154
return control.open_branch(), relpath
157
@deprecated_function(zero_eight)
158
def initialize(base):
159
"""Create a new working tree and branch, rooted at 'base' (url)
161
NOTE: This will soon be deprecated in favour of creation
164
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
166
@deprecated_function(zero_eight)
167
def setup_caching(self, cache_root):
168
"""Subclasses that care about caching should override this, and set
169
up cached stores located under cache_root.
171
NOTE: This is unused.
175
def get_config(self):
176
return BranchConfig(self)
179
return self.get_config().get_nickname()
181
def _set_nick(self, nick):
182
self.get_config().set_user_option('nickname', nick, warn_masked=True)
184
nick = property(_get_nick, _set_nick)
187
raise NotImplementedError(self.is_locked)
164
# Map some sort of prefix into a namespace
165
# stuff like "revno:10", "revid:", etc.
166
# This should match a prefix with a function which accepts
167
REVISION_NAMESPACES = {}
169
def __init__(self, base, init=False, find_root=True):
170
"""Create new branch object at a particular location.
172
base -- Base directory for the branch.
174
init -- If True, create new control files in a previously
175
unversioned directory. If False, the branch must already
178
find_root -- If true and init is false, find the root of the
179
existing branch containing base.
181
In the test suite, creation of new trees is tested using the
182
`ScratchBranch` class.
184
from bzrlib.store import ImmutableStore
186
self.base = os.path.realpath(base)
189
self.base = find_branch_root(base)
191
self.base = os.path.realpath(base)
192
if not isdir(self.controlfilename('.')):
193
from errors import NotBranchError
194
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
195
['use "bzr init" to initialize a new working tree',
196
'current bzr can only operate from top-of-tree'])
199
self.text_store = ImmutableStore(self.controlfilename('text-store'))
200
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
201
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
205
return '%s(%r)' % (self.__class__.__name__, self.base)
212
if self._lock_mode or self._lock:
213
from warnings import warn
214
warn("branch %r was not explicitly unlocked" % self)
189
219
def lock_write(self):
190
raise NotImplementedError(self.lock_write)
221
if self._lock_mode != 'w':
222
from errors import LockError
223
raise LockError("can't upgrade to a write lock from %r" %
225
self._lock_count += 1
227
from bzrlib.lock import WriteLock
229
self._lock = WriteLock(self.controlfilename('branch-lock'))
230
self._lock_mode = 'w'
192
235
def lock_read(self):
193
raise NotImplementedError(self.lock_read)
237
assert self._lock_mode in ('r', 'w'), \
238
"invalid lock mode %r" % self._lock_mode
239
self._lock_count += 1
241
from bzrlib.lock import ReadLock
243
self._lock = ReadLock(self.controlfilename('branch-lock'))
244
self._lock_mode = 'r'
195
249
def unlock(self):
196
raise NotImplementedError(self.unlock)
198
def peek_lock_mode(self):
199
"""Return lock mode for the Branch: 'r', 'w' or None"""
200
raise NotImplementedError(self.peek_lock_mode)
202
def get_physical_lock_status(self):
203
raise NotImplementedError(self.get_physical_lock_status)
206
def get_revision_id_to_revno_map(self):
207
"""Return the revision_id => dotted revno map.
209
This will be regenerated on demand, but will be cached.
211
:return: A dictionary mapping revision_id => dotted revno.
212
This dictionary should not be modified by the caller.
214
if self._revision_id_to_revno_cache is not None:
215
mapping = self._revision_id_to_revno_cache
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
217
mapping = self._gen_revno_map()
218
self._cache_revision_id_to_revno(mapping)
219
# TODO: jam 20070417 Since this is being cached, should we be returning
221
# I would rather not, and instead just declare that users should not
222
# modify the return value.
225
def _gen_revno_map(self):
226
"""Create a new mapping from revision ids to dotted revnos.
228
Dotted revnos are generated based on the current tip in the revision
230
This is the worker function for get_revision_id_to_revno_map, which
231
just caches the return value.
233
:return: A dictionary mapping revision_id => dotted revno.
235
last_revision = self.last_revision()
236
revision_graph = self.repository.get_revision_graph(last_revision)
237
merge_sorted_revisions = tsort.merge_sort(
242
revision_id_to_revno = dict((rev_id, revno)
243
for seq_num, rev_id, depth, revno, end_of_merge
244
in merge_sorted_revisions)
245
return revision_id_to_revno
247
def leave_lock_in_place(self):
248
"""Tell this branch object not to release the physical lock when this
251
If lock_write doesn't return a token, then this method is not supported.
253
self.control_files.leave_in_place()
255
def dont_leave_lock_in_place(self):
256
"""Tell this branch object to release the physical lock when this
257
object is unlocked, even if it didn't originally acquire it.
259
If lock_write doesn't return a token, then this method is not supported.
261
self.control_files.dont_leave_in_place()
259
self._lock_mode = self._lock_count = None
263
262
def abspath(self, name):
264
"""Return absolute filename for something in the branch
266
XXX: Robert Collins 20051017 what is this used for? why is it a branch
267
method and not a tree method.
269
raise NotImplementedError(self.abspath)
271
def bind(self, other):
272
"""Bind the local branch the other branch.
274
:param other: The branch to bind to
277
raise errors.UpgradeRequired(self.base)
280
def fetch(self, from_branch, last_revision=None, pb=None):
281
"""Copy revisions from from_branch into this branch.
283
:param from_branch: Where to copy from.
284
:param last_revision: What revision to stop at (None for at the end
286
:param pb: An optional progress bar to use.
288
Returns the copied revision count and the failed revisions in a tuple:
291
if self.base == from_branch.base:
294
nested_pb = ui.ui_factory.nested_progress_bar()
299
from_branch.lock_read()
301
if last_revision is None:
302
pb.update('get source history')
303
last_revision = from_branch.last_revision()
304
if last_revision is None:
305
last_revision = _mod_revision.NULL_REVISION
306
return self.repository.fetch(from_branch.repository,
307
revision_id=last_revision,
310
if nested_pb is not None:
314
def get_bound_location(self):
315
"""Return the URL of the branch we are bound to.
317
Older format branches cannot bind, please be sure to use a metadir
322
def get_old_bound_location(self):
323
"""Return the URL of the branch we used to be bound to
325
raise errors.UpgradeRequired(self.base)
327
def get_commit_builder(self, parents, config=None, timestamp=None,
328
timezone=None, committer=None, revprops=None,
330
"""Obtain a CommitBuilder for this branch.
332
:param parents: Revision ids of the parents of the new revision.
333
:param config: Optional configuration to use.
334
:param timestamp: Optional timestamp recorded for commit.
335
:param timezone: Optional timezone for timestamp.
336
:param committer: Optional committer to set for commit.
337
:param revprops: Optional dictionary of revision properties.
338
:param revision_id: Optional revision id.
342
config = self.get_config()
344
return self.repository.get_commit_builder(self, parents, config,
345
timestamp, timezone, committer, revprops, revision_id)
347
def get_master_branch(self):
348
"""Return the branch we are bound to.
350
:return: Either a Branch, or None
263
"""Return absolute filename for something in the branch"""
264
return os.path.join(self.base, name)
267
def relpath(self, path):
268
"""Return path relative to this branch of something inside it.
270
Raises an error if path is not in this branch."""
271
return _relpath(self.base, path)
274
def controlfilename(self, file_or_path):
275
"""Return location relative to branch."""
276
if isinstance(file_or_path, basestring):
277
file_or_path = [file_or_path]
278
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
281
def controlfile(self, file_or_path, mode='r'):
282
"""Open a control file for this branch.
284
There are two classes of file in the control directory: text
285
and binary. binary files are untranslated byte streams. Text
286
control files are stored with Unix newlines and in UTF-8, even
287
if the platform or locale defaults are different.
289
Controlfiles should almost never be opened in write mode but
290
rather should be atomically copied and replaced using atomicfile.
293
fn = self.controlfilename(file_or_path)
295
if mode == 'rb' or mode == 'wb':
296
return file(fn, mode)
297
elif mode == 'r' or mode == 'w':
298
# open in binary mode anyhow so there's no newline translation;
299
# codecs uses line buffering by default; don't want that.
301
return codecs.open(fn, mode + 'b', 'utf-8',
304
raise BzrError("invalid controlfile mode %r" % mode)
308
def _make_control(self):
309
from bzrlib.inventory import Inventory
310
from bzrlib.xml import pack_xml
312
os.mkdir(self.controlfilename([]))
313
self.controlfile('README', 'w').write(
314
"This is a Bazaar-NG control directory.\n"
315
"Do not change any files in this directory.\n")
316
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
317
for d in ('text-store', 'inventory-store', 'revision-store'):
318
os.mkdir(self.controlfilename(d))
319
for f in ('revision-history', 'merged-patches',
320
'pending-merged-patches', 'branch-name',
323
self.controlfile(f, 'w').write('')
324
mutter('created control directory in ' + self.base)
326
# if we want per-tree root ids then this is the place to set
327
# them; they're not needed for now and so ommitted for
329
pack_xml(Inventory(), self.controlfile('inventory','w'))
332
def _check_format(self):
333
"""Check this branch format is supported.
335
The current tool only supports the current unstable format.
337
In the future, we might need different in-memory Branch
338
classes to support downlevel branches. But not yet.
340
# This ignores newlines so that we can open branches created
341
# on Windows from Linux and so on. I think it might be better
342
# to always make all internal files in unix format.
343
fmt = self.controlfile('branch-format', 'r').read()
344
fmt.replace('\r\n', '')
345
if fmt != BZR_BRANCH_FORMAT:
346
raise BzrError('sorry, branch format %r not supported' % fmt,
347
['use a different bzr version',
348
'or remove the .bzr directory and "bzr init" again'])
350
def get_root_id(self):
351
"""Return the id of this branches root"""
352
inv = self.read_working_inventory()
353
return inv.root.file_id
355
def set_root_id(self, file_id):
356
inv = self.read_working_inventory()
357
orig_root_id = inv.root.file_id
358
del inv._byid[inv.root.file_id]
359
inv.root.file_id = file_id
360
inv._byid[inv.root.file_id] = inv.root
363
if entry.parent_id in (None, orig_root_id):
364
entry.parent_id = inv.root.file_id
365
self._write_inventory(inv)
367
def read_working_inventory(self):
368
"""Read the working inventory."""
369
from bzrlib.inventory import Inventory
370
from bzrlib.xml import unpack_xml
371
from time import time
375
# ElementTree does its own conversion from UTF-8, so open in
377
inv = unpack_xml(Inventory,
378
self.controlfile('inventory', 'rb'))
379
mutter("loaded inventory of %d items in %f"
380
% (len(inv), time() - before))
386
def _write_inventory(self, inv):
387
"""Update the working inventory.
389
That is to say, the inventory describing changes underway, that
390
will be committed to the next revision.
392
from bzrlib.atomicfile import AtomicFile
393
from bzrlib.xml import pack_xml
397
f = AtomicFile(self.controlfilename('inventory'), 'wb')
406
mutter('wrote working inventory')
409
inventory = property(read_working_inventory, _write_inventory, None,
410
"""Inventory for the working copy.""")
413
def add(self, files, verbose=False, ids=None):
414
"""Make files versioned.
416
Note that the command line normally calls smart_add instead.
418
This puts the files in the Added state, so that they will be
419
recorded by the next commit.
422
List of paths to add, relative to the base of the tree.
425
If set, use these instead of automatically generated ids.
426
Must be the same length as the list of files, but may
427
contain None for ids that are to be autogenerated.
429
TODO: Perhaps have an option to add the ids even if the files do
432
TODO: Perhaps return the ids of the files? But then again it
433
is easy to retrieve them if they're needed.
435
TODO: Adding a directory should optionally recurse down and
436
add all non-ignored children. Perhaps do that in a
439
# TODO: Re-adding a file that is removed in the working copy
440
# should probably put it back with the previous ID.
441
if isinstance(files, basestring):
442
assert(ids is None or isinstance(ids, basestring))
448
ids = [None] * len(files)
450
assert(len(ids) == len(files))
454
inv = self.read_working_inventory()
455
for f,file_id in zip(files, ids):
456
if is_control_file(f):
457
raise BzrError("cannot add control file %s" % quotefn(f))
462
raise BzrError("cannot add top-level %r" % f)
464
fullpath = os.path.normpath(self.abspath(f))
467
kind = file_kind(fullpath)
469
# maybe something better?
470
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
472
if kind != 'file' and kind != 'directory':
473
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
476
file_id = gen_file_id(f)
477
inv.add_path(f, kind=kind, file_id=file_id)
480
print 'added', quotefn(f)
482
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
484
self._write_inventory(inv)
489
def print_file(self, file, revno):
490
"""Print `file` to stdout."""
493
tree = self.revision_tree(self.lookup_revision(revno))
494
# use inventory as it was in that revision
495
file_id = tree.inventory.path2id(file)
497
raise BzrError("%r is not present in revision %s" % (file, revno))
498
tree.print_file(file_id)
503
def remove(self, files, verbose=False):
504
"""Mark nominated files for removal from the inventory.
506
This does not remove their text. This does not run on
508
TODO: Refuse to remove modified files unless --force is given?
510
TODO: Do something useful with directories.
512
TODO: Should this remove the text or not? Tough call; not
513
removing may be useful and the user can just use use rm, and
514
is the opposite of add. Removing it is consistent with most
515
other tools. Maybe an option.
517
## TODO: Normalize names
518
## TODO: Remove nested loops; better scalability
519
if isinstance(files, basestring):
525
tree = self.working_tree()
528
# do this before any modifications
532
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
533
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
535
# having remove it, it must be either ignored or unknown
536
if tree.is_ignored(f):
540
show_status(new_status, inv[fid].kind, quotefn(f))
543
self._write_inventory(inv)
548
# FIXME: this doesn't need to be a branch method
549
def set_inventory(self, new_inventory_list):
550
from bzrlib.inventory import Inventory, InventoryEntry
551
inv = Inventory(self.get_root_id())
552
for path, file_id, parent, kind in new_inventory_list:
553
name = os.path.basename(path)
556
inv.add(InventoryEntry(file_id, name, kind, parent))
557
self._write_inventory(inv)
561
"""Return all unknown files.
563
These are files in the working directory that are not versioned or
564
control files or ignored.
566
>>> b = ScratchBranch(files=['foo', 'foo~'])
567
>>> list(b.unknowns())
570
>>> list(b.unknowns())
573
>>> list(b.unknowns())
576
return self.working_tree().unknowns()
579
def append_revision(self, *revision_ids):
580
from bzrlib.atomicfile import AtomicFile
582
for revision_id in revision_ids:
583
mutter("add {%s} to revision-history" % revision_id)
585
rev_history = self.revision_history()
586
rev_history.extend(revision_ids)
588
f = AtomicFile(self.controlfilename('revision-history'))
590
for rev_id in rev_history:
597
def get_revision_xml(self, revision_id):
598
"""Return XML file object for revision object."""
599
if not revision_id or not isinstance(revision_id, basestring):
600
raise InvalidRevisionId(revision_id)
605
return self.revision_store[revision_id]
607
raise bzrlib.errors.NoSuchRevision(self, revision_id)
612
def get_revision(self, revision_id):
613
"""Return the Revision object for a named revision"""
614
xml_file = self.get_revision_xml(revision_id)
617
r = unpack_xml(Revision, xml_file)
618
except SyntaxError, e:
619
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
623
assert r.revision_id == revision_id
354
627
def get_revision_delta(self, revno):
355
628
"""Return the delta for one revision.
496
809
if stop_revision is None:
497
810
stop_revision = other_len
499
assert isinstance(stop_revision, int)
500
if stop_revision > other_len:
501
raise errors.NoSuchRevision(self, stop_revision)
811
elif stop_revision > other_len:
812
raise NoSuchRevision(self, stop_revision)
502
814
return other_history[self_len:stop_revision]
504
817
def update_revisions(self, other, stop_revision=None):
505
"""Pull in new perfect-fit revisions.
507
:param other: Another Branch to pull from
508
:param stop_revision: Updated until the given revision
511
raise NotImplementedError(self.update_revisions)
513
def revision_id_to_revno(self, revision_id):
514
"""Given a revision id, return its revno"""
515
if _mod_revision.is_null(revision_id):
517
revision_id = osutils.safe_revision_id(revision_id)
518
history = self.revision_history()
520
return history.index(revision_id) + 1
522
raise errors.NoSuchRevision(self, revision_id)
524
def get_rev_id(self, revno, history=None):
525
"""Find the revision id of the specified revno."""
529
history = self.revision_history()
530
if revno <= 0 or revno > len(history):
531
raise errors.NoSuchRevision(self, revno)
532
return history[revno - 1]
534
def pull(self, source, overwrite=False, stop_revision=None):
535
"""Mirror source into this branch.
537
This branch is considered to be 'local', having low latency.
539
:returns: PullResult instance
541
raise NotImplementedError(self.pull)
543
def push(self, target, overwrite=False, stop_revision=None):
544
"""Mirror this branch into target.
546
This branch is considered to be 'local', having low latency.
548
raise NotImplementedError(self.push)
818
"""Pull in all new revisions from other branch.
820
>>> from bzrlib.commit import commit
821
>>> bzrlib.trace.silent = True
822
>>> br1 = ScratchBranch(files=['foo', 'bar'])
825
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
826
>>> br2 = ScratchBranch()
827
>>> br2.update_revisions(br1)
831
>>> br2.revision_history()
833
>>> br2.update_revisions(br1)
837
>>> br1.text_store.total_size() == br2.text_store.total_size()
840
from bzrlib.progress import ProgressBar
844
pb.update('comparing histories')
845
revision_ids = self.missing_revisions(other, stop_revision)
847
if hasattr(other.revision_store, "prefetch"):
848
other.revision_store.prefetch(revision_ids)
849
if hasattr(other.inventory_store, "prefetch"):
850
inventory_ids = [other.get_revision(r).inventory_id
851
for r in revision_ids]
852
other.inventory_store.prefetch(inventory_ids)
857
for rev_id in revision_ids:
859
pb.update('fetching revision', i, len(revision_ids))
860
rev = other.get_revision(rev_id)
861
revisions.append(rev)
862
inv = other.get_inventory(str(rev.inventory_id))
863
for key, entry in inv.iter_entries():
864
if entry.text_id is None:
866
if entry.text_id not in self.text_store:
867
needed_texts.add(entry.text_id)
871
count = self.text_store.copy_multi(other.text_store, needed_texts)
872
print "Added %d texts." % count
873
inventory_ids = [ f.inventory_id for f in revisions ]
874
count = self.inventory_store.copy_multi(other.inventory_store,
876
print "Added %d inventories." % count
877
revision_ids = [ f.revision_id for f in revisions]
878
count = self.revision_store.copy_multi(other.revision_store,
880
for revision_id in revision_ids:
881
self.append_revision(revision_id)
882
print "Added %d revisions." % count
885
def commit(self, *args, **kw):
886
from bzrlib.commit import commit
887
commit(self, *args, **kw)
890
def lookup_revision(self, revision):
891
"""Return the revision identifier for a given revision information."""
892
revno, info = self.get_revision_info(revision)
895
def get_revision_info(self, revision):
896
"""Return (revno, revision id) for revision identifier.
898
revision can be an integer, in which case it is assumed to be revno (though
899
this will translate negative values into positive ones)
900
revision can also be a string, in which case it is parsed for something like
901
'date:' or 'revid:' etc.
906
try:# Convert to int if possible
907
revision = int(revision)
910
revs = self.revision_history()
911
if isinstance(revision, int):
914
# Mabye we should do this first, but we don't need it if revision == 0
916
revno = len(revs) + revision + 1
919
elif isinstance(revision, basestring):
920
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
921
if revision.startswith(prefix):
922
revno = func(self, revs, revision)
925
raise BzrError('No namespace registered for string: %r' % revision)
927
if revno is None or revno <= 0 or revno > len(revs):
928
raise BzrError("no such revision %s" % revision)
929
return revno, revs[revno-1]
931
def _namespace_revno(self, revs, revision):
932
"""Lookup a revision by revision number"""
933
assert revision.startswith('revno:')
935
return int(revision[6:])
938
REVISION_NAMESPACES['revno:'] = _namespace_revno
940
def _namespace_revid(self, revs, revision):
941
assert revision.startswith('revid:')
943
return revs.index(revision[6:]) + 1
946
REVISION_NAMESPACES['revid:'] = _namespace_revid
948
def _namespace_last(self, revs, revision):
949
assert revision.startswith('last:')
951
offset = int(revision[5:])
956
raise BzrError('You must supply a positive value for --revision last:XXX')
957
return len(revs) - offset + 1
958
REVISION_NAMESPACES['last:'] = _namespace_last
960
def _namespace_tag(self, revs, revision):
961
assert revision.startswith('tag:')
962
raise BzrError('tag: namespace registered, but not implemented.')
963
REVISION_NAMESPACES['tag:'] = _namespace_tag
965
def _namespace_date(self, revs, revision):
966
assert revision.startswith('date:')
968
# Spec for date revisions:
970
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
971
# it can also start with a '+/-/='. '+' says match the first
972
# entry after the given date. '-' is match the first entry before the date
973
# '=' is match the first entry after, but still on the given date.
975
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
976
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
977
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
978
# May 13th, 2005 at 0:00
980
# So the proper way of saying 'give me all entries for today' is:
981
# -r {date:+today}:{date:-tomorrow}
982
# The default is '=' when not supplied
985
if val[:1] in ('+', '-', '='):
986
match_style = val[:1]
989
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
990
if val.lower() == 'yesterday':
991
dt = today - datetime.timedelta(days=1)
992
elif val.lower() == 'today':
994
elif val.lower() == 'tomorrow':
995
dt = today + datetime.timedelta(days=1)
998
# This should be done outside the function to avoid recompiling it.
999
_date_re = re.compile(
1000
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1002
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1004
m = _date_re.match(val)
1005
if not m or (not m.group('date') and not m.group('time')):
1006
raise BzrError('Invalid revision date %r' % revision)
1009
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1011
year, month, day = today.year, today.month, today.day
1013
hour = int(m.group('hour'))
1014
minute = int(m.group('minute'))
1015
if m.group('second'):
1016
second = int(m.group('second'))
1020
hour, minute, second = 0,0,0
1022
dt = datetime.datetime(year=year, month=month, day=day,
1023
hour=hour, minute=minute, second=second)
1027
if match_style == '-':
1029
elif match_style == '=':
1030
last = dt + datetime.timedelta(days=1)
1033
for i in range(len(revs)-1, -1, -1):
1034
r = self.get_revision(revs[i])
1035
# TODO: Handle timezone.
1036
dt = datetime.datetime.fromtimestamp(r.timestamp)
1037
if first >= dt and (last is None or dt >= last):
1040
for i in range(len(revs)):
1041
r = self.get_revision(revs[i])
1042
# TODO: Handle timezone.
1043
dt = datetime.datetime.fromtimestamp(r.timestamp)
1044
if first <= dt and (last is None or dt <= last):
1046
REVISION_NAMESPACES['date:'] = _namespace_date
1048
def revision_tree(self, revision_id):
1049
"""Return Tree for a revision on this branch.
1051
`revision_id` may be None for the null revision, in which case
1052
an `EmptyTree` is returned."""
1053
# TODO: refactor this to use an existing revision object
1054
# so we don't need to read it in twice.
1055
if revision_id == None:
1058
inv = self.get_revision_inventory(revision_id)
1059
return RevisionTree(self.text_store, inv)
1062
def working_tree(self):
1063
"""Return a `Tree` for the working copy."""
1064
from workingtree import WorkingTree
1065
return WorkingTree(self.base, self.read_working_inventory())
550
1068
def basis_tree(self):
551
"""Return `Tree` object for last revision."""
552
return self.repository.revision_tree(self.last_revision())
1069
"""Return `Tree` object for last revision.
1071
If there are no revisions yet, return an `EmptyTree`.
1073
r = self.last_patch()
1077
return RevisionTree(self.text_store, self.get_revision_inventory(r))
554
1081
def rename_one(self, from_rel, to_rel):
555
1082
"""Rename one file.
557
1084
This can change the directory or the filename or both.
559
raise NotImplementedError(self.rename_one)
1088
tree = self.working_tree()
1089
inv = tree.inventory
1090
if not tree.has_filename(from_rel):
1091
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1092
if tree.has_filename(to_rel):
1093
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1095
file_id = inv.path2id(from_rel)
1097
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1099
if inv.path2id(to_rel):
1100
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1102
to_dir, to_tail = os.path.split(to_rel)
1103
to_dir_id = inv.path2id(to_dir)
1104
if to_dir_id == None and to_dir != '':
1105
raise BzrError("can't determine destination directory id for %r" % to_dir)
1107
mutter("rename_one:")
1108
mutter(" file_id {%s}" % file_id)
1109
mutter(" from_rel %r" % from_rel)
1110
mutter(" to_rel %r" % to_rel)
1111
mutter(" to_dir %r" % to_dir)
1112
mutter(" to_dir_id {%s}" % to_dir_id)
1114
inv.rename(file_id, to_dir_id, to_tail)
1116
print "%s => %s" % (from_rel, to_rel)
1118
from_abs = self.abspath(from_rel)
1119
to_abs = self.abspath(to_rel)
1121
os.rename(from_abs, to_abs)
1123
raise BzrError("failed to rename %r to %r: %s"
1124
% (from_abs, to_abs, e[1]),
1125
["rename rolled back"])
1127
self._write_inventory(inv)
561
1132
def move(self, from_paths, to_name):
562
1133
"""Rename files.
569
1140
Note that to_name is only the last component of the new name;
570
1141
this doesn't change the directory.
572
This returns a list of (from_path, to_path) pairs for each
575
raise NotImplementedError(self.move)
577
def get_parent(self):
578
"""Return the parent location of the branch.
580
This is the default location for push/pull/missing. The usual
581
pattern is that the user can override it by specifying a
584
raise NotImplementedError(self.get_parent)
586
def _set_config_location(self, name, url, config=None,
587
make_relative=False):
589
config = self.get_config()
593
url = urlutils.relative_url(self.base, url)
594
config.set_user_option(name, url, warn_masked=True)
596
def _get_config_location(self, name, config=None):
598
config = self.get_config()
599
location = config.get_user_option(name)
604
def get_submit_branch(self):
605
"""Return the submit location of the branch.
607
This is the default location for bundle. The usual
608
pattern is that the user can override it by specifying a
611
return self.get_config().get_user_option('submit_branch')
613
def set_submit_branch(self, location):
614
"""Return the submit location of the branch.
616
This is the default location for bundle. The usual
617
pattern is that the user can override it by specifying a
620
self.get_config().set_user_option('submit_branch', location,
623
def get_public_branch(self):
624
"""Return the public location of the branch.
626
This is is used by merge directives.
628
return self._get_config_location('public_branch')
630
def set_public_branch(self, location):
631
"""Return the submit location of the branch.
633
This is the default location for bundle. The usual
634
pattern is that the user can override it by specifying a
637
self._set_config_location('public_branch', location)
639
def get_push_location(self):
640
"""Return the None or the location to push this branch to."""
641
push_loc = self.get_config().get_user_option('push_location')
644
def set_push_location(self, location):
645
"""Set a new push location for this branch."""
646
raise NotImplementedError(self.set_push_location)
648
def set_parent(self, url):
649
raise NotImplementedError(self.set_parent)
653
"""Synchronise this branch with the master branch if any.
655
:return: None or the last_revision pivoted out during the update.
659
def check_revno(self, revno):
661
Check whether a revno corresponds to any revision.
662
Zero (the NULL revision) is considered valid.
665
self.check_real_revno(revno)
667
def check_real_revno(self, revno):
669
Check whether a revno corresponds to a real revision.
670
Zero (the NULL revision) is considered invalid
672
if revno < 1 or revno > self.revno():
673
raise InvalidRevisionNumber(revno)
676
def clone(self, to_bzrdir, revision_id=None):
677
"""Clone this branch into to_bzrdir preserving all semantic values.
679
revision_id: if not None, the revision history in the new branch will
680
be truncated to end with revision_id.
682
result = self._format.initialize(to_bzrdir)
683
self.copy_content_into(result, revision_id=revision_id)
687
def sprout(self, to_bzrdir, revision_id=None):
688
"""Create a new line of development from the branch, into to_bzrdir.
690
revision_id: if not None, the revision history in the new branch will
691
be truncated to end with revision_id.
693
result = self._format.initialize(to_bzrdir)
694
self.copy_content_into(result, revision_id=revision_id)
695
result.set_parent(self.bzrdir.root_transport.base)
698
def _synchronize_history(self, destination, revision_id):
699
"""Synchronize last revision and revision history between branches.
701
This version is most efficient when the destination is also a
702
BzrBranch5, but works for BzrBranch6 as long as the revision
703
history is the true lefthand parent history, and all of the revisions
704
are in the destination's repository. If not, set_revision_history
707
:param destination: The branch to copy the history into
708
:param revision_id: The revision-id to truncate history at. May
709
be None to copy complete history.
711
if revision_id == _mod_revision.NULL_REVISION:
713
new_history = self.revision_history()
714
if revision_id is not None and new_history != []:
715
revision_id = osutils.safe_revision_id(revision_id)
717
new_history = new_history[:new_history.index(revision_id) + 1]
719
rev = self.repository.get_revision(revision_id)
720
new_history = rev.get_history(self.repository)[1:]
721
destination.set_revision_history(new_history)
724
def copy_content_into(self, destination, revision_id=None):
725
"""Copy the content of self into destination.
727
revision_id: if not None, the revision history in the new branch will
728
be truncated to end with revision_id.
730
self._synchronize_history(destination, revision_id)
732
parent = self.get_parent()
733
except errors.InaccessibleParent, e:
734
mutter('parent was not accessible to copy: %s', e)
737
destination.set_parent(parent)
738
self.tags.merge_to(destination.tags)
742
"""Check consistency of the branch.
744
In particular this checks that revisions given in the revision-history
745
do actually match up in the revision graph, and that they're all
746
present in the repository.
748
Callers will typically also want to check the repository.
750
:return: A BranchCheckResult.
752
mainline_parent_id = None
753
for revision_id in self.revision_history():
755
revision = self.repository.get_revision(revision_id)
756
except errors.NoSuchRevision, e:
757
raise errors.BzrCheckError("mainline revision {%s} not in repository"
759
# In general the first entry on the revision history has no parents.
760
# But it's not illegal for it to have parents listed; this can happen
761
# in imports from Arch when the parents weren't reachable.
762
if mainline_parent_id is not None:
763
if mainline_parent_id not in revision.parent_ids:
764
raise errors.BzrCheckError("previous revision {%s} not listed among "
766
% (mainline_parent_id, revision_id))
767
mainline_parent_id = revision_id
768
return BranchCheckResult(self)
770
def _get_checkout_format(self):
771
"""Return the most suitable metadir for a checkout of this branch.
772
Weaves are used if this branch's repository uses weaves.
774
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
775
from bzrlib.repofmt import weaverepo
776
format = bzrdir.BzrDirMetaFormat1()
777
format.repository_format = weaverepo.RepositoryFormat7()
779
format = self.repository.bzrdir.checkout_metadir()
780
format.set_branch_format(self._format)
783
def create_checkout(self, to_location, revision_id=None,
785
"""Create a checkout of a branch.
787
:param to_location: The url to produce the checkout at
788
:param revision_id: The revision to check out
789
:param lightweight: If True, produce a lightweight checkout, otherwise,
790
produce a bound branch (heavyweight checkout)
791
:return: The tree of the created checkout
793
t = transport.get_transport(to_location)
796
format = self._get_checkout_format()
797
checkout = format.initialize_on_transport(t)
798
BranchReferenceFormat().initialize(checkout, self)
800
format = self._get_checkout_format()
801
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
802
to_location, force_new_tree=False, format=format)
803
checkout = checkout_branch.bzrdir
804
checkout_branch.bind(self)
805
# pull up to the specified revision_id to set the initial
806
# branch tip correctly, and seed it with history.
807
checkout_branch.pull(self, stop_revision=revision_id)
808
tree = checkout.create_workingtree(revision_id)
809
basis_tree = tree.basis_tree()
810
basis_tree.lock_read()
812
for path, file_id in basis_tree.iter_references():
813
reference_parent = self.reference_parent(file_id, path)
814
reference_parent.create_checkout(tree.abspath(path),
815
basis_tree.get_reference_revision(file_id, path),
821
def reference_parent(self, file_id, path):
822
"""Return the parent branch for a tree-reference file_id
823
:param file_id: The file_id of the tree reference
824
:param path: The path of the file_id in the tree
825
:return: A branch associated with the file_id
827
# FIXME should provide multiple branches, based on config
828
return Branch.open(self.bzrdir.root_transport.clone(path).base)
830
def supports_tags(self):
831
return self._format.supports_tags()
834
class BranchFormat(object):
835
"""An encapsulation of the initialization and open routines for a format.
837
Formats provide three things:
838
* An initialization routine,
842
Formats are placed in an dict by their format string for reference
843
during branch opening. Its not required that these be instances, they
844
can be classes themselves with class methods - it simply depends on
845
whether state is needed for a given format or not.
847
Once a format is deprecated, just deprecate the initialize and open
848
methods on the format class. Do not deprecate the object, as the
849
object will be created every time regardless.
852
_default_format = None
853
"""The default format used for new branches."""
856
"""The known formats."""
858
def __eq__(self, other):
859
return self.__class__ is other.__class__
861
def __ne__(self, other):
862
return not (self == other)
865
def find_format(klass, a_bzrdir):
866
"""Return the format for the branch object in a_bzrdir."""
868
transport = a_bzrdir.get_branch_transport(None)
869
format_string = transport.get("format").read()
870
return klass._formats[format_string]
872
raise NotBranchError(path=transport.base)
874
raise errors.UnknownFormatError(format=format_string)
877
def get_default_format(klass):
878
"""Return the current default format."""
879
return klass._default_format
881
def get_reference(self, a_bzrdir):
882
"""Get the target reference of the branch in a_bzrdir.
884
format probing must have been completed before calling
885
this method - it is assumed that the format of the branch
886
in a_bzrdir is correct.
888
:param a_bzrdir: The bzrdir to get the branch data from.
889
:return: None if the branch is not a reference branch.
893
def get_format_string(self):
894
"""Return the ASCII format string that identifies this format."""
895
raise NotImplementedError(self.get_format_string)
897
def get_format_description(self):
898
"""Return the short format description for this format."""
899
raise NotImplementedError(self.get_format_description)
901
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
903
"""Initialize a branch in a bzrdir, with specified files
905
:param a_bzrdir: The bzrdir to initialize the branch in
906
:param utf8_files: The files to create as a list of
907
(filename, content) tuples
908
:param set_format: If True, set the format with
909
self.get_format_string. (BzrBranch4 has its format set
911
:return: a branch in this format
913
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
914
branch_transport = a_bzrdir.get_branch_transport(self)
916
'metadir': ('lock', lockdir.LockDir),
917
'branch4': ('branch-lock', lockable_files.TransportLock),
919
lock_name, lock_class = lock_map[lock_type]
920
control_files = lockable_files.LockableFiles(branch_transport,
921
lock_name, lock_class)
922
control_files.create_lock()
923
control_files.lock_write()
925
control_files.put_utf8('format', self.get_format_string())
927
for file, content in utf8_files:
928
control_files.put_utf8(file, content)
930
control_files.unlock()
931
return self.open(a_bzrdir, _found=True)
933
def initialize(self, a_bzrdir):
934
"""Create a branch of this format in a_bzrdir."""
935
raise NotImplementedError(self.initialize)
937
def is_supported(self):
938
"""Is this format supported?
940
Supported formats can be initialized and opened.
941
Unsupported formats may not support initialization or committing or
942
some other features depending on the reason for not being supported.
946
def open(self, a_bzrdir, _found=False):
947
"""Return the branch object for a_bzrdir
949
_found is a private parameter, do not use it. It is used to indicate
950
if format probing has already be done.
952
raise NotImplementedError(self.open)
955
def register_format(klass, format):
956
klass._formats[format.get_format_string()] = format
959
def set_default_format(klass, format):
960
klass._default_format = format
963
def unregister_format(klass, format):
964
assert klass._formats[format.get_format_string()] is format
965
del klass._formats[format.get_format_string()]
968
return self.get_format_string().rstrip()
970
def supports_tags(self):
971
"""True if this format supports tags stored in the branch"""
972
return False # by default
974
# XXX: Probably doesn't really belong here -- mbp 20070212
975
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
977
branch_transport = a_bzrdir.get_branch_transport(self)
978
control_files = lockable_files.LockableFiles(branch_transport,
979
lock_filename, lock_class)
980
control_files.create_lock()
981
control_files.lock_write()
983
for filename, content in utf8_files:
984
control_files.put_utf8(filename, content)
986
control_files.unlock()
989
class BranchHooks(Hooks):
990
"""A dictionary mapping hook name to a list of callables for branch hooks.
992
e.g. ['set_rh'] Is the list of items to be called when the
993
set_revision_history function is invoked.
997
"""Create the default hooks.
999
These are all empty initially, because by default nothing should get
1002
Hooks.__init__(self)
1003
# Introduced in 0.15:
1004
# invoked whenever the revision history has been set
1005
# with set_revision_history. The api signature is
1006
# (branch, revision_history), and the branch will
1009
# invoked after a push operation completes.
1010
# the api signature is
1012
# containing the members
1013
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1014
# where local is the local target branch or None, master is the target
1015
# master branch, and the rest should be self explanatory. The source
1016
# is read locked and the target branches write locked. Source will
1017
# be the local low-latency branch.
1018
self['post_push'] = []
1019
# invoked after a pull operation completes.
1020
# the api signature is
1022
# containing the members
1023
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1024
# where local is the local branch or None, master is the target
1025
# master branch, and the rest should be self explanatory. The source
1026
# is read locked and the target branches write locked. The local
1027
# branch is the low-latency branch.
1028
self['post_pull'] = []
1029
# invoked after a commit operation completes.
1030
# the api signature is
1031
# (local, master, old_revno, old_revid, new_revno, new_revid)
1032
# old_revid is NULL_REVISION for the first commit to a branch.
1033
self['post_commit'] = []
1034
# invoked after a uncommit operation completes.
1035
# the api signature is
1036
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1037
# local is the local branch or None, master is the target branch,
1038
# and an empty branch recieves new_revno of 0, new_revid of None.
1039
self['post_uncommit'] = []
1042
# install the default hooks into the Branch class.
1043
Branch.hooks = BranchHooks()
1046
class BzrBranchFormat4(BranchFormat):
1047
"""Bzr branch format 4.
1050
- a revision-history file.
1051
- a branch-lock lock file [ to be shared with the bzrdir ]
1054
def get_format_description(self):
1055
"""See BranchFormat.get_format_description()."""
1056
return "Branch format 4"
1058
def initialize(self, a_bzrdir):
1059
"""Create a branch of this format in a_bzrdir."""
1060
utf8_files = [('revision-history', ''),
1061
('branch-name', ''),
1063
return self._initialize_helper(a_bzrdir, utf8_files,
1064
lock_type='branch4', set_format=False)
1067
super(BzrBranchFormat4, self).__init__()
1068
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1070
def open(self, a_bzrdir, _found=False):
1071
"""Return the branch object for a_bzrdir
1073
_found is a private parameter, do not use it. It is used to indicate
1074
if format probing has already be done.
1077
# we are being called directly and must probe.
1078
raise NotImplementedError
1079
return BzrBranch(_format=self,
1080
_control_files=a_bzrdir._control_files,
1082
_repository=a_bzrdir.open_repository())
1085
return "Bazaar-NG branch format 4"
1088
class BzrBranchFormat5(BranchFormat):
1089
"""Bzr branch format 5.
1092
- a revision-history file.
1094
- a lock dir guarding the branch itself
1095
- all of this stored in a branch/ subdirectory
1096
- works with shared repositories.
1098
This format is new in bzr 0.8.
1101
def get_format_string(self):
1102
"""See BranchFormat.get_format_string()."""
1103
return "Bazaar-NG branch format 5\n"
1105
def get_format_description(self):
1106
"""See BranchFormat.get_format_description()."""
1107
return "Branch format 5"
1109
def initialize(self, a_bzrdir):
1110
"""Create a branch of this format in a_bzrdir."""
1111
utf8_files = [('revision-history', ''),
1112
('branch-name', ''),
1114
return self._initialize_helper(a_bzrdir, utf8_files)
1117
super(BzrBranchFormat5, self).__init__()
1118
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1120
def open(self, a_bzrdir, _found=False):
1121
"""Return the branch object for a_bzrdir
1123
_found is a private parameter, do not use it. It is used to indicate
1124
if format probing has already be done.
1127
format = BranchFormat.find_format(a_bzrdir)
1128
assert format.__class__ == self.__class__
1130
transport = a_bzrdir.get_branch_transport(None)
1131
control_files = lockable_files.LockableFiles(transport, 'lock',
1133
return BzrBranch5(_format=self,
1134
_control_files=control_files,
1136
_repository=a_bzrdir.find_repository())
1138
raise NotBranchError(path=transport.base)
1141
class BzrBranchFormat6(BzrBranchFormat5):
1142
"""Branch format with last-revision
1144
Unlike previous formats, this has no explicit revision history. Instead,
1145
this just stores the last-revision, and the left-hand history leading
1146
up to there is the history.
1148
This format was introduced in bzr 0.15
1151
def get_format_string(self):
1152
"""See BranchFormat.get_format_string()."""
1153
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1155
def get_format_description(self):
1156
"""See BranchFormat.get_format_description()."""
1157
return "Branch format 6"
1159
def initialize(self, a_bzrdir):
1160
"""Create a branch of this format in a_bzrdir."""
1161
utf8_files = [('last-revision', '0 null:\n'),
1162
('branch-name', ''),
1163
('branch.conf', ''),
1166
return self._initialize_helper(a_bzrdir, utf8_files)
1168
def open(self, a_bzrdir, _found=False):
1169
"""Return the branch object for a_bzrdir
1171
_found is a private parameter, do not use it. It is used to indicate
1172
if format probing has already be done.
1175
format = BranchFormat.find_format(a_bzrdir)
1176
assert format.__class__ == self.__class__
1177
transport = a_bzrdir.get_branch_transport(None)
1178
control_files = lockable_files.LockableFiles(transport, 'lock',
1180
return BzrBranch6(_format=self,
1181
_control_files=control_files,
1183
_repository=a_bzrdir.find_repository())
1185
def supports_tags(self):
1189
class BranchReferenceFormat(BranchFormat):
1190
"""Bzr branch reference format.
1192
Branch references are used in implementing checkouts, they
1193
act as an alias to the real branch which is at some other url.
1200
def get_format_string(self):
1201
"""See BranchFormat.get_format_string()."""
1202
return "Bazaar-NG Branch Reference Format 1\n"
1204
def get_format_description(self):
1205
"""See BranchFormat.get_format_description()."""
1206
return "Checkout reference format 1"
1208
def get_reference(self, a_bzrdir):
1209
"""See BranchFormat.get_reference()."""
1210
transport = a_bzrdir.get_branch_transport(None)
1211
return transport.get('location').read()
1213
def initialize(self, a_bzrdir, target_branch=None):
1214
"""Create a branch of this format in a_bzrdir."""
1215
if target_branch is None:
1216
# this format does not implement branch itself, thus the implicit
1217
# creation contract must see it as uninitializable
1218
raise errors.UninitializableFormat(self)
1219
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1220
branch_transport = a_bzrdir.get_branch_transport(self)
1221
branch_transport.put_bytes('location',
1222
target_branch.bzrdir.root_transport.base)
1223
branch_transport.put_bytes('format', self.get_format_string())
1224
return self.open(a_bzrdir, _found=True)
1227
super(BranchReferenceFormat, self).__init__()
1228
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1230
def _make_reference_clone_function(format, a_branch):
1231
"""Create a clone() routine for a branch dynamically."""
1232
def clone(to_bzrdir, revision_id=None):
1233
"""See Branch.clone()."""
1234
return format.initialize(to_bzrdir, a_branch)
1235
# cannot obey revision_id limits when cloning a reference ...
1236
# FIXME RBC 20060210 either nuke revision_id for clone, or
1237
# emit some sort of warning/error to the caller ?!
1240
def open(self, a_bzrdir, _found=False, location=None):
1241
"""Return the branch that the branch reference in a_bzrdir points at.
1243
_found is a private parameter, do not use it. It is used to indicate
1244
if format probing has already be done.
1247
format = BranchFormat.find_format(a_bzrdir)
1248
assert format.__class__ == self.__class__
1249
if location is None:
1250
location = self.get_reference(a_bzrdir)
1251
real_bzrdir = bzrdir.BzrDir.open(location)
1252
result = real_bzrdir.open_branch()
1253
# this changes the behaviour of result.clone to create a new reference
1254
# rather than a copy of the content of the branch.
1255
# I did not use a proxy object because that needs much more extensive
1256
# testing, and we are only changing one behaviour at the moment.
1257
# If we decide to alter more behaviours - i.e. the implicit nickname
1258
# then this should be refactored to introduce a tested proxy branch
1259
# and a subclass of that for use in overriding clone() and ....
1261
result.clone = self._make_reference_clone_function(result)
1265
# formats which have no format string are not discoverable
1266
# and not independently creatable, so are not registered.
1267
__default_format = BzrBranchFormat5()
1268
BranchFormat.register_format(__default_format)
1269
BranchFormat.register_format(BranchReferenceFormat())
1270
BranchFormat.register_format(BzrBranchFormat6())
1271
BranchFormat.set_default_format(__default_format)
1272
_legacy_formats = [BzrBranchFormat4(),
1275
class BzrBranch(Branch):
1276
"""A branch stored in the actual filesystem.
1278
Note that it's "local" in the context of the filesystem; it doesn't
1279
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1280
it's writable, and can be accessed via the normal filesystem API.
1283
def __init__(self, _format=None,
1284
_control_files=None, a_bzrdir=None, _repository=None):
1285
"""Create new branch object at a particular location."""
1286
Branch.__init__(self)
1287
if a_bzrdir is None:
1288
raise ValueError('a_bzrdir must be supplied')
1290
self.bzrdir = a_bzrdir
1291
# self._transport used to point to the directory containing the
1292
# control directory, but was not used - now it's just the transport
1293
# for the branch control files. mbp 20070212
1294
self._base = self.bzrdir.transport.clone('..').base
1295
self._format = _format
1296
if _control_files is None:
1297
raise ValueError('BzrBranch _control_files is None')
1298
self.control_files = _control_files
1299
self._transport = _control_files._transport
1300
self.repository = _repository
1303
return '%s(%r)' % (self.__class__.__name__, self.base)
1307
def _get_base(self):
1308
"""Returns the directory containing the control directory."""
1311
base = property(_get_base, doc="The URL for the root of this branch.")
1313
def abspath(self, name):
1314
"""See Branch.abspath."""
1315
return self.control_files._transport.abspath(name)
1318
@deprecated_method(zero_sixteen)
1320
def get_root_id(self):
1321
"""See Branch.get_root_id."""
1322
tree = self.repository.revision_tree(self.last_revision())
1323
return tree.inventory.root.file_id
1325
def is_locked(self):
1326
return self.control_files.is_locked()
1328
def lock_write(self, token=None):
1329
repo_token = self.repository.lock_write()
1331
token = self.control_files.lock_write(token=token)
1333
self.repository.unlock()
1337
def lock_read(self):
1338
self.repository.lock_read()
1340
self.control_files.lock_read()
1342
self.repository.unlock()
1346
# TODO: test for failed two phase locks. This is known broken.
1348
self.control_files.unlock()
1350
self.repository.unlock()
1351
if not self.control_files.is_locked():
1352
# we just released the lock
1353
self._clear_cached_state()
1355
def peek_lock_mode(self):
1356
if self.control_files._lock_count == 0:
1359
return self.control_files._lock_mode
1361
def get_physical_lock_status(self):
1362
return self.control_files.get_physical_lock_status()
1365
def print_file(self, file, revision_id):
1366
"""See Branch.print_file."""
1367
return self.repository.print_file(file, revision_id)
1370
def append_revision(self, *revision_ids):
1371
"""See Branch.append_revision."""
1372
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1373
for revision_id in revision_ids:
1374
_mod_revision.check_not_reserved_id(revision_id)
1375
mutter("add {%s} to revision-history" % revision_id)
1376
rev_history = self.revision_history()
1377
rev_history.extend(revision_ids)
1378
self.set_revision_history(rev_history)
1380
def _write_revision_history(self, history):
1381
"""Factored out of set_revision_history.
1383
This performs the actual writing to disk.
1384
It is intended to be called by BzrBranch5.set_revision_history."""
1385
self.control_files.put_bytes(
1386
'revision-history', '\n'.join(history))
1389
def set_revision_history(self, rev_history):
1390
"""See Branch.set_revision_history."""
1391
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1392
self._clear_cached_state()
1393
self._write_revision_history(rev_history)
1394
self._cache_revision_history(rev_history)
1395
for hook in Branch.hooks['set_rh']:
1396
hook(self, rev_history)
1399
def set_last_revision_info(self, revno, revision_id):
1400
revision_id = osutils.safe_revision_id(revision_id)
1401
history = self._lefthand_history(revision_id)
1402
assert len(history) == revno, '%d != %d' % (len(history), revno)
1403
self.set_revision_history(history)
1405
def _gen_revision_history(self):
1406
history = self.control_files.get('revision-history').read().split('\n')
1407
if history[-1:] == ['']:
1408
# There shouldn't be a trailing newline, but just in case.
1412
def _lefthand_history(self, revision_id, last_rev=None,
1414
# stop_revision must be a descendant of last_revision
1415
stop_graph = self.repository.get_revision_graph(revision_id)
1416
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1417
and last_rev not in stop_graph):
1418
# our previous tip is not merged into stop_revision
1419
raise errors.DivergedBranches(self, other_branch)
1420
# make a new revision history from the graph
1421
current_rev_id = revision_id
1423
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1424
new_history.append(current_rev_id)
1425
current_rev_id_parents = stop_graph[current_rev_id]
1427
current_rev_id = current_rev_id_parents[0]
1429
current_rev_id = None
1430
new_history.reverse()
1434
def generate_revision_history(self, revision_id, last_rev=None,
1436
"""Create a new revision history that will finish with revision_id.
1438
:param revision_id: the new tip to use.
1439
:param last_rev: The previous last_revision. If not None, then this
1440
must be a ancestory of revision_id, or DivergedBranches is raised.
1441
:param other_branch: The other branch that DivergedBranches should
1442
raise with respect to.
1444
revision_id = osutils.safe_revision_id(revision_id)
1445
self.set_revision_history(self._lefthand_history(revision_id,
1446
last_rev, other_branch))
1449
def update_revisions(self, other, stop_revision=None):
1450
"""See Branch.update_revisions."""
1453
if stop_revision is None:
1454
stop_revision = other.last_revision()
1455
if stop_revision is None:
1456
# if there are no commits, we're done.
1459
stop_revision = osutils.safe_revision_id(stop_revision)
1460
# whats the current last revision, before we fetch [and change it
1462
last_rev = _mod_revision.ensure_null(self.last_revision())
1463
# we fetch here regardless of whether we need to so that we pickup
1465
self.fetch(other, stop_revision)
1466
my_ancestry = self.repository.get_ancestry(last_rev,
1468
if stop_revision in my_ancestry:
1469
# last_revision is a descendant of stop_revision
1471
self.generate_revision_history(stop_revision, last_rev=last_rev,
1476
def basis_tree(self):
1477
"""See Branch.basis_tree."""
1478
return self.repository.revision_tree(self.last_revision())
1480
@deprecated_method(zero_eight)
1481
def working_tree(self):
1482
"""Create a Working tree object for this branch."""
1484
from bzrlib.transport.local import LocalTransport
1485
if (self.base.find('://') != -1 or
1486
not isinstance(self._transport, LocalTransport)):
1487
raise NoWorkingTree(self.base)
1488
return self.bzrdir.open_workingtree()
1491
def pull(self, source, overwrite=False, stop_revision=None,
1492
_hook_master=None, run_hooks=True):
1495
:param _hook_master: Private parameter - set the branch to
1496
be supplied as the master to push hooks.
1497
:param run_hooks: Private parameter - if false, this branch
1498
is being called because it's the master of the primary branch,
1499
so it should not run its hooks.
1501
result = PullResult()
1502
result.source_branch = source
1503
result.target_branch = self
1506
result.old_revno, result.old_revid = self.last_revision_info()
1508
self.update_revisions(source, stop_revision)
1509
except DivergedBranches:
1513
if stop_revision is None:
1514
stop_revision = source.last_revision()
1515
self.generate_revision_history(stop_revision)
1516
result.tag_conflicts = source.tags.merge_to(self.tags)
1517
result.new_revno, result.new_revid = self.last_revision_info()
1519
result.master_branch = _hook_master
1520
result.local_branch = self
1522
result.master_branch = self
1523
result.local_branch = None
1525
for hook in Branch.hooks['post_pull']:
1531
def _get_parent_location(self):
1532
_locs = ['parent', 'pull', 'x-pull']
1535
return self.control_files.get(l).read().strip('\n')
1541
def push(self, target, overwrite=False, stop_revision=None,
1542
_override_hook_source_branch=None):
1545
This is the basic concrete implementation of push()
1547
:param _override_hook_source_branch: If specified, run
1548
the hooks passing this Branch as the source, rather than self.
1549
This is for use of RemoteBranch, where push is delegated to the
1550
underlying vfs-based Branch.
1552
# TODO: Public option to disable running hooks - should be trivial but
1556
result = self._push_with_bound_branches(target, overwrite,
1558
_override_hook_source_branch=_override_hook_source_branch)
1563
def _push_with_bound_branches(self, target, overwrite,
1565
_override_hook_source_branch=None):
1566
"""Push from self into target, and into target's master if any.
1568
This is on the base BzrBranch class even though it doesn't support
1569
bound branches because the *target* might be bound.
1572
if _override_hook_source_branch:
1573
result.source_branch = _override_hook_source_branch
1574
for hook in Branch.hooks['post_push']:
1577
bound_location = target.get_bound_location()
1578
if bound_location and target.base != bound_location:
1579
# there is a master branch.
1581
# XXX: Why the second check? Is it even supported for a branch to
1582
# be bound to itself? -- mbp 20070507
1583
master_branch = target.get_master_branch()
1584
master_branch.lock_write()
1586
# push into the master from this branch.
1587
self._basic_push(master_branch, overwrite, stop_revision)
1588
# and push into the target branch from this. Note that we push from
1589
# this branch again, because its considered the highest bandwidth
1591
result = self._basic_push(target, overwrite, stop_revision)
1592
result.master_branch = master_branch
1593
result.local_branch = target
1597
master_branch.unlock()
1600
result = self._basic_push(target, overwrite, stop_revision)
1601
# TODO: Why set master_branch and local_branch if there's no
1602
# binding? Maybe cleaner to just leave them unset? -- mbp
1604
result.master_branch = target
1605
result.local_branch = None
1609
def _basic_push(self, target, overwrite, stop_revision):
1610
"""Basic implementation of push without bound branches or hooks.
1612
Must be called with self read locked and target write locked.
1614
result = PushResult()
1615
result.source_branch = self
1616
result.target_branch = target
1617
result.old_revno, result.old_revid = target.last_revision_info()
1619
target.update_revisions(self, stop_revision)
1620
except DivergedBranches:
1624
target.set_revision_history(self.revision_history())
1625
result.tag_conflicts = self.tags.merge_to(target.tags)
1626
result.new_revno, result.new_revid = target.last_revision_info()
1629
def get_parent(self):
1630
"""See Branch.get_parent."""
1632
assert self.base[-1] == '/'
1633
parent = self._get_parent_location()
1636
# This is an old-format absolute path to a local branch
1637
# turn it into a url
1638
if parent.startswith('/'):
1639
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1641
return urlutils.join(self.base[:-1], parent)
1642
except errors.InvalidURLJoin, e:
1643
raise errors.InaccessibleParent(parent, self.base)
1645
def set_push_location(self, location):
1646
"""See Branch.set_push_location."""
1647
self.get_config().set_user_option(
1648
'push_location', location,
1649
store=_mod_config.STORE_LOCATION_NORECURSE)
1652
def set_parent(self, url):
1653
"""See Branch.set_parent."""
1654
# TODO: Maybe delete old location files?
1655
# URLs should never be unicode, even on the local fs,
1656
# FIXUP this and get_parent in a future branch format bump:
1657
# read and rewrite the file, and have the new format code read
1658
# using .get not .get_utf8. RBC 20060125
1660
if isinstance(url, unicode):
1662
url = url.encode('ascii')
1663
except UnicodeEncodeError:
1664
raise errors.InvalidURL(url,
1665
"Urls must be 7-bit ascii, "
1666
"use bzrlib.urlutils.escape")
1667
url = urlutils.relative_url(self.base, url)
1668
self._set_parent_location(url)
1670
def _set_parent_location(self, url):
1672
self.control_files._transport.delete('parent')
1674
assert isinstance(url, str)
1675
self.control_files.put_bytes('parent', url + '\n')
1677
@deprecated_function(zero_nine)
1678
def tree_config(self):
1679
"""DEPRECATED; call get_config instead.
1680
TreeConfig has become part of BranchConfig."""
1681
return TreeConfig(self)
1684
class BzrBranch5(BzrBranch):
1685
"""A format 5 branch. This supports new features over plan branches.
1687
It has support for a master_branch which is the data for bound branches.
1695
super(BzrBranch5, self).__init__(_format=_format,
1696
_control_files=_control_files,
1698
_repository=_repository)
1701
def pull(self, source, overwrite=False, stop_revision=None,
1703
"""Pull from source into self, updating my master if any.
1705
:param run_hooks: Private parameter - if false, this branch
1706
is being called because it's the master of the primary branch,
1707
so it should not run its hooks.
1709
bound_location = self.get_bound_location()
1710
master_branch = None
1711
if bound_location and source.base != bound_location:
1712
# not pulling from master, so we need to update master.
1713
master_branch = self.get_master_branch()
1714
master_branch.lock_write()
1717
# pull from source into master.
1718
master_branch.pull(source, overwrite, stop_revision,
1720
return super(BzrBranch5, self).pull(source, overwrite,
1721
stop_revision, _hook_master=master_branch,
1722
run_hooks=run_hooks)
1725
master_branch.unlock()
1727
def get_bound_location(self):
1729
return self.control_files.get_utf8('bound').read()[:-1]
1730
except errors.NoSuchFile:
1734
def get_master_branch(self):
1735
"""Return the branch we are bound to.
1737
:return: Either a Branch, or None
1739
This could memoise the branch, but if thats done
1740
it must be revalidated on each new lock.
1741
So for now we just don't memoise it.
1742
# RBC 20060304 review this decision.
1744
bound_loc = self.get_bound_location()
1748
return Branch.open(bound_loc)
1749
except (errors.NotBranchError, errors.ConnectionError), e:
1750
raise errors.BoundBranchConnectionFailure(
1754
def set_bound_location(self, location):
1755
"""Set the target where this branch is bound to.
1757
:param location: URL to the target branch
1760
self.control_files.put_utf8('bound', location+'\n')
1763
self.control_files._transport.delete('bound')
1145
## TODO: Option to move IDs only
1146
assert not isinstance(from_paths, basestring)
1147
tree = self.working_tree()
1148
inv = tree.inventory
1149
to_abs = self.abspath(to_name)
1150
if not isdir(to_abs):
1151
raise BzrError("destination %r is not a directory" % to_abs)
1152
if not tree.has_filename(to_name):
1153
raise BzrError("destination %r not in working directory" % to_abs)
1154
to_dir_id = inv.path2id(to_name)
1155
if to_dir_id == None and to_name != '':
1156
raise BzrError("destination %r is not a versioned directory" % to_name)
1157
to_dir_ie = inv[to_dir_id]
1158
if to_dir_ie.kind not in ('directory', 'root_directory'):
1159
raise BzrError("destination %r is not a directory" % to_abs)
1161
to_idpath = inv.get_idpath(to_dir_id)
1163
for f in from_paths:
1164
if not tree.has_filename(f):
1165
raise BzrError("%r does not exist in working tree" % f)
1166
f_id = inv.path2id(f)
1168
raise BzrError("%r is not versioned" % f)
1169
name_tail = splitpath(f)[-1]
1170
dest_path = appendpath(to_name, name_tail)
1171
if tree.has_filename(dest_path):
1172
raise BzrError("destination %r already exists" % dest_path)
1173
if f_id in to_idpath:
1174
raise BzrError("can't move %r to a subdirectory of itself" % f)
1176
# OK, so there's a race here, it's possible that someone will
1177
# create a file in this interval and then the rename might be
1178
# left half-done. But we should have caught most problems.
1180
for f in from_paths:
1181
name_tail = splitpath(f)[-1]
1182
dest_path = appendpath(to_name, name_tail)
1183
print "%s => %s" % (f, dest_path)
1184
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1186
os.rename(self.abspath(f), self.abspath(dest_path))
1188
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1189
["rename rolled back"])
1191
self._write_inventory(inv)
1196
def revert(self, filenames, old_tree=None, backups=True):
1197
"""Restore selected files to the versions from a previous tree.
1200
If true (default) backups are made of files before
1203
from bzrlib.errors import NotVersionedError, BzrError
1204
from bzrlib.atomicfile import AtomicFile
1205
from bzrlib.osutils import backup_file
1207
inv = self.read_working_inventory()
1208
if old_tree is None:
1209
old_tree = self.basis_tree()
1210
old_inv = old_tree.inventory
1213
for fn in filenames:
1214
file_id = inv.path2id(fn)
1216
raise NotVersionedError("not a versioned file", fn)
1217
if not old_inv.has_id(file_id):
1218
raise BzrError("file not present in old tree", fn, file_id)
1219
nids.append((fn, file_id))
1221
# TODO: Rename back if it was previously at a different location
1223
# TODO: If given a directory, restore the entire contents from
1224
# the previous version.
1226
# TODO: Make a backup to a temporary file.
1228
# TODO: If the file previously didn't exist, delete it?
1229
for fn, file_id in nids:
1232
f = AtomicFile(fn, 'wb')
1234
f.write(old_tree.get_file(file_id).read())
1240
def pending_merges(self):
1241
"""Return a list of pending merges.
1243
These are revisions that have been merged into the working
1244
directory but not yet committed.
1246
cfn = self.controlfilename('pending-merges')
1247
if not os.path.exists(cfn):
1250
for l in self.controlfile('pending-merges', 'r').readlines():
1251
p.append(l.rstrip('\n'))
1255
def add_pending_merge(self, revision_id):
1256
from bzrlib.revision import validate_revision_id
1258
validate_revision_id(revision_id)
1260
p = self.pending_merges()
1261
if revision_id in p:
1263
p.append(revision_id)
1264
self.set_pending_merges(p)
1267
def set_pending_merges(self, rev_list):
1268
from bzrlib.atomicfile import AtomicFile
1271
f = AtomicFile(self.controlfilename('pending-merges'))
1283
class ScratchBranch(Branch):
1284
"""Special test class: a branch that cleans up after itself.
1286
>>> b = ScratchBranch()
1294
def __init__(self, files=[], dirs=[], base=None):
1295
"""Make a test branch.
1297
This creates a temporary directory and runs init-tree in it.
1299
If any files are listed, they are created in the working copy.
1301
from tempfile import mkdtemp
1306
Branch.__init__(self, base, init=init)
1308
os.mkdir(self.abspath(d))
1311
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1316
>>> orig = ScratchBranch(files=["file1", "file2"])
1317
>>> clone = orig.clone()
1318
>>> os.path.samefile(orig.base, clone.base)
1320
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1323
from shutil import copytree
1324
from tempfile import mkdtemp
1327
copytree(self.base, base, symlinks=True)
1328
return ScratchBranch(base=base)
1334
"""Destroy the test branch, removing the scratch directory."""
1335
from shutil import rmtree
1338
mutter("delete ScratchBranch %s" % self.base)
1341
# Work around for shutil.rmtree failing on Windows when
1342
# readonly files are encountered
1343
mutter("hit exception in destroying ScratchBranch: %s" % e)
1344
for root, dirs, files in os.walk(self.base, topdown=False):
1346
os.chmod(os.path.join(root, name), 0700)
1352
######################################################################
1356
def is_control_file(filename):
1357
## FIXME: better check
1358
filename = os.path.normpath(filename)
1359
while filename != '':
1360
head, tail = os.path.split(filename)
1361
## mutter('check %r for control file' % ((head, tail), ))
1362
if tail == bzrlib.BZRDIR:
1769
def bind(self, other):
1770
"""Bind this branch to the branch other.
1772
This does not push or pull data between the branches, though it does
1773
check for divergence to raise an error when the branches are not
1774
either the same, or one a prefix of the other. That behaviour may not
1775
be useful, so that check may be removed in future.
1777
:param other: The branch to bind to
1780
# TODO: jam 20051230 Consider checking if the target is bound
1781
# It is debatable whether you should be able to bind to
1782
# a branch which is itself bound.
1783
# Committing is obviously forbidden,
1784
# but binding itself may not be.
1785
# Since we *have* to check at commit time, we don't
1786
# *need* to check here
1788
# we want to raise diverged if:
1789
# last_rev is not in the other_last_rev history, AND
1790
# other_last_rev is not in our history, and do it without pulling
1792
last_rev = _mod_revision.ensure_null(self.last_revision())
1793
if last_rev != _mod_revision.NULL_REVISION:
1796
other_last_rev = other.last_revision()
1797
if not _mod_revision.is_null(other_last_rev):
1798
# neither branch is new, we have to do some work to
1799
# ascertain diversion.
1800
remote_graph = other.repository.get_revision_graph(
1802
local_graph = self.repository.get_revision_graph(last_rev)
1803
if (last_rev not in remote_graph and
1804
other_last_rev not in local_graph):
1805
raise errors.DivergedBranches(self, other)
1808
self.set_bound_location(other.base)
1812
"""If bound, unbind"""
1813
return self.set_bound_location(None)
1817
"""Synchronise this branch with the master branch if any.
1819
:return: None or the last_revision that was pivoted out during the
1822
master = self.get_master_branch()
1823
if master is not None:
1824
old_tip = self.last_revision()
1825
self.pull(master, overwrite=True)
1826
if old_tip in self.repository.get_ancestry(
1827
_mod_revision.ensure_null(self.last_revision()),
1834
class BzrBranchExperimental(BzrBranch5):
1835
"""Bzr experimental branch format
1838
- a revision-history file.
1840
- a lock dir guarding the branch itself
1841
- all of this stored in a branch/ subdirectory
1842
- works with shared repositories.
1843
- a tag dictionary in the branch
1845
This format is new in bzr 0.15, but shouldn't be used for real data,
1848
This class acts as it's own BranchFormat.
1851
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1854
def get_format_string(cls):
1855
"""See BranchFormat.get_format_string()."""
1856
return "Bazaar-NG branch format experimental\n"
1859
def get_format_description(cls):
1860
"""See BranchFormat.get_format_description()."""
1861
return "Experimental branch format"
1864
def get_reference(cls, a_bzrdir):
1865
"""Get the target reference of the branch in a_bzrdir.
1867
format probing must have been completed before calling
1868
this method - it is assumed that the format of the branch
1869
in a_bzrdir is correct.
1871
:param a_bzrdir: The bzrdir to get the branch data from.
1872
:return: None if the branch is not a reference branch.
1877
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1879
branch_transport = a_bzrdir.get_branch_transport(cls)
1880
control_files = lockable_files.LockableFiles(branch_transport,
1881
lock_filename, lock_class)
1882
control_files.create_lock()
1883
control_files.lock_write()
1885
for filename, content in utf8_files:
1886
control_files.put_utf8(filename, content)
1888
control_files.unlock()
1891
def initialize(cls, a_bzrdir):
1892
"""Create a branch of this format in a_bzrdir."""
1893
utf8_files = [('format', cls.get_format_string()),
1894
('revision-history', ''),
1895
('branch-name', ''),
1898
cls._initialize_control_files(a_bzrdir, utf8_files,
1899
'lock', lockdir.LockDir)
1900
return cls.open(a_bzrdir, _found=True)
1903
def open(cls, a_bzrdir, _found=False):
1904
"""Return the branch object for a_bzrdir
1906
_found is a private parameter, do not use it. It is used to indicate
1907
if format probing has already be done.
1910
format = BranchFormat.find_format(a_bzrdir)
1911
assert format.__class__ == cls
1912
transport = a_bzrdir.get_branch_transport(None)
1913
control_files = lockable_files.LockableFiles(transport, 'lock',
1915
return cls(_format=cls,
1916
_control_files=control_files,
1918
_repository=a_bzrdir.find_repository())
1921
def is_supported(cls):
1924
def _make_tags(self):
1925
return BasicTags(self)
1928
def supports_tags(cls):
1932
BranchFormat.register_format(BzrBranchExperimental)
1935
class BzrBranch6(BzrBranch5):
1938
def last_revision_info(self):
1939
revision_string = self.control_files.get('last-revision').read()
1940
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1941
revision_id = cache_utf8.get_cached_utf8(revision_id)
1943
return revno, revision_id
1945
def last_revision(self):
1946
"""Return last revision id, or None"""
1947
revision_id = self.last_revision_info()[1]
1948
if revision_id == _mod_revision.NULL_REVISION:
1952
def _write_last_revision_info(self, revno, revision_id):
1953
"""Simply write out the revision id, with no checks.
1955
Use set_last_revision_info to perform this safely.
1957
Does not update the revision_history cache.
1958
Intended to be called by set_last_revision_info and
1959
_write_revision_history.
1961
if revision_id is None:
1962
revision_id = 'null:'
1963
out_string = '%d %s\n' % (revno, revision_id)
1964
self.control_files.put_bytes('last-revision', out_string)
1967
def set_last_revision_info(self, revno, revision_id):
1968
revision_id = osutils.safe_revision_id(revision_id)
1969
if self._get_append_revisions_only():
1970
self._check_history_violation(revision_id)
1971
self._write_last_revision_info(revno, revision_id)
1972
self._clear_cached_state()
1974
def _check_history_violation(self, revision_id):
1975
last_revision = _mod_revision.ensure_null(self.last_revision())
1976
if _mod_revision.is_null(last_revision):
1978
if last_revision not in self._lefthand_history(revision_id):
1979
raise errors.AppendRevisionsOnlyViolation(self.base)
1981
def _gen_revision_history(self):
1982
"""Generate the revision history from last revision
1984
history = list(self.repository.iter_reverse_revision_history(
1985
self.last_revision()))
1989
def _write_revision_history(self, history):
1990
"""Factored out of set_revision_history.
1992
This performs the actual writing to disk, with format-specific checks.
1993
It is intended to be called by BzrBranch5.set_revision_history.
1995
if len(history) == 0:
1996
last_revision = 'null:'
1998
if history != self._lefthand_history(history[-1]):
1999
raise errors.NotLefthandHistory(history)
2000
last_revision = history[-1]
2001
if self._get_append_revisions_only():
2002
self._check_history_violation(last_revision)
2003
self._write_last_revision_info(len(history), last_revision)
2006
def append_revision(self, *revision_ids):
2007
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
2008
if len(revision_ids) == 0:
2010
prev_revno, prev_revision = self.last_revision_info()
2011
for revision in self.repository.get_revisions(revision_ids):
2012
if prev_revision == _mod_revision.NULL_REVISION:
2013
if revision.parent_ids != []:
2014
raise errors.NotLeftParentDescendant(self, prev_revision,
2015
revision.revision_id)
2017
if revision.parent_ids[0] != prev_revision:
2018
raise errors.NotLeftParentDescendant(self, prev_revision,
2019
revision.revision_id)
2020
prev_revision = revision.revision_id
2021
self.set_last_revision_info(prev_revno + len(revision_ids),
2025
def _set_parent_location(self, url):
2026
"""Set the parent branch"""
2027
self._set_config_location('parent_location', url, make_relative=True)
2030
def _get_parent_location(self):
2031
"""Set the parent branch"""
2032
return self._get_config_location('parent_location')
2034
def set_push_location(self, location):
2035
"""See Branch.set_push_location."""
2036
self._set_config_location('push_location', location)
2038
def set_bound_location(self, location):
2039
"""See Branch.set_push_location."""
2041
config = self.get_config()
2042
if location is None:
2043
if config.get_user_option('bound') != 'True':
2046
config.set_user_option('bound', 'False', warn_masked=True)
2049
self._set_config_location('bound_location', location,
2051
config.set_user_option('bound', 'True', warn_masked=True)
2054
def _get_bound_location(self, bound):
2055
"""Return the bound location in the config file.
2057
Return None if the bound parameter does not match"""
2058
config = self.get_config()
2059
config_bound = (config.get_user_option('bound') == 'True')
2060
if config_bound != bound:
2062
return self._get_config_location('bound_location', config=config)
2064
def get_bound_location(self):
2065
"""See Branch.set_push_location."""
2066
return self._get_bound_location(True)
2068
def get_old_bound_location(self):
2069
"""See Branch.get_old_bound_location"""
2070
return self._get_bound_location(False)
2072
def set_append_revisions_only(self, enabled):
2077
self.get_config().set_user_option('append_revisions_only', value,
2080
def _get_append_revisions_only(self):
2081
value = self.get_config().get_user_option('append_revisions_only')
2082
return value == 'True'
2084
def _synchronize_history(self, destination, revision_id):
2085
"""Synchronize last revision and revision history between branches.
2087
This version is most efficient when the destination is also a
2088
BzrBranch6, but works for BzrBranch5, as long as the destination's
2089
repository contains all the lefthand ancestors of the intended
2090
last_revision. If not, set_last_revision_info will fail.
2092
:param destination: The branch to copy the history into
2093
:param revision_id: The revision-id to truncate history at. May
2094
be None to copy complete history.
2096
if revision_id is None:
2097
revno, revision_id = self.last_revision_info()
2099
# To figure out the revno for a random revision, we need to build
2100
# the revision history, and count its length.
2101
# We don't care about the order, just how long it is.
2102
# Alternatively, we could start at the current location, and count
2103
# backwards. But there is no guarantee that we will find it since
2104
# it may be a merged revision.
2105
revno = len(list(self.repository.iter_reverse_revision_history(
2107
destination.set_last_revision_info(revno, revision_id)
2109
def _make_tags(self):
2110
return BasicTags(self)
2113
######################################################################
2114
# results of operations
2117
class _Result(object):
2119
def _show_tag_conficts(self, to_file):
2120
if not getattr(self, 'tag_conflicts', None):
2122
to_file.write('Conflicting tags:\n')
2123
for name, value1, value2 in self.tag_conflicts:
2124
to_file.write(' %s\n' % (name, ))
2127
class PullResult(_Result):
2128
"""Result of a Branch.pull operation.
2130
:ivar old_revno: Revision number before pull.
2131
:ivar new_revno: Revision number after pull.
2132
:ivar old_revid: Tip revision id before pull.
2133
:ivar new_revid: Tip revision id after pull.
2134
:ivar source_branch: Source (local) branch object.
2135
:ivar master_branch: Master branch of the target, or None.
2136
:ivar target_branch: Target/destination branch object.
2140
# DEPRECATED: pull used to return the change in revno
2141
return self.new_revno - self.old_revno
2143
def report(self, to_file):
2144
if self.old_revid == self.new_revid:
2145
to_file.write('No revisions to pull.\n')
2147
to_file.write('Now on revision %d.\n' % self.new_revno)
2148
self._show_tag_conficts(to_file)
2151
class PushResult(_Result):
2152
"""Result of a Branch.push operation.
2154
:ivar old_revno: Revision number before push.
2155
:ivar new_revno: Revision number after push.
2156
:ivar old_revid: Tip revision id before push.
2157
:ivar new_revid: Tip revision id after push.
2158
:ivar source_branch: Source branch object.
2159
:ivar master_branch: Master branch of the target, or None.
2160
:ivar target_branch: Target/destination branch object.
2164
# DEPRECATED: push used to return the change in revno
2165
return self.new_revno - self.old_revno
2167
def report(self, to_file):
2168
"""Write a human-readable description of the result."""
2169
if self.old_revid == self.new_revid:
2170
to_file.write('No new revisions to push.\n')
2172
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2173
self._show_tag_conficts(to_file)
2176
class BranchCheckResult(object):
2177
"""Results of checking branch consistency.
2182
def __init__(self, branch):
2183
self.branch = branch
2185
def report_results(self, verbose):
2186
"""Report the check results via trace.note.
2188
:param verbose: Requests more detailed display of what was checked,
2191
note('checked branch %s format %s',
2193
self.branch._format)
2196
class Converter5to6(object):
2197
"""Perform an in-place upgrade of format 5 to format 6"""
2199
def convert(self, branch):
2200
# Data for 5 and 6 can peacefully coexist.
2201
format = BzrBranchFormat6()
2202
new_branch = format.open(branch.bzrdir, _found=True)
2204
# Copy source data into target
2205
new_branch.set_last_revision_info(*branch.last_revision_info())
2206
new_branch.set_parent(branch.get_parent())
2207
new_branch.set_bound_location(branch.get_bound_location())
2208
new_branch.set_push_location(branch.get_push_location())
2210
# New branch has no tags by default
2211
new_branch.tags._set_tag_dict({})
2213
# Copying done; now update target format
2214
new_branch.control_files.put_utf8('format',
2215
format.get_format_string())
2217
# Clean up old files
2218
new_branch.control_files._transport.delete('revision-history')
2220
branch.set_parent(None)
2223
branch.set_bound_location(None)
1364
if filename == head:
1371
def gen_file_id(name):
1372
"""Return new file id.
1374
This should probably generate proper UUIDs, but for the moment we
1375
cope with just randomness because running uuidgen every time is
1378
from binascii import hexlify
1379
from time import time
1381
# get last component
1382
idx = name.rfind('/')
1384
name = name[idx+1 : ]
1385
idx = name.rfind('\\')
1387
name = name[idx+1 : ]
1389
# make it not a hidden file
1390
name = name.lstrip('.')
1392
# remove any wierd characters; we don't escape them but rather
1393
# just pull them out
1394
name = re.sub(r'[^\w.]', '', name)
1396
s = hexlify(rand_bytes(8))
1397
return '-'.join((name, compact_date(time()), s))
1401
"""Return a new tree-root file id."""
1402
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
