Session::fetch() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/square..." - squareetlabs/LaravelOpenVidu - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c8e4bc...17399e )

by Jacobo

created 2020-09-18 17:45 UTC

Session::fetch() A

↳ Parent: Session

Complexity

Conditions	3
Paths	3

Size

Total Lines	18
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
cc	3
eloc	12
c	3
b	0
f	1
nc	3
nop	0
dl	0
loc	18
rs	9.8666

<?php

namespace SquareetLabs\LaravelOpenVidu;

use Exception;
use GuzzleHttp\Client;
use GuzzleHttp\RequestOptions;
use Illuminate\Support\Facades\Cache;
use JsonSerializable;
use SquareetLabs\LaravelOpenVidu\Builders\ConnectionBuilder;
use SquareetLabs\LaravelOpenVidu\Builders\PublisherBuilder;
use SquareetLabs\LaravelOpenVidu\Builders\SessionPropertiesBuilder;
use SquareetLabs\LaravelOpenVidu\Builders\SubscriberBuilder;
use SquareetLabs\LaravelOpenVidu\Enums\MediaMode;
use SquareetLabs\LaravelOpenVidu\Enums\OpenViduRole;
use SquareetLabs\LaravelOpenVidu\Enums\OutputMode;
use SquareetLabs\LaravelOpenVidu\Enums\RecordingLayout;
use SquareetLabs\LaravelOpenVidu\Enums\RecordingMode;
use SquareetLabs\LaravelOpenVidu\Enums\Uri;
use SquareetLabs\LaravelOpenVidu\Exceptions\OpenViduConnectionNotFoundException;
use SquareetLabs\LaravelOpenVidu\Exceptions\OpenViduException;
use SquareetLabs\LaravelOpenVidu\Exceptions\OpenViduProblemWithBodyParameterException;
use SquareetLabs\LaravelOpenVidu\Exceptions\OpenViduSessionNotFoundException;
use SquareetLabs\LaravelOpenVidu\Exceptions\OpenViduStreamCantCloseException;
use SquareetLabs\LaravelOpenVidu\Exceptions\OpenViduTokenCantCreateException;

/**
 * Class Session
 * @package SquareetLabs\LaravelOpenVidu
 */
class Session implements JsonSerializable
{
    /** @var  Client */
    private $client;

    /** @var  string */
    private $sessionId;

    /** @var SessionProperties */
    private $properties;

    /** @var bool */
    private $recording;

    /** @var string */
    private $lastRecordingId;

    /** @var array */
    private $activeConnections = [];

    /** @var int */
    private $createdAt;

    /**
     * Session constructor.
     * @param  Client  $client
     * @param  SessionProperties|null  $properties
     * @throws OpenViduException
     */
    public function __construct(Client $client, ?SessionProperties $properties = null)
    {
        $this->client = $client;
        $this->properties = $properties ? $properties : new SessionProperties(MediaMode::ROUTED, RecordingMode::MANUAL, OutputMode::COMPOSED, RecordingLayout::BEST_FIT);
        $this->sessionId = $this->getSessionId();
    }

    /**
     * @return string
     * @throws OpenViduException
     */
    public function getSessionId()
    {
        if (empty($this->sessionId)) {
            $response = $this->client->post(Uri::SESSION_URI, [
                RequestOptions::JSON => $this->properties->toArray()
            ]);
            switch ($response->getStatusCode()) {
                case 200:
                    return json_decode($response->getBody()->getContents())->id;
                case 400:
                    throw  new OpenViduProblemWithBodyParameterException();
                case 409:
                    return $this->properties->getCustomSessionId();
                default:
                    throw new OpenViduException("Invalid response status code ".$response->getStatusCode(), $response->getStatusCode());
            }
        } else {
            return $this->sessionId;
        }
    }

