Compare commits

..

2 Commits

Author SHA1 Message Date
jmiller d38934c475 refactor(installer): replace hardcoded extension list with dynamic manifest verification
Universal: PR Check / Branch Policy (pull_request) Successful in 2s
Universal: PR Check / Secret Scan (pull_request) Successful in 9s
Universal: PR Check / Validate PR (pull_request) Failing after 7s
Joomla: Metadata Validation / Validate Joomla Metadata (pull_request) Successful in 47s
Universal: PR Check / Build RC Package (pull_request) Has been cancelled
Universal: PR Check / Report Issues (pull_request) Has been cancelled
Read package manifest via $adapter->getParent()->getManifest() to discover
children dynamically instead of maintaining a hardcoded EXPECTED_EXTENSIONS
array. Fail-open pattern wraps verification in try/catch. Only the success
path (plugin enables, license warning) is gated; unconditional housekeeping
(DLID restore) runs regardless.

Claude-Session: https://claude.ai/code/session_01CwLGvFJPjoPTp9BEnSjtJf
2026-07-06 10:45:34 -05:00
jmiller 3396766c02 feat: add post-install verification to detect failed sub-extensions
Universal: PR Check / Branch Policy (pull_request) Successful in 2s
Universal: PR Check / Secret Scan (pull_request) Successful in 8s
Universal: PR Check / Validate PR (pull_request) Failing after 5s
Joomla: Metadata Validation / Validate Joomla Metadata (pull_request) Successful in 9s
Universal: PR Check / Build RC Package (pull_request) Has been cancelled
Universal: PR Check / Report Issues (pull_request) Has been cancelled
Checks that all expected component and plugins registered in
#__extensions after install. Disables the package entry and shows
an error if any sub-extension failed to install.

