~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisionspec.py

  • Committer: Patch Queue Manager
  • Date: 2011-11-17 12:59:55 UTC
  • mfrom: (6263.2.3 hpss-make-workingtrees)
  • Revision ID: pqm@pqm.ubuntu.com-20111117125955-yjbz106l8gkzslos
(jelmer) Add HPSS call ``Repository.make_working_trees``. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
 
 
18
from bzrlib.lazy_import import lazy_import
 
19
lazy_import(globals(), """
 
20
import bisect
 
21
import datetime
 
22
 
 
23
from bzrlib import (
 
24
    branch as _mod_branch,
 
25
    osutils,
 
26
    revision,
 
27
    symbol_versioning,
 
28
    workingtree,
 
29
    )
 
30
from bzrlib.i18n import gettext
 
31
""")
 
32
 
 
33
from bzrlib import (
 
34
    errors,
 
35
    lazy_regex,
 
36
    registry,
 
37
    trace,
 
38
    )
 
39
 
 
40
 
 
41
_marker = []
 
42
 
 
43
 
 
44
class RevisionInfo(object):
 
45
    """The results of applying a revision specification to a branch."""
 
46
 
 
47
    help_txt = """The results of applying a revision specification to a branch.
 
48
 
 
49
    An instance has two useful attributes: revno, and rev_id.
 
50
 
 
51
    They can also be accessed as spec[0] and spec[1] respectively,
 
52
    so that you can write code like:
 
53
    revno, rev_id = RevisionSpec(branch, spec)
 
54
    although this is probably going to be deprecated later.
 
55
 
 
56
    This class exists mostly to be the return value of a RevisionSpec,
 
57
    so that you can access the member you're interested in (number or id)
 
58
    or treat the result as a tuple.
 
59
    """
 
60
 
 
61
    def __init__(self, branch, revno, rev_id=_marker):
 
62
        self.branch = branch
 
63
        self.revno = revno
 
64
        if rev_id is _marker:
 
65
            # allow caller to be lazy
 
66
            if self.revno is None:
 
67
                self.rev_id = None
 
68
            else:
 
69
                self.rev_id = branch.get_rev_id(self.revno)
 
70
        else:
 
71
            self.rev_id = rev_id
 
72
 
 
73
    def __nonzero__(self):
 
74
        # first the easy ones...
 
75
        if self.rev_id is None:
 
76
            return False
 
77
        if self.revno is not None:
 
78
            return True
 
79
        # TODO: otherwise, it should depend on how I was built -
 
80
        # if it's in_history(branch), then check revision_history(),
 
81
        # if it's in_store(branch), do the check below
 
82
        return self.branch.repository.has_revision(self.rev_id)
 
83
 
 
84
    def __len__(self):
 
85
        return 2
 
86
 
 
87
    def __getitem__(self, index):
 
88
        if index == 0: return self.revno
 
89
        if index == 1: return self.rev_id
 
90
        raise IndexError(index)
 
91
 
 
92
    def get(self):
 
93
        return self.branch.repository.get_revision(self.rev_id)
 
94
 
 
95
    def __eq__(self, other):
 
96
        if type(other) not in (tuple, list, type(self)):
 
97
            return False
 
98
        if type(other) is type(self) and self.branch is not other.branch:
 
99
            return False
 
100
        return tuple(self) == tuple(other)
 
101
 
 
102
    def __repr__(self):
 
103
        return '<bzrlib.revisionspec.RevisionInfo object %s, %s for %r>' % (
 
104
            self.revno, self.rev_id, self.branch)
 
105
 
 
106
    @staticmethod
 
107
    def from_revision_id(branch, revision_id, revs):
 
108
        """Construct a RevisionInfo given just the id.
 
109
 
 
110
        Use this if you don't know or care what the revno is.
 
111
        """
 
112
        if revision_id == revision.NULL_REVISION:
 
113
            return RevisionInfo(branch, 0, revision_id)
 
114
        try:
 
115
            revno = revs.index(revision_id) + 1
 
116
        except ValueError:
 
117
            revno = None
 
118
        return RevisionInfo(branch, revno, revision_id)
 
119
 
 
120
 
 
121
class RevisionSpec(object):
 
122
    """A parsed revision specification."""
 
123
 
 
124
    help_txt = """A parsed revision specification.
 
125
 
 
126
    A revision specification is a string, which may be unambiguous about
 
127
    what it represents by giving a prefix like 'date:' or 'revid:' etc,
 
128
    or it may have no prefix, in which case it's tried against several
 
129
    specifier types in sequence to determine what the user meant.
 
130
 
 
131
    Revision specs are an UI element, and they have been moved out
 
132
    of the branch class to leave "back-end" classes unaware of such
 
133
    details.  Code that gets a revno or rev_id from other code should
 
134
    not be using revision specs - revnos and revision ids are the
 
135
    accepted ways to refer to revisions internally.
 
136
 
 
137
    (Equivalent to the old Branch method get_revision_info())
 
138
    """
 
139
 
 
140
    prefix = None
 
141
    wants_revision_history = True
 
142
    dwim_catchable_exceptions = (errors.InvalidRevisionSpec,)
 
