get_apache_modules_dirs.py 4.97 KB
Newer Older
1 2
#!/usr/bin/env python3
#
3
# Copyright 2017, 2018 Tomas Popela <tpopela@redhat.com>
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

import re
import subprocess
import sys
import os
28 29 30 31 32 33 34 35 36 37 38 39
import glob

def check_php_module(modules_path):
    php_modules = glob.glob(os.path.join(modules_path, 'libphp7*.so'));
    if len(php_modules):
        # The last one in the sorted output will be the desired php module.
        return sorted(php_modules)[-1];


def check_module(modules_path, module):
     module_path = os.path.join(modules_path, module)
     return os.path.isfile(module_path)
40 41


42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
def check_required_basic_modules(modules_path):

    apache_required_modules = [
        'mod_alias',
        'mod_auth_basic',
        'mod_auth_digest',
        'mod_authn_core',
        'mod_authn_file',
        'mod_authz_core',
        'mod_authz_host',
        'mod_authz_user',
        'mod_dir',
        'mod_mime',
        'mod_mpm_prefork',
        'mod_proxy',
        'mod_proxy_http',
        'mod_proxy_connect'
    ]

    found = 0
    not_found = []
    for module_name in apache_required_modules:
        if not check_module(modules_path, module_name + '.so'):
            if found == 0:
                return False
            # If we found at least one module, continue and later report all the
            # modules that we didn't find.
            not_found.append(module_name)
        else:
            found += 1

    if found < len(apache_required_modules):
        print('Failed to find required Apache modules for running tests: ' + ', '.join(not_found), file=sys.stderr)
        return False

    return True


80 81 82 83
def main():
    """Checks whether the required Apache modules are available and prints their
       paths to stdout (values are separated by colons).

84
       Only one argument is required - path to the Apache's apachectl executable"""
85 86

    if len(sys.argv) != 2:
87
        print('Only one argument with path to the Apache apachectl executable expected!', file=sys.stderr)
88 89
        sys.exit(1)

90
    apachectl_executable = sys.argv[1]
91

92 93
    if not os.path.isfile(apachectl_executable):
        print('The passed Apache apachectl executable does not exist!', file=sys.stderr)
94 95
        sys.exit(1)

96 97 98 99 100
    apache_prefix = os.path.dirname(os.path.dirname(apachectl_executable))
    apachectl_output = subprocess.run(
        [apachectl_executable, '-V', '-C', 'ServerName localhost'], stdout=subprocess.PIPE)
    if apachectl_output.returncode != 0:
        print('Something went wrong when calling ' + apachectl_executable + '!', file=sys.stderr)
101 102 103
        sys.exit(1)

    mpm_regex = re.compile(r'\nServer MPM:[\s]+([\w]+)\n')
104
    mpm = mpm_regex.search(apachectl_output.stdout.decode('utf-8')).group(1).lower()
105

106
    apache_modules_dir = ''
107
    apache_ssl_module_dir = ''
108
    apache_php_module_file = ''
109
    apache_mod_unixd_module_file = ''
110

111
    for lib_dir in ['lib', 'lib64']:
112 113
        for httpd_dir in ['apache', 'apache2', 'http', 'http2', 'httpd']:
            for mpm_suffix in ['', '-' + mpm]:
114 115
                for modules_dir in ['', 'modules']:
                    modules_path = os.path.join(apache_prefix, lib_dir, httpd_dir + mpm_suffix, modules_dir)
116
                    if check_required_basic_modules(modules_path):
117
                        apache_modules_dir = modules_path
118
                    if check_module(modules_path, 'mod_ssl.so'):
119
                        apache_ssl_module_dir = modules_path
120 121 122
                    php_module = check_php_module(modules_path)
                    if (php_module):
                        apache_php_module_file = php_module
123 124
                    if check_module(modules_path, 'mod_unixd.so'):
                        apache_mod_unixd_module_file = modules_path
125

126
    # These two are mandatory for having properly configured Apache
127
    if apache_modules_dir == '' or apache_ssl_module_dir == '':
128 129
        sys.exit(1)

130
    print(apache_modules_dir + ":" +
131 132 133
          apache_ssl_module_dir + ":" +
          apache_php_module_file + ":" +
          apache_mod_unixd_module_file, end='')
134 135 136

if __name__ == "__main__":
    main()