WantedPagesCLI::setup() - Code Metrics - Inspection of "Merge branch 'master' into svgpagetools" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — svgpagetools ( bbaba7...d7814e )

by Andreas

created 2017-08-15 20:08 UTC

WantedPagesCLI::setup() B

↳ Parent: WantedPagesCLI

Complexity

Conditions	1
Paths	1

Size

Total Lines	24
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	17
nc	1
nop	1
dl	0
loc	24
rs	8.9713
c	0
b	0
f	0

#!/usr/bin/php
<?php
if(!defined('DOKU_INC')) define('DOKU_INC', realpath(dirname(__FILE__) . '/../') . '/');
define('NOSESSION', 1);
require_once(DOKU_INC . 'inc/init.php');

/**
 * Find wanted pages
 */
class WantedPagesCLI extends DokuCLI {

    const DIR_CONTINUE = 1;
    const DIR_NS = 2;
    const DIR_PAGE = 3;

    private $skip = false;
    private $sort = 'wanted';

    private $result = array();

    /**
     * Register options and arguments on the given $options object
     *
     * @param DokuCLI_Options $options
     * @return void
     */
    protected function setup(DokuCLI_Options $options) {
        $options->setHelp(
            'Outputs a list of wanted pages (pages that do not exist yet) and their origin pages ' .
            ' (the pages that are linkin to these missing pages).'
        );
        $options->registerArgument(
            'namespace',
            'The namespace to lookup. Defaults to root namespace',
            false
        );

        $options->registerOption(
            'sort',
            'Sort by wanted or origin page',
            's',
            '(wanted|origin)'
        );

        $options->registerOption(
            'skip',
            'Do not show the second dimension',
            'k'
        );
    }

    /**
     * Your main program
     *
     * Arguments and options have been parsed when this is run
     *
     * @param DokuCLI_Options $options
     * @return void
     */
    protected function main(DokuCLI_Options $options) {

        if($options->args) {

            $startdir = dirname(wikiFN($options->args[0] . ':xxx'));
        } else {
            $startdir = dirname(wikiFN('xxx'));
        }

        $this->skip = $options->getOpt('skip');
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->sort = $options->getOpt('sort');
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        $this->info("searching $startdir");

        foreach($this->get_pages($startdir) as $page) {
            $this->internal_links($page);
        }
        ksort($this->result);
        foreach($this->result as $main => $subs) {
            if($this->skip) {
                print "$main\n";
            } else {
                $subs = array_unique($subs);
                sort($subs);
                foreach($subs as $sub) {
                    printf("%-40s %s\n", $main, $sub);
                }
            }
        }
    }

    /**
     * Determine directions of the search loop
     *
     * @param string $entry
     * @param string $basepath
     * @return int
     */
    protected function dir_filter($entry, $basepath) {
        if($entry == '.' || $entry == '..') {
            return WantedPagesCLI::DIR_CONTINUE;
        }
        if(is_dir($basepath . '/' . $entry)) {
            if(strpos($entry, '_') === 0) {
                return WantedPagesCLI::DIR_CONTINUE;
            }
            return WantedPagesCLI::DIR_NS;
        }
        if(preg_match('/\.txt$/', $entry)) {
            return WantedPagesCLI::DIR_PAGE;
        }
        return WantedPagesCLI::DIR_CONTINUE;
    }

    /**
     * Collects recursively the pages in a namespace
     *
     * @param string $dir
     * @return array
     * @throws DokuCLI_Exception
     */
    protected function get_pages($dir) {
        static $trunclen = null;
        if(!$trunclen) {
            global $conf;
            $trunclen = strlen($conf['datadir'] . ':');
        }

        if(!is_dir($dir)) {
            throw new DokuCLI_Exception("Unable to read directory $dir");
        }

        $pages = array();
        $dh = opendir($dir);
        while(false !== ($entry = readdir($dh))) {
            $status = $this->dir_filter($entry, $dir);
            if($status == WantedPagesCLI::DIR_CONTINUE) {
                continue;
            } else if($status == WantedPagesCLI::DIR_NS) {
                $pages = array_merge($pages, $this->get_pages($dir . '/' . $entry));
            } else {
                $page = array(
                    'id' => pathID(substr($dir . '/' . $entry, $trunclen)),
                    'file' => $dir . '/' . $entry,
                );
                $pages[] = $page;
            }
        }
        closedir($dh);
        return $pages;
    }

