mirror of
https://github.com/friendica/friendica
synced 2025-04-27 20:30:13 +00:00
Add SessionUsers class including tests
This commit is contained in:
Philipp
parent
66a4c30eb7
commit
940619325d
9 changed files with 542 additions and 5 deletions
81
src/Core/Session/Capability/IHandleUserSessions.php
Normal file
81
src/Core/Session/Capability/IHandleUserSessions.php
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
<?php
|
||||
/**
|
||||
* @copyright Copyright (C) 2010-2022, the Friendica project
|
||||
*
|
||||
* @license GNU AGPL version 3 or any later version
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace Friendica\Core\Session\Capability;
|
||||
|
||||
/**
|
||||
* Handles user infos based on session infos
|
||||
*/
|
||||
interface IHandleUserSessions
|
||||
{
|
||||
/**
|
||||
* Returns the user id of locally logged-in user or false.
|
||||
*
|
||||
* @return int|bool user id or false
|
||||
*/
|
||||
public function getLocalUserId();
|
||||
|
||||
/**
|
||||
* Returns the public contact id of logged-in user or false.
|
||||
*
|
||||
* @return int|bool public contact id or false
|
||||
*/
|
||||
public function getPublicContactId();
|
||||
|
||||
/**
|
||||
* Returns public contact id of authenticated site visitor or false
|
||||
*
|
||||
* @return int|bool visitor_id or false
|
||||
*/
|
||||
public function getRemoteUserId();
|
||||
|
||||
/**
|
||||
* Return the user contact ID of a visitor for the given user ID they are visiting
|
||||
*
|
||||
* @param int $uid User ID
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function getRemoteContactID(int $uid): int;
|
||||
|
||||
/**
|
||||
* Returns User ID for given contact ID of the visitor
|
||||
*
|
||||
* @param int $cid Contact ID
|
||||
*
|
||||
* @return int User ID for given contact ID of the visitor
|
||||
*/
|
||||
public function getUserIDForVisitorContactID(int $cid): int;
|
||||
|
||||
/**
|
||||
* Returns if the current visitor is authenticated
|
||||
*
|
||||
* @return bool "true" when visitor is either a local or remote user
|
||||
*/
|
||||
public function isAuthenticated(): bool;
|
||||
|
||||
/**
|
||||
* Set the session variable that contains the contact IDs for the visitor's contact URL
|
||||
*
|
||||
* @param string $url Contact URL
|
||||
*/
|
||||
public function setVisitorsContacts();
|
||||
}
|
||||
|
|
@ -61,7 +61,7 @@ class Cache implements SessionHandlerInterface
|
|||
return $data;
|
||||
}
|
||||
} catch (CachePersistenceException $exception) {
|
||||
$this->logger->warning('Cannot read session.'. ['id' => $id, 'exception' => $exception]);
|
||||
$this->logger->warning('Cannot read session.', ['id' => $id, 'exception' => $exception]);
|
||||
return '';
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ class Database implements SessionHandlerInterface
|
|||
return $session['data'];
|
||||
}
|
||||
} catch (\Exception $exception) {
|
||||
$this->logger->warning('Cannot read session.'. ['id' => $id, 'exception' => $exception]);
|
||||
$this->logger->warning('Cannot read session.', ['id' => $id, 'exception' => $exception]);
|
||||
return '';
|
||||
}
|
||||
|
||||
|
|
@ -114,7 +114,7 @@ class Database implements SessionHandlerInterface
|
|||
$this->dba->insert('session', $fields);
|
||||
}
|
||||
} catch (\Exception $exception) {
|
||||
$this->logger->warning('Cannot write session.'. ['id' => $id, 'exception' => $exception]);
|
||||
$this->logger->warning('Cannot write session.', ['id' => $id, 'exception' => $exception]);
|
||||
return false;
|
||||
}
|
||||
|
||||
|
|
@ -131,7 +131,7 @@ class Database implements SessionHandlerInterface
|
|||
try {
|
||||
return $this->dba->delete('session', ['sid' => $id]);
|
||||
} catch (\Exception $exception) {
|
||||
$this->logger->warning('Cannot destroy session.'. ['id' => $id, 'exception' => $exception]);
|
||||
$this->logger->warning('Cannot destroy session.', ['id' => $id, 'exception' => $exception]);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
|
@ -141,7 +141,7 @@ class Database implements SessionHandlerInterface
|
|||
try {
|
||||
return $this->dba->delete('session', ["`expire` < ?", time()]);
|
||||
} catch (\Exception $exception) {
|
||||
$this->logger->warning('Cannot use garbage collector.'. ['exception' => $exception]);
|
||||
$this->logger->warning('Cannot use garbage collector.', ['exception' => $exception]);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
121
src/Core/Session/Model/UserSession.php
Normal file
121
src/Core/Session/Model/UserSession.php
Normal file
|
|
@ -0,0 +1,121 @@
|
|||
<?php
|
||||
/**
|
||||
* @copyright Copyright (C) 2010-2022, the Friendica project
|
||||
*
|
||||
* @license GNU AGPL version 3 or any later version
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace Friendica\Core\Session\Model;
|
||||
|
||||
use Friendica\Core\Session\Capability\IHandleSessions;
|
||||
use Friendica\Core\Session\Capability\IHandleUserSessions;
|
||||
use Friendica\Model\Contact;
|
||||
|
||||
class UserSession implements IHandleUserSessions
|
||||
{
|
||||
/** @var IHandleSessions */
|
||||
private $session;
|
||||
/** @var int|bool saves the public Contact ID for later usage */
|
||||
protected $publicContactId = false;
|
||||
|
||||
public function __construct(IHandleSessions $session)
|
||||
{
|
||||
$this->session = $session;
|
||||
}
|
||||
|
||||
/** {@inheritDoc} */
|
||||
public function getLocalUserId()
|
||||
{
|
||||
if (!empty($this->session->get('authenticated')) && !empty($this->session->get('uid'))) {
|
||||
return intval($this->session->get('uid'));
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/** {@inheritDoc} */
|
||||
public function getPublicContactId()
|
||||
{
|
||||
if (empty($this->publicContactId) && !empty($this->session->get('authenticated'))) {
|
||||
if (!empty($this->session->get('my_address'))) {
|
||||
// Local user
|
||||
$this->publicContactId = Contact::getIdForURL($this->session->get('my_address'), 0, false);
|
||||
} elseif (!empty($this->session->get('visitor_home'))) {
|
||||
// Remote user
|
||||
$this->publicContactId = Contact::getIdForURL($this->session->get('visitor_home'), 0, false);
|
||||
}
|
||||
} elseif (empty($this->session->get('authenticated'))) {
|
||||
$this->publicContactId = false;
|
||||
}
|
||||
|
||||
return $this->publicContactId;
|
||||
}
|
||||
|
||||
/** {@inheritDoc} */
|
||||
public function getRemoteUserId()
|
||||
{
|
||||
if (empty($this->session->get('authenticated'))) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!empty($this->session->get('visitor_id'))) {
|
||||
return (int)$this->session->get('visitor_id');
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/** {@inheritDoc} */
|
||||
public function getRemoteContactID(int $uid): int
|
||||
{
|
||||
if (!empty($this->session->get('remote')[$uid])) {
|
||||
$remote = $this->session->get('remote')[$uid];
|
||||
} else {
|
||||
$remote = 0;
|
||||
}
|
||||
|
||||
$local_user = !empty($this->session->get('authenticated')) ? $this->session->get('uid') : 0;
|
||||
|
||||
if (empty($remote) && ($local_user != $uid) && !empty($my_address = $this->session->get('my_address'))) {
|
||||
$remote = Contact::getIdForURL($my_address, $uid, false);
|
||||
}
|
||||
|
||||
return $remote;
|
||||
}
|
||||
|
||||
/** {@inheritDoc} */
|
||||
public function getUserIDForVisitorContactID(int $cid): int
|
||||
{
|
||||
if (empty($this->session->get('remote'))) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return array_search($cid, $this->session->get('remote'));
|
||||
}
|
||||
|
||||
/** {@inheritDoc} */
|
||||
public function isAuthenticated(): bool
|
||||
{
|
||||
return $this->session->get('authenticated', false);
|
||||
}
|
||||
|
||||
/** {@inheritDoc} */
|
||||
public function setVisitorsContacts()
|
||||
{
|
||||
$this->session->set('remote', Contact::getVisitorByUrl($this->session->get('my_url')));
|
||||
}
|
||||
}
|
||||
81
src/Core/Session/Type/ArraySession.php
Normal file
81
src/Core/Session/Type/ArraySession.php
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
<?php
|
||||
/**
|
||||
* @copyright Copyright (C) 2010-2022, the Friendica project
|
||||
*
|
||||
* @license GNU AGPL version 3 or any later version
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace Friendica\Core\Session\Type;
|
||||
|
||||
use Friendica\Core\Session\Capability\IHandleSessions;
|
||||
|
||||
class ArraySession implements IHandleSessions
|
||||
{
|
||||
/** @var array */
|
||||
protected $data = [];
|
||||
|
||||
public function __construct(array $data = [])
|
||||
{
|
||||
$this->data = $data;
|
||||
}
|
||||
|
||||
public function start(): IHandleSessions
|
||||
{
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function exists(string $name): bool
|
||||
{
|
||||
return !empty($this->data[$name]);
|
||||
}
|
||||
|
||||
public function get(string $name, $defaults = null)
|
||||
{
|
||||
return $this->data[$name] ?? $defaults;
|
||||
}
|
||||
|
||||
public function pop(string $name, $defaults = null)
|
||||
{
|
||||
$value = $defaults;
|
||||
if ($this->exists($name)) {
|
||||
$value = $this->get($name);
|
||||
$this->remove($name);
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
public function set(string $name, $value)
|
||||
{
|
||||
$this->data[$name] = $value;
|
||||
}
|
||||
|
||||
public function setMultiple(array $values)
|
||||
{
|
||||
$this->data = array_merge($values, $this->data);
|
||||
}
|
||||
|
||||
public function remove(string $name)
|
||||
{
|
||||
unset($this->data[$name]);
|
||||
}
|
||||
|
||||
public function clear()
|
||||
{
|
||||
$this->data = [];
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue