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
import xml.sax.saxutils
24
from cStringIO import StringIO
28
import bzrlib.inventory as inventory
29
from bzrlib.trace import mutter, note
30
from bzrlib.osutils import (isdir, quotefn,
31
rename, splitpath, sha_file,
32
file_kind, abspath, normpath, pathjoin)
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, e:
138
mutter('not a branch in: %r %s', t.base, e)
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('/')[-2])
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 print_file(self, file, revision_id):
241
"""Print `file` to stdout."""
242
raise NotImplementedError('print_file is abstract')
244
def append_revision(self, *revision_ids):
245
raise NotImplementedError('append_revision is abstract')
247
def set_revision_history(self, rev_history):
248
raise NotImplementedError('set_revision_history is abstract')
250
def has_revision(self, revision_id):
251
"""True if this branch has a copy of the revision.
253
This does not necessarily imply the revision is merge
254
or on the mainline."""
255
raise NotImplementedError('has_revision is abstract')
257
def get_revision_xml(self, revision_id):
258
raise NotImplementedError('get_revision_xml is abstract')
260
def get_revision(self, revision_id):
261
"""Return the Revision object for a named revision"""
262
raise NotImplementedError('get_revision is abstract')
264
def get_revision_delta(self, revno):
265
"""Return the delta for one revision.
267
The delta is relative to its mainline predecessor, or the
268
empty tree for revision 1.
270
assert isinstance(revno, int)
271
rh = self.revision_history()
272
if not (1 <= revno <= len(rh)):
273
raise InvalidRevisionNumber(revno)
275
# revno is 1-based; list is 0-based
277
new_tree = self.revision_tree(rh[revno-1])
279
old_tree = EmptyTree()
281
old_tree = self.revision_tree(rh[revno-2])
283
return compare_trees(old_tree, new_tree)
285
def get_revision_sha1(self, revision_id):
286
"""Hash the stored value of a revision, and return it."""
287
raise NotImplementedError('get_revision_sha1 is abstract')
289
def get_ancestry(self, revision_id):
290
"""Return a list of revision-ids integrated by a revision.
292
This currently returns a list, but the ordering is not guaranteed:
295
raise NotImplementedError('get_ancestry is abstract')
297
def get_inventory(self, revision_id):
298
"""Get Inventory object by hash."""
299
raise NotImplementedError('get_inventory is abstract')
301
def get_inventory_xml(self, revision_id):
302
"""Get inventory XML as a file object."""
303
raise NotImplementedError('get_inventory_xml is abstract')
305
def get_inventory_sha1(self, revision_id):
306
"""Return the sha1 hash of the inventory entry."""
307
raise NotImplementedError('get_inventory_sha1 is abstract')
309
def get_revision_inventory(self, revision_id):
310
"""Return inventory of a past revision."""
311
raise NotImplementedError('get_revision_inventory is abstract')
313
def revision_history(self):
314
"""Return sequence of revision hashes on to this branch."""
315
raise NotImplementedError('revision_history is abstract')
318
"""Return current revision number for this branch.
320
That is equivalent to the number of revisions committed to
323
return len(self.revision_history())
325
def last_revision(self):
326
"""Return last patch hash, or None if no history."""
327
ph = self.revision_history()
333
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
334
"""Return a list of new revisions that would perfectly fit.
336
If self and other have not diverged, return a list of the revisions
337
present in other, but missing from self.
339
>>> from bzrlib.commit import commit
340
>>> bzrlib.trace.silent = True
341
>>> br1 = ScratchBranch()
342
>>> br2 = ScratchBranch()
343
>>> br1.missing_revisions(br2)
345
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
346
>>> br1.missing_revisions(br2)
348
>>> br2.missing_revisions(br1)
350
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
351
>>> br1.missing_revisions(br2)
353
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
354
>>> br1.missing_revisions(br2)
356
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
357
>>> br1.missing_revisions(br2)
358
Traceback (most recent call last):
359
DivergedBranches: These branches have diverged. Try merge.
361
self_history = self.revision_history()
362
self_len = len(self_history)
363
other_history = other.revision_history()
364
other_len = len(other_history)
365
common_index = min(self_len, other_len) -1
366
if common_index >= 0 and \
367
self_history[common_index] != other_history[common_index]:
368
raise DivergedBranches(self, other)
370
if stop_revision is None:
371
stop_revision = other_len
373
assert isinstance(stop_revision, int)
374
if stop_revision > other_len:
375
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
376
return other_history[self_len:stop_revision]
378
def update_revisions(self, other, stop_revision=None):
379
"""Pull in new perfect-fit revisions."""
380
raise NotImplementedError('update_revisions is abstract')
382
def pullable_revisions(self, other, stop_revision):
383
raise NotImplementedError('pullable_revisions is abstract')
385
def revision_id_to_revno(self, revision_id):
386
"""Given a revision id, return its revno"""
387
if revision_id is None:
389
history = self.revision_history()
391
return history.index(revision_id) + 1
393
raise bzrlib.errors.NoSuchRevision(self, revision_id)
395
def get_rev_id(self, revno, history=None):
396
"""Find the revision id of the specified revno."""
400
history = self.revision_history()
401
elif revno <= 0 or revno > len(history):
402
raise bzrlib.errors.NoSuchRevision(self, revno)
403
return history[revno - 1]
405
def revision_tree(self, revision_id):
406
"""Return Tree for a revision on this branch.
408
`revision_id` may be None for the null revision, in which case
409
an `EmptyTree` is returned."""
410
raise NotImplementedError('revision_tree is abstract')
412
def working_tree(self):
413
"""Return a `Tree` for the working copy if this is a local branch."""
414
raise NotImplementedError('working_tree is abstract')
416
def pull(self, source, overwrite=False):
417
raise NotImplementedError('pull is abstract')
419
def basis_tree(self):
420
"""Return `Tree` object for last revision.
422
If there are no revisions yet, return an `EmptyTree`.
424
return self.revision_tree(self.last_revision())
426
def rename_one(self, from_rel, to_rel):
429
This can change the directory or the filename or both.
431
raise NotImplementedError('rename_one is abstract')
433
def move(self, from_paths, to_name):
436
to_name must exist as a versioned directory.
438
If to_name exists and is a directory, the files are moved into
439
it, keeping their old names. If it is a directory,
441
Note that to_name is only the last component of the new name;
442
this doesn't change the directory.
444
This returns a list of (from_path, to_path) pairs for each
447
raise NotImplementedError('move is abstract')
449
def get_parent(self):
450
"""Return the parent location of the branch.
452
This is the default location for push/pull/missing. The usual
453
pattern is that the user can override it by specifying a
456
raise NotImplementedError('get_parent is abstract')
458
def get_push_location(self):
459
"""Return the None or the location to push this branch to."""
460
raise NotImplementedError('get_push_location is abstract')
462
def set_push_location(self, location):
463
"""Set a new push location for this branch."""
464
raise NotImplementedError('set_push_location is abstract')
466
def set_parent(self, url):
467
raise NotImplementedError('set_parent is abstract')
469
def check_revno(self, revno):
471
Check whether a revno corresponds to any revision.
472
Zero (the NULL revision) is considered valid.
475
self.check_real_revno(revno)
477
def check_real_revno(self, revno):
479
Check whether a revno corresponds to a real revision.
480
Zero (the NULL revision) is considered invalid
482
if revno < 1 or revno > self.revno():
483
raise InvalidRevisionNumber(revno)
485
def sign_revision(self, revision_id, gpg_strategy):
486
raise NotImplementedError('sign_revision is abstract')
488
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
489
raise NotImplementedError('store_revision_signature is abstract')
491
def fileid_involved_between_revs(self, from_revid, to_revid):
492
""" This function returns the file_id(s) involved in the
493
changes between the from_revid revision and the to_revid
496
raise NotImplementedError('fileid_involved_between_revs is abstract')
498
def fileid_involved(self, last_revid=None):
499
""" This function returns the file_id(s) involved in the
500
changes up to the revision last_revid
501
If no parametr is passed, then all file_id[s] present in the
502
repository are returned
504
raise NotImplementedError('fileid_involved is abstract')
506
def fileid_involved_by_set(self, changes):
507
""" This function returns the file_id(s) involved in the
508
changes present in the set 'changes'
510
raise NotImplementedError('fileid_involved_by_set is abstract')
512
class BzrBranch(Branch):
513
"""A branch stored in the actual filesystem.
515
Note that it's "local" in the context of the filesystem; it doesn't
516
really matter if it's on an nfs/smb/afs/coda/... share, as long as
517
it's writable, and can be accessed via the normal filesystem API.
523
If _lock_mode is true, a positive count of the number of times the
527
Lock object from bzrlib.lock.
529
# We actually expect this class to be somewhat short-lived; part of its
530
# purpose is to try to isolate what bits of the branch logic are tied to
531
# filesystem access, so that in a later step, we can extricate them to
532
# a separarte ("storage") class.
536
_inventory_weave = None
537
# If set to False (by a plugin, etc) BzrBranch will not set the
538
# mode on created files or directories
539
_set_file_mode = True
542
# Map some sort of prefix into a namespace
543
# stuff like "revno:10", "revid:", etc.
544
# This should match a prefix with a function which accepts
545
REVISION_NAMESPACES = {}
547
def push_stores(self, branch_to):
548
"""See Branch.push_stores."""
549
if (self._branch_format != branch_to._branch_format
550
or self._branch_format != 4):
551
from bzrlib.fetch import greedy_fetch
552
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
553
self, self._branch_format, branch_to, branch_to._branch_format)
554
greedy_fetch(to_branch=branch_to, from_branch=self,
555
revision=self.last_revision())
558
store_pairs = ((self.text_store, branch_to.text_store),
559
(self.inventory_store, branch_to.inventory_store),
560
(self.revision_store, branch_to.revision_store))
562
for from_store, to_store in store_pairs:
563
copy_all(from_store, to_store)
564
except UnlistableStore:
565
raise UnlistableBranch(from_store)
567
def __init__(self, transport, init=False,
568
relax_version_check=False):
569
"""Create new branch object at a particular location.
571
transport -- A Transport object, defining how to access files.
573
init -- If True, create new control files in a previously
574
unversioned directory. If False, the branch must already
577
relax_version_check -- If true, the usual check for the branch
578
version is not applied. This is intended only for
579
upgrade/recovery type use; it's not guaranteed that
580
all operations will work on old format branches.
582
In the test suite, creation of new trees is tested using the
583
`ScratchBranch` class.
585
assert isinstance(transport, Transport), \
586
"%r is not a Transport" % transport
587
self._transport = transport
590
self._check_format(relax_version_check)
593
def get_store(name, compressed=True, prefixed=False):
594
relpath = self._rel_controlfilename(unicode(name))
595
store = TextStore(self._transport.clone(relpath),
596
dir_mode=self._dir_mode,
597
file_mode=self._file_mode,
599
compressed=compressed)
602
def get_weave(name, prefixed=False):
603
relpath = self._rel_controlfilename(unicode(name))
604
ws = WeaveStore(self._transport.clone(relpath),
606
dir_mode=self._dir_mode,
607
file_mode=self._file_mode)
608
if self._transport.should_cache():
609
ws.enable_cache = True
612
if self._branch_format == 4:
613
self.inventory_store = get_store('inventory-store')
614
self.text_store = get_store('text-store')
615
self.revision_store = get_store('revision-store')
616
elif self._branch_format == 5:
617
self.control_weaves = get_weave(u'')
618
self.weave_store = get_weave(u'weaves')
619
self.revision_store = get_store(u'revision-store', compressed=False)
620
elif self._branch_format == 6:
621
self.control_weaves = get_weave(u'')
622
self.weave_store = get_weave(u'weaves', prefixed=True)
623
self.revision_store = get_store(u'revision-store', compressed=False,
625
self.revision_store.register_suffix('sig')
626
self._transaction = None
629
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
634
if self._lock_mode or self._lock:
635
# XXX: This should show something every time, and be suitable for
636
# headless operation and embedding
637
warn("branch %r was not explicitly unlocked" % self)
640
# TODO: It might be best to do this somewhere else,
641
# but it is nice for a Branch object to automatically
642
# cache it's information.
643
# Alternatively, we could have the Transport objects cache requests
644
# See the earlier discussion about how major objects (like Branch)
645
# should never expect their __del__ function to run.
646
if hasattr(self, 'cache_root') and self.cache_root is not None:
648
shutil.rmtree(self.cache_root)
651
self.cache_root = None
655
return self._transport.base
658
base = property(_get_base, doc="The URL for the root of this branch.")
660
def _finish_transaction(self):
661
"""Exit the current transaction."""
662
if self._transaction is None:
663
raise errors.LockError('Branch %s is not in a transaction' %
665
transaction = self._transaction
666
self._transaction = None
669
def get_transaction(self):
670
"""See Branch.get_transaction."""
671
if self._transaction is None:
672
return transactions.PassThroughTransaction()
674
return self._transaction
676
def _set_transaction(self, new_transaction):
677
"""Set a new active transaction."""
678
if self._transaction is not None:
679
raise errors.LockError('Branch %s is in a transaction already.' %
681
self._transaction = new_transaction
683
def lock_write(self):
684
#mutter("lock write: %s (%s)", self, self._lock_count)
685
# TODO: Upgrade locking to support using a Transport,
686
# and potentially a remote locking protocol
688
if self._lock_mode != 'w':
689
raise LockError("can't upgrade to a write lock from %r" %
691
self._lock_count += 1
693
self._lock = self._transport.lock_write(
694
self._rel_controlfilename('branch-lock'))
695
self._lock_mode = 'w'
697
self._set_transaction(transactions.PassThroughTransaction())
700
#mutter("lock read: %s (%s)", self, self._lock_count)
702
assert self._lock_mode in ('r', 'w'), \
703
"invalid lock mode %r" % self._lock_mode
704
self._lock_count += 1
706
self._lock = self._transport.lock_read(
707
self._rel_controlfilename('branch-lock'))
708
self._lock_mode = 'r'
710
self._set_transaction(transactions.ReadOnlyTransaction())
711
# 5K may be excessive, but hey, its a knob.
712
self.get_transaction().set_cache_size(5000)
715
#mutter("unlock: %s (%s)", self, self._lock_count)
716
if not self._lock_mode:
717
raise LockError('branch %r is not locked' % (self))
719
if self._lock_count > 1:
720
self._lock_count -= 1
722
self._finish_transaction()
725
self._lock_mode = self._lock_count = None
727
def abspath(self, name):
728
"""See Branch.abspath."""
729
return self._transport.abspath(name)
731
def _rel_controlfilename(self, file_or_path):
732
if not isinstance(file_or_path, basestring):
733
file_or_path = u'/'.join(file_or_path)
734
if file_or_path == '':
736
return bzrlib.transport.urlescape(bzrlib.BZRDIR + u'/' + file_or_path)
738
def controlfilename(self, file_or_path):
739
"""See Branch.controlfilename."""
740
return self._transport.abspath(self._rel_controlfilename(file_or_path))
742
def controlfile(self, file_or_path, mode='r'):
743
"""See Branch.controlfile."""
746
relpath = self._rel_controlfilename(file_or_path)
747
#TODO: codecs.open() buffers linewise, so it was overloaded with
748
# a much larger buffer, do we need to do the same for getreader/getwriter?
750
return self._transport.get(relpath)
752
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
754
# XXX: Do we really want errors='replace'? Perhaps it should be
755
# an error, or at least reported, if there's incorrectly-encoded
756
# data inside a file.
757
# <https://launchpad.net/products/bzr/+bug/3823>
758
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
760
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
762
raise BzrError("invalid controlfile mode %r" % mode)
764
def put_controlfile(self, path, f, encode=True):
765
"""See Branch.put_controlfile."""
766
self.put_controlfiles([(path, f)], encode=encode)
768
def put_controlfiles(self, files, encode=True):
769
"""See Branch.put_controlfiles."""
772
for path, f in files:
774
if isinstance(f, basestring):
775
f = f.encode('utf-8', 'replace')
777
f = codecs.getwriter('utf-8')(f, errors='replace')
778
path = self._rel_controlfilename(path)
779
ctrl_files.append((path, f))
780
self._transport.put_multi(ctrl_files, mode=self._file_mode)
782
def _find_modes(self, path=None):
783
"""Determine the appropriate modes for files and directories."""
786
path = self._rel_controlfilename('')
787
st = self._transport.stat(path)
788
except errors.TransportNotPossible:
789
self._dir_mode = 0755
790
self._file_mode = 0644
792
self._dir_mode = st.st_mode & 07777
793
# Remove the sticky and execute bits for files
794
self._file_mode = self._dir_mode & ~07111
795
if not self._set_dir_mode:
796
self._dir_mode = None
797
if not self._set_file_mode:
798
self._file_mode = None
800
def _make_control(self):
801
from bzrlib.inventory import Inventory
802
from bzrlib.weavefile import write_weave_v5
803
from bzrlib.weave import Weave
805
# Create an empty inventory
807
# if we want per-tree root ids then this is the place to set
808
# them; they're not needed for now and so ommitted for
810
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
811
empty_inv = sio.getvalue()
813
bzrlib.weavefile.write_weave_v5(Weave(), sio)
814
empty_weave = sio.getvalue()
816
cfn = self._rel_controlfilename
817
# Since we don't have a .bzr directory, inherit the
818
# mode from the root directory
819
self._find_modes(u'.')
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),
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
"""Find file_id(s) which are involved in the changes between revisions.
1142
This determines the set of revisions which are involved, and then
1143
finds all file ids affected by those revisions.
1145
# TODO: jam 20060119 This code assumes that w.inclusions will
1146
# always be correct. But because of the presence of ghosts
1147
# it is possible to be wrong.
1148
# One specific example from Robert Collins:
1149
# Two branches, with revisions ABC, and AD
1150
# C is a ghost merge of D.
1151
# Inclusions doesn't recognize D as an ancestor.
1152
# If D is ever merged in the future, the weave
1153
# won't be fixed, because AD never saw revision C
1154
# to cause a conflict which would force a reweave.
1155
w = self._get_inventory_weave( )
1156
from_set = set(w.inclusions([w.lookup(from_revid)]))
1157
to_set = set(w.inclusions([w.lookup(to_revid)]))
1158
included = to_set.difference(from_set)
1159
changed = map(w.idx_to_name,included)
1160
return self._fileid_involved_by_set(changed)
1162
def fileid_involved(self, last_revid=None):
1163
"""Find all file_ids modified in the ancestry of last_revid.
1165
:param last_revid: If None, last_revision() will be used.
1167
w = self._get_inventory_weave( )
1169
changed = set(w._names)
1171
included = w.inclusions([w.lookup(last_revid)])
1172
changed = map(w.idx_to_name, included)
1173
return self._fileid_involved_by_set(changed)
1175
def fileid_involved_by_set(self, changes):
1176
"""Find all file_ids modified by the set of revisions passed in.
1178
:param changes: A set() of revision ids
1180
# TODO: jam 20060119 This line does *nothing*, remove it.
1181
# or better yet, change _fileid_involved_by_set so
1182
# that it takes the inventory weave, rather than
1183
# pulling it out by itself.
1184
w = self._get_inventory_weave( )
1185
return self._fileid_involved_by_set(changes)
1187
def _fileid_involved_by_set(self, changes):
1188
"""Find the set of file-ids affected by the set of revisions.
1190
:param changes: A set() of revision ids.
1191
:return: A set() of file ids.
1193
This peaks at the Weave, interpreting each line, looking to
1194
see if it mentions one of the revisions. And if so, includes
1195
the file id mentioned.
1196
This expects both the Weave format, and the serialization
1197
to have a single line per file/directory, and to have
1198
fileid="" and revision="" on that line.
1200
assert self._branch_format in (5,6), \
1201
"fileid_involved only supported for branches which store inventory as xml"
1203
w = self._get_inventory_weave( )
1205
for line in w._weave:
1207
# it is ugly, but it is due to the weave structure
1208
if not isinstance(line,basestring): continue
1210
start = line.find('file_id="')+9
1211
if start < 9: continue
1212
end = line.find('"',start)
1214
file_id = xml.sax.saxutils.unescape(line[start:end])
1216
# check if file_id is already present
1217
if file_id in file_ids: continue
1219
start = line.find('revision="')+10
1220
if start < 10: continue
1221
end = line.find('"',start)
1223
revision_id = xml.sax.saxutils.unescape(line[start:end])
1225
if revision_id in changes:
1226
file_ids.add(file_id)
1231
class ScratchBranch(BzrBranch):
1232
"""Special test class: a branch that cleans up after itself.
1234
>>> b = ScratchBranch()
1238
>>> b._transport.__del__()
1243
def __init__(self, files=[], dirs=[], transport=None):
1244
"""Make a test branch.
1246
This creates a temporary directory and runs init-tree in it.
1248
If any files are listed, they are created in the working copy.
1250
if transport is None:
1251
transport = bzrlib.transport.local.ScratchTransport()
1252
super(ScratchBranch, self).__init__(transport, init=True)
1254
super(ScratchBranch, self).__init__(transport)
1257
self._transport.mkdir(d)
1260
self._transport.put(f, 'content of %s' % f)
1265
>>> orig = ScratchBranch(files=["file1", "file2"])
1266
>>> clone = orig.clone()
1267
>>> if os.name != 'nt':
1268
... os.path.samefile(orig.base, clone.base)
1270
... orig.base == clone.base
1273
>>> os.path.isfile(pathjoin(clone.base, "file1"))
1276
from shutil import copytree
1277
from bzrlib.osutils import mkdtemp
1280
copytree(self.base, base, symlinks=True)
1281
return ScratchBranch(
1282
transport=bzrlib.transport.local.ScratchTransport(base))
1285
######################################################################
1289
def is_control_file(filename):
1290
## FIXME: better check
1291
filename = normpath(filename)
1292
while filename != '':
1293
head, tail = os.path.split(filename)
1294
## mutter('check %r for control file' % ((head, tail), ))
1295
if tail == bzrlib.BZRDIR:
1297
if filename == head:
added
removed
bzrlib/branch.py
