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
28 from . import metadata
29 from . import rewritemeta
35 def enforce_https(domain):
36 return (re.compile(r'^[^h][^t][^t][^p][^s]://[^/]*' + re.escape(domain) + r'(/.*)?', re.IGNORECASE),
37 domain + " URLs should always use https://")
41 enforce_https('github.com'),
42 enforce_https('gitlab.com'),
43 enforce_https('bitbucket.org'),
44 enforce_https('apache.org'),
45 enforce_https('google.com'),
46 enforce_https('git.code.sf.net'),
47 enforce_https('svn.code.sf.net'),
48 enforce_https('anongit.kde.org'),
49 enforce_https('savannah.nongnu.org'),
50 enforce_https('git.savannah.nongnu.org'),
51 enforce_https('download.savannah.nongnu.org'),
52 enforce_https('savannah.gnu.org'),
53 enforce_https('git.savannah.gnu.org'),
54 enforce_https('download.savannah.gnu.org'),
55 enforce_https('github.io'),
56 enforce_https('gitlab.io'),
57 enforce_https('githubusercontent.com'),
61 def forbid_shortener(domain):
62 return (re.compile(r'https?://[^/]*' + re.escape(domain) + r'/.*'),
63 _("URL shorteners should not be used"))
66 http_url_shorteners = [
67 forbid_shortener('1url.com'),
68 forbid_shortener('adf.ly'),
69 forbid_shortener('bc.vc'),
70 forbid_shortener('bit.do'),
71 forbid_shortener('bit.ly'),
72 forbid_shortener('bitly.com'),
73 forbid_shortener('budurl.com'),
74 forbid_shortener('buzurl.com'),
75 forbid_shortener('cli.gs'),
76 forbid_shortener('cur.lv'),
77 forbid_shortener('cutt.us'),
78 forbid_shortener('db.tt'),
79 forbid_shortener('filoops.info'),
80 forbid_shortener('goo.gl'),
81 forbid_shortener('is.gd'),
82 forbid_shortener('ity.im'),
83 forbid_shortener('j.mp'),
84 forbid_shortener('l.gg'),
85 forbid_shortener('lnkd.in'),
86 forbid_shortener('moourl.com'),
87 forbid_shortener('ow.ly'),
88 forbid_shortener('para.pt'),
89 forbid_shortener('po.st'),
90 forbid_shortener('q.gs'),
91 forbid_shortener('qr.ae'),
92 forbid_shortener('qr.net'),
93 forbid_shortener('rdlnk.com'),
94 forbid_shortener('scrnch.me'),
95 forbid_shortener('short.nr'),
96 forbid_shortener('sn.im'),
97 forbid_shortener('snipurl.com'),
98 forbid_shortener('su.pr'),
99 forbid_shortener('t.co'),
100 forbid_shortener('tiny.cc'),
101 forbid_shortener('tinyarrows.com'),
102 forbid_shortener('tinyurl.com'),
103 forbid_shortener('tr.im'),
104 forbid_shortener('tweez.me'),
105 forbid_shortener('twitthis.com'),
106 forbid_shortener('twurl.nl'),
107 forbid_shortener('tyn.ee'),
108 forbid_shortener('u.bb'),
109 forbid_shortener('u.to'),
110 forbid_shortener('ur1.ca'),
111 forbid_shortener('urlof.site'),
112 forbid_shortener('v.gd'),
113 forbid_shortener('vzturl.com'),
114 forbid_shortener('x.co'),
115 forbid_shortener('xrl.us'),
116 forbid_shortener('yourls.org'),
117 forbid_shortener('zip.net'),
118 forbid_shortener('✩.ws'),
119 forbid_shortener('➡.ws'),
122 http_checks = https_enforcings + http_url_shorteners + [
123 (re.compile(r'.*github\.com/[^/]+/[^/]+\.git'),
124 _("Appending .git is not necessary")),
125 (re.compile(r'.*://[^/]*(github|gitlab|bitbucket|rawgit)[^/]*/([^/]+/){1,3}master'),
126 _("Use /HEAD instead of /master to point at a file in the default branch")),
130 'WebSite': http_checks,
131 'SourceCode': http_checks,
132 'Repo': https_enforcings,
133 'UpdateCheckMode': https_enforcings,
134 'IssueTracker': http_checks + [
135 (re.compile(r'.*github\.com/[^/]+/[^/]+/*$'),
136 _("/issues is missing")),
137 (re.compile(r'.*gitlab\.com/[^/]+/[^/]+/*$'),
138 _("/issues is missing")),
140 'Donate': http_checks + [
141 (re.compile(r'.*flattr\.com'),
142 _("Flattr donation methods belong in the FlattrID flag")),
143 (re.compile(r'.*liberapay\.com'),
144 _("Liberapay donation methods belong in the LiberapayID flag")),
146 'Changelog': http_checks,
149 _("Unnecessary leading space")),
150 (re.compile(r'.*\s$'),
151 _("Unnecessary trailing space")),
154 (re.compile(r'.*\b(free software|open source)\b.*', re.IGNORECASE),
155 _("No need to specify that the app is Free Software")),
156 (re.compile(r'.*((your|for).*android|android.*(app|device|client|port|version))', re.IGNORECASE),
157 _("No need to specify that the app is for Android")),
158 (re.compile(r'.*[a-z0-9][.!?]( |$)'),
159 _("Punctuation should be avoided")),
161 _("Unnecessary leading space")),
162 (re.compile(r'.*\s$'),
163 _("Unnecessary trailing space")),
165 'Description': https_enforcings + http_url_shorteners + [
166 (re.compile(r'\s*[*#][^ .]'),
167 _("Invalid bulleted list")),
169 _("Unnecessary leading space")),
170 (re.compile(r'.*\s$'),
171 _("Unnecessary trailing space")),
172 (re.compile(r'.*<(applet|base|body|button|embed|form|head|html|iframe|img|input|link|object|picture|script|source|style|svg|video).*', re.IGNORECASE),
173 _("Forbidden HTML tags")),
174 (re.compile(r'''.*\s+src=["']javascript:.*'''),
175 _("Javascript in HTML src attributes")),
179 locale_pattern = re.compile(r'^[a-z]{2,3}(-[A-Z][A-Z])?$')
182 def check_regexes(app):
183 for f, checks in regex_checks.items():
186 t = metadata.fieldtype(f)
187 if t == metadata.TYPE_MULTILINE:
188 for l in v.splitlines():
190 yield "%s at line '%s': %s" % (f, l, r)
195 yield "%s '%s': %s" % (f, v, r)
198 def get_lastbuild(builds):
202 if not build.disable:
203 vercode = int(build.versionCode)
204 if lowest_vercode == -1 or vercode < lowest_vercode:
205 lowest_vercode = vercode
206 if not lastbuild or int(build.versionCode) > int(lastbuild.versionCode):
211 def check_update_check_data_url(app):
212 """UpdateCheckData must have a valid HTTPS URL to protect checkupdates runs
214 if app.UpdateCheckData:
215 urlcode, codeex, urlver, verex = app.UpdateCheckData.split('|')
216 for url in (urlcode, urlver):
218 parsed = urllib.parse.urlparse(url)
219 if not parsed.scheme or not parsed.netloc:
220 yield _('UpdateCheckData not a valid URL: {url}').format(url=url)
221 if parsed.scheme != 'https':
222 yield _('UpdateCheckData must use HTTPS URL: {url}').format(url=url)
225 def check_ucm_tags(app):
226 lastbuild = get_lastbuild(app.builds)
227 if (lastbuild is not None
229 and app.UpdateCheckMode == 'RepoManifest'
230 and not lastbuild.commit.startswith('unknown')
231 and lastbuild.versionCode == app.CurrentVersionCode
232 and not lastbuild.forcevercode
233 and any(s in lastbuild.commit for s in '.,_-/')):
234 yield _("Last used commit '{commit}' looks like a tag, but Update Check Mode is '{ucm}'")\
235 .format(commit=lastbuild.commit, ucm=app.UpdateCheckMode)
238 def check_char_limits(app):
239 limits = config['char_limits']
241 if len(app.Summary) > limits['summary']:
242 yield _("Summary of length {length} is over the {limit} char limit")\
243 .format(length=len(app.Summary), limit=limits['summary'])
245 if len(app.Description) > limits['description']:
246 yield _("Description of length {length} is over the {limit} char limit")\
247 .format(length=len(app.Description), limit=limits['description'])
250 def check_old_links(app):
260 if any(s in app.Repo for s in usual_sites):
261 for f in ['WebSite', 'SourceCode', 'IssueTracker', 'Changelog']:
263 if any(s in v for s in old_sites):
264 yield _("App is in '{repo}' but has a link to {url}")\
265 .format(repo=app.Repo, url=v)
268 def check_useless_fields(app):
269 if app.UpdateCheckName == app.id:
270 yield _("Update Check Name is set to the known app id - it can be removed")
273 filling_ucms = re.compile(r'^(Tags.*|RepoManifest.*)')
276 def check_checkupdates_ran(app):
277 if filling_ucms.match(app.UpdateCheckMode):
278 if not app.AutoName and not app.CurrentVersion and app.CurrentVersionCode == '0':
279 yield _("UCM is set but it looks like checkupdates hasn't been run yet")
282 def check_empty_fields(app):
283 if not app.Categories:
284 yield _("Categories are not set")
287 all_categories = set([
298 "Science & Education",
308 def check_categories(app):
309 for categ in app.Categories:
310 if categ not in all_categories:
311 yield _("Category '%s' is not valid" % categ)
314 def check_duplicates(app):
315 if app.Name and app.Name == app.AutoName:
316 yield _("Name '%s' is just the auto name - remove it") % app.Name
319 for f in ['Source Code', 'Web Site', 'Issue Tracker', 'Changelog']:
325 yield _("Duplicate link in '{field}': {url}").format(field=f, url=v)
329 name = app.Name or app.AutoName
330 if app.Summary and name:
331 if app.Summary.lower() == name.lower():
332 yield _("Summary '%s' is just the app's name") % app.Summary
334 if app.Summary and app.Description and len(app.Description) == 1:
335 if app.Summary.lower() == app.Description[0].lower():
336 yield _("Description '%s' is just the app's summary") % app.Summary
339 for l in app.Description.splitlines():
343 yield _("Description has a duplicate line")
347 desc_url = re.compile(r'(^|[^[])\[([^ ]+)( |\]|$)')
350 def check_mediawiki_links(app):
351 wholedesc = ' '.join(app.Description)
352 for um in desc_url.finditer(wholedesc):
354 for m, r in http_checks:
356 yield _("URL {url} in Description: {error}").format(url=url, error=r)
359 def check_bulleted_lists(app):
360 validchars = ['*', '#']
363 for l in app.Description.splitlines():
368 if l[0] == lchar and l[1] == ' ':
370 if lcount > 2 and lchar not in validchars:
371 yield _("Description has a list (%s) but it isn't bulleted (*) nor numbered (#)") % lchar
378 def check_builds(app):
379 supported_flags = set(metadata.build_flags)
380 # needed for YAML and JSON
381 for build in app.builds:
383 if build.disable.startswith('Generated by import.py'):
384 yield _("Build generated by `fdroid import` - remove disable line once ready")
386 for s in ['master', 'origin', 'HEAD', 'default', 'trunk']:
387 if build.commit and build.commit.startswith(s):
388 yield _("Branch '{branch}' used as commit in build '{versionName}'")\
389 .format(branch=s, versionName=build.versionName)
390 for srclib in build.srclibs:
392 ref = srclib.split('@')[1].split('/')[0]
393 if ref.startswith(s):
394 yield _("Branch '{branch}' used as commit in srclib '{srclib}'")\
395 .format(branch=s, srclib=srclib)
397 yield _('srclibs missing name and/or @') + ' (srclibs: ' + srclib + ')'
398 for key in build.keys():
399 if key not in supported_flags:
400 yield _('%s is not an accepted build field') % key
403 def check_files_dir(app):
404 dir_path = os.path.join('metadata', app.id)
405 if not os.path.isdir(dir_path):
408 for name in os.listdir(dir_path):
409 path = os.path.join(dir_path, name)
410 if not (os.path.isfile(path) or name == 'signatures' or locale_pattern.match(name)):
411 yield _("Found non-file at %s") % path
415 used = {'signatures', }
416 for build in app.builds:
417 for fname in build.patch:
418 if fname not in files:
419 yield _("Unknown file '{filename}' in build '{versionName}'")\
420 .format(filename=fname, versionName=build.versionName)
424 for name in files.difference(used):
425 if locale_pattern.match(name):
427 yield _("Unused file at %s") % os.path.join(dir_path, name)
430 def check_format(app):
431 if options.format and not rewritemeta.proper_format(app):
432 yield _("Run rewritemeta to fix formatting")
435 def check_license_tag(app):
436 '''Ensure all license tags are in https://spdx.org/license-list'''
437 if app.License.rstrip('+') not in SPDX:
438 yield _('Invalid license tag "%s"! Use only tags from https://spdx.org/license-list') \
442 def check_extlib_dir(apps):
443 dir_path = os.path.join('build', 'extlib')
444 unused_extlib_files = set()
445 for root, dirs, files in os.walk(dir_path):
447 unused_extlib_files.add(os.path.join(root, name)[len(dir_path) + 1:])
451 for build in app.builds:
452 for path in build.extlibs:
453 if path not in unused_extlib_files:
454 yield _("{appid}: Unknown extlib {path} in build '{versionName}'")\
455 .format(appid=app.id, path=path, versionName=build.versionName)
459 for path in unused_extlib_files.difference(used):
460 if any(path.endswith(s) for s in [
462 'source.txt', 'origin.txt', 'md5.txt',
463 'LICENSE', 'LICENSE.txt',
464 'COPYING', 'COPYING.txt',
465 'NOTICE', 'NOTICE.txt',
468 yield _("Unused extlib at %s") % os.path.join(dir_path, path)
471 def check_for_unsupported_metadata_files(basedir=""):
472 """Checks whether any non-metadata files are in metadata/"""
477 formats = config['accepted_formats']
478 for f in glob.glob(basedir + 'metadata/*') + glob.glob(basedir + 'metadata/.*'):
482 exists = exists or os.path.exists(f + '.' + t)
484 print(_('"%s/" has no matching metadata file!') % f)
486 elif not os.path.splitext(f)[1][1:] in formats:
487 print('"' + f.replace(basedir, '')
488 + '" is not a supported file format: (' + ','.join(formats) + ')')
496 global config, options
498 # Parse command line...
499 parser = ArgumentParser(usage="%(prog)s [options] [APPID [APPID ...]]")
500 common.setup_global_opts(parser)
501 parser.add_argument("-f", "--format", action="store_true", default=False,
502 help=_("Also warn about formatting issues, like rewritemeta -l"))
503 parser.add_argument("appid", nargs='*', help=_("applicationId in the form APPID"))
504 metadata.add_metadata_arguments(parser)
505 options = parser.parse_args()
506 metadata.warnings_action = options.W
508 config = common.read_config(options)
511 allapps = metadata.read_metadata(xref=True)
512 apps = common.read_app_args(options.appid, allapps, False)
514 anywarns = check_for_unsupported_metadata_files()
516 apps_check_funcs = []
517 if len(options.appid) == 0:
518 # otherwise it finds tons of unused extlibs
519 apps_check_funcs.append(check_extlib_dir)
520 for check_func in apps_check_funcs:
521 for warn in check_func(apps.values()):
525 for appid, app in apps.items():
531 check_update_check_data_url,
535 check_checkupdates_ran,
536 check_useless_fields,
540 check_mediawiki_links,
541 check_bulleted_lists,
548 for check_func in app_check_funcs:
549 for warn in check_func(app):
551 print("%s: %s" % (appid, warn))
557 # A compiled, public domain list of official SPDX license tags from:
558 # https://github.com/sindresorhus/spdx-license-list/blob/v3.0.1/spdx-simple.json
559 # The deprecated license tags have been removed from the list, they are at the
560 # bottom, starting after the last license tags that start with Z.
561 # This is at the bottom, since its a long list of data
563 "PublicDomain", # an F-Droid addition, until we can enforce a better option
603 "BSD-2-Clause-FreeBSD",
604 "BSD-2-Clause-NetBSD",
606 "BSD-3-Clause-Clear",
607 "BSD-3-Clause-No-Nuclear-License",
608 "BSD-3-Clause-No-Nuclear-License-2014",
609 "BSD-3-Clause-No-Nuclear-Warranty",
613 "BSD-3-Clause-Attribution",
629 "CNRI-Python-GPL-Compatible",
763 "MPL-2.0-no-copyleft-exception",
887 "zlib-acknowledgement",
893 if __name__ == "__main__":