viewer_p.h

Go to the documentation of this file.

/* -*- mode: C++; c-file-style: "gnu" -*-
  Copyright (c) 1997 Markus Wuebben <markus.wuebben@kde.org>
  Copyright (C) 2009 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.net
  Copyright (c) 2009 Andras Mantia <andras@kdab.net>

  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 MAILVIEWER_P_H
#define MAILVIEWER_P_H

#include "viewer/nodehelper.h"
#include "viewer.h" //not so nice, it is actually for the enums from MailViewer

#include <akonadi/item.h>
#include <akonadi/monitor.h>
#include <kio/job.h>
#include <kmime/kmime_message.h>
#include <kservice.h>
#include <ksharedconfig.h>
#include <kurl.h>

#include <QtCore/QObject>
#include <QtCore/QTimer>
#include <QWebElement>
namespace GpgME { class Error; }
namespace KIO { 
  class Job; 
}

namespace Kleo { class SpecialJob; }

class KAction;
class KActionCollection;
class KSelectAction;
class KToggleAction;
class KHBox;
class KMenu;

class QPoint;
class QSplitter;
class QModelIndex;
class QTreeView;

namespace MessageViewer {

  class EditorWatcher;
  class HtmlWriter;
  class CSSHelper;
  class AttachmentStrategy;
  class ObjectTreeParser;
  class HeaderStrategy;
  class HeaderStyle;
  class FindBarMailWebView;
  class MimeTreeModel;
  class WebKitPartHtmlWriter;
  class HtmlStatusBar;
  class MailWebView;
  class ScamDetectionWarningWidget;
}

namespace GrantleeTheme {
class GrantleeThemeManager;
}

namespace PimCommon {
  class TranslatorWidget;
}

namespace MessageViewer {

class ViewerPrivate : public QObject {
  Q_OBJECT
public:

  ViewerPrivate(Viewer *aParent, QWidget *mainWindow, KActionCollection *actionCollection );

  virtual ~ViewerPrivate();

  KMime::Content* nodeFromUrl(const KUrl &url);

  void openAttachment( KMime::Content *node, const QString & fileName );

  bool deleteAttachment( KMime::Content* node, bool showWarning = true );


  void attachmentProperties( KMime::Content *node );
  void attachmentCopy( const KMime::Content::List & contents );


  bool editAttachment( KMime::Content* node, bool showWarning = true );

  MailWebView *htmlPart() const { return mViewer; }

  void showAttachmentPopup( KMime::Content* node, const QString & name, const QPoint & p );

  void prepareHandleAttachment(KMime::Content *node, const QString& fileName );

  void postProcessMessage( ObjectTreeParser *otp, KMMsgEncryptionState encryptionState );

  QString createAtmFileLink( const QString& atmFileName ) const;
  KService::Ptr getServiceOffer( KMime::Content *content);
  KMime::Content::List selectedContents();
  void attachmentOpenWith( KMime::Content *node, KService::Ptr offer = KService::Ptr() );
  void attachmentOpen( KMime::Content *node );


  HtmlWriter * htmlWriter() const { return mHtmlWriter; }

  CSSHelper* cssHelper() const;

  NodeHelper* nodeHelper() const { return mNodeHelper; }

  Viewer *viewer() const { return q; }

  Akonadi::Item messageItem() const { return mMessageItem; }

  KMime::Message::Ptr message() const { return mMessage; }

  bool decryptMessage() const;

  int pointsToPixel(int pointSize) const;

  void displaySplashPage( const QString &info );

  void enableMessageDisplay();

  void displayMessage();

  void parseContent( KMime::Content *content );

  QString writeMsgHeader( KMime::Message *aMsg, KMime::Content* vCardNode = 0,
                          bool topLevel = false );

  void showVCard(KMime::Content *msgPart);

  void setZoomTextOnly( bool textOnly );

  void saveMainFrameScreenshotInFile(const QString &filename);

private:
  void initHtmlWidget();
  void saveMimePartTreeConfig();
  void restoreMimePartTreeConfig();
  void createOpenWithMenu( KMenu *topMenu, const QString &contentTypeStr, bool fromCurrentContent );
public:
  bool eventFilter( QObject *obj, QEvent *ev );

  void readConfig();

  void writeConfig( bool withSync=true );

  HeaderStyle * headerStyle() const {
    return mHeaderStyle;
  }

  void setHeaderStyleAndStrategy( HeaderStyle * style,
                                  HeaderStrategy * strategy, bool writeInConfigFile = false );

  HeaderStrategy * headerStrategy() const {
    return mHeaderStrategy;
  }

  const AttachmentStrategy * attachmentStrategy() const {
    return mAttachmentStrategy;
  }
  void setAttachmentStrategy( const AttachmentStrategy * strategy );

  QString overrideEncoding() const { return mOverrideEncoding; }

  void setOverrideEncoding( const QString & encoding );

  virtual void setPrinting(bool enable) { mPrinting = enable; }


  void printMessage( const Akonadi::Item &msg );
  void printPreviewMessage( const Akonadi::Item &message );

  void resetStateForNewMessage();

  void setMessageInternal( const KMime::Message::Ptr message, Viewer::UpdateMode updateMode );

  void setMessageItem(const Akonadi::Item& item, Viewer::UpdateMode updateMode = Viewer::Delayed );


  void setMessage( const KMime::Message::Ptr& msg, Viewer::UpdateMode updateMode = Viewer::Delayed );

  void setMessagePart( KMime::Content * node );

  void showHideMimeTree();

  void atmViewMsg( KMime::Message::Ptr message );

  void setExternalWindow( bool b );

  void adjustLayout();
  void createWidgets();
  void createActions();

  void showContextMenu( KMime::Content* content, const QPoint& point);

  KToggleAction * actionForHeaderStyle( const HeaderStyle *,
                                       const HeaderStrategy * );
  KToggleAction * actionForAttachmentStrategy( const AttachmentStrategy * );
  void readGlobalOverrideCodec();

  const QTextCodec * overrideCodec() const;


  QString renderAttachments( KMime::Content *node, const QColor &bgColor ) const;

  KMime::Content* findContentByType(KMime::Content *content, const QByteArray &type); //TODO(Andras) move to NodeHelper

  static const QTextCodec* codecForName(const QByteArray& _str); //TODO(Andras) move to a utility class?

  void saveRelativePosition();

  bool htmlMail() const;
  bool htmlLoadExternal() const;

  bool htmlOverride() const;

  void setHtmlOverride( bool override );

  bool htmlLoadExtOverride() const;

  void setHtmlLoadExtOverride( bool override );

  void setDecryptMessageOverwrite( bool overwrite = true );

  bool showSignatureDetails() const;

  void setShowSignatureDetails( bool showDetails = true ) ;

  /* show or hide the list that points to the attachments */
  bool showAttachmentQuicklist() const;

  /* show or hide the list that points to the attachments */
  void setShowAttachmentQuicklist( bool showAttachmentQuicklist = true );

  // This controls whether a Toltec invitation is shown in its raw form or as a replacement text.
  // This can be toggled with the "kmail:showRawToltecMail" link.
  bool showRawToltecMail() const { return mShowRawToltecMail; }
  void setShowRawToltecMail( bool showRawToltecMail ) { mShowRawToltecMail = showRawToltecMail; }

  void scrollToAttachment( KMime::Content *node );
  void setUseFixedFont( bool useFixedFont );

  void attachmentView( KMime::Content *atmNode );
  void attachmentEncryptWithChiasmus( KMime::Content * content );

  bool showFullToAddressList() const;

  void setShowFullToAddressList( bool showFullToAddressList = true );

  bool showFullCcAddressList() const;

  void setShowFullCcAddressList( bool showFullCcAddressList = true );

  void toggleFullAddressList(const QString& field);

  void setZoomFactor( qreal zoomFactor );


  void goOnline();
  void goResourceOnline();

  bool isAShortUrl(const KUrl &url) const;

