File Source for FrontController.inc

<?php
require_once $config->get('sysRoot').'alpha/util/AlphaErrorHandlers.inc';
require_once $config->get('sysRoot').'alpha/exceptions/AlphaException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/SecurityException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/ResourceNotFoundException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/IllegalArguementException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/LibraryNotInstalledException.inc';
require_once $config->get('sysRoot').'alpha/util/filters/AlphaFilterInterface.inc';
require_once $config->get('sysRoot').'alpha/model/BadRequestObject.inc';
require_once $config->get('sysRoot').'alpha/controller/AlphaController.inc';
/**
*
* The front controller designed to optionally handle all requests
*
* @package alpha::controller::front
* @since 1.0
* @author John Collins <dev@alphaframework.org>
* @version $Id: FrontController.inc 1341 2011-03-17 15:02:02Z johnc $
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2011, John Collins (founder of Alpha Framework).
* All rights reserved.
*
* <pre>
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
* * Neither the name of the Alpha Framework nor the names
* of its contributors may be used to endorse or promote
* products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* </pre>
*
*/
class FrontController {
/**
* The GET query string
*
* @var string
* @since 1.0
*/
private $queryString;
/**
* The name of the page controller we want to invoke
*
* @var string
* @since 1.0
*/
private $pageController;
/**
* Boolean to flag if the GET query string is encrypted or not
*
* @var boolean
* @since 1.0
*/
private $encryptedQuery = false;
/**
* An array of controller alias
*
* @var array
* @since 1.0
*/
private $controllerAlias = array();
/**
* An array of HTTP filters applied to each request to the front controller. Each
* member must implement AlphaFilterInterface!
*
* @var array
* @since 1.0
*/
private $filters = array();
/**
* The name of the current alias
*
* @var string
* @since 1.0
*/
private $currentAlias;
/**
* Trace logger
*
* @var Logger
* @since 1.0
*/
private static $logger = null;
/**
* The constructor method
*
* @throws ResourceNotFoundException
* @since 1.0
*/
public function __construct() {
self::$logger = new Logger('FrontController');
self::$logger->debug('>>__construct()');
global $config;
self::$logger->debug('Requested URL is ['.$_SERVER['REQUEST_URI'].']');
// direct calls to the front controller
if (isset($_GET['act'])) {
self::$logger->debug('Processing direct request to the front controller');
$this->pageController = $_GET['act'];
// calls to the front controller via mod_rewrite
}elseif($config->get('sysUseModRewrite') && !isset($_GET['tk'])) {
self::$logger->debug('Processing a mod_rewrite request');
$this->handleModRewriteRequests();
// direct calls to the front controller with an encrypted query string
}else{
if (!isset($_GET['tk'])) {
self::$logger->warn('No controller action set for the front controller, URL is ['.$_SERVER['REQUEST_URI'].']');
throw new ResourceNotFoundException('The file that you have requested cannot be found!');
}else{
self::$logger->debug('Processing a direct request to the front controller with an encrypted token param');
$this->setEncrypt(true);
try {
$this->decodeQuery();
$this->populateGetVars();
if(isset($_GET['act']))
$this->pageController = $_GET['act'];
else
throw new SecurityException('No act param provided in the secure token!');
}catch (SecurityException $e) {
self::$logger->error('Error while attempting to decode a secure token in the FrontController: '.$e->getMessage());
throw new ResourceNotFoundException('The file that you have requested cannot be found!');
}
}
}
self::$logger->debug('<<__construct');
}
/**
* Sets the encryption flag
*
* @param boolean $encryptedQuery
* @since 1.0
*/
public function setEncrypt($encryptedQuery) {
$this->encryptedQuery = $encryptedQuery;
}
/**
* Method to populate the global _GET and _REQUEST arrays with the decoded
* query string
*
* @since 1.0
*/
private function populateGetVars() {
$pairs = explode('&', $this->queryString);
foreach($pairs as $pair) {
$keyValue = explode('=', $pair);
if(count($keyValue) == 2) {
$_GET[$keyValue[0]] = $keyValue[1];
$_REQUEST[$keyValue[0]] = $keyValue[1];
}
}
}
/**
* Static method for generating an absolute, secure URL for a page controller
*
* @param string $params
* @return string
* @since 1.0
*/
public static function generateSecureURL($params) {
global $config;
if($config->get('sysUseModRewrite'))
return $config->get('sysURL').'tk/'.FrontController::encodeQuery($params);
else
return $config->get('sysURL').'?tk='.FrontController::encodeQuery($params);
}
/**
* Static method for encoding a query string
*
* @param string $queryString
* @return string
* @since 1.0
*/
public static function encodeQuery($queryString) {
global $config;
$td = mcrypt_module_open ('tripledes', '', 'ecb', '');
$iv = mcrypt_create_iv (mcrypt_enc_get_iv_size ($td), MCRYPT_RAND);
mcrypt_generic_init ($td, $config->get('sysQSKey'), $iv);
$encryptedData = mcrypt_generic ($td, $queryString);
mcrypt_generic_deinit ($td);
mcrypt_module_close ($td);
$return = base64_encode($encryptedData);
// remove any characters that are likely to cause trouble on a URL
$return = strtr($return, '+/', '-_');
return $return;
}
/**
* Method to decode the current query string
*
* @throws SecurityException
* @since 1.0
*/
private function decodeQuery() {
global $config;
if (!isset($_GET['tk'])) {
throw new SecurityException('No token provided for the front controller!');
}else{
$td = mcrypt_module_open('tripledes', '', 'ecb', '');
$iv = mcrypt_create_iv(mcrypt_enc_get_iv_size ($td), MCRYPT_RAND);
// replace any troublesome characters from the URL with the original values
$token = strtr($_GET['tk'], '-_', '+/');
$token = base64_decode($token);
$this->queryString = trim(mcrypt_decrypt('tripledes', $config->get('sysQSKey'), $token, 'ecb', $iv));
}
}
/**
* Static method to return the decoded GET paramters from an encrytpted tk value
*
* @return string
* @since 1.0
*/
public static function decodeQueryParams($tk) {
global $config;
$td = mcrypt_module_open('tripledes', '', 'ecb', '');
$iv = mcrypt_create_iv(mcrypt_enc_get_iv_size ($td), MCRYPT_RAND);
// replace any troublesome characters from the URL with the original values
$token = strtr($tk, '-_', '+/');
$token = base64_decode($token);
$params = trim(mcrypt_decrypt('tripledes', $config->get('sysQSKey'), $token, 'ecb', $iv));
return $params;
}
/**
* Static method to return the decoded GET paramters from an encrytpted tk value as an array of key/value pairs.
*
* @return array
* @since 1.0
*/
public static function getDecodeQueryParams($tk) {
global $config;
$td = mcrypt_module_open('tripledes', '', 'ecb', '');
$iv = mcrypt_create_iv(mcrypt_enc_get_iv_size ($td), MCRYPT_RAND);
// replace any troublesome characters from the URL with the original values
$token = strtr($tk, '-_', '+/');
$token = base64_decode($token);
$params = trim(mcrypt_decrypt('tripledes', $config->get('sysQSKey'), $token, 'ecb', $iv));
$pairs = explode('&', $params);
$parameters = array();
foreach($pairs as $pair) {
$split = explode('=', $pair);
$parameters[$split[0]] = $split[1];
}
return $parameters;
}
/**
* Method to load the page controller
*
* @param boolean $allowRedirects Defaults to true, set to false if you want to prevent the front controller from redirecting the request
* @throws ResourceNotFoundException
* @since 1.0
*/
public function loadController($allowRedirects = true) {
global $config;
if($allowRedirects && $config->get('sysCheckInstalled') && $this->pageController != 'Install' && $this->pageController != 'Login') {
if(!AlphaDAO::isInstalled()) {
self::$logger->info('Invoking the Install controller as the system DB is not installed...');
$url = FrontController::generateSecureURL('act=Install');
self::$logger->info('Redirecting to ['.$url.']');
header('Location: '.$url);
exit;
}
}
// first process any attached filters
foreach ($this->filters as $filter)
$filter->process();
if($allowRedirects) {
// if there is an alias configured for the above page controller, redirect there
if($config->get('sysForceFC') && $this->hasAlias($this->pageController)) {
// make sure that it is not already an alias-based request to prevent re-direct loop
if(empty($this->currentAlias)) {
// set the correct HTTP header for the response
header('HTTP/1.1 301 Moved Permanently');
// see if there are any other GET params appart from the controller name
if (count($_GET) > 1) {
$keys = array_keys($_GET);
$param = $_GET[$keys[1]];
// if its a title then replace spaces with underscores in the URL
if($keys[1] == 'title')
$param = str_replace(' ','_',$param);
$URL = $config->get('sysURL').'/'.$this->getControllerAlias($this->pageController).'/'.
$this->getControllerParam($this->pageController).$param;
}else{
$URL = $config->get('sysURL').'/'.$this->getControllerAlias($this->pageController);
}
header('Location: '.$URL);
exit;
}
}
}
try {
AlphaController::loadControllerDef($this->pageController);
$pageController = new $this->pageController();
if(!empty($_POST)) {
$pageController->doPOST($_REQUEST);
}else{
$pageController->doGET($_GET);
}
}catch (LibraryNotInstalledException $e) {
self::$logger->warn($e->getMessage()."\nStacktrace:\n".$e->getTraceAsString()."\nRequest params:\n".var_export($_REQUEST, true)."\nRequested resource:\n".$_SERVER['REQUEST_URI']);
throw new LibraryNotInstalledException($e->getMessage());
}catch (ResourceNotAllowedException $e) {
self::$logger->warn($e->getMessage()."\nStacktrace:\n".$e->getTraceAsString()."\nRequest params:\n".var_export($_REQUEST, true)."\nRequested resource:\n".$_SERVER['REQUEST_URI']);
throw new ResourceNotAllowedException($e->getMessage());
}catch (ResourceNotFoundException $e) {
self::$logger->warn($e->getMessage()."\nStacktrace:\n".$e->getTraceAsString()."\nRequest params:\n".var_export($_REQUEST, true)."\nRequested resource:\n".$_SERVER['REQUEST_URI']);
throw new ResourceNotFoundException($e->getMessage());
}catch (IllegalArguementException $e) {
self::$logger->warn($e->getMessage()."\nStacktrace:\n".$e->getTraceAsString()."\nRequest params:\n".var_export($_REQUEST, true)."\nRequested resource:\n".$_SERVER['REQUEST_URI']);
if($config->get('sysEnableClientTempBlacklistFiler')) {
if(isset($_SERVER['HTTP_USER_AGENT']) && isset($_SERVER['REMOTE_ADDR']) && isset($_SERVER['REQUEST_URI'])) {
$request = new BadRequestObject();
$request->set('client', $_SERVER['HTTP_USER_AGENT']);
$request->set('IP', $_SERVER['REMOTE_ADDR']);
$request->set('requestedResource', $_SERVER['REQUEST_URI']);
$request->save();
}
}
throw new ResourceNotFoundException('The file that you have requested cannot be found!');
}catch (AlphaException $e) {
self::$logger->warn($e->getMessage()."\nStacktrace:\n".$e->getTraceAsString()."\nRequest params:\n".var_export($_REQUEST, true)."\nRequested resource:\n".$_SERVER['REQUEST_URI']);
if($config->get('sysEnableClientTempBlacklistFiler')) {
if(isset($_SERVER['HTTP_USER_AGENT']) && isset($_SERVER['REMOTE_ADDR']) && isset($_SERVER['REQUEST_URI'])) {
$request = new BadRequestObject();
$request->set('client', $_SERVER['HTTP_USER_AGENT']);
$request->set('IP', $_SERVER['REMOTE_ADDR']);
$request->set('requestedResource', $_SERVER['REQUEST_URI']);
$request->save();
}
}
throw new ResourceNotFoundException('The file that you have requested cannot be found!');
}
}
/**
* Used to register a controller alias to enable shorter URLs with mod_rewrite support enabled. Note that
* only controllers with a single parameter are supported.
*
* @param string $controller The name of the page controller class
* @param string $alias The URL alias for the page controller
* @param string $param The name of the GET parameter on the alias URL request
* @since 1.0
*/
public function registerAlias($controller, $alias, $param=null) {
$this->controllerAlias[$alias] = $controller;
if(isset($param))
$this->controllerAlias[$alias.'_param'] = $param;
// set up the page controller
$this->handleModRewriteRequests();
}
/**
* Check to see if an alias exists for the given alias name
*
* @param string $alias
* @return boolean
* @since 1.0
*/
public function checkAlias($alias) {
if(array_key_exists($alias, $this->controllerAlias))
return true;
else
return false;
}
/**
* Check to see if an alias exists for the given controller name
*
* @param string $controller
* @return boolean
* @since 1.0
*/
public function hasAlias($controller) {
if(in_array($controller, $this->controllerAlias))
return true;
else
return false;
}
/**
* Gets the full name of the controller for the given alias
*
* @param string $alias
* @return string
* @since 1.0
*/
public function getAliasController($alias) {
if(array_key_exists($alias, $this->controllerAlias))
return $this->controllerAlias[$alias];
}
/**
* Gets the name of the alias for the given controller
*
* @param string $controller
* @return string
* @since 1.0
*/
public function getControllerAlias($controller) {
if(in_array($controller, $this->controllerAlias)) {
$keys = array_keys($this->controllerAlias, $controller);
// there should only ever be one key per controller
return $keys[0];
}
}
/**
* Gets the parameter name expected in requests to the controller with the given alias
*
* @param string $alias
* @return string
* @since 1.0
*/
public function getAliasParam($alias) {
if(array_key_exists($alias.'_param', $this->controllerAlias))
return $this->controllerAlias[$alias.'_param'];
else
return '';
}
/**
* Gets the parameter name expected in requests to the controller with the given controller name
*
* @param string $controller
* @return string
* @since 1.0
*/
public function getControllerParam($controller) {
$alias = $this->getControllerAlias($controller);
if(array_key_exists($alias.'_param', $this->controllerAlias))
return $this->controllerAlias[$alias.'_param'];
else
return '';
}
/**
* Handles all of the rules for mod_rewrite style URL parsing
*
* @since 1.0
*/
private function handleModRewriteRequests() {
self::$logger->debug('>>handleModRewriteRequests');
global $config;
// strip off the system URL from the request URL
$request = str_replace($config->get('sysURL'), '', 'http://'.$_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI']);
self::$logger->debug('$request is ['.$request.']');
$params = explode('/', $request);
self::$logger->debug('$params are ['.var_export($params, true).']');
try {
// first param will always be the controller alias
if(empty($this->currentAlias) && !empty($params[0]))
$this->currentAlias = $params[0];
// check to see if we can load the page controller without an alias
AlphaController::loadControllerDef($params[0]);
self::$logger->debug('Page controller name set on the request URL is ['.$params[0].']');
$this->pageController = $params[0];
}catch (IllegalArguementException $iae) {
// handle request with alias
self::$logger->debug('The supplied controller alias is ['.$this->currentAlias.']');
// check to see if the controller is an alias for something
if($this->checkAlias($this->currentAlias)) {
$this->pageController = $this->getAliasController($this->currentAlias);
self::$logger->debug('Page controller name obtained from the URL alias is ['.$this->pageController.']');
if(isset($params[1])) {
if(!empty($_POST))
$_REQUEST[$this->getAliasParam($this->currentAlias)] = $params[1];
else
$_GET[$this->getAliasParam($this->currentAlias)] = $params[1];
}
}
}
self::$logger->debug('$params are ['.var_export($params, true).']');
self::$logger->debug('currentAlias is ['.$this->currentAlias.']');
// now populate the _GET vars
if($this->currentAlias == 'tk') {
self::$logger->debug('Setting the GET vars for a mod_rewrite request with a tk param');
$this->setEncrypt(true);
$this->queryString = FrontController::decodeQueryParams($params[1]);
$_GET['tk'] = $params[1];
$this->populateGetVars();
$this->pageController = $_GET['act'];
}else{
$count = count($params);
for($i = 1; $i < $count; $i+=2) {
if(isset($params[$i+1])) {
if(!empty($_POST))
$_REQUEST[$params[$i]] = $params[$i+1];
else
$_GET[$params[$i]] = $params[$i+1];
}
}
}
self::$logger->debug('$_GET is ['.var_export($_GET, true).']');
self::$logger->debug('<<handleModRewriteRequests');
}
/**
* Getter for the page controller
*
* @return string
* @since 1.0
*/
public function getPageController() {
return $this->pageController;
}
/**
* Add the supplied filter object to the list of filters ran on each request to the front controller
*
* @param AlphaFilterInterface $filterObject
* @throws IllegalArguementException
* @since 1.0
*/
public function registerFilter($filterObject) {
if($filterObject instanceof AlphaFilterInterface)
array_push($this->filters, $filterObject);
else
throw new IllegalArguementException('Supplied filter object is not a valid AlphaFilterInterface instance!');
}
/**
* Returns the array of filters currently attached to this FrontController
*
* @return array
* @since 1.0
*/
public function getFilters() {
return $this->filters;
}
}
?>

	alpha--controller--front

[ class tree: alpha--controller--front ] [ index: alpha--controller--front ] [ all elements ]

Source for file FrontController.inc