QXmpp  Version: 1.6.0
QXmppClient.h
1 // SPDX-FileCopyrightText: 2009 Manjeet Dahiya <manjeetdahiya@gmail.com>
2 //
3 // SPDX-License-Identifier: LGPL-2.1-or-later
4 
5 #ifndef QXMPPCLIENT_H
6 #define QXMPPCLIENT_H
7 
8 #include "QXmppConfiguration.h"
9 #include "QXmppLogger.h"
10 #include "QXmppPresence.h"
11 #include "QXmppSendResult.h"
12 #include "QXmppSendStanzaParams.h"
13 
14 #include <memory>
15 #include <variant>
16 
17 #include <QAbstractSocket>
18 #include <QObject>
19 #include <QSslError>
20 
21 template<typename T>
22 class QXmppTask;
23 
24 class QXmppE2eeExtension;
26 class QXmppClientPrivate;
27 class QXmppPresence;
28 class QXmppMessage;
29 class QXmppIq;
30 class QXmppStream;
31 class QXmppInternalClientExtension;
32 
33 // managers
34 class QXmppDiscoveryIq;
35 class QXmppRosterManager;
36 class QXmppVCardManager;
38 
46 
54 
83 class QXMPP_EXPORT QXmppClient : public QXmppLoggable
84 {
85  Q_OBJECT
86 
88  Q_PROPERTY(QXmppLogger *logger READ logger WRITE setLogger NOTIFY loggerChanged)
90  Q_PROPERTY(State state READ state NOTIFY stateChanged)
91 
92 public:
93  using IqResult = std::variant<QDomElement, QXmppError>;
94  using EmptyResult = std::variant<QXmpp::Success, QXmppError>;
95 
98  enum Error {
103  };
104  Q_ENUM(Error)
105 
106 
107  enum State {
110  ConnectedState
111  };
112  Q_ENUM(State)
113 
114 
121  ResumedStream
122  };
123 
131  };
132 
133  QXmppClient(InitialExtensions, QObject *parent = nullptr);
134  QXmppClient(QObject *parent = nullptr);
135  ~QXmppClient() override;
136 
137  bool addExtension(QXmppClientExtension *extension);
138  template<typename T, typename... Args>
139  T *addNewExtension(Args... args)
140  {
141  // it's impossible that addExtension() returns false: ext is a new object
142  auto *ext = new T(args...);
143  addExtension(ext);
144  return ext;
145  }
146  bool insertExtension(int index, QXmppClientExtension *extension);
147  bool removeExtension(QXmppClientExtension *extension);
148  QXmppE2eeExtension *encryptionExtension() const;
149  void setEncryptionExtension(QXmppE2eeExtension *);
150 
151  QList<QXmppClientExtension *> extensions();
152 
166  template<typename T>
168  {
169  const QList<QXmppClientExtension *> list = extensions();
170  for (auto ext : list) {
171  T *extension = qobject_cast<T *>(ext);
172  if (extension) {
173  return extension;
174  }
175  }
176  return nullptr;
177  }
178 
194  template<typename T>
196  {
197  auto list = extensions();
198  for (int i = 0; i < list.size(); ++i) {
199  if (qobject_cast<T *>(list.at(i)) != nullptr) {
200  return i;
201  }
202  }
203  return -1;
204  }
205 
206  bool isAuthenticated() const;
207  bool isConnected() const;
208 
209  bool isActive() const;
210  void setActive(bool active);
211 
212  StreamManagementState streamManagementState() const;
213 
214  QXmppPresence clientPresence() const;
215  void setClientPresence(const QXmppPresence &presence);
216 
217  QXmppConfiguration &configuration();
218 
219  // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
221  QXmppLogger *logger() const;
222  void setLogger(QXmppLogger *logger);
223 
224  QAbstractSocket::SocketError socketError();
225  QString socketErrorString() const;
226 
227  // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
229  State state() const;
230  QXmppStanza::Error::Condition xmppStreamError();
231 
232  QXmppTask<QXmpp::SendResult> sendSensitive(QXmppStanza &&, const std::optional<QXmppSendStanzaParams> & = {});
233  QXmppTask<QXmpp::SendResult> send(QXmppStanza &&, const std::optional<QXmppSendStanzaParams> & = {});
234  QXmppTask<QXmpp::SendResult> reply(QXmppStanza &&stanza, const std::optional<QXmppE2eeMetadata> &e2eeMetadata, const std::optional<QXmppSendStanzaParams> & = {});
235  QXmppTask<IqResult> sendIq(QXmppIq &&, const std::optional<QXmppSendStanzaParams> & = {});
236  QXmppTask<IqResult> sendSensitiveIq(QXmppIq &&, const std::optional<QXmppSendStanzaParams> & = {});
237  QXmppTask<EmptyResult> sendGenericIq(QXmppIq &&, const std::optional<QXmppSendStanzaParams> & = {});
238 
239 #if QXMPP_DEPRECATED_SINCE(1, 1)
240  QT_DEPRECATED_X("Use QXmppClient::findExtension<QXmppRosterManager>() instead")
241  QXmppRosterManager &rosterManager();
242 
243  QT_DEPRECATED_X("Use QXmppClient::findExtension<QXmppVCardManager>() instead")
244  QXmppVCardManager &vCardManager();
245 
246  QT_DEPRECATED_X("Use QXmppClient::findExtension<QXmppVersionManager>() instead")
247  QXmppVersionManager &versionManager();
248 #endif
249 
250 Q_SIGNALS:
251 
272  void connected();
273 
275  void disconnected();
276 
282  void error(QXmppClient::Error);
283 
285  void loggerChanged(QXmppLogger *logger);
286 
291  void messageReceived(const QXmppMessage &message);
292 
297  void presenceReceived(const QXmppPresence &presence);
298 
305  void iqReceived(const QXmppIq &iq);
306 
309  void sslErrors(const QList<QSslError> &errors);
310 
312  void stateChanged(QXmppClient::State state);
313 
314 public Q_SLOTS:
315  void connectToServer(const QXmppConfiguration &,
316  const QXmppPresence &initialPresence =
317  QXmppPresence());
318  void connectToServer(const QString &jid,
319  const QString &password);
320  void disconnectFromServer();
321  bool sendPacket(const QXmppNonza &);
322  void sendMessage(const QString &bareJid, const QString &message);
323 
324 private:
325  void injectIq(const QDomElement &element, const std::optional<QXmppE2eeMetadata> &e2eeMetadata);
326  bool injectMessage(QXmppMessage &&message);
327 
328 private Q_SLOTS:
329  void _q_elementReceived(const QDomElement &element, bool &handled);
330  void _q_reconnect();
331  void _q_socketStateChanged(QAbstractSocket::SocketState state);
332  void _q_streamConnected();
333  void _q_streamDisconnected();
334  void _q_streamError(QXmppClient::Error error);
335 
336 private:
337  const std::unique_ptr<QXmppClientPrivate> d;
338 
339  friend class QXmppClientExtension;
340  friend class QXmppInternalClientExtension;
341  friend class TestClient;
342 };
343 
344 #endif // QXMPPCLIENT_H
The QXmppVersionManager class makes it possible to request for the software version of an entity as d...
Definition: QXmppVersionManager.h:23
InitialExtensions
Definition: QXmppClient.h:126
The QXmppConfiguration class holds configuration options.
Definition: QXmppConfiguration.h:28
Error due to no response to a keep alive.
Definition: QXmppClient.h:101
The QXmppVCardManager class gets/sets XMPP vCards. It is an implementation of XEP-0054: vcard-temp...
Definition: QXmppVCardManager.h:37
Stream Management is not used.
Definition: QXmppClient.h:117
Disconnected from the server.
Definition: QXmppClient.h:108
Definition: QXmppE2eeExtension.h:22
int indexOfExtension()
Returns the index of an extension.
Definition: QXmppClient.h:195
Creates a client with the default set of extensions.
Definition: QXmppClient.h:130
Trying to connect to the server.
Definition: QXmppClient.h:109
The QXmppStanza class is the base class for all XMPP stanzas.
Definition: QXmppStanza.h:87
Definition: QXmppError.h:17
std::variant< QDomElement, QXmppError > IqResult
Definition: QXmppClient.h:93
No error.
Definition: QXmppClient.h:99
The QXmppLoggable class represents a source of logging messages.
Definition: QXmppLogger.h:104
Definition: QXmppStream.h:20
Error
Definition: QXmppClient.h:98
Definition: QXmppDiscoveryIq.h:17
Stream Management is used and the previous stream has not been resumed.
Definition: QXmppClient.h:119
Error due to XML stream.
Definition: QXmppClient.h:102
The QXmppRosterManager class provides access to a connected client&#39;s roster.
Definition: QXmppRosterManager.h:55
The QXmppLogger class represents a sink for logging messages.
Definition: QXmppLogger.h:26
StreamManagementState
Describes the use of XEP-0198: Stream Management.
Definition: QXmppClient.h:115
The QXmppStream class is the base class for all XMPP streams.
Definition: QXmppStream.h:35
The QXmppPresence class represents an XMPP presence stanza.
Definition: QXmppPresence.h:20
Condition
A detailed condition of the error.
Definition: QXmppStanza.h:110
The QXmppIq class is the base class for all IQs.
Definition: QXmppIq.h:22
Creates a client without any extensions.
Definition: QXmppClient.h:128
Definition: QXmppNonza.h:13
The QXmppMessage class represents an XMPP message.
Definition: QXmppMessage.h:37
T * findExtension()
Returns the extension which can be cast into type T*, or 0 if there is no such extension.
Definition: QXmppClient.h:167
State
This enumeration describes a client state.
Definition: QXmppClient.h:107
The QXmppClientExtension class is the base class for QXmppClient extensions.
Definition: QXmppClientExtension.h:32
T * addNewExtension(Args... args)
Definition: QXmppClient.h:139
Error due to TCP socket.
Definition: QXmppClient.h:100
std::variant< QXmpp::Success, QXmppError > EmptyResult
Definition: QXmppClient.h:94
The QXmppClient class is the main class for using QXmpp.
Definition: QXmppClient.h:83