blob: 3ac607ecae6fd728b6bfc5542237f39e500f7254 [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
Simran Basib9a1b732015-08-20 12:19:28 -070032import gitc_utils
David Pursehousee15c65a2012-08-22 10:46:11 +090033from git_config import GitConfig
David Pursehousee00aa6b2012-09-11 14:33:51 +090034from git_refs import R_HEADS, HEAD
35from project import RemoteSpec, Project, MetaProject
Julien Camperguedd654222014-01-09 16:21:37 +010036from error import ManifestParseError, ManifestInvalidRevisionError
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070037
38MANIFEST_FILE_NAME = 'manifest.xml'
Shawn O. Pearce5cc66792008-10-23 16:19:27 -070039LOCAL_MANIFEST_NAME = 'local_manifest.xml'
David Pursehouse2d5a0df2012-11-13 02:50:36 +090040LOCAL_MANIFESTS_DIR_NAME = 'local_manifests'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070041
Anthony Kingcb07ba72015-03-28 23:26:04 +000042# urljoin gets confused if the scheme is not known.
43urllib.parse.uses_relative.extend(['ssh', 'git', 'persistent-https', 'rpc'])
44urllib.parse.uses_netloc.extend(['ssh', 'git', 'persistent-https', 'rpc'])
Conley Owensdb728cd2011-09-26 16:34:01 -070045
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070046class _Default(object):
47 """Project defaults within the manifest."""
48
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -070049 revisionExpr = None
Conley Owensb6a16e62013-09-25 15:06:09 -070050 destBranchExpr = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070051 remote = None
Shawn O. Pearce6392c872011-09-22 17:44:31 -070052 sync_j = 1
Anatol Pomazau79770d22012-04-20 14:41:59 -070053 sync_c = False
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +080054 sync_s = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070055
Julien Campergue74879922013-10-09 14:38:46 +020056 def __eq__(self, other):
57 return self.__dict__ == other.__dict__
58
59 def __ne__(self, other):
60 return self.__dict__ != other.__dict__
61
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070062class _XmlRemote(object):
63 def __init__(self,
64 name,
Yestin Sunb292b982012-07-02 07:32:50 -070065 alias=None,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070066 fetch=None,
Conley Owensdb728cd2011-09-26 16:34:01 -070067 manifestUrl=None,
Anthony King36ea2fb2014-05-06 11:54:01 +010068 review=None,
Jonathan Nieder93719792015-03-17 11:29:58 -070069 revision=None):
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070070 self.name = name
71 self.fetchUrl = fetch
Conley Owensdb728cd2011-09-26 16:34:01 -070072 self.manifestUrl = manifestUrl
Yestin Sunb292b982012-07-02 07:32:50 -070073 self.remoteAlias = alias
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070074 self.reviewUrl = review
Anthony King36ea2fb2014-05-06 11:54:01 +010075 self.revision = revision
Conley Owensceea3682011-10-20 10:45:47 -070076 self.resolvedFetchUrl = self._resolveFetchUrl()
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070077
David Pursehouse717ece92012-11-13 08:49:16 +090078 def __eq__(self, other):
79 return self.__dict__ == other.__dict__
80
81 def __ne__(self, other):
82 return self.__dict__ != other.__dict__
83
Conley Owensceea3682011-10-20 10:45:47 -070084 def _resolveFetchUrl(self):
85 url = self.fetchUrl.rstrip('/')
Conley Owensdb728cd2011-09-26 16:34:01 -070086 manifestUrl = self.manifestUrl.rstrip('/')
Conley Owens2d0f5082014-01-31 15:03:51 -080087 # urljoin will gets confused over quite a few things. The ones we care
88 # about here are:
89 # * no scheme in the base url, like <hostname:port>
Anthony Kingcb07ba72015-03-28 23:26:04 +000090 # We handle no scheme by replacing it with an obscure protocol, gopher
91 # and then replacing it with the original when we are done.
92
Conley Owensdb728cd2011-09-26 16:34:01 -070093 if manifestUrl.find(':') != manifestUrl.find('/') - 1:
Conley Owens4ccad752015-04-29 10:45:37 -070094 url = urllib.parse.urljoin('gopher://' + manifestUrl, url)
95 url = re.sub(r'^gopher://', '', url)
Anthony Kingcb07ba72015-03-28 23:26:04 +000096 else:
97 url = urllib.parse.urljoin(manifestUrl, url)
Shawn Pearcea9f11b32013-01-02 15:40:48 -080098 return url
Conley Owensceea3682011-10-20 10:45:47 -070099
100 def ToRemoteSpec(self, projectName):
Conley Owens9d8f9142011-10-20 14:36:35 -0700101 url = self.resolvedFetchUrl.rstrip('/') + '/' + projectName
Yestin Sunb292b982012-07-02 07:32:50 -0700102 remoteName = self.name
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700103 if self.remoteAlias:
David Pursehouse37128b62013-10-15 10:48:40 +0900104 remoteName = self.remoteAlias
Yestin Sunb292b982012-07-02 07:32:50 -0700105 return RemoteSpec(remoteName, url, self.reviewUrl)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700106
Shawn O. Pearcec8a300f2009-05-18 13:19:57 -0700107class XmlManifest(object):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700108 """manages the repo configuration file"""
109
110 def __init__(self, repodir):
111 self.repodir = os.path.abspath(repodir)
112 self.topdir = os.path.dirname(self.repodir)
113 self.manifestFile = os.path.join(self.repodir, MANIFEST_FILE_NAME)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700114 self.globalConfig = GitConfig.ForUser()
David Pursehouse4eb285c2013-02-14 16:28:44 +0900115 self.localManifestWarning = False
Simran Basib9a1b732015-08-20 12:19:28 -0700116 self.isGitcClient = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700117
118 self.repoProject = MetaProject(self, 'repo',
119 gitdir = os.path.join(repodir, 'repo/.git'),
120 worktree = os.path.join(repodir, 'repo'))
121
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700122 self.manifestProject = MetaProject(self, 'manifests',
Shawn O. Pearcef5c25a62008-11-04 08:11:53 -0800123 gitdir = os.path.join(repodir, 'manifests.git'),
124 worktree = os.path.join(repodir, 'manifests'))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700125
126 self._Unload()
127
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700128 def Override(self, name):
129 """Use a different manifest, just for the current instantiation.
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700130 """
131 path = os.path.join(self.manifestProject.worktree, name)
132 if not os.path.isfile(path):
133 raise ManifestParseError('manifest %s not found' % name)
134
135 old = self.manifestFile
136 try:
137 self.manifestFile = path
138 self._Unload()
139 self._Load()
140 finally:
141 self.manifestFile = old
142
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700143 def Link(self, name):
144 """Update the repo metadata to use a different manifest.
145 """
146 self.Override(name)
147
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700148 try:
Sebastian Frias223bf962012-11-21 19:09:25 +0100149 if os.path.lexists(self.manifestFile):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700150 os.remove(self.manifestFile)
151 os.symlink('manifests/%s' % name, self.manifestFile)
Sebastian Frias223bf962012-11-21 19:09:25 +0100152 except OSError as e:
153 raise ManifestParseError('cannot link manifest %s: %s' % (name, str(e)))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700154
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800155 def _RemoteToXml(self, r, doc, root):
156 e = doc.createElement('remote')
157 root.appendChild(e)
158 e.setAttribute('name', r.name)
159 e.setAttribute('fetch', r.fetchUrl)
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700160 if r.remoteAlias is not None:
161 e.setAttribute('alias', r.remoteAlias)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800162 if r.reviewUrl is not None:
163 e.setAttribute('review', r.reviewUrl)
Anthony King36ea2fb2014-05-06 11:54:01 +0100164 if r.revision is not None:
165 e.setAttribute('revision', r.revision)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800166
Josh Triplett884a3872014-06-12 14:57:29 -0700167 def _ParseGroups(self, groups):
168 return [x for x in re.split(r'[,\s]+', groups) if x]
169
Dan Willemsen250303b2015-09-08 13:27:20 -0700170 def Save(self, fd, peg_rev=False, peg_rev_upstream=True, groups=None):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800171 """Write the current manifest out to the given file descriptor.
172 """
Colin Cross5acde752012-03-28 20:15:45 -0700173 mp = self.manifestProject
174
Dan Willemsen250303b2015-09-08 13:27:20 -0700175 if groups is None:
176 groups = mp.config.GetString('manifest.groups')
Matt Gumbel0c635bb2012-12-21 10:14:53 -0800177 if groups:
Josh Triplett884a3872014-06-12 14:57:29 -0700178 groups = self._ParseGroups(groups)
Colin Cross5acde752012-03-28 20:15:45 -0700179
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800180 doc = xml.dom.minidom.Document()
181 root = doc.createElement('manifest')
182 doc.appendChild(root)
183
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700184 # Save out the notice. There's a little bit of work here to give it the
185 # right whitespace, which assumes that the notice is automatically indented
186 # by 4 by minidom.
187 if self.notice:
188 notice_element = root.appendChild(doc.createElement('notice'))
189 notice_lines = self.notice.splitlines()
190 indented_notice = ('\n'.join(" "*4 + line for line in notice_lines))[4:]
191 notice_element.appendChild(doc.createTextNode(indented_notice))
192
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800193 d = self.default
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800194
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530195 for r in sorted(self.remotes):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800196 self._RemoteToXml(self.remotes[r], doc, root)
197 if self.remotes:
198 root.appendChild(doc.createTextNode(''))
199
200 have_default = False
201 e = doc.createElement('default')
202 if d.remote:
203 have_default = True
204 e.setAttribute('remote', d.remote.name)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700205 if d.revisionExpr:
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800206 have_default = True
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700207 e.setAttribute('revision', d.revisionExpr)
Simon Ruggier7e59de22015-07-24 12:50:06 +0200208 if d.destBranchExpr:
209 have_default = True
210 e.setAttribute('dest-branch', d.destBranchExpr)
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700211 if d.sync_j > 1:
212 have_default = True
213 e.setAttribute('sync-j', '%d' % d.sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700214 if d.sync_c:
215 have_default = True
216 e.setAttribute('sync-c', 'true')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800217 if d.sync_s:
218 have_default = True
219 e.setAttribute('sync-s', 'true')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800220 if have_default:
221 root.appendChild(e)
222 root.appendChild(doc.createTextNode(''))
223
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700224 if self._manifest_server:
225 e = doc.createElement('manifest-server')
226 e.setAttribute('url', self._manifest_server)
227 root.appendChild(e)
228 root.appendChild(doc.createTextNode(''))
229
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800230 def output_projects(parent, parent_node, projects):
David James8d201162013-10-11 17:03:19 -0700231 for project_name in projects:
232 for project in self._projects[project_name]:
233 output_project(parent, parent_node, project)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800234
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800235 def output_project(parent, parent_node, p):
Colin Cross5acde752012-03-28 20:15:45 -0700236 if not p.MatchesGroups(groups):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800237 return
238
239 name = p.name
240 relpath = p.relpath
241 if parent:
242 name = self._UnjoinName(parent.name, name)
243 relpath = self._UnjoinRelpath(parent.relpath, relpath)
Colin Cross5acde752012-03-28 20:15:45 -0700244
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800245 e = doc.createElement('project')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800246 parent_node.appendChild(e)
247 e.setAttribute('name', name)
248 if relpath != name:
249 e.setAttribute('path', relpath)
Conley Owensa17d7af2013-10-16 14:38:09 -0700250 remoteName = None
251 if d.remote:
Conley Owensce201a52013-10-16 14:42:42 -0700252 remoteName = d.remote.remoteAlias or d.remote.name
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700253 if not d.remote or p.remote.name != remoteName:
Anthony King36ea2fb2014-05-06 11:54:01 +0100254 remoteName = p.remote.name
255 e.setAttribute('remote', remoteName)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800256 if peg_rev:
257 if self.IsMirror:
Brian Harring14a66742012-09-28 20:21:57 -0700258 value = p.bare_git.rev_parse(p.revisionExpr + '^0')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800259 else:
Brian Harring14a66742012-09-28 20:21:57 -0700260 value = p.work_git.rev_parse(HEAD + '^0')
261 e.setAttribute('revision', value)
Conley Owens551dfec2015-07-10 14:54:54 -0700262 if peg_rev_upstream:
263 if p.upstream:
264 e.setAttribute('upstream', p.upstream)
265 elif value != p.revisionExpr:
266 # Only save the origin if the origin is not a sha1, and the default
267 # isn't our value
268 e.setAttribute('upstream', p.revisionExpr)
Anthony King36ea2fb2014-05-06 11:54:01 +0100269 else:
270 revision = self.remotes[remoteName].revision or d.revisionExpr
271 if not revision or revision != p.revisionExpr:
272 e.setAttribute('revision', p.revisionExpr)
Mani Chandel7a91d512014-07-24 16:27:08 +0530273 if p.upstream and p.upstream != p.revisionExpr:
274 e.setAttribute('upstream', p.upstream)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800275
Simon Ruggier7e59de22015-07-24 12:50:06 +0200276 if p.dest_branch and p.dest_branch != d.destBranchExpr:
277 e.setAttribute('dest-branch', p.dest_branch)
278
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800279 for c in p.copyfiles:
280 ce = doc.createElement('copyfile')
281 ce.setAttribute('src', c.src)
282 ce.setAttribute('dest', c.dest)
283 e.appendChild(ce)
284
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500285 for l in p.linkfiles:
286 le = doc.createElement('linkfile')
287 le.setAttribute('src', l.src)
288 le.setAttribute('dest', l.dest)
289 e.appendChild(le)
290
Conley Owensbb1b5f52012-08-13 13:11:18 -0700291 default_groups = ['all', 'name:%s' % p.name, 'path:%s' % p.relpath]
Dmitry Fink17f85ea2012-08-06 14:52:29 -0700292 egroups = [g for g in p.groups if g not in default_groups]
Conley Owens971de8e2012-04-16 10:36:08 -0700293 if egroups:
294 e.setAttribute('groups', ','.join(egroups))
Colin Cross5acde752012-03-28 20:15:45 -0700295
James W. Mills24c13082012-04-12 15:04:13 -0500296 for a in p.annotations:
297 if a.keep == "true":
298 ae = doc.createElement('annotation')
299 ae.setAttribute('name', a.name)
300 ae.setAttribute('value', a.value)
301 e.appendChild(ae)
302
Anatol Pomazau79770d22012-04-20 14:41:59 -0700303 if p.sync_c:
304 e.setAttribute('sync-c', 'true')
305
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800306 if p.sync_s:
307 e.setAttribute('sync-s', 'true')
308
Dan Willemsen88409222015-08-17 15:29:10 -0700309 if p.clone_depth:
310 e.setAttribute('clone-depth', str(p.clone_depth))
311
Simran Basib9a1b732015-08-20 12:19:28 -0700312 self._output_manifest_project_extras(p, e)
313
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800314 if p.subprojects:
David James8d201162013-10-11 17:03:19 -0700315 subprojects = set(subp.name for subp in p.subprojects)
316 output_projects(p, e, list(sorted(subprojects)))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800317
David James8d201162013-10-11 17:03:19 -0700318 projects = set(p.name for p in self._paths.values() if not p.parent)
319 output_projects(None, root, list(sorted(projects)))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800320
Doug Anderson37282b42011-03-04 11:54:18 -0800321 if self._repo_hooks_project:
322 root.appendChild(doc.createTextNode(''))
323 e = doc.createElement('repo-hooks')
324 e.setAttribute('in-project', self._repo_hooks_project.name)
325 e.setAttribute('enabled-list',
326 ' '.join(self._repo_hooks_project.enabled_repo_hooks))
327 root.appendChild(e)
328
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800329 doc.writexml(fd, '', ' ', '\n', 'UTF-8')
330
Simran Basib9a1b732015-08-20 12:19:28 -0700331 def _output_manifest_project_extras(self, p, e):
332 """Manifests can modify e if they support extra project attributes."""
333 pass
334
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700335 @property
David James8d201162013-10-11 17:03:19 -0700336 def paths(self):
337 self._Load()
338 return self._paths
339
340 @property
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700341 def projects(self):
342 self._Load()
Anthony Kingd58bfe52014-05-05 23:30:49 +0100343 return list(self._paths.values())
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700344
345 @property
346 def remotes(self):
347 self._Load()
348 return self._remotes
349
350 @property
351 def default(self):
352 self._Load()
353 return self._default
354
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800355 @property
Doug Anderson37282b42011-03-04 11:54:18 -0800356 def repo_hooks_project(self):
357 self._Load()
358 return self._repo_hooks_project
359
360 @property
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700361 def notice(self):
362 self._Load()
363 return self._notice
364
365 @property
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700366 def manifest_server(self):
367 self._Load()
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -0800368 return self._manifest_server
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700369
370 @property
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800371 def IsMirror(self):
372 return self.manifestProject.config.GetBoolean('repo.mirror')
373
Julien Campergue335f5ef2013-10-16 11:02:35 +0200374 @property
375 def IsArchive(self):
376 return self.manifestProject.config.GetBoolean('repo.archive')
377
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700378 def _Unload(self):
379 self._loaded = False
380 self._projects = {}
David James8d201162013-10-11 17:03:19 -0700381 self._paths = {}
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700382 self._remotes = {}
383 self._default = None
Doug Anderson37282b42011-03-04 11:54:18 -0800384 self._repo_hooks_project = None
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700385 self._notice = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700386 self.branch = None
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700387 self._manifest_server = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700388
389 def _Load(self):
390 if not self._loaded:
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800391 m = self.manifestProject
392 b = m.GetBranch(m.CurrentBranch).merge
Shawn O. Pearce21c5c342009-06-25 16:47:30 -0700393 if b is not None and b.startswith(R_HEADS):
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800394 b = b[len(R_HEADS):]
395 self.branch = b
396
Colin Cross23acdd32012-04-21 00:33:54 -0700397 nodes = []
Brian Harring475a47d2012-06-07 20:05:35 -0700398 nodes.append(self._ParseManifestXml(self.manifestFile,
399 self.manifestProject.worktree))
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700400
401 local = os.path.join(self.repodir, LOCAL_MANIFEST_NAME)
402 if os.path.exists(local):
David Pursehouse4eb285c2013-02-14 16:28:44 +0900403 if not self.localManifestWarning:
404 self.localManifestWarning = True
405 print('warning: %s is deprecated; put local manifests in `%s` instead'
406 % (LOCAL_MANIFEST_NAME, os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME)),
407 file=sys.stderr)
Brian Harring475a47d2012-06-07 20:05:35 -0700408 nodes.append(self._ParseManifestXml(local, self.repodir))
Colin Cross23acdd32012-04-21 00:33:54 -0700409
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900410 local_dir = os.path.abspath(os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME))
411 try:
David Pursehouse52f1e5d2012-11-14 04:53:24 +0900412 for local_file in sorted(os.listdir(local_dir)):
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900413 if local_file.endswith('.xml'):
David Pursehouse5f434ed2012-11-22 13:48:10 +0900414 local = os.path.join(local_dir, local_file)
415 nodes.append(self._ParseManifestXml(local, self.repodir))
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900416 except OSError:
417 pass
418
Joe Onorato26e24752013-01-11 12:35:53 -0800419 try:
420 self._ParseManifest(nodes)
421 except ManifestParseError as e:
422 # There was a problem parsing, unload ourselves in case they catch
423 # this error and try again later, we will show the correct error
424 self._Unload()
425 raise e
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700426
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800427 if self.IsMirror:
428 self._AddMetaProjectMirror(self.repoProject)
429 self._AddMetaProjectMirror(self.manifestProject)
430
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700431 self._loaded = True
432
Brian Harring475a47d2012-06-07 20:05:35 -0700433 def _ParseManifestXml(self, path, include_root):
David Pursehousef7fc8a92012-11-13 04:00:28 +0900434 try:
435 root = xml.dom.minidom.parse(path)
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900436 except (OSError, xml.parsers.expat.ExpatError) as e:
David Pursehousef7fc8a92012-11-13 04:00:28 +0900437 raise ManifestParseError("error parsing manifest %s: %s" % (path, e))
438
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700439 if not root or not root.childNodes:
Brian Harring26448742011-04-28 05:04:41 -0700440 raise ManifestParseError("no root node in %s" % (path,))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700441
Jooncheol Park34acdd22012-08-27 02:25:59 +0900442 for manifest in root.childNodes:
443 if manifest.nodeName == 'manifest':
444 break
445 else:
Brian Harring26448742011-04-28 05:04:41 -0700446 raise ManifestParseError("no <manifest> in %s" % (path,))
447
Colin Cross23acdd32012-04-21 00:33:54 -0700448 nodes = []
David Pursehouse4f7bdea2012-10-22 12:50:15 +0900449 for node in manifest.childNodes: # pylint:disable=W0631
David Pursehouse5c6eeac2012-10-11 16:44:48 +0900450 # We only get here if manifest is initialised
David Pursehousec1b86a22012-11-14 11:36:51 +0900451 if node.nodeName == 'include':
452 name = self._reqatt(node, 'name')
453 fp = os.path.join(include_root, name)
454 if not os.path.isfile(fp):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530455 raise ManifestParseError("include %s doesn't exist or isn't a file"
456 % (name,))
David Pursehousec1b86a22012-11-14 11:36:51 +0900457 try:
458 nodes.extend(self._ParseManifestXml(fp, include_root))
459 # should isolate this to the exact exception, but that's
460 # tricky. actual parsing implementation may vary.
461 except (KeyboardInterrupt, RuntimeError, SystemExit):
462 raise
463 except Exception as e:
464 raise ManifestParseError(
465 "failed parsing included manifest %s: %s", (name, e))
466 else:
467 nodes.append(node)
Colin Cross23acdd32012-04-21 00:33:54 -0700468 return nodes
Brian Harring26448742011-04-28 05:04:41 -0700469
Colin Cross23acdd32012-04-21 00:33:54 -0700470 def _ParseManifest(self, node_list):
471 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700472 if node.nodeName == 'remote':
473 remote = self._ParseRemote(node)
David Pursehouse717ece92012-11-13 08:49:16 +0900474 if remote:
475 if remote.name in self._remotes:
476 if remote != self._remotes[remote.name]:
477 raise ManifestParseError(
478 'remote %s already exists with different attributes' %
479 (remote.name))
480 else:
481 self._remotes[remote.name] = remote
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700482
Colin Cross23acdd32012-04-21 00:33:54 -0700483 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700484 if node.nodeName == 'default':
Julien Campergue74879922013-10-09 14:38:46 +0200485 new_default = self._ParseDefault(node)
486 if self._default is None:
487 self._default = new_default
488 elif new_default != self._default:
David Pursehouse37128b62013-10-15 10:48:40 +0900489 raise ManifestParseError('duplicate default in %s' %
490 (self.manifestFile))
Julien Campergue74879922013-10-09 14:38:46 +0200491
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700492 if self._default is None:
493 self._default = _Default()
494
Colin Cross23acdd32012-04-21 00:33:54 -0700495 for node in itertools.chain(*node_list):
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700496 if node.nodeName == 'notice':
497 if self._notice is not None:
Doug Anderson37282b42011-03-04 11:54:18 -0800498 raise ManifestParseError(
499 'duplicate notice in %s' %
500 (self.manifestFile))
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700501 self._notice = self._ParseNotice(node)
502
Colin Cross23acdd32012-04-21 00:33:54 -0700503 for node in itertools.chain(*node_list):
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700504 if node.nodeName == 'manifest-server':
505 url = self._reqatt(node, 'url')
506 if self._manifest_server is not None:
David Pursehousec1b86a22012-11-14 11:36:51 +0900507 raise ManifestParseError(
508 'duplicate manifest-server in %s' %
509 (self.manifestFile))
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700510 self._manifest_server = url
511
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800512 def recursively_add_projects(project):
David James8d201162013-10-11 17:03:19 -0700513 projects = self._projects.setdefault(project.name, [])
514 if project.relpath is None:
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800515 raise ManifestParseError(
David James8d201162013-10-11 17:03:19 -0700516 'missing path for %s in %s' %
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800517 (project.name, self.manifestFile))
David James8d201162013-10-11 17:03:19 -0700518 if project.relpath in self._paths:
519 raise ManifestParseError(
520 'duplicate path %s in %s' %
521 (project.relpath, self.manifestFile))
522 self._paths[project.relpath] = project
523 projects.append(project)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800524 for subproject in project.subprojects:
525 recursively_add_projects(subproject)
526
Colin Cross23acdd32012-04-21 00:33:54 -0700527 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700528 if node.nodeName == 'project':
529 project = self._ParseProject(node)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800530 recursively_add_projects(project)
Josh Triplett884a3872014-06-12 14:57:29 -0700531 if node.nodeName == 'extend-project':
532 name = self._reqatt(node, 'name')
533
534 if name not in self._projects:
535 raise ManifestParseError('extend-project element specifies non-existent '
536 'project: %s' % name)
537
538 path = node.getAttribute('path')
539 groups = node.getAttribute('groups')
540 if groups:
541 groups = self._ParseGroups(groups)
542
543 for p in self._projects[name]:
544 if path and p.relpath != path:
545 continue
546 if groups:
547 p.groups.extend(groups)
Doug Anderson37282b42011-03-04 11:54:18 -0800548 if node.nodeName == 'repo-hooks':
549 # Get the name of the project and the (space-separated) list of enabled.
550 repo_hooks_project = self._reqatt(node, 'in-project')
551 enabled_repo_hooks = self._reqatt(node, 'enabled-list').split()
552
553 # Only one project can be the hooks project
554 if self._repo_hooks_project is not None:
555 raise ManifestParseError(
556 'duplicate repo-hooks in %s' %
557 (self.manifestFile))
558
559 # Store a reference to the Project.
560 try:
David James8d201162013-10-11 17:03:19 -0700561 repo_hooks_projects = self._projects[repo_hooks_project]
Doug Anderson37282b42011-03-04 11:54:18 -0800562 except KeyError:
563 raise ManifestParseError(
564 'project %s not found for repo-hooks' %
565 (repo_hooks_project))
566
David James8d201162013-10-11 17:03:19 -0700567 if len(repo_hooks_projects) != 1:
568 raise ManifestParseError(
569 'internal error parsing repo-hooks in %s' %
570 (self.manifestFile))
571 self._repo_hooks_project = repo_hooks_projects[0]
572
Doug Anderson37282b42011-03-04 11:54:18 -0800573 # Store the enabled hooks in the Project object.
574 self._repo_hooks_project.enabled_repo_hooks = enabled_repo_hooks
Colin Cross23acdd32012-04-21 00:33:54 -0700575 if node.nodeName == 'remove-project':
576 name = self._reqatt(node, 'name')
David Jamesb8433df2014-01-30 10:11:17 -0800577
578 if name not in self._projects:
David Pursehousef9107482012-11-16 19:12:32 +0900579 raise ManifestParseError('remove-project element specifies non-existent '
580 'project: %s' % name)
Colin Cross23acdd32012-04-21 00:33:54 -0700581
David Jamesb8433df2014-01-30 10:11:17 -0800582 for p in self._projects[name]:
583 del self._paths[p.relpath]
584 del self._projects[name]
585
Colin Cross23acdd32012-04-21 00:33:54 -0700586 # If the manifest removes the hooks project, treat it as if it deleted
587 # the repo-hooks element too.
588 if self._repo_hooks_project and (self._repo_hooks_project.name == name):
589 self._repo_hooks_project = None
590
Doug Anderson37282b42011-03-04 11:54:18 -0800591
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800592 def _AddMetaProjectMirror(self, m):
593 name = None
594 m_url = m.GetRemote(m.remote.name).url
595 if m_url.endswith('/.git'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530596 raise ManifestParseError('refusing to mirror %s' % m_url)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800597
598 if self._default and self._default.remote:
Conley Owensceea3682011-10-20 10:45:47 -0700599 url = self._default.remote.resolvedFetchUrl
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800600 if not url.endswith('/'):
601 url += '/'
602 if m_url.startswith(url):
603 remote = self._default.remote
604 name = m_url[len(url):]
605
606 if name is None:
607 s = m_url.rindex('/') + 1
Conley Owensdb728cd2011-09-26 16:34:01 -0700608 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Shawn O. Pearcef35b2d92012-08-02 11:46:22 -0700609 remote = _XmlRemote('origin', fetch=m_url[:s], manifestUrl=manifestUrl)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800610 name = m_url[s:]
611
612 if name.endswith('.git'):
613 name = name[:-4]
614
615 if name not in self._projects:
616 m.PreSync()
617 gitdir = os.path.join(self.topdir, '%s.git' % name)
618 project = Project(manifest = self,
619 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700620 remote = remote.ToRemoteSpec(name),
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800621 gitdir = gitdir,
David James8d201162013-10-11 17:03:19 -0700622 objdir = gitdir,
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800623 worktree = None,
Kwanhong Leeccd218c2014-02-17 13:07:32 +0900624 relpath = name or None,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700625 revisionExpr = m.revisionExpr,
626 revisionId = None)
David James8d201162013-10-11 17:03:19 -0700627 self._projects[project.name] = [project]
Kwanhong Leeccd218c2014-02-17 13:07:32 +0900628 self._paths[project.relpath] = project
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800629
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700630 def _ParseRemote(self, node):
631 """
632 reads a <remote> element from the manifest file
633 """
634 name = self._reqatt(node, 'name')
Yestin Sunb292b982012-07-02 07:32:50 -0700635 alias = node.getAttribute('alias')
636 if alias == '':
637 alias = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700638 fetch = self._reqatt(node, 'fetch')
639 review = node.getAttribute('review')
Shawn O. Pearceae6e0942008-11-06 10:25:35 -0800640 if review == '':
641 review = None
Anthony King36ea2fb2014-05-06 11:54:01 +0100642 revision = node.getAttribute('revision')
643 if revision == '':
644 revision = None
Conley Owensdb728cd2011-09-26 16:34:01 -0700645 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Jonathan Nieder93719792015-03-17 11:29:58 -0700646 return _XmlRemote(name, alias, fetch, manifestUrl, review, revision)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700647
648 def _ParseDefault(self, node):
649 """
650 reads a <default> element from the manifest file
651 """
652 d = _Default()
653 d.remote = self._get_remote(node)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700654 d.revisionExpr = node.getAttribute('revision')
655 if d.revisionExpr == '':
656 d.revisionExpr = None
Anatol Pomazau79770d22012-04-20 14:41:59 -0700657
Bryan Jacobsf609f912013-05-06 13:36:24 -0400658 d.destBranchExpr = node.getAttribute('dest-branch') or None
659
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700660 sync_j = node.getAttribute('sync-j')
661 if sync_j == '' or sync_j is None:
662 d.sync_j = 1
663 else:
664 d.sync_j = int(sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700665
666 sync_c = node.getAttribute('sync-c')
667 if not sync_c:
668 d.sync_c = False
669 else:
670 d.sync_c = sync_c.lower() in ("yes", "true", "1")
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800671
672 sync_s = node.getAttribute('sync-s')
673 if not sync_s:
674 d.sync_s = False
675 else:
676 d.sync_s = sync_s.lower() in ("yes", "true", "1")
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700677 return d
678
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700679 def _ParseNotice(self, node):
680 """
681 reads a <notice> element from the manifest file
682
683 The <notice> element is distinct from other tags in the XML in that the
684 data is conveyed between the start and end tag (it's not an empty-element
685 tag).
686
687 The white space (carriage returns, indentation) for the notice element is
688 relevant and is parsed in a way that is based on how python docstrings work.
689 In fact, the code is remarkably similar to here:
690 http://www.python.org/dev/peps/pep-0257/
691 """
692 # Get the data out of the node...
693 notice = node.childNodes[0].data
694
695 # Figure out minimum indentation, skipping the first line (the same line
696 # as the <notice> tag)...
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530697 minIndent = sys.maxsize
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700698 lines = notice.splitlines()
699 for line in lines[1:]:
700 lstrippedLine = line.lstrip()
701 if lstrippedLine:
702 indent = len(line) - len(lstrippedLine)
703 minIndent = min(indent, minIndent)
704
705 # Strip leading / trailing blank lines and also indentation.
706 cleanLines = [lines[0].strip()]
707 for line in lines[1:]:
708 cleanLines.append(line[minIndent:].rstrip())
709
710 # Clear completely blank lines from front and back...
711 while cleanLines and not cleanLines[0]:
712 del cleanLines[0]
713 while cleanLines and not cleanLines[-1]:
714 del cleanLines[-1]
715
716 return '\n'.join(cleanLines)
717
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800718 def _JoinName(self, parent_name, name):
719 return os.path.join(parent_name, name)
720
721 def _UnjoinName(self, parent_name, name):
722 return os.path.relpath(name, parent_name)
723
Simran Basib9a1b732015-08-20 12:19:28 -0700724 def _ParseProject(self, node, parent = None, **extra_proj_attrs):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700725 """
726 reads a <project> element from the manifest file
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700727 """
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700728 name = self._reqatt(node, 'name')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800729 if parent:
730 name = self._JoinName(parent.name, name)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700731
732 remote = self._get_remote(node)
733 if remote is None:
734 remote = self._default.remote
735 if remote is None:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530736 raise ManifestParseError("no remote for project %s within %s" %
737 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700738
Anthony King36ea2fb2014-05-06 11:54:01 +0100739 revisionExpr = node.getAttribute('revision') or remote.revision
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700740 if not revisionExpr:
741 revisionExpr = self._default.revisionExpr
742 if not revisionExpr:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530743 raise ManifestParseError("no revision for project %s within %s" %
744 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700745
746 path = node.getAttribute('path')
747 if not path:
748 path = name
749 if path.startswith('/'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530750 raise ManifestParseError("project %s path cannot be absolute in %s" %
751 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700752
Mike Pontillod3153822012-02-28 11:53:24 -0800753 rebase = node.getAttribute('rebase')
754 if not rebase:
755 rebase = True
756 else:
757 rebase = rebase.lower() in ("yes", "true", "1")
758
Anatol Pomazau79770d22012-04-20 14:41:59 -0700759 sync_c = node.getAttribute('sync-c')
760 if not sync_c:
761 sync_c = False
762 else:
763 sync_c = sync_c.lower() in ("yes", "true", "1")
764
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800765 sync_s = node.getAttribute('sync-s')
766 if not sync_s:
767 sync_s = self._default.sync_s
768 else:
769 sync_s = sync_s.lower() in ("yes", "true", "1")
770
David Pursehouseede7f122012-11-27 22:25:30 +0900771 clone_depth = node.getAttribute('clone-depth')
772 if clone_depth:
773 try:
774 clone_depth = int(clone_depth)
775 if clone_depth <= 0:
776 raise ValueError()
777 except ValueError:
778 raise ManifestParseError('invalid clone-depth %s in %s' %
779 (clone_depth, self.manifestFile))
780
Bryan Jacobsf609f912013-05-06 13:36:24 -0400781 dest_branch = node.getAttribute('dest-branch') or self._default.destBranchExpr
782
Brian Harring14a66742012-09-28 20:21:57 -0700783 upstream = node.getAttribute('upstream')
784
Conley Owens971de8e2012-04-16 10:36:08 -0700785 groups = ''
786 if node.hasAttribute('groups'):
787 groups = node.getAttribute('groups')
Josh Triplett884a3872014-06-12 14:57:29 -0700788 groups = self._ParseGroups(groups)
Brian Harring7da13142012-06-15 02:24:20 -0700789
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800790 if parent is None:
David James8d201162013-10-11 17:03:19 -0700791 relpath, worktree, gitdir, objdir = self.GetProjectPaths(name, path)
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700792 else:
David James8d201162013-10-11 17:03:19 -0700793 relpath, worktree, gitdir, objdir = \
794 self.GetSubprojectPaths(parent, name, path)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800795
796 default_groups = ['all', 'name:%s' % name, 'path:%s' % relpath]
797 groups.extend(set(default_groups).difference(groups))
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700798
Scott Fandb83b1b2013-02-28 09:34:14 +0800799 if self.IsMirror and node.hasAttribute('force-path'):
800 if node.getAttribute('force-path').lower() in ("yes", "true", "1"):
801 gitdir = os.path.join(self.topdir, '%s.git' % path)
802
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700803 project = Project(manifest = self,
804 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700805 remote = remote.ToRemoteSpec(name),
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700806 gitdir = gitdir,
David James8d201162013-10-11 17:03:19 -0700807 objdir = objdir,
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700808 worktree = worktree,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800809 relpath = relpath,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700810 revisionExpr = revisionExpr,
Mike Pontillod3153822012-02-28 11:53:24 -0800811 revisionId = None,
Colin Cross5acde752012-03-28 20:15:45 -0700812 rebase = rebase,
Anatol Pomazau79770d22012-04-20 14:41:59 -0700813 groups = groups,
Brian Harring14a66742012-09-28 20:21:57 -0700814 sync_c = sync_c,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800815 sync_s = sync_s,
David Pursehouseede7f122012-11-27 22:25:30 +0900816 clone_depth = clone_depth,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800817 upstream = upstream,
Bryan Jacobsf609f912013-05-06 13:36:24 -0400818 parent = parent,
Simran Basib9a1b732015-08-20 12:19:28 -0700819 dest_branch = dest_branch,
820 **extra_proj_attrs)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700821
822 for n in node.childNodes:
Shawn O. Pearce242b5262009-05-19 13:00:29 -0700823 if n.nodeName == 'copyfile':
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700824 self._ParseCopyFile(project, n)
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500825 if n.nodeName == 'linkfile':
826 self._ParseLinkFile(project, n)
James W. Mills24c13082012-04-12 15:04:13 -0500827 if n.nodeName == 'annotation':
828 self._ParseAnnotation(project, n)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800829 if n.nodeName == 'project':
830 project.subprojects.append(self._ParseProject(n, parent = project))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700831
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700832 return project
833
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800834 def GetProjectPaths(self, name, path):
835 relpath = path
836 if self.IsMirror:
837 worktree = None
838 gitdir = os.path.join(self.topdir, '%s.git' % name)
David James8d201162013-10-11 17:03:19 -0700839 objdir = gitdir
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800840 else:
841 worktree = os.path.join(self.topdir, path).replace('\\', '/')
842 gitdir = os.path.join(self.repodir, 'projects', '%s.git' % path)
David James8d201162013-10-11 17:03:19 -0700843 objdir = os.path.join(self.repodir, 'project-objects', '%s.git' % name)
844 return relpath, worktree, gitdir, objdir
845
846 def GetProjectsWithName(self, name):
847 return self._projects.get(name, [])
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800848
849 def GetSubprojectName(self, parent, submodule_path):
850 return os.path.join(parent.name, submodule_path)
851
852 def _JoinRelpath(self, parent_relpath, relpath):
853 return os.path.join(parent_relpath, relpath)
854
855 def _UnjoinRelpath(self, parent_relpath, relpath):
856 return os.path.relpath(relpath, parent_relpath)
857
David James8d201162013-10-11 17:03:19 -0700858 def GetSubprojectPaths(self, parent, name, path):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800859 relpath = self._JoinRelpath(parent.relpath, path)
860 gitdir = os.path.join(parent.gitdir, 'subprojects', '%s.git' % path)
David James8d201162013-10-11 17:03:19 -0700861 objdir = os.path.join(parent.gitdir, 'subproject-objects', '%s.git' % name)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800862 if self.IsMirror:
863 worktree = None
864 else:
865 worktree = os.path.join(parent.worktree, path).replace('\\', '/')
David James8d201162013-10-11 17:03:19 -0700866 return relpath, worktree, gitdir, objdir
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800867
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700868 def _ParseCopyFile(self, project, node):
869 src = self._reqatt(node, 'src')
870 dest = self._reqatt(node, 'dest')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800871 if not self.IsMirror:
872 # src is project relative;
873 # dest is relative to the top of the tree
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800874 project.AddCopyFile(src, dest, os.path.join(self.topdir, dest))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700875
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500876 def _ParseLinkFile(self, project, node):
877 src = self._reqatt(node, 'src')
878 dest = self._reqatt(node, 'dest')
879 if not self.IsMirror:
880 # src is project relative;
881 # dest is relative to the top of the tree
882 project.AddLinkFile(src, dest, os.path.join(self.topdir, dest))
883
James W. Mills24c13082012-04-12 15:04:13 -0500884 def _ParseAnnotation(self, project, node):
885 name = self._reqatt(node, 'name')
886 value = self._reqatt(node, 'value')
887 try:
888 keep = self._reqatt(node, 'keep').lower()
889 except ManifestParseError:
890 keep = "true"
891 if keep != "true" and keep != "false":
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530892 raise ManifestParseError('optional "keep" attribute must be '
893 '"true" or "false"')
James W. Mills24c13082012-04-12 15:04:13 -0500894 project.AddAnnotation(name, value, keep)
895
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700896 def _get_remote(self, node):
897 name = node.getAttribute('remote')
898 if not name:
899 return None
900
901 v = self._remotes.get(name)
902 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530903 raise ManifestParseError("remote %s not defined in %s" %
904 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700905 return v
906
907 def _reqatt(self, node, attname):
908 """
909 reads a required attribute from the node.
910 """
911 v = node.getAttribute(attname)
912 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530913 raise ManifestParseError("no %s in <%s> within %s" %
914 (attname, node.nodeName, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700915 return v
Julien Camperguedd654222014-01-09 16:21:37 +0100916
917 def projectsDiff(self, manifest):
918 """return the projects differences between two manifests.
919
920 The diff will be from self to given manifest.
921
922 """
923 fromProjects = self.paths
924 toProjects = manifest.paths
925
Anthony King7446c592014-05-06 09:19:39 +0100926 fromKeys = sorted(fromProjects.keys())
927 toKeys = sorted(toProjects.keys())
Julien Camperguedd654222014-01-09 16:21:37 +0100928
929 diff = {'added': [], 'removed': [], 'changed': [], 'unreachable': []}
930
931 for proj in fromKeys:
932 if not proj in toKeys:
933 diff['removed'].append(fromProjects[proj])
934 else:
935 fromProj = fromProjects[proj]
936 toProj = toProjects[proj]
937 try:
938 fromRevId = fromProj.GetCommitRevisionId()
939 toRevId = toProj.GetCommitRevisionId()
940 except ManifestInvalidRevisionError:
941 diff['unreachable'].append((fromProj, toProj))
942 else:
943 if fromRevId != toRevId:
944 diff['changed'].append((fromProj, toProj))
945 toKeys.remove(proj)
946
947 for proj in toKeys:
948 diff['added'].append(toProjects[proj])
949
950 return diff
Simran Basib9a1b732015-08-20 12:19:28 -0700951
952
953class GitcManifest(XmlManifest):
954
955 def __init__(self, repodir, gitc_client_name):
956 """Initialize the GitcManifest object."""
957 super(GitcManifest, self).__init__(repodir)
958 self.isGitcClient = True
959 self.gitc_client_name = gitc_client_name
Simran Basi8ce50412015-08-28 14:25:44 -0700960 self.gitc_client_dir = os.path.join(gitc_utils.get_gitc_manifest_dir(),
Simran Basib9a1b732015-08-20 12:19:28 -0700961 gitc_client_name)
962 self.manifestFile = os.path.join(self.gitc_client_dir, '.manifest')
963
964 def _ParseProject(self, node, parent = None):
965 """Override _ParseProject and add support for GITC specific attributes."""
966 return super(GitcManifest, self)._ParseProject(
967 node, parent=parent, old_revision=node.getAttribute('old-revision'))
968
969 def _output_manifest_project_extras(self, p, e):
970 """Output GITC Specific Project attributes"""
971 if p.old_revision:
972 e.setAttribute('old-revision', str(p.old_revision))
973