-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
SessionFactory.php
164 lines (130 loc) · 5.4 KB
/
SessionFactory.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<?php
/**
* Joomla! Content Management System
*
* @copyright (C) 2018 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Session;
use Joomla\Database\DatabaseInterface;
use Joomla\DI\ContainerAwareInterface;
use Joomla\DI\ContainerAwareTrait;
use Joomla\Registry\Registry;
use Joomla\Session\Handler;
use Joomla\Session\HandlerInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
// phpcs:disable PSR1.Files.SideEffects
\defined('JPATH_PLATFORM') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Factory for creating session API objects
*
* @since 4.0.0
*/
class SessionFactory implements ContainerAwareInterface
{
use ContainerAwareTrait;
/**
* Create a session handler based on the application configuration.
*
* @param array $options The options used to instantiate the SessionInterface instance.
*
* @return HandlerInterface
*
* @since 4.0.0
*/
public function createSessionHandler(array $options): HandlerInterface
{
$resolver = new OptionsResolver();
$this->configureSessionHandlerOptions($resolver);
$options = $resolver->resolve($options);
/** @var Registry $config */
$config = $this->getContainer()->get('config');
$handlerType = $config->get('session_handler', 'filesystem');
switch ($handlerType) {
case 'apcu':
if (!Handler\ApcuHandler::isSupported()) {
throw new \RuntimeException('APCu is not supported on this system.');
}
return new Handler\ApcuHandler();
case 'database':
return new Handler\DatabaseHandler($this->getContainer()->get(DatabaseInterface::class));
case 'filesystem':
case 'none':
// Try to use a custom configured path, fall back to the path in the PHP runtime configuration
$path = $config->get('session_filesystem_path', ini_get('session.save_path'));
// If we still have no path, as a last resort fall back to the system's temporary directory
if (empty($path)) {
$path = sys_get_temp_dir();
}
return new Handler\FilesystemHandler($path);
case 'memcached':
if (!Handler\MemcachedHandler::isSupported()) {
throw new \RuntimeException('Memcached is not supported on this system.');
}
$host = $config->get('session_memcached_server_host', 'localhost');
$port = $config->get('session_memcached_server_port', 11211);
$memcached = new \Memcached($config->get('session_memcached_server_id', 'joomla_cms'));
$memcached->addServer($host, $port);
ini_set('session.save_path', "$host:$port");
ini_set('session.save_handler', 'memcached');
return new Handler\MemcachedHandler($memcached, ['ttl' => $options['expire']]);
case 'redis':
if (!Handler\RedisHandler::isSupported()) {
throw new \RuntimeException('Redis is not supported on this system.');
}
$redis = new \Redis();
$host = $config->get('session_redis_server_host', '127.0.0.1');
// Use default port if connecting over a socket whatever the config value
$port = $host[0] === '/' ? 0 : $config->get('session_redis_server_port', 6379);
if ($config->get('session_redis_persist', true)) {
$redis->pconnect(
$host,
$port
);
} else {
$redis->connect(
$host,
$port
);
}
if (!empty($config->get('session_redis_server_auth', ''))) {
$redis->auth($config->get('session_redis_server_auth', null));
}
$db = (int) $config->get('session_redis_server_db', 0);
if ($db !== 0) {
$redis->select($db);
}
return new Handler\RedisHandler($redis, ['ttl' => $options['expire']]);
case 'wincache':
// @TODO Remove WinCache with Joomla 5.0
if (!Handler\WincacheHandler::isSupported()) {
throw new \RuntimeException('Wincache is not supported on this system.');
}
return new Handler\WincacheHandler();
default:
throw new \InvalidArgumentException(sprintf('The "%s" session handler is not recognised.', $handlerType));
}
}
/**
* Resolve the options for the session handler.
*
* @param OptionsResolver $resolver The options resolver.
*
* @return void
*
* @since 4.0.0
*/
protected function configureSessionHandlerOptions(OptionsResolver $resolver)
{
$resolver->setDefaults(
[
'force_ssl' => false,
]
);
$resolver->setRequired(['name', 'expire']);
$resolver->setAllowedTypes('name', ['string']);
$resolver->setAllowedTypes('expire', ['int']);
$resolver->setAllowedTypes('force_ssl', ['bool']);
}
}