RegexService::read() - Code Metrics - Inspection of "new Datasource: Regex grabber for external html #1..." - Rello/analytics - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e7d759...857996 )

by Marcel

created 2020-01-10 23:48 UTC

RegexService::read() A

↳ Parent: RegexService

Complexity

Conditions	5
Paths	4

Size

Total Lines	35
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	23
c	1
b	0
f	0
nc	4
nop	1
dl	0
loc	35
rs	9.2408

<?php
/**
 * Data Analytics
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the LICENSE.md file.
 *
 * @author Marcel Scherello <[email protected]>
 * @copyright 2019 Marcel Scherello
 */

namespace OCA\Analytics\Datasource;

use OCP\ILogger;

class RegexService
{
    private $logger;

    public function __construct(
        ILogger $logger
    )
    {
        $this->logger = $logger;
    }

    /**
     * Grab data from external html via regex
     *
     * @NoAdminRequired
     * @param array $option
     * @return array
     */
    public function read($option)
    {
        // http headers for requests
        $headers = array(

            'Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
            'Accept-Language: en-US,en;q=0.5',
            'Connection: keep-alive',
            'DNT: 1', // :)
        );

        $regex = $option['regex'];
        $url = $option['url'];

        $html = file_get_contents($url);
        preg_match_all($regex, $html, $matches);

        $this->logger->debug('count: ' . count($matches['dimension']));

        $data = array();
        for ($i = 0; $i < count($matches['dimension']); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            if (isset($option['limit'])) {
                if ($i === (int)$option['limit'] AND (int)$option['limit'] !== 0) break;
            }
            array_push($data, ['dimension1' => '', 'dimension2' => $matches['dimension'][$i], 'dimension3' => $matches['value'][$i]]);
        }

        $header = array();
        $header['dimension1'] = '';
        $header['dimension2'] = 'Dimension2';
        $header['dimension3'] = 'Count';

        return [
            'header' => $header,
            'data' => $data,
            'error' => 0,
        ];
    }

    /**
     * template for options & settings
     *
     * @NoAdminRequired
     * @return array
     */
    public function getTemplate()
    {
        $template = array();
        array_push($template, ['id' => 'url', 'name' => 'URL', 'placeholder' => 'url']);
        array_push($template, ['id' => 'regex', 'name' => 'valid regex', 'placeholder' => '//']);
        array_push($template, ['id' => 'limit', 'name' => 'Limit', 'placeholder' => 'Number of records']);
        array_push($template, ['id' => 'timestamp', 'name' => 'Timestamp of dataload', 'placeholder' => 'true/false']);
        return $template;
    }

    private function backup()

    {
        /**
         * $ch = curl_init();
         * curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
         * curl_setopt($ch, CURLOPT_COOKIESESSION, true );
         * curl_setopt($ch, CURLOPT_COOKIEFILE, '');
         * curl_setopt($ch, CURLOPT_ENCODING, 'gzip, deflate');
         * curl_setopt($ch, CURLOPT_HEADER, false);
         * curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
         * curl_setopt($ch, CURLOPT_URL, $url);
         * curl_setopt($ch, CURLOPT_REFERER, $url);
         * curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
         * curl_setopt($ch, CURLOPT_USERAGENT, 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36');
         * //$html = curl_exec($ch);
         * curl_close($ch);
         *
         * //$this->logger->debug($result);
         * //$html = str_get_html($result, true, false);
         * //$this->logger->debug($html);
         * //$value = $html->find('a[href=/gp/bestsellers/books/405436/ref=pd_zg_hrsr_books]', 0)->parent->parent->first_child->innertext;
         * //ocument.querySelectorAll("a[href='/gp/bestsellers/books/405436/ref=pd_zg_hrsr_books']")[0].parentNode.parentNode.firstElementChild.innerText
         * //$string = 'http://www.amazon.de/dp/3964433578';
         * //$filter = '/(<span class=\"zg_hrsr_rank\">Nr. )(.*)(<\/span><span class="zg_hrsr_ladder">in&nbsp;<a href="\/gp\/bestsellers)(.*)(hrsr_books">)(.*)(<\/a><\/span>)/';
         * //$filter = '/(<span class="zg_hrsr_rank">Nr. )(.*)(<\/span><span class="zg_hrsr_ladder">in&nbsp;<a href="\/gp\/bestsellers\/books\/405436\/ref=pd_zg_hrsr_books">Vietnamesisch)/';
         * //$filter = '/(<span class="zg_hrsr_rank">Nr. )(.*)(<\/span>)(.*)(hrsr_books">)/';
         * //$filter = '/(<span class="zg_hrsr_rank">Nr. )(?<value>.*)(<\/span>\n    )(.*)(?<dimension>Vietnamesisch lernen)/';
         * //$this->logger->debug('values all: '. json_encode($values));
         * //$values = $values['value'];
         * //$this->logger->debug('values first array: '. json_encode($values));**/
    }
}

