Go to the documentation of this file.
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 ] ) ) {
180 $out->setPageTitle( $this->
msg(
'emailsent' ) );
181 $out->addWikiMsg(
'emailsenttext', $this->mTarget );
182 $out->returnToMain(
false, $this->mTargetObj->getUserPage() );
193 if ( $target ==
'' ) {
194 wfDebug(
"Target is empty.\n" );
200 if ( !$nu instanceof
User || !$nu->
getId() ) {
201 wfDebug(
"Target is invalid user.\n" );
204 } elseif ( !$nu->isEmailConfirmed() ) {
205 wfDebug(
"User has no valid email.\n" );
208 } elseif ( !$nu->canReceiveEmail() ) {
209 wfDebug(
"User does not allow user emails.\n" );
211 return 'nowikiemail';
226 if ( $config ===
null ) {
227 wfDebug( __METHOD__ .
' called without a Config instance passed to it' );
228 $config = MediaWikiServices::getInstance()->getMainConfig();
230 if ( !$config->get(
'EnableEmail' ) || !$config->get(
'EnableUserEmail' ) ) {
231 return 'usermaildisabled';
235 if ( !
$user->isEmailConfirmed() ) {
236 return 'mailnologin';
239 if ( !
$user->isAllowed(
'sendemail' ) ) {
243 if (
$user->isBlockedFromEmailuser() ) {
244 wfDebug(
"User is blocked from sending e-mail.\n" );
246 return "blockedemailuser";
249 if (
$user->pingLimiter(
'emailuser' ) ) {
250 wfDebug(
"Ping limiter triggered.\n" );
252 return 'actionthrottledtext';
258 Hooks::run(
'EmailUserPermissionsErrors', [
$user, $editToken, &$hookErr ] );
274 $this->
getOutput()->addModules(
'mediawiki.userSuggest' );
277 [
'method' =>
'get',
'action' =>
wfScript(),
'id' =>
'askusername' ]
283 $this->
msg(
'emailusername' )->
text(),
291 'id' =>
'emailusertarget',
292 'class' =>
'mw-autocomplete-user',
330 if ( !$target instanceof
User ) {
337 $subject = $data[
'Subject'];
338 $text = $data[
'Text'];
341 $text = rtrim( $text ) .
"\n\n-- \n";
343 $from->name, $to->name )->inContentLanguage()->text();
346 if ( !
Hooks::run(
'EmailUser', [ &$to, &$from, &$subject, &$text, &$error ] ) ) {
347 if ( $error instanceof
Status ) {
349 } elseif ( $error ===
false || $error ===
'' || $error === [] ) {
352 } elseif ( $error ===
true ) {
355 } elseif ( is_array( $error ) ) {
357 foreach ( $error
as $e ) {
366 $type = is_object( $error ) ? get_class( $error ) : gettype( $error );
367 wfDeprecated(
"EmailUser hook returning a $type as \$error",
'1.29' );
369 [
'$1', Message::rawParam( (
string)$error ) ],
'hookaborted'
374 if ( $config->get(
'UserEmailUseReplyTo' ) ) {
383 $mailFrom =
new MailAddress( $config->get(
'PasswordSender' ),
384 wfMessage(
'emailsender' )->inContentLanguage()->text() );
407 'replyTo' => $replyTo,
416 if ( $data[
'CCMe'] && $to != $from ) {
419 $ccSubject =
$context->
msg(
'emailccsubject' )->rawParams(
420 $target->getName(), $subject )->
text();
423 Hooks::run(
'EmailUserCC', [ &$ccTo, &$ccFrom, &$ccSubject, &$ccText ] );
425 if ( $config->get(
'UserEmailUseReplyTo' ) ) {
427 $config->get(
'PasswordSender' ),
428 wfMessage(
'emailsender' )->inContentLanguage()->text()
437 $ccTo, $mailFrom, $ccSubject, $ccText, [
438 'replyTo' => $replyTo,
443 Hooks::run(
'EmailUserComplete', [ $to, $from, $subject, $text ] );
getPageTitle( $subpage=false)
Get a self-referential title object.
getConfig()
Get the Config object.
error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
getContext()
Get the base IContextSource object.
getId()
Get the user's ID.
Show an error when the user tries to do something whilst blocked.
msg()
Get a Message object with context set Parameters are the same as wfMessage()
getOutput()
Get the OutputPage being used for this instance.
Shortcut to construct a special page which is unlisted by default.
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...
userForm( $name)
Form to ask for target user name.
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
static uiSubmit(array $data, HTMLForm $form)
Submit callback for an HTMLForm object, will simply call submit().
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 '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. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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! 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
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
static search( $audience, $search, $limit, $offset=0)
Do a prefix search of user names and return a list of matching user names.
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
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
static newFatal( $message)
Factory function for fatal errors.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
getSkin()
Shortcut to get the skin being used for this instance.
Allows to change the fields on the form that will be generated $name
Show an error when a user tries to do something they do not have the necessary permissions for.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
getName()
Get the name of this Special Page.
getUser()
Get the User object.
static newFromUser(User $user)
Create a new MailAddress object for the given user.
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
execute( $par)
Default execute method Checks user permissions.
Extension of RawMessage implementing IApiMessage.
static input( $name, $value='', $type='text', array $attribs=[])
Convenience function to produce an "<input>" element.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Stores a single person's name and email address.
static closeElement( $element)
Returns "</$element>".
isGood()
Returns whether the operation completed and didn't have any error or warnings.
An IContextSource implementation which will inherit context from another source but allow individual ...
static getTarget( $target)
Validate target User.
getConfig()
Shortcut to get main config object.
namespace and then decline to actually register it file or subcat img or subcat $title
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
doesWrites()
Indicates whether this special page may perform database writes.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers please use GetContentModels hook to make them known to core if desired 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 inclusive $limit
Show an error when the user hits a rate limit.
A special page that allows users to send e-mails to other users.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getUser()
Shortcut to get the User executing this instance.
static label( $label, $id, array $attribs=[])
Convenience function for generating a label for inputs.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
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
getContext()
Gets the context this SpecialPage is executed in.
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
msg()
Wrapper around wfMessage that sets the current context.
static newGood( $value=null)
Factory function for good results.
getRequest()
Get the WebRequest being used for this instance.
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
static submitButton( $contents, array $attrs, array $modifiers=[])
Returns an HTML link element in a string styled as a button (when $wgUseMediaWikiUIEverywhere is enab...
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Interface for objects which can provide a MediaWiki context on request.
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.
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
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
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 "<
MediaWiki Linker LinkRenderer null $linkRenderer
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
An error page which can definitely be safely rendered using the OutputPage.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
the array() calling protocol came about after MediaWiki 1.4rc1.
getDescription()
Returns the name that goes in the <h1> in the special page itself, and also the name that will be l...
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
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.