Go to the documentation of this file.
62 parent::__construct(
'EditWatchlist',
'editmywatchlist' );
70 if ( !$this->titleParser ) {
71 $this->titleParser = MediaWikiServices::getInstance()->getTitleParser();
88 # Anons don't get a watchlist
98 $out->addModuleStyles(
'mediawiki.special' );
100 # B/C: $mode used to be waaay down the parameter list, and the first parameter
102 if ( $mode instanceof
User ) {
103 $args = func_get_args();
112 $out->setPageTitle( $this->
msg(
'watchlistedit-raw-title' ) );
114 if ( $form->show() ) {
115 $out->addHTML( $this->successMessage );
120 $out->setPageTitle( $this->
msg(
'watchlistedit-clear-title' ) );
122 if ( $form->show() ) {
123 $out->addHTML( $this->successMessage );
155 $out->setPageTitle( $this->
msg(
'watchlistedit-normal-title' ) );
157 if ( $form->show() ) {
158 $out->addHTML( $this->successMessage );
160 } elseif ( $this->toc !==
false ) {
161 $out->prependHTML( $this->toc );
162 $out->addModuleStyles(
'mediawiki.toc.styles' );
189 $list = explode(
"\n", trim( $list ) );
190 if ( !is_array( $list ) ) {
196 foreach ( $list
as $text ) {
197 $text = trim( $text );
198 if ( strlen( $text ) > 0 ) {
206 MediaWikiServices::getInstance()->getGenderCache()->doTitlesArray(
$titles );
211 $list[] =
$title->getPrefixedText();
214 return array_unique( $list );
221 if (
count( $wanted ) > 0 ) {
222 $toWatch = array_diff( $wanted, $current );
223 $toUnwatch = array_diff( $current, $wanted );
226 $this->
getUser()->invalidateCache();
228 if (
count( $toWatch ) > 0 ||
count( $toUnwatch ) > 0 ) {
229 $this->successMessage = $this->
msg(
'watchlistedit-raw-done' )->parse();
234 if (
count( $toWatch ) > 0 ) {
235 $this->successMessage .=
' ' . $this->
msg(
'watchlistedit-raw-added' )
236 ->numParams(
count( $toWatch ) )->parse();
237 $this->
showTitles( $toWatch, $this->successMessage );
240 if (
count( $toUnwatch ) > 0 ) {
241 $this->successMessage .=
' ' . $this->
msg(
'watchlistedit-raw-removed' )
242 ->numParams(
count( $toUnwatch ) )->parse();
243 $this->
showTitles( $toUnwatch, $this->successMessage );
247 if (
count( $current ) === 0 ) {
252 $this->
showTitles( $current, $this->successMessage );
261 $this->
showTitles( $current, $this->successMessage );
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();
277 $watchedItemStore->clearUserWatchedItemsUsingJobQueue( $this->
getUser() );
278 $this->successMessage = $this->
msg(
'watchlistedit-clear-jobqueue' )->parse();
292 $talk = $this->
msg(
'talkpagelinktext' )->text();
296 $output = $this->
msg(
'watchlistedit-too-many' )->parse();
300 if ( !$title instanceof
Title ) {
324 $this->
msg(
'parentheses' )->rawParams(
343 $watchedItems = MediaWikiServices::getInstance()->getWatchedItemStore()->getWatchedItemsForUser(
345 [
'forWrite' => $this->
getRequest()->wasPosted() ]
348 if ( $watchedItems ) {
351 foreach ( $watchedItems
as $watchedItem ) {
352 $namespace = $watchedItem->getLinkTarget()->getNamespace();
353 $dbKey = $watchedItem->getLinkTarget()->getDBkey();
363 MediaWikiServices::getInstance()->getGenderCache()->doTitlesArray(
$titles );
366 $list[] =
$title->getPrefixedText();
384 $watchedItems = MediaWikiServices::getInstance()->getWatchedItemStore()
389 foreach ( $watchedItems
as $watchedItem ) {
390 $namespace = $watchedItem->getLinkTarget()->getNamespace();
391 $dbKey = $watchedItem->getLinkTarget()->getDBkey();
392 $lb->add( $namespace, $dbKey );
394 $titles[$namespace][$dbKey] = 1;
414 ||
$title->getNamespace() < 0
421 ||
$title->getNamespace() != $namespace
422 ||
$title->getDBkey() != $dbKey
424 $this->badItems[] = [
$title, $namespace, $dbKey ];
434 if ( $this->badItems === [] ) {
441 $store = MediaWikiServices::getInstance()->getWatchedItemStore();
444 $action =
$title ?
'cleaning up' :
'deleting';
445 wfDebug(
"User {$user->getName()} has broken watchlist item " .
446 "ns($namespace):$dbKey, $action.\n" );
448 $store->removeWatch(
$user,
new TitleValue( (
int)$namespace, $dbKey ) );
466 return MediaWikiServices::getInstance()->getWatchedItemStore()
484 return MediaWikiServices::getInstance()->getWatchedItemStore()
498 foreach ( $targets
as $target ) {
513 $expandedTargets = [];
514 foreach ( $targets
as $target ) {
517 $target = $this->titleParser->parseTitle( $target,
NS_MAIN );
524 $ns = $target->getNamespace();
525 $dbKey = $target->getDBkey();
529 return $expandedTargets;
537 $removed = array_merge( $removed,
$titles );
540 if (
count( $removed ) > 0 ) {
541 $this->successMessage = $this->
msg(
'watchlistedit-normal-done'
542 )->numParams(
count( $removed ) )->parse();
543 $this->
showTitles( $removed, $this->successMessage );
564 'WatchlistEditorBeforeFormRender',
568 foreach ( $watchlistInfo
as $namespace => $pages ) {
571 foreach ( array_keys( $pages )
as $dbkey ) {
583 $fields[
'TitlesNs' . $namespace] = [
586 'section' =>
"ns$namespace",
592 if (
count( $fields ) > 1 && $count > 30 ) {
595 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
598 # strip out the 'ns' prefix from the section name:
599 $ns = substr(
$data[
'section'], 2 );
602 ? $this->
msg(
'blanknamespace' )->escaped()
603 : htmlspecialchars( $contLang->getFormattedNsText( $ns ) );
604 $this->toc .=
Linker::tocLine(
"editwatchlist-{$data['section']}", $nsText,
616 $form->setSubmitTextMsg(
'watchlistedit-normal-submit' );
617 $form->setSubmitDestructive();
619 # 'accesskey-watchlistedit-normal-submit', 'tooltip-watchlistedit-normal-submit'
620 $form->setSubmitTooltip(
'watchlistedit-normal-submit' );
621 $form->setWrapperLegendMsg(
'watchlistedit-normal-legend' );
622 $form->addHeaderText( $this->
msg(
'watchlistedit-normal-explain' )->parse() );
623 $form->setSubmitCallback( [ $this,
'submitNormal' ] );
640 $this->
msg(
'talkpagelinktext' )->text()
646 $this->
msg(
'history_small' )->
text(),
648 [
'action' =>
'history' ]
655 $this->
msg(
'contribslink' )->text()
660 'WatchlistEditorBuildRemoveLine',
664 if (
$title->isRedirect() ) {
666 $link =
'<span class="watchlistredir">' .
$link .
'</span>';
670 $this->
msg(
'parentheses' )->rawParams( $this->
getLanguage()->pipeList( $tools ) )->escaped();
682 'type' =>
'textarea',
683 'label-message' =>
'watchlistedit-raw-titles',
690 $form->setSubmitTextMsg(
'watchlistedit-raw-submit' );
691 # Used message keys: 'accesskey-watchlistedit-raw-submit', 'tooltip-watchlistedit-raw-submit'
692 $form->setSubmitTooltip(
'watchlistedit-raw-submit' );
693 $form->setWrapperLegendMsg(
'watchlistedit-raw-legend' );
694 $form->addHeaderText( $this->
msg(
'watchlistedit-raw-explain' )->parse() );
695 $form->setSubmitCallback( [ $this,
'submitRaw' ] );
709 $form->setSubmitTextMsg(
'watchlistedit-clear-submit' );
710 # Used message keys: 'accesskey-watchlistedit-clear-submit', 'tooltip-watchlistedit-clear-submit'
711 $form->setSubmitTooltip(
'watchlistedit-clear-submit' );
712 $form->setWrapperLegendMsg(
'watchlistedit-clear-legend' );
713 $form->addHeaderText( $this->
msg(
'watchlistedit-clear-explain' )->parse() );
714 $form->setSubmitCallback( [ $this,
'submitClear' ] );
715 $form->setSubmitDestructive();
729 $mode = strtolower(
$request->getVal(
'action', $par ) );
761 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
766 'view' => [
'Watchlist',
false ],
767 'edit' => [
'EditWatchlist',
false ],
768 'raw' => [
'EditWatchlist',
'raw' ],
769 'clear' => [
'EditWatchlist',
'clear' ],
772 foreach ( $modes
as $mode => $arr ) {
780 return Html::rawElement(
782 [
'class' =>
'mw-watchlist-toollinks' ],
783 wfMessage(
'parentheses' )->rawParams(
$lang->pipeList( $tools ) )->escaped()
getPageTitle( $subpage=false)
Get a self-referential title object.
const EDIT_CLEAR
Editing modes.
unwatchTitles(array $targets)
Remove a list of titles from a user's watchlist.
return true to allow those checks to and false if checking is done & $user
getWatchlist()
Prepare a list of titles on a user's watchlist (excluding talk pages) and return an array of (prefixe...
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
msg( $key)
Wrapper around wfMessage that sets the current context.
processing should stop and the error should be shown to the user * false
checkTitle( $title, $namespace, $dbKey)
Validates watchlist entry.
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
static isTalk( $index)
Is the given namespace a talk namespace?
initServices()
Initialize any services we'll need (unless it has already been provided via a setter).
Class representing a list of titles The execute() method checks them all for existence and adds them ...
getOutput()
Get the OutputPage being used for this instance.
if(!isset( $args[0])) $lang
Shortcut to construct a special page which is unlisted by default.
static tocIndent()
Add another level to the Table of Contents.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
buildRemoveLine( $title)
Build the label for a checkbox, with a link to the title, and various additional bits.
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,...
watchTitles(array $targets)
Add a list of targets to a user's watchlist.
getSkin()
Shortcut to get the skin being used for this instance.
getExpandedTargets(array $targets)
getLanguage()
Shortcut to get user's language.
getName()
Get the name of this Special Page.
clearUserWatchedItems( $current, $messageFor)
static tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex=false)
parameter level defines if we are on an indentation level
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
runWatchUnwatchCompleteHook( $action, $targets)
execute( $mode)
Main execution point.
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
An IContextSource implementation which will inherit context from another source but allow individual ...
static tocList( $toc, $lang=null)
Wraps the TOC in a table and provides the hide/collapse javascript.
namespace and then decline to actually register it file or subcat img or subcat $title
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
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
getRawForm()
Get a form for editing the watchlist in "raw" mode.
executeViewEditWatchlist()
Executes an edit mode for the watchlist view, from which you can manage your watchlist.
extractTitles( $list)
Extract a list of titles from a blob of text, returning (prefixed) strings; unwatchable titles are ig...
static tocLineEnd()
End a Table Of Contents line.
Provides the UI through which users can perform editing operations on their watchlist.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getUser()
Shortcut to get the User executing this instance.
showTitles( $titles, &$output)
Print out a list of linked titles.
A title parser service for MediaWiki.
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))
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
getContext()
Gets the context this SpecialPage is executed in.
requireLogin( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
If the user is not logged in, throws UserNotLoggedIn error.
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
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
static getMode( $request, $par)
Determine whether we are editing the watchlist, and if so, what kind of editing operation.
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept.
getRequest()
Get the WebRequest being used for this instance.
cleanupWatchlist()
Attempts to clean up broken items.
doesWrites()
Indicates whether this special page may perform database writes.
outputSubtitle()
Renders a subheader on the watchlist page.
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
static buildTools( $lang, LinkRenderer $linkRenderer=null)
Build a set of links for convenient navigation between watchlist viewing and editing modes.
Represents a title within MediaWiki.
getClearForm()
Get a form for clearing the watchlist.
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
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
usually copyright or history_copyright This message must be in HTML not wikitext & $link
getNormalForm()
Get the standard watchlist editing form.
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
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
MediaWiki Linker LinkRenderer null $linkRenderer
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
getWatchlistInfo()
Get a list of titles on a user's watchlist, excluding talk pages, and return as a two-dimensional arr...
static getTalk( $index)
Get the talk namespace index for a given namespace.
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 "<
static getSubject( $index)
Get the subject namespace index for a given namespace Special namespaces (NS_MEDIA,...
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
static addCallableUpdate( $callable, $stage=self::POSTSEND, $dbw=null)
Add a callable update.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Internationalisation code.
Represents a page (or page fragment) title within MediaWiki.
static newFromTitleValue(TitleValue $titleValue, $forceClone='')
Returns a Title given a TitleValue.