+ Loading reverse DNS…
+
+
+
+
+
+
+
+
EOT;
}
}
diff --git a/modules/servers/VirtFusionDirect/lib/Module.php b/modules/servers/VirtFusionDirect/lib/Module.php
index 2a73fb7..84241d0 100644
--- a/modules/servers/VirtFusionDirect/lib/Module.php
+++ b/modules/servers/VirtFusionDirect/lib/Module.php
@@ -10,8 +10,49 @@ use WHMCS\Database\Capsule;
* server feature methods (power, network, VNC, backup, resource modification,
* self-service billing, traffic, rename, password reset).
*
- * Extended by ModuleFunctions (service lifecycle) and ConfigureService (order-time
- * operations). Most business logic lives here; subclasses delegate to these methods.
+ * INHERITANCE SHAPE
+ * -----------------
+ * Extended by:
+ * - ModuleFunctions — service lifecycle (create, suspend, unsuspend, terminate, change package)
+ * - ConfigureService — order-time operations (package/template discovery, server build init)
+ *
+ * Most business logic lives HERE, not in the subclasses. Subclasses are intentionally
+ * thin — they orchestrate sequences of calls to methods defined on this base, which
+ * lets us unit-exercise any single feature (e.g. "what happens during rename when
+ * the VirtFusion API returns 423?") without standing up a full WHMCS lifecycle.
+ *
+ * THE resolveServiceContext() PATTERN
+ * -----------------------------------
+ * Almost every method follows the same preamble: look up the module table row,
+ * look up the WHMCS tblhosting row, resolve the control panel credentials, build
+ * a Curl client with the bearer token. That preamble is consolidated into
+ * resolveServiceContext() which returns everything as an array or false on any
+ * missing piece. Every feature method starts with "$ctx = $this->resolveServiceContext($id);
+ * if (! $ctx) return false;" and can then use $ctx['request'], $ctx['serverId'], etc.
+ *
+ * This pattern is the most important abstraction in the module — violating it
+ * (e.g. reading tblservers directly in a feature method) leads to drift where
+ * some features handle missing servers gracefully and others don't.
+ *
+ * ENDPOINT OUTPUT CONVENTION
+ * --------------------------
+ * client.php and admin.php call $this->output() to emit JSON responses. Every
+ * output() call in a switch case MUST be followed by a `break` — the module
+ * deliberately does NOT rely on exit() inside output() for flow control because
+ * that couples the HTTP response format to the control-flow mechanism and makes
+ * refactoring fragile.
+ *
+ * SECURITY HELPERS
+ * ----------------
+ * Five guards callers compose in front of sensitive actions:
+ * - isAuthenticated() — client session required
+ * - adminOnly() — admin session required
+ * - requirePost() — HTTP method gate (mutations only)
+ * - requireSameOrigin() — CSRF origin check
+ * - requireServiceStatus() — filter by tblhosting.domainstatus
+ *
+ * Each exits on failure with the appropriate HTTP status — callers treat them
+ * as "throw on failure" style assertions rather than having to check return values.
*/
class Module
{
@@ -73,10 +114,23 @@ class Module
/**
* Resolve service context: system service, WHMCS service, control panel, and curl client.
- * Returns false if any lookup fails.
+ *
+ * This is the most-called method in the module. Every feature action begins
+ * by calling it, so think of the return value as "everything you need to
+ * touch VirtFusion for this service":
+ *
+ * service — row from mod_virtfusion_direct (has server_id, server_object)
+ * whmcsService — row from tblhosting (has server, userid, domain, etc.)
+ * cp — ['url', 'base_url', 'token'] for the VirtFusion API
+ * request — a fresh Curl instance pre-configured with the bearer token
+ * serverId — (int) of service.server_id — used in every URL downstream
+ *
+ * Returning false on ANY missing piece lets callers write a single
+ * "if (! $ctx) return false;" check at the top of each feature method
+ * rather than threading nullability through three separate lookups.
*
* @param int $serviceID
- * @return array{service: object, whmcsService: object, cp: array, request: Curl}|false
+ * @return array{service: object, whmcsService: object, cp: array, request: Curl, serverId: int}|false
*/
protected function resolveServiceContext($serviceID)
{
@@ -328,13 +382,37 @@ class Module
return false;
}
+ // Capture old hostname + server object from stored state so we can sync rDNS
+ // after the rename. We read from the cached server_object rather than a fresh
+ // fetch; this is the hostname the PTR would be set to (if module-managed).
+ $oldHostname = null;
+ $serverObject = null;
+ if (! empty($ctx['service']->server_object)) {
+ $serverObject = json_decode($ctx['service']->server_object, true);
+ if (is_array($serverObject)) {
+ $oldHostname = PowerDns\PtrManager::extractHostname($serverObject);
+ }
+ }
+
$ctx['request']->addOption(CURLOPT_POSTFIELDS, json_encode(['name' => $newName]));
$data = $ctx['request']->patch($ctx['cp']['url'] . '/servers/' . $ctx['serverId'] . '/name');
Log::insert(__FUNCTION__, $ctx['request']->getRequestInfo(), $data);
$httpCode = $ctx['request']->getRequestInfo('http_code');
+ $success = $httpCode == 200 || $httpCode == 204;
- return $httpCode == 200 || $httpCode == 204;
+ if ($success && $serverObject !== null && PowerDns\Config::isEnabled()) {
+ // Sync PTRs: only records whose current content equals the old hostname
+ // will be rewritten; client-customized PTRs are preserved automatically.
+ // Non-blocking: rDNS failures log but never fail the rename.
+ try {
+ (new PowerDns\PtrManager)->syncServer($serverObject, $oldHostname, $newName);
+ } catch (\Throwable $e) {
+ Log::insert('PowerDns:renameServer', ['serviceID' => $serviceID], $e->getMessage());
+ }
+ }
+
+ return $success;
} catch (\Exception $e) {
Log::insert(__FUNCTION__, [], $e->getMessage());
@@ -773,6 +851,26 @@ class Module
/**
* Resolve a WHMCS server record into an API base URL and decrypted Bearer token.
*
+ * OUTPUT SHAPE
+ * ------------
+ * url — full API base like "https://vf.example.com/api/v1". Append
+ * path components to this for every VirtFusion call.
+ * base_url — scheme + host only, "https://vf.example.com". Used for SSO
+ * redirects where we need to hit the panel UI, not the API.
+ * token — decrypted bearer token. Pass to initCurl() to get an
+ * authenticated Curl handle.
+ *
+ * $any=true is an unusual behaviour: when a WHMCS product doesn't have a
+ * specific server pinned (allowed if the module is the only VF module on
+ * the install), we fall back to any enabled VirtFusion server. This mostly
+ * exists for the "Test Connection" button which doesn't know which server
+ * to use until after a successful connection. Normal provisioning always
+ * passes a real server ID.
+ *
+ * The token is stored encrypted in tblservers.password and decrypted here
+ * via WHMCS's global decrypt() — the same encryption key used for addon
+ * module password fields.
+ *
* @param int|object $server WHMCS server ID or server object
* @param bool $any When true, fall back to any available server if the given one is not found
* @return array{url: string, base_url: string, token: string}|false
@@ -825,6 +923,164 @@ class Module
$this->output(['success' => false, 'errors' => 'unauthenticated'], true, true, 401);
}
+ /**
+ * Enforce POST as the HTTP method. Emits a 405 JSON response and exits otherwise.
+ *
+ * WHY THIS EXISTS
+ * ---------------
+ * The REST principle says mutations should be POST, and PHP's $_POST / $_GET
+ * separation means a mutation that reads from $_POST would fail quietly when
+ * called via GET. But "fail quietly" isn't what we want — an attacker probing
+ * endpoints via crafted Unable to load reverse DNS.
');
+ return;
+ }
+ if (!resp.data.enabled) {
+ list.closest(".panel").hide();
+ return;
+ }
+ vfRenderRdnsPanel(serviceId, systemUrl, resp.data.ips || []);
+ }).fail(function () {
+ list.html('Unable to load reverse DNS.
');
+ });
+}
+
+function vfRenderRdnsPanel(serviceId, systemUrl, ips) {
+ var list = $("#vf-rdns-list");
+ list.empty();
+ if (!ips.length) {
+ list.html('No IP addresses assigned to this server yet.
');
+ return;
+ }
+ ips.forEach(function (row) {
+ var wrap = $('');
+ var ipLabel = $('').text(row.ip);
+ var badge = vfRdnsBadge(row.status);
+
+ var input = $('');
+ input.val(row.ptr || "");
+
+ var saveBtn = $('');
+ var msg = $('');
+
+ saveBtn.on("click", function () {
+ vfUpdateRdns(serviceId, systemUrl, row.ip, input, saveBtn, msg, badge);
+ });
+ input.on("keydown", function (e) {
+ if (e.key === "Enter") { e.preventDefault(); saveBtn.click(); }
+ });
+
+ var editor = $('').append(input).append(saveBtn);
+ wrap.append(ipLabel).append(editor).append(badge).append(msg);
+ list.append(wrap);
+ });
+}
+
+function vfUpdateRdns(serviceId, systemUrl, ip, input, saveBtn, msg, badge) {
+ var ptr = (input.val() || "").trim();
+ // Light client-side regex mirrors the server-side one — strict enforcement is on the server.
+ if (ptr !== "" && !/^([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}\.?$/.test(ptr)) {
+ msg.text("Invalid hostname.").css("color", "#dc3545").show();
+ return;
+ }
+ saveBtn.prop("disabled", true);
+ msg.hide();
+
+ $.ajax({
+ url: vfUrl(systemUrl, serviceId, "rdnsUpdate"),
+ method: "POST",
+ data: { ip: ip, ptr: ptr },
+ dataType: "json"
+ }).done(function (resp) {
+ saveBtn.prop("disabled", false);
+ if (resp && resp.success) {
+ var verb = (ptr === "") ? "deleted" : "saved";
+ msg.text("rDNS " + verb + ".").css("color", "#28a745").show();
+ setTimeout(function () { msg.fadeOut(); }, 2500);
+ // Optimistically update the badge; a background refresh will correct it.
+ if (ptr === "") {
+ badge.replaceWith(vfRdnsBadge("missing"));
+ } else {
+ badge.replaceWith(vfRdnsBadge("ok"));
+ }
+ } else {
+ var err = (resp && resp.errors) ? resp.errors : "Save failed.";
+ msg.text(err).css("color", "#dc3545").show();
+ }
+ }).fail(function (xhr) {
+ saveBtn.prop("disabled", false);
+ var err = "Save failed.";
+ try {
+ var r = JSON.parse(xhr.responseText);
+ if (r && r.errors) err = r.errors;
+ } catch (e) {}
+ msg.text(err).css("color", "#dc3545").show();
+ });
+}
+
+// Admin-side wrappers — different endpoint ("admin"), no ownership check on server side.
+
+function vfAdminLoadRdns(serviceId, systemUrl) {
+ var list = $("#vf-rdns-list");
+ $.ajax({
+ url: vfUrl(systemUrl, serviceId, "rdnsStatus", "admin"),
+ method: "GET",
+ dataType: "json"
+ }).done(function (resp) {
+ if (!resp || !resp.success) {
+ list.html('Unable to load PTR state.');
+ return;
+ }
+ if (!resp.data.enabled) {
+ list.html('Reverse DNS addon is not activated.');
+ return;
+ }
+ list.empty();
+ if (!resp.data.ips.length) {
+ list.html('No IPs assigned.');
+ return;
+ }
+ resp.data.ips.forEach(function (row) {
+ var line = $('');
+ $('').text(row.ip).appendTo(line);
+ $('').text(row.ptr || "(no PTR)").appendTo(line);
+ vfRdnsBadge(row.status).appendTo(line);
+ list.append(line);
+ });
+ }).fail(function () {
+ list.html('Unable to load PTR state.');
+ });
+}
+
+function vfAdminReconcileRdns(serviceId, systemUrl, force) {
+ var out = $("#vf-rdns-report");
+ out.text("Reconciling…").css("color", "#555");
+ $.ajax({
+ url: vfUrl(systemUrl, serviceId, "rdnsReconcile", "admin"),
+ method: "POST",
+ data: { force: force ? 1 : 0 },
+ dataType: "json"
+ }).done(function (resp) {
+ if (resp && resp.success) {
+ var s = resp.data;
+ var parts = [];
+ ["added", "reset", "preserved", "forward_missing", "no_zone", "errors"].forEach(function (k) {
+ if (s[k] > 0) parts.push(k + "=" + s[k]);
+ });
+ out.text(parts.length ? parts.join(" ") : "no changes needed").css("color", "#28a745");
+ vfAdminLoadRdns(serviceId, systemUrl);
+ } else {
+ out.text((resp && resp.errors) ? resp.errors : "Reconcile failed").css("color", "#dc3545");
+ }
+ }).fail(function () {
+ out.text("Reconcile failed").css("color", "#dc3545");
+ });
+}
diff --git a/modules/servers/VirtFusionDirect/templates/overview.tpl b/modules/servers/VirtFusionDirect/templates/overview.tpl
index 3bcfb00..a5a4704 100644
--- a/modules/servers/VirtFusionDirect/templates/overview.tpl
+++ b/modules/servers/VirtFusionDirect/templates/overview.tpl
@@ -237,6 +237,28 @@
+{if $rdnsEnabled}
+{* Reverse DNS Panel *}
+
+
+{/if}
+
{* Resources Panel — populated by JS after server data loads *}
+
+ Reverse DNS
+
+
+Set a custom PTR record for each assigned IP. Forward DNS (A/AAAA) for the hostname must already resolve to the IP before the PTR can be saved.
+ +
+
+
+
+
+