SpecialEditWatchlist.php

Go to the documentation of this file.

<?php
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\MediaWikiServices;
 
class SpecialEditWatchlist extends UnlistedSpecialPage {
    public const EDIT_CLEAR = 1;
    public const EDIT_RAW = 2;
    public const EDIT_NORMAL = 3;
 
    protected $successMessage;
 
    protected $toc;
 
    private $badItems = [];
 
    private $titleParser;
 
    private $watchedItemStore;
 
    private $isWatchlistExpiryEnabled;
 
    public function __construct( WatchedItemStoreInterface $watchedItemStore ) {
        parent::__construct( 'EditWatchlist', 'editmywatchlist' );
        $this->watchedItemStore = $watchedItemStore;
        $this->isWatchlistExpiryEnabled = $this->getConfig()->get( 'WatchlistExpiry' );
    }
 
    private function initServices() {
        if ( !$this->titleParser ) {
            $this->titleParser = MediaWikiServices::getInstance()->getTitleParser();
        }
    }
 
    public function doesWrites() {
        return true;
    }
 
    public function execute( $mode ) {
        $this->initServices();
        $this->setHeaders();
 
        # Anons don't get a watchlist
        $this->requireLogin( 'watchlistanontext' );
 
        $out = $this->getOutput();
 
        $this->checkPermissions();
        $this->checkReadOnly();
 
        $this->outputHeader();
        $this->outputSubtitle();
        $out->addModuleStyles( 'mediawiki.special' );
 
        # B/C: $mode used to be waaay down the parameter list, and the first parameter
        # was $wgUser
        if ( $mode instanceof User ) {
            $args = func_get_args();
            if ( count( $args ) >= 4 ) {
                $mode = $args[3];
            }
        }
        $mode = self::getMode( $this->getRequest(), $mode );
 
        switch ( $mode ) {
            case self::EDIT_RAW:
                $out->setPageTitle( $this->msg( 'watchlistedit-raw-title' ) );
                $form = $this->getRawForm();
                if ( $form->show() ) {
                    $out->addHTML( $this->successMessage );
                    $out->addReturnTo( SpecialPage::getTitleFor( 'Watchlist' ) );
                }
                break;
            case self::EDIT_CLEAR:
                $out->setPageTitle( $this->msg( 'watchlistedit-clear-title' ) );
                $form = $this->getClearForm();
                if ( $form->show() ) {
                    $out->addHTML( $this->successMessage );
                    $out->addReturnTo( SpecialPage::getTitleFor( 'Watchlist' ) );
                }
                break;
 
            case self::EDIT_NORMAL:
            default:
                $this->executeViewEditWatchlist();
                break;
        }
    }
 
    protected function outputSubtitle() {
        $out = $this->getOutput();
        $out->addSubtitle( $this->msg( 'watchlistfor2', $this->getUser()->getName() )
            ->rawParams(
                self::buildTools(
                    $this->getLanguage(),
                    $this->getLinkRenderer()
                )
            )
        );
    }
 
    protected function executeViewEditWatchlist() {
        $out = $this->getOutput();
        $out->setPageTitle( $this->msg( 'watchlistedit-normal-title' ) );
        $form = $this->getNormalForm();
        if ( $form->show() ) {
            $out->addHTML( $this->successMessage );
            $out->addReturnTo( SpecialPage::getTitleFor( 'Watchlist' ) );
        } elseif ( $this->toc !== false ) {
            $out->prependHTML( $this->toc );
            $out->addModuleStyles( 'mediawiki.toc.styles' );
        }
    }
 
    public function getSubpagesForPrefixSearch() {
        // SpecialWatchlist uses SpecialEditWatchlist::getMode, so new types should be added
        // here and there - no 'edit' here, because that the default for this page
        return [
            'clear',
            'raw',
        ];
    }
 
    private function extractTitles( $list ) {
        $list = explode( "\n", trim( $list ) );
        if ( !is_array( $list ) ) {
            return [];
        }
 
        $titles = [];
 
        foreach ( $list as $text ) {
            $text = trim( $text );
            if ( strlen( $text ) > 0 ) {
                $title = Title::newFromText( $text );
                if ( $title instanceof Title && $title->isWatchable() ) {
                    $titles[] = $title;
                }
            }
        }
 
        MediaWikiServices::getInstance()->getGenderCache()->doTitlesArray( $titles );
 
        $list = [];
        foreach ( $titles as $title ) {
            $list[] = $title->getPrefixedText();
        }
 
        return array_unique( $list );
    }
 
