![Peter Wu](/assets/img/avatar_default.png)
A recent commit broke compilation with Python 3. The original author of html2text.py is deceased and the fork has increased the number of files for this "simple" helper. The html2text.py script in this patch was rewritten and its output matches with lynx (except for a few newlines around lists). This means that indentation has been added for headings, paragraphs and lists. Also, since it was written from scratch, a new license could be chosen that matches Wireshark. Since now the in-tree html2text.py script provides nicer output, remove detection of the alternative programs (elinks, links). lynx/w3m is somehow still necessary for asciidoc though. (I also looked into reusing html2text.py for the release notes to replace asciidoc, but the --format=html output produces different output (HTML adds a ToC and section numbers). For now still require lynx for release notes) Tested with Python 2.6.6, 2.7.9, 3.2.6 and 3.4.3 under LC_ALL=C and LC_ALL=en_US.UTF-8 on Linux. Tested reading from stdin and file, writing to file, pipe and tty. Tested with cmake (Ninja) and autotools on Arch Linux x86_64. Test: # For each $PATH per python version, execute (with varying LC_ALL) help/faq.py -b | tools/html2text.py /dev/stdin | md5sum help/faq.py -b | tools/html2text.py | md5sum help/faq.py -b | tools/html2text.py help/faq.py -b | tools/html2text.py >/dev/null Change-Id: I6409450a3e6c8b010ca082251f9db7358b0cc2fd Reviewed-on: https://code.wireshark.org/review/7779 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
328 lines
10 KiB
Python
Executable file
328 lines
10 KiB
Python
Executable file
#!/usr/bin/env python
|
|
# Copyright (c) 2013 The Chromium Authors. All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions are
|
|
# met:
|
|
#
|
|
# * Redistributions of source code must retain the above copyright
|
|
# notice, this list of conditions and the following disclaimer.
|
|
# * Redistributions in binary form must reproduce the above
|
|
# copyright notice, this list of conditions and the following disclaimer
|
|
# in the documentation and/or other materials provided with the
|
|
# distribution.
|
|
# * Neither the name of Google Inc. nor the names of its
|
|
# contributors may be used to endorse or promote products derived from
|
|
# this software without specific prior written permission.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
"""Makes sure that all files contain proper licensing information."""
|
|
|
|
|
|
import optparse
|
|
import os.path
|
|
import subprocess
|
|
import sys
|
|
|
|
|
|
def PrintUsage():
|
|
print("""Usage: python checklicenses.py [--root <root>] [tocheck]
|
|
--root Specifies the repository root. This defaults to ".." relative
|
|
to the script file. This will be correct given the normal location
|
|
of the script in "<root>/tools".
|
|
|
|
--ignore-suppressions Ignores path-specific license whitelist. Useful when
|
|
trying to remove a suppression/whitelist entry.
|
|
|
|
tocheck Specifies the directory, relative to root, to check. This defaults
|
|
to "." so it checks everything.
|
|
|
|
Examples:
|
|
python checklicenses.py
|
|
python checklicenses.py --root ~/chromium/src third_party""")
|
|
|
|
|
|
WHITELISTED_LICENSES = [
|
|
'Apache (v2.0)',
|
|
'Apache (v2.0) BSD (2 clause)',
|
|
'Apache (v2.0) GPL (v2)',
|
|
'Apple MIT', # https://fedoraproject.org/wiki/Licensing/Apple_MIT_License
|
|
'APSL (v2)',
|
|
'APSL (v2) BSD (4 clause)',
|
|
'BSD',
|
|
'BSD (2 clause)',
|
|
'BSD (2 clause) GPL (v2 or later)',
|
|
'BSD (2 clause) MIT/X11 (BSD like)',
|
|
'BSD (3 clause)',
|
|
'BSD (3 clause) ISC',
|
|
'BSD (3 clause) LGPL (v2 or later)',
|
|
'BSD (3 clause) LGPL (v2.1 or later)',
|
|
'BSD (3 clause) MIT/X11 (BSD like)',
|
|
'BSD (4 clause)',
|
|
'BSD-like',
|
|
|
|
# TODO(phajdan.jr): Make licensecheck not print BSD-like twice.
|
|
'BSD-like MIT/X11 (BSD like)',
|
|
|
|
'BSL (v1.0)',
|
|
'GPL (v2 or later)',
|
|
'GPL (v2 or later) with Bison parser exception',
|
|
'GPL (v2 or later) with libtool exception',
|
|
'GPL (v3 or later) with Bison parser exception',
|
|
'GPL with Bison parser exception',
|
|
'ISC',
|
|
'ISC GPL (v2)',
|
|
'ISC GPL (v2 or later)',
|
|
'LGPL',
|
|
'LGPL (v2)',
|
|
'LGPL (v2 or later)',
|
|
'LGPL (v2.1)',
|
|
'LGPL (v3 or later)',
|
|
|
|
# TODO(phajdan.jr): Make licensecheck convert that comma to a dot.
|
|
'LGPL (v2,1 or later)',
|
|
|
|
'LGPL (v2.1 or later)',
|
|
'MPL (v1.0) LGPL (v2 or later)',
|
|
'MPL (v1.1)',
|
|
'MPL (v1.1) BSD-like',
|
|
'MPL (v1.1) BSD-like GPL (unversioned/unknown version)',
|
|
'MPL (v1.1,) BSD (3 clause) GPL (unversioned/unknown version) '
|
|
'LGPL (v2.1 or later)',
|
|
'MPL (v1.1) GPL (unversioned/unknown version)',
|
|
'MPL (v2.0)',
|
|
|
|
# TODO(phajdan.jr): Make licensecheck not print the comma after 1.1.
|
|
'MPL (v1.1,) GPL (unversioned/unknown version) LGPL (v2 or later)',
|
|
'MPL (v1.1,) GPL (unversioned/unknown version) LGPL (v2.1 or later)',
|
|
|
|
'MIT/X11 (BSD like)',
|
|
'Ms-PL',
|
|
'Public domain',
|
|
'Public domain BSD',
|
|
'Public domain BSD (3 clause)',
|
|
'Public domain BSD-like',
|
|
'Public domain GPL (v2 or later)',
|
|
'Public domain LGPL (v2.1 or later)',
|
|
'Public domain MIT/X11 (BSD like)',
|
|
'libpng',
|
|
'zlib/libpng',
|
|
'zlib/libpng GPL (v2 or later)',
|
|
'SGI Free Software License B',
|
|
'University of Illinois/NCSA Open Source License (BSD like)',
|
|
]
|
|
|
|
|
|
PATH_SPECIFIC_WHITELISTED_LICENSES = {
|
|
'dtds': [
|
|
'UNKNOWN',
|
|
],
|
|
'diameter/dictionary.dtd': [
|
|
'UNKNOWN',
|
|
],
|
|
'wimaxasncp/dictionary.dtd': [
|
|
'UNKNOWN',
|
|
],
|
|
'docbook/custom_layer_pdf.xsl': [
|
|
'UNKNOWN',
|
|
],
|
|
'docbook/custom_layer_chm.xsl': [
|
|
'UNKNOWN',
|
|
],
|
|
'fix': [
|
|
'UNKNOWN',
|
|
],
|
|
'wsutil/g711.c': [
|
|
'UNKNOWN',
|
|
],
|
|
'wiretap/ascend.c': [
|
|
'GPL (v3 or later)',
|
|
],
|
|
'wiretap/ascend.h': [
|
|
'GPL (v3 or later)',
|
|
],
|
|
'packaging/macosx': [
|
|
'UNKNOWN',
|
|
],
|
|
'epan/except.c': [
|
|
'UNKNOWN',
|
|
],
|
|
'epan/except.h': [
|
|
'UNKNOWN',
|
|
],
|
|
'cmake/TestFileOffsetBits.c': [
|
|
'UNKNOWN',
|
|
],
|
|
'cmake/TestWindowsFSeek.c': [
|
|
'UNKNOWN',
|
|
],
|
|
'plugins/mate/mate_grammar.c': [
|
|
'GPL (v2 or later) LGPL (v2 or later)', # licensecheck bug?
|
|
],
|
|
# Generated header files by lex/yacc/whatever
|
|
'epan/dtd_grammar.h': [
|
|
'UNKNOWN',
|
|
],
|
|
'epan/dfilter/grammar.h': [
|
|
'UNKNOWN',
|
|
],
|
|
'plugins/mate/mate_grammar.h': [
|
|
'UNKNOWN',
|
|
],
|
|
'version.h': [
|
|
'UNKNOWN',
|
|
],
|
|
# Special IDL license that appears to be compatible as far as I (not a
|
|
# lawyer) can tell. See
|
|
# https://www.wireshark.org/lists/wireshark-dev/201310/msg00234.html
|
|
'epan/dissectors/pidl/idl_types.h': [
|
|
'UNKNOWN',
|
|
],
|
|
# Written by Ronnie Sahlberg and correctly licensed, but cannot include
|
|
# a license header despite the file extension as they need to be
|
|
# parsed by the pidl tool
|
|
'epan/dissectors/pidl/mapi/request.cnf.c': [
|
|
'UNKNOWN',
|
|
],
|
|
'epan/dissectors/pidl/mapi/response.cnf.c': [
|
|
'UNKNOWN',
|
|
],
|
|
# The following tools are under incompatible licenses (mostly GPLv3 or
|
|
# GPLv3+), but this is OK since they are not actually linked into Wireshark
|
|
'tools/pidl': [
|
|
'UNKNOWN',
|
|
],
|
|
'tools/lemon': [
|
|
'UNKNOWN',
|
|
],
|
|
'tools/fix_pragma_wdocumentation.sh': [
|
|
'UNKNOWN',
|
|
],
|
|
|
|
}
|
|
|
|
|
|
def check_licenses(options, args):
|
|
# Figure out which directory we have to check.
|
|
if len(args) == 0:
|
|
# No directory to check specified, use the repository root.
|
|
start_dir = options.base_directory
|
|
elif len(args) == 1:
|
|
# Directory specified. Start here. It's supposed to be relative to the
|
|
# base directory.
|
|
start_dir = os.path.abspath(os.path.join(options.base_directory, args[0]))
|
|
else:
|
|
# More than one argument, we don't handle this.
|
|
PrintUsage()
|
|
return 1
|
|
|
|
print("Using base directory: %s" % options.base_directory)
|
|
print("Checking: %s" % start_dir)
|
|
print("")
|
|
|
|
#licensecheck_path = os.path.abspath(os.path.join(options.base_directory,
|
|
# 'third_party',
|
|
# 'devscripts',
|
|
# 'licensecheck.pl'))
|
|
licensecheck_path = 'licensecheck'
|
|
|
|
licensecheck = subprocess.Popen([licensecheck_path,
|
|
'-l', '150',
|
|
'-r', start_dir],
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.PIPE)
|
|
stdout, stderr = licensecheck.communicate()
|
|
if sys.version_info[0] >= 3:
|
|
stdout = stdout.decode('utf-8')
|
|
stderr = stderr.decode('utf-8')
|
|
if options.verbose:
|
|
print('----------- licensecheck stdout -----------')
|
|
print(stdout)
|
|
print('--------- end licensecheck stdout ---------')
|
|
if licensecheck.returncode != 0 or stderr:
|
|
print('----------- licensecheck stderr -----------')
|
|
print(stderr)
|
|
print('--------- end licensecheck stderr ---------')
|
|
print("\nFAILED\n")
|
|
return 1
|
|
|
|
success = True
|
|
for line in stdout.splitlines():
|
|
filename, license = line.split(':', 1)
|
|
filename = os.path.relpath(filename.strip(), options.base_directory)
|
|
|
|
# All files in the build output directory are generated one way or another.
|
|
# There's no need to check them.
|
|
if filename.startswith('out/') or filename.startswith('sconsbuild/'):
|
|
continue
|
|
|
|
# For now we're just interested in the license.
|
|
license = license.replace('*No copyright*', '').strip()
|
|
|
|
# Skip generated files.
|
|
if 'GENERATED FILE' in license:
|
|
continue
|
|
|
|
if license in WHITELISTED_LICENSES:
|
|
continue
|
|
|
|
if not options.ignore_suppressions:
|
|
found_path_specific = False
|
|
for prefix in PATH_SPECIFIC_WHITELISTED_LICENSES:
|
|
if (filename.startswith(prefix) and
|
|
license in PATH_SPECIFIC_WHITELISTED_LICENSES[prefix]):
|
|
found_path_specific = True
|
|
break
|
|
if found_path_specific:
|
|
continue
|
|
|
|
print("'%s' has non-whitelisted license '%s'" % (filename, license))
|
|
success = False
|
|
|
|
if success:
|
|
print("\nSUCCESS\n")
|
|
return 0
|
|
else:
|
|
print("\nFAILED\n")
|
|
print("Please read")
|
|
print("http://www.chromium.org/developers/adding-3rd-party-libraries")
|
|
print("for more info how to handle the failure.")
|
|
print("")
|
|
print("Please respect OWNERS of checklicenses.py. Changes violating")
|
|
print("this requirement may be reverted.")
|
|
return 1
|
|
|
|
|
|
def main():
|
|
default_root = os.path.abspath(
|
|
os.path.join(os.path.dirname(__file__), '..'))
|
|
option_parser = optparse.OptionParser()
|
|
option_parser.add_option('--root', default=default_root,
|
|
dest='base_directory',
|
|
help='Specifies the repository root. This defaults '
|
|
'to "../.." relative to the script file, which '
|
|
'will normally be the repository root.')
|
|
option_parser.add_option('-v', '--verbose', action='store_true',
|
|
default=False, help='Print debug logging')
|
|
option_parser.add_option('--ignore-suppressions',
|
|
action='store_true',
|
|
default=False,
|
|
help='Ignore path-specific license whitelist.')
|
|
options, args = option_parser.parse_args()
|
|
return check_licenses(options, args)
|
|
|
|
|
|
if '__main__' == __name__:
|
|
sys.exit(main())
|