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         /**
  35          * Returns the user id of locally logged in user or false.
  36          *
  37          * @return int|bool user id or false
  38          */
  39         public static function getLocalUser()
  40         {
  41                 $session = DI::session();
  42
  43                 if (!empty($session->get('authenticated')) && !empty($session->get('uid'))) {
  44                         return intval($session->get('uid'));
  45                 }
  46
  47                 return false;
  48         }
  49
  50         /**
  51          * Returns the public contact id of logged in user or false.
  52          *
  53          * @return int|bool public contact id or false
  54          */
  55         public static function getPublicContact()
  56         {
  57                 static $public_contact_id = false;
  58
  59                 $session = DI::session();
  60
  61                 if (!$public_contact_id && !empty($session->get('authenticated'))) {
  62                         if (!empty($session->get('my_address'))) {
  63                                 // Local user
  64                                 $public_contact_id = intval(Contact::getIdForURL($session->get('my_address'), 0, false));
  65                         } elseif (!empty($session->get('visitor_home'))) {
  66                                 // Remote user
  67                                 $public_contact_id = intval(Contact::getIdForURL($session->get('visitor_home'), 0, false));
  68                         }
  69                 } elseif (empty($session->get('authenticated'))) {
  70                         $public_contact_id = false;
  71                 }
  72
  73                 return $public_contact_id;
  74         }
  75
  76         /**
  77          * Returns public contact id of authenticated site visitor or false
  78          *
  79          * @return int|bool visitor_id or false
  80          */
  81         public static function getRemoteUser()
  82         {
  83                 $session = DI::session();
  84
  85                 if (empty($session->get('authenticated'))) {
  86                         return false;
  87                 }
  88
  89                 if (!empty($session->get('visitor_id'))) {
  90                         return intval($session->get('visitor_id'));
  91                 }
  92
  93                 return false;
  94         }
  95
  96         /**
  97          * Return the user contact ID of a visitor for the given user ID they are visiting
  98          *
  99          * @param integer $uid User ID
 100          * @return integer
 101          */
 102         public static function getRemoteContactID($uid)
 103         {
 104                 $session = DI::session();
 105
 106                 if (!empty($session->get('remote')[$uid])) {
 107                         $remote = $session->get('remote')[$uid];
 108                 } else {
 109                         $remote = 0;
 110                 }
 111
 112                 $local_user = !empty($session->get('authenticated')) ? $session->get('uid') : 0;
 113
 114                 if (empty($remote) && ($local_user != $uid) && !empty($my_address = $session->get('my_address'))) {
 115                         $remote = Contact::getIdForURL($my_address, $uid, false);
 116                 }
 117
 118                 return $remote;
 119         }
 120
 121         /**
 122          * Returns User ID for given contact ID of the visitor
 123          *
 124          * @param integer $cid Contact ID
 125          * @return integer User ID for given contact ID of the visitor
 126          */
 127         public static function getUserIDForVisitorContactID($cid)
 128         {
 129                 $session = DI::session();
 130
 131                 if (empty($session->get('remote'))) {
 132                         return false;
 133                 }
 134
 135                 return array_search($cid, $session->get('remote'));
 136         }
 137
 138         /**
 139          * Set the session variable that contains the contact IDs for the visitor's contact URL
 140          *
 141          * @param string $url Contact URL
 142          */
 143         public static function setVisitorsContacts()
 144         {
 145                 $session = DI::session();
 146
 147                 $session->set('remote', []);
 148                 $remote = [];
 149
 150                 $remote_contacts = DBA::select('contact', ['id', 'uid'], ['nurl' => Strings::normaliseLink($session->get('my_url')), 'rel' => [Contact::FOLLOWER, Contact::FRIEND], 'self' => false]);
 151                 while ($contact = DBA::fetch($remote_contacts)) {
 152                         if (($contact['uid'] == 0) || Contact\User::isBlocked($contact['id'], $contact['uid'])) {
 153                                 continue;
 154                         }
 155                         $remote[$contact['uid']] = $contact['id'];
 156                 }
 157                 DBA::close($remote_contacts);
 158                 $session->set('remote', $remote);
 159         }
 160
 161         /**
 162          * Returns if the current visitor is authenticated
 163          *
 164          * @return boolean "true" when visitor is either a local or remote user
 165          */
 166         public static function isAuthenticated()
 167         {
 168                 $session = DI::session();
 169
 170                 return $session->get('authenticated', false);
 171         }
 172 }