SpecialPageTranslationDeletePage.php

Go to the documentation of this file.

<?php
class SpecialPageTranslationDeletePage extends UnlistedSpecialPage {
    // Basic form parameters both as text and as titles
    protected $text;

    protected $title;

    // Other form parameters
    protected $subaction;

    protected $reason;

    protected $doSubpages = false;

    protected $page;

    protected $code;

    protected $sectionPages;

    protected $translationPages;

    public function __construct() {
        parent::__construct( 'PageTranslationDeletePage' );
    }

    public function execute( $par ) {
        $request = $this->getRequest();

        // Yes, the use of getVal() and getText() is wanted, see bug 20365
        $this->text = $request->getVal( 'wpTitle', $par );
        $this->title = Title::newFromText( $this->text );
        $this->reason = $request->getText( 'reason' );
        // Checkboxes that default being checked are tricky
        $this->doSubpages = $request->getBool( 'subpages', !$request->wasPosted() );

        $user = $this->getUser();

        if ( $this->doBasicChecks() !== true ) {
            return;
        }

        $out = $this->getOutput();

        // Real stuff starts here
        if ( TranslatablePage::isSourcePage( $this->title ) ) {
            $title = $this->msg( 'pt-deletepage-full-title', $this->title->getPrefixedText() );
            $out->setPagetitle( $title );

            $this->code = '';
            $this->page = TranslatablePage::newFromTitle( $this->title );
        } else {
            $page = TranslatablePage::isTranslationPage( $this->title );
            if ( $page ) {
                $title = $this->msg( 'pt-deletepage-lang-title', $this->title->getPrefixedText() );
                $out->setPagetitle( $title );

                list( , $this->code ) = TranslateUtils::figureMessage( $this->title->getText() );
                $this->page = $page;
            } else {
                throw new ErrorPageError(
                    'pt-deletepage-invalid-title',
                    'pt-deletepage-invalid-text'
                );
            }
        }

        if ( !$user->isAllowed( 'pagetranslation' ) ) {
            throw new PermissionsError( 'pagetranslation' );
        }

        // Is there really no better way to do this?
        $subactionText = $request->getText( 'subaction' );
        switch ( $subactionText ) {
            case $this->msg( 'pt-deletepage-action-check' )->text():
                $subaction = 'check';
                break;
            case $this->msg( 'pt-deletepage-action-perform' )->text():
                $subaction = 'perform';
                break;
            case $this->msg( 'pt-deletepage-action-other' )->text():
                $subaction = '';
                break;
            default:
                $subaction = '';
        }

        if ( $subaction === 'check' && $this->checkToken() && $request->wasPosted() ) {
            $this->showConfirmation();
        } elseif ( $subaction === 'perform' && $this->checkToken() && $request->wasPosted() ) {
            $this->performAction();
        } else {
            $this->showForm();
        }
    }

    protected function doBasicChecks() {
        # Check for database lock
        if ( wfReadOnly() ) {
            throw new ReadOnlyError;
        }

        if ( $this->title === null ) {
            throw new ErrorPageError( 'notargettitle', 'notargettext' );
        }

        if ( !$this->title->exists() ) {
            throw new ErrorPageError( 'nopagetitle', 'nopagetext' );
        }

        # Check rights
        $permErrors = $this->title->getUserPermissionsErrors( 'delete', $this->getUser() );
        if ( !empty( $permErrors ) ) {
            throw new PermissionsError( 'delete', $permErrors );
        }

        // Let the caller know it's safe to continue
        return true;
    }

    protected function checkToken() {
        return $this->getUser()->matchEditToken( $this->getRequest()->getVal( 'wpEditToken' ) );
    }

