EditorialReportNotificationManager.inc.php

<?php
import('lib.pkp.classes.notification.NotificationManagerDelegate');
 
class EditorialReportNotificationManager extends NotificationManagerDelegate {
   private $_context;
   private $_request;
   private $_params;
   private $_attachmentFilename;
   private $_editorialTrends;
   private $_editorialTrendsTotal;
   private $_userRolesOverview;
 
   public function __construct(int $notificationType) {
      parent::__construct($notificationType);
      $this->_request = Application::get()->getRequest();
   }
 
   public function initialize(Context $context, DateTimeInterface $dateStart, DateTimeInterface $dateEnd) : void
   {
      $this->_context = $context;
      $locale = $this->_context->getPrimaryLocale();
      $dateStart = $dateStart;
      $dateEnd = $dateEnd;
 
      \AppLocale::requireComponents([LOCALE_COMPONENT_PKP_MANAGER, LOCALE_COMPONENT_APP_MANAGER, LOCALE_COMPONENT_PKP_USER], $locale);
 
      $dispatcher = Application::get()->getDispatcher();
 
      $this->_editorialTrends = Services::get('editorialStats')->getOverview([
         'contextIds' => [$this->_context->getId()],
         'dateStart' => $dateStart->format('Y-m-d'),
         'dateEnd' => $dateEnd->format('Y-m-d'),
      ]);
      $this->_editorialTrendsTotal = Services::get('editorialStats')->getOverview([
         'contextIds' => [$this->_context->getId()]
      ]);
 
      foreach ($this->_editorialTrends as $stat) {
         switch ($stat['key']) {
            case 'submissionsReceived':
               $newSubmissions = $stat['value'];
               break;
            case 'submissionsDeclined':
               $declinedSubmissions = $stat['value'];
               break;
            case 'submissionsAccepted':
               $acceptedSubmissions = $stat['value'];
               break;
         }
      }
 
      $this->_params = [
         'newSubmissions' => $newSubmissions,
         'declinedSubmissions' => $declinedSubmissions,
         'acceptedSubmissions' => $acceptedSubmissions,
         'totalSubmissions' => Services::get('editorialStats')->countSubmissionsReceived(['contextIds' => [$this->_context->getId()]]),
         'month' => $this->_getLocalizedMonthName($dateStart, $locale),
         'year' => $dateStart->format('Y'),
         'editorialStatsLink' => $dispatcher->url($this->_request, ROUTE_PAGE, $this->_context->getPath(), 'stats', 'editorial'),
         'publicationStatsLink' => $dispatcher->url($this->_request, ROUTE_PAGE, $this->_context->getPath(), 'stats', 'publications')
      ];
 
      $this->_userRolesOverview = Services::get('user')->getRolesOverview(['contextId' => $this->_context->getId()]);
 
      // Create the CSV file attachment
      // Active submissions by stage
      $file = new SplFileObject(tempnam(sys_get_temp_dir(), 'tmp'), 'wb');
      // Adds BOM (byte order mark) to enforce the UTF-8 format
      try {
         $file->fwrite("\xEF\xBB\xBF");
         $file->fputcsv([
            __('stats.submissionsActive', [], $locale),
            __('stats.total', [], $locale)
         ]);
         foreach (Application::get()->getApplicationStages() as $stageId) {
            $file->fputcsv([
               __(Application::get()->getWorkflowStageName($stageId), [], $locale),
               Services::get('editorialStats')->countActiveByStages($stageId)
            ]);
         }
 
         $file->fputcsv([]);
 
         // Editorial trends
         $file->fputcsv([
            __('stats.trends', [], $locale),
            $this->_getLocalizedMonthName($dateStart, $locale) . __('common.commaListSeparator', [], $locale) . $dateStart->format('Y'),
            __('stats.total', [], $locale)
         ]);
         foreach ($this->_editorialTrends as $i => $stat) {
            $file->fputcsv([
               __($stat['name'], [], $locale),
               $stat['value'],
               $this->_editorialTrendsTotal[$i]['value']
            ]);
         }
 
         $file->fputcsv([]);
 
         // Count of users by role
         $file->fputcsv([
            __('manager.users', [], $locale),
            __('stats.total', [], $locale)
         ]);
         foreach ($this->_userRolesOverview as $role) {
            $file->fputcsv([
               __($role['name'], [], $locale),
               $role['value']
            ]);
         }
 
         $this->_attachmentFilename = $file->getRealPath();
      }
      finally {
         $file = null;
      }
   }
 
   public function _getLocalizedMonthName(\DateTimeInterface $date, ?string $locale = null): string
   {
      static $cache = [];
      $locale ?? $locale = \AppLocale::getLocale();
      $formatter = $cache[$locale] ?? $cache[$locale] = \IntlDateFormatter::create($locale, null, null, null, null, 'MMMM');
      return $formatter->format($date);
   }
 
   public function getNotificationMessage($request, $notification) : string
   {
      return __('notification.type.editorialReport', [], $this->_context->getPrimaryLocale());
   }
 
   public function getNotificationContents($request, $notification) : EmailTemplate
   {
      return Services::get('emailTemplate')->getByKey($notification->getContextId(), 'STATISTICS_REPORT_NOTIFICATION');
   }
 
   public function getNotificationUrl($request, $notification) {
      $application = Application::get();
      $context = $application->getContextDAO()->getById($notification->getContextId());
      return $application->getDispatcher()->url($this->_request, ROUTE_PAGE, $context->getPath(), 'stats', 'editorial');
   }
 
   public function getIconClass($notification) : string
   {
      return 'notifyIconInfo';
   }
 
   public function getStyleClass($notification) : string
   {
      return NOTIFICATION_STYLE_CLASS_INFORMATION;
   }
 
   public function notify(User $user) : PKPNotification
   {
      return parent::createNotification(
         $this->_request,
         $user->getId(),
         NOTIFICATION_TYPE_EDITORIAL_REPORT,
         $this->_context->getId(),
         null,
         null,
         NOTIFICATION_LEVEL_TASK,
         ['contents' => __('notification.type.editorialReport.contents', [], $this->_context->getPrimaryLocale())],
         false,
         function ($mail) use ($user) {
            return $this->_setupMessage($mail, $user);
         }
      );
   }
 
   protected function getMailTemplate($emailKey = null) : MailTemplate
   {
      import('lib.pkp.classes.mail.MailTemplate');
      $mail = new MailTemplate('STATISTICS_REPORT_NOTIFICATION', $this->_context->getPrimaryLocale(), $this->_context, false);
      return $mail;
   }
 
   private function _setupMessage(Mail $mail, User $user) : Mail
   {
      $mail->assignParams($this->_getMessageParams($user));
      if ($this->_getMessageAttachment()) {
         $mail->addAttachment($this->_getMessageAttachment(), 'editorial-report.csv');
      }
      return $mail;
   }
 
   private function _getMessageParams(User $user) : array
   {
      return $this->_params + ['name' => $user->getLocalizedGivenName($this->_context->getPrimaryLocale())];
   }
 
   private function _getMessageAttachment() : string
   {
      return $this->_attachmentFilename;
   }
}