13
13
# You should have received a copy of the GNU General Public License
14
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
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26
22
from bzrlib import (
141
wants_revision_history = True
137
def __new__(cls, spec, _internal=False):
139
return object.__new__(cls, spec, _internal=_internal)
141
symbol_versioning.warn('Creating a RevisionSpec directly has'
142
' been deprecated in version 0.11. Use'
143
' RevisionSpec.from_string()'
145
DeprecationWarning, stacklevel=2)
146
return RevisionSpec.from_string(spec)
144
149
def from_string(spec):
155
160
return RevisionSpec(None, _internal=True)
156
match = revspec_registry.get_prefix(spec)
157
if match is not None:
158
spectype, specsuffix = match
159
trace.mutter('Returning RevisionSpec %s for %s',
160
spectype.__name__, spec)
161
return spectype(spec, _internal=True)
163
for spectype in SPEC_TYPES:
162
assert isinstance(spec, basestring), \
163
"You should only supply strings not %s" % (type(spec),)
165
for spectype in SPEC_TYPES:
166
if spec.startswith(spectype.prefix):
164
167
trace.mutter('Returning RevisionSpec %s for %s',
165
168
spectype.__name__, spec)
166
if spec.startswith(spectype.prefix):
167
return spectype(spec, _internal=True)
169
return spectype(spec, _internal=True)
168
171
# RevisionSpec_revno is special cased, because it is the only
169
172
# one that directly handles plain integers
170
173
# TODO: This should not be special cased rather it should be
199
202
def _match_on(self, branch, revs):
200
203
trace.mutter('Returning RevisionSpec._match_on: None')
201
return RevisionInfo(branch, None, None)
204
return RevisionInfo(branch, 0, None)
203
206
def _match_on_and_check(self, branch, revs):
204
207
info = self._match_on(branch, revs)
207
elif info == (None, None):
208
# special case - nothing supplied
210
elif info == (0, None):
211
# special case - the empty tree
210
213
elif self.prefix:
211
214
raise errors.InvalidRevisionSpec(self.user_spec, branch)
215
218
def in_history(self, branch):
217
if self.wants_revision_history:
218
revs = branch.revision_history()
220
revs = branch.revision_history()
222
222
# this should never trigger.
223
223
# TODO: make it a deprecated code path. RBC 20060928
233
233
# will do what you expect.
234
234
in_store = in_history
235
235
in_branch = in_store
237
def as_revision_id(self, context_branch):
238
"""Return just the revision_id for this revisions spec.
240
Some revision specs require a context_branch to be able to determine
241
their value. Not all specs will make use of it.
243
return self._as_revision_id(context_branch)
245
def _as_revision_id(self, context_branch):
246
"""Implementation of as_revision_id()
248
Classes should override this function to provide appropriate
249
functionality. The default is to just call '.in_history().rev_id'
251
return self.in_history(context_branch).rev_id
253
def as_tree(self, context_branch):
254
"""Return the tree object for this revisions spec.
256
Some revision specs require a context_branch to be able to determine
257
the revision id and access the repository. Not all specs will make
260
return self._as_tree(context_branch)
262
def _as_tree(self, context_branch):
263
"""Implementation of as_tree().
265
Classes should override this function to provide appropriate
266
functionality. The default is to just call '.as_revision_id()'
267
and get the revision tree from context_branch's repository.
269
revision_id = self.as_revision_id(context_branch)
270
return context_branch.repository.revision_tree(revision_id)
272
237
def __repr__(self):
273
238
# this is mostly for helping with testing
274
239
return '<%s %s>' % (self.__class__.__name__,
277
242
def needs_branch(self):
278
243
"""Whether this revision spec needs a branch.
301
266
A negative number will count from the end of the branch (-1 is the
302
267
last revision, -2 the previous one). If the negative number is larger
303
268
than the branch's history, the first revision is returned.
306
revno:1 -> return the first revision of this branch
270
revno:1 -> return the first revision
307
271
revno:3:/path/to/branch -> return the 3rd revision of
308
272
the branch '/path/to/branch'
309
273
revno:-1 -> The last revision in a branch.
313
277
your history is very long.
315
279
prefix = 'revno:'
316
wants_revision_history = False
318
281
def _match_on(self, branch, revs):
319
282
"""Lookup a revision by revision number"""
320
branch, revno, revision_id = self._lookup(branch, revs)
321
return RevisionInfo(branch, revno, revision_id)
323
def _lookup(self, branch, revs_or_none):
324
283
loc = self.spec.find(':')
326
285
revno_spec = self.spec
355
314
# the branch object.
356
315
from bzrlib.branch import Branch
357
316
branch = Branch.open(branch_spec)
317
# Need to use a new revision history
318
# because we are using a specific branch
319
revs = branch.revision_history()
362
revision_id = branch.dotted_revno_to_revision_id(match_revno,
364
except errors.NoSuchRevision:
365
raise errors.InvalidRevisionSpec(self.user_spec, branch)
324
revision_id_to_revno = branch.get_revision_id_to_revno_map()
325
revisions = [revision_id for revision_id, revno
326
in revision_id_to_revno.iteritems()
327
if revno == match_revno]
330
if len(revisions) != 1:
331
return RevisionInfo(branch, None, None)
367
333
# there is no traditional 'revno' for dotted-decimal revnos.
368
334
# so for API compatability we return None.
369
return branch, None, revision_id
335
return RevisionInfo(branch, None, revisions[0])
371
last_revno, last_revision_id = branch.last_revision_info()
373
338
# if get_rev_id supported negative revnos, there would not be a
374
339
# need for this special case.
375
if (-revno) >= last_revno:
340
if (-revno) >= len(revs):
378
revno = last_revno + revno + 1
343
revno = len(revs) + revno + 1
380
revision_id = branch.get_rev_id(revno, revs_or_none)
345
revision_id = branch.get_rev_id(revno, revs)
381
346
except errors.NoSuchRevision:
382
347
raise errors.InvalidRevisionSpec(self.user_spec, branch)
383
return branch, revno, revision_id
385
def _as_revision_id(self, context_branch):
386
# We would have the revno here, but we don't really care
387
branch, revno, revision_id = self._lookup(context_branch, None)
348
return RevisionInfo(branch, revno, revision_id)
390
350
def needs_branch(self):
391
351
return self.spec.find(':') == -1
407
368
help_txt = """Selects a revision using the revision id.
409
370
Supply a specific revision id, that can be used to specify any
410
revision id in the ancestry of the branch.
371
revision id in the ancestry of the branch.
411
372
Including merges, and pending merges.
414
374
revid:aaaa@bbbb-123456789 -> Select revision 'aaaa@bbbb-123456789'
417
376
prefix = 'revid:'
419
378
def _match_on(self, branch, revs):
423
382
revision_id = osutils.safe_revision_id(self.spec, warn=False)
424
383
return RevisionInfo.from_revision_id(branch, revision_id, revs)
426
def _as_revision_id(self, context_branch):
427
return osutils.safe_revision_id(self.spec, warn=False)
385
SPEC_TYPES.append(RevisionSpec_revid)
431
388
class RevisionSpec_last(RevisionSpec):
436
393
Supply a positive number to get the nth revision from the end.
437
394
This is the same as supplying negative numbers to the 'revno:' spec.
440
396
last:1 -> return the last revision
441
397
last:3 -> return the revision 2 before the end.
446
402
def _match_on(self, branch, revs):
447
revno, revision_id = self._revno_and_revision_id(branch, revs)
448
return RevisionInfo(branch, revno, revision_id)
450
def _revno_and_revision_id(self, context_branch, revs_or_none):
451
last_revno, last_revision_id = context_branch.last_revision_info()
453
403
if self.spec == '':
455
raise errors.NoCommits(context_branch)
456
return last_revno, last_revision_id
405
raise errors.NoCommits(branch)
406
return RevisionInfo(branch, len(revs), revs[-1])
459
409
offset = int(self.spec)
460
410
except ValueError, e:
461
raise errors.InvalidRevisionSpec(self.user_spec, context_branch, e)
411
raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
464
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
414
raise errors.InvalidRevisionSpec(self.user_spec, branch,
465
415
'you must supply a positive value')
467
revno = last_revno - offset + 1
416
revno = len(revs) - offset + 1
469
revision_id = context_branch.get_rev_id(revno, revs_or_none)
418
revision_id = branch.get_rev_id(revno, revs)
470
419
except errors.NoSuchRevision:
471
raise errors.InvalidRevisionSpec(self.user_spec, context_branch)
472
return revno, revision_id
474
def _as_revision_id(self, context_branch):
475
# We compute the revno as part of the process, but we don't really care
477
revno, revision_id = self._revno_and_revision_id(context_branch, None)
420
raise errors.InvalidRevisionSpec(self.user_spec, branch)
421
return RevisionInfo(branch, revno, revision_id)
423
SPEC_TYPES.append(RevisionSpec_last)
482
426
class RevisionSpec_before(RevisionSpec):
485
429
help_txt = """Selects the parent of the revision specified.
487
Supply any revision spec to return the parent of that revision. This is
488
mostly useful when inspecting revisions that are not in the revision history
431
Supply any revision spec to return the parent of that revision.
491
432
It is an error to request the parent of the null revision (before:0).
433
This is mostly useful when inspecting revisions that are not in the
434
revision history of a branch.
495
437
before:1913 -> Return the parent of revno 1913 (revno 1912)
496
438
before:revid:aaaa@bbbb-1234567890 -> return the parent of revision
497
439
aaaa@bbbb-1234567890
498
bzr diff -r before:1913..1913
499
-> Find the changes between revision 1913 and its parent (1912).
500
(What changes did revision 1913 introduce).
501
This is equivalent to: bzr diff -c 1913
440
bzr diff -r before:revid:aaaa..revid:aaaa
441
-> Find the changes between revision 'aaaa' and its parent.
442
(what changes did 'aaaa' introduce)
504
445
prefix = 'before:'
506
447
def _match_on(self, branch, revs):
507
448
r = RevisionSpec.from_string(self.spec)._match_on(branch, revs)
530
471
return RevisionInfo(branch, revno, revision_id)
532
def _as_revision_id(self, context_branch):
533
base_revspec = RevisionSpec.from_string(self.spec)
534
base_revision_id = base_revspec.as_revision_id(context_branch)
535
if base_revision_id == revision.NULL_REVISION:
536
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
537
'cannot go before the null: revision')
538
context_repo = context_branch.repository
539
context_repo.lock_read()
541
parent_map = context_repo.get_parent_map([base_revision_id])
543
context_repo.unlock()
544
if base_revision_id not in parent_map:
545
# Ghost, or unknown revision id
546
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
547
'cannot find the matching revision')
548
parents = parent_map[base_revision_id]
550
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
551
'No parents for revision.')
473
SPEC_TYPES.append(RevisionSpec_before)
556
476
class RevisionSpec_tag(RevisionSpec):
603
521
Matches the first entry after a given date (either at midnight or
604
522
at a specified time).
606
One way to display all the changes since yesterday would be::
608
bzr log -r date:yesterday..
524
One way to display all the changes since yesterday would be:
525
bzr log -r date:yesterday..-1
612
528
date:yesterday -> select the first revision since yesterday
613
529
date:2006-08-14,17:10:14 -> select the first revision after
614
530
August 14th, 2006 at 5:10pm.
617
533
_date_re = re.compile(
618
534
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
676
592
if rev == len(revs):
677
raise errors.InvalidRevisionSpec(self.user_spec, branch)
593
return RevisionInfo(branch, None)
679
595
return RevisionInfo(branch, rev + 1)
597
SPEC_TYPES.append(RevisionSpec_date)
683
600
class RevisionSpec_ancestor(RevisionSpec):
706
622
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
707
623
return self._find_revision_info(branch, self.spec)
709
def _as_revision_id(self, context_branch):
710
return self._find_revision_id(context_branch, self.spec)
713
626
def _find_revision_info(branch, other_location):
714
revision_id = RevisionSpec_ancestor._find_revision_id(branch,
627
from bzrlib.branch import Branch
629
other_branch = Branch.open(other_location)
630
revision_a = branch.last_revision()
631
revision_b = other_branch.last_revision()
632
for r, b in ((revision_a, branch), (revision_b, other_branch)):
633
if r in (None, revision.NULL_REVISION):
634
raise errors.NoCommits(b)
635
revision_source = revision.MultipleRevisionSources(
636
branch.repository, other_branch.repository)
637
rev_id = revision.common_ancestor(revision_a, revision_b,
717
revno = branch.revision_id_to_revno(revision_id)
640
revno = branch.revision_id_to_revno(rev_id)
718
641
except errors.NoSuchRevision:
720
return RevisionInfo(branch, revno, revision_id)
723
def _find_revision_id(branch, other_location):
724
from bzrlib.branch import Branch
728
revision_a = revision.ensure_null(branch.last_revision())
729
if revision_a == revision.NULL_REVISION:
730
raise errors.NoCommits(branch)
731
if other_location == '':
732
other_location = branch.get_parent()
733
other_branch = Branch.open(other_location)
734
other_branch.lock_read()
736
revision_b = revision.ensure_null(other_branch.last_revision())
737
if revision_b == revision.NULL_REVISION:
738
raise errors.NoCommits(other_branch)
739
graph = branch.repository.get_graph(other_branch.repository)
740
rev_id = graph.find_unique_lca(revision_a, revision_b)
742
other_branch.unlock()
743
if rev_id == revision.NULL_REVISION:
744
raise errors.NoCommonAncestor(revision_a, revision_b)
643
return RevisionInfo(branch, revno, rev_id)
646
SPEC_TYPES.append(RevisionSpec_ancestor)
752
649
class RevisionSpec_branch(RevisionSpec):
775
671
except errors.NoSuchRevision:
777
673
return RevisionInfo(branch, revno, revision_b)
779
def _as_revision_id(self, context_branch):
780
from bzrlib.branch import Branch
781
other_branch = Branch.open(self.spec)
782
last_revision = other_branch.last_revision()
783
last_revision = revision.ensure_null(last_revision)
784
context_branch.fetch(other_branch, last_revision)
785
if last_revision == revision.NULL_REVISION:
786
raise errors.NoCommits(other_branch)
789
def _as_tree(self, context_branch):
790
from bzrlib.branch import Branch
791
other_branch = Branch.open(self.spec)
792
last_revision = other_branch.last_revision()
793
last_revision = revision.ensure_null(last_revision)
794
if last_revision == revision.NULL_REVISION:
795
raise errors.NoCommits(other_branch)
796
return other_branch.repository.revision_tree(last_revision)
675
SPEC_TYPES.append(RevisionSpec_branch)
800
678
class RevisionSpec_submit(RevisionSpec_ancestor):
805
683
Diffing against this shows all the changes that were made in this branch,
806
684
and is a good predictor of what merge will do. The submit branch is
807
used by the bundle and merge directive commands. If no submit branch
685
used by the bundle and merge directive comands. If no submit branch
808
686
is specified, the parent branch is used instead.
810
688
The common ancestor is the last revision that existed in both
811
689
branches. Usually this is the branch point, but it could also be
812
690
a revision that was merged.
816
693
$ bzr diff -r submit:
819
696
prefix = 'submit:'
821
def _get_submit_location(self, branch):
698
def _match_on(self, branch, revs):
699
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
822
700
submit_location = branch.get_submit_branch()
823
701
location_type = 'submit branch'
824
702
if submit_location is None:
827
705
if submit_location is None:
828
706
raise errors.NoSubmitBranch(branch)
829
707
trace.note('Using %s %s', location_type, submit_location)
830
return submit_location
832
def _match_on(self, branch, revs):
833
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
834
return self._find_revision_info(branch,
835
self._get_submit_location(branch))
837
def _as_revision_id(self, context_branch):
838
return self._find_revision_id(context_branch,
839
self._get_submit_location(context_branch))
842
revspec_registry = registry.Registry()
843
def _register_revspec(revspec):
844
revspec_registry.register(revspec.prefix, revspec)
846
_register_revspec(RevisionSpec_revno)
847
_register_revspec(RevisionSpec_revid)
848
_register_revspec(RevisionSpec_last)
849
_register_revspec(RevisionSpec_before)
850
_register_revspec(RevisionSpec_tag)
851
_register_revspec(RevisionSpec_date)
852
_register_revspec(RevisionSpec_ancestor)
853
_register_revspec(RevisionSpec_branch)
854
_register_revspec(RevisionSpec_submit)
856
SPEC_TYPES = symbol_versioning.deprecated_list(
857
symbol_versioning.deprecated_in((1, 12, 0)), "SPEC_TYPES", [])
708
return self._find_revision_info(branch, submit_location)
711
SPEC_TYPES.append(RevisionSpec_submit)