SpecialCreateAccount.php

Go to the documentation of this file.

<?php
use MediaWiki\Auth\AuthManager;
use MediaWiki\Logger\LoggerFactory;

class SpecialCreateAccount extends LoginSignupSpecialPage {
    protected static $allowedActions = [
        AuthManager::ACTION_CREATE,
        AuthManager::ACTION_CREATE_CONTINUE
    ];

    protected static $messages = [
        'authform-newtoken' => 'nocookiesfornew',
        'authform-notoken' => 'sessionfailure',
        'authform-wrongtoken' => 'sessionfailure',
    ];

    public function __construct() {
        parent::__construct( 'CreateAccount' );
    }

    public function doesWrites() {
        return true;
    }

    public function isRestricted() {
        return !User::groupHasPermission( '*', 'createaccount' );
    }

    public function userCanExecute( User $user ) {
        return $user->isAllowed( 'createaccount' );
    }

    public function checkPermissions() {
        parent::checkPermissions();

        $user = $this->getUser();
        $status = AuthManager::singleton()->checkAccountCreatePermissions( $user );
        if ( !$status->isGood() ) {
            throw new ErrorPageError( 'createacct-error', $status->getMessage() );
        }
    }

    protected function getLoginSecurityLevel() {
        return false;
    }

    protected function getDefaultAction( $subPage ) {
        return AuthManager::ACTION_CREATE;
    }

    public function getDescription() {
        return $this->msg( 'createaccount' )->text();
    }

    protected function isSignup() {
        return true;
    }

    protected function successfulAction( $direct = false, $extraMessages = null ) {
        $session = $this->getRequest()->getSession();
        $user = $this->targetUser ?: $this->getUser();

        if ( $direct ) {
            # Only save preferences if the user is not creating an account for someone else.
            if ( !$this->proxyAccountCreation ) {
                Hooks::run( 'AddNewAccount', [ $user, false ] );

                // If the user does not have a session cookie at this point, they probably need to
                // do something to their browser.
                if ( !$this->hasSessionCookie() ) {
                    $this->mainLoginForm( [ /*?*/ ], $session->getProvider()->whyNoSession() );
                    // TODO something more specific? This used to use nocookiesnew
                    // FIXME should redirect to login page instead?
                    return;
                }
            } else {
                $byEmail = false; // FIXME no way to set this

                Hooks::run( 'AddNewAccount', [ $user, $byEmail ] );

                $out = $this->getOutput();
                $out->setPageTitle( $this->msg( $byEmail ? 'accmailtitle' : 'accountcreated' ) );
                if ( $byEmail ) {
                    $out->addWikiMsg( 'accmailtext', $user->getName(), $user->getEmail() );
                } else {
                    $out->addWikiMsg( 'accountcreatedtext', $user->getName() );
                }

                $rt = Title::newFromText( $this->mReturnTo );
                $out->addReturnTo(
                    ( $rt && !$rt->isExternal() ) ? $rt : $this->getPageTitle(),
                    wfCgiToArray( $this->mReturnToQuery )
                );
                return;
            }
        }

        $this->clearToken();

        # Run any hooks; display injected HTML
        $injected_html = '';
        $welcome_creation_msg = 'welcomecreation-msg';
        Hooks::run( 'UserLoginComplete', [ &$user, &$injected_html, $direct ] );

        Hooks::run( 'BeforeWelcomeCreation', [ &$welcome_creation_msg, &$injected_html ] );

        $this->showSuccessPage( 'signup', $this->msg( 'welcomeuser', $this->getUser()->getName() ),
            $welcome_creation_msg, $injected_html, $extraMessages );
    }

    protected function getToken() {
        return $this->getRequest()->getSession()->getToken( '', 'createaccount' );
    }

    protected function clearToken() {
        return $this->getRequest()->getSession()->resetToken( 'createaccount' );
    }

    protected function getTokenName() {
        return 'wpCreateaccountToken';
    }

    protected function getGroupName() {
        return 'login';
    }

    protected function logAuthResult( $success, $status = null ) {
        LoggerFactory::getInstance( 'authevents' )->info( 'Account creation attempt', [
            'event' => 'accountcreation',
            'successful' => $success,
            'status' => $status,
        ] );
    }
}