Mike Frysinger | f601376 | 2019-06-13 02:30:51 -0400 | [diff] [blame] | 1 | # -*- coding:utf-8 -*- |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 2 | # |
| 3 | # Copyright (C) 2008 The Android Open Source Project |
| 4 | # |
| 5 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | # you may not use this file except in compliance with the License. |
| 7 | # You may obtain a copy of the License at |
| 8 | # |
| 9 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | # |
| 11 | # Unless required by applicable law or agreed to in writing, software |
| 12 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | # See the License for the specific language governing permissions and |
| 15 | # limitations under the License. |
| 16 | |
| 17 | import os |
| 18 | import optparse |
Conley Owens | d21720d | 2012-04-16 11:02:21 -0700 | [diff] [blame] | 19 | import platform |
Colin Cross | 5acde75 | 2012-03-28 20:15:45 -0700 | [diff] [blame] | 20 | import re |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 21 | import sys |
| 22 | |
David Riley | e0684ad | 2017-04-05 00:02:59 -0700 | [diff] [blame] | 23 | from event_log import EventLog |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 24 | from error import NoSuchProjectError |
Colin Cross | 5acde75 | 2012-03-28 20:15:45 -0700 | [diff] [blame] | 25 | from error import InvalidProjectGroupsError |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 26 | |
David Pursehouse | b148ac9 | 2012-11-16 09:33:39 +0900 | [diff] [blame] | 27 | |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 28 | class Command(object): |
| 29 | """Base class for any command line action in repo. |
| 30 | """ |
| 31 | |
| 32 | common = False |
David Riley | e0684ad | 2017-04-05 00:02:59 -0700 | [diff] [blame] | 33 | event_log = EventLog() |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 34 | manifest = None |
| 35 | _optparse = None |
| 36 | |
Mark E. Hamilton | 8ccfa74 | 2016-02-10 10:44:30 -0700 | [diff] [blame] | 37 | def WantPager(self, _opt): |
Shawn O. Pearce | db45da1 | 2009-04-18 13:49:13 -0700 | [diff] [blame] | 38 | return False |
| 39 | |
David Pursehouse | b148ac9 | 2012-11-16 09:33:39 +0900 | [diff] [blame] | 40 | def ReadEnvironmentOptions(self, opts): |
| 41 | """ Set options from environment variables. """ |
| 42 | |
| 43 | env_options = self._RegisteredEnvironmentOptions() |
| 44 | |
| 45 | for env_key, opt_key in env_options.items(): |
| 46 | # Get the user-set option value if any |
| 47 | opt_value = getattr(opts, opt_key) |
| 48 | |
| 49 | # If the value is set, it means the user has passed it as a command |
| 50 | # line option, and we should use that. Otherwise we can try to set it |
| 51 | # with the value from the corresponding environment variable. |
| 52 | if opt_value is not None: |
| 53 | continue |
| 54 | |
| 55 | env_value = os.environ.get(env_key) |
| 56 | if env_value is not None: |
| 57 | setattr(opts, opt_key, env_value) |
| 58 | |
| 59 | return opts |
| 60 | |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 61 | @property |
| 62 | def OptionParser(self): |
| 63 | if self._optparse is None: |
| 64 | try: |
| 65 | me = 'repo %s' % self.NAME |
| 66 | usage = self.helpUsage.strip().replace('%prog', me) |
| 67 | except AttributeError: |
| 68 | usage = 'repo %s' % self.NAME |
Mike Frysinger | 72ebf19 | 2020-02-19 01:20:18 -0500 | [diff] [blame^] | 69 | epilog = 'Run `repo help %s` to view the detailed manual.' % self.NAME |
| 70 | self._optparse = optparse.OptionParser(usage=usage, epilog=epilog) |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 71 | self._Options(self._optparse) |
| 72 | return self._optparse |
| 73 | |
| 74 | def _Options(self, p): |
| 75 | """Initialize the option parser. |
| 76 | """ |
| 77 | |
David Pursehouse | b148ac9 | 2012-11-16 09:33:39 +0900 | [diff] [blame] | 78 | def _RegisteredEnvironmentOptions(self): |
| 79 | """Get options that can be set from environment variables. |
| 80 | |
| 81 | Return a dictionary mapping environment variable name |
| 82 | to option key name that it can override. |
| 83 | |
| 84 | Example: {'REPO_MY_OPTION': 'my_option'} |
| 85 | |
| 86 | Will allow the option with key value 'my_option' to be set |
| 87 | from the value in the environment variable named 'REPO_MY_OPTION'. |
| 88 | |
| 89 | Note: This does not work properly for options that are explicitly |
| 90 | set to None by the user, or options that are defined with a |
| 91 | default value other than None. |
| 92 | |
| 93 | """ |
| 94 | return {} |
| 95 | |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 96 | def Usage(self): |
| 97 | """Display usage and terminate. |
| 98 | """ |
| 99 | self.OptionParser.print_usage() |
| 100 | sys.exit(1) |
| 101 | |
Mike Frysinger | ae6cb08 | 2019-08-27 01:10:59 -0400 | [diff] [blame] | 102 | def ValidateOptions(self, opt, args): |
| 103 | """Validate the user options & arguments before executing. |
| 104 | |
| 105 | This is meant to help break the code up into logical steps. Some tips: |
| 106 | * Use self.OptionParser.error to display CLI related errors. |
| 107 | * Adjust opt member defaults as makes sense. |
| 108 | * Adjust the args list, but do so inplace so the caller sees updates. |
| 109 | * Try to avoid updating self state. Leave that to Execute. |
| 110 | """ |
| 111 | |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 112 | def Execute(self, opt, args): |
| 113 | """Perform the action, after option parsing is complete. |
| 114 | """ |
| 115 | raise NotImplementedError |
Conley Owens | 971de8e | 2012-04-16 10:36:08 -0700 | [diff] [blame] | 116 | |
Che-Liang Chiou | b2bd91c | 2012-01-11 11:28:42 +0800 | [diff] [blame] | 117 | def _ResetPathToProjectMap(self, projects): |
| 118 | self._by_path = dict((p.worktree, p) for p in projects) |
| 119 | |
| 120 | def _UpdatePathToProjectMap(self, project): |
| 121 | self._by_path[project.worktree] = project |
| 122 | |
Simran Basi | b9a1b73 | 2015-08-20 12:19:28 -0700 | [diff] [blame] | 123 | def _GetProjectByPath(self, manifest, path): |
Che-Liang Chiou | b2bd91c | 2012-01-11 11:28:42 +0800 | [diff] [blame] | 124 | project = None |
| 125 | if os.path.exists(path): |
| 126 | oldpath = None |
David Pursehouse | 5a2517f | 2020-02-12 14:55:01 +0900 | [diff] [blame] | 127 | while (path and |
| 128 | path != oldpath and |
| 129 | path != manifest.topdir): |
Che-Liang Chiou | b2bd91c | 2012-01-11 11:28:42 +0800 | [diff] [blame] | 130 | try: |
| 131 | project = self._by_path[path] |
| 132 | break |
| 133 | except KeyError: |
| 134 | oldpath = path |
| 135 | path = os.path.dirname(path) |
Mark E. Hamilton | f9fe3e1 | 2016-02-23 18:10:42 -0700 | [diff] [blame] | 136 | if not project and path == manifest.topdir: |
| 137 | try: |
| 138 | project = self._by_path[path] |
| 139 | except KeyError: |
| 140 | pass |
Che-Liang Chiou | b2bd91c | 2012-01-11 11:28:42 +0800 | [diff] [blame] | 141 | else: |
| 142 | try: |
| 143 | project = self._by_path[path] |
| 144 | except KeyError: |
| 145 | pass |
| 146 | return project |
| 147 | |
Simran Basi | b9a1b73 | 2015-08-20 12:19:28 -0700 | [diff] [blame] | 148 | def GetProjects(self, args, manifest=None, groups='', missing_ok=False, |
| 149 | submodules_ok=False): |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 150 | """A list of projects that match the arguments. |
| 151 | """ |
Simran Basi | b9a1b73 | 2015-08-20 12:19:28 -0700 | [diff] [blame] | 152 | if not manifest: |
| 153 | manifest = self.manifest |
| 154 | all_projects_list = manifest.projects |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 155 | result = [] |
| 156 | |
Simran Basi | b9a1b73 | 2015-08-20 12:19:28 -0700 | [diff] [blame] | 157 | mp = manifest.manifestProject |
Colin Cross | 5acde75 | 2012-03-28 20:15:45 -0700 | [diff] [blame] | 158 | |
Graham Christensen | 0369a06 | 2015-07-29 17:02:54 -0500 | [diff] [blame] | 159 | if not groups: |
Mark E. Hamilton | 8ccfa74 | 2016-02-10 10:44:30 -0700 | [diff] [blame] | 160 | groups = mp.config.GetString('manifest.groups') |
Colin Cross | c39864f | 2012-04-23 13:41:58 -0700 | [diff] [blame] | 161 | if not groups: |
David Holmer | 0a1c6a1 | 2012-11-14 19:19:00 -0500 | [diff] [blame] | 162 | groups = 'default,platform-' + platform.system().lower() |
David Pursehouse | 1d947b3 | 2012-10-25 12:23:11 +0900 | [diff] [blame] | 163 | groups = [x for x in re.split(r'[,\s]+', groups) if x] |
Colin Cross | 5acde75 | 2012-03-28 20:15:45 -0700 | [diff] [blame] | 164 | |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 165 | if not args: |
Che-Liang Chiou | b2bd91c | 2012-01-11 11:28:42 +0800 | [diff] [blame] | 166 | derived_projects = {} |
| 167 | for project in all_projects_list: |
| 168 | if submodules_ok or project.sync_s: |
| 169 | derived_projects.update((p.name, p) |
| 170 | for p in project.GetDerivedSubprojects()) |
| 171 | all_projects_list.extend(derived_projects.values()) |
| 172 | for project in all_projects_list: |
Mark E. Hamilton | 8ccfa74 | 2016-02-10 10:44:30 -0700 | [diff] [blame] | 173 | if (missing_ok or project.Exists) and project.MatchesGroups(groups): |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 174 | result.append(project) |
| 175 | else: |
David James | 8d20116 | 2013-10-11 17:03:19 -0700 | [diff] [blame] | 176 | self._ResetPathToProjectMap(all_projects_list) |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 177 | |
| 178 | for arg in args: |
Mike Frysinger | e778e57 | 2019-10-04 14:21:41 -0400 | [diff] [blame] | 179 | # We have to filter by manifest groups in case the requested project is |
| 180 | # checked out multiple times or differently based on them. |
| 181 | projects = [project for project in manifest.GetProjectsWithName(arg) |
| 182 | if project.MatchesGroups(groups)] |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 183 | |
David James | 8d20116 | 2013-10-11 17:03:19 -0700 | [diff] [blame] | 184 | if not projects: |
Anthony Newnam | df14a70 | 2011-01-09 17:31:57 -0800 | [diff] [blame] | 185 | path = os.path.abspath(arg).replace('\\', '/') |
Simran Basi | b9a1b73 | 2015-08-20 12:19:28 -0700 | [diff] [blame] | 186 | project = self._GetProjectByPath(manifest, path) |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 187 | |
Che-Liang Chiou | b2bd91c | 2012-01-11 11:28:42 +0800 | [diff] [blame] | 188 | # If it's not a derived project, update path->project mapping and |
| 189 | # search again, as arg might actually point to a derived subproject. |
Mark E. Hamilton | 8ccfa74 | 2016-02-10 10:44:30 -0700 | [diff] [blame] | 190 | if (project and not project.Derived and (submodules_ok or |
| 191 | project.sync_s)): |
Che-Liang Chiou | b2bd91c | 2012-01-11 11:28:42 +0800 | [diff] [blame] | 192 | search_again = False |
| 193 | for subproject in project.GetDerivedSubprojects(): |
| 194 | self._UpdatePathToProjectMap(subproject) |
| 195 | search_again = True |
| 196 | if search_again: |
Simran Basi | b9a1b73 | 2015-08-20 12:19:28 -0700 | [diff] [blame] | 197 | project = self._GetProjectByPath(manifest, path) or project |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 198 | |
David James | 8d20116 | 2013-10-11 17:03:19 -0700 | [diff] [blame] | 199 | if project: |
| 200 | projects = [project] |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 201 | |
David James | 8d20116 | 2013-10-11 17:03:19 -0700 | [diff] [blame] | 202 | if not projects: |
| 203 | raise NoSuchProjectError(arg) |
| 204 | |
| 205 | for project in projects: |
| 206 | if not missing_ok and not project.Exists: |
Mike Frysinger | e778e57 | 2019-10-04 14:21:41 -0400 | [diff] [blame] | 207 | raise NoSuchProjectError('%s (%s)' % (arg, project.relpath)) |
David James | 8d20116 | 2013-10-11 17:03:19 -0700 | [diff] [blame] | 208 | if not project.MatchesGroups(groups): |
| 209 | raise InvalidProjectGroupsError(arg) |
| 210 | |
| 211 | result.extend(projects) |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 212 | |
| 213 | def _getpath(x): |
| 214 | return x.relpath |
| 215 | result.sort(key=_getpath) |
| 216 | return result |
| 217 | |
Takeshi Kanemoto | 1f05644 | 2016-01-26 14:11:35 +0900 | [diff] [blame] | 218 | def FindProjects(self, args, inverse=False): |
Zhiguang Li | a8864fb | 2013-03-15 10:32:10 +0800 | [diff] [blame] | 219 | result = [] |
David Pursehouse | 84c4d3c | 2013-04-30 10:57:37 +0900 | [diff] [blame] | 220 | patterns = [re.compile(r'%s' % a, re.IGNORECASE) for a in args] |
Zhiguang Li | a8864fb | 2013-03-15 10:32:10 +0800 | [diff] [blame] | 221 | for project in self.GetProjects(''): |
David Pursehouse | 84c4d3c | 2013-04-30 10:57:37 +0900 | [diff] [blame] | 222 | for pattern in patterns: |
Takeshi Kanemoto | 1f05644 | 2016-01-26 14:11:35 +0900 | [diff] [blame] | 223 | match = pattern.search(project.name) or pattern.search(project.relpath) |
| 224 | if not inverse and match: |
Zhiguang Li | a8864fb | 2013-03-15 10:32:10 +0800 | [diff] [blame] | 225 | result.append(project) |
| 226 | break |
Takeshi Kanemoto | 1f05644 | 2016-01-26 14:11:35 +0900 | [diff] [blame] | 227 | if inverse and match: |
| 228 | break |
| 229 | else: |
| 230 | if inverse: |
| 231 | result.append(project) |
Zhiguang Li | a8864fb | 2013-03-15 10:32:10 +0800 | [diff] [blame] | 232 | result.sort(key=lambda project: project.relpath) |
| 233 | return result |
| 234 | |
Mark E. Hamilton | 8ccfa74 | 2016-02-10 10:44:30 -0700 | [diff] [blame] | 235 | |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 236 | class InteractiveCommand(Command): |
| 237 | """Command which requires user interaction on the tty and |
| 238 | must not run within a pager, even if the user asks to. |
| 239 | """ |
David Pursehouse | 819827a | 2020-02-12 15:20:19 +0900 | [diff] [blame] | 240 | |
Mark E. Hamilton | 8ccfa74 | 2016-02-10 10:44:30 -0700 | [diff] [blame] | 241 | def WantPager(self, _opt): |
Shawn O. Pearce | db45da1 | 2009-04-18 13:49:13 -0700 | [diff] [blame] | 242 | return False |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 243 | |
Mark E. Hamilton | 8ccfa74 | 2016-02-10 10:44:30 -0700 | [diff] [blame] | 244 | |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 245 | class PagedCommand(Command): |
| 246 | """Command which defaults to output in a pager, as its |
| 247 | display tends to be larger than one screen full. |
| 248 | """ |
David Pursehouse | 819827a | 2020-02-12 15:20:19 +0900 | [diff] [blame] | 249 | |
Mark E. Hamilton | 8ccfa74 | 2016-02-10 10:44:30 -0700 | [diff] [blame] | 250 | def WantPager(self, _opt): |
Shawn O. Pearce | db45da1 | 2009-04-18 13:49:13 -0700 | [diff] [blame] | 251 | return True |
Shawn O. Pearce | c95583b | 2009-03-03 17:47:06 -0800 | [diff] [blame] | 252 | |
Mark E. Hamilton | 8ccfa74 | 2016-02-10 10:44:30 -0700 | [diff] [blame] | 253 | |
Shawn O. Pearce | c95583b | 2009-03-03 17:47:06 -0800 | [diff] [blame] | 254 | class MirrorSafeCommand(object): |
| 255 | """Command permits itself to run within a mirror, |
| 256 | and does not require a working directory. |
| 257 | """ |
Dan Willemsen | 9ff2ece | 2015-08-31 15:45:06 -0700 | [diff] [blame] | 258 | |
Mark E. Hamilton | 8ccfa74 | 2016-02-10 10:44:30 -0700 | [diff] [blame] | 259 | |
Dan Willemsen | 7936064 | 2015-08-31 15:45:06 -0700 | [diff] [blame] | 260 | class GitcAvailableCommand(object): |
Dan Willemsen | 9ff2ece | 2015-08-31 15:45:06 -0700 | [diff] [blame] | 261 | """Command that requires GITC to be available, but does |
| 262 | not require the local client to be a GITC client. |
| 263 | """ |
Dan Willemsen | 7936064 | 2015-08-31 15:45:06 -0700 | [diff] [blame] | 264 | |
Mark E. Hamilton | 8ccfa74 | 2016-02-10 10:44:30 -0700 | [diff] [blame] | 265 | |
Dan Willemsen | 7936064 | 2015-08-31 15:45:06 -0700 | [diff] [blame] | 266 | class GitcClientCommand(object): |
| 267 | """Command that requires the local client to be a GITC |
| 268 | client. |
| 269 | """ |