functions.php

<?php

// Check for server single sign-on in progress
if (!empty($_GET['CometSSO'])) {
    performServerLogin($_GET['CometSSO']);
}

/**
 * Obtain a cURL handle given a URL, POST data and optional extra options
 * 
 * @param $URL
 * @param $data
 * @param array $extra_opts
 * @return resource
 */
function getCurlHandle($URL, $data, $extra_opts = []) {
    $ch = curl_init();

    curl_setopt($ch, CURLOPT_URL, $URL);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 30);
    curl_setopt($ch, CURLOPT_TIMEOUT, 400); // Timeout in seconds

    foreach ($extra_opts as $opt => $value) {
        curl_setopt($ch, $opt, $value);
    }

    return $ch;
}

/**
 * Send a request to the given API endpoint on the server.
 * 
 * @param array $params
 * @param array $data API parameters to supply
 * @param string $endPoint Admin API to use
 * @param bool $assoc (Optional) Return associative array instead of object
 * @return array|object|string
 */
function performAPIRequest($params, $data, $endPoint, $assoc = true) {
    $baseParams = [
        'Username' => $params['serverusername'],
        'AuthType' => 'Password',
        'Password' => $params['serverpassword'],
    ];

    $query = http_build_query($baseParams + $data);
    $ch = getCurlHandle(
        getHost($params) . '/api/v1/admin/' . $endPoint,
        $query,
        [CURLOPT_FOLLOWLOCATION => true]
    );

    $response = curl_exec($ch);
    $error = curl_error($ch);
    curl_close($ch);

    if ($error) {
        return ['curlerror' => $error];
    } else {
        return json_decode($response, $assoc);
    }
}

/**
 * Stream a client software download.
 * 
 * @param array $params
 * @param array $data Request data
 * @param string $action API endpoint
 * @return string
 */
function softwareDownload($params, $data, $action) {
    $baseParams = [
        'Username' => $params['serverusername'],
        'AuthType' => 'Password',
        'Password' => $params['serverpassword'],
    ];

    $query = http_build_query($baseParams + $data);
    $ch = getCurlHandle(
        getHost($params) . '/api/v1/admin/' . $action,
        $query,
        [CURLOPT_FOLLOWLOCATION => true]
    );

    // Streaming download
    return curl_exec($ch);
}

/**
 * Format bytes count into human-readable form.
 * 
 * @param $bytes
 * @return string
 */
function formatBytes($bytes) {
    if ($bytes >= 1073741824) {
        return number_format($bytes / 1073741824, 2) . ' GB';
    } else if ($bytes >= 1048576) {
        return number_format($bytes / 1048576, 2) . ' MB';
    } else if ($bytes >= 1024) {
        return number_format($bytes / 1024, 2) . ' KB';
    } else if ($bytes > 1) {
        return $bytes . ' bytes';
    } else if ($bytes == 1) {
        return $bytes . ' byte';
    } else {
        return '0 bytes';
    }
}

/**
 * Convert Comet job classification code to human readable string
 *
 * @param int $code
 * @return string
 */
function formatJobType($code) {
    switch ($code) {
        case 4001:
            return 'Backup';
        case 4002:
            return 'Restore';
        case 4003:
            return 'Cleanup';
        case 4004:
            return 'Unlock';
        case 4005:
            return 'Delete';
        case 4006:
            return 'Measure';
        case 4007:
            return 'Update';
        case 4008:
            return 'Import';
        case 4009:
            return 'Reindex';
        case 4010:
            return 'Verify';
        default:
            return 'Unknown';
    }
}

/**
 * Convert Comet status code to human readable form.
 * 
 * @param $code
 * @return string
 */
function formatStatusType($code) {
    if ($code >= 5000 && $code <= 5999) {
        return 'Success';
    } else if ($code >= 6000 && $code <= 6999) {
        return 'Running';
    } else if ($code >= 7000 && $code <= 7999) {
        return 'Error';
    } else {
        return 'Unknown';
    }
}

/**
 * Escape html entities (safe for use within `<tag properties="">' as well)
 * n.b. ENT_SUBSTITUTE means PHP 5.4.0+
 *
 * @param string $str Raw text
 * @return string HTML
 */
