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
21
from warnings import warn
22
from cStringIO import StringIO
26
from bzrlib.inventory import InventoryEntry
27
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
30
rename, splitpath, sha_file, appendpath,
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)
37
from bzrlib.textui import show_status
38
from bzrlib.revision import Revision
39
from bzrlib.delta import compare_trees
40
from bzrlib.tree import EmptyTree, RevisionTree
41
from bzrlib.inventory import Inventory
42
from bzrlib.store import copy_all
43
from bzrlib.store.compressed_text import CompressedTextStore
44
from bzrlib.store.text import TextStore
45
from bzrlib.store.weave import WeaveStore
46
import bzrlib.transactions as transactions
47
from bzrlib.transport import Transport, get_transport
52
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
53
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
54
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
55
## TODO: Maybe include checks for common corruption of newlines, etc?
58
# TODO: Some operations like log might retrieve the same revisions
59
# repeatedly to calculate deltas. We could perhaps have a weakref
60
# cache in memory to make this faster. In general anything can be
61
# cached in memory between lock and unlock operations.
63
def find_branch(*ignored, **ignored_too):
64
# XXX: leave this here for about one release, then remove it
65
raise NotImplementedError('find_branch() is not supported anymore, '
66
'please use one of the new branch constructors')
67
def _relpath(base, path):
68
"""Return path relative to base, or raise exception.
70
The path may be either an absolute path or a path relative to the
71
current working directory.
73
Lifted out of Branch.relpath for ease of testing.
75
os.path.commonprefix (python2.4) has a bad bug that it works just
76
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
77
avoids that problem."""
78
rp = os.path.abspath(path)
82
while len(head) >= len(base):
85
head, tail = os.path.split(head)
89
raise NotBranchError("path %r is not within branch %r" % (rp, base))
94
def find_branch_root(t):
95
"""Find the branch root enclosing the transport's base.
97
t is a Transport object.
99
It is not necessary that the base of t exists.
101
Basically we keep looking up until we find the control directory or
102
run into the root. If there isn't one, raises NotBranchError.
106
if t.has(bzrlib.BZRDIR):
108
new_t = t.clone('..')
109
if new_t.base == t.base:
110
# reached the root, whatever that may be
111
raise NotBranchError('%s is not in a branch' % orig_base)
115
######################################################################
118
class Branch(object):
119
"""Branch holding a history of revisions.
122
Base directory/url of the branch.
126
def __init__(self, *ignored, **ignored_too):
127
raise NotImplementedError('The Branch class is abstract')
130
def open_downlevel(base):
131
"""Open a branch which may be of an old format.
133
Only local branches are supported."""
134
return _Branch(get_transport(base), relax_version_check=True)
138
"""Open an existing branch, rooted at 'base' (url)"""
139
t = get_transport(base)
140
mutter("trying to open %r with transport %r", base, t)
144
def open_containing(url):
145
"""Open an existing branch which contains url.
147
This probes for a branch at url, and searches upwards from there.
149
t = get_transport(url)
150
t = find_branch_root(t)
154
def initialize(base):
155
"""Create a new branch, rooted at 'base' (url)"""
156
t = get_transport(base)
157
return _Branch(t, init=True)
159
def setup_caching(self, cache_root):
160
"""Subclasses that care about caching should override this, and set
161
up cached stores located under cache_root.
163
self.cache_root = cache_root
166
class _Branch(Branch):
167
"""A branch stored in the actual filesystem.
169
Note that it's "local" in the context of the filesystem; it doesn't
170
really matter if it's on an nfs/smb/afs/coda/... share, as long as
171
it's writable, and can be accessed via the normal filesystem API.
177
If _lock_mode is true, a positive count of the number of times the
181
Lock object from bzrlib.lock.
183
# We actually expect this class to be somewhat short-lived; part of its
184
# purpose is to try to isolate what bits of the branch logic are tied to
185
# filesystem access, so that in a later step, we can extricate them to
186
# a separarte ("storage") class.
190
_inventory_weave = None
192
# Map some sort of prefix into a namespace
193
# stuff like "revno:10", "revid:", etc.
194
# This should match a prefix with a function which accepts
195
REVISION_NAMESPACES = {}
197
def push_stores(self, branch_to):
198
"""Copy the content of this branches store to branch_to."""
199
if (self._branch_format != branch_to._branch_format
200
or self._branch_format != 4):
201
from bzrlib.fetch import greedy_fetch
202
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
203
self, self._branch_format, branch_to, branch_to._branch_format)
204
greedy_fetch(to_branch=branch_to, from_branch=self,
205
revision=self.last_revision())
208
store_pairs = ((self.text_store, branch_to.text_store),
209
(self.inventory_store, branch_to.inventory_store),
210
(self.revision_store, branch_to.revision_store))
212
for from_store, to_store in store_pairs:
213
copy_all(from_store, to_store)
214
except UnlistableStore:
215
raise UnlistableBranch(from_store)
217
def __init__(self, transport, init=False,
218
relax_version_check=False):
219
"""Create new branch object at a particular location.
221
transport -- A Transport object, defining how to access files.
222
(If a string, transport.transport() will be used to
223
create a Transport object)
225
init -- If True, create new control files in a previously
226
unversioned directory. If False, the branch must already
229
relax_version_check -- If true, the usual check for the branch
230
version is not applied. This is intended only for
231
upgrade/recovery type use; it's not guaranteed that
232
all operations will work on old format branches.
234
In the test suite, creation of new trees is tested using the
235
`ScratchBranch` class.
237
assert isinstance(transport, Transport), \
238
"%r is not a Transport" % transport
239
self._transport = transport
242
self._check_format(relax_version_check)
244
def get_store(name, compressed=True, prefixed=False):
245
# FIXME: This approach of assuming stores are all entirely compressed
246
# or entirely uncompressed is tidy, but breaks upgrade from
247
# some existing branches where there's a mixture; we probably
248
# still want the option to look for both.
249
relpath = self._rel_controlfilename(name)
251
store = CompressedTextStore(self._transport.clone(relpath),
254
store = TextStore(self._transport.clone(relpath),
256
#if self._transport.should_cache():
257
# cache_path = os.path.join(self.cache_root, name)
258
# os.mkdir(cache_path)
259
# store = bzrlib.store.CachedStore(store, cache_path)
261
def get_weave(name, prefixed=False):
262
relpath = self._rel_controlfilename(name)
263
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
264
if self._transport.should_cache():
265
ws.enable_cache = True
268
if self._branch_format == 4:
269
self.inventory_store = get_store('inventory-store')
270
self.text_store = get_store('text-store')
271
self.revision_store = get_store('revision-store')
272
elif self._branch_format == 5:
273
self.control_weaves = get_weave([])
274
self.weave_store = get_weave('weaves')
275
self.revision_store = get_store('revision-store', compressed=False)
276
elif self._branch_format == 6:
277
self.control_weaves = get_weave([])
278
self.weave_store = get_weave('weaves', prefixed=True)
279
self.revision_store = get_store('revision-store', compressed=False,
281
self._transaction = None
284
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
291
if self._lock_mode or self._lock:
292
# XXX: This should show something every time, and be suitable for
293
# headless operation and embedding
294
warn("branch %r was not explicitly unlocked" % self)
297
# TODO: It might be best to do this somewhere else,
298
# but it is nice for a Branch object to automatically
299
# cache it's information.
300
# Alternatively, we could have the Transport objects cache requests
301
# See the earlier discussion about how major objects (like Branch)
302
# should never expect their __del__ function to run.
303
if hasattr(self, 'cache_root') and self.cache_root is not None:
306
shutil.rmtree(self.cache_root)
309
self.cache_root = None
313
return self._transport.base
316
base = property(_get_base)
318
def _finish_transaction(self):
319
"""Exit the current transaction."""
320
if self._transaction is None:
321
raise errors.LockError('Branch %s is not in a transaction' %
323
transaction = self._transaction
324
self._transaction = None
327
def get_transaction(self):
328
"""Return the current active transaction.
330
If no transaction is active, this returns a passthrough object
331
for which all data is immedaitely flushed and no caching happens.
333
if self._transaction is None:
334
return transactions.PassThroughTransaction()
336
return self._transaction
338
def _set_transaction(self, new_transaction):
339
"""Set a new active transaction."""
340
if self._transaction is not None:
341
raise errors.LockError('Branch %s is in a transaction already.' %
343
self._transaction = new_transaction
345
def lock_write(self):
346
mutter("lock write: %s (%s)", self, self._lock_count)
347
# TODO: Upgrade locking to support using a Transport,
348
# and potentially a remote locking protocol
350
if self._lock_mode != 'w':
351
raise LockError("can't upgrade to a write lock from %r" %
353
self._lock_count += 1
355
self._lock = self._transport.lock_write(
356
self._rel_controlfilename('branch-lock'))
357
self._lock_mode = 'w'
359
self._set_transaction(transactions.PassThroughTransaction())
362
mutter("lock read: %s (%s)", self, self._lock_count)
364
assert self._lock_mode in ('r', 'w'), \
365
"invalid lock mode %r" % self._lock_mode
366
self._lock_count += 1
368
self._lock = self._transport.lock_read(
369
self._rel_controlfilename('branch-lock'))
370
self._lock_mode = 'r'
372
self._set_transaction(transactions.ReadOnlyTransaction())
373
# 5K may be excessive, but hey, its a knob.
374
self.get_transaction().set_cache_size(5000)
377
mutter("unlock: %s (%s)", self, self._lock_count)
378
if not self._lock_mode:
379
raise LockError('branch %r is not locked' % (self))
381
if self._lock_count > 1:
382
self._lock_count -= 1
384
self._finish_transaction()
387
self._lock_mode = self._lock_count = None
389
def abspath(self, name):
390
"""Return absolute filename for something in the branch"""
391
return self._transport.abspath(name)
393
def relpath(self, path):
394
"""Return path relative to this branch of something inside it.
396
Raises an error if path is not in this branch."""
397
return self._transport.relpath(path)
400
def _rel_controlfilename(self, file_or_path):
401
if isinstance(file_or_path, basestring):
402
file_or_path = [file_or_path]
403
return [bzrlib.BZRDIR] + file_or_path
405
def controlfilename(self, file_or_path):
406
"""Return location relative to branch."""
407
return self._transport.abspath(self._rel_controlfilename(file_or_path))
410
def controlfile(self, file_or_path, mode='r'):
411
"""Open a control file for this branch.
413
There are two classes of file in the control directory: text
414
and binary. binary files are untranslated byte streams. Text
415
control files are stored with Unix newlines and in UTF-8, even
416
if the platform or locale defaults are different.
418
Controlfiles should almost never be opened in write mode but
419
rather should be atomically copied and replaced using atomicfile.
423
relpath = self._rel_controlfilename(file_or_path)
424
#TODO: codecs.open() buffers linewise, so it was overloaded with
425
# a much larger buffer, do we need to do the same for getreader/getwriter?
427
return self._transport.get(relpath)
429
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
431
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
433
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
435
raise BzrError("invalid controlfile mode %r" % mode)
437
def put_controlfile(self, path, f, encode=True):
438
"""Write an entry as a controlfile.
440
:param path: The path to put the file, relative to the .bzr control
442
:param f: A file-like or string object whose contents should be copied.
443
:param encode: If true, encode the contents as utf-8
445
self.put_controlfiles([(path, f)], encode=encode)
447
def put_controlfiles(self, files, encode=True):
448
"""Write several entries as controlfiles.
450
:param files: A list of [(path, file)] pairs, where the path is the directory
451
underneath the bzr control directory
452
:param encode: If true, encode the contents as utf-8
456
for path, f in files:
458
if isinstance(f, basestring):
459
f = f.encode('utf-8', 'replace')
461
f = codecs.getwriter('utf-8')(f, errors='replace')
462
path = self._rel_controlfilename(path)
463
ctrl_files.append((path, f))
464
self._transport.put_multi(ctrl_files)
466
def _make_control(self):
467
from bzrlib.inventory import Inventory
468
from bzrlib.weavefile import write_weave_v5
469
from bzrlib.weave import Weave
471
# Create an empty inventory
473
# if we want per-tree root ids then this is the place to set
474
# them; they're not needed for now and so ommitted for
476
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
477
empty_inv = sio.getvalue()
479
bzrlib.weavefile.write_weave_v5(Weave(), sio)
480
empty_weave = sio.getvalue()
482
dirs = [[], 'revision-store', 'weaves']
484
"This is a Bazaar-NG control directory.\n"
485
"Do not change any files in this directory.\n"),
486
('branch-format', BZR_BRANCH_FORMAT_6),
487
('revision-history', ''),
490
('pending-merges', ''),
491
('inventory', empty_inv),
492
('inventory.weave', empty_weave),
493
('ancestry.weave', empty_weave)
495
cfn = self._rel_controlfilename
496
self._transport.mkdir_multi([cfn(d) for d in dirs])
497
self.put_controlfiles(files)
498
mutter('created control directory in ' + self._transport.base)
500
def _check_format(self, relax_version_check):
501
"""Check this branch format is supported.
503
The format level is stored, as an integer, in
504
self._branch_format for code that needs to check it later.
506
In the future, we might need different in-memory Branch
507
classes to support downlevel branches. But not yet.
510
fmt = self.controlfile('branch-format', 'r').read()
512
raise NotBranchError(self.base)
513
mutter("got branch format %r", fmt)
514
if fmt == BZR_BRANCH_FORMAT_6:
515
self._branch_format = 6
516
elif fmt == BZR_BRANCH_FORMAT_5:
517
self._branch_format = 5
518
elif fmt == BZR_BRANCH_FORMAT_4:
519
self._branch_format = 4
521
if (not relax_version_check
522
and self._branch_format not in (5, 6)):
523
raise errors.UnsupportedFormatError(
524
'sorry, branch format %r not supported' % fmt,
525
['use a different bzr version',
526
'or remove the .bzr directory'
527
' and "bzr init" again'])
529
def get_root_id(self):
530
"""Return the id of this branches root"""
531
inv = self.read_working_inventory()
532
return inv.root.file_id
534
def set_root_id(self, file_id):
535
inv = self.read_working_inventory()
536
orig_root_id = inv.root.file_id
537
del inv._byid[inv.root.file_id]
538
inv.root.file_id = file_id
539
inv._byid[inv.root.file_id] = inv.root
542
if entry.parent_id in (None, orig_root_id):
543
entry.parent_id = inv.root.file_id
544
self._write_inventory(inv)
546
def read_working_inventory(self):
547
"""Read the working inventory."""
550
# ElementTree does its own conversion from UTF-8, so open in
552
f = self.controlfile('inventory', 'rb')
553
return bzrlib.xml5.serializer_v5.read_inventory(f)
558
def _write_inventory(self, inv):
559
"""Update the working inventory.
561
That is to say, the inventory describing changes underway, that
562
will be committed to the next revision.
564
from cStringIO import StringIO
568
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
570
# Transport handles atomicity
571
self.put_controlfile('inventory', sio)
575
mutter('wrote working inventory')
577
inventory = property(read_working_inventory, _write_inventory, None,
578
"""Inventory for the working copy.""")
580
def add(self, files, ids=None):
581
"""Make files versioned.
583
Note that the command line normally calls smart_add instead,
584
which can automatically recurse.
586
This puts the files in the Added state, so that they will be
587
recorded by the next commit.
590
List of paths to add, relative to the base of the tree.
593
If set, use these instead of automatically generated ids.
594
Must be the same length as the list of files, but may
595
contain None for ids that are to be autogenerated.
597
TODO: Perhaps have an option to add the ids even if the files do
600
TODO: Perhaps yield the ids and paths as they're added.
602
# TODO: Re-adding a file that is removed in the working copy
603
# should probably put it back with the previous ID.
604
if isinstance(files, basestring):
605
assert(ids is None or isinstance(ids, basestring))
611
ids = [None] * len(files)
613
assert(len(ids) == len(files))
617
inv = self.read_working_inventory()
618
for f,file_id in zip(files, ids):
619
if is_control_file(f):
620
raise BzrError("cannot add control file %s" % quotefn(f))
625
raise BzrError("cannot add top-level %r" % f)
627
fullpath = os.path.normpath(self.abspath(f))
630
kind = file_kind(fullpath)
632
# maybe something better?
633
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
635
if not InventoryEntry.versionable_kind(kind):
636
raise BzrError('cannot add: not a versionable file ('
637
'i.e. regular file, symlink or directory): %s' % quotefn(f))
640
file_id = gen_file_id(f)
641
inv.add_path(f, kind=kind, file_id=file_id)
643
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
645
self._write_inventory(inv)
650
def print_file(self, file, revno):
651
"""Print `file` to stdout."""
654
tree = self.revision_tree(self.get_rev_id(revno))
655
# use inventory as it was in that revision
656
file_id = tree.inventory.path2id(file)
658
raise BzrError("%r is not present in revision %s" % (file, revno))
659
tree.print_file(file_id)
664
def remove(self, files, verbose=False):
665
"""Mark nominated files for removal from the inventory.
667
This does not remove their text. This does not run on
669
TODO: Refuse to remove modified files unless --force is given?
671
TODO: Do something useful with directories.
673
TODO: Should this remove the text or not? Tough call; not
674
removing may be useful and the user can just use use rm, and
675
is the opposite of add. Removing it is consistent with most
676
other tools. Maybe an option.
678
## TODO: Normalize names
679
## TODO: Remove nested loops; better scalability
680
if isinstance(files, basestring):
686
tree = self.working_tree()
689
# do this before any modifications
693
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
694
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
696
# having remove it, it must be either ignored or unknown
697
if tree.is_ignored(f):
701
show_status(new_status, inv[fid].kind, quotefn(f))
704
self._write_inventory(inv)
708
# FIXME: this doesn't need to be a branch method
709
def set_inventory(self, new_inventory_list):
710
from bzrlib.inventory import Inventory, InventoryEntry
711
inv = Inventory(self.get_root_id())
712
for path, file_id, parent, kind in new_inventory_list:
713
name = os.path.basename(path)
716
# fixme, there should be a factory function inv,add_??
717
if kind == 'directory':
718
inv.add(inventory.InventoryDirectory(file_id, name, parent))
720
inv.add(inventory.InventoryFile(file_id, name, parent))
721
elif kind == 'symlink':
722
inv.add(inventory.InventoryLink(file_id, name, parent))
724
raise BzrError("unknown kind %r" % kind)
725
self._write_inventory(inv)
728
"""Return all unknown files.
730
These are files in the working directory that are not versioned or
731
control files or ignored.
733
>>> b = ScratchBranch(files=['foo', 'foo~'])
734
>>> list(b.unknowns())
737
>>> list(b.unknowns())
740
>>> list(b.unknowns())
743
return self.working_tree().unknowns()
746
def append_revision(self, *revision_ids):
747
for revision_id in revision_ids:
748
mutter("add {%s} to revision-history" % revision_id)
751
rev_history = self.revision_history()
752
rev_history.extend(revision_ids)
753
self.put_controlfile('revision-history', '\n'.join(rev_history))
757
def has_revision(self, revision_id):
758
"""True if this branch has a copy of the revision.
760
This does not necessarily imply the revision is merge
761
or on the mainline."""
762
return (revision_id is None
763
or revision_id in self.revision_store)
765
def get_revision_xml_file(self, revision_id):
766
"""Return XML file object for revision object."""
767
if not revision_id or not isinstance(revision_id, basestring):
768
raise InvalidRevisionId(revision_id)
773
return self.revision_store[revision_id]
774
except (IndexError, KeyError):
775
raise bzrlib.errors.NoSuchRevision(self, revision_id)
780
get_revision_xml = get_revision_xml_file
782
def get_revision_xml(self, revision_id):
783
return self.get_revision_xml_file(revision_id).read()
786
def get_revision(self, revision_id):
787
"""Return the Revision object for a named revision"""
788
xml_file = self.get_revision_xml_file(revision_id)
791
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
792
except SyntaxError, e:
793
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
797
assert r.revision_id == revision_id
800
def get_revision_delta(self, revno):
801
"""Return the delta for one revision.
803
The delta is relative to its mainline predecessor, or the
804
empty tree for revision 1.
806
assert isinstance(revno, int)
807
rh = self.revision_history()
808
if not (1 <= revno <= len(rh)):
809
raise InvalidRevisionNumber(revno)
811
# revno is 1-based; list is 0-based
813
new_tree = self.revision_tree(rh[revno-1])
815
old_tree = EmptyTree()
817
old_tree = self.revision_tree(rh[revno-2])
819
return compare_trees(old_tree, new_tree)
821
def get_revision_sha1(self, revision_id):
822
"""Hash the stored value of a revision, and return it."""
823
# In the future, revision entries will be signed. At that
824
# point, it is probably best *not* to include the signature
825
# in the revision hash. Because that lets you re-sign
826
# the revision, (add signatures/remove signatures) and still
827
# have all hash pointers stay consistent.
828
# But for now, just hash the contents.
829
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
831
def get_ancestry(self, revision_id):
832
"""Return a list of revision-ids integrated by a revision.
834
This currently returns a list, but the ordering is not guaranteed:
837
if revision_id is None:
839
w = self.get_inventory_weave()
840
return [None] + map(w.idx_to_name,
841
w.inclusions([w.lookup(revision_id)]))
843
def get_inventory_weave(self):
844
return self.control_weaves.get_weave('inventory',
845
self.get_transaction())
847
def get_inventory(self, revision_id):
848
"""Get Inventory object by hash."""
849
xml = self.get_inventory_xml(revision_id)
850
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
852
def get_inventory_xml(self, revision_id):
853
"""Get inventory XML as a file object."""
855
assert isinstance(revision_id, basestring), type(revision_id)
856
iw = self.get_inventory_weave()
857
return iw.get_text(iw.lookup(revision_id))
859
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
861
def get_inventory_sha1(self, revision_id):
862
"""Return the sha1 hash of the inventory entry
864
return self.get_revision(revision_id).inventory_sha1
866
def get_revision_inventory(self, revision_id):
867
"""Return inventory of a past revision."""
868
# TODO: Unify this with get_inventory()
869
# bzr 0.0.6 and later imposes the constraint that the inventory_id
870
# must be the same as its revision, so this is trivial.
871
if revision_id == None:
872
return Inventory(self.get_root_id())
874
return self.get_inventory(revision_id)
876
def revision_history(self):
877
"""Return sequence of revision hashes on to this branch."""
880
transaction = self.get_transaction()
881
history = transaction.map.find_revision_history()
882
if history is not None:
883
mutter("cache hit for revision-history in %s", self)
885
history = [l.rstrip('\r\n') for l in
886
self.controlfile('revision-history', 'r').readlines()]
887
transaction.map.add_revision_history(history)
888
# this call is disabled because revision_history is
889
# not really an object yet, and the transaction is for objects.
890
# transaction.register_clean(history, precious=True)
895
def common_ancestor(self, other, self_revno=None, other_revno=None):
897
>>> from bzrlib.commit import commit
898
>>> sb = ScratchBranch(files=['foo', 'foo~'])
899
>>> sb.common_ancestor(sb) == (None, None)
901
>>> commit(sb, "Committing first revision", verbose=False)
902
>>> sb.common_ancestor(sb)[0]
904
>>> clone = sb.clone()
905
>>> commit(sb, "Committing second revision", verbose=False)
906
>>> sb.common_ancestor(sb)[0]
908
>>> sb.common_ancestor(clone)[0]
910
>>> commit(clone, "Committing divergent second revision",
912
>>> sb.common_ancestor(clone)[0]
914
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
916
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
918
>>> clone2 = sb.clone()
919
>>> sb.common_ancestor(clone2)[0]
921
>>> sb.common_ancestor(clone2, self_revno=1)[0]
923
>>> sb.common_ancestor(clone2, other_revno=1)[0]
926
my_history = self.revision_history()
927
other_history = other.revision_history()
928
if self_revno is None:
929
self_revno = len(my_history)
930
if other_revno is None:
931
other_revno = len(other_history)
932
indices = range(min((self_revno, other_revno)))
935
if my_history[r] == other_history[r]:
936
return r+1, my_history[r]
941
"""Return current revision number for this branch.
943
That is equivalent to the number of revisions committed to
946
return len(self.revision_history())
949
def last_revision(self):
950
"""Return last patch hash, or None if no history.
952
ph = self.revision_history()
959
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
960
"""Return a list of new revisions that would perfectly fit.
962
If self and other have not diverged, return a list of the revisions
963
present in other, but missing from self.
965
>>> from bzrlib.commit import commit
966
>>> bzrlib.trace.silent = True
967
>>> br1 = ScratchBranch()
968
>>> br2 = ScratchBranch()
969
>>> br1.missing_revisions(br2)
971
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
972
>>> br1.missing_revisions(br2)
974
>>> br2.missing_revisions(br1)
976
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
977
>>> br1.missing_revisions(br2)
979
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
980
>>> br1.missing_revisions(br2)
982
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
983
>>> br1.missing_revisions(br2)
984
Traceback (most recent call last):
985
DivergedBranches: These branches have diverged.
987
# FIXME: If the branches have diverged, but the latest
988
# revision in this branch is completely merged into the other,
989
# then we should still be able to pull.
990
self_history = self.revision_history()
991
self_len = len(self_history)
992
other_history = other.revision_history()
993
other_len = len(other_history)
994
common_index = min(self_len, other_len) -1
995
if common_index >= 0 and \
996
self_history[common_index] != other_history[common_index]:
997
raise DivergedBranches(self, other)
999
if stop_revision is None:
1000
stop_revision = other_len
1002
assert isinstance(stop_revision, int)
1003
if stop_revision > other_len:
1004
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
1005
return other_history[self_len:stop_revision]
1007
def update_revisions(self, other, stop_revision=None):
1008
"""Pull in new perfect-fit revisions."""
1009
from bzrlib.fetch import greedy_fetch
1010
from bzrlib.revision import get_intervening_revisions
1011
if stop_revision is None:
1012
stop_revision = other.last_revision()
1013
if (stop_revision is not None and
1014
stop_revision in self.revision_history()):
1016
greedy_fetch(to_branch=self, from_branch=other,
1017
revision=stop_revision)
1018
pullable_revs = self.missing_revisions(
1019
other, other.revision_id_to_revno(stop_revision))
1021
greedy_fetch(to_branch=self,
1023
revision=pullable_revs[-1])
1024
self.append_revision(*pullable_revs)
1027
def commit(self, *args, **kw):
1028
from bzrlib.commit import Commit
1029
Commit().commit(self, *args, **kw)
1031
def revision_id_to_revno(self, revision_id):
1032
"""Given a revision id, return its revno"""
1033
if revision_id is None:
1035
history = self.revision_history()
1037
return history.index(revision_id) + 1
1039
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1041
def get_rev_id(self, revno, history=None):
1042
"""Find the revision id of the specified revno."""
1046
history = self.revision_history()
1047
elif revno <= 0 or revno > len(history):
1048
raise bzrlib.errors.NoSuchRevision(self, revno)
1049
return history[revno - 1]
1051
def revision_tree(self, revision_id):
1052
"""Return Tree for a revision on this branch.
1054
`revision_id` may be None for the null revision, in which case
1055
an `EmptyTree` is returned."""
1056
# TODO: refactor this to use an existing revision object
1057
# so we don't need to read it in twice.
1058
if revision_id == None:
1061
inv = self.get_revision_inventory(revision_id)
1062
return RevisionTree(self.weave_store, inv, revision_id)
1065
def working_tree(self):
1066
"""Return a `Tree` for the working copy."""
1067
from bzrlib.workingtree import WorkingTree
1068
# TODO: In the future, WorkingTree should utilize Transport
1069
# RobertCollins 20051003 - I don't think it should - working trees are
1070
# much more complex to keep consistent than our careful .bzr subset.
1071
# instead, we should say that working trees are local only, and optimise
1073
return WorkingTree(self._transport.base, self.read_working_inventory())
1076
def basis_tree(self):
1077
"""Return `Tree` object for last revision.
1079
If there are no revisions yet, return an `EmptyTree`.
1081
return self.revision_tree(self.last_revision())
1084
def rename_one(self, from_rel, to_rel):
1087
This can change the directory or the filename or both.
1091
tree = self.working_tree()
1092
inv = tree.inventory
1093
if not tree.has_filename(from_rel):
1094
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1095
if tree.has_filename(to_rel):
1096
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1098
file_id = inv.path2id(from_rel)
1100
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1102
if inv.path2id(to_rel):
1103
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1105
to_dir, to_tail = os.path.split(to_rel)
1106
to_dir_id = inv.path2id(to_dir)
1107
if to_dir_id == None and to_dir != '':
1108
raise BzrError("can't determine destination directory id for %r" % to_dir)
1110
mutter("rename_one:")
1111
mutter(" file_id {%s}" % file_id)
1112
mutter(" from_rel %r" % from_rel)
1113
mutter(" to_rel %r" % to_rel)
1114
mutter(" to_dir %r" % to_dir)
1115
mutter(" to_dir_id {%s}" % to_dir_id)
1117
inv.rename(file_id, to_dir_id, to_tail)
1119
from_abs = self.abspath(from_rel)
1120
to_abs = self.abspath(to_rel)
1122
rename(from_abs, to_abs)
1124
raise BzrError("failed to rename %r to %r: %s"
1125
% (from_abs, to_abs, e[1]),
1126
["rename rolled back"])
1128
self._write_inventory(inv)
1133
def move(self, from_paths, to_name):
1136
to_name must exist as a versioned directory.
1138
If to_name exists and is a directory, the files are moved into
1139
it, keeping their old names. If it is a directory,
1141
Note that to_name is only the last component of the new name;
1142
this doesn't change the directory.
1144
This returns a list of (from_path, to_path) pairs for each
1145
entry that is moved.
1150
## TODO: Option to move IDs only
1151
assert not isinstance(from_paths, basestring)
1152
tree = self.working_tree()
1153
inv = tree.inventory
1154
to_abs = self.abspath(to_name)
1155
if not isdir(to_abs):
1156
raise BzrError("destination %r is not a directory" % to_abs)
1157
if not tree.has_filename(to_name):
1158
raise BzrError("destination %r not in working directory" % to_abs)
1159
to_dir_id = inv.path2id(to_name)
1160
if to_dir_id == None and to_name != '':
1161
raise BzrError("destination %r is not a versioned directory" % to_name)
1162
to_dir_ie = inv[to_dir_id]
1163
if to_dir_ie.kind not in ('directory', 'root_directory'):
1164
raise BzrError("destination %r is not a directory" % to_abs)
1166
to_idpath = inv.get_idpath(to_dir_id)
1168
for f in from_paths:
1169
if not tree.has_filename(f):
1170
raise BzrError("%r does not exist in working tree" % f)
1171
f_id = inv.path2id(f)
1173
raise BzrError("%r is not versioned" % f)
1174
name_tail = splitpath(f)[-1]
1175
dest_path = appendpath(to_name, name_tail)
1176
if tree.has_filename(dest_path):
1177
raise BzrError("destination %r already exists" % dest_path)
1178
if f_id in to_idpath:
1179
raise BzrError("can't move %r to a subdirectory of itself" % f)
1181
# OK, so there's a race here, it's possible that someone will
1182
# create a file in this interval and then the rename might be
1183
# left half-done. But we should have caught most problems.
1185
for f in from_paths:
1186
name_tail = splitpath(f)[-1]
1187
dest_path = appendpath(to_name, name_tail)
1188
result.append((f, dest_path))
1189
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1191
rename(self.abspath(f), self.abspath(dest_path))
1193
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1194
["rename rolled back"])
1196
self._write_inventory(inv)
1203
def revert(self, filenames, old_tree=None, backups=True):
1204
"""Restore selected files to the versions from a previous tree.
1207
If true (default) backups are made of files before
1210
from bzrlib.errors import NotVersionedError, BzrError
1211
from bzrlib.atomicfile import AtomicFile
1212
from bzrlib.osutils import backup_file
1214
inv = self.read_working_inventory()
1215
if old_tree is None:
1216
old_tree = self.basis_tree()
1217
old_inv = old_tree.inventory
1220
for fn in filenames:
1221
file_id = inv.path2id(fn)
1223
raise NotVersionedError("not a versioned file", fn)
1224
if not old_inv.has_id(file_id):
1225
raise BzrError("file not present in old tree", fn, file_id)
1226
nids.append((fn, file_id))
1228
# TODO: Rename back if it was previously at a different location
1230
# TODO: If given a directory, restore the entire contents from
1231
# the previous version.
1233
# TODO: Make a backup to a temporary file.
1235
# TODO: If the file previously didn't exist, delete it?
1236
for fn, file_id in nids:
1239
f = AtomicFile(fn, 'wb')
1241
f.write(old_tree.get_file(file_id).read())
1247
def pending_merges(self):
1248
"""Return a list of pending merges.
1250
These are revisions that have been merged into the working
1251
directory but not yet committed.
1253
cfn = self._rel_controlfilename('pending-merges')
1254
if not self._transport.has(cfn):
1257
for l in self.controlfile('pending-merges', 'r').readlines():
1258
p.append(l.rstrip('\n'))
1262
def add_pending_merge(self, *revision_ids):
1263
# TODO: Perhaps should check at this point that the
1264
# history of the revision is actually present?
1265
p = self.pending_merges()
1267
for rev_id in revision_ids:
1273
self.set_pending_merges(p)
1275
def set_pending_merges(self, rev_list):
1278
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1283
def get_parent(self):
1284
"""Return the parent location of the branch.
1286
This is the default location for push/pull/missing. The usual
1287
pattern is that the user can override it by specifying a
1291
_locs = ['parent', 'pull', 'x-pull']
1294
return self.controlfile(l, 'r').read().strip('\n')
1296
if e.errno != errno.ENOENT:
1301
def set_parent(self, url):
1302
# TODO: Maybe delete old location files?
1303
from bzrlib.atomicfile import AtomicFile
1306
f = AtomicFile(self.controlfilename('parent'))
1315
def check_revno(self, revno):
1317
Check whether a revno corresponds to any revision.
1318
Zero (the NULL revision) is considered valid.
1321
self.check_real_revno(revno)
1323
def check_real_revno(self, revno):
1325
Check whether a revno corresponds to a real revision.
1326
Zero (the NULL revision) is considered invalid
1328
if revno < 1 or revno > self.revno():
1329
raise InvalidRevisionNumber(revno)
1335
class ScratchBranch(_Branch):
1336
"""Special test class: a branch that cleans up after itself.
1338
>>> b = ScratchBranch()
1346
def __init__(self, files=[], dirs=[], base=None):
1347
"""Make a test branch.
1349
This creates a temporary directory and runs init-tree in it.
1351
If any files are listed, they are created in the working copy.
1353
from tempfile import mkdtemp
1358
if isinstance(base, basestring):
1359
base = get_transport(base)
1360
_Branch.__init__(self, base, init=init)
1362
self._transport.mkdir(d)
1365
self._transport.put(f, 'content of %s' % f)
1370
>>> orig = ScratchBranch(files=["file1", "file2"])
1371
>>> clone = orig.clone()
1372
>>> if os.name != 'nt':
1373
... os.path.samefile(orig.base, clone.base)
1375
... orig.base == clone.base
1378
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1381
from shutil import copytree
1382
from tempfile import mkdtemp
1385
copytree(self.base, base, symlinks=True)
1386
return ScratchBranch(base=base)
1392
"""Destroy the test branch, removing the scratch directory."""
1393
from shutil import rmtree
1396
mutter("delete ScratchBranch %s" % self.base)
1399
# Work around for shutil.rmtree failing on Windows when
1400
# readonly files are encountered
1401
mutter("hit exception in destroying ScratchBranch: %s" % e)
1402
for root, dirs, files in os.walk(self.base, topdown=False):
1404
os.chmod(os.path.join(root, name), 0700)
1406
self._transport = None
1410
######################################################################
1414
def is_control_file(filename):
1415
## FIXME: better check
1416
filename = os.path.normpath(filename)
1417
while filename != '':
1418
head, tail = os.path.split(filename)
1419
## mutter('check %r for control file' % ((head, tail), ))
1420
if tail == bzrlib.BZRDIR:
1422
if filename == head:
1429
def gen_file_id(name):
1430
"""Return new file id.
1432
This should probably generate proper UUIDs, but for the moment we
1433
cope with just randomness because running uuidgen every time is
1436
from binascii import hexlify
1437
from time import time
1439
# get last component
1440
idx = name.rfind('/')
1442
name = name[idx+1 : ]
1443
idx = name.rfind('\\')
1445
name = name[idx+1 : ]
1447
# make it not a hidden file
1448
name = name.lstrip('.')
1450
# remove any wierd characters; we don't escape them but rather
1451
# just pull them out
1452
name = re.sub(r'[^\w.]', '', name)
1454
s = hexlify(rand_bytes(8))
1455
return '-'.join((name, compact_date(time()), s))
1459
"""Return a new tree-root file id."""
1460
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
