ApiImageRotate::getPageSet() - Code Metrics - Inspection of "Daily Inspection: Merge "Only set memcache hash wh..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (296c00)

unknown

created 2016-10-15 17:10 UTC

ApiImageRotate::getPageSet() A

↳ Parent: ApiImageRotate

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	0
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0

<?php
/**
 *
 * Created on January 3rd, 2013
 *
 * 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
 */

class ApiImageRotate extends ApiBase {
	private $mPageSet = null;

	public function execute() {
		$this->useTransactionalTimeLimit();

		$params = $this->extractRequestParams();
		$rotation = $params['rotation'];

		$continuationManager = new ApiContinuationManager( $this, [], [] );
		$this->setContinuationManager( $continuationManager );

		$pageSet = $this->getPageSet();
		$pageSet->execute();

		$result = [];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		$result = $pageSet->getInvalidTitlesAndRevisions( [
			'invalidTitles', 'special', 'missingIds', 'missingRevIds', 'interwikiTitles',
		] );

		foreach ( $pageSet->getTitles() as $title ) {
			$r = [];
			$r['id'] = $title->getArticleID();
			ApiQueryBase::addTitleInfo( $r, $title );
			if ( !$title->exists() ) {
				$r['missing'] = true;
				if ( $title->isKnown() ) {
					$r['known'] = true;
				}
			}

			$file = wfFindFile( $title, [ 'latest' => true ] );
			if ( !$file ) {
				$r['result'] = 'Failure';
				$r['errormessage'] = 'File does not exist';
				$result[] = $r;
				continue;
			}
			$handler = $file->getHandler();
			if ( !$handler || !$handler->canRotate() ) {
				$r['result'] = 'Failure';
				$r['errormessage'] = 'File type cannot be rotated';
				$result[] = $r;
				continue;
			}

			// Check whether we're allowed to rotate this file
			$permError = $this->checkPermissions( $this->getUser(), $file->getTitle() );
			if ( $permError !== null ) {
				$r['result'] = 'Failure';
				$r['errormessage'] = $permError;
				$result[] = $r;
				continue;
			}

			$srcPath = $file->getLocalRefPath();
			if ( $srcPath === false ) {
				$r['result'] = 'Failure';
				$r['errormessage'] = 'Cannot get local file path';
				$result[] = $r;
				continue;
			}
			$ext = strtolower( pathinfo( "$srcPath", PATHINFO_EXTENSION ) );
			$tmpFile = TempFSFile::factory( 'rotate_', $ext, wfTempDir() );
			$dstPath = $tmpFile->getPath();
			$err = $handler->rotate( $file, [
				'srcPath' => $srcPath,
				'dstPath' => $dstPath,
				'rotation' => $rotation
			] );
			if ( !$err ) {
				$comment = wfMessage(
					'rotate-comment'
				)->numParams( $rotation )->inContentLanguage()->text();
				$status = $file->upload( $dstPath,

					$comment, $comment, 0, false, false, $this->getUser() );
				if ( $status->isGood() ) {
					$r['result'] = 'Success';
				} else {
					$r['result'] = 'Failure';
					$r['errormessage'] = $this->getErrorFormatter()->arrayFromStatus( $status );
				}
			} else {
				$r['result'] = 'Failure';
				$r['errormessage'] = $err->toText();
			}
			$result[] = $r;
		}
		$apiResult = $this->getResult();
		ApiResult::setIndexedTagName( $result, 'page' );
		$apiResult->addValue( null, $this->getModuleName(), $result );

		$this->setContinuationManager( null );
		$continuationManager->setContinuationIntoResult( $apiResult );
	}

	/**
	 * Get a cached instance of an ApiPageSet object
	 * @return ApiPageSet
	 */
	private function getPageSet() {
		if ( $this->mPageSet === null ) {
			$this->mPageSet = new ApiPageSet( $this, 0, NS_FILE );
		}

		return $this->mPageSet;
	}

