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")),
122 locale_pattern = re.compile(r'^[a-z]{2,3}(-[A-Z][A-Z])?$')
125 def check_regexes(app):
126 for f, checks in regex_checks.items():
129 t = metadata.fieldtype(f)
130 if t == metadata.TYPE_MULTILINE:
131 for l in v.splitlines():
133 yield "%s at line '%s': %s" % (f, l, r)
138 yield "%s '%s': %s" % (f, v, r)
141 def get_lastbuild(builds):
145 if not build.disable:
146 vercode = int(build.versionCode)
147 if lowest_vercode == -1 or vercode < lowest_vercode:
148 lowest_vercode = vercode
149 if not lastbuild or int(build.versionCode) > int(lastbuild.versionCode):
154 def check_ucm_tags(app):
155 lastbuild = get_lastbuild(app.builds)
156 if (lastbuild is not None
158 and app.UpdateCheckMode == 'RepoManifest'
159 and not lastbuild.commit.startswith('unknown')
160 and lastbuild.versionCode == app.CurrentVersionCode
161 and not lastbuild.forcevercode
162 and any(s in lastbuild.commit for s in '.,_-/')):
163 yield _("Last used commit '{commit}' looks like a tag, but Update Check Mode is '{ucm}'")\
164 .format(commit=lastbuild.commit, ucm=app.UpdateCheckMode)
167 def check_char_limits(app):
168 limits = config['char_limits']
170 if len(app.Summary) > limits['summary']:
171 yield _("Summary of length {length} is over the {limit} char limit")\
172 .format(length=len(app.Summary), limit=limits['summary'])
174 if len(app.Description) > limits['description']:
175 yield _("Description of length {length} is over the {limit} char limit")\
176 .format(length=len(app.Description), limit=limits['description'])
179 def check_old_links(app):
189 if any(s in app.Repo for s in usual_sites):
190 for f in ['WebSite', 'SourceCode', 'IssueTracker', 'Changelog']:
192 if any(s in v for s in old_sites):
193 yield _("App is in '{repo}' but has a link to {url}")\
194 .format(repo=app.Repo, url=v)
197 def check_useless_fields(app):
198 if app.UpdateCheckName == app.id:
199 yield _("Update Check Name is set to the known app id - it can be removed")
202 filling_ucms = re.compile(r'^(Tags.*|RepoManifest.*)')
205 def check_checkupdates_ran(app):
206 if filling_ucms.match(app.UpdateCheckMode):
207 if not app.AutoName and not app.CurrentVersion and app.CurrentVersionCode == '0':
208 yield _("UCM is set but it looks like checkupdates hasn't been run yet")
211 def check_empty_fields(app):
212 if not app.Categories:
213 yield _("Categories are not set")
216 all_categories = set([
227 "Science & Education",
237 def check_categories(app):
238 for categ in app.Categories:
239 if categ not in all_categories:
240 yield _("Category '%s' is not valid" % categ)
243 def check_duplicates(app):
244 if app.Name and app.Name == app.AutoName:
245 yield _("Name '%s' is just the auto name - remove it") % app.Name
248 for f in ['Source Code', 'Web Site', 'Issue Tracker', 'Changelog']:
254 yield _("Duplicate link in '{field}': {url}").format(field=f, url=v)
258 name = app.Name or app.AutoName
259 if app.Summary and name:
260 if app.Summary.lower() == name.lower():
261 yield _("Summary '%s' is just the app's name") % app.Summary
263 if app.Summary and app.Description and len(app.Description) == 1:
264 if app.Summary.lower() == app.Description[0].lower():
265 yield _("Description '%s' is just the app's summary") % app.Summary
268 for l in app.Description.splitlines():
272 yield _("Description has a duplicate line")
276 desc_url = re.compile(r'(^|[^[])\[([^ ]+)( |\]|$)')
279 def check_mediawiki_links(app):
280 wholedesc = ' '.join(app.Description)
281 for um in desc_url.finditer(wholedesc):
283 for m, r in http_checks:
285 yield _("URL {url} in Description: {error}").format(url=url, error=r)
288 def check_bulleted_lists(app):
289 validchars = ['*', '#']
292 for l in app.Description.splitlines():
297 if l[0] == lchar and l[1] == ' ':
299 if lcount > 2 and lchar not in validchars:
300 yield _("Description has a list (%s) but it isn't bulleted (*) nor numbered (#)") % lchar
307 def check_builds(app):
308 supported_flags = set(metadata.build_flags)
309 # needed for YAML and JSON
310 for build in app.builds:
312 if build.disable.startswith('Generated by import.py'):
313 yield _("Build generated by `fdroid import` - remove disable line once ready")
315 for s in ['master', 'origin', 'HEAD', 'default', 'trunk']:
316 if build.commit and build.commit.startswith(s):
317 yield _("Branch '{branch}' used as commit in build '{versionName}'")\
318 .format(branch=s, versionName=build.versionName)
319 for srclib in build.srclibs:
320 ref = srclib.split('@')[1].split('/')[0]
321 if ref.startswith(s):
322 yield _("Branch '{branch}' used as commit in srclib '{srclib}'")\
323 .format(branch=s, srclib=srclib)
324 for key in build.keys():
325 if key not in supported_flags:
326 yield _('%s is not an accepted build field') % key
329 def check_files_dir(app):
330 dir_path = os.path.join('metadata', app.id)
331 if not os.path.isdir(dir_path):
334 for name in os.listdir(dir_path):
335 path = os.path.join(dir_path, name)
336 if not (os.path.isfile(path) or name == 'signatures' or locale_pattern.match(name)):
337 yield _("Found non-file at %s") % path
341 used = {'signatures', }
342 for build in app.builds:
343 for fname in build.patch:
344 if fname not in files:
345 yield _("Unknown file '{filename}' in build '{versionName}'")\
346 .format(filename=fname, versionName=build.versionName)
350 for name in files.difference(used):
351 if locale_pattern.match(name):
353 yield _("Unused file at %s") % os.path.join(dir_path, name)
356 def check_format(app):
357 if options.format and not rewritemeta.proper_format(app):
358 yield _("Run rewritemeta to fix formatting")
361 def check_license_tag(app):
362 '''Ensure all license tags are in https://spdx.org/license-list'''
363 if app.License.rstrip('+') not in SPDX:
364 yield _('Invalid license tag "%s"! Use only tags from https://spdx.org/license-list') \
368 def check_extlib_dir(apps):
369 dir_path = os.path.join('build', 'extlib')
370 unused_extlib_files = set()
371 for root, dirs, files in os.walk(dir_path):
373 unused_extlib_files.add(os.path.join(root, name)[len(dir_path) + 1:])
377 for build in app.builds:
378 for path in build.extlibs:
379 if path not in unused_extlib_files:
380 yield _("{appid}: Unknown extlib {path} in build '{versionName}'")\
381 .format(appid=app.id, path=path, versionName=build.versionName)
385 for path in unused_extlib_files.difference(used):
386 if any(path.endswith(s) for s in [
388 'source.txt', 'origin.txt', 'md5.txt',
389 'LICENSE', 'LICENSE.txt',
390 'COPYING', 'COPYING.txt',
391 'NOTICE', 'NOTICE.txt',
394 yield _("Unused extlib at %s") % os.path.join(dir_path, path)
397 def check_for_unsupported_metadata_files(basedir=""):
398 """Checks whether any non-metadata files are in metadata/"""
403 formats = config['accepted_formats']
404 for f in glob.glob(basedir + 'metadata/*') + glob.glob(basedir + 'metadata/.*'):
408 exists = exists or os.path.exists(f + '.' + t)
410 print(_('"%s/" has no matching metadata file!') % f)
412 elif not os.path.splitext(f)[1][1:] in formats:
413 print('"' + f.replace(basedir, '')
414 + '" is not a supported file format: (' + ','.join(formats) + ')')
422 global config, options
424 # Parse command line...
425 parser = ArgumentParser(usage="%(prog)s [options] [APPID [APPID ...]]")
426 common.setup_global_opts(parser)
427 parser.add_argument("-f", "--format", action="store_true", default=False,
428 help=_("Also warn about formatting issues, like rewritemeta -l"))
429 parser.add_argument("appid", nargs='*', help=_("applicationId in the form APPID"))
430 metadata.add_metadata_arguments(parser)
431 options = parser.parse_args()
432 metadata.warnings_action = options.W
434 config = common.read_config(options)
437 allapps = metadata.read_metadata(xref=True)
438 apps = common.read_app_args(options.appid, allapps, False)
440 anywarns = check_for_unsupported_metadata_files()
442 apps_check_funcs = []
443 if len(options.appid) == 0:
444 # otherwise it finds tons of unused extlibs
445 apps_check_funcs.append(check_extlib_dir)
446 for check_func in apps_check_funcs:
447 for warn in check_func(apps.values()):
451 for appid, app in apps.items():
460 check_checkupdates_ran,
461 check_useless_fields,
465 check_mediawiki_links,
466 check_bulleted_lists,
473 for check_func in app_check_funcs:
474 for warn in check_func(app):
476 print("%s: %s" % (appid, warn))
482 # A compiled, public domain list of official SPDX license tags from:
483 # https://github.com/sindresorhus/spdx-license-list/blob/v3.0.1/spdx-simple.json
484 # The deprecated license tags have been removed from the list, they are at the
485 # bottom, starting after the last license tags that start with Z.
486 # This is at the bottom, since its a long list of data
488 "PublicDomain", # an F-Droid addition, until we can enforce a better option
528 "BSD-2-Clause-FreeBSD",
529 "BSD-2-Clause-NetBSD",
531 "BSD-3-Clause-Clear",
532 "BSD-3-Clause-No-Nuclear-License",
533 "BSD-3-Clause-No-Nuclear-License-2014",
534 "BSD-3-Clause-No-Nuclear-Warranty",
538 "BSD-3-Clause-Attribution",
554 "CNRI-Python-GPL-Compatible",
688 "MPL-2.0-no-copyleft-exception",
812 "zlib-acknowledgement",
818 if __name__ == "__main__":