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

ApiQueryLangBacklinks::executeGenerator() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: ApiQueryLangBacklinks

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	3
Ratio	100 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	3
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * API for MediaWiki 1.17+
 *
 * Created on May 14, 2011
 *
 * Copyright © 2011 Sam Reed
 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
 *
 * 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
 */

/**
 * This gives links pointing to the given interwiki
 * @ingroup API
 */
class ApiQueryLangBacklinks extends ApiQueryGeneratorBase {


	public function __construct( ApiQuery $query, $moduleName ) {
		parent::__construct( $query, $moduleName, 'lbl' );
	}

	public function execute() {
		$this->run();
	}

	public function executeGenerator( $resultPageSet ) {
		$this->run( $resultPageSet );
	}

	/**
	 * @param ApiPageSet $resultPageSet
	 * @return void
	 */
	public function run( $resultPageSet = null ) {
		$params = $this->extractRequestParams();

		if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) {
			$this->dieUsageMsg( [ 'missingparam', 'lang' ] );
		}

		if ( !is_null( $params['continue'] ) ) {
			$cont = explode( '|', $params['continue'] );
			$this->dieContinueUsageIf( count( $cont ) != 3 );

			$db = $this->getDB();
			$op = $params['dir'] == 'descending' ? '<' : '>';
			$prefix = $db->addQuotes( $cont[0] );
			$title = $db->addQuotes( $cont[1] );
			$from = intval( $cont[2] );
			$this->addWhere(
				"ll_lang $op $prefix OR " .
				"(ll_lang = $prefix AND " .
				"(ll_title $op $title OR " .
				"(ll_title = $title AND " .
				"ll_from $op= $from)))"
			);
		}

		$prop = array_flip( $params['prop'] );
		$lllang = isset( $prop['lllang'] );
		$lltitle = isset( $prop['lltitle'] );

		$this->addTables( [ 'langlinks', 'page' ] );
		$this->addWhere( 'll_from = page_id' );

