ExternalUser.php

Go to the documentation of this file.

<?php
abstract class ExternalUser {
        protected function __construct() {}

        public static function newFromName( $name ) {
                global $wgExternalAuthType;
                if ( is_null( $wgExternalAuthType ) ) {
                        return false;
                }
                $obj = new $wgExternalAuthType;
                if ( !$obj->initFromName( $name ) ) {
                        return false;
                }
                return $obj;
        }

        public static function newFromId( $id ) {
                global $wgExternalAuthType;
                if ( is_null( $wgExternalAuthType ) ) {
                        return false;
                }
                $obj = new $wgExternalAuthType;
                if ( !$obj->initFromId( $id ) ) {
                        return false;
                }
                return $obj;
        }

        public static function newFromCookie() {
                global $wgExternalAuthType;
                if ( is_null( $wgExternalAuthType ) ) {
                        return false;
                }
                $obj = new $wgExternalAuthType;
                if ( !$obj->initFromCookie() ) {
                        return false;
                }
                return $obj;
        }

        public static function newFromUser( $user ) {
                global $wgExternalAuthType;
                if ( is_null( $wgExternalAuthType ) ) {
                        # Short-circuit to avoid database query in common case so no one
                        # kills me
                        return false;
                }

                $dbr = wfGetDB( DB_SLAVE );
                $id = $dbr->selectField( 'external_user', 'eu_external_id',
                        array( 'eu_local_id' => $user->getId() ), __METHOD__ );
                if ( $id === false ) {
                        return false;
                }
                return self::newFromId( $id );
        }

        protected abstract function initFromName( $name );

        protected abstract function initFromId( $id );

        protected function initFromCookie() {
                return false;
        }

        abstract public function getId();

        abstract public function getName();

        abstract public function authenticate( $password );

        public function getPref( $pref ) {
                return null;
        }

        public function getGroups() {
                return array();
        }

        public static function getPrefMessage( $pref ) {
                return false;
        }

        public static function setPref( $key, $value ) {
                return false;
        }

        public final function linkToLocal( $id ) {
                $dbw = wfGetDB( DB_MASTER );
                $dbw->replace( 'external_user',
                        array( 'eu_local_id', 'eu_external_id' ),
                        array( 'eu_local_id' => $id,
                                   'eu_external_id' => $this->getId() ),
                        __METHOD__ );
        }
        
        public final function getLocalUser(){
                $dbr = wfGetDB( DB_SLAVE );
                $row = $dbr->selectRow(
                        'external_user',
                        '*',
                        array( 'eu_external_id' => $this->getId() )
                );
                return $row
                        ? User::newFromId( $row->eu_local_id )
                        : null;
        }
        
}