ElggPAM.php

Go to the documentation of this file.

<?php

class ElggPAM {

    public static $_handlers = [];

    protected $policy;

    protected $messages;

    public function __construct($policy) {
        $this->policy = $policy;
        $this->messages = ['sufficient' => [], 'required' => []];
    }

    public function authenticate($credentials = []) {
        if (!isset(self::$_handlers[$this->policy]) ||
            !is_array(self::$_handlers[$this->policy])) {
            return false;
        }

        $authenticated = false;

        foreach (self::$_handlers[$this->policy] as $v) {
            $handler = $v->handler;
            if (!is_callable($handler)) {
                continue;
            }
            /* @var callable $handler */

            $importance = $v->importance;

            try {
                // Execute the handler
                // @todo don't assume $handler is a global function
                $result = call_user_func($handler, $credentials);
                if ($result) {
                    $authenticated = true;
                } elseif ($result === false) {
                    if ($importance == 'required') {
                        $this->messages['required'][] = "$handler:failed";
                        return false;
                    } else {
                        $this->messages['sufficient'][] = "$handler:failed";
                    }
                }
            } catch (Exception $e) {
                if ($importance == 'required') {
                    $this->messages['required'][] = $e->getMessage();
                    return false;
                } else {
                    $this->messages['sufficient'][] = $e->getMessage();
                }
            }
        }

        return $authenticated;
    }

    public function getFailureMessage() {
        $message = _elgg_services()->translator->translate('auth:nopams');
        if (!empty($this->messages['required'])) {
            $message = $this->messages['required'][0];
        } elseif (!empty($this->messages['sufficient'])) {
            $message = $this->messages['sufficient'][0];
        }

        return _elgg_services()->hooks->trigger('fail', 'auth', $this->messages, $message);
    }
}