src/Streams/SocketFactory.h

   1 /* Copyright (C) 2006 - 2014 Jan Kundrát <jkt@flaska.net>
   2
   3    This file is part of the Trojita Qt IMAP e-mail client,
   4    http://trojita.flaska.net/
   5
   6    This program is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU General Public License as
   8    published by the Free Software Foundation; either version 2 of
   9    the License or (at your option) version 3 or any later version
  10    accepted by the membership of KDE e.V. (or its successor approved
  11    by the membership of KDE e.V.), which shall act as a proxy
  12    defined in Section 14 of version 3 of the license.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #ifndef STREAMS_SOCKETFACTORY_H
  24 #define STREAMS_SOCKETFACTORY_H
  25
  26 #include <QPointer>
  27 #include <QStringList>
  28 #include "Socket.h"
  29
  30 namespace Streams {
  31
  32 /** @short Specify preference for Proxy Settings */
  33 enum class ProxySettings
  34 {
  35     RespectSystemProxy, /**< @short Use System Proxy Settings to connect */
  36     DirectConnect,      /**< @short Connect without using any Proxy Settings */
  37 };
  38
  39 /** @short Abstract interface for creating new socket that is somehow connected
  40  * to the IMAP server */
  41 class SocketFactory: public QObject
  42 {
  43     Q_OBJECT
  44     bool m_startTls;
  45 public:
  46     SocketFactory();
  47     virtual ~SocketFactory() {}
  48     /** @short Create new socket and return a smart pointer to it */
  49     virtual Socket *create() = 0;
  50     virtual void setProxySettings(const Streams::ProxySettings proxySettings, const QString &protocolTag) = 0;
  51     void setStartTlsRequired(const bool doIt);
  52     bool startTlsRequired();
  53 signals:
  54     void error(const QString &);
  55 };
  56
  57 /** @short Manufacture sockets based on QProcess */
  58 class ProcessSocketFactory: public SocketFactory
  59 {
  60     Q_OBJECT
  61     /** @short Name of executable file to launch */
  62     QString executable;
  63     /** @short Arguments to launch the process with */
  64     QStringList args;
  65 public:
  66     ProcessSocketFactory(const QString &executable, const QStringList &args);
  67     virtual Socket *create();
  68     virtual void setProxySettings(const Streams::ProxySettings proxySettings, const QString &protocolTag);
  69 };
  70
  71 /** @short Manufacture sockets based on QSslSocket */
  72 class SslSocketFactory: public SocketFactory
  73 {
  74     Q_OBJECT
  75     /** @short Hostname of the remote host */
  76     QString host;
  77     /** @short Port number */
  78     quint16 port;
  79     /** @short Specify Proxy Settings for connection */
  80     ProxySettings m_proxySettings;
  81     /** @short Protocol for the requested connection */
  82     QString m_protocolTag;
  83 public:
  84     SslSocketFactory(const QString &host, const quint16 port);
  85     virtual void setProxySettings(const Streams::ProxySettings proxySettings, const QString &protocolTag);
  86     virtual Socket *create();
  87 };
  88
  89 /** @short Factory for regular TCP sockets that are able to STARTTLS */
  90 class TlsAbleSocketFactory: public SocketFactory
  91 {
  92     Q_OBJECT
  93     /** @short Hostname of the remote host */
  94     QString host;
  95     /** @short Port number */
  96     quint16 port;
  97     /** @short Specify Proxy Settings for connection */
  98     ProxySettings m_proxySettings;
  99     /** @short Protocol for the requested connection */
 100     QString m_protocolTag;
 101 public:
 102     TlsAbleSocketFactory(const QString &host, const quint16 port);
 103     virtual void setProxySettings(const Streams::ProxySettings proxySettings, const QString &protocolTag);
 104     virtual Socket *create();
 105 };
 106
 107 /** @short A fake factory suitable for unit tests */
 108 class FakeSocketFactory: public SocketFactory
 109 {
 110     Q_OBJECT
 111 public:
 112     explicit FakeSocketFactory(const Imap::ConnectionState initialState);
 113     virtual Socket *create();
 114     /** @short Return the last created socket */
 115     Socket *lastSocket();
 116     void setInitialState(const Imap::ConnectionState initialState);
 117     virtual void setProxySettings(const Streams::ProxySettings proxySettings, const QString &protocolTag);
 118
 119 private:
 120     QPointer<Socket> m_last;
 121     Imap::ConnectionState m_initialState;
 122 };
 123
 124 }
 125
 126 #endif