src/Module/BaseNotifications.php

   1 <?php
   2
   3 namespace Friendica\Module;
   4
   5 use Exception;
   6 use Friendica\BaseModule;
   7 use Friendica\Content\Pager;
   8 use Friendica\Core\Renderer;
   9 use Friendica\Core\System;
  10 use Friendica\DI;
  11 use Friendica\Network\HTTPException\ForbiddenException;
  12 use Friendica\Object\Notification\Notification;
  13
  14 /**
  15  * Base Module for each tab of the notification display
  16  *
  17  * General possibility to print it as JSON as well
  18  */
  19 abstract class BaseNotifications extends BaseModule
  20 {
  21         /** @var array Array of URL parameters */
  22         const URL_TYPES = [
  23                 Notification::NETWORK  => 'network',
  24                 Notification::SYSTEM   => 'system',
  25                 Notification::HOME     => 'home',
  26                 Notification::PERSONAL => 'personal',
  27                 Notification::INTRO    => 'intros',
  28         ];
  29
  30         /** @var array Array of the allowed notifications and their printable name */
  31         const PRINT_TYPES = [
  32                 Notification::NETWORK  => 'Network',
  33                 Notification::SYSTEM   => 'System',
  34                 Notification::HOME     => 'Home',
  35                 Notification::PERSONAL => 'Personal',
  36                 Notification::INTRO    => 'Introductions',
  37         ];
  38
  39         /** @var array The array of access keys for notification pages */
  40         const ACCESS_KEYS = [
  41                 Notification::NETWORK  => 'w',
  42                 Notification::SYSTEM   => 'y',
  43                 Notification::HOME     => 'h',
  44                 Notification::PERSONAL => 'r',
  45                 Notification::INTRO    => 'i',
  46         ];
  47
  48         /** @var int The default count of items per page */
  49         const ITEMS_PER_PAGE = 20;
  50         /** @var int The default limit of notifications per page */
  51         const DEFAULT_PAGE_LIMIT = 80;
  52
  53         /** @var boolean True, if ALL entries should get shown */
  54         protected static $showAll;
  55         /** @var int The determined start item of the current page */
  56         protected static $firstItemNum;
  57
  58         /**
  59          * Collects all notifications from the backend
  60          *
  61          * @return array The determined notification array
  62          *               ['header', 'notifications']
  63          */
  64         abstract public static function getNotifications();
  65
  66         public static function init(array $parameters = [])
  67         {
  68                 if (!local_user()) {
  69                         throw new ForbiddenException(DI::l10n()->t('Permission denied.'));
  70                 }
  71
  72                 $page = ($_REQUEST['page'] ?? 0) ?: 1;
  73
  74                 self::$firstItemNum = ($page * self::ITEMS_PER_PAGE) - self::ITEMS_PER_PAGE;
  75                 self::$showAll      = ($_REQUEST['show'] ?? '') === 'all';
  76         }
  77
  78         public static function rawContent(array $parameters = [])
  79         {
  80                 // If the last argument of the query is NOT json, return
  81                 if (DI::args()->get(DI::args()->getArgc() - 1) !== 'json') {
  82                         return;
  83                 }
  84
  85                 // Set the pager
  86                 $pager = new Pager(DI::args()->getQueryString(), self::ITEMS_PER_PAGE);
  87
  88                 // Add additional informations (needed for json output)
  89                 $notifications = [
  90                         'notifications' => static::getNotifications(),
  91                         'items_page'    => $pager->getItemsPerPage(),
  92                         'page'          => $pager->getPage(),
  93                 ];
  94
  95                 System::jsonExit($notifications);
  96         }
  97
  98         /**
  99          * Shows the printable result of notifications for a specific tab
 100          *
 101          * @param string $header        The notification header
 102          * @param array  $notifications The array with the notifications
 103          * @param string $noContent     The string in case there are no notifications
 104          * @param array  $showLink      The possible links at the top
 105          *
 106          * @return string The rendered output
 107          *
 108          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 109          */
 110         protected static function printContent(string $header, array $notifications, string $noContent, array $showLink)
 111         {
 112                 // Get the nav tabs for the notification pages
 113                 $tabs = self::getTabs();
 114
 115                 // Set the pager
 116                 $pager = new Pager(DI::args()->getQueryString(), self::ITEMS_PER_PAGE);
 117
 118                 $notif_tpl = Renderer::getMarkupTemplate('notifications/notifications.tpl');
 119                 return Renderer::replaceMacros($notif_tpl, [
 120                         '$header'        => $header ?? DI::l10n()->t('Notifications'),
 121                         '$tabs'          => $tabs,
 122                         '$notifications' => $notifications,
 123                         '$noContent'     => $noContent,
 124                         '$showLink'      => $showLink,
 125                         '$paginate'      => $pager->renderMinimal(count($notifications))
 126                 ]);
 127         }
 128
 129         /**
 130          * List of pages for the Notifications TabBar
 131          *
 132          * @return array with with notifications TabBar data
 133          * @throws Exception
 134          */
 135         private static function getTabs()
 136         {
 137                 $selected = DI::args()->get(1, '');
 138
 139                 $tabs = [];
 140
 141                 foreach (self::URL_TYPES as $type => $url) {
 142                         $tabs[] = [
 143                                 'label'     => DI::l10n()->t(self::PRINT_TYPES[$type]),
 144                                 'url'       => 'notifications/' . $url,
 145                                 'sel'       => (($selected == $url) ? 'active' : ''),
 146                                 'id'        => $type . '-tab',
 147                                 'accesskey' => self::ACCESS_KEYS[$type],
 148                         ];
 149                 }
 150
 151                 return $tabs;
 152         }
 153 }