kmkernel.h

Go to the documentation of this file.

// -*- mode: C++; c-file-style: "gnu" -*-

#ifndef _KMKERNEL_H
#define _KMKERNEL_H

#include "interfaces/mailinterfaces.h"

#include <QList>
#include <QObject>
#include <QPointer>
#include <QDBusObjectPath>
#include <Solid/Networking>

#include <kurl.h>

#include "kmail_export.h"
#include "settings/globalsettings.h"
#include <kcomponentdata.h>
#include <akonadi/servermanager.h>
#include "messageviewer/viewer/viewer.h"

#define kmkernel KMKernel::self()
#define kmconfig KMKernel::config()

namespace MailCommon {
  class KMFilterDialog;
}

class QAbstractItemModel;
namespace Akonadi {
  class Collection;
  class ChangeRecorder;
  class EntityTreeModel;
  class EntityMimeTypeFilterModel;
}

namespace KIO {
  class Job;
}

namespace KPIM {
  class ProgressItem;
}

namespace MessageComposer {
  class MessageSender;
  class ComposerAutoCorrection;
}

namespace KMail {
  class MailServiceImpl;
  class UndoStack;
  class KMSystemTray;
}
using KMail::MailServiceImpl;
using KMail::UndoStack;
namespace MessageComposer {
class AkonadiSender;
}

namespace KPIMIdentities {
  class Identity;
  class IdentityManager;
}
class KComponentData;
class QTimer;
class KMMainWin;
class KMainWindow;
class KMMainWidget;
class ConfigureDialog;

namespace MailCommon {
  class Kernel;
  class FolderCollection;
  class FolderCollectionMonitor;
  class JobScheduler;
}

class KMAIL_EXPORT KMKernel : public QObject, public MailCommon::IKernel, public MailCommon::ISettings, public MailCommon::IFilter
{
  Q_OBJECT
  Q_CLASSINFO("D-Bus Interface", "org.kde.kmail.kmail")

public:
  explicit KMKernel (QObject *parent=0, const char *name=0);
  ~KMKernel ();

public Q_SLOTS:

  Q_SCRIPTABLE void checkMail();
  Q_SCRIPTABLE void openReader() { openReader( false ); }

  Q_SCRIPTABLE void setSystrayIconNotificationsEnabled( bool enabled );

  Q_SCRIPTABLE void pauseBackgroundJobs();

  Q_SCRIPTABLE void resumeBackgroundJobs();

  Q_SCRIPTABLE void stopNetworkJobs();

  Q_SCRIPTABLE void resumeNetworkJobs();

  Q_SCRIPTABLE QStringList accounts();

  Q_SCRIPTABLE void makeResourceOnline(MessageViewer::Viewer::ResourceOnlineMode mode);

  Q_SCRIPTABLE void checkAccount( const QString & account );

  Q_SCRIPTABLE bool selectFolder( const QString & folder );

  Q_SCRIPTABLE bool canQueryClose();

  Q_SCRIPTABLE bool handleCommandLine( bool noArgsOpensReader );

  Q_SCRIPTABLE int openComposer(const QString & to,
                                 const QString & cc,
                                 const QString & bcc,
                                 const QString & subject,
                                 const QString & body,
                                 bool hidden,
                                 const QString & messageFile,
                                 const QStringList & attachmentPaths,
                                const QStringList & customHeaders , const QString &replyTo = QString(), const QString &inReplyTo = QString());

  Q_SCRIPTABLE int openComposer( const QString & to,
                                 const QString & cc,
                                 const QString & bcc,
                                 const QString & subject,
                                 const QString & body,
                                 bool hidden,
                                 const QString & attachName,
                                 const QByteArray & attachCte,
                                 const QByteArray  &attachData,
                                 const QByteArray & attachType,
                                 const QByteArray & attachSubType,
                                 const QByteArray & attachParamAttr,
                                 const QString & attachParamValue,
                                 const QByteArray & attachContDisp,
                                 const QByteArray & attachCharset,
                                 unsigned int identity );

  Q_SCRIPTABLE QDBusObjectPath openComposer( const QString & to,
                                             const QString & cc,
                                             const QString & bcc,
                                             const QString & subject,
                                             const QString & body,
                                             bool hidden );

  Q_SCRIPTABLE QDBusObjectPath newMessage( const QString & to,
                                           const QString & cc,
                                           const QString & bcc,
                                           bool hidden,
                                           bool useFolderId,
                                           const QString & messageFile,
                                           const QString & attachURL );

  Q_SCRIPTABLE bool showMail( quint32 serialNumber, const QString & messageId );

  Q_SCRIPTABLE int viewMessage( const QString & messageFile );

  Q_SCRIPTABLE void updateConfig();

  Q_SCRIPTABLE void showFolder(const QString &collectionId);

public:
  void checkMailOnStartup();

  static bool askToGoOnline();

  static bool isOffline();

  static KMKernel *self();
  /*reimp*/ KSharedConfig::Ptr config();
  /*reimp*/ void syncConfig();

  void init();
  void setupDBus();
  void readConfig();

  /*reimp*/ Akonadi::ChangeRecorder *folderCollectionMonitor() const;

  Akonadi::EntityTreeModel *entityTreeModel() const;

  /*reimp*/ Akonadi::EntityMimeTypeFilterModel *collectionModel() const;

  void recoverDeadLetters();
  void closeAllKMailWindows();
  void cleanup(void);
  void quit();
  bool doSessionManagement();
  bool firstInstance() const { return the_firstInstance; }
  void setFirstInstance(bool value) { the_firstInstance = value; }
  void action(bool mailto, bool check, const QString &to, const QString &cc,
               const QString &bcc, const QString &subj, const QString &body,
               const KUrl &messageFile, const KUrl::List &attach,
               const QStringList &customHeaders , const QString &replyTo, const QString &inReplyTo);

