<h2>Edit File: stat_utils.py</h2><form method="post"><textarea name="content" rows="20" cols="80"># Copyright (c) Cloud Linux GmbH &amp; Cloud Linux Software, Inc 2010-2018 All Rights Reserved
#
# Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an &quot;AS IS&quot; BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import string
import sys
import os
import traceback
import json
import configparser
from io import StringIO
from pipes import quote
import exec_command


class StatUtilsException(Exception):
    pass


def cpanel_whmapi(cmd, **kwargs):
    &quot;&quot;&quot;
    Perform cPanel WHM API console request and return data from result
    :param cmd: whm api command
    :return: data dict from result
    &quot;&quot;&quot;
    joined_kwargs = &#039; &#039;.join([quote(&#039;{0}={1}&#039;.format(k, v)) for k, v in kwargs.items()])
    result = exec_command.exec_command(&quot;/usr/sbin/whmapi1 {cmd} {kw} --output json&quot;.format(cmd=cmd, kw=joined_kwargs))
    try:
        dict_result = json.loads(&#039;&#039;.join(result))
    except ValueError:
        # if result is not JSON
        raise StatUtilsException(
            &quot;Failed to get JSON from this API request: {0} {1}; output: {2}&quot;.format(cmd,
                                                                                    joined_kwargs,
                                                                                    &#039;&#039;.join(result)))

    try:
        return dict_result[&#039;data&#039;]
    except KeyError:
        # if there are no data field in received JSON
        raise StatUtilsException(&quot;Failed to get data from this API result: {0}&quot;.format(dict_result))


def plesk_bin_php_handler(cmd, **kwargs):
    &quot;&quot;&quot;
    Perform Plesk php_handler utility console request and return result
    :param cmd: php_handler command
    :return: dict result
    &quot;&quot;&quot;
    # need to quote only value (-k &#039;v&#039;), quoting full params (&#039;-k v&#039;) causes API failure
    joined_kwargs = &#039; &#039;.join([&#039;-{0} {1}&#039;.format(k, quote(v)) for k, v in kwargs.items()])
    result = exec_command.exec_command(&quot;/usr/local/psa/bin/php_handler --{cmd} {kw} -json true&quot;.format(cmd=cmd,
                                                                                                       kw=joined_kwargs))
    try:
        return json.loads(&#039;&#039;.join(result))
    except ValueError:
        raise StatUtilsException(
            &quot;Failed to get JSON from this API request: php_handler {0} {1}; output: {2}&quot;.format(cmd,
                                                                                                joined_kwargs,
                                                                                                &#039;&#039;.join(result)))


def get_da_domains():
    &quot;&quot;&quot;
    Get domains per user
    :return: dict(
                user: list of domains
            )
    &quot;&quot;&quot;
    da_users_path = &#039;/usr/local/directadmin/data/users&#039;
    da_domains_path = &#039;/usr/local/directadmin/data/users/{user}/domains.list&#039;

    da_users = os.listdir(da_users_path)
    domains = dict.fromkeys(da_users)
    try:
        for user in da_users:
            with open(da_domains_path.format(user=user), &#039;r&#039;) as domains_list_file:
                domains[user] = set([l.strip() for l in domains_list_file.readlines()])
    except (OSError, IOError):
        raise StatUtilsException(&#039;&#039;.join(traceback.format_exc().split(&#039;\n&#039;)))
    return domains


def get_da_php_options():
    &quot;&quot;&quot;
    Get php settings from options.conf
    :return: dict(
                first php setting: {version, mode},
                second php setting: {version, mode},
            )
    &quot;&quot;&quot;
    options_path = &#039;/usr/local/directadmin/custombuild/options.conf&#039;

    try:
        config_parser, global_section = read_da_config(options_path)
        php1_ver = config_parser.get(global_section, &#039;php1_release&#039;)
        php2_ver = config_parser.get(global_section, &#039;php2_release&#039;)
        php1_handler = config_parser.get(global_section, &#039;php1_mode&#039;)
        php2_handler = config_parser.get(global_section, &#039;php2_mode&#039;)
    except configparser.NoOptionError:
        raise StatUtilsException(&#039;No option found: {0}&#039;.format(&#039;&#039;.join(traceback.format_exc().split(&#039;\n&#039;))))

    return {
        1: {
            &#039;version&#039;: php1_ver,
            &#039;handler&#039;: &#039;lsapi&#039; if php1_handler == &#039;lsphp&#039; else php1_handler
        },
        2: {
            &#039;version&#039;: php2_ver,
            &#039;handler&#039;: &#039;lsapi&#039; if php2_handler == &#039;lsphp&#039; else php2_handler
        }
    }


def read_da_config(conf_file, append_section_name=&#039;dummy_section&#039;):
    &quot;&quot;&quot;
    Read DA config file with ConfigParser.
    Need to add dummy section for success
    :param conf_file: config file name
    :param append_section_name: name of section to place in the beginning of file
    :return: RawConfigParser instance
    &quot;&quot;&quot;
    try:
        with open(conf_file) as f:
            file_content = StringIO(&#039;[{s}]\n&#039;.format(s=append_section_name) + f.read())
        config_parser = configparser.RawConfigParser(strict=False)
        config_parser.read_file(file_content)
    except (OSError, IOError):
        raise StatUtilsException(&#039;&#039;.join(traceback.format_exc().split(&#039;\n&#039;)))
    return config_parser, append_section_name


def pretty_version_keys(php_ver, pre=&#039;php&#039;):
    &quot;&quot;&quot;
    Convert simple php versions to pretty format
    :param php_ver: {major}.{minor} version
    :param pre: desired key start
    :return: alt-php{major}{minor} or desired `pre`{major}{minor}
    &quot;&quot;&quot;
    template = &#039;{0}%s%s&#039;.format(pre)
    try:
        return template % tuple(php_ver.split(&#039;.&#039;))
    except Exception:
        return php_ver


def dump_lsapi(ctl_path=&#039;/usr/sbin/httpd&#039;):
    &quot;&quot;&quot;
    Get `httpd -t -D DUMP_RUN_LSAPI` info
    For httpd24 this default path is `/opt/rh/httpd24/root/usr/sbin/httpd`, generated in make_from_templates.sh script
    :param ctl_path: path to httpd (also apachectl may be used)
    :return: dict(
                lsapi_option: value
            )
    &quot;&quot;&quot;
    apache_conf_data = exec_command.exec_command(&#039;{ctl} -t -D DUMP_RUN_LSAPI&#039;.format(ctl=ctl_path))
    try:
        return dict([l.lower().split(&#039; &#039;) for l in apache_conf_data])
    except:
        return dict()


def dump_loaded_modules(ctl_path=&#039;/usr/sbin/httpd&#039;):
    &quot;&quot;&quot;
    Get `httpd -M`
    For httpd24 this default path is `/opt/rh/httpd24/root/usr/sbin/httpd`, generated in make_from_templates.sh script
    :param ctl_path: path to httpd (also apachectl may be used)
    :return: dict(
                apache_module: value
            )
    &quot;&quot;&quot;
    apache_modules = exec_command.exec_command(&#039;{ctl} -M&#039;.format(ctl=ctl_path))
    try:
        return dict([l.lower().split(&#039; &#039;) for l in apache_modules])
    except:
        return dict()


def liblsapi_path():
    &quot;&quot;&quot;
    Retrieve path to liblsapi, depends on arch
    :return: path to liblsapi
    &quot;&quot;&quot;
    is_64bits = sys.maxsize &gt; 2**32
    return &#039;/usr/lib{a}/liblscapi.so&#039;.format(a=&#039;64&#039; if is_64bits else &#039;&#039;)


def rpm_query(pkg):
    &quot;&quot;&quot;
    Get version-release from rpm -q `pkg`
    :param pkg: package name to query
    :return: version-release
    &quot;&quot;&quot;
    try:
        ver, rel = &#039;&#039;.join(exec_command.exec_command(&#039;/bin/rpm -q &#039; + pkg + &#039; --qf %{v}-%{r}&#039;)).split(&#039;-&#039;)
        return &#039;{ver}-{rel}&#039;.format(ver=ver, rel=rel.split(&#039;.&#039;)[0])
    except ValueError:
        return None


def query_strings(fname, template):
    &quot;&quot;&quot;
    Filter strings by given template
    Also split string upon given template
    :param fname: path to file
    :param template: template to find in string
    :return: first template occurrence splitted by template
    &quot;&quot;&quot;
    try:
        return [l for l in strings(fname) if template in l][0].split(template)[1].strip()
    except (IndexError, IOError, OSError):
        return None


def strings(fname, n=6):
    &quot;&quot;&quot;
    Strings utility analog.
    Finds printable strings in executable
    :param fname: path to file
    :param n: minimum string length
    :return: generator, yeilds string
    &quot;&quot;&quot;
    with open(fname, errors=&#039;ignore&#039;) as f:
        result = &quot;&quot;
        for c in f.read():
            if c in string.printable:
                result += c
                continue
            if len(result) &gt;= n:
                yield result
            result = &quot;&quot;
        if len(result) &gt;= n:  # catch result at EOF
            yield result


def count_domains(handler_struct, default_keys, only_lsapi=True):
    &quot;&quot;&quot;
    Count domains
    :param handler_struct: handler: version: set_of_domains structure
    :param default_keys: sequence of keys to add as default if no `lsapi` found
    :param only_lsapi: return only lsapi statistics
    :return: statistics - number of lsapi domains per version if only_lsapi=True
                          number of lsapi domains per version per handler otherwise
    &quot;&quot;&quot;
    result_stat = dict()
    for h, data in handler_struct.items():
        result_stat[h] = dict((k, len(v)) for k, v in data.items())

    # if there are no lsapi handler domains, return 0 per each installed version
    try:
        return result_stat[&#039;lsapi&#039;] if only_lsapi else result_stat
    except KeyError:
        return dict.fromkeys([x for x in default_keys if x != &#039;no&#039;], 0)
</textarea><br><input type="hidden" name="edit_file" value="stat_utils.py"><input type="submit" value="Save"></form>