ActionHandler.php

Go to the documentation of this file.

<?php
// {{{ license

// +----------------------------------------------------------------------+
// | FastFrame Application Framework                                      |
// +----------------------------------------------------------------------+
// | Copyright (c) 2002-2006 The Codejanitor Group                        |
// +----------------------------------------------------------------------+
// | This source file is subject to the GNU Lesser Public License (LGPL), |
// | that is bundled with this package in the file LICENSE, and is        |
// | available at through the world-wide-web at                           |
// | http://www.fsf.org/copyleft/lesser.html                              |
// | If you did not receive a copy of the LGPL and are unable to          |
// | obtain it through the world-wide-web, you can get it by writing the  |
// | Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, |
// | MA 02111-1307, USA.                                                  |
// +----------------------------------------------------------------------+
// | Authors: Jason Rust <jrust@codejanitor.com>                          |
// +----------------------------------------------------------------------+

// }}}
// {{{ requires

require_once 'PEAR.php';
require_once dirname(__FILE__) . '/ErrorHandler.php';
require_once dirname(__FILE__) . '/../FastFrame.php';
require_once dirname(__FILE__) . '/Request.php';
require_once dirname(__FILE__) . '/Registry.php';
require_once dirname(__FILE__) . '/Auth.php';
require_once dirname(__FILE__) . '/Perms.php';
require_once dirname(__FILE__) . '/Result.php';
require_once dirname(__FILE__) . '/Output.php';

// }}}
// {{{ constants

define('ACTION_PROBLEM',        'problem');
define('ACTION_ADD',            'add');
define('ACTION_ADD_SUBMIT',     'add_submit');
define('ACTION_EDIT',           'edit');
define('ACTION_EDIT_SUBMIT',    'edit_submit');
define('ACTION_VIEW',           'view');
define('ACTION_DELETE',         'delete');
define('ACTION_LIST',           'list');
define('ACTION_LOGIN',          'login');
define('ACTION_LOGIN_SUBMIT',   'login_submit');
define('ACTION_LOGOUT',         'logout');
define('ACTION_SELECT',         'select');
define('ACTION_DISPLAY',        'display');
define('ACTION_RELOAD',         'reload');
define('ACTION_TREE',           'tree');
define('ACTION_HOME',           'home');
define('ACTION_DOWNLOAD',       'download');
define('ACTION_CONTACT',        'contact');
define('ACTION_CONTACT_SUBMIT', 'contact_submit');

// }}}
// {{{ class FF_ActionHandler 

// }}}
class FF_ActionHandler {
    // {{{ properties

    var $actionId;

    var $appId;

    var $moduleId;

    var $moduleConfig;

    var $defaultActionId;

    var $appName;

    var $o_registry;

    var $o_model;

    var $availableActions;

    var $defaultActions = array(
        ACTION_PROBLEM    => array('Action/Problem.php', 'FF_Action_Problem'),
        ACTION_ADD        => array('Action/Form.php', 'FF_Action_Form'),
        ACTION_ADD_SUBMIT => array('Action/FormSubmit.php', 'FF_Action_FormSubmit'),
        ACTION_EDIT       => array('Action/Form.php', 'FF_Action_Form'),
        ACTION_EDIT_SUBMIT=> array('Action/FormSubmit.php', 'FF_Action_FormSubmit'),
        ACTION_DELETE     => array('Action/Delete.php', 'FF_Action_Delete'),
        ACTION_LIST       => array('Action/List.php', 'FF_Action_List'),
        ACTION_SELECT     => array('Action/List.php', 'FF_Action_List'),
        ACTION_DISPLAY    => array('Action/Display.php', 'FF_Action_Display'),
        ACTION_TREE       => array('Action/Tree.php', 'FF_Action_Tree'),
        ACTION_TREE       => array('Action/Tree.php', 'FF_Action_Tree'),
        ACTION_DOWNLOAD   => array('Action/Download.php', 'FF_Action_Download'),
        ACTION_CONTACT    => array('Action/Contact.php', 'FF_Action_Contact'),
        ACTION_CONTACT_SUBMIT => array('Action/ContactSubmit.php', 'FF_Action_ContactSubmit'),
    );

    // }}}
    // {{{ constructor

