CentrifugoBroadcaster::isPrivateChannel() - Code Metrics - Inspection of "Added private channel" - denis660/laravel-centrifugo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4)

unknown

created 2021-06-21 17:34 UTC

CentrifugoBroadcaster::isPrivateChannel() A

↳ Parent: CentrifugoBroadcaster

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

declare(strict_types=1);

namespace denis660\Centrifugo;

use Exception;
use Illuminate\Broadcasting\Broadcasters\Broadcaster;
use Illuminate\Broadcasting\BroadcastException;
use Illuminate\Support\Str;
use Symfony\Component\HttpKernel\Exception\HttpException;

class CentrifugoBroadcaster extends Broadcaster
{
    /**
     * The Centrifugo SDK instance.
     *
     * @var Contracts\CentrifugoInterface
     */
    protected $centrifugo;

    /**
     * Create a new broadcaster instance.
     *
     * @param Centrifugo $centrifugo
     */
    public function __construct(Centrifugo $centrifugo)
    {
        $this->centrifugo = $centrifugo;
    }

    /**
     * Authenticate the incoming request for a given channel.
     *
     * @param \Illuminate\Http\Request $request
     * @return mixed
     */
    public function auth($request)
    {
        if ($request->user()) {
            $client = $this->getClientFromRequest($request);
            $channels = $this->getChannelsFromRequest($request);

            $response = [];
            foreach ($channels as $channel) {
                $channelName = $this->getChannelName($channel);

                try {
                    $is_access_granted = $this->verifyUserCanAccessChannel($request, $channelName);
                } catch (HttpException $e) {
                    $is_access_granted = false;
                }
                if ($this->isPrivateChannel($channel)) {
                    $response['channels'][] = $this->makeResponseForPrivateChannel($is_access_granted, $client, $channel);
                    continue;
                }
                $response[$channel] = $this->makeResponseForClient($is_access_granted, $client);
            }
            return response()->json($response);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        } else {
            throw new HttpException(401);
        }
    }

    /**
     * Return the valid authentication response.
     *
     * @param \Illuminate\Http\Request $request
     * @param mixed $result
     * @return mixed
     */
    public function validAuthenticationResponse($request, $result)
    {
        return $result;
    }

    /**
     * Broadcast the given event.
     *
     * @param array $channels
     * @param string $event
     * @param array $payload
     * @return void
     */
    public function broadcast(array $channels, $event, array $payload = [])
    {
        $payload['event'] = $event;

        $response = $this->centrifugo->broadcast($this->formatChannels($channels), $payload);

        if (is_array($response) && !isset($response['error'])) {
            return;
        }

        throw new BroadcastException(
            $response['error'] instanceof Exception ? $response['error']->getMessage() : $response['error']
        );
    }

    /**
     * Get client from request.
     *
     * @param \Illuminate\Http\Request $request
     * @return string
     */
    private function getClientFromRequest($request)
    {
        return $request->get('client', '');
    }

    /**
     * Get channels from request.
     *
     * @param \Illuminate\Http\Request $request
     * @return array
     */
    private function getChannelsFromRequest($request)
    {
        $channels = $request->get('channels', []);

        return is_array($channels) ? $channels : [$channels];
    }

    /**
     * Get channel name without $ symbol (if present).
     *
     * @param string $channel
     * @return string
     */
    private function getChannelName(string $channel)
    {
        return (substr($channel, 0, 1) === '$') ? substr($channel, 1) : $channel;
    }

    /**
     * Make response for client, based on access rights.
     *
     * @param bool $access_granted
     * @param string $client
     * @return array
     */
    private function makeResponseForClient(bool $access_granted, string $client)
    {
        $info = [];

        return $access_granted ? [
            'sign' => $this->centrifugo->generateConnectionToken($client, 0, $info),
            'info' => $info,
        ] : [
            'status' => 403,
        ];
    }

    private function makeResponseForPrivateChannel(bool $access_granted, string $client, string $channel): array
    {
        return $access_granted ? [
            'channel' => $channel,
            'token' => $this->centrifugo->generatePrivateChannelToken($client, $channel),
        ] : [
            'status' => 403,
        ];
    }