143
    """Exceptions that RevisionSpec_dwim._match_on will catch.
 
144
 
 
145
    If the revspec is part of ``dwim_revspecs``, it may be tried with an
 
146
    invalid revspec and raises some exception. The exceptions mentioned here
 
147
    will not be reported to the user but simply ignored without stopping the
 
148
    dwim processing.
 
149
    """
 
150
 
 
151
    @staticmethod
 
152
    def from_string(spec):
 
153
        """Parse a revision spec string into a RevisionSpec object.
 
154
 
 
155
        :param spec: A string specified by the user
 
156
        :return: A RevisionSpec object that understands how to parse the
 
157
            supplied notation.
 
158
        """
 
159
        if not isinstance(spec, (type(None), basestring)):
 
160
            raise TypeError('error')
 
161
 
 
162
        if spec is None:
 
163
            return RevisionSpec(None, _internal=True)
 
164
        match = revspec_registry.get_prefix(spec)
 
165
        if match is not None:
 
166
            spectype, specsuffix = match
 
167
            trace.mutter('Returning RevisionSpec %s for %s',
 
168
                         spectype.__name__, spec)
 
169
            return spectype(spec, _internal=True)
 
170
        else:
 
171
            # Otherwise treat it as a DWIM, build the RevisionSpec object and
 
172
            # wait for _match_on to be called.
 
173
            return RevisionSpec_dwim(spec, _internal=True)
 
174
 
 
175
    def __init__(self, spec, _internal=False):
 
176
        """Create a RevisionSpec referring to the Null revision.
 
177
 
 
178
        :param spec: The original spec supplied by the user
 
179
        :param _internal: Used to ensure that RevisionSpec is not being
 
180
            called directly. Only from RevisionSpec.from_string()
 
181
        """
 
182
        if not _internal:
 
183
            symbol_versioning.warn('Creating a RevisionSpec directly has'
 
184
                                   ' been deprecated in version 0.11. Use'
 
185
                                   ' RevisionSpec.from_string()'
 
186
                                   ' instead.',
 
187
                                   DeprecationWarning, stacklevel=2)
 
188
        self.user_spec = spec
 
189
        if self.prefix and spec.startswith(self.prefix):
 
190
            spec = spec[len(self.prefix):]
 
191
        self.spec = spec
 
192
 
 
193
    def _match_on(self, branch, revs):
 
194
        trace.mutter('Returning RevisionSpec._match_on: None')
 
195
        return RevisionInfo(branch, None, None)
 
196
 
 
197
    def _match_on_and_check(self, branch, revs):
 
198
        info = self._match_on(branch, revs)
 
199
        if info:
 
200
            return info
 
201
        elif info == (None, None):
 
202
            # special case - nothing supplied
 
203
            return info
 
204
        elif self.prefix:
 
205
            raise errors.InvalidRevisionSpec(self.user_spec, branch)
 
206
        else:
 
207
            raise errors.InvalidRevisionSpec(self.spec, branch)
 
208
 
 
209
    def in_history(self, branch):
 
210
        if branch:
 
211
            if self.wants_revision_history:
 
212
                # TODO: avoid looking at all of history
 
213
                branch.lock_read()
 
214
                try:
 
215
                    graph = branch.repository.get_graph()
 
216
                    revs = list(graph.iter_lefthand_ancestry(
 
217
                        branch.last_revision(), [revision.NULL_REVISION]))
 
218
                finally:
 
219
                    branch.unlock()
 
220
                revs.reverse()
 
221
            else:
 
222
                revs = None
 
223
        else:
 
224
            # this should never trigger.
 
225
            # TODO: make it a deprecated code path. RBC 20060928
 
226
            revs = None
 
227
        return self._match_on_and_check(branch, revs)
 
228
 
 
229
        # FIXME: in_history is somewhat broken,
 
230
        # it will return non-history revisions in many
 
231
        # circumstances. The expected facility is that
 
232
        # in_history only returns revision-history revs,
 
233
        # in_store returns any rev. RBC 20051010
 
234
    # aliases for now, when we fix the core logic, then they
 
235
    # will do what you expect.
 
236
    in_store = in_history
 
237
    in_branch = in_store
 
238
 
 
239
    def as_revision_id(self, context_branch):
 
240
        """Return just the revision_id for this revisions spec.
 
241
 
 
242
        Some revision specs require a context_branch to be able to determine
 
243
        their value. Not all specs will make use of it.
 
244
        """
 
245
        return self._as_revision_id(context_branch)
 
246
 
 
247
    def _as_revision_id(self, context_branch):
 
248
        """Implementation of as_revision_id()
 
249
 
 
250
        Classes should override this function to provide appropriate
 
251
        functionality. The default is to just call '.in_history().rev_id'
 
252
        """
 
253
        return self.in_history(context_branch).rev_id
 
254
 
 
255
    def as_tree(self, context_branch):
 
256
        """Return the tree object for this revisions spec.
 
257
 
 
258
        Some revision specs require a context_branch to be able to determine
 
259
        the revision id and access the repository. Not all specs will make
 
260
        use of it.
 
261
        """
 
262
        return self._as_tree(context_branch)
 
263
 
 
264
    def _as_tree(self, context_branch):
 
265
        """Implementation of as_tree().
 
266
 
 
267
        Classes should override this function to provide appropriate
 
268
        functionality. The default is to just call '.as_revision_id()'
 
269
        and get the revision tree from context_branch's repository.
 
270
        """
 
