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
25
from bzrlib.trace import mutter, note
26
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
27
rename, splitpath, sha_file, appendpath,
29
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
30
NoSuchRevision, HistoryMissing, NotBranchError,
31
DivergedBranches, LockError)
32
from bzrlib.textui import show_status
33
from bzrlib.revision import Revision, validate_revision_id
34
from bzrlib.delta import compare_trees
35
from bzrlib.tree import EmptyTree, RevisionTree
36
from bzrlib.inventory import Inventory
37
from bzrlib.weavestore import WeaveStore
38
from bzrlib.store import ImmutableStore
43
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
44
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
45
## TODO: Maybe include checks for common corruption of newlines, etc?
48
# TODO: Some operations like log might retrieve the same revisions
49
# repeatedly to calculate deltas. We could perhaps have a weakref
50
# cache in memory to make this faster. In general anything can be
51
# cached in memory between lock and unlock operations.
53
def find_branch(*ignored, **ignored_too):
54
# XXX: leave this here for about one release, then remove it
55
raise NotImplementedError('find_branch() is not supported anymore, '
56
'please use one of the new branch constructors')
58
def _relpath(base, path):
59
"""Return path relative to base, or raise exception.
61
The path may be either an absolute path or a path relative to the
62
current working directory.
64
Lifted out of Branch.relpath for ease of testing.
66
os.path.commonprefix (python2.4) has a bad bug that it works just
67
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
68
avoids that problem."""
69
rp = os.path.abspath(path)
73
while len(head) >= len(base):
76
head, tail = os.path.split(head)
80
raise NotBranchError("path %r is not within branch %r" % (rp, base))
85
def find_branch_root(f=None):
86
"""Find the branch root enclosing f, or pwd.
88
f may be a filename or a URL.
90
It is not necessary that f exists.
92
Basically we keep looking up until we find the control directory or
93
run into the root. If there isn't one, raises NotBranchError.
97
elif hasattr(os.path, 'realpath'):
98
f = os.path.realpath(f)
100
f = os.path.abspath(f)
101
if not os.path.exists(f):
102
raise BzrError('%r does not exist' % f)
108
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
110
head, tail = os.path.split(f)
112
# reached the root, whatever that may be
113
raise NotBranchError('%s is not in a branch' % orig_f)
119
######################################################################
122
class Branch(object):
123
"""Branch holding a history of revisions.
126
Base directory/url of the branch.
130
def __init__(self, *ignored, **ignored_too):
131
raise NotImplementedError('The Branch class is abstract')
135
"""Open an existing branch, rooted at 'base' (url)"""
136
if base and (base.startswith('http://') or base.startswith('https://')):
137
from bzrlib.remotebranch import RemoteBranch
138
return RemoteBranch(base, find_root=False)
140
return LocalBranch(base, find_root=False)
143
def open_containing(url):
144
"""Open an existing branch which contains url.
146
This probes for a branch at url, and searches upwards from there.
148
if url and (url.startswith('http://') or url.startswith('https://')):
149
from bzrlib.remotebranch import RemoteBranch
150
return RemoteBranch(url)
152
return LocalBranch(url)
155
def initialize(base):
156
"""Create a new branch, rooted at 'base' (url)"""
157
if base and (base.startswith('http://') or base.startswith('https://')):
158
from bzrlib.remotebranch import RemoteBranch
159
return RemoteBranch(base, init=True)
161
return LocalBranch(base, init=True)
163
def setup_caching(self, cache_root):
164
"""Subclasses that care about caching should override this, and set
165
up cached stores located under cache_root.
169
class LocalBranch(Branch):
170
"""A branch stored in the actual filesystem.
172
Note that it's "local" in the context of the filesystem; it doesn't
173
really matter if it's on an nfs/smb/afs/coda/... share, as long as
174
it's writable, and can be accessed via the normal filesystem API.
180
If _lock_mode is true, a positive count of the number of times the
184
Lock object from bzrlib.lock.
186
# We actually expect this class to be somewhat short-lived; part of its
187
# purpose is to try to isolate what bits of the branch logic are tied to
188
# filesystem access, so that in a later step, we can extricate them to
189
# a separarte ("storage") class.
193
_inventory_weave = None
195
# Map some sort of prefix into a namespace
196
# stuff like "revno:10", "revid:", etc.
197
# This should match a prefix with a function which accepts
198
REVISION_NAMESPACES = {}
200
def __init__(self, base, init=False, find_root=True,
201
relax_version_check=False):
202
"""Create new branch object at a particular location.
204
base -- Base directory for the branch. May be a file:// url.
206
init -- If True, create new control files in a previously
207
unversioned directory. If False, the branch must already
210
find_root -- If true and init is false, find the root of the
211
existing branch containing base.
213
relax_version_check -- If true, the usual check for the branch
214
version is not applied. This is intended only for
215
upgrade/recovery type use; it's not guaranteed that
216
all operations will work on old format branches.
218
In the test suite, creation of new trees is tested using the
219
`ScratchBranch` class.
222
self.base = os.path.realpath(base)
225
self.base = find_branch_root(base)
227
if base.startswith("file://"):
229
self.base = os.path.realpath(base)
230
if not isdir(self.controlfilename('.')):
231
raise NotBranchError('not a bzr branch: %s' % quotefn(base),
232
['use "bzr init" to initialize a '
234
self._check_format(relax_version_check)
235
cfn = self.controlfilename
236
if self._branch_format == 4:
237
self.inventory_store = ImmutableStore(cfn('inventory-store'))
238
self.text_store = ImmutableStore(cfn('text-store'))
239
elif self._branch_format == 5:
240
self.control_weaves = WeaveStore(cfn([]))
241
self.weave_store = WeaveStore(cfn('weaves'))
243
# FIXME: Unify with make_control_files
244
self.control_weaves.put_empty_weave('inventory')
245
self.control_weaves.put_empty_weave('ancestry')
246
self.revision_store = ImmutableStore(cfn('revision-store'))
250
return '%s(%r)' % (self.__class__.__name__, self.base)
257
if self._lock_mode or self._lock:
258
# XXX: This should show something every time, and be suitable for
259
# headless operation and embedding
260
warn("branch %r was not explicitly unlocked" % self)
263
def lock_write(self):
265
if self._lock_mode != 'w':
266
raise LockError("can't upgrade to a write lock from %r" %
268
self._lock_count += 1
270
from bzrlib.lock import WriteLock
272
self._lock = WriteLock(self.controlfilename('branch-lock'))
273
self._lock_mode = 'w'
279
assert self._lock_mode in ('r', 'w'), \
280
"invalid lock mode %r" % self._lock_mode
281
self._lock_count += 1
283
from bzrlib.lock import ReadLock
285
self._lock = ReadLock(self.controlfilename('branch-lock'))
286
self._lock_mode = 'r'
290
if not self._lock_mode:
291
raise LockError('branch %r is not locked' % (self))
293
if self._lock_count > 1:
294
self._lock_count -= 1
298
self._lock_mode = self._lock_count = None
300
def abspath(self, name):
301
"""Return absolute filename for something in the branch"""
302
return os.path.join(self.base, name)
304
def relpath(self, path):
305
"""Return path relative to this branch of something inside it.
307
Raises an error if path is not in this branch."""
308
return _relpath(self.base, path)
310
def controlfilename(self, file_or_path):
311
"""Return location relative to branch."""
312
if isinstance(file_or_path, basestring):
313
file_or_path = [file_or_path]
314
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
317
def controlfile(self, file_or_path, mode='r'):
318
"""Open a control file for this branch.
320
There are two classes of file in the control directory: text
321
and binary. binary files are untranslated byte streams. Text
322
control files are stored with Unix newlines and in UTF-8, even
323
if the platform or locale defaults are different.
325
Controlfiles should almost never be opened in write mode but
326
rather should be atomically copied and replaced using atomicfile.
329
fn = self.controlfilename(file_or_path)
331
if mode == 'rb' or mode == 'wb':
332
return file(fn, mode)
333
elif mode == 'r' or mode == 'w':
334
# open in binary mode anyhow so there's no newline translation;
335
# codecs uses line buffering by default; don't want that.
337
return codecs.open(fn, mode + 'b', 'utf-8',
340
raise BzrError("invalid controlfile mode %r" % mode)
342
def _make_control(self):
343
os.mkdir(self.controlfilename([]))
344
self.controlfile('README', 'w').write(
345
"This is a Bazaar-NG control directory.\n"
346
"Do not change any files in this directory.\n")
347
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
348
for d in ('text-store', 'revision-store',
350
os.mkdir(self.controlfilename(d))
351
for f in ('revision-history',
355
self.controlfile(f, 'w').write('')
356
mutter('created control directory in ' + self.base)
358
# if we want per-tree root ids then this is the place to set
359
# them; they're not needed for now and so ommitted for
361
f = self.controlfile('inventory','w')
362
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
365
def _check_format(self, relax_version_check):
366
"""Check this branch format is supported.
368
The format level is stored, as an integer, in
369
self._branch_format for code that needs to check it later.
371
In the future, we might need different in-memory Branch
372
classes to support downlevel branches. But not yet.
375
fmt = self.controlfile('branch-format', 'r').read()
377
if e.errno == errno.ENOENT:
378
raise NotBranchError(self.base)
382
if fmt == BZR_BRANCH_FORMAT_5:
383
self._branch_format = 5
384
elif fmt == BZR_BRANCH_FORMAT_4:
385
self._branch_format = 4
387
if (not relax_version_check
388
and self._branch_format != 5):
389
raise BzrError('sorry, branch format %r not supported' % fmt,
390
['use a different bzr version',
391
'or remove the .bzr directory and "bzr init" again'])
393
def get_root_id(self):
394
"""Return the id of this branches root"""
395
inv = self.read_working_inventory()
396
return inv.root.file_id
398
def set_root_id(self, file_id):
399
inv = self.read_working_inventory()
400
orig_root_id = inv.root.file_id
401
del inv._byid[inv.root.file_id]
402
inv.root.file_id = file_id
403
inv._byid[inv.root.file_id] = inv.root
406
if entry.parent_id in (None, orig_root_id):
407
entry.parent_id = inv.root.file_id
408
self._write_inventory(inv)
410
def read_working_inventory(self):
411
"""Read the working inventory."""
414
# ElementTree does its own conversion from UTF-8, so open in
416
f = self.controlfile('inventory', 'rb')
417
return bzrlib.xml5.serializer_v5.read_inventory(f)
422
def _write_inventory(self, inv):
423
"""Update the working inventory.
425
That is to say, the inventory describing changes underway, that
426
will be committed to the next revision.
428
from bzrlib.atomicfile import AtomicFile
432
f = AtomicFile(self.controlfilename('inventory'), 'wb')
434
bzrlib.xml5.serializer_v5.write_inventory(inv, f)
441
mutter('wrote working inventory')
444
inventory = property(read_working_inventory, _write_inventory, None,
445
"""Inventory for the working copy.""")
448
def add(self, files, ids=None):
449
"""Make files versioned.
451
Note that the command line normally calls smart_add instead,
452
which can automatically recurse.
454
This puts the files in the Added state, so that they will be
455
recorded by the next commit.
458
List of paths to add, relative to the base of the tree.
461
If set, use these instead of automatically generated ids.
462
Must be the same length as the list of files, but may
463
contain None for ids that are to be autogenerated.
465
TODO: Perhaps have an option to add the ids even if the files do
468
TODO: Perhaps yield the ids and paths as they're added.
470
# TODO: Re-adding a file that is removed in the working copy
471
# should probably put it back with the previous ID.
472
if isinstance(files, basestring):
473
assert(ids is None or isinstance(ids, basestring))
479
ids = [None] * len(files)
481
assert(len(ids) == len(files))
485
inv = self.read_working_inventory()
486
for f,file_id in zip(files, ids):
487
if is_control_file(f):
488
raise BzrError("cannot add control file %s" % quotefn(f))
493
raise BzrError("cannot add top-level %r" % f)
495
fullpath = os.path.normpath(self.abspath(f))
498
kind = file_kind(fullpath)
500
# maybe something better?
501
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
503
if kind != 'file' and kind != 'directory':
504
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
507
file_id = gen_file_id(f)
508
inv.add_path(f, kind=kind, file_id=file_id)
510
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
512
self._write_inventory(inv)
517
def print_file(self, file, revno):
518
"""Print `file` to stdout."""
521
tree = self.revision_tree(self.get_rev_id(revno))
522
# use inventory as it was in that revision
523
file_id = tree.inventory.path2id(file)
525
raise BzrError("%r is not present in revision %s" % (file, revno))
526
tree.print_file(file_id)
531
def remove(self, files, verbose=False):
532
"""Mark nominated files for removal from the inventory.
534
This does not remove their text. This does not run on
536
TODO: Refuse to remove modified files unless --force is given?
538
TODO: Do something useful with directories.
540
TODO: Should this remove the text or not? Tough call; not
541
removing may be useful and the user can just use use rm, and
542
is the opposite of add. Removing it is consistent with most
543
other tools. Maybe an option.
545
## TODO: Normalize names
546
## TODO: Remove nested loops; better scalability
547
if isinstance(files, basestring):
553
tree = self.working_tree()
556
# do this before any modifications
560
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
561
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
563
# having remove it, it must be either ignored or unknown
564
if tree.is_ignored(f):
568
show_status(new_status, inv[fid].kind, quotefn(f))
571
self._write_inventory(inv)
576
# FIXME: this doesn't need to be a branch method
577
def set_inventory(self, new_inventory_list):
578
from bzrlib.inventory import Inventory, InventoryEntry
579
inv = Inventory(self.get_root_id())
580
for path, file_id, parent, kind in new_inventory_list:
581
name = os.path.basename(path)
584
inv.add(InventoryEntry(file_id, name, kind, parent))
585
self._write_inventory(inv)
589
"""Return all unknown files.
591
These are files in the working directory that are not versioned or
592
control files or ignored.
594
>>> b = ScratchBranch(files=['foo', 'foo~'])
595
>>> list(b.unknowns())
598
>>> list(b.unknowns())
601
>>> list(b.unknowns())
604
return self.working_tree().unknowns()
607
def append_revision(self, *revision_ids):
608
from bzrlib.atomicfile import AtomicFile
610
for revision_id in revision_ids:
611
mutter("add {%s} to revision-history" % revision_id)
613
rev_history = self.revision_history()
614
rev_history.extend(revision_ids)
616
f = AtomicFile(self.controlfilename('revision-history'))
618
for rev_id in rev_history:
625
def has_revision(self, revision_id):
626
"""True if this branch has a copy of the revision.
628
This does not necessarily imply the revision is merge
629
or on the mainline."""
630
return (revision_id is None
631
or revision_id in self.revision_store)
634
def get_revision_xml_file(self, revision_id):
635
"""Return XML file object for revision object."""
636
if not revision_id or not isinstance(revision_id, basestring):
637
raise InvalidRevisionId(revision_id)
642
return self.revision_store[revision_id]
643
except (IndexError, KeyError):
644
raise bzrlib.errors.NoSuchRevision(self, revision_id)
649
def get_revision_xml(self, revision_id):
650
return self.get_revision_xml_file(revision_id).read()
653
def get_revision(self, revision_id):
654
"""Return the Revision object for a named revision"""
655
xml_file = self.get_revision_xml_file(revision_id)
658
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
659
except SyntaxError, e:
660
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
664
assert r.revision_id == revision_id
668
def get_revision_delta(self, revno):
669
"""Return the delta for one revision.
671
The delta is relative to its mainline predecessor, or the
672
empty tree for revision 1.
674
assert isinstance(revno, int)
675
rh = self.revision_history()
676
if not (1 <= revno <= len(rh)):
677
raise InvalidRevisionNumber(revno)
679
# revno is 1-based; list is 0-based
681
new_tree = self.revision_tree(rh[revno-1])
683
old_tree = EmptyTree()
685
old_tree = self.revision_tree(rh[revno-2])
687
return compare_trees(old_tree, new_tree)
690
def get_revision_sha1(self, revision_id):
691
"""Hash the stored value of a revision, and return it."""
692
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
695
def _get_ancestry_weave(self):
696
return self.control_weaves.get_weave('ancestry')
699
def get_ancestry(self, revision_id):
700
"""Return a list of revision-ids integrated by a revision.
703
if revision_id is None:
705
w = self._get_ancestry_weave()
706
return [None] + [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
709
def get_inventory_weave(self):
710
return self.control_weaves.get_weave('inventory')
713
def get_inventory(self, revision_id):
714
"""Get Inventory object by hash."""
715
xml = self.get_inventory_xml(revision_id)
716
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
719
def get_inventory_xml(self, revision_id):
720
"""Get inventory XML as a file object."""
722
assert isinstance(revision_id, basestring), type(revision_id)
723
iw = self.get_inventory_weave()
724
return iw.get_text(iw.lookup(revision_id))
726
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
729
def get_inventory_sha1(self, revision_id):
730
"""Return the sha1 hash of the inventory entry
732
return self.get_revision(revision_id).inventory_sha1
735
def get_revision_inventory(self, revision_id):
736
"""Return inventory of a past revision."""
737
# TODO: Unify this with get_inventory()
738
# bzr 0.0.6 and later imposes the constraint that the inventory_id
739
# must be the same as its revision, so this is trivial.
740
if revision_id == None:
741
return Inventory(self.get_root_id())
743
return self.get_inventory(revision_id)
746
def revision_history(self):
747
"""Return sequence of revision hashes on to this branch."""
750
return [l.rstrip('\r\n') for l in
751
self.controlfile('revision-history', 'r').readlines()]
756
def common_ancestor(self, other, self_revno=None, other_revno=None):
758
>>> from bzrlib.commit import commit
759
>>> sb = ScratchBranch(files=['foo', 'foo~'])
760
>>> sb.common_ancestor(sb) == (None, None)
762
>>> commit(sb, "Committing first revision", verbose=False)
763
>>> sb.common_ancestor(sb)[0]
765
>>> clone = sb.clone()
766
>>> commit(sb, "Committing second revision", verbose=False)
767
>>> sb.common_ancestor(sb)[0]
769
>>> sb.common_ancestor(clone)[0]
771
>>> commit(clone, "Committing divergent second revision",
773
>>> sb.common_ancestor(clone)[0]
775
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
777
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
779
>>> clone2 = sb.clone()
780
>>> sb.common_ancestor(clone2)[0]
782
>>> sb.common_ancestor(clone2, self_revno=1)[0]
784
>>> sb.common_ancestor(clone2, other_revno=1)[0]
787
my_history = self.revision_history()
788
other_history = other.revision_history()
789
if self_revno is None:
790
self_revno = len(my_history)
791
if other_revno is None:
792
other_revno = len(other_history)
793
indices = range(min((self_revno, other_revno)))
796
if my_history[r] == other_history[r]:
797
return r+1, my_history[r]
802
"""Return current revision number for this branch.
804
That is equivalent to the number of revisions committed to
807
return len(self.revision_history())
810
def last_revision(self):
811
"""Return last patch hash, or None if no history.
813
ph = self.revision_history()
820
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
821
"""Return a list of new revisions that would perfectly fit.
823
If self and other have not diverged, return a list of the revisions
824
present in other, but missing from self.
826
>>> from bzrlib.commit import commit
827
>>> bzrlib.trace.silent = True
828
>>> br1 = ScratchBranch()
829
>>> br2 = ScratchBranch()
830
>>> br1.missing_revisions(br2)
832
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
833
>>> br1.missing_revisions(br2)
835
>>> br2.missing_revisions(br1)
837
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
838
>>> br1.missing_revisions(br2)
840
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
841
>>> br1.missing_revisions(br2)
843
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
844
>>> br1.missing_revisions(br2)
845
Traceback (most recent call last):
846
DivergedBranches: These branches have diverged.
848
# FIXME: If the branches have diverged, but the latest
849
# revision in this branch is completely merged into the other,
850
# then we should still be able to pull.
851
self_history = self.revision_history()
852
self_len = len(self_history)
853
other_history = other.revision_history()
854
other_len = len(other_history)
855
common_index = min(self_len, other_len) -1
856
if common_index >= 0 and \
857
self_history[common_index] != other_history[common_index]:
858
raise DivergedBranches(self, other)
860
if stop_revision is None:
861
stop_revision = other_len
863
assert isinstance(stop_revision, int)
864
if stop_revision > other_len:
865
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
866
return other_history[self_len:stop_revision]
868
def update_revisions(self, other, stop_revision=None):
869
"""Pull in new perfect-fit revisions."""
870
from bzrlib.fetch import greedy_fetch
871
from bzrlib.revision import get_intervening_revisions
872
if stop_revision is None:
873
stop_revision = other.last_revision()
874
greedy_fetch(to_branch=self, from_branch=other,
875
revision=stop_revision)
876
pullable_revs = self.missing_revisions(
877
other, other.revision_id_to_revno(stop_revision))
879
greedy_fetch(to_branch=self,
881
revision=pullable_revs[-1])
882
self.append_revision(*pullable_revs)
884
def commit(self, *args, **kw):
885
from bzrlib.commit import Commit
886
Commit().commit(self, *args, **kw)
888
def revision_id_to_revno(self, revision_id):
889
"""Given a revision id, return its revno"""
890
if revision_id is None:
892
history = self.revision_history()
894
return history.index(revision_id) + 1
896
raise bzrlib.errors.NoSuchRevision(self, revision_id)
898
def get_rev_id(self, revno, history=None):
899
"""Find the revision id of the specified revno."""
903
history = self.revision_history()
904
elif revno <= 0 or revno > len(history):
905
raise bzrlib.errors.NoSuchRevision(self, revno)
906
return history[revno - 1]
908
def revision_tree(self, revision_id):
909
"""Return Tree for a revision on this branch.
911
`revision_id` may be None for the null revision, in which case
912
an `EmptyTree` is returned."""
913
# TODO: refactor this to use an existing revision object
914
# so we don't need to read it in twice.
915
if revision_id == None:
918
inv = self.get_revision_inventory(revision_id)
919
return RevisionTree(self.weave_store, inv, revision_id)
922
def working_tree(self):
923
"""Return a `Tree` for the working copy."""
924
from bzrlib.workingtree import WorkingTree
925
return WorkingTree(self.base, self.read_working_inventory())
928
def basis_tree(self):
929
"""Return `Tree` object for last revision.
931
If there are no revisions yet, return an `EmptyTree`.
933
return self.revision_tree(self.last_revision())
936
def rename_one(self, from_rel, to_rel):
939
This can change the directory or the filename or both.
943
tree = self.working_tree()
945
if not tree.has_filename(from_rel):
946
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
947
if tree.has_filename(to_rel):
948
raise BzrError("can't rename: new working file %r already exists" % to_rel)
950
file_id = inv.path2id(from_rel)
952
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
954
if inv.path2id(to_rel):
955
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
957
to_dir, to_tail = os.path.split(to_rel)
958
to_dir_id = inv.path2id(to_dir)
959
if to_dir_id == None and to_dir != '':
960
raise BzrError("can't determine destination directory id for %r" % to_dir)
962
mutter("rename_one:")
963
mutter(" file_id {%s}" % file_id)
964
mutter(" from_rel %r" % from_rel)
965
mutter(" to_rel %r" % to_rel)
966
mutter(" to_dir %r" % to_dir)
967
mutter(" to_dir_id {%s}" % to_dir_id)
969
inv.rename(file_id, to_dir_id, to_tail)
971
from_abs = self.abspath(from_rel)
972
to_abs = self.abspath(to_rel)
974
rename(from_abs, to_abs)
976
raise BzrError("failed to rename %r to %r: %s"
977
% (from_abs, to_abs, e[1]),
978
["rename rolled back"])
980
self._write_inventory(inv)
985
def move(self, from_paths, to_name):
988
to_name must exist as a versioned directory.
990
If to_name exists and is a directory, the files are moved into
991
it, keeping their old names. If it is a directory,
993
Note that to_name is only the last component of the new name;
994
this doesn't change the directory.
996
This returns a list of (from_path, to_path) pairs for each
1002
## TODO: Option to move IDs only
1003
assert not isinstance(from_paths, basestring)
1004
tree = self.working_tree()
1005
inv = tree.inventory
1006
to_abs = self.abspath(to_name)
1007
if not isdir(to_abs):
1008
raise BzrError("destination %r is not a directory" % to_abs)
1009
if not tree.has_filename(to_name):
1010
raise BzrError("destination %r not in working directory" % to_abs)
1011
to_dir_id = inv.path2id(to_name)
1012
if to_dir_id == None and to_name != '':
1013
raise BzrError("destination %r is not a versioned directory" % to_name)
1014
to_dir_ie = inv[to_dir_id]
1015
if to_dir_ie.kind not in ('directory', 'root_directory'):
1016
raise BzrError("destination %r is not a directory" % to_abs)
1018
to_idpath = inv.get_idpath(to_dir_id)
1020
for f in from_paths:
1021
if not tree.has_filename(f):
1022
raise BzrError("%r does not exist in working tree" % f)
1023
f_id = inv.path2id(f)
1025
raise BzrError("%r is not versioned" % f)
1026
name_tail = splitpath(f)[-1]
1027
dest_path = appendpath(to_name, name_tail)
1028
if tree.has_filename(dest_path):
1029
raise BzrError("destination %r already exists" % dest_path)
1030
if f_id in to_idpath:
1031
raise BzrError("can't move %r to a subdirectory of itself" % f)
1033
# OK, so there's a race here, it's possible that someone will
1034
# create a file in this interval and then the rename might be
1035
# left half-done. But we should have caught most problems.
1037
for f in from_paths:
1038
name_tail = splitpath(f)[-1]
1039
dest_path = appendpath(to_name, name_tail)
1040
result.append((f, dest_path))
1041
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1043
rename(self.abspath(f), self.abspath(dest_path))
1045
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1046
["rename rolled back"])
1048
self._write_inventory(inv)
1055
def revert(self, filenames, old_tree=None, backups=True):
1056
"""Restore selected files to the versions from a previous tree.
1059
If true (default) backups are made of files before
1062
from bzrlib.errors import NotVersionedError, BzrError
1063
from bzrlib.atomicfile import AtomicFile
1064
from bzrlib.osutils import backup_file
1066
inv = self.read_working_inventory()
1067
if old_tree is None:
1068
old_tree = self.basis_tree()
1069
old_inv = old_tree.inventory
1072
for fn in filenames:
1073
file_id = inv.path2id(fn)
1075
raise NotVersionedError("not a versioned file", fn)
1076
if not old_inv.has_id(file_id):
1077
raise BzrError("file not present in old tree", fn, file_id)
1078
nids.append((fn, file_id))
1080
# TODO: Rename back if it was previously at a different location
1082
# TODO: If given a directory, restore the entire contents from
1083
# the previous version.
1085
# TODO: Make a backup to a temporary file.
1087
# TODO: If the file previously didn't exist, delete it?
1088
for fn, file_id in nids:
1091
f = AtomicFile(fn, 'wb')
1093
f.write(old_tree.get_file(file_id).read())
1099
def pending_merges(self):
1100
"""Return a list of pending merges.
1102
These are revisions that have been merged into the working
1103
directory but not yet committed.
1105
cfn = self.controlfilename('pending-merges')
1106
if not os.path.exists(cfn):
1109
for l in self.controlfile('pending-merges', 'r').readlines():
1110
p.append(l.rstrip('\n'))
1114
def add_pending_merge(self, revision_id):
1115
validate_revision_id(revision_id)
1116
# TODO: Perhaps should check at this point that the
1117
# history of the revision is actually present?
1118
p = self.pending_merges()
1119
if revision_id in p:
1121
p.append(revision_id)
1122
self.set_pending_merges(p)
1125
def set_pending_merges(self, rev_list):
1126
from bzrlib.atomicfile import AtomicFile
1129
f = AtomicFile(self.controlfilename('pending-merges'))
1140
def get_parent(self):
1141
"""Return the parent location of the branch.
1143
This is the default location for push/pull/missing. The usual
1144
pattern is that the user can override it by specifying a
1148
_locs = ['parent', 'pull', 'x-pull']
1151
return self.controlfile(l, 'r').read().strip('\n')
1153
if e.errno != errno.ENOENT:
1158
def set_parent(self, url):
1159
# TODO: Maybe delete old location files?
1160
from bzrlib.atomicfile import AtomicFile
1163
f = AtomicFile(self.controlfilename('parent'))
1172
def check_revno(self, revno):
1174
Check whether a revno corresponds to any revision.
1175
Zero (the NULL revision) is considered valid.
1178
self.check_real_revno(revno)
1180
def check_real_revno(self, revno):
1182
Check whether a revno corresponds to a real revision.
1183
Zero (the NULL revision) is considered invalid
1185
if revno < 1 or revno > self.revno():
1186
raise InvalidRevisionNumber(revno)
1192
class ScratchBranch(LocalBranch):
1193
"""Special test class: a branch that cleans up after itself.
1195
>>> b = ScratchBranch()
1203
def __init__(self, files=[], dirs=[], base=None):
1204
"""Make a test branch.
1206
This creates a temporary directory and runs init-tree in it.
1208
If any files are listed, they are created in the working copy.
1210
from tempfile import mkdtemp
1215
LocalBranch.__init__(self, base, init=init)
1217
os.mkdir(self.abspath(d))
1220
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1225
>>> orig = ScratchBranch(files=["file1", "file2"])
1226
>>> clone = orig.clone()
1227
>>> if os.name != 'nt':
1228
... os.path.samefile(orig.base, clone.base)
1230
... orig.base == clone.base
1233
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1236
from shutil import copytree
1237
from tempfile import mkdtemp
1240
copytree(self.base, base, symlinks=True)
1241
return ScratchBranch(base=base)
1249
"""Destroy the test branch, removing the scratch directory."""
1250
from shutil import rmtree
1253
mutter("delete ScratchBranch %s" % self.base)
1256
# Work around for shutil.rmtree failing on Windows when
1257
# readonly files are encountered
1258
mutter("hit exception in destroying ScratchBranch: %s" % e)
1259
for root, dirs, files in os.walk(self.base, topdown=False):
1261
os.chmod(os.path.join(root, name), 0700)
1267
######################################################################
1271
def is_control_file(filename):
1272
## FIXME: better check
1273
filename = os.path.normpath(filename)
1274
while filename != '':
1275
head, tail = os.path.split(filename)
1276
## mutter('check %r for control file' % ((head, tail), ))
1277
if tail == bzrlib.BZRDIR:
1279
if filename == head:
1286
def gen_file_id(name):
1287
"""Return new file id.
1289
This should probably generate proper UUIDs, but for the moment we
1290
cope with just randomness because running uuidgen every time is
1293
from binascii import hexlify
1294
from time import time
1296
# get last component
1297
idx = name.rfind('/')
1299
name = name[idx+1 : ]
1300
idx = name.rfind('\\')
1302
name = name[idx+1 : ]
1304
# make it not a hidden file
1305
name = name.lstrip('.')
1307
# remove any wierd characters; we don't escape them but rather
1308
# just pull them out
1309
name = re.sub(r'[^\w.]', '', name)
1311
s = hexlify(rand_bytes(8))
1312
return '-'.join((name, compact_date(time()), s))
1316
"""Return a new tree-root file id."""
1317
return gen_file_id('TREE_ROOT')
1320
def copy_branch(branch_from, to_location, revision=None):
1321
"""Copy branch_from into the existing directory to_location.
1324
If not None, only revisions up to this point will be copied.
1325
The head of the new branch will be that revision. Must be a
1329
The name of a local directory that exists but is empty.
1331
# TODO: This could be done *much* more efficiently by just copying
1332
# all the whole weaves and revisions, rather than getting one
1333
# revision at a time.
1334
from bzrlib.merge import merge
1336
assert isinstance(branch_from, Branch)
1337
assert isinstance(to_location, basestring)
1339
br_to = Branch.initialize(to_location)
1340
br_to.set_root_id(branch_from.get_root_id())
1341
if revision is None:
1342
revision = branch_from.last_revision()
1343
br_to.update_revisions(branch_from, stop_revision=revision)
1344
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1345
check_clean=False, ignore_zero=True)
1346
br_to.set_parent(branch_from.base)
added
removed
bzrlib/branch.py
