mirror of
https://github.com/certbot/certbot.git
synced 2026-06-04 06:15:36 -04:00
7bff0a02e4
This PR adds two new command line parameters, --apache-ctlpath and --apache-binpath both of which are used to construct commands that we shell out for. The way that we previously fetched values either from Certbot configuration object or the dictionary of distribution based constants is now also unified, and the active options are parsed in prepare() to make it easier to override needed values for the distributions needing this behavior. Fixes: #5338 * Added the command line options and parsing * Refactor existing code * Distro override updates * Handle vhost_root from cli * Fix compatibility tests * Add comment about changes to command line arguments * Check None properly * Made help texts consistent * Keep the old defaults * Move to shorter CLI parameter names * No need for specific bin path, nor apache_cmd anymore * Make sure that we use user provided vhost-root value * Fix alt restart commands in overrides * Fix version_cmd defaults in overrides * Fix comparison * Remove cruft, and use configuration object for parser parameter
75 lines
2.7 KiB
Python
75 lines
2.7 KiB
Python
""" Distribution specific override class for Gentoo Linux """
|
|
import pkg_resources
|
|
|
|
import zope.interface
|
|
|
|
from certbot import interfaces
|
|
|
|
from certbot_apache import apache_util
|
|
from certbot_apache import configurator
|
|
from certbot_apache import parser
|
|
|
|
@zope.interface.provider(interfaces.IPluginFactory)
|
|
class GentooConfigurator(configurator.ApacheConfigurator):
|
|
"""Gentoo specific ApacheConfigurator override class"""
|
|
|
|
OS_DEFAULTS = dict(
|
|
server_root="/etc/apache2",
|
|
vhost_root="/etc/apache2/vhosts.d",
|
|
vhost_files="*.conf",
|
|
logs_root="/var/log/apache2",
|
|
ctl="apache2ctl",
|
|
version_cmd=['apache2ctl', '-v'],
|
|
restart_cmd=['apache2ctl', 'graceful'],
|
|
restart_cmd_alt=['apache2ctl', 'restart'],
|
|
conftest_cmd=['apache2ctl', 'configtest'],
|
|
enmod=None,
|
|
dismod=None,
|
|
le_vhost_ext="-le-ssl.conf",
|
|
handle_modules=False,
|
|
handle_sites=False,
|
|
challenge_location="/etc/apache2/vhosts.d",
|
|
MOD_SSL_CONF_SRC=pkg_resources.resource_filename(
|
|
"certbot_apache", "options-ssl-apache.conf")
|
|
)
|
|
|
|
def _prepare_options(self):
|
|
"""
|
|
Override the options dictionary initialization in order to support
|
|
alternative restart cmd used in Gentoo.
|
|
"""
|
|
super(GentooConfigurator, self)._prepare_options()
|
|
self.options["restart_cmd_alt"][0] = self.option("ctl")
|
|
|
|
def get_parser(self):
|
|
"""Initializes the ApacheParser"""
|
|
return GentooParser(
|
|
self.aug, self.option("server_root"), self.option("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(GentooParser, self).__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.keys():
|
|
self.variables[k] = defines[k]
|
|
|
|
def update_modules(self):
|
|
"""Get loaded modules from httpd process, and add them to DOM"""
|
|
mod_cmd = [self.configurator.option("ctl"), "modules"]
|
|
matches = self.parse_from_subprocess(mod_cmd, r"(.*)_module")
|
|
for mod in matches:
|
|
self.add_mod(mod.strip())
|