ReWork Notification Model/Module/Object/Repository/Factory

- Introduce Repository for interaction with "notify" table
- Introduce Factory for read-only notification objects (they're just loosely based on notification the table!)
- Introduce Objects for type-safe usage at the presentation layer
- Reworked Model, which is now fully based on the notify table, including generated fields (cache, ..)
This commit is contained in:
nupplaPhil 2020-01-25 02:01:49 +01:00
parent 230bb6dd53
commit 0850fb88dd
No known key found for this signature in database
GPG key ID: D8365C3D36B77D90
17 changed files with 1413 additions and 851 deletions

View file

@ -8,8 +8,8 @@ use Friendica\Content\Pager;
use Friendica\Core\Renderer;
use Friendica\Core\System;
use Friendica\DI;
use Friendica\Model\Notification;
use Friendica\Network\HTTPException\ForbiddenException;
use Friendica\Object\Notification\Notification;
/**
* Base Module for each tab of the notification display
@ -47,6 +47,8 @@ abstract class BaseNotifications extends BaseModule
/** @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 static $showAll;
@ -104,7 +106,17 @@ abstract class BaseNotifications extends BaseModule
return;
}
System::jsonExit(static::getNotifications()['notifs'] ?? []);
// Set the pager
$pager = new Pager(DI::args()->getQueryString(), self::ITEMS_PER_PAGE);
// Add additional informations (needed for json output)
$notifications = [
'notifications' => static::getNotifications(),
'items_page' => $pager->getItemsPerPage(),
'page' => $pager->getPage(),
];
System::jsonExit($notifications);
}
/**

View file

@ -9,6 +9,7 @@ use Friendica\Core\Renderer;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Module\BaseNotifications;
use Friendica\Object\Notification\Introduction;
/**
* Prints notifications about introduction
@ -23,7 +24,10 @@ class Introductions extends BaseNotifications
$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);
$notifications = [
'ident' => 'introductions',
'notifications' => DI::factNotIntro()->getIntroList($all, self::$firstItemNum, self::ITEMS_PER_PAGE, $id),
];
return [
'header' => DI::l10n()->t('Notifications'),
@ -50,11 +54,12 @@ class Introductions extends BaseNotifications
// 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'))
'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
/** @var Introduction $notification */
foreach ($notifications['notifications'] as $notification) {
// There are two kind of introduction. Contacts suggested by other contacts and normal connection requests.
@ -62,27 +67,27 @@ class Introductions extends BaseNotifications
switch ($notification['label']) {
case 'friend_suggestion':
$notificationContent[] = Renderer::replaceMacros($notificationSuggestions, [
'$type' => $notification['label'],
'$type' => $notification->getLabel(),
'str_notification_type' => DI::l10n()->t('Notification type:'),
'str_type' => $notification['str_type'],
'$intro_id' => $notification['intro_id'],
'str_type' => $notification->getType(),
'$intro_id' => $notification->getIntroId(),
'$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'],
'$madeby' => $notification->getMadeBy(),
'$madeby_url' => $notification->getMadeByUrl(),
'$madeby_zrl' => $notification->getMadeByZrl(),
'$madeby_addr' => $notification->getMadeByAddr(),
'$contact_id' => $notification->getContactId(),
'$photo' => $notification->getPhoto(),
'$fullname' => $notification->getName(),
'$url' => $notification->getUrl(),
'$zrl' => $notification->getZrl(),
'$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'],
'$addr' => $notification->getAddr(),
'$hidden' => ['hidden', DI::l10n()->t('Hide this contact from others'), $notification->isHidden(), ''],
'$knowyou' => $notification->getKnowYou(),
'$approve' => DI::l10n()->t('Approve'),
'$note' => $notification['note'],
'$request' => $notification['request'],
'$note' => $notification->getNote(),
'$request' => $notification->getRequest(),
'$ignore' => DI::l10n()->t('Ignore'),
'$discard' => DI::l10n()->t('Discard'),
]);
@ -90,8 +95,8 @@ class Introductions extends BaseNotifications
// Normal connection requests
default:
$friend_selected = (($notification['network'] !== Protocol::OSTATUS) ? ' checked="checked" ' : ' disabled ');
$fan_selected = (($notification['network'] === Protocol::OSTATUS) ? ' checked="checked" disabled ' : '');
$friend_selected = (($notification->getNetwork() !== Protocol::OSTATUS) ? ' checked="checked" ' : ' disabled ');
$fan_selected = (($notification->getNetwork() === Protocol::OSTATUS) ? ' checked="checked" disabled ' : '');
$lbl_knowyou = '';
$knowyou = '';
@ -99,13 +104,13 @@ class Introductions extends BaseNotifications
$helptext2 = '';
$helptext3 = '';
if ($notification['network'] === Protocol::DFRN) {
if ($notification->getNetwork() === Protocol::DFRN) {
$lbl_knowyou = DI::l10n()->t('Claims to be known to you: ');
$knowyou = (($notification['knowyou']) ? DI::l10n()->t('yes') : DI::l10n()->t('no'));
$knowyou = ($notification->getKnowYou() ? 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) {
} elseif ($notification->getNetwork() === 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']);
@ -113,17 +118,17 @@ class Introductions extends BaseNotifications
$dfrn_tpl = Renderer::getMarkupTemplate('notifications/netfriend.tpl');
$dfrn_text = Renderer::replaceMacros($dfrn_tpl, [
'$intro_id' => $notification['intro_id'],
'$intro_id' => $notification->getIntroId(),
'$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'))
'$as_fan' => (($notification->getNetwork() == Protocol::DIASPORA) ? DI::l10n()->t('Sharer') : DI::l10n()->t('Subscriber')),
]);
$contact = DBA::selectFirst('contact', ['network', 'protocol'], ['id' => $notification['contact_id']]);
$contact = DBA::selectFirst('contact', ['network', 'protocol'], ['id' => $notification->getContactId()]);
if (($contact['network'] != Protocol::DFRN) || ($contact['protocol'] == Protocol::ACTIVITYPUB)) {
$action = 'follow_confirm';
@ -137,45 +142,45 @@ class Introductions extends BaseNotifications
$header .= ' <' . $notification['addr'] . '>';
}
$header .= ' (' . ContactSelector::networkToName($notification['network'], $notification['url']) . ')';
$header .= ' (' . ContactSelector::networkToName($notification->getNetwork(), $notification->getUrl()) . ')';
if ($notification['network'] != Protocol::DIASPORA) {
if ($notification->getNetwork() != Protocol::DIASPORA) {
$discard = DI::l10n()->t('Discard');
} else {
$discard = '';
}
$notificationContent[] = Renderer::replaceMacros($notificationTemplate, [
'$type' => $notification['label'],
'$type' => $notification->getLabel(),
'$header' => $header,
'str_notification_type' => DI::l10n()->t('Notification type:'),
'str_type' => $notification['notifytype'],
'str_type' => $notification->getType(),
'$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'],
'$dfrn_id' => $notification->getDfrnId(),
'$uid' => $notification->getUid(),
'$intro_id' => $notification->getIntroId(),
'$contact_id' => $notification->getContactId(),
'$photo' => $notification->getPhoto(),
'$fullname' => $notification->getName(),
'$location' => $notification->getLocation(),
'$lbl_location' => DI::l10n()->t('Location:'),
'$about' => $notification['about'],
'$about' => $notification->getAbout(),
'$lbl_about' => DI::l10n()->t('About:'),
'$keywords' => $notification['keywords'],
'$keywords' => $notification->getKeywords(),
'$lbl_keywords' => DI::l10n()->t('Tags:'),
'$gender' => $notification['gender'],
'$gender' => $notification->getGender(),
'$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'],
'$url' => $notification->getUrl(),
'$zrl' => $notification->getZrl(),
'$lbl_url' => DI::l10n()->t('Profile URL'),
'$addr' => $notification['addr'],
'$addr' => $notification->getAddr(),
'$lbl_knowyou' => $lbl_knowyou,
'$lbl_network' => DI::l10n()->t('Network:'),
'$network' => ContactSelector::networkToName($notification['network'], $notification['url']),
'$network' => ContactSelector::networkToName($notification->getNetwork(), $notification->getUrl()),
'$knowyou' => $knowyou,
'$approve' => DI::l10n()->t('Approve'),
'$note' => $notification['note'],
'$note' => $notification->getNote(),
'$ignore' => DI::l10n()->t('Ignore'),
'$discard' => $discard,
'$action' => $action,

View file

@ -23,7 +23,11 @@ class Notification extends BaseModule
{
// @TODO: Replace with parameter from router
if (DI::args()->get(1) === 'mark' && DI::args()->get(2) === 'all') {
$success = DI::notification()->setAllSeen();
try {
$success = DI::notification()->setAllSeen();
}catch (\Exception $e) {
$success = false;
}
header('Content-type: application/json; charset=utf-8');
echo json_encode([
@ -43,14 +47,16 @@ class Notification extends BaseModule
{
// @TODO: Replace with parameter from router
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 = $notificationManager->getByID(DI::args()->get(2));
if (!empty($note)) {
$notificationManager->setSeen($note);
if (!empty($note['link'])) {
System::externalRedirect($note['link']);
try {
$notification = DI::notification()->getByID(DI::args()->get(2));
$notification->setSeen();
if (!empty($notification->link)) {
System::externalRedirect($notification->link);
}
} catch (HTTPException\NotFoundException $e) {
info(DI::l10n()->t('Invalid notification.'));
}
DI::baseUrl()->redirect();

View file

@ -3,10 +3,10 @@
namespace Friendica\Module\Notifications;
use Friendica\Content\Nav;
use Friendica\Content\Pager;
use Friendica\Core\Renderer;
use Friendica\DI;
use Friendica\Module\BaseNotifications;
use Friendica\Object\Notification\Notification;
/**
* Prints all notification types except introduction:
@ -22,41 +22,46 @@ class Notifications extends BaseNotifications
*/
public static function getNotifications()
{
$nm = DI::notification();
$notificationHeader = '';
/** @var Notification[] $notifications */
$notifications = [];
// 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);
$notifications = [
'ident' => Notification::NETWORK,
'notifications' => DI::factNotification()->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);
$notifications = [
'ident' => Notification::SYSTEM,
'notifications' => DI::factNotification()->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);
$notifications = [
'ident' => Notification::PERSONAL,
'notifications' => DI::factNotification()->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);
$notifications = [
'ident' => Notification::HOME,
'notifications' => DI::factNotification()->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,
@ -78,6 +83,7 @@ class Notifications extends BaseNotifications
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).
/** @var Notification $notification */
foreach ($notifications['notifications'] as $notification) {
$notification_templates = [
'like' => 'notifications/likes_item.tpl',
@ -91,17 +97,17 @@ class Notifications extends BaseNotifications
'notification' => 'notifications/notification.tpl',
];
$notificationTemplate = Renderer::getMarkupTemplate($notification_templates[$notification['label']]);
$notificationTemplate = Renderer::getMarkupTemplate($notification_templates[$notification->getLabel()]);
$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'],
'$item_label' => $notification->getLabel(),
'$item_link' => $notification->getLink(),
'$item_image' => $notification->getImage(),
'$item_url' => $notification->getUrl(),
'$item_text' => $notification->getText(),
'$item_when' => $notification->getWhen(),
'$item_ago' => $notification->getAgo(),
'$item_seen' => $notification->isSeen(),
]);
}
} else {