mythsession.h

Go to the documentation of this file.

#ifndef MYTHSESSION_H
#define MYTHSESSION_H
 
#include "mythbaseexp.h"
 
#include <cstdint>
 
#include <QString>
#include <QDateTime>
#include <QMap>
#include <QMutex>
 
enum DigestUserActions : std::uint8_t {
    DIGEST_USER_ADD,
    DIGEST_USER_REMOVE,
    DIGEST_USER_CHANGE_PW
};
 
class MBASE_PUBLIC MythUserSession
{
  public :
    MythUserSession() = default;
   ~MythUserSession() { m_sessionToken.fill('0'); m_sessionToken.clear(); }
   MythUserSession(const MythUserSession &) = default;
   MythUserSession(MythUserSession&& other) = default;
   MythUserSession &operator=(const MythUserSession &) = default;
   MythUserSession& operator=(MythUserSession&& other) = default;
 
    bool IsValid(void) const;
 
    QString GetUserName(void) const { return m_name; }
    uint  GetUserId(void) const { return m_userId; }
 
    QString GetSessionToken(void) const { return m_sessionToken; }
    QString GetSessionClient(void) const { return m_sessionClient; }
 
    QDateTime GetSessionCreated() const { return m_sessionCreated; }
    QDateTime GetSessionLastActive() const { return m_sessionLastActive; }
    QDateTime GetSessionExpires() const { return m_sessionExpires; }
 
    bool CheckPermission( const QString &context, uint permission);
 
  protected:
    bool Save(void);
 
    bool Update(void);
 
    uint    m_userId {0};
    QString m_name;
 
    QString m_sessionToken;
    QDateTime m_sessionCreated;
    QDateTime m_sessionLastActive; // For informational purposes
    QDateTime m_sessionExpires;
    QString m_sessionClient;
 
    QMap<QString, uint> m_permissionsList; // Context, flags
 
  friend class MythSessionManager;
};
 
class MBASE_PUBLIC MythSessionManager
{
  public :
    MythSessionManager();
 
    static bool IsValidUser(const QString &username);
 
    bool IsValidSession(const QString &sessionToken);
 
    MythUserSession GetSession(const QString &sessionToken);
 
    static QString GetPasswordDigest(const QString &username);
 
    MythUserSession LoginUser(const QString &username,
                              const QByteArray &digest,
                              const QString &client = "");
 
    MythUserSession LoginUser(const QString &username,
                              const QString &password,
                              const QString &client = "");
 
    static QByteArray CreateDigest(const QString &username,
                                   const QString &password);
 
    bool ManageDigestUser(DigestUserActions action,
                                 const QString    &username,
                                 const QString    &password,
                                 const QString    &newPassword);
    static void LockSessions();
    static void UnlockSessions();
 
  private:
    void LoadSessions(void);
 
    void UpdateSession(const QString &sessionToken);
 
    MythUserSession GetSession(const QString &username, const QString &client);
 
    MythUserSession CreateUserSession(uint userId, const QString &username,
                                      const QString &client);
 
    void DestroyUserSession(const QString &sessionToken);
 
    void DestroyUserAllSessions(const QString &username);
 
    static bool AddDigestUser(const QString &username,
                              const QString &password);
 
    bool RemoveDigestUser(const QString &username);
 
    bool ChangeDigestUserPassword(const QString &username,
                                         const QString &oldPassword,
                                         const QString &newPassword);
 
    QMap<QString, MythUserSession> m_sessionList;
 
    static QMutex mutex;
};
 
#endif // MYTHSESSION_H