summary refs log tree commit diff
path: root/include/MatrixClient.h
blob: 0185bf64ed139ac3ee2ba83af96c862543aa5c58 (plain) (blame)
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/*
 * nheko Copyright (C) 2017  Konstantinos Sideris <siderisk@auth.gr>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <QtNetwork/QNetworkAccessManager>

#include "MessageEvent.h"
#include "Profile.h"
#include "RoomMessages.h"
#include "Sync.h"

/*
 * MatrixClient provides the high level API to communicate with
 * a Matrix homeserver. All the responses are returned through signals.
 */
class MatrixClient : public QNetworkAccessManager
{
        Q_OBJECT
public:
        MatrixClient(QString server, QObject *parent = 0);

        // Client API.
        void initialSync() noexcept;
        void sync() noexcept;
        void sendRoomMessage(matrix::events::MessageEventType ty,
                             const QString &roomid,
                             const QString &msg,
                             const QString &url = "") noexcept;
        void login(const QString &username, const QString &password) noexcept;
        void registerUser(const QString &username,
                          const QString &password,
                          const QString &server) noexcept;
        void versions() noexcept;
        void fetchRoomAvatar(const QString &roomid, const QUrl &avatar_url);
        void fetchUserAvatar(const QString &userId, const QUrl &avatarUrl);
        void fetchOwnAvatar(const QUrl &avatar_url);
        void downloadImage(const QString &event_id, const QUrl &url);
        void messages(const QString &room_id, const QString &from_token, int limit = 30) noexcept;
        void uploadImage(const QString &roomid, const QString &filename);
        void joinRoom(const QString &roomIdOrAlias);
        void leaveRoom(const QString &roomId);

        inline QUrl getHomeServer();
        inline int transactionId();
        inline void incrementTransactionId();

        void reset() noexcept;

public slots:
        void getOwnProfile() noexcept;
        void logout() noexcept;

        inline void setServer(const QString &server);
        inline void setAccessToken(const QString &token);
        inline void setNextBatchToken(const QString &next_batch);

signals:
        void loginError(const QString &error);
        void registerError(const QString &error);
        void versionError(const QString &error);

        void loggedOut();

        void loginSuccess(const QString &userid, const QString &homeserver, const QString &token);
        void registerSuccess(const QString &userid,
                             const QString &homeserver,
                             const QString &token);
        void versionSuccess();
        void imageUploaded(const QString &roomid, const QString &filename, const QString &url);

        void roomAvatarRetrieved(const QString &roomid, const QPixmap &img);
        void userAvatarRetrieved(const QString &userId, const QImage &img);
        void ownAvatarRetrieved(const QPixmap &img);
        void imageDownloaded(const QString &event_id, const QPixmap &img);

        // Returned profile data for the user's account.
        void getOwnProfileResponse(const QUrl &avatar_url, const QString &display_name);
        void initialSyncCompleted(const SyncResponse &response);
        void initialSyncFailed(const QString &msg);
        void syncCompleted(const SyncResponse &response);
        void syncFailed(const QString &msg);
        void joinFailed(const QString &msg);
        void messageSent(const QString &event_id, const QString &roomid, const int txn_id);
        void emoteSent(const QString &event_id, const QString &roomid, const int txn_id);
        void messagesRetrieved(const QString &room_id, const RoomMessages &msgs);
        void joinedRoom(const QString &room_id);
        void leftRoom(const QString &room_id);

private slots:
        void onResponse(QNetworkReply *reply);

private:
        enum class Endpoint
        {
                GetOwnAvatar,
                GetOwnProfile,
                GetProfile,
                Image,
                InitialSync,
                ImageUpload,
                Login,
                Logout,
                Messages,
                Register,
                RoomAvatar,
                SendRoomMessage,
                Sync,
                UserAvatar,
                Versions,
                JoinRoom,
                LeaveRoom,
        };

        // Response handlers.
        void onGetOwnAvatarResponse(QNetworkReply *reply);
        void onGetOwnProfileResponse(QNetworkReply *reply);
        void onImageResponse(QNetworkReply *reply);
        void onInitialSyncResponse(QNetworkReply *reply);
        void onImageUploadResponse(QNetworkReply *reply);
        void onLoginResponse(QNetworkReply *reply);
        void onLogoutResponse(QNetworkReply *reply);
        void onMessagesResponse(QNetworkReply *reply);
        void onRegisterResponse(QNetworkReply *reply);
        void onRoomAvatarResponse(QNetworkReply *reply);
        void onSendRoomMessage(QNetworkReply *reply);
        void onSyncResponse(QNetworkReply *reply);
        void onUserAvatarResponse(QNetworkReply *reply);
        void onVersionsResponse(QNetworkReply *reply);
        void onJoinRoomResponse(QNetworkReply *reply);
        void onLeaveRoomResponse(QNetworkReply *reply);

        // Client API prefix.
        QString clientApiUrl_;

        // Media API prefix.
        QString mediaApiUrl_;

        // The Matrix server used for communication.
        QUrl server_;

        // The access token used for authentication.
        QString token_;

        // Increasing transaction ID.
        int txn_id_;

        // Token to be used for the next sync.
        QString next_batch_;
};

inline QUrl
MatrixClient::getHomeServer()
{
        return server_;
}

inline int
MatrixClient::transactionId()
{
        return txn_id_;
}

inline void
MatrixClient::setServer(const QString &server)
{
        server_ = QUrl(QString("https://%1").arg(server));
}

inline void
MatrixClient::setAccessToken(const QString &token)
{
        token_ = token;
}

inline void
MatrixClient::setNextBatchToken(const QString &next_batch)
{
        next_batch_ = next_batch;
}

inline void
MatrixClient::incrementTransactionId()
{
        txn_id_ += 1;
}