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
# 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://')):
52
from bzrlib.remotebranch import RemoteBranch
53
return RemoteBranch(f, **args)
55
return Branch(f, **args)
58
def find_cached_branch(f, cache_root, **args):
59
from bzrlib.remotebranch import RemoteBranch
60
br = find_branch(f, **args)
61
def cacheify(br, store_name):
62
from bzrlib.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
raise NotBranchError("path %r is not within branch %r" % (rp, base))
102
def find_branch_root(f=None):
103
"""Find the branch root enclosing f, or pwd.
105
f may be a filename or a URL.
107
It is not necessary that f exists.
109
Basically we keep looking up until we find the control directory or
110
run into the root. If there isn't one, raises NotBranchError.
114
elif hasattr(os.path, 'realpath'):
115
f = os.path.realpath(f)
117
f = os.path.abspath(f)
118
if not os.path.exists(f):
119
raise BzrError('%r does not exist' % f)
125
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
127
head, tail = os.path.split(f)
129
# reached the root, whatever that may be
130
raise NotBranchError('%s is not in a branch' % orig_f)
136
######################################################################
139
class Branch(object):
140
"""Branch holding a history of revisions.
143
Base directory of the branch.
149
If _lock_mode is true, a positive count of the number of times the
153
Lock object from bzrlib.lock.
160
# Map some sort of prefix into a namespace
161
# stuff like "revno:10", "revid:", etc.
162
# This should match a prefix with a function which accepts
163
REVISION_NAMESPACES = {}
165
def __init__(self, base, init=False, find_root=True):
166
"""Create new branch object at a particular location.
168
base -- Base directory for the branch. May be a file:// url.
170
init -- If True, create new control files in a previously
171
unversioned directory. If False, the branch must already
174
find_root -- If true and init is false, find the root of the
175
existing branch containing base.
177
In the test suite, creation of new trees is tested using the
178
`ScratchBranch` class.
180
from bzrlib.store import ImmutableStore
182
self.base = os.path.realpath(base)
185
self.base = find_branch_root(base)
187
if base.startswith("file://"):
189
self.base = os.path.realpath(base)
190
if not isdir(self.controlfilename('.')):
191
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
192
['use "bzr init" to initialize a new working tree',
193
'current bzr can only operate from top-of-tree'])
196
self.text_store = ImmutableStore(self.controlfilename('text-store'))
197
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
198
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
202
return '%s(%r)' % (self.__class__.__name__, self.base)
209
if self._lock_mode or self._lock:
210
from bzrlib.warnings import warn
211
warn("branch %r was not explicitly unlocked" % self)
214
def lock_write(self):
216
if self._lock_mode != 'w':
217
from bzrlib.errors import LockError
218
raise LockError("can't upgrade to a write lock from %r" %
220
self._lock_count += 1
222
from bzrlib.lock import WriteLock
224
self._lock = WriteLock(self.controlfilename('branch-lock'))
225
self._lock_mode = 'w'
231
assert self._lock_mode in ('r', 'w'), \
232
"invalid lock mode %r" % self._lock_mode
233
self._lock_count += 1
235
from bzrlib.lock import ReadLock
237
self._lock = ReadLock(self.controlfilename('branch-lock'))
238
self._lock_mode = 'r'
242
if not self._lock_mode:
243
from bzrlib.errors import LockError
244
raise LockError('branch %r is not locked' % (self))
246
if self._lock_count > 1:
247
self._lock_count -= 1
251
self._lock_mode = self._lock_count = None
253
def abspath(self, name):
254
"""Return absolute filename for something in the branch"""
255
return os.path.join(self.base, name)
257
def relpath(self, path):
258
"""Return path relative to this branch of something inside it.
260
Raises an error if path is not in this branch."""
261
return _relpath(self.base, path)
263
def controlfilename(self, file_or_path):
264
"""Return location relative to branch."""
265
if isinstance(file_or_path, basestring):
266
file_or_path = [file_or_path]
267
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
270
def controlfile(self, file_or_path, mode='r'):
271
"""Open a control file for this branch.
273
There are two classes of file in the control directory: text
274
and binary. binary files are untranslated byte streams. Text
275
control files are stored with Unix newlines and in UTF-8, even
276
if the platform or locale defaults are different.
278
Controlfiles should almost never be opened in write mode but
279
rather should be atomically copied and replaced using atomicfile.
282
fn = self.controlfilename(file_or_path)
284
if mode == 'rb' or mode == 'wb':
285
return file(fn, mode)
286
elif mode == 'r' or mode == 'w':
287
# open in binary mode anyhow so there's no newline translation;
288
# codecs uses line buffering by default; don't want that.
290
return codecs.open(fn, mode + 'b', 'utf-8',
293
raise BzrError("invalid controlfile mode %r" % mode)
295
def _make_control(self):
296
from bzrlib.inventory import Inventory
298
os.mkdir(self.controlfilename([]))
299
self.controlfile('README', 'w').write(
300
"This is a Bazaar-NG control directory.\n"
301
"Do not change any files in this directory.\n")
302
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
303
for d in ('text-store', 'inventory-store', 'revision-store'):
304
os.mkdir(self.controlfilename(d))
305
for f in ('revision-history', 'merged-patches',
306
'pending-merged-patches', 'branch-name',
309
self.controlfile(f, 'w').write('')
310
mutter('created control directory in ' + self.base)
312
# if we want per-tree root ids then this is the place to set
313
# them; they're not needed for now and so ommitted for
315
f = self.controlfile('inventory','w')
316
bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
319
def _check_format(self):
320
"""Check this branch format is supported.
322
The current tool only supports the current unstable format.
324
In the future, we might need different in-memory Branch
325
classes to support downlevel branches. But not yet.
327
# This ignores newlines so that we can open branches created
328
# on Windows from Linux and so on. I think it might be better
329
# to always make all internal files in unix format.
330
fmt = self.controlfile('branch-format', 'r').read()
331
fmt = fmt.replace('\r\n', '\n')
332
if fmt != BZR_BRANCH_FORMAT:
333
raise BzrError('sorry, branch format %r not supported' % fmt,
334
['use a different bzr version',
335
'or remove the .bzr directory and "bzr init" again'])
337
def get_root_id(self):
338
"""Return the id of this branches root"""
339
inv = self.read_working_inventory()
340
return inv.root.file_id
342
def set_root_id(self, file_id):
343
inv = self.read_working_inventory()
344
orig_root_id = inv.root.file_id
345
del inv._byid[inv.root.file_id]
346
inv.root.file_id = file_id
347
inv._byid[inv.root.file_id] = inv.root
350
if entry.parent_id in (None, orig_root_id):
351
entry.parent_id = inv.root.file_id
352
self._write_inventory(inv)
354
def read_working_inventory(self):
355
"""Read the working inventory."""
356
from bzrlib.inventory import Inventory
359
# ElementTree does its own conversion from UTF-8, so open in
361
f = self.controlfile('inventory', 'rb')
362
return bzrlib.xml.serializer_v4.read_inventory(f)
367
def _write_inventory(self, inv):
368
"""Update the working inventory.
370
That is to say, the inventory describing changes underway, that
371
will be committed to the next revision.
373
from bzrlib.atomicfile import AtomicFile
377
f = AtomicFile(self.controlfilename('inventory'), 'wb')
379
bzrlib.xml.serializer_v4.write_inventory(inv, f)
386
mutter('wrote working inventory')
389
inventory = property(read_working_inventory, _write_inventory, None,
390
"""Inventory for the working copy.""")
393
def add(self, files, ids=None):
394
"""Make files versioned.
396
Note that the command line normally calls smart_add instead,
397
which can automatically recurse.
399
This puts the files in the Added state, so that they will be
400
recorded by the next commit.
403
List of paths to add, relative to the base of the tree.
406
If set, use these instead of automatically generated ids.
407
Must be the same length as the list of files, but may
408
contain None for ids that are to be autogenerated.
410
TODO: Perhaps have an option to add the ids even if the files do
413
TODO: Perhaps yield the ids and paths as they're added.
415
# TODO: Re-adding a file that is removed in the working copy
416
# should probably put it back with the previous ID.
417
if isinstance(files, basestring):
418
assert(ids is None or isinstance(ids, basestring))
424
ids = [None] * len(files)
426
assert(len(ids) == len(files))
430
inv = self.read_working_inventory()
431
for f,file_id in zip(files, ids):
432
if is_control_file(f):
433
raise BzrError("cannot add control file %s" % quotefn(f))
438
raise BzrError("cannot add top-level %r" % f)
440
fullpath = os.path.normpath(self.abspath(f))
443
kind = file_kind(fullpath)
445
# maybe something better?
446
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
448
if kind != 'file' and kind != 'directory':
449
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
452
file_id = gen_file_id(f)
453
inv.add_path(f, kind=kind, file_id=file_id)
455
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
457
self._write_inventory(inv)
462
def print_file(self, file, revno):
463
"""Print `file` to stdout."""
466
tree = self.revision_tree(self.lookup_revision(revno))
467
# use inventory as it was in that revision
468
file_id = tree.inventory.path2id(file)
470
raise BzrError("%r is not present in revision %s" % (file, revno))
471
tree.print_file(file_id)
476
def remove(self, files, verbose=False):
477
"""Mark nominated files for removal from the inventory.
479
This does not remove their text. This does not run on
481
TODO: Refuse to remove modified files unless --force is given?
483
TODO: Do something useful with directories.
485
TODO: Should this remove the text or not? Tough call; not
486
removing may be useful and the user can just use use rm, and
487
is the opposite of add. Removing it is consistent with most
488
other tools. Maybe an option.
490
## TODO: Normalize names
491
## TODO: Remove nested loops; better scalability
492
if isinstance(files, basestring):
498
tree = self.working_tree()
501
# do this before any modifications
505
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
506
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
508
# having remove it, it must be either ignored or unknown
509
if tree.is_ignored(f):
513
show_status(new_status, inv[fid].kind, quotefn(f))
516
self._write_inventory(inv)
521
# FIXME: this doesn't need to be a branch method
522
def set_inventory(self, new_inventory_list):
523
from bzrlib.inventory import Inventory, InventoryEntry
524
inv = Inventory(self.get_root_id())
525
for path, file_id, parent, kind in new_inventory_list:
526
name = os.path.basename(path)
529
inv.add(InventoryEntry(file_id, name, kind, parent))
530
self._write_inventory(inv)
534
"""Return all unknown files.
536
These are files in the working directory that are not versioned or
537
control files or ignored.
539
>>> b = ScratchBranch(files=['foo', 'foo~'])
540
>>> list(b.unknowns())
543
>>> list(b.unknowns())
546
>>> list(b.unknowns())
549
return self.working_tree().unknowns()
552
def append_revision(self, *revision_ids):
553
from bzrlib.atomicfile import AtomicFile
555
for revision_id in revision_ids:
556
mutter("add {%s} to revision-history" % revision_id)
558
rev_history = self.revision_history()
559
rev_history.extend(revision_ids)
561
f = AtomicFile(self.controlfilename('revision-history'))
563
for rev_id in rev_history:
570
def get_revision_xml_file(self, revision_id):
571
"""Return XML file object for revision object."""
572
if not revision_id or not isinstance(revision_id, basestring):
573
raise InvalidRevisionId(revision_id)
578
return self.revision_store[revision_id]
580
raise bzrlib.errors.NoSuchRevision(self, revision_id)
586
get_revision_xml = get_revision_xml_file
589
def get_revision(self, revision_id):
590
"""Return the Revision object for a named revision"""
591
xml_file = self.get_revision_xml_file(revision_id)
594
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
595
except SyntaxError, e:
596
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
600
assert r.revision_id == revision_id
604
def get_revision_delta(self, revno):
605
"""Return the delta for one revision.
607
The delta is relative to its mainline predecessor, or the
608
empty tree for revision 1.
610
assert isinstance(revno, int)
611
rh = self.revision_history()
612
if not (1 <= revno <= len(rh)):
613
raise InvalidRevisionNumber(revno)
615
# revno is 1-based; list is 0-based
617
new_tree = self.revision_tree(rh[revno-1])
619
old_tree = EmptyTree()
621
old_tree = self.revision_tree(rh[revno-2])
623
return compare_trees(old_tree, new_tree)
627
def get_revision_sha1(self, revision_id):
628
"""Hash the stored value of a revision, and return it."""
629
# In the future, revision entries will be signed. At that
630
# point, it is probably best *not* to include the signature
631
# in the revision hash. Because that lets you re-sign
632
# the revision, (add signatures/remove signatures) and still
633
# have all hash pointers stay consistent.
634
# But for now, just hash the contents.
635
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
638
def get_inventory(self, inventory_id):
639
"""Get Inventory object by hash.
641
TODO: Perhaps for this and similar methods, take a revision
642
parameter which can be either an integer revno or a
644
from bzrlib.inventory import Inventory
646
f = self.get_inventory_xml_file(inventory_id)
647
return bzrlib.xml.serializer_v4.read_inventory(f)
650
def get_inventory_xml(self, inventory_id):
651
"""Get inventory XML as a file object."""
652
return self.inventory_store[inventory_id]
654
get_inventory_xml_file = get_inventory_xml
657
def get_inventory_sha1(self, inventory_id):
658
"""Return the sha1 hash of the inventory entry
660
return sha_file(self.get_inventory_xml(inventory_id))
663
def get_revision_inventory(self, revision_id):
664
"""Return inventory of a past revision."""
665
# bzr 0.0.6 imposes the constraint that the inventory_id
666
# must be the same as its revision, so this is trivial.
667
if revision_id == None:
668
from bzrlib.inventory import Inventory
669
return Inventory(self.get_root_id())
671
return self.get_inventory(revision_id)
674
def revision_history(self):
675
"""Return sequence of revision hashes on to this branch.
677
>>> ScratchBranch().revision_history()
682
return [l.rstrip('\r\n') for l in
683
self.controlfile('revision-history', 'r').readlines()]
688
def common_ancestor(self, other, self_revno=None, other_revno=None):
690
>>> from bzrlib.commit import commit
691
>>> sb = ScratchBranch(files=['foo', 'foo~'])
692
>>> sb.common_ancestor(sb) == (None, None)
694
>>> commit(sb, "Committing first revision", verbose=False)
695
>>> sb.common_ancestor(sb)[0]
697
>>> clone = sb.clone()
698
>>> commit(sb, "Committing second revision", verbose=False)
699
>>> sb.common_ancestor(sb)[0]
701
>>> sb.common_ancestor(clone)[0]
703
>>> commit(clone, "Committing divergent second revision",
705
>>> sb.common_ancestor(clone)[0]
707
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
709
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
711
>>> clone2 = sb.clone()
712
>>> sb.common_ancestor(clone2)[0]
714
>>> sb.common_ancestor(clone2, self_revno=1)[0]
716
>>> sb.common_ancestor(clone2, other_revno=1)[0]
719
my_history = self.revision_history()
720
other_history = other.revision_history()
721
if self_revno is None:
722
self_revno = len(my_history)
723
if other_revno is None:
724
other_revno = len(other_history)
725
indices = range(min((self_revno, other_revno)))
728
if my_history[r] == other_history[r]:
729
return r+1, my_history[r]
734
"""Return current revision number for this branch.
736
That is equivalent to the number of revisions committed to
739
return len(self.revision_history())
742
def last_patch(self):
743
"""Return last patch hash, or None if no history.
745
ph = self.revision_history()
752
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
754
If self and other have not diverged, return a list of the revisions
755
present in other, but missing from self.
757
>>> from bzrlib.commit import commit
758
>>> bzrlib.trace.silent = True
759
>>> br1 = ScratchBranch()
760
>>> br2 = ScratchBranch()
761
>>> br1.missing_revisions(br2)
763
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
764
>>> br1.missing_revisions(br2)
766
>>> br2.missing_revisions(br1)
768
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
769
>>> br1.missing_revisions(br2)
771
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
772
>>> br1.missing_revisions(br2)
774
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
775
>>> br1.missing_revisions(br2)
776
Traceback (most recent call last):
777
DivergedBranches: These branches have diverged.
779
self_history = self.revision_history()
780
self_len = len(self_history)
781
other_history = other.revision_history()
782
other_len = len(other_history)
783
common_index = min(self_len, other_len) -1
784
if common_index >= 0 and \
785
self_history[common_index] != other_history[common_index]:
786
raise DivergedBranches(self, other)
788
if stop_revision is None:
789
stop_revision = other_len
790
elif stop_revision > other_len:
791
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
793
return other_history[self_len:stop_revision]
796
def update_revisions(self, other, stop_revision=None):
797
"""Pull in all new revisions from other branch.
799
from bzrlib.fetch import greedy_fetch
800
from bzrlib.revision import get_intervening_revisions
802
pb = bzrlib.ui.ui_factory.progress_bar()
803
pb.update('comparing histories')
806
revision_ids = self.missing_revisions(other, stop_revision)
807
except DivergedBranches, e:
809
if stop_revision is None:
810
end_revision = other.last_patch()
811
revision_ids = get_intervening_revisions(self.last_patch(),
813
assert self.last_patch() not in revision_ids
814
except bzrlib.errors.NotAncestor:
817
if len(revision_ids) > 0:
818
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
821
self.append_revision(*revision_ids)
822
## note("Added %d revisions." % count)
825
def install_revisions(self, other, revision_ids, pb):
826
if hasattr(other.revision_store, "prefetch"):
827
other.revision_store.prefetch(revision_ids)
828
if hasattr(other.inventory_store, "prefetch"):
829
inventory_ids = [other.get_revision(r).inventory_id
830
for r in revision_ids]
831
other.inventory_store.prefetch(inventory_ids)
834
pb = bzrlib.ui.ui_factory.progress_bar()
841
for i, rev_id in enumerate(revision_ids):
842
pb.update('fetching revision', i+1, len(revision_ids))
844
rev = other.get_revision(rev_id)
845
except bzrlib.errors.NoSuchRevision:
849
revisions.append(rev)
850
inv = other.get_inventory(str(rev.inventory_id))
851
for key, entry in inv.iter_entries():
852
if entry.text_id is None:
854
if entry.text_id not in self.text_store:
855
needed_texts.add(entry.text_id)
859
count, cp_fail = self.text_store.copy_multi(other.text_store,
861
#print "Added %d texts." % count
862
inventory_ids = [ f.inventory_id for f in revisions ]
863
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
865
#print "Added %d inventories." % count
866
revision_ids = [ f.revision_id for f in revisions]
868
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
871
assert len(cp_fail) == 0
872
return count, failures
875
def commit(self, *args, **kw):
876
from bzrlib.commit import commit
877
commit(self, *args, **kw)
880
def lookup_revision(self, revision):
881
"""Return the revision identifier for a given revision information."""
882
revno, info = self._get_revision_info(revision)
886
def revision_id_to_revno(self, revision_id):
887
"""Given a revision id, return its revno"""
888
history = self.revision_history()
890
return history.index(revision_id) + 1
892
raise bzrlib.errors.NoSuchRevision(self, revision_id)
895
def get_revision_info(self, revision):
896
"""Return (revno, revision id) for revision identifier.
898
revision can be an integer, in which case it is assumed to be revno (though
899
this will translate negative values into positive ones)
900
revision can also be a string, in which case it is parsed for something like
901
'date:' or 'revid:' etc.
903
revno, rev_id = self._get_revision_info(revision)
905
raise bzrlib.errors.NoSuchRevision(self, revision)
908
def get_rev_id(self, revno, history=None):
909
"""Find the revision id of the specified revno."""
913
history = self.revision_history()
914
elif revno <= 0 or revno > len(history):
915
raise bzrlib.errors.NoSuchRevision(self, revno)
916
return history[revno - 1]
918
def _get_revision_info(self, revision):
919
"""Return (revno, revision id) for revision specifier.
921
revision can be an integer, in which case it is assumed to be revno
922
(though this will translate negative values into positive ones)
923
revision can also be a string, in which case it is parsed for something
924
like 'date:' or 'revid:' etc.
926
A revid is always returned. If it is None, the specifier referred to
927
the null revision. If the revid does not occur in the revision
928
history, revno will be None.
934
try:# Convert to int if possible
935
revision = int(revision)
938
revs = self.revision_history()
939
if isinstance(revision, int):
941
revno = len(revs) + revision + 1
944
rev_id = self.get_rev_id(revno, revs)
945
elif isinstance(revision, basestring):
946
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
947
if revision.startswith(prefix):
948
result = func(self, revs, revision)
950
revno, rev_id = result
953
rev_id = self.get_rev_id(revno, revs)
956
raise BzrError('No namespace registered for string: %r' %
959
raise TypeError('Unhandled revision type %s' % revision)
963
raise bzrlib.errors.NoSuchRevision(self, revision)
966
def _namespace_revno(self, revs, revision):
967
"""Lookup a revision by revision number"""
968
assert revision.startswith('revno:')
970
return (int(revision[6:]),)
973
REVISION_NAMESPACES['revno:'] = _namespace_revno
975
def _namespace_revid(self, revs, revision):
976
assert revision.startswith('revid:')
977
rev_id = revision[len('revid:'):]
979
return revs.index(rev_id) + 1, rev_id
982
REVISION_NAMESPACES['revid:'] = _namespace_revid
984
def _namespace_last(self, revs, revision):
985
assert revision.startswith('last:')
987
offset = int(revision[5:])
992
raise BzrError('You must supply a positive value for --revision last:XXX')
993
return (len(revs) - offset + 1,)
994
REVISION_NAMESPACES['last:'] = _namespace_last
996
def _namespace_tag(self, revs, revision):
997
assert revision.startswith('tag:')
998
raise BzrError('tag: namespace registered, but not implemented.')
999
REVISION_NAMESPACES['tag:'] = _namespace_tag
1001
def _namespace_date(self, revs, revision):
1002
assert revision.startswith('date:')
1004
# Spec for date revisions:
1006
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
1007
# it can also start with a '+/-/='. '+' says match the first
1008
# entry after the given date. '-' is match the first entry before the date
1009
# '=' is match the first entry after, but still on the given date.
1011
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
1012
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
1013
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
1014
# May 13th, 2005 at 0:00
1016
# So the proper way of saying 'give me all entries for today' is:
1017
# -r {date:+today}:{date:-tomorrow}
1018
# The default is '=' when not supplied
1021
if val[:1] in ('+', '-', '='):
1022
match_style = val[:1]
1025
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1026
if val.lower() == 'yesterday':
1027
dt = today - datetime.timedelta(days=1)
1028
elif val.lower() == 'today':
1030
elif val.lower() == 'tomorrow':
1031
dt = today + datetime.timedelta(days=1)
1034
# This should be done outside the function to avoid recompiling it.
1035
_date_re = re.compile(
1036
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1038
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1040
m = _date_re.match(val)
1041
if not m or (not m.group('date') and not m.group('time')):
1042
raise BzrError('Invalid revision date %r' % revision)
1045
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1047
year, month, day = today.year, today.month, today.day
1049
hour = int(m.group('hour'))
1050
minute = int(m.group('minute'))
1051
if m.group('second'):
1052
second = int(m.group('second'))
1056
hour, minute, second = 0,0,0
1058
dt = datetime.datetime(year=year, month=month, day=day,
1059
hour=hour, minute=minute, second=second)
1063
if match_style == '-':
1065
elif match_style == '=':
1066
last = dt + datetime.timedelta(days=1)
1069
for i in range(len(revs)-1, -1, -1):
1070
r = self.get_revision(revs[i])
1071
# TODO: Handle timezone.
1072
dt = datetime.datetime.fromtimestamp(r.timestamp)
1073
if first >= dt and (last is None or dt >= last):
1076
for i in range(len(revs)):
1077
r = self.get_revision(revs[i])
1078
# TODO: Handle timezone.
1079
dt = datetime.datetime.fromtimestamp(r.timestamp)
1080
if first <= dt and (last is None or dt <= last):
1082
REVISION_NAMESPACES['date:'] = _namespace_date
1084
def revision_tree(self, revision_id):
1085
"""Return Tree for a revision on this branch.
1087
`revision_id` may be None for the null revision, in which case
1088
an `EmptyTree` is returned."""
1089
# TODO: refactor this to use an existing revision object
1090
# so we don't need to read it in twice.
1091
if revision_id == None:
1094
inv = self.get_revision_inventory(revision_id)
1095
return RevisionTree(self.text_store, inv)
1098
def working_tree(self):
1099
"""Return a `Tree` for the working copy."""
1100
from bzrlib.workingtree import WorkingTree
1101
return WorkingTree(self.base, self.read_working_inventory())
1104
def basis_tree(self):
1105
"""Return `Tree` object for last revision.
1107
If there are no revisions yet, return an `EmptyTree`.
1109
r = self.last_patch()
1113
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1117
def rename_one(self, from_rel, to_rel):
1120
This can change the directory or the filename or both.
1124
tree = self.working_tree()
1125
inv = tree.inventory
1126
if not tree.has_filename(from_rel):
1127
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1128
if tree.has_filename(to_rel):
1129
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1131
file_id = inv.path2id(from_rel)
1133
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1135
if inv.path2id(to_rel):
1136
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1138
to_dir, to_tail = os.path.split(to_rel)
1139
to_dir_id = inv.path2id(to_dir)
1140
if to_dir_id == None and to_dir != '':
1141
raise BzrError("can't determine destination directory id for %r" % to_dir)
1143
mutter("rename_one:")
1144
mutter(" file_id {%s}" % file_id)
1145
mutter(" from_rel %r" % from_rel)
1146
mutter(" to_rel %r" % to_rel)
1147
mutter(" to_dir %r" % to_dir)
1148
mutter(" to_dir_id {%s}" % to_dir_id)
1150
inv.rename(file_id, to_dir_id, to_tail)
1152
from_abs = self.abspath(from_rel)
1153
to_abs = self.abspath(to_rel)
1155
os.rename(from_abs, to_abs)
1157
raise BzrError("failed to rename %r to %r: %s"
1158
% (from_abs, to_abs, e[1]),
1159
["rename rolled back"])
1161
self._write_inventory(inv)
1166
def move(self, from_paths, to_name):
1169
to_name must exist as a versioned directory.
1171
If to_name exists and is a directory, the files are moved into
1172
it, keeping their old names. If it is a directory,
1174
Note that to_name is only the last component of the new name;
1175
this doesn't change the directory.
1177
This returns a list of (from_path, to_path) pairs for each
1178
entry that is moved.
1183
## TODO: Option to move IDs only
1184
assert not isinstance(from_paths, basestring)
1185
tree = self.working_tree()
1186
inv = tree.inventory
1187
to_abs = self.abspath(to_name)
1188
if not isdir(to_abs):
1189
raise BzrError("destination %r is not a directory" % to_abs)
1190
if not tree.has_filename(to_name):
1191
raise BzrError("destination %r not in working directory" % to_abs)
1192
to_dir_id = inv.path2id(to_name)
1193
if to_dir_id == None and to_name != '':
1194
raise BzrError("destination %r is not a versioned directory" % to_name)
1195
to_dir_ie = inv[to_dir_id]
1196
if to_dir_ie.kind not in ('directory', 'root_directory'):
1197
raise BzrError("destination %r is not a directory" % to_abs)
1199
to_idpath = inv.get_idpath(to_dir_id)
1201
for f in from_paths:
1202
if not tree.has_filename(f):
1203
raise BzrError("%r does not exist in working tree" % f)
1204
f_id = inv.path2id(f)
1206
raise BzrError("%r is not versioned" % f)
1207
name_tail = splitpath(f)[-1]
1208
dest_path = appendpath(to_name, name_tail)
1209
if tree.has_filename(dest_path):
1210
raise BzrError("destination %r already exists" % dest_path)
1211
if f_id in to_idpath:
1212
raise BzrError("can't move %r to a subdirectory of itself" % f)
1214
# OK, so there's a race here, it's possible that someone will
1215
# create a file in this interval and then the rename might be
1216
# left half-done. But we should have caught most problems.
1218
for f in from_paths:
1219
name_tail = splitpath(f)[-1]
1220
dest_path = appendpath(to_name, name_tail)
1221
result.append((f, dest_path))
1222
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1224
os.rename(self.abspath(f), self.abspath(dest_path))
1226
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1227
["rename rolled back"])
1229
self._write_inventory(inv)
1236
def revert(self, filenames, old_tree=None, backups=True):
1237
"""Restore selected files to the versions from a previous tree.
1240
If true (default) backups are made of files before
1243
from bzrlib.errors import NotVersionedError, BzrError
1244
from bzrlib.atomicfile import AtomicFile
1245
from bzrlib.osutils import backup_file
1247
inv = self.read_working_inventory()
1248
if old_tree is None:
1249
old_tree = self.basis_tree()
1250
old_inv = old_tree.inventory
1253
for fn in filenames:
1254
file_id = inv.path2id(fn)
1256
raise NotVersionedError("not a versioned file", fn)
1257
if not old_inv.has_id(file_id):
1258
raise BzrError("file not present in old tree", fn, file_id)
1259
nids.append((fn, file_id))
1261
# TODO: Rename back if it was previously at a different location
1263
# TODO: If given a directory, restore the entire contents from
1264
# the previous version.
1266
# TODO: Make a backup to a temporary file.
1268
# TODO: If the file previously didn't exist, delete it?
1269
for fn, file_id in nids:
1272
f = AtomicFile(fn, 'wb')
1274
f.write(old_tree.get_file(file_id).read())
1280
def pending_merges(self):
1281
"""Return a list of pending merges.
1283
These are revisions that have been merged into the working
1284
directory but not yet committed.
1286
cfn = self.controlfilename('pending-merges')
1287
if not os.path.exists(cfn):
1290
for l in self.controlfile('pending-merges', 'r').readlines():
1291
p.append(l.rstrip('\n'))
1295
def add_pending_merge(self, revision_id):
1296
from bzrlib.revision import validate_revision_id
1298
validate_revision_id(revision_id)
1300
p = self.pending_merges()
1301
if revision_id in p:
1303
p.append(revision_id)
1304
self.set_pending_merges(p)
1307
def set_pending_merges(self, rev_list):
1308
from bzrlib.atomicfile import AtomicFile
1311
f = AtomicFile(self.controlfilename('pending-merges'))
1322
def get_parent(self):
1323
"""Return the parent location of the branch.
1325
This is the default location for push/pull/missing. The usual
1326
pattern is that the user can override it by specifying a
1330
_locs = ['parent', 'pull', 'x-pull']
1333
return self.controlfile(l, 'r').read().strip('\n')
1335
if e.errno != errno.ENOENT:
1340
def set_parent(self, url):
1341
# TODO: Maybe delete old location files?
1342
from bzrlib.atomicfile import AtomicFile
1345
f = AtomicFile(self.controlfilename('parent'))
1354
def check_revno(self, revno):
1356
Check whether a revno corresponds to any revision.
1357
Zero (the NULL revision) is considered valid.
1360
self.check_real_revno(revno)
1362
def check_real_revno(self, revno):
1364
Check whether a revno corresponds to a real revision.
1365
Zero (the NULL revision) is considered invalid
1367
if revno < 1 or revno > self.revno():
1368
raise InvalidRevisionNumber(revno)
1373
class ScratchBranch(Branch):
1374
"""Special test class: a branch that cleans up after itself.
1376
>>> b = ScratchBranch()
1384
def __init__(self, files=[], dirs=[], base=None):
1385
"""Make a test branch.
1387
This creates a temporary directory and runs init-tree in it.
1389
If any files are listed, they are created in the working copy.
1391
from tempfile import mkdtemp
1396
Branch.__init__(self, base, init=init)
1398
os.mkdir(self.abspath(d))
1401
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1406
>>> orig = ScratchBranch(files=["file1", "file2"])
1407
>>> clone = orig.clone()
1408
>>> os.path.samefile(orig.base, clone.base)
1410
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1413
from shutil import copytree
1414
from tempfile import mkdtemp
1417
copytree(self.base, base, symlinks=True)
1418
return ScratchBranch(base=base)
1426
"""Destroy the test branch, removing the scratch directory."""
1427
from shutil import rmtree
1430
mutter("delete ScratchBranch %s" % self.base)
1433
# Work around for shutil.rmtree failing on Windows when
1434
# readonly files are encountered
1435
mutter("hit exception in destroying ScratchBranch: %s" % e)
1436
for root, dirs, files in os.walk(self.base, topdown=False):
1438
os.chmod(os.path.join(root, name), 0700)
1444
######################################################################
1448
def is_control_file(filename):
1449
## FIXME: better check
1450
filename = os.path.normpath(filename)
1451
while filename != '':
1452
head, tail = os.path.split(filename)
1453
## mutter('check %r for control file' % ((head, tail), ))
1454
if tail == bzrlib.BZRDIR:
1456
if filename == head:
1463
def gen_file_id(name):
1464
"""Return new file id.
1466
This should probably generate proper UUIDs, but for the moment we
1467
cope with just randomness because running uuidgen every time is
1470
from binascii import hexlify
1471
from time import time
1473
# get last component
1474
idx = name.rfind('/')
1476
name = name[idx+1 : ]
1477
idx = name.rfind('\\')
1479
name = name[idx+1 : ]
1481
# make it not a hidden file
1482
name = name.lstrip('.')
1484
# remove any wierd characters; we don't escape them but rather
1485
# just pull them out
1486
name = re.sub(r'[^\w.]', '', name)
1488
s = hexlify(rand_bytes(8))
1489
return '-'.join((name, compact_date(time()), s))
1493
"""Return a new tree-root file id."""
1494
return gen_file_id('TREE_ROOT')
1497
def copy_branch(branch_from, to_location, revision=None):
1498
"""Copy branch_from into the existing directory to_location.
1501
If not None, only revisions up to this point will be copied.
1502
The head of the new branch will be that revision.
1505
The name of a local directory that exists but is empty.
1507
from bzrlib.merge import merge
1509
assert isinstance(branch_from, Branch)
1510
assert isinstance(to_location, basestring)
1512
br_to = Branch(to_location, init=True)
1513
br_to.set_root_id(branch_from.get_root_id())
1514
if revision is None:
1515
revno = branch_from.revno()
1517
revno, rev_id = branch_from.get_revision_info(revision)
1518
br_to.update_revisions(branch_from, stop_revision=revno)
1519
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1520
check_clean=False, ignore_zero=True)
1522
br_to.set_parent(branch_from.base)
added
removed
bzrlib/branch.py
