1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: Some kind of command-line display of revision properties:
17
# TODO: Some kind of command-line display of revision properties:
18
18
# perhaps show them in log -v and allow them as options to the commit command.
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from bzrlib import deprecated_graph
24
from bzrlib import bugtracker
26
21
from bzrlib import (
30
25
from bzrlib.osutils import contains_whitespace
26
from bzrlib.progress import DummyProgress
32
28
NULL_REVISION="null:"
33
29
CURRENT_REVISION="current:"
49
45
Dictionary of revision properties. These are attached to the
50
revision as extra metadata. The name must be a single
46
revision as extra metadata. The name must be a single
51
47
word; the value can be an arbitrary string.
54
50
def __init__(self, revision_id, properties=None, **args):
55
51
self.revision_id = revision_id
56
if properties is None:
59
self.properties = properties
60
self._check_properties()
52
self.properties = properties or {}
53
self._check_properties()
62
54
self.parent_ids = []
63
55
self.parent_sha1s = []
64
56
"""Not used anymore - legacy from for 4."""
70
62
def __eq__(self, other):
71
63
if not isinstance(other, Revision):
65
# FIXME: rbc 20050930 parent_ids are not being compared
74
67
self.inventory_sha1 == other.inventory_sha1
75
68
and self.revision_id == other.revision_id
77
70
and self.message == other.message
78
71
and self.timezone == other.timezone
79
72
and self.committer == other.committer
80
and self.properties == other.properties
81
and self.parent_ids == other.parent_ids)
73
and self.properties == other.properties)
83
75
def __ne__(self, other):
84
76
return not self.__eq__(other)
89
81
if not isinstance(name, basestring) or contains_whitespace(name):
90
82
raise ValueError("invalid property name %r" % name)
91
83
if not isinstance(value, basestring):
92
raise ValueError("invalid property value %r for %r" %
84
raise ValueError("invalid property value %r for %r" %
95
87
def get_history(self, repository):
96
88
"""Return the canonical line-of-history for this revision.
114
106
def get_summary(self):
115
107
"""Get the first line of the log message for this revision.
117
Return an empty string if message is None.
120
return self.message.lstrip().split('\n', 1)[0]
109
return self.message.lstrip().split('\n', 1)[0]
124
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
125
111
def get_apparent_author(self):
126
112
"""Return the apparent author of this revision.
128
This method is deprecated in favour of get_apparent_authors.
130
If the revision properties contain any author names,
131
return the first. Otherwise return the committer name.
133
authors = self.get_apparent_authors()
139
def get_apparent_authors(self):
140
"""Return the apparent authors of this revision.
142
If the revision properties contain the names of the authors,
143
return them. Otherwise return the committer name.
145
The return value will be a list containing at least one element.
147
authors = self.properties.get('authors', None)
149
author = self.properties.get('author', self.committer)
154
return authors.split("\n")
157
"""Iterate over the bugs associated with this revision."""
158
bug_property = self.properties.get('bugs', None)
159
if bug_property is None:
161
for line in bug_property.splitlines():
163
url, status = line.split(None, 2)
165
raise errors.InvalidLineInBugsProperty(line)
166
if status not in bugtracker.ALLOWED_BUG_STATUSES:
167
raise errors.InvalidBugStatus(status)
114
If the revision properties contain the author name,
115
return it. Otherwise return the committer name.
117
return self.properties.get('author', self.committer)
171
120
def iter_ancestors(revision_id, revision_source, only_present=False):
204
153
if anc_id not in found_ancestors:
205
154
found_ancestors[anc_id] = (anc_order, anc_distance)
206
155
return found_ancestors
209
158
def __get_closest(intersection):
210
159
intersection.sort()
212
161
for entry in intersection:
213
162
if entry[0] == intersection[0][0]:
214
163
matches.append(entry[2])
218
167
def is_reserved_id(revision_id):
219
168
"""Determine whether a revision id is reserved
221
:return: True if the revision is reserved, False otherwise
170
:return: True if the revision is is reserved, False otherwise
223
172
return isinstance(revision_id, basestring) and revision_id.endswith(':')