feat: auto-create custom fields, add try/catch coverage, PHPDoc, and Pint formatting
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>
This commit is contained in:
Prophet731
2026-03-19 15:03:17 -05:00
parent 1ab2ef42a5
commit d253bd44e6
22 changed files with 2384 additions and 1474 deletions

1
.gitignore vendored
View File

@@ -1,2 +1,3 @@
/.idea/ /.idea/
/.superpowers/ /.superpowers/
/vendor/

View File

@@ -91,6 +91,8 @@ The `publish-release.yml` workflow creates a GitHub/Gitea release with auto-gene
6. Updates WHMCS hosting record (IP, username, password, domain) 6. Updates WHMCS hosting record (IP, username, password, domain)
7. Calls `ConfigureService::initServerBuild()` with selected OS + SSH key 7. Calls `ConfigureService::initServerBuild()` with selected OS + SSH key
Custom fields (`Initial Operating System`, `Initial SSH Key`) are auto-created by `Database::ensureCustomFields()` on module load for all products using this module. No manual SQL setup required.
### Configurable Option Mapping ### Configurable Option Mapping
Custom option names can be mapped in `config/ConfigOptionMapping.php` (copy from `-example.php`). Default mapping keys: `packageId`, `hypervisorId`, `ipv4`, `storage`, `memory`, `traffic`, `cpuCores`, `networkSpeedInbound`, `networkSpeedOutbound`, `networkProfile`, `storageProfile`. Custom option names can be mapped in `config/ConfigOptionMapping.php` (copy from `-example.php`). Default mapping keys: `packageId`, `hypervisorId`, `ipv4`, `storage`, `memory`, `traffic`, `cpuCores`, `networkSpeedInbound`, `networkSpeedOutbound`, `networkProfile`, `storageProfile`.

101
README.md
View File

