nymea-app/libnymea-app/usermanager.h

// SPDX-License-Identifier: LGPL-3.0-or-later

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright (C) 2013 - 2024, nymea GmbH
* Copyright (C) 2024 - 2025, chargebyte austria GmbH
*
* This file is part of libnymea-app.
*
* libnymea-app 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 3
* of the License, or (at your option) any later version.
*
* libnymea-app 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 libnymea-app. If not, see <https://www.gnu.org/licenses/>.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#ifndef USERMANAGER_H
#define USERMANAGER_H

#include <QObject>

#include "jsonrpc/jsonrpcclient.h"
#include "engine.h"

#include "types/tokeninfos.h"
#include "types/userinfo.h"

class Users;

class UserManager: public QObject
{
    Q_OBJECT
    Q_PROPERTY(Engine* engine READ engine WRITE setEngine NOTIFY engineChanged)
    Q_PROPERTY(bool loading READ loading NOTIFY loadingChanged)

    Q_PROPERTY(UserInfo* userInfo READ userInfo CONSTANT)
    Q_PROPERTY(TokenInfos* tokenInfos READ tokenInfos CONSTANT)
    Q_PROPERTY(Users* users READ users CONSTANT)

public:
    enum UserError {
        UserErrorNoError,
        UserErrorBackendError,
        UserErrorInvalidUserId,
        UserErrorDuplicateUserId,
        UserErrorBadPassword,
        UserErrorTokenNotFound,
        UserErrorPermissionDenied,
        UserErrorInconsistantScopes
    };
    Q_ENUM(UserError)

    explicit UserManager(QObject *parent = nullptr);
    ~UserManager();

    Engine* engine() const;
    void setEngine(Engine* engine);

    bool loading() const;

    UserInfo* userInfo() const;
    TokenInfos* tokenInfos() const;
    Users *users() const;

    // NOTE: Q_FLAG from another QObject (UserInfo::PermissionScopes) doesn't seem to work in certain Qt versions. Using int instead
    Q_INVOKABLE int createUser(const QString &username, const QString &password, const QString &displayName, const QString &email, int permissionScopes = UserInfo::PermissionScopeAdmin, const QList<QUuid> &allowedThingIds = QList<QUuid>());
    Q_INVOKABLE int changePassword(const QString &newPassword);
    Q_INVOKABLE int removeToken(const QUuid &id);
    Q_INVOKABLE int removeUser(const QString &username);
    // NOTE: Q_FLAG from another QObject (UserInfo::PermissionScopes) doesn't seem to work in certain Qt versions. Using int instead
    Q_INVOKABLE int setUserScopes(const QString &username, int permissionScopes, const QList<QUuid> &allowedThingIds = QList<QUuid>());
    Q_INVOKABLE int setUserInfo(const QString &username, const QString &displayName, const QString &email);

signals:
    void engineChanged();
    void loadingChanged();

    void createUserReply(int id, UserError error);
    void removeTokenReply(int id, UserError error);
    void changePasswordReply(int id, UserError error);
    void removeUserReply(int id, UserError error);
    void setUserScopesReply(int id, UserError error);
    void setUserInfoReply(int id, UserError error);

private slots:
    void notificationReceived(const QVariantMap &data);

    void getUsersResponse(int commandId, const QVariantMap &data);
    void getUserInfoResponse(int commandId, const QVariantMap &data);
    void getTokensResponse(int commandId, const QVariantMap &data);
    void removeTokenResponse(int commandId, const QVariantMap &params);
    void changePasswordResponse(int commandId, const QVariantMap &params);
    void createUserResponse(int commandId, const QVariantMap &params);
    void removeUserResponse(int commandId, const QVariantMap &params);
    void setUserScopesResponse(int commandId, const QVariantMap &params);
    void setUserInfoResponse(int commandId, const QVariantMap &params);

private:
    Engine *m_engine = nullptr;
    bool m_loading = false;

    UserInfo *m_userInfo = nullptr;
    TokenInfos *m_tokenInfos = nullptr;

    Users *m_users = nullptr;

    QHash<int, QUuid> m_tokensToBeRemoved;
};

class Users: public QAbstractListModel {
    Q_OBJECT
    Q_PROPERTY(int count READ rowCount NOTIFY countChanged)

public:
    enum Roles {
        RoleUsername,
        RoleDisplayName,
        RoleEmail,
        RoleScopes,
        RoleAllowedThingIds
    };
    Q_ENUM(Roles)

    explicit Users(QObject *parent = nullptr);

    int rowCount(const QModelIndex &parent = QModelIndex()) const override;
    QVariant data(const QModelIndex &index, int role) const override;
    QHash<int, QByteArray> roleNames() const override;

    void insertUser(UserInfo *userInfo);
    void removeUser(const QString &username);

    Q_INVOKABLE UserInfo *get(int index) const;
    Q_INVOKABLE UserInfo *getUserInfo(const QString &username) const;

signals:
    void countChanged();

private:
    QList<UserInfo *> m_users;
};

#endif // USERMANAGER_H