DeleteOldRevisions::doDelete() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

DeleteOldRevisions::doDelete() B
last analyzed 2016-11-13 17:42 UTC

↳ Parent: DeleteOldRevisions

Complexity

Conditions	8
Paths	64

Size

Total Lines	55
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	32
nc	64
nop	2
dl	0
loc	55
rs	7.4033
c	0
b	0
f	0

How to fix Long Method

<?php

/**
 * Delete old (non-current) revisions from the database
 *
 * 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
 * @author Rob Church <[email protected]>
 */

require_once __DIR__ . '/Maintenance.php';

/**
 * Maintenance script that deletes old (non-current) revisions from the database.
 *
 * @ingroup Maintenance
 */
class DeleteOldRevisions extends Maintenance {
	public function __construct() {
		parent::__construct();
		$this->addDescription( 'Delete old (non-current) revisions from the database' );
		$this->addOption( 'delete', 'Actually perform the deletion' );
		$this->addOption( 'page_id', 'List of page ids to work on', false );
	}

	public function execute() {
		$this->output( "Delete old revisions\n\n" );
		$this->doDelete( $this->hasOption( 'delete' ), $this->mArgs );
	}

	function doDelete( $delete = false, $args = [] ) {

		# Data should come off the master, wrapped in a transaction
		$dbw = $this->getDB( DB_MASTER );
		$this->beginTransaction( $dbw, __METHOD__ );
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

		$pageConds = [];
		$revConds = [];

		# If a list of page_ids was provided, limit results to that set of page_ids
		if ( count( $args ) > 0 ) {
			$pageConds['page_id'] = $args;
			$revConds['rev_page'] = $args;
			$this->output( "Limiting to page IDs " . implode( ',', $args ) . "\n" );
		}

		# Get "active" revisions from the page table
		$this->output( "Searching for active revisions..." );
		$res = $dbw->select( 'page', 'page_latest', $pageConds, __METHOD__ );
		$latestRevs = [];
		foreach ( $res as $row ) {
			$latestRevs[] = $row->page_latest;
		}
		$this->output( "done.\n" );

		# Get all revisions that aren't in this set
		$this->output( "Searching for inactive revisions..." );
		if ( count( $latestRevs ) > 0 ) {
			$revConds[] = 'rev_id NOT IN (' . $dbw->makeList( $latestRevs ) . ')';
		}
		$res = $dbw->select( 'revision', 'rev_id', $revConds, __METHOD__ );
		$oldRevs = [];
		foreach ( $res as $row ) {
			$oldRevs[] = $row->rev_id;
		}
		$this->output( "done.\n" );

		# Inform the user of what we're going to do
		$count = count( $oldRevs );
		$this->output( "$count old revisions found.\n" );

		# Delete as appropriate
		if ( $delete && $count ) {
			$this->output( "Deleting..." );
			$dbw->delete( 'revision', [ 'rev_id' => $oldRevs ], __METHOD__ );
			$this->output( "done.\n" );
		}

		# This bit's done
		# Purge redundant text records
		$this->commitTransaction( $dbw, __METHOD__ );
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
		if ( $delete ) {
			$this->purgeRedundantText( true );
		}
	}
}

$maintClass = "DeleteOldRevisions";
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 25. 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			* Delete old (non-current) revisions from the database
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			* @author Rob Church <[email protected]>
23			*/
24
25			require_once __DIR__ . '/Maintenance.php';
26
27			/**
28			* Maintenance script that deletes old (non-current) revisions from the database.
29			*
30			* @ingroup Maintenance
31			*/
32			class DeleteOldRevisions extends Maintenance {
33			public function __construct() {
34			parent::__construct();
35			$this->addDescription( 'Delete old (non-current) revisions from the database' );
36			$this->addOption( 'delete', 'Actually perform the deletion' );
37			$this->addOption( 'page_id', 'List of page ids to work on', false );
38			}
39
40			public function execute() {
41			$this->output( "Delete old revisions\n\n" );
42			$this->doDelete( $this->hasOption( 'delete' ), $this->mArgs );
43			}
44
45			function doDelete( $delete = false, $args = [] ) {
46
47			# Data should come off the master, wrapped in a transaction
48			$dbw = $this->getDB( DB_MASTER );
49			$this->beginTransaction( $dbw, __METHOD__ );
			0 ignored issues – show Bug introduced 2016-09-24 18:22 UTC by Report Bug Copy Issue Report It seems like `$dbw` defined by `$this->getDB(DB_MASTER)` on line `48` can be `null`; however, `Maintenance::beginTransaction()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
50
51			$pageConds = [];
52			$revConds = [];
53
54			# If a list of page_ids was provided, limit results to that set of page_ids
55			if ( count( $args ) > 0 ) {
56			$pageConds['page_id'] = $args;
57			$revConds['rev_page'] = $args;
58			$this->output( "Limiting to page IDs " . implode( ',', $args ) . "\n" );
59			}
60
61			# Get "active" revisions from the page table
62			$this->output( "Searching for active revisions..." );
63			$res = $dbw->select( 'page', 'page_latest', $pageConds, __METHOD__ );
64			$latestRevs = [];
65			foreach ( $res as $row ) {
66			$latestRevs[] = $row->page_latest;
67			}
68			$this->output( "done.\n" );
69
70			# Get all revisions that aren't in this set
71			$this->output( "Searching for inactive revisions..." );
72			if ( count( $latestRevs ) > 0 ) {
73			$revConds[] = 'rev_id NOT IN (' . $dbw->makeList( $latestRevs ) . ')';
74			}
75			$res = $dbw->select( 'revision', 'rev_id', $revConds, __METHOD__ );
76			$oldRevs = [];
77			foreach ( $res as $row ) {
78			$oldRevs[] = $row->rev_id;
79			}
80			$this->output( "done.\n" );
81
82			# Inform the user of what we're going to do
83			$count = count( $oldRevs );
84			$this->output( "$count old revisions found.\n" );
85
86			# Delete as appropriate
87			if ( $delete && $count ) {
88			$this->output( "Deleting..." );
89			$dbw->delete( 'revision', [ 'rev_id' => $oldRevs ], __METHOD__ );
90			$this->output( "done.\n" );
91			}
92
93			# This bit's done
94			# Purge redundant text records
95			$this->commitTransaction( $dbw, __METHOD__ );
			0 ignored issues – show Bug introduced 2016-09-24 18:22 UTC by Report Bug Copy Issue Report It seems like `$dbw` defined by `$this->getDB(DB_MASTER)` on line `48` can be `null`; however, `Maintenance::commitTransaction()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
96			if ( $delete ) {
97			$this->purgeRedundantText( true );
98			}
99			}
100			}
101
102			$maintClass = "DeleteOldRevisions";
103			require_once RUN_MAINTENANCE_IF_MAIN;
104

wikimedia / mediawiki

DeleteOldRevisions::doDelete() B last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

DeleteOldRevisions::doDelete() B
last analyzed 2016-11-13 17:42 UTC