    /**
     ** Gets a new token associated to Session object with default values for
     * {@see TokenOptions}. This always translates into a
     * new request to OpenVidu Server
     *
     * @param  TokenOptions|null  $tokenOptions
     * @return string The generated token
     * @throws OpenViduException
     */
    public function generateToken(?TokenOptions $tokenOptions = null)
    {
        $this->getSessionId();
        try {
            if (!$tokenOptions) {
                $tokenOptions = new TokenOptions(OpenViduRole::PUBLISHER);
            }
            $response = $this->client->post(Uri::TOKEN_URI, [
                RequestOptions::JSON => array_merge($tokenOptions->toArray(), ['session' => $this->sessionId])
            ]);
            switch ($response->getStatusCode()) {
                case 200:
                    return json_decode($response->getBody()->getContents());
                case 400:
                    throw new OpenViduProblemWithBodyParameterException();
                case 404:
                    throw new OpenViduSessionNotFoundException();
                default:
                    throw new OpenViduException("Invalid response status code ".$response->getStatusCode(), $response->getStatusCode());
            }
        } catch (Exception $e) {
            throw new OpenViduTokenCantCreateException($e->getMessage(), $e);
        }
    }

    /**
     * Gracefully closes the Session: unpublishes all streams and evicts every
     * participant
     * @throws OpenViduException
     */
    public function close()
    {
        $response = $this->client->delete(Uri::SESSION_URI.'/'.$this->sessionId);
        switch ($response->getStatusCode()) {
            case 204:
                Cache::store('openvidu')->forget($this->sessionId);
                return true;
            case 404:
                throw new OpenViduSessionNotFoundException();
            default:
                throw new OpenViduException("Invalid response status code ".$response->getStatusCode(), $response->getStatusCode());
        }
    }

    /**
     * Updates every property of the Session with the current status it has in
     * OpenVidu Server. This is especially useful for getting the list of active
     * connections to the Session
     * ({@see getActiveConnections()}) and use
     * those values to call
     * {@see forceDisconnect(Connection)} or
     * {@link forceUnpublish(Publisher)}. <br>
     *
     * To update every Session object owned by OpenVidu object, call
     * {@see fetch()}
     *
     * @return bool true if the Session status has changed with respect to the server,
     * false if not. This applies to any property or sub-property of the object
     */

    public function fetch()
    {
        $response = $this->client->get(Uri::SESSION_URI.'/'.$this->sessionId, [
            'headers' => [
                'Content-Type' => 'application/x-www-form-urlencoded',
                'Accept' => 'application/json',
            ]
        ]);
        if ($response->getStatusCode() === 200) {
            $beforeJSON = $this->toJson();
            $this->fromJson($response->getBody()->getContents());
            $afterJSON = $this->toJson();
            if ($beforeJSON !== $afterJSON) {
                Cache::store('openvidu')->update($this->sessionId, $this->toJson());
                return true;
            }
        }
        return false;
    }

    /**
     * Convert the model instance to JSON.
     *
     * @param  int  $options
     * @return string
     *
     */
    public function toJson($options = 0): string
    {
        $json = json_encode($this->jsonSerialize(), $options);
        return $json;
    }

    /**
     * Specify data which should be serialized to JSON
     * @link https://php.net/manual/en/jsonserializable.jsonserialize.php
     * @return mixed data which can be serialized by <b>json_encode</b>,
     * which is a value of any type other than a resource.
     * @since 5.4.0
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }

    /**
     * Convert the model instance to an array.
     *
     * @return array
     */
    public function toArray(): array
    {
        $array = ['sessionId' => $this->sessionId, 'properties' => $this->properties->toArray(), 'recording' => $this->recording, 'createdAt' => $this->createdAt];
        foreach ($this->activeConnections as $connection) {
            $array['activeConnections'][] = $connection->toArray();
        }

        foreach ($array as $key => $value) {
            if (is_null($value) || $value == '') {
                unset($array[$key]);
            }
        }
        return $array;
    }

    /**
     * @param  string  $json
     * @return Session
     */
    public function fromJson(string $json): Session
    {
        return $this->fromArray(json_decode($json, true));
    }

