MokoSuiteStoreLocator/source/script.php

<?php
/**
 * @package     MokoSuiteStoreLocator
 * @subpackage  pkg_mokosuitestorelocator
 * @copyright   Copyright (C) 2026 Moko Consulting. All rights reserved.
 * @license     GNU General Public License version 3 or later; see LICENSE
 */

defined('_JEXEC') or die;

use Joomla\CMS\Installer\InstallerAdapter;
use Joomla\CMS\Installer\InstallerScriptInterface;
use Joomla\CMS\Log\Log;

/**
 * Package installation script for MokoSuiteStoreLocator.
 *
 * @since  1.0.0
 */
class Pkg_MokosuitestorelocatorInstallerScript implements InstallerScriptInterface
{
	/**
	 * Minimum PHP version required.
	 *
	 * @var    string
	 * @since  1.0.0
	 */
	protected string $minimumPhp = '8.2';

	/**
	 * Minimum Joomla version required.
	 *
	 * @var    string
	 * @since  1.0.0
	 */
	protected string $minimumJoomla = '5.0.0';

	/**
	 * Called before any type of action.
	 *
	 * @param   string             $type    Installation type (install, update, discover_install).
	 * @param   InstallerAdapter   $parent  The parent installer object.
	 *
	 * @return  boolean  True on success.
	 *
	 * @since   1.0.0
	 */
	public function preflight(string $type, InstallerAdapter $parent): bool
	{
		if (version_compare(PHP_VERSION, $this->minimumPhp, '<'))
		{
			Log::add(
				'MokoSuiteStoreLocator requires PHP ' . $this->minimumPhp . ' or later.',
				Log::WARNING,
				'jerror'
			);

			return false;
		}

		if (version_compare(JVERSION, $this->minimumJoomla, '<'))
		{
			Log::add(
				'MokoSuiteStoreLocator requires Joomla ' . $this->minimumJoomla . ' or later.',
				Log::WARNING,
				'jerror'
			);

			return false;
		}

		$this->saveDownloadKey();

		return true;
	}

	/**
	 * Called on installation.
	 *
	 * @param   InstallerAdapter  $parent  The parent installer object.
	 *
	 * @return  boolean  True on success.
	 *
	 * @since   1.0.0
	 */
	public function install(InstallerAdapter $parent): bool
	{
		return true;
	}

	/**
	 * Called on update.
	 *
	 * @param   InstallerAdapter  $parent  The parent installer object.
	 *
	 * @return  boolean  True on success.
	 *
	 * @since   1.0.0
	 */
	public function update(InstallerAdapter $parent): bool
	{
		return true;
	}

	/**
	 * Called on uninstallation.
	 *
	 * @param   InstallerAdapter  $parent  The parent installer object.
	 *
	 * @return  boolean  True on success.
	 *
	 * @since   1.0.0
	 */
	public function uninstall(InstallerAdapter $parent): bool
	{
		return true;
	}

	/**
	 * Called after any type of action.
	 *
	 * @param   string             $type    Installation type.
	 * @param   InstallerAdapter   $parent  The parent installer object.
	 *
	 * @return  boolean  True on success.
	 *
	 * @since   1.0.0
	 */
	public function postflight(string $type, InstallerAdapter $parent): bool
	{
		// Housekeeping runs unconditionally.
		$this->restoreDownloadKey();

		// Be honest about success. Joomla's package installer only LOGS a failed
		// child sub-install but still runs this postflight, so don't show the
		// license / next-steps message if a bundled extension is actually missing.
		// Fails open (see missingChildExtensions) so a query/IO glitch never fakes
		// a failure.
		$missing = $this->missingChildExtensions($parent);

		if (!empty($missing))
		{
			\Joomla\CMS\Factory::getApplication()->enqueueMessage(
				'<h4>MokoSuiteStoreLocator did not install correctly.</h4>'
				. '<p>The following bundled extensions are missing: '
				. htmlspecialchars(implode(', ', $missing), ENT_QUOTES) . '</p>'
				. '<p>Please uninstall MokoSuiteStoreLocator and reinstall the full package.</p>',
				'error'
			);

			return true;
		}

		// Success / next-steps path — only reached when every child installed.
		$this->warnMissingLicenseKey();

		return true;
	}

	/**
	 * Verify every child extension declared in the package manifest actually landed
	 * in #__extensions. Returns readable labels of any that are missing.
	 *
	 * Matching per Joomla's #__extensions uniqueness:
	 *   - type    = the <file> "type" attribute
	 *   - element = the <file> "id" attribute, EXCEPT for plugins the manifest often
	 *               declares the full `plg_<group>_<element>` id, so strip a leading
	 *               `plg_<group>_` to get the real element; components/modules use id as-is
	 *   - plugins ALSO match folder = the <file> "group" attribute
	 *
	 * FAILS OPEN: any error (unreadable manifest, query failure) returns [] so a
	 * transient glitch never turns a good install into a false failure.
	 *
	 * @param   InstallerAdapter  $parent  The parent installer object.
	 *
	 * @return  array  Readable labels of missing child extensions.
	 *
	 * @since   1.0.0
	 */
	private function missingChildExtensions(InstallerAdapter $parent): array
	{
		try
		{
			$manifest = $parent->getParent()->getManifest();

			if (!$manifest || !isset($manifest->files) || !isset($manifest->files->file))
			{
				return [];
			}

			$db      = \Joomla\CMS\Factory::getDbo();
			$missing = [];

			foreach ($manifest->files->file as $file)
			{
				$attrs  = $file->attributes();
				$id     = isset($attrs['id']) ? (string) $attrs['id'] : '';
				$exType = isset($attrs['type']) ? (string) $attrs['type'] : '';

				if ($id === '' || $exType === '')
				{
					continue;
				}

				$group   = isset($attrs['group']) ? (string) $attrs['group'] : '';
				$element = $id;

				// Plugin element in #__extensions is the id minus any leading plg_<group>_.
				if ($exType === 'plugin' && $group !== '')
				{
					$prefix = 'plg_' . $group . '_';

					if (strpos($element, $prefix) === 0)
					{
						$element = substr($element, \strlen($prefix));
					}
				}

				$query = $db->getQuery(true)
					->select('COUNT(*)')
					->from($db->quoteName('#__extensions'))
					->where($db->quoteName('element') . ' = ' . $db->quote($element))
					->where($db->quoteName('type') . ' = ' . $db->quote($exType));

				if ($exType === 'plugin' && $group !== '')
				{
					$query->where($db->quoteName('folder') . ' = ' . $db->quote($group));
				}

				if ((int) $db->setQuery($query)->loadResult() === 0)
				{
					$label     = trim((string) $file);
					$missing[] = $label !== '' ? preg_replace('/\.zip$/i', '', $label) : $id;
				}
			}

			return $missing;
		}
		catch (\Throwable $e)
		{
			// Fail open — never fake a failure on a glitch.
			return [];
		}
	}

	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_mokosuitestorelocator'))
					->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_mokosuitestorelocator'))
					->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('%MokoSuiteStoreLocator%')
						. ' OR ' . $db->quoteName('location') . ' LIKE ' . $db->quote('%MokoSuiteStoreLocator%') . ')'
					)
					->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) {}
	}
}