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, UnlistableStore,
33
from bzrlib.textui import show_status
34
from bzrlib.revision import Revision, validate_revision_id, is_ancestor
35
from bzrlib.delta import compare_trees
36
from bzrlib.tree import EmptyTree, RevisionTree
37
from bzrlib.inventory import Inventory
38
from bzrlib.weavestore import WeaveStore
39
from bzrlib.store import copy_all, ImmutableStore
44
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
45
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
46
## TODO: Maybe include checks for common corruption of newlines, etc?
49
# TODO: Some operations like log might retrieve the same revisions
50
# repeatedly to calculate deltas. We could perhaps have a weakref
51
# cache in memory to make this faster. In general anything can be
52
# cached in memory between lock and unlock operations.
54
def find_branch(*ignored, **ignored_too):
55
# XXX: leave this here for about one release, then remove it
56
raise NotImplementedError('find_branch() is not supported anymore, '
57
'please use one of the new branch constructors')
59
def _relpath(base, path):
60
"""Return path relative to base, or raise exception.
62
The path may be either an absolute path or a path relative to the
63
current working directory.
65
Lifted out of Branch.relpath for ease of testing.
67
os.path.commonprefix (python2.4) has a bad bug that it works just
68
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
69
avoids that problem."""
70
rp = os.path.abspath(path)
74
while len(head) >= len(base):
77
head, tail = os.path.split(head)
81
raise NotBranchError("path %r is not within branch %r" % (rp, base))
86
def find_branch_root(f=None):
87
"""Find the branch root enclosing f, or pwd.
89
f may be a filename or a URL.
91
It is not necessary that f exists.
93
Basically we keep looking up until we find the control directory or
94
run into the root. If there isn't one, raises NotBranchError.
98
elif hasattr(os.path, 'realpath'):
99
f = os.path.realpath(f)
101
f = os.path.abspath(f)
102
if not os.path.exists(f):
103
raise BzrError('%r does not exist' % f)
109
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
111
head, tail = os.path.split(f)
113
# reached the root, whatever that may be
114
raise NotBranchError('%s is not in a branch' % orig_f)
120
######################################################################
123
class Branch(object):
124
"""Branch holding a history of revisions.
127
Base directory/url of the branch.
131
def __init__(self, *ignored, **ignored_too):
132
raise NotImplementedError('The Branch class is abstract')
135
def open_downlevel(base):
136
"""Open a branch which may be of an old format.
138
Only local branches are supported."""
139
return LocalBranch(base, find_root=False, relax_version_check=True)
143
"""Open an existing branch, rooted at 'base' (url)"""
144
if base and (base.startswith('http://') or base.startswith('https://')):
145
from bzrlib.remotebranch import RemoteBranch
146
return RemoteBranch(base, find_root=False)
148
return LocalBranch(base, find_root=False)
151
def open_containing(url):
152
"""Open an existing branch which contains url.
154
This probes for a branch at url, and searches upwards from there.
156
if url and (url.startswith('http://') or url.startswith('https://')):
157
from bzrlib.remotebranch import RemoteBranch
158
return RemoteBranch(url)
160
return LocalBranch(url)
163
def initialize(base):
164
"""Create a new branch, rooted at 'base' (url)"""
165
if base and (base.startswith('http://') or base.startswith('https://')):
166
from bzrlib.remotebranch import RemoteBranch
167
return RemoteBranch(base, init=True)
169
return LocalBranch(base, init=True)
171
def setup_caching(self, cache_root):
172
"""Subclasses that care about caching should override this, and set
173
up cached stores located under cache_root.
177
class LocalBranch(Branch):
178
"""A branch stored in the actual filesystem.
180
Note that it's "local" in the context of the filesystem; it doesn't
181
really matter if it's on an nfs/smb/afs/coda/... share, as long as
182
it's writable, and can be accessed via the normal filesystem API.
188
If _lock_mode is true, a positive count of the number of times the
192
Lock object from bzrlib.lock.
194
# We actually expect this class to be somewhat short-lived; part of its
195
# purpose is to try to isolate what bits of the branch logic are tied to
196
# filesystem access, so that in a later step, we can extricate them to
197
# a separarte ("storage") class.
201
_inventory_weave = None
203
# Map some sort of prefix into a namespace
204
# stuff like "revno:10", "revid:", etc.
205
# This should match a prefix with a function which accepts
206
REVISION_NAMESPACES = {}
208
def push_stores(self, branch_to):
209
"""Copy the content of this branches store to branch_to."""
210
if (self._branch_format != branch_to._branch_format
211
or self._branch_format != 4):
212
from bzrlib.fetch import greedy_fetch
213
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
214
self, self._branch_format, branch_to, branch_to._branch_format)
215
greedy_fetch(to_branch=branch_to, from_branch=self,
216
revision=self.last_revision())
219
store_pairs = ((self.text_store, branch_to.text_store),
220
(self.inventory_store, branch_to.inventory_store),
221
(self.revision_store, branch_to.revision_store))
223
for from_store, to_store in store_pairs:
224
copy_all(from_store, to_store)
225
except UnlistableStore:
226
raise UnlistableBranch(from_store)
228
def __init__(self, base, init=False, find_root=True,
229
relax_version_check=False):
230
"""Create new branch object at a particular location.
232
base -- Base directory for the branch. May be a file:// url.
234
init -- If True, create new control files in a previously
235
unversioned directory. If False, the branch must already
238
find_root -- If true and init is false, find the root of the
239
existing branch containing base.
241
relax_version_check -- If true, the usual check for the branch
242
version is not applied. This is intended only for
243
upgrade/recovery type use; it's not guaranteed that
244
all operations will work on old format branches.
246
In the test suite, creation of new trees is tested using the
247
`ScratchBranch` class.
250
self.base = os.path.realpath(base)
253
self.base = find_branch_root(base)
255
if base.startswith("file://"):
257
self.base = os.path.realpath(base)
258
if not isdir(self.controlfilename('.')):
259
raise NotBranchError('not a bzr branch: %s' % quotefn(base),
260
['use "bzr init" to initialize a '
262
self._check_format(relax_version_check)
263
cfn = self.controlfilename
264
if self._branch_format == 4:
265
self.inventory_store = ImmutableStore(cfn('inventory-store'))
266
self.text_store = ImmutableStore(cfn('text-store'))
267
elif self._branch_format == 5:
268
self.control_weaves = WeaveStore(cfn([]))
269
self.weave_store = WeaveStore(cfn('weaves'))
271
# FIXME: Unify with make_control_files
272
self.control_weaves.put_empty_weave('inventory')
273
self.control_weaves.put_empty_weave('ancestry')
274
self.revision_store = ImmutableStore(cfn('revision-store'))
278
return '%s(%r)' % (self.__class__.__name__, self.base)
285
if self._lock_mode or self._lock:
286
# XXX: This should show something every time, and be suitable for
287
# headless operation and embedding
288
warn("branch %r was not explicitly unlocked" % self)
291
def lock_write(self):
293
if self._lock_mode != 'w':
294
raise LockError("can't upgrade to a write lock from %r" %
296
self._lock_count += 1
298
from bzrlib.lock import WriteLock
300
self._lock = WriteLock(self.controlfilename('branch-lock'))
301
self._lock_mode = 'w'
307
assert self._lock_mode in ('r', 'w'), \
308
"invalid lock mode %r" % self._lock_mode
309
self._lock_count += 1
311
from bzrlib.lock import ReadLock
313
self._lock = ReadLock(self.controlfilename('branch-lock'))
314
self._lock_mode = 'r'
318
if not self._lock_mode:
319
raise LockError('branch %r is not locked' % (self))
321
if self._lock_count > 1:
322
self._lock_count -= 1
326
self._lock_mode = self._lock_count = None
328
def abspath(self, name):
329
"""Return absolute filename for something in the branch"""
330
return os.path.join(self.base, name)
332
def relpath(self, path):
333
"""Return path relative to this branch of something inside it.
335
Raises an error if path is not in this branch."""
336
return _relpath(self.base, path)
338
def controlfilename(self, file_or_path):
339
"""Return location relative to branch."""
340
if isinstance(file_or_path, basestring):
341
file_or_path = [file_or_path]
342
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
345
def controlfile(self, file_or_path, mode='r'):
346
"""Open a control file for this branch.
348
There are two classes of file in the control directory: text
349
and binary. binary files are untranslated byte streams. Text
350
control files are stored with Unix newlines and in UTF-8, even
351
if the platform or locale defaults are different.
353
Controlfiles should almost never be opened in write mode but
354
rather should be atomically copied and replaced using atomicfile.
357
fn = self.controlfilename(file_or_path)
359
if mode == 'rb' or mode == 'wb':
360
return file(fn, mode)
361
elif mode == 'r' or mode == 'w':
362
# open in binary mode anyhow so there's no newline translation;
363
# codecs uses line buffering by default; don't want that.
365
return codecs.open(fn, mode + 'b', 'utf-8',
368
raise BzrError("invalid controlfile mode %r" % mode)
370
def _make_control(self):
371
os.mkdir(self.controlfilename([]))
372
self.controlfile('README', 'w').write(
373
"This is a Bazaar-NG control directory.\n"
374
"Do not change any files in this directory.\n")
375
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
376
for d in ('text-store', 'revision-store',
378
os.mkdir(self.controlfilename(d))
379
for f in ('revision-history',
383
self.controlfile(f, 'w').write('')
384
mutter('created control directory in ' + self.base)
386
# if we want per-tree root ids then this is the place to set
387
# them; they're not needed for now and so ommitted for
389
f = self.controlfile('inventory','w')
390
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
393
def _check_format(self, relax_version_check):
394
"""Check this branch format is supported.
396
The format level is stored, as an integer, in
397
self._branch_format for code that needs to check it later.
399
In the future, we might need different in-memory Branch
400
classes to support downlevel branches. But not yet.
403
fmt = self.controlfile('branch-format', 'r').read()
405
if e.errno == errno.ENOENT:
406
raise NotBranchError(self.base)
410
if fmt == BZR_BRANCH_FORMAT_5:
411
self._branch_format = 5
412
elif fmt == BZR_BRANCH_FORMAT_4:
413
self._branch_format = 4
415
if (not relax_version_check
416
and self._branch_format != 5):
417
raise BzrError('sorry, branch format %r not supported' % fmt,
418
['use a different bzr version',
419
'or remove the .bzr directory and "bzr init" again'])
421
def get_root_id(self):
422
"""Return the id of this branches root"""
423
inv = self.read_working_inventory()
424
return inv.root.file_id
426
def set_root_id(self, file_id):
427
inv = self.read_working_inventory()
428
orig_root_id = inv.root.file_id
429
del inv._byid[inv.root.file_id]
430
inv.root.file_id = file_id
431
inv._byid[inv.root.file_id] = inv.root
434
if entry.parent_id in (None, orig_root_id):
435
entry.parent_id = inv.root.file_id
436
self._write_inventory(inv)
438
def read_working_inventory(self):
439
"""Read the working inventory."""
442
# ElementTree does its own conversion from UTF-8, so open in
444
f = self.controlfile('inventory', 'rb')
445
return bzrlib.xml5.serializer_v5.read_inventory(f)
450
def _write_inventory(self, inv):
451
"""Update the working inventory.
453
That is to say, the inventory describing changes underway, that
454
will be committed to the next revision.
456
from bzrlib.atomicfile import AtomicFile
460
f = AtomicFile(self.controlfilename('inventory'), 'wb')
462
bzrlib.xml5.serializer_v5.write_inventory(inv, f)
469
mutter('wrote working inventory')
472
inventory = property(read_working_inventory, _write_inventory, None,
473
"""Inventory for the working copy.""")
476
def add(self, files, ids=None):
477
"""Make files versioned.
479
Note that the command line normally calls smart_add instead,
480
which can automatically recurse.
482
This puts the files in the Added state, so that they will be
483
recorded by the next commit.
486
List of paths to add, relative to the base of the tree.
489
If set, use these instead of automatically generated ids.
490
Must be the same length as the list of files, but may
491
contain None for ids that are to be autogenerated.
493
TODO: Perhaps have an option to add the ids even if the files do
496
TODO: Perhaps yield the ids and paths as they're added.
498
# TODO: Re-adding a file that is removed in the working copy
499
# should probably put it back with the previous ID.
500
if isinstance(files, basestring):
501
assert(ids is None or isinstance(ids, basestring))
507
ids = [None] * len(files)
509
assert(len(ids) == len(files))
513
inv = self.read_working_inventory()
514
for f,file_id in zip(files, ids):
515
if is_control_file(f):
516
raise BzrError("cannot add control file %s" % quotefn(f))
521
raise BzrError("cannot add top-level %r" % f)
523
fullpath = os.path.normpath(self.abspath(f))
526
kind = file_kind(fullpath)
528
# maybe something better?
529
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
531
if kind != 'file' and kind != 'directory':
532
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
535
file_id = gen_file_id(f)
536
inv.add_path(f, kind=kind, file_id=file_id)
538
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
540
self._write_inventory(inv)
545
def print_file(self, file, revno):
546
"""Print `file` to stdout."""
549
tree = self.revision_tree(self.get_rev_id(revno))
550
# use inventory as it was in that revision
551
file_id = tree.inventory.path2id(file)
553
raise BzrError("%r is not present in revision %s" % (file, revno))
554
tree.print_file(file_id)
559
def remove(self, files, verbose=False):
560
"""Mark nominated files for removal from the inventory.
562
This does not remove their text. This does not run on
564
TODO: Refuse to remove modified files unless --force is given?
566
TODO: Do something useful with directories.
568
TODO: Should this remove the text or not? Tough call; not
569
removing may be useful and the user can just use use rm, and
570
is the opposite of add. Removing it is consistent with most
571
other tools. Maybe an option.
573
## TODO: Normalize names
574
## TODO: Remove nested loops; better scalability
575
if isinstance(files, basestring):
581
tree = self.working_tree()
584
# do this before any modifications
588
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
589
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
591
# having remove it, it must be either ignored or unknown
592
if tree.is_ignored(f):
596
show_status(new_status, inv[fid].kind, quotefn(f))
599
self._write_inventory(inv)
604
# FIXME: this doesn't need to be a branch method
605
def set_inventory(self, new_inventory_list):
606
from bzrlib.inventory import Inventory, InventoryEntry
607
inv = Inventory(self.get_root_id())
608
for path, file_id, parent, kind in new_inventory_list:
609
name = os.path.basename(path)
612
inv.add(InventoryEntry(file_id, name, kind, parent))
613
self._write_inventory(inv)
617
"""Return all unknown files.
619
These are files in the working directory that are not versioned or
620
control files or ignored.
622
>>> b = ScratchBranch(files=['foo', 'foo~'])
623
>>> list(b.unknowns())
626
>>> list(b.unknowns())
629
>>> list(b.unknowns())
632
return self.working_tree().unknowns()
635
def append_revision(self, *revision_ids):
636
from bzrlib.atomicfile import AtomicFile
638
for revision_id in revision_ids:
639
mutter("add {%s} to revision-history" % revision_id)
641
rev_history = self.revision_history()
642
rev_history.extend(revision_ids)
644
f = AtomicFile(self.controlfilename('revision-history'))
646
for rev_id in rev_history:
653
def has_revision(self, revision_id):
654
"""True if this branch has a copy of the revision.
656
This does not necessarily imply the revision is merge
657
or on the mainline."""
658
return (revision_id is None
659
or revision_id in self.revision_store)
662
def get_revision_xml_file(self, revision_id):
663
"""Return XML file object for revision object."""
664
if not revision_id or not isinstance(revision_id, basestring):
665
raise InvalidRevisionId(revision_id)
670
return self.revision_store[revision_id]
671
except (IndexError, KeyError):
672
raise bzrlib.errors.NoSuchRevision(self, revision_id)
677
def get_revision_xml(self, revision_id):
678
return self.get_revision_xml_file(revision_id).read()
681
def get_revision(self, revision_id):
682
"""Return the Revision object for a named revision"""
683
xml_file = self.get_revision_xml_file(revision_id)
686
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
687
except SyntaxError, e:
688
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
692
assert r.revision_id == revision_id
696
def get_revision_delta(self, revno):
697
"""Return the delta for one revision.
699
The delta is relative to its mainline predecessor, or the
700
empty tree for revision 1.
702
assert isinstance(revno, int)
703
rh = self.revision_history()
704
if not (1 <= revno <= len(rh)):
705
raise InvalidRevisionNumber(revno)
707
# revno is 1-based; list is 0-based
709
new_tree = self.revision_tree(rh[revno-1])
711
old_tree = EmptyTree()
713
old_tree = self.revision_tree(rh[revno-2])
715
return compare_trees(old_tree, new_tree)
718
def get_revision_sha1(self, revision_id):
719
"""Hash the stored value of a revision, and return it."""
720
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
723
def _get_ancestry_weave(self):
724
return self.control_weaves.get_weave('ancestry')
727
def get_ancestry(self, revision_id):
728
"""Return a list of revision-ids integrated by a revision.
731
if revision_id is None:
733
w = self._get_ancestry_weave()
734
return [None] + [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
737
def get_inventory_weave(self):
738
return self.control_weaves.get_weave('inventory')
741
def get_inventory(self, revision_id):
742
"""Get Inventory object by hash."""
743
xml = self.get_inventory_xml(revision_id)
744
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
747
def get_inventory_xml(self, revision_id):
748
"""Get inventory XML as a file object."""
750
assert isinstance(revision_id, basestring), type(revision_id)
751
iw = self.get_inventory_weave()
752
return iw.get_text(iw.lookup(revision_id))
754
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
757
def get_inventory_sha1(self, revision_id):
758
"""Return the sha1 hash of the inventory entry
760
return self.get_revision(revision_id).inventory_sha1
763
def get_revision_inventory(self, revision_id):
764
"""Return inventory of a past revision."""
765
# TODO: Unify this with get_inventory()
766
# bzr 0.0.6 and later imposes the constraint that the inventory_id
767
# must be the same as its revision, so this is trivial.
768
if revision_id == None:
769
return Inventory(self.get_root_id())
771
return self.get_inventory(revision_id)
774
def revision_history(self):
775
"""Return sequence of revision hashes on to this branch."""
778
return [l.rstrip('\r\n') for l in
779
self.controlfile('revision-history', 'r').readlines()]
784
def common_ancestor(self, other, self_revno=None, other_revno=None):
786
>>> from bzrlib.commit import commit
787
>>> sb = ScratchBranch(files=['foo', 'foo~'])
788
>>> sb.common_ancestor(sb) == (None, None)
790
>>> commit(sb, "Committing first revision", verbose=False)
791
>>> sb.common_ancestor(sb)[0]
793
>>> clone = sb.clone()
794
>>> commit(sb, "Committing second revision", verbose=False)
795
>>> sb.common_ancestor(sb)[0]
797
>>> sb.common_ancestor(clone)[0]
799
>>> commit(clone, "Committing divergent second revision",
801
>>> sb.common_ancestor(clone)[0]
803
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
805
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
807
>>> clone2 = sb.clone()
808
>>> sb.common_ancestor(clone2)[0]
810
>>> sb.common_ancestor(clone2, self_revno=1)[0]
812
>>> sb.common_ancestor(clone2, other_revno=1)[0]
815
my_history = self.revision_history()
816
other_history = other.revision_history()
817
if self_revno is None:
818
self_revno = len(my_history)
819
if other_revno is None:
820
other_revno = len(other_history)
821
indices = range(min((self_revno, other_revno)))
824
if my_history[r] == other_history[r]:
825
return r+1, my_history[r]
830
"""Return current revision number for this branch.
832
That is equivalent to the number of revisions committed to
835
return len(self.revision_history())
838
def last_revision(self):
839
"""Return last patch hash, or None if no history.
841
ph = self.revision_history()
848
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
849
"""Return a list of new revisions that would perfectly fit.
851
If self and other have not diverged, return a list of the revisions
852
present in other, but missing from self.
854
>>> from bzrlib.commit import commit
855
>>> bzrlib.trace.silent = True
856
>>> br1 = ScratchBranch()
857
>>> br2 = ScratchBranch()
858
>>> br1.missing_revisions(br2)
860
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
861
>>> br1.missing_revisions(br2)
863
>>> br2.missing_revisions(br1)
865
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
866
>>> br1.missing_revisions(br2)
868
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
869
>>> br1.missing_revisions(br2)
871
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
872
>>> br1.missing_revisions(br2)
873
Traceback (most recent call last):
874
DivergedBranches: These branches have diverged.
876
# FIXME: If the branches have diverged, but the latest
877
# revision in this branch is completely merged into the other,
878
# then we should still be able to pull.
879
self_history = self.revision_history()
880
self_len = len(self_history)
881
other_history = other.revision_history()
882
other_len = len(other_history)
883
common_index = min(self_len, other_len) -1
884
if common_index >= 0 and \
885
self_history[common_index] != other_history[common_index]:
886
raise DivergedBranches(self, other)
888
if stop_revision is None:
889
stop_revision = other_len
891
assert isinstance(stop_revision, int)
892
if stop_revision > other_len:
893
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
894
return other_history[self_len:stop_revision]
896
def update_revisions(self, other, stop_revision=None):
897
"""Pull in new perfect-fit revisions."""
898
from bzrlib.fetch import greedy_fetch
899
from bzrlib.revision import get_intervening_revisions
900
if stop_revision is None:
901
stop_revision = other.last_revision()
902
greedy_fetch(to_branch=self, from_branch=other,
903
revision=stop_revision)
904
pullable_revs = self.missing_revisions(
905
other, other.revision_id_to_revno(stop_revision))
907
greedy_fetch(to_branch=self,
909
revision=pullable_revs[-1])
910
self.append_revision(*pullable_revs)
913
def commit(self, *args, **kw):
914
from bzrlib.commit import Commit
915
Commit().commit(self, *args, **kw)
917
def revision_id_to_revno(self, revision_id):
918
"""Given a revision id, return its revno"""
919
if revision_id is None:
921
history = self.revision_history()
923
return history.index(revision_id) + 1
925
raise bzrlib.errors.NoSuchRevision(self, revision_id)
927
def get_rev_id(self, revno, history=None):
928
"""Find the revision id of the specified revno."""
932
history = self.revision_history()
933
elif revno <= 0 or revno > len(history):
934
raise bzrlib.errors.NoSuchRevision(self, revno)
935
return history[revno - 1]
937
def revision_tree(self, revision_id):
938
"""Return Tree for a revision on this branch.
940
`revision_id` may be None for the null revision, in which case
941
an `EmptyTree` is returned."""
942
# TODO: refactor this to use an existing revision object
943
# so we don't need to read it in twice.
944
if revision_id == None:
947
inv = self.get_revision_inventory(revision_id)
948
return RevisionTree(self.weave_store, inv, revision_id)
951
def working_tree(self):
952
"""Return a `Tree` for the working copy."""
953
from bzrlib.workingtree import WorkingTree
954
return WorkingTree(self.base, self.read_working_inventory())
957
def basis_tree(self):
958
"""Return `Tree` object for last revision.
960
If there are no revisions yet, return an `EmptyTree`.
962
return self.revision_tree(self.last_revision())
965
def rename_one(self, from_rel, to_rel):
968
This can change the directory or the filename or both.
972
tree = self.working_tree()
974
if not tree.has_filename(from_rel):
975
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
976
if tree.has_filename(to_rel):
977
raise BzrError("can't rename: new working file %r already exists" % to_rel)
979
file_id = inv.path2id(from_rel)
981
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
983
if inv.path2id(to_rel):
984
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
986
to_dir, to_tail = os.path.split(to_rel)
987
to_dir_id = inv.path2id(to_dir)
988
if to_dir_id == None and to_dir != '':
989
raise BzrError("can't determine destination directory id for %r" % to_dir)
991
mutter("rename_one:")
992
mutter(" file_id {%s}" % file_id)
993
mutter(" from_rel %r" % from_rel)
994
mutter(" to_rel %r" % to_rel)
995
mutter(" to_dir %r" % to_dir)
996
mutter(" to_dir_id {%s}" % to_dir_id)
998
inv.rename(file_id, to_dir_id, to_tail)
1000
from_abs = self.abspath(from_rel)
1001
to_abs = self.abspath(to_rel)
1003
rename(from_abs, to_abs)
1005
raise BzrError("failed to rename %r to %r: %s"
1006
% (from_abs, to_abs, e[1]),
1007
["rename rolled back"])
1009
self._write_inventory(inv)
1014
def move(self, from_paths, to_name):
1017
to_name must exist as a versioned directory.
1019
If to_name exists and is a directory, the files are moved into
1020
it, keeping their old names. If it is a directory,
1022
Note that to_name is only the last component of the new name;
1023
this doesn't change the directory.
1025
This returns a list of (from_path, to_path) pairs for each
1026
entry that is moved.
1031
## TODO: Option to move IDs only
1032
assert not isinstance(from_paths, basestring)
1033
tree = self.working_tree()
1034
inv = tree.inventory
1035
to_abs = self.abspath(to_name)
1036
if not isdir(to_abs):
1037
raise BzrError("destination %r is not a directory" % to_abs)
1038
if not tree.has_filename(to_name):
1039
raise BzrError("destination %r not in working directory" % to_abs)
1040
to_dir_id = inv.path2id(to_name)
1041
if to_dir_id == None and to_name != '':
1042
raise BzrError("destination %r is not a versioned directory" % to_name)
1043
to_dir_ie = inv[to_dir_id]
1044
if to_dir_ie.kind not in ('directory', 'root_directory'):
1045
raise BzrError("destination %r is not a directory" % to_abs)
1047
to_idpath = inv.get_idpath(to_dir_id)
1049
for f in from_paths:
1050
if not tree.has_filename(f):
1051
raise BzrError("%r does not exist in working tree" % f)
1052
f_id = inv.path2id(f)
1054
raise BzrError("%r is not versioned" % f)
1055
name_tail = splitpath(f)[-1]
1056
dest_path = appendpath(to_name, name_tail)
1057
if tree.has_filename(dest_path):
1058
raise BzrError("destination %r already exists" % dest_path)
1059
if f_id in to_idpath:
1060
raise BzrError("can't move %r to a subdirectory of itself" % f)
1062
# OK, so there's a race here, it's possible that someone will
1063
# create a file in this interval and then the rename might be
1064
# left half-done. But we should have caught most problems.
1066
for f in from_paths:
1067
name_tail = splitpath(f)[-1]
1068
dest_path = appendpath(to_name, name_tail)
1069
result.append((f, dest_path))
1070
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1072
rename(self.abspath(f), self.abspath(dest_path))
1074
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1075
["rename rolled back"])
1077
self._write_inventory(inv)
1084
def revert(self, filenames, old_tree=None, backups=True):
1085
"""Restore selected files to the versions from a previous tree.
1088
If true (default) backups are made of files before
1091
from bzrlib.errors import NotVersionedError, BzrError
1092
from bzrlib.atomicfile import AtomicFile
1093
from bzrlib.osutils import backup_file
1095
inv = self.read_working_inventory()
1096
if old_tree is None:
1097
old_tree = self.basis_tree()
1098
old_inv = old_tree.inventory
1101
for fn in filenames:
1102
file_id = inv.path2id(fn)
1104
raise NotVersionedError("not a versioned file", fn)
1105
if not old_inv.has_id(file_id):
1106
raise BzrError("file not present in old tree", fn, file_id)
1107
nids.append((fn, file_id))
1109
# TODO: Rename back if it was previously at a different location
1111
# TODO: If given a directory, restore the entire contents from
1112
# the previous version.
1114
# TODO: Make a backup to a temporary file.
1116
# TODO: If the file previously didn't exist, delete it?
1117
for fn, file_id in nids:
1120
f = AtomicFile(fn, 'wb')
1122
f.write(old_tree.get_file(file_id).read())
1128
def pending_merges(self):
1129
"""Return a list of pending merges.
1131
These are revisions that have been merged into the working
1132
directory but not yet committed.
1134
cfn = self.controlfilename('pending-merges')
1135
if not os.path.exists(cfn):
1138
for l in self.controlfile('pending-merges', 'r').readlines():
1139
p.append(l.rstrip('\n'))
1143
def add_pending_merge(self, revision_id):
1144
validate_revision_id(revision_id)
1145
# TODO: Perhaps should check at this point that the
1146
# history of the revision is actually present?
1147
p = self.pending_merges()
1148
if revision_id in p:
1150
p.append(revision_id)
1151
self.set_pending_merges(p)
1154
def set_pending_merges(self, rev_list):
1155
from bzrlib.atomicfile import AtomicFile
1158
f = AtomicFile(self.controlfilename('pending-merges'))
1169
def get_parent(self):
1170
"""Return the parent location of the branch.
1172
This is the default location for push/pull/missing. The usual
1173
pattern is that the user can override it by specifying a
1177
_locs = ['parent', 'pull', 'x-pull']
1180
return self.controlfile(l, 'r').read().strip('\n')
1182
if e.errno != errno.ENOENT:
1187
def set_parent(self, url):
1188
# TODO: Maybe delete old location files?
1189
from bzrlib.atomicfile import AtomicFile
1192
f = AtomicFile(self.controlfilename('parent'))
1201
def check_revno(self, revno):
1203
Check whether a revno corresponds to any revision.
1204
Zero (the NULL revision) is considered valid.
1207
self.check_real_revno(revno)
1209
def check_real_revno(self, revno):
1211
Check whether a revno corresponds to a real revision.
1212
Zero (the NULL revision) is considered invalid
1214
if revno < 1 or revno > self.revno():
1215
raise InvalidRevisionNumber(revno)
1221
class ScratchBranch(LocalBranch):
1222
"""Special test class: a branch that cleans up after itself.
1224
>>> b = ScratchBranch()
1232
def __init__(self, files=[], dirs=[], base=None):
1233
"""Make a test branch.
1235
This creates a temporary directory and runs init-tree in it.
1237
If any files are listed, they are created in the working copy.
1239
from tempfile import mkdtemp
1244
LocalBranch.__init__(self, base, init=init)
1246
os.mkdir(self.abspath(d))
1249
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1254
>>> orig = ScratchBranch(files=["file1", "file2"])
1255
>>> clone = orig.clone()
1256
>>> if os.name != 'nt':
1257
... os.path.samefile(orig.base, clone.base)
1259
... orig.base == clone.base
1262
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1265
from shutil import copytree
1266
from tempfile import mkdtemp
1269
copytree(self.base, base, symlinks=True)
1270
return ScratchBranch(base=base)
1278
"""Destroy the test branch, removing the scratch directory."""
1279
from shutil import rmtree
1282
mutter("delete ScratchBranch %s" % self.base)
1285
# Work around for shutil.rmtree failing on Windows when
1286
# readonly files are encountered
1287
mutter("hit exception in destroying ScratchBranch: %s" % e)
1288
for root, dirs, files in os.walk(self.base, topdown=False):
1290
os.chmod(os.path.join(root, name), 0700)
1296
######################################################################
1300
def is_control_file(filename):
1301
## FIXME: better check
1302
filename = os.path.normpath(filename)
1303
while filename != '':
1304
head, tail = os.path.split(filename)
1305
## mutter('check %r for control file' % ((head, tail), ))
1306
if tail == bzrlib.BZRDIR:
1308
if filename == head:
1315
def gen_file_id(name):
1316
"""Return new file id.
1318
This should probably generate proper UUIDs, but for the moment we
1319
cope with just randomness because running uuidgen every time is
1322
from binascii import hexlify
1323
from time import time
1325
# get last component
1326
idx = name.rfind('/')
1328
name = name[idx+1 : ]
1329
idx = name.rfind('\\')
1331
name = name[idx+1 : ]
1333
# make it not a hidden file
1334
name = name.lstrip('.')
1336
# remove any wierd characters; we don't escape them but rather
1337
# just pull them out
1338
name = re.sub(r'[^\w.]', '', name)
1340
s = hexlify(rand_bytes(8))
1341
return '-'.join((name, compact_date(time()), s))
1345
"""Return a new tree-root file id."""
1346
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