271
        revision_id = self.as_revision_id(context_branch)
 
272
        return context_branch.repository.revision_tree(revision_id)
 
273
 
 
274
    def __repr__(self):
 
275
        # this is mostly for helping with testing
 
276
        return '<%s %s>' % (self.__class__.__name__,
 
277
                              self.user_spec)
 
278
 
 
279
    def needs_branch(self):
 
280
        """Whether this revision spec needs a branch.
 
281
 
 
282
        Set this to False the branch argument of _match_on is not used.
 
283
        """
 
284
        return True
 
285
 
 
286
    def get_branch(self):
 
287
        """When the revision specifier contains a branch location, return it.
 
288
 
 
289
        Otherwise, return None.
 
290
        """
 
291
        return None
 
292
 
 
293
 
 
294
# private API
 
295
 
 
296
class RevisionSpec_dwim(RevisionSpec):
 
297
    """Provides a DWIMish revision specifier lookup.
 
298
 
 
299
    Note that this does not go in the revspec_registry because by definition
 
300
    there is no prefix to identify it.  It's solely called from
 
301
    RevisionSpec.from_string() because the DWIMification happen when _match_on
 
302
    is called so the string describing the revision is kept here until needed.
 
303
    """
 
304
 
 
305
    help_txt = None
 
306
    # We don't need to build the revision history ourself, that's delegated to
 
307
    # each revspec we try.
 
308
    wants_revision_history = False
 
309
 
 
310
    _revno_regex = lazy_regex.lazy_compile(r'^(?:(\d+(\.\d+)*)|-\d+)(:.*)?$')
 
311
 
 
312
    # The revspecs to try
 
313
    _possible_revspecs = []
 
314
 
 
315
    def _try_spectype(self, rstype, branch):
 
316
        rs = rstype(self.spec, _internal=True)
 
317
        # Hit in_history to find out if it exists, or we need to try the
 
318
        # next type.
 
319
        return rs.in_history(branch)
 
320
 
 
321
    def _match_on(self, branch, revs):
 
322
        """Run the lookup and see what we can get."""
 
323
 
 
324
        # First, see if it's a revno
 
325
        if self._revno_regex.match(self.spec) is not None:
 
326
            try:
 
327
                return self._try_spectype(RevisionSpec_revno, branch)
 
328
            except RevisionSpec_revno.dwim_catchable_exceptions:
 
329
                pass
 
330
 
 
331
        # Next see what has been registered
 
332
        for objgetter in self._possible_revspecs:
 
333
            rs_class = objgetter.get_obj()
 
334
            try:
 
335
                return self._try_spectype(rs_class, branch)
 
336
            except rs_class.dwim_catchable_exceptions:
 
337
                pass
 
338
 
 
339
        # Try the old (deprecated) dwim list:
 
340
        for rs_class in dwim_revspecs:
 
341
            try:
 
342
                return self._try_spectype(rs_class, branch)
 
343
            except rs_class.dwim_catchable_exceptions:
 
344
                pass
 
345
 
 
346
        # Well, I dunno what it is. Note that we don't try to keep track of the
 
347
        # first of last exception raised during the DWIM tries as none seems
 
348
        # really relevant.
 
349
        raise errors.InvalidRevisionSpec(self.spec, branch)
 
350
 
 
351
    @classmethod
 
352
    def append_possible_revspec(cls, revspec):
 
353
        """Append a possible DWIM revspec.
 
354
 
 
355
        :param revspec: Revision spec to try.
 
356
        """
 
357
        cls._possible_revspecs.append(registry._ObjectGetter(revspec))
 
358
 
 
359
    @classmethod
 
360
    def append_possible_lazy_revspec(cls, module_name, member_name):
 
361
        """Append a possible lazily loaded DWIM revspec.
 
362
 
 
363
        :param module_name: Name of the module with the revspec
 
364
        :param member_name: Name of the revspec within the module
 
365
        """
 
366
        cls._possible_revspecs.append(
 
367
            registry._LazyObjectGetter(module_name, member_name))
 
368
 
 
369
 
 
370
class RevisionSpec_revno(RevisionSpec):
 
371
    """Selects a revision using a number."""
 
372
 
 
373
    help_txt = """Selects a revision using a number.
 
374
 
 
375
    Use an integer to specify a revision in the history of the branch.
 
376
    Optionally a branch can be specified.  A negative number will count
 
377
    from the end of the branch (-1 is the last revision, -2 the previous
 
378
    one). If the negative number is larger than the branch's history, the
 
379
    first revision is returned.
 
380
    Examples::
 
381
 
 
382
      revno:1                   -> return the first revision of this branch
 
383
      revno:3:/path/to/branch   -> return the 3rd revision of
 
384
                                   the branch '/path/to/branch'
 
385
      revno:-1                  -> The last revision in a branch.
 
386
      -2:http://other/branch    -> The second to last revision in the
 
387
                                   remote branch.
 
388
      -1000000                  -> Most likely the first revision, unless
 
389
                                   your history is very long.
 
390
    """
 
391
    prefix = 'revno:'
 
392
    wants_revision_history = False
 
393
 
 
394
    def _match_on(self, branch, revs):
 
395
        """Lookup a revision by revision number"""
 
396
        branch, revno, revision_id = self._lookup(branch, revs)
 
