d253bd44e6
All checks were successful
Publish Release / release (push) Successful in 10s
- Auto-create 'Initial Operating System' and 'Initial SSH Key' custom fields via Database::ensureCustomFields() on module load, eliminating the manual modify.sql step - Delete modify.sql (no longer needed) - Add try/catch blocks around every DB operation and API call across all PHP files per CLAUDE.md error handling rules - Add comprehensive PHPDoc to all classes, methods, and properties - Set up Laravel Pint (laravel/pint) with Laravel-style preset for consistent code formatting across the codebase - Add git pre-commit hook (hooks/pre-commit) that runs Pint on staged PHP files, auto-installed via Composer post-install/post-update scripts - Simplify README installation to a single copy-paste command Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
360 lines
12 KiB
PHP
360 lines
12 KiB
PHP
<?php
|
|
|
|
if (! defined('WHMCS')) {
|
|
exit('This file cannot be accessed directly');
|
|
}
|
|
|
|
use WHMCS\Database\Capsule;
|
|
use WHMCS\Module\Server\VirtFusionDirect\Database;
|
|
use WHMCS\Module\Server\VirtFusionDirect\Log;
|
|
use WHMCS\Module\Server\VirtFusionDirect\Module;
|
|
use WHMCS\Module\Server\VirtFusionDirect\ModuleFunctions;
|
|
|
|
/**
|
|
* Returns module metadata consumed by WHMCS.
|
|
*
|
|
* @return array
|
|
*/
|
|
function VirtFusionDirect_MetaData()
|
|
{
|
|
return [
|
|
'DisplayName' => 'VirtFusion Direct Provisioning',
|
|
'APIVersion' => '1.1',
|
|
'RequiresServer' => true,
|
|
'ServiceSingleSignOnLabel' => 'Login to VirtFusion Panel',
|
|
'AdminSingleSignOnLabel' => false,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Returns product configuration options displayed in the WHMCS product editor.
|
|
*
|
|
* @return array
|
|
*/
|
|
function VirtFusionDirect_ConfigOptions()
|
|
{
|
|
return [
|
|
'defaultHypervisorGroupId' => [
|
|
'FriendlyName' => 'Hypervisor Group ID',
|
|
'Type' => 'text',
|
|
'Size' => '20',
|
|
'Description' => 'The default hypervisor group ID for server placement.',
|
|
'Default' => '1',
|
|
],
|
|
'packageID' => [
|
|
'FriendlyName' => 'Package ID',
|
|
'Type' => 'text',
|
|
'Size' => '20',
|
|
'Description' => 'The VirtFusion package ID that defines server resources.',
|
|
'Default' => '1',
|
|
],
|
|
'defaultIPv4' => [
|
|
'FriendlyName' => 'Default IPv4',
|
|
'Type' => 'dropdown',
|
|
'Options' => '0,1,2,3,4,5,6,7,8,9,10',
|
|
'Description' => 'The default number of IPv4 addresses to assign to each server.',
|
|
'Default' => '1',
|
|
],
|
|
'selfServiceMode' => [
|
|
'FriendlyName' => 'Self-Service Mode',
|
|
'Type' => 'dropdown',
|
|
'Options' => '0|Disabled,1|Hourly,2|Resource Packs,3|Both',
|
|
'Description' => 'Enable VirtFusion self-service billing for users created by this product.',
|
|
'Default' => '0',
|
|
],
|
|
'autoTopOffThreshold' => [
|
|
'FriendlyName' => 'Auto Top-Off Threshold',
|
|
'Type' => 'text',
|
|
'Size' => '10',
|
|
'Description' => 'Credit balance below which auto top-off triggers during cron. 0 = disabled.',
|
|
'Default' => '0',
|
|
],
|
|
'autoTopOffAmount' => [
|
|
'FriendlyName' => 'Auto Top-Off Amount',
|
|
'Type' => 'text',
|
|
'Size' => '10',
|
|
'Description' => 'Credit amount to add when auto top-off triggers.',
|
|
'Default' => '100',
|
|
],
|
|
];
|
|
}
|
|
|
|
function VirtFusionDirect_TestConnection(array $params)
|
|
{
|
|
try {
|
|
$hostname = trim($params['serverhostname'] ?? '');
|
|
$password = $params['serverpassword'] ?? '';
|
|
|
|
if (empty($hostname) || empty($password)) {
|
|
return ['success' => false, 'error' => 'Server hostname and password are required. Please verify the server configuration.'];
|
|
}
|
|
|
|
$url = 'https://' . $hostname . '/api/v1';
|
|
$module = new Module;
|
|
$request = $module->initCurl($password);
|
|
$data = $request->get($url . '/connect');
|
|
|
|
$httpCode = $request->getRequestInfo('http_code');
|
|
|
|
if ($httpCode == 200) {
|
|
return ['success' => true, 'error' => ''];
|
|
}
|
|
|
|
if ($httpCode == 401) {
|
|
return ['success' => false, 'error' => 'Authentication failed. Please verify your API token is correct and has not expired.'];
|
|
}
|
|
|
|
if ($httpCode == 0) {
|
|
$curlError = $request->getRequestInfo('curl_error');
|
|
|
|
return ['success' => false, 'error' => 'Connection failed: ' . ($curlError ?: 'Unable to reach the VirtFusion server. Verify the hostname and that SSL certificates are valid.')];
|
|
}
|
|
|
|
return ['success' => false, 'error' => 'Unexpected response from VirtFusion API (HTTP ' . $httpCode . '). Please check the server configuration.'];
|
|
} catch (Throwable $e) {
|
|
return ['success' => false, 'error' => 'Connection test failed: ' . $e->getMessage()];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns custom admin action buttons shown on the service management page.
|
|
*
|
|
* @return array Button label => function suffix pairs
|
|
*/
|
|
function VirtFusionDirect_AdminCustomButtonArray()
|
|
{
|
|
return [
|
|
'Update Server Object' => 'updateServerObject',
|
|
'Validate Server Config' => 'validateServerConfig',
|
|
];
|
|
}
|
|
|
|
function VirtFusionDirect_ServiceSingleSignOn(array $params)
|
|
{
|
|
try {
|
|
$module = new Module;
|
|
$token = $module->fetchLoginTokens($params['serviceid']);
|
|
|
|
if ($token) {
|
|
return ['success' => true, 'redirectTo' => $token];
|
|
}
|
|
|
|
return ['success' => false, 'errorMsg' => 'Unable to generate a login token. The server may not be active or the VirtFusion API may be unreachable.'];
|
|
} catch (Exception $e) {
|
|
return ['success' => false, 'errorMsg' => $e->getMessage()];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Service functions
|
|
*/
|
|
function VirtFusionDirect_CreateAccount(array $params)
|
|
{
|
|
return (new ModuleFunctions)->createAccount($params);
|
|
}
|
|
|
|
/**
|
|
* Suspends the VirtFusion server associated with a WHMCS service.
|
|
*
|
|
* @param array $params WHMCS module parameters
|
|
* @return string 'success' or error message
|
|
*/
|
|
function VirtFusionDirect_SuspendAccount(array $params)
|
|
{
|
|
return (new ModuleFunctions)->suspendAccount($params);
|
|
}
|
|
|
|
/**
|
|
* Unsuspends the VirtFusion server associated with a WHMCS service.
|
|
*
|
|
* @param array $params WHMCS module parameters
|
|
* @return string 'success' or error message
|
|
*/
|
|
function VirtFusionDirect_UnsuspendAccount(array $params)
|
|
{
|
|
return (new ModuleFunctions)->unsuspendAccount($params);
|
|
}
|
|
|
|
/**
|
|
* Terminates (deletes) the VirtFusion server associated with a WHMCS service.
|
|
*
|
|
* @param array $params WHMCS module parameters
|
|
* @return string 'success' or error message
|
|
*/
|
|
function VirtFusionDirect_TerminateAccount(array $params)
|
|
{
|
|
return (new ModuleFunctions)->terminateAccount($params);
|
|
}
|
|
|
|
/**
|
|
* Admin custom action: refreshes the local server object from the VirtFusion API.
|
|
*
|
|
* @param array $params WHMCS module parameters
|
|
* @return string 'success' or error message
|
|
*/
|
|
function VirtFusionDirect_updateServerObject(array $params)
|
|
{
|
|
return (new ModuleFunctions)->updateServerObject($params);
|
|
}
|
|
|
|
/**
|
|
* Allows changing of the package of a server
|
|
*
|
|
* @return string
|
|
*/
|
|
function VirtFusionDirect_ChangePackage(array $params)
|
|
{
|
|
return (new ModuleFunctions)->changePackage($params);
|
|
}
|
|
|
|
/**
|
|
* Returns HTML fields rendered in the custom admin services tab.
|
|
*
|
|
* @param array $params WHMCS module parameters
|
|
* @return array Field name => HTML value pairs
|
|
*/
|
|
function VirtFusionDirect_AdminServicesTabFields(array $params)
|
|
{
|
|
return (new ModuleFunctions)->adminServicesTabFields($params);
|
|
}
|
|
|
|
/**
|
|
* Handles saving of custom admin services tab field values.
|
|
*
|
|
* @param array $params WHMCS module parameters
|
|
* @return void
|
|
*/
|
|
function VirtFusionDirect_AdminServicesTabFieldsSave(array $params)
|
|
{
|
|
(new ModuleFunctions)->adminServicesTabFieldsSave($params);
|
|
}
|
|
|
|
/**
|
|
* Returns the client area template variables and template name for the service overview page.
|
|
*
|
|
* @param array $params WHMCS module parameters
|
|
* @return array Smarty template variables and 'templatefile' key
|
|
*/
|
|
function VirtFusionDirect_ClientArea(array $params)
|
|
{
|
|
return (new ModuleFunctions)->clientArea($params);
|
|
}
|
|
|
|
/**
|
|
* Validates server configuration via dry run without creating the server.
|
|
*
|
|
* @return string 'success' or error message
|
|
*/
|
|
function VirtFusionDirect_validateServerConfig(array $params)
|
|
{
|
|
return (new ModuleFunctions)->validateServerConfig($params);
|
|
}
|
|
|
|
/**
|
|
* Usage Update - called by WHMCS daily cron to sync bandwidth and disk usage.
|
|
*
|
|
* Updates tblhosting with disk and bandwidth usage data from VirtFusion.
|
|
* Fields updated: diskused, disklimit, bwused, bwlimit, lastupdate
|
|
*
|
|
* @param array $params Server access credentials
|
|
* @return string 'success' or error message
|
|
*/
|
|
function VirtFusionDirect_UsageUpdate(array $params)
|
|
{
|
|
try {
|
|
$module = new Module;
|
|
$cp = $module->getCP($params['serverid']);
|
|
|
|
if (! $cp) {
|
|
return 'No control server found for usage update.';
|
|
}
|
|
|
|
$services = Capsule::table('tblhosting')
|
|
->where('server', $params['serverid'])
|
|
->where('domainstatus', 'Active')
|
|
->get();
|
|
|
|
foreach ($services as $service) {
|
|
try {
|
|
$systemService = Database::getSystemService($service->id);
|
|
if (! $systemService) {
|
|
continue;
|
|
}
|
|
|
|
$request = $module->initCurl($cp['token']);
|
|
$data = $request->get($cp['url'] . '/servers/' . (int) $systemService->server_id);
|
|
|
|
if ($request->getRequestInfo('http_code') != 200) {
|
|
continue;
|
|
}
|
|
|
|
$serverData = json_decode($data, true);
|
|
if (! isset($serverData['data'])) {
|
|
continue;
|
|
}
|
|
|
|
$server = $serverData['data'];
|
|
$update = [];
|
|
|
|
// Disk usage (WHMCS expects MB)
|
|
if (isset($server['usage']['storage']['used'])) {
|
|
$update['diskused'] = round($server['usage']['storage']['used'] / 1048576);
|
|
}
|
|
if (isset($server['settings']['resources']['storage'])) {
|
|
$update['disklimit'] = (int) $server['settings']['resources']['storage'] * 1024;
|
|
}
|
|
|
|
// Bandwidth usage (WHMCS expects MB)
|
|
if (isset($server['usage']['traffic']['used'])) {
|
|
$update['bwused'] = round($server['usage']['traffic']['used'] / 1048576);
|
|
}
|
|
if (isset($server['settings']['resources']['traffic'])) {
|
|
$trafficGB = (int) $server['settings']['resources']['traffic'];
|
|
$update['bwlimit'] = $trafficGB > 0 ? $trafficGB * 1024 : 0;
|
|
}
|
|
|
|
if (! empty($update)) {
|
|
$update['lastupdate'] = date('Y-m-d H:i:s');
|
|
Capsule::table('tblhosting')
|
|
->where('id', $service->id)
|
|
->update($update);
|
|
}
|
|
|
|
// Self-service auto top-off
|
|
$product = Capsule::table('tblproducts')
|
|
->where('id', $service->packageid)
|
|
->first();
|
|
|
|
if ($product) {
|
|
$threshold = (float) ($product->configoption5 ?? 0);
|
|
$topOffAmount = (float) ($product->configoption6 ?? 0);
|
|
|
|
if ($threshold > 0 && $topOffAmount > 0) {
|
|
$usageData = $module->getSelfServiceUsage($service->id);
|
|
if ($usageData) {
|
|
$usageInner = $usageData['data'] ?? $usageData;
|
|
$credit = $usageInner['credit'] ?? $usageInner['balance'] ?? null;
|
|
if ($credit !== null && (float) $credit < $threshold) {
|
|
$module->addSelfServiceCredit($service->id, $topOffAmount, 'Auto top-off');
|
|
Log::insert(
|
|
'UsageUpdate:autoTopOff',
|
|
['serviceId' => $service->id, 'credit' => $credit, 'threshold' => $threshold],
|
|
['amount' => $topOffAmount],
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} catch (Exception $e) {
|
|
// Log but continue processing other services
|
|
Log::insert('UsageUpdate:service:' . $service->id, [], $e->getMessage());
|
|
continue;
|
|
}
|
|
}
|
|
|
|
return 'success';
|
|
} catch (Exception $e) {
|
|
return 'Usage update failed: ' . $e->getMessage();
|
|
}
|
|
}
|