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
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
33
NoSuchRevision, HistoryMissing, NotBranchError,
34
DivergedBranches, LockError, UnlistableStore,
35
UnlistableBranch, NoSuchFile)
36
from bzrlib.textui import show_status
37
from bzrlib.revision import Revision, is_ancestor
38
from bzrlib.delta import compare_trees
39
from bzrlib.tree import EmptyTree, RevisionTree
40
from bzrlib.inventory import Inventory
41
from bzrlib.store import copy_all
42
from bzrlib.store.compressed_text import CompressedTextStore
43
from bzrlib.store.text import TextStore
44
from bzrlib.store.weave import WeaveStore
45
from bzrlib.transport import Transport, get_transport
50
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
51
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
52
## TODO: Maybe include checks for common corruption of newlines, etc?
55
# TODO: Some operations like log might retrieve the same revisions
56
# repeatedly to calculate deltas. We could perhaps have a weakref
57
# cache in memory to make this faster. In general anything can be
58
# cached in memory between lock and unlock operations.
60
def find_branch(*ignored, **ignored_too):
61
# XXX: leave this here for about one release, then remove it
62
raise NotImplementedError('find_branch() is not supported anymore, '
63
'please use one of the new branch constructors')
64
def _relpath(base, path):
65
"""Return path relative to base, or raise exception.
67
The path may be either an absolute path or a path relative to the
68
current working directory.
70
Lifted out of Branch.relpath for ease of testing.
72
os.path.commonprefix (python2.4) has a bad bug that it works just
73
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
74
avoids that problem."""
75
rp = os.path.abspath(path)
79
while len(head) >= len(base):
82
head, tail = os.path.split(head)
86
raise NotBranchError("path %r is not within branch %r" % (rp, base))
91
def find_branch_root(t):
92
"""Find the branch root enclosing the transport's base.
94
t is a Transport object.
96
It is not necessary that the base of t exists.
98
Basically we keep looking up until we find the control directory or
99
run into the root. If there isn't one, raises NotBranchError.
103
if t.has(bzrlib.BZRDIR):
105
new_t = t.clone('..')
106
if new_t.base == t.base:
107
# reached the root, whatever that may be
108
raise NotBranchError('%s is not in a branch' % orig_base)
112
######################################################################
115
class Branch(object):
116
"""Branch holding a history of revisions.
119
Base directory/url of the branch.
123
def __init__(self, *ignored, **ignored_too):
124
raise NotImplementedError('The Branch class is abstract')
127
def open_downlevel(base):
128
"""Open a branch which may be of an old format.
130
Only local branches are supported."""
131
return _Branch(get_transport(base), relax_version_check=True)
135
"""Open an existing branch, rooted at 'base' (url)"""
136
t = get_transport(base)
140
def open_containing(url):
141
"""Open an existing branch which contains url.
143
This probes for a branch at url, and searches upwards from there.
145
t = get_transport(url)
146
t = find_branch_root(t)
150
def initialize(base):
151
"""Create a new branch, rooted at 'base' (url)"""
152
t = get_transport(base)
153
return _Branch(t, init=True)
155
def setup_caching(self, cache_root):
156
"""Subclasses that care about caching should override this, and set
157
up cached stores located under cache_root.
159
self.cache_root = cache_root
162
class _Branch(Branch):
163
"""A branch stored in the actual filesystem.
165
Note that it's "local" in the context of the filesystem; it doesn't
166
really matter if it's on an nfs/smb/afs/coda/... share, as long as
167
it's writable, and can be accessed via the normal filesystem API.
173
If _lock_mode is true, a positive count of the number of times the
177
Lock object from bzrlib.lock.
179
# We actually expect this class to be somewhat short-lived; part of its
180
# purpose is to try to isolate what bits of the branch logic are tied to
181
# filesystem access, so that in a later step, we can extricate them to
182
# a separarte ("storage") class.
186
_inventory_weave = None
188
# Map some sort of prefix into a namespace
189
# stuff like "revno:10", "revid:", etc.
190
# This should match a prefix with a function which accepts
191
REVISION_NAMESPACES = {}
193
def push_stores(self, branch_to):
194
"""Copy the content of this branches store to branch_to."""
195
if (self._branch_format != branch_to._branch_format
196
or self._branch_format != 4):
197
from bzrlib.fetch import greedy_fetch
198
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
199
self, self._branch_format, branch_to, branch_to._branch_format)
200
greedy_fetch(to_branch=branch_to, from_branch=self,
201
revision=self.last_revision())
204
store_pairs = ((self.text_store, branch_to.text_store),
205
(self.inventory_store, branch_to.inventory_store),
206
(self.revision_store, branch_to.revision_store))
208
for from_store, to_store in store_pairs:
209
copy_all(from_store, to_store)
210
except UnlistableStore:
211
raise UnlistableBranch(from_store)
213
def __init__(self, transport, init=False,
214
relax_version_check=False):
215
"""Create new branch object at a particular location.
217
transport -- A Transport object, defining how to access files.
218
(If a string, transport.transport() will be used to
219
create a Transport object)
221
init -- If True, create new control files in a previously
222
unversioned directory. If False, the branch must already
225
relax_version_check -- If true, the usual check for the branch
226
version is not applied. This is intended only for
227
upgrade/recovery type use; it's not guaranteed that
228
all operations will work on old format branches.
230
In the test suite, creation of new trees is tested using the
231
`ScratchBranch` class.
233
assert isinstance(transport, Transport), \
234
"%r is not a Transport" % transport
235
self._transport = transport
238
self._check_format(relax_version_check)
240
def get_store(name, compressed=True):
241
# FIXME: This approach of assuming stores are all entirely compressed
242
# or entirely uncompressed is tidy, but breaks upgrade from
243
# some existing branches where there's a mixture; we probably
244
# still want the option to look for both.
245
relpath = self._rel_controlfilename(name)
247
store = CompressedTextStore(self._transport.clone(relpath))
249
store = TextStore(self._transport.clone(relpath))
250
#if self._transport.should_cache():
251
# cache_path = os.path.join(self.cache_root, name)
252
# os.mkdir(cache_path)
253
# store = bzrlib.store.CachedStore(store, cache_path)
256
relpath = self._rel_controlfilename(name)
257
ws = WeaveStore(self._transport.clone(relpath))
258
if self._transport.should_cache():
259
ws.enable_cache = True
262
if self._branch_format == 4:
263
self.inventory_store = get_store('inventory-store')
264
self.text_store = get_store('text-store')
265
self.revision_store = get_store('revision-store')
266
elif self._branch_format == 5:
267
self.control_weaves = get_weave([])
268
self.weave_store = get_weave('weaves')
269
self.revision_store = get_store('revision-store', compressed=False)
272
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
279
if self._lock_mode or self._lock:
280
# XXX: This should show something every time, and be suitable for
281
# headless operation and embedding
282
warn("branch %r was not explicitly unlocked" % self)
285
# TODO: It might be best to do this somewhere else,
286
# but it is nice for a Branch object to automatically
287
# cache it's information.
288
# Alternatively, we could have the Transport objects cache requests
289
# See the earlier discussion about how major objects (like Branch)
290
# should never expect their __del__ function to run.
291
if hasattr(self, 'cache_root') and self.cache_root is not None:
294
shutil.rmtree(self.cache_root)
297
self.cache_root = None
301
return self._transport.base
304
base = property(_get_base)
307
def lock_write(self):
308
# TODO: Upgrade locking to support using a Transport,
309
# and potentially a remote locking protocol
311
if self._lock_mode != 'w':
312
raise LockError("can't upgrade to a write lock from %r" %
314
self._lock_count += 1
316
self._lock = self._transport.lock_write(
317
self._rel_controlfilename('branch-lock'))
318
self._lock_mode = 'w'
324
assert self._lock_mode in ('r', 'w'), \
325
"invalid lock mode %r" % self._lock_mode
326
self._lock_count += 1
328
self._lock = self._transport.lock_read(
329
self._rel_controlfilename('branch-lock'))
330
self._lock_mode = 'r'
334
if not self._lock_mode:
335
raise LockError('branch %r is not locked' % (self))
337
if self._lock_count > 1:
338
self._lock_count -= 1
342
self._lock_mode = self._lock_count = None
344
def abspath(self, name):
345
"""Return absolute filename for something in the branch"""
346
return self._transport.abspath(name)
348
def relpath(self, path):
349
"""Return path relative to this branch of something inside it.
351
Raises an error if path is not in this branch."""
352
return self._transport.relpath(path)
355
def _rel_controlfilename(self, file_or_path):
356
if isinstance(file_or_path, basestring):
357
file_or_path = [file_or_path]
358
return [bzrlib.BZRDIR] + file_or_path
360
def controlfilename(self, file_or_path):
361
"""Return location relative to branch."""
362
return self._transport.abspath(self._rel_controlfilename(file_or_path))
365
def controlfile(self, file_or_path, mode='r'):
366
"""Open a control file for this branch.
368
There are two classes of file in the control directory: text
369
and binary. binary files are untranslated byte streams. Text
370
control files are stored with Unix newlines and in UTF-8, even
371
if the platform or locale defaults are different.
373
Controlfiles should almost never be opened in write mode but
374
rather should be atomically copied and replaced using atomicfile.
378
relpath = self._rel_controlfilename(file_or_path)
379
#TODO: codecs.open() buffers linewise, so it was overloaded with
380
# a much larger buffer, do we need to do the same for getreader/getwriter?
382
return self._transport.get(relpath)
384
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
386
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
388
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
390
raise BzrError("invalid controlfile mode %r" % mode)
392
def put_controlfile(self, path, f, encode=True):
393
"""Write an entry as a controlfile.
395
:param path: The path to put the file, relative to the .bzr control
397
:param f: A file-like or string object whose contents should be copied.
398
:param encode: If true, encode the contents as utf-8
400
self.put_controlfiles([(path, f)], encode=encode)
402
def put_controlfiles(self, files, encode=True):
403
"""Write several entries as controlfiles.
405
:param files: A list of [(path, file)] pairs, where the path is the directory
406
underneath the bzr control directory
407
:param encode: If true, encode the contents as utf-8
411
for path, f in files:
413
if isinstance(f, basestring):
414
f = f.encode('utf-8', 'replace')
416
f = codecs.getwriter('utf-8')(f, errors='replace')
417
path = self._rel_controlfilename(path)
418
ctrl_files.append((path, f))
419
self._transport.put_multi(ctrl_files)
421
def _make_control(self):
422
from bzrlib.inventory import Inventory
423
from bzrlib.weavefile import write_weave_v5
424
from bzrlib.weave import Weave
426
# Create an empty inventory
428
# if we want per-tree root ids then this is the place to set
429
# them; they're not needed for now and so ommitted for
431
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
432
empty_inv = sio.getvalue()
434
bzrlib.weavefile.write_weave_v5(Weave(), sio)
435
empty_weave = sio.getvalue()
437
dirs = [[], 'revision-store', 'weaves']
439
"This is a Bazaar-NG control directory.\n"
440
"Do not change any files in this directory.\n"),
441
('branch-format', BZR_BRANCH_FORMAT_5),
442
('revision-history', ''),
445
('pending-merges', ''),
446
('inventory', empty_inv),
447
('inventory.weave', empty_weave),
448
('ancestry.weave', empty_weave)
450
cfn = self._rel_controlfilename
451
self._transport.mkdir_multi([cfn(d) for d in dirs])
452
self.put_controlfiles(files)
453
mutter('created control directory in ' + self._transport.base)
455
def _check_format(self, relax_version_check):
456
"""Check this branch format is supported.
458
The format level is stored, as an integer, in
459
self._branch_format for code that needs to check it later.
461
In the future, we might need different in-memory Branch
462
classes to support downlevel branches. But not yet.
465
fmt = self.controlfile('branch-format', 'r').read()
467
raise NotBranchError(self.base)
469
if fmt == BZR_BRANCH_FORMAT_5:
470
self._branch_format = 5
471
elif fmt == BZR_BRANCH_FORMAT_4:
472
self._branch_format = 4
474
if (not relax_version_check
475
and self._branch_format != 5):
476
raise BzrError('sorry, branch format %r not supported' % fmt,
477
['use a different bzr version',
478
'or remove the .bzr directory'
479
' and "bzr init" again'])
481
def get_root_id(self):
482
"""Return the id of this branches root"""
483
inv = self.read_working_inventory()
484
return inv.root.file_id
486
def set_root_id(self, file_id):
487
inv = self.read_working_inventory()
488
orig_root_id = inv.root.file_id
489
del inv._byid[inv.root.file_id]
490
inv.root.file_id = file_id
491
inv._byid[inv.root.file_id] = inv.root
494
if entry.parent_id in (None, orig_root_id):
495
entry.parent_id = inv.root.file_id
496
self._write_inventory(inv)
498
def read_working_inventory(self):
499
"""Read the working inventory."""
502
# ElementTree does its own conversion from UTF-8, so open in
504
f = self.controlfile('inventory', 'rb')
505
return bzrlib.xml5.serializer_v5.read_inventory(f)
510
def _write_inventory(self, inv):
511
"""Update the working inventory.
513
That is to say, the inventory describing changes underway, that
514
will be committed to the next revision.
516
from cStringIO import StringIO
520
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
522
# Transport handles atomicity
523
self.put_controlfile('inventory', sio)
527
mutter('wrote working inventory')
529
inventory = property(read_working_inventory, _write_inventory, None,
530
"""Inventory for the working copy.""")
532
def add(self, files, ids=None):
533
"""Make files versioned.
535
Note that the command line normally calls smart_add instead,
536
which can automatically recurse.
538
This puts the files in the Added state, so that they will be
539
recorded by the next commit.
542
List of paths to add, relative to the base of the tree.
545
If set, use these instead of automatically generated ids.
546
Must be the same length as the list of files, but may
547
contain None for ids that are to be autogenerated.
549
TODO: Perhaps have an option to add the ids even if the files do
552
TODO: Perhaps yield the ids and paths as they're added.
554
# TODO: Re-adding a file that is removed in the working copy
555
# should probably put it back with the previous ID.
556
if isinstance(files, basestring):
557
assert(ids is None or isinstance(ids, basestring))
563
ids = [None] * len(files)
565
assert(len(ids) == len(files))
569
inv = self.read_working_inventory()
570
for f,file_id in zip(files, ids):
571
if is_control_file(f):
572
raise BzrError("cannot add control file %s" % quotefn(f))
577
raise BzrError("cannot add top-level %r" % f)
579
fullpath = os.path.normpath(self.abspath(f))
582
kind = file_kind(fullpath)
584
# maybe something better?
585
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
587
if not InventoryEntry.versionable_kind(kind):
588
raise BzrError('cannot add: not a versionable file ('
589
'i.e. regular file, symlink or directory): %s' % quotefn(f))
592
file_id = gen_file_id(f)
593
inv.add_path(f, kind=kind, file_id=file_id)
595
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
597
self._write_inventory(inv)
602
def print_file(self, file, revno):
603
"""Print `file` to stdout."""
606
tree = self.revision_tree(self.get_rev_id(revno))
607
# use inventory as it was in that revision
608
file_id = tree.inventory.path2id(file)
610
raise BzrError("%r is not present in revision %s" % (file, revno))
611
tree.print_file(file_id)
616
def remove(self, files, verbose=False):
617
"""Mark nominated files for removal from the inventory.
619
This does not remove their text. This does not run on
621
TODO: Refuse to remove modified files unless --force is given?
623
TODO: Do something useful with directories.
625
TODO: Should this remove the text or not? Tough call; not
626
removing may be useful and the user can just use use rm, and
627
is the opposite of add. Removing it is consistent with most
628
other tools. Maybe an option.
630
## TODO: Normalize names
631
## TODO: Remove nested loops; better scalability
632
if isinstance(files, basestring):
638
tree = self.working_tree()
641
# do this before any modifications
645
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
646
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
648
# having remove it, it must be either ignored or unknown
649
if tree.is_ignored(f):
653
show_status(new_status, inv[fid].kind, quotefn(f))
656
self._write_inventory(inv)
660
# FIXME: this doesn't need to be a branch method
661
def set_inventory(self, new_inventory_list):
662
from bzrlib.inventory import Inventory, InventoryEntry
663
inv = Inventory(self.get_root_id())
664
for path, file_id, parent, kind in new_inventory_list:
665
name = os.path.basename(path)
668
# fixme, there should be a factory function inv,add_??
669
if kind == 'directory':
670
inv.add(inventory.InventoryDirectory(file_id, name, parent))
672
inv.add(inventory.InventoryFile(file_id, name, parent))
673
elif kind == 'symlink':
674
inv.add(inventory.InventoryLink(file_id, name, parent))
676
raise BzrError("unknown kind %r" % kind)
677
self._write_inventory(inv)
680
"""Return all unknown files.
682
These are files in the working directory that are not versioned or
683
control files or ignored.
685
>>> b = ScratchBranch(files=['foo', 'foo~'])
686
>>> list(b.unknowns())
689
>>> list(b.unknowns())
692
>>> list(b.unknowns())
695
return self.working_tree().unknowns()
698
def append_revision(self, *revision_ids):
699
for revision_id in revision_ids:
700
mutter("add {%s} to revision-history" % revision_id)
703
rev_history = self.revision_history()
704
rev_history.extend(revision_ids)
705
self.put_controlfile('revision-history', '\n'.join(rev_history))
709
def has_revision(self, revision_id):
710
"""True if this branch has a copy of the revision.
712
This does not necessarily imply the revision is merge
713
or on the mainline."""
714
return (revision_id is None
715
or revision_id in self.revision_store)
717
def get_revision_xml_file(self, revision_id):
718
"""Return XML file object for revision object."""
719
if not revision_id or not isinstance(revision_id, basestring):
720
raise InvalidRevisionId(revision_id)
725
return self.revision_store[revision_id]
726
except (IndexError, KeyError):
727
raise bzrlib.errors.NoSuchRevision(self, revision_id)
732
get_revision_xml = get_revision_xml_file
734
def get_revision_xml(self, revision_id):
735
return self.get_revision_xml_file(revision_id).read()
738
def get_revision(self, revision_id):
739
"""Return the Revision object for a named revision"""
740
xml_file = self.get_revision_xml_file(revision_id)
743
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
744
except SyntaxError, e:
745
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
749
assert r.revision_id == revision_id
752
def get_revision_delta(self, revno):
753
"""Return the delta for one revision.
755
The delta is relative to its mainline predecessor, or the
756
empty tree for revision 1.
758
assert isinstance(revno, int)
759
rh = self.revision_history()
760
if not (1 <= revno <= len(rh)):
761
raise InvalidRevisionNumber(revno)
763
# revno is 1-based; list is 0-based
765
new_tree = self.revision_tree(rh[revno-1])
767
old_tree = EmptyTree()
769
old_tree = self.revision_tree(rh[revno-2])
771
return compare_trees(old_tree, new_tree)
773
def get_revision_sha1(self, revision_id):
774
"""Hash the stored value of a revision, and return it."""
775
# In the future, revision entries will be signed. At that
776
# point, it is probably best *not* to include the signature
777
# in the revision hash. Because that lets you re-sign
778
# the revision, (add signatures/remove signatures) and still
779
# have all hash pointers stay consistent.
780
# But for now, just hash the contents.
781
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
783
def _get_ancestry_weave(self):
784
return self.control_weaves.get_weave('ancestry')
786
def get_ancestry(self, revision_id):
787
"""Return a list of revision-ids integrated by a revision."""
788
if revision_id is None:
790
w = self._get_ancestry_weave()
791
return [None] + [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
793
def get_inventory_weave(self):
794
return self.control_weaves.get_weave('inventory')
796
def get_inventory(self, revision_id):
797
"""Get Inventory object by hash."""
798
xml = self.get_inventory_xml(revision_id)
799
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
801
def get_inventory_xml(self, revision_id):
802
"""Get inventory XML as a file object."""
804
assert isinstance(revision_id, basestring), type(revision_id)
805
iw = self.get_inventory_weave()
806
return iw.get_text(iw.lookup(revision_id))
808
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
810
def get_inventory_sha1(self, revision_id):
811
"""Return the sha1 hash of the inventory entry
813
return self.get_revision(revision_id).inventory_sha1
815
def get_revision_inventory(self, revision_id):
816
"""Return inventory of a past revision."""
817
# TODO: Unify this with get_inventory()
818
# bzr 0.0.6 and later imposes the constraint that the inventory_id
819
# must be the same as its revision, so this is trivial.
820
if revision_id == None:
821
return Inventory(self.get_root_id())
823
return self.get_inventory(revision_id)
825
def revision_history(self):
826
"""Return sequence of revision hashes on to this branch."""
829
return [l.rstrip('\r\n') for l in
830
self.controlfile('revision-history', 'r').readlines()]
834
def common_ancestor(self, other, self_revno=None, other_revno=None):
836
>>> from bzrlib.commit import commit
837
>>> sb = ScratchBranch(files=['foo', 'foo~'])
838
>>> sb.common_ancestor(sb) == (None, None)
840
>>> commit(sb, "Committing first revision", verbose=False)
841
>>> sb.common_ancestor(sb)[0]
843
>>> clone = sb.clone()
844
>>> commit(sb, "Committing second revision", verbose=False)
845
>>> sb.common_ancestor(sb)[0]
847
>>> sb.common_ancestor(clone)[0]
849
>>> commit(clone, "Committing divergent second revision",
851
>>> sb.common_ancestor(clone)[0]
853
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
855
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
857
>>> clone2 = sb.clone()
858
>>> sb.common_ancestor(clone2)[0]
860
>>> sb.common_ancestor(clone2, self_revno=1)[0]
862
>>> sb.common_ancestor(clone2, other_revno=1)[0]
865
my_history = self.revision_history()
866
other_history = other.revision_history()
867
if self_revno is None:
868
self_revno = len(my_history)
869
if other_revno is None:
870
other_revno = len(other_history)
871
indices = range(min((self_revno, other_revno)))
874
if my_history[r] == other_history[r]:
875
return r+1, my_history[r]
880
"""Return current revision number for this branch.
882
That is equivalent to the number of revisions committed to
885
return len(self.revision_history())
888
def last_revision(self):
889
"""Return last patch hash, or None if no history.
891
ph = self.revision_history()
898
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
899
"""Return a list of new revisions that would perfectly fit.
901
If self and other have not diverged, return a list of the revisions
902
present in other, but missing from self.
904
>>> from bzrlib.commit import commit
905
>>> bzrlib.trace.silent = True
906
>>> br1 = ScratchBranch()
907
>>> br2 = ScratchBranch()
908
>>> br1.missing_revisions(br2)
910
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
911
>>> br1.missing_revisions(br2)
913
>>> br2.missing_revisions(br1)
915
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
916
>>> br1.missing_revisions(br2)
918
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
919
>>> br1.missing_revisions(br2)
921
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
922
>>> br1.missing_revisions(br2)
923
Traceback (most recent call last):
924
DivergedBranches: These branches have diverged.
926
# FIXME: If the branches have diverged, but the latest
927
# revision in this branch is completely merged into the other,
928
# then we should still be able to pull.
929
self_history = self.revision_history()
930
self_len = len(self_history)
931
other_history = other.revision_history()
932
other_len = len(other_history)
933
common_index = min(self_len, other_len) -1
934
if common_index >= 0 and \
935
self_history[common_index] != other_history[common_index]:
936
raise DivergedBranches(self, other)
938
if stop_revision is None:
939
stop_revision = other_len
941
assert isinstance(stop_revision, int)
942
if stop_revision > other_len:
943
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
944
return other_history[self_len:stop_revision]
946
def update_revisions(self, other, stop_revision=None):
947
"""Pull in new perfect-fit revisions."""
948
from bzrlib.fetch import greedy_fetch
949
from bzrlib.revision import get_intervening_revisions
950
if stop_revision is None:
951
stop_revision = other.last_revision()
952
greedy_fetch(to_branch=self, from_branch=other,
953
revision=stop_revision)
954
pullable_revs = self.missing_revisions(
955
other, other.revision_id_to_revno(stop_revision))
957
greedy_fetch(to_branch=self,
959
revision=pullable_revs[-1])
960
self.append_revision(*pullable_revs)
963
def commit(self, *args, **kw):
964
from bzrlib.commit import Commit
965
Commit().commit(self, *args, **kw)
967
def revision_id_to_revno(self, revision_id):
968
"""Given a revision id, return its revno"""
969
if revision_id is None:
971
history = self.revision_history()
973
return history.index(revision_id) + 1
975
raise bzrlib.errors.NoSuchRevision(self, revision_id)
977
def get_rev_id(self, revno, history=None):
978
"""Find the revision id of the specified revno."""
982
history = self.revision_history()
983
elif revno <= 0 or revno > len(history):
984
raise bzrlib.errors.NoSuchRevision(self, revno)
985
return history[revno - 1]
987
def revision_tree(self, revision_id):
988
"""Return Tree for a revision on this branch.
990
`revision_id` may be None for the null revision, in which case
991
an `EmptyTree` is returned."""
992
# TODO: refactor this to use an existing revision object
993
# so we don't need to read it in twice.
994
if revision_id == None:
997
inv = self.get_revision_inventory(revision_id)
998
return RevisionTree(self.weave_store, inv, revision_id)
1001
def working_tree(self):
1002
"""Return a `Tree` for the working copy."""
1003
from bzrlib.workingtree import WorkingTree
1004
# TODO: In the future, WorkingTree should utilize Transport
1005
# RobertCollins 20051003 - I don't think it should - working trees are
1006
# much more complex to keep consistent than our careful .bzr subset.
1007
# instead, we should say that working trees are local only, and optimise
1009
return WorkingTree(self._transport.base, self.read_working_inventory())
1012
def basis_tree(self):
1013
"""Return `Tree` object for last revision.
1015
If there are no revisions yet, return an `EmptyTree`.
1017
return self.revision_tree(self.last_revision())
1020
def rename_one(self, from_rel, to_rel):
1023
This can change the directory or the filename or both.
1027
tree = self.working_tree()
1028
inv = tree.inventory
1029
if not tree.has_filename(from_rel):
1030
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1031
if tree.has_filename(to_rel):
1032
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1034
file_id = inv.path2id(from_rel)
1036
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1038
if inv.path2id(to_rel):
1039
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1041
to_dir, to_tail = os.path.split(to_rel)
1042
to_dir_id = inv.path2id(to_dir)
1043
if to_dir_id == None and to_dir != '':
1044
raise BzrError("can't determine destination directory id for %r" % to_dir)
1046
mutter("rename_one:")
1047
mutter(" file_id {%s}" % file_id)
1048
mutter(" from_rel %r" % from_rel)
1049
mutter(" to_rel %r" % to_rel)
1050
mutter(" to_dir %r" % to_dir)
1051
mutter(" to_dir_id {%s}" % to_dir_id)
1053
inv.rename(file_id, to_dir_id, to_tail)
1055
from_abs = self.abspath(from_rel)
1056
to_abs = self.abspath(to_rel)
1058
rename(from_abs, to_abs)
1060
raise BzrError("failed to rename %r to %r: %s"
1061
% (from_abs, to_abs, e[1]),
1062
["rename rolled back"])
1064
self._write_inventory(inv)
1069
def move(self, from_paths, to_name):
1072
to_name must exist as a versioned directory.
1074
If to_name exists and is a directory, the files are moved into
1075
it, keeping their old names. If it is a directory,
1077
Note that to_name is only the last component of the new name;
1078
this doesn't change the directory.
1080
This returns a list of (from_path, to_path) pairs for each
1081
entry that is moved.
1086
## TODO: Option to move IDs only
1087
assert not isinstance(from_paths, basestring)
1088
tree = self.working_tree()
1089
inv = tree.inventory
1090
to_abs = self.abspath(to_name)
1091
if not isdir(to_abs):
1092
raise BzrError("destination %r is not a directory" % to_abs)
1093
if not tree.has_filename(to_name):
1094
raise BzrError("destination %r not in working directory" % to_abs)
1095
to_dir_id = inv.path2id(to_name)
1096
if to_dir_id == None and to_name != '':
1097
raise BzrError("destination %r is not a versioned directory" % to_name)
1098
to_dir_ie = inv[to_dir_id]
1099
if to_dir_ie.kind not in ('directory', 'root_directory'):
1100
raise BzrError("destination %r is not a directory" % to_abs)
1102
to_idpath = inv.get_idpath(to_dir_id)
1104
for f in from_paths:
1105
if not tree.has_filename(f):
1106
raise BzrError("%r does not exist in working tree" % f)
1107
f_id = inv.path2id(f)
1109
raise BzrError("%r is not versioned" % f)
1110
name_tail = splitpath(f)[-1]
1111
dest_path = appendpath(to_name, name_tail)
1112
if tree.has_filename(dest_path):
1113
raise BzrError("destination %r already exists" % dest_path)
1114
if f_id in to_idpath:
1115
raise BzrError("can't move %r to a subdirectory of itself" % f)
1117
# OK, so there's a race here, it's possible that someone will
1118
# create a file in this interval and then the rename might be
1119
# left half-done. But we should have caught most problems.
1121
for f in from_paths:
1122
name_tail = splitpath(f)[-1]
1123
dest_path = appendpath(to_name, name_tail)
1124
result.append((f, dest_path))
1125
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1127
rename(self.abspath(f), self.abspath(dest_path))
1129
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1130
["rename rolled back"])
1132
self._write_inventory(inv)
1139
def revert(self, filenames, old_tree=None, backups=True):
1140
"""Restore selected files to the versions from a previous tree.
1143
If true (default) backups are made of files before
1146
from bzrlib.errors import NotVersionedError, BzrError
1147
from bzrlib.atomicfile import AtomicFile
1148
from bzrlib.osutils import backup_file
1150
inv = self.read_working_inventory()
1151
if old_tree is None:
1152
old_tree = self.basis_tree()
1153
old_inv = old_tree.inventory
1156
for fn in filenames:
1157
file_id = inv.path2id(fn)
1159
raise NotVersionedError("not a versioned file", fn)
1160
if not old_inv.has_id(file_id):
1161
raise BzrError("file not present in old tree", fn, file_id)
1162
nids.append((fn, file_id))
1164
# TODO: Rename back if it was previously at a different location
1166
# TODO: If given a directory, restore the entire contents from
1167
# the previous version.
1169
# TODO: Make a backup to a temporary file.
1171
# TODO: If the file previously didn't exist, delete it?
1172
for fn, file_id in nids:
1175
f = AtomicFile(fn, 'wb')
1177
f.write(old_tree.get_file(file_id).read())
1183
def pending_merges(self):
1184
"""Return a list of pending merges.
1186
These are revisions that have been merged into the working
1187
directory but not yet committed.
1189
cfn = self._rel_controlfilename('pending-merges')
1190
if not self._transport.has(cfn):
1193
for l in self.controlfile('pending-merges', 'r').readlines():
1194
p.append(l.rstrip('\n'))
1198
def add_pending_merge(self, *revision_ids):
1199
# TODO: Perhaps should check at this point that the
1200
# history of the revision is actually present?
1201
p = self.pending_merges()
1203
for rev_id in revision_ids:
1209
self.set_pending_merges(p)
1211
def set_pending_merges(self, rev_list):
1214
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1219
def get_parent(self):
1220
"""Return the parent location of the branch.
1222
This is the default location for push/pull/missing. The usual
1223
pattern is that the user can override it by specifying a
1227
_locs = ['parent', 'pull', 'x-pull']
1230
return self.controlfile(l, 'r').read().strip('\n')
1232
if e.errno != errno.ENOENT:
1237
def set_parent(self, url):
1238
# TODO: Maybe delete old location files?
1239
from bzrlib.atomicfile import AtomicFile
1242
f = AtomicFile(self.controlfilename('parent'))
1251
def check_revno(self, revno):
1253
Check whether a revno corresponds to any revision.
1254
Zero (the NULL revision) is considered valid.
1257
self.check_real_revno(revno)
1259
def check_real_revno(self, revno):
1261
Check whether a revno corresponds to a real revision.
1262
Zero (the NULL revision) is considered invalid
1264
if revno < 1 or revno > self.revno():
1265
raise InvalidRevisionNumber(revno)
1271
class ScratchBranch(_Branch):
1272
"""Special test class: a branch that cleans up after itself.
1274
>>> b = ScratchBranch()
1282
def __init__(self, files=[], dirs=[], base=None):
1283
"""Make a test branch.
1285
This creates a temporary directory and runs init-tree in it.
1287
If any files are listed, they are created in the working copy.
1289
from tempfile import mkdtemp
1294
if isinstance(base, basestring):
1295
base = get_transport(base)
1296
_Branch.__init__(self, base, init=init)
1298
self._transport.mkdir(d)
1301
self._transport.put(f, 'content of %s' % f)
1306
>>> orig = ScratchBranch(files=["file1", "file2"])
1307
>>> clone = orig.clone()
1308
>>> if os.name != 'nt':
1309
... os.path.samefile(orig.base, clone.base)
1311
... orig.base == clone.base
1314
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1317
from shutil import copytree
1318
from tempfile import mkdtemp
1321
copytree(self.base, base, symlinks=True)
1322
return ScratchBranch(base=base)
1328
"""Destroy the test branch, removing the scratch directory."""
1329
from shutil import rmtree
1332
mutter("delete ScratchBranch %s" % self.base)
1335
# Work around for shutil.rmtree failing on Windows when
1336
# readonly files are encountered
1337
mutter("hit exception in destroying ScratchBranch: %s" % e)
1338
for root, dirs, files in os.walk(self.base, topdown=False):
1340
os.chmod(os.path.join(root, name), 0700)
1342
self._transport = None
1346
######################################################################
1350
def is_control_file(filename):
1351
## FIXME: better check
1352
filename = os.path.normpath(filename)
1353
while filename != '':
1354
head, tail = os.path.split(filename)
1355
## mutter('check %r for control file' % ((head, tail), ))
1356
if tail == bzrlib.BZRDIR:
1358
if filename == head:
1365
def gen_file_id(name):
1366
"""Return new file id.
1368
This should probably generate proper UUIDs, but for the moment we
1369
cope with just randomness because running uuidgen every time is
1372
from binascii import hexlify
1373
from time import time
1375
# get last component
1376
idx = name.rfind('/')
1378
name = name[idx+1 : ]
1379
idx = name.rfind('\\')
1381
name = name[idx+1 : ]
1383
# make it not a hidden file
1384
name = name.lstrip('.')
1386
# remove any wierd characters; we don't escape them but rather
1387
# just pull them out
1388
name = re.sub(r'[^\w.]', '', name)
1390
s = hexlify(rand_bytes(8))
1391
return '-'.join((name, compact_date(time()), s))
1395
"""Return a new tree-root file id."""
1396
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
