ImportTextFiles - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

ImportTextFiles A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	172
Duplicated Lines	2.91 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

Metric	Value
dl	5
loc	172
rs	10
c	0
b	0
f	0
wmc	30
lcom	1
cbo	8

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	1
F	execute()	5	154	29

How to fix Duplicated Code

<?php

/**
 * Import pages from text files
 *
 * 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
 * @ingroup Maintenance
 */

require_once __DIR__ . '/Maintenance.php';

/**
 * Maintenance script which reads in text files
 * and imports their content to a page of the wiki.
 *
 * @ingroup Maintenance
 */
class ImportTextFiles extends Maintenance {
	public function __construct() {
		parent::__construct();
		$this->addDescription( 'Reads in text files and imports their content to pages of the wiki' );
		$this->addOption( 'user', 'Username to which edits should be attributed. ' .
			'Default: "Maintenance script"', false, true, 'u' );
		$this->addOption( 'summary', 'Specify edit summary for the edits', false, true, 's' );
		$this->addOption( 'use-timestamp', 'Use the modification date of the text file ' .
			'as the timestamp for the edit' );
		$this->addOption( 'overwrite', 'Overwrite existing pages. If --use-timestamp is passed, this ' .
			'will only overwrite pages if the file has been modified since the page was last modified.' );
		$this->addOption( 'prefix', 'A string to place in front of the file name', false, true, 'p' );
		$this->addOption( 'bot', 'Mark edits as bot edits in the recent changes list.' );
		$this->addOption( 'rc', 'Place revisions in RecentChanges.' );
		$this->addArg( 'files', 'Files to import' );
	}

	public function execute() {
		$userName = $this->getOption( 'user', false );
		$summary = $this->getOption( 'summary', 'Imported from text file' );
		$useTimestamp = $this->hasOption( 'use-timestamp' );
		$rc = $this->hasOption( 'rc' );
		$bot = $this->hasOption( 'bot' );
		$overwrite = $this->hasOption( 'overwrite' );
		$prefix = $this->getOption( 'prefix', '' );

		// Get all the arguments. A loop is required since Maintenance doesn't
		// support an arbitrary number of arguments.
		$files = [];
		$i = 0;
		while ( $arg = $this->getArg( $i++ ) ) {
			if ( file_exists( $arg ) ) {
				$files[$arg] = file_get_contents( $arg );
			} else {
				// use glob to support the Windows shell, which doesn't automatically
				// expand wildcards
				$found = false;
				foreach ( glob( $arg ) as $filename ) {
					$found = true;
					$files[$filename] = file_get_contents( $filename );
				}
				if ( !$found ) {
					$this->error( "Fatal error: The file '$arg' does not exist!", 1 );
				}
			}
		};

		$count = count( $files );
		$this->output( "Importing $count pages...\n" );

		if ( $userName === false ) {
			$user = User::newSystemUser( 'Maintenance script', [ 'steal' => true ] );
		} else {
			$user = User::newFromName( $userName );
		}

		if ( !$user ) {
			$this->error( "Invalid username\n", true );
		}
		if ( $user->isAnon() ) {
			$user->addToDatabase();
		}

		$exit = 0;

		$successCount = 0;
		$failCount = 0;
		$skipCount = 0;

		foreach ( $files as $file => $text ) {
			$pageName = $prefix . pathinfo( $file, PATHINFO_FILENAME );
			$timestamp = $useTimestamp ? wfTimestamp( TS_UNIX, filemtime( $file ) ) : wfTimestampNow();

			$title = Title::newFromText( $pageName );
			// Have to check for # manually, since it gets interpreted as a fragment
			if ( !$title || $title->hasFragment() ) {
				$this->error( "Invalid title $pageName. Skipping.\n" );
				$skipCount++;
				continue;
			}

			$exists = $title->exists();
			$oldRevID = $title->getLatestRevID();
			$oldRev = $oldRevID ? Revision::newFromId( $oldRevID ) : null;
			$actualTitle = $title->getPrefixedText();

			if ( $exists ) {
				$touched = wfTimestamp( TS_UNIX, $title->getTouched() );
				if ( !$overwrite ) {
					$this->output( "Title $actualTitle already exists. Skipping.\n" );
					$skipCount++;
					continue;
				} elseif ( $useTimestamp && intval( $touched ) >= intval( $timestamp ) ) {
					$this->output( "File for title $actualTitle has not been modified since the " .
						"destination page was touched. Skipping.\n" );
					$skipCount++;
					continue;
				}
			}

			$rev = new WikiRevision( ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) );
			$rev->setText( rtrim( $text ) );
			$rev->setTitle( $title );
			$rev->setUserObj( $user );
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
			$rev->setComment( $summary );
			$rev->setTimestamp( $timestamp );
<?php

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

    return false;
}

			if ( $exists && $overwrite && $rev->getContent()->equals( $oldRev->getContent() ) ) {
				$this->output( "File for title $actualTitle contains no changes from the current " .
					"revision. Skipping.\n" );
				$skipCount++;
				continue;
			}

			$status = $rev->importOldRevision();
			$newId = $title->getLatestRevID();

