Merge pull request 'Release: dev → main (02.58.x)' (#248) from dev into main
Cascade Main -> Dev / Cascade main -> dev (push) Has been cancelled
Sync Workflows to Repos / sync (push) Has been cancelled

This commit was merged in pull request #248.
This commit is contained in:
2026-07-12 22:18:48 +00:00
78 changed files with 2545 additions and 310 deletions
+12 -2
View File
@@ -29,6 +29,7 @@ secrets/
*.pid
*.seed
# ============================================================
# OS / Editor / IDE cruft
# ============================================================
@@ -45,6 +46,7 @@ Icon?
.idea/
.settings/
.claude/
.gemini/
.vscode/*
!.vscode/tasks.json
!.vscode/settings.json.example
@@ -116,6 +118,8 @@ out/
*.map
*.css.map
*.js.map
*.min.css
*.min.js
*.tsbuildinfo
# ============================================================
@@ -151,7 +155,7 @@ package-lock.json
# PHP / Composer tooling
# ============================================================
vendor/
!source/media/vendor/
!src/media/vendor/
composer.lock
*.phar
codeception.phar
@@ -177,7 +181,7 @@ __pycache__/
*.egg
*.egg-info/
.installed.cfg
MANIFEST
/MANIFEST
develop-eggs/
downloads/
eggs/
@@ -201,3 +205,9 @@ hypothesis/
profile.ps1
.mcp.json
# ============================================================
# Local wiki clone (not version controlled)
# ============================================================
wiki/
docs/
+1 -1
View File
@@ -5,7 +5,7 @@
# FILE INFORMATION
# DEFGROUP: MokoGitea.Workflow
# INGROUP: mokocli.Automation
# VERSION: 01.00.00
# VERSION: 02.58.37
# BRIEF: Auto-create feature branch when an issue is opened
name: "Universal: Issue Branch"
+24
View File
@@ -2,6 +2,30 @@
## [Unreleased]
### Fixed
- Pre-update backup on the **Joomla Update** page is now **seamless** (Akeeba-style): after the full-screen backup runs, the plugin auto-ticks Joomla's "I have taken a backup" checkbox and clicks Install, so the update continues automatically instead of stopping for a second manual click.
- Pre-update full-screen backup now actually fires on the **Joomla Update** page. The "Install the update" button posts to `option=com_joomlaupdate&layout=update` (Joomla's confirm/updating page) — carrying **only `layout=update`**, no `view`/`task` — so the previous match on `view=update`/`update.install` never triggered. The plugin now intercepts `layout=update` (as well as `view=update` and the legacy `update.install`) and returns the browser there flagged `is_backed_up=1`.
### Added
- **Snapshot transfer + master→slave injection (#237):** download a content snapshot as a portable **`.msbsnap`** file (zip of `manifest.json` + `snapshot.json` + a sha256 integrity check); **import** one on another site via a new Import button on the Snapshots page (materialises a local snapshot record you can then restore); and a **direct injection API**`POST /api/index.php/v1/mokosuitebackup/snapshot/inject` — so a **master** site can push a snapshot straight into a **slave**'s Web Services API. Two conflict modes ship now: **overwrite** (replace matching items by ID — master wins) and **create** (skip existing, add only new), selectable per inject call or defaulted in **Options → Snapshot Transfer**. A receiving site must opt in via the new *Allow Snapshot Injection* setting. A third **duplicate** mode inserts everything as brand-new records with **remapped IDs** (articles, categories, modules — plus their tags, custom-field values and featured flags) using Joomla's Table API so assets/UCM/nested-sets stay valid; each item is inserted defensively (a bad item is skipped and logged, never fatal).
- Full-screen backup now also fronts **extension updates and uninstalls** (Extensions → Update / Manage), not just core Joomla updates. Because `com_installer`'s `update.update` / `manage.remove` are POST actions (CSRF token + a checked `cid[]` list) that a server-side redirect can't cleanly resume, this is done client-side: the toolbar Update/Uninstall click is intercepted, the selection is captured, the full-screen backup runs, and on return the original selection is restored and the real POST form is re-submitted. Gated by `backup_before_update` / `backup_before_uninstall`, super-user only, and skipped if a backup already ran this session.
- Manual **"Backup Now"** completion now offers a **View backup record** button (links straight to the record that was just created). It appears only for manual backups — the pre-update / pre-uninstall flow hands control back to Joomla instead.
- **Full-screen backup screen** (`view=runbackup`) for both pre-update and manual backups, modelled on Akeeba's Backup-on-Update — replaces the earlier popup-modal approach. Clicking Joomla's **Install the update** now redirects (server-side, Akeeba-style) to a dedicated full-page backup screen that runs the stepped backup with a real progress bar and then **automatically continues the update** via a validated `returnurl` (flagged `is_backed_up=1` so the backup isn't repeated). Crucially, **no backup runs synchronously inside the update request** — which is what white-screened large sites. The dashboard **Backup Now** now opens the same full-screen screen instead of an inline modal. (#196)
- Retention now prunes **remote** copies too: when a backup is pruned by age/count, its archive is deleted from every enabled remote destination (SFTP / FTP / S3 / Google Drive), not just the local copy. Each uploader gained an idempotent `delete()` method (already-absent file = success), and removal is best-effort — a failing destination is logged but never blocks local pruning. The shared standalone `restore.php` is intentionally left in place (every backup overwrites it, so newer backups still depend on it). (#229)
### Changed
- Consolidated backup plumbing into shared helpers (#230):
- New `RemoteUploaderFactory` replaces the `createUploaderFromParams()` copy that was duplicated in `BackupEngine` and `SteppedBackupEngine`.
- `RetentionManager` is now the single retention authority — it takes the global `max_age_days`/`max_backups` fallback and gained `pruneOrphans()`; the system plugin's hourly cleanup delegates to it and its duplicate `deleteBackupRecord()` logic is removed.
- The backend controller, Web Services API controller, and legacy `cli/mokosuitebackup.php` now run backups through the shared `BackupRunner` (gaining the normalized complete/warning/fail status) instead of instantiating `BackupEngine` directly.
### Fixed
- Package installer is now **honest about success**: the postflight no longer prints "installed successfully" / next-steps when the install actually failed or only partially completed. Joomla logs a failed child extension but still runs the package postflight, so the postflight now (a) verifies every bundled child declared in the manifest actually registered in `#__extensions` (matched by element + type, and folder/group for plugins) and (b) verifies the component's schema tables — derived dynamically from the installed `install.mysql.sql` — actually exist. If anything is missing it enqueues an error listing what's missing and stops before the success message. Fail-open: any manifest/DB/IO glitch is treated as "nothing missing" so a transient error never turns a good install into a false failure. Unconditional housekeeping (e.g. download-key restore) still runs regardless.
- Pre-update full-screen backup screen now actually triggers on **Joomla 6** (and 4/5). The redirect matched only the legacy `update.install` task, which Joomla 4/5/6 don't use — they server-side-redirect to the **updating page `view=update`**, which then extracts the downloaded package from JavaScript. The plugin now intercepts the `view=update` page **load** (the last point before any files change) and returns the browser there flagged `is_backed_up=1` so the extraction proceeds after the backup. (`update.finalise` is intentionally not intercepted — by then the files are already extracted.)
- Pre-update/uninstall backup no longer **white-screens** the update on large sites. The synchronous backup that runs inside the extension update/uninstall request now raises `max_execution_time`/`memory_limit` (and `ignore_user_abort`) like the web-cron path, so it can't exhaust the request's default limits mid-backup. (Core Joomla updates additionally get a full-screen backup screen — see below.)
- Archive names for **CLI/console-triggered backups** no longer come out as `joomla.invalid_…`. The `[HOST]` placeholder took `$_SERVER['HTTP_HOST']` verbatim, but Joomla's console fills that with the reserved sentinel host `joomla.invalid`; the resolver now treats that (like empty/`localhost`) as unusable and falls back to the configured `live_site` host, then the system hostname. (Set the site's *live_site* to get the exact domain in CLI-built names.)
- Standalone restore script generation no longer aborts backups with `str_replace() expects at least 3 arguments, 2 given`. `MokoRestore::generateStandaloneScript()` had a `str_replace()` call (the "Backup Archive" pre-check rewrite) that was missing its `$php` subject argument, so **every** standalone-mode backup fatally errored while "Generating standalone restore.php…" — the archive still finalized and uploaded, but no `restore.php` was ever produced (the true root cause behind #226). (#226)
- Remote upload: the standalone restore script upload is no longer silent — its result is now checked and logged, and a failed restore-script upload marks the backup as `warning` (previously the result was discarded, so a missing restore script on the remote went unreported while the archive still showed success). (#226)
## [02.58.00] --- 2026-07-06
+1 -1
View File
@@ -23,7 +23,7 @@ DEFGROUP: Template-Joomla
INGROUP: Template-Joomla.Documentation
REPO: https://git.mokoconsulting.tech/MokoConsulting/Template-Joomla
PATH: /SECURITY.md
VERSION: 02.58.00
VERSION: 02.58.37
BRIEF: Security vulnerability reporting and handling policy
-->
@@ -13,7 +13,7 @@ namespace Joomla\Component\MokoSuiteBackup\Api\Controller;
defined('_JEXEC') or die;
use Joomla\CMS\MVC\Controller\ApiController;
use Joomla\Component\MokoSuiteBackup\Administrator\Engine\BackupEngine;
use Joomla\Component\MokoSuiteBackup\Administrator\Service\BackupRunner;
class BackupsController extends ApiController
{
@@ -38,8 +38,7 @@ class BackupsController extends ApiController
$profileId = (int) ($data['profile'] ?? 1);
$description = $data['description'] ?? 'API backup ' . date('Y-m-d H:i:s');
$engine = new BackupEngine();
$result = $engine->run($profileId, $description, 'api');
$result = (new BackupRunner())->run($profileId, $description, 'api');
if ($result['success']) {
$this->app->setHeader('status', 200);
@@ -21,9 +21,11 @@ namespace Joomla\Component\MokoSuiteBackup\Api\Controller;
defined('_JEXEC') or die;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Factory;
use Joomla\CMS\MVC\Controller\ApiController;
use Joomla\Component\MokoSuiteBackup\Administrator\Engine\SnapshotEngine;
use Joomla\Component\MokoSuiteBackup\Administrator\Engine\SnapshotPortable;
use Joomla\Component\MokoSuiteBackup\Administrator\Engine\SnapshotRestoreEngine;
class SnapshotsController extends ApiController
@@ -159,11 +161,11 @@ class SnapshotsController extends ApiController
$data = json_decode($this->input->json->getRaw(), true) ?: [];
$mode = $data['mode'] ?? 'replace';
$mode = (string) ($data['mode'] ?? 'replace');
$contentTypes = $data['content_types'] ?? [];
// Enforce valid restore mode
if (!in_array($mode, ['replace', 'merge'], true)) {
// Accept the external mode names too; the engine normalises + validates.
if (!in_array($mode, ['replace', 'merge', 'overwrite', 'create', 'duplicate'], true)) {
$mode = 'replace';
}
@@ -183,6 +185,86 @@ class SnapshotsController extends ApiController
return $this;
}
/**
* Inject a snapshot payload directly into this site (master → slave).
* POST /api/index.php/v1/mokosuitebackup/snapshot/inject
*
* Body: {
* "snapshot": { version, content_types, tables }, // the payload (required)
* "mode": "overwrite" | "create" | "duplicate", // optional; defaults to the site's snapshot_inject_mode
* "content_types": [ ... ], // optional filter
* "description": "..." // optional
* }
*/
public function inject(): static
{
if (!$this->app->getIdentity()->authorise('mokosuitebackup.snapshot.manage', 'com_mokosuitebackup')) {
$this->app->setHeader('status', 403);
echo json_encode(['errors' => [['title' => 'Access denied']]]);
$this->app->close();
return $this;
}
$params = ComponentHelper::getParams('com_mokosuitebackup');
// The receiving (slave) site must explicitly allow injection.
if (!(int) $params->get('snapshot_allow_inject', 0)) {
$this->app->setHeader('status', 403);
echo json_encode(['errors' => [['title' => 'Snapshot injection is disabled on this site']]]);
$this->app->close();
return $this;
}
$body = json_decode($this->input->json->getRaw(), true) ?: [];
$snapshot = $body['snapshot'] ?? null;
if (!is_array($snapshot)) {
$this->app->setHeader('status', 400);
echo json_encode(['errors' => [['title' => 'Missing "snapshot" payload']]]);
$this->app->close();
return $this;
}
// Explicit mode wins; otherwise the site default from Options.
$mode = (string) ($body['mode'] ?? $params->get('snapshot_inject_mode', 'overwrite'));
$contentTypes = $body['content_types'] ?? [];
$description = (string) ($body['description'] ?? 'Injected snapshot');
// Materialise a local record from the payload, then restore it.
$ingest = SnapshotPortable::ingestData($snapshot, $description);
if (empty($ingest['success'])) {
$this->app->setHeader('status', 422);
echo json_encode(['errors' => [['title' => $ingest['message']]]]);
$this->app->close();
return $this;
}
$engine = new SnapshotRestoreEngine();
$result = $engine->restore((int) $ingest['id'], $mode, $contentTypes);
$result['snapshot_id'] = (int) $ingest['id'];
if (!empty($ingest['warnings'])) {
$result['warnings'] = array_merge($result['warnings'] ?? [], $ingest['warnings']);
}
if ($result['success']) {
$this->app->setHeader('status', 200);
echo json_encode(['data' => $result]);
} else {
$this->app->setHeader('status', 500);
echo json_encode(['errors' => [['title' => $result['message']]], 'data' => $result]);
}
$this->app->close();
return $this;
}
/**
* Delete a snapshot record and its data file (DELETE /api/index.php/v1/mokosuitebackup/snapshot/:id)
*/
@@ -30,7 +30,7 @@ if (!defined('JPATH_BASE')) {
require_once JPATH_BASE . '/includes/framework.php';
use Joomla\CMS\Factory;
use Joomla\Component\MokoSuiteBackup\Administrator\Engine\BackupEngine;
use Joomla\Component\MokoSuiteBackup\Administrator\Service\BackupRunner;
// Parse CLI arguments
$profileId = 1;
@@ -56,8 +56,7 @@ echo "Profile: {$profileId}\n";
echo "Description: {$description}\n";
echo "Starting backup...\n\n";
$engine = new BackupEngine();
$result = $engine->run($profileId, $description, 'cli');
$result = (new BackupRunner())->run($profileId, $description, 'cli');
if ($result['success']) {
echo "SUCCESS: " . $result['message'] . "\n";
@@ -206,6 +206,31 @@
/>
</fieldset>
<fieldset name="snapshot_transfer" label="COM_MOKOJOOMBACKUP_CONFIG_SNAPSHOT_TRANSFER">
<field
name="snapshot_inject_mode"
type="list"
label="COM_MOKOJOOMBACKUP_CONFIG_SNAPSHOT_INJECT_MODE"
description="COM_MOKOJOOMBACKUP_CONFIG_SNAPSHOT_INJECT_MODE_DESC"
default="overwrite"
>
<option value="overwrite">COM_MOKOJOOMBACKUP_SNAPSHOT_MODE_OVERWRITE</option>
<option value="create">COM_MOKOJOOMBACKUP_SNAPSHOT_MODE_CREATE</option>
<option value="duplicate">COM_MOKOJOOMBACKUP_SNAPSHOT_MODE_DUPLICATE</option>
</field>
<field
name="snapshot_allow_inject"
type="radio"
label="COM_MOKOJOOMBACKUP_CONFIG_SNAPSHOT_ALLOW_INJECT"
description="COM_MOKOJOOMBACKUP_CONFIG_SNAPSHOT_ALLOW_INJECT_DESC"
default="0"
class="btn-group"
>
<option value="1">JYES</option>
<option value="0">JNO</option>
</field>
</fieldset>
<fieldset name="notifications" label="COM_MOKOJOOMBACKUP_CONFIG_NOTIFICATIONS">
<field
name="notify_email"
@@ -331,9 +331,25 @@ COM_MOKOJOOMBACKUP_CONFIG_SHOW_UPDATE_NOTICE_DESC="Display the update site confi
COM_MOKOJOOMBACKUP_CONFIG_PREACTION="Pre-action Backups"
COM_MOKOJOOMBACKUP_CONFIG_BACKUP_BEFORE_UPDATE="Backup Before Extension Update"
COM_MOKOJOOMBACKUP_CONFIG_BACKUP_BEFORE_UPDATE_DESC="Automatically run a full backup before any extension is updated. Uses the default profile. Throttled to once per 10 minutes to prevent duplicate backups during batch updates."
COM_MOKOJOOMBACKUP_CONFIG_PREUPDATE_AUTO_INTERCEPT="Auto-run on Update click"
COM_MOKOJOOMBACKUP_CONFIG_PREUPDATE_AUTO_INTERCEPT_DESC="When enabled, clicking the Update button on the Joomla Update or Extensions update page first pops the backup progress modal, runs the pre-update backup, then automatically continues the update. When disabled, a notice with a manual 'Back up now' button is shown instead."
COM_MOKOJOOMBACKUP_CONFIG_BACKUP_BEFORE_UNINSTALL="Backup Before Extension Uninstall"
COM_MOKOJOOMBACKUP_CONFIG_BACKUP_BEFORE_UNINSTALL_DESC="Automatically run a full backup before any extension is uninstalled. Uses the default profile. Throttled to once per 10 minutes."
; Full-screen backup progress view (runbackup)
COM_MOKOJOOMBACKUP_RUNBACKUP_TITLE="Backing Up"
COM_MOKOJOOMBACKUP_RUNBACKUP_PROFILE="Profile: %s"
COM_MOKOJOOMBACKUP_RUNBACKUP_STARTING="Starting backup…"
COM_MOKOJOOMBACKUP_RUNBACKUP_RUNNING="Backing up…"
COM_MOKOJOOMBACKUP_RUNBACKUP_COMPLETE="Backup complete"
COM_MOKOJOOMBACKUP_RUNBACKUP_CONTINUING="Backup complete — continuing…"
COM_MOKOJOOMBACKUP_RUNBACKUP_FAILED="Backup failed"
COM_MOKOJOOMBACKUP_RUNBACKUP_RETRY="Retry backup"
COM_MOKOJOOMBACKUP_RUNBACKUP_CONTINUE_ANYWAY="Continue without backup"
COM_MOKOJOOMBACKUP_RUNBACKUP_BACK_TO_DASHBOARD="Back to dashboard"
COM_MOKOJOOMBACKUP_RUNBACKUP_VIEW_RECORD="View backup record"
COM_MOKOJOOMBACKUP_RUNBACKUP_LEAVE_WARNING="A backup is in progress. Leaving now will cancel it."
COM_MOKOJOOMBACKUP_CONFIG_CLEANUP="Cleanup Defaults"
COM_MOKOJOOMBACKUP_CONFIG_MAX_AGE="Max Backup Age (days)"
COM_MOKOJOOMBACKUP_CONFIG_MAX_AGE_DESC="Default maximum age for backup records. Used by the system plugin and CLI cleanup command."
@@ -382,6 +398,8 @@ COM_MOKOJOOMBACKUP_FIELD_NOTIFY_USER_GROUPS_DESC="Select Joomla user groups whos
; Dashboard warnings
COM_MOKOJOOMBACKUP_DASHBOARD_DEFAULT_DIR_WARNING_TITLE="Backup directory is inside the web root"
COM_MOKOJOOMBACKUP_DASHBOARD_DEFAULT_DIR_WARNING="One or more profiles store backups in the default directory inside the web root. This may expose backup archives if .htaccess is not supported. Move backups to a directory outside the web root for better security."
COM_MOKOJOOMBACKUP_DASHBOARD_LIVESITE_WARNING_TITLE="Site URL (live_site) is not set"
COM_MOKOJOOMBACKUP_DASHBOARD_LIVESITE_WARNING="Your Global Configuration has no Site URL (live_site). CLI and scheduled backups can't reliably determine the site's domain (archive names fall back to the server hostname), and some URLs may be generated incorrectly. Set Site URL in System → Global Configuration to your full site address including https://."
COM_MOKOJOOMBACKUP_WEB_ACCESSIBLE_WARNING="This backup is stored inside the web root and may be directly downloadable if .htaccess is not supported."
@@ -477,6 +495,22 @@ COM_MOKOJOOMBACKUP_WEBCRON_IP_NONE="No IP restrictions — any IP can trigger we
COM_MOKOJOOMBACKUP_WEBCRON_IP_PLACEHOLDER="Enter IP address"
COM_MOKOJOOMBACKUP_WEBCRON_IP_ADD="Add"
; Snapshot transfer / injection (#237)
COM_MOKOJOOMBACKUP_SNAPSHOT_DOWNLOAD="Download portable snapshot (.msbsnap)"
COM_MOKOJOOMBACKUP_SNAPSHOT_NOT_FOUND="Snapshot not found."
COM_MOKOJOOMBACKUP_SNAPSHOT_IMPORT="Import Snapshot"
COM_MOKOJOOMBACKUP_SNAPSHOT_IMPORT_DESC="Upload a .msbsnap file exported from another site. It is added as a snapshot here, which you can then restore."
COM_MOKOJOOMBACKUP_SNAPSHOT_IMPORT_FILE="Snapshot file (.msbsnap)"
COM_MOKOJOOMBACKUP_SNAPSHOT_IMPORT_NO_FILE="No snapshot file was uploaded, or the upload failed."
COM_MOKOJOOMBACKUP_SNAPSHOT_MODE_OVERWRITE="Overwrite — replace matching items (master wins)"
COM_MOKOJOOMBACKUP_SNAPSHOT_MODE_CREATE="Create — skip existing, add only new items"
COM_MOKOJOOMBACKUP_SNAPSHOT_MODE_DUPLICATE="Duplicate — add as new copies (remapped IDs)"
COM_MOKOJOOMBACKUP_CONFIG_SNAPSHOT_TRANSFER="Snapshot Transfer / Injection"
COM_MOKOJOOMBACKUP_CONFIG_SNAPSHOT_INJECT_MODE="Default Conflict Mode"
COM_MOKOJOOMBACKUP_CONFIG_SNAPSHOT_INJECT_MODE_DESC="Default mode used when a snapshot is injected via the API without an explicit mode."
COM_MOKOJOOMBACKUP_CONFIG_SNAPSHOT_ALLOW_INJECT="Allow Snapshot Injection (API)"
COM_MOKOJOOMBACKUP_CONFIG_SNAPSHOT_ALLOW_INJECT_DESC="Allow a remote master site to inject snapshots directly into this site via the Web Services API (POST /snapshot/inject). Off by default; requires an API token with snapshot-manage permission."
; Snapshot browse / detail view
COM_MOKOJOOMBACKUP_SNAPSHOT_BROWSE="Browse Snapshot"
COM_MOKOJOOMBACKUP_SNAPSHOT_TAB_ARTICLES="Articles"
@@ -53,9 +53,25 @@ COM_MOKOJOOMBACKUP_CONFIG_SHOW_UPDATE_NOTICE_DESC="Display the update site confi
COM_MOKOJOOMBACKUP_CONFIG_PREACTION="Pre-action Backups"
COM_MOKOJOOMBACKUP_CONFIG_BACKUP_BEFORE_UPDATE="Backup Before Extension Update"
COM_MOKOJOOMBACKUP_CONFIG_BACKUP_BEFORE_UPDATE_DESC="Automatically run a full backup before any extension is updated. Uses the default profile. Throttled to once per 10 minutes to prevent duplicate backups during batch updates."
COM_MOKOJOOMBACKUP_CONFIG_PREUPDATE_AUTO_INTERCEPT="Auto-run on Update click"
COM_MOKOJOOMBACKUP_CONFIG_PREUPDATE_AUTO_INTERCEPT_DESC="When enabled, clicking the Update button on the Joomla Update or Extensions update page first pops the backup progress modal, runs the pre-update backup, then automatically continues the update. When disabled, a notice with a manual 'Back up now' button is shown instead."
COM_MOKOJOOMBACKUP_CONFIG_BACKUP_BEFORE_UNINSTALL="Backup Before Extension Uninstall"
COM_MOKOJOOMBACKUP_CONFIG_BACKUP_BEFORE_UNINSTALL_DESC="Automatically run a full backup before any extension is uninstalled. Uses the default profile. Throttled to once per 10 minutes."
; Full-screen backup progress view (runbackup)
COM_MOKOJOOMBACKUP_RUNBACKUP_TITLE="Backing Up"
COM_MOKOJOOMBACKUP_RUNBACKUP_PROFILE="Profile: %s"
COM_MOKOJOOMBACKUP_RUNBACKUP_STARTING="Starting backup…"
COM_MOKOJOOMBACKUP_RUNBACKUP_RUNNING="Backing up…"
COM_MOKOJOOMBACKUP_RUNBACKUP_COMPLETE="Backup complete"
COM_MOKOJOOMBACKUP_RUNBACKUP_CONTINUING="Backup complete — continuing…"
COM_MOKOJOOMBACKUP_RUNBACKUP_FAILED="Backup failed"
COM_MOKOJOOMBACKUP_RUNBACKUP_RETRY="Retry backup"
COM_MOKOJOOMBACKUP_RUNBACKUP_CONTINUE_ANYWAY="Continue without backup"
COM_MOKOJOOMBACKUP_RUNBACKUP_BACK_TO_DASHBOARD="Back to dashboard"
COM_MOKOJOOMBACKUP_RUNBACKUP_VIEW_RECORD="View backup record"
COM_MOKOJOOMBACKUP_RUNBACKUP_LEAVE_WARNING="A backup is in progress. Leaving now will cancel it."
COM_MOKOJOOMBACKUP_CONFIG_CLEANUP="Cleanup Defaults"
COM_MOKOJOOMBACKUP_CONFIG_MAX_AGE="Max Backup Age (days)"
COM_MOKOJOOMBACKUP_CONFIG_MAX_AGE_DESC="Default maximum age for backup records. Used by the system plugin and CLI cleanup command."
@@ -73,6 +89,8 @@ COM_MOKOJOOMBACKUP_FOLDER_NOT_FOUND="Directory not found"
COM_MOKOJOOMBACKUP_BACKUP_DIR_DEFAULT="Default (inside web root)"
COM_MOKOJOOMBACKUP_DASHBOARD_DEFAULT_DIR_WARNING_TITLE="Backup directory is inside the web root"
COM_MOKOJOOMBACKUP_DASHBOARD_DEFAULT_DIR_WARNING="One or more profiles store backups in the default directory inside the web root. This may expose backup archives if .htaccess is not supported. Move backups to a directory outside the web root for better security."
COM_MOKOJOOMBACKUP_DASHBOARD_LIVESITE_WARNING_TITLE="Site URL (live_site) is not set"
COM_MOKOJOOMBACKUP_DASHBOARD_LIVESITE_WARNING="Your Global Configuration has no Site URL (live_site). CLI and scheduled backups can't reliably determine the site's domain (archive names fall back to the server hostname), and some URLs may be generated incorrectly. Set Site URL in System → Global Configuration to your full site address including https://."
COM_MOKOJOOMBACKUP_WEB_ACCESSIBLE_WARNING="This backup is stored inside the web root and may be directly downloadable if .htaccess is not supported."
COM_MOKOJOOMBACKUP_FOLDER_EXISTS="Directory exists"
COM_MOKOJOOMBACKUP_FOLDER_NOT_FOUND="Directory not found"
@@ -17,7 +17,7 @@
display label there.
-->
<name>MokoSuiteBackup</name>
<version>02.58.00</version>
<version>02.58.37</version>
<creationDate>2026-06-02</creationDate>
<author>Moko Consulting</author>
<authorEmail>hello@mokoconsulting.tech</authorEmail>
@@ -0,0 +1 @@
/* 02.58.01 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.02 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.03 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.04 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.05 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.06 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.07 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.08 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.09 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.10 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.11 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.12 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.13 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.14 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.15 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.16 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.17 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.19 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.20 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.21 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.22 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.23 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.24 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.26 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.29 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.30 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.31 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.32 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.35 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.36 — no schema changes */
@@ -0,0 +1 @@
/* 02.58.37 — no schema changes */
@@ -84,6 +84,40 @@ class AjaxController extends BaseController
$this->sendJson($result);
}
/**
* Mark the pre-action backup as satisfied for this session.
*
* Called by the full-screen backup screen after a successful backup so the
* imminent server-side onExtensionBeforeUpdate / onExtensionBeforeUninstall
* backup is skipped — it arms the same 10-minute throttle keys the system
* plugin checks, preventing a duplicate backup when the update / uninstall
* then proceeds. Arms BOTH keys so a single ack covers whichever action the
* full-screen backup was fronting.
* POST: task=ajax.preupdateAck
*/
public function preupdateAck(): void
{
if (!Session::checkToken('get') && !Session::checkToken('post')) {
$this->sendJson(['error' => true, 'message' => 'Invalid token'], 403);
return;
}
if (!$this->app->getIdentity()->authorise('mokosuitebackup.backup.run', 'com_mokosuitebackup')) {
$this->sendJson(['error' => true, 'message' => 'Access denied'], 403);
return;
}
// Same keys + semantics as plg_system_mokosuitebackup::runPreActionBackup().
$session = Factory::getSession();
$now = time();
$session->set('mokosuitebackup.preaction_backup_before_update', $now);
$session->set('mokosuitebackup.preaction_backup_before_uninstall', $now);
$this->sendJson(['error' => false, 'message' => 'Pre-action backup acknowledged']);
}
/**
* Cancel a backup record stuck in "running" status.
* POST: task=ajax.cancelBackup&id=123
@@ -16,8 +16,8 @@ use Joomla\CMS\Language\Text;
use Joomla\CMS\MVC\Controller\AdminController;
use Joomla\CMS\Router\Route;
use Joomla\CMS\Session\Session;
use Joomla\Component\MokoSuiteBackup\Administrator\Engine\BackupEngine;
use Joomla\Component\MokoSuiteBackup\Administrator\Engine\RestoreEngine;
use Joomla\Component\MokoSuiteBackup\Administrator\Service\BackupRunner;
class BackupsController extends AdminController
{
@@ -54,8 +54,7 @@ class BackupsController extends AdminController
$profileId = $this->input->getInt('profile_id', 1);
$description = $this->input->getString('description', '');
$engine = new BackupEngine();
$result = $engine->run($profileId, $description, 'backend');
$result = (new BackupRunner())->run($profileId, $description, 'backend');
// Surface preflight warnings as Joomla messages
if (!empty($result['warnings'])) {
@@ -18,6 +18,7 @@ use Joomla\CMS\MVC\Controller\AdminController;
use Joomla\CMS\Router\Route;
use Joomla\CMS\Session\Session;
use Joomla\Component\MokoSuiteBackup\Administrator\Engine\SnapshotEngine;
use Joomla\Component\MokoSuiteBackup\Administrator\Engine\SnapshotPortable;
use Joomla\Component\MokoSuiteBackup\Administrator\Engine\SnapshotRestoreEngine;
class SnapshotsController extends AdminController
@@ -29,6 +30,95 @@ class SnapshotsController extends AdminController
return parent::getModel($name, $prefix, $config);
}
/**
* Download a snapshot as a portable .msbsnap file (manifest + payload + checksum).
*/
public function downloadPortable(): void
{
$this->checkToken('get');
if (!$this->app->getIdentity()->authorise('mokosuitebackup.snapshot.manage', 'com_mokosuitebackup')) {
$this->setMessage(Text::_('JLIB_APPLICATION_ERROR_ACCESS_FORBIDDEN'), 'error');
$this->setRedirect(Route::_('index.php?option=com_mokosuitebackup&view=snapshots', false));
return;
}
$id = $this->input->getInt('id', 0);
$item = $id ? $this->getModel('Snapshot')->getItem($id) : null;
if (!$item || empty($item->id)) {
$this->setMessage(Text::_('COM_MOKOJOOMBACKUP_SNAPSHOT_NOT_FOUND'), 'error');
$this->setRedirect(Route::_('index.php?option=com_mokosuitebackup&view=snapshots', false));
return;
}
try {
$file = SnapshotPortable::package($item);
} catch (\Throwable $e) {
$this->setMessage($e->getMessage(), 'error');
$this->setRedirect(Route::_('index.php?option=com_mokosuitebackup&view=snapshots', false));
return;
}
$name = SnapshotPortable::filename($item);
while (@ob_end_clean()) {
// flush buffers
}
header('Content-Type: application/octet-stream');
header("Content-Disposition: attachment; filename*=UTF-8''" . rawurlencode($name));
header('Content-Length: ' . filesize($file));
header('Cache-Control: no-cache, must-revalidate');
readfile($file);
@unlink($file);
$this->app->close();
}
/**
* Import an uploaded .msbsnap file — materialise a local snapshot record.
*/
public function import(): void
{
$this->checkToken();
if (!$this->app->getIdentity()->authorise('mokosuitebackup.snapshot.manage', 'com_mokosuitebackup')) {
$this->setMessage(Text::_('JLIB_APPLICATION_ERROR_ACCESS_FORBIDDEN'), 'error');
$this->setRedirect(Route::_('index.php?option=com_mokosuitebackup&view=snapshots', false));
return;
}
$file = $this->input->files->get('msbsnap_file', null, 'raw');
if (!is_array($file) || empty($file['tmp_name']) || (int) ($file['error'] ?? 1) !== 0
|| !is_uploaded_file($file['tmp_name'])) {
$this->setMessage(Text::_('COM_MOKOJOOMBACKUP_SNAPSHOT_IMPORT_NO_FILE'), 'error');
$this->setRedirect(Route::_('index.php?option=com_mokosuitebackup&view=snapshots', false));
return;
}
$result = SnapshotPortable::ingestZip($file['tmp_name']);
if (!empty($result['success'])) {
foreach ($result['warnings'] ?? [] as $warning) {
$this->app->enqueueMessage($warning, 'warning');
}
$this->setMessage($result['message']);
} else {
$this->setMessage($result['message'], 'error');
}
$this->setRedirect(Route::_('index.php?option=com_mokosuitebackup&view=snapshots', false));
}
/**
* Create a new content snapshot.
*/
@@ -304,7 +304,18 @@ class BackupEngine
$this->log(' Upload complete: ' . $result['message']);
if (!empty($restoreScriptPath) && is_file($restoreScriptPath)) {
$uploader->upload($restoreScriptPath, basename($restoreScriptPath));
$scriptName = basename($restoreScriptPath);
$this->log(' Uploading restore script: ' . $scriptName . '...');
$scriptResult = $uploader->upload($restoreScriptPath, $scriptName);
if (!empty($scriptResult['success'])) {
$this->log(' Restore script uploaded: ' . ($scriptResult['message'] ?? $scriptName));
} else {
/* Never silent: a missing restore script makes the archive
much harder to restore, so surface it as a warning. */
$uploadFailed = true;
$this->log(' WARNING: Restore script upload failed: ' . ($scriptResult['message'] ?? 'unknown error'));
}
}
} else {
$uploadFailed = true;
@@ -500,24 +511,7 @@ class BackupEngine
*/
private function createUploaderFromParams(string $type, array $params): RemoteUploaderInterface
{
$prefixMap = ['ftp' => 'ftp_', 'sftp' => 'sftp_', 's3' => 's3_', 'google_drive' => 'gdrive_'];
$prefix = $prefixMap[$type] ?? '';
$prefixed = [];
foreach ($params as $key => $value) {
$prefixed[$prefix . $key] = $value;
}
$fake = (object) $prefixed;
return match ($type) {
'ftp' => new FtpUploader($fake),
'sftp' => new SftpUploader($fake),
'google_drive' => new GoogleDriveUploader($fake),
's3' => new S3Uploader($fake),
default => throw new \InvalidArgumentException('Unknown remote storage type: ' . $type),
};
return RemoteUploaderFactory::create($type, $params);
}
/**
@@ -89,6 +89,52 @@ class FtpUploader implements RemoteUploaderInterface
}
}
public function delete(string $remoteName): array
{
if (!extension_loaded('ftp')) {
return ['success' => false, 'message' => 'PHP ext-ftp is required for FTP deletes. Enable it in php.ini.'];
}
if (empty($this->host)) {
return ['success' => false, 'message' => 'FTP host is not configured'];
}
$conn = $this->connect();
if (!$conn) {
return ['success' => false, 'message' => 'Failed to connect to FTP server ' . $this->host . ':' . $this->port];
}
try {
if (!@ftp_login($conn, $this->username, $this->password)) {
throw new \RuntimeException('FTP login failed for user: ' . $this->username);
}
if ($this->passive) {
ftp_pasv($conn, true);
}
$remoteFile = $this->remotePath . '/' . $remoteName;
/* Already-absent files: ftp_delete returns false, but if the file
isn't there the retention goal is already met, so probe size to
decide. ftp_size returns -1 when the file does not exist. */
if (@ftp_size($conn, $remoteFile) < 0) {
return ['success' => true, 'message' => 'FTP: nothing to delete (' . $remoteFile . ')'];
}
if (!@ftp_delete($conn, $remoteFile)) {
throw new \RuntimeException('ftp_delete failed for: ' . $remoteFile);
}
return ['success' => true, 'message' => 'Deleted from FTP: ' . $remoteFile];
} catch (\Throwable $e) {
return ['success' => false, 'message' => 'FTP delete failed: ' . $e->getMessage()];
} finally {
@ftp_close($conn);
}
}
public function testConnection(): array
{
if (empty($this->host)) {
@@ -81,6 +81,59 @@ class GoogleDriveUploader implements RemoteUploaderInterface
}
}
public function delete(string $remoteName): array
{
if (!extension_loaded('curl')) {
return ['success' => false, 'message' => 'PHP ext-curl is required for Google Drive deletes. Enable it in php.ini.'];
}
if (empty($this->clientId) || empty($this->refreshToken)) {
return ['success' => false, 'message' => 'Google Drive credentials not configured'];
}
try {
$accessToken = $this->getAccessToken();
/* Drive has no path addressing — resolve the file id(s) by name
within the configured folder, then delete each match. */
$q = "name = '" . str_replace("'", "\\'", $remoteName) . "' and trashed = false";
if (!empty($this->folderId)) {
$q .= " and '" . $this->folderId . "' in parents";
}
$listUrl = self::API_URL . '/files?q=' . rawurlencode($q) . '&fields=' . rawurlencode('files(id,name)') . '&pageSize=25';
$response = $this->curlRequest('GET', $listUrl, null, [
'Authorization: Bearer ' . $accessToken,
]);
if ($response['code'] !== 200) {
throw new \RuntimeException('Drive file lookup failed (HTTP ' . $response['code'] . ')');
}
$files = json_decode($response['body'], true)['files'] ?? [];
if (empty($files)) {
return ['success' => true, 'message' => 'Google Drive: nothing to delete (' . $remoteName . ')'];
}
foreach ($files as $file) {
$del = $this->curlRequest('DELETE', self::API_URL . '/files/' . rawurlencode($file['id']), null, [
'Authorization: Bearer ' . $accessToken,
]);
/* 204 = deleted, 404 = already gone — both acceptable. */
if ($del['code'] !== 204 && $del['code'] !== 200 && $del['code'] !== 404) {
return ['success' => false, 'message' => 'Google Drive delete failed for ' . $remoteName . ' (HTTP ' . $del['code'] . ')'];
}
}
return ['success' => true, 'message' => 'Deleted from Google Drive: ' . $remoteName];
} catch (\Throwable $e) {
return ['success' => false, 'message' => 'Google Drive delete failed: ' . $e->getMessage()];
}
}
public function testConnection(): array
{
if (empty($this->clientId) || empty($this->refreshToken)) {
@@ -204,7 +204,8 @@ ORIG,
'ok' => $backupCount > 0,
'hint' => 'Place one or more backup ZIP files in the same directory as ' . basename($_SERVER['SCRIPT_NAME']),
];
REPL
REPL,
$php
);
/* Modify remaining pre-checks to use getSelectedBackupFile() */
@@ -52,15 +52,25 @@ class PlaceholderResolver
{
$now = new \DateTimeImmutable('now');
/* Resolve hostname: prefer HTTP_HOST (web), then try Joomla config (CLI), then system hostname */
$rawHost = $_SERVER['HTTP_HOST'] ?? $_SERVER['SERVER_NAME'] ?? '';
/* Resolve hostname: prefer the real request host (web), then the
configured live_site (CLI), then the system hostname. Joomla's console
fills the request host with the placeholder 'joomla.invalid' (an
RFC 6761 reserved TLD used as a CLI sentinel), so treat that — along
with empty/localhost — as unusable and fall through; otherwise every
CLI-triggered backup would be named 'joomla.invalid_…'. */
$unusable = static function (string $h): bool {
$h = strtolower(trim($h));
if (empty($rawHost) || $rawHost === 'localhost') {
return $h === '' || $h === 'localhost' || $h === 'joomla.invalid';
};
$rawHost = (string) ($_SERVER['HTTP_HOST'] ?? $_SERVER['SERVER_NAME'] ?? '');
if ($unusable($rawHost)) {
try {
$app = Factory::getApplication();
$liveSite = $app->get('live_site', '');
$liveSite = (string) Factory::getApplication()->get('live_site', '');
if (!empty($liveSite)) {
if ($liveSite !== '') {
$parsed = parse_url($liveSite, PHP_URL_HOST);
if (!empty($parsed)) {
@@ -68,12 +78,13 @@ class PlaceholderResolver
}
}
} catch (\Throwable $e) {
/* fallback */
/* fall through to system hostname */
}
}
if (empty($rawHost)) {
$rawHost = php_uname('n');
if ($unusable($rawHost)) {
$sysHost = php_uname('n');
$rawHost = $sysHost !== '' ? $sysHost : 'site';
}
$hostname = preg_replace('/[^a-zA-Z0-9._-]/', '', $rawHost);
@@ -0,0 +1,69 @@
<?php
/**
* @package MokoSuiteBackup
* @subpackage com_mokosuitebackup
* @author Moko Consulting <hello@mokoconsulting.tech>
* @copyright Copyright (C) 2026 Moko Consulting. All rights reserved.
* @license GNU General Public License version 3 or later; see LICENSE
*/
namespace Joomla\Component\MokoSuiteBackup\Administrator\Engine;
defined('_JEXEC') or die;
/**
* Builds a remote uploader from a `#__mokosuitebackup_remotes` row.
*
* This was previously a private method duplicated in both BackupEngine and
* SteppedBackupEngine (and needed a third time by RetentionManager for remote
* deletion). It is centralised here so the type→class map and the param
* key-prefixing convention live in exactly one place.
*
* The remotes table stores per-type settings as a flat JSON object with
* un-prefixed keys (e.g. `{"host":"…","path":"/backups"}`). The concrete
* uploaders, however, read prefixed keys off a profile-shaped object
* (e.g. `sftp_host`, `s3_bucket`). This factory bridges the two.
*/
final class RemoteUploaderFactory
{
/**
* Map of remote type → the key prefix its uploader expects.
*/
private const PREFIX_MAP = [
'ftp' => 'ftp_',
'sftp' => 'sftp_',
's3' => 's3_',
'google_drive' => 'gdrive_',
];
/**
* Create an uploader for the given remote type from decoded JSON params.
*
* @param string $type Remote type: ftp, sftp, s3, google_drive
* @param array $params Key-value params decoded from the remote's JSON
*
* @return RemoteUploaderInterface
*
* @throws \InvalidArgumentException On an unknown remote type
*/
public static function create(string $type, array $params): RemoteUploaderInterface
{
$prefix = self::PREFIX_MAP[$type] ?? '';
$prefixed = [];
foreach ($params as $key => $value) {
$prefixed[$prefix . $key] = $value;
}
$fake = (object) $prefixed;
return match ($type) {
'ftp' => new FtpUploader($fake),
'sftp' => new SftpUploader($fake),
'google_drive' => new GoogleDriveUploader($fake),
's3' => new S3Uploader($fake),
default => throw new \InvalidArgumentException('Unknown remote storage type: ' . $type),
};
}
}
@@ -24,6 +24,21 @@ interface RemoteUploaderInterface
*/
public function upload(string $localPath, string $remoteName): array;
/**
* Delete a previously-uploaded file from remote storage.
*
* Used by retention pruning so that expiring a local backup also removes
* its archive from every remote destination. Implementations should treat
* an already-absent remote file as success (idempotent delete), so a
* partially-cleaned destination never blocks pruning.
*
* @param string $remoteName Filename on the remote end (the same
* $remoteName that was passed to upload())
*
* @return array{success: bool, message: string}
*/
public function delete(string $remoteName): array;
/**
* Test the connection / credentials without uploading.
*
@@ -15,32 +15,54 @@ defined('_JEXEC') or die;
use Joomla\Component\MokoSuiteBackup\Administrator\Utility\BackupDirectory;
/**
* Enforces per-profile backup retention.
* Enforces per-profile backup retention — the single retention authority.
*
* A profile may cap retained backups by age (retention_days) and/or by
* number of copies (retention_count). A backup is pruned when EITHER rule
* matches: it is older than retention_days OR it falls outside the newest
* retention_count copies. Deleting a record also removes its archive and
* log file, mirroring the Backup table's delete().
* number of copies (retention_count). When a profile leaves a rule at 0 the
* caller-supplied global default is used instead. A backup is pruned when
* EITHER rule matches: it is older than the effective days OR it falls outside
* the newest effective count of copies.
*
* Pruning a record removes, in this order:
* 1. the DB row (#__mokosuitebackup_records),
* 2. the local archive + its .log file, and
* 3. the archive copy on every enabled remote destination for the profile.
*
* The standalone restore script (restore.php) is intentionally NOT deleted
* from remotes: it is a single, fixed-name file that every backup overwrites,
* so newer backups still depend on it — removing it while pruning an old
* archive would break restore for the copies that remain.
*
* Because records do not store which destinations they were uploaded to,
* remote deletion targets the profile's *currently enabled* remotes. Remote
* deletes are idempotent (an already-absent file counts as success) and
* best-effort: a failing remote is logged but never blocks local pruning.
*/
final class RetentionManager
{
/**
* Prune old backups for a profile according to its retention settings.
*
* Called after a backup completes. Only 'complete' and 'warning' records
* are considered — pending/running/failed records are never pruned here.
* Called after a backup completes and from the periodic admin-side cleanup.
* Only 'complete' and 'warning' records are considered — pending/running/
* failed records are never pruned here.
*
* @param object $db Database driver
* @param object $profile Profile row (needs id, retention_days, retention_count)
* @param object $db Database driver
* @param object $profile Profile row (needs id, retention_days, retention_count)
* @param int $globalDays Fallback max age (days) when the profile's is 0
* @param int $globalCount Fallback max copies when the profile's is 0
*
* @return int Number of backup records deleted
*/
public static function prune(object $db, object $profile): int
public static function prune(object $db, object $profile, int $globalDays = 0, int $globalCount = 0): int
{
$days = (int) ($profile->retention_days ?? 0);
$count = (int) ($profile->retention_count ?? 0);
// A profile value of 0 means "use the global default".
$days = $days > 0 ? $days : $globalDays;
$count = $count > 0 ? $count : $globalCount;
// No retention configured — nothing to do.
if ($days <= 0 && $count <= 0) {
return 0;
@@ -48,7 +70,7 @@ final class RetentionManager
// Newest first, so the index is the copy's position from the top.
$query = $db->getQuery(true)
->select($db->quoteName(['id', 'absolute_path', 'backupstart']))
->select($db->quoteName(['id', 'archivename', 'absolute_path', 'backupstart']))
->from($db->quoteName('#__mokosuitebackup_records'))
->where($db->quoteName('profile_id') . ' = ' . (int) $profile->id)
->where($db->quoteName('status') . ' IN (' . implode(',', array_map([$db, 'quote'], ['complete', 'warning'])) . ')')
@@ -61,6 +83,7 @@ final class RetentionManager
}
$cutoffTs = $days > 0 ? (time() - ($days * 86400)) : null;
$remotes = self::loadEnabledRemotes($db, (int) $profile->id);
$deleted = 0;
foreach ($records as $index => $record) {
@@ -72,7 +95,7 @@ final class RetentionManager
continue;
}
if (self::deleteRecord($db, $record)) {
if (self::deleteRecord($db, $record, $remotes)) {
$deleted++;
}
}
@@ -81,12 +104,54 @@ final class RetentionManager
}
/**
* Delete a single backup record and its on-disk archive + log file.
* Delete backup records whose profile no longer exists.
*
* The DB row is removed first; the files are only unlinked if that
* succeeds, so a failed delete never orphans the record from its files.
* Orphans have no owning profile and therefore no remote destinations to
* reconcile, so only the local archive/log and DB row are removed.
*
* @param object $db Database driver
*
* @return int Number of orphaned records deleted
*/
private static function deleteRecord(object $db, object $record): bool
public static function pruneOrphans(object $db): int
{
$query = $db->getQuery(true)
->select($db->quoteName(['r.id', 'r.archivename', 'r.absolute_path'], ['id', 'archivename', 'absolute_path']))
->from($db->quoteName('#__mokosuitebackup_records', 'r'))
->join(
'LEFT',
$db->quoteName('#__mokosuitebackup_profiles', 'p')
. ' ON ' . $db->quoteName('p.id') . ' = ' . $db->quoteName('r.profile_id')
)
->where($db->quoteName('p.id') . ' IS NULL')
->where($db->quoteName('r.status') . ' IN (' . implode(',', array_map([$db, 'quote'], ['complete', 'warning'])) . ')');
$db->setQuery($query);
$orphans = $db->loadObjectList() ?: [];
$deleted = 0;
foreach ($orphans as $record) {
if (self::deleteRecord($db, $record, [])) {
$deleted++;
}
}
return $deleted;
}
/**
* Delete a single backup record, its on-disk archive + log file, and the
* archive copy on each enabled remote destination.
*
* The DB row is removed first; the local files are only unlinked if that
* succeeds, so a failed delete never orphans the record from its files.
* Remote deletion is best-effort and runs regardless.
*
* @param object $db Database driver
* @param object $record Record row (needs id, archivename, absolute_path)
* @param object[] $remotes Enabled remote rows (type, params) for the profile
*/
private static function deleteRecord(object $db, object $record, array $remotes): bool
{
$query = $db->getQuery(true)
->delete($db->quoteName('#__mokosuitebackup_records'))
@@ -113,6 +178,69 @@ final class RetentionManager
}
}
self::deleteFromRemotes($record, $remotes);
return true;
}
/**
* Remove the record's archive from every enabled remote destination.
*
* Best-effort: each remote is tried independently and failures are logged,
* never thrown, so one unreachable destination can't stall retention.
*
* @param object $record Record row (needs archivename)
* @param object[] $remotes Enabled remote rows (type, params)
*/
private static function deleteFromRemotes(object $record, array $remotes): void
{
$archiveName = (string) ($record->archivename ?? '');
if ($archiveName === '' || empty($remotes)) {
return;
}
foreach ($remotes as $remote) {
try {
$params = json_decode((string) ($remote->params ?? ''), true) ?: [];
$uploader = RemoteUploaderFactory::create((string) $remote->type, $params);
$result = $uploader->delete($archiveName);
if (empty($result['success'])) {
error_log(
'MokoSuiteBackup: retention could not delete ' . $archiveName
. ' from ' . $remote->type . ' remote: ' . ($result['message'] ?? 'unknown error')
);
}
} catch (\Throwable $e) {
error_log(
'MokoSuiteBackup: retention remote-delete error for ' . $archiveName
. ' (' . ($remote->type ?? '?') . '): ' . $e->getMessage()
);
}
}
}
/**
* Load the profile's enabled remote destinations (type + params only).
*
* Returns an empty array if the remotes table is missing (very old installs)
* or the profile has none, so callers can iterate unconditionally.
*/
private static function loadEnabledRemotes(object $db, int $profileId): array
{
try {
$query = $db->getQuery(true)
->select($db->quoteName(['type', 'params']))
->from($db->quoteName('#__mokosuitebackup_remotes'))
->where($db->quoteName('profile_id') . ' = ' . $profileId)
->where($db->quoteName('enabled') . ' = 1')
->order($db->quoteName('ordering') . ' ASC');
$db->setQuery($query);
return $db->loadObjectList() ?: [];
} catch (\Throwable $e) {
return [];
}
}
}
@@ -75,6 +75,54 @@ class S3Uploader implements RemoteUploaderInterface
}
}
public function delete(string $remoteName): array
{
if (!extension_loaded('curl')) {
return ['success' => false, 'message' => 'PHP ext-curl is required for S3 deletes. Enable it in php.ini.'];
}
if (empty($this->accessKey) || empty($this->secretKey) || empty($this->bucket)) {
return ['success' => false, 'message' => 'S3 credentials or bucket not configured'];
}
try {
$objectKey = ($this->path ? $this->path . '/' : '') . $remoteName;
$url = $this->getObjectUrl($objectKey);
$headers = $this->signRequest('DELETE', $url, hash('sha256', ''));
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => $url,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => $headers,
CURLOPT_TIMEOUT => 60,
]);
$response = curl_exec($ch);
$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if (curl_errno($ch)) {
$error = curl_error($ch);
curl_close($ch);
throw new \RuntimeException('cURL error: ' . $error);
}
curl_close($ch);
/* S3 DELETE returns 204 on success and — by design — also 204 when
the key never existed. 404 is treated as already-gone too. */
if ($code === 204 || $code === 200 || $code === 404) {
return ['success' => true, 'message' => 'Deleted from S3: s3://' . $this->bucket . '/' . $objectKey];
}
return ['success' => false, 'message' => 'S3 DELETE failed (HTTP ' . $code . '): ' . substr((string) $response, 0, 300)];
} catch (\Throwable $e) {
return ['success' => false, 'message' => 'S3 delete failed: ' . $e->getMessage()];
}
}
public function testConnection(): array
{
if (empty($this->accessKey) || empty($this->secretKey) || empty($this->bucket)) {
@@ -100,6 +100,40 @@ class SftpUploader implements RemoteUploaderInterface
}
}
public function delete(string $remoteName): array
{
if (empty($this->host) || empty($this->username)) {
return ['success' => false, 'message' => 'SFTP is not configured'];
}
$keyFile = null;
try {
if (!empty($this->keyData)) {
$keyFile = $this->writeTempKey();
}
/* rm -f exits 0 even when the file is already gone, so an
already-deleted remote archive is treated as success. */
$remoteFile = $this->remotePath . '/' . $remoteName;
$cmd = $this->buildSshCommand('rm -f ' . escapeshellarg($remoteFile), $keyFile);
$output = [];
$exitCode = 0;
exec($cmd . ' 2>&1', $output, $exitCode);
if ($exitCode !== 0) {
return ['success' => false, 'message' => 'SFTP delete failed: ' . implode(' ', $output)];
}
return ['success' => true, 'message' => 'Deleted from SFTP: ' . $remoteFile];
} catch (\Throwable $e) {
return ['success' => false, 'message' => 'SFTP delete failed: ' . $e->getMessage()];
} finally {
$this->cleanupTempKey($keyFile);
}
}
public function testConnection(): array
{
if (empty($this->host)) {
@@ -0,0 +1,285 @@
<?php
/**
* @package MokoSuiteBackup
* @subpackage com_mokosuitebackup
* @author Moko Consulting <hello@mokoconsulting.tech>
* @copyright Copyright (C) 2026 Moko Consulting. All rights reserved.
* @license GNU General Public License version 3 or later; see LICENSE
*
* Portable snapshot transfer format (.msbsnap).
*
* A .msbsnap is a zip containing:
* - manifest.json — format/version, generator, source (host/Joomla/prefix),
* content summary, and a sha256 of the payload.
* - snapshot.json — the snapshot's content data (verbatim, same shape the
* snapshot engine writes: {version, content_types, tables}).
*
* package() builds a .msbsnap for an existing snapshot record (for download).
* ingestZip() validates an uploaded .msbsnap and materialises a local snapshot
* record from it (so the normal restore UX can act on it).
* ingestData() materialises a record from an already-parsed data array (used by
* the master→slave injection API, which receives the payload inline).
*/
namespace Joomla\Component\MokoSuiteBackup\Administrator\Engine;
defined('_JEXEC') or die;
use Joomla\CMS\Factory;
use Joomla\CMS\Uri\Uri;
use Joomla\Component\MokoSuiteBackup\Administrator\Utility\BackupDirectory;
final class SnapshotPortable
{
public const FORMAT = 'msbsnap';
public const FORMAT_VERSION = 1;
public const MANIFEST_NAME = 'manifest.json';
public const PAYLOAD_NAME = 'snapshot.json';
/**
* Build a portable .msbsnap zip for a snapshot record.
*
* @param object $snapshot Row from #__mokosuitebackup_snapshots (needs
* data_file, description, content_types, *_count)
*
* @return string Absolute path to a temp .msbsnap file (caller unlinks it)
*
* @throws \RuntimeException
*/
public static function package(object $snapshot): string
{
$dataFile = (string) ($snapshot->data_file ?? '');
if ($dataFile === '' || !is_file($dataFile) || !is_readable($dataFile)) {
throw new \RuntimeException('Snapshot data file is missing or unreadable.');
}
$payload = file_get_contents($dataFile);
if ($payload === false) {
throw new \RuntimeException('Could not read snapshot data file.');
}
$manifest = [
'format' => self::FORMAT,
'format_version' => self::FORMAT_VERSION,
'generator' => 'MokoSuiteBackup',
'created' => Factory::getDate()->toISO8601(),
'source' => [
'host' => self::siteHost(),
'joomla_version' => JVERSION,
'db_prefix' => Factory::getDbo()->getPrefix(),
],
'snapshot' => [
'description' => (string) ($snapshot->description ?? ''),
'content_types' => json_decode((string) ($snapshot->content_types ?? '[]'), true) ?: [],
'articles_count' => (int) ($snapshot->articles_count ?? 0),
'categories_count' => (int) ($snapshot->categories_count ?? 0),
'modules_count' => (int) ($snapshot->modules_count ?? 0),
'created' => (string) ($snapshot->created ?? ''),
],
'payload' => [
'file' => self::PAYLOAD_NAME,
'sha256' => hash('sha256', $payload),
'size' => strlen($payload),
],
];
$tmp = tempnam(sys_get_temp_dir(), 'msbsnap_');
if ($tmp === false) {
throw new \RuntimeException('Could not create a temporary file.');
}
$zip = new \ZipArchive();
if ($zip->open($tmp, \ZipArchive::OVERWRITE) !== true) {
@unlink($tmp);
throw new \RuntimeException('Could not create the .msbsnap archive.');
}
$zip->addFromString(self::MANIFEST_NAME, json_encode($manifest, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
$zip->addFromString(self::PAYLOAD_NAME, $payload);
$zip->close();
return $tmp;
}
/**
* A friendly download filename for a snapshot's portable file.
*/
public static function filename(object $snapshot): string
{
$id = (int) ($snapshot->id ?? 0);
$date = date('Ymd_His');
return 'snapshot-' . $id . '-' . $date . '.msbsnap';
}
/**
* Ingest an uploaded .msbsnap file: validate it and materialise a local
* snapshot record so the normal restore UX can act on it.
*
* @return array{success:bool,message:string,id?:int,warnings?:array}
*/
public static function ingestZip(string $zipPath, string $descriptionPrefix = 'Imported'): array
{
if (!is_file($zipPath) || !is_readable($zipPath)) {
return ['success' => false, 'message' => 'Uploaded file is missing or unreadable.'];
}
$zip = new \ZipArchive();
if ($zip->open($zipPath) !== true) {
return ['success' => false, 'message' => 'Not a valid .msbsnap archive.'];
}
try {
$manifestRaw = $zip->getFromName(self::MANIFEST_NAME);
$payloadRaw = $zip->getFromName(self::PAYLOAD_NAME);
} finally {
$zip->close();
}
if ($manifestRaw === false || $payloadRaw === false) {
return ['success' => false, 'message' => 'Archive is missing its manifest or payload.'];
}
$manifest = json_decode($manifestRaw, true);
if (!is_array($manifest) || ($manifest['format'] ?? '') !== self::FORMAT) {
return ['success' => false, 'message' => 'Unrecognised snapshot file format.'];
}
if ((int) ($manifest['format_version'] ?? 0) > self::FORMAT_VERSION) {
return ['success' => false, 'message' => 'This snapshot file was made by a newer version of MokoSuiteBackup.'];
}
$expected = (string) ($manifest['payload']['sha256'] ?? '');
if ($expected !== '' && !hash_equals($expected, hash('sha256', $payloadRaw))) {
return ['success' => false, 'message' => 'Snapshot payload failed its integrity (checksum) check.'];
}
$data = json_decode($payloadRaw, true);
if (!self::isValidData($data)) {
return ['success' => false, 'message' => 'Snapshot payload is not valid content data.'];
}
$warnings = self::compatWarnings($manifest);
$srcHost = (string) ($manifest['source']['host'] ?? '');
$srcDesc = (string) ($manifest['snapshot']['description'] ?? '');
$descr = trim($descriptionPrefix . ': ' . ($srcDesc !== '' ? $srcDesc : 'snapshot')
. ($srcHost !== '' ? ' (from ' . $srcHost . ')' : ''));
$result = self::ingestData($data, $descr);
if (!empty($warnings) && !empty($result['success'])) {
$result['warnings'] = array_merge($result['warnings'] ?? [], $warnings);
}
return $result;
}
/**
* Materialise a snapshot record from an already-parsed data array.
* Used by the injection API (payload arrives inline, not as a zip).
*
* @return array{success:bool,message:string,id?:int,warnings?:array}
*/
public static function ingestData(array $data, string $description): array
{
if (!self::isValidData($data)) {
return ['success' => false, 'message' => 'Snapshot data is invalid or empty.'];
}
try {
$backupDir = BackupDirectory::getDefaultAbsolute();
BackupDirectory::ensureReady($backupDir);
$filename = 'snapshot_' . date('Ymd_His') . '_imported.json';
$filePath = $backupDir . '/' . $filename;
$json = json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
if ($json === false || file_put_contents($filePath, $json) === false) {
return ['success' => false, 'message' => 'Could not write the imported snapshot file.'];
}
$tables = $data['tables'] ?? [];
$db = Factory::getDbo();
$record = (object) [
'description' => $description !== '' ? $description : 'Imported snapshot',
'content_types' => json_encode(array_values($data['content_types'] ?? [])),
'status' => 'complete',
'articles_count' => count($tables['#__content'] ?? []),
'categories_count' => count($tables['#__categories'] ?? []),
'modules_count' => count($tables['#__modules'] ?? []),
'data_file' => $filePath,
'data_size' => strlen($json),
'log' => 'Imported ' . Factory::getDate()->toSql(),
'created' => Factory::getDate()->toSql(),
'created_by' => (int) (Factory::getApplication()->getIdentity()->id ?? 0),
];
$db->insertObject('#__mokosuitebackup_snapshots', $record, 'id');
return [
'success' => true,
'message' => 'Snapshot imported (record #' . (int) $record->id . ').',
'id' => (int) $record->id,
'warnings' => [],
];
} catch (\Throwable $e) {
return ['success' => false, 'message' => 'Import failed: ' . $e->getMessage()];
}
}
/**
* Structural check for a snapshot data payload.
*/
private static function isValidData($data): bool
{
return is_array($data)
&& isset($data['tables']) && is_array($data['tables'])
&& isset($data['content_types']) && is_array($data['content_types']);
}
/**
* Best-effort compatibility warnings (non-blocking).
*
* @return string[]
*/
private static function compatWarnings(array $manifest): array
{
$warnings = [];
$srcJoomla = (string) ($manifest['source']['joomla_version'] ?? '');
$srcMajor = $srcJoomla !== '' ? (int) explode('.', $srcJoomla)[0] : 0;
$thisMajor = (int) explode('.', JVERSION)[0];
if ($srcMajor > 0 && $srcMajor !== $thisMajor) {
$warnings[] = 'Snapshot was created on Joomla ' . $srcJoomla . ' but this site is Joomla ' . JVERSION
. ' — content tables may differ; review after restoring.';
}
return $warnings;
}
/**
* The current site's host, for the manifest (best-effort, informational).
*/
private static function siteHost(): string
{
try {
$host = Uri::getInstance(Uri::root())->getHost();
} catch (\Throwable $e) {
$host = '';
}
return $host !== '' ? $host : (string) (Factory::getApplication()->get('sitename', 'site'));
}
}
@@ -59,7 +59,9 @@ class SnapshotRestoreEngine
$this->log('WARNING: Could not increase memory limit to 512M');
}
if (!in_array($mode, ['replace', 'merge'])) {
$mode = $this->normaliseMode($mode);
if (!in_array($mode, ['replace', 'merge', 'create', 'duplicate'], true)) {
return ['success' => false, 'message' => 'Invalid restore mode: ' . $mode];
}
@@ -123,12 +125,27 @@ class SnapshotRestoreEngine
$prefix = $db->getPrefix();
$totalRows = 0;
// Build list of tables to restore based on selected types
$tablesToRestore = $this->getTablesToRestore($restoreTypes);
/* Duplicate mode inserts brand-new records through Joomla's Table API,
whose Nested tables (categories, tags) issue LOCK TABLES — which
implicitly COMMITS any open transaction in MySQL/InnoDB. Wrapping it
in transactionStart()/Rollback() would be a false atomicity promise:
the first category/tag store would commit and defeat the rollback.
Duplicate mode is therefore best-effort and per-item defensive (a bad
item is skipped and logged, never fatal) rather than all-or-nothing.
The raw-DB modes (replace/create/merge) remain fully transactional. */
$useTransaction = ($mode !== 'duplicate');
try {
$db->transactionStart();
// Build list of tables to restore based on selected types
$tablesToRestore = $this->getTablesToRestore($restoreTypes);
if ($useTransaction) {
$db->transactionStart();
}
if ($mode === 'duplicate') {
$totalRows = $this->restoreDuplicate($data, $restoreTypes);
} else {
foreach ($tablesToRestore as $abstractTable) {
if (!isset($data['tables'][$abstractTable])) {
$this->log(' Skipping ' . $abstractTable . ' (not in snapshot)');
@@ -140,6 +157,8 @@ class SnapshotRestoreEngine
if ($mode === 'replace') {
$rowCount = $this->restoreReplace($db, $realTable, $abstractTable, $rows);
} elseif ($mode === 'create') {
$rowCount = $this->restoreCreate($db, $realTable, $abstractTable, $rows);
} else {
$rowCount = $this->restoreMerge($db, $realTable, $abstractTable, $rows);
}
@@ -147,8 +166,11 @@ class SnapshotRestoreEngine
$totalRows += $rowCount;
$this->log(' ' . $abstractTable . ': ' . $rowCount . ' rows restored');
}
}
$db->transactionCommit();
if ($useTransaction) {
$db->transactionCommit();
}
$this->log('Restore complete: ' . $totalRows . ' total rows');
@@ -180,11 +202,15 @@ class SnapshotRestoreEngine
'log' => implode("\n", $this->log),
];
} catch (\Throwable $e) {
try {
$db->transactionRollback();
$this->log('Transaction rolled back');
} catch (\Exception $rollbackEx) {
$this->log('Rollback failed: ' . $rollbackEx->getMessage());
if ($useTransaction) {
try {
$db->transactionRollback();
$this->log('Transaction rolled back');
} catch (\Exception $rollbackEx) {
$this->log('Rollback failed: ' . $rollbackEx->getMessage());
}
} else {
$this->log('Duplicate mode is not transactional; records already inserted are left in place.');
}
$this->log('FATAL: ' . $e->getMessage());
@@ -264,6 +290,340 @@ class SnapshotRestoreEngine
return $count;
}
/**
* Create mode: insert only rows that don't already exist; never overwrite.
* Non-destructive — existing content on the target is left untouched. Used
* by master→slave injection when the master must not clobber local edits.
*/
private function restoreCreate(object $db, string $realTable, string $abstractTable, array $rows): int
{
$pk = self::PRIMARY_KEYS[$abstractTable] ?? null;
$count = 0;
foreach ($rows as $row) {
$obj = (object) $row;
if ($pk !== null && isset($row[$pk])) {
$exists = $db->setQuery(
$db->getQuery(true)
->select('COUNT(*)')
->from($db->quoteName($realTable))
->where($db->quoteName($pk) . ' = ' . $db->quote($row[$pk]))
)->loadResult();
if ($exists) {
continue;
}
$db->insertObject($realTable, $obj);
} else {
// Composite-key tables: insert, skip genuine duplicates.
try {
$db->insertObject($realTable, $obj);
} catch (\Exception $e) {
if (str_contains($e->getMessage(), 'Duplicate entry') || $e->getCode() === 1062) {
continue;
}
throw $e;
}
}
$count++;
}
return $count;
}
/**
* Normalise external mode names to the engine's internal modes.
* overwrite→replace, skip/new→create, copy→duplicate; passthrough otherwise.
*/
private function normaliseMode(string $mode): string
{
$map = [
'overwrite' => 'replace',
'replace' => 'replace',
'update' => 'merge',
'merge' => 'merge',
'skip' => 'create',
'new' => 'create',
'create' => 'create',
'copy' => 'duplicate',
'duplicate' => 'duplicate',
];
return $map[strtolower(trim($mode))] ?? strtolower(trim($mode));
}
/**
* Duplicate mode: insert snapshot content as BRAND-NEW records (new IDs),
* leaving existing content untouched. Uses Joomla's Table API so assets,
* UCM entries, category/tag nested-sets and alias uniqueness are handled by
* core. Every item is wrapped in try/catch — a bad item is skipped + logged,
* never fatal — so a partial import degrades gracefully rather than corrupting.
*
* Known limits: workflow stage is left to the article table's default;
* references to content NOT included in the snapshot keep their original IDs.
*
* @return int Number of new records created
*/
private function restoreDuplicate(array $data, array $types): int
{
$app = Factory::getApplication();
$db = Factory::getDbo();
$tables = $data['tables'] ?? [];
$count = 0;
$catMap = [];
$articleMap = [];
$moduleMap = [];
// --- Categories (parents before children so the remap resolves) ---
if (in_array('categories', $types, true) && !empty($tables['#__categories'])) {
$factory = $app->bootComponent('com_categories')->getMVCFactory();
$cats = $tables['#__categories'];
usort($cats, static fn ($a, $b) => ((int) ($a['level'] ?? 0)) <=> ((int) ($b['level'] ?? 0)));
foreach ($cats as $row) {
$oldId = (int) ($row['id'] ?? 0);
$oldParent = (int) ($row['parent_id'] ?? 1);
$newParent = $catMap[$oldParent] ?? ($oldParent > 1 ? $oldParent : 1);
unset($row['id'], $row['asset_id'], $row['lft'], $row['rgt'], $row['level'], $row['path']);
$row['extension'] = 'com_content';
$row['parent_id'] = $newParent;
$row['alias'] = $this->uniqueAlias($db, '#__categories', (string) ($row['alias'] ?? ''), ['extension' => 'com_content']);
try {
$table = $factory->createTable('Category', 'Administrator');
$table->setLocation($newParent, 'last-child');
if ($table->bind($row) && $table->check() && $table->store()) {
$catMap[$oldId] = (int) $table->id;
$count++;
} else {
$this->log(' Category skipped: ' . $table->getError());
}
} catch (\Throwable $e) {
$this->log(' Category "' . ($row['title'] ?? '?') . '" skipped: ' . $e->getMessage());
}
}
}
// --- Articles ---
if (in_array('articles', $types, true) && !empty($tables['#__content'])) {
$factory = $app->bootComponent('com_content')->getMVCFactory();
$featured = [];
foreach ($tables['#__content_frontpage'] ?? [] as $fp) {
$featured[(int) ($fp['content_id'] ?? 0)] = true;
}
$tagTitles = $this->buildArticleTagTitles($tables);
foreach ($tables['#__content'] as $row) {
$oldId = (int) ($row['id'] ?? 0);
$oldCat = (int) ($row['catid'] ?? 0);
unset($row['id'], $row['asset_id']);
if (isset($catMap[$oldCat])) {
$row['catid'] = $catMap[$oldCat];
}
$row['alias'] = $this->uniqueAlias($db, '#__content', (string) ($row['alias'] ?? ''), ['catid' => (int) ($row['catid'] ?? 0)]);
try {
$table = $factory->createTable('Article', 'Administrator');
$tagIds = $this->resolveTagIds($db, $app, $tagTitles[$oldId] ?? []);
if ($tagIds) {
$table->newTags = $tagIds;
}
if ($table->bind($row) && $table->check() && $table->store()) {
$newId = (int) $table->id;
$articleMap[$oldId] = $newId;
$count++;
if (!empty($featured[$oldId])) {
try {
$db->insertObject($db->getPrefix() . 'content_frontpage', (object) ['content_id' => $newId, 'ordering' => 0]);
} catch (\Throwable $e) {
// featured-ordering row is non-critical
}
}
} else {
$this->log(' Article skipped: ' . $table->getError());
}
} catch (\Throwable $e) {
$this->log(' Article "' . ($row['title'] ?? '?') . '" skipped: ' . $e->getMessage());
}
}
// Custom-field values for the duplicated articles.
foreach ($tables['#__fields_values'] ?? [] as $fv) {
$oldItem = (int) ($fv['item_id'] ?? 0);
if (!isset($articleMap[$oldItem])) {
continue;
}
$fv['item_id'] = (string) $articleMap[$oldItem];
try {
$db->insertObject($db->getPrefix() . 'fields_values', (object) $fv);
} catch (\Throwable $e) {
// duplicate/invalid field value — skip
}
}
}
// --- Modules ---
if (in_array('modules', $types, true) && !empty($tables['#__modules'])) {
$factory = $app->bootComponent('com_modules')->getMVCFactory();
foreach ($tables['#__modules'] as $row) {
$oldId = (int) ($row['id'] ?? 0);
unset($row['id'], $row['asset_id']);
try {
$table = $factory->createTable('Module', 'Administrator');
if ($table->bind($row) && $table->check() && $table->store()) {
$moduleMap[$oldId] = (int) $table->id;
$count++;
} else {
$this->log(' Module skipped: ' . $table->getError());
}
} catch (\Throwable $e) {
$this->log(' Module "' . ($row['title'] ?? '?') . '" skipped: ' . $e->getMessage());
}
}
foreach ($tables['#__modules_menu'] ?? [] as $mm) {
$oldMod = (int) ($mm['moduleid'] ?? 0);
if (!isset($moduleMap[$oldMod])) {
continue;
}
try {
$db->insertObject($db->getPrefix() . 'modules_menu', (object) ['moduleid' => $moduleMap[$oldMod], 'menuid' => (int) ($mm['menuid'] ?? 0)]);
} catch (\Throwable $e) {
// duplicate assignment — skip
}
}
}
$this->log('Duplicated ' . $count . ' new records (categories: ' . count($catMap) . ', articles: ' . count($articleMap) . ', modules: ' . count($moduleMap) . ')');
return $count;
}
/**
* Make an alias unique within a scope by appending -2, -3, … if needed.
*/
private function uniqueAlias(object $db, string $abstractTable, string $alias, array $scope): string
{
$alias = $alias !== '' ? $alias : 'item';
$table = str_replace('#__', $db->getPrefix(), $abstractTable);
$base = $alias;
$n = 1;
while (true) {
$query = $db->getQuery(true)
->select('COUNT(*)')
->from($db->quoteName($table))
->where($db->quoteName('alias') . ' = ' . $db->quote($alias));
foreach ($scope as $col => $val) {
$query->where($db->quoteName($col) . ' = ' . $db->quote($val));
}
if ((int) $db->setQuery($query)->loadResult() === 0) {
return $alias;
}
$n++;
$alias = $base . '-' . $n;
if ($n > 100) {
return $base . '-' . substr(md5((string) mt_rand()), 0, 6);
}
}
}
/**
* Map old article id → its tag titles, from the snapshot's tag map + tags.
*
* @return array<int,string[]>
*/
private function buildArticleTagTitles(array $tables): array
{
$tagTitle = [];
foreach ($tables['#__tags'] ?? [] as $tag) {
$tagTitle[(int) ($tag['id'] ?? 0)] = (string) ($tag['title'] ?? '');
}
$byArticle = [];
foreach ($tables['#__contentitem_tag_map'] ?? [] as $map) {
if (strpos((string) ($map['type_alias'] ?? ''), 'com_content.article') !== 0) {
continue;
}
$articleId = (int) ($map['content_item_id'] ?? 0);
$title = $tagTitle[(int) ($map['tag_id'] ?? 0)] ?? '';
if ($articleId && $title !== '') {
$byArticle[$articleId][] = $title;
}
}
return $byArticle;
}
/**
* Resolve tag titles to target tag IDs, creating any that don't exist.
*
* @return int[]
*/
private function resolveTagIds(object $db, object $app, array $titles): array
{
$ids = [];
foreach (array_unique($titles) as $title) {
try {
$existing = $db->setQuery(
$db->getQuery(true)
->select($db->quoteName('id'))
->from($db->quoteName('#__tags'))
->where($db->quoteName('title') . ' = ' . $db->quote($title))
)->loadResult();
if ($existing) {
$ids[] = (int) $existing;
continue;
}
$table = $app->bootComponent('com_tags')->getMVCFactory()->createTable('Tag', 'Administrator');
$table->setLocation(1, 'last-child');
if ($table->bind(['title' => $title, 'alias' => '', 'published' => 1, 'parent_id' => 1])
&& $table->check() && $table->store()) {
$ids[] = (int) $table->id;
}
} catch (\Throwable $e) {
// tag resolution is best-effort
}
}
return $ids;
}
/**
* Delete rows from a table, scoping to relevant content only.
*
@@ -217,6 +217,7 @@ class SteppedBackupEngine
'progress' => 100,
'message' => 'Backup complete: ' . $session->archiveName,
'done' => true,
'record_id' => $session->recordId,
];
}
@@ -228,6 +229,7 @@ class SteppedBackupEngine
'progress' => $session->getProgress(),
'message' => $session->statusMessage,
'done' => $session->phase === 'complete',
'record_id' => $session->recordId,
];
} catch (\Throwable $e) {
$session->log('FATAL: ' . $e->getMessage());
@@ -806,24 +808,7 @@ class SteppedBackupEngine
*/
private function createUploaderFromParams(string $type, array $params): RemoteUploaderInterface
{
$prefixMap = ['ftp' => 'ftp_', 'sftp' => 'sftp_', 's3' => 's3_', 'google_drive' => 'gdrive_'];
$prefix = $prefixMap[$type] ?? '';
$prefixed = [];
foreach ($params as $key => $value) {
$prefixed[$prefix . $key] = $value;
}
$fake = (object) $prefixed;
return match ($type) {
'ftp' => new FtpUploader($fake),
'sftp' => new SftpUploader($fake),
'google_drive' => new GoogleDriveUploader($fake),
's3' => new S3Uploader($fake),
default => throw new \InvalidArgumentException('Unknown remote storage type: ' . $type),
};
return RemoteUploaderFactory::create($type, $params);
}
}
@@ -0,0 +1,89 @@
<?php
/**
* @package MokoSuiteBackup
* @subpackage com_mokosuitebackup
* @author Moko Consulting <hello@mokoconsulting.tech>
* @copyright Copyright (C) 2026 Moko Consulting. All rights reserved.
* @license GNU General Public License version 3 or later; see LICENSE
*/
namespace Joomla\Component\MokoSuiteBackup\Administrator\View\Runbackup;
defined('_JEXEC') or die;
use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\MVC\View\HtmlView as BaseHtmlView;
use Joomla\CMS\Toolbar\ToolbarHelper;
/**
* Full-screen "run a backup" progress view.
*
* Auto-starts the stepped backup (ajax.init → loop ajax.step) and shows a
* full-page progress screen. Used both by the dashboard "Backup Now" action
* and — via the system plugin's pre-update redirect — as the interstitial
* between clicking Joomla's Update and the update actually running. When a
* `returnurl` is supplied the page redirects there once the backup completes
* (e.g. back to `com_joomlaupdate&task=update.install&is_backed_up=1`).
*/
class HtmlView extends BaseHtmlView
{
public int $profileId = 1;
public string $profileTitle = '';
public string $description = '';
/** Raw (possibly base64) return URL from the request; validated in the layout. */
public string $returnUrl = '';
public bool $autostart = true;
public function display($tpl = null): void
{
$input = Factory::getApplication()->getInput();
$this->profileId = (int) $input->getInt('profile_id', $input->getInt('profileid', 1));
$this->description = $input->getString('description', '');
$this->returnUrl = $input->getRaw('returnurl', '');
$this->autostart = (bool) $input->getInt('autostart', 1);
if ($this->profileId <= 0) {
$this->profileId = 1;
}
$this->profileTitle = $this->loadProfileTitle($this->profileId);
$this->addToolbar();
parent::display($tpl);
}
/**
* Look up the target profile's title for display (best-effort).
*/
private function loadProfileTitle(int $profileId): string
{
try {
$db = Factory::getContainer()->get(\Joomla\Database\DatabaseInterface::class);
$query = $db->getQuery(true)
->select($db->quoteName('title'))
->from($db->quoteName('#__mokosuitebackup_profiles'))
->where($db->quoteName('id') . ' = ' . (int) $profileId);
$db->setQuery($query);
return (string) ($db->loadResult() ?? '');
} catch (\Throwable $e) {
return '';
}
}
protected function addToolbar(): void
{
ToolbarHelper::title(
Text::_('COM_MOKOJOOMBACKUP_SHORT') . ': ' . Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_TITLE'),
'archive'
);
}
}
@@ -17,6 +17,9 @@ use Joomla\CMS\Session\Session;
$ajaxToken = Session::getFormToken();
$ajaxUrl = Route::_('index.php?option=com_mokosuitebackup&format=json', false);
$runbackupUrl = Route::_('index.php?option=com_mokosuitebackup&view=runbackup&autostart=1', false);
$liveSite = trim((string) \Joomla\CMS\Factory::getApplication()->get('live_site', ''));
?>
<?php if ($this->defaultDirWarning) : ?>
<div class="alert alert-warning d-flex align-items-center mb-3" role="alert">
@@ -31,6 +34,16 @@ $ajaxUrl = Route::_('index.php?option=com_mokosuitebackup&format=json', false)
</div>
<?php endif; ?>
<?php if ($liveSite === '') : ?>
<div class="alert alert-warning d-flex align-items-center mb-3" role="alert">
<span class="icon-warning-circle fs-4 me-3" aria-hidden="true"></span>
<div>
<strong><?php echo Text::_('COM_MOKOJOOMBACKUP_DASHBOARD_LIVESITE_WARNING_TITLE'); ?></strong><br>
<?php echo Text::_('COM_MOKOJOOMBACKUP_DASHBOARD_LIVESITE_WARNING'); ?>
</div>
</div>
<?php endif; ?>
<div class="row">
<!-- Row 1: Status Cards (clickable) -->
<div class="col-md-3 mb-3">
@@ -244,7 +257,7 @@ document.querySelectorAll('.mb-tile').forEach(function(tile) {
</option>
<?php endforeach; ?>
</select>
<button type="button" class="btn btn-primary w-100" onclick="window.mokosuitebackupStart()">
<button type="button" class="btn btn-primary w-100" onclick="mokosuitebackupGo()">
<span class="icon-download" aria-hidden="true"></span>
<?php echo Text::_('COM_MOKOJOOMBACKUP_TOOLBAR_BACKUP_NOW'); ?>
</button>
@@ -302,123 +315,18 @@ document.querySelectorAll('.mb-tile').forEach(function(tile) {
</div>
</div>
<!-- Stepped Backup Modal (reused from backups view) -->
<div id="mokosuitebackup-modal" style="display:none; position:fixed; top:0; left:0; width:100%; height:100%; background:rgba(0,0,0,0.6); z-index:10000;">
<div style="max-width:500px; margin:10% auto; background:#fff; border-radius:8px; padding:2rem; box-shadow:0 4px 20px rgba(0,0,0,0.3);">
<h3 id="mb-modal-title" style="margin:0 0 1rem;">Backup in Progress</h3>
<div class="alert alert-warning py-1 px-2 mb-2" style="font-size:0.85rem;">
<span class="icon-warning-circle" aria-hidden="true"></span>
<strong>Do not navigate away or close this window</strong> while the backup is running.
</div>
<div style="background:#e9ecef; border-radius:4px; overflow:hidden; height:24px; margin-bottom:0.5rem;">
<div id="mb-progress-bar" style="height:100%; background:#0d6efd; transition:width 0.3s; width:0%; display:flex; align-items:center; justify-content:center; color:#fff; font-size:0.8rem; font-weight:bold;">0%</div>
</div>
<p id="mb-status" style="color:#666; font-size:0.9rem; margin:0.5rem 0;">Initializing...</p>
<p id="mb-phase" style="color:#999; font-size:0.8rem; margin:0;">Phase: init</p>
</div>
</div>
<script>
(function() {
const AJAX_URL = <?php echo json_encode($ajaxUrl); ?>;
const TOKEN_NAME = <?php echo json_encode($ajaxToken); ?>;
/* "Backup Now" navigates to the full-screen backup progress page (view=runbackup)
for the selected profile — the same screen used for the pre-update backup. */
(function () {
'use strict';
var backupRunning = false;
var RUNBACKUP_URL = <?php echo json_encode($runbackupUrl); ?>;
window.addEventListener('beforeunload', function(e) {
if (backupRunning) { e.preventDefault(); e.returnValue = ''; }
});
function showModal() {
backupRunning = true;
document.getElementById('mokosuitebackup-modal').style.display = 'block';
}
function hideModal() {
backupRunning = false;
document.getElementById('mokosuitebackup-modal').style.display = 'none';
}
function updateProgress(progress, message, phase) {
const bar = document.getElementById('mb-progress-bar');
bar.style.width = progress + '%';
bar.textContent = progress + '%';
document.getElementById('mb-status').textContent = message;
document.getElementById('mb-phase').textContent = 'Phase: ' + phase;
}
async function postAjax(params) {
const form = new URLSearchParams();
form.append(TOKEN_NAME, '1');
for (const [k, v] of Object.entries(params)) {
form.append(k, v);
}
const res = await fetch(AJAX_URL, {
method: 'POST',
body: form,
headers: { 'X-Requested-With': 'XMLHttpRequest' }
});
return res.json();
}
async function startSteppedBackup() {
const profileSelect = document.getElementById('mb-profile-select');
const profileId = profileSelect ? profileSelect.value : '1';
showModal();
updateProgress(0, 'Initializing backup...', 'init');
try {
const initResult = await postAjax({
task: 'ajax.init',
profile_id: profileId
});
if (initResult.error) {
updateProgress(0, 'ERROR: ' + initResult.message, 'failed');
setTimeout(hideModal, 5000);
return;
}
// Show preflight warnings if any
if (initResult.warnings && initResult.warnings.length > 0) {
var warningEl = document.getElementById('mb-phase');
warningEl.textContent = 'Warnings: ' + initResult.warnings.join('; ');
warningEl.style.color = '#856404';
}
const sessionId = initResult.session_id;
updateProgress(initResult.progress, initResult.message, initResult.phase);
let done = false;
while (!done) {
const stepResult = await postAjax({
task: 'ajax.step',
session_id: sessionId
});
if (stepResult.error) {
updateProgress(0, 'ERROR: ' + stepResult.message, 'failed');
setTimeout(hideModal, 5000);
return;
}
updateProgress(stepResult.progress, stepResult.message, stepResult.phase);
done = stepResult.done || false;
}
document.getElementById('mb-modal-title').textContent = 'Backup Complete';
setTimeout(function() {
hideModal();
location.reload();
}, 2000);
} catch (err) {
updateProgress(0, 'ERROR: ' + err.message, 'failed');
setTimeout(hideModal, 5000);
}
}
window.mokosuitebackupStart = startSteppedBackup;
window.mokosuitebackupGo = function () {
var sel = document.getElementById('mb-profile-select');
var pid = sel ? sel.value : '1';
window.location.href = RUNBACKUP_URL + '&profile_id=' + encodeURIComponent(pid);
};
})();
</script>
@@ -0,0 +1,329 @@
<?php
/**
* @package MokoSuiteBackup
* @subpackage com_mokosuitebackup
* @author Moko Consulting <hello@mokoconsulting.tech>
* @copyright Copyright (C) 2026 Moko Consulting. All rights reserved.
* @license GNU General Public License version 3 or later; see LICENSE
*
* Full-screen backup progress screen. Reuses the stepped-backup AJAX
* (ajax.init → loop ajax.step). On completion, redirects to a validated
* return URL (pre-update flow) or shows a completion panel (Backup Now).
*/
defined('_JEXEC') or die;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Router\Route;
use Joomla\CMS\Session\Session;
use Joomla\CMS\Uri\Uri;
$ajaxToken = Session::getFormToken();
$ajaxUrl = Route::_('index.php?option=com_mokosuitebackup&format=json', false);
/* Validate the return URL to prevent an open redirect / javascript: XSS
(the value ends up in window.location.href). Accept ONLY:
- an absolute http(s) URL whose host matches this site, or
- a root-relative path starting with a single "/" (not "//").
This rejects javascript:, data:, vbscript: (empty host) and
protocol-relative //evil.com. Falls back to '' (no redirect). */
$safeReturnUrl = '';
if ($this->returnUrl !== '') {
$decoded = base64_decode($this->returnUrl, true);
$raw = ($decoded !== false && $decoded !== '') ? $decoded : $this->returnUrl;
/* Reject any backslash or control char outright: legitimate Joomla admin
return URLs never contain them, and a browser normalises a leading "/\"
to "//", turning a would-be root-relative path into a protocol-relative
open redirect (e.g. "/\evil.com" → "//evil.com"). */
if (preg_match('/[\x00-\x1f\x7f\\\\]/', $raw)) {
$raw = '';
}
$isAbsoluteHttp = (bool) preg_match('#^https?://#i', $raw);
$isRootRelative = isset($raw[0]) && $raw[0] === '/' && (!isset($raw[1]) || $raw[1] !== '/');
if ($isAbsoluteHttp || $isRootRelative) {
try {
$rootHost = Uri::getInstance(Uri::root())->getHost();
$target = new Uri($raw);
$scheme = strtolower((string) $target->getScheme());
$schemeOk = $scheme === '' || $scheme === 'http' || $scheme === 'https';
$hostOk = $target->getHost() === '' || strcasecmp($target->getHost(), $rootHost) === 0;
if ($schemeOk && $hostOk) {
$safeReturnUrl = $raw;
}
} catch (\Throwable $e) {
$safeReturnUrl = '';
}
}
}
$dashboardUrl = Route::_('index.php?option=com_mokosuitebackup&view=dashboard', false);
$config = [
'ajaxUrl' => $ajaxUrl,
'token' => $ajaxToken,
'profileId' => $this->profileId,
'description' => $this->description,
'returnUrl' => $safeReturnUrl,
'dashboardUrl' => $dashboardUrl,
'recordUrl' => Route::_('index.php?option=com_mokosuitebackup&view=backup&id=__MSBID__', false),
'autostart' => $this->autostart,
'labels' => [
'starting' => Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_STARTING'),
'running' => Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_RUNNING'),
'complete' => Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_COMPLETE'),
'continuing' => Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_CONTINUING'),
'failed' => Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_FAILED'),
'retry' => Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_RETRY'),
'continue' => Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_CONTINUE_ANYWAY'),
'dashboard' => Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_BACK_TO_DASHBOARD'),
'viewRecord' => Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_VIEW_RECORD'),
'leaveWarn' => Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_LEAVE_WARNING'),
],
];
?>
<style>
/* Colours are pulled from the Atum admin template's own CSS custom
properties so the screen matches whatever theme the site runs, with
Bootstrap and then a literal as progressive fallbacks. */
.msb-runbackup {
--msb-accent: var(--template-link-color, var(--bs-link-color, #2a69b8));
--msb-accent2: var(--template-special-color, var(--msb-accent));
--msb-success: var(--template-success-color, var(--bs-success, #2f7d32));
--msb-danger: var(--template-danger-color, var(--bs-danger, #c52128));
--msb-track: var(--template-bg-light, var(--bs-gray-200, #edf0f5));
padding: 0 1rem;
}
/* overflow:hidden clips the full-bleed bar to the card's rounded corners. */
.msb-runbackup .card { overflow: hidden; }
.msb-rb-progress {
height: 2.5rem;
background: var(--msb-track);
overflow: hidden;
}
.msb-rb-bar {
height: 100%;
width: 0;
display: flex;
align-items: center;
justify-content: center;
color: #fff;
font-weight: 600;
font-size: .95rem;
white-space: nowrap;
background-color: var(--msb-accent);
background-image: linear-gradient(90deg, var(--msb-accent), var(--msb-accent2));
transition: width .35s ease;
}
.msb-rb-bar.is-animated::after {
content: "";
position: absolute;
inset: 0;
background-image: linear-gradient(45deg, rgba(255,255,255,.18) 25%, transparent 25%, transparent 50%, rgba(255,255,255,.18) 50%, rgba(255,255,255,.18) 75%, transparent 75%, transparent);
background-size: 1rem 1rem;
animation: msb-rb-stripes 1s linear infinite;
}
.msb-rb-bar { position: relative; }
.msb-rb-bar.is-success { background-image: none; background-color: var(--msb-success); }
.msb-rb-bar.is-danger { background-image: none; background-color: var(--msb-danger); }
@keyframes msb-rb-stripes { from { background-position: 1rem 0; } to { background-position: 0 0; } }
</style>
<div class="msb-runbackup">
<div class="card shadow-sm">
<div class="card-body p-4 pb-3">
<h1 class="h4 mb-1" id="msb-rb-title">
<span class="icon-archive" aria-hidden="true"></span>
<?php echo Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_TITLE'); ?>
</h1>
<p class="text-muted mb-4" id="msb-rb-subtitle">
<?php echo htmlspecialchars(
$this->profileTitle !== ''
? Text::sprintf('COM_MOKOJOOMBACKUP_RUNBACKUP_PROFILE', $this->profileTitle)
: Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_STARTING'),
ENT_QUOTES,
'UTF-8'
); ?>
</p>
<div id="msb-rb-phase" class="fw-bold mb-1"></div>
<div id="msb-rb-status" class="text-muted small mb-0"><?php echo htmlspecialchars(Text::_('COM_MOKOJOOMBACKUP_RUNBACKUP_STARTING'), ENT_QUOTES, 'UTF-8'); ?></div>
<div id="msb-rb-actions" class="d-none mt-3">
<button type="button" id="msb-rb-retry" class="btn btn-primary d-none"></button>
<a href="#" id="msb-rb-record" class="btn btn-primary d-none"></a>
<a href="#" id="msb-rb-continue" class="btn btn-warning d-none"></a>
<a href="<?php echo $dashboardUrl; ?>" id="msb-rb-dashboard" class="btn btn-secondary d-none"></a>
</div>
</div>
<!-- Full-bleed progress bar, edge-to-edge along the bottom of the card. -->
<div class="msb-rb-progress" role="progressbar" aria-valuemin="0" aria-valuemax="100" aria-valuenow="0">
<div id="msb-rb-bar" class="msb-rb-bar is-animated" style="width:0;">0%</div>
</div>
</div>
</div>
<script>
(function () {
'use strict';
var CFG = <?php echo json_encode($config); ?>;
var L = CFG.labels || {};
var running = false;
var lastRecordId = 0;
var el = {
bar: document.getElementById('msb-rb-bar'),
track: document.querySelector('.msb-rb-progress'),
phase: document.getElementById('msb-rb-phase'),
status: document.getElementById('msb-rb-status'),
title: document.getElementById('msb-rb-title'),
actions: document.getElementById('msb-rb-actions'),
retry: document.getElementById('msb-rb-retry'),
record: document.getElementById('msb-rb-record'),
continue: document.getElementById('msb-rb-continue'),
dashboard: document.getElementById('msb-rb-dashboard')
};
function setBar(pct, striped) {
pct = Math.max(0, Math.min(100, parseInt(pct, 10) || 0));
el.bar.style.width = pct + '%';
el.bar.textContent = pct + '%';
if (el.track) { el.track.setAttribute('aria-valuenow', pct); }
if (!striped) {
el.bar.classList.remove('is-animated');
}
}
function setPhase(t) { el.phase.textContent = t || ''; }
function setStatus(t) { if (t) { el.status.textContent = t; } }
function post(params) {
var body = new URLSearchParams();
body.append(CFG.token, '1');
Object.keys(params).forEach(function (k) { body.append(k, params[k]); });
return fetch(CFG.ajaxUrl, {
method: 'POST',
body: body,
headers: { 'X-Requested-With': 'XMLHttpRequest' }
}).then(function (r) { return r.json(); });
}
function showActions() { el.actions.classList.remove('d-none'); }
function showBtn(node, label, href) {
node.textContent = label;
if (href) { node.setAttribute('href', href); }
node.classList.remove('d-none');
}
async function onComplete() {
el.bar.classList.remove('is-animated');
el.bar.classList.add('is-success');
setBar(100, false);
el.title.textContent = L.complete || 'Backup complete';
/* Arm the pre-action throttles so a following server-side onExtension
Before(Update|Uninstall) backup is skipped (no duplicate backup).
Awaited so it lands before we hand back to the update/uninstall. */
try { await post({ task: 'ajax.preupdateAck' }); } catch (e) {}
if (CFG.returnUrl) {
/* Pre-update / pre-uninstall flow: continue the original action.
No "view record" button here — we're handing back to Joomla. */
setStatus(L.continuing || 'Continuing…');
window.setTimeout(function () { window.location.href = CFG.returnUrl; }, 1200);
} else {
/* Manual "Backup Now": offer to view the record that was just made. */
setStatus(L.complete || 'Backup complete');
showActions();
if (lastRecordId > 0 && CFG.recordUrl) {
showBtn(el.record, L.viewRecord || 'View backup record',
CFG.recordUrl.replace('__MSBID__', String(lastRecordId)));
}
showBtn(el.dashboard, L.dashboard || 'Back to dashboard', CFG.dashboardUrl);
}
}
function onError(message) {
running = false;
el.bar.classList.remove('is-animated');
el.bar.classList.add('is-danger');
el.title.textContent = L.failed || 'Backup failed';
setStatus(message || 'Backup failed');
showActions();
el.retry.textContent = L.retry || 'Retry';
el.retry.classList.remove('d-none');
el.retry.onclick = function () {
el.retry.classList.add('d-none');
el.continue.classList.add('d-none');
el.bar.classList.remove('is-danger');
el.bar.classList.add('is-animated');
run();
};
if (CFG.returnUrl) {
showBtn(el.continue, L.continue || 'Continue without backup', CFG.returnUrl);
}
showBtn(el.dashboard, L.dashboard || 'Back to dashboard', CFG.dashboardUrl);
}
async function run() {
if (running) { return; }
running = true;
el.actions.classList.add('d-none');
setBar(0, true);
setPhase('');
setStatus(L.starting || 'Starting backup…');
try {
var init = await post({ task: 'ajax.init', profile_id: CFG.profileId, description: CFG.description });
if (!init || init.error || !init.session_id) {
throw new Error((init && init.message) || 'Could not start backup');
}
setBar(init.progress, true);
setPhase(init.phase || '');
setStatus(init.message || (L.running || 'Backing up…'));
if (init.record_id) { lastRecordId = init.record_id; }
var done = false;
while (!done) {
var step = await post({ task: 'ajax.step', session_id: init.session_id });
if (!step || step.error) {
throw new Error((step && step.message) || 'Backup step failed');
}
setBar(step.progress, true);
setPhase(step.phase || '');
setStatus(step.message || '');
if (step.record_id) { lastRecordId = step.record_id; }
done = step.done || false;
}
running = false;
await onComplete();
} catch (err) {
onError(err && err.message ? err.message : String(err));
}
}
/* Warn before leaving while a backup is mid-flight. */
window.addEventListener('beforeunload', function (e) {
if (running) { e.preventDefault(); e.returnValue = L.leaveWarn || ''; }
});
if (CFG.autostart) {
document.addEventListener('DOMContentLoaded', run);
}
})();
</script>
@@ -27,6 +27,14 @@ $listDirn = $this->escape($this->state->get('list.direction'));
<div class="row">
<div class="col-md-12">
<div id="j-main-container" class="j-main-container">
<?php if ($canManage) : ?>
<div class="mb-3">
<button type="button" class="btn btn-secondary" data-bs-toggle="modal" data-bs-target="#mb-snapshot-import-modal">
<span class="icon-upload" aria-hidden="true"></span>
<?php echo Text::_('COM_MOKOJOOMBACKUP_SNAPSHOT_IMPORT'); ?>
</button>
</div>
<?php endif; ?>
<?php if (empty($this->items)) : ?>
<div class="alert alert-info">
@@ -112,6 +120,11 @@ $listDirn = $this->escape($this->state->get('list.direction'));
title="<?php echo Text::_('COM_MOKOJOOMBACKUP_SNAPSHOT_RESTORE'); ?>">
<span class="icon-upload"></span>
</button>
<a class="btn btn-sm btn-outline-secondary"
href="<?php echo Route::_('index.php?option=com_mokosuitebackup&task=snapshots.downloadPortable&id=' . (int) $item->id . '&' . Session::getFormToken() . '=1'); ?>"
title="<?php echo Text::_('COM_MOKOJOOMBACKUP_SNAPSHOT_DOWNLOAD'); ?>">
<span class="icon-download"></span>
</a>
<?php endif; ?>
</td>
<td><?php echo (int) $item->id; ?></td>
@@ -131,6 +144,32 @@ $listDirn = $this->escape($this->state->get('list.direction'));
</div>
</form>
<!-- Import Snapshot Modal -->
<div class="modal fade" id="mb-snapshot-import-modal" tabindex="-1" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<form action="<?php echo Route::_('index.php?option=com_mokosuitebackup&task=snapshots.import'); ?>" method="post" enctype="multipart/form-data">
<div class="modal-header">
<h5 class="modal-title"><?php echo Text::_('COM_MOKOJOOMBACKUP_SNAPSHOT_IMPORT'); ?></h5>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="<?php echo Text::_('JCLOSE'); ?>"></button>
</div>
<div class="modal-body">
<p class="text-muted"><?php echo Text::_('COM_MOKOJOOMBACKUP_SNAPSHOT_IMPORT_DESC'); ?></p>
<div class="mb-3">
<label for="msbsnap_file" class="form-label"><?php echo Text::_('COM_MOKOJOOMBACKUP_SNAPSHOT_IMPORT_FILE'); ?></label>
<input type="file" class="form-control" id="msbsnap_file" name="msbsnap_file" accept=".msbsnap,application/zip,application/octet-stream" required>
</div>
</div>
<div class="modal-footer">
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal"><?php echo Text::_('JCANCEL'); ?></button>
<button type="submit" class="btn btn-primary"><?php echo Text::_('COM_MOKOJOOMBACKUP_SNAPSHOT_IMPORT'); ?></button>
</div>
<?php echo HTMLHelper::_('form.token'); ?>
</form>
</div>
</div>
</div>
<!-- Create Snapshot Modal -->
<div class="modal fade" id="mb-snapshot-create-modal" tabindex="-1" aria-hidden="true">
<div class="modal-dialog">
@@ -8,7 +8,7 @@
-->
<extension type="module" client="administrator" method="upgrade">
<name>Module - MokoSuiteBackup - cPanel</name>
<version>02.58.00</version>
<version>02.58.37</version>
<creationDate>2026-06-23</creationDate>
<author>Moko Consulting</author>
<authorEmail>hello@mokoconsulting.tech</authorEmail>
@@ -7,7 +7,7 @@
-->
<extension type="plugin" group="actionlog" method="upgrade">
<name>Action Log - MokoSuiteBackup</name>
<version>02.58.00</version>
<version>02.58.37</version>
<creationDate>2026-06-04</creationDate>
<author>Moko Consulting</author>
<authorEmail>hello@mokoconsulting.tech</authorEmail>
@@ -7,7 +7,7 @@
-->
<extension type="plugin" group="console" method="upgrade">
<name>Console - MokoSuiteBackup</name>
<version>02.58.00</version>
<version>02.58.37</version>
<creationDate>2026-06-04</creationDate>
<author>Moko Consulting</author>
<authorEmail>hello@mokoconsulting.tech</authorEmail>
@@ -7,7 +7,7 @@
-->
<extension type="plugin" group="content" method="upgrade">
<name>Content - MokoSuiteBackup</name>
<version>02.58.00</version>
<version>02.58.37</version>
<creationDate>2026-06-04</creationDate>
<author>Moko Consulting</author>
<authorEmail>hello@mokoconsulting.tech</authorEmail>
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<extension type="plugin" group="quickicon" method="upgrade">
<name>Quick Icon - MokoSuiteBackup</name>
<version>02.58.00</version>
<version>02.58.37</version>
<creationDate>2026-06-02</creationDate>
<author>Moko Consulting</author>
<authorEmail>hello@mokoconsulting.tech</authorEmail>
@@ -7,3 +7,10 @@ PLG_SYSTEM_MOKOJOOMBACKUP_FIELD_MAX_AGE="Max Backup Age (days)"
PLG_SYSTEM_MOKOJOOMBACKUP_FIELD_MAX_AGE_DESC="Delete backup records older than this many days."
PLG_SYSTEM_MOKOJOOMBACKUP_FIELD_MAX_BACKUPS="Max Backup Count"
PLG_SYSTEM_MOKOJOOMBACKUP_FIELD_MAX_BACKUPS_DESC="Keep at most this many completed backup records."
PLG_SYSTEM_MOKOJOOMBACKUP_UPDATE_NOTICE="MokoSuiteBackup: a full-site backup is recommended before you update."
PLG_SYSTEM_MOKOJOOMBACKUP_BACKUP_NOW="Back up now"
PLG_SYSTEM_MOKOJOOMBACKUP_DISMISS="Dismiss"
PLG_SYSTEM_MOKOJOOMBACKUP_BACKING_UP="Backing up…"
PLG_SYSTEM_MOKOJOOMBACKUP_BACKUP_COMPLETE="Backup complete — safe to update."
PLG_SYSTEM_MOKOJOOMBACKUP_BACKUP_FAILED="Backup failed"
PLG_SYSTEM_MOKOJOOMBACKUP_BACKUP_STARTING="Starting backup…"
@@ -7,3 +7,10 @@ PLG_SYSTEM_MOKOJOOMBACKUP_FIELD_MAX_AGE="Max Backup Age (days)"
PLG_SYSTEM_MOKOJOOMBACKUP_FIELD_MAX_AGE_DESC="Delete backup records older than this many days."
PLG_SYSTEM_MOKOJOOMBACKUP_FIELD_MAX_BACKUPS="Max Backup Count"
PLG_SYSTEM_MOKOJOOMBACKUP_FIELD_MAX_BACKUPS_DESC="Keep at most this many completed backup records."
PLG_SYSTEM_MOKOJOOMBACKUP_UPDATE_NOTICE="MokoSuiteBackup: a full-site backup is recommended before you update."
PLG_SYSTEM_MOKOJOOMBACKUP_BACKUP_NOW="Back up now"
PLG_SYSTEM_MOKOJOOMBACKUP_DISMISS="Dismiss"
PLG_SYSTEM_MOKOJOOMBACKUP_BACKING_UP="Backing up…"
PLG_SYSTEM_MOKOJOOMBACKUP_BACKUP_COMPLETE="Backup complete — safe to update."
PLG_SYSTEM_MOKOJOOMBACKUP_BACKUP_FAILED="Backup failed"
PLG_SYSTEM_MOKOJOOMBACKUP_BACKUP_STARTING="Starting backup…"
@@ -0,0 +1,150 @@
/**
* MokoSuiteBackup — full-screen backup before an EXTENSION update / uninstall.
*
* Injected by plg_system_mokosuitebackup on Extensions → Update and
* Extensions → Manage. Joomla 6 renders those toolbar buttons as web
* components (`<button task="update.update">`), NOT inline
* onclick="Joomla.submitbutton(...)", so wrapping Joomla.submitbutton is
* unreliable. Instead we add a CAPTURE-phase click listener on any element
* carrying a matching `task` attribute — it runs before the toolbar web
* component, so we can stop it, run the full-screen backup, and on return
* restore the checked cid[] selection and re-fire the button.
*
* The full-screen page arms the pre-action throttle on success, so the
* server-side onExtensionBefore(Update|Uninstall) backup is then skipped.
*
* Config: Joomla.getOptions('plg_system_mokosuitebackup.installer').
*/
(function () {
'use strict';
var cfg = (window.Joomla && Joomla.getOptions)
? Joomla.getOptions('plg_system_mokosuitebackup.installer', null)
: null;
if (!cfg || !cfg.runbackupUrl) {
return;
}
var STORAGE_KEY = 'msbInstallerBackup';
var TASKS = {};
if (cfg.backupBeforeUpdate) { TASKS['update.update'] = true; }
if (cfg.backupBeforeUninstall) { TASKS['manage.remove'] = true; TASKS['manage.uninstall'] = true; }
function checkedCids() {
var form = document.getElementById('adminForm');
var cids = [];
if (form) {
form.querySelectorAll('input[name="cid[]"]:checked').forEach(function (b) { cids.push(b.value); });
}
return cids;
}
/* Intercept the toolbar Update/Uninstall click in the CAPTURE phase, before
the toolbar web component's own handler runs. */
document.addEventListener('click', function (e) {
if (window.__msbResuming || cfg.recentBackup) {
return;
}
var node = e.target;
var btn = (node && node.closest) ? node.closest('[task]') : null;
if (!btn) {
return;
}
var task = btn.getAttribute('task');
if (!TASKS[task]) {
return;
}
var cids = checkedCids();
/* Nothing selected — let Joomla show its own "please select" notice. */
if (!cids.length) {
return;
}
var ret = window.location.href;
ret += (ret.indexOf('?') === -1 ? '?' : '&') + 'msb_resume=1';
/* Build the redirect BEFORE we swallow the click. btoa() throws on
non-Latin1 input (e.g. a UTF-8 filter value in the query string), so
encode as UTF-8 first; if it still fails, bail WITHOUT preventing the
click so Joomla's own update/uninstall proceeds normally. */
var target;
try {
target = cfg.runbackupUrl
+ '&profile_id=' + encodeURIComponent(cfg.profileId)
+ '&returnurl=' + encodeURIComponent(btoa(unescape(encodeURIComponent(ret))));
} catch (x) {
return;
}
e.preventDefault();
e.stopImmediatePropagation();
try {
sessionStorage.setItem(STORAGE_KEY, JSON.stringify({ task: task, cids: cids }));
} catch (x) {}
window.location.href = target;
}, true);
/* On return from the backup screen: restore the selection and re-fire. */
function resume() {
var params = new URLSearchParams(window.location.search);
if (params.get('msb_resume') !== '1') {
return;
}
var raw = null;
try { raw = sessionStorage.getItem(STORAGE_KEY); sessionStorage.removeItem(STORAGE_KEY); } catch (x) {}
if (!raw) {
return;
}
var data;
try { data = JSON.parse(raw); } catch (x) { data = null; }
if (!data || !data.task) {
return;
}
var form = document.getElementById('adminForm');
if (form) {
(data.cids || []).forEach(function (id) {
var box = form.querySelector('input[name="cid[]"][value="' + id + '"]');
if (box) { box.checked = true; }
});
/* Joomla's list-check reads boxchecked — set it so the re-fire passes. */
var bc = form.querySelector('input[name="boxchecked"]');
if (bc) { bc.value = (data.cids || []).length; }
}
window.__msbResuming = true;
var btn = document.querySelector('[task="' + data.task + '"]');
if (btn) {
window.setTimeout(function () { btn.click(); }, 300);
} else if (window.Joomla && typeof Joomla.submitbutton === 'function') {
Joomla.submitbutton(data.task);
}
}
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', resume);
} else {
resume();
}
})();
@@ -7,7 +7,7 @@
-->
<extension type="plugin" group="system" method="upgrade">
<name>System - MokoSuiteBackup</name>
<version>02.58.00</version>
<version>02.58.37</version>
<creationDate>2026-06-02</creationDate>
<author>Moko Consulting</author>
<authorEmail>hello@mokoconsulting.tech</authorEmail>
@@ -29,6 +29,10 @@
<language tag="en-GB">language/en-GB/plg_system_mokosuitebackup.sys.ini</language>
</languages>
<media destination="plg_system_mokosuitebackup" folder="media">
<folder>js</folder>
</media>
<config>
<fields name="params">
<fieldset name="basic">
@@ -13,8 +13,13 @@ namespace Joomla\Plugin\System\MokoSuiteBackup\Extension;
defined('_JEXEC') or die;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Document\HtmlDocument;
use Joomla\CMS\Factory;
use Joomla\CMS\Plugin\CMSPlugin;
use Joomla\CMS\Router\Route;
use Joomla\CMS\Session\Session;
use Joomla\CMS\Uri\Uri;
use Joomla\Component\MokoSuiteBackup\Administrator\Engine\RetentionManager;
use Joomla\Component\MokoSuiteBackup\Administrator\Service\BackupRunner;
use Joomla\Event\Event;
use Joomla\Event\SubscriberInterface;
@@ -28,6 +33,7 @@ final class MokoSuiteBackup extends CMSPlugin implements SubscriberInterface
return [
'onAfterInitialise' => 'onAfterInitialise',
'onAfterRoute' => 'onAfterRoute',
'onBeforeCompileHead' => 'onBeforeCompileHead',
'onExtensionBeforeUpdate' => 'onExtensionBeforeUpdate',
'onExtensionBeforeUninstall' => 'onExtensionBeforeUninstall',
];
@@ -120,6 +126,10 @@ final class MokoSuiteBackup extends CMSPlugin implements SubscriberInterface
return;
}
// Pre-update: send Joomla core-update installs through the full-screen
// backup page BEFORE the update runs (may not return from here).
$this->maybeRedirectForUpdate();
if (!(int) $this->params->get('auto_cleanup', 1)) {
return;
}
@@ -138,6 +148,227 @@ final class MokoSuiteBackup extends CMSPlugin implements SubscriberInterface
$this->cleanupOldSnapshots();
}
/**
* Inject the client-side interceptor on the Extensions → Update and
* Extensions → Manage pages, so an EXTENSION update / uninstall also runs
* through the full-screen backup page.
*
* Core Joomla updates are handled server-side (see maybeRedirectForUpdate),
* but com_installer's update.update / manage.remove are POST actions with a
* CSRF token and a checked cid[] list — a server-side GET redirect would drop
* the selection and fail the token check. So the JS wraps Joomla.submitbutton,
* stores the selection, sends the browser to view=runbackup, and on return
* restores the selection and re-submits the real POST form.
*/
public function onBeforeCompileHead(Event $event): void
{
$app = $this->getApplication();
if (!$app->isClient('administrator')) {
return;
}
$input = $app->getInput();
// Joomla core update: after the pre-update backup returns to the confirm
// page (layout=update&is_backed_up=1), auto-check Joomla's "I have a
// backup" box and click Install so the update continues seamlessly
// (Akeeba-style) instead of stopping for a second manual click.
if ($input->getCmd('option', '') === 'com_joomlaupdate') {
if ($input->getCmd('layout', '') === 'update'
&& (int) ComponentHelper::getParams('com_mokosuitebackup')->get('backup_before_update', 0)) {
$user = $app->getIdentity();
$doc = $app->getDocument();
if ($user && !$user->guest && $user->authorise('core.admin') && $doc instanceof HtmlDocument) {
$doc->getWebAssetManager()->useScript('core');
$doc->addScriptDeclaration($this->joomlaUpdateAutoContinueScript());
}
}
return;
}
if ($input->getCmd('option', '') !== 'com_installer') {
return;
}
$view = $input->getCmd('view', '');
if ($view !== 'update' && $view !== 'manage') {
return;
}
$params = ComponentHelper::getParams('com_mokosuitebackup');
$beforeUpdate = (int) $params->get('backup_before_update', 0);
$beforeUninst = (int) $params->get('backup_before_uninstall', 0);
// Relevant feature for this view must be on.
$active = ($view === 'update' && $beforeUpdate) || ($view === 'manage' && $beforeUninst);
if (!$active) {
return;
}
// Super Users only.
$user = $app->getIdentity();
if (!$user || $user->guest || !$user->authorise('core.admin')) {
return;
}
$doc = $app->getDocument();
if (!$doc instanceof HtmlDocument) {
return;
}
// Already backed up this session (throttle window)? Then the JS should
// let the action proceed without a fresh backup.
$session = Factory::getSession();
$throttleK = $view === 'update'
? 'mokosuitebackup.preaction_backup_before_update'
: 'mokosuitebackup.preaction_backup_before_uninstall';
$lastRun = (int) $session->get($throttleK, 0);
$recent = $lastRun > 0 && (time() - $lastRun) < 600;
$doc->getWebAssetManager()->useScript('core');
$doc->addScriptOptions('plg_system_mokosuitebackup.installer', [
'runbackupUrl' => Route::_('index.php?option=com_mokosuitebackup&view=runbackup&tmpl=component&autostart=1', false),
'profileId' => (int) $params->get('default_profile', 1),
'backupBeforeUpdate' => $view === 'update' && (bool) $beforeUpdate,
'backupBeforeUninstall' => $view === 'manage' && (bool) $beforeUninst,
'recentBackup' => $recent,
]);
$doc->addScript(Uri::root(true) . '/media/plg_system_mokosuitebackup/js/installer-backup.js', [], ['defer' => true]);
}
/**
* Inline JS for the Joomla Update confirm page. When we return there after
* the pre-update backup (is_backed_up=1), it ticks Joomla's "I have taken a
* backup" checkbox and clicks the Install button (.emptystate-btnadd) so the
* update proceeds automatically — seamless, no second manual click.
*/
private function joomlaUpdateAutoContinueScript(): string
{
return <<<'JS'
(function () {
'use strict';
if (new URLSearchParams(window.location.search).get('is_backed_up') !== '1') { return; }
var go = function () {
var chk = document.getElementById('joomlaupdate-confirm-backup');
var wrap = document.getElementById('joomlaupdate-wrapper');
var btn = (wrap && wrap.querySelector('.emptystate-btnadd')) || document.querySelector('.emptystate-btnadd');
if (chk) { chk.checked = true; chk.dispatchEvent(new Event('change', { bubbles: true })); }
if (btn) { btn.classList.remove('disabled'); window.setTimeout(function () { btn.click(); }, 400); }
};
if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', go); } else { go(); }
})();
JS;
}
/**
* Send a Joomla core update through the full-screen backup page BEFORE the
* update applies (Akeeba-style), so no backup runs synchronously inside the
* update request (which is what white-screened large sites).
*
* Interception point by Joomla version: on Joomla 4/5/6 the "Install the
* update" flow server-side-redirects to the updating page `view=update`,
* which *then* runs the file extraction from JavaScript (an AJAX call to
* com_joomlaupdate/extract.php). So the `view=update` page LOAD is the last
* moment before any files change — we intercept that. (Older releases used
* `task=update.install`.) In onAfterRoute — before com_joomlaupdate renders
* the page — we redirect to view=runbackup with a returnurl back to the same
* page flagged `is_backed_up=1`; the backup runs on its own full-screen page,
* then the browser returns to `view=update`, whose JS extraction then runs.
* On return we arm the throttle so onExtensionBeforeUpdate won't duplicate it.
*
* Note: `update.finalise` is deliberately NOT intercepted — by then the files
* are already extracted, so it is too late for a pre-update backup.
*/
private function maybeRedirectForUpdate(): void
{
$params = ComponentHelper::getParams('com_mokosuitebackup');
if (!(int) $params->get('backup_before_update', 0)) {
return;
}
$app = $this->getApplication();
$input = $app->getInput();
$view = $input->getCmd('view', '');
$task = $input->getCmd('task', '');
$layout = $input->getCmd('layout', '');
// The "Install the update" click posts to option=com_joomlaupdate&
// layout=update — the confirm/updating page, which is where the JS then
// downloads + extracts. (Some flows use view=update; Joomla 3 used
// task=update.install.) Intercept whichever fires — before files change.
if ($input->getCmd('option', '') !== 'com_joomlaupdate'
|| ($layout !== 'update' && $view !== 'update' && $task !== 'update.install')) {
return;
}
$session = Factory::getSession();
// Returned from the backup screen: arm the throttle so the synchronous
// onExtensionBeforeUpdate backup doesn't run again, then let it proceed.
if ((int) $input->getInt('is_backed_up', 0) === 1) {
$session->set('mokosuitebackup.preaction_backup_before_update', time());
return;
}
// Backed up recently already — let the update proceed.
$lastRun = (int) $session->get('mokosuitebackup.preaction_backup_before_update', 0);
if ($lastRun > 0 && (time() - $lastRun) < 600) {
return;
}
// Super Users only.
$user = $app->getIdentity();
if (!$user || $user->guest || !$user->authorise('core.admin')) {
return;
}
$token = Session::getFormToken();
$profileId = (int) $params->get('default_profile', 1);
// Where to send the browser after the backup: back to the same update
// entry point that fired (the updating page, or the legacy install task),
// flagged so this doesn't loop.
$returnUri = new Uri(Uri::base() . 'index.php');
$returnUri->setVar('option', 'com_joomlaupdate');
if ($layout === 'update') {
$returnUri->setVar('layout', 'update');
} elseif ($view === 'update') {
$returnUri->setVar('view', 'update');
} else {
$returnUri->setVar('task', $task);
}
$returnUri->setVar('is_backed_up', '1');
$returnUri->setVar($token, '1');
// The full-screen backup page (chromeless via tmpl=component).
$redirect = new Uri(Uri::base() . 'index.php');
$redirect->setVar('option', 'com_mokosuitebackup');
$redirect->setVar('view', 'runbackup');
$redirect->setVar('tmpl', 'component');
$redirect->setVar('autostart', '1');
$redirect->setVar('profile_id', (string) $profileId);
$redirect->setVar('description', 'Pre-update backup');
$redirect->setVar('returnurl', base64_encode($returnUri->toString()));
$redirect->setVar($token, '1');
$app->redirect($redirect->toString());
}
/**
* Remove backup records and files per profile retention settings.
* Each profile can override the global max_age_days and max_backups.
@@ -241,108 +472,28 @@ final class MokoSuiteBackup extends CMSPlugin implements SubscriberInterface
private function doCleanup(): void
{
$db = Factory::getDbo();
$globalMaxAge = (int) ComponentHelper::getParams('com_mokosuitebackup')->get('max_age_days', 30);
$globalMaxCount = (int) ComponentHelper::getParams('com_mokosuitebackup')->get('max_backups', 10);
$db = Factory::getDbo();
$params = ComponentHelper::getParams('com_mokosuitebackup');
$globalMaxAge = (int) $params->get('max_age_days', 30);
$globalMaxCount = (int) $params->get('max_backups', 10);
// Load all published profiles with their retention settings
// Load all published profiles with their retention settings.
$query = $db->getQuery(true)
->select([$db->quoteName('id'), $db->quoteName('retention_days'), $db->quoteName('retention_count')])
->select($db->quoteName(['id', 'retention_days', 'retention_count']))
->from($db->quoteName('#__mokosuitebackup_profiles'))
->where($db->quoteName('published') . ' = 1');
$db->setQuery($query);
$profiles = $db->loadObjectList();
$profiles = $db->loadObjectList() ?: [];
// Delegate to the single retention authority. RetentionManager prunes by
// age OR count (with these globals as the per-profile fallback) and also
// removes each pruned archive from the profile's remote destinations.
foreach ($profiles as $profile) {
$maxAge = (int) $profile->retention_days > 0 ? (int) $profile->retention_days : $globalMaxAge;
$maxCount = (int) $profile->retention_count > 0 ? (int) $profile->retention_count : $globalMaxCount;
$pid = (int) $profile->id;
// Delete by age for this profile
$cutoff = date('Y-m-d H:i:s', strtotime("-{$maxAge} days"));
$query = $db->getQuery(true)
->select('id, absolute_path')
->from($db->quoteName('#__mokosuitebackup_records'))
->where($db->quoteName('profile_id') . ' = ' . $pid)
->where($db->quoteName('backupstart') . ' < ' . $db->quote($cutoff))
->where($db->quoteName('status') . ' = ' . $db->quote('complete'));
$db->setQuery($query);
$expired = $db->loadObjectList();
foreach ($expired as $record) {
$this->deleteBackupRecord($db, $record);
}
// Enforce max count for this profile (keep newest)
$query = $db->getQuery(true)
->select('COUNT(*)')
->from($db->quoteName('#__mokosuitebackup_records'))
->where($db->quoteName('profile_id') . ' = ' . $pid)
->where($db->quoteName('status') . ' = ' . $db->quote('complete'));
$db->setQuery($query);
$totalCount = (int) $db->loadResult();
if ($totalCount > $maxCount) {
$excess = $totalCount - $maxCount;
$query = $db->getQuery(true)
->select('id, absolute_path')
->from($db->quoteName('#__mokosuitebackup_records'))
->where($db->quoteName('profile_id') . ' = ' . $pid)
->where($db->quoteName('status') . ' = ' . $db->quote('complete'))
->order($db->quoteName('backupstart') . ' ASC');
$db->setQuery($query, 0, $excess);
$oldest = $db->loadObjectList();
foreach ($oldest as $record) {
$this->deleteBackupRecord($db, $record);
}
}
RetentionManager::prune($db, $profile, $globalMaxAge, $globalMaxCount);
}
// Also clean up orphaned records (profile deleted but records remain)
$query = $db->getQuery(true)
->select('r.id, r.absolute_path')
->from($db->quoteName('#__mokosuitebackup_records', 'r'))
->join('LEFT', $db->quoteName('#__mokosuitebackup_profiles', 'p') . ' ON p.id = r.profile_id')
->where('p.id IS NULL')
->where($db->quoteName('r.status') . ' = ' . $db->quote('complete'));
$db->setQuery($query);
$orphans = $db->loadObjectList();
foreach ($orphans as $record) {
$this->deleteBackupRecord($db, $record);
}
}
/**
* Delete a backup record and its archive file.
*/
private function deleteBackupRecord(object $db, object $record): void
{
if (!empty($record->absolute_path) && is_file($record->absolute_path)) {
if (!@unlink($record->absolute_path)) {
error_log('MokoSuiteBackup: Could not delete backup file (id=' . $record->id . '): ' . $record->absolute_path);
return;
}
$logPath = preg_replace('/\.(zip|tar\.gz)$/i', '.log', $record->absolute_path);
if (is_file($logPath)) {
@unlink($logPath);
}
}
try {
$db->setQuery(
$db->getQuery(true)
->delete($db->quoteName('#__mokosuitebackup_records'))
->where($db->quoteName('id') . ' = ' . (int) $record->id)
);
$db->execute();
} catch (\Exception $e) {
error_log('MokoSuiteBackup: Could not delete backup record ' . $record->id . ': ' . $e->getMessage());
}
// Records whose profile was deleted (local files + DB row only).
RetentionManager::pruneOrphans($db);
}
/**
@@ -388,6 +539,16 @@ final class MokoSuiteBackup extends CMSPlugin implements SubscriberInterface
$profileId = (int) $params->get('default_profile', 1);
/* This backup runs synchronously inside the extension update/uninstall
request. Without raising these limits a large site blows past
max_execution_time / memory_limit mid-backup and the update page
white-screens. Mirror the web-cron path. (Core Joomla updates are
handled by the full-screen redirect instead — see onAfterRoute.) */
@set_time_limit(0);
@ini_set('max_execution_time', '0');
@ini_set('memory_limit', '512M');
@ignore_user_abort(true);
try {
$result = (new BackupRunner())->run($profileId, $description, 'preaction');
$app = Factory::getApplication();
@@ -7,7 +7,7 @@
-->
<extension type="plugin" group="task" method="upgrade">
<name>Task - MokoSuiteBackup</name>
<version>02.58.00</version>
<version>02.58.37</version>
<creationDate>2026-06-02</creationDate>
<author>Moko Consulting</author>
<authorEmail>hello@mokoconsulting.tech</authorEmail>
@@ -7,7 +7,7 @@
-->
<extension type="plugin" group="webservices" method="upgrade">
<name>Web Services - MokoSuiteBackup</name>
<version>02.58.00</version>
<version>02.58.37</version>
<creationDate>2026-06-02</creationDate>
<author>Moko Consulting</author>
<authorEmail>hello@mokoconsulting.tech</authorEmail>
@@ -137,6 +137,17 @@ final class MokoSuiteBackupWebServices extends CMSPlugin implements SubscriberIn
)
);
// Inject a snapshot payload directly — master → slave (POST)
$router->addRoute(
new Route(
['POST'],
'v1/mokosuitebackup/snapshot/inject',
'snapshots.inject',
[],
$defaults
)
);
// Delete a snapshot (DELETE)
$router->addRoute(
new Route(
+1 -1
View File
@@ -8,7 +8,7 @@
<extension type="package" method="upgrade">
<name>Package - MokoSuiteBackup</name>
<packagename>mokosuitebackup</packagename>
<version>02.58.00</version>
<version>02.58.37</version>
<creationDate>2026-06-02</creationDate>
<author>Moko Consulting</author>
<authorEmail>hello@mokoconsulting.tech</authorEmail>
+156
View File
@@ -188,6 +188,35 @@ class Pkg_MokoSuiteBackupInstallerScript
PREPARE/EXECUTE migration that MySQL 8 rejected in Joomla's installer). */
$this->dropLegacyRemoteColumns();
/* Honesty gate: Joomla logs a failed child extension but still runs the
package postflight, so verify every bundled child actually registered
before claiming success. If any are missing, say so and do NOT print the
success / next-steps messages. (All housekeeping above runs regardless.)
Fail-open — a manifest/DB glitch returns no missing children. */
$problems = $this->findMissingPackageChildren($parent);
foreach ($this->findMissingComponentTables() as $table) {
$problems[] = 'table ' . $table;
}
if (!empty($problems)) {
$safe = array_map(
static fn($m) => htmlspecialchars($m, ENT_QUOTES, 'UTF-8'),
$problems
);
$detail = count($safe) > 3
? count($safe) . ' bundled extensions/tables are missing'
: 'missing: ' . implode(', ', $safe);
Factory::getApplication()->enqueueMessage(
'<strong>MokoSuiteBackup did not install correctly</strong> — ' . $detail
. '. Review the installation log and re-install.',
'error'
);
return;
}
/* Install completion notice (install and update) */
$this->installSuccessful();
@@ -208,6 +237,133 @@ class Pkg_MokoSuiteBackupInstallerScript
}
}
/**
* Verify every bundled child extension declared in the package manifest
* actually registered in #__extensions. Joomla logs a failed child but does
* not fail the package, so this answers "did the package really install?"
* honestly. Returns human-readable labels for any missing children (empty =
* all present). Matching mirrors extension uniqueness: element + type, and
* for plugins also folder (group), since plugins are only unique that way.
*
* Fail-open: any manifest/DB error returns [] so a transient glitch can never
* turn a good install into a false failure.
*
* @param InstallerAdapter $parent Package installer adapter
*
* @return string[] Labels of missing children (empty when everything installed)
*/
private function findMissingPackageChildren(InstallerAdapter $parent): array
{
try {
$manifest = $parent->getParent()->getManifest();
if (!$manifest instanceof \SimpleXMLElement
|| !isset($manifest->files) || !isset($manifest->files->file)) {
return [];
}
$db = Factory::getContainer()->get(\Joomla\Database\DatabaseInterface::class);
$missing = [];
foreach ($manifest->files->file as $file) {
$attrs = $file->attributes();
$element = isset($attrs['id']) ? (string) $attrs['id'] : '';
$extType = isset($attrs['type']) ? (string) $attrs['type'] : '';
if ($element === '' || $extType === '') {
continue;
}
$query = $db->getQuery(true)
->select('COUNT(*)')
->from($db->quoteName('#__extensions'))
->where($db->quoteName('element') . ' = ' . $db->quote($element))
->where($db->quoteName('type') . ' = ' . $db->quote($extType));
$group = '';
/* Plugins are only unique by element + folder (group). */
if ($extType === 'plugin' && isset($attrs['group'])) {
$group = (string) $attrs['group'];
if ($group !== '') {
$query->where($db->quoteName('folder') . ' = ' . $db->quote($group));
}
}
$db->setQuery($query);
if ((int) $db->loadResult() === 0) {
$label = $extType . ' "' . $element . '"';
if ($group !== '') {
$label .= ' (' . $group . ')';
}
$missing[] = $label;
}
}
return $missing;
} catch (\Throwable $e) {
return [];
}
}
/**
* Verify the component's schema actually installed. The component has no
* installer script of its own, so this package postflight is the only place
* to catch a component whose extension row exists but whose CREATE TABLE
* statements failed (e.g. an installer-rejected migration). Reads the
* *installed* install SQL, extracts every declared table, and confirms each
* exists. Table names are derived dynamically — nothing is hard-coded.
*
* Fail-open: any IO/DB/parse error returns [] so a glitch can't fail a good
* install.
*
* @return string[] Missing table names (empty when all present)
*/
private function findMissingComponentTables(): array
{
try {
$sqlFile = JPATH_ADMINISTRATOR . '/components/com_mokosuitebackup/sql/install.mysql.sql';
if (!is_file($sqlFile)) {
return [];
}
$sql = file_get_contents($sqlFile);
if ($sql === false || $sql === '') {
return [];
}
if (!preg_match_all('/CREATE\s+TABLE\s+(?:IF\s+NOT\s+EXISTS\s+)?[`"\']?(#__[A-Za-z0-9_]+)/i', $sql, $m)) {
return [];
}
$db = Factory::getContainer()->get(\Joomla\Database\DatabaseInterface::class);
$prefix = $db->getPrefix();
/* Existing tables, compared case-insensitively. */
$existing = array_flip(array_map('strtolower', $db->getTableList()));
$missing = [];
foreach (array_unique($m[1]) as $declared) {
$real = str_replace('#__', $prefix, $declared);
if (!isset($existing[strtolower($real)])) {
$missing[] = $real;
}
}
return $missing;
} catch (\Throwable $e) {
return [];
}
}
/**
* Remove the orphaned component registration created when the component
* <name> briefly used the "Type - Name" display convention. Joomla derives a