MediaWiki  master
SpecialEmailUser.php
Go to the documentation of this file.
1 <?php
25 
32  protected $mTarget;
33 
37  protected $mTargetObj;
38 
39  public function __construct() {
40  parent::__construct( 'Emailuser' );
41  }
42 
43  public function doesWrites() {
44  return true;
45  }
46 
47  public function getDescription() {
48  $target = self::getTarget( $this->mTarget, $this->getUser() );
49  if ( !$target instanceof User ) {
50  return $this->msg( 'emailuser-title-notarget' )->text();
51  }
52 
53  return $this->msg( 'emailuser-title-target', $target->getName() )->text();
54  }
55 
56  protected function getFormFields() {
57  $linkRenderer = $this->getLinkRenderer();
58  return [
59  'From' => [
60  'type' => 'info',
61  'raw' => 1,
62  'default' => $linkRenderer->makeLink(
63  $this->getUser()->getUserPage(),
64  $this->getUser()->getName()
65  ),
66  'label-message' => 'emailfrom',
67  'id' => 'mw-emailuser-sender',
68  ],
69  'To' => [
70  'type' => 'info',
71  'raw' => 1,
72  'default' => $linkRenderer->makeLink(
73  $this->mTargetObj->getUserPage(),
74  $this->mTargetObj->getName()
75  ),
76  'label-message' => 'emailto',
77  'id' => 'mw-emailuser-recipient',
78  ],
79  'Target' => [
80  'type' => 'hidden',
81  'default' => $this->mTargetObj->getName(),
82  ],
83  'Subject' => [
84  'type' => 'text',
85  'default' => $this->msg( 'defemailsubject',
86  $this->getUser()->getName() )->inContentLanguage()->text(),
87  'label-message' => 'emailsubject',
88  'maxlength' => 200,
89  'size' => 60,
90  'required' => true,
91  ],
92  'Text' => [
93  'type' => 'textarea',
94  'rows' => 20,
95  'label-message' => 'emailmessage',
96  'required' => true,
97  ],
98  'CCMe' => [
99  'type' => 'check',
100  'label-message' => 'emailccme',
101  'default' => $this->getUser()->getBoolOption( 'ccmeonemails' ),
102  ],
103  ];
104  }
105 
106  public function execute( $par ) {
107  $out = $this->getOutput();
108  $request = $this->getRequest();
109  $out->addModuleStyles( 'mediawiki.special' );
110 
111  $this->mTarget = $par ?? $request->getVal( 'wpTarget', $request->getVal( 'target', '' ) );
112 
113  // Make sure, that HTMLForm uses the correct target.
114  $request->setVal( 'wpTarget', $this->mTarget );
115 
116  // This needs to be below assignment of $this->mTarget because
117  // getDescription() needs it to determine the correct page title.
118  $this->setHeaders();
119  $this->outputHeader();
120 
121  // error out if sending user cannot do this
122  $error = self::getPermissionsError(
123  $this->getUser(),
124  $this->getRequest()->getVal( 'wpEditToken' ),
125  $this->getConfig()
126  );
127 
128  switch ( $error ) {
129  case null:
130  # Wahey!
131  break;
132  case 'badaccess':
133  throw new PermissionsError( 'sendemail' );
134  case 'blockedemailuser':
135  throw $this->getBlockedEmailError();
136  case 'actionthrottledtext':
137  throw new ThrottledError;
138  case 'mailnologin':
139  case 'usermaildisabled':
140  throw new ErrorPageError( $error, "{$error}text" );
141  default:
142  # It's a hook error
143  list( $title, $msg, $params ) = $error;
144  throw new ErrorPageError( $title, $msg, $params );
145  }
146 
147  // Make sure, that a submitted form isn't submitted to a subpage (which could be
148  // a non-existing username)
149  $context = new DerivativeContext( $this->getContext() );
150  $context->setTitle( $this->getPageTitle() ); // Remove subpage
151  $this->setContext( $context );
152 
153  // A little hack: HTMLForm will check $this->mTarget only, if the form was posted, not
154  // if the user opens Special:EmailUser/Florian (e.g.). So check, if the user did that
155  // and show the "Send email to user" form directly, if so. Show the "enter username"
156  // form, otherwise.
157  $this->mTargetObj = self::getTarget( $this->mTarget, $this->getUser() );
158  if ( !$this->mTargetObj instanceof User ) {
159  $this->userForm( $this->mTarget );
160  } else {
161  $this->sendEmailForm();
162  }
163  }
164 
172  public static function getTarget( $target, User $sender ) {
173  if ( $target == '' ) {
174  wfDebug( "Target is empty.\n" );
175 
176  return 'notarget';
177  }
178 
179  $nu = User::newFromName( $target );
180  $error = self::validateTarget( $nu, $sender );
181 
182  return $error ?: $nu;
183  }
184 
193  public static function validateTarget( $target, User $sender ) {
194  if ( !$target instanceof User || !$target->getId() ) {
195  wfDebug( "Target is invalid user.\n" );
196 
197  return 'notarget';
198  }
199 
200  if ( !$target->isEmailConfirmed() ) {
201  wfDebug( "User has no valid email.\n" );
202 
203  return 'noemail';
204  }
205 
206  if ( !$target->canReceiveEmail() ) {
207  wfDebug( "User does not allow user emails.\n" );
208 
209  return 'nowikiemail';
210  }
211 
212  if ( !$target->getOption( 'email-allow-new-users' ) && $sender->isNewbie() ) {
213  wfDebug( "User does not allow user emails from new users.\n" );
214 
215  return 'nowikiemail';
216  }
217 
218  $blacklist = $target->getOption( 'email-blacklist', '' );
219  if ( $blacklist ) {
220  $blacklist = MultiUsernameFilter::splitIds( $blacklist );
221  $lookup = CentralIdLookup::factory();
222  $senderId = $lookup->centralIdFromLocalUser( $sender );
223  if ( $senderId !== 0 && in_array( $senderId, $blacklist ) ) {
224  wfDebug( "User does not allow user emails from this user.\n" );
225 
226  return 'nowikiemail';
227  }
228  }
229 
230  return '';
231  }
232 
242  public static function getPermissionsError( $user, $editToken, Config $config = null ) {
243  if ( $config === null ) {
244  wfDebug( __METHOD__ . ' called without a Config instance passed to it' );
245  $config = MediaWikiServices::getInstance()->getMainConfig();
246  }
247  if ( !$config->get( 'EnableEmail' ) || !$config->get( 'EnableUserEmail' ) ) {
248  return 'usermaildisabled';
249  }
250 
251  // Run this before $user->isAllowed, to show appropriate message to anons (T160309)
252  if ( !$user->isEmailConfirmed() ) {
253  return 'mailnologin';
254  }
255 
256  if ( !$user->isAllowed( 'sendemail' ) ) {
257  return 'badaccess';
258  }
259 
260  if ( $user->isBlockedFromEmailuser() ) {
261  wfDebug( "User is blocked from sending e-mail.\n" );
262 
263  return "blockedemailuser";
264  }
265 
266  // Check the ping limiter without incrementing it - we'll check it
267  // again later and increment it on a successful send
268  if ( $user->pingLimiter( 'emailuser', 0 ) ) {
269  wfDebug( "Ping limiter triggered.\n" );
270 
271  return 'actionthrottledtext';
272  }
273 
274  $hookErr = false;
275 
276  Hooks::run( 'UserCanSendEmail', [ &$user, &$hookErr ] );
277  Hooks::run( 'EmailUserPermissionsErrors', [ $user, $editToken, &$hookErr ] );
278 
279  if ( $hookErr ) {
280  return $hookErr;
281  }
282 
283  return null;
284  }
285 
291  protected function userForm( $name ) {
292  $htmlForm = HTMLForm::factory( 'ooui', [
293  'Target' => [
294  'type' => 'user',
295  'exists' => true,
296  'label' => $this->msg( 'emailusername' )->text(),
297  'id' => 'emailusertarget',
298  'autofocus' => true,
299  'value' => $name,
300  ]
301  ], $this->getContext() );
302 
303  $htmlForm
304  ->setMethod( 'post' )
305  ->setSubmitCallback( [ $this, 'sendEmailForm' ] )
306  ->setFormIdentifier( 'userForm' )
307  ->setId( 'askusername' )
308  ->setWrapperLegendMsg( 'emailtarget' )
309  ->setSubmitTextMsg( 'emailusernamesubmit' )
310  ->show();
311  }
312 
313  public function sendEmailForm() {
314  $out = $this->getOutput();
315 
317  if ( !$ret instanceof User ) {
318  if ( $this->mTarget != '' ) {
319  // Messages used here: notargettext, noemailtext, nowikiemailtext
320  $ret = ( $ret == 'notarget' ) ? 'emailnotarget' : ( $ret . 'text' );
321  return Status::newFatal( $ret );
322  }
323  return false;
324  }
325 
326  $htmlForm = HTMLForm::factory( 'ooui', $this->getFormFields(), $this->getContext() );
327  // By now we are supposed to be sure that $this->mTarget is a user name
328  $htmlForm
329  ->addPreText( $this->msg( 'emailpagetext', $this->mTarget )->parse() )
330  ->setSubmitTextMsg( 'emailsend' )
331  ->setSubmitCallback( [ __CLASS__, 'submit' ] )
332  ->setFormIdentifier( 'sendEmailForm' )
333  ->setWrapperLegendMsg( 'email-legend' )
334  ->loadData();
335 
336  if ( !Hooks::run( 'EmailUserForm', [ &$htmlForm ] ) ) {
337  return false;
338  }
339 
340  $result = $htmlForm->show();
341 
342  if ( $result === true || ( $result instanceof Status && $result->isGood() ) ) {
343  $out->setPageTitle( $this->msg( 'emailsent' ) );
344  $out->addWikiMsg( 'emailsenttext', $this->mTarget );
345  $out->returnToMain( false, $ret->getUserPage() );
346  }
347  return true;
348  }
349 
359  public static function submit( array $data, IContextSource $context ) {
360  $config = $context->getConfig();
361 
362  $target = self::getTarget( $data['Target'], $context->getUser() );
363  if ( !$target instanceof User ) {
364  // Messages used here: notargettext, noemailtext, nowikiemailtext
365  return Status::newFatal( $target . 'text' );
366  }
367 
368  $to = MailAddress::newFromUser( $target );
369  $from = MailAddress::newFromUser( $context->getUser() );
370  $subject = $data['Subject'];
371  $text = $data['Text'];
372 
373  // Add a standard footer and trim up trailing newlines
374  $text = rtrim( $text ) . "\n\n-- \n";
375  $text .= $context->msg( 'emailuserfooter',
376  $from->name, $to->name )->inContentLanguage()->text();
377 
378  if ( $config->get( 'EnableSpecialMute' ) ) {
379  $specialMutePage = SpecialPage::getTitleFor( 'Mute', $context->getUser()->getName() );
380  $text .= "\n" . $context->msg(
381  'specialmute-email-footer',
382  $specialMutePage->getCanonicalURL(),
383  $context->getUser()->getName()
384  )->inContentLanguage()->text();
385  }
386 
387  // Check and increment the rate limits
388  if ( $context->getUser()->pingLimiter( 'emailuser' ) ) {
389  throw new ThrottledError();
390  }
391 
392  $error = false;
393  if ( !Hooks::run( 'EmailUser', [ &$to, &$from, &$subject, &$text, &$error ] ) ) {
394  if ( $error instanceof Status ) {
395  return $error;
396  } elseif ( $error === false || $error === '' || $error === [] ) {
397  // Possibly to tell HTMLForm to pretend there was no submission?
398  return false;
399  } elseif ( $error === true ) {
400  // Hook sent the mail itself and indicates success?
401  return Status::newGood();
402  } elseif ( is_array( $error ) ) {
404  foreach ( $error as $e ) {
405  $status->fatal( $e );
406  }
407  return $status;
408  } elseif ( $error instanceof MessageSpecifier ) {
409  return Status::newFatal( $error );
410  } else {
411  // Ugh. Either a raw HTML string, or something that's supposed
412  // to be treated like one.
413  $type = is_object( $error ) ? get_class( $error ) : gettype( $error );
414  wfDeprecated( "EmailUser hook returning a $type as \$error", '1.29' );
415  return Status::newFatal( new ApiRawMessage(
416  [ '$1', Message::rawParam( (string)$error ) ], 'hookaborted'
417  ) );
418  }
419  }
420 
421  if ( $config->get( 'UserEmailUseReplyTo' ) ) {
430  $mailFrom = new MailAddress( $config->get( 'PasswordSender' ),
431  $context->msg( 'emailsender' )->inContentLanguage()->text() );
432  $replyTo = $from;
433  } else {
449  $mailFrom = $from;
450  $replyTo = null;
451  }
452 
453  $status = UserMailer::send( $to, $mailFrom, $subject, $text, [
454  'replyTo' => $replyTo,
455  ] );
456 
457  if ( !$status->isGood() ) {
458  return $status;
459  } else {
460  // if the user requested a copy of this mail, do this now,
461  // unless they are emailing themselves, in which case one
462  // copy of the message is sufficient.
463  if ( $data['CCMe'] && $to != $from ) {
464  $ccTo = $from;
465  $ccFrom = $from;
466  $ccSubject = $context->msg( 'emailccsubject' )->plaintextParams(
467  $target->getName(), $subject )->text();
468  $ccText = $text;
469 
470  Hooks::run( 'EmailUserCC', [ &$ccTo, &$ccFrom, &$ccSubject, &$ccText ] );
471 
472  if ( $config->get( 'UserEmailUseReplyTo' ) ) {
473  $mailFrom = new MailAddress(
474  $config->get( 'PasswordSender' ),
475  $context->msg( 'emailsender' )->inContentLanguage()->text()
476  );
477  $replyTo = $ccFrom;
478  } else {
479  $mailFrom = $ccFrom;
480  $replyTo = null;
481  }
482 
483  $ccStatus = UserMailer::send(
484  $ccTo, $mailFrom, $ccSubject, $ccText, [
485  'replyTo' => $replyTo,
486  ] );
487  $status->merge( $ccStatus );
488  }
489 
490  Hooks::run( 'EmailUserComplete', [ $to, $from, $subject, $text ] );
491 
492  return $status;
493  }
494  }
495 
504  public function prefixSearchSubpages( $search, $limit, $offset ) {
505  $user = User::newFromName( $search );
506  if ( !$user ) {
507  // No prefix suggestion for invalid user
508  return [];
509  }
510  // Autocomplete subpage as user list - public to allow caching
511  return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
512  }
513 
514  protected function getGroupName() {
515  return 'users';
516  }
517 
523  private function getBlockedEmailError() {
524  $block = $this->getUser()->mBlock;
525  $params = $block->getBlockErrorParams( $this->getContext() );
526 
527  $msg = $block->isSitewide() ? 'blockedtext' : 'blocked-email-user';
528  return new ErrorPageError( 'blockedtitle', $msg, $params );
529  }
530 }
static rawParam( $raw)
Definition: Message.php:1040
static getTarget( $target, User $sender)
Validate target User.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
isNewbie()
Determine whether the user is a newbie.
Definition: User.php:4350
Shortcut to construct a special page which is unlisted by default.
getContext()
Gets the context this SpecialPage is executed in.
A special page that allows users to send e-mails to other users.
static send( $to, $from, $subject, $body, $options=[])
This function will perform a direct (authenticated) login to a SMTP Server to use for mail relaying i...
Definition: UserMailer.php:115
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 noclasses & $ret
Definition: hooks.txt:1963
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2140
An IContextSource implementation which will inherit context from another source but allow individual ...
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 MediaWikiServices
Definition: injection.txt:23
static getPermissionsError( $user, $editToken, Config $config=null)
Check whether a user is allowed to send email.
getOutput()
Get the OutputPage being used for this instance.
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:299
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
static search( $audience, $search, $limit, $offset=0)
Do a prefix search of user names and return a list of matching user names.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1961
static submit(array $data, IContextSource $context)
Really send a mail.
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:767
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
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. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header '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 '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). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. '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:1244
getConfig()
Get the site configuration.
setContext( $context)
Sets the context this SpecialPage is executed in.
Interface for configuration instances.
Definition: Config.php:28
An error page which can definitely be safely rendered using the OutputPage.
Stores a single person&#39;s name and email address.
Definition: MailAddress.php:32
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
$params
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
static newFromUser(User $user)
Create a new MailAddress object for the given user.
Definition: MailAddress.php:66
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:83
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
msg( $key)
This is the method for getting translated interface messages.
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
static factory( $providerId=null)
Fetch a CentralIdLookup.
getName()
Get the name of this Special Page.
getId()
Get the user&#39;s ID.
Definition: User.php:2224
userForm( $name)
Form to ask for target user name.
getBlockedEmailError()
Builds an error message based on the block params.
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
getUser()
Shortcut to get the User executing this instance.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
getConfig()
Shortcut to get main config object.
Show an error when a user tries to do something they do not have the necessary permissions for...
msg( $key)
Wrapper around wfMessage that sets the current 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:2614
Extension of RawMessage implementing IApiMessage.
static validateTarget( $target, User $sender)
Validate target User.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
getRequest()
Get the WebRequest being used for this instance.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:535
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 $request
Definition: hooks.txt:2614
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getPageTitle( $subpage=false)
Get a self-referential title object.
Show an error when the user hits a rate limit.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:67