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

[PLUGINS][DeleteNote] Added documentation, stating the scope of what deleting a Note means

Browse Source
This commit is contained in:
Eliseu Amaro 2021-12-28 22:43:04 +00:00
parent ce3c6a7f23
commit 8274e93ed5
Signed by: eliseuamaro
GPG Key ID: 96DA09D4B97BC2D5
1 changed files with 99 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
plugins/DeleteNote/DeleteNote.php
View File

@ -1,6 +1,6 @@
<?php <?php
declare(strict_types = 1); declare(strict_types=1);
// {{{ License // {{{ License
// This file is part of GNU social - https://www.gnu.org/software/social // This file is part of GNU social - https://www.gnu.org/software/social
@ -21,9 +21,9 @@ declare(strict_types = 1);
namespace Plugin\DeleteNote; namespace Plugin\DeleteNote;
use ActivityPhp\Type\AbstractObject;
use App\Core\DB\DB; use App\Core\DB\DB;
use App\Core\Event; use App\Core\Event;
use function App\Core\I18n\_m;
use App\Core\Modules\NoteHandlerPlugin; use App\Core\Modules\NoteHandlerPlugin;
use App\Core\Router\RouteLoader; use App\Core\Router\RouteLoader;
use App\Core\Router\Router; use App\Core\Router\Router;
@ -33,12 +33,16 @@ use App\Entity\Note;
use App\Util\Common; use App\Util\Common;
use App\Util\Exception\ClientException; use App\Util\Exception\ClientException;
use DateTime; use DateTime;
use Plugin\ActivityPub\ActivityPub; use Plugin\ActivityPub\Entity\ActivitypubActivity;
use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Request;
use function App\Core\I18n\_m;
use function is_int;
use function is_null;
/** /**
* Delete note plugin main class. * Delete note plugin main class.
* Adds "delete this note" action to respective note if the user logged in is the author. * Adds "delete this note" action to respective note if the user logged in is
* the author.
* *
* @package GNUsocial * @package GNUsocial
* @category DeleteNote * @category DeleteNote
@ -49,6 +53,35 @@ use Symfony\Component\HttpFoundation\Request;
*/ */
class DeleteNote extends NoteHandlerPlugin class DeleteNote extends NoteHandlerPlugin
{ {
/**
* **Checks actor permissions for the DeleteNote action, deletes given Note
* and creates respective Activity and Notification**
*
* Ensures the given Actor has sufficient permissions to perform the
* deletion.
* If it does, **Undertaker** will carry on, spelling doom for
* the given Note and **everything related to it**
* - Replies and Conversation **are unaffected**, except for the fact that
* this Note no longer exists, of course
* - Replies to this Note **will** remain on the same Conversation, and can
* **still be seen** on that Conversation (potentially separated from a
* parent, this Note)
*
* Replies shouldn't be taken out of context in any additional way, and
* **Undertaker** only calls the methods necessary to accomplish the
* deletion of this Note. Not any other as collateral damage.
*
* Creates the **_delete_ (verb)** Activity, performed on the given **Note
* (object)**, by the given **Actor (subject)**. Launches the
* NewNotification Event, stating who dared to call Undertaker.
*
* @param \App\Entity\Actor $actor
* @param \App\Entity\Note $note
*
* @return \App\Entity\Activity
* @throws \App\Util\Exception\ClientException
* @throws \App\Util\Exception\ServerException
*/
private static function undertaker(Actor $actor, Note $note): Activity private static function undertaker(Actor $actor, Note $note): Activity
{ {
// Check permissions // Check permissions
@ -64,12 +97,28 @@ class DeleteNote extends NoteHandlerPlugin
return $activity; return $activity;
} }
/**
* Delegates **DeleteNote::undertaker** to delete the Note provided
*
* Checks whether the Note has already been deleted, only passing on the
* responsibility to undertaker if the Note wasn't.
*
* @param \App\Entity\Note|int $note
* @param \App\Entity\Actor|int $actor
* @param string $source
*
* @return \App\Entity\Activity|null
* @throws \App\Util\Exception\ClientException
* @throws \App\Util\Exception\DuplicateFoundException
* @throws \App\Util\Exception\NotFoundException
* @throws \App\Util\Exception\ServerException
*/
public static function deleteNote(Note|int $note, Actor|int $actor, string $source = 'web'): ?Activity public static function deleteNote(Note|int $note, Actor|int $actor, string $source = 'web'): ?Activity
{ {
$actor = \is_int($actor) ? Actor::getById($actor) : $actor; $actor = is_int($actor) ? Actor::getById($actor) : $actor;
$note = \is_int($note) ? Note::getById($note) : $note; $note = is_int($note) ? Note::getById($note) : $note;
// Try and find if note was already deleted // Try and find if note was already deleted
if (\is_null(DB::findOneBy(Activity::class, ['verb' => 'delete', 'object_type' => 'note', 'object_id' => $note->getId()], return_null: true))) { if (is_null(DB::findOneBy(Activity::class, ['verb' => 'delete', 'object_type' => 'note', 'object_id' => $note->getId()], return_null: true))) {
// If none found, then undertaker has a job to do // If none found, then undertaker has a job to do
return self::undertaker($actor, $note); return self::undertaker($actor, $note);
} else { } else {
@ -77,6 +126,14 @@ class DeleteNote extends NoteHandlerPlugin
} }
} }
/**
* Adds and connects the _delete_note_action_ route to
* Controller\DeleteNote::class
*
* @param \App\Core\Router\RouteLoader $r
*
* @return bool Event hook
*/
public function onAddRoute(RouteLoader $r) public function onAddRoute(RouteLoader $r)
{ {
$r->connect(id: 'delete_note_action', uri_path: '/object/note/{note_id<\d+>}/delete', target: Controller\DeleteNote::class); $r->connect(id: 'delete_note_action', uri_path: '/object/note/{note_id<\d+>}/delete', target: Controller\DeleteNote::class);
@ -84,13 +141,28 @@ class DeleteNote extends NoteHandlerPlugin
return Event::next; return Event::next;
} }
/**
* **Catches AddExtraNoteActions Event**
*
* Adds an anchor link to the route _delete_note_action_ in the **Note card
* template**. More specifically, in the **note_actions block**.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* @param \App\Entity\Note $note
* @param array $actions
*
* @return bool Event hook
* @throws \App\Util\Exception\DuplicateFoundException
* @throws \App\Util\Exception\NotFoundException
* @throws \App\Util\Exception\ServerException
*/
public function onAddExtraNoteActions(Request $request, Note $note, array &$actions) public function onAddExtraNoteActions(Request $request, Note $note, array &$actions)
{ {
if (\is_null($actor = Common::actor())) { if (is_null($actor = Common::actor())) {
return Event::next; return Event::next;
} }
// Only add action if note wasn't already deleted! // Only add action if note wasn't already deleted!
if (\is_null(DB::findOneBy(Activity::class, ['verb' => 'delete', 'object_type' => 'note', 'object_id' => $note->getId()], return_null: true)) if (is_null(DB::findOneBy(Activity::class, ['verb' => 'delete', 'object_type' => 'note', 'object_id' => $note->getId()], return_null: true))
// And has permissions // And has permissions
&& $actor->canAdmin($note->getActor())) { && $actor->canAdmin($note->getActor())) {
$delete_action_url = Router::url('delete_note_action', ['note_id' => $note->getId()]); $delete_action_url = Router::url('delete_note_action', ['note_id' => $note->getId()]);
@ -106,9 +178,11 @@ class DeleteNote extends NoteHandlerPlugin
return Event::next; return Event::next;
} }
// ActivityPub /*
* ActivityPub handling and processing for DeleteNote start
*/
private function activitypub_handler(Actor $actor, \ActivityPhp\Type\AbstractObject $type_activity, mixed $type_object, ?\Plugin\ActivityPub\Entity\ActivitypubActivity &$ap_act): bool private function activitypub_handler(Actor $actor, AbstractObject $type_activity, mixed $type_object, ?ActivitypubActivity &$ap_act): bool
{ {
if ($type_activity->get('type') !== 'Delete' if ($type_activity->get('type') !== 'Delete'
|| !($type_object instanceof Note)) { || !($type_object instanceof Note)) {
@ -116,9 +190,9 @@ class DeleteNote extends NoteHandlerPlugin
} }
$activity = self::deleteNote($type_object, $actor, source: 'ActivityPub'); $activity = self::deleteNote($type_object, $actor, source: 'ActivityPub');
if (!\is_null($activity)) { if (!is_null($activity)) {
// Store ActivityPub Activity // Store ActivityPub Activity
$ap_act = \Plugin\ActivityPub\Entity\ActivitypubActivity::create([ $ap_act = ActivitypubActivity::create([
'activity_id' => $activity->getId(), 'activity_id' => $activity->getId(),
'activity_uri' => $type_activity->get('id'), 'activity_uri' => $type_activity->get('id'),
'created' => new DateTime($type_activity->get('published') ?? 'now'), 'created' => new DateTime($type_activity->get('published') ?? 'now'),
@ -129,12 +203,12 @@ class DeleteNote extends NoteHandlerPlugin
return Event::stop; return Event::stop;
} }
public function onNewActivityPubActivity(Actor $actor, \ActivityPhp\Type\AbstractObject $type_activity, \ActivityPhp\Type\AbstractObject $type_object, ?\Plugin\ActivityPub\Entity\ActivitypubActivity &$ap_act): bool public function onNewActivityPubActivity(Actor $actor, AbstractObject $type_activity, AbstractObject $type_object, ?ActivitypubActivity &$ap_act): bool
{ {
return $this->activitypub_handler($actor, $type_activity, $type_object, $ap_act); return $this->activitypub_handler($actor, $type_activity, $type_object, $ap_act);
} }
public function onNewActivityPubActivityWithObject(Actor $actor, \ActivityPhp\Type\AbstractObject $type_activity, mixed $type_object, ?\Plugin\ActivityPub\Entity\ActivitypubActivity &$ap_act): bool public function onNewActivityPubActivityWithObject(Actor $actor, AbstractObject $type_activity, mixed $type_object, ?ActivitypubActivity &$ap_act): bool
{ {
return $this->activitypub_handler($actor, $type_activity, $type_object, $ap_act); return $this->activitypub_handler($actor, $type_activity, $type_object, $ap_act);
} }