  bool isImapFolder(const Akonadi::Collection& , bool &isOnline) const;

  //sets online status for akonadi accounts. true for online, false for offline
  void setAccountStatus(bool);

  const KComponentData &xmlGuiInstance() { return mXmlGuiInstance; }
  void setXmlGuiInstance( const KComponentData &instance ) { mXmlGuiInstance = instance; }

  UndoStack *undoStack() { return the_undoStack; }
  MessageComposer::MessageSender *msgSender();

  /*reimp*/ void openFilterDialog(bool createDummyFilter = true);
  /*reimp*/ void createFilter(const QByteArray& field, const QString& value);

  /*reimp*/ KPIMIdentities::IdentityManager *identityManager();

  /*reimp*/ MailCommon::JobScheduler* jobScheduler() const { return mJobScheduler; }

  void expireAllFoldersNow();

  int wrapCol() const { return mWrapCol;}

  bool firstStart() const { return the_firstStart; }
  void firstStartDone() { the_firstStart = false; }
  QString previousVersion() const { return the_previousVersion; }
  bool startingUp() const { return the_startingUp; }
  void setStartingUp (bool flag) { the_startingUp = flag; }
  bool shuttingDown() const { return the_shuttingDown; }
  void setShuttingDown(bool flag) { the_shuttingDown = flag; }

  static QString localDataPath();

  bool haveSystemTrayApplet() const;

  QTextCodec *networkCodec() { return netCodec; }

  KMainWindow* mainWin();

  KMMainWidget *getKMMainWidget();

  Akonadi::Collection::List allFolders() const;
//
  void selectCollectionFromId( const Akonadi::Collection::Id id);

  void raise();

  void stopAgentInstance();

  //ISettings
  /*reimp*/ bool showPopupAfterDnD();

  /*reimp*/ bool excludeImportantMailFromExpiry();

  /*reimp*/ qreal closeToQuotaThreshold();

  /*reimp*/ Akonadi::Collection::Id lastSelectedFolder();
  /*reimp*/ void setLastSelectedFolder( const Akonadi::Collection::Id  &col );

  /*reimp*/ QStringList customTemplates();

  void checkFolderFromResources( const Akonadi::Collection::List& collectionList );

  const QAbstractItemModel* treeviewModelSelection();

  void savePaneSelection();

  void updatePaneTagComboBox();


  MessageComposer::ComposerAutoCorrection* composerAutoCorrection();

  void toggleSystemTray();

protected:
  void agentInstanceBroken( const Akonadi::AgentInstance& instance );

  
public slots:

  /*reimp*/ void updateSystemTray();

  void updatedTemplates();

  void dumpDeadLetters();

  void slotRequestConfigSync();

  void slotSyncConfig();

  void slotShowConfigurationDialog();
  void slotRunBackgroundTasks();

  void slotConfigChanged();

signals:
  void configChanged();
  void onlineStatusChanged( GlobalSettings::EnumNetworkState::type );
  void customTemplatesChanged();

  void startCheckMail();
  void endCheckMail();

private slots:
  void transportRemoved( int id, const QString &name );
  void transportRenamed( int id, const QString &oldName, const QString &newName );
  void itemDispatchStarted();
  void instanceStatusChanged( const Akonadi::AgentInstance &);

  void akonadiStateChanged( Akonadi::ServerManager::State );
  void slotProgressItemCompletedOrCanceled( KPIM::ProgressItem * item);
  void slotInstanceError(const Akonadi::AgentInstance& instance, const QString & message);
  void slotInstanceWarning(const Akonadi::AgentInstance&instance, const QString& message);
  void slotCollectionMoved( const Akonadi::Collection &collection, const Akonadi::Collection &source, const Akonadi::Collection &destination );
  void slotCollectionRemoved(const Akonadi::Collection& col);
  void slotDeleteIdentity( uint identity);
  void slotInstanceRemoved(const Akonadi::AgentInstance&);
  void slotSystemNetworkStatusChanged( Solid::Networking::Status );
  void slotCollectionChanged(const Akonadi::Collection &, const QSet<QByteArray> &set);
  
private:
  void resourceGoOnLine();
  void openReader( bool onlyCheck );
  QSharedPointer<MailCommon::FolderCollection> currentFolderCollection();

  UndoStack *the_undoStack;
  mutable KPIMIdentities::IdentityManager *mIdentityManager;
  MessageComposer::AkonadiSender *the_msgSender;
  QString the_previousVersion;
  bool the_firstStart;
  bool the_startingUp;
  bool the_shuttingDown;
  bool the_firstInstance;

  KSharedConfig::Ptr mConfig;
  QTextCodec *netCodec;
  KComponentData mXmlGuiInstance;
  ConfigureDialog *mConfigureDialog;

  QTimer *mBackgroundTasksTimer;
  MailCommon::JobScheduler* mJobScheduler;
  // temporary mainwin
  KMMainWin *mWin;
  MailServiceImpl *mMailService;

  Solid::Networking::Status mSystemNetworkStatus;

  KMail::KMSystemTray* mSystemTray;
  QHash<QString, bool> mResourceCryptoSettingCache;
  MailCommon::FolderCollectionMonitor *mFolderCollectionMonitor;
  Akonadi::EntityTreeModel *mEntityTreeModel;
  Akonadi::EntityMimeTypeFilterModel *mCollectionModel;

  QList<QString> mResourcesBeingChecked;

  int mWrapCol;

  QPointer<MailCommon::KMFilterDialog> mFilterEditDialog;
  MessageComposer::ComposerAutoCorrection *mAutoCorrection;
};

#endif // _KMKERNEL_H