svnmailer.config

74 """ Provide settings from config 75 76 @cvar MAPSECTION: The mapping section name; if C{None}, 77 mapping is effectively disabled 78 @type MAPSECTION: C{str} 79 80 @ivar _config: The config object 81 @type _config: C{ConfigParser.ConfigParser} 82 """ 83 __implements__ = [settings.Settings] 84 85 MAPSECTION = "maps" 86

87 - def init(self, *args, **kwargs):

88 """ Implements the C{init} method of L{settings.Settings} 89 90 @exception ConfigInvalidError: invalid config options 91 @exception ConfigMissingError: see L{_loadConfig} 92 @exception ConfigNotFoundError: see L{_loadConfig} 93 @exception ConfigSectionNotFoundError: see L{_passConfig} 94 @exception ConfigOptionUnkownError: see L{_passConfig} 95 @exception ConfigMappingSpecInvalidError: see L{_applyMaps} 96 @exception ConfigMappingSectionNotFoundError: see L{_getPlainMap} 97 """ 98 try: 99 self._init(*args, **kwargs) 100 except (ValueError, TypeError, UnicodeError, ConfigParser.Error), exc: 101 raise ConfigInvalidError, str(exc), sys.exc_info()[2]

102 103

104 - def _init(self, options):

105 """ Actual implementation of C{self.init()} 106 107 @param options: runtime options 108 @type options: C{optparse.OptionParser} 109 110 @exception ConfigMissingError: see L{_loadConfig} 111 @exception ConfigNotFoundError: see L{_loadConfig} 112 @exception ConfigSectionNotFoundError: see L{_passConfig} 113 @exception ConfigOptionUnkownError: see L{_passConfig} 114 @exception ConfigMappingSpecInvalidError: see L{_applyMaps} 115 @exception ConfigMappingSectionNotFoundError: see L{_getPlainMap} 116 """ 117 self._initRuntime(options) 118 self._loadConfig() # needs runtime 119 self._initGeneral() # needs _config 120 self._initGroups() # needs _config and general

121 122

123 - def _initGroups(self):

124 """ Initializes the Group config """ 125 defaults = self._getGroupDefaults() 126 ddict = self._getDefaultGroupDict(defaults) 127 128 for group in self._config.sections(): 129 ddict["_name"] = group 130 container = self.getGroupContainer(**ddict) 131 self._passConfig(container, group) 132 self.groups.append(container) 133 134 if not self.groups: 135 self.groups.append(self.getGroupContainer(**defaults._dict_))

136 137

138 - def _getDefaultGroupDict(self, container):

139 """ Returns the default group dict 140 141 @param container: The default container 142 @type container: C{svnmailer.settings.GroupSettingsContainer} 143 144 @return: The default dict 145 @rtype: C{dict} 146 """ 147 ddict = dict(container._dict_) 148 ddict.update({ 149 "_def_for_repos": container.for_repos, 150 "_def_for_paths": container.for_paths, 151 }) 152 153 return ddict

154 155

156 - def _getGroupDefaults(self):

157 """ Returns the default groups container 158 159 @return: The defaults (groupcontainer without maps) 160 @rtype: C{svnmailer.settings.GroupSettingsContainer} 161 """ 162 defaults = self.getDefaultGroupContainer( 163 _name = "defaults", 164 diff_command = self.general.diff_command, 165 cia_rpc_server = self.general.cia_rpc_server, 166 ) 167 try: 168 self._passConfig(defaults, "defaults") 169 except ConfigSectionNotFoundError: 170 # [defaults] is optional 171 pass 172 else: 173 self._config.remove_section('defaults') 174 175 return defaults

176 177

178 - def _initGeneral(self):

179 """ Initializes the general config 180 181 @exception ConfigSectionNotFoundError: [general] not found 182 """ 183 self.general = self.getGeneralContainer() 184 self._passConfig(self.general, 'general') 185 self._config.remove_section('general')

186 187

188 - def _initRuntime(self, options):

189 """ Initializes the runtime from options 190 191 @param options: runtime options 192 @type options: C{optparse.OptionParser} 193 """ 194 # This is needed for every container 195 self._fcharset_ = options.path_encoding 196 197 self.runtime = self.getRuntimeContainer( 198 revision = options.revision, 199 repository = options.repository, 200 path_encoding = options.path_encoding, 201 debug = options.debug, 202 config = options.config, 203 mode = options.mode, 204 author = options.author, 205 propname = options.propname, 206 action = options.action, 207 )

208 209

210 - def _passConfig(self, container, section):

