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 secont 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.  
  248.         if (isset($aUrlComponents['path'])) {
  249.  
  250.             if ($secondCall == true) {
  251.  
  252. #        parent::$_oDebug->addDebug($aUrlComponents, 'ModRewriteController::_extractRequestUri() 2. call $aUrlComponents');
  253.                 // @todo: implement real redirect of old front_content.php style urls
  254.  
  255.                 // check for routing definition
  256.                 $routings = parent::getConfig('routing');
  257.                 if (is_array($routings) && isset($routings[$aUrlComponents['path']])) {
  258.                     $aUrlComponents['path'] = $routings[$aUrlComponents['path']];
  259.                     if (strpos($aUrlComponents['path'], 'front_content.php') !== false) {
  260.                         // routing destination contains front_content.php
  261.  
  262.                         $this->_bRoutingFound = true;
  263.  
  264.                         // set client language, if not set before
  265.                         mr_setClientLanguageId(parent::$_oGlobals->get('client'));
  266.  
  267.                         //rebuild URL
  268.                         $url = mr_buildNewUrl($aUrlComponents['path']);
  269.  
  270.                         $aUrlComponents = $this->_parseUrl($url);
  271.  
  272.                         $this->_aParts = array();
  273.                     }
  274.                 } else {
  275.                     return;
  276.                 }
  277.             }
  278.  
  279.             $aPaths = explode('/', $aUrlComponents['path']);
  280.             foreach ($aPaths as $p => $item) {
  281.                 if (!empty($item)) {
  282.                     // pathinfo would also work
  283.                     $arr   = explode('.', $item);
  284.                     $count = count($arr);
  285.                     if ($count > 0 && '.' . strtolower($arr[$count-1]) == parent::getConfig('file_extension')) {
  286.                         array_pop($arr);
  287.                         $this->_sArtName = implode('.', $arr);
  288.                     } else {
  289.                         $this->_aParts[] = $item;
  290.                     }
  291.                 }
  292.             }
  293.  
  294.             if ($secondCall == true) {
  295.                 // reprocess extracting client and language
  296.                 $this->_setClientId();
  297.                 mr_loadConfiguration($this->_iClientMR);
  298.                 $this->_setLanguageId();
  299.             }
  300.  
  301.         }
  302.         parent::$_oDebug->addDebug($this->_aParts, 'ModRewriteController::_extractRequestUri() $this->_aParts');
  303.  
  304.         // loop parts array and remove existing 'front_content.php'
  305.         if ($this->_hasPartArrayItems()) {
  306.             foreach($this->_aParts as $p => $item) {
  307.                 if ($item == 'front_content.php') {
  308.                     unset($this->_aParts[$p]);
  309.                 }
  310.             }
  311.         }
  312.  
  313.         // set parts property top null, if needed
  314.         if ($this->_hasPartArrayItems() == false) {
  315.             $this->_aParts = null;
  316.         }
  317.  
  318.         // set artname to null if needed
  319.         if (!isset($this->_sArtName) || empty($this->_sArtName) || strlen($this->_sArtName) == 0) {
  320.             $this->_sArtName = null;
  321.         }
  322.  
  323.     }
  324.  
  325.  
  326.     /**
  327.      * Tries to initialize the client id
  328.      */
  329.     private function _initializeClientId() {
  330.         $client       = parent::$_oGlobals->get('client', 0);
  331.         $changeclient = parent::$_oGlobals->get('changeclient', 0);
  332.  
  333.         $this->_iClientMR = 0;
  334.         if ($client > 0 && $changeclient == 0) {
  335.             $this->_iClientMR = $client;
  336.         } elseif ($changeclient > 0) {
  337.             $this->_iClientMR = $changeclient;
  338.         } else {
  339.             $this->_iClientMR = parent::$_oGlobals->get('load_client');
  340.         }
  341.  
  342.         if ((int) $this->_iClientMR > 0) {
  343.             // set global client variable
  344.             parent::$_oGlobals->set('client', (int) $this->_iClientMR);
  345.         }
  346.     }
  347.  
  348.  
  349.     /**
  350.      * Sets client id
  351.      */
  352.     private function _setClientId() {
  353.         if ($this->_hasPartArrayItems() == false || parent::getConfig('use_client') !== 1) {
  354.             return;
  355.         }
  356.  
  357.         $client       = parent::$_oGlobals->get('client', 0);
  358.         $changeclient = parent::$_oGlobals->get('changeclient', 0);
  359.  
  360.         if (parent::getConfig('use_client_name') == 1) {
  361.             $changeclient     = ModRewrite::getClientId(array_shift($this->_aParts));
  362.             $this->_iClientMR = $changeclient;
  363.         } else {
  364.             $changeclient     = (int) array_shift($this->_aParts);
  365.             $this->_iClientMR = $changeclient;
  366.         }
  367.  
  368.         if (empty($changeclient) || (int) $changeclient == 0) {
  369.             $changeclient = parent::$_oGlobals->get('load_client');
  370.         }
  371.         if ($client > 0 && $changeclient !== $client) {
  372.             // overwrite existing client variable
  373.             $this->_iClientMR = $changeclient;
  374.             parent::$_oGlobals->set('client', $changeclient);
  375.         }
  376.  
  377.         parent::$_oGlobals->set('changeclient', $changeclient);
  378.     }
  379.  
  380.  
  381.     /**
  382.      * Sets language id
  383.      */
  384.     private function _setLanguageId() {
  385.         if ($this->_hasPartArrayItems() == false || parent::getConfig('use_language') !== 1) {
  386.             return;
  387.         }
  388.  
  389.         if (parent::getConfig('use_language_name') == 1) {
  390.             // thanks to Nicolas Dickinson for multi Client/Language BugFix
  391.             $changelang = ModRewrite::getLanguageId(array_shift($this->_aParts) , $this->_iClientMR);
  392.         } else {
  393.             $changelang = (int) array_shift($this->_aParts);
  394.         }
  395.  
  396.         if ((int) $changelang > 0) {
  397.             parent::$_oGlobals->set('lang', $changelang);
  398.             parent::$_oGlobals->set('changelang', $changelang);
  399.         }
  400.     }
  401.  
  402.  
  403.     /**
  404.      * Sets path resolver and category id
  405.      */
  406.     private function _setPathresolverSetting() {
  407.         if ($this->_hasPartArrayItems() == false) {
  408.             return;
  409.         }
  410.  
  411.         $this->_sPath = '/' . implode('/', $this->_aParts) . '/';
  412.  
  413.         $lang = parent::$_oGlobals->get('lang');
  414.  
  415.         if ($lang == null) {
  416.             if (parent::$_oGlobals->get('load_lang', 0) > 0) {
  417.                 // load_client is set in frontend/config.php
  418.  
  419.                 $lang = parent::$_oGlobals->get('load_lang');
  420.             } else {
  421.                 // get client id from table
  422.                 cInclude('classes', 'contenido/class.clientslang.php');
  423.                 $clCol = new cApiClientLanguageCollection();
  424.                 $clCol->setWhere('idclient', parent::$_oGlobals->get('client'));
  425.                 $clCol->query();
  426.                 if ($clItem = $clCol->next()) {
  427.                     $lang = $clItem->get('idlang');
  428.                 }
  429.             }
  430.             parent::$_oGlobals->set('lang', $lang);
  431.         }
  432.  
  433.         $idcat = (int) ModRewrite::getCatIdByUrlPath($this->_sPath);
  434.  
  435.         if ($idcat == 0) {
  436.             // category couldn't resolved
  437.             $this->_bError = true;
  438.             $idcat = null;
  439.         } else {
  440.             // unset $this->_sPath if $idcat could set, otherwhise it would be resolved again.
  441.             unset($this->_sPath);
  442.         }
  443.  
  444.         parent::$_oGlobals->set('idcat', $idcat);
  445.  
  446.         parent::$_oDebug->addDebug($idcat, 'ModRewriteController->_setPathresolverSetting $idcat');
  447.         parent::$_oDebug->addDebug($this->_sPath, 'ModRewriteController->_setPathresolverSetting $this->_sPath');
  448.     }
  449.  
  450.  
  451.     /**
  452.      * Sets article id
  453.      */
  454.     private function _setIdart() {
  455.         // startarticle name in url
  456.         if (parent::getConfig('add_startart_name_to_url') && isset($this->_sArtName)) {
  457.             if ($this->_sArtName == parent::getConfig('default_startart_name')) {
  458.                 // stored articlename is the default one, remove it ModRewrite::getArtIdByWebsafeName()
  459.                 // will find the real article name
  460.                 $this->_sArtName = null;
  461.             }
  462.         }
  463.  
  464.         $idcat = parent::$_oGlobals->get('idcat');
  465.         $idart = parent::$_oGlobals->get('idart');
  466.  
  467.         if ($idcat !== null && $this->_sArtName && $idart == null) {
  468.             // existing idcat with article name and no idart
  469.             $idart = ModRewrite::getArtIdByWebsafeName($this->_sArtName, $idcat);
  470.         } elseif ($idcat > 0 && $this->_sArtName == null && $idart == null) {
  471.  
  472.             if (parent::getConfig('add_startart_name_to_url') && parent::getConfig('default_startart_name') == '') {
  473.  
  474.                 // existing idcat without article name and idart
  475.                 cInclude('classes', 'class.article.php');
  476.                 $artColl = new ArticleCollection(array('idcat' => $idcat, 'start' => 1));
  477.                 if ($artItem = $artColl->startArticle()) {
  478.                     $idart = $artItem->get('idart');
  479.                 }
  480.  
  481.             }
  482.  
  483.         } elseif ($idcat == null && $idart == null && isset($this->_sArtName)) {
  484.             // no idcat and idart but article name
  485.             $idart = ModRewrite::getArtIdByWebsafeName($this->_sArtName);
  486.         }
  487.  
  488.         if ($idart !== null && (!$idart || (int) $idart == 0)) {
  489.             if (parent::getConfig('redirect_invalid_article_to_errorsite') == 1) {
  490.                 $this->_bError = true;
  491.                 $idart = null;
  492.             }
  493.         }
  494.  
  495.         parent::$_oGlobals->set('idart', $idart);
  496.  
  497.         parent::$_oDebug->addDebug($idart, 'ModRewriteController->_setIdart $idart');
  498.     }
  499.  
  500.  
  501.     /**
  502.      * Does post validation of the extracted data.
  503.      *
  504.      * One main goal of this function is to prevent duplicated content, which could happen, if
  505.      * the configuration 'startfromroot' is activated.
  506.      */
  507.     private function _postValidation() {
  508.         if ($this->_bError || $this->_bRoutingFound || !$this->_hasPartArrayItems()) {
  509.             return;
  510.         }
  511.  
  512.         if (parent::getConfig('startfromroot') == 1 && parent::getConfig('prevent_duplicated_content') == 1) {
  513.  
  514.             // prevention of duplicated content if '/firstcat/' is directly requested!
  515.  
  516.             $idcat = parent::$_oGlobals->get('idcat');
  517.             $idart = parent::$_oGlobals->get('idart');
  518.  
  519.             // compose new parameter
  520.             $param = '';
  521.             if ($idcat) {
  522.                 $param .= 'idcat=' . (int) $idcat;
  523.             }
  524.             if ($idart) {
  525.                 $param .= ($param !== '') ? '&idart=' . (int) $idart : 'idart=' . (int) $idart;
  526.             }
  527.  
  528.             if ($param == '') {
  529.                 return;
  530.             }
  531.  
  532.             // set client language, if not set before
  533.             mr_setClientLanguageId(parent::$_oGlobals->get('client'));
  534.  
  535.             //rebuild url
  536.             $url = mr_buildNewUrl('front_content.php?' . $param);
  537.  
  538.             $aUrlComponents = @parse_url($this->_sIncommingUrl);
  539.             $incommingUrl   = (isset($aUrlComponents['path'])) ? $aUrlComponents['path'] : '';
  540.  
  541.             parent::$_oDebug->addDebug($url, 'ModRewriteController->_postValidation validate url');
  542.             parent::$_oDebug->addDebug($incommingUrl, 'ModRewriteController->_postValidation incommingUrl');
  543.  
  544.             // now the new generated uri should be identical with the request uri
  545.             if ($incommingUrl !== $url) {
  546.                 $this->_bError = true;
  547.                 parent::$_oGlobals->set('idcat', null);
  548.             }
  549.         }
  550.     }
  551.  
  552.  
  553.     /**
  554.      * Parses the url using defined separators
  555.      *
  556.      * @param   string  $url  Incoming url
  557.      * @return  string  Parsed url
  558.      */
  559.     private function _parseUrl($url) {
  560.         $this->_sResolvedUrl = $url;
  561.  
  562.         $oMrUrlUtil = ModRewriteUrlUtil::getInstance();
  563.         $url = $oMrUrlUtil->toContenidoUrl($url);
  564.  
  565.         return @parse_url($url);
  566.     }
  567.  
  568.  
  569.     /**
  570.      * Returns state of parts property.
  571.      *
  572.      * @return  bool  True if $this->_aParts propery is an array and contains items
  573.      * @access  private
  574.      */
  575.     function _hasPartArrayItems() {
  576.         if (is_array($this->_aParts) && count($this->_aParts) > 0) {
  577.             return true;
  578.         } else {
  579.             return false;
  580.         }
  581.     }
  582.  
  583. }

Documentation generated on Sun, 21 Dec 2008 21:42:35 +0100 by phpDocumentor 1.4.1