2020-09-04 15:18:58 +01:00
|
|
|
<?php
|
|
|
|
|
2021-10-10 09:26:18 +01:00
|
|
|
declare(strict_types = 1);
|
|
|
|
|
2020-09-04 15:18:58 +01:00
|
|
|
// {{{ 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;
|
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;
|
2021-09-18 07:27:17 +01:00
|
|
|
use App\Core\Router\Router;
|
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\Nickname;
|
2020-09-04 15:18:58 +01:00
|
|
|
use Symfony\Component\HttpFoundation\Request;
|
|
|
|
|
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
|
|
|
*
|
2021-08-22 19:58:48 +01:00
|
|
|
* @throws InvalidFormException
|
|
|
|
* @throws NoSuchNoteException
|
2021-10-10 09:26:18 +01:00
|
|
|
* @throws RedirectException
|
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-10-21 20:14:22 +01:00
|
|
|
// If note is favourite, "is_set" is 1
|
2021-09-18 03:22:27 +01:00
|
|
|
$opts = ['note_id' => $note->getId(), 'actor_id' => $user->getId()];
|
2021-10-21 20:14:22 +01:00
|
|
|
$is_favourite = DB::find('favourite', $opts) !== null;
|
2020-11-06 19:47:15 +00:00
|
|
|
|
2021-10-21 20:14:22 +01:00
|
|
|
// Generating URL for favourite action route
|
|
|
|
$args = ['id' => $note->getId()];
|
|
|
|
$type = Router::ABSOLUTE_PATH;
|
|
|
|
$favourite_action_url = $is_favourite ?
|
|
|
|
Router::url('note_remove_favourite', $args, $type) :
|
|
|
|
Router::url('note_add_favourite', $args, $type);
|
2021-08-11 02:49:23 +01:00
|
|
|
|
2021-10-21 20:14:22 +01:00
|
|
|
$extra_classes = $is_favourite ? "note-actions-set" : "note-actions-unset";
|
|
|
|
$favourite_action = [
|
|
|
|
"url" => $favourite_action_url,
|
|
|
|
"classes" => "button-container favourite-button-container $extra_classes"
|
|
|
|
];
|
2021-08-11 02:49:23 +01:00
|
|
|
|
2021-10-21 20:14:22 +01:00
|
|
|
$actions[] = $favourite_action;
|
2020-09-04 15:18:58 +01:00
|
|
|
return Event::next;
|
|
|
|
}
|
2021-04-14 20:59:37 +01:00
|
|
|
|
2021-09-18 07:27:17 +01:00
|
|
|
public function onAddProfileNavigationItem(array $vars, array &$res): bool
|
2021-04-15 01:57:29 +01:00
|
|
|
{
|
2021-09-22 16:46:58 +01:00
|
|
|
$res[] = ['title' => 'Favourites', 'path' => Router::url('actor_favourites_nickname', ['nickname' => $vars['nickname']]), 'path_id' => 'actor_favourites_nickname'];
|
|
|
|
$res[] = ['title' => 'Reverse Favourites', 'path' => Router::url('actor_reverse_favourites_nickname', ['nickname' => $vars['nickname']]), 'path_id' => 'actor_reverse_favourites_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-10-21 20:14:22 +01:00
|
|
|
// Add/remove note to/from favourites
|
|
|
|
$r->connect(id: 'note_add_favourite', uri_path: '/note/{id<\d+>}/add_favourite', target: [Controller\Favourite::class, 'noteAddFavourite']);
|
|
|
|
$r->connect(id: 'note_remove_favourite', uri_path: '/note/{id<\d+>}/remove_favourite', target: [Controller\Favourite::class, 'noteRemoveFavourite']);
|
|
|
|
|
|
|
|
// View all favourites by actor id
|
2021-09-16 17:04:05 +01:00
|
|
|
$r->connect(id: 'actor_favourites_id', uri_path: '/actor/{id<\d+>}/favourites', target: [Controller\Favourite::class, 'favouritesByActorId']);
|
|
|
|
$r->connect(id: 'actor_reverse_favourites_id', uri_path: '/actor/{id<\d+>}/reverse_favourites', target: [Controller\Favourite::class, 'reverseFavouritesByActorId']);
|
2021-10-21 20:14:22 +01:00
|
|
|
|
|
|
|
// View all favourites by nickname
|
2021-10-10 09:26:18 +01:00
|
|
|
$r->connect(id: 'actor_favourites_nickname', uri_path: '/@{nickname<' . Nickname::DISPLAY_FMT . '>}/favourites', target: [Controller\Favourite::class, 'favouritesByActorNickname']);
|
2021-09-20 17:04:24 +01:00
|
|
|
$r->connect(id: 'actor_reverse_favourites_nickname', uri_path: '/@{nickname<' . Nickname::DISPLAY_FMT . '>}/reverse_favourites', target: [Controller\Favourite::class, 'reverseFavouritesByActorNickname']);
|
2021-04-14 20:59:37 +01:00
|
|
|
return Event::next;
|
|
|
|
}
|
2020-09-04 20:36:37 +01:00
|
|
|
}
|