MediaWiki  1.29.1
SpecialEmailuser.php
Go to the documentation of this file.
1 <?php
24 
31  protected $mTarget;
32 
36  protected $mTargetObj;
37 
38  public function __construct() {
39  parent::__construct( 'Emailuser' );
40  }
41 
42  public function doesWrites() {
43  return true;
44  }
45 
46  public function getDescription() {
47  $target = self::getTarget( $this->mTarget );
48  if ( !$target instanceof User ) {
49  return $this->msg( 'emailuser-title-notarget' )->text();
50  }
51 
52  return $this->msg( 'emailuser-title-target', $target->getName() )->text();
53  }
54 
55  protected function getFormFields() {
56  $linkRenderer = $this->getLinkRenderer();
57  return [
58  'From' => [
59  'type' => 'info',
60  'raw' => 1,
61  'default' => $linkRenderer->makeLink(
62  $this->getUser()->getUserPage(),
63  $this->getUser()->getName()
64  ),
65  'label-message' => 'emailfrom',
66  'id' => 'mw-emailuser-sender',
67  ],
68  'To' => [
69  'type' => 'info',
70  'raw' => 1,
71  'default' => $linkRenderer->makeLink(
72  $this->mTargetObj->getUserPage(),
73  $this->mTargetObj->getName()
74  ),
75  'label-message' => 'emailto',
76  'id' => 'mw-emailuser-recipient',
77  ],
78  'Target' => [
79  'type' => 'hidden',
80  'default' => $this->mTargetObj->getName(),
81  ],
82  'Subject' => [
83  'type' => 'text',
84  'default' => $this->msg( 'defemailsubject',
85  $this->getUser()->getName() )->inContentLanguage()->text(),
86  'label-message' => 'emailsubject',
87  'maxlength' => 200,
88  'size' => 60,
89  'required' => true,
90  ],
91  'Text' => [
92  'type' => 'textarea',
93  'rows' => 20,
94  'cols' => 80,
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  $out->addModuleStyles( 'mediawiki.special' );
109 
110  $this->mTarget = is_null( $par )
111  ? $this->getRequest()->getVal( 'wpTarget', $this->getRequest()->getVal( 'target', '' ) )
112  : $par;
113 
114  // This needs to be below assignment of $this->mTarget because
115  // getDescription() needs it to determine the correct page title.
116  $this->setHeaders();
117  $this->outputHeader();
118 
119  // error out if sending user cannot do this
120  $error = self::getPermissionsError(
121  $this->getUser(),
122  $this->getRequest()->getVal( 'wpEditToken' ),
123  $this->getConfig()
124  );
125 
126  switch ( $error ) {
127  case null:
128  # Wahey!
129  break;
130  case 'badaccess':
131  throw new PermissionsError( 'sendemail' );
132  case 'blockedemailuser':
133  throw new UserBlockedError( $this->getUser()->mBlock );
134  case 'actionthrottledtext':
135  throw new ThrottledError;
136  case 'mailnologin':
137  case 'usermaildisabled':
138  throw new ErrorPageError( $error, "{$error}text" );
139  default:
140  # It's a hook error
141  list( $title, $msg, $params ) = $error;
142  throw new ErrorPageError( $title, $msg, $params );
143  }
144  // Got a valid target user name? Else ask for one.
145  $ret = self::getTarget( $this->mTarget );
146  if ( !$ret instanceof User ) {
147  if ( $this->mTarget != '' ) {
148  // Messages used here: notargettext, noemailtext, nowikiemailtext
149  $ret = ( $ret == 'notarget' ) ? 'emailnotarget' : ( $ret . 'text' );
150  $out->wrapWikiMsg( "<p class='error'>$1</p>", $ret );
151  }
152  $out->addHTML( $this->userForm( $this->mTarget ) );
153 
154  return;
155  }
156 
157  $this->mTargetObj = $ret;
158 
159  // Set the 'relevant user' in the skin, so it displays links like Contributions,
160  // User logs, UserRights, etc.
161  $this->getSkin()->setRelevantUser( $this->mTargetObj );
162 
163  $context = new DerivativeContext( $this->getContext() );
164  $context->setTitle( $this->getPageTitle() ); // Remove subpage
165  $form = new HTMLForm( $this->getFormFields(), $context );
166  // By now we are supposed to be sure that $this->mTarget is a user name
167  $form->addPreText( $this->msg( 'emailpagetext', $this->mTarget )->parse() );
168  $form->setSubmitTextMsg( 'emailsend' );
169  $form->setSubmitCallback( [ __CLASS__, 'uiSubmit' ] );
170  $form->setWrapperLegendMsg( 'email-legend' );
171  $form->loadData();
172 
173  if ( !Hooks::run( 'EmailUserForm', [ &$form ] ) ) {
174  return;
175  }
176 
177  $result = $form->show();
178 
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() );
183  }
184  }
185 
192  public static function getTarget( $target ) {
193  if ( $target == '' ) {
194  wfDebug( "Target is empty.\n" );
195 
196  return 'notarget';
197  }
198 
199  $nu = User::newFromName( $target );
200  if ( !$nu instanceof User || !$nu->getId() ) {
201  wfDebug( "Target is invalid user.\n" );
202 
203  return 'notarget';
204  } elseif ( !$nu->isEmailConfirmed() ) {
205  wfDebug( "User has no valid email.\n" );
206 
207  return 'noemail';
208  } elseif ( !$nu->canReceiveEmail() ) {
209  wfDebug( "User does not allow user emails.\n" );
210 
211  return 'nowikiemail';
212  }
213 
214  return $nu;
215  }
216 
225  public static function getPermissionsError( $user, $editToken, Config $config = null ) {
226  if ( $config === null ) {
227  wfDebug( __METHOD__ . ' called without a Config instance passed to it' );
228  $config = MediaWikiServices::getInstance()->getMainConfig();
229  }
230  if ( !$config->get( 'EnableEmail' ) || !$config->get( 'EnableUserEmail' ) ) {
231  return 'usermaildisabled';
232  }
233 
234  // Run this before $user->isAllowed, to show appropriate message to anons (T160309)
235  if ( !$user->isEmailConfirmed() ) {
236  return 'mailnologin';
237  }
238 
239  if ( !$user->isAllowed( 'sendemail' ) ) {
240  return 'badaccess';
241  }
242 
243  if ( $user->isBlockedFromEmailuser() ) {
244  wfDebug( "User is blocked from sending e-mail.\n" );
245 
246  return "blockedemailuser";
247  }
248 
249  if ( $user->pingLimiter( 'emailuser' ) ) {
250  wfDebug( "Ping limiter triggered.\n" );
251 
252  return 'actionthrottledtext';
253  }
254 
255  $hookErr = false;
256 
257  Hooks::run( 'UserCanSendEmail', [ &$user, &$hookErr ] );
258  Hooks::run( 'EmailUserPermissionsErrors', [ $user, $editToken, &$hookErr ] );
259 
260  if ( $hookErr ) {
261  return $hookErr;
262  }
263 
264  return null;
265  }
266 
273  protected function userForm( $name ) {
274  $this->getOutput()->addModules( 'mediawiki.userSuggest' );
275  $string = Html::openElement(
276  'form',
277  [ 'method' => 'get', 'action' => wfScript(), 'id' => 'askusername' ]
278  ) .
279  Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
280  Html::openElement( 'fieldset' ) .
281  Html::rawElement( 'legend', null, $this->msg( 'emailtarget' )->parse() ) .
282  Html::label(
283  $this->msg( 'emailusername' )->text(),
284  'emailusertarget'
285  ) . '&#160;' .
286  Html::input(
287  'target',
288  $name,
289  'text',
290  [
291  'id' => 'emailusertarget',
292  'class' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
293  'autofocus' => true,
294  'size' => 30,
295  ]
296  ) .
297  ' ' .
298  Html::submitButton( $this->msg( 'emailusernamesubmit' )->text(), [] ) .
299  Html::closeElement( 'fieldset' ) .
300  Html::closeElement( 'form' ) . "\n";
301 
302  return $string;
303  }
304 
313  public static function uiSubmit( array $data, HTMLForm $form ) {
314  return self::submit( $data, $form->getContext() );
315  }
316 
326  public static function submit( array $data, IContextSource $context ) {
327  $config = $context->getConfig();
328 
329  $target = self::getTarget( $data['Target'] );
330  if ( !$target instanceof User ) {
331  // Messages used here: notargettext, noemailtext, nowikiemailtext
332  return Status::newFatal( $target . 'text' );
333  }
334 
335  $to = MailAddress::newFromUser( $target );
337  $subject = $data['Subject'];
338  $text = $data['Text'];
339 
340  // Add a standard footer and trim up trailing newlines
341  $text = rtrim( $text ) . "\n\n-- \n";
342  $text .= $context->msg( 'emailuserfooter',
343  $from->name, $to->name )->inContentLanguage()->text();
344 
345  $error = false;
346  if ( !Hooks::run( 'EmailUser', [ &$to, &$from, &$subject, &$text, &$error ] ) ) {
347  if ( $error instanceof Status ) {
348  return $error;
349  } elseif ( $error === false || $error === '' || $error === [] ) {
350  // Possibly to tell HTMLForm to pretend there was no submission?
351  return false;
352  } elseif ( $error === true ) {
353  // Hook sent the mail itself and indicates success?
354  return Status::newGood();
355  } elseif ( is_array( $error ) ) {
357  foreach ( $error as $e ) {
358  $status->fatal( $e );
359  }
360  return $status;
361  } elseif ( $error instanceof MessageSpecifier ) {
362  return Status::newFatal( $error );
363  } else {
364  // Ugh. Either a raw HTML string, or something that's supposed
365  // to be treated like one.
366  $type = is_object( $error ) ? get_class( $error ) : gettype( $error );
367  wfDeprecated( "EmailUser hook returning a $type as \$error", '1.29' );
368  return Status::newFatal( new ApiRawMessage(
369  [ '$1', Message::rawParam( (string)$error ) ], 'hookaborted'
370  ) );
371  }
372  }
373 
374  if ( $config->get( 'UserEmailUseReplyTo' ) ) {
383  $mailFrom = new MailAddress( $config->get( 'PasswordSender' ),
384  wfMessage( 'emailsender' )->inContentLanguage()->text() );
385  $replyTo = $from;
386  } else {
402  $mailFrom = $from;
403  $replyTo = null;
404  }
405 
406  $status = UserMailer::send( $to, $mailFrom, $subject, $text, [
407  'replyTo' => $replyTo,
408  ] );
409 
410  if ( !$status->isGood() ) {
411  return $status;
412  } else {
413  // if the user requested a copy of this mail, do this now,
414  // unless they are emailing themselves, in which case one
415  // copy of the message is sufficient.
416  if ( $data['CCMe'] && $to != $from ) {
417  $ccTo = $from;
418  $ccFrom = $from;
419  $ccSubject = $context->msg( 'emailccsubject' )->rawParams(
420  $target->getName(), $subject )->text();
421  $ccText = $text;
422 
423  Hooks::run( 'EmailUserCC', [ &$ccTo, &$ccFrom, &$ccSubject, &$ccText ] );
424 
425  if ( $config->get( 'UserEmailUseReplyTo' ) ) {
426  $mailFrom = new MailAddress(
427  $config->get( 'PasswordSender' ),
428  wfMessage( 'emailsender' )->inContentLanguage()->text()
429  );
430  $replyTo = $ccFrom;
431  } else {
432  $mailFrom = $ccFrom;
433  $replyTo = null;
434  }
435 
436  $ccStatus = UserMailer::send(
437  $ccTo, $mailFrom, $ccSubject, $ccText, [
438  'replyTo' => $replyTo,
439  ] );
440  $status->merge( $ccStatus );
441  }
442 
443  Hooks::run( 'EmailUserComplete', [ $to, $from, $subject, $text ] );
444 
445  return $status;
446  }
447  }
448 
457  public function prefixSearchSubpages( $search, $limit, $offset ) {
458  $user = User::newFromName( $search );
459  if ( !$user ) {
460  // No prefix suggestion for invalid user
461  return [];
462  }
463  // Autocomplete subpage as user list - public to allow caching
464  return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
465  }
466 
467  protected function getGroupName() {
468  return 'users';
469  }
470 }
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:628
ContextSource\getConfig
getConfig()
Get the Config object.
Definition: ContextSource.php:68
SpecialEmailUser\__construct
__construct()
Definition: SpecialEmailuser.php:38
$context
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
Definition: hooks.txt:2612
ContextSource\getContext
getContext()
Get the base IContextSource object.
Definition: ContextSource.php:41
User\getId
getId()
Get the user's ID.
Definition: User.php:2200
UserBlockedError
Show an error when the user tries to do something whilst blocked.
Definition: UserBlockedError.php:27
ContextSource\msg
msg()
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:187
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:675
UnlistedSpecialPage
Shortcut to construct a special page which is unlisted by default.
Definition: UnlistedSpecialPage.php:29
UserMailer\send
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:114
SpecialEmailUser\userForm
userForm( $name)
Form to ask for target user name.
Definition: SpecialEmailuser.php:273
text
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
Definition: design.txt:12
SpecialEmailUser\uiSubmit
static uiSubmit(array $data, HTMLForm $form)
Submit callback for an HTMLForm object, will simply call submit().
Definition: SpecialEmailuser.php:313
$result
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
Definition: hooks.txt:1954
MessageSpecifier
Definition: MessageSpecifier.php:21
$status
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
Definition: hooks.txt:1049
UserNamePrefixSearch\search
static search( $audience, $search, $limit, $offset=0)
Do a prefix search of user names and return a list of matching user names.
Definition: UserNamePrefixSearch.php:39
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
$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:246
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:63
$params
$params
Definition: styleTest.css.php:40
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:556
SpecialPage\getSkin
getSkin()
Shortcut to get the skin being used for this instance.
Definition: SpecialPage.php:695
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
PermissionsError
Show an error when a user tries to do something they do not have the necessary permissions for.
Definition: PermissionsError.php:28
$type
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
Definition: hooks.txt:2536
SpecialPage\getName
getName()
Get the name of this Special Page.
Definition: SpecialPage.php:150
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:133
MailAddress\newFromUser
static newFromUser(User $user)
Create a new MailAddress object for the given user.
Definition: MailAddress.php:75
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
SpecialEmailUser\execute
execute( $par)
Default execute method Checks user permissions.
Definition: SpecialEmailuser.php:106
ApiRawMessage
Extension of RawMessage implementing IApiMessage.
Definition: ApiMessage.php:268
Html\input
static input( $name, $value='', $type='text', array $attribs=[])
Convenience function to produce an "<input>" element.
Definition: Html.php:663
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
MailAddress
Stores a single person's name and email address.
Definition: MailAddress.php:32
Html\closeElement
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:309
StatusValue\isGood
isGood()
Returns whether the operation completed and didn't have any error or warnings.
Definition: StatusValue.php:116
DerivativeContext
An IContextSource implementation which will inherit context from another source but allow individual ...
Definition: DerivativeContext.php:31
SpecialEmailUser\getTarget
static getTarget( $target)
Validate target User.
Definition: SpecialEmailuser.php:192
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:714
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:934
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1128
wfScript
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:3138
SpecialEmailUser\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialEmailuser.php:42
$limit
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
Definition: hooks.txt:1049
ThrottledError
Show an error when the user hits a rate limit.
Definition: ThrottledError.php:27
SpecialEmailUser
A special page that allows users to send e-mails to other users.
Definition: SpecialEmailuser.php:30
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:484
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:685
Html\label
static label( $label, $id, array $attribs=[])
Convenience function for generating a label for inputs.
Definition: Html.php:730
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:999
list
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
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:648
Html\hidden
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:746
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2122
SpecialPage\msg
msg()
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:746
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:76
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:665
$ret
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:1956
SpecialEmailUser\$mTargetObj
$mTargetObj
Definition: SpecialEmailuser.php:36
Html\submitButton
static submitButton( $contents, array $attrs, array $modifiers=[])
Returns an HTML link element in a string styled as a button (when $wgUseMediaWikiUIEverywhere is enab...
Definition: Html.php:185
SpecialEmailUser\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialEmailuser.php:467
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:55
SpecialEmailUser\getPermissionsError
static getPermissionsError( $user, $editToken, Config $config=null)
Check whether a user is allowed to send email.
Definition: SpecialEmailuser.php:225
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:856
SpecialEmailUser\$mTarget
$mTarget
Definition: SpecialEmailuser.php:31
SpecialEmailUser\submit
static submit(array $data, IContextSource $context)
Really send a mail.
Definition: SpecialEmailuser.php:326
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
Html\openElement
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:251
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
SpecialEmailUser\getFormFields
getFormFields()
Definition: SpecialEmailuser.php:55
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
SpecialPage\$linkRenderer
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
MediaWikiServices
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
ErrorPageError
An error page which can definitely be safely rendered using the OutputPage.
Definition: ErrorPageError.php:27
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:50
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
SpecialPage\outputHeader
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Definition: SpecialPage.php:583
array
the array() calling protocol came about after MediaWiki 1.4rc1.
SpecialEmailUser\getDescription
getDescription()
Returns the name that goes in the <h1> in the special page itself, and also the name that will be l...
Definition: SpecialEmailuser.php:46
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:128
$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:783
SpecialEmailUser\prefixSearchSubpages
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
Definition: SpecialEmailuser.php:457