wiki.techinc.nl/includes/api/ApiAcquireTempUserName.php
James D. Forrester 984076f98e Add namespace to includes/api classes
Bug: T353458
Change-Id: I3ea6b08c5018ba03ba45c5766e1f46e12f6b8597
2024-09-25 19:31:14 +00:00

81 lines
2.6 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\Api;
use MediaWiki\User\TempUser\TempUserCreator;
/**
* Acquire a temporary user username and stash it in the current session, if temp account creation
* is enabled and the current user is logged out. If a name has already been stashed, returns the
* same name.
*
* If the user later performs an action that results in temp account creation, the stashed username
* will be used for their account. It may also be used in previews. However, the account is not
* created yet, and the name is not visible to other users.
*
* @ingroup API
*/
class ApiAcquireTempUserName extends ApiBase {
private TempUserCreator $tempUserCreator;
public function __construct(
ApiMain $main,
string $action,
TempUserCreator $tempUserCreator
) {
parent::__construct( $main, $action );
$this->tempUserCreator = $tempUserCreator;
}
public function execute() {
// Like TempUserCreator::shouldAutoCreate(), but without the action check
if ( !$this->tempUserCreator->isEnabled() ) {
$this->dieWithError( 'apierror-tempuserdisabled', 'tempuserdisabled' );
}
if ( $this->getUser()->isRegistered() ) {
$this->dieWithError( 'apierror-alreadyregistered', 'alreadyregistered' );
}
$this->checkUserRightsAny( 'createaccount' );
// Checks passed, acquire the name
$session = $this->getRequest()->getSession();
$name = $this->tempUserCreator->acquireAndStashName( $session );
if ( $name === null ) {
$this->dieWithError( 'apierror-tempuseracquirefailed', 'tempuseracquirefailed' );
}
$session->persist();
$this->getResult()->addValue( null, $this->getModuleName(), $name );
}
public function isWriteMode() {
return true;
}
public function mustBePosted() {
return true;
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiAcquireTempUserName::class, 'ApiAcquireTempUserName' );