kmcomposewin.h

Go to the documentation of this file.

/*
 * This file is part of KMail.
 * Copyright (c) 2009 Constantin Berzan <exit3219@gmail.com>
 *
 * Based on KMail code by:
 * Copyright (c) 1997 Markus Wuebben <markus.wuebben@kde.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 __KMComposeWin
#define __KMComposeWin

// KMail includes
#include "editor/composer.h"
#include "messagecomposer/recipient/recipientseditor.h"

// Qt includes
#include <QFont>
#include <QList>

// KDE includes
#include <kglobalsettings.h>

// LIBKDEPIM includes
#include <messagecomposer/composer/kmeditor.h>

#include "messagecomposer/sender/messagesender.h"

// KDEPIMLIBS includes
#include <kmime/kmime_message.h>
#include <kmime/kmime_headers.h>

// Other includes
#include "kleo/enum.h"
#include <composer/composerviewbase.h>

class QByteArray;
class QCheckBox;
class QGridLayout;
class QLabel;
class QPushButton;
class QSplitter;

class CodecAction;
class KActionMenuChangeCase;
class KMComposeWin;
class KMComposerEditor;
class KSelectAction;
class KAction;
class KJob;
class KToggleAction;
class KUrl;
class KRecentFilesAction;
class SnippetWidget;
class AttachmentMissingWarning;
class ExternalEditorWarning;
class KActionMenu;
class CryptoStateIndicatorWidget;
class StatusBarLabelToggledState;
class PotentialPhishingEmailWarning;
class KMComposerGlobalAction;
namespace boost {
template <typename T> class shared_ptr;
}
namespace MailTransport {
class Transport;
}
namespace KPIMIdentities {
class Identity;
}

namespace KPIMTextEdit {
class SelectSpecialChar;
}

namespace KIO {
class Job;
}

namespace MessageComposer {
class ComposerLineEdit;
class Composer;
}

namespace MailCommon {
class FolderRequester;
}

namespace PimCommon {
class CustomToolsWidget;
class LineEditWithAutoCorrection;
class SplitterCollapser;
}
class KMStorageService;
//-----------------------------------------------------------------------------
class KMComposeWin : public KMail::Composer
{
    Q_OBJECT
    Q_CLASSINFO("D-Bus Interface", "org.kde.kmail.mailcomposer")

    friend class ::KMComposerEditor;

private: // mailserviceimpl, kmkernel, kmcommands, callback, kmmainwidget
    explicit KMComposeWin(const KMime::Message::Ptr &msg, bool lastSignState, bool lastEncryptState, TemplateContext context = NoTemplate,
                          uint identity = 0, const QString & textSelection = QString(),
                          const QString & customTemplate = QString() );
    ~KMComposeWin();

public:
    static Composer *create( const KMime::Message::Ptr &msg, bool lastSignState, bool lastEncryptState, TemplateContext context = NoTemplate,
                             uint identity = 0, const QString & textSelection = QString(),
                             const QString & customTemplate = QString() );

    QString dbusObjectPath() const;
    QString smartQuote( const QString & msg );

    // TODO clean-up dbus stuff; make the adaptor a friend; etc.
public slots:

    Q_SCRIPTABLE void send( int how );

    Q_SCRIPTABLE void addAttachmentsAndSend( const KUrl::List & urls,
                                             const QString & comment,
                                             int how );

    Q_SCRIPTABLE void addAttachment( const KUrl & url,
                                     const QString & comment );

    Q_SCRIPTABLE void addAttachment( const QString & name,
                                     KMime::Headers::contentEncoding cte,
                                     const QString& charset,
                                     const QByteArray & data,
                                     const QByteArray & mimeType );

signals:
    void identityChanged( const KPIMIdentities::Identity &identity );


public: // kmkernel, kmcommands, callback
    void setMessage( const KMime::Message::Ptr &newMsg, bool lastSignState = false, bool lastEncryptState = false,
                     bool mayAutoSign=true, bool allowDecryption=false, bool isModified=false );

    void setCurrentTransport( int transportId );

    void setFcc( const QString &idString );

    void disableWordWrap();

    void forceDisableHtml();

    bool isComposing() const;

    void setTextSelection( const QString& selection );

    void setCustomTemplate( const QString& customTemplate );

    void setSigningAndEncryptionDisabled( bool v );
    void setFolder(const Akonadi::Collection &aFolder );
    void setFocusToEditor();

    void setFocusToSubject();

    bool insertFromMimeData( const QMimeData *source, bool forceAttachment = false );

    void setCurrentReplyTo(const QString&);
    void setCollectionForNewMessage( const Akonadi::Collection& folder);

    void addExtraCustomHeaders( const QMap<QByteArray, QString> &header);

    KToggleAction *translateAction() const { return mTranslateAction; }
    KActionMenuChangeCase *changeCaseMenu() const { return mChangeCaseMenu; }
    KToggleAction *generateShortenUrlAction() const { return mGenerateShortenUrl; }

    virtual void setCurrentIdentity(uint identity);

private:
    void writeConfig( void );


    bool isModified() const;
    bool isComposerModified() const;
    void changeModifiedState( bool modified );


public slots: // kmkernel, callback
    void slotSendNow();
    void slotWordWrapToggled( bool );

    void slotToggleMarkup();
    void slotTextModeChanged( KRichTextEdit::Mode );
    void htmlToolBarVisibilityChanged( bool visible );
    void slotSpellcheckDoneClearStatus();
    void autoSaveMessage(bool force = false);
    void setModified( bool modified );
    void slotFetchJob(KJob*);

private slots:
    void disableHtml( MessageComposer::ComposerViewBase::Confirmation confirmation );
    void enableHtml();

    void slotPrint();
    void slotPrintPreview();

    void slotInsertRecentFile( const KUrl & );
    void slotRecentListFileClear();

    void slotSendNowVia(MailTransport::Transport *transport );
    void slotSendLater();
    void slotSendLaterVia(MailTransport::Transport *transport );

    void slotSaveDraft();
    void slotSaveTemplate();
    void slotNewComposer();
    void slotClose();
    void slotHelp();
    void slotPasteAsAttachment();
    void slotFolderRemoved( const Akonadi::Collection& );
    void slotLanguageChanged( const QString &language );
    void slotFccFolderChanged(const Akonadi::Collection&);
    void slotEditorTextChanged();
    void slotOverwriteModeChanged();
    void slotUpdateFont();

    void slotAddressBook();

    void slotInsertFile();

    void slotSpellcheckConfig();

    void slotSelectCryptoModule( bool init = false );

    void slotEditToolbars();
    void slotUpdateToolbars();
    void slotEditKeys();

    void readConfig( bool reload = false );

    void slotUpdWinTitle();

    void slotEncryptToggled( bool );

    void slotSignToggled( bool );

    void slotUpdateView();

    void slotIdentityChanged( uint uoid, bool initalChange = false );

    void slotCursorPositionChanged();

    void slotSpellCheckingStatus( const QString & status );

    void slotDelayedApplyTemplate( KJob* );

    void recipientEditorSizeHintChanged();
    void setMaximumHeaderSize();
    void slotDoDelayedSend( KJob* );

    void slotCompletionModeChanged( KGlobalSettings::Completion );
    void slotConfigChanged();

    void slotPrintComposeResult( KJob *job );
    
    void slotSendFailed(const QString& msg , MessageComposer::ComposerViewBase::FailedType type);
    void slotSendSuccessful(const QString &messageId);

    void slotAutoSpellCheckingToggled( bool );


    virtual void setAutoSaveFileName( const QString& fileName );
    void slotSpellCheckingLanguage(const QString& language);
    void forceAutoSaveMessage();
    void insertSpecialCharacter();
    void charSelected(const QChar& c);
    void slotSaveAsFile();
    void slotCreateAddressBookContact();

    void slotAttachMissingFile();
    void slotExplicitClosedMissingAttachment();
    void slotVerifyMissingAttachmentTimeout();
    void slotCheckSendNow();

    void slotUpperCase();
    void slotLowerCase();
    void slotSentenceCase();

    void slotExternalEditorStarted();
    void slotExternalEditorClosed();

    void slotInsertShortUrl(const QString &url);

    void slotShareLinkDone(const QString &fileName);

    void slotTransportChanged();
    void slotFollowUpMail(bool toggled);
    void slotSendNowByShortcut();
    void slotSnippetWidgetVisibilityChanged(bool b);
    void slotOverwriteModeWasChanged(bool state);
    void slotExpandGroupResult(KJob *job);
    void slotCheckSendNowStep2();
    void slotPotentialPhishingEmailsFound(const QStringList &list);
    void slotInsertTextFile(KJob *job);
public: // kmcommand
    // FIXME we need to remove these, but they're pure virtual in Composer.
    void addAttach( KMime::Content *msgPart );

    const KPIMIdentities::Identity &identity() const;

    void disableForgottenAttachmentsCheck();

    void ignoreStickyFields();

    uint currentIdentity() const;
private:
    void updateSignatureAndEncryptionStateIndicators();

    void addFollowupReminder(const QString &messageId);
    void confirmBeforeSend();
    void sendNow(bool shortcutUsed);

    void updateSignature(uint uoid, uint uOldId);
    Kleo::CryptoMessageFormat cryptoMessageFormat() const;
    void printComposeResult( KJob *job, bool preview );
    void printComposer(bool preview);
    void rethinkFields( bool fromslot=false );

    QWidget *connectFocusMoving( QWidget *prev, QWidget *next );

    void rethinkHeaderLine( int aValue, int aMask, int &aRow,
                            QLabel *aLbl, QWidget *aEdt,
                            QPushButton *aBtn = 0 );

    void rethinkHeaderLine( int value, int mask, int &row,
                            QLabel *lbl, QWidget *cbx, QCheckBox *chk ); // krazy:exclude=qclasses


    void applyTemplate(uint uoid , uint uOldId);

    void setQuotePrefix( uint uoid );

    bool checkRecipientNumber() const;

    void setupActions();
    void setupStatusBar(QWidget *w);
    void setupEditor();

    QString subject() const;
    QString from() const;
    QString replyTo() const;

    virtual bool queryClose();

    void setEncryption( bool encrypt, bool setByUser = false );

    void setSigning( bool sign, bool setByUser = false );

    MessageComposer::ComposerViewBase::MissingAttachment userForgotAttachment();
#if 0

    static void decryptOrStripOffCleartextSignature( QByteArray & );
#endif

    void doSend( MessageComposer::MessageSender::SendMethod method=MessageComposer::MessageSender::SendDefault,
                 MessageComposer::MessageSender::SaveIn saveIn = MessageComposer::MessageSender::SaveInNone );

    void doDelayedSend( MessageComposer::MessageSender::SendMethod method, MessageComposer::MessageSender::SaveIn saveIn );

    void changeCryptoAction();
    void applyComposerSetting( MessageComposer::ComposerViewBase* mComposerBase );
    MessageComposer::Composer* createSimpleComposer();

    bool canSignEncryptAttachments() const;

    // helper method for rethinkFields
    int calcColumnWidth( int which, long allShowing, int width ) const;


    void initHeader( KMime::Message *message, uint identity=0 );

    inline bool encryptToSelf() const;

private:
    bool showErrorMessage(KJob *job);
    int validateLineWrapWidth();
    Akonadi::Collection mCollectionForNewMessage;
    QMap<QByteArray, QString> mExtraHeaders;


    QWidget   *mMainWidget;
    MessageComposer::ComposerLineEdit *mEdtFrom, *mEdtReplyTo;
    PimCommon::LineEditWithAutoCorrection *mEdtSubject;
    QLabel    *mLblIdentity, *mLblTransport, *mLblFcc;
    QLabel    *mLblFrom, *mLblReplyTo;
    QLabel    *mLblSubject;
    QLabel    *mDictionaryLabel;
    QCheckBox *mBtnIdentity, *mBtnDictionary, *mBtnTransport, *mBtnFcc;
    bool mDone;

    KMime::Message::Ptr mMsg;
    QGridLayout *mGrid;
    QString mTextSelection;
    QString mCustomTemplate;
    bool mLastSignActionState, mLastEncryptActionState, mSigningAndEncryptionExplicitlyDisabled;
    bool mLastIdentityHasSigningKey, mLastIdentityHasEncryptionKey;
    Akonadi::Collection mFolder;
    long mShowHeaders;
    bool mForceDisableHtml;     // Completely disable any HTML. Useful when sending invitations in the
    // mail body.
    int mNumHeaders;
    QFont mBodyFont, mFixedFont;
    uint mId;
    TemplateContext mContext;

    KRecentFilesAction *mRecentAction;

    KToggleAction *mSignAction, *mEncryptAction, *mRequestMDNAction;
    KToggleAction *mUrgentAction, *mAllFieldsAction, *mFromAction;
    KToggleAction *mReplyToAction;
    KToggleAction *mSubjectAction;
    KToggleAction *mIdentityAction, *mTransportAction, *mFccAction;
    KToggleAction *mWordWrapAction, *mFixedFontAction, *mAutoSpellCheckingAction;
    KToggleAction *mDictionaryAction, *mSnippetAction, *mTranslateAction;
    KAction *mAppendSignature;
    KAction *mPrependSignature;
    KAction *mInsertSignatureAtCursorPosition;
    KToggleAction *mGenerateShortenUrl;

    KToggleAction *markupAction;

    CodecAction *mCodecAction;
    KSelectAction *mCryptoModuleAction;

    KAction *mFindText, *mFindNextText, *mReplaceText, *mSelectAll;

    QSplitter *mHeadersToEditorSplitter;
    QWidget* mHeadersArea;
    QSplitter *mSplitter;
    QSplitter *mSnippetSplitter;
    QByteArray mOriginalPreferredCharset;

    MessageComposer::Composer *mDummyComposer;
    // used for auto saving, printing, etc. Not for sending, which happens in ComposerViewBase
    QList< MessageComposer::Composer* > mMiscComposers;

    int mLabelWidth;

    KActionMenuChangeCase *mChangeCaseMenu;

    QString mdbusObjectPath;
    static int s_composerNumber;

    MessageComposer::ComposerViewBase* mComposerBase;


    SnippetWidget *mSnippetWidget;
    PimCommon::CustomToolsWidget *mCustomToolsWidget;
    QPointer<KPIMTextEdit::SelectSpecialChar> mSelectSpecialChar;
    AttachmentMissingWarning *mAttachmentMissing;
    ExternalEditorWarning *mExternalEditorWarning;
    QTimer *m_verifyMissingAttachment;
    MailCommon::FolderRequester *mFccFolder;
    bool mPreventFccOverwrite;
    bool mCheckForForgottenAttachments;
    bool mIgnoreStickyFields;
    bool mWasModified;
    CryptoStateIndicatorWidget *mCryptoStateIndicatorWidget;
    KMStorageService *mStorageService;
    bool mSendNowByShortcutUsed;
    PimCommon::SplitterCollapser *mSnippetSplitterCollapser;
    KToggleAction *mFollowUpToggleAction;
    StatusBarLabelToggledState *mStatusBarLabelToggledOverrideMode;
    StatusBarLabelToggledState *mStatusBarLabelSpellCheckingChangeMode;
    PotentialPhishingEmailWarning *mPotentialPhishingEmailWarning;
    KMComposerGlobalAction *mGlobalAction;
};

#endif