MediaWiki  REL1_31
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  }
164  }
165 
172  public function getSubpagesForPrefixSearch() {
173  // SpecialWatchlist uses SpecialEditWatchlist::getMode, so new types should be added
174  // here and there - no 'edit' here, because that the default for this page
175  return [
176  'clear',
177  'raw',
178  ];
179  }
180 
188  private function extractTitles( $list ) {
189  $list = explode( "\n", trim( $list ) );
190  if ( !is_array( $list ) ) {
191  return [];
192  }
193 
194  $titles = [];
195 
196  foreach ( $list as $text ) {
197  $text = trim( $text );
198  if ( strlen( $text ) > 0 ) {
199  $title = Title::newFromText( $text );
200  if ( $title instanceof Title && $title->isWatchable() ) {
201  $titles[] = $title;
202  }
203  }
204  }
205 
206  MediaWikiServices::getInstance()->getGenderCache()->doTitlesArray( $titles );
207 
208  $list = [];
210  foreach ( $titles as $title ) {
211  $list[] = $title->getPrefixedText();
212  }
213 
214  return array_unique( $list );
215  }
216 
217  public function submitRaw( $data ) {
218  $wanted = $this->extractTitles( $data['Titles'] );
219  $current = $this->getWatchlist();
220 
221  if ( count( $wanted ) > 0 ) {
222  $toWatch = array_diff( $wanted, $current );
223  $toUnwatch = array_diff( $current, $wanted );
224  $this->watchTitles( $toWatch );
225  $this->unwatchTitles( $toUnwatch );
226  $this->getUser()->invalidateCache();
227 
228  if ( count( $toWatch ) > 0 || count( $toUnwatch ) > 0 ) {
229  $this->successMessage = $this->msg( 'watchlistedit-raw-done' )->parse();
230  } else {
231  return false;
232  }
233 
234  if ( count( $toWatch ) > 0 ) {
235  $this->successMessage .= ' ' . $this->msg( 'watchlistedit-raw-added' )
236  ->numParams( count( $toWatch ) )->parse();
237  $this->showTitles( $toWatch, $this->successMessage );
238  }
239 
240  if ( count( $toUnwatch ) > 0 ) {
241  $this->successMessage .= ' ' . $this->msg( 'watchlistedit-raw-removed' )
242  ->numParams( count( $toUnwatch ) )->parse();
243  $this->showTitles( $toUnwatch, $this->successMessage );
244  }
245  } else {
246 
247  if ( count( $current ) === 0 ) {
248  return false;
249  }
250 
251  $this->clearUserWatchedItems( $current, 'raw' );
252  $this->showTitles( $current, $this->successMessage );
253  }
254 
255  return true;
256  }
257 
258  public function submitClear( $data ) {
259  $current = $this->getWatchlist();
260  $this->clearUserWatchedItems( $current, 'clear' );
261  $this->showTitles( $current, $this->successMessage );
262  return true;
263  }
264 
269  private function clearUserWatchedItems( $current, $messageFor ) {
270  $watchedItemStore = MediaWikiServices::getInstance()->getWatchedItemStore();
271  if ( $watchedItemStore->clearUserWatchedItems( $this->getUser() ) ) {
272  $this->successMessage = $this->msg( 'watchlistedit-' . $messageFor . '-done' )->parse();
273  $this->successMessage .= ' ' . $this->msg( 'watchlistedit-' . $messageFor . '-removed' )
274  ->numParams( count( $current ) )->parse();
275  $this->getUser()->invalidateCache();
276  } else {
277  $watchedItemStore->clearUserWatchedItemsUsingJobQueue( $this->getUser() );
278  $this->successMessage = $this->msg( 'watchlistedit-clear-jobqueue' )->parse();
279  }
280  }
281 
291  private function showTitles( $titles, &$output ) {
292  $talk = $this->msg( 'talkpagelinktext' )->text();
293  // Do a batch existence check
294  $batch = new LinkBatch();
295  if ( count( $titles ) >= 100 ) {
296  $output = $this->msg( 'watchlistedit-too-many' )->parse();
297  return;
298  }
299  foreach ( $titles as $title ) {
300  if ( !$title instanceof Title ) {
302  }
303 
304  if ( $title instanceof Title ) {
305  $batch->addObj( $title );
306  $batch->addObj( $title->getTalkPage() );
307  }
308  }
309 
310  $batch->execute();
311 
312  // Print out the list
313  $output .= "<ul>\n";
314 
315  $linkRenderer = $this->getLinkRenderer();
316  foreach ( $titles as $title ) {
317  if ( !$title instanceof Title ) {
319  }
320 
321  if ( $title instanceof Title ) {
322  $output .= '<li>' .
323  $linkRenderer->makeLink( $title ) . ' ' .
324  $this->msg( 'parentheses' )->rawParams(
325  $linkRenderer->makeLink( $title->getTalkPage(), $talk )
326  )->escaped() .
327  "</li>\n";
328  }
329  }
330 
331  $output .= "</ul>\n";
332  }
333 
340  private function getWatchlist() {
341  $list = [];
342 
343  $watchedItems = MediaWikiServices::getInstance()->getWatchedItemStore()->getWatchedItemsForUser(
344  $this->getUser(),
345  [ 'forWrite' => $this->getRequest()->wasPosted() ]
346  );
347 
348  if ( $watchedItems ) {
350  $titles = [];
351  foreach ( $watchedItems as $watchedItem ) {
352  $namespace = $watchedItem->getLinkTarget()->getNamespace();
353  $dbKey = $watchedItem->getLinkTarget()->getDBkey();
354  $title = Title::makeTitleSafe( $namespace, $dbKey );
355 
356  if ( $this->checkTitle( $title, $namespace, $dbKey )
357  && !$title->isTalkPage()
358  ) {
359  $titles[] = $title;
360  }
361  }
362 
363  MediaWikiServices::getInstance()->getGenderCache()->doTitlesArray( $titles );
364 
365  foreach ( $titles as $title ) {
366  $list[] = $title->getPrefixedText();
367  }
368  }
369 
370  $this->cleanupWatchlist();
371 
372  return $list;
373  }
374 
381  protected function getWatchlistInfo() {
382  $titles = [];
383 
384  $watchedItems = MediaWikiServices::getInstance()->getWatchedItemStore()
385  ->getWatchedItemsForUser( $this->getUser(), [ 'sort' => WatchedItemStore::SORT_ASC ] );
386 
387  $lb = new LinkBatch();
388 
389  foreach ( $watchedItems as $watchedItem ) {
390  $namespace = $watchedItem->getLinkTarget()->getNamespace();
391  $dbKey = $watchedItem->getLinkTarget()->getDBkey();
392  $lb->add( $namespace, $dbKey );
393  if ( !MWNamespace::isTalk( $namespace ) ) {
394  $titles[$namespace][$dbKey] = 1;
395  }
396  }
397 
398  $lb->execute();
399 
400  return $titles;
401  }
402 
411  private function checkTitle( $title, $namespace, $dbKey ) {
412  if ( $title
413  && ( $title->isExternal()
414  || $title->getNamespace() < 0
415  )
416  ) {
417  $title = false; // unrecoverable
418  }
419 
420  if ( !$title
421  || $title->getNamespace() != $namespace
422  || $title->getDBkey() != $dbKey
423  ) {
424  $this->badItems[] = [ $title, $namespace, $dbKey ];
425  }
426 
427  return (bool)$title;
428  }
429 
433  private function cleanupWatchlist() {
434  if ( !count( $this->badItems ) ) {
435  return; // nothing to do
436  }
437 
438  $user = $this->getUser();
441  $store = MediaWikiServices::getInstance()->getWatchedItemStore();
442  foreach ( $badItems as $row ) {
443  list( $title, $namespace, $dbKey ) = $row;
444  $action = $title ? 'cleaning up' : 'deleting';
445  wfDebug( "User {$user->getName()} has broken watchlist item " .
446  "ns($namespace):$dbKey, $action.\n" );
447 
448  $store->removeWatch( $user, new TitleValue( (int)$namespace, $dbKey ) );
449  // Can't just do an UPDATE instead of DELETE/INSERT due to unique index
450  if ( $title ) {
451  $user->addWatch( $title );
452  }
453  }
454  } );
455  }
456 
462  private function watchTitles( $targets ) {
463  $expandedTargets = [];
464  foreach ( $targets as $target ) {
465  if ( !$target instanceof LinkTarget ) {
466  try {
467  $target = $this->titleParser->parseTitle( $target, NS_MAIN );
468  }
469  catch ( MalformedTitleException $e ) {
470  continue;
471  }
472  }
473 
474  $ns = $target->getNamespace();
475  $dbKey = $target->getDBkey();
476  $expandedTargets[] = new TitleValue( MWNamespace::getSubject( $ns ), $dbKey );
477  $expandedTargets[] = new TitleValue( MWNamespace::getTalk( $ns ), $dbKey );
478  }
479 
480  MediaWikiServices::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
481  $this->getUser(),
482  $expandedTargets
483  );
484  }
485 
494  private function unwatchTitles( $titles ) {
495  $store = MediaWikiServices::getInstance()->getWatchedItemStore();
496 
497  foreach ( $titles as $title ) {
498  if ( !$title instanceof Title ) {
500  }
501 
502  if ( $title instanceof Title ) {
503  $store->removeWatch( $this->getUser(), $title->getSubjectPage() );
504  $store->removeWatch( $this->getUser(), $title->getTalkPage() );
505 
506  $page = WikiPage::factory( $title );
507  Hooks::run( 'UnwatchArticleComplete', [ $this->getUser(), &$page ] );
508  }
509  }
510  }
511 
512  public function submitNormal( $data ) {
513  $removed = [];
514 
515  foreach ( $data as $titles ) {
516  $this->unwatchTitles( $titles );
517  $removed = array_merge( $removed, $titles );
518  }
519 
520  if ( count( $removed ) > 0 ) {
521  $this->successMessage = $this->msg( 'watchlistedit-normal-done'
522  )->numParams( count( $removed ) )->parse();
523  $this->showTitles( $removed, $this->successMessage );
524 
525  return true;
526  } else {
527  return false;
528  }
529  }
530 
536  protected function getNormalForm() {
538 
539  $fields = [];
540  $count = 0;
541 
542  // Allow subscribers to manipulate the list of watched pages (or use it
543  // to preload lots of details at once)
544  $watchlistInfo = $this->getWatchlistInfo();
545  Hooks::run(
546  'WatchlistEditorBeforeFormRender',
547  [ &$watchlistInfo ]
548  );
549 
550  foreach ( $watchlistInfo as $namespace => $pages ) {
551  $options = [];
552 
553  foreach ( array_keys( $pages ) as $dbkey ) {
554  $title = Title::makeTitleSafe( $namespace, $dbkey );
555 
556  if ( $this->checkTitle( $title, $namespace, $dbkey ) ) {
557  $text = $this->buildRemoveLine( $title );
558  $options[$text] = $title->getPrefixedText();
559  $count++;
560  }
561  }
562 
563  // checkTitle can filter some options out, avoid empty sections
564  if ( count( $options ) > 0 ) {
565  $fields['TitlesNs' . $namespace] = [
567  'options' => $options,
568  'section' => "ns$namespace",
569  ];
570  }
571  }
572  $this->cleanupWatchlist();
573 
574  if ( count( $fields ) > 1 && $count > 30 ) {
575  $this->toc = Linker::tocIndent();
576  $tocLength = 0;
577 
578  foreach ( $fields as $data ) {
579  # strip out the 'ns' prefix from the section name:
580  $ns = substr( $data['section'], 2 );
581 
582  $nsText = ( $ns == NS_MAIN )
583  ? $this->msg( 'blanknamespace' )->escaped()
584  : htmlspecialchars( $wgContLang->getFormattedNsText( $ns ) );
585  $this->toc .= Linker::tocLine( "editwatchlist-{$data['section']}", $nsText,
586  $this->getLanguage()->formatNum( ++$tocLength ), 1 ) . Linker::tocLineEnd();
587  }
588 
589  $this->toc = Linker::tocList( $this->toc );
590  } else {
591  $this->toc = false;
592  }
593 
594  $context = new DerivativeContext( $this->getContext() );
595  $context->setTitle( $this->getPageTitle() ); // Remove subpage
596  $form = new EditWatchlistNormalHTMLForm( $fields, $context );
597  $form->setSubmitTextMsg( 'watchlistedit-normal-submit' );
598  $form->setSubmitDestructive();
599  # Used message keys:
600  # 'accesskey-watchlistedit-normal-submit', 'tooltip-watchlistedit-normal-submit'
601  $form->setSubmitTooltip( 'watchlistedit-normal-submit' );
602  $form->setWrapperLegendMsg( 'watchlistedit-normal-legend' );
603  $form->addHeaderText( $this->msg( 'watchlistedit-normal-explain' )->parse() );
604  $form->setSubmitCallback( [ $this, 'submitNormal' ] );
605 
606  return $form;
607  }
608 
615  private function buildRemoveLine( $title ) {
616  $linkRenderer = $this->getLinkRenderer();
617  $link = $linkRenderer->makeLink( $title );
618 
619  $tools['talk'] = $linkRenderer->makeLink(
620  $title->getTalkPage(),
621  $this->msg( 'talkpagelinktext' )->text()
622  );
623 
624  if ( $title->exists() ) {
625  $tools['history'] = $linkRenderer->makeKnownLink(
626  $title,
627  $this->msg( 'history_small' )->text(),
628  [],
629  [ 'action' => 'history' ]
630  );
631  }
632 
633  if ( $title->getNamespace() == NS_USER && !$title->isSubpage() ) {
634  $tools['contributions'] = $linkRenderer->makeKnownLink(
635  SpecialPage::getTitleFor( 'Contributions', $title->getText() ),
636  $this->msg( 'contributions' )->text()
637  );
638  }
639 
640  Hooks::run(
641  'WatchlistEditorBuildRemoveLine',
642  [ &$tools, $title, $title->isRedirect(), $this->getSkin(), &$link ]
643  );
644 
645  if ( $title->isRedirect() ) {
646  // Linker already makes class mw-redirect, so this is redundant
647  $link = '<span class="watchlistredir">' . $link . '</span>';
648  }
649 
650  return $link . ' ' .
651  $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList( $tools ) )->escaped();
652  }
653 
659  protected function getRawForm() {
660  $titles = implode( "\n", $this->getWatchlist() );
661  $fields = [
662  'Titles' => [
663  'type' => 'textarea',
664  'label-message' => 'watchlistedit-raw-titles',
665  'default' => $titles,
666  ],
667  ];
668  $context = new DerivativeContext( $this->getContext() );
669  $context->setTitle( $this->getPageTitle( 'raw' ) ); // Reset subpage
670  $form = new HTMLForm( $fields, $context );
671  $form->setSubmitTextMsg( 'watchlistedit-raw-submit' );
672  # Used message keys: 'accesskey-watchlistedit-raw-submit', 'tooltip-watchlistedit-raw-submit'
673  $form->setSubmitTooltip( 'watchlistedit-raw-submit' );
674  $form->setWrapperLegendMsg( 'watchlistedit-raw-legend' );
675  $form->addHeaderText( $this->msg( 'watchlistedit-raw-explain' )->parse() );
676  $form->setSubmitCallback( [ $this, 'submitRaw' ] );
677 
678  return $form;
679  }
680 
686  protected function getClearForm() {
687  $context = new DerivativeContext( $this->getContext() );
688  $context->setTitle( $this->getPageTitle( 'clear' ) ); // Reset subpage
689  $form = new HTMLForm( [], $context );
690  $form->setSubmitTextMsg( 'watchlistedit-clear-submit' );
691  # Used message keys: 'accesskey-watchlistedit-clear-submit', 'tooltip-watchlistedit-clear-submit'
692  $form->setSubmitTooltip( 'watchlistedit-clear-submit' );
693  $form->setWrapperLegendMsg( 'watchlistedit-clear-legend' );
694  $form->addHeaderText( $this->msg( 'watchlistedit-clear-explain' )->parse() );
695  $form->setSubmitCallback( [ $this, 'submitClear' ] );
696  $form->setSubmitDestructive();
697 
698  return $form;
699  }
700 
709  public static function getMode( $request, $par ) {
710  $mode = strtolower( $request->getVal( 'action', $par ) );
711 
712  switch ( $mode ) {
713  case 'clear':
714  case self::EDIT_CLEAR:
715  return self::EDIT_CLEAR;
716  case 'raw':
717  case self::EDIT_RAW:
718  return self::EDIT_RAW;
719  case 'edit':
720  case self::EDIT_NORMAL:
721  return self::EDIT_NORMAL;
722  default:
723  return false;
724  }
725  }
726 
735  public static function buildTools( $lang, LinkRenderer $linkRenderer = null ) {
736  if ( !$lang instanceof Language ) {
737  // back-compat where the first parameter was $unused
738  global $wgLang;
739  $lang = $wgLang;
740  }
741  if ( !$linkRenderer ) {
742  $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
743  }
744 
745  $tools = [];
746  $modes = [
747  'view' => [ 'Watchlist', false ],
748  'edit' => [ 'EditWatchlist', false ],
749  'raw' => [ 'EditWatchlist', 'raw' ],
750  'clear' => [ 'EditWatchlist', 'clear' ],
751  ];
752 
753  foreach ( $modes as $mode => $arr ) {
754  // can use messages 'watchlisttools-view', 'watchlisttools-edit', 'watchlisttools-raw'
755  $tools[] = $linkRenderer->makeKnownLink(
756  SpecialPage::getTitleFor( $arr[0], $arr[1] ),
757  wfMessage( "watchlisttools-{$mode}" )->text()
758  );
759  }
760 
761  return Html::rawElement(
762  'span',
763  [ 'class' => 'mw-watchlist-toollinks' ],
764  wfMessage( 'parentheses' )->rawParams( $lang->pipeList( $tools ) )->escaped()
765  );
766  }
767 }
$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
SpecialEditWatchlist\submitNormal
submitNormal( $data)
Definition: SpecialEditWatchlist.php:512
SpecialEditWatchlist\EDIT_CLEAR
const EDIT_CLEAR
Editing modes.
Definition: SpecialEditWatchlist.php:46
SpecialEditWatchlist\getWatchlist
getWatchlist()
Prepare a list of titles on a user's watchlist (excluding talk pages) and return an array of (prefixe...
Definition: SpecialEditWatchlist.php:340
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
SpecialEditWatchlist\unwatchTitles
unwatchTitles( $titles)
Remove a list of titles from a user's watchlist.
Definition: SpecialEditWatchlist.php:494
SpecialEditWatchlist\EDIT_RAW
const EDIT_RAW
Definition: SpecialEditWatchlist.php:47
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
SpecialEditWatchlist\checkTitle
checkTitle( $title, $namespace, $dbKey)
Validates watchlist entry.
Definition: SpecialEditWatchlist.php:411
MWNamespace\isTalk
static isTalk( $index)
Is the given namespace a talk namespace?
Definition: MWNamespace.php:118
SpecialEditWatchlist\initServices
initServices()
Initialize any services we'll need (unless it has already been provided via a setter).
Definition: SpecialEditWatchlist.php:69
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
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
$output
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2255
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
UnlistedSpecialPage
Shortcut to construct a special page which is unlisted by default.
Definition: UnlistedSpecialPage.php:29
Linker\tocIndent
static tocIndent()
Add another level to the Table of Contents.
Definition: Linker.php:1519
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
MediaWiki\Linker\LinkRenderer
Class that generates HTML links for pages.
Definition: LinkRenderer.php:41
SpecialEditWatchlist\__construct
__construct()
Definition: SpecialEditWatchlist.php:61
SpecialEditWatchlist\submitRaw
submitRaw( $data)
Definition: SpecialEditWatchlist.php:217
$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
SpecialPage\checkPermissions
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
Definition: SpecialPage.php:306
SpecialEditWatchlist\buildRemoveLine
buildRemoveLine( $title)
Build the label for a checkbox, with a link to the title, and various additional bits.
Definition: SpecialEditWatchlist.php:615
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
SpecialPage\getLanguage
getLanguage()
Shortcut to get user's language.
Definition: SpecialPage.php:752
SpecialPage\getName
getName()
Get the name of this Special Page.
Definition: SpecialPage.php:150
SpecialEditWatchlist\clearUserWatchedItems
clearUserWatchedItems( $current, $messageFor)
Definition: SpecialEditWatchlist.php:269
Linker\tocLine
static tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex=false)
parameter level defines if we are on an indentation level
Definition: Linker.php:1545
SpecialEditWatchlist\$badItems
$badItems
Definition: SpecialEditWatchlist.php:54
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
SpecialEditWatchlist\$titleParser
TitleParser $titleParser
Definition: SpecialEditWatchlist.php:59
SpecialEditWatchlist\execute
execute( $mode)
Main execution point.
Definition: SpecialEditWatchlist.php:84
NS_MAIN
const NS_MAIN
Definition: Defines.php:74
EditWatchlistNormalHTMLForm
Extend HTMLForm purely so we can have a more sane way of getting the section headers.
Definition: EditWatchlistNormalHTMLForm.php:24
DerivativeContext
An IContextSource implementation which will inherit context from another source but allow individual ...
Definition: DerivativeContext.php:30
SpecialEditWatchlist\EDIT_NORMAL
const EDIT_NORMAL
Definition: SpecialEditWatchlist.php:48
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
$titles
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
SpecialEditWatchlist\getRawForm
getRawForm()
Get a form for editing the watchlist in "raw" mode.
Definition: SpecialEditWatchlist.php:659
Linker\tocList
static tocList( $toc, $lang=false)
Wraps the TOC in a table and provides the hide/collapse javascript.
Definition: Linker.php:1581
SpecialEditWatchlist\executeViewEditWatchlist
executeViewEditWatchlist()
Executes an edit mode for the watchlist view, from which you can manage your watchlist.
Definition: SpecialEditWatchlist.php:153
SpecialEditWatchlist\extractTitles
extractTitles( $list)
Extract a list of titles from a blob of text, returning (prefixed) strings; unwatchable titles are ig...
Definition: SpecialEditWatchlist.php:188
Linker\tocLineEnd
static tocLineEnd()
End a Table Of Contents line.
Definition: Linker.php:1569
SpecialEditWatchlist
Provides the UI through which users can perform editing operations on their watchlist.
Definition: SpecialEditWatchlist.php:41
$wgLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition: design.txt:56
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3021
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
SpecialEditWatchlist\showTitles
showTitles( $titles, &$output)
Print out a list of linked titles.
Definition: SpecialEditWatchlist.php:291
TitleParser
A title parser service for MediaWiki.
Definition: TitleParser.php:33
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
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
SpecialPage\requireLogin
requireLogin( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
If the user is not logged in, throws UserNotLoggedIn error.
Definition: SpecialPage.php:336
$options
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:2001
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:562
SpecialEditWatchlist\getMode
static getMode( $request, $par)
Determine whether we are editing the watchlist, and if so, what kind of editing operation.
Definition: SpecialEditWatchlist.php:709
SpecialEditWatchlist\getSubpagesForPrefixSearch
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept.
Definition: SpecialEditWatchlist.php:172
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:712
SpecialEditWatchlist\cleanupWatchlist
cleanupWatchlist()
Attempts to clean up broken items.
Definition: SpecialEditWatchlist.php:433
SpecialEditWatchlist\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialEditWatchlist.php:75
WatchedItemStoreInterface\SORT_ASC
const SORT_ASC
Definition: WatchedItemStoreInterface.php:32
SpecialEditWatchlist\outputSubtitle
outputSubtitle()
Renders a subheader on the watchlist page.
Definition: SpecialEditWatchlist.php:138
SpecialEditWatchlist\$toc
$toc
Definition: SpecialEditWatchlist.php:52
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:907
SpecialEditWatchlist\buildTools
static buildTools( $lang, LinkRenderer $linkRenderer=null)
Build a set of links for convenient navigation between watchlist viewing and editing modes.
Definition: SpecialEditWatchlist.php:735
$args
if( $line===false) $args
Definition: cdb.php:64
Title
Represents a title within MediaWiki.
Definition: Title.php:39
SpecialEditWatchlist\getClearForm
getClearForm()
Get a form for clearing the watchlist.
Definition: SpecialEditWatchlist.php:686
MalformedTitleException
MalformedTitleException is thrown when a TitleParser is unable to parse a title string.
Definition: MalformedTitleException.php:25
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\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
NS_USER
const NS_USER
Definition: Defines.php:76
$batch
$batch
Definition: linkcache.txt:23
SpecialEditWatchlist\getNormalForm
getNormalForm()
Get the standard watchlist editing form.
Definition: SpecialEditWatchlist.php:536
SpecialEditWatchlist\watchTitles
watchTitles( $targets)
Add a list of targets to a user's watchlist.
Definition: SpecialEditWatchlist.php:462
class
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:56
SpecialPage\checkReadOnly
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
Definition: SpecialPage.php:319
SpecialPage\$linkRenderer
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
$request
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:2806
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
MediaWiki\Linker\LinkTarget
Definition: LinkTarget.php:26
SpecialEditWatchlist\getWatchlistInfo
getWatchlistInfo()
Get a list of titles on a user's watchlist, excluding talk pages, and return as a two-dimensional arr...
Definition: SpecialEditWatchlist.php:381
MWNamespace\getTalk
static getTalk( $index)
Get the talk namespace index for a given namespace.
Definition: MWNamespace.php:129
MWNamespace\getSubject
static getSubject( $index)
Get the subject namespace index for a given namespace Special namespaces (NS_MEDIA,...
Definition: MWNamespace.php:143
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
DeferredUpdates\addCallableUpdate
static addCallableUpdate( $callable, $stage=self::POSTSEND, $dbw=null)
Add a callable update.
Definition: DeferredUpdates.php:111
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
SpecialEditWatchlist\submitClear
submitClear( $data)
Definition: SpecialEditWatchlist.php:258
$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
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
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
Language
Internationalisation code.
Definition: Language.php:35
SpecialEditWatchlist\$successMessage
$successMessage
Definition: SpecialEditWatchlist.php:50
$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
TitleValue
Represents a page (or page fragment) title within MediaWiki.
Definition: TitleValue.php:35
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:130