LoginSubmit.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 FASTFRAME_ROOT . 'lib/FastFrame/Action.php';
require_once FASTFRAME_ROOT . 'lib/FastFrame/Hooks.php';

// }}}
// {{{ class FF_Action_LoginSubmit

// }}}
class FF_Action_LoginSubmit extends FF_Action {
    // {{{ run()
    
    function run()
    {
        // isAdminLogin is used when logging into another user's account via profile list
        if (FF_Request::getParam('isAdminLogin', 's', false) ||
            (($o_result = FF_Auth::authenticate(FF_Request::getParam('username', 'p'), FF_Request::getParam('password', 'p'))) && $o_result->isSuccess())) {
            $o_hooks =& FF_Hooks::singleton();
            // If the profile application is installed then set the user Id
            if ($this->o_registry->hasApp('profile')) {
                require_once $this->o_registry->getAppFile('Model/ProfileManager.php', 'profile', 'libs');
                $o_profileManager =& new FF_Model_ProfileManager();
                $o_profileModel =& $o_profileManager->getModelObject('profile');
                $s_userId = $o_profileModel->getIdByUsername(FF_Auth::getCredential('username'), 
                        FF_Auth::getCredential('authSource'));
                // if they were able to log on, but don't have a user id, then they logged on
                // with an auth source other than the profile database, so give them an empty profile
                if (is_null($s_userId)) {
                    $o_profileModel->setUsername(FF_Auth::getCredential('username'));
                    $o_profileModel->setAuthSource(FF_Auth::getCredential('authSource'));
                    $o_result =& $o_profileManager->addMinimalProfile();
                    if (!$o_result->isSuccess()) {
                        $this->o_output->setMessage(_('Error encountered in creating your profile.'));
                        $this->o_output->setMessage($o_result->getMessages());
                        $this->setProblemActionId();
                        return $this->o_nextAction;
                    }
                    else {
                        $s_userId = $o_profileModel->getId();
                    }
                }

                // Load in some of their profile settings as credentials
                $o_profileModel->setId($s_userId);
                FF_Auth::setCredential('userId', $s_userId); 

                // Now that defaults are loaded, run the login hooks
                $o_hooks->run('login', array($o_profileModel->getLastLogin()));

                // Now that anything that could affect their profile is done, update a few things
                $o_profileModel->fillById($s_userId);
                // See if their profile has been marked inactive
                if ($o_profileModel->getIsInactive()) {
                    FF_Auth::logout();
                    $this->o_output->setMessage(_('Your account is inactive.  Please contact your system administrator'), FASTFRAME_ERROR_MESSAGE);
                    $this->setProblemActionId();
                    return $this->o_nextAction;
                }

                $s_theme = $o_profileModel->getTheme();
                $s_lang = $o_profileModel->getLanguage(); 
                FF_Request::setParam('searchBoxType', $o_profileModel->getListMode(), 's');
                FF_Request::setParam('defDispLimit', $o_profileModel->getListLength(), 's');
                
                if (($a_initPage = $this->getAppByHostName()) == null ) {
                    $a_initPage = $o_profileModel->getInitialPage();
                }
                $o_profileModel->setLastLogin(time(), true);
                FF_Auth::setCredential('isProfileComplete', $o_profileManager->isProfileComplete($s_userId));
            }
            else {
                FF_Auth::setCredential('userId', 0);
                $o_hooks->run('login', array(0));
                $s_theme = $this->o_registry->getConfigParam('general/default_theme');
                $s_lang = FF_Locale::selectLang(); 
                if (($a_initPage = $this->getAppByHostName()) == null ) {
                    $tmp_app = $this->o_registry->getConfigParam('general/initial_app'); 
                    $tmp_module = $this->o_registry->getConfigParam('general/initial_module', null, $tmp_app); 
                    $a_initPage = array('app' => $tmp_app, 'module' => $tmp_module, 'actionId' => null);
                }
            
            }

            FF_Auth::setCredential('theme', $s_theme);
            FF_Auth::setCredential('language', $s_lang);
            FF_Auth::setCredential('initPage', $a_initPage);

            // login is successful proceed to initial app or where we came from
            $s_redirectURL = FF_Request::getParam('loginRedirect', 'p');
            if (empty($s_redirectURL)) {
                if ($a_initPage['app'] != $this->o_registry->getCurrentApp()) {
                    $a_initPage['actionId'] = false;
                    $s_redirectURL = FastFrame::selfURL($a_initPage, true);
                }
                else {
                    $s_redirectURL = FastFrame::selfURL(array('actionId' => ACTION_DISPLAY,
                                'module' => '', 'app' => $this->o_registry->getCurrentApp()), true);
                }
            }
            else {
                // This adds the session to the url and makes sure the ssl part is correct
                $s_redirectURL = FastFrame::url($s_redirectURL, array(), true);
            }

            // Always redirect on successful login.  This prevents the user from hitting
            // hitting the back button after logout and re-submitting the login form.
            FastFrame::redirect($s_redirectURL, true);
        }
        else {
            if (is_object($o_result)) {
                $this->o_output->setMessage($o_result->getMessages(), FASTFRAME_WARNING_MESSAGE);
            }

            $this->o_output->setMessage($this->getProblemMessage(), FASTFRAME_ERROR_MESSAGE);
            $this->setProblemActionId();
        }

        return $this->o_nextAction;
    }

    // }}}
    // {{{ getProblemMessage()

    function getProblemMessage()
    {
        return _('Login failed.  Please check your username and password and try again.');
    }

    // }}}
    // {{{ setProblemActionId()

    function setProblemActionId()
    {
        $this->o_nextAction->setNextActionId(ACTION_LOGIN);
    }

    // }}}
    // {{{ setSuccessActionId()

    function setSuccessActionId()
    {
        $this->o_nextAction->setNextActionId(ACTION_DISPLAY);
    }

    // }}}
    // {{{ getAppByHostName()

    function getAppByHostName()
    {
        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 (FF_Request::getParam('orig_hostname', 'p') == $s_host ) {
                    return array('app' => $s_app, 'module' => '', 'actionId' => '');
                }
            }
        }

        return null;
    }
            
    // }}}
}
?>

---