PushNotificationController::sendGotify() - Code Metrics - Inspection of "User: Use push functionality in webbrowsers - refs..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#6421)

by Yannick

created 2025-07-07 13:38 UTC

PushNotificationController::sendGotify() B

↳ Parent: PushNotificationController

Complexity

Conditions	6
Paths	8

Size

Total Lines	59
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	6
eloc	38
c	2
b	0
f	0
nc	8
nop	0
dl	0
loc	59
rs	8.6897

How to fix Long Method

<?php

declare(strict_types=1);

/* For licensing terms, see /license.txt */

namespace Chamilo\CoreBundle\Controller;

use Chamilo\CoreBundle\Helpers\UserHelper;
use Chamilo\CoreBundle\Repository\Node\UserRepository;
use Chamilo\CoreBundle\Repository\PushSubscriptionRepository;
use Chamilo\CoreBundle\Settings\SettingsManager;
use Minishlink\WebPush\WebPush;
use Minishlink\WebPush\Subscription;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpClient\HttpClient;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Contracts\Translation\TranslatorInterface;

#[Route('/push-notifications')]
class PushNotificationController extends AbstractController
{
    public function __construct(
        private readonly PushSubscriptionRepository $subscriptionRepository,
        private readonly SettingsManager $settingsManager,
        private readonly UserHelper $userHelper,
        private readonly TranslatorInterface $translator
    ) {}

    #[Route('/send/{userId}', name: 'chamilo_core_push_notification_send', methods: ['GET'])]
    public function send(int $userId, UserRepository $userRepository, Request $request): JsonResponse
    {
        $currentUser = $this->userHelper->getCurrent();

        if (!$currentUser) {
            return new JsonResponse([
                'error' => $this->translator->trans('Current user not found.'),
            ], 403);
        }

        // Check permission (example: only admins)
        if (!$currentUser->isAdmin()) {
            return new JsonResponse([
                'error' => $this->translator->trans('You do not have permission to send notifications to other users.'),
            ], 403);
        }

        // Find target user
        $user = $userRepository->find($userId);

        if (!$user) {
            return new JsonResponse([
                'error' => $this->translator->trans("This user doesn't exist"),
            ], 404);
        }

        $settings = $this->settingsManager->getSetting('platform.push_notification_settings', true);

        if (empty($settings)) {
            return new JsonResponse([
                'error' => $this->translator->trans('No push notification setting configured.'),
            ], 500);
        }

        $decoded = json_decode($settings, true);

        $vapidPublicKey = $decoded['vapid_public_key'] ?? null;
        $vapidPrivateKey = $decoded['vapid_private_key'] ?? null;

        if (!$vapidPublicKey || !$vapidPrivateKey) {
            return new JsonResponse([
                'error' => $this->translator->trans('VAPID keys are missing in the configuration.'),
            ], 500);
        }

        $subscriptions = $this->subscriptionRepository->findByUser($user);

        if (empty($subscriptions)) {
            return new JsonResponse([
                'error' => $this->translator->trans('No push subscriptions found for this user.'),
            ], 404);
        }

        $webPush = new WebPush([
            'VAPID' => [
                'subject' => 'mailto:' . $user->getEmail(),
                'publicKey' => $vapidPublicKey,
                'privateKey' => $vapidPrivateKey,
            ],
        ]);

        $successes = [];
        $failures = [];

        foreach ($subscriptions as $subEntity) {
            try {
                $subscription = Subscription::create([
                    'endpoint' => $subEntity->getEndpoint(),
                    'publicKey' =>  $subEntity->getPublicKey(),
                    'authToken' => $subEntity->getAuthToken(),
                    'contentEncoding' => $subEntity->getContentEncoding() ?? 'aesgcm',
                ]);

                $payload = json_encode([
                    'title' => $this->translator->trans('Push notification test'),
                    'message' => $this->translator->trans("This is a test push notification from this platform to the user's browser or app."),
                    'url' => '/account/edit'
                ]);

                $report = $webPush->sendOneNotification(
                    $subscription,
                    $payload
                );

                if ($report->isSuccess()) {
                    $successes[] = $subEntity->getEndpoint();
                } else {
                    $failures[] = [
                        'endpoint' => $subEntity->getEndpoint(),
                        'reason' => $report->getReason(),
                        'statusCode' => $report->getResponse()->getStatusCode(),
                    ];
                }
            } catch (\Throwable $e) {
                $failures[] = [
                    'endpoint' => $subEntity->getEndpoint(),
                    'reason' => $e->getMessage(),
                ];
            }
        }

        return new JsonResponse([
            'message' => $this->translator->trans('Push notifications have been processed.'),
            'success' => $successes,
            'failures' => $failures,
        ]);
    }

