bitPickups/friendica_2020-09-1_sharedHosting
1
0
Fork 0
Code Pull requests Activity

Fix API result, add PHPDoc and cleanup object construction

Browse source 
Fix missing getters
fix data array
fix missing "$" for template-variables
Remove lazy-loaded parent notification instance (for now..)
This commit is contained in:
Philipp Holzer 2020-01-25 20:00:58 +01:00
parent 4c5856da2b
commit 74f3a2f90c
No known key found for this signature in database
GPG key ID: D8365C3D36B77D90
7 changed files with 203 additions and 218 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
include/api.php
View file

@ -5909,16 +5909,21 @@ function api_friendica_notification($type)
$notifications = DI::notification()->select([], ['order' => ['seen' => 'ASC', 'date' => 'DESC'], 'limit' => 50]);
if ($type == "xml") {
$xmlnotes = [];
$xmlnotes = false;
if (!empty($notifications)) {
foreach ($notifications as $notification) {
$xmlnotes[] = ["@attributes" => $notification->toArray()];
}
}
$notifications = $xmlnotes;
$result = $xmlnotes;
} elseif (count($notifications) > 0) {
$result = $notifications->getArrayCopy();
} else {
$result = false;
}
return api_format_data("notes", $type, ['note' => $notifications->getArrayCopy()]);
return api_format_data("notes", $type, ['note' => $result]);
}
/**

6
src/Factory/Notification/IntroductionFactory.php
View file

@ -19,6 +19,12 @@ use Friendica\Object\Notification\Introduction;
use Friendica\Util\Proxy;
use Psr\Log\LoggerInterface;
/**
* Factory for creating notification objects based on introductions
* Currently, there are two main types of introduction based notifications:
* - Friend suggestion
* - Friend/Follower request
*/
class IntroductionFactory extends BaseFactory
{
/** @var Database */

162
src/Factory/Notification/NotificationFactory.php
View file

@ -23,6 +23,14 @@ use Friendica\Util\Temporal;
use Friendica\Util\XML;
use Psr\Log\LoggerInterface;
/**
* Factory for creating notification objects based on items
* Currently, there are the following types of item based notifications:
* - network
* - system
* - home
* - personal
*/
class NotificationFactory extends BaseFactory
{
/** @var Database */
@ -93,97 +101,89 @@ class NotificationFactory extends BaseFactory
// Transform the different types of notification in an usable array
switch ($item['verb'] ?? '') {
case Activity::LIKE:
return new \Friendica\Object\Notification\Notification(
'like',
$this->baseUrl->get(true) . '/display/' . $item['parent-guid'],
Proxy::proxifyUrl($item['author-avatar'], false, Proxy::SIZE_MICRO),
$item['author-link'],
$this->l10n->t("%s liked %s's post", $item['author-name'], $item['parent-author-name']),
$item['when'] ?? '',
$item['ago'] ?? '',
$item['seen'] ?? false);
return new \Friendica\Object\Notification\Notification([
'label' => 'like',
'link' => $this->baseUrl->get(true) . '/display/' . $item['parent-guid'],
'image' => Proxy::proxifyUrl($item['author-avatar'], false, Proxy::SIZE_MICRO),
'url' => $item['author-link'],
'text' => $this->l10n->t("%s liked %s's post", $item['author-name'], $item['parent-author-name']),
'when' => $item['when'],
'ago' => $item['ago'],
'seen' => $item['seen']]);
case Activity::DISLIKE:
return new \Friendica\Object\Notification\Notification(
'dislike',
$this->baseUrl->get(true) . '/display/' . $item['parent-guid'],
Proxy::proxifyUrl($item['author-avatar'], false, Proxy::SIZE_MICRO),
$item['author-link'],
$this->l10n->t("%s disliked %s's post", $item['author-name'], $item['parent-author-name']),
$item['when'] ?? '',
$item['ago'] ?? '',
$item['seen'] ?? false);
return new \Friendica\Object\Notification\Notification([
'label' => 'dislike',
'link' => $this->baseUrl->get(true) . '/display/' . $item['parent-guid'],
'image' => Proxy::proxifyUrl($item['author-avatar'], false, Proxy::SIZE_MICRO),
'url' => $item['author-link'],
'text' => $this->l10n->t("%s disliked %s's post", $item['author-name'], $item['parent-author-name']),
'when' => $item['when'],
'ago' => $item['ago'],
'seen' => $item['seen']]);
case Activity::ATTEND:
return new \Friendica\Object\Notification\Notification(
'attend',
$this->baseUrl->get(true) . '/display/' . $item['parent-guid'],
Proxy::proxifyUrl($item['author-avatar'], false, Proxy::SIZE_MICRO),
$item['author-link'],
$this->l10n->t("%s is attending %s's event", $item['author-name'], $item['parent-author-name']),
$item['when'] ?? '',
$item['ago'] ?? '',
$item['seen'] ?? false);
return new \Friendica\Object\Notification\Notification([
'label' => 'attend',
'link' => $this->baseUrl->get(true) . '/display/' . $item['parent-guid'],
'image' => Proxy::proxifyUrl($item['author-avatar'], false, Proxy::SIZE_MICRO),
'url' => $item['author-link'],
'text' => $this->l10n->t("%s is attending %s's event", $item['author-name'], $item['parent-author-name']),
'when' => $item['when'],
'ago' => $item['ago'],
'seen' => $item['seen']]);
case Activity::ATTENDNO:
return new \Friendica\Object\Notification\Notification(
'attendno',
$this->baseUrl->get(true) . '/display/' . $item['parent-guid'],
Proxy::proxifyUrl($item['author-avatar'], false, Proxy::SIZE_MICRO),
$item['author-link'],
$this->l10n->t("%s is not attending %s's event", $item['author-name'], $item['parent-author-name']),
$item['when'] ?? '',
$item['ago'] ?? '',
$item['seen'] ?? false);
return new \Friendica\Object\Notification\Notification([
'label' => 'attendno',
'link' => $this->baseUrl->get(true) . '/display/' . $item['parent-guid'],
'image' => Proxy::proxifyUrl($item['author-avatar'], false, Proxy::SIZE_MICRO),
'url' => $item['author-link'],
'text' => $this->l10n->t("%s is not attending %s's event", $item['author-name'], $item['parent-author-name']),
'when' => $item['when'],
'ago' => $item['ago'],
'seen' => $item['seen']]);
case Activity::ATTENDMAYBE:
return new \Friendica\Object\Notification\Notification(
'attendmaybe',
$this->baseUrl->get(true) . '/display/' . $item['parent-guid'],
Proxy::proxifyUrl($item['author-avatar'], false, Proxy::SIZE_MICRO),
$item['author-link'],
$this->l10n->t("%s may attending %s's event", $item['author-name'], $item['parent-author-name']),
$item['when'] ?? '',
$item['ago'] ?? '',
$item['seen'] ?? false);
return new \Friendica\Object\Notification\Notification([
'label' => 'attendmaybe',
'link' => $this->baseUrl->get(true) . '/display/' . $item['parent-guid'],
'image' => Proxy::proxifyUrl($item['author-avatar'], false, Proxy::SIZE_MICRO),
'url' => $item['author-link'],
'text' => $this->l10n->t("%s may attending %s's event", $item['author-name'], $item['parent-author-name']),
'when' => $item['when'],
'ago' => $item['ago'],
'seen' => $item['seen']]);
case Activity::FRIEND:
if (!isset($item['object'])) {
return new \Friendica\Object\Notification\Notification(
'friend',
$item['link'],
$item['image'],
$item['url'],
$item['text'],
$item['when'] ?? '',
$item['ago'] ?? '',
$item['seen'] ?? false);
return new \Friendica\Object\Notification\Notification([
'label' => 'friend',
'link' => $item['link'],
'image' => $item['image'],
'url' => $item['url'],
'text' => $item['text'],
'when' => $item['when'],
'ago' => $item['ago'],
'seen' => $item['seen']]);
}
$xmlHead = "<" . "?xml version='1.0' encoding='UTF-8' ?" . ">";
$obj = XML::parseString($xmlHead . $item['object']);
$item['fname'] = $obj->title;
return new \Friendica\Object\Notification\Notification(
'friend',
$this->baseUrl->get(true) . '/display/' . $item['parent-guid'],
Proxy::proxifyUrl($item['author-avatar'], false, Proxy::SIZE_MICRO),
$item['author-link'],
$this->l10n->t("%s is now friends with %s", $item['author-name'], $item['fname']),
$item['when'] ?? '',
$item['ago'] ?? '',
$item['seen'] ?? false);
return new \Friendica\Object\Notification\Notification([
'label' => 'friend',
'link' => $this->baseUrl->get(true) . '/display/' . $item['parent-guid'],
'image' => Proxy::proxifyUrl($item['author-avatar'], false, Proxy::SIZE_MICRO),
'url' => $item['author-link'],
'text' => $this->l10n->t("%s is now friends with %s", $item['author-name'], $item['fname']),
'when' => $item['when'],
'ago' => $item['ago'],
'seen' => $item['seen']]);
default:
return new \Friendica\Object\Notification\Notification(
$item['label'],
$item['link'],
$item['image'],
$item['url'],
$item['text'],
$item['when'] ?? '',
$item['ago'] ?? '',
$item['seen'] ?? false);
return new \Friendica\Object\Notification\Notification($item);
break;
}
}
@ -215,15 +215,15 @@ class NotificationFactory extends BaseFactory
$notifications = $this->notification->select($conditions, $params);
foreach ($notifications as $notification) {
$formattedNotifications[] = new \Friendica\Object\Notification\Notification(
'notification',
$this->baseUrl->get(true) . '/notification/view/' . $notification->id,
Proxy::proxifyUrl($notification->photo, false, Proxy::SIZE_MICRO),
$notification->url,
strip_tags(BBCode::convert($notification->msg)),
DateTimeFormat::local($notification->date, 'r'),
Temporal::getRelativeDate($notification->date),
$notification->seen);
$formattedNotifications[] = new \Friendica\Object\Notification\Notification([
'label' => 'notification',
'link' => $this->baseUrl->get(true) . '/notification/view/' . $notification->id,
'image' => Proxy::proxifyUrl($notification->photo, false, Proxy::SIZE_MICRO),
'url' => $notification->url,
'text' => strip_tags(BBCode::convert($notification->msg)),
'when' => DateTimeFormat::local($notification->date, 'r'),
'ago' => Temporal::getRelativeDate($notification->date),
'seen' => $notification->seen]);
}
} catch (Exception $e) {
$this->logger->warning('Select failed.', ['conditions' => $conditions, 'exception' => $e]);

24
src/Model/Notification.php
View file

@ -46,8 +46,6 @@ class Notification extends BaseModel
{
/** @var \Friendica\Repository\Notification */
private $repo;
/** @var $this */
private $parentInst;
public function __construct(Database $dba, LoggerInterface $logger, \Friendica\Repository\Notification $repo, array $data = [])
{
@ -118,28 +116,6 @@ class Notification extends BaseModel
}
}
public function __get($name)
{
$this->checkValid();
$return = null;
switch ($name) {
case 'parent':
if (!empty($this->parent)) {
$this->parentInst = $this->parentInst ?? $this->repo->getByID($this->parent);
$return = $this->parentInst;
}
break;
default:
$return = parent::__get($name);
break;
}
return $return;
}
public function __set($name, $value)
{
parent::__set($name, $value);

26
src/Module/Notifications/Introductions.php
View file

@ -64,12 +64,12 @@ class Introductions extends BaseNotifications
// 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']) {
switch ($notification->getLabel()) {
case 'friend_suggestion':
$notificationContent[] = Renderer::replaceMacros($notificationSuggestions, [
'$type' => $notification->getLabel(),
'str_notification_type' => DI::l10n()->t('Notification type:'),
'str_type' => $notification->getType(),
'$str_notification_type' => DI::l10n()->t('Notification type:'),
'$str_type' => $notification->getType(),
'$intro_id' => $notification->getIntroId(),
'$lbl_madeby' => DI::l10n()->t('Suggested by:'),
'$madeby' => $notification->getMadeBy(),
@ -108,12 +108,12 @@ class Introductions extends BaseNotifications
$lbl_knowyou = DI::l10n()->t('Claims to be known to you: ');
$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']);
$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->getName(), $notification->getName());
$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->getName());
} 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']);
$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->getName(), $notification->getName());
$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->getName());
}
$dfrn_tpl = Renderer::getMarkupTemplate('notifications/netfriend.tpl');
@ -136,10 +136,10 @@ class Introductions extends BaseNotifications
$action = 'dfrn_confirm';
}
$header = $notification['name'];
$header = $notification->getName();
if ($notification['addr'] != '') {
$header .= ' <' . $notification['addr'] . '>';
if ($notification->getAddr() != '') {
$header .= ' <' . $notification->getAddr() . '>';
}
$header .= ' (' . ContactSelector::networkToName($notification->getNetwork(), $notification->getUrl()) . ')';
@ -153,8 +153,8 @@ class Introductions extends BaseNotifications
$notificationContent[] = Renderer::replaceMacros($notificationTemplate, [
'$type' => $notification->getLabel(),
'$header' => $header,
'str_notification_type' => DI::l10n()->t('Notification type:'),
'str_type' => $notification->getType(),
'$str_notification_type' => DI::l10n()->t('Notification type:'),
'$str_type' => $notification->getType(),
'$dfrn_text' => $dfrn_text,
'$dfrn_id' => $notification->getDfrnId(),
'$uid' => $notification->getUid(),
@ -170,7 +170,7 @@ class Introductions extends BaseNotifications
'$lbl_keywords' => DI::l10n()->t('Tags:'),
'$gender' => $notification->getGender(),
'$lbl_gender' => DI::l10n()->t('Gender:'),
'$hidden' => ['hidden', DI::l10n()->t('Hide this contact from others'), ($notification['hidden'] == 1), ''],
'$hidden' => ['hidden', DI::l10n()->t('Hide this contact from others'), $notification->isHidden(), ''],
'$url' => $notification->getUrl(),
'$zrl' => $notification->getZrl(),
'$lbl_url' => DI::l10n()->t('Profile URL'),

68
src/Object/Notification/Introduction.php
View file

@ -12,7 +12,7 @@ class Introduction implements \JsonSerializable
/** @var string */
private $type = '';
/** @var integer */
private $intro_id = 0;
private $intro_id = -1;
/** @var string */
private $madeBy = '';
/** @var string */
@ -22,7 +22,7 @@ class Introduction implements \JsonSerializable
/** @var string */
private $madeByAddr = '';
/** @var integer */
private $contactId = 0;
private $contactId = -1;
/** @var string */
private $photo = '';
/** @var string */
@ -34,29 +34,29 @@ class Introduction implements \JsonSerializable
/** @var boolean */
private $hidden = false;
/** @var integer */
private $postNewFriend = 0;
/** @var string */
private $knowYou = '';
private $postNewFriend = -1;
/** @var boolean */
private $knowYou = false;
/** @var string */
private $note = '';
/** @var string */
private $request = '';
/** @var string */
private $dfrnId;
/** @var string */
private $addr;
/** @var string */
private $network;
/** @var int */
private $uid;
private $dfrnId = -1;
/** @var string */
private $keywords;
private $addr = '';
/** @var string */
private $gender;
private $network = '';
/** @var int */
private $uid = -1;
/** @var string */
private $location;
private $keywords = '';
/** @var string */
private $about;
private $gender = '';
/** @var string */
private $location = '';
/** @var string */
private $about = '';
/**
* @return string
@ -261,26 +261,26 @@ class Introduction implements \JsonSerializable
public function __construct(array $data = [])
{
$this->label = $data['label'] ?? '';
$this->type = $data['str_$type'] ?? '';
$this->intro_id = $data['$intro_id'] ?? '';
$this->madeBy = $data['$madeBy'] ?? '';
$this->madeByUrl = $data['$madeByUrl'] ?? '';
$this->madeByZrl = $data['$madeByZrl'] ?? '';
$this->madeByAddr = $data['$madeByAddr'] ?? '';
$this->contactId = $data['$contactId'] ?? '';
$this->photo = $data['$photo'] ?? '';
$this->name = $data['$name'] ?? '';
$this->url = $data['$url'] ?? '';
$this->zrl = $data['$zrl'] ?? '';
$this->hidden = $data['$hidden'] ?? '';
$this->postNewFriend = $data['$postNewFriend'] ?? '';
$this->knowYou = $data['$knowYou'] ?? '';
$this->note = $data['$note'] ?? '';
$this->request = $data['$request'] ?? '';
$this->dfrnId = $data['dfrn_id'] ?? '';
$this->type = $data['str_type'] ?? '';
$this->intro_id = $data['$intro_id'] ?? -1;
$this->madeBy = $data['madeBy'] ?? '';
$this->madeByUrl = $data['madeByUrl'] ?? '';
$this->madeByZrl = $data['madeByZrl'] ?? '';
$this->madeByAddr = $data['madeByAddr'] ?? '';
$this->contactId = $data['contactId'] ?? '';
$this->photo = $data['photo'] ?? '';
$this->name = $data['name'] ?? '';
$this->url = $data['url'] ?? '';
$this->zrl = $data['zrl'] ?? '';
$this->hidden = $data['hidden'] ?? false;
$this->postNewFriend = $data['postNewFriend'] ?? '';
$this->knowYou = $data['knowYou'] ?? false;
$this->note = $data['note'] ?? '';
$this->request = $data['request'] ?? '';
$this->dfrnId = $data['dfrn_id'] ?? -1;
$this->addr = $data['addr'] ?? '';
$this->network = $data['network'] ?? '';
$this->uid = $data['uid'] ?? '';
$this->uid = $data['uid'] ?? -1;
$this->keywords = $data['keywords'] ?? '';
$this->gender = $data['gender'] ?? '';
$this->location = $data['location'] ?? '';

20
src/Object/Notification/Notification.php
View file

@ -94,18 +94,16 @@ class Notification implements \JsonSerializable
return $this->seen;
}
public function __construct(string $label = '', string $link = '', string $image = '',
string $url = '', string $text = '',
string $when = '', string $ago = '', bool $seen = false)
public function __construct(array $data)
{
$this->label = $label;
$this->link = $link;
$this->image = $image;
$this->url = $url;
$this->text = $text;
$this->when = $when;
$this->ago = $ago;
$this->seen = $seen;
$this->label = $data['label'] ?? '';
$this->link = $data['link'] ?? '';
$this->image = $data['image'] ?? '';
$this->url = $data['url'] ?? '';
$this->text = $data['text'] ?? '';
$this->when = $data['when'] ?? '';
$this->ago = $data['ago'] ?? '';
$this->seen = $data['seen'] ?? false;
}
/**