blob: 295493dec8654627170675cc5da785e9d5c23ec2 [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
Dan Willemsen96c2d652016-04-06 16:03:54 -0700105 return RemoteSpec(remoteName,
106 url=url,
107 review=self.reviewUrl,
108 orig_name=self.name)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700109
Shawn O. Pearcec8a300f2009-05-18 13:19:57 -0700110class XmlManifest(object):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700111 """manages the repo configuration file"""
112
113 def __init__(self, repodir):
114 self.repodir = os.path.abspath(repodir)
115 self.topdir = os.path.dirname(self.repodir)
116 self.manifestFile = os.path.join(self.repodir, MANIFEST_FILE_NAME)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700117 self.globalConfig = GitConfig.ForUser()
David Pursehouse4eb285c2013-02-14 16:28:44 +0900118 self.localManifestWarning = False
Simran Basib9a1b732015-08-20 12:19:28 -0700119 self.isGitcClient = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700120
121 self.repoProject = MetaProject(self, 'repo',
122 gitdir = os.path.join(repodir, 'repo/.git'),
123 worktree = os.path.join(repodir, 'repo'))
124
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700125 self.manifestProject = MetaProject(self, 'manifests',
Shawn O. Pearcef5c25a62008-11-04 08:11:53 -0800126 gitdir = os.path.join(repodir, 'manifests.git'),
127 worktree = os.path.join(repodir, 'manifests'))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700128
129 self._Unload()
130
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700131 def Override(self, name):
132 """Use a different manifest, just for the current instantiation.
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700133 """
134 path = os.path.join(self.manifestProject.worktree, name)
135 if not os.path.isfile(path):
136 raise ManifestParseError('manifest %s not found' % name)
137
138 old = self.manifestFile
139 try:
140 self.manifestFile = path
141 self._Unload()
142 self._Load()
143 finally:
144 self.manifestFile = old
145
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700146 def Link(self, name):
147 """Update the repo metadata to use a different manifest.
148 """
149 self.Override(name)
150
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700151 try:
Sebastian Frias223bf962012-11-21 19:09:25 +0100152 if os.path.lexists(self.manifestFile):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700153 os.remove(self.manifestFile)
154 os.symlink('manifests/%s' % name, self.manifestFile)
Sebastian Frias223bf962012-11-21 19:09:25 +0100155 except OSError as e:
156 raise ManifestParseError('cannot link manifest %s: %s' % (name, str(e)))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700157
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800158 def _RemoteToXml(self, r, doc, root):
159 e = doc.createElement('remote')
160 root.appendChild(e)
161 e.setAttribute('name', r.name)
162 e.setAttribute('fetch', r.fetchUrl)
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700163 if r.remoteAlias is not None:
164 e.setAttribute('alias', r.remoteAlias)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800165 if r.reviewUrl is not None:
166 e.setAttribute('review', r.reviewUrl)
Anthony King36ea2fb2014-05-06 11:54:01 +0100167 if r.revision is not None:
168 e.setAttribute('revision', r.revision)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800169
Josh Triplett884a3872014-06-12 14:57:29 -0700170 def _ParseGroups(self, groups):
171 return [x for x in re.split(r'[,\s]+', groups) if x]
172
Dan Willemsen5ea32d12015-09-08 13:27:20 -0700173 def Save(self, fd, peg_rev=False, peg_rev_upstream=True, groups=None):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800174 """Write the current manifest out to the given file descriptor.
175 """
Colin Cross5acde752012-03-28 20:15:45 -0700176 mp = self.manifestProject
177
Dan Willemsen5ea32d12015-09-08 13:27:20 -0700178 if groups is None:
179 groups = mp.config.GetString('manifest.groups')
Matt Gumbel0c635bb2012-12-21 10:14:53 -0800180 if groups:
Josh Triplett884a3872014-06-12 14:57:29 -0700181 groups = self._ParseGroups(groups)
Colin Cross5acde752012-03-28 20:15:45 -0700182
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800183 doc = xml.dom.minidom.Document()
184 root = doc.createElement('manifest')
185 doc.appendChild(root)
186
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700187 # Save out the notice. There's a little bit of work here to give it the
188 # right whitespace, which assumes that the notice is automatically indented
189 # by 4 by minidom.
190 if self.notice:
191 notice_element = root.appendChild(doc.createElement('notice'))
192 notice_lines = self.notice.splitlines()
193 indented_notice = ('\n'.join(" "*4 + line for line in notice_lines))[4:]
194 notice_element.appendChild(doc.createTextNode(indented_notice))
195
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800196 d = self.default
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800197
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530198 for r in sorted(self.remotes):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800199 self._RemoteToXml(self.remotes[r], doc, root)
200 if self.remotes:
201 root.appendChild(doc.createTextNode(''))
202
203 have_default = False
204 e = doc.createElement('default')
205 if d.remote:
206 have_default = True
207 e.setAttribute('remote', d.remote.name)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700208 if d.revisionExpr:
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800209 have_default = True
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700210 e.setAttribute('revision', d.revisionExpr)
Simon Ruggier7e59de22015-07-24 12:50:06 +0200211 if d.destBranchExpr:
212 have_default = True
213 e.setAttribute('dest-branch', d.destBranchExpr)
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700214 if d.sync_j > 1:
215 have_default = True
216 e.setAttribute('sync-j', '%d' % d.sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700217 if d.sync_c:
218 have_default = True
219 e.setAttribute('sync-c', 'true')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800220 if d.sync_s:
221 have_default = True
222 e.setAttribute('sync-s', 'true')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800223 if have_default:
224 root.appendChild(e)
225 root.appendChild(doc.createTextNode(''))
226
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700227 if self._manifest_server:
228 e = doc.createElement('manifest-server')
229 e.setAttribute('url', self._manifest_server)
230 root.appendChild(e)
231 root.appendChild(doc.createTextNode(''))
232
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800233 def output_projects(parent, parent_node, projects):
David James8d201162013-10-11 17:03:19 -0700234 for project_name in projects:
235 for project in self._projects[project_name]:
236 output_project(parent, parent_node, project)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800237
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800238 def output_project(parent, parent_node, p):
Colin Cross5acde752012-03-28 20:15:45 -0700239 if not p.MatchesGroups(groups):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800240 return
241
242 name = p.name
243 relpath = p.relpath
244 if parent:
245 name = self._UnjoinName(parent.name, name)
246 relpath = self._UnjoinRelpath(parent.relpath, relpath)
Colin Cross5acde752012-03-28 20:15:45 -0700247
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800248 e = doc.createElement('project')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800249 parent_node.appendChild(e)
250 e.setAttribute('name', name)
251 if relpath != name:
252 e.setAttribute('path', relpath)
Conley Owensa17d7af2013-10-16 14:38:09 -0700253 remoteName = None
254 if d.remote:
Dan Willemsen96c2d652016-04-06 16:03:54 -0700255 remoteName = d.remote.name
256 if not d.remote or p.remote.orig_name != remoteName:
257 remoteName = p.remote.orig_name
Anthony King36ea2fb2014-05-06 11:54:01 +0100258 e.setAttribute('remote', remoteName)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800259 if peg_rev:
260 if self.IsMirror:
Brian Harring14a66742012-09-28 20:21:57 -0700261 value = p.bare_git.rev_parse(p.revisionExpr + '^0')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800262 else:
Brian Harring14a66742012-09-28 20:21:57 -0700263 value = p.work_git.rev_parse(HEAD + '^0')
264 e.setAttribute('revision', value)
Conley Owens551dfec2015-07-10 14:54:54 -0700265 if peg_rev_upstream:
266 if p.upstream:
267 e.setAttribute('upstream', p.upstream)
268 elif value != p.revisionExpr:
269 # Only save the origin if the origin is not a sha1, and the default
270 # isn't our value
271 e.setAttribute('upstream', p.revisionExpr)
Anthony King36ea2fb2014-05-06 11:54:01 +0100272 else:
Dan Willemsen96c2d652016-04-06 16:03:54 -0700273 revision = self.remotes[p.remote.orig_name].revision or d.revisionExpr
Anthony King36ea2fb2014-05-06 11:54:01 +0100274 if not revision or revision != p.revisionExpr:
275 e.setAttribute('revision', p.revisionExpr)
Mani Chandel7a91d512014-07-24 16:27:08 +0530276 if p.upstream and p.upstream != p.revisionExpr:
277 e.setAttribute('upstream', p.upstream)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800278
Simon Ruggier7e59de22015-07-24 12:50:06 +0200279 if p.dest_branch and p.dest_branch != d.destBranchExpr:
280 e.setAttribute('dest-branch', p.dest_branch)
281
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800282 for c in p.copyfiles:
283 ce = doc.createElement('copyfile')
284 ce.setAttribute('src', c.src)
285 ce.setAttribute('dest', c.dest)
286 e.appendChild(ce)
287
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500288 for l in p.linkfiles:
289 le = doc.createElement('linkfile')
290 le.setAttribute('src', l.src)
291 le.setAttribute('dest', l.dest)
292 e.appendChild(le)
293
Conley Owensbb1b5f52012-08-13 13:11:18 -0700294 default_groups = ['all', 'name:%s' % p.name, 'path:%s' % p.relpath]
Dmitry Fink17f85ea2012-08-06 14:52:29 -0700295 egroups = [g for g in p.groups if g not in default_groups]
Conley Owens971de8e2012-04-16 10:36:08 -0700296 if egroups:
297 e.setAttribute('groups', ','.join(egroups))
Colin Cross5acde752012-03-28 20:15:45 -0700298
James W. Mills24c13082012-04-12 15:04:13 -0500299 for a in p.annotations:
300 if a.keep == "true":
301 ae = doc.createElement('annotation')
302 ae.setAttribute('name', a.name)
303 ae.setAttribute('value', a.value)
304 e.appendChild(ae)
305
Anatol Pomazau79770d22012-04-20 14:41:59 -0700306 if p.sync_c:
307 e.setAttribute('sync-c', 'true')
308
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800309 if p.sync_s:
310 e.setAttribute('sync-s', 'true')
311
Dan Willemsen88409222015-08-17 15:29:10 -0700312 if p.clone_depth:
313 e.setAttribute('clone-depth', str(p.clone_depth))
314
Simran Basib9a1b732015-08-20 12:19:28 -0700315 self._output_manifest_project_extras(p, e)
316
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800317 if p.subprojects:
David James8d201162013-10-11 17:03:19 -0700318 subprojects = set(subp.name for subp in p.subprojects)
319 output_projects(p, e, list(sorted(subprojects)))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800320
David James8d201162013-10-11 17:03:19 -0700321 projects = set(p.name for p in self._paths.values() if not p.parent)
322 output_projects(None, root, list(sorted(projects)))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800323
Doug Anderson37282b42011-03-04 11:54:18 -0800324 if self._repo_hooks_project:
325 root.appendChild(doc.createTextNode(''))
326 e = doc.createElement('repo-hooks')
327 e.setAttribute('in-project', self._repo_hooks_project.name)
328 e.setAttribute('enabled-list',
329 ' '.join(self._repo_hooks_project.enabled_repo_hooks))
330 root.appendChild(e)
331
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800332 doc.writexml(fd, '', ' ', '\n', 'UTF-8')
333
Simran Basib9a1b732015-08-20 12:19:28 -0700334 def _output_manifest_project_extras(self, p, e):
335 """Manifests can modify e if they support extra project attributes."""
336 pass
337
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700338 @property
David James8d201162013-10-11 17:03:19 -0700339 def paths(self):
340 self._Load()
341 return self._paths
342
343 @property
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700344 def projects(self):
345 self._Load()
Anthony Kingd58bfe52014-05-05 23:30:49 +0100346 return list(self._paths.values())
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700347
348 @property
349 def remotes(self):
350 self._Load()
351 return self._remotes
352
353 @property
354 def default(self):
355 self._Load()
356 return self._default
357
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800358 @property
Doug Anderson37282b42011-03-04 11:54:18 -0800359 def repo_hooks_project(self):
360 self._Load()
361 return self._repo_hooks_project
362
363 @property
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700364 def notice(self):
365 self._Load()
366 return self._notice
367
368 @property
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700369 def manifest_server(self):
370 self._Load()
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -0800371 return self._manifest_server
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700372
373 @property
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800374 def IsMirror(self):
375 return self.manifestProject.config.GetBoolean('repo.mirror')
376
Julien Campergue335f5ef2013-10-16 11:02:35 +0200377 @property
378 def IsArchive(self):
379 return self.manifestProject.config.GetBoolean('repo.archive')
380
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700381 def _Unload(self):
382 self._loaded = False
383 self._projects = {}
David James8d201162013-10-11 17:03:19 -0700384 self._paths = {}
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700385 self._remotes = {}
386 self._default = None
Doug Anderson37282b42011-03-04 11:54:18 -0800387 self._repo_hooks_project = None
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700388 self._notice = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700389 self.branch = None
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700390 self._manifest_server = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700391
392 def _Load(self):
393 if not self._loaded:
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800394 m = self.manifestProject
395 b = m.GetBranch(m.CurrentBranch).merge
Shawn O. Pearce21c5c342009-06-25 16:47:30 -0700396 if b is not None and b.startswith(R_HEADS):
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800397 b = b[len(R_HEADS):]
398 self.branch = b
399
Colin Cross23acdd32012-04-21 00:33:54 -0700400 nodes = []
Brian Harring475a47d2012-06-07 20:05:35 -0700401 nodes.append(self._ParseManifestXml(self.manifestFile,
402 self.manifestProject.worktree))
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700403
404 local = os.path.join(self.repodir, LOCAL_MANIFEST_NAME)
405 if os.path.exists(local):
David Pursehouse4eb285c2013-02-14 16:28:44 +0900406 if not self.localManifestWarning:
407 self.localManifestWarning = True
408 print('warning: %s is deprecated; put local manifests in `%s` instead'
409 % (LOCAL_MANIFEST_NAME, os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME)),
410 file=sys.stderr)
Brian Harring475a47d2012-06-07 20:05:35 -0700411 nodes.append(self._ParseManifestXml(local, self.repodir))
Colin Cross23acdd32012-04-21 00:33:54 -0700412
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900413 local_dir = os.path.abspath(os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME))
414 try:
David Pursehouse52f1e5d2012-11-14 04:53:24 +0900415 for local_file in sorted(os.listdir(local_dir)):
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900416 if local_file.endswith('.xml'):
David Pursehouse5f434ed2012-11-22 13:48:10 +0900417 local = os.path.join(local_dir, local_file)
418 nodes.append(self._ParseManifestXml(local, self.repodir))
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900419 except OSError:
420 pass
421
Joe Onorato26e24752013-01-11 12:35:53 -0800422 try:
423 self._ParseManifest(nodes)
424 except ManifestParseError as e:
425 # There was a problem parsing, unload ourselves in case they catch
426 # this error and try again later, we will show the correct error
427 self._Unload()
428 raise e
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700429
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800430 if self.IsMirror:
431 self._AddMetaProjectMirror(self.repoProject)
432 self._AddMetaProjectMirror(self.manifestProject)
433
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700434 self._loaded = True
435
Brian Harring475a47d2012-06-07 20:05:35 -0700436 def _ParseManifestXml(self, path, include_root):
David Pursehousef7fc8a92012-11-13 04:00:28 +0900437 try:
438 root = xml.dom.minidom.parse(path)
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900439 except (OSError, xml.parsers.expat.ExpatError) as e:
David Pursehousef7fc8a92012-11-13 04:00:28 +0900440 raise ManifestParseError("error parsing manifest %s: %s" % (path, e))
441
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700442 if not root or not root.childNodes:
Brian Harring26448742011-04-28 05:04:41 -0700443 raise ManifestParseError("no root node in %s" % (path,))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700444
Jooncheol Park34acdd22012-08-27 02:25:59 +0900445 for manifest in root.childNodes:
446 if manifest.nodeName == 'manifest':
447 break
448 else:
Brian Harring26448742011-04-28 05:04:41 -0700449 raise ManifestParseError("no <manifest> in %s" % (path,))
450
Colin Cross23acdd32012-04-21 00:33:54 -0700451 nodes = []
David Pursehouse4f7bdea2012-10-22 12:50:15 +0900452 for node in manifest.childNodes: # pylint:disable=W0631
David Pursehouse5c6eeac2012-10-11 16:44:48 +0900453 # We only get here if manifest is initialised
David Pursehousec1b86a22012-11-14 11:36:51 +0900454 if node.nodeName == 'include':
455 name = self._reqatt(node, 'name')
456 fp = os.path.join(include_root, name)
457 if not os.path.isfile(fp):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530458 raise ManifestParseError("include %s doesn't exist or isn't a file"
459 % (name,))
David Pursehousec1b86a22012-11-14 11:36:51 +0900460 try:
461 nodes.extend(self._ParseManifestXml(fp, include_root))
462 # should isolate this to the exact exception, but that's
463 # tricky. actual parsing implementation may vary.
464 except (KeyboardInterrupt, RuntimeError, SystemExit):
465 raise
466 except Exception as e:
467 raise ManifestParseError(
468 "failed parsing included manifest %s: %s", (name, e))
469 else:
470 nodes.append(node)
Colin Cross23acdd32012-04-21 00:33:54 -0700471 return nodes
Brian Harring26448742011-04-28 05:04:41 -0700472
Colin Cross23acdd32012-04-21 00:33:54 -0700473 def _ParseManifest(self, node_list):
474 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700475 if node.nodeName == 'remote':
476 remote = self._ParseRemote(node)
David Pursehouse717ece92012-11-13 08:49:16 +0900477 if remote:
478 if remote.name in self._remotes:
479 if remote != self._remotes[remote.name]:
480 raise ManifestParseError(
481 'remote %s already exists with different attributes' %
482 (remote.name))
483 else:
484 self._remotes[remote.name] = remote
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700485
Colin Cross23acdd32012-04-21 00:33:54 -0700486 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700487 if node.nodeName == 'default':
Julien Campergue74879922013-10-09 14:38:46 +0200488 new_default = self._ParseDefault(node)
489 if self._default is None:
490 self._default = new_default
491 elif new_default != self._default:
David Pursehouse37128b62013-10-15 10:48:40 +0900492 raise ManifestParseError('duplicate default in %s' %
493 (self.manifestFile))
Julien Campergue74879922013-10-09 14:38:46 +0200494
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700495 if self._default is None:
496 self._default = _Default()
497
Colin Cross23acdd32012-04-21 00:33:54 -0700498 for node in itertools.chain(*node_list):
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700499 if node.nodeName == 'notice':
500 if self._notice is not None:
Doug Anderson37282b42011-03-04 11:54:18 -0800501 raise ManifestParseError(
502 'duplicate notice in %s' %
503 (self.manifestFile))
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700504 self._notice = self._ParseNotice(node)
505
Colin Cross23acdd32012-04-21 00:33:54 -0700506 for node in itertools.chain(*node_list):
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700507 if node.nodeName == 'manifest-server':
508 url = self._reqatt(node, 'url')
509 if self._manifest_server is not None:
David Pursehousec1b86a22012-11-14 11:36:51 +0900510 raise ManifestParseError(
511 'duplicate manifest-server in %s' %
512 (self.manifestFile))
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700513 self._manifest_server = url
514
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800515 def recursively_add_projects(project):
David James8d201162013-10-11 17:03:19 -0700516 projects = self._projects.setdefault(project.name, [])
517 if project.relpath is None:
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800518 raise ManifestParseError(
David James8d201162013-10-11 17:03:19 -0700519 'missing path for %s in %s' %
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800520 (project.name, self.manifestFile))
David James8d201162013-10-11 17:03:19 -0700521 if project.relpath in self._paths:
522 raise ManifestParseError(
523 'duplicate path %s in %s' %
524 (project.relpath, self.manifestFile))
525 self._paths[project.relpath] = project
526 projects.append(project)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800527 for subproject in project.subprojects:
528 recursively_add_projects(subproject)
529
Colin Cross23acdd32012-04-21 00:33:54 -0700530 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700531 if node.nodeName == 'project':
532 project = self._ParseProject(node)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800533 recursively_add_projects(project)
Josh Triplett884a3872014-06-12 14:57:29 -0700534 if node.nodeName == 'extend-project':
535 name = self._reqatt(node, 'name')
536
537 if name not in self._projects:
538 raise ManifestParseError('extend-project element specifies non-existent '
539 'project: %s' % name)
540
541 path = node.getAttribute('path')
542 groups = node.getAttribute('groups')
543 if groups:
544 groups = self._ParseGroups(groups)
545
546 for p in self._projects[name]:
547 if path and p.relpath != path:
548 continue
549 if groups:
550 p.groups.extend(groups)
Doug Anderson37282b42011-03-04 11:54:18 -0800551 if node.nodeName == 'repo-hooks':
552 # Get the name of the project and the (space-separated) list of enabled.
553 repo_hooks_project = self._reqatt(node, 'in-project')
554 enabled_repo_hooks = self._reqatt(node, 'enabled-list').split()
555
556 # Only one project can be the hooks project
557 if self._repo_hooks_project is not None:
558 raise ManifestParseError(
559 'duplicate repo-hooks in %s' %
560 (self.manifestFile))
561
562 # Store a reference to the Project.
563 try:
David James8d201162013-10-11 17:03:19 -0700564 repo_hooks_projects = self._projects[repo_hooks_project]
Doug Anderson37282b42011-03-04 11:54:18 -0800565 except KeyError:
566 raise ManifestParseError(
567 'project %s not found for repo-hooks' %
568 (repo_hooks_project))
569
David James8d201162013-10-11 17:03:19 -0700570 if len(repo_hooks_projects) != 1:
571 raise ManifestParseError(
572 'internal error parsing repo-hooks in %s' %
573 (self.manifestFile))
574 self._repo_hooks_project = repo_hooks_projects[0]
575
Doug Anderson37282b42011-03-04 11:54:18 -0800576 # Store the enabled hooks in the Project object.
577 self._repo_hooks_project.enabled_repo_hooks = enabled_repo_hooks
Colin Cross23acdd32012-04-21 00:33:54 -0700578 if node.nodeName == 'remove-project':
579 name = self._reqatt(node, 'name')
David Jamesb8433df2014-01-30 10:11:17 -0800580
581 if name not in self._projects:
David Pursehousef9107482012-11-16 19:12:32 +0900582 raise ManifestParseError('remove-project element specifies non-existent '
583 'project: %s' % name)
Colin Cross23acdd32012-04-21 00:33:54 -0700584
David Jamesb8433df2014-01-30 10:11:17 -0800585 for p in self._projects[name]:
586 del self._paths[p.relpath]
587 del self._projects[name]
588
Colin Cross23acdd32012-04-21 00:33:54 -0700589 # If the manifest removes the hooks project, treat it as if it deleted
590 # the repo-hooks element too.
591 if self._repo_hooks_project and (self._repo_hooks_project.name == name):
592 self._repo_hooks_project = None
593
Doug Anderson37282b42011-03-04 11:54:18 -0800594
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800595 def _AddMetaProjectMirror(self, m):
596 name = None
597 m_url = m.GetRemote(m.remote.name).url
598 if m_url.endswith('/.git'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530599 raise ManifestParseError('refusing to mirror %s' % m_url)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800600
601 if self._default and self._default.remote:
Conley Owensceea3682011-10-20 10:45:47 -0700602 url = self._default.remote.resolvedFetchUrl
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800603 if not url.endswith('/'):
604 url += '/'
605 if m_url.startswith(url):
606 remote = self._default.remote
607 name = m_url[len(url):]
608
609 if name is None:
610 s = m_url.rindex('/') + 1
Conley Owensdb728cd2011-09-26 16:34:01 -0700611 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Shawn O. Pearcef35b2d92012-08-02 11:46:22 -0700612 remote = _XmlRemote('origin', fetch=m_url[:s], manifestUrl=manifestUrl)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800613 name = m_url[s:]
614
615 if name.endswith('.git'):
616 name = name[:-4]
617
618 if name not in self._projects:
619 m.PreSync()
620 gitdir = os.path.join(self.topdir, '%s.git' % name)
621 project = Project(manifest = self,
622 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700623 remote = remote.ToRemoteSpec(name),
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800624 gitdir = gitdir,
David James8d201162013-10-11 17:03:19 -0700625 objdir = gitdir,
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800626 worktree = None,
Kwanhong Leeccd218c2014-02-17 13:07:32 +0900627 relpath = name or None,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700628 revisionExpr = m.revisionExpr,
629 revisionId = None)
David James8d201162013-10-11 17:03:19 -0700630 self._projects[project.name] = [project]
Kwanhong Leeccd218c2014-02-17 13:07:32 +0900631 self._paths[project.relpath] = project
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800632
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700633 def _ParseRemote(self, node):
634 """
635 reads a <remote> element from the manifest file
636 """
637 name = self._reqatt(node, 'name')
Yestin Sunb292b982012-07-02 07:32:50 -0700638 alias = node.getAttribute('alias')
639 if alias == '':
640 alias = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700641 fetch = self._reqatt(node, 'fetch')
642 review = node.getAttribute('review')
Shawn O. Pearceae6e0942008-11-06 10:25:35 -0800643 if review == '':
644 review = None
Anthony King36ea2fb2014-05-06 11:54:01 +0100645 revision = node.getAttribute('revision')
646 if revision == '':
647 revision = None
Conley Owensdb728cd2011-09-26 16:34:01 -0700648 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Jonathan Nieder93719792015-03-17 11:29:58 -0700649 return _XmlRemote(name, alias, fetch, manifestUrl, review, revision)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700650
651 def _ParseDefault(self, node):
652 """
653 reads a <default> element from the manifest file
654 """
655 d = _Default()
656 d.remote = self._get_remote(node)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700657 d.revisionExpr = node.getAttribute('revision')
658 if d.revisionExpr == '':
659 d.revisionExpr = None
Anatol Pomazau79770d22012-04-20 14:41:59 -0700660
Bryan Jacobsf609f912013-05-06 13:36:24 -0400661 d.destBranchExpr = node.getAttribute('dest-branch') or None
662
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700663 sync_j = node.getAttribute('sync-j')
664 if sync_j == '' or sync_j is None:
665 d.sync_j = 1
666 else:
667 d.sync_j = int(sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700668
669 sync_c = node.getAttribute('sync-c')
670 if not sync_c:
671 d.sync_c = False
672 else:
673 d.sync_c = sync_c.lower() in ("yes", "true", "1")
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800674
675 sync_s = node.getAttribute('sync-s')
676 if not sync_s:
677 d.sync_s = False
678 else:
679 d.sync_s = sync_s.lower() in ("yes", "true", "1")
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700680 return d
681
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700682 def _ParseNotice(self, node):
683 """
684 reads a <notice> element from the manifest file
685
686 The <notice> element is distinct from other tags in the XML in that the
687 data is conveyed between the start and end tag (it's not an empty-element
688 tag).
689
690 The white space (carriage returns, indentation) for the notice element is
691 relevant and is parsed in a way that is based on how python docstrings work.
692 In fact, the code is remarkably similar to here:
693 http://www.python.org/dev/peps/pep-0257/
694 """
695 # Get the data out of the node...
696 notice = node.childNodes[0].data
697
698 # Figure out minimum indentation, skipping the first line (the same line
699 # as the <notice> tag)...
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530700 minIndent = sys.maxsize
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700701 lines = notice.splitlines()
702 for line in lines[1:]:
703 lstrippedLine = line.lstrip()
704 if lstrippedLine:
705 indent = len(line) - len(lstrippedLine)
706 minIndent = min(indent, minIndent)
707
708 # Strip leading / trailing blank lines and also indentation.
709 cleanLines = [lines[0].strip()]
710 for line in lines[1:]:
711 cleanLines.append(line[minIndent:].rstrip())
712
713 # Clear completely blank lines from front and back...
714 while cleanLines and not cleanLines[0]:
715 del cleanLines[0]
716 while cleanLines and not cleanLines[-1]:
717 del cleanLines[-1]
718
719 return '\n'.join(cleanLines)
720
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800721 def _JoinName(self, parent_name, name):
722 return os.path.join(parent_name, name)
723
724 def _UnjoinName(self, parent_name, name):
725 return os.path.relpath(name, parent_name)
726
Simran Basib9a1b732015-08-20 12:19:28 -0700727 def _ParseProject(self, node, parent = None, **extra_proj_attrs):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700728 """
729 reads a <project> element from the manifest file
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700730 """
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700731 name = self._reqatt(node, 'name')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800732 if parent:
733 name = self._JoinName(parent.name, name)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700734
735 remote = self._get_remote(node)
736 if remote is None:
737 remote = self._default.remote
738 if remote is None:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530739 raise ManifestParseError("no remote for project %s within %s" %
740 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700741
Anthony King36ea2fb2014-05-06 11:54:01 +0100742 revisionExpr = node.getAttribute('revision') or remote.revision
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700743 if not revisionExpr:
744 revisionExpr = self._default.revisionExpr
745 if not revisionExpr:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530746 raise ManifestParseError("no revision for project %s within %s" %
747 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700748
749 path = node.getAttribute('path')
750 if not path:
751 path = name
752 if path.startswith('/'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530753 raise ManifestParseError("project %s path cannot be absolute in %s" %
754 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700755
Mike Pontillod3153822012-02-28 11:53:24 -0800756 rebase = node.getAttribute('rebase')
757 if not rebase:
758 rebase = True
759 else:
760 rebase = rebase.lower() in ("yes", "true", "1")
761
Anatol Pomazau79770d22012-04-20 14:41:59 -0700762 sync_c = node.getAttribute('sync-c')
763 if not sync_c:
764 sync_c = False
765 else:
766 sync_c = sync_c.lower() in ("yes", "true", "1")
767
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800768 sync_s = node.getAttribute('sync-s')
769 if not sync_s:
770 sync_s = self._default.sync_s
771 else:
772 sync_s = sync_s.lower() in ("yes", "true", "1")
773
David Pursehouseede7f122012-11-27 22:25:30 +0900774 clone_depth = node.getAttribute('clone-depth')
775 if clone_depth:
776 try:
777 clone_depth = int(clone_depth)
778 if clone_depth <= 0:
779 raise ValueError()
780 except ValueError:
781 raise ManifestParseError('invalid clone-depth %s in %s' %
782 (clone_depth, self.manifestFile))
783
Bryan Jacobsf609f912013-05-06 13:36:24 -0400784 dest_branch = node.getAttribute('dest-branch') or self._default.destBranchExpr
785
Brian Harring14a66742012-09-28 20:21:57 -0700786 upstream = node.getAttribute('upstream')
787
Conley Owens971de8e2012-04-16 10:36:08 -0700788 groups = ''
789 if node.hasAttribute('groups'):
790 groups = node.getAttribute('groups')
Josh Triplett884a3872014-06-12 14:57:29 -0700791 groups = self._ParseGroups(groups)
Brian Harring7da13142012-06-15 02:24:20 -0700792
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800793 if parent is None:
David James8d201162013-10-11 17:03:19 -0700794 relpath, worktree, gitdir, objdir = self.GetProjectPaths(name, path)
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700795 else:
David James8d201162013-10-11 17:03:19 -0700796 relpath, worktree, gitdir, objdir = \
797 self.GetSubprojectPaths(parent, name, path)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800798
799 default_groups = ['all', 'name:%s' % name, 'path:%s' % relpath]
800 groups.extend(set(default_groups).difference(groups))
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700801
Scott Fandb83b1b2013-02-28 09:34:14 +0800802 if self.IsMirror and node.hasAttribute('force-path'):
803 if node.getAttribute('force-path').lower() in ("yes", "true", "1"):
804 gitdir = os.path.join(self.topdir, '%s.git' % path)
805
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700806 project = Project(manifest = self,
807 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700808 remote = remote.ToRemoteSpec(name),
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700809 gitdir = gitdir,
David James8d201162013-10-11 17:03:19 -0700810 objdir = objdir,
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700811 worktree = worktree,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800812 relpath = relpath,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700813 revisionExpr = revisionExpr,
Mike Pontillod3153822012-02-28 11:53:24 -0800814 revisionId = None,
Colin Cross5acde752012-03-28 20:15:45 -0700815 rebase = rebase,
Anatol Pomazau79770d22012-04-20 14:41:59 -0700816 groups = groups,
Brian Harring14a66742012-09-28 20:21:57 -0700817 sync_c = sync_c,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800818 sync_s = sync_s,
David Pursehouseede7f122012-11-27 22:25:30 +0900819 clone_depth = clone_depth,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800820 upstream = upstream,
Bryan Jacobsf609f912013-05-06 13:36:24 -0400821 parent = parent,
Simran Basib9a1b732015-08-20 12:19:28 -0700822 dest_branch = dest_branch,
823 **extra_proj_attrs)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700824
825 for n in node.childNodes:
Shawn O. Pearce242b5262009-05-19 13:00:29 -0700826 if n.nodeName == 'copyfile':
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700827 self._ParseCopyFile(project, n)
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500828 if n.nodeName == 'linkfile':
829 self._ParseLinkFile(project, n)
James W. Mills24c13082012-04-12 15:04:13 -0500830 if n.nodeName == 'annotation':
831 self._ParseAnnotation(project, n)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800832 if n.nodeName == 'project':
833 project.subprojects.append(self._ParseProject(n, parent = project))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700834
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700835 return project
836
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800837 def GetProjectPaths(self, name, path):
838 relpath = path
839 if self.IsMirror:
840 worktree = None
841 gitdir = os.path.join(self.topdir, '%s.git' % name)
David James8d201162013-10-11 17:03:19 -0700842 objdir = gitdir
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800843 else:
844 worktree = os.path.join(self.topdir, path).replace('\\', '/')
845 gitdir = os.path.join(self.repodir, 'projects', '%s.git' % path)
David James8d201162013-10-11 17:03:19 -0700846 objdir = os.path.join(self.repodir, 'project-objects', '%s.git' % name)
847 return relpath, worktree, gitdir, objdir
848
849 def GetProjectsWithName(self, name):
850 return self._projects.get(name, [])
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800851
852 def GetSubprojectName(self, parent, submodule_path):
853 return os.path.join(parent.name, submodule_path)
854
855 def _JoinRelpath(self, parent_relpath, relpath):
856 return os.path.join(parent_relpath, relpath)
857
858 def _UnjoinRelpath(self, parent_relpath, relpath):
859 return os.path.relpath(relpath, parent_relpath)
860
David James8d201162013-10-11 17:03:19 -0700861 def GetSubprojectPaths(self, parent, name, path):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800862 relpath = self._JoinRelpath(parent.relpath, path)
863 gitdir = os.path.join(parent.gitdir, 'subprojects', '%s.git' % path)
David James8d201162013-10-11 17:03:19 -0700864 objdir = os.path.join(parent.gitdir, 'subproject-objects', '%s.git' % name)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800865 if self.IsMirror:
866 worktree = None
867 else:
868 worktree = os.path.join(parent.worktree, path).replace('\\', '/')
David James8d201162013-10-11 17:03:19 -0700869 return relpath, worktree, gitdir, objdir
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800870
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700871 def _ParseCopyFile(self, project, node):
872 src = self._reqatt(node, 'src')
873 dest = self._reqatt(node, 'dest')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800874 if not self.IsMirror:
875 # src is project relative;
876 # dest is relative to the top of the tree
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800877 project.AddCopyFile(src, dest, os.path.join(self.topdir, dest))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700878
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500879 def _ParseLinkFile(self, project, node):
880 src = self._reqatt(node, 'src')
881 dest = self._reqatt(node, 'dest')
882 if not self.IsMirror:
883 # src is project relative;
884 # dest is relative to the top of the tree
885 project.AddLinkFile(src, dest, os.path.join(self.topdir, dest))
886
James W. Mills24c13082012-04-12 15:04:13 -0500887 def _ParseAnnotation(self, project, node):
888 name = self._reqatt(node, 'name')
889 value = self._reqatt(node, 'value')
890 try:
891 keep = self._reqatt(node, 'keep').lower()
892 except ManifestParseError:
893 keep = "true"
894 if keep != "true" and keep != "false":
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530895 raise ManifestParseError('optional "keep" attribute must be '
896 '"true" or "false"')
James W. Mills24c13082012-04-12 15:04:13 -0500897 project.AddAnnotation(name, value, keep)
898
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700899 def _get_remote(self, node):
900 name = node.getAttribute('remote')
901 if not name:
902 return None
903
904 v = self._remotes.get(name)
905 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530906 raise ManifestParseError("remote %s not defined in %s" %
907 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700908 return v
909
910 def _reqatt(self, node, attname):
911 """
912 reads a required attribute from the node.
913 """
914 v = node.getAttribute(attname)
915 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530916 raise ManifestParseError("no %s in <%s> within %s" %
917 (attname, node.nodeName, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700918 return v
Julien Camperguedd654222014-01-09 16:21:37 +0100919
920 def projectsDiff(self, manifest):
921 """return the projects differences between two manifests.
922
923 The diff will be from self to given manifest.
924
925 """
926 fromProjects = self.paths
927 toProjects = manifest.paths
928
Anthony King7446c592014-05-06 09:19:39 +0100929 fromKeys = sorted(fromProjects.keys())
930 toKeys = sorted(toProjects.keys())
Julien Camperguedd654222014-01-09 16:21:37 +0100931
932 diff = {'added': [], 'removed': [], 'changed': [], 'unreachable': []}
933
934 for proj in fromKeys:
935 if not proj in toKeys:
936 diff['removed'].append(fromProjects[proj])
937 else:
938 fromProj = fromProjects[proj]
939 toProj = toProjects[proj]
940 try:
941 fromRevId = fromProj.GetCommitRevisionId()
942 toRevId = toProj.GetCommitRevisionId()
943 except ManifestInvalidRevisionError:
944 diff['unreachable'].append((fromProj, toProj))
945 else:
946 if fromRevId != toRevId:
947 diff['changed'].append((fromProj, toProj))
948 toKeys.remove(proj)
949
950 for proj in toKeys:
951 diff['added'].append(toProjects[proj])
952
953 return diff
Simran Basib9a1b732015-08-20 12:19:28 -0700954
955
956class GitcManifest(XmlManifest):
957
958 def __init__(self, repodir, gitc_client_name):
959 """Initialize the GitcManifest object."""
960 super(GitcManifest, self).__init__(repodir)
961 self.isGitcClient = True
962 self.gitc_client_name = gitc_client_name
Simran Basi8ce50412015-08-28 14:25:44 -0700963 self.gitc_client_dir = os.path.join(gitc_utils.get_gitc_manifest_dir(),
Simran Basib9a1b732015-08-20 12:19:28 -0700964 gitc_client_name)
965 self.manifestFile = os.path.join(self.gitc_client_dir, '.manifest')
966
967 def _ParseProject(self, node, parent = None):
968 """Override _ParseProject and add support for GITC specific attributes."""
969 return super(GitcManifest, self)._ParseProject(
970 node, parent=parent, old_revision=node.getAttribute('old-revision'))
971
972 def _output_manifest_project_extras(self, p, e):
973 """Output GITC Specific Project attributes"""
974 if p.old_revision:
Stefan Beller66851062016-06-17 16:40:08 -0700975 e.setAttribute('old-revision', str(p.old_revision))
Simran Basib9a1b732015-08-20 12:19:28 -0700976