blob: b3ab098dc7d7c71148a1a62c4808c057df9e2489 [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')
Chirayu Desaidb2ad9d2013-06-11 13:42:25 +053030 urllib.parse = 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
Conley Owensb6a16e62013-09-25 15:06:09 -070048 destBranchExpr = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070049 remote = None
Shawn O. Pearce6392c872011-09-22 17:44:31 -070050 sync_j = 1
Anatol Pomazau79770d22012-04-20 14:41:59 -070051 sync_c = False
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +080052 sync_s = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070053
Julien Campergue74879922013-10-09 14:38:46 +020054 def __eq__(self, other):
55 return self.__dict__ == other.__dict__
56
57 def __ne__(self, other):
58 return self.__dict__ != other.__dict__
59
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070060class _XmlRemote(object):
61 def __init__(self,
62 name,
Yestin Sunb292b982012-07-02 07:32:50 -070063 alias=None,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070064 fetch=None,
Conley Owensdb728cd2011-09-26 16:34:01 -070065 manifestUrl=None,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070066 review=None):
67 self.name = name
68 self.fetchUrl = fetch
Conley Owensdb728cd2011-09-26 16:34:01 -070069 self.manifestUrl = manifestUrl
Yestin Sunb292b982012-07-02 07:32:50 -070070 self.remoteAlias = alias
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070071 self.reviewUrl = review
Conley Owensceea3682011-10-20 10:45:47 -070072 self.resolvedFetchUrl = self._resolveFetchUrl()
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070073
David Pursehouse717ece92012-11-13 08:49:16 +090074 def __eq__(self, other):
75 return self.__dict__ == other.__dict__
76
77 def __ne__(self, other):
78 return self.__dict__ != other.__dict__
79
Conley Owensceea3682011-10-20 10:45:47 -070080 def _resolveFetchUrl(self):
81 url = self.fetchUrl.rstrip('/')
Conley Owensdb728cd2011-09-26 16:34:01 -070082 manifestUrl = self.manifestUrl.rstrip('/')
Shawn Pearcea9f11b32013-01-02 15:40:48 -080083 p = manifestUrl.startswith('persistent-http')
84 if p:
85 manifestUrl = manifestUrl[len('persistent-'):]
86
Conley Owensdb728cd2011-09-26 16:34:01 -070087 # urljoin will get confused if there is no scheme in the base url
88 # ie, if manifestUrl is of the form <hostname:port>
89 if manifestUrl.find(':') != manifestUrl.find('/') - 1:
David Pursehousec1b86a22012-11-14 11:36:51 +090090 manifestUrl = 'gopher://' + manifestUrl
Chirayu Desai217ea7d2013-03-01 19:14:38 +053091 url = urllib.parse.urljoin(manifestUrl, url)
Shawn Pearcea9f11b32013-01-02 15:40:48 -080092 url = re.sub(r'^gopher://', '', url)
93 if p:
94 url = 'persistent-' + url
95 return url
Conley Owensceea3682011-10-20 10:45:47 -070096
97 def ToRemoteSpec(self, projectName):
Conley Owens9d8f9142011-10-20 14:36:35 -070098 url = self.resolvedFetchUrl.rstrip('/') + '/' + projectName
Yestin Sunb292b982012-07-02 07:32:50 -070099 remoteName = self.name
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700100 if self.remoteAlias:
David Pursehouse37128b62013-10-15 10:48:40 +0900101 remoteName = self.remoteAlias
Yestin Sunb292b982012-07-02 07:32:50 -0700102 return RemoteSpec(remoteName, url, self.reviewUrl)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700103
Shawn O. Pearcec8a300f2009-05-18 13:19:57 -0700104class XmlManifest(object):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700105 """manages the repo configuration file"""
106
107 def __init__(self, repodir):
108 self.repodir = os.path.abspath(repodir)
109 self.topdir = os.path.dirname(self.repodir)
110 self.manifestFile = os.path.join(self.repodir, MANIFEST_FILE_NAME)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700111 self.globalConfig = GitConfig.ForUser()
David Pursehouse4eb285c2013-02-14 16:28:44 +0900112 self.localManifestWarning = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700113
114 self.repoProject = MetaProject(self, 'repo',
115 gitdir = os.path.join(repodir, 'repo/.git'),
116 worktree = os.path.join(repodir, 'repo'))
117
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700118 self.manifestProject = MetaProject(self, 'manifests',
Shawn O. Pearcef5c25a62008-11-04 08:11:53 -0800119 gitdir = os.path.join(repodir, 'manifests.git'),
120 worktree = os.path.join(repodir, 'manifests'))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700121
122 self._Unload()
123
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700124 def Override(self, name):
125 """Use a different manifest, just for the current instantiation.
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700126 """
127 path = os.path.join(self.manifestProject.worktree, name)
128 if not os.path.isfile(path):
129 raise ManifestParseError('manifest %s not found' % name)
130
131 old = self.manifestFile
132 try:
133 self.manifestFile = path
134 self._Unload()
135 self._Load()
136 finally:
137 self.manifestFile = old
138
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700139 def Link(self, name):
140 """Update the repo metadata to use a different manifest.
141 """
142 self.Override(name)
143
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700144 try:
Sebastian Frias223bf962012-11-21 19:09:25 +0100145 if os.path.lexists(self.manifestFile):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700146 os.remove(self.manifestFile)
147 os.symlink('manifests/%s' % name, self.manifestFile)
Sebastian Frias223bf962012-11-21 19:09:25 +0100148 except OSError as e:
149 raise ManifestParseError('cannot link manifest %s: %s' % (name, str(e)))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700150
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800151 def _RemoteToXml(self, r, doc, root):
152 e = doc.createElement('remote')
153 root.appendChild(e)
154 e.setAttribute('name', r.name)
155 e.setAttribute('fetch', r.fetchUrl)
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700156 if r.remoteAlias is not None:
157 e.setAttribute('alias', r.remoteAlias)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800158 if r.reviewUrl is not None:
159 e.setAttribute('review', r.reviewUrl)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800160
Brian Harring14a66742012-09-28 20:21:57 -0700161 def Save(self, fd, peg_rev=False, peg_rev_upstream=True):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800162 """Write the current manifest out to the given file descriptor.
163 """
Colin Cross5acde752012-03-28 20:15:45 -0700164 mp = self.manifestProject
165
166 groups = mp.config.GetString('manifest.groups')
Matt Gumbel0c635bb2012-12-21 10:14:53 -0800167 if groups:
168 groups = [x for x in re.split(r'[,\s]+', groups) if x]
Colin Cross5acde752012-03-28 20:15:45 -0700169
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800170 doc = xml.dom.minidom.Document()
171 root = doc.createElement('manifest')
172 doc.appendChild(root)
173
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700174 # Save out the notice. There's a little bit of work here to give it the
175 # right whitespace, which assumes that the notice is automatically indented
176 # by 4 by minidom.
177 if self.notice:
178 notice_element = root.appendChild(doc.createElement('notice'))
179 notice_lines = self.notice.splitlines()
180 indented_notice = ('\n'.join(" "*4 + line for line in notice_lines))[4:]
181 notice_element.appendChild(doc.createTextNode(indented_notice))
182
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800183 d = self.default
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800184
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530185 for r in sorted(self.remotes):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800186 self._RemoteToXml(self.remotes[r], doc, root)
187 if self.remotes:
188 root.appendChild(doc.createTextNode(''))
189
190 have_default = False
191 e = doc.createElement('default')
192 if d.remote:
193 have_default = True
194 e.setAttribute('remote', d.remote.name)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700195 if d.revisionExpr:
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800196 have_default = True
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700197 e.setAttribute('revision', d.revisionExpr)
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700198 if d.sync_j > 1:
199 have_default = True
200 e.setAttribute('sync-j', '%d' % d.sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700201 if d.sync_c:
202 have_default = True
203 e.setAttribute('sync-c', 'true')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800204 if d.sync_s:
205 have_default = True
206 e.setAttribute('sync-s', 'true')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800207 if have_default:
208 root.appendChild(e)
209 root.appendChild(doc.createTextNode(''))
210
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700211 if self._manifest_server:
212 e = doc.createElement('manifest-server')
213 e.setAttribute('url', self._manifest_server)
214 root.appendChild(e)
215 root.appendChild(doc.createTextNode(''))
216
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800217 def output_projects(parent, parent_node, projects):
218 for p in projects:
219 output_project(parent, parent_node, self.projects[p])
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800220
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800221 def output_project(parent, parent_node, p):
Colin Cross5acde752012-03-28 20:15:45 -0700222 if not p.MatchesGroups(groups):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800223 return
224
225 name = p.name
226 relpath = p.relpath
227 if parent:
228 name = self._UnjoinName(parent.name, name)
229 relpath = self._UnjoinRelpath(parent.relpath, relpath)
Colin Cross5acde752012-03-28 20:15:45 -0700230
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800231 e = doc.createElement('project')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800232 parent_node.appendChild(e)
233 e.setAttribute('name', name)
234 if relpath != name:
235 e.setAttribute('path', relpath)
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700236 remoteName = d.remote.remoteAlias or d.remote.name
237 if not d.remote or p.remote.name != remoteName:
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800238 e.setAttribute('remote', p.remote.name)
239 if peg_rev:
240 if self.IsMirror:
Brian Harring14a66742012-09-28 20:21:57 -0700241 value = p.bare_git.rev_parse(p.revisionExpr + '^0')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800242 else:
Brian Harring14a66742012-09-28 20:21:57 -0700243 value = p.work_git.rev_parse(HEAD + '^0')
244 e.setAttribute('revision', value)
245 if peg_rev_upstream and value != p.revisionExpr:
246 # Only save the origin if the origin is not a sha1, and the default
247 # isn't our value, and the if the default doesn't already have that
248 # covered.
249 e.setAttribute('upstream', p.revisionExpr)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700250 elif not d.revisionExpr or p.revisionExpr != d.revisionExpr:
251 e.setAttribute('revision', p.revisionExpr)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800252
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800253 for c in p.copyfiles:
254 ce = doc.createElement('copyfile')
255 ce.setAttribute('src', c.src)
256 ce.setAttribute('dest', c.dest)
257 e.appendChild(ce)
258
Conley Owensbb1b5f52012-08-13 13:11:18 -0700259 default_groups = ['all', 'name:%s' % p.name, 'path:%s' % p.relpath]
Dmitry Fink17f85ea2012-08-06 14:52:29 -0700260 egroups = [g for g in p.groups if g not in default_groups]
Conley Owens971de8e2012-04-16 10:36:08 -0700261 if egroups:
262 e.setAttribute('groups', ','.join(egroups))
Colin Cross5acde752012-03-28 20:15:45 -0700263
James W. Mills24c13082012-04-12 15:04:13 -0500264 for a in p.annotations:
265 if a.keep == "true":
266 ae = doc.createElement('annotation')
267 ae.setAttribute('name', a.name)
268 ae.setAttribute('value', a.value)
269 e.appendChild(ae)
270
Anatol Pomazau79770d22012-04-20 14:41:59 -0700271 if p.sync_c:
272 e.setAttribute('sync-c', 'true')
273
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800274 if p.sync_s:
275 e.setAttribute('sync-s', 'true')
276
277 if p.subprojects:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530278 sort_projects = list(sorted([subp.name for subp in p.subprojects]))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800279 output_projects(p, e, sort_projects)
280
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530281 sort_projects = list(sorted([key for key, value in self.projects.items()
282 if not value.parent]))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800283 sort_projects.sort()
284 output_projects(None, root, sort_projects)
285
Doug Anderson37282b42011-03-04 11:54:18 -0800286 if self._repo_hooks_project:
287 root.appendChild(doc.createTextNode(''))
288 e = doc.createElement('repo-hooks')
289 e.setAttribute('in-project', self._repo_hooks_project.name)
290 e.setAttribute('enabled-list',
291 ' '.join(self._repo_hooks_project.enabled_repo_hooks))
292 root.appendChild(e)
293
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800294 doc.writexml(fd, '', ' ', '\n', 'UTF-8')
295
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700296 @property
297 def projects(self):
298 self._Load()
299 return self._projects
300
301 @property
302 def remotes(self):
303 self._Load()
304 return self._remotes
305
306 @property
307 def default(self):
308 self._Load()
309 return self._default
310
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800311 @property
Doug Anderson37282b42011-03-04 11:54:18 -0800312 def repo_hooks_project(self):
313 self._Load()
314 return self._repo_hooks_project
315
316 @property
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700317 def notice(self):
318 self._Load()
319 return self._notice
320
321 @property
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700322 def manifest_server(self):
323 self._Load()
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -0800324 return self._manifest_server
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700325
326 @property
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800327 def IsMirror(self):
328 return self.manifestProject.config.GetBoolean('repo.mirror')
329
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700330 def _Unload(self):
331 self._loaded = False
332 self._projects = {}
333 self._remotes = {}
334 self._default = None
Doug Anderson37282b42011-03-04 11:54:18 -0800335 self._repo_hooks_project = None
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700336 self._notice = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700337 self.branch = None
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700338 self._manifest_server = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700339
340 def _Load(self):
341 if not self._loaded:
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800342 m = self.manifestProject
343 b = m.GetBranch(m.CurrentBranch).merge
Shawn O. Pearce21c5c342009-06-25 16:47:30 -0700344 if b is not None and b.startswith(R_HEADS):
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800345 b = b[len(R_HEADS):]
346 self.branch = b
347
Colin Cross23acdd32012-04-21 00:33:54 -0700348 nodes = []
Brian Harring475a47d2012-06-07 20:05:35 -0700349 nodes.append(self._ParseManifestXml(self.manifestFile,
350 self.manifestProject.worktree))
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700351
352 local = os.path.join(self.repodir, LOCAL_MANIFEST_NAME)
353 if os.path.exists(local):
David Pursehouse4eb285c2013-02-14 16:28:44 +0900354 if not self.localManifestWarning:
355 self.localManifestWarning = True
356 print('warning: %s is deprecated; put local manifests in `%s` instead'
357 % (LOCAL_MANIFEST_NAME, os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME)),
358 file=sys.stderr)
Brian Harring475a47d2012-06-07 20:05:35 -0700359 nodes.append(self._ParseManifestXml(local, self.repodir))
Colin Cross23acdd32012-04-21 00:33:54 -0700360
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900361 local_dir = os.path.abspath(os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME))
362 try:
David Pursehouse52f1e5d2012-11-14 04:53:24 +0900363 for local_file in sorted(os.listdir(local_dir)):
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900364 if local_file.endswith('.xml'):
David Pursehouse5f434ed2012-11-22 13:48:10 +0900365 local = os.path.join(local_dir, local_file)
366 nodes.append(self._ParseManifestXml(local, self.repodir))
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900367 except OSError:
368 pass
369
Joe Onorato26e24752013-01-11 12:35:53 -0800370 try:
371 self._ParseManifest(nodes)
372 except ManifestParseError as e:
373 # There was a problem parsing, unload ourselves in case they catch
374 # this error and try again later, we will show the correct error
375 self._Unload()
376 raise e
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700377
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800378 if self.IsMirror:
379 self._AddMetaProjectMirror(self.repoProject)
380 self._AddMetaProjectMirror(self.manifestProject)
381
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700382 self._loaded = True
383
Brian Harring475a47d2012-06-07 20:05:35 -0700384 def _ParseManifestXml(self, path, include_root):
David Pursehousef7fc8a92012-11-13 04:00:28 +0900385 try:
386 root = xml.dom.minidom.parse(path)
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900387 except (OSError, xml.parsers.expat.ExpatError) as e:
David Pursehousef7fc8a92012-11-13 04:00:28 +0900388 raise ManifestParseError("error parsing manifest %s: %s" % (path, e))
389
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700390 if not root or not root.childNodes:
Brian Harring26448742011-04-28 05:04:41 -0700391 raise ManifestParseError("no root node in %s" % (path,))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700392
Jooncheol Park34acdd22012-08-27 02:25:59 +0900393 for manifest in root.childNodes:
394 if manifest.nodeName == 'manifest':
395 break
396 else:
Brian Harring26448742011-04-28 05:04:41 -0700397 raise ManifestParseError("no <manifest> in %s" % (path,))
398
Colin Cross23acdd32012-04-21 00:33:54 -0700399 nodes = []
David Pursehouse4f7bdea2012-10-22 12:50:15 +0900400 for node in manifest.childNodes: # pylint:disable=W0631
David Pursehouse5c6eeac2012-10-11 16:44:48 +0900401 # We only get here if manifest is initialised
David Pursehousec1b86a22012-11-14 11:36:51 +0900402 if node.nodeName == 'include':
403 name = self._reqatt(node, 'name')
404 fp = os.path.join(include_root, name)
405 if not os.path.isfile(fp):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530406 raise ManifestParseError("include %s doesn't exist or isn't a file"
407 % (name,))
David Pursehousec1b86a22012-11-14 11:36:51 +0900408 try:
409 nodes.extend(self._ParseManifestXml(fp, include_root))
410 # should isolate this to the exact exception, but that's
411 # tricky. actual parsing implementation may vary.
412 except (KeyboardInterrupt, RuntimeError, SystemExit):
413 raise
414 except Exception as e:
415 raise ManifestParseError(
416 "failed parsing included manifest %s: %s", (name, e))
417 else:
418 nodes.append(node)
Colin Cross23acdd32012-04-21 00:33:54 -0700419 return nodes
Brian Harring26448742011-04-28 05:04:41 -0700420
Colin Cross23acdd32012-04-21 00:33:54 -0700421 def _ParseManifest(self, node_list):
422 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700423 if node.nodeName == 'remote':
424 remote = self._ParseRemote(node)
David Pursehouse717ece92012-11-13 08:49:16 +0900425 if remote:
426 if remote.name in self._remotes:
427 if remote != self._remotes[remote.name]:
428 raise ManifestParseError(
429 'remote %s already exists with different attributes' %
430 (remote.name))
431 else:
432 self._remotes[remote.name] = remote
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700433
Colin Cross23acdd32012-04-21 00:33:54 -0700434 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700435 if node.nodeName == 'default':
Julien Campergue74879922013-10-09 14:38:46 +0200436 new_default = self._ParseDefault(node)
437 if self._default is None:
438 self._default = new_default
439 elif new_default != self._default:
David Pursehouse37128b62013-10-15 10:48:40 +0900440 raise ManifestParseError('duplicate default in %s' %
441 (self.manifestFile))
Julien Campergue74879922013-10-09 14:38:46 +0200442
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700443 if self._default is None:
444 self._default = _Default()
445
Colin Cross23acdd32012-04-21 00:33:54 -0700446 for node in itertools.chain(*node_list):
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700447 if node.nodeName == 'notice':
448 if self._notice is not None:
Doug Anderson37282b42011-03-04 11:54:18 -0800449 raise ManifestParseError(
450 'duplicate notice in %s' %
451 (self.manifestFile))
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700452 self._notice = self._ParseNotice(node)
453
Colin Cross23acdd32012-04-21 00:33:54 -0700454 for node in itertools.chain(*node_list):
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700455 if node.nodeName == 'manifest-server':
456 url = self._reqatt(node, 'url')
457 if self._manifest_server is not None:
David Pursehousec1b86a22012-11-14 11:36:51 +0900458 raise ManifestParseError(
459 'duplicate manifest-server in %s' %
460 (self.manifestFile))
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700461 self._manifest_server = url
462
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800463 def recursively_add_projects(project):
464 if self._projects.get(project.name):
465 raise ManifestParseError(
466 'duplicate project %s in %s' %
467 (project.name, self.manifestFile))
468 self._projects[project.name] = project
469 for subproject in project.subprojects:
470 recursively_add_projects(subproject)
471
Colin Cross23acdd32012-04-21 00:33:54 -0700472 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700473 if node.nodeName == 'project':
474 project = self._ParseProject(node)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800475 recursively_add_projects(project)
Doug Anderson37282b42011-03-04 11:54:18 -0800476 if node.nodeName == 'repo-hooks':
477 # Get the name of the project and the (space-separated) list of enabled.
478 repo_hooks_project = self._reqatt(node, 'in-project')
479 enabled_repo_hooks = self._reqatt(node, 'enabled-list').split()
480
481 # Only one project can be the hooks project
482 if self._repo_hooks_project is not None:
483 raise ManifestParseError(
484 'duplicate repo-hooks in %s' %
485 (self.manifestFile))
486
487 # Store a reference to the Project.
488 try:
489 self._repo_hooks_project = self._projects[repo_hooks_project]
490 except KeyError:
491 raise ManifestParseError(
492 'project %s not found for repo-hooks' %
493 (repo_hooks_project))
494
495 # Store the enabled hooks in the Project object.
496 self._repo_hooks_project.enabled_repo_hooks = enabled_repo_hooks
Colin Cross23acdd32012-04-21 00:33:54 -0700497 if node.nodeName == 'remove-project':
498 name = self._reqatt(node, 'name')
499 try:
500 del self._projects[name]
501 except KeyError:
David Pursehousef9107482012-11-16 19:12:32 +0900502 raise ManifestParseError('remove-project element specifies non-existent '
503 'project: %s' % name)
Colin Cross23acdd32012-04-21 00:33:54 -0700504
505 # If the manifest removes the hooks project, treat it as if it deleted
506 # the repo-hooks element too.
507 if self._repo_hooks_project and (self._repo_hooks_project.name == name):
508 self._repo_hooks_project = None
509
Doug Anderson37282b42011-03-04 11:54:18 -0800510
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800511 def _AddMetaProjectMirror(self, m):
512 name = None
513 m_url = m.GetRemote(m.remote.name).url
514 if m_url.endswith('/.git'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530515 raise ManifestParseError('refusing to mirror %s' % m_url)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800516
517 if self._default and self._default.remote:
Conley Owensceea3682011-10-20 10:45:47 -0700518 url = self._default.remote.resolvedFetchUrl
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800519 if not url.endswith('/'):
520 url += '/'
521 if m_url.startswith(url):
522 remote = self._default.remote
523 name = m_url[len(url):]
524
525 if name is None:
526 s = m_url.rindex('/') + 1
Conley Owensdb728cd2011-09-26 16:34:01 -0700527 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Shawn O. Pearcef35b2d92012-08-02 11:46:22 -0700528 remote = _XmlRemote('origin', fetch=m_url[:s], manifestUrl=manifestUrl)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800529 name = m_url[s:]
530
531 if name.endswith('.git'):
532 name = name[:-4]
533
534 if name not in self._projects:
535 m.PreSync()
536 gitdir = os.path.join(self.topdir, '%s.git' % name)
537 project = Project(manifest = self,
538 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700539 remote = remote.ToRemoteSpec(name),
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800540 gitdir = gitdir,
541 worktree = None,
542 relpath = None,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700543 revisionExpr = m.revisionExpr,
544 revisionId = None)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800545 self._projects[project.name] = project
546
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700547 def _ParseRemote(self, node):
548 """
549 reads a <remote> element from the manifest file
550 """
551 name = self._reqatt(node, 'name')
Yestin Sunb292b982012-07-02 07:32:50 -0700552 alias = node.getAttribute('alias')
553 if alias == '':
554 alias = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700555 fetch = self._reqatt(node, 'fetch')
556 review = node.getAttribute('review')
Shawn O. Pearceae6e0942008-11-06 10:25:35 -0800557 if review == '':
558 review = None
Conley Owensdb728cd2011-09-26 16:34:01 -0700559 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Yestin Sunb292b982012-07-02 07:32:50 -0700560 return _XmlRemote(name, alias, fetch, manifestUrl, review)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700561
562 def _ParseDefault(self, node):
563 """
564 reads a <default> element from the manifest file
565 """
566 d = _Default()
567 d.remote = self._get_remote(node)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700568 d.revisionExpr = node.getAttribute('revision')
569 if d.revisionExpr == '':
570 d.revisionExpr = None
Anatol Pomazau79770d22012-04-20 14:41:59 -0700571
Bryan Jacobsf609f912013-05-06 13:36:24 -0400572 d.destBranchExpr = node.getAttribute('dest-branch') or None
573
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700574 sync_j = node.getAttribute('sync-j')
575 if sync_j == '' or sync_j is None:
576 d.sync_j = 1
577 else:
578 d.sync_j = int(sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700579
580 sync_c = node.getAttribute('sync-c')
581 if not sync_c:
582 d.sync_c = False
583 else:
584 d.sync_c = sync_c.lower() in ("yes", "true", "1")
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800585
586 sync_s = node.getAttribute('sync-s')
587 if not sync_s:
588 d.sync_s = False
589 else:
590 d.sync_s = sync_s.lower() in ("yes", "true", "1")
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700591 return d
592
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700593 def _ParseNotice(self, node):
594 """
595 reads a <notice> element from the manifest file
596
597 The <notice> element is distinct from other tags in the XML in that the
598 data is conveyed between the start and end tag (it's not an empty-element
599 tag).
600
601 The white space (carriage returns, indentation) for the notice element is
602 relevant and is parsed in a way that is based on how python docstrings work.
603 In fact, the code is remarkably similar to here:
604 http://www.python.org/dev/peps/pep-0257/
605 """
606 # Get the data out of the node...
607 notice = node.childNodes[0].data
608
609 # Figure out minimum indentation, skipping the first line (the same line
610 # as the <notice> tag)...
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530611 minIndent = sys.maxsize
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700612 lines = notice.splitlines()
613 for line in lines[1:]:
614 lstrippedLine = line.lstrip()
615 if lstrippedLine:
616 indent = len(line) - len(lstrippedLine)
617 minIndent = min(indent, minIndent)
618
619 # Strip leading / trailing blank lines and also indentation.
620 cleanLines = [lines[0].strip()]
621 for line in lines[1:]:
622 cleanLines.append(line[minIndent:].rstrip())
623
624 # Clear completely blank lines from front and back...
625 while cleanLines and not cleanLines[0]:
626 del cleanLines[0]
627 while cleanLines and not cleanLines[-1]:
628 del cleanLines[-1]
629
630 return '\n'.join(cleanLines)
631
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800632 def _JoinName(self, parent_name, name):
633 return os.path.join(parent_name, name)
634
635 def _UnjoinName(self, parent_name, name):
636 return os.path.relpath(name, parent_name)
637
638 def _ParseProject(self, node, parent = None):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700639 """
640 reads a <project> element from the manifest file
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700641 """
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700642 name = self._reqatt(node, 'name')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800643 if parent:
644 name = self._JoinName(parent.name, name)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700645
646 remote = self._get_remote(node)
647 if remote is None:
648 remote = self._default.remote
649 if remote is None:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530650 raise ManifestParseError("no remote for project %s within %s" %
651 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700652
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700653 revisionExpr = node.getAttribute('revision')
654 if not revisionExpr:
655 revisionExpr = self._default.revisionExpr
656 if not revisionExpr:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530657 raise ManifestParseError("no revision for project %s within %s" %
658 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700659
660 path = node.getAttribute('path')
661 if not path:
662 path = name
663 if path.startswith('/'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530664 raise ManifestParseError("project %s path cannot be absolute in %s" %
665 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700666
Mike Pontillod3153822012-02-28 11:53:24 -0800667 rebase = node.getAttribute('rebase')
668 if not rebase:
669 rebase = True
670 else:
671 rebase = rebase.lower() in ("yes", "true", "1")
672
Anatol Pomazau79770d22012-04-20 14:41:59 -0700673 sync_c = node.getAttribute('sync-c')
674 if not sync_c:
675 sync_c = False
676 else:
677 sync_c = sync_c.lower() in ("yes", "true", "1")
678
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800679 sync_s = node.getAttribute('sync-s')
680 if not sync_s:
681 sync_s = self._default.sync_s
682 else:
683 sync_s = sync_s.lower() in ("yes", "true", "1")
684
David Pursehouseede7f122012-11-27 22:25:30 +0900685 clone_depth = node.getAttribute('clone-depth')
686 if clone_depth:
687 try:
688 clone_depth = int(clone_depth)
689 if clone_depth <= 0:
690 raise ValueError()
691 except ValueError:
692 raise ManifestParseError('invalid clone-depth %s in %s' %
693 (clone_depth, self.manifestFile))
694
Bryan Jacobsf609f912013-05-06 13:36:24 -0400695 dest_branch = node.getAttribute('dest-branch') or self._default.destBranchExpr
696
Brian Harring14a66742012-09-28 20:21:57 -0700697 upstream = node.getAttribute('upstream')
698
Conley Owens971de8e2012-04-16 10:36:08 -0700699 groups = ''
700 if node.hasAttribute('groups'):
701 groups = node.getAttribute('groups')
David Pursehouse1d947b32012-10-25 12:23:11 +0900702 groups = [x for x in re.split(r'[,\s]+', groups) if x]
Brian Harring7da13142012-06-15 02:24:20 -0700703
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800704 if parent is None:
705 relpath, worktree, gitdir = self.GetProjectPaths(name, path)
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700706 else:
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800707 relpath, worktree, gitdir = self.GetSubprojectPaths(parent, path)
708
709 default_groups = ['all', 'name:%s' % name, 'path:%s' % relpath]
710 groups.extend(set(default_groups).difference(groups))
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700711
Scott Fandb83b1b2013-02-28 09:34:14 +0800712 if self.IsMirror and node.hasAttribute('force-path'):
713 if node.getAttribute('force-path').lower() in ("yes", "true", "1"):
714 gitdir = os.path.join(self.topdir, '%s.git' % path)
715
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700716 project = Project(manifest = self,
717 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700718 remote = remote.ToRemoteSpec(name),
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700719 gitdir = gitdir,
720 worktree = worktree,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800721 relpath = relpath,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700722 revisionExpr = revisionExpr,
Mike Pontillod3153822012-02-28 11:53:24 -0800723 revisionId = None,
Colin Cross5acde752012-03-28 20:15:45 -0700724 rebase = rebase,
Anatol Pomazau79770d22012-04-20 14:41:59 -0700725 groups = groups,
Brian Harring14a66742012-09-28 20:21:57 -0700726 sync_c = sync_c,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800727 sync_s = sync_s,
David Pursehouseede7f122012-11-27 22:25:30 +0900728 clone_depth = clone_depth,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800729 upstream = upstream,
Bryan Jacobsf609f912013-05-06 13:36:24 -0400730 parent = parent,
731 dest_branch = dest_branch)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700732
733 for n in node.childNodes:
Shawn O. Pearce242b5262009-05-19 13:00:29 -0700734 if n.nodeName == 'copyfile':
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700735 self._ParseCopyFile(project, n)
James W. Mills24c13082012-04-12 15:04:13 -0500736 if n.nodeName == 'annotation':
737 self._ParseAnnotation(project, n)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800738 if n.nodeName == 'project':
739 project.subprojects.append(self._ParseProject(n, parent = project))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700740
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700741 return project
742
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800743 def GetProjectPaths(self, name, path):
744 relpath = path
745 if self.IsMirror:
746 worktree = None
747 gitdir = os.path.join(self.topdir, '%s.git' % name)
748 else:
749 worktree = os.path.join(self.topdir, path).replace('\\', '/')
750 gitdir = os.path.join(self.repodir, 'projects', '%s.git' % path)
751 return relpath, worktree, gitdir
752
753 def GetSubprojectName(self, parent, submodule_path):
754 return os.path.join(parent.name, submodule_path)
755
756 def _JoinRelpath(self, parent_relpath, relpath):
757 return os.path.join(parent_relpath, relpath)
758
759 def _UnjoinRelpath(self, parent_relpath, relpath):
760 return os.path.relpath(relpath, parent_relpath)
761
762 def GetSubprojectPaths(self, parent, path):
763 relpath = self._JoinRelpath(parent.relpath, path)
764 gitdir = os.path.join(parent.gitdir, 'subprojects', '%s.git' % path)
765 if self.IsMirror:
766 worktree = None
767 else:
768 worktree = os.path.join(parent.worktree, path).replace('\\', '/')
769 return relpath, worktree, gitdir
770
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700771 def _ParseCopyFile(self, project, node):
772 src = self._reqatt(node, 'src')
773 dest = self._reqatt(node, 'dest')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800774 if not self.IsMirror:
775 # src is project relative;
776 # dest is relative to the top of the tree
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800777 project.AddCopyFile(src, dest, os.path.join(self.topdir, dest))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700778
James W. Mills24c13082012-04-12 15:04:13 -0500779 def _ParseAnnotation(self, project, node):
780 name = self._reqatt(node, 'name')
781 value = self._reqatt(node, 'value')
782 try:
783 keep = self._reqatt(node, 'keep').lower()
784 except ManifestParseError:
785 keep = "true"
786 if keep != "true" and keep != "false":
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530787 raise ManifestParseError('optional "keep" attribute must be '
788 '"true" or "false"')
James W. Mills24c13082012-04-12 15:04:13 -0500789 project.AddAnnotation(name, value, keep)
790
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700791 def _get_remote(self, node):
792 name = node.getAttribute('remote')
793 if not name:
794 return None
795
796 v = self._remotes.get(name)
797 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530798 raise ManifestParseError("remote %s not defined in %s" %
799 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700800 return v
801
802 def _reqatt(self, node, attname):
803 """
804 reads a required attribute from the node.
805 """
806 v = node.getAttribute(attname)
807 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530808 raise ManifestParseError("no %s in <%s> within %s" %
809 (attname, node.nodeName, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700810 return v