#include <session.h>

Inheritance diagram for Cutelyst::Session:

Public Member Functions
	Session (Application *parent)

void	setStorage (SessionStore *store)

virtual bool	setup (Application *app) final

SessionStore *	storage () const

Public Member Functions inherited from Cutelyst::Plugin
	Plugin (Application *parent)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const

bool	disconnect (const QObject receiver, const char method) const

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const

bool	inherits (const char *className) const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const

bool	isWindowType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

QString	objectName () const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

QVariant	property (const char *name) const

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval, Qt::TimerType timerType)

QThread *	thread () const

Static Public Member Functions
static void	changeExpires (Context *c, quint64 expires)

static QString	deleteReason (Context *c)

static void	deleteSession (Context *c, const QString &reason=QString())

static void	deleteValue (Context *c, const QString &key)

static void	deleteValues (Context *c, const QStringList &keys)

static quint64	expires (Context *c)

static QString	id (Context *c)

static bool	isValid (Context *c)

static void	setValue (Context *c, const QString &key, const QVariant &value)

static QVariant	value (Context *c, const QString &key, const QVariant &defaultValue=QVariant())

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Additional Inherited Members
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Properties inherited from QObject
	objectName

Detailed Description

Plugin providing methods for session management.

Configuration file options

There are some options you can set in your application configuration file in the Cutelyst_Session_Plugin section.

expires

Integer value, default: 7200

Expiration duration of the session in seconds.

verify_address

Boolean value, default: false

If enabled, the plugin will check if the IP address of the requesting user matches the address stored in the session data. In case of a mismatch, the session will be deleted.

verify_user_agent

Boolean value, default: false

If true, the plugin will check if the user agent of the requesting user matches the user agent stored in the session data. In case of a mismatch, the session will be deleted.

cookie_http_only

Boolean value, default: true

If true, the session cookie will have the httpOnly flag set so that the cookie is not accessible to JavaScript's Document.cookie API.

cookie_secure

Boolean value, default: false

If true, the session cookie will have the secure flag set so that the cookie is only sent to the server with an encrypted request over the HTTPS protocol.

Definition at line 105 of file session.h.

Constructor & Destructor Documentation

Session::Session ( Cutelyst::Application * parent )

Constructs a new session object with the given parent.

Definition at line 48 of file session.cpp.

Member Function Documentation

void Session::changeExpires	(	Context *	c,
		quint64	expires
	)

static

change the session expiration time for this session

Note that this only works to set the session longer than the config setting.

Definition at line 138 of file session.cpp.

References QDateTime::currentMSecsSinceEpoch(), and id().

QString Session::deleteReason ( Context * c )

static

This method contains a string with the reason a session was deleted. Possible values include:

session expired
address mismatch
user agent mismatch

Definition at line 160 of file session.cpp.

References Cutelyst::Context::stash().

void Session::deleteSession	(	Context *	c,
		const QString &	reason = `QString()`
	)

static

This method is used to invalidate a session. It takes an optional parameter which will be saved in deleteReason if provided.

NOTE: This method will also delete your flash data.

Definition at line 151 of file session.cpp.

void Session::deleteValue	(	Context *	c,
		const QString &	key
	)

static

Removes the session key.

Definition at line 203 of file session.cpp.

References QVariant::isNull(), Cutelyst::Context::setStash(), Cutelyst::Context::stash(), and QVariant::toHash().

void Session::deleteValues	(	Context *	c,
		const QStringList &	keys
	)

static

Removes all session keys.

Definition at line 226 of file session.cpp.

References QVariant::isNull(), Cutelyst::Context::setStash(), Cutelyst::Context::stash(), and QVariant::toHash().

Referenced by Cutelyst::StatusMessage::load(), and Cutelyst::AuthenticationRealm::removePersistedUser().

quint64 Session::expires ( Context * c )

static

This method returns the time when the current session will expire, or 0 if there is no current session. If there is a session and it already expired, it will delete the session and return 0 as well.

Definition at line 118 of file session.cpp.

References QVariant::isNull(), Cutelyst::Context::stash(), QVariant::toLongLong(), and QVariant::toULongLong().

QString Session::id ( Cutelyst::Context * c )

static

Returns the current session id or null if there is no current session

Definition at line 100 of file session.cpp.

References QVariant::isNull(), Cutelyst::Context::stash(), and QVariant::toString().

Referenced by changeExpires().

bool Session::isValid ( Cutelyst::Context * c )

static

Returns true if the session is valid.

Definition at line 251 of file session.cpp.