blob: b6f75477db160ffa8225f1672cf70080b859be70 [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
Sarah Owenscecd1d82012-11-01 22:59:27 -070016from __future__ import print_function
Colin Cross23acdd32012-04-21 00:33:54 -070017import itertools
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070018import os
Conley Owensdb728cd2011-09-26 16:34:01 -070019import re
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070020import sys
David Pursehouse59bbb582013-05-17 10:49:33 +090021import xml.dom.minidom
22
23from pyversion import is_python3
24if is_python3():
Chirayu Desai217ea7d2013-03-01 19:14:38 +053025 import urllib.parse
David Pursehouse59bbb582013-05-17 10:49:33 +090026else:
Chirayu Desai217ea7d2013-03-01 19:14:38 +053027 import imp
28 import urlparse
29 urllib = imp.new_module('urllib')
David Pursehousecd51f172013-06-06 19:06:16 +090030 urllib.parse = urlparse.urlparse
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070031
David Pursehousee15c65a2012-08-22 10:46:11 +090032from git_config import GitConfig
David Pursehousee00aa6b2012-09-11 14:33:51 +090033from git_refs import R_HEADS, HEAD
34from project import RemoteSpec, Project, MetaProject
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070035from error import ManifestParseError
36
37MANIFEST_FILE_NAME = 'manifest.xml'
Shawn O. Pearce5cc66792008-10-23 16:19:27 -070038LOCAL_MANIFEST_NAME = 'local_manifest.xml'
David Pursehouse2d5a0df2012-11-13 02:50:36 +090039LOCAL_MANIFESTS_DIR_NAME = 'local_manifests'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070040
Chirayu Desai217ea7d2013-03-01 19:14:38 +053041urllib.parse.uses_relative.extend(['ssh', 'git'])
42urllib.parse.uses_netloc.extend(['ssh', 'git'])
Conley Owensdb728cd2011-09-26 16:34:01 -070043
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070044class _Default(object):
45 """Project defaults within the manifest."""
46
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -070047 revisionExpr = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070048 remote = None
Shawn O. Pearce6392c872011-09-22 17:44:31 -070049 sync_j = 1
Anatol Pomazau79770d22012-04-20 14:41:59 -070050 sync_c = False
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +080051 sync_s = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070052
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070053class _XmlRemote(object):
54 def __init__(self,
55 name,
Yestin Sunb292b982012-07-02 07:32:50 -070056 alias=None,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070057 fetch=None,
Conley Owensdb728cd2011-09-26 16:34:01 -070058 manifestUrl=None,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070059 review=None):
60 self.name = name
61 self.fetchUrl = fetch
Conley Owensdb728cd2011-09-26 16:34:01 -070062 self.manifestUrl = manifestUrl
Yestin Sunb292b982012-07-02 07:32:50 -070063 self.remoteAlias = alias
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070064 self.reviewUrl = review
Conley Owensceea3682011-10-20 10:45:47 -070065 self.resolvedFetchUrl = self._resolveFetchUrl()
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070066
David Pursehouse717ece92012-11-13 08:49:16 +090067 def __eq__(self, other):
68 return self.__dict__ == other.__dict__
69
70 def __ne__(self, other):
71 return self.__dict__ != other.__dict__
72
Conley Owensceea3682011-10-20 10:45:47 -070073 def _resolveFetchUrl(self):
74 url = self.fetchUrl.rstrip('/')
Conley Owensdb728cd2011-09-26 16:34:01 -070075 manifestUrl = self.manifestUrl.rstrip('/')
Shawn Pearcea9f11b32013-01-02 15:40:48 -080076 p = manifestUrl.startswith('persistent-http')
77 if p:
78 manifestUrl = manifestUrl[len('persistent-'):]
79
Conley Owensdb728cd2011-09-26 16:34:01 -070080 # urljoin will get confused if there is no scheme in the base url
81 # ie, if manifestUrl is of the form <hostname:port>
82 if manifestUrl.find(':') != manifestUrl.find('/') - 1:
David Pursehousec1b86a22012-11-14 11:36:51 +090083 manifestUrl = 'gopher://' + manifestUrl
Chirayu Desai217ea7d2013-03-01 19:14:38 +053084 url = urllib.parse.urljoin(manifestUrl, url)
Shawn Pearcea9f11b32013-01-02 15:40:48 -080085 url = re.sub(r'^gopher://', '', url)
86 if p:
87 url = 'persistent-' + url
88 return url
Conley Owensceea3682011-10-20 10:45:47 -070089
90 def ToRemoteSpec(self, projectName):
Conley Owens9d8f9142011-10-20 14:36:35 -070091 url = self.resolvedFetchUrl.rstrip('/') + '/' + projectName
Yestin Sunb292b982012-07-02 07:32:50 -070092 remoteName = self.name
Yestin Sunb292b982012-07-02 07:32:50 -070093 return RemoteSpec(remoteName, url, self.reviewUrl)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070094
Shawn O. Pearcec8a300f2009-05-18 13:19:57 -070095class XmlManifest(object):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070096 """manages the repo configuration file"""
97
98 def __init__(self, repodir):
99 self.repodir = os.path.abspath(repodir)
100 self.topdir = os.path.dirname(self.repodir)
101 self.manifestFile = os.path.join(self.repodir, MANIFEST_FILE_NAME)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700102 self.globalConfig = GitConfig.ForUser()
David Pursehouse4eb285c2013-02-14 16:28:44 +0900103 self.localManifestWarning = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700104
105 self.repoProject = MetaProject(self, 'repo',
106 gitdir = os.path.join(repodir, 'repo/.git'),
107 worktree = os.path.join(repodir, 'repo'))
108
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700109 self.manifestProject = MetaProject(self, 'manifests',
Shawn O. Pearcef5c25a62008-11-04 08:11:53 -0800110 gitdir = os.path.join(repodir, 'manifests.git'),
111 worktree = os.path.join(repodir, 'manifests'))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700112
113 self._Unload()
114
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700115 def Override(self, name):
116 """Use a different manifest, just for the current instantiation.
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700117 """
118 path = os.path.join(self.manifestProject.worktree, name)
119 if not os.path.isfile(path):
120 raise ManifestParseError('manifest %s not found' % name)
121
122 old = self.manifestFile
123 try:
124 self.manifestFile = path
125 self._Unload()
126 self._Load()
127 finally:
128 self.manifestFile = old
129
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700130 def Link(self, name):
131 """Update the repo metadata to use a different manifest.
132 """
133 self.Override(name)
134
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700135 try:
Sebastian Frias223bf962012-11-21 19:09:25 +0100136 if os.path.lexists(self.manifestFile):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700137 os.remove(self.manifestFile)
138 os.symlink('manifests/%s' % name, self.manifestFile)
Sebastian Frias223bf962012-11-21 19:09:25 +0100139 except OSError as e:
140 raise ManifestParseError('cannot link manifest %s: %s' % (name, str(e)))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700141
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800142 def _RemoteToXml(self, r, doc, root):
143 e = doc.createElement('remote')
144 root.appendChild(e)
145 e.setAttribute('name', r.name)
146 e.setAttribute('fetch', r.fetchUrl)
147 if r.reviewUrl is not None:
148 e.setAttribute('review', r.reviewUrl)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800149
Brian Harring14a66742012-09-28 20:21:57 -0700150 def Save(self, fd, peg_rev=False, peg_rev_upstream=True):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800151 """Write the current manifest out to the given file descriptor.
152 """
Colin Cross5acde752012-03-28 20:15:45 -0700153 mp = self.manifestProject
154
155 groups = mp.config.GetString('manifest.groups')
Matt Gumbel0c635bb2012-12-21 10:14:53 -0800156 if groups:
157 groups = [x for x in re.split(r'[,\s]+', groups) if x]
Colin Cross5acde752012-03-28 20:15:45 -0700158
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800159 doc = xml.dom.minidom.Document()
160 root = doc.createElement('manifest')
161 doc.appendChild(root)
162
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700163 # Save out the notice. There's a little bit of work here to give it the
164 # right whitespace, which assumes that the notice is automatically indented
165 # by 4 by minidom.
166 if self.notice:
167 notice_element = root.appendChild(doc.createElement('notice'))
168 notice_lines = self.notice.splitlines()
169 indented_notice = ('\n'.join(" "*4 + line for line in notice_lines))[4:]
170 notice_element.appendChild(doc.createTextNode(indented_notice))
171
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800172 d = self.default
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800173
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530174 for r in sorted(self.remotes):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800175 self._RemoteToXml(self.remotes[r], doc, root)
176 if self.remotes:
177 root.appendChild(doc.createTextNode(''))
178
179 have_default = False
180 e = doc.createElement('default')
181 if d.remote:
182 have_default = True
183 e.setAttribute('remote', d.remote.name)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700184 if d.revisionExpr:
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800185 have_default = True
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700186 e.setAttribute('revision', d.revisionExpr)
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700187 if d.sync_j > 1:
188 have_default = True
189 e.setAttribute('sync-j', '%d' % d.sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700190 if d.sync_c:
191 have_default = True
192 e.setAttribute('sync-c', 'true')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800193 if d.sync_s:
194 have_default = True
195 e.setAttribute('sync-s', 'true')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800196 if have_default:
197 root.appendChild(e)
198 root.appendChild(doc.createTextNode(''))
199
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700200 if self._manifest_server:
201 e = doc.createElement('manifest-server')
202 e.setAttribute('url', self._manifest_server)
203 root.appendChild(e)
204 root.appendChild(doc.createTextNode(''))
205
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800206 def output_projects(parent, parent_node, projects):
207 for p in projects:
208 output_project(parent, parent_node, self.projects[p])
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800209
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800210 def output_project(parent, parent_node, p):
Colin Cross5acde752012-03-28 20:15:45 -0700211 if not p.MatchesGroups(groups):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800212 return
213
214 name = p.name
215 relpath = p.relpath
216 if parent:
217 name = self._UnjoinName(parent.name, name)
218 relpath = self._UnjoinRelpath(parent.relpath, relpath)
Colin Cross5acde752012-03-28 20:15:45 -0700219
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800220 e = doc.createElement('project')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800221 parent_node.appendChild(e)
222 e.setAttribute('name', name)
223 if relpath != name:
224 e.setAttribute('path', relpath)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800225 if not d.remote or p.remote.name != d.remote.name:
226 e.setAttribute('remote', p.remote.name)
227 if peg_rev:
228 if self.IsMirror:
Brian Harring14a66742012-09-28 20:21:57 -0700229 value = p.bare_git.rev_parse(p.revisionExpr + '^0')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800230 else:
Brian Harring14a66742012-09-28 20:21:57 -0700231 value = p.work_git.rev_parse(HEAD + '^0')
232 e.setAttribute('revision', value)
233 if peg_rev_upstream and value != p.revisionExpr:
234 # Only save the origin if the origin is not a sha1, and the default
235 # isn't our value, and the if the default doesn't already have that
236 # covered.
237 e.setAttribute('upstream', p.revisionExpr)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700238 elif not d.revisionExpr or p.revisionExpr != d.revisionExpr:
239 e.setAttribute('revision', p.revisionExpr)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800240
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800241 for c in p.copyfiles:
242 ce = doc.createElement('copyfile')
243 ce.setAttribute('src', c.src)
244 ce.setAttribute('dest', c.dest)
245 e.appendChild(ce)
246
Conley Owensbb1b5f52012-08-13 13:11:18 -0700247 default_groups = ['all', 'name:%s' % p.name, 'path:%s' % p.relpath]
Dmitry Fink17f85ea2012-08-06 14:52:29 -0700248 egroups = [g for g in p.groups if g not in default_groups]
Conley Owens971de8e2012-04-16 10:36:08 -0700249 if egroups:
250 e.setAttribute('groups', ','.join(egroups))
Colin Cross5acde752012-03-28 20:15:45 -0700251
James W. Mills24c13082012-04-12 15:04:13 -0500252 for a in p.annotations:
253 if a.keep == "true":
254 ae = doc.createElement('annotation')
255 ae.setAttribute('name', a.name)
256 ae.setAttribute('value', a.value)
257 e.appendChild(ae)
258
Anatol Pomazau79770d22012-04-20 14:41:59 -0700259 if p.sync_c:
260 e.setAttribute('sync-c', 'true')
261
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800262 if p.sync_s:
263 e.setAttribute('sync-s', 'true')
264
265 if p.subprojects:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530266 sort_projects = list(sorted([subp.name for subp in p.subprojects]))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800267 output_projects(p, e, sort_projects)
268
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530269 sort_projects = list(sorted([key for key, value in self.projects.items()
270 if not value.parent]))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800271 sort_projects.sort()
272 output_projects(None, root, sort_projects)
273
Doug Anderson37282b42011-03-04 11:54:18 -0800274 if self._repo_hooks_project:
275 root.appendChild(doc.createTextNode(''))
276 e = doc.createElement('repo-hooks')
277 e.setAttribute('in-project', self._repo_hooks_project.name)
278 e.setAttribute('enabled-list',
279 ' '.join(self._repo_hooks_project.enabled_repo_hooks))
280 root.appendChild(e)
281
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800282 doc.writexml(fd, '', ' ', '\n', 'UTF-8')
283
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700284 @property
285 def projects(self):
286 self._Load()
287 return self._projects
288
289 @property
290 def remotes(self):
291 self._Load()
292 return self._remotes
293
294 @property
295 def default(self):
296 self._Load()
297 return self._default
298
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800299 @property
Doug Anderson37282b42011-03-04 11:54:18 -0800300 def repo_hooks_project(self):
301 self._Load()
302 return self._repo_hooks_project
303
304 @property
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700305 def notice(self):
306 self._Load()
307 return self._notice
308
309 @property
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700310 def manifest_server(self):
311 self._Load()
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -0800312 return self._manifest_server
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700313
314 @property
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800315 def IsMirror(self):
316 return self.manifestProject.config.GetBoolean('repo.mirror')
317
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700318 def _Unload(self):
319 self._loaded = False
320 self._projects = {}
321 self._remotes = {}
322 self._default = None
Doug Anderson37282b42011-03-04 11:54:18 -0800323 self._repo_hooks_project = None
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700324 self._notice = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700325 self.branch = None
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700326 self._manifest_server = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700327
328 def _Load(self):
329 if not self._loaded:
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800330 m = self.manifestProject
331 b = m.GetBranch(m.CurrentBranch).merge
Shawn O. Pearce21c5c342009-06-25 16:47:30 -0700332 if b is not None and b.startswith(R_HEADS):
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800333 b = b[len(R_HEADS):]
334 self.branch = b
335
Colin Cross23acdd32012-04-21 00:33:54 -0700336 nodes = []
Brian Harring475a47d2012-06-07 20:05:35 -0700337 nodes.append(self._ParseManifestXml(self.manifestFile,
338 self.manifestProject.worktree))
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700339
340 local = os.path.join(self.repodir, LOCAL_MANIFEST_NAME)
341 if os.path.exists(local):
David Pursehouse4eb285c2013-02-14 16:28:44 +0900342 if not self.localManifestWarning:
343 self.localManifestWarning = True
344 print('warning: %s is deprecated; put local manifests in `%s` instead'
345 % (LOCAL_MANIFEST_NAME, os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME)),
346 file=sys.stderr)
Brian Harring475a47d2012-06-07 20:05:35 -0700347 nodes.append(self._ParseManifestXml(local, self.repodir))
Colin Cross23acdd32012-04-21 00:33:54 -0700348
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900349 local_dir = os.path.abspath(os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME))
350 try:
David Pursehouse52f1e5d2012-11-14 04:53:24 +0900351 for local_file in sorted(os.listdir(local_dir)):
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900352 if local_file.endswith('.xml'):
David Pursehouse5f434ed2012-11-22 13:48:10 +0900353 local = os.path.join(local_dir, local_file)
354 nodes.append(self._ParseManifestXml(local, self.repodir))
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900355 except OSError:
356 pass
357
Joe Onorato26e24752013-01-11 12:35:53 -0800358 try:
359 self._ParseManifest(nodes)
360 except ManifestParseError as e:
361 # There was a problem parsing, unload ourselves in case they catch
362 # this error and try again later, we will show the correct error
363 self._Unload()
364 raise e
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700365
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800366 if self.IsMirror:
367 self._AddMetaProjectMirror(self.repoProject)
368 self._AddMetaProjectMirror(self.manifestProject)
369
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700370 self._loaded = True
371
Brian Harring475a47d2012-06-07 20:05:35 -0700372 def _ParseManifestXml(self, path, include_root):
David Pursehousef7fc8a92012-11-13 04:00:28 +0900373 try:
374 root = xml.dom.minidom.parse(path)
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900375 except (OSError, xml.parsers.expat.ExpatError) as e:
David Pursehousef7fc8a92012-11-13 04:00:28 +0900376 raise ManifestParseError("error parsing manifest %s: %s" % (path, e))
377
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700378 if not root or not root.childNodes:
Brian Harring26448742011-04-28 05:04:41 -0700379 raise ManifestParseError("no root node in %s" % (path,))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700380
Jooncheol Park34acdd22012-08-27 02:25:59 +0900381 for manifest in root.childNodes:
382 if manifest.nodeName == 'manifest':
383 break
384 else:
Brian Harring26448742011-04-28 05:04:41 -0700385 raise ManifestParseError("no <manifest> in %s" % (path,))
386
Colin Cross23acdd32012-04-21 00:33:54 -0700387 nodes = []
David Pursehouse4f7bdea2012-10-22 12:50:15 +0900388 for node in manifest.childNodes: # pylint:disable=W0631
David Pursehouse5c6eeac2012-10-11 16:44:48 +0900389 # We only get here if manifest is initialised
David Pursehousec1b86a22012-11-14 11:36:51 +0900390 if node.nodeName == 'include':
391 name = self._reqatt(node, 'name')
392 fp = os.path.join(include_root, name)
393 if not os.path.isfile(fp):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530394 raise ManifestParseError("include %s doesn't exist or isn't a file"
395 % (name,))
David Pursehousec1b86a22012-11-14 11:36:51 +0900396 try:
397 nodes.extend(self._ParseManifestXml(fp, include_root))
398 # should isolate this to the exact exception, but that's
399 # tricky. actual parsing implementation may vary.
400 except (KeyboardInterrupt, RuntimeError, SystemExit):
401 raise
402 except Exception as e:
403 raise ManifestParseError(
404 "failed parsing included manifest %s: %s", (name, e))
405 else:
406 nodes.append(node)
Colin Cross23acdd32012-04-21 00:33:54 -0700407 return nodes
Brian Harring26448742011-04-28 05:04:41 -0700408
Colin Cross23acdd32012-04-21 00:33:54 -0700409 def _ParseManifest(self, node_list):
410 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700411 if node.nodeName == 'remote':
412 remote = self._ParseRemote(node)
David Pursehouse717ece92012-11-13 08:49:16 +0900413 if remote:
414 if remote.name in self._remotes:
415 if remote != self._remotes[remote.name]:
416 raise ManifestParseError(
417 'remote %s already exists with different attributes' %
418 (remote.name))
419 else:
420 self._remotes[remote.name] = remote
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700421
Colin Cross23acdd32012-04-21 00:33:54 -0700422 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700423 if node.nodeName == 'default':
424 if self._default is not None:
Doug Anderson37282b42011-03-04 11:54:18 -0800425 raise ManifestParseError(
426 'duplicate default in %s' %
427 (self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700428 self._default = self._ParseDefault(node)
429 if self._default is None:
430 self._default = _Default()
431
Colin Cross23acdd32012-04-21 00:33:54 -0700432 for node in itertools.chain(*node_list):
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700433 if node.nodeName == 'notice':
434 if self._notice is not None:
Doug Anderson37282b42011-03-04 11:54:18 -0800435 raise ManifestParseError(
436 'duplicate notice in %s' %
437 (self.manifestFile))
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700438 self._notice = self._ParseNotice(node)
439
Colin Cross23acdd32012-04-21 00:33:54 -0700440 for node in itertools.chain(*node_list):
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700441 if node.nodeName == 'manifest-server':
442 url = self._reqatt(node, 'url')
443 if self._manifest_server is not None:
David Pursehousec1b86a22012-11-14 11:36:51 +0900444 raise ManifestParseError(
445 'duplicate manifest-server in %s' %
446 (self.manifestFile))
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700447 self._manifest_server = url
448
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800449 def recursively_add_projects(project):
450 if self._projects.get(project.name):
451 raise ManifestParseError(
452 'duplicate project %s in %s' %
453 (project.name, self.manifestFile))
454 self._projects[project.name] = project
455 for subproject in project.subprojects:
456 recursively_add_projects(subproject)
457
Colin Cross23acdd32012-04-21 00:33:54 -0700458 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700459 if node.nodeName == 'project':
460 project = self._ParseProject(node)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800461 recursively_add_projects(project)
Doug Anderson37282b42011-03-04 11:54:18 -0800462 if node.nodeName == 'repo-hooks':
463 # Get the name of the project and the (space-separated) list of enabled.
464 repo_hooks_project = self._reqatt(node, 'in-project')
465 enabled_repo_hooks = self._reqatt(node, 'enabled-list').split()
466
467 # Only one project can be the hooks project
468 if self._repo_hooks_project is not None:
469 raise ManifestParseError(
470 'duplicate repo-hooks in %s' %
471 (self.manifestFile))
472
473 # Store a reference to the Project.
474 try:
475 self._repo_hooks_project = self._projects[repo_hooks_project]
476 except KeyError:
477 raise ManifestParseError(
478 'project %s not found for repo-hooks' %
479 (repo_hooks_project))
480
481 # Store the enabled hooks in the Project object.
482 self._repo_hooks_project.enabled_repo_hooks = enabled_repo_hooks
Colin Cross23acdd32012-04-21 00:33:54 -0700483 if node.nodeName == 'remove-project':
484 name = self._reqatt(node, 'name')
485 try:
486 del self._projects[name]
487 except KeyError:
David Pursehousef9107482012-11-16 19:12:32 +0900488 raise ManifestParseError('remove-project element specifies non-existent '
489 'project: %s' % name)
Colin Cross23acdd32012-04-21 00:33:54 -0700490
491 # If the manifest removes the hooks project, treat it as if it deleted
492 # the repo-hooks element too.
493 if self._repo_hooks_project and (self._repo_hooks_project.name == name):
494 self._repo_hooks_project = None
495
Doug Anderson37282b42011-03-04 11:54:18 -0800496
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800497 def _AddMetaProjectMirror(self, m):
498 name = None
499 m_url = m.GetRemote(m.remote.name).url
500 if m_url.endswith('/.git'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530501 raise ManifestParseError('refusing to mirror %s' % m_url)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800502
503 if self._default and self._default.remote:
Conley Owensceea3682011-10-20 10:45:47 -0700504 url = self._default.remote.resolvedFetchUrl
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800505 if not url.endswith('/'):
506 url += '/'
507 if m_url.startswith(url):
508 remote = self._default.remote
509 name = m_url[len(url):]
510
511 if name is None:
512 s = m_url.rindex('/') + 1
Conley Owensdb728cd2011-09-26 16:34:01 -0700513 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Shawn O. Pearcef35b2d92012-08-02 11:46:22 -0700514 remote = _XmlRemote('origin', fetch=m_url[:s], manifestUrl=manifestUrl)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800515 name = m_url[s:]
516
517 if name.endswith('.git'):
518 name = name[:-4]
519
520 if name not in self._projects:
521 m.PreSync()
522 gitdir = os.path.join(self.topdir, '%s.git' % name)
523 project = Project(manifest = self,
524 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700525 remote = remote.ToRemoteSpec(name),
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800526 gitdir = gitdir,
527 worktree = None,
528 relpath = None,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700529 revisionExpr = m.revisionExpr,
530 revisionId = None)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800531 self._projects[project.name] = project
532
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700533 def _ParseRemote(self, node):
534 """
535 reads a <remote> element from the manifest file
536 """
537 name = self._reqatt(node, 'name')
Yestin Sunb292b982012-07-02 07:32:50 -0700538 alias = node.getAttribute('alias')
539 if alias == '':
540 alias = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700541 fetch = self._reqatt(node, 'fetch')
542 review = node.getAttribute('review')
Shawn O. Pearceae6e0942008-11-06 10:25:35 -0800543 if review == '':
544 review = None
Conley Owensdb728cd2011-09-26 16:34:01 -0700545 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Yestin Sunb292b982012-07-02 07:32:50 -0700546 return _XmlRemote(name, alias, fetch, manifestUrl, review)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700547
548 def _ParseDefault(self, node):
549 """
550 reads a <default> element from the manifest file
551 """
552 d = _Default()
553 d.remote = self._get_remote(node)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700554 d.revisionExpr = node.getAttribute('revision')
555 if d.revisionExpr == '':
556 d.revisionExpr = None
Anatol Pomazau79770d22012-04-20 14:41:59 -0700557
Bryan Jacobsf609f912013-05-06 13:36:24 -0400558 d.destBranchExpr = node.getAttribute('dest-branch') or None
559
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700560 sync_j = node.getAttribute('sync-j')
561 if sync_j == '' or sync_j is None:
562 d.sync_j = 1
563 else:
564 d.sync_j = int(sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700565
566 sync_c = node.getAttribute('sync-c')
567 if not sync_c:
568 d.sync_c = False
569 else:
570 d.sync_c = sync_c.lower() in ("yes", "true", "1")
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800571
572 sync_s = node.getAttribute('sync-s')
573 if not sync_s:
574 d.sync_s = False
575 else:
576 d.sync_s = sync_s.lower() in ("yes", "true", "1")
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700577 return d
578
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700579 def _ParseNotice(self, node):
580 """
581 reads a <notice> element from the manifest file
582
583 The <notice> element is distinct from other tags in the XML in that the
584 data is conveyed between the start and end tag (it's not an empty-element
585 tag).
586
587 The white space (carriage returns, indentation) for the notice element is
588 relevant and is parsed in a way that is based on how python docstrings work.
589 In fact, the code is remarkably similar to here:
590 http://www.python.org/dev/peps/pep-0257/
591 """
592 # Get the data out of the node...
593 notice = node.childNodes[0].data
594
595 # Figure out minimum indentation, skipping the first line (the same line
596 # as the <notice> tag)...
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530597 minIndent = sys.maxsize
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700598 lines = notice.splitlines()
599 for line in lines[1:]:
600 lstrippedLine = line.lstrip()
601 if lstrippedLine:
602 indent = len(line) - len(lstrippedLine)
603 minIndent = min(indent, minIndent)
604
605 # Strip leading / trailing blank lines and also indentation.
606 cleanLines = [lines[0].strip()]
607 for line in lines[1:]:
608 cleanLines.append(line[minIndent:].rstrip())
609
610 # Clear completely blank lines from front and back...
611 while cleanLines and not cleanLines[0]:
612 del cleanLines[0]
613 while cleanLines and not cleanLines[-1]:
614 del cleanLines[-1]
615
616 return '\n'.join(cleanLines)
617
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800618 def _JoinName(self, parent_name, name):
619 return os.path.join(parent_name, name)
620
621 def _UnjoinName(self, parent_name, name):
622 return os.path.relpath(name, parent_name)
623
624 def _ParseProject(self, node, parent = None):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700625 """
626 reads a <project> element from the manifest file
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700627 """
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700628 name = self._reqatt(node, 'name')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800629 if parent:
630 name = self._JoinName(parent.name, name)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700631
632 remote = self._get_remote(node)
633 if remote is None:
634 remote = self._default.remote
635 if remote is None:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530636 raise ManifestParseError("no remote for project %s within %s" %
637 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700638
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700639 revisionExpr = node.getAttribute('revision')
640 if not revisionExpr:
641 revisionExpr = self._default.revisionExpr
642 if not revisionExpr:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530643 raise ManifestParseError("no revision for project %s within %s" %
644 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700645
646 path = node.getAttribute('path')
647 if not path:
648 path = name
649 if path.startswith('/'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530650 raise ManifestParseError("project %s path cannot be absolute in %s" %
651 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700652
Mike Pontillod3153822012-02-28 11:53:24 -0800653 rebase = node.getAttribute('rebase')
654 if not rebase:
655 rebase = True
656 else:
657 rebase = rebase.lower() in ("yes", "true", "1")
658
Anatol Pomazau79770d22012-04-20 14:41:59 -0700659 sync_c = node.getAttribute('sync-c')
660 if not sync_c:
661 sync_c = False
662 else:
663 sync_c = sync_c.lower() in ("yes", "true", "1")
664
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800665 sync_s = node.getAttribute('sync-s')
666 if not sync_s:
667 sync_s = self._default.sync_s
668 else:
669 sync_s = sync_s.lower() in ("yes", "true", "1")
670
David Pursehouseede7f122012-11-27 22:25:30 +0900671 clone_depth = node.getAttribute('clone-depth')
672 if clone_depth:
673 try:
674 clone_depth = int(clone_depth)
675 if clone_depth <= 0:
676 raise ValueError()
677 except ValueError:
678 raise ManifestParseError('invalid clone-depth %s in %s' %
679 (clone_depth, self.manifestFile))
680
Bryan Jacobsf609f912013-05-06 13:36:24 -0400681 dest_branch = node.getAttribute('dest-branch') or self._default.destBranchExpr
682
Brian Harring14a66742012-09-28 20:21:57 -0700683 upstream = node.getAttribute('upstream')
684
Conley Owens971de8e2012-04-16 10:36:08 -0700685 groups = ''
686 if node.hasAttribute('groups'):
687 groups = node.getAttribute('groups')
David Pursehouse1d947b32012-10-25 12:23:11 +0900688 groups = [x for x in re.split(r'[,\s]+', groups) if x]
Brian Harring7da13142012-06-15 02:24:20 -0700689
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800690 if parent is None:
691 relpath, worktree, gitdir = self.GetProjectPaths(name, path)
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700692 else:
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800693 relpath, worktree, gitdir = self.GetSubprojectPaths(parent, path)
694
695 default_groups = ['all', 'name:%s' % name, 'path:%s' % relpath]
696 groups.extend(set(default_groups).difference(groups))
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700697
Scott Fandb83b1b2013-02-28 09:34:14 +0800698 if self.IsMirror and node.hasAttribute('force-path'):
699 if node.getAttribute('force-path').lower() in ("yes", "true", "1"):
700 gitdir = os.path.join(self.topdir, '%s.git' % path)
701
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700702 project = Project(manifest = self,
703 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700704 remote = remote.ToRemoteSpec(name),
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700705 gitdir = gitdir,
706 worktree = worktree,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800707 relpath = relpath,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700708 revisionExpr = revisionExpr,
Mike Pontillod3153822012-02-28 11:53:24 -0800709 revisionId = None,
Colin Cross5acde752012-03-28 20:15:45 -0700710 rebase = rebase,
Anatol Pomazau79770d22012-04-20 14:41:59 -0700711 groups = groups,
Brian Harring14a66742012-09-28 20:21:57 -0700712 sync_c = sync_c,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800713 sync_s = sync_s,
David Pursehouseede7f122012-11-27 22:25:30 +0900714 clone_depth = clone_depth,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800715 upstream = upstream,
Bryan Jacobsf609f912013-05-06 13:36:24 -0400716 parent = parent,
717 dest_branch = dest_branch)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700718
719 for n in node.childNodes:
Shawn O. Pearce242b5262009-05-19 13:00:29 -0700720 if n.nodeName == 'copyfile':
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700721 self._ParseCopyFile(project, n)
James W. Mills24c13082012-04-12 15:04:13 -0500722 if n.nodeName == 'annotation':
723 self._ParseAnnotation(project, n)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800724 if n.nodeName == 'project':
725 project.subprojects.append(self._ParseProject(n, parent = project))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700726
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700727 return project
728
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800729 def GetProjectPaths(self, name, path):
730 relpath = path
731 if self.IsMirror:
732 worktree = None
733 gitdir = os.path.join(self.topdir, '%s.git' % name)
734 else:
735 worktree = os.path.join(self.topdir, path).replace('\\', '/')
736 gitdir = os.path.join(self.repodir, 'projects', '%s.git' % path)
737 return relpath, worktree, gitdir
738
739 def GetSubprojectName(self, parent, submodule_path):
740 return os.path.join(parent.name, submodule_path)
741
742 def _JoinRelpath(self, parent_relpath, relpath):
743 return os.path.join(parent_relpath, relpath)
744
745 def _UnjoinRelpath(self, parent_relpath, relpath):
746 return os.path.relpath(relpath, parent_relpath)
747
748 def GetSubprojectPaths(self, parent, path):
749 relpath = self._JoinRelpath(parent.relpath, path)
750 gitdir = os.path.join(parent.gitdir, 'subprojects', '%s.git' % path)
751 if self.IsMirror:
752 worktree = None
753 else:
754 worktree = os.path.join(parent.worktree, path).replace('\\', '/')
755 return relpath, worktree, gitdir
756
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700757 def _ParseCopyFile(self, project, node):
758 src = self._reqatt(node, 'src')
759 dest = self._reqatt(node, 'dest')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800760 if not self.IsMirror:
761 # src is project relative;
762 # dest is relative to the top of the tree
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800763 project.AddCopyFile(src, dest, os.path.join(self.topdir, dest))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700764
James W. Mills24c13082012-04-12 15:04:13 -0500765 def _ParseAnnotation(self, project, node):
766 name = self._reqatt(node, 'name')
767 value = self._reqatt(node, 'value')
768 try:
769 keep = self._reqatt(node, 'keep').lower()
770 except ManifestParseError:
771 keep = "true"
772 if keep != "true" and keep != "false":
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530773 raise ManifestParseError('optional "keep" attribute must be '
774 '"true" or "false"')
James W. Mills24c13082012-04-12 15:04:13 -0500775 project.AddAnnotation(name, value, keep)
776
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700777 def _get_remote(self, node):
778 name = node.getAttribute('remote')
779 if not name:
780 return None
781
782 v = self._remotes.get(name)
783 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530784 raise ManifestParseError("remote %s not defined in %s" %
785 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700786 return v
787
788 def _reqatt(self, node, attname):
789 """
790 reads a required attribute from the node.
791 """
792 v = node.getAttribute(attname)
793 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530794 raise ManifestParseError("no %s in <%s> within %s" %
795 (attname, node.nodeName, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700796 return v