src/Core/Session.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, 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\Core;
  23
  24 use Friendica\Database\DBA;
  25 use Friendica\DI;
  26 use Friendica\Model\Contact;
  27 use Friendica\Util\Strings;
  28
  29 /**
  30  * High-level Session service class
  31  */
  32 class Session
  33 {
  34         public static $exists = false;
  35         public static $expire = 180000;
  36
  37         public static function exists($name)
  38         {
  39                 return DI::session()->exists($name);
  40         }
  41
  42         public static function get($name, $defaults = null)
  43         {
  44                 return DI::session()->get($name, $defaults);
  45         }
  46
  47         public static function pop($name, $defaults = null)
  48         {
  49                 return DI::session()->pop($name, $defaults);
  50         }
  51
  52         public static function set($name, $value)
  53         {
  54                 DI::session()->set($name, $value);
  55         }
  56
  57         public static function setMultiple(array $values)
  58         {
  59                 DI::session()->setMultiple($values);
  60         }
  61
  62         public static function remove($name)
  63         {
  64                 DI::session()->remove($name);
  65         }
  66
  67         public static function clear()
  68         {
  69                 DI::session()->clear();
  70         }
  71
  72         /**
  73          * Return the user contact ID of a visitor for the given user ID they are visiting
  74          *
  75          * @param integer $uid User ID
  76          * @return integer
  77          */
  78         public static function getRemoteContactID($uid)
  79         {
  80                 $session = DI::session();
  81
  82                 if (!empty($session->get('remote')[$uid])) {
  83                         $remote = $session->get('remote')[$uid];
  84                 } else {
  85                         $remote = 0;
  86                 }
  87
  88                 $local_user = !empty($session->get('authenticated')) ? $session->get('uid') : 0;
  89
  90                 if (empty($remote) && ($local_user != $uid) && !empty($my_address = $session->get('my_address'))) {
  91                         $remote = Contact::getIdForURL($my_address, $uid, false);
  92                 }
  93
  94                 return $remote;
  95         }
  96
  97         /**
  98          * Returns User ID for given contact ID of the visitor
  99          *
 100          * @param integer $cid Contact ID
 101          * @return integer User ID for given contact ID of the visitor
 102          */
 103         public static function getUserIDForVisitorContactID($cid)
 104         {
 105                 $session = DI::session();
 106
 107                 if (empty($session->get('remote'))) {
 108                         return false;
 109                 }
 110
 111                 return array_search($cid, $session->get('remote'));
 112         }
 113
 114         /**
 115          * Set the session variable that contains the contact IDs for the visitor's contact URL
 116          *
 117          * @param string $url Contact URL
 118          */
 119         public static function setVisitorsContacts()
 120         {
 121                 $session = DI::session();
 122
 123                 $session->set('remote', []);
 124                 $remote = [];
 125
 126                 $remote_contacts = DBA::select('contact', ['id', 'uid'], ['nurl' => Strings::normaliseLink($session->get('my_url')), 'rel' => [Contact::FOLLOWER, Contact::FRIEND], 'self' => false]);
 127                 while ($contact = DBA::fetch($remote_contacts)) {
 128                         if (($contact['uid'] == 0) || Contact\User::isBlocked($contact['id'], $contact['uid'])) {
 129                                 continue;
 130                         }
 131                         $remote[$contact['uid']] = $contact['id'];
 132                 }
 133                 DBA::close($remote_contacts);
 134                 $session->set('remote', $remote);
 135         }
 136
 137         /**
 138          * Returns if the current visitor is authenticated
 139          *
 140          * @return boolean "true" when visitor is either a local or remote user
 141          */
 142         public static function isAuthenticated()
 143         {
 144                 $session = DI::session();
 145
 146                 return $session->get('authenticated', false);
 147         }
 148 }