private slots:
  void slotModifyItemDone(KJob* job);
  void slotMessageMayBeAScam();
  void slotMessageIsNotAScam();
  void slotAddToWhiteList();
  void slotToggleCaretBrowsing(bool);
  void slotAtmDecryptWithChiasmusResult( const GpgME::Error &, const QVariant & );
  void slotAtmDecryptWithChiasmusUploadResult( KJob * );

  void toggleFullAddressList();

  void itemFetchResult( KJob *job );

  void slotItemChanged( const Akonadi::Item& item, const QSet<QByteArray>& partIdentifiers );
  void slotItemMoved( const Akonadi::Item&, const Akonadi::Collection&, const Akonadi::Collection& );

  void itemModifiedResult( KJob* job );

  void collectionFetchedForStoringDecryptedMessage( KJob* job );

  void slotMimePartDestroyed();

  void slotClear();

  void slotMessageRendered();
  
  void slotOpenWithAction(QAction *act);

  void slotOpenWithActionCurrentContent(QAction* act);

  void slotOpenWithDialog();

  void slotOpenWithDialogCurrentContent();


  void saveSplitterSizes() const;
  void slotGrantleeThemesUpdated();

public slots:
  void slotUrlOpen( const QUrl &url = QUrl());

  void slotUrlOn(const QString & link, const QString & title, const QString & textContent);

  void slotUrlPopup(const QUrl &, const QUrl &imageUrl, const QPoint& mousePos);

  void slotFind();

  void slotTranslate();


  void slotToggleFixedFont();
  void slotToggleMimePartTree();

  void slotShowMessageSource();

  void updateReaderWin();

  void slotMimePartSelected( const QModelIndex &index );

  void slotBriefHeaders();
  void slotFancyHeaders();
  void slotEnterpriseHeaders();
  void slotStandardHeaders();
  void slotLongHeaders();
  void slotAllHeaders();
  void slotCustomHeaders();
  void slotGrantleeHeaders();

  void slotIconicAttachments();
  void slotSmartAttachments();
  void slotInlineAttachments();
  void slotHideAttachments();
  void slotHeaderOnlyAttachments();

  void slotDelayedResize();

  void slotPrintMsg();
  void slotPrintPreview();


  void slotSetEncoding();
  void injectAttachments();
  void slotSettingsChanged();
  void slotMimeTreeContextMenuRequested( const QPoint& pos );
  void slotAttachmentOpenWith();
  void slotAttachmentOpen();
  void slotAttachmentSaveAs();
  void slotAttachmentSaveAll();
  void slotAttachmentView();
  void slotAttachmentProperties();
  void slotAttachmentCopy();
  void slotAttachmentDelete();
  void slotAttachmentEdit();
  void slotAttachmentEditDone(EditorWatcher* editorWatcher);
  void slotLevelQuote( int l );

  void slotToggleHtmlMode();
  void slotZoomTextOnly();
  void slotLoadExternalReference();


  void slotHandleAttachment( int action );
  void slotCopySelectedText();

  void viewerSelectionChanged();
  
  void selectAll();

  void clearSelection();

  void slotUrlCopy();
  void slotSaveMessage();
  void update(MessageViewer::Viewer::UpdateMode updateMode = Viewer::Delayed);

  void slotZoomIn();
  void slotZoomOut();
  void slotZoomReset();
  void slotSpeakText();
  void slotCopyImageLocation();
  void slotSaveMessageDisplayFormat();
  void slotResetMessageDisplayFormat();
  void slotBlockImage();
  void slotOpenBlockableItems();
  void slotExpandShortUrl();
