GNUsocial
/
gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

[COMPONENT][Feed] Add way of filtering the notes on an arbitrary feed with a types GET parameter, that accepts {,!}<[media,text,link,tags]...>

This commit is contained in:
Hugo Sales 2021-12-30 18:28:32 +00:00
parent 0ae24f6088
commit 9a6bdf74dc
Signed by: someonewithpc
GPG Key ID: 7D0C7EAFC9D835A0
1 changed files with 45 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
components/Feed/Util/FeedController.php
View File

@ -34,9 +34,12 @@ namespace Component\Feed\Util;
use App\Core\Controller;
use App\Core\Event;
use function App\Core\I18n\_m;
use App\Entity\Actor;
use App\Entity\Note;
use App\Util\Common;
use App\Util\Exception\ClientException;
use App\Util\Formatting;
use Functional as F;
abstract class FeedController extends Controller
@ -46,13 +49,17 @@ abstract class FeedController extends Controller
* notes or actors the user specified, as well as format the raw
* list of notes into a usable format
*/
public static function postProcess(array $result): array
protected function postProcess(array $result): array
{
$actor = Common::actor();
if (\array_key_exists('notes', $result)) {
$notes = $result['notes'];
self::enforceScope($notes, $actor);
$types = $this->string('types');
if (!\is_null($types)) {
self::filterNoteType($notes, $types);
}
Event::handle('FilterNoteList', [$actor, &$notes, $result['request']]);
Event::handle('FormatNoteList', [$notes, &$result['notes']]);
}
@ -60,6 +67,43 @@ abstract class FeedController extends Controller
return $result;
}
private static function filterNoteType(array &$notes, string $types): void
{
$types = explode(',', $types);
$types = [
...$types,
// Add any missing types as a negation
...array_diff(['!media', '!link', '!text', '!tags'], F\map($types, fn ($t) => $t[0] === '!' ? $t : '!' . $t)),
];
$notes = F\select($notes, function (Note $note) use ($types) {
$include = false;
foreach ($types as $type) {
$is_negate = $type[0] === '!';
$type = Formatting::removePrefix($type, '!');
$ret = (function () use ($note, $type) {
switch ($type) {
case 'media':
return !empty($note->getAttachments());
case 'link':
return !empty($note->getLinks());
case 'text':
return !\is_null($note->getContent());
case 'tags':
return !empty($note->getTags());
default:
throw new ClientException(_m('Unknown note type requested ({type})', ['{type}' => $type]));
}
})();
if ($is_negate && $ret) {
return false;
}
$include = $include || $ret;
}
return $include;
});
}
private static function enforceScope(array &$notes, ?Actor $actor): void
{
$notes = F\select($notes, fn (Note $n) => $n->isVisibleTo($actor));