397
        return RevisionInfo(branch, revno, revision_id)
 
398
 
 
399
    def _lookup(self, branch, revs_or_none):
 
400
        loc = self.spec.find(':')
 
401
        if loc == -1:
 
402
            revno_spec = self.spec
 
403
            branch_spec = None
 
404
        else:
 
405
            revno_spec = self.spec[:loc]
 
406
            branch_spec = self.spec[loc+1:]
 
407
 
 
408
        if revno_spec == '':
 
409
            if not branch_spec:
 
410
                raise errors.InvalidRevisionSpec(self.user_spec,
 
411
                        branch, 'cannot have an empty revno and no branch')
 
412
            revno = None
 
413
        else:
 
414
            try:
 
415
                revno = int(revno_spec)
 
416
                dotted = False
 
417
            except ValueError:
 
418
                # dotted decimal. This arguably should not be here
 
419
                # but the from_string method is a little primitive
 
420
                # right now - RBC 20060928
 
421
                try:
 
422
                    match_revno = tuple((int(number) for number in revno_spec.split('.')))
 
423
                except ValueError, e:
 
424
                    raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
 
425
 
 
426
                dotted = True
 
427
 
 
428
        if branch_spec:
 
429
            # the user has override the branch to look in.
 
430
            # we need to refresh the revision_history map and
 
431
            # the branch object.
 
432
            from bzrlib.branch import Branch
 
433
            branch = Branch.open(branch_spec)
 
434
            revs_or_none = None
 
435
 
 
436
        if dotted:
 
437
            try:
 
438
                revision_id = branch.dotted_revno_to_revision_id(match_revno,
 
439
                    _cache_reverse=True)
 
440
            except errors.NoSuchRevision:
 
441
                raise errors.InvalidRevisionSpec(self.user_spec, branch)
 
442
            else:
 
443
                # there is no traditional 'revno' for dotted-decimal revnos.
 
444
                # so for  API compatability we return None.
 
445
                return branch, None, revision_id
 
446
        else:
 
447
            last_revno, last_revision_id = branch.last_revision_info()
 
448
            if revno < 0:
 
449
                # if get_rev_id supported negative revnos, there would not be a
 
450
                # need for this special case.
 
451
                if (-revno) >= last_revno:
 
452
                    revno = 1
 
453
                else:
 
454
                    revno = last_revno + revno + 1
 
455
            try:
 
456
                revision_id = branch.get_rev_id(revno, revs_or_none)
 
457
            except errors.NoSuchRevision:
 
458
                raise errors.InvalidRevisionSpec(self.user_spec, branch)
 
459
        return branch, revno, revision_id
 
460
 
 
461
    def _as_revision_id(self, context_branch):
 
462
        # We would have the revno here, but we don't really care
 
463
        branch, revno, revision_id = self._lookup(context_branch, None)
 
464
        return revision_id
 
465
 
 
466
    def needs_branch(self):
 
467
        return self.spec.find(':') == -1
 
468
 
 
469
    def get_branch(self):
 
470
        if self.spec.find(':') == -1:
 
471
            return None
 
472
        else:
 
473
            return self.spec[self.spec.find(':')+1:]
 
474
 
 
475
# Old compatibility
 
476
RevisionSpec_int = RevisionSpec_revno
 
477
 
 
478
 
 
479
 
 
480
class RevisionIDSpec(RevisionSpec):
 
481
 
 
482
    def _match_on(self, branch, revs):
 
483
        revision_id = self.as_revision_id(branch)
 
484
        return RevisionInfo.from_revision_id(branch, revision_id, revs)
 
485
 
 
486
 
 
487
class RevisionSpec_revid(RevisionIDSpec):
 
488
    """Selects a revision using the revision id."""
 
489
 
 
490
    help_txt = """Selects a revision using the revision id.
 
491
 
 
492
    Supply a specific revision id, that can be used to specify any
 
493
    revision id in the ancestry of the branch.
 
494
    Including merges, and pending merges.
 
495
    Examples::
 
496
 
 
497
      revid:aaaa@bbbb-123456789 -> Select revision 'aaaa@bbbb-123456789'
 
498
    """
 
499
 
 
500
    prefix = 'revid:'
 
501
 
 
502
    def _as_revision_id(self, context_branch):
 
503
        # self.spec comes straight from parsing the command line arguments,
 
504
        # so we expect it to be a Unicode string. Switch it to the internal
 
505
        # representation.
 
506
        return osutils.safe_revision_id(self.spec, warn=False)
 
507
 
 
508
 
 
509
 
 
510
class RevisionSpec_last(RevisionSpec):
 
511
    """Selects the nth revision from the end."""
 
512
 
 
513
    help_txt = """Selects the nth revision from the end.
 
514
 
 
515
    Supply a positive number to get the nth revision from the end.
 
516
    This is the same as supplying negative numbers to the 'revno:' spec.
 
517
    Examples::
 
518
 
 
519
      last:1        -> return the last revision
 
520
      last:3        -> return the revision 2 before the end.
 
521
    """
 
522
 
 
523
    prefix = 'last:'
 
524
 
 
525
    def _match_on(self, branch, revs):
 
526
        revno, revision_id = self._revno_and_revision_id(branch, revs)
 
