lib/AkRequest.php

   1 <?php
   2 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
   3
   4 // +----------------------------------------------------------------------+
   5 // | Akelos Framework - http://www.akelos.org                             |
   6 // +----------------------------------------------------------------------+
   7 // | Copyright (c) 2002-2006, Akelos Media, S.L.  & Bermi Ferrer Martinez |
   8 // | Released under the GNU Lesser General Public License, see LICENSE.txt|
   9 // +----------------------------------------------------------------------+
  10
  11 /**
  12  * @package ActionController
  13  * @subpackage Request
  14  * @author Bermi Ferrer <bermi a.t akelos c.om>
  15  * @copyright Copyright (c) 2002-2006, Akelos Media, S.L. http://www.akelos.org
  16  * @license GNU Lesser General Public License <http://www.gnu.org/copyleft/lesser.html>
  17  */
  18
  19 if(!defined('AK_DEFAULT_CONTROLLER')){
  20     define('AK_DEFAULT_CONTROLLER', 'page');
  21 }
  22 if(!defined('AK_DEFAULT_ACTION')){
  23     define('AK_DEFAULT_ACTION', 'index');
  24 }
  25
  26 defined('AK_HIGH_LOAD_MODE') ? null : define('AK_HIGH_LOAD_MODE', false);
  27 defined('AK_AUTOMATIC_DB_CONNECTION') ? null : define('AK_AUTOMATIC_DB_CONNECTION', !AK_HIGH_LOAD_MODE);
  28 defined('AK_AUTOMATIC_SESSION_START') ? null : define('AK_AUTOMATIC_SESSION_START', !AK_HIGH_LOAD_MODE);
  29
  30 // IIS does not provide a valid REQUEST_URI so we need to guess it from the script name + query string
  31 $_SERVER['REQUEST_URI'] = (isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : $_SERVER['SCRIPT_NAME'].(( isset($_SERVER['QUERY_STRING']) ? '?' . $_SERVER['QUERY_STRING'] : '')));
  32
  33
  34 /**
  35 * Class that handles incoming request.
  36 *
  37 * The Request Object handles user request (CLI, GET, POST, session or
  38 * cookie requests), transforms it and sets it up for the
  39 * ApplicationController class, who takes control of the data
  40 * flow.
  41 *
  42 * @author Bermi Ferrer <bermi@akelos.com>
  43 * @copyright Copyright (c) 2002-2005, Akelos Media, S.L. http://www.akelos.org
  44 * @license GNU Lesser General Public License <http://www.gnu.org/copyleft/lesser.html>
  45 */
  46 class AkRequest extends AkObject
  47 {
  48
  49     /**
  50     * Array containing the request parameters.
  51     *
  52     * This property stores the parameters parsed from the
  53     * parseRequest() method. This array is used by addParams()
  54     * method.
  55     *
  56     * @access private
  57     * @var array $_request
  58     */
  59     var $_request = array();
  60
  61     var $_init_check = false;
  62     var $__internationalization_support_enabled = false;
  63
  64     var $action = AK_DEFAULT_ACTION;
  65     var $controller = AK_DEFAULT_CONTROLLER;
  66     var $view;
  67
  68     /**
  69     * Holds information about current environment. Initially a reference to $_SERVER
  70     *
  71     * @var array
  72     */
  73     var $env = array();
  74
  75
  76     /**
  77     * String parse method.
  78     *
  79     * This method gets a petition as parameter, using the "Ruby
  80     * on Rails" request format (see prettyURL in RoR documentation). The format is:
  81     * file.php?ak=/controller/action/id&paramN=valueN
  82     *
  83     * This method requires for a previous execution of the _mergeRequest() method,
  84     * in order to merge all the request all i one array.
  85     *
  86     * This method expands dynamically the class Request, adding a public property for
  87     * every parameter sent in the request.
  88     *
  89     *
  90     * @access public
  91     * @return array
  92     */
  93     function _parseAkRequestString($ak_request_string, $pattern = '/')
  94     {
  95         $result = array();
  96         $ak_request = trim($ak_request_string,$pattern);
  97         if(strstr($ak_request,$pattern)){
  98             $result = explode($pattern,$ak_request);
  99         }
 100         return $result;
 101     }
 102
 103
 104     function __construct ()
 105     {
 106         $this->init();
 107     }
 108
 109
 110
 111     /**
 112     * Initialization method.
 113     *
 114     * Initialization method. Use this via the class constructor.
 115     *
 116     * @access public
 117     * @uses parseRequest
 118     * @return void
 119     */
 120     function init()
 121     {
 122         if(!$this->_init_check){
 123             $this->env =& $_SERVER;
 124             $this->_fixGpcMagic();
 125             $this->_urlDecode();
 126
 127             $this->_mergeRequest();
 128
 129             if(is_array($this->_request)){
 130                 foreach ($this->_request as $k=>$v){
 131                     $this->_addParam($k, $v);
 132                 }
 133             }
 134
 135             $this->_init_check = true;
 136         }
 137
 138         if(defined('AK_LOG_EVENTS') && AK_LOG_EVENTS){
 139             $this->Logger =& Ak::getLogger();
 140             $this->Logger->message($this->Logger->formatText('Request','green').' from '.$this->getRemoteIp(), $this->getParams());
 141         }
 142     }
 143
 144     function get($var_name)
 145     {
 146         return $this->_request[$var_name];
 147     }
 148
 149     function getParams()
 150     {
 151         return array_merge(array('controller'=>$this->controller,'action'=>$this->action),$this->_request);
 152     }
 153
 154     function getAction()
 155     {
 156         return $this->action;
 157     }
 158
 159     function getController()
 160     {
 161         return $this->controller;
 162     }
 163
 164     function reset()
 165     {
 166         $this->_request = array();
 167         $this->_init_check = false;
 168     }
 169
 170     function set($variable, $value)
 171     {
 172         $this->_addParam($variable, $value);
 173     }
 174
 175
 176     function checkForRoutedRequests(&$Router)
 177     {
 178         $ak_request = isset($this->_request['ak']) ? '/'.trim($this->_request['ak'],'/').'/' : '/';
 179
 180         if($found = $Router->toParams($ak_request)){
 181             if(!isset($found['controller'])){
 182                 trigger_error(Ak::t('No controller was specified.'), E_USER_WARNING);
 183             }
 184             if(!isset($found['action'])){
 185                 trigger_error(Ak::t('No action was specified.'), E_USER_WARNING);
 186             }
 187
 188             if(isset($found['controller'])){
 189                 if($this->_addParam('controller',$found['controller'])){
 190                     $this->controller = $this->_request['controller'] = $found['controller'];
 191                 }
 192             }
 193             if(isset($found['action'])){
 194                 if($this->_addParam('action',$found['action'])){
 195                     $this->action = $this->_request['action'] = $found['action'];
 196                 }
 197             }
 198             if(isset($found['module'])){
 199                 if($this->_addParam('module',$found['module'])){
 200                     $this->module = $this->_request['module'] = $found['module'];
 201                 }
 202             }
 203
 204             foreach ($found as $k=>$v){
 205                 if($this->_addParam($k,$v)){
 206                     $this->_request[$k] = $v;
 207                 }
 208             }
 209         }
 210     }
 211
 212
 213     function isValidControllerName($controller_name)
 214     {
 215         return $this->_validateTechName($controller_name);
 216     }
 217
 218     function isValidActionName($action_name)
 219     {
 220         return $this->_validateTechName($action_name);
 221     }
 222
 223     function isValidModuleName($module_name)
 224     {
 225         return preg_match('/^[A-Za-z]{1,}[A-Za-z0-9_\/]*$/', $module_name);
 226     }
 227
 228
 229
 230     /**
 231     * Returns both GET and POST parameters in a single array.
 232     */
 233     function getParameters()
 234     {
 235         if(empty($this->parameters)){
 236             $this->parameters = $this->getParams();
 237         }
 238         return $this->parameters;
 239     }
 240
 241     function setPathParameters($parameters)
 242     {
 243         $this->_path_parameters = $parameters;
 244     }
 245
 246     function getPathParameters()
 247     {
 248         return empty($this->_path_parameters) ? array() : $this->_path_parameters;
 249     }
 250
 251     function getUrlParams()
 252     {
 253         return $_GET;
 254     }
 255
 256     /**
 257     * Must be implemented in the concrete request
 258     */
 259     function getQueryParameters ()
 260     {
 261     }
 262     function getRequestParameters ()
 263     {
 264     }
 265
 266     /**
 267      * Returns the path minus the web server relative installation directory. This method returns null unless the web server is apache.
 268      */
 269     function getRelativeUrlRoot()
 270     {
 271         return str_replace('/index.php','', @$this->env['PHP_SELF']);
 272     }
 273
 274     /**
 275      * Returns the locale identifier of current URL
 276      */
 277     function getLocaleFromUrl()
 278     {
 279         $locale = Ak::get_url_locale();
 280         if(strstr(AK_CURRENT_URL,AK_SITE_URL.'/'.$locale)){
 281             return $locale;
 282         }
 283         return '';
 284     }
 285
 286     /**
 287     * Returns the HTTP request method as a lowercase symbol ('get, for example)
 288     */
 289     function getMethod()
 290     {
 291         return strtolower($this->env['REQUEST_METHOD']);
 292     }
 293
 294     /**
 295     * Is this a GET request?  Equivalent to $Request->getMethod() == 'get'
 296     */
 297     function isGet()
 298     {
 299         return $this->getMethod() == 'get';
 300     }
 301
 302     /**
 303     * Is this a POST request?  Equivalent to $Request->getMethod() == 'post'
 304     */
 305     function isPost()
 306     {
 307         return $this->getMethod() == 'post';
 308     }
 309
 310     /**
 311     * Is this a PUT request?  Equivalent to $Request->getMethod() == 'put'
 312     */
 313     function isPut()
 314     {
 315         return isset($this->env['REQUEST_METHOD']) ? $this->getMethod() == 'put' : false;
 316     }
 317
 318     /**
 319     * Is this a DELETE request?  Equivalent to $Request->getMethod() == 'delete'
 320     */
 321     function isDelete()
 322     {
 323         return $this->getMethod() == 'delete';
 324     }
 325
 326     /**
 327     * Is this a HEAD request?  Equivalent to $Request->getMethod() == 'head'
 328     */
 329     function isHead()
 330     {
 331         return $this->getMethod() == 'head';
 332     }
 333
 334
 335
 336     /**
 337     * Determine originating IP address.  REMOTE_ADDR is the standard
 338     * but will fail if( the user is behind a proxy.  HTTP_CLIENT_IP and/or
 339     * HTTP_X_FORWARDED_FOR are set by proxies so check for these before
 340     * falling back to REMOTE_ADDR.  HTTP_X_FORWARDED_FOR may be a comma-
 341     * delimited list in the case of multiple chained proxies; the first is
 342     * the originating IP.
 343     */
 344     function getRemoteIp()
 345     {
 346         if(!empty($this->env['HTTP_CLIENT_IP'])){
 347             return $this->env['HTTP_CLIENT_IP'];
 348         }
 349         if(!empty($this->env['HTTP_X_FORWARDED_FOR'])){
 350             foreach ((strstr($this->env['HTTP_X_FORWARDED_FOR'],',') ? split(',',$this->env['HTTP_X_FORWARDED_FOR']) : array($this->env['HTTP_X_FORWARDED_FOR'])) as $remote_ip){
 351                 if($remote_ip == 'unknown' ||
 352                 preg_match('/^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$/', $remote_ip) ||
 353                 preg_match('/^([0-9a-fA-F]{4}|0)(\:([0-9a-fA-F]{4}|0)){7}$/', $remote_ip)
 354                 ){
 355                     return $remote_ip;
 356                 }
 357             }
 358         }
 359         return empty($this->env['REMOTE_ADDR']) ? '' : $this->env['REMOTE_ADDR'];
 360
 361     }
 362
 363     /**
 364     * Returns the domain part of a host, such as akelos.com in 'www.akelos.com'. You can specify
 365     * a different <tt>tld_length</tt>, such as 2 to catch akelos.co.uk in 'www.akelos.co.uk'.
 366     */
 367     function getDomain($tld_length = 1)
 368     {
 369         return preg_match('/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/',$this->getHost()) ?
 370         null :
 371         join('.',array_slice(explode('.',$this->getHost()),(1 + $tld_length)*-1));
 372     }
 373
 374     /**
 375     * Returns all the subdomains as an array, so ['dev', 'www'] would be returned for 'dev.www.akelos.com'.
 376     * You can specify a different <tt>tld_length</tt>, such as 2 to catch ['www'] instead of ['www', 'akelos']
 377     * in 'www.akelos.co.uk'.
 378     */
 379     function getSubdomains($tld_length = 1)
 380     {
 381         return preg_match('/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/',$this->getHost()) ||
 382         !strstr($this->getHost(),'.') ? array() : (array)array_slice(explode('.',$this->getHost()),0,(1 + $tld_length)*-1);
 383     }
 384
 385
 386     /**
 387     * Returns the request URI correctly
 388     */
 389     function getRequestUri()
 390     {
 391         return $this->getProtocol().$this->getHostWithPort();
 392     }
 393
 394     /**
 395     * Return 'https://' if( this is an SSL request and 'http://' otherwise.
 396     */
 397     function getProtocol()
 398     {
 399         return $this->isSsl() ? 'https://' : 'http://';
 400     }
 401
 402     /**
 403     * Is this an SSL request?
 404     */
 405     function isSsl()
 406     {
 407         return isset($this->env['HTTPS']) && ($this->env['HTTPS'] === true || $this->env['HTTPS'] == 'on');
 408     }
 409
 410     /**
 411     * Returns the interpreted path to requested resource
 412     */
 413     function getPath()
 414     {
 415         return strstr($this->env['REQUEST_URI'],'?') ? substr($this->env['REQUEST_URI'],0,strpos($this->env['REQUEST_URI'],'?')) : $this->env['REQUEST_URI'];
 416     }
 417
 418     /**
 419     * Returns the port number of this request as an integer.
 420     */
 421     function getPort()
 422     {
 423         $this->port_as_int = AK_WEB_REQUEST ? AK_SERVER_PORT : 80;
 424         return $this->port_as_int;
 425     }
 426
 427     /**
 428     * Returns the standard port number for this request's protocol
 429     */
 430     function getStandardPort()
 431     {
 432         return $this->isSsl() ? 443 : 80;
 433     }
 434
 435     /**
 436     * Returns a port suffix like ':8080' if( the port number of this request
 437     * is not the default HTTP port 80 or HTTPS port 443.
 438     */
 439     function getPortString()
 440     {
 441         $port = $this->getPort();
 442         return $port == $this->getStandardPort() ? '' : ($port ? ':'.$this->getPort() : '');
 443     }
 444
 445     /**
 446     * Returns a host:port string for this request, such as example.com or
 447     * example.com:8080.
 448     */
 449     function getHostWithPort()
 450     {
 451         return $this->getHost() . $this->getPortString();
 452     }
 453
 454
 455     function getHost()
 456     {
 457         if(!empty($this->_host)){
 458             return $this->_host;
 459         }
 460         return AK_WEB_REQUEST ? $this->env['SERVER_NAME'] : 'localhost';
 461     }
 462
 463     function &getSession()
 464     {
 465         return $_SESSION;
 466     }
 467
 468     function resetSession()
 469     {
 470         $_SESSION = array();
 471     }
 472
 473     function &getCookies()
 474     {
 475         return $_COOKIE;
 476     }
 477
 478
 479     function &getEnv()
 480     {
 481         return $this->env;
 482     }
 483
 484
 485     function getServerSoftware()
 486     {
 487         if(!empty($this->env['SERVER_SOFTWARE'])){
 488             if(preg_match('/^([a-zA-Z]+)/', $this->env['SERVER_SOFTWARE'],$match)){
 489                 return strtolower($match[0]);
 490             }
 491         }
 492         return '';
 493     }
 494
 495
 496     /**
 497     * Returns true if the request's 'X-Requested-With' header contains
 498     * 'XMLHttpRequest'. (The Prototype Javascript library sends this header with
 499     * every Ajax request.)
 500     */
 501     function isXmlHttpRequest()
 502     {
 503         return !empty($this->env['HTTP_X_REQUESTED_WITH']) && strstr(strtolower($this->env['HTTP_X_REQUESTED_WITH']),'xmlhttprequest');
 504     }
 505     function xhr()
 506     {
 507         return $this->isXmlHttpRequest();
 508     }
 509
 510     function isAjax()
 511     {
 512         return $this->isXmlHttpRequest();
 513     }
 514
 515
 516     /**
 517      * Receive the raw post data.
 518      * This is useful for services such as REST, XMLRPC and SOAP
 519      * which communicate over HTTP POST but don't use the traditional parameter format.
 520      */
 521     function getRawPost()
 522     {
 523         return empty($_ENV['RAW_POST_DATA']) ? '' : $_ENV['RAW_POST_DATA'];
 524     }
 525
 526
 527     function _validateTechName($name)
 528     {
 529         return preg_match('/^[A-Za-z]{1,}[A-Za-z0-9_]*$/',$name);
 530     }
 531
 532
 533
 534     // {{{ _mergeRequest()
 535
 536     /**
 537     * Populates $this->_request attribute with incoming request in the following precedence:
 538     *
 539     * $_SESSION['request'] <- This will override options provided by previous methods
 540     * $_COOKIE
 541     * $_POST
 542     * $_GET
 543     * Command line params
 544     *
 545     * @access public
 546     * @return void Void returned. Modifies the private property "
 547     */
 548     function _mergeRequest()
 549     {
 550         $this->_request = array();
 551
 552         $session_params = isset($_SESSION['request']) ? $_SESSION['request'] : null;
 553         $command_line_params = !empty($_REQUEST)  ? $_REQUEST : null;
 554
 555         $requests = array($command_line_params, $_GET, array_merge_recursive($_POST, $this->getPutParams(), $this->_getNormalizedFilesArray()), $_COOKIE, $session_params);
 556
 557         foreach ($requests as $request){
 558             $this->_request = (!is_null($request) && is_array($request)) ?
 559             array_merge($this->_request,$request) : $this->_request;
 560         }
 561     }
 562
 563     // }}}
 564
 565     function _getNormalizedFilesArray($params = null, $first_call = true)
 566     {
 567         $params = $first_call ? $_FILES : $params;
 568         $result = array();
 569
 570         $params = array_diff($params,array(''));
 571         if(!empty($params) && is_array($params)){
 572             foreach ($params as $name=>$details){
 573
 574                 if(is_array($details) && !empty($details['name']) &&  !empty($details['tmp_name']) &&  !empty($details['size'])){
 575                     if(is_array($details['tmp_name'])){
 576                         foreach ($details['tmp_name'] as $item=>$item_details){
 577                             if(is_array($item_details)){
 578                                 foreach (array_keys($item_details) as $k){
 579                                     if(UPLOAD_ERR_NO_FILE != $details['error'][$item][$k]){
 580                                         $result[$name][$item][$k] = array(
 581                                         'name'=>$details['name'][$item][$k],
 582                                         'tmp_name'=>$details['tmp_name'][$item][$k],
 583                                         'size'=>$details['size'][$item][$k],
 584                                         'type'=>$details['type'][$item][$k],
 585                                         'error'=>$details['error'][$item][$k],
 586                                         );
 587                                     }
 588                                 }
 589                             }else{
 590                                 if(UPLOAD_ERR_NO_FILE != $details['error'][$item]){
 591                                     $result[$name][$item] = array(
 592                                     'name'=>$details['name'][$item],
 593                                     'tmp_name'=>$details['tmp_name'][$item],
 594                                     'size'=>$details['size'][$item],
 595                                     'type'=>$details['type'][$item],
 596                                     'error'=>$details['error'][$item],
 597                                     );
 598                                 }
 599                             }
 600                         }
 601                     }elseif ($first_call){
 602                         $result[$name] = $details;
 603                     }else{
 604                         $result[$name][] = $details;
 605                     }
 606                 }elseif(is_array($details)){
 607                     $_nested = $this->_getNormalizedFilesArray($details, false);
 608
 609                     if(!empty($_nested)){
 610                         $result = array_merge(array($name=>$_nested), $result);
 611                     }
 612                 }
 613             }
 614         }
 615
 616         return $result;
 617     }
 618
 619     // {{{ _addParams()
 620
 621     /**
 622     * Builds (i.e., "expands") the Request class for accessing
 623     * the request parameters as public properties.
 624     * For example, when the requests is "ak=/controller/action/id&parameter=value",
 625     * once parsed, you can access the parameters of the request just like
 626     * an object, e.g.:
 627     *
 628     *   $value_to_get = $request->parameter
 629     *
 630     * @access private
 631     * @return void
 632     */
 633     function _addParam($variable, $value)
 634     {
 635         if($variable[0] != '_'){
 636             if( ( $variable == 'action' && !$this->isValidActionName($value)) ||
 637             ( $variable == 'controller' && !$this->isValidControllerName($value)) ||
 638             ( $variable == 'module' && !$this->isValidModuleName($value))
 639             ){
 640                 return false;
 641             }
 642             $this->$variable = $value;
 643             return true;
 644         }
 645         return false;
 646     }
 647
 648     // }}}
 649
 650
 651     /**
 652     * Correct double-escaping problems caused by "magic quotes" in some PHP
 653     * installations.
 654     */
 655     function _fixGpcMagic()
 656     {
 657         if(!defined('AK_GPC_MAGIC_FIXED')){
 658             if (get_magic_quotes_gpc()) {
 659                 array_walk($_GET, array('AkRequest', '_fixGpc'));
 660                 array_walk($_POST, array('AkRequest', '_fixGpc'));
 661                 array_walk($_COOKIE, array('AkRequest', '_fixGpc'));
 662             }
 663             define('AK_GPC_MAGIC_FIXED',true);
 664         }
 665     }
 666
 667     function _fixGpc(&$item)
 668     {
 669         if (is_array($item)) {
 670             array_walk($item, array('AkRequest', '_fixGpc'));
 671         }else {
 672             $item = stripslashes($item);
 673         }
 674     }
 675
 676
 677     function _urlDecode()
 678     {
 679         if(!defined('AK_URL_DECODED')){
 680             array_walk($_GET, array('AkRequest', '_performUrlDecode'));
 681             define('AK_URL_DECODED',true);
 682         }
 683     }
 684
 685     function _performUrlDecode(&$item)
 686     {
 687         if (is_array($item)) {
 688             array_walk($item, array('AkRequest', '_performUrlDecode'));
 689         }else {
 690             $item = urldecode($item);
 691         }
 692     }
 693
 694
 695     // {{{ recognize()
 696
 697     /**
 698     * Recognizes a Request and returns the responsible controller instance
 699     *
 700     * @return AkActionController
 701     */
 702     function &recognize($Map = null)
 703     {
 704         AK_ENVIRONMENT != 'setup' ? $this->_connectToDatabase() : null;
 705         $this->_startSession();
 706         $this->_enableInternationalizationSupport();
 707         $this->_mapRoutes($Map);
 708
 709         $params = $this->getParams();
 710
 711         $module_path = $module_class_peffix = '';
 712         if(!empty($params['module'])){
 713             $module_path = trim(str_replace(array('/','\\'), DS, Ak::sanitize_include($params['module'], 'high')), DS).DS;
 714             $module_shared_model = AK_CONTROLLERS_DIR.DS.trim($module_path,DS).'_controller.php';
 715             $module_class_peffix = str_replace(' ','_',AkInflector::titleize(str_replace(DS,' ', trim($module_path, DS)))).'_';
 716         }
 717
 718         $controller_file_name = AkInflector::underscore($params['controller']).'_controller.php';
 719         $controller_class_name = $module_class_peffix.AkInflector::camelize($params['controller']).'Controller';
 720         $controller_path = AK_CONTROLLERS_DIR.DS.$module_path.$controller_file_name;
 721         include_once(AK_APP_DIR.DS.'application_controller.php');
 722
 723         if(!empty($module_path) && file_exists($module_shared_model)){
 724             include_once($module_shared_model);
 725         }
 726
 727         if(!is_file($controller_path) || !include_once($controller_path)){
 728             defined('AK_LOG_EVENTS') && AK_LOG_EVENTS && $this->Logger->error('Controller '.$controller_path.' not found.');
 729             if(AK_ENVIRONMENT == 'development'){
 730                 trigger_error(Ak::t('Could not find the file /app/controllers/<i>%controller_file_name</i> for '.
 731                 'the controller %controller_class_name',
 732                 array('%controller_file_name'=> $controller_file_name,
 733                 '%controller_class_name' => $controller_class_name)), E_USER_ERROR);
 734             }elseif(@include(AK_PUBLIC_DIR.DS.'404.php')){
 735                 exit;
 736             }else{
 737                 header("HTTP/1.1 404 Not Found");
 738                 die('404 Not found');
 739             }
 740         }
 741         if(!class_exists($controller_class_name)){
 742             defined('AK_LOG_EVENTS') && AK_LOG_EVENTS && $this->Logger->error('Controller '.$controller_path.' does not implement '.$controller_class_name.' class.');
 743             if(AK_ENVIRONMENT == 'development'){
 744                 trigger_error(Ak::t('Controller <i>%controller_name</i> does not exist',
 745                 array('%controller_name' => $controller_class_name)), E_USER_ERROR);
 746             }elseif(@include(AK_PUBLIC_DIR.DS.'405.php')){
 747                 exit;
 748             }else{
 749                 header("HTTP/1.1 405 Method Not Allowed");
 750                 die('405 Method Not Allowed');
 751             }
 752         }
 753         $Controller =& new $controller_class_name(array('controller'=>true));
 754         $Controller->_module_path = $module_path;
 755         isset($_SESSION) ? $Controller->session =& $_SESSION : null;
 756         return $Controller;
 757
 758     }
 759
 760     // }}}
 761
 762     function _enableInternationalizationSupport()
 763     {
 764         if(AK_AVAILABLE_LOCALES != 'en'){
 765             require_once(AK_LIB_DIR.DS.'AkLocaleManager.php');
 766
 767             $LocaleManager = new AkLocaleManager();
 768             $LocaleManager->init();
 769             $LocaleManager->initApplicationInternationalization($this);
 770             $this->__internationalization_support_enabled = true;
 771         }
 772     }
 773
 774     function _mapRoutes($Map = null)
 775     {
 776         require_once(AK_LIB_DIR.DS.'AkRouter.php');
 777         if(is_file(AK_ROUTES_MAPPING_FILE)){
 778             if(empty($Map)){
 779                 $Map =& AkRouter();
 780             }
 781             include(AK_ROUTES_MAPPING_FILE);
 782             // Set this routes for being used via Ak::toUrl
 783             Ak::toUrl($Map,true);
 784             $this->checkForRoutedRequests($Map);
 785         }
 786     }
 787
 788
 789     function _connectToDatabase()
 790     {
 791         if(AK_AUTOMATIC_DB_CONNECTION){
 792             Ak::db(AK_DEFAULT_DATABASE_PROFILE);
 793         }
 794     }
 795
 796     function _startSession()
 797     {
 798         if(AK_AUTOMATIC_SESSION_START){
 799             if(!isset($_SESSION)){
 800                 if(AK_SESSION_HANDLER == 1 && defined('AK_DATABASE_CONNECTION_AVAILABLE') && AK_DATABASE_CONNECTION_AVAILABLE){
 801                     require_once(AK_LIB_DIR.DS.'AkDbSession.php');
 802
 803                     $AkDbSession = new AkDbSession();
 804                     $AkDbSession->session_life = AK_SESSION_EXPIRE;
 805                     session_set_save_handler (
 806                     array(&$AkDbSession, '_open'),
 807                     array(&$AkDbSession, '_close'),
 808                     array(&$AkDbSession, '_read'),
 809                     array(&$AkDbSession, '_write'),
 810                     array(&$AkDbSession, '_destroy'),
 811                     array(&$AkDbSession, '_gc')
 812                     );
 813                 }
 814                 @session_start();
 815             }
 816         }
 817     }
 818
 819     function getPutParams()
 820     {
 821         if(!isset($this->put) && $this->isPut() && $data = $this->getPutRequestData()){
 822             $this->put = array();
 823             parse_str(urldecode($data), $this->put);
 824         }
 825         return isset($this->put) ? $this->put : array();
 826     }
 827
 828     function getPutRequestData()
 829     {
 830         if(!empty($_SERVER['CONTENT_LENGTH'])){
 831             $putdata = fopen('php://input', 'r');
 832             $result = fread($putdata, $_SERVER['CONTENT_LENGTH']);
 833             fclose($putdata);
 834             return $result;
 835         }else{
 836             return false;
 837         }
 838     }
 839 }
 840
 841 function &AkRequest()
 842 {
 843     $null = null;
 844     $AkRequest =& Ak::singleton('AkRequest', $null);
 845     return $AkRequest;
 846 }
 847
 848 ?>