    protected function showForm() {
        $this->getOutput()->addWikiMsg( 'pt-deletepage-intro' );

        $subaction = array( 'name' => 'subaction' );
        $formParams = array(
            'method' => 'post',
            'action' => $this->getTitle( $this->text )->getLocalURL()
        );

        $form = array();
        $form[] = Xml::fieldset( $this->msg( 'pt-deletepage-any-legend' )->text() );
        $form[] = Html::openElement( 'form', $formParams );
        $form[] = Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
        $this->addInputLabel(
            $form,
            $this->msg( 'pt-deletepage-current' )->text(),
            'wpTitle',
            30,
            $this->text
        );
        $this->addInputLabel(
            $form,
            $this->msg( 'pt-deletepage-reason' )->text(),
            'reason',
            60,
            $this->reason
        );
        $form[] = Xml::submitButton(
            $this->msg( 'pt-deletepage-action-check' )->text(),
            $subaction
        );
        $form[] = Xml::closeElement( 'form' );
        $form[] = Xml::closeElement( 'fieldset' );
        $this->getOutput()->addHTML( implode( "\n", $form ) );
    }

    protected function addInputLabel( &$form, $label, $name, $size = false, $text = false,
        $attribs = array()
    ) {
        $br = Html::element( 'br' );
        list( $label, $input ) = Xml::inputLabelSep( $label, $name, $name, $size, $text, $attribs );
        $form[] = $label . $br;
        $form[] = $input . $br;
    }

    protected function showConfirmation() {
        $out = $this->getOutput();

        $out->addWikiMsg( 'pt-deletepage-intro' );

        $count = 1; // Base page

        $out->wrapWikiMsg( '== $1 ==', 'pt-deletepage-list-pages' );
        if ( !$this->singleLanguage() ) {
            $this->printChangeLine( $this->title );
        }

        $out->wrapWikiMsg( '=== $1 ===', 'pt-deletepage-list-translation' );
        $translationPages = $this->getTranslationPages();
        foreach ( $translationPages as $old ) {
            $count++;
            $this->printChangeLine( $old );
        }

        $out->wrapWikiMsg( '=== $1 ===', 'pt-deletepage-list-section' );
        $sectionPages = $this->getSectionPages();
        foreach ( $sectionPages as $old ) {
            $count++;
            $this->printChangeLine( $old );
        }

        $out->wrapWikiMsg( '=== $1 ===', 'pt-deletepage-list-other' );
        $subpages = $this->getSubpages();
        foreach ( $subpages as $old ) {
            if ( TranslatablePage::isTranslationPage( $old ) ) {
                continue;
            }

            if ( $this->doSubpages ) {
                $count++;
            }

            $this->printChangeLine( $old, $this->doSubpages );
        }

        $out->addWikiText( "----\n" );
        $out->addWikiMsg( 'pt-deletepage-list-count', $this->getLanguage()->formatNum( $count ) );

        $br = Html::element( 'br' );
        $readonly = array( 'readonly' => 'readonly' );

        $subaction = array( 'name' => 'subaction' );
        $formParams = array(
            'method' => 'post',
            'action' => $this->getTitle( $this->text )->getLocalURL()
        );

        $form = array();
        if ( $this->singleLanguage() ) {
            $form[] = Xml::fieldset( $this->msg( 'pt-deletepage-lang-legend' )->text() );
        } else {
            $form[] = Xml::fieldset( $this->msg( 'pt-deletepage-full-legend' )->text() );
        }
        $form[] = Html::openElement( 'form', $formParams );
        $form[] = Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
        $this->addInputLabel(
            $form,
            $this->msg( 'pt-deletepage-current' )->text(),
            'wpTitle',
            30,
            $this->text, $readonly );
        $this->addInputLabel(
            $form,
            $this->msg( 'pt-deletepage-reason' )->text(),
            'reason',
            60,
            $this->reason );
        $form[] = Xml::checkLabel(
            $this->msg( 'pt-deletepage-subpages' )->text(),
            'subpages',
            'mw-subpages',
            $this->doSubpages,
            $readonly
        ) . $br;
        $form[] = Xml::submitButton(
            $this->msg( 'pt-deletepage-action-perform' )->text(),
            $subaction
        );
        $form[] = Xml::submitButton(
            $this->msg( 'pt-deletepage-action-other' )->text(),
            $subaction
        );
        $form[] = Xml::closeElement( 'form' );
        $form[] = Xml::closeElement( 'fieldset' );
        $out->addHTML( implode( "\n", $form ) );
    }

