Clean up ChunkedUpdateDrawingAreaProxy
[WebKit-https.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.config import urls
40 from webkitpy.common.net.bugzilla import parse_bug_id
41 from webkitpy.tool.grammar import join_with_separators
42
43
44 class ChangeLogEntry(object):
45     # e.g. 2009-06-03  Eric Seidel  <eric@webkit.org>
46     date_line_regexp = r'^(?P<date>\d{4}-\d{2}-\d{2})\s+(?P<name>.+?)\s+<(?P<email>[^<>]+)>$'
47
48     def __init__(self, contents, committer_list=CommitterList()):
49         self._contents = contents
50         self._committer_list = committer_list
51         self._parse_entry()
52
53     def _parse_entry(self):
54         match = re.match(self.date_line_regexp, self._contents, re.MULTILINE)
55         if not match:
56             log("WARNING: Creating invalid ChangeLogEntry:\n%s" % self._contents)
57
58         # FIXME: group("name") does not seem to be Unicode?  Probably due to self._contents not being unicode.
59         self._author_name = match.group("name") if match else None
60         self._author_email = match.group("email") if match else None
61
62         match = re.search("^\s+Reviewed by (?P<reviewer>.*?)[\.,]?\s*$", self._contents, re.MULTILINE) # Discard everything after the first period
63         self._reviewer_text = match.group("reviewer") if match else None
64
65         self._reviewer = self._committer_list.committer_by_name(self._reviewer_text)
66         self._author = self._committer_list.committer_by_email(self._author_email) or self._committer_list.committer_by_name(self._author_name)
67
68     def author_name(self):
69         return self._author_name
70
71     def author_email(self):
72         return self._author_email
73
74     def author(self):
75         return self._author # Might be None
76
77     # FIXME: Eventually we would like to map reviwer names to reviewer objects.
78     # See https://bugs.webkit.org/show_bug.cgi?id=26533
79     def reviewer_text(self):
80         return self._reviewer_text
81
82     def reviewer(self):
83         return self._reviewer # Might be None
84
85     def contents(self):
86         return self._contents
87
88     def bug_id(self):
89         return parse_bug_id(self._contents)
90
91
92 # FIXME: Various methods on ChangeLog should move into ChangeLogEntry instead.
93 class ChangeLog(object):
94
95     def __init__(self, path):
96         self.path = path
97
98     _changelog_indent = " " * 8
99
100     @staticmethod
101     def parse_latest_entry_from_file(changelog_file):
102         """changelog_file must be a file-like object which returns
103         unicode strings.  Use codecs.open or StringIO(unicode())
104         to pass file objects to this class."""
105         date_line_regexp = re.compile(ChangeLogEntry.date_line_regexp)
106         entry_lines = []
107         # The first line should be a date line.
108         first_line = changelog_file.readline()
109         assert(isinstance(first_line, unicode))
110         if not date_line_regexp.match(first_line):
111             return None
112         entry_lines.append(first_line)
113
114         for line in changelog_file:
115             # If we've hit the next entry, return.
116             if date_line_regexp.match(line):
117                 # Remove the extra newline at the end
118                 return ChangeLogEntry(''.join(entry_lines[:-1]))
119             entry_lines.append(line)
120         return None # We never found a date line!
121
122     def latest_entry(self):
123         # ChangeLog files are always UTF-8, we read them in as such to support Reviewers with unicode in their names.
124         changelog_file = codecs.open(self.path, "r", "utf-8")
125         try:
126             return self.parse_latest_entry_from_file(changelog_file)
127         finally:
128             changelog_file.close()
129
130     # _wrap_line and _wrap_lines exist to work around
131     # http://bugs.python.org/issue1859
132
133     def _wrap_line(self, line):
134         return textwrap.fill(line,
135                              width=70,
136                              initial_indent=self._changelog_indent,
137                              # Don't break urls which may be longer than width.
138                              break_long_words=False,
139                              subsequent_indent=self._changelog_indent)
140
141     # Workaround as suggested by guido in
142     # http://bugs.python.org/issue1859#msg60040
143
144     def _wrap_lines(self, message):
145         lines = [self._wrap_line(line) for line in message.splitlines()]
146         return "\n".join(lines)
147
148     # This probably does not belong in changelogs.py
149     def _message_for_revert(self, revision_list, reason, bug_url):
150         message = "Unreviewed, rolling out %s.\n" % join_with_separators(['r' + str(revision) for revision in revision_list])
151         for revision in revision_list:
152             message += "%s\n" % urls.view_revision_url(revision)
153         if bug_url:
154             message += "%s\n" % bug_url
155         # Add an extra new line after the rollout links, before any reason.
156         message += "\n"
157         if reason:
158             message += "%s\n\n" % reason
159         return self._wrap_lines(message)
160
161     def update_for_revert(self, revision_list, reason, bug_url=None):
162         reviewed_by_regexp = re.compile(
163                 "%sReviewed by NOBODY \(OOPS!\)\." % self._changelog_indent)
164         removing_boilerplate = False
165         # inplace=1 creates a backup file and re-directs stdout to the file
166         for line in fileinput.FileInput(self.path, inplace=1):
167             if reviewed_by_regexp.search(line):
168                 message_lines = self._message_for_revert(revision_list,
169                                                          reason,
170                                                          bug_url)
171                 print reviewed_by_regexp.sub(message_lines, line),
172                 # Remove all the ChangeLog boilerplate between the Reviewed by
173                 # line and the first changed file.
174                 removing_boilerplate = True
175             elif removing_boilerplate:
176                 if line.find('*') >= 0: # each changed file is preceded by a *
177                     removing_boilerplate = False
178
179             if not removing_boilerplate:
180                 print line,
181
182     def set_reviewer(self, reviewer):
183         # inplace=1 creates a backup file and re-directs stdout to the file
184         for line in fileinput.FileInput(self.path, inplace=1):
185             # Trailing comma suppresses printing newline
186             print line.replace("NOBODY (OOPS!)", reviewer.encode("utf-8")),
187
188     def set_short_description_and_bug_url(self, short_description, bug_url):
189         message = "%s\n        %s" % (short_description, bug_url)
190         for line in fileinput.FileInput(self.path, inplace=1):
191             print line.replace("Need a short description and bug URL (OOPS!)", message.encode("utf-8")),