wikimedia/mediawiki-extensions-Cite
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Cite synced 2024-11-23 14:36:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add phan configuration for static analysis

Browse source 
Bug: T179554
Change-Id: I2bfd52c08aac1aa8f34e0664e6314835f79a0324
This commit is contained in:
Phantom42 2017-12-25 15:17:20 +02:00 committed by Kunal Mehta
parent 9e2c5abfa9
commit 67ed343ecc
5 changed files with 326 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -1,5 +1,6 @@
/node_modules/
/vendor/
/tests/phan/issues
/composer.lock
# Editors

16
includes/ApiQueryReferences.php
View file

@ -21,6 +21,8 @@
* @see https://www.mediawiki.org/wiki/Extension:Cite#API
*/
use MediaWiki\MediaWikiServices;
class ApiQueryReferences extends ApiQueryBase {
public function __construct( $query, $moduleName ) {
@ -36,13 +38,9 @@ class ApiQueryReferences extends ApiQueryBase {
}
public function execute() {
$config = ConfigFactory::getDefaultInstance()->makeConfig( 'cite' );
$config = MediaWikiServices::getInstance()->getConfigFactory()->makeConfig( 'cite' );
if ( !$config->get( 'CiteStoreReferencesData' ) ) {
if ( is_callable( [ $this, 'dieWithError' ] ) ) {
$this->dieWithError( 'apierror-citestoragedisabled' );
} else {
$this->dieUsage( 'Cite extension reference storage is not enabled', 'citestoragedisabled' );
}
$this->dieWithError( 'apierror-citestoragedisabled' );
}
$params = $this->extractRequestParams();
$titles = $this->getPageSet()->getGoodTitles();
@ -95,6 +93,12 @@ class ApiQueryReferences extends ApiQueryBase {
}
}
/**
* Get the cache mode for the data generated by this module.
*
* @param array $params
* @return string
*/
public function getCacheMode( $params ) {
return 'public';
}

11
includes/Cite.php
View file

@ -22,6 +22,7 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
*/
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\IDatabase;
/**
@ -454,7 +455,7 @@ class Cite {
* @throws Exception
* @return string
*/
private function stack( $str, $key = null, $group, $follow, array $call ) {
private function stack( $str, $key, $group, $follow, array $call ) {
if ( !isset( $this->mRefs[$group] ) ) {
$this->mRefs[$group] = [];
}
@ -758,9 +759,9 @@ class Cite {
// Let's try to cache it.
global $wgCiteCacheReferences, $wgMemc;
$data = false;
$data = [];
if ( $wgCiteCacheReferences ) {
$cacheKey = wfMemcKey(
$cacheKey = $wgMemc->makeKey(
'citeref',
md5( $parserInput ),
$this->mParser->Title()->getArticleID()
@ -1335,7 +1336,7 @@ class Cite {
* Return an error message based on an error ID
*
* @param string $key Message name for the error
* @param string|null $param Parameter to pass to the message
* @param string[]|string|null $param Parameter to pass to the message
* @param string $parse Whether to parse the message ('parse') or not ('noparse')
* @return string XHTML or wikitext ready for output
*/
@ -1429,7 +1430,7 @@ class Cite {
if ( !$wgCiteStoreReferencesData ) {
return false;
}
$cache = ObjectCache::getMainWANInstance();
$cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
$key = $cache->makeKey( self::EXT_DATA_KEY, $title->getArticleID() );
return $cache->getWithSetCallback(
$key,

10
includes/CiteHooks.php
View file

@ -8,6 +8,8 @@
* @license The MIT License (MIT); see MIT-LICENSE.txt
*/
use MediaWiki\MediaWikiServices;
class CiteHooks {
/**
* Convert the content model of a message that is actually JSON to JSON. This
@ -212,7 +214,7 @@ class CiteHooks {
}
if ( $wgCiteCacheRawReferencesOnParse ) {
// caching
$cache = ObjectCache::getMainWANInstance();
$cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
$articleID = $linksUpdate->getTitle()->getArticleID();
$key = $cache->makeKey( Cite::EXT_DATA_KEY, $articleID );
$cache->set( $key, $refData, Cite::CACHE_DURATION_ONPARSE );
@ -254,7 +256,7 @@ class CiteHooks {
return;
}
}
$cache = ObjectCache::getMainWANInstance();
$cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
$articleID = $linksUpdate->getTitle()->getArticleID();
$key = $cache->makeKey( Cite::EXT_DATA_KEY, $articleID );
// delete with reduced hold off period (LinksUpdate uses a master connection)
@ -267,7 +269,7 @@ class CiteHooks {
* @return true
*/
public static function onResourceLoaderGetConfigVars( array &$vars ) {
$config = ConfigFactory::getDefaultInstance()->makeConfig( 'cite' );
$config = MediaWikiServices::getInstance()->getConfigFactory()->makeConfig( 'cite' );
$vars['wgCiteVisualEditorOtherGroup'] = $config->get( 'CiteVisualEditorOtherGroup' );
$vars['wgCiteResponsiveReferences'] = $config->get( 'CiteResponsiveReferences' );
return true;
@ -282,7 +284,7 @@ class CiteHooks {
* @param array &$data
*/
public static function onAPIQuerySiteInfoGeneralInfo( ApiQuerySiteInfo $api, array &$data ) {
$config = ConfigFactory::getDefaultInstance()->makeConfig( 'cite' );
$config = MediaWikiServices::getInstance()->getConfigFactory()->makeConfig( 'cite' );
$data['citeresponsivereferences'] = $config->get( 'CiteResponsiveReferences' );
}
}

303
tests/phan/config.php Normal file
View file

@ -0,0 +1,303 @@
<?php
// If xdebug is enabled, we need to increase the nesting level for phan
ini_set( 'xdebug.max_nesting_level', 1000 );
/**
* This configuration will be read and overlayed on top of the
* default configuration. Command line arguments will be applied
* after this file is read.
*
* @see src/Phan/Config.php
* See Config for all configurable options.
*
* A Note About Paths
* ==================
*
* Files referenced from this file should be defined as
*
* ```
* Config::projectPath('relative_path/to/file')
* ```
*
* where the relative path is relative to the root of the
* project which is defined as either the working directory
* of the phan executable or a path passed in via the CLI
* '-d' flag.
*/
return [
/**
* A list of individual files to include in analysis
* with a path relative to the root directory of the
* project. directory_list won't find .inc files so
* we augment it here.
*/
'file_list' => [
],
/**
* A list of directories that should be parsed for class and
* method information. After excluding the directories
* defined in exclude_analysis_directory_list, the remaining
* files will be statically analyzed for errors.
*
* Thus, both first-party and third-party code being used by
* your application should be included in this list.
*/
'directory_list' => [
'includes/',
'./../../includes',
'./../../languages',
'./../../maintenance',
'./../../vendor',
],
/**
* A file list that defines files that will be excluded
* from parsing and analysis and will not be read at all.
*
* This is useful for excluding hopelessly unanalyzable
* files that can't be removed for whatever reason.
*/
'exclude_file_list' => [
],
/**
* A list of directories holding code that we want
* to parse, but not analyze. Also works for individual
* files.
*/
"exclude_analysis_directory_list" => [
'./../../includes',
'./../../languages',
'./../../maintenance',
'./../../vendor',
],
/**
* Backwards Compatibility Checking. This is slow
* and expensive, but you should consider running
* it before upgrading your version of PHP to a
* new version that has backward compatibility
* breaks.
*/
'backward_compatibility_checks' => false,
/**
* A set of fully qualified class-names for which
* a call to parent::__construct() is required
*/
'parent_constructor_required' => [
],
/**
* Run a quick version of checks that takes less
* time at the cost of not running as thorough
* an analysis. You should consider setting this
* to true only when you wish you had more issues
* to fix in your code base.
*
* In quick-mode the scanner doesn't rescan a function
* or a method's code block every time a call is seen.
* This means that the problem here won't be detected:
*
* ```php
* <?php
* function test($arg):int {
* return $arg;
* }
* test("abc");
* ```
*
* This would normally generate:
*
* ```sh
* test.php:3 TypeError return string but `test()` is declared to return int
* ```
*
* The initial scan of the function's code block has no
* type information for `$arg`. It isn't until we see
* the call and rescan test()'s code block that we can
* detect that it is actually returning the passed in
* `string` instead of an `int` as declared.
*/
'quick_mode' => false,
/**
* By default, Phan will not analyze all node types
* in order to save time. If this config is set to true,
* Phan will dig deeper into the AST tree and do an
* analysis on all nodes, possibly finding more issues.
*
* See \Phan\Analysis::shouldVisit for the set of skipped
* nodes.
*/
'should_visit_all_nodes' => true,
/**
* If enabled, check all methods that override a
* parent method to make sure its signature is
* compatible with the parent's. This check
* can add quite a bit of time to the analysis.
*/
'analyze_signature_compatibility' => true,
// Emit all issues. They are then suppressed via
// suppress_issue_types, rather than a minimum
// severity.
"minimum_severity" => 0,
/**
* If true, missing properties will be created when
* they are first seen. If false, we'll report an
* error message if there is an attempt to write
* to a class property that wasn't explicitly
* defined.
*/
'allow_missing_properties' => false,
/**
* Allow null to be cast as any type and for any
* type to be cast to null. Setting this to false
* will cut down on false positives.
*/
'null_casts_as_any_type' => true,
/**
* If enabled, scalars (int, float, bool, string, null)
* are treated as if they can cast to each other.
*
* MediaWiki is pretty lax and uses many scalar
* types interchangably.
*/
'scalar_implicit_cast' => true,
/**
* If true, seemingly undeclared variables in the global
* scope will be ignored. This is useful for projects
* with complicated cross-file globals that you have no
* hope of fixing.
*/
'ignore_undeclared_variables_in_global_scope' => false,
/**
* Set to true in order to attempt to detect dead
* (unreferenced) code. Keep in mind that the
* results will only be a guess given that classes,
* properties, constants and methods can be referenced
* as variables (like `$class->$property` or
* `$class->$method()`) in ways that we're unable
* to make sense of.
*/
'dead_code_detection' => false,
/**
* If true, the dead code detection rig will
* prefer false negatives (not report dead code) to
* false positives (report dead code that is not
* actually dead) which is to say that the graph of
* references will create too many edges rather than
* too few edges when guesses have to be made about
* what references what.
*/
'dead_code_detection_prefer_false_negative' => true,
/**
* If disabled, Phan will not read docblock type
* annotation comments (such as for @return, @param,
* @var, @suppress, @deprecated) and only rely on
* types expressed in code.
*/
'read_type_annotations' => true,
/**
* If a file path is given, the code base will be
* read from and written to the given location in
* order to attempt to save some work from being
* done. Only changed files will get analyzed if
* the file is read
*/
'stored_state_file_path' => null,
/**
* Set to true in order to ignore issue suppression.
* This is useful for testing the state of your code, but
* unlikely to be useful outside of that.
*/
'disable_suppression' => false,
/**
* If set to true, we'll dump the AST instead of
* analyzing files
*/
'dump_ast' => false,
/**
* If set to a string, we'll dump the fully qualified lowercase
* function and method signatures instead of analyzing files.
*/
'dump_signatures_file' => null,
/**
* If true (and if stored_state_file_path is set) we'll
* look at the list of files passed in and expand the list
* to include files that depend on the given files
*/
'expand_file_list' => false,
// Include a progress bar in the output
'progress_bar' => false,
/**
* The probability of actually emitting any progress
* bar update. Setting this to something very low
* is good for reducing network IO and filling up
* your terminal's buffer when running phan on a
* remote host.
*/
'progress_bar_sample_rate' => 0.005,
/**
* The number of processes to fork off during the analysis
* phase.
*/
'processes' => 1,
/**
* Add any issue types (such as 'PhanUndeclaredMethod')
* to this black-list to inhibit them from being reported.
*/
'suppress_issue_types' => [
'PhanUndeclaredClassMethod',
'PhanUndeclaredProperty'
],
/**
* If empty, no filter against issues types will be applied.
* If this white-list is non-empty, only issues within the list
* will be emitted by Phan.
*/
'whitelist_issue_types' => [
],
/**
* Override to hardcode existence and types of (non-builtin) globals in the global scope.
* Class names must be prefixed with '\\'.
* (E.g. ['_FOO' => '\\FooClass', 'page' => '\\PageClass', 'userId' => 'int'])
*/
'globals_type_map' => [
],
// Emit issue messages with markdown formatting
'markdown_issue_messages' => false,
/**
* Enable or disable support for generic templated
* class types.
*/
'generic_types_enabled' => true,
// A list of plugin files to execute
'plugins' => [
],
];