signals:
  void showStatusBarMessage( const QString &message );
  void replaceMsgByUnencryptedVersion();
  void popupMenu(const Akonadi::Item &msg, const KUrl &url, const KUrl &imageUrl, const QPoint& mousePos);
  void urlClicked( const Akonadi::Item &msg, const KUrl &url );
  void requestConfigSync();
  void showReader( KMime::Content* aMsgPart, bool aHTML, const QString & encoding );
  void showMessage( KMime::Message::Ptr message, const QString& encoding );
  void itemRemoved();
  void makeResourceOnline(MessageViewer::Viewer::ResourceOnlineMode mode);

  void changeDisplayMail(Viewer::ForceDisplayTo,bool);
  void moveMessageToTrash();
private:
  QString attachmentInjectionHtml() const;
  QString recipientsQuickListLinkHtml( bool, const QString & ) const;
  void initGrantleeThemeName();

public:
  NodeHelper* mNodeHelper;
  bool mHtmlMail, mHtmlLoadExternal, mHtmlOverride, mHtmlLoadExtOverride;
  KMime::Message::Ptr mMessage; //the current message, if it was set manually
  Akonadi::Item mMessageItem; //the message item from Akonadi
  // widgets:
  QSplitter * mSplitter;
  KHBox *mBox;
  HtmlStatusBar *mColorBar;
