4 * @file src/Core/Session.php
6 namespace Friendica\Core;
9 use Friendica\Core\Session\CacheSessionHandler;
10 use Friendica\Core\Session\DatabaseSessionHandler;
11 use Friendica\Database\DBA;
12 use Friendica\Model\Contact;
13 use Friendica\Model\User;
14 use Friendica\Util\BaseURL;
15 use Friendica\Util\DateTimeFormat;
18 * High-level Session service class
20 * @author Hypolite Petovan <hypolite@mrpetovan.com>
24 public static $exists = false;
25 public static $expire = 180000;
27 public static function init()
29 ini_set('session.gc_probability', 50);
30 ini_set('session.use_only_cookies', 1);
31 ini_set('session.cookie_httponly', 1);
33 if (Config::get('system', 'ssl_policy') == BaseURL::SSL_POLICY_FULL) {
34 ini_set('session.cookie_secure', 1);
37 $session_handler = Config::get('system', 'session_handler', 'database');
38 if ($session_handler != 'native') {
39 if ($session_handler == 'cache' && Config::get('system', 'cache_driver', 'database') != 'database') {
40 $SessionHandler = new CacheSessionHandler();
42 $SessionHandler = new DatabaseSessionHandler();
45 session_set_save_handler($SessionHandler);
49 public static function exists($name)
51 return isset($_SESSION[$name]);
55 * Retrieves a key from the session super global or the defaults if the key is missing or the value is falsy.
57 * Handle the case where session_start() hasn't been called and the super global isn't available.
60 * @param mixed $defaults
63 public static function get($name, $defaults = null)
65 return $_SESSION[$name] ?? $defaults;
69 * Sets a single session variable.
70 * Overrides value of existing key.
75 public static function set($name, $value)
77 $_SESSION[$name] = $value;
81 * Sets multiple session variables.
82 * Overrides values for existing keys.
84 * @param array $values
86 public static function setMultiple(array $values)
88 $_SESSION = $values + $_SESSION;
92 * Removes a session variable.
93 * Ignores missing keys.
97 public static function remove($name)
99 unset($_SESSION[$name]);
103 * @brief Sets the provided user's authenticated session
106 * @param array $user_record
107 * @param bool $login_initial
108 * @param bool $interactive
109 * @param bool $login_refresh
110 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
112 public static function setAuthenticatedForUser(App $a, array $user_record, $login_initial = false, $interactive = false, $login_refresh = false)
115 'uid' => $user_record['uid'],
116 'theme' => $user_record['theme'],
117 'mobile-theme' => PConfig::get($user_record['uid'], 'system', 'mobile_theme'),
118 'authenticated' => 1,
119 'page_flags' => $user_record['page-flags'],
120 'my_url' => $a->getBaseURL() . '/profile/' . $user_record['nickname'],
121 'my_address' => $user_record['nickname'] . '@' . substr($a->getBaseURL(), strpos($a->getBaseURL(), '://') + 3),
122 'addr' => defaults($_SERVER, 'REMOTE_ADDR', '0.0.0.0'),
125 $member_since = strtotime($user_record['register_date']);
126 self::set('new_member', time() < ($member_since + ( 60 * 60 * 24 * 14)));
128 if (strlen($user_record['timezone'])) {
129 date_default_timezone_set($user_record['timezone']);
130 $a->timezone = $user_record['timezone'];
133 $masterUid = $user_record['uid'];
135 if (self::get('submanage')) {
136 $user = DBA::selectFirst('user', ['uid'], ['uid' => self::get('submanage')]);
137 if (DBA::isResult($user)) {
138 $masterUid = $user['uid'];
142 $a->identities = User::identities($masterUid);
144 if ($login_initial) {
145 $a->getLogger()->info('auth_identities: ' . print_r($a->identities, true));
148 if ($login_refresh) {
149 $a->getLogger()->info('auth_identities refresh: ' . print_r($a->identities, true));
152 $contact = DBA::selectFirst('contact', [], ['uid' => $user_record['uid'], 'self' => true]);
153 if (DBA::isResult($contact)) {
154 $a->contact = $contact;
155 $a->cid = $contact['id'];
156 self::set('cid', $a->cid);
159 header('X-Account-Management-Status: active; name="' . $user_record['username'] . '"; id="' . $user_record['nickname'] . '"');
161 if ($login_initial || $login_refresh) {
162 DBA::update('user', ['login_date' => DateTimeFormat::utcNow()], ['uid' => $user_record['uid']]);
164 // Set the login date for all identities of the user
165 DBA::update('user', ['login_date' => DateTimeFormat::utcNow()],
166 ['parent-uid' => $masterUid, 'account_removed' => false]);
169 if ($login_initial) {
171 * If the user specified to remember the authentication, then set a cookie
172 * that expires after one week (the default is when the browser is closed).
173 * The cookie will be renewed automatically.
174 * The week ensures that sessions will expire after some inactivity.
177 if (self::get('remember')) {
178 $a->getLogger()->info('Injecting cookie for remembered user ' . $user_record['nickname']);
179 Authentication::setCookie(604800, $user_record);
180 self::remove('remember');
184 Authentication::twoFactorCheck($user_record['uid'], $a);
187 if ($user_record['login_date'] <= DBA::NULL_DATETIME) {
188 info(L10n::t('Welcome %s', $user_record['username']));
189 info(L10n::t('Please upload a profile photo.'));
190 $a->internalRedirect('profile_photo/new');
192 info(L10n::t("Welcome back %s", $user_record['username']));
196 $a->user = $user_record;
198 if ($login_initial) {
199 Hook::callAll('logged_in', $a->user);
201 if ($a->module !== 'home' && self::exists('return_path')) {
202 $a->internalRedirect(self::get('return_path'));