527
        return RevisionInfo(branch, revno, revision_id)
 
528
 
 
529
    def _revno_and_revision_id(self, context_branch, revs_or_none):
 
530
        last_revno, last_revision_id = context_branch.last_revision_info()
 
531
 
 
532
        if self.spec == '':
 
533
            if not last_revno:
 
534
                raise errors.NoCommits(context_branch)
 
535
            return last_revno, last_revision_id
 
536
 
 
537
        try:
 
538
            offset = int(self.spec)
 
539
        except ValueError, e:
 
540
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch, e)
 
541
 
 
542
        if offset <= 0:
 
543
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
 
544
                                             'you must supply a positive value')
 
545
 
 
546
        revno = last_revno - offset + 1
 
547
        try:
 
548
            revision_id = context_branch.get_rev_id(revno, revs_or_none)
 
549
        except errors.NoSuchRevision:
 
550
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch)
 
551
        return revno, revision_id
 
552
 
 
553
    def _as_revision_id(self, context_branch):
 
554
        # We compute the revno as part of the process, but we don't really care
 
555
        # about it.
 
556
        revno, revision_id = self._revno_and_revision_id(context_branch, None)
 
557
        return revision_id
 
558
 
 
559
 
 
560
 
 
561
class RevisionSpec_before(RevisionSpec):
 
562
    """Selects the parent of the revision specified."""
 
563
 
 
564
    help_txt = """Selects the parent of the revision specified.
 
565
 
 
566
    Supply any revision spec to return the parent of that revision.  This is
 
567
    mostly useful when inspecting revisions that are not in the revision history
 
568
    of a branch.
 
569
 
 
570
    It is an error to request the parent of the null revision (before:0).
 
571
 
 
572
    Examples::
 
573
 
 
574
      before:1913    -> Return the parent of revno 1913 (revno 1912)
 
575
      before:revid:aaaa@bbbb-1234567890  -> return the parent of revision
 
576
                                            aaaa@bbbb-1234567890
 
577
      bzr diff -r before:1913..1913
 
578
            -> Find the changes between revision 1913 and its parent (1912).
 
579
               (What changes did revision 1913 introduce).
 
580
               This is equivalent to:  bzr diff -c 1913
 
581
    """
 
582
 
 
583
    prefix = 'before:'
 
584
 
 
585
    def _match_on(self, branch, revs):
 
586
        r = RevisionSpec.from_string(self.spec)._match_on(branch, revs)
 
587
        if r.revno == 0:
 
588
            raise errors.InvalidRevisionSpec(self.user_spec, branch,
 
589
                                         'cannot go before the null: revision')
 
590
        if r.revno is None:
 
591
            # We need to use the repository history here
 
592
            rev = branch.repository.get_revision(r.rev_id)
 
593
            if not rev.parent_ids:
 
594
                revno = 0
 
595
                revision_id = revision.NULL_REVISION
 
596
            else:
 
597
                revision_id = rev.parent_ids[0]
 
598
                try:
 
599
                    revno = revs.index(revision_id) + 1
 
600
                except ValueError:
 
601
                    revno = None
 
602
        else:
 
603
            revno = r.revno - 1
 
604
            try:
 
605
                revision_id = branch.get_rev_id(revno, revs)
 
606
            except errors.NoSuchRevision:
 
607
                raise errors.InvalidRevisionSpec(self.user_spec,
 
608
                                                 branch)
 
609
        return RevisionInfo(branch, revno, revision_id)
 
610
 
 
611
    def _as_revision_id(self, context_branch):
 
612
        base_revspec = RevisionSpec.from_string(self.spec)
 
613
        base_revision_id = base_revspec.as_revision_id(context_branch)
 
614
        if base_revision_id == revision.NULL_REVISION:
 
615
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
 
616
                                         'cannot go before the null: revision')
 
617
        context_repo = context_branch.repository
 
618
        context_repo.lock_read()
 
619
        try:
 
620
            parent_map = context_repo.get_parent_map([base_revision_id])
 
621
        finally:
 
622
            context_repo.unlock()
 
623
        if base_revision_id not in parent_map:
 
624
            # Ghost, or unknown revision id
 
625
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
 
626
                'cannot find the matching revision')
 
627
        parents = parent_map[base_revision_id]
 
628
        if len(parents) < 1:
 
629
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
 
630
                'No parents for revision.')
 
631
        return parents[0]
 
632
 
 
633
 
 
634
 
 
635
class RevisionSpec_tag(RevisionSpec):
 
636
    """Select a revision identified by tag name"""
 
637
 
 
638
    help_txt = """Selects a revision identified by a tag name.
 
639
 
 
640
    Tags are stored in the branch and created by the 'tag' command.
 
641
    """
 
642
 
 
643
    prefix = 'tag:'
 
644
    dwim_catchable_exceptions = (errors.NoSuchTag, errors.TagsNotSupported)
 
645
 
 
646
    def _match_on(self, branch, revs):
 
647
        # Can raise tags not supported, NoSuchTag, etc
 
648
        return RevisionInfo.from_revision_id(branch,
 
649
            branch.tags.lookup_tag(self.spec),
 
650
            revs)
 
651
 
 
652
    def _as_revision_id(self, context_branch):
 
653
        return context_branch.tags.lookup_tag(self.spec)
 