#ifndef QT_NO_TREEVIEW
  QTreeView* mMimePartTree; //FIXME(Andras) port the functionality from KMMimePartTree to a new view class or to here with signals/slots
#endif
  MimeTreeModel *mMimePartModel;
  MailWebView *mViewer;
  FindBarMailWebView *mFindBar;
  PimCommon::TranslatorWidget *mTranslatorWidget;

  const AttachmentStrategy * mAttachmentStrategy;
  HeaderStrategy * mHeaderStrategy;
  HeaderStyle * mHeaderStyle;
  static const int delay;
  QTimer mUpdateReaderWinTimer;
  QTimer mResizeTimer;
  QString mOverrideEncoding;
  QString mOldGlobalOverrideEncoding; // used to detect changes of the global override character encoding

  bool mMsgDisplay;

  CSSHelper * mCSSHelper;
  bool mUseFixedFont;
  bool mPrinting;
  QString mIdOfLastViewedMessage;
  QWidget *mMainWindow;
  KActionCollection *mActionCollection;
  KAction *mCopyAction, *mCopyURLAction,
      *mUrlOpenAction, *mSelectAllAction,
      *mScrollUpAction, *mScrollDownAction, *mScrollUpMoreAction, *mScrollDownMoreAction,
      *mViewSourceAction, *mSaveMessageAction, *mFindInMessageAction, *mSaveMessageDisplayFormat, *mResetMessageDisplayFormat;
  KToggleAction *mHeaderOnlyAttachmentsAction;
  KSelectAction *mSelectEncodingAction;
  KToggleAction *mToggleFixFontAction, *mToggleDisplayModeAction;
#ifndef KDEPIM_NO_WEBKIT
#if QTWEBKIT_VERSION >= QTWEBKIT_VERSION_CHECK(2, 3, 0)
  KToggleAction *mCaretBrowsing;
#endif
#endif
  KAction *mZoomTextOnlyAction, *mZoomInAction, *mZoomOutAction, *mZoomResetAction;
  KToggleAction *mToggleMimePartTreeAction;
  KAction *mSpeakTextAction;
  KAction *mCopyImageLocation;
  KAction *mTranslateAction;
  KAction *mBlockImage;
  KAction *mBlockableItems;
  KAction *mExpandUrlAction;
  KUrl mHoveredUrl;
  KUrl mClickedUrl;
  KUrl mImageUrl;
  QPoint mLastClickPosition;
  bool mCanStartDrag;
  HtmlWriter * mHtmlWriter;
  QPointer<WebKitPartHtmlWriter> mPartHtmlWriter;

  float mSavedRelativePosition;
  int mLevelQuote;
  bool mDecrytMessageOverwrite;
  bool mShowSignatureDetails;
  bool mShowAttachmentQuicklist;
  bool mShowRawToltecMail;
  bool mExternalWindow;
  bool mZoomTextOnly;
  int mRecursionCountForDisplayMessage;
  KMime::Content *mCurrentContent;
  KMime::Content *mMessagePartNode;
  QString mCurrentFileName;
  QString mMessagePath;
  QMap<EditorWatcher*, KMime::Content*> mEditorWatchers;
  Kleo::SpecialJob *mJob;
  Viewer *const q;
  bool mShowFullToAddressList;
  bool mShowFullCcAddressList;
  Akonadi::Monitor mMonitor;
  QString mAppName;
  QSet<AbstractMessageLoadedHandler*> mMessageLoadedHandlers;
  Akonadi::Item::Id mPreviouslyViewedItem;

  GrantleeTheme::GrantleeThemeManager *mThemeManager;
  ScamDetectionWarningWidget *mScamDetectionWarning;
  // zoom Factor
  static const qreal zoomBy;
  qreal mZoomFactor;
};

}

#endif