nominatim/tokenizer/icu_rule_loader.py

   1 """
   2 Helper class to create ICU rules from a configuration file.
   3 """
   4 import io
   5 import json
   6 import logging
   7 import itertools
   8 import re
   9
  10 from icu import Transliterator
  11
  12 from nominatim.config import flatten_config_list
  13 from nominatim.db.properties import set_property, get_property
  14 from nominatim.errors import UsageError
  15 from nominatim.tokenizer.icu_name_processor import ICUNameProcessor
  16 from nominatim.tokenizer.place_sanitizer import PlaceSanitizer
  17 import nominatim.tokenizer.icu_variants as variants
  18
  19 LOG = logging.getLogger()
  20
  21 DBCFG_IMPORT_NORM_RULES = "tokenizer_import_normalisation"
  22 DBCFG_IMPORT_TRANS_RULES = "tokenizer_import_transliteration"
  23 DBCFG_IMPORT_ANALYSIS_RULES = "tokenizer_import_analysis_rules"
  24
  25
  26 class VariantRule:
  27     """ Saves a single variant expansion.
  28
  29         An expansion consists of the normalized replacement term and
  30         a dicitonary of properties that describe when the expansion applies.
  31     """
  32
  33     def __init__(self, replacement, properties):
  34         self.replacement = replacement
  35         self.properties = properties or {}
  36
  37
  38 class ICURuleLoader:
  39     """ Compiler for ICU rules from a tokenizer configuration file.
  40     """
  41
  42     def __init__(self, config):
  43         rules = config.load_sub_configuration('icu_tokenizer.yaml',
  44                                               config='TOKENIZER_CONFIG')
  45
  46         self.normalization_rules = self._cfg_to_icu_rules(rules, 'normalization')
  47         self.transliteration_rules = self._cfg_to_icu_rules(rules, 'transliteration')
  48         self.analysis_rules = self._get_section(rules, 'token-analysis')
  49         self._setup_analysis()
  50
  51         # Load optional sanitizer rule set.
  52         self.sanitizer_rules = rules.get('sanitizers', [])
  53
  54
  55     def load_config_from_db(self, conn):
  56         """ Get previously saved parts of the configuration from the
  57             database.
  58         """
  59         self.normalization_rules = get_property(conn, DBCFG_IMPORT_NORM_RULES)
  60         self.transliteration_rules = get_property(conn, DBCFG_IMPORT_TRANS_RULES)
  61         self.analysis_rules = json.loads(get_property(conn, DBCFG_IMPORT_ANALYSIS_RULES))
  62         self._setup_analysis()
  63
  64
  65     def save_config_to_db(self, conn):
  66         """ Save the part of the configuration that cannot be changed into
  67             the database.
  68         """
  69         set_property(conn, DBCFG_IMPORT_NORM_RULES, self.normalization_rules)
  70         set_property(conn, DBCFG_IMPORT_TRANS_RULES, self.transliteration_rules)
  71         set_property(conn, DBCFG_IMPORT_ANALYSIS_RULES, json.dumps(self.analysis_rules))
  72
  73
  74     def make_sanitizer(self):
  75         """ Create a place sanitizer from the configured rules.
  76         """
  77         return PlaceSanitizer(self.sanitizer_rules)
  78
  79
  80     def make_token_analysis(self):
  81         """ Create a token analyser from the reviouly loaded rules.
  82         """
  83         return self.analysis[None].create(self.normalization_rules,
  84                                           self.transliteration_rules)
  85
  86
  87     def get_search_rules(self):
  88         """ Return the ICU rules to be used during search.
  89             The rules combine normalization and transliteration.
  90         """
  91         # First apply the normalization rules.
  92         rules = io.StringIO()
  93         rules.write(self.normalization_rules)
  94
  95         # Then add transliteration.
  96         rules.write(self.transliteration_rules)
  97         return rules.getvalue()
  98
  99
 100     def get_normalization_rules(self):
 101         """ Return rules for normalisation of a term.
 102         """
 103         return self.normalization_rules
 104
 105
 106     def get_transliteration_rules(self):
 107         """ Return the rules for converting a string into its asciii representation.
 108         """
 109         return self.transliteration_rules
 110
 111
 112     def _setup_analysis(self):
 113         """ Process the rules used for creating the various token analyzers.
 114         """
 115         self.analysis = {}
 116
 117         if not isinstance(self.analysis_rules, list):
 118             raise UsageError("Configuration section 'token-analysis' must be a list.")
 119
 120         for section in self.analysis_rules:
 121             name = section.get('id', None)
 122             if name in self.analysis:
 123                 if name is None:
 124                     LOG.fatal("ICU tokenizer configuration has two default token analyzers.")
 125                 else:
 126                     LOG.fatal("ICU tokenizer configuration has two token "
 127                               "analyzers with id '%s'.", name)
 128                 UsageError("Syntax error in ICU tokenizer config.")
 129             self.analysis[name] = TokenAnalyzerRule(section, self.normalization_rules)
 130
 131
 132     @staticmethod
 133     def _get_section(rules, section):
 134         """ Get the section named 'section' from the rules. If the section does
 135             not exist, raise a usage error with a meaningful message.
 136         """
 137         if section not in rules:
 138             LOG.fatal("Section '%s' not found in tokenizer config.", section)
 139             raise UsageError("Syntax error in tokenizer configuration file.")
 140
 141         return rules[section]
 142
 143
 144     def _cfg_to_icu_rules(self, rules, section):
 145         """ Load an ICU ruleset from the given section. If the section is a
 146             simple string, it is interpreted as a file name and the rules are
 147             loaded verbatim from the given file. The filename is expected to be
 148             relative to the tokenizer rule file. If the section is a list then
 149             each line is assumed to be a rule. All rules are concatenated and returned.
 150         """
 151         content = self._get_section(rules, section)
 152
 153         if content is None:
 154             return ''
 155
 156         return ';'.join(flatten_config_list(content, section)) + ';'
 157
 158
 159 class TokenAnalyzerRule:
 160     """ Factory for a single analysis module. The class saves the configuration
 161         and creates a new token analyzer on request.
 162     """
 163
 164     def __init__(self, rules, normalization_rules):
 165         self._parse_variant_list(rules.get('variants'), normalization_rules)
 166
 167
 168     def create(self, normalization_rules, transliteration_rules):
 169         """ Create an analyzer from the given rules.
 170         """
 171         return ICUNameProcessor(normalization_rules,
 172                                 transliteration_rules,
 173                                 self.variants)
 174
 175
 176     def _parse_variant_list(self, rules, normalization_rules):
 177         self.variants = set()
 178
 179         if not rules:
 180             return
 181
 182         rules = flatten_config_list(rules, 'variants')
 183
 184         vmaker = _VariantMaker(normalization_rules)
 185
 186         properties = []
 187         for section in rules:
 188             # Create the property field and deduplicate against existing
 189             # instances.
 190             props = variants.ICUVariantProperties.from_rules(section)
 191             for existing in properties:
 192                 if existing == props:
 193                     props = existing
 194                     break
 195             else:
 196                 properties.append(props)
 197
 198             for rule in (section.get('words') or []):
 199                 self.variants.update(vmaker.compute(rule, props))
 200
 201
 202 class _VariantMaker:
 203     """ Generater for all necessary ICUVariants from a single variant rule.
 204
 205         All text in rules is normalized to make sure the variants match later.
 206     """
 207
 208     def __init__(self, norm_rules):
 209         self.norm = Transliterator.createFromRules("rule_loader_normalization",
 210                                                    norm_rules)
 211
 212
 213     def compute(self, rule, props):
 214         """ Generator for all ICUVariant tuples from a single variant rule.
 215         """
 216         parts = re.split(r'(\|)?([=-])>', rule)
 217         if len(parts) != 4:
 218             raise UsageError("Syntax error in variant rule: " + rule)
 219
 220         decompose = parts[1] is None
 221         src_terms = [self._parse_variant_word(t) for t in parts[0].split(',')]
 222         repl_terms = (self.norm.transliterate(t.strip()) for t in parts[3].split(','))
 223
 224         # If the source should be kept, add a 1:1 replacement
 225         if parts[2] == '-':
 226             for src in src_terms:
 227                 if src:
 228                     for froms, tos in _create_variants(*src, src[0], decompose):
 229                         yield variants.ICUVariant(froms, tos, props)
 230
 231         for src, repl in itertools.product(src_terms, repl_terms):
 232             if src and repl:
 233                 for froms, tos in _create_variants(*src, repl, decompose):
 234                     yield variants.ICUVariant(froms, tos, props)
 235
 236
 237     def _parse_variant_word(self, name):
 238         name = name.strip()
 239         match = re.fullmatch(r'([~^]?)([^~$^]*)([~$]?)', name)
 240         if match is None or (match.group(1) == '~' and match.group(3) == '~'):
 241             raise UsageError("Invalid variant word descriptor '{}'".format(name))
 242         norm_name = self.norm.transliterate(match.group(2))
 243         if not norm_name:
 244             return None
 245
 246         return norm_name, match.group(1), match.group(3)
 247
 248
 249 _FLAG_MATCH = {'^': '^ ',
 250                '$': ' ^',
 251                '': ' '}
 252
 253
 254 def _create_variants(src, preflag, postflag, repl, decompose):
 255     if preflag == '~':
 256         postfix = _FLAG_MATCH[postflag]
 257         # suffix decomposition
 258         src = src + postfix
 259         repl = repl + postfix
 260
 261         yield src, repl
 262         yield ' ' + src, ' ' + repl
 263
 264         if decompose:
 265             yield src, ' ' + repl
 266             yield ' ' + src, repl
 267     elif postflag == '~':
 268         # prefix decomposition
 269         prefix = _FLAG_MATCH[preflag]
 270         src = prefix + src
 271         repl = prefix + repl
 272
 273         yield src, repl
 274         yield src + ' ', repl + ' '
 275
 276         if decompose:
 277             yield src, repl + ' '
 278             yield src + ' ', repl
 279     else:
 280         prefix = _FLAG_MATCH[preflag]
 281         postfix = _FLAG_MATCH[postflag]
 282
 283         yield prefix + src + postfix, prefix + repl + postfix