654
 
 
655
 
 
656
 
 
657
class _RevListToTimestamps(object):
 
658
    """This takes a list of revisions, and allows you to bisect by date"""
 
659
 
 
660
    __slots__ = ['revs', 'branch']
 
661
 
 
662
    def __init__(self, revs, branch):
 
663
        self.revs = revs
 
664
        self.branch = branch
 
665
 
 
666
    def __getitem__(self, index):
 
667
        """Get the date of the index'd item"""
 
668
        r = self.branch.repository.get_revision(self.revs[index])
 
669
        # TODO: Handle timezone.
 
670
        return datetime.datetime.fromtimestamp(r.timestamp)
 
671
 
 
672
    def __len__(self):
 
673
        return len(self.revs)
 
674
 
 
675
 
 
676
class RevisionSpec_date(RevisionSpec):
 
677
    """Selects a revision on the basis of a datestamp."""
 
678
 
 
679
    help_txt = """Selects a revision on the basis of a datestamp.
 
680
 
 
681
    Supply a datestamp to select the first revision that matches the date.
 
682
    Date can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
 
683
    Matches the first entry after a given date (either at midnight or
 
684
    at a specified time).
 
685
 
 
686
    One way to display all the changes since yesterday would be::
 
687
 
 
688
        bzr log -r date:yesterday..
 
689
 
 
690
    Examples::
 
691
 
 
692
      date:yesterday            -> select the first revision since yesterday
 
693
      date:2006-08-14,17:10:14  -> select the first revision after
 
694
                                   August 14th, 2006 at 5:10pm.
 
695
    """
 
696
    prefix = 'date:'
 
697
    _date_regex = lazy_regex.lazy_compile(
 
698
            r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
 
699
            r'(,|T)?\s*'
 
700
            r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
 
701
        )
 
702
 
 
703
    def _match_on(self, branch, revs):
 
704
        """Spec for date revisions:
 
705
          date:value
 
706
          value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
 
707
          matches the first entry after a given date (either at midnight or
 
708
          at a specified time).
 
709
        """
 
710
        #  XXX: This doesn't actually work
 
711
        #  So the proper way of saying 'give me all entries for today' is:
 
712
        #      -r date:yesterday..date:today
 
713
        today = datetime.datetime.fromordinal(datetime.date.today().toordinal())
 
714
        if self.spec.lower() == 'yesterday':
 
715
            dt = today - datetime.timedelta(days=1)
 
716
        elif self.spec.lower() == 'today':
 
717
            dt = today
 
718
        elif self.spec.lower() == 'tomorrow':
 
719
            dt = today + datetime.timedelta(days=1)
 
720
        else:
 
721
            m = self._date_regex.match(self.spec)
 
722
            if not m or (not m.group('date') and not m.group('time')):
 
723
                raise errors.InvalidRevisionSpec(self.user_spec,
 
724
                                                 branch, 'invalid date')
 
725
 
 
726
            try:
 
727
                if m.group('date'):
 
728
                    year = int(m.group('year'))
 
729
                    month = int(m.group('month'))
 
730
                    day = int(m.group('day'))
 
731
                else:
 
732
                    year = today.year
 
733
                    month = today.month
 
734
                    day = today.day
 
735
 
 
736
                if m.group('time'):
 
737
                    hour = int(m.group('hour'))
 
738
                    minute = int(m.group('minute'))
 
739
                    if m.group('second'):
 
740
                        second = int(m.group('second'))
 
741
                    else:
 
742
                        second = 0
 
743
                else:
 
744
                    hour, minute, second = 0,0,0
 
745
            except ValueError:
 
746
                raise errors.InvalidRevisionSpec(self.user_spec,
 
747
                                                 branch, 'invalid date')
 
748
 
 
749
            dt = datetime.datetime(year=year, month=month, day=day,
 
750
                    hour=hour, minute=minute, second=second)
 
751
        branch.lock_read()
 
752
        try:
 
753
            rev = bisect.bisect(_RevListToTimestamps(revs, branch), dt)
 
754
        finally:
 
755
            branch.unlock()
 
756
        if rev == len(revs):
 
757
            raise errors.InvalidRevisionSpec(self.user_spec, branch)
 
758
        else:
 
759
            return RevisionInfo(branch, rev + 1)
 
760
 
 
761
 
 
762
 
 
763
class RevisionSpec_ancestor(RevisionSpec):
 
764
    """Selects a common ancestor with a second branch."""
 
765
 
 
766
    help_txt = """Selects a common ancestor with a second branch.
 
767
 
 
768
    Supply the path to a branch to select the common ancestor.
 
769
 
 
770
    The common ancestor is the last revision that existed in both
 
771
    branches. Usually this is the branch point, but it could also be
 
772
    a revision that was merged.
 
773
 
 
774
    This is frequently used with 'diff' to return all of the changes
 
775
    that your branch introduces, while excluding the changes that you
 
776
    have not merged from the remote branch.
 
777
 
 
778
    Examples::
 
779
 
 
780
      ancestor:/path/to/branch
 
781
      $ bzr diff -r ancestor:../../mainline/branch
 
782
    """
 
783
    prefix = 'ancestor:'
 
784
 
 
785
    def _match_on(self, branch, revs):
 
786
        trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
 
787
        return self._find_revision_info(branch, self.spec)
 
