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('git.code.sf.net'),
46 enforce_https('svn.code.sf.net'),
47 enforce_https('anongit.kde.org'),
48 enforce_https('savannah.nongnu.org'),
49 enforce_https('git.savannah.nongnu.org'),
50 enforce_https('download.savannah.nongnu.org'),
51 enforce_https('savannah.gnu.org'),
52 enforce_https('git.savannah.gnu.org'),
53 enforce_https('download.savannah.gnu.org'),
57 def forbid_shortener(domain):
58 return (re.compile(r'https?://[^/]*' + re.escape(domain) + r'/.*'),
59 _("URL shorteners should not be used"))
62 http_url_shorteners = [
63 forbid_shortener('goo.gl'),
64 forbid_shortener('t.co'),
65 forbid_shortener('ur1.ca'),
66 forbid_shortener('is.gd'),
67 forbid_shortener('bit.ly'),
68 forbid_shortener('tiny.cc'),
69 forbid_shortener('tinyurl.com'),
72 http_checks = https_enforcings + http_url_shorteners + [
73 (re.compile(r'.*github\.com/[^/]+/[^/]+\.git'),
74 _("Appending .git is not necessary")),
75 (re.compile(r'.*://[^/]*(github|gitlab|bitbucket|rawgit)[^/]*/([^/]+/){1,3}master'),
76 _("Use /HEAD instead of /master to point at a file in the default branch")),
80 'WebSite': http_checks,
81 'SourceCode': http_checks,
82 'Repo': https_enforcings,
83 'IssueTracker': http_checks + [
84 (re.compile(r'.*github\.com/[^/]+/[^/]+/*$'),
85 _("/issues is missing")),
86 (re.compile(r'.*gitlab\.com/[^/]+/[^/]+/*$'),
87 _("/issues is missing")),
89 'Donate': http_checks + [
90 (re.compile(r'.*flattr\.com'),
91 _("Flattr donation methods belong in the FlattrID flag")),
93 'Changelog': http_checks,
96 _("Unnecessary leading space")),
97 (re.compile(r'.*\s$'),
98 _("Unnecessary trailing space")),
101 (re.compile(r'.*\b(free software|open source)\b.*', re.IGNORECASE),
102 _("No need to specify that the app is Free Software")),
103 (re.compile(r'.*((your|for).*android|android.*(app|device|client|port|version))', re.IGNORECASE),
104 _("No need to specify that the app is for Android")),
105 (re.compile(r'.*[a-z0-9][.!?]( |$)'),
106 _("Punctuation should be avoided")),
108 _("Unnecessary leading space")),
109 (re.compile(r'.*\s$'),
110 _("Unnecessary trailing space")),
113 (re.compile(r'\s*[*#][^ .]'),
114 _("Invalid bulleted list")),
116 _("Unnecessary leading space")),
117 (re.compile(r'.*\s$'),
118 _("Unnecessary trailing space")),
119 (re.compile(r'.*([^[]|^)\[[^:[\]]+( |\]|$)'),
120 _("Invalid link - use [http://foo.bar Link title] or [http://foo.bar]")),
121 (re.compile(r'(^|.* )https?://[^ ]+'),
122 _("Unlinkified link - use [http://foo.bar Link title] or [http://foo.bar]")),
126 locale_pattern = re.compile(r'^[a-z]{2,3}(-[A-Z][A-Z])?$')
129 def check_regexes(app):
130 for f, checks in regex_checks.items():
133 t = metadata.fieldtype(f)
134 if t == metadata.TYPE_MULTILINE:
135 for l in v.splitlines():
137 yield "%s at line '%s': %s" % (f, l, r)
142 yield "%s '%s': %s" % (f, v, r)
145 def get_lastbuild(builds):
149 if not build.disable:
150 vercode = int(build.versionCode)
151 if lowest_vercode == -1 or vercode < lowest_vercode:
152 lowest_vercode = vercode
153 if not lastbuild or int(build.versionCode) > int(lastbuild.versionCode):
158 def check_ucm_tags(app):
159 lastbuild = get_lastbuild(app.builds)
160 if (lastbuild is not None
162 and app.UpdateCheckMode == 'RepoManifest'
163 and not lastbuild.commit.startswith('unknown')
164 and lastbuild.versionCode == app.CurrentVersionCode
165 and not lastbuild.forcevercode
166 and any(s in lastbuild.commit for s in '.,_-/')):
167 yield _("Last used commit '{commit}' looks like a tag, but Update Check Mode is '{ucm}'")\
168 .format(commit=lastbuild.commit, ucm=app.UpdateCheckMode)
171 def check_char_limits(app):
172 limits = config['char_limits']
174 if len(app.Summary) > limits['summary']:
175 yield _("Summary of length {length} is over the {limit} char limit")\
176 .format(length=len(app.Summary), limit=limits['summary'])
178 if len(app.Description) > limits['description']:
179 yield _("Description of length {length} is over the {limit} char limit")\
180 .format(length=len(app.Description), limit=limits['description'])
183 def check_old_links(app):
193 if any(s in app.Repo for s in usual_sites):
194 for f in ['WebSite', 'SourceCode', 'IssueTracker', 'Changelog']:
196 if any(s in v for s in old_sites):
197 yield _("App is in '{repo}' but has a link to {url}")\
198 .format(repo=app.Repo, url=v)
201 def check_useless_fields(app):
202 if app.UpdateCheckName == app.id:
203 yield _("Update Check Name is set to the known app id - it can be removed")
206 filling_ucms = re.compile(r'^(Tags.*|RepoManifest.*)')
209 def check_checkupdates_ran(app):
210 if filling_ucms.match(app.UpdateCheckMode):
211 if not app.AutoName and not app.CurrentVersion and app.CurrentVersionCode == '0':
212 yield _("UCM is set but it looks like checkupdates hasn't been run yet")
215 def check_empty_fields(app):
216 if not app.Categories:
217 yield _("Categories are not set")
220 all_categories = set([
231 "Science & Education",
241 def check_categories(app):
242 for categ in app.Categories:
243 if categ not in all_categories:
244 yield _("Category '%s' is not valid" % categ)
247 def check_duplicates(app):
248 if app.Name and app.Name == app.AutoName:
249 yield _("Name '%s' is just the auto name - remove it") % app.Name
252 for f in ['Source Code', 'Web Site', 'Issue Tracker', 'Changelog']:
258 yield _("Duplicate link in '{field}': {url}").format(field=f, url=v)
262 name = app.Name or app.AutoName
263 if app.Summary and name:
264 if app.Summary.lower() == name.lower():
265 yield _("Summary '%s' is just the app's name") % app.Summary
267 if app.Summary and app.Description and len(app.Description) == 1:
268 if app.Summary.lower() == app.Description[0].lower():
269 yield _("Description '%s' is just the app's summary") % app.Summary
272 for l in app.Description.splitlines():
276 yield _("Description has a duplicate line")
280 desc_url = re.compile(r'(^|[^[])\[([^ ]+)( |\]|$)')
283 def check_mediawiki_links(app):
284 wholedesc = ' '.join(app.Description)
285 for um in desc_url.finditer(wholedesc):
287 for m, r in http_checks:
289 yield _("URL {url} in Description: {error}").format(url=url, error=r)
292 def check_bulleted_lists(app):
293 validchars = ['*', '#']
296 for l in app.Description.splitlines():
301 if l[0] == lchar and l[1] == ' ':
303 if lcount > 2 and lchar not in validchars:
304 yield _("Description has a list (%s) but it isn't bulleted (*) nor numbered (#)") % lchar
311 def check_builds(app):
312 supported_flags = set(metadata.build_flags)
313 # needed for YAML and JSON
314 for build in app.builds:
316 if build.disable.startswith('Generated by import.py'):
317 yield _("Build generated by `fdroid import` - remove disable line once ready")
319 for s in ['master', 'origin', 'HEAD', 'default', 'trunk']:
320 if build.commit and build.commit.startswith(s):
321 yield _("Branch '{branch}' used as commit in build '{versionName}'")\
322 .format(branch=s, versionName=build.versionName)
323 for srclib in build.srclibs:
324 ref = srclib.split('@')[1].split('/')[0]
325 if ref.startswith(s):
326 yield _("Branch '{branch}' used as commit in srclib '{srclib}'")\
327 .format(branch=s, srclib=srclib)
328 for key in build.keys():
329 if key not in supported_flags:
330 yield _('%s is not an accepted build field') % key
333 def check_files_dir(app):
334 dir_path = os.path.join('metadata', app.id)
335 if not os.path.isdir(dir_path):
338 for name in os.listdir(dir_path):
339 path = os.path.join(dir_path, name)
340 if not (os.path.isfile(path) or name == 'signatures' or locale_pattern.match(name)):
341 yield _("Found non-file at %s") % path
345 used = {'signatures', }
346 for build in app.builds:
347 for fname in build.patch:
348 if fname not in files:
349 yield _("Unknown file '{filename}' in build '{versionName}'")\
350 .format(filename=fname, versionName=build.versionName)
354 for name in files.difference(used):
355 if locale_pattern.match(name):
357 yield _("Unused file at %s") % os.path.join(dir_path, name)
360 def check_format(app):
361 if options.format and not rewritemeta.proper_format(app):
362 yield _("Run rewritemeta to fix formatting")
365 def check_license_tag(app):
366 '''Ensure all license tags are in https://spdx.org/license-list'''
367 if app.License.rstrip('+') not in SPDX:
368 yield _('Invalid license tag "%s"! Use only tags from https://spdx.org/license-list') \
372 def check_extlib_dir(apps):
373 dir_path = os.path.join('build', 'extlib')
374 unused_extlib_files = set()
375 for root, dirs, files in os.walk(dir_path):
377 unused_extlib_files.add(os.path.join(root, name)[len(dir_path) + 1:])
381 for build in app.builds:
382 for path in build.extlibs:
383 if path not in unused_extlib_files:
384 yield _("{appid}: Unknown extlib {path} in build '{versionName}'")\
385 .format(appid=app.id, path=path, versionName=build.versionName)
389 for path in unused_extlib_files.difference(used):
390 if any(path.endswith(s) for s in [
392 'source.txt', 'origin.txt', 'md5.txt',
393 'LICENSE', 'LICENSE.txt',
394 'COPYING', 'COPYING.txt',
395 'NOTICE', 'NOTICE.txt',
398 yield _("Unused extlib at %s") % os.path.join(dir_path, path)
401 def check_for_unsupported_metadata_files(basedir=""):
402 """Checks whether any non-metadata files are in metadata/"""
407 formats = config['accepted_formats']
408 for f in glob.glob(basedir + 'metadata/*') + glob.glob(basedir + 'metadata/.*'):
412 exists = exists or os.path.exists(f + '.' + t)
414 print(_('"%s/" has no matching metadata file!') % f)
416 elif not os.path.splitext(f)[1][1:] in formats:
417 print('"' + f.replace(basedir, '')
418 + '" is not a supported file format: (' + ','.join(formats) + ')')
426 global config, options
428 # Parse command line...
429 parser = ArgumentParser(usage="%(prog)s [options] [APPID [APPID ...]]")
430 common.setup_global_opts(parser)
431 parser.add_argument("-f", "--format", action="store_true", default=False,
432 help=_("Also warn about formatting issues, like rewritemeta -l"))
433 parser.add_argument("appid", nargs='*', help=_("applicationId in the form APPID"))
434 metadata.add_metadata_arguments(parser)
435 options = parser.parse_args()
436 metadata.warnings_action = options.W
438 config = common.read_config(options)
441 allapps = metadata.read_metadata(xref=True)
442 apps = common.read_app_args(options.appid, allapps, False)
444 anywarns = check_for_unsupported_metadata_files()
446 apps_check_funcs = []
447 if len(options.appid) == 0:
448 # otherwise it finds tons of unused extlibs
449 apps_check_funcs.append(check_extlib_dir)
450 for check_func in apps_check_funcs:
451 for warn in check_func(apps.values()):
455 for appid, app in apps.items():
464 check_checkupdates_ran,
465 check_useless_fields,
469 check_mediawiki_links,
470 check_bulleted_lists,
477 for check_func in app_check_funcs:
478 for warn in check_func(app):
480 print("%s: %s" % (appid, warn))
486 # A compiled, public domain list of official SPDX license tags from:
487 # https://github.com/sindresorhus/spdx-license-list/blob/v3.0.1/spdx-simple.json
488 # The deprecated license tags have been removed from the list, they are at the
489 # bottom, starting after the last license tags that start with Z.
490 # This is at the bottom, since its a long list of data
492 "PublicDomain", # an F-Droid addition, until we can enforce a better option
532 "BSD-2-Clause-FreeBSD",
533 "BSD-2-Clause-NetBSD",
535 "BSD-3-Clause-Clear",
536 "BSD-3-Clause-No-Nuclear-License",
537 "BSD-3-Clause-No-Nuclear-License-2014",
538 "BSD-3-Clause-No-Nuclear-Warranty",
542 "BSD-3-Clause-Attribution",
558 "CNRI-Python-GPL-Compatible",
692 "MPL-2.0-no-copyleft-exception",
816 "zlib-acknowledgement",
822 if __name__ == "__main__":