cdb.php ➔ cdbShowHelp() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

cdb.php ➔ cdbShowHelp() B
last analyzed 2016-11-13 17:42 UTC

↳ Parent: Project

Complexity

Conditions	5
Paths	8

Size

Total Lines	22
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	17
nc	8
nop	1
dl	0
loc	22
rs	8.6737
c	0
b	0
f	0

<?php

/**
 * cdb inspector tool
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @todo document
 * @ingroup Maintenance
 */
use \Cdb\Exception as CdbException;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use \Cdb\Reader as CdbReader;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

/** */
require_once __DIR__ . '/commandLine.inc';

function cdbShowHelp( $command ) {
	$commandList = [
		'load' => 'load a cdb file for reading',
		'get' => 'get a value for a key',
		'exit' => 'exit cdb',
		'quit' => 'exit cdb',
		'help' => 'help about a command',
	];
	if ( !$command ) {
		$command = 'fullhelp';
	}
	if ( $command === 'fullhelp' ) {
		$max_cmd_len = max( array_map( 'strlen', array_keys( $commandList ) ) );
		foreach ( $commandList as $cmd => $desc ) {
			printf( "%-{$max_cmd_len}s: %s\n", $cmd, $desc );
		}
	} elseif ( isset( $commandList[$command] ) ) {
		print "$command: $commandList[$command]\n";
	} else {
		print "$command: command does not exist or no help for it\n";
	}
}

do {
	$bad = false;
	$showhelp = false;
	$quit = false;
	static $fileHandle = false;

	$line = Maintenance::readconsole();
	if ( $line === false ) {
		exit;
	}

	$args = explode( ' ', $line, 2 );
	$command = array_shift( $args );

	// process command
	switch ( $command ) {
		case 'help':
			// show an help message
			cdbShowHelp( array_shift( $args ) );
			break;
		case 'load':
			if ( !isset( $args[0] ) ) {
				print "Need a filename there buddy\n";
				break;
			}
			$file = $args[0];
			print "Loading cdb file $file...";
			try {
				$fileHandle = CdbReader::open( $file );
			} catch ( CdbException $e ) {

			}

			if ( !$fileHandle ) {
				print "not a cdb file or unable to read it\n";
			} else {
				print "ok\n";
			}
			break;
		case 'get':
			if ( !$fileHandle ) {
				print "Need to load a cdb file first\n";
				break;
			}
			if ( !isset( $args[0] ) ) {
				print "Need to specify a key, Luke\n";
				break;
			}
			try {
				$res = $fileHandle->get( $args[0] );
			} catch ( CdbException $e ) {
				print "Unable to read key from file\n";
				break;
			}
			if ( $res === false ) {
				print "No such key/value pair\n";
			} elseif ( is_string( $res ) ) {
				print "$res\n";
			} else {
				var_dump( $res );

			}
			break;
		case 'quit':
		case 'exit':
			$quit = true;
			break;

		default:
			$bad = true;
	} // switch() end

	if ( $bad ) {
		if ( $command ) {
			print "Bad command\n";
		}
	} else {
		if ( function_exists( 'readline_add_history' ) ) {
			readline_add_history( $line );
		}
	}
} while ( !$quit );


1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2016-02-23 18:14 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 30 and the first side effect is on line 28. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2		/**
3		* cdb inspector tool
4		*
5		* This program is free software; you can redistribute it and/or modify
6		* it under the terms of the GNU General Public License as published by
7		* the Free Software Foundation; either version 2 of the License, or
8		* (at your option) any later version.
9		*
10		* This program is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13		* GNU General Public License for more details.
14		*
15		* You should have received a copy of the GNU General Public License along
16		* with this program; if not, write to the Free Software Foundation, Inc.,
17		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18		* http://www.gnu.org/copyleft/gpl.html
19		*
20		* @file
21		* @todo document
22		* @ingroup Maintenance
23		*/
24		use \Cdb\Exception as CdbException;
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `CdbException`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
25		use \Cdb\Reader as CdbReader;
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `CdbReader`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
26
27		/** */
28		require_once __DIR__ . '/commandLine.inc';
29
30		function cdbShowHelp( $command ) {
31		$commandList = [
32		'load' => 'load a cdb file for reading',
33		'get' => 'get a value for a key',
34		'exit' => 'exit cdb',
35		'quit' => 'exit cdb',
36		'help' => 'help about a command',
37		];
38		if ( !$command ) {
39		$command = 'fullhelp';
40		}
41		if ( $command === 'fullhelp' ) {
42		$max_cmd_len = max( array_map( 'strlen', array_keys( $commandList ) ) );
43		foreach ( $commandList as $cmd => $desc ) {
44		printf( "%-{$max_cmd_len}s: %s\n", $cmd, $desc );
45		}
46		} elseif ( isset( $commandList[$command] ) ) {
47		print "$command: $commandList[$command]\n";
48		} else {
49		print "$command: command does not exist or no help for it\n";
50		}
51		}
52
53		do {
54		$bad = false;
55		$showhelp = false;
56		$quit = false;
57		static $fileHandle = false;
58
59		$line = Maintenance::readconsole();
60		if ( $line === false ) {
61		exit;
62		}
63
64		$args = explode( ' ', $line, 2 );
65		$command = array_shift( $args );
66
67		// process command
68		switch ( $command ) {
69		case 'help':
70		// show an help message
71		cdbShowHelp( array_shift( $args ) );
72		break;
73		case 'load':
74		if ( !isset( $args[0] ) ) {
75		print "Need a filename there buddy\n";
76		break;
77		}
78		$file = $args[0];
79		print "Loading cdb file $file...";
80		try {
81		$fileHandle = CdbReader::open( $file );
82		} catch ( CdbException $e ) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
83		}
84
85		if ( !$fileHandle ) {
86		print "not a cdb file or unable to read it\n";
87		} else {
88		print "ok\n";
89		}
90		break;
91		case 'get':
92		if ( !$fileHandle ) {
93		print "Need to load a cdb file first\n";
94		break;
95		}
96		if ( !isset( $args[0] ) ) {
97		print "Need to specify a key, Luke\n";
98		break;
99		}
100		try {
101		$res = $fileHandle->get( $args[0] );
102		} catch ( CdbException $e ) {
103		print "Unable to read key from file\n";
104		break;
105		}
106	View Code Duplication	if ( $res === false ) {
107		print "No such key/value pair\n";
108		} elseif ( is_string( $res ) ) {
109		print "$res\n";
110		} else {
111		var_dump( $res );
		0 ignored issues – show Security Debugging Code introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report `var_dump($res);` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
112		}
113		break;
114		case 'quit':
115		case 'exit':
116		$quit = true;
117		break;
118
119		default:
120		$bad = true;
121		} // switch() end
122
123		if ( $bad ) {
124		if ( $command ) {
125		print "Bad command\n";
126		}
127		} else {
128		if ( function_exists( 'readline_add_history' ) ) {
129		readline_add_history( $line );
130		}
131		}
132		} while ( !$quit );
133

wikimedia / mediawiki

cdb.php ➔ cdbShowHelp() B last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

cdb.php ➔ cdbShowHelp() B
last analyzed 2016-11-13 17:42 UTC