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 not isinstance(file_or_path, basestring):
387
file_or_path = '/'.join(file_or_path)
388
if file_or_path == '':
390
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
392
def controlfilename(self, file_or_path):
393
"""Return location relative to branch."""
394
return self._transport.abspath(self._rel_controlfilename(file_or_path))
396
def controlfile(self, file_or_path, mode='r'):
397
"""Open a control file for this branch.
399
There are two classes of file in the control directory: text
400
and binary. binary files are untranslated byte streams. Text
401
control files are stored with Unix newlines and in UTF-8, even
402
if the platform or locale defaults are different.
404
Controlfiles should almost never be opened in write mode but
405
rather should be atomically copied and replaced using atomicfile.
409
relpath = self._rel_controlfilename(file_or_path)
410
#TODO: codecs.open() buffers linewise, so it was overloaded with
411
# a much larger buffer, do we need to do the same for getreader/getwriter?
413
return self._transport.get(relpath)
415
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
417
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
419
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
421
raise BzrError("invalid controlfile mode %r" % mode)
423
def put_controlfile(self, path, f, encode=True):
424
"""Write an entry as a controlfile.
426
:param path: The path to put the file, relative to the .bzr control
428
:param f: A file-like or string object whose contents should be copied.
429
:param encode: If true, encode the contents as utf-8
431
self.put_controlfiles([(path, f)], encode=encode)
433
def put_controlfiles(self, files, encode=True):
434
"""Write several entries as controlfiles.
436
:param files: A list of [(path, file)] pairs, where the path is the directory
437
underneath the bzr control directory
438
:param encode: If true, encode the contents as utf-8
442
for path, f in files:
444
if isinstance(f, basestring):
445
f = f.encode('utf-8', 'replace')
447
f = codecs.getwriter('utf-8')(f, errors='replace')
448
path = self._rel_controlfilename(path)
449
ctrl_files.append((path, f))
450
self._transport.put_multi(ctrl_files)
452
def _make_control(self):
453
from bzrlib.inventory import Inventory
454
from bzrlib.weavefile import write_weave_v5
455
from bzrlib.weave import Weave
457
# Create an empty inventory
459
# if we want per-tree root ids then this is the place to set
460
# them; they're not needed for now and so ommitted for
462
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
463
empty_inv = sio.getvalue()
465
bzrlib.weavefile.write_weave_v5(Weave(), sio)
466
empty_weave = sio.getvalue()
468
dirs = [[], 'revision-store', 'weaves']
470
"This is a Bazaar-NG control directory.\n"
471
"Do not change any files in this directory.\n"),
472
('branch-format', BZR_BRANCH_FORMAT_6),
473
('revision-history', ''),
476
('pending-merges', ''),
477
('inventory', empty_inv),
478
('inventory.weave', empty_weave),
479
('ancestry.weave', empty_weave)
481
cfn = self._rel_controlfilename
482
self._transport.mkdir_multi([cfn(d) for d in dirs])
483
self.put_controlfiles(files)
484
mutter('created control directory in ' + self._transport.base)
486
def _check_format(self, relax_version_check):
487
"""Check this branch format is supported.
489
The format level is stored, as an integer, in
490
self._branch_format for code that needs to check it later.
492
In the future, we might need different in-memory Branch
493
classes to support downlevel branches. But not yet.
496
fmt = self.controlfile('branch-format', 'r').read()
498
raise NotBranchError(path=self.base)
499
mutter("got branch format %r", fmt)
500
if fmt == BZR_BRANCH_FORMAT_6:
501
self._branch_format = 6
502
elif fmt == BZR_BRANCH_FORMAT_5:
503
self._branch_format = 5
504
elif fmt == BZR_BRANCH_FORMAT_4:
505
self._branch_format = 4
507
if (not relax_version_check
508
and self._branch_format not in (5, 6)):
509
raise errors.UnsupportedFormatError(
510
'sorry, branch format %r not supported' % fmt,
511
['use a different bzr version',
512
'or remove the .bzr directory'
513
' and "bzr init" again'])
515
def get_root_id(self):
516
"""Return the id of this branches root"""
517
inv = self.read_working_inventory()
518
return inv.root.file_id
520
def set_root_id(self, file_id):
521
inv = self.read_working_inventory()
522
orig_root_id = inv.root.file_id
523
del inv._byid[inv.root.file_id]
524
inv.root.file_id = file_id
525
inv._byid[inv.root.file_id] = inv.root
528
if entry.parent_id in (None, orig_root_id):
529
entry.parent_id = inv.root.file_id
530
self._write_inventory(inv)
533
def read_working_inventory(self):
534
"""Read the working inventory."""
535
# ElementTree does its own conversion from UTF-8, so open in
537
f = self.controlfile('inventory', 'rb')
538
return bzrlib.xml5.serializer_v5.read_inventory(f)
541
def _write_inventory(self, inv):
542
"""Update the working inventory.
544
That is to say, the inventory describing changes underway, that
545
will be committed to the next revision.
547
from cStringIO import StringIO
549
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
551
# Transport handles atomicity
552
self.put_controlfile('inventory', sio)
554
mutter('wrote working inventory')
556
inventory = property(read_working_inventory, _write_inventory, None,
557
"""Inventory for the working copy.""")
560
def add(self, files, ids=None):
561
"""Make files versioned.
563
Note that the command line normally calls smart_add instead,
564
which can automatically recurse.
566
This puts the files in the Added state, so that they will be
567
recorded by the next commit.
570
List of paths to add, relative to the base of the tree.
573
If set, use these instead of automatically generated ids.
574
Must be the same length as the list of files, but may
575
contain None for ids that are to be autogenerated.
577
TODO: Perhaps have an option to add the ids even if the files do
580
TODO: Perhaps yield the ids and paths as they're added.
582
# TODO: Re-adding a file that is removed in the working copy
583
# should probably put it back with the previous ID.
584
if isinstance(files, basestring):
585
assert(ids is None or isinstance(ids, basestring))
591
ids = [None] * len(files)
593
assert(len(ids) == len(files))
595
inv = self.read_working_inventory()
596
for f,file_id in zip(files, ids):
597
if is_control_file(f):
598
raise BzrError("cannot add control file %s" % quotefn(f))
603
raise BzrError("cannot add top-level %r" % f)
605
fullpath = os.path.normpath(self.abspath(f))
608
kind = file_kind(fullpath)
610
# maybe something better?
611
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
613
if not InventoryEntry.versionable_kind(kind):
614
raise BzrError('cannot add: not a versionable file ('
615
'i.e. regular file, symlink or directory): %s' % quotefn(f))
618
file_id = gen_file_id(f)
619
inv.add_path(f, kind=kind, file_id=file_id)
621
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
623
self._write_inventory(inv)
626
def print_file(self, file, revno):
627
"""Print `file` to stdout."""
628
tree = self.revision_tree(self.get_rev_id(revno))
629
# use inventory as it was in that revision
630
file_id = tree.inventory.path2id(file)
632
raise BzrError("%r is not present in revision %s" % (file, revno))
633
tree.print_file(file_id)
635
# FIXME: this doesn't need to be a branch method
636
def set_inventory(self, new_inventory_list):
637
from bzrlib.inventory import Inventory, InventoryEntry
638
inv = Inventory(self.get_root_id())
639
for path, file_id, parent, kind in new_inventory_list:
640
name = os.path.basename(path)
643
# fixme, there should be a factory function inv,add_??
644
if kind == 'directory':
645
inv.add(inventory.InventoryDirectory(file_id, name, parent))
647
inv.add(inventory.InventoryFile(file_id, name, parent))
648
elif kind == 'symlink':
649
inv.add(inventory.InventoryLink(file_id, name, parent))
651
raise BzrError("unknown kind %r" % kind)
652
self._write_inventory(inv)
655
"""Return all unknown files.
657
These are files in the working directory that are not versioned or
658
control files or ignored.
660
>>> from bzrlib.workingtree import WorkingTree
661
>>> b = ScratchBranch(files=['foo', 'foo~'])
662
>>> map(str, b.unknowns())
665
>>> list(b.unknowns())
667
>>> WorkingTree(b.base, b).remove('foo')
668
>>> list(b.unknowns())
671
return self.working_tree().unknowns()
674
def append_revision(self, *revision_ids):
675
for revision_id in revision_ids:
676
mutter("add {%s} to revision-history" % revision_id)
677
rev_history = self.revision_history()
678
rev_history.extend(revision_ids)
679
self.set_revision_history(rev_history)
682
def set_revision_history(self, rev_history):
683
self.put_controlfile('revision-history', '\n'.join(rev_history))
685
def has_revision(self, revision_id):
686
"""True if this branch has a copy of the revision.
688
This does not necessarily imply the revision is merge
689
or on the mainline."""
690
return (revision_id is None
691
or self.revision_store.has_id(revision_id))
694
def get_revision_xml_file(self, revision_id):
695
"""Return XML file object for revision object."""
696
if not revision_id or not isinstance(revision_id, basestring):
697
raise InvalidRevisionId(revision_id=revision_id, branch=self)
699
return self.revision_store.get(revision_id)
700
except (IndexError, KeyError):
701
raise bzrlib.errors.NoSuchRevision(self, revision_id)
704
get_revision_xml = get_revision_xml_file
706
def get_revision_xml(self, revision_id):
707
return self.get_revision_xml_file(revision_id).read()
710
def get_revision(self, revision_id):
711
"""Return the Revision object for a named revision"""
712
xml_file = self.get_revision_xml_file(revision_id)
715
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
716
except SyntaxError, e:
717
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
721
assert r.revision_id == revision_id
724
def get_revision_delta(self, revno):
725
"""Return the delta for one revision.
727
The delta is relative to its mainline predecessor, or the
728
empty tree for revision 1.
730
assert isinstance(revno, int)
731
rh = self.revision_history()
732
if not (1 <= revno <= len(rh)):
733
raise InvalidRevisionNumber(revno)
735
# revno is 1-based; list is 0-based
737
new_tree = self.revision_tree(rh[revno-1])
739
old_tree = EmptyTree()
741
old_tree = self.revision_tree(rh[revno-2])
743
return compare_trees(old_tree, new_tree)
745
def get_revision_sha1(self, revision_id):
746
"""Hash the stored value of a revision, and return it."""
747
# In the future, revision entries will be signed. At that
748
# point, it is probably best *not* to include the signature
749
# in the revision hash. Because that lets you re-sign
750
# the revision, (add signatures/remove signatures) and still
751
# have all hash pointers stay consistent.
752
# But for now, just hash the contents.
753
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
755
def get_ancestry(self, revision_id):
756
"""Return a list of revision-ids integrated by a revision.
758
This currently returns a list, but the ordering is not guaranteed:
761
if revision_id is None:
763
w = self.get_inventory_weave()
764
return [None] + map(w.idx_to_name,
765
w.inclusions([w.lookup(revision_id)]))
767
def get_inventory_weave(self):
768
return self.control_weaves.get_weave('inventory',
769
self.get_transaction())
771
def get_inventory(self, revision_id):
772
"""Get Inventory object by hash."""
773
xml = self.get_inventory_xml(revision_id)
774
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
776
def get_inventory_xml(self, revision_id):
777
"""Get inventory XML as a file object."""
779
assert isinstance(revision_id, basestring), type(revision_id)
780
iw = self.get_inventory_weave()
781
return iw.get_text(iw.lookup(revision_id))
783
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
785
def get_inventory_sha1(self, revision_id):
786
"""Return the sha1 hash of the inventory entry
788
return self.get_revision(revision_id).inventory_sha1
790
def get_revision_inventory(self, revision_id):
791
"""Return inventory of a past revision."""
792
# TODO: Unify this with get_inventory()
793
# bzr 0.0.6 and later imposes the constraint that the inventory_id
794
# must be the same as its revision, so this is trivial.
795
if revision_id == None:
796
return Inventory(self.get_root_id())
798
return self.get_inventory(revision_id)
801
def revision_history(self):
802
"""Return sequence of revision hashes on to this branch."""
803
transaction = self.get_transaction()
804
history = transaction.map.find_revision_history()
805
if history is not None:
806
mutter("cache hit for revision-history in %s", self)
808
history = [l.rstrip('\r\n') for l in
809
self.controlfile('revision-history', 'r').readlines()]
810
transaction.map.add_revision_history(history)
811
# this call is disabled because revision_history is
812
# not really an object yet, and the transaction is for objects.
813
# transaction.register_clean(history, precious=True)
817
"""Return current revision number for this branch.
819
That is equivalent to the number of revisions committed to
822
return len(self.revision_history())
824
def last_revision(self):
825
"""Return last patch hash, or None if no history.
827
ph = self.revision_history()
833
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
834
"""Return a list of new revisions that would perfectly fit.
836
If self and other have not diverged, return a list of the revisions
837
present in other, but missing from self.
839
>>> from bzrlib.commit import commit
840
>>> bzrlib.trace.silent = True
841
>>> br1 = ScratchBranch()
842
>>> br2 = ScratchBranch()
843
>>> br1.missing_revisions(br2)
845
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
846
>>> br1.missing_revisions(br2)
848
>>> br2.missing_revisions(br1)
850
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
851
>>> br1.missing_revisions(br2)
853
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
854
>>> br1.missing_revisions(br2)
856
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
857
>>> br1.missing_revisions(br2)
858
Traceback (most recent call last):
859
DivergedBranches: These branches have diverged.
861
self_history = self.revision_history()
862
self_len = len(self_history)
863
other_history = other.revision_history()
864
other_len = len(other_history)
865
common_index = min(self_len, other_len) -1
866
if common_index >= 0 and \
867
self_history[common_index] != other_history[common_index]:
868
raise DivergedBranches(self, other)
870
if stop_revision is None:
871
stop_revision = other_len
873
assert isinstance(stop_revision, int)
874
if stop_revision > other_len:
875
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
876
return other_history[self_len:stop_revision]
878
def update_revisions(self, other, stop_revision=None):
879
"""Pull in new perfect-fit revisions."""
880
from bzrlib.fetch import greedy_fetch
881
if stop_revision is None:
882
stop_revision = other.last_revision()
883
### Should this be checking is_ancestor instead of revision_history?
884
if (stop_revision is not None and
885
stop_revision in self.revision_history()):
887
greedy_fetch(to_branch=self, from_branch=other,
888
revision=stop_revision)
889
pullable_revs = self.pullable_revisions(other, stop_revision)
890
if len(pullable_revs) > 0:
891
self.append_revision(*pullable_revs)
893
def pullable_revisions(self, other, stop_revision):
894
other_revno = other.revision_id_to_revno(stop_revision)
896
return self.missing_revisions(other, other_revno)
897
except DivergedBranches, e:
899
pullable_revs = get_intervening_revisions(self.last_revision(),
901
assert self.last_revision() not in pullable_revs
903
except bzrlib.errors.NotAncestor:
904
if is_ancestor(self.last_revision(), stop_revision, self):
909
def commit(self, *args, **kw):
910
from bzrlib.commit import Commit
911
Commit().commit(self, *args, **kw)
913
def revision_id_to_revno(self, revision_id):
914
"""Given a revision id, return its revno"""
915
if revision_id is None:
917
history = self.revision_history()
919
return history.index(revision_id) + 1
921
raise bzrlib.errors.NoSuchRevision(self, revision_id)
923
def get_rev_id(self, revno, history=None):
924
"""Find the revision id of the specified revno."""
928
history = self.revision_history()
929
elif revno <= 0 or revno > len(history):
930
raise bzrlib.errors.NoSuchRevision(self, revno)
931
return history[revno - 1]
933
def revision_tree(self, revision_id):
934
"""Return Tree for a revision on this branch.
936
`revision_id` may be None for the null revision, in which case
937
an `EmptyTree` is returned."""
938
# TODO: refactor this to use an existing revision object
939
# so we don't need to read it in twice.
940
if revision_id == None:
943
inv = self.get_revision_inventory(revision_id)
944
return RevisionTree(self.weave_store, inv, revision_id)
946
def working_tree(self):
947
"""Return a `Tree` for the working copy."""
948
from bzrlib.workingtree import WorkingTree
949
# TODO: In the future, perhaps WorkingTree should utilize Transport
950
# RobertCollins 20051003 - I don't think it should - working trees are
951
# much more complex to keep consistent than our careful .bzr subset.
952
# instead, we should say that working trees are local only, and optimise
954
return WorkingTree(self.base, branch=self)
957
def basis_tree(self):
958
"""Return `Tree` object for last revision.
960
If there are no revisions yet, return an `EmptyTree`.
962
return self.revision_tree(self.last_revision())
965
def rename_one(self, from_rel, to_rel):
968
This can change the directory or the filename or both.
970
tree = self.working_tree()
972
if not tree.has_filename(from_rel):
973
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
974
if tree.has_filename(to_rel):
975
raise BzrError("can't rename: new working file %r already exists" % to_rel)
977
file_id = inv.path2id(from_rel)
979
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
981
if inv.path2id(to_rel):
982
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
984
to_dir, to_tail = os.path.split(to_rel)
985
to_dir_id = inv.path2id(to_dir)
986
if to_dir_id == None and to_dir != '':
987
raise BzrError("can't determine destination directory id for %r" % to_dir)
989
mutter("rename_one:")
990
mutter(" file_id {%s}" % file_id)
991
mutter(" from_rel %r" % from_rel)
992
mutter(" to_rel %r" % to_rel)
993
mutter(" to_dir %r" % to_dir)
994
mutter(" to_dir_id {%s}" % to_dir_id)
996
inv.rename(file_id, to_dir_id, to_tail)
998
from_abs = self.abspath(from_rel)
999
to_abs = self.abspath(to_rel)
1001
rename(from_abs, to_abs)
1003
raise BzrError("failed to rename %r to %r: %s"
1004
% (from_abs, to_abs, e[1]),
1005
["rename rolled back"])
1007
self._write_inventory(inv)
1010
def move(self, from_paths, to_name):
1013
to_name must exist as a versioned directory.
1015
If to_name exists and is a directory, the files are moved into
1016
it, keeping their old names. If it is a directory,
1018
Note that to_name is only the last component of the new name;
1019
this doesn't change the directory.
1021
This returns a list of (from_path, to_path) pairs for each
1022
entry that is moved.
1025
## TODO: Option to move IDs only
1026
assert not isinstance(from_paths, basestring)
1027
tree = self.working_tree()
1028
inv = tree.inventory
1029
to_abs = self.abspath(to_name)
1030
if not isdir(to_abs):
1031
raise BzrError("destination %r is not a directory" % to_abs)
1032
if not tree.has_filename(to_name):
1033
raise BzrError("destination %r not in working directory" % to_abs)
1034
to_dir_id = inv.path2id(to_name)
1035
if to_dir_id == None and to_name != '':
1036
raise BzrError("destination %r is not a versioned directory" % to_name)
1037
to_dir_ie = inv[to_dir_id]
1038
if to_dir_ie.kind not in ('directory', 'root_directory'):
1039
raise BzrError("destination %r is not a directory" % to_abs)
1041
to_idpath = inv.get_idpath(to_dir_id)
1043
for f in from_paths:
1044
if not tree.has_filename(f):
1045
raise BzrError("%r does not exist in working tree" % f)
1046
f_id = inv.path2id(f)
1048
raise BzrError("%r is not versioned" % f)
1049
name_tail = splitpath(f)[-1]
1050
dest_path = appendpath(to_name, name_tail)
1051
if tree.has_filename(dest_path):
1052
raise BzrError("destination %r already exists" % dest_path)
1053
if f_id in to_idpath:
1054
raise BzrError("can't move %r to a subdirectory of itself" % f)
1056
# OK, so there's a race here, it's possible that someone will
1057
# create a file in this interval and then the rename might be
1058
# left half-done. But we should have caught most problems.
1060
for f in from_paths:
1061
name_tail = splitpath(f)[-1]
1062
dest_path = appendpath(to_name, name_tail)
1063
result.append((f, dest_path))
1064
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1066
rename(self.abspath(f), self.abspath(dest_path))
1068
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1069
["rename rolled back"])
1071
self._write_inventory(inv)
1075
def revert(self, filenames, old_tree=None, backups=True):
1076
"""Restore selected files to the versions from a previous tree.
1079
If true (default) backups are made of files before
1082
from bzrlib.atomicfile import AtomicFile
1083
from bzrlib.osutils import backup_file
1085
inv = self.read_working_inventory()
1086
if old_tree is None:
1087
old_tree = self.basis_tree()
1088
old_inv = old_tree.inventory
1091
for fn in filenames:
1092
file_id = inv.path2id(fn)
1094
raise NotVersionedError(path=fn)
1095
if not old_inv.has_id(file_id):
1096
raise BzrError("file not present in old tree", fn, file_id)
1097
nids.append((fn, file_id))
1099
# TODO: Rename back if it was previously at a different location
1101
# TODO: If given a directory, restore the entire contents from
1102
# the previous version.
1104
# TODO: Make a backup to a temporary file.
1106
# TODO: If the file previously didn't exist, delete it?
1107
for fn, file_id in nids:
1110
f = AtomicFile(fn, 'wb')
1112
f.write(old_tree.get_file(file_id).read())
1118
def pending_merges(self):
1119
"""Return a list of pending merges.
1121
These are revisions that have been merged into the working
1122
directory but not yet committed.
1124
cfn = self._rel_controlfilename('pending-merges')
1125
if not self._transport.has(cfn):
1128
for l in self.controlfile('pending-merges', 'r').readlines():
1129
p.append(l.rstrip('\n'))
1133
def add_pending_merge(self, *revision_ids):
1134
# TODO: Perhaps should check at this point that the
1135
# history of the revision is actually present?
1136
p = self.pending_merges()
1138
for rev_id in revision_ids:
1144
self.set_pending_merges(p)
1147
def set_pending_merges(self, rev_list):
1148
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1150
def get_parent(self):
1151
"""Return the parent location of the branch.
1153
This is the default location for push/pull/missing. The usual
1154
pattern is that the user can override it by specifying a
1158
_locs = ['parent', 'pull', 'x-pull']
1161
return self.controlfile(l, 'r').read().strip('\n')
1163
if e.errno != errno.ENOENT:
1168
def set_parent(self, url):
1169
# TODO: Maybe delete old location files?
1170
from bzrlib.atomicfile import AtomicFile
1171
f = AtomicFile(self.controlfilename('parent'))
1178
def check_revno(self, revno):
1180
Check whether a revno corresponds to any revision.
1181
Zero (the NULL revision) is considered valid.
1184
self.check_real_revno(revno)
1186
def check_real_revno(self, revno):
1188
Check whether a revno corresponds to a real revision.
1189
Zero (the NULL revision) is considered invalid
1191
if revno < 1 or revno > self.revno():
1192
raise InvalidRevisionNumber(revno)
1194
def sign_revision(self, revision_id, gpg_strategy):
1195
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1196
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1199
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1200
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1204
class ScratchBranch(_Branch):
1205
"""Special test class: a branch that cleans up after itself.
1207
>>> b = ScratchBranch()
1211
>>> b._transport.__del__()
1216
def __init__(self, files=[], dirs=[], transport=None):
1217
"""Make a test branch.
1219
This creates a temporary directory and runs init-tree in it.
1221
If any files are listed, they are created in the working copy.
1223
if transport is None:
1224
transport = bzrlib.transport.local.ScratchTransport()
1225
super(ScratchBranch, self).__init__(transport, init=True)
1227
super(ScratchBranch, self).__init__(transport)
1230
self._transport.mkdir(d)
1233
self._transport.put(f, 'content of %s' % f)
1238
>>> orig = ScratchBranch(files=["file1", "file2"])
1239
>>> clone = orig.clone()
1240
>>> if os.name != 'nt':
1241
... os.path.samefile(orig.base, clone.base)
1243
... orig.base == clone.base
1246
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1249
from shutil import copytree
1250
from tempfile import mkdtemp
1253
copytree(self.base, base, symlinks=True)
1254
return ScratchBranch(
1255
transport=bzrlib.transport.local.ScratchTransport(base))
1258
######################################################################
1262
def is_control_file(filename):
1263
## FIXME: better check
1264
filename = os.path.normpath(filename)
1265
while filename != '':
1266
head, tail = os.path.split(filename)
1267
## mutter('check %r for control file' % ((head, tail), ))
1268
if tail == bzrlib.BZRDIR:
1270
if filename == head:
1277
def gen_file_id(name):
1278
"""Return new file id.
1280
This should probably generate proper UUIDs, but for the moment we
1281
cope with just randomness because running uuidgen every time is
1284
from binascii import hexlify
1285
from time import time
1287
# get last component
1288
idx = name.rfind('/')
1290
name = name[idx+1 : ]
1291
idx = name.rfind('\\')
1293
name = name[idx+1 : ]
1295
# make it not a hidden file
1296
name = name.lstrip('.')
1298
# remove any wierd characters; we don't escape them but rather
1299
# just pull them out
1300
name = re.sub(r'[^\w.]', '', name)
1302
s = hexlify(rand_bytes(8))
1303
return '-'.join((name, compact_date(time()), s))
1307
"""Return a new tree-root file id."""
1308
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
