tangra logo
   
[ class tree: tangra_lib ] [ index: tangra_lib ] [ all elements ]
 

Source for file redirect_composer_local.class.php

Documentation is available at redirect_composer_local.class.php

  1. <?php
  2. // *** Tangra (Application Framework and Tools for PHP)
  3. // $Id$
  4. //
  5.  
  6. /**
  7.  * Contains class Redirect_Composer_Local
  8.  *
  9.  * @package tangra_lib
  10.  * @subpackage  web_site
  11.  */
  12.  
  13. /**
  14.  *
  15.  */
  16. require_once(TANGRA_MAIN_DIR.'web_site/web_context.class.php');
  17.  
  18. /**
  19.  *
  20.  */
  21. require_once(TANGRA_MAIN_DIR.'exceptions/te_key_already_exists.class.php');
  22.  
  23. /**
  24.  *
  25.  */
  26. require_once('redirect_composer.class.php');
  27.  
  28. /**
  29.  * Redirect_Composer_Local is intended to be used for internal redirect within site
  30.  *
  31.  * @see Redirect_Composer
  32.  * @package tangra_lib
  33.  * @subpackage  web_site
  34.  */
  35. class Redirect_Composer_Local extends Redirect_Composer {
  36.     /**
  37.      * Holds Web_Context
  38.      *
  39.      * @var Web_Context 
  40.      */
  41.     private $_context;
  42.  
  43.     
  44.     /**
  45.      * 
  46.      * Holds protocol: http, https or ''
  47.      * '' (empty) value means keep current
  48.      * @var string 
  49.      */
  50.     private $protocol;
  51.  
  52.     /**
  53.      * 
  54.      * Holds port that will be used for composing
  55.      * @var integer 
  56.      */
  57.     private $port;
  58.     
  59.     /**
  60.      * Constructor
  61.      *
  62.      * @param string $target Target address
  63.      * @param array $param_pairs Parameters that will be added to target address ($key => $value pairs)
  64.      * @throws Tangra_Exception
  65.      */
  66.     function __construct(Web_Context $context, $target, $param_pairs = array(), $protocol = '', $port = 0) {
  67.         $this->set_context($context);
  68.         parent::__construct($target, $param_pairs);
  69.         
  70.         $this->set_protocol($protocol);
  71.         $this->set_port($port);
  72.     }
  73.  
  74.     /**
  75.      * Sets context
  76.      *
  77.      * @param Web_Context $context 
  78.      * @internal
  79.      */
  80.     private function set_context(Web_Context $context) {
  81.         $this->_context = $context;
  82.     }
  83.  
  84.  
  85.     /**
  86.      * Returns reference to context
  87.      *
  88.      * @return Web_Context 
  89.      */
  90.     public function get__context() {
  91.         return $this->_context;
  92.     }
  93.  
  94.     /**
  95.      * 
  96.      * Sets protocol.
  97.      * @param string $protocol Valid values are http, https and '' (empty). Empty value means "use current" (autodetected)
  98.      * @throws Tangra_Expception
  99.      */
  100.     public function set_protocol($protocol) {
  101.         if ($protocol == '' || $protocol == 'http' || $protocolo == 'https') {
  102.             $this->protocol = $protocol;
  103.         } else {
  104.             throw new Tangra_Expception('Invalid protocol value. Must be "http", "https" or empty. Current value: '.$protocol);
  105.         }
  106.     }
  107.     
  108.     /**
  109.      * 
  110.      * Returns $protocol
  111.      */
  112.     public function get_protocol() {
  113.         return $this->protocol;
  114.     }
  115.  
  116.     
  117.     /**
  118.      * 
  119.      * Sets port to be used when composing
  120.      * Valid values:
  121.      * integer - sets port to specified value
  122.      * 0 - "use current" (autodetected)
  123.      * NULL - sets port to NULL which means don't set port when composing
  124.      * @param integer $port 
  125.      */
  126.     public function set_port($port = 0) {
  127.         if ($port) {
  128.             tangra_if_not_int_throw_e($port);
  129.         }
  130.         
  131.         $this->port = $port;
  132.     }
  133.     
  134.     
  135.     /**
  136.      * 
  137.      * Returns port
  138.      */
  139.     public function get_port() {
  140.         return $this->port;
  141.     }
  142.     
  143.     
  144.     /**
  145.      * Returns composed target address with parameters
  146.      *
  147.      * @param Web_Context $context 
  148.      * @return string 
  149.      */
  150.     public function get_target_address() {
  151.         $context = $this->get__context();
  152.  
  153.         $this->add_threads_manager_var($context);
  154.  
  155.         $server = $context->get_from_server('SERVER_NAME');
  156.         $port = $this->get_port();
  157.         
  158.         $protocol = $this->get_protocol();
  159.         if (!$protocol) {
  160.             if ($context->exists_in_server('HTTPS')) {
  161.                 $https = $context->get_from_server('HTTPS');
  162.             } else {
  163.                 $https = false;
  164.             }
  165.     
  166.             $protocol = ($https) ? 'https' : 'http';
  167.         }
  168.         
  169.         
  170.         if (is_null($port)) {
  171.             $port = '';            
  172.         } elseif ( $port == 0) {
  173.             $port =  $context->get_from_server('SERVER_PORT');
  174.             if (($port == '80' && $protocol == 'http') ||  ($port == '443' && $protocol == 'https')) {
  175.                 $port = '';
  176.             } else {
  177.                 $port = ':'.$port;
  178.             }
  179.         } else {
  180.             $port = ':'.$port;
  181.         }
  182.         
  183.         $params = $this->get_params();
  184.  
  185.         $pi_vars = $this->get_pi_string();
  186.  
  187.         if (substr($this->get_target(), -1) == '/') {
  188.             $ret = $protocol.'://'.$server.$port.'/'.$this->get_target().$pi_vars.$params;
  189.         } else {
  190.             $ret = $protocol.'://'.$server.$port.'/'.$this->get_target().'/'.$pi_vars.$params;
  191.         }
  192.  
  193.         return $ret;
  194.     }
  195.  
  196.  
  197.     /**
  198.      * Adds threads manager var to parameters
  199.      *
  200.      * @param Web_Context $context 
  201.      * @internal
  202.      */
  203.     private function add_threads_manager_var(Web_Context $context) {
  204.         if (defined('THREADS_MANAGER_NAME')) {
  205.             $svm_var_name = Session_Vars_Manager::get_svm_var_name();
  206.             $svm = $context->get_from_session($svm_var_name);
  207.  
  208.  
  209.             if ($svm->is_global_var_registered(THREADS_MANAGER_NAME)) {
  210.                 $tm = $svm->get_global_var(THREADS_MANAGER_NAME);
  211.  
  212.                 // removing if already exists. Needed in case of login redirect or in case of user mistakes
  213.                 if ($this->param_exists(THREADS_MANAGER_NAME)) {
  214.                     $this->remove_param(THREADS_MANAGER_NAME);
  215.                 }
  216.  
  217.                 $this->add_param_pair($tm->get_url_rewrite_var_name(), $tm->get_current_url_var());
  218.             }
  219.  
  220.         }
  221.     }
  222.  
  223.  
  224.     private function get_pi_string() {
  225.         $ret = '';
  226.  
  227.         if (function_exists('_get_pi_string')) {
  228.             $ret = _get_pi_string();
  229.         }
  230.  
  231.         return $ret;
  232.     }
  233. }