3 # lint.py - part of the FDroid server tool
4 # Copyright (C) 2013-2014 Daniel Martà <mvdan@mvdan.cc>
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU Affero General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See th
14 # GNU Affero General Public License for more details.
16 # You should have received a copy of the GNU Affero General Public Licen
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19 from argparse import ArgumentParser
27 from . import metadata
28 from . import rewritemeta
34 def enforce_https(domain):
35 return (re.compile(r'.*[^sS]://[^/]*' + re.escape(domain) + r'(/.*)?'),
36 domain + " URLs should always use https://")
40 enforce_https('github.com'),
41 enforce_https('gitlab.com'),
42 enforce_https('bitbucket.org'),
43 enforce_https('apache.org'),
44 enforce_https('google.com'),
45 enforce_https('svn.code.sf.net'),
49 def forbid_shortener(domain):
50 return (re.compile(r'https?://[^/]*' + re.escape(domain) + r'/.*'),
51 _("URL shorteners should not be used"))
54 http_url_shorteners = [
55 forbid_shortener('goo.gl'),
56 forbid_shortener('t.co'),
57 forbid_shortener('ur1.ca'),
58 forbid_shortener('is.gd'),
59 forbid_shortener('bit.ly'),
60 forbid_shortener('tiny.cc'),
61 forbid_shortener('tinyurl.com'),
64 http_checks = https_enforcings + http_url_shorteners + [
65 (re.compile(r'.*github\.com/[^/]+/[^/]+\.git'),
66 _("Appending .git is not necessary")),
67 (re.compile(r'.*://[^/]*(github|gitlab|bitbucket|rawgit)[^/]*/([^/]+/){1,3}master'),
68 _("Use /HEAD instead of /master to point at a file in the default branch")),
72 'WebSite': http_checks,
73 'SourceCode': http_checks,
74 'Repo': https_enforcings,
75 'IssueTracker': http_checks + [
76 (re.compile(r'.*github\.com/[^/]+/[^/]+/*$'),
77 _("/issues is missing")),
78 (re.compile(r'.*gitlab\.com/[^/]+/[^/]+/*$'),
79 _("/issues is missing")),
81 'Donate': http_checks + [
82 (re.compile(r'.*flattr\.com'),
83 _("Flattr donation methods belong in the FlattrID flag")),
85 'Changelog': http_checks,
88 _("Unnecessary leading space")),
89 (re.compile(r'.*\s$'),
90 _("Unnecessary trailing space")),
93 (re.compile(r'.*\b(free software|open source)\b.*', re.IGNORECASE),
94 _("No need to specify that the app is Free Software")),
95 (re.compile(r'.*((your|for).*android|android.*(app|device|client|port|version))', re.IGNORECASE),
96 _("No need to specify that the app is for Android")),
97 (re.compile(r'.*[a-z0-9][.!?]( |$)'),
98 _("Punctuation should be avoided")),
100 _("Unnecessary leading space")),
101 (re.compile(r'.*\s$'),
102 _("Unnecessary trailing space")),
105 (re.compile(r'\s*[*#][^ .]'),
106 _("Invalid bulleted list")),
108 _("Unnecessary leading space")),
109 (re.compile(r'.*\s$'),
110 _("Unnecessary trailing space")),
111 (re.compile(r'.*([^[]|^)\[[^:[\]]+( |\]|$)'),
112 _("Invalid link - use [http://foo.bar Link title] or [http://foo.bar]")),
113 (re.compile(r'(^|.* )https?://[^ ]+'),
114 _("Unlinkified link - use [http://foo.bar Link title] or [http://foo.bar]")),
118 locale_pattern = re.compile(r'^[a-z]{2,3}(-[A-Z][A-Z])?$')
121 def check_regexes(app):
122 for f, checks in regex_checks.items():
125 t = metadata.fieldtype(f)
126 if t == metadata.TYPE_MULTILINE:
127 for l in v.splitlines():
129 yield "%s at line '%s': %s" % (f, l, r)
134 yield "%s '%s': %s" % (f, v, r)
137 def get_lastbuild(builds):
141 if not build.disable:
142 vercode = int(build.versionCode)
143 if lowest_vercode == -1 or vercode < lowest_vercode:
144 lowest_vercode = vercode
145 if not lastbuild or int(build.versionCode) > int(lastbuild.versionCode):
150 def check_ucm_tags(app):
151 lastbuild = get_lastbuild(app.builds)
152 if (lastbuild is not None
154 and app.UpdateCheckMode == 'RepoManifest'
155 and not lastbuild.commit.startswith('unknown')
156 and lastbuild.versionCode == app.CurrentVersionCode
157 and not lastbuild.forcevercode
158 and any(s in lastbuild.commit for s in '.,_-/')):
159 yield _("Last used commit '%s' looks like a tag, but Update Check Mode is '%s'") % (
160 lastbuild.commit, app.UpdateCheckMode)
163 def check_char_limits(app):
164 limits = config['char_limits']
166 if len(app.Summary) > limits['summary']:
167 yield _("Summary of length %s is over the %i char limit") % (
168 len(app.Summary), limits['summary'])
170 if len(app.Description) > limits['description']:
171 yield _("Description of length %s is over the %i char limit") % (
172 len(app.Description), limits['description'])
175 def check_old_links(app):
185 if any(s in app.Repo for s in usual_sites):
186 for f in ['WebSite', 'SourceCode', 'IssueTracker', 'Changelog']:
188 if any(s in v for s in old_sites):
189 yield _("App is in '%s' but has a link to '%s'") % (app.Repo, v)
192 def check_useless_fields(app):
193 if app.UpdateCheckName == app.id:
194 yield _("Update Check Name is set to the known app id - it can be removed")
197 filling_ucms = re.compile(r'^(Tags.*|RepoManifest.*)')
200 def check_checkupdates_ran(app):
201 if filling_ucms.match(app.UpdateCheckMode):
202 if not app.AutoName and not app.CurrentVersion and app.CurrentVersionCode == '0':
203 yield _("UCM is set but it looks like checkupdates hasn't been run yet")
206 def check_empty_fields(app):
207 if not app.Categories:
208 yield _("Categories are not set")
211 all_categories = set([
222 "Science & Education",
232 def check_categories(app):
233 for categ in app.Categories:
234 if categ not in all_categories:
235 yield _("Category '%s' is not valid" % categ)
238 def check_duplicates(app):
239 if app.Name and app.Name == app.AutoName:
240 yield _("Name '%s' is just the auto name - remove it") % app.Name
243 for f in ['Source Code', 'Web Site', 'Issue Tracker', 'Changelog']:
249 yield _("Duplicate link in '%s': %s") % (f, v)
253 name = app.Name or app.AutoName
254 if app.Summary and name:
255 if app.Summary.lower() == name.lower():
256 yield _("Summary '%s' is just the app's name") % app.Summary
258 if app.Summary and app.Description and len(app.Description) == 1:
259 if app.Summary.lower() == app.Description[0].lower():
260 yield _("Description '%s' is just the app's summary") % app.Summary
263 for l in app.Description.splitlines():
267 yield _("Description has a duplicate line")
271 desc_url = re.compile(r'(^|[^[])\[([^ ]+)( |\]|$)')
274 def check_mediawiki_links(app):
275 wholedesc = ' '.join(app.Description)
276 for um in desc_url.finditer(wholedesc):
278 for m, r in http_checks:
280 yield _("URL '%s' in Description: %s") % (url, r)
283 def check_bulleted_lists(app):
284 validchars = ['*', '#']
287 for l in app.Description.splitlines():
292 if l[0] == lchar and l[1] == ' ':
294 if lcount > 2 and lchar not in validchars:
295 yield _("Description has a list (%s) but it isn't bulleted (*) nor numbered (#)") % lchar
302 def check_builds(app):
303 supported_flags = set(metadata.build_flags)
304 # needed for YAML and JSON
305 for build in app.builds:
307 if build.disable.startswith('Generated by import.py'):
308 yield _("Build generated by `fdroid import` - remove disable line once ready")
310 for s in ['master', 'origin', 'HEAD', 'default', 'trunk']:
311 if build.commit and build.commit.startswith(s):
312 yield _("Branch '%s' used as commit in build '%s'") % (s, build.versionName)
313 for srclib in build.srclibs:
314 ref = srclib.split('@')[1].split('/')[0]
315 if ref.startswith(s):
316 yield _("Branch '%s' used as commit in srclib '%s'") % (s, srclib)
317 for key in build.keys():
318 if key not in supported_flags:
319 yield _('%s is not an accepted build field') % key
322 def check_files_dir(app):
323 dir_path = os.path.join('metadata', app.id)
324 if not os.path.isdir(dir_path):
327 for name in os.listdir(dir_path):
328 path = os.path.join(dir_path, name)
329 if not (os.path.isfile(path) or name == 'signatures' or locale_pattern.match(name)):
330 yield _("Found non-file at %s") % path
334 used = {'signatures', }
335 for build in app.builds:
336 for fname in build.patch:
337 if fname not in files:
338 yield _("Unknown file %s in build '%s'") % (fname, build.versionName)
342 for name in files.difference(used):
343 if locale_pattern.match(name):
345 yield _("Unused file at %s") % os.path.join(dir_path, name)
348 def check_format(app):
349 if options.format and not rewritemeta.proper_format(app):
350 yield _("Run rewritemeta to fix formatting")
353 def check_license_tag(app):
354 '''Ensure all license tags are in https://spdx.org/license-list'''
355 if app.License.rstrip('+') not in SPDX:
356 yield _('Invalid license tag "%s"! Use only tags from https://spdx.org/license-list') \
360 def check_extlib_dir(apps):
361 dir_path = os.path.join('build', 'extlib')
362 unused_extlib_files = set()
363 for root, dirs, files in os.walk(dir_path):
365 unused_extlib_files.add(os.path.join(root, name)[len(dir_path) + 1:])
369 for build in app.builds:
370 for path in build.extlibs:
371 if path not in unused_extlib_files:
372 yield _("%s: Unknown extlib %s in build '%s'") % (app.id, path, build.versionName)
376 for path in unused_extlib_files.difference(used):
377 if any(path.endswith(s) for s in [
379 'source.txt', 'origin.txt', 'md5.txt',
380 'LICENSE', 'LICENSE.txt',
381 'COPYING', 'COPYING.txt',
382 'NOTICE', 'NOTICE.txt',
385 yield _("Unused extlib at %s") % os.path.join(dir_path, path)
388 def check_for_unsupported_metadata_files(basedir=""):
389 """Checks whether any non-metadata files are in metadata/"""
394 formats = config['accepted_formats']
395 for f in glob.glob(basedir + 'metadata/*') + glob.glob(basedir + 'metadata/.*'):
399 exists = exists or os.path.exists(f + '.' + t)
401 print(_('"%s/" has no matching metadata file!') % f)
403 elif not os.path.splitext(f)[1][1:] in formats:
404 print('"' + f.replace(basedir, '')
405 + '" is not a supported file format: (' + ','.join(formats) + ')')
413 global config, options
415 # Parse command line...
416 parser = ArgumentParser(usage="%(prog)s [options] [APPID [APPID ...]]")
417 common.setup_global_opts(parser)
418 parser.add_argument("-f", "--format", action="store_true", default=False,
419 help=_("Also warn about formatting issues, like rewritemeta -l"))
420 parser.add_argument("appid", nargs='*', help=_("applicationId in the form APPID"))
421 metadata.add_metadata_arguments(parser)
422 options = parser.parse_args()
423 metadata.warnings_action = options.W
425 config = common.read_config(options)
428 allapps = metadata.read_metadata(xref=True)
429 apps = common.read_app_args(options.appid, allapps, False)
431 anywarns = check_for_unsupported_metadata_files()
433 apps_check_funcs = []
434 if len(options.appid) == 0:
435 # otherwise it finds tons of unused extlibs
436 apps_check_funcs.append(check_extlib_dir)
437 for check_func in apps_check_funcs:
438 for warn in check_func(apps.values()):
442 for appid, app in apps.items():
451 check_checkupdates_ran,
452 check_useless_fields,
456 check_mediawiki_links,
457 check_bulleted_lists,
464 for check_func in app_check_funcs:
465 for warn in check_func(app):
467 print("%s: %s" % (appid, warn))
473 # A compiled, public domain list of official SPDX license tags from:
474 # https://github.com/sindresorhus/spdx-license-list/blob/v3.0.1/spdx-simple.json
475 # The deprecated license tags have been removed from the list, they are at the
476 # bottom, starting after the last license tags that start with Z.
477 # This is at the bottom, since its a long list of data
479 "PublicDomain", # an F-Droid addition, until we can enforce a better option
519 "BSD-2-Clause-FreeBSD",
520 "BSD-2-Clause-NetBSD",
522 "BSD-3-Clause-Clear",
523 "BSD-3-Clause-No-Nuclear-License",
524 "BSD-3-Clause-No-Nuclear-License-2014",
525 "BSD-3-Clause-No-Nuclear-Warranty",
529 "BSD-3-Clause-Attribution",
545 "CNRI-Python-GPL-Compatible",
679 "MPL-2.0-no-copyleft-exception",
803 "zlib-acknowledgement",
809 if __name__ == "__main__":