MediaWiki  REL1_31
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, $this->getUser() );
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, $this->getUser() );
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 
193  public static function getTarget( $target, User $sender = null ) {
194  if ( $sender === null ) {
195  wfDeprecated( __METHOD__ . ' without specifying the sending user', '1.30' );
196  }
197 
198  if ( $target == '' ) {
199  wfDebug( "Target is empty.\n" );
200 
201  return 'notarget';
202  }
203 
204  $nu = User::newFromName( $target );
205  $error = self::validateTarget( $nu, $sender );
206 
207  return $error ? $error : $nu;
208  }
209 
218  public static function validateTarget( $target, User $sender = null ) {
219  if ( $sender === null ) {
220  wfDeprecated( __METHOD__ . ' without specifying the sending user', '1.30' );
221  }
222 
223  if ( !$target instanceof User || !$target->getId() ) {
224  wfDebug( "Target is invalid user.\n" );
225 
226  return 'notarget';
227  }
228 
229  if ( !$target->isEmailConfirmed() ) {
230  wfDebug( "User has no valid email.\n" );
231 
232  return 'noemail';
233  }
234 
235  if ( !$target->canReceiveEmail() ) {
236  wfDebug( "User does not allow user emails.\n" );
237 
238  return 'nowikiemail';
239  }
240 
241  if ( $sender !== null && !$target->getOption( 'email-allow-new-users' ) &&
242  $sender->isNewbie()
243  ) {
244  wfDebug( "User does not allow user emails from new users.\n" );
245 
246  return 'nowikiemail';
247  }
248 
249  if ( $sender !== null ) {
250  $blacklist = $target->getOption( 'email-blacklist', [] );
251  if ( $blacklist ) {
252  $lookup = CentralIdLookup::factory();
253  $senderId = $lookup->centralIdFromLocalUser( $sender );
254  if ( $senderId !== 0 && in_array( $senderId, $blacklist ) ) {
255  wfDebug( "User does not allow user emails from this user.\n" );
256 
257  return 'nowikiemail';
258  }
259  }
260  }
261 
262  return '';
263  }
264 
273  public static function getPermissionsError( $user, $editToken, Config $config = null ) {
274  if ( $config === null ) {
275  wfDebug( __METHOD__ . ' called without a Config instance passed to it' );
276  $config = MediaWikiServices::getInstance()->getMainConfig();
277  }
278  if ( !$config->get( 'EnableEmail' ) || !$config->get( 'EnableUserEmail' ) ) {
279  return 'usermaildisabled';
280  }
281 
282  // Run this before $user->isAllowed, to show appropriate message to anons (T160309)
283  if ( !$user->isEmailConfirmed() ) {
284  return 'mailnologin';
285  }
286 
287  if ( !$user->isAllowed( 'sendemail' ) ) {
288  return 'badaccess';
289  }
290 
291  if ( $user->isBlockedFromEmailuser() ) {
292  wfDebug( "User is blocked from sending e-mail.\n" );
293 
294  return "blockedemailuser";
295  }
296 
297  // Check the ping limiter without incrementing it - we'll check it
298  // again later and increment it on a successful send
299  if ( $user->pingLimiter( 'emailuser', 0 ) ) {
300  wfDebug( "Ping limiter triggered.\n" );
301 
302  return 'actionthrottledtext';
303  }
304 
305  $hookErr = false;
306 
307  Hooks::run( 'UserCanSendEmail', [ &$user, &$hookErr ] );
308  Hooks::run( 'EmailUserPermissionsErrors', [ $user, $editToken, &$hookErr ] );
309 
310  if ( $hookErr ) {
311  return $hookErr;
312  }
313 
314  return null;
315  }
316 
323  protected function userForm( $name ) {
324  $this->getOutput()->addModules( 'mediawiki.userSuggest' );
325  $string = Html::openElement(
326  'form',
327  [ 'method' => 'get', 'action' => wfScript(), 'id' => 'askusername' ]
328  ) .
329  Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
330  Html::openElement( 'fieldset' ) .
331  Html::rawElement( 'legend', null, $this->msg( 'emailtarget' )->parse() ) .
332  Html::label(
333  $this->msg( 'emailusername' )->text(),
334  'emailusertarget'
335  ) . '&#160;' .
336  Html::input(
337  'target',
338  $name,
339  'text',
340  [
341  'id' => 'emailusertarget',
342  'class' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
343  'autofocus' => true,
344  'size' => 30,
345  ]
346  ) .
347  ' ' .
348  Html::submitButton( $this->msg( 'emailusernamesubmit' )->text(), [] ) .
349  Html::closeElement( 'fieldset' ) .
350  Html::closeElement( 'form' ) . "\n";
351 
352  return $string;
353  }
354 
363  public static function uiSubmit( array $data, HTMLForm $form ) {
364  return self::submit( $data, $form->getContext() );
365  }
366 
376  public static function submit( array $data, IContextSource $context ) {
377  $config = $context->getConfig();
378 
379  $target = self::getTarget( $data['Target'], $context->getUser() );
380  if ( !$target instanceof User ) {
381  // Messages used here: notargettext, noemailtext, nowikiemailtext
382  return Status::newFatal( $target . 'text' );
383  }
384 
385  $to = MailAddress::newFromUser( $target );
386  $from = MailAddress::newFromUser( $context->getUser() );
387  $subject = $data['Subject'];
388  $text = $data['Text'];
389 
390  // Add a standard footer and trim up trailing newlines
391  $text = rtrim( $text ) . "\n\n-- \n";
392  $text .= $context->msg( 'emailuserfooter',
393  $from->name, $to->name )->inContentLanguage()->text();
394 
395  // Check and increment the rate limits
396  if ( $context->getUser()->pingLimiter( 'emailuser' ) ) {
397  throw new ThrottledError();
398  }
399 
400  $error = false;
401  if ( !Hooks::run( 'EmailUser', [ &$to, &$from, &$subject, &$text, &$error ] ) ) {
402  if ( $error instanceof Status ) {
403  return $error;
404  } elseif ( $error === false || $error === '' || $error === [] ) {
405  // Possibly to tell HTMLForm to pretend there was no submission?
406  return false;
407  } elseif ( $error === true ) {
408  // Hook sent the mail itself and indicates success?
409  return Status::newGood();
410  } elseif ( is_array( $error ) ) {
412  foreach ( $error as $e ) {
413  $status->fatal( $e );
414  }
415  return $status;
416  } elseif ( $error instanceof MessageSpecifier ) {
417  return Status::newFatal( $error );
418  } else {
419  // Ugh. Either a raw HTML string, or something that's supposed
420  // to be treated like one.
421  $type = is_object( $error ) ? get_class( $error ) : gettype( $error );
422  wfDeprecated( "EmailUser hook returning a $type as \$error", '1.29' );
423  return Status::newFatal( new ApiRawMessage(
424  [ '$1', Message::rawParam( (string)$error ) ], 'hookaborted'
425  ) );
426  }
427  }
428 
429  if ( $config->get( 'UserEmailUseReplyTo' ) ) {
438  $mailFrom = new MailAddress( $config->get( 'PasswordSender' ),
439  wfMessage( 'emailsender' )->inContentLanguage()->text() );
440  $replyTo = $from;
441  } else {
457  $mailFrom = $from;
458  $replyTo = null;
459  }
460 
461  $status = UserMailer::send( $to, $mailFrom, $subject, $text, [
462  'replyTo' => $replyTo,
463  ] );
464 
465  if ( !$status->isGood() ) {
466  return $status;
467  } else {
468  // if the user requested a copy of this mail, do this now,
469  // unless they are emailing themselves, in which case one
470  // copy of the message is sufficient.
471  if ( $data['CCMe'] && $to != $from ) {
472  $ccTo = $from;
473  $ccFrom = $from;
474  $ccSubject = $context->msg( 'emailccsubject' )->rawParams(
475  $target->getName(), $subject )->text();
476  $ccText = $text;
477 
478  Hooks::run( 'EmailUserCC', [ &$ccTo, &$ccFrom, &$ccSubject, &$ccText ] );
479 
480  if ( $config->get( 'UserEmailUseReplyTo' ) ) {
481  $mailFrom = new MailAddress(
482  $config->get( 'PasswordSender' ),
483  wfMessage( 'emailsender' )->inContentLanguage()->text()
484  );
485  $replyTo = $ccFrom;
486  } else {
487  $mailFrom = $ccFrom;
488  $replyTo = null;
489  }
490 
491  $ccStatus = UserMailer::send(
492  $ccTo, $mailFrom, $ccSubject, $ccText, [
493  'replyTo' => $replyTo,
494  ] );
495  $status->merge( $ccStatus );
496  }
497 
498  Hooks::run( 'EmailUserComplete', [ $to, $from, $subject, $text ] );
499 
500  return $status;
501  }
502  }
503 
512  public function prefixSearchSubpages( $search, $limit, $offset ) {
513  $user = User::newFromName( $search );
514  if ( !$user ) {
515  // No prefix suggestion for invalid user
516  return [];
517  }
518  // Autocomplete subpage as user list - public to allow caching
519  return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
520  }
521 
522  protected function getGroupName() {
523  return 'users';
524  }
525 }
$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:247
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:675
SpecialEmailUser\__construct
__construct()
Definition: SpecialEmailuser.php:38
ContextSource\getContext
getContext()
Get the base IContextSource object.
Definition: ContextSource.php:40
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:793
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
User\getId
getId()
Get the user's ID.
Definition: User.php:2457
UserBlockedError
Show an error when the user tries to do something whilst blocked.
Definition: UserBlockedError.php:27
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:722
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
array
the array() calling protocol came about after MediaWiki 1.4rc1.
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:323
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:18
SpecialEmailUser\uiSubmit
static uiSubmit(array $data, HTMLForm $form)
Submit callback for an HTMLForm object, will simply call submit().
Definition: SpecialEmailuser.php:363
$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:2005
MessageSpecifier
Definition: MessageSpecifier.php:21
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
$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:864
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
$params
$params
Definition: styleTest.css.php:40
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
SpecialPage\getSkin
getSkin()
Shortcut to get the skin being used for this instance.
Definition: SpecialPage.php:742
PermissionsError
Show an error when a user tries to do something they do not have the necessary permissions for.
Definition: PermissionsError.php:28
$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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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. '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:1993
SpecialPage\getName
getName()
Get the name of this Special Page.
Definition: SpecialPage.php:150
MailAddress\newFromUser
static newFromUser(User $user)
Create a new MailAddress object for the given user.
Definition: MailAddress.php:74
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:37
SpecialEmailUser\execute
execute( $par)
Default execute method Checks user permissions.
Definition: SpecialEmailuser.php:106
ApiRawMessage
Extension of RawMessage implementing IApiMessage.
Definition: ApiMessage.php:275
Html\input
static input( $name, $value='', $type='text', array $attribs=[])
Convenience function to produce an "<input>" element.
Definition: Html.php:645
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
Config
Interface for configuration instances.
Definition: Config.php:28
StatusValue\isGood
isGood()
Returns whether the operation completed and didn't have any error or warnings.
Definition: StatusValue.php:121
DerivativeContext
An IContextSource implementation which will inherit context from another source but allow individual ...
Definition: DerivativeContext.php:30
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:761
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1123
wfScript
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:2890
SpecialEmailUser\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialEmailuser.php:42
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:527
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:732
Html\label
static label( $label, $id, array $attribs=[])
Convenience function for generating a label for inputs.
Definition: Html.php:758
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:994
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:695
Html\hidden
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:774
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
Message\rawParam
static rawParam( $raw)
Definition: Message.php:1017
SpecialEmailUser\validateTarget
static validateTarget( $target, User $sender=null)
Validate target User.
Definition: SpecialEmailuser.php:218
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:712
SpecialEmailUser\$mTargetObj
$mTargetObj
Definition: SpecialEmailuser.php:36
$status
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). '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:1255
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:522
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
SpecialEmailUser\getPermissionsError
static getPermissionsError( $user, $editToken, Config $config=null)
Check whether a user is allowed to send email.
Definition: SpecialEmailuser.php:273
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:907
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
SpecialEmailUser\$mTarget
$mTarget
Definition: SpecialEmailuser.php:31
SpecialEmailUser\submit
static submit(array $data, IContextSource $context)
Really send a mail.
Definition: SpecialEmailuser.php:376
SpecialEmailUser\getTarget
static getTarget( $target, User $sender=null)
Validate target User.
Definition: SpecialEmailuser.php:193
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:22
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
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:25
ErrorPageError
An error page which can definitely be safely rendered using the OutputPage.
Definition: ErrorPageError.php:27
CentralIdLookup\factory
static factory( $providerId=null)
Fetch a CentralIdLookup.
Definition: CentralIdLookup.php:46
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
$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:2811
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:629
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
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:130
$type
$type
Definition: testCompression.php:48
SpecialEmailUser\prefixSearchSubpages
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
Definition: SpecialEmailuser.php:512