788
 
 
789
    def _as_revision_id(self, context_branch):
 
790
        return self._find_revision_id(context_branch, self.spec)
 
791
 
 
792
    @staticmethod
 
793
    def _find_revision_info(branch, other_location):
 
794
        revision_id = RevisionSpec_ancestor._find_revision_id(branch,
 
795
                                                              other_location)
 
796
        try:
 
797
            revno = branch.revision_id_to_revno(revision_id)
 
798
        except errors.NoSuchRevision:
 
799
            revno = None
 
800
        return RevisionInfo(branch, revno, revision_id)
 
801
 
 
802
    @staticmethod
 
803
    def _find_revision_id(branch, other_location):
 
804
        from bzrlib.branch import Branch
 
805
 
 
806
        branch.lock_read()
 
807
        try:
 
808
            revision_a = revision.ensure_null(branch.last_revision())
 
809
            if revision_a == revision.NULL_REVISION:
 
810
                raise errors.NoCommits(branch)
 
811
            if other_location == '':
 
812
                other_location = branch.get_parent()
 
813
            other_branch = Branch.open(other_location)
 
814
            other_branch.lock_read()
 
815
            try:
 
816
                revision_b = revision.ensure_null(other_branch.last_revision())
 
817
                if revision_b == revision.NULL_REVISION:
 
818
                    raise errors.NoCommits(other_branch)
 
819
                graph = branch.repository.get_graph(other_branch.repository)
 
820
                rev_id = graph.find_unique_lca(revision_a, revision_b)
 
821
            finally:
 
822
                other_branch.unlock()
 
823
            if rev_id == revision.NULL_REVISION:
 
824
                raise errors.NoCommonAncestor(revision_a, revision_b)
 
825
            return rev_id
 
826
        finally:
 
827
            branch.unlock()
 
828
 
 
829
 
 
830
 
 
831
 
 
832
class RevisionSpec_branch(RevisionSpec):
 
833
    """Selects the last revision of a specified branch."""
 
834
 
 
835
    help_txt = """Selects the last revision of a specified branch.
 
836
 
 
837
    Supply the path to a branch to select its last revision.
 
838
 
 
839
    Examples::
 
840
 
 
841
      branch:/path/to/branch
 
842
    """
 
843
    prefix = 'branch:'
 
844
    dwim_catchable_exceptions = (errors.NotBranchError,)
 
845
 
 
846
    def _match_on(self, branch, revs):
 
847
        from bzrlib.branch import Branch
 
848
        other_branch = Branch.open(self.spec)
 
849
        revision_b = other_branch.last_revision()
 
850
        if revision_b in (None, revision.NULL_REVISION):
 
851
            raise errors.NoCommits(other_branch)
 
852
        if branch is None:
 
853
            branch = other_branch
 
854
        else:
 
855
            try:
 
856
                # pull in the remote revisions so we can diff
 
857
                branch.fetch(other_branch, revision_b)
 
858
            except errors.ReadOnlyError:
 
859
                branch = other_branch
 
860
        try:
 
861
            revno = branch.revision_id_to_revno(revision_b)
 
862
        except errors.NoSuchRevision:
 
863
            revno = None
 
864
        return RevisionInfo(branch, revno, revision_b)
 
865
 
 
866
    def _as_revision_id(self, context_branch):
 
867
        from bzrlib.branch import Branch
 
868
        other_branch = Branch.open(self.spec)
 
869
        last_revision = other_branch.last_revision()
 
870
        last_revision = revision.ensure_null(last_revision)
 
871
        context_branch.fetch(other_branch, last_revision)
 
872
        if last_revision == revision.NULL_REVISION:
 
873
            raise errors.NoCommits(other_branch)
 
874
        return last_revision
 
875
 
 
876
    def _as_tree(self, context_branch):
 
877
        from bzrlib.branch import Branch
 
878
        other_branch = Branch.open(self.spec)
 
879
        last_revision = other_branch.last_revision()
 
880
        last_revision = revision.ensure_null(last_revision)
 
881
        if last_revision == revision.NULL_REVISION:
 
882
            raise errors.NoCommits(other_branch)
 
883
        return other_branch.repository.revision_tree(last_revision)
 
884
 
 
885
    def needs_branch(self):
 
886
        return False
 
887
 
 
888
    def get_branch(self):
 
889
        return self.spec
 
890
 
 
891
 
 
892
 
 
893
class RevisionSpec_submit(RevisionSpec_ancestor):
 
894
    """Selects a common ancestor with a submit branch."""
 
895
 
 
896
    help_txt = """Selects a common ancestor with the submit branch.
 
897
 
 
898
    Diffing against this shows all the changes that were made in this branch,
 
899
    and is a good predictor of what merge will do.  The submit branch is
 
900
    used by the bundle and merge directive commands.  If no submit branch
 
901
    is specified, the parent branch is used instead.
 
902
 
 
903
    The common ancestor is the last revision that existed in both
 
904
    branches. Usually this is the branch point, but it could also be
 
905
    a revision that was merged.
 
906
 
 
907
    Examples::
 
908
 
 
909
      $ bzr diff -r submit:
 
910
    """
 
911
 
 
912
    prefix = 'submit:'
 
913
 
 
914
    def _get_submit_location(self, branch):
 