    public function submitRaw( $data ) {
        $wanted = $this->extractTitles( $data['Titles'] );
        $current = $this->getWatchlist();
 
        if ( count( $wanted ) > 0 ) {
            $toWatch = array_diff( $wanted, $current );
            $toUnwatch = array_diff( $current, $wanted );
            $this->watchTitles( $toWatch );
            $this->unwatchTitles( $toUnwatch );
            $this->getUser()->invalidateCache();
 
            if ( count( $toWatch ) > 0 || count( $toUnwatch ) > 0 ) {
                $this->successMessage = $this->msg( 'watchlistedit-raw-done' )->parse();
            } else {
                return false;
            }
 
            if ( count( $toWatch ) > 0 ) {
                $this->successMessage .= ' ' . $this->msg( 'watchlistedit-raw-added' )
                    ->numParams( count( $toWatch ) )->parse();
                $this->showTitles( $toWatch, $this->successMessage );
            }
 
            if ( count( $toUnwatch ) > 0 ) {
                $this->successMessage .= ' ' . $this->msg( 'watchlistedit-raw-removed' )
                    ->numParams( count( $toUnwatch ) )->parse();
                $this->showTitles( $toUnwatch, $this->successMessage );
            }
        } else {
 
            if ( count( $current ) === 0 ) {
                return false;
            }
 
            $this->clearUserWatchedItems( 'raw' );
            $this->showTitles( $current, $this->successMessage );
        }
 
        return true;
    }
 
    public function submitClear( $data ): bool {
        $this->clearUserWatchedItems( 'clear' );
        return true;
    }
 
    private function clearUserWatchedItems( string $messageFor ): void {
        if ( $this->watchedItemStore->mustClearWatchedItemsUsingJobQueue( $this->getUser() ) ) {
            $this->clearUserWatchedItemsUsingJobQueue();
        } else {
            $this->clearUserWatchedItemsNow( $messageFor );
        }
    }
 
    private function clearUserWatchedItemsNow( string $messageFor ): void {
        $current = $this->getWatchlist();
        if ( !$this->watchedItemStore->clearUserWatchedItems( $this->getUser() ) ) {
            throw new LogicException(
                __METHOD__ . ' should only be called when able to clear synchronously'
            );
        }
        $this->successMessage = $this->msg( 'watchlistedit-' . $messageFor . '-done' )->parse();
        $this->successMessage .= ' ' . $this->msg( 'watchlistedit-' . $messageFor . '-removed' )
                ->numParams( count( $current ) )->parse();
        $this->getUser()->invalidateCache();
        $this->showTitles( $current, $this->successMessage );
    }
 
    private function clearUserWatchedItemsUsingJobQueue(): void {
        $this->watchedItemStore->clearUserWatchedItemsUsingJobQueue( $this->getUser() );
        $this->successMessage = $this->msg( 'watchlistedit-clear-jobqueue' )->parse();
    }
 
    private function showTitles( $titles, &$output ) {
        $talk = $this->msg( 'talkpagelinktext' )->text();
        // Do a batch existence check
        $batch = new LinkBatch();
        if ( count( $titles ) >= 100 ) {
            $output = $this->msg( 'watchlistedit-too-many' )->parse();
            return;
        }
        foreach ( $titles as $title ) {
            if ( !$title instanceof Title ) {
                $title = Title::newFromText( $title );
            }
 
            if ( $title instanceof Title ) {
                $batch->addObj( $title );
                $batch->addObj( $title->getTalkPage() );
            }
        }
 
        $batch->execute();
 
        // Print out the list
        $output .= "<ul>\n";
 
        $linkRenderer = $this->getLinkRenderer();
        foreach ( $titles as $title ) {
            if ( !$title instanceof Title ) {
                $title = Title::newFromText( $title );
            }
 
            if ( $title instanceof Title ) {
                $output .= '<li>' .
                    $linkRenderer->makeLink( $title ) . ' ' .
                    $this->msg( 'parentheses' )->rawParams(
                        $linkRenderer->makeLink( $title->getTalkPage(), $talk )
                    )->escaped() .
                    "</li>\n";
            }
        }
 
        $output .= "</ul>\n";
    }
 
