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.text import TextStore
48
from bzrlib.store.weave import WeaveStore
49
from bzrlib.testament import Testament
50
import bzrlib.transactions as transactions
51
from bzrlib.transport import Transport, get_transport
54
from config import TreeConfig
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 BzrBranch(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 BzrBranch(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 BzrBranch(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
cfg = self.tree_config()
159
return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
161
def _set_nick(self, nick):
162
cfg = self.tree_config()
163
cfg.set_option(nick, "nickname")
164
assert cfg.get_option("nickname") == nick
166
nick = property(_get_nick, _set_nick)
168
def push_stores(self, branch_to):
169
"""Copy the content of this branches store to branch_to."""
170
raise NotImplementedError('push_stores is abstract')
172
def get_transaction(self):
173
"""Return the current active transaction.
175
If no transaction is active, this returns a passthrough object
176
for which all data is immediately flushed and no caching happens.
178
raise NotImplementedError('get_transaction is abstract')
180
def lock_write(self):
181
raise NotImplementedError('lock_write is abstract')
184
raise NotImplementedError('lock_read is abstract')
187
raise NotImplementedError('unlock is abstract')
189
def abspath(self, name):
190
"""Return absolute filename for something in the branch
192
XXX: Robert Collins 20051017 what is this used for? why is it a branch
193
method and not a tree method.
195
raise NotImplementedError('abspath is abstract')
197
def controlfilename(self, file_or_path):
198
"""Return location relative to branch."""
199
raise NotImplementedError('controlfilename is abstract')
201
def controlfile(self, file_or_path, mode='r'):
202
"""Open a control file for this branch.
204
There are two classes of file in the control directory: text
205
and binary. binary files are untranslated byte streams. Text
206
control files are stored with Unix newlines and in UTF-8, even
207
if the platform or locale defaults are different.
209
Controlfiles should almost never be opened in write mode but
210
rather should be atomically copied and replaced using atomicfile.
212
raise NotImplementedError('controlfile is abstract')
214
def put_controlfile(self, path, f, encode=True):
215
"""Write an entry as a controlfile.
217
:param path: The path to put the file, relative to the .bzr control
219
:param f: A file-like or string object whose contents should be copied.
220
:param encode: If true, encode the contents as utf-8
222
raise NotImplementedError('put_controlfile is abstract')
224
def put_controlfiles(self, files, encode=True):
225
"""Write several entries as controlfiles.
227
:param files: A list of [(path, file)] pairs, where the path is the directory
228
underneath the bzr control directory
229
:param encode: If true, encode the contents as utf-8
231
raise NotImplementedError('put_controlfiles is abstract')
233
def get_root_id(self):
234
"""Return the id of this branches root"""
235
raise NotImplementedError('get_root_id is abstract')
237
def set_root_id(self, file_id):
238
raise NotImplementedError('set_root_id is abstract')
240
def add(self, files, ids=None):
241
"""Make files versioned.
243
Note that the command line normally calls smart_add instead,
244
which can automatically recurse.
246
This puts the files in the Added state, so that they will be
247
recorded by the next commit.
250
List of paths to add, relative to the base of the tree.
253
If set, use these instead of automatically generated ids.
254
Must be the same length as the list of files, but may
255
contain None for ids that are to be autogenerated.
257
TODO: Perhaps have an option to add the ids even if the files do
260
TODO: Perhaps yield the ids and paths as they're added.
262
raise NotImplementedError('add is abstract')
264
def print_file(self, file, revno):
265
"""Print `file` to stdout."""
266
raise NotImplementedError('print_file is abstract')
269
"""Return all unknown files.
271
These are files in the working directory that are not versioned or
272
control files or ignored.
274
>>> from bzrlib.workingtree import WorkingTree
275
>>> b = ScratchBranch(files=['foo', 'foo~'])
276
>>> map(str, b.unknowns())
279
>>> list(b.unknowns())
281
>>> WorkingTree(b.base, b).remove('foo')
282
>>> list(b.unknowns())
285
raise NotImplementedError('unknowns is abstract')
287
def append_revision(self, *revision_ids):
288
raise NotImplementedError('append_revision is abstract')
290
def set_revision_history(self, rev_history):
291
raise NotImplementedError('set_revision_history is abstract')
293
def has_revision(self, revision_id):
294
"""True if this branch has a copy of the revision.
296
This does not necessarily imply the revision is merge
297
or on the mainline."""
298
raise NotImplementedError('has_revision is abstract')
300
def get_revision_xml_file(self, revision_id):
301
"""Return XML file object for revision object."""
302
raise NotImplementedError('get_revision_xml_file is abstract')
304
def get_revision_xml(self, revision_id):
305
raise NotImplementedError('get_revision_xml is abstract')
307
def get_revision(self, revision_id):
308
"""Return the Revision object for a named revision"""
309
raise NotImplementedError('get_revision is abstract')
311
def get_revision_delta(self, revno):
312
"""Return the delta for one revision.
314
The delta is relative to its mainline predecessor, or the
315
empty tree for revision 1.
317
assert isinstance(revno, int)
318
rh = self.revision_history()
319
if not (1 <= revno <= len(rh)):
320
raise InvalidRevisionNumber(revno)
322
# revno is 1-based; list is 0-based
324
new_tree = self.revision_tree(rh[revno-1])
326
old_tree = EmptyTree()
328
old_tree = self.revision_tree(rh[revno-2])
330
return compare_trees(old_tree, new_tree)
332
def get_revision_sha1(self, revision_id):
333
"""Hash the stored value of a revision, and return it."""
334
raise NotImplementedError('get_revision_sha1 is abstract')
336
def get_ancestry(self, revision_id):
337
"""Return a list of revision-ids integrated by a revision.
339
This currently returns a list, but the ordering is not guaranteed:
342
raise NotImplementedError('get_ancestry is abstract')
344
def get_inventory(self, revision_id):
345
"""Get Inventory object by hash."""
346
raise NotImplementedError('get_inventory is abstract')
348
def get_inventory_xml(self, revision_id):
349
"""Get inventory XML as a file object."""
350
raise NotImplementedError('get_inventory_xml is abstract')
352
def get_inventory_sha1(self, revision_id):
353
"""Return the sha1 hash of the inventory entry."""
354
raise NotImplementedError('get_inventory_sha1 is abstract')
356
def get_revision_inventory(self, revision_id):
357
"""Return inventory of a past revision."""
358
raise NotImplementedError('get_revision_inventory is abstract')
360
def revision_history(self):
361
"""Return sequence of revision hashes on to this branch."""
362
raise NotImplementedError('revision_history is abstract')
365
"""Return current revision number for this branch.
367
That is equivalent to the number of revisions committed to
370
return len(self.revision_history())
372
def last_revision(self):
373
"""Return last patch hash, or None if no history."""
374
ph = self.revision_history()
380
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
381
"""Return a list of new revisions that would perfectly fit.
383
If self and other have not diverged, return a list of the revisions
384
present in other, but missing from self.
386
>>> from bzrlib.commit import commit
387
>>> bzrlib.trace.silent = True
388
>>> br1 = ScratchBranch()
389
>>> br2 = ScratchBranch()
390
>>> br1.missing_revisions(br2)
392
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
393
>>> br1.missing_revisions(br2)
395
>>> br2.missing_revisions(br1)
397
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
398
>>> br1.missing_revisions(br2)
400
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
401
>>> br1.missing_revisions(br2)
403
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
404
>>> br1.missing_revisions(br2)
405
Traceback (most recent call last):
406
DivergedBranches: These branches have diverged.
408
self_history = self.revision_history()
409
self_len = len(self_history)
410
other_history = other.revision_history()
411
other_len = len(other_history)
412
common_index = min(self_len, other_len) -1
413
if common_index >= 0 and \
414
self_history[common_index] != other_history[common_index]:
415
raise DivergedBranches(self, other)
417
if stop_revision is None:
418
stop_revision = other_len
420
assert isinstance(stop_revision, int)
421
if stop_revision > other_len:
422
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
423
return other_history[self_len:stop_revision]
425
def update_revisions(self, other, stop_revision=None):
426
"""Pull in new perfect-fit revisions."""
427
raise NotImplementedError('update_revisions is abstract')
429
def pullable_revisions(self, other, stop_revision):
430
raise NotImplementedError('pullable_revisions is abstract')
432
def revision_id_to_revno(self, revision_id):
433
"""Given a revision id, return its revno"""
434
if revision_id is None:
436
history = self.revision_history()
438
return history.index(revision_id) + 1
440
raise bzrlib.errors.NoSuchRevision(self, revision_id)
442
def get_rev_id(self, revno, history=None):
443
"""Find the revision id of the specified revno."""
447
history = self.revision_history()
448
elif revno <= 0 or revno > len(history):
449
raise bzrlib.errors.NoSuchRevision(self, revno)
450
return history[revno - 1]
452
def revision_tree(self, revision_id):
453
"""Return Tree for a revision on this branch.
455
`revision_id` may be None for the null revision, in which case
456
an `EmptyTree` is returned."""
457
raise NotImplementedError('revision_tree is abstract')
459
def working_tree(self):
460
"""Return a `Tree` for the working copy."""
461
raise NotImplementedError('working_tree is abstract')
463
def pull(self, source, overwrite=False):
464
raise NotImplementedError('pull is abstract')
466
def basis_tree(self):
467
"""Return `Tree` object for last revision.
469
If there are no revisions yet, return an `EmptyTree`.
471
return self.revision_tree(self.last_revision())
473
def rename_one(self, from_rel, to_rel):
476
This can change the directory or the filename or both.
478
raise NotImplementedError('rename_one is abstract')
480
def move(self, from_paths, to_name):
483
to_name must exist as a versioned directory.
485
If to_name exists and is a directory, the files are moved into
486
it, keeping their old names. If it is a directory,
488
Note that to_name is only the last component of the new name;
489
this doesn't change the directory.
491
This returns a list of (from_path, to_path) pairs for each
494
raise NotImplementedError('move is abstract')
496
def get_parent(self):
497
"""Return the parent location of the branch.
499
This is the default location for push/pull/missing. The usual
500
pattern is that the user can override it by specifying a
503
raise NotImplementedError('get_parent is abstract')
505
def get_push_location(self):
506
"""Return the None or the location to push this branch to."""
507
raise NotImplementedError('get_push_location is abstract')
509
def set_push_location(self, location):
510
"""Set a new push location for this branch."""
511
raise NotImplementedError('set_push_location is abstract')
513
def set_parent(self, url):
514
raise NotImplementedError('set_parent is abstract')
516
def check_revno(self, revno):
518
Check whether a revno corresponds to any revision.
519
Zero (the NULL revision) is considered valid.
522
self.check_real_revno(revno)
524
def check_real_revno(self, revno):
526
Check whether a revno corresponds to a real revision.
527
Zero (the NULL revision) is considered invalid
529
if revno < 1 or revno > self.revno():
530
raise InvalidRevisionNumber(revno)
532
def sign_revision(self, revision_id, gpg_strategy):
533
raise NotImplementedError('sign_revision is abstract')
535
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
536
raise NotImplementedError('store_revision_signature is abstract')
538
class BzrBranch(Branch):
539
"""A branch stored in the actual filesystem.
541
Note that it's "local" in the context of the filesystem; it doesn't
542
really matter if it's on an nfs/smb/afs/coda/... share, as long as
543
it's writable, and can be accessed via the normal filesystem API.
549
If _lock_mode is true, a positive count of the number of times the
553
Lock object from bzrlib.lock.
555
# We actually expect this class to be somewhat short-lived; part of its
556
# purpose is to try to isolate what bits of the branch logic are tied to
557
# filesystem access, so that in a later step, we can extricate them to
558
# a separarte ("storage") class.
562
_inventory_weave = None
564
# Map some sort of prefix into a namespace
565
# stuff like "revno:10", "revid:", etc.
566
# This should match a prefix with a function which accepts
567
REVISION_NAMESPACES = {}
569
def push_stores(self, branch_to):
570
"""See Branch.push_stores."""
571
if (self._branch_format != branch_to._branch_format
572
or self._branch_format != 4):
573
from bzrlib.fetch import greedy_fetch
574
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
575
self, self._branch_format, branch_to, branch_to._branch_format)
576
greedy_fetch(to_branch=branch_to, from_branch=self,
577
revision=self.last_revision())
580
store_pairs = ((self.text_store, branch_to.text_store),
581
(self.inventory_store, branch_to.inventory_store),
582
(self.revision_store, branch_to.revision_store))
584
for from_store, to_store in store_pairs:
585
copy_all(from_store, to_store)
586
except UnlistableStore:
587
raise UnlistableBranch(from_store)
589
def __init__(self, transport, init=False,
590
relax_version_check=False):
591
"""Create new branch object at a particular location.
593
transport -- A Transport object, defining how to access files.
595
init -- If True, create new control files in a previously
596
unversioned directory. If False, the branch must already
599
relax_version_check -- If true, the usual check for the branch
600
version is not applied. This is intended only for
601
upgrade/recovery type use; it's not guaranteed that
602
all operations will work on old format branches.
604
In the test suite, creation of new trees is tested using the
605
`ScratchBranch` class.
607
assert isinstance(transport, Transport), \
608
"%r is not a Transport" % transport
609
self._transport = transport
612
self._check_format(relax_version_check)
614
def get_store(name, compressed=True, prefixed=False):
615
# FIXME: This approach of assuming stores are all entirely compressed
616
# or entirely uncompressed is tidy, but breaks upgrade from
617
# some existing branches where there's a mixture; we probably
618
# still want the option to look for both.
619
relpath = self._rel_controlfilename(name)
620
store = TextStore(self._transport.clone(relpath),
622
compressed=compressed)
623
#if self._transport.should_cache():
624
# cache_path = os.path.join(self.cache_root, name)
625
# os.mkdir(cache_path)
626
# store = bzrlib.store.CachedStore(store, cache_path)
628
def get_weave(name, prefixed=False):
629
relpath = self._rel_controlfilename(name)
630
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
631
if self._transport.should_cache():
632
ws.enable_cache = True
635
if self._branch_format == 4:
636
self.inventory_store = get_store('inventory-store')
637
self.text_store = get_store('text-store')
638
self.revision_store = get_store('revision-store')
639
elif self._branch_format == 5:
640
self.control_weaves = get_weave('')
641
self.weave_store = get_weave('weaves')
642
self.revision_store = get_store('revision-store', compressed=False)
643
elif self._branch_format == 6:
644
self.control_weaves = get_weave('')
645
self.weave_store = get_weave('weaves', prefixed=True)
646
self.revision_store = get_store('revision-store', compressed=False,
648
self.revision_store.register_suffix('sig')
649
self._transaction = None
652
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
657
if self._lock_mode or self._lock:
658
# XXX: This should show something every time, and be suitable for
659
# headless operation and embedding
660
warn("branch %r was not explicitly unlocked" % self)
663
# TODO: It might be best to do this somewhere else,
664
# but it is nice for a Branch object to automatically
665
# cache it's information.
666
# Alternatively, we could have the Transport objects cache requests
667
# See the earlier discussion about how major objects (like Branch)
668
# should never expect their __del__ function to run.
669
if hasattr(self, 'cache_root') and self.cache_root is not None:
671
shutil.rmtree(self.cache_root)
674
self.cache_root = None
678
return self._transport.base
681
base = property(_get_base, doc="The URL for the root of this branch.")
683
def _finish_transaction(self):
684
"""Exit the current transaction."""
685
if self._transaction is None:
686
raise errors.LockError('Branch %s is not in a transaction' %
688
transaction = self._transaction
689
self._transaction = None
692
def get_transaction(self):
693
"""See Branch.get_transaction."""
694
if self._transaction is None:
695
return transactions.PassThroughTransaction()
697
return self._transaction
699
def _set_transaction(self, new_transaction):
700
"""Set a new active transaction."""
701
if self._transaction is not None:
702
raise errors.LockError('Branch %s is in a transaction already.' %
704
self._transaction = new_transaction
706
def lock_write(self):
707
mutter("lock write: %s (%s)", self, self._lock_count)
708
# TODO: Upgrade locking to support using a Transport,
709
# and potentially a remote locking protocol
711
if self._lock_mode != 'w':
712
raise LockError("can't upgrade to a write lock from %r" %
714
self._lock_count += 1
716
self._lock = self._transport.lock_write(
717
self._rel_controlfilename('branch-lock'))
718
self._lock_mode = 'w'
720
self._set_transaction(transactions.PassThroughTransaction())
723
mutter("lock read: %s (%s)", self, self._lock_count)
725
assert self._lock_mode in ('r', 'w'), \
726
"invalid lock mode %r" % self._lock_mode
727
self._lock_count += 1
729
self._lock = self._transport.lock_read(
730
self._rel_controlfilename('branch-lock'))
731
self._lock_mode = 'r'
733
self._set_transaction(transactions.ReadOnlyTransaction())
734
# 5K may be excessive, but hey, its a knob.
735
self.get_transaction().set_cache_size(5000)
738
mutter("unlock: %s (%s)", self, self._lock_count)
739
if not self._lock_mode:
740
raise LockError('branch %r is not locked' % (self))
742
if self._lock_count > 1:
743
self._lock_count -= 1
745
self._finish_transaction()
748
self._lock_mode = self._lock_count = None
750
def abspath(self, name):
751
"""See Branch.abspath."""
752
return self._transport.abspath(name)
754
def _rel_controlfilename(self, file_or_path):
755
if not isinstance(file_or_path, basestring):
756
file_or_path = '/'.join(file_or_path)
757
if file_or_path == '':
759
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
761
def controlfilename(self, file_or_path):
762
"""See Branch.controlfilename."""
763
return self._transport.abspath(self._rel_controlfilename(file_or_path))
765
def controlfile(self, file_or_path, mode='r'):
766
"""See Branch.controlfile."""
769
relpath = self._rel_controlfilename(file_or_path)
770
#TODO: codecs.open() buffers linewise, so it was overloaded with
771
# a much larger buffer, do we need to do the same for getreader/getwriter?
773
return self._transport.get(relpath)
775
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
777
# XXX: Do we really want errors='replace'? Perhaps it should be
778
# an error, or at least reported, if there's incorrectly-encoded
779
# data inside a file.
780
# <https://launchpad.net/products/bzr/+bug/3823>
781
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
783
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
785
raise BzrError("invalid controlfile mode %r" % mode)
787
def put_controlfile(self, path, f, encode=True):
788
"""See Branch.put_controlfile."""
789
self.put_controlfiles([(path, f)], encode=encode)
791
def put_controlfiles(self, files, encode=True):
792
"""See Branch.put_controlfiles."""
795
for path, f in files:
797
if isinstance(f, basestring):
798
f = f.encode('utf-8', 'replace')
800
f = codecs.getwriter('utf-8')(f, errors='replace')
801
path = self._rel_controlfilename(path)
802
ctrl_files.append((path, f))
803
self._transport.put_multi(ctrl_files)
805
def _make_control(self):
806
from bzrlib.inventory import Inventory
807
from bzrlib.weavefile import write_weave_v5
808
from bzrlib.weave import Weave
810
# Create an empty inventory
812
# if we want per-tree root ids then this is the place to set
813
# them; they're not needed for now and so ommitted for
815
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
816
empty_inv = sio.getvalue()
818
bzrlib.weavefile.write_weave_v5(Weave(), sio)
819
empty_weave = sio.getvalue()
821
dirs = [[], 'revision-store', 'weaves']
823
"This is a Bazaar-NG control directory.\n"
824
"Do not change any files in this directory.\n"),
825
('branch-format', BZR_BRANCH_FORMAT_6),
826
('revision-history', ''),
829
('pending-merges', ''),
830
('inventory', empty_inv),
831
('inventory.weave', empty_weave),
832
('ancestry.weave', empty_weave)
834
cfn = self._rel_controlfilename
835
self._transport.mkdir_multi([cfn(d) for d in dirs])
836
self.put_controlfiles(files)
837
mutter('created control directory in ' + self._transport.base)
839
def _check_format(self, relax_version_check):
840
"""Check this branch format is supported.
842
The format level is stored, as an integer, in
843
self._branch_format for code that needs to check it later.
845
In the future, we might need different in-memory Branch
846
classes to support downlevel branches. But not yet.
849
fmt = self.controlfile('branch-format', 'r').read()
851
raise NotBranchError(path=self.base)
852
mutter("got branch format %r", fmt)
853
if fmt == BZR_BRANCH_FORMAT_6:
854
self._branch_format = 6
855
elif fmt == BZR_BRANCH_FORMAT_5:
856
self._branch_format = 5
857
elif fmt == BZR_BRANCH_FORMAT_4:
858
self._branch_format = 4
860
if (not relax_version_check
861
and self._branch_format not in (5, 6)):
862
raise errors.UnsupportedFormatError(
863
'sorry, branch format %r not supported' % fmt,
864
['use a different bzr version',
865
'or remove the .bzr directory'
866
' and "bzr init" again'])
868
def get_root_id(self):
869
"""See Branch.get_root_id."""
870
inv = self.get_inventory(self.last_revision())
871
return inv.root.file_id
874
def set_root_id(self, file_id):
875
"""See Branch.set_root_id."""
876
inv = self.working_tree().read_working_inventory()
877
orig_root_id = inv.root.file_id
878
del inv._byid[inv.root.file_id]
879
inv.root.file_id = file_id
880
inv._byid[inv.root.file_id] = inv.root
883
if entry.parent_id in (None, orig_root_id):
884
entry.parent_id = inv.root.file_id
885
self._write_inventory(inv)
888
def add(self, files, ids=None):
889
"""See Branch.add."""
890
# TODO: Re-adding a file that is removed in the working copy
891
# should probably put it back with the previous ID.
892
if isinstance(files, basestring):
893
assert(ids is None or isinstance(ids, basestring))
899
ids = [None] * len(files)
901
assert(len(ids) == len(files))
903
inv = self.working_tree().read_working_inventory()
904
for f,file_id in zip(files, ids):
905
if is_control_file(f):
906
raise BzrError("cannot add control file %s" % quotefn(f))
911
raise BzrError("cannot add top-level %r" % f)
913
fullpath = os.path.normpath(self.abspath(f))
916
kind = file_kind(fullpath)
918
# maybe something better?
919
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
921
if not InventoryEntry.versionable_kind(kind):
922
raise BzrError('cannot add: not a versionable file ('
923
'i.e. regular file, symlink or directory): %s' % quotefn(f))
926
file_id = gen_file_id(f)
927
inv.add_path(f, kind=kind, file_id=file_id)
929
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
931
self.working_tree()._write_inventory(inv)
934
def print_file(self, file, revno):
935
"""See Branch.print_file."""
936
tree = self.revision_tree(self.get_rev_id(revno))
937
# use inventory as it was in that revision
938
file_id = tree.inventory.path2id(file)
940
raise BzrError("%r is not present in revision %s" % (file, revno))
941
tree.print_file(file_id)
944
"""See Branch.unknowns."""
945
return self.working_tree().unknowns()
948
def append_revision(self, *revision_ids):
949
"""See Branch.append_revision."""
950
for revision_id in revision_ids:
951
mutter("add {%s} to revision-history" % revision_id)
952
rev_history = self.revision_history()
953
rev_history.extend(revision_ids)
954
self.set_revision_history(rev_history)
957
def set_revision_history(self, rev_history):
958
"""See Branch.set_revision_history."""
959
self.put_controlfile('revision-history', '\n'.join(rev_history))
961
def has_revision(self, revision_id):
962
"""See Branch.has_revision."""
963
return (revision_id is None
964
or self.revision_store.has_id(revision_id))
967
def get_revision_xml_file(self, revision_id):
968
"""See Branch.get_revision_xml_file."""
969
if not revision_id or not isinstance(revision_id, basestring):
970
raise InvalidRevisionId(revision_id=revision_id, branch=self)
972
return self.revision_store.get(revision_id)
973
except (IndexError, KeyError):
974
raise bzrlib.errors.NoSuchRevision(self, revision_id)
977
get_revision_xml = get_revision_xml_file
979
def get_revision_xml(self, revision_id):
980
"""See Branch.get_revision_xml."""
981
return self.get_revision_xml_file(revision_id).read()
984
def get_revision(self, revision_id):
985
"""See Branch.get_revision."""
986
xml_file = self.get_revision_xml_file(revision_id)
989
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
990
except SyntaxError, e:
991
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
995
assert r.revision_id == revision_id
998
def get_revision_sha1(self, revision_id):
999
"""See Branch.get_revision_sha1."""
1000
# In the future, revision entries will be signed. At that
1001
# point, it is probably best *not* to include the signature
1002
# in the revision hash. Because that lets you re-sign
1003
# the revision, (add signatures/remove signatures) and still
1004
# have all hash pointers stay consistent.
1005
# But for now, just hash the contents.
1006
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
1008
def get_ancestry(self, revision_id):
1009
"""See Branch.get_ancestry."""
1010
if revision_id is None:
1012
w = self._get_inventory_weave()
1013
return [None] + map(w.idx_to_name,
1014
w.inclusions([w.lookup(revision_id)]))
1016
def _get_inventory_weave(self):
1017
return self.control_weaves.get_weave('inventory',
1018
self.get_transaction())
1020
def get_inventory(self, revision_id):
1021
"""See Branch.get_inventory."""
1022
xml = self.get_inventory_xml(revision_id)
1023
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1025
def get_inventory_xml(self, revision_id):
1026
"""See Branch.get_inventory_xml."""
1028
assert isinstance(revision_id, basestring), type(revision_id)
1029
iw = self._get_inventory_weave()
1030
return iw.get_text(iw.lookup(revision_id))
1032
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
1034
def get_inventory_sha1(self, revision_id):
1035
"""See Branch.get_inventory_sha1."""
1036
return self.get_revision(revision_id).inventory_sha1
1038
def get_revision_inventory(self, revision_id):
1039
"""See Branch.get_revision_inventory."""
1040
# TODO: Unify this with get_inventory()
1041
# bzr 0.0.6 and later imposes the constraint that the inventory_id
1042
# must be the same as its revision, so this is trivial.
1043
if revision_id == None:
1044
# This does not make sense: if there is no revision,
1045
# then it is the current tree inventory surely ?!
1046
# and thus get_root_id() is something that looks at the last
1047
# commit on the branch, and the get_root_id is an inventory check.
1048
raise NotImplementedError
1049
# return Inventory(self.get_root_id())
1051
return self.get_inventory(revision_id)
1054
def revision_history(self):
1055
"""See Branch.revision_history."""
1056
transaction = self.get_transaction()
1057
history = transaction.map.find_revision_history()
1058
if history is not None:
1059
mutter("cache hit for revision-history in %s", self)
1060
return list(history)
1061
history = [l.rstrip('\r\n') for l in
1062
self.controlfile('revision-history', 'r').readlines()]
1063
transaction.map.add_revision_history(history)
1064
# this call is disabled because revision_history is
1065
# not really an object yet, and the transaction is for objects.
1066
# transaction.register_clean(history, precious=True)
1067
return list(history)
1069
def update_revisions(self, other, stop_revision=None):
1070
"""See Branch.update_revisions."""
1071
from bzrlib.fetch import greedy_fetch
1072
if stop_revision is None:
1073
stop_revision = other.last_revision()
1074
### Should this be checking is_ancestor instead of revision_history?
1075
if (stop_revision is not None and
1076
stop_revision in self.revision_history()):
1078
greedy_fetch(to_branch=self, from_branch=other,
1079
revision=stop_revision)
1080
pullable_revs = self.pullable_revisions(other, stop_revision)
1081
if len(pullable_revs) > 0:
1082
self.append_revision(*pullable_revs)
1084
def pullable_revisions(self, other, stop_revision):
1085
"""See Branch.pullable_revisions."""
1086
other_revno = other.revision_id_to_revno(stop_revision)
1088
return self.missing_revisions(other, other_revno)
1089
except DivergedBranches, e:
1091
pullable_revs = get_intervening_revisions(self.last_revision(),
1092
stop_revision, self)
1093
assert self.last_revision() not in pullable_revs
1094
return pullable_revs
1095
except bzrlib.errors.NotAncestor:
1096
if is_ancestor(self.last_revision(), stop_revision, self):
1101
def revision_id_to_revno(self, revision_id):
1102
"""Given a revision id, return its revno"""
1103
if revision_id is None:
1105
history = self.revision_history()
1107
return history.index(revision_id) + 1
1109
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1111
def get_rev_id(self, revno, history=None):
1112
"""Find the revision id of the specified revno."""
1116
history = self.revision_history()
1117
elif revno <= 0 or revno > len(history):
1118
raise bzrlib.errors.NoSuchRevision(self, revno)
1119
return history[revno - 1]
1121
def revision_tree(self, revision_id):
1122
"""See Branch.revision_tree."""
1123
# TODO: refactor this to use an existing revision object
1124
# so we don't need to read it in twice.
1125
if revision_id == None or revision_id == NULL_REVISION:
1128
inv = self.get_revision_inventory(revision_id)
1129
return RevisionTree(self.weave_store, inv, revision_id)
1131
def working_tree(self):
1132
"""See Branch.working_tree."""
1133
from bzrlib.workingtree import WorkingTree
1134
# TODO: In the future, perhaps WorkingTree should utilize Transport
1135
# RobertCollins 20051003 - I don't think it should - working trees are
1136
# much more complex to keep consistent than our careful .bzr subset.
1137
# instead, we should say that working trees are local only, and optimise
1139
if self._transport.base.find('://') != -1:
1140
raise NoWorkingTree(self.base)
1141
return WorkingTree(self.base, branch=self)
1144
def pull(self, source, overwrite=False):
1145
"""See Branch.pull."""
1149
self.update_revisions(source)
1150
except DivergedBranches:
1153
self.set_revision_history(source.revision_history())
1158
def rename_one(self, from_rel, to_rel):
1159
"""See Branch.rename_one."""
1160
tree = self.working_tree()
1161
inv = tree.inventory
1162
if not tree.has_filename(from_rel):
1163
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1164
if tree.has_filename(to_rel):
1165
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1167
file_id = inv.path2id(from_rel)
1169
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1171
if inv.path2id(to_rel):
1172
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1174
to_dir, to_tail = os.path.split(to_rel)
1175
to_dir_id = inv.path2id(to_dir)
1176
if to_dir_id == None and to_dir != '':
1177
raise BzrError("can't determine destination directory id for %r" % to_dir)
1179
mutter("rename_one:")
1180
mutter(" file_id {%s}" % file_id)
1181
mutter(" from_rel %r" % from_rel)
1182
mutter(" to_rel %r" % to_rel)
1183
mutter(" to_dir %r" % to_dir)
1184
mutter(" to_dir_id {%s}" % to_dir_id)
1186
inv.rename(file_id, to_dir_id, to_tail)
1188
from_abs = self.abspath(from_rel)
1189
to_abs = self.abspath(to_rel)
1191
rename(from_abs, to_abs)
1193
raise BzrError("failed to rename %r to %r: %s"
1194
% (from_abs, to_abs, e[1]),
1195
["rename rolled back"])
1197
self.working_tree()._write_inventory(inv)
1200
def move(self, from_paths, to_name):
1201
"""See Branch.move."""
1203
## TODO: Option to move IDs only
1204
assert not isinstance(from_paths, basestring)
1205
tree = self.working_tree()
1206
inv = tree.inventory
1207
to_abs = self.abspath(to_name)
1208
if not isdir(to_abs):
1209
raise BzrError("destination %r is not a directory" % to_abs)
1210
if not tree.has_filename(to_name):
1211
raise BzrError("destination %r not in working directory" % to_abs)
1212
to_dir_id = inv.path2id(to_name)
1213
if to_dir_id == None and to_name != '':
1214
raise BzrError("destination %r is not a versioned directory" % to_name)
1215
to_dir_ie = inv[to_dir_id]
1216
if to_dir_ie.kind not in ('directory', 'root_directory'):
1217
raise BzrError("destination %r is not a directory" % to_abs)
1219
to_idpath = inv.get_idpath(to_dir_id)
1221
for f in from_paths:
1222
if not tree.has_filename(f):
1223
raise BzrError("%r does not exist in working tree" % f)
1224
f_id = inv.path2id(f)
1226
raise BzrError("%r is not versioned" % f)
1227
name_tail = splitpath(f)[-1]
1228
dest_path = appendpath(to_name, name_tail)
1229
if tree.has_filename(dest_path):
1230
raise BzrError("destination %r already exists" % dest_path)
1231
if f_id in to_idpath:
1232
raise BzrError("can't move %r to a subdirectory of itself" % f)
1234
# OK, so there's a race here, it's possible that someone will
1235
# create a file in this interval and then the rename might be
1236
# left half-done. But we should have caught most problems.
1238
for f in from_paths:
1239
name_tail = splitpath(f)[-1]
1240
dest_path = appendpath(to_name, name_tail)
1241
result.append((f, dest_path))
1242
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1244
rename(self.abspath(f), self.abspath(dest_path))
1246
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1247
["rename rolled back"])
1249
self.working_tree()._write_inventory(inv)
1252
def get_parent(self):
1253
"""See Branch.get_parent."""
1255
_locs = ['parent', 'pull', 'x-pull']
1258
return self.controlfile(l, 'r').read().strip('\n')
1260
if e.errno != errno.ENOENT:
1264
def get_push_location(self):
1265
"""See Branch.get_push_location."""
1266
config = bzrlib.config.BranchConfig(self)
1267
push_loc = config.get_user_option('push_location')
1270
def set_push_location(self, location):
1271
"""See Branch.set_push_location."""
1272
config = bzrlib.config.LocationConfig(self.base)
1273
config.set_user_option('push_location', location)
1276
def set_parent(self, url):
1277
"""See Branch.set_parent."""
1278
# TODO: Maybe delete old location files?
1279
from bzrlib.atomicfile import AtomicFile
1280
f = AtomicFile(self.controlfilename('parent'))
1287
def tree_config(self):
1288
return TreeConfig(self)
1290
def check_revno(self, revno):
1292
Check whether a revno corresponds to any revision.
1293
Zero (the NULL revision) is considered valid.
1296
self.check_real_revno(revno)
1298
def check_real_revno(self, revno):
1300
Check whether a revno corresponds to a real revision.
1301
Zero (the NULL revision) is considered invalid
1303
if revno < 1 or revno > self.revno():
1304
raise InvalidRevisionNumber(revno)
1306
def sign_revision(self, revision_id, gpg_strategy):
1307
"""See Branch.sign_revision."""
1308
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1309
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1312
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1313
"""See Branch.store_revision_signature."""
1314
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1318
class ScratchBranch(BzrBranch):
1319
"""Special test class: a branch that cleans up after itself.
1321
>>> b = ScratchBranch()
1325
>>> b._transport.__del__()
1330
def __init__(self, files=[], dirs=[], transport=None):
1331
"""Make a test branch.
1333
This creates a temporary directory and runs init-tree in it.
1335
If any files are listed, they are created in the working copy.
1337
if transport is None:
1338
transport = bzrlib.transport.local.ScratchTransport()
1339
super(ScratchBranch, self).__init__(transport, init=True)
1341
super(ScratchBranch, self).__init__(transport)
1344
self._transport.mkdir(d)
1347
self._transport.put(f, 'content of %s' % f)
1352
>>> orig = ScratchBranch(files=["file1", "file2"])
1353
>>> clone = orig.clone()
1354
>>> if os.name != 'nt':
1355
... os.path.samefile(orig.base, clone.base)
1357
... orig.base == clone.base
1360
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1363
from shutil import copytree
1364
from tempfile import mkdtemp
1367
copytree(self.base, base, symlinks=True)
1368
return ScratchBranch(
1369
transport=bzrlib.transport.local.ScratchTransport(base))
1372
######################################################################
1376
def is_control_file(filename):
1377
## FIXME: better check
1378
filename = os.path.normpath(filename)
1379
while filename != '':
1380
head, tail = os.path.split(filename)
1381
## mutter('check %r for control file' % ((head, tail), ))
1382
if tail == bzrlib.BZRDIR:
1384
if filename == head:
1391
def gen_file_id(name):
1392
"""Return new file id.
1394
This should probably generate proper UUIDs, but for the moment we
1395
cope with just randomness because running uuidgen every time is
1398
from binascii import hexlify
1399
from time import time
1401
# get last component
1402
idx = name.rfind('/')
1404
name = name[idx+1 : ]
1405
idx = name.rfind('\\')
1407
name = name[idx+1 : ]
1409
# make it not a hidden file
1410
name = name.lstrip('.')
1412
# remove any wierd characters; we don't escape them but rather
1413
# just pull them out
1414
name = re.sub(r'[^\w.]', '', name)
1416
s = hexlify(rand_bytes(8))
1417
return '-'.join((name, compact_date(time()), s))
1421
"""Return a new tree-root file id."""
1422
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
