      1: <?php
      2:
      3: // include the config file
      4: if(!isset($config)) {
      5:     require_once '../util/AlphaConfig.inc';
      6:     $config = AlphaConfig::getInstance();
      7:
      8:     require_once $config->get('app.root').'alpha/util/AlphaAutoLoader.inc';
      9: }
     10:
     11: /**
     12:  *
     13:  * Logout controller that removes the current user object from the session
     14:  *
     15:  * @package alpha::controller
     16:  * @since 1.0
     17:  * @author John Collins <dev@alphaframework.org>
     18:  * @version $Id: Logout.php 1624 2012-12-21 12:17:55Z alphadevx $
     19:  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
     20:  * @copyright Copyright (c) 2012, John Collins (founder of Alpha Framework).
     21:  * All rights reserved.
     22:  *
     23:  * <pre>
     24:  * Redistribution and use in source and binary forms, with or
     25:  * without modification, are permitted provided that the
     26:  * following conditions are met:
     27:  *
     28:  * * Redistributions of source code must retain the above
     29:  *   copyright notice, this list of conditions and the
     30:  *   following disclaimer.
     31:  * * Redistributions in binary form must reproduce the above
     32:  *   copyright notice, this list of conditions and the
     33:  *   following disclaimer in the documentation and/or other
     34:  *   materials provided with the distribution.
     35:  * * Neither the name of the Alpha Framework nor the names
     36:  *   of its contributors may be used to endorse or promote
     37:  *   products derived from this software without specific
     38:  *   prior written permission.
     39:  *
     40:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
     41:  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
     42:  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     43:  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     44:  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
     45:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     46:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     47:  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     48:  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     49:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     50:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
     51:  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     52:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     53:  * </pre>
     54:  *
     55:  */
     56: class Logout extends AlphaController implements AlphaControllerInterface {
     57:     /**
     58:      * Trace logger
     59:      *
     60:      * @var Logger
     61:      * @since 1.0
     62:      */
     63:     private static $logger = null;
     64:
     65:     /**
     66:      * constructor to set up the object
     67:      *
     68:      * @since 1.0
     69:      */
     70:     public function __construct() {
     71:         self::$logger = new Logger('Logout');
     72:         self::$logger->debug('>>__construct()');
     73:
     74:         // ensure that the super class constructor is called, indicating the rights group
     75:         parent::__construct('Public');
     76:
     77:         if(isset($_SESSION['currentUser']))
     78:             $this->setBO($_SESSION['currentUser']);
     79:         else
     80:             self::$logger->warn('Logout controller called when no user is logged in');
     81:
     82:         // set up the title and meta details
     83:         $this->setTitle('Logged out successfully.');
     84:         $this->setDescription('Logout page.');
     85:         $this->setKeywords('Logout,logon');
     86:
     87:         self::$logger->debug('<<__construct');
     88:     }
     89:
     90:     /**
     91:      * Handle POST requests (adds $currentUser PersonObject to the session)
     92:      *
     93:      * @param array $params
     94:      * @since 1.0
     95:      */
     96:     public function doPOST($params) {
     97:         self::$logger->debug('>>doPOST($params=['.var_export($params, true).'])');
     98:
     99:         self::$logger->debug('<<doPOST');
    100:     }
    101:
    102:     /**
    103:      * Handle GET requests
    104:      *
    105:      * @param array $params
    106:      * @since 1.0
    107:      * @throws AlphaException
    108:      */
    109:     public function doGET($params) {
    110:         self::$logger->debug('>>doGET($params=['.var_export($params, true).'])');
    111:
    112:         global $config;
    113:
    114:         if($this->BO instanceof PersonObject)
    115:             self::$logger->info('Logging out ['.$this->BO->get('email').'] at ['.date("Y-m-d H:i:s").']');
    116:
    117:         $_SESSION = array();
    118:
    119:         session_destroy();
    120:
    121:         echo AlphaView::displayPageHead($this);
    122:
    123:         echo AlphaView::displayUpdateMessage('You have successfully logged out of the system.');
    124:
    125:         echo '<div align="center"><a href="'.$config->get('app.url').'">Home Page</a></div>';
    126:
    127:         echo AlphaView::displayPageFoot($this);
    128:
    129:         self::$logger->debug('<<doGET');
    130:     }
    131: }
    132:
    133: // now build the new controller if this file is called directly
    134: if ('Logout.php' == basename($_SERVER['PHP_SELF'])) {
    135:     $controller = new Logout();
    136:
    137:     if(!empty($_POST)) {
    138:         $controller->doPOST($_POST);
    139:     }else{
    140:         $controller->doGET($_GET);
    141:     }
    142: }
    143:
    144: ?>