	/**
	 * Checks that the user has permissions to perform rotations.
	 * @param User $user The user to check
	 * @param Title $title
	 * @return string|null Permission error message, or null if there is no error
	 */
	protected function checkPermissions( $user, $title ) {
		$permissionErrors = array_merge(
			$title->getUserPermissionsErrors( 'edit', $user ),
			$title->getUserPermissionsErrors( 'upload', $user )
		);

		if ( $permissionErrors ) {
			// Just return the first error
			$msg = $this->parseMsg( $permissionErrors[0] );

			return $msg['info'];
		}

		return null;
	}

	public function mustBePosted() {
		return true;
	}

	public function isWriteMode() {
		return true;
	}

	public function getAllowedParams( $flags = 0 ) {
		$result = [
			'rotation' => [
				ApiBase::PARAM_TYPE => [ '90', '180', '270' ],
				ApiBase::PARAM_REQUIRED => true
			],
			'continue' => [
				ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
			],
		];
		if ( $flags ) {
			$result += $this->getPageSet()->getFinalParams( $flags );
		}

		return $result;
	}

	public function needsToken() {
		return 'csrf';
	}

	protected function getExamplesMessages() {
		return [
			'action=imagerotate&titles=File:Example.jpg&rotation=90&token=123ABC'
				=> 'apihelp-imagerotate-example-simple',
			'action=imagerotate&generator=categorymembers&gcmtitle=Category:Flip&gcmtype=file&' .
				'rotation=180&token=123ABC'
				=> 'apihelp-imagerotate-example-generator',
		];
	}
}


