1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: Some kind of command-line display of revision properties:
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
# TODO: Some kind of command-line display of revision properties:
18
20
# perhaps show them in log -v and allow them as options to the commit command.
21
23
from bzrlib.lazy_import import lazy_import
22
24
lazy_import(globals(), """
23
from bzrlib import deprecated_graph
25
from bzrlib import bugtracker
25
27
from bzrlib import (
29
31
from bzrlib.osutils import contains_whitespace
30
from bzrlib.progress import DummyProgress
32
33
NULL_REVISION="null:"
33
34
CURRENT_REVISION="current:"
49
50
Dictionary of revision properties. These are attached to the
50
revision as extra metadata. The name must be a single
51
revision as extra metadata. The name must be a single
51
52
word; the value can be an arbitrary string.
54
55
def __init__(self, revision_id, properties=None, **args):
55
56
self.revision_id = revision_id
56
self.properties = properties or {}
57
self._check_properties()
57
if properties is None:
60
self.properties = properties
61
self._check_properties()
58
63
self.parent_ids = []
59
64
self.parent_sha1s = []
60
65
"""Not used anymore - legacy from for 4."""
66
71
def __eq__(self, other):
67
72
if not isinstance(other, Revision):
69
# FIXME: rbc 20050930 parent_ids are not being compared
71
75
self.inventory_sha1 == other.inventory_sha1
72
76
and self.revision_id == other.revision_id
74
78
and self.message == other.message
75
79
and self.timezone == other.timezone
76
80
and self.committer == other.committer
77
and self.properties == other.properties)
81
and self.properties == other.properties
82
and self.parent_ids == other.parent_ids)
79
84
def __ne__(self, other):
80
85
return not self.__eq__(other)
85
90
if not isinstance(name, basestring) or contains_whitespace(name):
86
91
raise ValueError("invalid property name %r" % name)
87
92
if not isinstance(value, basestring):
88
raise ValueError("invalid property value %r for %r" %
93
raise ValueError("invalid property value %r for %r" %
91
96
def get_history(self, repository):
92
97
"""Return the canonical line-of-history for this revision.
110
115
def get_summary(self):
111
116
"""Get the first line of the log message for this revision.
113
return self.message.lstrip().split('\n', 1)[0]
115
def get_apparent_author(self):
116
"""Return the apparent author of this revision.
118
If the revision properties contain the author name,
119
return it. Otherwise return the committer name.
121
return self.properties.get('author', self.committer)
118
Return an empty string if message is None.
121
return self.message.lstrip().split('\n', 1)[0]
125
def get_apparent_authors(self):
126
"""Return the apparent authors of this revision.
128
If the revision properties contain the names of the authors,
129
return them. Otherwise return the committer name.
131
The return value will be a list containing at least one element.
133
authors = self.properties.get('authors', None)
135
author = self.properties.get('author', self.committer)
140
return authors.split("\n")
143
"""Iterate over the bugs associated with this revision."""
144
bug_property = self.properties.get('bugs', None)
145
if bug_property is None:
147
for line in bug_property.splitlines():
149
url, status = line.split(None, 2)
151
raise errors.InvalidLineInBugsProperty(line)
152
if status not in bugtracker.ALLOWED_BUG_STATUSES:
153
raise errors.InvalidBugStatus(status)
124
157
def iter_ancestors(revision_id, revision_source, only_present=False):
157
190
if anc_id not in found_ancestors:
158
191
found_ancestors[anc_id] = (anc_order, anc_distance)
159
192
return found_ancestors
162
195
def __get_closest(intersection):
163
196
intersection.sort()
165
198
for entry in intersection:
166
199
if entry[0] == intersection[0][0]:
167
200
matches.append(entry[2])
171
204
def is_reserved_id(revision_id):
172
205
"""Determine whether a revision id is reserved
174
:return: True if the revision is is reserved, False otherwise
207
:return: True if the revision is reserved, False otherwise
176
209
return isinstance(revision_id, basestring) and revision_id.endswith(':')