@@ -108,95 +108,28 @@ You also need a VirtFusion API token with the following permissions:
## Installation ## Installation
### Step 1: Download & Install
Download the latest release from the [releases](https://github.com/EZSCALE/virtfusion-whmcs-module/releases) page, or install directly via the command line:
```bash ```bash
cd /tmp git clone https://github.com/EZSCALE/virtfusion-whmcs-module.git /tmp/vf && rsync -ahP --delete /tmp/vf/modules/servers/VirtFusionDirect/ /path/to/whmcs/modules/servers/VirtFusionDirect/ && rm -rf /tmp/vf
git clone https://github.com/EZSCALE/virtfusion-whmcs-module.git
rsync -ahP --delete /tmp/virtfusion-whmcs-module/modules/servers/VirtFusionDirect/ /path/to/whmcs/modules/servers/VirtFusionDirect/
rm -rf /tmp/virtfusion-whmcs-module
``` ```
Replace `/path/to/whmcs` with your actual WHMCS installation root. Replace `/path/to/whmcs` with your actual WHMCS installation root. The database table, schema migrations, and custom fields are all created automatically on first load.
The resulting file structure should be: Then configure in WHMCS Admin:
``` 1. **Add Server** — Configuration > System Settings > Servers > Add New Server. Set hostname to your VirtFusion panel (e.g. `cp.example.com`), type to "VirtFusion Direct Provisioning", and paste your API token in the Password field. Click **Test Connection** to verify.
modules/servers/VirtFusionDirect/ 2. **Create Product** — Configuration > System Settings > Products/Services. On the Module Settings tab, select "VirtFusion Direct Provisioning", choose your server, and set the Hypervisor Group ID, Package ID, and Default IPv4 count.
VirtFusionDirect.php # Main module file
client.php # Client AJAX API
admin.php # Admin AJAX API
hooks.php # WHMCS hooks
modify.sql # Custom field setup SQL
lib/
Module.php # Core module class
ModuleFunctions.php # Provisioning functions
ConfigureService.php # OS/SSH config service
Database.php # Database operations
Curl.php # HTTP client
ServerResource.php # Data transformer
AdminHTML.php # Admin interface HTML
Log.php # Logging
templates/
overview.tpl # Client area template
error.tpl # Error template
css/module.css # Styles
js/module.js # Client JavaScript
js/keygen.js # SSH Ed25519 key generator
config/
ConfigOptionMapping-example.php # Config mapping example
```
### Step 2: Set Up Server in WHMCS That's it. Hooks activate automatically and custom fields are created on module load.
1. Go to **Configuration > System Settings > Servers**
2. Click **Add New Server**
3. Fill in:
- **Name**: Anything descriptive (e.g., "VirtFusion Production")
- **Hostname**: Your VirtFusion panel hostname (e.g., `cp.example.com`)
- **Type**: VirtFusion Direct Provisioning
- **Password/Access Hash**: Your VirtFusion API token
4. Click **Test Connection** to verify
5. Click **Save Changes**
### Step 3: Create Product
1. Go to **Configuration > System Settings > Products/Services**
2. Create a new product or edit an existing one
3. On the **Module Settings** tab:
- Set **Module Name** to "VirtFusion Direct Provisioning"
- Select your VirtFusion server
- Set **Hypervisor Group ID**, **Package ID**, and **Default IPv4** count
4. Save the product
### Step 4: Set Up Custom Fields
See [Custom Fields](#custom-fields) section below.
### Step 5: Activate Hooks
The hooks file (`hooks.php`) is automatically detected by WHMCS when the module is active. If you add the module files to an existing installation, you may need to re-save the product settings or clear the WHMCS template cache for hooks to take effect.
## Upgrading ## Upgrading
1. Back up your existing `modules/servers/VirtFusionDirect/` directory
2. Back up `config/ConfigOptionMapping.php` if you have a custom mapping
3. Download and deploy the new version:
```bash ```bash
cd /tmp git clone https://github.com/EZSCALE/virtfusion-whmcs-module.git /tmp/vf && rsync -ahP --delete /tmp/vf/modules/servers/VirtFusionDirect/ /path/to/whmcs/modules/servers/VirtFusionDirect/ && rm -rf /tmp/vf
git clone https://github.com/EZSCALE/virtfusion-whmcs-module.git
rsync -ahP --delete /tmp/virtfusion-whmcs-module/modules/servers/VirtFusionDirect/ /path/to/whmcs/modules/servers/VirtFusionDirect/
rm -rf /tmp/virtfusion-whmcs-module
``` ```
4. Restore your custom `config/ConfigOptionMapping.php` if applicable > **Note:** If you have a custom `config/ConfigOptionMapping.php`, back it up first — `--delete` will remove it. Restore it after upgrading.
5. If you have theme-overridden templates, review them for any new template variables
6. Clear the WHMCS template cache: **Configuration > System Settings > General Settings > clear template cache**
The module database table (`mod_virtfusion_direct`) is automatically migrated on first load. If you use theme-overridden templates, review them for any new template variables. Clear the WHMCS template cache after upgrading: **Configuration > System Settings > General Settings > clear template cache**.
## Configuration ## Configuration
@@ -222,20 +155,9 @@ Each WHMCS product using this module needs:
### Custom Fields ### Custom Fields
You **must** create two custom fields on each product that uses this module: The module requires two custom fields per product: **Initial Operating System** and **Initial SSH Key**. These are **automatically created** when the module loads — no manual setup required.
| Field Name | Field Type | Show on Order Form | Admin Only | Required | The fields are hidden text boxes that are dynamically replaced by dropdown selects via JavaScript hooks on the order form. They are created for every product with the module type set to "VirtFusion Direct Provisioning".
|---|---|---|---|---|
| Initial Operating System | Text Box | Yes | No | No |
| Initial SSH Key | Text Box | Yes | No | No |
These fields are hidden text boxes that are dynamically replaced by dropdown selects via JavaScript hooks on the order form.
**Automated setup**: Run the SQL from [modify.sql](modify.sql) to auto-create these fields for all VirtFusion products:
```bash
mysql -u whmcs_user -p whmcs_database < modules/servers/VirtFusionDirect/modify.sql
```
### Module Configuration Options ### Module Configuration Options
@@ -559,7 +481,6 @@ modules/servers/VirtFusionDirect/
client.php # Client-facing AJAX API (authenticated, ownership-validated) client.php # Client-facing AJAX API (authenticated, ownership-validated)
admin.php # Admin-facing AJAX API (admin authentication required) admin.php # Admin-facing AJAX API (admin authentication required)
hooks.php # WHMCS hooks (order form OS/SSH dropdowns, checkout validation) hooks.php # WHMCS hooks (order form OS/SSH dropdowns, checkout validation)
modify.sql # SQL for creating custom fields
lib/ lib/
Module.php # Base class: API communication, power, network, VNC, rebuild Module.php # Base class: API communication, power, network, VNC, rebuild
ModuleFunctions.php # Provisioning: create, suspend, unsuspend, terminate, change package ModuleFunctions.php # Provisioning: create, suspend, unsuspend, terminate, change package

19
composer.json Normal file
View File

@@ -0,0 +1,19 @@
{
"name": "ezscale/virtfusion-whmcs-module",
"description": "VirtFusion Direct Provisioning Module for WHMCS",
"type": "whmcs-module",
"license": "GPL-3.0-or-later",
"require-dev": {
"laravel/pint": "^1.0"
},
"scripts": {
"post-install-cmd": [
"cp hooks/pre-commit .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit"
],
"post-update-cmd": [
"cp hooks/pre-commit .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit"
],
"lint": "pint",
"lint-test": "pint --test"
}
}

87
composer.lock generated Normal file
View File

@@ -0,0 +1,87 @@
{
"_readme": [
"This file locks the dependencies of your project to a known state",
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
"content-hash": "f6be98eb2bded4b127a92bc0f1e19d93",
"packages": [],
"packages-dev": [
{
"name": "laravel/pint",
"version": "v1.29.0",
"source": {
"type": "git",
"url": "https://github.com/laravel/pint.git",
"reference": "bdec963f53172c5e36330f3a400604c69bf02d39"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/laravel/pint/zipball/bdec963f53172c5e36330f3a400604c69bf02d39",
"reference": "bdec963f53172c5e36330f3a400604c69bf02d39",
"shasum": ""
},
"require": {
"ext-json": "*",
"ext-mbstring": "*",
"ext-tokenizer": "*",
"ext-xml": "*",
"php": "^8.2.0"
},
"require-dev": {
"friendsofphp/php-cs-fixer": "^3.94.2",
"illuminate/view": "^12.54.1",
"larastan/larastan": "^3.9.3",
"laravel-zero/framework": "^12.0.5",
"mockery/mockery": "^1.6.12",
"nunomaduro/termwind": "^2.4.0",
"pestphp/pest": "^3.8.6",
"shipfastlabs/agent-detector": "^1.1.0"
},
"bin": [
"builds/pint"
],
"type": "project",
"autoload": {
"psr-4": {
"App\\": "app/",
"Database\\Seeders\\": "database/seeders/",
"Database\\Factories\\": "database/factories/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Nuno Maduro",
"email": "enunomaduro@gmail.com"
}
],
"description": "An opinionated code formatter for PHP.",
"homepage": "https://laravel.com",
"keywords": [
"dev",
"format",
"formatter",
"lint",
"linter",
"php"
],
"support": {
"issues": "https://github.com/laravel/pint/issues",
"source": "https://github.com/laravel/pint"
},
"time": "2026-03-12T15:51:39+00:00"
}
],
"aliases": [],
"minimum-stability": "stable",
"stability-flags": {},
"prefer-stable": false,
"prefer-lowest": false,
"platform": {},
"platform-dev": {},
"plugin-api-version": "2.9.0"
}

26
hooks/pre-commit Executable file
View File

@@ -0,0 +1,26 @@
#!/bin/bash
# Run Pint on staged PHP files before committing.
# Fixes formatting in-place and re-stages the corrected files.
STAGED_PHP=$(git diff --cached --name-only --diff-filter=ACM | grep '\.php$')
if [ -z "$STAGED_PHP" ]; then
exit 0
fi
# Check that Pint is installed
if [ ! -x "./vendor/bin/pint" ]; then
echo "Error: laravel/pint is not installed. Run 'composer install' first."
exit 1
fi
echo "Running Pint on staged PHP files..."
./vendor/bin/pint $STAGED_PHP
# Re-stage any files that Pint modified
for FILE in $STAGED_PHP; do
if [ -f "$FILE" ]; then
git add "$FILE"
fi
done

View File

@@ -1,13 +1,20 @@
<?php <?php
if (!defined("WHMCS")) { if (! defined('WHMCS')) {
die("This file cannot be accessed directly"); exit('This file cannot be accessed directly');
} }
use WHMCS\Module\Server\VirtFusionDirect\ModuleFunctions; use WHMCS\Database\Capsule;
use WHMCS\Module\Server\VirtFusionDirect\Module;
use WHMCS\Module\Server\VirtFusionDirect\Database; 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() function VirtFusionDirect_MetaData()
{ {
return [ return [
@@ -19,50 +26,55 @@ function VirtFusionDirect_MetaData()
]; ];
} }
/**
* Returns product configuration options displayed in the WHMCS product editor.
*
* @return array
*/
function VirtFusionDirect_ConfigOptions() function VirtFusionDirect_ConfigOptions()
{ {
return [ return [
"defaultHypervisorGroupId" => [ 'defaultHypervisorGroupId' => [
"FriendlyName" => "Hypervisor Group ID", 'FriendlyName' => 'Hypervisor Group ID',
"Type" => "text", 'Type' => 'text',
"Size" => "20", 'Size' => '20',
"Description" => "The default hypervisor group ID for server placement.", 'Description' => 'The default hypervisor group ID for server placement.',
"Default" => "1", 'Default' => '1',
], ],
"packageID" => [ 'packageID' => [
"FriendlyName" => "Package ID", 'FriendlyName' => 'Package ID',
"Type" => "text", 'Type' => 'text',
"Size" => "20", 'Size' => '20',
"Description" => "The VirtFusion package ID that defines server resources.", 'Description' => 'The VirtFusion package ID that defines server resources.',
"Default" => "1", 'Default' => '1',
], ],
"defaultIPv4" => [ 'defaultIPv4' => [
"FriendlyName" => "Default IPv4", 'FriendlyName' => 'Default IPv4',
"Type" => "dropdown", 'Type' => 'dropdown',
"Options" => "0,1,2,3,4,5,6,7,8,9,10", 'Options' => '0,1,2,3,4,5,6,7,8,9,10',
"Description" => "The default number of IPv4 addresses to assign to each server.", 'Description' => 'The default number of IPv4 addresses to assign to each server.',
"Default" => "1", 'Default' => '1',
], ],
"selfServiceMode" => [ 'selfServiceMode' => [
"FriendlyName" => "Self-Service Mode", 'FriendlyName' => 'Self-Service Mode',
"Type" => "dropdown", 'Type' => 'dropdown',
"Options" => "0|Disabled,1|Hourly,2|Resource Packs,3|Both", 'Options' => '0|Disabled,1|Hourly,2|Resource Packs,3|Both',
"Description" => "Enable VirtFusion self-service billing for users created by this product.", 'Description' => 'Enable VirtFusion self-service billing for users created by this product.',
"Default" => "0", 'Default' => '0',
], ],
"autoTopOffThreshold" => [ 'autoTopOffThreshold' => [
"FriendlyName" => "Auto Top-Off Threshold", 'FriendlyName' => 'Auto Top-Off Threshold',
"Type" => "text", 'Type' => 'text',
"Size" => "10", 'Size' => '10',
"Description" => "Credit balance below which auto top-off triggers during cron. 0 = disabled.", 'Description' => 'Credit balance below which auto top-off triggers during cron. 0 = disabled.',
"Default" => "0", 'Default' => '0',
], ],
"autoTopOffAmount" => [ 'autoTopOffAmount' => [
"FriendlyName" => "Auto Top-Off Amount", 'FriendlyName' => 'Auto Top-Off Amount',
"Type" => "text", 'Type' => 'text',
"Size" => "10", 'Size' => '10',
"Description" => "Credit amount to add when auto top-off triggers.", 'Description' => 'Credit amount to add when auto top-off triggers.',
"Default" => "100", 'Default' => '100',
], ],
]; ];
} }
@@ -78,7 +90,7 @@ function VirtFusionDirect_TestConnection(array $params)
} }
$url = 'https://' . $hostname . '/api/v1'; $url = 'https://' . $hostname . '/api/v1';
$module = new Module(); $module = new Module;
$request = $module->initCurl($password); $request = $module->initCurl($password);
$data = $request->get($url . '/connect'); $data = $request->get($url . '/connect');
@@ -94,27 +106,33 @@ function VirtFusionDirect_TestConnection(array $params)
if ($httpCode == 0) { if ($httpCode == 0) {
$curlError = $request->getRequestInfo('curl_error'); $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' => '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.']; return ['success' => false, 'error' => 'Unexpected response from VirtFusion API (HTTP ' . $httpCode . '). Please check the server configuration.'];
} catch (\Throwable $e) { } catch (Throwable $e) {
return ['success' => false, 'error' => 'Connection test failed: ' . $e->getMessage()]; 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() function VirtFusionDirect_AdminCustomButtonArray()
{ {
return [ return [
"Update Server Object" => "updateServerObject", 'Update Server Object' => 'updateServerObject',
"Validate Server Config" => "validateServerConfig", 'Validate Server Config' => 'validateServerConfig',
]; ];
} }
function VirtFusionDirect_ServiceSingleSignOn(array $params) function VirtFusionDirect_ServiceSingleSignOn(array $params)
{ {
try { try {
$module = new Module(); $module = new Module;
$token = $module->fetchLoginTokens($params['serviceid']); $token = $module->fetchLoginTokens($params['serviceid']);
if ($token) { if ($token) {
@@ -122,7 +140,7 @@ function VirtFusionDirect_ServiceSingleSignOn(array $params)
} }
return ['success' => false, 'errorMsg' => 'Unable to generate a login token. The server may not be active or the VirtFusion API may be unreachable.']; 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) { } catch (Exception $e) {
return ['success' => false, 'errorMsg' => $e->getMessage()]; return ['success' => false, 'errorMsg' => $e->getMessage()];
} }
} }
@@ -132,64 +150,104 @@ function VirtFusionDirect_ServiceSingleSignOn(array $params)
*/ */
function VirtFusionDirect_CreateAccount(array $params) function VirtFusionDirect_CreateAccount(array $params)
{ {
return (new ModuleFunctions())->createAccount($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) function VirtFusionDirect_SuspendAccount(array $params)
{ {
return (new ModuleFunctions())->suspendAccount($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) function VirtFusionDirect_UnsuspendAccount(array $params)
{ {
return (new ModuleFunctions())->unsuspendAccount($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) function VirtFusionDirect_TerminateAccount(array $params)
{ {
return (new ModuleFunctions())->terminateAccount($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) function VirtFusionDirect_updateServerObject(array $params)
{ {
return (new ModuleFunctions())->updateServerObject($params); return (new ModuleFunctions)->updateServerObject($params);
} }
/** /**
* Allows changing of the package of a server * Allows changing of the package of a server
* *
* @param array $params
* @return string * @return string
*/ */
function VirtFusionDirect_ChangePackage(array $params) function VirtFusionDirect_ChangePackage(array $params)
{ {
return (new ModuleFunctions())->changePackage($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) function VirtFusionDirect_AdminServicesTabFields(array $params)
{ {
return (new ModuleFunctions())->adminServicesTabFields($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) function VirtFusionDirect_AdminServicesTabFieldsSave(array $params)
{ {
(new ModuleFunctions())->adminServicesTabFieldsSave($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) function VirtFusionDirect_ClientArea(array $params)
{ {
return (new ModuleFunctions())->clientArea($params); return (new ModuleFunctions)->clientArea($params);
} }
/** /**
* Validates server configuration via dry run without creating the server. * Validates server configuration via dry run without creating the server.
* *
* @param array $params
* @return string 'success' or error message * @return string 'success' or error message
*/ */
function VirtFusionDirect_validateServerConfig(array $params) function VirtFusionDirect_validateServerConfig(array $params)
{ {
return (new ModuleFunctions())->validateServerConfig($params); return (new ModuleFunctions)->validateServerConfig($params);
} }
/** /**
@@ -198,20 +256,20 @@ function VirtFusionDirect_validateServerConfig(array $params)
* Updates tblhosting with disk and bandwidth usage data from VirtFusion. * Updates tblhosting with disk and bandwidth usage data from VirtFusion.
* Fields updated: diskused, disklimit, bwused, bwlimit, lastupdate * Fields updated: diskused, disklimit, bwused, bwlimit, lastupdate
* *
* @param array $params Server access credentials * @param array $params Server access credentials
* @return string 'success' or error message * @return string 'success' or error message
*/ */
function VirtFusionDirect_UsageUpdate(array $params) function VirtFusionDirect_UsageUpdate(array $params)
{ {
try { try {
$module = new Module(); $module = new Module;
$cp = $module->getCP($params['serverid']); $cp = $module->getCP($params['serverid']);
if (!$cp) { if (! $cp) {
return 'No control server found for usage update.'; return 'No control server found for usage update.';
} }
$services = \WHMCS\Database\Capsule::table('tblhosting') $services = Capsule::table('tblhosting')
->where('server', $params['serverid']) ->where('server', $params['serverid'])
->where('domainstatus', 'Active') ->where('domainstatus', 'Active')
->get(); ->get();
@@ -219,7 +277,7 @@ function VirtFusionDirect_UsageUpdate(array $params)
foreach ($services as $service) { foreach ($services as $service) {
try { try {
$systemService = Database::getSystemService($service->id); $systemService = Database::getSystemService($service->id);
if (!$systemService) { if (! $systemService) {
continue; continue;
} }
@@ -231,7 +289,7 @@ function VirtFusionDirect_UsageUpdate(array $params)
} }
$serverData = json_decode($data, true); $serverData = json_decode($data, true);
if (!isset($serverData['data'])) { if (! isset($serverData['data'])) {
continue; continue;
} }
@@ -255,15 +313,15 @@ function VirtFusionDirect_UsageUpdate(array $params)
$update['bwlimit'] = $trafficGB > 0 ? $trafficGB * 1024 : 0; $update['bwlimit'] = $trafficGB > 0 ? $trafficGB * 1024 : 0;
} }
if (!empty($update)) { if (! empty($update)) {
$update['lastupdate'] = date('Y-m-d H:i:s'); $update['lastupdate'] = date('Y-m-d H:i:s');
\WHMCS\Database\Capsule::table('tblhosting') Capsule::table('tblhosting')
->where('id', $service->id) ->where('id', $service->id)
->update($update); ->update($update);
} }
// Self-service auto top-off // Self-service auto top-off
$product = \WHMCS\Database\Capsule::table('tblproducts') $product = Capsule::table('tblproducts')
->where('id', $service->packageid) ->where('id', $service->packageid)
->first(); ->first();
@@ -278,24 +336,24 @@ function VirtFusionDirect_UsageUpdate(array $params)
$credit = $usageInner['credit'] ?? $usageInner['balance'] ?? null; $credit = $usageInner['credit'] ?? $usageInner['balance'] ?? null;
if ($credit !== null && (float) $credit < $threshold) { if ($credit !== null && (float) $credit < $threshold) {
$module->addSelfServiceCredit($service->id, $topOffAmount, 'Auto top-off'); $module->addSelfServiceCredit($service->id, $topOffAmount, 'Auto top-off');
\WHMCS\Module\Server\VirtFusionDirect\Log::insert( Log::insert(
'UsageUpdate:autoTopOff', 'UsageUpdate:autoTopOff',
['serviceId' => $service->id, 'credit' => $credit, 'threshold' => $threshold], ['serviceId' => $service->id, 'credit' => $credit, 'threshold' => $threshold],
['amount' => $topOffAmount] ['amount' => $topOffAmount],
); );
} }
} }
} }
} }
} catch (\Exception $e) { } catch (Exception $e) {
// Log but continue processing other services // Log but continue processing other services
\WHMCS\Module\Server\VirtFusionDirect\Log::insert('UsageUpdate:service:' . $service->id, [], $e->getMessage()); Log::insert('UsageUpdate:service:' . $service->id, [], $e->getMessage());
continue; continue;
} }
} }
return 'success'; return 'success';
} catch (\Exception $e) { } catch (Exception $e) {
return 'Usage update failed: ' . $e->getMessage(); return 'Usage update failed: ' . $e->getMessage();
} }
} }

View File

@@ -2,82 +2,97 @@
require dirname(__DIR__, 3) . '/init.php'; require dirname(__DIR__, 3) . '/init.php';
/**
* Admin-facing AJAX API endpoint.
*
* Requires WHMCS admin authentication. Provides server data lookup
* and user impersonation for the admin services tab.
*/
use WHMCS\Module\Server\VirtFusionDirect\Database; use WHMCS\Module\Server\VirtFusionDirect\Database;
use WHMCS\Module\Server\VirtFusionDirect\Log;
use WHMCS\Module\Server\VirtFusionDirect\Module; use WHMCS\Module\Server\VirtFusionDirect\Module;
use WHMCS\Module\Server\VirtFusionDirect\ServerResource; use WHMCS\Module\Server\VirtFusionDirect\ServerResource;
$vf = new Module(); $vf = new Module;
$vf->adminOnly(); try {
switch ($vf->validateAction(true)) { $vf->adminOnly();
/** switch ($vf->validateAction(true)) {
* Get server information.
*/
case 'serverData':
$serviceID = $vf->validateServiceID(true); /**
* Get server information.
*/
case 'serverData':
$whmcsService = Database::getWhmcsService($serviceID); $serviceID = $vf->validateServiceID(true);
if (!$whmcsService) { $whmcsService = Database::getWhmcsService($serviceID);
$vf->output(['success' => false, 'errors' => 'Service not found.'], true, true, 404);
if (! $whmcsService) {
$vf->output(['success' => false, 'errors' => 'Service not found.'], true, true, 404);
break;
}
if (in_array($whmcsService->domainstatus, ['Pending', 'Terminated', 'Cancelled', 'Fraud'], true)) {
$vf->output(['success' => false, 'errors' => 'Server is not Active, Suspended or Completed. Not fetching remote data.'], true, true, 400);
break;
}
$data = $vf->fetchServerData($serviceID);
if (! $data) {
$vf->output(['success' => false, 'errors' => 'No data returned from VirtFusion.'], true, true, 502);
break;
}
$vf->updateWhmcsServiceParamsOnServerObject($serviceID, $data);
$vf->output(['success' => true, 'data' => (new ServerResource)->process($data)], true, true, 200);
break; break;
}
if (in_array($whmcsService->domainstatus, ['Pending', 'Terminated', 'Cancelled', 'Fraud'], true)) { /**
$vf->output(['success' => false, 'errors' => 'Server is not Active, Suspended or Completed. Not fetching remote data.'], true, true, 400); * Impersonate server owner.
*/
case 'impersonateServerOwner':
$serviceID = $vf->validateServiceID(true);
$service = Database::getSystemService($serviceID);
if (! $service) {
$vf->output(['success' => false, 'errors' => 'Service not found'], true, true, 404);
break;
}
$whmcsService = Database::getWhmcsService($serviceID);
if (! $whmcsService) {
$vf->output(['success' => false, 'errors' => 'WHMCS service not found'], true, true, 404);
break;
}
$cp = $vf->getCP($whmcsService->server);
if (! $cp) {
$vf->output(['success' => false, 'errors' => 'Control server not found'], true, true, 500);
break;
}
$request = $vf->initCurl($cp['token']);
$data = $request->get($cp['url'] . '/users/' . (int) $whmcsService->userid . '/byExtRelation');
if ($request->getRequestInfo('http_code') === 200) {
$vf->output(['success' => true, 'url' => $cp['base_url'], 'user' => json_decode($data, true)['data']], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to fetch user data'], true, true, 502);
break; break;
}
$data = $vf->fetchServerData($serviceID); default:
$vf->output(['success' => false, 'errors' => 'invalid action'], true, true, 400);
}
if (!$data) { } catch (Exception $e) {
$vf->output(['success' => false, 'errors' => 'No data returned from VirtFusion.'], true, true, 502); Log::insert('admin.php', [], $e->getMessage());
break; $vf->output(['success' => false, 'errors' => 'An unexpected error occurred'], true, true, 500);
}
$vf->updateWhmcsServiceParamsOnServerObject($serviceID, $data);
$vf->output(['success' => true, 'data' => (new ServerResource())->process($data)], true, true, 200);
break;
/**
* Impersonate server owner.
*/
case 'impersonateServerOwner':
$serviceID = $vf->validateServiceID(true);
$service = Database::getSystemService($serviceID);
if (!$service) {
$vf->output(['success' => false, 'errors' => 'Service not found'], true, true, 404);
break;
}
$whmcsService = Database::getWhmcsService($serviceID);
if (!$whmcsService) {
$vf->output(['success' => false, 'errors' => 'WHMCS service not found'], true, true, 404);
break;
}
$cp = $vf->getCP($whmcsService->server);
if (!$cp) {
$vf->output(['success' => false, 'errors' => 'Control server not found'], true, true, 500);
break;
}
$request = $vf->initCurl($cp['token']);
$data = $request->get($cp['url'] . '/users/' . (int) $whmcsService->userid . '/byExtRelation');
if ($request->getRequestInfo('http_code') === 200) {
$vf->output(['success' => true, 'url' => $cp['base_url'], 'user' => json_decode($data, true)['data']], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to fetch user data'], true, true, 502);
break;
default:
$vf->output(['success' => false, 'errors' => 'invalid action'], true, true, 400);
} }

View File

@@ -2,399 +2,414 @@
require dirname(__DIR__, 3) . '/init.php'; require dirname(__DIR__, 3) . '/init.php';
/**
* Client-facing AJAX API endpoint.
*
* Authenticated by WHMCS session + service ownership validation.
* POST for mutations (power, rebuild, rename, credit), GET for reads (serverData, templates, backups).
*/
use WHMCS\Module\Server\VirtFusionDirect\Log;
use WHMCS\Module\Server\VirtFusionDirect\Module; use WHMCS\Module\Server\VirtFusionDirect\Module;
use WHMCS\Module\Server\VirtFusionDirect\ServerResource; use WHMCS\Module\Server\VirtFusionDirect\ServerResource;
$vf = new Module(); $vf = new Module;
$vf->isAuthenticated(); try {
$action = $vf->validateAction(true); $vf->isAuthenticated();
switch ($action) { $action = $vf->validateAction(true);
/** switch ($action) {
* Reset Password.
*/
case 'resetPassword':
$serviceID = $vf->validateServiceID(true); /**
$client = $vf->validateUserOwnsService($serviceID); * Reset Password.
*/
case 'resetPassword':
if (!$client) { $serviceID = $vf->validateServiceID(true);
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403); $client = $vf->validateUserOwnsService($serviceID);
if (! $client) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$data = $vf->resetUserPassword($serviceID, $client);
if ($data) {
$vf->output(['success' => true, 'data' => $data->data], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Password reset failed'], true, true, 500);
break; break;
}
$data = $vf->resetUserPassword($serviceID, $client); /**
* Get server information.
*/
case 'serverData':
if ($data) { $serviceID = $vf->validateServiceID(true);
$vf->output(['success' => true, 'data' => $data->data], true, true, 200);
if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$data = $vf->fetchServerData($serviceID);
if ($data) {
$vf->updateWhmcsServiceParamsOnServerObject($serviceID, $data);
$vf->output(['success' => true, 'data' => (new ServerResource)->process($data)], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to retrieve server data'], true, true, 500);
break; break;
}
$vf->output(['success' => false, 'errors' => 'Password reset failed'], true, true, 500); /**
break; * Login as server owner.
*/
case 'loginAsServerOwner':
/** $serviceID = $vf->validateServiceID(true);
* Get server information.
*/
case 'serverData':
$serviceID = $vf->validateServiceID(true); if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
if (!$vf->validateUserOwnsService($serviceID)) { $token = $vf->fetchLoginTokens($serviceID);
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
if ($token) {
$vf->output(['success' => true, 'token_url' => $token], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to generate login token'], true, true, 500);
break; break;
}
$data = $vf->fetchServerData($serviceID); /**
* Power management actions: boot, shutdown, restart, poweroff
*/
case 'powerAction':
if ($data) { $serviceID = $vf->validateServiceID(true);
$vf->updateWhmcsServiceParamsOnServerObject($serviceID, $data);
$vf->output(['success' => true, 'data' => (new ServerResource())->process($data)], true, true, 200); if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$powerAction = isset($_POST['powerAction']) ? preg_replace('/[^a-zA-Z]/', '', $_POST['powerAction']) : '';
$allowedActions = ['boot', 'shutdown', 'restart', 'poweroff'];
if (! in_array($powerAction, $allowedActions, true)) {
$vf->output(['success' => false, 'errors' => 'Invalid power action'], true, true, 400);
break;
}
$result = $vf->serverPowerAction($serviceID, $powerAction);
if ($result) {
$vf->output(['success' => true, 'data' => ['action' => $powerAction, 'message' => 'Power action queued successfully']], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Power action failed. The server may be locked or unavailable.'], true, true, 500);
break; break;
}
$vf->output(['success' => false, 'errors' => 'Unable to retrieve server data'], true, true, 500); /**
break; * Rebuild/reinstall server with new OS.
*/
case 'rebuild':
/** $serviceID = $vf->validateServiceID(true);
* Login as server owner.
*/
case 'loginAsServerOwner':
$serviceID = $vf->validateServiceID(true); if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
if (!$vf->validateUserOwnsService($serviceID)) { $osId = isset($_POST['osId']) ? (int) $_POST['osId'] : 0;
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403); $hostname = isset($_POST['hostname']) ? preg_replace('/[^a-zA-Z0-9.\-]/', '', $_POST['hostname']) : null;
if ($osId <= 0) {
$vf->output(['success' => false, 'errors' => 'Invalid operating system ID'], true, true, 400);
break;
}
$result = $vf->rebuildServer($serviceID, $osId, $hostname);
if ($result) {
$vf->output(['success' => true, 'data' => ['message' => 'Server rebuild initiated successfully']], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Server rebuild failed. The server may be locked or unavailable.'], true, true, 500);
break; break;
}
$token = $vf->fetchLoginTokens($serviceID); /**
* Rename server.
*/
case 'rename':
if ($token) { $serviceID = $vf->validateServiceID(true);
$vf->output(['success' => true, 'token_url' => $token], true, true, 200);
if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$newName = isset($_POST['name']) ? trim($_POST['name']) : '';
if (empty($newName) || strlen($newName) > 63 || ! preg_match('/^[a-z0-9]([a-z0-9\-]{0,61}[a-z0-9])?$/', $newName)) {
$vf->output(['success' => false, 'errors' => 'Invalid server name'], true, true, 400);
break;
}
$result = $vf->renameServer($serviceID, $newName);
if ($result) {
$vf->output(['success' => true, 'data' => ['message' => 'Server renamed successfully']], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Server rename failed'], true, true, 500);
break; break;
}
$vf->output(['success' => false, 'errors' => 'Unable to generate login token'], true, true, 500); /**
break; * Get available OS templates for rebuild.
*/
case 'osTemplates':
/** $serviceID = $vf->validateServiceID(true);
* Power management actions: boot, shutdown, restart, poweroff
*/
case 'powerAction':
$serviceID = $vf->validateServiceID(true); if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
if (!$vf->validateUserOwnsService($serviceID)) { $templates = $vf->fetchOsTemplates($serviceID);
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
if ($templates !== false) {
$vf->output(['success' => true, 'data' => $templates], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to fetch OS templates'], true, true, 500);
break; break;
}
$powerAction = isset($_POST['powerAction']) ? preg_replace('/[^a-zA-Z]/', '', $_POST['powerAction']) : ''; // =================================================================
$allowedActions = ['boot', 'shutdown', 'restart', 'poweroff']; // Server Password Reset
// =================================================================
if (!in_array($powerAction, $allowedActions, true)) { /**
$vf->output(['success' => false, 'errors' => 'Invalid power action'], true, true, 400); * Reset server root password.
*/
case 'resetServerPassword':
$serviceID = $vf->validateServiceID(true);
if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$result = $vf->resetServerPassword($serviceID);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Password reset failed'], true, true, 500);
break; break;
}
$result = $vf->serverPowerAction($serviceID, $powerAction); // =================================================================
// Backup Listing
// =================================================================
if ($result) { /**
$vf->output(['success' => true, 'data' => ['action' => $powerAction, 'message' => 'Power action queued successfully']], true, true, 200); * Get server backups.
*/
case 'backups':
$serviceID = $vf->validateServiceID(true);
if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$result = $vf->getServerBackups($serviceID);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to retrieve backups'], true, true, 500);
break; break;
}
$vf->output(['success' => false, 'errors' => 'Power action failed. The server may be locked or unavailable.'], true, true, 500); // =================================================================
break; // Traffic Statistics
// =================================================================
/** /**
* Rebuild/reinstall server with new OS. * Get traffic statistics for a server.
*/ */
case 'rebuild': case 'trafficStats':
$serviceID = $vf->validateServiceID(true); $serviceID = $vf->validateServiceID(true);
if (!$vf->validateUserOwnsService($serviceID)) { if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403); $vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$result = $vf->getTrafficStats($serviceID);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to retrieve traffic statistics'], true, true, 500);
break; break;
}
$osId = isset($_POST['osId']) ? (int) $_POST['osId'] : 0; // =================================================================
$hostname = isset($_POST['hostname']) ? preg_replace('/[^a-zA-Z0-9.\-]/', '', $_POST['hostname']) : null; // VNC Console
// =================================================================
if ($osId <= 0) { /**
$vf->output(['success' => false, 'errors' => 'Invalid operating system ID'], true, true, 400); * Get VNC console URL.
*/
case 'vnc':
$serviceID = $vf->validateServiceID(true);
if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$result = $vf->getVncConsole($serviceID);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'VNC console unavailable. The server may be powered off or VNC is not supported.'], true, true, 500);
break; break;
}
$result = $vf->rebuildServer($serviceID, $osId, $hostname); /**
* Toggle VNC on/off.
*/
case 'toggleVnc':
if ($result) { $serviceID = $vf->validateServiceID(true);
$vf->output(['success' => true, 'data' => ['message' => 'Server rebuild initiated successfully']], true, true, 200);
if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$enabled = isset($_POST['enabled']) && $_POST['enabled'] === '1';
$result = $vf->toggleVnc($serviceID, $enabled);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Failed to toggle VNC'], true, true, 500);
break; break;
}
$vf->output(['success' => false, 'errors' => 'Server rebuild failed. The server may be locked or unavailable.'], true, true, 500); // =================================================================
break; // Self Service — Credit & Usage
// =================================================================
/** /**
* Rename server. * Get self-service usage data.
*/ */
case 'rename': case 'selfServiceUsage':
$serviceID = $vf->validateServiceID(true); $serviceID = $vf->validateServiceID(true);
if (!$vf->validateUserOwnsService($serviceID)) { if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403); $vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$result = $vf->getSelfServiceUsage($serviceID);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to retrieve self-service usage data'], true, true, 500);
break; break;
}
$newName = isset($_POST['name']) ? trim($_POST['name']) : ''; /**
* Get self-service billing report.
*/
case 'selfServiceReport':
if (empty($newName) || strlen($newName) > 63 || !preg_match('/^[a-z0-9]([a-z0-9\-]{0,61}[a-z0-9])?$/', $newName)) { $serviceID = $vf->validateServiceID(true);
$vf->output(['success' => false, 'errors' => 'Invalid server name'], true, true, 400);
if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$result = $vf->getSelfServiceReport($serviceID);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to retrieve self-service report'], true, true, 500);
break; break;
}
$result = $vf->renameServer($serviceID, $newName); /**
* Add self-service credit.
*/
case 'selfServiceAddCredit':
if ($result) { $serviceID = $vf->validateServiceID(true);
$vf->output(['success' => true, 'data' => ['message' => 'Server renamed successfully']], true, true, 200);
if (! $vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$tokens = isset($_POST['tokens']) ? (float) $_POST['tokens'] : 0;
if ($tokens <= 0) {
$vf->output(['success' => false, 'errors' => 'Invalid credit amount. Must be a positive number.'], true, true, 400);
break;
}
$result = $vf->addSelfServiceCredit($serviceID, $tokens);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Failed to add credit'], true, true, 500);
break; break;
}
$vf->output(['success' => false, 'errors' => 'Server rename failed'], true, true, 500); default:
break; $vf->output(['success' => false, 'errors' => 'invalid action'], true, true, 400);
}
/** } catch (Exception $e) {
* Get available OS templates for rebuild. Log::insert('client.php', [], $e->getMessage());
*/ $vf->output(['success' => false, 'errors' => 'An unexpected error occurred'], true, true, 500);
case 'osTemplates':
$serviceID = $vf->validateServiceID(true);
if (!$vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$templates = $vf->fetchOsTemplates($serviceID);
if ($templates !== false) {
$vf->output(['success' => true, 'data' => $templates], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to fetch OS templates'], true, true, 500);
break;
// =================================================================
// Server Password Reset
// =================================================================
/**
* Reset server root password.
*/
case 'resetServerPassword':
$serviceID = $vf->validateServiceID(true);
if (!$vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$result = $vf->resetServerPassword($serviceID);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Password reset failed'], true, true, 500);
break;
// =================================================================
// Backup Listing
// =================================================================
/**
* Get server backups.
*/
case 'backups':
$serviceID = $vf->validateServiceID(true);
if (!$vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$result = $vf->getServerBackups($serviceID);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to retrieve backups'], true, true, 500);
break;
// =================================================================
// Traffic Statistics
// =================================================================
/**
* Get traffic statistics for a server.
*/
case 'trafficStats':
$serviceID = $vf->validateServiceID(true);
if (!$vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$result = $vf->getTrafficStats($serviceID);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to retrieve traffic statistics'], true, true, 500);
break;
// =================================================================
// VNC Console
// =================================================================
/**
* Get VNC console URL.
*/
case 'vnc':
$serviceID = $vf->validateServiceID(true);
if (!$vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$result = $vf->getVncConsole($serviceID);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'VNC console unavailable. The server may be powered off or VNC is not supported.'], true, true, 500);
break;
/**
* Toggle VNC on/off.
*/
case 'toggleVnc':
$serviceID = $vf->validateServiceID(true);
if (!$vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$enabled = isset($_POST['enabled']) && $_POST['enabled'] === '1';
$result = $vf->toggleVnc($serviceID, $enabled);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Failed to toggle VNC'], true, true, 500);
break;
// =================================================================
// Self Service — Credit & Usage
// =================================================================
/**
* Get self-service usage data.
*/
case 'selfServiceUsage':
$serviceID = $vf->validateServiceID(true);
if (!$vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$result = $vf->getSelfServiceUsage($serviceID);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to retrieve self-service usage data'], true, true, 500);
break;
/**
* Get self-service billing report.
*/
case 'selfServiceReport':
$serviceID = $vf->validateServiceID(true);
if (!$vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$result = $vf->getSelfServiceReport($serviceID);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Unable to retrieve self-service report'], true, true, 500);
break;
/**
* Add self-service credit.
*/
case 'selfServiceAddCredit':
$serviceID = $vf->validateServiceID(true);
if (!$vf->validateUserOwnsService($serviceID)) {
$vf->output(['success' => false, 'errors' => 'service <> owner mismatch'], true, true, 403);
break;
}
$tokens = isset($_POST['tokens']) ? (float) $_POST['tokens'] : 0;
if ($tokens <= 0) {
$vf->output(['success' => false, 'errors' => 'Invalid credit amount. Must be a positive number.'], true, true, 400);
break;
}
$result = $vf->addSelfServiceCredit($serviceID, $tokens);
if ($result !== false) {
$vf->output(['success' => true, 'data' => $result], true, true, 200);
break;
}
$vf->output(['success' => false, 'errors' => 'Failed to add credit'], true, true, 500);
break;
default:
$vf->output(['success' => false, 'errors' => 'invalid action'], true, true, 400);
} }

View File

@@ -1,7 +1,7 @@
<?php <?php
if (!defined("WHMCS")) { if (! defined('WHMCS')) {
die("This file cannot be accessed directly"); exit('This file cannot be accessed directly');
} }
return [ return [

View File

@@ -1,10 +1,12 @@
<?php <?php
use WHMCS\Database\Capsule;
use WHMCS\Module\Server\VirtFusionDirect\ConfigureService; use WHMCS\Module\Server\VirtFusionDirect\ConfigureService;
use WHMCS\Module\Server\VirtFusionDirect\Database; use WHMCS\Module\Server\VirtFusionDirect\Database;
use WHMCS\Module\Server\VirtFusionDirect\Module;
if (!defined("WHMCS")) { if (! defined('WHMCS')) {
die("This file cannot be accessed directly"); exit('This file cannot be accessed directly');
} }
/** /**
@@ -16,47 +18,51 @@ if (!defined("WHMCS")) {
add_hook('ShoppingCartValidateCheckout', 1, function ($vars) { add_hook('ShoppingCartValidateCheckout', 1, function ($vars) {
$errors = []; $errors = [];
if (!isset($_SESSION['cart']['products']) || !is_array($_SESSION['cart']['products'])) { try {
return $errors; if (! isset($_SESSION['cart']['products']) || ! is_array($_SESSION['cart']['products'])) {
} return $errors;
foreach ($_SESSION['cart']['products'] as $key => $product) {
$pid = $product['pid'] ?? null;
if (!$pid) {
continue;
} }
$dbProduct = \WHMCS\Database\Capsule::table('tblproducts') foreach ($_SESSION['cart']['products'] as $key => $product) {
->where('id', $pid) $pid = $product['pid'] ?? null;
->where('servertype', 'VirtFusionDirect') if (! $pid) {
->first(); continue;
}
if (!$dbProduct) { $dbProduct = Capsule::table('tblproducts')
continue; ->where('id', $pid)
} ->where('servertype', 'VirtFusionDirect')
->first();
// Check if Initial Operating System custom field has a value if (! $dbProduct) {
if (isset($product['customfields']) && is_array($product['customfields'])) { continue;
$osSelected = false; }
$customFields = \WHMCS\Database\Capsule::table('tblcustomfields')
->where('relid', $pid)
->where('type', 'product')
->get();
foreach ($customFields as $field) { // Check if Initial Operating System custom field has a value
if (strtolower(str_replace(' ', '', $field->fieldname)) === 'initialoperatingsystem') { if (isset($product['customfields']) && is_array($product['customfields'])) {
$fieldValue = $product['customfields'][$field->id] ?? ''; $osSelected = false;
if (!empty($fieldValue) && is_numeric($fieldValue)) { $customFields = Capsule::table('tblcustomfields')
$osSelected = true; ->where('relid', $pid)
->where('type', 'product')
->get();
foreach ($customFields as $field) {
if (strtolower(str_replace(' ', '', $field->fieldname)) === 'initialoperatingsystem') {
$fieldValue = $product['customfields'][$field->id] ?? '';
if (! empty($fieldValue) && is_numeric($fieldValue)) {
$osSelected = true;
}
break;
} }
break; }
if (! $osSelected) {
$errors[] = 'Please select an Operating System for your VPS order.';
} }
} }
if (!$osSelected) {
$errors[] = 'Please select an Operating System for your VPS order.';
}
} }
} catch (Exception $e) {
// Don't block checkout on internal errors
} }
return $errors; return $errors;
@@ -70,22 +76,22 @@ add_hook('ShoppingCartValidateCheckout', 1, function ($vars) {
* Works with all WHMCS themes by using vanilla JavaScript and standard form-control classes. * Works with all WHMCS themes by using vanilla JavaScript and standard form-control classes.
*/ */
add_hook('ClientAreaFooterOutput', 1, function ($vars) { add_hook('ClientAreaFooterOutput', 1, function ($vars) {
if (!isset($vars['productinfo']['module']) || $vars['productinfo']['module'] !== 'VirtFusionDirect') { if (! isset($vars['productinfo']['module']) || $vars['productinfo']['module'] !== 'VirtFusionDirect') {
return null; return null;
} }
try { try {
$cs = new ConfigureService(); $cs = new ConfigureService;
$templates_data = $cs->fetchTemplates( $templates_data = $cs->fetchTemplates(
$cs->fetchPackageByDbId($vars['productinfo']['pid']) ?? $cs->fetchPackageId($vars['productinfo']['name']) $cs->fetchPackageByDbId($vars['productinfo']['pid']) ?? $cs->fetchPackageId($vars['productinfo']['name']),
); );
if (empty($templates_data)) { if (empty($templates_data)) {
return null; return null;
} }
$vfServer = \WHMCS\Database\Capsule::table('tblservers') $vfServer = Capsule::table('tblservers')
->where('type', 'VirtFusionDirect') ->where('type', 'VirtFusionDirect')
->where('disabled', 0) ->where('disabled', 0)
->first(); ->first();
@@ -93,7 +99,7 @@ add_hook('ClientAreaFooterOutput', 1, function ($vars) {
$galleryData = [ $galleryData = [
'baseUrl' => $baseUrl, 'baseUrl' => $baseUrl,
'categories' => \WHMCS\Module\Server\VirtFusionDirect\Module::groupOsTemplates($templates_data['data'] ?? [], true), 'categories' => Module::groupOsTemplates($templates_data['data'] ?? [], true),
]; ];
$sshKeys = []; $sshKeys = [];
@@ -105,9 +111,10 @@ add_hook('ClientAreaFooterOutput', 1, function ($vars) {
if ($sshKey['enabled'] === false) { if ($sshKey['enabled'] === false) {
return null; return null;
} }
return [ return [
'id' => $sshKey['id'], 'id' => $sshKey['id'],
'name' => htmlspecialchars($sshKey['name'], ENT_QUOTES, 'UTF-8') 'name' => htmlspecialchars($sshKey['name'], ENT_QUOTES, 'UTF-8'),
]; ];
}, $sshKeysData['data']))); }, $sshKeysData['data'])));
} }
@@ -134,17 +141,17 @@ add_hook('ClientAreaFooterOutput', 1, function ($vars) {
$systemUrl = Database::getSystemUrl(); $systemUrl = Database::getSystemUrl();
return " return '
<link href=\"" . htmlspecialchars($systemUrl, ENT_QUOTES, 'UTF-8') . "modules/servers/VirtFusionDirect/templates/css/module.css?v=" . time() . "\" rel=\"stylesheet\"> <link href="' . htmlspecialchars($systemUrl, ENT_QUOTES, 'UTF-8') . 'modules/servers/VirtFusionDirect/templates/css/module.css?v=' . time() . '" rel="stylesheet">
<script src=\"" . htmlspecialchars($systemUrl, ENT_QUOTES, 'UTF-8') . "modules/servers/VirtFusionDirect/templates/js/keygen.js?v=" . time() . "\"></script> <script src="' . htmlspecialchars($systemUrl, ENT_QUOTES, 'UTF-8') . 'modules/servers/VirtFusionDirect/templates/js/keygen.js?v=' . time() . "\"></script>
<script> <script>
document.addEventListener('DOMContentLoaded', function() { document.addEventListener('DOMContentLoaded', function() {
var osGalleryData = " . json_encode($galleryData, JSON_THROW_ON_ERROR | JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT) . "; var osGalleryData = " . json_encode($galleryData, JSON_THROW_ON_ERROR | JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT) . ';
var sshKeys = " . json_encode($sshKeysOptions, JSON_THROW_ON_ERROR | JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT) . "; var sshKeys = ' . json_encode($sshKeysOptions, JSON_THROW_ON_ERROR | JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT) . ";
var osInputField = document.querySelector('[name=\"customfield[" . (int) $osFieldId . "]\"]'); var osInputField = document.querySelector('[name=\"customfield[" . (int) $osFieldId . "]\"]');
var sshInputField = " . ($sshFieldId !== null ? "document.querySelector('[name=\"customfield[" . (int) $sshFieldId . "]\"]')" : "null") . "; var sshInputField = " . ($sshFieldId !== null ? "document.querySelector('[name=\"customfield[" . (int) $sshFieldId . "]\"]')" : 'null') . ';
var sshInputLabel = " . ($sshFieldId !== null ? "document.querySelector('[for=\"customfield" . (int) $sshFieldId . "\"]')" : "null") . "; var sshInputLabel = ' . ($sshFieldId !== null ? "document.querySelector('[for=\"customfield" . (int) $sshFieldId . "\"]')" : 'null') . ";
if (!osInputField) return; if (!osInputField) return;
@@ -564,7 +571,7 @@ add_hook('ClientAreaFooterOutput', 1, function ($vars) {
}); });
</script> </script>
"; ";
} catch (\Throwable $e) { } catch (Throwable $e) {
// Silently fail - don't break the checkout page // Silently fail - don't break the checkout page
return null; return null;
} }

View File

@@ -2,41 +2,73 @@
namespace WHMCS\Module\Server\VirtFusionDirect; namespace WHMCS\Module\Server\VirtFusionDirect;
/**
* Static methods that generate HTML fragments for the WHMCS admin services tab.
*/
class AdminHTML class AdminHTML
{ {
/**
* Render the "Impersonate Server Owner" button for the admin services tab.
*
* @param string $systemUrl WHMCS system URL
* @param int $serviceId VirtFusion server ID
* @return string HTML button markup
*/
public static function options($systemUrl, $serviceId) public static function options($systemUrl, $serviceId)
{ {
$systemUrl = htmlspecialchars($systemUrl, ENT_QUOTES, 'UTF-8'); $systemUrl = htmlspecialchars($systemUrl, ENT_QUOTES, 'UTF-8');
return <<<EOT return <<<EOT
<button onclick="impersonateServerOwner('${serviceId}', '${systemUrl}')" type="button" class="btn btn-primary">Impersonate Server Owner</button> <button onclick="impersonateServerOwner('${serviceId}', '${systemUrl}')" type="button" class="btn btn-primary">Impersonate Server Owner</button>
<span class="text-info">&nbsp;&nbsp;A valid VirtFusion admin session in the same browser is required for this functionality to work.</span> <span class="text-info">&nbsp;&nbsp;A valid VirtFusion admin session in the same browser is required for this functionality to work.</span>
EOT; EOT;
} }
/**
* Render a read-only textarea containing the raw VirtFusion server JSON object.
*
* @param string $serverObject JSON-encoded server object from the VirtFusion API
* @return string HTML textarea markup
*/
public static function serverObject($serverObject) public static function serverObject($serverObject)
{ {
$serverObject = htmlspecialchars($serverObject, ENT_QUOTES, 'UTF-8'); $serverObject = htmlspecialchars($serverObject, ENT_QUOTES, 'UTF-8');
return <<<EOT return <<<EOT
<textarea class="form-control" name="modulefields[1]" rows="10" style="width: 100%" disabled>${serverObject}</textarea> <textarea class="form-control" name="modulefields[1]" rows="10" style="width: 100%" disabled>${serverObject}</textarea>
EOT; EOT;
} }
/**
* Render an editable text input for the VirtFusion server ID field.
*
* @param int $serverId Current VirtFusion server ID
* @return string HTML input markup with a warning note
*/
public static function serverId($serverId) public static function serverId($serverId)
{ {
$serverId = (int) $serverId; $serverId = (int) $serverId;
return <<<EOT return <<<EOT
<input type="text" class="form-control input-200 input-inline" name="modulefields[0]" size="20" value="${serverId}" /> <input type="text" class="form-control input-200 input-inline" name="modulefields[0]" size="20" value="${serverId}" />
<span class="text-info">&nbsp;&nbsp;Changing the Sever ID manually is not recommended. Alterations to this field are usually handled automatically.</span> <span class="text-info">&nbsp;&nbsp;Changing the Sever ID manually is not recommended. Alterations to this field are usually handled automatically.</span>
EOT; EOT;
} }
/**
* Render the inline server info panel for the admin services tab, including CSS/JS assets.
*
* @param string $systemUrl WHMCS system URL (used to build asset and AJAX URLs)
* @param int $serviceId VirtFusion server ID passed to the JS data-loader
* @return string HTML panel markup with embedded script and asset tags
*/
public static function serverInfo($systemUrl, $serviceId) public static function serverInfo($systemUrl, $serviceId)
{ {
$systemUrl = htmlspecialchars($systemUrl, ENT_QUOTES, 'UTF-8'); $systemUrl = htmlspecialchars($systemUrl, ENT_QUOTES, 'UTF-8');
$serviceId = (int) $serviceId; $serviceId = (int) $serviceId;
$cacheV = time(); $cacheV = time();
return <<<EOT return <<<EOT
<link href="${systemUrl}modules/servers/VirtFusionDirect/templates/css/module.css?v=${cacheV}" rel="stylesheet"> <link href="${systemUrl}modules/servers/VirtFusionDirect/templates/css/module.css?v=${cacheV}" rel="stylesheet">
<script src="${systemUrl}modules/servers/VirtFusionDirect/templates/js/module.js?v=${cacheV}"></script> <script src="${systemUrl}modules/servers/VirtFusionDirect/templates/js/module.js?v=${cacheV}"></script>

View File

@@ -2,6 +2,10 @@
namespace WHMCS\Module\Server\VirtFusionDirect; namespace WHMCS\Module\Server\VirtFusionDirect;
/**
* Two-tier cache: uses Redis when the ext-redis extension is available, with an atomic
* filesystem fallback stored in the system temp directory.
*/
class Cache class Cache
{ {
const PREFIX = 'vfd:'; const PREFIX = 'vfd:';
@@ -28,19 +32,22 @@ class Cache
return self::$redis; return self::$redis;
} }
if (!extension_loaded('redis')) { if (! extension_loaded('redis')) {
self::$redisAvailable = false; self::$redisAvailable = false;
return null; return null;
} }
try { try {
$redis = new \Redis(); $redis = new \Redis;
$redis->connect('127.0.0.1', 6379, 1.0); $redis->connect('127.0.0.1', 6379, 1.0);
self::$redis = $redis; self::$redis = $redis;
self::$redisAvailable = true; self::$redisAvailable = true;
return $redis; return $redis;
} catch (\Exception $e) { } catch (\Exception $e) {
self::$redisAvailable = false; self::$redisAvailable = false;
return null; return null;
} }
} }
@@ -55,11 +62,12 @@ class Cache
} }
$dir = sys_get_temp_dir() . '/vfd_cache'; $dir = sys_get_temp_dir() . '/vfd_cache';
if (!is_dir($dir)) { if (! is_dir($dir)) {
@mkdir($dir, 0700, true); @mkdir($dir, 0700, true);
} }
self::$fileDir = $dir; self::$fileDir = $dir;
return $dir; return $dir;
} }
@@ -74,7 +82,7 @@ class Cache
/** /**
* Get a cached value. * Get a cached value.
* *
* @param string $key * @param string $key
* @return mixed|null Returns null on miss * @return mixed|null Returns null on miss
*/ */
public static function get($key) public static function get($key)
@@ -87,6 +95,7 @@ class Cache
if ($data !== false) { if ($data !== false) {
return json_decode($data, true); return json_decode($data, true);
} }
return null; return null;
} catch (\Exception $e) { } catch (\Exception $e) {
// Fall through to file cache // Fall through to file cache
@@ -95,7 +104,7 @@ class Cache
// File cache fallback // File cache fallback
$path = self::filePath($key); $path = self::filePath($key);
if (!file_exists($path)) { if (! file_exists($path)) {
return null; return null;
} }
@@ -105,13 +114,15 @@ class Cache
} }
$entry = json_decode($raw, true); $entry = json_decode($raw, true);
if (!$entry || !isset($entry['expires']) || !isset($entry['data'])) { if (! $entry || ! isset($entry['expires']) || ! isset($entry['data'])) {
@unlink($path); @unlink($path);
return null; return null;
} }
if ($entry['expires'] < time()) { if ($entry['expires'] < time()) {
@unlink($path); @unlink($path);
return null; return null;
} }
@@ -121,9 +132,9 @@ class Cache
/** /**
* Store a value in cache. * Store a value in cache.
* *
* @param string $key * @param string $key
* @param mixed $value * @param mixed $value
* @param int $ttl Time-to-live in seconds * @param int $ttl Time-to-live in seconds
*/ */
public static function set($key, $value, $ttl = 300) public static function set($key, $value, $ttl = 300)
{ {
@@ -132,6 +143,7 @@ class Cache
if ($redis) { if ($redis) {
try { try {
$redis->setex(self::PREFIX . $key, $ttl, json_encode($value)); $redis->setex(self::PREFIX . $key, $ttl, json_encode($value));
return; return;
} catch (\Exception $e) { } catch (\Exception $e) {
// Fall through to file cache // Fall through to file cache
@@ -151,7 +163,7 @@ class Cache
/** /**
* Delete a cached value. * Delete a cached value.
* *
* @param string $key * @param string $key
*/ */
public static function forget($key) public static function forget($key)
{ {
@@ -169,5 +181,4 @@ class Cache
@unlink($path); @unlink($path);
} }
} }
} }

View File

@@ -5,13 +5,30 @@ namespace WHMCS\Module\Server\VirtFusionDirect;
use WHMCS\Database\Capsule as DB; use WHMCS\Database\Capsule as DB;
use WHMCS\User\User; use WHMCS\User\User;
/**
* Handles order-time and provisioning-time operations for VirtFusion servers.
*
* Extends Module to provide package discovery, OS template fetching, server build
* initialization, and SSH key retrieval/creation. Used during WHMCS checkout and
* account creation flows rather than ongoing service management.
*/
class ConfigureService extends Module class ConfigureService extends Module
{ {
/** /**
* @var array|false $cp * The first available VirtFusion control panel connection, as returned by
* getCP(). Holds server URL and API token used for all API calls in this
* class. False if no active VirtFusion server is configured in WHMCS.
*
* @var array|false
*/ */
private array|bool $cp; private array|bool $cp;
/**
* Initialize the service configurator with the first available VirtFusion server.
*
* Calls the parent Module constructor then resolves the control panel connection
* so all methods in this class have a ready API endpoint.
*/
public function __construct() public function __construct()
{ {
parent::__construct(); parent::__construct();
@@ -19,208 +36,298 @@ class ConfigureService extends Module
} }
/** /**
* @param string $packageName * Find a VirtFusion package ID by its name via the API.
* @return int|null *
* @throws JsonException * Searches the packages list for an enabled package whose name matches
* exactly. Result is cached for 10 minutes. Returns null if not found
* or if no control panel is available.
*
* @param string $packageName Exact package name as configured in VirtFusion.
* @return int|null Package ID, or null if not found.
*/ */
public function fetchPackageId(string $packageName): ?int public function fetchPackageId(string $packageName): ?int
{ {
$cacheKey = 'pkg_name:' . md5($packageName); try {
$cached = Cache::get($cacheKey); $cacheKey = 'pkg_name:' . md5($packageName);
if ($cached !== null) { $cached = Cache::get($cacheKey);
return $cached; if ($cached !== null) {
} return $cached;
if (!$this->cp) return null;
$request = $this->initCurl($this->cp['token']);
$response = $request->get(
sprintf("%s/packages", $this->cp['url'])
);
$packages = $this->decodeResponseFromJson($response);
foreach ($packages['data'] as $package) {
if ($package['name'] === $packageName && $package['enabled'] === true) {
Cache::set($cacheKey, $package['id'], 600);
return $package['id'];
} }
}
return null; if (! $this->cp) {
return null;
}
$request = $this->initCurl($this->cp['token']);
$response = $request->get(
sprintf('%s/packages', $this->cp['url']),
);
$packages = $this->decodeResponseFromJson($response);
foreach ($packages['data'] as $package) {
if ($package['name'] === $packageName && $package['enabled'] === true) {
Cache::set($cacheKey, $package['id'], 600);
return $package['id'];
}
}
return null;
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
return null;
}
} }
/** /**
* @param int $productId * Get the VirtFusion package ID from a WHMCS product's config option.
* @return int|null *
* Reads configoption2 directly from the tblproducts database record for
* the given WHMCS product ID. Returns null if the product does not exist.
*
* @param int $productId WHMCS product (tblproducts) ID.
* @return int|null VirtFusion package ID, or null if the product is not found.
*/ */
public function fetchPackageByDbId(int $productId): ?int public function fetchPackageByDbId(int $productId): ?int
{ {
$product = DB::table('tblproducts')->where('id', $productId)->first(); try {
$product = DB::table('tblproducts')->where('id', $productId)->first();
if (is_null($product)) {
return null;
}
return (int) $product->configoption2;
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
if (is_null($product)) {
return null; return null;
} }
return (int)$product->configoption2;
} }
/** /**
* @param int $serverPackageId * Fetch the available OS templates for a given VirtFusion server package.
* @return array|null *
* @throws JsonException * Queries the VirtFusion API for templates compatible with the specified
* package spec ID. Result is cached for 10 minutes. Returns null if no
* package ID is provided or no control panel is available.
*
* @param int|null $serverPackageId VirtFusion server package spec ID.
* @return array|null Template list from the API, or null on failure.
*/ */
public function fetchTemplates(?int $serverPackageId): ?array public function fetchTemplates(?int $serverPackageId): ?array
{ {
if (is_null($serverPackageId)) { try {
if (is_null($serverPackageId)) {
return null;
}
$cacheKey = 'tpl:' . $serverPackageId;
$cached = Cache::get($cacheKey);
if ($cached !== null) {
return $cached;
}
if (! $this->cp) {
return null;
}
$request = $this->initCurl($this->cp['token']);
$response = $request->get(
sprintf('%s/media/templates/fromServerPackageSpec/%d', $this->cp['url'], $serverPackageId),
);
$result = $this->decodeResponseFromJson($response);
Cache::set($cacheKey, $result, 600);
return $result;
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
return null; return null;
} }
$cacheKey = 'tpl:' . $serverPackageId;
$cached = Cache::get($cacheKey);
if ($cached !== null) {
return $cached;
}
if (!$this->cp) return null;
$request = $this->initCurl($this->cp['token']);
$response = $request->get(
sprintf("%s/media/templates/fromServerPackageSpec/%d", $this->cp['url'], $serverPackageId)
);
$result = $this->decodeResponseFromJson($response);
Cache::set($cacheKey, $result, 600);
return $result;
} }
/** /**
* @param User|null $user * Get the SSH keys registered for a VirtFusion user.
* @return array|null *
* @throws JsonException * Looks up the VirtFusion account for the given WHMCS user via external
* relation ID, then fetches their SSH key list from the API. Returns null
* if the user is not found in VirtFusion or no control panel is available.
*
* @param User|null $user WHMCS User object.
* @return array|null SSH key list from the API, or null on failure.
*/ */
public function getUserSshKeys(?User $user): ?array public function getUserSshKeys(?User $user): ?array
{ {
if (is_null($user)) { try {
if (is_null($user)) {
return null;
}
if (! $this->cp) {
return null;
}
$request = $this->initCurl($this->cp['token']);
$vfUser = $this->getVFUserDetails($user['id']);
if (! $vfUser) {
return null;
}
$response = $request->get(
sprintf('%s/ssh_keys/user/%d', $this->cp['url'], $vfUser['id']),
);
return $this->decodeResponseFromJson($response);
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
return null; return null;
} }
if (!$this->cp) return null;
$request = $this->initCurl($this->cp['token']);
$vfUser = $this->getVFUserDetails($user['id']);
if (!$vfUser) return null;
$response = $request->get(
sprintf("%s/ssh_keys/user/%d", $this->cp['url'], $vfUser['id'])
);
return $this->decodeResponseFromJson($response);
} }
/** /**
* @param int $id * Look up a VirtFusion user by WHMCS external relation ID.
* @return array|null *
* @throws JsonException * Calls the VirtFusion API's byExtRelation endpoint using the WHMCS client
* ID. Returns null if the user does not exist in VirtFusion or no control
* panel is available.
*
* @param int $id WHMCS client ID used as the VirtFusion external relation ID.
* @return array|null VirtFusion user data array, or null if not found.
*/ */
public function getVFUserDetails(int $id): ?array public function getVFUserDetails(int $id): ?array
{ {
if (!$this->cp) return null; try {
if (! $this->cp) {
return null;
}
$request = $this->initCurl($this->cp['token']); $request = $this->initCurl($this->cp['token']);
$response = $this->decodeResponseFromJson($request->get( $response = $this->decodeResponseFromJson($request->get(
sprintf("%s/users/%d/byExtRelation", $this->cp['url'], $id) sprintf('%s/users/%d/byExtRelation', $this->cp['url'], $id),
)); ));
return isset($response['msg']) && $response['msg'] === "ext_relation_id not found" ? null : $response['data']; return isset($response['msg']) && $response['msg'] === 'ext_relation_id not found' ? null : $response['data'];
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
return null;
}
} }
/** /**
* @param int $id * Trigger OS installation on a newly created VirtFusion server.
* @param array $vars *
* @param int|null $vfUserId VirtFusion user ID (for creating SSH keys from raw public key) * Posts a build request to the VirtFusion API with the selected OS template
* @return bool * and optionally an SSH key. If the custom field contains a numeric value it
* is treated as an existing key ID; if it is a raw public key string, the key
* is created first via createUserSshKey(). Returns true on HTTP 200/201.
*
* @param int $id VirtFusion server ID to build.
* @param array $vars WHMCS order vars, including customfields for OS and SSH key.
* @param int|null $vfUserId VirtFusion user ID, required when creating a new SSH key from a raw public key.
* @return bool True if the build request was accepted, false otherwise.
*/ */
public function initServerBuild(int $id, array $vars, ?int $vfUserId = null): bool public function initServerBuild(int $id, array $vars, ?int $vfUserId = null): bool
{ {
if (!$this->cp) return false; try {
if (! $this->cp) {
$request = $this->initCurl($this->cp['token']); return false;
// Generate a hostname with sufficient entropy to avoid collisions
$hostname = 'vps-' . bin2hex(random_bytes(4));
$sshKeyValue = $vars['customfields']['Initial SSH Key'] ?? null;
$sshKeyId = null;
if (!empty($sshKeyValue)) {
if (is_numeric($sshKeyValue)) {
// Existing SSH key ID
$sshKeyId = (int) $sshKeyValue;
} elseif (preg_match('/^ssh-/', $sshKeyValue) && $vfUserId) {
// Raw public key — create it via API
$sshKeyId = $this->createUserSshKey($vfUserId, $sshKeyValue);
} }
$request = $this->initCurl($this->cp['token']);
// Generate a hostname with sufficient entropy to avoid collisions
$hostname = 'vps-' . bin2hex(random_bytes(4));
$sshKeyValue = $vars['customfields']['Initial SSH Key'] ?? null;
$sshKeyId = null;
if (! empty($sshKeyValue)) {
if (is_numeric($sshKeyValue)) {
// Existing SSH key ID
$sshKeyId = (int) $sshKeyValue;
} elseif (preg_match('/^ssh-/', $sshKeyValue) && $vfUserId) {
// Raw public key — create it via API
$sshKeyId = $this->createUserSshKey($vfUserId, $sshKeyValue);
}
}
$inputData = [
'operatingSystemId' => $vars['customfields']['Initial Operating System'] ?? null,
'name' => $hostname,
'email' => true,
];
if ($sshKeyId) {
$inputData['sshKeys'] = [$sshKeyId];
}
$request->addOption(CURLOPT_POSTFIELDS, json_encode($inputData));
$response = $request->post(
sprintf('%s/servers/%d/build', $this->cp['url'], $id),
);
$httpCode = $request->getRequestInfo('http_code');
Log::insert(__FUNCTION__, $request->getRequestInfo(), $response);
return $httpCode == 200 || $httpCode == 201;
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
return false;
} }
$inputData = [
"operatingSystemId" => $vars['customfields']['Initial Operating System'] ?? null,
"name" => $hostname,
'email' => true
];
if ($sshKeyId) {
$inputData['sshKeys'] = [$sshKeyId];
}
$request->addOption(CURLOPT_POSTFIELDS, json_encode($inputData));
$response = $request->post(
sprintf("%s/servers/%d/build", $this->cp['url'], $id)
);
$httpCode = $request->getRequestInfo('http_code');
Log::insert(__FUNCTION__, $request->getRequestInfo(), $response);
return ($httpCode == 200 || $httpCode == 201);
} }
/** /**
* Create an SSH key for a VirtFusion user from a raw public key string. * Create an SSH key for a VirtFusion user from a raw public key string.
* *
* @param int $userId VirtFusion user ID * @param int $userId VirtFusion user ID
* @param string $publicKey Raw SSH public key (ssh-rsa ..., ssh-ed25519 ..., etc.) * @param string $publicKey Raw SSH public key (ssh-rsa ..., ssh-ed25519 ..., etc.)
* @return int|null Created key ID or null on failure * @return int|null Created key ID or null on failure
*/ */
public function createUserSshKey(int $userId, string $publicKey): ?int public function createUserSshKey(int $userId, string $publicKey): ?int
{ {
if (!$this->cp) return null; try {
if (! $this->cp) {
return null;
}
$request = $this->initCurl($this->cp['token']); $request = $this->initCurl($this->cp['token']);
$keyData = [ $keyData = [
'userId' => $userId, 'userId' => $userId,
'name' => 'WHMCS-' . date('Y-m-d'), 'name' => 'WHMCS-' . date('Y-m-d'),
'publicKey' => trim($publicKey), 'publicKey' => trim($publicKey),
]; ];
$request->addOption(CURLOPT_POSTFIELDS, json_encode($keyData)); $request->addOption(CURLOPT_POSTFIELDS, json_encode($keyData));
$response = $request->post($this->cp['url'] . '/ssh_keys'); $response = $request->post($this->cp['url'] . '/ssh_keys');
Log::insert(__FUNCTION__, $request->getRequestInfo(), $response); Log::insert(__FUNCTION__, $request->getRequestInfo(), $response);
$httpCode = $request->getRequestInfo('http_code'); $httpCode = $request->getRequestInfo('http_code');
if ($httpCode == 200 || $httpCode == 201) { if ($httpCode == 200 || $httpCode == 201) {
$data = json_decode($response, true); $data = json_decode($response, true);
return $data['data']['id'] ?? null;
return $data['data']['id'] ?? null;
}
return null;
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
return null;
} }
return null;
} }
} }

View File

@@ -2,11 +2,22 @@
namespace WHMCS\Module\Server\VirtFusionDirect; namespace WHMCS\Module\Server\VirtFusionDirect;
/**
* HTTP client wrapper with Bearer token auth, SSL verification, and a 30s timeout.
* Single-use — each instance makes one request.
*/
class Curl class Curl
{ {
/** @var resource|\CurlHandle cURL handle */
private $ch; private $ch;
/** @var array Response info and parsed header data collected after exec */
private $data; private $data;
/** @var array User-supplied cURL options that override defaults */
private $customOptions = []; private $customOptions = [];
/** @var array Default cURL options applied to every request */
private $defaultOptions = [ private $defaultOptions = [
CURLOPT_SSL_VERIFYPEER => true, CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2, CURLOPT_SSL_VERIFYHOST => 2,
@@ -18,15 +29,17 @@ class Curl
CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_CONNECTTIMEOUT => 10,
]; ];
/** Initialise the cURL handle. */
public function __construct() public function __construct()
{ {
$this->ch = curl_init(); $this->ch = curl_init();
} }
/** /**
* @param $name * Set a custom cURL option, overriding the defaults.
* @param $value *
* @param int $name A CURLOPT_* constant
* @param mixed $value The option value
*/ */
public function addOption($name, $value) public function addOption($name, $value)
{ {
@@ -34,8 +47,10 @@ class Curl
} }
/** /**
* @param null $url * Execute a PUT request.
* @return bool|string|void *
* @param string|null $url Target URL, or null to use a previously set CURLOPT_URL
* @return bool|string Response body, or false on failure
*/ */
public function put($url = null) public function put($url = null)
{ {
@@ -43,8 +58,10 @@ class Curl
} }
/** /**
* @param null $url * Execute a PATCH request.
* @return bool|string|void *
* @param string|null $url Target URL, or null to use a previously set CURLOPT_URL
* @return bool|string Response body, or false on failure
*/ */
public function patch($url = null) public function patch($url = null)
{ {
@@ -52,14 +69,18 @@ class Curl
} }
/** /**
* @param $method * Set the HTTP method and URL, then execute the request.
* @param $url *
* @return bool|string|void * @param string $method HTTP method (GET, POST, PUT, PATCH, DELETE)
* @param string|null $url Target URL, or null to use a previously set CURLOPT_URL
* @return bool|string Response body, or false on failure
*
* @throws \RuntimeException If no URL is available
*/ */
private function send($method, $url) private function send($method, $url)
{ {
if ($url === null) { if ($url === null) {
if (!isset($this->customOptions[CURLOPT_URL]) || empty($this->customOptions[CURLOPT_URL])) { if (! isset($this->customOptions[CURLOPT_URL]) || empty($this->customOptions[CURLOPT_URL])) {
throw new \RuntimeException('Curl: empty URL provided'); throw new \RuntimeException('Curl: empty URL provided');
} }
} }
@@ -70,7 +91,9 @@ class Curl
} }
/** /**
* @return bool|string * Apply options, run the cURL handle, collect response info, and close the handle.
*
* @return bool|string Response body, or false on cURL error
*/ */
private function exec() private function exec()
{ {
@@ -94,6 +117,7 @@ class Curl
return $response; return $response;
} }
/** Merge custom and default cURL options and apply them to the handle. */
private function setOptions() private function setOptions()
{ {
if (isset($this->customOptions[CURLOPT_HEADER]) && $this->customOptions[CURLOPT_HEADER]) { if (isset($this->customOptions[CURLOPT_HEADER]) && $this->customOptions[CURLOPT_HEADER]) {
@@ -105,7 +129,9 @@ class Curl
} }
/** /**
* @param $data * Split a response containing headers into header and body parts and store them.
*
* @param string $data Raw response string (headers + body); replaced with body only
*/ */
private function processHeaders(&$data) private function processHeaders(&$data)
{ {
@@ -116,15 +142,17 @@ class Curl
$tmp = explode("\r\n", $this->data['info']['response_header']); $tmp = explode("\r\n", $this->data['info']['response_header']);
$this->data['data']['Message'] = $tmp[0]; $this->data['data']['Message'] = $tmp[0];
for ($i = 1, $size = count($tmp); $i < $size; ++$i) { for ($i = 1, $size = count($tmp); $i < $size; $i++) {
$string = explode(': ', $tmp[$i], 2); $string = explode(': ', $tmp[$i], 2);
$this->data['data'][$string[0]] = $string[1]; $this->data['data'][$string[0]] = $string[1];
} }
} }
/** /**
* @param null $url * Execute a GET request.
* @return bool|string|void *
* @param string|null $url Target URL, or null to use a previously set CURLOPT_URL
* @return bool|string Response body, or false on failure
*/ */
public function get($url = null) public function get($url = null)
{ {
@@ -132,8 +160,10 @@ class Curl
} }
/** /**
* @param null $url * Execute a DELETE request.
* @return bool|string|void *
* @param string|null $url Target URL, or null to use a previously set CURLOPT_URL
* @return bool|string Response body, or false on failure
*/ */
public function delete($url = null) public function delete($url = null)
{ {
@@ -141,8 +171,10 @@ class Curl
} }
/** /**
* @param null $url * Execute a POST request.
* @return bool|string|void *
* @param string|null $url Target URL, or null to use a previously set CURLOPT_URL
* @return bool|string Response body, or false on failure
*/ */
public function post($url = null) public function post($url = null)
{ {
@@ -150,8 +182,10 @@ class Curl
} }
/** /**
* @param false $param * Return curl_getinfo data for the completed request.
* @return mixed|null *
* @param string|false $param A specific info key to retrieve, or false for the full array
* @return mixed|null The requested info value, the full info array, or null if the key is absent
*/ */
public function getRequestInfo($param = false) public function getRequestInfo($param = false)
{ {
@@ -163,9 +197,11 @@ class Curl
} }
/** /**
* @param $what * Retrieve a single item from the internal data store by section and key.
* @param $name *
* @return mixed|null * @param string $what Top-level section key (e.g. 'info', 'data')
* @param string $name Item key within that section
* @return mixed|null The stored value, or null if not found
*/ */
private function getDataItem($what, $name) private function getDataItem($what, $name)
{ {
@@ -175,5 +211,4 @@ class Curl
return null; return null;
} }
} }
} }

View File

@@ -4,13 +4,28 @@ namespace WHMCS\Module\Server\VirtFusionDirect;
use WHMCS\Database\Capsule as DB; use WHMCS\Database\Capsule as DB;
/**
* Handles all database operations for the module's custom table (mod_virtfusion_direct)
* and queries against core WHMCS tables (tblhosting, tblclients, tblservers, etc.).
*/
class Database class Database
{ {
const SYSTEM_TABLE = 'mod_virtfusion_direct'; const SYSTEM_TABLE = 'mod_virtfusion_direct';
/** @var bool Tracks whether custom field existence has already been verified this request. */
private static $fieldsChecked = false;
/**
* Creates or migrates the module table schema and ensures custom fields exist.
*
* Creates mod_virtfusion_direct with service_id and server_id columns if absent,
* adds the server_object column if missing, then calls ensureCustomFields().
*
* @return void
*/
public static function schema() public static function schema()
{ {
if (!DB::schema()->hasTable(self::SYSTEM_TABLE)) { if (! DB::schema()->hasTable(self::SYSTEM_TABLE)) {
try { try {
DB::schema()->create(self::SYSTEM_TABLE, function ($table) { DB::schema()->create(self::SYSTEM_TABLE, function ($table) {
$table->unsignedBigInteger('service_id')->nullable()->default(null)->index(); $table->unsignedBigInteger('service_id')->nullable()->default(null)->index();
@@ -22,7 +37,7 @@ class Database
} }
} }
if (!DB::schema()->hasColumn(self::SYSTEM_TABLE, 'server_object')) { if (! DB::schema()->hasColumn(self::SYSTEM_TABLE, 'server_object')) {
try { try {
DB::schema()->table(self::SYSTEM_TABLE, function ($table) { DB::schema()->table(self::SYSTEM_TABLE, function ($table) {
$table->longText('server_object')->nullable()->default(null); $table->longText('server_object')->nullable()->default(null);
@@ -31,92 +46,283 @@ class Database
Log::insert(__FUNCTION__, [], $e->getMessage()); Log::insert(__FUNCTION__, [], $e->getMessage());
} }
} }
self::ensureCustomFields();
} }
/**
* Ensures the "Initial Operating System" and "Initial SSH Key" custom fields exist
* for every VirtFusionDirect product, creating them via upsert if absent.
*
* @return void
*/
public static function ensureCustomFields()
{
if (self::$fieldsChecked) {
return;
}
self::$fieldsChecked = true;
try {
$productIds = DB::table('tblproducts')
->where('servertype', 'VirtFusionDirect')
->pluck('id');
foreach ($productIds as $productId) {
foreach (['Initial Operating System', 'Initial SSH Key'] as $fieldName) {
DB::table('tblcustomfields')->updateOrInsert(
['type' => 'product', 'relid' => $productId, 'fieldname' => $fieldName],
[
'fieldtype' => 'text',
'description' => '',
'fieldoptions' => '',
'regexpr' => '',
'adminonly' => '',
'required' => '',
'showorder' => 'on',
'showinvoice' => '',
'sortorder' => 0,
'updated_at' => DB::raw('UTC_TIMESTAMP()'),
],
);
}
}
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
}
}
/**
* Fetches a VirtFusionDirect server record from tblservers.
*
* When $server is non-zero, returns the matching server by ID.
* When $any is true and $server is 0, returns the first enabled server.
*
* @param int $server WHMCS server ID to look up (0 to skip ID filter).
* @param bool $any If true, fall back to the first active server.
* @return object|false Row object on success, false on failure or not found.
*/
public static function getWhmcsServer(int $server, $any = false) public static function getWhmcsServer(int $server, $any = false)
{ {
if ($server) { try {
return DB::table('tblservers')->where('type', 'VirtFusionDirect')->where('id', $server)->first(); if ($server) {
} return DB::table('tblservers')->where('type', 'VirtFusionDirect')->where('id', $server)->first();
}
if ($any) { if ($any) {
return DB::table('tblservers')->where('type', 'VirtFusionDirect')->where('disabled', 0)->first(); return DB::table('tblservers')->where('type', 'VirtFusionDirect')->where('disabled', 0)->first();
}
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
} }
return false; return false;
} }
/**
* Checks whether a WHMCS service belongs to the given client.
*
* @param int $serviceId WHMCS hosting service ID.
* @param int $userId WHMCS client ID.
* @return bool True if the service is owned by the client, false otherwise.
*/
public static function userWhmcsService(int $serviceId, int $userId) public static function userWhmcsService(int $serviceId, int $userId)
{ {
return DB::table('tblhosting')->where('id', $serviceId)->where('userid', $userId)->exists(); try {
return DB::table('tblhosting')->where('id', $serviceId)->where('userid', $userId)->exists();
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
return false;
}
} }
/**
* Returns the WHMCS system URL from tblconfiguration.
*
* @return string The system URL, or an empty string if not found or on error.
*/
public static function getSystemUrl() public static function getSystemUrl()
{ {
$url = DB::table('tblconfiguration')->where('setting', '=', 'SystemURL')->first(); try {
if (!$url) return ''; $url = DB::table('tblconfiguration')->where('setting', '=', 'SystemURL')->first();
return $url->value; if (! $url) {
return '';
}
return $url->value;
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
return '';
}
} }
/**
* Fetches a WHMCS client record by ID.
*
* @param int $id WHMCS client ID.
* @return object|null Row object on success, null on failure or not found.
*/
public static function getUser(int $id) public static function getUser(int $id)
{ {
return DB::table('tblclients')->where('id', $id)->first(); try {
return DB::table('tblclients')->where('id', $id)->first();
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
return null;
}
} }
/**
* Fetches a WHMCS hosting service record by ID.
*
* @param int $serviceId WHMCS hosting service ID.
* @return object|null Row object on success, null on failure or not found.
*/
public static function getWhmcsService(int $serviceId) public static function getWhmcsService(int $serviceId)
{ {
return DB::table('tblhosting')->where('id', $serviceId)->first(); try {
return DB::table('tblhosting')->where('id', $serviceId)->first();
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
return null;
}
} }
/**
* Upserts the VirtFusion server ID for a given WHMCS service in the module table.
*
* @param int $serviceId WHMCS hosting service ID.
* @param int $serverId VirtFusion server ID.
* @return void
*/
public static function updateSystemServiceServerId(int $serviceId, int $serverId) public static function updateSystemServiceServerId(int $serviceId, int $serverId)
{ {
try {
DB::table(self::SYSTEM_TABLE)->updateOrInsert( DB::table(self::SYSTEM_TABLE)->updateOrInsert(
[ [
"service_id" => $serviceId 'service_id' => $serviceId,
], ],
[ [
'server_id' => $serverId 'server_id' => $serverId,
] ],
); );
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
}
} }
/**
* Updates one or more WHMCS tables with the provided data for a given service ID.
*
* $data is keyed by table name; each value is an associative array of column => value
* pairs passed to an update() WHERE id = $serviceId.
*
* @param int $serviceId WHMCS hosting service ID.
* @param array $data Map of table name to column-value pairs to update.
* @return void
*/
public static function updateWhmcsServiceParams(int $serviceId, $data) public static function updateWhmcsServiceParams(int $serviceId, $data)
{ {
if (count($data)) { try {
foreach ($data as $key => $items) { if (count($data)) {
DB::table($key)->where('id', $serviceId)->update($items); foreach ($data as $key => $items) {
DB::table($key)->where('id', $serviceId)->update($items);
}
} }
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
} }
} }
/**
* Checks whether a module table record exists for the given service.
*
* @param int $serviceId WHMCS hosting service ID.
* @return bool True if a record exists, false otherwise.
*/
public static function checkSystemService(int $serviceId) public static function checkSystemService(int $serviceId)
{ {
return DB::table(self::SYSTEM_TABLE)->where('service_id', $serviceId)->exists(); try {
} return DB::table(self::SYSTEM_TABLE)->where('service_id', $serviceId)->exists();
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
public static function deleteSystemService(int $serviceId) return false;
{
DB::table(self::SYSTEM_TABLE)->where('service_id', $serviceId)->delete();
}
public static function updateSystemServiceServerObject(int $serviceId, $data)
{
DB::table(self::SYSTEM_TABLE)->where('service_id', $serviceId)->update(['server_object' => json_encode($data, JSON_PRETTY_PRINT)]);
}
public static function systemOnServerCreate(int $serviceId, $data)
{
if (DB::table(self::SYSTEM_TABLE)->where('service_id', $serviceId)->exists()) {
DB::table(self::SYSTEM_TABLE)->where('service_id', $serviceId)->update(['server_id' => $data->data->id, 'server_object' => json_encode($data, JSON_PRETTY_PRINT)]);
} else {
DB::table(self::SYSTEM_TABLE)->insert(['service_id' => $serviceId, 'server_id' => $data->data->id, 'server_object' => json_encode($data, JSON_PRETTY_PRINT)]);
} }
} }
public static function getSystemService(int $serviceId) /**
* Deletes the module table record for the given service.
*
* @param int $serviceId WHMCS hosting service ID.
* @return void
*/
public static function deleteSystemService(int $serviceId)
{ {
return DB::table(self::SYSTEM_TABLE)->where('service_id', $serviceId)->first(); try {
DB::table(self::SYSTEM_TABLE)->where('service_id', $serviceId)->delete();
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
}
} }
/**
* Persists the raw VirtFusion server API response as JSON in the module table.
*
* @param int $serviceId WHMCS hosting service ID.
* @param mixed $data Server object from the VirtFusion API (will be JSON-encoded).
* @return void
*/
public static function updateSystemServiceServerObject(int $serviceId, $data)
{
try {
DB::table(self::SYSTEM_TABLE)->where('service_id', $serviceId)->update(['server_object' => json_encode($data, JSON_PRETTY_PRINT)]);
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
}
}
/**
* Inserts or updates the module table record immediately after a VirtFusion server is created.
*
* Stores both the VirtFusion server ID (from $data->data->id) and the full server
* object JSON. Uses update if a record already exists, otherwise inserts.
*
* @param int $serviceId WHMCS hosting service ID.
* @param mixed $data Full API response object from the VirtFusion server creation call.
* @return void
*/
public static function systemOnServerCreate(int $serviceId, $data)
{
try {
if (DB::table(self::SYSTEM_TABLE)->where('service_id', $serviceId)->exists()) {
DB::table(self::SYSTEM_TABLE)->where('service_id', $serviceId)->update(['server_id' => $data->data->id, 'server_object' => json_encode($data, JSON_PRETTY_PRINT)]);
} else {
DB::table(self::SYSTEM_TABLE)->insert(['service_id' => $serviceId, 'server_id' => $data->data->id, 'server_object' => json_encode($data, JSON_PRETTY_PRINT)]);
}
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
}
}
/**
* Fetches the module table record for the given service.
*
* @param int $serviceId WHMCS hosting service ID.
* @return object|null Row object on success, null on failure or not found.
*/
public static function getSystemService(int $serviceId)
{
try {
return DB::table(self::SYSTEM_TABLE)->where('service_id', $serviceId)->first();
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
return null;
}
}
} }

View File

@@ -2,22 +2,22 @@
namespace WHMCS\Module\Server\VirtFusionDirect; namespace WHMCS\Module\Server\VirtFusionDirect;
/**
* Thin wrapper around the WHMCS logModuleCall() function for module-level logging.
*/
class Log class Log
{ {
const LOG_MODULE = 'VirtFusionDirect'; const LOG_MODULE = 'VirtFusionDirect';
/**
* Write an entry to the WHMCS module log.
*
* @param string $action Name of the action being logged (e.g. 'CreateAccount')
* @param string|array $requestString Request data sent to the API
* @param string|array $responseData Response data received from the API
*/
public static function insert($action, $requestString, $responseData) public static function insert($action, $requestString, $responseData)
{ {
/**
* Log module call.
*
* @param string $module The name of the module
* @param string $action The name of the action being performed
* @param string|array $requestString The input parameters for the API call
* @param string|array $responseData The response data from the API call
* @param string|array $processedData The resulting data after any post processing (eg. json decode, xml decode, etc...)
* @param array $replaceVars An array of strings for replacement
*/
logModuleCall(self::LOG_MODULE, $action, $requestString, $responseData); logModuleCall(self::LOG_MODULE, $action, $requestString, $responseData);
} }
} }

File diff suppressed because it is too large Load Diff

View File

@@ -2,6 +2,12 @@
namespace WHMCS\Module\Server\VirtFusionDirect; namespace WHMCS\Module\Server\VirtFusionDirect;
/**
* Extends Module to handle the WHMCS service lifecycle for VirtFusion servers.
*
* Responsibilities include: provisioning (create, suspend, unsuspend, terminate),
* package changes, usage updates, client area rendering, and admin tab fields.
*/
class ModuleFunctions extends Module class ModuleFunctions extends Module
{ {
public function __construct() public function __construct()
@@ -10,13 +16,13 @@ class ModuleFunctions extends Module
} }
/** /**
* Provision a new VirtFusion server for a WHMCS service.
* *
* CREATE SERVER * Ensures a matching VirtFusion user exists (creating one if needed), then creates
* * the server and triggers the OS build via ConfigureService::initServerBuild().
* Before creating a server, we check to see if a user exists in VirtFusion that matches
* the WHMCS user. If it matches, We move on to create the server, if not, we attempt to
* create a user to assign to the new server.
* *
* @param array $params WHMCS service parameters
* @return string 'success' or an error message
*/ */
public function createAccount($params) public function createAccount($params)
{ {
@@ -33,9 +39,9 @@ class ModuleFunctions extends Module
* If no VirtFusionDirect control server exists, cancel the create account action. * If no VirtFusionDirect control server exists, cancel the create account action.
*/ */
$server = $params['serverid'] ?: false; $server = $params['serverid'] ?: false;
$cp = $this->getCP($server, !$server); $cp = $this->getCP($server, ! $server);
if (!$cp) { if (! $cp) {
return 'No Control server found. Please ensure a VirtFusion server is configured in WHMCS.'; return 'No Control server found. Please ensure a VirtFusion server is configured in WHMCS.';
} }
@@ -62,16 +68,16 @@ class ModuleFunctions extends Module
*/ */
$user = Database::getUser($params['userid']); $user = Database::getUser($params['userid']);
if (!$user) { if (! $user) {
return 'WHMCS user not found for ID ' . (int) $params['userid']; return 'WHMCS user not found for ID ' . (int) $params['userid'];
} }
$request = $this->initCurl($cp['token']); $request = $this->initCurl($cp['token']);
$userData = [ $userData = [
"name" => $user->firstname . ' ' . $user->lastname, 'name' => $user->firstname . ' ' . $user->lastname,
"email" => $user->email, 'email' => $user->email,
"extRelationId" => $user->id, 'extRelationId' => $user->id,
]; ];
// Enable self-service billing if configured // Enable self-service billing if configured
@@ -100,7 +106,6 @@ class ModuleFunctions extends Module
/** /**
* A user is available. We can now attempt to create a server. * A user is available. We can now attempt to create a server.
*/ */
$configOptionDefaultNaming = [ $configOptionDefaultNaming = [
'ipv4' => 'IPv4', 'ipv4' => 'IPv4',
'packageId' => 'Package', 'packageId' => 'Package',
@@ -122,10 +127,10 @@ class ModuleFunctions extends Module
} }
$options = [ $options = [
"packageId" => (int) $params['configoption2'], 'packageId' => (int) $params['configoption2'],
"userId" => $data->data->id, 'userId' => $data->data->id,
"hypervisorId" => (int) $params['configoption1'], 'hypervisorId' => (int) $params['configoption1'],
"ipv4" => (int) $params['configoption3'], 'ipv4' => (int) $params['configoption3'],
]; ];
if (array_key_exists('configoptions', $params)) { if (array_key_exists('configoptions', $params)) {
@@ -159,7 +164,7 @@ class ModuleFunctions extends Module
$this->updateWhmcsServiceParamsOnServerObject($params['serviceid'], $data); $this->updateWhmcsServiceParamsOnServerObject($params['serviceid'], $data);
// If the server is created successfully, we can initialize the server build. // If the server is created successfully, we can initialize the server build.
$cs = new ConfigureService(); $cs = new ConfigureService;
$vfUserId = isset($data->data->owner->id) ? (int) $data->data->owner->id : null; $vfUserId = isset($data->data->owner->id) ? (int) $data->data->owner->id : null;
$cs->initServerBuild($data->data->id, $params, $vfUserId); $cs->initServerBuild($data->data->id, $params, $vfUserId);
@@ -171,328 +176,440 @@ class ModuleFunctions extends Module
if (isset($data->msg)) { if (isset($data->msg)) {
return $data->msg; return $data->msg;
} }
return 'Server creation failed. VirtFusion API returned HTTP ' . $request->getRequestInfo('http_code'); return 'Server creation failed. VirtFusion API returned HTTP ' . $request->getRequestInfo('http_code');
} }
} catch (\Exception $e) { } catch (\Exception $e) {
Log::insert(__FUNCTION__, $params, $e->getMessage()); Log::insert(__FUNCTION__, $params, $e->getMessage());
return $e->getMessage(); return $e->getMessage();
} }
} }
/** /**
* Allows changing of the package of a server * Change the VirtFusion package assigned to a server and apply resource modifications.
* *
* @param $params * Updates the package via the API, then individually adjusts memory, CPU, and bandwidth
* @return string * if those configurable options are present.
*
* @param array $params WHMCS service parameters
* @return string 'success' or an error message
*/ */
public function changePackage($params) public function changePackage($params)
{ {
$service = Database::getSystemService($params['serviceid']); try {
$service = Database::getSystemService($params['serviceid']);
if ($service) { if ($service) {
$whmcsService = Database::getWhmcsService($params['serviceid']); $whmcsService = Database::getWhmcsService($params['serviceid']);
if (!$whmcsService) return 'WHMCS service record not found.'; if (! $whmcsService) {
return 'WHMCS service record not found.';
$cp = $this->getCP($whmcsService->server);
if (!$cp) return 'No control server found.';
$request = $this->initCurl($cp['token']);
$data = $request->put($cp['url'] . '/servers/' . (int) $service->server_id . '/package/' . (int) $params['configoption2']);
$data = json_decode($data);
Log::insert(__FUNCTION__, $request->getRequestInfo(), $data);
switch ($request->getRequestInfo('http_code')) {
case 204:
break;
case 404:
return 'The server or package was not found in VirtFusion (HTTP 404).';
case 423:
if (isset($data->msg)) {
return $data->msg;
}
return 'The server is currently locked. Please try again later.';
default:
return 'Update package request failed. VirtFusion API returned HTTP ' . $request->getRequestInfo('http_code');
}
// Apply individual resource modifications from configurable options
if (isset($params['configoptions']) && is_array($params['configoptions'])) {
$configOptionDefaultNaming = [
'memory' => 'Memory',
'cpuCores' => 'CPU Cores',
'traffic' => 'Bandwidth',
];
$configOptionCustomNaming = [];
if (file_exists(ROOTDIR . '/modules/servers/VirtFusionDirect/config/ConfigOptionMapping.php')) {
$configOptionCustomNaming = require ROOTDIR . '/modules/servers/VirtFusionDirect/config/ConfigOptionMapping.php';
} }
foreach ($configOptionDefaultNaming as $resource => $optionName) { $cp = $this->getCP($whmcsService->server);
$currentOption = array_key_exists($resource, $configOptionCustomNaming) ? $configOptionCustomNaming[$resource] : $optionName; if (! $cp) {
if (isset($params['configoptions'][$currentOption]) && is_numeric($params['configoptions'][$currentOption])) { return 'No control server found.';
$value = (int) $params['configoptions'][$currentOption]; }
if ($resource === 'memory' && $value < 1024) {
$value = $value * 1024; $request = $this->initCurl($cp['token']);
$data = $request->put($cp['url'] . '/servers/' . (int) $service->server_id . '/package/' . (int) $params['configoption2']);
$data = json_decode($data);
Log::insert(__FUNCTION__, $request->getRequestInfo(), $data);
switch ($request->getRequestInfo('http_code')) {
case 204:
break;
case 404:
return 'The server or package was not found in VirtFusion (HTTP 404).';
case 423:
if (isset($data->msg)) {
return $data->msg;
}
return 'The server is currently locked. Please try again later.';
default:
return 'Update package request failed. VirtFusion API returned HTTP ' . $request->getRequestInfo('http_code');
}
// Apply individual resource modifications from configurable options
if (isset($params['configoptions']) && is_array($params['configoptions'])) {
$configOptionDefaultNaming = [
'memory' => 'Memory',
'cpuCores' => 'CPU Cores',
'traffic' => 'Bandwidth',
];
$configOptionCustomNaming = [];
if (file_exists(ROOTDIR . '/modules/servers/VirtFusionDirect/config/ConfigOptionMapping.php')) {
$configOptionCustomNaming = require ROOTDIR . '/modules/servers/VirtFusionDirect/config/ConfigOptionMapping.php';
}
foreach ($configOptionDefaultNaming as $resource => $optionName) {
$currentOption = array_key_exists($resource, $configOptionCustomNaming) ? $configOptionCustomNaming[$resource] : $optionName;
if (isset($params['configoptions'][$currentOption]) && is_numeric($params['configoptions'][$currentOption])) {
$value = (int) $params['configoptions'][$currentOption];
if ($resource === 'memory' && $value < 1024) {
$value = $value * 1024;
}
$this->modifyResource($params['serviceid'], $resource, $value);
} }
$this->modifyResource($params['serviceid'], $resource, $value);
} }
} }
return 'success';
} }
return 'success'; return 'Service not found in module database.';
} catch (\Exception $e) {
Log::insert(__FUNCTION__, $params, $e->getMessage());
return $e->getMessage();
} }
return 'Service not found in module database.';
} }
/** /**
* Delete a VirtFusion server, applying the default 5-minute grace period before destruction.
* *
* TERMINATE SERVER * On success, removes the service record from the module database and clears WHMCS service fields.
* * If VirtFusion reports the server is already gone (404 + "server not found"), treats it as success.
* When requesting to terminate a server in VirtFusion, we leave it set to
* the default 5-minute delay allowing to un-terminate in VirtFusion if the
* request was done in error.
* *
* @param array $params WHMCS service parameters
* @return string 'success' or an error message
*/ */
public function terminateAccount($params) public function terminateAccount($params)
{ {
$service = Database::getSystemService($params['serviceid']); try {
$service = Database::getSystemService($params['serviceid']);
if ($service) { if ($service) {
$whmcsService = Database::getWhmcsService($params['serviceid']); $whmcsService = Database::getWhmcsService($params['serviceid']);
if (!$whmcsService) return 'WHMCS service record not found.'; if (! $whmcsService) {
return 'WHMCS service record not found.';
}
$cp = $this->getCP($whmcsService->server); $cp = $this->getCP($whmcsService->server);
if (!$cp) return 'No control server found.'; if (! $cp) {
return 'No control server found.';
}
$request = $this->initCurl($cp['token']); $request = $this->initCurl($cp['token']);
$data = $request->delete($cp['url'] . '/servers/' . (int) $service->server_id); $data = $request->delete($cp['url'] . '/servers/' . (int) $service->server_id);
$data = json_decode($data); $data = json_decode($data);
Log::insert(__FUNCTION__, $request->getRequestInfo(), $data); Log::insert(__FUNCTION__, $request->getRequestInfo(), $data);
switch ($request->getRequestInfo('http_code')) { switch ($request->getRequestInfo('http_code')) {
case 204: case 204:
Database::deleteSystemService($params['serviceid']); Database::deleteSystemService($params['serviceid']);
$this->updateWhmcsServiceParamsOnDestroy($params['serviceid']); $this->updateWhmcsServiceParamsOnDestroy($params['serviceid']);
return 'success';
case 404: return 'success';
if (isset($data->msg)) {
if ($data->msg == 'server not found') { case 404:
Database::deleteSystemService($params['serviceid']); if (isset($data->msg)) {
return 'success'; if ($data->msg == 'server not found') {
Database::deleteSystemService($params['serviceid']);
return 'success';
} else {
return 'VirtFusion returned 404: ' . $data->msg;
}
} else { } else {
return 'VirtFusion returned 404: ' . $data->msg; return 'VirtFusion returned 404 without details. The API may be unavailable.';
} }
} else {
return 'VirtFusion returned 404 without details. The API may be unavailable.';
}
default: default:
return 'Termination request failed. VirtFusion API returned HTTP ' . $request->getRequestInfo('http_code'); return 'Termination request failed. VirtFusion API returned HTTP ' . $request->getRequestInfo('http_code');
}
} }
return 'Service not found in module database. Has termination already been run?';
} catch (\Exception $e) {
Log::insert(__FUNCTION__, $params, $e->getMessage());
return $e->getMessage();
} }
return 'Service not found in module database. Has termination already been run?';
} }
/** /**
* Suspend a VirtFusion server, queuing the action if another operation is in progress.
* *
* SUSPEND SERVER * Returns 'success' whether the server is suspended immediately or queued for suspension.
*
* When requesting to suspend a server in VirtFusion it may be delayed if another action
* is being processed. This function will return success if the server is either suspended
* now or has been queued for suspension.
* *
* @param array $params WHMCS service parameters
* @return string 'success' or an error message
*/ */
public function suspendAccount($params) public function suspendAccount($params)
{ {
$service = Database::getSystemService($params['serviceid']); try {
$service = Database::getSystemService($params['serviceid']);
if ($service) { if ($service) {
$whmcsService = Database::getWhmcsService($params['serviceid']); $whmcsService = Database::getWhmcsService($params['serviceid']);
if (!$whmcsService) return 'WHMCS service record not found.'; if (! $whmcsService) {
return 'WHMCS service record not found.';
}
$cp = $this->getCP($whmcsService->server); $cp = $this->getCP($whmcsService->server);
if (!$cp) return 'No control server found.'; if (! $cp) {
return 'No control server found.';
}
$request = $this->initCurl($cp['token']); $request = $this->initCurl($cp['token']);
$data = $request->post($cp['url'] . '/servers/' . (int) $service->server_id . '/suspend'); $data = $request->post($cp['url'] . '/servers/' . (int) $service->server_id . '/suspend');
$data = json_decode($data); $data = json_decode($data);
Log::insert(__FUNCTION__, $request->getRequestInfo(), $data); Log::insert(__FUNCTION__, $request->getRequestInfo(), $data);
switch ($request->getRequestInfo('http_code')) { switch ($request->getRequestInfo('http_code')) {
case 204: case 204:
return 'success'; return 'success';
case 404: case 404:
if (isset($data->msg)) { if (isset($data->msg)) {
if ($data->msg == 'server not found') { if ($data->msg == 'server not found') {
Database::deleteSystemService($params['serviceid']); Database::deleteSystemService($params['serviceid']);
return 'success';
return 'success';
} else {
return 'VirtFusion returned 404: ' . $data->msg;
}
} else { } else {
return 'VirtFusion returned 404: ' . $data->msg; return 'VirtFusion returned 404 without details. The API may be unavailable.';
} }
} else { case 423:
return 'VirtFusion returned 404 without details. The API may be unavailable.'; if (isset($data->msg)) {
} return $data->msg;
case 423:
if (isset($data->msg)) {
return $data->msg;
}
return 'The server is currently locked. Please try again later.';
default:
return 'Suspend request failed. VirtFusion API returned HTTP ' . $request->getRequestInfo('http_code');
}
}
return 'Service not found in module database.';
}
function updateServerObject($params)
{
$service = Database::getSystemService($params['serviceid']);
if ($service) {
$whmcsService = Database::getWhmcsService($params['serviceid']);
if (!$whmcsService) return 'WHMCS service record not found.';
$cp = $this->getCP($whmcsService->server);
if (!$cp) return 'No control server found.';
$request = $this->initCurl($cp['token']);
$data = $request->get($cp['url'] . '/servers/' . (int) $service->server_id);
$data = json_decode($data);
Log::insert(__FUNCTION__, $request->getRequestInfo(), $data);
switch ($request->getRequestInfo('http_code')) {
case 200:
Database::updateSystemServiceServerObject($params['serviceid'], $data);
$this->updateWhmcsServiceParamsOnServerObject($params['serviceid'], $data);
return 'success';
default:
return 'Request failed. VirtFusion API returned HTTP ' . $request->getRequestInfo('http_code');
}
}
return 'Service not found in module database.';
}
public function unsuspendAccount($params)
{
$service = Database::getSystemService($params['serviceid']);
if ($service) {
$whmcsService = Database::getWhmcsService($params['serviceid']);
if (!$whmcsService) return 'WHMCS service record not found.';
$cp = $this->getCP($whmcsService->server);
if (!$cp) return 'No control server found.';
$request = $this->initCurl($cp['token']);
$data = $request->post($cp['url'] . '/servers/' . (int) $service->server_id . '/unsuspend');
$data = json_decode($data);
Log::insert(__FUNCTION__, $request->getRequestInfo(), $data);
switch ($request->getRequestInfo('http_code')) {
case 204:
return 'success';
case 404:
if (isset($data->msg)) {
if ($data->msg == 'server not found') {
Database::deleteSystemService($params['serviceid']);
return 'success';
} else {
return 'VirtFusion returned 404: ' . $data->msg;
} }
} else {
return 'VirtFusion returned 404 without details. The API may be unavailable.';
}
case 423:
if (isset($data->msg)) {
return $data->msg;
}
return 'The server is currently locked. Please try again later.';
default: return 'The server is currently locked. Please try again later.';
return 'Unsuspend request failed. VirtFusion API returned HTTP ' . $request->getRequestInfo('http_code');
default:
return 'Suspend request failed. VirtFusion API returned HTTP ' . $request->getRequestInfo('http_code');
}
} }
}
return 'Service not found in module database.';
}
public function adminServicesTabFields($params) return 'Service not found in module database.';
{ } catch (\Exception $e) {
$serverId = ''; Log::insert(__FUNCTION__, $params, $e->getMessage());
$serverObject = '';
$service = Database::getSystemService($params['serviceid']); return $e->getMessage();
$systemUrl = Database::getSystemUrl();
if ($service) {
$serverId = $service->server_id;
$serverObject = $service->server_object;
}
$fields = [
'Server ID' => AdminHTML::serverId($serverId),
'Server Info' => AdminHTML::serverInfo($systemUrl, $params['serviceid']),
'Server Object' => AdminHTML::serverObject($serverObject),
];
if ($params['status'] != 'Terminated') {
$fields['Options'] = AdminHTML::options($systemUrl, $params['serviceid']);
}
return $fields;
}
public function adminServicesTabFieldsSave($params)
{
if (!isset($_POST['modulefields'][0]) || $_POST['modulefields'][0] === '') {
Database::deleteSystemService($params['serviceid']);
} else {
$serverId = (int) $_POST['modulefields'][0];
if ($serverId > 0) {
Database::updateSystemServiceServerId($params['serviceid'], $serverId);
}
} }
} }
/** /**
* Validate server creation parameters via dry run. * Refresh the cached server object by fetching fresh data from the VirtFusion API.
* *
* @param array $params WHMCS service params * Updates both the module database record and the WHMCS service fields (IP, username, etc.).
* @return string 'success' or error message *
* @param array $params WHMCS service parameters
* @return string 'success' or an error message
*/
public function updateServerObject($params)
{
try {
$service = Database::getSystemService($params['serviceid']);
if ($service) {
$whmcsService = Database::getWhmcsService($params['serviceid']);
if (! $whmcsService) {
return 'WHMCS service record not found.';
}
$cp = $this->getCP($whmcsService->server);
if (! $cp) {
return 'No control server found.';
}
$request = $this->initCurl($cp['token']);
$data = $request->get($cp['url'] . '/servers/' . (int) $service->server_id);
$data = json_decode($data);
Log::insert(__FUNCTION__, $request->getRequestInfo(), $data);
switch ($request->getRequestInfo('http_code')) {
case 200:
Database::updateSystemServiceServerObject($params['serviceid'], $data);
$this->updateWhmcsServiceParamsOnServerObject($params['serviceid'], $data);
return 'success';
default:
return 'Request failed. VirtFusion API returned HTTP ' . $request->getRequestInfo('http_code');
}
}
return 'Service not found in module database.';
} catch (\Exception $e) {
Log::insert(__FUNCTION__, $params, $e->getMessage());
return $e->getMessage();
}
}
/**
* Unsuspend a VirtFusion server, queuing the action if another operation is in progress.
*
* Returns 'success' whether the server is unsuspended immediately or queued for unsuspension.
*
* @param array $params WHMCS service parameters
* @return string 'success' or an error message
*/
public function unsuspendAccount($params)
{
try {
$service = Database::getSystemService($params['serviceid']);
if ($service) {
$whmcsService = Database::getWhmcsService($params['serviceid']);
if (! $whmcsService) {
return 'WHMCS service record not found.';
}
$cp = $this->getCP($whmcsService->server);
if (! $cp) {
return 'No control server found.';
}
$request = $this->initCurl($cp['token']);
$data = $request->post($cp['url'] . '/servers/' . (int) $service->server_id . '/unsuspend');
$data = json_decode($data);
Log::insert(__FUNCTION__, $request->getRequestInfo(), $data);
switch ($request->getRequestInfo('http_code')) {
case 204:
return 'success';
case 404:
if (isset($data->msg)) {
if ($data->msg == 'server not found') {
Database::deleteSystemService($params['serviceid']);
return 'success';
} else {
return 'VirtFusion returned 404: ' . $data->msg;
}
} else {
return 'VirtFusion returned 404 without details. The API may be unavailable.';
}
case 423:
if (isset($data->msg)) {
return $data->msg;
}
return 'The server is currently locked. Please try again later.';
default:
return 'Unsuspend request failed. VirtFusion API returned HTTP ' . $request->getRequestInfo('http_code');
}
}
return 'Service not found in module database.';
} catch (\Exception $e) {
Log::insert(__FUNCTION__, $params, $e->getMessage());
return $e->getMessage();
}
}
/**
* Generate the admin Services tab custom fields for a VirtFusion service.
*
* Returns fields for Server ID (editable), Server Info, Server Object (JSON viewer),
* and Options (action buttons), omitting Options for terminated services.
*
* @param array $params WHMCS service parameters
* @return array Associative array of field label => HTML content
*/
public function adminServicesTabFields($params)
{
try {
$serverId = '';
$serverObject = '';
$service = Database::getSystemService($params['serviceid']);
$systemUrl = Database::getSystemUrl();
if ($service) {
$serverId = $service->server_id;
$serverObject = $service->server_object;
}
$fields = [
'Server ID' => AdminHTML::serverId($serverId),
'Server Info' => AdminHTML::serverInfo($systemUrl, $params['serviceid']),
'Server Object' => AdminHTML::serverObject($serverObject),
];
if ($params['status'] != 'Terminated') {
$fields['Options'] = AdminHTML::options($systemUrl, $params['serviceid']);
}
return $fields;
} catch (\Exception $e) {
Log::insert(__FUNCTION__, $params, $e->getMessage());
return [];
}
}
/**
* Save the admin Services tab custom fields for a VirtFusion service.
*
* Deletes the module database record if the Server ID field is cleared,
* or updates it with the new integer server ID if a value is provided.
*
* @param array $params WHMCS service parameters
* @return void
*/
public function adminServicesTabFieldsSave($params)
{
try {
if (! isset($_POST['modulefields'][0]) || $_POST['modulefields'][0] === '') {
Database::deleteSystemService($params['serviceid']);
} else {
$serverId = (int) $_POST['modulefields'][0];
if ($serverId > 0) {
Database::updateSystemServiceServerId($params['serviceid'], $serverId);
}
}
} catch (\Exception $e) {
Log::insert(__FUNCTION__, $params, $e->getMessage());
}
}
/**
* Perform a dry-run server creation to validate the current product configuration.
*
* Used by the WHMCS "Test Connection" button to confirm that the package, hypervisor,
* and IP settings are accepted by the VirtFusion API without creating a server.
*
* @param array $params WHMCS service parameters
* @return string 'success' or an error message
*/ */
public function validateServerConfig($params) public function validateServerConfig($params)
{ {
try { try {
$server = $params['serverid'] ?: false; $server = $params['serverid'] ?: false;
$cp = $this->getCP($server, !$server); $cp = $this->getCP($server, ! $server);
if (!$cp) { if (! $cp) {
return 'No Control server found.'; return 'No Control server found.';
} }
$options = [ $options = [
"packageId" => (int) $params['configoption2'], 'packageId' => (int) $params['configoption2'],
"hypervisorId" => (int) $params['configoption1'], 'hypervisorId' => (int) $params['configoption1'],
"ipv4" => (int) $params['configoption3'], 'ipv4' => (int) $params['configoption3'],
]; ];
// We need a userId for dry run - use the service owner // We need a userId for dry run - use the service owner
@@ -517,6 +634,16 @@ class ModuleFunctions extends Module
} }
} }
/**
* Render the client area overview tab for a VirtFusion service.
*
* Returns the template name and variables (system URL, service status, hostname,
* self-service mode) needed by the Smarty overview template. Falls back to an
* error template on any exception.
*
* @param array $params WHMCS service parameters
* @return array Template name and variables for WHMCS to render
*/
public function clientArea($params) public function clientArea($params)
{ {
$serverHostname = null; $serverHostname = null;

View File

@@ -2,8 +2,17 @@
namespace WHMCS\Module\Server\VirtFusionDirect; namespace WHMCS\Module\Server\VirtFusionDirect;
/**
* Transforms a VirtFusion API server response into a flat key-value array for Smarty templates and admin display.
*/
class ServerResource class ServerResource
{ {
/**
* Normalise a VirtFusion API server response into a flat associative array.
*
* @param object $data VirtFusion API server response object (with a `data` property)
* @return array Flat associative array containing server name, hostname, resources, network info, and usage
*/
public function process($data) public function process($data)
{ {
$server = json_decode(json_encode($data->data), true); $server = json_decode(json_encode($data->data), true);

View File

@@ -1,49 +0,0 @@
-- Insert records for Initial Operating System if they don't already exist
INSERT INTO tblcustomfields
(type, relid, fieldname, fieldtype, description, fieldoptions, regexpr, adminonly, required, showorder, showinvoice,
sortorder, created_at, updated_at)
SELECT 'product',
id,
'Initial Operating System',
'text',
'',
'',
'',
'',
'',
'on',
'',
0,
UTC_TIMESTAMP(),
UTC_TIMESTAMP()
FROM tblproducts
WHERE servertype = 'VirtFusionDirect'
AND NOT EXISTS (SELECT 1
FROM tblcustomfields
WHERE fieldname = 'Initial Operating System'
AND relid = tblproducts.id);
-- Insert records for Initial SSH Key if they don't already exist
INSERT INTO tblcustomfields
(type, relid, fieldname, fieldtype, description, fieldoptions, regexpr, adminonly, required, showorder, showinvoice,
sortorder, created_at, updated_at)
SELECT 'product',
id,
'Initial SSH Key',
'text',
'',
'',
'',
'',
'',
'on',
'',
0,
UTC_TIMESTAMP(),
UTC_TIMESTAMP()
FROM tblproducts
WHERE servertype = 'VirtFusionDirect'
AND NOT EXISTS (SELECT 1
FROM tblcustomfields
WHERE fieldname = 'Initial SSH Key'
AND relid = tblproducts.id);

24
pint.json Normal file
View File

@@ -0,0 +1,24 @@
{
"preset": "laravel",
"rules": {
"declare_strict_types": false,
"blank_line_before_statement": {
"statements": ["return", "throw", "try"]
},
"concat_space": {
"spacing": "one"
},
"ordered_imports": {
"sort_algorithm": "alpha"
},
"single_quote": true,
"no_unused_imports": true,
"trailing_comma_in_multiline": {
"elements": ["arrays", "arguments"]
}
},
"exclude": [
"vendor",
"templates"
]
}