From 7d8cce3b279cddb37f58df0a88005e85d4ef2ba5 Mon Sep 17 00:00:00 2001 From: Diogo Peralta Cordeiro Date: Thu, 23 Dec 2021 13:27:31 +0000 Subject: [PATCH] [COMPONENT][Feed] Correct queries and introduce new feeds Refactor feeds and search to use a common query builder --- .../Conversation/Controller/Conversation.php | 2 +- components/Conversation/Controller/Reply.php | 2 +- components/Feed/Feed.php | 122 ++++++++++++++++++ .../Feed/Util}/FeedController.php | 4 +- .../Feed/templates/feed}/feed.html.twig | 0 components/FreeNetwork/Controller/Feeds.php | 113 ++++++++++++++++ components/LeftPanel/Controller/EditFeeds.php | 2 +- components/Search/Controller/Search.php | 28 +--- components/Search/Search.php | 42 ------ components/Search/Util/Parser.php | 19 +-- .../Search/templates/search/show.html.twig | 2 +- config/packages/security.yaml | 2 +- plugins/Directory/Controller/Directory.php | 2 +- plugins/Favourite/Controller/Favourite.php | 51 ++++---- src/Controller/Feeds.php | 85 ++++-------- src/Controller/ResetPassword.php | 2 +- src/Controller/Security.php | 8 +- src/Core/Controller.php | 3 +- src/Core/Controller/ActorController.php | 1 + src/Entity/Feed.php | 5 +- src/Entity/Note.php | 32 +---- src/Security/Authenticator.php | 2 +- templates/actor/view.html.twig | 2 +- templates/base.html.twig | 2 +- templates/cards/navigation/view.html.twig | 9 +- tests/Controller/FeedsTest.php | 4 +- tests/Controller/SecurityTest.php | 8 +- 27 files changed, 337 insertions(+), 217 deletions(-) create mode 100644 components/Feed/Feed.php rename {src/Core/Controller => components/Feed/Util}/FeedController.php (94%) rename {templates/feeds => components/Feed/templates/feed}/feed.html.twig (100%) create mode 100644 components/FreeNetwork/Controller/Feeds.php diff --git a/components/Conversation/Controller/Conversation.php b/components/Conversation/Controller/Conversation.php index 4a49824ec3..6fd5313395 100644 --- a/components/Conversation/Controller/Conversation.php +++ b/components/Conversation/Controller/Conversation.php @@ -47,7 +47,7 @@ class Conversation extends FeedController . 'on n.conversation_id = :id ' . 'order by n.created DESC', ['id' => $conversation_id], ); return [ - '_template' => 'feeds/feed.html.twig', + '_template' => 'feed/feed.html.twig', 'notes' => $notes, 'should_format' => false, 'page_title' => 'Conversation', diff --git a/components/Conversation/Controller/Reply.php b/components/Conversation/Controller/Reply.php index 60c4713401..7489f3ed19 100644 --- a/components/Conversation/Controller/Reply.php +++ b/components/Conversation/Controller/Reply.php @@ -77,7 +77,7 @@ class Reply extends FeedController . 'where n.reply_to is not null and n.actor_id = :id ' . 'order by n.created DESC', ['id' => $actor_id], ); return [ - '_template' => 'feeds/feed.html.twig', + '_template' => 'feed/feed.html.twig', 'notes' => $notes, 'should_format' => false, 'page_title' => 'Replies feed', diff --git a/components/Feed/Feed.php b/components/Feed/Feed.php new file mode 100644 index 0000000000..962076b136 --- /dev/null +++ b/components/Feed/Feed.php @@ -0,0 +1,122 @@ +. + +// }}} + +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; + } +} diff --git a/src/Core/Controller/FeedController.php b/components/Feed/Util/FeedController.php similarity index 94% rename from src/Core/Controller/FeedController.php rename to components/Feed/Util/FeedController.php index b5b5ddd9a3..3acb01dd28 100644 --- a/src/Core/Controller/FeedController.php +++ b/components/Feed/Util/FeedController.php @@ -30,7 +30,7 @@ declare(strict_types = 1); * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later */ -namespace App\Core\Controller; +namespace Component\Feed\Util; use App\Core\Controller; use App\Core\Event; @@ -43,7 +43,7 @@ abstract class FeedController extends Controller * 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) + public static function post_process(array $result): array { $actor = Common::actor(); diff --git a/templates/feeds/feed.html.twig b/components/Feed/templates/feed/feed.html.twig similarity index 100% rename from templates/feeds/feed.html.twig rename to components/Feed/templates/feed/feed.html.twig diff --git a/components/FreeNetwork/Controller/Feeds.php b/components/FreeNetwork/Controller/Feeds.php new file mode 100644 index 0000000000..de6dbd3765 --- /dev/null +++ b/components/FreeNetwork/Controller/Feeds.php @@ -0,0 +1,113 @@ +. + +// }}} + +/** + * Handle network public feed + * + * @package GNUsocial + * @category Controller + * + * @author Diogo Peralta Cordeiro <@diogo.site> + * @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org + * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later + */ + +namespace Component\FreeNetwork\Controller; + +use App\Core\DB\DB; +use function App\Core\I18n\_m; +use App\Util\Common; +use Component\Feed\Feed; +use Component\Feed\Util\FeedController; +use Symfony\Component\HttpFoundation\Request; + +class Feeds extends FeedController +{ + /** + * The Meteorites feed represents every post coming from the + * known fediverse to this instance's inbox. I.e., it's our + * known network and excludes everything that is local only + * or federated out. + */ + public function network(Request $request): array + { + $data = Feed::query( + query: 'note-local:false', + page: $this->int('p'), + language: Common::actor()?->getTopLanguage()?->getLocale(), + ); + return [ + '_template' => 'feed/feed.html.twig', + 'page_title' => _m('Meteorites'), + 'should_format' => true, + 'notes' => $data['notes'], + ]; + } + + /** + * The Planetary System feed represents every planet-centric post, i.e., + * everything that is local or comes from outside with relation to local actors + * or posts. + */ + public function clique(Request $request): array + { + $notes = DB::dql( + <<<'EOF' + SELECT n FROM \App\Entity\Note AS n + WHERE n.is_local = true OR n.id IN ( + SELECT act.object_id FROM \App\Entity\Activity AS act + WHERE act.object_type = 'note' AND act.id IN + (SELECT att.activity_id FROM \Component\Notification\Entity\Notification AS att WHERE att.target_id IN + (SELECT a.id FROM \App\Entity\Actor a WHERE a.is_local = true)) + ) + ORDER BY n.created DESC, n.id DESC + EOF, + ); + return [ + '_template' => 'feed/feed.html.twig', + 'page_title' => _m('Planetary System'), + 'should_format' => true, + 'notes' => $notes, + ]; + } + + /** + * The Galaxy feed represents everything that is federated out or federated in. + * Given that any local post can be federated out and it's hard to specifically exclude these, + * we simply return everything here, local and remote posts. So, a galaxy. + */ + public function federated(Request $request): array + { + $data = Feed::query( + query: '', + page: $this->int('p'), + language: Common::actor()?->getTopLanguage()?->getLocale(), + ); + return [ + '_template' => 'feed/feed.html.twig', + 'page_title' => _m('Galaxy'), + 'should_format' => true, + 'notes' => $data['notes'], + ]; + } +} diff --git a/components/LeftPanel/Controller/EditFeeds.php b/components/LeftPanel/Controller/EditFeeds.php index 6bb0df70b6..5e3ff39575 100644 --- a/components/LeftPanel/Controller/EditFeeds.php +++ b/components/LeftPanel/Controller/EditFeeds.php @@ -25,7 +25,6 @@ namespace Component\LeftPanel\Controller; use App\Core\Cache; use App\Core\Controller; -use App\Core\Controller\FeedController; use App\Core\DB\DB; use App\Core\Form; use function App\Core\I18n\_m; @@ -34,6 +33,7 @@ use App\Entity\Feed; use App\Util\Common; use App\Util\Exception\ClientException; use App\Util\Exception\RedirectException; +use Component\Feed\Util\FeedController; use Functional as F; use Symfony\Component\Form\Extension\Core\Type\IntegerType; use Symfony\Component\Form\Extension\Core\Type\SubmitType; diff --git a/components/Search/Controller/Search.php b/components/Search/Controller/Search.php index 8851360de0..cd099b42fe 100644 --- a/components/Search/Controller/Search.php +++ b/components/Search/Controller/Search.php @@ -23,9 +23,6 @@ declare(strict_types = 1); namespace Component\Search\Controller; -use App\Core\Controller\FeedController; -use App\Core\DB\DB; -use App\Core\Event; use App\Core\Form; use function App\Core\I18n\_m; use App\Util\Common; @@ -33,8 +30,9 @@ use App\Util\Exception\BugFoundException; use App\Util\Exception\RedirectException; use App\Util\Form\FormFields; use App\Util\Formatting; +use Component\Feed\Feed; +use Component\Feed\Util\FeedController; use Component\Search as Comp; -use Component\Search\Util\Parser; use Symfony\Component\Form\Extension\Core\Type\CheckboxType; use Symfony\Component\Form\Extension\Core\Type\SubmitType; use Symfony\Component\Form\Extension\Core\Type\TextType; @@ -50,26 +48,10 @@ class Search extends FeedController $actor = Common::actor(); $language = !\is_null($actor) ? $actor->getTopLanguage()->getLocale() : null; $q = $this->string('q'); - if (!empty($q) && !empty($q = trim($q))) { - [$note_criteria, $actor_criteria] = Parser::parse($q, $language); - $note_qb = DB::createQueryBuilder(); - $actor_qb = DB::createQueryBuilder(); - $note_qb->select('note')->from('App\Entity\Note', 'note')->orderBy('note.created', 'DESC'); - $actor_qb->select('actor')->from('App\Entity\Actor', 'actor')->orderBy('actor.created', 'DESC'); - Event::handle('SearchQueryAddJoins', [&$note_qb, &$actor_qb]); - - $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(); - } - } + $data = Feed::query(query: $q, page: $this->int('p'), language: $language); + $notes = $data['notes']; + $actors = $data['actors']; $search_builder_form = Form::create([ ['include_actors', CheckboxType::class, ['required' => false, 'data' => false, 'label' => _m('Include people/actors')]], diff --git a/components/Search/Search.php b/components/Search/Search.php index 9dded07dbb..50446ae971 100644 --- a/components/Search/Search.php +++ b/components/Search/Search.php @@ -27,11 +27,8 @@ use App\Core\Event; use App\Core\Form; use function App\Core\I18n\_m; use App\Core\Modules\Component; -use App\Entity\Actor; use App\Util\Common; use App\Util\Exception\RedirectException; -use App\Util\Formatting; -use Doctrine\Common\Collections\ExpressionBuilder; use Symfony\Component\Form\Extension\Core\Type\SubmitType; use Symfony\Component\Form\Extension\Core\Type\TextType; use Symfony\Component\Form\FormView; @@ -140,43 +137,4 @@ class Search extends Component $styles[] = 'components/Search/assets/css/view.css'; return Event::next; } - - /** - * 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 - { - $include_term = str_contains($term, ':') ? explode(':', $term)[1] : $term; - if (Formatting::startsWith($term, ['note-types:', 'notes-incude:', 'note-filter:'])) { - if (\is_null($note_expr)) { - $note_expr = []; - } - if (array_intersect(explode(',', $include_term), ['text', 'words']) !== []) { - $note_expr[] = $eb->neq('note.rendered', null); - } else { - $note_expr[] = $eb->eq('note.rendered', null); - } - } elseif (Formatting::startsWith($term, ['actor-types:', 'actors-incude:', 'actor-filter:'])) { - 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(',', $include_term), $match) !== []) { - $actor_expr[] = $eb->eq('actor.type', $type); - } else { - $actor_expr[] = $eb->neq('actor.type', $type); - } - } - } elseif (!str_contains($term, ':')) { - $note_expr = $eb->contains('note.rendered', $term); - } - return Event::next; - } } diff --git a/components/Search/Util/Parser.php b/components/Search/Util/Parser.php index e14e5f85f2..b835e0912c 100644 --- a/components/Search/Util/Parser.php +++ b/components/Search/Util/Parser.php @@ -48,7 +48,7 @@ abstract class Parser * Currently doesn't support nesting with parenthesis and * recognises either spaces (currently `or`, should be fuzzy match), `OR` or `|` (`or`) and `AND` or `&` (`and`) * - * TODO Better fuzzy match, implement exact match with quotes and nesting with parens + * TODO: Better fuzzy match, implement exact match with quotes and nesting with parens * * @return Criteria[] */ @@ -58,9 +58,9 @@ abstract class Parser $input = trim(preg_replace(['/\s+/', '/\s+AND\s+/', '/\s+OR\s+/'], [' ', '&', '|'], $input), ' |&'); } - $left = $right = 0; + $left = 0; + $right = 0; $lenght = mb_strlen($input); - $stack = []; $eb = Criteria::expr(); $note_criteria_arr = []; $actor_criteria_arr = []; @@ -74,9 +74,10 @@ abstract class Parser foreach (['&', '|', ' '] as $delimiter) { if ($input[$index] === $delimiter || $end = ($index === $lenght - 1)) { - $term = mb_substr($input, $left, $end ? null : $right - $left); - $note_res = $actor_res = null; - $ret = Event::handle('SearchCreateExpression', [$eb, $term, $language, &$note_res, &$actor_res]); + $term = mb_substr($input, $left, $end ? null : $right - $left); + $note_res = null; + $actor_res = null; + Event::handle('SearchCreateExpression', [$eb, $term, $language, &$note_res, &$actor_res]); if (\is_null($note_res) && \is_null($actor_res)) { throw new ServerException("No one claimed responsibility for a match term: {$term}"); } @@ -88,7 +89,7 @@ abstract class Parser } if (!\is_null($actor_res) && !empty($note_res)) { if (\is_array($actor_res)) { - $actor_res = $ex->orX(...$actor_res); + $actor_res = $eb->orX(...$actor_res); } $actor_parts[] = $actor_res; } @@ -97,7 +98,6 @@ abstract class Parser if (!\is_null($last_op) && $last_op !== $delimiter) { self::connectParts($note_parts, $note_criteria_arr, $last_op, $eb, force: false); - self::connectParts($actor_parts, $actor_criteria_arr, $last_op, $eb, force: false); } else { $last_op = $delimiter; } @@ -110,7 +110,8 @@ abstract class Parser } } - $note_criteria = $actor_criteria = null; + $note_criteria = null; + $actor_criteria = null; if (!empty($note_parts)) { self::connectParts($note_parts, $note_criteria_arr, $last_op, $eb, force: true); $note_criteria = new Criteria($eb->orX(...$note_criteria_arr)); diff --git a/components/Search/templates/search/show.html.twig b/components/Search/templates/search/show.html.twig index b113ea4791..73ff5951d3 100644 --- a/components/Search/templates/search/show.html.twig +++ b/components/Search/templates/search/show.html.twig @@ -1,4 +1,4 @@ -{% extends 'feeds/feed.html.twig' %} +{% extends 'feed/feed.html.twig' %} {% block body %} diff --git a/config/packages/security.yaml b/config/packages/security.yaml index 9340e1e0dc..da109f2184 100644 --- a/config/packages/security.yaml +++ b/config/packages/security.yaml @@ -33,7 +33,7 @@ security: logout: path: security_logout # where to redirect after logout - target: main_all + target: root remember_me: secret: '%kernel.secret%' diff --git a/plugins/Directory/Controller/Directory.php b/plugins/Directory/Controller/Directory.php index 6edead9d59..6ed92445be 100644 --- a/plugins/Directory/Controller/Directory.php +++ b/plugins/Directory/Controller/Directory.php @@ -23,8 +23,8 @@ declare(strict_types = 1); namespace Plugin\Directory\Controller; -use App\Core\Controller\FeedController; use App\Core\DB\DB; +use Component\Feed\Util\FeedController; use Symfony\Component\HttpFoundation\Request; class Directory extends FeedController diff --git a/plugins/Favourite/Controller/Favourite.php b/plugins/Favourite/Controller/Favourite.php index 625aec1d4d..f9aa39c8b8 100644 --- a/plugins/Favourite/Controller/Favourite.php +++ b/plugins/Favourite/Controller/Favourite.php @@ -23,9 +23,9 @@ declare(strict_types = 1); namespace Plugin\Favourite\Controller; -use App\Core\Controller\FeedController; use App\Core\DB\DB; use App\Core\Form; +use function App\Core\I18n\_m; use App\Core\Log; use App\Core\Router\Router; use App\Util\Common; @@ -35,27 +35,26 @@ use App\Util\Exception\NoLoggedInUser; use App\Util\Exception\NoSuchNoteException; use App\Util\Exception\RedirectException; use App\Util\Exception\ServerException; +use Component\Feed\Util\FeedController; use Symfony\Component\Form\Extension\Core\Type\SubmitType; use Symfony\Component\HttpFoundation\Request; -use function App\Core\I18n\_m; -use function is_null; class Favourite extends FeedController { /** - * @throws ServerException * @throws InvalidFormException * @throws NoLoggedInUser * @throws NoSuchNoteException * @throws RedirectException + * @throws ServerException */ public function favouriteAddNote(Request $request, int $id): bool|array { - $user = Common::ensureLoggedIn(); - $actor_id = $user->getId(); - $opts = ['id' => $id]; + $user = Common::ensureLoggedIn(); + $actor_id = $user->getId(); + $opts = ['id' => $id]; $add_favourite_note = DB::find('note', $opts); - if (is_null($add_favourite_note)) { + if (\is_null($add_favourite_note)) { throw new NoSuchNoteException(); } @@ -63,7 +62,7 @@ class Favourite extends FeedController ['add_favourite', SubmitType::class, [ 'label' => _m('Favourite note!'), - 'attr' => [ + 'attr' => [ 'title' => _m('Favourite this note!'), ], ], @@ -73,7 +72,7 @@ class Favourite extends FeedController $form_add_to_favourite->handleRequest($request); if ($form_add_to_favourite->isSubmitted()) { - if (!is_null(\Plugin\Favourite\Favourite::favourNote(note_id: $id, actor_id: $actor_id))) { + if (!\is_null(\Plugin\Favourite\Favourite::favourNote(note_id: $id, actor_id: $actor_id))) { DB::flush(); } else { throw new ClientException(_m('Note already favoured!')); @@ -81,7 +80,7 @@ class Favourite extends FeedController // Redirect user to where they came from // Prevent open redirect - if (!is_null($from = $this->string('from'))) { + if (!\is_null($from = $this->string('from'))) { if (Router::isAbsolute($from)) { Log::warning("Actor {$actor_id} attempted to reply to a note and then get redirected to another host, or the URL was invalid ({$from})"); throw new ClientException(_m('Can not redirect to outside the website from here'), 400); // 400 Bad request (deceptive) @@ -96,26 +95,26 @@ class Favourite extends FeedController } return [ - '_template' => 'favourite/add_to_favourites.html.twig', - 'note' => $add_favourite_note, + '_template' => 'favourite/add_to_favourites.html.twig', + 'note' => $add_favourite_note, 'add_favourite' => $form_add_to_favourite->createView(), ]; } /** - * @throws ServerException * @throws InvalidFormException * @throws NoLoggedInUser * @throws NoSuchNoteException * @throws RedirectException + * @throws ServerException */ public function favouriteRemoveNote(Request $request, int $id): array { - $user = Common::ensureLoggedIn(); - $actor_id = $user->getId(); - $opts = ['id' => $id]; + $user = Common::ensureLoggedIn(); + $actor_id = $user->getId(); + $opts = ['id' => $id]; $remove_favourite_note = DB::find('note', $opts); - if (is_null($remove_favourite_note)) { + if (\is_null($remove_favourite_note)) { throw new NoSuchNoteException(); } @@ -123,7 +122,7 @@ class Favourite extends FeedController ['remove_favourite', SubmitType::class, [ 'label' => _m('Remove favourite'), - 'attr' => [ + 'attr' => [ 'title' => _m('Remove note from favourites.'), ], ], @@ -132,7 +131,7 @@ class Favourite extends FeedController $form_remove_favourite->handleRequest($request); if ($form_remove_favourite->isSubmitted()) { - if (!is_null(\Plugin\Favourite\Favourite::unfavourNote(note_id: $id, actor_id: $actor_id))) { + if (!\is_null(\Plugin\Favourite\Favourite::unfavourNote(note_id: $id, actor_id: $actor_id))) { DB::flush(); } else { throw new ClientException(_m('Note already unfavoured!')); @@ -140,7 +139,7 @@ class Favourite extends FeedController // Redirect user to where they came from // Prevent open redirect - if (!is_null($from = $this->string('from'))) { + if (!\is_null($from = $this->string('from'))) { if (Router::isAbsolute($from)) { Log::warning("Actor {$actor_id} attempted to reply to a note and then get redirected to another host, or the URL was invalid ({$from})"); throw new ClientException(_m('Can not redirect to outside the website from here'), 400); // 400 Bad request (deceptive) @@ -156,8 +155,8 @@ class Favourite extends FeedController $note = DB::find('note', ['id' => $id]); return [ - '_template' => 'favourite/remove_from_favourites.html.twig', - 'note' => $note, + '_template' => 'favourite/remove_from_favourites.html.twig', + 'note' => $note, 'remove_favourite' => $form_remove_favourite->createView(), ]; } @@ -175,7 +174,7 @@ class Favourite extends FeedController ); return [ - '_template' => 'feeds/feed.html.twig', + '_template' => 'feed/feed.html.twig', 'page_title' => 'Favourites feed.', 'notes' => $notes, ]; @@ -190,9 +189,9 @@ class Favourite extends FeedController /** * Reverse favourites stream * - * @return array template * @throws NoLoggedInUser user not logged in * + * @return array template */ public function reverseFavouritesByActorId(Request $request, int $id): array { @@ -208,7 +207,7 @@ class Favourite extends FeedController ); return [ - '_template' => 'feeds/feed.html.twig', + '_template' => 'feed/feed.html.twig', 'page_title' => 'Reverse favourites feed.', 'notes' => $notes, ]; diff --git a/src/Controller/Feeds.php b/src/Controller/Feeds.php index 70b0c8a38a..68b18ca423 100644 --- a/src/Controller/Feeds.php +++ b/src/Controller/Feeds.php @@ -35,13 +35,11 @@ declare(strict_types = 1); namespace App\Controller; -use App\Core\Controller\FeedController; -use App\Core\DB\DB; use function App\Core\I18n\_m; use App\Core\VisibilityScope; -use App\Entity\Note; -use App\Util\Exception\ClientException; -use App\Util\Exception\NotFoundException; +use App\Util\Common; +use Component\Feed\Feed; +use Component\Feed\Util\FeedController; use Symfony\Component\HttpFoundation\Request; class Feeds extends FeedController @@ -52,68 +50,39 @@ class Feeds extends FeedController private $message_scope = VisibilityScope::MESSAGE; private $subscriber_scope = VisibilityScope::PUBLIC | VisibilityScope::SUBSCRIBER; - public function public(Request $request) + /** + * The Planet feed represents every local post. Which is what this instance has to share with the universe. + */ + public function public(Request $request): array { - $notes = Note::getAllNotes($this->instance_scope); + $data = Feed::query( + query: 'note-local:true', + page: $this->int('p'), + language: Common::actor()?->getTopLanguage()?->getLocale(), + ); return [ - '_template' => 'feeds/feed.html.twig', - 'page_title' => 'Public feed', + '_template' => 'feed/feed.html.twig', + 'page_title' => _m(\is_null(Common::user()) ? 'Feed' : 'Planet'), 'should_format' => true, - 'notes' => $notes, + 'notes' => $data['notes'], ]; } - public function home(Request $request, string $nickname) + /** + * The Home feed represents everything that concerns a certain actor (its subscriptions) + */ + public function home(Request $request): array { - try { - $target = DB::findOneBy('actor', ['nickname' => $nickname, 'is_local' => true]); - } catch (NotFoundException) { - throw new ClientException(_m('User {nickname} doesn\'t exist', ['{nickname}' => $nickname])); - } - - // TODO Handle replies in home stream - $query = << {$this->message_scope} - order by note.modified DESC - END; - $notes = DB::sql($query, ['target_actor_id' => $target->getId()]); - + $data = Feed::query( + query: 'from:subscribed-actors OR from:subscribed-groups', + page: $this->int('p'), + language: Common::actor()?->getTopLanguage()?->getLocale(), + ); return [ - '_template' => 'feeds/feed.html.twig', - 'page_title' => 'Home feed', + '_template' => 'feed/feed.html.twig', + 'page_title' => _m('Home'), 'should_format' => true, - 'notes' => $notes, - ]; - } - - public function network(Request $request) - { - $notes = Note::getAllNotes($this->public_scope); - return [ - '_template' => 'feeds/feed.html.twig', - 'page_title' => 'Network feed', - 'should_format' => true, - 'notes' => $notes, + 'notes' => $data['notes'], ]; } } diff --git a/src/Controller/ResetPassword.php b/src/Controller/ResetPassword.php index a0d978ea84..aeaa2412ff 100644 --- a/src/Controller/ResetPassword.php +++ b/src/Controller/ResetPassword.php @@ -115,7 +115,7 @@ class ResetPassword extends Controller // // The session is cleaned up after the password has been changed. // $this->cleanSessionAfterReset(); - // throw new RedirectException('main_all'); + // throw new RedirectException('root'); // } // return [ diff --git a/src/Controller/Security.php b/src/Controller/Security.php index fc94efbc45..f0e6cb77b9 100644 --- a/src/Controller/Security.php +++ b/src/Controller/Security.php @@ -52,7 +52,7 @@ class Security extends Controller { // Skip if already logged in if ($this->getUser()) { - return $this->redirectToRoute('main_all'); + return $this->redirectToRoute('root'); } // get the login error if there is one @@ -150,10 +150,10 @@ class Security extends Controller $actor = Actor::create([ 'nickname' => $nickname, 'is_local' => true, - 'type' => Actor::PERSON, - 'roles' => UserRoles::USER, + 'type' => Actor::PERSON, + 'roles' => UserRoles::USER, ]); - $user = LocalUser::create([ + $user = LocalUser::create([ 'nickname' => $nickname, 'outgoing_email' => $data['email'], 'incoming_email' => $data['email'], diff --git a/src/Core/Controller.php b/src/Core/Controller.php index 5d86e895d1..f98bbca71f 100644 --- a/src/Core/Controller.php +++ b/src/Core/Controller.php @@ -33,12 +33,12 @@ declare(strict_types = 1); namespace App\Core; -use App\Core\Controller\FeedController; use function App\Core\I18n\_m; use App\Util\Common; use App\Util\Exception\ClientException; use App\Util\Exception\RedirectException; use App\Util\Exception\ServerException; +use Component\Feed\Util\FeedController; use Exception; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\EventDispatcher\EventSubscriberInterface; @@ -136,6 +136,7 @@ abstract class Controller extends AbstractController implements EventSubscriberI $controller = $controller[0]; } + // XXX: Could we do this differently? if (is_subclass_of($controller, FeedController::class)) { $this->vars = FeedController::post_process($this->vars); } diff --git a/src/Core/Controller/ActorController.php b/src/Core/Controller/ActorController.php index be87f3fb42..2b82ebce2c 100644 --- a/src/Core/Controller/ActorController.php +++ b/src/Core/Controller/ActorController.php @@ -37,6 +37,7 @@ use function App\Core\I18n\_m; use App\Core\Router\Router; use App\Util\Exception\ClientException; use App\Util\Exception\RedirectException; +use Component\Feed\Util\FeedController; abstract class ActorController extends FeedController { diff --git a/src/Entity/Feed.php b/src/Entity/Feed.php index c433084a56..344f109fad 100644 --- a/src/Entity/Feed.php +++ b/src/Entity/Feed.php @@ -152,9 +152,8 @@ class Feed extends Entity public static function createDefaultFeeds(int $actor_id, LocalUser $user): void { $ordering = 1; - DB::persist(self::create(['actor_id' => $actor_id, 'url' => Router::url($route = 'main_public'), 'route' => $route, 'title' => _m('Public'), 'ordering' => $ordering++])); - DB::persist(self::create(['actor_id' => $actor_id, 'url' => Router::url($route = 'main_all'), 'route' => $route, 'title' => _m('Network'), 'ordering' => $ordering++])); - DB::persist(self::create(['actor_id' => $actor_id, 'url' => Router::url($route = 'home_all', ['nickname' => $user->getNickname()]), 'route' => $route, 'title' => _m('Home'), 'ordering' => $ordering++])); + DB::persist(self::create(['actor_id' => $actor_id, 'url' => Router::url($route = 'feed_home', ['nickname' => $user->getNickname()]), 'route' => $route, 'title' => _m('Home'), 'ordering' => $ordering++])); + DB::persist(self::create(['actor_id' => $actor_id, 'url' => Router::url($route = 'feed_public'), 'route' => $route, 'title' => _m('Planet'), 'ordering' => $ordering++])); Event::handle('CreateDefaultFeeds', [$actor_id, $user, &$ordering]); } diff --git a/src/Entity/Note.php b/src/Entity/Note.php index 046b532a16..0d1b2caa8c 100644 --- a/src/Entity/Note.php +++ b/src/Entity/Note.php @@ -255,26 +255,8 @@ class Note extends Entity public static function getAllNotesByActor(Actor $actor): array { - return DB::sql( - <<<'EOF' - select {select} from note n - where (n.actor_id & :actor_id) <> 0 - order by n.created DESC - EOF, - ['actor_id' => $actor], - ); - } - - public static function getAllNotes(int $note_scope): array - { - return DB::sql( - <<<'EOF' - select {select} from note n - where (n.scope & :scope) <> 0 - order by n.created DESC - EOF, - ['scope' => $note_scope], - ); + // TODO: Enforce scoping on the notes before returning + return DB::findBy('note', ['actor_id' => $actor->getId()], order_by: ['created' => 'DESC', 'id' => 'DESC']); } public function getAttachments(): array @@ -374,13 +356,12 @@ class Note extends Entity } /** - * * @return array of ids of Actors */ public function getNotificationTargetIds(array $ids_already_known = [], ?int $sender_id = null): array { $target_ids = []; - if (!array_key_exists('object', $ids_already_known)) { + if (!\array_key_exists('object', $ids_already_known)) { $mentions = Formatting::findMentions($this->getContent(), $this->getActor()); foreach ($mentions as $mention) { foreach ($mention['mentioned'] as $m) { @@ -390,7 +371,7 @@ class Note extends Entity } // Additional actors that should know about this - if (array_key_exists('additional', $ids_already_known)) { + if (\array_key_exists('additional', $ids_already_known)) { array_push($target_ids, ...$ids_already_known['additional']); } @@ -398,18 +379,17 @@ class Note extends Entity } /** - * * @return array of Actors */ public function getNotificationTargets(array $ids_already_known = [], ?int $sender_id = null): array { - if (array_key_exists('additional', $ids_already_known)) { + if (\array_key_exists('additional', $ids_already_known)) { $target_ids = $this->getNotificationTargetIds($ids_already_known, $sender_id); return $target_ids === [] ? [] : DB::findBy('actor', ['id' => $target_ids]); } $mentioned = []; - if (!array_key_exists('object', $ids_already_known)) { + if (!\array_key_exists('object', $ids_already_known)) { $mentions = Formatting::findMentions($this->getContent(), $this->getActor()); foreach ($mentions as $mention) { foreach ($mention['mentioned'] as $m) { diff --git a/src/Security/Authenticator.php b/src/Security/Authenticator.php index ec7b540f82..424b4b2ba2 100644 --- a/src/Security/Authenticator.php +++ b/src/Security/Authenticator.php @@ -160,7 +160,7 @@ class Authenticator extends AbstractFormLoginAuthenticator implements Authentica return new RedirectResponse($targetPath); } - return new RedirectResponse(Router::url('main_all')); + return new RedirectResponse(Router::url('root')); } public function authenticate(Request $request): PassportInterface diff --git a/templates/actor/view.html.twig b/templates/actor/view.html.twig index 8ae5d19d76..8dd0570a20 100644 --- a/templates/actor/view.html.twig +++ b/templates/actor/view.html.twig @@ -1,4 +1,4 @@ -{% extends 'feeds/feed.html.twig' %} +{% extends 'feed/feed.html.twig' %} {% set nickname = nickname|escape %} diff --git a/templates/base.html.twig b/templates/base.html.twig index 66aeeffa44..a5b48a8cd9 100644 --- a/templates/base.html.twig +++ b/templates/base.html.twig @@ -73,7 +73,7 @@ -

{{ icon('logo', 'icon icon-logo') | raw }}{{ config('site', 'name') }}

 diff --git a/templates/cards/navigation/view.html.twig b/templates/cards/navigation/view.html.twig index 9ba33fb4f3..ff6ecd4f91 100644 --- a/templates/cards/navigation/view.html.twig +++ b/templates/cards/navigation/view.html.twig @@ -15,13 +15,8 @@ {% if not app.user %} {# Default feeds #} diff --git a/tests/Controller/FeedsTest.php b/tests/Controller/FeedsTest.php index 1cc91f483c..6f903ec7c7 100644 --- a/tests/Controller/FeedsTest.php +++ b/tests/Controller/FeedsTest.php @@ -76,10 +76,10 @@ class FeedsTest extends GNUsocialTestCase $req_stack = $this->createMock(RequestStack::class); $feeds = new Feeds($req_stack); if ($route == 'home') { - static::assertThrows(ClientException::class, fn () => $feeds->home($req, 'username_not_taken')); + static::assertThrows(ClientException::class, fn () => $feeds->home($req)); } $result = $feeds->{$route}($req, ...$extra_args); - static::assertSame($result['_template'], 'feeds/feed.html.twig'); + static::assertSame($result['_template'], 'feed/feed.html.twig'); foreach ($result['notes'] as $n) { static::assertIsArray($n['replies']); } diff --git a/tests/Controller/SecurityTest.php b/tests/Controller/SecurityTest.php index 813318c1cd..d312aaed70 100644 --- a/tests/Controller/SecurityTest.php +++ b/tests/Controller/SecurityTest.php @@ -50,7 +50,7 @@ class SecurityTest extends GNUsocialTestCase [, $crawler] = self::testLogin($nickname = 'taken_user', 'foobar'); $this->assertResponseIsSuccessful(); $this->assertSelectorNotExists('.alert'); - $this->assertRouteSame('main_all'); + $this->assertRouteSame('root'); $this->assertSelectorTextContains('.profile-info .profile-info-nickname', $nickname); } @@ -59,7 +59,7 @@ class SecurityTest extends GNUsocialTestCase [$client] = self::testLogin('taken_user', 'foobar'); // Normal login $crawler = $client->request('GET', '/main/login'); // attempt to login again $client->followRedirect(); - $this->assertRouteSame('main_all'); + $this->assertRouteSame('root'); } public function testLoginFailure() @@ -75,7 +75,7 @@ class SecurityTest extends GNUsocialTestCase self::testLogin('email@provider', 'foobar'); $this->assertResponseIsSuccessful(); $this->assertSelectorNotExists('.alert'); - $this->assertRouteSame('main_all'); + $this->assertRouteSame('root'); $this->assertSelectorTextContains('.profile-info .profile-info-nickname', 'taken_user'); } @@ -102,7 +102,7 @@ class SecurityTest extends GNUsocialTestCase $client->followRedirect(); $this->assertResponseIsSuccessful(); $this->assertSelectorNotExists('.alert'); - $this->assertRouteSame('main_all'); + $this->assertRouteSame('root'); $this->assertSelectorTextContains('.profile-info .profile-info-nickname', 'new_nickname'); }