Form::submit() - Code Metrics - Inspection of "Mautic form fixes" - escopecz/mautic-form-submit - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#9)

unknown

created 2019-04-17 12:43 UTC

Form::submit() F

↳ Parent: Form

Complexity

Conditions	12
Paths	384

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	92.418

Importance

Changes

Metric	Value
dl	0
loc	70
rs	3.7212
c	0
b	0
f	0
ccs	6
cts	34
cp	0.1765
cc	12
nc	384
nop	2
crap	92.418

How to fix Long Method Complexity

<?php

namespace Escopecz\MauticFormSubmit\Mautic;

use Escopecz\MauticFormSubmit\Mautic;
use Escopecz\MauticFormSubmit\Mautic\Cookie;
use Escopecz\MauticFormSubmit\HttpHeader;

/**
 * Mautic form
 */
class Form
{
    /**
     * @var Mautic
     */
    protected $mautic;

    /**
     * Form ID
     *
     * @var int
     */
    protected $id;

    /**
     * Constructor
     *
     * @param Mautic $mautic
     * @param int    $id
     */
    public function __construct(Mautic $mautic, $id)
    {
        $this->mautic = $mautic;
        $this->id = $id;
    }

    /**
     * Submit the $data array to the Mautic form, using the optional $curlOpts
     * array to override curl settings
     * Returns array containing info about the request, response and cookie
     *
     * @param  array  $data
     * @param  array  $curlOpts
     *
     * @return array
     */
    public function submit(array $data, array $curlOpts = [])
    {
        $originalCookie = $this->mautic->getCookie()->getSuperGlobalCookie();
        $response = [];
        $request = $this->prepareRequest($data);

        $ch = curl_init($request['url']);
        curl_setopt($ch, CURLOPT_POST, 1);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $request['query']);

        if (isset($request['header'])) {
            curl_setopt($ch, CURLOPT_HTTPHEADER, $request['header']);
        }

        if (isset($request['referer'])) {
            curl_setopt($ch, CURLOPT_REFERER, $request['referer']);
        }

        if (isset($request['cookie'])) {
            curl_setopt($ch, CURLOPT_COOKIEFILE, $this->mautic->getCookie()->createCookieFile());
        }

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($ch, CURLOPT_VERBOSE, 1);
        curl_setopt($ch, CURLOPT_HEADER, 1);

        foreach ($curlOpts as $key => $value) {
            curl_setopt($ch, $key, $value);
        }

        $result = curl_exec($ch);

        $response['header'] = null;
        $response['content'] = null;
        if (is_string($result) && strpos($result, "\r\n\r\n") !== false) {
            list($header, $content) = explode("\r\n\r\n", $result, 2);
            if (stripos($header, '100 Continue') !== false && strpos($content, "\r\n\r\n") !== false) {
                list($header, $content) = explode("\r\n\r\n", $content, 2);
            }
            $response['header'] = $header;
            $response['content'] = htmlentities($content);
        }
        $response['info'] = curl_getinfo($ch);
        curl_close($ch);

        $contact = $this->mautic->getContact();
        $httpHeader = new HttpHeader($response['header']);
        $sessionId = $httpHeader->getCookieValue(Cookie::MAUTIC_SESSION_ID);
        $deviceId = $httpHeader->getCookieValue(Cookie::MAUTIC_DEVICE_ID);
        $contactId = $httpHeader->getCookieValue($sessionId);

