Your IP : 216.73.216.43
<?php
/**
* @package panopticon
* @copyright Copyright (c)2023-2024 Nicholas K. Dionysopoulos / Akeeba Ltd
* @license https://www.gnu.org/licenses/agpl-3.0.txt GNU Affero General Public License, version 3 or later
*/
namespace Akeeba\Panopticon\Task;
defined('AKEEBA') || die;
use Akeeba\Panopticon\Helper\Html2Text;
use Akeeba\Panopticon\Helper\LanguageListTrait;
use Akeeba\Panopticon\Library\Enumerations\CMSType;
use Akeeba\Panopticon\Library\Queue\QueueItem;
use Akeeba\Panopticon\Library\Queue\QueueTypeEnum;
use Akeeba\Panopticon\Library\Task\AbstractCallback;
use Akeeba\Panopticon\Library\Task\Attribute\AsTask;
use Akeeba\Panopticon\Library\Task\Status;
use Akeeba\Panopticon\Model\Reports;
use Akeeba\Panopticon\Model\Site;
use Akeeba\Panopticon\Task\Trait\ApiRequestTrait;
use Akeeba\Panopticon\Task\Trait\EmailSendingTrait;
use Akeeba\Panopticon\Task\Trait\JsonSanitizerTrait;
use Akeeba\Panopticon\Task\Trait\SaveSiteTrait;
use Akeeba\Panopticon\Task\Trait\SiteNotificationEmailTrait;
use Akeeba\Panopticon\View\Mailtemplates\Html;
use Awf\Registry\Registry;
use Exception;
use GuzzleHttp\Exception\GuzzleException;
use GuzzleHttp\RequestOptions;
use RuntimeException;
#[AsTask(name: 'extensionsupdate', description: 'PANOPTICON_TASKTYPE_EXTENSIONSUPDATE')]
class ExtensionsUpdate extends AbstractCallback
{
use ApiRequestTrait;
use SiteNotificationEmailTrait;
use EmailSendingTrait;
use LanguageListTrait;
use JsonSanitizerTrait;
use SaveSiteTrait;
public function __invoke(object $task, Registry $storage): int
{
// Get the site object
/** @var Site $site */
$site = $this->container->mvcFactory->makeTempModel('Site');
$site->findOrFail($task->site_id);
if ($site->cmsType() !== CMSType::JOOMLA)
{
throw new RuntimeException('This is not a Joomla site!');
}
$this->logger->pushLogger($this->container->loggerFactory->get($this->name . '.' . $site->id));
// Get the queue
$queueKey = sprintf(QueueTypeEnum::EXTENSIONS->value, $task->site_id);
$queue = $this->container->queueFactory->makeQueue($queueKey);
$item = $queue->pop();
// It is possible for this to happen if another process snatched the last item of the queue before we did.
if ($item === null)
{
$this->logger->info(
sprintf(
'Extension updates for site #%d (%s): Queue empty, done installing updates',
$site->id, $site->name
)
);
// Email say we are done
$this->enqueueResultsEmail($site, $storage);
// Reload the update information from the site (you never know…)
$this->reloadExtensionInformation($site);
/**
* DO NOT REMOVE THIS CHECK - THIS IS A CONCURRENCY SANITY CHECK
*
* It is possible that there were no items in the queue when we tried to pop an item. However, between then
* and now we've done a fair amount of work which gives enough time for another process to enqueue a new
* item. In this case we don't want to return OK; we want to return WILL_RESUME instead.
*/
if ($queue->count() === 0)
{
return Status::OK->value;
}
$this->logger->info(
sprintf(
'Extension updates for site #%d (%s): Queue item added before marking ourselves done; will resume installing updates later.',
$site->id, $site->name
)
);
return Status::WILL_RESUME->value;
}
// Tell the site to install the update.
$this->installUpdate($site, $item, $storage);
return Status::WILL_RESUME->value;
}
private function installUpdate(Site $site, QueueItem $item, Registry $storage): void
{
$updateStatus = (array) $storage->get('updateStatus', []);
// This is the extension ID we are asked to install
$data = $item->getData();
if (is_object($item->getData()))
{
// This handles legacy data which might be in the database. Eventually, it can be removed.
$extensionId = (int) ($data->id ?? 0);
$updateMode = $data->mode ?? 'update';
$initiatingUser = $data->initiatingUser ?? 0;
}
else
{
$extensionId = (int) $item->getData();
$updateMode = 'update';
$initiatingUser = 0;
}
if (empty($extensionId) || $extensionId <= 0)
{
$this->logger->warning(
sprintf(
'Extension updates for site #%d (%s): invalid extension ID “%d” will be ignored',
$site->id, $site->name, $extensionId
)
);
return;
}
// Try to get the extension information from the site's config
$siteConfig = $site->getConfig() ?? new Registry();
$extensions = (array) $siteConfig->get('extensions.list');
if (!isset($extensions[$extensionId]))
{
$this->logger->warning(
sprintf(
'Extension updates for site #%d (%s): extension ID “%d” does not exist and will be ignored',
$site->id, $site->name, $extensionId
)
);
return;
}
// Record the "last seen" new version in the site's configuration.
$this->recordLastSeenVersion($site, $extensionId);
if ($updateMode === 'email')
{
$this->logger->info(
sprintf(
'Extension updates for site #%d (%s): will notify by email for %s “%s” (EID: %d). The update will NOT be installed automatically.',
$site->id, $site->name, $extensions[$extensionId]->type, $extensions[$extensionId]->name,
$extensionId
)
);
// Enqueue update email
$this->enqueueUpdateEmail($site, $extensions[$extensionId]);
return;
}
// Log that we are about to install an update
$this->logger->info(
sprintf(
'Extension updates for site #%d (%s): attempting to install update for %s “%s” (EID: %d)',
$site->id, $site->name, $extensions[$extensionId]->type, $extensions[$extensionId]->name, $extensionId
)
);
// Cache the versions; we use them in reports
$oldVersion = $extensions[$extensionId]->version?->current;
$newVersion = $extensions[$extensionId]->version?->new;
// Send the HTTP request
$httpClient = $this->container->httpFactory->makeClient(cache: false);
[$url, $options] = $this->getRequestOptions($site, '/index.php/v1/panopticon/update');
$options = array_merge(
$options, [
RequestOptions::FORM_PARAMS => [
'eid' => [$extensionId],
],
]
);
try
{
$response = $httpClient->post($url, $options);
}
catch (GuzzleException $e)
{
$this->logger->error(
sprintf(
'Extension updates for site #%d (%s): failed installing update for %s “%s”. Guzzle error: %s',
$site->id, $site->name, $extensions[$extensionId]->type, $extensions[$extensionId]->name,
$e->getMessage()
)
);
$updateStatus[$extensionId] = [
'type' => $extensions[$extensionId]->type,
'name' => $extensions[$extensionId]->name,
'status' => 'exception',
'messages' => [$e->getMessage()],
];
$storage->set('updateStatus', $updateStatus);
// Log failed update report
$this->logReport(
$site,
$extensions[$extensionId],
$oldVersion,
$newVersion,
false,
$e,
$initiatingUser
);
return;
}
$rawJSONData = $this->sanitizeJson($response->getBody()->getContents());
try
{
$status = @json_decode($rawJSONData ?? '{}');
if (empty($status))
{
throw new \RuntimeException('No JSON object returned from the Joomla! API application.');
}
}
catch (Exception $e)
{
$this->logger->error(
sprintf(
'Extension updates for site #%d (%s): failed installing update for %s “%s”. Invalid JSON reply: %s',
$site->id, $site->name, $extensions[$extensionId]->type, $extensions[$extensionId]->name,
$response->getBody()
)
);
$updateStatus[$extensionId] = [
'type' => $extensions[$extensionId]->type,
'name' => $extensions[$extensionId]->name,
'status' => 'invalid_json',
'messages' => [$e->getMessage()],
];
$storage->set('updateStatus', $updateStatus);
// Log failed update report
$this->logReport(
$site,
$extensions[$extensionId],
$oldVersion,
$newVersion,
false,
$e,
$initiatingUser
);
return;
}
// Try to get the returned data.
$returnedDataArray = $status?->data ?? [];
$returnedDataZeroElement = is_array($returnedDataArray) ? ($returnedDataArray[0] ?? null) : null;
$returnedAttributes = $returnedDataZeroElement?->attributes ?? null;
// This should never happen, really.
if (!is_object($returnedAttributes))
{
$this->logger->error(
sprintf(
'Extension updates for site #%d (%s): failed installing update for %s “%s”. Joomla! returned invalid data',
$site->id, $site->name, $extensions[$extensionId]->type, $extensions[$extensionId]->name
),
[$rawJSONData]
);
$updateStatus[$extensionId] = [
'type' => $extensions[$extensionId]->type,
'name' => $extensions[$extensionId]->name,
'status' => 'error',
'messages' => [$rawJSONData ?? ''],
];
$storage->set('updateStatus', $updateStatus);
// Log failed update report
$this->logReport(
$site,
$extensions[$extensionId],
$oldVersion,
$newVersion,
false,
[
'invalidJson' => $rawJSONData,
],
$initiatingUser
);
return;
}
if (!($returnedAttributes?->status ?? 1))
{
$messages = $returnedAttributes?->messages ?? [];
$forImplode = array_filter(
array_map(
function ($message) {
if (is_string($message))
{
return $message;
}
if (is_array($message))
{
return $message['message'] ?? null;
}
if (is_object($message))
{
return $message->message ?? null;
}
return null;
},
$messages
)
);
$this->logger->error(
sprintf(
'Extension updates for site #%d (%s): failed installing update for %s “%s”. Joomla! reported an error: %s',
$site->id, $site->name, $extensions[$extensionId]->type, $extensions[$extensionId]->name,
implode(' • ', $forImplode)
),
(array) $status
);
$updateStatus[$extensionId] = [
'type' => $extensions[$extensionId]->type,
'name' => $extensions[$extensionId]->name,
'status' => 'error',
'messages' => $messages,
];
$storage->set('updateStatus', $updateStatus);
// Log failed update report
$this->logReport(
$site,
$extensions[$extensionId],
$oldVersion,
$newVersion,
false,
[
'messages' => $messages,
],
$initiatingUser
);
return;
}
$this->logger->debug(
sprintf(
'Extension updates for site #%d (%s): installed update for %s “%s”',
$site->id, $site->name, $extensions[$extensionId]->type, $extensions[$extensionId]->name
),
(array) $status
);
// Update extensions.list and extensions.hasUpdates in the site's config storage
$this->saveSite(
$site,
function (Site $site) use ($extensionId)
{
// Reload the site information, in case it changed while we were installing updates
$site->findOrFail($site->id);
// Get the extensions list
$siteConfig = $site->getConfig() ?? new Registry();;
$extensions = (array) $siteConfig->get('extensions.list');
// Make sure our updated extension didn't get uninstalled in the meantime
if (!isset($extensions[$extensionId]))
{
throw new \RuntimeException('The extension went away.');
}
// Mark the extension as not having updates
$extensions[$extensionId]->version->new = null;
$siteConfig->set('extensions.list', $extensions);
// Set a flag for the existence of updates
$hasUpdates = array_reduce(
$extensions,
function (bool $carry, object $item): int {
$current = $item?->version?->current;
$new = $item?->version?->new;
if ($carry || empty($current) || empty($new))
{
return $carry;
}
return version_compare($current, $new, 'lt');
},
false
);
$siteConfig->set('extensions.hasUpdates', $hasUpdates);
// Update the site's JSON config field
$site->config = $siteConfig->toString('JSON');
}
);
$updateStatus[$extensionId] = [
'type' => $extensions[$extensionId]->type,
'name' => $extensions[$extensionId]->name,
'status' => 'success',
'messages' => $returnedAttributes?->messages ?? [],
];
$storage->set('updateStatus', $updateStatus);
// Log successful update report
$this->logReport(
$site,
$extensions[$extensionId],
$oldVersion,
$newVersion,
true,
[
'messages' => $returnedAttributes?->messages ?? [],
],
$initiatingUser
);
}
/**
* Log an extension update installation report entry
*
* @param Site $site The site we are installing extension updates on
* @param object $extension The extension object being updated
* @param bool $status Did we succeed?
* @param mixed $e Additional context (on failure)
* @param int|null $initiatingUser The initiating user of this update installation
*
* @return void
* @since 1.0.4
*/
private function logReport(
Site $site, object $extension, string $oldVersion, string $newVersion, bool $status = true, mixed $e = null,
?int $initiatingUser = null
): void
{
$report = Reports::fromExtensionUpdateInstalled(
$site->id,
$this->container->mvcFactory->makeTempModel('Sysconfig')
->getExtensionShortname(
$extension->type, $extension->element, $extension->folder, $extension->client_id
),
$extension->name,
$oldVersion,
$newVersion,
$status,
$e
);
if ($initiatingUser !== null && $initiatingUser !== 0)
{
$report->created_by = $initiatingUser;
}
try
{
$report->save();
}
catch (\Throwable $e)
{
// Whatever...
}
}
/**
* Enqueue an email with the resilts of the update
*
* @param Site $site
* @param Registry $storage
*
* @return void
* @throws \Awf\Exception\App
* @since 1.0.0
*/
private function enqueueResultsEmail(Site $site, Registry $storage): void
{
// Render the messages as HTML
$updateStatus = (array) $storage->get('updateStatus', []);
if (empty($updateStatus))
{
// We did not do anything. No need to email the user to tell them we did sod all.
return;
}
$perLanguageVars = [];
foreach ($this->getAllKnownLanguages() as $language)
{
[$rendered, $renderedText] = $this->getRenderedResultsForEmail($language, $updateStatus, $site);
$perLanguageVars[$language] = [
'RENDERED_HTML' => $rendered,
'RENDERED_TEXT' => $renderedText,
];
}
$emailKey = 'extensions_update_done';
$variables = [
'SITE_NAME' => $site->name,
'SITE_URL' => $site->getBaseUrl(),
];
// Get the CC email addresses
$config = $site->getFieldValue('config', '{}');
$config = ($config instanceof Registry) ? $config->toString() : $config;
try
{
$config = @json_decode($config);
}
catch (Exception $e)
{
$config = null;
}
$cc = $this->getSiteNotificationEmails($config);
$data = new Registry();
$data->set('template', $emailKey);
$data->set('email_variables', $variables);
$data->set('email_variables_by_lang', $perLanguageVars);
$data->set('permissions', ['panopticon.super', 'panopticon.admin', 'panopticon.editown']);
$data->set('email_cc', $cc);
$this->enqueueEmail($data, $site->id, 'now');
}
private function enqueueUpdateEmail(Site $site, ?object $extension): void
{
$emailKey = 'extension_update_found';
$variables = [
'SITE_NAME' => $site->name,
'SITE_URL' => $site->getBaseUrl(),
'OLD_VERSION' => $extension?->version?->current,
'NEW_VERSION' => $extension?->version?->new,
'EXTENSION_TYPE' => $extension?->type,
'EXTENSION_NAME' => $extension?->name,
'EXTENSION_DESCRIPTION' => $extension?->description,
'EXTENSION_AUTHOR' => $extension?->author,
];
// Get the CC email addresses
$config = $site->getFieldValue('config', '{}');
$config = ($config instanceof Registry) ? $config->toString() : $config;
try
{
$config = @json_decode($config);
}
catch (Exception $e)
{
$config = null;
}
$data = new Registry();
$data->set('template', $emailKey);
$data->set('email_variables', $variables);
$data->set('permissions', ['panopticon.super', 'panopticon.admin', 'panopticon.editown']);
$data->set('email_cc', $this->getSiteNotificationEmails($config));
$this->enqueueEmail($data, $site->id, 'now');
}
private function reloadExtensionInformation(Site $site): void
{
$this->logger->info(
sprintf(
'Refreshing the extension update information for site #%d (%s)',
$site->id,
$site->name
)
);
$callback = $this->container->taskRegistry->get('refreshinstalledextensions');
$dummy = new \stdClass();
$dummyRegistry = new Registry();
$dummyRegistry->set('limitStart', 0);
$dummyRegistry->set('limit', 10);
$dummyRegistry->set('force', true);
$dummyRegistry->set('filter.ids', [$site->id]);
$return = $callback($dummy, $dummyRegistry);
}
/**
* Records the last seen newest version of an extension in a site's configuration.
*
* @param Site $site The site which the extension belongs to.
* @param int $extensionId The extension to record information for.
*
* @return void
*/
private function recordLastSeenVersion(Site $site, int $extensionId): void
{
$this->saveSite(
$site,
function (Site $site) use ($extensionId)
{
$siteConfig = $site->getConfig() ?? new Registry();
$lastSeenVersions = $siteConfig->get('director.extensionupdates.lastSeen', []) ?: [];
$lastSeenVersions = is_object($lastSeenVersions) ? (array) $lastSeenVersions : $lastSeenVersions;
$lastSeenVersions = is_array($lastSeenVersions) ? $lastSeenVersions : [];
$extensions = (array) $siteConfig->get('extensions.list');
$extensionItem = $extensions[$extensionId] ?? null;
$latestVersion = $extensionItem?->version?->new;
$lastSeenVersions[$extensionId] = $latestVersion;
$siteConfig->set('director.extensionupdates.lastSeen', $lastSeenVersions);
$site->setFieldValue('config', $siteConfig->toString());
}
);
}
/**
* @param string $language
* @param array $updateStatus
* @param Site $site
*
* @return array
* @throws \Awf\Exception\App
*/
private function getRenderedResultsForEmail(string $language, array $updateStatus, Site $site): array
{
$possibleTemplates = [
'Mailtemplates/mail_extensions_update_done.' . $language,
'Mailtemplates/mail_extensions_update_done',
];
$container = clone $this->container;
$container['mvc_config'] = [
'template_path' => [
APATH_ROOT . '/ViewTemplates/Mailtemplates',
APATH_USER_CODE . '/ViewTemplates/Mailtemplates',
],
];
$container->language->loadLanguage($language ?: $container->appConfig->get('language', 'en-GB'));
$fakeView = new Html($container);
$rendered = '';
foreach ($possibleTemplates as $template)
{
try
{
$rendered = $rendered ?: $fakeView->loadAnyTemplate(
$template,
[
'updateStatus' => $updateStatus,
'site' => $site,
]
);
}
catch (Exception $e)
{
// Expected, as the language override may not be in place.
}
}
// Render the messages as plain text
$possibleTemplates = [
'Mailtemplates/mail_extensions_update_done.' . $language . 'text',
'Mailtemplates/mail_extensions_update_done.text',
];
$renderedText = '';
foreach ($possibleTemplates as $template)
{
try
{
$renderedText = $renderedText ?: $fakeView->loadAnyTemplate(
$template,
[
'updateStatus' => $updateStatus,
'site' => $site,
]
);
}
catch (Exception $e)
{
// Expected, as the language override may not be in place.
}
}
// Fall back to automatic HTML to plain text conversion
if (empty($renderedText))
{
$renderedText = (new Html2Text($rendered))->getText();
}
return [$rendered, $renderedText];
}
}