1
# Copyright (C) 2005 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
25
sha_file, appendpath, file_kind
27
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
29
from bzrlib.textui import show_status
30
from bzrlib.revision import Revision
31
from bzrlib.delta import compare_trees
32
from bzrlib.tree import EmptyTree, RevisionTree
33
from bzrlib.inventory import Inventory
34
from bzrlib.weavestore import WeaveStore
40
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
41
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
42
## TODO: Maybe include checks for common corruption of newlines, etc?
45
# TODO: Some operations like log might retrieve the same revisions
46
# repeatedly to calculate deltas. We could perhaps have a weakref
47
# cache in memory to make this faster.
49
# TODO: please move the revision-string syntax stuff out of the branch
50
# object; it's clutter
53
def find_branch(f, **args):
54
if f and (f.startswith('http://') or f.startswith('https://')):
56
return remotebranch.RemoteBranch(f, **args)
58
return Branch(f, **args)
61
def find_cached_branch(f, cache_root, **args):
62
from remotebranch import RemoteBranch
63
br = find_branch(f, **args)
64
def cacheify(br, store_name):
65
from meta_store import CachedStore
66
cache_path = os.path.join(cache_root, store_name)
68
new_store = CachedStore(getattr(br, store_name), cache_path)
69
setattr(br, store_name, new_store)
71
if isinstance(br, RemoteBranch):
72
cacheify(br, 'inventory_store')
73
cacheify(br, 'text_store')
74
cacheify(br, 'revision_store')
78
def _relpath(base, path):
79
"""Return path relative to base, or raise exception.
81
The path may be either an absolute path or a path relative to the
82
current working directory.
84
Lifted out of Branch.relpath for ease of testing.
86
os.path.commonprefix (python2.4) has a bad bug that it works just
87
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
88
avoids that problem."""
89
rp = os.path.abspath(path)
93
while len(head) >= len(base):
96
head, tail = os.path.split(head)
100
from errors import NotBranchError
101
raise NotBranchError("path %r is not within branch %r" % (rp, base))
103
return os.sep.join(s)
106
def find_branch_root(f=None):
107
"""Find the branch root enclosing f, or pwd.
109
f may be a filename or a URL.
111
It is not necessary that f exists.
113
Basically we keep looking up until we find the control directory or
114
run into the root. If there isn't one, raises NotBranchError.
118
elif hasattr(os.path, 'realpath'):
119
f = os.path.realpath(f)
121
f = os.path.abspath(f)
122
if not os.path.exists(f):
123
raise BzrError('%r does not exist' % f)
129
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
131
head, tail = os.path.split(f)
133
# reached the root, whatever that may be
134
raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
139
# XXX: move into bzrlib.errors; subclass BzrError
140
class DivergedBranches(Exception):
141
def __init__(self, branch1, branch2):
142
self.branch1 = branch1
143
self.branch2 = branch2
144
Exception.__init__(self, "These branches have diverged.")
147
######################################################################
150
class Branch(object):
151
"""Branch holding a history of revisions.
154
Base directory of the branch.
160
If _lock_mode is true, a positive count of the number of times the
164
Lock object from bzrlib.lock.
171
# Map some sort of prefix into a namespace
172
# stuff like "revno:10", "revid:", etc.
173
# This should match a prefix with a function which accepts
174
REVISION_NAMESPACES = {}
176
def __init__(self, base, init=False, find_root=True):
177
"""Create new branch object at a particular location.
179
base -- Base directory for the branch.
181
init -- If True, create new control files in a previously
182
unversioned directory. If False, the branch must already
185
find_root -- If true and init is false, find the root of the
186
existing branch containing base.
188
In the test suite, creation of new trees is tested using the
189
`ScratchBranch` class.
191
from bzrlib.store import ImmutableStore
193
self.base = os.path.realpath(base)
196
self.base = find_branch_root(base)
198
self.base = os.path.realpath(base)
199
if not isdir(self.controlfilename('.')):
200
from errors import NotBranchError
201
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
202
['use "bzr init" to initialize a new working tree',
203
'current bzr can only operate from top-of-tree'])
206
self.weave_store = WeaveStore(self.controlfilename('weaves'))
207
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
208
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
212
return '%s(%r)' % (self.__class__.__name__, self.base)
219
if self._lock_mode or self._lock:
220
from warnings import warn
221
warn("branch %r was not explicitly unlocked" % self)
225
def lock_write(self):
227
if self._lock_mode != 'w':
228
from errors import LockError
229
raise LockError("can't upgrade to a write lock from %r" %
231
self._lock_count += 1
233
from bzrlib.lock import WriteLock
235
self._lock = WriteLock(self.controlfilename('branch-lock'))
236
self._lock_mode = 'w'
242
assert self._lock_mode in ('r', 'w'), \
243
"invalid lock mode %r" % self._lock_mode
244
self._lock_count += 1
246
from bzrlib.lock import ReadLock
248
self._lock = ReadLock(self.controlfilename('branch-lock'))
249
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
264
def abspath(self, name):
265
"""Return absolute filename for something in the branch"""
266
return os.path.join(self.base, name)
268
def relpath(self, path):
269
"""Return path relative to this branch of something inside it.
271
Raises an error if path is not in this branch."""
272
return _relpath(self.base, path)
274
def controlfilename(self, file_or_path):
275
"""Return location relative to branch."""
276
if isinstance(file_or_path, basestring):
277
file_or_path = [file_or_path]
278
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
281
def controlfile(self, file_or_path, mode='r'):
282
"""Open a control file for this branch.
284
There are two classes of file in the control directory: text
285
and binary. binary files are untranslated byte streams. Text
286
control files are stored with Unix newlines and in UTF-8, even
287
if the platform or locale defaults are different.
289
Controlfiles should almost never be opened in write mode but
290
rather should be atomically copied and replaced using atomicfile.
293
fn = self.controlfilename(file_or_path)
295
if mode == 'rb' or mode == 'wb':
296
return file(fn, mode)
297
elif mode == 'r' or mode == 'w':
298
# open in binary mode anyhow so there's no newline translation;
299
# codecs uses line buffering by default; don't want that.
301
return codecs.open(fn, mode + 'b', 'utf-8',
304
raise BzrError("invalid controlfile mode %r" % mode)
306
def _make_control(self):
307
os.mkdir(self.controlfilename([]))
308
self.controlfile('README', 'w').write(
309
"This is a Bazaar-NG control directory.\n"
310
"Do not change any files in this directory.\n")
311
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
312
for d in ('text-store', 'inventory-store', 'revision-store',
314
os.mkdir(self.controlfilename(d))
315
for f in ('revision-history', 'merged-patches',
316
'pending-merged-patches', 'branch-name',
319
self.controlfile(f, 'w').write('')
320
mutter('created control directory in ' + self.base)
322
# if we want per-tree root ids then this is the place to set
323
# them; they're not needed for now and so ommitted for
325
f = self.controlfile('inventory','w')
326
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
329
def _check_format(self):
330
"""Check this branch format is supported.
332
The format level is stored, as an integer, in
333
self._branch_format for code that needs to check it later.
335
In the future, we might need different in-memory Branch
336
classes to support downlevel branches. But not yet.
338
fmt = self.controlfile('branch-format', 'r').read()
339
if fmt == BZR_BRANCH_FORMAT_5:
340
self._branch_format = 5
342
raise BzrError('sorry, branch format "%s" not supported; '
343
'use a different bzr version, '
344
'or run "bzr upgrade", '
345
'or remove the .bzr directory and "bzr init" again'
346
% fmt.rstrip('\n\r'))
348
def get_root_id(self):
349
"""Return the id of this branches root"""
350
inv = self.read_working_inventory()
351
return inv.root.file_id
353
def set_root_id(self, file_id):
354
inv = self.read_working_inventory()
355
orig_root_id = inv.root.file_id
356
del inv._byid[inv.root.file_id]
357
inv.root.file_id = file_id
358
inv._byid[inv.root.file_id] = inv.root
361
if entry.parent_id in (None, orig_root_id):
362
entry.parent_id = inv.root.file_id
363
self._write_inventory(inv)
365
def read_working_inventory(self):
366
"""Read the working inventory."""
369
# ElementTree does its own conversion from UTF-8, so open in
371
f = self.controlfile('inventory', 'rb')
372
return bzrlib.xml5.serializer_v5.read_inventory(f)
377
def _write_inventory(self, inv):
378
"""Update the working inventory.
380
That is to say, the inventory describing changes underway, that
381
will be committed to the next revision.
383
from bzrlib.atomicfile import AtomicFile
387
f = AtomicFile(self.controlfilename('inventory'), 'wb')
389
bzrlib.xml5.serializer_v5.write_inventory(inv, f)
396
mutter('wrote working inventory')
399
inventory = property(read_working_inventory, _write_inventory, None,
400
"""Inventory for the working copy.""")
403
def add(self, files, ids=None):
404
"""Make files versioned.
406
Note that the command line normally calls smart_add instead,
407
which can automatically recurse.
409
This puts the files in the Added state, so that they will be
410
recorded by the next commit.
413
List of paths to add, relative to the base of the tree.
416
If set, use these instead of automatically generated ids.
417
Must be the same length as the list of files, but may
418
contain None for ids that are to be autogenerated.
420
TODO: Perhaps have an option to add the ids even if the files do
423
TODO: Perhaps yield the ids and paths as they're added.
425
# TODO: Re-adding a file that is removed in the working copy
426
# should probably put it back with the previous ID.
427
if isinstance(files, basestring):
428
assert(ids is None or isinstance(ids, basestring))
434
ids = [None] * len(files)
436
assert(len(ids) == len(files))
440
inv = self.read_working_inventory()
441
for f,file_id in zip(files, ids):
442
if is_control_file(f):
443
raise BzrError("cannot add control file %s" % quotefn(f))
448
raise BzrError("cannot add top-level %r" % f)
450
fullpath = os.path.normpath(self.abspath(f))
453
kind = file_kind(fullpath)
455
# maybe something better?
456
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
458
if kind != 'file' and kind != 'directory':
459
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
462
file_id = gen_file_id(f)
463
inv.add_path(f, kind=kind, file_id=file_id)
465
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
467
self._write_inventory(inv)
472
def print_file(self, file, revno):
473
"""Print `file` to stdout."""
476
tree = self.revision_tree(self.lookup_revision(revno))
477
# use inventory as it was in that revision
478
file_id = tree.inventory.path2id(file)
480
raise BzrError("%r is not present in revision %s" % (file, revno))
481
tree.print_file(file_id)
486
def remove(self, files, verbose=False):
487
"""Mark nominated files for removal from the inventory.
489
This does not remove their text. This does not run on
491
TODO: Refuse to remove modified files unless --force is given?
493
TODO: Do something useful with directories.
495
TODO: Should this remove the text or not? Tough call; not
496
removing may be useful and the user can just use use rm, and
497
is the opposite of add. Removing it is consistent with most
498
other tools. Maybe an option.
500
## TODO: Normalize names
501
## TODO: Remove nested loops; better scalability
502
if isinstance(files, basestring):
508
tree = self.working_tree()
511
# do this before any modifications
515
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
516
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
518
# having remove it, it must be either ignored or unknown
519
if tree.is_ignored(f):
523
show_status(new_status, inv[fid].kind, quotefn(f))
526
self._write_inventory(inv)
531
# FIXME: this doesn't need to be a branch method
532
def set_inventory(self, new_inventory_list):
533
from bzrlib.inventory import Inventory, InventoryEntry
534
inv = Inventory(self.get_root_id())
535
for path, file_id, parent, kind in new_inventory_list:
536
name = os.path.basename(path)
539
inv.add(InventoryEntry(file_id, name, kind, parent))
540
self._write_inventory(inv)
544
"""Return all unknown files.
546
These are files in the working directory that are not versioned or
547
control files or ignored.
549
>>> b = ScratchBranch(files=['foo', 'foo~'])
550
>>> list(b.unknowns())
553
>>> list(b.unknowns())
556
>>> list(b.unknowns())
559
return self.working_tree().unknowns()
562
def append_revision(self, *revision_ids):
563
from bzrlib.atomicfile import AtomicFile
565
for revision_id in revision_ids:
566
mutter("add {%s} to revision-history" % revision_id)
568
rev_history = self.revision_history()
569
rev_history.extend(revision_ids)
571
f = AtomicFile(self.controlfilename('revision-history'))
573
for rev_id in rev_history:
580
def get_revision_xml_file(self, revision_id):
581
"""Return XML file object for revision object."""
582
if not revision_id or not isinstance(revision_id, basestring):
583
raise InvalidRevisionId(revision_id)
588
return self.revision_store[revision_id]
590
raise bzrlib.errors.NoSuchRevision(self, revision_id)
596
get_revision_xml = get_revision_xml_file
599
def get_revision(self, revision_id):
600
"""Return the Revision object for a named revision"""
601
xml_file = self.get_revision_xml_file(revision_id)
604
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
605
except SyntaxError, e:
606
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
610
assert r.revision_id == revision_id
614
def get_revision_delta(self, revno):
615
"""Return the delta for one revision.
617
The delta is relative to its mainline predecessor, or the
618
empty tree for revision 1.
620
assert isinstance(revno, int)
621
rh = self.revision_history()
622
if not (1 <= revno <= len(rh)):
623
raise InvalidRevisionNumber(revno)
625
# revno is 1-based; list is 0-based
627
new_tree = self.revision_tree(rh[revno-1])
629
old_tree = EmptyTree()
631
old_tree = self.revision_tree(rh[revno-2])
633
return compare_trees(old_tree, new_tree)
637
def get_revision_sha1(self, revision_id):
638
"""Hash the stored value of a revision, and return it."""
639
# In the future, revision entries will be signed. At that
640
# point, it is probably best *not* to include the signature
641
# in the revision hash. Because that lets you re-sign
642
# the revision, (add signatures/remove signatures) and still
643
# have all hash pointers stay consistent.
644
# But for now, just hash the contents.
645
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
648
def get_inventory(self, revision_id):
649
"""Get Inventory object by hash.
651
TODO: Perhaps for this and similar methods, take a revision
652
parameter which can be either an integer revno or a
654
f = self.get_inventory_xml_file(revision_id)
655
return bzrlib.xml5.serializer_v5.read_inventory(f)
658
def get_inventory_xml(self, revision_id):
659
"""Get inventory XML as a file object."""
661
assert isinstance(revision_id, basestring), type(revision_id)
662
return self.inventory_store[revision_id]
664
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
666
get_inventory_xml_file = get_inventory_xml
669
def get_inventory_sha1(self, revision_id):
670
"""Return the sha1 hash of the inventory entry
672
return sha_file(self.get_inventory_xml_file(revision_id))
675
def get_revision_inventory(self, revision_id):
676
"""Return inventory of a past revision."""
677
# bzr 0.0.6 and later imposes the constraint that the inventory_id
678
# must be the same as its revision, so this is trivial.
679
if revision_id == None:
680
return Inventory(self.get_root_id())
682
return self.get_inventory(revision_id)
685
def revision_history(self):
686
"""Return sequence of revision hashes on to this branch.
688
>>> ScratchBranch().revision_history()
693
return [l.rstrip('\r\n') for l in
694
self.controlfile('revision-history', 'r').readlines()]
699
def common_ancestor(self, other, self_revno=None, other_revno=None):
702
>>> sb = ScratchBranch(files=['foo', 'foo~'])
703
>>> sb.common_ancestor(sb) == (None, None)
705
>>> commit.commit(sb, "Committing first revision")
706
>>> sb.common_ancestor(sb)[0]
708
>>> clone = sb.clone()
709
>>> commit.commit(sb, "Committing second revision")
710
>>> sb.common_ancestor(sb)[0]
712
>>> sb.common_ancestor(clone)[0]
714
>>> commit.commit(clone, "Committing divergent second revision")
715
>>> sb.common_ancestor(clone)[0]
717
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
719
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
721
>>> clone2 = sb.clone()
722
>>> sb.common_ancestor(clone2)[0]
724
>>> sb.common_ancestor(clone2, self_revno=1)[0]
726
>>> sb.common_ancestor(clone2, other_revno=1)[0]
729
my_history = self.revision_history()
730
other_history = other.revision_history()
731
if self_revno is None:
732
self_revno = len(my_history)
733
if other_revno is None:
734
other_revno = len(other_history)
735
indices = range(min((self_revno, other_revno)))
738
if my_history[r] == other_history[r]:
739
return r+1, my_history[r]
744
"""Return current revision number for this branch.
746
That is equivalent to the number of revisions committed to
749
return len(self.revision_history())
752
def last_patch(self):
753
"""Return last patch hash, or None if no history.
755
ph = self.revision_history()
762
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
764
If self and other have not diverged, return a list of the revisions
765
present in other, but missing from self.
767
>>> from bzrlib.commit import commit
768
>>> bzrlib.trace.silent = True
769
>>> br1 = ScratchBranch()
770
>>> br2 = ScratchBranch()
771
>>> br1.missing_revisions(br2)
773
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
774
>>> br1.missing_revisions(br2)
776
>>> br2.missing_revisions(br1)
778
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
779
>>> br1.missing_revisions(br2)
781
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
782
>>> br1.missing_revisions(br2)
784
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
785
>>> br1.missing_revisions(br2)
786
Traceback (most recent call last):
787
DivergedBranches: These branches have diverged.
789
self_history = self.revision_history()
790
self_len = len(self_history)
791
other_history = other.revision_history()
792
other_len = len(other_history)
793
common_index = min(self_len, other_len) -1
794
if common_index >= 0 and \
795
self_history[common_index] != other_history[common_index]:
796
raise DivergedBranches(self, other)
798
if stop_revision is None:
799
stop_revision = other_len
800
elif stop_revision > other_len:
801
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
803
return other_history[self_len:stop_revision]
806
def update_revisions(self, other, stop_revision=None):
807
"""Pull in all new revisions from other branch.
809
from bzrlib.fetch import greedy_fetch
811
pb = bzrlib.ui.ui_factory.progress_bar()
812
pb.update('comparing histories')
814
revision_ids = self.missing_revisions(other, stop_revision)
816
if len(revision_ids) > 0:
817
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
820
self.append_revision(*revision_ids)
821
## note("Added %d revisions." % count)
825
def commit(self, *args, **kw):
826
from bzrlib.commit import Commit
827
Commit().commit(self, *args, **kw)
830
def lookup_revision(self, revision):
831
"""Return the revision identifier for a given revision information."""
832
revno, info = self._get_revision_info(revision)
836
def revision_id_to_revno(self, revision_id):
837
"""Given a revision id, return its revno"""
838
history = self.revision_history()
840
return history.index(revision_id) + 1
842
raise bzrlib.errors.NoSuchRevision(self, revision_id)
845
def get_revision_info(self, revision):
846
"""Return (revno, revision id) for revision identifier.
848
revision can be an integer, in which case it is assumed to be revno (though
849
this will translate negative values into positive ones)
850
revision can also be a string, in which case it is parsed for something like
851
'date:' or 'revid:' etc.
853
revno, rev_id = self._get_revision_info(revision)
855
raise bzrlib.errors.NoSuchRevision(self, revision)
858
def get_rev_id(self, revno, history=None):
859
"""Find the revision id of the specified revno."""
863
history = self.revision_history()
864
elif revno <= 0 or revno > len(history):
865
raise bzrlib.errors.NoSuchRevision(self, revno)
866
return history[revno - 1]
868
def _get_revision_info(self, revision):
869
"""Return (revno, revision id) for revision specifier.
871
revision can be an integer, in which case it is assumed to be revno
872
(though this will translate negative values into positive ones)
873
revision can also be a string, in which case it is parsed for something
874
like 'date:' or 'revid:' etc.
876
A revid is always returned. If it is None, the specifier referred to
877
the null revision. If the revid does not occur in the revision
878
history, revno will be None.
884
try:# Convert to int if possible
885
revision = int(revision)
888
revs = self.revision_history()
889
if isinstance(revision, int):
891
revno = len(revs) + revision + 1
894
rev_id = self.get_rev_id(revno, revs)
895
elif isinstance(revision, basestring):
896
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
897
if revision.startswith(prefix):
898
result = func(self, revs, revision)
900
revno, rev_id = result
903
rev_id = self.get_rev_id(revno, revs)
906
raise BzrError('No namespace registered for string: %r' %
909
raise TypeError('Unhandled revision type %s' % revision)
913
raise bzrlib.errors.NoSuchRevision(self, revision)
916
def _namespace_revno(self, revs, revision):
917
"""Lookup a revision by revision number"""
918
assert revision.startswith('revno:')
920
return (int(revision[6:]),)
923
REVISION_NAMESPACES['revno:'] = _namespace_revno
925
def _namespace_revid(self, revs, revision):
926
assert revision.startswith('revid:')
927
rev_id = revision[len('revid:'):]
929
return revs.index(rev_id) + 1, rev_id
932
REVISION_NAMESPACES['revid:'] = _namespace_revid
934
def _namespace_last(self, revs, revision):
935
assert revision.startswith('last:')
937
offset = int(revision[5:])
942
raise BzrError('You must supply a positive value for --revision last:XXX')
943
return (len(revs) - offset + 1,)
944
REVISION_NAMESPACES['last:'] = _namespace_last
946
def _namespace_tag(self, revs, revision):
947
assert revision.startswith('tag:')
948
raise BzrError('tag: namespace registered, but not implemented.')
949
REVISION_NAMESPACES['tag:'] = _namespace_tag
951
def _namespace_date(self, revs, revision):
952
assert revision.startswith('date:')
954
# Spec for date revisions:
956
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
957
# it can also start with a '+/-/='. '+' says match the first
958
# entry after the given date. '-' is match the first entry before the date
959
# '=' is match the first entry after, but still on the given date.
961
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
962
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
963
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
964
# May 13th, 2005 at 0:00
966
# So the proper way of saying 'give me all entries for today' is:
967
# -r {date:+today}:{date:-tomorrow}
968
# The default is '=' when not supplied
971
if val[:1] in ('+', '-', '='):
972
match_style = val[:1]
975
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
976
if val.lower() == 'yesterday':
977
dt = today - datetime.timedelta(days=1)
978
elif val.lower() == 'today':
980
elif val.lower() == 'tomorrow':
981
dt = today + datetime.timedelta(days=1)
984
# This should be done outside the function to avoid recompiling it.
985
_date_re = re.compile(
986
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
988
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
990
m = _date_re.match(val)
991
if not m or (not m.group('date') and not m.group('time')):
992
raise BzrError('Invalid revision date %r' % revision)
995
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
997
year, month, day = today.year, today.month, today.day
999
hour = int(m.group('hour'))
1000
minute = int(m.group('minute'))
1001
if m.group('second'):
1002
second = int(m.group('second'))
1006
hour, minute, second = 0,0,0
1008
dt = datetime.datetime(year=year, month=month, day=day,
1009
hour=hour, minute=minute, second=second)
1013
if match_style == '-':
1015
elif match_style == '=':
1016
last = dt + datetime.timedelta(days=1)
1019
for i in range(len(revs)-1, -1, -1):
1020
r = self.get_revision(revs[i])
1021
# TODO: Handle timezone.
1022
dt = datetime.datetime.fromtimestamp(r.timestamp)
1023
if first >= dt and (last is None or dt >= last):
1026
for i in range(len(revs)):
1027
r = self.get_revision(revs[i])
1028
# TODO: Handle timezone.
1029
dt = datetime.datetime.fromtimestamp(r.timestamp)
1030
if first <= dt and (last is None or dt <= last):
1032
REVISION_NAMESPACES['date:'] = _namespace_date
1034
def revision_tree(self, revision_id):
1035
"""Return Tree for a revision on this branch.
1037
`revision_id` may be None for the null revision, in which case
1038
an `EmptyTree` is returned."""
1039
# TODO: refactor this to use an existing revision object
1040
# so we don't need to read it in twice.
1041
if revision_id == None:
1044
inv = self.get_revision_inventory(revision_id)
1045
return RevisionTree(self.weave_store, inv, revision_id)
1048
def working_tree(self):
1049
"""Return a `Tree` for the working copy."""
1050
from workingtree import WorkingTree
1051
return WorkingTree(self.base, self.read_working_inventory())
1054
def basis_tree(self):
1055
"""Return `Tree` object for last revision.
1057
If there are no revisions yet, return an `EmptyTree`.
1059
return self.revision_tree(self.last_patch())
1062
def rename_one(self, from_rel, to_rel):
1065
This can change the directory or the filename or both.
1069
tree = self.working_tree()
1070
inv = tree.inventory
1071
if not tree.has_filename(from_rel):
1072
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1073
if tree.has_filename(to_rel):
1074
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1076
file_id = inv.path2id(from_rel)
1078
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1080
if inv.path2id(to_rel):
1081
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1083
to_dir, to_tail = os.path.split(to_rel)
1084
to_dir_id = inv.path2id(to_dir)
1085
if to_dir_id == None and to_dir != '':
1086
raise BzrError("can't determine destination directory id for %r" % to_dir)
1088
mutter("rename_one:")
1089
mutter(" file_id {%s}" % file_id)
1090
mutter(" from_rel %r" % from_rel)
1091
mutter(" to_rel %r" % to_rel)
1092
mutter(" to_dir %r" % to_dir)
1093
mutter(" to_dir_id {%s}" % to_dir_id)
1095
inv.rename(file_id, to_dir_id, to_tail)
1097
from_abs = self.abspath(from_rel)
1098
to_abs = self.abspath(to_rel)
1100
os.rename(from_abs, to_abs)
1102
raise BzrError("failed to rename %r to %r: %s"
1103
% (from_abs, to_abs, e[1]),
1104
["rename rolled back"])
1106
self._write_inventory(inv)
1111
def move(self, from_paths, to_name):
1114
to_name must exist as a versioned directory.
1116
If to_name exists and is a directory, the files are moved into
1117
it, keeping their old names. If it is a directory,
1119
Note that to_name is only the last component of the new name;
1120
this doesn't change the directory.
1122
This returns a list of (from_path, to_path) pairs for each
1123
entry that is moved.
1128
## TODO: Option to move IDs only
1129
assert not isinstance(from_paths, basestring)
1130
tree = self.working_tree()
1131
inv = tree.inventory
1132
to_abs = self.abspath(to_name)
1133
if not isdir(to_abs):
1134
raise BzrError("destination %r is not a directory" % to_abs)
1135
if not tree.has_filename(to_name):
1136
raise BzrError("destination %r not in working directory" % to_abs)
1137
to_dir_id = inv.path2id(to_name)
1138
if to_dir_id == None and to_name != '':
1139
raise BzrError("destination %r is not a versioned directory" % to_name)
1140
to_dir_ie = inv[to_dir_id]
1141
if to_dir_ie.kind not in ('directory', 'root_directory'):
1142
raise BzrError("destination %r is not a directory" % to_abs)
1144
to_idpath = inv.get_idpath(to_dir_id)
1146
for f in from_paths:
1147
if not tree.has_filename(f):
1148
raise BzrError("%r does not exist in working tree" % f)
1149
f_id = inv.path2id(f)
1151
raise BzrError("%r is not versioned" % f)
1152
name_tail = splitpath(f)[-1]
1153
dest_path = appendpath(to_name, name_tail)
1154
if tree.has_filename(dest_path):
1155
raise BzrError("destination %r already exists" % dest_path)
1156
if f_id in to_idpath:
1157
raise BzrError("can't move %r to a subdirectory of itself" % f)
1159
# OK, so there's a race here, it's possible that someone will
1160
# create a file in this interval and then the rename might be
1161
# left half-done. But we should have caught most problems.
1163
for f in from_paths:
1164
name_tail = splitpath(f)[-1]
1165
dest_path = appendpath(to_name, name_tail)
1166
result.append((f, dest_path))
1167
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1169
os.rename(self.abspath(f), self.abspath(dest_path))
1171
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1172
["rename rolled back"])
1174
self._write_inventory(inv)
1181
def revert(self, filenames, old_tree=None, backups=True):
1182
"""Restore selected files to the versions from a previous tree.
1185
If true (default) backups are made of files before
1188
from bzrlib.errors import NotVersionedError, BzrError
1189
from bzrlib.atomicfile import AtomicFile
1190
from bzrlib.osutils import backup_file
1192
inv = self.read_working_inventory()
1193
if old_tree is None:
1194
old_tree = self.basis_tree()
1195
old_inv = old_tree.inventory
1198
for fn in filenames:
1199
file_id = inv.path2id(fn)
1201
raise NotVersionedError("not a versioned file", fn)
1202
if not old_inv.has_id(file_id):
1203
raise BzrError("file not present in old tree", fn, file_id)
1204
nids.append((fn, file_id))
1206
# TODO: Rename back if it was previously at a different location
1208
# TODO: If given a directory, restore the entire contents from
1209
# the previous version.
1211
# TODO: Make a backup to a temporary file.
1213
# TODO: If the file previously didn't exist, delete it?
1214
for fn, file_id in nids:
1217
f = AtomicFile(fn, 'wb')
1219
f.write(old_tree.get_file(file_id).read())
1225
def pending_merges(self):
1226
"""Return a list of pending merges.
1228
These are revisions that have been merged into the working
1229
directory but not yet committed.
1231
cfn = self.controlfilename('pending-merges')
1232
if not os.path.exists(cfn):
1235
for l in self.controlfile('pending-merges', 'r').readlines():
1236
p.append(l.rstrip('\n'))
1240
def add_pending_merge(self, revision_id):
1241
from bzrlib.revision import validate_revision_id
1243
validate_revision_id(revision_id)
1245
p = self.pending_merges()
1246
if revision_id in p:
1248
p.append(revision_id)
1249
self.set_pending_merges(p)
1252
def set_pending_merges(self, rev_list):
1253
from bzrlib.atomicfile import AtomicFile
1256
f = AtomicFile(self.controlfilename('pending-merges'))
1267
def get_parent(self):
1268
"""Return the parent location of the branch.
1270
This is the default location for push/pull/missing. The usual
1271
pattern is that the user can override it by specifying a
1275
_locs = ['parent', 'pull', 'x-pull']
1278
return self.controlfile(l, 'r').read().strip('\n')
1280
if e.errno != errno.ENOENT:
1285
def set_parent(self, url):
1286
# TODO: Maybe delete old location files?
1287
from bzrlib.atomicfile import AtomicFile
1290
f = AtomicFile(self.controlfilename('parent'))
1299
def check_revno(self, revno):
1301
Check whether a revno corresponds to any revision.
1302
Zero (the NULL revision) is considered valid.
1305
self.check_real_revno(revno)
1307
def check_real_revno(self, revno):
1309
Check whether a revno corresponds to a real revision.
1310
Zero (the NULL revision) is considered invalid
1312
if revno < 1 or revno > self.revno():
1313
raise InvalidRevisionNumber(revno)
1318
class ScratchBranch(Branch):
1319
"""Special test class: a branch that cleans up after itself.
1321
>>> b = ScratchBranch()
1329
def __init__(self, files=[], dirs=[], base=None):
1330
"""Make a test branch.
1332
This creates a temporary directory and runs init-tree in it.
1334
If any files are listed, they are created in the working copy.
1336
from tempfile import mkdtemp
1341
Branch.__init__(self, base, init=init)
1343
os.mkdir(self.abspath(d))
1346
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1351
>>> orig = ScratchBranch(files=["file1", "file2"])
1352
>>> clone = orig.clone()
1353
>>> os.path.samefile(orig.base, clone.base)
1355
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1358
from shutil import copytree
1359
from tempfile import mkdtemp
1362
copytree(self.base, base, symlinks=True)
1363
return ScratchBranch(base=base)
1371
"""Destroy the test branch, removing the scratch directory."""
1372
from shutil import rmtree
1375
mutter("delete ScratchBranch %s" % self.base)
1378
# Work around for shutil.rmtree failing on Windows when
1379
# readonly files are encountered
1380
mutter("hit exception in destroying ScratchBranch: %s" % e)
1381
for root, dirs, files in os.walk(self.base, topdown=False):
1383
os.chmod(os.path.join(root, name), 0700)
1389
######################################################################
1393
def is_control_file(filename):
1394
## FIXME: better check
1395
filename = os.path.normpath(filename)
1396
while filename != '':
1397
head, tail = os.path.split(filename)
1398
## mutter('check %r for control file' % ((head, tail), ))
1399
if tail == bzrlib.BZRDIR:
1401
if filename == head:
1408
def gen_file_id(name):
1409
"""Return new file id.
1411
This should probably generate proper UUIDs, but for the moment we
1412
cope with just randomness because running uuidgen every time is
1415
from binascii import hexlify
1416
from time import time
1418
# get last component
1419
idx = name.rfind('/')
1421
name = name[idx+1 : ]
1422
idx = name.rfind('\\')
1424
name = name[idx+1 : ]
1426
# make it not a hidden file
1427
name = name.lstrip('.')
1429
# remove any wierd characters; we don't escape them but rather
1430
# just pull them out
1431
name = re.sub(r'[^\w.]', '', name)
1433
s = hexlify(rand_bytes(8))
1434
return '-'.join((name, compact_date(time()), s))
1438
"""Return a new tree-root file id."""
1439
return gen_file_id('TREE_ROOT')
1442
def pull_loc(branch):
1443
# TODO: Should perhaps just make attribute be 'base' in
1444
# RemoteBranch and Branch?
1445
if hasattr(branch, "baseurl"):
1446
return branch.baseurl
1451
def copy_branch(branch_from, to_location, revision=None):
1452
"""Copy branch_from into the existing directory to_location.
1455
If not None, only revisions up to this point will be copied.
1456
The head of the new branch will be that revision.
1459
The name of a local directory that exists but is empty.
1461
from bzrlib.merge import merge
1462
from bzrlib.branch import Branch
1464
assert isinstance(branch_from, Branch)
1465
assert isinstance(to_location, basestring)
1467
br_to = Branch(to_location, init=True)
1468
br_to.set_root_id(branch_from.get_root_id())
1469
if revision is None:
1470
revno = branch_from.revno()
1472
revno, rev_id = branch_from.get_revision_info(revision)
1473
br_to.update_revisions(branch_from, stop_revision=revno)
1474
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1475
check_clean=False, ignore_zero=True)
1477
from_location = pull_loc(branch_from)
1478
br_to.set_parent(pull_loc(branch_from))
added
removed
bzrlib/branch.py
