blob: a7fe8ddf7c75a07a6036ffb532f70f6bcd7c2632 [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 Willemsen03755232015-09-09 21:43:32 +0000170 def Save(self, fd, peg_rev=False, peg_rev_upstream=True):
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 Willemsen03755232015-09-09 21:43:32 +0000175 groups = mp.config.GetString('manifest.groups')
Matt Gumbel0c635bb2012-12-21 10:14:53 -0800176 if groups:
Josh Triplett884a3872014-06-12 14:57:29 -0700177 groups = self._ParseGroups(groups)
Colin Cross5acde752012-03-28 20:15:45 -0700178
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800179 doc = xml.dom.minidom.Document()
180 root = doc.createElement('manifest')
181 doc.appendChild(root)
182
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700183 # Save out the notice. There's a little bit of work here to give it the
184 # right whitespace, which assumes that the notice is automatically indented
185 # by 4 by minidom.
186 if self.notice:
187 notice_element = root.appendChild(doc.createElement('notice'))
188 notice_lines = self.notice.splitlines()
189 indented_notice = ('\n'.join(" "*4 + line for line in notice_lines))[4:]
190 notice_element.appendChild(doc.createTextNode(indented_notice))
191
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800192 d = self.default
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800193
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530194 for r in sorted(self.remotes):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800195 self._RemoteToXml(self.remotes[r], doc, root)
196 if self.remotes:
197 root.appendChild(doc.createTextNode(''))
198
199 have_default = False
200 e = doc.createElement('default')
201 if d.remote:
202 have_default = True
203 e.setAttribute('remote', d.remote.name)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700204 if d.revisionExpr:
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800205 have_default = True
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700206 e.setAttribute('revision', d.revisionExpr)
Simon Ruggier7e59de22015-07-24 12:50:06 +0200207 if d.destBranchExpr:
208 have_default = True
209 e.setAttribute('dest-branch', d.destBranchExpr)
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700210 if d.sync_j > 1:
211 have_default = True
212 e.setAttribute('sync-j', '%d' % d.sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700213 if d.sync_c:
214 have_default = True
215 e.setAttribute('sync-c', 'true')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800216 if d.sync_s:
217 have_default = True
218 e.setAttribute('sync-s', 'true')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800219 if have_default:
220 root.appendChild(e)
221 root.appendChild(doc.createTextNode(''))
222
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700223 if self._manifest_server:
224 e = doc.createElement('manifest-server')
225 e.setAttribute('url', self._manifest_server)
226 root.appendChild(e)
227 root.appendChild(doc.createTextNode(''))
228
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800229 def output_projects(parent, parent_node, projects):
David James8d201162013-10-11 17:03:19 -0700230 for project_name in projects:
231 for project in self._projects[project_name]:
232 output_project(parent, parent_node, project)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800233
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800234 def output_project(parent, parent_node, p):
Colin Cross5acde752012-03-28 20:15:45 -0700235 if not p.MatchesGroups(groups):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800236 return
237
238 name = p.name
239 relpath = p.relpath
240 if parent:
241 name = self._UnjoinName(parent.name, name)
242 relpath = self._UnjoinRelpath(parent.relpath, relpath)
Colin Cross5acde752012-03-28 20:15:45 -0700243
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800244 e = doc.createElement('project')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800245 parent_node.appendChild(e)
246 e.setAttribute('name', name)
247 if relpath != name:
248 e.setAttribute('path', relpath)
Conley Owensa17d7af2013-10-16 14:38:09 -0700249 remoteName = None
250 if d.remote:
Conley Owensce201a52013-10-16 14:42:42 -0700251 remoteName = d.remote.remoteAlias or d.remote.name
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700252 if not d.remote or p.remote.name != remoteName:
Anthony King36ea2fb2014-05-06 11:54:01 +0100253 remoteName = p.remote.name
254 e.setAttribute('remote', remoteName)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800255 if peg_rev:
256 if self.IsMirror:
Brian Harring14a66742012-09-28 20:21:57 -0700257 value = p.bare_git.rev_parse(p.revisionExpr + '^0')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800258 else:
Brian Harring14a66742012-09-28 20:21:57 -0700259 value = p.work_git.rev_parse(HEAD + '^0')
260 e.setAttribute('revision', value)
Conley Owens551dfec2015-07-10 14:54:54 -0700261 if peg_rev_upstream:
262 if p.upstream:
263 e.setAttribute('upstream', p.upstream)
264 elif value != p.revisionExpr:
265 # Only save the origin if the origin is not a sha1, and the default
266 # isn't our value
267 e.setAttribute('upstream', p.revisionExpr)
Anthony King36ea2fb2014-05-06 11:54:01 +0100268 else:
269 revision = self.remotes[remoteName].revision or d.revisionExpr
270 if not revision or revision != p.revisionExpr:
271 e.setAttribute('revision', p.revisionExpr)
Mani Chandel7a91d512014-07-24 16:27:08 +0530272 if p.upstream and p.upstream != p.revisionExpr:
273 e.setAttribute('upstream', p.upstream)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800274
Simon Ruggier7e59de22015-07-24 12:50:06 +0200275 if p.dest_branch and p.dest_branch != d.destBranchExpr:
276 e.setAttribute('dest-branch', p.dest_branch)
277
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800278 for c in p.copyfiles:
279 ce = doc.createElement('copyfile')
280 ce.setAttribute('src', c.src)
281 ce.setAttribute('dest', c.dest)
282 e.appendChild(ce)
283
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500284 for l in p.linkfiles:
285 le = doc.createElement('linkfile')
286 le.setAttribute('src', l.src)
287 le.setAttribute('dest', l.dest)
288 e.appendChild(le)
289
Conley Owensbb1b5f52012-08-13 13:11:18 -0700290 default_groups = ['all', 'name:%s' % p.name, 'path:%s' % p.relpath]
Dmitry Fink17f85ea2012-08-06 14:52:29 -0700291 egroups = [g for g in p.groups if g not in default_groups]
Conley Owens971de8e2012-04-16 10:36:08 -0700292 if egroups:
293 e.setAttribute('groups', ','.join(egroups))
Colin Cross5acde752012-03-28 20:15:45 -0700294
James W. Mills24c13082012-04-12 15:04:13 -0500295 for a in p.annotations:
296 if a.keep == "true":
297 ae = doc.createElement('annotation')
298 ae.setAttribute('name', a.name)
299 ae.setAttribute('value', a.value)
300 e.appendChild(ae)
301
Anatol Pomazau79770d22012-04-20 14:41:59 -0700302 if p.sync_c:
303 e.setAttribute('sync-c', 'true')
304
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800305 if p.sync_s:
306 e.setAttribute('sync-s', 'true')
307
Dan Willemsen88409222015-08-17 15:29:10 -0700308 if p.clone_depth:
309 e.setAttribute('clone-depth', str(p.clone_depth))
310
Simran Basib9a1b732015-08-20 12:19:28 -0700311 self._output_manifest_project_extras(p, e)
312
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800313 if p.subprojects:
David James8d201162013-10-11 17:03:19 -0700314 subprojects = set(subp.name for subp in p.subprojects)
315 output_projects(p, e, list(sorted(subprojects)))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800316
David James8d201162013-10-11 17:03:19 -0700317 projects = set(p.name for p in self._paths.values() if not p.parent)
318 output_projects(None, root, list(sorted(projects)))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800319
Doug Anderson37282b42011-03-04 11:54:18 -0800320 if self._repo_hooks_project:
321 root.appendChild(doc.createTextNode(''))
322 e = doc.createElement('repo-hooks')
323 e.setAttribute('in-project', self._repo_hooks_project.name)
324 e.setAttribute('enabled-list',
325 ' '.join(self._repo_hooks_project.enabled_repo_hooks))
326 root.appendChild(e)
327
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800328 doc.writexml(fd, '', ' ', '\n', 'UTF-8')
329
Simran Basib9a1b732015-08-20 12:19:28 -0700330 def _output_manifest_project_extras(self, p, e):
331 """Manifests can modify e if they support extra project attributes."""
332 pass
333
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700334 @property
David James8d201162013-10-11 17:03:19 -0700335 def paths(self):
336 self._Load()
337 return self._paths
338
339 @property
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700340 def projects(self):
341 self._Load()
Anthony Kingd58bfe52014-05-05 23:30:49 +0100342 return list(self._paths.values())
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700343
344 @property
345 def remotes(self):
346 self._Load()
347 return self._remotes
348
349 @property
350 def default(self):
351 self._Load()
352 return self._default
353
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800354 @property
Doug Anderson37282b42011-03-04 11:54:18 -0800355 def repo_hooks_project(self):
356 self._Load()
357 return self._repo_hooks_project
358
359 @property
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700360 def notice(self):
361 self._Load()
362 return self._notice
363
364 @property
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700365 def manifest_server(self):
366 self._Load()
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -0800367 return self._manifest_server
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700368
369 @property
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800370 def IsMirror(self):
371 return self.manifestProject.config.GetBoolean('repo.mirror')
372
Julien Campergue335f5ef2013-10-16 11:02:35 +0200373 @property
374 def IsArchive(self):
375 return self.manifestProject.config.GetBoolean('repo.archive')
376
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700377 def _Unload(self):
378 self._loaded = False
379 self._projects = {}
David James8d201162013-10-11 17:03:19 -0700380 self._paths = {}
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700381 self._remotes = {}
382 self._default = None
Doug Anderson37282b42011-03-04 11:54:18 -0800383 self._repo_hooks_project = None
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700384 self._notice = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700385 self.branch = None
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700386 self._manifest_server = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700387
388 def _Load(self):
389 if not self._loaded:
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800390 m = self.manifestProject
391 b = m.GetBranch(m.CurrentBranch).merge
Shawn O. Pearce21c5c342009-06-25 16:47:30 -0700392 if b is not None and b.startswith(R_HEADS):
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800393 b = b[len(R_HEADS):]
394 self.branch = b
395
Colin Cross23acdd32012-04-21 00:33:54 -0700396 nodes = []
Brian Harring475a47d2012-06-07 20:05:35 -0700397 nodes.append(self._ParseManifestXml(self.manifestFile,
398 self.manifestProject.worktree))
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700399
400 local = os.path.join(self.repodir, LOCAL_MANIFEST_NAME)
401 if os.path.exists(local):
David Pursehouse4eb285c2013-02-14 16:28:44 +0900402 if not self.localManifestWarning:
403 self.localManifestWarning = True
404 print('warning: %s is deprecated; put local manifests in `%s` instead'
405 % (LOCAL_MANIFEST_NAME, os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME)),
406 file=sys.stderr)
Brian Harring475a47d2012-06-07 20:05:35 -0700407 nodes.append(self._ParseManifestXml(local, self.repodir))
Colin Cross23acdd32012-04-21 00:33:54 -0700408
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900409 local_dir = os.path.abspath(os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME))
410 try:
David Pursehouse52f1e5d2012-11-14 04:53:24 +0900411 for local_file in sorted(os.listdir(local_dir)):
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900412 if local_file.endswith('.xml'):
David Pursehouse5f434ed2012-11-22 13:48:10 +0900413 local = os.path.join(local_dir, local_file)
414 nodes.append(self._ParseManifestXml(local, self.repodir))
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900415 except OSError:
416 pass
417
Joe Onorato26e24752013-01-11 12:35:53 -0800418 try:
419 self._ParseManifest(nodes)
420 except ManifestParseError as e:
421 # There was a problem parsing, unload ourselves in case they catch
422 # this error and try again later, we will show the correct error
423 self._Unload()
424 raise e
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700425
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800426 if self.IsMirror:
427 self._AddMetaProjectMirror(self.repoProject)
428 self._AddMetaProjectMirror(self.manifestProject)
429
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700430 self._loaded = True
431
Brian Harring475a47d2012-06-07 20:05:35 -0700432 def _ParseManifestXml(self, path, include_root):
David Pursehousef7fc8a92012-11-13 04:00:28 +0900433 try:
434 root = xml.dom.minidom.parse(path)
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900435 except (OSError, xml.parsers.expat.ExpatError) as e:
David Pursehousef7fc8a92012-11-13 04:00:28 +0900436 raise ManifestParseError("error parsing manifest %s: %s" % (path, e))
437
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700438 if not root or not root.childNodes:
Brian Harring26448742011-04-28 05:04:41 -0700439 raise ManifestParseError("no root node in %s" % (path,))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700440
Jooncheol Park34acdd22012-08-27 02:25:59 +0900441 for manifest in root.childNodes:
442 if manifest.nodeName == 'manifest':
443 break
444 else:
Brian Harring26448742011-04-28 05:04:41 -0700445 raise ManifestParseError("no <manifest> in %s" % (path,))
446
Colin Cross23acdd32012-04-21 00:33:54 -0700447 nodes = []
David Pursehouse4f7bdea2012-10-22 12:50:15 +0900448 for node in manifest.childNodes: # pylint:disable=W0631
David Pursehouse5c6eeac2012-10-11 16:44:48 +0900449 # We only get here if manifest is initialised
David Pursehousec1b86a22012-11-14 11:36:51 +0900450 if node.nodeName == 'include':
451 name = self._reqatt(node, 'name')
452 fp = os.path.join(include_root, name)
453 if not os.path.isfile(fp):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530454 raise ManifestParseError("include %s doesn't exist or isn't a file"
455 % (name,))
David Pursehousec1b86a22012-11-14 11:36:51 +0900456 try:
457 nodes.extend(self._ParseManifestXml(fp, include_root))
458 # should isolate this to the exact exception, but that's
459 # tricky. actual parsing implementation may vary.
460 except (KeyboardInterrupt, RuntimeError, SystemExit):
461 raise
462 except Exception as e:
463 raise ManifestParseError(
464 "failed parsing included manifest %s: %s", (name, e))
465 else:
466 nodes.append(node)
Colin Cross23acdd32012-04-21 00:33:54 -0700467 return nodes
Brian Harring26448742011-04-28 05:04:41 -0700468
Colin Cross23acdd32012-04-21 00:33:54 -0700469 def _ParseManifest(self, node_list):
470 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700471 if node.nodeName == 'remote':
472 remote = self._ParseRemote(node)
David Pursehouse717ece92012-11-13 08:49:16 +0900473 if remote:
474 if remote.name in self._remotes:
475 if remote != self._remotes[remote.name]:
476 raise ManifestParseError(
477 'remote %s already exists with different attributes' %
478 (remote.name))
479 else:
480 self._remotes[remote.name] = remote
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700481
Colin Cross23acdd32012-04-21 00:33:54 -0700482 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700483 if node.nodeName == 'default':
Julien Campergue74879922013-10-09 14:38:46 +0200484 new_default = self._ParseDefault(node)
485 if self._default is None:
486 self._default = new_default
487 elif new_default != self._default:
David Pursehouse37128b62013-10-15 10:48:40 +0900488 raise ManifestParseError('duplicate default in %s' %
489 (self.manifestFile))
Julien Campergue74879922013-10-09 14:38:46 +0200490
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700491 if self._default is None:
492 self._default = _Default()
493
Colin Cross23acdd32012-04-21 00:33:54 -0700494 for node in itertools.chain(*node_list):
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700495 if node.nodeName == 'notice':
496 if self._notice is not None:
Doug Anderson37282b42011-03-04 11:54:18 -0800497 raise ManifestParseError(
498 'duplicate notice in %s' %
499 (self.manifestFile))
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700500 self._notice = self._ParseNotice(node)
501
Colin Cross23acdd32012-04-21 00:33:54 -0700502 for node in itertools.chain(*node_list):
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700503 if node.nodeName == 'manifest-server':
504 url = self._reqatt(node, 'url')
505 if self._manifest_server is not None:
David Pursehousec1b86a22012-11-14 11:36:51 +0900506 raise ManifestParseError(
507 'duplicate manifest-server in %s' %
508 (self.manifestFile))
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700509 self._manifest_server = url
510
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800511 def recursively_add_projects(project):
David James8d201162013-10-11 17:03:19 -0700512 projects = self._projects.setdefault(project.name, [])
513 if project.relpath is None:
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800514 raise ManifestParseError(
David James8d201162013-10-11 17:03:19 -0700515 'missing path for %s in %s' %
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800516 (project.name, self.manifestFile))
David James8d201162013-10-11 17:03:19 -0700517 if project.relpath in self._paths:
518 raise ManifestParseError(
519 'duplicate path %s in %s' %
520 (project.relpath, self.manifestFile))
521 self._paths[project.relpath] = project
522 projects.append(project)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800523 for subproject in project.subprojects:
524 recursively_add_projects(subproject)
525
Colin Cross23acdd32012-04-21 00:33:54 -0700526 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700527 if node.nodeName == 'project':
528 project = self._ParseProject(node)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800529 recursively_add_projects(project)
Josh Triplett884a3872014-06-12 14:57:29 -0700530 if node.nodeName == 'extend-project':
531 name = self._reqatt(node, 'name')
532
533 if name not in self._projects:
534 raise ManifestParseError('extend-project element specifies non-existent '
535 'project: %s' % name)
536
537 path = node.getAttribute('path')
538 groups = node.getAttribute('groups')
539 if groups:
540 groups = self._ParseGroups(groups)
541
542 for p in self._projects[name]:
543 if path and p.relpath != path:
544 continue
545 if groups:
546 p.groups.extend(groups)
Doug Anderson37282b42011-03-04 11:54:18 -0800547 if node.nodeName == 'repo-hooks':
548 # Get the name of the project and the (space-separated) list of enabled.
549 repo_hooks_project = self._reqatt(node, 'in-project')
550 enabled_repo_hooks = self._reqatt(node, 'enabled-list').split()
551
552 # Only one project can be the hooks project
553 if self._repo_hooks_project is not None:
554 raise ManifestParseError(
555 'duplicate repo-hooks in %s' %
556 (self.manifestFile))
557
558 # Store a reference to the Project.
559 try:
David James8d201162013-10-11 17:03:19 -0700560 repo_hooks_projects = self._projects[repo_hooks_project]
Doug Anderson37282b42011-03-04 11:54:18 -0800561 except KeyError:
562 raise ManifestParseError(
563 'project %s not found for repo-hooks' %
564 (repo_hooks_project))
565
David James8d201162013-10-11 17:03:19 -0700566 if len(repo_hooks_projects) != 1:
567 raise ManifestParseError(
568 'internal error parsing repo-hooks in %s' %
569 (self.manifestFile))
570 self._repo_hooks_project = repo_hooks_projects[0]
571
Doug Anderson37282b42011-03-04 11:54:18 -0800572 # Store the enabled hooks in the Project object.
573 self._repo_hooks_project.enabled_repo_hooks = enabled_repo_hooks
Colin Cross23acdd32012-04-21 00:33:54 -0700574 if node.nodeName == 'remove-project':
575 name = self._reqatt(node, 'name')
David Jamesb8433df2014-01-30 10:11:17 -0800576
577 if name not in self._projects:
David Pursehousef9107482012-11-16 19:12:32 +0900578 raise ManifestParseError('remove-project element specifies non-existent '
579 'project: %s' % name)
Colin Cross23acdd32012-04-21 00:33:54 -0700580
David Jamesb8433df2014-01-30 10:11:17 -0800581 for p in self._projects[name]:
582 del self._paths[p.relpath]
583 del self._projects[name]
584
Colin Cross23acdd32012-04-21 00:33:54 -0700585 # If the manifest removes the hooks project, treat it as if it deleted
586 # the repo-hooks element too.
587 if self._repo_hooks_project and (self._repo_hooks_project.name == name):
588 self._repo_hooks_project = None
589
Doug Anderson37282b42011-03-04 11:54:18 -0800590
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800591 def _AddMetaProjectMirror(self, m):
592 name = None
593 m_url = m.GetRemote(m.remote.name).url
594 if m_url.endswith('/.git'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530595 raise ManifestParseError('refusing to mirror %s' % m_url)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800596
597 if self._default and self._default.remote:
Conley Owensceea3682011-10-20 10:45:47 -0700598 url = self._default.remote.resolvedFetchUrl
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800599 if not url.endswith('/'):
600 url += '/'
601 if m_url.startswith(url):
602 remote = self._default.remote
603 name = m_url[len(url):]
604
605 if name is None:
606 s = m_url.rindex('/') + 1
Conley Owensdb728cd2011-09-26 16:34:01 -0700607 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Shawn O. Pearcef35b2d92012-08-02 11:46:22 -0700608 remote = _XmlRemote('origin', fetch=m_url[:s], manifestUrl=manifestUrl)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800609 name = m_url[s:]
610
611 if name.endswith('.git'):
612 name = name[:-4]
613
614 if name not in self._projects:
615 m.PreSync()
616 gitdir = os.path.join(self.topdir, '%s.git' % name)
617 project = Project(manifest = self,
618 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700619 remote = remote.ToRemoteSpec(name),
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800620 gitdir = gitdir,
David James8d201162013-10-11 17:03:19 -0700621 objdir = gitdir,
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800622 worktree = None,
Kwanhong Leeccd218c2014-02-17 13:07:32 +0900623 relpath = name or None,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700624 revisionExpr = m.revisionExpr,
625 revisionId = None)
David James8d201162013-10-11 17:03:19 -0700626 self._projects[project.name] = [project]
Kwanhong Leeccd218c2014-02-17 13:07:32 +0900627 self._paths[project.relpath] = project
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800628
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700629 def _ParseRemote(self, node):
630 """
631 reads a <remote> element from the manifest file
632 """
633 name = self._reqatt(node, 'name')
Yestin Sunb292b982012-07-02 07:32:50 -0700634 alias = node.getAttribute('alias')
635 if alias == '':
636 alias = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700637 fetch = self._reqatt(node, 'fetch')
638 review = node.getAttribute('review')
Shawn O. Pearceae6e0942008-11-06 10:25:35 -0800639 if review == '':
640 review = None
Anthony King36ea2fb2014-05-06 11:54:01 +0100641 revision = node.getAttribute('revision')
642 if revision == '':
643 revision = None
Conley Owensdb728cd2011-09-26 16:34:01 -0700644 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Jonathan Nieder93719792015-03-17 11:29:58 -0700645 return _XmlRemote(name, alias, fetch, manifestUrl, review, revision)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700646
647 def _ParseDefault(self, node):
648 """
649 reads a <default> element from the manifest file
650 """
651 d = _Default()
652 d.remote = self._get_remote(node)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700653 d.revisionExpr = node.getAttribute('revision')
654 if d.revisionExpr == '':
655 d.revisionExpr = None
Anatol Pomazau79770d22012-04-20 14:41:59 -0700656
Bryan Jacobsf609f912013-05-06 13:36:24 -0400657 d.destBranchExpr = node.getAttribute('dest-branch') or None
658
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700659 sync_j = node.getAttribute('sync-j')
660 if sync_j == '' or sync_j is None:
661 d.sync_j = 1
662 else:
663 d.sync_j = int(sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700664
665 sync_c = node.getAttribute('sync-c')
666 if not sync_c:
667 d.sync_c = False
668 else:
669 d.sync_c = sync_c.lower() in ("yes", "true", "1")
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800670
671 sync_s = node.getAttribute('sync-s')
672 if not sync_s:
673 d.sync_s = False
674 else:
675 d.sync_s = sync_s.lower() in ("yes", "true", "1")
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700676 return d
677
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700678 def _ParseNotice(self, node):
679 """
680 reads a <notice> element from the manifest file
681
682 The <notice> element is distinct from other tags in the XML in that the
683 data is conveyed between the start and end tag (it's not an empty-element
684 tag).
685
686 The white space (carriage returns, indentation) for the notice element is
687 relevant and is parsed in a way that is based on how python docstrings work.
688 In fact, the code is remarkably similar to here:
689 http://www.python.org/dev/peps/pep-0257/
690 """
691 # Get the data out of the node...
692 notice = node.childNodes[0].data
693
694 # Figure out minimum indentation, skipping the first line (the same line
695 # as the <notice> tag)...
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530696 minIndent = sys.maxsize
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700697 lines = notice.splitlines()
698 for line in lines[1:]:
699 lstrippedLine = line.lstrip()
700 if lstrippedLine:
701 indent = len(line) - len(lstrippedLine)
702 minIndent = min(indent, minIndent)
703
704 # Strip leading / trailing blank lines and also indentation.
705 cleanLines = [lines[0].strip()]
706 for line in lines[1:]:
707 cleanLines.append(line[minIndent:].rstrip())
708
709 # Clear completely blank lines from front and back...
710 while cleanLines and not cleanLines[0]:
711 del cleanLines[0]
712 while cleanLines and not cleanLines[-1]:
713 del cleanLines[-1]
714
715 return '\n'.join(cleanLines)
716
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800717 def _JoinName(self, parent_name, name):
718 return os.path.join(parent_name, name)
719
720 def _UnjoinName(self, parent_name, name):
721 return os.path.relpath(name, parent_name)
722
Simran Basib9a1b732015-08-20 12:19:28 -0700723 def _ParseProject(self, node, parent = None, **extra_proj_attrs):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700724 """
725 reads a <project> element from the manifest file
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700726 """
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700727 name = self._reqatt(node, 'name')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800728 if parent:
729 name = self._JoinName(parent.name, name)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700730
731 remote = self._get_remote(node)
732 if remote is None:
733 remote = self._default.remote
734 if remote is None:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530735 raise ManifestParseError("no remote for project %s within %s" %
736 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700737
Anthony King36ea2fb2014-05-06 11:54:01 +0100738 revisionExpr = node.getAttribute('revision') or remote.revision
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700739 if not revisionExpr:
740 revisionExpr = self._default.revisionExpr
741 if not revisionExpr:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530742 raise ManifestParseError("no revision for project %s within %s" %
743 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700744
745 path = node.getAttribute('path')
746 if not path:
747 path = name
748 if path.startswith('/'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530749 raise ManifestParseError("project %s path cannot be absolute in %s" %
750 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700751
Mike Pontillod3153822012-02-28 11:53:24 -0800752 rebase = node.getAttribute('rebase')
753 if not rebase:
754 rebase = True
755 else:
756 rebase = rebase.lower() in ("yes", "true", "1")
757
Anatol Pomazau79770d22012-04-20 14:41:59 -0700758 sync_c = node.getAttribute('sync-c')
759 if not sync_c:
760 sync_c = False
761 else:
762 sync_c = sync_c.lower() in ("yes", "true", "1")
763
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800764 sync_s = node.getAttribute('sync-s')
765 if not sync_s:
766 sync_s = self._default.sync_s
767 else:
768 sync_s = sync_s.lower() in ("yes", "true", "1")
769
David Pursehouseede7f122012-11-27 22:25:30 +0900770 clone_depth = node.getAttribute('clone-depth')
771 if clone_depth:
772 try:
773 clone_depth = int(clone_depth)
774 if clone_depth <= 0:
775 raise ValueError()
776 except ValueError:
777 raise ManifestParseError('invalid clone-depth %s in %s' %
778 (clone_depth, self.manifestFile))
779
Bryan Jacobsf609f912013-05-06 13:36:24 -0400780 dest_branch = node.getAttribute('dest-branch') or self._default.destBranchExpr
781
Brian Harring14a66742012-09-28 20:21:57 -0700782 upstream = node.getAttribute('upstream')
783
Conley Owens971de8e2012-04-16 10:36:08 -0700784 groups = ''
785 if node.hasAttribute('groups'):
786 groups = node.getAttribute('groups')
Josh Triplett884a3872014-06-12 14:57:29 -0700787 groups = self._ParseGroups(groups)
Brian Harring7da13142012-06-15 02:24:20 -0700788
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800789 if parent is None:
David James8d201162013-10-11 17:03:19 -0700790 relpath, worktree, gitdir, objdir = self.GetProjectPaths(name, path)
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700791 else:
David James8d201162013-10-11 17:03:19 -0700792 relpath, worktree, gitdir, objdir = \
793 self.GetSubprojectPaths(parent, name, path)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800794
795 default_groups = ['all', 'name:%s' % name, 'path:%s' % relpath]
796 groups.extend(set(default_groups).difference(groups))
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700797
Scott Fandb83b1b2013-02-28 09:34:14 +0800798 if self.IsMirror and node.hasAttribute('force-path'):
799 if node.getAttribute('force-path').lower() in ("yes", "true", "1"):
800 gitdir = os.path.join(self.topdir, '%s.git' % path)
801
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700802 project = Project(manifest = self,
803 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700804 remote = remote.ToRemoteSpec(name),
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700805 gitdir = gitdir,
David James8d201162013-10-11 17:03:19 -0700806 objdir = objdir,
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700807 worktree = worktree,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800808 relpath = relpath,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700809 revisionExpr = revisionExpr,
Mike Pontillod3153822012-02-28 11:53:24 -0800810 revisionId = None,
Colin Cross5acde752012-03-28 20:15:45 -0700811 rebase = rebase,
Anatol Pomazau79770d22012-04-20 14:41:59 -0700812 groups = groups,
Brian Harring14a66742012-09-28 20:21:57 -0700813 sync_c = sync_c,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800814 sync_s = sync_s,
David Pursehouseede7f122012-11-27 22:25:30 +0900815 clone_depth = clone_depth,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800816 upstream = upstream,
Bryan Jacobsf609f912013-05-06 13:36:24 -0400817 parent = parent,
Simran Basib9a1b732015-08-20 12:19:28 -0700818 dest_branch = dest_branch,
819 **extra_proj_attrs)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700820
821 for n in node.childNodes:
Shawn O. Pearce242b5262009-05-19 13:00:29 -0700822 if n.nodeName == 'copyfile':
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700823 self._ParseCopyFile(project, n)
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500824 if n.nodeName == 'linkfile':
825 self._ParseLinkFile(project, n)
James W. Mills24c13082012-04-12 15:04:13 -0500826 if n.nodeName == 'annotation':
827 self._ParseAnnotation(project, n)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800828 if n.nodeName == 'project':
829 project.subprojects.append(self._ParseProject(n, parent = project))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700830
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700831 return project
832
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800833 def GetProjectPaths(self, name, path):
834 relpath = path
835 if self.IsMirror:
836 worktree = None
837 gitdir = os.path.join(self.topdir, '%s.git' % name)
David James8d201162013-10-11 17:03:19 -0700838 objdir = gitdir
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800839 else:
840 worktree = os.path.join(self.topdir, path).replace('\\', '/')
841 gitdir = os.path.join(self.repodir, 'projects', '%s.git' % path)
David James8d201162013-10-11 17:03:19 -0700842 objdir = os.path.join(self.repodir, 'project-objects', '%s.git' % name)
843 return relpath, worktree, gitdir, objdir
844
845 def GetProjectsWithName(self, name):
846 return self._projects.get(name, [])
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800847
848 def GetSubprojectName(self, parent, submodule_path):
849 return os.path.join(parent.name, submodule_path)
850
851 def _JoinRelpath(self, parent_relpath, relpath):
852 return os.path.join(parent_relpath, relpath)
853
854 def _UnjoinRelpath(self, parent_relpath, relpath):
855 return os.path.relpath(relpath, parent_relpath)
856
David James8d201162013-10-11 17:03:19 -0700857 def GetSubprojectPaths(self, parent, name, path):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800858 relpath = self._JoinRelpath(parent.relpath, path)
859 gitdir = os.path.join(parent.gitdir, 'subprojects', '%s.git' % path)
David James8d201162013-10-11 17:03:19 -0700860 objdir = os.path.join(parent.gitdir, 'subproject-objects', '%s.git' % name)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800861 if self.IsMirror:
862 worktree = None
863 else:
864 worktree = os.path.join(parent.worktree, path).replace('\\', '/')
David James8d201162013-10-11 17:03:19 -0700865 return relpath, worktree, gitdir, objdir
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800866
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700867 def _ParseCopyFile(self, project, node):
868 src = self._reqatt(node, 'src')
869 dest = self._reqatt(node, 'dest')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800870 if not self.IsMirror:
871 # src is project relative;
872 # dest is relative to the top of the tree
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800873 project.AddCopyFile(src, dest, os.path.join(self.topdir, dest))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700874
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500875 def _ParseLinkFile(self, project, node):
876 src = self._reqatt(node, 'src')
877 dest = self._reqatt(node, 'dest')
878 if not self.IsMirror:
879 # src is project relative;
880 # dest is relative to the top of the tree
881 project.AddLinkFile(src, dest, os.path.join(self.topdir, dest))
882
James W. Mills24c13082012-04-12 15:04:13 -0500883 def _ParseAnnotation(self, project, node):
884 name = self._reqatt(node, 'name')
885 value = self._reqatt(node, 'value')
886 try:
887 keep = self._reqatt(node, 'keep').lower()
888 except ManifestParseError:
889 keep = "true"
890 if keep != "true" and keep != "false":
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530891 raise ManifestParseError('optional "keep" attribute must be '
892 '"true" or "false"')
James W. Mills24c13082012-04-12 15:04:13 -0500893 project.AddAnnotation(name, value, keep)
894
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700895 def _get_remote(self, node):
896 name = node.getAttribute('remote')
897 if not name:
898 return None
899
900 v = self._remotes.get(name)
901 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530902 raise ManifestParseError("remote %s not defined in %s" %
903 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700904 return v
905
906 def _reqatt(self, node, attname):
907 """
908 reads a required attribute from the node.
909 """
910 v = node.getAttribute(attname)
911 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530912 raise ManifestParseError("no %s in <%s> within %s" %
913 (attname, node.nodeName, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700914 return v
Julien Camperguedd654222014-01-09 16:21:37 +0100915
916 def projectsDiff(self, manifest):
917 """return the projects differences between two manifests.
918
919 The diff will be from self to given manifest.
920
921 """
922 fromProjects = self.paths
923 toProjects = manifest.paths
924
Anthony King7446c592014-05-06 09:19:39 +0100925 fromKeys = sorted(fromProjects.keys())
926 toKeys = sorted(toProjects.keys())
Julien Camperguedd654222014-01-09 16:21:37 +0100927
928 diff = {'added': [], 'removed': [], 'changed': [], 'unreachable': []}
929
930 for proj in fromKeys:
931 if not proj in toKeys:
932 diff['removed'].append(fromProjects[proj])
933 else:
934 fromProj = fromProjects[proj]
935 toProj = toProjects[proj]
936 try:
937 fromRevId = fromProj.GetCommitRevisionId()
938 toRevId = toProj.GetCommitRevisionId()
939 except ManifestInvalidRevisionError:
940 diff['unreachable'].append((fromProj, toProj))
941 else:
942 if fromRevId != toRevId:
943 diff['changed'].append((fromProj, toProj))
944 toKeys.remove(proj)
945
946 for proj in toKeys:
947 diff['added'].append(toProjects[proj])
948
949 return diff
Simran Basib9a1b732015-08-20 12:19:28 -0700950
951
952class GitcManifest(XmlManifest):
953
954 def __init__(self, repodir, gitc_client_name):
955 """Initialize the GitcManifest object."""
956 super(GitcManifest, self).__init__(repodir)
957 self.isGitcClient = True
958 self.gitc_client_name = gitc_client_name
Simran Basi8ce50412015-08-28 14:25:44 -0700959 self.gitc_client_dir = os.path.join(gitc_utils.get_gitc_manifest_dir(),
Simran Basib9a1b732015-08-20 12:19:28 -0700960 gitc_client_name)
961 self.manifestFile = os.path.join(self.gitc_client_dir, '.manifest')
962
963 def _ParseProject(self, node, parent = None):
964 """Override _ParseProject and add support for GITC specific attributes."""
965 return super(GitcManifest, self)._ParseProject(
966 node, parent=parent, old_revision=node.getAttribute('old-revision'))
967
968 def _output_manifest_project_extras(self, p, e):
969 """Output GITC Specific Project attributes"""
970 if p.old_revision:
971 e.setAttribute('old-revision', str(p.old_revision))
972