GoogleMarkupHelper::checkUrl() - Code Metrics - padosoft/laravel-google-structured-data-testing-tool - Measure and Improve Code Quality continuously with Scrutinizer

GoogleMarkupHelper::checkUrl() A
last analyzed 2018-08-02 13:47 UTC

↳ Parent: GoogleMarkupHelper

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	30
rs	9.44
c	0
b	0
f	0
cc	2
nc	2
nop	1

<?php

namespace Padosoft\Laravel\Google\StructuredDataTestingTool;

use Illuminate\Console\Command;

class GoogleMarkupHelper
{
    protected $command;

    protected $url;

    protected $whitelist;

    public $tableEntities = [];

    /**
     * constructor.
     * @param Command $objcommand
     * @param $whitelist
     */
    public function __construct(Command $objcommand, $whitelist)
    {
        $this->command = $objcommand;
        $this->whitelist = $whitelist;
    }

    /**
     *
     * Send Request to sensiolab and return array of sensiolab vulnerabilities.
     * Empty array if here is no vulnerabilities.
     *
     * @param $url path to composer.lock file.
     *
     * @return array
     */
    public function checkUrl($url)
    {
        $this->url = $url;

        $optArray = array(
            CURLOPT_URL => "https://search.google.com/structured-data/testing-tool/validate",
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_ENCODING => "",
            CURLOPT_MAXREDIRS => 10,
            CURLOPT_TIMEOUT => 30,
            CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
            CURLOPT_CUSTOMREQUEST => "POST",
            CURLOPT_POSTFIELDS => "url=" . urlencode($url),
            CURLOPT_HTTPHEADER => array(
                "cache-control: no-cache",
                "content-type: application/x-www-form-urlencoded;charset=UTF-8",
                "origin: https://search.google.com",
                "postman-token: 7ee787bf-1fe1-30c6-0b76-3dce8926bd5b",
                "referer: https://search.google.com/structured-data/testing-tool/u/0/",
                "user-agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.143 Safari/537.36"
            ),
        );

        $response = $this->sendRequest($optArray);
        if ($response === false) {
            return false;
        }

        return $this->parseResponse($response);
    }

    /**
     * @param $optArray
     * @return bool|mixed
     */
    public function sendRequest($optArray)
    {
        $curl = curl_init();

        curl_setopt_array($curl, $optArray);

        $response = curl_exec($curl);
        $err = curl_error($curl);
        $information = curl_getinfo($curl);
        $http_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);

        curl_close($curl);

        $colorTag = $this->getColorTagForStatusCode($http_code);
        $this->command->line("HTTP StatusCode: <{$colorTag}>" . $http_code . "</{$colorTag}>");

        if ($err || $http_code != 200) {
            $this->command->error("cURL Error #:" . $err);
            $this->command->line("cURL info: " . print_r($information, true));
            $this->command->line("Response: " . get_var_dump_output($response));
            return false;
        } elseif ($this->command->option('verbose')=="true") {
            $this->command->line("cURL opt array:");
            $this->command->line(get_var_dump_output($optArray));
            $this->command->line("cURL info: " . print_r($information, true));
            $this->command->line("Response: " . get_var_dump_output($response));
        }