    /**
     * @param  array  $sessionArray
     * @return Session
     */
    public function fromArray(array $sessionArray): Session
    {
        $this->sessionId = $sessionArray['sessionId'];
        $this->createdAt = $sessionArray['createdAt'] ?? null;
        $this->recording = $sessionArray['recording'] ?? null;

        if (array_key_exists('properties', $sessionArray)) {
            $this->properties = SessionPropertiesBuilder::build($sessionArray['properties']);
        }

        $this->activeConnections = [];
        if (array_key_exists('connections', $sessionArray)) {
            foreach ($sessionArray['connections']['content'] as $connection) {
                $publishers = [];
                $ensure = $connection['content'] ?? $connection;
                foreach ($ensure['publishers'] as $publisher) {
                    $publishers[] = PublisherBuilder::build($publisher);
                }
                $subscribers = [];

                foreach ($ensure['subscribers'] as $subscriber) {
                    $subscribers[] = SubscriberBuilder::build($subscriber);
                }
                $this->activeConnections[] = ConnectionBuilder::build($ensure, $publishers, $subscribers);
            }
        }
        return $this;
    }

    /**
     * Forces the user with Connection `connectionId` to leave the session. OpenVidu Browser will trigger the proper events on the client-side
     * (`streamDestroyed`, `connectionDestroyed`, `sessionDisconnected`) with reason set to `"forceDisconnectByServer"`
     *
     *
     * @param  string  $connectionId
     * @throws OpenViduException
     */
    public function forceDisconnect(string $connectionId)
    {
        $response = $this->client->delete(Uri::SESSION_URI.'/'.$this->sessionId.'/connection/'.$connectionId, [
            'headers' => [
                'Content-Type' => 'application/x-www-form-urlencoded',
                'Accept' => 'application/json',
            ]
        ]);
        switch ($response->getStatusCode()) {
            case 204:
                $this->leaveSession($connectionId);
                Cache::store('openvidu')->update($this->sessionId, $this->toJson());
                break;
            case 400:
                throw new OpenViduSessionNotFoundException();
            case 404:
                throw new OpenViduConnectionNotFoundException();
            default:
                throw new OpenViduException("Invalid response status code ".$response->getStatusCode(), $response->getStatusCode());
        }
    }

    /**
     * Get `connection` parameter from activeConnections array {@see Connection::getConnectionId()} for getting each `connectionId` property).
     * Remember to call {@see fetch()} before to fetch the current actual properties of the Session from OpenVidu Server
     * @param  string  $connectionId
     */

    private function leaveSession(string $connectionId)
    {
        $connectionClosed = null;
        $this->activeConnections = array_filter($this->activeConnections, function (Connection $connection) use (&$connectionClosed, $connectionId) {
            if ($connection->getConnectionId() !== $connectionId) {
                return true;
            }
            $connectionClosed = $connection;
            return false;
        });
        if ($connectionClosed != null) {
            foreach ($connectionClosed->getPublishers() as $publisher) {
                foreach ($this->activeConnections as $con) {
                    $con->unsubscribe($publisher->getStreamId());
                }
            }
        }
    }


    /**
     * Allows publish a Stream (For now can only be IPCAM).
     * Remember to call
     * {@see fetch()} before to fetch the current
     * actual properties of the Session from OpenVidu Server
     *
     * @param  IPCameraOptions  $IPCameraOptions
     * @return Connection
     * @throws OpenViduException
     * @throws OpenViduSessionNotFoundException
     */
    public function publish(IPCameraOptions $IPCameraOptions)
    {
        $response = $this->client->post(Uri::SESSION_URI.'/'.$this->sessionId.'/connection', [
            RequestOptions::JSON => array_merge($IPCameraOptions->toArray())
        ]);
        switch ($response->getStatusCode()) {
            case 200:
                return json_decode($response->getBody()->getContents());
            case 400:
                throw new OpenViduProblemWithBodyParameterException();
            case 404:
                throw new OpenViduSessionNotFoundException();
            default:
                throw new OpenViduException("Unexpected error when publishing the IP camera stream into the session.");
        }
    }