1		<?php
2		/**
3		*
4		* Created on January 3rd, 2013
5		*
6		* This program is free software; you can redistribute it and/or modify
7		* it under the terms of the GNU General Public License as published by
8		* the Free Software Foundation; either version 2 of the License, or
9		* (at your option) any later version.
10		*
11		* This program is distributed in the hope that it will be useful,
12		* but WITHOUT ANY WARRANTY; without even the implied warranty of
13		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14		* GNU General Public License for more details.
15		*
16		* You should have received a copy of the GNU General Public License along
17		* with this program; if not, write to the Free Software Foundation, Inc.,
18		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19		* http://www.gnu.org/copyleft/gpl.html
20		*
21		* @file
22		*/
23
24		class ApiImageRotate extends ApiBase {
25		private $mPageSet = null;
26
27		public function execute() {
28		$this->useTransactionalTimeLimit();
29
30		$params = $this->extractRequestParams();
31		$rotation = $params['rotation'];
32
33		$continuationManager = new ApiContinuationManager( $this, [], [] );
34		$this->setContinuationManager( $continuationManager );
35
36		$pageSet = $this->getPageSet();
37		$pageSet->execute();
38
39		$result = [];
		0 ignored issues – show Unused Code introduced 2016-10-12 17:42 UTC by Report Bug Copy Issue Report `$result` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
40
41		$result = $pageSet->getInvalidTitlesAndRevisions( [
42		'invalidTitles', 'special', 'missingIds', 'missingRevIds', 'interwikiTitles',
43		] );
44
45		foreach ( $pageSet->getTitles() as $title ) {
46		$r = [];
47		$r['id'] = $title->getArticleID();
48		ApiQueryBase::addTitleInfo( $r, $title );
49	View Code Duplication	if ( !$title->exists() ) {
50		$r['missing'] = true;
51		if ( $title->isKnown() ) {
52		$r['known'] = true;
53		}
54		}
55
56		$file = wfFindFile( $title, [ 'latest' => true ] );
57	View Code Duplication	if ( !$file ) {
58		$r['result'] = 'Failure';
59		$r['errormessage'] = 'File does not exist';
60		$result[] = $r;
61		continue;
62		}
63		$handler = $file->getHandler();
64	View Code Duplication	if ( !$handler \|\| !$handler->canRotate() ) {
65		$r['result'] = 'Failure';
66		$r['errormessage'] = 'File type cannot be rotated';
67		$result[] = $r;
68		continue;
69		}
70
71		// Check whether we're allowed to rotate this file
72		$permError = $this->checkPermissions( $this->getUser(), $file->getTitle() );
73	View Code Duplication	if ( $permError !== null ) {
74		$r['result'] = 'Failure';
75		$r['errormessage'] = $permError;
76		$result[] = $r;
77		continue;
78		}
79
80		$srcPath = $file->getLocalRefPath();
81	View Code Duplication	if ( $srcPath === false ) {
82		$r['result'] = 'Failure';
83		$r['errormessage'] = 'Cannot get local file path';
84		$result[] = $r;
85		continue;
86		}
87		$ext = strtolower( pathinfo( "$srcPath", PATHINFO_EXTENSION ) );
88		$tmpFile = TempFSFile::factory( 'rotate_', $ext, wfTempDir() );
89		$dstPath = $tmpFile->getPath();
90		$err = $handler->rotate( $file, [
91		'srcPath' => $srcPath,
92		'dstPath' => $dstPath,
93		'rotation' => $rotation
94		] );
95		if ( !$err ) {
96		$comment = wfMessage(
97		'rotate-comment'
98		)->numParams( $rotation )->inContentLanguage()->text();
99		$status = $file->upload( $dstPath,
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The method `upload()` does not exist on `File`. Did you maybe mean `recordUpload()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
100		$comment, $comment, 0, false, false, $this->getUser() );
101		if ( $status->isGood() ) {
102		$r['result'] = 'Success';
103		} else {
104		$r['result'] = 'Failure';
105		$r['errormessage'] = $this->getErrorFormatter()->arrayFromStatus( $status );
106		}
107		} else {
108		$r['result'] = 'Failure';
109		$r['errormessage'] = $err->toText();
110		}
111		$result[] = $r;
112		}
113		$apiResult = $this->getResult();
114		ApiResult::setIndexedTagName( $result, 'page' );
115		$apiResult->addValue( null, $this->getModuleName(), $result );
116
117		$this->setContinuationManager( null );
118		$continuationManager->setContinuationIntoResult( $apiResult );
119		}
120
121		/**
122		* Get a cached instance of an ApiPageSet object
123		* @return ApiPageSet
124		*/
125		private function getPageSet() {
126		if ( $this->mPageSet === null ) {
127		$this->mPageSet = new ApiPageSet( $this, 0, NS_FILE );
128		}
129
130		return $this->mPageSet;
131		}
132
133		/**
134		* Checks that the user has permissions to perform rotations.
135		* @param User $user The user to check
136		* @param Title $title
137		* @return string\|null Permission error message, or null if there is no error
138		*/
139		protected function checkPermissions( $user, $title ) {
140		$permissionErrors = array_merge(
141		$title->getUserPermissionsErrors( 'edit', $user ),
142		$title->getUserPermissionsErrors( 'upload', $user )
143		);
144
145		if ( $permissionErrors ) {
146		// Just return the first error
147		$msg = $this->parseMsg( $permissionErrors[0] );
148
149		return $msg['info'];
150		}
151
152		return null;
153		}
154
155		public function mustBePosted() {
156		return true;
157		}
158
159		public function isWriteMode() {
160		return true;
161		}
162
163	View Code Duplication	public function getAllowedParams( $flags = 0 ) {
164		$result = [
165		'rotation' => [
166		ApiBase::PARAM_TYPE => [ '90', '180', '270' ],
167		ApiBase::PARAM_REQUIRED => true
168		],
169		'continue' => [
170		ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
171		],
172		];
173		if ( $flags ) {
174		$result += $this->getPageSet()->getFinalParams( $flags );
175		}
176
177		return $result;
178		}
179
180		public function needsToken() {
181		return 'csrf';
182		}
183
184		protected function getExamplesMessages() {
185		return [
186		'action=imagerotate&titles=File:Example.jpg&rotation=90&token=123ABC'
187		=> 'apihelp-imagerotate-example-simple',
188		'action=imagerotate&generator=categorymembers&gcmtitle=Category:Flip&gcmtype=file&' .
189		'rotation=180&token=123ABC'
190		=> 'apihelp-imagerotate-example-generator',
191		];
192		}
193		}
194

wikimedia / mediawiki

Branch — master (296c00)

ApiImageRotate::getPageSet() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like