fkooman\VPN\Server\OpenVpn\ManagementSocket

Complexity

Total Complexity

17

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	open()	0	12	2
A	command()	0	9	1
A	close()	0	7	2
A	write()	0	6	2
A	read()	0	12	4
A	isEndOfResponse()	0	11	3
A	requireOpenSocket()	0	6	2

<?php
/**
 * Copyright 2016 François Kooman <fkooman@tuxed.net>.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace fkooman\VPN\Server\OpenVpn;

use fkooman\VPN\Server\OpenVpn\Exception\ManagementSocketException;

/**
 * Abstraction to use the OpenVPN management interface using a socket 
 * connection.
 */
class ManagementSocket implements ManagementSocketInterface
{
    /** @var resource */
    private $socket;

    public function __construct()
    {
        $this->socket = null;
    }

    /**
     * Connect to an OpenVPN management socket.
     *
     * @param string $socketAddress the socket to connect to, e.g.: 
     *                              "tcp://localhost:7505"
     */
    public function open($socketAddress, $timeOut = 5)
    {
        $this->socket = @stream_socket_client($socketAddress, $errno, $errstr, $timeOut);
        if (false === $this->socket) {
            throw new ManagementSocketException(
                sprintf('%s (%s)', $errstr, $errno)
            );
        }
        // turn off logging as the output may interfere with our management 
        // session, we do not care about the output
        $this->command('log off');
    }

    public function command($command)
    {
        $this->requireOpenSocket();
        $this->write(
            sprintf("%s\n", $command)
        );

        return $this->read();
    }

    public function close()
    {
        $this->requireOpenSocket();
        if (false === @fclose($this->socket)) {
            throw new ManagementSocketException('unable to close the socket');
        }
    }

    private function write($data)
    {
        if (false === @fwrite($this->socket, $data)) {

            throw new ManagementSocketException('unable to write to socket');
        }
    }

    private function read()
    {
        $dataBuffer = array();
        while (!feof($this->socket) && !$this->isEndOfResponse(end($dataBuffer))) {
            if (false === $readData = @fgets($this->socket, 4096)) {
                throw new ManagementSocketException('unable to read from socket');
            }
            $dataBuffer[] = trim($readData);
        }

        return $dataBuffer;
    }

    private function isEndOfResponse($lastLine)
    {
        $endMarkers = array('END', 'SUCCESS: ', 'ERROR: ');
        foreach ($endMarkers as $endMarker) {
            if (0 === strpos($lastLine, $endMarker)) {
                return true;
            }
        }

        return false;
    }

    private function requireOpenSocket()
    {
        if (is_null($this->socket)) {
            throw new ManagementSocketException('socket not open');
        }
    }
}