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.
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
self.base = os.path.realpath(base)
196
if not isdir(self.controlfilename('.')):
197
from errors import NotBranchError
198
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
199
['use "bzr init" to initialize a new working tree',
200
'current bzr can only operate from top-of-tree'])
203
self.text_store = ImmutableStore(self.controlfilename('text-store'))
204
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
205
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
209
return '%s(%r)' % (self.__class__.__name__, self.base)
216
if self._lock_mode or self._lock:
217
from warnings import warn
218
warn("branch %r was not explicitly unlocked" % self)
222
def lock_write(self):
224
if self._lock_mode != 'w':
225
from errors import LockError
226
raise LockError("can't upgrade to a write lock from %r" %
228
self._lock_count += 1
230
from bzrlib.lock import WriteLock
232
self._lock = WriteLock(self.controlfilename('branch-lock'))
233
self._lock_mode = 'w'
239
assert self._lock_mode in ('r', 'w'), \
240
"invalid lock mode %r" % self._lock_mode
241
self._lock_count += 1
243
from bzrlib.lock import ReadLock
245
self._lock = ReadLock(self.controlfilename('branch-lock'))
246
self._lock_mode = 'r'
250
if not self._lock_mode:
251
from errors import LockError
252
raise LockError('branch %r is not locked' % (self))
254
if self._lock_count > 1:
255
self._lock_count -= 1
259
self._lock_mode = self._lock_count = None
261
def abspath(self, name):
262
"""Return absolute filename for something in the branch"""
263
return os.path.join(self.base, name)
265
def relpath(self, path):
266
"""Return path relative to this branch of something inside it.
268
Raises an error if path is not in this branch."""
269
return _relpath(self.base, path)
271
def controlfilename(self, file_or_path):
272
"""Return location relative to branch."""
273
if isinstance(file_or_path, basestring):
274
file_or_path = [file_or_path]
275
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
278
def controlfile(self, file_or_path, mode='r'):
279
"""Open a control file for this branch.
281
There are two classes of file in the control directory: text
282
and binary. binary files are untranslated byte streams. Text
283
control files are stored with Unix newlines and in UTF-8, even
284
if the platform or locale defaults are different.
286
Controlfiles should almost never be opened in write mode but
287
rather should be atomically copied and replaced using atomicfile.
290
fn = self.controlfilename(file_or_path)
292
if mode == 'rb' or mode == 'wb':
293
return file(fn, mode)
294
elif mode == 'r' or mode == 'w':
295
# open in binary mode anyhow so there's no newline translation;
296
# codecs uses line buffering by default; don't want that.
298
return codecs.open(fn, mode + 'b', 'utf-8',
301
raise BzrError("invalid controlfile mode %r" % mode)
303
def _make_control(self):
304
from bzrlib.inventory import Inventory
306
os.mkdir(self.controlfilename([]))
307
self.controlfile('README', 'w').write(
308
"This is a Bazaar-NG control directory.\n"
309
"Do not change any files in this directory.\n")
310
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
311
for d in ('text-store', 'inventory-store', 'revision-store'):
312
os.mkdir(self.controlfilename(d))
313
for f in ('revision-history', 'merged-patches',
314
'pending-merged-patches', 'branch-name',
317
self.controlfile(f, 'w').write('')
318
mutter('created control directory in ' + self.base)
320
# if we want per-tree root ids then this is the place to set
321
# them; they're not needed for now and so ommitted for
323
f = self.controlfile('inventory','w')
324
bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
327
def _check_format(self):
328
"""Check this branch format is supported.
330
The current tool only supports the current unstable format.
332
In the future, we might need different in-memory Branch
333
classes to support downlevel branches. But not yet.
335
# This ignores newlines so that we can open branches created
336
# on Windows from Linux and so on. I think it might be better
337
# to always make all internal files in unix format.
338
fmt = self.controlfile('branch-format', 'r').read()
339
fmt = fmt.replace('\r\n', '\n')
340
if fmt != BZR_BRANCH_FORMAT:
341
raise BzrError('sorry, branch format %r not supported' % fmt,
342
['use a different bzr version',
343
'or remove the .bzr directory and "bzr init" again'])
345
def get_root_id(self):
346
"""Return the id of this branches root"""
347
inv = self.read_working_inventory()
348
return inv.root.file_id
350
def set_root_id(self, file_id):
351
inv = self.read_working_inventory()
352
orig_root_id = inv.root.file_id
353
del inv._byid[inv.root.file_id]
354
inv.root.file_id = file_id
355
inv._byid[inv.root.file_id] = inv.root
358
if entry.parent_id in (None, orig_root_id):
359
entry.parent_id = inv.root.file_id
360
self._write_inventory(inv)
362
def read_working_inventory(self):
363
"""Read the working inventory."""
364
from bzrlib.inventory import Inventory
367
# ElementTree does its own conversion from UTF-8, so open in
369
f = self.controlfile('inventory', 'rb')
370
return bzrlib.xml.serializer_v4.read_inventory(f)
375
def _write_inventory(self, inv):
376
"""Update the working inventory.
378
That is to say, the inventory describing changes underway, that
379
will be committed to the next revision.
381
from bzrlib.atomicfile import AtomicFile
385
f = AtomicFile(self.controlfilename('inventory'), 'wb')
387
bzrlib.xml.serializer_v4.write_inventory(inv, f)
394
mutter('wrote working inventory')
397
inventory = property(read_working_inventory, _write_inventory, None,
398
"""Inventory for the working copy.""")
401
def add(self, files, ids=None):
402
"""Make files versioned.
404
Note that the command line normally calls smart_add instead,
405
which can automatically recurse.
407
This puts the files in the Added state, so that they will be
408
recorded by the next commit.
411
List of paths to add, relative to the base of the tree.
414
If set, use these instead of automatically generated ids.
415
Must be the same length as the list of files, but may
416
contain None for ids that are to be autogenerated.
418
TODO: Perhaps have an option to add the ids even if the files do
421
TODO: Perhaps yield the ids and paths as they're added.
423
# TODO: Re-adding a file that is removed in the working copy
424
# should probably put it back with the previous ID.
425
if isinstance(files, basestring):
426
assert(ids is None or isinstance(ids, basestring))
432
ids = [None] * len(files)
434
assert(len(ids) == len(files))
438
inv = self.read_working_inventory()
439
for f,file_id in zip(files, ids):
440
if is_control_file(f):
441
raise BzrError("cannot add control file %s" % quotefn(f))
446
raise BzrError("cannot add top-level %r" % f)
448
fullpath = os.path.normpath(self.abspath(f))
451
kind = file_kind(fullpath)
453
# maybe something better?
454
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
456
if kind != 'file' and kind != 'directory':
457
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
460
file_id = gen_file_id(f)
461
inv.add_path(f, kind=kind, file_id=file_id)
463
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
465
self._write_inventory(inv)
470
def print_file(self, file, revno):
471
"""Print `file` to stdout."""
474
tree = self.revision_tree(self.lookup_revision(revno))
475
# use inventory as it was in that revision
476
file_id = tree.inventory.path2id(file)
478
raise BzrError("%r is not present in revision %s" % (file, revno))
479
tree.print_file(file_id)
484
def remove(self, files, verbose=False):
485
"""Mark nominated files for removal from the inventory.
487
This does not remove their text. This does not run on
489
TODO: Refuse to remove modified files unless --force is given?
491
TODO: Do something useful with directories.
493
TODO: Should this remove the text or not? Tough call; not
494
removing may be useful and the user can just use use rm, and
495
is the opposite of add. Removing it is consistent with most
496
other tools. Maybe an option.
498
## TODO: Normalize names
499
## TODO: Remove nested loops; better scalability
500
if isinstance(files, basestring):
506
tree = self.working_tree()
509
# do this before any modifications
513
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
514
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
516
# having remove it, it must be either ignored or unknown
517
if tree.is_ignored(f):
521
show_status(new_status, inv[fid].kind, quotefn(f))
524
self._write_inventory(inv)
529
# FIXME: this doesn't need to be a branch method
530
def set_inventory(self, new_inventory_list):
531
from bzrlib.inventory import Inventory, InventoryEntry
532
inv = Inventory(self.get_root_id())
533
for path, file_id, parent, kind in new_inventory_list:
534
name = os.path.basename(path)
537
inv.add(InventoryEntry(file_id, name, kind, parent))
538
self._write_inventory(inv)
542
"""Return all unknown files.
544
These are files in the working directory that are not versioned or
545
control files or ignored.
547
>>> b = ScratchBranch(files=['foo', 'foo~'])
548
>>> list(b.unknowns())
551
>>> list(b.unknowns())
554
>>> list(b.unknowns())
557
return self.working_tree().unknowns()
560
def append_revision(self, *revision_ids):
561
from bzrlib.atomicfile import AtomicFile
563
for revision_id in revision_ids:
564
mutter("add {%s} to revision-history" % revision_id)
566
rev_history = self.revision_history()
567
rev_history.extend(revision_ids)
569
f = AtomicFile(self.controlfilename('revision-history'))
571
for rev_id in rev_history:
578
def get_revision_xml_file(self, revision_id):
579
"""Return XML file object for revision object."""
580
if not revision_id or not isinstance(revision_id, basestring):
581
raise InvalidRevisionId(revision_id)
586
return self.revision_store[revision_id]
588
raise bzrlib.errors.NoSuchRevision(self, revision_id)
594
get_revision_xml = get_revision_xml_file
597
def get_revision(self, revision_id):
598
"""Return the Revision object for a named revision"""
599
xml_file = self.get_revision_xml_file(revision_id)
602
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
603
except SyntaxError, e:
604
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
608
assert r.revision_id == revision_id
612
def get_revision_delta(self, revno):
613
"""Return the delta for one revision.
615
The delta is relative to its mainline predecessor, or the
616
empty tree for revision 1.
618
assert isinstance(revno, int)
619
rh = self.revision_history()
620
if not (1 <= revno <= len(rh)):
621
raise InvalidRevisionNumber(revno)
623
# revno is 1-based; list is 0-based
625
new_tree = self.revision_tree(rh[revno-1])
627
old_tree = EmptyTree()
629
old_tree = self.revision_tree(rh[revno-2])
631
return compare_trees(old_tree, new_tree)
635
def get_revision_sha1(self, revision_id):
636
"""Hash the stored value of a revision, and return it."""
637
# In the future, revision entries will be signed. At that
638
# point, it is probably best *not* to include the signature
639
# in the revision hash. Because that lets you re-sign
640
# the revision, (add signatures/remove signatures) and still
641
# have all hash pointers stay consistent.
642
# But for now, just hash the contents.
643
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
646
def get_inventory(self, inventory_id):
647
"""Get Inventory object by hash.
649
TODO: Perhaps for this and similar methods, take a revision
650
parameter which can be either an integer revno or a
652
from bzrlib.inventory import Inventory
654
f = self.get_inventory_xml_file(inventory_id)
655
return bzrlib.xml.serializer_v4.read_inventory(f)
658
def get_inventory_xml(self, inventory_id):
659
"""Get inventory XML as a file object."""
660
return self.inventory_store[inventory_id]
662
get_inventory_xml_file = get_inventory_xml
665
def get_inventory_sha1(self, inventory_id):
666
"""Return the sha1 hash of the inventory entry
668
return sha_file(self.get_inventory_xml(inventory_id))
671
def get_revision_inventory(self, revision_id):
672
"""Return inventory of a past revision."""
673
# bzr 0.0.6 imposes the constraint that the inventory_id
674
# must be the same as its revision, so this is trivial.
675
if revision_id == None:
676
from bzrlib.inventory import Inventory
677
return Inventory(self.get_root_id())
679
return self.get_inventory(revision_id)
682
def revision_history(self):
683
"""Return sequence of revision hashes on to this branch.
685
>>> ScratchBranch().revision_history()
690
return [l.rstrip('\r\n') for l in
691
self.controlfile('revision-history', 'r').readlines()]
696
def common_ancestor(self, other, self_revno=None, other_revno=None):
699
>>> sb = ScratchBranch(files=['foo', 'foo~'])
700
>>> sb.common_ancestor(sb) == (None, None)
702
>>> commit.commit(sb, "Committing first revision", verbose=False)
703
>>> sb.common_ancestor(sb)[0]
705
>>> clone = sb.clone()
706
>>> commit.commit(sb, "Committing second revision", verbose=False)
707
>>> sb.common_ancestor(sb)[0]
709
>>> sb.common_ancestor(clone)[0]
711
>>> commit.commit(clone, "Committing divergent second revision",
713
>>> sb.common_ancestor(clone)[0]
715
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
717
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
719
>>> clone2 = sb.clone()
720
>>> sb.common_ancestor(clone2)[0]
722
>>> sb.common_ancestor(clone2, self_revno=1)[0]
724
>>> sb.common_ancestor(clone2, other_revno=1)[0]
727
my_history = self.revision_history()
728
other_history = other.revision_history()
729
if self_revno is None:
730
self_revno = len(my_history)
731
if other_revno is None:
732
other_revno = len(other_history)
733
indices = range(min((self_revno, other_revno)))
736
if my_history[r] == other_history[r]:
737
return r+1, my_history[r]
742
"""Return current revision number for this branch.
744
That is equivalent to the number of revisions committed to
747
return len(self.revision_history())
750
def last_patch(self):
751
"""Return last patch hash, or None if no history.
753
ph = self.revision_history()
760
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
762
If self and other have not diverged, return a list of the revisions
763
present in other, but missing from self.
765
>>> from bzrlib.commit import commit
766
>>> bzrlib.trace.silent = True
767
>>> br1 = ScratchBranch()
768
>>> br2 = ScratchBranch()
769
>>> br1.missing_revisions(br2)
771
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
772
>>> br1.missing_revisions(br2)
774
>>> br2.missing_revisions(br1)
776
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
777
>>> br1.missing_revisions(br2)
779
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
780
>>> br1.missing_revisions(br2)
782
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
783
>>> br1.missing_revisions(br2)
784
Traceback (most recent call last):
785
DivergedBranches: These branches have diverged.
787
self_history = self.revision_history()
788
self_len = len(self_history)
789
other_history = other.revision_history()
790
other_len = len(other_history)
791
common_index = min(self_len, other_len) -1
792
if common_index >= 0 and \
793
self_history[common_index] != other_history[common_index]:
794
raise DivergedBranches(self, other)
796
if stop_revision is None:
797
stop_revision = other_len
798
elif stop_revision > other_len:
799
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
801
return other_history[self_len:stop_revision]
804
def update_revisions(self, other, stop_revision=None):
805
"""Pull in all new revisions from other branch.
807
from bzrlib.fetch import greedy_fetch
808
from bzrlib.revision import get_intervening_revisions
810
pb = bzrlib.ui.ui_factory.progress_bar()
811
pb.update('comparing histories')
814
revision_ids = self.missing_revisions(other, stop_revision)
815
except DivergedBranches, e:
817
if stop_revision is None:
818
end_revision = other.last_patch()
819
revision_ids = get_intervening_revisions(self.last_patch(),
821
assert self.last_patch() not in revision_ids
822
except bzrlib.errors.NotAncestor:
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 lookup_revision(self, revision):
889
"""Return the revision identifier for a given revision information."""
890
revno, info = self._get_revision_info(revision)
894
def revision_id_to_revno(self, revision_id):
895
"""Given a revision id, return its revno"""
896
history = self.revision_history()
898
return history.index(revision_id) + 1
900
raise bzrlib.errors.NoSuchRevision(self, revision_id)
903
def get_revision_info(self, revision):
904
"""Return (revno, revision id) for revision identifier.
906
revision can be an integer, in which case it is assumed to be revno (though
907
this will translate negative values into positive ones)
908
revision can also be a string, in which case it is parsed for something like
909
'date:' or 'revid:' etc.
911
revno, rev_id = self._get_revision_info(revision)
913
raise bzrlib.errors.NoSuchRevision(self, revision)
916
def get_rev_id(self, revno, history=None):
917
"""Find the revision id of the specified revno."""
921
history = self.revision_history()
922
elif revno <= 0 or revno > len(history):
923
raise bzrlib.errors.NoSuchRevision(self, revno)
924
return history[revno - 1]
926
def _get_revision_info(self, revision):
927
"""Return (revno, revision id) for revision specifier.
929
revision can be an integer, in which case it is assumed to be revno
930
(though this will translate negative values into positive ones)
931
revision can also be a string, in which case it is parsed for something
932
like 'date:' or 'revid:' etc.
934
A revid is always returned. If it is None, the specifier referred to
935
the null revision. If the revid does not occur in the revision
936
history, revno will be None.
942
try:# Convert to int if possible
943
revision = int(revision)
946
revs = self.revision_history()
947
if isinstance(revision, int):
949
revno = len(revs) + revision + 1
952
rev_id = self.get_rev_id(revno, revs)
953
elif isinstance(revision, basestring):
954
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
955
if revision.startswith(prefix):
956
result = func(self, revs, revision)
958
revno, rev_id = result
961
rev_id = self.get_rev_id(revno, revs)
964
raise BzrError('No namespace registered for string: %r' %
967
raise TypeError('Unhandled revision type %s' % revision)
971
raise bzrlib.errors.NoSuchRevision(self, revision)
974
def _namespace_revno(self, revs, revision):
975
"""Lookup a revision by revision number"""
976
assert revision.startswith('revno:')
978
return (int(revision[6:]),)
981
REVISION_NAMESPACES['revno:'] = _namespace_revno
983
def _namespace_revid(self, revs, revision):
984
assert revision.startswith('revid:')
985
rev_id = revision[len('revid:'):]
987
return revs.index(rev_id) + 1, rev_id
990
REVISION_NAMESPACES['revid:'] = _namespace_revid
992
def _namespace_last(self, revs, revision):
993
assert revision.startswith('last:')
995
offset = int(revision[5:])
1000
raise BzrError('You must supply a positive value for --revision last:XXX')
1001
return (len(revs) - offset + 1,)
1002
REVISION_NAMESPACES['last:'] = _namespace_last
1004
def _namespace_tag(self, revs, revision):
1005
assert revision.startswith('tag:')
1006
raise BzrError('tag: namespace registered, but not implemented.')
1007
REVISION_NAMESPACES['tag:'] = _namespace_tag
1009
def _namespace_date(self, revs, revision):
1010
assert revision.startswith('date:')
1012
# Spec for date revisions:
1014
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
1015
# it can also start with a '+/-/='. '+' says match the first
1016
# entry after the given date. '-' is match the first entry before the date
1017
# '=' is match the first entry after, but still on the given date.
1019
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
1020
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
1021
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
1022
# May 13th, 2005 at 0:00
1024
# So the proper way of saying 'give me all entries for today' is:
1025
# -r {date:+today}:{date:-tomorrow}
1026
# The default is '=' when not supplied
1029
if val[:1] in ('+', '-', '='):
1030
match_style = val[:1]
1033
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1034
if val.lower() == 'yesterday':
1035
dt = today - datetime.timedelta(days=1)
1036
elif val.lower() == 'today':
1038
elif val.lower() == 'tomorrow':
1039
dt = today + datetime.timedelta(days=1)
1042
# This should be done outside the function to avoid recompiling it.
1043
_date_re = re.compile(
1044
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1046
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1048
m = _date_re.match(val)
1049
if not m or (not m.group('date') and not m.group('time')):
1050
raise BzrError('Invalid revision date %r' % revision)
1053
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1055
year, month, day = today.year, today.month, today.day
1057
hour = int(m.group('hour'))
1058
minute = int(m.group('minute'))
1059
if m.group('second'):
1060
second = int(m.group('second'))
1064
hour, minute, second = 0,0,0
1066
dt = datetime.datetime(year=year, month=month, day=day,
1067
hour=hour, minute=minute, second=second)
1071
if match_style == '-':
1073
elif match_style == '=':
1074
last = dt + datetime.timedelta(days=1)
1077
for i in range(len(revs)-1, -1, -1):
1078
r = self.get_revision(revs[i])
1079
# TODO: Handle timezone.
1080
dt = datetime.datetime.fromtimestamp(r.timestamp)
1081
if first >= dt and (last is None or dt >= last):
1084
for i in range(len(revs)):
1085
r = self.get_revision(revs[i])
1086
# TODO: Handle timezone.
1087
dt = datetime.datetime.fromtimestamp(r.timestamp)
1088
if first <= dt and (last is None or dt <= last):
1090
REVISION_NAMESPACES['date:'] = _namespace_date
1092
def revision_tree(self, revision_id):
1093
"""Return Tree for a revision on this branch.
1095
`revision_id` may be None for the null revision, in which case
1096
an `EmptyTree` is returned."""
1097
# TODO: refactor this to use an existing revision object
1098
# so we don't need to read it in twice.
1099
if revision_id == None:
1102
inv = self.get_revision_inventory(revision_id)
1103
return RevisionTree(self.text_store, inv)
1106
def working_tree(self):
1107
"""Return a `Tree` for the working copy."""
1108
from workingtree import WorkingTree
1109
return WorkingTree(self.base, self.read_working_inventory())
1112
def basis_tree(self):
1113
"""Return `Tree` object for last revision.
1115
If there are no revisions yet, return an `EmptyTree`.
1117
r = self.last_patch()
1121
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1125
def rename_one(self, from_rel, to_rel):
1128
This can change the directory or the filename or both.
1132
tree = self.working_tree()
1133
inv = tree.inventory
1134
if not tree.has_filename(from_rel):
1135
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1136
if tree.has_filename(to_rel):
1137
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1139
file_id = inv.path2id(from_rel)
1141
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1143
if inv.path2id(to_rel):
1144
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1146
to_dir, to_tail = os.path.split(to_rel)
1147
to_dir_id = inv.path2id(to_dir)
1148
if to_dir_id == None and to_dir != '':
1149
raise BzrError("can't determine destination directory id for %r" % to_dir)
1151
mutter("rename_one:")
1152
mutter(" file_id {%s}" % file_id)
1153
mutter(" from_rel %r" % from_rel)
1154
mutter(" to_rel %r" % to_rel)
1155
mutter(" to_dir %r" % to_dir)
1156
mutter(" to_dir_id {%s}" % to_dir_id)
1158
inv.rename(file_id, to_dir_id, to_tail)
1160
from_abs = self.abspath(from_rel)
1161
to_abs = self.abspath(to_rel)
1163
os.rename(from_abs, to_abs)
1165
raise BzrError("failed to rename %r to %r: %s"
1166
% (from_abs, to_abs, e[1]),
1167
["rename rolled back"])
1169
self._write_inventory(inv)
1174
def move(self, from_paths, to_name):
1177
to_name must exist as a versioned directory.
1179
If to_name exists and is a directory, the files are moved into
1180
it, keeping their old names. If it is a directory,
1182
Note that to_name is only the last component of the new name;
1183
this doesn't change the directory.
1185
This returns a list of (from_path, to_path) pairs for each
1186
entry that is moved.
1191
## TODO: Option to move IDs only
1192
assert not isinstance(from_paths, basestring)
1193
tree = self.working_tree()
1194
inv = tree.inventory
1195
to_abs = self.abspath(to_name)
1196
if not isdir(to_abs):
1197
raise BzrError("destination %r is not a directory" % to_abs)
1198
if not tree.has_filename(to_name):
1199
raise BzrError("destination %r not in working directory" % to_abs)
1200
to_dir_id = inv.path2id(to_name)
1201
if to_dir_id == None and to_name != '':
1202
raise BzrError("destination %r is not a versioned directory" % to_name)
1203
to_dir_ie = inv[to_dir_id]
1204
if to_dir_ie.kind not in ('directory', 'root_directory'):
1205
raise BzrError("destination %r is not a directory" % to_abs)
1207
to_idpath = inv.get_idpath(to_dir_id)
1209
for f in from_paths:
1210
if not tree.has_filename(f):
1211
raise BzrError("%r does not exist in working tree" % f)
1212
f_id = inv.path2id(f)
1214
raise BzrError("%r is not versioned" % f)
1215
name_tail = splitpath(f)[-1]
1216
dest_path = appendpath(to_name, name_tail)
1217
if tree.has_filename(dest_path):
1218
raise BzrError("destination %r already exists" % dest_path)
1219
if f_id in to_idpath:
1220
raise BzrError("can't move %r to a subdirectory of itself" % f)
1222
# OK, so there's a race here, it's possible that someone will
1223
# create a file in this interval and then the rename might be
1224
# left half-done. But we should have caught most problems.
1226
for f in from_paths:
1227
name_tail = splitpath(f)[-1]
1228
dest_path = appendpath(to_name, name_tail)
1229
result.append((f, dest_path))
1230
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1232
os.rename(self.abspath(f), self.abspath(dest_path))
1234
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1235
["rename rolled back"])
1237
self._write_inventory(inv)
1244
def revert(self, filenames, old_tree=None, backups=True):
1245
"""Restore selected files to the versions from a previous tree.
1248
If true (default) backups are made of files before
1251
from bzrlib.errors import NotVersionedError, BzrError
1252
from bzrlib.atomicfile import AtomicFile
1253
from bzrlib.osutils import backup_file
1255
inv = self.read_working_inventory()
1256
if old_tree is None:
1257
old_tree = self.basis_tree()
1258
old_inv = old_tree.inventory
1261
for fn in filenames:
1262
file_id = inv.path2id(fn)
1264
raise NotVersionedError("not a versioned file", fn)
1265
if not old_inv.has_id(file_id):
1266
raise BzrError("file not present in old tree", fn, file_id)
1267
nids.append((fn, file_id))
1269
# TODO: Rename back if it was previously at a different location
1271
# TODO: If given a directory, restore the entire contents from
1272
# the previous version.
1274
# TODO: Make a backup to a temporary file.
1276
# TODO: If the file previously didn't exist, delete it?
1277
for fn, file_id in nids:
1280
f = AtomicFile(fn, 'wb')
1282
f.write(old_tree.get_file(file_id).read())
1288
def pending_merges(self):
1289
"""Return a list of pending merges.
1291
These are revisions that have been merged into the working
1292
directory but not yet committed.
1294
cfn = self.controlfilename('pending-merges')
1295
if not os.path.exists(cfn):
1298
for l in self.controlfile('pending-merges', 'r').readlines():
1299
p.append(l.rstrip('\n'))
1303
def add_pending_merge(self, revision_id):
1304
from bzrlib.revision import validate_revision_id
1306
validate_revision_id(revision_id)
1308
p = self.pending_merges()
1309
if revision_id in p:
1311
p.append(revision_id)
1312
self.set_pending_merges(p)
1315
def set_pending_merges(self, rev_list):
1316
from bzrlib.atomicfile import AtomicFile
1319
f = AtomicFile(self.controlfilename('pending-merges'))
1330
def get_parent(self):
1331
"""Return the parent location of the branch.
1333
This is the default location for push/pull/missing. The usual
1334
pattern is that the user can override it by specifying a
1338
_locs = ['parent', 'pull', 'x-pull']
1341
return self.controlfile(l, 'r').read().strip('\n')
1343
if e.errno != errno.ENOENT:
1348
def set_parent(self, url):
1349
# TODO: Maybe delete old location files?
1350
from bzrlib.atomicfile import AtomicFile
1353
f = AtomicFile(self.controlfilename('parent'))
1362
def check_revno(self, revno):
1364
Check whether a revno corresponds to any revision.
1365
Zero (the NULL revision) is considered valid.
1368
self.check_real_revno(revno)
1370
def check_real_revno(self, revno):
1372
Check whether a revno corresponds to a real revision.
1373
Zero (the NULL revision) is considered invalid
1375
if revno < 1 or revno > self.revno():
1376
raise InvalidRevisionNumber(revno)
1381
class ScratchBranch(Branch):
1382
"""Special test class: a branch that cleans up after itself.
1384
>>> b = ScratchBranch()
1392
def __init__(self, files=[], dirs=[], base=None):
1393
"""Make a test branch.
1395
This creates a temporary directory and runs init-tree in it.
1397
If any files are listed, they are created in the working copy.
1399
from tempfile import mkdtemp
1404
Branch.__init__(self, base, init=init)
1406
os.mkdir(self.abspath(d))
1409
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1414
>>> orig = ScratchBranch(files=["file1", "file2"])
1415
>>> clone = orig.clone()
1416
>>> os.path.samefile(orig.base, clone.base)
1418
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1421
from shutil import copytree
1422
from tempfile import mkdtemp
1425
copytree(self.base, base, symlinks=True)
1426
return ScratchBranch(base=base)
1434
"""Destroy the test branch, removing the scratch directory."""
1435
from shutil import rmtree
1438
mutter("delete ScratchBranch %s" % self.base)
1441
# Work around for shutil.rmtree failing on Windows when
1442
# readonly files are encountered
1443
mutter("hit exception in destroying ScratchBranch: %s" % e)
1444
for root, dirs, files in os.walk(self.base, topdown=False):
1446
os.chmod(os.path.join(root, name), 0700)
1452
######################################################################
1456
def is_control_file(filename):
1457
## FIXME: better check
1458
filename = os.path.normpath(filename)
1459
while filename != '':
1460
head, tail = os.path.split(filename)
1461
## mutter('check %r for control file' % ((head, tail), ))
1462
if tail == bzrlib.BZRDIR:
1464
if filename == head:
1471
def gen_file_id(name):
1472
"""Return new file id.
1474
This should probably generate proper UUIDs, but for the moment we
1475
cope with just randomness because running uuidgen every time is
1478
from binascii import hexlify
1479
from time import time
1481
# get last component
1482
idx = name.rfind('/')
1484
name = name[idx+1 : ]
1485
idx = name.rfind('\\')
1487
name = name[idx+1 : ]
1489
# make it not a hidden file
1490
name = name.lstrip('.')
1492
# remove any wierd characters; we don't escape them but rather
1493
# just pull them out
1494
name = re.sub(r'[^\w.]', '', name)
1496
s = hexlify(rand_bytes(8))
1497
return '-'.join((name, compact_date(time()), s))
1501
"""Return a new tree-root file id."""
1502
return gen_file_id('TREE_ROOT')
1505
def pull_loc(branch):
1506
# TODO: Should perhaps just make attribute be 'base' in
1507
# RemoteBranch and Branch?
1508
if hasattr(branch, "baseurl"):
1509
return branch.baseurl
1514
def copy_branch(branch_from, to_location, revision=None):
1515
"""Copy branch_from into the existing directory to_location.
1518
If not None, only revisions up to this point will be copied.
1519
The head of the new branch will be that revision.
1522
The name of a local directory that exists but is empty.
1524
from bzrlib.merge import merge
1525
from bzrlib.branch import Branch
1527
assert isinstance(branch_from, Branch)
1528
assert isinstance(to_location, basestring)
1530
br_to = Branch(to_location, init=True)
1531
br_to.set_root_id(branch_from.get_root_id())
1532
if revision is None:
1533
revno = branch_from.revno()
1535
revno, rev_id = branch_from.get_revision_info(revision)
1536
br_to.update_revisions(branch_from, stop_revision=revno)
1537
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1538
check_clean=False, ignore_zero=True)
1540
from_location = pull_loc(branch_from)
1541
br_to.set_parent(pull_loc(branch_from))
added
removed
bzrlib/branch.py
