scripts/spdxcheck.py

   1 #!/usr/bin/env python3
   2 # SPDX-License-Identifier: GPL-2.0
   3 # Copyright Thomas Gleixner <tglx@linutronix.de>
   4
   5 from argparse import ArgumentParser
   6 from ply import lex, yacc
   7 import locale
   8 import traceback
   9 import sys
  10 import git
  11 import re
  12 import os
  13
  14 class ParserException(Exception):
  15     def __init__(self, tok, txt):
  16         self.tok = tok
  17         self.txt = txt
  18
  19 class SPDXException(Exception):
  20     def __init__(self, el, txt):
  21         self.el = el
  22         self.txt = txt
  23
  24 class SPDXdata(object):
  25     def __init__(self):
  26         self.license_files = 0
  27         self.exception_files = 0
  28         self.licenses = [ ]
  29         self.exceptions = { }
  30
  31 # Read the spdx data from the LICENSES directory
  32 def read_spdxdata(repo):
  33
  34     # The subdirectories of LICENSES in the kernel source
  35     # Note: exceptions needs to be parsed as last directory.
  36     license_dirs = [ "preferred", "dual", "deprecated", "exceptions" ]
  37     lictree = repo.head.commit.tree['LICENSES']
  38
  39     spdx = SPDXdata()
  40
  41     for d in license_dirs:
  42         for el in lictree[d].traverse():
  43             if not os.path.isfile(el.path):
  44                 continue
  45
  46             exception = None
  47             for l in open(el.path, encoding="utf-8").readlines():
  48                 if l.startswith('Valid-License-Identifier:'):
  49                     lid = l.split(':')[1].strip().upper()
  50                     if lid in spdx.licenses:
  51                         raise SPDXException(el, 'Duplicate License Identifier: %s' %lid)
  52                     else:
  53                         spdx.licenses.append(lid)
  54
  55                 elif l.startswith('SPDX-Exception-Identifier:'):
  56                     exception = l.split(':')[1].strip().upper()
  57                     spdx.exceptions[exception] = []
  58
  59                 elif l.startswith('SPDX-Licenses:'):
  60                     for lic in l.split(':')[1].upper().strip().replace(' ', '').replace('\t', '').split(','):
  61                         if not lic in spdx.licenses:
  62                             raise SPDXException(None, 'Exception %s missing license %s' %(exception, lic))
  63                         spdx.exceptions[exception].append(lic)
  64
  65                 elif l.startswith("License-Text:"):
  66                     if exception:
  67                         if not len(spdx.exceptions[exception]):
  68                             raise SPDXException(el, 'Exception %s is missing SPDX-Licenses' %exception)
  69                         spdx.exception_files += 1
  70                     else:
  71                         spdx.license_files += 1
  72                     break
  73     return spdx
  74
  75 class id_parser(object):
  76
  77     reserved = [ 'AND', 'OR', 'WITH' ]
  78     tokens = [ 'LPAR', 'RPAR', 'ID', 'EXC' ] + reserved
  79
  80     precedence = ( ('nonassoc', 'AND', 'OR'), )
  81
  82     t_ignore = ' \t'
  83
  84     def __init__(self, spdx):
  85         self.spdx = spdx
  86         self.lasttok = None
  87         self.lastid = None
  88         self.lexer = lex.lex(module = self, reflags = re.UNICODE)
  89         # Initialize the parser. No debug file and no parser rules stored on disk
  90         # The rules are small enough to be generated on the fly
  91         self.parser = yacc.yacc(module = self, write_tables = False, debug = False)
  92         self.lines_checked = 0
  93         self.checked = 0
  94         self.spdx_valid = 0
  95         self.spdx_errors = 0
  96         self.curline = 0
  97         self.deepest = 0
  98
  99     # Validate License and Exception IDs
 100     def validate(self, tok):
 101         id = tok.value.upper()
 102         if tok.type == 'ID':
 103             if not id in self.spdx.licenses:
 104                 raise ParserException(tok, 'Invalid License ID')
 105             self.lastid = id
 106         elif tok.type == 'EXC':
 107             if id not in self.spdx.exceptions:
 108                 raise ParserException(tok, 'Invalid Exception ID')
 109             if self.lastid not in self.spdx.exceptions[id]:
 110                 raise ParserException(tok, 'Exception not valid for license %s' %self.lastid)
 111             self.lastid = None
 112         elif tok.type != 'WITH':
 113             self.lastid = None
 114
 115     # Lexer functions
 116     def t_RPAR(self, tok):
 117         r'\)'
 118         self.lasttok = tok.type
 119         return tok
 120
 121     def t_LPAR(self, tok):
 122         r'\('
 123         self.lasttok = tok.type
 124         return tok
 125
 126     def t_ID(self, tok):
 127         r'[A-Za-z.0-9\-+]+'
 128
 129         if self.lasttok == 'EXC':
 130             print(tok)
 131             raise ParserException(tok, 'Missing parentheses')
 132
 133         tok.value = tok.value.strip()
 134         val = tok.value.upper()
 135
 136         if val in self.reserved:
 137             tok.type = val
 138         elif self.lasttok == 'WITH':
 139             tok.type = 'EXC'
 140
 141         self.lasttok = tok.type
 142         self.validate(tok)
 143         return tok
 144
 145     def t_error(self, tok):
 146         raise ParserException(tok, 'Invalid token')
 147
 148     def p_expr(self, p):
 149         '''expr : ID
 150                 | ID WITH EXC
 151                 | expr AND expr
 152                 | expr OR expr
 153                 | LPAR expr RPAR'''
 154         pass
 155
 156     def p_error(self, p):
 157         if not p:
 158             raise ParserException(None, 'Unfinished license expression')
 159         else:
 160             raise ParserException(p, 'Syntax error')
 161
 162     def parse(self, expr):
 163         self.lasttok = None
 164         self.lastid = None
 165         self.parser.parse(expr, lexer = self.lexer)
 166
 167     def parse_lines(self, fd, maxlines, fname):
 168         self.checked += 1
 169         self.curline = 0
 170         try:
 171             for line in fd:
 172                 line = line.decode(locale.getpreferredencoding(False), errors='ignore')
 173                 self.curline += 1
 174                 if self.curline > maxlines:
 175                     break
 176                 self.lines_checked += 1
 177                 if line.find("SPDX-License-Identifier:") < 0:
 178                     continue
 179                 expr = line.split(':')[1].strip()
 180                 # Remove trailing comment closure
 181                 if line.strip().endswith('*/'):
 182                     expr = expr.rstrip('*/').strip()
 183                 # Remove trailing xml comment closure
 184                 if line.strip().endswith('-->'):
 185                     expr = expr.rstrip('-->').strip()
 186                 # Special case for SH magic boot code files
 187                 if line.startswith('LIST \"'):
 188                     expr = expr.rstrip('\"').strip()
 189                 self.parse(expr)
 190                 self.spdx_valid += 1
 191                 #
 192                 # Should we check for more SPDX ids in the same file and
 193                 # complain if there are any?
 194                 #
 195                 break
 196
 197         except ParserException as pe:
 198             if pe.tok:
 199                 col = line.find(expr) + pe.tok.lexpos
 200                 tok = pe.tok.value
 201                 sys.stdout.write('%s: %d:%d %s: %s\n' %(fname, self.curline, col, pe.txt, tok))
 202             else:
 203                 sys.stdout.write('%s: %d:0 %s\n' %(fname, self.curline, col, pe.txt))
 204             self.spdx_errors += 1
 205
 206 def scan_git_tree(tree):
 207     for el in tree.traverse():
 208         # Exclude stuff which would make pointless noise
 209         # FIXME: Put this somewhere more sensible
 210         if el.path.startswith("LICENSES"):
 211             continue
 212         if el.path.find("license-rules.rst") >= 0:
 213             continue
 214         if not os.path.isfile(el.path):
 215             continue
 216         with open(el.path, 'rb') as fd:
 217             parser.parse_lines(fd, args.maxlines, el.path)
 218
 219 def scan_git_subtree(tree, path):
 220     for p in path.strip('/').split('/'):
 221         tree = tree[p]
 222     scan_git_tree(tree)
 223
 224 if __name__ == '__main__':
 225
 226     ap = ArgumentParser(description='SPDX expression checker')
 227     ap.add_argument('path', nargs='*', help='Check path or file. If not given full git tree scan. For stdin use "-"')
 228     ap.add_argument('-m', '--maxlines', type=int, default=15,
 229                     help='Maximum number of lines to scan in a file. Default 15')
 230     ap.add_argument('-v', '--verbose', action='store_true', help='Verbose statistics output')
 231     args = ap.parse_args()
 232
 233     # Sanity check path arguments
 234     if '-' in args.path and len(args.path) > 1:
 235         sys.stderr.write('stdin input "-" must be the only path argument\n')
 236         sys.exit(1)
 237
 238     try:
 239         # Use git to get the valid license expressions
 240         repo = git.Repo(os.getcwd())
 241         assert not repo.bare
 242
 243         # Initialize SPDX data
 244         spdx = read_spdxdata(repo)
 245
 246         # Initialize the parser
 247         parser = id_parser(spdx)
 248
 249     except SPDXException as se:
 250         if se.el:
 251             sys.stderr.write('%s: %s\n' %(se.el.path, se.txt))
 252         else:
 253             sys.stderr.write('%s\n' %se.txt)
 254         sys.exit(1)
 255
 256     except Exception as ex:
 257         sys.stderr.write('FAIL: %s\n' %ex)
 258         sys.stderr.write('%s\n' %traceback.format_exc())
 259         sys.exit(1)
 260
 261     try:
 262         if len(args.path) and args.path[0] == '-':
 263             stdin = os.fdopen(sys.stdin.fileno(), 'rb')
 264             parser.parse_lines(stdin, args.maxlines, '-')
 265         else:
 266             if args.path:
 267                 for p in args.path:
 268                     if os.path.isfile(p):
 269                         parser.parse_lines(open(p, 'rb'), args.maxlines, p)
 270                     elif os.path.isdir(p):
 271                         scan_git_subtree(repo.head.reference.commit.tree, p)
 272                     else:
 273                         sys.stderr.write('path %s does not exist\n' %p)
 274                         sys.exit(1)
 275             else:
 276                 # Full git tree scan
 277                 scan_git_tree(repo.head.commit.tree)
 278
 279             if args.verbose:
 280                 sys.stderr.write('\n')
 281                 sys.stderr.write('License files:     %12d\n' %spdx.license_files)
 282                 sys.stderr.write('Exception files:   %12d\n' %spdx.exception_files)
 283                 sys.stderr.write('License IDs        %12d\n' %len(spdx.licenses))
 284                 sys.stderr.write('Exception IDs      %12d\n' %len(spdx.exceptions))
 285                 sys.stderr.write('\n')
 286                 sys.stderr.write('Files checked:     %12d\n' %parser.checked)
 287                 sys.stderr.write('Lines checked:     %12d\n' %parser.lines_checked)
 288                 sys.stderr.write('Files with SPDX:   %12d\n' %parser.spdx_valid)
 289                 sys.stderr.write('Files with errors: %12d\n' %parser.spdx_errors)
 290
 291             sys.exit(0)
 292
 293     except Exception as ex:
 294         sys.stderr.write('FAIL: %s\n' %ex)
 295         sys.stderr.write('%s\n' %traceback.format_exc())
 296         sys.exit(1)