Source for file class.modrewritecontroller.php

Documentation is available at class.modrewritecontroller.php

  1. <?php
  2. /**
  3.  * Includes Mod Rewrite controller class.
  4.  *
  5.  * @author      Murat Purc <murat@purc.de>
  6.  * @copyright   © Murat Purc 2008
  7.  * @package     Contenido
  8.  * @subpackage  ModRewrite
  9.  */
  10.  
  11.  
  12. defined('CON_FRAMEWORK') or die('Illegal call');
  13.  
  14.  
  15. /**
  16.  * Mod Rewrite controller class. Extracts url parts and sets some necessary globals like:
  17.  * - $idart
  18.  * - $idcat
  19.  * - $client
  20.  * - $changeclient
  21.  * - $lang
  22.  * - $changelang
  23.  *
  24.  * @author      Murat Purc <murat@purc.de>
  25.  * @date        16.04.2008
  26.  * @package     Contenido
  27.  * @subpackage  ModRewrite
  28.  */
  29. class ModRewriteController extends ModRewriteBase {
  30.  
  31.     /**
  32.      * Extracted request uri path parts by path separator '/'
  33.      *
  34.      * @var array 
  35.      */
  36.     private $_aParts;
  37.  
  38.     /**
  39.      * Extracted article name from request uri
  40.      *
  41.      * @var string 
  42.      */
  43.     private $_sArtName;
  44.  
  45.     /**
  46.      * Remaining path for path resolver (see $GLOBALS['path'])
  47.      *
  48.      * @var string 
  49.      */
  50.     private $_sPath;
  51.  
  52.     /**
  53.      * Incomming URL
  54.      *
  55.      * @var string 
  56.      */
  57.     private $_sIncommingUrl;
  58.  
  59.     /**
  60.      * Resolved URL
  61.      *
  62.      * @var string 
  63.      */
  64.     private $_sResolvedUrl;
  65.  
  66.     /**
  67.      * Client id used by this class
  68.      *
  69.      * @var int 
  70.      */
  71.     private $_iClientMR;
  72.  
  73.     /**
  74.      * Flag about occured errors
  75.      *
  76.      * @var bool 
  77.      */
  78.     private $_bError = false;
  79.  
  80.     /**
  81.      * Flag about found routing definition
  82.      *
  83.      * @var bool 
  84.      */
  85.     private $_bRoutingFound = false;
  86.  
  87.  
  88.     /**
  89.      * Constructor, sets several properties.
  90.      *
  91.      * @param  string  $incommingUrl  Incomming URL
  92.      */
  93.     public function __construct($incommingUrl) {
  94.         parent::initialize();
  95.         $this->_sIncommingUrl = $incommingUrl;
  96.         $this->_aParts        = array();
  97.     }
  98.  
  99.  
  100.     /**
  101.      * Getter for overwritten client id (see $GLOBALS['client'])
  102.      *
  103.      * @return  int  Client id
  104.      */
  105.     public function getClient() {
  106.         return parent::$_oGlobals->get('client');
  107.     }
  108.  
  109.  
  110.     /**
  111.      * Getter for overwritten change client id (see $GLOBALS['changeclient'])
  112.      *
  113.      * @return  int  Change client id
  114.      */
  115.     public function getChangeClient() {
  116.         return parent::$_oGlobals->get('changeclient');
  117.     }
  118.  
  119.  
  120.     /**
  121.      * Getter for article id (see $GLOBALS['idart'])
  122.      *
  123.      * @return  int  Article id
  124.      */
  125.     public function getIdArt() {
  126.         return parent::$_oGlobals->get('idart');
  127.     }
  128.  
  129.  
  130.     /**
  131.      * Getter for category id (see $GLOBALS['idcat'])
  132.      *
  133.      * @return  int  Category id
  134.      */
  135.     public function getIdCat() {
  136.         return parent::$_oGlobals->get('idcat');
  137.     }
  138.  
  139.  
  140.     /**
  141.      * Getter for language id (see $GLOBALS['lang'])
  142.      *
  143.      * @return  int  Language id
  144.      */
  145.     public function getLang() {
  146.         return parent::$_oGlobals->get('lang');
  147.     }
  148.  
  149.  
  150.     /**
  151.      * Getter for change language id (see $GLOBALS['change_lang'])
  152.      *
  153.      * @return  int  Change language id
  154.      */
  155.     public function getChangeLang() {
  156.         return parent::$_oGlobals->get('changelang');
  157.     }
  158.  
  159.  
  160.     /**
  161.      * Getter for path (see $GLOBALS['path'])
  162.      *
  163.      * @return  string  Path, used by path resolver
  164.      */
  165.     public function getPath() {
  166.         return $this->_sPath;
  167.     }
  168.  
  169.  
  170.     /**
  171.      * Getter for resolved url
  172.      *
  173.      * @return  string  Resolved url
  174.      */
  175.     public function getResolvedUrl() {
  176.         return $this->_sResolvedUrl;
  177.     }
  178.  
  179.  
  180.     /**
  181.      * Returns a flag about found routing definition
  182.      *
  183.      * return  bool  Flag about found routing
  184.      */
  185.     public function getRoutingFoundState() {
  186.         return $this->_bRoutingFound;
  187.     }
  188.  
  189.  
  190.     /**
  191.      * Getter for occured error state
  192.      *
  193.      * @return  bool  Flag for occured error
  194.      */
  195.     public function errorOccured(){
  196.         return $this->_bError;
  197.     }
  198.  
  199.  
  200.     /**
  201.      * Main function to call for mod rewrite related preprocessing jobs.
  202.      *
  203.      * Executes some private functions to extract request URI and to set needed membervariables
  204.      * (client, language, article id, category id, etc.)
  205.      */
  206.     public function execute() {
  207.         if (parent::isEnabled() == false) {
  208.             return;
  209.         }
  210.  
  211.         $this->_extractRequestUri();
  212.  
  213.         $this->_initializeClientId();
  214.  
  215.         $this->_setClientId();
  216.  
  217.         mr_loadConfiguration($this->_iClientMR);
  218.  
  219.         $this->_setLanguageId();
  220.  
  221.         // second call after setting client and language
  222.         $this->_extractRequestUri(true);
  223.  
  224.         $this->_setPathresolverSetting();
  225.  
  226.         $this->_setIdart();
  227.  
  228.         parent::$_oDebug->addDebug($this->_aParts, 'ModRewriteController::execute() _setIdart');
  229.  
  230.         $this->_postValidation();
  231.     }
  232.  
  233.  
  234.     /**
  235.      * Extracts request URI and sets member variables $this->_sArtName and $this->_aParts
  236.      *
  237.      * @param  bool $secondCall  Flag about second call of this function, is needed
  238.      *                            to re extract url if a routing definition was found
  239.      */
  240.     private function _extractRequestUri($secondCall=false) {
  241.         // check for defined rootdir
  242.         if (parent::getConfig('rootdir') !== '/' && strpos($_SERVER['REQUEST_URI'], $this->_sIncommingUrl) === 0) {
  243.             $this->_sIncommingUrl = str_replace(parent::getConfig('rootdir'), '/', $this->_sIncommingUrl);
  244.         }
  245.  
  246.         $aUrlComponents = $this->_parseUrl($this->_sIncommingUrl);
  247.         if (isset($aUrlComponents['path'])) {
  248. ##++##
  249.             if (parent::getConfig('rootdir') !== '/' && strpos($aUrlComponents['path'], parent::getConfig('rootdir')) === 0) {
  250.                 $aUrlComponents['path'] = str_replace(parent::getConfig('rootdir'), '/', $aUrlComponents['path']);
  251.             }
  252. ##++##
  253.  
  254.             if ($secondCall == true) {
  255.  
  256. #        parent::$_oDebug->addDebug($aUrlComponents, 'ModRewriteController::_extractRequestUri() 2. call $aUrlComponents');
  257.                 // @todo: implement real redirect of old front_content.php style urls
  258.  
  259.                 // check for routing definition
  260.                 $routings = parent::getConfig('routing');
  261.                 if (is_array($routings) && isset($routings[$aUrlComponents['path']])) {
  262.                     $aUrlComponents['path'] = $routings[$aUrlComponents['path']];
  263.                     if (strpos($aUrlComponents['path'], 'front_content.php') !== false) {
  264.                         // routing destination contains front_content.php
  265.  
  266.                         $this->_bRoutingFound = true;
  267.  
  268.                         // set client language, if not set before
  269.                         mr_setClientLanguageId(parent::$_oGlobals->get('client'));
  270.  
  271.                         //rebuild URL
  272.                         $url = mr_buildNewUrl($aUrlComponents['path']);
  273.  
  274.                         $aUrlComponents = $this->_parseUrl($url);
  275.  
  276.                         $this->_aParts = array();
  277.                     }
  278.                 } else {
  279.                     return;
  280.                 }
  281.             }
  282.  
  283.             $aPaths = explode('/', $aUrlComponents['path']);
  284.             foreach ($aPaths as $p => $item) {
  285.                 if (!empty($item)) {
  286.                     // pathinfo would also work
  287.                     $arr   = explode('.', $item);
  288.                     $count = count($arr);
  289.                     if ($count > 0 && '.' . strtolower($arr[$count-1]) == parent::getConfig('file_extension')) {
  290.                         array_pop($arr);
  291.                         $this->_sArtName = implode('.', $arr);
  292.                     } else {
  293.                         $this->_aParts[] = $item;
  294.                     }
  295.                 }
  296.             }
  297.  
  298.             if ($secondCall == true) {
  299.                 // reprocess extracting client and language
  300.                 $this->_setClientId();
  301.                 mr_loadConfiguration($this->_iClientMR);
  302.                 $this->_setLanguageId();
  303.             }
  304.  
  305.         }
  306.         parent::$_oDebug->addDebug($this->_aParts, 'ModRewriteController::_extractRequestUri() $this->_aParts');
  307.  
  308.         // loop parts array and remove existing 'front_content.php'
  309.         if ($this->_hasPartArrayItems()) {
  310.             foreach($this->_aParts as $p => $item) {
  311.                 if ($item == 'front_content.php') {
  312.                     unset($this->_aParts[$p]);
  313.                 }
  314.             }
  315.         }
  316.  
  317.         // set parts property top null, if needed
  318.         if ($this->_hasPartArrayItems() == false) {
  319.             $this->_aParts = null;
  320.         }
  321.  
  322.         // set artname to null if needed
  323.         if (!isset($this->_sArtName) || empty($this->_sArtName) || strlen($this->_sArtName) == 0) {
  324.             $this->_sArtName = null;
  325.         }
  326.  
  327.     }
  328.  
  329.  
  330.     /**
  331.      * Tries to initialize the client id
  332.      */
  333.     private function _initializeClientId() {
  334.         $client       = parent::$_oGlobals->get('client', 0);
  335.         $changeclient = parent::$_oGlobals->get('changeclient', 0);
  336.  
  337.         $this->_iClientMR = 0;
  338.         if ($client > 0 && $changeclient == 0) {
  339.             $this->_iClientMR = $client;
  340.         } elseif ($changeclient > 0) {
  341.             $this->_iClientMR = $changeclient;
  342.         } else {
  343.             $this->_iClientMR = parent::$_oGlobals->get('load_client');
  344.         }
  345.  
  346.         if ((int) $this->_iClientMR > 0) {
  347.             // set global client variable
  348.             parent::$_oGlobals->set('client', (int) $this->_iClientMR);
  349.         }
  350.     }
  351.  
  352.  
  353.     /**
  354.      * Sets client id
  355.      */
  356.     private function _setClientId() {
  357.         if ($this->_hasPartArrayItems() == false || parent::getConfig('use_client') !== 1) {
  358.             return;
  359.         }
  360.  
  361.         $client       = parent::$_oGlobals->get('client', 0);
  362.         $changeclient = parent::$_oGlobals->get('changeclient', 0);
  363.  
  364.         if (parent::getConfig('use_client_name') == 1) {
  365.             $changeclient     = ModRewrite::getClientId(array_shift($this->_aParts));
  366.             $this->_iClientMR = $changeclient;
  367.         } else {
  368.             $changeclient     = (int) array_shift($this->_aParts);
  369.             $this->_iClientMR = $changeclient;
  370.         }
  371.  
  372.         if (empty($changeclient) || (int) $changeclient == 0) {
  373.             $changeclient = parent::$_oGlobals->get('load_client');
  374.         }
  375.         if ($client > 0 && $changeclient !== $client) {
  376.             // overwrite existing client variable
  377.             $this->_iClientMR = $changeclient;
  378.             parent::$_oGlobals->set('client', $changeclient);
  379.         }
  380.  
  381.         parent::$_oGlobals->set('changeclient', $changeclient);
  382.     }
  383.  
  384.  
  385.     /**
  386.      * Sets language id
  387.      */
  388.     private function _setLanguageId() {
  389.         if ($this->_hasPartArrayItems() == false || parent::getConfig('use_language') !== 1) {
  390.             return;
  391.         }
  392.  
  393.         if (parent::getConfig('use_language_name') == 1) {
  394.             // thanks to Nicolas Dickinson for multi Client/Language BugFix
  395.             $changelang = ModRewrite::getLanguageId(array_shift($this->_aParts) , $this->_iClientMR);
  396.         } else {
  397.             $changelang = (int) array_shift($this->_aParts);
  398.         }
  399.  
  400.         if ((int) $changelang > 0) {
  401.             parent::$_oGlobals->set('lang', $changelang);
  402.             parent::$_oGlobals->set('changelang', $changelang);
  403.         }
  404.     }
  405.  
  406.  
  407.     /**
  408.      * Sets path resolver and category id
  409.      */
  410.     private function _setPathresolverSetting() {
  411.         if ($this->_hasPartArrayItems() == false) {
  412.             return;
  413.         }
  414.  
  415.         $this->_sPath = '/' . implode('/', $this->_aParts) . '/';
  416.  
  417.         $lang = parent::$_oGlobals->get('lang');
  418.  
  419.         if ($lang == null) {
  420.             if (parent::$_oGlobals->get('load_lang', 0) > 0) {
  421.                 // load_client is set in frontend/config.php
  422.  
  423.                 $lang = parent::$_oGlobals->get('load_lang');
  424.             } else {
  425.                 // get client id from table
  426.                 cInclude('classes', 'contenido/class.clientslang.php');
  427.                 $clCol = new cApiClientLanguageCollection();
  428.                 $clCol->setWhere('idclient', parent::$_oGlobals->get('client'));
  429.                 $clCol->query();
  430.                 if ($clItem = $clCol->next()) {
  431.                     $lang = $clItem->get('idlang');
  432.                 }
  433.             }
  434.             parent::$_oGlobals->set('lang', $lang);
  435.         }
  436.  
  437.         $idcat = (int) ModRewrite::getCatIdByUrlPath($this->_sPath);
  438.  
  439.         if ($idcat == 0) {
  440.             // category couldn't resolved
  441.             $this->_bError = true;
  442.             $idcat = null;
  443.         } else {
  444.             // unset $this->_sPath if $idcat could set, otherwhise it would be resolved again.
  445.             unset($this->_sPath);
  446.         }
  447.  
  448.         parent::$_oGlobals->set('idcat', $idcat);
  449.  
  450.         parent::$_oDebug->addDebug($idcat, 'ModRewriteController->_setPathresolverSetting $idcat');
  451.         parent::$_oDebug->addDebug($this->_sPath, 'ModRewriteController->_setPathresolverSetting $this->_sPath');
  452.     }
  453.  
  454.  
  455.     /**
  456.      * Sets article id
  457.      */
  458.     private function _setIdart() {
  459.         // startarticle name in url
  460.         if (parent::getConfig('add_startart_name_to_url') && isset($this->_sArtName)) {
  461.             if ($this->_sArtName == parent::getConfig('default_startart_name')) {
  462.                 // stored articlename is the default one, remove it ModRewrite::getArtIdByWebsafeName()
  463.                 // will find the real article name
  464.                 $this->_sArtName = null;
  465.             }
  466.         }
  467.  
  468.         $idcat = parent::$_oGlobals->get('idcat');
  469.         $idart = parent::$_oGlobals->get('idart');
  470.  
  471.         if ($idcat !== null && $this->_sArtName && $idart == null) {
  472.             // existing idcat with article name and no idart
  473.             $idart = ModRewrite::getArtIdByWebsafeName($this->_sArtName, $idcat);
  474.         } elseif ($idcat > 0 && $this->_sArtName == null && $idart == null) {
  475.  
  476.             if (parent::getConfig('add_startart_name_to_url') && parent::getConfig('default_startart_name') == '') {
  477.  
  478.                 // existing idcat without article name and idart
  479.                 cInclude('classes', 'class.article.php');
  480.                 $artColl = new ArticleCollection(array('idcat' => $idcat, 'start' => 1));
  481.                 if ($artItem = $artColl->startArticle()) {
  482.                     $idart = $artItem->get('idart');
  483.                 }
  484.  
  485.             }
  486.  
  487.         } elseif ($idcat == null && $idart == null && isset($this->_sArtName)) {
  488.             // no idcat and idart but article name
  489.             $idart = ModRewrite::getArtIdByWebsafeName($this->_sArtName);
  490.         }
  491.  
  492.         if ($idart !== null && (!$idart || (int) $idart == 0)) {
  493.             if (parent::getConfig('redirect_invalid_article_to_errorsite') == 1) {
  494.                 $this->_bError = true;
  495.                 $idart = null;
  496.             }
  497.         }
  498.  
  499.         parent::$_oGlobals->set('idart', $idart);
  500.  
  501.         parent::$_oDebug->addDebug($idart, 'ModRewriteController->_setIdart $idart');
  502.     }
  503.  
  504.  
  505.     /**
  506.      * Does post validation of the extracted data.
  507.      *
  508.      * One main goal of this function is to prevent duplicated content, which could happen, if
  509.      * the configuration 'startfromroot' is activated.
  510.      */
  511.     private function _postValidation() {
  512.         if ($this->_bError || $this->_bRoutingFound || !$this->_hasPartArrayItems()) {
  513.             return;
  514.         }
  515.  
  516.         if (parent::getConfig('startfromroot') == 1 && parent::getConfig('prevent_duplicated_content') == 1) {
  517.  
  518.             // prevention of duplicated content if '/firstcat/' is directly requested!
  519.  
  520.             $idcat = parent::$_oGlobals->get('idcat');
  521.             $idart = parent::$_oGlobals->get('idart');
  522.  
  523.             // compose new parameter
  524.             $param = '';
  525.             if ($idcat) {
  526.                 $param .= 'idcat=' . (int) $idcat;
  527.             }
  528.             if ($idart) {
  529.                 $param .= ($param !== '') ? '&idart=' . (int) $idart : 'idart=' . (int) $idart;
  530.             }
  531.  
  532.             if ($param == '') {
  533.                 return;
  534.             }
  535.  
  536.             // set client language, if not set before
  537.             mr_setClientLanguageId(parent::$_oGlobals->get('client'));
  538.  
  539.             //rebuild url
  540.             $url = mr_buildNewUrl('front_content.php?' . $param);
  541.  
  542.             $aUrlComponents = @parse_url($this->_sIncommingUrl);
  543.             $incommingUrl   = (isset($aUrlComponents['path'])) ? $aUrlComponents['path'] : '';
  544.  
  545.             parent::$_oDebug->addDebug($url, 'ModRewriteController->_postValidation validate url');
  546.             parent::$_oDebug->addDebug($incommingUrl, 'ModRewriteController->_postValidation incommingUrl');
  547.  
  548.             // now the new generated uri should be identical with the request uri
  549.             if ($incommingUrl !== $url) {
  550.                 $this->_bError = true;
  551.                 parent::$_oGlobals->set('idcat', null);
  552.             }
  553.         }
  554.     }
  555.  
  556.  
  557.     /**
  558.      * Parses the url using defined separators
  559.      *
  560.      * @param   string  $url  Incoming url
  561.      * @return  string  Parsed url
  562.      */
  563.     private function _parseUrl($url) {
  564.         $this->_sResolvedUrl = $url;
  565.  
  566.         $oMrUrlUtil = ModRewriteUrlUtil::getInstance();
  567.         $url = $oMrUrlUtil->toContenidoUrl($url);
  568.  
  569.         return @parse_url($url);
  570.     }
  571.  
  572.  
  573.     /**
  574.      * Returns state of parts property.
  575.      *
  576.      * @return  bool  True if $this->_aParts propery is an array and contains items
  577.      * @access  private
  578.      */
  579.     function _hasPartArrayItems() {
  580.         if (is_array($this->_aParts) && count($this->_aParts) > 0) {
  581.             return true;
  582.         } else {
  583.             return false;
  584.         }
  585.     }
  586.  
  587. }

Documentation generated on Sun, 08 Feb 2009 22:00:35 +0100 by phpDocumentor 1.4.1