    private function getWatchlist() {
        $list = [];
 
        $watchedItems = $this->watchedItemStore->getWatchedItemsForUser(
            $this->getUser(),
            [ 'forWrite' => $this->getRequest()->wasPosted() ]
        );
 
        if ( $watchedItems ) {
            $titles = [];
            foreach ( $watchedItems as $watchedItem ) {
                $namespace = $watchedItem->getLinkTarget()->getNamespace();
                $dbKey = $watchedItem->getLinkTarget()->getDBkey();
                $title = Title::makeTitleSafe( $namespace, $dbKey );
 
                if ( $this->checkTitle( $title, $namespace, $dbKey )
                    && !$title->isTalkPage()
                ) {
                    $titles[] = $title;
                }
            }
 
            MediaWikiServices::getInstance()->getGenderCache()->doTitlesArray( $titles );
 
            foreach ( $titles as $title ) {
                $list[] = $title->getPrefixedText();
            }
        }
 
        $this->cleanupWatchlist();
 
        return $list;
    }
 
    protected function getWatchlistInfo() {
        $titles = [];
        $services = MediaWikiServices::getInstance();
        $options = [ 'sort' => WatchedItemStore::SORT_ASC ];
 
        if ( $this->isWatchlistExpiryEnabled ) {
            $options[ 'sortByExpiry'] = true;
        }
 
        $watchedItems = $this->watchedItemStore->getWatchedItemsForUser(
            $this->getUser(), $options
        );
 
        $lb = new LinkBatch();
        $context = $this->getContext();
 
        foreach ( $watchedItems as $watchedItem ) {
            $namespace = $watchedItem->getLinkTarget()->getNamespace();
            $dbKey = $watchedItem->getLinkTarget()->getDBkey();
            $lb->add( $namespace, $dbKey );
            if ( !$services->getNamespaceInfo()->isTalk( $namespace ) ) {
                $titles[$namespace][$dbKey] = $watchedItem->getExpiryInDaysText( $context );
            }
        }
 
        $lb->execute();
 
        return $titles;
    }
 
    private function checkTitle( $title, $namespace, $dbKey ) {
        if ( $title
            && ( $title->isExternal()
                || $title->getNamespace() < 0
            )
        ) {
            $title = false; // unrecoverable
        }
 
        if ( !$title
            || $title->getNamespace() != $namespace
            || $title->getDBkey() != $dbKey
        ) {
            $this->badItems[] = [ $title, $namespace, $dbKey ];
        }
 
        return (bool)$title;
    }
 
    private function cleanupWatchlist() {
        if ( $this->badItems === [] ) {
            return; // nothing to do
        }
 
        $user = $this->getUser();
        $badItems = $this->badItems;
        DeferredUpdates::addCallableUpdate( function () use ( $user, $badItems ) {
            foreach ( $badItems as $row ) {
                list( $title, $namespace, $dbKey ) = $row;
                $action = $title ? 'cleaning up' : 'deleting';
                wfDebug( "User {$user->getName()} has broken watchlist item " .
                    "ns($namespace):$dbKey, $action." );
 
                // NOTE: We *know* that the title is invalid. TitleValue may refuse instantiation.
                // XXX: We may need an InvalidTitleValue class that allows instantiation of
                //      known bad title values.
                $this->watchedItemStore->removeWatch( $user, Title::makeTitle( (int)$namespace, $dbKey ) );
                // Can't just do an UPDATE instead of DELETE/INSERT due to unique index
                if ( $title ) {
                    $user->addWatch( $title );
                }
            }
        } );
    }
 
    private function watchTitles( array $targets ) {
        return $this->watchedItemStore->addWatchBatchForUser(
                $this->getUser(), $this->getExpandedTargets( $targets )
            ) && $this->runWatchUnwatchCompleteHook( 'Watch', $targets );
    }
 
    private function unwatchTitles( array $targets ) {
        return $this->watchedItemStore->removeWatchBatchForUser(
                $this->getUser(), $this->getExpandedTargets( $targets )
            ) && $this->runWatchUnwatchCompleteHook( 'Unwatch', $targets );
    }
 
    private function runWatchUnwatchCompleteHook( $action, $targets ) {
        foreach ( $targets as $target ) {
            $title = $target instanceof TitleValue ?
                Title::newFromTitleValue( $target ) :
                Title::newFromText( $target );
            $page = WikiPage::factory( $title );
            $user = $this->getUser();
            if ( $action === 'Watch' ) {
                $this->getHookRunner()->onWatchArticleComplete( $user, $page );
            } else {
                $this->getHookRunner()->onUnwatchArticleComplete( $user, $page );
            }
        }
        return true;
    }
 