    #[Route('/send-gotify', name: '_core_push_notification_send_gotify')]
    public function sendGotify(): JsonResponse
    {
        $user = $this->userHelper->getCurrent();

        if (!$user) {
            return new JsonResponse([
                'error' => $this->translator->trans('User not found.'),
            ], 403);
        }

        $settings = $this->settingsManager->getSetting('platform.push_notification_settings', true);

        if (empty($settings)) {
            return new JsonResponse([
                'error' => $this->translator->trans('No push notification settings configured.'),
            ], 500);
        }

        $decoded = json_decode($settings, true);

        $gotifyUrl = $decoded['gotify_url'] ?? null;
        $gotifyToken = $decoded['gotify_token'] ?? null;

        if (!$gotifyUrl || !$gotifyToken) {
            return new JsonResponse([
                'error' => $this->translator->trans('Gotify configuration is missing.'),
            ], 500);
        }

        // Prepare the payload for Gotify
        $payload = [
            'title' => $user->getEmail(),
            'message' => $this->translator->trans('This is a test notification sent to Gotify from this platform.'),
            'priority' => 5,
        ];

        $client = HttpClient::create();

        try {
            $response = $client->request('POST', rtrim($gotifyUrl, '/') . '/message', [
                'headers' => [
                    'X-Gotify-Key' => $gotifyToken,
                ],
                'json' => $payload,
            ]);

            $statusCode = $response->getStatusCode();
            $content = $response->toArray(false);

            return new JsonResponse([
                'message' => $this->translator->trans('Gotify notification has been sent.'),
                'status' => $statusCode,
                'response' => $content,
            ]);
        } catch (\Throwable $e) {
            return new JsonResponse([
                'error' => $this->translator->trans('Error sending notification to Gotify: ') . $e->getMessage(),
            ], 500);
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/* For licensing terms, see /license.txt */
6
7			namespace Chamilo\CoreBundle\Controller;
8
9			use Chamilo\CoreBundle\Helpers\UserHelper;
10			use Chamilo\CoreBundle\Repository\Node\UserRepository;
11			use Chamilo\CoreBundle\Repository\PushSubscriptionRepository;
12			use Chamilo\CoreBundle\Settings\SettingsManager;
13			use Minishlink\WebPush\WebPush;
14			use Minishlink\WebPush\Subscription;
15			use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
16			use Symfony\Component\HttpClient\HttpClient;
17			use Symfony\Component\HttpFoundation\JsonResponse;
18			use Symfony\Component\HttpFoundation\Request;
19			use Symfony\Component\Routing\Annotation\Route;
20			use Symfony\Contracts\Translation\TranslatorInterface;
21
22			#[Route('/push-notifications')]
23			class PushNotificationController extends AbstractController
24			{
25			public function __construct(
26			private readonly PushSubscriptionRepository $subscriptionRepository,
27			private readonly SettingsManager $settingsManager,
28			private readonly UserHelper $userHelper,
29			private readonly TranslatorInterface $translator
30			) {}
31
32			#[Route('/send/{userId}', name: 'chamilo_core_push_notification_send', methods: ['GET'])]
33			public function send(int $userId, UserRepository $userRepository, Request $request): JsonResponse
34			{
35			$currentUser = $this->userHelper->getCurrent();
36
37			if (!$currentUser) {
38			return new JsonResponse([
39			'error' => $this->translator->trans('Current user not found.'),
40			], 403);
41			}
42
43			// Check permission (example: only admins)
44			if (!$currentUser->isAdmin()) {
45			return new JsonResponse([
46			'error' => $this->translator->trans('You do not have permission to send notifications to other users.'),
47			], 403);
48			}
49
50			// Find target user
51			$user = $userRepository->find($userId);
52
53			if (!$user) {
54			return new JsonResponse([
55			'error' => $this->translator->trans("This user doesn't exist"),
56			], 404);
57			}
58
59			$settings = $this->settingsManager->getSetting('platform.push_notification_settings', true);
60
61			if (empty($settings)) {
62			return new JsonResponse([
63			'error' => $this->translator->trans('No push notification setting configured.'),
64			], 500);
65			}
66
67			$decoded = json_decode($settings, true);
68
69			$vapidPublicKey = $decoded['vapid_public_key'] ?? null;
70			$vapidPrivateKey = $decoded['vapid_private_key'] ?? null;
71
72			if (!$vapidPublicKey \|\| !$vapidPrivateKey) {
73			return new JsonResponse([
74			'error' => $this->translator->trans('VAPID keys are missing in the configuration.'),
75			], 500);
76			}
77
78			$subscriptions = $this->subscriptionRepository->findByUser($user);
79
80			if (empty($subscriptions)) {
81			return new JsonResponse([
82			'error' => $this->translator->trans('No push subscriptions found for this user.'),
83			], 404);
84			}
85
86			$webPush = new WebPush([
87			'VAPID' => [
88			'subject' => 'mailto:' . $user->getEmail(),
89			'publicKey' => $vapidPublicKey,
90			'privateKey' => $vapidPrivateKey,
91			],
92			]);
93
94			$successes = [];
95			$failures = [];
96
97			foreach ($subscriptions as $subEntity) {
98			try {
99			$subscription = Subscription::create([
100			'endpoint' => $subEntity->getEndpoint(),
101			'publicKey' => $subEntity->getPublicKey(),
102			'authToken' => $subEntity->getAuthToken(),
103			'contentEncoding' => $subEntity->getContentEncoding() ?? 'aesgcm',
104			]);
105
106			$payload = json_encode([
107			'title' => $this->translator->trans('Push notification test'),
108			'message' => $this->translator->trans("This is a test push notification from this platform to the user's browser or app."),
109			'url' => '/account/edit'
110			]);
111
112			$report = $webPush->sendOneNotification(
113			$subscription,
114			$payload
115			);
116
117			if ($report->isSuccess()) {
118			$successes[] = $subEntity->getEndpoint();
119			} else {
120			$failures[] = [
121			'endpoint' => $subEntity->getEndpoint(),
122			'reason' => $report->getReason(),
123			'statusCode' => $report->getResponse()->getStatusCode(),
124			];
125			}
126			} catch (\Throwable $e) {
127			$failures[] = [
128			'endpoint' => $subEntity->getEndpoint(),
129			'reason' => $e->getMessage(),
130			];
131			}
132			}
133
134			return new JsonResponse([
135			'message' => $this->translator->trans('Push notifications have been processed.'),
136			'success' => $successes,
137			'failures' => $failures,
138			]);
139			}
140
141			#[Route('/send-gotify', name: '_core_push_notification_send_gotify')]
142			public function sendGotify(): JsonResponse
143			{
144			$user = $this->userHelper->getCurrent();
145
146			if (!$user) {
147			return new JsonResponse([
148			'error' => $this->translator->trans('User not found.'),
149			], 403);
150			}
151
152			$settings = $this->settingsManager->getSetting('platform.push_notification_settings', true);
153
154			if (empty($settings)) {
155			return new JsonResponse([
156			'error' => $this->translator->trans('No push notification settings configured.'),
157			], 500);
158			}
159
160			$decoded = json_decode($settings, true);
161
162			$gotifyUrl = $decoded['gotify_url'] ?? null;
163			$gotifyToken = $decoded['gotify_token'] ?? null;
164
165			if (!$gotifyUrl \|\| !$gotifyToken) {
166			return new JsonResponse([
167			'error' => $this->translator->trans('Gotify configuration is missing.'),
168			], 500);
169			}
170
171			// Prepare the payload for Gotify
172			$payload = [
173			'title' => $user->getEmail(),
174			'message' => $this->translator->trans('This is a test notification sent to Gotify from this platform.'),
175			'priority' => 5,
176			];
177
178			$client = HttpClient::create();
179
180			try {
181			$response = $client->request('POST', rtrim($gotifyUrl, '/') . '/message', [
182			'headers' => [
183			'X-Gotify-Key' => $gotifyToken,
184			],
185			'json' => $payload,
186			]);
187
188			$statusCode = $response->getStatusCode();
189			$content = $response->toArray(false);
190
191			return new JsonResponse([
192			'message' => $this->translator->trans('Gotify notification has been sent.'),
193			'status' => $statusCode,
194			'response' => $content,
195			]);
196			} catch (\Throwable $e) {
197			return new JsonResponse([
198			'error' => $this->translator->trans('Error sending notification to Gotify: ') . $e->getMessage(),
199			], 500);
200			}
201			}
202			}
203

chamilo / chamilo-lms

Pull Request — master (#6421)

PushNotificationController::sendGotify() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like