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
	{
		$this->restoreDownloadKey();
		$this->warnMissingLicenseKey();

		return true;
	}

	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) {}
	}
}