<?php
/**
* Joomla! Content Management System
*
* @copyright (C) 2005 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Installer\Adapter;
use Joomla\CMS\Application\ApplicationHelper;
use Joomla\CMS\Installer\Installer;
use Joomla\CMS\Installer\InstallerAdapter;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Log\Log;
use Joomla\CMS\Table\Table;
use Joomla\Database\ParameterType;
use Joomla\Filesystem\Folder;
use Joomla\Utilities\ArrayHelper;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Module installer
*
* @since 3.1
*/
class ModuleAdapter extends InstallerAdapter
{
/**
* The install client ID
*
* @var integer
* @since 3.4
*/
protected $clientId;
/**
* `<scriptfile>` element of the extension manifest
*
* @var object
* @since 3.1
*/
protected $scriptElement = null;
/**
* Method to check if the extension is already present in the database
*
* @return void
*
* @since 3.4
* @throws \RuntimeException
*/
protected function checkExistingExtension()
{
try {
$this->currentExtensionId = $this->extension->find(
[
'element' => $this->element,
'type' => $this->type,
'client_id' => $this->clientId,
]
);
} catch (\RuntimeException $e) {
// Install failed, roll back changes
throw new \RuntimeException(
Text::sprintf(
'JLIB_INSTALLER_ABORT_ROLLBACK',
Text::_('JLIB_INSTALLER_' . $this->route),
$e->getMessage()
),
$e->getCode(),
$e
);
}
}
/**
* Method to copy the extension's base files from the `<files>` tag(s) and the manifest file
*
* @return void
*
* @since 3.4
* @throws \RuntimeException
*/
protected function copyBaseFiles()
{
// Copy all necessary files
if ($this->parent->parseFiles($this->getManifest()->files, -1) === false) {
throw new \RuntimeException(Text::_('JLIB_INSTALLER_ABORT_MOD_COPY_FILES'));
}
// If there is a manifest script, let's copy it.
if ($this->manifest_script) {
$path = [];
$path['src'] = $this->parent->getPath('source') . '/' . $this->manifest_script;
$path['dest'] = $this->parent->getPath('extension_root') . '/' . $this->manifest_script;
if ($this->parent->isOverwrite() || !file_exists($path['dest'])) {
if (!$this->parent->copyFiles([$path])) {
// Install failed, rollback changes
throw new \RuntimeException(
Text::sprintf(
'JLIB_INSTALLER_ABORT_MANIFEST',
Text::_('JLIB_INSTALLER_' . strtoupper($this->route))
)
);
}
}
}
}
/**
* Custom discover method
*
* @return array Extension list of extensions available
*
* @since 3.1
*/
public function discover()
{
$results = [];
$site_list = Folder::folders(JPATH_SITE . '/modules');
$admin_list = Folder::folders(JPATH_ADMINISTRATOR . '/modules');
$site_info = ApplicationHelper::getClientInfo('site', true);
$admin_info = ApplicationHelper::getClientInfo('administrator', true);
foreach ($site_list as $module) {
if (file_exists(JPATH_SITE . "/modules/$module/$module.xml")) {
$manifest_details = Installer::parseXMLInstallFile(JPATH_SITE . "/modules/$module/$module.xml");
$extension = Table::getInstance('extension');
$extension->type = 'module';
$extension->client_id = $site_info->id;
$extension->element = $module;
$extension->folder = '';
$extension->name = $module;
$extension->state = -1;
$extension->manifest_cache = json_encode($manifest_details);
$extension->params = '{}';
$results[] = clone $extension;
}
}
foreach ($admin_list as $module) {
if (file_exists(JPATH_ADMINISTRATOR . "/modules/$module/$module.xml")) {
$manifest_details = Installer::parseXMLInstallFile(JPATH_ADMINISTRATOR . "/modules/$module/$module.xml");
$extension = Table::getInstance('extension');
$extension->type = 'module';
$extension->client_id = $admin_info->id;
$extension->element = $module;
$extension->folder = '';
$extension->name = $module;
$extension->state = -1;
$extension->manifest_cache = json_encode($manifest_details);
$extension->params = '{}';
$results[] = clone $extension;
}
}
return $results;
}
/**
* Method to finalise the installation processing
*
* @return void
*
* @since 3.4
* @throws \RuntimeException
*/
protected function finaliseInstall()
{
// Clobber any possible pending updates
$update = Table::getInstance('update');
$uid = $update->find(
[
'element' => $this->element,
'type' => 'module',
'client_id' => $this->clientId,
]
);
if ($uid) {
$update->delete($uid);
}
// Lastly, we will copy the manifest file to its appropriate place.
if ($this->route !== 'discover_install') {
if (!$this->parent->copyManifest(-1)) {
// Install failed, rollback changes
throw new \RuntimeException(
Text::sprintf(
'JLIB_INSTALLER_ABORT_COPY_SETUP',
Text::_('JLIB_INSTALLER_' . strtoupper($this->route))
)
);
}
}
}
/**
* Method to finalise the uninstallation processing
*
* @return boolean
*
* @since 4.0.0
* @throws \RuntimeException
*/
protected function finaliseUninstall(): bool
{
$extensionId = $this->extension->extension_id;
$db = $this->getDatabase();
$retval = true;
// Remove the schema version
$query = $db->getQuery(true)
->delete('#__schemas')
->where('extension_id = :extension_id')
->bind(':extension_id', $extensionId, ParameterType::INTEGER);
$db->setQuery($query);
$db->execute();
$element = $this->extension->element;
$clientId = $this->extension->client_id;
// Let's delete all the module copies for the type we are uninstalling
$query->clear()
->select($db->quoteName('id'))
->from($db->quoteName('#__modules'))
->where($db->quoteName('module') . ' = :element')
->where($db->quoteName('client_id') . ' = :client_id')
->bind(':element', $element)
->bind(':client_id', $clientId, ParameterType::INTEGER);
$db->setQuery($query);
try {
$modules = $db->loadColumn();
} catch (\RuntimeException $e) {
$modules = [];
}
// Do we have any module copies?
if (\count($modules)) {
// Ensure the list is sane
$modules = ArrayHelper::toInteger($modules);
// Wipe out any items assigned to menus
$query = $db->getQuery(true)
->delete($db->quoteName('#__modules_menu'))
->whereIn($db->quoteName('moduleid'), $modules);
$db->setQuery($query);
try {
$db->execute();
} catch (\RuntimeException $e) {
Log::add(Text::sprintf('JLIB_INSTALLER_ERROR_MOD_UNINSTALL_EXCEPTION', $e->getMessage()), Log::WARNING, 'jerror');
$retval = false;
}
// Wipe out any instances in the modules table
/** @var \Joomla\CMS\Table\Module $module */
$module = Table::getInstance('Module');
foreach ($modules as $modInstanceId) {
$module->load($modInstanceId);
if (!$module->delete()) {
Log::add(Text::sprintf('JLIB_INSTALLER_ERROR_MOD_UNINSTALL_EXCEPTION', $module->getError()), Log::WARNING, 'jerror');
$retval = false;
}
}
}
// Now we will no longer need the module object, so let's delete it and free up memory
$this->extension->delete($this->extension->extension_id);
$query = $db->getQuery(true)
->delete($db->quoteName('#__modules'))
->where($db->quoteName('module') . ' = :element')
->where($db->quoteName('client_id') . ' = :client_id')
->bind(':element', $element)
->bind(':client_id', $clientId, ParameterType::INTEGER);
$db->setQuery($query);
try {
// Clean up any other ones that might exist as well
$db->execute();
} catch (\RuntimeException) {
// Ignore the error...
}
// Remove the installation folder
if (!Folder::delete($this->parent->getPath('extension_root'))) {
// Folder should raise an error
$retval = false;
}
return $retval;
}
/**
* Get the filtered extension element from the manifest
*
* @param string $element Optional element name to be converted
*
* @return string|null The filtered element
*
* @since 3.4
*/
public function getElement($element = null)
{
if ($element) {
return $element;
}
// Joomla 4 Module.
if ((string) $this->getManifest()->element) {
return (string) $this->getManifest()->element;
}
if (!\count($this->getManifest()->files->children())) {
return $element;
}
foreach ($this->getManifest()->files->children() as $file) {
if ((string) $file->attributes()->module) {
// Joomla 3 (legacy) Module.
return strtolower((string) $file->attributes()->module);
}
}
return $element;
}
/**
* Custom loadLanguage method
*
* @param string $path The path where we find language files
*
* @return void
*
* @since 3.4
*/
public function loadLanguage($path = null)
{
$source = $this->parent->getPath('source');
$client = $this->parent->extension->client_id ? JPATH_ADMINISTRATOR : JPATH_SITE;
if (!$source) {
$this->parent->setPath('source', $client . '/modules/' . $this->parent->extension->element);
}
$this->setManifest($this->parent->getManifest());
if ($this->getManifest()->files) {
$extension = $this->getElement();
if ($extension) {
$source = $path ?: $client . '/modules/' . $extension;
$folder = (string) $this->getManifest()->files->attributes()->folder;
if ($folder && file_exists($path . '/' . $folder)) {
$source = $path . '/' . $folder;
}
$client = (string) $this->getManifest()->attributes()->client ?: 'site';
$this->doLoadLanguage($extension, $source, \constant('JPATH_' . strtoupper($client)));
}
}
}
/**
* Method to parse optional tags in the manifest
*
* @return void
*
* @since 3.4
*/
protected function parseOptionalTags()
{
// Parse optional tags
$this->parent->parseMedia($this->getManifest()->media, $this->clientId);
$this->parent->parseLanguages($this->getManifest()->languages, $this->clientId);
}
/**
* Prepares the adapter for a discover_install task
*
* @return void
*
* @since 3.4
*/
public function prepareDiscoverInstall()
{
$client = ApplicationHelper::getClientInfo($this->parent->extension->client_id);
$manifestPath = $client->path . '/modules/' . $this->parent->extension->element . '/' . $this->parent->extension->element . '.xml';
$this->parent->manifest = $this->parent->isManifest($manifestPath);
$this->parent->setPath('manifest', $manifestPath);
$this->setManifest($this->parent->getManifest());
}
/**
* Refreshes the extension table cache
*
* @return boolean Result of operation, true if updated, false on failure.
*
* @since 3.1
*/
public function refreshManifestCache()
{
$client = ApplicationHelper::getClientInfo($this->parent->extension->client_id);
$manifestPath = $client->path . '/modules/' . $this->parent->extension->element . '/' . $this->parent->extension->element . '.xml';
$this->parent->manifest = $this->parent->isManifest($manifestPath);
$this->parent->setPath('manifest', $manifestPath);
$manifest_details = Installer::parseXMLInstallFile($this->parent->getPath('manifest'));
$this->parent->extension->manifest_cache = json_encode($manifest_details);
$this->parent->extension->name = $manifest_details['name'];
$this->parent->extension->changelogurl = $manifest_details['changelogurl'];
if ($this->parent->extension->store()) {
return true;
}
Log::add(Text::_('JLIB_INSTALLER_ERROR_MOD_REFRESH_MANIFEST_CACHE'), Log::WARNING, 'jerror');
return false;
}
/**
* Removes this extension's files
*
* @return void
*
* @since 4.0.0
* @throws \RuntimeException
*/
protected function removeExtensionFiles()
{
$this->parent->removeFiles($this->getManifest()->media);
$this->parent->removeFiles($this->getManifest()->languages, $this->extension->client_id);
}
/**
* Method to do any prechecks and setup the install paths for the extension
*
* @return void
*
* @since 3.4
* @throws \RuntimeException
*/
protected function setupInstallPaths()
{
// Get the target application
$cname = (string) $this->getManifest()->attributes()->client;
if ($cname) {
// Attempt to map the client to a base path
$client = ApplicationHelper::getClientInfo($cname, true);
if ($client === false) {
throw new \RuntimeException(
Text::sprintf(
'JLIB_INSTALLER_ABORT_MOD_UNKNOWN_CLIENT',
Text::_('JLIB_INSTALLER_' . $this->route),
$client->name
)
);
}
$basePath = $client->path;
$this->clientId = $client->id;
} else {
// No client attribute was found so we assume the site as the client
$basePath = JPATH_SITE;
$this->clientId = 0;
}
// Set the installation path
if (empty($this->element)) {
throw new \RuntimeException(
Text::sprintf(
'JLIB_INSTALLER_ABORT_MOD_INSTALL_NOFILE',
Text::_('JLIB_INSTALLER_' . $this->route)
)
);
}
$this->parent->setPath('extension_root', $basePath . '/modules/' . $this->element);
}
/**
* Method to do any prechecks and setup the uninstall job
*
* @return void
*
* @since 4.0.0
*/
protected function setupUninstall()
{
// Get the extension root path
$element = $this->extension->element;
$client = ApplicationHelper::getClientInfo($this->extension->client_id);
if ($client === false) {
throw new \RuntimeException(
Text::sprintf(
'JLIB_INSTALLER_ERROR_MOD_UNINSTALL_UNKNOWN_CLIENT',
$this->extension->client_id
)
);
}
$this->parent->setPath('extension_root', $client->path . '/modules/' . $element);
$this->parent->setPath('source', $this->parent->getPath('extension_root'));
// Get the module's manifest object
// We do findManifest to avoid problem when uninstalling a list of extensions: getManifest cache its manifest file.
$this->parent->findManifest();
$this->setManifest($this->parent->getManifest());
// Attempt to load the language file; might have uninstall strings
$this->loadLanguage(($this->extension->client_id ? JPATH_ADMINISTRATOR : JPATH_SITE) . '/modules/' . $element);
}
/**
* Method to store the extension to the database
*
* @return void
*
* @since 3.4
* @throws \RuntimeException
*/
protected function storeExtension()
{
// Discover installs are stored a little differently
if ($this->route === 'discover_install') {
$manifest_details = Installer::parseXMLInstallFile($this->parent->getPath('manifest'));
$this->extension->manifest_cache = json_encode($manifest_details);
$this->extension->state = 0;
$this->extension->name = $manifest_details['name'];
$this->extension->enabled = 1;
$this->extension->params = $this->parent->getParams();
$this->extension->changelogurl = (string) $this->manifest->changelogurl;
if (!$this->extension->store()) {
// Install failed, roll back changes
throw new \RuntimeException(Text::_('JLIB_INSTALLER_ERROR_MOD_DISCOVER_STORE_DETAILS'));
}
return;
}
// Was there a module already installed with the same name?
if ($this->currentExtensionId) {
if (!$this->parent->isOverwrite()) {
// Install failed, roll back changes
throw new \RuntimeException(
Text::sprintf(
'JLIB_INSTALLER_ABORT_ALREADY_EXISTS',
Text::_('JLIB_INSTALLER_' . $this->route),
$this->name
)
);
}
// Load the entry and update the manifest_cache
$this->extension->load($this->currentExtensionId);
// Update name
$this->extension->name = $this->name;
// Update namespace
$this->extension->namespace = (string) $this->manifest->namespace;
// Update changelogurl
$this->extension->changelogurl = (string) $this->manifest->changelogurl;
// Update manifest
$this->extension->manifest_cache = $this->parent->generateManifestCache();
if (!$this->extension->store()) {
// Install failed, roll back changes
throw new \RuntimeException(
Text::sprintf(
'JLIB_INSTALLER_ABORT_MOD_ROLLBACK',
Text::_('JLIB_INSTALLER_' . $this->route),
$this->extension->getError()
)
);
}
} else {
$this->extension->name = $this->name;
$this->extension->type = 'module';
$this->extension->element = $this->element;
$this->extension->namespace = (string) $this->manifest->namespace;
$this->extension->changelogurl = $this->changelogurl;
// There is no folder for modules
$this->extension->folder = '';
$this->extension->enabled = 1;
$this->extension->protected = 0;
$this->extension->access = $this->clientId == 1 ? 2 : 0;
$this->extension->client_id = $this->clientId;
$this->extension->params = $this->parent->getParams();
// Update the manifest cache for the entry
$this->extension->manifest_cache = $this->parent->generateManifestCache();
if (!$this->extension->store()) {
// Install failed, roll back changes
throw new \RuntimeException(
Text::sprintf(
'JLIB_INSTALLER_ABORT_MOD_ROLLBACK',
Text::_('JLIB_INSTALLER_' . $this->route),
$this->extension->getError()
)
);
}
// Since we have created a module item, we add it to the installation step stack
// so that if we have to rollback the changes we can undo it.
$this->parent->pushStep(
[
'type' => 'extension',
'extension_id' => $this->extension->extension_id,
]
);
// Create unpublished module
$name = preg_replace('#[\*?]#', '', Text::_($this->name));
/** @var \Joomla\CMS\Table\Module $module */
$module = Table::getInstance('module');
$module->title = $name;
$module->content = '';
$module->module = $this->element;
$module->access = '1';
$module->showtitle = '1';
$module->params = '';
$module->client_id = $this->clientId;
$module->language = '*';
$module->position = '';
$module->store();
}
}
/**
* Custom rollback method
* - Roll back the menu item
*
* @param array $arg Installation step to rollback
*
* @return boolean True on success
*
* @since 3.1
*/
protected function _rollback_menu($arg)
{
// Get database connector object
$db = $this->getDatabase();
$moduleId = $arg['id'];
// Remove the entry from the #__modules_menu table
$query = $db->getQuery(true)
->delete($db->quoteName('#__modules_menu'))
->where($db->quoteName('moduleid') . ' = :module_id')
->bind(':module_id', $moduleId, ParameterType::INTEGER);
$db->setQuery($query);
try {
return $db->execute();
} catch (\RuntimeException) {
return false;
}
}
/**
* Custom rollback method
* - Roll back the module item
*
* @param array $arg Installation step to rollback
*
* @return boolean True on success
*
* @since 3.1
*/
protected function _rollback_module($arg)
{
// Get database connector object
$db = $this->getDatabase();
$moduleId = $arg['id'];
// Remove the entry from the #__modules table
$query = $db->getQuery(true)
->delete($db->quoteName('#__modules'))
->where($db->quoteName('id') . ' = :module_id')
->bind(':module_id', $moduleId, ParameterType::INTEGER);
$db->setQuery($query);
try {
return $db->execute();
} catch (\RuntimeException) {
return false;
}
}
}