| Current File : /home/pacjaorg/pacjaorg/cop.pacja.org/administrator/manifests/packages/akeeba/script.akeeba.php |
<?php
/**
* @package akeebabackup
* @copyright Copyright (c)2006-2023 Nicholas K. Dionysopoulos / Akeeba Ltd
* @license GNU General Public License version 3, or later
*/
// Protect from unauthorized access
use Joomla\CMS\Factory;
use Joomla\CMS\Filesystem\Folder;
defined('_JEXEC') or die();
class Pkg_AkeebaInstallerScript
{
/**
* The name of our package, e.g. pkg_example. Used for dependency tracking.
*
* @var string
*/
protected $packageName = 'pkg_akeeba';
/**
* The name of our component, e.g. com_example. Used for dependency tracking.
*
* @var string
*/
protected $componentName = 'com_akeeba';
/**
* The minimum PHP version required to install this extension
*
* @var string
*/
protected $minimumPHPVersion = '7.2.0';
/**
* The minimum Joomla! version required to install this extension
*
* @var string
*/
protected $minimumJoomlaVersion = '3.9.0';
/**
* The maximum Joomla! version this extension can be installed on
*
* @var string
*/
protected $maximumJoomlaVersion = '4.999.999';
/**
* A list of extensions (modules, plugins) to enable after installation. Each item has four values, in this order:
* type (plugin, module, ...), name (of the extension), client (0=site, 1=admin), group (for plugins).
*
* These extensions are ONLY enabled when you do a clean installation of the package, i.e. it will NOT run on update
*
* @var array
*/
protected $extensionsToEnable = [
['plugin', 'akeebabackup', 1, 'quickicon'],
];
/**
* Like above, but enable these extensions on installation OR update. Use this sparingly. It overrides the
* preferences of the user. Ideally, this should only be used for installer plugins.
*
* @var array
*/
protected $extensionsToAlwaysEnable = [
['plugin', 'akeebabackup', 1, 'installer'],
['plugin', 'akversioncheck', 1, 'system'],
];
/**
* A list of plugins to uninstall when installing or updating the package. Each item has two values, in this order:
* name (element), folder.
*
* @var array
*/
protected $uninstallPlugins = [
['jsonapi', 'akeebabackup'],
['legacyapi', 'akeebabackup'],
['akeebaactionlog', 'system'],
['akeebaupdatecheck', 'system'],
['aklazy', 'system'],
['srp', 'system'],
];
/**
* We remove some plugins' files. If Joomla fails to update them correctly you'd end up with an inaccessible site.
* These will be updated / installed right after the preflight event so you don't ever lose their functionality.
*
* @var string[]
*/
protected $preRemoveFolders = [
// Current plugins
'plugins/actionlog/akeebabackup',
'plugins/console/akeebabackup',
'plugins/installer/akeebabackup',
'plugins/quickicon/akeebabackup',
'plugins/system/backuponupdate',
// Obsolete plugins
'plugins/system/akeebaactionlog',
'plugins/system/akeebaupdatecheck',
'plugins/system/aklazy',
'plugins/system/srp',
];
/**
* =================================================================================================================
* DO NOT EDIT BELOW THIS LINE
* =================================================================================================================
*/
/**
* Joomla! pre-flight event. This runs before Joomla! installs or updates the package. This is our last chance to
* tell Joomla! if it should abort the installation.
*
* In here we'll try to install FOF. We have to do that before installing the component since it's using an
* installation script extending FOF's InstallScript class. We can't use a <file> tag in the manifest to install FOF
* since the FOF installation is expected to fail if a newer version of FOF is already installed on the site.
*
* @param string $type Installation type (install, update, discover_install)
* @param \JInstallerAdapterPackage $parent Parent object
*
* @return boolean True to let the installation proceed, false to halt the installation
*/
public function preflight($type, $parent)
{
// Do not run on uninstall.
if ($type === 'uninstall')
{
return true;
}
// Check the minimum PHP version
if (!version_compare(PHP_VERSION, $this->minimumPHPVersion, 'ge'))
{
$msg = "<p>You need PHP $this->minimumPHPVersion or later to install this package</p>";
JLog::add($msg, JLog::WARNING, 'jerror');
return false;
}
// Check the minimum Joomla! version
if (!version_compare(JVERSION, $this->minimumJoomlaVersion, 'ge'))
{
$msg = "<p>You need Joomla! $this->minimumJoomlaVersion or later to install this component</p>";
JLog::add($msg, JLog::WARNING, 'jerror');
return false;
}
// Check the maximum Joomla! version
if (!version_compare(JVERSION, $this->maximumJoomlaVersion, 'le'))
{
//$msg = "<p>You need Joomla! $this->maximumJoomlaVersion or earlier to install this component</p>";
$hasOldVersion = \Joomla\CMS\Component\ComponentHelper::isInstalled('com_akeeba');
$jVersion = JVERSION;
if ($hasOldVersion)
{
$upgradeMessage = <<< HTML
<p class="fs-2">
Please go to <a href="index.php?option=com_akeeba">Components, Akeeba Backup</a> to learn how to install
Akeeba Backup 9 — the Joomla 4 native version of our software — and migrate your backup settings and backup
archives with a single click.
</p>
HTML;
}
else
{
$upgradeMessage = <<< HTML
<p class="fs-2">
Please go to <a href="https://www.akeeba.com/download.html">our site's Download page</a> to download
Akeeba Backup 9, the Joomla 4 native version of our software.
</p>
HTML;
}
$msg = <<< HTML
<div class="m-4">
<h3 class="alert-heading fs-1">Akeeba Backup 8 cannot be installed or used with Joomla 4.1 and later versions</h3>
$upgradeMessage
<p class="fs-5">
<strong>Note:</strong> You will see the messages “Extension Install: Custom install routine failure.”
and “Error installing package” printed below. This is normal and expected. Since Akeeba Backup 8 is not
meant to be used with Joomla $jVersion it refuses to install at all and Joomla produces these two messages.
</p>
</div>
HTML;
JLog::add($msg, JLog::WARNING, 'jerror');
return false;
}
// HHVM made sense in 2013, now PHP 7 is a way better solution than an hybrid PHP interpreter
if (defined('HHVM_VERSION'))
{
$msg = "<p>We have detected that you are running HHVM instead of PHP. This software WILL NOT WORK properly on HHVM. Please switch to PHP 7 instead.</p>";
JLog::add($msg, JLog::WARNING, 'jerror');
return false;
}
/**
* Try to install FOF. We need to do this in preflight to make sure that FOF is available when we install our
* component. The reason being that the component's installation script extends FOF's InstallScript class.
* We can't use a <file> tag in our package manifest because FOF's package is *supposed* to fail to install if
* a newer version is already installed. This would unfortunately cancel the installation of the entire package,
* so we have to get a bit tricky.
*/
$this->installOrUpdateFOF($parent);
// Remove plugins' files which load outside of the component. If any is not fully updated your site won't crash.
foreach ($this->preRemoveFolders as $folder)
{
$f = JPATH_ROOT . '/' . $folder;
if (!@file_exists($f) || !is_dir($f) || is_link($f))
{
continue;
}
Folder::delete($f);
}
return true;
}
/**
* Runs after install, update or discover_update. In other words, it executes after Joomla! has finished installing
* or updating your component. This is the last chance you've got to perform any additional installations, clean-up,
* database updates and similar housekeeping functions.
*
* @param string $type install, update or discover_update
* @param \JInstallerAdapterComponent $parent Parent object
*/
public function postflight($type, $parent)
{
// Do not run on uninstall.
if ($type === 'uninstall')
{
return;
}
// Always uninstall these plugins
if (isset($this->uninstallPlugins) && !empty($this->uninstallPlugins))
{
foreach ($this->uninstallPlugins as $pluginInfo)
{
try
{
$this->uninstallPlugin($pluginInfo[1], $pluginInfo[0]);
}
catch (Exception $e)
{
// No op.
}
}
}
// Joomla 3: Always uninstall plg_console_akeebabackup (it's J4 only)
if (version_compare(JVERSION, '3.999.999', 'le'))
{
$this->uninstallPlugin('console', 'akeebabackup');
// These dependencies are not removed when uninstalling a plugin while installing a package (thanks, Joomla)
$this->removeDependency('fof30', 'plg_console_akeebabackup');
$this->removeDependency('fof40', 'plg_console_akeebabackup');
}
// Always enable these extensions
if (isset($this->extensionsToAlwaysEnable) && !empty($this->extensionsToAlwaysEnable))
{
$this->enableExtensions($this->extensionsToAlwaysEnable);
}
// Joomla 4: Always enable the plg_console_akeebabackup plugin
if (version_compare(JVERSION, '3.999.999', 'gt'))
{
$this->enableExtensions([
['plugin', 'akeebabackup', 1, 'console'],
]);
}
/**
* Try to install FEF. We only need to do this in postflight. A failure, while detrimental to the display of the
* extension, is non-fatal to the installation and can be rectified by manual installation of the FEF package.
* We can't use a <file> tag in our package manifest because FEF's package is *supposed* to fail to install if
* a newer version is already installed. This would unfortunately cancel the installation of the entire package,
* so we have to get a bit tricky.
*/
$this->installOrUpdateFEF($parent);
/**
* Clean the cache after installing the package.
*
* See bug report https://github.com/joomla/joomla-cms/issues/16147
*/
$conf = \JFactory::getConfig();
$clearGroups = array('_system', 'com_modules', 'mod_menu', 'com_plugins', 'com_modules');
$cacheClients = array(0, 1);
foreach ($clearGroups as $group)
{
foreach ($cacheClients as $client_id)
{
try
{
$options = array(
'defaultgroup' => $group,
'cachebase' => ($client_id) ? JPATH_ADMINISTRATOR . '/cache' : $conf->get('cache_path', JPATH_SITE . '/cache')
);
/** @var JCache $cache */
$cache = \JCache::getInstance('callback', $options);
$cache->clean();
}
catch (Exception $exception)
{
$options['result'] = false;
}
// Trigger the onContentCleanCache event.
try
{
JFactory::getApplication()->triggerEvent('onContentCleanCache', $options);
}
catch (Exception $e)
{
// Suck it up
}
}
}
}
/**
* Runs on installation (but not on upgrade). This happens in install and discover_install installation routes.
*
* @param \JInstallerAdapterPackage $parent Parent object
*
* @return bool
*/
public function install($parent)
{
// Enable the extensions we need to install
$this->enableExtensions();
return true;
}
/**
* Runs on uninstallation
*
* @param \JInstallerAdapterPackage $parent Parent object
*
* @return bool
*/
public function uninstall($parent)
{
// Preload FOF classes required for the InstallScript. This is required since we'll be trying to uninstall FOF
// before uninstalling the component itself. The component has an uninstallation script which uses FOF, so...
@include_once(JPATH_LIBRARIES . '/fof40/include.php');
class_exists('FOF40\\Utils\\InstallScript\\BaseInstaller', true);
class_exists('FOF40\\Utils\\InstallScript\\Component', true);
class_exists('FOF40\\Utils\\InstallScript\\Module', true);
class_exists('FOF40\\Utils\\InstallScript\\Plugin', true);
class_exists('FOF40\\Utils\\InstallScript', true);
class_exists('FOF40\\Database\\Installer', true);
/**
* uninstall() is called before the component is uninstalled. Therefore there is a dependency to FOF 4 which
* prevents FOF 4 from being removed at this point. Therefore we have to remove the dependency before removing
* the component and hope nothing goes wrong.
*/
$this->removeDependency('fof40', $this->componentName);
/**
* uninstall() is called before the component is uninstalled. Therefore there is a dependency to FEF which
* prevents FEF from being removed at this point. Therefore we have to remove the dependency before removing
* the component and hope nothing goes wrong.
*/
$this->removeDependency('file_fef', $this->componentName);
// The try to uninstall FEF. The uninstallation might fail if there are other extensions depending
// on it. That would cause the entire package uninstallation to fail, hence the need for special handling.
$this->uninstallFEF($parent);
// Then try to uninstall the FOF library. The uninstallation might fail if there are other extensions depending
// on it. That would cause the entire package uninstallation to fail, hence the need for special handling.
$this->uninstallFOF($parent);
return true;
}
/**
* Tries to install or update FOF. The FOF library package installation can fail if there's a newer version
* installed. In this case we raise no error. If, however, the FOF library package installation failed AND we can
* not load FOF then we raise an error: this means that FOF installation really failed (e.g. unwritable folder) and
* we can't install this package.
*
* @param \JInstallerAdapterPackage $parent
*/
private function installOrUpdateFOF($parent)
{
// Get the path to the FOF package
$sourcePath = $parent->getParent()->getPath('source');
$sourcePackage = $sourcePath . '/lib_fof40.zip';
// Extract and install the package
$package = JInstallerHelper::unpack($sourcePackage);
$tmpInstaller = new JInstaller;
$error = null;
try
{
$installResult = $tmpInstaller->install($package['dir']);
}
catch (\Exception $e)
{
$installResult = false;
$error = $e->getMessage();
}
// Try to include FOF. If that fails then the FOF package isn't installed because its installation failed, not
// because we had a newer version already installed. As a result we have to abort the entire package's
// installation.
if (!defined('FOF40_INCLUDED') && !@include_once(JPATH_LIBRARIES . '/fof40/include.php'))
{
if (empty($error))
{
$error = JText::sprintf(
'JLIB_INSTALLER_ABORT_PACK_INSTALL_ERROR_EXTENSION',
JText::_('JLIB_INSTALLER_' . strtoupper($parent->get('route'))),
basename($sourcePackage)
);
}
throw new RuntimeException($error);
}
}
/**
* Try to uninstall the FOF library. We don't go through the Joomla! package uninstallation since we can expect the
* uninstallation of the FOF library to fail if other software depends on it.
*
* @param JInstallerAdapterPackage $parent
*/
private function uninstallFOF($parent)
{
// Check dependencies on FOF
$dependencyCount = count($this->getDependencies('fof40'));
if ($dependencyCount)
{
$msg = "<p>You have $dependencyCount extension(s) depending on this version of FOF. The package cannot be uninstalled unless these extensions are uninstalled first.</p>";
JLog::add($msg, JLog::WARNING, 'jerror');
return;
}
$tmpInstaller = new JInstaller;
$db = $parent->getParent()->getDbo();
$query = $db->getQuery(true)
->select('extension_id')
->from('#__extensions')
->where('type = ' . $db->quote('library'))
->where('element = ' . $db->quote('lib_fof40'));
$db->setQuery($query);
$id = $db->loadResult();
if (!$id)
{
return;
}
try
{
$tmpInstaller->uninstall('library', $id, 0);
}
catch (\Exception $e)
{
// We can expect the uninstallation to fail if there are other extensions depending on the FOF library.
}
}
/**
* Tries to install or update FEF. The FEF files package installation can fail if there's a newer version
* installed.
*
* @param \JInstallerAdapterPackage $parent
*/
private function installOrUpdateFEF($parent)
{
// Get the path to the FOF package
$sourcePath = $parent->getParent()->getPath('source');
$sourcePackage = $sourcePath . '/file_fef.zip';
// Extract and install the package
$package = JInstallerHelper::unpack($sourcePackage);
$tmpInstaller = new JInstaller;
$error = null;
try
{
$installResult = $tmpInstaller->install($package['dir']);
}
catch (\Exception $e)
{
$installResult = false;
$error = $e->getMessage();
}
}
/**
* Try to uninstall the FEF package. We don't go through the Joomla! package uninstallation since we can expect the
* uninstallation of the FEF library to fail if other software depends on it.
*
* @param JInstallerAdapterPackage $parent
*/
private function uninstallFEF($parent)
{
// Check dependencies on FOF
$dependencyCount = count($this->getDependencies('file_fef'));
if ($dependencyCount)
{
$msg = "<p>You have $dependencyCount extension(s) depending on this version of Akeeba FEF. The package cannot be uninstalled unless these extensions are uninstalled first.</p>";
JLog::add($msg, JLog::WARNING, 'jerror');
return;
}
$tmpInstaller = new JInstaller;
$db = $parent->getParent()->getDbo();
$query = $db->getQuery(true)
->select('extension_id')
->from('#__extensions')
->where('type = ' . $db->quote('file'))
->where('element = ' . $db->quote('file_fef'));
$db->setQuery($query);
$id = $db->loadResult();
if (!$id)
{
return;
}
try
{
$tmpInstaller->uninstall('file', $id, 0);
}
catch (\Exception $e)
{
// We can expect the uninstallation to fail if there are other extensions depending on the FOF library.
}
}
/**
* Enable modules and plugins after installing them
*/
private function enableExtensions($extensions = [])
{
if (empty($extensions))
{
$extensions = $this->extensionsToEnable;
}
foreach ($extensions as $ext)
{
$this->enableExtension($ext[0], $ext[1], $ext[2], $ext[3]);
}
}
/**
* Enable an extension
*
* @param string $type The extension type.
* @param string $name The name of the extension (the element field).
* @param integer $client The application id (0: Joomla CMS site; 1: Joomla CMS administrator).
* @param string $group The extension group (for plugins).
*/
private function enableExtension($type, $name, $client = 1, $group = null)
{
try
{
$db = JFactory::getDbo();
$query = $db->getQuery(true)
->update('#__extensions')
->set($db->qn('enabled') . ' = ' . $db->q(1))
->where('type = ' . $db->quote($type))
->where('element = ' . $db->quote($name));
}
catch (\Exception $e)
{
return;
}
switch ($type)
{
case 'plugin':
// Plugins have a folder but not a client
$query->where('folder = ' . $db->quote($group));
break;
case 'language':
case 'module':
case 'template':
// Languages, modules and templates have a client but not a folder
$client = JApplicationHelper::getClientInfo($client, true);
$query->where('client_id = ' . (int) $client->id);
break;
default:
case 'library':
case 'package':
case 'component':
// Components, packages and libraries don't have a folder or client.
// Included for completeness.
break;
}
try
{
$db->setQuery($query);
$db->execute();
}
catch (\Exception $e)
{
}
}
/**
* Get the dependencies for a package from the #__akeeba_common table
*
* @param string $package The package
*
* @return array The dependencies
*/
private function getDependencies($package)
{
$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select($db->qn('value'))
->from($db->qn('#__akeeba_common'))
->where($db->qn('key') . ' = ' . $db->q($package));
try
{
$dependencies = $db->setQuery($query)->loadResult();
$dependencies = json_decode($dependencies, true);
if (empty($dependencies))
{
$dependencies = array();
}
}
catch (Exception $e)
{
$dependencies = array();
}
return $dependencies;
}
/**
* Sets the dependencies for a package into the #__akeeba_common table
*
* @param string $package The package
* @param array $dependencies The dependencies list
*/
private function setDependencies($package, array $dependencies)
{
$db = JFactory::getDbo();
$query = $db->getQuery(true)
->delete('#__akeeba_common')
->where($db->qn('key') . ' = ' . $db->q($package));
try
{
$db->setQuery($query)->execute();
}
catch (Exception $e)
{
// Do nothing if the old key wasn't found
}
$object = (object)array(
'key' => $package,
'value' => json_encode($dependencies)
);
try
{
$db->insertObject('#__akeeba_common', $object, 'key');
}
catch (Exception $e)
{
// Do nothing if the old key wasn't found
}
}
/**
* Adds a package dependency to #__akeeba_common
*
* @param string $package The package
* @param string $dependency The dependency to add
*/
private function addDependency($package, $dependency)
{
$dependencies = $this->getDependencies($package);
if (!in_array($dependency, $dependencies))
{
$dependencies[] = $dependency;
$this->setDependencies($package, $dependencies);
}
}
/**
* Removes a package dependency from #__akeeba_common
*
* @param string $package The package
* @param string $dependency The dependency to remove
*/
private function removeDependency($package, $dependency)
{
$dependencies = $this->getDependencies($package);
if (in_array($dependency, $dependencies))
{
$index = array_search($dependency, $dependencies);
unset($dependencies[$index]);
$this->setDependencies($package, $dependencies);
}
}
/**
* Do I have a dependency for a package in #__akeeba_common
*
* @param string $package The package
* @param string $dependency The dependency to check for
*
* @return bool
*/
private function hasDependency($package, $dependency)
{
$dependencies = $this->getDependencies($package);
return in_array($dependency, $dependencies);
}
private function uninstallPlugin($folder, $element)
{
$db = Factory::getDbo();
// Does the plugin exist?
$query = $db->getQuery(true)
->select('*')
->from('#__extensions')
->where($db->qn('type') . ' = ' . $db->q('plugin'))
->where($db->qn('folder') . ' = ' . $db->q($folder))
->where($db->qn('element') . ' = ' . $db->q($element));
try
{
$result = $db->setQuery($query)->loadAssoc();
if (empty($result))
{
return;
}
$eid = $result['extension_id'];
}
catch (Exception $e)
{
return;
}
/**
* Here's a bummer. If you try to uninstall a plugin Joomla throws a nonsensical error message about the
* plugin's XML manifest missing -- after it has already uninstalled the plugin! This error causes the package
* installation to fail which results in the extension being installed BUT the database record of the package
* NOT being present which makes it impossible to uninstall.
*
* So I have to hack my way around it which is ugly but the only viable alternative :(
*/
try
{
// Safely delete the row in the extensions table
$row = JTable::getInstance('extension');
$row->load((int) $eid);
$row->delete($eid);
// Delete the plugin's files
$pluginPath = sprintf("%s/%s/%s", JPATH_PLUGINS, $folder, $element);
if (is_dir($pluginPath))
{
JFolder::delete($pluginPath);
}
// Delete the plugin's language files
$langFiles = [
sprintf("%s/language/en-GB/en-GB.plg_%s_%s.ini", JPATH_ADMINISTRATOR, $folder, $element),
sprintf("%s/language/en-GB/en-GB.plg_%s_%s.sys.ini", JPATH_ADMINISTRATOR, $folder, $element),
];
foreach ($langFiles as $file)
{
if (@is_file($file))
{
JFile::delete($file);
}
}
}
catch (Exception $e)
{
// I tried, I failed. Dear user, do NOT try to enable that old plugin. Bye!
}
}
}