first commit
This commit is contained in:
salam committed
commit
1218dd1517
12716 files changed
+989233
No files matched your search
@@ -0,0 +1,147 @@
|
||||
<?php
|
||||
namespace TYPO3\CMS\Reports\Task;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 CMS project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under
|
||||
* the terms of the GNU General Public License, either version 2
|
||||
* of the License, or any later version.
|
||||
*
|
||||
* For the full copyright and license information, please read the
|
||||
* LICENSE.txt file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
use TYPO3\CMS\Core\Localization\LanguageService;
|
||||
use TYPO3\CMS\Core\Mail\MailMessage;
|
||||
use TYPO3\CMS\Core\Registry;
|
||||
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
||||
use TYPO3\CMS\Reports\Status;
|
||||
use TYPO3\CMS\Scheduler\Task\AbstractTask;
|
||||
|
||||
/**
|
||||
* A task that should be run regularly to determine the system's status.
|
||||
* @internal This class is a specific scheduler task implementation and is not considered part of the Public TYPO3 API.
|
||||
*/
|
||||
class SystemStatusUpdateTask extends AbstractTask
|
||||
{
|
||||
/**
|
||||
* Email addresses to send email notification to in case we find problems with
|
||||
* the system.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $notificationEmail;
|
||||
|
||||
/**
|
||||
* Checkbox for to send all types of notification, not only problems
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $notificationAll = false;
|
||||
|
||||
/**
|
||||
* Executes the System Status Update task, determining the highest severity of
|
||||
* status reports and saving that to the registry to be displayed at login
|
||||
* if necessary.
|
||||
*
|
||||
* @see \TYPO3\CMS\Scheduler\Task\AbstractTask::execute()
|
||||
*/
|
||||
public function execute()
|
||||
{
|
||||
/** @var Registry $registry */
|
||||
$registry = GeneralUtility::makeInstance(Registry::class);
|
||||
/** @var \TYPO3\CMS\Reports\Report\Status\Status $statusReport */
|
||||
$statusReport = GeneralUtility::makeInstance(\TYPO3\CMS\Reports\Report\Status\Status::class);
|
||||
$systemStatus = $statusReport->getDetailedSystemStatus();
|
||||
$highestSeverity = $statusReport->getHighestSeverity($systemStatus);
|
||||
$registry->set('tx_reports', 'status.highestSeverity', $highestSeverity);
|
||||
if (($highestSeverity > Status::OK) || $this->getNotificationAll()) {
|
||||
$this->sendNotificationEmail($systemStatus);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the notification email addresses.
|
||||
*
|
||||
* @return string Notification email addresses.
|
||||
*/
|
||||
public function getNotificationEmail()
|
||||
{
|
||||
return $this->notificationEmail;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the notification email address.
|
||||
*
|
||||
* @param string $notificationEmail Notification email address.
|
||||
*/
|
||||
public function setNotificationEmail($notificationEmail)
|
||||
{
|
||||
$this->notificationEmail = $notificationEmail;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a notification email, reporting system issues.
|
||||
*
|
||||
* @param Status[] $systemStatus Array of statuses
|
||||
*/
|
||||
protected function sendNotificationEmail(array $systemStatus)
|
||||
{
|
||||
$systemIssues = [];
|
||||
foreach ($systemStatus as $statusProvider) {
|
||||
/** @var Status $status */
|
||||
foreach ($statusProvider as $status) {
|
||||
if ($this->getNotificationAll() || ($status->getSeverity() > Status::OK)) {
|
||||
$systemIssues[] = (string)$status . CRLF . $status->getMessage() . CRLF . CRLF;
|
||||
}
|
||||
}
|
||||
}
|
||||
$notificationEmails = GeneralUtility::trimExplode(LF, $this->notificationEmail, true);
|
||||
$sendEmailsTo = [];
|
||||
foreach ($notificationEmails as $notificationEmail) {
|
||||
$sendEmailsTo[] = $notificationEmail;
|
||||
}
|
||||
$subject = sprintf($this->getLanguageService()->getLL('status_updateTask_email_subject'), $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename']);
|
||||
$message = $this->getNotificationAll() ? $this->getLanguageService()->getLL('status_allNotification') : $this->getLanguageService()->getLL('status_problemNotification');
|
||||
$message .= CRLF . CRLF;
|
||||
$message .= $this->getLanguageService()->getLL('status_updateTask_email_site') . ': ' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
|
||||
$message .= CRLF . CRLF;
|
||||
$message .= $this->getLanguageService()->getLL('status_updateTask_email_issues') . ': ' . CRLF;
|
||||
$message .= implode(CRLF, $systemIssues);
|
||||
$message .= CRLF . CRLF;
|
||||
/** @var MailMessage $mail */
|
||||
$mail = GeneralUtility::makeInstance(MailMessage::class);
|
||||
$mail->setTo($sendEmailsTo);
|
||||
$mail->setSubject($subject);
|
||||
$mail->setBody($message);
|
||||
$mail->send();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function getNotificationAll(): bool
|
||||
{
|
||||
return $this->notificationAll;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param bool $notificationAll
|
||||
*/
|
||||
public function setNotificationAll(bool $notificationAll)
|
||||
{
|
||||
$this->notificationAll = $notificationAll;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return LanguageService
|
||||
*/
|
||||
protected function getLanguageService()
|
||||
{
|
||||
return $GLOBALS['LANG'];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,148 @@
|
||||
<?php
|
||||
namespace TYPO3\CMS\Reports\Task;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 CMS project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under
|
||||
* the terms of the GNU General Public License, either version 2
|
||||
* of the License, or any later version.
|
||||
*
|
||||
* For the full copyright and license information, please read the
|
||||
* LICENSE.txt file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
use TYPO3\CMS\Core\Localization\LanguageService;
|
||||
use TYPO3\CMS\Core\Messaging\FlashMessage;
|
||||
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
||||
use TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider;
|
||||
use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;
|
||||
use TYPO3\CMS\Scheduler\Task\AbstractTask;
|
||||
use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
|
||||
|
||||
/**
|
||||
* Additional field to set the notification email address(es) for system health
|
||||
* issue notifications.
|
||||
* @internal This class is a specific scheduler task implementation and is not considered part of the Public TYPO3 API.
|
||||
*/
|
||||
class SystemStatusUpdateTaskNotificationEmailField extends AbstractAdditionalFieldProvider
|
||||
{
|
||||
/**
|
||||
* Additional fields
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $fields = ['notificationEmail', 'notificationAll'];
|
||||
|
||||
/**
|
||||
* Field prefix.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $fieldPrefix = 'SystemStatusUpdate';
|
||||
|
||||
/**
|
||||
* Gets additional fields to render in the form to add/edit a task
|
||||
*
|
||||
* @param array $taskInfo Values of the fields from the add/edit task form
|
||||
* @param AbstractTask|null $task When editing, reference to the current task. NULL when adding.
|
||||
* @param SchedulerModuleController $schedulerModule Reference to the scheduler backend module
|
||||
* @return array A two dimensional array, array('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))
|
||||
*/
|
||||
public function getAdditionalFields(array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
|
||||
{
|
||||
$currentSchedulerModuleAction = $schedulerModule->getCurrentAction();
|
||||
|
||||
if ($currentSchedulerModuleAction->equals(Action::EDIT)) {
|
||||
$taskInfo[$this->fieldPrefix . 'NotificationEmail'] = $task->getNotificationEmail();
|
||||
$taskInfo[$this->fieldPrefix . 'NotificationAll'] = $task->getNotificationAll();
|
||||
}
|
||||
// build html for additional email field
|
||||
$fieldName = $this->getFullFieldName('notificationEmail');
|
||||
$fieldId = 'task_' . $fieldName;
|
||||
$fieldHtml = '<textarea class="form-control" ' . 'rows="5" cols="50" name="tx_scheduler[' . $fieldName . ']" ' . 'id="' . $fieldId . '" ' . '>' . htmlspecialchars($taskInfo[$fieldName]) . '</textarea>';
|
||||
|
||||
$additionalFields = [];
|
||||
$additionalFields[$fieldId] = [
|
||||
'code' => $fieldHtml,
|
||||
'label' => 'LLL:EXT:reports/Resources/Private/Language/locallang_reports.xlf:status_updateTaskField_notificationEmails',
|
||||
'cshKey' => '',
|
||||
'cshLabel' => $fieldId
|
||||
];
|
||||
|
||||
// build html for additional mail all checkbox field
|
||||
$fieldName = $this->getFullFieldName('notificationAll');
|
||||
$fieldId = 'task_' . $fieldName;
|
||||
$fieldHtml = '<input type="checkbox" name="tx_scheduler[' . $fieldName . ']" id="' . $fieldId . '" value="1"' . ($taskInfo[$fieldName] ? ' checked="checked"' : '') . '>';
|
||||
|
||||
$additionalFields[$fieldId] = [
|
||||
'code' => $fieldHtml,
|
||||
'label' => 'LLL:EXT:reports/Resources/Private/Language/locallang_reports.xlf:status_updateTaskField_notificationAll',
|
||||
'cshKey' => '',
|
||||
'cshLabel' => $fieldId
|
||||
];
|
||||
|
||||
return $additionalFields;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates the additional fields' values
|
||||
*
|
||||
* @param array $submittedData An array containing the data submitted by the add/edit task form
|
||||
* @param SchedulerModuleController $schedulerModule Reference to the scheduler backend module
|
||||
* @return bool TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
|
||||
*/
|
||||
public function validateAdditionalFields(array &$submittedData, SchedulerModuleController $schedulerModule)
|
||||
{
|
||||
$validInput = true;
|
||||
$notificationEmails = GeneralUtility::trimExplode(LF, $submittedData[$this->fieldPrefix . 'NotificationEmail'], true);
|
||||
foreach ($notificationEmails as $notificationEmail) {
|
||||
if (!GeneralUtility::validEmail($notificationEmail)) {
|
||||
$validInput = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!$validInput || empty($submittedData[$this->fieldPrefix . 'NotificationEmail'])) {
|
||||
$this->addMessage($this->getLanguageService()->sL('LLL:EXT:reports/Resources/Private/Language/locallang_reports.xlf:status_updateTaskField_notificationEmails_invalid'), FlashMessage::ERROR);
|
||||
$validInput = false;
|
||||
}
|
||||
return $validInput;
|
||||
}
|
||||
|
||||
/**
|
||||
* Takes care of saving the additional fields' values in the task's object
|
||||
*
|
||||
* @param array $submittedData An array containing the data submitted by the add/edit task form
|
||||
* @param AbstractTask $task Reference to the scheduler backend module
|
||||
* @throws \InvalidArgumentException
|
||||
*/
|
||||
public function saveAdditionalFields(array $submittedData, AbstractTask $task)
|
||||
{
|
||||
if (!$task instanceof SystemStatusUpdateTask) {
|
||||
throw new \InvalidArgumentException('Expected a task of type ' . SystemStatusUpdateTask::class . ', but got ' . get_class($task), 1295012802);
|
||||
}
|
||||
$task->setNotificationEmail($submittedData[$this->fieldPrefix . 'NotificationEmail']);
|
||||
$task->setNotificationAll(!empty($submittedData[$this->fieldPrefix . 'NotificationAll']));
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs the full field name which can be used in HTML markup.
|
||||
*
|
||||
* @param string $fieldName A raw field name
|
||||
* @return string Field name ready to use in HTML markup
|
||||
*/
|
||||
protected function getFullFieldName($fieldName)
|
||||
{
|
||||
return $this->fieldPrefix . ucfirst($fieldName);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return LanguageService
|
||||
*/
|
||||
protected function getLanguageService()
|
||||
{
|
||||
return $GLOBALS['LANG'];
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user