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.xml import unpack_xml
32
from bzrlib.delta import compare_trees
33
from bzrlib.tree import EmptyTree, RevisionTree
37
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
38
## TODO: Maybe include checks for common corruption of newlines, etc?
41
# TODO: Some operations like log might retrieve the same revisions
42
# repeatedly to calculate deltas. We could perhaps have a weakref
43
# cache in memory to make this faster.
45
# TODO: please move the revision-string syntax stuff out of the branch
46
# object; it's clutter
49
def find_branch(f, **args):
50
if f and (f.startswith('http://') or f.startswith('https://')):
52
return remotebranch.RemoteBranch(f, **args)
54
return Branch(f, **args)
57
def find_cached_branch(f, cache_root, **args):
58
from remotebranch import RemoteBranch
59
br = find_branch(f, **args)
60
def cacheify(br, store_name):
61
from meta_store import CachedStore
62
cache_path = os.path.join(cache_root, store_name)
64
new_store = CachedStore(getattr(br, store_name), cache_path)
65
setattr(br, store_name, new_store)
67
if isinstance(br, RemoteBranch):
68
cacheify(br, 'inventory_store')
69
cacheify(br, 'text_store')
70
cacheify(br, 'revision_store')
74
def _relpath(base, path):
75
"""Return path relative to base, or raise exception.
77
The path may be either an absolute path or a path relative to the
78
current working directory.
80
Lifted out of Branch.relpath for ease of testing.
82
os.path.commonprefix (python2.4) has a bad bug that it works just
83
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
84
avoids that problem."""
85
rp = os.path.abspath(path)
89
while len(head) >= len(base):
92
head, tail = os.path.split(head)
96
from errors import NotBranchError
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 bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
135
# XXX: move into bzrlib.errors; subclass BzrError
136
class DivergedBranches(Exception):
137
def __init__(self, branch1, branch2):
138
self.branch1 = branch1
139
self.branch2 = branch2
140
Exception.__init__(self, "These branches have diverged.")
143
######################################################################
146
class Branch(object):
147
"""Branch holding a history of revisions.
150
Base directory of the branch.
156
If _lock_mode is true, a positive count of the number of times the
160
Lock object from bzrlib.lock.
167
# Map some sort of prefix into a namespace
168
# stuff like "revno:10", "revid:", etc.
169
# This should match a prefix with a function which accepts
170
REVISION_NAMESPACES = {}
172
def __init__(self, base, init=False, find_root=True):
173
"""Create new branch object at a particular location.
175
base -- Base directory for the branch.
177
init -- If True, create new control files in a previously
178
unversioned directory. If False, the branch must already
181
find_root -- If true and init is false, find the root of the
182
existing branch containing base.
184
In the test suite, creation of new trees is tested using the
185
`ScratchBranch` class.
187
from bzrlib.store import ImmutableStore
189
self.base = os.path.realpath(base)
192
self.base = find_branch_root(base)
194
self.base = os.path.realpath(base)
195
if not isdir(self.controlfilename('.')):
196
from errors import NotBranchError
197
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
198
['use "bzr init" to initialize a new working tree',
199
'current bzr can only operate from top-of-tree'])
202
self.text_store = ImmutableStore(self.controlfilename('text-store'))
203
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
204
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
208
return '%s(%r)' % (self.__class__.__name__, self.base)
215
if self._lock_mode or self._lock:
216
from warnings import warn
217
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'
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'
253
if not self._lock_mode:
254
from errors import LockError
255
raise LockError('branch %r is not locked' % (self))
257
if self._lock_count > 1:
258
self._lock_count -= 1
262
self._lock_mode = self._lock_count = None
265
def abspath(self, name):
266
"""Return absolute filename for something in the branch"""
267
return os.path.join(self.base, name)
270
def relpath(self, path):
271
"""Return path relative to this branch of something inside it.
273
Raises an error if path is not in this branch."""
274
return _relpath(self.base, path)
277
def controlfilename(self, file_or_path):
278
"""Return location relative to branch."""
279
if isinstance(file_or_path, basestring):
280
file_or_path = [file_or_path]
281
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
284
def controlfile(self, file_or_path, mode='r'):
285
"""Open a control file for this branch.
287
There are two classes of file in the control directory: text
288
and binary. binary files are untranslated byte streams. Text
289
control files are stored with Unix newlines and in UTF-8, even
290
if the platform or locale defaults are different.
292
Controlfiles should almost never be opened in write mode but
293
rather should be atomically copied and replaced using atomicfile.
296
fn = self.controlfilename(file_or_path)
298
if mode == 'rb' or mode == 'wb':
299
return file(fn, mode)
300
elif mode == 'r' or mode == 'w':
301
# open in binary mode anyhow so there's no newline translation;
302
# codecs uses line buffering by default; don't want that.
304
return codecs.open(fn, mode + 'b', 'utf-8',
307
raise BzrError("invalid controlfile mode %r" % mode)
311
def _make_control(self):
312
from bzrlib.inventory import Inventory
313
from bzrlib.xml import pack_xml
315
os.mkdir(self.controlfilename([]))
316
self.controlfile('README', 'w').write(
317
"This is a Bazaar-NG control directory.\n"
318
"Do not change any files in this directory.\n")
319
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
320
for d in ('text-store', 'inventory-store', 'revision-store'):
321
os.mkdir(self.controlfilename(d))
322
for f in ('revision-history', 'merged-patches',
323
'pending-merged-patches', 'branch-name',
326
self.controlfile(f, 'w').write('')
327
mutter('created control directory in ' + self.base)
329
# if we want per-tree root ids then this is the place to set
330
# them; they're not needed for now and so ommitted for
332
pack_xml(Inventory(), self.controlfile('inventory','w'))
335
def _check_format(self):
336
"""Check this branch format is supported.
338
The current tool only supports the current unstable format.
340
In the future, we might need different in-memory Branch
341
classes to support downlevel branches. But not yet.
343
# This ignores newlines so that we can open branches created
344
# on Windows from Linux and so on. I think it might be better
345
# to always make all internal files in unix format.
346
fmt = self.controlfile('branch-format', 'r').read()
347
fmt.replace('\r\n', '')
348
if fmt != BZR_BRANCH_FORMAT:
349
raise BzrError('sorry, branch format %r not supported' % fmt,
350
['use a different bzr version',
351
'or remove the .bzr directory and "bzr init" again'])
353
def get_root_id(self):
354
"""Return the id of this branches root"""
355
inv = self.read_working_inventory()
356
return inv.root.file_id
358
def set_root_id(self, file_id):
359
inv = self.read_working_inventory()
360
orig_root_id = inv.root.file_id
361
del inv._byid[inv.root.file_id]
362
inv.root.file_id = file_id
363
inv._byid[inv.root.file_id] = inv.root
366
if entry.parent_id in (None, orig_root_id):
367
entry.parent_id = inv.root.file_id
368
self._write_inventory(inv)
370
def read_working_inventory(self):
371
"""Read the working inventory."""
372
from bzrlib.inventory import Inventory
373
from bzrlib.xml import unpack_xml
374
from time import time
378
# ElementTree does its own conversion from UTF-8, so open in
380
inv = unpack_xml(Inventory,
381
self.controlfile('inventory', 'rb'))
382
mutter("loaded inventory of %d items in %f"
383
% (len(inv), time() - before))
389
def _write_inventory(self, inv):
390
"""Update the working inventory.
392
That is to say, the inventory describing changes underway, that
393
will be committed to the next revision.
395
from bzrlib.atomicfile import AtomicFile
396
from bzrlib.xml import pack_xml
400
f = AtomicFile(self.controlfilename('inventory'), 'wb')
409
mutter('wrote working inventory')
412
inventory = property(read_working_inventory, _write_inventory, None,
413
"""Inventory for the working copy.""")
416
def add(self, files, verbose=False, ids=None):
417
"""Make files versioned.
419
Note that the command line normally calls smart_add instead.
421
This puts the files in the Added state, so that they will be
422
recorded by the next commit.
425
List of paths to add, relative to the base of the tree.
428
If set, use these instead of automatically generated ids.
429
Must be the same length as the list of files, but may
430
contain None for ids that are to be autogenerated.
432
TODO: Perhaps have an option to add the ids even if the files do
435
TODO: Perhaps return the ids of the files? But then again it
436
is easy to retrieve them if they're needed.
438
TODO: Adding a directory should optionally recurse down and
439
add all non-ignored children. Perhaps do that in a
442
# TODO: Re-adding a file that is removed in the working copy
443
# should probably put it back with the previous ID.
444
if isinstance(files, basestring):
445
assert(ids is None or isinstance(ids, basestring))
451
ids = [None] * len(files)
453
assert(len(ids) == len(files))
457
inv = self.read_working_inventory()
458
for f,file_id in zip(files, ids):
459
if is_control_file(f):
460
raise BzrError("cannot add control file %s" % quotefn(f))
465
raise BzrError("cannot add top-level %r" % f)
467
fullpath = os.path.normpath(self.abspath(f))
470
kind = file_kind(fullpath)
472
# maybe something better?
473
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
475
if kind != 'file' and kind != 'directory':
476
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
479
file_id = gen_file_id(f)
480
inv.add_path(f, kind=kind, file_id=file_id)
483
print 'added', quotefn(f)
485
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
487
self._write_inventory(inv)
492
def print_file(self, file, revno):
493
"""Print `file` to stdout."""
496
tree = self.revision_tree(self.lookup_revision(revno))
497
# use inventory as it was in that revision
498
file_id = tree.inventory.path2id(file)
500
raise BzrError("%r is not present in revision %s" % (file, revno))
501
tree.print_file(file_id)
506
def remove(self, files, verbose=False):
507
"""Mark nominated files for removal from the inventory.
509
This does not remove their text. This does not run on
511
TODO: Refuse to remove modified files unless --force is given?
513
TODO: Do something useful with directories.
515
TODO: Should this remove the text or not? Tough call; not
516
removing may be useful and the user can just use use rm, and
517
is the opposite of add. Removing it is consistent with most
518
other tools. Maybe an option.
520
## TODO: Normalize names
521
## TODO: Remove nested loops; better scalability
522
if isinstance(files, basestring):
528
tree = self.working_tree()
531
# do this before any modifications
535
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
536
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
538
# having remove it, it must be either ignored or unknown
539
if tree.is_ignored(f):
543
show_status(new_status, inv[fid].kind, quotefn(f))
546
self._write_inventory(inv)
551
# FIXME: this doesn't need to be a branch method
552
def set_inventory(self, new_inventory_list):
553
from bzrlib.inventory import Inventory, InventoryEntry
554
inv = Inventory(self.get_root_id())
555
for path, file_id, parent, kind in new_inventory_list:
556
name = os.path.basename(path)
559
inv.add(InventoryEntry(file_id, name, kind, parent))
560
self._write_inventory(inv)
564
"""Return all unknown files.
566
These are files in the working directory that are not versioned or
567
control files or ignored.
569
>>> b = ScratchBranch(files=['foo', 'foo~'])
570
>>> list(b.unknowns())
573
>>> list(b.unknowns())
576
>>> list(b.unknowns())
579
return self.working_tree().unknowns()
582
def append_revision(self, *revision_ids):
583
from bzrlib.atomicfile import AtomicFile
585
for revision_id in revision_ids:
586
mutter("add {%s} to revision-history" % revision_id)
588
rev_history = self.revision_history()
589
rev_history.extend(revision_ids)
591
f = AtomicFile(self.controlfilename('revision-history'))
593
for rev_id in rev_history:
600
def get_revision_xml(self, revision_id):
601
"""Return XML file object for revision object."""
602
if not revision_id or not isinstance(revision_id, basestring):
603
raise InvalidRevisionId(revision_id)
608
return self.revision_store[revision_id]
610
raise bzrlib.errors.NoSuchRevision(self, revision_id)
615
def get_revision(self, revision_id):
616
"""Return the Revision object for a named revision"""
617
xml_file = self.get_revision_xml(revision_id)
620
r = unpack_xml(Revision, xml_file)
621
except SyntaxError, e:
622
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
626
assert r.revision_id == revision_id
630
def get_revision_delta(self, revno):
631
"""Return the delta for one revision.
633
The delta is relative to its mainline predecessor, or the
634
empty tree for revision 1.
636
assert isinstance(revno, int)
637
rh = self.revision_history()
638
if not (1 <= revno <= len(rh)):
639
raise InvalidRevisionNumber(revno)
641
# revno is 1-based; list is 0-based
643
new_tree = self.revision_tree(rh[revno-1])
645
old_tree = EmptyTree()
647
old_tree = self.revision_tree(rh[revno-2])
649
return compare_trees(old_tree, new_tree)
653
def get_revision_sha1(self, revision_id):
654
"""Hash the stored value of a revision, and return it."""
655
# In the future, revision entries will be signed. At that
656
# point, it is probably best *not* to include the signature
657
# in the revision hash. Because that lets you re-sign
658
# the revision, (add signatures/remove signatures) and still
659
# have all hash pointers stay consistent.
660
# But for now, just hash the contents.
661
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
664
def get_inventory(self, inventory_id):
665
"""Get Inventory object by hash.
667
TODO: Perhaps for this and similar methods, take a revision
668
parameter which can be either an integer revno or a
670
from bzrlib.inventory import Inventory
671
from bzrlib.xml import unpack_xml
673
return unpack_xml(Inventory, self.get_inventory_xml(inventory_id))
676
def get_inventory_xml(self, inventory_id):
677
"""Get inventory XML as a file object."""
678
return self.inventory_store[inventory_id]
681
def get_inventory_sha1(self, inventory_id):
682
"""Return the sha1 hash of the inventory entry
684
return sha_file(self.get_inventory_xml(inventory_id))
687
def get_revision_inventory(self, revision_id):
688
"""Return inventory of a past revision."""
689
# bzr 0.0.6 imposes the constraint that the inventory_id
690
# must be the same as its revision, so this is trivial.
691
if revision_id == None:
692
from bzrlib.inventory import Inventory
693
return Inventory(self.get_root_id())
695
return self.get_inventory(revision_id)
698
def revision_history(self):
699
"""Return sequence of revision hashes on to this branch.
701
>>> ScratchBranch().revision_history()
706
return [l.rstrip('\r\n') for l in
707
self.controlfile('revision-history', 'r').readlines()]
712
def common_ancestor(self, other, self_revno=None, other_revno=None):
715
>>> sb = ScratchBranch(files=['foo', 'foo~'])
716
>>> sb.common_ancestor(sb) == (None, None)
718
>>> commit.commit(sb, "Committing first revision", verbose=False)
719
>>> sb.common_ancestor(sb)[0]
721
>>> clone = sb.clone()
722
>>> commit.commit(sb, "Committing second revision", verbose=False)
723
>>> sb.common_ancestor(sb)[0]
725
>>> sb.common_ancestor(clone)[0]
727
>>> commit.commit(clone, "Committing divergent second revision",
729
>>> sb.common_ancestor(clone)[0]
731
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
733
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
735
>>> clone2 = sb.clone()
736
>>> sb.common_ancestor(clone2)[0]
738
>>> sb.common_ancestor(clone2, self_revno=1)[0]
740
>>> sb.common_ancestor(clone2, other_revno=1)[0]
743
my_history = self.revision_history()
744
other_history = other.revision_history()
745
if self_revno is None:
746
self_revno = len(my_history)
747
if other_revno is None:
748
other_revno = len(other_history)
749
indices = range(min((self_revno, other_revno)))
752
if my_history[r] == other_history[r]:
753
return r+1, my_history[r]
758
"""Return current revision number for this branch.
760
That is equivalent to the number of revisions committed to
763
return len(self.revision_history())
766
def last_patch(self):
767
"""Return last patch hash, or None if no history.
769
ph = self.revision_history()
776
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
778
If self and other have not diverged, return a list of the revisions
779
present in other, but missing from self.
781
>>> from bzrlib.commit import commit
782
>>> bzrlib.trace.silent = True
783
>>> br1 = ScratchBranch()
784
>>> br2 = ScratchBranch()
785
>>> br1.missing_revisions(br2)
787
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
788
>>> br1.missing_revisions(br2)
790
>>> br2.missing_revisions(br1)
792
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
793
>>> br1.missing_revisions(br2)
795
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
796
>>> br1.missing_revisions(br2)
798
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
799
>>> br1.missing_revisions(br2)
800
Traceback (most recent call last):
801
DivergedBranches: These branches have diverged.
803
self_history = self.revision_history()
804
self_len = len(self_history)
805
other_history = other.revision_history()
806
other_len = len(other_history)
807
common_index = min(self_len, other_len) -1
808
if common_index >= 0 and \
809
self_history[common_index] != other_history[common_index]:
810
raise DivergedBranches(self, other)
812
if stop_revision is None:
813
stop_revision = other_len
814
elif stop_revision > other_len:
815
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
817
return other_history[self_len:stop_revision]
820
def update_revisions(self, other, stop_revision=None):
821
"""Pull in all new revisions from other branch.
823
>>> from bzrlib.commit import commit
824
>>> bzrlib.trace.silent = True
825
>>> br1 = ScratchBranch(files=['foo', 'bar'])
828
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
829
>>> br2 = ScratchBranch()
830
>>> br2.update_revisions(br1)
834
>>> br2.revision_history()
836
>>> br2.update_revisions(br1)
840
>>> br1.text_store.total_size() == br2.text_store.total_size()
843
progress = bzrlib.ui.ui_factory.progress_bar()
844
progress.update('comparing histories')
845
revision_ids = self.missing_revisions(other, stop_revision)
846
count = self.install_revisions(other, revision_ids, progress=progress)
847
self.append_revision(*revision_ids)
848
print "Added %d revisions." % count
851
def install_revisions(self, other, revision_ids, progress=None):
852
if hasattr(other.revision_store, "prefetch"):
853
other.revision_store.prefetch(revision_ids)
854
if hasattr(other.inventory_store, "prefetch"):
855
inventory_ids = [other.get_revision(r).inventory_id
856
for r in revision_ids]
857
other.inventory_store.prefetch(inventory_ids)
862
for rev_id in revision_ids:
865
progress.update('fetching revision', i, len(revision_ids))
866
rev = other.get_revision(rev_id)
867
revisions.append(rev)
868
inv = other.get_inventory(str(rev.inventory_id))
869
for key, entry in inv.iter_entries():
870
if entry.text_id is None:
872
if entry.text_id not in self.text_store:
873
needed_texts.add(entry.text_id)
878
count = self.text_store.copy_multi(other.text_store, needed_texts)
879
print "Added %d texts." % count
880
inventory_ids = [ f.inventory_id for f in revisions ]
881
count = self.inventory_store.copy_multi(other.inventory_store,
883
print "Added %d inventories." % count
884
revision_ids = [ f.revision_id for f in revisions]
885
count = self.revision_store.copy_multi(other.revision_store,
889
def commit(self, *args, **kw):
890
from bzrlib.commit import commit
891
commit(self, *args, **kw)
894
def lookup_revision(self, revision):
895
"""Return the revision identifier for a given revision information."""
896
revno, info = self.get_revision_info(revision)
900
def revision_id_to_revno(self, revision_id):
901
"""Given a revision id, return its revno"""
902
history = self.revision_history()
904
return history.index(revision_id) + 1
906
raise bzrlib.errors.NoSuchRevision(self, revision_id)
909
def get_revision_info(self, revision):
910
"""Return (revno, revision id) for revision identifier.
912
revision can be an integer, in which case it is assumed to be revno (though
913
this will translate negative values into positive ones)
914
revision can also be a string, in which case it is parsed for something like
915
'date:' or 'revid:' etc.
920
try:# Convert to int if possible
921
revision = int(revision)
924
revs = self.revision_history()
925
if isinstance(revision, int):
928
# Mabye we should do this first, but we don't need it if revision == 0
930
revno = len(revs) + revision + 1
933
elif isinstance(revision, basestring):
934
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
935
if revision.startswith(prefix):
936
revno = func(self, revs, revision)
939
raise BzrError('No namespace registered for string: %r' % revision)
941
if revno is None or revno <= 0 or revno > len(revs):
942
raise BzrError("no such revision %s" % revision)
943
return revno, revs[revno-1]
945
def _namespace_revno(self, revs, revision):
946
"""Lookup a revision by revision number"""
947
assert revision.startswith('revno:')
949
return int(revision[6:])
952
REVISION_NAMESPACES['revno:'] = _namespace_revno
954
def _namespace_revid(self, revs, revision):
955
assert revision.startswith('revid:')
957
return revs.index(revision[6:]) + 1
960
REVISION_NAMESPACES['revid:'] = _namespace_revid
962
def _namespace_last(self, revs, revision):
963
assert revision.startswith('last:')
965
offset = int(revision[5:])
970
raise BzrError('You must supply a positive value for --revision last:XXX')
971
return len(revs) - offset + 1
972
REVISION_NAMESPACES['last:'] = _namespace_last
974
def _namespace_tag(self, revs, revision):
975
assert revision.startswith('tag:')
976
raise BzrError('tag: namespace registered, but not implemented.')
977
REVISION_NAMESPACES['tag:'] = _namespace_tag
979
def _namespace_date(self, revs, revision):
980
assert revision.startswith('date:')
982
# Spec for date revisions:
984
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
985
# it can also start with a '+/-/='. '+' says match the first
986
# entry after the given date. '-' is match the first entry before the date
987
# '=' is match the first entry after, but still on the given date.
989
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
990
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
991
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
992
# May 13th, 2005 at 0:00
994
# So the proper way of saying 'give me all entries for today' is:
995
# -r {date:+today}:{date:-tomorrow}
996
# The default is '=' when not supplied
999
if val[:1] in ('+', '-', '='):
1000
match_style = val[:1]
1003
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1004
if val.lower() == 'yesterday':
1005
dt = today - datetime.timedelta(days=1)
1006
elif val.lower() == 'today':
1008
elif val.lower() == 'tomorrow':
1009
dt = today + datetime.timedelta(days=1)
1012
# This should be done outside the function to avoid recompiling it.
1013
_date_re = re.compile(
1014
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1016
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1018
m = _date_re.match(val)
1019
if not m or (not m.group('date') and not m.group('time')):
1020
raise BzrError('Invalid revision date %r' % revision)
1023
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1025
year, month, day = today.year, today.month, today.day
1027
hour = int(m.group('hour'))
1028
minute = int(m.group('minute'))
1029
if m.group('second'):
1030
second = int(m.group('second'))
1034
hour, minute, second = 0,0,0
1036
dt = datetime.datetime(year=year, month=month, day=day,
1037
hour=hour, minute=minute, second=second)
1041
if match_style == '-':
1043
elif match_style == '=':
1044
last = dt + datetime.timedelta(days=1)
1047
for i in range(len(revs)-1, -1, -1):
1048
r = self.get_revision(revs[i])
1049
# TODO: Handle timezone.
1050
dt = datetime.datetime.fromtimestamp(r.timestamp)
1051
if first >= dt and (last is None or dt >= last):
1054
for i in range(len(revs)):
1055
r = self.get_revision(revs[i])
1056
# TODO: Handle timezone.
1057
dt = datetime.datetime.fromtimestamp(r.timestamp)
1058
if first <= dt and (last is None or dt <= last):
1060
REVISION_NAMESPACES['date:'] = _namespace_date
1062
def revision_tree(self, revision_id):
1063
"""Return Tree for a revision on this branch.
1065
`revision_id` may be None for the null revision, in which case
1066
an `EmptyTree` is returned."""
1067
# TODO: refactor this to use an existing revision object
1068
# so we don't need to read it in twice.
1069
if revision_id == None:
1072
inv = self.get_revision_inventory(revision_id)
1073
return RevisionTree(self.text_store, inv)
1076
def working_tree(self):
1077
"""Return a `Tree` for the working copy."""
1078
from workingtree import WorkingTree
1079
return WorkingTree(self.base, self.read_working_inventory())
1082
def basis_tree(self):
1083
"""Return `Tree` object for last revision.
1085
If there are no revisions yet, return an `EmptyTree`.
1087
r = self.last_patch()
1091
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1095
def rename_one(self, from_rel, to_rel):
1098
This can change the directory or the filename or both.
1102
tree = self.working_tree()
1103
inv = tree.inventory
1104
if not tree.has_filename(from_rel):
1105
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1106
if tree.has_filename(to_rel):
1107
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1109
file_id = inv.path2id(from_rel)
1111
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1113
if inv.path2id(to_rel):
1114
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1116
to_dir, to_tail = os.path.split(to_rel)
1117
to_dir_id = inv.path2id(to_dir)
1118
if to_dir_id == None and to_dir != '':
1119
raise BzrError("can't determine destination directory id for %r" % to_dir)
1121
mutter("rename_one:")
1122
mutter(" file_id {%s}" % file_id)
1123
mutter(" from_rel %r" % from_rel)
1124
mutter(" to_rel %r" % to_rel)
1125
mutter(" to_dir %r" % to_dir)
1126
mutter(" to_dir_id {%s}" % to_dir_id)
1128
inv.rename(file_id, to_dir_id, to_tail)
1130
print "%s => %s" % (from_rel, to_rel)
1132
from_abs = self.abspath(from_rel)
1133
to_abs = self.abspath(to_rel)
1135
os.rename(from_abs, to_abs)
1137
raise BzrError("failed to rename %r to %r: %s"
1138
% (from_abs, to_abs, e[1]),
1139
["rename rolled back"])
1141
self._write_inventory(inv)
1146
def move(self, from_paths, to_name):
1149
to_name must exist as a versioned directory.
1151
If to_name exists and is a directory, the files are moved into
1152
it, keeping their old names. If it is a directory,
1154
Note that to_name is only the last component of the new name;
1155
this doesn't change the directory.
1159
## TODO: Option to move IDs only
1160
assert not isinstance(from_paths, basestring)
1161
tree = self.working_tree()
1162
inv = tree.inventory
1163
to_abs = self.abspath(to_name)
1164
if not isdir(to_abs):
1165
raise BzrError("destination %r is not a directory" % to_abs)
1166
if not tree.has_filename(to_name):
1167
raise BzrError("destination %r not in working directory" % to_abs)
1168
to_dir_id = inv.path2id(to_name)
1169
if to_dir_id == None and to_name != '':
1170
raise BzrError("destination %r is not a versioned directory" % to_name)
1171
to_dir_ie = inv[to_dir_id]
1172
if to_dir_ie.kind not in ('directory', 'root_directory'):
1173
raise BzrError("destination %r is not a directory" % to_abs)
1175
to_idpath = inv.get_idpath(to_dir_id)
1177
for f in from_paths:
1178
if not tree.has_filename(f):
1179
raise BzrError("%r does not exist in working tree" % f)
1180
f_id = inv.path2id(f)
1182
raise BzrError("%r is not versioned" % f)
1183
name_tail = splitpath(f)[-1]
1184
dest_path = appendpath(to_name, name_tail)
1185
if tree.has_filename(dest_path):
1186
raise BzrError("destination %r already exists" % dest_path)
1187
if f_id in to_idpath:
1188
raise BzrError("can't move %r to a subdirectory of itself" % f)
1190
# OK, so there's a race here, it's possible that someone will
1191
# create a file in this interval and then the rename might be
1192
# left half-done. But we should have caught most problems.
1194
for f in from_paths:
1195
name_tail = splitpath(f)[-1]
1196
dest_path = appendpath(to_name, name_tail)
1197
print "%s => %s" % (f, dest_path)
1198
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1200
os.rename(self.abspath(f), self.abspath(dest_path))
1202
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1203
["rename rolled back"])
1205
self._write_inventory(inv)
1210
def revert(self, filenames, old_tree=None, backups=True):
1211
"""Restore selected files to the versions from a previous tree.
1214
If true (default) backups are made of files before
1217
from bzrlib.errors import NotVersionedError, BzrError
1218
from bzrlib.atomicfile import AtomicFile
1219
from bzrlib.osutils import backup_file
1221
inv = self.read_working_inventory()
1222
if old_tree is None:
1223
old_tree = self.basis_tree()
1224
old_inv = old_tree.inventory
1227
for fn in filenames:
1228
file_id = inv.path2id(fn)
1230
raise NotVersionedError("not a versioned file", fn)
1231
if not old_inv.has_id(file_id):
1232
raise BzrError("file not present in old tree", fn, file_id)
1233
nids.append((fn, file_id))
1235
# TODO: Rename back if it was previously at a different location
1237
# TODO: If given a directory, restore the entire contents from
1238
# the previous version.
1240
# TODO: Make a backup to a temporary file.
1242
# TODO: If the file previously didn't exist, delete it?
1243
for fn, file_id in nids:
1246
f = AtomicFile(fn, 'wb')
1248
f.write(old_tree.get_file(file_id).read())
1254
def pending_merges(self):
1255
"""Return a list of pending merges.
1257
These are revisions that have been merged into the working
1258
directory but not yet committed.
1260
cfn = self.controlfilename('pending-merges')
1261
if not os.path.exists(cfn):
1264
for l in self.controlfile('pending-merges', 'r').readlines():
1265
p.append(l.rstrip('\n'))
1269
def add_pending_merge(self, revision_id):
1270
from bzrlib.revision import validate_revision_id
1272
validate_revision_id(revision_id)
1274
p = self.pending_merges()
1275
if revision_id in p:
1277
p.append(revision_id)
1278
self.set_pending_merges(p)
1281
def set_pending_merges(self, rev_list):
1282
from bzrlib.atomicfile import AtomicFile
1285
f = AtomicFile(self.controlfilename('pending-merges'))
1297
class ScratchBranch(Branch):
1298
"""Special test class: a branch that cleans up after itself.
1300
>>> b = ScratchBranch()
1308
def __init__(self, files=[], dirs=[], base=None):
1309
"""Make a test branch.
1311
This creates a temporary directory and runs init-tree in it.
1313
If any files are listed, they are created in the working copy.
1315
from tempfile import mkdtemp
1320
Branch.__init__(self, base, init=init)
1322
os.mkdir(self.abspath(d))
1325
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1330
>>> orig = ScratchBranch(files=["file1", "file2"])
1331
>>> clone = orig.clone()
1332
>>> os.path.samefile(orig.base, clone.base)
1334
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1337
from shutil import copytree
1338
from tempfile import mkdtemp
1341
copytree(self.base, base, symlinks=True)
1342
return ScratchBranch(base=base)
1348
"""Destroy the test branch, removing the scratch directory."""
1349
from shutil import rmtree
1352
mutter("delete ScratchBranch %s" % self.base)
1355
# Work around for shutil.rmtree failing on Windows when
1356
# readonly files are encountered
1357
mutter("hit exception in destroying ScratchBranch: %s" % e)
1358
for root, dirs, files in os.walk(self.base, topdown=False):
1360
os.chmod(os.path.join(root, name), 0700)
1366
######################################################################
1370
def is_control_file(filename):
1371
## FIXME: better check
1372
filename = os.path.normpath(filename)
1373
while filename != '':
1374
head, tail = os.path.split(filename)
1375
## mutter('check %r for control file' % ((head, tail), ))
1376
if tail == bzrlib.BZRDIR:
1378
if filename == head:
1385
def gen_file_id(name):
1386
"""Return new file id.
1388
This should probably generate proper UUIDs, but for the moment we
1389
cope with just randomness because running uuidgen every time is
1392
from binascii import hexlify
1393
from time import time
1395
# get last component
1396
idx = name.rfind('/')
1398
name = name[idx+1 : ]
1399
idx = name.rfind('\\')
1401
name = name[idx+1 : ]
1403
# make it not a hidden file
1404
name = name.lstrip('.')
1406
# remove any wierd characters; we don't escape them but rather
1407
# just pull them out
1408
name = re.sub(r'[^\w.]', '', name)
1410
s = hexlify(rand_bytes(8))
1411
return '-'.join((name, compact_date(time()), s))
1415
"""Return a new tree-root file id."""
1416
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
