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
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn,
30
rename, splitpath, sha_file,
31
file_kind, abspath, normpath, pathjoin)
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile, NotVersionedError,
38
from bzrlib.textui import show_status
39
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
42
from bzrlib.delta import compare_trees
43
from bzrlib.tree import EmptyTree, RevisionTree
44
from bzrlib.inventory import Inventory
45
from bzrlib.store import copy_all
46
from bzrlib.store.text import TextStore
47
from bzrlib.store.weave import WeaveStore
48
from bzrlib.testament import Testament
49
import bzrlib.transactions as transactions
50
from bzrlib.transport import Transport, get_transport
53
from config import TreeConfig
56
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
57
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
58
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
59
## TODO: Maybe include checks for common corruption of newlines, etc?
62
# TODO: Some operations like log might retrieve the same revisions
63
# repeatedly to calculate deltas. We could perhaps have a weakref
64
# cache in memory to make this faster. In general anything can be
65
# cached in memory between lock and unlock operations.
67
def find_branch(*ignored, **ignored_too):
68
# XXX: leave this here for about one release, then remove it
69
raise NotImplementedError('find_branch() is not supported anymore, '
70
'please use one of the new branch constructors')
73
def needs_read_lock(unbound):
74
"""Decorate unbound to take out and release a read lock."""
75
def decorated(self, *args, **kwargs):
78
return unbound(self, *args, **kwargs)
84
def needs_write_lock(unbound):
85
"""Decorate unbound to take out and release a write lock."""
86
def decorated(self, *args, **kwargs):
89
return unbound(self, *args, **kwargs)
94
######################################################################
98
"""Branch holding a history of revisions.
101
Base directory/url of the branch.
105
def __init__(self, *ignored, **ignored_too):
106
raise NotImplementedError('The Branch class is abstract')
109
def open_downlevel(base):
110
"""Open a branch which may be of an old format.
112
Only local branches are supported."""
113
return BzrBranch(get_transport(base), relax_version_check=True)
117
"""Open an existing branch, rooted at 'base' (url)"""
118
t = get_transport(base)
119
mutter("trying to open %r with transport %r", base, t)
123
def open_containing(url):
124
"""Open an existing branch which contains url.
126
This probes for a branch at url, and searches upwards from there.
128
Basically we keep looking up until we find the control directory or
129
run into the root. If there isn't one, raises NotBranchError.
130
If there is one, it is returned, along with the unused portion of url.
132
t = get_transport(url)
135
return BzrBranch(t), t.relpath(url)
136
except NotBranchError, e:
137
mutter('not a branch in: %r %s', t.base, e)
138
new_t = t.clone('..')
139
if new_t.base == t.base:
140
# reached the root, whatever that may be
141
raise NotBranchError(path=url)
145
def initialize(base):
146
"""Create a new branch, rooted at 'base' (url)"""
147
t = get_transport(base)
148
return BzrBranch(t, init=True)
150
def setup_caching(self, cache_root):
151
"""Subclasses that care about caching should override this, and set
152
up cached stores located under cache_root.
154
self.cache_root = cache_root
157
cfg = self.tree_config()
158
return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
160
def _set_nick(self, nick):
161
cfg = self.tree_config()
162
cfg.set_option(nick, "nickname")
163
assert cfg.get_option("nickname") == nick
165
nick = property(_get_nick, _set_nick)
167
def push_stores(self, branch_to):
168
"""Copy the content of this branches store to branch_to."""
169
raise NotImplementedError('push_stores is abstract')
171
def get_transaction(self):
172
"""Return the current active transaction.
174
If no transaction is active, this returns a passthrough object
175
for which all data is immediately flushed and no caching happens.
177
raise NotImplementedError('get_transaction is abstract')
179
def lock_write(self):
180
raise NotImplementedError('lock_write is abstract')
183
raise NotImplementedError('lock_read is abstract')
186
raise NotImplementedError('unlock is abstract')
188
def abspath(self, name):
189
"""Return absolute filename for something in the branch
191
XXX: Robert Collins 20051017 what is this used for? why is it a branch
192
method and not a tree method.
194
raise NotImplementedError('abspath is abstract')
196
def controlfilename(self, file_or_path):
197
"""Return location relative to branch."""
198
raise NotImplementedError('controlfilename is abstract')
200
def controlfile(self, file_or_path, mode='r'):
201
"""Open a control file for this branch.
203
There are two classes of file in the control directory: text
204
and binary. binary files are untranslated byte streams. Text
205
control files are stored with Unix newlines and in UTF-8, even
206
if the platform or locale defaults are different.
208
Controlfiles should almost never be opened in write mode but
209
rather should be atomically copied and replaced using atomicfile.
211
raise NotImplementedError('controlfile is abstract')
213
def put_controlfile(self, path, f, encode=True):
214
"""Write an entry as a controlfile.
216
:param path: The path to put the file, relative to the .bzr control
218
:param f: A file-like or string object whose contents should be copied.
219
:param encode: If true, encode the contents as utf-8
221
raise NotImplementedError('put_controlfile is abstract')
223
def put_controlfiles(self, files, encode=True):
224
"""Write several entries as controlfiles.
226
:param files: A list of [(path, file)] pairs, where the path is the directory
227
underneath the bzr control directory
228
:param encode: If true, encode the contents as utf-8
230
raise NotImplementedError('put_controlfiles is abstract')
232
def get_root_id(self):
233
"""Return the id of this branches root"""
234
raise NotImplementedError('get_root_id is abstract')
236
def set_root_id(self, file_id):
237
raise NotImplementedError('set_root_id is abstract')
239
def print_file(self, file, revision_id):
240
"""Print `file` to stdout."""
241
raise NotImplementedError('print_file is abstract')
243
def append_revision(self, *revision_ids):
244
raise NotImplementedError('append_revision is abstract')
246
def set_revision_history(self, rev_history):
247
raise NotImplementedError('set_revision_history is abstract')
249
def has_revision(self, revision_id):
250
"""True if this branch has a copy of the revision.
252
This does not necessarily imply the revision is merge
253
or on the mainline."""
254
raise NotImplementedError('has_revision is abstract')
256
def get_revision_xml(self, revision_id):
257
raise NotImplementedError('get_revision_xml is abstract')
259
def get_revision(self, revision_id):
260
"""Return the Revision object for a named revision"""
261
raise NotImplementedError('get_revision is abstract')
263
def get_revision_delta(self, revno):
264
"""Return the delta for one revision.
266
The delta is relative to its mainline predecessor, or the
267
empty tree for revision 1.
269
assert isinstance(revno, int)
270
rh = self.revision_history()
271
if not (1 <= revno <= len(rh)):
272
raise InvalidRevisionNumber(revno)
274
# revno is 1-based; list is 0-based
276
new_tree = self.revision_tree(rh[revno-1])
278
old_tree = EmptyTree()
280
old_tree = self.revision_tree(rh[revno-2])
282
return compare_trees(old_tree, new_tree)
284
def get_revision_sha1(self, revision_id):
285
"""Hash the stored value of a revision, and return it."""
286
raise NotImplementedError('get_revision_sha1 is abstract')
288
def get_ancestry(self, revision_id):
289
"""Return a list of revision-ids integrated by a revision.
291
This currently returns a list, but the ordering is not guaranteed:
294
raise NotImplementedError('get_ancestry is abstract')
296
def get_inventory(self, revision_id):
297
"""Get Inventory object by hash."""
298
raise NotImplementedError('get_inventory is abstract')
300
def get_inventory_xml(self, revision_id):
301
"""Get inventory XML as a file object."""
302
raise NotImplementedError('get_inventory_xml is abstract')
304
def get_inventory_sha1(self, revision_id):
305
"""Return the sha1 hash of the inventory entry."""
306
raise NotImplementedError('get_inventory_sha1 is abstract')
308
def get_revision_inventory(self, revision_id):
309
"""Return inventory of a past revision."""
310
raise NotImplementedError('get_revision_inventory is abstract')
312
def revision_history(self):
313
"""Return sequence of revision hashes on to this branch."""
314
raise NotImplementedError('revision_history is abstract')
317
"""Return current revision number for this branch.
319
That is equivalent to the number of revisions committed to
322
return len(self.revision_history())
324
def last_revision(self):
325
"""Return last patch hash, or None if no history."""
326
ph = self.revision_history()
332
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
333
"""Return a list of new revisions that would perfectly fit.
335
If self and other have not diverged, return a list of the revisions
336
present in other, but missing from self.
338
>>> from bzrlib.commit import commit
339
>>> bzrlib.trace.silent = True
340
>>> br1 = ScratchBranch()
341
>>> br2 = ScratchBranch()
342
>>> br1.missing_revisions(br2)
344
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
345
>>> br1.missing_revisions(br2)
347
>>> br2.missing_revisions(br1)
349
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
350
>>> br1.missing_revisions(br2)
352
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
353
>>> br1.missing_revisions(br2)
355
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
356
>>> br1.missing_revisions(br2)
357
Traceback (most recent call last):
358
DivergedBranches: These branches have diverged. Try merge.
360
self_history = self.revision_history()
361
self_len = len(self_history)
362
other_history = other.revision_history()
363
other_len = len(other_history)
364
common_index = min(self_len, other_len) -1
365
if common_index >= 0 and \
366
self_history[common_index] != other_history[common_index]:
367
raise DivergedBranches(self, other)
369
if stop_revision is None:
370
stop_revision = other_len
372
assert isinstance(stop_revision, int)
373
if stop_revision > other_len:
374
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
375
return other_history[self_len:stop_revision]
377
def update_revisions(self, other, stop_revision=None):
378
"""Pull in new perfect-fit revisions."""
379
raise NotImplementedError('update_revisions is abstract')
381
def pullable_revisions(self, other, stop_revision):
382
raise NotImplementedError('pullable_revisions is abstract')
384
def revision_id_to_revno(self, revision_id):
385
"""Given a revision id, return its revno"""
386
if revision_id is None:
388
history = self.revision_history()
390
return history.index(revision_id) + 1
392
raise bzrlib.errors.NoSuchRevision(self, revision_id)
394
def get_rev_id(self, revno, history=None):
395
"""Find the revision id of the specified revno."""
399
history = self.revision_history()
400
elif revno <= 0 or revno > len(history):
401
raise bzrlib.errors.NoSuchRevision(self, revno)
402
return history[revno - 1]
404
def revision_tree(self, revision_id):
405
"""Return Tree for a revision on this branch.
407
`revision_id` may be None for the null revision, in which case
408
an `EmptyTree` is returned."""
409
raise NotImplementedError('revision_tree is abstract')
411
def working_tree(self):
412
"""Return a `Tree` for the working copy if this is a local branch."""
413
raise NotImplementedError('working_tree is abstract')
415
def pull(self, source, overwrite=False):
416
raise NotImplementedError('pull is abstract')
418
def basis_tree(self):
419
"""Return `Tree` object for last revision.
421
If there are no revisions yet, return an `EmptyTree`.
423
return self.revision_tree(self.last_revision())
425
def rename_one(self, from_rel, to_rel):
428
This can change the directory or the filename or both.
430
raise NotImplementedError('rename_one is abstract')
432
def move(self, from_paths, to_name):
435
to_name must exist as a versioned directory.
437
If to_name exists and is a directory, the files are moved into
438
it, keeping their old names. If it is a directory,
440
Note that to_name is only the last component of the new name;
441
this doesn't change the directory.
443
This returns a list of (from_path, to_path) pairs for each
446
raise NotImplementedError('move is abstract')
448
def get_parent(self):
449
"""Return the parent location of the branch.
451
This is the default location for push/pull/missing. The usual
452
pattern is that the user can override it by specifying a
455
raise NotImplementedError('get_parent is abstract')
457
def get_push_location(self):
458
"""Return the None or the location to push this branch to."""
459
raise NotImplementedError('get_push_location is abstract')
461
def set_push_location(self, location):
462
"""Set a new push location for this branch."""
463
raise NotImplementedError('set_push_location is abstract')
465
def set_parent(self, url):
466
raise NotImplementedError('set_parent is abstract')
468
def check_revno(self, revno):
470
Check whether a revno corresponds to any revision.
471
Zero (the NULL revision) is considered valid.
474
self.check_real_revno(revno)
476
def check_real_revno(self, revno):
478
Check whether a revno corresponds to a real revision.
479
Zero (the NULL revision) is considered invalid
481
if revno < 1 or revno > self.revno():
482
raise InvalidRevisionNumber(revno)
484
def sign_revision(self, revision_id, gpg_strategy):
485
raise NotImplementedError('sign_revision is abstract')
487
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
488
raise NotImplementedError('store_revision_signature is abstract')
490
def fileid_involved_between_revs(self, from_revid, to_revid):
491
""" This function returns the file_id(s) involved in the
492
changes between the from_revid revision and the to_revid
495
raise NotImplementedError('fileid_involved_between_revs is abstract')
497
def fileid_involved(self, last_revid=None):
498
""" This function returns the file_id(s) involved in the
499
changes up to the revision last_revid
500
If no parametr is passed, then all file_id[s] present in the
501
repository are returned
503
raise NotImplementedError('fileid_involved is abstract')
505
def fileid_involved_by_set(self, changes):
506
""" This function returns the file_id(s) involved in the
507
changes present in the set 'changes'
509
raise NotImplementedError('fileid_involved_by_set is abstract')
511
class BzrBranch(Branch):
512
"""A branch stored in the actual filesystem.
514
Note that it's "local" in the context of the filesystem; it doesn't
515
really matter if it's on an nfs/smb/afs/coda/... share, as long as
516
it's writable, and can be accessed via the normal filesystem API.
522
If _lock_mode is true, a positive count of the number of times the
526
Lock object from bzrlib.lock.
528
# We actually expect this class to be somewhat short-lived; part of its
529
# purpose is to try to isolate what bits of the branch logic are tied to
530
# filesystem access, so that in a later step, we can extricate them to
531
# a separarte ("storage") class.
535
_inventory_weave = None
536
# If set to False (by a plugin, etc) BzrBranch will not set the
537
# mode on created files or directories
538
_set_file_mode = True
541
# Map some sort of prefix into a namespace
542
# stuff like "revno:10", "revid:", etc.
543
# This should match a prefix with a function which accepts
544
REVISION_NAMESPACES = {}
546
def push_stores(self, branch_to):
547
"""See Branch.push_stores."""
548
if (self._branch_format != branch_to._branch_format
549
or self._branch_format != 4):
550
from bzrlib.fetch import greedy_fetch
551
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
552
self, self._branch_format, branch_to, branch_to._branch_format)
553
greedy_fetch(to_branch=branch_to, from_branch=self,
554
revision=self.last_revision())
557
store_pairs = ((self.text_store, branch_to.text_store),
558
(self.inventory_store, branch_to.inventory_store),
559
(self.revision_store, branch_to.revision_store))
561
for from_store, to_store in store_pairs:
562
copy_all(from_store, to_store)
563
except UnlistableStore:
564
raise UnlistableBranch(from_store)
566
def __init__(self, transport, init=False,
567
relax_version_check=False):
568
"""Create new branch object at a particular location.
570
transport -- A Transport object, defining how to access files.
572
init -- If True, create new control files in a previously
573
unversioned directory. If False, the branch must already
576
relax_version_check -- If true, the usual check for the branch
577
version is not applied. This is intended only for
578
upgrade/recovery type use; it's not guaranteed that
579
all operations will work on old format branches.
581
In the test suite, creation of new trees is tested using the
582
`ScratchBranch` class.
584
assert isinstance(transport, Transport), \
585
"%r is not a Transport" % transport
586
self._transport = transport
589
self._check_format(relax_version_check)
592
def get_store(name, compressed=True, prefixed=False):
593
relpath = self._rel_controlfilename(unicode(name))
594
store = TextStore(self._transport.clone(relpath),
595
dir_mode=self._dir_mode,
596
file_mode=self._file_mode,
598
compressed=compressed)
601
def get_weave(name, prefixed=False):
602
relpath = self._rel_controlfilename(unicode(name))
603
ws = WeaveStore(self._transport.clone(relpath),
605
dir_mode=self._dir_mode,
606
file_mode=self._file_mode)
607
if self._transport.should_cache():
608
ws.enable_cache = True
611
if self._branch_format == 4:
612
self.inventory_store = get_store('inventory-store')
613
self.text_store = get_store('text-store')
614
self.revision_store = get_store('revision-store')
615
elif self._branch_format == 5:
616
self.control_weaves = get_weave(u'')
617
self.weave_store = get_weave(u'weaves')
618
self.revision_store = get_store(u'revision-store', compressed=False)
619
elif self._branch_format == 6:
620
self.control_weaves = get_weave(u'')
621
self.weave_store = get_weave(u'weaves', prefixed=True)
622
self.revision_store = get_store(u'revision-store', compressed=False,
624
self.revision_store.register_suffix('sig')
625
self._transaction = None
628
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
633
if self._lock_mode or self._lock:
634
# XXX: This should show something every time, and be suitable for
635
# headless operation and embedding
636
warn("branch %r was not explicitly unlocked" % self)
639
# TODO: It might be best to do this somewhere else,
640
# but it is nice for a Branch object to automatically
641
# cache it's information.
642
# Alternatively, we could have the Transport objects cache requests
643
# See the earlier discussion about how major objects (like Branch)
644
# should never expect their __del__ function to run.
645
if hasattr(self, 'cache_root') and self.cache_root is not None:
647
shutil.rmtree(self.cache_root)
650
self.cache_root = None
654
return self._transport.base
657
base = property(_get_base, doc="The URL for the root of this branch.")
659
def _finish_transaction(self):
660
"""Exit the current transaction."""
661
if self._transaction is None:
662
raise errors.LockError('Branch %s is not in a transaction' %
664
transaction = self._transaction
665
self._transaction = None
668
def get_transaction(self):
669
"""See Branch.get_transaction."""
670
if self._transaction is None:
671
return transactions.PassThroughTransaction()
673
return self._transaction
675
def _set_transaction(self, new_transaction):
676
"""Set a new active transaction."""
677
if self._transaction is not None:
678
raise errors.LockError('Branch %s is in a transaction already.' %
680
self._transaction = new_transaction
682
def lock_write(self):
683
#mutter("lock write: %s (%s)", self, self._lock_count)
684
# TODO: Upgrade locking to support using a Transport,
685
# and potentially a remote locking protocol
687
if self._lock_mode != 'w':
688
raise LockError("can't upgrade to a write lock from %r" %
690
self._lock_count += 1
692
self._lock = self._transport.lock_write(
693
self._rel_controlfilename('branch-lock'))
694
self._lock_mode = 'w'
696
self._set_transaction(transactions.PassThroughTransaction())
699
#mutter("lock read: %s (%s)", self, self._lock_count)
701
assert self._lock_mode in ('r', 'w'), \
702
"invalid lock mode %r" % self._lock_mode
703
self._lock_count += 1
705
self._lock = self._transport.lock_read(
706
self._rel_controlfilename('branch-lock'))
707
self._lock_mode = 'r'
709
self._set_transaction(transactions.ReadOnlyTransaction())
710
# 5K may be excessive, but hey, its a knob.
711
self.get_transaction().set_cache_size(5000)
714
#mutter("unlock: %s (%s)", self, self._lock_count)
715
if not self._lock_mode:
716
raise LockError('branch %r is not locked' % (self))
718
if self._lock_count > 1:
719
self._lock_count -= 1
721
self._finish_transaction()
724
self._lock_mode = self._lock_count = None
726
def abspath(self, name):
727
"""See Branch.abspath."""
728
return self._transport.abspath(name)
730
def _rel_controlfilename(self, file_or_path):
731
if not isinstance(file_or_path, basestring):
732
file_or_path = u'/'.join(file_or_path)
733
if file_or_path == '':
735
return bzrlib.transport.urlescape(bzrlib.BZRDIR + u'/' + file_or_path)
737
def controlfilename(self, file_or_path):
738
"""See Branch.controlfilename."""
739
return self._transport.abspath(self._rel_controlfilename(file_or_path))
741
def controlfile(self, file_or_path, mode='r'):
742
"""See Branch.controlfile."""
745
relpath = self._rel_controlfilename(file_or_path)
746
#TODO: codecs.open() buffers linewise, so it was overloaded with
747
# a much larger buffer, do we need to do the same for getreader/getwriter?
749
return self._transport.get(relpath)
751
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
753
# XXX: Do we really want errors='replace'? Perhaps it should be
754
# an error, or at least reported, if there's incorrectly-encoded
755
# data inside a file.
756
# <https://launchpad.net/products/bzr/+bug/3823>
757
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
759
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
761
raise BzrError("invalid controlfile mode %r" % mode)
763
def put_controlfile(self, path, f, encode=True):
764
"""See Branch.put_controlfile."""
765
self.put_controlfiles([(path, f)], encode=encode)
767
def put_controlfiles(self, files, encode=True):
768
"""See Branch.put_controlfiles."""
771
for path, f in files:
773
if isinstance(f, basestring):
774
f = f.encode('utf-8', 'replace')
776
f = codecs.getwriter('utf-8')(f, errors='replace')
777
path = self._rel_controlfilename(path)
778
ctrl_files.append((path, f))
779
self._transport.put_multi(ctrl_files, mode=self._file_mode)
781
def _find_modes(self, path=None):
782
"""Determine the appropriate modes for files and directories."""
785
path = self._rel_controlfilename('')
786
st = self._transport.stat(path)
787
except errors.TransportNotPossible:
788
self._dir_mode = 0755
789
self._file_mode = 0644
791
self._dir_mode = st.st_mode & 07777
792
# Remove the sticky and execute bits for files
793
self._file_mode = self._dir_mode & ~07111
794
if not self._set_dir_mode:
795
self._dir_mode = None
796
if not self._set_file_mode:
797
self._file_mode = None
799
def _make_control(self):
800
from bzrlib.inventory import Inventory
801
from bzrlib.weavefile import write_weave_v5
802
from bzrlib.weave import Weave
804
# Create an empty inventory
806
# if we want per-tree root ids then this is the place to set
807
# them; they're not needed for now and so ommitted for
809
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
810
empty_inv = sio.getvalue()
812
bzrlib.weavefile.write_weave_v5(Weave(), sio)
813
empty_weave = sio.getvalue()
815
cfn = self._rel_controlfilename
816
# Since we don't have a .bzr directory, inherit the
817
# mode from the root directory
818
self._find_modes(u'.')
820
dirs = ['', 'revision-store', 'weaves']
822
"This is a Bazaar-NG control directory.\n"
823
"Do not change any files in this directory.\n"),
824
('branch-format', BZR_BRANCH_FORMAT_6),
825
('revision-history', ''),
828
('pending-merges', ''),
829
('inventory', empty_inv),
830
('inventory.weave', empty_weave),
831
('ancestry.weave', empty_weave)
833
self._transport.mkdir_multi([cfn(d) for d in dirs], mode=self._dir_mode)
834
self.put_controlfiles(files)
835
mutter('created control directory in ' + self._transport.base)
837
def _check_format(self, relax_version_check):
838
"""Check this branch format is supported.
840
The format level is stored, as an integer, in
841
self._branch_format for code that needs to check it later.
843
In the future, we might need different in-memory Branch
844
classes to support downlevel branches. But not yet.
847
fmt = self.controlfile('branch-format', 'r').read()
849
raise NotBranchError(path=self.base)
850
mutter("got branch format %r", fmt)
851
if fmt == BZR_BRANCH_FORMAT_6:
852
self._branch_format = 6
853
elif fmt == BZR_BRANCH_FORMAT_5:
854
self._branch_format = 5
855
elif fmt == BZR_BRANCH_FORMAT_4:
856
self._branch_format = 4
858
if (not relax_version_check
859
and self._branch_format not in (5, 6)):
860
raise errors.UnsupportedFormatError(
861
'sorry, branch format %r not supported' % fmt,
862
['use a different bzr version',
863
'or remove the .bzr directory'
864
' and "bzr init" again'])
867
def get_root_id(self):
868
"""See Branch.get_root_id."""
869
inv = self.get_inventory(self.last_revision())
870
return inv.root.file_id
873
def print_file(self, file, revision_id):
874
"""See Branch.print_file."""
875
tree = self.revision_tree(revision_id)
876
# use inventory as it was in that revision
877
file_id = tree.inventory.path2id(file)
880
revno = self.revision_id_to_revno(revision_id)
881
except errors.NoSuchRevision:
882
# TODO: This should not be BzrError,
883
# but NoSuchFile doesn't fit either
884
raise BzrError('%r is not present in revision %s'
885
% (file, revision_id))
887
raise BzrError('%r is not present in revision %s'
889
tree.print_file(file_id)
892
def append_revision(self, *revision_ids):
893
"""See Branch.append_revision."""
894
for revision_id in revision_ids:
895
mutter("add {%s} to revision-history" % revision_id)
896
rev_history = self.revision_history()
897
rev_history.extend(revision_ids)
898
self.set_revision_history(rev_history)
901
def set_revision_history(self, rev_history):
902
"""See Branch.set_revision_history."""
903
old_revision = self.last_revision()
904
new_revision = rev_history[-1]
905
self.put_controlfile('revision-history', '\n'.join(rev_history))
907
self.working_tree().set_last_revision(new_revision, old_revision)
908
except NoWorkingTree:
909
mutter('Unable to set_last_revision without a working tree.')
911
def has_revision(self, revision_id):
912
"""See Branch.has_revision."""
913
return (revision_id is None
914
or self.revision_store.has_id(revision_id))
917
def _get_revision_xml_file(self, revision_id):
918
if not revision_id or not isinstance(revision_id, basestring):
919
raise InvalidRevisionId(revision_id=revision_id, branch=self)
921
return self.revision_store.get(revision_id)
922
except (IndexError, KeyError):
923
raise bzrlib.errors.NoSuchRevision(self, revision_id)
925
def get_revision_xml(self, revision_id):
926
"""See Branch.get_revision_xml."""
927
return self._get_revision_xml_file(revision_id).read()
929
def get_revision(self, revision_id):
930
"""See Branch.get_revision."""
931
xml_file = self._get_revision_xml_file(revision_id)
934
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
935
except SyntaxError, e:
936
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
940
assert r.revision_id == revision_id
943
def get_revision_sha1(self, revision_id):
944
"""See Branch.get_revision_sha1."""
945
# In the future, revision entries will be signed. At that
946
# point, it is probably best *not* to include the signature
947
# in the revision hash. Because that lets you re-sign
948
# the revision, (add signatures/remove signatures) and still
949
# have all hash pointers stay consistent.
950
# But for now, just hash the contents.
951
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
953
def get_ancestry(self, revision_id):
954
"""See Branch.get_ancestry."""
955
if revision_id is None:
957
w = self._get_inventory_weave()
958
return [None] + map(w.idx_to_name,
959
w.inclusions([w.lookup(revision_id)]))
961
def _get_inventory_weave(self):
962
return self.control_weaves.get_weave('inventory',
963
self.get_transaction())
965
def get_inventory(self, revision_id):
966
"""See Branch.get_inventory."""
967
xml = self.get_inventory_xml(revision_id)
968
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
970
def get_inventory_xml(self, revision_id):
971
"""See Branch.get_inventory_xml."""
973
assert isinstance(revision_id, basestring), type(revision_id)
974
iw = self._get_inventory_weave()
975
return iw.get_text(iw.lookup(revision_id))
977
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
979
def get_inventory_sha1(self, revision_id):
980
"""See Branch.get_inventory_sha1."""
981
return self.get_revision(revision_id).inventory_sha1
983
def get_revision_inventory(self, revision_id):
984
"""See Branch.get_revision_inventory."""
985
# TODO: Unify this with get_inventory()
986
# bzr 0.0.6 and later imposes the constraint that the inventory_id
987
# must be the same as its revision, so this is trivial.
988
if revision_id == None:
989
# This does not make sense: if there is no revision,
990
# then it is the current tree inventory surely ?!
991
# and thus get_root_id() is something that looks at the last
992
# commit on the branch, and the get_root_id is an inventory check.
993
raise NotImplementedError
994
# return Inventory(self.get_root_id())
996
return self.get_inventory(revision_id)
999
def revision_history(self):
1000
"""See Branch.revision_history."""
1001
transaction = self.get_transaction()
1002
history = transaction.map.find_revision_history()
1003
if history is not None:
1004
mutter("cache hit for revision-history in %s", self)
1005
return list(history)
1006
history = [l.rstrip('\r\n') for l in
1007
self.controlfile('revision-history', 'r').readlines()]
1008
transaction.map.add_revision_history(history)
1009
# this call is disabled because revision_history is
1010
# not really an object yet, and the transaction is for objects.
1011
# transaction.register_clean(history, precious=True)
1012
return list(history)
1014
def update_revisions(self, other, stop_revision=None):
1015
"""See Branch.update_revisions."""
1016
from bzrlib.fetch import greedy_fetch
1017
if stop_revision is None:
1018
stop_revision = other.last_revision()
1019
### Should this be checking is_ancestor instead of revision_history?
1020
if (stop_revision is not None and
1021
stop_revision in self.revision_history()):
1023
greedy_fetch(to_branch=self, from_branch=other,
1024
revision=stop_revision)
1025
pullable_revs = self.pullable_revisions(other, stop_revision)
1026
if len(pullable_revs) > 0:
1027
self.append_revision(*pullable_revs)
1029
def pullable_revisions(self, other, stop_revision):
1030
"""See Branch.pullable_revisions."""
1031
other_revno = other.revision_id_to_revno(stop_revision)
1033
return self.missing_revisions(other, other_revno)
1034
except DivergedBranches, e:
1036
pullable_revs = get_intervening_revisions(self.last_revision(),
1037
stop_revision, self)
1038
assert self.last_revision() not in pullable_revs
1039
return pullable_revs
1040
except bzrlib.errors.NotAncestor:
1041
if is_ancestor(self.last_revision(), stop_revision, self):
1046
def revision_tree(self, revision_id):
1047
"""See Branch.revision_tree."""
1048
# TODO: refactor this to use an existing revision object
1049
# so we don't need to read it in twice.
1050
if revision_id == None or revision_id == NULL_REVISION:
1053
inv = self.get_revision_inventory(revision_id)
1054
return RevisionTree(self, inv, revision_id)
1056
def basis_tree(self):
1057
"""See Branch.basis_tree."""
1059
revision_id = self.revision_history()[-1]
1060
xml = self.working_tree().read_basis_inventory(revision_id)
1061
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1062
return RevisionTree(self, inv, revision_id)
1063
except (IndexError, NoSuchFile, NoWorkingTree), e:
1064
return self.revision_tree(self.last_revision())
1066
def working_tree(self):
1067
"""See Branch.working_tree."""
1068
from bzrlib.workingtree import WorkingTree
1069
if self._transport.base.find('://') != -1:
1070
raise NoWorkingTree(self.base)
1071
return WorkingTree(self.base, branch=self)
1074
def pull(self, source, overwrite=False):
1075
"""See Branch.pull."""
1078
old_count = len(self.revision_history())
1080
self.update_revisions(source)
1081
except DivergedBranches:
1085
self.set_revision_history(source.revision_history())
1086
new_count = len(self.revision_history())
1087
return new_count - old_count
1091
def get_parent(self):
1092
"""See Branch.get_parent."""
1094
_locs = ['parent', 'pull', 'x-pull']
1097
return self.controlfile(l, 'r').read().strip('\n')
1102
def get_push_location(self):
1103
"""See Branch.get_push_location."""
1104
config = bzrlib.config.BranchConfig(self)
1105
push_loc = config.get_user_option('push_location')
1108
def set_push_location(self, location):
1109
"""See Branch.set_push_location."""
1110
config = bzrlib.config.LocationConfig(self.base)
1111
config.set_user_option('push_location', location)
1114
def set_parent(self, url):
1115
"""See Branch.set_parent."""
1116
# TODO: Maybe delete old location files?
1117
from bzrlib.atomicfile import AtomicFile
1118
f = AtomicFile(self.controlfilename('parent'))
1125
def tree_config(self):
1126
return TreeConfig(self)
1128
def sign_revision(self, revision_id, gpg_strategy):
1129
"""See Branch.sign_revision."""
1130
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1131
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1134
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1135
"""See Branch.store_revision_signature."""
1136
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1139
def fileid_involved_between_revs(self, from_revid, to_revid):
1140
""" This function returns the file_id(s) involved in the
1141
changes between the from_revid revision and the to_revid
1144
w = self._get_inventory_weave( )
1145
from_set = set(w.inclusions([w.lookup(from_revid)]))
1146
to_set = set(w.inclusions([w.lookup(to_revid)]))
1147
included = to_set.difference(from_set)
1148
changed = map(w.idx_to_name,included)
1149
return self._fileid_involved_by_set(changed)
1151
def fileid_involved(self, last_revid=None):
1152
""" This function returns the file_id(s) involved in the
1153
changes up to the revision last_revid
1154
If no parametr is passed, then all file_id[s] present in the
1155
repository are returned
1157
w = self._get_inventory_weave( )
1159
changed = set(w._names)
1161
included = w.inclusions([w.lookup(last_revid)])
1162
changed = map(w.idx_to_name, included)
1163
return self._fileid_involved_by_set(changed)
1165
def fileid_involved_by_set(self, changes):
1166
""" This function returns the file_id(s) involved in the
1167
changese present in the set changes
1169
w = self._get_inventory_weave( )
1170
return self._fileid_involved_by_set(changes)
1172
def _fileid_involved_by_set(self, changes):
1173
w = self._get_inventory_weave( )
1175
for line in w._weave:
1177
# it is ugly, but it is due to the weave structure
1178
if not isinstance(line,basestring): continue
1180
start = line.find('file_id="')+9
1181
if start < 9: continue
1182
end = line.find('"',start)
1184
file_id = line[start:end]
1186
# check if file_id is already present
1187
if file_id in file_ids: continue
1189
start = line.find('revision="')+10
1190
if start < 10: continue
1191
end = line.find('"',start)
1193
revision_id = line[start:end]
1195
if revision_id in changes:
1196
file_ids.add(file_id)
1201
class ScratchBranch(BzrBranch):
1202
"""Special test class: a branch that cleans up after itself.
1204
>>> b = ScratchBranch()
1208
>>> b._transport.__del__()
1213
def __init__(self, files=[], dirs=[], transport=None):
1214
"""Make a test branch.
1216
This creates a temporary directory and runs init-tree in it.
1218
If any files are listed, they are created in the working copy.
1220
if transport is None:
1221
transport = bzrlib.transport.local.ScratchTransport()
1222
super(ScratchBranch, self).__init__(transport, init=True)
1224
super(ScratchBranch, self).__init__(transport)
1227
self._transport.mkdir(d)
1230
self._transport.put(f, 'content of %s' % f)
1235
>>> orig = ScratchBranch(files=["file1", "file2"])
1236
>>> clone = orig.clone()
1237
>>> if os.name != 'nt':
1238
... os.path.samefile(orig.base, clone.base)
1240
... orig.base == clone.base
1243
>>> os.path.isfile(pathjoin(clone.base, "file1"))
1246
from shutil import copytree
1247
from bzrlib.osutils import mkdtemp
1250
copytree(self.base, base, symlinks=True)
1251
return ScratchBranch(
1252
transport=bzrlib.transport.local.ScratchTransport(base))
1255
######################################################################
1259
def is_control_file(filename):
1260
## FIXME: better check
1261
filename = normpath(filename)
1262
while filename != '':
1263
head, tail = os.path.split(filename)
1264
## mutter('check %r for control file' % ((head, tail), ))
1265
if tail == bzrlib.BZRDIR:
1267
if filename == head:
added
removed
bzrlib/branch.py
