[COMPONENT][Feed] Correct queries and introduce new feeds

Refactor feeds and search to use a common query builder

components/Feed/Feed.php

@@ -0,0 +1,122 @@
+<?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\Feed;
+
+use App\Core\DB\DB;
+use App\Core\Event;
+use App\Core\Modules\Component;
+use App\Entity\Actor;
+use App\Util\Formatting;
+use Component\Search\Util\Parser;
+use Doctrine\Common\Collections\ExpressionBuilder;
+
+class Feed extends Component
+{
+    public static function query(string $query, int $page, ?string $language = null): array
+    {
+        $note_criteria  = null;
+        $actor_criteria = null;
+        if (!empty($query = trim($query))) {
+            [$note_criteria, $actor_criteria] = Parser::parse($query, $language);
+        }
+        $note_qb  = DB::createQueryBuilder();
+        $actor_qb = DB::createQueryBuilder();
+        $note_qb->select('note')->from('App\Entity\Note', 'note')->orderBy('note.created', 'DESC')->orderBy('note.id', 'DESC');
+        $actor_qb->select('actor')->from('App\Entity\Actor', 'actor')->orderBy('actor.created', 'DESC')->orderBy('actor.id', 'DESC');
+        Event::handle('SearchQueryAddJoins', [&$note_qb, &$actor_qb, $note_criteria, $actor_criteria]);
+
+        $notes  = [];
+        $actors = [];
+        if (!\is_null($note_criteria)) {
+            $note_qb->addCriteria($note_criteria);
+        }
+        $notes = $note_qb->getQuery()->execute();
+
+        if (!\is_null($actor_criteria)) {
+            $actor_qb->addCriteria($actor_criteria);
+        }
+        $actors = $actor_qb->getQuery()->execute();
+
+        // TODO: Enforce scoping on the notes before returning
+        return ['notes' => $notes ?? null, 'actors' => $actors ?? null];
+    }
+
+    /**
+     * Convert $term to $note_expr and $actor_expr, search criteria. Handles searching for text
+     * notes, for different types of actors and for the content of text notes
+     */
+    public function onSearchCreateExpression(ExpressionBuilder $eb, string $term, ?string $language, &$note_expr, &$actor_expr): bool
+    {
+        if (str_contains($term, ':')) {
+            $term = explode(':', $term);
+            if (Formatting::startsWith($term[0], 'note-')) {
+                switch ($term[0]) {
+                    case 'note-local':
+                        $note_expr = $eb->eq('note.is_local', filter_var($term[1], \FILTER_VALIDATE_BOOLEAN));
+                        break;
+                    case 'note-types':
+                    case 'notes-include':
+                    case 'note-filter':
+                        if (\is_null($note_expr)) {
+                            $note_expr = [];
+                        }
+                        if (array_intersect(explode(',', $term[1]), ['text', 'words']) !== []) {
+                            $note_expr[] = $eb->neq('note.content', null);
+                        } else {
+                            $note_expr[] = $eb->eq('note.content', null);
+                        }
+                        break;
+                }
+            } elseif (Formatting::startsWith($term, 'actor-')) {
+                switch ($term[0]) {
+                    case 'actor-types':
+                    case 'actors-include':
+                    case 'actor-filter':
+                    case 'actor-local':
+                        if (\is_null($actor_expr)) {
+                            $actor_expr = [];
+                        }
+                        foreach (
+                            [
+                                Actor::PERSON => ['person', 'people'],
+                                Actor::GROUP => ['group', 'groups'],
+                                Actor::ORGANIZATION => ['org', 'orgs', 'organization', 'organizations', 'organisation', 'organisations'],
+                                Actor::BUSINESS => ['business', 'businesses'],
+                                Actor::BOT => ['bot', 'bots'],
+                            ] as $type => $match) {
+                            if (array_intersect(explode(',', $term[1]), $match) !== []) {
+                                $actor_expr[] = $eb->eq('actor.type', $type);
+                            } else {
+                                $actor_expr[] = $eb->neq('actor.type', $type);
+                            }
+                        }
+                        break;
+                }
+            }
+        } else {
+            $note_expr = $eb->contains('note.content', $term);
+        }
+        return Event::next;
+    }
+}

components/Feed/Util/FeedController.php

@@ -0,0 +1,58 @@
+<?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/>.
+// }}}
+
+/**
+ * Base class for feed controllers
+ *
+ * @package  GNUsocial
+ * @category Controller
+ *
+ * @author    Hugo Sales <hugo@hsal.es>
+ * @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+
+namespace Component\Feed\Util;
+
+use App\Core\Controller;
+use App\Core\Event;
+use App\Util\Common;
+
+abstract class FeedController extends Controller
+{
+    /**
+     * Post process the result of a feed controller, to remove any
+     * notes or actors the user specified, as well as format the raw
+     * list of notes into a usable format
+     */
+    public static function post_process(array $result): array
+    {
+        $actor = Common::actor();
+
+        if (\array_key_exists('notes', $result)) {
+            $notes = $result['notes'];
+            Event::handle('FilterNoteList', [$actor, &$notes, $result['request']]);
+            Event::handle('FormatNoteList', [$notes, &$result['notes']]);
+        }
+
+        return $result;
+    }
+}

components/Feed/templates/feed/feed.html.twig

@@ -0,0 +1,34 @@
+{% extends 'stdgrid.html.twig' %}
+{% import '/cards/note/view.html.twig' as noteView %}
+
+{% block title %}{% if page_title is defined %}{{ page_title | trans }}{% endif %}{% endblock %}
+
+{% block stylesheets %}
+    {{ parent() }}
+    <link rel="stylesheet" href="{{ asset('assets/default_theme/css/pages/feeds.css') }}" type="text/css">
+{% endblock stylesheets %}
+
+{% block body %}
+    {% for block in handle_event('BeforeFeed', app.request) %}
+        {{ block | raw }}
+    {% endfor %}
+    {# Backwards compatibility with hAtom 0.1 #}
+    <main class="feed" tabindex="0" role="feed">
+        <div class="h-feed hfeed notes">
+            {% if notes is defined and notes is not empty %}
+                {% for conversation in notes %}
+                    {% block current_note %}
+                        {% if conversation is instanceof('array') %}
+                            {{ noteView.macro_note(conversation['note'], conversation['replies']) }}
+                        {% else %}
+                            {{ noteView.macro_note(conversation) }}
+                        {% endif %}
+                        <hr tabindex="0" title="{{ 'End of note and replies.' | trans }}">
+                    {% endblock current_note %}
+                {% endfor %}
+            {% else %}
+                <div id="empty-notes"><h1>{% trans %}No notes here.{% endtrans %}</h1></div>
+            {% endif %}
+        </div>
+    </main>
+{% endblock body %}