diff --git a/plugins/RepeatNote/RepeatNote.php b/plugins/RepeatNote/RepeatNote.php
index 9964de54b9..a4e6bc4177 100644
--- a/plugins/RepeatNote/RepeatNote.php
+++ b/plugins/RepeatNote/RepeatNote.php
@@ -1,6 +1,6 @@
$actor_id,
- 'note_id' => $note->getId(),
- ])[0] ?? null;
+ 'actor_id' => $actor_id,
+ 'note_id' => $note->getId(),
+ ])[ 0 ] ?? null;
if (!\is_null($repeat_entity)) {
return null;
}
// If it's a repeat, the reply_to should be to the original, conversation ought to be the same
- $og_id = $note->getId();
- $extra_args['reply_to'] = $og_id;
+ $og_id = $note->getId();
+ $extra_args[ 'reply_to' ] = $og_id;
// Create a new note with the same content as the original
$repeat = Posting::storeLocalNote(
@@ -69,72 +93,88 @@ class RepeatNote extends NoteHandlerPlugin
);
DB::persist(NoteRepeat::create([
- 'note_id' => $repeat->getId(),
- 'actor_id' => $actor_id,
+ 'note_id' => $repeat->getId(),
+ 'actor_id' => $actor_id,
'repeat_of' => $og_id,
]));
// Log an activity
$repeat_activity = Activity::create([
- 'actor_id' => $actor_id,
- 'verb' => 'repeat',
+ 'actor_id' => $actor_id,
+ 'verb' => 'repeat',
'object_type' => 'note',
- 'object_id' => $note->getId(),
- 'source' => $source,
+ 'object_id' => $note->getId(),
+ 'source' => $source,
]);
DB::persist($repeat_activity);
- Event::handle('NewNotification', [$actor = Actor::getById($actor_id), $repeat_activity, [], _m('{nickname} repeated note {note_id}.', ['nickname' => $actor->getNickname(), 'note_id' => $repeat_activity->getObjectId()])]);
+ Event::handle('NewNotification', [$actor = Actor::getById($actor_id), $repeat_activity, [], _m('{nickname} repeated note {note_id}.', ['nickname' => $actor->getNickname(), 'note_id' => $repeat_activity->getObjectId()])]);
return $repeat_activity;
}
+ /**
+ * **Undoes a Repeat**
+ *
+ * Removes the Repeat from NoteRepeat table, and the deletes the Note
+ * clone.
+ *
+ * Finally, creates a new Activity, undoing the repeat, and the respective
+ * Notification is handled.
+ *
+ * @param int $note_id
+ * @param int $actor_id
+ * @param string $source
+ *
+ * @return \App\Entity\Activity|null
+ * @throws \App\Util\Exception\ServerException
+ */
public static function unrepeatNote(int $note_id, int $actor_id, string $source = 'web'): ?Activity
{
- $already_repeated = DB::findBy(NoteRepeat::class, ['actor_id' => $actor_id, 'repeat_of' => $note_id])[0] ?? null;
+ $already_repeated = DB::findBy(NoteRepeat::class, ['actor_id' => $actor_id, 'repeat_of' => $note_id])[ 0 ] ?? null;
if (!\is_null($already_repeated)) { // If it was repeated, then we can undo it
// Find previous repeat activity
$already_repeated_activity = DB::findBy(Activity::class, [
- 'actor_id' => $actor_id,
- 'verb' => 'repeat',
- 'object_type' => 'note',
- 'object_id' => $already_repeated->getRepeatOf(),
- ])[0] ?? null;
+ 'actor_id' => $actor_id,
+ 'verb' => 'repeat',
+ 'object_type' => 'note',
+ 'object_id' => $already_repeated->getRepeatOf(),
+ ])[ 0 ] ?? null;
// Remove the clone note
- DB::findBy(Note::class, ['id' => $already_repeated->getNoteId()])[0]->delete(actor: Actor::getById($actor_id));
+ DB::findBy(Note::class, ['id' => $already_repeated->getNoteId()])[ 0 ]->delete(actor: Actor::getById($actor_id));
// Remove from the note_repeat table
- DB::remove(DB::findBy(NoteRepeat::class, ['note_id' => $already_repeated->getNoteId()])[0]);
+ DB::remove(DB::findBy(NoteRepeat::class, ['note_id' => $already_repeated->getNoteId()])[ 0 ]);
// Log an activity
$undo_repeat_activity = Activity::create([
- 'actor_id' => $actor_id,
- 'verb' => 'undo',
+ 'actor_id' => $actor_id,
+ 'verb' => 'undo',
'object_type' => 'activity',
- 'object_id' => $already_repeated_activity->getId(),
- 'source' => $source,
+ 'object_id' => $already_repeated_activity->getId(),
+ 'source' => $source,
]);
DB::persist($undo_repeat_activity);
- Event::handle('NewNotification', [$actor = Actor::getById($actor_id), $undo_repeat_activity, [], _m('{nickname} unrepeated note {note_id}.', ['nickname' => $actor->getNickname(), 'note_id' => $note_id])]);
+ Event::handle('NewNotification', [$actor = Actor::getById($actor_id), $undo_repeat_activity, [], _m('{nickname} unrepeated note {note_id}.', ['nickname' => $actor->getNickname(), 'note_id' => $note_id])]);
return $undo_repeat_activity;
} else {
// Either was undoed already
if (!\is_null($already_repeated_activity = DB::findBy('activity', [
- 'actor_id' => $actor_id,
- 'verb' => 'repeat',
- 'object_type' => 'note',
- 'object_id' => $note_id,
- ])[0] ?? null)) {
+ 'actor_id' => $actor_id,
+ 'verb' => 'repeat',
+ 'object_type' => 'note',
+ 'object_id' => $note_id,
+ ])[ 0 ] ?? null)) {
return DB::findBy('activity', [
- 'actor_id' => $actor_id,
- 'verb' => 'undo',
- 'object_type' => 'activity',
- 'object_id' => $already_repeated_activity->getId(),
- ])[0] ?? null; // null if not undoed
+ 'actor_id' => $actor_id,
+ 'verb' => 'undo',
+ 'object_type' => 'activity',
+ 'object_id' => $already_repeated_activity->getId(),
+ ])[ 0 ] ?? null; // null if not undoed
} else {
// or it's an attempt to undo something that wasn't repeated in the first place,
return null;
@@ -142,35 +182,46 @@ class RepeatNote extends NoteHandlerPlugin
}
}
+
/**
- * Filters repeats out of Conversations, and replaces a repeat with the original Note on Actor feed
+ * Filters repeats out of Conversations, and replaces a repeat with the
+ * original Note on Actor feed
+ *
+ * @param \App\Entity\Actor|null $actor
+ * @param array $notes
+ * @param \Symfony\Component\HttpFoundation\Request $request
*
* @return bool
*/
- public function onFilterNoteList(?Actor $actor, array &$notes, Request $request)
+ public function onFilterNoteList(?Actor $actor, array &$notes, Request $request): bool
{
// Replaces repeat with original note on Actor feed
// it's pretty cool
if (str_starts_with($request->get('_route'), 'actor_view_')) {
$notes = array_map(
- fn (Note $note) => NoteRepeat::isNoteRepeat($note)
- ? Note::getById(NoteRepeat::getByPK($note->getId())->getRepeatOf())
- : $note,
+ fn(Note $note) => NoteRepeat::isNoteRepeat($note)
+ ? Note::getById(NoteRepeat::getByPK($note->getId())->getRepeatOf())
+ : $note,
$notes,
);
return Event::next;
}
// Filter out repeats altogether
- $notes = array_filter($notes, fn (Note $note) => !NoteRepeat::isNoteRepeat($note));
+ $notes = array_filter($notes, fn(Note $note) => !NoteRepeat::isNoteRepeat($note));
return Event::next;
}
+
/**
* HTML rendering event that adds the repeat form as a note
* action, if a user is logged in
*
- * @return bool Event hook
+ * @param \Symfony\Component\HttpFoundation\Request $request
+ * @param \App\Entity\Note $note
+ * @param array $actions
+ *
+ * @return bool Event hook
*/
public function onAddNoteActions(Request $request, Note $note, array &$actions): bool
{
@@ -181,13 +232,13 @@ class RepeatNote extends NoteHandlerPlugin
// If note is repeated, "is_repeated" is 1, 0 otherwise.
$is_repeat = ($note_repeat = DB::findBy('note_repeat', [
- 'actor_id' => $user->getId(),
+ 'actor_id' => $user->getId(),
'repeat_of' => $note->getId(),
])) !== [] ? 1 : 0;
// Generating URL for repeat action route
- $args = ['note_id' => $is_repeat === 0 ? $note->getId() : $note_repeat[0]->getRepeatOf()];
- $type = Router::ABSOLUTE_PATH;
+ $args = ['note_id' => $is_repeat === 0 ? $note->getId() : $note_repeat[ 0 ]->getRepeatOf()];
+ $type = Router::ABSOLUTE_PATH;
$repeat_action_url = $is_repeat
? Router::url('repeat_remove', $args, $type)
: Router::url('repeat_add', $args, $type);
@@ -197,8 +248,8 @@ class RepeatNote extends NoteHandlerPlugin
$extra_classes = $is_repeat ? 'note-actions-set' : 'note-actions-unset';
$repeat_action = [
- 'url' => $repeat_action_url,
- 'title' => $is_repeat ? 'Remove this repeat' : 'Repeat this note!',
+ 'url' => $repeat_action_url,
+ 'title' => $is_repeat ? 'Remove this repeat' : 'Repeat this note!',
'classes' => "button-container repeat-button-container {$extra_classes}",
'note_id' => 'repeat-button-container-' . $note->getId(),
];
@@ -207,8 +258,14 @@ class RepeatNote extends NoteHandlerPlugin
return Event::next;
}
+
/**
- * Append on note information about user actions.
+ * Appends in Note information stating who and what user actions were
+ * performed.
+ *
+ * @param array $vars Contains the Note currently being rendered
+ * @param array $result Rendered String containing anchors for Actors that
+ * repeated the Note
*
* @return array|bool
*/
@@ -218,11 +275,11 @@ class RepeatNote extends NoteHandlerPlugin
// if user is the one who repeated, append on end "you repeated this, remove repeat?"
$check_user = !\is_null(Common::user());
- $note = $vars['note'];
+ $note = $vars[ 'note' ];
$complementary_info = '';
- $repeat_actor = [];
- $note_repeats = NoteRepeat::getNoteRepeats($note);
+ $repeat_actor = [];
+ $note_repeats = NoteRepeat::getNoteRepeats($note);
// Get actors who replied
foreach ($note_repeats as $reply) {
@@ -237,7 +294,7 @@ class RepeatNote extends NoteHandlerPlugin
// Add to complementary info
foreach ($repeat_actor as $actor) {
- $repeat_actor_url = $actor->getUrl();
+ $repeat_actor_url = $actor->getUrl();
$repeat_actor_nickname = $actor->getNickname();
if ($check_user && $actor->getId() === (Common::actor())->getId()) {
@@ -248,7 +305,7 @@ class RepeatNote extends NoteHandlerPlugin
$you_translation = 'You';
}
- $prepend = "{$you_translation}, " . ($prepend = &$complementary_info);
+ $prepend = "{$you_translation}, " . ($prepend = &$complementary_info);
$complementary_info = $prepend;
} else {
// If the repeat is from someone else
@@ -263,6 +320,20 @@ class RepeatNote extends NoteHandlerPlugin
return $result;
}
+ /**
+ * Connects the following Routes to their respective Controllers:
+ *
+ * - **repeat_add**
+ * page containing the Note the user wishes to Repeat and a button to
+ * confirm it wishes to perform the action
+ *
+ * - **repeat_remove**
+ * same as above, except that it undoes the aforementioned action
+ *
+ * @param \App\Core\Router\RouteLoader $r
+ *
+ * @return bool Event hook
+ */
public function onAddRoute(RouteLoader $r): bool
{
// Add/remove note to/from repeats
@@ -272,31 +343,52 @@ class RepeatNote extends NoteHandlerPlugin
return Event::next;
}
- // ActivityPub
+ /*
+ * ActivityPub handling and processing for Repeat start
+ */
- private function activitypub_handler(Actor $actor, \ActivityPhp\Type\AbstractObject $type_activity, mixed $type_object, ?\Plugin\ActivityPub\Entity\ActivitypubActivity &$ap_act): bool
+ /**
+ * Handler for the Repeat Activity
+ *
+ * @param \App\Entity\Actor $actor
+ * @param \ActivityPhp\Type\AbstractObject $type_activity
+ * @param mixed $type_object
+ * @param \Plugin\ActivityPub\Entity\ActivitypubActivity|null $ap_act
+ *
+ * @return bool
+ * @throws \App\Util\Exception\BugFoundException
+ * @throws \App\Util\Exception\ClientException
+ * @throws \App\Util\Exception\DuplicateFoundException
+ * @throws \App\Util\Exception\NoSuchActorException
+ * @throws \App\Util\Exception\ServerException
+ * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
+ * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
+ * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
+ * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
+ */
+ private function activitypub_handler(Actor $actor, AbstractObject $type_activity, mixed $type_object, ?ActivitypubActivity &$ap_act): bool
{
if (!\in_array($type_activity->get('type'), ['Announce', 'Undo'])) {
return Event::next;
}
if ($type_activity->get('type') === 'Announce') { // Repeat
- if ($type_object instanceof \ActivityPhp\Type\AbstractObject) {
+ if ($type_object instanceof AbstractObject) {
if ($type_object->get('type') === 'Note') {
- $note = \Plugin\ActivityPub\Util\Model\Note::fromJson($type_object);
+ $note = \Plugin\ActivityPub\Util\Model\Note::fromJson($type_object);
$note_id = $note->getId();
} else {
return Event::next;
}
} elseif ($type_object instanceof Note) {
- $note = $type_object;
+ $note = $type_object;
$note_id = $note->getId();
} else {
return Event::next;
}
} else { // Undo Repeat
- if ($type_object instanceof \ActivityPhp\Type\AbstractObject) {
+ if ($type_object instanceof AbstractObject) {
$ap_prev_repeat_act = \Plugin\ActivityPub\Util\Model\Activity::fromJson($type_object);
- $prev_repeat_act = $ap_prev_repeat_act->getActivity();
+ $prev_repeat_act = $ap_prev_repeat_act->getActivity();
if ($prev_repeat_act->getVerb() === 'repeat' && $prev_repeat_act->getObjectType() === 'note') {
$note_id = $prev_repeat_act->getObjectId();
} else {
@@ -320,23 +412,23 @@ class RepeatNote extends NoteHandlerPlugin
}
if (!\is_null($activity)) {
// Store ActivityPub Activity
- $ap_act = \Plugin\ActivityPub\Entity\ActivitypubActivity::create([
- 'activity_id' => $activity->getId(),
+ $ap_act = ActivitypubActivity::create([
+ 'activity_id' => $activity->getId(),
'activity_uri' => $type_activity->get('id'),
- 'created' => new DateTime($type_activity->get('published') ?? 'now'),
- 'modified' => new DateTime(),
+ 'created' => new DateTime($type_activity->get('published') ?? 'now'),
+ 'modified' => new DateTime(),
]);
DB::persist($ap_act);
}
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);
}
- 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);
}