CaptchaStore.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Session\SessionManager;
 
abstract class CaptchaStore {
    abstract public function store( $index, $info );
 
    abstract public function retrieve( $index );
 
    abstract public function clear( $index );
 
    abstract public function cookiesNeeded();
 
    private static $instance;
 
    final public static function get() {
        if ( !self::$instance instanceof self ) {
            global $wgCaptchaStorageClass;
            if ( in_array( 'CaptchaStore', class_parents( $wgCaptchaStorageClass ) ) ) {
                self::$instance = new $wgCaptchaStorageClass;
            } else {
                throw new Exception( "Invalid CaptchaStore class $wgCaptchaStorageClass" );
            }
        }
        return self::$instance;
    }
 
    final public static function unsetInstanceForTests() {
        if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
            throw new MWException( 'Cannot unset ' . __CLASS__ . ' instance in operation.' );
        }
        self::$instance = null;
    }
 
    protected function __construct() {
    }
}
 
class CaptchaSessionStore extends CaptchaStore {
    protected function __construct() {
        // Make sure the session is started
        SessionManager::getGlobalSession()->persist();
    }
 
    function store( $index, $info ) {
        SessionManager::getGlobalSession()->set( 'captcha' . $index, $info );
    }
 
    function retrieve( $index ) {
        return SessionManager::getGlobalSession()->get( 'captcha' . $index, false );
    }
 
    function clear( $index ) {
        SessionManager::getGlobalSession()->remove( 'captcha' . $index );
    }
 
    function cookiesNeeded() {
        return true;
    }
}
 
class CaptchaCacheStore extends CaptchaStore {
    function store( $index, $info ) {
        global $wgCaptchaSessionExpiration;
 
        ObjectCache::getMainStashInstance()->set(
            wfMemcKey( 'captcha', $index ),
            $info,
            $wgCaptchaSessionExpiration
        );
    }
 
    function retrieve( $index ) {
        $info = ObjectCache::getMainStashInstance()->get( wfMemcKey( 'captcha', $index ) );
        if ( $info ) {
            return $info;
        } else {
            return false;
        }
    }
 
    function clear( $index ) {
        ObjectCache::getMainStashInstance()->delete( wfMemcKey( 'captcha', $index ) );
    }
 
    function cookiesNeeded() {
        return false;
    }
}
 
class CaptchaHashStore extends CaptchaStore {
    protected $data = [];
 
    public function store( $index, $info ) {
        $this->data[$index] = $info;
    }
 
    public function retrieve( $index ) {
        if ( array_key_exists( $index, $this->data ) ) {
            return $this->data[$index];
        }
        return false;
    }
 
    public function clear( $index ) {
        unset( $this->data[$index] );
    }
 
    public function cookiesNeeded() {
        return false;
    }
 
    public function clearAll() {
        $this->data = [];
    }
}