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.trace import mutter, note
27
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
28
rename, splitpath, sha_file, appendpath,
30
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
31
NoSuchRevision, HistoryMissing, NotBranchError,
32
DivergedBranches, LockError, UnlistableStore,
33
UnlistableBranch, NoSuchFile)
34
from bzrlib.textui import show_status
35
from bzrlib.revision import Revision, validate_revision_id, is_ancestor
36
from bzrlib.delta import compare_trees
37
from bzrlib.tree import EmptyTree, RevisionTree
38
from bzrlib.inventory import Inventory
39
from bzrlib.store import copy_all
40
from bzrlib.store.compressed_text import CompressedTextStore
41
from bzrlib.store.text import TextStore
42
from bzrlib.store.weave import WeaveStore
43
from bzrlib.transport import Transport, get_transport
48
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
49
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
50
## TODO: Maybe include checks for common corruption of newlines, etc?
53
# TODO: Some operations like log might retrieve the same revisions
54
# repeatedly to calculate deltas. We could perhaps have a weakref
55
# cache in memory to make this faster. In general anything can be
56
# cached in memory between lock and unlock operations.
58
def find_branch(*ignored, **ignored_too):
59
# XXX: leave this here for about one release, then remove it
60
raise NotImplementedError('find_branch() is not supported anymore, '
61
'please use one of the new branch constructors')
62
def _relpath(base, path):
63
"""Return path relative to base, or raise exception.
65
The path may be either an absolute path or a path relative to the
66
current working directory.
68
Lifted out of Branch.relpath for ease of testing.
70
os.path.commonprefix (python2.4) has a bad bug that it works just
71
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
72
avoids that problem."""
73
rp = os.path.abspath(path)
77
while len(head) >= len(base):
80
head, tail = os.path.split(head)
84
raise NotBranchError("path %r is not within branch %r" % (rp, base))
89
def find_branch_root(t):
90
"""Find the branch root enclosing the transport's base.
92
t is a Transport object.
94
It is not necessary that the base of t exists.
96
Basically we keep looking up until we find the control directory or
97
run into the root. If there isn't one, raises NotBranchError.
101
if t.has(bzrlib.BZRDIR):
103
new_t = t.clone('..')
104
if new_t.base == t.base:
105
# reached the root, whatever that may be
106
raise NotBranchError('%s is not in a branch' % orig_base)
110
######################################################################
113
class Branch(object):
114
"""Branch holding a history of revisions.
117
Base directory/url of the branch.
121
def __init__(self, *ignored, **ignored_too):
122
raise NotImplementedError('The Branch class is abstract')
125
def open_downlevel(base):
126
"""Open a branch which may be of an old format.
128
Only local branches are supported."""
129
return _Branch(get_transport(base), relax_version_check=True)
133
"""Open an existing branch, rooted at 'base' (url)"""
134
t = get_transport(base)
138
def open_containing(url):
139
"""Open an existing branch which contains url.
141
This probes for a branch at url, and searches upwards from there.
143
t = get_transport(url)
144
t = find_branch_root(t)
148
def initialize(base):
149
"""Create a new branch, rooted at 'base' (url)"""
150
t = get_transport(base)
151
return _Branch(t, init=True)
153
def setup_caching(self, cache_root):
154
"""Subclasses that care about caching should override this, and set
155
up cached stores located under cache_root.
159
class _Branch(Branch):
160
"""A branch stored in the actual filesystem.
162
Note that it's "local" in the context of the filesystem; it doesn't
163
really matter if it's on an nfs/smb/afs/coda/... share, as long as
164
it's writable, and can be accessed via the normal filesystem API.
170
If _lock_mode is true, a positive count of the number of times the
174
Lock object from bzrlib.lock.
176
# We actually expect this class to be somewhat short-lived; part of its
177
# purpose is to try to isolate what bits of the branch logic are tied to
178
# filesystem access, so that in a later step, we can extricate them to
179
# a separarte ("storage") class.
183
_inventory_weave = None
185
# Map some sort of prefix into a namespace
186
# stuff like "revno:10", "revid:", etc.
187
# This should match a prefix with a function which accepts
188
REVISION_NAMESPACES = {}
190
def push_stores(self, branch_to):
191
"""Copy the content of this branches store to branch_to."""
192
if (self._branch_format != branch_to._branch_format
193
or self._branch_format != 4):
194
from bzrlib.fetch import greedy_fetch
195
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
196
self, self._branch_format, branch_to, branch_to._branch_format)
197
greedy_fetch(to_branch=branch_to, from_branch=self,
198
revision=self.last_revision())
201
store_pairs = ((self.text_store, branch_to.text_store),
202
(self.inventory_store, branch_to.inventory_store),
203
(self.revision_store, branch_to.revision_store))
205
for from_store, to_store in store_pairs:
206
copy_all(from_store, to_store)
207
except UnlistableStore:
208
raise UnlistableBranch(from_store)
210
def __init__(self, transport, init=False,
211
relax_version_check=False):
212
"""Create new branch object at a particular location.
214
transport -- A Transport object, defining how to access files.
215
(If a string, transport.transport() will be used to
216
create a Transport object)
218
init -- If True, create new control files in a previously
219
unversioned directory. If False, the branch must already
222
relax_version_check -- If true, the usual check for the branch
223
version is not applied. This is intended only for
224
upgrade/recovery type use; it's not guaranteed that
225
all operations will work on old format branches.
227
In the test suite, creation of new trees is tested using the
228
`ScratchBranch` class.
230
assert isinstance(transport, Transport), \
231
"%r is not a Transport" % transport
232
self._transport = transport
235
self._check_format(relax_version_check)
237
def get_store(name, compressed=True):
238
relpath = self._rel_controlfilename(name)
240
store = CompressedTextStore(self._transport.clone(relpath))
242
store = TextStore(self._transport.clone(relpath))
243
if self._transport.should_cache():
244
from meta_store import CachedStore
245
cache_path = os.path.join(self.cache_root, name)
247
store = CachedStore(store, cache_path)
250
relpath = self._rel_controlfilename(name)
251
ws = WeaveStore(self._transport.clone(relpath))
252
if self._transport.should_cache():
253
ws.enable_cache = True
256
if self._branch_format == 4:
257
self.inventory_store = get_store('inventory-store')
258
self.text_store = get_store('text-store')
259
self.revision_store = get_store('revision-store')
260
elif self._branch_format == 5:
261
self.control_weaves = get_weave([])
262
self.weave_store = get_weave('weaves')
263
self.revision_store = get_store('revision-store', compressed=False)
266
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
273
if self._lock_mode or self._lock:
274
# XXX: This should show something every time, and be suitable for
275
# headless operation and embedding
276
warn("branch %r was not explicitly unlocked" % self)
279
# TODO: It might be best to do this somewhere else,
280
# but it is nice for a Branch object to automatically
281
# cache it's information.
282
# Alternatively, we could have the Transport objects cache requests
283
# See the earlier discussion about how major objects (like Branch)
284
# should never expect their __del__ function to run.
285
if hasattr(self, 'cache_root') and self.cache_root is not None:
288
shutil.rmtree(self.cache_root)
291
self.cache_root = None
295
return self._transport.base
298
base = property(_get_base)
301
def lock_write(self):
302
# TODO: Upgrade locking to support using a Transport,
303
# and potentially a remote locking protocol
305
if self._lock_mode != 'w':
306
raise LockError("can't upgrade to a write lock from %r" %
308
self._lock_count += 1
310
self._lock = self._transport.lock_write(
311
self._rel_controlfilename('branch-lock'))
312
self._lock_mode = 'w'
318
assert self._lock_mode in ('r', 'w'), \
319
"invalid lock mode %r" % self._lock_mode
320
self._lock_count += 1
322
self._lock = self._transport.lock_read(
323
self._rel_controlfilename('branch-lock'))
324
self._lock_mode = 'r'
328
if not self._lock_mode:
329
raise LockError('branch %r is not locked' % (self))
331
if self._lock_count > 1:
332
self._lock_count -= 1
336
self._lock_mode = self._lock_count = None
338
def abspath(self, name):
339
"""Return absolute filename for something in the branch"""
340
return self._transport.abspath(name)
342
def relpath(self, path):
343
"""Return path relative to this branch of something inside it.
345
Raises an error if path is not in this branch."""
346
return self._transport.relpath(path)
349
def _rel_controlfilename(self, file_or_path):
350
if isinstance(file_or_path, basestring):
351
file_or_path = [file_or_path]
352
return [bzrlib.BZRDIR] + file_or_path
354
def controlfilename(self, file_or_path):
355
"""Return location relative to branch."""
356
return self._transport.abspath(self._rel_controlfilename(file_or_path))
359
def controlfile(self, file_or_path, mode='r'):
360
"""Open a control file for this branch.
362
There are two classes of file in the control directory: text
363
and binary. binary files are untranslated byte streams. Text
364
control files are stored with Unix newlines and in UTF-8, even
365
if the platform or locale defaults are different.
367
Controlfiles should almost never be opened in write mode but
368
rather should be atomically copied and replaced using atomicfile.
372
relpath = self._rel_controlfilename(file_or_path)
373
#TODO: codecs.open() buffers linewise, so it was overloaded with
374
# a much larger buffer, do we need to do the same for getreader/getwriter?
376
return self._transport.get(relpath)
378
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
380
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
382
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
384
raise BzrError("invalid controlfile mode %r" % mode)
386
def put_controlfile(self, path, f, encode=True):
387
"""Write an entry as a controlfile.
389
:param path: The path to put the file, relative to the .bzr control
391
:param f: A file-like or string object whose contents should be copied.
392
:param encode: If true, encode the contents as utf-8
394
self.put_controlfiles([(path, f)], encode=encode)
396
def put_controlfiles(self, files, encode=True):
397
"""Write several entries as controlfiles.
399
:param files: A list of [(path, file)] pairs, where the path is the directory
400
underneath the bzr control directory
401
:param encode: If true, encode the contents as utf-8
405
for path, f in files:
407
if isinstance(f, basestring):
408
f = f.encode('utf-8', 'replace')
410
f = codecs.getwriter('utf-8')(f, errors='replace')
411
path = self._rel_controlfilename(path)
412
ctrl_files.append((path, f))
413
self._transport.put_multi(ctrl_files)
415
def _make_control(self):
416
from bzrlib.inventory import Inventory
417
from bzrlib.weavefile import write_weave_v5
418
from bzrlib.weave import Weave
420
# Create an empty inventory
422
# if we want per-tree root ids then this is the place to set
423
# them; they're not needed for now and so ommitted for
425
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
426
empty_inv = sio.getvalue()
428
bzrlib.weavefile.write_weave_v5(Weave(), sio)
429
empty_weave = sio.getvalue()
431
dirs = [[], 'revision-store', 'weaves']
433
"This is a Bazaar-NG control directory.\n"
434
"Do not change any files in this directory.\n"),
435
('branch-format', BZR_BRANCH_FORMAT_5),
436
('revision-history', ''),
439
('pending-merges', ''),
440
('inventory', empty_inv),
441
('inventory.weave', empty_weave),
442
('ancestry.weave', empty_weave)
444
cfn = self._rel_controlfilename
445
self._transport.mkdir_multi([cfn(d) for d in dirs])
446
self.put_controlfiles(files)
447
mutter('created control directory in ' + self._transport.base)
449
def _check_format(self, relax_version_check):
450
"""Check this branch format is supported.
452
The format level is stored, as an integer, in
453
self._branch_format for code that needs to check it later.
455
In the future, we might need different in-memory Branch
456
classes to support downlevel branches. But not yet.
459
fmt = self.controlfile('branch-format', 'r').read()
461
raise NotBranchError(self.base)
463
if fmt == BZR_BRANCH_FORMAT_5:
464
self._branch_format = 5
465
elif fmt == BZR_BRANCH_FORMAT_4:
466
self._branch_format = 4
468
if (not relax_version_check
469
and self._branch_format != 5):
470
raise BzrError('sorry, branch format %r not supported' % fmt,
471
['use a different bzr version',
472
'or remove the .bzr directory'
473
' and "bzr init" again'])
475
def get_root_id(self):
476
"""Return the id of this branches root"""
477
inv = self.read_working_inventory()
478
return inv.root.file_id
480
def set_root_id(self, file_id):
481
inv = self.read_working_inventory()
482
orig_root_id = inv.root.file_id
483
del inv._byid[inv.root.file_id]
484
inv.root.file_id = file_id
485
inv._byid[inv.root.file_id] = inv.root
488
if entry.parent_id in (None, orig_root_id):
489
entry.parent_id = inv.root.file_id
490
self._write_inventory(inv)
492
def read_working_inventory(self):
493
"""Read the working inventory."""
496
# ElementTree does its own conversion from UTF-8, so open in
498
f = self.controlfile('inventory', 'rb')
499
return bzrlib.xml5.serializer_v5.read_inventory(f)
504
def _write_inventory(self, inv):
505
"""Update the working inventory.
507
That is to say, the inventory describing changes underway, that
508
will be committed to the next revision.
510
from cStringIO import StringIO
514
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
516
# Transport handles atomicity
517
self.put_controlfile('inventory', sio)
521
mutter('wrote working inventory')
524
inventory = property(read_working_inventory, _write_inventory, None,
525
"""Inventory for the working copy.""")
528
def add(self, files, ids=None):
529
"""Make files versioned.
531
Note that the command line normally calls smart_add instead,
532
which can automatically recurse.
534
This puts the files in the Added state, so that they will be
535
recorded by the next commit.
538
List of paths to add, relative to the base of the tree.
541
If set, use these instead of automatically generated ids.
542
Must be the same length as the list of files, but may
543
contain None for ids that are to be autogenerated.
545
TODO: Perhaps have an option to add the ids even if the files do
548
TODO: Perhaps yield the ids and paths as they're added.
550
# TODO: Re-adding a file that is removed in the working copy
551
# should probably put it back with the previous ID.
552
if isinstance(files, basestring):
553
assert(ids is None or isinstance(ids, basestring))
559
ids = [None] * len(files)
561
assert(len(ids) == len(files))
565
inv = self.read_working_inventory()
566
for f,file_id in zip(files, ids):
567
if is_control_file(f):
568
raise BzrError("cannot add control file %s" % quotefn(f))
573
raise BzrError("cannot add top-level %r" % f)
575
fullpath = os.path.normpath(self.abspath(f))
578
kind = file_kind(fullpath)
580
# maybe something better?
581
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
583
if kind != 'file' and kind != 'directory':
584
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
587
file_id = gen_file_id(f)
588
inv.add_path(f, kind=kind, file_id=file_id)
590
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
592
self._write_inventory(inv)
597
def print_file(self, file, revno):
598
"""Print `file` to stdout."""
601
tree = self.revision_tree(self.get_rev_id(revno))
602
# use inventory as it was in that revision
603
file_id = tree.inventory.path2id(file)
605
raise BzrError("%r is not present in revision %s" % (file, revno))
606
tree.print_file(file_id)
611
def remove(self, files, verbose=False):
612
"""Mark nominated files for removal from the inventory.
614
This does not remove their text. This does not run on
616
TODO: Refuse to remove modified files unless --force is given?
618
TODO: Do something useful with directories.
620
TODO: Should this remove the text or not? Tough call; not
621
removing may be useful and the user can just use use rm, and
622
is the opposite of add. Removing it is consistent with most
623
other tools. Maybe an option.
625
## TODO: Normalize names
626
## TODO: Remove nested loops; better scalability
627
if isinstance(files, basestring):
633
tree = self.working_tree()
636
# do this before any modifications
640
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
641
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
643
# having remove it, it must be either ignored or unknown
644
if tree.is_ignored(f):
648
show_status(new_status, inv[fid].kind, quotefn(f))
651
self._write_inventory(inv)
656
# FIXME: this doesn't need to be a branch method
657
def set_inventory(self, new_inventory_list):
658
from bzrlib.inventory import Inventory, InventoryEntry
659
inv = Inventory(self.get_root_id())
660
for path, file_id, parent, kind in new_inventory_list:
661
name = os.path.basename(path)
664
inv.add(InventoryEntry(file_id, name, kind, parent))
665
self._write_inventory(inv)
669
"""Return all unknown files.
671
These are files in the working directory that are not versioned or
672
control files or ignored.
674
>>> b = ScratchBranch(files=['foo', 'foo~'])
675
>>> list(b.unknowns())
678
>>> list(b.unknowns())
681
>>> list(b.unknowns())
684
return self.working_tree().unknowns()
687
def append_revision(self, *revision_ids):
688
for revision_id in revision_ids:
689
mutter("add {%s} to revision-history" % revision_id)
692
rev_history = self.revision_history()
693
rev_history.extend(revision_ids)
694
self.put_controlfile('revision-history', '\n'.join(rev_history))
699
def has_revision(self, revision_id):
700
"""True if this branch has a copy of the revision.
702
This does not necessarily imply the revision is merge
703
or on the mainline."""
704
return (revision_id is None
705
or revision_id in self.revision_store)
708
def get_revision_xml_file(self, revision_id):
709
"""Return XML file object for revision object."""
710
if not revision_id or not isinstance(revision_id, basestring):
711
raise InvalidRevisionId(revision_id)
716
return self.revision_store[revision_id]
717
except (IndexError, KeyError):
718
raise bzrlib.errors.NoSuchRevision(self, revision_id)
723
def get_revision_xml(self, revision_id):
724
return self.get_revision_xml_file(revision_id).read()
727
def get_revision(self, revision_id):
728
"""Return the Revision object for a named revision"""
729
xml_file = self.get_revision_xml_file(revision_id)
732
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
733
except SyntaxError, e:
734
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
738
assert r.revision_id == revision_id
742
def get_revision_delta(self, revno):
743
"""Return the delta for one revision.
745
The delta is relative to its mainline predecessor, or the
746
empty tree for revision 1.
748
assert isinstance(revno, int)
749
rh = self.revision_history()
750
if not (1 <= revno <= len(rh)):
751
raise InvalidRevisionNumber(revno)
753
# revno is 1-based; list is 0-based
755
new_tree = self.revision_tree(rh[revno-1])
757
old_tree = EmptyTree()
759
old_tree = self.revision_tree(rh[revno-2])
761
return compare_trees(old_tree, new_tree)
763
def get_revision_sha1(self, revision_id):
764
"""Hash the stored value of a revision, and return it."""
765
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
768
def _get_ancestry_weave(self):
769
return self.control_weaves.get_weave('ancestry')
772
def get_ancestry(self, revision_id):
773
"""Return a list of revision-ids integrated by a revision.
776
if revision_id is None:
778
w = self._get_ancestry_weave()
779
return [None] + [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
782
def get_inventory_weave(self):
783
return self.control_weaves.get_weave('inventory')
786
def get_inventory(self, revision_id):
787
"""Get Inventory object by hash."""
788
xml = self.get_inventory_xml(revision_id)
789
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
792
def get_inventory_xml(self, revision_id):
793
"""Get inventory XML as a file object."""
795
assert isinstance(revision_id, basestring), type(revision_id)
796
iw = self.get_inventory_weave()
797
return iw.get_text(iw.lookup(revision_id))
799
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
802
def get_inventory_sha1(self, revision_id):
803
"""Return the sha1 hash of the inventory entry
805
return self.get_revision(revision_id).inventory_sha1
808
def get_revision_inventory(self, revision_id):
809
"""Return inventory of a past revision."""
810
# TODO: Unify this with get_inventory()
811
# bzr 0.0.6 and later imposes the constraint that the inventory_id
812
# must be the same as its revision, so this is trivial.
813
if revision_id == None:
814
return Inventory(self.get_root_id())
816
return self.get_inventory(revision_id)
819
def revision_history(self):
820
"""Return sequence of revision hashes on to this branch."""
823
return [l.rstrip('\r\n') for l in
824
self.controlfile('revision-history', 'r').readlines()]
829
def common_ancestor(self, other, self_revno=None, other_revno=None):
831
>>> from bzrlib.commit import commit
832
>>> sb = ScratchBranch(files=['foo', 'foo~'])
833
>>> sb.common_ancestor(sb) == (None, None)
835
>>> commit(sb, "Committing first revision", verbose=False)
836
>>> sb.common_ancestor(sb)[0]
838
>>> clone = sb.clone()
839
>>> commit(sb, "Committing second revision", verbose=False)
840
>>> sb.common_ancestor(sb)[0]
842
>>> sb.common_ancestor(clone)[0]
844
>>> commit(clone, "Committing divergent second revision",
846
>>> sb.common_ancestor(clone)[0]
848
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
850
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
852
>>> clone2 = sb.clone()
853
>>> sb.common_ancestor(clone2)[0]
855
>>> sb.common_ancestor(clone2, self_revno=1)[0]
857
>>> sb.common_ancestor(clone2, other_revno=1)[0]
860
my_history = self.revision_history()
861
other_history = other.revision_history()
862
if self_revno is None:
863
self_revno = len(my_history)
864
if other_revno is None:
865
other_revno = len(other_history)
866
indices = range(min((self_revno, other_revno)))
869
if my_history[r] == other_history[r]:
870
return r+1, my_history[r]
875
"""Return current revision number for this branch.
877
That is equivalent to the number of revisions committed to
880
return len(self.revision_history())
883
def last_revision(self):
884
"""Return last patch hash, or None if no history.
886
ph = self.revision_history()
893
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
894
"""Return a list of new revisions that would perfectly fit.
896
If self and other have not diverged, return a list of the revisions
897
present in other, but missing from self.
899
>>> from bzrlib.commit import commit
900
>>> bzrlib.trace.silent = True
901
>>> br1 = ScratchBranch()
902
>>> br2 = ScratchBranch()
903
>>> br1.missing_revisions(br2)
905
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
906
>>> br1.missing_revisions(br2)
908
>>> br2.missing_revisions(br1)
910
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
911
>>> br1.missing_revisions(br2)
913
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
914
>>> br1.missing_revisions(br2)
916
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
917
>>> br1.missing_revisions(br2)
918
Traceback (most recent call last):
919
DivergedBranches: These branches have diverged.
921
# FIXME: If the branches have diverged, but the latest
922
# revision in this branch is completely merged into the other,
923
# then we should still be able to pull.
924
self_history = self.revision_history()
925
self_len = len(self_history)
926
other_history = other.revision_history()
927
other_len = len(other_history)
928
common_index = min(self_len, other_len) -1
929
if common_index >= 0 and \
930
self_history[common_index] != other_history[common_index]:
931
raise DivergedBranches(self, other)
933
if stop_revision is None:
934
stop_revision = other_len
936
assert isinstance(stop_revision, int)
937
if stop_revision > other_len:
938
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
939
return other_history[self_len:stop_revision]
941
def update_revisions(self, other, stop_revision=None):
942
"""Pull in new perfect-fit revisions."""
943
from bzrlib.fetch import greedy_fetch
944
from bzrlib.revision import get_intervening_revisions
945
if stop_revision is None:
946
stop_revision = other.last_revision()
947
greedy_fetch(to_branch=self, from_branch=other,
948
revision=stop_revision)
949
pullable_revs = self.missing_revisions(
950
other, other.revision_id_to_revno(stop_revision))
952
greedy_fetch(to_branch=self,
954
revision=pullable_revs[-1])
955
self.append_revision(*pullable_revs)
958
def commit(self, *args, **kw):
959
from bzrlib.commit import Commit
960
Commit().commit(self, *args, **kw)
962
def revision_id_to_revno(self, revision_id):
963
"""Given a revision id, return its revno"""
964
if revision_id is None:
966
history = self.revision_history()
968
return history.index(revision_id) + 1
970
raise bzrlib.errors.NoSuchRevision(self, revision_id)
972
def get_rev_id(self, revno, history=None):
973
"""Find the revision id of the specified revno."""
977
history = self.revision_history()
978
elif revno <= 0 or revno > len(history):
979
raise bzrlib.errors.NoSuchRevision(self, revno)
980
return history[revno - 1]
982
def revision_tree(self, revision_id):
983
"""Return Tree for a revision on this branch.
985
`revision_id` may be None for the null revision, in which case
986
an `EmptyTree` is returned."""
987
# TODO: refactor this to use an existing revision object
988
# so we don't need to read it in twice.
989
if revision_id == None:
992
inv = self.get_revision_inventory(revision_id)
993
return RevisionTree(self.weave_store, inv, revision_id)
996
def working_tree(self):
997
"""Return a `Tree` for the working copy."""
998
from bzrlib.workingtree import WorkingTree
999
# TODO: In the future, WorkingTree should utilize Transport
1000
return WorkingTree(self._transport.base, self.read_working_inventory())
1003
def basis_tree(self):
1004
"""Return `Tree` object for last revision.
1006
If there are no revisions yet, return an `EmptyTree`.
1008
return self.revision_tree(self.last_revision())
1011
def rename_one(self, from_rel, to_rel):
1014
This can change the directory or the filename or both.
1018
tree = self.working_tree()
1019
inv = tree.inventory
1020
if not tree.has_filename(from_rel):
1021
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1022
if tree.has_filename(to_rel):
1023
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1025
file_id = inv.path2id(from_rel)
1027
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1029
if inv.path2id(to_rel):
1030
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1032
to_dir, to_tail = os.path.split(to_rel)
1033
to_dir_id = inv.path2id(to_dir)
1034
if to_dir_id == None and to_dir != '':
1035
raise BzrError("can't determine destination directory id for %r" % to_dir)
1037
mutter("rename_one:")
1038
mutter(" file_id {%s}" % file_id)
1039
mutter(" from_rel %r" % from_rel)
1040
mutter(" to_rel %r" % to_rel)
1041
mutter(" to_dir %r" % to_dir)
1042
mutter(" to_dir_id {%s}" % to_dir_id)
1044
inv.rename(file_id, to_dir_id, to_tail)
1046
from_abs = self.abspath(from_rel)
1047
to_abs = self.abspath(to_rel)
1049
rename(from_abs, to_abs)
1051
raise BzrError("failed to rename %r to %r: %s"
1052
% (from_abs, to_abs, e[1]),
1053
["rename rolled back"])
1055
self._write_inventory(inv)
1060
def move(self, from_paths, to_name):
1063
to_name must exist as a versioned directory.
1065
If to_name exists and is a directory, the files are moved into
1066
it, keeping their old names. If it is a directory,
1068
Note that to_name is only the last component of the new name;
1069
this doesn't change the directory.
1071
This returns a list of (from_path, to_path) pairs for each
1072
entry that is moved.
1077
## TODO: Option to move IDs only
1078
assert not isinstance(from_paths, basestring)
1079
tree = self.working_tree()
1080
inv = tree.inventory
1081
to_abs = self.abspath(to_name)
1082
if not isdir(to_abs):
1083
raise BzrError("destination %r is not a directory" % to_abs)
1084
if not tree.has_filename(to_name):
1085
raise BzrError("destination %r not in working directory" % to_abs)
1086
to_dir_id = inv.path2id(to_name)
1087
if to_dir_id == None and to_name != '':
1088
raise BzrError("destination %r is not a versioned directory" % to_name)
1089
to_dir_ie = inv[to_dir_id]
1090
if to_dir_ie.kind not in ('directory', 'root_directory'):
1091
raise BzrError("destination %r is not a directory" % to_abs)
1093
to_idpath = inv.get_idpath(to_dir_id)
1095
for f in from_paths:
1096
if not tree.has_filename(f):
1097
raise BzrError("%r does not exist in working tree" % f)
1098
f_id = inv.path2id(f)
1100
raise BzrError("%r is not versioned" % f)
1101
name_tail = splitpath(f)[-1]
1102
dest_path = appendpath(to_name, name_tail)
1103
if tree.has_filename(dest_path):
1104
raise BzrError("destination %r already exists" % dest_path)
1105
if f_id in to_idpath:
1106
raise BzrError("can't move %r to a subdirectory of itself" % f)
1108
# OK, so there's a race here, it's possible that someone will
1109
# create a file in this interval and then the rename might be
1110
# left half-done. But we should have caught most problems.
1112
for f in from_paths:
1113
name_tail = splitpath(f)[-1]
1114
dest_path = appendpath(to_name, name_tail)
1115
result.append((f, dest_path))
1116
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1118
rename(self.abspath(f), self.abspath(dest_path))
1120
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1121
["rename rolled back"])
1123
self._write_inventory(inv)
1130
def revert(self, filenames, old_tree=None, backups=True):
1131
"""Restore selected files to the versions from a previous tree.
1134
If true (default) backups are made of files before
1137
from bzrlib.errors import NotVersionedError, BzrError
1138
from bzrlib.atomicfile import AtomicFile
1139
from bzrlib.osutils import backup_file
1141
inv = self.read_working_inventory()
1142
if old_tree is None:
1143
old_tree = self.basis_tree()
1144
old_inv = old_tree.inventory
1147
for fn in filenames:
1148
file_id = inv.path2id(fn)
1150
raise NotVersionedError("not a versioned file", fn)
1151
if not old_inv.has_id(file_id):
1152
raise BzrError("file not present in old tree", fn, file_id)
1153
nids.append((fn, file_id))
1155
# TODO: Rename back if it was previously at a different location
1157
# TODO: If given a directory, restore the entire contents from
1158
# the previous version.
1160
# TODO: Make a backup to a temporary file.
1162
# TODO: If the file previously didn't exist, delete it?
1163
for fn, file_id in nids:
1166
f = AtomicFile(fn, 'wb')
1168
f.write(old_tree.get_file(file_id).read())
1174
def pending_merges(self):
1175
"""Return a list of pending merges.
1177
These are revisions that have been merged into the working
1178
directory but not yet committed.
1180
cfn = self._rel_controlfilename('pending-merges')
1181
if not self._transport.has(cfn):
1184
for l in self.controlfile('pending-merges', 'r').readlines():
1185
p.append(l.rstrip('\n'))
1189
def add_pending_merge(self, *revision_ids):
1190
# TODO: Perhaps should check at this point that the
1191
# history of the revision is actually present?
1192
for rev_id in revision_ids:
1193
validate_revision_id(rev_id)
1195
p = self.pending_merges()
1197
for rev_id in revision_ids:
1203
self.set_pending_merges(p)
1205
def set_pending_merges(self, rev_list):
1208
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1213
def get_parent(self):
1214
"""Return the parent location of the branch.
1216
This is the default location for push/pull/missing. The usual
1217
pattern is that the user can override it by specifying a
1221
_locs = ['parent', 'pull', 'x-pull']
1224
return self.controlfile(l, 'r').read().strip('\n')
1226
if e.errno != errno.ENOENT:
1231
def set_parent(self, url):
1232
# TODO: Maybe delete old location files?
1233
from bzrlib.atomicfile import AtomicFile
1236
f = AtomicFile(self.controlfilename('parent'))
1245
def check_revno(self, revno):
1247
Check whether a revno corresponds to any revision.
1248
Zero (the NULL revision) is considered valid.
1251
self.check_real_revno(revno)
1253
def check_real_revno(self, revno):
1255
Check whether a revno corresponds to a real revision.
1256
Zero (the NULL revision) is considered invalid
1258
if revno < 1 or revno > self.revno():
1259
raise InvalidRevisionNumber(revno)
1265
class ScratchBranch(_Branch):
1266
"""Special test class: a branch that cleans up after itself.
1268
>>> b = ScratchBranch()
1276
def __init__(self, files=[], dirs=[], base=None):
1277
"""Make a test branch.
1279
This creates a temporary directory and runs init-tree in it.
1281
If any files are listed, they are created in the working copy.
1283
from tempfile import mkdtemp
1288
if isinstance(base, basestring):
1289
base = get_transport(base)
1290
_Branch.__init__(self, base, init=init)
1292
self._transport.mkdir(d)
1295
self._transport.put(f, 'content of %s' % f)
1300
>>> orig = ScratchBranch(files=["file1", "file2"])
1301
>>> clone = orig.clone()
1302
>>> if os.name != 'nt':
1303
... os.path.samefile(orig.base, clone.base)
1305
... orig.base == clone.base
1308
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1311
from shutil import copytree
1312
from tempfile import mkdtemp
1315
copytree(self.base, base, symlinks=True)
1316
return ScratchBranch(base=base)
1324
"""Destroy the test branch, removing the scratch directory."""
1325
from shutil import rmtree
1328
mutter("delete ScratchBranch %s" % self.base)
1331
# Work around for shutil.rmtree failing on Windows when
1332
# readonly files are encountered
1333
mutter("hit exception in destroying ScratchBranch: %s" % e)
1334
for root, dirs, files in os.walk(self.base, topdown=False):
1336
os.chmod(os.path.join(root, name), 0700)
1338
self._transport = None
1342
######################################################################
1346
def is_control_file(filename):
1347
## FIXME: better check
1348
filename = os.path.normpath(filename)
1349
while filename != '':
1350
head, tail = os.path.split(filename)
1351
## mutter('check %r for control file' % ((head, tail), ))
1352
if tail == bzrlib.BZRDIR:
1354
if filename == head:
1361
def gen_file_id(name):
1362
"""Return new file id.
1364
This should probably generate proper UUIDs, but for the moment we
1365
cope with just randomness because running uuidgen every time is
1368
from binascii import hexlify
1369
from time import time
1371
# get last component
1372
idx = name.rfind('/')
1374
name = name[idx+1 : ]
1375
idx = name.rfind('\\')
1377
name = name[idx+1 : ]
1379
# make it not a hidden file
1380
name = name.lstrip('.')
1382
# remove any wierd characters; we don't escape them but rather
1383
# just pull them out
1384
name = re.sub(r'[^\w.]', '', name)
1386
s = hexlify(rand_bytes(8))
1387
return '-'.join((name, compact_date(time()), s))
1391
"""Return a new tree-root file id."""
1392
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