    /**
     * Parse instructions and add the non-existing links to the result array
     *
     * @param array $page array with page id and file path
     */
    function internal_links($page) {

        global $conf;
        $instructions = p_get_instructions(file_get_contents($page['file']));
        $cns = getNS($page['id']);
        $exists = false;
        $pid = $page['id'];
        foreach($instructions as $ins) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if($ins[0] == 'internallink' || ($conf['camelcase'] && $ins[0] == 'camelcaselink')) {
                $mid = $ins[1][0];
                resolve_pageid($cns, $mid, $exists);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
                if(!$exists) {
                    list($mid) = explode('#', $mid); //record pages without hashes

                    if($this->sort == 'origin') {
                        $this->result[$pid][] = $mid;
                    } else {
                        $this->result[$mid][] = $pid;
                    }
                }
            }
        }
    }
}

// Main
$cli = new WantedPagesCLI();
$cli->run();


1			#!/usr/bin/php
2			<?php
3			if(!defined('DOKU_INC')) define('DOKU_INC', realpath(dirname(__FILE__) . '/../') . '/');
4			define('NOSESSION', 1);
5			require_once(DOKU_INC . 'inc/init.php');
6
7			/**
8			* Find wanted pages
9			*/
10			class WantedPagesCLI extends DokuCLI {
11
12			const DIR_CONTINUE = 1;
13			const DIR_NS = 2;
14			const DIR_PAGE = 3;
15
16			private $skip = false;
17			private $sort = 'wanted';
18
19			private $result = array();
20
21			/**
22			* Register options and arguments on the given $options object
23			*
24			* @param DokuCLI_Options $options
25			* @return void
26			*/
27			protected function setup(DokuCLI_Options $options) {
28			$options->setHelp(
29			'Outputs a list of wanted pages (pages that do not exist yet) and their origin pages ' .
30			' (the pages that are linkin to these missing pages).'
31			);
32			$options->registerArgument(
33			'namespace',
34			'The namespace to lookup. Defaults to root namespace',
35			false
36			);
37
38			$options->registerOption(
39			'sort',
40			'Sort by wanted or origin page',
41			's',
42			'(wanted\|origin)'
43			);
44
45			$options->registerOption(
46			'skip',
47			'Do not show the second dimension',
48			'k'
49			);
50			}
51
52			/**
53			* Your main program
54			*
55			* Arguments and options have been parsed when this is run
56			*
57			* @param DokuCLI_Options $options
58			* @return void
59			*/
60			protected function main(DokuCLI_Options $options) {
61
62			if($options->args) {
			0 ignored issues – show Bug Best Practice introduced 2015-11-25 07:06 UTC by Report Bug Copy Issue Report The expression `$options->args` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
63			$startdir = dirname(wikiFN($options->args[0] . ':xxx'));
64			} else {
65			$startdir = dirname(wikiFN('xxx'));
66			}
67
68			$this->skip = $options->getOpt('skip');
			0 ignored issues – show Documentation Bug introduced 2017-07-28 08:08 UTC by Report Bug Copy Issue Report It seems like `$options->getOpt('skip')` can also be of type `string`. However, the property `$skip` is declared as type `boolean`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
69			$this->sort = $options->getOpt('sort');
			0 ignored issues – show Documentation Bug introduced 2017-07-28 08:08 UTC by Report Bug Copy Issue Report It seems like `$options->getOpt('sort')` can also be of type `boolean`. However, the property `$sort` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
70
71			$this->info("searching $startdir");
72
73			foreach($this->get_pages($startdir) as $page) {
74			$this->internal_links($page);
75			}
76			ksort($this->result);
77			foreach($this->result as $main => $subs) {
78			if($this->skip) {
79			print "$main\n";
80			} else {
81			$subs = array_unique($subs);
82			sort($subs);
83			foreach($subs as $sub) {
84			printf("%-40s %s\n", $main, $sub);
85			}
86			}
87			}
88			}
89
90			/**
91			* Determine directions of the search loop
92			*
93			* @param string $entry
94			* @param string $basepath
95			* @return int
96			*/
97			protected function dir_filter($entry, $basepath) {
98			if($entry == '.' \|\| $entry == '..') {
99			return WantedPagesCLI::DIR_CONTINUE;
100			}
101			if(is_dir($basepath . '/' . $entry)) {
102			if(strpos($entry, '_') === 0) {
103			return WantedPagesCLI::DIR_CONTINUE;
104			}
105			return WantedPagesCLI::DIR_NS;
106			}
107			if(preg_match('/\.txt$/', $entry)) {
108			return WantedPagesCLI::DIR_PAGE;
109			}
110			return WantedPagesCLI::DIR_CONTINUE;
111			}
112
113			/**
114			* Collects recursively the pages in a namespace
115			*
116			* @param string $dir
117			* @return array
118			* @throws DokuCLI_Exception
119			*/
120			protected function get_pages($dir) {
121			static $trunclen = null;
122			if(!$trunclen) {
123			global $conf;
124			$trunclen = strlen($conf['datadir'] . ':');
125			}
126
127			if(!is_dir($dir)) {
128			throw new DokuCLI_Exception("Unable to read directory $dir");
129			}
130
131			$pages = array();
132			$dh = opendir($dir);
133			while(false !== ($entry = readdir($dh))) {
134			$status = $this->dir_filter($entry, $dir);
135			if($status == WantedPagesCLI::DIR_CONTINUE) {
136			continue;
137			} else if($status == WantedPagesCLI::DIR_NS) {
138			$pages = array_merge($pages, $this->get_pages($dir . '/' . $entry));
139			} else {
140			$page = array(
141			'id' => pathID(substr($dir . '/' . $entry, $trunclen)),
142			'file' => $dir . '/' . $entry,
143			);
144			$pages[] = $page;
145			}
146			}
147			closedir($dh);
148			return $pages;
149			}
150
151			/**
152			* Parse instructions and add the non-existing links to the result array
153			*
154			* @param array $page array with page id and file path
155			*/
156			function internal_links($page) {
			0 ignored issues – show Best Practice introduced 2015-11-25 07:06 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
157			global $conf;
158			$instructions = p_get_instructions(file_get_contents($page['file']));
159			$cns = getNS($page['id']);
160			$exists = false;
161			$pid = $page['id'];
162			foreach($instructions as $ins) {
			0 ignored issues – show Bug introduced 2015-11-25 07:06 UTC by Report Bug Copy Issue Report The expression `$instructions` of type `array\|false` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
163			if($ins[0] == 'internallink' \|\| ($conf['camelcase'] && $ins[0] == 'camelcaselink')) {
164			$mid = $ins[1][0];
165			resolve_pageid($cns, $mid, $exists);
			0 ignored issues – show Security Bug introduced 2016-02-04 19:12 UTC by Report Bug Copy Issue Report It seems like `$cns` defined by `getNS($page['id'])` on line `159` can also be of type `false`; however, `resolve_pageid()` does only seem to accept `string`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
166			if(!$exists) {
167			list($mid) = explode('#', $mid); //record pages without hashes
168
169			if($this->sort == 'origin') {
170			$this->result[$pid][] = $mid;
171			} else {
172			$this->result[$mid][] = $pid;
173			}
174			}
175			}
176			}
177			}
178			}
179
180			// Main
181			$cli = new WantedPagesCLI();
182			$cli->run();
183

splitbrain / dokuwiki

Push — svgpagetools ( bbaba7...d7814e )

WantedPagesCLI::setup() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like