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

WikiFilePage::isLocal() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: WikiFilePage

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Special handling for file pages.
 *
 * 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
 */

/**
 * Special handling for file pages
 *
 * @ingroup Media
 */
class WikiFilePage extends WikiPage {
	/** @var File */
	protected $mFile = false;
	/** @var LocalRepo */
	protected $mRepo = null;
	/** @var bool */
	protected $mFileLoaded = false;
	/** @var array */
	protected $mDupes = null;

	public function __construct( $title ) {
		parent::__construct( $title );
		$this->mDupes = null;

		$this->mRepo = null;
	}

	/**
	 * @param File $file
	 */
	public function setFile( $file ) {
		$this->mFile = $file;
		$this->mFileLoaded = true;
	}

	/**
	 * @return bool
	 */
	protected function loadFile() {
		if ( $this->mFileLoaded ) {
			return true;
		}
		$this->mFileLoaded = true;

		$this->mFile = wfFindFile( $this->mTitle );
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
		if ( !$this->mFile ) {
			$this->mFile = wfLocalFile( $this->mTitle ); // always a File
		}
		$this->mRepo = $this->mFile->getRepo();
		return true;
	}

	/**
	 * @return mixed|null|Title
	 */
	public function getRedirectTarget() {
		$this->loadFile();
		if ( $this->mFile->isLocal() ) {
			return parent::getRedirectTarget();
		}
		// Foreign image page
		$from = $this->mFile->getRedirected();
		$to = $this->mFile->getName();
		if ( $from == $to ) {
			return null;
		}
		$this->mRedirectTarget = Title::makeTitle( NS_FILE, $to );
		return $this->mRedirectTarget;
	}

	/**
	 * @return bool|mixed|Title
	 */
	public function followRedirect() {
		$this->loadFile();
		if ( $this->mFile->isLocal() ) {
			return parent::followRedirect();
		}
		$from = $this->mFile->getRedirected();
		$to = $this->mFile->getName();
		if ( $from == $to ) {
			return false;
		}
		return Title::makeTitle( NS_FILE, $to );
	}

	/**
	 * @return bool
	 */
	public function isRedirect() {
		$this->loadFile();
		if ( $this->mFile->isLocal() ) {
			return parent::isRedirect();
		}

		return (bool)$this->mFile->getRedirected();
	}

	/**
	 * @return bool
	 */
	public function isLocal() {
		$this->loadFile();
		return $this->mFile->isLocal();
	}

	/**
	 * @return bool|File
	 */
	public function getFile() {
		$this->loadFile();
		return $this->mFile;
	}

	/**
	 * @return array|null
	 */
	public function getDuplicates() {
		$this->loadFile();
		if ( !is_null( $this->mDupes ) ) {
			return $this->mDupes;
		}
		$hash = $this->mFile->getSha1();
		if ( !( $hash ) ) {
			$this->mDupes = [];
			return $this->mDupes;
		}
		$dupes = RepoGroup::singleton()->findBySha1( $hash );
		// Remove duplicates with self and non matching file sizes
		$self = $this->mFile->getRepoName() . ':' . $this->mFile->getName();
		$size = $this->mFile->getSize();

		/**
		 * @var $file File
		 */
		foreach ( $dupes as $index => $file ) {
			$key = $file->getRepoName() . ':' . $file->getName();
			if ( $key == $self ) {
				unset( $dupes[$index] );
			}
			if ( $file->getSize() != $size ) {
				unset( $dupes[$index] );
			}
		}
		$this->mDupes = $dupes;
		return $this->mDupes;
	}

	public function doPurge( $flags = self::PURGE_ALL ) {
		$this->loadFile();

		if ( $this->mFile->exists() ) {
			wfDebug( 'ImagePage::doPurge purging ' . $this->mFile->getName() . "\n" );
			DeferredUpdates::addUpdate( new HTMLCacheUpdate( $this->mTitle, 'imagelinks' ) );
			$this->mFile->purgeCache( [ 'forThumbRefresh' => true ] );
		} else {
			wfDebug( 'ImagePage::doPurge no image for '
				. $this->mFile->getName() . "; limiting purge to cache only\n" );
			// even if the file supposedly doesn't exist, force any cached information
			// to be updated (in case the cached information is wrong)
			$this->mFile->purgeCache( [ 'forThumbRefresh' => true ] );
		}
		if ( $this->mRepo ) {
			// Purge redirect cache
			$this->mRepo->invalidateImageRedirect( $this->mTitle );
		}

		return parent::doPurge( $flags );
	}

