1 # -*- coding: utf-8 -*-
3 # metadata.py - part of the FDroid server tools
4 # Copyright (C) 2013, Ciaran Gultnieks, ciaran@ciarang.com
5 # Copyright (C) 2013-2014 Daniel Martà <mvdan@mvdan.cc>
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class MetaDataException(Exception):
25 def __init__(self, value):
29 return repr(self.value)
49 'Archive Policy': None,
50 'Update Check Mode': 'None',
51 'Update Check Data': None,
52 'Vercode Operation': None,
53 'Auto Update Mode': 'None',
54 'Current Version': '',
55 'Current Version Code': '0',
58 'Requires Root': False,
63 # This defines the preferred order for the build items - as in the
64 # manual, they're roughly in order of application.
66 'disable', 'commit', 'subdir', 'submodules', 'init',
67 'gradle', 'maven', 'output', 'oldsdkloc', 'target',
68 'update', 'encoding', 'forceversion', 'forcevercode', 'rm',
69 'fixtrans', 'fixapos', 'extlibs', 'srclibs', 'patch',
70 'prebuild', 'scanignore', 'scandelete', 'build', 'buildjni',
71 'preassemble', 'bindir', 'antcommand', 'novcheck'
75 # Designates a metadata field type and checks that it matches
77 # 'name' - The long name of the field type
78 # 'matching' - List of possible values or regex expression
79 # 'sep' - Separator to use if value may be a list
80 # 'fields' - Metadata fields (Field:Value) of this type
81 # 'attrs' - Build attributes (attr=value) of this type
84 def __init__(self, name, matching, sep, fields, attrs):
86 self.matching = matching
87 if type(matching) is str:
88 self.compiled = re.compile(matching)
93 def _assert_regex(self, values, appid):
95 if not self.compiled.match(v):
96 raise MetaDataException("'%s' is not a valid %s in %s. "
97 % (v, self.name, appid) +
98 "Regex pattern: %s" % (self.matching))
100 def _assert_list(self, values, appid):
102 if v not in self.matching:
103 raise MetaDataException("'%s' is not a valid %s in %s. "
104 % (v, self.name, appid) +
105 "Possible values: %s" % (", ".join(self.matching)))
107 def check(self, value, appid):
108 if type(value) is not str or not value:
110 if self.sep is not None:
111 values = value.split(self.sep)
114 if type(self.matching) is list:
115 self._assert_list(values, appid)
117 self._assert_regex(values, appid)
120 # Generic value types
122 'int' : FieldType("Integer",
123 r'^[1-9][0-9]*$', None,
127 'http' : FieldType("HTTP link",
128 r'^http[s]?://', None,
129 [ "Web Site", "Source Code", "Issue Tracker", "Donate" ], []),
131 'bitcoin' : FieldType("Bitcoin address",
132 r'^[a-zA-Z0-9]{27,34}$', None,
136 'litecoin' : FieldType("Litecoin address",
137 r'^L[a-zA-Z0-9]{33}$', None,
141 'dogecoin' : FieldType("Dogecoin address",
142 r'^D[a-zA-Z0-9]{33}$', None,
146 'Bool' : FieldType("Boolean",
151 'bool' : FieldType("Boolean",
154 [ 'submodules', 'oldsdkloc', 'forceversion', 'forcevercode',
155 'fixtrans', 'fixapos', 'novcheck' ]),
157 'Repo Type' : FieldType("Repo Type",
158 [ 'git', 'git-svn', 'svn', 'hg', 'bzr', 'srclib' ], None,
162 'archive' : FieldType("Archive Policy",
163 r'^[0-9]+ versions$', None,
164 [ "Archive Policy" ],
167 'antifeatures' : FieldType("Anti-Feature",
168 [ "Ads", "Tracking", "NonFreeNet", "NonFreeDep", "NonFreeAdd", "UpstreamNonFree" ], ',',
172 'autoupdatemodes' : FieldType("Auto Update Mode",
173 r"^(Version .+|None)$", None,
174 [ "Auto Update Mode" ],
177 'updatecheckmodes' : FieldType("Update Check Mode",
178 r"^(Tags|Tags .+|RepoManifest|RepoManifest/.+|RepoTrunk|HTTP|Static|None)$", None,
179 [ "Update Check Mode" ],
183 # Check an app's metadata information for integrity errors
184 def check_metadata(info):
185 for k, t in valuetypes.iteritems():
186 for field in t.fields:
188 t.check(info[field], info['id'])
190 info[field] = info[field] == "Yes"
191 for build in info['builds']:
194 t.check(build[attr], info['id'])
196 build[attr] = build[attr] == "yes"
200 # Formatter for descriptions. Create an instance, and call parseline() with
201 # each line of the description source from the metadata. At the end, call
202 # end() and then text_plain, text_wiki and text_html will contain the result.
203 class DescriptionFormatter:
215 def __init__(self, linkres):
216 self.linkResolver = linkres
217 def endcur(self, notstates=None):
218 if notstates and self.state in notstates:
220 if self.state == self.stPARA:
222 elif self.state == self.stUL:
224 elif self.state == self.stOL:
227 self.text_plain += '\n'
228 self.text_html += '</p>'
229 self.state = self.stNONE
231 self.text_html += '</ul>'
232 self.state = self.stNONE
234 self.text_html += '</ol>'
235 self.state = self.stNONE
237 def formatted(self, txt, html):
240 txt = cgi.escape(txt)
242 index = txt.find("''")
244 return formatted + txt
245 formatted += txt[:index]
247 if txt.startswith("'''"):
253 self.bold = not self.bold
261 self.ital = not self.ital
265 def linkify(self, txt):
269 index = txt.find("[")
271 return (linkified_plain + self.formatted(txt, False), linkified_html + self.formatted(txt, True))
272 linkified_plain += self.formatted(txt[:index], False)
273 linkified_html += self.formatted(txt[:index], True)
275 if txt.startswith("[["):
276 index = txt.find("]]")
278 raise MetaDataException("Unterminated ]]")
280 if self.linkResolver:
281 url, urltext = self.linkResolver(url)
284 linkified_html += '<a href="' + url + '">' + cgi.escape(urltext) + '</a>'
285 linkified_plain += urltext
288 index = txt.find("]")
290 raise MetaDataException("Unterminated ]")
292 index2 = url.find(' ')
296 urltxt = url[index2 + 1:]
298 linkified_html += '<a href="' + url + '">' + cgi.escape(urltxt) + '</a>'
299 linkified_plain += urltxt
301 linkified_plain += ' (' + url + ')'
304 def addtext(self, txt):
305 p, h = self.linkify(txt)
309 def parseline(self, line):
310 self.text_wiki += "%s\n" % line
313 elif line.startswith('*'):
314 self.endcur([self.stUL])
315 if self.state != self.stUL:
316 self.text_html += '<ul>'
317 self.state = self.stUL
318 self.text_html += '<li>'
319 self.text_plain += '*'
320 self.addtext(line[1:])
321 self.text_html += '</li>'
322 elif line.startswith('#'):
323 self.endcur([self.stOL])
324 if self.state != self.stOL:
325 self.text_html += '<ol>'
326 self.state = self.stOL
327 self.text_html += '<li>'
328 self.text_plain += '*' #TODO: lazy - put the numbers in!
329 self.addtext(line[1:])
330 self.text_html += '</li>'
332 self.endcur([self.stPARA])
333 if self.state == self.stNONE:
334 self.text_html += '<p>'
335 self.state = self.stPARA
336 elif self.state == self.stPARA:
337 self.text_html += ' '
338 self.text_plain += ' '
344 # Parse multiple lines of description as written in a metadata file, returning
345 # a single string in plain text format.
346 def description_plain(lines, linkres):
347 ps = DescriptionFormatter(linkres)
353 # Parse multiple lines of description as written in a metadata file, returning
354 # a single string in wiki format. Used for the Maintainer Notes field as well,
355 # because it's the same format.
356 def description_wiki(lines):
357 ps = DescriptionFormatter(None)
363 # Parse multiple lines of description as written in a metadata file, returning
364 # a single string in HTML format.
365 def description_html(lines,linkres):
366 ps = DescriptionFormatter(linkres)
372 def parse_srclib(metafile, **kw):
375 if metafile and not isinstance(metafile, file):
376 metafile = open(metafile, "r")
378 # Defaults for fields that come from metadata
379 thisinfo['Repo Type'] = ''
380 thisinfo['Repo'] = ''
381 thisinfo['Subdir'] = None
382 thisinfo['Prepare'] = None
383 thisinfo['Srclibs'] = None
384 thisinfo['Update Project'] = None
389 for line in metafile:
390 line = line.rstrip('\r\n')
391 if not line or line.startswith("#"):
395 field, value = line.split(':',1)
397 raise MetaDataException("Invalid metadata in " + metafile.name + " at: " + line)
399 if field == "Subdir":
400 thisinfo[field] = value.split(',')
402 thisinfo[field] = value
406 # Read all metadata. Returns a list of 'app' objects (which are dictionaries as
407 # returned by the parse_metadata function.
408 def read_metadata(xref=True, package=None, store=True):
411 for basedir in ('metadata', 'tmp'):
412 if not os.path.exists(basedir):
415 for metafile in sorted(glob.glob(os.path.join('metadata', '*.txt'))):
416 if package is None or metafile == os.path.join('metadata', package + '.txt'):
418 appinfo = parse_metadata(metafile)
420 raise MetaDataException("Problem reading metadata file %s: - %s" % (metafile, str(e)))
421 check_metadata(appinfo)
425 # Parse all descriptions at load time, just to ensure cross-referencing
426 # errors are caught early rather than when they hit the build server.
429 if app['id'] == link:
430 return ("fdroid.app:" + link, "Dummy name - don't know yet")
431 raise MetaDataException("Cannot resolve app id " + link)
434 description_html(app['Description'], linkres)
436 raise MetaDataException("Problem with description of " + app['id'] +
441 # Get the type expected for a given metadata field.
442 def metafieldtype(name):
443 if name in ['Description', 'Maintainer Notes']:
445 if name == 'Build Version':
449 if name == 'Use Built':
451 if name not in app_defaults:
455 # Parse metadata for a single application.
457 # 'metafile' - the filename to read. The package id for the application comes
458 # from this filename. Pass None to get a blank entry.
460 # Returns a dictionary containing all the details of the application. There are
461 # two major kinds of information in the dictionary. Keys beginning with capital
462 # letters correspond directory to identically named keys in the metadata file.
463 # Keys beginning with lower case letters are generated in one way or another,
464 # and are not found verbatim in the metadata.
466 # Known keys not originating from the metadata are:
468 # 'id' - the application's package ID
469 # 'builds' - a list of dictionaries containing build information
470 # for each defined build
471 # 'comments' - a list of comments from the metadata file. Each is
472 # a tuple of the form (field, comment) where field is
473 # the name of the field it preceded in the metadata
474 # file. Where field is None, the comment goes at the
475 # end of the file. Alternatively, 'build:version' is
476 # for a comment before a particular build version.
477 # 'descriptionlines' - original lines of description as formatted in the
480 def parse_metadata(metafile):
482 def parse_buildline(lines):
483 value = "".join(lines)
484 parts = [p.replace("\\,", ",")
485 for p in re.split(r"(?<!\\),", value)]
487 raise MetaDataException("Invalid build format: " + value + " in " + metafile.name)
489 thisbuild['origlines'] = lines
490 thisbuild['version'] = parts[0]
491 thisbuild['vercode'] = parts[1]
492 if parts[2].startswith('!'):
493 # For backwards compatibility, handle old-style disabling,
494 # including attempting to extract the commit from the message
495 thisbuild['disable'] = parts[2][1:]
496 commit = 'unknown - see disabled'
497 index = parts[2].rfind('at ')
499 commit = parts[2][index+3:]
500 if commit.endswith(')'):
502 thisbuild['commit'] = commit
504 thisbuild['commit'] = parts[2]
506 pk, pv = p.split('=', 1)
508 if pk not in ordered_flags:
509 raise MetaDataException("Unrecognised build flag at {0} in {1}".
510 format(p, metafile.name))
515 def add_comments(key):
518 for comment in curcomments:
519 thisinfo['comments'].append((key, comment))
522 def get_build_type(build):
523 for t in ['maven', 'gradle', 'kivy']:
524 if build.get(t, 'no') != 'no':
526 if 'output' in build:
532 if not isinstance(metafile, file):
533 metafile = open(metafile, "r")
534 thisinfo['id'] = metafile.name[9:-4]
536 thisinfo['id'] = None
538 thisinfo.update(app_defaults)
540 # General defaults...
541 thisinfo['builds'] = []
542 thisinfo['comments'] = []
552 for line in metafile:
553 line = line.rstrip('\r\n')
555 if not any(line.startswith(s) for s in (' ', '\t')):
556 if 'commit' not in curbuild and 'disable' not in curbuild:
557 raise MetaDataException("No commit specified for {0} in {1}".format(
558 curbuild['version'], metafile.name))
559 thisinfo['builds'].append(curbuild)
560 add_comments('build:' + curbuild['version'])
563 if line.endswith('\\'):
564 buildlines.append(line[:-1].lstrip())
566 buildlines.append(line.lstrip())
567 bl = ''.join(buildlines)
568 bv = bl.split('=', 1)
570 raise MetaDataException("Invalid build flag at {0} in {1}".
571 format(buildlines[0], metafile.name))
574 raise MetaDataException("Duplicate definition on {0} in version {1} of {2}".
575 format(name, curbuild['version'], metafile.name))
576 curbuild[name] = val.lstrip()
582 if line.startswith("#"):
583 curcomments.append(line)
586 field, value = line.split(':',1)
588 raise MetaDataException("Invalid metadata in " + metafile.name + " at: " + line)
589 if field != field.strip() or value != value.strip():
590 raise MetaDataException("Extra spacing found in " + metafile.name + " at: " + line)
592 # Translate obsolete fields...
593 if field == 'Market Version':
594 field = 'Current Version'
595 if field == 'Market Version Code':
596 field = 'Current Version Code'
598 fieldtype = metafieldtype(field)
599 if fieldtype not in ['build', 'buildv2']:
601 if fieldtype == 'multiline':
605 raise MetaDataException("Unexpected text on same line as " + field + " in " + metafile.name)
606 elif fieldtype == 'string':
607 thisinfo[field] = value
608 elif fieldtype == 'build':
609 if value.endswith("\\"):
611 buildlines = [value[:-1]]
613 thisinfo['builds'].append(parse_buildline([value]))
614 add_comments('build:' + thisinfo['builds'][-1]['version'])
615 elif fieldtype == 'buildv2':
617 vv = value.split(',')
619 raise MetaDataException('Build should have comma-separated version and vercode, not "{0}", in {1}'.
620 format(value, metafile.name))
621 curbuild['version'] = vv[0]
622 curbuild['vercode'] = vv[1]
625 elif fieldtype == 'obsolete':
626 pass # Just throw it away!
628 raise MetaDataException("Unrecognised field type for " + field + " in " + metafile.name)
629 elif mode == 1: # Multiline field
633 thisinfo[field].append(line)
634 elif mode == 2: # Line continuation mode in Build Version
635 if line.endswith("\\"):
636 buildlines.append(line[:-1])
638 buildlines.append(line)
639 thisinfo['builds'].append(
640 parse_buildline(buildlines))
641 add_comments('build:' + thisinfo['builds'][-1]['version'])
645 # Mode at end of file should always be 0...
647 raise MetaDataException(field + " not terminated in " + metafile.name)
649 raise MetaDataException("Unterminated continuation in " + metafile.name)
651 raise MetaDataException("Unterminated build in " + metafile.name)
653 if not thisinfo['Description']:
654 thisinfo['Description'].append('No description available')
656 for build in thisinfo['builds']:
657 build['type'] = get_build_type(build)
661 # Write a metadata file.
663 # 'dest' - The path to the output file
664 # 'app' - The app data
665 def write_metadata(dest, app):
667 def writecomments(key):
669 for pf, comment in app['comments']:
671 mf.write("%s\n" % comment)
674 logging.debug("...writing comments for " + (key if key else 'EOF'))
676 def writefield(field, value=None):
680 mf.write("%s:%s\n" % (field, value))
684 writefield('Disabled')
685 if app['AntiFeatures']:
686 writefield('AntiFeatures')
688 writefield('Provides')
689 writefield('Categories')
690 writefield('License')
691 writefield('Web Site')
692 writefield('Source Code')
693 writefield('Issue Tracker')
697 writefield('FlattrID')
699 writefield('Bitcoin')
701 writefield('Litecoin')
703 writefield('Dogecoin')
708 writefield('Auto Name')
709 writefield('Summary')
710 writefield('Description', '')
711 for line in app['Description']:
712 mf.write("%s\n" % line)
715 if app['Requires Root']:
716 writefield('Requires Root', 'Yes')
719 writefield('Repo Type')
722 for build in app['builds']:
723 writecomments('build:' + build['version'])
724 mf.write("Build:%s,%s\n" % ( build['version'], build['vercode']))
726 def write_builditem(key, value):
727 if key in ['version', 'vercode', 'origlines', 'type']:
729 if key in valuetypes['bool'].attrs:
733 logging.debug("...writing {0} : {1}".format(key, value))
734 outline = ' %s=' % key
735 outline += '&& \\\n '.join([s.lstrip() for s in value.split('&& ')])
739 for key in ordered_flags:
741 write_builditem(key, build[key])
744 if 'Maintainer Notes' in app:
745 writefield('Maintainer Notes', '')
746 for line in app['Maintainer Notes']:
747 mf.write("%s\n" % line)
752 if app['Archive Policy']:
753 writefield('Archive Policy')
754 writefield('Auto Update Mode')
755 writefield('Update Check Mode')
756 if app['Vercode Operation']:
757 writefield('Vercode Operation')
758 if app['Update Check Data']:
759 writefield('Update Check Data')
760 if app['Current Version']:
761 writefield('Current Version')
762 writefield('Current Version Code')
764 if app['No Source Since']:
765 writefield('No Source Since')