1			<?php
2			/**
3			* Data Analytics
4			*
5			* This file is licensed under the Affero General Public License version 3 or
6			* later. See the LICENSE.md file.
7			*
8			* @author Marcel Scherello <[email protected]>
9			* @copyright 2019 Marcel Scherello
10			*/
11
12			namespace OCA\Analytics\Datasource;
13
14			use OCP\ILogger;
15
16			class RegexService
17			{
18			private $logger;
19
20			public function __construct(
21			ILogger $logger
22			)
23			{
24			$this->logger = $logger;
25			}
26
27			/**
28			* Grab data from external html via regex
29			*
30			* @NoAdminRequired
31			* @param array $option
32			* @return array
33			*/
34			public function read($option)
35			{
36			// http headers for requests
37			$headers = array(
			0 ignored issues – show Unused Code introduced 2020-01-10 23:51 UTC by Report Bug Copy Issue Report The assignment to `$headers` is dead and can be removed. Loading history...
38			'Accept: text/html,application/xhtml+xml,application/xml;q=0.9,/;q=0.8',
39			'Accept-Language: en-US,en;q=0.5',
40			'Connection: keep-alive',
41			'DNT: 1', // :)
42			);
43
44			$regex = $option['regex'];
45			$url = $option['url'];
46
47			$html = file_get_contents($url);
48			preg_match_all($regex, $html, $matches);
49
50			$this->logger->debug('count: ' . count($matches['dimension']));
51
52			$data = array();
53			for ($i = 0; $i < count($matches['dimension']); $i++) {
			0 ignored issues – show Performance Best Practice introduced 2020-01-10 23:51 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
54			if (isset($option['limit'])) {
55			if ($i === (int)$option['limit'] AND (int)$option['limit'] !== 0) break;
56			}
57			array_push($data, ['dimension1' => '', 'dimension2' => $matches['dimension'][$i], 'dimension3' => $matches['value'][$i]]);
58			}
59
60			$header = array();
61			$header['dimension1'] = '';
62			$header['dimension2'] = 'Dimension2';
63			$header['dimension3'] = 'Count';
64
65			return [
66			'header' => $header,
67			'data' => $data,
68			'error' => 0,
69			];
70			}
71
72			/**
73			* template for options & settings
74			*
75			* @NoAdminRequired
76			* @return array
77			*/
78			public function getTemplate()
79			{
80			$template = array();
81			array_push($template, ['id' => 'url', 'name' => 'URL', 'placeholder' => 'url']);
82			array_push($template, ['id' => 'regex', 'name' => 'valid regex', 'placeholder' => '//']);
83			array_push($template, ['id' => 'limit', 'name' => 'Limit', 'placeholder' => 'Number of records']);
84			array_push($template, ['id' => 'timestamp', 'name' => 'Timestamp of dataload', 'placeholder' => 'true/false']);
85			return $template;
86			}
87
88			private function backup()
			0 ignored issues – show Unused Code introduced 2020-01-10 23:51 UTC by Report Bug Copy Issue Report The method `backup()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
89			{
90			/**
91			* $ch = curl_init();
92			* curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
93			* curl_setopt($ch, CURLOPT_COOKIESESSION, true );
94			* curl_setopt($ch, CURLOPT_COOKIEFILE, '');
95			* curl_setopt($ch, CURLOPT_ENCODING, 'gzip, deflate');
96			* curl_setopt($ch, CURLOPT_HEADER, false);
97			* curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
98			* curl_setopt($ch, CURLOPT_URL, $url);
99			* curl_setopt($ch, CURLOPT_REFERER, $url);
100			* curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
101			* curl_setopt($ch, CURLOPT_USERAGENT, 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36');
102			* //$html = curl_exec($ch);
103			* curl_close($ch);
104			*
105			* //$this->logger->debug($result);
106			* //$html = str_get_html($result, true, false);
107			* //$this->logger->debug($html);
108			* //$value = $html->find('a[href=/gp/bestsellers/books/405436/ref=pd_zg_hrsr_books]', 0)->parent->parent->first_child->innertext;
109			* //ocument.querySelectorAll("a[href='/gp/bestsellers/books/405436/ref=pd_zg_hrsr_books']")[0].parentNode.parentNode.firstElementChild.innerText
110			* //$string = 'http://www.amazon.de/dp/3964433578';
111			* //$filter = '/(<span class=\"zg_hrsr_rank\">Nr. )(.)(<\/span><span class="zg_hrsr_ladder">in <a href="\/gp\/bestsellers)(.)(hrsr_books">)(.*)(<\/a><\/span>)/';
112			* //$filter = '/(<span class="zg_hrsr_rank">Nr. )(.*)(<\/span><span class="zg_hrsr_ladder">in <a href="\/gp\/bestsellers\/books\/405436\/ref=pd_zg_hrsr_books">Vietnamesisch)/';
113			* //$filter = '/(<span class="zg_hrsr_rank">Nr. )(.)(<\/span>)(.)(hrsr_books">)/';
114			* //$filter = '/(<span class="zg_hrsr_rank">Nr. )(?<value>.)(<\/span>\n )(.)(?<dimension>Vietnamesisch lernen)/';
115			* //$this->logger->debug('values all: '. json_encode($values));
116			* //$values = $values['value'];
117			* //$this->logger->debug('values first array: '. json_encode($values));**/
118			}
119			}

Rello / analytics

Push — master ( e7d759...857996 )

RegexService::read() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like