gnu-social/plugins/Directory/Controller/Directory.php

164 lines
6.6 KiB
PHP

<?php
declare(strict_types = 1);
// {{{ License
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
// }}}
namespace Plugin\Directory\Controller;
use App\Core\DB\DB;
use function App\Core\I18n\_m;
use App\Entity\Actor;
use App\Util\Common;
use App\Util\Exception\BugFoundException;
use App\Util\Exception\ClientException;
use App\Util\Exception\ServerException;
use Component\Collection\Util\Controller\CircleController;
use Symfony\Component\HttpFoundation\Request;
class Directory extends CircleController
{
public const ALLOWED_FIELDS = ['nickname', 'created', 'modified', 'activity', 'subscribers'];
/**
* Function responsible for displaying a list of actors of a given
* $actor_type, sorted by the `order_by` GET parameter, if given
*
* @throws BugFoundException
* @throws ClientException
* @throws ServerException
*/
private function magic(Request $request, int $actor_type, string $title, string $empty_message): array
{
if ($actor_type !== Actor::PERSON && $actor_type !== Actor::GROUP) {
throw new BugFoundException("Unimplemented for actor type: {$actor_type}");
}
$page = $this->int('page') ?? 1;
$limit = Common::config('feeds', 'entries_per_page');
$offset = $limit * ($page - 1);
// -------- Figure out the order by field and operator --------
$order_by_qs = $this->string('order_by');
if (!\is_null($order_by_qs) && mb_detect_encoding($order_by_qs, 'ASCII', strict: true) !== false) {
$order_by_op = mb_substr($order_by_qs, -1);
if (\in_array($order_by_op, ['^', '<'])) {
$order_by_field = mb_substr($order_by_qs, 0, -1);
$order_by_op = 'DESC';
} elseif (\in_array($order_by_op, ['v', '>'])) {
$order_by_field = mb_substr($order_by_qs, 0, -1);
$order_by_op = 'ASC';
} else {
$order_by_field = $order_by_qs;
$order_by_op = match ($this->string('order_op')) {
'ASC' => 'ASC',
'DESC' => 'DESC',
default => 'ASC',
};
}
if (!\in_array($order_by_field, self::ALLOWED_FIELDS)) {
throw new ClientException(_m('Invalid order by given: {order_by}', ['{order_by}' => $order_by_field]));
}
} else {
$order_by_field = 'nickname';
$order_by_op = 'ASC';
}
$order_by = [$order_by_field => $order_by_op];
// -------- *** --------
// -------- Query builder for selecting actors joined with another table, namely activity and group_inbox --------
$general_query_fn_fn = function (string $func, string $order) use ($limit, $offset) {
return fn (string $table, string $join_field, string $aggregate_field) => fn (int $actor_type) => DB::sql(
<<<EOQ
select {select}
from actor actr
join (
select tbl.{$join_field}, {$func}(tbl.{$aggregate_field}) as aggr
from {$table} tbl
group by tbl.{$join_field}
) actor_activity on actr.id = actor_activity.{$join_field}
where actr.type = :type
order by actor_activity.aggr {$order}
limit :limit offset :offset
EOQ,
[
'type' => $actor_type,
'limit' => $limit,
'offset' => $offset,
],
['actor' => Actor::class],
);
};
// -------- *** --------
// -------- Start setting up the queries --------
$actor_query_fn = fn (int $actor_type) => DB::findBy(Actor::class, ['type' => $actor_type], order_by: $order_by, limit: $limit, offset: $offset);
$minmax_query_fn = $general_query_fn_fn(func: $order_by_op === 'ASC' ? 'MAX' : 'MIN', order: $order_by_op);
$count_query_fn = $general_query_fn_fn(func: 'COUNT', order: $order_by_op);
// -------- *** --------
// -------- Figure out the final query --------
$query_fn = match ($order_by_field) {
'nickname', 'created' => $actor_query_fn, // select only from actors
// select by most/least recent activity
'modified' => $minmax_query_fn(table: 'activity', join_field: 'actor_id', aggregate_field: 'created'),
// select by most/least activity amount
'activity' => $count_query_fn(table: 'activity', join_field: 'actor_id', aggregate_field: 'created'),
// select by actors with most/least subscribers/members
'subscribers' => $count_query_fn(table: 'subscription', join_field: 'subscribed_id', aggregate_field: 'subscriber_id'),
default => throw new BugFoundException("Unknown order by found, but should have been validated: {$order_by_field}"),
};
// -------- *** --------
$sort_form_fields = [];
foreach (self::ALLOWED_FIELDS as $al) {
$sort_form_fields[] = [
'checked' => $order_by_field === $al,
'value' => $al,
'label' => _m(ucfirst($al)),
];
}
return [
'_template' => 'collection/actors.html.twig',
'actors' => $query_fn($actor_type),
'title' => $title,
'empty_message' => $empty_message,
'sort_form_fields' => $sort_form_fields,
'page' => $page,
];
}
public function people(Request $request): array
{
return $this->magic($request, Actor::PERSON, title: _m('People'), empty_message: _m('No people here'));
}
public function groups(Request $request): array
{
return $this->magic($request, Actor::GROUP, title: _m('Groups'), empty_message: _m('No groups here'));
}
}