SessionInfo.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Session;

class SessionInfo {
    const MIN_PRIORITY = 1;

    const MAX_PRIORITY = 100;

    private $provider;

    private $id;

    private $priority;

    private $userInfo = null;

    private $persisted = false;
    private $remembered = false;
    private $forceHTTPS = false;
    private $idIsSafe = false;
    private $forceUse = false;

    private $providerMetadata = null;

    public function __construct( $priority, array $data ) {
        if ( $priority < self::MIN_PRIORITY || $priority > self::MAX_PRIORITY ) {
            throw new \InvalidArgumentException( 'Invalid priority' );
        }

        if ( isset( $data['copyFrom'] ) ) {
            $from = $data['copyFrom'];
            if ( !$from instanceof SessionInfo ) {
                throw new \InvalidArgumentException( 'Invalid copyFrom' );
            }
            $data += [
                'provider' => $from->provider,
                'id' => $from->id,
                'userInfo' => $from->userInfo,
                'persisted' => $from->persisted,
                'remembered' => $from->remembered,
                'forceHTTPS' => $from->forceHTTPS,
                'metadata' => $from->providerMetadata,
                'idIsSafe' => $from->idIsSafe,
                'forceUse' => $from->forceUse,
                // @codeCoverageIgnoreStart
            ];
            // @codeCoverageIgnoreEnd
        } else {
            $data += [
                'provider' => null,
                'id' => null,
                'userInfo' => null,
                'persisted' => false,
                'remembered' => true,
                'forceHTTPS' => false,
                'metadata' => null,
                'idIsSafe' => false,
                'forceUse' => false,
                // @codeCoverageIgnoreStart
            ];
            // @codeCoverageIgnoreEnd
        }

        if ( $data['id'] !== null && !SessionManager::validateSessionId( $data['id'] ) ) {
            throw new \InvalidArgumentException( 'Invalid session ID' );
        }

        if ( $data['userInfo'] !== null && !$data['userInfo'] instanceof UserInfo ) {
            throw new \InvalidArgumentException( 'Invalid userInfo' );
        }

        if ( !$data['provider'] && $data['id'] === null ) {
            throw new \InvalidArgumentException(
                'Must supply an ID when no provider is given'
            );
        }

        if ( $data['metadata'] !== null && !is_array( $data['metadata'] ) ) {
            throw new \InvalidArgumentException( 'Invalid metadata' );
        }

        $this->provider = $data['provider'];
        if ( $data['id'] !== null ) {
            $this->id = $data['id'];
            $this->idIsSafe = $data['idIsSafe'];
            $this->forceUse = $data['forceUse'] && $this->provider;
        } else {
            $this->id = $this->provider->getManager()->generateSessionId();
            $this->idIsSafe = true;
            $this->forceUse = false;
        }
        $this->priority = (int)$priority;
        $this->userInfo = $data['userInfo'];
        $this->persisted = (bool)$data['persisted'];
        if ( $data['provider'] !== null ) {
            if ( $this->userInfo !== null && !$this->userInfo->isAnon() && $this->userInfo->isVerified() ) {
                $this->remembered = (bool)$data['remembered'];
            }
            $this->providerMetadata = $data['metadata'];
        }
        $this->forceHTTPS = (bool)$data['forceHTTPS'];
    }

    final public function getProvider() {
        return $this->provider;
    }

    final public function getId() {
        return $this->id;
    }

    final public function isIdSafe() {
        return $this->idIsSafe;
    }

    final public function forceUse() {
        return $this->forceUse;
    }

    final public function getPriority() {
        return $this->priority;
    }

    final public function getUserInfo() {
        return $this->userInfo;
    }

    final public function wasPersisted() {
        return $this->persisted;
    }

    final public function getProviderMetadata() {
        return $this->providerMetadata;
    }

    final public function wasRemembered() {
        return $this->remembered;
    }

    final public function forceHTTPS() {
        return $this->forceHTTPS;
    }

    public function __toString() {
        return '[' . $this->getPriority() . ']' .
            ( $this->getProvider() ?: 'null' ) .
            ( $this->userInfo ?: '<null>' ) . $this->getId();
    }

    public static function compare( $a, $b ) {
        return $a->getPriority() - $b->getPriority();
    }

}