		$this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
			'll_from', 'll_lang', 'll_title' ] );

		$sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
		if ( isset( $params['lang'] ) ) {
			$this->addWhereFld( 'll_lang', $params['lang'] );
			if ( isset( $params['title'] ) ) {
				$this->addWhereFld( 'll_title', $params['title'] );
				$this->addOption( 'ORDER BY', 'll_from' . $sort );
			} else {
				$this->addOption( 'ORDER BY', [
					'll_title' . $sort,
					'll_from' . $sort
				] );
			}
		} else {
			$this->addOption( 'ORDER BY', [
				'll_lang' . $sort,
				'll_title' . $sort,
				'll_from' . $sort
			] );
		}

		$this->addOption( 'LIMIT', $params['limit'] + 1 );

		$res = $this->select( __METHOD__ );

		$pages = [];

		$count = 0;
		$result = $this->getResult();
		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... Continue string
				// preserved in case the redirect query doesn't pass the limit.
				$this->setContinueEnumParameter(
					'continue',
					"{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}"
				);
				break;
			}

			if ( !is_null( $resultPageSet ) ) {
				$pages[] = Title::newFromRow( $row );
/** @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);
    }
}
			} else {
				$entry = [ 'pageid' => $row->page_id ];

				$title = Title::makeTitle( $row->page_namespace, $row->page_title );
				ApiQueryBase::addTitleInfo( $entry, $title );

				if ( $row->page_is_redirect ) {
					$entry['redirect'] = true;
				}

				if ( $lllang ) {
					$entry['lllang'] = $row->ll_lang;
				}

				if ( $lltitle ) {
					$entry['lltitle'] = $row->ll_title;
				}

				$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
				if ( !$fit ) {
					$this->setContinueEnumParameter(
						'continue',
						"{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}"
					);
					break;
				}
			}
		}

		if ( is_null( $resultPageSet ) ) {
			$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'll' );
		} else {
			$resultPageSet->populateFromTitles( $pages );
		}
	}

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

	public function getAllowedParams() {
		return [
			'lang' => null,
			'title' => null,
			'continue' => [
				ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
			],
			'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
			],
			'prop' => [
				ApiBase::PARAM_ISMULTI => true,
				ApiBase::PARAM_DFLT => '',
				ApiBase::PARAM_TYPE => [
					'lllang',
					'lltitle',
				],
				ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
			],
			'dir' => [
				ApiBase::PARAM_DFLT => 'ascending',
				ApiBase::PARAM_TYPE => [
					'ascending',
					'descending'
				]
			],
		];
	}

	protected function getExamplesMessages() {
		return [
			'action=query&list=langbacklinks&lbltitle=Test&lbllang=fr'
				=> 'apihelp-query+langbacklinks-example-simple',
			'action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info'
				=> 'apihelp-query+langbacklinks-example-generator',
		];
	}

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


1		<?php
2		/**
3		* API for MediaWiki 1.17+
4		*
5		* Created on May 14, 2011
6		*
7		* Copyright © 2011 Sam Reed
8		* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
9		*
10		* This program is free software; you can redistribute it and/or modify
11		* it under the terms of the GNU General Public License as published by
12		* the Free Software Foundation; either version 2 of the License, or
13		* (at your option) any later version.
14		*
15		* This program is distributed in the hope that it will be useful,
16		* but WITHOUT ANY WARRANTY; without even the implied warranty of
17		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18		* GNU General Public License for more details.
19		*
20		* You should have received a copy of the GNU General Public License along
21		* with this program; if not, write to the Free Software Foundation, Inc.,
22		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23		* http://www.gnu.org/copyleft/gpl.html
24		*
25		* @file
26		*/
27
28		/**
29		* This gives links pointing to the given interwiki
30		* @ingroup API
31		*/
32	View Code Duplication	class ApiQueryLangBacklinks extends ApiQueryGeneratorBase {
		0 ignored issues – show Duplication introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
33
34		public function __construct( ApiQuery $query, $moduleName ) {
35		parent::__construct( $query, $moduleName, 'lbl' );
36		}
37
38		public function execute() {
39		$this->run();
40		}
41
42		public function executeGenerator( $resultPageSet ) {
43		$this->run( $resultPageSet );
44		}
45
46		/**
47		* @param ApiPageSet $resultPageSet
48		* @return void
49		*/
50		public function run( $resultPageSet = null ) {
51		$params = $this->extractRequestParams();
52
53		if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) {
54		$this->dieUsageMsg( [ 'missingparam', 'lang' ] );
55		}
56
57		if ( !is_null( $params['continue'] ) ) {
58		$cont = explode( '\|', $params['continue'] );
59		$this->dieContinueUsageIf( count( $cont ) != 3 );
60
61		$db = $this->getDB();
62		$op = $params['dir'] == 'descending' ? '<' : '>';
63		$prefix = $db->addQuotes( $cont[0] );
64		$title = $db->addQuotes( $cont[1] );
65		$from = intval( $cont[2] );
66		$this->addWhere(
67		"ll_lang $op $prefix OR " .
68		"(ll_lang = $prefix AND " .
69		"(ll_title $op $title OR " .
70		"(ll_title = $title AND " .
71		"ll_from $op= $from)))"
72		);
73		}
74
75		$prop = array_flip( $params['prop'] );
76		$lllang = isset( $prop['lllang'] );
77		$lltitle = isset( $prop['lltitle'] );
78
79		$this->addTables( [ 'langlinks', 'page' ] );
80		$this->addWhere( 'll_from = page_id' );
81
82		$this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
83		'll_from', 'll_lang', 'll_title' ] );
84
85		$sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
86		if ( isset( $params['lang'] ) ) {
87		$this->addWhereFld( 'll_lang', $params['lang'] );
88		if ( isset( $params['title'] ) ) {
89		$this->addWhereFld( 'll_title', $params['title'] );
90		$this->addOption( 'ORDER BY', 'll_from' . $sort );
91		} else {
92		$this->addOption( 'ORDER BY', [
93		'll_title' . $sort,
94		'll_from' . $sort
95		] );
96		}
97		} else {
98		$this->addOption( 'ORDER BY', [
99		'll_lang' . $sort,
100		'll_title' . $sort,
101		'll_from' . $sort
102		] );
103		}
104
105		$this->addOption( 'LIMIT', $params['limit'] + 1 );
106
107		$res = $this->select( __METHOD__ );
108
109		$pages = [];
110
111		$count = 0;
112		$result = $this->getResult();
113		foreach ( $res as $row ) {
114		if ( ++$count > $params['limit'] ) {
115		// We've reached the one extra which shows that there are
116		// additional pages to be had. Stop here... Continue string
117		// preserved in case the redirect query doesn't pass the limit.
118		$this->setContinueEnumParameter(
119		'continue',
120		"{$row->ll_lang}\|{$row->ll_title}\|{$row->ll_from}"
121		);
122		break;
123		}
124
125		if ( !is_null( $resultPageSet ) ) {
126		$pages[] = Title::newFromRow( $row );
		0 ignored issues – show Bug introduced 2016-09-19 18:26 UTC by Report Bug Copy Issue Report It seems like `$row` defined by `$row` on line `113` can be `null`; however, `Title::newFromRow()` 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...
127		} else {
128		$entry = [ 'pageid' => $row->page_id ];
129
130		$title = Title::makeTitle( $row->page_namespace, $row->page_title );
131		ApiQueryBase::addTitleInfo( $entry, $title );
132
133		if ( $row->page_is_redirect ) {
134		$entry['redirect'] = true;
135		}
136
137		if ( $lllang ) {
138		$entry['lllang'] = $row->ll_lang;
139		}
140
141		if ( $lltitle ) {
142		$entry['lltitle'] = $row->ll_title;
143		}
144
145		$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
146		if ( !$fit ) {
147		$this->setContinueEnumParameter(
148		'continue',
149		"{$row->ll_lang}\|{$row->ll_title}\|{$row->ll_from}"
150		);
151		break;
152		}
153		}
154		}
155
156		if ( is_null( $resultPageSet ) ) {
157		$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'll' );
158		} else {
159		$resultPageSet->populateFromTitles( $pages );
160		}
161		}
162
163		public function getCacheMode( $params ) {
164		return 'public';
165		}
166
167		public function getAllowedParams() {
168		return [
169		'lang' => null,
170		'title' => null,
171		'continue' => [
172		ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
173		],
174		'limit' => [
175		ApiBase::PARAM_DFLT => 10,
176		ApiBase::PARAM_TYPE => 'limit',
177		ApiBase::PARAM_MIN => 1,
178		ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
179		ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
180		],
181		'prop' => [
182		ApiBase::PARAM_ISMULTI => true,
183		ApiBase::PARAM_DFLT => '',
184		ApiBase::PARAM_TYPE => [
185		'lllang',
186		'lltitle',
187		],
188		ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
189		],
190		'dir' => [
191		ApiBase::PARAM_DFLT => 'ascending',
192		ApiBase::PARAM_TYPE => [
193		'ascending',
194		'descending'
195		]
196		],
197		];
198		}
199
200		protected function getExamplesMessages() {
201		return [
202		'action=query&list=langbacklinks&lbltitle=Test&lbllang=fr'
203		=> 'apihelp-query+langbacklinks-example-simple',
204		'action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info'
205		=> 'apihelp-query+langbacklinks-example-generator',
206		];
207		}
208
209		public function getHelpUrls() {
210		return 'https://www.mediawiki.org/wiki/API:Langbacklinks';
211		}
212		}
213

wikimedia / mediawiki

ApiQueryLangBacklinks::executeGenerator() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ApiQueryLangBacklinks::executeGenerator() A
last analyzed 2016-11-13 17:42 UTC