bin/parseConfigFile.py

   1 # Copyright (C) 2013-2016  CEA/DEN, EDF R&D, OPEN CASCADE
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 #
  17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 #
  19
  20 import configparser
  21 import os
  22 import logging
  23 import re
  24 from io import StringIO
  25 import subprocess
  26 from salomeContextUtils import SalomeContextException #@UnresolvedImport
  27
  28 logging.basicConfig()
  29 logConfigParser = logging.getLogger(__name__)
  30
  31 ADD_TO_PREFIX = 'ADD_TO_'
  32 UNSET_KEYWORD = 'UNSET'
  33
  34
  35 def _expandSystemVariables(key, val):
  36   expandedVal = os.path.expandvars(val) # expand environment variables
  37   # Search for not expanded variables (i.e. non-existing environment variables)
  38   pattern = re.compile('\${ ( [^}]* ) }', re.VERBOSE) # string enclosed in ${ and }
  39   expandedVal = pattern.sub(r'', expandedVal) # remove matching patterns
  40
  41   if not "DLIM8VAR" in key: # special case: DISTENE licence key can contain double clons (::)
  42     expandedVal = _trimColons(expandedVal)
  43   return expandedVal
  44 #
  45
  46 # :TRICKY: So ugly solution...
  47 class MultiOptSafeConfigParser(configparser.SafeConfigParser):
  48   def __init__(self):
  49     configparser.SafeConfigParser.__init__(self)
  50
  51   # copied from python 2.6.8 Lib.ConfigParser.py
  52   # modified (see code comments) to handle duplicate keys
  53   def _read(self, fp, fpname):
  54     """Parse a sectioned setup file.
  55
  56     The sections in setup file contains a title line at the top,
  57     indicated by a name in square brackets (`[]'), plus key/value
  58     options lines, indicated by `name: value' format lines.
  59     Continuations are represented by an embedded newline then
  60     leading whitespace.  Blank lines, lines beginning with a '#',
  61     and just about everything else are ignored.
  62     """
  63     cursect = None                        # None, or a dictionary
  64     optname = None
  65     lineno = 0
  66     e = None                              # None, or an exception
  67     while True:
  68       line = fp.readline()
  69       if not line:
  70         break
  71       lineno = lineno + 1
  72       # comment or blank line?
  73       if line.strip() == '' or line[0] in '#;':
  74         continue
  75       if line.split(None, 1)[0].lower() == 'rem' and line[0] in "rR":
  76         # no leading whitespace
  77         continue
  78       # continuation line?
  79       if line[0].isspace() and cursect is not None and optname:
  80         value = line.strip()
  81         if value:
  82           cursect[optname].append(value)
  83       # a section header or option header?
  84       else:
  85         # is it a section header?
  86         mo = self.SECTCRE.match(line)
  87         if mo:
  88           sectname = mo.group('header')
  89           if sectname in self._sections:
  90             cursect = self._sections[sectname]
  91           elif sectname == configparser.DEFAULTSECT:
  92             cursect = self._defaults
  93           else:
  94             cursect = self._dict()
  95             cursect['__name__'] = sectname
  96             self._sections[sectname] = cursect
  97           # So sections can't start with a continuation line
  98           optname = None
  99         # no section header in the file?
 100         elif cursect is None:
 101           raise configparser.MissingSectionHeaderError(fpname, lineno, line)
 102         # an option line?
 103         else:
 104           mo = self.OPTCRE.match(line)
 105           if mo:
 106             optname, vi, optval = mo.group('option', 'vi', 'value')
 107             optname = self.optionxform(optname.rstrip())
 108             # This check is fine because the OPTCRE cannot
 109             # match if it would set optval to None
 110             if optval is not None:
 111               if vi in ('=', ':') and ';' in optval:
 112                 # ';' is a comment delimiter only if it follows
 113                 # a spacing character
 114                 pos = optval.find(';')
 115                 if pos != -1 and optval[pos-1].isspace():
 116                   optval = optval[:pos]
 117               optval = optval.strip()
 118               # ADD THESE LINES
 119               splittedComments = optval.split('#')
 120               s = _expandSystemVariables(optname, splittedComments[0])
 121               optval = s.strip().strip("'").strip('"')
 122               #if len(splittedComments) > 1:
 123               #  optval += " #" + " ".join(splittedComments[1:])
 124               # END OF ADD
 125               # allow empty values
 126               if optval == '""':
 127                 optval = ''
 128               # REPLACE following line (original):
 129               #cursect[optname] = [optval]
 130               # BY THESE LINES:
 131               # Check if this optname already exists
 132               if (optname in cursect) and (cursect[optname] is not None):
 133                 cursect[optname][0] += ','+optval
 134               else:
 135                 cursect[optname] = [optval]
 136               # END OF SUBSTITUTION
 137             else:
 138               # valueless option handling
 139               cursect[optname] = optval
 140           else:
 141             # a non-fatal parsing error occurred.  set up the
 142             # exception but keep going. the exception will be
 143             # raised at the end of the file and will contain a
 144             # list of all bogus lines
 145             if not e:
 146               e = configparser.ParsingError(fpname)
 147             e.append(lineno, repr(line))
 148     # if any parsing errors occurred, raise an exception
 149     if e:
 150       raise e
 151
 152     # join the multi-line values collected while reading
 153     all_sections = [self._defaults]
 154     all_sections.extend(list(self._sections.values()))
 155     for options in all_sections:
 156       for name, val in list(options.items()):
 157         if isinstance(val, list):
 158           options[name] = '\n'.join(val)
 159   #
 160
 161
 162 # Parse configuration file
 163 # Input: filename, and a list of reserved keywords (environment variables)
 164 # Output: a list of pairs (variable, value), and a dictionary associating a list of user-defined values to each reserved keywords
 165 # Note: Does not support duplicate keys in a same section
 166 def parseConfigFile(filename, reserved = None):
 167   if reserved is None:
 168     reserved = []
 169   config = MultiOptSafeConfigParser()
 170   config.optionxform = str # case sensitive
 171
 172   # :TODO: test file existence
 173
 174   # Read config file
 175   try:
 176     config.read(filename)
 177   except configparser.MissingSectionHeaderError:
 178     logConfigParser.error("No section found in file: %s"%(filename))
 179     return []
 180
 181   try:
 182     return __processConfigFile(config, reserved, filename)
 183   except configparser.InterpolationMissingOptionError as e:
 184     msg = "A variable may be undefined in SALOME context file: %s\nParser error is: %s\n"%(filename, e)
 185     raise SalomeContextException(msg)
 186 #
 187
 188 def __processConfigFile(config, reserved = None, filename="UNKNOWN FILENAME"):
 189   # :TODO: may detect duplicated variables in the same section (raise a warning)
 190   #        or even duplicate sections
 191
 192   if reserved is None:
 193     reserved = []
 194   unsetVariables = []
 195   outputVariables = []
 196   # Get raw items for each section, and make some processing for environment variables management
 197   reservedKeys = [ADD_TO_PREFIX+str(x) for x in reserved] # produce [ 'ADD_TO_reserved_1', 'ADD_TO_reserved_2', ..., ADD_TO_reserved_n ]
 198   reservedValues = dict([str(i),[]] for i in reserved) # create a dictionary in which keys are the 'ADD_TO_reserved_i' and associated values are empty lists: { 'reserved_1':[], 'reserved_2':[], ..., reserved_n:[] }
 199   sections = config.sections()
 200   for section in sections:
 201     entries = config.items(section, raw=False) # use interpolation
 202     if len(entries) == 0: # empty section
 203       logConfigParser.warning("Empty section: %s in file: %s"%(section, filename))
 204       pass
 205     for key,val in entries:
 206       if key in reserved:
 207         logConfigParser.error("Invalid use of reserved variable: %s in file: %s"%(key, filename))
 208       elif key == UNSET_KEYWORD:
 209         unsetVariables += val.replace(',', ' ').split()
 210       else:
 211         expandedVal = _expandSystemVariables(key, val)
 212
 213         if key in reservedKeys:
 214           shortKey = key[len(ADD_TO_PREFIX):]
 215           vals = expandedVal.split(',')
 216           reservedValues[shortKey] += vals
 217           # remove left&right spaces on each element
 218           vals = [v.strip(' \t\n\r') for v in vals]
 219         else:
 220           outputVariables.append((key, expandedVal))
 221           pass
 222         pass # end if key
 223       pass # end for key,val
 224     pass # end for section
 225
 226   # remove duplicate values
 227   outVars = []
 228   for (var, values) in outputVariables:
 229     vals = values.split(',')
 230     vals = list(set(vals))
 231     outVars.append((var, ','.join(vals)))
 232
 233   return unsetVariables, outVars, reservedValues
 234 #
 235
 236 def _trimColons(var):
 237   v = var
 238   # Remove leading and trailing colons (:)
 239   pattern = re.compile('^:+ | :+$', re.VERBOSE)
 240   v = pattern.sub(r'', v) # remove matching patterns
 241   # Remove multiple colons
 242   pattern = re.compile('::+', re.VERBOSE)
 243   v = pattern.sub(r':', v) # remove matching patterns
 244   return v
 245 #