Orbit Framework 2.0.0
A high-performance asynchronous C++20 HTTP server framework.
Loading...
Searching...
No Matches
SessionManager.hpp
Go to the documentation of this file.
1#pragma once
3#include <chrono>
4#include <memory>
5#include <mutex>
6#include <optional>
7#include <string>
8#include <unordered_map>
11#ifdef ORBIT_ENABLE_REDIS
13#endif
14
15namespace orbit::middleware {
16
18using SessionData = std::unordered_map<std::string, std::string>;
19
24public:
25 virtual ~SessionStore() = default;
27 virtual std::optional<SessionData> load(const std::string& id) = 0;
29 virtual void save(const std::string& id, const SessionData& data, std::chrono::seconds ttl) = 0;
31 virtual void touch(const std::string& id, std::chrono::seconds ttl) = 0;
32 virtual void destroy(const std::string& id) = 0;
33};
34
40public:
43 explicit MemorySessionStore(size_t max_sessions = 100000) : max_sessions_(max_sessions) {}
44
45 std::optional<SessionData> load(const std::string& id) override;
46 void save(const std::string& id, const SessionData& data, std::chrono::seconds ttl) override;
47 void touch(const std::string& id, std::chrono::seconds ttl) override;
48 void destroy(const std::string& id) override;
49 size_t size();
50
51private:
52 using Clock = std::chrono::steady_clock;
53 struct Entry {
55 Clock::time_point expires;
56 };
57 void evict_locked(Clock::time_point now);
58
60 std::unordered_map<std::string, Entry> sessions_;
61 std::mutex mutex_;
62};
63
64#ifdef ORBIT_ENABLE_REDIS
69class RedisSessionStore : public SessionStore {
70public:
71 RedisSessionStore(const std::string& host, int port);
72 std::optional<SessionData> load(const std::string& id) override;
73 void save(const std::string& id, const SessionData& data, std::chrono::seconds ttl) override;
74 void touch(const std::string& id, std::chrono::seconds ttl) override;
75 void destroy(const std::string& id) override;
76
77private:
78 std::shared_ptr<database::RedisClient> redis_;
79};
80#endif
81
89class Session {
90public:
91 const std::string& id() const { return id_; }
93 bool is_new() const { return is_new_; }
94
95 std::optional<std::string> get(const std::string& key) const;
96 void set(const std::string& key, std::string value);
97 void erase(const std::string& key);
98 const SessionData& data() const { return data_; }
99
103 void destroy();
104
105private:
106 friend class SessionManager;
107 std::string id_;
108 std::string previous_id_; // set by regenerate()
110 bool is_new_ = false;
111 bool dirty_ = false;
112 bool destroyed_ = false;
113};
114
116 std::string cookie_name = "session_id";
117 int ttl_seconds = 86400;
118 bool secure = false;
119 std::string same_site = "Lax";
123};
124
131public:
132 SessionManager(std::shared_ptr<SessionStore> store, SessionOptions options = {});
133#ifdef ORBIT_ENABLE_REDIS
135 SessionManager(const std::string& redis_host, int redis_port, SessionOptions options = {});
136#endif
137
138 bool operator()(http::HttpRequest& req, std::shared_ptr<http::ResponseWriter> writer);
139
140 static std::string generate_session_id();
141
142private:
143 std::shared_ptr<SessionStore> store_;
145};
146
148inline auto session(std::shared_ptr<SessionStore> store, SessionOptions options = {}) {
149 return [manager = std::make_shared<SessionManager>(std::move(store), std::move(options))]
150 (http::HttpRequest& req, std::shared_ptr<http::ResponseWriter> writer) -> bool {
151 return (*manager)(req, writer);
152 };
153}
154
155#ifdef ORBIT_ENABLE_REDIS
157inline auto session(const std::string& redis_host, int redis_port, SessionOptions options = {}) {
158 return [manager = std::make_shared<SessionManager>(redis_host, redis_port, std::move(options))]
159 (http::HttpRequest& req, std::shared_ptr<http::ResponseWriter> writer) -> bool {
160 return (*manager)(req, writer);
161 };
162}
163#endif
164
165} // namespace middleware
In-process store. Fine for a single server; sessions are lost on restart and not shared between insta...
Definition SessionManager.hpp:39
size_t max_sessions_
Definition SessionManager.hpp:59
void touch(const std::string &id, std::chrono::seconds ttl) override
Extends the lifetime of an existing session.
std::unordered_map< std::string, Entry > sessions_
Definition SessionManager.hpp:60
MemorySessionStore(size_t max_sessions=100000)
Definition SessionManager.hpp:43
std::chrono::steady_clock Clock
Definition SessionManager.hpp:52
void destroy(const std::string &id) override
std::mutex mutex_
Definition SessionManager.hpp:61
void evict_locked(Clock::time_point now)
void save(const std::string &id, const SessionData &data, std::chrono::seconds ttl) override
Creates or replaces the session; it expires after ttl without use.
std::optional< SessionData > load(const std::string &id) override
The session's data, or std::nullopt if it does not exist or expired.
Loads or creates the session for each request (req.session, req.session_id) and saves it when the res...
Definition SessionManager.hpp:130
bool operator()(http::HttpRequest &req, std::shared_ptr< http::ResponseWriter > writer)
SessionOptions options_
Definition SessionManager.hpp:144
std::shared_ptr< SessionStore > store_
Definition SessionManager.hpp:143
SessionManager(std::shared_ptr< SessionStore > store, SessionOptions options={})
static std::string generate_session_id()
Where sessions live. Implementations must be thread-safe.
Definition SessionManager.hpp:23
virtual std::optional< SessionData > load(const std::string &id)=0
The session's data, or std::nullopt if it does not exist or expired.
virtual void touch(const std::string &id, std::chrono::seconds ttl)=0
Extends the lifetime of an existing session.
virtual void save(const std::string &id, const SessionData &data, std::chrono::seconds ttl)=0
Creates or replaces the session; it expires after ttl without use.
virtual void destroy(const std::string &id)=0
virtual ~SessionStore()=default
The current request's session (req.session).
Definition SessionManager.hpp:89
SessionData data_
Definition SessionManager.hpp:109
bool destroyed_
Definition SessionManager.hpp:112
std::string previous_id_
Definition SessionManager.hpp:108
void erase(const std::string &key)
std::optional< std::string > get(const std::string &key) const
bool is_new_
Definition SessionManager.hpp:110
bool dirty_
Definition SessionManager.hpp:111
void regenerate()
Issues a new ID and keeps the data; the old ID stops working.
void set(const std::string &key, std::string value)
std::string id_
Definition SessionManager.hpp:107
const std::string & id() const
Definition SessionManager.hpp:91
void destroy()
Deletes the session and expires the cookie.
bool is_new() const
True if this request created the session.
Definition SessionManager.hpp:93
const SessionData & data() const
Definition SessionManager.hpp:98
Definition HttpRequest.hpp:19
auto session(std::shared_ptr< SessionStore > store, SessionOptions options={})
Session middleware over any store, e.g. std::make_shared<MemorySessionStore>().
Definition SessionManager.hpp:148
std::unordered_map< std::string, std::string > SessionData
Key/value data kept for one session.
Definition SessionManager.hpp:18
Represents an incoming HTTP request.
Definition HttpRequest.hpp:54
Definition SessionManager.hpp:53
SessionData data
Definition SessionManager.hpp:54
Clock::time_point expires
Definition SessionManager.hpp:55
Definition SessionManager.hpp:115
std::string same_site
Definition SessionManager.hpp:119
int ttl_seconds
Idle lifetime; refreshed on every request.
Definition SessionManager.hpp:117
std::string cookie_name
Definition SessionManager.hpp:116
bool save_uninitialized
Definition SessionManager.hpp:122
bool secure
Set the Secure attribute (enable behind HTTPS)
Definition SessionManager.hpp:118