kmail/kmmainwidget.h

/* -*- mode: C++; c-file-style: "gnu" -*-
  This file is part of KMail, the KDE mail client.
  Copyright (c) 2002 Don Sanders <sanders@kde.org>

  Based on the work of Stefan Taferner <taferner@kde.org>

  KMail is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License, version 2, as
  published by the Free Software Foundation.

  KMail 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
  General Public License for more details.

  You should have received a copy of the GNU General Public License along
  with this program; if not, write to the Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef __KMMAINWIDGET
#define __KMMAINWIDGET

#include "kmail_export.h"
#include "kmreaderwin.h" //for inline actions
#include "kmkernel.h" // for access to config

#include <kurl.h>
#include <kxmlguiclient.h>
#include <kaction.h>
#include <kactioncollection.h>
#include <kvbox.h>

#include <QList>
#include <QVector>
#include <QVBoxLayout>
#include <q3listview.h>
#include <QMenu>
#include <QHash>
#include <QPointer>

class Q3Accel;
class QVBoxLayout;
class QSplitter;
class QSignalMapper;
class QToolBar;

class KActionMenu;
class KConfig;
class KToggleAction;
class KToggleAction;

class KMFolder;
class KMFolderTree;
class KMFolderTreeItem;
class KMMetaFilterActionCommand;
class FolderShortcutCommand;
class KMMessage;
class KMFolder;
class KMSystemTray;
class KMHeaders;

template <typename T> class QList;
template <typename T, typename S> class QMap;
template <typename T> class QPointer;

namespace KIO {
  class Job;
}

namespace KMail {
  class Vacation;
  class SieveDebugDialog;
  class FolderJob;
  class HeaderListQuickSearch;
  class SearchWindow;
  class ImapAccountBase;
}

typedef QMap<QAction*,KMFolder*> KMMenuToFolder;

class KMAIL_EXPORT KMMainWidget : public QWidget
{
  Q_OBJECT

  public:
    KMMainWidget(QWidget *parent, KXMLGUIClient *aGUIClient,
                 KActionCollection *actionCollection,
                 KConfig *config = KMKernel::config() );
    virtual ~KMMainWidget();
    void destruct();

    /** Read configuration options before widgets are created. */
    virtual void readPreConfig(void);

    /** Read configuration for current folder. */
    virtual void readFolderConfig(void);

    /** Write configuration for current folder. */
    virtual void writeFolderConfig(void);

    /** Read configuration options after widgets are created. */
    virtual void readConfig(void);

    /** Write configuration options. */
    virtual void writeConfig(void);

    /** Easy access to main components of the window. */
    KMReaderWin* messageView(void) const { return mMsgView; }
    KMFolderTree* folderTree(void) const  { return mFolderTree; }

    static void cleanup();

    QAction *action( const char *name ) { return mActionCollection->action( name ); }

    KAction *replyAction() const { return mReplyAction; }
    KAction *replyAuthorAction() const { return mReplyAuthorAction; }
    KAction *replyAllAction() const { return mReplyAllAction; }
    KAction *replyListAction() const { return mReplyListAction; }
    KActionMenu *customReplyAction() const { return mCustomReplyActionMenu; }
    KActionMenu *customReplyAllAction() const { return mCustomReplyAllActionMenu; }
    KActionMenu * replyMenu() const { return mReplyActionMenu; }
    KActionMenu *forwardMenu() const { return mForwardActionMenu; }
    KAction *forwardAction() const { return mForwardAction; }
    KAction *forwardAttachedAction() const { return mForwardAttachedAction; }
    KAction *redirectAction() const { return mRedirectAction; }
    KActionMenu *customForwardAction() const { return mCustomForwardActionMenu; }
    KAction *noQuoteReplyAction() const { return mNoQuoteReplyAction; }
    KActionMenu *filterMenu() const { return mFilterMenu; }
    KAction *printAction() const { return mPrintAction; }
    KAction *trashAction() const { return mTrashAction; }
    KAction *deleteAction() const { return mDeleteAction; }
    KAction *trashThreadAction() const { return mTrashThreadAction; }
    KAction *deleteThreadAction() const { return mDeleteThreadAction; }
    KAction *saveAsAction() const { return mSaveAsAction; }
    KAction *editAction() const { return mEditAction; }
    KAction *useAction() const { return mUseAction; }
    KAction *sendAgainAction() const { return mSendAgainAction; }
    KAction *applyAllFiltersAction() const { return mApplyAllFiltersAction; }
    KAction *findInMessageAction() const { return mFindInMessageAction; }
    KAction *saveAttachmentsAction() const { return mSaveAttachmentsAction; }
    KAction *openAction() const { return mOpenAction; }
    KAction *viewSourceAction() { return mViewSourceAction; }

    KActionMenu *statusMenu()  const{ return mStatusMenu; }
    KActionMenu *threadStatusMenu() const { return mThreadStatusMenu; }
    KActionMenu *moveActionMenu() const{ return mMoveActionMenu; }
    KActionMenu *mopyActionMenu() const { return mCopyActionMenu; }
    KActionMenu *applyFilterActionsMenu() const { return mApplyFilterActionsMenu; }

    KToggleAction *watchThreadAction() const { return mWatchThreadAction; }
    KToggleAction *ignoreThreadAction() const { return mIgnoreThreadAction; }

    KMHeaders *headers() const { return mHeaders; }
    void toggleSystemTray();

    void updateListFilterAction();

    /**
      Returns a list of all KMMainWidgets. Warning, the list itself can be 0.
      @return the list of all main widgets, or 0 if it is not yet initialized
    */
    static const QList<KMMainWidget*>* mainWidgetList() { return s_mainWidgetList; }

    KMSystemTray *systray() const;

    /**
      Checks a shortcut against the actioncollection and returns whether it
      is already used and therefor not valid or not.
    */
    bool shortcutIsValid( const QKeySequence& ) const;

    void modifyFolder( KMFolderTreeItem *folderItem );

    /**
      Enable or disable the global accelerators. This is useful for keyboard
      navigation inside child widgets like combo boxes.
    */
    void setAccelsEnabled( bool enabled = true );

  public slots:
    void slotMoveMsgToFolder( KMFolder *dest);
    void slotTrashMsg();   // move to trash

    virtual void show();
    virtual void hide();
    void slotCheckMail();

    /**
      Select the given folder
      If the folder is 0 the intro is shown
    */
    void folderSelected( KMFolder*, bool forceJumpToUnread = false );

    /**
      Reselect current folder
    */
    void folderSelected();

    /**
      Select the folder and jump to the next unread msg
    */
    void folderSelectedUnread( KMFolder* );

    void slotMsgSelected(KMMessage*);
    void slotMsgChanged();

    /**
      Change the current folder, select a message in the current folder
    */
    void slotSelectFolder(KMFolder*);
    void slotSelectMessage(KMMessage*);

    void slotReplaceMsgByUnencryptedVersion();

    /**
      Update message menu
    */
    void updateMessageMenu();

    /**
      Start a timer to update message actions
    */
    void startUpdateMessageActionsTimer();

    /** Update message actions */
    void updateMessageActions();

    /** Launch subscription-dialog (server side) */
    void slotSubscriptionDialog();

    /** Launch dialog for local (client side) subscription configuration */
    void slotLocalSubscriptionDialog();

    /** The columns of the foldertree changed */
    void slotFolderTreeColumnsChanged();

    /** Clear and create actions for marked filters */
    void clearFilterActions();
    void initializeFilterActions();

    /** Create IMAP-account-related actions if applicable */
    void initializeIMAPActions() { initializeIMAPActions( true ); }

    /** Create actions for the folder shortcuts. */
    void initializeFolderShortcutActions();

    /** Add, remove or adjust the folder's shortcut. */
    void slotShortcutChanged( KMFolder *folder );

    /** Update the custom template menus. */
    void updateCustomTemplateMenus();

  signals:
    void messagesTransfered( bool );
    void captionChangeRequest( const QString &caption );

  protected:
    void setupActions();
    void createWidgets();
    void activatePanners();
    void showMsg( KMReaderWin *win, KMMessage *msg );
    void updateFileMenu();
    void newFromTemplate( KMMessage *msg );

    // helper functions for keeping reference to mFolder
    void openFolder();
    void closeFolder();

    KActionCollection *actionCollection() const { return mActionCollection; }

    /**
      @return the correct config dialog depending on whether the parent of
      the mainWidget is a KPart or a KMMainWindow.
      When dealing with geometries, use this pointer
    */
    KConfig *config();

  protected slots:
    void slotCheckOneAccount( QAction* );
    void slotMailChecked( bool newMail, bool sendOnCheck,
                          const QMap<QString, int> & newInFolder );
    void getAccountMenu();
    void getTransportMenu();
    void slotHelp();
    void slotFilter();
    void slotPopFilter();
    void slotManageSieveScripts();
    void slotAddrBook();
    void slotImport();
    void slotCompose();
    void slotPostToML();
    void slotModifyFolder();
    void slotFolderMailingListProperties();
    void slotFolderShortcutCommand();
    void slotExpireFolder();
    void slotExpireAll();
    void slotInvalidateIMAPFolders();
    void slotMarkAllAsRead();
    void slotRemoveFolder();
    void slotEmptyFolder();
    void slotCompactFolder();
    void slotRefreshFolder();
    void slotTroubleshootFolder();
    void slotCompactAll();
    void slotOverrideHtml();
    void slotOverrideHtmlLoadExt();
    void slotOverrideThread();
    void slotToggleSubjectThreading();
    void slotMessageQueuedOrDrafted();
    void slotEditMsg();
    void slotUseTemplate();
    void slotDeleteMsg( bool confirmDelete = true );  // completely delete message
    void slotTrashThread();
    void slotDeleteThread( bool confirmDelete = true );  // completely delete thread
    void slotUndo();
    void slotReadOn();
    void slotSaveMsg();
    void slotOpenMsg();
    void slotSaveAttachments();
    void slotJumpToFolder();
    void slotMoveMsg();
    void slotCopyMsgToFolder( KMFolder *dest);
    void slotCopyMsg();
    void slotResendMsg();
    void slotEditVacation();
    void slotDebugSieve();
    void slotStartCertManager();
    void slotStartWatchGnuPG();
    void slotApplyFilters();
    void slotExpandThread();
    void slotExpandAllThreads();
    void slotCollapseThread();
    void slotCollapseAllThreads();
    void slotShowMsgSrc();
    void slotSetMsgStatusNew();
    void slotSetMsgStatusUnread();
    void slotSetMsgStatusRead();
    void slotSetMsgStatusTodo();
    void slotSetMsgStatusSent();
    void slotSetMsgStatusImportant();
    void slotSetThreadStatusNew();
    void slotSetThreadStatusUnread();
    void slotSetThreadStatusRead();
    void slotSetThreadStatusTodo();
    void slotSetThreadStatusImportant();
    void slotSetThreadStatusWatched();
    void slotSetThreadStatusIgnored();
    void slotToggleUnread();
    void slotToggleTotalColumn();
    void slotSendQueued();
    void slotSendQueuedVia( QAction* );
    void slotOnlineStatus();
    void slotUpdateOnlineStatus( GlobalSettings::EnumNetworkState::type );
    void slotMsgPopup(KMMessage &msg, const KUrl &aUrl, const QPoint&);
    void slotMarkAll();
    void slotSearch();
    void slotSearchClosed();
    void slotFind();
    void slotIntro();
    void slotShowStartupFolder();
    void slotShowTip();  // Show tip-of-the-day, forced
    void slotAntiSpamWizard();
    void slotAntiVirusWizard();
    void slotFilterLogViewer();

    /** Message navigation */
    void slotNextMessage();
    void slotNextUnreadMessage();
    void slotNextUnreadFolder();
    void slotPrevMessage();
    void slotPrevUnreadMessage();
    void slotPrevUnreadFolder();

    /** etc. */
    void slotDisplayCurrentMessage();
    void slotMsgActivated(KMMessage*);

    void slotShowNewFromTemplate();
    void slotNewFromTemplate( int );

    /** Update the undo action */
    void slotUpdateUndo();

    /** Move selected messages to folder with corresponding to given qaction */
    virtual void moveSelectedToFolder( QAction* );
    /** Copy selected messages to folder with corresponding to given qaction */
    virtual void copySelectedToFolder( QAction* );
    /** Update html and threaded messages preferences in Folder menu. */
    void updateFolderMenu();
    /**
      Enable or disable the "mark all as read" action. Needs to happen more
      often the the other updates and is therefor in its own method.
    */
    void updateMarkAsReadAction();

    /** Settings menu */
    void slotToggleShowQuickSearch();

    /** XML-GUI stuff */
    void slotEditNotifications();
    void slotEditKeys();

    /** changes the caption and displays the foldername */
    void slotChangeCaption(Q3ListViewItem*);
    void removeDuplicates();

    /** Slot to reply to a message */
    void slotReplyToMsg();
    void slotReplyAuthorToMsg();
    void slotReplyListToMsg();
    void slotReplyAllToMsg();
    void slotCustomReplyToMsg( int tid );
    void slotCustomReplyAllToMsg( int tid );
    void slotForwardMsg();
    void slotForwardAttachedMsg();
    void slotRedirectMsg();
    void slotCustomForwardMsg( int tid );
    void slotNoQuoteReplyToMsg();
    void slotSubjectFilter();
    void slotMailingListFilter();
    void slotFromFilter();
    void slotToFilter();
    void slotPrintMsg();

    void slotConfigChanged();

    /**
      Remove the shortcut actions associated with a folder.
    */
    void slotFolderRemoved( KMFolder *folder );

    /** Show a splash screen for the longer-lasting operation */
    void slotShowBusySplash();

    /**
      Show a message screen explaining that we are currently offline, when
      an online folder is selected.
    */
    void showOfflinePage();

  private:
    /** Get override character encoding. */
    QString overrideEncoding() const;

    void initializeIMAPActions( bool setState );

    /**
      Helper which finds the associated account if there is a current
      folder and it is an imap or disconnected imap one.
    */
    KMail::ImapAccountBase* findCurrentImapAccountBase();

    /**
      Helper which finds the associated IMAP path if there is a current
      folder and it is an imap or disconnected imap one.
    */
    QString findCurrentImapPath();

    // Message actions
    KAction *mTrashAction, *mDeleteAction, *mTrashThreadAction,
      *mDeleteThreadAction, *mSaveAsAction, *mEditAction, *mUseAction,
      *mSendAgainAction, *mApplyAllFiltersAction, *mFindInMessageAction,
      *mSaveAttachmentsAction, *mOpenAction, *mViewSourceAction;

    // Composition actions
    KAction *mPrintAction,
      *mReplyAction, *mReplyAllAction, *mReplyAuthorAction, *mReplyListAction,
      *mForwardAction, *mForwardAttachedAction, *mRedirectAction, *mNoQuoteReplyAction;
    KActionMenu *mReplyActionMenu;
    KActionMenu *mForwardActionMenu;

    // Filter actions
    KActionMenu *mFilterMenu;
    KAction *mSubjectFilterAction, *mFromFilterAction, *mToFilterAction,
      *mListFilterAction;

    KActionMenu *mTemplateMenu;

    // Custom template actions menu
    KActionMenu *mCustomReplyActionMenu, *mCustomReplyAllActionMenu, *mCustomForwardActionMenu;

    // Signal mappers for custom template actions
    QSignalMapper *mCustomReplyMapper, *mCustomReplyAllMapper, *mCustomForwardMapper;

    KActionMenu *mStatusMenu, *mThreadStatusMenu, *mMoveActionMenu,
      *mCopyActionMenu, *mApplyFilterActionsMenu;
    KAction *mMarkThreadAsNewAction, *mMarkThreadAsReadAction, *mMarkThreadAsUnreadAction;
    KToggleAction *mToggleThreadTodoAction, *mToggleThreadImportantAction,
      *mToggleTodoAction, *mToggleImportantAction;

    KToggleAction *mWatchThreadAction, *mIgnoreThreadAction;

    /** we need to access those KToggleActions from the foldertree-popup */
    KToggleAction* mUnreadColumnToggle;
    KToggleAction* mUnreadTextToggle;
    KToggleAction* mTotalColumnToggle;

    KToggleAction *mToggleShowQuickSearchAction;

    KMFolderTree *mFolderTree;
    KMReaderWin  *mMsgView;
    QSplitter    *mPanner1, *mPanner2;
    KMHeaders    *mHeaders;
    KVBox        *mSearchAndHeaders;
    QToolBar     *mSearchToolBar;
    KMail::HeaderListQuickSearch *mQuickSearchLine;
    QPointer<KMFolder> mFolder;
    KMFolder     *mTemplateFolder;
    QMenu        *mViewMenu, *mBodyPartsMenu;
    KAction      *mlistFilterAction;
    bool          mIntegrated;
    bool          mBeepOnNew;
    bool          mConfirmEmpty;
    QString       mStartupFolder;
    int           mMessageStatusId;
    QList<int>    mPanner1Sep, mPanner2Sep;
    KUrl          mUrlCurrent;
    QMenu        *mActMenu;
    QMenu        *mSendMenu;
    QMenu        *mFileMenu;

    bool          mLongFolderList;
    bool          mStartupDone;
    KMMenuToFolder mMenuToFolder;
    int copyId, moveId, htmlId, threadId;
    bool mHtmlPref, mHtmlLoadExtPref, mThreadPref,
      mFolderHtmlPref, mFolderHtmlLoadExtPref, mFolderThreadPref,
      mFolderThreadSubjPref, mReaderWindowActive, mReaderWindowBelow;

    //  QPopupMenu *mMessageMenu;
    KMail::SearchWindow *mSearchWin;

    KAction *mNewFolderAction, *mModifyFolderAction, *mRemoveFolderAction,
      *mExpireFolderAction, *mCompactFolderAction, *mRefreshFolderAction,
      *mEmptyFolderAction, *mMarkAllAsReadAction, *mFolderMailingListPropertiesAction,
      *mFolderShortCutCommandAction, *mTroubleshootFolderAction, *mRemoveDuplicatesAction;
    KToggleAction *mPreferHtmlAction, *mPreferHtmlLoadExtAction,
      *mThreadMessagesAction, *mThreadBySubjectAction;
    KToggleAction *mFolderAction, *mHeaderAction, *mMimeAction;

    QTimer *menutimer;
    QTimer *mShowBusySplashTimer;

    QPointer<KMail::Vacation> mVacation;
#if !defined(NDEBUG)
    QPointer<KMail::SieveDebugDialog> mSieveDebugDialog;
#endif
    KActionCollection *mActionCollection;
    QAction  *mToolbarActionSeparator;
    QVBoxLayout *mTopLayout;
    bool mDestructed, mForceJumpToUnread, mShowingOfflineScreen;
    QList<QAction*> mFilterMenuActions;
    QList<QAction*> mFilterTBarActions;
    QList<KMMetaFilterActionCommand*> mFilterCommands;
    QHash<QString,FolderShortcutCommand*> mFolderShortcutCommands;
    QPointer <KMail::FolderJob> mJob;

    QVector<QString> mCustomTemplates;
    QList<KAction*> mCustomTemplateActions;

    KMSystemTray  *mSystemTray;
    KConfig *mConfig;
    KXMLGUIClient *mGUIClient;

    static QList<KMMainWidget*>* s_mainWidgetList;
    bool mOpenedImapFolder;

    Q3Accel *mAccel;
};

#endif