session.h

/*
 * Copyright (C) 2013-2017 Daniel Nicoletti <dantti12@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef CSESSION_H
#define CSESSION_H

#include <QVariant>

#include <Cutelyst/plugin.h>
#include <Cutelyst/cutelyst_global.h>

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 QString &sid, const QString &key, const QVariant &defaultValue = QVariant()) = 0;

    virtual bool storeSessionData(Context *c, const QString &sid, const QString &key, const QVariant &value) = 0;

    virtual bool deleteSessionData(Context *c, const QString &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);
    virtual ~Session();

    virtual bool setup(Application *app) final;

    void setStorage(SessionStore *store);

    SessionStore *storage() const;

    static QString 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*))
};

}

#endif // CSESSION_H