src/Module/Security/Logout.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2024, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Module\Security;
  23
  24 use Friendica\App;
  25 use Friendica\BaseModule;
  26 use Friendica\Core\Cache\Capability\ICanCache;
  27 use Friendica\Core\Hook;
  28 use Friendica\Core\L10n;
  29 use Friendica\Core\Session\Capability\IHandleUserSessions;
  30 use Friendica\Core\System;
  31 use Friendica\DI;
  32 use Friendica\Model\Profile;
  33 use Friendica\Model\User\Cookie;
  34 use Friendica\Module\Response;
  35 use Friendica\Util\Profiler;
  36 use Psr\Log\LoggerInterface;
  37
  38 /**
  39  * Logout module
  40  */
  41 class Logout extends BaseModule
  42 {
  43         /** @var ICanCache */
  44         protected $cache;
  45         /** @var Cookie */
  46         protected $cookie;
  47         /** @var IHandleUserSessions */
  48         protected $session;
  49
  50         public function __construct(L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, ICanCache $cache, Cookie $cookie, IHandleUserSessions $session, array $server, array $parameters = [])
  51         {
  52                 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
  53
  54                 $this->cache   = $cache;
  55                 $this->cookie  = $cookie;
  56                 $this->session = $session;
  57         }
  58
  59
  60         /**
  61          * Process logout requests
  62          */
  63         protected function rawContent(array $request = [])
  64         {
  65                 $visitor_home = null;
  66                 if ($this->session->getRemoteUserId()) {
  67                         $visitor_home = Profile::getMyURL();
  68                         $this->cache->delete('zrlInit:' . $visitor_home);
  69                 }
  70
  71                 Hook::callAll("logging_out");
  72
  73                 // If this is a trusted browser, redirect to the 2fa signout page
  74                 if ($this->cookie->get('2fa_cookie_hash')) {
  75                         $this->baseUrl->redirect('2fa/signout');
  76                 }
  77
  78                 $this->cookie->clear();
  79                 $this->session->clear();
  80
  81                 if ($visitor_home) {
  82                         System::externalRedirect($visitor_home);
  83                 } else {
  84                         DI::sysmsg()->addInfo($this->t('Logged out.'));
  85                         $this->baseUrl->redirect();
  86                 }
  87         }
  88 }