fdroidserver/metadata.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # common.py - part of the FDroid server tools
   4 # Copyright (C) 2013, Ciaran Gultnieks, ciaran@ciarang.com
   5 # Copyright (C) 2013 Daniel Martí <mvdan@mvdan.cc>
   6 #
   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.
  11 #
  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.
  16 #
  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/>.
  19
  20 import os, re, glob
  21 import cgi
  22
  23 class MetaDataException(Exception):
  24     def __init__(self, value):
  25         self.value = value
  26
  27     def __str__(self):
  28         return repr(self.value)
  29
  30 # Designates a metadata field type and checks that it matches
  31 #
  32 # 'name'     - The long name of the field type
  33 # 'matching' - List of possible values or regex expression
  34 # 'sep'      - Separator to use if value may be a list
  35 # 'fields'   - Metadata fields (Field:Value) of this type
  36 # 'attrs'    - Build attributes (attr=value) of this type
  37 #
  38 class FieldType():
  39     def __init__(self, name, matching, sep, fields, attrs):
  40         self.name = name
  41         self.matching = matching
  42         if type(matching) is str:
  43             self.compiled = re.compile(matching)
  44         self.sep = sep
  45         self.fields = fields
  46         self.attrs = attrs
  47
  48     def _assert_regex(self, values, appid):
  49         for v in values:
  50             if not self.compiled.match(v):
  51                 raise MetaDataException("'%s' is not a valid %s in %s. "
  52                         % (v, self.name, appid) +
  53                         "Regex pattern: %s" % (self.matching))
  54
  55     def _assert_list(self, values, appid):
  56         for v in values:
  57             if v not in self.matching:
  58                 raise MetaDataException("'%s' is not a valid %s in %s. "
  59                         % (v, self.name, appid) +
  60                         "Possible values: %s" % (", ".join(self.matching)))
  61
  62     def check(self, value, appid):
  63         if type(value) is not str or not value:
  64             return
  65         if self.sep is not None:
  66             values = value.split(self.sep)
  67         else:
  68             values = [value]
  69         if type(self.matching) is list:
  70             self._assert_list(values, appid)
  71         else:
  72             self._assert_regex(values, appid)
  73
  74
  75 # Generic value types
  76 valuetypes = {
  77     'int' : FieldType("Integer",
  78         r'^[0-9]+$', None,
  79         [ 'FlattrID' ],
  80         [ 'vercode' ]),
  81
  82     'http' : FieldType("HTTP link",
  83         r'^http[s]?://', None,
  84         [ "Web Site", "Source Code", "Issue Tracker", "Donate" ], []),
  85
  86     'bitcoin' : FieldType("Bitcoin address",
  87         r'^[a-zA-Z0-9]{27,34}$', None,
  88         [ "Bitcoin" ],
  89         [ ]),
  90
  91     'litecoin' : FieldType("Litecoin address",
  92         r'^L[a-zA-Z0-9]{33}$', None,
  93         [ "Litecoin" ],
  94         [ ]),
  95
  96     'Bool' : FieldType("Boolean",
  97         ['Yes', 'No'], None,
  98         [ "Requires Root" ],
  99         [ ]),
 100
 101     'bool' : FieldType("Boolean",
 102         ['yes', 'no'], None,
 103         [ ],
 104         [ 'submodules', 'oldsdkloc', 'forceversion', 'forcevercode',
 105             'fixtrans', 'fixapos', 'novcheck' ]),
 106
 107     'Repo Type' : FieldType("Repo Type",
 108         [ 'git', 'git-svn', 'svn', 'hg', 'bzr', 'srclib' ], None,
 109         [ "Repo Type" ],
 110         [ ]),
 111
 112     'archive' : FieldType("Archive Policy",
 113         r'^[0-9]+ versions$', None,
 114         [ "Archive Policy" ],
 115         [ ]),
 116
 117     'antifeatures' : FieldType("Anti-Feature",
 118         [ "Ads", "Tracking", "NonFreeNet", "NonFreeDep", "NonFreeAdd", "UpstreamNonFree" ], ',',
 119         [ "AntiFeatures" ],
 120         [ ]),
 121
 122     'autoupdatemodes' : FieldType("Auto Update Mode",
 123         r"^(Version .+|None)$", None,
 124         [ "Auto Update Mode" ],
 125         [ ]),
 126
 127     'updatecheckmodes' : FieldType("Update Check Mode",
 128         r"^(Tags|RepoManifest|RepoManifest/.+|RepoTrunk|HTTP|Static|None)$", None,
 129         [ "Update Check Mode" ],
 130         [ ])
 131 }
 132
 133 # Check an app's metadata information for integrity errors
 134 def check_metadata(info):
 135     for k, t in valuetypes.iteritems():
 136         for field in t.fields:
 137             if field in info:
 138                 t.check(info[field], info['id'])
 139                 if k == 'Bool':
 140                     info[field] = info[field] == "Yes"
 141         for build in info['builds']:
 142             for attr in t.attrs:
 143                 if attr in build:
 144                     t.check(build[attr], info['id'])
 145                     if k == 'bool':
 146                         build[attr] = build[attr] == "yes"
 147                 elif k == 'bool':
 148                     build[attr] = False
 149
 150 # Formatter for descriptions. Create an instance, and call parseline() with
 151 # each line of the description source from the metadata. At the end, call
 152 # end() and then text_plain, text_wiki and text_html will contain the result.
 153 class DescriptionFormatter:
 154     stNONE = 0
 155     stPARA = 1
 156     stUL = 2
 157     stOL = 3
 158     bold = False
 159     ital = False
 160     state = stNONE
 161     text_plain = ''
 162     text_wiki = ''
 163     text_html = ''
 164     linkResolver = None
 165     def __init__(self, linkres):
 166         self.linkResolver = linkres
 167     def endcur(self, notstates=None):
 168         if notstates and self.state in notstates:
 169             return
 170         if self.state == self.stPARA:
 171             self.endpara()
 172         elif self.state == self.stUL:
 173             self.endul()
 174         elif self.state == self.stOL:
 175             self.endol()
 176     def endpara(self):
 177         self.text_plain += '\n'
 178         self.text_html += '</p>'
 179         self.state = self.stNONE
 180     def endul(self):
 181         self.text_html += '</ul>'
 182         self.state = self.stNONE
 183     def endol(self):
 184         self.text_html += '</ol>'
 185         self.state = self.stNONE
 186
 187     def formatted(self, txt, html):
 188         formatted = ''
 189         if html:
 190             txt = cgi.escape(txt)
 191         while True:
 192             index = txt.find("''")
 193             if index == -1:
 194                 return formatted + txt
 195             formatted += txt[:index]
 196             txt = txt[index:]
 197             if txt.startswith("'''"):
 198                 if html:
 199                     if self.bold:
 200                         formatted += '</b>'
 201                     else:
 202                         formatted += '<b>'
 203                 self.bold = not self.bold
 204                 txt = txt[3:]
 205             else:
 206                 if html:
 207                     if self.ital:
 208                         formatted += '</i>'
 209                     else:
 210                         formatted += '<i>'
 211                 self.ital = not self.ital
 212                 txt = txt[2:]
 213
 214
 215     def linkify(self, txt):
 216         linkified_plain = ''
 217         linkified_html = ''
 218         while True:
 219             index = txt.find("[")
 220             if index == -1:
 221                 return (linkified_plain + self.formatted(txt, False), linkified_html + self.formatted(txt, True))
 222             linkified_plain += self.formatted(txt[:index], False)
 223             linkified_html += self.formatted(txt[:index], True)
 224             txt = txt[index:]
 225             if txt.startswith("[["):
 226                 index = txt.find("]]")
 227                 if index == -1:
 228                     raise MetaDataException("Unterminated ]]")
 229                 url = txt[2:index]
 230                 if self.linkResolver:
 231                     url, urltext = self.linkResolver(url)
 232                 else:
 233                     urltext = url
 234                 linkified_html += '<a href="' + url + '">' + cgi.escape(urltext) + '</a>'
 235                 linkified_plain += urltext
 236                 txt = txt[index+2:]
 237             else:
 238                 index = txt.find("]")
 239                 if index == -1:
 240                     raise MetaDataException("Unterminated ]")
 241                 url = txt[1:index]
 242                 index2 = url.find(' ')
 243                 if index2 == -1:
 244                     urltxt = url
 245                 else:
 246                     urltxt = url[index2 + 1:]
 247                     url = url[:index2]
 248                 linkified_html += '<a href="' + url + '">' + cgi.escape(urltxt) + '</a>'
 249                 linkified_plain += urltxt
 250                 if urltxt != url:
 251                     linkified_plain += ' (' + url + ')'
 252                 txt = txt[index+1:]
 253
 254     def addtext(self, txt):
 255         p, h = self.linkify(txt)
 256         self.text_plain += p
 257         self.text_html += h
 258
 259     def parseline(self, line):
 260         self.text_wiki += "%s\n" % line
 261         if not line:
 262             self.endcur()
 263         elif line.startswith('*'):
 264             self.endcur([self.stUL])
 265             if self.state != self.stUL:
 266                 self.text_html += '<ul>'
 267                 self.state = self.stUL
 268             self.text_html += '<li>'
 269             self.text_plain += '*'
 270             self.addtext(line[1:])
 271             self.text_html += '</li>'
 272         elif line.startswith('#'):
 273             self.endcur([self.stOL])
 274             if self.state != self.stOL:
 275                 self.text_html += '<ol>'
 276                 self.state = self.stOL
 277             self.text_html += '<li>'
 278             self.text_plain += '*' #TODO: lazy - put the numbers in!
 279             self.addtext(line[1:])
 280             self.text_html += '</li>'
 281         else:
 282             self.endcur([self.stPARA])
 283             if self.state == self.stNONE:
 284                 self.text_html += '<p>'
 285                 self.state = self.stPARA
 286             elif self.state == self.stPARA:
 287                 self.text_html += ' '
 288                 self.text_plain += ' '
 289             self.addtext(line)
 290
 291     def end(self):
 292         self.endcur()
 293
 294 # Parse multiple lines of description as written in a metadata file, returning
 295 # a single string in plain text format.
 296 def description_plain(lines, linkres):
 297     ps = DescriptionFormatter(linkres)
 298     for line in lines:
 299         ps.parseline(line)
 300     ps.end()
 301     return ps.text_plain
 302
 303 # Parse multiple lines of description as written in a metadata file, returning
 304 # a single string in wiki format. Used for the Maintainer Notes field as well,
 305 # because it's the same format.
 306 def description_wiki(lines):
 307     ps = DescriptionFormatter(None)
 308     for line in lines:
 309         ps.parseline(line)
 310     ps.end()
 311     return ps.text_wiki
 312
 313 # Parse multiple lines of description as written in a metadata file, returning
 314 # a single string in HTML format.
 315 def description_html(lines,linkres):
 316     ps = DescriptionFormatter(linkres)
 317     for line in lines:
 318         ps.parseline(line)
 319     ps.end()
 320     return ps.text_html
 321
 322 def parse_srclib(metafile, **kw):
 323
 324     thisinfo = {}
 325     if metafile and not isinstance(metafile, file):
 326         metafile = open(metafile, "r")
 327
 328     # Defaults for fields that come from metadata
 329     thisinfo['Repo Type'] = ''
 330     thisinfo['Repo'] = ''
 331     thisinfo['Subdir'] = None
 332     thisinfo['Prepare'] = None
 333     thisinfo['Srclibs'] = None
 334     thisinfo['Update Project'] = None
 335
 336     if metafile is None:
 337         return thisinfo
 338
 339     for line in metafile:
 340         line = line.rstrip('\r\n')
 341         if not line or line.startswith("#"):
 342             continue
 343
 344         try:
 345             field, value = line.split(':',1)
 346         except ValueError:
 347             raise MetaDataException("Invalid metadata in " + metafile.name + " at: " + line)
 348
 349         if field == "Subdir":
 350             thisinfo[field] = value.split(',')
 351         else:
 352             thisinfo[field] = value
 353
 354     return thisinfo
 355
 356 # Read all metadata. Returns a list of 'app' objects (which are dictionaries as
 357 # returned by the parse_metadata function.
 358 def read_metadata(xref=True, package=None):
 359     apps = []
 360     for basedir in ('metadata', 'tmp'):
 361         if not os.path.exists(basedir):
 362             os.makedirs(basedir)
 363     for metafile in sorted(glob.glob(os.path.join('metadata', '*.txt'))):
 364         if package is None or metafile == os.path.join('metadata', package + '.txt'):
 365             try:
 366                 appinfo = parse_metadata(metafile)
 367             except Exception, e:
 368                 raise MetaDataException("Problem reading metadata file %s: - %s" % (metafile, str(e)))
 369             check_metadata(appinfo)
 370             apps.append(appinfo)
 371
 372     if xref:
 373         # Parse all descriptions at load time, just to ensure cross-referencing
 374         # errors are caught early rather than when they hit the build server.
 375         def linkres(link):
 376             for app in apps:
 377                 if app['id'] == link:
 378                     return ("fdroid.app:" + link, "Dummy name - don't know yet")
 379             raise MetaDataException("Cannot resolve app id " + link)
 380         for app in apps:
 381             try:
 382                 description_html(app['Description'], linkres)
 383             except Exception, e:
 384                 raise MetaDataException("Problem with description of " + app['id'] +
 385                         " - " + str(e))
 386
 387     return apps
 388
 389 # Get the type expected for a given metadata field.
 390 def metafieldtype(name):
 391     if name in ['Description', 'Maintainer Notes']:
 392         return 'multiline'
 393     if name == 'Build Version':
 394         return 'build'
 395     if name == 'Build':
 396         return 'buildv2'
 397     if name == 'Use Built':
 398         return 'obsolete'
 399     return 'string'
 400
 401 # Parse metadata for a single application.
 402 #
 403 #  'metafile' - the filename to read. The package id for the application comes
 404 #               from this filename. Pass None to get a blank entry.
 405 #
 406 # Returns a dictionary containing all the details of the application. There are
 407 # two major kinds of information in the dictionary. Keys beginning with capital
 408 # letters correspond directory to identically named keys in the metadata file.
 409 # Keys beginning with lower case letters are generated in one way or another,
 410 # and are not found verbatim in the metadata.
 411 #
 412 # Known keys not originating from the metadata are:
 413 #
 414 #  'id'               - the application's package ID
 415 #  'builds'           - a list of dictionaries containing build information
 416 #                       for each defined build
 417 #  'comments'         - a list of comments from the metadata file. Each is
 418 #                       a tuple of the form (field, comment) where field is
 419 #                       the name of the field it preceded in the metadata
 420 #                       file. Where field is None, the comment goes at the
 421 #                       end of the file. Alternatively, 'build:version' is
 422 #                       for a comment before a particular build version.
 423 #  'descriptionlines' - original lines of description as formatted in the
 424 #                       metadata file.
 425 #
 426 def parse_metadata(metafile):
 427
 428     def parse_buildline(lines):
 429         value = "".join(lines)
 430         parts = [p.replace("\\,", ",")
 431                  for p in re.split(r"(?<!\\),", value)]
 432         if len(parts) < 3:
 433             raise MetaDataException("Invalid build format: " + value + " in " + metafile.name)
 434         thisbuild = {}
 435         thisbuild['origlines'] = lines
 436         thisbuild['version'] = parts[0]
 437         thisbuild['vercode'] = parts[1]
 438         if parts[2].startswith('!'):
 439             # For backwards compatibility, handle old-style disabling,
 440             # including attempting to extract the commit from the message
 441             thisbuild['disable'] = parts[2][1:]
 442             commit = 'unknown - see disabled'
 443             index = parts[2].rfind('at ')
 444             if index != -1:
 445                 commit = parts[2][index+3:]
 446                 if commit.endswith(')'):
 447                     commit = commit[:-1]
 448             thisbuild['commit'] = commit
 449         else:
 450             thisbuild['commit'] = parts[2]
 451         for p in parts[3:]:
 452             pk, pv = p.split('=', 1)
 453             thisbuild[pk.strip()] = pv
 454
 455         return thisbuild
 456
 457     def add_comments(key):
 458         if not curcomments:
 459             return
 460         for comment in curcomments:
 461             thisinfo['comments'].append((key, comment))
 462         del curcomments[:]
 463
 464
 465     thisinfo = {}
 466     if metafile:
 467         if not isinstance(metafile, file):
 468             metafile = open(metafile, "r")
 469         thisinfo['id'] = metafile.name[9:-4]
 470     else:
 471         thisinfo['id'] = None
 472
 473     # Defaults for fields that come from metadata...
 474     thisinfo['Name'] = None
 475     thisinfo['Provides'] = None
 476     thisinfo['Auto Name'] = ''
 477     thisinfo['Categories'] = 'None'
 478     thisinfo['Description'] = []
 479     thisinfo['Summary'] = ''
 480     thisinfo['License'] = 'Unknown'
 481     thisinfo['Web Site'] = ''
 482     thisinfo['Source Code'] = ''
 483     thisinfo['Issue Tracker'] = ''
 484     thisinfo['Donate'] = None
 485     thisinfo['FlattrID'] = None
 486     thisinfo['Bitcoin'] = None
 487     thisinfo['Litecoin'] = None
 488     thisinfo['Disabled'] = None
 489     thisinfo['AntiFeatures'] = None
 490     thisinfo['Archive Policy'] = None
 491     thisinfo['Update Check Mode'] = 'None'
 492     thisinfo['Vercode Operation'] = None
 493     thisinfo['Auto Update Mode'] = 'None'
 494     thisinfo['Current Version'] = ''
 495     thisinfo['Current Version Code'] = '0'
 496     thisinfo['Repo Type'] = ''
 497     thisinfo['Repo'] = ''
 498     thisinfo['Requires Root'] = False
 499     thisinfo['No Source Since'] = ''
 500
 501     # General defaults...
 502     thisinfo['builds'] = []
 503     thisinfo['comments'] = []
 504
 505     if metafile is None:
 506         return thisinfo
 507
 508     mode = 0
 509     buildlines = []
 510     curcomments = []
 511     curbuild = None
 512
 513     for line in metafile:
 514         line = line.rstrip('\r\n')
 515         if mode == 3:
 516             if not any(line.startswith(s) for s in (' ', '\t')):
 517                 if 'commit' not in curbuild and 'disable' not in curbuild:
 518                     raise MetaDataException("No commit specified for {0} in {1}".format(
 519                         curbuild['version'], metafile.name))
 520                 thisinfo['builds'].append(curbuild)
 521                 add_comments('build:' + curbuild['version'])
 522                 mode = 0
 523             else:
 524                 if line.endswith('\\'):
 525                     buildlines.append(line[:-1].lstrip())
 526                 else:
 527                     buildlines.append(line.lstrip())
 528                     bl = ''.join(buildlines)
 529                     bv = bl.split('=', 1)
 530                     if len(bv) != 2:
 531                         raise MetaDataException("Invalid build flag at {0} in {1}".
 532                                 format(buildlines[0], metafile.name))
 533                     name, val = bv
 534                     if name in curbuild:
 535                         raise MetaDataException("Duplicate definition on {0} in version {1} of {2}".
 536                                 format(name, curbuild['version'], metafile.name))
 537                     curbuild[name] = val.lstrip()
 538                     buildlines = []
 539
 540         if mode == 0:
 541             if not line:
 542                 continue
 543             if line.startswith("#"):
 544                 curcomments.append(line)
 545                 continue
 546             try:
 547                 field, value = line.split(':',1)
 548             except ValueError:
 549                 raise MetaDataException("Invalid metadata in " + metafile.name + " at: " + line)
 550
 551             # Translate obsolete fields...
 552             if field == 'Market Version':
 553                 field = 'Current Version'
 554             if field == 'Market Version Code':
 555                 field = 'Current Version Code'
 556
 557             fieldtype = metafieldtype(field)
 558             if fieldtype not in ['build', 'buildv2']:
 559                 add_comments(field)
 560             if fieldtype == 'multiline':
 561                 mode = 1
 562                 thisinfo[field] = []
 563                 if value:
 564                     raise MetaDataException("Unexpected text on same line as " + field + " in " + metafile.name)
 565             elif fieldtype == 'string':
 566                 if field == 'Category' and thisinfo['Categories'] == 'None':
 567                     thisinfo['Categories'] = value.replace(';',',')
 568                 thisinfo[field] = value
 569             elif fieldtype == 'build':
 570                 if value.endswith("\\"):
 571                     mode = 2
 572                     buildlines = [value[:-1]]
 573                 else:
 574                     thisinfo['builds'].append(parse_buildline([value]))
 575                     add_comments('build:' + thisinfo['builds'][-1]['version'])
 576             elif fieldtype == 'buildv2':
 577                 curbuild = {}
 578                 vv = value.split(',')
 579                 if len(vv) != 2:
 580                     raise MetaDataException('Build should have comma-separated version and vercode, not "{0}", in {1}'.
 581                         format(value, metafile.name))
 582                 curbuild['version'] = vv[0]
 583                 curbuild['vercode'] = vv[1]
 584                 buildlines = []
 585                 mode = 3
 586             elif fieldtype == 'obsolete':
 587                 pass        # Just throw it away!
 588             else:
 589                 raise MetaDataException("Unrecognised field type for " + field + " in " + metafile.name)
 590         elif mode == 1:     # Multiline field
 591             if line == '.':
 592                 mode = 0
 593             else:
 594                 thisinfo[field].append(line)
 595         elif mode == 2:     # Line continuation mode in Build Version
 596             if line.endswith("\\"):
 597                 buildlines.append(line[:-1])
 598             else:
 599                 buildlines.append(line)
 600                 thisinfo['builds'].append(
 601                     parse_buildline(buildlines))
 602                 add_comments('build:' + thisinfo['builds'][-1]['version'])
 603                 mode = 0
 604     add_comments(None)
 605
 606     # Mode at end of file should always be 0...
 607     if mode == 1:
 608         raise MetaDataException(field + " not terminated in " + metafile.name)
 609     elif mode == 2:
 610         raise MetaDataException("Unterminated continuation in " + metafile.name)
 611     elif mode == 3:
 612         raise MetaDataException("Unterminated build in " + metafile.name)
 613
 614     if not thisinfo['Description']:
 615         thisinfo['Description'].append('No description available')
 616
 617     return thisinfo
 618
 619 # Write a metadata file.
 620 #
 621 # 'dest'    - The path to the output file
 622 # 'app'     - The app data
 623 def write_metadata(dest, app):
 624
 625     def writecomments(key):
 626         written = 0
 627         for pf, comment in app['comments']:
 628             if pf == key:
 629                 mf.write("%s\n" % comment)
 630                 written += 1
 631         #if options.verbose and written > 0:
 632             #print "...writing comments for " + (key if key else 'EOF')
 633
 634     def writefield(field, value=None):
 635         writecomments(field)
 636         if value is None:
 637             value = app[field]
 638         mf.write("%s:%s\n" % (field, value))
 639
 640     mf = open(dest, 'w')
 641     if app['Disabled']:
 642         writefield('Disabled')
 643     if app['AntiFeatures']:
 644         writefield('AntiFeatures')
 645     if app['Provides']:
 646         writefield('Provides')
 647     writefield('Categories')
 648     writefield('License')
 649     writefield('Web Site')
 650     writefield('Source Code')
 651     writefield('Issue Tracker')
 652     if app['Donate']:
 653         writefield('Donate')
 654     if app['FlattrID']:
 655         writefield('FlattrID')
 656     if app['Bitcoin']:
 657         writefield('Bitcoin')
 658     if app['Litecoin']:
 659         writefield('Litecoin')
 660     mf.write('\n')
 661     if app['Name']:
 662         writefield('Name')
 663     if app['Auto Name']:
 664         writefield('Auto Name')
 665     writefield('Summary')
 666     writefield('Description', '')
 667     for line in app['Description']:
 668         mf.write("%s\n" % line)
 669     mf.write('.\n')
 670     mf.write('\n')
 671     if app['Requires Root']:
 672         writefield('Requires Root', 'Yes')
 673         mf.write('\n')
 674     if app['Repo Type']:
 675         writefield('Repo Type')
 676         writefield('Repo')
 677         mf.write('\n')
 678     for build in app['builds']:
 679         writecomments('build:' + build['version'])
 680         mf.write("Build:%s,%s\n" % ( build['version'], build['vercode']))
 681
 682         # This defines the preferred order for the build items - as in the
 683         # manual, they're roughly in order of application.
 684         keyorder = ['disable', 'commit', 'subdir', 'submodules', 'init',
 685                     'gradle', 'maven', 'oldsdkloc', 'target', 'compilesdk',
 686                     'update', 'encoding', 'forceversion', 'forcevercode', 'rm',
 687                     'fixtrans', 'fixapos', 'extlibs', 'srclibs', 'patch',
 688                     'prebuild', 'scanignore', 'scandelete', 'build', 'buildjni',
 689                     'preassemble', 'bindir', 'antcommand', 'novcheck']
 690
 691         def write_builditem(key, value):
 692             if key in ['version', 'vercode', 'origlines']:
 693                 return
 694             if key in valuetypes['bool'].attrs:
 695                 if not value:
 696                     return
 697                 value = 'yes'
 698             #if options.verbose:
 699                 #print "...writing {0} : {1}".format(key, value)
 700             outline = '    %s=' % key
 701             outline += '&& \\\n        '.join([s.lstrip() for s in value.split('&& ')])
 702             outline += '\n'
 703             mf.write(outline)
 704
 705         for key in keyorder:
 706             if key in build:
 707                 write_builditem(key, build[key])
 708         for key, value in build.iteritems():
 709             if not key in keyorder:
 710                 write_builditem(key, value)
 711         mf.write('\n')
 712
 713     if 'Maintainer Notes' in app:
 714         writefield('Maintainer Notes', '')
 715         for line in app['Maintainer Notes']:
 716             mf.write("%s\n" % line)
 717         mf.write('.\n')
 718         mf.write('\n')
 719
 720
 721     if app['Archive Policy']:
 722         writefield('Archive Policy')
 723     writefield('Auto Update Mode')
 724     writefield('Update Check Mode')
 725     if app['Vercode Operation']:
 726         writefield('Vercode Operation')
 727     if 'Update Check Data' in app:
 728         writefield('Update Check Data')
 729     if app['Current Version']:
 730         writefield('Current Version')
 731         writefield('Current Version Code')
 732     mf.write('\n')
 733     if app['No Source Since']:
 734         writefield('No Source Since')
 735         mf.write('\n')
 736     writecomments(None)
 737     mf.close()
 738
 739