    protected function printChangeLine( $title, $enabled = true ) {
        if ( $enabled ) {
            $this->getOutput()->addWikiText( '* ' . $title->getPrefixedText() );
        } else {
            $this->getOutput()->addWikiText( '* <s>' . $title->getPrefixedText() . '</s>' );
        }
    }

    protected function performAction() {
        $jobs = array();
        $target = $this->title;
        $base = $this->title->getPrefixedText();

        $translationPages = $this->getTranslationPages();
        $user = $this->getUser();
        foreach ( $translationPages as $old ) {
            $jobs[$old->getPrefixedText()] = TranslateDeleteJob::newJob(
                $old,
                $base,
                !$this->singleLanguage(),
                $user
            );
        }

        $sectionPages = $this->getSectionPages();
        foreach ( $sectionPages as $old ) {
            $jobs[$old->getPrefixedText()] = TranslateDeleteJob::newJob(
                $old,
                $base,
                !$this->singleLanguage(),
                $user
            );
        }

        if ( !$this->doSubpages ) {
            $subpages = $this->getSubpages();
            foreach ( $subpages as $old ) {
                if ( TranslatablePage::isTranslationPage( $old ) ) {
                    continue;
                }

                $jobs[$old->getPrefixedText()] = TranslateDeleteJob::newJob(
                    $old,
                    $base,
                    !$this->singleLanguage(),
                    $user
                );
            }
        }

        Job::batchInsert( $jobs );

        $cache = wfGetCache( CACHE_DB );
        $cache->set(
            wfMemcKey( 'pt-base', $target->getPrefixedText() ),
            array_keys( $jobs ),
            60 * 60 * 6
        );

        if ( !$this->singleLanguage() ) {
            $this->page->unmarkTranslatablePage();
        }

        $this->clearMetadata();
        MessageGroups::clearCache();
        MessageIndexRebuildJob::newJob()->insert();

        $this->getOutput()->addWikiMsg( 'pt-deletepage-started' );
    }

    protected function clearMetadata() {
        // remove the entries from metadata table.
        $groupId = $this->page->getMessageGroupId();
        TranslateMetadata::set( $groupId, 'prioritylangs', false );
        TranslateMetadata::set( $groupId, 'priorityforce', false );
        TranslateMetadata::set( $groupId, 'priorityreason', false );
        // remove the page from aggregate groups, if present in any of them.
        $groups = MessageGroups::getAllGroups();
        foreach ( $groups as $group ) {
            if ( $group instanceof AggregateMessageGroup ) {
                $subgroups = TranslateMetadata::get( $group->getId(), 'subgroups' );
                if ( $subgroups !== false ) {
                    $subgroups = explode( ',', $subgroups );
                    $subgroups = array_flip( $subgroups );
                    if ( isset( $subgroups[$groupId] ) ) {
                        unset( $subgroups[$groupId] );
                        $subgroups = array_flip( $subgroups );
                        TranslateMetadata::set(
                            $group->getId(),
                            'subgroups',
                            implode( ',', $subgroups )
                        );
                    }
                }
            }
        }
    }

    protected function getSectionPages() {
        $code = $this->singleLanguage() ? $this->code : false;

        return $this->page->getTranslationUnitPages( 'all', $code );
    }

    protected function getTranslationPages() {
        if ( $this->singleLanguage() ) {
            return array( $this->title );
        }

        if ( !isset( $this->translationPages ) ) {
            $this->translationPages = $this->page->getTranslationPages();
        }

        return $this->translationPages;
    }

    protected function getSubpages() {
        return $this->title->getSubpages();
    }

    protected function singleLanguage() {
        return $this->code !== '';
    }
}