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
22
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
25
sha_file, appendpath, file_kind
27
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId, \
28
DivergedBranches, NotBranchError
29
from bzrlib.textui import show_status
30
from bzrlib.revision import Revision
31
from bzrlib.delta import compare_trees
32
from bzrlib.tree import EmptyTree, RevisionTree
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
## TODO: Maybe include checks for common corruption of newlines, etc?
42
# TODO: Some operations like log might retrieve the same revisions
43
# repeatedly to calculate deltas. We could perhaps have a weakref
44
# cache in memory to make this faster.
46
def find_branch(*ignored, **ignored_too):
47
# XXX: leave this here for about one release, then remove it
48
raise NotImplementedError('find_branch() is not supported anymore, '
49
'please use one of the new branch constructors')
51
def _relpath(base, path):
52
"""Return path relative to base, or raise exception.
54
The path may be either an absolute path or a path relative to the
55
current working directory.
57
Lifted out of Branch.relpath for ease of testing.
59
os.path.commonprefix (python2.4) has a bad bug that it works just
60
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
61
avoids that problem."""
62
rp = os.path.abspath(path)
66
while len(head) >= len(base):
69
head, tail = os.path.split(head)
73
raise NotBranchError("path %r is not within branch %r" % (rp, base))
78
def find_branch_root(f=None):
79
"""Find the branch root enclosing f, or pwd.
81
f may be a filename or a URL.
83
It is not necessary that f exists.
85
Basically we keep looking up until we find the control directory or
86
run into the root. If there isn't one, raises NotBranchError.
90
elif hasattr(os.path, 'realpath'):
91
f = os.path.realpath(f)
93
f = os.path.abspath(f)
94
if not os.path.exists(f):
95
raise BzrError('%r does not exist' % f)
101
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
103
head, tail = os.path.split(f)
105
# reached the root, whatever that may be
106
raise NotBranchError('%s is not in a branch' % orig_f)
112
######################################################################
115
class Branch(object):
116
"""Branch holding a history of revisions.
119
Base directory/url of the branch.
123
def __init__(self, *ignored, **ignored_too):
124
raise NotImplementedError('The Branch class is abstract')
128
"""Open an existing branch, rooted at 'base' (url)"""
129
if base and (base.startswith('http://') or base.startswith('https://')):
130
from bzrlib.remotebranch import RemoteBranch
131
return RemoteBranch(base, find_root=False)
133
return LocalBranch(base, find_root=False)
136
def open_containing(url):
137
"""Open an existing branch, containing url (search upwards for the root)
139
if url and (url.startswith('http://') or url.startswith('https://')):
140
from bzrlib.remotebranch import RemoteBranch
141
return RemoteBranch(url)
143
return LocalBranch(url)
146
def initialize(base):
147
"""Create a new branch, rooted at 'base' (url)"""
148
if base and (base.startswith('http://') or base.startswith('https://')):
149
from bzrlib.remotebranch import RemoteBranch
150
return RemoteBranch(base, init=True)
152
return LocalBranch(base, init=True)
154
def setup_caching(self, cache_root):
155
"""Subclasses that care about caching should override this, and set
156
up cached stores located under cache_root.
160
class LocalBranch(Branch):
161
"""A branch stored in the actual filesystem.
163
Note that it's "local" in the context of the filesystem; it doesn't
164
really matter if it's on an nfs/smb/afs/coda/... share, as long as
165
it's writable, and can be accessed via the normal filesystem API.
171
If _lock_mode is true, a positive count of the number of times the
175
Lock object from bzrlib.lock.
177
# We actually expect this class to be somewhat short-lived; part of its
178
# purpose is to try to isolate what bits of the branch logic are tied to
179
# filesystem access, so that in a later step, we can extricate them to
180
# a separarte ("storage") class.
185
def __init__(self, base, init=False, find_root=True):
186
"""Create new branch object at a particular location.
188
base -- Base directory for the branch.
190
init -- If True, create new control files in a previously
191
unversioned directory. If False, the branch must already
194
find_root -- If true and init is false, find the root of the
195
existing branch containing base.
197
In the test suite, creation of new trees is tested using the
198
`ScratchBranch` class.
200
from bzrlib.store import ImmutableStore
202
self.base = os.path.realpath(base)
205
self.base = find_branch_root(base)
207
self.base = os.path.realpath(base)
208
if not isdir(self.controlfilename('.')):
209
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
210
['use "bzr init" to initialize a new working tree',
211
'current bzr can only operate from top-of-tree'])
214
self.text_store = ImmutableStore(self.controlfilename('text-store'))
215
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
216
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
220
return '%s(%r)' % (self.__class__.__name__, self.base)
227
if self._lock_mode or self._lock:
228
from bzrlib.warnings import warn
229
warn("branch %r was not explicitly unlocked" % self)
233
def lock_write(self):
235
if self._lock_mode != 'w':
236
from bzrlib.errors import LockError
237
raise LockError("can't upgrade to a write lock from %r" %
239
self._lock_count += 1
241
from bzrlib.lock import WriteLock
243
self._lock = WriteLock(self.controlfilename('branch-lock'))
244
self._lock_mode = 'w'
250
assert self._lock_mode in ('r', 'w'), \
251
"invalid lock mode %r" % self._lock_mode
252
self._lock_count += 1
254
from bzrlib.lock import ReadLock
256
self._lock = ReadLock(self.controlfilename('branch-lock'))
257
self._lock_mode = 'r'
261
if not self._lock_mode:
262
from bzrlib.errors import LockError
263
raise LockError('branch %r is not locked' % (self))
265
if self._lock_count > 1:
266
self._lock_count -= 1
270
self._lock_mode = self._lock_count = None
272
def abspath(self, name):
273
"""Return absolute filename for something in the branch"""
274
return os.path.join(self.base, name)
276
def relpath(self, path):
277
"""Return path relative to this branch of something inside it.
279
Raises an error if path is not in this branch."""
280
return _relpath(self.base, path)
282
def controlfilename(self, file_or_path):
283
"""Return location relative to branch."""
284
if isinstance(file_or_path, basestring):
285
file_or_path = [file_or_path]
286
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
289
def controlfile(self, file_or_path, mode='r'):
290
"""Open a control file for this branch.
292
There are two classes of file in the control directory: text
293
and binary. binary files are untranslated byte streams. Text
294
control files are stored with Unix newlines and in UTF-8, even
295
if the platform or locale defaults are different.
297
Controlfiles should almost never be opened in write mode but
298
rather should be atomically copied and replaced using atomicfile.
301
fn = self.controlfilename(file_or_path)
303
if mode == 'rb' or mode == 'wb':
304
return file(fn, mode)
305
elif mode == 'r' or mode == 'w':
306
# open in binary mode anyhow so there's no newline translation;
307
# codecs uses line buffering by default; don't want that.
309
return codecs.open(fn, mode + 'b', 'utf-8',
312
raise BzrError("invalid controlfile mode %r" % mode)
314
def _make_control(self):
315
from bzrlib.inventory import Inventory
317
os.mkdir(self.controlfilename([]))
318
self.controlfile('README', 'w').write(
319
"This is a Bazaar-NG control directory.\n"
320
"Do not change any files in this directory.\n")
321
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
322
for d in ('text-store', 'inventory-store', 'revision-store'):
323
os.mkdir(self.controlfilename(d))
324
for f in ('revision-history', 'merged-patches',
325
'pending-merged-patches', 'branch-name',
328
self.controlfile(f, 'w').write('')
329
mutter('created control directory in ' + self.base)
331
# if we want per-tree root ids then this is the place to set
332
# them; they're not needed for now and so ommitted for
334
f = self.controlfile('inventory','w')
335
bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
338
def _check_format(self):
339
"""Check this branch format is supported.
341
The current tool only supports the current unstable format.
343
In the future, we might need different in-memory Branch
344
classes to support downlevel branches. But not yet.
346
# This ignores newlines so that we can open branches created
347
# on Windows from Linux and so on. I think it might be better
348
# to always make all internal files in unix format.
349
fmt = self.controlfile('branch-format', 'r').read()
350
fmt = fmt.replace('\r\n', '\n')
351
if fmt != BZR_BRANCH_FORMAT:
352
raise BzrError('sorry, branch format %r not supported' % fmt,
353
['use a different bzr version',
354
'or remove the .bzr directory and "bzr init" again'])
356
def get_root_id(self):
357
"""Return the id of this branches root"""
358
inv = self.read_working_inventory()
359
return inv.root.file_id
361
def set_root_id(self, file_id):
362
inv = self.read_working_inventory()
363
orig_root_id = inv.root.file_id
364
del inv._byid[inv.root.file_id]
365
inv.root.file_id = file_id
366
inv._byid[inv.root.file_id] = inv.root
369
if entry.parent_id in (None, orig_root_id):
370
entry.parent_id = inv.root.file_id
371
self._write_inventory(inv)
373
def read_working_inventory(self):
374
"""Read the working inventory."""
375
from bzrlib.inventory import Inventory
378
# ElementTree does its own conversion from UTF-8, so open in
380
f = self.controlfile('inventory', 'rb')
381
return bzrlib.xml.serializer_v4.read_inventory(f)
386
def _write_inventory(self, inv):
387
"""Update the working inventory.
389
That is to say, the inventory describing changes underway, that
390
will be committed to the next revision.
392
from bzrlib.atomicfile import AtomicFile
396
f = AtomicFile(self.controlfilename('inventory'), 'wb')
398
bzrlib.xml.serializer_v4.write_inventory(inv, f)
405
mutter('wrote working inventory')
408
inventory = property(read_working_inventory, _write_inventory, None,
409
"""Inventory for the working copy.""")
412
def add(self, files, ids=None):
413
"""Make files versioned.
415
Note that the command line normally calls smart_add instead,
416
which can automatically recurse.
418
This puts the files in the Added state, so that they will be
419
recorded by the next commit.
422
List of paths to add, relative to the base of the tree.
425
If set, use these instead of automatically generated ids.
426
Must be the same length as the list of files, but may
427
contain None for ids that are to be autogenerated.
429
TODO: Perhaps have an option to add the ids even if the files do
432
TODO: Perhaps yield the ids and paths as they're added.
434
# TODO: Re-adding a file that is removed in the working copy
435
# should probably put it back with the previous ID.
436
if isinstance(files, basestring):
437
assert(ids is None or isinstance(ids, basestring))
443
ids = [None] * len(files)
445
assert(len(ids) == len(files))
449
inv = self.read_working_inventory()
450
for f,file_id in zip(files, ids):
451
if is_control_file(f):
452
raise BzrError("cannot add control file %s" % quotefn(f))
457
raise BzrError("cannot add top-level %r" % f)
459
fullpath = os.path.normpath(self.abspath(f))
462
kind = file_kind(fullpath)
464
# maybe something better?
465
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
467
if kind != 'file' and kind != 'directory':
468
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
471
file_id = gen_file_id(f)
472
inv.add_path(f, kind=kind, file_id=file_id)
474
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
476
self._write_inventory(inv)
481
def print_file(self, file, revno):
482
"""Print `file` to stdout."""
485
tree = self.revision_tree(self.get_rev_id(revno))
486
# use inventory as it was in that revision
487
file_id = tree.inventory.path2id(file)
489
raise BzrError("%r is not present in revision %s" % (file, revno))
490
tree.print_file(file_id)
495
def remove(self, files, verbose=False):
496
"""Mark nominated files for removal from the inventory.
498
This does not remove their text. This does not run on
500
TODO: Refuse to remove modified files unless --force is given?
502
TODO: Do something useful with directories.
504
TODO: Should this remove the text or not? Tough call; not
505
removing may be useful and the user can just use use rm, and
506
is the opposite of add. Removing it is consistent with most
507
other tools. Maybe an option.
509
## TODO: Normalize names
510
## TODO: Remove nested loops; better scalability
511
if isinstance(files, basestring):
517
tree = self.working_tree()
520
# do this before any modifications
524
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
525
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
527
# having remove it, it must be either ignored or unknown
528
if tree.is_ignored(f):
532
show_status(new_status, inv[fid].kind, quotefn(f))
535
self._write_inventory(inv)
540
# FIXME: this doesn't need to be a branch method
541
def set_inventory(self, new_inventory_list):
542
from bzrlib.inventory import Inventory, InventoryEntry
543
inv = Inventory(self.get_root_id())
544
for path, file_id, parent, kind in new_inventory_list:
545
name = os.path.basename(path)
548
inv.add(InventoryEntry(file_id, name, kind, parent))
549
self._write_inventory(inv)
553
"""Return all unknown files.
555
These are files in the working directory that are not versioned or
556
control files or ignored.
558
>>> b = ScratchBranch(files=['foo', 'foo~'])
559
>>> list(b.unknowns())
562
>>> list(b.unknowns())
565
>>> list(b.unknowns())
568
return self.working_tree().unknowns()
571
def append_revision(self, *revision_ids):
572
from bzrlib.atomicfile import AtomicFile
574
for revision_id in revision_ids:
575
mutter("add {%s} to revision-history" % revision_id)
577
rev_history = self.revision_history()
578
rev_history.extend(revision_ids)
580
f = AtomicFile(self.controlfilename('revision-history'))
582
for rev_id in rev_history:
589
def get_revision_xml_file(self, revision_id):
590
"""Return XML file object for revision object."""
591
if not revision_id or not isinstance(revision_id, basestring):
592
raise InvalidRevisionId(revision_id)
597
return self.revision_store[revision_id]
599
raise bzrlib.errors.NoSuchRevision(self, revision_id)
605
get_revision_xml = get_revision_xml_file
608
def get_revision(self, revision_id):
609
"""Return the Revision object for a named revision"""
610
xml_file = self.get_revision_xml_file(revision_id)
613
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
614
except SyntaxError, e:
615
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
619
assert r.revision_id == revision_id
623
def get_revision_delta(self, revno):
624
"""Return the delta for one revision.
626
The delta is relative to its mainline predecessor, or the
627
empty tree for revision 1.
629
assert isinstance(revno, int)
630
rh = self.revision_history()
631
if not (1 <= revno <= len(rh)):
632
raise InvalidRevisionNumber(revno)
634
# revno is 1-based; list is 0-based
636
new_tree = self.revision_tree(rh[revno-1])
638
old_tree = EmptyTree()
640
old_tree = self.revision_tree(rh[revno-2])
642
return compare_trees(old_tree, new_tree)
646
def get_revision_sha1(self, revision_id):
647
"""Hash the stored value of a revision, and return it."""
648
# In the future, revision entries will be signed. At that
649
# point, it is probably best *not* to include the signature
650
# in the revision hash. Because that lets you re-sign
651
# the revision, (add signatures/remove signatures) and still
652
# have all hash pointers stay consistent.
653
# But for now, just hash the contents.
654
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
657
def get_inventory(self, inventory_id):
658
"""Get Inventory object by hash.
660
TODO: Perhaps for this and similar methods, take a revision
661
parameter which can be either an integer revno or a
663
from bzrlib.inventory import Inventory
665
f = self.get_inventory_xml_file(inventory_id)
666
return bzrlib.xml.serializer_v4.read_inventory(f)
669
def get_inventory_xml(self, inventory_id):
670
"""Get inventory XML as a file object."""
671
return self.inventory_store[inventory_id]
673
get_inventory_xml_file = get_inventory_xml
676
def get_inventory_sha1(self, inventory_id):
677
"""Return the sha1 hash of the inventory entry
679
return sha_file(self.get_inventory_xml(inventory_id))
682
def get_revision_inventory(self, revision_id):
683
"""Return inventory of a past revision."""
684
# bzr 0.0.6 imposes the constraint that the inventory_id
685
# must be the same as its revision, so this is trivial.
686
if revision_id == None:
687
from bzrlib.inventory import Inventory
688
return Inventory(self.get_root_id())
690
return self.get_inventory(revision_id)
693
def revision_history(self):
694
"""Return sequence of revision hashes on to this branch.
696
>>> ScratchBranch().revision_history()
701
return [l.rstrip('\r\n') for l in
702
self.controlfile('revision-history', 'r').readlines()]
707
def common_ancestor(self, other, self_revno=None, other_revno=None):
709
>>> from bzrlib.commit import commit
710
>>> sb = ScratchBranch(files=['foo', 'foo~'])
711
>>> sb.common_ancestor(sb) == (None, None)
713
>>> commit(sb, "Committing first revision", verbose=False)
714
>>> sb.common_ancestor(sb)[0]
716
>>> clone = sb.clone()
717
>>> commit(sb, "Committing second revision", verbose=False)
718
>>> sb.common_ancestor(sb)[0]
720
>>> sb.common_ancestor(clone)[0]
722
>>> commit(clone, "Committing divergent second revision",
724
>>> sb.common_ancestor(clone)[0]
726
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
728
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
730
>>> clone2 = sb.clone()
731
>>> sb.common_ancestor(clone2)[0]
733
>>> sb.common_ancestor(clone2, self_revno=1)[0]
735
>>> sb.common_ancestor(clone2, other_revno=1)[0]
738
my_history = self.revision_history()
739
other_history = other.revision_history()
740
if self_revno is None:
741
self_revno = len(my_history)
742
if other_revno is None:
743
other_revno = len(other_history)
744
indices = range(min((self_revno, other_revno)))
747
if my_history[r] == other_history[r]:
748
return r+1, my_history[r]
753
"""Return current revision number for this branch.
755
That is equivalent to the number of revisions committed to
758
return len(self.revision_history())
761
def last_patch(self):
762
"""Return last patch hash, or None if no history.
764
ph = self.revision_history()
771
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
773
If self and other have not diverged, return a list of the revisions
774
present in other, but missing from self.
776
>>> from bzrlib.commit import commit
777
>>> bzrlib.trace.silent = True
778
>>> br1 = ScratchBranch()
779
>>> br2 = ScratchBranch()
780
>>> br1.missing_revisions(br2)
782
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
783
>>> br1.missing_revisions(br2)
785
>>> br2.missing_revisions(br1)
787
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
788
>>> br1.missing_revisions(br2)
790
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
791
>>> br1.missing_revisions(br2)
793
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
794
>>> br1.missing_revisions(br2)
795
Traceback (most recent call last):
796
DivergedBranches: These branches have diverged.
798
self_history = self.revision_history()
799
self_len = len(self_history)
800
other_history = other.revision_history()
801
other_len = len(other_history)
802
common_index = min(self_len, other_len) -1
803
if common_index >= 0 and \
804
self_history[common_index] != other_history[common_index]:
805
raise DivergedBranches(self, other)
807
if stop_revision is None:
808
stop_revision = other_len
809
elif stop_revision > other_len:
810
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
812
return other_history[self_len:stop_revision]
815
def update_revisions(self, other, stop_revision=None):
816
"""Pull in all new revisions from other branch.
818
from bzrlib.fetch import greedy_fetch
820
pb = bzrlib.ui.ui_factory.progress_bar()
821
pb.update('comparing histories')
823
revision_ids = self.missing_revisions(other, stop_revision)
825
if len(revision_ids) > 0:
826
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
829
self.append_revision(*revision_ids)
830
## note("Added %d revisions." % count)
833
def install_revisions(self, other, revision_ids, pb):
834
if hasattr(other.revision_store, "prefetch"):
835
other.revision_store.prefetch(revision_ids)
836
if hasattr(other.inventory_store, "prefetch"):
837
inventory_ids = [other.get_revision(r).inventory_id
838
for r in revision_ids]
839
other.inventory_store.prefetch(inventory_ids)
842
pb = bzrlib.ui.ui_factory.progress_bar()
849
for i, rev_id in enumerate(revision_ids):
850
pb.update('fetching revision', i+1, len(revision_ids))
852
rev = other.get_revision(rev_id)
853
except bzrlib.errors.NoSuchRevision:
857
revisions.append(rev)
858
inv = other.get_inventory(str(rev.inventory_id))
859
for key, entry in inv.iter_entries():
860
if entry.text_id is None:
862
if entry.text_id not in self.text_store:
863
needed_texts.add(entry.text_id)
867
count, cp_fail = self.text_store.copy_multi(other.text_store,
869
#print "Added %d texts." % count
870
inventory_ids = [ f.inventory_id for f in revisions ]
871
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
873
#print "Added %d inventories." % count
874
revision_ids = [ f.revision_id for f in revisions]
876
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
879
assert len(cp_fail) == 0
880
return count, failures
883
def commit(self, *args, **kw):
884
from bzrlib.commit import commit
885
commit(self, *args, **kw)
888
def revision_id_to_revno(self, revision_id):
889
"""Given a revision id, return its revno"""
890
history = self.revision_history()
892
return history.index(revision_id) + 1
894
raise bzrlib.errors.NoSuchRevision(self, revision_id)
897
def get_rev_id(self, revno, history=None):
898
"""Find the revision id of the specified revno."""
902
history = self.revision_history()
903
elif revno <= 0 or revno > len(history):
904
raise bzrlib.errors.NoSuchRevision(self, revno)
905
return history[revno - 1]
907
def revision_tree(self, revision_id):
908
"""Return Tree for a revision on this branch.
910
`revision_id` may be None for the null revision, in which case
911
an `EmptyTree` is returned."""
912
# TODO: refactor this to use an existing revision object
913
# so we don't need to read it in twice.
914
if revision_id == None:
917
inv = self.get_revision_inventory(revision_id)
918
return RevisionTree(self.text_store, inv)
921
def working_tree(self):
922
"""Return a `Tree` for the working copy."""
923
from bzrlib.workingtree import WorkingTree
924
return WorkingTree(self.base, self.read_working_inventory())
927
def basis_tree(self):
928
"""Return `Tree` object for last revision.
930
If there are no revisions yet, return an `EmptyTree`.
932
r = self.last_patch()
936
return RevisionTree(self.text_store, self.get_revision_inventory(r))
940
def rename_one(self, from_rel, to_rel):
943
This can change the directory or the filename or both.
947
tree = self.working_tree()
949
if not tree.has_filename(from_rel):
950
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
951
if tree.has_filename(to_rel):
952
raise BzrError("can't rename: new working file %r already exists" % to_rel)
954
file_id = inv.path2id(from_rel)
956
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
958
if inv.path2id(to_rel):
959
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
961
to_dir, to_tail = os.path.split(to_rel)
962
to_dir_id = inv.path2id(to_dir)
963
if to_dir_id == None and to_dir != '':
964
raise BzrError("can't determine destination directory id for %r" % to_dir)
966
mutter("rename_one:")
967
mutter(" file_id {%s}" % file_id)
968
mutter(" from_rel %r" % from_rel)
969
mutter(" to_rel %r" % to_rel)
970
mutter(" to_dir %r" % to_dir)
971
mutter(" to_dir_id {%s}" % to_dir_id)
973
inv.rename(file_id, to_dir_id, to_tail)
975
from_abs = self.abspath(from_rel)
976
to_abs = self.abspath(to_rel)
978
os.rename(from_abs, to_abs)
980
raise BzrError("failed to rename %r to %r: %s"
981
% (from_abs, to_abs, e[1]),
982
["rename rolled back"])
984
self._write_inventory(inv)
989
def move(self, from_paths, to_name):
992
to_name must exist as a versioned directory.
994
If to_name exists and is a directory, the files are moved into
995
it, keeping their old names. If it is a directory,
997
Note that to_name is only the last component of the new name;
998
this doesn't change the directory.
1000
This returns a list of (from_path, to_path) pairs for each
1001
entry that is moved.
1006
## TODO: Option to move IDs only
1007
assert not isinstance(from_paths, basestring)
1008
tree = self.working_tree()
1009
inv = tree.inventory
1010
to_abs = self.abspath(to_name)
1011
if not isdir(to_abs):
1012
raise BzrError("destination %r is not a directory" % to_abs)
1013
if not tree.has_filename(to_name):
1014
raise BzrError("destination %r not in working directory" % to_abs)
1015
to_dir_id = inv.path2id(to_name)
1016
if to_dir_id == None and to_name != '':
1017
raise BzrError("destination %r is not a versioned directory" % to_name)
1018
to_dir_ie = inv[to_dir_id]
1019
if to_dir_ie.kind not in ('directory', 'root_directory'):
1020
raise BzrError("destination %r is not a directory" % to_abs)
1022
to_idpath = inv.get_idpath(to_dir_id)
1024
for f in from_paths:
1025
if not tree.has_filename(f):
1026
raise BzrError("%r does not exist in working tree" % f)
1027
f_id = inv.path2id(f)
1029
raise BzrError("%r is not versioned" % f)
1030
name_tail = splitpath(f)[-1]
1031
dest_path = appendpath(to_name, name_tail)
1032
if tree.has_filename(dest_path):
1033
raise BzrError("destination %r already exists" % dest_path)
1034
if f_id in to_idpath:
1035
raise BzrError("can't move %r to a subdirectory of itself" % f)
1037
# OK, so there's a race here, it's possible that someone will
1038
# create a file in this interval and then the rename might be
1039
# left half-done. But we should have caught most problems.
1041
for f in from_paths:
1042
name_tail = splitpath(f)[-1]
1043
dest_path = appendpath(to_name, name_tail)
1044
result.append((f, dest_path))
1045
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1047
os.rename(self.abspath(f), self.abspath(dest_path))
1049
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1050
["rename rolled back"])
1052
self._write_inventory(inv)
1059
def revert(self, filenames, old_tree=None, backups=True):
1060
"""Restore selected files to the versions from a previous tree.
1063
If true (default) backups are made of files before
1066
from bzrlib.errors import NotVersionedError, BzrError
1067
from bzrlib.atomicfile import AtomicFile
1068
from bzrlib.osutils import backup_file
1070
inv = self.read_working_inventory()
1071
if old_tree is None:
1072
old_tree = self.basis_tree()
1073
old_inv = old_tree.inventory
1076
for fn in filenames:
1077
file_id = inv.path2id(fn)
1079
raise NotVersionedError("not a versioned file", fn)
1080
if not old_inv.has_id(file_id):
1081
raise BzrError("file not present in old tree", fn, file_id)
1082
nids.append((fn, file_id))
1084
# TODO: Rename back if it was previously at a different location
1086
# TODO: If given a directory, restore the entire contents from
1087
# the previous version.
1089
# TODO: Make a backup to a temporary file.
1091
# TODO: If the file previously didn't exist, delete it?
1092
for fn, file_id in nids:
1095
f = AtomicFile(fn, 'wb')
1097
f.write(old_tree.get_file(file_id).read())
1103
def pending_merges(self):
1104
"""Return a list of pending merges.
1106
These are revisions that have been merged into the working
1107
directory but not yet committed.
1109
cfn = self.controlfilename('pending-merges')
1110
if not os.path.exists(cfn):
1113
for l in self.controlfile('pending-merges', 'r').readlines():
1114
p.append(l.rstrip('\n'))
1118
def add_pending_merge(self, revision_id):
1119
from bzrlib.revision import validate_revision_id
1121
validate_revision_id(revision_id)
1123
p = self.pending_merges()
1124
if revision_id in p:
1126
p.append(revision_id)
1127
self.set_pending_merges(p)
1130
def set_pending_merges(self, rev_list):
1131
from bzrlib.atomicfile import AtomicFile
1134
f = AtomicFile(self.controlfilename('pending-merges'))
1145
def get_parent(self):
1146
"""Return the parent location of the branch.
1148
This is the default location for push/pull/missing. The usual
1149
pattern is that the user can override it by specifying a
1153
_locs = ['parent', 'pull', 'x-pull']
1156
return self.controlfile(l, 'r').read().strip('\n')
1158
if e.errno != errno.ENOENT:
1163
def set_parent(self, url):
1164
# TODO: Maybe delete old location files?
1165
from bzrlib.atomicfile import AtomicFile
1168
f = AtomicFile(self.controlfilename('parent'))
1177
def check_revno(self, revno):
1179
Check whether a revno corresponds to any revision.
1180
Zero (the NULL revision) is considered valid.
1183
self.check_real_revno(revno)
1185
def check_real_revno(self, revno):
1187
Check whether a revno corresponds to a real revision.
1188
Zero (the NULL revision) is considered invalid
1190
if revno < 1 or revno > self.revno():
1191
raise InvalidRevisionNumber(revno)
1196
class ScratchBranch(LocalBranch):
1197
"""Special test class: a branch that cleans up after itself.
1199
>>> b = ScratchBranch()
1207
def __init__(self, files=[], dirs=[], base=None):
1208
"""Make a test branch.
1210
This creates a temporary directory and runs init-tree in it.
1212
If any files are listed, they are created in the working copy.
1214
from tempfile import mkdtemp
1219
LocalBranch.__init__(self, base, init=init)
1221
os.mkdir(self.abspath(d))
1224
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1229
>>> orig = ScratchBranch(files=["file1", "file2"])
1230
>>> clone = orig.clone()
1231
>>> os.path.samefile(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.
1328
The name of a local directory that exists but is empty.
1330
from bzrlib.merge import merge
1331
from bzrlib.revisionspec import RevisionSpec
1333
assert isinstance(branch_from, Branch)
1334
assert isinstance(to_location, basestring)
1336
br_to = Branch.initialize(to_location)
1337
br_to.set_root_id(branch_from.get_root_id())
1338
if revision is None:
1339
revno = branch_from.revno()
1341
revno, rev_id = RevisionSpec(revision).in_history(branch_from)
1342
br_to.update_revisions(branch_from, stop_revision=revno)
1343
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1344
check_clean=False, ignore_zero=True)
1346
from_location = branch_from.base
1347
br_to.set_parent(branch_from.base)
added
removed
bzrlib/branch.py
