Socket::disconnect() - Code Metrics - fabiang/xmpp - Measure and Improve Code Quality continuously with Scrutinizer

Socket::disconnect() A
last analyzed 2017-05-23 13:22 UTC

↳ Parent: Socket

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	9
cts	9
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	0
crap	2

<?php

/**
 * Copyright 2014 Fabian Grutschus. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those
 * of the authors and should not be interpreted as representing official policies,
 * either expressed or implied, of the copyright holders.
 *
 * @author    Fabian Grutschus <[email protected]>
 * @copyright 2014 Fabian Grutschus. All rights reserved.
 * @license   BSD
 * @link      http://github.com/fabiang/xmpp
 */

namespace Fabiang\Xmpp\Connection;

use Psr\Log\LogLevel;
use Fabiang\Xmpp\Stream\SocketClient;
use Fabiang\Xmpp\Util\XML;
use Fabiang\Xmpp\Options;
use Fabiang\Xmpp\Exception\TimeoutException;

/**
 * Connection to a socket stream.
 *
 * @package Xmpp\Connection
 */
class Socket extends AbstractConnection implements SocketConnectionInterface
{

    const DEFAULT_LENGTH = 4096;
    const STREAM_START   = <<<'XML'
<?xml version="1.0" encoding="UTF-8"?>
<stream:stream to="%s" xmlns:stream="http://etherx.jabber.org/streams" xmlns="jabber:client" version="1.0">
XML;
    const STREAM_END     = '</stream:stream>';

    /**
     * Socket.
     *
     * @var SocketClient
     */
    protected $socket;

    /**
     * Did we received any data yet?
     *
     * @var bool
     */
    private $receivedAnyData = false;

    /**
     * Constructor set default socket instance if no socket was given.
     *
     * @param StreamSocket $socket  Socket instance
     */
    public function __construct(SocketClient $socket)
    {
        $this->setSocket($socket);
    }

    /**
     * Factory for connection class.
     *
     * @param Options $options Options object
     * @return static
     */
    public static function factory(Options $options)
    {
        $socket = new SocketClient($options->getAddress(), $options->getContextOptions());
        $object = new static($socket);
        $object->setOptions($options);
        return $object;
    }

    /**
     * {@inheritDoc}
     */
    public function receive()
    {
        $buffer = $this->getSocket()->read(static::DEFAULT_LENGTH);

        if ($buffer) {
            $this->receivedAnyData = true;
            $address = $this->getAddress();
            $this->log("Received buffer '$buffer' from '{$address}'", LogLevel::DEBUG);
            $this->getInputStream()->parse($buffer);
            return $buffer;
        }

        try {
            $this->checkTimeout($buffer);
        } catch (TimeoutException $exception) {
            $this->reconnectTls($exception);
        }
    }

    /**
     * Try to reconnect via TLS.
     *
     * @param TimeoutException $exception
     * @return null
     * @throws TimeoutException
     */
    private function reconnectTls(TimeoutException $exception)
    {
        // check if we didn't receive any data
        // if not we re-try to connect via TLS
        if (false === $this->receivedAnyData) {
            $matches = [];
            $previousAddress = $this->getOptions()->getAddress();
            // only reconnect via tls if we've used tcp before.
            if (preg_match('#tcp://(?<address>.+)#', $previousAddress, $matches)) {
                $this->log('Connecting via TCP failed, now trying to connect via TLS');

                $address = 'tls://' . $matches['address'];
                $this->connected = false;
                $this->getOptions()->setAddress($address);
                $this->getSocket()->reconnect($address);
                $this->connect();
                return;
            }
        }

        throw $exception;
    }

    /**
     * {@inheritDoc}
     */
    public function send($buffer)
    {
        if (false === $this->isConnected()) {
            $this->connect();
        }

        $address = $this->getAddress();
        $this->log("Sending data '$buffer' to '{$address}'", LogLevel::DEBUG);
        $this->getSocket()->write($buffer);
        $this->getOutputStream()->parse($buffer);

        while ($this->checkBlockingListeners()) {
            $this->receive();
        }
    }

