Page MenuHomeWickedGov Phorge
Files F4057786

AbstractTemporaryAccountIPHandler.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

AbstractTemporaryAccountIPHandler.php
View Options

<?php
namespace MediaWiki\CheckUser\Api\Rest\Handler;
use MediaWiki\Block\BlockManager;
use MediaWiki\CheckUser\Logging\TemporaryAccountLogger;
use MediaWiki\CheckUser\Services\CheckUserPermissionManager;
use MediaWiki\Config\Config;
use MediaWiki\JobQueue\JobQueueGroup;
use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\User\ActorStore;
use MediaWiki\User\TempUser\TempUserConfig;
use MediaWiki\User\UserNameUtils;
use Wikimedia\IPUtils;
use Wikimedia\Message\MessageValue;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef\IntegerDef;
use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\Rdbms\ReadOnlyMode;
/**
* Handle IP validation for endpoints that take an IP as a parameter
*/
abstract class AbstractTemporaryAccountIPHandler extends AbstractTemporaryAccountHandler {
private TempUserConfig $tempUserConfig;
public function __construct(
Config $config,
JobQueueGroup $jobQueueGroup,
PermissionManager $permissionManager,
UserNameUtils $userNameUtils,
IConnectionProvider $dbProvider,
ActorStore $actorStore,
BlockManager $blockManager,
TempUserConfig $tempUserConfig,
CheckUserPermissionManager $checkUserPermissionsManager,
ReadOnlyMode $readOnlyMode
) {
parent::__construct(
$config, $jobQueueGroup, $permissionManager, $userNameUtils, $dbProvider, $actorStore,
$blockManager, $checkUserPermissionsManager, $readOnlyMode
);
$this->tempUserConfig = $tempUserConfig;
}
/**
* @inheritDoc
*/
public function getResults( $identifier ): array {
if ( !$this->tempUserConfig->isKnown() ) {
// Pretend the route doesn't exist if temporary accounts are not known, as the APIs need them to be enabled
// to actually be of any use.
throw new LocalizedHttpException( new MessageValue( 'rest-no-match' ), 404 );
}
if ( !IPUtils::isValid( $identifier ) ) {
throw new LocalizedHttpException(
new MessageValue( 'rest-invalid-ip', [ $identifier ] ),
404
);
}
$dbr = $this->dbProvider->getReplicaDatabase();
return $this->getData( $identifier, $dbr );
}
/**
* @inheritDoc
*/
protected function getLogType(): string {
return TemporaryAccountLogger::ACTION_VIEW_TEMPORARY_ACCOUNTS_ON_IP;
}
/**
* @inheritDoc
*/
public function getParamSettings() {
return [
'ip' => [
self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
],
'limit' => [
self::PARAM_SOURCE => 'query',
ParamValidator::PARAM_TYPE => 'integer',
ParamValidator::PARAM_REQUIRED => false,
ParamValidator::PARAM_DEFAULT => $this->config->get( 'CheckUserMaximumRowCount' ),
IntegerDef::PARAM_MAX => $this->config->get( 'CheckUserMaximumRowCount' ),
IntegerDef::PARAM_MIN => 1,
],
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 16 2026, 04:19 (13 w, 12 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
fe/8c/ec937d81f30ec04eae2368f9a782
Default Alt Text
AbstractTemporaryAccountIPHandler.php (2 KB)

Event Timeline