Public Access
b491241a58
Universal: Sync Feature Branch Versions / Sync feature branches with dev (push) Has been skipped
# Conflicts: # .mokogitea/CLAUDE.md # .mokogitea/ISSUE_TEMPLATE/config.yml # .mokogitea/ISSUE_TEMPLATE/documentation.md # .mokogitea/ISSUE_TEMPLATE/feature_request.md # .mokogitea/ISSUE_TEMPLATE/security.md # .mokogitea/branch-protection.yml # .mokogitea/bulk-repo-sync.yml # .mokogitea/pr-branch-check.yml # .mokogitea/renovate.yml # .mokogitea/sync-wikis.yml # .mokogitea/workflows/auto-bump.yml # .mokogitea/workflows/auto-release.yml # .mokogitea/workflows/ci-platform.yml # .mokogitea/workflows/cleanup.yml # .mokogitea/workflows/gitleaks.yml # .mokogitea/workflows/issue-branch.yml # .mokogitea/workflows/notify.yml # .mokogitea/workflows/pre-release.yml # .mokogitea/workflows/repo-health.yml # .mokogitea/workflows/security-audit.yml # .script-registry.json # CHANGELOG.md # PLUGIN_SCRIPTS.md # README.md # analysis/index.md # automation/bulk_joomla_template.php # automation/bulk_sync.php # automation/enrich_manifest_xml.php # automation/enrich_mokostandards_xml.php # automation/index.md # automation/migrate_to_gitea.php # automation/push_files.php # automation/push_manifest_xml.php # automation/push_mokostandards_xml.php # automation/repo_cleanup.php # bin/moko # cli/archive_repo.php # cli/audit_query.php # cli/badge_update.php # cli/branch_rename.php # cli/bulk_workflow_push.php # cli/bulk_workflow_trigger.php # cli/changelog_promote.php # cli/changelog_prune.php # cli/client_dashboard.php # cli/client_health_check.php # cli/client_inventory.php # cli/client_provision.php # cli/completion.php # cli/create_project.php # cli/create_repo.php # cli/deploy_joomla.php # cli/dev_branch_reset.php # cli/grafana_dashboard.php # cli/joomla_build.php # cli/joomla_compat_check.php # cli/joomla_metadata_validate.php # cli/joomla_release.php # cli/license_manage.php # cli/manifest_element.php # cli/manifest_licensing.php # cli/manifest_read.php # cli/package_build.php # cli/platform_detect.php # cli/release.php # cli/release_body_update.php # cli/release_cascade.php # cli/release_create.php # cli/release_manage.php # cli/release_mirror.php # cli/release_notes.php # cli/release_package.php # cli/release_promote.php # cli/release_publish.php # cli/release_validate.php # cli/release_verify.php # cli/scaffold_client.php # cli/sync_rulesets.php # cli/theme_lint.php # cli/updates_xml_build.php # cli/updates_xml_sync.php # cli/version_auto_bump.php # cli/version_bump.php # cli/version_bump_remote.php # cli/version_check.php # cli/version_read.php # cli/version_reset_dev.php # cli/version_set_platform.php # cli/wiki_sync.php # cli/workflow_sync.php # composer.json # deploy/backup-before-deploy.php # deploy/deploy-dolibarr.php # deploy/deploy-joomla.php # deploy/deploy-sftp.php # deploy/health-check.php # deploy/rollback-joomla.php # deploy/sync-joomla.php # fix/fix_line_endings.php # fix/fix_permissions.php # fix/fix_tabs.php # fix/fix_trailing_spaces.php # fix/index.md # index.md # lib/CliBase.php # lib/Common.php # lib/Enterprise/AbstractProjectPlugin.php # lib/Enterprise/ApiClient.php # lib/Enterprise/AuditLogger.php # lib/Enterprise/CheckpointManager.php # lib/Enterprise/CliFramework.php # lib/Enterprise/Config.php # lib/Enterprise/ConfigValidator.php # lib/Enterprise/EnterpriseReadinessValidator.php # lib/Enterprise/ErrorRecovery.php # lib/Enterprise/FileFixUtility.php # lib/Enterprise/GitHubAdapter.php # lib/Enterprise/GitPlatformAdapter.php # lib/Enterprise/InputValidator.php # lib/Enterprise/ManifestParser.php # lib/Enterprise/ManifestReader.php # lib/Enterprise/MetricsCollector.php # lib/Enterprise/MokoGiteaAdapter.php # lib/Enterprise/PackageBuilder.php # lib/Enterprise/PlatformAdapterFactory.php # lib/Enterprise/PluginFactory.php # lib/Enterprise/PluginRegistry.php # lib/Enterprise/Plugins/ApiPlugin.php # lib/Enterprise/Plugins/DocumentationPlugin.php # lib/Enterprise/Plugins/DolibarrPlugin.php # lib/Enterprise/Plugins/GenericPlugin.php # lib/Enterprise/Plugins/JoomlaPlugin.php # lib/Enterprise/Plugins/McpServerPlugin.php # lib/Enterprise/Plugins/MobilePlugin.php # lib/Enterprise/Plugins/NodeJsPlugin.php # lib/Enterprise/Plugins/PythonPlugin.php # lib/Enterprise/Plugins/TerraformPlugin.php # lib/Enterprise/Plugins/WordPressPlugin.php # lib/Enterprise/ProjectConfigValidator.php # lib/Enterprise/ProjectMetricsCollector.php # lib/Enterprise/ProjectPluginInterface.php # lib/Enterprise/ProjectTypeDetector.php # lib/Enterprise/RecoveryError.php # lib/Enterprise/RecoveryManager.php # lib/Enterprise/RepositoryHealthChecker.php # lib/Enterprise/RepositorySynchronizer.php # lib/Enterprise/RetryHelper.php # lib/Enterprise/SecurityValidator.php # lib/Enterprise/SourceResolver.php # lib/Enterprise/SynchronizationException.php # lib/Enterprise/TransactionManager.php # lib/Enterprise/UnifiedValidation.php # lib/index.md # lib/plugins/Joomla/UpdateXmlGenerator.php # maintenance/index.md # maintenance/pin_action_shas.php # maintenance/repo_inventory.php # maintenance/rotate_secrets.php # maintenance/setup_labels.php # maintenance/sync_dolibarr_readmes.php # maintenance/update_repo_inventory.php # maintenance/update_sha_hashes.php # maintenance/update_version_from_readme.php # mcp/config.example.json # mcp/package.json # mcp/src/config.ts # mcp/src/index.ts # mcp/src/runner.ts # mcp/src/types.ts # phpcs.xml # plugin_health_check.php # plugin_list.php # plugin_metrics.php # plugin_readiness.php # plugin_validate.php # release/generate_dolibarr_version_txt.php # release/generate_joomla_update_xml.php # src/functions.php # templates/configs/README.md # templates/configs/index.md # templates/configs/manifest.xml.template # templates/configs/manifest.yml.template # templates/configs/mokostandards.xml.template # templates/configs/mokostandards.yml.template # templates/configs/phpcs.xml # templates/docs/README.md # templates/docs/extra/README.md # templates/docs/extra/index.md # templates/docs/index.md # templates/docs/required/GOVERNANCE.md # templates/docs/required/README.md # templates/docs/required/index.md # templates/docs/required/template-CONTRIBUTING.md # templates/docs/required/template-README.md # templates/docs/required/template-SECURITY.md # templates/index.md # templates/licenses/README.md # templates/licenses/index.md # templates/makefiles/README.md # templates/mokogitea/CLAUDE.dolibarr.md.template # templates/mokogitea/CLAUDE.joomla.md.template # templates/mokogitea/CLAUDE.md.template # templates/mokogitea/ISSUE_TEMPLATE/config.yml # templates/mokogitea/ISSUE_TEMPLATE/documentation.md # templates/mokogitea/ISSUE_TEMPLATE/dolibarr_module_id_request.md # templates/mokogitea/ISSUE_TEMPLATE/feature_request.md # templates/mokogitea/ISSUE_TEMPLATE/security.md # templates/mokogitea/README.md # templates/mokogitea/copilot-instructions.dolibarr.md.template # templates/mokogitea/copilot-instructions.joomla.md.template # templates/mokogitea/copilot-instructions.md.template # templates/mokogitea/dependabot.yml.template # templates/mokogitea/override.tf.template # templates/required/README.md # templates/schemas/README.md # templates/schemas/manifest-schema.xsd # templates/schemas/moko-platform-schema.xsd # templates/schemas/mokostandards-schema.xsd # templates/schemas/schemas/README.md # templates/schemas/template-repository-structure.xml # templates/scripts/README.md # templates/scripts/common/CliBase.template.php # templates/scripts/fix/index.md # templates/scripts/index.md # templates/scripts/release/index.md # templates/scripts/release/package_dolibarr.php # templates/scripts/release/package_joomla.php # templates/scripts/sftp-config/README.md # templates/scripts/validate/dolibarr_module.php # templates/scripts/validate/index.md # templates/scripts/validate/validate_manifest.php # templates/scripts/validate/validate_structure.php # templates/security/README.md # templates/security/index.php # templates/stubs/dolibarr.php # templates/stubs/joomla.php # templates/web/index.php # tests/Enterprise/GitPlatformAdapterTest.php # tests/Unit/VersionBumpTest.php # tests/Unit/VersionReadTest.php # tests/index.md # tests/test_circuit_breaker_handling.php # tests/test_enterprise_libraries.php # validate/SECURITY_SCANNING.md # validate/auto_detect_platform.php # validate/check_changelog.php # validate/check_client_theme.php # validate/check_composer_deps.php # validate/check_dolibarr_module.php # validate/check_enterprise_readiness.php # validate/check_file_integrity.php # validate/check_joomla_manifest.php # validate/check_language_structure.php # validate/check_license_headers.php # validate/check_no_secrets.php # validate/check_paths.php # validate/check_php_syntax.php # validate/check_repo_health.php # validate/check_structure.php # validate/check_tabs.php # validate/check_version_consistency.php # validate/check_wiki_health.php # validate/check_xml_wellformed.php # validate/index.md # validate/scan_drift.php # wrappers/auto_detect_platform.php # wrappers/bulk_sync.php # wrappers/check_changelog.php # wrappers/check_dolibarr_module.php # wrappers/check_enterprise_readiness.php # wrappers/check_joomla_manifest.php # wrappers/check_language_structure.php # wrappers/check_license_headers.php # wrappers/check_no_secrets.php # wrappers/check_paths.php # wrappers/check_php_syntax.php # wrappers/check_repo_health.php # wrappers/check_structure.php # wrappers/check_tabs.php # wrappers/check_version_consistency.php # wrappers/check_xml_wellformed.php # wrappers/deploy_sftp.php # wrappers/fix_line_endings.php # wrappers/fix_permissions.php # wrappers/fix_tabs.php # wrappers/fix_trailing_spaces.php # wrappers/gen_wrappers.php # wrappers/index.md # wrappers/pin_action_shas.php # wrappers/plugin_health_check.php # wrappers/plugin_list.php # wrappers/plugin_metrics.php # wrappers/plugin_readiness.php # wrappers/plugin_validate.php # wrappers/scan_drift.php # wrappers/setup_labels.php # wrappers/sync_dolibarr_readmes.php # wrappers/update_sha_hashes.php # wrappers/update_version_from_readme.php
204 lines
6.0 KiB
PHP
204 lines
6.0 KiB
PHP
#!/usr/bin/env php
|
|
<?php
|
|
|
|
/* Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
|
*
|
|
* This file is part of a Moko Consulting project.
|
|
*
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
|
*
|
|
* FILE INFORMATION
|
|
<<<<<<< HEAD
|
|
* DEFGROUP: MokoCLI.Scripts.Deploy
|
|
* INGROUP: MokoCLI
|
|
* REPO: https://git.mokoconsulting.tech/MokoConsulting/mokocli
|
|
* PATH: /deploy/backup-before-deploy.php
|
|
* VERSION: 09.25.05
|
|
=======
|
|
* DEFGROUP: MokoPlatform.Scripts.Deploy
|
|
* INGROUP: MokoPlatform
|
|
* REPO: https://git.mokoconsulting.tech/MokoConsulting/mokoplatform
|
|
* PATH: /deploy/backup-before-deploy.php
|
|
* VERSION: 09.32.00
|
|
>>>>>>> main
|
|
* BRIEF: Snapshot Joomla directories before deployment for rollback capability
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
require_once __DIR__ . '/../lib/Enterprise/CliFramework.php';
|
|
|
|
use MokoCli\CliFramework;
|
|
|
|
class BackupBeforeDeployCli extends CliFramework
|
|
{
|
|
private const JOOMLA_DIRS = [
|
|
'administrator/components',
|
|
'administrator/language',
|
|
'administrator/modules',
|
|
'administrator/templates',
|
|
'components',
|
|
'language',
|
|
'layouts',
|
|
'libraries',
|
|
'media',
|
|
'modules',
|
|
'plugins',
|
|
'templates',
|
|
];
|
|
|
|
protected function configure(): void
|
|
{
|
|
$this->setDescription('Snapshot Joomla directories before deployment for rollback capability');
|
|
$this->addArgument('--config', 'Path to sftp-config.json', '');
|
|
$this->addArgument('--output', 'Local output directory for snapshot', '');
|
|
}
|
|
|
|
protected function run(): int
|
|
{
|
|
$configPath = $this->getArgument('--config');
|
|
$outputDir = $this->getArgument('--output');
|
|
|
|
if ($configPath === '') {
|
|
$this->log('ERROR', 'Usage: backup-before-deploy.php --config <sftp-config.json> [--output <local-dir>] [--verbose]');
|
|
return 1;
|
|
}
|
|
|
|
if ($outputDir === '') {
|
|
$outputDir = '/tmp/moko-snapshot-' . date('Ymd-His');
|
|
}
|
|
|
|
$config = $this->loadConfig($configPath);
|
|
if ($config === null) {
|
|
return 1;
|
|
}
|
|
|
|
$host = $config['host'] ?? '';
|
|
$user = $config['user'] ?? '';
|
|
$port = (int) ($config['port'] ?? 22);
|
|
$remotePath = rtrim($config['remote_path'] ?? '', '/');
|
|
$sshKey = $config['ssh_key_file'] ?? '';
|
|
|
|
if ($host === '' || $user === '' || $remotePath === '') {
|
|
$this->log('ERROR', 'Config must contain host, user, and remote_path.');
|
|
return 1;
|
|
}
|
|
|
|
// Create output directory
|
|
if (!is_dir($outputDir)) {
|
|
if (!mkdir($outputDir, 0755, true)) {
|
|
$this->log('ERROR', "Could not create output directory: {$outputDir}");
|
|
return 1;
|
|
}
|
|
}
|
|
|
|
$this->log('INFO', 'Starting pre-deploy snapshot...');
|
|
$this->log('INFO', "Source: {$user}@{$host}:{$remotePath}");
|
|
$this->log('INFO', "Output: {$outputDir}");
|
|
|
|
$failed = 0;
|
|
|
|
foreach (self::JOOMLA_DIRS as $dir) {
|
|
$remoteSource = "{$remotePath}/{$dir}/";
|
|
$localTarget = rtrim($outputDir, '/\\') . '/' . $dir . '/';
|
|
|
|
// Ensure local subdirectory exists
|
|
if (!is_dir($localTarget)) {
|
|
mkdir($localTarget, 0755, true);
|
|
}
|
|
|
|
$sshCmd = "ssh -p {$port}";
|
|
if ($sshKey !== '') {
|
|
$sshCmd .= " -i " . escapeshellarg($sshKey);
|
|
}
|
|
|
|
$cmd = $this->buildRsyncCommand(
|
|
$sshCmd,
|
|
"{$user}@{$host}:{$remoteSource}",
|
|
$localTarget
|
|
);
|
|
|
|
$this->log('INFO', "Downloading: {$dir}");
|
|
if ($this->verbose) {
|
|
$this->log('INFO', "CMD: {$cmd}");
|
|
}
|
|
|
|
$output = [];
|
|
$exitCode = 0;
|
|
exec($cmd, $output, $exitCode);
|
|
|
|
if ($exitCode !== 0) {
|
|
$this->log('ERROR', "rsync failed for {$dir} (exit code {$exitCode})");
|
|
foreach ($output as $line) {
|
|
$this->log('ERROR', " {$line}");
|
|
}
|
|
$failed++;
|
|
} else {
|
|
if ($this->verbose) {
|
|
foreach ($output as $line) {
|
|
$this->log('INFO', " {$line}");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($failed > 0) {
|
|
$this->log('ERROR', "Snapshot completed with {$failed} error(s).");
|
|
return 1;
|
|
}
|
|
|
|
$this->log('INFO', '');
|
|
$this->log('INFO', 'Snapshot completed successfully.');
|
|
$this->log('INFO', "SNAPSHOT_PATH={$outputDir}");
|
|
$this->log('INFO', '');
|
|
$this->log('INFO', 'To rollback, run:');
|
|
$this->log('INFO', " php rollback-joomla.php --config {$configPath} --snapshot-dir {$outputDir}");
|
|
|
|
return 0;
|
|
}
|
|
|
|
private function loadConfig(string $path): ?array
|
|
{
|
|
if (!is_file($path)) {
|
|
$this->log('ERROR', "Config file not found: {$path}");
|
|
return null;
|
|
}
|
|
|
|
$raw = file_get_contents($path);
|
|
if ($raw === false) {
|
|
$this->log('ERROR', "Could not read config file: {$path}");
|
|
return null;
|
|
}
|
|
|
|
// Strip // comments (sftp-config.json style)
|
|
$cleaned = preg_replace('#^\s*//.*$#m', '', $raw);
|
|
$config = json_decode($cleaned, true);
|
|
|
|
if (!is_array($config)) {
|
|
$this->log('ERROR', 'Invalid JSON in config file.');
|
|
return null;
|
|
}
|
|
|
|
return $config;
|
|
}
|
|
|
|
private function buildRsyncCommand(string $sshCmd, string $source, string $dest): string
|
|
{
|
|
$parts = ['rsync', '-rlptz', '--exclude=configuration.php'];
|
|
|
|
if ($this->verbose) {
|
|
$parts[] = '-v';
|
|
}
|
|
|
|
$parts[] = '-e';
|
|
$parts[] = escapeshellarg($sshCmd);
|
|
$parts[] = escapeshellarg($source);
|
|
$parts[] = escapeshellarg($dest);
|
|
|
|
return implode(' ', $parts);
|
|
}
|
|
}
|
|
|
|
$app = new BackupBeforeDeployCli();
|
|
exit($app->execute());
|