	/**
	 * Get the categories this file is a member of on the wiki where it was uploaded.
	 * For local files, this is the same as getCategories().
	 * For foreign API files (InstantCommons), this is not supported currently.
	 * Results will include hidden categories.
	 *
	 * @return TitleArray|Title[]
	 * @since 1.23
	 */
	public function getForeignCategories() {
		$this->loadFile();
		$title = $this->mTitle;
		$file = $this->mFile;

		if ( !$file instanceof LocalFile ) {
			wfDebug( __CLASS__ . '::' . __METHOD__ . " is not supported for this file\n" );
			return TitleArray::newFromResult( new FakeResultWrapper( [] ) );
		}

		/** @var LocalRepo $repo */
		$repo = $file->getRepo();
		$dbr = $repo->getSlaveDB();

		$res = $dbr->select(
			[ 'page', 'categorylinks' ],
			[
				'page_title' => 'cl_to',
				'page_namespace' => NS_CATEGORY,
			],
			[
				'page_namespace' => $title->getNamespace(),
				'page_title' => $title->getDBkey(),
			],
			__METHOD__,
			[],
			[ 'categorylinks' => [ 'INNER JOIN', 'page_id = cl_from' ] ]
		);

		return TitleArray::newFromResult( $res );
	}
}


1		<?php
2		/**
3		* Special handling for file pages.
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		*/
22
23		/**
24		* Special handling for file pages
25		*
26		* @ingroup Media
27		*/
28		class WikiFilePage extends WikiPage {
29		/** @var File */
30		protected $mFile = false;
31		/** @var LocalRepo */
32		protected $mRepo = null;
33		/** @var bool */
34		protected $mFileLoaded = false;
35		/** @var array */
36		protected $mDupes = null;
37
38		public function __construct( $title ) {
39		parent::__construct( $title );
40		$this->mDupes = null;
		0 ignored issues – show Documentation Bug introduced 2016-05-07 17:51 UTC by Report Bug Copy Issue Report It seems like `null` of type `null` is incompatible with the declared type `array` of property `$mDupes`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
41		$this->mRepo = null;
42		}
43
44		/**
45		* @param File $file
46		*/
47		public function setFile( $file ) {
48		$this->mFile = $file;
49		$this->mFileLoaded = true;
50		}
51
52		/**
53		* @return bool
54		*/
55		protected function loadFile() {
56		if ( $this->mFileLoaded ) {
57		return true;
58		}
59		$this->mFileLoaded = true;
60
61		$this->mFile = wfFindFile( $this->mTitle );
		0 ignored issues – show Documentation Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `wfFindFile($this->mTitle)` can also be of type `boolean`. However, the property `$mFile` is declared as type `object<File>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
62		if ( !$this->mFile ) {
63		$this->mFile = wfLocalFile( $this->mTitle ); // always a File
64		}
65		$this->mRepo = $this->mFile->getRepo();
66		return true;
67		}
68
69		/**
70		* @return mixed\|null\|Title
71		*/
72	View Code Duplication	public function getRedirectTarget() {
73		$this->loadFile();
74		if ( $this->mFile->isLocal() ) {
75		return parent::getRedirectTarget();
76		}
77		// Foreign image page
78		$from = $this->mFile->getRedirected();
79		$to = $this->mFile->getName();
80		if ( $from == $to ) {
81		return null;
82		}
83		$this->mRedirectTarget = Title::makeTitle( NS_FILE, $to );
84		return $this->mRedirectTarget;
85		}
86
87		/**
88		* @return bool\|mixed\|Title
89		*/
90	View Code Duplication	public function followRedirect() {
91		$this->loadFile();
92		if ( $this->mFile->isLocal() ) {
93		return parent::followRedirect();
94		}
95		$from = $this->mFile->getRedirected();
96		$to = $this->mFile->getName();
97		if ( $from == $to ) {
98		return false;
99		}
100		return Title::makeTitle( NS_FILE, $to );
101		}
102
103		/**
104		* @return bool
105		*/
106		public function isRedirect() {
107		$this->loadFile();
108		if ( $this->mFile->isLocal() ) {
109		return parent::isRedirect();
110		}
111
112		return (bool)$this->mFile->getRedirected();
113		}
114
115		/**
116		* @return bool
117		*/
118		public function isLocal() {
119		$this->loadFile();
120		return $this->mFile->isLocal();
121		}
122
123		/**
124		* @return bool\|File
125		*/
126		public function getFile() {
127		$this->loadFile();
128		return $this->mFile;
129		}
130
131		/**
132		* @return array\|null
133		*/
134		public function getDuplicates() {
135		$this->loadFile();
136		if ( !is_null( $this->mDupes ) ) {
137		return $this->mDupes;
138		}
139		$hash = $this->mFile->getSha1();
140		if ( !( $hash ) ) {
141		$this->mDupes = [];
142		return $this->mDupes;
143		}
144		$dupes = RepoGroup::singleton()->findBySha1( $hash );
145		// Remove duplicates with self and non matching file sizes
146		$self = $this->mFile->getRepoName() . ':' . $this->mFile->getName();
147		$size = $this->mFile->getSize();
148
149		/**
150		* @var $file File
151		*/
152		foreach ( $dupes as $index => $file ) {
153		$key = $file->getRepoName() . ':' . $file->getName();
154		if ( $key == $self ) {
155		unset( $dupes[$index] );
156		}
157		if ( $file->getSize() != $size ) {
158		unset( $dupes[$index] );
159		}
160		}
161		$this->mDupes = $dupes;
162		return $this->mDupes;
163		}
164
165		public function doPurge( $flags = self::PURGE_ALL ) {
166		$this->loadFile();
167
168		if ( $this->mFile->exists() ) {
169		wfDebug( 'ImagePage::doPurge purging ' . $this->mFile->getName() . "\n" );
170		DeferredUpdates::addUpdate( new HTMLCacheUpdate( $this->mTitle, 'imagelinks' ) );
171		$this->mFile->purgeCache( [ 'forThumbRefresh' => true ] );
172		} else {
173		wfDebug( 'ImagePage::doPurge no image for '
174		. $this->mFile->getName() . "; limiting purge to cache only\n" );
175		// even if the file supposedly doesn't exist, force any cached information
176		// to be updated (in case the cached information is wrong)
177		$this->mFile->purgeCache( [ 'forThumbRefresh' => true ] );
178		}
179		if ( $this->mRepo ) {
180		// Purge redirect cache
181		$this->mRepo->invalidateImageRedirect( $this->mTitle );
182		}
183
184		return parent::doPurge( $flags );
185		}
186
187		/**
188		* Get the categories this file is a member of on the wiki where it was uploaded.
189		* For local files, this is the same as getCategories().
190		* For foreign API files (InstantCommons), this is not supported currently.
191		* Results will include hidden categories.
192		*
193		* @return TitleArray\|Title[]
194		* @since 1.23
195		*/
196		public function getForeignCategories() {
197		$this->loadFile();
198		$title = $this->mTitle;
199		$file = $this->mFile;
200
201		if ( !$file instanceof LocalFile ) {
202		wfDebug( __CLASS__ . '::' . __METHOD__ . " is not supported for this file\n" );
203		return TitleArray::newFromResult( new FakeResultWrapper( [] ) );
204		}
205
206		/** @var LocalRepo $repo */
207		$repo = $file->getRepo();
208		$dbr = $repo->getSlaveDB();
209
210		$res = $dbr->select(
211		[ 'page', 'categorylinks' ],
212		[
213		'page_title' => 'cl_to',
214		'page_namespace' => NS_CATEGORY,
215		],
216		[
217		'page_namespace' => $title->getNamespace(),
218		'page_title' => $title->getDBkey(),
219		],
220		__METHOD__,
221		[],
222		[ 'categorylinks' => [ 'INNER JOIN', 'page_id = cl_from' ] ]
223		);
224
225		return TitleArray::newFromResult( $res );
226		}
227		}
228

wikimedia / mediawiki

WikiFilePage::isLocal() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WikiFilePage::isLocal() A
last analyzed 2016-11-13 17:42 UTC