mediawiki-extensions-AbuseFilter/includes/Views/AbuseFilterView.php

<?php

use Wikimedia\Rdbms\IDatabase;

abstract class AbuseFilterView extends ContextSource {
	public $mFilter, $mHistoryID, $mSubmit, $mPage, $mParams;

	/**
	 * @var \MediaWiki\Linker\LinkRenderer
	 */
	protected $linkRenderer;

	/**
	 * @param SpecialAbuseFilter $page
	 * @param array $params
	 */
	public function __construct( $page, $params ) {
		$this->mPage = $page;
		$this->mParams = $params;
		$this->setContext( $this->mPage->getContext() );
		$this->linkRenderer = $page->getLinkRenderer();
	}

	/**
	 * @param string $subpage
	 * @return Title
	 */
	public function getTitle( $subpage = '' ) {
		return $this->mPage->getPageTitle( $subpage );
	}

	/**
	 * Function to show the page
	 */
	abstract public function show();

	/**
	 * @return bool
	 */
	public function canEdit() {
		return (
			!$this->getUser()->isBlocked() &&
			$this->getUser()->isAllowed( 'abusefilter-modify' )
		);
	}

	/**
	 * @return bool
	 */
	public function canEditGlobal() {
		return $this->getUser()->isAllowed( 'abusefilter-modify-global' );
	}

	/**
	 * Whether the user can edit the given filter.
	 *
	 * @param object $row Filter row
	 *
	 * @return bool
	 */
	public function canEditFilter( $row ) {
		return (
			$this->canEdit() &&
			!( isset( $row->af_global ) && $row->af_global == 1 && !$this->canEditGlobal() )
		);
	}

	/**
	 * @param string $rules
	 * @param string $textName
	 * @param bool $addResultDiv
	 * @param bool $externalForm
	 * @param bool $needsModifyRights
	 * @return string
	 */
	public function buildEditBox(
		$rules,
		$textName = 'wpFilterRules',
		$addResultDiv = true,
		$externalForm = false,
		$needsModifyRights = true
	) {
		$this->getOutput()->enableOOUI();

		// Rules are in English
		$editorAttrib = [ 'dir' => 'ltr' ];

		$noTestAttrib = [];
		$isUserAllowed = $needsModifyRights ?
			$this->getUser()->isAllowed( 'abusefilter-modify' ) :
			$this->canViewPrivate();
		if ( !$isUserAllowed ) {
			$noTestAttrib['disabled'] = 'disabled';
			$addResultDiv = false;
		}

		$rules = rtrim( $rules ) . "\n";
		$canEdit = $needsModifyRights ? $this->canEdit() : $this->canViewPrivate();

		if ( ExtensionRegistry::getInstance()->isLoaded( 'CodeEditor' ) ) {
			$editorAttrib['name'] = 'wpAceFilterEditor';
			$editorAttrib['id'] = 'wpAceFilterEditor';
			$editorAttrib['class'] = 'mw-abusefilter-editor';

			$switchEditor =
				new OOUI\ButtonWidget(
					[
						'label' => $this->msg( 'abusefilter-edit-switch-editor' )->text(),
						'id' => 'mw-abusefilter-switcheditor'
					] + $noTestAttrib
				);

			$rulesContainer = Xml::element( 'div', $editorAttrib, $rules );

			// Dummy textarea for submitting form and to use in case JS is disabled
			$textareaAttribs = [];
			if ( !$canEdit ) {
				$textareaAttribs['readonly'] = 'readonly';
			}
			if ( $externalForm ) {
				$textareaAttribs['form'] = 'wpFilterForm';
			}
			$rulesContainer .= Xml::textarea( $textName, $rules, 40, 15, $textareaAttribs );

			$editorConfig = AbuseFilter::getAceConfig( $canEdit );

			// Add Ace configuration variable
			$this->getOutput()->addJsConfigVars( 'aceConfig', $editorConfig );
		} else {
			if ( !$canEdit ) {
				$editorAttrib['readonly'] = 'readonly';
			}
			if ( $externalForm ) {
				$editorAttrib['form'] = 'wpFilterForm';
			}
			$rulesContainer = Xml::textarea( $textName, $rules, 40, 15, $editorAttrib );
		}

		if ( $canEdit ) {
			// Generate builder drop-down
			$rawDropDown = AbuseFilter::getBuilderValues();

			// The array needs to be rearranged to be understood by OOUI. It comes with the format
			// [ group-msg-key => [ text-to-add => text-msg-key ] ] and we need it as
			// [ group-msg => [ text-msg => text-to-add ] ]
			// Also, the 'other' element must be the first one.
			$dropDown = [ $this->msg( 'abusefilter-edit-builder-select' )->text() => 'other' ];
			foreach ( $rawDropDown as $group => $values ) {
				// Give grep a chance to find the usages:
				// abusefilter-edit-builder-group-op-arithmetic, abusefilter-edit-builder-group-op-comparison,
				// abusefilter-edit-builder-group-op-bool, abusefilter-edit-builder-group-misc,
				// abusefilter-edit-builder-group-funcs, abusefilter-edit-builder-group-vars
				$localisedGroup = $this->msg( "abusefilter-edit-builder-group-$group" )->text();
				$dropDown[ $localisedGroup ] = array_flip( $values );
				$newKeys = array_map(
					function ( $key ) use ( $group ) {
						return $this->msg( "abusefilter-edit-builder-$group-$key" )->text();
					},
					array_keys( $dropDown[ $localisedGroup ] )
				);
				$dropDown[ $localisedGroup ] = array_combine( $newKeys, $dropDown[ $localisedGroup ] );
			}

			$dropDown = Xml::listDropDownOptionsOoui( $dropDown );
			$dropDown = new OOUI\DropdownInputWidget( [
				'name' => 'wpFilterBuilder',
				'inputId' => 'wpFilterBuilder',
				'options' => $dropDown
			] );

			$dropDown = new OOUI\FieldLayout( $dropDown );
			$formElements = [ $dropDown ];

			// Button for syntax check
			$syntaxCheck =
				new OOUI\ButtonWidget(
					[
						'label' => $this->msg( 'abusefilter-edit-check' )->text(),
						'id' => 'mw-abusefilter-syntaxcheck'
					] + $noTestAttrib
				);
			$group = $syntaxCheck;

			// Button for switching editor (if Ace is used)
			if ( isset( $switchEditor ) ) {
				$group =
					new OOUI\Widget( [
						'content' => new OOUI\HorizontalLayout( [
							'items' => [ $switchEditor, $syntaxCheck ]
						] )
					] );
			}
			$group = new OOUI\FieldLayout( $group );
			$formElements[] = $group;

			$fieldSet = new OOUI\FieldsetLayout( [
				'items' => $formElements,
				'classes' => [ 'mw-abusefilter-edit-buttons', 'mw-abusefilter-javascript-tools' ]
			] );

			$rulesContainer .= $fieldSet;
		}

		if ( $addResultDiv ) {
			$rulesContainer .= Xml::element( 'div',
				[ 'id' => 'mw-abusefilter-syntaxresult', 'style' => 'display: none;' ],
				'&#160;' );
		}

		// Add script
		$this->getOutput()->addModules( 'ext.abuseFilter.edit' );
		AbuseFilter::$editboxName = $textName;

		return $rulesContainer;
	}

