1
# Copyright (C) 2005 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
from warnings import warn
22
from cStringIO import StringIO
26
from bzrlib.inventory import InventoryEntry
27
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
30
rename, splitpath, sha_file, appendpath,
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile, NotVersionedError)
37
from bzrlib.textui import show_status
38
from bzrlib.revision import Revision, is_ancestor, get_intervening_revisions
40
from bzrlib.delta import compare_trees
41
from bzrlib.tree import EmptyTree, RevisionTree
42
from bzrlib.inventory import Inventory
43
from bzrlib.store import copy_all
44
from bzrlib.store.compressed_text import CompressedTextStore
45
from bzrlib.store.text import TextStore
46
from bzrlib.store.weave import WeaveStore
47
from bzrlib.testament import Testament
48
import bzrlib.transactions as transactions
49
from bzrlib.transport import Transport, get_transport
54
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
55
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
56
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
57
## TODO: Maybe include checks for common corruption of newlines, etc?
60
# TODO: Some operations like log might retrieve the same revisions
61
# repeatedly to calculate deltas. We could perhaps have a weakref
62
# cache in memory to make this faster. In general anything can be
63
# cached in memory between lock and unlock operations.
65
def find_branch(*ignored, **ignored_too):
66
# XXX: leave this here for about one release, then remove it
67
raise NotImplementedError('find_branch() is not supported anymore, '
68
'please use one of the new branch constructors')
71
def needs_read_lock(unbound):
72
"""Decorate unbound to take out and release a read lock."""
73
def decorated(self, *args, **kwargs):
76
return unbound(self, *args, **kwargs)
82
def needs_write_lock(unbound):
83
"""Decorate unbound to take out and release a write lock."""
84
def decorated(self, *args, **kwargs):
87
return unbound(self, *args, **kwargs)
92
######################################################################
96
"""Branch holding a history of revisions.
99
Base directory/url of the branch.
103
def __init__(self, *ignored, **ignored_too):
104
raise NotImplementedError('The Branch class is abstract')
107
def open_downlevel(base):
108
"""Open a branch which may be of an old format.
110
Only local branches are supported."""
111
return _Branch(get_transport(base), relax_version_check=True)
115
"""Open an existing branch, rooted at 'base' (url)"""
116
t = get_transport(base)
117
mutter("trying to open %r with transport %r", base, t)
121
def open_containing(url):
122
"""Open an existing branch which contains url.
124
This probes for a branch at url, and searches upwards from there.
126
Basically we keep looking up until we find the control directory or
127
run into the root. If there isn't one, raises NotBranchError.
128
If there is one, it is returned, along with the unused portion of url.
130
t = get_transport(url)
133
return _Branch(t), t.relpath(url)
134
except NotBranchError:
136
new_t = t.clone('..')
137
if new_t.base == t.base:
138
# reached the root, whatever that may be
139
raise NotBranchError(path=url)
143
def initialize(base):
144
"""Create a new branch, rooted at 'base' (url)"""
145
t = get_transport(base)
146
return _Branch(t, init=True)
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
self.cache_root = cache_root
155
class _Branch(Branch):
156
"""A branch stored in the actual filesystem.
158
Note that it's "local" in the context of the filesystem; it doesn't
159
really matter if it's on an nfs/smb/afs/coda/... share, as long as
160
it's writable, and can be accessed via the normal filesystem API.
166
If _lock_mode is true, a positive count of the number of times the
170
Lock object from bzrlib.lock.
172
# We actually expect this class to be somewhat short-lived; part of its
173
# purpose is to try to isolate what bits of the branch logic are tied to
174
# filesystem access, so that in a later step, we can extricate them to
175
# a separarte ("storage") class.
179
_inventory_weave = None
181
# Map some sort of prefix into a namespace
182
# stuff like "revno:10", "revid:", etc.
183
# This should match a prefix with a function which accepts
184
REVISION_NAMESPACES = {}
186
def push_stores(self, branch_to):
187
"""Copy the content of this branches store to branch_to."""
188
if (self._branch_format != branch_to._branch_format
189
or self._branch_format != 4):
190
from bzrlib.fetch import greedy_fetch
191
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
192
self, self._branch_format, branch_to, branch_to._branch_format)
193
greedy_fetch(to_branch=branch_to, from_branch=self,
194
revision=self.last_revision())
197
store_pairs = ((self.text_store, branch_to.text_store),
198
(self.inventory_store, branch_to.inventory_store),
199
(self.revision_store, branch_to.revision_store))
201
for from_store, to_store in store_pairs:
202
copy_all(from_store, to_store)
203
except UnlistableStore:
204
raise UnlistableBranch(from_store)
206
def __init__(self, transport, init=False,
207
relax_version_check=False):
208
"""Create new branch object at a particular location.
210
transport -- A Transport object, defining how to access files.
212
init -- If True, create new control files in a previously
213
unversioned directory. If False, the branch must already
216
relax_version_check -- If true, the usual check for the branch
217
version is not applied. This is intended only for
218
upgrade/recovery type use; it's not guaranteed that
219
all operations will work on old format branches.
221
In the test suite, creation of new trees is tested using the
222
`ScratchBranch` class.
224
assert isinstance(transport, Transport), \
225
"%r is not a Transport" % transport
226
self._transport = transport
229
self._check_format(relax_version_check)
231
def get_store(name, compressed=True, prefixed=False):
232
# FIXME: This approach of assuming stores are all entirely compressed
233
# or entirely uncompressed is tidy, but breaks upgrade from
234
# some existing branches where there's a mixture; we probably
235
# still want the option to look for both.
236
relpath = self._rel_controlfilename(name)
238
store = CompressedTextStore(self._transport.clone(relpath),
241
store = TextStore(self._transport.clone(relpath),
243
#if self._transport.should_cache():
244
# cache_path = os.path.join(self.cache_root, name)
245
# os.mkdir(cache_path)
246
# store = bzrlib.store.CachedStore(store, cache_path)
248
def get_weave(name, prefixed=False):
249
relpath = self._rel_controlfilename(name)
250
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
251
if self._transport.should_cache():
252
ws.enable_cache = True
255
if self._branch_format == 4:
256
self.inventory_store = get_store('inventory-store')
257
self.text_store = get_store('text-store')
258
self.revision_store = get_store('revision-store')
259
elif self._branch_format == 5:
260
self.control_weaves = get_weave([])
261
self.weave_store = get_weave('weaves')
262
self.revision_store = get_store('revision-store', compressed=False)
263
elif self._branch_format == 6:
264
self.control_weaves = get_weave([])
265
self.weave_store = get_weave('weaves', prefixed=True)
266
self.revision_store = get_store('revision-store', compressed=False,
268
self.revision_store.register_suffix('sig')
269
self._transaction = None
272
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
279
if self._lock_mode or self._lock:
280
# XXX: This should show something every time, and be suitable for
281
# headless operation and embedding
282
warn("branch %r was not explicitly unlocked" % self)
285
# TODO: It might be best to do this somewhere else,
286
# but it is nice for a Branch object to automatically
287
# cache it's information.
288
# Alternatively, we could have the Transport objects cache requests
289
# See the earlier discussion about how major objects (like Branch)
290
# should never expect their __del__ function to run.
291
if hasattr(self, 'cache_root') and self.cache_root is not None:
294
shutil.rmtree(self.cache_root)
297
self.cache_root = None
301
return self._transport.base
304
base = property(_get_base, doc="The URL for the root of this branch.")
306
def _finish_transaction(self):
307
"""Exit the current transaction."""
308
if self._transaction is None:
309
raise errors.LockError('Branch %s is not in a transaction' %
311
transaction = self._transaction
312
self._transaction = None
315
def get_transaction(self):
316
"""Return the current active transaction.
318
If no transaction is active, this returns a passthrough object
319
for which all data is immediately flushed and no caching happens.
321
if self._transaction is None:
322
return transactions.PassThroughTransaction()
324
return self._transaction
326
def _set_transaction(self, new_transaction):
327
"""Set a new active transaction."""
328
if self._transaction is not None:
329
raise errors.LockError('Branch %s is in a transaction already.' %
331
self._transaction = new_transaction
333
def lock_write(self):
334
mutter("lock write: %s (%s)", self, self._lock_count)
335
# TODO: Upgrade locking to support using a Transport,
336
# and potentially a remote locking protocol
338
if self._lock_mode != 'w':
339
raise LockError("can't upgrade to a write lock from %r" %
341
self._lock_count += 1
343
self._lock = self._transport.lock_write(
344
self._rel_controlfilename('branch-lock'))
345
self._lock_mode = 'w'
347
self._set_transaction(transactions.PassThroughTransaction())
350
mutter("lock read: %s (%s)", self, self._lock_count)
352
assert self._lock_mode in ('r', 'w'), \
353
"invalid lock mode %r" % self._lock_mode
354
self._lock_count += 1
356
self._lock = self._transport.lock_read(
357
self._rel_controlfilename('branch-lock'))
358
self._lock_mode = 'r'
360
self._set_transaction(transactions.ReadOnlyTransaction())
361
# 5K may be excessive, but hey, its a knob.
362
self.get_transaction().set_cache_size(5000)
365
mutter("unlock: %s (%s)", self, self._lock_count)
366
if not self._lock_mode:
367
raise LockError('branch %r is not locked' % (self))
369
if self._lock_count > 1:
370
self._lock_count -= 1
372
self._finish_transaction()
375
self._lock_mode = self._lock_count = None
377
def abspath(self, name):
378
"""Return absolute filename for something in the branch
380
XXX: Robert Collins 20051017 what is this used for? why is it a branch
381
method and not a tree method.
383
return self._transport.abspath(name)
385
def _rel_controlfilename(self, file_or_path):
386
if isinstance(file_or_path, basestring):
387
file_or_path = [file_or_path]
388
return [bzrlib.BZRDIR] + file_or_path
390
def controlfilename(self, file_or_path):
391
"""Return location relative to branch."""
392
return self._transport.abspath(self._rel_controlfilename(file_or_path))
395
def controlfile(self, file_or_path, mode='r'):
396
"""Open a control file for this branch.
398
There are two classes of file in the control directory: text
399
and binary. binary files are untranslated byte streams. Text
400
control files are stored with Unix newlines and in UTF-8, even
401
if the platform or locale defaults are different.
403
Controlfiles should almost never be opened in write mode but
404
rather should be atomically copied and replaced using atomicfile.
408
relpath = self._rel_controlfilename(file_or_path)
409
#TODO: codecs.open() buffers linewise, so it was overloaded with
410
# a much larger buffer, do we need to do the same for getreader/getwriter?
412
return self._transport.get(relpath)
414
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
416
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
418
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
420
raise BzrError("invalid controlfile mode %r" % mode)
422
def put_controlfile(self, path, f, encode=True):
423
"""Write an entry as a controlfile.
425
:param path: The path to put the file, relative to the .bzr control
427
:param f: A file-like or string object whose contents should be copied.
428
:param encode: If true, encode the contents as utf-8
430
self.put_controlfiles([(path, f)], encode=encode)
432
def put_controlfiles(self, files, encode=True):
433
"""Write several entries as controlfiles.
435
:param files: A list of [(path, file)] pairs, where the path is the directory
436
underneath the bzr control directory
437
:param encode: If true, encode the contents as utf-8
441
for path, f in files:
443
if isinstance(f, basestring):
444
f = f.encode('utf-8', 'replace')
446
f = codecs.getwriter('utf-8')(f, errors='replace')
447
path = self._rel_controlfilename(path)
448
ctrl_files.append((path, f))
449
self._transport.put_multi(ctrl_files)
451
def _make_control(self):
452
from bzrlib.inventory import Inventory
453
from bzrlib.weavefile import write_weave_v5
454
from bzrlib.weave import Weave
456
# Create an empty inventory
458
# if we want per-tree root ids then this is the place to set
459
# them; they're not needed for now and so ommitted for
461
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
462
empty_inv = sio.getvalue()
464
bzrlib.weavefile.write_weave_v5(Weave(), sio)
465
empty_weave = sio.getvalue()
467
dirs = [[], 'revision-store', 'weaves']
469
"This is a Bazaar-NG control directory.\n"
470
"Do not change any files in this directory.\n"),
471
('branch-format', BZR_BRANCH_FORMAT_6),
472
('revision-history', ''),
475
('pending-merges', ''),
476
('inventory', empty_inv),
477
('inventory.weave', empty_weave),
478
('ancestry.weave', empty_weave)
480
cfn = self._rel_controlfilename
481
self._transport.mkdir_multi([cfn(d) for d in dirs])
482
self.put_controlfiles(files)
483
mutter('created control directory in ' + self._transport.base)
485
def _check_format(self, relax_version_check):
486
"""Check this branch format is supported.
488
The format level is stored, as an integer, in
489
self._branch_format for code that needs to check it later.
491
In the future, we might need different in-memory Branch
492
classes to support downlevel branches. But not yet.
495
fmt = self.controlfile('branch-format', 'r').read()
497
raise NotBranchError(path=self.base)
498
mutter("got branch format %r", fmt)
499
if fmt == BZR_BRANCH_FORMAT_6:
500
self._branch_format = 6
501
elif fmt == BZR_BRANCH_FORMAT_5:
502
self._branch_format = 5
503
elif fmt == BZR_BRANCH_FORMAT_4:
504
self._branch_format = 4
506
if (not relax_version_check
507
and self._branch_format not in (5, 6)):
508
raise errors.UnsupportedFormatError(
509
'sorry, branch format %r not supported' % fmt,
510
['use a different bzr version',
511
'or remove the .bzr directory'
512
' and "bzr init" again'])
514
def get_root_id(self):
515
"""Return the id of this branches root"""
516
inv = self.read_working_inventory()
517
return inv.root.file_id
519
def set_root_id(self, file_id):
520
inv = self.read_working_inventory()
521
orig_root_id = inv.root.file_id
522
del inv._byid[inv.root.file_id]
523
inv.root.file_id = file_id
524
inv._byid[inv.root.file_id] = inv.root
527
if entry.parent_id in (None, orig_root_id):
528
entry.parent_id = inv.root.file_id
529
self._write_inventory(inv)
532
def read_working_inventory(self):
533
"""Read the working inventory."""
534
# ElementTree does its own conversion from UTF-8, so open in
536
f = self.controlfile('inventory', 'rb')
537
return bzrlib.xml5.serializer_v5.read_inventory(f)
540
def _write_inventory(self, inv):
541
"""Update the working inventory.
543
That is to say, the inventory describing changes underway, that
544
will be committed to the next revision.
546
from cStringIO import StringIO
548
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
550
# Transport handles atomicity
551
self.put_controlfile('inventory', sio)
553
mutter('wrote working inventory')
555
inventory = property(read_working_inventory, _write_inventory, None,
556
"""Inventory for the working copy.""")
559
def add(self, files, ids=None):
560
"""Make files versioned.
562
Note that the command line normally calls smart_add instead,
563
which can automatically recurse.
565
This puts the files in the Added state, so that they will be
566
recorded by the next commit.
569
List of paths to add, relative to the base of the tree.
572
If set, use these instead of automatically generated ids.
573
Must be the same length as the list of files, but may
574
contain None for ids that are to be autogenerated.
576
TODO: Perhaps have an option to add the ids even if the files do
579
TODO: Perhaps yield the ids and paths as they're added.
581
# TODO: Re-adding a file that is removed in the working copy
582
# should probably put it back with the previous ID.
583
if isinstance(files, basestring):
584
assert(ids is None or isinstance(ids, basestring))
590
ids = [None] * len(files)
592
assert(len(ids) == len(files))
594
inv = self.read_working_inventory()
595
for f,file_id in zip(files, ids):
596
if is_control_file(f):
597
raise BzrError("cannot add control file %s" % quotefn(f))
602
raise BzrError("cannot add top-level %r" % f)
604
fullpath = os.path.normpath(self.abspath(f))
607
kind = file_kind(fullpath)
609
# maybe something better?
610
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
612
if not InventoryEntry.versionable_kind(kind):
613
raise BzrError('cannot add: not a versionable file ('
614
'i.e. regular file, symlink or directory): %s' % quotefn(f))
617
file_id = gen_file_id(f)
618
inv.add_path(f, kind=kind, file_id=file_id)
620
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
622
self._write_inventory(inv)
625
def print_file(self, file, revno):
626
"""Print `file` to stdout."""
627
tree = self.revision_tree(self.get_rev_id(revno))
628
# use inventory as it was in that revision
629
file_id = tree.inventory.path2id(file)
631
raise BzrError("%r is not present in revision %s" % (file, revno))
632
tree.print_file(file_id)
634
# FIXME: this doesn't need to be a branch method
635
def set_inventory(self, new_inventory_list):
636
from bzrlib.inventory import Inventory, InventoryEntry
637
inv = Inventory(self.get_root_id())
638
for path, file_id, parent, kind in new_inventory_list:
639
name = os.path.basename(path)
642
# fixme, there should be a factory function inv,add_??
643
if kind == 'directory':
644
inv.add(inventory.InventoryDirectory(file_id, name, parent))
646
inv.add(inventory.InventoryFile(file_id, name, parent))
647
elif kind == 'symlink':
648
inv.add(inventory.InventoryLink(file_id, name, parent))
650
raise BzrError("unknown kind %r" % kind)
651
self._write_inventory(inv)
654
"""Return all unknown files.
656
These are files in the working directory that are not versioned or
657
control files or ignored.
659
>>> from bzrlib.workingtree import WorkingTree
660
>>> b = ScratchBranch(files=['foo', 'foo~'])
661
>>> map(str, b.unknowns())
664
>>> list(b.unknowns())
666
>>> WorkingTree(b.base, b).remove('foo')
667
>>> list(b.unknowns())
670
return self.working_tree().unknowns()
673
def append_revision(self, *revision_ids):
674
for revision_id in revision_ids:
675
mutter("add {%s} to revision-history" % revision_id)
676
rev_history = self.revision_history()
677
rev_history.extend(revision_ids)
678
self.put_controlfile('revision-history', '\n'.join(rev_history))
680
def has_revision(self, revision_id):
681
"""True if this branch has a copy of the revision.
683
This does not necessarily imply the revision is merge
684
or on the mainline."""
685
return (revision_id is None
686
or self.revision_store.has_id(revision_id))
689
def get_revision_xml_file(self, revision_id):
690
"""Return XML file object for revision object."""
691
if not revision_id or not isinstance(revision_id, basestring):
692
raise InvalidRevisionId(revision_id)
694
return self.revision_store.get(revision_id)
695
except (IndexError, KeyError):
696
raise bzrlib.errors.NoSuchRevision(self, revision_id)
699
get_revision_xml = get_revision_xml_file
701
def get_revision_xml(self, revision_id):
702
return self.get_revision_xml_file(revision_id).read()
705
def get_revision(self, revision_id):
706
"""Return the Revision object for a named revision"""
707
xml_file = self.get_revision_xml_file(revision_id)
710
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
711
except SyntaxError, e:
712
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
716
assert r.revision_id == revision_id
719
def get_revision_delta(self, revno):
720
"""Return the delta for one revision.
722
The delta is relative to its mainline predecessor, or the
723
empty tree for revision 1.
725
assert isinstance(revno, int)
726
rh = self.revision_history()
727
if not (1 <= revno <= len(rh)):
728
raise InvalidRevisionNumber(revno)
730
# revno is 1-based; list is 0-based
732
new_tree = self.revision_tree(rh[revno-1])
734
old_tree = EmptyTree()
736
old_tree = self.revision_tree(rh[revno-2])
738
return compare_trees(old_tree, new_tree)
740
def get_revision_sha1(self, revision_id):
741
"""Hash the stored value of a revision, and return it."""
742
# In the future, revision entries will be signed. At that
743
# point, it is probably best *not* to include the signature
744
# in the revision hash. Because that lets you re-sign
745
# the revision, (add signatures/remove signatures) and still
746
# have all hash pointers stay consistent.
747
# But for now, just hash the contents.
748
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
750
def get_ancestry(self, revision_id):
751
"""Return a list of revision-ids integrated by a revision.
753
This currently returns a list, but the ordering is not guaranteed:
756
if revision_id is None:
758
w = self.get_inventory_weave()
759
return [None] + map(w.idx_to_name,
760
w.inclusions([w.lookup(revision_id)]))
762
def get_inventory_weave(self):
763
return self.control_weaves.get_weave('inventory',
764
self.get_transaction())
766
def get_inventory(self, revision_id):
767
"""Get Inventory object by hash."""
768
xml = self.get_inventory_xml(revision_id)
769
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
771
def get_inventory_xml(self, revision_id):
772
"""Get inventory XML as a file object."""
774
assert isinstance(revision_id, basestring), type(revision_id)
775
iw = self.get_inventory_weave()
776
return iw.get_text(iw.lookup(revision_id))
778
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
780
def get_inventory_sha1(self, revision_id):
781
"""Return the sha1 hash of the inventory entry
783
return self.get_revision(revision_id).inventory_sha1
785
def get_revision_inventory(self, revision_id):
786
"""Return inventory of a past revision."""
787
# TODO: Unify this with get_inventory()
788
# bzr 0.0.6 and later imposes the constraint that the inventory_id
789
# must be the same as its revision, so this is trivial.
790
if revision_id == None:
791
return Inventory(self.get_root_id())
793
return self.get_inventory(revision_id)
796
def revision_history(self):
797
"""Return sequence of revision hashes on to this branch."""
798
transaction = self.get_transaction()
799
history = transaction.map.find_revision_history()
800
if history is not None:
801
mutter("cache hit for revision-history in %s", self)
803
history = [l.rstrip('\r\n') for l in
804
self.controlfile('revision-history', 'r').readlines()]
805
transaction.map.add_revision_history(history)
806
# this call is disabled because revision_history is
807
# not really an object yet, and the transaction is for objects.
808
# transaction.register_clean(history, precious=True)
812
"""Return current revision number for this branch.
814
That is equivalent to the number of revisions committed to
817
return len(self.revision_history())
819
def last_revision(self):
820
"""Return last patch hash, or None if no history.
822
ph = self.revision_history()
828
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
829
"""Return a list of new revisions that would perfectly fit.
831
If self and other have not diverged, return a list of the revisions
832
present in other, but missing from self.
834
>>> from bzrlib.commit import commit
835
>>> bzrlib.trace.silent = True
836
>>> br1 = ScratchBranch()
837
>>> br2 = ScratchBranch()
838
>>> br1.missing_revisions(br2)
840
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
841
>>> br1.missing_revisions(br2)
843
>>> br2.missing_revisions(br1)
845
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
846
>>> br1.missing_revisions(br2)
848
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
849
>>> br1.missing_revisions(br2)
851
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
852
>>> br1.missing_revisions(br2)
853
Traceback (most recent call last):
854
DivergedBranches: These branches have diverged.
856
self_history = self.revision_history()
857
self_len = len(self_history)
858
other_history = other.revision_history()
859
other_len = len(other_history)
860
common_index = min(self_len, other_len) -1
861
if common_index >= 0 and \
862
self_history[common_index] != other_history[common_index]:
863
raise DivergedBranches(self, other)
865
if stop_revision is None:
866
stop_revision = other_len
868
assert isinstance(stop_revision, int)
869
if stop_revision > other_len:
870
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
871
return other_history[self_len:stop_revision]
873
def update_revisions(self, other, stop_revision=None):
874
"""Pull in new perfect-fit revisions."""
875
# FIXME: If the branches have diverged, but the latest
876
# revision in this branch is completely merged into the other,
877
# then we should still be able to pull.
878
from bzrlib.fetch import greedy_fetch
879
if stop_revision is None:
880
stop_revision = other.last_revision()
881
### Should this be checking is_ancestor instead of revision_history?
882
if (stop_revision is not None and
883
stop_revision in self.revision_history()):
885
greedy_fetch(to_branch=self, from_branch=other,
886
revision=stop_revision)
887
pullable_revs = self.pullable_revisions(other, stop_revision)
888
if len(pullable_revs) > 0:
889
self.append_revision(*pullable_revs)
891
def pullable_revisions(self, other, stop_revision):
892
other_revno = other.revision_id_to_revno(stop_revision)
894
return self.missing_revisions(other, other_revno)
895
except DivergedBranches, e:
897
pullable_revs = get_intervening_revisions(self.last_revision(),
899
assert self.last_revision() not in pullable_revs
901
except bzrlib.errors.NotAncestor:
902
if is_ancestor(self.last_revision(), stop_revision, self):
907
def commit(self, *args, **kw):
908
from bzrlib.commit import Commit
909
Commit().commit(self, *args, **kw)
911
def revision_id_to_revno(self, revision_id):
912
"""Given a revision id, return its revno"""
913
if revision_id is None:
915
history = self.revision_history()
917
return history.index(revision_id) + 1
919
raise bzrlib.errors.NoSuchRevision(self, revision_id)
921
def get_rev_id(self, revno, history=None):
922
"""Find the revision id of the specified revno."""
926
history = self.revision_history()
927
elif revno <= 0 or revno > len(history):
928
raise bzrlib.errors.NoSuchRevision(self, revno)
929
return history[revno - 1]
931
def revision_tree(self, revision_id):
932
"""Return Tree for a revision on this branch.
934
`revision_id` may be None for the null revision, in which case
935
an `EmptyTree` is returned."""
936
# TODO: refactor this to use an existing revision object
937
# so we don't need to read it in twice.
938
if revision_id == None:
941
inv = self.get_revision_inventory(revision_id)
942
return RevisionTree(self.weave_store, inv, revision_id)
944
def working_tree(self):
945
"""Return a `Tree` for the working copy."""
946
from bzrlib.workingtree import WorkingTree
947
# TODO: In the future, perhaps WorkingTree should utilize Transport
948
# RobertCollins 20051003 - I don't think it should - working trees are
949
# much more complex to keep consistent than our careful .bzr subset.
950
# instead, we should say that working trees are local only, and optimise
952
return WorkingTree(self.base, branch=self)
955
def basis_tree(self):
956
"""Return `Tree` object for last revision.
958
If there are no revisions yet, return an `EmptyTree`.
960
return self.revision_tree(self.last_revision())
963
def rename_one(self, from_rel, to_rel):
966
This can change the directory or the filename or both.
968
tree = self.working_tree()
970
if not tree.has_filename(from_rel):
971
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
972
if tree.has_filename(to_rel):
973
raise BzrError("can't rename: new working file %r already exists" % to_rel)
975
file_id = inv.path2id(from_rel)
977
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
979
if inv.path2id(to_rel):
980
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
982
to_dir, to_tail = os.path.split(to_rel)
983
to_dir_id = inv.path2id(to_dir)
984
if to_dir_id == None and to_dir != '':
985
raise BzrError("can't determine destination directory id for %r" % to_dir)
987
mutter("rename_one:")
988
mutter(" file_id {%s}" % file_id)
989
mutter(" from_rel %r" % from_rel)
990
mutter(" to_rel %r" % to_rel)
991
mutter(" to_dir %r" % to_dir)
992
mutter(" to_dir_id {%s}" % to_dir_id)
994
inv.rename(file_id, to_dir_id, to_tail)
996
from_abs = self.abspath(from_rel)
997
to_abs = self.abspath(to_rel)
999
rename(from_abs, to_abs)
1001
raise BzrError("failed to rename %r to %r: %s"
1002
% (from_abs, to_abs, e[1]),
1003
["rename rolled back"])
1005
self._write_inventory(inv)
1008
def move(self, from_paths, to_name):
1011
to_name must exist as a versioned directory.
1013
If to_name exists and is a directory, the files are moved into
1014
it, keeping their old names. If it is a directory,
1016
Note that to_name is only the last component of the new name;
1017
this doesn't change the directory.
1019
This returns a list of (from_path, to_path) pairs for each
1020
entry that is moved.
1023
## TODO: Option to move IDs only
1024
assert not isinstance(from_paths, basestring)
1025
tree = self.working_tree()
1026
inv = tree.inventory
1027
to_abs = self.abspath(to_name)
1028
if not isdir(to_abs):
1029
raise BzrError("destination %r is not a directory" % to_abs)
1030
if not tree.has_filename(to_name):
1031
raise BzrError("destination %r not in working directory" % to_abs)
1032
to_dir_id = inv.path2id(to_name)
1033
if to_dir_id == None and to_name != '':
1034
raise BzrError("destination %r is not a versioned directory" % to_name)
1035
to_dir_ie = inv[to_dir_id]
1036
if to_dir_ie.kind not in ('directory', 'root_directory'):
1037
raise BzrError("destination %r is not a directory" % to_abs)
1039
to_idpath = inv.get_idpath(to_dir_id)
1041
for f in from_paths:
1042
if not tree.has_filename(f):
1043
raise BzrError("%r does not exist in working tree" % f)
1044
f_id = inv.path2id(f)
1046
raise BzrError("%r is not versioned" % f)
1047
name_tail = splitpath(f)[-1]
1048
dest_path = appendpath(to_name, name_tail)
1049
if tree.has_filename(dest_path):
1050
raise BzrError("destination %r already exists" % dest_path)
1051
if f_id in to_idpath:
1052
raise BzrError("can't move %r to a subdirectory of itself" % f)
1054
# OK, so there's a race here, it's possible that someone will
1055
# create a file in this interval and then the rename might be
1056
# left half-done. But we should have caught most problems.
1058
for f in from_paths:
1059
name_tail = splitpath(f)[-1]
1060
dest_path = appendpath(to_name, name_tail)
1061
result.append((f, dest_path))
1062
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1064
rename(self.abspath(f), self.abspath(dest_path))
1066
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1067
["rename rolled back"])
1069
self._write_inventory(inv)
1073
def revert(self, filenames, old_tree=None, backups=True):
1074
"""Restore selected files to the versions from a previous tree.
1077
If true (default) backups are made of files before
1080
from bzrlib.atomicfile import AtomicFile
1081
from bzrlib.osutils import backup_file
1083
inv = self.read_working_inventory()
1084
if old_tree is None:
1085
old_tree = self.basis_tree()
1086
old_inv = old_tree.inventory
1089
for fn in filenames:
1090
file_id = inv.path2id(fn)
1092
raise NotVersionedError(path=fn)
1093
if not old_inv.has_id(file_id):
1094
raise BzrError("file not present in old tree", fn, file_id)
1095
nids.append((fn, file_id))
1097
# TODO: Rename back if it was previously at a different location
1099
# TODO: If given a directory, restore the entire contents from
1100
# the previous version.
1102
# TODO: Make a backup to a temporary file.
1104
# TODO: If the file previously didn't exist, delete it?
1105
for fn, file_id in nids:
1108
f = AtomicFile(fn, 'wb')
1110
f.write(old_tree.get_file(file_id).read())
1116
def pending_merges(self):
1117
"""Return a list of pending merges.
1119
These are revisions that have been merged into the working
1120
directory but not yet committed.
1122
cfn = self._rel_controlfilename('pending-merges')
1123
if not self._transport.has(cfn):
1126
for l in self.controlfile('pending-merges', 'r').readlines():
1127
p.append(l.rstrip('\n'))
1131
def add_pending_merge(self, *revision_ids):
1132
# TODO: Perhaps should check at this point that the
1133
# history of the revision is actually present?
1134
p = self.pending_merges()
1136
for rev_id in revision_ids:
1142
self.set_pending_merges(p)
1145
def set_pending_merges(self, rev_list):
1146
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1148
def get_parent(self):
1149
"""Return the parent location of the branch.
1151
This is the default location for push/pull/missing. The usual
1152
pattern is that the user can override it by specifying a
1156
_locs = ['parent', 'pull', 'x-pull']
1159
return self.controlfile(l, 'r').read().strip('\n')
1161
if e.errno != errno.ENOENT:
1166
def set_parent(self, url):
1167
# TODO: Maybe delete old location files?
1168
from bzrlib.atomicfile import AtomicFile
1169
f = AtomicFile(self.controlfilename('parent'))
1176
def check_revno(self, revno):
1178
Check whether a revno corresponds to any revision.
1179
Zero (the NULL revision) is considered valid.
1182
self.check_real_revno(revno)
1184
def check_real_revno(self, revno):
1186
Check whether a revno corresponds to a real revision.
1187
Zero (the NULL revision) is considered invalid
1189
if revno < 1 or revno > self.revno():
1190
raise InvalidRevisionNumber(revno)
1192
def sign_revision(self, revision_id, gpg_strategy):
1193
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1194
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1197
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1198
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1202
class ScratchBranch(_Branch):
1203
"""Special test class: a branch that cleans up after itself.
1205
>>> b = ScratchBranch()
1209
>>> b._transport.__del__()
1214
def __init__(self, files=[], dirs=[], transport=None):
1215
"""Make a test branch.
1217
This creates a temporary directory and runs init-tree in it.
1219
If any files are listed, they are created in the working copy.
1221
if transport is None:
1222
transport = bzrlib.transport.local.ScratchTransport()
1223
super(ScratchBranch, self).__init__(transport, init=True)
1225
super(ScratchBranch, self).__init__(transport)
1228
self._transport.mkdir(d)
1231
self._transport.put(f, 'content of %s' % f)
1236
>>> orig = ScratchBranch(files=["file1", "file2"])
1237
>>> clone = orig.clone()
1238
>>> if os.name != 'nt':
1239
... os.path.samefile(orig.base, clone.base)
1241
... orig.base == clone.base
1244
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1247
from shutil import copytree
1248
from tempfile import mkdtemp
1251
copytree(self.base, base, symlinks=True)
1252
return ScratchBranch(
1253
transport=bzrlib.transport.local.ScratchTransport(base))
1256
######################################################################
1260
def is_control_file(filename):
1261
## FIXME: better check
1262
filename = os.path.normpath(filename)
1263
while filename != '':
1264
head, tail = os.path.split(filename)
1265
## mutter('check %r for control file' % ((head, tail), ))
1266
if tail == bzrlib.BZRDIR:
1268
if filename == head:
1275
def gen_file_id(name):
1276
"""Return new file id.
1278
This should probably generate proper UUIDs, but for the moment we
1279
cope with just randomness because running uuidgen every time is
1282
from binascii import hexlify
1283
from time import time
1285
# get last component
1286
idx = name.rfind('/')
1288
name = name[idx+1 : ]
1289
idx = name.rfind('\\')
1291
name = name[idx+1 : ]
1293
# make it not a hidden file
1294
name = name.lstrip('.')
1296
# remove any wierd characters; we don't escape them but rather
1297
# just pull them out
1298
name = re.sub(r'[^\w.]', '', name)
1300
s = hexlify(rand_bytes(8))
1301
return '-'.join((name, compact_date(time()), s))
1305
"""Return a new tree-root file id."""
1306
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
