MediaWiki  master
SpecialEditWatchlist.php
Go to the documentation of this file.
1 <?php
32 
46  const EDIT_CLEAR = 1;
47  const EDIT_RAW = 2;
48  const EDIT_NORMAL = 3;
49 
50  protected $successMessage;
51 
52  protected $toc;
53 
54  private $badItems = [];
55 
59  private $titleParser;
60 
61  public function __construct() {
62  parent::__construct( 'EditWatchlist', 'editmywatchlist' );
63  }
64 
69  private function initServices() {
70  if ( !$this->titleParser ) {
71  $this->titleParser = MediaWikiServices::getInstance()->getTitleParser();
72  }
73  }
74 
75  public function doesWrites() {
76  return true;
77  }
78 
84  public function execute( $mode ) {
85  $this->initServices();
86  $this->setHeaders();
87 
88  # Anons don't get a watchlist
89  $this->requireLogin( 'watchlistanontext' );
90 
91  $out = $this->getOutput();
92 
93  $this->checkPermissions();
94  $this->checkReadOnly();
95 
96  $this->outputHeader();
97  $this->outputSubtitle();
98  $out->addModuleStyles( 'mediawiki.special' );
99 
100  # B/C: $mode used to be waaay down the parameter list, and the first parameter
101  # was $wgUser
102  if ( $mode instanceof User ) {
103  $args = func_get_args();
104  if ( count( $args ) >= 4 ) {
105  $mode = $args[3];
106  }
107  }
108  $mode = self::getMode( $this->getRequest(), $mode );
109 
110  switch ( $mode ) {
111  case self::EDIT_RAW:
112  $out->setPageTitle( $this->msg( 'watchlistedit-raw-title' ) );
113  $form = $this->getRawForm();
114  if ( $form->show() ) {
115  $out->addHTML( $this->successMessage );
116  $out->addReturnTo( SpecialPage::getTitleFor( 'Watchlist' ) );
117  }
118  break;
119  case self::EDIT_CLEAR:
120  $out->setPageTitle( $this->msg( 'watchlistedit-clear-title' ) );
121  $form = $this->getClearForm();
122  if ( $form->show() ) {
123  $out->addHTML( $this->successMessage );
124  $out->addReturnTo( SpecialPage::getTitleFor( 'Watchlist' ) );
125  }
126  break;
127 
128  case self::EDIT_NORMAL:
129  default:
130  $this->executeViewEditWatchlist();
131  break;
132  }
133  }
134 
138  protected function outputSubtitle() {
139  $out = $this->getOutput();
140  $out->addSubtitle( $this->msg( 'watchlistfor2', $this->getUser()->getName() )
141  ->rawParams(
142  self::buildTools(
143  $this->getLanguage(),
144  $this->getLinkRenderer()
145  )
146  )
147  );
148  }
149 
153  protected function executeViewEditWatchlist() {
154  $out = $this->getOutput();
155  $out->setPageTitle( $this->msg( 'watchlistedit-normal-title' ) );
156  $form = $this->getNormalForm();
157  if ( $form->show() ) {
158  $out->addHTML( $this->successMessage );
159  $out->addReturnTo( SpecialPage::getTitleFor( 'Watchlist' ) );
160  } elseif ( $this->toc !== false ) {
161  $out->prependHTML( $this->toc );
162  $out->addModules( 'mediawiki.toc' );
163  $out->addModuleStyles( 'mediawiki.toc.styles' );
164  }
165  }
166 
173  public function getSubpagesForPrefixSearch() {
174  // SpecialWatchlist uses SpecialEditWatchlist::getMode, so new types should be added
175  // here and there - no 'edit' here, because that the default for this page
176  return [
177  'clear',
178  'raw',
179  ];
180  }
181 
189  private function extractTitles( $list ) {
190  $list = explode( "\n", trim( $list ) );
191  if ( !is_array( $list ) ) {
192  return [];
193  }
194 
195  $titles = [];
196 
197  foreach ( $list as $text ) {
198  $text = trim( $text );
199  if ( strlen( $text ) > 0 ) {
200  $title = Title::newFromText( $text );
201  if ( $title instanceof Title && $title->isWatchable() ) {
202  $titles[] = $title;
203  }
204  }
205  }
206 
207  MediaWikiServices::getInstance()->getGenderCache()->doTitlesArray( $titles );
208 
209  $list = [];
211  foreach ( $titles as $title ) {
212  $list[] = $title->getPrefixedText();
213  }
214 
215  return array_unique( $list );
216  }
217 
218  public function submitRaw( $data ) {
219  $wanted = $this->extractTitles( $data['Titles'] );
220  $current = $this->getWatchlist();
221 
222  if ( count( $wanted ) > 0 ) {
223  $toWatch = array_diff( $wanted, $current );
224  $toUnwatch = array_diff( $current, $wanted );
225  $this->watchTitles( $toWatch );
226  $this->unwatchTitles( $toUnwatch );
227  $this->getUser()->invalidateCache();
228 
229  if ( count( $toWatch ) > 0 || count( $toUnwatch ) > 0 ) {
230  $this->successMessage = $this->msg( 'watchlistedit-raw-done' )->parse();
231  } else {
232  return false;
233  }
234 
235  if ( count( $toWatch ) > 0 ) {
236  $this->successMessage .= ' ' . $this->msg( 'watchlistedit-raw-added' )
237  ->numParams( count( $toWatch ) )->parse();
238  $this->showTitles( $toWatch, $this->successMessage );
239  }
240 
241  if ( count( $toUnwatch ) > 0 ) {
242  $this->successMessage .= ' ' . $this->msg( 'watchlistedit-raw-removed' )
243  ->numParams( count( $toUnwatch ) )->parse();
244  $this->showTitles( $toUnwatch, $this->successMessage );
245  }
246  } else {
247 
248  if ( count( $current ) === 0 ) {
249  return false;
250  }
251 
252  $this->clearUserWatchedItems( $current, 'raw' );
253  $this->showTitles( $current, $this->successMessage );
254  }
255 
256  return true;
257  }
258 
259  public function submitClear( $data ) {
260  $current = $this->getWatchlist();
261  $this->clearUserWatchedItems( $current, 'clear' );
262  $this->showTitles( $current, $this->successMessage );
263  return true;
264  }
265 
270  private function clearUserWatchedItems( $current, $messageFor ) {
271  $watchedItemStore = MediaWikiServices::getInstance()->getWatchedItemStore();
272  if ( $watchedItemStore->clearUserWatchedItems( $this->getUser() ) ) {
273  $this->successMessage = $this->msg( 'watchlistedit-' . $messageFor . '-done' )->parse();
274  $this->successMessage .= ' ' . $this->msg( 'watchlistedit-' . $messageFor . '-removed' )
275  ->numParams( count( $current ) )->parse();
276  $this->getUser()->invalidateCache();
277  } else {
278  $watchedItemStore->clearUserWatchedItemsUsingJobQueue( $this->getUser() );
279  $this->successMessage = $this->msg( 'watchlistedit-clear-jobqueue' )->parse();
280  }
281  }
282 
292  private function showTitles( $titles, &$output ) {
293  $talk = $this->msg( 'talkpagelinktext' )->text();
294  // Do a batch existence check
295  $batch = new LinkBatch();
296  if ( count( $titles ) >= 100 ) {
297  $output = $this->msg( 'watchlistedit-too-many' )->parse();
298  return;
299  }
300  foreach ( $titles as $title ) {
301  if ( !$title instanceof Title ) {
302  $title = Title::newFromText( $title );
303  }
304 
305  if ( $title instanceof Title ) {
306  $batch->addObj( $title );
307  $batch->addObj( $title->getTalkPage() );
308  }
309  }
310 
311  $batch->execute();
312 
313  // Print out the list
314  $output .= "<ul>\n";
315 
316  $linkRenderer = $this->getLinkRenderer();
317  foreach ( $titles as $title ) {
318  if ( !$title instanceof Title ) {
319  $title = Title::newFromText( $title );
320  }
321 
322  if ( $title instanceof Title ) {
323  $output .= '<li>' .
324  $linkRenderer->makeLink( $title ) . ' ' .
325  $this->msg( 'parentheses' )->rawParams(
326  $linkRenderer->makeLink( $title->getTalkPage(), $talk )
327  )->escaped() .
328  "</li>\n";
329  }
330  }
331 
332  $output .= "</ul>\n";
333  }
334 
341  private function getWatchlist() {
342  $list = [];
343 
344  $watchedItems = MediaWikiServices::getInstance()->getWatchedItemStore()->getWatchedItemsForUser(
345  $this->getUser(),
346  [ 'forWrite' => $this->getRequest()->wasPosted() ]
347  );
348 
349  if ( $watchedItems ) {
351  $titles = [];
352  foreach ( $watchedItems as $watchedItem ) {
353  $namespace = $watchedItem->getLinkTarget()->getNamespace();
354  $dbKey = $watchedItem->getLinkTarget()->getDBkey();
355  $title = Title::makeTitleSafe( $namespace, $dbKey );
356 
357  if ( $this->checkTitle( $title, $namespace, $dbKey )
358  && !$title->isTalkPage()
359  ) {
360  $titles[] = $title;
361  }
362  }
363 
364  MediaWikiServices::getInstance()->getGenderCache()->doTitlesArray( $titles );
365 
366  foreach ( $titles as $title ) {
367  $list[] = $title->getPrefixedText();
368  }
369  }
370 
371  $this->cleanupWatchlist();
372 
373  return $list;
374  }
375 
382  protected function getWatchlistInfo() {
383  $titles = [];
384 
385  $watchedItems = MediaWikiServices::getInstance()->getWatchedItemStore()
386  ->getWatchedItemsForUser( $this->getUser(), [ 'sort' => WatchedItemStore::SORT_ASC ] );
387 
388  $lb = new LinkBatch();
389 
390  foreach ( $watchedItems as $watchedItem ) {
391  $namespace = $watchedItem->getLinkTarget()->getNamespace();
392  $dbKey = $watchedItem->getLinkTarget()->getDBkey();
393  $lb->add( $namespace, $dbKey );
394  if ( !MWNamespace::isTalk( $namespace ) ) {
395  $titles[$namespace][$dbKey] = 1;
396  }
397  }
398 
399  $lb->execute();
400 
401  return $titles;
402  }
403 
412  private function checkTitle( $title, $namespace, $dbKey ) {
413  if ( $title
414  && ( $title->isExternal()
415  || $title->getNamespace() < 0
416  )
417  ) {
418  $title = false; // unrecoverable
419  }
420 
421  if ( !$title
422  || $title->getNamespace() != $namespace
423  || $title->getDBkey() != $dbKey
424  ) {
425  $this->badItems[] = [ $title, $namespace, $dbKey ];
426  }
427 
428  return (bool)$title;
429  }
430 
434  private function cleanupWatchlist() {
435  if ( !count( $this->badItems ) ) {
436  return; // nothing to do
437  }
438 
439  $user = $this->getUser();
442  $store = MediaWikiServices::getInstance()->getWatchedItemStore();
443  foreach ( $badItems as $row ) {
444  list( $title, $namespace, $dbKey ) = $row;
445  $action = $title ? 'cleaning up' : 'deleting';
446  wfDebug( "User {$user->getName()} has broken watchlist item " .
447  "ns($namespace):$dbKey, $action.\n" );
448 
449  $store->removeWatch( $user, new TitleValue( (int)$namespace, $dbKey ) );
450  // Can't just do an UPDATE instead of DELETE/INSERT due to unique index
451  if ( $title ) {
452  $user->addWatch( $title );
453  }
454  }
455  } );
456  }
457 
466  private function watchTitles( array $targets ) {
467  return MediaWikiServices::getInstance()->getWatchedItemStore()
468  ->addWatchBatchForUser( $this->getUser(), $this->getExpandedTargets( $targets ) )
469  && $this->runWatchUnwatchCompleteHook( 'Watch', $targets );
470  }
471 
484  private function unwatchTitles( array $targets ) {
485  return MediaWikiServices::getInstance()->getWatchedItemStore()
486  ->removeWatchBatchForUser( $this->getUser(), $this->getExpandedTargets( $targets ) )
487  && $this->runWatchUnwatchCompleteHook( 'Unwatch', $targets );
488  }
489 
498  private function runWatchUnwatchCompleteHook( $action, $targets ) {
499  foreach ( $targets as $target ) {
500  $title = $target instanceof TitleValue ?
501  Title::newFromTitleValue( $target ) :
502  Title::newFromText( $target );
503  $page = WikiPage::factory( $title );
504  Hooks::run( $action . 'ArticleComplete', [ $this->getUser(), &$page ] );
505  }
506  return true;
507  }
508 
513  private function getExpandedTargets( array $targets ) {
514  $expandedTargets = [];
515  foreach ( $targets as $target ) {
516  if ( !$target instanceof LinkTarget ) {
517  try {
518  $target = $this->titleParser->parseTitle( $target, NS_MAIN );
519  }
520  catch ( MalformedTitleException $e ) {
521  continue;
522  }
523  }
524 
525  $ns = $target->getNamespace();
526  $dbKey = $target->getDBkey();
527  $expandedTargets[] = new TitleValue( MWNamespace::getSubject( $ns ), $dbKey );
528  $expandedTargets[] = new TitleValue( MWNamespace::getTalk( $ns ), $dbKey );
529  }
530  return $expandedTargets;
531  }
532 
533  public function submitNormal( $data ) {
534  $removed = [];
535 
536  foreach ( $data as $titles ) {
537  $this->unwatchTitles( $titles );
538  $removed = array_merge( $removed, $titles );
539  }
540 
541  if ( count( $removed ) > 0 ) {
542  $this->successMessage = $this->msg( 'watchlistedit-normal-done'
543  )->numParams( count( $removed ) )->parse();
544  $this->showTitles( $removed, $this->successMessage );
545 
546  return true;
547  } else {
548  return false;
549  }
550  }
551 
557  protected function getNormalForm() {
558  $fields = [];
559  $count = 0;
560 
561  // Allow subscribers to manipulate the list of watched pages (or use it
562  // to preload lots of details at once)
563  $watchlistInfo = $this->getWatchlistInfo();
564  Hooks::run(
565  'WatchlistEditorBeforeFormRender',
566  [ &$watchlistInfo ]
567  );
568 
569  foreach ( $watchlistInfo as $namespace => $pages ) {
570  $options = [];
571 
572  foreach ( array_keys( $pages ) as $dbkey ) {
573  $title = Title::makeTitleSafe( $namespace, $dbkey );
574 
575  if ( $this->checkTitle( $title, $namespace, $dbkey ) ) {
576  $text = $this->buildRemoveLine( $title );
577  $options[$text] = $title->getPrefixedText();
578  $count++;
579  }
580  }
581 
582  // checkTitle can filter some options out, avoid empty sections
583  if ( count( $options ) > 0 ) {
584  $fields['TitlesNs' . $namespace] = [
586  'options' => $options,
587  'section' => "ns$namespace",
588  ];
589  }
590  }
591  $this->cleanupWatchlist();
592 
593  if ( count( $fields ) > 1 && $count > 30 ) {
594  $this->toc = Linker::tocIndent();
595  $tocLength = 0;
596  $contLang = MediaWikiServices::getInstance()->getContentLanguage();
597 
598  foreach ( $fields as $data ) {
599  # strip out the 'ns' prefix from the section name:
600  $ns = substr( $data['section'], 2 );
601 
602  $nsText = ( $ns == NS_MAIN )
603  ? $this->msg( 'blanknamespace' )->escaped()
604  : htmlspecialchars( $contLang->getFormattedNsText( $ns ) );
605  $this->toc .= Linker::tocLine( "editwatchlist-{$data['section']}", $nsText,
606  $this->getLanguage()->formatNum( ++$tocLength ), 1 ) . Linker::tocLineEnd();
607  }
608 
609  $this->toc = Linker::tocList( $this->toc );
610  } else {
611  $this->toc = false;
612  }
613 
614  $context = new DerivativeContext( $this->getContext() );
615  $context->setTitle( $this->getPageTitle() ); // Remove subpage
616  $form = new EditWatchlistNormalHTMLForm( $fields, $context );
617  $form->setSubmitTextMsg( 'watchlistedit-normal-submit' );
618  $form->setSubmitDestructive();
619  # Used message keys:
620  # 'accesskey-watchlistedit-normal-submit', 'tooltip-watchlistedit-normal-submit'
621  $form->setSubmitTooltip( 'watchlistedit-normal-submit' );
622  $form->setWrapperLegendMsg( 'watchlistedit-normal-legend' );
623  $form->addHeaderText( $this->msg( 'watchlistedit-normal-explain' )->parse() );
624  $form->setSubmitCallback( [ $this, 'submitNormal' ] );
625 
626  return $form;
627  }
628 
635  private function buildRemoveLine( $title ) {
636  $linkRenderer = $this->getLinkRenderer();
637  $link = $linkRenderer->makeLink( $title );
638 
639  $tools['talk'] = $linkRenderer->makeLink(
640  $title->getTalkPage(),
641  $this->msg( 'talkpagelinktext' )->text()
642  );
643 
644  if ( $title->exists() ) {
645  $tools['history'] = $linkRenderer->makeKnownLink(
646  $title,
647  $this->msg( 'history_small' )->text(),
648  [],
649  [ 'action' => 'history' ]
650  );
651  }
652 
653  if ( $title->getNamespace() == NS_USER && !$title->isSubpage() ) {
654  $tools['contributions'] = $linkRenderer->makeKnownLink(
655  SpecialPage::getTitleFor( 'Contributions', $title->getText() ),
656  $this->msg( 'contribslink' )->text()
657  );
658  }
659 
660  Hooks::run(
661  'WatchlistEditorBuildRemoveLine',
662  [ &$tools, $title, $title->isRedirect(), $this->getSkin(), &$link ]
663  );
664 
665  if ( $title->isRedirect() ) {
666  // Linker already makes class mw-redirect, so this is redundant
667  $link = '<span class="watchlistredir">' . $link . '</span>';
668  }
669 
670  return $link . ' ' .
671  $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList( $tools ) )->escaped();
672  }
673 
679  protected function getRawForm() {
680  $titles = implode( "\n", $this->getWatchlist() );
681  $fields = [
682  'Titles' => [
683  'type' => 'textarea',
684  'label-message' => 'watchlistedit-raw-titles',
685  'default' => $titles,
686  ],
687  ];
688  $context = new DerivativeContext( $this->getContext() );
689  $context->setTitle( $this->getPageTitle( 'raw' ) ); // Reset subpage
690  $form = new OOUIHTMLForm( $fields, $context );
691  $form->setSubmitTextMsg( 'watchlistedit-raw-submit' );
692  # Used message keys: 'accesskey-watchlistedit-raw-submit', 'tooltip-watchlistedit-raw-submit'
693  $form->setSubmitTooltip( 'watchlistedit-raw-submit' );
694  $form->setWrapperLegendMsg( 'watchlistedit-raw-legend' );
695  $form->addHeaderText( $this->msg( 'watchlistedit-raw-explain' )->parse() );
696  $form->setSubmitCallback( [ $this, 'submitRaw' ] );
697 
698  return $form;
699  }
700 
706  protected function getClearForm() {
707  $context = new DerivativeContext( $this->getContext() );
708  $context->setTitle( $this->getPageTitle( 'clear' ) ); // Reset subpage
709  $form = new OOUIHTMLForm( [], $context );
710  $form->setSubmitTextMsg( 'watchlistedit-clear-submit' );
711  # Used message keys: 'accesskey-watchlistedit-clear-submit', 'tooltip-watchlistedit-clear-submit'
712  $form->setSubmitTooltip( 'watchlistedit-clear-submit' );
713  $form->setWrapperLegendMsg( 'watchlistedit-clear-legend' );
714  $form->addHeaderText( $this->msg( 'watchlistedit-clear-explain' )->parse() );
715  $form->setSubmitCallback( [ $this, 'submitClear' ] );
716  $form->setSubmitDestructive();
717 
718  return $form;
719  }
720 
729  public static function getMode( $request, $par ) {
730  $mode = strtolower( $request->getVal( 'action', $par ) );
731 
732  switch ( $mode ) {
733  case 'clear':
734  case self::EDIT_CLEAR:
735  return self::EDIT_CLEAR;
736  case 'raw':
737  case self::EDIT_RAW:
738  return self::EDIT_RAW;
739  case 'edit':
740  case self::EDIT_NORMAL:
741  return self::EDIT_NORMAL;
742  default:
743  return false;
744  }
745  }
746 
755  public static function buildTools( $lang, LinkRenderer $linkRenderer = null ) {
756  if ( !$lang instanceof Language ) {
757  // back-compat where the first parameter was $unused
758  global $wgLang;
759  $lang = $wgLang;
760  }
761  if ( !$linkRenderer ) {
762  $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
763  }
764 
765  $tools = [];
766  $modes = [
767  'view' => [ 'Watchlist', false ],
768  'edit' => [ 'EditWatchlist', false ],
769  'raw' => [ 'EditWatchlist', 'raw' ],
770  'clear' => [ 'EditWatchlist', 'clear' ],
771  ];
772 
773  foreach ( $modes as $mode => $arr ) {
774  // can use messages 'watchlisttools-view', 'watchlisttools-edit', 'watchlisttools-raw'
775  $tools[] = $linkRenderer->makeKnownLink(
776  SpecialPage::getTitleFor( $arr[0], $arr[1] ),
777  wfMessage( "watchlisttools-{$mode}" )->text()
778  );
779  }
780 
781  return Html::rawElement(
782  'span',
783  [ 'class' => 'mw-watchlist-toollinks' ],
784  wfMessage( 'parentheses' )->rawParams( $lang->pipeList( $tools ) )->escaped()
785  );
786  }
787 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:127
static tocList( $toc, $lang=false)
Wraps the TOC in a table and provides the hide/collapse javascript.
Definition: Linker.php:1567
static tocLineEnd()
End a Table Of Contents line.
Definition: Linker.php:1555
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
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:822
runWatchUnwatchCompleteHook( $action, $targets)
Shortcut to construct a special page which is unlisted by default.
MalformedTitleException is thrown when a TitleParser is unable to parse a title string.
getContext()
Gets the context this SpecialPage is executed in.
const NS_MAIN
Definition: Defines.php:64
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
const EDIT_CLEAR
Editing modes.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2223
if(!isset( $args[0])) $lang
getClearForm()
Get a form for clearing the watchlist.
cleanupWatchlist()
Attempts to clean up broken items.
static getSubject( $index)
Get the subject namespace index for a given namespace Special namespaces (NS_MEDIA, NS_SPECIAL) are always the subject.
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
An IContextSource implementation which will inherit context from another source but allow individual ...
static getMode( $request, $par)
Determine whether we are editing the watchlist, and if so, what kind of editing operation.
getRawForm()
Get a form for editing the watchlist in "raw" mode.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
static buildTools( $lang, LinkRenderer $linkRenderer=null)
Build a set of links for convenient navigation between watchlist viewing and editing modes...
static isTalk( $index)
Is the given namespace a talk namespace?
getOutput()
Get the OutputPage being used for this instance.
execute( $mode)
Main execution point.
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
getWatchlist()
Prepare a list of titles on a user&#39;s watchlist (excluding talk pages) and return an array of (prefixe...
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2280
if( $line===false) $args
Definition: cdb.php:64
$batch
Definition: linkcache.txt:23
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3100
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:47
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept.
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
getExpandedTargets(array $targets)
static addCallableUpdate( $callable, $stage=self::POSTSEND, $dbw=null)
Add a callable update.
clearUserWatchedItems( $current, $messageFor)
$wgLang
Definition: Setup.php:889
Class that generates HTML links for pages.
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 use $formDescriptor instead 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
unwatchTitles(array $targets)
Remove a list of titles from a user&#39;s watchlist.
getNormalForm()
Get the standard watchlist editing form.
checkTitle( $title, $namespace, $dbKey)
Validates watchlist entry.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Extend OOUIHTMLForm purely so we can have a more sane way of getting the section headers.
initServices()
Initialize any services we&#39;ll need (unless it has already been provided via a setter).
showTitles( $titles, &$output)
Print out a list of linked titles.
static tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex=false)
parameter level defines if we are on an indentation level
Definition: Linker.php:1531
getSkin()
Shortcut to get the skin 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 & $options
Definition: hooks.txt:2046
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:973
extractTitles( $list)
Extract a list of titles from a blob of text, returning (prefixed) strings; unwatchable titles are ig...
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:82
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
static newFromTitleValue(TitleValue $titleValue)
Create a new Title from a TitleValue.
Definition: Title.php:240
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:573
outputSubtitle()
Renders a subheader on the watchlist page.
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
getName()
Get the name of this Special Page.
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
requireLogin( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
If the user is not logged in, throws UserNotLoggedIn error.
static getTalk( $index)
Get the talk namespace index for a given namespace.
getUser()
Shortcut to get the User executing this instance.
Compact stacked vertical format for forms, implemented using OOUI widgets.
getLanguage()
Shortcut to get user&#39;s language.
msg( $key)
Wrapper around wfMessage that sets the current context.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2685
getWatchlistInfo()
Get a list of titles on a user&#39;s watchlist, excluding talk pages, and return as a two-dimensional arr...
static tocIndent()
Add another level to the Table of Contents.
Definition: Linker.php:1505
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
getRequest()
Get the WebRequest being used for this instance.
executeViewEditWatchlist()
Executes an edit mode for the watchlist view, from which you can manage your watchlist.
buildRemoveLine( $title)
Build the label for a checkbox, with a link to the title, and various additional bits.
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
Provides the UI through which users can perform editing operations on their watchlist.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2685
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getPageTitle( $subpage=false)
Get a self-referential title object.
watchTitles(array $targets)
Add a list of targets to a user&#39;s watchlist.
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 local account $user
Definition: hooks.txt:244
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:280