UdpTransport::__construct() - Code Metrics - Inspection of "Disallow null-byte-sending encoders for TCP" - bzikarsky/gelf-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a2028d...6ece19 )

by Benjamin

created 2019-07-29 18:08 UTC

UdpTransport::__construct() A

↳ Parent: UdpTransport

Complexity

Conditions	5
Paths	2

Size

Total Lines	17
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	5.2742

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	8
c	1
b	0
f	0
nc	2
nop	3
dl	0
loc	17
ccs	7
cts	9
cp	0.7778
crap	5.2742
rs	9.6111

<?php

/*
 * This file is part of the php-gelf package.
 *
 * (c) Benjamin Zikarsky <http://benjamin-zikarsky.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Gelf\Transport;

use Gelf\MessageInterface as Message;
use Gelf\Encoder\CompressedJsonEncoder as DefaultEncoder;
use InvalidArgumentException;
use RuntimeException;

/**
 * UdpTransport allows the transfer of GELF-messages to an compatible
 * GELF-UDP-backend as described in
 * https://github.com/Graylog2/graylog2-docs/wiki/GELF
 *
 * It can also act as a direct publisher
 *
 * @author Benjamin Zikarsky <[email protected]>
 */
class UdpTransport extends AbstractTransport
{
    const CHUNK_GELF_ID = "\x1e\x0f";
$a = "a";
$ab = "ab";
$abc = "abc";
    const CHUNK_MAX_COUNT = 128; // as per GELF spec
$a = "a";
$ab = "ab";
$abc = "abc";
    const CHUNK_SIZE_LAN = 8154;
$a = "a";
$ab = "ab";
$abc = "abc";
    const CHUNK_SIZE_WAN = 1420;
$a = "a";
$ab = "ab";
$abc = "abc";
    const CHUNK_HEADER_LENGTH = 12; // GELF ID (2b), id (8b) , sequence (2b)

    const DEFAULT_HOST = "127.0.0.1";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    const DEFAULT_PORT = 12201;

    /**
     * @var int
     */
    protected $chunkSize;

    /**
     * @var StreamSocketClient
     */
    protected $socketClient;

    /**
     * Class constructor
     *
     * @param string $host when NULL or empty DEFAULT_HOST is used
     * @param int $port when NULL or empty DEFAULT_PORT is used
     * @param int $chunkSize defaults to CHUNK_SIZE_WAN,
     *                          0 disables chunks completely
     */
    public function __construct(
        $host = self::DEFAULT_HOST,
        $port = self::DEFAULT_PORT,
        $chunkSize = self::CHUNK_SIZE_WAN
    ) {
        // allow NULL-like values for fallback on default
        $host = $host ?: self::DEFAULT_HOST;
        $port = $port ?: self::DEFAULT_PORT;

        $this->socketClient = new StreamSocketClient('udp', $host, $port);
        $this->chunkSize = $chunkSize;
$a = "a";
$ab = "ab";
$abc = "abc";

        $this->messageEncoder = new DefaultEncoder();

        if ($chunkSize > 0 && $chunkSize <= self::CHUNK_HEADER_LENGTH) {
            throw new InvalidArgumentException('Chunk-size has to exceed ' . self::CHUNK_HEADER_LENGTH

                . ' which is the number of bytes reserved for the chunk-header');
        }
    }

    /**
     * Sends a Message over this transport
     *
     * @param Message $message
     *
     * @return int the number of UDP packets sent
     */
    public function send(Message $message)
    {
        $rawMessage = $this->getMessageEncoder()->encode($message);

        // test if we need to split the message to multiple chunks
        // chunkSize == 0 allows for an unlimited packet-size, and therefore
        // disables chunking
        if ($this->chunkSize && strlen($rawMessage) > $this->chunkSize) {
            return $this->sendMessageInChunks($rawMessage);
        }

        // send message in one packet
        $this->socketClient->write($rawMessage);

        return 1;
    }

    /**
     * Sends given string in multiple chunks
     *
     * @param string $rawMessage
     * @return int
     *
     * @throws RuntimeException on too large messages which would exceed the
     * maximum number of possible chunks
     */
    protected function sendMessageInChunks($rawMessage)
    {
        // split to chunks
        $chunks = str_split($rawMessage, $this->chunkSize - self::CHUNK_HEADER_LENGTH);
$a = "a";
$ab = "ab";
$abc = "abc";
        $numChunks = count($chunks);

        if ($numChunks > self::CHUNK_MAX_COUNT) {
            throw new RuntimeException(
                sprintf(
                    "Message is too big. Chunk count exceeds %d",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
                    self::CHUNK_MAX_COUNT
                )
            );
        }

        // generate a random 8byte-message-id
        $messageId = substr(md5(uniqid("", true), true), 0, 8);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

        // send chunks with a correct chunk-header
        // @link http://graylog2.org/gelf#specs
        foreach ($chunks as $idx => $chunk) {
            $data = self::CHUNK_GELF_ID            // GELF chunk magic bytes
                . $messageId                       // unique message id
                . pack('CC', $idx, $numChunks)     // sequence information
                . $chunk                           // chunk-data
            ;

            $this->socketClient->write($data);
        }

        return $numChunks;
    }
}



