2020-09-04 15:18:58 +01:00
|
|
|
<?php
|
|
|
|
|
|
|
|
// {{{ License
|
2021-04-23 13:55:42 +01:00
|
|
|
|
2020-09-04 15:18:58 +01:00
|
|
|
// 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/>.
|
2021-04-23 13:55:42 +01:00
|
|
|
|
2020-09-04 15:18:58 +01:00
|
|
|
// }}}
|
|
|
|
|
|
|
|
namespace Plugin\Favourite;
|
|
|
|
|
|
|
|
use App\Core\DB\DB;
|
|
|
|
use App\Core\Event;
|
|
|
|
use App\Core\Form;
|
2021-08-18 19:14:24 +01:00
|
|
|
use App\Core\Modules\NoteHandlerPlugin;
|
2021-04-15 00:31:18 +01:00
|
|
|
use App\Core\Router\RouteLoader;
|
2020-09-04 15:18:58 +01:00
|
|
|
use App\Entity\Note;
|
|
|
|
use App\Util\Common;
|
2021-08-22 19:58:48 +01:00
|
|
|
use App\Util\Exception\InvalidFormException;
|
|
|
|
use App\Util\Exception\NoSuchNoteException;
|
2021-08-11 02:49:23 +01:00
|
|
|
use App\Util\Exception\RedirectException;
|
2021-04-15 01:57:29 +01:00
|
|
|
use App\Util\Formatting;
|
|
|
|
use App\Util\Nickname;
|
2020-09-04 15:18:58 +01:00
|
|
|
use Symfony\Component\Form\Extension\Core\Type\HiddenType;
|
|
|
|
use Symfony\Component\Form\Extension\Core\Type\SubmitType;
|
|
|
|
use Symfony\Component\HttpFoundation\Request;
|
2021-09-06 22:39:01 +01:00
|
|
|
use function App\Core\I18n\_m;
|
2020-09-04 15:18:58 +01:00
|
|
|
|
2021-08-18 19:14:24 +01:00
|
|
|
class Favourite extends NoteHandlerPlugin
|
2020-09-04 15:18:58 +01:00
|
|
|
{
|
2020-11-06 19:47:15 +00:00
|
|
|
/**
|
|
|
|
* HTML rendering event that adds the favourite form as a note
|
|
|
|
* action, if a user is logged in
|
2021-08-11 02:49:23 +01:00
|
|
|
*
|
|
|
|
* @param Request $request
|
|
|
|
* @param Note $note
|
|
|
|
* @param array $actions
|
|
|
|
*
|
|
|
|
* @throws RedirectException
|
2021-08-22 19:58:48 +01:00
|
|
|
* @throws InvalidFormException
|
|
|
|
* @throws NoSuchNoteException
|
2021-08-11 02:49:23 +01:00
|
|
|
*
|
|
|
|
* @return bool Event hook
|
2020-11-06 19:47:15 +00:00
|
|
|
*/
|
2021-04-30 01:51:59 +01:00
|
|
|
public function onAddNoteActions(Request $request, Note $note, array &$actions): bool
|
2020-09-04 15:18:58 +01:00
|
|
|
{
|
2021-08-11 02:49:23 +01:00
|
|
|
if (($user = Common::user()) === null) {
|
2020-11-06 19:47:15 +00:00
|
|
|
return Event::next;
|
|
|
|
}
|
|
|
|
|
2021-08-11 02:49:23 +01:00
|
|
|
// if note is favourited, "is_set" is 1
|
2021-08-11 18:42:15 +01:00
|
|
|
$opts = ['note_id' => $note->getId(), 'gsactor_id' => $user->getId()];
|
2021-09-05 15:56:32 +01:00
|
|
|
$is_set = DB::find('favourite', $opts) !== null;
|
2021-08-11 18:42:15 +01:00
|
|
|
$form_fav = Form::create([
|
2021-09-05 15:56:32 +01:00
|
|
|
['submit_favourite', SubmitType::class,
|
2021-08-11 18:42:15 +01:00
|
|
|
[
|
2021-09-06 22:39:01 +01:00
|
|
|
'label' => $is_set ? _m('Note already favourite!.') : _m('Favourite this note.'),
|
2021-08-11 18:42:15 +01:00
|
|
|
'attr' => [
|
2021-09-05 14:34:30 +01:00
|
|
|
'class' => $is_set ? 'note-actions-set' : 'note-actions-unset',
|
2021-08-11 18:42:15 +01:00
|
|
|
],
|
|
|
|
],
|
|
|
|
],
|
2021-09-05 15:56:32 +01:00
|
|
|
['note_id', HiddenType::class, ['data' => $note->getId()]],
|
|
|
|
["favourite-{$note->getId()}", HiddenType::class, ['data' => $is_set ? '1' : '0']],
|
2020-09-04 15:18:58 +01:00
|
|
|
]);
|
2020-11-06 19:47:15 +00:00
|
|
|
|
|
|
|
// Form handler
|
2021-08-11 02:49:23 +01:00
|
|
|
$ret = self::noteActionHandle(
|
2021-09-06 20:59:36 +01:00
|
|
|
$request, $form_fav, $note, "favourite-{$note->getId()}",
|
|
|
|
/**
|
|
|
|
* Called from form handler
|
|
|
|
*
|
|
|
|
* @param $note Note to be favourited
|
|
|
|
* @param $data Form input
|
|
|
|
*
|
|
|
|
* @throws RedirectException Always thrown in order to prevent accidental form re-submit from browser
|
|
|
|
*/
|
|
|
|
function ($note, $data) use ($opts) {
|
|
|
|
$favourite_note = DB::find('favourite', $opts);
|
|
|
|
if ($data["favourite-{$note->getId()}"] === '0' && $favourite_note === null) {
|
|
|
|
DB::persist(Entity\Favourite::create($opts));
|
|
|
|
DB::flush();
|
|
|
|
} else {
|
|
|
|
if ($data["favourite-{$note->getId()}"] === '1' && $favourite_note !== null) {
|
|
|
|
DB::remove($favourite_note);
|
|
|
|
DB::flush();
|
|
|
|
}
|
|
|
|
}
|
2021-08-11 02:49:23 +01:00
|
|
|
|
2021-09-06 20:59:36 +01:00
|
|
|
// Prevent accidental refreshes from resubmitting the form
|
|
|
|
throw new RedirectException();
|
2021-08-11 02:49:23 +01:00
|
|
|
|
2021-09-06 20:59:36 +01:00
|
|
|
return Event::stop;
|
|
|
|
});
|
2020-11-06 19:47:15 +00:00
|
|
|
|
2021-09-05 15:56:32 +01:00
|
|
|
if ($ret !== null) {
|
2020-09-10 23:28:11 +01:00
|
|
|
return $ret;
|
2020-09-04 15:18:58 +01:00
|
|
|
}
|
2020-11-06 19:47:15 +00:00
|
|
|
|
2021-08-11 18:42:15 +01:00
|
|
|
$actions[] = $form_fav->createView();
|
2020-09-04 15:18:58 +01:00
|
|
|
return Event::next;
|
|
|
|
}
|
2021-04-14 20:59:37 +01:00
|
|
|
|
2021-04-30 01:51:59 +01:00
|
|
|
public function onInsertLeftPanelLink(string $user_nickname, &$res): bool
|
2021-04-15 01:57:29 +01:00
|
|
|
{
|
2021-04-30 22:29:42 +01:00
|
|
|
$res[] = Formatting::twigRenderString(<<<END
|
2021-04-15 01:57:29 +01:00
|
|
|
<a href="{{ path("favourites", {'nickname' : user_nickname}) }}" class='hover-effect {{ active("favourites") }}'>Favourites</a>
|
|
|
|
<a href="{{ path("reverse_favourites", {'nickname' : user_nickname}) }}" class='hover-effect {{ active("reverse_favourites") }}'>Reverse Favs</a>
|
|
|
|
END, ['user_nickname' => $user_nickname]);
|
2021-04-30 01:51:59 +01:00
|
|
|
return Event::next;
|
2021-04-15 01:57:29 +01:00
|
|
|
}
|
|
|
|
|
2021-04-30 01:51:59 +01:00
|
|
|
public function onAddRoute(RouteLoader $r): bool
|
2021-04-14 20:59:37 +01:00
|
|
|
{
|
2021-04-15 01:57:29 +01:00
|
|
|
$r->connect('favourites', '/favourites/{nickname<' . Nickname::DISPLAY_FMT . '>}', [Controller\Favourite::class, 'favourites']);
|
|
|
|
$r->connect('reverse_favourites', '/reverse_favourites/{nickname<' . Nickname::DISPLAY_FMT . '>}', [Controller\Favourite::class, 'reverseFavourites']);
|
2021-04-14 20:59:37 +01:00
|
|
|
return Event::next;
|
|
|
|
}
|
2020-09-04 20:36:37 +01:00
|
|
|
}
|