drush advancedqueue:queue:process @queue (in a cron job).", [
+ '@queue' => $defaultValue,
+ ':queue_url' => '/admin/config/system/queues/jobs/' . urlencode($defaultValue ?? ''),
+ ]),
+ ];
+
+ $form['templates'] = [
+ '#type' => 'fieldset',
+ '#title' => $this->t('Templates'),
+ '#tree' => TRUE,
+ ];
+
+ $templatePath = $this->moduleHandler->getPath('os2forms_forloeb') . '/templates/os2forms-forloeb-notification-message-email-html.html.twig';
+ $defaultTemplate = file_exists($templatePath) ? file_get_contents($templatePath) : NULL;
+ $form['templates']['notification_email'] = [
+ '#type' => 'textarea',
+ '#rows' => 20,
+ '#required' => TRUE,
+ '#title' => $this->t('Email template'),
+ '#default_value' => $config->get('templates')['notification_email'] ?? $defaultTemplate,
+ '#description' => $this->t('HTML template for email notifications. If the template is a path, e.g. @templatePath, the template will be loaded from this path.', [
+ '@templatePath' => $templatePath,
+ ]),
+ ];
+
+ $templatePath = $this->moduleHandler->getPath('os2forms_forloeb') . '/templates/os2forms-forloeb-notification-message-pdf-html.html.twig';
+ $defaultTemplate = file_exists($templatePath) ? file_get_contents($templatePath) : NULL;
+ $form['templates']['notification_pdf'] = [
+ '#type' => 'textarea',
+ '#rows' => 20,
+ '#required' => TRUE,
+ '#title' => $this->t('PDF template'),
+ '#default_value' => $config->get('templates')['notification_pdf'] ?? $defaultTemplate,
+ '#description' => $this->t('HTML template for PDF notifications (digital post). If the template is a path, e.g. @templatePath, the template will be loaded from this path.', [
+ '@templatePath' => $templatePath,
+ ]),
+ ];
+
+ return parent::buildForm($form, $form_state);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function submitForm(array &$form, FormStateInterface $formState) {
+ $this->config(static::SETTINGS)
+ ->set('known_anonymous_roles', $formState->getValue('known_anonymous_roles'))
+ ->set('processing', $formState->getValue('processing'))
+ ->set('templates', $formState->getValue('templates'))
+ ->save();
+
+ parent::submitForm($form, $formState);
+ }
+
+}
diff --git a/modules/os2forms_forloeb/src/MaestroHelper.php b/modules/os2forms_forloeb/src/MaestroHelper.php
new file mode 100644
index 0000000..82c3912
--- /dev/null
+++ b/modules/os2forms_forloeb/src/MaestroHelper.php
@@ -0,0 +1,694 @@
+config = $configFactory->get(SettingsForm::SETTINGS);
+ $this->webformSubmissionStorage = $entityTypeManager->getStorage('webform_submission');
+ $this->queueStorage = $entityTypeManager->getStorage('advancedqueue_queue');
+
+ // The OS2Forms Digital Post (os2forms_digital_post) module may not be
+ // installed.
+ $this->digitalPostHelper = \Drupal::hasService(DigitalPostHelper::class)
+ ? \Drupal::service(DigitalPostHelper::class)
+ : NULL;
+ }
+
+ /**
+ * Implements hook_maestro_zero_user_notification().
+ */
+ public function maestroZeroUserNotification($templateMachineName, $taskMachineName, $queueID, $notificationType) {
+ $templateTask = MaestroEngine::getTemplateTaskByID($templateMachineName, $taskMachineName);
+ if (MaestroWebformInheritTask::isWebformTask($templateTask)) {
+ if ($inheritWebformUniqueId = ($templateTask['data'][MaestroWebformInheritTask::INHERIT_WEBFORM_UNIQUE_ID] ?? NULL)) {
+ if ($processID = (MaestroEngine::getProcessIdFromQueueId($queueID) ?: NULL)) {
+ if ($entityIdentifier = (self::getWebformSubmissionIdentifiersForProcess($processID)[$inheritWebformUniqueId] ?? NULL)) {
+ $submission = $this->webformSubmissionStorage->load($entityIdentifier['entity_id']);
+ if ($submission) {
+ $this->handleSubmissionNotification($notificationType, $submission, $templateTask, $queueID);
+ }
+ }
+ }
+ }
+ }
+ }
+
+ /**
+ * Get webform submission identifiers for a process.
+ *
+ * @param int $processID
+ * The Maestro Process ID.
+ *
+ * @return array
+ * The webform submission identifiers sorted ascendingly by creation time.
+ */
+ public static function getWebformSubmissionIdentifiersForProcess(int $processID): array {
+ // Get webform submissions in process.
+ $entityIdentifiers = array_filter(
+ MaestroEngine::getAllEntityIdentifiersForProcess($processID),
+ static fn (array $entityIdentifier) => 'webform_submission' === ($entityIdentifier['entity_type'] ?? NULL)
+ );
+
+ // Sort by entity ID.
+ uasort($entityIdentifiers, static fn (array $a, array $b) => ($b['entity_id'] ?? 0) <=> ($a['entity_id'] ?? 0));
+
+ return $entityIdentifiers;
+ }
+
+ /**
+ * Handle submission notification.
+ *
+ * Creates job for sending notification to assigned user.
+ *
+ * @param string $notificationType
+ * The notification type (one of the NOTIFICATION_* constannts).
+ * @param \Drupal\webform\WebformSubmissionInterface $submission
+ * The webform submission.
+ * @param array $templateTask
+ * The template task.
+ * @param int $maestroQueueID
+ * The Maestro queue ID.
+ *
+ * @see self::processJob()
+ */
+ private function handleSubmissionNotification(
+ string $notificationType,
+ WebformSubmissionInterface $submission,
+ array $templateTask,
+ int $maestroQueueID
+ ): ?Job {
+ $context = [
+ 'webform_submission' => $submission,
+ ];
+
+ try {
+ $job = Job::create(SendMeastroNotification::class, [
+ 'notificationType' => $notificationType,
+ 'templateTask' => $templateTask,
+ 'queueID' => $maestroQueueID,
+ 'submissionID' => $submission->id(),
+ 'webformID' => $submission->getWebform()->id(),
+ ]);
+
+ $queue = $this->loadQueue();
+ $queue->enqueueJob($job);
+ $context['@queue'] = $queue->id();
+ $this->notice('Job for sending notification added to the queue @queue.', $context + [
+ 'handler_id' => 'os2forms_forloeb',
+ 'operation' => 'notification queued for sending',
+ ]);
+
+ return $job;
+ }
+ catch (\Exception $exception) {
+ $this->error('Error creating job for sending notification: @message', $context + [
+ '@message' => $exception->getMessage(),
+ 'handler_id' => 'os2forms_forloeb',
+ 'operation' => 'notification failed',
+ 'exception' => $exception,
+ ]);
+
+ return NULL;
+ }
+ }
+
+ /**
+ * Process a job to send out a notification.
+ *
+ * @param \Drupal\advancedqueue\Job $job
+ * The job (created by handleSubmissionNotification)
+ *
+ * @see self::handleSubmissionNotification()
+ */
+ public function processJob(Job $job): JobResult {
+ $payload = $job->getPayload();
+ [
+ 'notificationType' => $notificationType,
+ 'templateTask' => $templateTask,
+ 'queueID' => $maestroQueueID,
+ 'submissionID' => $submissionID,
+ ] = $payload;
+
+ $submission = $this->webformSubmissionStorage->load($submissionID);
+
+ $this->sendNotification($notificationType, $submission, $templateTask, $maestroQueueID);
+
+ return JobResult::success();
+ }
+
+ /**
+ * Send notification.
+ *
+ * @param string $notificationType
+ * The notification type (one of the NOTIFICATION_* constannts).
+ * @param \Drupal\webform\WebformSubmissionInterface $submission
+ * The webform submission.
+ * @param array $templateTask
+ * The template task.
+ * @param int $maestroQueueID
+ * The Maestro queue ID.
+ */
+ private function sendNotification(
+ string $notificationType,
+ WebformSubmissionInterface $submission,
+ array $templateTask,
+ int $maestroQueueID
+ ) {
+ $context = [
+ 'webform_submission' => $submission,
+ ];
+
+ try {
+ $handlers = $submission->getWebform()->getHandlers();
+ foreach ($handlers as $handler) {
+ if (!($handler instanceof MaestroNotificationHandler)
+ || $handler->isDisabled()
+ || $handler->isExcluded()
+ || !$handler->isNotificationEnabled($notificationType)
+ ) {
+ continue;
+ }
+
+ [
+ 'content' => $content,
+ 'contentType' => $contentType,
+ 'recipient' => $recipient,
+ 'subject' => $subject,
+ 'taskUrl' => $taskUrl,
+ 'actionLabel' => $actionLabel,
+ ] = $this->renderNotification($submission, $handler->getHandlerId(), $notificationType, $templateTask, $maestroQueueID);
+
+ if ('email' === $contentType) {
+ $this->sendNotificationEmail($recipient, $subject, $content, $submission, $notificationType);
+ }
+ else {
+ $this->sendNotificationDigitalPost($recipient, $subject, $content, $taskUrl, $actionLabel, $submission, $notificationType);
+ }
+ }
+ }
+ catch (\Exception $exception) {
+ $this->error('Error sending notification: @message', $context + [
+ '@message' => $exception->getMessage(),
+ 'handler_id' => 'os2forms_forloeb',
+ 'operation' => 'notification failed',
+ 'exception' => $exception,
+ ]);
+ }
+ }
+
+ /**
+ * Load advanced queue used to process notification jobs.
+ *
+ * @return \Drupal\advancedqueue\Entity\QueueInterface
+ * The queue.
+ */
+ private function loadQueue(): QueueInterface {
+ $queueId = $this->config->get('processing')['queue'] ?? NULL;
+
+ if (NULL === $queueId) {
+ throw new RuntimeException('Cannot get queue ID');
+ }
+
+ $queue = $this->queueStorage->load($queueId);
+ if (NULL === $queue) {
+ throw new RuntimeException(sprintf('Cannot load queue %s', $queueId));
+ }
+
+ return $queue;
+ }
+
+ /**
+ * Send notification email.
+ *
+ * @param string $recipient
+ * The recipient.
+ * @param string $subject
+ * The subject.
+ * @param string $body
+ * The body.
+ * @param \Drupal\webform\WebformSubmissionInterface $submission
+ * The webform submission.
+ * @param string $notificationType
+ * The notification type (one of the NOTIFICATION_* constannts).
+ */
+ private function sendNotificationEmail(
+ string $recipient,
+ string $subject,
+ string $body,
+ WebformSubmissionInterface $submission,
+ string $notificationType
+ ): void {
+ try {
+ $message = [
+ 'subject' => $subject,
+ 'body' => $body,
+ 'html' => TRUE,
+ ];
+
+ $langcode = $this->languageManager->getCurrentLanguage()->getId();
+
+ $result = $this->mailManager->mail(
+ 'os2forms_forloeb',
+ 'notification',
+ $recipient,
+ $langcode,
+ $message
+ );
+
+ if (!$result['result']) {
+ throw new RuntimeException(sprintf('Error sending notification (%s) email to %s', $notificationType, $recipient));
+ }
+
+ $this->notice('Email notification (@type) sent to @recipient', [
+ '@type' => $notificationType,
+ 'webform_submission' => $submission,
+ '@recipient' => $recipient,
+ 'handler_id' => 'os2forms_forloeb',
+ 'operation' => 'notification sent',
+ ]);
+ }
+ catch (\Exception $exception) {
+ $this->error('Error sending email notification (@type): @message', [
+ '@type' => $notificationType,
+ '@message' => $exception->getMessage(),
+ 'webform_submission' => $submission,
+ 'handler_id' => 'os2forms_forloeb',
+ 'operation' => 'failed sending notification',
+ ]);
+ }
+ }
+
+ /**
+ * Send notification digital post.
+ *
+ * @param string $recipient
+ * The recipient.
+ * @param string $subject
+ * The subject.
+ * @param string $content
+ * The content.
+ * @param string $taskUrl
+ * The Maestro task URL.
+ * @param string $actionLabel
+ * The action label.
+ * @param \Drupal\webform\WebformSubmissionInterface $submission
+ * The webform submission.
+ * @param string $notificationType
+ * The notification type (one of the NOTIFICATION_* constannts).
+ */
+ private function sendNotificationDigitalPost(
+ string $recipient,
+ string $subject,
+ string $content,
+ string $taskUrl,
+ string $actionLabel,
+ WebformSubmissionInterface $submission,
+ string $notificationType
+ ): void {
+ if (NULL === $this->digitalPostHelper) {
+ throw new RuntimeException('Cannot send digital post. Module OS2Forms Digital Post (os2forms_digital_post) not installed.');
+ }
+
+ try {
+ $document = new Document(
+ $content,
+ Document::MIME_TYPE_PDF,
+ $subject . '.pdf'
+ );
+
+ $senderLabel = $subject;
+ $messageLabel = $subject;
+
+ $recipientLookupResult = $this->digitalPostHelper->lookupRecipient($recipient);
+ $actions = [
+ (new Action())
+ ->setActionCode(SF1601::ACTION_SELVBETJENING)
+ ->setEntryPoint((new EntryPoint())
+ ->setUrl($taskUrl)
+ )
+ ->setLabel($actionLabel),
+ ];
+
+ $message = $this->digitalPostHelper->getMeMoHelper()->buildMessage($recipientLookupResult, $senderLabel,
+ $messageLabel, $document, $actions);
+ $forsendelse = $this->digitalPostHelper->getForsendelseHelper()->buildForsendelse($recipientLookupResult,
+ $messageLabel, $document);
+ $this->digitalPostHelper->sendDigitalPost(
+ SF1601::TYPE_AUTOMATISK_VALG,
+ $message,
+ $forsendelse,
+ $submission
+ );
+
+ $this->notice('Digital post notification sent (@type)', [
+ '@type' => $notificationType,
+ 'webform_submission' => $submission,
+ 'handler_id' => 'os2forms_forloeb',
+ 'operation' => 'notification sent',
+ ]);
+ }
+ catch (\Exception $exception) {
+ $this->error('Error sending digital post notification (@type): @message', [
+ '@type' => $notificationType,
+ '@message' => $exception->getMessage(),
+ 'webform_submission' => $submission,
+ 'handler_id' => 'os2forms_forloeb',
+ 'operation' => 'failed sending notification',
+ ]);
+ }
+ }
+
+ /**
+ * Render notification.
+ *
+ * @param \Drupal\webform\WebformSubmissionInterface $submission
+ * The submission.
+ * @param string $handlerId
+ * The handler ID.
+ * @param string $notificationType
+ * The notification type (one of the NOTIFICATION_* constannts).
+ * @param array $templateTask
+ * The Maestro template task.
+ * @param int $maestroQueueID
+ * The Maestro queue ID.
+ * @param string|null $contentType
+ * Optional content type. If not set the content type will be compoted based
+ * on the recipient.
+ *
+ * @return array
+ * The rendered notification with keys
+ * - content
+ * - contentType
+ * - recipient
+ * - subject
+ * - taskUrl (for digital post)
+ * - actionLabel (for digital post)
+ *
+ * @see self::renderHtml()
+ */
+ public function renderNotification(WebformSubmissionInterface $submission, string $handlerId, string $notificationType, array $templateTask, int $maestroQueueID, string $contentType = NULL): array {
+ $handler = $submission->getWebform()->getHandler($handlerId);
+ $settings = $handler->getSettings();
+
+ $data = $submission->getData();
+ $recipientElement = $settings[MaestroNotificationHandler::NOTIFICATION][MaestroNotificationHandler::RECIPIENT_ELEMENT] ?? NULL;
+ // Handle os2forms_person_lookup element.
+ $recipient = $data[$recipientElement]['cpr_number']
+ // Simple element.
+ ?? $data[$recipientElement]
+ ?? NULL;
+
+ if ($notificationType === self::NOTIFICATION_ESCALATION) {
+ $recipient = $settings[MaestroNotificationHandler::NOTIFICATION][$notificationType][MaestroNotificationHandler::NOTIFICATION_RECIPIENT] ?? NULL;
+ }
+
+ if (NULL !== $recipient) {
+ // Lifted from MaestroEngine.
+ $maestroTokenData = [
+ 'maestro' => [
+ 'task' => $templateTask,
+ 'queueID' => $maestroQueueID,
+ ],
+ ];
+
+ $notificationSetting = $settings[MaestroNotificationHandler::NOTIFICATION][$notificationType] ?? NULL;
+ if (NULL === $notificationSetting) {
+ throw new RuntimeException(sprintf('Cannot get setting for %s notification', $notificationType));
+ }
+
+ $processValue = static fn (string $value) => $value;
+
+ // Handle a preview, i.e. not a real Maestro context.
+ if (empty($templateTask) || 0 === $maestroQueueID) {
+ $taskUrl = Url::fromRoute('os2forms_forloeb.meastro_notification.preview_message', ['message' => 'This is just a preview'])->toString(TRUE)->getGeneratedUrl();
+
+ $processValue = static function (string $value) use ($taskUrl) {
+ // Replace href="[maestro:task-url]" with href="«$taskUrl»".
+ $value = preg_replace('/href\s*=\s*["\']\[maestro:task-url\]["\']/', sprintf('href="%s"', htmlspecialchars($taskUrl)), $value);
+ $value = preg_replace('/\[(maestro:[^]]+)\]/', '[\1]', $value);
+
+ return $value;
+ };
+ }
+ else {
+ $taskUrl = TaskHandler::getHandlerURL($maestroQueueID);
+ }
+
+ $subject = $this->tokenManager->replace(
+ $processValue($notificationSetting[MaestroNotificationHandler::NOTIFICATION_SUBJECT]),
+ $submission,
+ $maestroTokenData
+ );
+
+ $content = $notificationSetting[MaestroNotificationHandler::NOTIFICATION_CONTENT];
+ if (isset($content['value'])) {
+ // Process tokens in content.
+ $content['value'] = $this->tokenManager->replace(
+ $processValue($content['value']),
+ $submission,
+ $maestroTokenData
+ );
+ }
+
+ $actionLabel = $this->tokenManager->replace($notificationSetting[MaestroNotificationHandler::NOTIFICATION_ACTION_LABEL], $submission);
+
+ if (NULL === $contentType) {
+ $contentType = filter_var($recipient, FILTER_VALIDATE_EMAIL) ? 'email' : 'pdf';
+ }
+
+ switch ($contentType) {
+ case 'email':
+ $content = $this->renderHtml($contentType, $subject, $content, $taskUrl, $actionLabel, $submission);
+ break;
+
+ case 'pdf':
+ $pdfContent = $this->renderHtml($contentType, $subject, $content, $taskUrl, $actionLabel, $submission);
+
+ // Get dompdf plugin from entity_print module.
+ /** @var \Drupal\entity_print\Plugin\EntityPrint\PrintEngine\PdfEngineBase $printer */
+ $printer = $this->entityPrintPluginManager->createInstance('dompdf');
+ $printer->addPage($pdfContent);
+ $content = $printer->getBlob();
+ break;
+
+ default:
+ throw new RuntimeException(sprintf('Invalid content type: %s', $contentType));
+ }
+
+ return [
+ 'content' => $content,
+ 'contentType' => $contentType,
+ 'recipient' => $recipient,
+ 'subject' => $subject,
+ 'taskUrl' => $taskUrl,
+ 'actionLabel' => $actionLabel,
+ ];
+ }
+
+ throw new RuntimeException();
+ }
+
+ /**
+ * Render HTML for a notification.
+ *
+ * @param string $type
+ * The notification content type ('email' or 'pdf').
+ * @param string $subject
+ * The subject.
+ * @param array $content
+ * The content.
+ * @param string $taskUrl
+ * The Maestro taks URL.
+ * @param string $actionLabel
+ * The action label.
+ * @param \Drupal\webform\WebformSubmissionInterface $submission
+ * The webform submission.
+ *
+ * @return string|MarkupInterface
+ * The rendered content.
+ */
+ private function renderHtml(
+ string $type,
+ string $subject,
+ array $content,
+ string $taskUrl,
+ string $actionLabel,
+ WebformSubmissionInterface $submission
+ ): string|MarkupInterface {
+ $template = $this->config->get('templates')['notification_' . $type] ?? NULL;
+ if (file_exists($template)) {
+ $template = file_get_contents($template) ?: NULL;
+ }
+ if (NULL === $template) {
+ $template = 'Missing or invalid template';
+ }
+
+ $build = [
+ '#type' => 'inline_template',
+ '#template' => $template,
+ '#context' => [
+ 'message' => [
+ 'subject' => $subject,
+ 'content' => $content,
+ ],
+ 'task_url' => $taskUrl,
+ 'action_label' => $actionLabel,
+ 'webform_submission' => $submission,
+ 'handler' => $this,
+ ],
+ ];
+
+ return Markup::create(trim((string) $this->webformThemeManager->renderPlain($build)));
+ }
+
+ /**
+ * Implements hook_mail().
+ */
+ public function mail(string $key, array &$message, array $params) {
+ switch ($key) {
+ case 'notification':
+ $message['subject'] = $params['subject'];
+ $message['body'][] = $params['body'];
+ if (isset($params['attachments'])) {
+ foreach ($params['attachments'] as $attachment) {
+ $message['params']['attachments'][] = $attachment;
+ }
+ }
+ break;
+ }
+ }
+
+ /**
+ * Implements hook_mail_alter().
+ */
+ public function mailAlter(array &$message) {
+ if (str_starts_with($message['id'], 'os2forms_forloeb')) {
+ if (isset($message['params']['html']) && $message['params']['html']) {
+ $message['headers']['Content-Type'] = 'text/html; charset=UTF-8; format=flowed';
+ }
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function log($level, $message, array $context = []): void {
+ $this->logger->log($level, $message, $context);
+ // @see https://www.drupal.org/node/3020595
+ if (isset($context['webform_submission']) && $context['webform_submission'] instanceof WebformSubmissionInterface) {
+ $this->submissionLogger->log($level, $message, $context);
+ }
+ }
+
+ /**
+ * Implements hook_maestro_can_user_execute_task_alter().
+ */
+ public function maestroCanUserExecuteTaskAlter(bool &$returnValue, int $queueID, int $userID): void {
+ // Perform our checks only if an anonymous user has been barred access.
+ if (0 === $userID && FALSE === $returnValue) {
+ $templateTask = MaestroEngine::getTemplateTaskByQueueID($queueID);
+ if (isset($templateTask['assigned'])) {
+ $assignments = explode(',', $templateTask['assigned']);
+
+ // Check if one of the assignments match our known anonymous roles.
+ $knownAnonymousAssignments = array_map(
+ static fn(string $role) => 'role:fixed:' . $role,
+ array_filter($this->config->get('known_anonymous_roles') ?: [])
+ );
+
+ foreach ($assignments as $assignment) {
+ if (in_array($assignment, $knownAnonymousAssignments, TRUE)) {
+ $returnValue = TRUE;
+ }
+ }
+ }
+ }
+ }
+
+}
diff --git a/modules/os2forms_forloeb/src/Plugin/AdvancedQueue/JobType/SendMeastroNotification.php b/modules/os2forms_forloeb/src/Plugin/AdvancedQueue/JobType/SendMeastroNotification.php
new file mode 100644
index 0000000..8968e03
--- /dev/null
+++ b/modules/os2forms_forloeb/src/Plugin/AdvancedQueue/JobType/SendMeastroNotification.php
@@ -0,0 +1,55 @@
+get(MaestroHelper::class)
+ );
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function __construct(
+ array $configuration,
+ $plugin_id,
+ $plugin_definition,
+ private readonly MaestroHelper $helper
+ ) {
+ parent::__construct($configuration, $plugin_id, $plugin_definition);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function process(Job $job): JobResult {
+ return $this->helper->processJob($job);
+ }
+
+}
diff --git a/modules/os2forms_forloeb/src/Plugin/EngineTasks/MaestroWebformInheritTask.php b/modules/os2forms_forloeb/src/Plugin/EngineTasks/MaestroWebformInheritTask.php
index b33bf4b..b04137c 100644
--- a/modules/os2forms_forloeb/src/Plugin/EngineTasks/MaestroWebformInheritTask.php
+++ b/modules/os2forms_forloeb/src/Plugin/EngineTasks/MaestroWebformInheritTask.php
@@ -3,14 +3,10 @@
namespace Drupal\os2forms_forloeb\Plugin\EngineTasks;
use Drupal\Core\Form\FormStateInterface;
-use Drupal\Core\Url;
use Drupal\maestro\Engine\MaestroEngine;
-use Drupal\maestro\Form\MaestroExecuteInteractive;
use Drupal\maestro_webform\Plugin\EngineTasks\MaestroWebformTask;
use Drupal\webform\Entity\WebformSubmission;
-use Drupal\webform\WebformSubmissionForm;
-use Drupal\webform\WebformSubmissionInterface;
-use Symfony\Component\HttpFoundation\RedirectResponse;
+use Drupal\webform\Utility\WebformArrayHelper;
/**
* Maestro Webform Task Plugin for Multiple Submissions.
@@ -21,6 +17,7 @@
* )
*/
class MaestroWebformInheritTask extends MaestroWebformTask {
+ public const INHERIT_WEBFORM_UNIQUE_ID = 'inherit_webform_unique_id';
/**
* Constructor.
@@ -65,25 +62,71 @@ public function getPluginId() {
* {@inheritDoc}
*/
public function getTaskEditForm(array $task, $templateMachineName) {
+ // Get all webform tasks in template excluding the current task.
+ $template = MaestroEngine::getTemplate($templateMachineName);
+ $webformTasks = array_filter(
+ $template->tasks,
+ static fn(array $t) => $t['id'] !== $task['id'] && self::isWebformTask($t)
+ );
+ // Index by tasks' unique id.
+ $webformTasksByUniqueId = [];
+ foreach ($webformTasks as $id => $webformTask) {
+ $webformTasksByUniqueId[$webformTask['data']['unique_id'] ?? $id] = $webformTask;
+ }
// We call the parent, as we need to add a field to the inherited form.
$form = parent::getTaskEditForm($task, $templateMachineName);
- $form['inherit_webform_unique_id'] = [
- '#type' => 'textfield',
+ $form[self::INHERIT_WEBFORM_UNIQUE_ID] = [
+ '#type' => 'select',
+ '#options' => ['submission' => $this->t('Start')]
+ + array_map(
+ static fn(array $task) => sprintf('%s (%s)', $task['label'], $task['data']['unique_id'] ?? $task['id']),
+ $webformTasksByUniqueId
+ ),
'#title' => $this->t('Inherit Webform from:'),
'#description' => $this->t('Put the unique identifier of the webform you want to inherit from (start-task=submission'),
- '#default_value' => $task['data']['inherit_webform_unique_id'] ?? '',
+ '#default_value' => $task['data'][self::INHERIT_WEBFORM_UNIQUE_ID] ?? '',
'#required' => TRUE,
+ '#empty_option' => $this->t('Select task'),
];
- $form['inherit_webform_create_submission'] = [
- '#type' => 'checkbox',
- '#title' => $this->t('Create submission'),
- '#description' => $this->t('Create submission'),
- '#default_value' => $task['data']['inherit_webform_create_submission'] ?? FALSE,
- ];
return $form;
}
+ /**
+ * {@inheritdoc}
+ */
+ public function getAssignmentsAndNotificationsForm(array $task, $templateMachineName) {
+ $form = parent::getAssignmentsAndNotificationsForm($task, $templateMachineName);
+
+ // @todo Find task by unique_id = $task['data']['inherit_webform_unique_id'] and point to webform.
+ $anonymousNotificationMessage = $this->t('Add a Meastro notification handler to the webform for the task selected under %inherit_webform_from', [
+ '%inherit_webform_from' => $this->t('Inherit Webform from:'),
+ ]);
+
+ WebformArrayHelper::insertBefore(
+ $form['edit_task_notifications'], 'token_tree',
+ 'anonymous_notification_message',
+ [
+ '#theme' => 'status_messages',
+ '#message_list' => [
+ 'status' => [$anonymousNotificationMessage],
+ ],
+ ]
+ );
+
+ return $form;
+ }
+
+ /**
+ * Deside if a task is a webform task.
+ */
+ public static function isWebformTask(array $task): bool {
+ return in_array($task['tasktype'] ?? NULL, [
+ 'MaestroWebform',
+ 'MaestroWebformInherit',
+ ], TRUE);
+ }
+
/**
* {@inheritDoc}
*/
@@ -92,157 +135,51 @@ public function prepareTaskForSave(array &$form, FormStateInterface $form_state,
// Inherit from parent.
parent::prepareTaskForSave($form, $form_state, $task);
// Add custom field(s) to the inherited prepareTaskForSave method.
- $task['data']['inherit_webform_unique_id'] = $form_state->getValue('inherit_webform_unique_id');
- $task['data']['inherit_webform_create_submission'] = $form_state->getValue('inherit_webform_create_submission');
+ $task['data'][self::INHERIT_WEBFORM_UNIQUE_ID] = $form_state->getValue(self::INHERIT_WEBFORM_UNIQUE_ID);
}
/**
- * {@inheritDoc}
+ * Implements hook_webform_submission_form_alter().
*/
- public function getExecutableForm($modal, MaestroExecuteInteractive $parent) {
-
- // First, get hold of the interesting previous tasks.
- $templateMachineName = MaestroEngine::getTemplateIdFromProcessId($this->processID);
- $taskMachineName = MaestroEngine::getTaskIdFromQueueId($this->queueID);
- $task = MaestroEngine::getTemplateTaskByID($templateMachineName, $taskMachineName);
-
- // Get user input from 'inherit_webform_unique_id'.
- $webformInheritID = $task['data']['inherit_webform_unique_id'];
-
- // Load its corresponding webform submission.
- $sid = MaestroEngine::getEntityIdentiferByUniqueID($this->processID, $webformInheritID);
- if ($sid) {
- $webform_submission = WebformSubmission::load($sid);
- }
- if (!isset($webform_submission)) {
- \Drupal::logger('os2forms_forloeb')->error(
- "Predecessors must have submissions with webforms attached."
- );
- return FALSE;
- }
- // Copy the fields of the webform submission to the values array.
- foreach ($webform_submission->getData() as $key => $value) {
- if ($value) {
- $field_values[$key] = $value;
- }
- }
- // Now create webform submission, submit and attach to current process.
- $templateTask = MaestroEngine::getTemplateTaskByQueueID($this->queueID);
- $webformMachineName = $templateTask['data']['webform_machine_name'];
-
- $values = [];
- $values['webform_id'] = $webformMachineName;
- $values['data'] = $field_values;
-
- $createSubmission = (bool) ($task['data']['inherit_webform_create_submission'] ?? FALSE);
- if ($createSubmission) {
- // Create submission.
- $new_submission = WebformSubmission::create($values);
-
- // Submit the webform submission.
- $submission = WebformSubmissionForm::submitWebformSubmission($new_submission);
-
- // WebformSubmissionForm::submitWebformSubmission returns an array
- // if the submission is not valid.
- if (is_array($submission)) {
- \Drupal::logger('os2forms_forloeb')->error(
- "Can't create new submission: " . json_encode($submission)
- );
- \Drupal::messenger()->addError('Webform data is invalid and could not be submitted.');
- return FALSE;
- }
-
- $taskUniqueSubmissionId = $templateTask['data']['unique_id'];
-
- // Attach it to the Maestro process.
- $sid = $new_submission->id();
- MaestroEngine::createEntityIdentifier(
- $this->processID, $new_submission->getEntityTypeId(),
- $new_submission->bundle(), $taskUniqueSubmissionId, $sid
- );
-
- // Important: Apparently the form must be generated after calling
- // MaestroEngine::createEntityIdentifier for this to work.
- $form = parent::getExecutableForm($modal, $parent);
- // Catch os2forms-forloeb access token and pass it further.
- if ($form instanceof RedirectResponse && $token = \Drupal::request()->query->get('os2forms-forloeb-ws-token')) {
- // Check token to previous submission and update it to new one.
- if ($token === $webform_submission->getToken()) {
- $token = $new_submission->getToken();
- $url = Url::fromUserInput($form->getTargetUrl(), ['query' => ['os2forms-forloeb-ws-token' => $token]]);
- $form = new RedirectResponse($url->toString());
+ public static function webformSubmissionFormAlter(array &$form, FormStateInterface $formState, string $formId) {
+ // @todo Clean up and align with MaestroHelper::maestroZeroUserNotification().
+ if ($queueID = self::getQueueIdFromRequest()) {
+ $templateTask = MaestroEngine::getTemplateTaskByQueueID($queueID);
+ if (self::isWebformTask($templateTask)) {
+ if ($inheritWebformUniqueId = ($templateTask['data'][self::INHERIT_WEBFORM_UNIQUE_ID] ?? NULL)) {
+ $processID = MaestroEngine::getProcessIdFromQueueId($queueID);
+ $entityIdentifier = MaestroEngine::getAllEntityIdentifiersForProcess($processID)[$inheritWebformUniqueId] ?? NULL;
+ if ('webform_submission' === ($entityIdentifier['entity_type'] ?? NULL)) {
+ $submission = WebformSubmission::load($entityIdentifier['entity_id']);
+ $data = $submission->getData();
+ foreach ($data as $key => $value) {
+ if (isset($form['elements'][$key])) {
+ $form['elements'][$key]['#default_value'] = $value;
+ }
+ }
+ }
}
}
}
- else {
- // Store values in session.
- $values['processID'] = $this->processID;
- $values['queueID'] = $this->queueID;
- $values['webformInheritID'] = $webformInheritID;
-
- self::setTaskValues($this->queueID, $values);
-
- $form = parent::getExecutableForm($modal, $parent);
- }
-
- return $form;
}
/**
- * Implements hook_ENTITY_TYPE_prepare_form().
+ * Get Maestro queue ID from request.
*/
- public static function webformSubmissionPrepareForm(WebformSubmissionInterface $webformSubmission, string $operation, FormStateInterface $formState): void {
+ public static function getQueueIdFromRequest(): ?int {
+ $queueID = NULL;
$request = \Drupal::request();
- $isMaestro = (bool) $request->query->get('maestro', 0);
- $queueID = (int) $request->query->get('queueid', 0);
- if ($isMaestro && $queueID > 0) {
- $values = self::getTaskValues($queueID);
- if (isset($values['data'])) {
- foreach ($values['data'] as $name => $value) {
- $webformSubmission->setElementData($name, $value);
- }
+ if ($sitewideToken = \Drupal::service('config.factory')->get('maestro.settings')->get('maestro_sitewide_token')) {
+ $token = $request->query->get($sitewideToken);
+ if (is_string($token)) {
+ $queueID = MaestroEngine::getQueueIdFromToken($token);
}
}
- }
-
- /**
- * Get task values from session.
- *
- * @param int $queueID
- * The queue ID.
- *
- * @return array
- * The task values if any.
- */
- private static function getTaskValues($queueID) {
- $sessionKey = self::formatTaskValuesSessionKey($queueID);
- return \Drupal::request()->getSession()->get($sessionKey);
- }
-
- /**
- * Set task values in session.
- *
- * @param int $queueID
- * The queue ID.
- * @param array $values
- * The values.
- */
- private static function setTaskValues($queueID, array $values) {
- $sessionKey = self::formatTaskValuesSessionKey($queueID);
- \Drupal::request()->getSession()->set($sessionKey, $values);
- }
+ if (empty($queueID)) {
+ $queueID = $request->query->get('queueid');
+ }
- /**
- * Format task values session key.
- *
- * @param int $queueID
- * The queue ID.
- *
- * @return string
- * The formatted session key.
- */
- private static function formatTaskValuesSessionKey($queueID) {
- return sprintf('os2forms_forloeb_inherited_values_%s', $queueID);
+ return (int) $queueID ?: NULL;
}
}
diff --git a/modules/os2forms_forloeb/src/Plugin/WebformHandler/MaestroNotificationHandler.php b/modules/os2forms_forloeb/src/Plugin/WebformHandler/MaestroNotificationHandler.php
new file mode 100644
index 0000000..d0afc20
--- /dev/null
+++ b/modules/os2forms_forloeb/src/Plugin/WebformHandler/MaestroNotificationHandler.php
@@ -0,0 +1,290 @@
+loggerFactory = $container->get('logger.factory');
+ $instance->configFactory = $container->get('config.factory');
+ $instance->renderer = $container->get('renderer');
+ $instance->entityTypeManager = $container->get('entity_type.manager');
+ $instance->conditionsValidator = $container->get('webform_submission.conditions_validator');
+
+ $instance->setConfiguration($configuration);
+
+ return $instance;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getSummary() {
+ return [
+ 'info' => [
+ '#prefix' => '@token_maestro_task_url token which is the URL to the Maestro task.',
+ [
+ '@token_maestro_task_url' => self::TOKEN_MAESTRO_TASK_URL,
+ ]),
+ '#states' => $states(),
+ ];
+
+ $form[self::NOTIFICATION][$notificationType][self::NOTIFICATION_ACTION_LABEL] = [
+ '#type' => 'textfield',
+ '#title' => $this->t('Action label'),
+ '#default_value' => $this->configuration[self::NOTIFICATION][$notificationType][self::NOTIFICATION_ACTION_LABEL] ?? NULL,
+ '#description' => $this->t('Label of the action in digital post'),
+ '#states' => $states(required: FALSE),
+ ];
+ }
+
+ return $this->setSettingsParents($form);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function validateConfigurationForm(array &$form, FormStateInterface $formState) {
+ parent::validateConfigurationForm($form, $formState);
+
+ foreach ([
+ MaestroHelper::NOTIFICATION_ASSIGNMENT,
+ MaestroHelper::NOTIFICATION_REMINDER,
+ MaestroHelper::NOTIFICATION_ESCALATION,
+ ] as $notificationType) {
+ $key = [self::NOTIFICATION, $notificationType, self::NOTIFICATION_ENABLE];
+ $enabled = $formState->getValue($key);
+ if (!$enabled) {
+ break;
+ }
+ $key = [self::NOTIFICATION, $notificationType, self::NOTIFICATION_CONTENT];
+ $content = $formState->getValue($key);
+ if (isset($content['value'])) {
+ $content = $content['value'];
+ }
+ if (!str_contains($content, self::TOKEN_MAESTRO_TASK_URL)) {
+ $formState->setErrorByName(
+ implode('][', [self::NOTIFICATION, self::NOTIFICATION_CONTENT]),
+ $this->t('The notification content must contain the @token_maestro_task_url token', [
+ '@token_maestro_task_url' => self::TOKEN_MAESTRO_TASK_URL,
+ ])
+ );
+ }
+ }
+ }
+
+ /**
+ * Get recipient elements.
+ */
+ private function getRecipientElements(): array {
+ $elements = $this->getWebform()->getElementsDecodedAndFlattened();
+
+ $elementTypes = [
+ 'email',
+ 'textfield',
+ 'cpr_element',
+ 'cpr_value_element',
+ 'cvr_element',
+ 'cvr_value_element',
+ 'os2forms_person_lookup',
+ ];
+ $elements = array_filter(
+ $elements,
+ static function (array $element) use ($elementTypes) {
+ return in_array($element['#type'], $elementTypes, TRUE);
+ }
+ );
+
+ return array_map(static function (array $element) {
+ return $element['#title'];
+ }, $elements);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function submitConfigurationForm(array &$form, FormStateInterface $formState) {
+ parent::submitConfigurationForm($form, $formState);
+
+ $this->configuration[self::NOTIFICATION] = $formState->getValue(self::NOTIFICATION);
+ }
+
+ /**
+ * Get all notification types.
+ */
+ public function getEnabledNotifications(): array {
+ $enabledNotificationTypes = [];
+
+ foreach ([
+ MaestroHelper::NOTIFICATION_ASSIGNMENT,
+ MaestroHelper::NOTIFICATION_REMINDER,
+ MaestroHelper::NOTIFICATION_ESCALATION,
+ ] as $notificationType) {
+ if ($this->configuration[self::NOTIFICATION][$notificationType][self::NOTIFICATION_ENABLE] ?? FALSE) {
+ $enabledNotificationTypes[$notificationType] = $notificationType;
+ }
+ }
+
+ return $enabledNotificationTypes;
+ }
+
+ /**
+ * Check if a notification type is enabled.
+ */
+ public function isNotificationEnabled(string $notificationType): bool {
+ return isset($this->getEnabledNotifications()[$notificationType]);
+ }
+
+}
diff --git a/modules/os2forms_forloeb/templates/os2forms-forloeb-notification-message-email-html.html.twig b/modules/os2forms_forloeb/templates/os2forms-forloeb-notification-message-email-html.html.twig
new file mode 100644
index 0000000..17e0f8e
--- /dev/null
+++ b/modules/os2forms_forloeb/templates/os2forms-forloeb-notification-message-email-html.html.twig
@@ -0,0 +1,35 @@
+{#
+/**
+ * @file
+ * Template for Maestro notification email.
+ *
+ * Available variables:
+ * - message: The notification message
+ * - subject: the notification subject
+ * - contect: the notification content. Must be rendered as `processed_text`, i.e.:
+ * @code
+ * {{ {
+ * '#type': 'processed_text',
+ * '#text': message.content.value,
+ * '#format': message.content.format,
+ * } }}
+ * @endcode
+ * - notification_type: The type of notification ()
+ * - task_url: URL of the task.
+ * - action_label: Optional label for the task action.
+ */
+#}
+