blob: ea6a7e520822ff1c6891990208d0e9ffd26be14b [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
Colin Cross23acdd32012-04-21 00:33:54 -070016import itertools
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070017import os
Conley Owensdb728cd2011-09-26 16:34:01 -070018import re
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070019import sys
Conley Owensdb728cd2011-09-26 16:34:01 -070020import urlparse
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070021import xml.dom.minidom
22
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070023from git_config import GitConfig, IsId
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070024from project import RemoteSpec, Project, MetaProject, R_HEADS, HEAD
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070025from error import ManifestParseError
26
27MANIFEST_FILE_NAME = 'manifest.xml'
Shawn O. Pearce5cc66792008-10-23 16:19:27 -070028LOCAL_MANIFEST_NAME = 'local_manifest.xml'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070029
Conley Owensdb728cd2011-09-26 16:34:01 -070030urlparse.uses_relative.extend(['ssh', 'git'])
31urlparse.uses_netloc.extend(['ssh', 'git'])
32
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070033class _Default(object):
34 """Project defaults within the manifest."""
35
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -070036 revisionExpr = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070037 remote = None
Shawn O. Pearce6392c872011-09-22 17:44:31 -070038 sync_j = 1
Anatol Pomazau79770d22012-04-20 14:41:59 -070039 sync_c = False
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070040
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070041class _XmlRemote(object):
42 def __init__(self,
43 name,
Yestin Sunb292b982012-07-02 07:32:50 -070044 alias=None,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070045 fetch=None,
Conley Owensdb728cd2011-09-26 16:34:01 -070046 manifestUrl=None,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070047 review=None):
48 self.name = name
49 self.fetchUrl = fetch
Conley Owensdb728cd2011-09-26 16:34:01 -070050 self.manifestUrl = manifestUrl
Yestin Sunb292b982012-07-02 07:32:50 -070051 self.remoteAlias = alias
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070052 self.reviewUrl = review
Conley Owensceea3682011-10-20 10:45:47 -070053 self.resolvedFetchUrl = self._resolveFetchUrl()
Shawn O. Pearced1f70d92009-05-19 14:58:02 -070054
Conley Owensceea3682011-10-20 10:45:47 -070055 def _resolveFetchUrl(self):
56 url = self.fetchUrl.rstrip('/')
Conley Owensdb728cd2011-09-26 16:34:01 -070057 manifestUrl = self.manifestUrl.rstrip('/')
58 # urljoin will get confused if there is no scheme in the base url
59 # ie, if manifestUrl is of the form <hostname:port>
60 if manifestUrl.find(':') != manifestUrl.find('/') - 1:
61 manifestUrl = 'gopher://' + manifestUrl
62 url = urlparse.urljoin(manifestUrl, url)
Conley Owensceea3682011-10-20 10:45:47 -070063 return re.sub(r'^gopher://', '', url)
64
65 def ToRemoteSpec(self, projectName):
Conley Owens9d8f9142011-10-20 14:36:35 -070066 url = self.resolvedFetchUrl.rstrip('/') + '/' + projectName
Yestin Sunb292b982012-07-02 07:32:50 -070067 remoteName = self.name
68 if self.remoteAlias:
69 remoteName = self.remoteAlias
70 return RemoteSpec(remoteName, url, self.reviewUrl)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070071
Shawn O. Pearcec8a300f2009-05-18 13:19:57 -070072class XmlManifest(object):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070073 """manages the repo configuration file"""
74
75 def __init__(self, repodir):
76 self.repodir = os.path.abspath(repodir)
77 self.topdir = os.path.dirname(self.repodir)
78 self.manifestFile = os.path.join(self.repodir, MANIFEST_FILE_NAME)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070079 self.globalConfig = GitConfig.ForUser()
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070080
81 self.repoProject = MetaProject(self, 'repo',
82 gitdir = os.path.join(repodir, 'repo/.git'),
83 worktree = os.path.join(repodir, 'repo'))
84
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070085 self.manifestProject = MetaProject(self, 'manifests',
Shawn O. Pearcef5c25a62008-11-04 08:11:53 -080086 gitdir = os.path.join(repodir, 'manifests.git'),
87 worktree = os.path.join(repodir, 'manifests'))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070088
89 self._Unload()
90
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -070091 def Override(self, name):
92 """Use a different manifest, just for the current instantiation.
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070093 """
94 path = os.path.join(self.manifestProject.worktree, name)
95 if not os.path.isfile(path):
96 raise ManifestParseError('manifest %s not found' % name)
97
98 old = self.manifestFile
99 try:
100 self.manifestFile = path
101 self._Unload()
102 self._Load()
103 finally:
104 self.manifestFile = old
105
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700106 def Link(self, name):
107 """Update the repo metadata to use a different manifest.
108 """
109 self.Override(name)
110
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700111 try:
112 if os.path.exists(self.manifestFile):
113 os.remove(self.manifestFile)
114 os.symlink('manifests/%s' % name, self.manifestFile)
115 except OSError, e:
116 raise ManifestParseError('cannot link manifest %s' % name)
117
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800118 def _RemoteToXml(self, r, doc, root):
119 e = doc.createElement('remote')
120 root.appendChild(e)
121 e.setAttribute('name', r.name)
122 e.setAttribute('fetch', r.fetchUrl)
123 if r.reviewUrl is not None:
124 e.setAttribute('review', r.reviewUrl)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800125
126 def Save(self, fd, peg_rev=False):
127 """Write the current manifest out to the given file descriptor.
128 """
Colin Cross5acde752012-03-28 20:15:45 -0700129 mp = self.manifestProject
130
131 groups = mp.config.GetString('manifest.groups')
Colin Crossc39864f2012-04-23 13:41:58 -0700132 if not groups:
Conley Owens971de8e2012-04-16 10:36:08 -0700133 groups = 'default'
134 groups = [x for x in re.split(r'[,\s]+', groups) if x]
Colin Cross5acde752012-03-28 20:15:45 -0700135
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800136 doc = xml.dom.minidom.Document()
137 root = doc.createElement('manifest')
138 doc.appendChild(root)
139
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700140 # Save out the notice. There's a little bit of work here to give it the
141 # right whitespace, which assumes that the notice is automatically indented
142 # by 4 by minidom.
143 if self.notice:
144 notice_element = root.appendChild(doc.createElement('notice'))
145 notice_lines = self.notice.splitlines()
146 indented_notice = ('\n'.join(" "*4 + line for line in notice_lines))[4:]
147 notice_element.appendChild(doc.createTextNode(indented_notice))
148
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800149 d = self.default
150 sort_remotes = list(self.remotes.keys())
151 sort_remotes.sort()
152
153 for r in sort_remotes:
154 self._RemoteToXml(self.remotes[r], doc, root)
155 if self.remotes:
156 root.appendChild(doc.createTextNode(''))
157
158 have_default = False
159 e = doc.createElement('default')
160 if d.remote:
161 have_default = True
162 e.setAttribute('remote', d.remote.name)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700163 if d.revisionExpr:
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800164 have_default = True
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700165 e.setAttribute('revision', d.revisionExpr)
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700166 if d.sync_j > 1:
167 have_default = True
168 e.setAttribute('sync-j', '%d' % d.sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700169 if d.sync_c:
170 have_default = True
171 e.setAttribute('sync-c', 'true')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800172 if have_default:
173 root.appendChild(e)
174 root.appendChild(doc.createTextNode(''))
175
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700176 if self._manifest_server:
177 e = doc.createElement('manifest-server')
178 e.setAttribute('url', self._manifest_server)
179 root.appendChild(e)
180 root.appendChild(doc.createTextNode(''))
181
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800182 sort_projects = list(self.projects.keys())
183 sort_projects.sort()
184
185 for p in sort_projects:
186 p = self.projects[p]
Colin Cross5acde752012-03-28 20:15:45 -0700187
188 if not p.MatchesGroups(groups):
189 continue
190
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800191 e = doc.createElement('project')
192 root.appendChild(e)
193 e.setAttribute('name', p.name)
194 if p.relpath != p.name:
195 e.setAttribute('path', p.relpath)
196 if not d.remote or p.remote.name != d.remote.name:
197 e.setAttribute('remote', p.remote.name)
198 if peg_rev:
199 if self.IsMirror:
200 e.setAttribute('revision',
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700201 p.bare_git.rev_parse(p.revisionExpr + '^0'))
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800202 else:
203 e.setAttribute('revision',
204 p.work_git.rev_parse(HEAD + '^0'))
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700205 elif not d.revisionExpr or p.revisionExpr != d.revisionExpr:
206 e.setAttribute('revision', p.revisionExpr)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800207
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800208 for c in p.copyfiles:
209 ce = doc.createElement('copyfile')
210 ce.setAttribute('src', c.src)
211 ce.setAttribute('dest', c.dest)
212 e.appendChild(ce)
213
Conley Owens971de8e2012-04-16 10:36:08 -0700214 egroups = [g for g in p.groups if g != 'default']
215 if egroups:
216 e.setAttribute('groups', ','.join(egroups))
Colin Cross5acde752012-03-28 20:15:45 -0700217
James W. Mills24c13082012-04-12 15:04:13 -0500218 for a in p.annotations:
219 if a.keep == "true":
220 ae = doc.createElement('annotation')
221 ae.setAttribute('name', a.name)
222 ae.setAttribute('value', a.value)
223 e.appendChild(ae)
224
Anatol Pomazau79770d22012-04-20 14:41:59 -0700225 if p.sync_c:
226 e.setAttribute('sync-c', 'true')
227
Doug Anderson37282b42011-03-04 11:54:18 -0800228 if self._repo_hooks_project:
229 root.appendChild(doc.createTextNode(''))
230 e = doc.createElement('repo-hooks')
231 e.setAttribute('in-project', self._repo_hooks_project.name)
232 e.setAttribute('enabled-list',
233 ' '.join(self._repo_hooks_project.enabled_repo_hooks))
234 root.appendChild(e)
235
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800236 doc.writexml(fd, '', ' ', '\n', 'UTF-8')
237
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700238 @property
239 def projects(self):
240 self._Load()
241 return self._projects
242
243 @property
244 def remotes(self):
245 self._Load()
246 return self._remotes
247
248 @property
249 def default(self):
250 self._Load()
251 return self._default
252
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800253 @property
Doug Anderson37282b42011-03-04 11:54:18 -0800254 def repo_hooks_project(self):
255 self._Load()
256 return self._repo_hooks_project
257
258 @property
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700259 def notice(self):
260 self._Load()
261 return self._notice
262
263 @property
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700264 def manifest_server(self):
265 self._Load()
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -0800266 return self._manifest_server
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700267
268 @property
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800269 def IsMirror(self):
270 return self.manifestProject.config.GetBoolean('repo.mirror')
271
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700272 def _Unload(self):
273 self._loaded = False
274 self._projects = {}
275 self._remotes = {}
276 self._default = None
Doug Anderson37282b42011-03-04 11:54:18 -0800277 self._repo_hooks_project = None
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700278 self._notice = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700279 self.branch = None
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700280 self._manifest_server = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700281
282 def _Load(self):
283 if not self._loaded:
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800284 m = self.manifestProject
285 b = m.GetBranch(m.CurrentBranch).merge
Shawn O. Pearce21c5c342009-06-25 16:47:30 -0700286 if b is not None and b.startswith(R_HEADS):
Shawn O. Pearce2450a292008-11-04 08:22:07 -0800287 b = b[len(R_HEADS):]
288 self.branch = b
289
Colin Cross23acdd32012-04-21 00:33:54 -0700290 nodes = []
Brian Harring475a47d2012-06-07 20:05:35 -0700291 nodes.append(self._ParseManifestXml(self.manifestFile,
292 self.manifestProject.worktree))
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700293
294 local = os.path.join(self.repodir, LOCAL_MANIFEST_NAME)
295 if os.path.exists(local):
Brian Harring475a47d2012-06-07 20:05:35 -0700296 nodes.append(self._ParseManifestXml(local, self.repodir))
Colin Cross23acdd32012-04-21 00:33:54 -0700297
298 self._ParseManifest(nodes)
Shawn O. Pearce5cc66792008-10-23 16:19:27 -0700299
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800300 if self.IsMirror:
301 self._AddMetaProjectMirror(self.repoProject)
302 self._AddMetaProjectMirror(self.manifestProject)
303
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700304 self._loaded = True
305
Brian Harring475a47d2012-06-07 20:05:35 -0700306 def _ParseManifestXml(self, path, include_root):
Brian Harring26448742011-04-28 05:04:41 -0700307 root = xml.dom.minidom.parse(path)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700308 if not root or not root.childNodes:
Brian Harring26448742011-04-28 05:04:41 -0700309 raise ManifestParseError("no root node in %s" % (path,))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700310
311 config = root.childNodes[0]
312 if config.nodeName != 'manifest':
Brian Harring26448742011-04-28 05:04:41 -0700313 raise ManifestParseError("no <manifest> in %s" % (path,))
314
Colin Cross23acdd32012-04-21 00:33:54 -0700315 nodes = []
Brian Harring26448742011-04-28 05:04:41 -0700316 for node in config.childNodes:
317 if node.nodeName == 'include':
318 name = self._reqatt(node, 'name')
Brian Harring475a47d2012-06-07 20:05:35 -0700319 fp = os.path.join(include_root, name)
Brian Harring26448742011-04-28 05:04:41 -0700320 if not os.path.isfile(fp):
321 raise ManifestParseError, \
322 "include %s doesn't exist or isn't a file" % \
323 (name,)
324 try:
Brian Harring475a47d2012-06-07 20:05:35 -0700325 nodes.extend(self._ParseManifestXml(fp, include_root))
Brian Harring26448742011-04-28 05:04:41 -0700326 # should isolate this to the exact exception, but that's
327 # tricky. actual parsing implementation may vary.
328 except (KeyboardInterrupt, RuntimeError, SystemExit):
329 raise
330 except Exception, e:
331 raise ManifestParseError(
332 "failed parsing included manifest %s: %s", (name, e))
Colin Cross23acdd32012-04-21 00:33:54 -0700333 else:
334 nodes.append(node)
335 return nodes
Brian Harring26448742011-04-28 05:04:41 -0700336
Colin Cross23acdd32012-04-21 00:33:54 -0700337 def _ParseManifest(self, node_list):
338 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700339 if node.nodeName == 'remote':
340 remote = self._ParseRemote(node)
341 if self._remotes.get(remote.name):
Doug Anderson37282b42011-03-04 11:54:18 -0800342 raise ManifestParseError(
343 'duplicate remote %s in %s' %
344 (remote.name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700345 self._remotes[remote.name] = remote
346
Colin Cross23acdd32012-04-21 00:33:54 -0700347 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700348 if node.nodeName == 'default':
349 if self._default is not None:
Doug Anderson37282b42011-03-04 11:54:18 -0800350 raise ManifestParseError(
351 'duplicate default in %s' %
352 (self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700353 self._default = self._ParseDefault(node)
354 if self._default is None:
355 self._default = _Default()
356
Colin Cross23acdd32012-04-21 00:33:54 -0700357 for node in itertools.chain(*node_list):
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700358 if node.nodeName == 'notice':
359 if self._notice is not None:
Doug Anderson37282b42011-03-04 11:54:18 -0800360 raise ManifestParseError(
361 'duplicate notice in %s' %
362 (self.manifestFile))
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700363 self._notice = self._ParseNotice(node)
364
Colin Cross23acdd32012-04-21 00:33:54 -0700365 for node in itertools.chain(*node_list):
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700366 if node.nodeName == 'manifest-server':
367 url = self._reqatt(node, 'url')
368 if self._manifest_server is not None:
Doug Anderson37282b42011-03-04 11:54:18 -0800369 raise ManifestParseError(
370 'duplicate manifest-server in %s' %
371 (self.manifestFile))
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700372 self._manifest_server = url
373
Colin Cross23acdd32012-04-21 00:33:54 -0700374 for node in itertools.chain(*node_list):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700375 if node.nodeName == 'project':
376 project = self._ParseProject(node)
377 if self._projects.get(project.name):
Doug Anderson37282b42011-03-04 11:54:18 -0800378 raise ManifestParseError(
379 'duplicate project %s in %s' %
380 (project.name, self.manifestFile))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700381 self._projects[project.name] = project
Doug Anderson37282b42011-03-04 11:54:18 -0800382 if node.nodeName == 'repo-hooks':
383 # Get the name of the project and the (space-separated) list of enabled.
384 repo_hooks_project = self._reqatt(node, 'in-project')
385 enabled_repo_hooks = self._reqatt(node, 'enabled-list').split()
386
387 # Only one project can be the hooks project
388 if self._repo_hooks_project is not None:
389 raise ManifestParseError(
390 'duplicate repo-hooks in %s' %
391 (self.manifestFile))
392
393 # Store a reference to the Project.
394 try:
395 self._repo_hooks_project = self._projects[repo_hooks_project]
396 except KeyError:
397 raise ManifestParseError(
398 'project %s not found for repo-hooks' %
399 (repo_hooks_project))
400
401 # Store the enabled hooks in the Project object.
402 self._repo_hooks_project.enabled_repo_hooks = enabled_repo_hooks
Colin Cross23acdd32012-04-21 00:33:54 -0700403 if node.nodeName == 'remove-project':
404 name = self._reqatt(node, 'name')
405 try:
406 del self._projects[name]
407 except KeyError:
408 raise ManifestParseError(
409 'project %s not found' %
410 (name))
411
412 # If the manifest removes the hooks project, treat it as if it deleted
413 # the repo-hooks element too.
414 if self._repo_hooks_project and (self._repo_hooks_project.name == name):
415 self._repo_hooks_project = None
416
Doug Anderson37282b42011-03-04 11:54:18 -0800417
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800418 def _AddMetaProjectMirror(self, m):
419 name = None
420 m_url = m.GetRemote(m.remote.name).url
421 if m_url.endswith('/.git'):
422 raise ManifestParseError, 'refusing to mirror %s' % m_url
423
424 if self._default and self._default.remote:
Conley Owensceea3682011-10-20 10:45:47 -0700425 url = self._default.remote.resolvedFetchUrl
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800426 if not url.endswith('/'):
427 url += '/'
428 if m_url.startswith(url):
429 remote = self._default.remote
430 name = m_url[len(url):]
431
432 if name is None:
433 s = m_url.rindex('/') + 1
Conley Owensdb728cd2011-09-26 16:34:01 -0700434 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Shawn O. Pearcef35b2d92012-08-02 11:46:22 -0700435 remote = _XmlRemote('origin', fetch=m_url[:s], manifestUrl=manifestUrl)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800436 name = m_url[s:]
437
438 if name.endswith('.git'):
439 name = name[:-4]
440
441 if name not in self._projects:
442 m.PreSync()
443 gitdir = os.path.join(self.topdir, '%s.git' % name)
444 project = Project(manifest = self,
445 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700446 remote = remote.ToRemoteSpec(name),
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800447 gitdir = gitdir,
448 worktree = None,
449 relpath = None,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700450 revisionExpr = m.revisionExpr,
451 revisionId = None)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800452 self._projects[project.name] = project
453
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700454 def _ParseRemote(self, node):
455 """
456 reads a <remote> element from the manifest file
457 """
458 name = self._reqatt(node, 'name')
Yestin Sunb292b982012-07-02 07:32:50 -0700459 alias = node.getAttribute('alias')
460 if alias == '':
461 alias = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700462 fetch = self._reqatt(node, 'fetch')
463 review = node.getAttribute('review')
Shawn O. Pearceae6e0942008-11-06 10:25:35 -0800464 if review == '':
465 review = None
Conley Owensdb728cd2011-09-26 16:34:01 -0700466 manifestUrl = self.manifestProject.config.GetString('remote.origin.url')
Yestin Sunb292b982012-07-02 07:32:50 -0700467 return _XmlRemote(name, alias, fetch, manifestUrl, review)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700468
469 def _ParseDefault(self, node):
470 """
471 reads a <default> element from the manifest file
472 """
473 d = _Default()
474 d.remote = self._get_remote(node)
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700475 d.revisionExpr = node.getAttribute('revision')
476 if d.revisionExpr == '':
477 d.revisionExpr = None
Anatol Pomazau79770d22012-04-20 14:41:59 -0700478
Shawn O. Pearce6392c872011-09-22 17:44:31 -0700479 sync_j = node.getAttribute('sync-j')
480 if sync_j == '' or sync_j is None:
481 d.sync_j = 1
482 else:
483 d.sync_j = int(sync_j)
Anatol Pomazau79770d22012-04-20 14:41:59 -0700484
485 sync_c = node.getAttribute('sync-c')
486 if not sync_c:
487 d.sync_c = False
488 else:
489 d.sync_c = sync_c.lower() in ("yes", "true", "1")
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700490 return d
491
Doug Anderson2b8db3c2010-11-01 15:08:06 -0700492 def _ParseNotice(self, node):
493 """
494 reads a <notice> element from the manifest file
495
496 The <notice> element is distinct from other tags in the XML in that the
497 data is conveyed between the start and end tag (it's not an empty-element
498 tag).
499
500 The white space (carriage returns, indentation) for the notice element is
501 relevant and is parsed in a way that is based on how python docstrings work.
502 In fact, the code is remarkably similar to here:
503 http://www.python.org/dev/peps/pep-0257/
504 """
505 # Get the data out of the node...
506 notice = node.childNodes[0].data
507
508 # Figure out minimum indentation, skipping the first line (the same line
509 # as the <notice> tag)...
510 minIndent = sys.maxint
511 lines = notice.splitlines()
512 for line in lines[1:]:
513 lstrippedLine = line.lstrip()
514 if lstrippedLine:
515 indent = len(line) - len(lstrippedLine)
516 minIndent = min(indent, minIndent)
517
518 # Strip leading / trailing blank lines and also indentation.
519 cleanLines = [lines[0].strip()]
520 for line in lines[1:]:
521 cleanLines.append(line[minIndent:].rstrip())
522
523 # Clear completely blank lines from front and back...
524 while cleanLines and not cleanLines[0]:
525 del cleanLines[0]
526 while cleanLines and not cleanLines[-1]:
527 del cleanLines[-1]
528
529 return '\n'.join(cleanLines)
530
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700531 def _ParseProject(self, node):
532 """
533 reads a <project> element from the manifest file
Nico Sallembiena1bfd2c2010-04-06 10:40:01 -0700534 """
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700535 name = self._reqatt(node, 'name')
536
537 remote = self._get_remote(node)
538 if remote is None:
539 remote = self._default.remote
540 if remote is None:
541 raise ManifestParseError, \
542 "no remote for project %s within %s" % \
543 (name, self.manifestFile)
544
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700545 revisionExpr = node.getAttribute('revision')
546 if not revisionExpr:
547 revisionExpr = self._default.revisionExpr
548 if not revisionExpr:
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700549 raise ManifestParseError, \
550 "no revision for project %s within %s" % \
551 (name, self.manifestFile)
552
553 path = node.getAttribute('path')
554 if not path:
555 path = name
556 if path.startswith('/'):
557 raise ManifestParseError, \
558 "project %s path cannot be absolute in %s" % \
559 (name, self.manifestFile)
560
Mike Pontillod3153822012-02-28 11:53:24 -0800561 rebase = node.getAttribute('rebase')
562 if not rebase:
563 rebase = True
564 else:
565 rebase = rebase.lower() in ("yes", "true", "1")
566
Anatol Pomazau79770d22012-04-20 14:41:59 -0700567 sync_c = node.getAttribute('sync-c')
568 if not sync_c:
569 sync_c = False
570 else:
571 sync_c = sync_c.lower() in ("yes", "true", "1")
572
Conley Owens971de8e2012-04-16 10:36:08 -0700573 groups = ''
574 if node.hasAttribute('groups'):
575 groups = node.getAttribute('groups')
576 groups = [x for x in re.split('[,\s]+', groups) if x]
Brian Harring7da13142012-06-15 02:24:20 -0700577
578 default_groups = ['default', 'name:%s' % name, 'path:%s' % path]
579 groups.extend(set(default_groups).difference(groups))
Colin Cross5acde752012-03-28 20:15:45 -0700580
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800581 if self.IsMirror:
582 relpath = None
583 worktree = None
584 gitdir = os.path.join(self.topdir, '%s.git' % name)
585 else:
Anthony Newnamdf14a702011-01-09 17:31:57 -0800586 worktree = os.path.join(self.topdir, path).replace('\\', '/')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800587 gitdir = os.path.join(self.repodir, 'projects/%s.git' % path)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700588
589 project = Project(manifest = self,
590 name = name,
Shawn O. Pearced1f70d92009-05-19 14:58:02 -0700591 remote = remote.ToRemoteSpec(name),
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700592 gitdir = gitdir,
593 worktree = worktree,
594 relpath = path,
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700595 revisionExpr = revisionExpr,
Mike Pontillod3153822012-02-28 11:53:24 -0800596 revisionId = None,
Colin Cross5acde752012-03-28 20:15:45 -0700597 rebase = rebase,
Anatol Pomazau79770d22012-04-20 14:41:59 -0700598 groups = groups,
599 sync_c = sync_c)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700600
601 for n in node.childNodes:
Shawn O. Pearce242b5262009-05-19 13:00:29 -0700602 if n.nodeName == 'copyfile':
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700603 self._ParseCopyFile(project, n)
James W. Mills24c13082012-04-12 15:04:13 -0500604 if n.nodeName == 'annotation':
605 self._ParseAnnotation(project, n)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700606
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700607 return project
608
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700609 def _ParseCopyFile(self, project, node):
610 src = self._reqatt(node, 'src')
611 dest = self._reqatt(node, 'dest')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800612 if not self.IsMirror:
613 # src is project relative;
614 # dest is relative to the top of the tree
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -0800615 project.AddCopyFile(src, dest, os.path.join(self.topdir, dest))
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700616
James W. Mills24c13082012-04-12 15:04:13 -0500617 def _ParseAnnotation(self, project, node):
618 name = self._reqatt(node, 'name')
619 value = self._reqatt(node, 'value')
620 try:
621 keep = self._reqatt(node, 'keep').lower()
622 except ManifestParseError:
623 keep = "true"
624 if keep != "true" and keep != "false":
625 raise ManifestParseError, "optional \"keep\" attribute must be \"true\" or \"false\""
626 project.AddAnnotation(name, value, keep)
627
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700628 def _get_remote(self, node):
629 name = node.getAttribute('remote')
630 if not name:
631 return None
632
633 v = self._remotes.get(name)
634 if not v:
635 raise ManifestParseError, \
636 "remote %s not defined in %s" % \
637 (name, self.manifestFile)
638 return v
639
640 def _reqatt(self, node, attname):
641 """
642 reads a required attribute from the node.
643 """
644 v = node.getAttribute(attname)
645 if not v:
646 raise ManifestParseError, \
647 "no %s in <%s> within %s" % \
648 (attname, node.nodeName, self.manifestFile)
649 return v