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
# XXX: Do we really want errors='replace'? Perhaps it should be
418
# an error, or at least reported, if there's incorrectly-encoded
419
# data inside a file.
420
# <https://launchpad.net/products/bzr/+bug/3823>
421
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
423
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
425
raise BzrError("invalid controlfile mode %r" % mode)
427
def put_controlfile(self, path, f, encode=True):
428
"""Write an entry as a controlfile.
430
:param path: The path to put the file, relative to the .bzr control
432
:param f: A file-like or string object whose contents should be copied.
433
:param encode: If true, encode the contents as utf-8
435
self.put_controlfiles([(path, f)], encode=encode)
437
def put_controlfiles(self, files, encode=True):
438
"""Write several entries as controlfiles.
440
:param files: A list of [(path, file)] pairs, where the path is the directory
441
underneath the bzr control directory
442
:param encode: If true, encode the contents as utf-8
446
for path, f in files:
448
if isinstance(f, basestring):
449
f = f.encode('utf-8', 'replace')
451
f = codecs.getwriter('utf-8')(f, errors='replace')
452
path = self._rel_controlfilename(path)
453
ctrl_files.append((path, f))
454
self._transport.put_multi(ctrl_files)
456
def _make_control(self):
457
from bzrlib.inventory import Inventory
458
from bzrlib.weavefile import write_weave_v5
459
from bzrlib.weave import Weave
461
# Create an empty inventory
463
# if we want per-tree root ids then this is the place to set
464
# them; they're not needed for now and so ommitted for
466
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
467
empty_inv = sio.getvalue()
469
bzrlib.weavefile.write_weave_v5(Weave(), sio)
470
empty_weave = sio.getvalue()
472
dirs = [[], 'revision-store', 'weaves']
474
"This is a Bazaar-NG control directory.\n"
475
"Do not change any files in this directory.\n"),
476
('branch-format', BZR_BRANCH_FORMAT_6),
477
('revision-history', ''),
480
('pending-merges', ''),
481
('inventory', empty_inv),
482
('inventory.weave', empty_weave),
483
('ancestry.weave', empty_weave)
485
cfn = self._rel_controlfilename
486
self._transport.mkdir_multi([cfn(d) for d in dirs])
487
self.put_controlfiles(files)
488
mutter('created control directory in ' + self._transport.base)
490
def _check_format(self, relax_version_check):
491
"""Check this branch format is supported.
493
The format level is stored, as an integer, in
494
self._branch_format for code that needs to check it later.
496
In the future, we might need different in-memory Branch
497
classes to support downlevel branches. But not yet.
500
fmt = self.controlfile('branch-format', 'r').read()
502
raise NotBranchError(path=self.base)
503
mutter("got branch format %r", fmt)
504
if fmt == BZR_BRANCH_FORMAT_6:
505
self._branch_format = 6
506
elif fmt == BZR_BRANCH_FORMAT_5:
507
self._branch_format = 5
508
elif fmt == BZR_BRANCH_FORMAT_4:
509
self._branch_format = 4
511
if (not relax_version_check
512
and self._branch_format not in (5, 6)):
513
raise errors.UnsupportedFormatError(
514
'sorry, branch format %r not supported' % fmt,
515
['use a different bzr version',
516
'or remove the .bzr directory'
517
' and "bzr init" again'])
519
def get_root_id(self):
520
"""Return the id of this branches root"""
521
inv = self.get_inventory(self.last_revision())
522
return inv.root.file_id
525
def add(self, files, ids=None):
526
"""Make files versioned.
528
Note that the command line normally calls smart_add instead,
529
which can automatically recurse.
531
This puts the files in the Added state, so that they will be
532
recorded by the next commit.
535
List of paths to add, relative to the base of the tree.
538
If set, use these instead of automatically generated ids.
539
Must be the same length as the list of files, but may
540
contain None for ids that are to be autogenerated.
542
TODO: Perhaps have an option to add the ids even if the files do
545
TODO: Perhaps yield the ids and paths as they're added.
547
# TODO: Re-adding a file that is removed in the working copy
548
# should probably put it back with the previous ID.
549
if isinstance(files, basestring):
550
assert(ids is None or isinstance(ids, basestring))
556
ids = [None] * len(files)
558
assert(len(ids) == len(files))
560
inv = self.working_tree().read_working_inventory()
561
for f,file_id in zip(files, ids):
562
if is_control_file(f):
563
raise BzrError("cannot add control file %s" % quotefn(f))
568
raise BzrError("cannot add top-level %r" % f)
570
fullpath = os.path.normpath(self.abspath(f))
573
kind = file_kind(fullpath)
575
# maybe something better?
576
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
578
if not InventoryEntry.versionable_kind(kind):
579
raise BzrError('cannot add: not a versionable file ('
580
'i.e. regular file, symlink or directory): %s' % quotefn(f))
583
file_id = gen_file_id(f)
584
inv.add_path(f, kind=kind, file_id=file_id)
586
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
588
self.working_tree()._write_inventory(inv)
591
def print_file(self, file, revno):
592
"""Print `file` to stdout."""
593
tree = self.revision_tree(self.get_rev_id(revno))
594
# use inventory as it was in that revision
595
file_id = tree.inventory.path2id(file)
597
raise BzrError("%r is not present in revision %s" % (file, revno))
598
tree.print_file(file_id)
601
"""Return all unknown files.
603
These are files in the working directory that are not versioned or
604
control files or ignored.
606
>>> from bzrlib.workingtree import WorkingTree
607
>>> b = ScratchBranch(files=['foo', 'foo~'])
608
>>> map(str, b.unknowns())
611
>>> list(b.unknowns())
613
>>> WorkingTree(b.base, b).remove('foo')
614
>>> list(b.unknowns())
617
return self.working_tree().unknowns()
620
def append_revision(self, *revision_ids):
621
for revision_id in revision_ids:
622
mutter("add {%s} to revision-history" % revision_id)
623
rev_history = self.revision_history()
624
rev_history.extend(revision_ids)
625
self.set_revision_history(rev_history)
628
def set_revision_history(self, rev_history):
629
self.put_controlfile('revision-history', '\n'.join(rev_history))
631
def has_revision(self, revision_id):
632
"""True if this branch has a copy of the revision.
634
This does not necessarily imply the revision is merge
635
or on the mainline."""
636
return (revision_id is None
637
or self.revision_store.has_id(revision_id))
640
def get_revision_xml_file(self, revision_id):
641
"""Return XML file object for revision object."""
642
if not revision_id or not isinstance(revision_id, basestring):
643
raise InvalidRevisionId(revision_id=revision_id, branch=self)
645
return self.revision_store.get(revision_id)
646
except (IndexError, KeyError):
647
raise bzrlib.errors.NoSuchRevision(self, revision_id)
650
get_revision_xml = get_revision_xml_file
652
def get_revision_xml(self, revision_id):
653
return self.get_revision_xml_file(revision_id).read()
656
def get_revision(self, revision_id):
657
"""Return the Revision object for a named revision"""
658
xml_file = self.get_revision_xml_file(revision_id)
661
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
662
except SyntaxError, e:
663
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
667
assert r.revision_id == revision_id
670
def get_revision_delta(self, revno):
671
"""Return the delta for one revision.
673
The delta is relative to its mainline predecessor, or the
674
empty tree for revision 1.
676
assert isinstance(revno, int)
677
rh = self.revision_history()
678
if not (1 <= revno <= len(rh)):
679
raise InvalidRevisionNumber(revno)
681
# revno is 1-based; list is 0-based
683
new_tree = self.revision_tree(rh[revno-1])
685
old_tree = EmptyTree()
687
old_tree = self.revision_tree(rh[revno-2])
689
return compare_trees(old_tree, new_tree)
691
def get_revision_sha1(self, revision_id):
692
"""Hash the stored value of a revision, and return it."""
693
# In the future, revision entries will be signed. At that
694
# point, it is probably best *not* to include the signature
695
# in the revision hash. Because that lets you re-sign
696
# the revision, (add signatures/remove signatures) and still
697
# have all hash pointers stay consistent.
698
# But for now, just hash the contents.
699
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
701
def get_ancestry(self, revision_id):
702
"""Return a list of revision-ids integrated by a revision.
704
This currently returns a list, but the ordering is not guaranteed:
707
if revision_id is None:
709
w = self.get_inventory_weave()
710
return [None] + map(w.idx_to_name,
711
w.inclusions([w.lookup(revision_id)]))
713
def get_inventory_weave(self):
714
return self.control_weaves.get_weave('inventory',
715
self.get_transaction())
717
def get_inventory(self, revision_id):
718
"""Get Inventory object by hash."""
719
xml = self.get_inventory_xml(revision_id)
720
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
722
def get_inventory_xml(self, revision_id):
723
"""Get inventory XML as a file object."""
725
assert isinstance(revision_id, basestring), type(revision_id)
726
iw = self.get_inventory_weave()
727
return iw.get_text(iw.lookup(revision_id))
729
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
731
def get_inventory_sha1(self, revision_id):
732
"""Return the sha1 hash of the inventory entry
734
return self.get_revision(revision_id).inventory_sha1
736
def get_revision_inventory(self, revision_id):
737
"""Return inventory of a past revision."""
738
# TODO: Unify this with get_inventory()
739
# bzr 0.0.6 and later imposes the constraint that the inventory_id
740
# must be the same as its revision, so this is trivial.
741
if revision_id == None:
742
# This does not make sense: if there is no revision,
743
# then it is the current tree inventory surely ?!
744
# and thus get_root_id() is something that looks at the last
745
# commit on the branch, and the get_root_id is an inventory check.
746
raise NotImplementedError
747
# return Inventory(self.get_root_id())
749
return self.get_inventory(revision_id)
752
def revision_history(self):
753
"""Return sequence of revision hashes on to this branch."""
754
transaction = self.get_transaction()
755
history = transaction.map.find_revision_history()
756
if history is not None:
757
mutter("cache hit for revision-history in %s", self)
759
history = [l.rstrip('\r\n') for l in
760
self.controlfile('revision-history', 'r').readlines()]
761
transaction.map.add_revision_history(history)
762
# this call is disabled because revision_history is
763
# not really an object yet, and the transaction is for objects.
764
# transaction.register_clean(history, precious=True)
768
"""Return current revision number for this branch.
770
That is equivalent to the number of revisions committed to
773
return len(self.revision_history())
775
def last_revision(self):
776
"""Return last patch hash, or None if no history.
778
ph = self.revision_history()
784
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
785
"""Return a list of new revisions that would perfectly fit.
787
If self and other have not diverged, return a list of the revisions
788
present in other, but missing from self.
790
>>> from bzrlib.commit import commit
791
>>> bzrlib.trace.silent = True
792
>>> br1 = ScratchBranch()
793
>>> br2 = ScratchBranch()
794
>>> br1.missing_revisions(br2)
796
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
797
>>> br1.missing_revisions(br2)
799
>>> br2.missing_revisions(br1)
801
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
802
>>> br1.missing_revisions(br2)
804
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
805
>>> br1.missing_revisions(br2)
807
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
808
>>> br1.missing_revisions(br2)
809
Traceback (most recent call last):
810
DivergedBranches: These branches have diverged.
812
self_history = self.revision_history()
813
self_len = len(self_history)
814
other_history = other.revision_history()
815
other_len = len(other_history)
816
common_index = min(self_len, other_len) -1
817
if common_index >= 0 and \
818
self_history[common_index] != other_history[common_index]:
819
raise DivergedBranches(self, other)
821
if stop_revision is None:
822
stop_revision = other_len
824
assert isinstance(stop_revision, int)
825
if stop_revision > other_len:
826
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
827
return other_history[self_len:stop_revision]
829
def update_revisions(self, other, stop_revision=None):
830
"""Pull in new perfect-fit revisions."""
831
from bzrlib.fetch import greedy_fetch
832
if stop_revision is None:
833
stop_revision = other.last_revision()
834
### Should this be checking is_ancestor instead of revision_history?
835
if (stop_revision is not None and
836
stop_revision in self.revision_history()):
838
greedy_fetch(to_branch=self, from_branch=other,
839
revision=stop_revision)
840
pullable_revs = self.pullable_revisions(other, stop_revision)
841
if len(pullable_revs) > 0:
842
self.append_revision(*pullable_revs)
844
def pullable_revisions(self, other, stop_revision):
845
other_revno = other.revision_id_to_revno(stop_revision)
847
return self.missing_revisions(other, other_revno)
848
except DivergedBranches, e:
850
pullable_revs = get_intervening_revisions(self.last_revision(),
852
assert self.last_revision() not in pullable_revs
854
except bzrlib.errors.NotAncestor:
855
if is_ancestor(self.last_revision(), stop_revision, self):
860
def revision_id_to_revno(self, revision_id):
861
"""Given a revision id, return its revno"""
862
if revision_id is None:
864
history = self.revision_history()
866
return history.index(revision_id) + 1
868
raise bzrlib.errors.NoSuchRevision(self, revision_id)
870
def get_rev_id(self, revno, history=None):
871
"""Find the revision id of the specified revno."""
875
history = self.revision_history()
876
elif revno <= 0 or revno > len(history):
877
raise bzrlib.errors.NoSuchRevision(self, revno)
878
return history[revno - 1]
880
def revision_tree(self, revision_id):
881
"""Return Tree for a revision on this branch.
883
`revision_id` may be None for the null revision, in which case
884
an `EmptyTree` is returned."""
885
# TODO: refactor this to use an existing revision object
886
# so we don't need to read it in twice.
887
if revision_id == None or revision_id == NULL_REVISION:
890
inv = self.get_revision_inventory(revision_id)
891
return RevisionTree(self.weave_store, inv, revision_id)
893
def working_tree(self):
894
"""Return a `Tree` for the working copy."""
895
from bzrlib.workingtree import WorkingTree
896
# TODO: In the future, perhaps WorkingTree should utilize Transport
897
# RobertCollins 20051003 - I don't think it should - working trees are
898
# much more complex to keep consistent than our careful .bzr subset.
899
# instead, we should say that working trees are local only, and optimise
901
if self._transport.base.find('://') != -1:
902
raise NoWorkingTree(self.base)
903
return WorkingTree(self.base, branch=self)
906
def pull(self, source, overwrite=False):
910
self.update_revisions(source)
911
except DivergedBranches:
914
self.set_revision_history(source.revision_history())
918
def basis_tree(self):
919
"""Return `Tree` object for last revision.
921
If there are no revisions yet, return an `EmptyTree`.
923
return self.revision_tree(self.last_revision())
926
def rename_one(self, from_rel, to_rel):
929
This can change the directory or the filename or both.
931
tree = self.working_tree()
933
if not tree.has_filename(from_rel):
934
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
935
if tree.has_filename(to_rel):
936
raise BzrError("can't rename: new working file %r already exists" % to_rel)
938
file_id = inv.path2id(from_rel)
940
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
942
if inv.path2id(to_rel):
943
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
945
to_dir, to_tail = os.path.split(to_rel)
946
to_dir_id = inv.path2id(to_dir)
947
if to_dir_id == None and to_dir != '':
948
raise BzrError("can't determine destination directory id for %r" % to_dir)
950
mutter("rename_one:")
951
mutter(" file_id {%s}" % file_id)
952
mutter(" from_rel %r" % from_rel)
953
mutter(" to_rel %r" % to_rel)
954
mutter(" to_dir %r" % to_dir)
955
mutter(" to_dir_id {%s}" % to_dir_id)
957
inv.rename(file_id, to_dir_id, to_tail)
959
from_abs = self.abspath(from_rel)
960
to_abs = self.abspath(to_rel)
962
rename(from_abs, to_abs)
964
raise BzrError("failed to rename %r to %r: %s"
965
% (from_abs, to_abs, e[1]),
966
["rename rolled back"])
968
self.working_tree()._write_inventory(inv)
971
def move(self, from_paths, to_name):
974
to_name must exist as a versioned directory.
976
If to_name exists and is a directory, the files are moved into
977
it, keeping their old names. If it is a directory,
979
Note that to_name is only the last component of the new name;
980
this doesn't change the directory.
982
This returns a list of (from_path, to_path) pairs for each
986
## TODO: Option to move IDs only
987
assert not isinstance(from_paths, basestring)
988
tree = self.working_tree()
990
to_abs = self.abspath(to_name)
991
if not isdir(to_abs):
992
raise BzrError("destination %r is not a directory" % to_abs)
993
if not tree.has_filename(to_name):
994
raise BzrError("destination %r not in working directory" % to_abs)
995
to_dir_id = inv.path2id(to_name)
996
if to_dir_id == None and to_name != '':
997
raise BzrError("destination %r is not a versioned directory" % to_name)
998
to_dir_ie = inv[to_dir_id]
999
if to_dir_ie.kind not in ('directory', 'root_directory'):
1000
raise BzrError("destination %r is not a directory" % to_abs)
1002
to_idpath = inv.get_idpath(to_dir_id)
1004
for f in from_paths:
1005
if not tree.has_filename(f):
1006
raise BzrError("%r does not exist in working tree" % f)
1007
f_id = inv.path2id(f)
1009
raise BzrError("%r is not versioned" % f)
1010
name_tail = splitpath(f)[-1]
1011
dest_path = appendpath(to_name, name_tail)
1012
if tree.has_filename(dest_path):
1013
raise BzrError("destination %r already exists" % dest_path)
1014
if f_id in to_idpath:
1015
raise BzrError("can't move %r to a subdirectory of itself" % f)
1017
# OK, so there's a race here, it's possible that someone will
1018
# create a file in this interval and then the rename might be
1019
# left half-done. But we should have caught most problems.
1021
for f in from_paths:
1022
name_tail = splitpath(f)[-1]
1023
dest_path = appendpath(to_name, name_tail)
1024
result.append((f, dest_path))
1025
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1027
rename(self.abspath(f), self.abspath(dest_path))
1029
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1030
["rename rolled back"])
1032
self.working_tree()._write_inventory(inv)
1035
def get_parent(self):
1036
"""Return the parent location of the branch.
1038
This is the default location for push/pull/missing. The usual
1039
pattern is that the user can override it by specifying a
1043
_locs = ['parent', 'pull', 'x-pull']
1046
return self.controlfile(l, 'r').read().strip('\n')
1048
if e.errno != errno.ENOENT:
1052
def get_push_location(self):
1053
"""Return the None or the location to push this branch to."""
1054
config = bzrlib.config.BranchConfig(self)
1055
push_loc = config.get_user_option('push_location')
1058
def set_push_location(self, location):
1059
"""Set a new push location for this branch."""
1060
config = bzrlib.config.LocationConfig(self.base)
1061
config.set_user_option('push_location', location)
1064
def set_parent(self, url):
1065
# TODO: Maybe delete old location files?
1066
from bzrlib.atomicfile import AtomicFile
1067
f = AtomicFile(self.controlfilename('parent'))
1074
def check_revno(self, revno):
1076
Check whether a revno corresponds to any revision.
1077
Zero (the NULL revision) is considered valid.
1080
self.check_real_revno(revno)
1082
def check_real_revno(self, revno):
1084
Check whether a revno corresponds to a real revision.
1085
Zero (the NULL revision) is considered invalid
1087
if revno < 1 or revno > self.revno():
1088
raise InvalidRevisionNumber(revno)
1090
def sign_revision(self, revision_id, gpg_strategy):
1091
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1092
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1095
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1096
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1100
class ScratchBranch(_Branch):
1101
"""Special test class: a branch that cleans up after itself.
1103
>>> b = ScratchBranch()
1107
>>> b._transport.__del__()
1112
def __init__(self, files=[], dirs=[], transport=None):
1113
"""Make a test branch.
1115
This creates a temporary directory and runs init-tree in it.
1117
If any files are listed, they are created in the working copy.
1119
if transport is None:
1120
transport = bzrlib.transport.local.ScratchTransport()
1121
super(ScratchBranch, self).__init__(transport, init=True)
1123
super(ScratchBranch, self).__init__(transport)
1126
self._transport.mkdir(d)
1129
self._transport.put(f, 'content of %s' % f)
1134
>>> orig = ScratchBranch(files=["file1", "file2"])
1135
>>> clone = orig.clone()
1136
>>> if os.name != 'nt':
1137
... os.path.samefile(orig.base, clone.base)
1139
... orig.base == clone.base
1142
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1145
from shutil import copytree
1146
from tempfile import mkdtemp
1149
copytree(self.base, base, symlinks=True)
1150
return ScratchBranch(
1151
transport=bzrlib.transport.local.ScratchTransport(base))
1154
######################################################################
1158
def is_control_file(filename):
1159
## FIXME: better check
1160
filename = os.path.normpath(filename)
1161
while filename != '':
1162
head, tail = os.path.split(filename)
1163
## mutter('check %r for control file' % ((head, tail), ))
1164
if tail == bzrlib.BZRDIR:
1166
if filename == head:
1173
def gen_file_id(name):
1174
"""Return new file id.
1176
This should probably generate proper UUIDs, but for the moment we
1177
cope with just randomness because running uuidgen every time is
1180
from binascii import hexlify
1181
from time import time
1183
# get last component
1184
idx = name.rfind('/')
1186
name = name[idx+1 : ]
1187
idx = name.rfind('\\')
1189
name = name[idx+1 : ]
1191
# make it not a hidden file
1192
name = name.lstrip('.')
1194
# remove any wierd characters; we don't escape them but rather
1195
# just pull them out
1196
name = re.sub(r'[^\w.]', '', name)
1198
s = hexlify(rand_bytes(8))
1199
return '-'.join((name, compact_date(time()), s))
1203
"""Return a new tree-root file id."""
1204
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
