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
20
from bzrlib.errors import BzrError, NoSuchRevision, NoCommits
24
class RevisionInfo(object):
25
"""The results of applying a revision specification to a branch.
27
An instance has two useful attributes: revno, and rev_id.
29
They can also be accessed as spec[0] and spec[1] respectively,
30
so that you can write code like:
31
revno, rev_id = RevisionSpec(branch, spec)
32
although this is probably going to be deprecated later.
34
This class exists mostly to be the return value of a RevisionSpec,
35
so that you can access the member you're interested in (number or id)
36
or treat the result as a tuple.
39
def __init__(self, branch, revno, rev_id=_marker):
43
# allow caller to be lazy
44
if self.revno is None:
47
self.rev_id = branch.get_rev_id(self.revno)
51
def __nonzero__(self):
52
# first the easy ones...
53
if self.rev_id is None:
55
if self.revno is not None:
57
# TODO: otherwise, it should depend on how I was built -
58
# if it's in_history(branch), then check revision_history(),
59
# if it's in_store(branch), do the check below
60
return self.rev_id in self.branch.revision_store
65
def __getitem__(self, index):
66
if index == 0: return self.revno
67
if index == 1: return self.rev_id
68
raise IndexError(index)
71
return self.branch.get_revision(self.rev_id)
73
def __eq__(self, other):
74
if type(other) not in (tuple, list, type(self)):
76
if type(other) is type(self) and self.branch is not other.branch:
78
return tuple(self) == tuple(other)
81
return '<bzrlib.revisionspec.RevisionInfo object %s, %s for %r>' % (
82
self.revno, self.rev_id, self.branch)
84
# classes in this list should have a "prefix" attribute, against which
85
# string specs are matched
88
class RevisionSpec(object):
89
"""A parsed revision specification.
91
A revision specification can be an integer, in which case it is
92
assumed to be a revno (though this will translate negative values
93
into positive ones); or it can be a string, in which case it is
94
parsed for something like 'date:' or 'revid:' etc.
96
Revision specs are an UI element, and they have been moved out
97
of the branch class to leave "back-end" classes unaware of such
98
details. Code that gets a revno or rev_id from other code should
99
not be using revision specs - revnos and revision ids are the
100
accepted ways to refer to revisions internally.
102
(Equivalent to the old Branch method get_revision_info())
107
def __new__(cls, spec, foo=_marker):
108
"""Parse a revision specifier.
111
return object.__new__(RevisionSpec, spec)
118
if isinstance(spec, int):
119
return object.__new__(RevisionSpec_int, spec)
120
elif isinstance(spec, basestring):
121
for spectype in SPEC_TYPES:
122
if spec.startswith(spectype.prefix):
123
return object.__new__(spectype, spec)
125
raise BzrError('No namespace registered for string: %r' %
128
raise TypeError('Unhandled revision type %s' % spec)
130
def __init__(self, spec):
131
if self.prefix and spec.startswith(self.prefix):
132
spec = spec[len(self.prefix):]
135
def _match_on(self, branch, revs):
136
return RevisionInfo(branch, 0, None)
138
def _match_on_and_check(self, branch, revs):
139
info = self._match_on(branch, revs)
142
elif info == (0, None):
143
# special case - the empty tree
146
raise NoSuchRevision(branch, self.prefix + str(self.spec))
148
raise NoSuchRevision(branch, str(self.spec))
150
def in_history(self, branch):
151
revs = branch.revision_history()
152
return self._match_on_and_check(branch, revs)
155
# this is mostly for helping with testing
156
return '<%s %s%s>' % (self.__class__.__name__,
163
class RevisionSpec_int(RevisionSpec):
164
"""Spec is a number. Special case."""
165
def __init__(self, spec):
166
self.spec = int(spec)
168
def _match_on(self, branch, revs):
170
revno = len(revs) + self.spec + 1
173
rev_id = branch.get_rev_id(revno, revs)
174
return RevisionInfo(branch, revno, rev_id)
177
class RevisionSpec_revno(RevisionSpec):
180
def _match_on(self, branch, revs):
181
"""Lookup a revision by revision number"""
183
return RevisionInfo(branch, int(self.spec))
185
return RevisionInfo(branch, None)
187
SPEC_TYPES.append(RevisionSpec_revno)
190
class RevisionSpec_revid(RevisionSpec):
193
def _match_on(self, branch, revs):
195
return RevisionInfo(branch, revs.index(self.spec) + 1, self.spec)
197
return RevisionInfo(branch, None)
199
SPEC_TYPES.append(RevisionSpec_revid)
202
class RevisionSpec_last(RevisionSpec):
205
def _match_on(self, branch, revs):
207
offset = int(self.spec)
209
return RevisionInfo(branch, None)
212
raise BzrError('You must supply a positive value for --revision last:XXX')
213
return RevisionInfo(branch, len(revs) - offset + 1)
215
SPEC_TYPES.append(RevisionSpec_last)
218
class RevisionSpec_tag(RevisionSpec):
221
def _match_on(self, branch, revs):
222
raise BzrError('tag: namespace registered, but not implemented.')
224
SPEC_TYPES.append(RevisionSpec_tag)
227
class RevisionSpec_date(RevisionSpec):
229
_date_re = re.compile(
230
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
232
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
235
def _match_on(self, branch, revs):
237
Spec for date revisions:
239
value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
240
it can also start with a '+/-/='. '+' says match the first
241
entry after the given date. '-' is match the first entry before the date
242
'=' is match the first entry after, but still on the given date.
244
+2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
245
-2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
246
=2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
247
May 13th, 2005 at 0:00
249
So the proper way of saying 'give me all entries for today' is:
250
-r {date:+today}:{date:-tomorrow}
251
The default is '=' when not supplied
254
if self.spec[:1] in ('+', '-', '='):
255
match_style = self.spec[:1]
256
self.spec = self.spec[1:]
258
# XXX: this should probably be using datetime.date instead
259
today = datetime.datetime.today().replace(hour=0, minute=0, second=0,
261
if self.spec.lower() == 'yesterday':
262
dt = today - datetime.timedelta(days=1)
263
elif self.spec.lower() == 'today':
265
elif self.spec.lower() == 'tomorrow':
266
dt = today + datetime.timedelta(days=1)
268
m = self._date_re.match(self.spec)
269
if not m or (not m.group('date') and not m.group('time')):
270
raise BzrError('Invalid revision date %r' % self.spec)
273
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
275
year, month, day = today.year, today.month, today.day
277
hour = int(m.group('hour'))
278
minute = int(m.group('minute'))
279
if m.group('second'):
280
second = int(m.group('second'))
284
hour, minute, second = 0,0,0
286
dt = datetime.datetime(year=year, month=month, day=day,
287
hour=hour, minute=minute, second=second)
291
if match_style == '-':
293
elif match_style == '=':
294
last = dt + datetime.timedelta(days=1)
297
for i in range(len(revs)-1, -1, -1):
298
r = branch.get_revision(revs[i])
299
# TODO: Handle timezone.
300
dt = datetime.datetime.fromtimestamp(r.timestamp)
301
if first >= dt and (last is None or dt >= last):
302
return RevisionInfo(branch, i+1,)
304
for i in range(len(revs)):
305
r = branch.get_revision(revs[i])
306
# TODO: Handle timezone.
307
dt = datetime.datetime.fromtimestamp(r.timestamp)
308
if first <= dt and (last is None or dt <= last):
309
return RevisionInfo(branch, i+1,)
311
SPEC_TYPES.append(RevisionSpec_date)
314
class RevisionSpec_ancestor(RevisionSpec):
317
def _match_on(self, branch, revs):
318
from branch import Branch
319
from revision import common_ancestor, MultipleRevisionSources
320
other_branch = Branch.open_containing(self.spec)
321
revision_a = branch.last_patch()
322
revision_b = other_branch.last_patch()
323
for r, b in ((revision_a, branch), (revision_b, other_branch)):
326
revision_source = MultipleRevisionSources(branch, other_branch)
327
rev_id = common_ancestor(revision_a, revision_b, revision_source)
329
revno = branch.revision_id_to_revno(rev_id)
330
except NoSuchRevision:
332
return RevisionInfo(branch, revno, rev_id)
334
SPEC_TYPES.append(RevisionSpec_ancestor)