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('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * Logout action class.
  35  *
  36  * @category Action
  37  * @package  StatusNet
  38  * @author   Evan Prodromou <evan@status.net>
  39  * @author   Robin Millette <millette@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  41  * @link     http://status.net/
  42  */
  43 class LogoutAction extends ManagedAction
  44 {
  45     /**
  46      * This is read only.
  47      *
  48      * @return boolean true
  49      */
  50     function isReadOnly(array $args=array())
  51     {
  52         return false;
  53     }
  54
  55     /**
  56      * Class handler.
  57      *
  58      * @return nothing
  59      */
  60     protected function doPreparation()
  61     {
  62         if (!common_logged_in()) {
  63             // TRANS: Error message displayed when trying to logout even though you are not logged in.
  64             throw new AlreadyFulfilledException(_('Cannot log you out if you are not logged in.'));
  65         }
  66         if (Event::handle('StartLogout', array($this))) {
  67             $this->logout();
  68         }
  69         Event::handle('EndLogout', array($this));
  70
  71         common_redirect(common_local_url('top'));
  72     }
  73
  74     // Accessed through the action on events
  75     public function logout()
  76     {
  77         common_set_user(null);
  78         common_real_login(false); // not logged in
  79         common_forgetme(); // don't log back in!
  80     }
  81 }