    private function isPrivateChannel(string $channel): bool
    {
        return Str::contains($channel, "$");
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace denis660\Centrifugo;
6
7			use Exception;
8			use Illuminate\Broadcasting\Broadcasters\Broadcaster;
9			use Illuminate\Broadcasting\BroadcastException;
10			use Illuminate\Support\Str;
11			use Symfony\Component\HttpKernel\Exception\HttpException;
12
13			class CentrifugoBroadcaster extends Broadcaster
14			{
15			/**
16			* The Centrifugo SDK instance.
17			*
18			* @var Contracts\CentrifugoInterface
19			*/
20			protected $centrifugo;
21
22			/**
23			* Create a new broadcaster instance.
24			*
25			* @param Centrifugo $centrifugo
26			*/
27			public function __construct(Centrifugo $centrifugo)
28			{
29			$this->centrifugo = $centrifugo;
30			}
31
32			/**
33			* Authenticate the incoming request for a given channel.
34			*
35			* @param \Illuminate\Http\Request $request
36			* @return mixed
37			*/
38			public function auth($request)
39			{
40			if ($request->user()) {
41			$client = $this->getClientFromRequest($request);
42			$channels = $this->getChannelsFromRequest($request);
43
44			$response = [];
45			foreach ($channels as $channel) {
46			$channelName = $this->getChannelName($channel);
47
48			try {
49			$is_access_granted = $this->verifyUserCanAccessChannel($request, $channelName);
50			} catch (HttpException $e) {
51			$is_access_granted = false;
52			}
53			if ($this->isPrivateChannel($channel)) {
54			$response['channels'][] = $this->makeResponseForPrivateChannel($is_access_granted, $client, $channel);
55			continue;
56			}
57			$response[$channel] = $this->makeResponseForClient($is_access_granted, $client);
58			}
59			return response()->json($response);
			0 ignored issues – show Bug introduced 2021-01-12 17:16 UTC by Report Bug Copy Issue Report The method `json` does only exist in `Illuminate\Contracts\Routing\ResponseFactory`, but not in `Illuminate\Http\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
60			} else {
61			throw new HttpException(401);
62			}
63			}
64
65			/**
66			* Return the valid authentication response.
67			*
68			* @param \Illuminate\Http\Request $request
69			* @param mixed $result
70			* @return mixed
71			*/
72			public function validAuthenticationResponse($request, $result)
73			{
74			return $result;
75			}
76
77			/**
78			* Broadcast the given event.
79			*
80			* @param array $channels
81			* @param string $event
82			* @param array $payload
83			* @return void
84			*/
85			public function broadcast(array $channels, $event, array $payload = [])
86			{
87			$payload['event'] = $event;
88
89			$response = $this->centrifugo->broadcast($this->formatChannels($channels), $payload);
90
91			if (is_array($response) && !isset($response['error'])) {
92			return;
93			}
94
95			throw new BroadcastException(
96			$response['error'] instanceof Exception ? $response['error']->getMessage() : $response['error']
97			);
98			}
99
100			/**
101			* Get client from request.
102			*
103			* @param \Illuminate\Http\Request $request
104			* @return string
105			*/
106			private function getClientFromRequest($request)
107			{
108			return $request->get('client', '');
109			}
110
111			/**
112			* Get channels from request.
113			*
114			* @param \Illuminate\Http\Request $request
115			* @return array
116			*/
117			private function getChannelsFromRequest($request)
118			{
119			$channels = $request->get('channels', []);
120
121			return is_array($channels) ? $channels : [$channels];
122			}
123
124			/**
125			* Get channel name without $ symbol (if present).
126			*
127			* @param string $channel
128			* @return string
129			*/
130			private function getChannelName(string $channel)
131			{
132			return (substr($channel, 0, 1) === '$') ? substr($channel, 1) : $channel;
133			}
134
135			/**
136			* Make response for client, based on access rights.
137			*
138			* @param bool $access_granted
139			* @param string $client
140			* @return array
141			*/
142			private function makeResponseForClient(bool $access_granted, string $client)
143			{
144			$info = [];
145
146			return $access_granted ? [
147			'sign' => $this->centrifugo->generateConnectionToken($client, 0, $info),
148			'info' => $info,
149			] : [
150			'status' => 403,
151			];
152			}
153
154			private function makeResponseForPrivateChannel(bool $access_granted, string $client, string $channel): array
155			{
156			return $access_granted ? [
157			'channel' => $channel,
158			'token' => $this->centrifugo->generatePrivateChannelToken($client, $channel),
159			] : [
160			'status' => 403,
161			];
162			}
163
164			private function isPrivateChannel(string $channel): bool
165			{
166			return Str::contains($channel, "$");
167			}
168			}
169

denis660 / laravel-centrifugo

Scrutinizer GitHub App not installed

Pull Request — master (#4)

CentrifugoBroadcaster::isPrivateChannel() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like