	/**
	 * @param IDatabase $db
	 * @param string|bool $action 'edit', 'move', 'createaccount', 'delete' or false for all
	 * @return string
	 */
	public function buildTestConditions( IDatabase $db, $action = false ) {
		// If one of these is true, we're abusefilter compatible.
		switch ( $action ) {
			case 'edit':
				return $db->makeList( [
					// Actually, this is only one condition, but this way we get it as string
					'rc_source' => [
						RecentChange::SRC_EDIT,
						RecentChange::SRC_NEW,
					]
				], LIST_AND );
			case 'move':
				return $db->makeList( [
					'rc_source' => RecentChange::SRC_LOG,
					'rc_log_type' => 'move',
					'rc_log_action' => 'move'
				], LIST_AND );
			case 'createaccount':
				return $db->makeList( [
					'rc_source' => RecentChange::SRC_LOG,
					'rc_log_type' => 'newusers',
					'rc_log_action' => 'create'
				], LIST_AND );
			case 'delete':
				return $db->makeList( [
					'rc_source' => RecentChange::SRC_LOG,
					'rc_log_type' => 'delete',
					'rc_log_action' => 'delete'
				], LIST_AND );
			// @ToDo: case 'upload'
		}

		return $db->makeList( [
			'rc_source' => [
				RecentChange::SRC_EDIT,
				RecentChange::SRC_NEW,
			],
			$db->makeList( [
				'rc_source' => RecentChange::SRC_LOG,
				$db->makeList( [
					$db->makeList( [
						'rc_log_type' => 'move',
						'rc_log_action' => 'move'
					], LIST_AND ),
					$db->makeList( [
						'rc_log_type' => 'newusers',
						'rc_log_action' => 'create'
					], LIST_AND ),
					$db->makeList( [
						'rc_log_type' => 'delete',
						'rc_log_action' => 'delete'
					], LIST_AND ),
					// @todo: add upload
				], LIST_OR ),
			], LIST_AND ),
		], LIST_OR );
	}

	/**
	 * @static
	 * @return bool
	 */
	public static function canViewPrivate() {
		global $wgUser;
		static $canView = null;

		if ( is_null( $canView ) ) {
			$canView = $wgUser->isAllowedAny( 'abusefilter-modify', 'abusefilter-view-private' );
		}

		return $canView;
	}

}