PKPNotificationOperationManager.inc.php

<?php
 
import('classes.notification.Notification');
import('lib.pkp.classes.notification.INotificationInfoProvider');
 
abstract class PKPNotificationOperationManager implements INotificationInfoProvider {
 
   //
   // Implement INotificationInfoProvider with default values.
   //
   function getNotificationUrl($request, $notification) {
      return null;
   }
 
   function getNotificationMessage($request, $notification) {
      return null;
   }
 
   function getNotificationContents($request, $notification) {
      return $this->getNotificationMessage($request, $notification);
   }
 
   function getNotificationTitle($notification) {
      return __('notification.notification');
   }
 
   function getStyleClass($notification) {
      return '';
   }
 
   function getIconClass($notification) {
      return '';
   }
 
   function isVisibleToAllUsers($notificationType, $assocType, $assocId) {
      return false;
   }
 
 
   //
   // Notification manager operations.
   //
   public function getFormattedNotificationsForUser($request, $userId, $level = NOTIFICATION_LEVEL_NORMAL, $contextId = null, $rangeInfo = null, $notificationTemplate = 'notification/notification.tpl') {
      $notificationDao = DAORegistry::getDAO('NotificationDAO'); /* @var $notificationDao NotificationDAO */
      $notifications = $notificationDao->getByUserId($userId, $level, null, $contextId, $rangeInfo);
 
      return $this->formatNotifications($request, $notifications, $notificationTemplate);
   }
 
   public function getParamsForCurrentLocale($params) {
      $locale = AppLocale::getLocale();
      $primaryLocale = AppLocale::getPrimaryLocale();
 
      $localizedParams = array();
      foreach ($params as $name => $value) {
         if (!is_array($value)) {
            // Non-localized text
            $localizedParams[$name] = $value;
         } elseif (isset($value[$locale])) {
            // Check if the parameter is in the user's current locale
            $localizedParams[$name] = $value[$locale];
         } elseif (isset($value[$primaryLocale])) {
            // Check if the parameter is in the default site locale
            $localizedParams[$name] = $value[$primaryLocale];
         } else {
            // Otherwise, iterate over all supported locales and return the first match
            $locales = AppLocale::getSupportedLocales();
            foreach ($locales as $localeKey) {
               if (isset($value[$localeKey])) {
                  $localizedParams[$name] = $value[$localeKey];
               }
            }
         }
      }
 
      return $localizedParams;
   }
 
   public function createNotification($request, $userId = null, $notificationType, $contextId = null, $assocType = null, $assocId = null, $level = NOTIFICATION_LEVEL_NORMAL, $params = null, $suppressEmail = false, callable $mailConfigurator = null) {
      $blockedNotifications = $this->getUserBlockedNotifications($userId, $contextId);
 
      if (!in_array($notificationType, $blockedNotifications)) {
         $notificationDao = DAORegistry::getDAO('NotificationDAO'); 
         $notification = $notificationDao->newDataObject(); 
         $notification->setUserId((int) $userId);
         $notification->setType((int) $notificationType);
         $notification->setContextId((int) $contextId);
         $notification->setAssocType((int) $assocType);
         $notification->setAssocId((int) $assocId);
         $notification->setLevel((int) $level);
 
         $notificationId = $notificationDao->insertObject($notification);
 
         // Send notification emails
         if ($notification->getLevel() != NOTIFICATION_LEVEL_TRIVIAL && !$suppressEmail) {
            $notificationEmailSettings = $this->getUserBlockedEmailedNotifications($userId, $contextId);
 
            if (!in_array($notificationType, $notificationEmailSettings)) {
               $this->sendNotificationEmail($request, $notification, $contextId, $mailConfigurator);
            }
         }
 
         if ($params) {
            $notificationSettingsDao = DAORegistry::getDAO('NotificationSettingsDAO'); /* @var $notificationSettingsDao NotificationSettingsDAO */
            foreach ($params as $name => $value) {
               $notificationSettingsDao->updateNotificationSetting($notificationId, $name, $value);
            }
         }
 
         return $notification;
      }
   }
 
   public function createTrivialNotification($userId, $notificationType = NOTIFICATION_TYPE_SUCCESS, $params = null) {
      $notificationDao = DAORegistry::getDAO('NotificationDAO'); /* @var $notificationDao NotificationDAO */
      $notification = $notificationDao->newDataObject();
      $notification->setUserId($userId);
      $notification->setContextId(CONTEXT_ID_NONE);
      $notification->setType($notificationType);
      $notification->setLevel(NOTIFICATION_LEVEL_TRIVIAL);
 
      $notificationId = $notificationDao->insertObject($notification);
 
      if ($params) {
         $notificationSettingsDao = DAORegistry::getDAO('NotificationSettingsDAO'); /* @var $notificationSettingsDao NotificationSettingsDAO */
         foreach ($params as $name => $value) {
            $notificationSettingsDao->updateNotificationSetting($notificationId, $name, $value);
         }
      }
 
      return $notification;
   }
 
   public function deleteTrivialNotifications($notifications) {
      $notificationDao = DAORegistry::getDAO('NotificationDAO'); /* @var $notificationDao NotificationDAO */
      foreach($notifications as $notification) {
         // Delete only trivial notifications.
         if($notification->getLevel() == NOTIFICATION_LEVEL_TRIVIAL) {
            $notificationDao->deleteById($notification->getId(), $notification->getUserId());
         }
      }
   }
 
