SpecialMute.php

Go to the documentation of this file.

<?php
/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup SpecialPage
 */
use MediaWiki\Preferences\MultiUsernameFilter;
 
class SpecialMute extends FormSpecialPage {
 
    private const PAGE_NAME = 'Mute';
 
    private $target;
 
    private $targetCentralId;
 
    private $enableUserEmailMuteList;
 
    private $enableUserEmail;
 
    private $centralIdLookup;
 
    public function __construct() {
        // TODO: inject all these dependencies once T222388 is resolved
        $config = RequestContext::getMain()->getConfig();
        $this->enableUserEmailMuteList = $config->get( 'EnableUserEmailBlacklist' );
        $this->enableUserEmail = $config->get( 'EnableUserEmail' );
 
        $this->centralIdLookup = CentralIdLookup::factory();
 
        parent::__construct( self::PAGE_NAME, '', false );
    }
 
    public function execute( $par ) {
        $this->addHelpLink(
            'https://meta.wikimedia.org/wiki/Community_health_initiative/User_Mute_features',
            true
        );
        $this->requireLogin( 'specialmute-login-required' );
        $this->loadTarget( $par );
 
        parent::execute( $par );
 
        $out = $this->getOutput();
        $out->addModules( 'mediawiki.misc-authed-ooui' );
    }
 
    public function requiresUnblock() {
        return false;
    }
 
    protected function getDisplayFormat() {
        return 'ooui';
    }
 
    public function onSuccess() {
        $out = $this->getOutput();
        $out->addWikiMsg( 'specialmute-success' );
    }
 
    public function onSubmit( array $data, HTMLForm $form = null ) {
        $hookData = [];
        foreach ( $data as $userOption => $value ) {
            $hookData[$userOption]['before'] = $this->isTargetMuted( $userOption );
            if ( $value ) {
                $this->muteTarget( $userOption );
            } else {
                $this->unmuteTarget( $userOption );
            }
            $hookData[$userOption]['after'] = (bool)$value;
        }
 
        // NOTE: this hook is temporary
        $this->getHookRunner()->onSpecialMuteSubmit( $hookData );
 
        return true;
    }
 
    public function getDescription() {
        return $this->msg( 'specialmute' )->text();
    }
 
    public function getTarget(): ?User {
        return $this->target;
    }
 
    private function unmuteTarget( $userOption ) {
        $muteList = $this->getMuteList( $userOption );
 
        $key = array_search( $this->targetCentralId, $muteList );
        if ( $key !== false ) {
            unset( $muteList[$key] );
            $muteList = implode( "\n", $muteList );
 
            $user = $this->getUser();
            $user->setOption( $userOption, $muteList );
            $user->saveSettings();
        }
    }
 
    private function muteTarget( $userOption ) {
        // avoid duplicates just in case
        if ( !$this->isTargetMuted( $userOption ) ) {
            $muteList = $this->getMuteList( $userOption );
 
            $muteList[] = $this->targetCentralId;
            $muteList = implode( "\n", $muteList );
 
            $user = $this->getUser();
            $user->setOption( $userOption, $muteList );
            $user->saveSettings();
        }
    }
 
    protected function getForm() {
        $form = parent::getForm();
        $form->setId( 'mw-specialmute-form' );
        $form->setHeaderText( $this->msg( 'specialmute-header', $this->target )->parse() );
        $form->setSubmitTextMsg( 'specialmute-submit' );
        $form->setSubmitID( 'save' );
 
        return $form;
    }
 
    protected function getFormFields() {
        $fields = [];
        if (
            $this->enableUserEmailMuteList &&
            $this->enableUserEmail &&
            $this->getUser()->getEmailAuthenticationTimestamp()
        ) {
            $fields['email-blacklist'] = [
                'type' => 'check',
                'label-message' => [
                    'specialmute-label-mute-email',
                    $this->getTarget() ? $this->getTarget()->getName() : ''
                ],
                'default' => $this->isTargetMuted( 'email-blacklist' ),
            ];
        }
 
        $this->getHookRunner()->onSpecialMuteModifyFormFields( $this, $fields );
 
        if ( count( $fields ) == 0 ) {
            throw new ErrorPageError( 'specialmute', 'specialmute-error-no-options' );
        }
 
        return $fields;
    }
 
    private function loadTarget( $username ) {
        $target = User::newFromName( $username );
        if ( !$target || !$target->getId() ) {
            throw new ErrorPageError( 'specialmute', 'specialmute-error-invalid-user' );
        } else {
            $this->target = $target;
            $this->targetCentralId = $this->centralIdLookup->centralIdFromLocalUser( $target );
        }
    }
 
    public function isTargetMuted( $userOption ) {
        $muteList = $this->getMuteList( $userOption );
        return in_array( $this->targetCentralId, $muteList, true );
    }
 
    public function isTargetBlacklisted( $userOption ) {
        return $this->isTargetMuted( $userOption );
    }
 
    private function getMuteList( $userOption ) {
        $muteList = $this->getUser()->getOption( $userOption );
        if ( !$muteList ) {
            return [];
        }
 
        return MultiUsernameFilter::splitIds( $muteList );
    }
}