wiki.techinc.nl/includes/preferences/MultiUsernameFilter.php
Max Semenik e6b4944dbf Introduce preference filters
This normalizes handling of transformations on the boundaries between
preferences and generic form controls and removes the special case
where email-blacklist is passed around as an array internally, leaking
into the API.

As a result of this normalization, meta=userinfo no longer returns an
array of users, using the internal representation like action=options.

Bug: T198935
Change-Id: Iff63da0d215585cfcf083e7f7ec8ed45d5b77301
2018-07-17 13:19:14 -07:00

86 lines
2.4 KiB
PHP

<?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
*/
namespace MediaWiki\Preferences;
use CentralIdLookup;
class MultiUsernameFilter implements Filter {
/**
* @var CentralIdLookup|null
*/
private $lookup;
/** @var CentralIdLookup|int User querying central usernames or one of the audience constants */
private $userOrAudience;
/**
* @param CentralIdLookup|null $lookup
* @param int $userOrAudience
*/
public function __construct( CentralIdLookup $lookup = null,
$userOrAudience = CentralIdLookup::AUDIENCE_PUBLIC
) {
$this->lookup = $lookup;
$this->userOrAudience = $userOrAudience;
}
/**
* @inheritDoc
*/
public function filterFromForm( $names ) {
$names = trim( $names );
if ( $names !== '' ) {
$names = preg_split( '/\n/', $names, -1, PREG_SPLIT_NO_EMPTY );
$ids = $this->getLookup()->centralIdsFromNames( $names, $this->userOrAudience );
if ( $ids ) {
return implode( "\n", $ids );
}
}
// If the user list is empty, it should be null (don't save) rather than an empty string
return null;
}
/**
* @inheritDoc
*/
public function filterForForm( $value ) {
$ids = self::splitIds( $value );
$names = $ids ? $this->getLookup()->namesFromCentralIds( $ids, $this->userOrAudience ) : [];
return implode( "\n", $names );
}
/**
* Splits a newline separated list of user ids into a
*
* @param string $str
* @return int[]
*/
public static function splitIds( $str ) {
return array_map( 'intval', preg_split( '/\n/', $str, -1, PREG_SPLIT_NO_EMPTY ) );
}
/**
* @return CentralIdLookup
*/
private function getLookup() {
$this->lookup = $this->lookup ?? CentralIdLookup::factory();
return $this->lookup;
}
}