From: jld3103 Date: Mon, 19 Jun 2023 05:48:03 +0000 (+0200) Subject: comments: Stop using a service alias for controller X-Git-Tag: v28.0.0beta1~877^2~1 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=4cd07d79a75e65865de7b2c8230ed2dd4b7eedef;p=nextcloud-server.git comments: Stop using a service alias for controller Signed-off-by: jld3103 --- diff --git a/apps/comments/composer/composer/autoload_classmap.php b/apps/comments/composer/composer/autoload_classmap.php index 6afc14d07a1..61def2ecc46 100644 --- a/apps/comments/composer/composer/autoload_classmap.php +++ b/apps/comments/composer/composer/autoload_classmap.php @@ -14,7 +14,7 @@ return array( 'OCA\\Comments\\AppInfo\\Application' => $baseDir . '/../lib/AppInfo/Application.php', 'OCA\\Comments\\Capabilities' => $baseDir . '/../lib/Capabilities.php', 'OCA\\Comments\\Collaboration\\CommentersSorter' => $baseDir . '/../lib/Collaboration/CommentersSorter.php', - 'OCA\\Comments\\Controller\\Notifications' => $baseDir . '/../lib/Controller/Notifications.php', + 'OCA\\Comments\\Controller\\NotificationsController' => $baseDir . '/../lib/Controller/NotificationsController.php', 'OCA\\Comments\\EventHandler' => $baseDir . '/../lib/EventHandler.php', 'OCA\\Comments\\Listener\\CommentsEntityEventListener' => $baseDir . '/../lib/Listener/CommentsEntityEventListener.php', 'OCA\\Comments\\Listener\\LoadAdditionalScripts' => $baseDir . '/../lib/Listener/LoadAdditionalScripts.php', diff --git a/apps/comments/composer/composer/autoload_static.php b/apps/comments/composer/composer/autoload_static.php index 0f832e1849b..9732ee9f4ca 100644 --- a/apps/comments/composer/composer/autoload_static.php +++ b/apps/comments/composer/composer/autoload_static.php @@ -7,14 +7,14 @@ namespace Composer\Autoload; class ComposerStaticInitComments { public static $prefixLengthsPsr4 = array ( - 'O' => + 'O' => array ( 'OCA\\Comments\\' => 13, ), ); public static $prefixDirsPsr4 = array ( - 'OCA\\Comments\\' => + 'OCA\\Comments\\' => array ( 0 => __DIR__ . '/..' . '/../lib', ), @@ -29,7 +29,7 @@ class ComposerStaticInitComments 'OCA\\Comments\\AppInfo\\Application' => __DIR__ . '/..' . '/../lib/AppInfo/Application.php', 'OCA\\Comments\\Capabilities' => __DIR__ . '/..' . '/../lib/Capabilities.php', 'OCA\\Comments\\Collaboration\\CommentersSorter' => __DIR__ . '/..' . '/../lib/Collaboration/CommentersSorter.php', - 'OCA\\Comments\\Controller\\Notifications' => __DIR__ . '/..' . '/../lib/Controller/Notifications.php', + 'OCA\\Comments\\Controller\\NotificationsController' => __DIR__ . '/..' . '/../lib/Controller/NotificationsController.php', 'OCA\\Comments\\EventHandler' => __DIR__ . '/..' . '/../lib/EventHandler.php', 'OCA\\Comments\\Listener\\CommentsEntityEventListener' => __DIR__ . '/..' . '/../lib/Listener/CommentsEntityEventListener.php', 'OCA\\Comments\\Listener\\LoadAdditionalScripts' => __DIR__ . '/..' . '/../lib/Listener/LoadAdditionalScripts.php', diff --git a/apps/comments/lib/AppInfo/Application.php b/apps/comments/lib/AppInfo/Application.php index 527c5d99fc3..bfd66c43ecd 100644 --- a/apps/comments/lib/AppInfo/Application.php +++ b/apps/comments/lib/AppInfo/Application.php @@ -28,7 +28,6 @@ namespace OCA\Comments\AppInfo; use Closure; use OCA\Comments\Capabilities; -use OCA\Comments\Controller\Notifications; use OCA\Comments\EventHandler; use OCA\Comments\Listener\CommentsEntityEventListener; use OCA\Comments\Listener\LoadAdditionalScripts; @@ -58,8 +57,6 @@ class Application extends App implements IBootstrap { public function register(IRegistrationContext $context): void { $context->registerCapability(Capabilities::class); - $context->registerServiceAlias('NotificationsController', Notifications::class); - $context->registerEventListener( LoadAdditionalScriptsEvent::class, LoadAdditionalScripts::class diff --git a/apps/comments/lib/Controller/Notifications.php b/apps/comments/lib/Controller/Notifications.php deleted file mode 100644 index ba61a0d33cd..00000000000 --- a/apps/comments/lib/Controller/Notifications.php +++ /dev/null @@ -1,126 +0,0 @@ - - * - * @author Arthur Schiwon - * @author Christoph Wurst - * @author Joas Schilling - * - * @license GNU AGPL version 3 or any later version - * - * This program 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. - * - * This program 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 this program. If not, see . - * - */ -namespace OCA\Comments\Controller; - -use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\NotFoundResponse; -use OCP\AppFramework\Http\RedirectResponse; -use OCP\AppFramework\Http\Response; -use OCP\Comments\IComment; -use OCP\Comments\ICommentsManager; -use OCP\Files\IRootFolder; -use OCP\IRequest; -use OCP\IURLGenerator; -use OCP\IUser; -use OCP\IUserSession; -use OCP\Notification\IManager; - -/** - * Class Notifications - * - * @package OCA\Comments\Controller - */ -class Notifications extends Controller { - - protected IRootFolder $rootFolder; - protected ICommentsManager $commentsManager; - protected IURLGenerator $urlGenerator; - protected IManager $notificationManager; - protected IUserSession $userSession; - - /** - * Notifications constructor. - */ - public function __construct( - string $appName, - IRequest $request, - ICommentsManager $commentsManager, - IRootFolder $rootFolder, - IURLGenerator $urlGenerator, - IManager $notificationManager, - IUserSession $userSession - ) { - parent::__construct($appName, $request); - $this->commentsManager = $commentsManager; - $this->rootFolder = $rootFolder; - $this->urlGenerator = $urlGenerator; - $this->notificationManager = $notificationManager; - $this->userSession = $userSession; - } - - /** - * @PublicPage - * @NoCSRFRequired - */ - public function view(string $id): Response { - $currentUser = $this->userSession->getUser(); - if (!$currentUser instanceof IUser) { - return new RedirectResponse( - $this->urlGenerator->linkToRoute('core.login.showLoginForm', [ - 'redirect_url' => $this->urlGenerator->linkToRoute( - 'comments.Notifications.view', - ['id' => $id] - ), - ]) - ); - } - - try { - $comment = $this->commentsManager->get($id); - if ($comment->getObjectType() !== 'files') { - return new NotFoundResponse(); - } - $userFolder = $this->rootFolder->getUserFolder($currentUser->getUID()); - $files = $userFolder->getById((int)$comment->getObjectId()); - - $this->markProcessed($comment, $currentUser); - - if (empty($files)) { - return new NotFoundResponse(); - } - - $url = $this->urlGenerator->linkToRouteAbsolute( - 'files.viewcontroller.showFile', - [ 'fileid' => $comment->getObjectId() ] - ); - - return new RedirectResponse($url); - } catch (\Exception $e) { - return new NotFoundResponse(); - } - } - - /** - * Marks the notification about a comment as processed - */ - protected function markProcessed(IComment $comment, IUser $currentUser): void { - $notification = $this->notificationManager->createNotification(); - $notification->setApp('comments') - ->setObject('comment', $comment->getId()) - ->setSubject('mention') - ->setUser($currentUser->getUID()); - $this->notificationManager->markProcessed($notification); - } -} diff --git a/apps/comments/lib/Controller/NotificationsController.php b/apps/comments/lib/Controller/NotificationsController.php new file mode 100644 index 00000000000..41a9541a684 --- /dev/null +++ b/apps/comments/lib/Controller/NotificationsController.php @@ -0,0 +1,126 @@ + + * + * @author Arthur Schiwon + * @author Christoph Wurst + * @author Joas Schilling + * + * @license GNU AGPL version 3 or any later version + * + * This program 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. + * + * This program 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 this program. If not, see . + * + */ +namespace OCA\Comments\Controller; + +use OCP\AppFramework\Controller; +use OCP\AppFramework\Http\NotFoundResponse; +use OCP\AppFramework\Http\RedirectResponse; +use OCP\AppFramework\Http\Response; +use OCP\Comments\IComment; +use OCP\Comments\ICommentsManager; +use OCP\Files\IRootFolder; +use OCP\IRequest; +use OCP\IURLGenerator; +use OCP\IUser; +use OCP\IUserSession; +use OCP\Notification\IManager; + +/** + * Class NotificationsController + * + * @package OCA\Comments\Controller + */ +class NotificationsController extends Controller { + + protected IRootFolder $rootFolder; + protected ICommentsManager $commentsManager; + protected IURLGenerator $urlGenerator; + protected IManager $notificationManager; + protected IUserSession $userSession; + + /** + * NotificationsController constructor. + */ + public function __construct( + string $appName, + IRequest $request, + ICommentsManager $commentsManager, + IRootFolder $rootFolder, + IURLGenerator $urlGenerator, + IManager $notificationManager, + IUserSession $userSession + ) { + parent::__construct($appName, $request); + $this->commentsManager = $commentsManager; + $this->rootFolder = $rootFolder; + $this->urlGenerator = $urlGenerator; + $this->notificationManager = $notificationManager; + $this->userSession = $userSession; + } + + /** + * @PublicPage + * @NoCSRFRequired + */ + public function view(string $id): Response { + $currentUser = $this->userSession->getUser(); + if (!$currentUser instanceof IUser) { + return new RedirectResponse( + $this->urlGenerator->linkToRoute('core.login.showLoginForm', [ + 'redirect_url' => $this->urlGenerator->linkToRoute( + 'comments.Notifications.view', + ['id' => $id] + ), + ]) + ); + } + + try { + $comment = $this->commentsManager->get($id); + if ($comment->getObjectType() !== 'files') { + return new NotFoundResponse(); + } + $userFolder = $this->rootFolder->getUserFolder($currentUser->getUID()); + $files = $userFolder->getById((int)$comment->getObjectId()); + + $this->markProcessed($comment, $currentUser); + + if (empty($files)) { + return new NotFoundResponse(); + } + + $url = $this->urlGenerator->linkToRouteAbsolute( + 'files.viewcontroller.showFile', + [ 'fileid' => $comment->getObjectId() ] + ); + + return new RedirectResponse($url); + } catch (\Exception $e) { + return new NotFoundResponse(); + } + } + + /** + * Marks the notification about a comment as processed + */ + protected function markProcessed(IComment $comment, IUser $currentUser): void { + $notification = $this->notificationManager->createNotification(); + $notification->setApp('comments') + ->setObject('comment', $comment->getId()) + ->setSubject('mention') + ->setUser($currentUser->getUID()); + $this->notificationManager->markProcessed($notification); + } +} diff --git a/apps/comments/tests/Unit/AppInfo/ApplicationTest.php b/apps/comments/tests/Unit/AppInfo/ApplicationTest.php index 6e3658c0e5b..a0ec722b368 100644 --- a/apps/comments/tests/Unit/AppInfo/ApplicationTest.php +++ b/apps/comments/tests/Unit/AppInfo/ApplicationTest.php @@ -51,11 +51,8 @@ class ApplicationTest extends TestCase { $app = new Application(); $c = $app->getContainer(); - // assert service instances in the container are properly setup - $s = $c->get('NotificationsController'); - $this->assertInstanceOf('OCA\Comments\Controller\Notifications', $s); - $services = [ + 'OCA\Comments\Controller\NotificationsController', 'OCA\Comments\Activity\Filter', 'OCA\Comments\Activity\Listener', 'OCA\Comments\Activity\Provider', diff --git a/apps/comments/tests/Unit/Controller/NotificationsTest.php b/apps/comments/tests/Unit/Controller/NotificationsTest.php index c21101030e8..4ccb553739b 100644 --- a/apps/comments/tests/Unit/Controller/NotificationsTest.php +++ b/apps/comments/tests/Unit/Controller/NotificationsTest.php @@ -25,7 +25,7 @@ */ namespace OCA\Comments\Tests\Unit\Controller; -use OCA\Comments\Controller\Notifications; +use OCA\Comments\Controller\NotificationsController; use OCP\AppFramework\Http\NotFoundResponse; use OCP\AppFramework\Http\RedirectResponse; use OCP\Comments\IComment; @@ -43,7 +43,7 @@ use OCP\Notification\INotification; use Test\TestCase; class NotificationsTest extends TestCase { - /** @var Notifications */ + /** @var NotificationsController */ protected $notificationsController; /** @var ICommentsManager|\PHPUnit\Framework\MockObject\MockObject */ @@ -70,7 +70,7 @@ class NotificationsTest extends TestCase { $this->notificationManager = $this->createMock(IManager::class); $this->urlGenerator = $this->createMock(IURLGenerator::class); - $this->notificationsController = new Notifications( + $this->notificationsController = new NotificationsController( 'comments', $this->createMock(IRequest::class), $this->commentsManager,