    /**
     * Forces some user to unpublish a Stream. OpenVidu Browser will trigger the
     * proper events on the client-side (<code>streamDestroyed</code>) with reason
     * set to "forceUnpublishByServer". <br>
     *
     * You can get <code>streamId</code> parameter with
     * {@see Session::getActiveConnections()} and then for
     * each Connection you can call
     * {@see  Connection::getPublishers()}. Finally
     * {@see Publisher::getStreamId()}) will give you the
     * <code>streamId</code>. Remember to call
     * {@see fetch()} before to fetch the current
     * actual properties of the Session from OpenVidu Server
     *
     * @param  string  $streamId
     * @return void
     * @throws OpenViduConnectionNotFoundException
     * @throws OpenViduException
     * @throws OpenViduSessionNotFoundException
     */
    public function forceUnpublish(string $streamId)
    {
        $response = $this->client->delete(Uri::SESSION_URI.'/'.$this->sessionId.'/stream/'.$streamId, [
            'headers' => [
                'Content-Type' => 'application/x-www-form-urlencoded',
                'Accept' => 'application/json',
            ]
        ]);
        switch ($response->getStatusCode()) {
            case 204:
                foreach ($this->activeConnections as $connection) {
                    $connection->unpublish($streamId);
                    $connection->unsubscribe($streamId);
                }
                Cache::store('openvidu')->update($this->sessionId, $this->toJson());
                break;
            case 400:
                throw new OpenViduSessionNotFoundException();
            case 404:
                throw new OpenViduConnectionNotFoundException();
            case 405:
                throw new OpenViduStreamCantCloseException("You cannot directly delete the stream of an IPCAM participant");
            default:
                throw new OpenViduException("Invalid response status code ".$response->getStatusCode(), $response->getStatusCode());
        }
    }

    /**
     * Returns the list of active connections to the session. <strong>This value
     * will remain unchanged since the last time method
     * {@see fetch()} was called</strong>.
     * Exceptions to this rule are:
     * <ul>
     * <li>Calling {@see Session::forceUnpublish(string)}
     * updates each affected Connection status</li>
     * <li>Calling {@see Session::forceDisconnect(string)}
     * updates each affected Connection status</li>
     * </ul>
     * <br>
     * To get the list of active connections with their current actual value, you
     * must call first {@see Session::fetch()} and then
     * {@see Session::getActiveConnections()}
     */
    public function getActiveConnections(): array
    {
        return $this->activeConnections;
    }

    /**
     * Returns whether the session is being recorded or not
     */
    public function isBeingRecorded(): bool
    {
        return !!$this->recording;
    }

    /**
     * Set value
     * @param  bool  $recording
     */
    public function setIsBeingRecorded(bool $recording)
    {
        $this->recording = $recording;
        Cache::store('openvidu')->update($this->sessionId, $this->toJson());
    }

    public function getLastRecordingId()
    {
        return $this->lastRecordingId;
    }

    public function setLastRecordingId(string $lastRecordingId)
    {
        $this->lastRecordingId = $lastRecordingId;
        Cache::store('openvidu')->update($this->sessionId, $this->toJson());
    }

    /**
     * @return string
     * @throws OpenViduException
     */
    public function __toString(): string
    {
        return $this->getSessionId();
    }
}