function hesc($str) {
    return @htmlentities($str, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8');
}

/**
 * Outputs API response message or a generic error message containing encoded response details if no API response message present
 * 
 * @param array $response
 * @param bool $noHTML
 * @return string
 */
function handleErrorResponse($response, $noHTML = false) {
    if (isset($response['Message'])) {
        return $response['Message'];
    } else {
        return 'An error has occurred - please contact support. ' . ($noHTML ? ' Error detail: ' : '<br> <span style="color:darkred;"> Error detail:</span>') . base64_encode(var_export($response, true));
    }
}

/**
 * Sets the suspension state of an account to the provided value
 * 
 * @param array $params
 * @param bool $suspended
 * @return string
 */
function modifyAccountSuspensionState($params, $suspended) {
    $baseRequestData = [
        'TargetUser' => getUsernameFromParams($params)
    ];

    $profile = performAPIRequest(
        $params,
        $baseRequestData,
        'get-user-profile-and-hash',
        false
    );

    if (is_object($profile) && property_exists($profile, 'ProfileHash')) {
        $profileData = $profile->Profile;
        $profileData->IsSuspended = $suspended; // Modify suspension state value

        $response = performAPIRequest(
            $params,
            $baseRequestData + [
                'ProfileData' => json_encode($profileData),
                'RequireHash' => $profile->ProfileHash
            ],
            'set-user-profile-hash'
        );

        if (array_key_exists('Status', $response) && $response['Status'] === 200) {
            return 'success';
        } else {
            return handleErrorResponse($response, true);
        }
    } else {
        return "Error Fetching User.";
    }
}

/**
 * Checks for the existence of a policy group on the Comet server and creates it if necessary.
 * 
 * @param array $params
 * @param string $policyGroupGUID
 */
function maybeCreatePolicyGroup($params, $policyGroupGUID) {
    $baseRequestData = [
        'PolicyID' => $policyGroupGUID
    ];

    $policy = performAPIRequest(
        $params,
        $baseRequestData,
        'policies/get'
    );

    if (empty($policy['PolicyHash'])) {
        performAPIRequest(
            $params,
            $baseRequestData + [
                'Policy' => json_encode([
                    'Description' => $policyGroupGUID,
                    'Policy' => [
                        'PreventChangeAccountPassword' => true,
                        'ModeAdminResetPassword' => 3,
                        'PreventDeleteStorageVault' => true,
                        'PreventAddCustomStorageVault' => true,
                        'PreventRequestStorageVault' => true,
                        'StorageVaultProviders' => [
                            'AllowedProvidersWhenRestricted' => [1003],
                            'ShouldRestrictProviderList' => true
                        ],
                        'ProtectedItemEngineTypes' => [
                            'AllowedEngineTypeWhenRestricted' => [],
                            'ShouldRestrictEngineTypeList' => false
                        ],
                    ]
                ])
            ],
            'policies/set'
        );
    }
}

/**
 * Retrieves a user profile and updates it to reflect the currently configured account restrictions in WHMCS.
 * 
 * @param array $params
 * @return string
 */
function applyRestrictions($params) {
    // Prepare base API request params
    $baseRequestData = [
        'TargetUser' => getUsernameFromParams($params),
    ];

    // Retrieve profile content for modification
    $profile = performAPIRequest($params, $baseRequestData, 'get-user-profile-and-hash', false);

    // Sanity check
    if (is_object($profile) && property_exists($profile, 'ProfileHash')) {
        $profileData = $profile->Profile;

        // Apply storage vault quota if set
        if (
            !empty($params['configoptions']['storage_vault_quota_gb']) &&
            !empty($profileData->Destinations)
        ) {
            foreach (array_keys((array)$profileData->Destinations) as $destinationGUID) {
                $profileData->Destinations->$destinationGUID->StorageLimitEnabled = true;
                $profileData->Destinations->$destinationGUID->StorageLimitBytes = intval($params['configoptions']['storage_vault_quota_gb']) * pow(1024, 3);
            }

        } else if (
            !empty($params['configoptions']['storage_vault_quota_tb']) &&
            !empty($profileData->Destinations)
        ) {
            foreach (array_keys((array)$profileData->Destinations) as $destinationGUID) {
                $profileData->Destinations->$destinationGUID->StorageLimitEnabled = true;
                $profileData->Destinations->$destinationGUID->StorageLimitBytes = intval($params['configoptions']['storage_vault_quota_tb']) * pow(1024, 4);
            }
        }

        // Apply protected items quota if set
        if (!empty($params['configoptions']['protected_item_quota_gb'])) {
            $profileData->AllProtectedItemsQuotaEnabled     = true;
            $profileData->AllProtectedItemsQuotaBytes       = intval($params['configoptions']['protected_item_quota_gb']) * pow(1024, 3);
        
        } else if (!empty($params['configoptions']['protected_item_quota_tb'])) {
            $profileData->AllProtectedItemsQuotaEnabled     = true;
            $profileData->AllProtectedItemsQuotaBytes       = intval($params['configoptions']['protected_item_quota_tb']) * pow(1024, 4);
        
        } else {
            $profileData->AllProtectedItemsQuotaEnabled     = false;
            $profileData->AllProtectedItemsQuotaBytes       = 0;
        }

        // Apply device quota if set
        $profileData->MaximumDevices                    = intval((empty($params['configoptions']['number_of_devices']) ? 0 : intval($params['configoptions']['number_of_devices'])));

        // Apply policy group if set
        $profileData->PolicyID                          = (empty($params['configoption1']) ? '' : $params['configoption1']);

        // Prepare request
        $updateProfileRequestData = $baseRequestData + [
            'ProfileData'           => json_encode($profileData),
            'RequireHash'           => $profile->ProfileHash
        ];

        // Update user
        $response = performAPIRequest($params, $updateProfileRequestData, 'set-user-profile-hash');

        if (isset($response['Status']) && $response['Status'] == 200) {
            return 'success';
        } else {
            return 'Account creation succeeded, however an error occurred during configuration - please check to confirm whether account details are correct. Error detail: ' . base64_encode(var_export($response, true));
        }
    } else {
        return 'Couldn\'t retrieve profile.';
    }
}

/**
 * Produce a usable server hostname
 * 
 * @param array $params
 * @return string
 */
function getHost($params) {
    $hostname =  preg_replace(["^http://^i", "^https://^i", "^/^"], "", $params['serverhostname']);

    // Compatibility with servers configured under older versions of the module / WHMCS
    $port = '';
    $extractPort = [];
    preg_match('/:([0-9]+)$/', $hostname, $extractPort);

    // Use port from hostname if set (compatibility)
    if (!empty($extractPort[1]) && is_numeric($extractPort[1])) {
        $port = $extractPort[1];
        $hostname =  preg_replace(["/:[0-9]+/"], "", $hostname);

    // Use port from serverport if set (standard)
    } else if (!empty($params['serverport'])) {
        $port = $params['serverport'];
    }

    return $params['serverhttpprefix'] . '://' . $hostname . (!empty($port) ? ':' . intval($port) : '');
}

/**
 * Inject some javascript into the page to perform single sign-on and then die.
 * 
 * @param string $requestData Base64-encoded JSON object
 */
function performServerLogin($requestData) {
    $data = json_decode(base64_decode($requestData), true);

?> 
    <div style="height:100vh;width:100vw;position:fixed;top:0;left:0;background:#555;line-height:100vh;text-align:center;color:#FFF;font-family:Arial;">
        <h1>Loading...</h1>
    </div>
    <script type="text/javascript">
        (function() {
            var TARGET_URI = <?= json_encode($data['Server']) ?>;
            var SESSIONKEY = <?= json_encode($data['SessionKey']) ?>;
            var USERNAME = <?= json_encode($data['TargetUser']) ?>;

            window.addEventListener('message', function(msg) {
                wnd.postMessage({
                        "msg": "session_login",
                        "username": USERNAME,
                        "sessionkey": SESSIONKEY
                    },
                    TARGET_URI
                );
                window.close();
            }, TARGET_URI);

            var wnd = window.open(TARGET_URI);
        })();
    </script>
<?php

    die();
}

/**
 * Retrieve the client's username, selecting from service params or product custom fields 
 * depending on whether a custom field is present.
 * 
 * @param array $params
 * @return string
 */
function getUsernameFromParams($params) {
    $username = false;

    // Check for a product custom field
    if (getIsUsingCustomUsernameFromParams($params)) {
        $username = $params['customfields']['Username'];

    // If no custom field, use the service value
    } else {
        $username = $params['username'];
    }

    return $username;
}

/**
 * Check whether a custom username is present.
 * 
 * @param array $params
 * @return bool
 */
function getIsUsingCustomUsernameFromParams($params) {
    return !empty(trim($params['customfields']['Username']));
}

/**
 * Retrieve the client's password, selecting from service params or product custom fields 
 * depending on whether a custom field is present.
 * 
 * @param array $params
 * @return string
 */
function getPasswordFromParams($params) {
    $password = false;

    // Check for a product custom field
    if (getIsUsingCustomPasswordFromParams($params)) {
        $password = $params['customfields']['Password'];

    // If no custom field, use the service value
    } else {
        $password = $params['password'];
    }

    return $password;
}

/**
 * Check whether a custom password is present.
 * 
 * @param array $params
 * @return bool
 */
function getIsUsingCustomPasswordFromParams($params) {
    return !empty($params['customfields']['Password']);
}