blob: e2f58e621dd1b677236caecc357a0d909fbfab81 [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
David Pursehousee15c65a2012-08-22 10:46:11 +090032from git_config import GitConfig
David Pursehousee00aa6b2012-09-11 14:33:51 +090033from git_refs import R_HEADS, HEAD
34from project import RemoteSpec, Project, MetaProject
Julien Camperguedd654222014-01-09 16:21:37 +010035from error import ManifestParseError, ManifestInvalidRevisionError
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070036
37MANIFEST_FILE_NAME = 'manifest.xml'
Shawn O. Pearce5cc66792008-10-23 16:19:27 -070038LOCAL_MANIFEST_NAME = 'local_manifest.xml'
David Pursehouse2d5a0df2012-11-13 02:50:36 +090039LOCAL_MANIFESTS_DIR_NAME = 'local_manifests'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070040
Chirayu Desai217ea7d2013-03-01 19:14:38 +053041urllib.parse.uses_relative.extend(['ssh', 'git'])
42urllib.parse.uses_netloc.extend(['ssh', 'git'])
Conley Owensdb728cd2011-09-26 16:34:01 -070043
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070044class _Default(object):
45 """Project defaults within the manifest."""
46
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -070047 revisionExpr = None
Conley Owensb6a16e62013-09-25 15:06:09 -070048 destBranchExpr = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070049 remote = None
Shawn O. Pearce6392c872011-09-22 17:44:31 -070050 sync_j = 1
Anatol Pomazau79770d22012-04-20 14:41:59 -070051 sync_c = False
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +080052 sync_s = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070053
Julien Campergue74879922013-10-09 14:38:46 +020054 def __eq__(self, other):
55 return self.__dict__ == other.__dict__
56
57 def __ne__(self, other):
58 return self.__dict__ != other.__dict__
59
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070060class _XmlRemote(object):
61 def __init__(self,
62 name,
Yestin Sunb292b982012-07-02 07:32:50 -070063 alias=None,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070064 fetch=None,
Conley Owensdb728cd2011-09-26 16:34:01 -070065 manifestUrl=None,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070066 review=None):
67 self.name = name
68 self.fetchUrl = fetch
Conley Owensdb728cd2011-09-26 16:34:01 -070069 self.manifestUrl = manifestUrl
Yestin Sunb292b982012-07-02 07:32:50 -070070 self.remoteAlias = alias
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070071 self.reviewUrl = review
Conley Owensceea3682011-10-20 10:45:47 -070072 self.resolvedFetchUrl = self._resolveFetchUrl()
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070073
David Pursehouse717ece92012-11-13 08:49:16 +090074 def __eq__(self, other):
75 return self.__dict__ == other.__dict__
76
77 def __ne__(self, other):
78 return self.__dict__ != other.__dict__
79
Conley Owensceea3682011-10-20 10:45:47 -070080 def _resolveFetchUrl(self):
81 url = self.fetchUrl.rstrip('/')
Conley Owensdb728cd2011-09-26 16:34:01 -070082 manifestUrl = self.manifestUrl.rstrip('/')
Conley Owens2d0f5082014-01-31 15:03:51 -080083 # urljoin will gets confused over quite a few things. The ones we care
84 # about here are:
85 # * no scheme in the base url, like <hostname:port>
86 # * persistent-https://
87 # We handle this by replacing these with obscure protocols
88 # and then replacing them with the original when we are done.
89 # gopher -> <none>
90 # wais -> persistent-https
Conley Owensdb728cd2011-09-26 16:34:01 -070091 if manifestUrl.find(':') != manifestUrl.find('/') - 1:
David Pursehousec1b86a22012-11-14 11:36:51 +090092 manifestUrl = 'gopher://' + manifestUrl
Conley Owens2d0f5082014-01-31 15:03:51 -080093 manifestUrl = re.sub(r'^persistent-https://', 'wais://', manifestUrl)
Chirayu Desai217ea7d2013-03-01 19:14:38 +053094 url = urllib.parse.urljoin(manifestUrl, url)
Shawn Pearcea9f11b32013-01-02 15:40:48 -080095 url = re.sub(r'^gopher://', '', url)
Conley Owens2d0f5082014-01-31 15:03:51 -080096 url = re.sub(r'^wais://', 'persistent-https://', url)
Shawn Pearcea9f11b32013-01-02 15:40:48 -080097 return url
Conley Owensceea3682011-10-20 10:45:47 -070098
99 def ToRemoteSpec(self, projectName):
Conley Owens9d8f9142011-10-20 14:36:35 -0700100 url = self.resolvedFetchUrl.rstrip('/') + '/' + projectName
Yestin Sunb292b982012-07-02 07:32:50 -0700101 remoteName = self.name
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700102 if self.remoteAlias:
David Pursehouse37128b62013-10-15 10:48:40 +0900103 remoteName = self.remoteAlias
Yestin Sunb292b982012-07-02 07:32:50 -0700104 return RemoteSpec(remoteName, url, self.reviewUrl)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700105
Shawn O. Pearcec8a300f2009-05-18 13:19:57 -0700106class XmlManifest(object):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700107 """manages the repo configuration file"""
108
109 def __init__(self, repodir):
110 self.repodir = os.path.abspath(repodir)
111 self.topdir = os.path.dirname(self.repodir)
112 self.manifestFile = os.path.join(self.repodir, MANIFEST_FILE_NAME)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700113 self.globalConfig = GitConfig.ForUser()
David Pursehouse4eb285c2013-02-14 16:28:44 +0900114 self.localManifestWarning = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700115
116 self.repoProject = MetaProject(self, 'repo',
117 gitdir = os.path.join(repodir, 'repo/.git'),
118 worktree = os.path.join(repodir, 'repo'))
119
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700120 self.manifestProject = MetaProject(self, 'manifests',
Shawn O. Pearcef5c25a62008-11-04 08:11:53 -0800121 gitdir = os.path.join(repodir, 'manifests.git'),
122 worktree = os.path.join(repodir, 'manifests'))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700123
124 self._Unload()
125
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700126 def Override(self, name):
127 """Use a different manifest, just for the current instantiation.
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700128 """
129 path = os.path.join(self.manifestProject.worktree, name)
130 if not os.path.isfile(path):
131 raise ManifestParseError('manifest %s not found' % name)
132
133 old = self.manifestFile
134 try:
135 self.manifestFile = path
136 self._Unload()
137 self._Load()
138 finally:
139 self.manifestFile = old
140
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700141 def Link(self, name):
142 """Update the repo metadata to use a different manifest.
143 """
144 self.Override(name)
145
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700146 try:
Sebastian Frias223bf962012-11-21 19:09:25 +0100147 if os.path.lexists(self.manifestFile):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700148 os.remove(self.manifestFile)
149 os.symlink('manifests/%s' % name, self.manifestFile)
Sebastian Frias223bf962012-11-21 19:09:25 +0100150 except OSError as e:
151 raise ManifestParseError('cannot link manifest %s: %s' % (name, str(e)))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700152
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800153 def _RemoteToXml(self, r, doc, root):
154 e = doc.createElement('remote')
155 root.appendChild(e)
156 e.setAttribute('name', r.name)
157 e.setAttribute('fetch', r.fetchUrl)
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700158 if r.remoteAlias is not None:
159 e.setAttribute('alias', r.remoteAlias)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800160 if r.reviewUrl is not None:
161 e.setAttribute('review', r.reviewUrl)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800162
Brian Harring14a66742012-09-28 20:21:57 -0700163 def Save(self, fd, peg_rev=False, peg_rev_upstream=True):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800164 """Write the current manifest out to the given file descriptor.
165 """
Colin Cross5acde752012-03-28 20:15:45 -0700166 mp = self.manifestProject
167
168 groups = mp.config.GetString('manifest.groups')
Matt Gumbel0c635bb2012-12-21 10:14:53 -0800169 if groups:
170 groups = [x for x in re.split(r'[,\s]+', groups) if x]
Colin Cross5acde752012-03-28 20:15:45 -0700171
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800172 doc = xml.dom.minidom.Document()
173 root = doc.createElement('manifest')
174 doc.appendChild(root)
175
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700176 # Save out the notice. There's a little bit of work here to give it the
177 # right whitespace, which assumes that the notice is automatically indented
178 # by 4 by minidom.
179 if self.notice:
180 notice_element = root.appendChild(doc.createElement('notice'))
181 notice_lines = self.notice.splitlines()
182 indented_notice = ('\n'.join(" "*4 + line for line in notice_lines))[4:]
183 notice_element.appendChild(doc.createTextNode(indented_notice))
184
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800185 d = self.default
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800186
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530187 for r in sorted(self.remotes):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800188 self._RemoteToXml(self.remotes[r], doc, root)
189 if self.remotes:
190 root.appendChild(doc.createTextNode(''))
191
192 have_default = False
193 e = doc.createElement('default')
194 if d.remote:
195 have_default = True
196 e.setAttribute('remote', d.remote.name)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700197 if d.revisionExpr:
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800198 have_default = True
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700199 e.setAttribute('revision', d.revisionExpr)
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700200 if d.sync_j > 1:
201 have_default = True
202 e.setAttribute('sync-j', '%d' % d.sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700203 if d.sync_c:
204 have_default = True
205 e.setAttribute('sync-c', 'true')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800206 if d.sync_s:
207 have_default = True
208 e.setAttribute('sync-s', 'true')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800209 if have_default:
210 root.appendChild(e)
211 root.appendChild(doc.createTextNode(''))
212
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700213 if self._manifest_server:
214 e = doc.createElement('manifest-server')
215 e.setAttribute('url', self._manifest_server)
216 root.appendChild(e)
217 root.appendChild(doc.createTextNode(''))
218
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800219 def output_projects(parent, parent_node, projects):
David James8d201162013-10-11 17:03:19 -0700220 for project_name in projects:
221 for project in self._projects[project_name]:
222 output_project(parent, parent_node, project)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800223
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800224 def output_project(parent, parent_node, p):
Colin Cross5acde752012-03-28 20:15:45 -0700225 if not p.MatchesGroups(groups):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800226 return
227
228 name = p.name
229 relpath = p.relpath
230 if parent:
231 name = self._UnjoinName(parent.name, name)
232 relpath = self._UnjoinRelpath(parent.relpath, relpath)
Colin Cross5acde752012-03-28 20:15:45 -0700233
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800234 e = doc.createElement('project')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800235 parent_node.appendChild(e)
236 e.setAttribute('name', name)
237 if relpath != name:
238 e.setAttribute('path', relpath)
Conley Owensa17d7af2013-10-16 14:38:09 -0700239 remoteName = None
240 if d.remote:
Conley Owensce201a52013-10-16 14:42:42 -0700241 remoteName = d.remote.remoteAlias or d.remote.name
Conley Owens1e7ab2a2013-10-08 17:26:57 -0700242 if not d.remote or p.remote.name != remoteName:
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800243 e.setAttribute('remote', p.remote.name)
244 if peg_rev:
245 if self.IsMirror:
Brian Harring14a66742012-09-28 20:21:57 -0700246 value = p.bare_git.rev_parse(p.revisionExpr + '^0')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800247 else:
Brian Harring14a66742012-09-28 20:21:57 -0700248 value = p.work_git.rev_parse(HEAD + '^0')
249 e.setAttribute('revision', value)
250 if peg_rev_upstream and value != p.revisionExpr:
251 # Only save the origin if the origin is not a sha1, and the default
252 # isn't our value, and the if the default doesn't already have that
253 # covered.
254 e.setAttribute('upstream', p.revisionExpr)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700255 elif not d.revisionExpr or p.revisionExpr != d.revisionExpr:
256 e.setAttribute('revision', p.revisionExpr)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800257
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800258 for c in p.copyfiles:
259 ce = doc.createElement('copyfile')
260 ce.setAttribute('src', c.src)
261 ce.setAttribute('dest', c.dest)
262 e.appendChild(ce)
263
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500264 for l in p.linkfiles:
265 le = doc.createElement('linkfile')
266 le.setAttribute('src', l.src)
267 le.setAttribute('dest', l.dest)
268 e.appendChild(le)
269
Conley Owensbb1b5f52012-08-13 13:11:18 -0700270 default_groups = ['all', 'name:%s' % p.name, 'path:%s' % p.relpath]
Dmitry Fink17f85ea2012-08-06 14:52:29 -0700271 egroups = [g for g in p.groups if g not in default_groups]
Conley Owens971de8e2012-04-16 10:36:08 -0700272 if egroups:
273 e.setAttribute('groups', ','.join(egroups))
Colin Cross5acde752012-03-28 20:15:45 -0700274
James W. Mills24c13082012-04-12 15:04:13 -0500275 for a in p.annotations:
276 if a.keep == "true":
277 ae = doc.createElement('annotation')
278 ae.setAttribute('name', a.name)
279 ae.setAttribute('value', a.value)
280 e.appendChild(ae)
281
Anatol Pomazau79770d22012-04-20 14:41:59 -0700282 if p.sync_c:
283 e.setAttribute('sync-c', 'true')
284
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800285 if p.sync_s:
286 e.setAttribute('sync-s', 'true')
287
288 if p.subprojects:
David James8d201162013-10-11 17:03:19 -0700289 subprojects = set(subp.name for subp in p.subprojects)
290 output_projects(p, e, list(sorted(subprojects)))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800291
David James8d201162013-10-11 17:03:19 -0700292 projects = set(p.name for p in self._paths.values() if not p.parent)
293 output_projects(None, root, list(sorted(projects)))
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800294
Doug Anderson37282b42011-03-04 11:54:18 -0800295 if self._repo_hooks_project:
296 root.appendChild(doc.createTextNode(''))
297 e = doc.createElement('repo-hooks')
298 e.setAttribute('in-project', self._repo_hooks_project.name)
299 e.setAttribute('enabled-list',
300 ' '.join(self._repo_hooks_project.enabled_repo_hooks))
301 root.appendChild(e)
302
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800303 doc.writexml(fd, '', ' ', '\n', 'UTF-8')
304
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700305 @property
David James8d201162013-10-11 17:03:19 -0700306 def paths(self):
307 self._Load()
308 return self._paths
309
310 @property
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700311 def projects(self):
312 self._Load()
David James8d201162013-10-11 17:03:19 -0700313 return self._paths.values()
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700314
315 @property
316 def remotes(self):
317 self._Load()
318 return self._remotes
319
320 @property
321 def default(self):
322 self._Load()
323 return self._default
324
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800325 @property
Doug Anderson37282b42011-03-04 11:54:18 -0800326 def repo_hooks_project(self):
327 self._Load()
328 return self._repo_hooks_project
329
330 @property
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700331 def notice(self):
332 self._Load()
333 return self._notice
334
335 @property
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700336 def manifest_server(self):
337 self._Load()
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -0800338 return self._manifest_server
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700339
340 @property
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800341 def IsMirror(self):
342 return self.manifestProject.config.GetBoolean('repo.mirror')
343
Julien Campergue335f5ef2013-10-16 11:02:35 +0200344 @property
345 def IsArchive(self):
346 return self.manifestProject.config.GetBoolean('repo.archive')
347
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700348 def _Unload(self):
349 self._loaded = False
350 self._projects = {}
David James8d201162013-10-11 17:03:19 -0700351 self._paths = {}
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700352 self._remotes = {}
353 self._default = None
Doug Anderson37282b42011-03-04 11:54:18 -0800354 self._repo_hooks_project = None
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700355 self._notice = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700356 self.branch = None
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700357 self._manifest_server = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700358
359 def _Load(self):
360 if not self._loaded:
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800361 m = self.manifestProject
362 b = m.GetBranch(m.CurrentBranch).merge
Shawn O. Pearce21c5c342009-06-25 16:47:30 -0700363 if b is not None and b.startswith(R_HEADS):
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800364 b = b[len(R_HEADS):]
365 self.branch = b
366
Colin Cross23acdd32012-04-21 00:33:54 -0700367 nodes = []
Brian Harring475a47d2012-06-07 20:05:35 -0700368 nodes.append(self._ParseManifestXml(self.manifestFile,
369 self.manifestProject.worktree))
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700370
371 local = os.path.join(self.repodir, LOCAL_MANIFEST_NAME)
372 if os.path.exists(local):
David Pursehouse4eb285c2013-02-14 16:28:44 +0900373 if not self.localManifestWarning:
374 self.localManifestWarning = True
375 print('warning: %s is deprecated; put local manifests in `%s` instead'
376 % (LOCAL_MANIFEST_NAME, os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME)),
377 file=sys.stderr)
Brian Harring475a47d2012-06-07 20:05:35 -0700378 nodes.append(self._ParseManifestXml(local, self.repodir))
Colin Cross23acdd32012-04-21 00:33:54 -0700379
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900380 local_dir = os.path.abspath(os.path.join(self.repodir, LOCAL_MANIFESTS_DIR_NAME))
381 try:
David Pursehouse52f1e5d2012-11-14 04:53:24 +0900382 for local_file in sorted(os.listdir(local_dir)):
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900383 if local_file.endswith('.xml'):
David Pursehouse5f434ed2012-11-22 13:48:10 +0900384 local = os.path.join(local_dir, local_file)
385 nodes.append(self._ParseManifestXml(local, self.repodir))
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900386 except OSError:
387 pass
388
Joe Onorato26e24752013-01-11 12:35:53 -0800389 try:
390 self._ParseManifest(nodes)
391 except ManifestParseError as e:
392 # There was a problem parsing, unload ourselves in case they catch
393 # this error and try again later, we will show the correct error
394 self._Unload()
395 raise e
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700396
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800397 if self.IsMirror:
398 self._AddMetaProjectMirror(self.repoProject)
399 self._AddMetaProjectMirror(self.manifestProject)
400
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700401 self._loaded = True
402
Brian Harring475a47d2012-06-07 20:05:35 -0700403 def _ParseManifestXml(self, path, include_root):
David Pursehousef7fc8a92012-11-13 04:00:28 +0900404 try:
405 root = xml.dom.minidom.parse(path)
David Pursehouse2d5a0df2012-11-13 02:50:36 +0900406 except (OSError, xml.parsers.expat.ExpatError) as e:
David Pursehousef7fc8a92012-11-13 04:00:28 +0900407 raise ManifestParseError("error parsing manifest %s: %s" % (path, e))
408
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700409 if not root or not root.childNodes:
Brian Harring26448742011-04-28 05:04:41 -0700410 raise ManifestParseError("no root node in %s" % (path,))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700411
Jooncheol Park34acdd22012-08-27 02:25:59 +0900412 for manifest in root.childNodes:
413 if manifest.nodeName == 'manifest':
414 break
415 else:
Brian Harring26448742011-04-28 05:04:41 -0700416 raise ManifestParseError("no <manifest> in %s" % (path,))
417
Colin Cross23acdd32012-04-21 00:33:54 -0700418 nodes = []
David Pursehouse4f7bdea2012-10-22 12:50:15 +0900419 for node in manifest.childNodes: # pylint:disable=W0631
David Pursehouse5c6eeac2012-10-11 16:44:48 +0900420 # We only get here if manifest is initialised
David Pursehousec1b86a22012-11-14 11:36:51 +0900421 if node.nodeName == 'include':
422 name = self._reqatt(node, 'name')
423 fp = os.path.join(include_root, name)
424 if not os.path.isfile(fp):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530425 raise ManifestParseError("include %s doesn't exist or isn't a file"
426 % (name,))
David Pursehousec1b86a22012-11-14 11:36:51 +0900427 try:
428 nodes.extend(self._ParseManifestXml(fp, include_root))
429 # should isolate this to the exact exception, but that's
430 # tricky. actual parsing implementation may vary.
431 except (KeyboardInterrupt, RuntimeError, SystemExit):
432 raise
433 except Exception as e:
434 raise ManifestParseError(
435 "failed parsing included manifest %s: %s", (name, e))
436 else:
437 nodes.append(node)
Colin Cross23acdd32012-04-21 00:33:54 -0700438 return nodes
Brian Harring26448742011-04-28 05:04:41 -0700439
Colin Cross23acdd32012-04-21 00:33:54 -0700440 def _ParseManifest(self, node_list):
441 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700442 if node.nodeName == 'remote':
443 remote = self._ParseRemote(node)
David Pursehouse717ece92012-11-13 08:49:16 +0900444 if remote:
445 if remote.name in self._remotes:
446 if remote != self._remotes[remote.name]:
447 raise ManifestParseError(
448 'remote %s already exists with different attributes' %
449 (remote.name))
450 else:
451 self._remotes[remote.name] = remote
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700452
Colin Cross23acdd32012-04-21 00:33:54 -0700453 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700454 if node.nodeName == 'default':
Julien Campergue74879922013-10-09 14:38:46 +0200455 new_default = self._ParseDefault(node)
456 if self._default is None:
457 self._default = new_default
458 elif new_default != self._default:
David Pursehouse37128b62013-10-15 10:48:40 +0900459 raise ManifestParseError('duplicate default in %s' %
460 (self.manifestFile))
Julien Campergue74879922013-10-09 14:38:46 +0200461
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700462 if self._default is None:
463 self._default = _Default()
464
Colin Cross23acdd32012-04-21 00:33:54 -0700465 for node in itertools.chain(*node_list):
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700466 if node.nodeName == 'notice':
467 if self._notice is not None:
Doug Anderson37282b42011-03-04 11:54:18 -0800468 raise ManifestParseError(
469 'duplicate notice in %s' %
470 (self.manifestFile))
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700471 self._notice = self._ParseNotice(node)
472
Colin Cross23acdd32012-04-21 00:33:54 -0700473 for node in itertools.chain(*node_list):
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700474 if node.nodeName == 'manifest-server':
475 url = self._reqatt(node, 'url')
476 if self._manifest_server is not None:
David Pursehousec1b86a22012-11-14 11:36:51 +0900477 raise ManifestParseError(
478 'duplicate manifest-server in %s' %
479 (self.manifestFile))
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700480 self._manifest_server = url
481
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800482 def recursively_add_projects(project):
David James8d201162013-10-11 17:03:19 -0700483 projects = self._projects.setdefault(project.name, [])
484 if project.relpath is None:
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800485 raise ManifestParseError(
David James8d201162013-10-11 17:03:19 -0700486 'missing path for %s in %s' %
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800487 (project.name, self.manifestFile))
David James8d201162013-10-11 17:03:19 -0700488 if project.relpath in self._paths:
489 raise ManifestParseError(
490 'duplicate path %s in %s' %
491 (project.relpath, self.manifestFile))
492 self._paths[project.relpath] = project
493 projects.append(project)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800494 for subproject in project.subprojects:
495 recursively_add_projects(subproject)
496
Colin Cross23acdd32012-04-21 00:33:54 -0700497 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700498 if node.nodeName == 'project':
499 project = self._ParseProject(node)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800500 recursively_add_projects(project)
Doug Anderson37282b42011-03-04 11:54:18 -0800501 if node.nodeName == 'repo-hooks':
502 # Get the name of the project and the (space-separated) list of enabled.
503 repo_hooks_project = self._reqatt(node, 'in-project')
504 enabled_repo_hooks = self._reqatt(node, 'enabled-list').split()
505
506 # Only one project can be the hooks project
507 if self._repo_hooks_project is not None:
508 raise ManifestParseError(
509 'duplicate repo-hooks in %s' %
510 (self.manifestFile))
511
512 # Store a reference to the Project.
513 try:
David James8d201162013-10-11 17:03:19 -0700514 repo_hooks_projects = self._projects[repo_hooks_project]
Doug Anderson37282b42011-03-04 11:54:18 -0800515 except KeyError:
516 raise ManifestParseError(
517 'project %s not found for repo-hooks' %
518 (repo_hooks_project))
519
David James8d201162013-10-11 17:03:19 -0700520 if len(repo_hooks_projects) != 1:
521 raise ManifestParseError(
522 'internal error parsing repo-hooks in %s' %
523 (self.manifestFile))
524 self._repo_hooks_project = repo_hooks_projects[0]
525
Doug Anderson37282b42011-03-04 11:54:18 -0800526 # Store the enabled hooks in the Project object.
527 self._repo_hooks_project.enabled_repo_hooks = enabled_repo_hooks
Colin Cross23acdd32012-04-21 00:33:54 -0700528 if node.nodeName == 'remove-project':
529 name = self._reqatt(node, 'name')
David Jamesb8433df2014-01-30 10:11:17 -0800530
531 if name not in self._projects:
David Pursehousef9107482012-11-16 19:12:32 +0900532 raise ManifestParseError('remove-project element specifies non-existent '
533 'project: %s' % name)
Colin Cross23acdd32012-04-21 00:33:54 -0700534
David Jamesb8433df2014-01-30 10:11:17 -0800535 for p in self._projects[name]:
536 del self._paths[p.relpath]
537 del self._projects[name]
538
Colin Cross23acdd32012-04-21 00:33:54 -0700539 # If the manifest removes the hooks project, treat it as if it deleted
540 # the repo-hooks element too.
541 if self._repo_hooks_project and (self._repo_hooks_project.name == name):
542 self._repo_hooks_project = None
543
Doug Anderson37282b42011-03-04 11:54:18 -0800544
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800545 def _AddMetaProjectMirror(self, m):
546 name = None
547 m_url = m.GetRemote(m.remote.name).url
548 if m_url.endswith('/.git'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530549 raise ManifestParseError('refusing to mirror %s' % m_url)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800550
551 if self._default and self._default.remote:
Conley Owensceea3682011-10-20 10:45:47 -0700552 url = self._default.remote.resolvedFetchUrl
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800553 if not url.endswith('/'):
554 url += '/'
555 if m_url.startswith(url):
556 remote = self._default.remote
557 name = m_url[len(url):]
558
559 if name is None:
560 s = m_url.rindex('/') + 1
Conley Owensdb728cd2011-09-26 16:34:01 -0700561 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Shawn O. Pearcef35b2d92012-08-02 11:46:22 -0700562 remote = _XmlRemote('origin', fetch=m_url[:s], manifestUrl=manifestUrl)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800563 name = m_url[s:]
564
565 if name.endswith('.git'):
566 name = name[:-4]
567
568 if name not in self._projects:
569 m.PreSync()
570 gitdir = os.path.join(self.topdir, '%s.git' % name)
571 project = Project(manifest = self,
572 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700573 remote = remote.ToRemoteSpec(name),
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800574 gitdir = gitdir,
David James8d201162013-10-11 17:03:19 -0700575 objdir = gitdir,
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800576 worktree = None,
Kwanhong Leeccd218c2014-02-17 13:07:32 +0900577 relpath = name or None,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700578 revisionExpr = m.revisionExpr,
579 revisionId = None)
David James8d201162013-10-11 17:03:19 -0700580 self._projects[project.name] = [project]
Kwanhong Leeccd218c2014-02-17 13:07:32 +0900581 self._paths[project.relpath] = project
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800582
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700583 def _ParseRemote(self, node):
584 """
585 reads a <remote> element from the manifest file
586 """
587 name = self._reqatt(node, 'name')
Yestin Sunb292b982012-07-02 07:32:50 -0700588 alias = node.getAttribute('alias')
589 if alias == '':
590 alias = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700591 fetch = self._reqatt(node, 'fetch')
592 review = node.getAttribute('review')
Shawn O. Pearceae6e0942008-11-06 10:25:35 -0800593 if review == '':
594 review = None
Conley Owensdb728cd2011-09-26 16:34:01 -0700595 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Yestin Sunb292b982012-07-02 07:32:50 -0700596 return _XmlRemote(name, alias, fetch, manifestUrl, review)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700597
598 def _ParseDefault(self, node):
599 """
600 reads a <default> element from the manifest file
601 """
602 d = _Default()
603 d.remote = self._get_remote(node)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700604 d.revisionExpr = node.getAttribute('revision')
605 if d.revisionExpr == '':
606 d.revisionExpr = None
Anatol Pomazau79770d22012-04-20 14:41:59 -0700607
Bryan Jacobsf609f912013-05-06 13:36:24 -0400608 d.destBranchExpr = node.getAttribute('dest-branch') or None
609
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700610 sync_j = node.getAttribute('sync-j')
611 if sync_j == '' or sync_j is None:
612 d.sync_j = 1
613 else:
614 d.sync_j = int(sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700615
616 sync_c = node.getAttribute('sync-c')
617 if not sync_c:
618 d.sync_c = False
619 else:
620 d.sync_c = sync_c.lower() in ("yes", "true", "1")
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800621
622 sync_s = node.getAttribute('sync-s')
623 if not sync_s:
624 d.sync_s = False
625 else:
626 d.sync_s = sync_s.lower() in ("yes", "true", "1")
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700627 return d
628
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700629 def _ParseNotice(self, node):
630 """
631 reads a <notice> element from the manifest file
632
633 The <notice> element is distinct from other tags in the XML in that the
634 data is conveyed between the start and end tag (it's not an empty-element
635 tag).
636
637 The white space (carriage returns, indentation) for the notice element is
638 relevant and is parsed in a way that is based on how python docstrings work.
639 In fact, the code is remarkably similar to here:
640 http://www.python.org/dev/peps/pep-0257/
641 """
642 # Get the data out of the node...
643 notice = node.childNodes[0].data
644
645 # Figure out minimum indentation, skipping the first line (the same line
646 # as the <notice> tag)...
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530647 minIndent = sys.maxsize
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700648 lines = notice.splitlines()
649 for line in lines[1:]:
650 lstrippedLine = line.lstrip()
651 if lstrippedLine:
652 indent = len(line) - len(lstrippedLine)
653 minIndent = min(indent, minIndent)
654
655 # Strip leading / trailing blank lines and also indentation.
656 cleanLines = [lines[0].strip()]
657 for line in lines[1:]:
658 cleanLines.append(line[minIndent:].rstrip())
659
660 # Clear completely blank lines from front and back...
661 while cleanLines and not cleanLines[0]:
662 del cleanLines[0]
663 while cleanLines and not cleanLines[-1]:
664 del cleanLines[-1]
665
666 return '\n'.join(cleanLines)
667
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800668 def _JoinName(self, parent_name, name):
669 return os.path.join(parent_name, name)
670
671 def _UnjoinName(self, parent_name, name):
672 return os.path.relpath(name, parent_name)
673
674 def _ParseProject(self, node, parent = None):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700675 """
676 reads a <project> element from the manifest file
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700677 """
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700678 name = self._reqatt(node, 'name')
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800679 if parent:
680 name = self._JoinName(parent.name, name)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700681
682 remote = self._get_remote(node)
683 if remote is None:
684 remote = self._default.remote
685 if remote is None:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530686 raise ManifestParseError("no remote for project %s within %s" %
687 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700688
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700689 revisionExpr = node.getAttribute('revision')
690 if not revisionExpr:
691 revisionExpr = self._default.revisionExpr
692 if not revisionExpr:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530693 raise ManifestParseError("no revision for project %s within %s" %
694 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700695
696 path = node.getAttribute('path')
697 if not path:
698 path = name
699 if path.startswith('/'):
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530700 raise ManifestParseError("project %s path cannot be absolute in %s" %
701 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700702
Mike Pontillod3153822012-02-28 11:53:24 -0800703 rebase = node.getAttribute('rebase')
704 if not rebase:
705 rebase = True
706 else:
707 rebase = rebase.lower() in ("yes", "true", "1")
708
Anatol Pomazau79770d22012-04-20 14:41:59 -0700709 sync_c = node.getAttribute('sync-c')
710 if not sync_c:
711 sync_c = False
712 else:
713 sync_c = sync_c.lower() in ("yes", "true", "1")
714
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800715 sync_s = node.getAttribute('sync-s')
716 if not sync_s:
717 sync_s = self._default.sync_s
718 else:
719 sync_s = sync_s.lower() in ("yes", "true", "1")
720
David Pursehouseede7f122012-11-27 22:25:30 +0900721 clone_depth = node.getAttribute('clone-depth')
722 if clone_depth:
723 try:
724 clone_depth = int(clone_depth)
725 if clone_depth <= 0:
726 raise ValueError()
727 except ValueError:
728 raise ManifestParseError('invalid clone-depth %s in %s' %
729 (clone_depth, self.manifestFile))
730
Bryan Jacobsf609f912013-05-06 13:36:24 -0400731 dest_branch = node.getAttribute('dest-branch') or self._default.destBranchExpr
732
Brian Harring14a66742012-09-28 20:21:57 -0700733 upstream = node.getAttribute('upstream')
734
Conley Owens971de8e2012-04-16 10:36:08 -0700735 groups = ''
736 if node.hasAttribute('groups'):
737 groups = node.getAttribute('groups')
David Pursehouse1d947b32012-10-25 12:23:11 +0900738 groups = [x for x in re.split(r'[,\s]+', groups) if x]
Brian Harring7da13142012-06-15 02:24:20 -0700739
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800740 if parent is None:
David James8d201162013-10-11 17:03:19 -0700741 relpath, worktree, gitdir, objdir = self.GetProjectPaths(name, path)
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700742 else:
David James8d201162013-10-11 17:03:19 -0700743 relpath, worktree, gitdir, objdir = \
744 self.GetSubprojectPaths(parent, name, path)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800745
746 default_groups = ['all', 'name:%s' % name, 'path:%s' % relpath]
747 groups.extend(set(default_groups).difference(groups))
Shawn O. Pearcecd81dd62012-10-26 12:18:00 -0700748
Scott Fandb83b1b2013-02-28 09:34:14 +0800749 if self.IsMirror and node.hasAttribute('force-path'):
750 if node.getAttribute('force-path').lower() in ("yes", "true", "1"):
751 gitdir = os.path.join(self.topdir, '%s.git' % path)
752
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700753 project = Project(manifest = self,
754 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700755 remote = remote.ToRemoteSpec(name),
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700756 gitdir = gitdir,
David James8d201162013-10-11 17:03:19 -0700757 objdir = objdir,
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700758 worktree = worktree,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800759 relpath = relpath,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700760 revisionExpr = revisionExpr,
Mike Pontillod3153822012-02-28 11:53:24 -0800761 revisionId = None,
Colin Cross5acde752012-03-28 20:15:45 -0700762 rebase = rebase,
Anatol Pomazau79770d22012-04-20 14:41:59 -0700763 groups = groups,
Brian Harring14a66742012-09-28 20:21:57 -0700764 sync_c = sync_c,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800765 sync_s = sync_s,
David Pursehouseede7f122012-11-27 22:25:30 +0900766 clone_depth = clone_depth,
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800767 upstream = upstream,
Bryan Jacobsf609f912013-05-06 13:36:24 -0400768 parent = parent,
769 dest_branch = dest_branch)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700770
771 for n in node.childNodes:
Shawn O. Pearce242b5262009-05-19 13:00:29 -0700772 if n.nodeName == 'copyfile':
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700773 self._ParseCopyFile(project, n)
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500774 if n.nodeName == 'linkfile':
775 self._ParseLinkFile(project, n)
James W. Mills24c13082012-04-12 15:04:13 -0500776 if n.nodeName == 'annotation':
777 self._ParseAnnotation(project, n)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800778 if n.nodeName == 'project':
779 project.subprojects.append(self._ParseProject(n, parent = project))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700780
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700781 return project
782
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800783 def GetProjectPaths(self, name, path):
784 relpath = path
785 if self.IsMirror:
786 worktree = None
787 gitdir = os.path.join(self.topdir, '%s.git' % name)
David James8d201162013-10-11 17:03:19 -0700788 objdir = gitdir
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800789 else:
790 worktree = os.path.join(self.topdir, path).replace('\\', '/')
791 gitdir = os.path.join(self.repodir, 'projects', '%s.git' % path)
David James8d201162013-10-11 17:03:19 -0700792 objdir = os.path.join(self.repodir, 'project-objects', '%s.git' % name)
793 return relpath, worktree, gitdir, objdir
794
795 def GetProjectsWithName(self, name):
796 return self._projects.get(name, [])
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800797
798 def GetSubprojectName(self, parent, submodule_path):
799 return os.path.join(parent.name, submodule_path)
800
801 def _JoinRelpath(self, parent_relpath, relpath):
802 return os.path.join(parent_relpath, relpath)
803
804 def _UnjoinRelpath(self, parent_relpath, relpath):
805 return os.path.relpath(relpath, parent_relpath)
806
David James8d201162013-10-11 17:03:19 -0700807 def GetSubprojectPaths(self, parent, name, path):
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800808 relpath = self._JoinRelpath(parent.relpath, path)
809 gitdir = os.path.join(parent.gitdir, 'subprojects', '%s.git' % path)
David James8d201162013-10-11 17:03:19 -0700810 objdir = os.path.join(parent.gitdir, 'subproject-objects', '%s.git' % name)
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800811 if self.IsMirror:
812 worktree = None
813 else:
814 worktree = os.path.join(parent.worktree, path).replace('\\', '/')
David James8d201162013-10-11 17:03:19 -0700815 return relpath, worktree, gitdir, objdir
Che-Liang Chioub2bd91c2012-01-11 11:28:42 +0800816
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700817 def _ParseCopyFile(self, project, node):
818 src = self._reqatt(node, 'src')
819 dest = self._reqatt(node, 'dest')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800820 if not self.IsMirror:
821 # src is project relative;
822 # dest is relative to the top of the tree
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800823 project.AddCopyFile(src, dest, os.path.join(self.topdir, dest))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700824
Jeff Hamiltone0df2322014-04-21 17:10:59 -0500825 def _ParseLinkFile(self, project, node):
826 src = self._reqatt(node, 'src')
827 dest = self._reqatt(node, 'dest')
828 if not self.IsMirror:
829 # src is project relative;
830 # dest is relative to the top of the tree
831 project.AddLinkFile(src, dest, os.path.join(self.topdir, dest))
832
James W. Mills24c13082012-04-12 15:04:13 -0500833 def _ParseAnnotation(self, project, node):
834 name = self._reqatt(node, 'name')
835 value = self._reqatt(node, 'value')
836 try:
837 keep = self._reqatt(node, 'keep').lower()
838 except ManifestParseError:
839 keep = "true"
840 if keep != "true" and keep != "false":
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530841 raise ManifestParseError('optional "keep" attribute must be '
842 '"true" or "false"')
James W. Mills24c13082012-04-12 15:04:13 -0500843 project.AddAnnotation(name, value, keep)
844
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700845 def _get_remote(self, node):
846 name = node.getAttribute('remote')
847 if not name:
848 return None
849
850 v = self._remotes.get(name)
851 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530852 raise ManifestParseError("remote %s not defined in %s" %
853 (name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700854 return v
855
856 def _reqatt(self, node, attname):
857 """
858 reads a required attribute from the node.
859 """
860 v = node.getAttribute(attname)
861 if not v:
Chirayu Desai217ea7d2013-03-01 19:14:38 +0530862 raise ManifestParseError("no %s in <%s> within %s" %
863 (attname, node.nodeName, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700864 return v
Julien Camperguedd654222014-01-09 16:21:37 +0100865
866 def projectsDiff(self, manifest):
867 """return the projects differences between two manifests.
868
869 The diff will be from self to given manifest.
870
871 """
872 fromProjects = self.paths
873 toProjects = manifest.paths
874
875 fromKeys = fromProjects.keys()
876 fromKeys.sort()
877 toKeys = toProjects.keys()
878 toKeys.sort()
879
880 diff = {'added': [], 'removed': [], 'changed': [], 'unreachable': []}
881
882 for proj in fromKeys:
883 if not proj in toKeys:
884 diff['removed'].append(fromProjects[proj])
885 else:
886 fromProj = fromProjects[proj]
887 toProj = toProjects[proj]
888 try:
889 fromRevId = fromProj.GetCommitRevisionId()
890 toRevId = toProj.GetCommitRevisionId()
891 except ManifestInvalidRevisionError:
892 diff['unreachable'].append((fromProj, toProj))
893 else:
894 if fromRevId != toRevId:
895 diff['changed'].append((fromProj, toProj))
896 toKeys.remove(proj)
897
898 for proj in toKeys:
899 diff['added'].append(toProjects[proj])
900
901 return diff