class.Application.php

Go to the documentation of this file.

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2014 wemove digital solutions GmbH
 *
 * Licensed under the terms of any of the following licenses
 * at your choice:
 *
 * - GNU Lesser General Public License (LGPL)
 *   http://www.gnu.org/licenses/lgpl.html
 * - Eclipse Public License (EPL)
 *   http://www.eclipse.org/org/documents/epl-v10.php
 *
 * See the license.txt file distributed with this work for
 * additional information.
 *
 * $Id: class.Application.php 1462 2014-02-04 23:52:27Z iherwig $
 */
require_once("base_dir.php");

require_once(BASE."wcmf/lib/util/class.Message.php");
require_once(BASE."wcmf/lib/util/class.SessionData.php");
require_once(BASE."wcmf/lib/output/class.LogOutputStrategy.php");
require_once(BASE."wcmf/lib/presentation/class.WCMFInifileParser.php");
require_once(BASE."wcmf/lib/persistence/class.PersistenceFacade.php");
require_once(BASE."wcmf/lib/security/class.AuthUser.php");
require_once(BASE."wcmf/lib/presentation/ListboxFunctions.php");
require_once(BASE."wcmf/lib/util/class.JSONUtil.php");
require_once(BASE."wcmf/lib/util/class.Log.php");

/**
 * Function to be called when an php error should be handled.
 * Set with set_error_handler.
 */
function globalErrorHandler($errno, $errstr, $errfile, $errline)
{
  switch ($errno)
  {
    case E_WARNING:
    case E_NOTICE:
    case E_USER_NOTICE:
    case E_USER_WARNING:
      Log::warn($errstr." in ".$errfile.":".$errline, 'Application');
      break;
    case E_USER_ERROR:
      WCMFException::throwEx($errstr, $errfile, $errline);
      break;
  }
}

/**
 * @class Application
 * @ingroup Presentation
 * @brief The main application class. Does all the initialization.
 *
 * @author ingo herwig <ingo@wemove.com>
 */
class Application
{
  var $_data = null;

