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
22
from warnings import warn
23
from cStringIO import StringIO
27
from bzrlib.inventory import InventoryEntry
28
import bzrlib.inventory as inventory
29
from bzrlib.trace import mutter, note
30
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
31
rename, splitpath, sha_file, appendpath,
33
import bzrlib.errors as errors
34
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
35
NoSuchRevision, HistoryMissing, NotBranchError,
36
DivergedBranches, LockError, UnlistableStore,
37
UnlistableBranch, NoSuchFile, NotVersionedError,
39
from bzrlib.textui import show_status
40
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
43
from bzrlib.delta import compare_trees
44
from bzrlib.tree import EmptyTree, RevisionTree
45
from bzrlib.inventory import Inventory
46
from bzrlib.store import copy_all
47
from bzrlib.store.compressed_text import CompressedTextStore
48
from bzrlib.store.text import TextStore
49
from bzrlib.store.weave import WeaveStore
50
from bzrlib.testament import Testament
51
import bzrlib.transactions as transactions
52
from bzrlib.transport import Transport, get_transport
57
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
58
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
59
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
60
## TODO: Maybe include checks for common corruption of newlines, etc?
63
# TODO: Some operations like log might retrieve the same revisions
64
# repeatedly to calculate deltas. We could perhaps have a weakref
65
# cache in memory to make this faster. In general anything can be
66
# cached in memory between lock and unlock operations.
68
def find_branch(*ignored, **ignored_too):
69
# XXX: leave this here for about one release, then remove it
70
raise NotImplementedError('find_branch() is not supported anymore, '
71
'please use one of the new branch constructors')
74
def needs_read_lock(unbound):
75
"""Decorate unbound to take out and release a read lock."""
76
def decorated(self, *args, **kwargs):
79
return unbound(self, *args, **kwargs)
85
def needs_write_lock(unbound):
86
"""Decorate unbound to take out and release a write lock."""
87
def decorated(self, *args, **kwargs):
90
return unbound(self, *args, **kwargs)
95
######################################################################
99
"""Branch holding a history of revisions.
102
Base directory/url of the branch.
106
def __init__(self, *ignored, **ignored_too):
107
raise NotImplementedError('The Branch class is abstract')
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format.
113
Only local branches are supported."""
114
return _Branch(get_transport(base), relax_version_check=True)
118
"""Open an existing branch, rooted at 'base' (url)"""
119
t = get_transport(base)
120
mutter("trying to open %r with transport %r", base, t)
124
def open_containing(url):
125
"""Open an existing branch which contains url.
127
This probes for a branch at url, and searches upwards from there.
129
Basically we keep looking up until we find the control directory or
130
run into the root. If there isn't one, raises NotBranchError.
131
If there is one, it is returned, along with the unused portion of url.
133
t = get_transport(url)
136
return _Branch(t), t.relpath(url)
137
except NotBranchError:
139
new_t = t.clone('..')
140
if new_t.base == t.base:
141
# reached the root, whatever that may be
142
raise NotBranchError(path=url)
146
def initialize(base):
147
"""Create a new branch, rooted at 'base' (url)"""
148
t = get_transport(base)
149
return _Branch(t, init=True)
151
def setup_caching(self, cache_root):
152
"""Subclasses that care about caching should override this, and set
153
up cached stores located under cache_root.
155
self.cache_root = cache_root
158
class _Branch(Branch):
159
"""A branch stored in the actual filesystem.
161
Note that it's "local" in the context of the filesystem; it doesn't
162
really matter if it's on an nfs/smb/afs/coda/... share, as long as
163
it's writable, and can be accessed via the normal filesystem API.
169
If _lock_mode is true, a positive count of the number of times the
173
Lock object from bzrlib.lock.
175
# We actually expect this class to be somewhat short-lived; part of its
176
# purpose is to try to isolate what bits of the branch logic are tied to
177
# filesystem access, so that in a later step, we can extricate them to
178
# a separarte ("storage") class.
182
_inventory_weave = None
184
# Map some sort of prefix into a namespace
185
# stuff like "revno:10", "revid:", etc.
186
# This should match a prefix with a function which accepts
187
REVISION_NAMESPACES = {}
189
def push_stores(self, branch_to):
190
"""Copy the content of this branches store to branch_to."""
191
if (self._branch_format != branch_to._branch_format
192
or self._branch_format != 4):
193
from bzrlib.fetch import greedy_fetch
194
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
195
self, self._branch_format, branch_to, branch_to._branch_format)
196
greedy_fetch(to_branch=branch_to, from_branch=self,
197
revision=self.last_revision())
200
store_pairs = ((self.text_store, branch_to.text_store),
201
(self.inventory_store, branch_to.inventory_store),
202
(self.revision_store, branch_to.revision_store))
204
for from_store, to_store in store_pairs:
205
copy_all(from_store, to_store)
206
except UnlistableStore:
207
raise UnlistableBranch(from_store)
209
def __init__(self, transport, init=False,
210
relax_version_check=False):
211
"""Create new branch object at a particular location.
213
transport -- A Transport object, defining how to access files.
215
init -- If True, create new control files in a previously
216
unversioned directory. If False, the branch must already
219
relax_version_check -- If true, the usual check for the branch
220
version is not applied. This is intended only for
221
upgrade/recovery type use; it's not guaranteed that
222
all operations will work on old format branches.
224
In the test suite, creation of new trees is tested using the
225
`ScratchBranch` class.
227
assert isinstance(transport, Transport), \
228
"%r is not a Transport" % transport
229
self._transport = transport
232
self._check_format(relax_version_check)
234
def get_store(name, compressed=True, prefixed=False):
235
# FIXME: This approach of assuming stores are all entirely compressed
236
# or entirely uncompressed is tidy, but breaks upgrade from
237
# some existing branches where there's a mixture; we probably
238
# still want the option to look for both.
239
relpath = self._rel_controlfilename(name)
241
store = CompressedTextStore(self._transport.clone(relpath),
244
store = TextStore(self._transport.clone(relpath),
246
#if self._transport.should_cache():
247
# cache_path = os.path.join(self.cache_root, name)
248
# os.mkdir(cache_path)
249
# store = bzrlib.store.CachedStore(store, cache_path)
251
def get_weave(name, prefixed=False):
252
relpath = self._rel_controlfilename(name)
253
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
254
if self._transport.should_cache():
255
ws.enable_cache = True
258
if self._branch_format == 4:
259
self.inventory_store = get_store('inventory-store')
260
self.text_store = get_store('text-store')
261
self.revision_store = get_store('revision-store')
262
elif self._branch_format == 5:
263
self.control_weaves = get_weave('')
264
self.weave_store = get_weave('weaves')
265
self.revision_store = get_store('revision-store', compressed=False)
266
elif self._branch_format == 6:
267
self.control_weaves = get_weave('')
268
self.weave_store = get_weave('weaves', prefixed=True)
269
self.revision_store = get_store('revision-store', compressed=False,
271
self.revision_store.register_suffix('sig')
272
self._transaction = None
275
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
280
if self._lock_mode or self._lock:
281
# XXX: This should show something every time, and be suitable for
282
# headless operation and embedding
283
warn("branch %r was not explicitly unlocked" % self)
286
# TODO: It might be best to do this somewhere else,
287
# but it is nice for a Branch object to automatically
288
# cache it's information.
289
# Alternatively, we could have the Transport objects cache requests
290
# See the earlier discussion about how major objects (like Branch)
291
# should never expect their __del__ function to run.
292
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.get_inventory(self.last_revision())
518
return inv.root.file_id
521
def set_root_id(self, file_id):
522
inv = self.working_tree().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 _write_inventory(self, inv):
535
"""Update the working inventory.
537
That is to say, the inventory describing changes underway, that
538
will be committed to the next revision.
540
from cStringIO import StringIO
542
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
544
# Transport handles atomicity
545
self.put_controlfile('inventory', sio)
547
mutter('wrote working inventory')
550
def add(self, files, ids=None):
551
"""Make files versioned.
553
Note that the command line normally calls smart_add instead,
554
which can automatically recurse.
556
This puts the files in the Added state, so that they will be
557
recorded by the next commit.
560
List of paths to add, relative to the base of the tree.
563
If set, use these instead of automatically generated ids.
564
Must be the same length as the list of files, but may
565
contain None for ids that are to be autogenerated.
567
TODO: Perhaps have an option to add the ids even if the files do
570
TODO: Perhaps yield the ids and paths as they're added.
572
# TODO: Re-adding a file that is removed in the working copy
573
# should probably put it back with the previous ID.
574
if isinstance(files, basestring):
575
assert(ids is None or isinstance(ids, basestring))
581
ids = [None] * len(files)
583
assert(len(ids) == len(files))
585
inv = self.working_tree().read_working_inventory()
586
for f,file_id in zip(files, ids):
587
if is_control_file(f):
588
raise BzrError("cannot add control file %s" % quotefn(f))
593
raise BzrError("cannot add top-level %r" % f)
595
fullpath = os.path.normpath(self.abspath(f))
598
kind = file_kind(fullpath)
600
# maybe something better?
601
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
603
if not InventoryEntry.versionable_kind(kind):
604
raise BzrError('cannot add: not a versionable file ('
605
'i.e. regular file, symlink or directory): %s' % quotefn(f))
608
file_id = gen_file_id(f)
609
inv.add_path(f, kind=kind, file_id=file_id)
611
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
613
self._write_inventory(inv)
616
def print_file(self, file, revno):
617
"""Print `file` to stdout."""
618
tree = self.revision_tree(self.get_rev_id(revno))
619
# use inventory as it was in that revision
620
file_id = tree.inventory.path2id(file)
622
raise BzrError("%r is not present in revision %s" % (file, revno))
623
tree.print_file(file_id)
626
"""Return all unknown files.
628
These are files in the working directory that are not versioned or
629
control files or ignored.
631
>>> from bzrlib.workingtree import WorkingTree
632
>>> b = ScratchBranch(files=['foo', 'foo~'])
633
>>> map(str, b.unknowns())
636
>>> list(b.unknowns())
638
>>> WorkingTree(b.base, b).remove('foo')
639
>>> list(b.unknowns())
642
return self.working_tree().unknowns()
645
def append_revision(self, *revision_ids):
646
for revision_id in revision_ids:
647
mutter("add {%s} to revision-history" % revision_id)
648
rev_history = self.revision_history()
649
rev_history.extend(revision_ids)
650
self.set_revision_history(rev_history)
653
def set_revision_history(self, rev_history):
654
self.put_controlfile('revision-history', '\n'.join(rev_history))
656
def has_revision(self, revision_id):
657
"""True if this branch has a copy of the revision.
659
This does not necessarily imply the revision is merge
660
or on the mainline."""
661
return (revision_id is None
662
or self.revision_store.has_id(revision_id))
665
def get_revision_xml_file(self, revision_id):
666
"""Return XML file object for revision object."""
667
if not revision_id or not isinstance(revision_id, basestring):
668
raise InvalidRevisionId(revision_id=revision_id, branch=self)
670
return self.revision_store.get(revision_id)
671
except (IndexError, KeyError):
672
raise bzrlib.errors.NoSuchRevision(self, revision_id)
675
get_revision_xml = get_revision_xml_file
677
def get_revision_xml(self, revision_id):
678
return self.get_revision_xml_file(revision_id).read()
681
def get_revision(self, revision_id):
682
"""Return the Revision object for a named revision"""
683
xml_file = self.get_revision_xml_file(revision_id)
686
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
687
except SyntaxError, e:
688
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
692
assert r.revision_id == revision_id
695
def get_revision_delta(self, revno):
696
"""Return the delta for one revision.
698
The delta is relative to its mainline predecessor, or the
699
empty tree for revision 1.
701
assert isinstance(revno, int)
702
rh = self.revision_history()
703
if not (1 <= revno <= len(rh)):
704
raise InvalidRevisionNumber(revno)
706
# revno is 1-based; list is 0-based
708
new_tree = self.revision_tree(rh[revno-1])
710
old_tree = EmptyTree()
712
old_tree = self.revision_tree(rh[revno-2])
714
return compare_trees(old_tree, new_tree)
716
def get_revision_sha1(self, revision_id):
717
"""Hash the stored value of a revision, and return it."""
718
# In the future, revision entries will be signed. At that
719
# point, it is probably best *not* to include the signature
720
# in the revision hash. Because that lets you re-sign
721
# the revision, (add signatures/remove signatures) and still
722
# have all hash pointers stay consistent.
723
# But for now, just hash the contents.
724
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
726
def get_ancestry(self, revision_id):
727
"""Return a list of revision-ids integrated by a revision.
729
This currently returns a list, but the ordering is not guaranteed:
732
if revision_id is None:
734
w = self.get_inventory_weave()
735
return [None] + map(w.idx_to_name,
736
w.inclusions([w.lookup(revision_id)]))
738
def get_inventory_weave(self):
739
return self.control_weaves.get_weave('inventory',
740
self.get_transaction())
742
def get_inventory(self, revision_id):
743
"""Get Inventory object by hash."""
744
xml = self.get_inventory_xml(revision_id)
745
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
747
def get_inventory_xml(self, revision_id):
748
"""Get inventory XML as a file object."""
750
assert isinstance(revision_id, basestring), type(revision_id)
751
iw = self.get_inventory_weave()
752
return iw.get_text(iw.lookup(revision_id))
754
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
756
def get_inventory_sha1(self, revision_id):
757
"""Return the sha1 hash of the inventory entry
759
return self.get_revision(revision_id).inventory_sha1
761
def get_revision_inventory(self, revision_id):
762
"""Return inventory of a past revision."""
763
# TODO: Unify this with get_inventory()
764
# bzr 0.0.6 and later imposes the constraint that the inventory_id
765
# must be the same as its revision, so this is trivial.
766
if revision_id == None:
767
# This does not make sense: if there is no revision,
768
# then it is the current tree inventory surely ?!
769
# and thus get_root_id() is something that looks at the last
770
# commit on the branch, and the get_root_id is an inventory check.
771
raise NotImplementedError
772
# return Inventory(self.get_root_id())
774
return self.get_inventory(revision_id)
777
def revision_history(self):
778
"""Return sequence of revision hashes on to this branch."""
779
transaction = self.get_transaction()
780
history = transaction.map.find_revision_history()
781
if history is not None:
782
mutter("cache hit for revision-history in %s", self)
784
history = [l.rstrip('\r\n') for l in
785
self.controlfile('revision-history', 'r').readlines()]
786
transaction.map.add_revision_history(history)
787
# this call is disabled because revision_history is
788
# not really an object yet, and the transaction is for objects.
789
# transaction.register_clean(history, precious=True)
793
"""Return current revision number for this branch.
795
That is equivalent to the number of revisions committed to
798
return len(self.revision_history())
800
def last_revision(self):
801
"""Return last patch hash, or None if no history.
803
ph = self.revision_history()
809
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
810
"""Return a list of new revisions that would perfectly fit.
812
If self and other have not diverged, return a list of the revisions
813
present in other, but missing from self.
815
>>> from bzrlib.commit import commit
816
>>> bzrlib.trace.silent = True
817
>>> br1 = ScratchBranch()
818
>>> br2 = ScratchBranch()
819
>>> br1.missing_revisions(br2)
821
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
822
>>> br1.missing_revisions(br2)
824
>>> br2.missing_revisions(br1)
826
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
827
>>> br1.missing_revisions(br2)
829
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
830
>>> br1.missing_revisions(br2)
832
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
833
>>> br1.missing_revisions(br2)
834
Traceback (most recent call last):
835
DivergedBranches: These branches have diverged.
837
self_history = self.revision_history()
838
self_len = len(self_history)
839
other_history = other.revision_history()
840
other_len = len(other_history)
841
common_index = min(self_len, other_len) -1
842
if common_index >= 0 and \
843
self_history[common_index] != other_history[common_index]:
844
raise DivergedBranches(self, other)
846
if stop_revision is None:
847
stop_revision = other_len
849
assert isinstance(stop_revision, int)
850
if stop_revision > other_len:
851
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
852
return other_history[self_len:stop_revision]
854
def update_revisions(self, other, stop_revision=None):
855
"""Pull in new perfect-fit revisions."""
856
from bzrlib.fetch import greedy_fetch
857
if stop_revision is None:
858
stop_revision = other.last_revision()
859
### Should this be checking is_ancestor instead of revision_history?
860
if (stop_revision is not None and
861
stop_revision in self.revision_history()):
863
greedy_fetch(to_branch=self, from_branch=other,
864
revision=stop_revision)
865
pullable_revs = self.pullable_revisions(other, stop_revision)
866
if len(pullable_revs) > 0:
867
self.append_revision(*pullable_revs)
869
def pullable_revisions(self, other, stop_revision):
870
other_revno = other.revision_id_to_revno(stop_revision)
872
return self.missing_revisions(other, other_revno)
873
except DivergedBranches, e:
875
pullable_revs = get_intervening_revisions(self.last_revision(),
877
assert self.last_revision() not in pullable_revs
879
except bzrlib.errors.NotAncestor:
880
if is_ancestor(self.last_revision(), stop_revision, self):
885
def commit(self, *args, **kw):
886
from bzrlib.commit import Commit
887
Commit().commit(self, *args, **kw)
889
def revision_id_to_revno(self, revision_id):
890
"""Given a revision id, return its revno"""
891
if revision_id is None:
893
history = self.revision_history()
895
return history.index(revision_id) + 1
897
raise bzrlib.errors.NoSuchRevision(self, revision_id)
899
def get_rev_id(self, revno, history=None):
900
"""Find the revision id of the specified revno."""
904
history = self.revision_history()
905
elif revno <= 0 or revno > len(history):
906
raise bzrlib.errors.NoSuchRevision(self, revno)
907
return history[revno - 1]
909
def revision_tree(self, revision_id):
910
"""Return Tree for a revision on this branch.
912
`revision_id` may be None for the null revision, in which case
913
an `EmptyTree` is returned."""
914
# TODO: refactor this to use an existing revision object
915
# so we don't need to read it in twice.
916
if revision_id == None or revision_id == NULL_REVISION:
919
inv = self.get_revision_inventory(revision_id)
920
return RevisionTree(self.weave_store, inv, revision_id)
922
def working_tree(self):
923
"""Return a `Tree` for the working copy."""
924
from bzrlib.workingtree import WorkingTree
925
# TODO: In the future, perhaps WorkingTree should utilize Transport
926
# RobertCollins 20051003 - I don't think it should - working trees are
927
# much more complex to keep consistent than our careful .bzr subset.
928
# instead, we should say that working trees are local only, and optimise
930
if self._transport.base.find('://') != -1:
931
raise NoWorkingTree(self.base)
932
return WorkingTree(self.base, branch=self)
935
def pull(self, source, overwrite=False):
939
self.update_revisions(source)
940
except DivergedBranches:
943
self.set_revision_history(source.revision_history())
947
def basis_tree(self):
948
"""Return `Tree` object for last revision.
950
If there are no revisions yet, return an `EmptyTree`.
952
return self.revision_tree(self.last_revision())
955
def rename_one(self, from_rel, to_rel):
958
This can change the directory or the filename or both.
960
tree = self.working_tree()
962
if not tree.has_filename(from_rel):
963
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
964
if tree.has_filename(to_rel):
965
raise BzrError("can't rename: new working file %r already exists" % to_rel)
967
file_id = inv.path2id(from_rel)
969
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
971
if inv.path2id(to_rel):
972
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
974
to_dir, to_tail = os.path.split(to_rel)
975
to_dir_id = inv.path2id(to_dir)
976
if to_dir_id == None and to_dir != '':
977
raise BzrError("can't determine destination directory id for %r" % to_dir)
979
mutter("rename_one:")
980
mutter(" file_id {%s}" % file_id)
981
mutter(" from_rel %r" % from_rel)
982
mutter(" to_rel %r" % to_rel)
983
mutter(" to_dir %r" % to_dir)
984
mutter(" to_dir_id {%s}" % to_dir_id)
986
inv.rename(file_id, to_dir_id, to_tail)
988
from_abs = self.abspath(from_rel)
989
to_abs = self.abspath(to_rel)
991
rename(from_abs, to_abs)
993
raise BzrError("failed to rename %r to %r: %s"
994
% (from_abs, to_abs, e[1]),
995
["rename rolled back"])
997
self._write_inventory(inv)
1000
def move(self, from_paths, to_name):
1003
to_name must exist as a versioned directory.
1005
If to_name exists and is a directory, the files are moved into
1006
it, keeping their old names. If it is a directory,
1008
Note that to_name is only the last component of the new name;
1009
this doesn't change the directory.
1011
This returns a list of (from_path, to_path) pairs for each
1012
entry that is moved.
1015
## TODO: Option to move IDs only
1016
assert not isinstance(from_paths, basestring)
1017
tree = self.working_tree()
1018
inv = tree.inventory
1019
to_abs = self.abspath(to_name)
1020
if not isdir(to_abs):
1021
raise BzrError("destination %r is not a directory" % to_abs)
1022
if not tree.has_filename(to_name):
1023
raise BzrError("destination %r not in working directory" % to_abs)
1024
to_dir_id = inv.path2id(to_name)
1025
if to_dir_id == None and to_name != '':
1026
raise BzrError("destination %r is not a versioned directory" % to_name)
1027
to_dir_ie = inv[to_dir_id]
1028
if to_dir_ie.kind not in ('directory', 'root_directory'):
1029
raise BzrError("destination %r is not a directory" % to_abs)
1031
to_idpath = inv.get_idpath(to_dir_id)
1033
for f in from_paths:
1034
if not tree.has_filename(f):
1035
raise BzrError("%r does not exist in working tree" % f)
1036
f_id = inv.path2id(f)
1038
raise BzrError("%r is not versioned" % f)
1039
name_tail = splitpath(f)[-1]
1040
dest_path = appendpath(to_name, name_tail)
1041
if tree.has_filename(dest_path):
1042
raise BzrError("destination %r already exists" % dest_path)
1043
if f_id in to_idpath:
1044
raise BzrError("can't move %r to a subdirectory of itself" % f)
1046
# OK, so there's a race here, it's possible that someone will
1047
# create a file in this interval and then the rename might be
1048
# left half-done. But we should have caught most problems.
1050
for f in from_paths:
1051
name_tail = splitpath(f)[-1]
1052
dest_path = appendpath(to_name, name_tail)
1053
result.append((f, dest_path))
1054
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1056
rename(self.abspath(f), self.abspath(dest_path))
1058
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1059
["rename rolled back"])
1061
self._write_inventory(inv)
1065
def revert(self, filenames, old_tree=None, backups=True):
1066
"""Restore selected files to the versions from a previous tree.
1069
If true (default) backups are made of files before
1072
from bzrlib.atomicfile import AtomicFile
1073
from bzrlib.osutils import backup_file
1075
inv = self.working_tree().read_working_inventory()
1076
if old_tree is None:
1077
old_tree = self.basis_tree()
1078
old_inv = old_tree.inventory
1081
for fn in filenames:
1082
file_id = inv.path2id(fn)
1084
raise NotVersionedError(path=fn)
1085
if not old_inv.has_id(file_id):
1086
raise BzrError("file not present in old tree", fn, file_id)
1087
nids.append((fn, file_id))
1089
# TODO: Rename back if it was previously at a different location
1091
# TODO: If given a directory, restore the entire contents from
1092
# the previous version.
1094
# TODO: Make a backup to a temporary file.
1096
# TODO: If the file previously didn't exist, delete it?
1097
for fn, file_id in nids:
1100
f = AtomicFile(fn, 'wb')
1102
f.write(old_tree.get_file(file_id).read())
1108
def pending_merges(self):
1109
"""Return a list of pending merges.
1111
These are revisions that have been merged into the working
1112
directory but not yet committed.
1114
cfn = self._rel_controlfilename('pending-merges')
1115
if not self._transport.has(cfn):
1118
for l in self.controlfile('pending-merges', 'r').readlines():
1119
p.append(l.rstrip('\n'))
1123
def add_pending_merge(self, *revision_ids):
1124
# TODO: Perhaps should check at this point that the
1125
# history of the revision is actually present?
1126
p = self.pending_merges()
1128
for rev_id in revision_ids:
1134
self.set_pending_merges(p)
1137
def set_pending_merges(self, rev_list):
1138
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1140
def get_parent(self):
1141
"""Return the parent location of the branch.
1143
This is the default location for push/pull/missing. The usual
1144
pattern is that the user can override it by specifying a
1148
_locs = ['parent', 'pull', 'x-pull']
1151
return self.controlfile(l, 'r').read().strip('\n')
1153
if e.errno != errno.ENOENT:
1157
def get_push_location(self):
1158
"""Return the None or the location to push this branch to."""
1159
config = bzrlib.config.BranchConfig(self)
1160
push_loc = config.get_user_option('push_location')
1163
def set_push_location(self, location):
1164
"""Set a new push location for this branch."""
1165
config = bzrlib.config.LocationConfig(self.base)
1166
config.set_user_option('push_location', location)
1169
def set_parent(self, url):
1170
# TODO: Maybe delete old location files?
1171
from bzrlib.atomicfile import AtomicFile
1172
f = AtomicFile(self.controlfilename('parent'))
1179
def check_revno(self, revno):
1181
Check whether a revno corresponds to any revision.
1182
Zero (the NULL revision) is considered valid.
1185
self.check_real_revno(revno)
1187
def check_real_revno(self, revno):
1189
Check whether a revno corresponds to a real revision.
1190
Zero (the NULL revision) is considered invalid
1192
if revno < 1 or revno > self.revno():
1193
raise InvalidRevisionNumber(revno)
1195
def sign_revision(self, revision_id, gpg_strategy):
1196
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1197
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1200
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1201
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1205
class ScratchBranch(_Branch):
1206
"""Special test class: a branch that cleans up after itself.
1208
>>> b = ScratchBranch()
1212
>>> b._transport.__del__()
1217
def __init__(self, files=[], dirs=[], transport=None):
1218
"""Make a test branch.
1220
This creates a temporary directory and runs init-tree in it.
1222
If any files are listed, they are created in the working copy.
1224
if transport is None:
1225
transport = bzrlib.transport.local.ScratchTransport()
1226
super(ScratchBranch, self).__init__(transport, init=True)
1228
super(ScratchBranch, self).__init__(transport)
1231
self._transport.mkdir(d)
1234
self._transport.put(f, 'content of %s' % f)
1239
>>> orig = ScratchBranch(files=["file1", "file2"])
1240
>>> clone = orig.clone()
1241
>>> if os.name != 'nt':
1242
... os.path.samefile(orig.base, clone.base)
1244
... orig.base == clone.base
1247
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1250
from shutil import copytree
1251
from tempfile import mkdtemp
1254
copytree(self.base, base, symlinks=True)
1255
return ScratchBranch(
1256
transport=bzrlib.transport.local.ScratchTransport(base))
1259
######################################################################
1263
def is_control_file(filename):
1264
## FIXME: better check
1265
filename = os.path.normpath(filename)
1266
while filename != '':
1267
head, tail = os.path.split(filename)
1268
## mutter('check %r for control file' % ((head, tail), ))
1269
if tail == bzrlib.BZRDIR:
1271
if filename == head:
1278
def gen_file_id(name):
1279
"""Return new file id.
1281
This should probably generate proper UUIDs, but for the moment we
1282
cope with just randomness because running uuidgen every time is
1285
from binascii import hexlify
1286
from time import time
1288
# get last component
1289
idx = name.rfind('/')
1291
name = name[idx+1 : ]
1292
idx = name.rfind('\\')
1294
name = name[idx+1 : ]
1296
# make it not a hidden file
1297
name = name.lstrip('.')
1299
# remove any wierd characters; we don't escape them but rather
1300
# just pull them out
1301
name = re.sub(r'[^\w.]', '', name)
1303
s = hexlify(rand_bytes(8))
1304
return '-'.join((name, compact_date(time()), s))
1308
"""Return a new tree-root file id."""
1309
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
