logout.php 2.2 KB

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