File indexing completed on 2024-11-24 04:44:33

 /*
    SPDX-FileCopyrightText: 2010 Thomas McGuire <mcguire@kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
 
 #pragma once
 
 class KJob;
 #include <Akonadi/ResourceBase>
 #include <KMime/Message>
 #include <QSet>
 
 #include "settings.h"
 
 class DeleteJob;
 
 namespace Akonadi
 {
 class ItemCreateJob;
 }
 class POPSession;
 class QTimer;
 namespace QKeychain
 {
 class Job;
 }
 class POP3Resource : public Akonadi::ResourceBase, public Akonadi::AgentBase::Observer
 {
     Q_OBJECT
 
 public:
     explicit POP3Resource(const QString &id);
     ~POP3Resource() override;
 
     void clearCachedPassword();
 
     void cleanup() override;
 
 protected:
     using ResourceBase::retrieveItems; // Suppress -Woverload-virtual
 
 protected Q_SLOTS:
     void retrieveCollections() override;
     void retrieveItems(const Akonadi::Collection &col) override;
     bool retrieveItems(const Akonadi::Item::List &items, const QSet<QByteArray> &parts) override;
     bool retrieveItem(const Akonadi::Item &item, const QSet<QByteArray> &parts) override;
 
 protected:
     void aboutToQuit() override;
     void doSetOnline(bool online) override;
 
 private Q_SLOTS:
 
     void slotAbortRequested();
     void intervalCheckTriggered();
     void configurationChanged();
 
     // For state FetchTargetCollection
     void targetCollectionFetchJobFinished(KJob *job);
     void localFolderRequestJobFinished(KJob *job);
 
     // For state Precommand
     void precommandResult(KJob *job);
 
     // For state RequestPassword
     void walletOpenedForLoading(QKeychain::Job *baseJob);
 
     // For state Login
     void loginJobResult(KJob *job);
 
     // For state List
     void listJobResult(KJob *job);
 
     // For state UIDList
     void uidListJobResult(KJob *job);
 
     // For state Download
     void messageFinished(int messageId, KMime::Message::Ptr message);
     void fetchJobResult(KJob *job);
     void messageDownloadProgress(KJob *job, KJob::Unit unit, qulonglong totalBytes);
 
     // For state Save
     void itemCreateJobResult(KJob *job);
 
     // For state Delete
     void deleteJobResult(KJob *job);
 
     // For state Quit
     void quitJobResult(KJob *job);
 
 private:
     enum State {
         Idle,
         FetchTargetCollection,
         Precommand,
         RequestPassword,
         Connect,
         Login,
         List,
         UIDList,
         Download,
         Save,
         Quit,
         SavePassword,
         CheckRemovingMessage
     };
 
     void resetState();
     void doStateStep();
     void advanceState(State nextState);
     void cancelSync(const QString &errorMessage, bool error = true);
     void saveSeenUIDList();
     QList<int> shouldDeleteId(int downloadedId) const;
     int idToTime(int id) const;
     int idOfOldestMessage(const QSet<int> &idList) const;
     void startMailCheck();
     void updateIntervalTimer();
     void showPasswordDialog(const QString &queryText);
     QString buildLabelForPasswordDialog(const QString &detailedError) const;
     void checkRemovingMessageFromServer();
     void finish();
 
     bool shouldAdvanceToQuitState() const;
 
     State mState;
     Akonadi::Collection mTargetCollection;
     POPSession *mPopSession = nullptr;
     bool mAskAgain = false;
     QTimer *mIntervalTimer = nullptr;
     bool mIntervalCheckInProgress = false;
     QString mPassword;
     bool mSavePassword = false;
     bool mTestLocalInbox = false;
 
     // Maps IDs on the server to message sizes on the server
     QMap<int, int> mIdsToSizeMap;
 
     // Maps IDs on the server to UIDs on the server.
     // This can be empty, if the server doesn't support UIDL
     QMap<int, QString> mIdsToUidsMap;
 
     // Maps UIDs on the server to IDs on the server.
     // This can be empty, if the server doesn't support UIDL
     QMap<QString, int> mUidsToIdsMap;
 
     // Whether we actually received a valid UID list from the server
     bool mUidListValid;
 
     // IDs of messages that we have successfully downloaded. This does _not_ mean
     // that the messages corresponding to the IDs are stored in Akonadi yet
     QList<int> mDownloadedIDs;
 
     // IDs of messages that we want to download and that we have started the
     // FetchJob with. After the FetchJob, this should be empty, except if there
     // was some error
     QList<int> mIdsToDownload;
 
     // After downloading a message, we store it in Akonadi by using an ItemCreateJob.
     // This map stores the currently running ItemCreateJob's and their corresponding
     // POP3 IDs.
     // When an ItemCreateJob finished, it is removed from this map.
     // The Save state waits until this map becomes empty.
     QMap<Akonadi::ItemCreateJob *, int> mPendingCreateJobs;
 
     // List of message IDs that were successfully stored in Akonadi
     QList<int> mIDsStored;
 
     // List of message IDs that were successfully deleted
     QList<int> mDeletedIDs;
 
     // List of message IDs that we want to delete with the next delete job
     QList<int> mIdsWaitingToDelete;
 
     // List of message IDs that we want to keep on the server
     mutable QSet<int> mIdsToSave;
     mutable bool mIdsToSaveValid;
 
     // Current deletion job in process
     DeleteJob *mDeleteJob = nullptr;
 
     Settings mSettings;
 };