MediaWiki  1.30.0
GadgetHooks.php
Go to the documentation of this file.
1 <?php
2 
23 use WrappedString\WrappedString;
24 
25 class GadgetHooks {
34  public static function onPageContentSaveComplete( $article, $user, $content ) {
35  // update cache if MediaWiki:Gadgets-definition was edited
36  $title = $article->getTitle();
37  $repo = GadgetRepo::singleton();
38  if ( $title->getNamespace() == NS_MEDIAWIKI && $title->getText() == 'Gadgets-definition'
39  && $repo instanceof MediaWikiGadgetsDefinitionRepo
40  ) {
41  $repo->purgeDefinitionCache();
42  }
43  return true;
44  }
45 
51  public static function userGetDefaultOptions( &$defaultOptions ) {
52  $gadgets = GadgetRepo::singleton()->getStructuredList();
53  if ( !$gadgets ) {
54  return true;
55  }
56 
60  foreach ( $gadgets as $thisSection ) {
61  foreach ( $thisSection as $gadgetId => $gadget ) {
62  if ( $gadget->isOnByDefault() ) {
63  $defaultOptions['gadget-' . $gadgetId] = 1;
64  }
65  }
66  }
67 
68  return true;
69  }
70 
77  public static function getPreferences( $user, &$preferences ) {
78  $gadgets = GadgetRepo::singleton()->getStructuredList();
79  if ( !$gadgets ) {
80  return true;
81  }
82 
83  $options = [];
84  $default = [];
85  foreach ( $gadgets as $section => $thisSection ) {
86  $available = [];
87 
91  foreach ( $thisSection as $gadget ) {
92  if ( !$gadget->isHidden() && $gadget->isAllowed( $user ) ) {
93  $gname = $gadget->getName();
94  # bug 30182: dir="auto" because it's often not translated
95  $desc = '<span dir="auto">' . $gadget->getDescription() . '</span>';
96  $available[$desc] = $gname;
97  if ( $gadget->isEnabled( $user ) ) {
98  $default[] = $gname;
99  }
100  }
101  }
102 
103  if ( $section !== '' ) {
104  $section = wfMessage( "gadget-section-$section" )->parse();
105 
106  if ( count( $available ) ) {
107  $options[$section] = $available;
108  }
109  } else {
110  $options = array_merge( $options, $available );
111  }
112  }
113 
114  $preferences['gadgets-intro'] =
115  [
116  'type' => 'info',
117  'label' => '&#160;',
118  'default' => Xml::tags( 'tr', [],
119  Xml::tags( 'td', [ 'colspan' => 2 ],
120  wfMessage( 'gadgets-prefstext' )->parseAsBlock() ) ),
121  'section' => 'gadgets',
122  'raw' => 1,
123  'rawrow' => 1,
124  'noglobal' => true,
125  ];
126 
127  $preferences['gadgets'] =
128  [
129  'type' => 'multiselect',
130  'options' => $options,
131  'section' => 'gadgets',
132  'label' => '&#160;',
133  'prefix' => 'gadget-',
134  'default' => $default,
135  'noglobal' => true,
136  ];
137 
138  return true;
139  }
140 
146  public static function registerModules( &$resourceLoader ) {
147  $repo = GadgetRepo::singleton();
148  $ids = $repo->getGadgetIds();
149 
150  foreach ( $ids as $id ) {
151  $resourceLoader->register( Gadget::getModuleName( $id ), [
152  'class' => 'GadgetResourceLoaderModule',
153  'id' => $id,
154  ] );
155  }
156 
157  return true;
158  }
159 
165  public static function beforePageDisplay( $out ) {
166  $repo = GadgetRepo::singleton();
167  $ids = $repo->getGadgetIds();
168  if ( !$ids ) {
169  return true;
170  }
171 
172  $lb = new LinkBatch();
173  $lb->setCaller( __METHOD__ );
174  $enabledLegacyGadgets = [];
175 
179  $user = $out->getUser();
180  foreach ( $ids as $id ) {
181  try {
182  $gadget = $repo->getGadget( $id );
183  } catch ( InvalidArgumentException $e ) {
184  continue;
185  }
186  $peers = [];
187  foreach ( $gadget->getPeers() as $peerName ) {
188  try {
189  $peers[] = $repo->getGadget( $peerName );
190  } catch ( InvalidArgumentException $e ) {
191  // Ignore
192  // @todo: Emit warning for invalid peer?
193  }
194  }
195  if ( $gadget->isEnabled( $user ) && $gadget->isAllowed( $user ) ) {
196  if ( $gadget->hasModule() ) {
197  if ( $gadget->getType() === 'styles' ) {
198  $out->addModuleStyles( Gadget::getModuleName( $gadget->getName() ) );
199  } else {
200  $out->addModules( Gadget::getModuleName( $gadget->getName() ) );
201  // Load peer modules
202  foreach ( $peers as $peer ) {
203  if ( $peer->getType() === 'styles' ) {
204  $out->addModuleStyles( Gadget::getModuleName( $peer->getName() ) );
205  }
206  // Else, if not type=styles: Use dependencies instead.
207  // Note: No need for recursion as styles modules don't support
208  // either of 'dependencies' and 'peers'.
209  }
210  }
211  }
212 
213  if ( $gadget->getLegacyScripts() ) {
214  $enabledLegacyGadgets[] = $id;
215  }
216  }
217  }
218 
219  $strings = [];
220  foreach ( $enabledLegacyGadgets as $id ) {
221  $strings[] = self::makeLegacyWarning( $id );
222  }
223  $out->addHTML( WrappedString::join( "\n", $strings ) );
224 
225  return true;
226  }
227 
228  private static function makeLegacyWarning( $id ) {
229  $special = SpecialPage::getTitleFor( 'Gadgets' );
230 
231  return ResourceLoader::makeInlineScript(
232  Xml::encodeJsCall( 'mw.log.warn', [
233  "Gadget \"$id\" was not loaded. Please migrate it to use ResourceLoader. " .
234  'See <' . $special->getCanonicalURL() . '>.'
235  ] )
236  );
237  }
238 
249  public static function onEditFilterMergedContent( $context, $content, $status, $summary ) {
250  $title = $context->getTitle();
251 
252  if ( !$title->inNamespace( NS_GADGET_DEFINITION ) ) {
253  return true;
254  }
255 
256  if ( !$content instanceof GadgetDefinitionContent ) {
257  // This should not be possible?
258  throw new Exception(
259  "Tried to save non-GadgetDefinitionContent to {$title->getPrefixedText()}"
260  );
261  }
262 
263  $status = $content->validate();
264  if ( !$status->isGood() ) {
265  $status->merge( $status );
266  return false;
267  }
268 
269  return true;
270  }
271 
278  public static function onPageContentInsertComplete( WikiPage $page ) {
279  if ( $page->getTitle()->inNamespace( NS_GADGET_DEFINITION ) ) {
280  $repo = GadgetRepo::singleton();
281  if ( $repo instanceof GadgetDefinitionNamespaceRepo ) {
282  $repo->purgeGadgetIdsList();
283  }
284  }
285  }
286 
295  public static function onContentHandlerDefaultModelFor( Title $title, &$model ) {
296  if ( $title->inNamespace( NS_GADGET ) ) {
297  preg_match( '!\.(css|js)$!u', $title->getText(), $ext );
298  $ext = isset( $ext[1] ) ? $ext[1] : '';
299  switch ( $ext ) {
300  case 'js':
301  $model = 'javascript';
302  return false;
303  case 'css':
304  $model = 'css';
305  return false;
306  }
307  }
308 
309  return true;
310  }
311 
320  public static function onCodeEditorGetPageLanguage( Title $title, &$lang ) {
321  if ( $title->hasContentModel( 'GadgetDefinition' ) ) {
322  $lang = 'json';
323  return false;
324  }
325 
326  return true;
327  }
328 
334  public static function onwgQueryPages( &$queryPages ) {
335  $queryPages[] = [ 'SpecialGadgetUsage', 'GadgetUsage' ];
336  return true;
337  }
338 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:244
Gadget\getModuleName
static getModuleName( $id)
Definition: Gadgets_body.php:150
GadgetHooks\onContentHandlerDefaultModelFor
static onContentHandlerDefaultModelFor(Title $title, &$model)
Mark the Title as having a content model of javascript or css for pages in the Gadget namespace based...
Definition: GadgetHooks.php:295
$context
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2581
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
Xml\tags
static tags( $element, $attribs=null, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:131
GadgetHooks\onPageContentInsertComplete
static onPageContentInsertComplete(WikiPage $page)
After a new page is created in the Gadget definition namespace, invalidate the list of gadget ids.
Definition: GadgetHooks.php:278
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
captcha-old.count
count
Definition: captcha-old.py:249
MediaWiki\getTitle
getTitle()
Get the Title object that we'll be acting on, as specified in the WebRequest.
Definition: MediaWiki.php:137
$status
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1245
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
WikiPage
Class representing a MediaWiki article and history.
Definition: WikiPage.php:37
GadgetHooks\userGetDefaultOptions
static userGetDefaultOptions(&$defaultOptions)
UserGetDefaultOptions hook handler.
Definition: GadgetHooks.php:51
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
$resourceLoader
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext such as when responding to a resource loader request or generating HTML output & $resourceLoader
Definition: hooks.txt:2581
MediaWikiGadgetsDefinitionRepo
Gadgets repo powered by MediaWiki:Gadgets-definition.
Definition: MediaWikiGadgetsDefinitionRepo.php:8
GadgetHooks\onPageContentSaveComplete
static onPageContentSaveComplete( $article, $user, $content)
PageContentSaveComplete hook handler.
Definition: GadgetHooks.php:34
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
GadgetHooks\registerModules
static registerModules(&$resourceLoader)
ResourceLoaderRegisterModules hook handler.
Definition: GadgetHooks.php:146
Xml\encodeJsCall
static encodeJsCall( $name, $args, $pretty=false)
Create a call to a JavaScript function.
Definition: Xml.php:677
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:932
GadgetHooks
Definition: GadgetHooks.php:25
$article
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function array $article
Definition: hooks.txt:77
WikiPage\getTitle
getTitle()
Get the title object of the article.
Definition: WikiPage.php:239
GadgetRepo\singleton
static singleton()
Get the configured default GadgetRepo.
Definition: GadgetRepo.php:53
GadgetHooks\makeLegacyWarning
static makeLegacyWarning( $id)
Definition: GadgetHooks.php:228
GadgetHooks\getPreferences
static getPreferences( $user, &$preferences)
GetPreferences hook handler.
Definition: GadgetHooks.php:77
GadgetHooks\onEditFilterMergedContent
static onEditFilterMergedContent( $context, $content, $status, $summary)
Valid gadget definition page after content is modified.
Definition: GadgetHooks.php:249
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2141
GadgetDefinitionContent
Definition: GadgetDefinitionContent.php:23
GadgetDefinitionNamespaceRepo
GadgetRepo implementation where each gadget has a page in the Gadget definition namespace,...
Definition: GadgetDefinitionNamespaceRepo.php:10
$special
this hook is for auditing only RecentChangesLinked and Watchlist $special
Definition: hooks.txt:988
GadgetHooks\onCodeEditorGetPageLanguage
static onCodeEditorGetPageLanguage(Title $title, &$lang)
Set the CodeEditor language for Gadget definition pages.
Definition: GadgetHooks.php:320
Title
Represents a title within MediaWiki.
Definition: Title.php:39
GadgetHooks\onwgQueryPages
static onwgQueryPages(&$queryPages)
Add the GadgetUsage special page to the list of QueryPages.
Definition: GadgetHooks.php:334
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1965
$ext
$ext
Definition: NoLocalSettings.php:25
$section
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:2981
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
NS_MEDIAWIKI
const NS_MEDIAWIKI
Definition: Defines.php:73
GadgetHooks\beforePageDisplay
static beforePageDisplay( $out)
BeforePageDisplay hook handler.
Definition: GadgetHooks.php:165
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:781