        return $response;
    }

    /**
     * @param $error
     * @param bool $tuttoOk
     * @return array
     */
    public function checkError($error, $tuttoOk)
    {
        $tableEntities = array();

        $arr = [
            'name' => '',
            'type' => var_export($error['ownerSet'], true),
            'errors' => var_export($error['errorType'], true),
            'warnings' => var_export($error['args'], true),
            'isOk' => $tuttoOk,
        ];
        $tableEntities[] = $arr;

        return $tableEntities;
    }

    /**
     * @param $response
     * @return array
     */
    public function checkResponse($response)
    {
        $tuttoOk = true;

        if ($response['numObjects'] == 0) {
            $this->command->info("No structured data Found");
        }
        if ($response['totalNumErrors'] > 0) {
            $this->command->error("Found " . $response['totalNumErrors'] . " error");
            $tuttoOk = false;
        }
        if ($response['totalNumWarnings'] > 0) {
            $this->command->warn("Found " . $response['totalNumWarnings'] . " warnings");
            $tuttoOk = false;
        }
        if ($response['totalNumErrors'] == 0 && $response['totalNumWarnings'] == 0) {
            $this->command->info("No Errors or Warnings Found");
        }

        if (in_array(rtrim($this->url), $this->whitelist)) {
            $tuttoOk = true;
        }

        $colorTag = $this->getColorTagForResponse($response);

        $this->tableEntities [] = [
            'name' => "<{$colorTag}>" . $this->url . "</{$colorTag}>",
            'type' => $response['numObjects'] == 0 ? 'No structured data Found' : '',
            'errors' => $response['totalNumErrors'],
            'warnings' => $response['totalNumWarnings'],
            'isOk' => $tuttoOk,
        ];

        if(!array_key_exists_safe($response, 'errors')) {
            return $tuttoOk;
        }

        foreach ($response['errors'] as $error) {
            $this->tableEntities = array_merge($this->tableEntities, $this->checkError($error, $tuttoOk));
        }

        return $tuttoOk;
    }

    /**
     * Get the color tag for the given status code.
     *
     * @param string $code
     *
     * @return string
     *
     * @see https://github.com/spatie/http-status-check/blob/master/src/CrawlLogger.php#L96
     */
    protected function getColorTagForStatusCode($code)
    {
        if (starts_with($code, '2')) {
            return 'info';
        }
        if (starts_with($code, '3')) {
            return 'comment';
        }
        return 'error';
    }

    /**
     * Get the color tag for the given response.
     *
     * @param string $response
     *
     * @return string
     *
     */
    protected function getColorTagForResponse($response)
    {
        if ($response['totalNumErrors'] > 0) {
            return 'error';
        }
        if ($response['totalNumWarnings'] > 0 || $response['numObjects'] == 0) {
            return 'comment';
        }
        return 'info';
    }

    /**
     * @param $response
     * @return mixed|string
     */
    protected function parseResponse($response)
    {
        //sometimes response return with strange start chars
        if (!starts_with(trim($response), "{")) {
            $response = substr($response, 4);
        }

        //strip html sometimes invalidate json
        $response = str_replace(["\r", "\n"], "", $response);
        $re = '/"html":"(.*),"errors"/';
        $subst = '"html":"","errors"';
        $response = preg_replace($re, $subst, $response);
        $re = '/"html": "(.*),"errors"/';
        $subst = '"html":"","errors"';
        $response = preg_replace($re, $subst, $response);

        $response = json_decode($response, true);

        return $response;
    }
}


