wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-11-24 06:24:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Use Config instead of globals"

Browse source
This commit is contained in:
jenkins-bot 2014-08-15 22:55:02 +00:00 committed by Gerrit Code Review
parent 924e3c026d 5575bed67c
commit 14e4a915d7
5 changed files with 112 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
ApiVisualEditor.php
View file

@ -10,33 +10,38 @@
class ApiVisualEditor extends ApiBase {
/**
* @var Config
*/
protected $veConfig;
public function __construct( ApiMain $main, $name, Config $config ) {
parent::__construct( $main, $name );
$this->veConfig = $config;
}
/**
* Parsoid HTTP proxy configuration for MWHttpRequest
*/
protected function getProxyConf() {
global $wgVisualEditorParsoidHTTPProxy;
if ( $wgVisualEditorParsoidHTTPProxy ) {
return array( 'proxy' => $wgVisualEditorParsoidHTTPProxy );
$parsoidHTTPProxy = $this->veConfig->get( 'VisualEditorParsoidHTTPProxy' );
if ( $parsoidHTTPProxy ) {
return array( 'proxy' => $parsoidHTTPProxy );
} else {
return array( 'noProxy' => true );
}
}
protected function requestParsoid( $method, $title, $params ) {
global $wgVisualEditorParsoidURL,
$wgVisualEditorParsoidPrefix,
$wgVisualEditorParsoidTimeout,
$wgVisualEditorParsoidForwardCookies;
$url = $wgVisualEditorParsoidURL . '/' .
$wgVisualEditorParsoidPrefix . '/' .
$url = $this->veConfig->get( 'VisualEditorParsoidURL' ) . '/' .
$this->veConfig->get( 'VisualEditorParsoidPrefix' ) . '/' .
urlencode( $title->getPrefixedDBkey() );
$data = array_merge(
$this->getProxyConf(),
array(
'method' => $method,
'timeout' => $wgVisualEditorParsoidTimeout,
'timeout' => $this->veConfig->get( 'VisualEditorParsoidTimeout' ),
)
);
@ -48,7 +53,9 @@ class ApiVisualEditor extends ApiBase {
$req = MWHttpRequest::factory( $url, $data );
// Forward cookies, but only if configured to do so and if there are read restrictions
if ( $wgVisualEditorParsoidForwardCookies && !User::isEveryoneAllowed( 'read' ) ) {
if ( $this->veConfig->get( 'VisualEditorParsoidForwardCookies' )
&& !User::isEveryoneAllowed( 'read' )
) {
$req->setHeader( 'Cookie', $this->getRequest()->getHeader( 'Cookie' ) );
}
$status = $req->execute();
@ -83,11 +90,6 @@ class ApiVisualEditor extends ApiBase {
}
protected function getHTML( $title, $parserParams ) {
global $wgVisualEditorParsoidURL,
$wgVisualEditorParsoidPrefix,
$wgVisualEditorParsoidTimeout,
$wgVisualEditorParsoidForwardCookies;
$restoring = false;
if ( $title->exists() ) {
@ -132,14 +134,14 @@ class ApiVisualEditor extends ApiBase {
}
protected function storeInSerializationCache( $title, $oldid, $html ) {
global $wgMemc, $wgVisualEditorSerializationCacheTimeout;
global $wgMemc;
$content = $this->postHTML( $title, $html, array( 'oldid' => $oldid ) );
if ( $content === false ) {
return false;
}
$hash = md5( $content );
$key = wfMemcKey( 'visualeditor', 'serialization', $hash );
$wgMemc->set( $key, $content, $wgVisualEditorSerializationCacheTimeout );
$wgMemc->set( $key, $content, $this->veConfig->get( 'VisualEditorSerializationCacheTimeout' ) );
return $hash;
}
@ -282,8 +284,6 @@ class ApiVisualEditor extends ApiBase {
}
public function execute() {
global $wgVisualEditorNamespaces;
$user = $this->getUser();
$params = $this->extractRequestParams();
@ -291,7 +291,7 @@ class ApiVisualEditor extends ApiBase {
if ( !$page ) {
$this->dieUsageMsg( 'invalidtitle', $params['page'] );
}
if ( !in_array( $page->getNamespace(), $wgVisualEditorNamespaces ) ) {
if ( !in_array( $page->getNamespace(), $this->veConfig->get( 'VisualEditorNamespaces' ) ) ) {
$this->dieUsage( "VisualEditor is not enabled in namespace " .
$page->getNamespace(), 'novenamespace' );
}

12
ApiVisualEditorEdit.php
View file

@ -10,6 +10,10 @@
class ApiVisualEditorEdit extends ApiVisualEditor {
public function __construct( ApiMain $main, $name, Config $config ) {
parent::__construct( $main, $name, $config );
}
protected function saveWikitext( $title, $wikitext, $params ) {
$apiParams = array(
'action' => 'edit',
@ -53,15 +57,13 @@ class ApiVisualEditorEdit extends ApiVisualEditor {
}
public function execute() {
global $wgVisualEditorNamespaces, $wgVisualEditorUseChangeTagging;
$user = $this->getUser();
$params = $this->extractRequestParams();
$page = Title::newFromText( $params['page'] );
if ( !$page ) {
$this->dieUsageMsg( 'invalidtitle', $params['page'] );
}
if ( !in_array( $page->getNamespace(), $wgVisualEditorNamespaces ) ) {
if ( !in_array( $page->getNamespace(), $this->veConfig->get( 'VisualEditorNamespaces' ) ) ) {
$this->dieUsage( "VisualEditor is not enabled in namespace " .
$page->getNamespace(), 'novenamespace' );
}
@ -100,7 +102,9 @@ class ApiVisualEditorEdit extends ApiVisualEditor {
// Success
} else {
if ( isset( $saveresult['edit']['newrevid'] ) && $wgVisualEditorUseChangeTagging ) {
if ( isset( $saveresult['edit']['newrevid'] )
&& $this->veConfig->get( 'VisualEditorUseChangeTagging' )
) {
ChangeTags::addTags( 'visualeditor', null,
intval( $saveresult['edit']['newrevid'] ),
null

118
VisualEditor.hooks.php
View file

@ -10,9 +10,6 @@
class VisualEditorHooks {
public static function onSetup() {
global $wgResourceModules,
$wgVisualEditorTabMessages;
// This prevents VisualEditor from being run in environments that don't
// have the dependent code in core; this should be updated as a part of
// when additional dependencies are created and pushed into MediaWiki's
@ -20,14 +17,18 @@ class VisualEditorHooks {
// parties who attempt to install VisualEditor onto non-alpha wikis, as
// this should have no impact on deploying to Wikimedia's wiki cluster;
// is fine for release tarballs because 1.22wmf11 < 1.22alpha < 1.22.0.
wfUseMW( '1.24wmf6' );
wfUseMW( '1.24wmf17' );
$coreConfig = ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
$veConfig = ConfigFactory::getDefaultInstance()->makeConfig( 'visualeditor' );
$resourceModules = $coreConfig->get( 'ResourceModules' );
// Add tab messages to the init init module
foreach ( $wgVisualEditorTabMessages as $msg ) {
foreach ( $veConfig->get( 'VisualEditorTabMessages' ) as $msg ) {
if ( $msg !== null ) {
$wgResourceModules['ext.visualEditor.viewPageTarget.init']['messages'][] = $msg;
$resourceModules['ext.visualEditor.viewPageTarget.init']['messages'][] = $msg;
}
}
$coreConfig->set( 'ResourceModules', $resourceModules );
}
/**
@ -63,7 +64,8 @@ class VisualEditorHooks {
return true;
}
global $wgVisualEditorTabMessages, $wgVisualEditorTabPosition;
$config = ConfigFactory::getDefaultInstance()->makeConfig( 'visualeditor' );
if ( !isset( $links['views']['edit'] ) ) {
// There's no edit link, nothing to do
return true;
@ -72,6 +74,7 @@ class VisualEditorHooks {
if ( defined( 'EP_NS' ) && $title->inNamespace( EP_NS ) ) {
return true;
}
$tabMessages = $config->get( 'VisualEditorTabMessages' );
// Rebuild the $links['views'] array and inject the VisualEditor tab before or after
// the edit tab as appropriate. We have to rebuild the array because PHP doesn't allow
// us to splice into the middle of an associative array.
@ -87,7 +90,7 @@ class VisualEditorHooks {
$veParams = $skin->editUrlOptions();
unset( $veParams['action'] ); // Remove action=edit
$veParams['veaction'] = 'edit'; // Set veaction=edit
$veTabMessage = $wgVisualEditorTabMessages[$action];
$veTabMessage = $tabMessages[$action];
$veTabText = $veTabMessage === null ? $data['text'] :
wfMessage( $veTabMessage )->setContext( $skin->getContext() )->text();
$veTab = array(
@ -104,9 +107,9 @@ class VisualEditorHooks {
WikiPage::factory( $title ) instanceof WikiFilePage &&
!WikiPage::factory( $title )->isLocal()
) {
$editTabMessage = $wgVisualEditorTabMessages[$action . 'localdescriptionsource'];
$editTabMessage = $tabMessages[$action . 'localdescriptionsource'];
} else {
$editTabMessage = $wgVisualEditorTabMessages[$action . 'source'];
$editTabMessage = $tabMessages[$action . 'source'];
}
if ( $editTabMessage !== null ) {
@ -114,7 +117,7 @@ class VisualEditorHooks {
}
// Inject the VE tab before or after the edit tab
if ( $wgVisualEditorTabPosition === 'before' ) {
if ( $config->get( 'VisualEditorTabPosition' ) === 'before' ) {
$editTab['class'] .= ' collapsible';
$newViews['ve-edit'] = $veTab;
$newViews['edit'] = $editTab;
@ -206,11 +209,12 @@ class VisualEditorHooks {
return;
}
global $wgVisualEditorTabMessages, $wgVisualEditorTabPosition;
$veEditSection = $wgVisualEditorTabMessages['editsection'] !== null ?
$wgVisualEditorTabMessages['editsection'] : 'editsection';
$sourceEditSection = $wgVisualEditorTabMessages['editsectionsource'] !== null ?
$wgVisualEditorTabMessages['editsectionsource'] : 'editsection';
$config = ConfigFactory::getDefaultInstance()->makeConfig( 'visualeditor' );
$tabMessages = $config->get( 'VisualEditorTabMessages' );
$veEditSection = $tabMessages['editsection'] !== null ?
$tabMessages['editsection'] : 'editsection';
$sourceEditSection = $tabMessages['editsectionsource'] !== null ?
$tabMessages['editsectionsource'] : 'editsection';
// Code mostly duplicated from Skin::doEditSectionLink() :(
$attribs = array();
@ -231,7 +235,7 @@ class VisualEditorHooks {
array( 'noclasses', 'known' )
);
$veFirst = $wgVisualEditorTabPosition === 'before';
$veFirst = $config->get( 'VisualEditorTabPosition' ) === 'before';
$result = '<span class="mw-editsection">'
. '<span class="mw-editsection-bracket">[</span>'
. ( $veFirst ? $veLink : $sourceLink )
@ -261,7 +265,8 @@ class VisualEditorHooks {
}
public static function onGetPreferences( User $user, array &$preferences ) {
global $wgLang, $wgVisualEditorNamespaces;
global $wgLang;
$config = ConfigFactory::getDefaultInstance()->makeConfig( 'visualeditor' );
if ( !array_key_exists( 'visualeditor-enable', $preferences ) ) {
$preferences['visualeditor-enable'] = array(
'type' => 'toggle',
@ -269,7 +274,7 @@ class VisualEditorHooks {
'visualeditor-preference-enable',
$wgLang->commaList( array_map(
array( 'self', 'convertNs' ),
$wgVisualEditorNamespaces
$config->get( 'VisualEditorNamespaces' )
) )
),
'section' => 'editing/editor'
@ -287,10 +292,10 @@ class VisualEditorHooks {
}
public static function onGetBetaPreferences( User $user, array &$preferences ) {
global $wgExtensionAssetsPath, $wgVisualEditorSupportedSkins, $wgVisualEditorBrowserBlacklist;
$iconpath = $wgExtensionAssetsPath . "/VisualEditor";
$coreConfig = RequestContext::getMain()->getConfig();
$iconpath = $coreConfig->get( 'ExtensionAssetsPath' ) . "/VisualEditor";
$veConfig = ConfigFactory::getDefaultInstance()->makeConfig( 'visualeditor' );
$preferences['visualeditor-enable'] = array(
'version' => '1.0',
'label-message' => 'visualeditor-preference-core-label',
@ -303,8 +308,8 @@ class VisualEditorHooks {
'discussion-message' => 'visualeditor-preference-core-discussion-link',
'requirements' => array(
'javascript' => true,
'blacklist' => $wgVisualEditorBrowserBlacklist,
'skins' => $wgVisualEditorSupportedSkins,
'blacklist' => $veConfig->get( 'VisualEditorBrowserBlacklist' ),
'skins' => $veConfig->get( 'VisualEditorSupportedSkins' ),
)
);
@ -356,20 +361,18 @@ class VisualEditorHooks {
* Adds extra variables to the page config.
*/
public static function onMakeGlobalVariablesScript( array &$vars, OutputPage $out ) {
global $wgStylePath, $wgSVGMaxSize, $wgNamespacesWithSubpages;
$pageLanguage = $out->getTitle()->getPageLanguage();
$vars['wgVisualEditor'] = array(
'isPageWatched' => $out->getUser()->isWatched( $out->getTitle() ),
// Same as in Linker.php
'magnifyClipIconURL' => $wgStylePath .
'magnifyClipIconURL' => $out->getConfig()->get( 'StylePath' ) .
'/common/images/magnify-clip' .
( $pageLanguage->isRTL() ? '-rtl' : '' ) . '.png',
'pageLanguageCode' => $pageLanguage->getHtmlCode(),
'pageLanguageDir' => $pageLanguage->getDir(),
'svgMaxSize' => $wgSVGMaxSize,
'namespacesWithSubpages' => $wgNamespacesWithSubpages
'svgMaxSize' => $out->getConfig()->get( 'SVGMaxSize' ),
'namespacesWithSubpages' => $out->getConfig()->get( 'NamespacesWithSubpages' )
);
return true;
@ -379,40 +382,32 @@ class VisualEditorHooks {
* Adds extra variables to the global config
*/
public static function onResourceLoaderGetConfigVars( array &$vars ) {
global $wgDefaultUserOptions,
$wgThumbLimits,
$wgVisualEditorDisableForAnons,
$wgVisualEditorNamespaces,
$wgVisualEditorPluginModules,
$wgVisualEditorTabPosition,
$wgVisualEditorTabMessages,
$wgVisualEditorBrowserBlacklist,
$wgVisualEditorSupportedSkins,
$wgVisualEditorShowBetaWelcome,
$wgVisualEditorEnableTocWidget,
$wgVisualEditorPreferenceModules;
$coreConfig = RequestContext::getMain()->getConfig();
$defaultUserOptions = $coreConfig->get( 'DefaultUserOptions' );
$thumbLimits = $coreConfig->get( 'ThumbLimits' );
$veConfig = ConfigFactory::getDefaultInstance()->makeConfig( 'visualeditor' );
$vars['wgVisualEditorConfig'] = array(
'disableForAnons' => $wgVisualEditorDisableForAnons,
'preferenceModules' => $wgVisualEditorPreferenceModules,
'namespaces' => $wgVisualEditorNamespaces,
'pluginModules' => $wgVisualEditorPluginModules,
'disableForAnons' => $veConfig->get( 'VisualEditorDisableForAnons' ),
'preferenceModules' => $veConfig->get( 'VisualEditorPreferenceModules' ),
'namespaces' => $veConfig->get( 'VisualEditorNamespaces' ),
'pluginModules' => $veConfig->get( 'VisualEditorPluginModules' ),
'defaultUserOptions' => array(
'betatempdisable' => $wgDefaultUserOptions['visualeditor-betatempdisable'],
'enable' => $wgDefaultUserOptions['visualeditor-enable'],
'defaultthumbsize' => $wgThumbLimits[ $wgDefaultUserOptions['thumbsize'] ]
'betatempdisable' => $defaultUserOptions['visualeditor-betatempdisable'],
'enable' => $defaultUserOptions['visualeditor-enable'],
'defaultthumbsize' => $thumbLimits[ $defaultUserOptions['thumbsize'] ]
),
'blacklist' => $wgVisualEditorBrowserBlacklist,
'skins' => $wgVisualEditorSupportedSkins,
'tabPosition' => $wgVisualEditorTabPosition,
'tabMessages' => $wgVisualEditorTabMessages,
'showBetaWelcome' => $wgVisualEditorShowBetaWelcome,
'enableTocWidget' => $wgVisualEditorEnableTocWidget
'blacklist' => $veConfig->get( 'VisualEditorBrowserBlacklist' ),
'skins' => $veConfig->get( 'VisualEditorSupportedSkins' ),
'tabPosition' => $veConfig->get( 'VisualEditorTabPosition' ),
'tabMessages' => $veConfig->get( 'VisualEditorTabMessages' ),
'showBetaWelcome' => $veConfig->get( 'VisualEditorShowBetaWelcome' ),
'enableTocWidget' => $veConfig->get( 'VisualEditorEnableTocWidget' )
);
foreach ( $wgVisualEditorPreferenceModules as $pref => $module ) {
foreach ( $veConfig->get( 'VisualEditorPreferenceModules' ) as $pref => $module ) {
$vars['wgVisualEditorConfig']['defaultUserOptions'][$pref] =
$wgDefaultUserOptions[$pref];
$defaultUserOptions[$pref];
}
return true;
@ -426,17 +421,18 @@ class VisualEditorHooks {
* @returns boolean true
*/
public static function onResourceLoaderRegisterModules( ResourceLoader &$resourceLoader ) {
global $wgResourceModules, $wgVisualEditorResourceTemplate;
$resourceModules = $resourceLoader->getConfig()->get( 'ResourceModules' );
$veResourceTemplate = ConfigFactory::getDefaultInstance()
->makeConfig( 'visualeditor')->get( 'VisualEditorResourceTemplate' );
$libModules = array(
'jquery.uls.data' => $wgVisualEditorResourceTemplate + array(
'jquery.uls.data' => $veResourceTemplate + array(
'scripts' => array(
'lib/ve/lib/jquery.uls/src/jquery.uls.data.js',
'lib/ve/lib/jquery.uls/src/jquery.uls.data.utils.js',
),
'targets' => array( 'desktop', 'mobile' ),
),
'jquery.i18n' => $wgVisualEditorResourceTemplate + array(
'jquery.i18n' => $veResourceTemplate + array(
'scripts' => array(
'lib/ve/lib/jquery.i18n/src/jquery.i18n.js',
'lib/ve/lib/jquery.i18n/src/jquery.i18n.messagestore.js',
@ -468,7 +464,7 @@ class VisualEditorHooks {
$addModules = array();
foreach ( $libModules as $name => $data ) {
if ( !isset( $wgResourceModules[$name] ) && !$resourceLoader->getModule( $name ) ) {
if ( !isset( $resourceModules[$name] ) && !$resourceLoader->getModule( $name ) ) {
$addModules[$name] = $data;
}
}

24
VisualEditor.php
View file

@ -48,8 +48,28 @@ $wgMessagesDirs['VisualEditor'] = array(
);
// Register API modules
$wgAPIModules['visualeditor'] = 'ApiVisualEditor';
$wgAPIModules['visualeditoredit'] = 'ApiVisualEditorEdit';
$wgAPIModules['visualeditor'] = array(
'class' => 'ApiVisualEditor',
'factory' => 'wfVisualEditorApiFactory',
);
$wgAPIModules['visualeditoredit'] = array(
'class' => 'ApiVisualEditorEdit',
'factory' => 'wfVisualEditorApiFactory',
);
/**
* @param ApiMain $main
* @param string $name
* @return ApiVisualEditor|ApiVisualEditorEdit
*/
function wfVisualEditorApiFactory( $main, $name ) {
$config = ConfigFactory::getDefaultInstance()->makeConfig( 'visualeditor' );
$class = $name === 'visualeditor' ? 'ApiVisualEditor' : 'ApiVisualEditorEdit';
return new $class( $main, $name, $config );
}
// Register Config instance
$wgConfigRegistry['visualeditor'] = 'GlobalVarConfig::newInstance';
// Register Hooks
$wgHooks['BeforePageDisplay'][] = 'VisualEditorHooks::onBeforePageDisplay';

6
VisualEditorDataModule.php
View file

@ -87,11 +87,11 @@ class VisualEditorDataModule extends ResourceLoaderModule {
);
// Copyright warning (based on EditPage::getCopyrightWarning)
global $wgRightsText;
if ( $wgRightsText ) {
$rightsText = $this->config->get( 'RightsText' );
if ( $rightsText ) {
$copywarnMsg = array( 'copyrightwarning',
'[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]',
$wgRightsText );
$rightsText );
} else {
$copywarnMsg = array( 'copyrightwarning2',
'[[' . wfMessage( 'copyrightpage' )->inContentLanguage()->text() . ']]' );