mirror of
https://github.com/certbot/certbot.git
synced 2026-06-05 06:42:10 -04:00
0dbe17bbd4
In https://github.com/certbot/certbot/pull/8748#discussion_r605457670 we discussed about changing the dict used to set OS options for Apache configurators into a dedicated object. * Create _OsOptions class to configure the os specific options of the Apache configurators * Fix tests * Clean imports * Fix naming * Fix compatibility tests * Rename a class * Ensure restart_cmd_alt is set for specific OSes. * Add docstring * Fix override * Fix coverage
64 lines
2.4 KiB
Python
64 lines
2.4 KiB
Python
""" Distribution specific override class for Gentoo Linux """
|
|
import zope.interface
|
|
|
|
from certbot import interfaces
|
|
from certbot_apache._internal import apache_util
|
|
from certbot_apache._internal import configurator
|
|
from certbot_apache._internal import parser
|
|
from certbot_apache._internal.configurator import OsOptions
|
|
|
|
|
|
@zope.interface.provider(interfaces.IPluginFactory)
|
|
class GentooConfigurator(configurator.ApacheConfigurator):
|
|
"""Gentoo specific ApacheConfigurator override class"""
|
|
|
|
OS_DEFAULTS = OsOptions(
|
|
server_root="/etc/apache2",
|
|
vhost_root="/etc/apache2/vhosts.d",
|
|
vhost_files="*.conf",
|
|
restart_cmd_alt=['apache2ctl', 'restart'],
|
|
challenge_location="/etc/apache2/vhosts.d",
|
|
)
|
|
|
|
def _prepare_options(self):
|
|
"""
|
|
Override the options dictionary initialization in order to support
|
|
alternative restart cmd used in Gentoo.
|
|
"""
|
|
super()._prepare_options()
|
|
if not self.options.restart_cmd_alt: # pragma: no cover
|
|
raise ValueError("OS option restart_cmd_alt must be set for Gentoo.")
|
|
self.options.restart_cmd_alt[0] = self.options.ctl
|
|
|
|
def get_parser(self):
|
|
"""Initializes the ApacheParser"""
|
|
return GentooParser(
|
|
self.options.server_root, self.options.vhost_root,
|
|
self.version, configurator=self)
|
|
|
|
|
|
class GentooParser(parser.ApacheParser):
|
|
"""Gentoo specific ApacheParser override class"""
|
|
def __init__(self, *args, **kwargs):
|
|
# Gentoo specific configuration file for Apache2
|
|
self.apacheconfig_filep = "/etc/conf.d/apache2"
|
|
super().__init__(*args, **kwargs)
|
|
|
|
def update_runtime_variables(self):
|
|
""" Override for update_runtime_variables for custom parsing """
|
|
self.parse_sysconfig_var()
|
|
self.update_modules()
|
|
|
|
def parse_sysconfig_var(self):
|
|
""" Parses Apache CLI options from Gentoo configuration file """
|
|
defines = apache_util.parse_define_file(self.apacheconfig_filep,
|
|
"APACHE2_OPTS")
|
|
for k in defines:
|
|
self.variables[k] = defines[k]
|
|
|
|
def update_modules(self):
|
|
"""Get loaded modules from httpd process, and add them to DOM"""
|
|
mod_cmd = [self.configurator.options.ctl, "modules"]
|
|
matches = apache_util.parse_from_subprocess(mod_cmd, r"(.*)_module")
|
|
for mod in matches:
|
|
self.add_mod(mod.strip())
|