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/>.
28 from cStringIO import StringIO
30 from StringIO import StringIO
33 # use libyaml if it is available
35 from yaml import CLoader
38 from yaml import Loader
41 # use the C implementation when available
42 import xml.etree.cElementTree as ElementTree
49 class MetaDataException(Exception):
51 def __init__(self, value):
57 # To filter which ones should be written to the metadata files if
85 'Update Check Ignore',
90 'Current Version Code',
93 'comments', # For formats that don't do inline comments
94 'builds', # For formats that do builds as a list
102 self.AntiFeatures = []
104 self.Categories = ['None']
105 self.License = 'Unknown'
108 self.IssueTracker = ''
117 self.Description = ''
118 self.RequiresRoot = False
122 self.MaintainerNotes = ''
123 self.ArchivePolicy = None
124 self.AutoUpdateMode = 'None'
125 self.UpdateCheckMode = 'None'
126 self.UpdateCheckIgnore = None
127 self.VercodeOperation = None
128 self.UpdateCheckName = None
129 self.UpdateCheckData = None
130 self.CurrentVersion = ''
131 self.CurrentVersionCode = '0'
132 self.NoSourceSince = ''
135 self.metadatapath = None
139 self.lastupdated = None
141 # Translates human-readable field names to attribute names, e.g.
142 # 'Auto Name' to 'AutoName'
144 def field_to_attr(cls, f):
145 return f.replace(' ', '')
147 # Translates attribute names to human-readable field names, e.g.
148 # 'AutoName' to 'Auto Name'
150 def attr_to_field(cls, k):
153 f = re.sub(r'([a-z])([A-Z])', r'\1 \2', k)
156 # Constructs an old-fashioned dict with the human-readable field
157 # names. Should only be used for tests.
158 def field_dict(self):
160 for k, v in self.__dict__.iteritems():
164 d['builds'].append(build.__dict__)
166 k = App.attr_to_field(k)
170 # Gets the value associated to a field name, e.g. 'Auto Name'
171 def get_field(self, f):
172 if f not in app_fields:
173 raise MetaDataException('Unrecognised app field: ' + f)
174 k = App.field_to_attr(f)
175 return getattr(self, k)
177 # Sets the value associated to a field name, e.g. 'Auto Name'
178 def set_field(self, f, v):
179 if f not in app_fields:
180 raise MetaDataException('Unrecognised app field: ' + f)
181 k = App.field_to_attr(f)
184 # Appends to the value associated to a field name, e.g. 'Auto Name'
185 def append_field(self, f, v):
186 if f not in app_fields:
187 raise MetaDataException('Unrecognised app field: ' + f)
188 k = App.field_to_attr(f)
189 if k not in self.__dict__:
190 self.__dict__[k] = [v]
192 self.__dict__[k].append(v)
194 # Like dict.update(), but using human-readable field names
195 def update_fields(self, d):
196 for f, v in d.iteritems():
200 build.update_flags(b)
201 self.builds.append(build)
216 'Description': TYPE_MULTILINE,
217 'Maintainer Notes': TYPE_MULTILINE,
218 'Categories': TYPE_LIST,
219 'AntiFeatures': TYPE_LIST,
220 'Build Version': TYPE_BUILD,
221 'Build': TYPE_BUILD_V2,
222 'Use Built': TYPE_OBSOLETE,
227 if name in fieldtypes:
228 return fieldtypes[name]
232 # In the order in which they are laid out on files
233 build_flags_order = [
266 build_flags = set(build_flags_order + ['version', 'vercode'])
275 self.submodules = False
283 self.oldsdkloc = False
285 self.forceversion = False
286 self.forcevercode = False
297 self.preassemble = []
298 self.gradleprops = []
299 self.antcommands = None
300 self.novcheck = False
302 def get_flag(self, f):
303 if f not in build_flags:
304 raise MetaDataException('Unrecognised build flag: ' + f)
305 return getattr(self, f)
307 def set_flag(self, f, v):
308 if f == 'versionName':
310 if f == 'versionCode':
312 if f not in build_flags:
313 raise MetaDataException('Unrecognised build flag: ' + f)
316 def append_flag(self, f, v):
317 if f not in build_flags:
318 raise MetaDataException('Unrecognised build flag: ' + f)
319 if f not in self.__dict__:
320 self.__dict__[f] = [v]
322 self.__dict__[f].append(v)
325 for f in ['maven', 'gradle', 'kivy']:
335 version = 'r10e' # falls back to latest
336 paths = common.config['ndk_paths']
337 if version not in paths:
339 return paths[version]
341 def update_flags(self, d):
342 for f, v in d.iteritems():
346 'extlibs': TYPE_LIST,
347 'srclibs': TYPE_LIST,
350 'buildjni': TYPE_LIST,
351 'preassemble': TYPE_LIST,
353 'scanignore': TYPE_LIST,
354 'scandelete': TYPE_LIST,
356 'antcommands': TYPE_LIST,
357 'gradleprops': TYPE_LIST,
359 'prebuild': TYPE_SCRIPT,
360 'build': TYPE_SCRIPT,
361 'submodules': TYPE_BOOL,
362 'oldsdkloc': TYPE_BOOL,
363 'forceversion': TYPE_BOOL,
364 'forcevercode': TYPE_BOOL,
365 'novcheck': TYPE_BOOL,
370 if name in flagtypes:
371 return flagtypes[name]
375 # Designates a metadata field type and checks that it matches
377 # 'name' - The long name of the field type
378 # 'matching' - List of possible values or regex expression
379 # 'sep' - Separator to use if value may be a list
380 # 'fields' - Metadata fields (Field:Value) of this type
381 # 'flags' - Build flags (flag=value) of this type
383 class FieldValidator():
385 def __init__(self, name, matching, sep, fields, flags):
387 self.matching = matching
388 if type(matching) is str:
389 self.compiled = re.compile(matching)
394 def _assert_regex(self, values, appid):
396 if not self.compiled.match(v):
397 raise MetaDataException("'%s' is not a valid %s in %s. "
398 % (v, self.name, appid) +
399 "Regex pattern: %s" % (self.matching))
401 def _assert_list(self, values, appid):
403 if v not in self.matching:
404 raise MetaDataException("'%s' is not a valid %s in %s. "
405 % (v, self.name, appid) +
406 "Possible values: %s" % (", ".join(self.matching)))
408 def check(self, v, appid):
409 if type(v) is not str or not v:
411 if self.sep is not None:
412 values = v.split(self.sep)
415 if type(self.matching) is list:
416 self._assert_list(values, appid)
418 self._assert_regex(values, appid)
421 # Generic value types
423 FieldValidator("Integer",
424 r'^[1-9][0-9]*$', None,
428 FieldValidator("Hexadecimal",
429 r'^[0-9a-f]+$', None,
433 FieldValidator("HTTP link",
434 r'^http[s]?://', None,
435 ["Web Site", "Source Code", "Issue Tracker", "Changelog", "Donate"], []),
437 FieldValidator("Bitcoin address",
438 r'^[a-zA-Z0-9]{27,34}$', None,
442 FieldValidator("Litecoin address",
443 r'^L[a-zA-Z0-9]{33}$', None,
447 FieldValidator("bool",
448 r'([Yy]es|[Nn]o|[Tt]rue|[Ff]alse)', None,
450 ['submodules', 'oldsdkloc', 'forceversion', 'forcevercode',
453 FieldValidator("Repo Type",
454 ['git', 'git-svn', 'svn', 'hg', 'bzr', 'srclib'], None,
458 FieldValidator("Binaries",
459 r'^http[s]?://', None,
463 FieldValidator("Archive Policy",
464 r'^[0-9]+ versions$', None,
468 FieldValidator("Anti-Feature",
469 ["Ads", "Tracking", "NonFreeNet", "NonFreeDep", "NonFreeAdd", "UpstreamNonFree"], ',',
473 FieldValidator("Auto Update Mode",
474 r"^(Version .+|None)$", None,
475 ["Auto Update Mode"],
478 FieldValidator("Update Check Mode",
479 r"^(Tags|Tags .+|RepoManifest|RepoManifest/.+|RepoTrunk|HTTP|Static|None)$", None,
480 ["Update Check Mode"],
485 # Check an app's metadata information for integrity errors
486 def check_metadata(app):
489 v.check(app.get_field(f), app.id)
490 for build in app.builds:
492 v.check(build.get_flag(f), app.id)
495 # Formatter for descriptions. Create an instance, and call parseline() with
496 # each line of the description source from the metadata. At the end, call
497 # end() and then text_txt and text_html will contain the result.
498 class DescriptionFormatter:
505 def __init__(self, linkres):
508 self.state = self.stNONE
511 self.html = StringIO()
512 self.text = StringIO()
514 self.linkResolver = None
515 self.linkResolver = linkres
517 def endcur(self, notstates=None):
518 if notstates and self.state in notstates:
520 if self.state == self.stPARA:
522 elif self.state == self.stUL:
524 elif self.state == self.stOL:
528 self.state = self.stNONE
529 whole_para = ' '.join(self.para_lines)
530 self.addtext(whole_para)
531 self.text.write(textwrap.fill(whole_para, 80,
532 break_long_words=False,
533 break_on_hyphens=False))
534 self.text.write('\n\n')
535 self.html.write('</p>')
536 del self.para_lines[:]
539 self.html.write('</ul>')
540 self.text.write('\n')
541 self.state = self.stNONE
544 self.html.write('</ol>')
545 self.text.write('\n')
546 self.state = self.stNONE
548 def formatted(self, txt, html):
551 txt = cgi.escape(txt)
553 index = txt.find("''")
558 if txt.startswith("'''"):
564 self.bold = not self.bold
572 self.ital = not self.ital
575 def linkify(self, txt):
579 index = txt.find("[")
581 return (res_plain + self.formatted(txt, False), res_html + self.formatted(txt, True))
582 res_plain += self.formatted(txt[:index], False)
583 res_html += self.formatted(txt[:index], True)
585 if txt.startswith("[["):
586 index = txt.find("]]")
588 raise MetaDataException("Unterminated ]]")
590 if self.linkResolver:
591 url, urltext = self.linkResolver(url)
594 res_html += '<a href="' + url + '">' + cgi.escape(urltext) + '</a>'
596 txt = txt[index + 2:]
598 index = txt.find("]")
600 raise MetaDataException("Unterminated ]")
602 index2 = url.find(' ')
606 urltxt = url[index2 + 1:]
609 raise MetaDataException("Url title is just the URL - use [url]")
610 res_html += '<a href="' + url + '">' + cgi.escape(urltxt) + '</a>'
613 res_plain += ' (' + url + ')'
614 txt = txt[index + 1:]
616 def addtext(self, txt):
617 p, h = self.linkify(txt)
620 def parseline(self, line):
623 elif line.startswith('* '):
624 self.endcur([self.stUL])
625 self.text.write(line)
626 self.text.write('\n')
627 if self.state != self.stUL:
628 self.html.write('<ul>')
629 self.state = self.stUL
630 self.html.write('<li>')
631 self.addtext(line[1:])
632 self.html.write('</li>')
633 elif line.startswith('# '):
634 self.endcur([self.stOL])
635 self.text.write(line)
636 self.text.write('\n')
637 if self.state != self.stOL:
638 self.html.write('<ol>')
639 self.state = self.stOL
640 self.html.write('<li>')
641 self.addtext(line[1:])
642 self.html.write('</li>')
644 self.para_lines.append(line)
645 self.endcur([self.stPARA])
646 if self.state == self.stNONE:
647 self.html.write('<p>')
648 self.state = self.stPARA
652 self.text_txt = self.text.getvalue().rstrip()
653 self.text_html = self.html.getvalue()
658 # Parse multiple lines of description as written in a metadata file, returning
659 # a single string in text format and wrapped to 80 columns.
660 def description_txt(s):
661 ps = DescriptionFormatter(None)
662 for line in s.splitlines():
668 # Parse multiple lines of description as written in a metadata file, returning
669 # a single string in wiki format. Used for the Maintainer Notes field as well,
670 # because it's the same format.
671 def description_wiki(s):
675 # Parse multiple lines of description as written in a metadata file, returning
676 # a single string in HTML format.
677 def description_html(s, linkres):
678 ps = DescriptionFormatter(linkres)
679 for line in s.splitlines():
685 def parse_srclib(metadatapath):
689 # Defaults for fields that come from metadata
690 thisinfo['Repo Type'] = ''
691 thisinfo['Repo'] = ''
692 thisinfo['Subdir'] = None
693 thisinfo['Prepare'] = None
695 if not os.path.exists(metadatapath):
698 metafile = open(metadatapath, "r")
701 for line in metafile:
703 line = line.rstrip('\r\n')
704 if not line or line.startswith("#"):
708 f, v = line.split(':', 1)
710 raise MetaDataException("Invalid metadata in %s:%d" % (line, n))
713 thisinfo[f] = v.split(',')
723 """Read all srclib metadata.
725 The information read will be accessible as metadata.srclibs, which is a
726 dictionary, keyed on srclib name, with the values each being a dictionary
727 in the same format as that returned by the parse_srclib function.
729 A MetaDataException is raised if there are any problems with the srclib
734 # They were already loaded
735 if srclibs is not None:
741 if not os.path.exists(srcdir):
744 for metadatapath in sorted(glob.glob(os.path.join(srcdir, '*.txt'))):
745 srclibname = os.path.basename(metadatapath[:-4])
746 srclibs[srclibname] = parse_srclib(metadatapath)
749 # Read all metadata. Returns a list of 'app' objects (which are dictionaries as
750 # returned by the parse_txt_metadata function.
751 def read_metadata(xref=True):
753 # Always read the srclibs before the apps, since they can use a srlib as
754 # their source repository.
759 for basedir in ('metadata', 'tmp'):
760 if not os.path.exists(basedir):
763 # If there are multiple metadata files for a single appid, then the first
764 # file that is parsed wins over all the others, and the rest throw an
765 # exception. So the original .txt format is parsed first, at least until
766 # newer formats stabilize.
768 for metadatapath in sorted(glob.glob(os.path.join('metadata', '*.txt'))
769 + glob.glob(os.path.join('metadata', '*.json'))
770 + glob.glob(os.path.join('metadata', '*.xml'))
771 + glob.glob(os.path.join('metadata', '*.yaml'))):
772 app = parse_metadata(metadatapath)
774 raise MetaDataException("Found multiple metadata files for " + app.id)
779 # Parse all descriptions at load time, just to ensure cross-referencing
780 # errors are caught early rather than when they hit the build server.
783 return ("fdroid.app:" + appid, "Dummy name - don't know yet")
784 raise MetaDataException("Cannot resolve app id " + appid)
786 for appid, app in apps.iteritems():
788 description_html(app.Description, linkres)
789 except MetaDataException, e:
790 raise MetaDataException("Problem with description of " + appid +
795 # Port legacy ';' separators
796 list_sep = re.compile(r'[,;]')
799 def split_list_values(s):
801 for v in re.split(list_sep, s):
811 def get_default_app_info(metadatapath=None):
812 if metadatapath is None:
815 appid, _ = common.get_extension(os.path.basename(metadatapath))
818 app.metadatapath = metadatapath
819 if appid is not None:
825 def sorted_builds(builds):
826 return sorted(builds, key=lambda build: int(build.vercode))
829 esc_newlines = re.compile(r'\\( |\n)')
832 # This function uses __dict__ to be faster
833 def post_metadata_parse(app):
835 for k, v in app.__dict__.iteritems():
836 if type(v) in (float, int):
837 app.__dict__[k] = str(v)
839 for build in app.builds:
840 for k, v in build.__dict__.iteritems():
842 if type(v) in (float, int):
843 build.__dict__[k] = str(v)
847 if ftype == TYPE_SCRIPT:
848 build.__dict__[k] = re.sub(esc_newlines, '', v).lstrip().rstrip()
849 elif ftype == TYPE_BOOL:
850 # TODO handle this using <xsd:element type="xsd:boolean> in a schema
851 if isinstance(v, basestring) and v == 'true':
852 build.__dict__[k] = True
853 elif ftype == TYPE_BOOL:
854 if isinstance(v, bool) and v:
855 build.__dict__[k] = 'yes'
857 if not app.Description:
858 app.Description = 'No description available'
860 app.builds = sorted_builds(app.builds)
863 # Parse metadata for a single application.
865 # 'metadatapath' - the filename to read. The package id for the application comes
866 # from this filename. Pass None to get a blank entry.
868 # Returns a dictionary containing all the details of the application. There are
869 # two major kinds of information in the dictionary. Keys beginning with capital
870 # letters correspond directory to identically named keys in the metadata file.
871 # Keys beginning with lower case letters are generated in one way or another,
872 # and are not found verbatim in the metadata.
874 # Known keys not originating from the metadata are:
876 # 'builds' - a list of dictionaries containing build information
877 # for each defined build
878 # 'comments' - a list of comments from the metadata file. Each is
879 # a list of the form [field, comment] where field is
880 # the name of the field it preceded in the metadata
881 # file. Where field is None, the comment goes at the
882 # end of the file. Alternatively, 'build:version' is
883 # for a comment before a particular build version.
884 # 'descriptionlines' - original lines of description as formatted in the
889 def _decode_list(data):
890 '''convert items in a list from unicode to basestring'''
893 if isinstance(item, unicode):
894 item = item.encode('utf-8')
895 elif isinstance(item, list):
896 item = _decode_list(item)
897 elif isinstance(item, dict):
898 item = _decode_dict(item)
903 def _decode_dict(data):
904 '''convert items in a dict from unicode to basestring'''
906 for k, v in data.iteritems():
907 if isinstance(k, unicode):
908 k = k.encode('utf-8')
909 if isinstance(v, unicode):
910 v = v.encode('utf-8')
911 elif isinstance(v, list):
913 elif isinstance(v, dict):
919 def parse_metadata(metadatapath):
920 _, ext = common.get_extension(metadatapath)
921 accepted = common.config['accepted_formats']
922 if ext not in accepted:
923 raise MetaDataException('"%s" is not an accepted format, convert to: %s' % (
924 metadatapath, ', '.join(accepted)))
928 app = parse_txt_metadata(metadatapath)
930 app = parse_json_metadata(metadatapath)
932 app = parse_xml_metadata(metadatapath)
934 app = parse_yaml_metadata(metadatapath)
936 raise MetaDataException('Unknown metadata format: %s' % metadatapath)
938 post_metadata_parse(app)
942 def parse_json_metadata(metadatapath):
944 app = get_default_app_info(metadatapath)
946 # fdroid metadata is only strings and booleans, no floats or ints. And
947 # json returns unicode, and fdroidserver still uses plain python strings
948 # TODO create schema using https://pypi.python.org/pypi/jsonschema
950 with open(metadatapath, 'r') as f:
951 jsoninfo = json.load(f, object_hook=_decode_dict,
952 parse_int=lambda s: s,
953 parse_float=lambda s: s)
954 app.update_fields(jsoninfo)
955 for f in ['Description', 'Maintainer Notes']:
957 app.set_field(f, '\n'.join(v))
961 def parse_xml_metadata(metadatapath):
963 app = get_default_app_info(metadatapath)
965 tree = ElementTree.ElementTree(file=metadatapath)
966 root = tree.getroot()
968 if root.tag != 'resources':
969 raise MetaDataException('%s does not have root as <resources></resources>!' % metadatapath)
972 if child.tag != 'builds':
973 # builds does not have name="" attrib
974 name = child.attrib['name']
976 if child.tag == 'string':
977 app.set_field(name, child.text)
978 elif child.tag == 'string-array':
980 app.append_field(name, item.text)
981 elif child.tag == 'builds':
985 build.set_flag(key.tag, key.text)
986 app.builds.append(build)
988 # TODO handle this using <xsd:element type="xsd:boolean> in a schema
989 if not isinstance(app.RequiresRoot, bool):
990 app.RequiresRoot = app.RequiresRoot == 'true'
995 def parse_yaml_metadata(metadatapath):
997 app = get_default_app_info(metadatapath)
1000 with open(metadatapath, 'r') as f:
1001 yamlinfo = yaml.load(f, Loader=YamlLoader)
1002 app.update_fields(yamlinfo)
1006 build_line_sep = re.compile(r'(?<!\\),')
1007 build_cont = re.compile(r'^[ \t]')
1010 def parse_txt_metadata(metadatapath):
1014 def add_buildflag(p, build):
1016 raise MetaDataException("Empty build flag at {1}"
1017 .format(buildlines[0], linedesc))
1018 bv = p.split('=', 1)
1020 raise MetaDataException("Invalid build flag at {0} in {1}"
1021 .format(buildlines[0], linedesc))
1027 pv = split_list_values(pv)
1028 build.set_flag(pk, pv)
1029 elif t == TYPE_STRING or t == TYPE_SCRIPT:
1030 build.set_flag(pk, pv)
1031 elif t == TYPE_BOOL:
1033 build.set_flag(pk, True)
1035 def parse_buildline(lines):
1037 parts = [p.replace("\\,", ",") for p in re.split(build_line_sep, v)]
1039 raise MetaDataException("Invalid build format: " + v + " in " + metafile.name)
1041 build.origlines = lines
1042 build.version = parts[0]
1043 build.vercode = parts[1]
1044 if parts[2].startswith('!'):
1045 # For backwards compatibility, handle old-style disabling,
1046 # including attempting to extract the commit from the message
1047 build.disable = parts[2][1:]
1048 commit = 'unknown - see disabled'
1049 index = parts[2].rfind('at ')
1051 commit = parts[2][index + 3:]
1052 if commit.endswith(')'):
1053 commit = commit[:-1]
1054 build.commit = commit
1056 build.commit = parts[2]
1058 add_buildflag(p, build)
1062 def add_comments(key):
1065 app.comments[key] = list(curcomments)
1068 app = get_default_app_info(metadatapath)
1069 metafile = open(metadatapath, "r")
1073 multiline_lines = []
1079 for line in metafile:
1081 linedesc = "%s:%d" % (metafile.name, c)
1082 line = line.rstrip('\r\n')
1084 if build_cont.match(line):
1085 if line.endswith('\\'):
1086 buildlines.append(line[:-1].lstrip())
1088 buildlines.append(line.lstrip())
1089 bl = ''.join(buildlines)
1090 add_buildflag(bl, build)
1093 if not build.commit and not build.disable:
1094 raise MetaDataException("No commit specified for {0} in {1}"
1095 .format(build.version, linedesc))
1097 app.builds.append(build)
1098 add_comments('build:' + build.vercode)
1104 if line.startswith("#"):
1105 curcomments.append(line[1:].strip())
1108 f, v = line.split(':', 1)
1110 raise MetaDataException("Invalid metadata in " + linedesc)
1112 # Translate obsolete fields...
1113 if f == 'Market Version':
1114 f = 'Current Version'
1115 if f == 'Market Version Code':
1116 f = 'Current Version Code'
1118 ftype = fieldtype(f)
1119 if ftype not in [TYPE_BUILD, TYPE_BUILD_V2]:
1121 if ftype == TYPE_MULTILINE:
1124 raise MetaDataException("Unexpected text on same line as " + f + " in " + linedesc)
1125 elif ftype == TYPE_STRING:
1127 elif ftype == TYPE_LIST:
1128 app.set_field(f, split_list_values(v))
1129 elif ftype == TYPE_BUILD:
1130 if v.endswith("\\"):
1133 buildlines.append(v[:-1])
1135 build = parse_buildline([v])
1136 app.builds.append(build)
1137 add_comments('build:' + app.builds[-1].vercode)
1138 elif ftype == TYPE_BUILD_V2:
1141 raise MetaDataException('Build should have comma-separated version and vercode, not "{0}", in {1}'
1142 .format(v, linedesc))
1144 build.version = vv[0]
1145 build.vercode = vv[1]
1146 if build.vercode in vc_seen:
1147 raise MetaDataException('Duplicate build recipe found for vercode %s in %s' % (
1148 build.vercode, linedesc))
1149 vc_seen.add(build.vercode)
1152 elif ftype == TYPE_OBSOLETE:
1153 pass # Just throw it away!
1155 raise MetaDataException("Unrecognised field '" + f + "' in " + linedesc)
1156 elif mode == 1: # Multiline field
1159 app.set_field(f, '\n'.join(multiline_lines))
1160 del multiline_lines[:]
1162 multiline_lines.append(line)
1163 elif mode == 2: # Line continuation mode in Build Version
1164 if line.endswith("\\"):
1165 buildlines.append(line[:-1])
1167 buildlines.append(line)
1168 build = parse_buildline(buildlines)
1169 app.builds.append(build)
1170 add_comments('build:' + app.builds[-1].vercode)
1175 # Mode at end of file should always be 0
1177 raise MetaDataException(f + " not terminated in " + metafile.name)
1179 raise MetaDataException("Unterminated continuation in " + metafile.name)
1181 raise MetaDataException("Unterminated build in " + metafile.name)
1186 def write_plaintext_metadata(mf, app, w_comment, w_field, w_build):
1188 def w_comments(key):
1189 if key not in app.comments:
1191 for line in app.comments[key]:
1194 def w_field_always(f, v=None):
1196 v = app.get_field(f)
1200 def w_field_nonempty(f, v=None):
1202 v = app.get_field(f)
1207 w_field_nonempty('Disabled')
1208 if app.AntiFeatures:
1209 w_field_always('AntiFeatures')
1210 w_field_nonempty('Provides')
1211 w_field_always('Categories')
1212 w_field_always('License')
1213 w_field_always('Web Site')
1214 w_field_always('Source Code')
1215 w_field_always('Issue Tracker')
1216 w_field_nonempty('Changelog')
1217 w_field_nonempty('Donate')
1218 w_field_nonempty('FlattrID')
1219 w_field_nonempty('Bitcoin')
1220 w_field_nonempty('Litecoin')
1222 w_field_nonempty('Name')
1223 w_field_nonempty('Auto Name')
1224 w_field_always('Summary')
1225 w_field_always('Description', description_txt(app.Description))
1227 if app.RequiresRoot:
1228 w_field_always('Requires Root', 'yes')
1231 w_field_always('Repo Type')
1232 w_field_always('Repo')
1234 w_field_always('Binaries')
1237 for build in sorted_builds(app.builds):
1239 if build.version == "Ignore":
1242 w_comments('build:' + build.vercode)
1246 if app.MaintainerNotes:
1247 w_field_always('Maintainer Notes', app.MaintainerNotes)
1250 w_field_nonempty('Archive Policy')
1251 w_field_always('Auto Update Mode')
1252 w_field_always('Update Check Mode')
1253 w_field_nonempty('Update Check Ignore')
1254 w_field_nonempty('Vercode Operation')
1255 w_field_nonempty('Update Check Name')
1256 w_field_nonempty('Update Check Data')
1257 if app.CurrentVersion:
1258 w_field_always('Current Version')
1259 w_field_always('Current Version Code')
1260 if app.NoSourceSince:
1262 w_field_always('No Source Since')
1266 # Write a metadata file in txt format.
1268 # 'mf' - Writer interface (file, StringIO, ...)
1269 # 'app' - The app data
1270 def write_txt_metadata(mf, app):
1272 def w_comment(line):
1273 mf.write("# %s\n" % line)
1279 elif t == TYPE_MULTILINE:
1280 v = '\n' + v + '\n.'
1281 mf.write("%s:%s\n" % (f, v))
1284 mf.write("Build:%s,%s\n" % (build.version, build.vercode))
1286 for f in build_flags_order:
1287 v = build.get_flag(f)
1292 mf.write(' %s=' % f)
1293 if t == TYPE_STRING:
1295 elif t == TYPE_BOOL:
1297 elif t == TYPE_SCRIPT:
1299 for s in v.split(' && '):
1303 mf.write(' && \\\n ')
1305 elif t == TYPE_LIST:
1306 mf.write(','.join(v))
1310 write_plaintext_metadata(mf, app, w_comment, w_field, w_build)
1313 def write_yaml_metadata(mf, app):
1315 def w_comment(line):
1316 mf.write("# %s\n" % line)
1321 if any(c in v for c in [': ', '%', '@', '*']):
1322 return "'" + v.replace("'", "''") + "'"
1325 def w_field(f, v, prefix='', t=None):
1332 v += prefix + ' - ' + escape(e) + '\n'
1333 elif t == TYPE_MULTILINE:
1335 for l in v.splitlines():
1337 v += prefix + ' ' + l + '\n'
1340 elif t == TYPE_BOOL:
1342 elif t == TYPE_SCRIPT:
1343 cmds = [s + '&& \\' for s in v.split('&& ')]
1345 cmds[-1] = cmds[-1][:-len('&& \\')]
1346 w_field(f, cmds, prefix, 'multiline')
1349 v = ' ' + escape(v) + '\n'
1362 mf.write("builds:\n")
1365 w_field('versionName', build.version, ' - ', TYPE_STRING)
1366 w_field('versionCode', build.vercode, ' ', TYPE_STRING)
1367 for f in build_flags_order:
1368 v = build.get_flag(f)
1372 w_field(f, v, ' ', flagtype(f))
1374 write_plaintext_metadata(mf, app, w_comment, w_field, w_build)
1377 def write_metadata(fmt, mf, app):
1379 return write_txt_metadata(mf, app)
1381 return write_yaml_metadata(mf, app)
1382 raise MetaDataException("Unknown metadata format given")