jenkins-bot has submitted this change and it was merged. Change subject: config-clean-up ......................................................................
config-clean-up aaron schulz requested that we move non configurable variables out of Config.php and just hard code it as used; some variables i have moved into a new Constants.php class in order to encapsulate them within the GWToolset namespace. Change-Id: I2dc355ee6e39d6f173c3dfe5dcd41c5f340749fa --- M GWToolset.php M includes/Config.php A includes/Constants.php M includes/Forms/MetadataDetectForm.php M includes/GWTException.php M includes/Handlers/Forms/MetadataMappingHandler.php M includes/Handlers/UploadHandler.php M includes/Helpers/GWTFileBackend.php M includes/Helpers/WikiChecks.php M includes/Specials/SpecialGWToolset.php 10 files changed, 153 insertions(+), 261 deletions(-) Approvals: Aaron Schulz: Looks good to me, approved jenkins-bot: Verified diff --git a/GWToolset.php b/GWToolset.php index 23e0541..20a8d6e 100644 --- a/GWToolset.php +++ b/GWToolset.php @@ -6,56 +6,36 @@ * @ingroup Extensions * @license GNU General Public License 3.0 http://www.gnu.org/licenses/gpl.html */ + namespace GWToolset; use GWToolset\Helpers\WikiChecks; -/** - * If a user tries to access this extension directly,alert the user that this is - * not a valid entry point to the wiki. - */ if ( !defined( 'MEDIAWIKI' ) ) { - echo - 'This file is part of a MediaWiki extension; it is not a valid entry point. ' . - 'To install this extension, follow the directions in the INSTALL file.'; - + echo 'This file is part of a MediaWiki extension; it is not a valid entry point. To install this extension, follow the instructions in the INSTALL file.'; exit(); } -/** - * set extension directory reference to this directory - */ +// register extension metadata with MediaWiki +$wgExtensionCredits['media'][] = array( + 'author' => array( 'dan entous' ), + 'descriptionmsg' => 'gwtoolset-desc', + 'name' => 'GWToolset', + 'path' => __FILE__, + 'url' => 'https://www.mediawiki.org/wiki/Extension:GWToolset', + 'version' => '0.0.1-dev' +); + +// set extension directory reference to this directory $wgGWToolsetDir = realpath( __DIR__ ); -/** - * load extension configuration - */ -require_once - $wgGWToolsetDir . DIRECTORY_SEPARATOR . - 'includes' . DIRECTORY_SEPARATOR . - 'Config.php'; - -/** - * load extension functions - */ -require_once - $wgGWToolsetDir . DIRECTORY_SEPARATOR . - 'includes' . DIRECTORY_SEPARATOR . - 'functions' . DIRECTORY_SEPARATOR . - 'functions.php'; - -/** - * define namespaces - * @see http://www.mediawiki.org/wiki/Manual:Using_custom_namespaces - * @see https://www.mediawiki.org/wiki/Extension_default_namespaces#GWToolset - */ +// define namespaces +// @see http://www.mediawiki.org/wiki/Manual:Using_custom_namespaces +// @see https://www.mediawiki.org/wiki/Extension_default_namespaces#GWToolset if ( !defined( 'NS_GWTOOLSET' ) ) { define( 'NS_GWTOOLSET', 490 ); define( 'NS_GWTOOLSET_TALK', NS_GWTOOLSET + 1 ); } else { - echo - 'Namespace conflict. Either another extension or configuration has already ' . - 'defined the namespace NS_GWTOOLSET.'; - + echo 'Namespace conflict. Either another extension or configuration has already defined the namespace NS_GWTOOLSET.'; exit(); } @@ -65,73 +45,102 @@ $wgNamespacesWithSubpages[NS_GWTOOLSET] = true; $wgNamespacesWithSubpages[NS_GWTOOLSET_TALK] = true; -/** - * registering extension metadata with MediaWiki - */ -$wgExtensionCredits[Config::$type][] = array( - 'author' => Config::$author, - 'descriptionmsg' => Config::$descriptionmsg, - 'name' => Config::$name, - 'path' => __FILE__, - 'url' => Config::$url, - 'version' => Config::$version -); - -/** - * add user permissions - */ +// add user permissions $wgGroupPermissions["gwtoolset"]["gwtoolset"] = true; $wgGroupPermissions["gwtoolset"]["upload_by_url"] = true; $wgGroupPermissions['sysop']['gwtoolset'] = true; $wgGroupPermissions['sysop']['gwtoolset-debug'] = true; -/** - * add autoloader classes - */ -foreach ( Config::$autoloader_classes as $class => $file ) { - $wgAutoloadClasses[$class] = - $wgGWToolsetDir . - str_replace( '/', DIRECTORY_SEPARATOR, $file ); -} +// load extension functions +require_once $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'functions' . DIRECTORY_SEPARATOR . 'functions.php'; -/** - * add internationalization message file references - */ -foreach ( Config::$messages as $message => $file ) { - $wgExtensionMessagesFiles[$message] = - $wgGWToolsetDir . - str_replace( '/', DIRECTORY_SEPARATOR, $file ); -} +// add autoloader classes +$wgAutoloadClasses['GWToolset\Config'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Config.php'; +$wgAutoloadClasses['GWToolset\Constants'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Constants.php'; +$wgAutoloadClasses['GWToolset\GWTException'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'GWTException.php'; +$wgAutoloadClasses['GWToolset\Adapters\DataAdapterInterface'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Adapters' . DIRECTORY_SEPARATOR . 'DataAdapterInterface.php'; +$wgAutoloadClasses['GWToolset\Adapters\Php\MappingPhpAdapter'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Adapters' . DIRECTORY_SEPARATOR . 'Php' . DIRECTORY_SEPARATOR . 'MappingPhpAdapter.php'; +$wgAutoloadClasses['GWToolset\Adapters\Php\MediawikiTemplatePhpAdapter'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Adapters' . DIRECTORY_SEPARATOR . 'Php' . DIRECTORY_SEPARATOR . 'MediawikiTemplatePhpAdapter.php'; +$wgAutoloadClasses['GWToolset\Adapters\Php\MetadataPhpAdapter'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Adapters' . DIRECTORY_SEPARATOR . 'Php' . DIRECTORY_SEPARATOR . 'MetadataPhpAdapter.php'; +$wgAutoloadClasses['GWToolset\Forms\MetadataDetectForm'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Forms' . DIRECTORY_SEPARATOR . 'MetadataDetectForm.php'; +$wgAutoloadClasses['GWToolset\Forms\MetadataMappingForm'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Forms' . DIRECTORY_SEPARATOR . 'MetadataMappingForm.php'; +$wgAutoloadClasses['GWToolset\Forms\PreviewForm'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Forms' . DIRECTORY_SEPARATOR . 'PreviewForm.php'; +$wgAutoloadClasses['GWToolset\Handlers\Forms\FormHandler'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Handlers' . DIRECTORY_SEPARATOR . 'Forms' . DIRECTORY_SEPARATOR . 'FormHandler.php'; +$wgAutoloadClasses['GWToolset\Handlers\Forms\MetadataDetectHandler'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Handlers' . DIRECTORY_SEPARATOR . 'Forms' . DIRECTORY_SEPARATOR . 'MetadataDetectHandler.php'; +$wgAutoloadClasses['GWToolset\Handlers\Forms\MetadataMappingHandler'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Handlers' . DIRECTORY_SEPARATOR . 'Forms' . DIRECTORY_SEPARATOR . 'MetadataMappingHandler.php'; +$wgAutoloadClasses['GWToolset\Handlers\SpecialPageHandler'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Handlers' . DIRECTORY_SEPARATOR . 'SpecialPageHandler.php'; +$wgAutoloadClasses['GWToolset\Handlers\UploadHandler'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Handlers' . DIRECTORY_SEPARATOR . 'UploadHandler.php'; +$wgAutoloadClasses['GWToolset\Handlers\Xml\XmlDetectHandler'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Handlers' . DIRECTORY_SEPARATOR . 'Xml' . DIRECTORY_SEPARATOR . 'XmlDetectHandler.php'; +$wgAutoloadClasses['GWToolset\Handlers\Xml\XmlHandler'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Handlers' . DIRECTORY_SEPARATOR . 'Xml' . DIRECTORY_SEPARATOR . 'XmlHandler.php'; +$wgAutoloadClasses['GWToolset\Handlers\Xml\XmlMappingHandler'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Handlers' . DIRECTORY_SEPARATOR . 'Xml' . DIRECTORY_SEPARATOR . 'XmlMappingHandler.php'; +$wgAutoloadClasses['GWToolset\Helpers\FileChecks'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Helpers' . DIRECTORY_SEPARATOR . 'FileChecks.php'; +$wgAutoloadClasses['GWToolset\Helpers\GWTFileBackend'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Helpers' . DIRECTORY_SEPARATOR . 'GWTFileBackend.php'; +$wgAutoloadClasses['GWToolset\Helpers\WikiChecks'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Helpers' . DIRECTORY_SEPARATOR . 'WikiChecks.php'; +$wgAutoloadClasses['GWToolset\Helpers\WikiPages'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Helpers' . DIRECTORY_SEPARATOR . 'WikiPages.php'; +$wgAutoloadClasses['GWToolset\Hooks'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Hooks' . DIRECTORY_SEPARATOR . 'Hooks.php'; +$wgAutoloadClasses['GWToolset\Jobs\GWTFileBackendCleanupJob'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Jobs' . DIRECTORY_SEPARATOR . 'GWTFileBackendCleanupJob.php'; +$wgAutoloadClasses['GWToolset\Jobs\UploadMediafileJob'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Jobs' . DIRECTORY_SEPARATOR . 'UploadMediafileJob.php'; +$wgAutoloadClasses['GWToolset\Jobs\UploadMetadataJob'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Jobs' . DIRECTORY_SEPARATOR . 'UploadMetadataJob.php'; +$wgAutoloadClasses['GWToolset\Models\Mapping'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Models' . DIRECTORY_SEPARATOR . 'Mapping.php'; +$wgAutoloadClasses['GWToolset\Models\MediawikiTemplate'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Models' . DIRECTORY_SEPARATOR . 'MediawikiTemplate.php'; +$wgAutoloadClasses['GWToolset\Models\Metadata'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Models' . DIRECTORY_SEPARATOR . 'Metadata.php'; +$wgAutoloadClasses['GWToolset\Models\ModelInterface'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Models' . DIRECTORY_SEPARATOR . 'ModelInterface.php'; +$wgAutoloadClasses['GWToolset\SpecialGWToolset'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Specials' . DIRECTORY_SEPARATOR . 'SpecialGWToolset.php'; +$wgAutoloadClasses['Php\File'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Php' . DIRECTORY_SEPARATOR . 'File.php'; +$wgAutoloadClasses['Php\FileException'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Php' . DIRECTORY_SEPARATOR . 'FileException.php'; +$wgAutoloadClasses['Php\Filter'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Php' . DIRECTORY_SEPARATOR . 'Filter.php'; +$wgAutoloadClasses['Php\FilterException'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'Php' . DIRECTORY_SEPARATOR . 'FilterException.php'; -/** - * setup special page references - */ -foreach ( Config::$special_pages as $page => $values ) { - $wgSpecialPages[$page] = $values['class_name']; +// add internationalization message file references +$wgExtensionMessagesFiles['GWToolsetAlias'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'GWToolset.alias.php'; +$wgExtensionMessagesFiles['GWToolset'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'GWToolset.i18n.php'; +$wgExtensionMessagesFiles['GWToolsetNamespaces'] = $wgGWToolsetDir . DIRECTORY_SEPARATOR . 'GWToolset.namespaces.php'; - if ( !empty( $values['group'] ) ) { - $wgSpecialPageGroups[$page] = $values['group']; - } -} +// setup special page references +$wgSpecialPages['GWToolset'] = 'GWToolset\SpecialGWToolset'; +$wgSpecialPageGroups['GWToolset'] = 'media'; -/** - * add hooks - * not yet used - */ -foreach ( Config::$hooks as $hook => $method ) { - $wgHooks[$hook][] = $method; -} +// add hooks +$wgHooks['CanonicalNamespaces'][] = 'GWToolset\Hooks::onCanonicalNamespaces'; +$wgHooks['UnitTestsList'][] = 'GWToolset\Hooks::onUnitTestsList'; -/** - * add jobs - */ -foreach ( Config::$jobs as $job => $method ) { - $wgJobClasses[$job] = $method; -} +// add jobs +$wgJobClasses['gwtoolsetGWTFileBackendCleanupJob'] = 'GWToolset\Jobs\GWTFileBackendCleanupJob'; +$wgJobClasses['gwtoolsetUploadMediafileJob'] = 'GWToolset\Jobs\UploadMediafileJob'; +$wgJobClasses['gwtoolsetUploadMetadataJob'] = 'GWToolset\Jobs\UploadMetadataJob'; -/** - * register resources with ResourceLoader - */ -Config::$resources['localBasePath'] = $wgGWToolsetDir; -Config::$resources['remoteExtPath'] = 'GWToolset'; -$wgResourceModules['ext.GWToolset'] = Config::$resources; +// register resources with ResourceLoader +$wgResourceModules['ext.GWToolset'] = array( + 'localBasePath' => $wgGWToolsetDir, + 'remoteExtPath' => 'GWToolset', + 'scripts' => array( + 'resources/js/ext.gwtoolset.js' + ), + 'styles' => array( + 'resources/css/ext.gwtoolset.css' + ), + 'messages' => array( + 'gwtoolset-back-text-link', + 'gwtoolset-cancel', + 'gwtoolset-create-mapping', + 'gwtoolset-developer-issue', + 'gwtoolset-loading', + 'gwtoolset-save', + 'gwtoolset-save-mapping', + 'gwtoolset-save-mapping-name', + 'gwtoolset-save-mapping-failed', + 'gwtoolset-save-mapping-succeeded', + 'gwtoolset-step-2-heading' + ), + 'dependencies' => array( + 'jquery.json', + 'jquery.spinner', + 'jquery.ui.widget', + 'jquery.ui.button', + 'jquery.ui.draggable', + 'jquery.ui.mouse', + 'jquery.ui.position', + 'jquery.ui.resizable', + 'jquery.ui.dialog' + ) +); diff --git a/includes/Config.php b/includes/Config.php index 61efb3f..b40e8eb 100644 --- a/includes/Config.php +++ b/includes/Config.php @@ -9,14 +9,11 @@ namespace GWToolset; +/** + * these values can be overriden in LocalSettings.php with + * GWToolset\Config::$var_name = 'new value' + */ class Config { - - public static $name = 'GWToolset'; - public static $author = array( 'dan entous' ); - public static $url = 'https://www.mediawiki.org/wiki/Extension:GWToolset'; - public static $descriptionmsg = 'gwtoolset-desc'; - public static $type = 'media'; - public static $version = '0.0.1-dev'; /** * @var {array} @@ -49,67 +46,9 @@ ); /** - * @var {array} - */ - public static $autoloader_classes = array( - 'GWToolset\GWTException' => '/includes/GWTException.php', - - 'GWToolset\Adapters\DataAdapterInterface' => '/includes/Adapters/DataAdapterInterface.php', - - 'GWToolset\Adapters\Php\MappingPhpAdapter' => '/includes/Adapters/Php/MappingPhpAdapter.php', - 'GWToolset\Adapters\Php\MediawikiTemplatePhpAdapter' => '/includes/Adapters/Php/MediawikiTemplatePhpAdapter.php', - 'GWToolset\Adapters\Php\MetadataPhpAdapter' => '/includes/Adapters/Php/MetadataPhpAdapter.php', - - 'GWToolset\Forms\MetadataDetectForm' => '/includes/Forms/MetadataDetectForm.php', - 'GWToolset\Forms\MetadataMappingForm' => '/includes/Forms/MetadataMappingForm.php', - 'GWToolset\Forms\PreviewForm' => '/includes/Forms/PreviewForm.php', - - 'GWToolset\Handlers\Forms\FormHandler' => '/includes/Handlers/Forms/FormHandler.php', - 'GWToolset\Handlers\Forms\MetadataDetectHandler' => '/includes/Handlers/Forms/MetadataDetectHandler.php', - 'GWToolset\Handlers\Forms\MetadataMappingHandler' => '/includes/Handlers/Forms/MetadataMappingHandler.php', - - 'GWToolset\Handlers\SpecialPageHandler' => '/includes/Handlers/SpecialPageHandler.php', - 'GWToolset\Handlers\UploadHandler' => '/includes/Handlers/UploadHandler.php', - 'GWToolset\Handlers\Xml\XmlDetectHandler' => '/includes/Handlers/Xml/XmlDetectHandler.php', - 'GWToolset\Handlers\Xml\XmlHandler' => '/includes/Handlers/Xml/XmlHandler.php', - 'GWToolset\Handlers\Xml\XmlMappingHandler' => '/includes/Handlers/Xml/XmlMappingHandler.php', - - 'GWToolset\Helpers\FileChecks' => '/includes/Helpers/FileChecks.php', - 'GWToolset\Helpers\GWTFileBackend' => '/includes/Helpers/GWTFileBackend.php', - 'GWToolset\Helpers\WikiChecks' => '/includes/Helpers/WikiChecks.php', - 'GWToolset\Helpers\WikiPages' => '/includes/Helpers/WikiPages.php', - - 'GWToolset\Hooks' => '/includes/Hooks/Hooks.php', - - 'GWToolset\Jobs\GWTFileBackendCleanupJob' => '/includes/Jobs/GWTFileBackendCleanupJob.php', - 'GWToolset\Jobs\UploadMediafileJob' => '/includes/Jobs/UploadMediafileJob.php', - 'GWToolset\Jobs\UploadMetadataJob' => '/includes/Jobs/UploadMetadataJob.php', - - 'GWToolset\Models\Mapping' => '/includes/Models/Mapping.php', - 'GWToolset\Models\MediawikiTemplate' => '/includes/Models/MediawikiTemplate.php', - 'GWToolset\Models\Metadata' => '/includes/Models/Metadata.php', - 'GWToolset\Models\ModelInterface' => '/includes/Models/ModelInterface.php', - - 'GWToolset\SpecialGWToolset' => '/includes/Specials/SpecialGWToolset.php', - - 'Php\File' => '/includes/Php/File.php', - 'Php\FileException' => '/includes/Php/FileException.php', - 'Php\Filter' => '/includes/Php/Filter.php', - 'Php\FilterException' => '/includes/Php/FilterException.php' - ); - - /** * @var {string} */ public static $category_separator = '|'; - - /** - * @var {array} - */ - public static $hooks = array( - 'CanonicalNamespaces' => 'GWToolset\Hooks::onCanonicalNamespaces', - 'UnitTestsList' => 'GWToolset\Hooks::onUnitTestsList' - ); /** * @var {int} @@ -121,16 +60,6 @@ * @var {string} */ public static $http_agent = 'Mozilla/5.0 (Windows; U; Windows NT 5.1; rv:1.7.3) Gecko/20041001 Firefox/0.10.1'; - - /** - * @var {array} - * register jobs with the wiki - */ - public static $jobs = array( - 'gwtoolsetGWTFileBackendCleanupJob' => 'GWToolset\Jobs\GWTFileBackendCleanupJob', - 'gwtoolsetUploadMediafileJob' => 'GWToolset\Jobs\UploadMediafileJob', - 'gwtoolsetUploadMetadataJob' => 'GWToolset\Jobs\UploadMetadataJob' - ); /** * @var {int} @@ -153,6 +82,7 @@ /** * @var {array} + * fallbacks in case there’s no template data for these MediaWiki templates * http://gwtoolset/api.php?action=templatedata&titles=Template:Artwork */ public static $mediawiki_templates = array( @@ -174,15 +104,6 @@ * 128M default */ public static $memory_limit = '256M'; - - /** - * @var {array} - */ - public static $messages = array( - 'GWToolsetAlias' => '/GWToolset.alias.php', - 'GWToolset' => '/GWToolset.i18n.php', - 'GWToolsetNamespaces' => '/GWToolset.namespaces.php', - ); /** * @var {string} @@ -226,57 +147,9 @@ /** * @var {string} - */ - public static $required_mediawiki_version = '1.22c'; - - /** - * @var {array} - */ - public static $resources = array( - 'scripts' => array( - 'resources/js/ext.gwtoolset.js' - ), - 'styles' => array( - 'resources/css/ext.gwtoolset.css' - ), - 'messages' => array( - 'gwtoolset-back-text-link', - 'gwtoolset-cancel', - 'gwtoolset-create-mapping', - 'gwtoolset-developer-issue', - 'gwtoolset-loading', - 'gwtoolset-save', - 'gwtoolset-save-mapping', - 'gwtoolset-save-mapping-name', - 'gwtoolset-save-mapping-failed', - 'gwtoolset-save-mapping-succeeded', - 'gwtoolset-step-2-heading' - ), - 'dependencies' => array( - 'jquery.json', - 'jquery.spinner', - 'jquery.ui.widget', - 'jquery.ui.button', - 'jquery.ui.draggable', - 'jquery.ui.mouse', - 'jquery.ui.position', - 'jquery.ui.resizable', - 'jquery.ui.dialog' - ) - ); - - /** - * @var {string} * Category:Source_templates is the category on commons for partner templates */ public static $source_templates = 'Source_templates'; - - /** - * @see SpecialPage __constructor - * @var {string} - * name of the special page, as seen in links and URLs - */ - public static $special_page_name = 'GWToolset'; /** * @see SpecialPage __constructor @@ -291,16 +164,6 @@ * whether the page is listed in Special:Specialpages */ public static $special_page_listed = true; - - /** - * @var {array} - */ - public static $special_pages = array( - 'GWToolset' => array( - 'class_name' => 'GWToolset\SpecialGWToolset', - 'group' => 'media' - ) - ); /** * @var {int} @@ -320,11 +183,6 @@ * delimited list in the input file’s accept attribute */ public static $use_file_accept_attribute = true; - - /** - * @var {bool} - */ - public static $use_UploadStash = true; /** * @var {string} diff --git a/includes/Constants.php b/includes/Constants.php new file mode 100644 index 0000000..5c91817 --- /dev/null +++ b/includes/Constants.php @@ -0,0 +1,18 @@ +<?php +/** + * GWToolset + * + * @file + * @ingroup Extensions + * @license GNU General Public License 3.0 http://www.gnu.org/licenses/gpl.html + */ + +namespace GWToolset; + +class Constants { + + const EXTENSION_NAME = 'GWToolset'; + const REQUIRED_MEDIAWIKI_VERSION = '1.22c'; + const USE_FILEBACKEND = true; + +} diff --git a/includes/Forms/MetadataDetectForm.php b/includes/Forms/MetadataDetectForm.php index ad89fb4..d842c0f 100644 --- a/includes/Forms/MetadataDetectForm.php +++ b/includes/Forms/MetadataDetectForm.php @@ -10,6 +10,7 @@ use Html, GWToolset\Adapters\Php\MediawikiTemplatePhpAdapter, GWToolset\Config, + GWToolset\Constants, GWToolset\Helpers\FileChecks, GWToolset\Models\MediawikiTemplate, Linker, @@ -273,7 +274,7 @@ public static function getMetadataFileUrlExtraInstructions() { $result = null; - if ( Config::$use_UploadStash ) { + if ( Constants::USE_FILEBACKEND ) { return $result; } @@ -286,7 +287,7 @@ public static function getMetadataFileUrlInput( $namespace ) { $result = null; - if ( Config::$use_UploadStash ) { + if ( Constants::USE_FILEBACKEND ) { return $result; } diff --git a/includes/GWTException.php b/includes/GWTException.php index 6d5baa8..980b2f9 100644 --- a/includes/GWTException.php +++ b/includes/GWTException.php @@ -8,7 +8,7 @@ */ namespace GWToolset; -use \Exception; +use Exception; class GWTException extends Exception { } diff --git a/includes/Handlers/Forms/MetadataMappingHandler.php b/includes/Handlers/Forms/MetadataMappingHandler.php index 6a6c4a4..f69e21f 100644 --- a/includes/Handlers/Forms/MetadataMappingHandler.php +++ b/includes/Handlers/Forms/MetadataMappingHandler.php @@ -13,6 +13,7 @@ GWToolset\Adapters\Php\MediawikiTemplatePhpAdapter, GWToolset\Adapters\Php\MetadataPhpAdapter, GWToolset\Config, + GWToolset\Constants, GWToolset\Forms\PreviewForm, GWToolset\GWTException, GWToolset\Helpers\GWTFileBackend, @@ -100,7 +101,7 @@ $job = new UploadMetadataJob( Title::newFromText( $this->User->getName() . '/' . - Config::$name . '/' . + Constants::EXTENSION_NAME . '/' . 'Metadata Batch Job/' . uniqid(), NS_USER @@ -433,6 +434,7 @@ $this->_whitelisted_post['gwtoolset-record-begin'] = (int)$user_options['gwtoolset-record-current']; $this->createMetadataBatchJob( $user_options ); + } else { // no more UploadMediafileJobs need to be created // create a GWTFileBackendCleanupJob that will delete the metadata file in the mwstore diff --git a/includes/Handlers/UploadHandler.php b/includes/Handlers/UploadHandler.php index 2048836..1f1ca14 100644 --- a/includes/Handlers/UploadHandler.php +++ b/includes/Handlers/UploadHandler.php @@ -10,6 +10,7 @@ namespace GWToolset\Handlers; use ContentHandler, GWToolset\Config, + GWToolset\Constants, GWToolset\GWTException, GWToolset\Helpers\GWTFileBackend, GWToolset\Helpers\FileChecks, @@ -495,7 +496,7 @@ $options['ignorewarnings'] = true; $options['watch'] = true; $options['comment'] = wfMessage( 'gwtoolset-create-mediafile' ) - ->params( Config::$name, $this->_User->getName() ) + ->params( Constants::EXTENSION_NAME, $this->_User->getName() ) ->escaped() . PHP_EOL . trim( $this->user_options['comment'] ); @@ -562,7 +563,7 @@ $job = new UploadMediafileJob( Title::newFromText( $this->_User->getName() . '/' . - Config::$name . '/' . + Constants::EXTENSION_NAME . '/' . 'Mediafile Batch Job/' . uniqid(), NS_USER diff --git a/includes/Helpers/GWTFileBackend.php b/includes/Helpers/GWTFileBackend.php index 30b6dff..76ca605 100644 --- a/includes/Helpers/GWTFileBackend.php +++ b/includes/Helpers/GWTFileBackend.php @@ -11,6 +11,7 @@ use FileBackendGroup, GWToolset\Jobs\GWTFileBackendCleanupJob, GWToolset\Config, + GWToolset\Constants, JobQueueGroup, MWException, Php\File, @@ -78,7 +79,7 @@ $job = new GWTFileBackendCleanupJob( Title::newFromText( Filter::evaluate( $this->_User->getName() ) . '/' . - Filter::evaluate( Config::$name ) . '/' . + Filter::evaluate( Constants::EXTENSION_NAME ) . '/' . 'FileBackend Cleanup Job/' . uniqid(), NS_USER diff --git a/includes/Helpers/WikiChecks.php b/includes/Helpers/WikiChecks.php index 27127f7..632fdd6 100644 --- a/includes/Helpers/WikiChecks.php +++ b/includes/Helpers/WikiChecks.php @@ -9,6 +9,7 @@ namespace GWToolset\Helpers; use GWToolset\Config, + GWToolset\Constants, Html, MWException, PermissionsError, @@ -91,11 +92,11 @@ global $wgVersion; try { - wfUseMW( Config::$required_mediawiki_version ); + wfUseMW( Constants::REQUIRED_MEDIAWIKI_VERSION ); } catch( MWException $e ) { return Status::newFatal( 'gwtoolset-mediawiki-version-invalid', - Config::$required_mediawiki_version, + Constants::REQUIRED_MEDIAWIKI_VERSION, $wgVersion ); } @@ -137,7 +138,7 @@ if ( !defined( 'PHP_VERSION' ) || version_compare( PHP_VERSION, '5.3.3', '<' ) ) { - return Status::newFatal( 'gwtoolset-verify-php-version', Config::$name ); + return Status::newFatal( 'gwtoolset-verify-php-version', Constants::EXTENSION_NAME ); } return Status::newGood(); @@ -326,7 +327,7 @@ global $wgEnableUploads; if ( !$wgEnableUploads || ( !wfIsHHVM() && !wfIniGetBool( 'file_uploads' ) ) ) { - return Status::newFatal( 'gwtoolset-verify-uploads-enabled', Config::$name ); + return Status::newFatal( 'gwtoolset-verify-uploads-enabled', Constants::EXTENSION_NAME ); } return Status::newGood(); @@ -339,7 +340,7 @@ global $wgEnableAPI; if ( !$wgEnableAPI ) { - return Status::newFatal( 'gwtoolset-verify-api-enabled', Config::$name ); + return Status::newFatal( 'gwtoolset-verify-api-enabled', Constants::EXTENSION_NAME ); } return Status::newGood(); @@ -352,7 +353,7 @@ global $wgEnableWriteAPI; if ( !$wgEnableWriteAPI ) { - return Status::newFatal( 'gwtoolset-verify-api-writeable', Config::$name ); + return Status::newFatal( 'gwtoolset-verify-api-writeable', Constants::EXTENSION_NAME ); } return Status::newGood(); @@ -363,7 +364,7 @@ */ public static function verifyFinfoExists() { if ( !class_exists( 'finfo' ) ) { - return Status::newFatal( 'gwtoolset-verify-finfo', Config::$name ); + return Status::newFatal( 'gwtoolset-verify-finfo', Constants::EXTENSION_NAME ); } return Status::newGood(); @@ -374,7 +375,7 @@ */ public static function verifyXMLReaderExists() { if ( !class_exists( 'XMLReader' ) ) { - return Status::newFatal( 'gwtoolset-verify-xmlreader', Config::$name ); + return Status::newFatal( 'gwtoolset-verify-xmlreader', Constants::EXTENSION_NAME ); } return Status::newGood(); diff --git a/includes/Specials/SpecialGWToolset.php b/includes/Specials/SpecialGWToolset.php index d6ad479..76b7ef9 100644 --- a/includes/Specials/SpecialGWToolset.php +++ b/includes/Specials/SpecialGWToolset.php @@ -8,8 +8,9 @@ */ namespace GWToolset; -use GWToolset\Handlers\SpecialPageHandler, +use GWToolset\Constants, GWToolset\GWTException, + GWToolset\Handlers\SpecialPageHandler, GWToolset\Helpers\FileChecks, GWToolset\Helpers\WikiChecks, Html, @@ -55,7 +56,7 @@ public function __construct() { parent::__construct( - Config::$special_page_name, + Constants::EXTENSION_NAME, Config::$special_page_restriction, Config::$special_page_listed ); @@ -169,7 +170,7 @@ $this->getOutput()->addHtml( wfMessage( 'gwtoolset-menu' )->rawParams( Linker::link( - Title::newFromText( 'Special:' . Config::$name ), + Title::newFromText( 'Special:' . Constants::EXTENSION_NAME ), wfMessage( 'gwtoolset-menu-1' )->escaped(), array(), array( 'gwtoolset-form' => 'metadata-detect' ) -- To view, visit https://gerrit.wikimedia.org/r/96147 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I2dc355ee6e39d6f173c3dfe5dcd41c5f340749fa Gerrit-PatchSet: 5 Gerrit-Project: mediawiki/extensions/GWToolset Gerrit-Branch: master Gerrit-Owner: Dan-nl <[email protected]> Gerrit-Reviewer: Aaron Schulz <[email protected]> Gerrit-Reviewer: BryanDavis <[email protected]> Gerrit-Reviewer: Dan-nl <[email protected]> Gerrit-Reviewer: Gergő Tisza <[email protected]> Gerrit-Reviewer: jenkins-bot _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
