228 lines
8.4 KiB
PHP
228 lines
8.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 Plugin\Favourite\Controller;
|
|
|
|
use App\Core\DB\DB;
|
|
use App\Core\Event;
|
|
use App\Core\Form;
|
|
use function App\Core\I18n\_m;
|
|
use App\Core\Log;
|
|
use App\Core\Router\Router;
|
|
use App\Entity\Actor;
|
|
use App\Entity\LocalUser;
|
|
use App\Entity\Note;
|
|
use App\Util\Common;
|
|
use App\Util\Exception\ClientException;
|
|
use App\Util\Exception\InvalidFormException;
|
|
use App\Util\Exception\NoLoggedInUser;
|
|
use App\Util\Exception\NoSuchNoteException;
|
|
use App\Util\Exception\RedirectException;
|
|
use App\Util\Exception\ServerException;
|
|
use Component\Collection\Util\Controller\FeedController;
|
|
use Symfony\Component\Form\Extension\Core\Type\SubmitType;
|
|
use Symfony\Component\HttpFoundation\Request;
|
|
|
|
class Favourite extends FeedController
|
|
{
|
|
/**
|
|
* @throws InvalidFormException
|
|
* @throws NoLoggedInUser
|
|
* @throws NoSuchNoteException
|
|
* @throws RedirectException
|
|
* @throws ServerException
|
|
*/
|
|
public function favouriteAddNote(Request $request, int $id): bool|array
|
|
{
|
|
$user = Common::ensureLoggedIn();
|
|
$actor_id = $user->getId();
|
|
$opts = ['id' => $id];
|
|
$add_favourite_note = DB::findOneBy(Note::class, $opts);
|
|
if (\is_null($add_favourite_note)) {
|
|
throw new NoSuchNoteException();
|
|
}
|
|
|
|
$form_add_to_favourite = Form::create([
|
|
['add_favourite', SubmitType::class,
|
|
[
|
|
'label' => _m('Favourite note!'),
|
|
'attr' => [
|
|
'title' => _m('Favourite this note!'),
|
|
],
|
|
],
|
|
],
|
|
]);
|
|
|
|
$form_add_to_favourite->handleRequest($request);
|
|
|
|
if ($form_add_to_favourite->isSubmitted()) {
|
|
if (!\is_null($activity = \Plugin\Favourite\Favourite::favourNote(note_id: $id, actor_id: $actor_id))) {
|
|
DB::flush();
|
|
Event::handle('NewNotification', [$actor = Actor::getById($actor_id), $activity, $activity->getAttentionTargets(), _m('{actor_id} favoured note {note_id}.', ['{actor_id}' => $actor->getId(), '{note_id}' => $activity->getObjectId()])]);
|
|
} else {
|
|
throw new ClientException(_m('Note already favoured!'));
|
|
}
|
|
|
|
// Redirect user to where they came from
|
|
// Prevent open redirect
|
|
if (!\is_null($from = $this->string('from'))) {
|
|
if (Router::isAbsolute($from)) {
|
|
Log::warning("Actor {$actor_id} attempted to favourite a note and then get redirected to another host, or the URL was invalid ({$from})");
|
|
throw new ClientException(_m('Can not redirect to outside the website from here'), 400); // 400 Bad request (deceptive)
|
|
} else {
|
|
// TODO anchor on element id
|
|
throw new RedirectException(url: $from);
|
|
}
|
|
} else {
|
|
// If we don't have a URL to return to, go to the instance root
|
|
throw new RedirectException('root');
|
|
}
|
|
}
|
|
|
|
return [
|
|
'_template' => 'favourite/add_to_favourites.html.twig',
|
|
'note' => $add_favourite_note,
|
|
'add_favourite' => $form_add_to_favourite->createView(),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @throws InvalidFormException
|
|
* @throws NoLoggedInUser
|
|
* @throws NoSuchNoteException
|
|
* @throws RedirectException
|
|
* @throws ServerException
|
|
*/
|
|
public function favouriteRemoveNote(Request $request, int $id): array
|
|
{
|
|
$user = Common::ensureLoggedIn();
|
|
$actor_id = $user->getId();
|
|
$opts = ['id' => $id];
|
|
$remove_favourite_note = DB::findOneBy(Note::class, $opts);
|
|
if (\is_null($remove_favourite_note)) {
|
|
throw new NoSuchNoteException();
|
|
}
|
|
|
|
$form_remove_favourite = Form::create([
|
|
['remove_favourite', SubmitType::class,
|
|
[
|
|
'label' => _m('Remove favourite'),
|
|
'attr' => [
|
|
'title' => _m('Remove note from favourites.'),
|
|
],
|
|
],
|
|
],
|
|
]);
|
|
|
|
$form_remove_favourite->handleRequest($request);
|
|
if ($form_remove_favourite->isSubmitted()) {
|
|
if (!\is_null($activity = \Plugin\Favourite\Favourite::unfavourNote(note_id: $id, actor_id: $actor_id))) {
|
|
DB::flush();
|
|
Event::handle('NewNotification', [$actor = Actor::getById($actor_id), $activity, $activity->getAttentionTargets(), _m('{actor_id} unfavoured note {note_id}.', ['{actor_id}' => $actor->getId(), '{note_id}' => $activity->getObjectId()])]);
|
|
} else {
|
|
throw new ClientException(_m('Note already unfavoured!'));
|
|
}
|
|
|
|
// Redirect user to where they came from
|
|
// Prevent open redirect
|
|
if (!\is_null($from = $this->string('from'))) {
|
|
if (Router::isAbsolute($from)) {
|
|
Log::warning("Actor {$actor_id} attempted to reply to a note and then get redirected to another host, or the URL was invalid ({$from})");
|
|
throw new ClientException(_m('Can not redirect to outside the website from here'), 400); // 400 Bad request (deceptive)
|
|
} else {
|
|
// TODO anchor on element id
|
|
throw new RedirectException(url: $from);
|
|
}
|
|
} else {
|
|
// If we don't have a URL to return to, go to the instance root
|
|
throw new RedirectException('root');
|
|
}
|
|
}
|
|
|
|
$note = DB::findOneBy(Note::class, ['id' => $id]);
|
|
return [
|
|
'_template' => 'favourite/remove_from_favourites.html.twig',
|
|
'note' => $note,
|
|
'remove_favourite' => $form_remove_favourite->createView(),
|
|
];
|
|
}
|
|
|
|
public function favouritesViewByActorId(Request $request, int $id)
|
|
{
|
|
$notes = DB::dql(
|
|
<<< 'EOF'
|
|
select n from note n
|
|
join note_favourite f with n.id = f.note_id
|
|
where f.actor_id = :id
|
|
order by f.created DESC
|
|
EOF,
|
|
['id' => $id],
|
|
);
|
|
|
|
return [
|
|
'_template' => 'collection/notes.html.twig',
|
|
'page_title' => 'Favourites',
|
|
'notes' => $notes,
|
|
];
|
|
}
|
|
|
|
public function favouritesViewByActorNickname(Request $request, string $nickname)
|
|
{
|
|
$user = DB::findOneBy(LocalUser::class, ['nickname' => $nickname]);
|
|
return self::favouritesViewByActorId($request, $user->getId());
|
|
}
|
|
|
|
/**
|
|
* Reverse favourites stream
|
|
*
|
|
* @throws NoLoggedInUser user not logged in
|
|
*
|
|
* @return array template
|
|
*/
|
|
public function reverseFavouritesViewByActorId(Request $request, int $id): array
|
|
{
|
|
$notes = DB::dql(
|
|
<<< 'EOF'
|
|
select n from note n
|
|
join note_favourite f with n.id = f.note_id
|
|
where f.actor_id != :id
|
|
and n.actor_id = :id
|
|
order by f.created DESC
|
|
EOF,
|
|
['id' => $id],
|
|
);
|
|
|
|
return [
|
|
'_template' => 'collection/notes.html.twig',
|
|
'page_title' => 'Reverse favourites feed.',
|
|
'notes' => $notes,
|
|
];
|
|
}
|
|
|
|
public function reverseFavouritesViewByActorNickname(Request $request, string $nickname)
|
|
{
|
|
$user = DB::findOneBy(LocalUser::class, ['nickname' => $nickname]);
|
|
return self::reverseFavouritesViewByActorId($request, $user->getId());
|
|
}
|
|
}
|