Alpha Framework alpha--controller
[ class tree: alpha--controller ] [ index: alpha--controller ] [ all elements ]
alpha--controller
Packages:
alpha--controller
alpha--controller--front
alpha--exceptions
alpha--model
alpha--model--types
alpha--service
alpha--tasks
alpha--tests
alpha--util
alpha--util--cache
alpha--util--convertors
alpha--util--feeds
alpha--util--filters
alpha--util--graphs
alpha--util--helpers
alpha--util--metrics
alpha--view
alpha--view--widgets

Source for file GenSecureQueryStrings.php

Documentation is available at GenSecureQueryStrings.php

  1. <?php
  2.  
  3. // include the config file
  4. if(!isset($config)) {
  5.     require_once '../util/AlphaConfig.inc';
  6.     $config = AlphaConfig::getInstance();
  7. }
  8.  
  9. require_once $config->get('sysRoot').'alpha/controller/AlphaController.inc';
  10. require_once $config->get('sysRoot').'alpha/controller/front/FrontController.inc';
  11. require_once $config->get('sysRoot').'alpha/controller/AlphaControllerInterface.inc';
  12. require_once $config->get('sysRoot').'alpha/view/AlphaView.inc';
  13.  
  14. /**
  15.  *
  16.  * Controller used to generate secure URLs from the query strings provided
  17.  * 
  18.  * @package alpha::controller
  19.  * @since 1.0
  20.  * @author John Collins <dev@alphaframework.org>
  21.  * @version $Id: GenSecureQueryStrings.php 1453 2011-12-04 15:12:54Z johnc $
  22.  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
  23.  * @copyright Copyright (c) 2011, John Collins (founder of Alpha Framework).
  24.  *  All rights reserved.
  25.  * 
  26.  *  <pre>
  27.  *  Redistribution and use in source and binary forms, with or
  28.  *  without modification, are permitted provided that the
  29.  *  following conditions are met:
  30.  * 
  31.  *  * Redistributions of source code must retain the above
  32.  *    copyright notice, this list of conditions and the
  33.  *    following disclaimer.
  34.  *  * Redistributions in binary form must reproduce the above
  35.  *    copyright notice, this list of conditions and the
  36.  *    following disclaimer in the documentation and/or other
  37.  *    materials provided with the distribution.
  38.  *  * Neither the name of the Alpha Framework nor the names
  39.  *    of its contributors may be used to endorse or promote
  40.  *    products derived from this software without specific
  41.  *    prior written permission.
  42.  *   
  43.  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  44.  *  CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  45.  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  46.  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  47.  *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  48.  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  49.  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  50.  *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  51.  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  52.  *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  53.  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  54.  *  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  55.  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  56.  *  </pre>
  57.  *  
  58.  */
  59. class GenSecureQueryStrings extends AlphaController implements AlphaControllerInterface {
  60.     /**
  61.      * Trace logger
  62.      * 
  63.      * @var Logger 
  64.      * @since 1.0
  65.      */
  66.     private static $logger = null;
  67.     
  68.     /**
  69.      * Constructor
  70.      * 
  71.      * @since 1.0
  72.      */
  73.     public function __construct() {
  74.         self::$logger = new Logger('CacheManager');
  75.         self::$logger->debug('>>__construct()');
  76.         
  77.         global $config;
  78.         
  79.         // ensure that the super class constructor is called, indicating the rights group
  80.         parent::__construct('Admin');
  81.         
  82.         $this->setTitle('Generate Secure Query Strings');
  83.         
  84.         self::$logger->debug('<<__construct');
  85.     }
  86.     
  87.     /**
  88.      * Handle GET requests
  89.      * 
  90.      * @param array $params 
  91.      * @since 1.0
  92.      */
  93.     public function doGET($params) {
  94.         self::$logger->debug('>>doGET($params=['.var_export($params, true).'])');
  95.         
  96.         echo AlphaView::displayPageHead($this);
  97.         
  98.         echo $this->renderForm();
  99.         
  100.         echo AlphaView::displayPageFoot($this);
  101.         
  102.         self::$logger->debug('<<doGET');
  103.     }
  104.     
  105.     /**
  106.      * Handle POST requests
  107.      * 
  108.      * @param array $params 
  109.      * @since 1.0
  110.      */
  111.     public function doPOST($params) {
  112.         self::$logger->debug('>>doPOST($params=['.var_export($params, true).'])');
  113.         
  114.         global $config;
  115.  
  116.         echo AlphaView::displayPageHead($this);
  117.         
  118.         echo '<p style="width:90%; overflow:scroll;">';
  119.         if(isset($params['QS']))
  120.             echo FrontController::generateSecureURL($params['QS']);
  121.         echo '</p>';
  122.         
  123.         echo $this->renderForm();
  124.         
  125.         echo AlphaView::displayPageFoot($this);
  126.         
  127.         self::$logger->debug('<<doPOST');
  128.     }
  129.     
  130.     /**
  131.      * Renders the HTML form for generating secure URLs
  132.      * 
  133.      * @return string 
  134.      * @since 1.0
  135.      */
  136.     private function renderForm() {
  137.         global $config;
  138.         
  139.         $html = '<p>Use this form to generate secure (encrypted) URLs which make use of the Front Controller.  Always be sure to specify an action controller'.
  140.             ' (act) at a minimum.</p>';
  141.         $html .= '<p>Example 1: to generate a secure URL for viewing article object 00000000001, enter <em>act=ViewArticle&oid=00000000001</em></p>';
  142.         $html .= '<p>Example 2: to generate a secure URL for viewing an Atom news feed of the articles, enter'.
  143.             ' <em>act=ViewFeed&bo=ArticleObject&type=Atom</em</p>';
  144.  
  145.         $html .= '<form action="'.$_SERVER['REQUEST_URI'].'" method="post">';
  146.         $html .= '<input type="text" name="QS" size="100"/>';
  147.         $temp = new Button('submit', 'Generate', 'saveBut');
  148.         $html .= $temp->render();
  149.         $html .= '</form>';
  150.         
  151.         return $html;
  152.     }
  153. }
  154.  
  155. // now build the new controller if this file is called directly
  156. if ('GenSecureQueryStrings.php' == basename($_SERVER['PHP_SELF'])) {
  157.     $controller = new GenSecureQueryStrings();
  158.     
  159.     if(!empty($_POST)) {            
  160.         $controller->doPOST($_QUERY);
  161.     }else{
  162.         $controller->doGET($_GET);
  163.     }
  164. }
  165.  
  166. ?>
Documentation generated on Tue, 13 Dec 2011 20:26:58 +0000 by phpDocumentor 1.4.3