1# Copyright (c) 2011 The Chromium OS Authors. 2# 3# SPDX-License-Identifier: GPL-2.0+ 4# 5 6import itertools 7import os 8 9import get_maintainer 10import gitutil 11import terminal 12 13# Series-xxx tags that we understand 14valid_series = ['to', 'cc', 'version', 'changes', 'prefix', 'notes', 'name', 15 'cover-cc', 'process_log'] 16 17class Series(dict): 18 """Holds information about a patch series, including all tags. 19 20 Vars: 21 cc: List of aliases/emails to Cc all patches to 22 commits: List of Commit objects, one for each patch 23 cover: List of lines in the cover letter 24 notes: List of lines in the notes 25 changes: (dict) List of changes for each version, The key is 26 the integer version number 27 allow_overwrite: Allow tags to overwrite an existing tag 28 """ 29 def __init__(self): 30 self.cc = [] 31 self.to = [] 32 self.cover_cc = [] 33 self.commits = [] 34 self.cover = None 35 self.notes = [] 36 self.changes = {} 37 self.allow_overwrite = False 38 39 # Written in MakeCcFile() 40 # key: name of patch file 41 # value: list of email addresses 42 self._generated_cc = {} 43 44 # These make us more like a dictionary 45 def __setattr__(self, name, value): 46 self[name] = value 47 48 def __getattr__(self, name): 49 return self[name] 50 51 def AddTag(self, commit, line, name, value): 52 """Add a new Series-xxx tag along with its value. 53 54 Args: 55 line: Source line containing tag (useful for debug/error messages) 56 name: Tag name (part after 'Series-') 57 value: Tag value (part after 'Series-xxx: ') 58 """ 59 # If we already have it, then add to our list 60 name = name.replace('-', '_') 61 if name in self and not self.allow_overwrite: 62 values = value.split(',') 63 values = [str.strip() for str in values] 64 if type(self[name]) != type([]): 65 raise ValueError("In %s: line '%s': Cannot add another value " 66 "'%s' to series '%s'" % 67 (commit.hash, line, values, self[name])) 68 self[name] += values 69 70 # Otherwise just set the value 71 elif name in valid_series: 72 self[name] = value 73 else: 74 raise ValueError("In %s: line '%s': Unknown 'Series-%s': valid " 75 "options are %s" % (commit.hash, line, name, 76 ', '.join(valid_series))) 77 78 def AddCommit(self, commit): 79 """Add a commit into our list of commits 80 81 We create a list of tags in the commit subject also. 82 83 Args: 84 commit: Commit object to add 85 """ 86 commit.CheckTags() 87 self.commits.append(commit) 88 89 def ShowActions(self, args, cmd, process_tags): 90 """Show what actions we will/would perform 91 92 Args: 93 args: List of patch files we created 94 cmd: The git command we would have run 95 process_tags: Process tags as if they were aliases 96 """ 97 col = terminal.Color() 98 print 'Dry run, so not doing much. But I would do this:' 99 print 100 print 'Send a total of %d patch%s with %scover letter.' % ( 101 len(args), '' if len(args) == 1 else 'es', 102 self.get('cover') and 'a ' or 'no ') 103 104 # TODO: Colour the patches according to whether they passed checks 105 for upto in range(len(args)): 106 commit = self.commits[upto] 107 print col.Color(col.GREEN, ' %s' % args[upto]) 108 cc_list = list(self._generated_cc[commit.patch]) 109 110 # Skip items in To list 111 if 'to' in self: 112 try: 113 map(cc_list.remove, gitutil.BuildEmailList(self.to)) 114 except ValueError: 115 pass 116 117 for email in cc_list: 118 if email == None: 119 email = col.Color(col.YELLOW, "<alias '%s' not found>" 120 % tag) 121 if email: 122 print ' Cc: ',email 123 print 124 for item in gitutil.BuildEmailList(self.get('to', '<none>')): 125 print 'To:\t ', item 126 for item in gitutil.BuildEmailList(self.cc): 127 print 'Cc:\t ', item 128 print 'Version: ', self.get('version') 129 print 'Prefix:\t ', self.get('prefix') 130 if self.cover: 131 print 'Cover: %d lines' % len(self.cover) 132 cover_cc = gitutil.BuildEmailList(self.get('cover_cc', '')) 133 all_ccs = itertools.chain(cover_cc, *self._generated_cc.values()) 134 for email in set(all_ccs): 135 print ' Cc: ',email 136 if cmd: 137 print 'Git command: %s' % cmd 138 139 def MakeChangeLog(self, commit): 140 """Create a list of changes for each version. 141 142 Return: 143 The change log as a list of strings, one per line 144 145 Changes in v4: 146 - Jog the dial back closer to the widget 147 148 Changes in v3: None 149 Changes in v2: 150 - Fix the widget 151 - Jog the dial 152 153 etc. 154 """ 155 final = [] 156 process_it = self.get('process_log', '').split(',') 157 process_it = [item.strip() for item in process_it] 158 need_blank = False 159 for change in sorted(self.changes, reverse=True): 160 out = [] 161 for this_commit, text in self.changes[change]: 162 if commit and this_commit != commit: 163 continue 164 if 'uniq' not in process_it or text not in out: 165 out.append(text) 166 line = 'Changes in v%d:' % change 167 have_changes = len(out) > 0 168 if 'sort' in process_it: 169 out = sorted(out) 170 if have_changes: 171 out.insert(0, line) 172 else: 173 out = [line + ' None'] 174 if need_blank: 175 out.insert(0, '') 176 final += out 177 need_blank = have_changes 178 if self.changes: 179 final.append('') 180 return final 181 182 def DoChecks(self): 183 """Check that each version has a change log 184 185 Print an error if something is wrong. 186 """ 187 col = terminal.Color() 188 if self.get('version'): 189 changes_copy = dict(self.changes) 190 for version in range(1, int(self.version) + 1): 191 if self.changes.get(version): 192 del changes_copy[version] 193 else: 194 if version > 1: 195 str = 'Change log missing for v%d' % version 196 print col.Color(col.RED, str) 197 for version in changes_copy: 198 str = 'Change log for unknown version v%d' % version 199 print col.Color(col.RED, str) 200 elif self.changes: 201 str = 'Change log exists, but no version is set' 202 print col.Color(col.RED, str) 203 204 def MakeCcFile(self, process_tags, cover_fname, raise_on_error, 205 add_maintainers): 206 """Make a cc file for us to use for per-commit Cc automation 207 208 Also stores in self._generated_cc to make ShowActions() faster. 209 210 Args: 211 process_tags: Process tags as if they were aliases 212 cover_fname: If non-None the name of the cover letter. 213 raise_on_error: True to raise an error when an alias fails to match, 214 False to just print a message. 215 add_maintainers: Call the get_maintainers to CC maintainers 216 Return: 217 Filename of temp file created 218 """ 219 # Look for commit tags (of the form 'xxx:' at the start of the subject) 220 fname = '/tmp/patman.%d' % os.getpid() 221 fd = open(fname, 'w') 222 all_ccs = [] 223 for commit in self.commits: 224 list = [] 225 if process_tags: 226 list += gitutil.BuildEmailList(commit.tags, 227 raise_on_error=raise_on_error) 228 list += gitutil.BuildEmailList(commit.cc_list, 229 raise_on_error=raise_on_error) 230 if add_maintainers: 231 list += get_maintainer.GetMaintainer(commit.patch) 232 all_ccs += list 233 print >>fd, commit.patch, ', '.join(list) 234 self._generated_cc[commit.patch] = list 235 236 if cover_fname: 237 cover_cc = gitutil.BuildEmailList(self.get('cover_cc', '')) 238 print >>fd, cover_fname, ', '.join(set(cover_cc + all_ccs)) 239 240 fd.close() 241 return fname 242 243 def AddChange(self, version, commit, info): 244 """Add a new change line to a version. 245 246 This will later appear in the change log. 247 248 Args: 249 version: version number to add change list to 250 info: change line for this version 251 """ 252 if not self.changes.get(version): 253 self.changes[version] = [] 254 self.changes[version].append([commit, info]) 255 256 def GetPatchPrefix(self): 257 """Get the patch version string 258 259 Return: 260 Patch string, like 'RFC PATCH v5' or just 'PATCH' 261 """ 262 version = '' 263 if self.get('version'): 264 version = ' v%s' % self['version'] 265 266 # Get patch name prefix 267 prefix = '' 268 if self.get('prefix'): 269 prefix = '%s ' % self['prefix'] 270 return '%sPATCH%s' % (prefix, version) 271