915
        submit_location = branch.get_submit_branch()
 
916
        location_type = 'submit branch'
 
917
        if submit_location is None:
 
918
            submit_location = branch.get_parent()
 
919
            location_type = 'parent branch'
 
920
        if submit_location is None:
 
921
            raise errors.NoSubmitBranch(branch)
 
922
        trace.note(gettext('Using {0} {1}').format(location_type,
 
923
                                                        submit_location))
 
924
        return submit_location
 
925
 
 
926
    def _match_on(self, branch, revs):
 
927
        trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
 
928
        return self._find_revision_info(branch,
 
929
            self._get_submit_location(branch))
 
930
 
 
931
    def _as_revision_id(self, context_branch):
 
932
        return self._find_revision_id(context_branch,
 
933
            self._get_submit_location(context_branch))
 
934
 
 
935
 
 
936
class RevisionSpec_annotate(RevisionIDSpec):
 
937
 
 
938
    prefix = 'annotate:'
 
939
 
 
940
    help_txt = """Select the revision that last modified the specified line.
 
941
 
 
942
    Select the revision that last modified the specified line.  Line is
 
943
    specified as path:number.  Path is a relative path to the file.  Numbers
 
944
    start at 1, and are relative to the current version, not the last-
 
945
    committed version of the file.
 
946
    """
 
947
 
 
948
    def _raise_invalid(self, numstring, context_branch):
 
949
        raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
 
950
            'No such line: %s' % numstring)
 
951
 
 
952
    def _as_revision_id(self, context_branch):
 
953
        path, numstring = self.spec.rsplit(':', 1)
 
954
        try:
 
955
            index = int(numstring) - 1
 
956
        except ValueError:
 
957
            self._raise_invalid(numstring, context_branch)
 
958
        tree, file_path = workingtree.WorkingTree.open_containing(path)
 
959
        tree.lock_read()
 
960
        try:
 
961
            file_id = tree.path2id(file_path)
 
962
            if file_id is None:
 
963
                raise errors.InvalidRevisionSpec(self.user_spec,
 
964
                    context_branch, "File '%s' is not versioned." %
 
965
                    file_path)
 
966
            revision_ids = [r for (r, l) in tree.annotate_iter(file_id)]
 
967
        finally:
 
968
            tree.unlock()
 
969
        try:
 
970
            revision_id = revision_ids[index]
 
971
        except IndexError:
 
972
            self._raise_invalid(numstring, context_branch)
 
973
        if revision_id == revision.CURRENT_REVISION:
 
974
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
 
975
                'Line %s has not been committed.' % numstring)
 
976
        return revision_id
 
977
 
 
978
 
 
979
class RevisionSpec_mainline(RevisionIDSpec):
 
980
 
 
981
    help_txt = """Select mainline revision that merged the specified revision.
 
982
 
 
983
    Select the revision that merged the specified revision into mainline.
 
984
    """
 
985
 
 
986
    prefix = 'mainline:'
 
987
 
 
988
    def _as_revision_id(self, context_branch):
 
989
        revspec = RevisionSpec.from_string(self.spec)
 
990
        if revspec.get_branch() is None:
 
991
            spec_branch = context_branch
 
992
        else:
 
993
            spec_branch = _mod_branch.Branch.open(revspec.get_branch())
 
994
        revision_id = revspec.as_revision_id(spec_branch)
 
995
        graph = context_branch.repository.get_graph()
 
996
        result = graph.find_lefthand_merger(revision_id,
 
997
                                            context_branch.last_revision())
 
998
        if result is None:
 
999
            raise errors.InvalidRevisionSpec(self.user_spec, context_branch)
 
1000
        return result
 
1001
 
 
1002
 
 
1003
# The order in which we want to DWIM a revision spec without any prefix.
 
1004
# revno is always tried first and isn't listed here, this is used by
 
1005
# RevisionSpec_dwim._match_on
 
1006
dwim_revspecs = symbol_versioning.deprecated_list(
 
1007
    symbol_versioning.deprecated_in((2, 4, 0)), "dwim_revspecs", [])
 
1008
 
 
1009
RevisionSpec_dwim.append_possible_revspec(RevisionSpec_tag)
 
1010
RevisionSpec_dwim.append_possible_revspec(RevisionSpec_revid)
 
1011
RevisionSpec_dwim.append_possible_revspec(RevisionSpec_date)
 
1012
RevisionSpec_dwim.append_possible_revspec(RevisionSpec_branch)
 
1013
 
 
1014
revspec_registry = registry.Registry()
 
1015
def _register_revspec(revspec):
 
1016
    revspec_registry.register(revspec.prefix, revspec)
 
1017
 
 
1018
_register_revspec(RevisionSpec_revno)
 
1019
_register_revspec(RevisionSpec_revid)
 
1020
_register_revspec(RevisionSpec_last)
 
1021
_register_revspec(RevisionSpec_before)
 
1022
_register_revspec(RevisionSpec_tag)
 
1023
_register_revspec(RevisionSpec_date)
 
1024
_register_revspec(RevisionSpec_ancestor)
 
1025
_register_revspec(RevisionSpec_branch)
 
1026
_register_revspec(RevisionSpec_submit)
 
1027
_register_revspec(RevisionSpec_annotate)
 
1028
_register_revspec(RevisionSpec_mainline)