1			<?php
2
3			namespace SquareetLabs\LaravelOpenVidu;
4
5			use Exception;
6			use GuzzleHttp\Client;
7			use GuzzleHttp\RequestOptions;
8			use Illuminate\Support\Facades\Cache;
9			use JsonSerializable;
10			use SquareetLabs\LaravelOpenVidu\Builders\ConnectionBuilder;
11			use SquareetLabs\LaravelOpenVidu\Builders\PublisherBuilder;
12			use SquareetLabs\LaravelOpenVidu\Builders\SessionPropertiesBuilder;
13			use SquareetLabs\LaravelOpenVidu\Builders\SubscriberBuilder;
14			use SquareetLabs\LaravelOpenVidu\Enums\MediaMode;
15			use SquareetLabs\LaravelOpenVidu\Enums\OpenViduRole;
16			use SquareetLabs\LaravelOpenVidu\Enums\OutputMode;
17			use SquareetLabs\LaravelOpenVidu\Enums\RecordingLayout;
18			use SquareetLabs\LaravelOpenVidu\Enums\RecordingMode;
19			use SquareetLabs\LaravelOpenVidu\Enums\Uri;
20			use SquareetLabs\LaravelOpenVidu\Exceptions\OpenViduConnectionNotFoundException;
21			use SquareetLabs\LaravelOpenVidu\Exceptions\OpenViduException;
22			use SquareetLabs\LaravelOpenVidu\Exceptions\OpenViduProblemWithBodyParameterException;
23			use SquareetLabs\LaravelOpenVidu\Exceptions\OpenViduSessionNotFoundException;
24			use SquareetLabs\LaravelOpenVidu\Exceptions\OpenViduStreamCantCloseException;
25			use SquareetLabs\LaravelOpenVidu\Exceptions\OpenViduTokenCantCreateException;
26
27			/**
28			* Class Session
29			* @package SquareetLabs\LaravelOpenVidu
30			*/
31			class Session implements JsonSerializable
32			{
33			/** @var Client */
34			private $client;
35
36			/** @var string */
37			private $sessionId;
38
39			/** @var SessionProperties */
40			private $properties;
41
42			/** @var bool */
43			private $recording;
44
45			/** @var string */
46			private $lastRecordingId;
47
48			/** @var array */
49			private $activeConnections = [];
50
51			/** @var int */
52			private $createdAt;
53
54			/**
55			* Session constructor.
56			* @param Client $client
57			* @param SessionProperties\|null $properties
58			* @throws OpenViduException
59			*/
60			public function __construct(Client $client, ?SessionProperties $properties = null)
61			{
62			$this->client = $client;
63			$this->properties = $properties ? $properties : new SessionProperties(MediaMode::ROUTED, RecordingMode::MANUAL, OutputMode::COMPOSED, RecordingLayout::BEST_FIT);
64			$this->sessionId = $this->getSessionId();
65			}
66
67			/**
68			* @return string
69			* @throws OpenViduException
70			*/
71			public function getSessionId()
72			{
73			if (empty($this->sessionId)) {
74			$response = $this->client->post(Uri::SESSION_URI, [
75			RequestOptions::JSON => $this->properties->toArray()
76			]);
77			switch ($response->getStatusCode()) {
78			case 200:
79			return json_decode($response->getBody()->getContents())->id;
80			case 400:
81			throw new OpenViduProblemWithBodyParameterException();
82			case 409:
83			return $this->properties->getCustomSessionId();
84			default:
85			throw new OpenViduException("Invalid response status code ".$response->getStatusCode(), $response->getStatusCode());
86			}
87			} else {
88			return $this->sessionId;
89			}
90			}
91
92			/**
93			** Gets a new token associated to Session object with default values for
94			* {@see TokenOptions}. This always translates into a
95			* new request to OpenVidu Server
96			*
97			* @param TokenOptions\|null $tokenOptions
98			* @return string The generated token
99			* @throws OpenViduException
100			*/
101			public function generateToken(?TokenOptions $tokenOptions = null)
102			{
103			$this->getSessionId();
104			try {
105			if (!$tokenOptions) {
106			$tokenOptions = new TokenOptions(OpenViduRole::PUBLISHER);
107			}
108			$response = $this->client->post(Uri::TOKEN_URI, [
109			RequestOptions::JSON => array_merge($tokenOptions->toArray(), ['session' => $this->sessionId])
110			]);
111			switch ($response->getStatusCode()) {
112			case 200:
113			return json_decode($response->getBody()->getContents());
114			case 400:
115			throw new OpenViduProblemWithBodyParameterException();
116			case 404:
117			throw new OpenViduSessionNotFoundException();
118			default:
119			throw new OpenViduException("Invalid response status code ".$response->getStatusCode(), $response->getStatusCode());
120			}
121			} catch (Exception $e) {
122			throw new OpenViduTokenCantCreateException($e->getMessage(), $e);
123			}
124			}
125
126			/**
127			* Gracefully closes the Session: unpublishes all streams and evicts every
128			* participant
129			* @throws OpenViduException
130			*/
131			public function close()
132			{
133			$response = $this->client->delete(Uri::SESSION_URI.'/'.$this->sessionId);
134			switch ($response->getStatusCode()) {
135			case 204:
136			Cache::store('openvidu')->forget($this->sessionId);
137			return true;
138			case 404:
139			throw new OpenViduSessionNotFoundException();
140			default:
141			throw new OpenViduException("Invalid response status code ".$response->getStatusCode(), $response->getStatusCode());
142			}
143			}
144
145			/**
146			* Updates every property of the Session with the current status it has in
147			* OpenVidu Server. This is especially useful for getting the list of active
148			* connections to the Session
149			* ({@see getActiveConnections()}) and use
150			* those values to call
151			* {@see forceDisconnect(Connection)} or
152			* {@link forceUnpublish(Publisher)}. <br>
153			*
154			* To update every Session object owned by OpenVidu object, call
155			* {@see fetch()}
156			*
157			* @return bool true if the Session status has changed with respect to the server,
158			* false if not. This applies to any property or sub-property of the object
159			*/
160
161			public function fetch()
162			{
163			$response = $this->client->get(Uri::SESSION_URI.'/'.$this->sessionId, [
164			'headers' => [
165			'Content-Type' => 'application/x-www-form-urlencoded',
166			'Accept' => 'application/json',
167			]
168			]);
169			if ($response->getStatusCode() === 200) {
170			$beforeJSON = $this->toJson();
171			$this->fromJson($response->getBody()->getContents());
172			$afterJSON = $this->toJson();
173			if ($beforeJSON !== $afterJSON) {
174			Cache::store('openvidu')->update($this->sessionId, $this->toJson());
175			return true;
176			}
177			}
178			return false;
179			}
180
181			/**
182			* Convert the model instance to JSON.
183			*
184			* @param int $options
185			* @return string
186			*
187			*/
188			public function toJson($options = 0): string
189			{
190			$json = json_encode($this->jsonSerialize(), $options);
191			return $json;
192			}
193
194			/**
195			* Specify data which should be serialized to JSON
196			* @link https://php.net/manual/en/jsonserializable.jsonserialize.php
197			* @return mixed data which can be serialized by <b>json_encode</b>,
198			* which is a value of any type other than a resource.
199			* @since 5.4.0
200			*/
201			public function jsonSerialize()
202			{
203			return $this->toArray();
204			}
205
206			/**
207			* Convert the model instance to an array.
208			*
209			* @return array
210			*/
211			public function toArray(): array
212			{
213			$array = ['sessionId' => $this->sessionId, 'properties' => $this->properties->toArray(), 'recording' => $this->recording, 'createdAt' => $this->createdAt];
214			foreach ($this->activeConnections as $connection) {
215			$array['activeConnections'][] = $connection->toArray();
216			}
217
218			foreach ($array as $key => $value) {
219			if (is_null($value) \|\| $value == '') {
220			unset($array[$key]);
221			}
222			}
223			return $array;
224			}
225
226			/**
227			* @param string $json
228			* @return Session
229			*/
230			public function fromJson(string $json): Session
231			{
232			return $this->fromArray(json_decode($json, true));
233			}
234
235			/**
236			* @param array $sessionArray
237			* @return Session
238			*/
239			public function fromArray(array $sessionArray): Session
240			{
241			$this->sessionId = $sessionArray['sessionId'];
242			$this->createdAt = $sessionArray['createdAt'] ?? null;
243			$this->recording = $sessionArray['recording'] ?? null;
244
245			if (array_key_exists('properties', $sessionArray)) {
246			$this->properties = SessionPropertiesBuilder::build($sessionArray['properties']);
247			}
248
249			$this->activeConnections = [];
250			if (array_key_exists('connections', $sessionArray)) {
251			foreach ($sessionArray['connections']['content'] as $connection) {
252			$publishers = [];
253			$ensure = $connection['content'] ?? $connection;
254			foreach ($ensure['publishers'] as $publisher) {
255			$publishers[] = PublisherBuilder::build($publisher);
256			}
257			$subscribers = [];
258
259			foreach ($ensure['subscribers'] as $subscriber) {
260			$subscribers[] = SubscriberBuilder::build($subscriber);
261			}
262			$this->activeConnections[] = ConnectionBuilder::build($ensure, $publishers, $subscribers);
263			}
264			}
265			return $this;
266			}
267
268			/**
269			* Forces the user with Connection `connectionId` to leave the session. OpenVidu Browser will trigger the proper events on the client-side
270			* (`streamDestroyed`, `connectionDestroyed`, `sessionDisconnected`) with reason set to `"forceDisconnectByServer"`
271			*
272			*
273			* @param string $connectionId
274			* @throws OpenViduException
275			*/
276			public function forceDisconnect(string $connectionId)
277			{
278			$response = $this->client->delete(Uri::SESSION_URI.'/'.$this->sessionId.'/connection/'.$connectionId, [
279			'headers' => [
280			'Content-Type' => 'application/x-www-form-urlencoded',
281			'Accept' => 'application/json',
282			]
283			]);
284			switch ($response->getStatusCode()) {
285			case 204:
286			$this->leaveSession($connectionId);
287			Cache::store('openvidu')->update($this->sessionId, $this->toJson());
288			break;
289			case 400:
290			throw new OpenViduSessionNotFoundException();
291			case 404:
292			throw new OpenViduConnectionNotFoundException();
293			default:
294			throw new OpenViduException("Invalid response status code ".$response->getStatusCode(), $response->getStatusCode());
295			}
296			}
297
298			/**
299			* Get `connection` parameter from activeConnections array {@see Connection::getConnectionId()} for getting each `connectionId` property).
300			* Remember to call {@see fetch()} before to fetch the current actual properties of the Session from OpenVidu Server
301			* @param string $connectionId
302			*/
303
304			private function leaveSession(string $connectionId)
305			{
306			$connectionClosed = null;
307			$this->activeConnections = array_filter($this->activeConnections, function (Connection $connection) use (&$connectionClosed, $connectionId) {
308			if ($connection->getConnectionId() !== $connectionId) {
309			return true;
310			}
311			$connectionClosed = $connection;
312			return false;
313			});
314			if ($connectionClosed != null) {
315			foreach ($connectionClosed->getPublishers() as $publisher) {
316			foreach ($this->activeConnections as $con) {
317			$con->unsubscribe($publisher->getStreamId());
318			}
319			}
320			}
321			}
322
323
324			/**
325			* Allows publish a Stream (For now can only be IPCAM).
326			* Remember to call
327			* {@see fetch()} before to fetch the current
328			* actual properties of the Session from OpenVidu Server
329			*
330			* @param IPCameraOptions $IPCameraOptions
331			* @return Connection
332			* @throws OpenViduException
333			* @throws OpenViduSessionNotFoundException
334			*/
335			public function publish(IPCameraOptions $IPCameraOptions)
336			{
337			$response = $this->client->post(Uri::SESSION_URI.'/'.$this->sessionId.'/connection', [
338			RequestOptions::JSON => array_merge($IPCameraOptions->toArray())
339			]);
340			switch ($response->getStatusCode()) {
341			case 200:
342			return json_decode($response->getBody()->getContents());
343			case 400:
344			throw new OpenViduProblemWithBodyParameterException();
345			case 404:
346			throw new OpenViduSessionNotFoundException();
347			default:
348			throw new OpenViduException("Unexpected error when publishing the IP camera stream into the session.");
349			}
350			}
351
352			/**
353			* Forces some user to unpublish a Stream. OpenVidu Browser will trigger the
354			* proper events on the client-side (<code>streamDestroyed</code>) with reason
355			* set to "forceUnpublishByServer". <br>
356			*
357			* You can get <code>streamId</code> parameter with
358			* {@see Session::getActiveConnections()} and then for
359			* each Connection you can call
360			* {@see Connection::getPublishers()}. Finally
361			* {@see Publisher::getStreamId()}) will give you the
362			* <code>streamId</code>. Remember to call
363			* {@see fetch()} before to fetch the current
364			* actual properties of the Session from OpenVidu Server
365			*
366			* @param string $streamId
367			* @return void
368			* @throws OpenViduConnectionNotFoundException
369			* @throws OpenViduException
370			* @throws OpenViduSessionNotFoundException
371			*/
372			public function forceUnpublish(string $streamId)
373			{
374			$response = $this->client->delete(Uri::SESSION_URI.'/'.$this->sessionId.'/stream/'.$streamId, [
375			'headers' => [
376			'Content-Type' => 'application/x-www-form-urlencoded',
377			'Accept' => 'application/json',
378			]
379			]);
380			switch ($response->getStatusCode()) {
381			case 204:
382			foreach ($this->activeConnections as $connection) {
383			$connection->unpublish($streamId);
384			$connection->unsubscribe($streamId);
385			}
386			Cache::store('openvidu')->update($this->sessionId, $this->toJson());
387			break;
388			case 400:
389			throw new OpenViduSessionNotFoundException();
390			case 404:
391			throw new OpenViduConnectionNotFoundException();
392			case 405:
393			throw new OpenViduStreamCantCloseException("You cannot directly delete the stream of an IPCAM participant");
394			default:
395			throw new OpenViduException("Invalid response status code ".$response->getStatusCode(), $response->getStatusCode());
396			}
397			}
398
399			/**
400			* Returns the list of active connections to the session. <strong>This value
401			* will remain unchanged since the last time method
402			* {@see fetch()} was called</strong>.
403			* Exceptions to this rule are:
404			* <ul>
405			* <li>Calling {@see Session::forceUnpublish(string)}
406			* updates each affected Connection status</li>
407			* <li>Calling {@see Session::forceDisconnect(string)}
408			* updates each affected Connection status</li>
409			* </ul>
410			* <br>
411			* To get the list of active connections with their current actual value, you
412			* must call first {@see Session::fetch()} and then
413			* {@see Session::getActiveConnections()}
414			*/
415			public function getActiveConnections(): array
416			{
417			return $this->activeConnections;
418			}
419
420			/**
421			* Returns whether the session is being recorded or not
422			*/
423			public function isBeingRecorded(): bool
424			{
425			return !!$this->recording;
426			}
427
428			/**
429			* Set value
430			* @param bool $recording
431			*/
432			public function setIsBeingRecorded(bool $recording)
433			{
434			$this->recording = $recording;
435			Cache::store('openvidu')->update($this->sessionId, $this->toJson());
436			}
437
438			public function getLastRecordingId()
439			{
440			return $this->lastRecordingId;
441			}
442
443			public function setLastRecordingId(string $lastRecordingId)
444			{
445			$this->lastRecordingId = $lastRecordingId;
446			Cache::store('openvidu')->update($this->sessionId, $this->toJson());
447			}
448
449			/**
450			* @return string
451			* @throws OpenViduException
452			*/
453			public function __toString(): string
454			{
455			return $this->getSessionId();
456			}
457			}
458

squareetlabs / LaravelOpenVidu

Push — master ( c8e4bc...17399e )

Session::fetch() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like