[CORE][ActorController] Refactor actor related controllers (Actor, Subscribers, Subscriptions) to remove duplicated code

This commit is contained in:
Hugo Sales 2021-12-21 12:10:08 +00:00
parent 315fd95b94
commit 87aa9360a3
Signed by: someonewithpc
GPG Key ID: 7D0C7EAFC9D835A0
4 changed files with 132 additions and 100 deletions

View File

@ -23,7 +23,8 @@ declare(strict_types = 1);
namespace App\Controller;
use App\Core\Controller;
use App\Core\Cache;
use App\Core\Controller\ActorController;
use App\Core\DB\DB;
use App\Core\Router\Router;
use Symfony\Component\HttpFoundation\RedirectResponse;
@ -31,35 +32,30 @@ use function App\Core\I18n\_m;
use App\Util\Exception\ClientException;
use Symfony\Component\HttpFoundation\Request;
class Actor extends Controller
class Actor extends ActorController
{
/**
* Generic function that handles getting a representation for an actor from id
*/
private function ActorById(int $id, callable $handle)
public function actorViewId(Request $request, int $id)
{
$actor = DB::findOneBy('actor', ['id' => $id]);
if ($actor->getIsLocal()) {
return new RedirectResponse(Router::url('actor_view_nickname', ['nickname' => $actor->getNickname()]));
}
if (empty($actor)) {
throw new ClientException(_m('No such actor.'), 404);
} else {
return $handle($actor);
}
return $this->handleActorById(
$id,
fn ($actor) => [
'_template' => 'actor/view.html.twig',
'actor' => $actor
]
);
}
/**
* Generic function that handles getting a representation for an actor from nickname
*/
private function ActorByNickname(string $nickname, callable $handle)
public function actorViewNickname(Request $request, string $nickname)
{
$user = DB::findOneBy('local_user', ['nickname' => $nickname]);
$actor = DB::findOneBy('actor', ['id' => $user->getId()]);
if (empty($actor)) {
throw new ClientException(_m('No such actor.'), 404);
} else {
return $handle($actor);
}
return $this->handleActorByNickname(
$nickname,
fn ($actor) => [
'_template' => 'actor/view.html.twig',
'actor' => $actor,
'notes' => \App\Entity\Note::getAllNotesByActor($actor)
]
);
}
/**

View File

@ -23,49 +23,33 @@ declare(strict_types = 1);
namespace App\Controller;
use App\Core\Controller;
use App\Core\DB\DB;
use function App\Core\I18n\_m;
use App\Util\Exception\ClientException;
use App\Core\Controller\ActorController;
use Symfony\Component\HttpFoundation\Request;
class Subscribers extends Controller
/**
* Collection of an actor's subscribers
*/
class Subscribers extends ActorController
{
/**
* Generic function that handles getting a representation for an actor from id
*/
private function ActorById(int $id, callable $handle)
public function subscribersByActorId(Request $request, int $id)
{
$actor = DB::findOneBy('actor', ['id' => $id]);
if (empty($actor)) {
throw new ClientException(_m('No such actor.'), 404);
} else {
return $handle($actor);
}
}
/**
* Generic function that handles getting a representation for an actor from nickname
*/
private function ActorByNickname(string $nickname, callable $handle)
{
$user = DB::findOneBy('local_user', ['nickname' => $nickname]);
$actor = DB::findOneBy('actor', ['id' => $user->getId()]);
if (empty($actor)) {
throw new ClientException(_m('No such actor.'), 404);
} else {
return $handle($actor);
}
return $this->handleActorById(
$id,
fn ($actor) => [
'_template' => 'subscribers/view.html.twig',
'actor' => $actor,
],
);
}
/**
* Collection of an actor's subscribers
*/
public function ActorShowId(Request $request, int $id)
public function subscribersByActorNickname(Request $request, string $nickname)
{
return $this->ActorById($id, fn ($actor) => ['_template' => 'subscribers/view.html.twig', 'actor' => $actor]);
}
public function ActorShowNickname(Request $request, string $nickname)
{
return $this->ActorByNickname($nickname, fn ($actor) => ['_template' => 'subscribers/view.html.twig', 'actor' => $actor]);
return $this->handleActorByNickname(
$nickname,
fn ($actor) => [
'_template' => 'subscribers/view.html.twig',
'actor' => $actor,
],
);
}
}

View File

@ -23,49 +23,33 @@ declare(strict_types = 1);
namespace App\Controller;
use App\Core\Controller;
use App\Core\DB\DB;
use function App\Core\I18n\_m;
use App\Util\Exception\ClientException;
use App\Core\Controller\ActorController;
use Symfony\Component\HttpFoundation\Request;
class Subscriptions extends Controller
/**
* Collection of an actor's subscriptions
*/
class Subscriptions extends ActorController
{
/**
* Generic function that handles getting a representation for an actor from id
*/
private function ActorById(int $id, callable $handle)
public function subscriptionsByActorId(Request $request, int $id)
{
$actor = DB::findOneBy('actor', ['id' => $id]);
if (empty($actor)) {
throw new ClientException(_m('No such actor.'), 404);
} else {
return $handle($actor);
}
}
/**
* Generic function that handles getting a representation for an actor from nickname
*/
private function ActorByNickname(string $nickname, callable $handle)
{
$user = DB::findOneBy('local_user', ['nickname' => $nickname]);
$actor = DB::findOneBy('actor', ['id' => $user->getId()]);
if (empty($actor)) {
throw new ClientException(_m('No such actor.'), 404);
} else {
return $handle($actor);
}
return $this->handleActorById(
$id,
fn ($actor) => [
'_template' => 'subscriptions/view.html.twig',
'actor' => $actor,
],
);
}
/**
* Collection of an actor's subscriptions
*/
public function ActorShowId(Request $request, int $id)
public function subscriptionsByActorNickname(Request $request, string $nickname)
{
return $this->ActorById($id, fn ($actor) => ['_template' => 'subscriptions/view.html.twig', 'actor' => $actor]);
}
public function ActorShowNickname(Request $request, string $nickname)
{
return $this->ActorByNickname($nickname, fn ($actor) => ['_template' => 'subscriptions/view.html.twig', 'actor' => $actor]);
return $this->handleActorByNickname(
$nickname,
fn ($actor) => [
'_template' => 'subscriptions/view.html.twig',
'actor' => $actor,
],
);
}
}

View File

@ -0,0 +1,68 @@
<?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/>.
// }}}
/**
* Base class for feed controllers
*
* @package GNUsocial
* @category Controller
*
* @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
*/
namespace App\Core\Controller;
use App\Core\Controller;
abstract class ActorController extends Controller
{
/**
* Generic function that handles getting a representation for an actor from id
*/
protected function handleActorById(int $id, callable $handle)
{
$actor = DB::findOneBy('actor', ['id' => $id]);
if ($actor->getIsLocal()) {
return new RedirectResponse($actor->getUrl());
}
if (empty($actor)) {
throw new ClientException(_m('No such actor.'), 404);
} else {
return $handle($actor);
}
}
/**
* Generic function that handles getting a representation for an actor from nickname
*/
protected function handleActorByNickname(string $nickname, callable $handle)
{
$user = DB::findOneBy('local_user', ['nickname' => $nickname]);
$actor = DB::findOneBy('actor', ['id' => $user->getId()]);
if (empty($actor)) {
throw new ClientException(_m('No such actor.'), 404);
} else {
return $handle($actor);
}
}
}