GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

[NOTIFICATION] Implement Target Collector

Browse Source
This commit is contained in:
Diogo Peralta Cordeiro
2021-11-27 04:12:44 +00:00
parent 51994406da
commit 7b9d388a44
11 changed files with 423 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

160
components/Notification/Entity/Notification.php Normal file
View File

@@ -0,0 +1,160 @@
<?php
// {{{ License
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
// }}}
namespace Component\Notification\Entity;
use App\Core\DB\DB;
use App\Core\Entity;
use App\Entity\Actor;
use DateTimeInterface;
/**
* Entity for attentions
*
* @category DB
* @package GNUsocial
*
* @author Zach Copley <zach@status.net>
* @copyright 2010 StatusNet Inc.
* @author Mikael Nordfeldth <mmn@hethane.se>
* @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org
* @author Hugo Sales <hugo@hsal.es>
* @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
class Notification extends Entity
{
// {{{ Autocode
// @codeCoverageIgnoreStart
private int $activity_id;
private int $target_id;
private ?string $reason;
private \DateTimeInterface $created;
private \DateTimeInterface $modified;
public function setActivityId(int $activity_id): self
{
$this->activity_id = $activity_id;
return $this;
}
public function getActivityId(): int
{
return $this->activity_id;
}
public function setTargetId(int $target_id): self
{
$this->target_id = $target_id;
return $this;
}
public function getTargetId(): int
{
return $this->target_id;
}
public function setReason(?string $reason): self
{
$this->reason = $reason;
return $this;
}
public function getReason(): ?string
{
return $this->reason;
}
public function setCreated(DateTimeInterface $created): self
{
$this->created = $created;
return $this;
}
public function getCreated(): DateTimeInterface
{
return $this->created;
}
public function setModified(DateTimeInterface $modified): self
{
$this->modified = $modified;
return $this;
}
public function getModified(): DateTimeInterface
{
return $this->modified;
}
// @codeCoverageIgnoreEnd
// }}} Autocode
/**
* @return Actor
*/
public function getTarget(): Actor
{
return Actor::getById($this->getActorId());
}
/**
* Pull the complete list of known activity context notifications for this activity.
*
* @return array of integer actor ids (also group profiles)
*/
public static function getNotificationTargetIdsByActivity(int|Activity $activity_id): array
{
$notifications = DB::findBy('notification', ['activity_id' => is_int($activity_id) ? $activity_id : $activity_id->getId()]);
$targets = [];
foreach ($notifications as $notification) {
$targets[] = $notification->getTargetId();
}
return $targets;
}
/**
* @param int|Activity $activity_id
* @return array
*/
public function getNotificationTargetsByActivity(int|Activity $activity_id): array
{
return DB::findBy('actor', ['id' => $this->getNotificationTargetIdsByActivity($activity_id)]);
}
public static function schemaDef(): array
{
return [
'name' => 'notification',
'description' => 'Activity notification for actors (that are not a mention and not result of a subscription)',
'fields' => [
'activity_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Activity.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'activity_id to give attention'],
'target_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Actor.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'actor_id for feed receiver'],
'reason' => ['type' => 'varchar', 'length' => 191, 'description' => 'Optional reason why this was brought to the attention of actor_id'],
'created' => ['type' => 'datetime', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was created'],
'modified' => ['type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
],
'primary key' => ['activity_id', 'target_id'],
'indexes' => [
'attention_activity_id_idx' => ['activity_id'],
'attention_target_id_idx' => ['target_id'],
],
];
}
}

237
components/Notification/Entity/UserNotificationPrefs.php Normal file
View File

@@ -0,0 +1,237 @@
<?php
// {{{ License
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
// }}}
namespace Component\Notification\Entity;
use App\Core\Entity;
use DateTimeInterface;
/**
* Entity for user notification preferences
*
* @category DB
* @package GNUsocial
*
* @author Hugo Sales <hugo@hsal.es>
* @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
class UserNotificationPrefs extends Entity
{
// {{{ Autocode
// @codeCoverageIgnoreStart
private int $user_id;
private string $transport;
private ?int $target_actor_id;
private bool $activity_by_subscribed = true;
private bool $mention = true;
private bool $reply = true;
private bool $subscription = true;
private bool $favorite = true;
private bool $nudge = false;
private bool $dm = true;
private bool $post_on_status_change = false;
private ?bool $enable_posting;
private \DateTimeInterface $created;
private \DateTimeInterface $modified;
public function setUserId(int $user_id): self
{
$this->user_id = $user_id;
return $this;
}
public function getUserId(): int
{
return $this->user_id;
}
public function setTransport(string $transport): self
{
$this->transport = $transport;
return $this;
}
public function getTransport(): string
{
return $this->transport;
}
public function setTargetActorId(?int $target_actor_id): self
{
$this->target_actor_id = $target_actor_id;
return $this;
}
public function getTargetActorId(): ?int
{
return $this->target_actor_id;
}
public function setActivityBySubscribed(bool $activity_by_subscribed): self
{
$this->activity_by_subscribed = $activity_by_subscribed;
return $this;
}
public function getActivityBySubscribed(): bool
{
return $this->activity_by_subscribed;
}
public function setMention(bool $mention): self
{
$this->mention = $mention;
return $this;
}
public function getMention(): bool
{
return $this->mention;
}
public function setReply(bool $reply): self
{
$this->reply = $reply;
return $this;
}
public function getReply(): bool
{
return $this->reply;
}
public function setSubscription(bool $subscription): self
{
$this->subscription = $subscription;
return $this;
}
public function getSubscription(): bool
{
return $this->subscription;
}
public function setFavorite(bool $favorite): self
{
$this->favorite = $favorite;
return $this;
}
public function getFavorite(): bool
{
return $this->favorite;
}
public function setNudge(bool $nudge): self
{
$this->nudge = $nudge;
return $this;
}
public function getNudge(): bool
{
return $this->nudge;
}
public function setDm(bool $dm): self
{
$this->dm = $dm;
return $this;
}
public function getDm(): bool
{
return $this->dm;
}
public function setPostOnStatusChange(bool $post_on_status_change): self
{
$this->post_on_status_change = $post_on_status_change;
return $this;
}
public function getPostOnStatusChange(): bool
{
return $this->post_on_status_change;
}
public function setEnablePosting(?bool $enable_posting): self
{
$this->enable_posting = $enable_posting;
return $this;
}
public function getEnablePosting(): ?bool
{
return $this->enable_posting;
}
public function setCreated(DateTimeInterface $created): self
{
$this->created = $created;
return $this;
}
public function getCreated(): DateTimeInterface
{
return $this->created;
}
public function setModified(DateTimeInterface $modified): self
{
$this->modified = $modified;
return $this;
}
public function getModified(): DateTimeInterface
{
return $this->modified;
}
// @codeCoverageIgnoreEnd
// }}} Autocode
public static function schemaDef(): array
{
return [
'name' => 'user_notification_prefs',
'fields' => [
'user_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'LocalUser.id', 'multiplicity' => 'one to one', 'not null' => true],
'transport' => ['type' => 'varchar', 'length' => 191, 'not null' => true, 'description' => 'transport (ex email. xmpp, aim)'],
'target_actor_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Actor.id', 'multiplicity' => 'one to one', 'default' => null, 'description' => 'If not null, settings are specific only to a given actors'],
'activity_by_subscribed' => ['type' => 'bool', 'not null' => true, 'default' => true, 'description' => 'Notify when a new activity by someone we subscribe is made'],
'mention' => ['type' => 'bool', 'not null' => true, 'default' => true, 'description' => 'Notify when mentioned by someone we do not subscribe'],
'reply' => ['type' => 'bool', 'not null' => true, 'default' => true, 'description' => 'Notify when someone replies to a notice made by us'],
'subscription' => ['type' => 'bool', 'not null' => true, 'default' => true, 'description' => 'Notify someone subscribes us'],
'favorite' => ['type' => 'bool', 'not null' => true, 'default' => true, 'description' => 'Notify someone favorites a notice by us'],
'nudge' => ['type' => 'bool', 'not null' => true, 'default' => false, 'description' => 'Notify someone nudges us'],
'dm' => ['type' => 'bool', 'not null' => true, 'default' => true, 'description' => 'Notify someone sends us a direct message'],
'post_on_status_change' => ['type' => 'bool', 'not null' => true, 'default' => false, 'description' => 'Post a notice when our status in service changes'],
'enable_posting' => ['type' => 'bool', 'default' => true, 'description' => 'Enable posting from this service'],
'created' => ['type' => 'datetime', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was created'],
'modified' => ['type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
],
'primary key' => ['user_id', 'transport'],
'indexes' => [
'user_notification_prefs_user_target_actor_idx' => ['user_id', 'target_actor_id'],
],
];
}
}

68
components/Notification/Notification.php Normal file
View File

@@ -0,0 +1,68 @@
<?php
declare(strict_types=1);
// {{{ License
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
// }}}
namespace Component\Notification;
use App\Core\DB\DB;
use App\Core\Event;
use App\Core\Log;
use App\Core\Modules\Component;
use App\Entity\Activity;
use App\Entity\Actor;
use Component\FreeNetwork\FreeNetwork;
use DateTime;
use DateTimeInterface;
class Notification extends Component
{
/**
* Enqueues a notification for an Actor (user or group) which means
* it shows up in their home feed and such.
*/
public function onNewNotification(Actor $sender, Activity $activity, array $ids_already_known = [], ?string $reason = null): bool
{
$targets = $activity->getNotificationTargets($ids_already_known);
foreach ($targets as $target) {
$this->notify($sender, $activity, $target, $reason);
}
return Event::next;
}
public function notify(Actor $sender, Activity $activity, Actor $target, ?string $reason = null): bool
{
if ($target->isGroup()) {
// FIXME: Make sure we check (for both local and remote) users are in the groups they send to!
} else {
if ($target->hasBlocked($activity->getActor())) {
Log::info("Not saving reply to actor {$target->getId()} from sender {$sender->getId()} because of a block.");
return false;
}
}
if ($target->getIsLocal()) {
// TODO: use https://symfony.com/doc/current/notifier.html
} else {
return FreeNetwork::notify($sender, $activity, $target, $reason);
}
return true;
}
}