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
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)
223
def lock_write(self):
225
if self._lock_mode != 'w':
226
from errors import LockError
227
raise LockError("can't upgrade to a write lock from %r" %
229
self._lock_count += 1
231
from bzrlib.lock import WriteLock
233
self._lock = WriteLock(self.controlfilename('branch-lock'))
234
self._lock_mode = 'w'
241
assert self._lock_mode in ('r', 'w'), \
242
"invalid lock mode %r" % self._lock_mode
243
self._lock_count += 1
245
from bzrlib.lock import ReadLock
247
self._lock = ReadLock(self.controlfilename('branch-lock'))
248
self._lock_mode = 'r'
254
if not self._lock_mode:
255
from errors import LockError
256
raise LockError('branch %r is not locked' % (self))
258
if self._lock_count > 1:
259
self._lock_count -= 1
263
self._lock_mode = self._lock_count = None
266
def abspath(self, name):
267
"""Return absolute filename for something in the branch"""
268
return os.path.join(self.base, name)
271
def relpath(self, path):
272
"""Return path relative to this branch of something inside it.
274
Raises an error if path is not in this branch."""
275
return _relpath(self.base, path)
278
def controlfilename(self, file_or_path):
279
"""Return location relative to branch."""
280
if isinstance(file_or_path, basestring):
281
file_or_path = [file_or_path]
282
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
285
def controlfile(self, file_or_path, mode='r'):
286
"""Open a control file for this branch.
288
There are two classes of file in the control directory: text
289
and binary. binary files are untranslated byte streams. Text
290
control files are stored with Unix newlines and in UTF-8, even
291
if the platform or locale defaults are different.
293
Controlfiles should almost never be opened in write mode but
294
rather should be atomically copied and replaced using atomicfile.
297
fn = self.controlfilename(file_or_path)
299
if mode == 'rb' or mode == 'wb':
300
return file(fn, mode)
301
elif mode == 'r' or mode == 'w':
302
# open in binary mode anyhow so there's no newline translation;
303
# codecs uses line buffering by default; don't want that.
305
return codecs.open(fn, mode + 'b', 'utf-8',
308
raise BzrError("invalid controlfile mode %r" % mode)
312
def _make_control(self):
313
from bzrlib.inventory import Inventory
314
from bzrlib.xml import pack_xml
316
os.mkdir(self.controlfilename([]))
317
self.controlfile('README', 'w').write(
318
"This is a Bazaar-NG control directory.\n"
319
"Do not change any files in this directory.\n")
320
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
321
for d in ('text-store', 'inventory-store', 'revision-store'):
322
os.mkdir(self.controlfilename(d))
323
for f in ('revision-history', 'merged-patches',
324
'pending-merged-patches', 'branch-name',
327
self.controlfile(f, 'w').write('')
328
mutter('created control directory in ' + self.base)
330
# if we want per-tree root ids then this is the place to set
331
# them; they're not needed for now and so ommitted for
333
pack_xml(Inventory(), self.controlfile('inventory','w'))
336
def _check_format(self):
337
"""Check this branch format is supported.
339
The current tool only supports the current unstable format.
341
In the future, we might need different in-memory Branch
342
classes to support downlevel branches. But not yet.
344
# This ignores newlines so that we can open branches created
345
# on Windows from Linux and so on. I think it might be better
346
# to always make all internal files in unix format.
347
fmt = self.controlfile('branch-format', 'r').read()
348
fmt.replace('\r\n', '')
349
if fmt != BZR_BRANCH_FORMAT:
350
raise BzrError('sorry, branch format %r not supported' % fmt,
351
['use a different bzr version',
352
'or remove the .bzr directory and "bzr init" again'])
354
def get_root_id(self):
355
"""Return the id of this branches root"""
356
inv = self.read_working_inventory()
357
return inv.root.file_id
359
def set_root_id(self, file_id):
360
inv = self.read_working_inventory()
361
orig_root_id = inv.root.file_id
362
del inv._byid[inv.root.file_id]
363
inv.root.file_id = file_id
364
inv._byid[inv.root.file_id] = inv.root
367
if entry.parent_id in (None, orig_root_id):
368
entry.parent_id = inv.root.file_id
369
self._write_inventory(inv)
371
def read_working_inventory(self):
372
"""Read the working inventory."""
373
from bzrlib.inventory import Inventory
374
from bzrlib.xml import unpack_xml
375
from time import time
379
# ElementTree does its own conversion from UTF-8, so open in
381
inv = unpack_xml(Inventory,
382
self.controlfile('inventory', 'rb'))
383
mutter("loaded inventory of %d items in %f"
384
% (len(inv), time() - before))
390
def _write_inventory(self, inv):
391
"""Update the working inventory.
393
That is to say, the inventory describing changes underway, that
394
will be committed to the next revision.
396
from bzrlib.atomicfile import AtomicFile
397
from bzrlib.xml import pack_xml
401
f = AtomicFile(self.controlfilename('inventory'), 'wb')
410
mutter('wrote working inventory')
413
inventory = property(read_working_inventory, _write_inventory, None,
414
"""Inventory for the working copy.""")
417
def add(self, files, ids=None):
418
"""Make files versioned.
420
Note that the command line normally calls smart_add instead,
421
which can automatically recurse.
423
This puts the files in the Added state, so that they will be
424
recorded by the next commit.
427
List of paths to add, relative to the base of the tree.
430
If set, use these instead of automatically generated ids.
431
Must be the same length as the list of files, but may
432
contain None for ids that are to be autogenerated.
434
TODO: Perhaps have an option to add the ids even if the files do
437
TODO: Perhaps yield the ids and paths as they're added.
439
# TODO: Re-adding a file that is removed in the working copy
440
# should probably put it back with the previous ID.
441
if isinstance(files, basestring):
442
assert(ids is None or isinstance(ids, basestring))
448
ids = [None] * len(files)
450
assert(len(ids) == len(files))
454
inv = self.read_working_inventory()
455
for f,file_id in zip(files, ids):
456
if is_control_file(f):
457
raise BzrError("cannot add control file %s" % quotefn(f))
462
raise BzrError("cannot add top-level %r" % f)
464
fullpath = os.path.normpath(self.abspath(f))
467
kind = file_kind(fullpath)
469
# maybe something better?
470
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
472
if kind != 'file' and kind != 'directory':
473
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
476
file_id = gen_file_id(f)
477
inv.add_path(f, kind=kind, file_id=file_id)
479
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
481
self._write_inventory(inv)
486
def print_file(self, file, revno):
487
"""Print `file` to stdout."""
490
tree = self.revision_tree(self.lookup_revision(revno))
491
# use inventory as it was in that revision
492
file_id = tree.inventory.path2id(file)
494
raise BzrError("%r is not present in revision %s" % (file, revno))
495
tree.print_file(file_id)
500
def remove(self, files, verbose=False):
501
"""Mark nominated files for removal from the inventory.
503
This does not remove their text. This does not run on
505
TODO: Refuse to remove modified files unless --force is given?
507
TODO: Do something useful with directories.
509
TODO: Should this remove the text or not? Tough call; not
510
removing may be useful and the user can just use use rm, and
511
is the opposite of add. Removing it is consistent with most
512
other tools. Maybe an option.
514
## TODO: Normalize names
515
## TODO: Remove nested loops; better scalability
516
if isinstance(files, basestring):
522
tree = self.working_tree()
525
# do this before any modifications
529
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
530
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
532
# having remove it, it must be either ignored or unknown
533
if tree.is_ignored(f):
537
show_status(new_status, inv[fid].kind, quotefn(f))
540
self._write_inventory(inv)
545
# FIXME: this doesn't need to be a branch method
546
def set_inventory(self, new_inventory_list):
547
from bzrlib.inventory import Inventory, InventoryEntry
548
inv = Inventory(self.get_root_id())
549
for path, file_id, parent, kind in new_inventory_list:
550
name = os.path.basename(path)
553
inv.add(InventoryEntry(file_id, name, kind, parent))
554
self._write_inventory(inv)
558
"""Return all unknown files.
560
These are files in the working directory that are not versioned or
561
control files or ignored.
563
>>> b = ScratchBranch(files=['foo', 'foo~'])
564
>>> list(b.unknowns())
567
>>> list(b.unknowns())
570
>>> list(b.unknowns())
573
return self.working_tree().unknowns()
576
def append_revision(self, *revision_ids):
577
from bzrlib.atomicfile import AtomicFile
579
for revision_id in revision_ids:
580
mutter("add {%s} to revision-history" % revision_id)
582
rev_history = self.revision_history()
583
rev_history.extend(revision_ids)
585
f = AtomicFile(self.controlfilename('revision-history'))
587
for rev_id in rev_history:
594
def get_revision_xml(self, revision_id):
595
"""Return XML file object for revision object."""
596
if not revision_id or not isinstance(revision_id, basestring):
597
raise InvalidRevisionId(revision_id)
602
return self.revision_store[revision_id]
604
raise bzrlib.errors.NoSuchRevision(self, revision_id)
609
def get_revision(self, revision_id):
610
"""Return the Revision object for a named revision"""
611
xml_file = self.get_revision_xml(revision_id)
614
r = unpack_xml(Revision, xml_file)
615
except SyntaxError, e:
616
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
620
assert r.revision_id == revision_id
624
def get_revision_delta(self, revno):
625
"""Return the delta for one revision.
627
The delta is relative to its mainline predecessor, or the
628
empty tree for revision 1.
630
assert isinstance(revno, int)
631
rh = self.revision_history()
632
if not (1 <= revno <= len(rh)):
633
raise InvalidRevisionNumber(revno)
635
# revno is 1-based; list is 0-based
637
new_tree = self.revision_tree(rh[revno-1])
639
old_tree = EmptyTree()
641
old_tree = self.revision_tree(rh[revno-2])
643
return compare_trees(old_tree, new_tree)
647
def get_revision_sha1(self, revision_id):
648
"""Hash the stored value of a revision, and return it."""
649
# In the future, revision entries will be signed. At that
650
# point, it is probably best *not* to include the signature
651
# in the revision hash. Because that lets you re-sign
652
# the revision, (add signatures/remove signatures) and still
653
# have all hash pointers stay consistent.
654
# But for now, just hash the contents.
655
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
658
def get_inventory(self, inventory_id):
659
"""Get Inventory object by hash.
661
TODO: Perhaps for this and similar methods, take a revision
662
parameter which can be either an integer revno or a
664
from bzrlib.inventory import Inventory
665
from bzrlib.xml import unpack_xml
667
return unpack_xml(Inventory, self.get_inventory_xml(inventory_id))
670
def get_inventory_xml(self, inventory_id):
671
"""Get inventory XML as a file object."""
672
return self.inventory_store[inventory_id]
675
def get_inventory_sha1(self, inventory_id):
676
"""Return the sha1 hash of the inventory entry
678
return sha_file(self.get_inventory_xml(inventory_id))
681
def get_revision_inventory(self, revision_id):
682
"""Return inventory of a past revision."""
683
# bzr 0.0.6 imposes the constraint that the inventory_id
684
# must be the same as its revision, so this is trivial.
685
if revision_id == None:
686
from bzrlib.inventory import Inventory
687
return Inventory(self.get_root_id())
689
return self.get_inventory(revision_id)
692
def revision_history(self):
693
"""Return sequence of revision hashes on to this branch.
695
>>> ScratchBranch().revision_history()
700
return [l.rstrip('\r\n') for l in
701
self.controlfile('revision-history', 'r').readlines()]
706
def common_ancestor(self, other, self_revno=None, other_revno=None):
709
>>> sb = ScratchBranch(files=['foo', 'foo~'])
710
>>> sb.common_ancestor(sb) == (None, None)
712
>>> commit.commit(sb, "Committing first revision", verbose=False)
713
>>> sb.common_ancestor(sb)[0]
715
>>> clone = sb.clone()
716
>>> commit.commit(sb, "Committing second revision", verbose=False)
717
>>> sb.common_ancestor(sb)[0]
719
>>> sb.common_ancestor(clone)[0]
721
>>> commit.commit(clone, "Committing divergent second revision",
723
>>> sb.common_ancestor(clone)[0]
725
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
727
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
729
>>> clone2 = sb.clone()
730
>>> sb.common_ancestor(clone2)[0]
732
>>> sb.common_ancestor(clone2, self_revno=1)[0]
734
>>> sb.common_ancestor(clone2, other_revno=1)[0]
737
my_history = self.revision_history()
738
other_history = other.revision_history()
739
if self_revno is None:
740
self_revno = len(my_history)
741
if other_revno is None:
742
other_revno = len(other_history)
743
indices = range(min((self_revno, other_revno)))
746
if my_history[r] == other_history[r]:
747
return r+1, my_history[r]
752
"""Return current revision number for this branch.
754
That is equivalent to the number of revisions committed to
757
return len(self.revision_history())
760
def last_patch(self):
761
"""Return last patch hash, or None if no history.
763
ph = self.revision_history()
770
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
772
If self and other have not diverged, return a list of the revisions
773
present in other, but missing from self.
775
>>> from bzrlib.commit import commit
776
>>> bzrlib.trace.silent = True
777
>>> br1 = ScratchBranch()
778
>>> br2 = ScratchBranch()
779
>>> br1.missing_revisions(br2)
781
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
782
>>> br1.missing_revisions(br2)
784
>>> br2.missing_revisions(br1)
786
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
787
>>> br1.missing_revisions(br2)
789
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
790
>>> br1.missing_revisions(br2)
792
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
793
>>> br1.missing_revisions(br2)
794
Traceback (most recent call last):
795
DivergedBranches: These branches have diverged.
797
self_history = self.revision_history()
798
self_len = len(self_history)
799
other_history = other.revision_history()
800
other_len = len(other_history)
801
common_index = min(self_len, other_len) -1
802
if common_index >= 0 and \
803
self_history[common_index] != other_history[common_index]:
804
raise DivergedBranches(self, other)
806
if stop_revision is None:
807
stop_revision = other_len
808
elif stop_revision > other_len:
809
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
811
return other_history[self_len:stop_revision]
814
def update_revisions(self, other, stop_revision=None):
815
"""Pull in all new revisions from other branch.
817
from bzrlib.fetch import greedy_fetch
819
pb = bzrlib.ui.ui_factory.progress_bar()
820
pb.update('comparing histories')
822
revision_ids = self.missing_revisions(other, stop_revision)
824
if len(revision_ids) > 0:
825
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
828
self.append_revision(*revision_ids)
829
## note("Added %d revisions." % count)
834
def install_revisions(self, other, revision_ids, pb):
835
if hasattr(other.revision_store, "prefetch"):
836
other.revision_store.prefetch(revision_ids)
837
if hasattr(other.inventory_store, "prefetch"):
838
inventory_ids = [other.get_revision(r).inventory_id
839
for r in revision_ids]
840
other.inventory_store.prefetch(inventory_ids)
843
pb = bzrlib.ui.ui_factory.progress_bar()
850
for i, rev_id in enumerate(revision_ids):
851
pb.update('fetching revision', i+1, len(revision_ids))
853
rev = other.get_revision(rev_id)
854
except bzrlib.errors.NoSuchRevision:
858
revisions.append(rev)
859
inv = other.get_inventory(str(rev.inventory_id))
860
for key, entry in inv.iter_entries():
861
if entry.text_id is None:
863
if entry.text_id not in self.text_store:
864
needed_texts.add(entry.text_id)
868
count, cp_fail = self.text_store.copy_multi(other.text_store,
870
#print "Added %d texts." % count
871
inventory_ids = [ f.inventory_id for f in revisions ]
872
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
874
#print "Added %d inventories." % count
875
revision_ids = [ f.revision_id for f in revisions]
877
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
880
assert len(cp_fail) == 0
881
return count, failures
884
def commit(self, *args, **kw):
885
from bzrlib.commit import commit
886
commit(self, *args, **kw)
889
def lookup_revision(self, revision):
890
"""Return the revision identifier for a given revision information."""
891
revno, info = self.get_revision_info(revision)
895
def revision_id_to_revno(self, revision_id):
896
"""Given a revision id, return its revno"""
897
history = self.revision_history()
899
return history.index(revision_id) + 1
901
raise bzrlib.errors.NoSuchRevision(self, revision_id)
904
def get_revision_info(self, revision):
905
"""Return (revno, revision id) for revision identifier.
907
revision can be an integer, in which case it is assumed to be revno (though
908
this will translate negative values into positive ones)
909
revision can also be a string, in which case it is parsed for something like
910
'date:' or 'revid:' etc.
915
try:# Convert to int if possible
916
revision = int(revision)
919
revs = self.revision_history()
920
if isinstance(revision, int):
923
# Mabye we should do this first, but we don't need it if revision == 0
925
revno = len(revs) + revision + 1
928
elif isinstance(revision, basestring):
929
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
930
if revision.startswith(prefix):
931
revno = func(self, revs, revision)
934
raise BzrError('No namespace registered for string: %r' % revision)
936
if revno is None or revno <= 0 or revno > len(revs):
937
raise BzrError("no such revision %s" % revision)
938
return revno, revs[revno-1]
940
def _namespace_revno(self, revs, revision):
941
"""Lookup a revision by revision number"""
942
assert revision.startswith('revno:')
944
return int(revision[6:])
947
REVISION_NAMESPACES['revno:'] = _namespace_revno
949
def _namespace_revid(self, revs, revision):
950
assert revision.startswith('revid:')
952
return revs.index(revision[6:]) + 1
955
REVISION_NAMESPACES['revid:'] = _namespace_revid
957
def _namespace_last(self, revs, revision):
958
assert revision.startswith('last:')
960
offset = int(revision[5:])
965
raise BzrError('You must supply a positive value for --revision last:XXX')
966
return len(revs) - offset + 1
967
REVISION_NAMESPACES['last:'] = _namespace_last
969
def _namespace_tag(self, revs, revision):
970
assert revision.startswith('tag:')
971
raise BzrError('tag: namespace registered, but not implemented.')
972
REVISION_NAMESPACES['tag:'] = _namespace_tag
974
def _namespace_date(self, revs, revision):
975
assert revision.startswith('date:')
977
# Spec for date revisions:
979
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
980
# it can also start with a '+/-/='. '+' says match the first
981
# entry after the given date. '-' is match the first entry before the date
982
# '=' is match the first entry after, but still on the given date.
984
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
985
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
986
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
987
# May 13th, 2005 at 0:00
989
# So the proper way of saying 'give me all entries for today' is:
990
# -r {date:+today}:{date:-tomorrow}
991
# The default is '=' when not supplied
994
if val[:1] in ('+', '-', '='):
995
match_style = val[:1]
998
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
999
if val.lower() == 'yesterday':
1000
dt = today - datetime.timedelta(days=1)
1001
elif val.lower() == 'today':
1003
elif val.lower() == 'tomorrow':
1004
dt = today + datetime.timedelta(days=1)
1007
# This should be done outside the function to avoid recompiling it.
1008
_date_re = re.compile(
1009
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1011
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1013
m = _date_re.match(val)
1014
if not m or (not m.group('date') and not m.group('time')):
1015
raise BzrError('Invalid revision date %r' % revision)
1018
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1020
year, month, day = today.year, today.month, today.day
1022
hour = int(m.group('hour'))
1023
minute = int(m.group('minute'))
1024
if m.group('second'):
1025
second = int(m.group('second'))
1029
hour, minute, second = 0,0,0
1031
dt = datetime.datetime(year=year, month=month, day=day,
1032
hour=hour, minute=minute, second=second)
1036
if match_style == '-':
1038
elif match_style == '=':
1039
last = dt + datetime.timedelta(days=1)
1042
for i in range(len(revs)-1, -1, -1):
1043
r = self.get_revision(revs[i])
1044
# TODO: Handle timezone.
1045
dt = datetime.datetime.fromtimestamp(r.timestamp)
1046
if first >= dt and (last is None or dt >= last):
1049
for i in range(len(revs)):
1050
r = self.get_revision(revs[i])
1051
# TODO: Handle timezone.
1052
dt = datetime.datetime.fromtimestamp(r.timestamp)
1053
if first <= dt and (last is None or dt <= last):
1055
REVISION_NAMESPACES['date:'] = _namespace_date
1057
def revision_tree(self, revision_id):
1058
"""Return Tree for a revision on this branch.
1060
`revision_id` may be None for the null revision, in which case
1061
an `EmptyTree` is returned."""
1062
# TODO: refactor this to use an existing revision object
1063
# so we don't need to read it in twice.
1064
if revision_id == None:
1067
inv = self.get_revision_inventory(revision_id)
1068
return RevisionTree(self.text_store, inv)
1071
def working_tree(self):
1072
"""Return a `Tree` for the working copy."""
1073
from workingtree import WorkingTree
1074
return WorkingTree(self.base, self.read_working_inventory())
1077
def basis_tree(self):
1078
"""Return `Tree` object for last revision.
1080
If there are no revisions yet, return an `EmptyTree`.
1082
r = self.last_patch()
1086
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1090
def rename_one(self, from_rel, to_rel):
1093
This can change the directory or the filename or both.
1097
tree = self.working_tree()
1098
inv = tree.inventory
1099
if not tree.has_filename(from_rel):
1100
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1101
if tree.has_filename(to_rel):
1102
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1104
file_id = inv.path2id(from_rel)
1106
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1108
if inv.path2id(to_rel):
1109
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1111
to_dir, to_tail = os.path.split(to_rel)
1112
to_dir_id = inv.path2id(to_dir)
1113
if to_dir_id == None and to_dir != '':
1114
raise BzrError("can't determine destination directory id for %r" % to_dir)
1116
mutter("rename_one:")
1117
mutter(" file_id {%s}" % file_id)
1118
mutter(" from_rel %r" % from_rel)
1119
mutter(" to_rel %r" % to_rel)
1120
mutter(" to_dir %r" % to_dir)
1121
mutter(" to_dir_id {%s}" % to_dir_id)
1123
inv.rename(file_id, to_dir_id, to_tail)
1125
from_abs = self.abspath(from_rel)
1126
to_abs = self.abspath(to_rel)
1128
os.rename(from_abs, to_abs)
1130
raise BzrError("failed to rename %r to %r: %s"
1131
% (from_abs, to_abs, e[1]),
1132
["rename rolled back"])
1134
self._write_inventory(inv)
1139
def move(self, from_paths, to_name):
1142
to_name must exist as a versioned directory.
1144
If to_name exists and is a directory, the files are moved into
1145
it, keeping their old names. If it is a directory,
1147
Note that to_name is only the last component of the new name;
1148
this doesn't change the directory.
1150
This returns a list of (from_path, to_path) pairs for each
1151
entry that is moved.
1156
## TODO: Option to move IDs only
1157
assert not isinstance(from_paths, basestring)
1158
tree = self.working_tree()
1159
inv = tree.inventory
1160
to_abs = self.abspath(to_name)
1161
if not isdir(to_abs):
1162
raise BzrError("destination %r is not a directory" % to_abs)
1163
if not tree.has_filename(to_name):
1164
raise BzrError("destination %r not in working directory" % to_abs)
1165
to_dir_id = inv.path2id(to_name)
1166
if to_dir_id == None and to_name != '':
1167
raise BzrError("destination %r is not a versioned directory" % to_name)
1168
to_dir_ie = inv[to_dir_id]
1169
if to_dir_ie.kind not in ('directory', 'root_directory'):
1170
raise BzrError("destination %r is not a directory" % to_abs)
1172
to_idpath = inv.get_idpath(to_dir_id)
1174
for f in from_paths:
1175
if not tree.has_filename(f):
1176
raise BzrError("%r does not exist in working tree" % f)
1177
f_id = inv.path2id(f)
1179
raise BzrError("%r is not versioned" % f)
1180
name_tail = splitpath(f)[-1]
1181
dest_path = appendpath(to_name, name_tail)
1182
if tree.has_filename(dest_path):
1183
raise BzrError("destination %r already exists" % dest_path)
1184
if f_id in to_idpath:
1185
raise BzrError("can't move %r to a subdirectory of itself" % f)
1187
# OK, so there's a race here, it's possible that someone will
1188
# create a file in this interval and then the rename might be
1189
# left half-done. But we should have caught most problems.
1191
for f in from_paths:
1192
name_tail = splitpath(f)[-1]
1193
dest_path = appendpath(to_name, name_tail)
1194
result.append((f, dest_path))
1195
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1197
os.rename(self.abspath(f), self.abspath(dest_path))
1199
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1200
["rename rolled back"])
1202
self._write_inventory(inv)
1209
def revert(self, filenames, old_tree=None, backups=True):
1210
"""Restore selected files to the versions from a previous tree.
1213
If true (default) backups are made of files before
1216
from bzrlib.errors import NotVersionedError, BzrError
1217
from bzrlib.atomicfile import AtomicFile
1218
from bzrlib.osutils import backup_file
1220
inv = self.read_working_inventory()
1221
if old_tree is None:
1222
old_tree = self.basis_tree()
1223
old_inv = old_tree.inventory
1226
for fn in filenames:
1227
file_id = inv.path2id(fn)
1229
raise NotVersionedError("not a versioned file", fn)
1230
if not old_inv.has_id(file_id):
1231
raise BzrError("file not present in old tree", fn, file_id)
1232
nids.append((fn, file_id))
1234
# TODO: Rename back if it was previously at a different location
1236
# TODO: If given a directory, restore the entire contents from
1237
# the previous version.
1239
# TODO: Make a backup to a temporary file.
1241
# TODO: If the file previously didn't exist, delete it?
1242
for fn, file_id in nids:
1245
f = AtomicFile(fn, 'wb')
1247
f.write(old_tree.get_file(file_id).read())
1253
def pending_merges(self):
1254
"""Return a list of pending merges.
1256
These are revisions that have been merged into the working
1257
directory but not yet committed.
1259
cfn = self.controlfilename('pending-merges')
1260
if not os.path.exists(cfn):
1263
for l in self.controlfile('pending-merges', 'r').readlines():
1264
p.append(l.rstrip('\n'))
1268
def add_pending_merge(self, revision_id):
1269
from bzrlib.revision import validate_revision_id
1271
validate_revision_id(revision_id)
1273
p = self.pending_merges()
1274
if revision_id in p:
1276
p.append(revision_id)
1277
self.set_pending_merges(p)
1280
def set_pending_merges(self, rev_list):
1281
from bzrlib.atomicfile import AtomicFile
1284
f = AtomicFile(self.controlfilename('pending-merges'))
1296
class ScratchBranch(Branch):
1297
"""Special test class: a branch that cleans up after itself.
1299
>>> b = ScratchBranch()
1307
def __init__(self, files=[], dirs=[], base=None):
1308
"""Make a test branch.
1310
This creates a temporary directory and runs init-tree in it.
1312
If any files are listed, they are created in the working copy.
1314
from tempfile import mkdtemp
1319
Branch.__init__(self, base, init=init)
1321
os.mkdir(self.abspath(d))
1324
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1329
>>> orig = ScratchBranch(files=["file1", "file2"])
1330
>>> clone = orig.clone()
1331
>>> os.path.samefile(orig.base, clone.base)
1333
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1336
from shutil import copytree
1337
from tempfile import mkdtemp
1340
copytree(self.base, base, symlinks=True)
1341
return ScratchBranch(base=base)
1347
"""Destroy the test branch, removing the scratch directory."""
1348
from shutil import rmtree
1351
mutter("delete ScratchBranch %s" % self.base)
1354
# Work around for shutil.rmtree failing on Windows when
1355
# readonly files are encountered
1356
mutter("hit exception in destroying ScratchBranch: %s" % e)
1357
for root, dirs, files in os.walk(self.base, topdown=False):
1359
os.chmod(os.path.join(root, name), 0700)
1365
######################################################################
1369
def is_control_file(filename):
1370
## FIXME: better check
1371
filename = os.path.normpath(filename)
1372
while filename != '':
1373
head, tail = os.path.split(filename)
1374
## mutter('check %r for control file' % ((head, tail), ))
1375
if tail == bzrlib.BZRDIR:
1377
if filename == head:
1384
def gen_file_id(name):
1385
"""Return new file id.
1387
This should probably generate proper UUIDs, but for the moment we
1388
cope with just randomness because running uuidgen every time is
1391
from binascii import hexlify
1392
from time import time
1394
# get last component
1395
idx = name.rfind('/')
1397
name = name[idx+1 : ]
1398
idx = name.rfind('\\')
1400
name = name[idx+1 : ]
1402
# make it not a hidden file
1403
name = name.lstrip('.')
1405
# remove any wierd characters; we don't escape them but rather
1406
# just pull them out
1407
name = re.sub(r'[^\w.]', '', name)
1409
s = hexlify(rand_bytes(8))
1410
return '-'.join((name, compact_date(time()), s))
1414
"""Return a new tree-root file id."""
1415
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