    function FF_ActionHandler()
    {
        $this->o_registry =& FF_Registry::singleton();
        $this->_initializeErrorHandler();
        FF_Auth::startSession();
        // Always set the locale to a guaranteed language first so that a custom language
        // (i.e. en_BIP) will work
        FF_Locale::setLang('en_US');

        if (FF_Request::getParam('actionId', 'g') == ACTION_HOME &&
            is_array($a_init = FF_Auth::getCredential('initPage'))) {
            $this->setActionId(@$a_init['actionId']);
            $this->setModuleId(@$a_init['module']);
            $this->setAppId($a_init['app']);
        }
        elseif (FF_Request::getParam('app', 'pg', false) === false) {
            foreach ($this->o_registry->getApps() as $s_app) {
                $m_hosts = (array) $this->o_registry->getAppParam('hostnames', array(), $s_app); 
                foreach ($m_hosts as $s_host ) {
                    if (!empty($_SERVER['HTTP_HOST']) && $_SERVER['HTTP_HOST'] == $s_host ) {
                        $this->setActionId('');
                        $this->setModuleId('');
                        $this->setAppId($s_app);
                        break;
                    }    
                }
            }
        }
        else {
            $this->setActionId(FF_Request::getParam('actionId', 'pg'));
            $this->setModuleId(FF_Request::getParam('module', 'pg'));
            $this->setAppId(FF_Request::getParam('app', 'pg'));
        }

        $this->_makeDefaultPathsAbsolute();
        $this->_checkProfile();
    }

    // }}}
    // {{{ singleton()

    function &singleton()
    {
        static $instance;
        if (!isset($instance)) {
            $instance = new FF_ActionHandler();
        }

        return $instance;
    }

    // }}}
    // {{{ takeAction()

    function takeAction()
    {
        $hitLastAction = false;
        while (!$hitLastAction) {
            $this->loadActions();
            $this->_checkActionId();
            $this->checkAuth();
            $this->moduleConfig->checkPerms();
            $pth_actionFile = $this->availableActions[$this->actionId][0];
            require_once $pth_actionFile;
            $o_action =& new $this->availableActions[$this->actionId][1]($this->o_model);
            $o_nextAction = $o_action->run();
            if ($o_nextAction->isLastAction()) {
                $hitLastAction = true;
            }
            else {
                $this->setActionId($o_nextAction->getNextActionId());
                if (!is_null($o_nextAction->getNextAppId())) {
                    $this->setAppId($o_nextAction->getNextAppId());
                }

                if (!is_null($o_nextAction->getNextModuleId())) {
                    $this->setModuleId($o_nextAction->getNextModuleId());
                }
            }
        }
    }

    // }}}
    // {{{ loadActions()

    function loadActions()
    {
        static $a_configObjects, $s_lastApp, $s_lastModule;
        settype($a_configObjects, 'array');
        if (empty($this->appId)) {
            $this->appId = $this->o_registry->getConfigParam('general/initial_app');
        }

        if ($s_lastApp != $this->appId) {
            $this->o_registry->pushApp($this->appId);
            // If changing apps then need to check profile again
            $this->_checkProfile();
        }

        if (empty($this->moduleId)) {
            $this->moduleId = $this->o_registry->getConfigParam('general/initial_module');
        }

        // no need to reload if not changing module and app 
        if ($s_lastApp == $this->appId && $s_lastModule == $this->moduleId) {
            return;
        }

        $s_lastApp = $this->appId;
        $s_lastModule = $this->moduleId;
        $s_className = 'FF_ActionHandlerConfig_' . $this->moduleId;
        if (!isset($a_configObjects[$s_className])) {
            $pth_config= $this->o_registry->getAppFile("ActionHandler/$this->moduleId.php", $this->appId, 'libs'); 
            if (file_exists($pth_config)) {
                require_once $pth_config;
                $a_configObjects[$s_className] =& new $s_className($this);
            }
            else {
                trigger_error('The class file ' . basename($pth_config) . ' for module ' . $this->moduleId . ' does not exist', E_USER_ERROR);
            }
        }

        $this->availableActions = $this->defaultActions;
        $this->moduleConfig =& $a_configObjects[$s_className];
        $this->moduleConfig->loadConfig();
    }

    // }}}
    // {{{ addAction()

    function addAction($in_actionId, $in_classFile, $in_className)
    {
        $this->availableActions[$in_actionId] = array($in_classFile, $in_className);
    }

    // }}}
    // {{{ batchModifyActions()

    function batchModifyActions($in_actions, $in_path, $in_classExtension, $in_filePrefix = '') {
        foreach ($in_actions as $s_actionId) {
            $s_newPath = $in_path . '/' . $in_filePrefix . basename($this->availableActions[$s_actionId][0]);
            $s_newClass = $this->availableActions[$s_actionId][1] . $in_classExtension;
            $this->addAction($s_actionId, $s_newPath, $s_newClass);
        }
    }