    private function getExpandedTargets( array $targets ) {
        $expandedTargets = [];
        $services = MediaWikiServices::getInstance();
        foreach ( $targets as $target ) {
            if ( !$target instanceof LinkTarget ) {
                try {
                    $target = $this->titleParser->parseTitle( $target, NS_MAIN );
                }
                catch ( MalformedTitleException $e ) {
                    continue;
                }
            }
 
            $ns = $target->getNamespace();
            $dbKey = $target->getDBkey();
            $expandedTargets[] =
                new TitleValue( $services->getNamespaceInfo()->getSubject( $ns ), $dbKey );
            $expandedTargets[] =
                new TitleValue( $services->getNamespaceInfo()->getTalk( $ns ), $dbKey );
        }
        return $expandedTargets;
    }
 
    public function submitNormal( $data ) {
        $removed = [];
 
        foreach ( $data as $titles ) {
            $this->unwatchTitles( $titles );
            $removed = array_merge( $removed, $titles );
        }
 
        if ( count( $removed ) > 0 ) {
            $this->successMessage = $this->msg( 'watchlistedit-normal-done'
            )->numParams( count( $removed ) )->parse();
            $this->showTitles( $removed, $this->successMessage );
 
            return true;
        } else {
            return false;
        }
    }
 
    protected function getNormalForm() {
        $fields = [];
        $count = 0;
 
        // Allow subscribers to manipulate the list of watched pages (or use it
        // to preload lots of details at once)
        $watchlistInfo = $this->getWatchlistInfo();
        $this->getHookRunner()->onWatchlistEditorBeforeFormRender( $watchlistInfo );
 
        foreach ( $watchlistInfo as $namespace => $pages ) {
            $options = [];
            foreach ( $pages as $dbkey => $expiryDaysText ) {
                $title = Title::makeTitleSafe( $namespace, $dbkey );
 
                if ( $this->checkTitle( $title, $namespace, $dbkey ) ) {
                    $text = $this->buildRemoveLine( $title, $expiryDaysText );
                    $options[$text] = $title->getPrefixedText();
                    $count++;
                }
            }
 
            // checkTitle can filter some options out, avoid empty sections
            if ( count( $options ) > 0 ) {
                $fields['TitlesNs' . $namespace] = [
                    'class' => EditWatchlistCheckboxSeriesField::class,
                    'options' => $options,
                    'section' => "ns$namespace",
                ];
            }
        }
        $this->cleanupWatchlist();
 
        if ( count( $fields ) > 1 && $count > 30 ) {
            $this->toc = Linker::tocIndent();
            $tocLength = 0;
            $contLang = MediaWikiServices::getInstance()->getContentLanguage();
 
            foreach ( $fields as $data ) {
                # strip out the 'ns' prefix from the section name:
                $ns = substr( $data['section'], 2 );
 
                $nsText = ( $ns == NS_MAIN )
                    ? $this->msg( 'blanknamespace' )->escaped()
                    : htmlspecialchars( $contLang->getFormattedNsText( $ns ) );
                $this->toc .= Linker::tocLine( "editwatchlist-{$data['section']}", $nsText,
                    $this->getLanguage()->formatNum( ++$tocLength ), 1 ) . Linker::tocLineEnd();
            }
 
            $this->toc = Linker::tocList( $this->toc );
        } else {
            $this->toc = false;
        }
 
        $context = new DerivativeContext( $this->getContext() );
        $context->setTitle( $this->getPageTitle() ); // Remove subpage
        $form = new EditWatchlistNormalHTMLForm( $fields, $context );
        $form->setSubmitTextMsg( 'watchlistedit-normal-submit' );
        $form->setSubmitDestructive();
        # Used message keys:
        # 'accesskey-watchlistedit-normal-submit', 'tooltip-watchlistedit-normal-submit'
        $form->setSubmitTooltip( 'watchlistedit-normal-submit' );
        $form->setWrapperLegendMsg( 'watchlistedit-normal-legend' );
        $form->addHeaderText( $this->msg( 'watchlistedit-normal-explain' )->parse() );
        $form->setSubmitCallback( [ $this, 'submitNormal' ] );
 
        return $form;
    }
 