Claude-Session: https://claude.ai/code/session_01CwLGvFJPjoPTp9BEnSjtJf
2026-07-05 22:28:51 -05:00
6 changed files with 179 additions and 147 deletions
+1 -1
View File
@@ -5,7 +5,7 @@
# FILE INFORMATION # FILE INFORMATION
# DEFGROUP: Gitea.Workflow # DEFGROUP: Gitea.Workflow
# INGROUP: mokocli.Automation # INGROUP: mokocli.Automation
# VERSION: 01.07.34 # VERSION: 01.07.28
# BRIEF: Auto-create feature branch when an issue is opened # BRIEF: Auto-create feature branch when an issue is opened
name: "Universal: Issue Branch" name: "Universal: Issue Branch"
-4
View File
@@ -1,10 +1,6 @@
# MokoSuite NPO # MokoSuite NPO
Nonprofit management for MokoSuite. Layer 2 add-on (requires CRM). Nonprofit management for MokoSuite. Layer 2 add-on (requires CRM).
## [Unreleased]
### Fixed
- Installer no longer shows the "license / next-steps" success message when a bundled child extension failed to install. The package `postflight` now verifies every child declared in the manifest actually landed in `#__extensions` and shows an honest error instead. Fails open so a transient glitch never fakes a failure.
## Features ## Features
- Donor management with giving levels - Donor management with giving levels
- Donation tracking with fund allocation - Donation tracking with fund allocation
@@ -1,3 +0,0 @@
COM_MOKOSUITENPO="MokoSuite NPO"
COM_MOKOSUITENPO_SHORT="NPO"
COM_MOKOSUITENPO_XML_DESCRIPTION="MokoSuite NPO component."
@@ -7,16 +7,13 @@
<license>GPL-3.0-or-later</license> <license>GPL-3.0-or-later</license>
<authorEmail>hello@mokoconsulting.tech</authorEmail> <authorEmail>hello@mokoconsulting.tech</authorEmail>
<authorUrl>https://mokoconsulting.tech</authorUrl> <authorUrl>https://mokoconsulting.tech</authorUrl>
<version>01.07.34</version> <version>01.07.28</version>
<php_minimum>8.3</php_minimum> <php_minimum>8.3</php_minimum>
<description>COM_MOKOSUITENPO_XML_DESCRIPTION</description> <description>MokoSuite NPO component</description>
<namespace path="src">Moko\Component\MokoSuiteNpo</namespace> <namespace path="src">Moko\Component\MokoSuiteNpo</namespace>
<administration> <administration>
<menu>COM_MOKOSUITENPO_SHORT</menu> <menu>MokoSuite NPO</menu>
<files folder="admin"><folder>language</folder><folder>src</folder><folder>services</folder><folder>tmpl</folder></files> <files folder="admin"><folder>src</folder><folder>services</folder><folder>tmpl</folder></files>
<languages folder="admin/language">
<language tag="en-GB">en-GB/com_mokosuitenpo.sys.ini</language>
</languages>
</administration> </administration>
<files folder="site"><folder>src</folder><folder>tmpl</folder></files> <files folder="site"><folder>src</folder><folder>tmpl</folder></files>
<api><files folder="api"><folder>src</folder></files></api> <api><files folder="api"><folder>src</folder></files></api>
+1 -1
View File
@@ -2,7 +2,7 @@
<extension type="package" method="upgrade"> <extension type="package" method="upgrade">
<name>Package - MokoSuite NPO</name> <name>Package - MokoSuite NPO</name>
<packagename>mokosuitenpo</packagename> <packagename>mokosuitenpo</packagename>
<version>01.07.34</version> <version>01.07.28</version>
<creationDate>2026-06-11</creationDate> <creationDate>2026-06-11</creationDate>
<author>Moko Consulting</author> <author>Moko Consulting</author>
<authorEmail>hello@mokoconsulting.tech</authorEmail> <authorEmail>hello@mokoconsulting.tech</authorEmail>
+173 -131
View File
@@ -1,9 +1,10 @@
<?php <?php
/** /**
* @package MokoSuiteNPO * MokoSuite NPO Package Install Script
* @subpackage pkg_mokosuitenpo *
* @package MokoSuite NPO
* @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved.
* @license GNU General Public License version 3 or later; see LICENSE * @license GPL-3.0-or-later
*/ */
defined('_JEXEC') or die; defined('_JEXEC') or die;
@@ -11,153 +12,73 @@ defined('_JEXEC') or die;
use Joomla\CMS\Factory; use Joomla\CMS\Factory;
use Joomla\CMS\Installer\InstallerAdapter; use Joomla\CMS\Installer\InstallerAdapter;
use Joomla\CMS\Log\Log; use Joomla\CMS\Log\Log;
use Joomla\Database\DatabaseInterface;
/**
* Package installation script for MokoSuiteNPO.
*/
class Pkg_MokoSuiteNPOInstallerScript class Pkg_MokoSuiteNPOInstallerScript
{ {
private string $savedDlid = '';
public function preflight(string $type, InstallerAdapter $adapter): bool
{
if ($type === 'update')
{
$this->savedDlid = $this->getExistingDlid();
}
return true;
}
public function postflight(string $type, InstallerAdapter $adapter): void public function postflight(string $type, InstallerAdapter $adapter): void
{ {
// Be honest about success. Joomla's package installer only LOGS a failed if ($this->savedDlid)
// 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 glitch never fakes a failure.
$missing = $this->missingChildExtensions($adapter);
if (!empty($missing))
{ {
Factory::getApplication()->enqueueMessage( $this->restoreDlid($this->savedDlid);
'<h4>MokoSuiteNPO did not install correctly.</h4>'
. '<p>The following bundled extensions are missing: '
. htmlspecialchars(implode(', ', $missing), ENT_QUOTES) . '</p>'
. '<p>Please uninstall MokoSuiteNPO and reinstall the full package.</p>',
'error'
);
return;
} }
$this->warnMissingLicenseKey(); if ($type === 'install')
}
/**
* 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 where the
* manifest declares the full plg_<group>_<element> id, so a
* leading plg_<group>_ is stripped to get the real element
* - 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 $adapter The package installer adapter.
*
* @return string[] Labels of missing child extensions.
*/
private function missingChildExtensions(InstallerAdapter $adapter): array
{
try
{ {
$manifest = $adapter->getParent()->getManifest(); $missing = $this->verifyChildren($adapter);
if (!$manifest || !isset($manifest->files) || !isset($manifest->files->file)) if (!empty($missing))
{ {
return []; Factory::getApplication()->enqueueMessage(
'<strong>MokoSuite NPO — Incomplete Installation</strong><br>'
. 'The following extensions failed to install: '
. implode(', ', $missing)
. '.<br>Please check file permissions and server logs, then reinstall the package.',
'error'
);
return;
} }
$db = Factory::getDbo(); $this->enablePlugin('system', 'mokosuitenpo');
$missing = []; $this->enablePlugin('webservices', 'mokosuitenpo');
$this->enablePlugin('task', 'mokosuitenpo_task');
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 function warnMissingLicenseKey(): void $dlid = $this->getExistingDlid();
{
try if (empty($dlid))
{ {
$db = Factory::getDbo();
$app = Factory::getApplication(); $app = Factory::getApplication();
$query = $db->getQuery(true) try
->select([$db->quoteName('update_site_id'), $db->quoteName('extra_query')])
->from($db->quoteName('#__update_sites'))
->where('(' . $db->quoteName('name') . ' LIKE ' . $db->quote('%MokoSuiteNPO%')
. ' OR ' . $db->quoteName('location') . ' LIKE ' . $db->quote('%MokoSuiteNPO%') . ')')
->setLimit(1);
$db->setQuery($query);
$site = $db->loadObject();
if ($site)
{ {
$extraQuery = (string) ($site->extra_query ?? ''); $db = Factory::getContainer()->get(DatabaseInterface::class);
$db->setQuery(
if (!empty($extraQuery) && strpos($extraQuery, 'dlid=') !== false) $db->getQuery(true)
{ ->select($db->quoteName('update_site_id'))
parse_str($extraQuery, $parsed); ->from($db->quoteName('#__update_sites'))
->where($db->quoteName('name') . ' LIKE ' . $db->quote('%MokoSuiteNPO%'))
if (!empty($parsed['dlid'])) ->setLimit(1)
{ );
return; $siteId = (int) $db->loadResult();
} $editUrl = $siteId
} ? 'index.php?option=com_installer&task=updatesite.edit&update_site_id=' . $siteId
: 'index.php?option=com_installer&view=updatesites';
$editUrl = 'index.php?option=com_installer&task=updatesite.edit&update_site_id=' . (int) $site->update_site_id;
} }
else catch (\Throwable $e)
{ {
$editUrl = 'index.php?option=com_installer&view=updatesites'; $editUrl = 'index.php?option=com_installer&view=updatesites';
} }
@@ -169,9 +90,130 @@ class Pkg_MokoSuiteNPOInstallerScript
'warning' 'warning'
); );
} }
}
private function verifyChildren(InstallerAdapter $adapter): array
{
try
{
$manifest = $adapter->getParent()->getManifest();
$files = $manifest->files->file ?? [];
if (!$files)
{
return [];
}
$db = Factory::getContainer()->get(DatabaseInterface::class);
$missing = [];
foreach ($files as $file)
{
$type = (string) ($file['type'] ?? '');
$id = (string) ($file['id'] ?? '');
$group = (string) ($file['group'] ?? '');
if ($type === '' || $id === '')
{
continue;
}
$element = ($type === 'plugin' && $group !== '')
? preg_replace('/^plg_' . preg_quote($group, '/') . '_/', '', $id)
: $id;
$query = $db->getQuery(true)
->select('COUNT(*)')
->from($db->quoteName('#__extensions'))
->where($db->quoteName('element') . ' = ' . $db->quote($element))
->where($db->quoteName('type') . ' = ' . $db->quote($type));
if ($type === 'plugin' && $group !== '')
{
$query->where($db->quoteName('folder') . ' = ' . $db->quote($group));
}
$db->setQuery($query);
if ((int) $db->loadResult() === 0)
{
$missing[] = htmlspecialchars($type . ': ' . $id, ENT_QUOTES, 'UTF-8');
}
}
return $missing;
}
catch (\Throwable $e) catch (\Throwable $e)
{ {
// Silent — avoid breaking install if update_sites query fails return [];
}
}
private function getExistingDlid(): string
{
try
{
$db = Factory::getContainer()->get(DatabaseInterface::class);
$db->setQuery(
$db->getQuery(true)
->select($db->quoteName('extra_query'))
->from($db->quoteName('#__update_sites'))
->where($db->quoteName('name') . ' LIKE ' . $db->quote('%MokoSuiteNPO%'))
->setLimit(1)
);
$extraQuery = $db->loadResult() ?? '';
if (preg_match('/dlid=([a-zA-Z0-9]+)/', $extraQuery, $matches))
{
return $matches[1];
}
}
catch (\Throwable $e)
{
Log::add('NPO install: failed to read DLID — ' . $e->getMessage(), Log::WARNING, 'mokosuite.npo');
}
return '';
}
private function restoreDlid(string $dlid): void
{
try
{
$db = Factory::getContainer()->get(DatabaseInterface::class);
$db->setQuery(
$db->getQuery(true)
->update($db->quoteName('#__update_sites'))
->set($db->quoteName('extra_query') . ' = ' . $db->quote('dlid=' . $dlid))
->where($db->quoteName('name') . ' LIKE ' . $db->quote('%MokoSuiteNPO%'))
);
$db->execute();
}
catch (\Throwable $e)
{
Log::add('NPO install: failed to restore DLID — ' . $e->getMessage(), Log::WARNING, 'mokosuite.npo');
}
}
private function enablePlugin(string $group, string $element): void
{
try
{
$db = Factory::getContainer()->get(DatabaseInterface::class);
$db->setQuery(
$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($group))
->where($db->quoteName('element') . ' = ' . $db->quote($element))
);
$db->execute();
}
catch (\Throwable $e)
{
Log::add('NPO install: failed to enable ' . $group . '/' . $element . ' — ' . $e->getMessage(), Log::WARNING, 'mokosuite.npo');
} }
} }
} }