File indexing completed on 2024-10-06 10:50:31

 /*
     SPDX-FileCopyrightText: 2010 Omat Holding B.V. <info@omat.nl>
     SPDX-FileCopyrightText: 2014 Sandro Knauß <knauss@kolabsys.com>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 // This code was taken from kmail-account-wizard
 
 #pragma once
 
 #include <QObject>
 
 #include <KIO/Job>
 #include <KMime/HeaderParsing>
 #include <QUrl>
 
 class QDomElement;
 class QDomDocument;
 
 struct Server;
 struct identity;
 
 /**
   This class will search in Mozilla's database for an xml file
   describing the isp data belonging to that address. This class
   searches and wraps the result for further usage. References:
     https://wiki.mozilla.org/Thunderbird:Autoconfiguration
     https://developer.mozilla.org/en/Thunderbird/Autoconfiguration
     https://ispdb.mozillamessaging.com/
 */
 class Ispdb : public QObject
 {
     Q_OBJECT
 public:
     enum socketType { None = 0, SSL, StartTLS };
 
     /**
      Ispdb uses custom authtyps, hence the enum here.
      @see https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat
      In particular, note that Ispdb's Plain represents both Cleartext and AUTH Plain
      We will always treat it as Cleartext
      */
     enum authType { Plain = 0, CramMD5, NTLM, GSSAPI, ClientIP, NoAuth, Basic, OAuth2 };
     enum length { Long = 0, Short };
 
     /** Constructor */
     explicit Ispdb(QObject *parent = nullptr);
 
     /** Destructor */
     ~Ispdb() override;
 
     /** After finished() has been emitted you can
         retrieve the domains that are covered by these
         settings */
     QStringList relevantDomains() const;
 
     /** After finished() has been emitted you can
         get the name of the provider, you can get a long
         name and a short one */
     QString name(length) const;
 
     /** After finished() has been emitted you can
         get a list of imap servers available for this provider */
     QVector<Server> imapServers() const;
 
     /** After finished() has been emitted you can
         get a list of pop3 servers available for this provider */
     QVector<Server> pop3Servers() const;
 
     /** After finished() has been emitted you can
         get a list of smtp servers available for this provider */
     QVector<Server> smtpServers() const;
 
     QVector<identity> identities() const;
 
     int defaultIdentity() const;
 public Q_SLOTS:
     /** Sets the emailaddress you want to servers for */
     void setEmail(const QString &);
 
     /** Sets the password for login */
     void setPassword(const QString &);
     /** Starts looking up the servers which belong to the e-mailaddress */
     void start();
 
 private:
     void slotResult(KJob *);
 
 Q_SIGNALS:
     /** emitted when done. **/
     void finished(bool);
     void searchType(const QString &type);
 
 protected:
     /** search types, where to search for autoconfig
         @see lookupUrl to generate a url base on this type
      */
     enum searchServerType {
         IspAutoConfig = 0, /**< http://autoconfig.example.com/mail/config-v1.1.xml */
         IspWellKnow, /**< http://example.com/.well-known/autoconfig/mail/config-v1.1.xml */
         DataBase /**< https://autoconfig.thunderbird.net/v1.1/example.com */
     };
 
     /** let's request the autoconfig server */
     virtual void startJob(const QUrl &url);
 
     /** generate url and start job afterwards */
     virtual void lookupInDb(bool auth, bool crypt);
 
     /** an valid xml document is available, parse it and create all the objects
         should run createServer, createIdentity, ...
      */
     virtual void parseResult(const QDomDocument &document);
 
     /** create a server object out of an element */
     virtual Server createServer(const QDomElement &n);
 
     /** create a identity object out of an element */
     virtual identity createIdentity(const QDomElement &n);
 
     /** get standard urls for autoconfig
         @return the standard url for autoconfig depends on serverType
         @param type of request (ex. "mail")
         @param version of the file (example for mail "1.1")
         @param auth use authentication with username & password to access autoconfig file
                     (username is the emailaddress)
         @param crypt use https
      */
     QUrl lookupUrl(const QString &type, const QString &version, bool auth, bool crypt);
 
     /** setter for serverType */
     void setServerType(Ispdb::searchServerType type);
 
     /** getter for serverType */
     Ispdb::searchServerType serverType() const;
 
     /** replaces %EMAILLOCALPART%, %EMAILADDRESS% and %EMAILDOMAIN% with the
         parts of the emailaddress */
     QString replacePlaceholders(const QString &);
 
     QByteArray mData; /** storage of incoming data from kio */
 protected Q_SLOTS:
 
     /** slot for TransferJob to dump data */
     void dataArrived(KIO::Job *, const QByteArray &data);
 
 private:
     KMime::Types::AddrSpec mAddr; // emailaddress
     QString mPassword;
 
     // storage of the results
     QStringList mDomains;
     QString mDisplayName;
     QString mDisplayShortName;
     QVector<Server> mImapServers;
     QVector<Server> mPop3Servers;
     QVector<Server> mSmtpServers;
     QVector<identity> mIdentities;
 
     int mDefaultIdentity = -1;
     Ispdb::searchServerType mServerType;
     bool mStart = true;
 };
 
 struct Server {
     Server() = default;
 
     bool isValid() const
     {
         return port != -1;
     }
 
     Ispdb::authType authentication = Ispdb::Plain;
     Ispdb::socketType socketType = Ispdb::None;
     QString hostname;
     QString username;
     int port = -1;
 };
 QDebug operator<<(QDebug d, const Server &t);
 
 struct identity {
     identity() = default;
 
     bool isValid() const
     {
         return !name.isEmpty();
     }
 
     bool isDefault() const
     {
         return mDefault;
     }
 
     QString email;
     QString name;
     QString organization;
     QString signature;
     bool mDefault = false;
 };
 QDebug operator<<(QDebug d, const identity &t);