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.
211
(If a string, transport.transport() will be used to
212
create a Transport object)
214
init -- If True, create new control files in a previously
215
unversioned directory. If False, the branch must already
218
relax_version_check -- If true, the usual check for the branch
219
version is not applied. This is intended only for
220
upgrade/recovery type use; it's not guaranteed that
221
all operations will work on old format branches.
223
In the test suite, creation of new trees is tested using the
224
`ScratchBranch` class.
226
assert isinstance(transport, Transport), \
227
"%r is not a Transport" % transport
228
self._transport = transport
231
self._check_format(relax_version_check)
233
def get_store(name, compressed=True, prefixed=False):
234
# FIXME: This approach of assuming stores are all entirely compressed
235
# or entirely uncompressed is tidy, but breaks upgrade from
236
# some existing branches where there's a mixture; we probably
237
# still want the option to look for both.
238
relpath = self._rel_controlfilename(name)
240
store = CompressedTextStore(self._transport.clone(relpath),
243
store = TextStore(self._transport.clone(relpath),
245
#if self._transport.should_cache():
246
# cache_path = os.path.join(self.cache_root, name)
247
# os.mkdir(cache_path)
248
# store = bzrlib.store.CachedStore(store, cache_path)
250
def get_weave(name, prefixed=False):
251
relpath = self._rel_controlfilename(name)
252
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
253
if self._transport.should_cache():
254
ws.enable_cache = True
257
if self._branch_format == 4:
258
self.inventory_store = get_store('inventory-store')
259
self.text_store = get_store('text-store')
260
self.revision_store = get_store('revision-store')
261
elif self._branch_format == 5:
262
self.control_weaves = get_weave([])
263
self.weave_store = get_weave('weaves')
264
self.revision_store = get_store('revision-store', compressed=False)
265
elif self._branch_format == 6:
266
self.control_weaves = get_weave([])
267
self.weave_store = get_weave('weaves', prefixed=True)
268
self.revision_store = get_store('revision-store', compressed=False,
270
self.revision_store.register_suffix('sig')
271
self._transaction = None
274
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
281
if self._lock_mode or self._lock:
282
# XXX: This should show something every time, and be suitable for
283
# headless operation and embedding
284
warn("branch %r was not explicitly unlocked" % self)
287
# TODO: It might be best to do this somewhere else,
288
# but it is nice for a Branch object to automatically
289
# cache it's information.
290
# Alternatively, we could have the Transport objects cache requests
291
# See the earlier discussion about how major objects (like Branch)
292
# should never expect their __del__ function to run.
293
if hasattr(self, 'cache_root') and self.cache_root is not None:
296
shutil.rmtree(self.cache_root)
299
self.cache_root = None
303
return self._transport.base
306
base = property(_get_base, doc="The URL for the root of this branch.")
308
def _finish_transaction(self):
309
"""Exit the current transaction."""
310
if self._transaction is None:
311
raise errors.LockError('Branch %s is not in a transaction' %
313
transaction = self._transaction
314
self._transaction = None
317
def get_transaction(self):
318
"""Return the current active transaction.
320
If no transaction is active, this returns a passthrough object
321
for which all data is immedaitely flushed and no caching happens.
323
if self._transaction is None:
324
return transactions.PassThroughTransaction()
326
return self._transaction
328
def _set_transaction(self, new_transaction):
329
"""Set a new active transaction."""
330
if self._transaction is not None:
331
raise errors.LockError('Branch %s is in a transaction already.' %
333
self._transaction = new_transaction
335
def lock_write(self):
336
mutter("lock write: %s (%s)", self, self._lock_count)
337
# TODO: Upgrade locking to support using a Transport,
338
# and potentially a remote locking protocol
340
if self._lock_mode != 'w':
341
raise LockError("can't upgrade to a write lock from %r" %
343
self._lock_count += 1
345
self._lock = self._transport.lock_write(
346
self._rel_controlfilename('branch-lock'))
347
self._lock_mode = 'w'
349
self._set_transaction(transactions.PassThroughTransaction())
352
mutter("lock read: %s (%s)", self, self._lock_count)
354
assert self._lock_mode in ('r', 'w'), \
355
"invalid lock mode %r" % self._lock_mode
356
self._lock_count += 1
358
self._lock = self._transport.lock_read(
359
self._rel_controlfilename('branch-lock'))
360
self._lock_mode = 'r'
362
self._set_transaction(transactions.ReadOnlyTransaction())
363
# 5K may be excessive, but hey, its a knob.
364
self.get_transaction().set_cache_size(5000)
367
mutter("unlock: %s (%s)", self, self._lock_count)
368
if not self._lock_mode:
369
raise LockError('branch %r is not locked' % (self))
371
if self._lock_count > 1:
372
self._lock_count -= 1
374
self._finish_transaction()
377
self._lock_mode = self._lock_count = None
379
def abspath(self, name):
380
"""Return absolute filename for something in the branch
382
XXX: Robert Collins 20051017 what is this used for? why is it a branch
383
method and not a tree method.
385
return self._transport.abspath(name)
387
def _rel_controlfilename(self, file_or_path):
388
if isinstance(file_or_path, basestring):
389
file_or_path = [file_or_path]
390
return [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))
397
def controlfile(self, file_or_path, mode='r'):
398
"""Open a control file for this branch.
400
There are two classes of file in the control directory: text
401
and binary. binary files are untranslated byte streams. Text
402
control files are stored with Unix newlines and in UTF-8, even
403
if the platform or locale defaults are different.
405
Controlfiles should almost never be opened in write mode but
406
rather should be atomically copied and replaced using atomicfile.
410
relpath = self._rel_controlfilename(file_or_path)
411
#TODO: codecs.open() buffers linewise, so it was overloaded with
412
# a much larger buffer, do we need to do the same for getreader/getwriter?
414
return self._transport.get(relpath)
416
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
418
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
420
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
422
raise BzrError("invalid controlfile mode %r" % mode)
424
def put_controlfile(self, path, f, encode=True):
425
"""Write an entry as a controlfile.
427
:param path: The path to put the file, relative to the .bzr control
429
:param f: A file-like or string object whose contents should be copied.
430
:param encode: If true, encode the contents as utf-8
432
self.put_controlfiles([(path, f)], encode=encode)
434
def put_controlfiles(self, files, encode=True):
435
"""Write several entries as controlfiles.
437
:param files: A list of [(path, file)] pairs, where the path is the directory
438
underneath the bzr control directory
439
:param encode: If true, encode the contents as utf-8
443
for path, f in files:
445
if isinstance(f, basestring):
446
f = f.encode('utf-8', 'replace')
448
f = codecs.getwriter('utf-8')(f, errors='replace')
449
path = self._rel_controlfilename(path)
450
ctrl_files.append((path, f))
451
self._transport.put_multi(ctrl_files)
453
def _make_control(self):
454
from bzrlib.inventory import Inventory
455
from bzrlib.weavefile import write_weave_v5
456
from bzrlib.weave import Weave
458
# Create an empty inventory
460
# if we want per-tree root ids then this is the place to set
461
# them; they're not needed for now and so ommitted for
463
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
464
empty_inv = sio.getvalue()
466
bzrlib.weavefile.write_weave_v5(Weave(), sio)
467
empty_weave = sio.getvalue()
469
dirs = [[], 'revision-store', 'weaves']
471
"This is a Bazaar-NG control directory.\n"
472
"Do not change any files in this directory.\n"),
473
('branch-format', BZR_BRANCH_FORMAT_6),
474
('revision-history', ''),
477
('pending-merges', ''),
478
('inventory', empty_inv),
479
('inventory.weave', empty_weave),
480
('ancestry.weave', empty_weave)
482
cfn = self._rel_controlfilename
483
self._transport.mkdir_multi([cfn(d) for d in dirs])
484
self.put_controlfiles(files)
485
mutter('created control directory in ' + self._transport.base)
487
def _check_format(self, relax_version_check):
488
"""Check this branch format is supported.
490
The format level is stored, as an integer, in
491
self._branch_format for code that needs to check it later.
493
In the future, we might need different in-memory Branch
494
classes to support downlevel branches. But not yet.
497
fmt = self.controlfile('branch-format', 'r').read()
499
raise NotBranchError(path=self.base)
500
mutter("got branch format %r", fmt)
501
if fmt == BZR_BRANCH_FORMAT_6:
502
self._branch_format = 6
503
elif fmt == BZR_BRANCH_FORMAT_5:
504
self._branch_format = 5
505
elif fmt == BZR_BRANCH_FORMAT_4:
506
self._branch_format = 4
508
if (not relax_version_check
509
and self._branch_format not in (5, 6)):
510
raise errors.UnsupportedFormatError(
511
'sorry, branch format %r not supported' % fmt,
512
['use a different bzr version',
513
'or remove the .bzr directory'
514
' and "bzr init" again'])
516
def get_root_id(self):
517
"""Return the id of this branches root"""
518
inv = self.read_working_inventory()
519
return inv.root.file_id
521
def set_root_id(self, file_id):
522
inv = self.read_working_inventory()
523
orig_root_id = inv.root.file_id
524
del inv._byid[inv.root.file_id]
525
inv.root.file_id = file_id
526
inv._byid[inv.root.file_id] = inv.root
529
if entry.parent_id in (None, orig_root_id):
530
entry.parent_id = inv.root.file_id
531
self._write_inventory(inv)
534
def read_working_inventory(self):
535
"""Read the working inventory."""
536
# ElementTree does its own conversion from UTF-8, so open in
538
f = self.controlfile('inventory', 'rb')
539
return bzrlib.xml5.serializer_v5.read_inventory(f)
542
def _write_inventory(self, inv):
543
"""Update the working inventory.
545
That is to say, the inventory describing changes underway, that
546
will be committed to the next revision.
548
from cStringIO import StringIO
550
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
552
# Transport handles atomicity
553
self.put_controlfile('inventory', sio)
555
mutter('wrote working inventory')
557
inventory = property(read_working_inventory, _write_inventory, None,
558
"""Inventory for the working copy.""")
561
def add(self, files, ids=None):
562
"""Make files versioned.
564
Note that the command line normally calls smart_add instead,
565
which can automatically recurse.
567
This puts the files in the Added state, so that they will be
568
recorded by the next commit.
571
List of paths to add, relative to the base of the tree.
574
If set, use these instead of automatically generated ids.
575
Must be the same length as the list of files, but may
576
contain None for ids that are to be autogenerated.
578
TODO: Perhaps have an option to add the ids even if the files do
581
TODO: Perhaps yield the ids and paths as they're added.
583
# TODO: Re-adding a file that is removed in the working copy
584
# should probably put it back with the previous ID.
585
if isinstance(files, basestring):
586
assert(ids is None or isinstance(ids, basestring))
592
ids = [None] * len(files)
594
assert(len(ids) == len(files))
596
inv = self.read_working_inventory()
597
for f,file_id in zip(files, ids):
598
if is_control_file(f):
599
raise BzrError("cannot add control file %s" % quotefn(f))
604
raise BzrError("cannot add top-level %r" % f)
606
fullpath = os.path.normpath(self.abspath(f))
609
kind = file_kind(fullpath)
611
# maybe something better?
612
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
614
if not InventoryEntry.versionable_kind(kind):
615
raise BzrError('cannot add: not a versionable file ('
616
'i.e. regular file, symlink or directory): %s' % quotefn(f))
619
file_id = gen_file_id(f)
620
inv.add_path(f, kind=kind, file_id=file_id)
622
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
624
self._write_inventory(inv)
627
def print_file(self, file, revno):
628
"""Print `file` to stdout."""
629
tree = self.revision_tree(self.get_rev_id(revno))
630
# use inventory as it was in that revision
631
file_id = tree.inventory.path2id(file)
633
raise BzrError("%r is not present in revision %s" % (file, revno))
634
tree.print_file(file_id)
636
# FIXME: this doesn't need to be a branch method
637
def set_inventory(self, new_inventory_list):
638
from bzrlib.inventory import Inventory, InventoryEntry
639
inv = Inventory(self.get_root_id())
640
for path, file_id, parent, kind in new_inventory_list:
641
name = os.path.basename(path)
644
# fixme, there should be a factory function inv,add_??
645
if kind == 'directory':
646
inv.add(inventory.InventoryDirectory(file_id, name, parent))
648
inv.add(inventory.InventoryFile(file_id, name, parent))
649
elif kind == 'symlink':
650
inv.add(inventory.InventoryLink(file_id, name, parent))
652
raise BzrError("unknown kind %r" % kind)
653
self._write_inventory(inv)
656
"""Return all unknown files.
658
These are files in the working directory that are not versioned or
659
control files or ignored.
661
>>> from bzrlib.workingtree import WorkingTree
662
>>> b = ScratchBranch(files=['foo', 'foo~'])
663
>>> map(str, b.unknowns())
666
>>> list(b.unknowns())
668
>>> WorkingTree(b.base, b).remove('foo')
669
>>> list(b.unknowns())
672
return self.working_tree().unknowns()
675
def append_revision(self, *revision_ids):
676
for revision_id in revision_ids:
677
mutter("add {%s} to revision-history" % revision_id)
678
rev_history = self.revision_history()
679
rev_history.extend(revision_ids)
680
self.set_revision_history(rev_history)
683
def set_revision_history(self, rev_history):
684
self.put_controlfile('revision-history', '\n'.join(rev_history))
686
def has_revision(self, revision_id):
687
"""True if this branch has a copy of the revision.
689
This does not necessarily imply the revision is merge
690
or on the mainline."""
691
return (revision_id is None
692
or self.revision_store.has_id(revision_id))
695
def get_revision_xml_file(self, revision_id):
696
"""Return XML file object for revision object."""
697
if not revision_id or not isinstance(revision_id, basestring):
698
raise InvalidRevisionId(revision_id)
700
return self.revision_store.get(revision_id)
701
except (IndexError, KeyError):
702
raise bzrlib.errors.NoSuchRevision(self, revision_id)
705
get_revision_xml = get_revision_xml_file
707
def get_revision_xml(self, revision_id):
708
return self.get_revision_xml_file(revision_id).read()
711
def get_revision(self, revision_id):
712
"""Return the Revision object for a named revision"""
713
xml_file = self.get_revision_xml_file(revision_id)
716
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
717
except SyntaxError, e:
718
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
722
assert r.revision_id == revision_id
725
def get_revision_delta(self, revno):
726
"""Return the delta for one revision.
728
The delta is relative to its mainline predecessor, or the
729
empty tree for revision 1.
731
assert isinstance(revno, int)
732
rh = self.revision_history()
733
if not (1 <= revno <= len(rh)):
734
raise InvalidRevisionNumber(revno)
736
# revno is 1-based; list is 0-based
738
new_tree = self.revision_tree(rh[revno-1])
740
old_tree = EmptyTree()
742
old_tree = self.revision_tree(rh[revno-2])
744
return compare_trees(old_tree, new_tree)
746
def get_revision_sha1(self, revision_id):
747
"""Hash the stored value of a revision, and return it."""
748
# In the future, revision entries will be signed. At that
749
# point, it is probably best *not* to include the signature
750
# in the revision hash. Because that lets you re-sign
751
# the revision, (add signatures/remove signatures) and still
752
# have all hash pointers stay consistent.
753
# But for now, just hash the contents.
754
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
756
def get_ancestry(self, revision_id):
757
"""Return a list of revision-ids integrated by a revision.
759
This currently returns a list, but the ordering is not guaranteed:
762
if revision_id is None:
764
w = self.get_inventory_weave()
765
return [None] + map(w.idx_to_name,
766
w.inclusions([w.lookup(revision_id)]))
768
def get_inventory_weave(self):
769
return self.control_weaves.get_weave('inventory',
770
self.get_transaction())
772
def get_inventory(self, revision_id):
773
"""Get Inventory object by hash."""
774
xml = self.get_inventory_xml(revision_id)
775
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
777
def get_inventory_xml(self, revision_id):
778
"""Get inventory XML as a file object."""
780
assert isinstance(revision_id, basestring), type(revision_id)
781
iw = self.get_inventory_weave()
782
return iw.get_text(iw.lookup(revision_id))
784
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
786
def get_inventory_sha1(self, revision_id):
787
"""Return the sha1 hash of the inventory entry
789
return self.get_revision(revision_id).inventory_sha1
791
def get_revision_inventory(self, revision_id):
792
"""Return inventory of a past revision."""
793
# TODO: Unify this with get_inventory()
794
# bzr 0.0.6 and later imposes the constraint that the inventory_id
795
# must be the same as its revision, so this is trivial.
796
if revision_id == None:
797
return Inventory(self.get_root_id())
799
return self.get_inventory(revision_id)
802
def revision_history(self):
803
"""Return sequence of revision hashes on to this branch."""
804
transaction = self.get_transaction()
805
history = transaction.map.find_revision_history()
806
if history is not None:
807
mutter("cache hit for revision-history in %s", self)
809
history = [l.rstrip('\r\n') for l in
810
self.controlfile('revision-history', 'r').readlines()]
811
transaction.map.add_revision_history(history)
812
# this call is disabled because revision_history is
813
# not really an object yet, and the transaction is for objects.
814
# transaction.register_clean(history, precious=True)
818
"""Return current revision number for this branch.
820
That is equivalent to the number of revisions committed to
823
return len(self.revision_history())
825
def last_revision(self):
826
"""Return last patch hash, or None if no history.
828
ph = self.revision_history()
834
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
835
"""Return a list of new revisions that would perfectly fit.
837
If self and other have not diverged, return a list of the revisions
838
present in other, but missing from self.
840
>>> from bzrlib.commit import commit
841
>>> bzrlib.trace.silent = True
842
>>> br1 = ScratchBranch()
843
>>> br2 = ScratchBranch()
844
>>> br1.missing_revisions(br2)
846
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
847
>>> br1.missing_revisions(br2)
849
>>> br2.missing_revisions(br1)
851
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
852
>>> br1.missing_revisions(br2)
854
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
855
>>> br1.missing_revisions(br2)
857
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
858
>>> br1.missing_revisions(br2)
859
Traceback (most recent call last):
860
DivergedBranches: These branches have diverged.
862
self_history = self.revision_history()
863
self_len = len(self_history)
864
other_history = other.revision_history()
865
other_len = len(other_history)
866
common_index = min(self_len, other_len) -1
867
if common_index >= 0 and \
868
self_history[common_index] != other_history[common_index]:
869
raise DivergedBranches(self, other)
871
if stop_revision is None:
872
stop_revision = other_len
874
assert isinstance(stop_revision, int)
875
if stop_revision > other_len:
876
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
877
return other_history[self_len:stop_revision]
879
def update_revisions(self, other, stop_revision=None):
880
"""Pull in new perfect-fit revisions."""
881
# FIXME: If the branches have diverged, but the latest
882
# revision in this branch is completely merged into the other,
883
# then we should still be able to pull.
884
from bzrlib.fetch import greedy_fetch
885
if stop_revision is None:
886
stop_revision = other.last_revision()
887
### Should this be checking is_ancestor instead of revision_history?
888
if (stop_revision is not None and
889
stop_revision in self.revision_history()):
891
greedy_fetch(to_branch=self, from_branch=other,
892
revision=stop_revision)
893
pullable_revs = self.pullable_revisions(other, stop_revision)
894
if len(pullable_revs) > 0:
895
self.append_revision(*pullable_revs)
897
def pullable_revisions(self, other, stop_revision):
898
other_revno = other.revision_id_to_revno(stop_revision)
900
return self.missing_revisions(other, other_revno)
901
except DivergedBranches, e:
903
pullable_revs = get_intervening_revisions(self.last_revision(),
905
assert self.last_revision() not in pullable_revs
907
except bzrlib.errors.NotAncestor:
908
if is_ancestor(self.last_revision(), stop_revision, self):
913
def commit(self, *args, **kw):
914
from bzrlib.commit import Commit
915
Commit().commit(self, *args, **kw)
917
def revision_id_to_revno(self, revision_id):
918
"""Given a revision id, return its revno"""
919
if revision_id is None:
921
history = self.revision_history()
923
return history.index(revision_id) + 1
925
raise bzrlib.errors.NoSuchRevision(self, revision_id)
927
def get_rev_id(self, revno, history=None):
928
"""Find the revision id of the specified revno."""
932
history = self.revision_history()
933
elif revno <= 0 or revno > len(history):
934
raise bzrlib.errors.NoSuchRevision(self, revno)
935
return history[revno - 1]
937
def revision_tree(self, revision_id):
938
"""Return Tree for a revision on this branch.
940
`revision_id` may be None for the null revision, in which case
941
an `EmptyTree` is returned."""
942
# TODO: refactor this to use an existing revision object
943
# so we don't need to read it in twice.
944
if revision_id == None:
947
inv = self.get_revision_inventory(revision_id)
948
return RevisionTree(self.weave_store, inv, revision_id)
950
def working_tree(self):
951
"""Return a `Tree` for the working copy."""
952
from bzrlib.workingtree import WorkingTree
953
# TODO: In the future, perhaps WorkingTree should utilize Transport
954
# RobertCollins 20051003 - I don't think it should - working trees are
955
# much more complex to keep consistent than our careful .bzr subset.
956
# instead, we should say that working trees are local only, and optimise
958
return WorkingTree(self.base, branch=self)
961
def basis_tree(self):
962
"""Return `Tree` object for last revision.
964
If there are no revisions yet, return an `EmptyTree`.
966
return self.revision_tree(self.last_revision())
969
def rename_one(self, from_rel, to_rel):
972
This can change the directory or the filename or both.
974
tree = self.working_tree()
976
if not tree.has_filename(from_rel):
977
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
978
if tree.has_filename(to_rel):
979
raise BzrError("can't rename: new working file %r already exists" % to_rel)
981
file_id = inv.path2id(from_rel)
983
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
985
if inv.path2id(to_rel):
986
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
988
to_dir, to_tail = os.path.split(to_rel)
989
to_dir_id = inv.path2id(to_dir)
990
if to_dir_id == None and to_dir != '':
991
raise BzrError("can't determine destination directory id for %r" % to_dir)
993
mutter("rename_one:")
994
mutter(" file_id {%s}" % file_id)
995
mutter(" from_rel %r" % from_rel)
996
mutter(" to_rel %r" % to_rel)
997
mutter(" to_dir %r" % to_dir)
998
mutter(" to_dir_id {%s}" % to_dir_id)
1000
inv.rename(file_id, to_dir_id, to_tail)
1002
from_abs = self.abspath(from_rel)
1003
to_abs = self.abspath(to_rel)
1005
rename(from_abs, to_abs)
1007
raise BzrError("failed to rename %r to %r: %s"
1008
% (from_abs, to_abs, e[1]),
1009
["rename rolled back"])
1011
self._write_inventory(inv)
1014
def move(self, from_paths, to_name):
1017
to_name must exist as a versioned directory.
1019
If to_name exists and is a directory, the files are moved into
1020
it, keeping their old names. If it is a directory,
1022
Note that to_name is only the last component of the new name;
1023
this doesn't change the directory.
1025
This returns a list of (from_path, to_path) pairs for each
1026
entry that is moved.
1029
## TODO: Option to move IDs only
1030
assert not isinstance(from_paths, basestring)
1031
tree = self.working_tree()
1032
inv = tree.inventory
1033
to_abs = self.abspath(to_name)
1034
if not isdir(to_abs):
1035
raise BzrError("destination %r is not a directory" % to_abs)
1036
if not tree.has_filename(to_name):
1037
raise BzrError("destination %r not in working directory" % to_abs)
1038
to_dir_id = inv.path2id(to_name)
1039
if to_dir_id == None and to_name != '':
1040
raise BzrError("destination %r is not a versioned directory" % to_name)
1041
to_dir_ie = inv[to_dir_id]
1042
if to_dir_ie.kind not in ('directory', 'root_directory'):
1043
raise BzrError("destination %r is not a directory" % to_abs)
1045
to_idpath = inv.get_idpath(to_dir_id)
1047
for f in from_paths:
1048
if not tree.has_filename(f):
1049
raise BzrError("%r does not exist in working tree" % f)
1050
f_id = inv.path2id(f)
1052
raise BzrError("%r is not versioned" % f)
1053
name_tail = splitpath(f)[-1]
1054
dest_path = appendpath(to_name, name_tail)
1055
if tree.has_filename(dest_path):
1056
raise BzrError("destination %r already exists" % dest_path)
1057
if f_id in to_idpath:
1058
raise BzrError("can't move %r to a subdirectory of itself" % f)
1060
# OK, so there's a race here, it's possible that someone will
1061
# create a file in this interval and then the rename might be
1062
# left half-done. But we should have caught most problems.
1064
for f in from_paths:
1065
name_tail = splitpath(f)[-1]
1066
dest_path = appendpath(to_name, name_tail)
1067
result.append((f, dest_path))
1068
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1070
rename(self.abspath(f), self.abspath(dest_path))
1072
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1073
["rename rolled back"])
1075
self._write_inventory(inv)
1079
def revert(self, filenames, old_tree=None, backups=True):
1080
"""Restore selected files to the versions from a previous tree.
1083
If true (default) backups are made of files before
1086
from bzrlib.atomicfile import AtomicFile
1087
from bzrlib.osutils import backup_file
1089
inv = self.read_working_inventory()
1090
if old_tree is None:
1091
old_tree = self.basis_tree()
1092
old_inv = old_tree.inventory
1095
for fn in filenames:
1096
file_id = inv.path2id(fn)
1098
raise NotVersionedError(path=fn)
1099
if not old_inv.has_id(file_id):
1100
raise BzrError("file not present in old tree", fn, file_id)
1101
nids.append((fn, file_id))
1103
# TODO: Rename back if it was previously at a different location
1105
# TODO: If given a directory, restore the entire contents from
1106
# the previous version.
1108
# TODO: Make a backup to a temporary file.
1110
# TODO: If the file previously didn't exist, delete it?
1111
for fn, file_id in nids:
1114
f = AtomicFile(fn, 'wb')
1116
f.write(old_tree.get_file(file_id).read())
1122
def pending_merges(self):
1123
"""Return a list of pending merges.
1125
These are revisions that have been merged into the working
1126
directory but not yet committed.
1128
cfn = self._rel_controlfilename('pending-merges')
1129
if not self._transport.has(cfn):
1132
for l in self.controlfile('pending-merges', 'r').readlines():
1133
p.append(l.rstrip('\n'))
1137
def add_pending_merge(self, *revision_ids):
1138
# TODO: Perhaps should check at this point that the
1139
# history of the revision is actually present?
1140
p = self.pending_merges()
1142
for rev_id in revision_ids:
1148
self.set_pending_merges(p)
1151
def set_pending_merges(self, rev_list):
1152
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1154
def get_parent(self):
1155
"""Return the parent location of the branch.
1157
This is the default location for push/pull/missing. The usual
1158
pattern is that the user can override it by specifying a
1162
_locs = ['parent', 'pull', 'x-pull']
1165
return self.controlfile(l, 'r').read().strip('\n')
1167
if e.errno != errno.ENOENT:
1172
def set_parent(self, url):
1173
# TODO: Maybe delete old location files?
1174
from bzrlib.atomicfile import AtomicFile
1175
f = AtomicFile(self.controlfilename('parent'))
1182
def check_revno(self, revno):
1184
Check whether a revno corresponds to any revision.
1185
Zero (the NULL revision) is considered valid.
1188
self.check_real_revno(revno)
1190
def check_real_revno(self, revno):
1192
Check whether a revno corresponds to a real revision.
1193
Zero (the NULL revision) is considered invalid
1195
if revno < 1 or revno > self.revno():
1196
raise InvalidRevisionNumber(revno)
1198
def sign_revision(self, revision_id, gpg_strategy):
1199
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1200
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1203
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1204
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1208
class ScratchBranch(_Branch):
1209
"""Special test class: a branch that cleans up after itself.
1211
>>> b = ScratchBranch()
1215
>>> b._transport.__del__()
1220
def __init__(self, files=[], dirs=[], transport=None):
1221
"""Make a test branch.
1223
This creates a temporary directory and runs init-tree in it.
1225
If any files are listed, they are created in the working copy.
1227
if transport is None:
1228
transport = bzrlib.transport.local.ScratchTransport()
1229
super(ScratchBranch, self).__init__(transport, init=True)
1231
super(ScratchBranch, self).__init__(transport)
1234
self._transport.mkdir(d)
1237
self._transport.put(f, 'content of %s' % f)
1242
>>> orig = ScratchBranch(files=["file1", "file2"])
1243
>>> clone = orig.clone()
1244
>>> if os.name != 'nt':
1245
... os.path.samefile(orig.base, clone.base)
1247
... orig.base == clone.base
1250
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1253
from shutil import copytree
1254
from tempfile import mkdtemp
1257
copytree(self.base, base, symlinks=True)
1258
return ScratchBranch(
1259
transport=bzrlib.transport.local.ScratchTransport(base))
1262
######################################################################
1266
def is_control_file(filename):
1267
## FIXME: better check
1268
filename = os.path.normpath(filename)
1269
while filename != '':
1270
head, tail = os.path.split(filename)
1271
## mutter('check %r for control file' % ((head, tail), ))
1272
if tail == bzrlib.BZRDIR:
1274
if filename == head:
1281
def gen_file_id(name):
1282
"""Return new file id.
1284
This should probably generate proper UUIDs, but for the moment we
1285
cope with just randomness because running uuidgen every time is
1288
from binascii import hexlify
1289
from time import time
1291
# get last component
1292
idx = name.rfind('/')
1294
name = name[idx+1 : ]
1295
idx = name.rfind('\\')
1297
name = name[idx+1 : ]
1299
# make it not a hidden file
1300
name = name.lstrip('.')
1302
# remove any wierd characters; we don't escape them but rather
1303
# just pull them out
1304
name = re.sub(r'[^\w.]', '', name)
1306
s = hexlify(rand_bytes(8))
1307
return '-'.join((name, compact_date(time()), s))
1311
"""Return a new tree-root file id."""
1312
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