			if ( $status ) {
				$action = $exists ? 'updated' : 'created';
				$this->output( "Successfully $action $actualTitle\n" );
				$successCount++;
			} else {
				$action = $exists ? 'update' : 'create';
				$this->output( "Failed to $action $actualTitle\n" );
				$failCount++;
				$exit = 1;
			}

			// Create the RecentChanges entry if necessary
			if ( $rc && $status ) {
				if ( $exists ) {
					if ( is_object( $oldRev ) ) {
						$oldContent = $oldRev->getContent();
						RecentChange::notifyEdit(
							$timestamp,
<?php

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

    return false;
}
							$title,
							$rev->getMinor(),
							$user,
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
							$summary,
							$oldRevID,
							$oldRev->getTimestamp(),

							$bot,
							'',
							$oldContent ? $oldContent->getSize() : 0,
							$rev->getContent()->getSize(),
							$newId,
							1 /* the pages don't need to be patrolled */
						);
					}
				} else {
					RecentChange::notifyNew(
						$timestamp,
<?php

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

    return false;
}
						$title,
						$rev->getMinor(),
						$user,
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
						$summary,
						$bot,
						'',
						$rev->getContent()->getSize(),
						$newId,
						1
					);
				}
			}
		}

		$this->output( "Done! $successCount succeeded, $skipCount skipped.\n" );
		if ( $exit ) {
			$this->error( "Import failed with $failCount failed pages.\n", $exit );
		}
	}
}

