Merge pull request #8155 from nupplaphil/task/move_notifications

Move mod/notifications to Module\Notification
This commit is contained in:
Hypolite Petovan 2020-01-24 12:10:49 -05:00 committed by GitHub
commit 188720c3cd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
68 changed files with 794 additions and 686 deletions

View file

@ -0,0 +1,165 @@
<?php
namespace Friendica\Module;
use Exception;
use Friendica\BaseModule;
use Friendica\Content\Pager;
use Friendica\Core\Renderer;
use Friendica\Core\System;
use Friendica\DI;
use Friendica\Model\Notification;
use Friendica\Network\HTTPException\ForbiddenException;
/**
* 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 = [
Notification::NETWORK => 'network',
Notification::SYSTEM => 'system',
Notification::HOME => 'home',
Notification::PERSONAL => 'personal',
Notification::INTRO => 'intros',
];
/** @var array Array of the allowed notifications and their printable name */
const PRINT_TYPES = [
Notification::NETWORK => 'Network',
Notification::SYSTEM => 'System',
Notification::HOME => 'Home',
Notification::PERSONAL => 'Personal',
Notification::INTRO => 'Introductions',
];
/** @var array The array of access keys for notification pages */
const ACCESS_KEYS = [
Notification::NETWORK => 'w',
Notification::SYSTEM => 'y',
Notification::HOME => 'h',
Notification::PERSONAL => 'r',
Notification::INTRO => 'i',
];
/** @var int The default count of items per page */
const ITEMS_PER_PAGE = 20;
/** @var boolean True, if ALL entries should get shown */
protected static $showAll;
/** @var int The determined start item of the current page */
protected static $firstItemNum;
/**
* Collects all notifications from the backend
*
* @return array The determined notification array
* ['header', 'notifications']
*/
abstract public static function getNotifications();
public static function init(array $parameters = [])
{
if (!local_user()) {
throw new ForbiddenException(DI::l10n()->t('Permission denied.'));
}
$page = ($_REQUEST['page'] ?? 0) ?: 1;
self::$firstItemNum = ($page * self::ITEMS_PER_PAGE) - self::ITEMS_PER_PAGE;
self::$showAll = ($_REQUEST['show'] ?? '') === 'all';
}
public static function post(array $parameters = [])
{
$request_id = DI::args()->get(1);
if ($request_id === 'all') {
return;
}
if ($request_id) {
$intro = DI::intro()->selectFirst(['id' => $request_id, 'uid' => local_user()]);
switch ($_POST['submit']) {
case DI::l10n()->t('Discard'):
$intro->discard();
break;
case DI::l10n()->t('Ignore'):
$intro->ignore();
break;
}
DI::baseUrl()->redirect('notifications/intros');
}
}
public static function rawContent(array $parameters = [])
{
// If the last argument of the query is NOT json, return
if (DI::args()->get(DI::args()->getArgc() - 1) !== 'json') {
return;
}
System::jsonExit(static::getNotifications()['notifs'] ?? []);
}
/**
* 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 static function printContent(string $header, array $notifications, string $noContent, array $showLink)
{
// Get the nav tabs for the notification pages
$tabs = self::getTabs();
// Set the pager
$pager = new Pager(DI::args()->getQueryString(), self::ITEMS_PER_PAGE);
$notif_tpl = Renderer::getMarkupTemplate('notifications/notifications.tpl');
return Renderer::replaceMacros($notif_tpl, [
'$header' => $header ?? DI::l10n()->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 static function getTabs()
{
$selected = DI::args()->get(1, '');
$tabs = [];
foreach (self::URL_TYPES as $type => $url) {
$tabs[] = [
'label' => DI::l10n()->t(self::PRINT_TYPES[$type]),
'url' => 'notifications/' . $url,
'sel' => (($selected == $url) ? 'active' : ''),
'id' => $type . '-tab',
'accesskey' => self::ACCESS_KEYS[$type],
];
}
return $tabs;
}
}

View file

@ -0,0 +1,194 @@
<?php
namespace Friendica\Module\Notifications;
use Friendica\Content\ContactSelector;
use Friendica\Content\Nav;
use Friendica\Core\Protocol;
use Friendica\Core\Renderer;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Module\BaseNotifications;
/**
* Prints notifications about introduction
*/
class Introductions extends BaseNotifications
{
/**
* @inheritDoc
*/
public static function getNotifications()
{
$id = (int)DI::args()->get(2, 0);
$all = DI::args()->get(2) == 'all';
$notifications = DI::notification()->getIntroList($all, self::$firstItemNum, self::ITEMS_PER_PAGE, $id);
return [
'header' => DI::l10n()->t('Notifications'),
'notifications' => $notifications,
];
}
public static function content(array $parameters = [])
{
Nav::setSelected('introductions');
$all = DI::args()->get(2) == 'all';
$notificationContent = [];
$notificationNoContent = '';
$notificationResult = self::getNotifications();
$notifications = $notificationResult['notifications'] ?? [];
$notificationHeader = $notificationResult['header'] ?? '';
$notificationSuggestions = Renderer::getMarkupTemplate('notifications/suggestions.tpl');
$notificationTemplate = Renderer::getMarkupTemplate('notifications/intros.tpl');
// The link to switch between ignored and normal connection requests
$notificationShowLink = [
'href' => (!$all ? 'notifications/intros/all' : 'notifications/intros'),
'text' => (!$all ? DI::l10n()->t('Show Ignored Requests') : DI::l10n()->t('Hide Ignored Requests'))
];
// Loop through all introduction notifications.This creates an array with the output html for each
// introduction
foreach ($notifications['notifications'] as $notification) {
// There are two kind of introduction. Contacts suggested by other contacts and normal connection requests.
// We have to distinguish between these two because they use different data.
switch ($notification['label']) {
case 'friend_suggestion':
$notificationContent[] = Renderer::replaceMacros($notificationSuggestions, [
'$type' => $notification['label'],
'str_notification_type' => DI::l10n()->t('Notification type:'),
'str_type' => $notification['str_type'],
'$intro_id' => $notification['intro_id'],
'$lbl_madeby' => DI::l10n()->t('Suggested by:'),
'$madeby' => $notification['madeby'],
'$madeby_url' => $notification['madeby_url'],
'$madeby_zrl' => $notification['madeby_zrl'],
'$madeby_addr' => $notification['madeby_addr'],
'$contact_id' => $notification['contact_id'],
'$photo' => $notification['photo'],
'$fullname' => $notification['name'],
'$url' => $notification['url'],
'$zrl' => $notification['zrl'],
'$lbl_url' => DI::l10n()->t('Profile URL'),
'$addr' => $notification['addr'],
'$hidden' => ['hidden', DI::l10n()->t('Hide this contact from others'), ($notification['hidden'] == 1), ''],
'$knowyou' => $notification['knowyou'],
'$approve' => DI::l10n()->t('Approve'),
'$note' => $notification['note'],
'$request' => $notification['request'],
'$ignore' => DI::l10n()->t('Ignore'),
'$discard' => DI::l10n()->t('Discard'),
]);
break;
// Normal connection requests
default:
$friend_selected = (($notification['network'] !== Protocol::OSTATUS) ? ' checked="checked" ' : ' disabled ');
$fan_selected = (($notification['network'] === Protocol::OSTATUS) ? ' checked="checked" disabled ' : '');
$lbl_knowyou = '';
$knowyou = '';
$helptext = '';
$helptext2 = '';
$helptext3 = '';
if ($notification['network'] === Protocol::DFRN) {
$lbl_knowyou = DI::l10n()->t('Claims to be known to you: ');
$knowyou = (($notification['knowyou']) ? DI::l10n()->t('yes') : DI::l10n()->t('no'));
$helptext = DI::l10n()->t('Shall your connection be bidirectional or not?');
$helptext2 = DI::l10n()->t('Accepting %s as a friend allows %s to subscribe to your posts, and you will also receive updates from them in your news feed.', $notification['name'], $notification['name']);
$helptext3 = DI::l10n()->t('Accepting %s as a subscriber allows them to subscribe to your posts, but you will not receive updates from them in your news feed.', $notification['name']);
} elseif ($notification['network'] === Protocol::DIASPORA) {
$helptext = DI::l10n()->t('Shall your connection be bidirectional or not?');
$helptext2 = DI::l10n()->t('Accepting %s as a friend allows %s to subscribe to your posts, and you will also receive updates from them in your news feed.', $notification['name'], $notification['name']);
$helptext3 = DI::l10n()->t('Accepting %s as a sharer allows them to subscribe to your posts, but you will not receive updates from them in your news feed.', $notification['name']);
}
$dfrn_tpl = Renderer::getMarkupTemplate('notifications/netfriend.tpl');
$dfrn_text = Renderer::replaceMacros($dfrn_tpl, [
'$intro_id' => $notification['intro_id'],
'$friend_selected' => $friend_selected,
'$fan_selected' => $fan_selected,
'$approve_as1' => $helptext,
'$approve_as2' => $helptext2,
'$approve_as3' => $helptext3,
'$as_friend' => DI::l10n()->t('Friend'),
'$as_fan' => (($notification['network'] == Protocol::DIASPORA) ? DI::l10n()->t('Sharer') : DI::l10n()->t('Subscriber'))
]);
$contact = DBA::selectFirst('contact', ['network', 'protocol'], ['id' => $notification['contact_id']]);
if (($contact['network'] != Protocol::DFRN) || ($contact['protocol'] == Protocol::ACTIVITYPUB)) {
$action = 'follow_confirm';
} else {
$action = 'dfrn_confirm';
}
$header = $notification['name'];
if ($notification['addr'] != '') {
$header .= ' <' . $notification['addr'] . '>';
}
$header .= ' (' . ContactSelector::networkToName($notification['network'], $notification['url']) . ')';
if ($notification['network'] != Protocol::DIASPORA) {
$discard = DI::l10n()->t('Discard');
} else {
$discard = '';
}
$notificationContent[] = Renderer::replaceMacros($notificationTemplate, [
'$type' => $notification['label'],
'$header' => $header,
'str_notification_type' => DI::l10n()->t('Notification type:'),
'str_type' => $notification['notifytype'],
'$dfrn_text' => $dfrn_text,
'$dfrn_id' => $notification['dfrn_id'],
'$uid' => $notification['uid'],
'$intro_id' => $notification['intro_id'],
'$contact_id' => $notification['contact_id'],
'$photo' => $notification['photo'],
'$fullname' => $notification['name'],
'$location' => $notification['location'],
'$lbl_location' => DI::l10n()->t('Location:'),
'$about' => $notification['about'],
'$lbl_about' => DI::l10n()->t('About:'),
'$keywords' => $notification['keywords'],
'$lbl_keywords' => DI::l10n()->t('Tags:'),
'$gender' => $notification['gender'],
'$lbl_gender' => DI::l10n()->t('Gender:'),
'$hidden' => ['hidden', DI::l10n()->t('Hide this contact from others'), ($notification['hidden'] == 1), ''],
'$url' => $notification['url'],
'$zrl' => $notification['zrl'],
'$lbl_url' => DI::l10n()->t('Profile URL'),
'$addr' => $notification['addr'],
'$lbl_knowyou' => $lbl_knowyou,
'$lbl_network' => DI::l10n()->t('Network:'),
'$network' => ContactSelector::networkToName($notification['network'], $notification['url']),
'$knowyou' => $knowyou,
'$approve' => DI::l10n()->t('Approve'),
'$note' => $notification['note'],
'$ignore' => DI::l10n()->t('Ignore'),
'$discard' => $discard,
'$action' => $action,
]);
break;
}
}
if (count($notifications['notifications']) == 0) {
info(DI::l10n()->t('No introductions.') . EOL);
$notificationNoContent = DI::l10n()->t('No more %s notifications.', $notifications['ident']);
}
return self::printContent($notificationHeader, $notificationContent, $notificationNoContent, $notificationShowLink);
}
}

