Auth.php

浏览该文件的文档。

<?php
// FleaPHP Framework
//
// Copyright (c) 2005 - 2007 FleaPHP.org (www.fleaphp.org)
//
// 许可协议，请查看源代码中附带的 LICENSE.txt 文件，
// 或者访问 http://www.fleaphp.org/ 获得详细信息。

// {{{ includes
FLEA::loadClass('FLEA_Dispatcher_Simple');
// }}}

class FLEA_Dispatcher_Auth extends FLEA_Dispatcher_Simple
{
    var $_auth;

    function FLEA_Dispatcher_Auth(& $request)
    {
        parent::FLEA_Dispatcher_Simple($request);
        $this->_auth =& FLEA::getSingleton(FLEA::getAppInf('dispatcherAuthProvider'));
    }

    function & getAuthProvider()
    {
        return $this->_auth;
    }

    function setAuthProvider(& $auth)
    {
        $this->_auth =& $auth;
    }

    function setUser($userData, $rolesData = null)
    {
        $this->_auth->setUser($userData, $rolesData);
    }

    function getUser()
    {
        return $this->_auth->getUser();
    }

    function getUserRoles()
    {
        return $this->_auth->getRolesArray();
    }

    function clearUser()
    {
        $this->_auth->clearUser();
    }

    function dispatching()
    {
        $controllerName  = $this->getControllerName();
        $actionName      = $this->getActionName();
        $controllerClass = $this->getControllerClass($controllerName);

        if ($this->check($controllerName, $actionName, $controllerClass)) {
            // 检查通过，执行控制器方法
            return $this->_executeAction($controllerName, $actionName, $controllerClass);
        } else {
            // 检查失败
            $callback = FLEA::getAppInf('dispatcherAuthFailedCallback');

            $rawACT = $this->getControllerACT($controllerName, $controllerClass);
            if (is_null($rawACT) || empty($rawACT)) { return true; }
            $ACT = $this->_auth->prepareACT($rawACT);
            $roles = $this->_auth->getRolesArray();
            $args = array($controllerName, $actionName, $controllerClass, $ACT, $roles);

            // 如果控制器定义了的 _onAuthFailed 静态方法，则调用该方法
            if ($this->_loadController($controllerClass)) {
                $methods = get_class_methods($controllerClass);
                if (in_array('_onAuthFailed', $methods, true)) {
                    if (call_user_func_array(array($controllerClass, '_onAuthFailed'), $args) !== false) {
                        return false;
                    }
                }
            }

            if ($callback) {
                return call_user_func_array($callback, $args);
            } else {
                FLEA::loadClass('FLEA_Dispatcher_Exception_CheckFailed');
                __THROW(new FLEA_Dispatcher_Exception_CheckFailed($controllerName, $actionName, $rawACT, $roles));
                return false;
            }
        }
    }

    function check($controllerName, $actionName = null, $controllerClass = null)
    {
        if (is_null($controllerClass)) {
            $controllerClass = $this->getControllerClass($controllerName);
        }
        if (is_null($actionName)) {
            $actionName = $this->getActionName();
        }
        // 如果控制器没有提供 ACT，或者提供了一个空的 ACT，则假定允许用户访问
        $rawACT = $this->getControllerACT($controllerName, $controllerClass);
        if (is_null($rawACT) || empty($rawACT)) { return true; }

        $ACT = $this->_auth->prepareACT($rawACT);
        $ACT['actions'] = array();
        if (isset($rawACT['actions']) && is_array($rawACT['actions'])) {
            foreach ($rawACT['actions'] as $rawActionName => $rawActionACT) {
                if ($rawActionName !== ACTION_ALL) {
                    $rawActionName = strtolower($rawActionName);
                }
                $ACT['actions'][$rawActionName] = $this->_auth->prepareACT($rawActionACT);
            }
        }
        // 取出用户角色信息
        $roles = $this->_auth->getRolesArray();
        // 首先检查用户是否可以访问该控制器
        if (!$this->_auth->check($roles, $ACT)) { return false; }

        // 接下来验证用户是否可以访问指定的控制器方法
        $actionName = strtolower($actionName);
        if (isset($ACT['actions'][$actionName])) {
            return $this->_auth->check($roles, $ACT['actions'][$actionName]);
        }

        // 如果当前要访问的控制器方法没有在 act 中指定，则检查 act 中是否提供了 ACTION_ALL
        if (!isset($ACT['actions'][ACTION_ALL])) { return true; }
        return $this->_auth->check($roles, $ACT['actions'][ACTION_ALL]);
    }

    function getControllerACT($controllerName, $controllerClass)
    {
        // 首先尝试从全局 ACT 查询控制器的 ACT
        $ACT = FLEA::getAppInfValue('globalACT', $controllerName);
        if ($ACT) { return $ACT; }

        $actFilename = FLEA::getFilePath($controllerClass . '.act.php');
        if (!$actFilename) {
            if (FLEA::getAppInf('autoQueryDefaultACTFile')) {
                $ACT = $this->getControllerACTFromDefaultFile($controllerName);
                if ($ACT) { return $ACT; }
            }

            if (FLEA::getAppInf('controllerACTLoadWarning')) {
                trigger_error(sprintf(_ET(0x0701006), $controllerName), E_USER_WARNING);
            }
            return FLEA::getAppInf('defaultControllerACT');
        }

        return $this->_loadACTFile($actFilename);
    }

    function getControllerACTFromDefaultFile($controllerName)
    {
        $actFilename = realpath(FLEA::getAppInf('defaultControllerACTFile'));
        if (!$actFilename) {
            if (FLEA::getAppInf('controllerACTLoadWarning')) {
                trigger_error(sprintf(_ET(0x0701006), $controllerName), E_USER_WARNING);
            }
            return FLEA::getAppInf('defaultControllerACT');
        }

        $ACT = $this->_loadACTFile($actFilename);
        if ($ACT === false) { return false; }

        $ACT = array_change_key_case($ACT, CASE_UPPER);
        $controllerName = strtoupper($controllerName);
        return isset($ACT[$controllerName]) ?
            $ACT[$controllerName] :
            FLEA::getAppInf('defaultControllerACT');
    }

    function _loadACTFile($actFilename)
    {
        static $files = array();

        if (isset($files[$actFilename])) {
            return $files[$actFilename];
        }

        $ACT = require($actFilename);
        if (is_array($ACT)) {
            $files[$actFilename] = $ACT;
            return $ACT;
        }

        // 当控制器的 ACT 文件没有返回 ACT 时抛出异常
        FLEA::loadClass('FLEA_Rbac_Exception_InvalidACTFile');
        __THROW(new FLEA_Rbac_Exception_InvalidACTFile($actFilename, $ACT));
        return false;
    }
}

---