2011-01-28 Adam Barth <abarth@webkit.org>
[WebKit.git] / Tools / Scripts / webkitpy / common / checkout / changelog.py
1 # Copyright (C) 2009, Google Inc. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions are
5 # met:
6 #
7 #     * Redistributions of source code must retain the above copyright
8 # notice, this list of conditions and the following disclaimer.
9 #     * Redistributions in binary form must reproduce the above
10 # copyright notice, this list of conditions and the following disclaimer
11 # in the documentation and/or other materials provided with the
12 # distribution.
13 #     * Neither the name of Google Inc. nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
16 #
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #
29 # WebKit's Python module for parsing and modifying ChangeLog files
30
31 import codecs
32 import fileinput # inplace file editing for set_reviewer_in_changelog
33 import os.path
34 import re
35 import textwrap
36
37 from webkitpy.common.system.deprecated_logging import log
38 from webkitpy.common.config.committers import CommitterList
39 from webkitpy.common.net.bugzilla import parse_bug_id
40
41
42 class ChangeLogEntry(object):
43     # e.g. 2009-06-03  Eric Seidel  <eric@webkit.org>
44     date_line_regexp = r'^(?P<date>\d{4}-\d{2}-\d{2})\s+(?P<name>.+?)\s+<(?P<email>[^<>]+)>$'
45
46     def __init__(self, contents, committer_list=CommitterList()):
47         self._contents = contents
48         self._committer_list = committer_list
49         self._parse_entry()
50
51     def _parse_entry(self):
52         match = re.match(self.date_line_regexp, self._contents, re.MULTILINE)
53         if not match:
54             log("WARNING: Creating invalid ChangeLogEntry:\n%s" % self._contents)
55
56         # FIXME: group("name") does not seem to be Unicode?  Probably due to self._contents not being unicode.
57         self._author_name = match.group("name") if match else None
58         self._author_email = match.group("email") if match else None
59
60         match = re.search("^\s+Reviewed by (?P<reviewer>.*?)[\.,]?\s*$", self._contents, re.MULTILINE) # Discard everything after the first period
61         self._reviewer_text = match.group("reviewer") if match else None
62
63         self._reviewer = self._committer_list.committer_by_name(self._reviewer_text)
64         self._author = self._committer_list.committer_by_email(self._author_email) or self._committer_list.committer_by_name(self._author_name)
65
66     def author_name(self):
67         return self._author_name
68
69     def author_email(self):
70         return self._author_email
71
72     def author(self):
73         return self._author # Might be None
74
75     # FIXME: Eventually we would like to map reviwer names to reviewer objects.
76     # See https://bugs.webkit.org/show_bug.cgi?id=26533
77     def reviewer_text(self):
78         return self._reviewer_text
79
80     def reviewer(self):
81         return self._reviewer # Might be None
82
83     def contents(self):
84         return self._contents
85
86     def bug_id(self):
87         return parse_bug_id(self._contents)
88
89
90 # FIXME: Various methods on ChangeLog should move into ChangeLogEntry instead.
91 class ChangeLog(object):
92
93     def __init__(self, path):
94         self.path = path
95
96     _changelog_indent = " " * 8
97
98     @staticmethod
99     def parse_latest_entry_from_file(changelog_file):
100         """changelog_file must be a file-like object which returns
101         unicode strings.  Use codecs.open or StringIO(unicode())
102         to pass file objects to this class."""
103         date_line_regexp = re.compile(ChangeLogEntry.date_line_regexp)
104         entry_lines = []
105         # The first line should be a date line.
106         first_line = changelog_file.readline()
107         assert(isinstance(first_line, unicode))
108         if not date_line_regexp.match(first_line):
109             return None
110         entry_lines.append(first_line)
111
112         for line in changelog_file:
113             # If we've hit the next entry, return.
114             if date_line_regexp.match(line):
115                 # Remove the extra newline at the end
116                 return ChangeLogEntry(''.join(entry_lines[:-1]))
117             entry_lines.append(line)
118         return None # We never found a date line!
119
120     def latest_entry(self):
121         # ChangeLog files are always UTF-8, we read them in as such to support Reviewers with unicode in their names.
122         changelog_file = codecs.open(self.path, "r", "utf-8")
123         try:
124             return self.parse_latest_entry_from_file(changelog_file)
125         finally:
126             changelog_file.close()
127
128     # _wrap_line and _wrap_lines exist to work around
129     # http://bugs.python.org/issue1859
130
131     def _wrap_line(self, line):
132         return textwrap.fill(line,
133                              width=70,
134                              initial_indent=self._changelog_indent,
135                              # Don't break urls which may be longer than width.
136                              break_long_words=False,
137                              subsequent_indent=self._changelog_indent)
138
139     # Workaround as suggested by guido in
140     # http://bugs.python.org/issue1859#msg60040
141
142     def _wrap_lines(self, message):
143         lines = [self._wrap_line(line) for line in message.splitlines()]
144         return "\n".join(lines)
145
146     def update_with_unreviewed_message(self, message):
147         reviewed_by_regexp = re.compile(
148                 "%sReviewed by NOBODY \(OOPS!\)\." % self._changelog_indent)
149         removing_boilerplate = False
150         # inplace=1 creates a backup file and re-directs stdout to the file
151         for line in fileinput.FileInput(self.path, inplace=1):
152             if reviewed_by_regexp.search(line):
153                 message_lines = self._wrap_lines(message)
154                 print reviewed_by_regexp.sub(message_lines, line),
155                 # Remove all the ChangeLog boilerplate between the Reviewed by
156                 # line and the first changed file.
157                 removing_boilerplate = True
158             elif removing_boilerplate:
159                 if line.find('*') >= 0: # each changed file is preceded by a *
160                     removing_boilerplate = False
161
162             if not removing_boilerplate:
163                 print line,
164
165     def set_reviewer(self, reviewer):
166         # inplace=1 creates a backup file and re-directs stdout to the file
167         for line in fileinput.FileInput(self.path, inplace=1):
168             # Trailing comma suppresses printing newline
169             print line.replace("NOBODY (OOPS!)", reviewer.encode("utf-8")),
170
171     def set_short_description_and_bug_url(self, short_description, bug_url):
172         message = "%s\n        %s" % (short_description, bug_url)
173         for line in fileinput.FileInput(self.path, inplace=1):
174             print line.replace("Need a short description and bug URL (OOPS!)", message.encode("utf-8")),