actions/logout.php

   1 <?php
   2 /**
   3  * Logout action.
   4  *
   5  * PHP version 5
   6  *
   7  * @category Action
   8  * @package  StatusNet
   9  * @author   Evan Prodromou <evan@status.net>
  10  * @author   Robin Millette <millette@status.net>
  11  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  12  * @link     http://status.net/
  13  *
  14  * StatusNet - the distributed open-source microblogging tool
  15  * Copyright (C) 2008, 2009, StatusNet, Inc.
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU Affero General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU Affero General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU Affero General Public License
  28  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/openid.php';
  36
  37 /**
  38  * Logout action class.
  39  *
  40  * @category Action
  41  * @package  StatusNet
  42  * @author   Evan Prodromou <evan@status.net>
  43  * @author   Robin Millette <millette@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  45  * @link     http://status.net/
  46  */
  47 class LogoutAction extends Action
  48 {
  49
  50     /**
  51      * This is read only.
  52      *
  53      * @return boolean true
  54      */
  55     function isReadOnly($args)
  56     {
  57         return false;
  58     }
  59
  60     /**
  61      * Class handler.
  62      *
  63      * @param array $args array of arguments
  64      *
  65      * @return nothing
  66      */
  67     function handle($args)
  68     {
  69         parent::handle($args);
  70         if (!common_logged_in()) {
  71             $this->clientError(_('Not logged in.'));
  72         } else {
  73             if (Event::handle('StartLogout', array($this))) {
  74                 $this->logout();
  75             }
  76             Event::handle('EndLogout', array($this));
  77
  78             common_redirect(common_local_url('public'), 303);
  79         }
  80     }
  81
  82     function logout()
  83     {
  84         common_set_user(null);
  85         common_real_login(false); // not logged in
  86         common_forgetme(); // don't log back in!
  87     }
  88
  89 }