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

ApiQueryContributors::__construct() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: ApiQueryContributors

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	2
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Query the list of contributors to a page
 *
 * Created on Nov 14, 2013
 *
 * Copyright © 2013 Brad Jorsch
 *
 * 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
 * @since 1.23
 */

/**
 * A query module to show contributors to a page
 *
 * @ingroup API
 * @since 1.23
 */
class ApiQueryContributors extends ApiQueryBase {
	/** We don't want to process too many pages at once (it hits cold
	 * database pages too heavily), so only do the first MAX_PAGES input pages
	 * in each API call (leaving the rest for continuation).
	 */
	const MAX_PAGES = 100;

	public function __construct( ApiQuery $query, $moduleName ) {
		// "pc" is short for "page contributors", "co" was already taken by the
		// GeoData extension's prop=coordinates.
		parent::__construct( $query, $moduleName, 'pc' );
	}

	public function execute() {
		$db = $this->getDB();
		$params = $this->extractRequestParams();
		$this->requireMaxOneParameter( $params, 'group', 'excludegroup', 'rights', 'excluderights' );

		// Only operate on existing pages
		$pages = array_keys( $this->getPageSet()->getGoodTitles() );

		// Filter out already-processed pages
		if ( $params['continue'] !== null ) {
			$cont = explode( '|', $params['continue'] );
			$this->dieContinueUsageIf( count( $cont ) != 2 );
			$cont_page = (int)$cont[0];
			$pages = array_filter( $pages, function ( $v ) use ( $cont_page ) {
				return $v >= $cont_page;
			} );
		}
		if ( !count( $pages ) ) {
			// Nothing to do
			return;
		}

		// Apply MAX_PAGES, leaving any over the limit for a continue.
		sort( $pages );
		$continuePages = null;
		if ( count( $pages ) > self::MAX_PAGES ) {
			$continuePages = $pages[self::MAX_PAGES] . '|0';
			$pages = array_slice( $pages, 0, self::MAX_PAGES );
		}

		$result = $this->getResult();

		// First, count anons
		$this->addTables( 'revision' );
		$this->addFields( [
			'page' => 'rev_page',
			'anons' => 'COUNT(DISTINCT rev_user_text)',
		] );
		$this->addWhereFld( 'rev_page', $pages );
		$this->addWhere( 'rev_user = 0' );
		$this->addWhere( $db->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' );
		$this->addOption( 'GROUP BY', 'rev_page' );
		$res = $this->select( __METHOD__ );
		foreach ( $res as $row ) {
			$fit = $result->addValue( [ 'query', 'pages', $row->page ],
				'anoncontributors', (int)$row->anons
			);
			if ( !$fit ) {
				// This not fitting isn't reasonable, so it probably means that
				// some other module used up all the space. Just set a dummy
				// continue and hope it works next time.
				$this->setContinueEnumParameter( 'continue',
					$params['continue'] !== null ? $params['continue'] : '0|0'
				);

				return;
			}
		}

		// Next, add logged-in users
		$this->resetQueryParams();
		$this->addTables( 'revision' );
		$this->addFields( [
			'page' => 'rev_page',
			'user' => 'rev_user',
			'username' => 'MAX(rev_user_text)', // Non-MySQL databases don't like partial group-by
		] );
		$this->addWhereFld( 'rev_page', $pages );
		$this->addWhere( 'rev_user != 0' );
		$this->addWhere( $db->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' );
		$this->addOption( 'GROUP BY', 'rev_page, rev_user' );
		$this->addOption( 'LIMIT', $params['limit'] + 1 );

		// Force a sort order to ensure that properties are grouped by page
		// But only if pp_page is not constant in the WHERE clause.
		if ( count( $pages ) > 1 ) {
			$this->addOption( 'ORDER BY', 'rev_page, rev_user' );
		} else {
			$this->addOption( 'ORDER BY', 'rev_user' );
		}

		$limitGroups = [];
		if ( $params['group'] ) {
			$excludeGroups = false;
			$limitGroups = $params['group'];
		} elseif ( $params['excludegroup'] ) {
			$excludeGroups = true;
			$limitGroups = $params['excludegroup'];
		} elseif ( $params['rights'] ) {
			$excludeGroups = false;
			foreach ( $params['rights'] as $r ) {
				$limitGroups = array_merge( $limitGroups, User::getGroupsWithPermission( $r ) );
			}

			// If no group has the rights requested, no need to query
			if ( !$limitGroups ) {
				if ( $continuePages !== null ) {
					// But we still need to continue for the next page's worth
					// of anoncontributors
					$this->setContinueEnumParameter( 'continue', $continuePages );
				}

				return;
			}
		} elseif ( $params['excluderights'] ) {
			$excludeGroups = true;
			foreach ( $params['excluderights'] as $r ) {
				$limitGroups = array_merge( $limitGroups, User::getGroupsWithPermission( $r ) );
			}
		}

		if ( $limitGroups ) {
			$limitGroups = array_unique( $limitGroups );
			$this->addTables( 'user_groups' );
			$this->addJoinConds( [ 'user_groups' => [
				$excludeGroups ? 'LEFT OUTER JOIN' : 'INNER JOIN',
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
				[ 'ug_user=rev_user', 'ug_group' => $limitGroups ]
			] ] );
			$this->addWhereIf( 'ug_user IS NULL', $excludeGroups );
		}

		if ( $params['continue'] !== null ) {
			$cont = explode( '|', $params['continue'] );
			$this->dieContinueUsageIf( count( $cont ) != 2 );
			$cont_page = (int)$cont[0];
			$cont_user = (int)$cont[1];
			$this->addWhere(
				"rev_page > $cont_page OR " .
				"(rev_page = $cont_page AND " .
				"rev_user >= $cont_user)"
			);
		}

		$res = $this->select( __METHOD__ );
		$count = 0;
		foreach ( $res as $row ) {
			if ( ++$count > $params['limit'] ) {
				// We've reached the one extra which shows that
				// there are additional pages to be had. Stop here...
				$this->setContinueEnumParameter( 'continue', $row->page . '|' . $row->user );

				return;
			}

			$fit = $this->addPageSubItem( $row->page,
				[ 'userid' => (int)$row->user, 'name' => $row->username ],
				'user'
			);
			if ( !$fit ) {
				$this->setContinueEnumParameter( 'continue', $row->page . '|' . $row->user );

				return;
			}
		}

		if ( $continuePages !== null ) {
			$this->setContinueEnumParameter( 'continue', $continuePages );
		}
	}

	public function getCacheMode( $params ) {
		return 'public';
	}

	public function getAllowedParams() {
		$userGroups = User::getAllGroups();
		$userRights = User::getAllRights();

		return [
			'group' => [
				ApiBase::PARAM_TYPE => $userGroups,
				ApiBase::PARAM_ISMULTI => true,
			],
			'excludegroup' => [
				ApiBase::PARAM_TYPE => $userGroups,
				ApiBase::PARAM_ISMULTI => true,
			],
			'rights' => [
				ApiBase::PARAM_TYPE => $userRights,
				ApiBase::PARAM_ISMULTI => true,
			],
			'excluderights' => [
				ApiBase::PARAM_TYPE => $userRights,
				ApiBase::PARAM_ISMULTI => true,
			],
			'limit' => [
				ApiBase::PARAM_DFLT => 10,
				ApiBase::PARAM_TYPE => 'limit',
				ApiBase::PARAM_MIN => 1,
				ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
				ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
			],
			'continue' => [
				ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
			],
		];
	}

	protected function getExamplesMessages() {
		return [
			'action=query&prop=contributors&titles=Main_Page'
				=> 'apihelp-query+contributors-example-simple',
		];
	}

	public function getHelpUrls() {
		return 'https://www.mediawiki.org/wiki/API:Contributors';
	}
}


1		<?php
2		/**
3		* Query the list of contributors to a page
4		*
5		* Created on Nov 14, 2013
6		*
7		* Copyright © 2013 Brad Jorsch
8		*
9		* This program is free software; you can redistribute it and/or modify
10		* it under the terms of the GNU General Public License as published by
11		* the Free Software Foundation; either version 2 of the License, or
12		* (at your option) any later version.
13		*
14		* This program is distributed in the hope that it will be useful,
15		* but WITHOUT ANY WARRANTY; without even the implied warranty of
16		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17		* GNU General Public License for more details.
18		*
19		* You should have received a copy of the GNU General Public License along
20		* with this program; if not, write to the Free Software Foundation, Inc.,
21		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22		* http://www.gnu.org/copyleft/gpl.html
23		*
24		* @file
25		* @since 1.23
26		*/
27
28		/**
29		* A query module to show contributors to a page
30		*
31		* @ingroup API
32		* @since 1.23
33		*/
34		class ApiQueryContributors extends ApiQueryBase {
35		/** We don't want to process too many pages at once (it hits cold
36		* database pages too heavily), so only do the first MAX_PAGES input pages
37		* in each API call (leaving the rest for continuation).
38		*/
39		const MAX_PAGES = 100;
40
41		public function __construct( ApiQuery $query, $moduleName ) {
42		// "pc" is short for "page contributors", "co" was already taken by the
43		// GeoData extension's prop=coordinates.
44		parent::__construct( $query, $moduleName, 'pc' );
45		}
46
47		public function execute() {
48		$db = $this->getDB();
49		$params = $this->extractRequestParams();
50		$this->requireMaxOneParameter( $params, 'group', 'excludegroup', 'rights', 'excluderights' );
51
52		// Only operate on existing pages
53		$pages = array_keys( $this->getPageSet()->getGoodTitles() );
54
55		// Filter out already-processed pages
56		if ( $params['continue'] !== null ) {
57		$cont = explode( '\|', $params['continue'] );
58		$this->dieContinueUsageIf( count( $cont ) != 2 );
59		$cont_page = (int)$cont[0];
60		$pages = array_filter( $pages, function ( $v ) use ( $cont_page ) {
61		return $v >= $cont_page;
62		} );
63		}
64		if ( !count( $pages ) ) {
65		// Nothing to do
66		return;
67		}
68
69		// Apply MAX_PAGES, leaving any over the limit for a continue.
70		sort( $pages );
71		$continuePages = null;
72		if ( count( $pages ) > self::MAX_PAGES ) {
73		$continuePages = $pages[self::MAX_PAGES] . '\|0';
74		$pages = array_slice( $pages, 0, self::MAX_PAGES );
75		}
76
77		$result = $this->getResult();
78
79		// First, count anons
80		$this->addTables( 'revision' );
81		$this->addFields( [
82		'page' => 'rev_page',
83		'anons' => 'COUNT(DISTINCT rev_user_text)',
84		] );
85		$this->addWhereFld( 'rev_page', $pages );
86		$this->addWhere( 'rev_user = 0' );
87		$this->addWhere( $db->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' );
88		$this->addOption( 'GROUP BY', 'rev_page' );
89		$res = $this->select( __METHOD__ );
90		foreach ( $res as $row ) {
91		$fit = $result->addValue( [ 'query', 'pages', $row->page ],
92		'anoncontributors', (int)$row->anons
93		);
94		if ( !$fit ) {
95		// This not fitting isn't reasonable, so it probably means that
96		// some other module used up all the space. Just set a dummy
97		// continue and hope it works next time.
98		$this->setContinueEnumParameter( 'continue',
99		$params['continue'] !== null ? $params['continue'] : '0\|0'
100		);
101
102		return;
103		}
104		}
105
106		// Next, add logged-in users
107		$this->resetQueryParams();
108		$this->addTables( 'revision' );
109		$this->addFields( [
110		'page' => 'rev_page',
111		'user' => 'rev_user',
112		'username' => 'MAX(rev_user_text)', // Non-MySQL databases don't like partial group-by
113		] );
114		$this->addWhereFld( 'rev_page', $pages );
115		$this->addWhere( 'rev_user != 0' );
116		$this->addWhere( $db->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' );
117		$this->addOption( 'GROUP BY', 'rev_page, rev_user' );
118		$this->addOption( 'LIMIT', $params['limit'] + 1 );
119
120		// Force a sort order to ensure that properties are grouped by page
121		// But only if pp_page is not constant in the WHERE clause.
122		if ( count( $pages ) > 1 ) {
123		$this->addOption( 'ORDER BY', 'rev_page, rev_user' );
124		} else {
125		$this->addOption( 'ORDER BY', 'rev_user' );
126		}
127
128		$limitGroups = [];
129		if ( $params['group'] ) {
130		$excludeGroups = false;
131		$limitGroups = $params['group'];
132		} elseif ( $params['excludegroup'] ) {
133		$excludeGroups = true;
134		$limitGroups = $params['excludegroup'];
135		} elseif ( $params['rights'] ) {
136		$excludeGroups = false;
137		foreach ( $params['rights'] as $r ) {
138		$limitGroups = array_merge( $limitGroups, User::getGroupsWithPermission( $r ) );
139		}
140
141		// If no group has the rights requested, no need to query
142		if ( !$limitGroups ) {
143		if ( $continuePages !== null ) {
144		// But we still need to continue for the next page's worth
145		// of anoncontributors
146		$this->setContinueEnumParameter( 'continue', $continuePages );
147		}
148
149		return;
150		}
151		} elseif ( $params['excluderights'] ) {
152		$excludeGroups = true;
153		foreach ( $params['excluderights'] as $r ) {
154		$limitGroups = array_merge( $limitGroups, User::getGroupsWithPermission( $r ) );
155		}
156		}
157
158		if ( $limitGroups ) {
159		$limitGroups = array_unique( $limitGroups );
160		$this->addTables( 'user_groups' );
161		$this->addJoinConds( [ 'user_groups' => [
162		$excludeGroups ? 'LEFT OUTER JOIN' : 'INNER JOIN',
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The variable `$excludeGroups` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
163		[ 'ug_user=rev_user', 'ug_group' => $limitGroups ]
164		] ] );
165		$this->addWhereIf( 'ug_user IS NULL', $excludeGroups );
166		}
167
168		if ( $params['continue'] !== null ) {
169		$cont = explode( '\|', $params['continue'] );
170		$this->dieContinueUsageIf( count( $cont ) != 2 );
171		$cont_page = (int)$cont[0];
172		$cont_user = (int)$cont[1];
173		$this->addWhere(
174		"rev_page > $cont_page OR " .
175		"(rev_page = $cont_page AND " .
176		"rev_user >= $cont_user)"
177		);
178		}
179
180		$res = $this->select( __METHOD__ );
181		$count = 0;
182		foreach ( $res as $row ) {
183	View Code Duplication	if ( ++$count > $params['limit'] ) {
184		// We've reached the one extra which shows that
185		// there are additional pages to be had. Stop here...
186		$this->setContinueEnumParameter( 'continue', $row->page . '\|' . $row->user );
187
188		return;
189		}
190
191		$fit = $this->addPageSubItem( $row->page,
192		[ 'userid' => (int)$row->user, 'name' => $row->username ],
193		'user'
194		);
195		if ( !$fit ) {
196		$this->setContinueEnumParameter( 'continue', $row->page . '\|' . $row->user );
197
198		return;
199		}
200		}
201
202		if ( $continuePages !== null ) {
203		$this->setContinueEnumParameter( 'continue', $continuePages );
204		}
205		}
206
207		public function getCacheMode( $params ) {
208		return 'public';
209		}
210
211		public function getAllowedParams() {
212		$userGroups = User::getAllGroups();
213		$userRights = User::getAllRights();
214
215		return [
216		'group' => [
217		ApiBase::PARAM_TYPE => $userGroups,
218		ApiBase::PARAM_ISMULTI => true,
219		],
220		'excludegroup' => [
221		ApiBase::PARAM_TYPE => $userGroups,
222		ApiBase::PARAM_ISMULTI => true,
223		],
224		'rights' => [
225		ApiBase::PARAM_TYPE => $userRights,
226		ApiBase::PARAM_ISMULTI => true,
227		],
228		'excluderights' => [
229		ApiBase::PARAM_TYPE => $userRights,
230		ApiBase::PARAM_ISMULTI => true,
231		],
232		'limit' => [
233		ApiBase::PARAM_DFLT => 10,
234		ApiBase::PARAM_TYPE => 'limit',
235		ApiBase::PARAM_MIN => 1,
236		ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
237		ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
238		],
239		'continue' => [
240		ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
241		],
242		];
243		}
244
245		protected function getExamplesMessages() {
246		return [
247		'action=query&prop=contributors&titles=Main_Page'
248		=> 'apihelp-query+contributors-example-simple',
249		];
250		}
251
252		public function getHelpUrls() {
253		return 'https://www.mediawiki.org/wiki/API:Contributors';
254		}
255		}
256

wikimedia / mediawiki

ApiQueryContributors::__construct() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

ApiQueryContributors::__construct() A
last analyzed 2016-11-13 17:42 UTC