~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisionspec.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-13 00:26:41 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101013002641-9tlh9k89mlj1666m
Keep docs-plain working.

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