detain/myadmin-cpanel-licensing

<?php
/**
 * License Related Functionality
 * @author Joe Huss <detain@interserver.net>
 * @copyright 2019
 * @package MyAdmin
 * @category Licenses
 */

/**
 * activate_cpanel()
 * activates a cpanel license
 *
 * @param string $ipAddress ip address to activate
 * @param integer $package the package type to activate
 * @return string the response and command sent to activate cpanel
 */
function activate_cpanel($ipAddress, $package)
{
    $module = 'licenses';
    $package = (int) $package;
    myadmin_log('licenses', 'info', "activate_cpanel($ipAddress, $package) Called", __LINE__, __FILE__);
    $cpl = new \Detain\Cpanel\Cpanel(CPANEL_LICENSING_USERNAME, CPANEL_LICENSING_PASSWORD);
    //$groups = $cpl->fetchGroups();
    //myadmin_log('licenses', 'info', json_encode($groups), __LINE__, __FILE__);
    //$groupid = array_search(CPANEL_LICENSING_GROUP, $groups['groups']);
    //myadmin_log('licenses', 'info', $groupid, __LINE__, __FILE__);
    $request = [
        'ip' => $ipAddress,
        'groupid' => CPANEL_LICENSING_GROUP,
        'packageid' => $package,
        'force' => 1,
        'reactivateok' => 1
    ];
    $response = $cpl->activateLicense($request);
    request_log($module, $GLOBALS['tf']->session->account_id, __FUNCTION__, 'cpanel', 'activateLicense', $request, $response);
    myadmin_log('licenses', 'info', json_encode($response['attr']), __LINE__, __FILE__);
    return $response['attr'];
}

/**
 * deactivate_cpanel()
 *
 * @param bool|false|string $ipAddress the ip to deactivate, or FALSE to use the request variable ip
 * @return bool TRUE if successfull, flase otherwise
 */
function deactivate_cpanel($ipAddress = false)
{
    if ($GLOBALS['tf']->ima == 'admin' && $ipAddress === false && isset($GLOBALS['tf']->variables->request['ip'])) {
        $ipAddress = $GLOBALS['tf']->variables->request['ip'];
    }
    if (trim($ipAddress) == '') {
        return true;
    }
    $cpl = new \Detain\Cpanel\Cpanel(CPANEL_LICENSING_USERNAME, CPANEL_LICENSING_PASSWORD);
    $request = ['ip' => $ipAddress];
    $response = $cpl->fetchLicenseId($request);
    request_log('licenses', false, __FUNCTION__, 'cpanel', 'fetchLicenseId', $request, $response);
    if (isset($response['attr']['reason']) && $response['attr']['reason'] == 'No Licenses Found') {
        return true;
    }
    if (isset($response['licenseid']) && isset($response['licenseid']['value'])) {
        $liscid = $response['licenseid']['value'];
        $request = ['liscid' => $liscid];
        $response = $cpl->expireLicense($request);
        request_log('licenses', false, __FUNCTION__, 'cpanel', 'expireLicense', $request, $response);
        myadmin_log('licenses', 'info', "deactivate_cpanel({$ipAddress}) returned ".json_encode($response['attr']), __LINE__, __FILE__);
        if (in_array($response['attr']['reason'], ['OK', 'No Licenses Found'])) {
            return true;
        } else {
            $bodyRows = [];
            $bodyRows[] = 'License IP: '.$ipAddress.' unable to deactivate.';
            $bodyRows[] = 'Deactivation Response: .'.json_encode($response);
            $subject = 'Cpanel License Deactivation Issue IP: '.$ipAddress;
            $smartyE = new TFSmarty();
            $smartyE->assign('h1', 'Cpanel License Deactivation');
            $smartyE->assign('body_rows', $bodyRows);
            $msg = $smartyE->fetch('email/client/client_email.tpl');
            (new \MyAdmin\Mail())->adminMail($subject, $msg, false, 'client/client_email.tpl');
            return false;
        }
    }
    $bodyRows = [];
    $bodyRows[] = 'License IP: '.$ipAddress.' unable to fetch for deactivation.';
    $bodyRows[] = 'Fetch License ID Response: .'.json_encode($response);
    $subject = 'Cpanel License Fetch Issue IP: '.$ipAddress;
    $smartyE = new TFSmarty();
    $smartyE->assign('h1', 'Cpanel License Fetch Issue For Deactivation');
    $smartyE->assign('body_rows', $bodyRows);
    $msg = $smartyE->fetch('email/client/client_email.tpl');
    (new \MyAdmin\Mail())->adminMail($subject, $msg, false, 'client/client_email.tpl');
    myadmin_log('licenses', 'error', 'deactivate_cpanel('.$ipAddress.') gave unexpected output:'.json_encode($response), __LINE__, __FILE__, 'licenses');
    return false;
}