  /**
   * Returns an instance of the class.
   * @return A reference to the only instance of the Singleton object
   */
  function &getInstance()
  {
    static $instance = null;

    if (!isset($instance)) {
      $instance = new Application();
    }
    return $instance;
  }
  /**
   * Constructor
   */
  function Application()
  {
    // collect all request data
    $this->_data = array_merge($_GET, $_POST, $_COOKIE, $_FILES);
    $json = JSONUtil::decode(file_get_contents('php://input'), true);
    if (is_array($json))
    {
      foreach ($json as $key => $value) {
        $this->_data[$key] = $value;
      }
    }
    // store data in global variables to make them accessible by error handlers
    $GLOBALS['data'] = &$this->_data;
  }
  /**
   * Initialize the application.
   * - Parses and processes the configuration
   * - Sets global variables
   * - Initialize the session and other main application classes
   * - Extracts the application parameters
   * @param configPath The path where config files reside (as seen from main.php), optional [default: 'include/']
   * @param mainConfigFile The main configuration file to use, optional [default: 'config.ini']
   * @param defaultController The controller to call if none is given in request parameters, optional [default: 'LoginController']
   * @param defaultContext The context to set if none is given in request parameters, optional [default: '']
   * @param defaultAction The action to perform if none is given in request parameters, optional [default: 'login']
   * @param defaultResponseFormat The response format if none is given in request parameters, optional [default: MSG_FORMAT_HTML]
   * @return An associative array with keys 'action', 'context', 'controller', 'data'
   */
  function initialize($configPath='include/', $mainConfigFile='config.ini',
    $defaultController='LoginController', $defaultContext='', $defaultAction='login',
    $defaultResponseFormat=MSG_FORMAT_HTML)
  {
    Application::setupGlobals($configPath, $mainConfigFile);
    $parser = &WCMFInifileParser::getInstance();

    // include files from implementation section
    // NOTE: this must be done before the session is started to avoid incomplete object definitions
    $objectFactory = &ObjectFactory::getInstance();
    $implementationFiles = array_values($parser->getSection("implementation"));
    foreach($implementationFiles as $implementationFile)
    {
      $impl = BASE.$objectFactory->getClassfileFromConfig($implementationFile);
      if (is_file($impl))
        require_once(BASE.$objectFactory->getClassfileFromConfig($implementationFile));
      else
        WCMFException::throwEx("Implementation file ".$implementationFile." not found.", __FILE__, __LINE__);
    }

    // initialize session with session id if given
    $sessionId = Application::getCallParameter('sid', false);
    if ($sessionId === false) { 
      $sessionId = Application::getCallParameter('PHPSESSID', false);
    }
    if ($sessionId !== false) {
      SessionData::init($sessionId);
    }

    // clear errors
    $session = &SessionData::getInstance();
    $session->clearErrors();

    // get controller/context/action triple
    // (defaults to /LoginController//login in this application)
    $controller = Application::getCallParameter('controller', $defaultController);
    $context = Application::getCallParameter('context', $defaultContext);
    $action = Application::getCallParameter('usr_action', $defaultAction);
    $readonly = Application::getCallParameter('readonly', false);
    $requestFormat = Application::getCallParameter('request_format', $defaultResponseFormat);
    $responseFormat = Application::getCallParameter('response_format', $defaultResponseFormat);

    // load user configuration
    $rightsManager = &RightsManager::getInstance();
    $authUser = &$rightsManager->getAuthUser();
    if ($authUser && strlen($authUser->getConfig()) > 0)
    {
      if (!$parser->parseIniFile($GLOBALS['CONFIG_PATH'].$authUser->getConfig(), true))
        WCMFException::throwEx($parser->getErrorMsg(), __FILE__, __LINE__);
    }

    // prepare PersistenceFacade
    $persistenceFacade = &PersistenceFacade::getInstance();
    if ($parser->getValue('logDBActions', 'cms') == 1)
      $persistenceFacade->enableLogging(new LogOutputStrategy());
    if ($readonly)
      $persistenceFacade->setReadOnly(true);

    // store data in global variables to make them accessible by error handlers
    $GLOBALS['controller'] = $controller;
    $GLOBALS['context'] = $context;
    $GLOBALS['action'] = $action;
    $GLOBALS['requestFormat'] = $requestFormat;
    $GLOBALS['responseFormat'] = $responseFormat;

    // return the parameters needed to process the requested action
    return array('action' => $action, 'context' => $context, 'controller' => $controller,
      'data' => &$this->_data, 'requestFormat' => $requestFormat, 'responseFormat' => $responseFormat);
  }
  /**
   * Get a value from the call parameters (GET, POST variables)
   * @param name The name of the parameter
   * @param default The value to return, if no value is given
   * @return The value
   */
  function getCallParameter($name, $default)
  {
    $value = $default;
    $application = &Application::getInstance();
    if (array_key_exists($name, $application->_data))
      $value = $application->_data[$name];
    return $value;
  }
  /**
   * Setup global variables. Does nothing related to session, users and persistence.
   * Use this method if you just want to have all global variables initialized and need access to config values.
   * @param configPath The path where config files reside (as seen from main.php), maybe null [default: include/]
   * @param mainConfigFile The main configuration file to use, maybe null [default: config.ini]
   */
  function setupGlobals($configPath='include/', $mainConfigFile='config.ini')
  {
    // globals
    $GLOBALS['CONFIG_PATH'] = $configPath;
    $GLOBALS['CONFIG_EXTENSION'] = "ini";
    $GLOBALS['MAIN_CONFIG_FILE'] = $mainConfigFile;

    // get configuration from file
    $parser = &WCMFInifileParser::getInstance();
    if (!$parser->parseIniFile($GLOBALS['CONFIG_PATH'].$GLOBALS['MAIN_CONFIG_FILE'], true))
      WCMFException::throwEx($parser->getErrorMsg(), __FILE__, __LINE__);

    // message globals
    $GLOBALS['MESSAGE_LOCALE_DIR'] = $parser->getValue('localeDir', 'cms');
    $GLOBALS['MESSAGE_LANGUAGE'] = $parser->getValue('language', 'cms');

    // set locale
    if ($GLOBALS['MESSAGE_LANGUAGE'] !== false)
      setlocale(LC_ALL, $GLOBALS['MESSAGE_LANGUAGE']);

    // we do our own error handling
    set_error_handler("globalErrorHandler", error_reporting());
  }
  /**
   * Get an unique id for the application based on the installation location.
   * @return The id
   */
  function getId()
  {
    return md5($_SERVER['SERVER_ADDR'].__FILE__);
  }
}
?>