   public function formatToGeneralNotification($request, $notifications) {
      $formattedNotificationsData = array();
      foreach ($notifications as $notification) { /* @var $notification Notification */
         $formattedNotificationsData[$notification->getLevel()][$notification->getId()] = array(
            'title' => $this->getNotificationTitle($notification),
            'text' => $this->getNotificationContents($request, $notification),
            'addclass' => $this->getStyleClass($notification),
            'notice_icon' => $this->getIconClass($notification),
            'styling' => 'jqueryui',
         );
      }
 
      return $formattedNotificationsData;
   }
 
   public function formatToInPlaceNotification($request, $notifications) {
      $formattedNotificationsData = null;
 
      if (!empty($notifications)) {
         $templateMgr = TemplateManager::getManager($request);
         foreach ((array)$notifications as $notification) {
            $formattedNotificationsData[$notification->getLevel()][$notification->getId()] = $this->formatNotification($request, $notification, 'controllers/notification/inPlaceNotificationContent.tpl');
         }
      }
 
      return $formattedNotificationsData;
   }
 
   protected function getUserBlockedNotifications($userId, $contextId) {
      $notificationSubscriptionSettingsDao = DAORegistry::getDAO('NotificationSubscriptionSettingsDAO'); /* @var $notificationSubscriptionSettingsDao NotificationSubscriptionSettingsDAO */
      return $notificationSubscriptionSettingsDao->getNotificationSubscriptionSettings('blocked_notification', $userId, (int) $contextId);
   }
 
   protected function getUserBlockedEmailedNotifications($userId, $contextId) {
      $notificationSubscriptionSettingsDao = DAORegistry::getDAO('NotificationSubscriptionSettingsDAO'); /* @var $notificationSubscriptionSettingsDao NotificationSubscriptionSettingsDAO */
      return $notificationSubscriptionSettingsDao->getNotificationSubscriptionSettings('blocked_emailed_notification', $userId, (int) $contextId);
   }
 
   protected function getMailTemplate($emailKey = null) {
      import('lib.pkp.classes.mail.MailTemplate');
      return new MailTemplate($emailKey, null, null, false);
   }
 
   protected function fetchLinkActionNotificationContent($linkAction, $request) {
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->assign('linkAction', $linkAction);
      return $templateMgr->fetch('controllers/notification/linkActionNotificationContent.tpl');
   }
 
 
   //
   // Private helper methods.
   //
   /*
    * Return a string of formatted notifications for display
    * @param $request PKPRequest
    * @param $notifications object DAOResultFactory
    * @param $notificationTemplate string optional Template to use for constructing an individual notification for display
    * @return string
    */
   private function formatNotifications($request, $notifications, $notificationTemplate = 'notification/notification.tpl') {
      $notificationString = '';
 
      // Build out the notifications based on their associated objects and format into a string
      while($notification = $notifications->next()) {
         $notificationString .= $this->formatNotification($request, $notification, $notificationTemplate);
      }
 
      return $notificationString;
   }
 
   private function formatNotification($request, $notification, $notificationTemplate = 'notification/notification.tpl') {
      $templateMgr = TemplateManager::getManager($request);
 
      // Set the date read if it isn't already set
      if (!$notification->getDateRead()) {
         $notificationDao = DAORegistry::getDAO('NotificationDAO'); /* @var $notificationDao NotificationDAO */
         $dateRead = $notificationDao->setDateRead($notification->getId(), Core::getCurrentDate());
         $notification->setDateRead($dateRead);
      }
 
      $user = $request->getUser();
      $templateMgr->assign(array(
         'isUserLoggedIn' => $user,
         'notificationDateCreated' => $notification->getDateCreated(),
         'notificationId' => $notification->getId(),
         'notificationContents' => $this->getNotificationContents($request, $notification),
         'notificationTitle' => $this->getNotificationTitle($notification),
         'notificationStyleClass' => $this->getStyleClass($notification),
         'notificationIconClass' => $this->getIconClass($notification),
         'notificationDateRead' => $notification->getDateRead(),
      ));
 
      if($notification->getLevel() != NOTIFICATION_LEVEL_TRIVIAL) {
         $templateMgr->assign('notificationUrl', $this->getNotificationUrl($request, $notification));
      }
 
      return $templateMgr->fetch($notificationTemplate);
   }
 
   protected function sendNotificationEmail($request, $notification, ?int $contextId, callable $mailConfigurator = null) {
      $userId = $notification->getUserId();
      $userDao = DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
      $user = $userDao->getById($userId);
      if ($user && !$user->getDisabled()) {
         AppLocale::requireComponents(LOCALE_COMPONENT_APP_COMMON);
 
         $context = $request->getContext();
         if ($contextId && (!$context || $context->getId() != $contextId)) {
            $contextDao = Application::getContextDAO();
            $context = $contextDao->getById($contextId);
         }
 
         $site = $request->getSite();
         $mail = $this->getMailTemplate('NOTIFICATION');
 
         if ($context) {
            $mail->setReplyTo($context->getContactEmail(), $context->getContactName());
         } else {
            $mail->setReplyTo($site->getLocalizedContactEmail(), $site->getLocalizedContactName());
         }
 
         $mail->assignParams(array(
            'notificationContents' => $this->getNotificationContents($request, $notification),
            'url' => $this->getNotificationUrl($request, $notification),
            'siteTitle' => $context?$context->getLocalizedName():$site->getLocalizedTitle()
         ));
         $mail->addRecipient($user->getEmail(), $user->getFullName());
         if (is_callable($mailConfigurator)) {
            $mail = $mailConfigurator($mail);
         }
         if (!$mail->send() && $request->getUser()) {
            import('classes.notification.NotificationManager');
            $notificationMgr = new NotificationManager();
            $notificationMgr->createTrivialNotification($request->getUser()->getId(), NOTIFICATION_TYPE_ERROR, array('contents' => __('email.compose.error')));
         }
      }
   }
}