/**
 * verify_cpanel()
 * verifies a cpanel license with cpanel
 *
 * @param mixed $ipAddress ip address
 * @return string the response from cpanel or 'Not Active' if no response
 */
function verify_cpanel($ipAddress)
{
    if (!validIp($ipAddress, false)) {
        return false;
    }
    $cpl = new \Detain\Cpanel\Cpanel(CPANEL_LICENSING_USERNAME, CPANEL_LICENSING_PASSWORD);
    $request = ['ip' => $ipAddress];
    $status = $cpl->fetchLicenseRaw($request);
    request_log('licenses', false, __FUNCTION__, 'cpanel', 'expireLicense', $request, $status);
    if ($status['attr']['status'] == 1) {
        $response = 'active';
    } else {
        $response = 'not active';
    }
    /*
    $response = trim(`curl --connect-timeout 60 --max-time 60 -L 'http://verify.cpanel.net/index.cgi?ip=$ipAddress' 2>/dev/null | grep -A18 tblheader | cut -d\> -f3 | cut -d\< -f1 | grep -v "^$" | tail -n 1`);
    if ($response == '}')
        $response = 'Not Active';
    */
    return $response;
}

/**
 * get_cpanel_license_data_by_ip()
 * gets cpanel license data
 * Sample output
 * [ip] => 209.67.63.2
 * [hostname] => neo.internetwebserver.net
 * [valid] => 1
 * [os] => Linux
 * [expiredon] =>
 * [groupid] => 30
 * [company] => Interserver, Inc.
 * [licenseid] => 1039954
 * [adddate] => 1251993592
 * [expirereason] =>
 * [distro] => centos enterprise 5.3
 * [version] => 11.24.5-RELEASE_38506
 * [packageid] => 560
 * [reason] => OK
 * [envtype] => virtuozzo
 * [osver] => 2.6.18-128.2.1.el5.028stab064.4.aviPAE
 * [updateexpiretime] => 0
 *
 * @param string $ipAddress ip address
 * @return array|bool
 */
function get_cpanel_license_data_by_ip($ipAddress)
{
    if (!validIp($ipAddress, false)) {
        return false;
    }
    $cpl = new \Detain\Cpanel\Cpanel(CPANEL_LICENSING_USERNAME, CPANEL_LICENSING_PASSWORD);
    $request = ['ip' => $ipAddress];
    $status = $cpl->fetchLicenseRaw($request);
    request_log('licenses', false, __FUNCTION__, 'cpanel', 'fetchLicenseRaw', $request, $status);
    if (!isset($status['license'])) {
        return false;
    }
    return $status['license'];
}

/**
 * @return array|mixed
 */
function get_cpanel_licenses()
{
    $cpl = new \Detain\Cpanel\Cpanel(CPANEL_LICENSING_USERNAME, CPANEL_LICENSING_PASSWORD);
    $status = $cpl->fetchLicenses();
    request_log('licenses', false, __FUNCTION__, 'cpanel', 'fetchLicenses', '', $status);
    return $status;
    //return $status['licenses'];
}

function get_cpanel_accounts_for_license_ip($ip)
{
    $data = get_cpanel_license_data_by_ip($ip);
    if ($data === false) {
        return false;
    }
    return $data['accounts'];
}