blob: 55d25a797abe8f85c450e10777183f7adc4058af [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.
Joe Kilner6e310792016-10-27 15:53:53 -070043urllib.parse.uses_relative.extend([
44 'ssh',
45 'git',
46 'persistent-https',
47 'sso',
48 'rpc'])
49urllib.parse.uses_netloc.extend([
50 'ssh',
51 'git',
52 'persistent-https',
53 'sso',
54 'rpc'])
Conley Owensdb728cd2011-09-26 16:34:01 -070055
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070056class _Default(object):
57 """Project defaults within the manifest."""
58
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -070059 revisionExpr = None
Conley Owensb6a16e62013-09-25 15:06:09 -070060 destBranchExpr = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070061 remote = None
Shawn O. Pearce6392c872011-09-22 17:44:31 -070062 sync_j = 1
Anatol Pomazau79770d22012-04-20 14:41:59 -070063 sync_c = False
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +080064 sync_s = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070065
Julien Campergue74879922013-10-09 14:38:46 +020066 def __eq__(self, other):
67 return self.__dict__ == other.__dict__
68
69 def __ne__(self, other):
70 return self.__dict__ != other.__dict__
71
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070072class _XmlRemote(object):
73 def __init__(self,
74 name,
Yestin Sunb292b982012-07-02 07:32:50 -070075 alias=None,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070076 fetch=None,
Steve Raed6480452016-08-10 15:00:00 -070077 pushUrl=None,
Conley Owensdb728cd2011-09-26 16:34:01 -070078 manifestUrl=None,
Anthony King36ea2fb2014-05-06 11:54:01 +010079 review=None,
Jonathan Nieder93719792015-03-17 11:29:58 -070080 revision=None):
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070081 self.name = name
82 self.fetchUrl = fetch
Steve Raed6480452016-08-10 15:00:00 -070083 self.pushUrl = pushUrl
Conley Owensdb728cd2011-09-26 16:34:01 -070084 self.manifestUrl = manifestUrl
Yestin Sunb292b982012-07-02 07:32:50 -070085 self.remoteAlias = alias
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070086 self.reviewUrl = review
Anthony King36ea2fb2014-05-06 11:54:01 +010087 self.revision = revision
Conley Owensceea3682011-10-20 10:45:47 -070088 self.resolvedFetchUrl = self._resolveFetchUrl()
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070089
David Pursehouse717ece92012-11-13 08:49:16 +090090 def __eq__(self, other):
91 return self.__dict__ == other.__dict__
92
93 def __ne__(self, other):
94 return self.__dict__ != other.__dict__
95
Conley Owensceea3682011-10-20 10:45:47 -070096 def _resolveFetchUrl(self):
97 url = self.fetchUrl.rstrip('/')
Conley Owensdb728cd2011-09-26 16:34:01 -070098 manifestUrl = self.manifestUrl.rstrip('/')
Conley Owens2d0f5082014-01-31 15:03:51 -080099 # urljoin will gets confused over quite a few things. The ones we care
100 # about here are:
101 # * no scheme in the base url, like <hostname:port>
Anthony Kingcb07ba72015-03-28 23:26:04 +0000102 # We handle no scheme by replacing it with an obscure protocol, gopher
103 # and then replacing it with the original when we are done.
104
Conley Owensdb728cd2011-09-26 16:34:01 -0700105 if manifestUrl.find(':') != manifestUrl.find('/') - 1:
Conley Owens4ccad752015-04-29 10:45:37 -0700106 url = urllib.parse.urljoin('gopher://' + manifestUrl, url)
107 url = re.sub(r'^gopher://', '', url)
Anthony Kingcb07ba72015-03-28 23:26:04 +0000108 else:
109 url = urllib.parse.urljoin(manifestUrl, url)
Shawn Pearcea9f11b32013-01-02 15:40:48 -0800110 return url
Conley Owensceea3682011-10-20 10:45:47 -0700111
112 def ToRemoteSpec(self, projectName):
David Rileye0684ad2017-04-05 00:02:59 -0700113 fetchUrl = self.resolvedFetchUrl.rstrip('/')
114 url = fetchUrl + '/' + projectName
Yestin Sunb292b982012-07-02 07:32:50 -0700115 remoteName = self.name
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700116 if self.remoteAlias:
David Pursehouse37128b62013-10-15 10:48:40 +0900117 remoteName = self.remoteAlias
Dan Willemsen96c2d652016-04-06 16:03:54 -0700118 return RemoteSpec(remoteName,
119 url=url,
Steve Raed6480452016-08-10 15:00:00 -0700120 pushUrl=self.pushUrl,
Dan Willemsen96c2d652016-04-06 16:03:54 -0700121 review=self.reviewUrl,
David Rileye0684ad2017-04-05 00:02:59 -0700122 orig_name=self.name,
123 fetchUrl=self.fetchUrl)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700124
Shawn O. Pearcec8a300f2009-05-18 13:19:57 -0700125class XmlManifest(object):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700126 """manages the repo configuration file"""
127
128 def __init__(self, repodir):
129 self.repodir = os.path.abspath(repodir)
130 self.topdir = os.path.dirname(self.repodir)
131 self.manifestFile = os.path.join(self.repodir, MANIFEST_FILE_NAME)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700132 self.globalConfig = GitConfig.ForUser()
David Pursehouse4eb285c2013-02-14 16:28:44 +0900133 self.localManifestWarning = False
Simran Basib9a1b732015-08-20 12:19:28 -0700134 self.isGitcClient = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700135
136 self.repoProject = MetaProject(self, 'repo',
137 gitdir = os.path.join(repodir, 'repo/.git'),
138 worktree = os.path.join(repodir, 'repo'))
139
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700140 self.manifestProject = MetaProject(self, 'manifests',
Shawn O. Pearcef5c25a62008-11-04 08:11:53 -0800141 gitdir = os.path.join(repodir, 'manifests.git'),
142 worktree = os.path.join(repodir, 'manifests'))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700143
144 self._Unload()
145
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700146 def Override(self, name):
147 """Use a different manifest, just for the current instantiation.
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700148 """
149 path = os.path.join(self.manifestProject.worktree, name)
150 if not os.path.isfile(path):
151 raise ManifestParseError('manifest %s not found' % name)
152
153 old = self.manifestFile
154 try:
155 self.manifestFile = path
156 self._Unload()
157 self._Load()
158 finally:
159 self.manifestFile = old
160
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700161 def Link(self, name):
162 """Update the repo metadata to use a different manifest.
163 """
164 self.Override(name)
165
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700166 try:
Sebastian Frias223bf962012-11-21 19:09:25 +0100167 if os.path.lexists(self.manifestFile):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700168 os.remove(self.manifestFile)
Renaud Paquay6a470be2016-11-01 11:25:15 -0700169 os.symlink(os.path.join('manifests', name), self.manifestFile)
Sebastian Frias223bf962012-11-21 19:09:25 +0100170 except OSError as e:
171 raise ManifestParseError('cannot link manifest %s: %s' % (name, str(e)))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700172
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800173 def _RemoteToXml(self, r, doc, root):
174 e = doc.createElement('remote')
175 root.appendChild(e)
176 e.setAttribute('name', r.name)
177 e.setAttribute('fetch', r.fetchUrl)
Steve Raed6480452016-08-10 15:00:00 -0700178 if r.pushUrl is not None:
179 e.setAttribute('pushurl', r.pushUrl)
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700180 if r.remoteAlias is not None:
181 e.setAttribute('alias', r.remoteAlias)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800182 if r.reviewUrl is not None:
183 e.setAttribute('review', r.reviewUrl)
Anthony King36ea2fb2014-05-06 11:54:01 +0100184 if r.revision is not None:
185 e.setAttribute('revision', r.revision)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800186
Josh Triplett884a3872014-06-12 14:57:29 -0700187 def _ParseGroups(self, groups):
188 return [x for x in re.split(r'[,\s]+', groups) if x]
189
Dan Willemsen5ea32d12015-09-08 13:27:20 -0700190 def Save(self, fd, peg_rev=False, peg_rev_upstream=True, groups=None):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800191 """Write the current manifest out to the given file descriptor.
192 """
Colin Cross5acde752012-03-28 20:15:45 -0700193 mp = self.manifestProject
194
Dan Willemsen5ea32d12015-09-08 13:27:20 -0700195 if groups is None:
196 groups = mp.config.GetString('manifest.groups')
Matt Gumbel0c635bb2012-12-21 10:14:53 -0800197 if groups:
Josh Triplett884a3872014-06-12 14:57:29 -0700198 groups = self._ParseGroups(groups)
Colin Cross5acde752012-03-28 20:15:45 -0700199
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800200 doc = xml.dom.minidom.Document()
201 root = doc.createElement('manifest')
202 doc.appendChild(root)
203
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700204 # Save out the notice. There's a little bit of work here to give it the
205 # right whitespace, which assumes that the notice is automatically indented
206 # by 4 by minidom.
207 if self.notice:
208 notice_element = root.appendChild(doc.createElement('notice'))
209 notice_lines = self.notice.splitlines()
210 indented_notice = ('\n'.join(" "*4 + line for line in notice_lines))[4:]
211 notice_element.appendChild(doc.createTextNode(indented_notice))
212
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800213 d = self.default
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800214
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530215 for r in sorted(self.remotes):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800216 self._RemoteToXml(self.remotes[r], doc, root)
217 if self.remotes:
218 root.appendChild(doc.createTextNode(''))
219
220 have_default = False
221 e = doc.createElement('default')
222 if d.remote:
223 have_default = True
224 e.setAttribute('remote', d.remote.name)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700225 if d.revisionExpr:
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800226 have_default = True
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700227 e.setAttribute('revision', d.revisionExpr)
Simon Ruggier7e59de22015-07-24 12:50:06 +0200228 if d.destBranchExpr:
229 have_default = True
230 e.setAttribute('dest-branch', d.destBranchExpr)
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700231 if d.sync_j > 1:
232 have_default = True
233 e.setAttribute('sync-j', '%d' % d.sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700234 if d.sync_c:
235 have_default = True
236 e.setAttribute('sync-c', 'true')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800237 if d.sync_s:
238 have_default = True
239 e.setAttribute('sync-s', 'true')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800240 if have_default:
241 root.appendChild(e)
242 root.appendChild(doc.createTextNode(''))
243
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700244 if self._manifest_server:
245 e = doc.createElement('manifest-server')
246 e.setAttribute('url', self._manifest_server)
247 root.appendChild(e)
248 root.appendChild(doc.createTextNode(''))
249
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800250 def output_projects(parent, parent_node, projects):
David James8d201162013-10-11 17:03:19 -0700251 for project_name in projects:
252 for project in self._projects[project_name]:
253 output_project(parent, parent_node, project)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800254
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800255 def output_project(parent, parent_node, p):
Colin Cross5acde752012-03-28 20:15:45 -0700256 if not p.MatchesGroups(groups):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800257 return
258
259 name = p.name
260 relpath = p.relpath
261 if parent:
262 name = self._UnjoinName(parent.name, name)
263 relpath = self._UnjoinRelpath(parent.relpath, relpath)
Colin Cross5acde752012-03-28 20:15:45 -0700264
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800265 e = doc.createElement('project')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800266 parent_node.appendChild(e)
267 e.setAttribute('name', name)
268 if relpath != name:
269 e.setAttribute('path', relpath)
Conley Owensa17d7af2013-10-16 14:38:09 -0700270 remoteName = None
271 if d.remote:
Dan Willemsen96c2d652016-04-06 16:03:54 -0700272 remoteName = d.remote.name
273 if not d.remote or p.remote.orig_name != remoteName:
274 remoteName = p.remote.orig_name
Anthony King36ea2fb2014-05-06 11:54:01 +0100275 e.setAttribute('remote', remoteName)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800276 if peg_rev:
277 if self.IsMirror:
Brian Harring14a66742012-09-28 20:21:57 -0700278 value = p.bare_git.rev_parse(p.revisionExpr + '^0')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800279 else:
Brian Harring14a66742012-09-28 20:21:57 -0700280 value = p.work_git.rev_parse(HEAD + '^0')
281 e.setAttribute('revision', value)
Conley Owens551dfec2015-07-10 14:54:54 -0700282 if peg_rev_upstream:
283 if p.upstream:
284 e.setAttribute('upstream', p.upstream)
285 elif value != p.revisionExpr:
286 # Only save the origin if the origin is not a sha1, and the default
287 # isn't our value
288 e.setAttribute('upstream', p.revisionExpr)
Anthony King36ea2fb2014-05-06 11:54:01 +0100289 else:
Dan Willemsen96c2d652016-04-06 16:03:54 -0700290 revision = self.remotes[p.remote.orig_name].revision or d.revisionExpr
Anthony King36ea2fb2014-05-06 11:54:01 +0100291 if not revision or revision != p.revisionExpr:
292 e.setAttribute('revision', p.revisionExpr)
Mani Chandel7a91d512014-07-24 16:27:08 +0530293 if p.upstream and p.upstream != p.revisionExpr:
294 e.setAttribute('upstream', p.upstream)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800295
Simon Ruggier7e59de22015-07-24 12:50:06 +0200296 if p.dest_branch and p.dest_branch != d.destBranchExpr:
297 e.setAttribute('dest-branch', p.dest_branch)
298
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800299 for c in p.copyfiles:
300 ce = doc.createElement('copyfile')
301 ce.setAttribute('src', c.src)
302 ce.setAttribute('dest', c.dest)
303 e.appendChild(ce)
304
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500305 for l in p.linkfiles:
306 le = doc.createElement('linkfile')
307 le.setAttribute('src', l.src)
308 le.setAttribute('dest', l.dest)
309 e.appendChild(le)
310
Conley Owensbb1b5f52012-08-13 13:11:18 -0700311 default_groups = ['all', 'name:%s' % p.name, 'path:%s' % p.relpath]
Dmitry Fink17f85ea2012-08-06 14:52:29 -0700312 egroups = [g for g in p.groups if g not in default_groups]
Conley Owens971de8e2012-04-16 10:36:08 -0700313 if egroups:
314 e.setAttribute('groups', ','.join(egroups))
Colin Cross5acde752012-03-28 20:15:45 -0700315
James W. Mills24c13082012-04-12 15:04:13 -0500316 for a in p.annotations:
317 if a.keep == "true":
318 ae = doc.createElement('annotation')
319 ae.setAttribute('name', a.name)
320 ae.setAttribute('value', a.value)
321 e.appendChild(ae)
322
Anatol Pomazau79770d22012-04-20 14:41:59 -0700323 if p.sync_c:
324 e.setAttribute('sync-c', 'true')
325
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800326 if p.sync_s:
327 e.setAttribute('sync-s', 'true')
328
Dan Willemsen88409222015-08-17 15:29:10 -0700329 if p.clone_depth:
330 e.setAttribute('clone-depth', str(p.clone_depth))
331
Simran Basib9a1b732015-08-20 12:19:28 -0700332 self._output_manifest_project_extras(p, e)
333
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800334 if p.subprojects:
David James8d201162013-10-11 17:03:19 -0700335 subprojects = set(subp.name for subp in p.subprojects)
336 output_projects(p, e, list(sorted(subprojects)))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800337
David James8d201162013-10-11 17:03:19 -0700338 projects = set(p.name for p in self._paths.values() if not p.parent)
339 output_projects(None, root, list(sorted(projects)))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800340
Doug Anderson37282b42011-03-04 11:54:18 -0800341 if self._repo_hooks_project:
342 root.appendChild(doc.createTextNode(''))
343 e = doc.createElement('repo-hooks')
344 e.setAttribute('in-project', self._repo_hooks_project.name)
345 e.setAttribute('enabled-list',
346 ' '.join(self._repo_hooks_project.enabled_repo_hooks))
347 root.appendChild(e)
348
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800349 doc.writexml(fd, '', ' ', '\n', 'UTF-8')
350
Simran Basib9a1b732015-08-20 12:19:28 -0700351 def _output_manifest_project_extras(self, p, e):
352 """Manifests can modify e if they support extra project attributes."""
353 pass
354
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700355 @property
David James8d201162013-10-11 17:03:19 -0700356 def paths(self):
357 self._Load()
358 return self._paths
359
360 @property
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700361 def projects(self):
362 self._Load()
Anthony Kingd58bfe52014-05-05 23:30:49 +0100363 return list(self._paths.values())
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700364
365 @property
366 def remotes(self):
367 self._Load()
368 return self._remotes
369
370 @property
371 def default(self):
372 self._Load()
373 return self._default
374
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800375 @property
Doug Anderson37282b42011-03-04 11:54:18 -0800376 def repo_hooks_project(self):
377 self._Load()
378 return self._repo_hooks_project
379
380 @property
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700381 def notice(self):
382 self._Load()
383 return self._notice
384
385 @property
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700386 def manifest_server(self):
387 self._Load()
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -0800388 return self._manifest_server
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700389
390 @property
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800391 def IsMirror(self):
392 return self.manifestProject.config.GetBoolean('repo.mirror')
393
Julien Campergue335f5ef2013-10-16 11:02:35 +0200394 @property
395 def IsArchive(self):
396 return self.manifestProject.config.GetBoolean('repo.archive')
397
Martin Kellye4e94d22017-03-21 16:05:12 -0700398 @property
399 def HasSubmodules(self):
400 return self.manifestProject.config.GetBoolean('repo.submodules')
401
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700402 def _Unload(self):
403 self._loaded = False
404 self._projects = {}
David James8d201162013-10-11 17:03:19 -0700405 self._paths = {}
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700406 self._remotes = {}
407 self._default = None
Doug Anderson37282b42011-03-04 11:54:18 -0800408 self._repo_hooks_project = None
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700409 self._notice = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700410 self.branch = None
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700411 self._manifest_server = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700412
413 def _Load(self):
414 if not self._loaded:
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800415 m = self.manifestProject
416 b = m.GetBranch(m.CurrentBranch).merge
Shawn O. Pearce21c5c342009-06-25 16:47:30 -0700417 if b is not None and b.startswith(R_HEADS):
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800418 b = b[len(R_HEADS):]
419 self.branch = b
420
Colin Cross23acdd32012-04-21 00:33:54 -0700421 nodes = []
Brian Harring475a47d2012-06-07 20:05:35 -0700422 nodes.append(self._ParseManifestXml(self.manifestFile,
423 self.manifestProject.worktree))
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700424
425 local = os.path.join(self.repodir, LOCAL_MANIFEST_NAME)
426 if os.path.exists(local):
David Pursehouse4eb285c2013-02-14 16:28:44 +0900427 if not self.localManifestWarning:
428 self.localManifestWarning = True
429 print('warning: %s is deprecated; put local manifests in `%s` instead'
430 % (LOCAL_MANIFEST_NAME, os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME)),
431 file=sys.stderr)
Brian Harring475a47d2012-06-07 20:05:35 -0700432 nodes.append(self._ParseManifestXml(local, self.repodir))
Colin Cross23acdd32012-04-21 00:33:54 -0700433
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900434 local_dir = os.path.abspath(os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME))
435 try:
David Pursehouse52f1e5d2012-11-14 04:53:24 +0900436 for local_file in sorted(os.listdir(local_dir)):
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900437 if local_file.endswith('.xml'):
David Pursehouse5f434ed2012-11-22 13:48:10 +0900438 local = os.path.join(local_dir, local_file)
439 nodes.append(self._ParseManifestXml(local, self.repodir))
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900440 except OSError:
441 pass
442
Joe Onorato26e24752013-01-11 12:35:53 -0800443 try:
444 self._ParseManifest(nodes)
445 except ManifestParseError as e:
446 # There was a problem parsing, unload ourselves in case they catch
447 # this error and try again later, we will show the correct error
448 self._Unload()
449 raise e
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700450
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800451 if self.IsMirror:
452 self._AddMetaProjectMirror(self.repoProject)
453 self._AddMetaProjectMirror(self.manifestProject)
454
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700455 self._loaded = True
456
Brian Harring475a47d2012-06-07 20:05:35 -0700457 def _ParseManifestXml(self, path, include_root):
David Pursehousef7fc8a92012-11-13 04:00:28 +0900458 try:
459 root = xml.dom.minidom.parse(path)
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900460 except (OSError, xml.parsers.expat.ExpatError) as e:
David Pursehousef7fc8a92012-11-13 04:00:28 +0900461 raise ManifestParseError("error parsing manifest %s: %s" % (path, e))
462
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700463 if not root or not root.childNodes:
Brian Harring26448742011-04-28 05:04:41 -0700464 raise ManifestParseError("no root node in %s" % (path,))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700465
Jooncheol Park34acdd22012-08-27 02:25:59 +0900466 for manifest in root.childNodes:
467 if manifest.nodeName == 'manifest':
468 break
469 else:
Brian Harring26448742011-04-28 05:04:41 -0700470 raise ManifestParseError("no <manifest> in %s" % (path,))
471
Colin Cross23acdd32012-04-21 00:33:54 -0700472 nodes = []
David Pursehouse4f7bdea2012-10-22 12:50:15 +0900473 for node in manifest.childNodes: # pylint:disable=W0631
David Pursehouse5c6eeac2012-10-11 16:44:48 +0900474 # We only get here if manifest is initialised
David Pursehousec1b86a22012-11-14 11:36:51 +0900475 if node.nodeName == 'include':
476 name = self._reqatt(node, 'name')
477 fp = os.path.join(include_root, name)
478 if not os.path.isfile(fp):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530479 raise ManifestParseError("include %s doesn't exist or isn't a file"
480 % (name,))
David Pursehousec1b86a22012-11-14 11:36:51 +0900481 try:
482 nodes.extend(self._ParseManifestXml(fp, include_root))
483 # should isolate this to the exact exception, but that's
484 # tricky. actual parsing implementation may vary.
485 except (KeyboardInterrupt, RuntimeError, SystemExit):
486 raise
487 except Exception as e:
488 raise ManifestParseError(
489 "failed parsing included manifest %s: %s", (name, e))
490 else:
491 nodes.append(node)
Colin Cross23acdd32012-04-21 00:33:54 -0700492 return nodes
Brian Harring26448742011-04-28 05:04:41 -0700493
Colin Cross23acdd32012-04-21 00:33:54 -0700494 def _ParseManifest(self, node_list):
495 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700496 if node.nodeName == 'remote':
497 remote = self._ParseRemote(node)
David Pursehouse717ece92012-11-13 08:49:16 +0900498 if remote:
499 if remote.name in self._remotes:
500 if remote != self._remotes[remote.name]:
501 raise ManifestParseError(
502 'remote %s already exists with different attributes' %
503 (remote.name))
504 else:
505 self._remotes[remote.name] = remote
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700506
Colin Cross23acdd32012-04-21 00:33:54 -0700507 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700508 if node.nodeName == 'default':
Julien Campergue74879922013-10-09 14:38:46 +0200509 new_default = self._ParseDefault(node)
510 if self._default is None:
511 self._default = new_default
512 elif new_default != self._default:
David Pursehouse37128b62013-10-15 10:48:40 +0900513 raise ManifestParseError('duplicate default in %s' %
514 (self.manifestFile))
Julien Campergue74879922013-10-09 14:38:46 +0200515
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700516 if self._default is None:
517 self._default = _Default()
518
Colin Cross23acdd32012-04-21 00:33:54 -0700519 for node in itertools.chain(*node_list):
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700520 if node.nodeName == 'notice':
521 if self._notice is not None:
Doug Anderson37282b42011-03-04 11:54:18 -0800522 raise ManifestParseError(
523 'duplicate notice in %s' %
524 (self.manifestFile))
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700525 self._notice = self._ParseNotice(node)
526
Colin Cross23acdd32012-04-21 00:33:54 -0700527 for node in itertools.chain(*node_list):
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700528 if node.nodeName == 'manifest-server':
529 url = self._reqatt(node, 'url')
530 if self._manifest_server is not None:
David Pursehousec1b86a22012-11-14 11:36:51 +0900531 raise ManifestParseError(
532 'duplicate manifest-server in %s' %
533 (self.manifestFile))
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700534 self._manifest_server = url
535
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800536 def recursively_add_projects(project):
David James8d201162013-10-11 17:03:19 -0700537 projects = self._projects.setdefault(project.name, [])
538 if project.relpath is None:
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800539 raise ManifestParseError(
David James8d201162013-10-11 17:03:19 -0700540 'missing path for %s in %s' %
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800541 (project.name, self.manifestFile))
David James8d201162013-10-11 17:03:19 -0700542 if project.relpath in self._paths:
543 raise ManifestParseError(
544 'duplicate path %s in %s' %
545 (project.relpath, self.manifestFile))
546 self._paths[project.relpath] = project
547 projects.append(project)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800548 for subproject in project.subprojects:
549 recursively_add_projects(subproject)
550
Colin Cross23acdd32012-04-21 00:33:54 -0700551 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700552 if node.nodeName == 'project':
553 project = self._ParseProject(node)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800554 recursively_add_projects(project)
Josh Triplett884a3872014-06-12 14:57:29 -0700555 if node.nodeName == 'extend-project':
556 name = self._reqatt(node, 'name')
557
558 if name not in self._projects:
559 raise ManifestParseError('extend-project element specifies non-existent '
560 'project: %s' % name)
561
562 path = node.getAttribute('path')
563 groups = node.getAttribute('groups')
564 if groups:
565 groups = self._ParseGroups(groups)
566
567 for p in self._projects[name]:
568 if path and p.relpath != path:
569 continue
570 if groups:
571 p.groups.extend(groups)
Doug Anderson37282b42011-03-04 11:54:18 -0800572 if node.nodeName == 'repo-hooks':
573 # Get the name of the project and the (space-separated) list of enabled.
574 repo_hooks_project = self._reqatt(node, 'in-project')
575 enabled_repo_hooks = self._reqatt(node, 'enabled-list').split()
576
577 # Only one project can be the hooks project
578 if self._repo_hooks_project is not None:
579 raise ManifestParseError(
580 'duplicate repo-hooks in %s' %
581 (self.manifestFile))
582
583 # Store a reference to the Project.
584 try:
David James8d201162013-10-11 17:03:19 -0700585 repo_hooks_projects = self._projects[repo_hooks_project]
Doug Anderson37282b42011-03-04 11:54:18 -0800586 except KeyError:
587 raise ManifestParseError(
588 'project %s not found for repo-hooks' %
589 (repo_hooks_project))
590
David James8d201162013-10-11 17:03:19 -0700591 if len(repo_hooks_projects) != 1:
592 raise ManifestParseError(
593 'internal error parsing repo-hooks in %s' %
594 (self.manifestFile))
595 self._repo_hooks_project = repo_hooks_projects[0]
596
Doug Anderson37282b42011-03-04 11:54:18 -0800597 # Store the enabled hooks in the Project object.
598 self._repo_hooks_project.enabled_repo_hooks = enabled_repo_hooks
Colin Cross23acdd32012-04-21 00:33:54 -0700599 if node.nodeName == 'remove-project':
600 name = self._reqatt(node, 'name')
David Jamesb8433df2014-01-30 10:11:17 -0800601
602 if name not in self._projects:
David Pursehousef9107482012-11-16 19:12:32 +0900603 raise ManifestParseError('remove-project element specifies non-existent '
604 'project: %s' % name)
Colin Cross23acdd32012-04-21 00:33:54 -0700605
David Jamesb8433df2014-01-30 10:11:17 -0800606 for p in self._projects[name]:
607 del self._paths[p.relpath]
608 del self._projects[name]
609
Colin Cross23acdd32012-04-21 00:33:54 -0700610 # If the manifest removes the hooks project, treat it as if it deleted
611 # the repo-hooks element too.
612 if self._repo_hooks_project and (self._repo_hooks_project.name == name):
613 self._repo_hooks_project = None
614
Doug Anderson37282b42011-03-04 11:54:18 -0800615
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800616 def _AddMetaProjectMirror(self, m):
617 name = None
618 m_url = m.GetRemote(m.remote.name).url
619 if m_url.endswith('/.git'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530620 raise ManifestParseError('refusing to mirror %s' % m_url)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800621
622 if self._default and self._default.remote:
Conley Owensceea3682011-10-20 10:45:47 -0700623 url = self._default.remote.resolvedFetchUrl
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800624 if not url.endswith('/'):
625 url += '/'
626 if m_url.startswith(url):
627 remote = self._default.remote
628 name = m_url[len(url):]
629
630 if name is None:
631 s = m_url.rindex('/') + 1
Conley Owensdb728cd2011-09-26 16:34:01 -0700632 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Shawn O. Pearcef35b2d92012-08-02 11:46:22 -0700633 remote = _XmlRemote('origin', fetch=m_url[:s], manifestUrl=manifestUrl)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800634 name = m_url[s:]
635
636 if name.endswith('.git'):
637 name = name[:-4]
638
639 if name not in self._projects:
640 m.PreSync()
641 gitdir = os.path.join(self.topdir, '%s.git' % name)
642 project = Project(manifest = self,
643 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700644 remote = remote.ToRemoteSpec(name),
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800645 gitdir = gitdir,
David James8d201162013-10-11 17:03:19 -0700646 objdir = gitdir,
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800647 worktree = None,
Kwanhong Leeccd218c2014-02-17 13:07:32 +0900648 relpath = name or None,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700649 revisionExpr = m.revisionExpr,
650 revisionId = None)
David James8d201162013-10-11 17:03:19 -0700651 self._projects[project.name] = [project]
Kwanhong Leeccd218c2014-02-17 13:07:32 +0900652 self._paths[project.relpath] = project
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800653
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700654 def _ParseRemote(self, node):
655 """
656 reads a <remote> element from the manifest file
657 """
658 name = self._reqatt(node, 'name')
Yestin Sunb292b982012-07-02 07:32:50 -0700659 alias = node.getAttribute('alias')
660 if alias == '':
661 alias = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700662 fetch = self._reqatt(node, 'fetch')
Steve Raed6480452016-08-10 15:00:00 -0700663 pushUrl = node.getAttribute('pushurl')
664 if pushUrl == '':
665 pushUrl = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700666 review = node.getAttribute('review')
Shawn O. Pearceae6e0942008-11-06 10:25:35 -0800667 if review == '':
668 review = None
Anthony King36ea2fb2014-05-06 11:54:01 +0100669 revision = node.getAttribute('revision')
670 if revision == '':
671 revision = None
Conley Owensdb728cd2011-09-26 16:34:01 -0700672 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Steve Raed6480452016-08-10 15:00:00 -0700673 return _XmlRemote(name, alias, fetch, pushUrl, manifestUrl, review, revision)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700674
675 def _ParseDefault(self, node):
676 """
677 reads a <default> element from the manifest file
678 """
679 d = _Default()
680 d.remote = self._get_remote(node)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700681 d.revisionExpr = node.getAttribute('revision')
682 if d.revisionExpr == '':
683 d.revisionExpr = None
Anatol Pomazau79770d22012-04-20 14:41:59 -0700684
Bryan Jacobsf609f912013-05-06 13:36:24 -0400685 d.destBranchExpr = node.getAttribute('dest-branch') or None
686
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700687 sync_j = node.getAttribute('sync-j')
688 if sync_j == '' or sync_j is None:
689 d.sync_j = 1
690 else:
691 d.sync_j = int(sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700692
693 sync_c = node.getAttribute('sync-c')
694 if not sync_c:
695 d.sync_c = False
696 else:
697 d.sync_c = sync_c.lower() in ("yes", "true", "1")
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800698
699 sync_s = node.getAttribute('sync-s')
700 if not sync_s:
701 d.sync_s = False
702 else:
703 d.sync_s = sync_s.lower() in ("yes", "true", "1")
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700704 return d
705
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700706 def _ParseNotice(self, node):
707 """
708 reads a <notice> element from the manifest file
709
710 The <notice> element is distinct from other tags in the XML in that the
711 data is conveyed between the start and end tag (it's not an empty-element
712 tag).
713
714 The white space (carriage returns, indentation) for the notice element is
715 relevant and is parsed in a way that is based on how python docstrings work.
716 In fact, the code is remarkably similar to here:
717 http://www.python.org/dev/peps/pep-0257/
718 """
719 # Get the data out of the node...
720 notice = node.childNodes[0].data
721
722 # Figure out minimum indentation, skipping the first line (the same line
723 # as the <notice> tag)...
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530724 minIndent = sys.maxsize
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700725 lines = notice.splitlines()
726 for line in lines[1:]:
727 lstrippedLine = line.lstrip()
728 if lstrippedLine:
729 indent = len(line) - len(lstrippedLine)
730 minIndent = min(indent, minIndent)
731
732 # Strip leading / trailing blank lines and also indentation.
733 cleanLines = [lines[0].strip()]
734 for line in lines[1:]:
735 cleanLines.append(line[minIndent:].rstrip())
736
737 # Clear completely blank lines from front and back...
738 while cleanLines and not cleanLines[0]:
739 del cleanLines[0]
740 while cleanLines and not cleanLines[-1]:
741 del cleanLines[-1]
742
743 return '\n'.join(cleanLines)
744
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800745 def _JoinName(self, parent_name, name):
746 return os.path.join(parent_name, name)
747
748 def _UnjoinName(self, parent_name, name):
749 return os.path.relpath(name, parent_name)
750
Simran Basib9a1b732015-08-20 12:19:28 -0700751 def _ParseProject(self, node, parent = None, **extra_proj_attrs):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700752 """
753 reads a <project> element from the manifest file
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700754 """
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700755 name = self._reqatt(node, 'name')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800756 if parent:
757 name = self._JoinName(parent.name, name)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700758
759 remote = self._get_remote(node)
760 if remote is None:
761 remote = self._default.remote
762 if remote is None:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530763 raise ManifestParseError("no remote for project %s within %s" %
764 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700765
Anthony King36ea2fb2014-05-06 11:54:01 +0100766 revisionExpr = node.getAttribute('revision') or remote.revision
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700767 if not revisionExpr:
768 revisionExpr = self._default.revisionExpr
769 if not revisionExpr:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530770 raise ManifestParseError("no revision for project %s within %s" %
771 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700772
773 path = node.getAttribute('path')
774 if not path:
775 path = name
776 if path.startswith('/'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530777 raise ManifestParseError("project %s path cannot be absolute in %s" %
778 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700779
Mike Pontillod3153822012-02-28 11:53:24 -0800780 rebase = node.getAttribute('rebase')
781 if not rebase:
782 rebase = True
783 else:
784 rebase = rebase.lower() in ("yes", "true", "1")
785
Anatol Pomazau79770d22012-04-20 14:41:59 -0700786 sync_c = node.getAttribute('sync-c')
787 if not sync_c:
788 sync_c = False
789 else:
790 sync_c = sync_c.lower() in ("yes", "true", "1")
791
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800792 sync_s = node.getAttribute('sync-s')
793 if not sync_s:
794 sync_s = self._default.sync_s
795 else:
796 sync_s = sync_s.lower() in ("yes", "true", "1")
797
David Pursehouseede7f122012-11-27 22:25:30 +0900798 clone_depth = node.getAttribute('clone-depth')
799 if clone_depth:
800 try:
801 clone_depth = int(clone_depth)
802 if clone_depth <= 0:
803 raise ValueError()
804 except ValueError:
805 raise ManifestParseError('invalid clone-depth %s in %s' %
806 (clone_depth, self.manifestFile))
807
Bryan Jacobsf609f912013-05-06 13:36:24 -0400808 dest_branch = node.getAttribute('dest-branch') or self._default.destBranchExpr
809
Brian Harring14a66742012-09-28 20:21:57 -0700810 upstream = node.getAttribute('upstream')
811
Conley Owens971de8e2012-04-16 10:36:08 -0700812 groups = ''
813 if node.hasAttribute('groups'):
814 groups = node.getAttribute('groups')
Josh Triplett884a3872014-06-12 14:57:29 -0700815 groups = self._ParseGroups(groups)
Brian Harring7da13142012-06-15 02:24:20 -0700816
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800817 if parent is None:
David James8d201162013-10-11 17:03:19 -0700818 relpath, worktree, gitdir, objdir = self.GetProjectPaths(name, path)
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700819 else:
David James8d201162013-10-11 17:03:19 -0700820 relpath, worktree, gitdir, objdir = \
821 self.GetSubprojectPaths(parent, name, path)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800822
823 default_groups = ['all', 'name:%s' % name, 'path:%s' % relpath]
824 groups.extend(set(default_groups).difference(groups))
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700825
Scott Fandb83b1b2013-02-28 09:34:14 +0800826 if self.IsMirror and node.hasAttribute('force-path'):
827 if node.getAttribute('force-path').lower() in ("yes", "true", "1"):
828 gitdir = os.path.join(self.topdir, '%s.git' % path)
829
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700830 project = Project(manifest = self,
831 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700832 remote = remote.ToRemoteSpec(name),
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700833 gitdir = gitdir,
David James8d201162013-10-11 17:03:19 -0700834 objdir = objdir,
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700835 worktree = worktree,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800836 relpath = relpath,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700837 revisionExpr = revisionExpr,
Mike Pontillod3153822012-02-28 11:53:24 -0800838 revisionId = None,
Colin Cross5acde752012-03-28 20:15:45 -0700839 rebase = rebase,
Anatol Pomazau79770d22012-04-20 14:41:59 -0700840 groups = groups,
Brian Harring14a66742012-09-28 20:21:57 -0700841 sync_c = sync_c,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800842 sync_s = sync_s,
David Pursehouseede7f122012-11-27 22:25:30 +0900843 clone_depth = clone_depth,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800844 upstream = upstream,
Bryan Jacobsf609f912013-05-06 13:36:24 -0400845 parent = parent,
Simran Basib9a1b732015-08-20 12:19:28 -0700846 dest_branch = dest_branch,
847 **extra_proj_attrs)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700848
849 for n in node.childNodes:
Shawn O. Pearce242b5262009-05-19 13:00:29 -0700850 if n.nodeName == 'copyfile':
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700851 self._ParseCopyFile(project, n)
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500852 if n.nodeName == 'linkfile':
853 self._ParseLinkFile(project, n)
James W. Mills24c13082012-04-12 15:04:13 -0500854 if n.nodeName == 'annotation':
855 self._ParseAnnotation(project, n)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800856 if n.nodeName == 'project':
857 project.subprojects.append(self._ParseProject(n, parent = project))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700858
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700859 return project
860
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800861 def GetProjectPaths(self, name, path):
862 relpath = path
863 if self.IsMirror:
864 worktree = None
865 gitdir = os.path.join(self.topdir, '%s.git' % name)
David James8d201162013-10-11 17:03:19 -0700866 objdir = gitdir
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800867 else:
868 worktree = os.path.join(self.topdir, path).replace('\\', '/')
869 gitdir = os.path.join(self.repodir, 'projects', '%s.git' % path)
David James8d201162013-10-11 17:03:19 -0700870 objdir = os.path.join(self.repodir, 'project-objects', '%s.git' % name)
871 return relpath, worktree, gitdir, objdir
872
873 def GetProjectsWithName(self, name):
874 return self._projects.get(name, [])
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800875
876 def GetSubprojectName(self, parent, submodule_path):
877 return os.path.join(parent.name, submodule_path)
878
879 def _JoinRelpath(self, parent_relpath, relpath):
880 return os.path.join(parent_relpath, relpath)
881
882 def _UnjoinRelpath(self, parent_relpath, relpath):
883 return os.path.relpath(relpath, parent_relpath)
884
David James8d201162013-10-11 17:03:19 -0700885 def GetSubprojectPaths(self, parent, name, path):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800886 relpath = self._JoinRelpath(parent.relpath, path)
887 gitdir = os.path.join(parent.gitdir, 'subprojects', '%s.git' % path)
David James8d201162013-10-11 17:03:19 -0700888 objdir = os.path.join(parent.gitdir, 'subproject-objects', '%s.git' % name)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800889 if self.IsMirror:
890 worktree = None
891 else:
892 worktree = os.path.join(parent.worktree, path).replace('\\', '/')
David James8d201162013-10-11 17:03:19 -0700893 return relpath, worktree, gitdir, objdir
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800894
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700895 def _ParseCopyFile(self, project, node):
896 src = self._reqatt(node, 'src')
897 dest = self._reqatt(node, 'dest')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800898 if not self.IsMirror:
899 # src is project relative;
900 # dest is relative to the top of the tree
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800901 project.AddCopyFile(src, dest, os.path.join(self.topdir, dest))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700902
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500903 def _ParseLinkFile(self, project, node):
904 src = self._reqatt(node, 'src')
905 dest = self._reqatt(node, 'dest')
906 if not self.IsMirror:
907 # src is project relative;
908 # dest is relative to the top of the tree
909 project.AddLinkFile(src, dest, os.path.join(self.topdir, dest))
910
James W. Mills24c13082012-04-12 15:04:13 -0500911 def _ParseAnnotation(self, project, node):
912 name = self._reqatt(node, 'name')
913 value = self._reqatt(node, 'value')
914 try:
915 keep = self._reqatt(node, 'keep').lower()
916 except ManifestParseError:
917 keep = "true"
918 if keep != "true" and keep != "false":
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530919 raise ManifestParseError('optional "keep" attribute must be '
920 '"true" or "false"')
James W. Mills24c13082012-04-12 15:04:13 -0500921 project.AddAnnotation(name, value, keep)
922
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700923 def _get_remote(self, node):
924 name = node.getAttribute('remote')
925 if not name:
926 return None
927
928 v = self._remotes.get(name)
929 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530930 raise ManifestParseError("remote %s not defined in %s" %
931 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700932 return v
933
934 def _reqatt(self, node, attname):
935 """
936 reads a required attribute from the node.
937 """
938 v = node.getAttribute(attname)
939 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530940 raise ManifestParseError("no %s in <%s> within %s" %
941 (attname, node.nodeName, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700942 return v
Julien Camperguedd654222014-01-09 16:21:37 +0100943
944 def projectsDiff(self, manifest):
945 """return the projects differences between two manifests.
946
947 The diff will be from self to given manifest.
948
949 """
950 fromProjects = self.paths
951 toProjects = manifest.paths
952
Anthony King7446c592014-05-06 09:19:39 +0100953 fromKeys = sorted(fromProjects.keys())
954 toKeys = sorted(toProjects.keys())
Julien Camperguedd654222014-01-09 16:21:37 +0100955
956 diff = {'added': [], 'removed': [], 'changed': [], 'unreachable': []}
957
958 for proj in fromKeys:
959 if not proj in toKeys:
960 diff['removed'].append(fromProjects[proj])
961 else:
962 fromProj = fromProjects[proj]
963 toProj = toProjects[proj]
964 try:
965 fromRevId = fromProj.GetCommitRevisionId()
966 toRevId = toProj.GetCommitRevisionId()
967 except ManifestInvalidRevisionError:
968 diff['unreachable'].append((fromProj, toProj))
969 else:
970 if fromRevId != toRevId:
971 diff['changed'].append((fromProj, toProj))
972 toKeys.remove(proj)
973
974 for proj in toKeys:
975 diff['added'].append(toProjects[proj])
976
977 return diff
Simran Basib9a1b732015-08-20 12:19:28 -0700978
979
980class GitcManifest(XmlManifest):
981
982 def __init__(self, repodir, gitc_client_name):
983 """Initialize the GitcManifest object."""
984 super(GitcManifest, self).__init__(repodir)
985 self.isGitcClient = True
986 self.gitc_client_name = gitc_client_name
Simran Basi8ce50412015-08-28 14:25:44 -0700987 self.gitc_client_dir = os.path.join(gitc_utils.get_gitc_manifest_dir(),
Simran Basib9a1b732015-08-20 12:19:28 -0700988 gitc_client_name)
989 self.manifestFile = os.path.join(self.gitc_client_dir, '.manifest')
990
991 def _ParseProject(self, node, parent = None):
992 """Override _ParseProject and add support for GITC specific attributes."""
993 return super(GitcManifest, self)._ParseProject(
994 node, parent=parent, old_revision=node.getAttribute('old-revision'))
995
996 def _output_manifest_project_extras(self, p, e):
997 """Output GITC Specific Project attributes"""
998 if p.old_revision:
Stefan Beller66851062016-06-17 16:40:08 -0700999 e.setAttribute('old-revision', str(p.old_revision))
Simran Basib9a1b732015-08-20 12:19:28 -07001000