    /**
     * {@inheritDoc}
     */
    public function connect()
    {
        if (false === $this->connected) {
            $address = $this->getAddress();
            $this->getSocket()->connect($this->getOptions()->getTimeout());
            $this->getSocket()->setBlocking(true);

            $this->connected = true;
            $this->log("Connected to '{$address}'", LogLevel::DEBUG);
        }

        $this->send(sprintf(static::STREAM_START, XML::quote($this->getOptions()->getTo())));
    }

    /**
     * {@inheritDoc}
     */
    public function disconnect()
    {
        if (true === $this->connected) {
            $address         = $this->getAddress();
            $this->send(static::STREAM_END);
            $this->getSocket()->close();
            $this->connected = false;
            $this->log("Disconnected from '{$address}'", LogLevel::DEBUG);
        }
    }

    /**
     * Get address from options object.
     *
     * @return string
     */
    protected function getAddress()
    {
        return $this->getOptions()->getAddress();
    }

    /**
     * Return socket instance.
     *
     * @return SocketClient
     */
    public function getSocket()
    {
        return $this->socket;
    }

    /**
     * {@inheritDoc}
     */
    public function setSocket(SocketClient $socket)
    {
        $this->socket = $socket;
        return $this;
    }
}


1		<?php
2
3		/**
4		* Copyright 2014 Fabian Grutschus. All rights reserved.
5		*
6		* Redistribution and use in source and binary forms, with or without modification,
7		* are permitted provided that the following conditions are met:
8		*
9		* 1. Redistributions of source code must retain the above copyright notice, this
10		* list of conditions and the following disclaimer.
11		*
12		* 2. Redistributions in binary form must reproduce the above copyright notice,
13		* this list of conditions and the following disclaimer in the documentation
14		* and/or other materials provided with the distribution.
15		*
16		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17		* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18		* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19		* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
20		* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21		* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22		* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23		* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25		* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26		*
27		* The views and conclusions contained in the software and documentation are those
28		* of the authors and should not be interpreted as representing official policies,
29		* either expressed or implied, of the copyright holders.
30		*
31		* @author Fabian Grutschus <[email protected]>
32		* @copyright 2014 Fabian Grutschus. All rights reserved.
33		* @license BSD
34		* @link http://github.com/fabiang/xmpp
35		*/
36
37		namespace Fabiang\Xmpp\Connection;
38
39		use Psr\Log\LogLevel;
40		use Fabiang\Xmpp\Stream\SocketClient;
41		use Fabiang\Xmpp\Util\XML;
42		use Fabiang\Xmpp\Options;
43		use Fabiang\Xmpp\Exception\TimeoutException;
44
45		/**
46		* Connection to a socket stream.
47		*
48		* @package Xmpp\Connection
49		*/
50		class Socket extends AbstractConnection implements SocketConnectionInterface
51		{
52
53		const DEFAULT_LENGTH = 4096;
54		const STREAM_START = <<<'XML'
55		<?xml version="1.0" encoding="UTF-8"?>
56		<stream:stream to="%s" xmlns:stream="http://etherx.jabber.org/streams" xmlns="jabber:client" version="1.0">
57		XML;
58		const STREAM_END = '</stream:stream>';
59
60		/**
61		* Socket.
62		*
63		* @var SocketClient
64		*/
65		protected $socket;
66
67		/**
68		* Did we received any data yet?
69		*
70		* @var bool
71		*/
72		private $receivedAnyData = false;
73
74		/**
75		* Constructor set default socket instance if no socket was given.
76		*
77		* @param StreamSocket $socket Socket instance
78		*/
79	3	public function __construct(SocketClient $socket)
80		{
81	3	$this->setSocket($socket);
82	3	}
83
84		/**
85		* Factory for connection class.
86		*
87		* @param Options $options Options object
88		* @return static
89		*/
90		public static function factory(Options $options)
91		{
92		$socket = new SocketClient($options->getAddress(), $options->getContextOptions());
93		$object = new static($socket);
94		$object->setOptions($options);
95		return $object;
96		}
97
98		/**
99		* {@inheritDoc}
100		*/
101	6	public function receive()
102		{
103	6	$buffer = $this->getSocket()->read(static::DEFAULT_LENGTH);
104
105	6	if ($buffer) {
106	3	$this->receivedAnyData = true;
107	3	$address = $this->getAddress();
108	3	$this->log("Received buffer '$buffer' from '{$address}'", LogLevel::DEBUG);
109	3	$this->getInputStream()->parse($buffer);
110	3	return $buffer;
111		}
112
113		try {
114	3	$this->checkTimeout($buffer);
115	3	} catch (TimeoutException $exception) {
116	3	$this->reconnectTls($exception);
117		}
118	3	}
119
120		/**
121		* Try to reconnect via TLS.
122		*
123		* @param TimeoutException $exception
124		* @return null
125		* @throws TimeoutException
126		*/
127	3	private function reconnectTls(TimeoutException $exception)
128		{
129		// check if we didn't receive any data
130		// if not we re-try to connect via TLS
131	3	if (false === $this->receivedAnyData) {
132	3	$matches = [];
133	3	$previousAddress = $this->getOptions()->getAddress();
134		// only reconnect via tls if we've used tcp before.
135	3	if (preg_match('#tcp://(?<address>.+)#', $previousAddress, $matches)) {
136	3	$this->log('Connecting via TCP failed, now trying to connect via TLS');
137
138	3	$address = 'tls://' . $matches['address'];
139	3	$this->connected = false;
140	3	$this->getOptions()->setAddress($address);
141	3	$this->getSocket()->reconnect($address);
142	3	$this->connect();
143	3	return;
144		}
145	3	}
146
147	3	throw $exception;
148		}
149
150		/**
151		* {@inheritDoc}
152		*/
153	3	public function send($buffer)
154		{
155	3	if (false === $this->isConnected()) {
156	3	$this->connect();
157	3	}
158
159	3	$address = $this->getAddress();
160	3	$this->log("Sending data '$buffer' to '{$address}'", LogLevel::DEBUG);
161	3	$this->getSocket()->write($buffer);
162	3	$this->getOutputStream()->parse($buffer);
163
164	3	while ($this->checkBlockingListeners()) {
165		$this->receive();
166		}
167	3	}
168
169		/**
170		* {@inheritDoc}
171		*/
172	3	public function connect()
173		{
174	3	if (false === $this->connected) {
175	3	$address = $this->getAddress();
176	3	$this->getSocket()->connect($this->getOptions()->getTimeout());
177	3	$this->getSocket()->setBlocking(true);
178
179	3	$this->connected = true;
180	3	$this->log("Connected to '{$address}'", LogLevel::DEBUG);
181	3	}
182
183	3	$this->send(sprintf(static::STREAM_START, XML::quote($this->getOptions()->getTo())));
184	3	}
185
186		/**
187		* {@inheritDoc}
188		*/
189	3	public function disconnect()
190		{
191	3	if (true === $this->connected) {
192	3	$address = $this->getAddress();
193	3	$this->send(static::STREAM_END);
194	3	$this->getSocket()->close();
195	3	$this->connected = false;
196	3	$this->log("Disconnected from '{$address}'", LogLevel::DEBUG);
197	3	}
198	3	}
199
200		/**
201		* Get address from options object.
202		*
203		* @return string
204		*/
205	3	protected function getAddress()
206		{
207	3	return $this->getOptions()->getAddress();
208		}
209
210		/**
211		* Return socket instance.
212		*
213		* @return SocketClient
214		*/
215	3	public function getSocket()
216		{
217	3	return $this->socket;
218		}
219
220		/**
221		* {@inheritDoc}
222		*/
223	3	public function setSocket(SocketClient $socket)
224		{
225	3	$this->socket = $socket;
226	3	return $this;
227		}
228		}
229

fabiang / xmpp

Socket::disconnect() A last analyzed 2017-05-23 13:22 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Socket::disconnect() A
last analyzed 2017-05-23 13:22 UTC