View file

@ -8,9 +8,9 @@ use Friendica\DI;
use Friendica\Network\HTTPException;
/**
* Interacting with the /notify command
* Interacting with the /notification command
*/
class Notify extends BaseModule
class Notification extends BaseModule
{
public static function init(array $parameters = [])
{
@ -21,11 +21,9 @@ class Notify extends BaseModule
public static function rawContent(array $parameters = [])
{
$a = DI::app();
// @TODO: Replace with parameter from router
if ($a->argc > 2 && $a->argv[1] === 'mark' && $a->argv[2] === 'all') {
$success = DI::notify()->setAllSeen();
if (DI::args()->get(1) === 'mark' && DI::args()->get(2) === 'all') {
$success = DI::notification()->setAllSeen();
header('Content-type: application/json; charset=utf-8');
echo json_encode([
@ -36,22 +34,20 @@ class Notify extends BaseModule
}
/**
* Redirect to the notifications main page or to the url for the chosen notify
* Redirect to the notifications main page or to the url for the chosen notifications
*
* @return string|void
* @throws HTTPException\InternalServerErrorException
*/
public static function content(array $parameters = [])
{
$a = DI::app();
// @TODO: Replace with parameter from router
if ($a->argc > 2 && $a->argv[1] === 'view' && intval($a->argv[2])) {
$notificationsManager = DI::notify();
if (DI::args()->getArgc() > 2 && DI::args()->get(1) === 'view' && intval(DI::args()->get(2))) {
$notificationManager = DI::notification();
// @TODO: Replace with parameter from router
$note = $notificationsManager->getByID($a->argv[2]);
$note = $notificationManager->getByID(DI::args()->get(2));
if (!empty($note)) {
$notificationsManager->setSeen($note);
$notificationManager->setSeen($note);
if (!empty($note['link'])) {
System::externalRedirect($note['link']);
}

View file

@ -0,0 +1,118 @@
<?php
namespace Friendica\Module\Notifications;
use Friendica\Content\Nav;
use Friendica\Content\Pager;
use Friendica\Core\Renderer;
use Friendica\DI;
use Friendica\Module\BaseNotifications;
/**
* Prints all notification types except introduction:
* - Network
* - System
* - Personal
* - Home
*/
class Notifications extends BaseNotifications
{
/**
* {@inheritDoc}
*/
public static function getNotifications()
{
$nm = DI::notification();
$notificationHeader = '';
// Get the network notifications
if ((DI::args()->get(1) == 'network')) {
$notificationHeader = DI::l10n()->t('Network Notifications');
$notifications = $nm->getNetworkList(self::$showAll, self::$firstItemNum, self::ITEMS_PER_PAGE);
// Get the system notifications
} elseif ((DI::args()->get(1) == 'system')) {
$notificationHeader = DI::l10n()->t('System Notifications');
$notifications = $nm->getSystemList(self::$showAll, self::$firstItemNum, self::ITEMS_PER_PAGE);
// Get the personal notifications
} elseif ((DI::args()->get(1) == 'personal')) {
$notificationHeader = DI::l10n()->t('Personal Notifications');
$notifications = $nm->getPersonalList(self::$showAll, self::$firstItemNum, self::ITEMS_PER_PAGE);
// Get the home notifications
} elseif ((DI::args()->get(1) == 'home')) {
$notificationHeader = DI::l10n()->t('Home Notifications');
$notifications = $nm->getHomeList(self::$showAll, self::$firstItemNum, self::ITEMS_PER_PAGE);
// fallback - redirect to main page
} else {
DI::baseUrl()->redirect('notifications');
}
// Set the pager
$pager = new Pager(DI::args()->getQueryString(), self::ITEMS_PER_PAGE);
// Add additional informations (needed for json output)
$notifications['items_page'] = $pager->getItemsPerPage();
$notifications['page'] = $pager->getPage();
return [
'header' => $notificationHeader,
'notifications' => $notifications,
];
}
public static function content(array $parameters = [])
{
Nav::setSelected('notifications');
$notificationContent = [];
$notificationNoContent = '';
$notificationResult = self::getNotifications();
$notifications = $notificationResult['notifications'] ?? [];
$notificationHeader = $notificationResult['header'] ?? '';
if (!empty($notifications['notifications'])) {
// Loop trough ever notification This creates an array with the output html for each
// notification and apply the correct template according to the notificationtype (label).
foreach ($notifications['notifications'] as $notification) {
$notification_templates = [
'like' => 'notifications/likes_item.tpl',
'dislike' => 'notifications/dislikes_item.tpl',
'attend' => 'notifications/attend_item.tpl',
'attendno' => 'notifications/attend_item.tpl',
'attendmaybe' => 'notifications/attend_item.tpl',
'friend' => 'notifications/friends_item.tpl',
'comment' => 'notifications/comments_item.tpl',
'post' => 'notifications/posts_item.tpl',
'notification' => 'notifications/notification.tpl',
];
$notificationTemplate = Renderer::getMarkupTemplate($notification_templates[$notification['label']]);
$notificationContent[] = Renderer::replaceMacros($notificationTemplate, [
'$item_label' => $notification['label'],
'$item_link' => $notification['link'],
'$item_image' => $notification['image'],
'$item_url' => $notification['url'],
'$item_text' => $notification['text'],
'$item_when' => $notification['when'],
'$item_ago' => $notification['ago'],
'$item_seen' => $notification['seen'],
]);
}
} else {
$notificationNoContent = DI::l10n()->t('No more %s notifications.', $notifications['ident']);
}
$notificationShowLink = [
'href' => (self::$showAll ? 'notifications/' . $notifications['ident'] : 'notifications/' . $notifications['ident'] . '?show=all'),
'text' => (self::$showAll ? DI::l10n()->t('Show unread') : DI::l10n()->t('Show all')),
];
return self::printContent($notificationHeader, $notificationContent, $notificationNoContent, $notificationShowLink);
}
}