Files
MokoSuiteCross/source/script.php
T

289 lines
8.4 KiB
PHP
Raw Normal View History

<?php
/**
* @package MokoSuiteCross
* @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
* SPDX-License-Identifier: GPL-3.0-or-later
*/
defined('_JEXEC') or die;
use Joomla\CMS\Factory;
use Joomla\CMS\Installer\InstallerAdapter;
use Joomla\CMS\Language\Text;
class Pkg_MokoSuiteCrossInstallerScript
{
protected $minimumPhp = '8.1.0';
public function preflight(string $type, InstallerAdapter $parent): bool
{
if (version_compare(PHP_VERSION, $this->minimumPhp, '<'))
{
Factory::getApplication()->enqueueMessage(
Text::sprintf('PKG_MOKOSUITECROSS_PHP_VERSION_ERROR', $this->minimumPhp),
'error'
);
return false;
}
$this->saveDownloadKey();
return true;
}
public function postflight(string $type, InstallerAdapter $parent): void
{
// The download key must be restored regardless of the install outcome.
$this->restoreDownloadKey();
$db = Factory::getDbo();
if ($type === 'install')
{
$corePlugins = [
['system', 'mokosuitecross'],
['content', 'mokosuitecross'],
['webservices', 'mokosuitecross'],
['task', 'mokosuitecross'],
];
foreach ($corePlugins as [$folder, $element])
{
$query = $db->getQuery(true)
->update($db->quoteName('#__extensions'))
->set($db->quoteName('enabled') . ' = 1')
->where($db->quoteName('type') . ' = ' . $db->quote('plugin'))
->where($db->quoteName('folder') . ' = ' . $db->quote($folder))
->where($db->quoteName('element') . ' = ' . $db->quote($element));
$db->setQuery($query);
$db->execute();
}
$query = $db->getQuery(true)
->update($db->quoteName('#__extensions'))
->set($db->quoteName('enabled') . ' = 1')
->where($db->quoteName('type') . ' = ' . $db->quote('plugin'))
->where($db->quoteName('folder') . ' = ' . $db->quote('mokosuitecross'));
$db->setQuery($query);
$db->execute();
$this->detectPerfectPublisherPro($db);
}
// Be smart: only run the success path (and show the licence notice, which
// implies a completed install) when every child extension declared in the
// package manifest actually registered. If any are missing, the package
// did NOT install successfully — surface that instead of implying success.
$missing = $this->missingChildExtensions($parent);
if ($missing !== [])
{
Factory::getApplication()->enqueueMessage(
'<strong>MokoSuiteCross did not install completely.</strong> '
. 'The following extension(s) failed to install: '
. htmlspecialchars(implode(', ', $missing), ENT_QUOTES, 'UTF-8') . '. '
. 'Resolve the errors shown above, then uninstall and reinstall the package.',
'error'
);
return;
}
$this->warnMissingLicenseKey();
}
/**
* Compare the child extensions the package manifest declares against what is
* actually registered in #__extensions after the install/update. Returns the
* label of each declared extension that is missing (i.e. failed to install);
* an empty array means every child installed and the package succeeded.
*
* Fails open: any error returns [] so a query problem can never turn a good
* install into a false "did not install completely" warning.
*
* @param InstallerAdapter $parent
* @return string[]
*/
private function missingChildExtensions(InstallerAdapter $parent): array
{
$missing = [];
try
{
$manifest = $parent->getParent()->getManifest();
if (!$manifest || !isset($manifest->files) || !isset($manifest->files->file))
{
return [];
}
$db = Factory::getDbo();
foreach ($manifest->files->file as $file)
{
$type = (string) $file['type'];
$element = (string) $file['id'];
$group = (string) $file['group'];
if ($element === '')
{
continue;
}
$query = $db->getQuery(true)
->select('COUNT(*)')
->from($db->quoteName('#__extensions'))
->where($db->quoteName('element') . ' = ' . $db->quote($element));
if ($type !== '')
{
$query->where($db->quoteName('type') . ' = ' . $db->quote($type));
}
// Plugins are only unique by element + folder (the manifest "group").
if ($type === 'plugin' && $group !== '')
{
$query->where($db->quoteName('folder') . ' = ' . $db->quote($group));
}
$db->setQuery($query);
if ((int) $db->loadResult() === 0)
{
$missing[] = $element . ($group !== '' ? ' (' . $group . ')' : '');
}
}
}
catch (\Throwable $e)
{
return [];
}
return $missing;
}
private function detectPerfectPublisherPro($db): void
{
$query = $db->getQuery(true)
->select($db->quoteName(['element', 'params']))
->from($db->quoteName('#__extensions'))
->where($db->quoteName('element') . ' LIKE ' . $db->quote('%perfectpublisher%'))
->where($db->quoteName('type') . ' = ' . $db->quote('component'));
$db->setQuery($query);
$result = $db->loadObject();
if ($result)
{
Factory::getApplication()->enqueueMessage(
Text::_('PKG_MOKOSUITECROSS_MIGRATION_DETECTED'),
'notice'
);
$query = $db->getQuery(true)
->update($db->quoteName('#__extensions'))
->set($db->quoteName('params') . ' = ' . $db->quote(json_encode([
'migration_available' => 'perfectpublisher',
'migration_source_params' => $result->params,
])))
->where($db->quoteName('type') . ' = ' . $db->quote('component'))
->where($db->quoteName('element') . ' = ' . $db->quote('com_mokosuitecross'));
$db->setQuery($query);
$db->execute();
}
}
private ?string $savedDownloadKey = null;
private function saveDownloadKey(): void
{
try
{
$db = \Joomla\CMS\Factory::getDbo();
$db->setQuery(
$db->getQuery(true)
->select($db->quoteName('us.extra_query'))
->from($db->quoteName('#__update_sites', 'us'))
->join('INNER', $db->quoteName('#__update_sites_extensions', 'use') . ' ON use.update_site_id = us.update_site_id')
->join('INNER', $db->quoteName('#__extensions', 'e') . ' ON e.extension_id = use.extension_id')
->where($db->quoteName('e.element') . ' = ' . $db->quote('pkg_mokosuitecross'))
->setLimit(1)
);
$key = $db->loadResult();
if (!empty($key)) { $this->savedDownloadKey = $key; }
}
catch (\Throwable $e) {}
}
private function restoreDownloadKey(): void
{
if ($this->savedDownloadKey === null) { return; }
try
{
$db = \Joomla\CMS\Factory::getDbo();
$db->setQuery(
$db->getQuery(true)
->select($db->quoteName('us.update_site_id'))
->from($db->quoteName('#__update_sites', 'us'))
->join('INNER', $db->quoteName('#__update_sites_extensions', 'use') . ' ON use.update_site_id = us.update_site_id')
->join('INNER', $db->quoteName('#__extensions', 'e') . ' ON e.extension_id = use.extension_id')
->where($db->quoteName('e.element') . ' = ' . $db->quote('pkg_mokosuitecross'))
->setLimit(1)
);
$siteId = (int) $db->loadResult();
if ($siteId > 0)
{
$db->setQuery(
$db->getQuery(true)
->update($db->quoteName('#__update_sites'))
->set($db->quoteName('extra_query') . ' = ' . $db->quote($this->savedDownloadKey))
->where($db->quoteName('update_site_id') . ' = ' . $siteId)
)->execute();
}
}
catch (\Throwable $e) {}
}
private function warnMissingLicenseKey(): void
{
try
{
$db = \Joomla\CMS\Factory::getDbo();
$db->setQuery(
$db->getQuery(true)
->select([$db->quoteName('update_site_id'), $db->quoteName('extra_query')])
->from($db->quoteName('#__update_sites'))
->where('(' . $db->quoteName('name') . ' LIKE ' . $db->quote('%MokoSuiteCross%') . ' OR ' . $db->quoteName('location') . ' LIKE ' . $db->quote('%MokoSuiteCross%') . ')')
->setLimit(1)
);
$site = $db->loadObject();
if ($site)
{
$eq = (string) ($site->extra_query ?? '');
if (!empty($eq) && strpos($eq, 'dlid=') !== false) { parse_str($eq, $p); if (!empty($p['dlid'])) { return; } }
$editUrl = 'index.php?option=com_installer&task=updatesite.edit&update_site_id=' . (int) $site->update_site_id;
}
else
{
$editUrl = 'index.php?option=com_installer&view=updatesites';
}
\Joomla\CMS\Factory::getApplication()->enqueueMessage(
'<strong>Moko Consulting License Key Required</strong> — '
. 'No download key is configured. Updates will not be available until a valid license key is entered. '
. '<a href="' . $editUrl . '" class="btn btn-sm btn-warning ms-2">Enter License Key</a>',
'warning'
);
}
catch (\Throwable $e) {}
}
}