    // }}}
    // {{{ setAppId()

    function setAppId($in_appId)
    {
        $this->appId = $in_appId;
    }

    // }}}
    // {{{ getAppId()

    function getAppId()
    {
        return $this->appId;
    }

    // }}}
    // {{{ setModuleId()

    function setModuleId($in_moduleId)
    {
        $this->moduleId = $in_moduleId;
    }

    // }}}
    // {{{ getModuleId()

    function getModuleId()
    {
        return $this->moduleId;
    }

    // }}}
    // {{{ setActionId()

    function setActionId($in_actionId)
    {
        $this->actionId = $in_actionId;
    }

    // }}}
    // {{{ getActionId()

    function getActionId()
    {
        return $this->actionId;
    }

    // }}}
    // {{{ setDefaultActionId()

    function setDefaultActionId($in_actionId)
    {
        $this->defaultActionId = $in_actionId;
    }

    // }}}
    // {{{ checkAuth()

    function checkAuth($in_noModuleCheck = false)
    {
        if (!$in_noModuleCheck && $this->moduleConfig->hasCheckAuth()) {
            $this->moduleConfig->checkAuth();
        } 
        else {
            if (!FF_Auth::checkAuth(true)) {
                $this->setAppId('login');
                $this->setModuleId($this->o_registry->getConfigParam('general/initial_module', null, $this->appId));
                $this->loadActions();
                // If there was no app specified then they have arrived newly at the
                // site.  We don't want to bounce them to the initial app only to have
                // them bounce back to the login page.  So we send them straight to it.
                if (FF_Request::getParam('app', 'gp', false) === false) {
                    $this->setActionId($this->defaultActionId);
                }
                else {
                    // They were trying to get somewhere but don't have
                    // auth, store where they were trying to go so we can
                    // bounce back there after login.
                    $s_redirectURL = preg_replace('/[?&]' . session_name() . '=[^?&]*/', '', $_SERVER['REQUEST_URI']);
                    FF_Request::setParam('loginRedirect', $s_redirectURL, 'p');
                    $this->setActionId(ACTION_LOGOUT);
                }
            }
        }
    }

    // }}}
    // {{{ _checkActionId()

    function _checkActionId()
    {
        if (empty($this->actionId) ||
            !isset($this->availableActions[$this->actionId])) {
            if (isset($this->availableActions[$this->defaultActionId])) {
                $this->setActionId($this->defaultActionId);
            }
            else {
                $this->setActionId(ACTION_PROBLEM);
            }
        }
    }

    // }}}
    // {{{ _makeDefaultPathsAbsolute()

    function _makeDefaultPathsAbsolute()
    {
        $s_path = dirname(__FILE__) . '/';
        foreach ($this->defaultActions as $s_action => $a_vals) {
            if (strpos($a_vals[0], '/') !== 0) {
                $this->defaultActions[$s_action][0] = $s_path . $a_vals[0];
            }
        }
    }

    // }}}
    // {{{ _initializeErrorHandler()

    function _initializeErrorHandler()
    {
        // This causes all pear errors to be sent to the error handler
        PEAR::setErrorHandling(PEAR_ERROR_TRIGGER, E_USER_NOTICE); 
        // Don't re-initialize the error handler
        if (!isset($GLOBALS['o_error'])) {
            $o_error = new FF_ErrorHandler($this->o_registry->getConfigParam('error/reporters', array()));
            $GLOBALS['o_error'] =& $o_error;
            $o_error->setDateFormat('[Y-m-d H:i:s]');
            $o_error->setExcludeObjects(false);
            $o_error->setFileUrl($this->o_registry->getConfigParam('error/file_url'));
        }
    }

    // }}}
    // {{{ _checkProfile()

    function _checkProfile()
    {
        if ($this->o_registry->hasApp('profile') &&
            !FF_Auth::isGuest() &&
            !FF_Auth::getCredential('isProfileComplete') &&
            $this->getActionId() != ACTION_LOGOUT &&
            $this->o_registry->getConfigParam('profile/force_complete', false, 'profile')) {
            require_once $this->o_registry->getAppFile('ActionHandler/actions.php', 'profile', 'libs');
            // Don't redirect if already on the profile page or submitting it
            if ($this->getActionId() != ACTION_MYPROFILE && $this->getActionId() != ACTION_EDIT_SUBMIT) {
                FastFrame::redirect(FastFrame::url('index.php', array('app' => 'profile', 'actionId' => ACTION_MYPROFILE)));
            }
        }
    }

    // }}}
}
?>

---