session.h

/*
 * SPDX-FileCopyrightText: (C) 2013-2022 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef CSESSION_H
#define CSESSION_H
 
#include <Cutelyst/Plugins/session_export.h>
#include <Cutelyst/plugin.h>
 
#include <QVariant>
 
namespace Cutelyst {
 
class Context;
class CUTELYST_PLUGIN_SESSION_EXPORT SessionStore : public QObject
{
    Q_OBJECT
public:
    explicit SessionStore(QObject *parent = nullptr);
 
    virtual QVariant getSessionData(Context *c,
                                    const QByteArray &sid,
                                    const QString &key,
                                    const QVariant &defaultValue = QVariant()) = 0;
 
    virtual bool storeSessionData(Context *c,
                                  const QByteArray &sid,
                                  const QString &key,
                                  const QVariant &value) = 0;
 
    virtual bool deleteSessionData(Context *c, const QByteArray &sid, const QString &key) = 0;
 
    virtual bool deleteExpiredSessions(Context *c, quint64 expires) = 0;
};
 
class SessionPrivate;
class CUTELYST_PLUGIN_SESSION_EXPORT Session : public Plugin
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(Session)
public:
    Session(Application *parent);
 
    Session(Application *parent, const QVariantMap &defaultConfig);
 
    virtual ~Session();
 
    virtual bool setup(Application *app) final;
 
    void setStorage(std::unique_ptr<SessionStore> store);
 
    SessionStore *storage() const;
 
    static QByteArray id(Context *c);
 
    static quint64 expires(Context *c);
 
    static void changeExpires(Context *c, quint64 expires);
 
    static void deleteSession(Context *c, const QString &reason = QString());
 
    static QString deleteReason(Context *c);
 
    static QVariant
        value(Context *c, const QString &key, const QVariant &defaultValue = QVariant());
 
    static void setValue(Context *c, const QString &key, const QVariant &value);
 
    static void deleteValue(Context *c, const QString &key);
 
    static void deleteValues(Context *c, const QStringList &keys);
 
    static bool isValid(Context *c);
 
protected:
    SessionPrivate *d_ptr;
 
private:
    Q_PRIVATE_SLOT(d_func(), void _q_saveSession(Context *))
};
 
} // namespace Cutelyst
 
#endif // CSESSION_H