39 parent::__construct(
'Emailuser' );
48 if ( !$target instanceof
User ) {
49 return $this->
msg(
'emailuser-title-notarget' )->text();
52 return $this->
msg(
'emailuser-title-target', $target->getName() )->text();
62 $this->
getUser()->getUserPage(),
65 'label-message' =>
'emailfrom',
66 'id' =>
'mw-emailuser-sender',
72 $this->mTargetObj->getUserPage(),
73 $this->mTargetObj->getName()
75 'label-message' =>
'emailto',
76 'id' =>
'mw-emailuser-recipient',
80 'default' => $this->mTargetObj->getName(),
84 'default' => $this->
msg(
'defemailsubject',
86 'label-message' =>
'emailsubject',
95 'label-message' =>
'emailmessage',
100 'label-message' =>
'emailccme',
101 'default' => $this->
getUser()->getBoolOption(
'ccmeonemails' ),
108 $out->addModuleStyles(
'mediawiki.special' );
110 $this->mTarget = is_null( $par )
132 case 'blockedemailuser':
134 case 'actionthrottledtext':
137 case 'usermaildisabled':
147 if ( $this->mTarget !=
'' ) {
149 $ret = (
$ret ==
'notarget' ) ?
'emailnotarget' : (
$ret .
'text' );
150 $out->wrapWikiMsg(
"<p class='error'>$1</p>",
$ret );
157 $this->mTargetObj =
$ret;
161 $this->
getSkin()->setRelevantUser( $this->mTargetObj );
167 $form->addPreText( $this->
msg(
'emailpagetext', $this->mTarget )->parse() );
168 $form->setSubmitTextMsg(
'emailsend' );
169 $form->setSubmitCallback( [ __CLASS__,
'uiSubmit' ] );
170 $form->setWrapperLegendMsg(
'email-legend' );
173 if ( !Hooks::run(
'EmailUserForm', [ &$form ] ) ) {
177 $result = $form->show();
179 if ( $result ===
true || ( $result instanceof
Status && $result->
isGood() ) ) {
180 $out->setPageTitle( $this->
msg(
'emailsent' ) );
181 $out->addWikiMsg(
'emailsenttext', $this->mTarget );
182 $out->returnToMain(
false, $this->mTargetObj->getUserPage() );
194 if ( $sender ===
null ) {
195 wfDeprecated( __METHOD__ .
' without specifying the sending user',
'1.30' );
198 if ( $target ==
'' ) {
199 wfDebug(
"Target is empty.\n" );
204 $nu = User::newFromName( $target );
207 return $error ? $error : $nu;
219 if ( $sender ===
null ) {
220 wfDeprecated( __METHOD__ .
' without specifying the sending user',
'1.30' );
223 if ( !$target instanceof
User || !$target->
getId() ) {
224 wfDebug(
"Target is invalid user.\n" );
227 } elseif ( !$target->isEmailConfirmed() ) {
228 wfDebug(
"User has no valid email.\n" );
231 } elseif ( !$target->canReceiveEmail() ) {
232 wfDebug(
"User does not allow user emails.\n" );
234 return 'nowikiemail';
235 } elseif ( $sender !==
null ) {
236 $blacklist = $target->getOption(
'email-blacklist', [] );
239 $senderId = $lookup->centralIdFromLocalUser( $sender );
240 if ( $senderId !== 0 && in_array( $senderId, $blacklist ) ) {
241 wfDebug(
"User does not allow user emails from this user.\n" );
243 return 'nowikiemail';
260 if ( $config ===
null ) {
261 wfDebug( __METHOD__ .
' called without a Config instance passed to it' );
262 $config = MediaWikiServices::getInstance()->getMainConfig();
264 if ( !$config->get(
'EnableEmail' ) || !$config->get(
'EnableUserEmail' ) ) {
265 return 'usermaildisabled';
269 if ( !$user->isEmailConfirmed() ) {
270 return 'mailnologin';
273 if ( !$user->isAllowed(
'sendemail' ) ) {
277 if ( $user->isBlockedFromEmailuser() ) {
278 wfDebug(
"User is blocked from sending e-mail.\n" );
280 return "blockedemailuser";
283 if ( $user->pingLimiter(
'emailuser' ) ) {
284 wfDebug(
"Ping limiter triggered.\n" );
286 return 'actionthrottledtext';
291 Hooks::run(
'UserCanSendEmail', [ &$user, &$hookErr ] );
292 Hooks::run(
'EmailUserPermissionsErrors', [ $user, $editToken, &$hookErr ] );
308 $this->
getOutput()->addModules(
'mediawiki.userSuggest' );
309 $string = Html::openElement(
311 [
'method' =>
'get',
'action' =>
wfScript(),
'id' =>
'askusername' ]
313 Html::hidden(
'title', $this->
getPageTitle()->getPrefixedText() ) .
314 Html::openElement(
'fieldset' ) .
315 Html::rawElement(
'legend',
null, $this->
msg(
'emailtarget' )->parse() ) .
317 $this->
msg(
'emailusername' )->
text(),
325 'id' =>
'emailusertarget',
326 'class' =>
'mw-autocomplete-user',
332 Html::submitButton( $this->
msg(
'emailusernamesubmit' )->
text(), [] ) .
333 Html::closeElement(
'fieldset' ) .
334 Html::closeElement(
'form' ) .
"\n";
364 if ( !$target instanceof
User ) {
366 return Status::newFatal( $target .
'text' );
371 $subject = $data[
'Subject'];
372 $text = $data[
'Text'];
375 $text = rtrim( $text ) .
"\n\n-- \n";
376 $text .=
$context->msg(
'emailuserfooter',
377 $from->name, $to->name )->inContentLanguage()->text();
380 if ( !Hooks::run(
'EmailUser', [ &$to, &$from, &$subject, &$text, &$error ] ) ) {
381 if ( $error instanceof
Status ) {
383 } elseif ( $error ===
false || $error ===
'' || $error === [] ) {
386 } elseif ( $error ===
true ) {
388 return Status::newGood();
389 } elseif ( is_array( $error ) ) {
391 foreach ( $error as
$e ) {
396 return Status::newFatal( $error );
400 $type = is_object( $error ) ? get_class( $error ) : gettype( $error );
401 wfDeprecated(
"EmailUser hook returning a $type as \$error",
'1.29' );
403 [
'$1', Message::rawParam( (
string)$error ) ],
'hookaborted'
408 if ( $config->get(
'UserEmailUseReplyTo' ) ) {
417 $mailFrom =
new MailAddress( $config->get(
'PasswordSender' ),
441 'replyTo' => $replyTo,
450 if ( $data[
'CCMe'] && $to != $from ) {
453 $ccSubject =
$context->msg(
'emailccsubject' )->rawParams(
454 $target->getName(), $subject )->text();
457 Hooks::run(
'EmailUserCC', [ &$ccTo, &$ccFrom, &$ccSubject, &$ccText ] );
459 if ( $config->get(
'UserEmailUseReplyTo' ) ) {
461 $config->get(
'PasswordSender' ),
471 $ccTo, $mailFrom, $ccSubject, $ccText, [
472 'replyTo' => $replyTo,
477 Hooks::run(
'EmailUserComplete', [ $to, $from, $subject, $text ] );
492 $user = User::newFromName( $search );
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Extension of RawMessage implementing IApiMessage.
static factory( $providerId=null)
Fetch a CentralIdLookup.
An IContextSource implementation which will inherit context from another source but allow individual ...
An error page which can definitely be safely rendered using the OutputPage.
Stores a single person's name and email address.
static newFromUser(User $user)
Create a new MailAddress object for the given user.
Show an error when a user tries to do something they do not have the necessary permissions for.
A special page that allows users to send e-mails to other users.
static getTarget( $target, User $sender=null)
Validate target User.
static uiSubmit(array $data, HTMLForm $form)
Submit callback for an HTMLForm object, will simply call submit().
userForm( $name)
Form to ask for target user name.
static getPermissionsError( $user, $editToken, Config $config=null)
Check whether a user is allowed to send email.
static submit(array $data, IContextSource $context)
Really send a mail.
static validateTarget( $target, User $sender=null)
Validate target User.
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
doesWrites()
Indicates whether this special page may perform database writes.
getDescription()
Returns the name that goes in the <h1> in the special page itself, and also the name that will be l...
execute( $par)
Default execute method Checks user permissions.
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getName()
Get the name of this Special Page.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getOutput()
Get the OutputPage being used for this instance.
getUser()
Shortcut to get the User executing this instance.
getSkin()
Shortcut to get the skin being used for this instance.
getContext()
Gets the context this SpecialPage is executed in.
msg( $key)
Wrapper around wfMessage that sets the current context.
getConfig()
Shortcut to get main config object.
getRequest()
Get the WebRequest being used for this instance.
getPageTitle( $subpage=false)
Get a self-referential title object.
MediaWiki Linker LinkRenderer null $linkRenderer
isGood()
Returns whether the operation completed and didn't have any error or warnings.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Show an error when the user hits a rate limit.
Shortcut to construct a special page which is unlisted by default.
Show an error when the user tries to do something whilst blocked.
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...
static search( $audience, $search, $limit, $offset=0)
Do a prefix search of user names and return a list of matching user names.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
getId()
Get the user's ID.
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
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
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
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 "<div ...>$1</div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
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
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
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
returning false will NOT prevent logging $e
Interface for objects which can provide a MediaWiki context on request.