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')
136
"""Open an existing branch, rooted at 'base' (url)"""
137
if base and (base.startswith('http://') or base.startswith('https://')):
138
from bzrlib.remotebranch import RemoteBranch
139
return RemoteBranch(base, find_root=False)
141
return LocalBranch(base, find_root=False)
144
def open_containing(url):
145
"""Open an existing branch which contains url.
147
This probes for a branch at url, and searches upwards from there.
149
if url and (url.startswith('http://') or url.startswith('https://')):
150
from bzrlib.remotebranch import RemoteBranch
151
return RemoteBranch(url)
153
return LocalBranch(url)
156
def initialize(base):
157
"""Create a new branch, rooted at 'base' (url)"""
158
if base and (base.startswith('http://') or base.startswith('https://')):
159
from bzrlib.remotebranch import RemoteBranch
160
return RemoteBranch(base, init=True)
162
return LocalBranch(base, init=True)
164
def setup_caching(self, cache_root):
165
"""Subclasses that care about caching should override this, and set
166
up cached stores located under cache_root.
170
class LocalBranch(Branch):
171
"""A branch stored in the actual filesystem.
173
Note that it's "local" in the context of the filesystem; it doesn't
174
really matter if it's on an nfs/smb/afs/coda/... share, as long as
175
it's writable, and can be accessed via the normal filesystem API.
181
If _lock_mode is true, a positive count of the number of times the
185
Lock object from bzrlib.lock.
187
# We actually expect this class to be somewhat short-lived; part of its
188
# purpose is to try to isolate what bits of the branch logic are tied to
189
# filesystem access, so that in a later step, we can extricate them to
190
# a separarte ("storage") class.
194
_inventory_weave = None
196
# Map some sort of prefix into a namespace
197
# stuff like "revno:10", "revid:", etc.
198
# This should match a prefix with a function which accepts
199
REVISION_NAMESPACES = {}
201
def push_stores(self, branch_to):
202
"""Copy the content of this branches store to branch_to."""
203
if (self._branch_format != branch_to._branch_format
204
or self._branch_format != 4):
205
from bzrlib.fetch import greedy_fetch
206
mutter("falling back to fetch logic to push between %s and %s",
208
greedy_fetch(to_branch=branch_to, from_branch=self,
209
revision=self.last_revision())
212
store_pairs = ((self.text_store, branch_to.text_store),
213
(self.inventory_store, branch_to.inventory_store),
214
(self.revision_store, branch_to.revision_store))
216
for from_store, to_store in store_pairs:
217
copy_all(from_store, to_store)
218
except UnlistableStore:
219
raise UnlistableBranch(from_store)
221
def __init__(self, base, init=False, find_root=True,
222
relax_version_check=False):
223
"""Create new branch object at a particular location.
225
base -- Base directory for the branch. May be a file:// url.
227
init -- If True, create new control files in a previously
228
unversioned directory. If False, the branch must already
231
find_root -- If true and init is false, find the root of the
232
existing branch containing base.
234
relax_version_check -- If true, the usual check for the branch
235
version is not applied. This is intended only for
236
upgrade/recovery type use; it's not guaranteed that
237
all operations will work on old format branches.
239
In the test suite, creation of new trees is tested using the
240
`ScratchBranch` class.
243
self.base = os.path.realpath(base)
246
self.base = find_branch_root(base)
248
if base.startswith("file://"):
250
self.base = os.path.realpath(base)
251
if not isdir(self.controlfilename('.')):
252
raise NotBranchError('not a bzr branch: %s' % quotefn(base),
253
['use "bzr init" to initialize a '
255
self._check_format(relax_version_check)
256
cfn = self.controlfilename
257
if self._branch_format == 4:
258
self.inventory_store = ImmutableStore(cfn('inventory-store'))
259
self.text_store = ImmutableStore(cfn('text-store'))
260
elif self._branch_format == 5:
261
self.control_weaves = WeaveStore(cfn([]))
262
self.weave_store = WeaveStore(cfn('weaves'))
264
# FIXME: Unify with make_control_files
265
self.control_weaves.put_empty_weave('inventory')
266
self.control_weaves.put_empty_weave('ancestry')
267
self.revision_store = ImmutableStore(cfn('revision-store'))
271
return '%s(%r)' % (self.__class__.__name__, self.base)
278
if self._lock_mode or self._lock:
279
# XXX: This should show something every time, and be suitable for
280
# headless operation and embedding
281
warn("branch %r was not explicitly unlocked" % self)
284
def lock_write(self):
286
if self._lock_mode != 'w':
287
raise LockError("can't upgrade to a write lock from %r" %
289
self._lock_count += 1
291
from bzrlib.lock import WriteLock
293
self._lock = WriteLock(self.controlfilename('branch-lock'))
294
self._lock_mode = 'w'
300
assert self._lock_mode in ('r', 'w'), \
301
"invalid lock mode %r" % self._lock_mode
302
self._lock_count += 1
304
from bzrlib.lock import ReadLock
306
self._lock = ReadLock(self.controlfilename('branch-lock'))
307
self._lock_mode = 'r'
311
if not self._lock_mode:
312
raise LockError('branch %r is not locked' % (self))
314
if self._lock_count > 1:
315
self._lock_count -= 1
319
self._lock_mode = self._lock_count = None
321
def abspath(self, name):
322
"""Return absolute filename for something in the branch"""
323
return os.path.join(self.base, name)
325
def relpath(self, path):
326
"""Return path relative to this branch of something inside it.
328
Raises an error if path is not in this branch."""
329
return _relpath(self.base, path)
331
def controlfilename(self, file_or_path):
332
"""Return location relative to branch."""
333
if isinstance(file_or_path, basestring):
334
file_or_path = [file_or_path]
335
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
338
def controlfile(self, file_or_path, mode='r'):
339
"""Open a control file for this branch.
341
There are two classes of file in the control directory: text
342
and binary. binary files are untranslated byte streams. Text
343
control files are stored with Unix newlines and in UTF-8, even
344
if the platform or locale defaults are different.
346
Controlfiles should almost never be opened in write mode but
347
rather should be atomically copied and replaced using atomicfile.
350
fn = self.controlfilename(file_or_path)
352
if mode == 'rb' or mode == 'wb':
353
return file(fn, mode)
354
elif mode == 'r' or mode == 'w':
355
# open in binary mode anyhow so there's no newline translation;
356
# codecs uses line buffering by default; don't want that.
358
return codecs.open(fn, mode + 'b', 'utf-8',
361
raise BzrError("invalid controlfile mode %r" % mode)
363
def _make_control(self):
364
os.mkdir(self.controlfilename([]))
365
self.controlfile('README', 'w').write(
366
"This is a Bazaar-NG control directory.\n"
367
"Do not change any files in this directory.\n")
368
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
369
for d in ('text-store', 'revision-store',
371
os.mkdir(self.controlfilename(d))
372
for f in ('revision-history',
376
self.controlfile(f, 'w').write('')
377
mutter('created control directory in ' + self.base)
379
# if we want per-tree root ids then this is the place to set
380
# them; they're not needed for now and so ommitted for
382
f = self.controlfile('inventory','w')
383
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
386
def _check_format(self, relax_version_check):
387
"""Check this branch format is supported.
389
The format level is stored, as an integer, in
390
self._branch_format for code that needs to check it later.
392
In the future, we might need different in-memory Branch
393
classes to support downlevel branches. But not yet.
396
fmt = self.controlfile('branch-format', 'r').read()
398
if e.errno == errno.ENOENT:
399
raise NotBranchError(self.base)
403
if fmt == BZR_BRANCH_FORMAT_5:
404
self._branch_format = 5
405
elif fmt == BZR_BRANCH_FORMAT_4:
406
self._branch_format = 4
408
if (not relax_version_check
409
and self._branch_format != 5):
410
raise BzrError('sorry, branch format %r not supported' % fmt,
411
['use a different bzr version',
412
'or remove the .bzr directory and "bzr init" again'])
414
def get_root_id(self):
415
"""Return the id of this branches root"""
416
inv = self.read_working_inventory()
417
return inv.root.file_id
419
def set_root_id(self, file_id):
420
inv = self.read_working_inventory()
421
orig_root_id = inv.root.file_id
422
del inv._byid[inv.root.file_id]
423
inv.root.file_id = file_id
424
inv._byid[inv.root.file_id] = inv.root
427
if entry.parent_id in (None, orig_root_id):
428
entry.parent_id = inv.root.file_id
429
self._write_inventory(inv)
431
def read_working_inventory(self):
432
"""Read the working inventory."""
435
# ElementTree does its own conversion from UTF-8, so open in
437
f = self.controlfile('inventory', 'rb')
438
return bzrlib.xml5.serializer_v5.read_inventory(f)
443
def _write_inventory(self, inv):
444
"""Update the working inventory.
446
That is to say, the inventory describing changes underway, that
447
will be committed to the next revision.
449
from bzrlib.atomicfile import AtomicFile
453
f = AtomicFile(self.controlfilename('inventory'), 'wb')
455
bzrlib.xml5.serializer_v5.write_inventory(inv, f)
462
mutter('wrote working inventory')
465
inventory = property(read_working_inventory, _write_inventory, None,
466
"""Inventory for the working copy.""")
469
def add(self, files, ids=None):
470
"""Make files versioned.
472
Note that the command line normally calls smart_add instead,
473
which can automatically recurse.
475
This puts the files in the Added state, so that they will be
476
recorded by the next commit.
479
List of paths to add, relative to the base of the tree.
482
If set, use these instead of automatically generated ids.
483
Must be the same length as the list of files, but may
484
contain None for ids that are to be autogenerated.
486
TODO: Perhaps have an option to add the ids even if the files do
489
TODO: Perhaps yield the ids and paths as they're added.
491
# TODO: Re-adding a file that is removed in the working copy
492
# should probably put it back with the previous ID.
493
if isinstance(files, basestring):
494
assert(ids is None or isinstance(ids, basestring))
500
ids = [None] * len(files)
502
assert(len(ids) == len(files))
506
inv = self.read_working_inventory()
507
for f,file_id in zip(files, ids):
508
if is_control_file(f):
509
raise BzrError("cannot add control file %s" % quotefn(f))
514
raise BzrError("cannot add top-level %r" % f)
516
fullpath = os.path.normpath(self.abspath(f))
519
kind = file_kind(fullpath)
521
# maybe something better?
522
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
524
if kind != 'file' and kind != 'directory':
525
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
528
file_id = gen_file_id(f)
529
inv.add_path(f, kind=kind, file_id=file_id)
531
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
533
self._write_inventory(inv)
538
def print_file(self, file, revno):
539
"""Print `file` to stdout."""
542
tree = self.revision_tree(self.get_rev_id(revno))
543
# use inventory as it was in that revision
544
file_id = tree.inventory.path2id(file)
546
raise BzrError("%r is not present in revision %s" % (file, revno))
547
tree.print_file(file_id)
552
def remove(self, files, verbose=False):
553
"""Mark nominated files for removal from the inventory.
555
This does not remove their text. This does not run on
557
TODO: Refuse to remove modified files unless --force is given?
559
TODO: Do something useful with directories.
561
TODO: Should this remove the text or not? Tough call; not
562
removing may be useful and the user can just use use rm, and
563
is the opposite of add. Removing it is consistent with most
564
other tools. Maybe an option.
566
## TODO: Normalize names
567
## TODO: Remove nested loops; better scalability
568
if isinstance(files, basestring):
574
tree = self.working_tree()
577
# do this before any modifications
581
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
582
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
584
# having remove it, it must be either ignored or unknown
585
if tree.is_ignored(f):
589
show_status(new_status, inv[fid].kind, quotefn(f))
592
self._write_inventory(inv)
597
# FIXME: this doesn't need to be a branch method
598
def set_inventory(self, new_inventory_list):
599
from bzrlib.inventory import Inventory, InventoryEntry
600
inv = Inventory(self.get_root_id())
601
for path, file_id, parent, kind in new_inventory_list:
602
name = os.path.basename(path)
605
inv.add(InventoryEntry(file_id, name, kind, parent))
606
self._write_inventory(inv)
610
"""Return all unknown files.
612
These are files in the working directory that are not versioned or
613
control files or ignored.
615
>>> b = ScratchBranch(files=['foo', 'foo~'])
616
>>> list(b.unknowns())
619
>>> list(b.unknowns())
622
>>> list(b.unknowns())
625
return self.working_tree().unknowns()
628
def append_revision(self, *revision_ids):
629
from bzrlib.atomicfile import AtomicFile
631
for revision_id in revision_ids:
632
mutter("add {%s} to revision-history" % revision_id)
634
rev_history = self.revision_history()
635
rev_history.extend(revision_ids)
637
f = AtomicFile(self.controlfilename('revision-history'))
639
for rev_id in rev_history:
646
def has_revision(self, revision_id):
647
"""True if this branch has a copy of the revision.
649
This does not necessarily imply the revision is merge
650
or on the mainline."""
651
return (revision_id is None
652
or revision_id in self.revision_store)
655
def get_revision_xml_file(self, revision_id):
656
"""Return XML file object for revision object."""
657
if not revision_id or not isinstance(revision_id, basestring):
658
raise InvalidRevisionId(revision_id)
663
return self.revision_store[revision_id]
664
except (IndexError, KeyError):
665
raise bzrlib.errors.NoSuchRevision(self, revision_id)
670
def get_revision_xml(self, revision_id):
671
return self.get_revision_xml_file(revision_id).read()
674
def get_revision(self, revision_id):
675
"""Return the Revision object for a named revision"""
676
xml_file = self.get_revision_xml_file(revision_id)
679
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
680
except SyntaxError, e:
681
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
685
assert r.revision_id == revision_id
689
def get_revision_delta(self, revno):
690
"""Return the delta for one revision.
692
The delta is relative to its mainline predecessor, or the
693
empty tree for revision 1.
695
assert isinstance(revno, int)
696
rh = self.revision_history()
697
if not (1 <= revno <= len(rh)):
698
raise InvalidRevisionNumber(revno)
700
# revno is 1-based; list is 0-based
702
new_tree = self.revision_tree(rh[revno-1])
704
old_tree = EmptyTree()
706
old_tree = self.revision_tree(rh[revno-2])
708
return compare_trees(old_tree, new_tree)
711
def get_revision_sha1(self, revision_id):
712
"""Hash the stored value of a revision, and return it."""
713
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
716
def _get_ancestry_weave(self):
717
return self.control_weaves.get_weave('ancestry')
720
def get_ancestry(self, revision_id):
721
"""Return a list of revision-ids integrated by a revision.
724
if revision_id is None:
726
w = self._get_ancestry_weave()
727
return [None] + [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
730
def get_inventory_weave(self):
731
return self.control_weaves.get_weave('inventory')
734
def get_inventory(self, revision_id):
735
"""Get Inventory object by hash."""
736
xml = self.get_inventory_xml(revision_id)
737
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
740
def get_inventory_xml(self, revision_id):
741
"""Get inventory XML as a file object."""
743
assert isinstance(revision_id, basestring), type(revision_id)
744
iw = self.get_inventory_weave()
745
return iw.get_text(iw.lookup(revision_id))
747
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
750
def get_inventory_sha1(self, revision_id):
751
"""Return the sha1 hash of the inventory entry
753
return self.get_revision(revision_id).inventory_sha1
756
def get_revision_inventory(self, revision_id):
757
"""Return inventory of a past revision."""
758
# TODO: Unify this with get_inventory()
759
# bzr 0.0.6 and later imposes the constraint that the inventory_id
760
# must be the same as its revision, so this is trivial.
761
if revision_id == None:
762
return Inventory(self.get_root_id())
764
return self.get_inventory(revision_id)
767
def revision_history(self):
768
"""Return sequence of revision hashes on to this branch."""
771
return [l.rstrip('\r\n') for l in
772
self.controlfile('revision-history', 'r').readlines()]
777
def common_ancestor(self, other, self_revno=None, other_revno=None):
779
>>> from bzrlib.commit import commit
780
>>> sb = ScratchBranch(files=['foo', 'foo~'])
781
>>> sb.common_ancestor(sb) == (None, None)
783
>>> commit(sb, "Committing first revision", verbose=False)
784
>>> sb.common_ancestor(sb)[0]
786
>>> clone = sb.clone()
787
>>> commit(sb, "Committing second revision", verbose=False)
788
>>> sb.common_ancestor(sb)[0]
790
>>> sb.common_ancestor(clone)[0]
792
>>> commit(clone, "Committing divergent second revision",
794
>>> sb.common_ancestor(clone)[0]
796
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
798
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
800
>>> clone2 = sb.clone()
801
>>> sb.common_ancestor(clone2)[0]
803
>>> sb.common_ancestor(clone2, self_revno=1)[0]
805
>>> sb.common_ancestor(clone2, other_revno=1)[0]
808
my_history = self.revision_history()
809
other_history = other.revision_history()
810
if self_revno is None:
811
self_revno = len(my_history)
812
if other_revno is None:
813
other_revno = len(other_history)
814
indices = range(min((self_revno, other_revno)))
817
if my_history[r] == other_history[r]:
818
return r+1, my_history[r]
823
"""Return current revision number for this branch.
825
That is equivalent to the number of revisions committed to
828
return len(self.revision_history())
831
def last_revision(self):
832
"""Return last patch hash, or None if no history.
834
ph = self.revision_history()
841
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
842
"""Return a list of new revisions that would perfectly fit.
844
If self and other have not diverged, return a list of the revisions
845
present in other, but missing from self.
847
>>> from bzrlib.commit import commit
848
>>> bzrlib.trace.silent = True
849
>>> br1 = ScratchBranch()
850
>>> br2 = ScratchBranch()
851
>>> br1.missing_revisions(br2)
853
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
854
>>> br1.missing_revisions(br2)
856
>>> br2.missing_revisions(br1)
858
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
859
>>> br1.missing_revisions(br2)
861
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
862
>>> br1.missing_revisions(br2)
864
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
865
>>> br1.missing_revisions(br2)
866
Traceback (most recent call last):
867
DivergedBranches: These branches have diverged.
869
# FIXME: If the branches have diverged, but the latest
870
# revision in this branch is completely merged into the other,
871
# then we should still be able to pull.
872
self_history = self.revision_history()
873
self_len = len(self_history)
874
other_history = other.revision_history()
875
other_len = len(other_history)
876
common_index = min(self_len, other_len) -1
877
if common_index >= 0 and \
878
self_history[common_index] != other_history[common_index]:
879
raise DivergedBranches(self, other)
881
if stop_revision is None:
882
stop_revision = other_len
884
assert isinstance(stop_revision, int)
885
if stop_revision > other_len:
886
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
887
return other_history[self_len:stop_revision]
889
def update_revisions(self, other, stop_revision=None):
890
"""Pull in new perfect-fit revisions."""
891
from bzrlib.fetch import greedy_fetch
892
from bzrlib.revision import get_intervening_revisions
893
if stop_revision is None:
894
stop_revision = other.last_revision()
895
greedy_fetch(to_branch=self, from_branch=other,
896
revision=stop_revision)
897
pullable_revs = self.missing_revisions(
898
other, other.revision_id_to_revno(stop_revision))
900
greedy_fetch(to_branch=self,
902
revision=pullable_revs[-1])
903
self.append_revision(*pullable_revs)
906
def commit(self, *args, **kw):
907
from bzrlib.commit import Commit
908
Commit().commit(self, *args, **kw)
910
def revision_id_to_revno(self, revision_id):
911
"""Given a revision id, return its revno"""
912
if revision_id is None:
914
history = self.revision_history()
916
return history.index(revision_id) + 1
918
raise bzrlib.errors.NoSuchRevision(self, revision_id)
920
def get_rev_id(self, revno, history=None):
921
"""Find the revision id of the specified revno."""
925
history = self.revision_history()
926
elif revno <= 0 or revno > len(history):
927
raise bzrlib.errors.NoSuchRevision(self, revno)
928
return history[revno - 1]
930
def revision_tree(self, revision_id):
931
"""Return Tree for a revision on this branch.
933
`revision_id` may be None for the null revision, in which case
934
an `EmptyTree` is returned."""
935
# TODO: refactor this to use an existing revision object
936
# so we don't need to read it in twice.
937
if revision_id == None:
940
inv = self.get_revision_inventory(revision_id)
941
return RevisionTree(self.weave_store, inv, revision_id)
944
def working_tree(self):
945
"""Return a `Tree` for the working copy."""
946
from bzrlib.workingtree import WorkingTree
947
return WorkingTree(self.base, self.read_working_inventory())
950
def basis_tree(self):
951
"""Return `Tree` object for last revision.
953
If there are no revisions yet, return an `EmptyTree`.
955
return self.revision_tree(self.last_revision())
958
def rename_one(self, from_rel, to_rel):
961
This can change the directory or the filename or both.
965
tree = self.working_tree()
967
if not tree.has_filename(from_rel):
968
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
969
if tree.has_filename(to_rel):
970
raise BzrError("can't rename: new working file %r already exists" % to_rel)
972
file_id = inv.path2id(from_rel)
974
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
976
if inv.path2id(to_rel):
977
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
979
to_dir, to_tail = os.path.split(to_rel)
980
to_dir_id = inv.path2id(to_dir)
981
if to_dir_id == None and to_dir != '':
982
raise BzrError("can't determine destination directory id for %r" % to_dir)
984
mutter("rename_one:")
985
mutter(" file_id {%s}" % file_id)
986
mutter(" from_rel %r" % from_rel)
987
mutter(" to_rel %r" % to_rel)
988
mutter(" to_dir %r" % to_dir)
989
mutter(" to_dir_id {%s}" % to_dir_id)
991
inv.rename(file_id, to_dir_id, to_tail)
993
from_abs = self.abspath(from_rel)
994
to_abs = self.abspath(to_rel)
996
rename(from_abs, to_abs)
998
raise BzrError("failed to rename %r to %r: %s"
999
% (from_abs, to_abs, e[1]),
1000
["rename rolled back"])
1002
self._write_inventory(inv)
1007
def move(self, from_paths, to_name):
1010
to_name must exist as a versioned directory.
1012
If to_name exists and is a directory, the files are moved into
1013
it, keeping their old names. If it is a directory,
1015
Note that to_name is only the last component of the new name;
1016
this doesn't change the directory.
1018
This returns a list of (from_path, to_path) pairs for each
1019
entry that is moved.
1024
## TODO: Option to move IDs only
1025
assert not isinstance(from_paths, basestring)
1026
tree = self.working_tree()
1027
inv = tree.inventory
1028
to_abs = self.abspath(to_name)
1029
if not isdir(to_abs):
1030
raise BzrError("destination %r is not a directory" % to_abs)
1031
if not tree.has_filename(to_name):
1032
raise BzrError("destination %r not in working directory" % to_abs)
1033
to_dir_id = inv.path2id(to_name)
1034
if to_dir_id == None and to_name != '':
1035
raise BzrError("destination %r is not a versioned directory" % to_name)
1036
to_dir_ie = inv[to_dir_id]
1037
if to_dir_ie.kind not in ('directory', 'root_directory'):
1038
raise BzrError("destination %r is not a directory" % to_abs)
1040
to_idpath = inv.get_idpath(to_dir_id)
1042
for f in from_paths:
1043
if not tree.has_filename(f):
1044
raise BzrError("%r does not exist in working tree" % f)
1045
f_id = inv.path2id(f)
1047
raise BzrError("%r is not versioned" % f)
1048
name_tail = splitpath(f)[-1]
1049
dest_path = appendpath(to_name, name_tail)
1050
if tree.has_filename(dest_path):
1051
raise BzrError("destination %r already exists" % dest_path)
1052
if f_id in to_idpath:
1053
raise BzrError("can't move %r to a subdirectory of itself" % f)
1055
# OK, so there's a race here, it's possible that someone will
1056
# create a file in this interval and then the rename might be
1057
# left half-done. But we should have caught most problems.
1059
for f in from_paths:
1060
name_tail = splitpath(f)[-1]
1061
dest_path = appendpath(to_name, name_tail)
1062
result.append((f, dest_path))
1063
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1065
rename(self.abspath(f), self.abspath(dest_path))
1067
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1068
["rename rolled back"])
1070
self._write_inventory(inv)
1077
def revert(self, filenames, old_tree=None, backups=True):
1078
"""Restore selected files to the versions from a previous tree.
1081
If true (default) backups are made of files before
1084
from bzrlib.errors import NotVersionedError, BzrError
1085
from bzrlib.atomicfile import AtomicFile
1086
from bzrlib.osutils import backup_file
1088
inv = self.read_working_inventory()
1089
if old_tree is None:
1090
old_tree = self.basis_tree()
1091
old_inv = old_tree.inventory
1094
for fn in filenames:
1095
file_id = inv.path2id(fn)
1097
raise NotVersionedError("not a versioned file", fn)
1098
if not old_inv.has_id(file_id):
1099
raise BzrError("file not present in old tree", fn, file_id)
1100
nids.append((fn, file_id))
1102
# TODO: Rename back if it was previously at a different location
1104
# TODO: If given a directory, restore the entire contents from
1105
# the previous version.
1107
# TODO: Make a backup to a temporary file.
1109
# TODO: If the file previously didn't exist, delete it?
1110
for fn, file_id in nids:
1113
f = AtomicFile(fn, 'wb')
1115
f.write(old_tree.get_file(file_id).read())
1121
def pending_merges(self):
1122
"""Return a list of pending merges.
1124
These are revisions that have been merged into the working
1125
directory but not yet committed.
1127
cfn = self.controlfilename('pending-merges')
1128
if not os.path.exists(cfn):
1131
for l in self.controlfile('pending-merges', 'r').readlines():
1132
p.append(l.rstrip('\n'))
1136
def add_pending_merge(self, revision_id):
1137
validate_revision_id(revision_id)
1138
# TODO: Perhaps should check at this point that the
1139
# history of the revision is actually present?
1140
p = self.pending_merges()
1141
if revision_id in p:
1143
p.append(revision_id)
1144
self.set_pending_merges(p)
1147
def set_pending_merges(self, rev_list):
1148
from bzrlib.atomicfile import AtomicFile
1151
f = AtomicFile(self.controlfilename('pending-merges'))
1162
def get_parent(self):
1163
"""Return the parent location of the branch.
1165
This is the default location for push/pull/missing. The usual
1166
pattern is that the user can override it by specifying a
1170
_locs = ['parent', 'pull', 'x-pull']
1173
return self.controlfile(l, 'r').read().strip('\n')
1175
if e.errno != errno.ENOENT:
1180
def set_parent(self, url):
1181
# TODO: Maybe delete old location files?
1182
from bzrlib.atomicfile import AtomicFile
1185
f = AtomicFile(self.controlfilename('parent'))
1194
def check_revno(self, revno):
1196
Check whether a revno corresponds to any revision.
1197
Zero (the NULL revision) is considered valid.
1200
self.check_real_revno(revno)
1202
def check_real_revno(self, revno):
1204
Check whether a revno corresponds to a real revision.
1205
Zero (the NULL revision) is considered invalid
1207
if revno < 1 or revno > self.revno():
1208
raise InvalidRevisionNumber(revno)
1214
class ScratchBranch(LocalBranch):
1215
"""Special test class: a branch that cleans up after itself.
1217
>>> b = ScratchBranch()
1225
def __init__(self, files=[], dirs=[], base=None):
1226
"""Make a test branch.
1228
This creates a temporary directory and runs init-tree in it.
1230
If any files are listed, they are created in the working copy.
1232
from tempfile import mkdtemp
1237
LocalBranch.__init__(self, base, init=init)
1239
os.mkdir(self.abspath(d))
1242
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1247
>>> orig = ScratchBranch(files=["file1", "file2"])
1248
>>> clone = orig.clone()
1249
>>> if os.name != 'nt':
1250
... os.path.samefile(orig.base, clone.base)
1252
... orig.base == clone.base
1255
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1258
from shutil import copytree
1259
from tempfile import mkdtemp
1262
copytree(self.base, base, symlinks=True)
1263
return ScratchBranch(base=base)
1271
"""Destroy the test branch, removing the scratch directory."""
1272
from shutil import rmtree
1275
mutter("delete ScratchBranch %s" % self.base)
1278
# Work around for shutil.rmtree failing on Windows when
1279
# readonly files are encountered
1280
mutter("hit exception in destroying ScratchBranch: %s" % e)
1281
for root, dirs, files in os.walk(self.base, topdown=False):
1283
os.chmod(os.path.join(root, name), 0700)
1289
######################################################################
1293
def is_control_file(filename):
1294
## FIXME: better check
1295
filename = os.path.normpath(filename)
1296
while filename != '':
1297
head, tail = os.path.split(filename)
1298
## mutter('check %r for control file' % ((head, tail), ))
1299
if tail == bzrlib.BZRDIR:
1301
if filename == head:
1308
def gen_file_id(name):
1309
"""Return new file id.
1311
This should probably generate proper UUIDs, but for the moment we
1312
cope with just randomness because running uuidgen every time is
1315
from binascii import hexlify
1316
from time import time
1318
# get last component
1319
idx = name.rfind('/')
1321
name = name[idx+1 : ]
1322
idx = name.rfind('\\')
1324
name = name[idx+1 : ]
1326
# make it not a hidden file
1327
name = name.lstrip('.')
1329
# remove any wierd characters; we don't escape them but rather
1330
# just pull them out
1331
name = re.sub(r'[^\w.]', '', name)
1333
s = hexlify(rand_bytes(8))
1334
return '-'.join((name, compact_date(time()), s))
1338
"""Return a new tree-root file id."""
1339
return gen_file_id('TREE_ROOT')
1342
def copy_branch(branch_from, to_location, revision=None, basis_branch=None):
1343
"""Copy branch_from into the existing directory to_location.
1346
If not None, only revisions up to this point will be copied.
1347
The head of the new branch will be that revision. Must be a
1351
The name of a local directory that exists but is empty.
1354
The revision to copy up to
1357
A local branch to copy revisions from, related to branch_from
1359
# TODO: This could be done *much* more efficiently by just copying
1360
# all the whole weaves and revisions, rather than getting one
1361
# revision at a time.
1362
from bzrlib.merge import merge
1364
assert isinstance(branch_from, Branch)
1365
assert isinstance(to_location, basestring)
1367
br_to = Branch.initialize(to_location)
1368
if basis_branch is not None:
1369
basis_branch.push_stores(br_to)
1370
br_to.set_root_id(branch_from.get_root_id())
1371
if revision is None:
1372
revision = branch_from.last_revision()
1373
br_to.update_revisions(branch_from, stop_revision=revision)
1374
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1375
check_clean=False, ignore_zero=True)
1376
br_to.set_parent(branch_from.base)
added
removed
bzrlib/branch.py