        if ($sessionId) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $contact->setSessionId($sessionId);
        }

        if ($deviceId) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $contact->setDeviceId($deviceId);
        }

        if ($contactId) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $contact->setId((int)$contactId);
        }

        return [
            'original_cookie' => $originalCookie,
            'new_cookie' => $this->mautic->getCookie()->toArray(),
            'request' => $request,
            'response' => $response,
        ];
    }

    /**
     * Prepares data for CURL request based on provided form data, $_COOKIE and $_SERVER
     *
     * @param  array $data
     *
     * @return array
     */
    public function prepareRequest(array $data)
    {
        $contact = $this->mautic->getContact();
        $request = ['header' => []];

        $data['formId'] = $this->id;

        // return has to be part of the form data array so Mautic would accept the submission
        if (!isset($data['return'])) {
            $data['return'] = '';
        }

        $request['url'] = $this->getUrl();
        $request['data'] = ['mauticform' => $data];

        if ($contactId = $contact->getId()) {
            $request['data']['mtc_id'] = $contactId;
        }

        if ($contactIp = $contact->getIp()) {
            $request['header'][] = "X-Forwarded-For: $contactIp";
            $request['header'][] = "Client-Ip: $contactIp";
        }

        if ($sessionId = $contact->getSessionId()) {
            $request['header'][] = "Cookie: mautic_session_id=$sessionId";
            $request['header'][] = "Cookie: mautic_device_id=$sessionId";
        }

        if (isset($_SERVER['HTTP_REFERER'])) {
            $request['referer'] = $_SERVER["HTTP_REFERER"];
        }

        $request['query'] = http_build_query($request['data']);

        return $request;
    }

    /**
     * Builds the form URL
     *
     * @return string
     */
    public function getUrl()
    {
        return sprintf('%s/form/submit?formId=%d', $this->mautic->getBaseUrl(), $this->id);
    }

    /**
     * Returns the Form ID
     *
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }
}


1		<?php
2
3		namespace Escopecz\MauticFormSubmit\Mautic;
4
5		use Escopecz\MauticFormSubmit\Mautic;
6		use Escopecz\MauticFormSubmit\Mautic\Cookie;
7		use Escopecz\MauticFormSubmit\HttpHeader;
8
9		/**
10		* Mautic form
11		*/
12		class Form
13		{
14		/**
15		* @var Mautic
16		*/
17		protected $mautic;
18
19		/**
20		* Form ID
21		*
22		* @var int
23		*/
24		protected $id;
25
26		/**
27		* Constructor
28		*
29		* @param Mautic $mautic
30	14	* @param int $id
31		*/
32	14	public function __construct(Mautic $mautic, $id)
33	14	{
34	14	$this->mautic = $mautic;
35		$this->id = $id;
36		}
37
38		/**
39		* Submit the $data array to the Mautic form, using the optional $curlOpts
40		* array to override curl settings
41		* Returns array containing info about the request, response and cookie
42		*
43		* @param array $data
44		* @param array $curlOpts
45		*
46		* @return array
47		*/
48		public function submit(array $data, array $curlOpts = [])
49		{
50		$originalCookie = $this->mautic->getCookie()->getSuperGlobalCookie();
51		$response = [];
52		$request = $this->prepareRequest($data);
53
54		$ch = curl_init($request['url']);
55		curl_setopt($ch, CURLOPT_POST, 1);
56		curl_setopt($ch, CURLOPT_POSTFIELDS, $request['query']);
57
58		if (isset($request['header'])) {
59		curl_setopt($ch, CURLOPT_HTTPHEADER, $request['header']);
60		}
61
62		if (isset($request['referer'])) {
63		curl_setopt($ch, CURLOPT_REFERER, $request['referer']);
64		}
65
66		if (isset($request['cookie'])) {
67		curl_setopt($ch, CURLOPT_COOKIEFILE, $this->mautic->getCookie()->createCookieFile());
68		}
69
70		curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
71		curl_setopt($ch, CURLOPT_VERBOSE, 1);
72		curl_setopt($ch, CURLOPT_HEADER, 1);
73
74		foreach ($curlOpts as $key => $value) {
75		curl_setopt($ch, $key, $value);
76		}
77
78		$result = curl_exec($ch);
79
80		$response['header'] = null;
81		$response['content'] = null;
82		if (is_string($result) && strpos($result, "\r\n\r\n") !== false) {
83		list($header, $content) = explode("\r\n\r\n", $result, 2);
84		if (stripos($header, '100 Continue') !== false && strpos($content, "\r\n\r\n") !== false) {
85		list($header, $content) = explode("\r\n\r\n", $content, 2);
86		}
87		$response['header'] = $header;
88		$response['content'] = htmlentities($content);
89		}
90		$response['info'] = curl_getinfo($ch);
91		curl_close($ch);
92
93		$contact = $this->mautic->getContact();
94		$httpHeader = new HttpHeader($response['header']);
95		$sessionId = $httpHeader->getCookieValue(Cookie::MAUTIC_SESSION_ID);
96		$deviceId = $httpHeader->getCookieValue(Cookie::MAUTIC_DEVICE_ID);
97		$contactId = $httpHeader->getCookieValue($sessionId);
98
99		if ($sessionId) {
		0 ignored issues – show Bug Best Practice introduced 2018-07-04 08:58 UTC by Report Bug Copy Issue Report The expression `$sessionId` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
100	2	$contact->setSessionId($sessionId);
101		}
102	2
103	2	if ($deviceId) {
		0 ignored issues – show Bug Best Practice introduced 2018-07-04 08:58 UTC by Report Bug Copy Issue Report The expression `$deviceId` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
104		$contact->setDeviceId($deviceId);
105		}
106	2
107		if ($contactId) {
		0 ignored issues – show Bug Best Practice introduced 2018-07-04 08:58 UTC by Report Bug Copy Issue Report The expression `$contactId` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
108	2	$contact->setId((int)$contactId);
109	2	}
110
111		return [
112		'original_cookie' => $originalCookie,
113		'new_cookie' => $this->mautic->getCookie()->toArray(),
114		'request' => $request,
115		'response' => $response,
116		];
117		}
118
119		/**
120		* Prepares data for CURL request based on provided form data, $_COOKIE and $_SERVER
121		*
122		* @param array $data
123	2	*
124		* @return array
125	2	*/
126	2	public function prepareRequest(array $data)
127		{
128		$contact = $this->mautic->getContact();
129	2	$request = ['header' => []];
130
131	2	$data['formId'] = $this->id;
132	2
133		// return has to be part of the form data array so Mautic would accept the submission
134		if (!isset($data['return'])) {
135		$data['return'] = '';
136		}
137
138		$request['url'] = $this->getUrl();
139		$request['data'] = ['mauticform' => $data];
140
141		if ($contactId = $contact->getId()) {
142		$request['data']['mtc_id'] = $contactId;
143		}
144
145	2	if ($contactIp = $contact->getIp()) {
146		$request['header'][] = "X-Forwarded-For: $contactIp";
147	2	$request['header'][] = "Client-Ip: $contactIp";
148	2	}
149
150	2	if ($sessionId = $contact->getSessionId()) {
151		$request['header'][] = "Cookie: mautic_session_id=$sessionId";
152		$request['header'][] = "Cookie: mautic_device_id=$sessionId";
153	2	}
154	2
155		if (isset($_SERVER['HTTP_REFERER'])) {
156		$request['referer'] = $_SERVER["HTTP_REFERER"];
157	2	}
158	2
159		$request['query'] = http_build_query($request['data']);
160	2
161		return $request;
162		}
163
164	2	/**
165		* Builds the form URL
166		*
167		* @return string
168	2	*/
169		public function getUrl()
170		{
171		return sprintf('%s/form/submit?formId=%d', $this->mautic->getBaseUrl(), $this->id);
172	2	}
173
174		/**
175		* Returns the Form ID
176	2	*
177		* @return int
178	2	*/
179		public function getId()
180		{
181		return $this->id;
182		}
183		}
184

escopecz / mautic-form-submit

Pull Request — master (#9)

Form::submit() F

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like