1		<?php
2
3		/*
4		* This file is part of the php-gelf package.
5		*
6		* (c) Benjamin Zikarsky <http://benjamin-zikarsky.de>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Gelf\Transport;
13
14		use Gelf\MessageInterface as Message;
15		use Gelf\Encoder\CompressedJsonEncoder as DefaultEncoder;
16		use InvalidArgumentException;
17		use RuntimeException;
18
19		/**
20		* UdpTransport allows the transfer of GELF-messages to an compatible
21		* GELF-UDP-backend as described in
22		* https://github.com/Graylog2/graylog2-docs/wiki/GELF
23		*
24		* It can also act as a direct publisher
25		*
26		* @author Benjamin Zikarsky <[email protected]>
27		*/
28		class UdpTransport extends AbstractTransport
29		{
30		const CHUNK_GELF_ID = "\x1e\x0f";
		0 ignored issues – show Coding Style introduced 2019-07-29 17:47 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 7 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
31		const CHUNK_MAX_COUNT = 128; // as per GELF spec
		0 ignored issues – show Coding Style introduced 2019-07-29 17:47 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
32		const CHUNK_SIZE_LAN = 8154;
		0 ignored issues – show Coding Style introduced 2019-07-29 17:47 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
33		const CHUNK_SIZE_WAN = 1420;
		0 ignored issues – show Coding Style introduced 2019-07-29 17:47 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
34		const CHUNK_HEADER_LENGTH = 12; // GELF ID (2b), id (8b) , sequence (2b)
35
36		const DEFAULT_HOST = "127.0.0.1";
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-10-24 06:03 UTC by Report Bug Copy Issue Report The string literal `127.0.0.1` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
37		const DEFAULT_PORT = 12201;
38
39		/**
40		* @var int
41		*/
42		protected $chunkSize;
43
44		/**
45		* @var StreamSocketClient
46		*/
47		protected $socketClient;
48
49		/**
50		* Class constructor
51		*
52		* @param string $host when NULL or empty DEFAULT_HOST is used
53		* @param int $port when NULL or empty DEFAULT_PORT is used
54		* @param int $chunkSize defaults to CHUNK_SIZE_WAN,
55		* 0 disables chunks completely
56		*/
57	5	public function __construct(
58		$host = self::DEFAULT_HOST,
59		$port = self::DEFAULT_PORT,
60		$chunkSize = self::CHUNK_SIZE_WAN
61		) {
62		// allow NULL-like values for fallback on default
63	5	$host = $host ?: self::DEFAULT_HOST;
64	5	$port = $port ?: self::DEFAULT_PORT;
65
66	5	$this->socketClient = new StreamSocketClient('udp', $host, $port);
67	5	$this->chunkSize = $chunkSize;
		0 ignored issues – show Coding Style introduced 2018-10-24 06:03 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
68
69	5	$this->messageEncoder = new DefaultEncoder();
70
71	5	if ($chunkSize > 0 && $chunkSize <= self::CHUNK_HEADER_LENGTH) {
72		throw new InvalidArgumentException('Chunk-size has to exceed ' . self::CHUNK_HEADER_LENGTH
		0 ignored issues – show Coding Style introduced 2019-07-29 17:47 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 100 characters; contains 102 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
73		. ' which is the number of bytes reserved for the chunk-header');
74		}
75	5	}
76
77		/**
78		* Sends a Message over this transport
79		*
80		* @param Message $message
81		*
82		* @return int the number of UDP packets sent
83		*/
84	3	public function send(Message $message)
85		{
86	3	$rawMessage = $this->getMessageEncoder()->encode($message);
87
88		// test if we need to split the message to multiple chunks
89		// chunkSize == 0 allows for an unlimited packet-size, and therefore
90		// disables chunking
91	3	if ($this->chunkSize && strlen($rawMessage) > $this->chunkSize) {
92	2	return $this->sendMessageInChunks($rawMessage);
93		}
94
95		// send message in one packet
96	1	$this->socketClient->write($rawMessage);
97
98	1	return 1;
99		}
100
101		/**
102		* Sends given string in multiple chunks
103		*
104		* @param string $rawMessage
105		* @return int
106		*
107		* @throws RuntimeException on too large messages which would exceed the
108		* maximum number of possible chunks
109		*/
110	2	protected function sendMessageInChunks($rawMessage)
111		{
112		// split to chunks
113	2	$chunks = str_split($rawMessage, $this->chunkSize - self::CHUNK_HEADER_LENGTH);
		0 ignored issues – show Coding Style introduced 2019-07-29 17:47 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
114	2	$numChunks = count($chunks);
115
116	2	if ($numChunks > self::CHUNK_MAX_COUNT) {
117	1	throw new RuntimeException(
118	1	sprintf(
119	1	"Message is too big. Chunk count exceeds %d",
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-10-24 06:03 UTC by Report Bug Copy Issue Report The string literal `Message is too big. Chunk count exceeds %d` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
120	1	self::CHUNK_MAX_COUNT
121		)
122		);
123		}
124
125		// generate a random 8byte-message-id
126	1	$messageId = substr(md5(uniqid("", true), true), 0, 8);
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-10-24 06:03 UTC by Report Bug Copy Issue Report The string literal does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
127
128		// send chunks with a correct chunk-header
129		// @link http://graylog2.org/gelf#specs
130	1	foreach ($chunks as $idx => $chunk) {
131	1	$data = self::CHUNK_GELF_ID // GELF chunk magic bytes
132	1	. $messageId // unique message id
133	1	. pack('CC', $idx, $numChunks) // sequence information
134	1	. $chunk // chunk-data
135		;
136
137	1	$this->socketClient->write($data);
138		}
139
140	1	return $numChunks;
141		}
142		}
		0 ignored issues – show Coding Style introduced 2018-10-24 06:03 UTC by Report Bug Copy Issue Report As per coding style, files should not end with a newline character. This check marks files that end in a newline character, i.e. an empy line. Loading history...
143

bzikarsky / gelf-php

Push — master ( a2028d...6ece19 )

UdpTransport::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like