build/i18n/tests/check_entities.py

   1 #!/usr/bin/env python
   2 # -----------------------------------------------------------------------
   3 # Copyright (C) 2008  Laurentian University
   4 # Dan Scott <dscott@laurentian.ca>
   5 #
   6 # This program is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU General Public License
   8 # as published by the Free Software Foundation; either version 2
   9 # of the License, or (at your option) any later version.
  10 #
  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 the
  14 # GNU General Public License for more details.
  15 # -----------------------------------------------------------------------
  16
  17 # vim:et:sw=4:ts=4: set fileencoding=utf-8 :
  18
  19 """
  20 Parse DTD files and XUL files looking for trouble
  21     * Missing entities
  22 """
  23
  24 import os
  25 import re
  26
  27 DEBUG = False
  28
  29 DTD_DIRS = (
  30         '../../../Open-ILS/web/opac/locale/en-US/',
  31         )
  32
  33 XUL_DIRS = (
  34         '../../../Open-ILS/xul/staff_client/server/',
  35         '../../../Open-ILS/xul/staff_client/chrome/',
  36         )
  37
  38 def parse_entities():
  39     """
  40     Parse entities files in known places
  41     """
  42
  43     basedir = os.path.normpath(os.path.dirname(os.path.abspath(__file__)))
  44
  45     entities = {
  46         "amp" : "&",
  47         "lt" : "<",
  48         "gt" : ">",
  49         "nbsp" : ">",
  50         "quot" : ">",
  51     }
  52
  53     dtd_files = []
  54
  55     for p_dir in DTD_DIRS:
  56         p_dir = os.path.normpath(os.path.join(basedir, p_dir))
  57         file_list = os.listdir(p_dir)
  58         for d_file in file_list:
  59             if os.path.splitext(d_file)[1] == '.dtd':
  60                 dtd_files.append(os.path.join(p_dir, d_file))
  61
  62     prefix = os.path.commonprefix(dtd_files)
  63
  64     for d_file in dtd_files:
  65
  66         # Get the shortest unique address for this file
  67         short_df = d_file[len(prefix):]
  68
  69         dtd_file = open(d_file, 'r')
  70
  71         line_num = 1
  72
  73         for line in dtd_file:
  74             line_num += 1
  75
  76             # Get rid of trailing linefeed
  77             line = line[0:-1]
  78
  79             # Parse entity/value
  80             unpack = re.search(r'<!ENTITY\s+(.+?)\s+([\'"])(.*?)\2\s*>', line)
  81             if DEBUG and unpack:
  82                 print(unpack.groups())
  83
  84             # Skip anything other than entity definitions
  85             # Note that this makes some massive assumptions:
  86             #   1. that we only have with one entity defined per line
  87             #   2. that we only have single-line entities
  88             #   3. that the entity begins in position 0 on the line
  89             if not unpack or not line or not line.startswith('<!ENTITY'):
  90                 continue
  91
  92             # If we did not retrieve an entity and definition, that's probably not good
  93             if len(unpack.groups()) != 3:
  94                 print("%s:%d: No entity defined on line [%s]" % (short_df, line_num, line))
  95                 continue
  96
  97             entity_key, quote, value = unpack.groups()
  98             if DEBUG:
  99                 print(entity_key, value)
 100
 101             if not entities.has_key(entity_key):
 102                 entities[entity_key] = [{'value': value, 'file': short_df}]
 103                 continue
 104
 105             for entry in entities[entity_key]:
 106                 if entry['file'] == short_df:
 107                     print("%s:%d: Duplicate key '%s' in line [%s]" % (short_df, line_num, entity_key, line[0:-1]))
 108                     continue
 109
 110             entities[entity_key].append({'value': value, 'file': short_df})
 111
 112         dtd_file.close()
 113
 114     return entities
 115
 116 def check_xul_files(entities):
 117     """
 118     Finds all the XUL and JavaScript files
 119     """
 120
 121     basedir = os.path.normpath(os.path.dirname(os.path.abspath(__file__)))
 122
 123     xul_files = []
 124
 125     for x_dir in XUL_DIRS:
 126         for root, dirs, files in os.walk(x_dir):
 127             for x_file in files:
 128                 if os.path.splitext(x_file)[1] == '.xul' or os.path.splitext(x_file)[1] == '.js':
 129                     check_xul(root, x_file, entities)
 130
 131 def check_xul(root, filename, entities):
 132     """
 133     Checks all XUL files to ensure:
 134       * that the requested entity exists
 135       * that every entity is actually required
 136     """
 137
 138     num_strings = 0
 139
 140     # Typical entity usage:
 141     # &blah.blah.blah_bity.blah;
 142     strings = re.compile(r'''&([a-zA-Z:_][a-zA-Z0-9:_\-.]+);''')
 143
 144     xul = open(os.path.join(root, filename), 'r')
 145     content = xul.read()
 146     xul.close()
 147
 148     if DEBUG:
 149         print("File: %s" % (os.path.normpath(os.path.join(root, filename))))
 150
 151     for s_match in strings.finditer(content):
 152         num_strings += 1
 153         if not entities.has_key(s_match.group(1)):
 154             print("File: %s" % (os.path.normpath(os.path.join(root, filename))))
 155             print("\tEntity %s not found, expected in %s" % (s_match.group(1), 'lang.dtd'))
 156
 157         # Find bad entities
 158         bad_strings = re.compile(r'''&([^a-zA-Z:_]?[a-zA-Z0-9:_]*[^a-zA-Z0-9:_\-.;][a-zA-Z0-9:_\-.]*);''')
 159
 160         # Match character entities (&#0129; etc), which are okay
 161         char_entity = re.compile(r'''^((#([0-9])+)|(#x([0-9a-fA-F])+))$''')
 162
 163         for s_match in bad_strings.finditer(content):
 164                 # Rule out character entities and URL concatenation
 165                 if (not char_entity.search(s_match.group(1))) and s_match.group(1) != "'":
 166                         print("File: %s" % (os.path.normpath(os.path.join(root, filename))))
 167                         print("\tBad entity: %s" % (s_match.group(1)))
 168
 169     if DEBUG:
 170         print("\t%d entities found" % (num_strings))
 171
 172 if __name__ == '__main__':
 173     entities = parse_entities()
 174     check_xul_files(entities)