WantedPagesCLI::main() - Code Metrics - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

WantedPagesCLI::main() B
last analyzed 2021-06-08 18:02 UTC

↳ Parent: WantedPagesCLI

Complexity

Conditions	6
Paths	16

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
nc	16
nop	1
dl	0
loc	29
rs	8.8337
c	0
b	0
f	0

#!/usr/bin/env php
<?php

use splitbrain\phpcli\CLI;
use splitbrain\phpcli\Options;
use dokuwiki\Utf8\Sort;

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 CLI {

    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 Options $options
     * @return void
     */
    protected function setup(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 Options $options
     * @return void
     */
    protected function main(Options $options) {
        $args = $options->getArgs();
        if($args) {

            $startdir = dirname(wikiFN($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->getPages($startdir) as $page) {
            $this->internalLinks($page);
        }
        Sort::ksort($this->result);
        foreach($this->result as $main => $subs) {
            if($this->skip) {
                print "$main\n";
            } else {
                $subs = array_unique($subs);
                Sort::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 dirFilter($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 getPages($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->dirFilter($entry, $dir);
            if($status == WantedPagesCLI::DIR_CONTINUE) {
                continue;
            } else if($status == WantedPagesCLI::DIR_NS) {
                $pages = array_merge($pages, $this->getPages($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
     */
    protected function internalLinks($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) {
            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/env php
2			<?php
3
4			use splitbrain\phpcli\CLI;
5			use splitbrain\phpcli\Options;
6			use dokuwiki\Utf8\Sort;
7
8			if(!defined('DOKU_INC')) define('DOKU_INC', realpath(dirname(__FILE__) . '/../') . '/');
9			define('NOSESSION', 1);
10			require_once(DOKU_INC . 'inc/init.php');
11
12			/**
13			* Find wanted pages
14			*/
15			class WantedPagesCLI extends CLI {
16
17			const DIR_CONTINUE = 1;
18			const DIR_NS = 2;
19			const DIR_PAGE = 3;
20
21			private $skip = false;
22			private $sort = 'wanted';
23
24			private $result = array();
25
26			/**
27			* Register options and arguments on the given $options object
28			*
29			* @param Options $options
30			* @return void
31			*/
32			protected function setup(Options $options) {
33			$options->setHelp(
34			'Outputs a list of wanted pages (pages that do not exist yet) and their origin pages ' .
35			' (the pages that are linkin to these missing pages).'
36			);
37			$options->registerArgument(
38			'namespace',
39			'The namespace to lookup. Defaults to root namespace',
40			false
41			);
42
43			$options->registerOption(
44			'sort',
45			'Sort by wanted or origin page',
46			's',
47			'(wanted\|origin)'
48			);
49
50			$options->registerOption(
51			'skip',
52			'Do not show the second dimension',
53			'k'
54			);
55			}
56
57			/**
58			* Your main program
59			*
60			* Arguments and options have been parsed when this is run
61			*
62			* @param Options $options
63			* @return void
64			*/
65			protected function main(Options $options) {
66			$args = $options->getArgs();
67			if($args) {
			0 ignored issues – show Bug Best Practice introduced 2017-11-10 16:53 UTC by Report Bug Copy Issue Report The expression `$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...
68			$startdir = dirname(wikiFN($args[0] . ':xxx'));
69			} else {
70			$startdir = dirname(wikiFN('xxx'));
71			}
72
73			$this->skip = $options->getOpt('skip');
			0 ignored issues – show Documentation Bug introduced 2018-04-13 06:51 UTC by Report Bug Copy Issue Report It seems like `$options->getOpt('skip')` can also be of type `string` or `array<integer,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...
74			$this->sort = $options->getOpt('sort');
			0 ignored issues – show Documentation Bug introduced 2018-04-13 06:51 UTC by Report Bug Copy Issue Report It seems like `$options->getOpt('sort')` can also be of type `boolean` or `array<integer,string>`. 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...
75
76			$this->info("searching $startdir");
77
78			foreach($this->getPages($startdir) as $page) {
79			$this->internalLinks($page);
80			}
81			Sort::ksort($this->result);
82			foreach($this->result as $main => $subs) {
83			if($this->skip) {
84			print "$main\n";
85			} else {
86			$subs = array_unique($subs);
87			Sort::sort($subs);
88			foreach($subs as $sub) {
89			printf("%-40s %s\n", $main, $sub);
90			}
91			}
92			}
93			}
94
95			/**
96			* Determine directions of the search loop
97			*
98			* @param string $entry
99			* @param string $basepath
100			* @return int
101			*/
102			protected function dirFilter($entry, $basepath) {
103			if($entry == '.' \|\| $entry == '..') {
104			return WantedPagesCLI::DIR_CONTINUE;
105			}
106			if(is_dir($basepath . '/' . $entry)) {
107			if(strpos($entry, '_') === 0) {
108			return WantedPagesCLI::DIR_CONTINUE;
109			}
110			return WantedPagesCLI::DIR_NS;
111			}
112			if(preg_match('/\.txt$/', $entry)) {
113			return WantedPagesCLI::DIR_PAGE;
114			}
115			return WantedPagesCLI::DIR_CONTINUE;
116			}
117
118			/**
119			* Collects recursively the pages in a namespace
120			*
121			* @param string $dir
122			* @return array
123			* @throws DokuCLI_Exception
124			*/
125			protected function getPages($dir) {
126			static $trunclen = null;
127			if(!$trunclen) {
128			global $conf;
129			$trunclen = strlen($conf['datadir'] . ':');
130			}
131
132			if(!is_dir($dir)) {
133			throw new DokuCLI_Exception("Unable to read directory $dir");
134			}
135
136			$pages = array();
137			$dh = opendir($dir);
138			while(false !== ($entry = readdir($dh))) {
139			$status = $this->dirFilter($entry, $dir);
140			if($status == WantedPagesCLI::DIR_CONTINUE) {
141			continue;
142			} else if($status == WantedPagesCLI::DIR_NS) {
143			$pages = array_merge($pages, $this->getPages($dir . '/' . $entry));
144			} else {
145			$page = array(
146			'id' => pathID(substr($dir . '/' . $entry, $trunclen)),
147			'file' => $dir . '/' . $entry,
148			);
149			$pages[] = $page;
150			}
151			}
152			closedir($dh);
153			return $pages;
154			}
155
156			/**
157			* Parse instructions and add the non-existing links to the result array
158			*
159			* @param array $page array with page id and file path
160			*/
161			protected function internalLinks($page) {
162			global $conf;
163			$instructions = p_get_instructions(file_get_contents($page['file']));
164			$cns = getNS($page['id']);
165			$exists = false;
166			$pid = $page['id'];
167			foreach($instructions as $ins) {
168			if($ins[0] == 'internallink' \|\| ($conf['camelcase'] && $ins[0] == 'camelcaselink')) {
169			$mid = $ins[1][0];
170			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 `164` 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...
171			if(!$exists) {
172			list($mid) = explode('#', $mid); //record pages without hashes
173
174			if($this->sort == 'origin') {
175			$this->result[$pid][] = $mid;
176			} else {
177			$this->result[$mid][] = $pid;
178			}
179			}
180			}
181			}
182			}
183			}
184
185			// Main
186			$cli = new WantedPagesCLI();
187			$cli->run();
188

splitbrain / dokuwiki

WantedPagesCLI::main() B last analyzed 2021-06-08 18:02 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WantedPagesCLI::main() B
last analyzed 2021-06-08 18:02 UTC