From 210aded6bc10d0971ab48abd855e88730d72199d Mon Sep 17 00:00:00 2001 From: Jonathan Miller Date: Sat, 6 Jun 2026 17:11:44 -0500 Subject: [PATCH] feat: download key preservation + license key warning (MokoWaaS pattern) --- source/script.php | 377 ++++++++++++++++++++++++++-------------------- 1 file changed, 215 insertions(+), 162 deletions(-) diff --git a/source/script.php b/source/script.php index fd9547b..ad16609 100644 --- a/source/script.php +++ b/source/script.php @@ -16,187 +16,240 @@ use Joomla\CMS\Language\Text; class Pkg_MokoJoomCrossInstallerScript { - /** - * Minimum PHP version required - * - * @var string - */ - protected $minimumPhp = '8.1.0'; + protected $minimumPhp = '8.1.0'; - /** - * Called before any install/update/uninstall action. - * - * @param string $type Action type (install, update, uninstall) - * @param InstallerAdapter $parent Installer adapter - * - * @return bool - */ - public function preflight(string $type, InstallerAdapter $parent): bool - { - if (version_compare(PHP_VERSION, $this->minimumPhp, '<')) { - Factory::getApplication()->enqueueMessage( - Text::sprintf('PKG_MOKOJOOMCROSS_PHP_VERSION_ERROR', $this->minimumPhp), - 'error' - ); + /** @var array Download keys saved before Joomla wipes update sites */ + private array $savedDownloadKeys = []; - return false; - } + public function preflight(string $type, InstallerAdapter $parent): bool + { + if (version_compare(PHP_VERSION, $this->minimumPhp, '<')) + { + Factory::getApplication()->enqueueMessage( + Text::sprintf('PKG_MOKOJOOMCROSS_PHP_VERSION_ERROR', $this->minimumPhp), + 'error' + ); - if ($type === 'update') { - $this->saveDownloadKey(); - } + return false; + } - return true; - } + $this->savedDownloadKeys = $this->backupDownloadKeys(); - /** - * Called after install/update. - * - * @param string $type Action type - * @param InstallerAdapter $parent Installer adapter - * - * @return void - */ - public function postflight(string $type, InstallerAdapter $parent): void - { - if ($this->savedDownloadKey !== null) { - $this->restoreDownloadKey(); - } - $this->showUpdateSiteNotice(); + return true; + } - $db = Factory::getDbo(); + public function postflight(string $type, InstallerAdapter $parent): void + { + $this->restoreDownloadKeys($this->savedDownloadKeys); + $this->warnMissingLicenseKey(); - if ($type === 'install') { - // Enable core plugins automatically on fresh install - $corePlugins = [ - ['system', 'mokojoomcross'], - ['content', 'mokojoomcross'], - ['webservices', 'mokojoomcross'], - ['task', 'mokojoomcross'], - ]; + $db = Factory::getDbo(); - 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)); + if ($type === 'install') + { + $corePlugins = [ + ['system', 'mokojoomcross'], + ['content', 'mokojoomcross'], + ['webservices', 'mokojoomcross'], + ['task', 'mokojoomcross'], + ]; - $db->setQuery($query); - $db->execute(); - } + 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(); + } - // Enable all service plugins in the mokojoomcross group - $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('mokojoomcross')); + $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('mokojoomcross')); + $db->setQuery($query); + $db->execute(); - $db->setQuery($query); - $db->execute(); + $this->detectPerfectPublisherPro($db); + } + } - // Check for Perfect Publisher Pro and offer migration - $this->detectPerfectPublisherPro($db); - } - } + private function backupDownloadKeys(): array + { + $keys = []; - /** - * Detect Perfect Publisher Pro installation and store migration flag. - * - * @param \Joomla\Database\DatabaseInterface $db Database driver - * - * @return void - */ - private ?string $savedDownloadKey = null; + try + { + $db = Factory::getDbo(); + $db->setQuery( + $db->getQuery(true) + ->select([ + 'us.' . $db->quoteName('update_site_id'), + 'us.' . $db->quoteName('extra_query'), + 'us.' . $db->quoteName('location'), + 'e.' . $db->quoteName('element'), + ]) + ->from($db->quoteName('#__update_sites', 'us')) + ->join('INNER', $db->quoteName('#__update_sites_extensions', 'use') . ' ON us.update_site_id = use.update_site_id') + ->join('INNER', $db->quoteName('#__extensions', 'e') . ' ON e.extension_id = use.extension_id') + ->where($db->quoteName('us.extra_query') . ' != ' . $db->quote('')) + ); - private function saveDownloadKey(): void - { - try { - $db = 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_mokojoomcross')) - ->setLimit(1) - ); - $key = $db->loadResult(); - if (!empty($key)) { $this->savedDownloadKey = $key; } - } catch (\Throwable $e) {} - } + foreach ($db->loadObjectList() ?: [] as $row) + { + $keys['elem_' . $row->element] = $row->extra_query; + $keys[$row->location] = $row->extra_query; + $keys['id_' . $row->update_site_id] = $row->extra_query; + } + } + catch (\Throwable $e) {} - private function restoreDownloadKey(): void - { - try { - $db = 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_mokojoomcross')) - ->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) {} - } + return $keys; + } - private function showUpdateSiteNotice(): void - { - try { - $db = 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_mokojoomcross')) - ->setLimit(1) - ); - if ((int) $db->loadResult() > 0) { - Factory::getApplication()->enqueueMessage('To receive automatic updates, configure your download key in System > Update Sites.', 'info'); - } - } catch (\Throwable $e) {} - } + private function restoreDownloadKeys(array $savedKeys): void + { + if (empty($savedKeys)) + { + return; + } - 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')); + try + { + $db = Factory::getDbo(); + $db->setQuery( + $db->getQuery(true) + ->select([ + 'us.' . $db->quoteName('update_site_id'), + 'us.' . $db->quoteName('extra_query'), + 'us.' . $db->quoteName('location'), + 'e.' . $db->quoteName('element'), + ]) + ->from($db->quoteName('#__update_sites', 'us')) + ->join('LEFT', $db->quoteName('#__update_sites_extensions', 'use') . ' ON us.update_site_id = use.update_site_id') + ->join('LEFT', $db->quoteName('#__extensions', 'e') . ' ON e.extension_id = use.extension_id') + ->where('(' . $db->quoteName('us.extra_query') . ' = ' . $db->quote('') + . ' OR ' . $db->quoteName('us.extra_query') . ' NOT LIKE ' . $db->quote('%dlid=%') . ')') + ); - $db->setQuery($query); - $result = $db->loadObject(); + $restored = 0; - if ($result) { - Factory::getApplication()->enqueueMessage( - Text::_('PKG_MOKOJOOMCROSS_MIGRATION_DETECTED'), - 'notice' - ); + foreach ($db->loadObjectList() ?: [] as $site) + { + $element = (string) ($site->element ?? ''); + $key = ''; - // Store migration availability in component params - $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_mokojoomcross')); + if ($element !== '') + { + $key = $savedKeys['elem_' . $element] ?? ''; + } - $db->setQuery($query); - $db->execute(); - } - } + if (empty($key)) + { + $key = $savedKeys[$site->location] ?? $savedKeys['id_' . $site->update_site_id] ?? ''; + } + + if (!empty($key)) + { + $db->setQuery( + $db->getQuery(true) + ->update($db->quoteName('#__update_sites')) + ->set($db->quoteName('extra_query') . ' = ' . $db->quote($key)) + ->where($db->quoteName('update_site_id') . ' = ' . (int) $site->update_site_id) + )->execute(); + $restored++; + } + } + + if ($restored > 0) + { + Factory::getApplication()->enqueueMessage( + sprintf('Restored %d download key(s) after update site cleanup.', $restored), + 'message' + ); + } + } + catch (\Throwable $e) {} + } + + private function warnMissingLicenseKey(): void + { + try + { + $db = Factory::getDbo(); + $app = Factory::getApplication(); + + $query = $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('%MokoJoomCross%') + . ' OR ' . $db->quoteName('location') . ' LIKE ' . $db->quote('%MokoJoomCross%') . ')') + ->setLimit(1); + $db->setQuery($query); + $site = $db->loadObject(); + + if ($site) + { + $extraQuery = (string) ($site->extra_query ?? ''); + + if (!empty($extraQuery) && strpos($extraQuery, 'dlid=') !== false) + { + parse_str($extraQuery, $parsed); + + if (!empty($parsed['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'; + } + + $app->enqueueMessage( + 'Moko Consulting License Key Required — ' + . 'No download key is configured. Updates will not be available until a valid license key is entered. ' + . 'Enter License Key', + 'warning' + ); + } + catch (\Throwable $e) {} + } + + 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_MOKOJOOMCROSS_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_mokojoomcross')); + $db->setQuery($query); + $db->execute(); + } + } }