fdroidserver/lint.py

   1 #!/usr/bin/env python2
   2 # -*- coding: utf-8 -*-
   3 #
   4 # lint.py - part of the FDroid server tool
   5 # Copyright (C) 2013-2014 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 th
  15 # GNU Affero General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Affero General Public Licen
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 from argparse import ArgumentParser
  21 import re
  22 import sys
  23 from sets import Set
  24
  25 import common
  26 import metadata
  27 import rewritemeta
  28
  29 config = None
  30 options = None
  31
  32
  33 def enforce_https(domain):
  34     return (re.compile(r'.*[^sS]://[^/]*' + re.escape(domain) + r'(/.*)?'),
  35             domain + " URLs should always use https://")
  36
  37 https_enforcings = [
  38     enforce_https('github.com'),
  39     enforce_https('gitlab.com'),
  40     enforce_https('bitbucket.org'),
  41     enforce_https('apache.org'),
  42     enforce_https('google.com'),
  43     enforce_https('svn.code.sf.net'),
  44 ]
  45
  46
  47 def forbid_shortener(domain):
  48     return (re.compile(r'https?://[^/]*' + re.escape(domain) + r'/.*'),
  49             "URL shorteners should not be used")
  50
  51 http_url_shorteners = [
  52     forbid_shortener('goo.gl'),
  53     forbid_shortener('t.co'),
  54     forbid_shortener('ur1.ca'),
  55 ]
  56
  57 http_checks = https_enforcings + http_url_shorteners + [
  58     (re.compile(r'.*github\.com/[^/]+/[^/]+\.git'),
  59      "Appending .git is not necessary"),
  60     (re.compile(r'.*://[^/]*(github|gitlab|bitbucket|rawgit)[^/]*/([^/]+/){1,3}master'),
  61      "Use /HEAD instead of /master to point at a file in the default branch"),
  62 ]
  63
  64 regex_checks = {
  65     'Web Site': http_checks,
  66     'Source Code': http_checks,
  67     'Repo': https_enforcings,
  68     'Issue Tracker': http_checks + [
  69         (re.compile(r'.*github\.com/[^/]+/[^/]+[/]*$'),
  70          "/issues is missing"),
  71     ],
  72     'Donate': http_checks + [
  73         (re.compile(r'.*flattr\.com'),
  74          "Flattr donation methods belong in the FlattrID flag"),
  75     ],
  76     'Changelog': http_checks,
  77     'Author Name': [
  78         (re.compile(r'^\s'),
  79          "Unnecessary leading space"),
  80     ],
  81     'License': [
  82         (re.compile(r'^(|None|Unknown)$'),
  83          "No license specified"),
  84     ],
  85     'Summary': [
  86         (re.compile(r'^$'),
  87          "Summary yet to be filled"),
  88         (re.compile(r'.*\b(free software|open source)\b.*', re.IGNORECASE),
  89          "No need to specify that the app is Free Software"),
  90         (re.compile(r'.*((your|for).*android|android.*(app|device|client|port|version))', re.IGNORECASE),
  91          "No need to specify that the app is for Android"),
  92         (re.compile(r'.*[a-z0-9][.!?]( |$)'),
  93          "Punctuation should be avoided"),
  94         (re.compile(r'^\s'),
  95          "Unnecessary leading space"),
  96         (re.compile(r'.*\s$'),
  97          "Unnecessary trailing space"),
  98     ],
  99     'Description': [
 100         (re.compile(r'^No description available$'),
 101          "Description yet to be filled"),
 102         (re.compile(r'\s*[*#][^ .]'),
 103          "Invalid bulleted list"),
 104         (re.compile(r'^\s'),
 105          "Unnecessary leading space"),
 106         (re.compile(r'.*\s$'),
 107          "Unnecessary trailing space"),
 108         (re.compile(r'.*([^[]|^)\[[^:[\]]+( |\]|$)'),
 109          "Invalid link - use [http://foo.bar Link title] or [http://foo.bar]"),
 110         (re.compile(r'(^|.* )https?://[^ ]+'),
 111          "Unlinkified link - use [http://foo.bar Link title] or [http://foo.bar]"),
 112     ],
 113 }
 114
 115
 116 def check_regexes(app):
 117     for f, checks in regex_checks.iteritems():
 118         for m, r in checks:
 119             v = app.get_field(f)
 120             t = metadata.fieldtype(f)
 121             if t == metadata.TYPE_MULTILINE:
 122                 for l in v.splitlines():
 123                     if m.match(l):
 124                         yield "%s at line '%s': %s" % (f, l, r)
 125             else:
 126                 if v is None:
 127                     continue
 128                 if m.match(v):
 129                     yield "%s '%s': %s" % (f, v, r)
 130
 131
 132 def get_lastbuild(builds):
 133     lowest_vercode = -1
 134     lastbuild = None
 135     for build in builds:
 136         if not build.disable:
 137             vercode = int(build.vercode)
 138             if lowest_vercode == -1 or vercode < lowest_vercode:
 139                 lowest_vercode = vercode
 140         if not lastbuild or int(build.vercode) > int(lastbuild.vercode):
 141             lastbuild = build
 142     return lastbuild
 143
 144
 145 def check_ucm_tags(app):
 146     lastbuild = get_lastbuild(app.builds)
 147     if (lastbuild is not None
 148             and lastbuild.commit
 149             and app.UpdateCheckMode == 'RepoManifest'
 150             and not lastbuild.commit.startswith('unknown')
 151             and lastbuild.vercode == app.CurrentVersionCode
 152             and not lastbuild.forcevercode
 153             and any(s in lastbuild.commit for s in '.,_-/')):
 154         yield "Last used commit '%s' looks like a tag, but Update Check Mode is '%s'" % (
 155             lastbuild.commit, app.UpdateCheckMode)
 156
 157
 158 def check_char_limits(app):
 159     limits = config['char_limits']
 160
 161     if len(app.Summary) > limits['Summary']:
 162         yield "Summary of length %s is over the %i char limit" % (
 163             len(app.Summary), limits['Summary'])
 164
 165     if len(app.Description) > limits['Description']:
 166         yield "Description of length %s is over the %i char limit" % (
 167             len(app.Description), limits['Description'])
 168
 169
 170 def check_old_links(app):
 171     usual_sites = [
 172         'github.com',
 173         'gitlab.com',
 174         'bitbucket.org',
 175     ]
 176     old_sites = [
 177         'gitorious.org',
 178         'code.google.com',
 179     ]
 180     if any(s in app.Repo for s in usual_sites):
 181         for f in ['Web Site', 'Source Code', 'Issue Tracker', 'Changelog']:
 182             v = app.get_field(f)
 183             if any(s in v for s in old_sites):
 184                 yield "App is in '%s' but has a link to '%s'" % (app.Repo, v)
 185
 186
 187 def check_useless_fields(app):
 188     if app.UpdateCheckName == app.id:
 189         yield "Update Check Name is set to the known app id - it can be removed"
 190
 191 filling_ucms = re.compile(r'^(Tags.*|RepoManifest.*)')
 192
 193
 194 def check_checkupdates_ran(app):
 195     if filling_ucms.match(app.UpdateCheckMode):
 196         if not app.AutoName and not app.CurrentVersion and app.CurrentVersionCode == '0':
 197             yield "UCM is set but it looks like checkupdates hasn't been run yet"
 198
 199
 200 def check_empty_fields(app):
 201     if not app.Categories:
 202         yield "Categories are not set"
 203
 204 all_categories = Set([
 205     "Connectivity",
 206     "Development",
 207     "Games",
 208     "Graphics",
 209     "Internet",
 210     "Money",
 211     "Multimedia",
 212     "Navigation",
 213     "Phone & SMS",
 214     "Reading",
 215     "Science & Education",
 216     "Security",
 217     "Sports & Health",
 218     "System",
 219     "Theming",
 220     "Time",
 221     "Writing",
 222 ])
 223
 224
 225 def check_categories(app):
 226     for categ in app.Categories:
 227         if categ not in all_categories:
 228             yield "Category '%s' is not valid" % categ
 229
 230
 231 def check_duplicates(app):
 232     if app.Name and app.Name == app.AutoName:
 233         yield "Name '%s' is just the auto name - remove it" % app.Name
 234
 235     links_seen = set()
 236     for f in ['Source Code', 'Web Site', 'Issue Tracker', 'Changelog']:
 237         v = app.get_field(f)
 238         if not v:
 239             continue
 240         v = v.lower()
 241         if v in links_seen:
 242             yield "Duplicate link in '%s': %s" % (f, v)
 243         else:
 244             links_seen.add(v)
 245
 246     name = app.Name or app.AutoName
 247     if app.Summary and name:
 248         if app.Summary.lower() == name.lower():
 249             yield "Summary '%s' is just the app's name" % app.Summary
 250
 251     if app.Summary and app.Description and len(app.Description) == 1:
 252         if app.Summary.lower() == app.Description[0].lower():
 253             yield "Description '%s' is just the app's summary" % app.Summary
 254
 255     seenlines = set()
 256     for l in app.Description.splitlines():
 257         if len(l) < 1:
 258             continue
 259         if l in seenlines:
 260             yield "Description has a duplicate line"
 261         seenlines.add(l)
 262
 263
 264 desc_url = re.compile(r'(^|[^[])\[([^ ]+)( |\]|$)')
 265
 266
 267 def check_mediawiki_links(app):
 268     wholedesc = ' '.join(app.Description)
 269     for um in desc_url.finditer(wholedesc):
 270         url = um.group(1)
 271         for m, r in http_checks:
 272             if m.match(url):
 273                 yield "URL '%s' in Description: %s" % (url, r)
 274
 275
 276 def check_bulleted_lists(app):
 277     validchars = ['*', '#']
 278     lchar = ''
 279     lcount = 0
 280     for l in app.Description.splitlines():
 281         if len(l) < 1:
 282             lcount = 0
 283             continue
 284
 285         if l[0] == lchar and l[1] == ' ':
 286             lcount += 1
 287             if lcount > 2 and lchar not in validchars:
 288                 yield "Description has a list (%s) but it isn't bulleted (*) nor numbered (#)" % lchar
 289                 break
 290         else:
 291             lchar = l[0]
 292             lcount = 1
 293
 294
 295 def check_builds(app):
 296     for build in app.builds:
 297         if build.disable:
 298             continue
 299         for s in ['master', 'origin', 'HEAD', 'default', 'trunk']:
 300             if build.commit and build.commit.startswith(s):
 301                 yield "Branch '%s' used as commit in build '%s'" % (s, build.version)
 302             for srclib in build.srclibs:
 303                 ref = srclib.split('@')[1].split('/')[0]
 304                 if ref.startswith(s):
 305                     yield "Branch '%s' used as commit in srclib '%s'" % (s, srclib)
 306         if build.target and build.method() == 'gradle':
 307             yield "target= has no gradle support"
 308
 309
 310 def main():
 311
 312     global config, options
 313
 314     anywarns = False
 315
 316     # Parse command line...
 317     parser = ArgumentParser(usage="%(prog)s [options] [APPID [APPID ...]]")
 318     common.setup_global_opts(parser)
 319     parser.add_argument("-f", "--format", action="store_true", default=False,
 320                         help="Also warn about formatting issues, like rewritemeta -l")
 321     parser.add_argument("appid", nargs='*', help="app-id in the form APPID")
 322     options = parser.parse_args()
 323
 324     config = common.read_config(options)
 325
 326     # Get all apps...
 327     allapps = metadata.read_metadata(xref=True)
 328     apps = common.read_app_args(options.appid, allapps, False)
 329
 330     for appid, app in apps.iteritems():
 331         if app.Disabled:
 332             continue
 333
 334         warns = []
 335
 336         for check_func in [
 337                 check_regexes,
 338                 check_ucm_tags,
 339                 check_char_limits,
 340                 check_old_links,
 341                 check_checkupdates_ran,
 342                 check_useless_fields,
 343                 check_empty_fields,
 344                 check_categories,
 345                 check_duplicates,
 346                 check_mediawiki_links,
 347                 check_bulleted_lists,
 348                 check_builds,
 349                 ]:
 350             warns += check_func(app)
 351
 352         if options.format:
 353             if not rewritemeta.proper_format(app):
 354                 warns.append("Run rewritemeta to fix formatting")
 355
 356         if warns:
 357             anywarns = True
 358             for warn in warns:
 359                 print("%s: %s" % (appid, warn))
 360
 361     if anywarns:
 362         sys.exit(1)
 363
 364
 365 if __name__ == "__main__":
 366     main()