start moving client-specific code

1 files changed, 293 insertions, 0 deletions

diff --git a/src/client/QXmppTransferManager.h b/src/client/QXmppTransferManager.h
new file mode 100644
index 00000000..900d2163
--- /dev/null
+++ b/src/client/QXmppTransferManager.h
@@ -0,0 +1,293 @@
+/*
+ * Copyright (C) 2008-2011 The QXmpp developers
+ *
+ * Author:
+ *  Jeremy Lainé
+ *
+ * Source:
+ *  http://code.google.com/p/qxmpp
+ *
+ * This file is a part of QXmpp library.
+ *
+ * This library 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 2.1 of the License, or (at your option) any later version.
+ *
+ * This library 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.
+ *
+ */
+
+#ifndef QXMPPTRANSFERMANAGER_H
+#define QXMPPTRANSFERMANAGER_H
+
+#include <QDateTime>
+#include <QUrl>
+#include <QVariant>
+
+#include "QXmppClientExtension.h"
+#include "QXmppIq.h"
+#include "QXmppByteStreamIq.h"
+
+class QTcpSocket;
+class QXmppByteStreamIq;
+class QXmppIbbCloseIq;
+class QXmppIbbDataIq;
+class QXmppIbbOpenIq;
+class QXmppSocksClient;
+class QXmppSocksServer;
+class QXmppStreamInitiationIq;
+class QXmppTransferJobPrivate;
+
+class QXmppTransferFileInfo
+{
+public:
+    QXmppTransferFileInfo();
+
+    QDateTime date() const;
+    void setDate(const QDateTime &date);
+
+    QByteArray hash() const;
+    void setHash(const QByteArray &hash);
+
+    QString name() const;
+    void setName(const QString &name);
+
+    qint64 size() const;
+    void setSize(qint64 size);
+
+    bool operator==(const QXmppTransferFileInfo &other) const;
+
+private:
+    QDateTime m_date;
+    QByteArray m_hash;
+    QString m_name;
+    qint64 m_size;
+};
+
+/// \brief The QXmppTransferJob class represents a single file transfer job.
+///
+/// \sa QXmppTransferManager
+///
+
+class QXmppTransferJob : public QXmppLoggable
+{
+    Q_OBJECT
+    Q_ENUMS(Direction Error State)
+    Q_FLAGS(Method Methods)
+    Q_PROPERTY(Direction direction READ direction CONSTANT)
+    Q_PROPERTY(QUrl localFileUrl READ localFileUrl WRITE setLocalFileUrl NOTIFY localFileUrlChanged)
+    Q_PROPERTY(QString jid READ jid CONSTANT)
+    Q_PROPERTY(Method method READ method CONSTANT)
+    Q_PROPERTY(State state READ state NOTIFY stateChanged)
+
+    Q_PROPERTY(QString fileName READ fileName CONSTANT)
+    Q_PROPERTY(qint64 fileSize READ fileSize CONSTANT)
+
+public:
+    /// This enum is used to describe the direction of a transfer job.
+    enum Direction
+    {
+        IncomingDirection, ///< The file is being received.
+        OutgoingDirection, ///< The file is being sent.
+    };
+
+    /// This enum is used to describe the type of error encountered by a transfer job.
+    enum Error
+    {
+        NoError = 0,      ///< No error occurred.
+        AbortError,       ///< The file transfer was aborted.
+        FileAccessError,  ///< An error was encountered trying to access a local file.
+        FileCorruptError, ///< The file is corrupt: the file size or hash do not match.
+        ProtocolError,    ///< An error was encountered in the file transfer protocol.
+    };
+
+    /// This enum is used to describe a transfer method.
+    enum Method
+    {
+        NoMethod = 0,     ///< No transfer method.
+        InBandMethod = 1, ///< XEP-0047: In-Band Bytestreams
+        SocksMethod = 2,  ///< XEP-0065: SOCKS5 Bytestreams
+        AnyMethod = 3,    ///< Any supported transfer method.
+    };
+    Q_DECLARE_FLAGS(Methods, Method)
+
+    /// This enum is used to describe the state of a transfer job.
+    enum State
+    {
+        OfferState = 0,    ///< The transfer is being offered to the remote party.
+        StartState = 1,    ///< The transfer is being connected.
+        TransferState = 2, ///< The transfer is ongoing.
+        FinishedState = 3, ///< The transfer is finished.
+    };
+
+    ~QXmppTransferJob();
+
+    QXmppTransferJob::Direction direction() const;
+    QXmppTransferJob::Error error() const;
+    QString jid() const;
+    QXmppTransferJob::Method method() const;
+    QString sid() const;
+    qint64 speed() const;
+    QXmppTransferJob::State state() const;
+
+    // XEP-0096 : File transfer
+    QXmppTransferFileInfo fileInfo() const;
+    QUrl localFileUrl() const;
+    void setLocalFileUrl(const QUrl &localFileUrl);
+
+    /// \cond
+    QDateTime fileDate() const;
+    QByteArray fileHash() const;
+    QString fileName() const;
+    qint64 fileSize() const;
+    /// \endcond
+
+signals:
+    /// This signal is emitted when an error is encountered while
+    /// processing the transfer job.
+    void error(QXmppTransferJob::Error error);
+
+    /// This signal is emitted when the transfer job is finished.
+    ///
+    /// You can determine if the job completed successfully by testing whether
+    /// error() returns QXmppTransferJob::NoError.
+    ///
+    /// Note: Do not delete the job in the slot connected to this signal,
+    /// instead use deleteLater().
+    void finished();
+
+    /// This signal is emitted when the local file URL changes.
+    void localFileUrlChanged(const QUrl &localFileUrl);
+
+    /// This signal is emitted to indicate the progress of this transfer job.
+    void progress(qint64 done, qint64 total);
+
+    /// This signal is emitted when the transfer job changes state.
+    void stateChanged(QXmppTransferJob::State state);
+
+public slots:
+    void abort();
+    void accept(const QString &filePath);
+    void accept(QIODevice *output);
+
+private slots:
+    void _q_disconnected();
+    void _q_receiveData();
+    void _q_sendData();
+    void _q_terminated();
+
+private:
+    QXmppTransferJob(const QString &jid, QXmppTransferJob::Direction direction, QObject *parent);
+    void checkData();
+    void setState(QXmppTransferJob::State state);
+    void terminate(QXmppTransferJob::Error error);
+    bool writeData(const QByteArray &data);
+
+    QXmppTransferJobPrivate *const d;
+    friend class QXmppTransferManager;
+};
+
+/// \brief The QXmppTransferManager class provides support for sending and
+/// receiving files.
+///
+/// Stream initiation is performed as described in XEP-0095: Stream Initiation
+/// and XEP-0096: SI File Transfer. The actual file transfer is then performed
+/// using either XEP-0065: SOCKS5 Bytestreams or XEP-0047: In-Band Bytestreams.
+///
+/// To make use of this manager, you need to instantiate it and load it into
+/// the QXmppClient instance as follows:
+///
+/// \code
+/// QXmppTransferManager *manager = new QXmppTransferManager;
+/// client->addExtension(manager);
+/// \endcode
+///
+/// \ingroup Managers
+
+class QXmppTransferManager : public QXmppClientExtension
+{
+    Q_OBJECT
+    Q_PROPERTY(QString proxy READ proxy WRITE setProxy)
+    Q_PROPERTY(bool proxyOnly READ proxyOnly WRITE setProxyOnly)
+    Q_PROPERTY(QXmppTransferJob::Methods supportedMethods READ supportedMethods WRITE setSupportedMethods)
+
+public:
+    QXmppTransferManager();
+
+    QString proxy() const;
+    void setProxy(const QString &proxyJid);
+
+    bool proxyOnly() const;
+    void setProxyOnly(bool proxyOnly);
+
+    QXmppTransferJob::Methods supportedMethods() const;
+    void setSupportedMethods(QXmppTransferJob::Methods methods);
+
+    /// \cond
+    QStringList discoveryFeatures() const;
+    bool handleStanza(const QDomElement &element);
+    /// \endcond
+
+signals:
+    /// This signal is emitted when a new file transfer offer is received.
+    ///
+    /// To accept the transfer job, call the job's QXmppTransferJob::accept() method.
+    /// To refuse the transfer job, call the job's QXmppTransferJob::abort() method.
+    void fileReceived(QXmppTransferJob *job);
+
+    /// This signal is emitted whenever a transfer job is started.
+    void jobStarted(QXmppTransferJob *job);
+
+    /// This signal is emitted whenever a transfer job is finished.
+    ///
+    /// \sa QXmppTransferJob::finished()
+    void jobFinished(QXmppTransferJob *job);
+
+public slots:
+    QXmppTransferJob *sendFile(const QString &jid, const QString &filePath, const QString &sid = QString());
+    QXmppTransferJob *sendFile(const QString &jid, QIODevice *device, const QXmppTransferFileInfo &fileInfo, const QString &sid = QString());
+
+protected:
+    /// \cond
+    void setClient(QXmppClient* client);
+    /// \endcond
+
+private slots:
+    void _q_iqReceived(const QXmppIq&);
+    void _q_jobDestroyed(QObject *object);
+    void _q_jobError(QXmppTransferJob::Error error);
+    void _q_jobFinished();
+    void _q_jobStateChanged(QXmppTransferJob::State state);
+    void _q_socksServerConnected(QTcpSocket *socket, const QString &hostName, quint16 port);
+
+private:
+    QXmppTransferJob *getJobByRequestId(QXmppTransferJob::Direction direction, const QString &jid, const QString &id);
+    QXmppTransferJob *getJobBySid(QXmppTransferJob::Direction, const QString &jid, const QString &sid);
+    void byteStreamIqReceived(const QXmppByteStreamIq&);
+    void byteStreamResponseReceived(const QXmppIq&);
+    void byteStreamResultReceived(const QXmppByteStreamIq&);
+    void byteStreamSetReceived(const QXmppByteStreamIq&);
+    void ibbCloseIqReceived(const QXmppIbbCloseIq&);
+    void ibbDataIqReceived(const QXmppIbbDataIq&);
+    void ibbOpenIqReceived(const QXmppIbbOpenIq&);
+    void ibbResponseReceived(const QXmppIq&);
+    void streamInitiationIqReceived(const QXmppStreamInitiationIq&);
+    void streamInitiationResultReceived(const QXmppStreamInitiationIq&);
+    void streamInitiationSetReceived(const QXmppStreamInitiationIq&);
+    void socksServerSendOffer(QXmppTransferJob *job);
+
+    int m_ibbBlockSize;
+    QList<QXmppTransferJob*> m_jobs;
+    QString m_proxy;
+    bool m_proxyOnly;
+    QXmppSocksServer *m_socksServer;
+    QXmppTransferJob::Methods m_supportedMethods;
+};
+
+Q_DECLARE_OPERATORS_FOR_FLAGS(QXmppTransferJob::Methods)
+
+#endif