125 lines
4.4 KiB
PHP
125 lines
4.4 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 Component\Tag;
|
|
|
|
use App\Core\Cache;
|
|
use App\Core\DB\DB;
|
|
use App\Core\Event;
|
|
use App\Core\Modules\Component;
|
|
use App\Core\Router\Router;
|
|
use App\Entity\Note;
|
|
use App\Entity\NoteTag;
|
|
use App\Util\Formatting;
|
|
use App\Util\HTML;
|
|
use Doctrine\Common\Collections\ExpressionBuilder;
|
|
use Doctrine\ORM\Query\Expr;
|
|
use Doctrine\ORM\QueryBuilder;
|
|
|
|
/**
|
|
* Component responsible for extracting tags from posted notes, as well as normalizing them
|
|
*
|
|
* @author Hugo Sales <hugo@hsal.es>
|
|
* @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
*/
|
|
class Tag extends Component
|
|
{
|
|
public const MAX_TAG_LENGTH = 64;
|
|
public const TAG_REGEX = '/(^|\\s)(#[\\pL\\pN_\\-\\.]{1,64})/u'; // Brion Vibber 2011-02-23 v2:classes/Notice.php:367 function saveTags
|
|
public const TAG_SLUG_REGEX = '[A-Za-z0-9]{1,64}';
|
|
|
|
public function onAddRoute($r): bool
|
|
{
|
|
$r->connect('tag', '/tag/{tag<' . self::TAG_SLUG_REGEX . '>}', [Controller\Tag::class, 'tag']);
|
|
return Event::next;
|
|
}
|
|
|
|
/**
|
|
* Process note by extracting any tags present
|
|
*/
|
|
public function onProcessNoteContent(Note $note, string $content)
|
|
{
|
|
$matched_tags = [];
|
|
$processed_tags = false;
|
|
preg_match_all(self::TAG_REGEX, $content, $matched_tags, \PREG_SET_ORDER);
|
|
foreach ($matched_tags as $match) {
|
|
$tag = $match[2];
|
|
$canonical_tag = self::canonicalTag($tag);
|
|
DB::persist(NoteTag::create(['tag' => $tag, 'canonical' => $canonical_tag, 'note_id' => $note->getId()]));
|
|
Cache::pushList("tag-{$canonical_tag}", $note);
|
|
$processed_tags = true;
|
|
}
|
|
if ($processed_tags) {
|
|
DB::flush();
|
|
}
|
|
}
|
|
|
|
public function onRenderContent(string &$text)
|
|
{
|
|
$text = preg_replace_callback(self::TAG_REGEX, fn ($m) => $m[1] . $this->tagLink($m[2]), $text);
|
|
}
|
|
|
|
private function tagLink(string $tag): string
|
|
{
|
|
$canonical = self::canonicalTag($tag);
|
|
$url = Router::url('tag', ['tag' => $canonical]);
|
|
return HTML::html(['a' => ['attrs' => ['href' => $url, 'title' => $tag, 'rel' => 'tag'], $tag]], options: ['indent' => false]);
|
|
}
|
|
|
|
public static function canonicalTag(string $tag): string
|
|
{
|
|
return mb_substr(Formatting::slugify($tag), 0, self::MAX_TAG_LENGTH);
|
|
}
|
|
|
|
/**
|
|
* Populate $note_expr with an expression to match a tag, if the term looks like a tag
|
|
*
|
|
* $term /^(note|tag|people|actor)/ means we want to match only either a note or an actor
|
|
*/
|
|
public function onSearchCreateExpression(ExpressionBuilder $eb, string $term, &$note_expr, &$actor_expr)
|
|
{
|
|
$search_term = str_contains($term, ':#') ? explode(':', $term)[1] : $term;
|
|
$temp_note_expr = $eb->eq('note_tag.tag', $search_term);
|
|
$temp_actor_expr = $eb->eq('actor_tag.tag', $search_term);
|
|
if (Formatting::startsWith($term, ['note', 'tag'])) {
|
|
$note_expr = $temp_note_expr;
|
|
} else {
|
|
if (Formatting::startsWith($term, ['people', 'actor'])) {
|
|
$actor_expr = $temp_actor_expr;
|
|
} else {
|
|
$note_expr = $temp_note_expr;
|
|
$actor_expr = $temp_actor_expr;
|
|
return Event::next;
|
|
}
|
|
}
|
|
return Event::stop;
|
|
}
|
|
|
|
public function onSeachQueryAddJoins(QueryBuilder &$note_qb, QueryBuilder &$actor_qb)
|
|
{
|
|
$note_qb->join('App\Entity\NoteTag', 'note_tag', Expr\Join::WITH, 'note_tag.note_id = note.id');
|
|
$actor_qb->join('App\Entity\ActorTag', 'actor_tag', Expr\Join::WITH, 'actor_tag.tagger = actor.id');
|
|
}
|
|
}
|