mirror of
https://github.com/friendica/friendica
synced 2024-12-25 00:40:17 +00:00
181 lines
5.7 KiB
PHP
181 lines
5.7 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (C) 2010-2021, the Friendica project
|
|
*
|
|
* @license GNU AGPL version 3 or any later version
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
namespace Friendica\Module;
|
|
|
|
use Exception;
|
|
use Friendica\App;
|
|
use Friendica\App\Arguments;
|
|
use Friendica\BaseModule;
|
|
use Friendica\Content\Pager;
|
|
use Friendica\Core\L10n;
|
|
use Friendica\Core\Renderer;
|
|
use Friendica\Core\System;
|
|
use Friendica\Navigation\Notifications\ValueObject\FormattedNotification;
|
|
use Friendica\Network\HTTPException\ForbiddenException;
|
|
use Friendica\Util\Profiler;
|
|
use Psr\Log\LoggerInterface;
|
|
|
|
/**
|
|
* Base Module for each tab of the notification display
|
|
*
|
|
* General possibility to print it as JSON as well
|
|
*/
|
|
abstract class BaseNotifications extends BaseModule
|
|
{
|
|
/** @var array Array of URL parameters */
|
|
const URL_TYPES = [
|
|
FormattedNotification::NETWORK => 'network',
|
|
FormattedNotification::SYSTEM => 'system',
|
|
FormattedNotification::HOME => 'home',
|
|
FormattedNotification::PERSONAL => 'personal',
|
|
FormattedNotification::INTRO => 'intros',
|
|
];
|
|
|
|
/** @var array Array of the allowed notifications and their printable name */
|
|
const PRINT_TYPES = [
|
|
FormattedNotification::NETWORK => 'Network',
|
|
FormattedNotification::SYSTEM => 'System',
|
|
FormattedNotification::HOME => 'Home',
|
|
FormattedNotification::PERSONAL => 'Personal',
|
|
FormattedNotification::INTRO => 'Introductions',
|
|
];
|
|
|
|
/** @var array The array of access keys for notification pages */
|
|
const ACCESS_KEYS = [
|
|
FormattedNotification::NETWORK => 'w',
|
|
FormattedNotification::SYSTEM => 'y',
|
|
FormattedNotification::HOME => 'h',
|
|
FormattedNotification::PERSONAL => 'r',
|
|
FormattedNotification::INTRO => 'i',
|
|
];
|
|
|
|
/** @var int The default count of items per page */
|
|
const ITEMS_PER_PAGE = 20;
|
|
/** @var int The default limit of notifications per page */
|
|
const DEFAULT_PAGE_LIMIT = 80;
|
|
|
|
/** @var boolean True, if ALL entries should get shown */
|
|
protected $showAll;
|
|
/** @var int The determined start item of the current page */
|
|
protected $firstItemNum;
|
|
|
|
/** @var Arguments */
|
|
protected $args;
|
|
|
|
/**
|
|
* Collects all notifications from the backend
|
|
*
|
|
* @return array The determined notification array
|
|
* ['header', 'notifications']
|
|
*/
|
|
abstract public function getNotifications();
|
|
|
|
public function __construct(L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, array $server, array $parameters = [])
|
|
{
|
|
parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
|
|
|
|
if (!local_user()) {
|
|
throw new ForbiddenException($this->t('Permission denied.'));
|
|
}
|
|
|
|
$page = ($_REQUEST['page'] ?? 0) ?: 1;
|
|
|
|
$this->firstItemNum = ($page * self::ITEMS_PER_PAGE) - self::ITEMS_PER_PAGE;
|
|
$this->showAll = ($_REQUEST['show'] ?? '') === 'all';
|
|
}
|
|
|
|
protected function rawContent(array $request = [])
|
|
{
|
|
// If the last argument of the query is NOT json, return
|
|
if ($this->args->get($this->args->getArgc() - 1) !== 'json') {
|
|
return;
|
|
}
|
|
|
|
// Set the pager
|
|
$pager = new Pager($this->l10n, $this->args->getQueryString(), self::ITEMS_PER_PAGE);
|
|
|
|
// Add additional informations (needed for json output)
|
|
$notifications = [
|
|
'notifications' => $this->getNotifications(),
|
|
'items_page' => $pager->getItemsPerPage(),
|
|
'page' => $pager->getPage(),
|
|
];
|
|
|
|
System::jsonExit($notifications);
|
|
}
|
|
|
|
/**
|
|
* Shows the printable result of notifications for a specific tab
|
|
*
|
|
* @param string $header The notification header
|
|
* @param array $notifications The array with the notifications
|
|
* @param string $noContent The string in case there are no notifications
|
|
* @param array $showLink The possible links at the top
|
|
*
|
|
* @return string The rendered output
|
|
*
|
|
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
|
*/
|
|
protected function printContent(string $header, array $notifications, string $noContent, array $showLink)
|
|
{
|
|
// Get the nav tabs for the notification pages
|
|
$tabs = $this->getTabs();
|
|
|
|
// Set the pager
|
|
$pager = new Pager($this->l10n, $this->args->getQueryString(), self::ITEMS_PER_PAGE);
|
|
|
|
$notif_tpl = Renderer::getMarkupTemplate('notifications/notifications.tpl');
|
|
return Renderer::replaceMacros($notif_tpl, [
|
|
'$header' => $header ?? $this->t('Notifications'),
|
|
'$tabs' => $tabs,
|
|
'$notifications' => $notifications,
|
|
'$noContent' => $noContent,
|
|
'$showLink' => $showLink,
|
|
'$paginate' => $pager->renderMinimal(count($notifications))
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* List of pages for the Notifications TabBar
|
|
*
|
|
* @return array with with notifications TabBar data
|
|
* @throws Exception
|
|
*/
|
|
private function getTabs()
|
|
{
|
|
$selected = $this->args->get(1, '');
|
|
|
|
$tabs = [];
|
|
|
|
foreach (self::URL_TYPES as $type => $url) {
|
|
$tabs[] = [
|
|
'label' => $this->t(self::PRINT_TYPES[$type]),
|
|
'url' => 'notifications/' . $url,
|
|
'sel' => (($selected == $url) ? 'active' : ''),
|
|
'id' => $type . '-tab',
|
|
'accesskey' => self::ACCESS_KEYS[$type],
|
|
];
|
|
}
|
|
|
|
return $tabs;
|
|
}
|
|
}
|