blob: 439885200cc61d70739d4090e48187118578bbeb [file] [log] [blame]
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -07001#
2# Copyright (C) 2008 The Android Open Source Project
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15
16import os
17import optparse
Conley Owensd21720d2012-04-16 11:02:21 -070018import platform
Colin Cross5acde752012-03-28 20:15:45 -070019import re
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070020import sys
21
22from error import NoSuchProjectError
Colin Cross5acde752012-03-28 20:15:45 -070023from error import InvalidProjectGroupsError
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070024
David Pursehouseb148ac92012-11-16 09:33:39 +090025
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070026class Command(object):
27 """Base class for any command line action in repo.
28 """
29
30 common = False
31 manifest = None
32 _optparse = None
33
Shawn O. Pearcedb45da12009-04-18 13:49:13 -070034 def WantPager(self, opt):
35 return False
36
David Pursehouseb148ac92012-11-16 09:33:39 +090037 def ReadEnvironmentOptions(self, opts):
38 """ Set options from environment variables. """
39
40 env_options = self._RegisteredEnvironmentOptions()
41
42 for env_key, opt_key in env_options.items():
43 # Get the user-set option value if any
44 opt_value = getattr(opts, opt_key)
45
46 # If the value is set, it means the user has passed it as a command
47 # line option, and we should use that. Otherwise we can try to set it
48 # with the value from the corresponding environment variable.
49 if opt_value is not None:
50 continue
51
52 env_value = os.environ.get(env_key)
53 if env_value is not None:
54 setattr(opts, opt_key, env_value)
55
56 return opts
57
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070058 @property
59 def OptionParser(self):
60 if self._optparse is None:
61 try:
62 me = 'repo %s' % self.NAME
63 usage = self.helpUsage.strip().replace('%prog', me)
64 except AttributeError:
65 usage = 'repo %s' % self.NAME
66 self._optparse = optparse.OptionParser(usage = usage)
67 self._Options(self._optparse)
68 return self._optparse
69
70 def _Options(self, p):
71 """Initialize the option parser.
72 """
73
David Pursehouseb148ac92012-11-16 09:33:39 +090074 def _RegisteredEnvironmentOptions(self):
75 """Get options that can be set from environment variables.
76
77 Return a dictionary mapping environment variable name
78 to option key name that it can override.
79
80 Example: {'REPO_MY_OPTION': 'my_option'}
81
82 Will allow the option with key value 'my_option' to be set
83 from the value in the environment variable named 'REPO_MY_OPTION'.
84
85 Note: This does not work properly for options that are explicitly
86 set to None by the user, or options that are defined with a
87 default value other than None.
88
89 """
90 return {}
91
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070092 def Usage(self):
93 """Display usage and terminate.
94 """
95 self.OptionParser.print_usage()
96 sys.exit(1)
97
98 def Execute(self, opt, args):
99 """Perform the action, after option parsing is complete.
100 """
101 raise NotImplementedError
Conley Owens971de8e2012-04-16 10:36:08 -0700102
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800103 def _ResetPathToProjectMap(self, projects):
104 self._by_path = dict((p.worktree, p) for p in projects)
105
106 def _UpdatePathToProjectMap(self, project):
107 self._by_path[project.worktree] = project
108
109 def _GetProjectByPath(self, path):
110 project = None
111 if os.path.exists(path):
112 oldpath = None
113 while path \
114 and path != oldpath \
115 and path != self.manifest.topdir:
116 try:
117 project = self._by_path[path]
118 break
119 except KeyError:
120 oldpath = path
121 path = os.path.dirname(path)
122 else:
123 try:
124 project = self._by_path[path]
125 except KeyError:
126 pass
127 return project
128
129 def GetProjects(self, args, missing_ok=False, submodules_ok=False):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700130 """A list of projects that match the arguments.
131 """
David Pursehouse8a68ff92012-09-24 12:15:13 +0900132 all_projects = self.manifest.projects
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700133 result = []
134
Colin Cross5acde752012-03-28 20:15:45 -0700135 mp = self.manifest.manifestProject
136
137 groups = mp.config.GetString('manifest.groups')
Colin Crossc39864f2012-04-23 13:41:58 -0700138 if not groups:
David Holmer0a1c6a12012-11-14 19:19:00 -0500139 groups = 'default,platform-' + platform.system().lower()
David Pursehouse1d947b32012-10-25 12:23:11 +0900140 groups = [x for x in re.split(r'[,\s]+', groups) if x]
Colin Cross5acde752012-03-28 20:15:45 -0700141
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700142 if not args:
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800143 all_projects_list = all_projects.values()
144 derived_projects = {}
145 for project in all_projects_list:
146 if submodules_ok or project.sync_s:
147 derived_projects.update((p.name, p)
148 for p in project.GetDerivedSubprojects())
149 all_projects_list.extend(derived_projects.values())
150 for project in all_projects_list:
Colin Cross5acde752012-03-28 20:15:45 -0700151 if ((missing_ok or project.Exists) and
152 project.MatchesGroups(groups)):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700153 result.append(project)
154 else:
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800155 self._ResetPathToProjectMap(all_projects.values())
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700156
157 for arg in args:
David Pursehouse8a68ff92012-09-24 12:15:13 +0900158 project = all_projects.get(arg)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700159
160 if not project:
Anthony Newnamdf14a702011-01-09 17:31:57 -0800161 path = os.path.abspath(arg).replace('\\', '/')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800162 project = self._GetProjectByPath(path)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700163
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800164 # If it's not a derived project, update path->project mapping and
165 # search again, as arg might actually point to a derived subproject.
166 if (project and not project.Derived and
167 (submodules_ok or project.sync_s)):
168 search_again = False
169 for subproject in project.GetDerivedSubprojects():
170 self._UpdatePathToProjectMap(subproject)
171 search_again = True
172 if search_again:
173 project = self._GetProjectByPath(path) or project
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700174
175 if not project:
176 raise NoSuchProjectError(arg)
177 if not missing_ok and not project.Exists:
178 raise NoSuchProjectError(arg)
Colin Cross5acde752012-03-28 20:15:45 -0700179 if not project.MatchesGroups(groups):
180 raise InvalidProjectGroupsError(arg)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700181
182 result.append(project)
183
184 def _getpath(x):
185 return x.relpath
186 result.sort(key=_getpath)
187 return result
188
David Pursehouse4f7bdea2012-10-22 12:50:15 +0900189# pylint: disable=W0223
David Pursehouse5c6eeac2012-10-11 16:44:48 +0900190# Pylint warns that the `InteractiveCommand` and `PagedCommand` classes do not
191# override method `Execute` which is abstract in `Command`. Since that method
192# is always implemented in classes derived from `InteractiveCommand` and
193# `PagedCommand`, this warning can be suppressed.
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700194class InteractiveCommand(Command):
195 """Command which requires user interaction on the tty and
196 must not run within a pager, even if the user asks to.
197 """
Shawn O. Pearcedb45da12009-04-18 13:49:13 -0700198 def WantPager(self, opt):
199 return False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700200
201class PagedCommand(Command):
202 """Command which defaults to output in a pager, as its
203 display tends to be larger than one screen full.
204 """
Shawn O. Pearcedb45da12009-04-18 13:49:13 -0700205 def WantPager(self, opt):
206 return True
Shawn O. Pearcec95583b2009-03-03 17:47:06 -0800207
David Pursehouse4f7bdea2012-10-22 12:50:15 +0900208# pylint: enable=W0223
David Pursehouse5c6eeac2012-10-11 16:44:48 +0900209
Shawn O. Pearcec95583b2009-03-03 17:47:06 -0800210class MirrorSafeCommand(object):
211 """Command permits itself to run within a mirror,
212 and does not require a working directory.
213 """