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') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * Logout action class.
  37  *
  38  * @category Action
  39  * @package  StatusNet
  40  * @author   Evan Prodromou <evan@status.net>
  41  * @author   Robin Millette <millette@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  43  * @link     http://status.net/
  44  */
  45 class LogoutAction extends Action
  46 {
  47     /**
  48      * This is read only.
  49      *
  50      * @return boolean true
  51      */
  52     function isReadOnly($args)
  53     {
  54         return false;
  55     }
  56
  57     /**
  58      * Class handler.
  59      *
  60      * @param array $args array of arguments
  61      *
  62      * @return nothing
  63      */
  64     function handle($args)
  65     {
  66         parent::handle($args);
  67         if (!common_logged_in()) {
  68             // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
  69             $this->clientError(_('Not logged in.'));
  70         } else {
  71             if (Event::handle('StartLogout', array($this))) {
  72                 $this->logout();
  73             }
  74             Event::handle('EndLogout', array($this));
  75
  76             common_redirect(common_local_url('public'), 303);
  77         }
  78     }
  79
  80     function logout()
  81     {
  82         common_set_user(null);
  83         common_real_login(false); // not logged in
  84         common_forgetme(); // don't log back in!
  85     }
  86 }