1			<?php
2
3			namespace Padosoft\Laravel\Google\StructuredDataTestingTool;
4
5			use Illuminate\Console\Command;
6
7			class GoogleMarkupHelper
8			{
9			protected $command;
10
11			protected $url;
12
13			protected $whitelist;
14
15			public $tableEntities = [];
16
17			/**
18			* constructor.
19			* @param Command $objcommand
20			* @param $whitelist
21			*/
22			public function __construct(Command $objcommand, $whitelist)
23			{
24			$this->command = $objcommand;
25			$this->whitelist = $whitelist;
26			}
27
28			/**
29			*
30			* Send Request to sensiolab and return array of sensiolab vulnerabilities.
31			* Empty array if here is no vulnerabilities.
32			*
33			* @param $url path to composer.lock file.
34			*
35			* @return array
36			*/
37			public function checkUrl($url)
38			{
39			$this->url = $url;
40
41			$optArray = array(
42			CURLOPT_URL => "https://search.google.com/structured-data/testing-tool/validate",
43			CURLOPT_RETURNTRANSFER => true,
44			CURLOPT_ENCODING => "",
45			CURLOPT_MAXREDIRS => 10,
46			CURLOPT_TIMEOUT => 30,
47			CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
48			CURLOPT_CUSTOMREQUEST => "POST",
49			CURLOPT_POSTFIELDS => "url=" . urlencode($url),
50			CURLOPT_HTTPHEADER => array(
51			"cache-control: no-cache",
52			"content-type: application/x-www-form-urlencoded;charset=UTF-8",
53			"origin: https://search.google.com",
54			"postman-token: 7ee787bf-1fe1-30c6-0b76-3dce8926bd5b",
55			"referer: https://search.google.com/structured-data/testing-tool/u/0/",
56			"user-agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.143 Safari/537.36"
57			),
58			);
59
60			$response = $this->sendRequest($optArray);
61			if ($response === false) {
62			return false;
63			}
64
65			return $this->parseResponse($response);
66			}
67
68			/**
69			* @param $optArray
70			* @return bool\|mixed
71			*/
72			public function sendRequest($optArray)
73			{
74			$curl = curl_init();
75
76			curl_setopt_array($curl, $optArray);
77
78			$response = curl_exec($curl);
79			$err = curl_error($curl);
80			$information = curl_getinfo($curl);
81			$http_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
82
83			curl_close($curl);
84
85			$colorTag = $this->getColorTagForStatusCode($http_code);
86			$this->command->line("HTTP StatusCode: <{$colorTag}>" . $http_code . "</{$colorTag}>");
87
88			if ($err \|\| $http_code != 200) {
89			$this->command->error("cURL Error #:" . $err);
90			$this->command->line("cURL info: " . print_r($information, true));
91			$this->command->line("Response: " . get_var_dump_output($response));
92			return false;
93			} elseif ($this->command->option('verbose')=="true") {
94			$this->command->line("cURL opt array:");
95			$this->command->line(get_var_dump_output($optArray));
96			$this->command->line("cURL info: " . print_r($information, true));
97			$this->command->line("Response: " . get_var_dump_output($response));
98			}
99
100			return $response;
101			}
102
103			/**
104			* @param $error
105			* @param bool $tuttoOk
106			* @return array
107			*/
108			public function checkError($error, $tuttoOk)
109			{
110			$tableEntities = array();
111
112			$arr = [
113			'name' => '',
114			'type' => var_export($error['ownerSet'], true),
115			'errors' => var_export($error['errorType'], true),
116			'warnings' => var_export($error['args'], true),
117			'isOk' => $tuttoOk,
118			];
119			$tableEntities[] = $arr;
120
121			return $tableEntities;
122			}
123
124			/**
125			* @param $response
126			* @return array
127			*/
128			public function checkResponse($response)
129			{
130			$tuttoOk = true;
131
132			if ($response['numObjects'] == 0) {
133			$this->command->info("No structured data Found");
134			}
135			if ($response['totalNumErrors'] > 0) {
136			$this->command->error("Found " . $response['totalNumErrors'] . " error");
137			$tuttoOk = false;
138			}
139			if ($response['totalNumWarnings'] > 0) {
140			$this->command->warn("Found " . $response['totalNumWarnings'] . " warnings");
141			$tuttoOk = false;
142			}
143			if ($response['totalNumErrors'] == 0 && $response['totalNumWarnings'] == 0) {
144			$this->command->info("No Errors or Warnings Found");
145			}
146
147			if (in_array(rtrim($this->url), $this->whitelist)) {
148			$tuttoOk = true;
149			}
150
151			$colorTag = $this->getColorTagForResponse($response);
152
153			$this->tableEntities [] = [
154			'name' => "<{$colorTag}>" . $this->url . "</{$colorTag}>",
155			'type' => $response['numObjects'] == 0 ? 'No structured data Found' : '',
156			'errors' => $response['totalNumErrors'],
157			'warnings' => $response['totalNumWarnings'],
158			'isOk' => $tuttoOk,
159			];
160
161			if(!array_key_exists_safe($response, 'errors')) {
162			return $tuttoOk;
163			}
164
165			foreach ($response['errors'] as $error) {
166			$this->tableEntities = array_merge($this->tableEntities, $this->checkError($error, $tuttoOk));
167			}
168
169			return $tuttoOk;
170			}
171
172			/**
173			* Get the color tag for the given status code.
174			*
175			* @param string $code
176			*
177			* @return string
178			*
179			* @see https://github.com/spatie/http-status-check/blob/master/src/CrawlLogger.php#L96
180			*/
181			protected function getColorTagForStatusCode($code)
182			{
183			if (starts_with($code, '2')) {
184			return 'info';
185			}
186			if (starts_with($code, '3')) {
187			return 'comment';
188			}
189			return 'error';
190			}
191
192			/**
193			* Get the color tag for the given response.
194			*
195			* @param string $response
196			*
197			* @return string
198			*
199			*/
200			protected function getColorTagForResponse($response)
201			{
202			if ($response['totalNumErrors'] > 0) {
203			return 'error';
204			}
205			if ($response['totalNumWarnings'] > 0 \|\| $response['numObjects'] == 0) {
206			return 'comment';
207			}
208			return 'info';
209			}
210
211			/**
212			* @param $response
213			* @return mixed\|string
214			*/
215			protected function parseResponse($response)
216			{
217			//sometimes response return with strange start chars
218			if (!starts_with(trim($response), "{")) {
219			$response = substr($response, 4);
220			}
221
222			//strip html sometimes invalidate json
223			$response = str_replace(["\r", "\n"], "", $response);
224			$re = '/"html":"(.*),"errors"/';
225			$subst = '"html":"","errors"';
226			$response = preg_replace($re, $subst, $response);
227			$re = '/"html": "(.*),"errors"/';
228			$subst = '"html":"","errors"';
229			$response = preg_replace($re, $subst, $response);
230
231			$response = json_decode($response, true);
232
233			return $response;
234			}
235			}
236

padosoft / laravel-google-structured-data-testing-tool

GoogleMarkupHelper::checkUrl() A last analyzed 2018-08-02 13:47 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

GoogleMarkupHelper::checkUrl() A
last analyzed 2018-08-02 13:47 UTC