From 382db650c305e335d022649844afb4e92fea001a Mon Sep 17 00:00:00 2001 From: BentiGorlich Date: Sat, 31 Jan 2026 20:59:14 +0100 Subject: [PATCH 1/6] Move the front page to cursor based pagination - instead of the usual `LIMIT`/`OFFSET` pagination use cursor based one based on the current ordering - Write classes that are inspired by the pagination of doctrine for cursor based pagination - make the `ContentRepository` work with the new pagination, while still working with the regular one --- assets/styles/layout/_section.scss | 11 + src/Controller/Entry/EntryFrontController.php | 25 +- .../Cursor/CursorAdapterInterface.php | 32 + src/Pagination/Cursor/CursorPagination.php | 213 +++++++ .../Cursor/CursorPaginationInterface.php | 63 ++ .../Cursor/NativeQueryCursorAdapter.php | 78 +++ src/Pagination/NativeQueryAdapter.php | 20 +- src/Repository/ContentRepository.php | 572 +++++++++++------- .../Components/CursorPaginationComponent.php | 16 + src/Twig/Extension/UrlExtension.php | 1 + src/Twig/Runtime/NavbarExtensionRuntime.php | 6 +- src/Twig/Runtime/UrlExtensionRuntime.php | 10 + src/Utils/SqlHelpers.php | 34 +- .../components/cursor_pagination.html.twig | 19 + templates/entry/_options.html.twig | 50 +- templates/layout/_subject_list.html.twig | 23 + .../Entry/EntryFrontControllerTest.php | 5 +- tests/Unit/CursorPaginationTest.php | 129 ++++ 18 files changed, 1022 insertions(+), 285 deletions(-) create mode 100644 src/Pagination/Cursor/CursorAdapterInterface.php create mode 100644 src/Pagination/Cursor/CursorPagination.php create mode 100644 src/Pagination/Cursor/CursorPaginationInterface.php create mode 100644 src/Pagination/Cursor/NativeQueryCursorAdapter.php create mode 100644 src/Twig/Components/CursorPaginationComponent.php create mode 100644 templates/components/cursor_pagination.html.twig create mode 100644 tests/Unit/CursorPaginationTest.php diff --git a/assets/styles/layout/_section.scss b/assets/styles/layout/_section.scss index 54bfa561d0..6ef66ad47e 100644 --- a/assets/styles/layout/_section.scss +++ b/assets/styles/layout/_section.scss @@ -71,3 +71,14 @@ color: var(--kbin-alert-danger-text-color); } } + +.cursor-pagination .section { + text-align: center; + padding: .25rem; + + a { + display: inline-block; + width: 25%; + min-width: 250px; + } +} diff --git a/src/Controller/Entry/EntryFrontController.php b/src/Controller/Entry/EntryFrontController.php index adceff7113..a644eb1f1d 100644 --- a/src/Controller/Entry/EntryFrontController.php +++ b/src/Controller/Entry/EntryFrontController.php @@ -41,6 +41,7 @@ public function front( #[MapQueryParameter] ?string $type, Request $request, + #[MapQueryParameter] ?string $cursor = null, ): Response { $user = $this->getUser(); @@ -61,7 +62,8 @@ public function front( $criteria->fetchCachedItems($this->contentRepository, $user); } - $entities = $this->contentRepository->findByCriteria($criteria); + $entities = $this->contentRepository->findByCriteriaCursored($criteria, $this->getCursorByCriteria($criteria, $cursor)); + $page = $entities->getCurrentPageResults(); $templatePath = 'content/'; $dataKey = 'results'; @@ -106,6 +108,7 @@ public function magazine( #[MapQueryParameter] ?string $type, Request $request, + #[MapQueryParameter] ?string $cursor = null, ): Response { $user = $this->getUser(); $response = new Response(); @@ -132,7 +135,7 @@ public function magazine( return $this->renderResponse( $request, $criteria, - ['results' => $this->contentRepository->findByCriteria($criteria), 'magazine' => $magazine], + ['results' => $this->contentRepository->findByCriteriaCursored($criteria, $this->getCursorByCriteria($criteria, $cursor)), 'magazine' => $magazine], 'content/', $user ); @@ -299,4 +302,22 @@ private function handleCrossposts($pagination): PagerfantaInterface return $pagerfanta; } + + /** + * @throws \DateMalformedStringException + */ + private function getCursorByCriteria(Criteria $criteria, ?string $cursor): int|\DateTimeImmutable + { + $guessedCursor = $this->contentRepository->guessInitialCursor($criteria); + if ($guessedCursor instanceof \DateTimeImmutable) { + $currentCursor = null !== $cursor ? new \DateTimeImmutable($cursor) : $guessedCursor; + // $currentCursor = null !== $cursor ? (new \DateTimeImmutable)->setTimestamp(intval($cursor)) : $guessedCursor; + } elseif (\is_int($guessedCursor)) { + $currentCursor = null !== $cursor ? \intval($cursor) : $guessedCursor; + } else { + throw new \LogicException(\get_class($guessedCursor).' is not accounted for'); + } + + return $currentCursor; + } } diff --git a/src/Pagination/Cursor/CursorAdapterInterface.php b/src/Pagination/Cursor/CursorAdapterInterface.php new file mode 100644 index 0000000000..0715dd2d0b --- /dev/null +++ b/src/Pagination/Cursor/CursorAdapterInterface.php @@ -0,0 +1,32 @@ + $length + * + * @return iterable + */ + public function getSlice(mixed $cursor, int $length): iterable; + + /** + * Returns a slice of the results representing the previous page of items in reverse. + * + * @param TCursor $cursor + * @param int<0, max> $length + * + * @return iterable + */ + public function getPreviousSlice(mixed $cursor, int $length): iterable; +} diff --git a/src/Pagination/Cursor/CursorPagination.php b/src/Pagination/Cursor/CursorPagination.php new file mode 100644 index 0000000000..3240c73ca3 --- /dev/null +++ b/src/Pagination/Cursor/CursorPagination.php @@ -0,0 +1,213 @@ +|null + */ + private ?array $currentPageResults = null; + + /** + * @var array|null + */ + private ?array $previousPageResults = null; + + /** + * @var TCursor|null + */ + private mixed $currentCursor = null; + + /** + * @var TCursor|null + */ + private mixed $nextCursor = null; + + /** + * @param CursorAdapterInterface $adapter + */ + public function __construct( + private readonly CursorAdapterInterface $adapter, + private readonly string $cursorFieldName, + private int $maxPerPage, + ) { + } + + public function getIterator(): \Traversable + { + $results = $this->getCurrentPageResults(); + + if ($results instanceof \Iterator) { + return $results; + } + + if ($results instanceof \IteratorAggregate) { + return $results->getIterator(); + } + + if (\is_array($results)) { + return new \ArrayIterator($results); + } + + throw new \InvalidArgumentException(\sprintf('Cannot create iterator with page results of type "%s".', \get_class($results))); + } + + public function getAdapter(): CursorAdapterInterface + { + return $this->adapter; + } + + public function setMaxPerPage(int $maxPerPage): CursorPaginationInterface + { + $this->maxPerPage = $maxPerPage; + + return $this; + } + + public function getMaxPerPage(): int + { + return $this->maxPerPage; + } + + public function getCurrentPageResults(): iterable + { + if (null !== $this->currentPageResults) { + return $this->currentPageResults; + } + $results = $this->adapter->getSlice($this->currentCursor, $this->maxPerPage); + $this->currentPageResults = [...$results]; + + return $this->currentPageResults; + } + + public function haveToPaginate(): bool + { + return $this->maxPerPage === \sizeof($this->currentPageResults ?? [...$this->getCurrentPageResults()]); + } + + public function hasNextPage(): bool + { + return $this->haveToPaginate(); + } + + public function getNextPage(): mixed + { + if (null !== $this->nextCursor) { + return $this->nextCursor; + } + + $cursorFieldName = $this->cursorFieldName; + $array = $this->getCurrentPageResults(); + $nextCursor = null; + $i = 0; + foreach ($array as $item) { + if (\is_object($item)) { + $nextCursor = $item->$cursorFieldName; + } elseif (\is_array($item)) { + $nextCursor = $item[$cursorFieldName]; + } else { + throw new \LogicException('Item has to be an object or array.'); + } + ++$i; + } + if ($this->maxPerPage === $i) { + $this->nextCursor = $nextCursor; + + return $nextCursor; + } + throw new \LogicException('There is no next page'); + } + + /** + * Generates an iterator to automatically iterate over all pages in a result set. + * + * @return \Generator + */ + public function autoPagingIterator(): \Generator + { + while (true) { + foreach ($this->getCurrentPageResults() as $item) { + yield $item; + } + + if (!$this->hasNextPage()) { + break; + } + + $this->setCurrentPage($this->getNextPage()); + } + } + + public function setCurrentPage(mixed $cursor): CursorPaginationInterface + { + if ($cursor !== $this->currentCursor) { + $this->previousPageResults = null; + $this->currentCursor = $cursor; + $this->currentPageResults = null; + $this->nextCursor = null; + } + + return $this; + } + + public function getCurrentCursor(): mixed + { + return $this->currentCursor; + } + + public function hasPreviousPage(): bool + { + return \sizeof($this->getPreviousPageResults()) > 0; + } + + public function getPreviousPage(): mixed + { + $cursorFieldName = $this->cursorFieldName; + $array = $this->getPreviousPageResults(); + $key = array_key_last($array); + + $item = $array[$key]; + if (\is_object($item)) { + $cursor = $item->$cursorFieldName; + } elseif (\is_array($item)) { + $cursor = $item[$cursorFieldName]; + } else { + throw new \LogicException('Item has to be an object or array.'); + } + + $currentCursor = $this->getCurrentCursor(); + // we need to modify the value to include the last result of the previous page in reverse, + // otherwise we will always be missing one result when going back + if ($currentCursor > $cursor) { + if ($cursor instanceof \DateTime || $cursor instanceof \DateTimeImmutable) { + return (new \DateTimeImmutable())->setTimestamp($cursor->getTimestamp() - 1); + } elseif (\is_int($cursor)) { + return --$cursor; + } + } else { + if ($cursor instanceof \DateTime || $cursor instanceof \DateTimeImmutable) { + return (new \DateTimeImmutable())->setTimestamp($cursor->getTimestamp() + 1); + } elseif (\is_int($cursor)) { + return ++$cursor; + } + } + + return $cursor; + } + + private function getPreviousPageResults(): array + { + if (null === $this->previousPageResults) { + $this->previousPageResults = [...$this->adapter->getPreviousSlice($this->currentCursor, $this->maxPerPage)]; + } + + return $this->previousPageResults; + } +} diff --git a/src/Pagination/Cursor/CursorPaginationInterface.php b/src/Pagination/Cursor/CursorPaginationInterface.php new file mode 100644 index 0000000000..82bac2c661 --- /dev/null +++ b/src/Pagination/Cursor/CursorPaginationInterface.php @@ -0,0 +1,63 @@ + + * + * @method \Generator autoPagingIterator() + */ +interface CursorPaginationInterface extends \IteratorAggregate +{ + /** + * @return CursorAdapterInterface + */ + public function getAdapter(): CursorAdapterInterface; + + public function setMaxPerPage(int $maxPerPage): self; + + /** + * @param TCursor $cursor + */ + public function setCurrentPage(mixed $cursor): self; + + public function getMaxPerPage(): int; + + /** + * @return iterable + */ + public function getCurrentPageResults(): iterable; + + public function haveToPaginate(): bool; + + public function hasNextPage(): bool; + + /** + * @return TCursor + * + * @throws LogicException if there is no next page + */ + public function getNextPage(): mixed; + + public function hasPreviousPage(): bool; + + /** + * @return TCursor + * + * @throws LogicException if there is no previous page + */ + public function getPreviousPage(): mixed; + + /** + * @return TCursor + */ + public function getCurrentCursor(): mixed; +} diff --git a/src/Pagination/Cursor/NativeQueryCursorAdapter.php b/src/Pagination/Cursor/NativeQueryCursorAdapter.php new file mode 100644 index 0000000000..b070dd5ad2 --- /dev/null +++ b/src/Pagination/Cursor/NativeQueryCursorAdapter.php @@ -0,0 +1,78 @@ + $parameters parameter name as key, parameter value as the value + * @param ResultTransformer $transformer defaults to the VoidTransformer which does not transform the result in any way + * + * @throws Exception + */ + public function __construct( + private readonly Connection $conn, + private string $sql, + private string $forwardCursorCondition, + private string $backwardCursorCondition, + private string $forwardCursorSort, + private string $backwardCursorSort, + private readonly array $parameters, + private readonly ResultTransformer $transformer = new VoidTransformer(), + ) { + } + + /** + * @param TCursor $cursor + * + * @return iterable + * + * @throws Exception + */ + public function getSlice(mixed $cursor, int $length): iterable + { + $replacedCursorSortSql = str_replace('%cursorSort%', $this->forwardCursorSort, $this->sql); + $replacedCursorSql = str_replace('%cursor%', $this->forwardCursorCondition, $replacedCursorSortSql); + $sql = $replacedCursorSql.' LIMIT :limit'; + + return $this->query($sql, $cursor, $length); + } + + public function getPreviousSlice(mixed $cursor, int $length): iterable + { + $replacedCursorSortSql = str_replace('%cursorSort%', $this->backwardCursorSort, $this->sql); + $replacedCursorSql = str_replace('%cursor%', $this->backwardCursorCondition, $replacedCursorSortSql); + $sql = $replacedCursorSql.' LIMIT :limit'; + + return $this->query($sql, $cursor, $length); + } + + /** + * @throws Exception + */ + private function query(string $sql, mixed $cursor, int $length): iterable + { + $statement = $this->conn->prepare($sql); + foreach ($this->parameters as $key => $value) { + $statement->bindValue($key, $value, SqlHelpers::getSqlType($value)); + } + $statement->bindValue('cursor', $cursor, SqlHelpers::getSqlType($cursor)); + $statement->bindValue('limit', $length); + + return $this->transformer->transform($statement->executeQuery()->fetchAllAssociative()); + } +} diff --git a/src/Pagination/NativeQueryAdapter.php b/src/Pagination/NativeQueryAdapter.php index 1668b66a62..a4aedd6b3d 100644 --- a/src/Pagination/NativeQueryAdapter.php +++ b/src/Pagination/NativeQueryAdapter.php @@ -6,11 +6,10 @@ use App\Pagination\Transformation\ResultTransformer; use App\Pagination\Transformation\VoidTransformer; +use App\Utils\SqlHelpers; use Doctrine\DBAL\Connection; use Doctrine\DBAL\Exception; -use Doctrine\DBAL\ParameterType; use Doctrine\DBAL\Statement; -use Doctrine\DBAL\Types\Types; use Pagerfanta\Adapter\AdapterInterface; use Psr\Cache\CacheItemInterface; use Symfony\Contracts\Cache\CacheInterface; @@ -42,7 +41,7 @@ public function __construct( $this->statement = $this->conn->prepare($sql.' LIMIT :limit OFFSET :offset'); foreach ($this->parameters as $key => $value) { - $this->statement->bindValue($key, $value, $this->getSqlType($value)); + $this->statement->bindValue($key, $value, SqlHelpers::getSqlType($value)); } } @@ -73,7 +72,7 @@ private function calculateNumOfResults(string $sql, array $parameters): int $sql2 = 'SELECT COUNT(*) as cnt FROM ('.$sql.') sub'; $stmt2 = $this->conn->prepare($sql2); foreach ($parameters as $key => $value) { - $stmt2->bindValue($key, $value, $this->getSqlType($value)); + $stmt2->bindValue($key, $value, SqlHelpers::getSqlType($value)); } $result = $stmt2->executeQuery()->fetchAllAssociative(); @@ -92,17 +91,4 @@ public function getSlice(int $offset, int $length): iterable return $this->transformer->transform($this->statement->executeQuery()->fetchAllAssociative()); } - - private function getSqlType(mixed $value): mixed - { - if ($value instanceof \DateTimeImmutable) { - return Types::DATETIMETZ_IMMUTABLE; - } elseif ($value instanceof \DateTime) { - return Types::DATETIMETZ_MUTABLE; - } elseif (\is_int($value)) { - return Types::INTEGER; - } - - return ParameterType::STRING; - } } diff --git a/src/Repository/ContentRepository.php b/src/Repository/ContentRepository.php index 6eb1c38f2d..542de2536a 100644 --- a/src/Repository/ContentRepository.php +++ b/src/Repository/ContentRepository.php @@ -5,7 +5,12 @@ namespace App\Repository; use App\Entity\Contracts\VisibilityInterface; +use App\Entity\Entry; +use App\Entity\Post; use App\Entity\User; +use App\Pagination\Cursor\CursorPagination; +use App\Pagination\Cursor\CursorPaginationInterface; +use App\Pagination\Cursor\NativeQueryCursorAdapter; use App\Pagination\NativeQueryAdapter; use App\Pagination\Pagerfanta; use App\Pagination\Transformation\ContentPopulationTransformer; @@ -43,6 +48,272 @@ public function __construct( } public function findByCriteria(Criteria $criteria): PagerfantaInterface + { + $query = $this->getQueryAndParameters($criteria, false); + $conn = $this->entityManager->getConnection(); + + $numResults = null; + if ('test' !== $this->kernel->getEnvironment() && !$criteria->magazine && !$criteria->moderated && !$criteria->favourite && Criteria::TIME_ALL === $criteria->time && Criteria::AP_ALL === $criteria->federation && 'all' === $criteria->type) { + // pre-set the results to 1000 pages for queries not very limited by the parameters so the count query is not being executed + $numResults = 1000 * ($criteria->perPage ?? self::PER_PAGE); + } + $fanta = new Pagerfanta(new NativeQueryAdapter($conn, $query['sql'], $query['parameters'], numOfResults: $numResults, transformer: $this->contentPopulationTransformer, cache: $this->cache)); + $fanta->setMaxPerPage($criteria->perPage ?? self::PER_PAGE); + $fanta->setCurrentPage($criteria->page); + + return $fanta; + } + + /** + * @template-covariant TCursor + * + * @param TCursor|null $currentCursor + * + * @return CursorPaginationInterface + * + * @throws Exception + */ + public function findByCriteriaCursored(Criteria $criteria, mixed $currentCursor): CursorPaginationInterface + { + $query = $this->getQueryAndParameters($criteria, true); + $conn = $this->entityManager->getConnection(); + $orderings = $this->getOrderings($criteria); + + $fanta = new CursorPagination( + new NativeQueryCursorAdapter( + $conn, + $query['sql'], + $this->getCursorWhereFromCriteria($criteria), + $this->getCursorWhereInvertedFromCriteria($criteria), + join(',', $orderings), + join(',', SqlHelpers::invertOrderings($orderings)), + $query['parameters'], + transformer: $this->contentPopulationTransformer, + ), + $this->getCursorFieldFromCriteria($criteria), + $criteria->perPage ?? self::PER_PAGE, + ); + $fanta->setCurrentPage($currentCursor ?? $this->guessInitialCursor($criteria)); + + return $fanta; + } + + /** + * @return int[] the ids of the users $user follows + * + * @throws InvalidArgumentException|Exception + */ + public function getCachedUserFollows(User $user): array + { + $sql = 'SELECT following_id FROM user_follow WHERE follower_id = :uId'; + if ('test' === $this->kernel->getEnvironment()) { + return $this->fetchSingleColumnAsArray($sql, $user); + } + + return $this->cache->get(self::USER_FOLLOWS_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { + return $this->fetchSingleColumnAsArray($sql, $user); + }); + } + + public function clearCachedUserFollows(User $user): void + { + $this->logger->debug('Clearing cached user follows for user {u}', ['u' => $user->username]); + try { + $this->cache->delete(self::USER_FOLLOWS_KEY.$user->getId()); + } catch (InvalidArgumentException $exception) { + $this->logger->warning('There was an error clearing the cached user follows of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); + } + } + + /** + * @return int[] the ids of the magazines $user is subscribed to + * + * @throws InvalidArgumentException|Exception + */ + public function getCachedUserSubscribedMagazines(User $user): array + { + $sql = 'SELECT magazine_id FROM magazine_subscription WHERE user_id = :uId'; + if ('test' === $this->kernel->getEnvironment()) { + return $this->fetchSingleColumnAsArray($sql, $user); + } + + return $this->cache->get(self::USER_MAGAZINE_SUBSCRIPTION_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { + return $this->fetchSingleColumnAsArray($sql, $user); + }); + } + + public function clearCachedUserSubscribedMagazines(User $user): void + { + $this->logger->debug('Clearing cached magazine subscriptions for user {u}', ['u' => $user->username]); + try { + $this->cache->delete(self::USER_MAGAZINE_SUBSCRIPTION_KEY.$user->getId()); + } catch (InvalidArgumentException $exception) { + $this->logger->warning('There was an error clearing the cached subscribed Magazines of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); + } + } + + /** + * @return int[] the ids of the magazines $user moderates + * + * @throws InvalidArgumentException|Exception + */ + public function getCachedUserModeratedMagazines(User $user): array + { + $sql = 'SELECT magazine_id FROM moderator WHERE user_id = :uId'; + if ('test' === $this->kernel->getEnvironment()) { + return $this->fetchSingleColumnAsArray($sql, $user); + } + + return $this->cache->get(self::USER_MAGAZINE_MODERATION_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { + return $this->fetchSingleColumnAsArray($sql, $user); + }); + } + + public function clearCachedUserModeratedMagazines(User $user): void + { + $this->logger->debug('Clearing cached moderated magazines for user {u}', ['u' => $user->username]); + try { + $this->cache->delete(self::USER_MAGAZINE_MODERATION_KEY.$user->getId()); + } catch (InvalidArgumentException $exception) { + $this->logger->warning('There was an error clearing the cached moderated magazines of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); + } + } + + /** + * @return int[] the ids of the domains $user is subscribed to + * + * @throws InvalidArgumentException|Exception + */ + public function getCachedUserSubscribedDomains(User $user): array + { + $sql = 'SELECT domain_id FROM domain_subscription WHERE user_id = :uId'; + if ('test' === $this->kernel->getEnvironment()) { + return $this->fetchSingleColumnAsArray($sql, $user); + } + + return $this->cache->get(self::USER_DOMAIN_SUBSCRIPTION_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { + return $this->fetchSingleColumnAsArray($sql, $user); + }); + } + + public function clearCachedUserSubscribedDomains(User $user): void + { + $this->logger->debug('Clearing cached domain subscriptions for user {u}', ['u' => $user->username]); + try { + $this->cache->delete(self::USER_DOMAIN_SUBSCRIPTION_KEY.$user->getId()); + } catch (InvalidArgumentException $exception) { + $this->logger->warning('There was an error clearing the cached subscribed domains of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); + } + } + + /** + * @return int[] the ids of the domains $user is subscribed to + * + * @throws InvalidArgumentException|Exception + */ + public function getCachedUserBlocks(User $user): array + { + $sql = 'SELECT blocked_id FROM user_block WHERE blocker_id = :uId'; + if ('test' === $this->kernel->getEnvironment()) { + return $this->fetchSingleColumnAsArray($sql, $user); + } + + return $this->cache->get(self::USER_BLOCKS_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { + return $this->fetchSingleColumnAsArray($sql, $user); + }); + } + + public function clearCachedUserBlocks(User $user): void + { + $this->logger->debug('Clearing cached user blocks for user {u}', ['u' => $user->username]); + try { + $this->cache->delete(self::USER_BLOCKS_KEY.$user->getId()); + } catch (InvalidArgumentException $exception) { + $this->logger->warning('There was an error clearing the cached blocked user of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); + } + } + + /** + * @return int[] the ids of the domains $user is subscribed to + * + * @throws InvalidArgumentException|Exception + */ + public function getCachedUserMagazineBlocks(User $user): array + { + $sql = 'SELECT magazine_id FROM magazine_block WHERE user_id = :uId'; + if ('test' === $this->kernel->getEnvironment()) { + return $this->fetchSingleColumnAsArray($sql, $user); + } + + return $this->cache->get(self::USER_MAGAZINE_BLOCKS_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { + return $this->fetchSingleColumnAsArray($sql, $user); + }); + } + + public function clearCachedUserMagazineBlocks(User $user): void + { + $this->logger->debug('Clearing cached magazine blocks for user {u}', ['u' => $user->username]); + try { + $this->cache->delete(self::USER_MAGAZINE_BLOCKS_KEY.$user->getId()); + } catch (InvalidArgumentException $exception) { + $this->logger->warning('There was an error clearing the cached blocked magazines of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); + } + } + + /** + * @return int[] the ids of the domains $user is subscribed to + * + * @throws InvalidArgumentException|Exception + */ + public function getCachedUserDomainBlocks(User $user): array + { + $sql = 'SELECT domain_id FROM domain_block WHERE user_id = :uId'; + if ('test' === $this->kernel->getEnvironment()) { + return $this->fetchSingleColumnAsArray($sql, $user); + } + + return $this->cache->get(self::USER_DOMAIN_BLOCKS_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { + return $this->fetchSingleColumnAsArray($sql, $user); + }); + } + + public function clearCachedUserDomainBlocks(User $user): void + { + $this->logger->debug('Clearing cached domain blocks for user {u}', ['u' => $user->username]); + try { + $this->cache->delete(self::USER_DOMAIN_BLOCKS_KEY.$user->getId()); + } catch (InvalidArgumentException $exception) { + $this->logger->warning('There was an error clearing the cached blocked domains of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); + } + } + + /** + * @param string $sql the sql to fetch the single column, should contain a 'uId' Parameter + * + * @return int[] + * + * @throws Exception + */ + public function fetchSingleColumnAsArray(string $sql, User $user): array + { + $conn = $this->entityManager->getConnection(); + $stmt = $conn->prepare($sql); + $result = $stmt->executeQuery(['uId' => $user->getId()]); + $rows = $result->fetchAllAssociative(); + $result = []; + foreach ($rows as $row) { + $result[] = $row[array_key_first($row)]; + } + + $this->logger->debug('Fetching single column row from {sql}: {res}', ['sql' => $sql, 'res' => $result]); + + return $result; + } + + /** + * @return array{sql: string, parameters: array}> + */ + private function getQueryAndParameters(Criteria $criteria, bool $addCursor): array { $includeEntries = Criteria::CONTENT_COMBINED === $criteria->content || Criteria::CONTENT_THREADS === $criteria->content; $parameters = [ @@ -235,6 +506,7 @@ public function findByCriteria(Criteria $criteria): PagerfantaInterface $visibilityClauseM, $visibilityClauseC, $allClause, + $addCursor ? 'c.%cursor%' : '', ]); $postWhere = SqlHelpers::makeWhereString([ @@ -255,44 +527,17 @@ public function findByCriteria(Criteria $criteria): PagerfantaInterface $visibilityClauseM, $visibilityClauseC, $allClause, + $addCursor ? 'c.%cursor%' : '', ]); $outerWhere = SqlHelpers::makeWhereString([ $visibilityClauseU, $deletedClause, $allClauseU, + $addCursor ? 'content.%cursor%' : '', ]); - $orderings = []; - - if ($criteria->stickiesFirst) { - $orderings[] = 'sticky DESC'; - } - - switch ($criteria->sortOption) { - case Criteria::SORT_TOP: - $orderings[] = 'score DESC'; - break; - case Criteria::SORT_HOT: - $orderings[] = 'ranking DESC'; - break; - case Criteria::SORT_COMMENTED: - $orderings[] = 'comment_count DESC'; - break; - case Criteria::SORT_ACTIVE: - $orderings[] = 'last_active DESC'; - break; - default: - } - - switch ($criteria->sortOption) { - case Criteria::SORT_OLD: - $orderings[] = 'created_at ASC'; - break; - case Criteria::SORT_NEW: - default: - $orderings[] = 'created_at DESC'; - } + $orderings = $addCursor ? ['%cursorSort%'] : $this->getOrderings($criteria); $orderBy = 'ORDER BY '.join(', ', $orderings); // only join domain if we are explicitly looking at one @@ -306,13 +551,14 @@ public function findByCriteria(Criteria $criteria): PagerfantaInterface LEFT JOIN magazine m ON c.magazine_id = m.id $postWhere"; + $innerLimit = $addCursor ? 'LIMIT :limit' : ''; $innerSql = ''; if (Criteria::CONTENT_THREADS === $criteria->content) { - $innerSql = "$entrySql $orderBy"; + $innerSql = "$entrySql $orderBy $innerLimit"; } elseif (Criteria::CONTENT_MICROBLOG === $criteria->content) { - $innerSql = "$postSql $orderBy"; + $innerSql = "$postSql $orderBy $innerLimit"; } else { - $innerSql = "$entrySql UNION ALL $postSql"; + $innerSql = "($entrySql $orderBy $innerLimit) UNION ALL ($postSql $orderBy $innerLimit)"; } $sql = "SELECT content.* FROM ($innerSql) content @@ -325,232 +571,90 @@ public function findByCriteria(Criteria $criteria): PagerfantaInterface } $rewritten = SqlHelpers::rewriteArrayParameters($parameters, $sql); - $conn = $this->entityManager->getConnection(); $this->logger->debug('{s} | {p}', ['s' => $sql, 'p' => $parameters]); $this->logger->debug('Rewritten to: {s} | {p}', ['p' => $rewritten['parameters'], 's' => $rewritten['sql']]); - $numResults = null; - if ('test' !== $this->kernel->getEnvironment() && !$criteria->magazine && !$criteria->moderated && !$criteria->favourite && Criteria::TIME_ALL === $criteria->time && Criteria::AP_ALL === $criteria->federation && 'all' === $criteria->type) { - // pre-set the results to 1000 pages for queries not very limited by the parameters so the count query is not being executed - $numResults = 1000 * ($criteria->perPage ?? self::PER_PAGE); - } - $fanta = new Pagerfanta(new NativeQueryAdapter($conn, $rewritten['sql'], $rewritten['parameters'], numOfResults: $numResults, transformer: $this->contentPopulationTransformer, cache: $this->cache)); - $fanta->setMaxPerPage($criteria->perPage ?? self::PER_PAGE); - $fanta->setCurrentPage($criteria->page); - - return $fanta; - } - - /** - * @return int[] the ids of the users $user follows - * - * @throws InvalidArgumentException|Exception - */ - public function getCachedUserFollows(User $user): array - { - $sql = 'SELECT following_id FROM user_follow WHERE follower_id = :uId'; - if ('test' === $this->kernel->getEnvironment()) { - return $this->fetchSingleColumnAsArray($sql, $user); - } - - return $this->cache->get(self::USER_FOLLOWS_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { - return $this->fetchSingleColumnAsArray($sql, $user); - }); - } - - public function clearCachedUserFollows(User $user): void - { - $this->logger->debug('Clearing cached user follows for user {u}', ['u' => $user->username]); - try { - $this->cache->delete(self::USER_FOLLOWS_KEY.$user->getId()); - } catch (InvalidArgumentException $exception) { - $this->logger->warning('There was an error clearing the cached user follows of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); - } - } - - /** - * @return int[] the ids of the magazines $user is subscribed to - * - * @throws InvalidArgumentException|Exception - */ - public function getCachedUserSubscribedMagazines(User $user): array - { - $sql = 'SELECT magazine_id FROM magazine_subscription WHERE user_id = :uId'; - if ('test' === $this->kernel->getEnvironment()) { - return $this->fetchSingleColumnAsArray($sql, $user); - } - - return $this->cache->get(self::USER_MAGAZINE_SUBSCRIPTION_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { - return $this->fetchSingleColumnAsArray($sql, $user); - }); + return $rewritten; } - public function clearCachedUserSubscribedMagazines(User $user): void + private function getCursorFieldFromCriteria(Criteria $criteria): string { - $this->logger->debug('Clearing cached magazine subscriptions for user {u}', ['u' => $user->username]); - try { - $this->cache->delete(self::USER_MAGAZINE_SUBSCRIPTION_KEY.$user->getId()); - } catch (InvalidArgumentException $exception) { - $this->logger->warning('There was an error clearing the cached subscribed Magazines of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); - } + return match ($criteria->sortOption) { + Criteria::SORT_TOP => 'score', + Criteria::SORT_HOT => 'ranking', + Criteria::SORT_COMMENTED => 'commentCount', + Criteria::SORT_ACTIVE => 'lastActive', + default => 'createdAt', + }; } - /** - * @return int[] the ids of the magazines $user moderates - * - * @throws InvalidArgumentException|Exception - */ - public function getCachedUserModeratedMagazines(User $user): array + private function getCursorWhereFromCriteria(Criteria $criteria): string { - $sql = 'SELECT magazine_id FROM moderator WHERE user_id = :uId'; - if ('test' === $this->kernel->getEnvironment()) { - return $this->fetchSingleColumnAsArray($sql, $user); - } - - return $this->cache->get(self::USER_MAGAZINE_MODERATION_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { - return $this->fetchSingleColumnAsArray($sql, $user); - }); + return match ($criteria->sortOption) { + Criteria::SORT_TOP => 'score < :cursor', + Criteria::SORT_HOT => 'ranking < :cursor', + Criteria::SORT_COMMENTED => 'comment_count < :cursor', + Criteria::SORT_ACTIVE => 'last_active < :cursor', + Criteria::SORT_OLD => 'created_at > :cursor', + default => 'created_at < :cursor', + }; } - public function clearCachedUserModeratedMagazines(User $user): void + private function getCursorWhereInvertedFromCriteria(Criteria $criteria): string { - $this->logger->debug('Clearing cached moderated magazines for user {u}', ['u' => $user->username]); - try { - $this->cache->delete(self::USER_MAGAZINE_MODERATION_KEY.$user->getId()); - } catch (InvalidArgumentException $exception) { - $this->logger->warning('There was an error clearing the cached moderated magazines of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); - } + return match ($criteria->sortOption) { + Criteria::SORT_TOP => 'score >= :cursor', + Criteria::SORT_HOT => 'ranking >= :cursor', + Criteria::SORT_COMMENTED => 'comment_count >= :cursor', + Criteria::SORT_ACTIVE => 'last_active >= :cursor', + Criteria::SORT_OLD => 'created_at <= :cursor', + default => 'created_at >= :cursor', + }; } - /** - * @return int[] the ids of the domains $user is subscribed to - * - * @throws InvalidArgumentException|Exception - */ - public function getCachedUserSubscribedDomains(User $user): array + public function guessInitialCursor(Criteria $criteria): mixed { - $sql = 'SELECT domain_id FROM domain_subscription WHERE user_id = :uId'; - if ('test' === $this->kernel->getEnvironment()) { - return $this->fetchSingleColumnAsArray($sql, $user); - } - - return $this->cache->get(self::USER_DOMAIN_SUBSCRIPTION_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { - return $this->fetchSingleColumnAsArray($sql, $user); - }); + return match ($criteria->sortOption) { + Criteria::SORT_TOP, Criteria::SORT_HOT, Criteria::SORT_COMMENTED => 2147483647, // postgresql max int + Criteria::SORT_OLD => (new \DateTimeImmutable())->setTimestamp(0), + default => new \DateTimeImmutable('now + 1 minute'), + }; } - public function clearCachedUserSubscribedDomains(User $user): void + private function getOrderings(Criteria $criteria): array { - $this->logger->debug('Clearing cached domain subscriptions for user {u}', ['u' => $user->username]); - try { - $this->cache->delete(self::USER_DOMAIN_SUBSCRIPTION_KEY.$user->getId()); - } catch (InvalidArgumentException $exception) { - $this->logger->warning('There was an error clearing the cached subscribed domains of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); - } - } - - /** - * @return int[] the ids of the domains $user is subscribed to - * - * @throws InvalidArgumentException|Exception - */ - public function getCachedUserBlocks(User $user): array - { - $sql = 'SELECT blocked_id FROM user_block WHERE blocker_id = :uId'; - if ('test' === $this->kernel->getEnvironment()) { - return $this->fetchSingleColumnAsArray($sql, $user); - } - - return $this->cache->get(self::USER_BLOCKS_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { - return $this->fetchSingleColumnAsArray($sql, $user); - }); - } - - public function clearCachedUserBlocks(User $user): void - { - $this->logger->debug('Clearing cached user blocks for user {u}', ['u' => $user->username]); - try { - $this->cache->delete(self::USER_BLOCKS_KEY.$user->getId()); - } catch (InvalidArgumentException $exception) { - $this->logger->warning('There was an error clearing the cached blocked user of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); - } - } - - /** - * @return int[] the ids of the domains $user is subscribed to - * - * @throws InvalidArgumentException|Exception - */ - public function getCachedUserMagazineBlocks(User $user): array - { - $sql = 'SELECT magazine_id FROM magazine_block WHERE user_id = :uId'; - if ('test' === $this->kernel->getEnvironment()) { - return $this->fetchSingleColumnAsArray($sql, $user); - } - - return $this->cache->get(self::USER_MAGAZINE_BLOCKS_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { - return $this->fetchSingleColumnAsArray($sql, $user); - }); - } - - public function clearCachedUserMagazineBlocks(User $user): void - { - $this->logger->debug('Clearing cached magazine blocks for user {u}', ['u' => $user->username]); - try { - $this->cache->delete(self::USER_MAGAZINE_BLOCKS_KEY.$user->getId()); - } catch (InvalidArgumentException $exception) { - $this->logger->warning('There was an error clearing the cached blocked magazines of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); - } - } + $orderings = []; - /** - * @return int[] the ids of the domains $user is subscribed to - * - * @throws InvalidArgumentException|Exception - */ - public function getCachedUserDomainBlocks(User $user): array - { - $sql = 'SELECT domain_id FROM domain_block WHERE user_id = :uId'; - if ('test' === $this->kernel->getEnvironment()) { - return $this->fetchSingleColumnAsArray($sql, $user); + if ($criteria->stickiesFirst) { + $orderings[] = 'sticky DESC'; } - return $this->cache->get(self::USER_DOMAIN_BLOCKS_KEY.$user->getId(), function (ItemInterface $item) use ($user, $sql) { - return $this->fetchSingleColumnAsArray($sql, $user); - }); - } - - public function clearCachedUserDomainBlocks(User $user): void - { - $this->logger->debug('Clearing cached domain blocks for user {u}', ['u' => $user->username]); - try { - $this->cache->delete(self::USER_DOMAIN_BLOCKS_KEY.$user->getId()); - } catch (InvalidArgumentException $exception) { - $this->logger->warning('There was an error clearing the cached blocked domains of user "{u}": {m}', ['u' => $user->username, 'm' => $exception->getMessage()]); + switch ($criteria->sortOption) { + case Criteria::SORT_TOP: + $orderings[] = 'score DESC'; + break; + case Criteria::SORT_HOT: + $orderings[] = 'ranking DESC'; + break; + case Criteria::SORT_COMMENTED: + $orderings[] = 'comment_count DESC'; + break; + case Criteria::SORT_ACTIVE: + $orderings[] = 'last_active DESC'; + break; + default: } - } - /** - * @param string $sql the sql to fetch the single column, should contain a 'uId' Parameter - * - * @return int[] - * - * @throws Exception - */ - public function fetchSingleColumnAsArray(string $sql, User $user): array - { - $conn = $this->entityManager->getConnection(); - $stmt = $conn->prepare($sql); - $result = $stmt->executeQuery(['uId' => $user->getId()]); - $rows = $result->fetchAllAssociative(); - $result = []; - foreach ($rows as $row) { - $result[] = $row[array_key_first($row)]; + switch ($criteria->sortOption) { + case Criteria::SORT_OLD: + $orderings[] = 'created_at ASC'; + break; + case Criteria::SORT_NEW: + default: + $orderings[] = 'created_at DESC'; } - $this->logger->debug('Fetching single column row from {sql}: {res}', ['sql' => $sql, 'res' => $result]); - - return $result; + return $orderings; } } diff --git a/src/Twig/Components/CursorPaginationComponent.php b/src/Twig/Components/CursorPaginationComponent.php new file mode 100644 index 0000000000..7461e1de30 --- /dev/null +++ b/src/Twig/Components/CursorPaginationComponent.php @@ -0,0 +1,16 @@ +frontExtension->frontOptionsUrl( 'content', 'threads', $magazine instanceof Magazine ? 'front_magazine' : 'front', - ['name' => $magazine?->name, 'p' => null], + ['name' => $magazine?->name, 'p' => null, 'cursor' => null], ); } @@ -61,7 +61,7 @@ public function navbarCombinedUrl(?Magazine $magazine): string return $this->frontExtension->frontOptionsUrl( 'content', 'combined', $magazine instanceof Magazine ? 'front_magazine' : 'front', - ['name' => $magazine?->name, 'p' => null], + ['name' => $magazine?->name, 'p' => null, 'cursor' => null], ); } @@ -99,7 +99,7 @@ public function navbarPostsUrl(?Magazine $magazine): string return $this->frontExtension->frontOptionsUrl( 'content', 'microblog', $magazine instanceof Magazine ? 'front_magazine' : 'front', - ['name' => $magazine?->name, 'p' => null, 'type' => null], + ['name' => $magazine?->name, 'p' => null, 'cursor' => null, 'type' => null], ); } diff --git a/src/Twig/Runtime/UrlExtensionRuntime.php b/src/Twig/Runtime/UrlExtensionRuntime.php index d8ee916ee3..90e47c4db1 100644 --- a/src/Twig/Runtime/UrlExtensionRuntime.php +++ b/src/Twig/Runtime/UrlExtensionRuntime.php @@ -296,4 +296,14 @@ public function mentionUrl(string $username): string { return $this->mentionManager->getRoute([$username])[0]; } + + public function getCursorUrlValue(mixed $cursor): mixed + { + if ($cursor instanceof \DateTime || $cursor instanceof \DateTimeImmutable) { + return $cursor->format(DATE_ATOM); + // return $cursor->getTimestamp(); + } + + return $cursor; + } } diff --git a/src/Utils/SqlHelpers.php b/src/Utils/SqlHelpers.php index c23b178846..fd8d8f1c5c 100644 --- a/src/Utils/SqlHelpers.php +++ b/src/Utils/SqlHelpers.php @@ -7,6 +7,8 @@ use App\Entity\MagazineBlock; use App\Entity\User; use App\Entity\UserBlock; +use Doctrine\DBAL\ParameterType; +use Doctrine\DBAL\Types\Types; use Doctrine\ORM\EntityManagerInterface; class SqlHelpers @@ -44,7 +46,7 @@ public static function makeWhereString(array $whereClauses): string * which are not supported by sql directly. Keep in mind that postgresql has a limit of 65k parameters * and each one of the array values counts as one parameter (because it only works that way). * - * @return array{'sql': string, 'parameters': array}> + * @return array{sql: string, parameters: array}> */ public static function rewriteArrayParameters(array $parameters, string $sql): array { @@ -77,6 +79,23 @@ public static function rewriteArrayParameters(array $parameters, string $sql): a ]; } + public static function invertOrderings(array $orderings): array + { + $newOrderings = []; + foreach ($orderings as $ordering) { + if (str_contains($ordering, 'DESC')) { + $newOrderings[] = str_replace('DESC', 'ASC', $ordering); + } elseif (str_contains($ordering, 'ASC')) { + $newOrderings[] = str_replace('ASC', 'DESC', $ordering); + } else { + // neither ASC nor DESC means ASC + $newOrderings[] = $ordering.' DESC'; + } + } + + return $newOrderings; + } + public function getBlockedMagazinesDql(User $user): string { return $this->entityManager->createQueryBuilder() @@ -98,4 +117,17 @@ public function getBlockedUsersDql(User $user): string ->setParameter('user', $user) ->getDql(); } + + public static function getSqlType(mixed $value): mixed + { + if ($value instanceof \DateTimeImmutable) { + return Types::DATETIMETZ_IMMUTABLE; + } elseif ($value instanceof \DateTime) { + return Types::DATETIMETZ_MUTABLE; + } elseif (\is_int($value)) { + return Types::INTEGER; + } + + return ParameterType::STRING; + } } diff --git a/templates/components/cursor_pagination.html.twig b/templates/components/cursor_pagination.html.twig new file mode 100644 index 0000000000..817ec89e57 --- /dev/null +++ b/templates/components/cursor_pagination.html.twig @@ -0,0 +1,19 @@ +
+ {% if isForward is same as true %} + {% if pagination.haveToPaginate %} +
+ + {{ 'next'|trans|capitalize }} + +
+ {% endif %} + {% else %} + {% if pagination.hasPreviousPage() %} +
+ + {{ 'previous'|trans|capitalize }} + +
+ {% endif %} + {% endif %} +
diff --git a/templates/entry/_options.html.twig b/templates/entry/_options.html.twig index 0562dfe537..7df0c479fe 100644 --- a/templates/entry/_options.html.twig +++ b/templates/entry/_options.html.twig @@ -11,31 +11,31 @@
  • - {{ 'top'|trans }}
  • - {{ 'hot'|trans }}
  • - {{ 'newest'|trans }}
  • - {{ 'active'|trans }}
  • - {{ 'commented'|trans }} @@ -52,48 +52,48 @@
    • - {{ 'all_time'|trans }}
    • - {{ '3h'|trans }}
    • - {{ '6h'|trans }}
    • - {{ '12h'|trans }}
    • - {{ '1d'|trans }}
    • - {{ '1w'|trans }}
    • - {{ '1m'|trans }}
    • - {{ '1y'|trans }} @@ -124,27 +124,27 @@
      • - +   {{ 'all'|trans }}
      • - +   {{ 'links'|trans }}
      • - +   {{ 'threads'|trans }}
      • - +   {{ 'photos'|trans }}
      • - +   {{ 'videos'|trans }}
        • @@ -172,24 +172,24 @@
        • - +   {{ 'all'|trans }}
          • {% if not is_route_name_contains('_magazine') %}
        • - +   {{ 'subscribed'|trans }}
        • - +  {{ 'moderated'|trans }}
          • {% endif %}
        • - +   {{ 'favourites'|trans }}
          • @@ -217,18 +217,18 @@
          • - +   {{ 'all'|trans }}
          • - +   {{ 'local'|trans }}
            • {#
          • - +   {{ 'federated'|trans }}
            • diff --git a/templates/layout/_subject_list.html.twig b/templates/layout/_subject_list.html.twig index 5cc734af8b..e0f749ce4c 100644 --- a/templates/layout/_subject_list.html.twig +++ b/templates/layout/_subject_list.html.twig @@ -14,6 +14,22 @@ {% set postCommentAttributes = {} %} {% endif %} +{% if pagination is defined and pagination %} + {% if(pagination.hasPreviousPage is defined and pagination.hasPreviousPage) %} + {% if pagination.getCurrentCursor is defined and app.request.cookies.get(constant('App\\Controller\\User\\ThemeSettingsController::KBIN_GENERAL_INFINITE_SCROLL')) is not same as 'true' %} + {{ component('cursor_pagination', {'pagination': pagination, 'isForward': false}) }} + {% endif %} + {% endif %} +{% else %} + {% if(results.hasPreviousPage is defined and results.hasPreviousPage) %} + {% if results.getCurrentCursor is defined and app.request.cookies.get(constant('App\\Controller\\User\\ThemeSettingsController::KBIN_GENERAL_INFINITE_SCROLL')) is not same as 'true' %} + {% if results.getCurrentCursor is defined %} + {{ component('cursor_pagination', {'pagination': results, 'isForward': false}) }} + {% endif %} + {% endif %} + {% endif %} +{% endif %} + {% for subject in results %} {% include 'layout/_subject.html.twig' %} {% endfor %} @@ -26,12 +42,17 @@ {{ pagerfanta(pagination, null, {'pageParameter':'[p]'}) }} + {% elseif pagination.getCurrentCursor is defined %} + {{ component('cursor_pagination', {'pagination': pagination}) }} {% else %} {{ pagerfanta(pagination, null, {'pageParameter':'[p]'}) }} {% endif %} {% endif %} {% else %} {% if(results.haveToPaginate is defined and results.haveToPaginate) %} + {% if pagination.getCurrentCursor is defined %} + {{ component('cursor_pagination', {'pagination': results}) }} + {% endif %} {% if app.request.cookies.get(constant('App\\Controller\\User\\ThemeSettingsController::KBIN_GENERAL_INFINITE_SCROLL')) is same as 'true' %}
            {{ component('loader', {'data-infinite-scroll-target': 'loader'}) }} @@ -39,6 +60,8 @@ {{ pagerfanta(results, null, {'pageParameter':'[p]'}) }}
            + {% elseif results.getCurrentCursor is defined %} + {{ component('cursor_pagination', {'pagination': results}) }} {% else %} {{ pagerfanta(results, null, {'pageParameter':'[p]'}) }} {% endif %} diff --git a/tests/Functional/Controller/Entry/EntryFrontControllerTest.php b/tests/Functional/Controller/Entry/EntryFrontControllerTest.php index 62099aa55b..030c931b0d 100644 --- a/tests/Functional/Controller/Entry/EntryFrontControllerTest.php +++ b/tests/Functional/Controller/Entry/EntryFrontControllerTest.php @@ -330,16 +330,15 @@ public function testCustomDefaultSort(): void private function prepareEntries(): KernelBrowser { - $this->getEntryByTitle( + $older = $this->getEntryByTitle( 'test entry 1', 'https://kbin.pub', null, $this->getMagazineByName('kbin', $this->getUserByUsername('JaneDoe')), $this->getUserByUsername('JaneDoe') ); + $older->createdAt = new \DateTimeImmutable('now - 1 minute'); - // this is necessary so the second entry is guaranteed to be newer than the first - sleep(1); $this->getEntryByTitle('test entry 2', 'https://kbin.pub'); return $this->client; diff --git a/tests/Unit/CursorPaginationTest.php b/tests/Unit/CursorPaginationTest.php new file mode 100644 index 0000000000..c3cd4b5aa1 --- /dev/null +++ b/tests/Unit/CursorPaginationTest.php @@ -0,0 +1,129 @@ +entityManager->getConnection()->executeQuery($tempTable); + + for ($i = 0; $i < 10; ++$i) { + $this->entityManager->getConnection()->executeQuery("INSERT INTO cursorTest(value) VALUES($i)"); + } + + $sql = 'SELECT * FROM cursorTest WHERE %cursor% ORDER BY %cursorSort%'; + + $this->cursorPagination = new CursorPagination( + new NativeQueryCursorAdapter( + $this->entityManager->getConnection(), + $sql, + 'value > :cursor', + 'value <= :cursor', + 'value', + 'value DESC', + [], + ), + 'value', + 3 + ); + } + + public function testCursorPaginationInteger(): void + { + $this->cursorPagination->setCurrentPage(-1); + $currentPage = $this->cursorPagination->getCurrentPageResults(); + + $i = 0; + foreach ($currentPage as $result) { + self::assertEquals($i, $result['value']); + ++$i; + } + + self::assertTrue($this->cursorPagination->hasNextPage()); + self::assertFalse($this->cursorPagination->hasPreviousPage()); + + $this->cursorPagination->setCurrentPage($this->cursorPagination->getNextPage()); + $currentPage = $this->cursorPagination->getCurrentPageResults(); + + $i = 3; + foreach ($currentPage as $result) { + self::assertEquals($i, $result['value']); + ++$i; + } + + self::assertTrue($this->cursorPagination->hasNextPage()); + self::assertTrue($this->cursorPagination->hasPreviousPage()); + + $this->cursorPagination->setCurrentPage($this->cursorPagination->getNextPage()); + $currentPage = $this->cursorPagination->getCurrentPageResults(); + + $i = 6; + foreach ($currentPage as $result) { + self::assertEquals($i, $result['value']); + ++$i; + } + + self::assertTrue($this->cursorPagination->hasNextPage()); + self::assertTrue($this->cursorPagination->hasPreviousPage()); + + $this->cursorPagination->setCurrentPage($this->cursorPagination->getNextPage()); + $currentPage = $this->cursorPagination->getCurrentPageResults(); + + $i = 9; + foreach ($currentPage as $result) { + self::assertEquals($i, $result['value']); + ++$i; + } + + self::assertFalse($this->cursorPagination->hasNextPage()); + self::assertTrue($this->cursorPagination->hasPreviousPage()); + + $this->cursorPagination->setCurrentPage($this->cursorPagination->getPreviousPage()); + $currentPage = $this->cursorPagination->getCurrentPageResults(); + + $i = 6; + foreach ($currentPage as $result) { + self::assertEquals($i, $result['value']); + ++$i; + } + + self::assertTrue($this->cursorPagination->hasNextPage()); + self::assertTrue($this->cursorPagination->hasPreviousPage()); + + $this->cursorPagination->setCurrentPage($this->cursorPagination->getPreviousPage()); + $currentPage = $this->cursorPagination->getCurrentPageResults(); + + $i = 3; + foreach ($currentPage as $result) { + self::assertEquals($i, $result['value']); + ++$i; + } + + self::assertTrue($this->cursorPagination->hasNextPage()); + self::assertTrue($this->cursorPagination->hasPreviousPage()); + + $this->cursorPagination->setCurrentPage($this->cursorPagination->getPreviousPage()); + $currentPage = $this->cursorPagination->getCurrentPageResults(); + + $i = 0; + foreach ($currentPage as $result) { + self::assertEquals($i, $result['value']); + ++$i; + } + self::assertTrue($this->cursorPagination->hasNextPage()); + self::assertFalse($this->cursorPagination->hasPreviousPage()); + } +} From 4935148443c9c6ab52f558202aaaf4a6705c1566 Mon Sep 17 00:00:00 2001 From: BentiGorlich Date: Sun, 1 Feb 2026 14:33:12 +0100 Subject: [PATCH 2/6] Add support for infinite scroll --- .../controllers/infinite_scroll_controller.js | 17 +- src/Pagination/Cursor/CursorPagination.php | 4 +- .../components/cursor_pagination.html.twig | 10 +- templates/layout/_subject_list.html.twig | 9 +- translations/messages.en.yaml | 293 +++++++++--------- 5 files changed, 174 insertions(+), 159 deletions(-) diff --git a/assets/controllers/infinite_scroll_controller.js b/assets/controllers/infinite_scroll_controller.js index 344a3f2944..4eb14fcc28 100644 --- a/assets/controllers/infinite_scroll_controller.js +++ b/assets/controllers/infinite_scroll_controller.js @@ -22,9 +22,20 @@ export default class extends Controller { try { this.loadingValue = true; - const paginationElem = this.paginationTarget.getElementsByClassName('pagination__item--current-page')[0].nextElementSibling; - if (paginationElem.classList.contains('pagination__item--disabled')) { - throw new Error('No more pages'); + const cursorPaginationElement = this.paginationTarget.getElementsByClassName('cursor-pagination'); + let paginationElem = null; + if (cursorPaginationElement.length) { + console.log(cursorPaginationElement[0]); + let button = cursorPaginationElement[0].getElementsByTagName('a'); + if (!button.length) { + throw new Error('No more pages'); + } + paginationElem = button[0]; + } else { + paginationElem = this.paginationTarget.getElementsByClassName('pagination__item--current-page')[0].nextElementSibling; + if (paginationElem.classList.contains('pagination__item--disabled')) { + throw new Error('No more pages'); + } } if (window.infiniteScrollUrls.includes(paginationElem.href)) { diff --git a/src/Pagination/Cursor/CursorPagination.php b/src/Pagination/Cursor/CursorPagination.php index 3240c73ca3..ae58270bb4 100644 --- a/src/Pagination/Cursor/CursorPagination.php +++ b/src/Pagination/Cursor/CursorPagination.php @@ -89,12 +89,12 @@ public function getCurrentPageResults(): iterable public function haveToPaginate(): bool { - return $this->maxPerPage === \sizeof($this->currentPageResults ?? [...$this->getCurrentPageResults()]); + return $this->hasNextPage() || $this->hasPreviousPage(); } public function hasNextPage(): bool { - return $this->haveToPaginate(); + return $this->maxPerPage === \sizeof($this->currentPageResults ?? [...$this->getCurrentPageResults()]); } public function getNextPage(): mixed diff --git a/templates/components/cursor_pagination.html.twig b/templates/components/cursor_pagination.html.twig index 817ec89e57..421af5f482 100644 --- a/templates/components/cursor_pagination.html.twig +++ b/templates/components/cursor_pagination.html.twig @@ -1,12 +1,14 @@
            {% if isForward is same as true %} - {% if pagination.haveToPaginate %} -
            +
            + {% if pagination.hasNextPage() %} {{ 'next'|trans|capitalize }} -
            - {% endif %} + {% else %} + {{ 'reached_end'|trans }} + {% endif %} +
            {% else %} {% if pagination.hasPreviousPage() %}
            diff --git a/templates/layout/_subject_list.html.twig b/templates/layout/_subject_list.html.twig index e0f749ce4c..eae7c39ef3 100644 --- a/templates/layout/_subject_list.html.twig +++ b/templates/layout/_subject_list.html.twig @@ -50,14 +50,15 @@ {% endif %} {% else %} {% if(results.haveToPaginate is defined and results.haveToPaginate) %} - {% if pagination.getCurrentCursor is defined %} - {{ component('cursor_pagination', {'pagination': results}) }} - {% endif %} {% if app.request.cookies.get(constant('App\\Controller\\User\\ThemeSettingsController::KBIN_GENERAL_INFINITE_SCROLL')) is same as 'true' %}
            {{ component('loader', {'data-infinite-scroll-target': 'loader'}) }}
            {% elseif results.getCurrentCursor is defined %} diff --git a/translations/messages.en.yaml b/translations/messages.en.yaml index 27751678bb..066e693301 100644 --- a/translations/messages.en.yaml +++ b/translations/messages.en.yaml @@ -62,13 +62,13 @@ activity: Activity cover: Cover related_posts: Related posts random_posts: Random posts -federated_magazine_info: This magazine is from a federated server and may be +federated_magazine_info: This magazine is from a federated server and may be incomplete. -disconnected_magazine_info: This magazine is not receiving updates (last +disconnected_magazine_info: This magazine is not receiving updates (last activity %days% day(s) ago). always_disconnected_magazine_info: This magazine is not receiving updates. subscribe_for_updates: Subscribe to start receiving updates. -federated_user_info: This profile is from a federated server and may be +federated_user_info: This profile is from a federated server and may be incomplete. go_to_original_instance: View on remote instance empty: Empty @@ -92,7 +92,7 @@ from: from username: Username email: Email repeat_password: Repeat password -agree_terms: Consent to %terms_link_start%Terms and Conditions%terms_link_end% +agree_terms: Consent to %terms_link_start%Terms and Conditions%terms_link_end% and %policy_link_start%Privacy Policy%policy_link_end% terms: Terms of service privacy_policy: Privacy policy @@ -118,10 +118,10 @@ enabled: Enabled useful: Useful help: Help check_email: Check your email -reset_check_email_desc: If there is already an account associated with your - email address, you should receive an email shortly containing a link that you +reset_check_email_desc: If there is already an account associated with your + email address, you should receive an email shortly containing a link that you can use to reset your password. This link will expire in %expire%. -reset_check_email_desc2: If you don't receive an email please check your spam +reset_check_email_desc2: If you don't receive an email please check your spam folder. try_again: Try again up_vote: Boost @@ -217,7 +217,7 @@ notify_on_new_entry_reply: Any level comments in threads I authored notify_on_new_entry_comment_reply: Replies to my comments in any threads notify_on_new_post_reply: Any level replies to posts I authored notify_on_new_post_comment_reply: Replies to my comments on any posts -notify_on_new_entry: New threads (links or articles) in any magazine to which +notify_on_new_entry: New threads (links or articles) in any magazine to which I'm subscribed notify_on_new_posts: New posts in any magazine to which I'm subscribed notify_on_user_signup: New signups @@ -266,13 +266,13 @@ show_all: Show all flash_register_success: Welcome aboard! Your account is now registered. One last step - check your inbox for an activation link that will bring your account to life. -flash_thread_new_success: The thread has been created successfully and is now +flash_thread_new_success: The thread has been created successfully and is now visible to other users. flash_thread_edit_success: The thread has been successfully edited. flash_thread_delete_success: The thread has been successfully deleted. flash_thread_pin_success: The thread has been successfully pinned. flash_thread_unpin_success: The thread has been successfully unpinned. -flash_magazine_new_success: The magazine has been created successfully. You can +flash_magazine_new_success: The magazine has been created successfully. You can now add new content or explore the magazine's administration panel. flash_magazine_edit_success: The magazine has been successfully edited. flash_mark_as_adult_success: The post has been successfully marked as NSFW. @@ -280,9 +280,9 @@ flash_unmark_as_adult_success: The post has been successfully unmarked as NSFW. too_many_requests: Limit exceeded, please try again later. set_magazines_bar: Magazines bar set_magazines_bar_desc: add the magazine names after the comma -set_magazines_bar_empty_desc: if the field is empty, active magazines are +set_magazines_bar_empty_desc: if the field is empty, active magazines are displayed on the bar. -mod_log_alert: WARNING - The Modlog may contain unpleasant or distressing +mod_log_alert: WARNING - The Modlog may contain unpleasant or distressing content that has been removed by moderators. Please exercise caution. added_new_thread: Added a new thread edited_thread: Edited a thread @@ -327,10 +327,10 @@ approve: Approve ban: Ban unban: Unban ban_hashtag_btn: Ban Hashtag -ban_hashtag_description: Banning a hashtag will stop posts with this hashtag +ban_hashtag_description: Banning a hashtag will stop posts with this hashtag from being created, as well as hiding existing posts with this hashtag. unban_hashtag_btn: Unban Hashtag -unban_hashtag_description: Unbanning a hashtag will allow creating posts with +unban_hashtag_description: Unbanning a hashtag will allow creating posts with this hashtag again. Existing posts with this hashtag are no longer hidden. filters: Filters approved: Approved @@ -405,15 +405,15 @@ auto_preview: Auto media preview dynamic_lists: Dynamic lists banned_instances: Banned instances kbin_intro_title: Explore the Fediverse -kbin_intro_desc: is a decentralized platform for content aggregation and +kbin_intro_desc: is a decentralized platform for content aggregation and microblogging that operates within the Fediverse network. kbin_promo_title: Create your own instance kbin_promo_desc: '%link_start%Clone repo%link_end% and develop fediverse' captcha_enabled: Captcha enabled header_logo: Header logo -browsing_one_thread: You are only browsing one thread in the discussion! All +browsing_one_thread: You are only browsing one thread in the discussion! All comments are available on the post page. -viewing_one_signup_request: You are only viewing one signup request by +viewing_one_signup_request: You are only viewing one signup request by %username% return: Return boost: Boost @@ -421,7 +421,7 @@ mercure_enabled: Mercure enabled report_issue: Report issue tokyo_night: Tokyo Night preferred_languages: Filter languages of threads and posts -infinite_scroll_help: Automatically load more content when you reach the bottom +infinite_scroll_help: Automatically load more content when you reach the bottom of the page. sticky_navbar_help: The navbar will stick to the top of the page when you scroll down. @@ -448,12 +448,12 @@ bot_body_content: "Welcome to the Mbin Agent! This agent plays a crucial role in users, and engage in social interactions such as liking, sharing, and commenting on threads or posts." password_confirm_header: Confirm your password change request. -your_account_is_not_active: Your account has not been activated. Please check - your email for account activation instructions or request a new account activation email. your_account_has_been_banned: Your account has been banned -your_account_is_not_yet_approved: Your account has not been approved yet. We - will send you an email as soon as the admins have processed your signup +your_account_is_not_yet_approved: Your account has not been approved yet. We + will send you an email as soon as the admins have processed your signup request. toolbar.bold: Bold toolbar.italic: Italic @@ -472,21 +472,21 @@ federation_page_enabled: Federation page enabled federation_page_allowed_description: Known instances we federate with federation_page_disallowed_description: Instances we do not federate with federation_page_dead_title: Dead instances -federation_page_dead_description: Instances that we could not deliver at least +federation_page_dead_description: Instances that we could not deliver at least 10 activities in a row and where the last successful deliver and -receive were more than a week ago federated_search_only_loggedin: Federated search limited if not logged in account_deletion_title: Account deletion account_deletion_description: Your account will be deleted in 30 days unless you - choose to delete the account immediately. To restore your account within 30 + choose to delete the account immediately. To restore your account within 30 days, login with the same user credentials or contact an administrator. account_deletion_button: Delete Account account_deletion_immediate: Delete immediately more_from_domain: More from domain errors.server500.title: 500 Internal Server Error -errors.server500.description: Sorry, something went wrong on our end. If you - continue to see this error, try contacting the instance owner. If this - instance is not working at all, check out %link_start%other Mbin +errors.server500.description: Sorry, something went wrong on our end. If you + continue to see this error, try contacting the instance owner. If this + instance is not working at all, check out %link_start%other Mbin instances%link_end% in the meanwhile until the problem is resolved. errors.server429.title: 429 Too Many Requests errors.server404.title: 404 Not found @@ -499,97 +499,97 @@ email.delete.description: The following user has requested that their account be deleted resend_account_activation_email_question: Inactive account? resend_account_activation_email: Re-send account activation email -resend_account_activation_email_error: There was an issue submitting this - request. There may be no account associated with that email or perhaps it is +resend_account_activation_email_error: There was an issue submitting this + request. There may be no account associated with that email or perhaps it is already activated. -resend_account_activation_email_success: If an account associated with that +resend_account_activation_email_success: If an account associated with that email exists, we will send out a new activation email. -resend_account_activation_email_description: Enter the email address associated +resend_account_activation_email_description: Enter the email address associated with your account. We will send out another activation email for you. custom_css: Custom CSS ignore_magazines_custom_css: Ignore magazines custom CSS oauth.consent.title: OAuth2 Consent Form oauth.consent.grant_permissions: Grant Permissions -oauth.consent.app_requesting_permissions: would like to perform the following +oauth.consent.app_requesting_permissions: would like to perform the following actions on your behalf oauth.consent.app_has_permissions: can already perform the following actions -oauth.consent.to_allow_access: To allow this access, click the 'Allow' button +oauth.consent.to_allow_access: To allow this access, click the 'Allow' button below oauth.consent.allow: Allow oauth.consent.deny: Deny oauth.client_identifier.invalid: Invalid OAuth Client ID! -oauth.client_not_granted_message_read_permission: This app has not received +oauth.client_not_granted_message_read_permission: This app has not received permission to read your messages. restrict_oauth_clients: Restrict OAuth2 Client creation to Admins private_instance: Force users to login before they can access any content block: Block unblock: Unblock -oauth2.grant.moderate.magazine.ban.delete: Unban users in your moderated +oauth2.grant.moderate.magazine.ban.delete: Unban users in your moderated magazines. oauth2.grant.moderate.magazine.list: Read a list of your moderated magazines. -oauth2.grant.moderate.magazine.reports.all: Manage reports in your moderated +oauth2.grant.moderate.magazine.reports.all: Manage reports in your moderated magazines. -oauth2.grant.moderate.magazine.reports.read: Read reports in your moderated +oauth2.grant.moderate.magazine.reports.read: Read reports in your moderated magazines. -oauth2.grant.moderate.magazine.reports.action: Accept or reject reports in your +oauth2.grant.moderate.magazine.reports.action: Accept or reject reports in your moderated magazines. -oauth2.grant.moderate.magazine.trash.read: View trashed content in your +oauth2.grant.moderate.magazine.trash.read: View trashed content in your moderated magazines. -oauth2.grant.moderate.magazine_admin.all: Create, edit, or delete your owned +oauth2.grant.moderate.magazine_admin.all: Create, edit, or delete your owned magazines. oauth2.grant.moderate.magazine_admin.create: Create new magazines. oauth2.grant.moderate.magazine_admin.delete: Delete any of your owned magazines. -oauth2.grant.moderate.magazine_admin.update: Edit any of your owned magazines' +oauth2.grant.moderate.magazine_admin.update: Edit any of your owned magazines' rules, description, NSFW status, or icon. -oauth2.grant.moderate.magazine_admin.edit_theme: Edit the custom CSS of any of +oauth2.grant.moderate.magazine_admin.edit_theme: Edit the custom CSS of any of your owned magazines. oauth2.grant.moderate.magazine_admin.moderators: Add or remove moderators of any of your owned magazines. -oauth2.grant.moderate.magazine_admin.badges: Create or remove badges from your +oauth2.grant.moderate.magazine_admin.badges: Create or remove badges from your owned magazines. oauth2.grant.moderate.magazine_admin.tags: Create or remove tags from your owned magazines. -oauth2.grant.moderate.magazine_admin.stats: View the content, vote, and view +oauth2.grant.moderate.magazine_admin.stats: View the content, vote, and view stats of your owned magazines. oauth2.grant.admin.all: Perform any administrative action on your instance. oauth2.grant.admin.entry.purge: Completely delete any thread from your instance. oauth2.grant.read.general: Read all content you have access to. -oauth2.grant.write.general: Create or edit any of your threads, posts, or +oauth2.grant.write.general: Create or edit any of your threads, posts, or comments. oauth2.grant.delete.general: Delete any of your threads, posts, or comments. oauth2.grant.report.general: Report threads, posts, or comments. -oauth2.grant.vote.general: Upvote, downvote, or boost threads, posts, or +oauth2.grant.vote.general: Upvote, downvote, or boost threads, posts, or comments. -oauth2.grant.subscribe.general: Subscribe or follow any magazine, domain, or +oauth2.grant.subscribe.general: Subscribe or follow any magazine, domain, or user, and view the magazines, domains, and users you subscribe to. -oauth2.grant.block.general: Block or unblock any magazine, domain, or user, and +oauth2.grant.block.general: Block or unblock any magazine, domain, or user, and view the magazines, domains, and users you have blocked. oauth2.grant.domain.all: Subscribe to or block domains, and view the domains you subscribe to or block. -oauth2.grant.domain.subscribe: Subscribe or unsubscribe to domains and view the +oauth2.grant.domain.subscribe: Subscribe or unsubscribe to domains and view the domains you subscribe to. -oauth2.grant.domain.block: Block or unblock domains and view the domains you +oauth2.grant.domain.block: Block or unblock domains and view the domains you have blocked. -oauth2.grant.entry.all: Create, edit, or delete your threads, and vote, boost, +oauth2.grant.entry.all: Create, edit, or delete your threads, and vote, boost, or report any thread. oauth2.grant.entry.create: Create new threads. oauth2.grant.entry.edit: Edit your existing threads. oauth2.grant.entry.delete: Delete your existing threads. oauth2.grant.entry.vote: Upvote, boost, or downvote any thread. oauth2.grant.entry.report: Report any thread. -oauth2.grant.entry_comment.all: Create, edit, or delete your comments in +oauth2.grant.entry_comment.all: Create, edit, or delete your comments in threads, and vote, boost, or report any comment in a thread. oauth2.grant.entry_comment.create: Create new comments in threads. oauth2.grant.entry_comment.edit: Edit your existing comments in threads. oauth2.grant.entry_comment.delete: Delete your existing comments in threads. -oauth2.grant.entry_comment.vote: Upvote, boost, or downvote any comment in a +oauth2.grant.entry_comment.vote: Upvote, boost, or downvote any comment in a thread. oauth2.grant.entry_comment.report: Report any comment in a thread. -oauth2.grant.magazine.all: Subscribe to or block magazines, and view the +oauth2.grant.magazine.all: Subscribe to or block magazines, and view the magazines you subscribe to or block. -oauth2.grant.magazine.subscribe: Subscribe or unsubscribe to magazines and view +oauth2.grant.magazine.subscribe: Subscribe or unsubscribe to magazines and view the magazines you subscribe to. -oauth2.grant.magazine.block: Block or unblock magazines and view the magazines +oauth2.grant.magazine.block: Block or unblock magazines and view the magazines you have blocked. oauth2.grant.post.all: Create, edit, or delete your microblogs, and vote, boost, or report any microblog. @@ -598,16 +598,16 @@ oauth2.grant.post.edit: Edit your existing posts. oauth2.grant.post.delete: Delete your existing posts. oauth2.grant.post.vote: Upvote, boost, or downvote any post. oauth2.grant.post.report: Report any post. -oauth2.grant.post_comment.all: Create, edit, or delete your comments on posts, +oauth2.grant.post_comment.all: Create, edit, or delete your comments on posts, and vote, boost, or report any comment on a post. oauth2.grant.post_comment.create: Create new comments on posts. oauth2.grant.post_comment.edit: Edit your existing comments on posts. oauth2.grant.post_comment.delete: Delete your existing comments on posts. -oauth2.grant.post_comment.vote: Upvote, boost, or downvote any comment on a +oauth2.grant.post_comment.vote: Upvote, boost, or downvote any comment on a post. oauth2.grant.post_comment.report: Report any comment on a post. -oauth2.grant.user.all: Read and edit your profile, messages, or notifications; - Read and edit permissions you've granted other apps; follow or block other +oauth2.grant.user.all: Read and edit your profile, messages, or notifications; + Read and edit permissions you've granted other apps; follow or block other users; view lists of users you follow or block. oauth2.grant.user.bookmark: Add and remove bookmarks oauth2.grant.user.bookmark.add: Add bookmarks @@ -619,44 +619,44 @@ oauth2.grant.user.bookmark_list.delete: Delete your bookmark lists oauth2.grant.user.profile.all: Read and edit your profile. oauth2.grant.user.profile.read: Read your profile. oauth2.grant.user.profile.edit: Edit your profile. -oauth2.grant.user.message.all: Read your messages and send messages to other +oauth2.grant.user.message.all: Read your messages and send messages to other users. oauth2.grant.user.message.read: Read your messages. oauth2.grant.user.message.create: Send messages to other users. oauth2.grant.user.notification.all: Read and clear your notifications. -oauth2.grant.user.notification.read: Read your notifications, including message +oauth2.grant.user.notification.read: Read your notifications, including message notifications. oauth2.grant.user.notification.delete: Clear your notifications. -oauth2.grant.user.oauth_clients.all: Read and edit the permissions you have +oauth2.grant.user.oauth_clients.all: Read and edit the permissions you have granted to other OAuth2 applications. -oauth2.grant.user.oauth_clients.read: Read the permissions you have granted to +oauth2.grant.user.oauth_clients.read: Read the permissions you have granted to other OAuth2 applications. -oauth2.grant.user.oauth_clients.edit: Edit the permissions you have granted to +oauth2.grant.user.oauth_clients.edit: Edit the permissions you have granted to other OAuth2 applications. oauth2.grant.user.follow: Follow or unfollow users, and read a list of users you follow. -oauth2.grant.user.block: Block or unblock users, and read a list of users you +oauth2.grant.user.block: Block or unblock users, and read a list of users you block. -oauth2.grant.moderate.all: Perform any moderation action you have permission to +oauth2.grant.moderate.all: Perform any moderation action you have permission to perform in your moderated magazines. oauth2.grant.moderate.entry.all: Moderate threads in your moderated magazines. -oauth2.grant.moderate.entry.change_language: Change the language of threads in +oauth2.grant.moderate.entry.change_language: Change the language of threads in your moderated magazines. -oauth2.grant.moderate.entry.pin: Pin threads to the top of your moderated +oauth2.grant.moderate.entry.pin: Pin threads to the top of your moderated magazines. oauth2.grant.moderate.entry.lock: Lock threads in your moderated magazines, so no one can comment on it oauth2.grant.moderate.entry.set_adult: Mark threads as NSFW in your moderated magazines. -oauth2.grant.moderate.entry.trash: Trash or restore threads in your moderated +oauth2.grant.moderate.entry.trash: Trash or restore threads in your moderated magazines. -oauth2.grant.moderate.entry_comment.all: Moderate comments in threads in your +oauth2.grant.moderate.entry_comment.all: Moderate comments in threads in your moderated magazines. -oauth2.grant.moderate.entry_comment.change_language: Change the language of +oauth2.grant.moderate.entry_comment.change_language: Change the language of comments in threads in your moderated magazines. -oauth2.grant.moderate.entry_comment.set_adult: Mark comments in threads as NSFW +oauth2.grant.moderate.entry_comment.set_adult: Mark comments in threads as NSFW in your moderated magazines. -oauth2.grant.moderate.entry_comment.trash: Trash or restore comments in threads +oauth2.grant.moderate.entry_comment.trash: Trash or restore comments in threads in your moderated magazines. oauth2.grant.moderate.post.all: Moderate posts in your moderated magazines. oauth2.grant.moderate.post.change_language: Change the language of posts in your @@ -665,57 +665,57 @@ oauth2.grant.moderate.post.lock: Lock microblogs in your moderated magazines, so no one can comment on it oauth2.grant.moderate.post.set_adult: Mark posts as NSFW in your moderated magazines. -oauth2.grant.moderate.post.trash: Trash or restore posts in your moderated +oauth2.grant.moderate.post.trash: Trash or restore posts in your moderated magazines. -oauth2.grant.moderate.post_comment.all: Moderate comments on posts in your +oauth2.grant.moderate.post_comment.all: Moderate comments on posts in your moderated magazines. -oauth2.grant.moderate.post_comment.change_language: Change the language of +oauth2.grant.moderate.post_comment.change_language: Change the language of comments on posts in your moderated magazines. -oauth2.grant.moderate.post_comment.set_adult: Mark comments on posts as NSFW in +oauth2.grant.moderate.post_comment.set_adult: Mark comments on posts as NSFW in your moderated magazines. -oauth2.grant.moderate.post_comment.trash: Trash or restore comments on posts in +oauth2.grant.moderate.post_comment.trash: Trash or restore comments on posts in your moderated magazines. oauth2.grant.moderate.magazine.all: Manage bans, reports, and view trashed items in your moderated magazines. -oauth2.grant.moderate.magazine.ban.all: Manage banned users in your moderated +oauth2.grant.moderate.magazine.ban.all: Manage banned users in your moderated magazines. -oauth2.grant.moderate.magazine.ban.read: View banned users in your moderated +oauth2.grant.moderate.magazine.ban.read: View banned users in your moderated magazines. -oauth2.grant.moderate.magazine.ban.create: Ban users in your moderated +oauth2.grant.moderate.magazine.ban.create: Ban users in your moderated magazines. -oauth2.grant.admin.entry_comment.purge: Completely delete any comment in a +oauth2.grant.admin.entry_comment.purge: Completely delete any comment in a thread from your instance. oauth2.grant.admin.post.purge: Completely delete any post from your instance. -oauth2.grant.admin.post_comment.purge: Completely delete any comment on a post +oauth2.grant.admin.post_comment.purge: Completely delete any comment on a post from your instance. -oauth2.grant.admin.magazine.all: Move threads between or completely delete +oauth2.grant.admin.magazine.all: Move threads between or completely delete magazines on your instance. -oauth2.grant.admin.magazine.move_entry: Move threads between magazines on your +oauth2.grant.admin.magazine.move_entry: Move threads between magazines on your instance. oauth2.grant.admin.magazine.purge: Completely delete magazines on your instance. -oauth2.grant.admin.user.all: Ban, verify, or completely delete users on your +oauth2.grant.admin.user.all: Ban, verify, or completely delete users on your instance. oauth2.grant.admin.user.ban: Ban or unban users from your instance. oauth2.grant.admin.user.verify: Verify users on your instance. oauth2.grant.admin.user.delete: Delete users from your instance. oauth2.grant.admin.user.purge: Completely delete users from your instance. -oauth2.grant.admin.instance.all: View and update instance settings or +oauth2.grant.admin.instance.all: View and update instance settings or information. oauth2.grant.admin.instance.stats: View your instance's stats. -oauth2.grant.admin.instance.settings.all: View or update settings on your +oauth2.grant.admin.instance.settings.all: View or update settings on your instance. oauth2.grant.admin.instance.settings.read: View settings on your instance. oauth2.grant.admin.instance.settings.edit: Update settings on your instance. -oauth2.grant.admin.instance.information.edit: Update the About, FAQ, Contact, +oauth2.grant.admin.instance.information.edit: Update the About, FAQ, Contact, Terms of Service, and Privacy Policy pages on your instance. -oauth2.grant.admin.federation.all: View and update currently defederated +oauth2.grant.admin.federation.all: View and update currently defederated instances. oauth2.grant.admin.federation.read: View the list of defederated instances. -oauth2.grant.admin.federation.update: Add or remove instances to or from the +oauth2.grant.admin.federation.update: Add or remove instances to or from the list of defederated instances. -oauth2.grant.admin.oauth_clients.all: View or revoke OAuth2 clients that exist +oauth2.grant.admin.oauth_clients.all: View or revoke OAuth2 clients that exist on your instance. -oauth2.grant.admin.oauth_clients.read: View the OAuth2 clients that exist on +oauth2.grant.admin.oauth_clients.read: View the OAuth2 clients that exist on your instance, and their usage stats. oauth2.grant.admin.oauth_clients.revoke: Revoke access to OAuth2 clients on your instance. @@ -728,14 +728,14 @@ comment_reply_position_help: Display the comment reply form either at the top or show_avatars_on_comments: Show Comment Avatars single_settings: Single update_comment: Update comment -show_avatars_on_comments_help: Display/hide user avatars when viewing comments +show_avatars_on_comments_help: Display/hide user avatars when viewing comments on a single thread or post. comment_reply_position: Comment reply position -magazine_theme_appearance_custom_css: Custom CSS that will apply when viewing +magazine_theme_appearance_custom_css: Custom CSS that will apply when viewing content within your magazine. magazine_theme_appearance_icon: Custom icon for the magazine. -magazine_theme_appearance_banner: Custom banner for the magazine. It is - displayed above all threads and should be in a wide aspect ratio (5:1, or +magazine_theme_appearance_banner: Custom banner for the magazine. It is + displayed above all threads and should be in a wide aspect ratio (5:1, or 1500px * 300px). magazine_theme_appearance_background_image: Custom background image that will be applied when viewing content within your magazine. @@ -743,28 +743,28 @@ moderation.report.approve_report_title: Approve Report moderation.report.reject_report_title: Reject Report moderation.report.ban_user_description: Do you want to ban the user (%username%) who created this content from this magazine? -moderation.report.approve_report_confirmation: Are you sure that you want to +moderation.report.approve_report_confirmation: Are you sure that you want to approve this report? subject_reported_exists: This content has already been reported. moderation.report.ban_user_title: Ban User -moderation.report.reject_report_confirmation: Are you sure that you want to +moderation.report.reject_report_confirmation: Are you sure that you want to reject this report? -oauth2.grant.moderate.post.pin: Pin posts to the top of your moderated +oauth2.grant.moderate.post.pin: Pin posts to the top of your moderated magazines. delete_content: Delete content purge_content: Purge content -delete_content_desc: Delete the user's content while leaving the responses of +delete_content_desc: Delete the user's content while leaving the responses of other users in the created threads, posts and comments. -purge_content_desc: Completely purge the user's content, including deleting the +purge_content_desc: Completely purge the user's content, including deleting the responses of other users in created threads, posts and comments. -delete_account_desc: Delete the account, including the responses of other users +delete_account_desc: Delete the account, including the responses of other users in created threads, posts and comments. schedule_delete_account: Schedule Deletion -schedule_delete_account_desc: Schedule the deletion of this account in 30 days. - This will hide the user and their content as well as prevent the user from +schedule_delete_account_desc: Schedule the deletion of this account in 30 days. + This will hide the user and their content as well as prevent the user from logging in. remove_schedule_delete_account: Remove Scheduled Deletion -remove_schedule_delete_account_desc: Remove the scheduled deletion. All the +remove_schedule_delete_account_desc: Remove the scheduled deletion. All the content will be available again and the user will be able to login. two_factor_authentication: Two-factor authentication two_factor_backup: Two-factor authentication backup codes @@ -781,24 +781,24 @@ two_factor_backup: Two-factor authentication backup codes 2fa.remove: Remove 2FA 2fa.add: Add to my account 2fa.verify_authentication_code.label: Enter a two-factor code to verify setup -2fa.qr_code_img.alt: A QR code that allows the setup of two-factor +2fa.qr_code_img.alt: A QR code that allows the setup of two-factor authentication for your account -2fa.qr_code_link.title: Visiting this link may allow your platform to register +2fa.qr_code_link.title: Visiting this link may allow your platform to register this two-factor authentication 2fa.user_active_tfa.title: User has active 2FA -2fa.available_apps: Use a two-factor authentication app such as - %google_authenticator%, %aegis% (Android) or %raivo% (iOS) to scan the +2fa.available_apps: Use a two-factor authentication app such as + %google_authenticator%, %aegis% (Android) or %raivo% (iOS) to scan the QR-code. -2fa.backup_codes.help: You can use these codes when you don't have your - two-factor authentication device or app. You will not be shown them - again and will be able to use each of them only +2fa.backup_codes.help: You can use these codes when you don't have your + two-factor authentication device or app. You will not be shown them + again and will be able to use each of them only once. -2fa.backup_codes.recommendation: It is recommended that you keep a copy of them +2fa.backup_codes.recommendation: It is recommended that you keep a copy of them in a safe place. 2fa.manual_code_hint: If you cannot scan the QR code, enter the secret manually cancel: Cancel password_and_2fa: Password & 2FA -flash_account_settings_changed: Your account settings have been successfully +flash_account_settings_changed: Your account settings have been successfully changed. You will need to login again. show_subscriptions: Show subscriptions subscription_sort: Sort @@ -815,17 +815,17 @@ position_bottom: Bottom position_top: Top pending: Pending flash_thread_new_error: Thread could not be created. Something went wrong. -flash_thread_tag_banned_error: Thread could not be created. The content is not +flash_thread_tag_banned_error: Thread could not be created. The content is not allowed. -flash_thread_ref_image_not_found: The image referenced by 'imageHash' could not +flash_thread_ref_image_not_found: The image referenced by 'imageHash' could not be found. -flash_image_download_too_large_error: Image could not be created, it is too big +flash_image_download_too_large_error: Image could not be created, it is too big (max size %bytes%) flash_email_was_sent: Email has been successfully sent. flash_email_failed_to_sent: Email could not be sent. flash_post_new_success: Post has been successfully created. flash_post_new_error: Post could not be created. Something went wrong. -flash_magazine_theme_changed_success: Successfully updated the magazine +flash_magazine_theme_changed_success: Successfully updated the magazine appearance. flash_magazine_theme_changed_error: Failed to update the magazine appearance. flash_comment_new_success: Comment has been successfully created. @@ -851,20 +851,20 @@ open_url_to_fediverse: Open original URL change_my_avatar: Change my avatar change_my_cover: Change my cover edit_my_profile: Edit my profile -account_settings_changed: Your account settings have been successfully changed. +account_settings_changed: Your account settings have been successfully changed. You will need to login again. magazine_deletion: Magazine deletion delete_magazine: Delete magazine restore_magazine: Restore magazine purge_magazine: Purge magazine -magazine_is_deleted: Magazine is deleted. You can restore it within 30 days. suspend_account: Suspend account unsuspend_account: Unsuspend account account_suspended: The account has been suspended. account_unsuspended: The account has been unsuspended. deletion: Deletion -user_suspend_desc: Suspending your account hides your content on the instance, +user_suspend_desc: Suspending your account hides your content on the instance, but doesn't permanently remove it, and you can restore it at any time. account_banned: The account has been banned. account_unbanned: The account has been unbanned. @@ -899,11 +899,11 @@ show: Show hide: Hide edited: edited sso_registrations_enabled: SSO registrations enabled -sso_registrations_enabled.error: New account registrations with third-party +sso_registrations_enabled.error: New account registrations with third-party identity managers are currently disabled. sso_only_mode: Restrict login and registration to SSO methods only related_entry: Related -restrict_magazine_creation: Restrict local magazine creation to admins and +restrict_magazine_creation: Restrict local magazine creation to admins and global mods sso_show_first: Show SSO first on login and registration pages continue_with: Continue with @@ -946,16 +946,16 @@ notification_title_removed_post: A post was removed notification_title_edited_post: A post was edited notification_title_new_signup: A new user registered notification_body_new_signup: The user %u% registered. -notification_body2_new_signup_approval: You need to approve the request before +notification_body2_new_signup_approval: You need to approve the request before they can log in show_related_magazines: Show random magazines show_related_entries: Show random threads show_related_posts: Show random posts show_active_users: Show active users notification_title_new_report: A new report was created -magazine_posting_restricted_to_mods_warning: Only mods can create threads in +magazine_posting_restricted_to_mods_warning: Only mods can create threads in this magazine -flash_posting_restricted_error: Creating threads is restricted to mods in this +flash_posting_restricted_error: Creating threads is restricted to mods in this magazine and you are not one server_software: Server software version: Version @@ -964,7 +964,7 @@ last_successful_receive: Last successful receive last_failed_contact: Last failed contact magazine_posting_restricted_to_mods: Restrict thread creation to moderators new_user_description: This user is new (active for less than %days% days) -new_magazine_description: This magazine is new (active for less than %days% +new_magazine_description: This magazine is new (active for less than %days% days) admin_users_active: Active admin_users_inactive: Inactive @@ -999,22 +999,22 @@ search_type_user: Users search_type_actors: Magazines + Users search_type_content: Threads + Microblogs select_user: Choose a user -new_users_need_approval: New users have to be approved by an admin before they +new_users_need_approval: New users have to be approved by an admin before they can log in. signup_requests: Signup requests application_text: Explain why you want to join signup_requests_header: Signup Requests -signup_requests_paragraph: These users would like to join your server. They +signup_requests_paragraph: These users would like to join your server. They cannot log in until you've approved their signup request. -flash_application_info: An admin needs to approve your account before you can +flash_application_info: An admin needs to approve your account before you can log in. You will receive an email once your signup request has been processed. email_application_approved_title: Your signup request has been approved -email_application_approved_body: Your signup request was approved by the server +email_application_approved_body: Your signup request was approved by the server admin. You can now log into the server at %siteName%. email_application_rejected_title: Your signup request has been rejected -email_application_rejected_body: Thank you for your interest, but we regret to +email_application_rejected_body: Thank you for your interest, but we regret to inform you that your signup request has been declined. -email_application_pending: Your account requires admin approval before you can +email_application_pending: Your account requires admin approval before you can log in. email_verification_pending: You have to verify your email address before you can log in. @@ -1031,22 +1031,22 @@ compact_view_help: A compact view with less margins, where the media is moved to show_users_avatars_help: Display the user avatar image. show_magazines_icons_help: Display the magazine icon. show_thumbnails_help: Show the thumbnail images. -image_lightbox_in_list_help: When checked, clicking the thumbnail shows a modal +image_lightbox_in_list_help: When checked, clicking the thumbnail shows a modal image box window. When unchecked, clicking the thumbnail will open the thread. show_new_icons: Show new icons show_new_icons_help: Show icon for new magazine/user (30 days old or newer) -magazine_instance_defederated_info: The instance of this magazine is +magazine_instance_defederated_info: The instance of this magazine is defederated. The magazine will therefore not receive updates. user_instance_defederated_info: The instance of this user is defederated. flash_thread_instance_banned: The instance of this magazine is banned. show_rich_mention: Rich mentions -show_rich_mention_help: Render a user component when a user is mentioned. This +show_rich_mention_help: Render a user component when a user is mentioned. This will include their display name and profile picture. show_rich_mention_magazine: Rich magazine mentions -show_rich_mention_magazine_help: Render a magazine component when a magazine is +show_rich_mention_magazine_help: Render a magazine component when a magazine is mentioned. This will include their display name and icon. show_rich_ap_link: Rich AP links -show_rich_ap_link_help: Render an inline component when other ActivityPub +show_rich_ap_link_help: Render an inline component when other ActivityPub content is linked to. attitude: Attitude type_search_magazine: Limit search to magazine... @@ -1071,17 +1071,17 @@ direct_message_setting_label: Who can send you a direct message delete_magazine_icon: Delete magazine icon flash_magazine_theme_icon_detached_success: Magazine icon deleted successfully delete_magazine_banner: Delete magazine banner -flash_magazine_theme_banner_detached_success: Magazine banner deleted +flash_magazine_theme_banner_detached_success: Magazine banner deleted successfully federation_uses_allowlist: Use allowlist for federation defederating_instance: Defederating instance %i -their_user_follows: Amount of users from their instance following users on our +their_user_follows: Amount of users from their instance following users on our instance -our_user_follows: Amount of users from our instance following users on their +our_user_follows: Amount of users from our instance following users on their instance -their_magazine_subscriptions: Amount of users from their instance subscribed to +their_magazine_subscriptions: Amount of users from their instance subscribed to magazines on our instance -our_magazine_subscriptions: Amount of users on our instance subscribed to +our_magazine_subscriptions: Amount of users on our instance subscribed to magazines from their instance confirm_defederation: Confirm defederation flash_error_defederation_must_confirm: You have to confirm the defederation @@ -1091,7 +1091,7 @@ btn_allow: Allow ban_instance: Ban instance allow_instance: Allow instance federation_page_use_allowlist_help: If an allow list is used, this instance will - only federate with the explicitly allowed instances. Otherwise this instance + only federate with the explicitly allowed instances. Otherwise this instance will federate with every instance, except those that are banned. you_have_been_banned_from_magazine: You have been banned from magazine %m. you_have_been_banned_from_magazine_permanently: You have been permanently banned from magazine %m. @@ -1142,3 +1142,4 @@ magazine_name_as_tag_help: The tags of a magazine are used to match microblog po containing "#fediverse" will be put in this magazine. magazine_rules_deprecated: the rules field is deprecated and will be removed in the future. Please put your rules in the description box. +reached_end: You've reached the end From 5fea78f78ba071078b7aa1da76caf1a169d2ca5c Mon Sep 17 00:00:00 2001 From: BentiGorlich Date: Sun, 1 Feb 2026 14:34:01 +0100 Subject: [PATCH 3/6] Add translations --- templates/components/cursor_pagination.html.twig | 4 ++-- translations/messages.en.yaml | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/templates/components/cursor_pagination.html.twig b/templates/components/cursor_pagination.html.twig index 421af5f482..565f0e71d7 100644 --- a/templates/components/cursor_pagination.html.twig +++ b/templates/components/cursor_pagination.html.twig @@ -3,7 +3,7 @@
            {% if pagination.hasNextPage() %} - {{ 'next'|trans|capitalize }} + {{ 'next_page'|trans|capitalize }} {% else %} {{ 'reached_end'|trans }} @@ -13,7 +13,7 @@ {% if pagination.hasPreviousPage() %}
            - {{ 'previous'|trans|capitalize }} + {{ 'previous_page'|trans|capitalize }}
            {% endif %} diff --git a/translations/messages.en.yaml b/translations/messages.en.yaml index 066e693301..8e4f81da9e 100644 --- a/translations/messages.en.yaml +++ b/translations/messages.en.yaml @@ -1143,3 +1143,5 @@ magazine_name_as_tag_help: The tags of a magazine are used to match microblog po magazine_rules_deprecated: the rules field is deprecated and will be removed in the future. Please put your rules in the description box. reached_end: You've reached the end +next_page: Next page +previous_page: Previous page From 8cdbb45ce7e6ff3e5d6253da3327e509c8e05507 Mon Sep 17 00:00:00 2001 From: BentiGorlich Date: Sun, 1 Feb 2026 15:57:21 +0100 Subject: [PATCH 4/6] Add API endpoint - add API endpoint to retrieve content using the cursor pagination - add tests for the `CombinedRetrieveApi` - make `CombinedRetrieveApi` actually returning combined content --- config/mbin_routes/combined_api.yaml | 14 + src/Controller/Api/BaseApi.php | 10 + .../Api/Combined/CombinedRetrieveApi.php | 278 +++++++++++++++++- src/Schema/CursorPaginationSchema.php | 48 +++ src/Twig/Runtime/UrlExtensionRuntime.php | 1 - .../Api/Combined/CombinedRetrieveApiTest.php | 93 ++++++ tests/WebTestCase.php | 1 + 7 files changed, 431 insertions(+), 14 deletions(-) create mode 100644 src/Schema/CursorPaginationSchema.php create mode 100644 tests/Functional/Controller/Api/Combined/CombinedRetrieveApiTest.php diff --git a/config/mbin_routes/combined_api.yaml b/config/mbin_routes/combined_api.yaml index 00a93e0780..940e09a882 100644 --- a/config/mbin_routes/combined_api.yaml +++ b/config/mbin_routes/combined_api.yaml @@ -1,3 +1,17 @@ +api_combined_cursor: + controller: App\Controller\Api\Combined\CombinedRetrieveApi::cursorCollection + path: /api/combined/2.0 + methods: [ GET ] + format: json + +api_combined_user_cursor: + controller: App\Controller\Api\Combined\CombinedRetrieveApi::cursorUserCollection + path: /api/combined/2.0/{contentType} + requirements: + contentType: subscribed|moderated|favourited + methods: [ PUT ] + format: json + api_combined: controller: App\Controller\Api\Combined\CombinedRetrieveApi::collection path: /api/combined diff --git a/src/Controller/Api/BaseApi.php b/src/Controller/Api/BaseApi.php index 7aa2ca905f..31a6ac0b55 100644 --- a/src/Controller/Api/BaseApi.php +++ b/src/Controller/Api/BaseApi.php @@ -41,6 +41,7 @@ use App\Factory\PostFactory; use App\Factory\UserFactory; use App\Form\Constraint\ImageConstraint; +use App\Pagination\Cursor\CursorPaginationInterface; use App\Repository\BookmarkListRepository; use App\Repository\BookmarkRepository; use App\Repository\Criteria; @@ -55,6 +56,7 @@ use App\Repository\ReputationRepository; use App\Repository\TagLinkRepository; use App\Repository\UserRepository; +use App\Schema\CursorPaginationSchema; use App\Schema\PaginationSchema; use App\Service\BookmarkManager; use App\Service\InstanceManager; @@ -233,6 +235,14 @@ public function serializePaginated(array $serializedItems, PagerfantaInterface $ ]; } + public function serializeCursorPaginated(array $serializedItems, CursorPaginationInterface $pagerfanta): array + { + return [ + 'items' => $serializedItems, + 'pagination' => new CursorPaginationSchema($pagerfanta), + ]; + } + public function serializeContentInterface(ContentInterface $content, bool $forceVisible = false): mixed { $toReturn = null; diff --git a/src/Controller/Api/Combined/CombinedRetrieveApi.php b/src/Controller/Api/Combined/CombinedRetrieveApi.php index 9286b8f10a..05eb3b40fb 100644 --- a/src/Controller/Api/Combined/CombinedRetrieveApi.php +++ b/src/Controller/Api/Combined/CombinedRetrieveApi.php @@ -11,13 +11,16 @@ use App\Entity\Post; use App\Entity\User; use App\PageView\ContentPageView; +use App\Pagination\Cursor\CursorPaginationInterface; use App\Repository\ContentRepository; use App\Repository\Criteria; +use App\Schema\CursorPaginationSchema; use App\Schema\Errors\TooManyRequestsErrorSchema; use App\Schema\Errors\UnauthorizedErrorSchema; use App\Schema\PaginationSchema; use Nelmio\ApiDocBundle\Attribute\Model; use OpenApi\Attributes as OA; +use Pagerfanta\PagerfantaInterface; use Symfony\Bundle\SecurityBundle\Security; use Symfony\Component\HttpFoundation\JsonResponse; use Symfony\Component\HttpKernel\Attribute\MapQueryParameter; @@ -125,7 +128,12 @@ public function collection( #[MapQueryParameter] ?string $time, #[MapQueryParameter] ?string $federation, ): JsonResponse { - return $this->generateResponse($apiReadLimiter, $anonymousApiReadLimiter, $p, $security, $sort, $time, $federation, $perPage, $contentRepository); + $headers = $this->rateLimit($apiReadLimiter, $anonymousApiReadLimiter); + $criteria = $this->getCriteria($p, $security, $sort, $time, $federation, $perPage, $contentRepository, null); + + $content = $contentRepository->findByCriteria($criteria); + + return $this->serializeContent($content, $headers); } #[OA\Response( @@ -228,28 +236,237 @@ public function userCollection( #[MapQueryParameter] ?string $federation, string $collectionType, ): JsonResponse { - return $this->generateResponse($apiReadLimiter, $anonymousApiReadLimiter, $p, $security, $sort, $time, $federation, $perPage, $contentRepository, $collectionType); + $headers = $this->rateLimit($apiReadLimiter, $anonymousApiReadLimiter); + $criteria = $this->getCriteria($p, $security, $sort, $time, $federation, $perPage, $contentRepository, $collectionType); + + $content = $contentRepository->findByCriteria($criteria); + + return $this->serializeContent($content, $headers); } - private function generateResponse( + #[OA\Response( + response: 200, + description: 'A cursor paginated list of combined entries and posts filtered by the query parameters', + headers: [ + new OA\Header(header: 'X-RateLimit-Remaining', description: 'Number of requests left until you will be rate limited', schema: new OA\Schema(type: 'integer')), + new OA\Header(header: 'X-RateLimit-Retry-After', description: 'Unix timestamp to retry the request after', schema: new OA\Schema(type: 'integer')), + new OA\Header(header: 'X-RateLimit-Limit', description: 'Number of requests available', schema: new OA\Schema(type: 'integer')), + ], + content: new OA\JsonContent( + properties: [ + new OA\Property( + property: 'items', + type: 'array', + items: new OA\Items(ref: new Model(type: ContentResponseDto::class)) + ), + new OA\Property( + property: 'pagination', + ref: new Model(type: CursorPaginationSchema::class) + ), + ], + type: 'object' + ) + )] + #[OA\Response( + response: 401, + description: 'Permission denied due to missing or expired token', + content: new OA\JsonContent(ref: new Model(type: UnauthorizedErrorSchema::class)) + )] + #[OA\Response( + response: 429, + description: 'You are being rate limited', + headers: [ + new OA\Header(header: 'X-RateLimit-Remaining', description: 'Number of requests left until you will be rate limited', schema: new OA\Schema(type: 'integer')), + new OA\Header(header: 'X-RateLimit-Retry-After', description: 'Unix timestamp to retry the request after', schema: new OA\Schema(type: 'integer')), + new OA\Header(header: 'X-RateLimit-Limit', description: 'Number of requests available', schema: new OA\Schema(type: 'integer')), + ], + content: new OA\JsonContent(ref: new Model(type: TooManyRequestsErrorSchema::class)) + )] + #[OA\Parameter( + name: 'cursor', + description: 'The cursor', + in: 'query', + schema: new OA\Schema(type: 'string', default: null) + )] + #[OA\Parameter( + name: 'perPage', + description: 'Number of content items to retrieve per page', + in: 'query', + schema: new OA\Schema(type: 'integer', default: ContentRepository::PER_PAGE, maximum: self::MAX_PER_PAGE, minimum: self::MIN_PER_PAGE) + )] + #[OA\Parameter( + name: 'sort', + description: 'Sort method to use when retrieving content', + in: 'query', + schema: new OA\Schema(type: 'string', default: Criteria::SORT_HOT, enum: Criteria::SORT_OPTIONS) + )] + #[OA\Parameter( + name: 'time', + description: 'Max age of retrieved content', + in: 'query', + schema: new OA\Schema(type: 'string', default: Criteria::TIME_ALL, enum: Criteria::TIME_ROUTES_EN) + )] + #[OA\Parameter( + name: 'lang[]', + description: 'Language(s) of content to return', + in: 'query', + schema: new OA\Schema( + type: 'array', + items: new OA\Items(type: 'string', default: null, maxLength: 3, minLength: 2) + ), + explode: true, + allowReserved: true + )] + #[OA\Parameter( + name: 'usePreferredLangs', + description: 'Filter by a user\'s preferred languages? (Requires authentication and takes precedence over lang[])', + in: 'query', + schema: new OA\Schema(type: 'boolean', default: false), + )] + #[OA\Parameter( + name: 'federation', + description: 'What type of federated entries to retrieve', + in: 'query', + schema: new OA\Schema(type: 'string', default: Criteria::AP_ALL, enum: Criteria::AP_OPTIONS) + )] + #[OA\Tag(name: 'combined')] + public function cursorCollection( + RateLimiterFactory $apiReadLimiter, + RateLimiterFactory $anonymousApiReadLimiter, + Security $security, + ContentRepository $contentRepository, + #[MapQueryParameter] ?string $cursor, + #[MapQueryParameter] ?int $perPage, + #[MapQueryParameter] ?string $sort, + #[MapQueryParameter] ?string $time, + #[MapQueryParameter] ?string $federation, + ): JsonResponse { + $headers = $this->rateLimit($apiReadLimiter, $anonymousApiReadLimiter); + $criteria = $this->getCriteria(1, $security, $sort, $time, $federation, $perPage, $contentRepository, null); + $currentCursor = $this->getCursor($contentRepository, $criteria, $cursor); + + $content = $contentRepository->findByCriteriaCursored($criteria, $currentCursor); + + return $this->serializeContentCursored($content, $headers); + } + + #[OA\Response( + response: 200, + description: 'A cursor paginated list of combined entries and posts from subscribed magazines and users filtered by the query parameters', + headers: [ + new OA\Header(header: 'X-RateLimit-Remaining', description: 'Number of requests left until you will be rate limited', schema: new OA\Schema(type: 'integer')), + new OA\Header(header: 'X-RateLimit-Retry-After', description: 'Unix timestamp to retry the request after', schema: new OA\Schema(type: 'integer')), + new OA\Header(header: 'X-RateLimit-Limit', description: 'Number of requests available', schema: new OA\Schema(type: 'integer')), + ], + content: new OA\JsonContent( + properties: [ + new OA\Property( + property: 'items', + type: 'array', + items: new OA\Items(ref: new Model(type: ContentResponseDto::class)) + ), + new OA\Property( + property: 'pagination', + ref: new Model(type: CursorPaginationSchema::class) + ), + ], + type: 'object' + ) + )] + #[OA\Response( + response: 401, + description: 'Permission denied due to missing or expired token', + content: new OA\JsonContent(ref: new Model(type: UnauthorizedErrorSchema::class)) + )] + #[OA\Response( + response: 429, + description: 'You are being rate limited', + headers: [ + new OA\Header(header: 'X-RateLimit-Remaining', description: 'Number of requests left until you will be rate limited', schema: new OA\Schema(type: 'integer')), + new OA\Header(header: 'X-RateLimit-Retry-After', description: 'Unix timestamp to retry the request after', schema: new OA\Schema(type: 'integer')), + new OA\Header(header: 'X-RateLimit-Limit', description: 'Number of requests available', schema: new OA\Schema(type: 'integer')), + ], + content: new OA\JsonContent(ref: new Model(type: TooManyRequestsErrorSchema::class)) + )] + #[OA\Parameter( + name: 'cursor', + description: 'The cursor', + in: 'query', + schema: new OA\Schema(type: 'string', default: null) + )] + #[OA\Parameter( + name: 'perPage', + description: 'Number of content items to retrieve per page', + in: 'query', + schema: new OA\Schema(type: 'integer', default: ContentRepository::PER_PAGE, maximum: self::MAX_PER_PAGE, minimum: self::MIN_PER_PAGE) + )] + #[OA\Parameter( + name: 'sort', + description: 'Sort method to use when retrieving content', + in: 'query', + schema: new OA\Schema(type: 'string', default: Criteria::SORT_HOT, enum: Criteria::SORT_OPTIONS) + )] + #[OA\Parameter( + name: 'time', + description: 'Max age of retrieved content', + in: 'query', + schema: new OA\Schema(type: 'string', default: Criteria::TIME_ALL, enum: Criteria::TIME_ROUTES_EN) + )] + #[OA\Parameter( + name: 'lang[]', + description: 'Language(s) of content to return', + in: 'query', + schema: new OA\Schema( + type: 'array', + items: new OA\Items(type: 'string', default: null, maxLength: 3, minLength: 2) + ), + explode: true, + allowReserved: true + )] + #[OA\Parameter( + name: 'usePreferredLangs', + description: 'Filter by a user\'s preferred languages? (Requires authentication and takes precedence over lang[])', + in: 'query', + schema: new OA\Schema(type: 'boolean', default: false), + )] + #[OA\Parameter( + name: 'federation', + description: 'What type of federated entries to retrieve', + in: 'query', + schema: new OA\Schema(type: 'string', default: Criteria::AP_ALL, enum: Criteria::AP_OPTIONS) + )] + #[OA\Tag(name: 'combined')] + #[\Nelmio\ApiDocBundle\Attribute\Security(name: 'oauth2', scopes: ['read'])] + #[IsGranted('ROLE_OAUTH2_READ')] + public function cursorUserCollection( RateLimiterFactory $apiReadLimiter, RateLimiterFactory $anonymousApiReadLimiter, - ?int $p, Security $security, - ?string $sort, - ?string $time, - ?string $federation, - ?int $perPage, ContentRepository $contentRepository, - ?string $collectionType = null, + #[MapQueryParameter] ?string $cursor, + #[MapQueryParameter] ?int $perPage, + #[MapQueryParameter] ?string $sort, + #[MapQueryParameter] ?string $time, + #[MapQueryParameter] ?string $federation, + string $collectionType, ): JsonResponse { $headers = $this->rateLimit($apiReadLimiter, $anonymousApiReadLimiter); + $criteria = $this->getCriteria(1, $security, $sort, $time, $federation, $perPage, $contentRepository, $collectionType); + $currentCursor = $this->getCursor($contentRepository, $criteria, $cursor); + + $content = $contentRepository->findByCriteriaCursored($criteria, $currentCursor); + + return $this->serializeContentCursored($content, $headers); + } + + private function getCriteria(?int $p, Security $security, ?string $sort, ?string $time, ?string $federation, ?int $perPage, ContentRepository $contentRepository, ?string $collectionType): ContentPageView + { $criteria = new ContentPageView($p ?? 1, $security); $criteria->sortOption = $sort ?? Criteria::SORT_HOT; $criteria->time = $criteria->resolveTime($time ?? Criteria::TIME_ALL); $criteria->setFederation($federation ?? Criteria::AP_ALL); $this->handleLanguageCriteria($criteria); - $criteria->content = Criteria::CONTENT_THREADS; + $criteria->content = Criteria::CONTENT_COMBINED; $criteria->perPage = $perPage; $user = $security->getUser(); if ($user instanceof User) { @@ -268,11 +485,13 @@ private function generateResponse( break; } - $content = $contentRepository->findByCriteria($criteria); - $this->handleLanguageCriteria($criteria); + return $criteria; + } + private function serializeContent(PagerfantaInterface $content, array $headers): JsonResponse + { $result = []; - foreach ($content->getCurrentPageResults() as $item) { + foreach ($content as $item) { if ($item instanceof Entry) { $this->handlePrivateContent($item); $result[] = new ContentResponseDto(entry: $this->serializeEntry($this->entryFactory->createDto($item), $this->tagLinkRepository->getTagsOfContent($item))); @@ -284,4 +503,37 @@ private function generateResponse( return new JsonResponse($this->serializePaginated($result, $content), headers: $headers); } + + private function serializeContentCursored(CursorPaginationInterface $content, array $headers): JsonResponse + { + $result = []; + foreach ($content as $item) { + if ($item instanceof Entry) { + $this->handlePrivateContent($item); + $result[] = new ContentResponseDto(entry: $this->serializeEntry($this->entryFactory->createDto($item), $this->tagLinkRepository->getTagsOfContent($item))); + } elseif ($item instanceof Post) { + $this->handlePrivateContent($item); + $result[] = new ContentResponseDto(post: $this->serializePost($this->postFactory->createDto($item), $this->tagLinkRepository->getTagsOfContent($item))); + } + } + + return new JsonResponse($this->serializeCursorPaginated($result, $content), headers: $headers); + } + + /** + * @throws \DateMalformedStringException + */ + private function getCursor(ContentRepository $contentRepository, ContentPageView $criteria, ?string $cursor): int|\DateTime|\DateTimeImmutable + { + $initialCursor = $contentRepository->guessInitialCursor($criteria); + if ($initialCursor instanceof \DateTime || $initialCursor instanceof \DateTimeImmutable) { + $currentCursor = null !== $cursor ? new \DateTimeImmutable($cursor) : $initialCursor; + } elseif (\is_int($initialCursor)) { + $currentCursor = null !== $cursor ? \intval($cursor) : $initialCursor; + } else { + throw new \LogicException(\get_class($initialCursor).' is not accounted for'); + } + + return $currentCursor; + } } diff --git a/src/Schema/CursorPaginationSchema.php b/src/Schema/CursorPaginationSchema.php new file mode 100644 index 0000000000..86e11ea60e --- /dev/null +++ b/src/Schema/CursorPaginationSchema.php @@ -0,0 +1,48 @@ +currentCursor = $this->cursorToString($pagerfanta->getCurrentCursor()); + $this->nextCursor = $pagerfanta->hasNextPage() ? $this->cursorToString($pagerfanta->getNextPage()) : null; + $this->previousCursor = $pagerfanta->hasPreviousPage() ? $this->cursorToString($pagerfanta->getPreviousPage()) : null; + $this->perPage = $pagerfanta->getMaxPerPage(); + } + + private function cursorToString(mixed $cursor): string + { + if ($cursor instanceof \DateTime || $cursor instanceof \DateTimeImmutable) { + return $cursor->format(DATE_ATOM); + } + + return $cursor->__toString(); + } + + public function jsonSerialize(): mixed + { + return [ + 'currentCursor' => $this->currentCursor, + 'nextCursor' => $this->nextCursor, + 'previousCursor' => $this->previousCursor, + 'perPage' => $this->perPage, + ]; + } +} diff --git a/src/Twig/Runtime/UrlExtensionRuntime.php b/src/Twig/Runtime/UrlExtensionRuntime.php index 90e47c4db1..81b62049fa 100644 --- a/src/Twig/Runtime/UrlExtensionRuntime.php +++ b/src/Twig/Runtime/UrlExtensionRuntime.php @@ -301,7 +301,6 @@ public function getCursorUrlValue(mixed $cursor): mixed { if ($cursor instanceof \DateTime || $cursor instanceof \DateTimeImmutable) { return $cursor->format(DATE_ATOM); - // return $cursor->getTimestamp(); } return $cursor; diff --git a/tests/Functional/Controller/Api/Combined/CombinedRetrieveApiTest.php b/tests/Functional/Controller/Api/Combined/CombinedRetrieveApiTest.php new file mode 100644 index 0000000000..beddad81d0 --- /dev/null +++ b/tests/Functional/Controller/Api/Combined/CombinedRetrieveApiTest.php @@ -0,0 +1,93 @@ +magazine = $this->getMagazineByName('acme'); + for ($i = 0; $i < 10; ++$i) { + $entry = $this->getEntryByTitle("Test Entry $i", magazine: $this->magazine); + $entry->createdAt = new \DateTimeImmutable("now - $i minutes"); + $this->entityManager->persist($entry); + $this->generatedEntries[] = $entry; + ++$i; + $post = $this->createPost("Test Post $i", magazine: $this->magazine); + $post->createdAt = new \DateTimeImmutable("now - $i minutes"); + $this->entityManager->persist($post); + $this->generatedPosts[] = $post; + } + $this->entityManager->flush(); + } + + public function testCombinedAnonymous(): void + { + $this->client->request('GET', '/api/combined?perPage=2&content=all&sort=newest'); + + self::assertResponseIsSuccessful(); + $data = self::getJsonResponse($this->client); + self::assertArrayKeysMatch(WebTestCase::PAGINATED_KEYS, $data); + self::assertCount(2, $data['items']); + self::assertArrayKeysMatch(WebTestCase::PAGINATION_KEYS, $data['pagination']); + self::assertEquals(5, $data['pagination']['maxPage']); + + self::assertArrayKeysMatch(WebTestCase::ENTRY_RESPONSE_KEYS, $data['items'][0]['entry']); + self::assertNull($data['items'][0]['post']); + assertEquals($this->generatedEntries[0]->getId(), $data['items'][0]['entry']['entryId']); + self::assertArrayKeysMatch(WebTestCase::POST_RESPONSE_KEYS, $data['items'][1]['post']); + self::assertNull($data['items'][1]['entry']); + assertEquals($this->generatedPosts[0]->getId(), $data['items'][1]['post']['postId']); + } + + public function testCombinedCursoredAnonymous(): void + { + $this->client->request('GET', '/api/combined/2.0?perPage=2&sort=newest'); + + self::assertResponseIsSuccessful(); + $data = self::getJsonResponse($this->client); + self::assertArrayKeysMatch(WebTestCase::PAGINATED_KEYS, $data); + + self::assertCount(2, $data['items']); + self::assertArrayKeysMatch(WebTestCase::CURSOR_PAGINATION_KEYS, $data['pagination']); + self::assertNotNull($data['pagination']['nextCursor']); + self::assertNotNull($data['pagination']['currentCursor']); + self::assertNull($data['pagination']['previousCursor']); + + self::assertArrayKeysMatch(WebTestCase::ENTRY_RESPONSE_KEYS, $data['items'][0]['entry']); + self::assertNull($data['items'][0]['post']); + assertEquals($this->generatedEntries[0]->getId(), $data['items'][0]['entry']['entryId']); + self::assertArrayKeysMatch(WebTestCase::POST_RESPONSE_KEYS, $data['items'][1]['post']); + self::assertNull($data['items'][1]['entry']); + assertEquals($this->generatedPosts[0]->getId(), $data['items'][1]['post']['postId']); + + $this->client->request('GET', '/api/combined/2.0?perPage=2&sort=newest&cursor='.urlencode($data['pagination']['nextCursor'])); + self::assertResponseIsSuccessful(); + $data = self::getJsonResponse($this->client); + + self::assertCount(2, $data['items']); + self::assertArrayKeysMatch(WebTestCase::CURSOR_PAGINATION_KEYS, $data['pagination']); + self::assertNotNull($data['pagination']['nextCursor']); + self::assertNotNull($data['pagination']['currentCursor']); + self::assertNotNull($data['pagination']['previousCursor']); + + self::assertArrayKeysMatch(WebTestCase::ENTRY_RESPONSE_KEYS, $data['items'][0]['entry']); + self::assertNull($data['items'][0]['post']); + assertEquals($this->generatedEntries[1]->getId(), $data['items'][0]['entry']['entryId']); + self::assertArrayKeysMatch(WebTestCase::POST_RESPONSE_KEYS, $data['items'][1]['post']); + self::assertNull($data['items'][1]['entry']); + assertEquals($this->generatedPosts[1]->getId(), $data['items'][1]['post']['postId']); + } +} diff --git a/tests/WebTestCase.php b/tests/WebTestCase.php index 5e07478875..f1ba47db89 100644 --- a/tests/WebTestCase.php +++ b/tests/WebTestCase.php @@ -84,6 +84,7 @@ abstract class WebTestCase extends BaseWebTestCase protected const PAGINATED_KEYS = ['items', 'pagination']; protected const PAGINATION_KEYS = ['count', 'currentPage', 'maxPage', 'perPage']; + protected const CURSOR_PAGINATION_KEYS = ['currentCursor', 'nextCursor', 'previousCursor', 'perPage']; protected const IMAGE_KEYS = ['filePath', 'sourceUrl', 'storageUrl', 'altText', 'width', 'height', 'blurHash']; protected const MESSAGE_RESPONSE_KEYS = ['messageId', 'threadId', 'sender', 'body', 'status', 'createdAt']; protected const USER_RESPONSE_KEYS = ['userId', 'username', 'about', 'avatar', 'cover', 'createdAt', 'followersCount', 'apId', 'apProfileId', 'isBot', 'isFollowedByUser', 'isFollowerOfUser', 'isBlockedByUser', 'isAdmin', 'isGlobalModerator', 'serverSoftware', 'serverSoftwareVersion', 'notificationStatus', 'reputationPoints', 'discoverable', 'indexable']; From 571f611862542bcb407454f4a63fde1554ed99a0 Mon Sep 17 00:00:00 2001 From: BentiGorlich Date: Sun, 1 Feb 2026 16:01:35 +0100 Subject: [PATCH 5/6] Fix linter --- assets/controllers/infinite_scroll_controller.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assets/controllers/infinite_scroll_controller.js b/assets/controllers/infinite_scroll_controller.js index 4eb14fcc28..b7e89cc7ad 100644 --- a/assets/controllers/infinite_scroll_controller.js +++ b/assets/controllers/infinite_scroll_controller.js @@ -26,7 +26,7 @@ export default class extends Controller { let paginationElem = null; if (cursorPaginationElement.length) { console.log(cursorPaginationElement[0]); - let button = cursorPaginationElement[0].getElementsByTagName('a'); + const button = cursorPaginationElement[0].getElementsByTagName('a'); if (!button.length) { throw new Error('No more pages'); } From fe09af684263858671d8f22b3285475cf7a12f27 Mon Sep 17 00:00:00 2001 From: BentiGorlich Date: Mon, 2 Feb 2026 18:14:27 +0100 Subject: [PATCH 6/6] Use cursor pagination in RSS feed --- src/Service/FeedManager.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Service/FeedManager.php b/src/Service/FeedManager.php index c7bd9b2446..7f41c91b0e 100644 --- a/src/Service/FeedManager.php +++ b/src/Service/FeedManager.php @@ -46,7 +46,7 @@ public function getFeed(Request $request): FeedInterface $criteria = $this->getCriteriaFromRequest($request); $feed = $this->createFeed($criteria); - $content = $this->contentRepository->findByCriteria($criteria); + $content = $this->contentRepository->findByCriteriaCursored($criteria, $this->contentRepository->guessInitialCursor($criteria)); foreach ($this->getItems($content->getCurrentPageResults()) as $item) { $feed->add($item);