File: admin.h

package info (click to toggle)
libquotient 0.9.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,588 kB
  • sloc: xml: 39,103; cpp: 25,226; sh: 97; makefile: 10
file content (103 lines) | stat: -rw-r--r-- 3,186 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
// THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN

#pragma once

#include <Quotient/jobs/basejob.h>

namespace Quotient {

//! \brief Gets information about a particular user.
//!
//! Gets information about a particular user.
//!
//! This API may be restricted to only be called by the user being looked
//! up, or by a server admin. Server-local administrator privileges are not
//! specified in this document.
class QUOTIENT_API GetWhoIsJob : public BaseJob {
public:
    // Inner data structures

    struct QUOTIENT_API ConnectionInfo {
        //! Most recently seen IP address of the session.
        QString ip{};

        //! Unix timestamp that the session was last active.
        std::optional<qint64> lastSeen{};

        //! User agent string last seen in the session.
        QString userAgent{};
    };

    struct QUOTIENT_API SessionInfo {
        //! Information particular connections in the session.
        QVector<ConnectionInfo> connections{};
    };

    struct QUOTIENT_API DeviceInfo {
        //! A user's sessions (i.e. what they did with an access token from one login).
        QVector<SessionInfo> sessions{};
    };

    // Construction/destruction

    //! \param userId
    //!   The user to look up.
    explicit GetWhoIsJob(const QString& userId);

    //! \brief Construct a URL without creating a full-fledged job object
    //!
    //! This function can be used when a URL for GetWhoIsJob
    //! is necessary but the job itself isn't.
    static QUrl makeRequestUrl(const HomeserverData& hsData, const QString& userId);

    // Result properties

    //! The Matrix user ID of the user.
    QString userId() const { return loadFromJson<QString>("user_id"_L1); }

    //! Each key is an identifier for one of the user's devices.
    QHash<QString, DeviceInfo> devices() const
    {
        return loadFromJson<QHash<QString, DeviceInfo>>("devices"_L1);
    }

    struct Response {
        //! The Matrix user ID of the user.
        QString userId{};

        //! Each key is an identifier for one of the user's devices.
        QHash<QString, DeviceInfo> devices{};
    };
};

template <std::derived_from<GetWhoIsJob> JobT>
constexpr inline auto doCollectResponse<JobT> =
    [](JobT* j) -> GetWhoIsJob::Response { return { j->userId(), j->devices() }; };

template <>
struct QUOTIENT_API JsonObjectConverter<GetWhoIsJob::ConnectionInfo> {
    static void fillFrom(const QJsonObject& jo, GetWhoIsJob::ConnectionInfo& result)
    {
        fillFromJson(jo.value("ip"_L1), result.ip);
        fillFromJson(jo.value("last_seen"_L1), result.lastSeen);
        fillFromJson(jo.value("user_agent"_L1), result.userAgent);
    }
};

template <>
struct QUOTIENT_API JsonObjectConverter<GetWhoIsJob::SessionInfo> {
    static void fillFrom(const QJsonObject& jo, GetWhoIsJob::SessionInfo& result)
    {
        fillFromJson(jo.value("connections"_L1), result.connections);
    }
};

template <>
struct QUOTIENT_API JsonObjectConverter<GetWhoIsJob::DeviceInfo> {
    static void fillFrom(const QJsonObject& jo, GetWhoIsJob::DeviceInfo& result)
    {
        fillFromJson(jo.value("sessions"_L1), result.sessions);
    }
};

} // namespace Quotient