. // }}} /** * @author Hugo Sales * @author Eliseu Amaro * @copyright 2021-2022 Free Software Foundation, Inc http://www.fsf.org * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later */ namespace Component\Conversation; use App\Core\Cache; use App\Core\DB; use App\Core\Event; use function App\Core\I18n\_m; use App\Core\Modules\Component; use App\Core\Router; use App\Entity\Activity; use App\Entity\Actor; use App\Entity\Note; use App\Util\Common; use App\Util\Formatting; use Component\Conversation\Entity\Conversation as ConversationEntity; use Component\Conversation\Entity\ConversationMute; use EventResult; use Functional as F; use Symfony\Component\HttpFoundation\Request; class Conversation extends Component { public function onAddRoute(Router $r): EventResult { $r->connect('conversation', '/conversation/{conversation_id<\d+>}', [Controller\Conversation::class, 'showConversation']); $r->connect('conversation_mute', '/conversation/{conversation_id<\d+>}/mute', [Controller\Conversation::class, 'muteConversation']); $r->connect('conversation_reply_to', '/conversation/reply', [Controller\Conversation::class, 'addReply']); return Event::next; } /** * **Assigns** the given local Note it's corresponding **Conversation**. * * **If a _$parent_id_ is not given**, then the Actor is not attempting a reply, * therefore, we can assume (for now) that we need to create a new Conversation and assign it * to the newly created Note (please look at Component\Posting::storeLocalNote, where this function is used) * * **On the other hand**, given a _$parent_id_, the Actor is attempting to post a reply. Meaning that, * this Note conversation_id should be same as the parent Note * * @param \App\Entity\Note $current_note Local Note currently being assigned a Conversation * @param null|int $parent_id If present, it's a reply */ public static function assignLocalConversation(Note $current_note, ?int $parent_id): void { if (!$parent_id) { // If none found, we don't know yet if it is a reply or root // Let's assume for now that it's a new conversation and deal with stitching later $conversation = ConversationEntity::create(['initial_note_id' => $current_note->getId()]); // We need the Conversation id itself, so a persist is in order DB::persist($conversation); // Set current_note's own conversation_id $current_note->setConversationId($conversation->getId()); } else { // It's a reply for sure // Set reply_to property in newly created Note to parent's id // Parent will have a conversation of its own, the reply should have the same one $parent_note = Note::getById($parent_id); $current_note->setConversationId($parent_note->getConversationId()); } DB::persist($current_note); } /** * HTML rendering event that adds a reply link as a note * action, if a user is logged in. * * @param \App\Entity\Note $note The Note being rendered * @param array $actions Contains keys 'url' (linking 'conversation_reply_to' * route), 'title' (used as title for aforementioned url), * 'classes' (CSS styling classes used to visually inform the user of action context), * 'id' (HTML markup id used to redirect user to this anchor upon performing the action) * * @throws \App\Util\Exception\ServerException */ public function onAddNoteActions(Request $request, Note $note, array &$actions): EventResult { if (\is_null(Common::user())) { return Event::next; } $from = $request->query->has('from') ? $request->query->get('from') : $request->getPathInfo(); $reply_action_url = Router::url( 'conversation_reply_to', [ 'reply_to_id' => $note->getId(), 'from' => $from, '_fragment' => 'note-anchor-' . $note->getId(), ], Router::ABSOLUTE_PATH, ); $reply_action = [ 'url' => $reply_action_url, 'title' => _m('Reply to this note!'), 'classes' => 'button-container reply-button-container note-actions-unset', 'id' => 'reply-button-container-' . $note->getId(), ]; $actions[] = $reply_action; return Event::next; } /** * Append on note information about user actions. * * @param array $vars Contains information related to Note currently being rendered * @param array $result Contains keys 'actors', and 'action'. Needed to construct a string, stating who ($result['actors']), has already performed a reply ($result['action']), in the given Note (vars['note']) */ public function onAppendCardNote(array $vars, array &$result): EventResult { if (str_contains($vars['request']->getPathInfo(), 'conversation')) { return Event::next; } // The current Note being rendered $note = $vars['note']; // Will have actors array, and action string // Actors are the subjects, action is the verb (in the final phrase) $reply_actors = F\map( $note->getReplies(), fn (Note $reply) => Actor::getByPK($reply->getActorId()), ); if (empty($reply_actors)) { return Event::next; } // Filter out multiple replies from the same actor $reply_actors = array_unique($reply_actors, \SORT_REGULAR); $result[] = ['actors' => $reply_actors, 'action' => 'replied to']; return Event::next; } private function getReplyToIdFromRequest(Request $request): ?int { if (!\is_array($request->get('post_note')) || !\array_key_exists('_next', $request->get('post_note'))) { return null; } $next = parse_url($request->get('post_note')['_next']); if (!\array_key_exists('query', $next)) { return null; } parse_str($next['query'], $query); if (!\array_key_exists('reply_to_id', $query)) { return null; } return (int) $query['reply_to_id']; } /** * Informs **\App\Component\Posting::onAppendRightPostingBlock**, of the **current page context** in which the given * Actor is in. This is valuable when posting within a group route, allowing \App\Component\Posting to create a * Note **targeting** that specific Group. * * @param \App\Entity\Actor $actor The Actor currently attempting to post a Note * @param null|\App\Entity\Actor $context_actor The 'owner' of the current route (e.g. Group or Actor), used to target it */ public function onPostingGetContextActor(Request $request, Actor $actor, ?Actor &$context_actor): EventResult { $to_note_id = $this->getReplyToIdFromRequest($request); if (!\is_null($to_note_id)) { // Getting the actor itself $context_actor = Actor::getById(Note::getById((int) $to_note_id)->getActorId()); return Event::stop; } return Event::next; } /** * Posting event to add extra information to Component\Posting form data * * @param array $data Transport data to be filled with reply_to_id * * @throws \App\Util\Exception\ClientException * @throws \App\Util\Exception\NoSuchNoteException */ public function onPostingModifyData(Request $request, Actor $actor, array &$data): EventResult { $to_note_id = $this->getReplyToIdFromRequest($request); if (!\is_null($to_note_id)) { Note::ensureCanInteract(Note::getById($to_note_id), $actor); $data['reply_to_id'] = $to_note_id; } return Event::next; } /** * Add minimal Note card to RightPanel template */ public function onPrependPostingForm(Request $request, array &$elements): EventResult { $elements[] = Formatting::twigRenderFile('cards/blocks/note_compact_wrapper.html.twig', ['note' => Note::getById((int) $request->query->get('reply_to_id'))]); return Event::next; } /** * Event launched when deleting given Note, it's deletion implies further changes to object related to this Note. * Please note, **replies are NOT deleted**, their reply_to is only set to null since this Note no longer exists. * * @param \App\Entity\Note $note Note being deleted * @param \App\Entity\Actor $actor Actor that performed the delete action */ public function onNoteDeleteRelated(Note &$note, Actor $actor): EventResult { // Ensure we have the most up to date replies Cache::delete(Note::cacheKeys($note->getId())['replies']); DB::wrapInTransaction(fn () => F\each($note->getReplies(), fn (Note $note) => $note->setReplyTo(null))); Cache::delete(Note::cacheKeys($note->getId())['replies']); return Event::next; } /** * Adds extra actions related to Conversation Component, that act upon/from the given Note. * * @param \App\Entity\Note $note Current Note being rendered * @param array $actions Containing 'url' (Controller connected route), 'title' (used in anchor link containing the url), ?'classes' (CSS classes required for styling, if needed) * * @throws \App\Util\Exception\ServerException */ public function onAddExtraNoteActions(Request $request, Note $note, array &$actions): EventResult { if (\is_null($user = Common::user())) { return Event::next; } $from = $request->query->has('from') ? $request->query->get('from') : $request->getPathInfo(); $mute_extra_action_url = Router::url( 'conversation_mute', [ 'conversation_id' => $note->getConversationId(), 'from' => $from, '_fragment' => 'note-anchor-' . $note->getId(), ], Router::ABSOLUTE_PATH, ); $actions[] = [ 'title' => ConversationMute::isMuted($note, $user) ? _m('Unmute conversation') : _m('Mute conversation'), 'classes' => '', 'url' => $mute_extra_action_url, ]; return Event::next; } /** * Prevents new Notifications to appear for muted conversations * * @param Activity $activity Notification Activity */ public function onNewNotificationShould(Activity $activity, Actor $actor): EventResult { if ($activity->getObjectType() === 'note' && ConversationMute::isMuted($activity, $actor)) { return Event::stop; } return Event::next; } }