$maintClass = "ImportTextFiles";
require_once RUN_MAINTENANCE_IF_MAIN;


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 32 and the first side effect is on line 24. 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		* Import pages from text files
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		* @ingroup Maintenance
22		*/
23
24		require_once __DIR__ . '/Maintenance.php';
25
26		/**
27		* Maintenance script which reads in text files
28		* and imports their content to a page of the wiki.
29		*
30		* @ingroup Maintenance
31		*/
32		class ImportTextFiles extends Maintenance {
33		public function __construct() {
34		parent::__construct();
35		$this->addDescription( 'Reads in text files and imports their content to pages of the wiki' );
36		$this->addOption( 'user', 'Username to which edits should be attributed. ' .
37		'Default: "Maintenance script"', false, true, 'u' );
38		$this->addOption( 'summary', 'Specify edit summary for the edits', false, true, 's' );
39		$this->addOption( 'use-timestamp', 'Use the modification date of the text file ' .
40		'as the timestamp for the edit' );
41		$this->addOption( 'overwrite', 'Overwrite existing pages. If --use-timestamp is passed, this ' .
42		'will only overwrite pages if the file has been modified since the page was last modified.' );
43		$this->addOption( 'prefix', 'A string to place in front of the file name', false, true, 'p' );
44		$this->addOption( 'bot', 'Mark edits as bot edits in the recent changes list.' );
45		$this->addOption( 'rc', 'Place revisions in RecentChanges.' );
46		$this->addArg( 'files', 'Files to import' );
47		}
48
49		public function execute() {
50		$userName = $this->getOption( 'user', false );
51		$summary = $this->getOption( 'summary', 'Imported from text file' );
52		$useTimestamp = $this->hasOption( 'use-timestamp' );
53		$rc = $this->hasOption( 'rc' );
54		$bot = $this->hasOption( 'bot' );
55		$overwrite = $this->hasOption( 'overwrite' );
56		$prefix = $this->getOption( 'prefix', '' );
57
58		// Get all the arguments. A loop is required since Maintenance doesn't
59		// support an arbitrary number of arguments.
60		$files = [];
61		$i = 0;
62		while ( $arg = $this->getArg( $i++ ) ) {
63		if ( file_exists( $arg ) ) {
64		$files[$arg] = file_get_contents( $arg );
65		} else {
66		// use glob to support the Windows shell, which doesn't automatically
67		// expand wildcards
68		$found = false;
69		foreach ( glob( $arg ) as $filename ) {
70		$found = true;
71		$files[$filename] = file_get_contents( $filename );
72		}
73		if ( !$found ) {
74		$this->error( "Fatal error: The file '$arg' does not exist!", 1 );
75		}
76		}
77		};
78
79		$count = count( $files );
80		$this->output( "Importing $count pages...\n" );
81
82	View Code Duplication	if ( $userName === false ) {
83		$user = User::newSystemUser( 'Maintenance script', [ 'steal' => true ] );
84		} else {
85		$user = User::newFromName( $userName );
86		}
87
88		if ( !$user ) {
89		$this->error( "Invalid username\n", true );
90		}
91		if ( $user->isAnon() ) {
92		$user->addToDatabase();
93		}
94
95		$exit = 0;
96
97		$successCount = 0;
98		$failCount = 0;
99		$skipCount = 0;
100
101		foreach ( $files as $file => $text ) {
102		$pageName = $prefix . pathinfo( $file, PATHINFO_FILENAME );
103		$timestamp = $useTimestamp ? wfTimestamp( TS_UNIX, filemtime( $file ) ) : wfTimestampNow();
104
105		$title = Title::newFromText( $pageName );
106		// Have to check for # manually, since it gets interpreted as a fragment
107		if ( !$title \|\| $title->hasFragment() ) {
108		$this->error( "Invalid title $pageName. Skipping.\n" );
109		$skipCount++;
110		continue;
111		}
112
113		$exists = $title->exists();
114		$oldRevID = $title->getLatestRevID();
115		$oldRev = $oldRevID ? Revision::newFromId( $oldRevID ) : null;
116		$actualTitle = $title->getPrefixedText();
117
118		if ( $exists ) {
119		$touched = wfTimestamp( TS_UNIX, $title->getTouched() );
120		if ( !$overwrite ) {
121		$this->output( "Title $actualTitle already exists. Skipping.\n" );
122		$skipCount++;
123		continue;
124		} elseif ( $useTimestamp && intval( $touched ) >= intval( $timestamp ) ) {
125		$this->output( "File for title $actualTitle has not been modified since the " .
126		"destination page was touched. Skipping.\n" );
127		$skipCount++;
128		continue;
129		}
130		}
131
132		$rev = new WikiRevision( ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) );
133		$rev->setText( rtrim( $text ) );
134		$rev->setTitle( $title );
135		$rev->setUserObj( $user );
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `$user` can also be of type `false` or `null`; however, `WikiRevision::setUserObj()` does only seem to accept `object<User>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
136		$rev->setComment( $summary );
137		$rev->setTimestamp( $timestamp );
		0 ignored issues – show Security Bug introduced 2016-02-23 18:14 UTC by Report Bug Copy Issue Report It seems like `$timestamp` defined by `$useTimestamp ? wfTimest...le)) : wfTimestampNow()` on line `103` can also be of type `false`; however, `WikiRevision::setTimestamp()` 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...
138
139		if ( $exists && $overwrite && $rev->getContent()->equals( $oldRev->getContent() ) ) {
140		$this->output( "File for title $actualTitle contains no changes from the current " .
141		"revision. Skipping.\n" );
142		$skipCount++;
143		continue;
144		}
145
146		$status = $rev->importOldRevision();
147		$newId = $title->getLatestRevID();
148
149		if ( $status ) {
150		$action = $exists ? 'updated' : 'created';
151		$this->output( "Successfully $action $actualTitle\n" );
152		$successCount++;
153		} else {
154		$action = $exists ? 'update' : 'create';
155		$this->output( "Failed to $action $actualTitle\n" );
156		$failCount++;
157		$exit = 1;
158		}
159
160		// Create the RecentChanges entry if necessary
161		if ( $rc && $status ) {
162		if ( $exists ) {
163		if ( is_object( $oldRev ) ) {
164		$oldContent = $oldRev->getContent();
165		RecentChange::notifyEdit(
166		$timestamp,
		0 ignored issues – show Security Bug introduced 2016-02-23 18:14 UTC by Report Bug Copy Issue Report It seems like `$timestamp` defined by `$useTimestamp ? wfTimest...le)) : wfTimestampNow()` on line `103` can also be of type `false`; however, `RecentChange::notifyEdit()` 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...
167		$title,
168		$rev->getMinor(),
169		$user,
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `$user` can also be of type `false` or `null`; however, `RecentChange::notifyEdit()` does only seem to accept `object<User>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
170		$summary,
171		$oldRevID,
172		$oldRev->getTimestamp(),
		0 ignored issues – show Security Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `$oldRev->getTimestamp()` targeting `Revision::getTimestamp()` can also be of type `false`; however, `RecentChange::notifyEdit()` does only seem to accept `string`, did you maybe forget to handle an error condition? Loading history...
173		$bot,
174		'',
175		$oldContent ? $oldContent->getSize() : 0,
176		$rev->getContent()->getSize(),
177		$newId,
178		1 /* the pages don't need to be patrolled */
179		);
180		}
181		} else {
182		RecentChange::notifyNew(
183		$timestamp,
		0 ignored issues – show Security Bug introduced 2016-02-23 18:14 UTC by Report Bug Copy Issue Report It seems like `$timestamp` defined by `$useTimestamp ? wfTimest...le)) : wfTimestampNow()` on line `103` can also be of type `false`; however, `RecentChange::notifyNew()` 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...
184		$title,
185		$rev->getMinor(),
186		$user,
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `$user` can also be of type `false` or `null`; however, `RecentChange::notifyNew()` does only seem to accept `object<User>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
187		$summary,
188		$bot,
189		'',
190		$rev->getContent()->getSize(),
191		$newId,
192		1
193		);
194		}
195		}
196		}
197
198		$this->output( "Done! $successCount succeeded, $skipCount skipped.\n" );
199		if ( $exit ) {
200		$this->error( "Import failed with $failCount failed pages.\n", $exit );
201		}
202		}
203		}
204
205		$maintClass = "ImportTextFiles";
206		require_once RUN_MAINTENANCE_IF_MAIN;
207

wikimedia / mediawiki

ImportTextFiles A last analyzed 2016-11-13 17:42 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

ImportTextFiles A
last analyzed 2016-11-13 17:42 UTC