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