blob: 05651c6cba37505479c0b33249bb273ab2c65444 [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
Renaud Paquayd5cec5e2016-11-01 11:24:03 -070035import platform_utils
David Pursehousee00aa6b2012-09-11 14:33:51 +090036from project import RemoteSpec, Project, MetaProject
Julien Camperguedd654222014-01-09 16:21:37 +010037from error import ManifestParseError, ManifestInvalidRevisionError
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070038
39MANIFEST_FILE_NAME = 'manifest.xml'
Shawn O. Pearce5cc66792008-10-23 16:19:27 -070040LOCAL_MANIFEST_NAME = 'local_manifest.xml'
David Pursehouse2d5a0df2012-11-13 02:50:36 +090041LOCAL_MANIFESTS_DIR_NAME = 'local_manifests'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070042
Anthony Kingcb07ba72015-03-28 23:26:04 +000043# urljoin gets confused if the scheme is not known.
Joe Kilner6e310792016-10-27 15:53:53 -070044urllib.parse.uses_relative.extend([
45 'ssh',
46 'git',
47 'persistent-https',
48 'sso',
49 'rpc'])
50urllib.parse.uses_netloc.extend([
51 'ssh',
52 'git',
53 'persistent-https',
54 'sso',
55 'rpc'])
Conley Owensdb728cd2011-09-26 16:34:01 -070056
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070057class _Default(object):
58 """Project defaults within the manifest."""
59
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -070060 revisionExpr = None
Conley Owensb6a16e62013-09-25 15:06:09 -070061 destBranchExpr = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070062 remote = None
Shawn O. Pearce6392c872011-09-22 17:44:31 -070063 sync_j = 1
Anatol Pomazau79770d22012-04-20 14:41:59 -070064 sync_c = False
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +080065 sync_s = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070066
Julien Campergue74879922013-10-09 14:38:46 +020067 def __eq__(self, other):
68 return self.__dict__ == other.__dict__
69
70 def __ne__(self, other):
71 return self.__dict__ != other.__dict__
72
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070073class _XmlRemote(object):
74 def __init__(self,
75 name,
Yestin Sunb292b982012-07-02 07:32:50 -070076 alias=None,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070077 fetch=None,
Steve Raed6480452016-08-10 15:00:00 -070078 pushUrl=None,
Conley Owensdb728cd2011-09-26 16:34:01 -070079 manifestUrl=None,
Anthony King36ea2fb2014-05-06 11:54:01 +010080 review=None,
Jonathan Nieder93719792015-03-17 11:29:58 -070081 revision=None):
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070082 self.name = name
83 self.fetchUrl = fetch
Steve Raed6480452016-08-10 15:00:00 -070084 self.pushUrl = pushUrl
Conley Owensdb728cd2011-09-26 16:34:01 -070085 self.manifestUrl = manifestUrl
Yestin Sunb292b982012-07-02 07:32:50 -070086 self.remoteAlias = alias
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070087 self.reviewUrl = review
Anthony King36ea2fb2014-05-06 11:54:01 +010088 self.revision = revision
Conley Owensceea3682011-10-20 10:45:47 -070089 self.resolvedFetchUrl = self._resolveFetchUrl()
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070090
David Pursehouse717ece92012-11-13 08:49:16 +090091 def __eq__(self, other):
92 return self.__dict__ == other.__dict__
93
94 def __ne__(self, other):
95 return self.__dict__ != other.__dict__
96
Conley Owensceea3682011-10-20 10:45:47 -070097 def _resolveFetchUrl(self):
98 url = self.fetchUrl.rstrip('/')
Conley Owensdb728cd2011-09-26 16:34:01 -070099 manifestUrl = self.manifestUrl.rstrip('/')
Conley Owens2d0f5082014-01-31 15:03:51 -0800100 # urljoin will gets confused over quite a few things. The ones we care
101 # about here are:
102 # * no scheme in the base url, like <hostname:port>
Anthony Kingcb07ba72015-03-28 23:26:04 +0000103 # We handle no scheme by replacing it with an obscure protocol, gopher
104 # and then replacing it with the original when we are done.
105
Conley Owensdb728cd2011-09-26 16:34:01 -0700106 if manifestUrl.find(':') != manifestUrl.find('/') - 1:
Conley Owens4ccad752015-04-29 10:45:37 -0700107 url = urllib.parse.urljoin('gopher://' + manifestUrl, url)
108 url = re.sub(r'^gopher://', '', url)
Anthony Kingcb07ba72015-03-28 23:26:04 +0000109 else:
110 url = urllib.parse.urljoin(manifestUrl, url)
Shawn Pearcea9f11b32013-01-02 15:40:48 -0800111 return url
Conley Owensceea3682011-10-20 10:45:47 -0700112
113 def ToRemoteSpec(self, projectName):
David Rileye0684ad2017-04-05 00:02:59 -0700114 fetchUrl = self.resolvedFetchUrl.rstrip('/')
115 url = fetchUrl + '/' + projectName
Yestin Sunb292b982012-07-02 07:32:50 -0700116 remoteName = self.name
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700117 if self.remoteAlias:
David Pursehouse37128b62013-10-15 10:48:40 +0900118 remoteName = self.remoteAlias
Dan Willemsen96c2d652016-04-06 16:03:54 -0700119 return RemoteSpec(remoteName,
120 url=url,
Steve Raed6480452016-08-10 15:00:00 -0700121 pushUrl=self.pushUrl,
Dan Willemsen96c2d652016-04-06 16:03:54 -0700122 review=self.reviewUrl,
David Rileye0684ad2017-04-05 00:02:59 -0700123 orig_name=self.name,
124 fetchUrl=self.fetchUrl)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700125
Shawn O. Pearcec8a300f2009-05-18 13:19:57 -0700126class XmlManifest(object):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700127 """manages the repo configuration file"""
128
129 def __init__(self, repodir):
130 self.repodir = os.path.abspath(repodir)
131 self.topdir = os.path.dirname(self.repodir)
132 self.manifestFile = os.path.join(self.repodir, MANIFEST_FILE_NAME)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700133 self.globalConfig = GitConfig.ForUser()
David Pursehouse4eb285c2013-02-14 16:28:44 +0900134 self.localManifestWarning = False
Simran Basib9a1b732015-08-20 12:19:28 -0700135 self.isGitcClient = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700136
137 self.repoProject = MetaProject(self, 'repo',
138 gitdir = os.path.join(repodir, 'repo/.git'),
139 worktree = os.path.join(repodir, 'repo'))
140
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700141 self.manifestProject = MetaProject(self, 'manifests',
Shawn O. Pearcef5c25a62008-11-04 08:11:53 -0800142 gitdir = os.path.join(repodir, 'manifests.git'),
143 worktree = os.path.join(repodir, 'manifests'))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700144
145 self._Unload()
146
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700147 def Override(self, name):
148 """Use a different manifest, just for the current instantiation.
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700149 """
150 path = os.path.join(self.manifestProject.worktree, name)
151 if not os.path.isfile(path):
152 raise ManifestParseError('manifest %s not found' % name)
153
154 old = self.manifestFile
155 try:
156 self.manifestFile = path
157 self._Unload()
158 self._Load()
159 finally:
160 self.manifestFile = old
161
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700162 def Link(self, name):
163 """Update the repo metadata to use a different manifest.
164 """
165 self.Override(name)
166
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700167 try:
Sebastian Frias223bf962012-11-21 19:09:25 +0100168 if os.path.lexists(self.manifestFile):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700169 os.remove(self.manifestFile)
Renaud Paquayd5cec5e2016-11-01 11:24:03 -0700170 platform_utils.symlink(os.path.join('manifests', name), self.manifestFile)
Sebastian Frias223bf962012-11-21 19:09:25 +0100171 except OSError as e:
172 raise ManifestParseError('cannot link manifest %s: %s' % (name, str(e)))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700173
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800174 def _RemoteToXml(self, r, doc, root):
175 e = doc.createElement('remote')
176 root.appendChild(e)
177 e.setAttribute('name', r.name)
178 e.setAttribute('fetch', r.fetchUrl)
Steve Raed6480452016-08-10 15:00:00 -0700179 if r.pushUrl is not None:
180 e.setAttribute('pushurl', r.pushUrl)
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700181 if r.remoteAlias is not None:
182 e.setAttribute('alias', r.remoteAlias)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800183 if r.reviewUrl is not None:
184 e.setAttribute('review', r.reviewUrl)
Anthony King36ea2fb2014-05-06 11:54:01 +0100185 if r.revision is not None:
186 e.setAttribute('revision', r.revision)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800187
Josh Triplett884a3872014-06-12 14:57:29 -0700188 def _ParseGroups(self, groups):
189 return [x for x in re.split(r'[,\s]+', groups) if x]
190
Dan Willemsen5ea32d12015-09-08 13:27:20 -0700191 def Save(self, fd, peg_rev=False, peg_rev_upstream=True, groups=None):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800192 """Write the current manifest out to the given file descriptor.
193 """
Colin Cross5acde752012-03-28 20:15:45 -0700194 mp = self.manifestProject
195
Dan Willemsen5ea32d12015-09-08 13:27:20 -0700196 if groups is None:
197 groups = mp.config.GetString('manifest.groups')
Matt Gumbel0c635bb2012-12-21 10:14:53 -0800198 if groups:
Josh Triplett884a3872014-06-12 14:57:29 -0700199 groups = self._ParseGroups(groups)
Colin Cross5acde752012-03-28 20:15:45 -0700200
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800201 doc = xml.dom.minidom.Document()
202 root = doc.createElement('manifest')
203 doc.appendChild(root)
204
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700205 # Save out the notice. There's a little bit of work here to give it the
206 # right whitespace, which assumes that the notice is automatically indented
207 # by 4 by minidom.
208 if self.notice:
209 notice_element = root.appendChild(doc.createElement('notice'))
210 notice_lines = self.notice.splitlines()
211 indented_notice = ('\n'.join(" "*4 + line for line in notice_lines))[4:]
212 notice_element.appendChild(doc.createTextNode(indented_notice))
213
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800214 d = self.default
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800215
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530216 for r in sorted(self.remotes):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800217 self._RemoteToXml(self.remotes[r], doc, root)
218 if self.remotes:
219 root.appendChild(doc.createTextNode(''))
220
221 have_default = False
222 e = doc.createElement('default')
223 if d.remote:
224 have_default = True
225 e.setAttribute('remote', d.remote.name)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700226 if d.revisionExpr:
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800227 have_default = True
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700228 e.setAttribute('revision', d.revisionExpr)
Simon Ruggier7e59de22015-07-24 12:50:06 +0200229 if d.destBranchExpr:
230 have_default = True
231 e.setAttribute('dest-branch', d.destBranchExpr)
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700232 if d.sync_j > 1:
233 have_default = True
234 e.setAttribute('sync-j', '%d' % d.sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700235 if d.sync_c:
236 have_default = True
237 e.setAttribute('sync-c', 'true')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800238 if d.sync_s:
239 have_default = True
240 e.setAttribute('sync-s', 'true')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800241 if have_default:
242 root.appendChild(e)
243 root.appendChild(doc.createTextNode(''))
244
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700245 if self._manifest_server:
246 e = doc.createElement('manifest-server')
247 e.setAttribute('url', self._manifest_server)
248 root.appendChild(e)
249 root.appendChild(doc.createTextNode(''))
250
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800251 def output_projects(parent, parent_node, projects):
David James8d201162013-10-11 17:03:19 -0700252 for project_name in projects:
253 for project in self._projects[project_name]:
254 output_project(parent, parent_node, project)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800255
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800256 def output_project(parent, parent_node, p):
Colin Cross5acde752012-03-28 20:15:45 -0700257 if not p.MatchesGroups(groups):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800258 return
259
260 name = p.name
261 relpath = p.relpath
262 if parent:
263 name = self._UnjoinName(parent.name, name)
264 relpath = self._UnjoinRelpath(parent.relpath, relpath)
Colin Cross5acde752012-03-28 20:15:45 -0700265
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800266 e = doc.createElement('project')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800267 parent_node.appendChild(e)
268 e.setAttribute('name', name)
269 if relpath != name:
270 e.setAttribute('path', relpath)
Conley Owensa17d7af2013-10-16 14:38:09 -0700271 remoteName = None
272 if d.remote:
Dan Willemsen96c2d652016-04-06 16:03:54 -0700273 remoteName = d.remote.name
274 if not d.remote or p.remote.orig_name != remoteName:
275 remoteName = p.remote.orig_name
Anthony King36ea2fb2014-05-06 11:54:01 +0100276 e.setAttribute('remote', remoteName)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800277 if peg_rev:
278 if self.IsMirror:
Brian Harring14a66742012-09-28 20:21:57 -0700279 value = p.bare_git.rev_parse(p.revisionExpr + '^0')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800280 else:
Brian Harring14a66742012-09-28 20:21:57 -0700281 value = p.work_git.rev_parse(HEAD + '^0')
282 e.setAttribute('revision', value)
Conley Owens551dfec2015-07-10 14:54:54 -0700283 if peg_rev_upstream:
284 if p.upstream:
285 e.setAttribute('upstream', p.upstream)
286 elif value != p.revisionExpr:
287 # Only save the origin if the origin is not a sha1, and the default
288 # isn't our value
289 e.setAttribute('upstream', p.revisionExpr)
Anthony King36ea2fb2014-05-06 11:54:01 +0100290 else:
Dan Willemsen96c2d652016-04-06 16:03:54 -0700291 revision = self.remotes[p.remote.orig_name].revision or d.revisionExpr
Anthony King36ea2fb2014-05-06 11:54:01 +0100292 if not revision or revision != p.revisionExpr:
293 e.setAttribute('revision', p.revisionExpr)
Mani Chandel7a91d512014-07-24 16:27:08 +0530294 if p.upstream and p.upstream != p.revisionExpr:
295 e.setAttribute('upstream', p.upstream)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800296
Simon Ruggier7e59de22015-07-24 12:50:06 +0200297 if p.dest_branch and p.dest_branch != d.destBranchExpr:
298 e.setAttribute('dest-branch', p.dest_branch)
299
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800300 for c in p.copyfiles:
301 ce = doc.createElement('copyfile')
302 ce.setAttribute('src', c.src)
303 ce.setAttribute('dest', c.dest)
304 e.appendChild(ce)
305
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500306 for l in p.linkfiles:
307 le = doc.createElement('linkfile')
308 le.setAttribute('src', l.src)
309 le.setAttribute('dest', l.dest)
310 e.appendChild(le)
311
Conley Owensbb1b5f52012-08-13 13:11:18 -0700312 default_groups = ['all', 'name:%s' % p.name, 'path:%s' % p.relpath]
Dmitry Fink17f85ea2012-08-06 14:52:29 -0700313 egroups = [g for g in p.groups if g not in default_groups]
Conley Owens971de8e2012-04-16 10:36:08 -0700314 if egroups:
315 e.setAttribute('groups', ','.join(egroups))
Colin Cross5acde752012-03-28 20:15:45 -0700316
James W. Mills24c13082012-04-12 15:04:13 -0500317 for a in p.annotations:
318 if a.keep == "true":
319 ae = doc.createElement('annotation')
320 ae.setAttribute('name', a.name)
321 ae.setAttribute('value', a.value)
322 e.appendChild(ae)
323
Anatol Pomazau79770d22012-04-20 14:41:59 -0700324 if p.sync_c:
325 e.setAttribute('sync-c', 'true')
326
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800327 if p.sync_s:
328 e.setAttribute('sync-s', 'true')
329
Dan Willemsen88409222015-08-17 15:29:10 -0700330 if p.clone_depth:
331 e.setAttribute('clone-depth', str(p.clone_depth))
332
Simran Basib9a1b732015-08-20 12:19:28 -0700333 self._output_manifest_project_extras(p, e)
334
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800335 if p.subprojects:
David James8d201162013-10-11 17:03:19 -0700336 subprojects = set(subp.name for subp in p.subprojects)
337 output_projects(p, e, list(sorted(subprojects)))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800338
David James8d201162013-10-11 17:03:19 -0700339 projects = set(p.name for p in self._paths.values() if not p.parent)
340 output_projects(None, root, list(sorted(projects)))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800341
Doug Anderson37282b42011-03-04 11:54:18 -0800342 if self._repo_hooks_project:
343 root.appendChild(doc.createTextNode(''))
344 e = doc.createElement('repo-hooks')
345 e.setAttribute('in-project', self._repo_hooks_project.name)
346 e.setAttribute('enabled-list',
347 ' '.join(self._repo_hooks_project.enabled_repo_hooks))
348 root.appendChild(e)
349
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800350 doc.writexml(fd, '', ' ', '\n', 'UTF-8')
351
Simran Basib9a1b732015-08-20 12:19:28 -0700352 def _output_manifest_project_extras(self, p, e):
353 """Manifests can modify e if they support extra project attributes."""
354 pass
355
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700356 @property
David James8d201162013-10-11 17:03:19 -0700357 def paths(self):
358 self._Load()
359 return self._paths
360
361 @property
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700362 def projects(self):
363 self._Load()
Anthony Kingd58bfe52014-05-05 23:30:49 +0100364 return list(self._paths.values())
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700365
366 @property
367 def remotes(self):
368 self._Load()
369 return self._remotes
370
371 @property
372 def default(self):
373 self._Load()
374 return self._default
375
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800376 @property
Doug Anderson37282b42011-03-04 11:54:18 -0800377 def repo_hooks_project(self):
378 self._Load()
379 return self._repo_hooks_project
380
381 @property
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700382 def notice(self):
383 self._Load()
384 return self._notice
385
386 @property
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700387 def manifest_server(self):
388 self._Load()
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -0800389 return self._manifest_server
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700390
391 @property
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800392 def IsMirror(self):
393 return self.manifestProject.config.GetBoolean('repo.mirror')
394
Julien Campergue335f5ef2013-10-16 11:02:35 +0200395 @property
396 def IsArchive(self):
397 return self.manifestProject.config.GetBoolean('repo.archive')
398
Martin Kellye4e94d22017-03-21 16:05:12 -0700399 @property
400 def HasSubmodules(self):
401 return self.manifestProject.config.GetBoolean('repo.submodules')
402
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700403 def _Unload(self):
404 self._loaded = False
405 self._projects = {}
David James8d201162013-10-11 17:03:19 -0700406 self._paths = {}
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700407 self._remotes = {}
408 self._default = None
Doug Anderson37282b42011-03-04 11:54:18 -0800409 self._repo_hooks_project = None
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700410 self._notice = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700411 self.branch = None
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700412 self._manifest_server = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700413
414 def _Load(self):
415 if not self._loaded:
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800416 m = self.manifestProject
417 b = m.GetBranch(m.CurrentBranch).merge
Shawn O. Pearce21c5c342009-06-25 16:47:30 -0700418 if b is not None and b.startswith(R_HEADS):
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800419 b = b[len(R_HEADS):]
420 self.branch = b
421
Colin Cross23acdd32012-04-21 00:33:54 -0700422 nodes = []
Brian Harring475a47d2012-06-07 20:05:35 -0700423 nodes.append(self._ParseManifestXml(self.manifestFile,
424 self.manifestProject.worktree))
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700425
426 local = os.path.join(self.repodir, LOCAL_MANIFEST_NAME)
427 if os.path.exists(local):
David Pursehouse4eb285c2013-02-14 16:28:44 +0900428 if not self.localManifestWarning:
429 self.localManifestWarning = True
430 print('warning: %s is deprecated; put local manifests in `%s` instead'
431 % (LOCAL_MANIFEST_NAME, os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME)),
432 file=sys.stderr)
Brian Harring475a47d2012-06-07 20:05:35 -0700433 nodes.append(self._ParseManifestXml(local, self.repodir))
Colin Cross23acdd32012-04-21 00:33:54 -0700434
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900435 local_dir = os.path.abspath(os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME))
436 try:
David Pursehouse52f1e5d2012-11-14 04:53:24 +0900437 for local_file in sorted(os.listdir(local_dir)):
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900438 if local_file.endswith('.xml'):
David Pursehouse5f434ed2012-11-22 13:48:10 +0900439 local = os.path.join(local_dir, local_file)
440 nodes.append(self._ParseManifestXml(local, self.repodir))
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900441 except OSError:
442 pass
443
Joe Onorato26e24752013-01-11 12:35:53 -0800444 try:
445 self._ParseManifest(nodes)
446 except ManifestParseError as e:
447 # There was a problem parsing, unload ourselves in case they catch
448 # this error and try again later, we will show the correct error
449 self._Unload()
450 raise e
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700451
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800452 if self.IsMirror:
453 self._AddMetaProjectMirror(self.repoProject)
454 self._AddMetaProjectMirror(self.manifestProject)
455
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700456 self._loaded = True
457
Brian Harring475a47d2012-06-07 20:05:35 -0700458 def _ParseManifestXml(self, path, include_root):
David Pursehousef7fc8a92012-11-13 04:00:28 +0900459 try:
460 root = xml.dom.minidom.parse(path)
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900461 except (OSError, xml.parsers.expat.ExpatError) as e:
David Pursehousef7fc8a92012-11-13 04:00:28 +0900462 raise ManifestParseError("error parsing manifest %s: %s" % (path, e))
463
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700464 if not root or not root.childNodes:
Brian Harring26448742011-04-28 05:04:41 -0700465 raise ManifestParseError("no root node in %s" % (path,))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700466
Jooncheol Park34acdd22012-08-27 02:25:59 +0900467 for manifest in root.childNodes:
468 if manifest.nodeName == 'manifest':
469 break
470 else:
Brian Harring26448742011-04-28 05:04:41 -0700471 raise ManifestParseError("no <manifest> in %s" % (path,))
472
Colin Cross23acdd32012-04-21 00:33:54 -0700473 nodes = []
David Pursehouse4f7bdea2012-10-22 12:50:15 +0900474 for node in manifest.childNodes: # pylint:disable=W0631
David Pursehouse5c6eeac2012-10-11 16:44:48 +0900475 # We only get here if manifest is initialised
David Pursehousec1b86a22012-11-14 11:36:51 +0900476 if node.nodeName == 'include':
477 name = self._reqatt(node, 'name')
478 fp = os.path.join(include_root, name)
479 if not os.path.isfile(fp):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530480 raise ManifestParseError("include %s doesn't exist or isn't a file"
481 % (name,))
David Pursehousec1b86a22012-11-14 11:36:51 +0900482 try:
483 nodes.extend(self._ParseManifestXml(fp, include_root))
484 # should isolate this to the exact exception, but that's
485 # tricky. actual parsing implementation may vary.
486 except (KeyboardInterrupt, RuntimeError, SystemExit):
487 raise
488 except Exception as e:
489 raise ManifestParseError(
490 "failed parsing included manifest %s: %s", (name, e))
491 else:
492 nodes.append(node)
Colin Cross23acdd32012-04-21 00:33:54 -0700493 return nodes
Brian Harring26448742011-04-28 05:04:41 -0700494
Colin Cross23acdd32012-04-21 00:33:54 -0700495 def _ParseManifest(self, node_list):
496 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700497 if node.nodeName == 'remote':
498 remote = self._ParseRemote(node)
David Pursehouse717ece92012-11-13 08:49:16 +0900499 if remote:
500 if remote.name in self._remotes:
501 if remote != self._remotes[remote.name]:
502 raise ManifestParseError(
503 'remote %s already exists with different attributes' %
504 (remote.name))
505 else:
506 self._remotes[remote.name] = remote
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700507
Colin Cross23acdd32012-04-21 00:33:54 -0700508 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700509 if node.nodeName == 'default':
Julien Campergue74879922013-10-09 14:38:46 +0200510 new_default = self._ParseDefault(node)
511 if self._default is None:
512 self._default = new_default
513 elif new_default != self._default:
David Pursehouse37128b62013-10-15 10:48:40 +0900514 raise ManifestParseError('duplicate default in %s' %
515 (self.manifestFile))
Julien Campergue74879922013-10-09 14:38:46 +0200516
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700517 if self._default is None:
518 self._default = _Default()
519
Colin Cross23acdd32012-04-21 00:33:54 -0700520 for node in itertools.chain(*node_list):
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700521 if node.nodeName == 'notice':
522 if self._notice is not None:
Doug Anderson37282b42011-03-04 11:54:18 -0800523 raise ManifestParseError(
524 'duplicate notice in %s' %
525 (self.manifestFile))
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700526 self._notice = self._ParseNotice(node)
527
Colin Cross23acdd32012-04-21 00:33:54 -0700528 for node in itertools.chain(*node_list):
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700529 if node.nodeName == 'manifest-server':
530 url = self._reqatt(node, 'url')
531 if self._manifest_server is not None:
David Pursehousec1b86a22012-11-14 11:36:51 +0900532 raise ManifestParseError(
533 'duplicate manifest-server in %s' %
534 (self.manifestFile))
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700535 self._manifest_server = url
536
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800537 def recursively_add_projects(project):
David James8d201162013-10-11 17:03:19 -0700538 projects = self._projects.setdefault(project.name, [])
539 if project.relpath is None:
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800540 raise ManifestParseError(
David James8d201162013-10-11 17:03:19 -0700541 'missing path for %s in %s' %
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800542 (project.name, self.manifestFile))
David James8d201162013-10-11 17:03:19 -0700543 if project.relpath in self._paths:
544 raise ManifestParseError(
545 'duplicate path %s in %s' %
546 (project.relpath, self.manifestFile))
547 self._paths[project.relpath] = project
548 projects.append(project)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800549 for subproject in project.subprojects:
550 recursively_add_projects(subproject)
551
Colin Cross23acdd32012-04-21 00:33:54 -0700552 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700553 if node.nodeName == 'project':
554 project = self._ParseProject(node)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800555 recursively_add_projects(project)
Josh Triplett884a3872014-06-12 14:57:29 -0700556 if node.nodeName == 'extend-project':
557 name = self._reqatt(node, 'name')
558
559 if name not in self._projects:
560 raise ManifestParseError('extend-project element specifies non-existent '
561 'project: %s' % name)
562
563 path = node.getAttribute('path')
564 groups = node.getAttribute('groups')
565 if groups:
566 groups = self._ParseGroups(groups)
567
568 for p in self._projects[name]:
569 if path and p.relpath != path:
570 continue
571 if groups:
572 p.groups.extend(groups)
Doug Anderson37282b42011-03-04 11:54:18 -0800573 if node.nodeName == 'repo-hooks':
574 # Get the name of the project and the (space-separated) list of enabled.
575 repo_hooks_project = self._reqatt(node, 'in-project')
576 enabled_repo_hooks = self._reqatt(node, 'enabled-list').split()
577
578 # Only one project can be the hooks project
579 if self._repo_hooks_project is not None:
580 raise ManifestParseError(
581 'duplicate repo-hooks in %s' %
582 (self.manifestFile))
583
584 # Store a reference to the Project.
585 try:
David James8d201162013-10-11 17:03:19 -0700586 repo_hooks_projects = self._projects[repo_hooks_project]
Doug Anderson37282b42011-03-04 11:54:18 -0800587 except KeyError:
588 raise ManifestParseError(
589 'project %s not found for repo-hooks' %
590 (repo_hooks_project))
591
David James8d201162013-10-11 17:03:19 -0700592 if len(repo_hooks_projects) != 1:
593 raise ManifestParseError(
594 'internal error parsing repo-hooks in %s' %
595 (self.manifestFile))
596 self._repo_hooks_project = repo_hooks_projects[0]
597
Doug Anderson37282b42011-03-04 11:54:18 -0800598 # Store the enabled hooks in the Project object.
599 self._repo_hooks_project.enabled_repo_hooks = enabled_repo_hooks
Colin Cross23acdd32012-04-21 00:33:54 -0700600 if node.nodeName == 'remove-project':
601 name = self._reqatt(node, 'name')
David Jamesb8433df2014-01-30 10:11:17 -0800602
603 if name not in self._projects:
David Pursehousef9107482012-11-16 19:12:32 +0900604 raise ManifestParseError('remove-project element specifies non-existent '
605 'project: %s' % name)
Colin Cross23acdd32012-04-21 00:33:54 -0700606
David Jamesb8433df2014-01-30 10:11:17 -0800607 for p in self._projects[name]:
608 del self._paths[p.relpath]
609 del self._projects[name]
610
Colin Cross23acdd32012-04-21 00:33:54 -0700611 # If the manifest removes the hooks project, treat it as if it deleted
612 # the repo-hooks element too.
613 if self._repo_hooks_project and (self._repo_hooks_project.name == name):
614 self._repo_hooks_project = None
615
Doug Anderson37282b42011-03-04 11:54:18 -0800616
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800617 def _AddMetaProjectMirror(self, m):
618 name = None
619 m_url = m.GetRemote(m.remote.name).url
620 if m_url.endswith('/.git'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530621 raise ManifestParseError('refusing to mirror %s' % m_url)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800622
623 if self._default and self._default.remote:
Conley Owensceea3682011-10-20 10:45:47 -0700624 url = self._default.remote.resolvedFetchUrl
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800625 if not url.endswith('/'):
626 url += '/'
627 if m_url.startswith(url):
628 remote = self._default.remote
629 name = m_url[len(url):]
630
631 if name is None:
632 s = m_url.rindex('/') + 1
Conley Owensdb728cd2011-09-26 16:34:01 -0700633 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Shawn O. Pearcef35b2d92012-08-02 11:46:22 -0700634 remote = _XmlRemote('origin', fetch=m_url[:s], manifestUrl=manifestUrl)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800635 name = m_url[s:]
636
637 if name.endswith('.git'):
638 name = name[:-4]
639
640 if name not in self._projects:
641 m.PreSync()
642 gitdir = os.path.join(self.topdir, '%s.git' % name)
643 project = Project(manifest = self,
644 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700645 remote = remote.ToRemoteSpec(name),
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800646 gitdir = gitdir,
David James8d201162013-10-11 17:03:19 -0700647 objdir = gitdir,
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800648 worktree = None,
Kwanhong Leeccd218c2014-02-17 13:07:32 +0900649 relpath = name or None,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700650 revisionExpr = m.revisionExpr,
651 revisionId = None)
David James8d201162013-10-11 17:03:19 -0700652 self._projects[project.name] = [project]
Kwanhong Leeccd218c2014-02-17 13:07:32 +0900653 self._paths[project.relpath] = project
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800654
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700655 def _ParseRemote(self, node):
656 """
657 reads a <remote> element from the manifest file
658 """
659 name = self._reqatt(node, 'name')
Yestin Sunb292b982012-07-02 07:32:50 -0700660 alias = node.getAttribute('alias')
661 if alias == '':
662 alias = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700663 fetch = self._reqatt(node, 'fetch')
Steve Raed6480452016-08-10 15:00:00 -0700664 pushUrl = node.getAttribute('pushurl')
665 if pushUrl == '':
666 pushUrl = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700667 review = node.getAttribute('review')
Shawn O. Pearceae6e0942008-11-06 10:25:35 -0800668 if review == '':
669 review = None
Anthony King36ea2fb2014-05-06 11:54:01 +0100670 revision = node.getAttribute('revision')
671 if revision == '':
672 revision = None
Conley Owensdb728cd2011-09-26 16:34:01 -0700673 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Steve Raed6480452016-08-10 15:00:00 -0700674 return _XmlRemote(name, alias, fetch, pushUrl, manifestUrl, review, revision)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700675
676 def _ParseDefault(self, node):
677 """
678 reads a <default> element from the manifest file
679 """
680 d = _Default()
681 d.remote = self._get_remote(node)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700682 d.revisionExpr = node.getAttribute('revision')
683 if d.revisionExpr == '':
684 d.revisionExpr = None
Anatol Pomazau79770d22012-04-20 14:41:59 -0700685
Bryan Jacobsf609f912013-05-06 13:36:24 -0400686 d.destBranchExpr = node.getAttribute('dest-branch') or None
687
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700688 sync_j = node.getAttribute('sync-j')
689 if sync_j == '' or sync_j is None:
690 d.sync_j = 1
691 else:
692 d.sync_j = int(sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700693
694 sync_c = node.getAttribute('sync-c')
695 if not sync_c:
696 d.sync_c = False
697 else:
698 d.sync_c = sync_c.lower() in ("yes", "true", "1")
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800699
700 sync_s = node.getAttribute('sync-s')
701 if not sync_s:
702 d.sync_s = False
703 else:
704 d.sync_s = sync_s.lower() in ("yes", "true", "1")
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700705 return d
706
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700707 def _ParseNotice(self, node):
708 """
709 reads a <notice> element from the manifest file
710
711 The <notice> element is distinct from other tags in the XML in that the
712 data is conveyed between the start and end tag (it's not an empty-element
713 tag).
714
715 The white space (carriage returns, indentation) for the notice element is
716 relevant and is parsed in a way that is based on how python docstrings work.
717 In fact, the code is remarkably similar to here:
718 http://www.python.org/dev/peps/pep-0257/
719 """
720 # Get the data out of the node...
721 notice = node.childNodes[0].data
722
723 # Figure out minimum indentation, skipping the first line (the same line
724 # as the <notice> tag)...
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530725 minIndent = sys.maxsize
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700726 lines = notice.splitlines()
727 for line in lines[1:]:
728 lstrippedLine = line.lstrip()
729 if lstrippedLine:
730 indent = len(line) - len(lstrippedLine)
731 minIndent = min(indent, minIndent)
732
733 # Strip leading / trailing blank lines and also indentation.
734 cleanLines = [lines[0].strip()]
735 for line in lines[1:]:
736 cleanLines.append(line[minIndent:].rstrip())
737
738 # Clear completely blank lines from front and back...
739 while cleanLines and not cleanLines[0]:
740 del cleanLines[0]
741 while cleanLines and not cleanLines[-1]:
742 del cleanLines[-1]
743
744 return '\n'.join(cleanLines)
745
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800746 def _JoinName(self, parent_name, name):
747 return os.path.join(parent_name, name)
748
749 def _UnjoinName(self, parent_name, name):
750 return os.path.relpath(name, parent_name)
751
Simran Basib9a1b732015-08-20 12:19:28 -0700752 def _ParseProject(self, node, parent = None, **extra_proj_attrs):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700753 """
754 reads a <project> element from the manifest file
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700755 """
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700756 name = self._reqatt(node, 'name')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800757 if parent:
758 name = self._JoinName(parent.name, name)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700759
760 remote = self._get_remote(node)
761 if remote is None:
762 remote = self._default.remote
763 if remote is None:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530764 raise ManifestParseError("no remote for project %s within %s" %
765 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700766
Anthony King36ea2fb2014-05-06 11:54:01 +0100767 revisionExpr = node.getAttribute('revision') or remote.revision
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700768 if not revisionExpr:
769 revisionExpr = self._default.revisionExpr
770 if not revisionExpr:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530771 raise ManifestParseError("no revision for project %s within %s" %
772 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700773
774 path = node.getAttribute('path')
775 if not path:
776 path = name
777 if path.startswith('/'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530778 raise ManifestParseError("project %s path cannot be absolute in %s" %
779 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700780
Mike Pontillod3153822012-02-28 11:53:24 -0800781 rebase = node.getAttribute('rebase')
782 if not rebase:
783 rebase = True
784 else:
785 rebase = rebase.lower() in ("yes", "true", "1")
786
Anatol Pomazau79770d22012-04-20 14:41:59 -0700787 sync_c = node.getAttribute('sync-c')
788 if not sync_c:
789 sync_c = False
790 else:
791 sync_c = sync_c.lower() in ("yes", "true", "1")
792
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800793 sync_s = node.getAttribute('sync-s')
794 if not sync_s:
795 sync_s = self._default.sync_s
796 else:
797 sync_s = sync_s.lower() in ("yes", "true", "1")
798
David Pursehouseede7f122012-11-27 22:25:30 +0900799 clone_depth = node.getAttribute('clone-depth')
800 if clone_depth:
801 try:
802 clone_depth = int(clone_depth)
803 if clone_depth <= 0:
804 raise ValueError()
805 except ValueError:
806 raise ManifestParseError('invalid clone-depth %s in %s' %
807 (clone_depth, self.manifestFile))
808
Bryan Jacobsf609f912013-05-06 13:36:24 -0400809 dest_branch = node.getAttribute('dest-branch') or self._default.destBranchExpr
810
Brian Harring14a66742012-09-28 20:21:57 -0700811 upstream = node.getAttribute('upstream')
812
Conley Owens971de8e2012-04-16 10:36:08 -0700813 groups = ''
814 if node.hasAttribute('groups'):
815 groups = node.getAttribute('groups')
Josh Triplett884a3872014-06-12 14:57:29 -0700816 groups = self._ParseGroups(groups)
Brian Harring7da13142012-06-15 02:24:20 -0700817
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800818 if parent is None:
David James8d201162013-10-11 17:03:19 -0700819 relpath, worktree, gitdir, objdir = self.GetProjectPaths(name, path)
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700820 else:
David James8d201162013-10-11 17:03:19 -0700821 relpath, worktree, gitdir, objdir = \
822 self.GetSubprojectPaths(parent, name, path)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800823
824 default_groups = ['all', 'name:%s' % name, 'path:%s' % relpath]
825 groups.extend(set(default_groups).difference(groups))
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700826
Scott Fandb83b1b2013-02-28 09:34:14 +0800827 if self.IsMirror and node.hasAttribute('force-path'):
828 if node.getAttribute('force-path').lower() in ("yes", "true", "1"):
829 gitdir = os.path.join(self.topdir, '%s.git' % path)
830
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700831 project = Project(manifest = self,
832 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700833 remote = remote.ToRemoteSpec(name),
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700834 gitdir = gitdir,
David James8d201162013-10-11 17:03:19 -0700835 objdir = objdir,
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700836 worktree = worktree,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800837 relpath = relpath,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700838 revisionExpr = revisionExpr,
Mike Pontillod3153822012-02-28 11:53:24 -0800839 revisionId = None,
Colin Cross5acde752012-03-28 20:15:45 -0700840 rebase = rebase,
Anatol Pomazau79770d22012-04-20 14:41:59 -0700841 groups = groups,
Brian Harring14a66742012-09-28 20:21:57 -0700842 sync_c = sync_c,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800843 sync_s = sync_s,
David Pursehouseede7f122012-11-27 22:25:30 +0900844 clone_depth = clone_depth,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800845 upstream = upstream,
Bryan Jacobsf609f912013-05-06 13:36:24 -0400846 parent = parent,
Simran Basib9a1b732015-08-20 12:19:28 -0700847 dest_branch = dest_branch,
848 **extra_proj_attrs)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700849
850 for n in node.childNodes:
Shawn O. Pearce242b5262009-05-19 13:00:29 -0700851 if n.nodeName == 'copyfile':
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700852 self._ParseCopyFile(project, n)
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500853 if n.nodeName == 'linkfile':
854 self._ParseLinkFile(project, n)
James W. Mills24c13082012-04-12 15:04:13 -0500855 if n.nodeName == 'annotation':
856 self._ParseAnnotation(project, n)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800857 if n.nodeName == 'project':
858 project.subprojects.append(self._ParseProject(n, parent = project))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700859
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700860 return project
861
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800862 def GetProjectPaths(self, name, path):
863 relpath = path
864 if self.IsMirror:
865 worktree = None
866 gitdir = os.path.join(self.topdir, '%s.git' % name)
David James8d201162013-10-11 17:03:19 -0700867 objdir = gitdir
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800868 else:
869 worktree = os.path.join(self.topdir, path).replace('\\', '/')
870 gitdir = os.path.join(self.repodir, 'projects', '%s.git' % path)
David James8d201162013-10-11 17:03:19 -0700871 objdir = os.path.join(self.repodir, 'project-objects', '%s.git' % name)
872 return relpath, worktree, gitdir, objdir
873
874 def GetProjectsWithName(self, name):
875 return self._projects.get(name, [])
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800876
877 def GetSubprojectName(self, parent, submodule_path):
878 return os.path.join(parent.name, submodule_path)
879
880 def _JoinRelpath(self, parent_relpath, relpath):
881 return os.path.join(parent_relpath, relpath)
882
883 def _UnjoinRelpath(self, parent_relpath, relpath):
884 return os.path.relpath(relpath, parent_relpath)
885
David James8d201162013-10-11 17:03:19 -0700886 def GetSubprojectPaths(self, parent, name, path):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800887 relpath = self._JoinRelpath(parent.relpath, path)
888 gitdir = os.path.join(parent.gitdir, 'subprojects', '%s.git' % path)
David James8d201162013-10-11 17:03:19 -0700889 objdir = os.path.join(parent.gitdir, 'subproject-objects', '%s.git' % name)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800890 if self.IsMirror:
891 worktree = None
892 else:
893 worktree = os.path.join(parent.worktree, path).replace('\\', '/')
David James8d201162013-10-11 17:03:19 -0700894 return relpath, worktree, gitdir, objdir
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800895
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700896 def _ParseCopyFile(self, project, node):
897 src = self._reqatt(node, 'src')
898 dest = self._reqatt(node, 'dest')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800899 if not self.IsMirror:
900 # src is project relative;
901 # dest is relative to the top of the tree
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800902 project.AddCopyFile(src, dest, os.path.join(self.topdir, dest))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700903
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500904 def _ParseLinkFile(self, project, node):
905 src = self._reqatt(node, 'src')
906 dest = self._reqatt(node, 'dest')
907 if not self.IsMirror:
908 # src is project relative;
909 # dest is relative to the top of the tree
910 project.AddLinkFile(src, dest, os.path.join(self.topdir, dest))
911
James W. Mills24c13082012-04-12 15:04:13 -0500912 def _ParseAnnotation(self, project, node):
913 name = self._reqatt(node, 'name')
914 value = self._reqatt(node, 'value')
915 try:
916 keep = self._reqatt(node, 'keep').lower()
917 except ManifestParseError:
918 keep = "true"
919 if keep != "true" and keep != "false":
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530920 raise ManifestParseError('optional "keep" attribute must be '
921 '"true" or "false"')
James W. Mills24c13082012-04-12 15:04:13 -0500922 project.AddAnnotation(name, value, keep)
923
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700924 def _get_remote(self, node):
925 name = node.getAttribute('remote')
926 if not name:
927 return None
928
929 v = self._remotes.get(name)
930 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530931 raise ManifestParseError("remote %s not defined in %s" %
932 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700933 return v
934
935 def _reqatt(self, node, attname):
936 """
937 reads a required attribute from the node.
938 """
939 v = node.getAttribute(attname)
940 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530941 raise ManifestParseError("no %s in <%s> within %s" %
942 (attname, node.nodeName, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700943 return v
Julien Camperguedd654222014-01-09 16:21:37 +0100944
945 def projectsDiff(self, manifest):
946 """return the projects differences between two manifests.
947
948 The diff will be from self to given manifest.
949
950 """
951 fromProjects = self.paths
952 toProjects = manifest.paths
953
Anthony King7446c592014-05-06 09:19:39 +0100954 fromKeys = sorted(fromProjects.keys())
955 toKeys = sorted(toProjects.keys())
Julien Camperguedd654222014-01-09 16:21:37 +0100956
957 diff = {'added': [], 'removed': [], 'changed': [], 'unreachable': []}
958
959 for proj in fromKeys:
960 if not proj in toKeys:
961 diff['removed'].append(fromProjects[proj])
962 else:
963 fromProj = fromProjects[proj]
964 toProj = toProjects[proj]
965 try:
966 fromRevId = fromProj.GetCommitRevisionId()
967 toRevId = toProj.GetCommitRevisionId()
968 except ManifestInvalidRevisionError:
969 diff['unreachable'].append((fromProj, toProj))
970 else:
971 if fromRevId != toRevId:
972 diff['changed'].append((fromProj, toProj))
973 toKeys.remove(proj)
974
975 for proj in toKeys:
976 diff['added'].append(toProjects[proj])
977
978 return diff
Simran Basib9a1b732015-08-20 12:19:28 -0700979
980
981class GitcManifest(XmlManifest):
982
983 def __init__(self, repodir, gitc_client_name):
984 """Initialize the GitcManifest object."""
985 super(GitcManifest, self).__init__(repodir)
986 self.isGitcClient = True
987 self.gitc_client_name = gitc_client_name
Simran Basi8ce50412015-08-28 14:25:44 -0700988 self.gitc_client_dir = os.path.join(gitc_utils.get_gitc_manifest_dir(),
Simran Basib9a1b732015-08-20 12:19:28 -0700989 gitc_client_name)
990 self.manifestFile = os.path.join(self.gitc_client_dir, '.manifest')
991
992 def _ParseProject(self, node, parent = None):
993 """Override _ParseProject and add support for GITC specific attributes."""
994 return super(GitcManifest, self)._ParseProject(
995 node, parent=parent, old_revision=node.getAttribute('old-revision'))
996
997 def _output_manifest_project_extras(self, p, e):
998 """Output GITC Specific Project attributes"""
999 if p.old_revision:
Stefan Beller66851062016-06-17 16:40:08 -07001000 e.setAttribute('old-revision', str(p.old_revision))
Simran Basib9a1b732015-08-20 12:19:28 -07001001