    private function buildRemoveLine( $title, string $expiryDaysText = '' ): string {
        $linkRenderer = $this->getLinkRenderer();
        $link = $linkRenderer->makeLink( $title );
 
        $tools = [];
        $tools['talk'] = $linkRenderer->makeLink(
            $title->getTalkPage(),
            $this->msg( 'talkpagelinktext' )->text()
        );
 
        if ( $title->exists() ) {
            $tools['history'] = $linkRenderer->makeKnownLink(
                $title,
                $this->msg( 'history_small' )->text(),
                [],
                [ 'action' => 'history' ]
            );
        }
 
        if ( $title->getNamespace() == NS_USER && !$title->isSubpage() ) {
            $tools['contributions'] = $linkRenderer->makeKnownLink(
                SpecialPage::getTitleFor( 'Contributions', $title->getText() ),
                $this->msg( 'contribslink' )->text()
            );
        }
 
        $this->getHookRunner()->onWatchlistEditorBuildRemoveLine(
            $tools, $title, $title->isRedirect(), $this->getSkin(), $link );
 
        if ( $title->isRedirect() ) {
            // Linker already makes class mw-redirect, so this is redundant
            $link = '<span class="watchlistredir">' . $link . '</span>';
        }
 
        $watchlistExpiringMessage = '';
        if ( $this->isWatchlistExpiryEnabled && $expiryDaysText ) {
            $watchlistExpiringMessage = Html::element(
                'span',
                [ 'class' => 'watchlistexpiry-msg' ],
                $expiryDaysText
            );
        }
 
        return $link . ' ' .
            $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList( $tools ) )->escaped() .
            $watchlistExpiringMessage;
    }
 
    protected function getRawForm() {
        $titles = implode( "\n", $this->getWatchlist() );
        $fields = [
            'Titles' => [
                'type' => 'textarea',
                'label-message' => 'watchlistedit-raw-titles',
                'default' => $titles,
            ],
        ];
        $context = new DerivativeContext( $this->getContext() );
        $context->setTitle( $this->getPageTitle( 'raw' ) ); // Reset subpage
        $form = new OOUIHTMLForm( $fields, $context );
        $form->setSubmitTextMsg( 'watchlistedit-raw-submit' );
        # Used message keys: 'accesskey-watchlistedit-raw-submit', 'tooltip-watchlistedit-raw-submit'
        $form->setSubmitTooltip( 'watchlistedit-raw-submit' );
        $form->setWrapperLegendMsg( 'watchlistedit-raw-legend' );
        $form->addHeaderText( $this->msg( 'watchlistedit-raw-explain' )->parse() );
        $form->setSubmitCallback( [ $this, 'submitRaw' ] );
 
        return $form;
    }
 
    protected function getClearForm() {
        $context = new DerivativeContext( $this->getContext() );
        $context->setTitle( $this->getPageTitle( 'clear' ) ); // Reset subpage
        $form = new OOUIHTMLForm( [], $context );
        $form->setSubmitTextMsg( 'watchlistedit-clear-submit' );
        # Used message keys: 'accesskey-watchlistedit-clear-submit', 'tooltip-watchlistedit-clear-submit'
        $form->setSubmitTooltip( 'watchlistedit-clear-submit' );
        $form->setWrapperLegendMsg( 'watchlistedit-clear-legend' );
        $form->addHeaderText( $this->msg( 'watchlistedit-clear-explain' )->parse() );
        $form->setSubmitCallback( [ $this, 'submitClear' ] );
        $form->setSubmitDestructive();
 
        return $form;
    }
 
    public static function getMode( $request, $par ) {
        $mode = strtolower( $request->getVal( 'action', $par ?? '' ) );
 
        switch ( $mode ) {
            case 'clear':
            case self::EDIT_CLEAR:
                return self::EDIT_CLEAR;
            case 'raw':
            case self::EDIT_RAW:
                return self::EDIT_RAW;
            case 'edit':
            case self::EDIT_NORMAL:
                return self::EDIT_NORMAL;
            default:
                return false;
        }
    }
 
    public static function buildTools( $lang, LinkRenderer $linkRenderer = null ) {
        if ( !$lang instanceof Language ) {
            // back-compat where the first parameter was $unused
            global $wgLang;
            $lang = $wgLang;
        }
        if ( !$linkRenderer ) {
            $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
        }
 
        $tools = [];
        $modes = [
            'view' => [ 'Watchlist', false ],
            'edit' => [ 'EditWatchlist', false ],
            'raw' => [ 'EditWatchlist', 'raw' ],
            'clear' => [ 'EditWatchlist', 'clear' ],
        ];
 
        foreach ( $modes as $mode => $arr ) {
            // can use messages 'watchlisttools-view', 'watchlisttools-edit', 'watchlisttools-raw'
            $tools[] = $linkRenderer->makeKnownLink(
                SpecialPage::getTitleFor( $arr[0], $arr[1] ),
                wfMessage( "watchlisttools-{$mode}" )->text()
            );
        }
 
        return Html::rawElement(
            'span',
            [ 'class' => 'mw-watchlist-toollinks' ],
            wfMessage( 'parentheses' )->rawParams( $lang->pipeList( $tools ) )->escaped()
        );
    }
}