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
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
# TODO: please move the revision-string syntax stuff out of the branch
47
# object; it's clutter
50
def find_branch(f, **args):
51
if f and (f.startswith('http://') or f.startswith('https://')):
53
return remotebranch.RemoteBranch(f, **args)
55
return Branch(f, **args)
58
def find_cached_branch(f, cache_root, **args):
59
from remotebranch import RemoteBranch
60
br = find_branch(f, **args)
61
def cacheify(br, store_name):
62
from meta_store import CachedStore
63
cache_path = os.path.join(cache_root, store_name)
65
new_store = CachedStore(getattr(br, store_name), cache_path)
66
setattr(br, store_name, new_store)
68
if isinstance(br, RemoteBranch):
69
cacheify(br, 'inventory_store')
70
cacheify(br, 'text_store')
71
cacheify(br, 'revision_store')
75
def _relpath(base, path):
76
"""Return path relative to base, or raise exception.
78
The path may be either an absolute path or a path relative to the
79
current working directory.
81
Lifted out of Branch.relpath for ease of testing.
83
os.path.commonprefix (python2.4) has a bad bug that it works just
84
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
85
avoids that problem."""
86
rp = os.path.abspath(path)
90
while len(head) >= len(base):
93
head, tail = os.path.split(head)
97
from errors import NotBranchError
98
raise NotBranchError("path %r is not within branch %r" % (rp, base))
100
return os.sep.join(s)
103
def find_branch_root(f=None):
104
"""Find the branch root enclosing f, or pwd.
106
f may be a filename or a URL.
108
It is not necessary that f exists.
110
Basically we keep looking up until we find the control directory or
111
run into the root. If there isn't one, raises NotBranchError.
115
elif hasattr(os.path, 'realpath'):
116
f = os.path.realpath(f)
118
f = os.path.abspath(f)
119
if not os.path.exists(f):
120
raise BzrError('%r does not exist' % f)
126
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
128
head, tail = os.path.split(f)
130
# reached the root, whatever that may be
131
raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
136
# XXX: move into bzrlib.errors; subclass BzrError
137
class DivergedBranches(Exception):
138
def __init__(self, branch1, branch2):
139
self.branch1 = branch1
140
self.branch2 = branch2
141
Exception.__init__(self, "These branches have diverged.")
144
######################################################################
147
class Branch(object):
148
"""Branch holding a history of revisions.
151
Base directory of the branch.
157
If _lock_mode is true, a positive count of the number of times the
161
Lock object from bzrlib.lock.
168
# Map some sort of prefix into a namespace
169
# stuff like "revno:10", "revid:", etc.
170
# This should match a prefix with a function which accepts
171
REVISION_NAMESPACES = {}
173
def __init__(self, base, init=False, find_root=True):
174
"""Create new branch object at a particular location.
176
base -- Base directory for the branch. May be a file:// url.
178
init -- If True, create new control files in a previously
179
unversioned directory. If False, the branch must already
182
find_root -- If true and init is false, find the root of the
183
existing branch containing base.
185
In the test suite, creation of new trees is tested using the
186
`ScratchBranch` class.
188
from bzrlib.store import ImmutableStore
190
self.base = os.path.realpath(base)
193
self.base = find_branch_root(base)
195
if base.startswith("file://"):
197
self.base = os.path.realpath(base)
198
if not isdir(self.controlfilename('.')):
199
from errors import NotBranchError
200
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
201
['use "bzr init" to initialize a new working tree',
202
'current bzr can only operate from top-of-tree'])
205
self.text_store = ImmutableStore(self.controlfilename('text-store'))
206
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
207
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
211
return '%s(%r)' % (self.__class__.__name__, self.base)
218
if self._lock_mode or self._lock:
219
from warnings import warn
220
warn("branch %r was not explicitly unlocked" % self)
223
def lock_write(self):
225
if self._lock_mode != 'w':
226
from errors import LockError
227
raise LockError("can't upgrade to a write lock from %r" %
229
self._lock_count += 1
231
from bzrlib.lock import WriteLock
233
self._lock = WriteLock(self.controlfilename('branch-lock'))
234
self._lock_mode = 'w'
240
assert self._lock_mode in ('r', 'w'), \
241
"invalid lock mode %r" % self._lock_mode
242
self._lock_count += 1
244
from bzrlib.lock import ReadLock
246
self._lock = ReadLock(self.controlfilename('branch-lock'))
247
self._lock_mode = 'r'
251
if not self._lock_mode:
252
from errors import LockError
253
raise LockError('branch %r is not locked' % (self))
255
if self._lock_count > 1:
256
self._lock_count -= 1
260
self._lock_mode = self._lock_count = None
262
def abspath(self, name):
263
"""Return absolute filename for something in the branch"""
264
return os.path.join(self.base, name)
266
def relpath(self, path):
267
"""Return path relative to this branch of something inside it.
269
Raises an error if path is not in this branch."""
270
return _relpath(self.base, path)
272
def controlfilename(self, file_or_path):
273
"""Return location relative to branch."""
274
if isinstance(file_or_path, basestring):
275
file_or_path = [file_or_path]
276
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
279
def controlfile(self, file_or_path, mode='r'):
280
"""Open a control file for this branch.
282
There are two classes of file in the control directory: text
283
and binary. binary files are untranslated byte streams. Text
284
control files are stored with Unix newlines and in UTF-8, even
285
if the platform or locale defaults are different.
287
Controlfiles should almost never be opened in write mode but
288
rather should be atomically copied and replaced using atomicfile.
291
fn = self.controlfilename(file_or_path)
293
if mode == 'rb' or mode == 'wb':
294
return file(fn, mode)
295
elif mode == 'r' or mode == 'w':
296
# open in binary mode anyhow so there's no newline translation;
297
# codecs uses line buffering by default; don't want that.
299
return codecs.open(fn, mode + 'b', 'utf-8',
302
raise BzrError("invalid controlfile mode %r" % mode)
304
def _make_control(self):
305
from bzrlib.inventory import Inventory
307
os.mkdir(self.controlfilename([]))
308
self.controlfile('README', 'w').write(
309
"This is a Bazaar-NG control directory.\n"
310
"Do not change any files in this directory.\n")
311
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
312
for d in ('text-store', 'inventory-store', 'revision-store'):
313
os.mkdir(self.controlfilename(d))
314
for f in ('revision-history', 'merged-patches',
315
'pending-merged-patches', 'branch-name',
318
self.controlfile(f, 'w').write('')
319
mutter('created control directory in ' + self.base)
321
# if we want per-tree root ids then this is the place to set
322
# them; they're not needed for now and so ommitted for
324
f = self.controlfile('inventory','w')
325
bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
328
def _check_format(self):
329
"""Check this branch format is supported.
331
The current tool only supports the current unstable format.
333
In the future, we might need different in-memory Branch
334
classes to support downlevel branches. But not yet.
336
# This ignores newlines so that we can open branches created
337
# on Windows from Linux and so on. I think it might be better
338
# to always make all internal files in unix format.
339
fmt = self.controlfile('branch-format', 'r').read()
340
fmt = fmt.replace('\r\n', '\n')
341
if fmt != BZR_BRANCH_FORMAT:
342
raise BzrError('sorry, branch format %r not supported' % fmt,
343
['use a different bzr version',
344
'or remove the .bzr directory and "bzr init" again'])
346
def get_root_id(self):
347
"""Return the id of this branches root"""
348
inv = self.read_working_inventory()
349
return inv.root.file_id
351
def set_root_id(self, file_id):
352
inv = self.read_working_inventory()
353
orig_root_id = inv.root.file_id
354
del inv._byid[inv.root.file_id]
355
inv.root.file_id = file_id
356
inv._byid[inv.root.file_id] = inv.root
359
if entry.parent_id in (None, orig_root_id):
360
entry.parent_id = inv.root.file_id
361
self._write_inventory(inv)
363
def read_working_inventory(self):
364
"""Read the working inventory."""
365
from bzrlib.inventory import Inventory
368
# ElementTree does its own conversion from UTF-8, so open in
370
f = self.controlfile('inventory', 'rb')
371
return bzrlib.xml.serializer_v4.read_inventory(f)
376
def _write_inventory(self, inv):
377
"""Update the working inventory.
379
That is to say, the inventory describing changes underway, that
380
will be committed to the next revision.
382
from bzrlib.atomicfile import AtomicFile
386
f = AtomicFile(self.controlfilename('inventory'), 'wb')
388
bzrlib.xml.serializer_v4.write_inventory(inv, f)
395
mutter('wrote working inventory')
398
inventory = property(read_working_inventory, _write_inventory, None,
399
"""Inventory for the working copy.""")
402
def add(self, files, ids=None):
403
"""Make files versioned.
405
Note that the command line normally calls smart_add instead,
406
which can automatically recurse.
408
This puts the files in the Added state, so that they will be
409
recorded by the next commit.
412
List of paths to add, relative to the base of the tree.
415
If set, use these instead of automatically generated ids.
416
Must be the same length as the list of files, but may
417
contain None for ids that are to be autogenerated.
419
TODO: Perhaps have an option to add the ids even if the files do
422
TODO: Perhaps yield the ids and paths as they're added.
424
# TODO: Re-adding a file that is removed in the working copy
425
# should probably put it back with the previous ID.
426
if isinstance(files, basestring):
427
assert(ids is None or isinstance(ids, basestring))
433
ids = [None] * len(files)
435
assert(len(ids) == len(files))
439
inv = self.read_working_inventory()
440
for f,file_id in zip(files, ids):
441
if is_control_file(f):
442
raise BzrError("cannot add control file %s" % quotefn(f))
447
raise BzrError("cannot add top-level %r" % f)
449
fullpath = os.path.normpath(self.abspath(f))
452
kind = file_kind(fullpath)
454
# maybe something better?
455
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
457
if kind != 'file' and kind != 'directory':
458
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
461
file_id = gen_file_id(f)
462
inv.add_path(f, kind=kind, file_id=file_id)
464
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
466
self._write_inventory(inv)
471
def print_file(self, file, revno):
472
"""Print `file` to stdout."""
475
tree = self.revision_tree(self.lookup_revision(revno))
476
# use inventory as it was in that revision
477
file_id = tree.inventory.path2id(file)
479
raise BzrError("%r is not present in revision %s" % (file, revno))
480
tree.print_file(file_id)
485
def remove(self, files, verbose=False):
486
"""Mark nominated files for removal from the inventory.
488
This does not remove their text. This does not run on
490
TODO: Refuse to remove modified files unless --force is given?
492
TODO: Do something useful with directories.
494
TODO: Should this remove the text or not? Tough call; not
495
removing may be useful and the user can just use use rm, and
496
is the opposite of add. Removing it is consistent with most
497
other tools. Maybe an option.
499
## TODO: Normalize names
500
## TODO: Remove nested loops; better scalability
501
if isinstance(files, basestring):
507
tree = self.working_tree()
510
# do this before any modifications
514
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
515
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
517
# having remove it, it must be either ignored or unknown
518
if tree.is_ignored(f):
522
show_status(new_status, inv[fid].kind, quotefn(f))
525
self._write_inventory(inv)
530
# FIXME: this doesn't need to be a branch method
531
def set_inventory(self, new_inventory_list):
532
from bzrlib.inventory import Inventory, InventoryEntry
533
inv = Inventory(self.get_root_id())
534
for path, file_id, parent, kind in new_inventory_list:
535
name = os.path.basename(path)
538
inv.add(InventoryEntry(file_id, name, kind, parent))
539
self._write_inventory(inv)
543
"""Return all unknown files.
545
These are files in the working directory that are not versioned or
546
control files or ignored.
548
>>> b = ScratchBranch(files=['foo', 'foo~'])
549
>>> list(b.unknowns())
552
>>> list(b.unknowns())
555
>>> list(b.unknowns())
558
return self.working_tree().unknowns()
561
def append_revision(self, *revision_ids):
562
from bzrlib.atomicfile import AtomicFile
564
for revision_id in revision_ids:
565
mutter("add {%s} to revision-history" % revision_id)
567
rev_history = self.revision_history()
568
rev_history.extend(revision_ids)
570
f = AtomicFile(self.controlfilename('revision-history'))
572
for rev_id in rev_history:
579
def get_revision_xml_file(self, revision_id):
580
"""Return XML file object for revision object."""
581
if not revision_id or not isinstance(revision_id, basestring):
582
raise InvalidRevisionId(revision_id)
587
return self.revision_store[revision_id]
589
raise bzrlib.errors.NoSuchRevision(self, revision_id)
595
get_revision_xml = get_revision_xml_file
598
def get_revision(self, revision_id):
599
"""Return the Revision object for a named revision"""
600
xml_file = self.get_revision_xml_file(revision_id)
603
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
604
except SyntaxError, e:
605
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
609
assert r.revision_id == revision_id
613
def get_revision_delta(self, revno):
614
"""Return the delta for one revision.
616
The delta is relative to its mainline predecessor, or the
617
empty tree for revision 1.
619
assert isinstance(revno, int)
620
rh = self.revision_history()
621
if not (1 <= revno <= len(rh)):
622
raise InvalidRevisionNumber(revno)
624
# revno is 1-based; list is 0-based
626
new_tree = self.revision_tree(rh[revno-1])
628
old_tree = EmptyTree()
630
old_tree = self.revision_tree(rh[revno-2])
632
return compare_trees(old_tree, new_tree)
636
def get_revision_sha1(self, revision_id):
637
"""Hash the stored value of a revision, and return it."""
638
# In the future, revision entries will be signed. At that
639
# point, it is probably best *not* to include the signature
640
# in the revision hash. Because that lets you re-sign
641
# the revision, (add signatures/remove signatures) and still
642
# have all hash pointers stay consistent.
643
# But for now, just hash the contents.
644
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
647
def get_inventory(self, inventory_id):
648
"""Get Inventory object by hash.
650
TODO: Perhaps for this and similar methods, take a revision
651
parameter which can be either an integer revno or a
653
from bzrlib.inventory import Inventory
655
f = self.get_inventory_xml_file(inventory_id)
656
return bzrlib.xml.serializer_v4.read_inventory(f)
659
def get_inventory_xml(self, inventory_id):
660
"""Get inventory XML as a file object."""
661
return self.inventory_store[inventory_id]
663
get_inventory_xml_file = get_inventory_xml
666
def get_inventory_sha1(self, inventory_id):
667
"""Return the sha1 hash of the inventory entry
669
return sha_file(self.get_inventory_xml(inventory_id))
672
def get_revision_inventory(self, revision_id):
673
"""Return inventory of a past revision."""
674
# bzr 0.0.6 imposes the constraint that the inventory_id
675
# must be the same as its revision, so this is trivial.
676
if revision_id == None:
677
from bzrlib.inventory import Inventory
678
return Inventory(self.get_root_id())
680
return self.get_inventory(revision_id)
683
def revision_history(self):
684
"""Return sequence of revision hashes on to this branch.
686
>>> ScratchBranch().revision_history()
691
return [l.rstrip('\r\n') for l in
692
self.controlfile('revision-history', 'r').readlines()]
697
def common_ancestor(self, other, self_revno=None, other_revno=None):
700
>>> sb = ScratchBranch(files=['foo', 'foo~'])
701
>>> sb.common_ancestor(sb) == (None, None)
703
>>> commit.commit(sb, "Committing first revision", verbose=False)
704
>>> sb.common_ancestor(sb)[0]
706
>>> clone = sb.clone()
707
>>> commit.commit(sb, "Committing second revision", verbose=False)
708
>>> sb.common_ancestor(sb)[0]
710
>>> sb.common_ancestor(clone)[0]
712
>>> commit.commit(clone, "Committing divergent second revision",
714
>>> sb.common_ancestor(clone)[0]
716
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
718
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
720
>>> clone2 = sb.clone()
721
>>> sb.common_ancestor(clone2)[0]
723
>>> sb.common_ancestor(clone2, self_revno=1)[0]
725
>>> sb.common_ancestor(clone2, other_revno=1)[0]
728
my_history = self.revision_history()
729
other_history = other.revision_history()
730
if self_revno is None:
731
self_revno = len(my_history)
732
if other_revno is None:
733
other_revno = len(other_history)
734
indices = range(min((self_revno, other_revno)))
737
if my_history[r] == other_history[r]:
738
return r+1, my_history[r]
743
"""Return current revision number for this branch.
745
That is equivalent to the number of revisions committed to
748
return len(self.revision_history())
751
def last_patch(self):
752
"""Return last patch hash, or None if no history.
754
ph = self.revision_history()
761
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
763
If self and other have not diverged, return a list of the revisions
764
present in other, but missing from self.
766
>>> from bzrlib.commit import commit
767
>>> bzrlib.trace.silent = True
768
>>> br1 = ScratchBranch()
769
>>> br2 = ScratchBranch()
770
>>> br1.missing_revisions(br2)
772
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
773
>>> br1.missing_revisions(br2)
775
>>> br2.missing_revisions(br1)
777
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
778
>>> br1.missing_revisions(br2)
780
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
781
>>> br1.missing_revisions(br2)
783
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
784
>>> br1.missing_revisions(br2)
785
Traceback (most recent call last):
786
DivergedBranches: These branches have diverged.
788
self_history = self.revision_history()
789
self_len = len(self_history)
790
other_history = other.revision_history()
791
other_len = len(other_history)
792
common_index = min(self_len, other_len) -1
793
if common_index >= 0 and \
794
self_history[common_index] != other_history[common_index]:
795
raise DivergedBranches(self, other)
797
if stop_revision is None:
798
stop_revision = other_len
799
elif stop_revision > other_len:
800
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
802
return other_history[self_len:stop_revision]
805
def update_revisions(self, other, stop_revision=None):
806
"""Pull in all new revisions from other branch.
808
from bzrlib.fetch import greedy_fetch
809
from bzrlib.revision import get_intervening_revisions
811
pb = bzrlib.ui.ui_factory.progress_bar()
812
pb.update('comparing histories')
815
revision_ids = self.missing_revisions(other, stop_revision)
816
except DivergedBranches, e:
818
if stop_revision is None:
819
end_revision = other.last_patch()
820
revision_ids = get_intervening_revisions(self.last_patch(),
822
assert self.last_patch() not in revision_ids
823
except bzrlib.errors.NotAncestor:
826
if len(revision_ids) > 0:
827
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
830
self.append_revision(*revision_ids)
831
## note("Added %d revisions." % count)
834
def install_revisions(self, other, revision_ids, pb):
835
if hasattr(other.revision_store, "prefetch"):
836
other.revision_store.prefetch(revision_ids)
837
if hasattr(other.inventory_store, "prefetch"):
838
inventory_ids = [other.get_revision(r).inventory_id
839
for r in revision_ids]
840
other.inventory_store.prefetch(inventory_ids)
843
pb = bzrlib.ui.ui_factory.progress_bar()
850
for i, rev_id in enumerate(revision_ids):
851
pb.update('fetching revision', i+1, len(revision_ids))
853
rev = other.get_revision(rev_id)
854
except bzrlib.errors.NoSuchRevision:
858
revisions.append(rev)
859
inv = other.get_inventory(str(rev.inventory_id))
860
for key, entry in inv.iter_entries():
861
if entry.text_id is None:
863
if entry.text_id not in self.text_store:
864
needed_texts.add(entry.text_id)
868
count, cp_fail = self.text_store.copy_multi(other.text_store,
870
#print "Added %d texts." % count
871
inventory_ids = [ f.inventory_id for f in revisions ]
872
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
874
#print "Added %d inventories." % count
875
revision_ids = [ f.revision_id for f in revisions]
877
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
880
assert len(cp_fail) == 0
881
return count, failures
884
def commit(self, *args, **kw):
885
from bzrlib.commit import commit
886
commit(self, *args, **kw)
889
def lookup_revision(self, revision):
890
"""Return the revision identifier for a given revision information."""
891
revno, info = self._get_revision_info(revision)
895
def revision_id_to_revno(self, revision_id):
896
"""Given a revision id, return its revno"""
897
history = self.revision_history()
899
return history.index(revision_id) + 1
901
raise bzrlib.errors.NoSuchRevision(self, revision_id)
904
def get_revision_info(self, revision):
905
"""Return (revno, revision id) for revision identifier.
907
revision can be an integer, in which case it is assumed to be revno (though
908
this will translate negative values into positive ones)
909
revision can also be a string, in which case it is parsed for something like
910
'date:' or 'revid:' etc.
912
revno, rev_id = self._get_revision_info(revision)
914
raise bzrlib.errors.NoSuchRevision(self, revision)
917
def get_rev_id(self, revno, history=None):
918
"""Find the revision id of the specified revno."""
922
history = self.revision_history()
923
elif revno <= 0 or revno > len(history):
924
raise bzrlib.errors.NoSuchRevision(self, revno)
925
return history[revno - 1]
927
def _get_revision_info(self, revision):
928
"""Return (revno, revision id) for revision specifier.
930
revision can be an integer, in which case it is assumed to be revno
931
(though this will translate negative values into positive ones)
932
revision can also be a string, in which case it is parsed for something
933
like 'date:' or 'revid:' etc.
935
A revid is always returned. If it is None, the specifier referred to
936
the null revision. If the revid does not occur in the revision
937
history, revno will be None.
943
try:# Convert to int if possible
944
revision = int(revision)
947
revs = self.revision_history()
948
if isinstance(revision, int):
950
revno = len(revs) + revision + 1
953
rev_id = self.get_rev_id(revno, revs)
954
elif isinstance(revision, basestring):
955
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
956
if revision.startswith(prefix):
957
result = func(self, revs, revision)
959
revno, rev_id = result
962
rev_id = self.get_rev_id(revno, revs)
965
raise BzrError('No namespace registered for string: %r' %
968
raise TypeError('Unhandled revision type %s' % revision)
972
raise bzrlib.errors.NoSuchRevision(self, revision)
975
def _namespace_revno(self, revs, revision):
976
"""Lookup a revision by revision number"""
977
assert revision.startswith('revno:')
979
return (int(revision[6:]),)
982
REVISION_NAMESPACES['revno:'] = _namespace_revno
984
def _namespace_revid(self, revs, revision):
985
assert revision.startswith('revid:')
986
rev_id = revision[len('revid:'):]
988
return revs.index(rev_id) + 1, rev_id
991
REVISION_NAMESPACES['revid:'] = _namespace_revid
993
def _namespace_last(self, revs, revision):
994
assert revision.startswith('last:')
996
offset = int(revision[5:])
1001
raise BzrError('You must supply a positive value for --revision last:XXX')
1002
return (len(revs) - offset + 1,)
1003
REVISION_NAMESPACES['last:'] = _namespace_last
1005
def _namespace_tag(self, revs, revision):
1006
assert revision.startswith('tag:')
1007
raise BzrError('tag: namespace registered, but not implemented.')
1008
REVISION_NAMESPACES['tag:'] = _namespace_tag
1010
def _namespace_date(self, revs, revision):
1011
assert revision.startswith('date:')
1013
# Spec for date revisions:
1015
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
1016
# it can also start with a '+/-/='. '+' says match the first
1017
# entry after the given date. '-' is match the first entry before the date
1018
# '=' is match the first entry after, but still on the given date.
1020
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
1021
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
1022
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
1023
# May 13th, 2005 at 0:00
1025
# So the proper way of saying 'give me all entries for today' is:
1026
# -r {date:+today}:{date:-tomorrow}
1027
# The default is '=' when not supplied
1030
if val[:1] in ('+', '-', '='):
1031
match_style = val[:1]
1034
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1035
if val.lower() == 'yesterday':
1036
dt = today - datetime.timedelta(days=1)
1037
elif val.lower() == 'today':
1039
elif val.lower() == 'tomorrow':
1040
dt = today + datetime.timedelta(days=1)
1043
# This should be done outside the function to avoid recompiling it.
1044
_date_re = re.compile(
1045
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1047
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1049
m = _date_re.match(val)
1050
if not m or (not m.group('date') and not m.group('time')):
1051
raise BzrError('Invalid revision date %r' % revision)
1054
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1056
year, month, day = today.year, today.month, today.day
1058
hour = int(m.group('hour'))
1059
minute = int(m.group('minute'))
1060
if m.group('second'):
1061
second = int(m.group('second'))
1065
hour, minute, second = 0,0,0
1067
dt = datetime.datetime(year=year, month=month, day=day,
1068
hour=hour, minute=minute, second=second)
1072
if match_style == '-':
1074
elif match_style == '=':
1075
last = dt + datetime.timedelta(days=1)
1078
for i in range(len(revs)-1, -1, -1):
1079
r = self.get_revision(revs[i])
1080
# TODO: Handle timezone.
1081
dt = datetime.datetime.fromtimestamp(r.timestamp)
1082
if first >= dt and (last is None or dt >= last):
1085
for i in range(len(revs)):
1086
r = self.get_revision(revs[i])
1087
# TODO: Handle timezone.
1088
dt = datetime.datetime.fromtimestamp(r.timestamp)
1089
if first <= dt and (last is None or dt <= last):
1091
REVISION_NAMESPACES['date:'] = _namespace_date
1093
def revision_tree(self, revision_id):
1094
"""Return Tree for a revision on this branch.
1096
`revision_id` may be None for the null revision, in which case
1097
an `EmptyTree` is returned."""
1098
# TODO: refactor this to use an existing revision object
1099
# so we don't need to read it in twice.
1100
if revision_id == None:
1103
inv = self.get_revision_inventory(revision_id)
1104
return RevisionTree(self.text_store, inv)
1107
def working_tree(self):
1108
"""Return a `Tree` for the working copy."""
1109
from workingtree import WorkingTree
1110
return WorkingTree(self.base, self.read_working_inventory())
1113
def basis_tree(self):
1114
"""Return `Tree` object for last revision.
1116
If there are no revisions yet, return an `EmptyTree`.
1118
r = self.last_patch()
1122
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1126
def rename_one(self, from_rel, to_rel):
1129
This can change the directory or the filename or both.
1133
tree = self.working_tree()
1134
inv = tree.inventory
1135
if not tree.has_filename(from_rel):
1136
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1137
if tree.has_filename(to_rel):
1138
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1140
file_id = inv.path2id(from_rel)
1142
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1144
if inv.path2id(to_rel):
1145
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1147
to_dir, to_tail = os.path.split(to_rel)
1148
to_dir_id = inv.path2id(to_dir)
1149
if to_dir_id == None and to_dir != '':
1150
raise BzrError("can't determine destination directory id for %r" % to_dir)
1152
mutter("rename_one:")
1153
mutter(" file_id {%s}" % file_id)
1154
mutter(" from_rel %r" % from_rel)
1155
mutter(" to_rel %r" % to_rel)
1156
mutter(" to_dir %r" % to_dir)
1157
mutter(" to_dir_id {%s}" % to_dir_id)
1159
inv.rename(file_id, to_dir_id, to_tail)
1161
from_abs = self.abspath(from_rel)
1162
to_abs = self.abspath(to_rel)
1164
os.rename(from_abs, to_abs)
1166
raise BzrError("failed to rename %r to %r: %s"
1167
% (from_abs, to_abs, e[1]),
1168
["rename rolled back"])
1170
self._write_inventory(inv)
1175
def move(self, from_paths, to_name):
1178
to_name must exist as a versioned directory.
1180
If to_name exists and is a directory, the files are moved into
1181
it, keeping their old names. If it is a directory,
1183
Note that to_name is only the last component of the new name;
1184
this doesn't change the directory.
1186
This returns a list of (from_path, to_path) pairs for each
1187
entry that is moved.
1192
## TODO: Option to move IDs only
1193
assert not isinstance(from_paths, basestring)
1194
tree = self.working_tree()
1195
inv = tree.inventory
1196
to_abs = self.abspath(to_name)
1197
if not isdir(to_abs):
1198
raise BzrError("destination %r is not a directory" % to_abs)
1199
if not tree.has_filename(to_name):
1200
raise BzrError("destination %r not in working directory" % to_abs)
1201
to_dir_id = inv.path2id(to_name)
1202
if to_dir_id == None and to_name != '':
1203
raise BzrError("destination %r is not a versioned directory" % to_name)
1204
to_dir_ie = inv[to_dir_id]
1205
if to_dir_ie.kind not in ('directory', 'root_directory'):
1206
raise BzrError("destination %r is not a directory" % to_abs)
1208
to_idpath = inv.get_idpath(to_dir_id)
1210
for f in from_paths:
1211
if not tree.has_filename(f):
1212
raise BzrError("%r does not exist in working tree" % f)
1213
f_id = inv.path2id(f)
1215
raise BzrError("%r is not versioned" % f)
1216
name_tail = splitpath(f)[-1]
1217
dest_path = appendpath(to_name, name_tail)
1218
if tree.has_filename(dest_path):
1219
raise BzrError("destination %r already exists" % dest_path)
1220
if f_id in to_idpath:
1221
raise BzrError("can't move %r to a subdirectory of itself" % f)
1223
# OK, so there's a race here, it's possible that someone will
1224
# create a file in this interval and then the rename might be
1225
# left half-done. But we should have caught most problems.
1227
for f in from_paths:
1228
name_tail = splitpath(f)[-1]
1229
dest_path = appendpath(to_name, name_tail)
1230
result.append((f, dest_path))
1231
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1233
os.rename(self.abspath(f), self.abspath(dest_path))
1235
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1236
["rename rolled back"])
1238
self._write_inventory(inv)
1245
def revert(self, filenames, old_tree=None, backups=True):
1246
"""Restore selected files to the versions from a previous tree.
1249
If true (default) backups are made of files before
1252
from bzrlib.errors import NotVersionedError, BzrError
1253
from bzrlib.atomicfile import AtomicFile
1254
from bzrlib.osutils import backup_file
1256
inv = self.read_working_inventory()
1257
if old_tree is None:
1258
old_tree = self.basis_tree()
1259
old_inv = old_tree.inventory
1262
for fn in filenames:
1263
file_id = inv.path2id(fn)
1265
raise NotVersionedError("not a versioned file", fn)
1266
if not old_inv.has_id(file_id):
1267
raise BzrError("file not present in old tree", fn, file_id)
1268
nids.append((fn, file_id))
1270
# TODO: Rename back if it was previously at a different location
1272
# TODO: If given a directory, restore the entire contents from
1273
# the previous version.
1275
# TODO: Make a backup to a temporary file.
1277
# TODO: If the file previously didn't exist, delete it?
1278
for fn, file_id in nids:
1281
f = AtomicFile(fn, 'wb')
1283
f.write(old_tree.get_file(file_id).read())
1289
def pending_merges(self):
1290
"""Return a list of pending merges.
1292
These are revisions that have been merged into the working
1293
directory but not yet committed.
1295
cfn = self.controlfilename('pending-merges')
1296
if not os.path.exists(cfn):
1299
for l in self.controlfile('pending-merges', 'r').readlines():
1300
p.append(l.rstrip('\n'))
1304
def add_pending_merge(self, revision_id):
1305
from bzrlib.revision import validate_revision_id
1307
validate_revision_id(revision_id)
1309
p = self.pending_merges()
1310
if revision_id in p:
1312
p.append(revision_id)
1313
self.set_pending_merges(p)
1316
def set_pending_merges(self, rev_list):
1317
from bzrlib.atomicfile import AtomicFile
1320
f = AtomicFile(self.controlfilename('pending-merges'))
1331
def get_parent(self):
1332
"""Return the parent location of the branch.
1334
This is the default location for push/pull/missing. The usual
1335
pattern is that the user can override it by specifying a
1339
_locs = ['parent', 'pull', 'x-pull']
1342
return self.controlfile(l, 'r').read().strip('\n')
1344
if e.errno != errno.ENOENT:
1349
def set_parent(self, url):
1350
# TODO: Maybe delete old location files?
1351
from bzrlib.atomicfile import AtomicFile
1354
f = AtomicFile(self.controlfilename('parent'))
1363
def check_revno(self, revno):
1365
Check whether a revno corresponds to any revision.
1366
Zero (the NULL revision) is considered valid.
1369
self.check_real_revno(revno)
1371
def check_real_revno(self, revno):
1373
Check whether a revno corresponds to a real revision.
1374
Zero (the NULL revision) is considered invalid
1376
if revno < 1 or revno > self.revno():
1377
raise InvalidRevisionNumber(revno)
1382
class ScratchBranch(Branch):
1383
"""Special test class: a branch that cleans up after itself.
1385
>>> b = ScratchBranch()
1393
def __init__(self, files=[], dirs=[], base=None):
1394
"""Make a test branch.
1396
This creates a temporary directory and runs init-tree in it.
1398
If any files are listed, they are created in the working copy.
1400
from tempfile import mkdtemp
1405
Branch.__init__(self, base, init=init)
1407
os.mkdir(self.abspath(d))
1410
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1415
>>> orig = ScratchBranch(files=["file1", "file2"])
1416
>>> clone = orig.clone()
1417
>>> os.path.samefile(orig.base, clone.base)
1419
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1422
from shutil import copytree
1423
from tempfile import mkdtemp
1426
copytree(self.base, base, symlinks=True)
1427
return ScratchBranch(base=base)
1435
"""Destroy the test branch, removing the scratch directory."""
1436
from shutil import rmtree
1439
mutter("delete ScratchBranch %s" % self.base)
1442
# Work around for shutil.rmtree failing on Windows when
1443
# readonly files are encountered
1444
mutter("hit exception in destroying ScratchBranch: %s" % e)
1445
for root, dirs, files in os.walk(self.base, topdown=False):
1447
os.chmod(os.path.join(root, name), 0700)
1453
######################################################################
1457
def is_control_file(filename):
1458
## FIXME: better check
1459
filename = os.path.normpath(filename)
1460
while filename != '':
1461
head, tail = os.path.split(filename)
1462
## mutter('check %r for control file' % ((head, tail), ))
1463
if tail == bzrlib.BZRDIR:
1465
if filename == head:
1472
def gen_file_id(name):
1473
"""Return new file id.
1475
This should probably generate proper UUIDs, but for the moment we
1476
cope with just randomness because running uuidgen every time is
1479
from binascii import hexlify
1480
from time import time
1482
# get last component
1483
idx = name.rfind('/')
1485
name = name[idx+1 : ]
1486
idx = name.rfind('\\')
1488
name = name[idx+1 : ]
1490
# make it not a hidden file
1491
name = name.lstrip('.')
1493
# remove any wierd characters; we don't escape them but rather
1494
# just pull them out
1495
name = re.sub(r'[^\w.]', '', name)
1497
s = hexlify(rand_bytes(8))
1498
return '-'.join((name, compact_date(time()), s))
1502
"""Return a new tree-root file id."""
1503
return gen_file_id('TREE_ROOT')
1506
def pull_loc(branch):
1507
# TODO: Should perhaps just make attribute be 'base' in
1508
# RemoteBranch and Branch?
1509
if hasattr(branch, "baseurl"):
1510
return branch.baseurl
1515
def copy_branch(branch_from, to_location, revision=None):
1516
"""Copy branch_from into the existing directory to_location.
1519
If not None, only revisions up to this point will be copied.
1520
The head of the new branch will be that revision.
1523
The name of a local directory that exists but is empty.
1525
from bzrlib.merge import merge
1526
from bzrlib.branch import Branch
1528
assert isinstance(branch_from, Branch)
1529
assert isinstance(to_location, basestring)
1531
br_to = Branch(to_location, init=True)
1532
br_to.set_root_id(branch_from.get_root_id())
1533
if revision is None:
1534
revno = branch_from.revno()
1536
revno, rev_id = branch_from.get_revision_info(revision)
1537
br_to.update_revisions(branch_from, stop_revision=revno)
1538
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1539
check_clean=False, ignore_zero=True)
1541
from_location = pull_loc(branch_from)
1542
br_to.set_parent(pull_loc(branch_from))
added
removed
bzrlib/branch.py