211 """ Passes the options to the specified container 212 213 @param container: The container object 214 @type container: C{svnmailer.util.Struct} 215 216 @param section: The config section name 217 @type section: C{str} 218 219 @exception ConfigSectionNotFoundError: The specified section was 220 not found in the config file 221 @exception ConfigOptionUnkownError: There was an unknown 222 config option in the config file. 223 """ 224 try: 225 for option in self._config.options(section): 226 # options starting with _ are for internal usage 227 if option[:1] in ('_', '-'): 228 raise ConfigOptionUnknownError( 229 "Unknown option '%s' in section [%s]" % 230 (option, section) 231 ) 232 233 try: 234 container._set_( 235 option.replace('-', '_'), 236 self._config.get(section, option, raw = True) 237 ) 238 except AttributeError: 239 raise ConfigOptionUnknownError( 240 "Unknown option '%s' in section [%s]" % 241 (option, section) 242 ) 243 except ConfigParser.NoSectionError, exc: 244 raise ConfigSectionNotFoundError(str(exc))

245 246

247 - def _loadConfig(self):

248 """ Parse config file 249 250 @return: parsed config 251 @rtype: C{ConfigParser.ConfigParser} 252 253 @exception ConfigNotFoundError: some configfile could not 254 be opened 255 @exception ConfigMissingError: see L{_findConfig} 256 @exception ConfigMappingSpecInvalidError: see L{_applyMaps} 257 @exception ConfigMappingSectionNotFoundError: see L{_getPlainMap} 258 """ 259 config_fp = self._findConfig() 260 self._config = self._createConfigParser() 261 try: 262 self._config.readfp(config_fp, config_fp.name) 263 config_fp.close() 264 except IOError, exc: 265 raise ConfigNotFoundError("%s: %s" % (config_fp.name, str(exc))) 266 267 if self._config.has_section("general"): 268 self._applyCharset() 269 self._applyIncludes(config_fp.name) 270 271 self._applyMaps()

272 273

274 - def _createConfigParser(self):

275 """ Returns a ConfigParser instance 276 277 @return: The ConfigParser instance 278 @rtype: C{ConfigParser.ConfigParser} 279 """ 280 return ConfigParser.ConfigParser()

281 282

283 - def _findConfig(self, _file = file):

284 """ Finds and opens the main config file 285 286 @param _file: The function to open the file 287 @type _file: C{callable} 288 289 @return: The open descriptor 290 @rtype: file like object 291 292 @exception ConfigMissingError: config neither specified nor 293 on default locations found. Default locations are (tried 294 in that order): 295 - <repos>/conf/mailer.conf 296 - <scriptdir>/mailer.conf 297 - /etc/svn-mailer.conf 298 @exception ConfigNotFoundError: specified configfile could not 299 be opened 300 """ 301 import errno 302 303 config_file = self.runtime.config 304 if config_file: 305 try: 306 return config_file == '-' and sys.stdin or _file(config_file) 307 except IOError, exc: 308 raise ConfigNotFoundError("%s: %s" % (config_file, str(exc))) 309 310 for config_file in self._getDefaultConfigFiles(): 311 try: 312 return _file(config_file) 313 except IOError, exc: 314 # try next one only if not found 315 if exc[0] != errno.ENOENT: 316 raise ConfigNotFoundError("%s: %s" % ( 317 config_file, str(exc) 318 )) 319 320 raise ConfigMissingError("No config file found")

321 322

323 - def _applyMaps(self):

324 """ Resolves all map definitions 325 326 @TODO: raise an error on unknown options 327 328 @exception ConfigMappingSpecInvalidError: The mapping spec was 329 invalid 330 @exception ConfigMappingSectionNotFoundError: see L{_getPlainMap} 331 """ 332 section = self.MAPSECTION 333 if section is None or not self._config.has_section(section): 334 return 335 336 self._maps_ = {} 337 remove_sections = [section] 338 for option in self._config.options(section): 339 if option[:1] in ('_', '-'): 340 raise ConfigOptionUnknownError( 341 "Unknown option '%s' in section [%s]" % 342 (option, section) 343 ) 344 345 value = self._config.get(section, option, raw = True) 346 if value[:1] == '[' and value[-1:] == ']': 347 this_section = value[1:-1] 348 self._maps_[option.replace('-', '_')] = \ 349 self._getPlainMap(this_section) 350 remove_sections.append(this_section) 351 else: 352 raise ConfigMappingSpecInvalidError( 353 "Invalid mapping specification %r = %r" % (option, value) 354 ) 355 356 for name in dict.fromkeys(remove_sections).keys(): 357 self._config.remove_section(name)

358 359

360 - def _getPlainMap(self, section):

361 """ Returns a plain map for a particular section 362 363 @param section: The mapping section 364 @type section: C{str} 365 366 @return: The mapping function 367 @rtype: C{callable} 368 369 @exception ConfigMappingSectionNotFoundError: The specified 370 section was not found 371 """ 372 try: 373 mdict = dict([ 374 (option, self._config.get(section, option, raw = True)) 375 for option in self._config.options(section) 376 ]) 377 except ConfigParser.NoSectionError, exc: 378 raise ConfigMappingSectionNotFoundError(str(exc)) 379 380 def mapfunc(value): 381 """ Mapping function """ 382 return mdict.get(value, value)

383 384 return mapfunc

Source Code for Module svnmailer.config