kmail/kmcommands.h

   1 // -*- mode: C++; c-file-style: "gnu" -*-
   2
   3 #ifndef KMCommands_h
   4 #define KMCommands_h
   5
   6 #include "kmail_export.h"
   7 #include <kmime/kmime_message.h>
   8 #include "messageviewer/viewer.h"
   9 #include "messageviewer/editorwatcher.h"
  10 #include "messageviewer/headerstrategy.h"
  11 #include "messageviewer/headerstyle.h"
  12 using MessageViewer::EditorWatcher;
  13 #include <akonadi/kmime/messagestatus.h>
  14 #include <messagelist/core/view.h>
  15 using Akonadi::MessageStatus;
  16 #include <kservice.h>
  17 #include <ktemporaryfile.h>
  18 #include <kio/job.h>
  19
  20 #include <QPointer>
  21 #include <QList>
  22 #include <akonadi/item.h>
  23 #include <akonadi/itemfetchscope.h>
  24 #include <akonadi/collection.h>
  25 class KProgressDialog;
  26 class KMMainWidget;
  27
  28 namespace MailCommon {
  29   class FolderCollection;
  30   class MailFilter;
  31 }
  32
  33 template <typename T> class QSharedPointer;
  34
  35 namespace KIO { class Job; }
  36 namespace KMail {
  37   class Composer;
  38 }
  39 namespace GpgME { class Error; }
  40 namespace Kleo { class SpecialJob; }
  41
  42 typedef QMap<KMime::Content*, Akonadi::Item> PartNodeMessageMap;
  43   /// Small helper structure which encapsulates the KMMessage created when creating a reply, and
  44
  45 class KMAIL_EXPORT KMCommand : public QObject
  46 {
  47   Q_OBJECT
  48
  49 public:
  50   enum Result { Undefined, OK, Canceled, Failed };
  51
  52   // Trival constructor, don't retrieve any messages
  53   KMCommand( QWidget *parent = 0 );
  54   KMCommand( QWidget *parent, const Akonadi::Item & );
  55   // Retrieve all messages in msgList when start is called.
  56   KMCommand( QWidget *parent, const QList<Akonadi::Item> &msgList );
  57   // Retrieve the single message msgBase when start is called.
  58   virtual ~KMCommand();
  59
  60
  61   /** Returns the result of the command. Only call this method from the slot
  62       connected to completed().
  63   */
  64   Result result() const;
  65
  66 public slots:
  67   // Retrieve messages then calls execute
  68   void start();
  69
  70 signals:
  71
  72   /// @param result The status of the command.
  73   void messagesTransfered( KMCommand::Result result );
  74
  75   /// Emitted when the command has completed.
  76   void completed( KMCommand *command );
  77
  78 protected:
  79   /** Allows to configure how much data should be retrieved of the messages. */
  80   Akonadi::ItemFetchScope& fetchScope() { return mFetchScope; }
  81
  82   // Returns list of messages retrieved
  83   const QList<Akonadi::Item> retrievedMsgs() const;
  84   // Returns the single message retrieved
  85   Akonadi::Item retrievedMessage() const;
  86   // Returns the parent widget
  87   QWidget *parentWidget() const;
  88
  89   bool deletesItself() const { return mDeletesItself; }
  90   /** Specify whether the subclass takes care of the deletion of the object.
  91       By default the base class will delete the object.
  92       @param deletesItself true if the subclass takes care of deletion, false
  93                            if the base class should take care of deletion
  94   */
  95   void setDeletesItself( bool deletesItself )
  96   { mDeletesItself = deletesItself; }
  97
  98   bool emitsCompletedItself() const { return mEmitsCompletedItself; }
  99   /** Specify whether the subclass takes care of emitting the completed()
 100       signal. By default the base class will emit this signal.
 101       @param emitsCompletedItself true if the subclass emits the completed
 102                                   signal, false if the base class should emit
 103                                   the signal
 104   */
 105   void setEmitsCompletedItself( bool emitsCompletedItself )
 106   { mEmitsCompletedItself = emitsCompletedItself; }
 107
 108   /** Use this to set the result of the command.
 109       @param result The result of the command.
 110    */
 111   void setResult( Result result )
 112   { mResult = result; }
 113
 114 private:
 115   // execute should be implemented by derived classes
 116   virtual Result execute() = 0;
 117
 118   /** transfers the list of (imap)-messages
 119    *  this is a necessary preparation for e.g. forwarding */
 120   void transferSelectedMsgs();
 121
 122 private slots:
 123   void slotPostTransfer( KMCommand::Result result );
 124   /** the msg has been transferred */
 125   void slotMsgTransfered(const Akonadi::Item::List& msgs);
 126   /** the KMImapJob is finished */
 127   void slotJobFinished();
 128   /** the transfer was canceled */
 129   void slotTransferCancelled();
 130
 131 protected:
 132   QList<Akonadi::Item> mRetrievedMsgs;
 133
 134 private:
 135   // ProgressDialog for transferring messages
 136   KProgressDialog* mProgressDialog;
 137   //Currently only one async command allowed at a time
 138   static int mCountJobs;
 139   int mCountMsgs;
 140   Result mResult;
 141   bool mDeletesItself : 1;
 142   bool mEmitsCompletedItself : 1;
 143
 144   QWidget *mParent;
 145   QList<Akonadi::Item> mMsgList;
 146   Akonadi::ItemFetchScope mFetchScope;
 147 };
 148
 149 class KMAIL_EXPORT KMMailtoComposeCommand : public KMCommand
 150 {
 151   Q_OBJECT
 152
 153 public:
 154   explicit KMMailtoComposeCommand( const KUrl &url, const Akonadi::Item &msg=Akonadi::Item() );
 155
 156 private:
 157   virtual Result execute();
 158
 159   KUrl mUrl;
 160   Akonadi::Item mMessage;
 161 };
 162
 163 class KMAIL_EXPORT KMMailtoReplyCommand : public KMCommand
 164 {
 165   Q_OBJECT
 166
 167 public:
 168   KMMailtoReplyCommand( QWidget *parent, const KUrl &url,
 169                         const Akonadi::Item &msg, const QString &selection );
 170
 171 private:
 172   virtual Result execute();
 173
 174   KUrl mUrl;
 175   QString mSelection;
 176 };
 177
 178 class KMAIL_EXPORT KMMailtoForwardCommand : public KMCommand
 179 {
 180   Q_OBJECT
 181
 182 public:
 183   KMMailtoForwardCommand( QWidget *parent, const KUrl &url,const Akonadi::Item& msg );
 184
 185 private:
 186   virtual Result execute();
 187
 188   KUrl mUrl;
 189 };
 190
 191 class KMAIL_EXPORT KMAddBookmarksCommand : public KMCommand
 192 {
 193   Q_OBJECT
 194
 195 public:
 196   KMAddBookmarksCommand( const KUrl &url, QWidget *parent );
 197
 198 private:
 199   virtual Result execute();
 200
 201   KUrl mUrl;
 202 };
 203
 204 class KMAIL_EXPORT KMUrlSaveCommand : public KMCommand
 205 {
 206   Q_OBJECT
 207
 208 public:
 209   KMUrlSaveCommand( const KUrl &url, QWidget *parent );
 210
 211 private slots:
 212   void slotUrlSaveResult( KJob *job );
 213
 214 private:
 215   virtual Result execute();
 216
 217   KUrl mUrl;
 218 };
 219
 220 class KMAIL_EXPORT KMEditMsgCommand : public KMCommand
 221 {
 222   Q_OBJECT
 223
 224 public:
 225   KMEditMsgCommand( QWidget *parent, const Akonadi::Item &msg, bool deleteFromSource = true );
 226 private slots:
 227   void slotDeleteItem( KJob *job );
 228 private:
 229   virtual Result execute();
 230   bool mDeleteFromSource;
 231 };
 232
 233 class KMAIL_EXPORT KMUseTemplateCommand : public KMCommand
 234 {
 235   Q_OBJECT
 236
 237 public:
 238   KMUseTemplateCommand( QWidget *parent, const Akonadi::Item &msg );
 239
 240 private:
 241   virtual Result execute();
 242 };
 243
 244 class KMAIL_EXPORT KMSaveMsgCommand : public KMCommand
 245 {
 246   Q_OBJECT
 247
 248 public:
 249   KMSaveMsgCommand( QWidget *parent, const QList<Akonadi::Item> &msgList );
 250   KMSaveMsgCommand( QWidget *parent, const Akonadi::Item & msg );
 251   KUrl url() const;
 252
 253 private:
 254   virtual Result execute();
 255
 256 private:
 257   KUrl mUrl;
 258 };
 259
 260 class KMAIL_EXPORT KMOpenMsgCommand : public KMCommand
 261 {
 262   Q_OBJECT
 263
 264 public:
 265   explicit KMOpenMsgCommand( QWidget *parent, const KUrl & url = KUrl(),
 266                              const QString & encoding = QString() );
 267
 268 private:
 269   virtual Result execute();
 270
 271 private slots:
 272   void slotDataArrived( KIO::Job *job, const QByteArray & data );
 273   void slotResult( KJob *job );
 274
 275 private:
 276   static const int MAX_CHUNK_SIZE = 64*1024;
 277   KUrl mUrl;
 278   QString mMsgString;
 279   KIO::TransferJob *mJob;
 280   const QString mEncoding;
 281 };
 282
 283 class KMAIL_EXPORT KMSaveAttachmentsCommand : public KMCommand
 284 {
 285   Q_OBJECT
 286 public:
 287   /** Use this to save all attachments of the given message.
 288       @param parent  The parent widget of the command used for message boxes.
 289       @param msg     The message of which the attachments should be saved.
 290    */
 291   KMSaveAttachmentsCommand( QWidget *parent, const Akonadi::Item &msg  );
 292   /** Use this to save all attachments of the given messages.
 293       @param parent  The parent widget of the command used for message boxes.
 294       @param msgs    The messages of which the attachments should be saved.
 295    */
 296   KMSaveAttachmentsCommand( QWidget *parent, const QList<Akonadi::Item>& msgs );
 297
 298 private:
 299   virtual Result execute();
 300 };
 301
 302 class KMAIL_EXPORT KMReplyToCommand : public KMCommand
 303 {
 304   Q_OBJECT
 305
 306 public:
 307   KMReplyToCommand( QWidget *parent, const Akonadi::Item &msg,
 308                     const QString &selection = QString() );
 309
 310 private:
 311   virtual Result execute();
 312
 313 private:
 314   QString mSelection;
 315 };
 316
 317 class KMAIL_EXPORT KMNoQuoteReplyToCommand : public KMCommand
 318 {
 319   Q_OBJECT
 320
 321 public:
 322   KMNoQuoteReplyToCommand( QWidget *parent, const Akonadi::Item &msg );
 323
 324 private:
 325   virtual Result execute();
 326 };
 327
 328 class KMReplyListCommand : public KMCommand
 329 {
 330   Q_OBJECT
 331
 332 public:
 333   KMReplyListCommand( QWidget *parent, const Akonadi::Item &msg,
 334                       const QString &selection = QString() );
 335
 336 private:
 337   virtual Result execute();
 338
 339 private:
 340   QString mSelection;
 341 };
 342
 343 class KMAIL_EXPORT KMReplyToAllCommand : public KMCommand
 344 {
 345   Q_OBJECT
 346
 347 public:
 348   KMReplyToAllCommand( QWidget *parent, const Akonadi::Item &msg,
 349                        const QString &selection = QString() );
 350
 351 private:
 352   virtual Result execute();
 353
 354 private:
 355   QString mSelection;
 356 };
 357
 358 class KMAIL_EXPORT KMReplyAuthorCommand : public KMCommand
 359 {
 360   Q_OBJECT
 361
 362 public:
 363   KMReplyAuthorCommand( QWidget *parent, const Akonadi::Item &msg,
 364                         const QString &selection = QString() );
 365
 366 private:
 367   virtual Result execute();
 368
 369 private:
 370   QString mSelection;
 371 };
 372
 373 class KMAIL_EXPORT KMForwardCommand : public KMCommand
 374 {
 375   Q_OBJECT
 376
 377 public:
 378   KMForwardCommand( QWidget *parent, const QList<Akonadi::Item> &msgList,
 379                     uint identity = 0 );
 380   KMForwardCommand( QWidget *parent, const Akonadi::Item& msg,
 381                     uint identity = 0 );
 382
 383 private:
 384   virtual Result execute();
 385
 386 private:
 387   uint mIdentity;
 388 };
 389
 390 class KMAIL_EXPORT KMForwardAttachedCommand : public KMCommand
 391 {
 392   Q_OBJECT
 393
 394 public:
 395   KMForwardAttachedCommand( QWidget *parent, const QList<Akonadi::Item> &msgList,
 396                             uint identity = 0, KMail::Composer *win = 0 );
 397   KMForwardAttachedCommand( QWidget *parent, const Akonadi::Item & msg,
 398                             uint identity = 0, KMail::Composer *win = 0 );
 399
 400 private:
 401   virtual Result execute();
 402
 403   uint mIdentity;
 404   QPointer<KMail::Composer> mWin;
 405 };
 406
 407 class KMAIL_EXPORT KMRedirectCommand : public KMCommand
 408 {
 409   Q_OBJECT
 410
 411 public:
 412   KMRedirectCommand( QWidget *parent, const Akonadi::Item &msg );
 413
 414 private:
 415   virtual Result execute();
 416 };
 417
 418 class KMAIL_EXPORT KMCustomReplyToCommand : public KMCommand
 419 {
 420   Q_OBJECT
 421
 422 public:
 423   KMCustomReplyToCommand( QWidget *parent, const Akonadi::Item &msg,
 424                           const QString &selection,
 425                           const QString &tmpl );
 426
 427 private:
 428   virtual Result execute();
 429
 430 private:
 431   QString mSelection;
 432   QString mTemplate;
 433 };
 434
 435 class KMAIL_EXPORT KMCustomReplyAllToCommand : public KMCommand
 436 {
 437   Q_OBJECT
 438
 439 public:
 440   KMCustomReplyAllToCommand( QWidget *parent, const Akonadi::Item &msg,
 441                           const QString &selection,
 442                           const QString &tmpl );
 443
 444 private:
 445   virtual Result execute();
 446
 447 private:
 448   QString mSelection;
 449   QString mTemplate;
 450 };
 451
 452 class KMAIL_EXPORT KMCustomForwardCommand : public KMCommand
 453 {
 454   Q_OBJECT
 455
 456 public:
 457   KMCustomForwardCommand( QWidget *parent, const QList<Akonadi::Item> &msgList,
 458                           uint identity, const QString &tmpl );
 459   KMCustomForwardCommand( QWidget *parent, const Akonadi::Item& msg,
 460                           uint identity, const QString &tmpl );
 461
 462 private:
 463   virtual Result execute();
 464
 465   uint mIdentity;
 466   QString mTemplate;
 467 };
 468
 469 class KMAIL_EXPORT KMPrintCommand : public KMCommand
 470 {
 471   Q_OBJECT
 472
 473 public:
 474   KMPrintCommand( QWidget *parent, const Akonadi::Item &msg,
 475                   MessageViewer::HeaderStyle *headerStyle = 0,
 476                   const MessageViewer::HeaderStrategy *headerStrategy = 0,
 477                   bool htmlOverride = false,
 478                   bool htmlLoadExtOverride = false,
 479                   bool useFixedFont = false,
 480                   const QString & encoding = QString() );
 481
 482   void setOverrideFont( const QFont& );
 483   void setAttachmentStrategy( const MessageViewer::AttachmentStrategy *strategy );
 484
 485 private:
 486   virtual Result execute();
 487
 488   MessageViewer::HeaderStyle *mHeaderStyle;
 489   const MessageViewer::HeaderStrategy *mHeaderStrategy;
 490   const MessageViewer::AttachmentStrategy *mAttachmentStrategy;
 491   bool mHtmlOverride;
 492   bool mHtmlLoadExtOverride;
 493   bool mUseFixedFont;
 494   QFont mOverrideFont;
 495   QString mEncoding;
 496 };
 497
 498 class KMAIL_EXPORT KMSetStatusCommand : public KMCommand
 499 {
 500   Q_OBJECT
 501
 502 public:
 503   // Serial numbers
 504   KMSetStatusCommand( const MessageStatus& status, const Akonadi::Item::List &items,
 505                       bool invert=false );
 506
 507 protected slots:
 508   void slotModifyItemDone( KJob * job );
 509
 510 private:
 511   virtual Result execute();
 512   MessageStatus mStatus;
 513   bool mInvertMark;
 514 };
 515
 516 /** This command is used to set or toggle a tag for a list of messages. If toggle is
 517     true then the tag is deleted if it is already applied.
 518  */
 519 class KMAIL_EXPORT KMSetTagCommand : public KMCommand
 520 {
 521   Q_OBJECT
 522
 523 public:
 524   enum SetTagMode { AddIfNotExisting, Toggle };
 525
 526   KMSetTagCommand( const QString &tagLabel, const QList<Akonadi::Item> &item,
 527                    SetTagMode mode=AddIfNotExisting );
 528
 529 private:
 530   virtual Result execute();
 531
 532   QString mTagLabel;
 533   QList<Akonadi::Item> mItem;
 534   SetTagMode mMode;
 535 };
 536
 537 /* This command is used to create a filter based on the user's
 538     decision, e.g. filter by From header */
 539 class KMAIL_EXPORT KMFilterCommand : public KMCommand
 540 {
 541   Q_OBJECT
 542
 543 public:
 544   KMFilterCommand( const QByteArray &field, const QString &value );
 545
 546 private:
 547   virtual Result execute();
 548
 549   QByteArray mField;
 550   QString mValue;
 551 };
 552
 553
 554 /* This command is used to apply a single filter (AKA ad-hoc filter)
 555     to a set of messages */
 556 class KMAIL_EXPORT KMFilterActionCommand : public KMCommand
 557 {
 558   Q_OBJECT
 559
 560 public:
 561   KMFilterActionCommand( QWidget *parent,
 562                          const QList<Akonadi::Item> &msgList, MailCommon::MailFilter *filter );
 563
 564 private:
 565   virtual Result execute();
 566   MailCommon::MailFilter *mFilter;
 567 };
 568
 569
 570 class KMAIL_EXPORT KMMetaFilterActionCommand : public QObject
 571 {
 572   Q_OBJECT
 573
 574 public:
 575   KMMetaFilterActionCommand( MailCommon::MailFilter *filter, KMMainWidget *main );
 576
 577 public slots:
 578   void start();
 579
 580 private:
 581   MailCommon::MailFilter *mFilter;
 582   KMMainWidget *mMainWidget;
 583 };
 584
 585
 586 class KMAIL_EXPORT KMMailingListFilterCommand : public KMCommand
 587 {
 588   Q_OBJECT
 589
 590 public:
 591   KMMailingListFilterCommand( QWidget *parent, const Akonadi::Item &msg );
 592
 593 private:
 594   virtual Result execute();
 595 };
 596
 597
 598 class KMAIL_EXPORT KMCopyCommand : public KMCommand
 599 {
 600   Q_OBJECT
 601
 602 public:
 603   KMCopyCommand( const Akonadi::Collection &destFolder, const QList<Akonadi::Item> &msgList );
 604   KMCopyCommand( const Akonadi::Collection& destFolder, const Akonadi::Item &msg );
 605
 606 protected slots:
 607   void slotCopyResult( KJob * job );
 608 private:
 609   virtual Result execute();
 610
 611   Akonadi::Collection mDestFolder;
 612   QList<Akonadi::Item> mMsgList;
 613 };
 614
 615 namespace KPIM {
 616   class ProgressItem;
 617 }
 618 class KMAIL_EXPORT KMMoveCommand : public KMCommand
 619 {
 620   Q_OBJECT
 621
 622 public:
 623   KMMoveCommand( const Akonadi::Collection& destFolder, const QList<Akonadi::Item> &msgList, MessageList::Core::MessageItemSetReference ref );
 624   KMMoveCommand( const Akonadi::Collection& destFolder, const Akonadi::Item & msg, MessageList::Core::MessageItemSetReference ref = MessageList::Core::MessageItemSetReference() );
 625   Akonadi::Collection destFolder() const { return mDestFolder; }
 626
 627   MessageList::Core::MessageItemSetReference refSet() const { return mRef; }
 628
 629 public slots:
 630   void slotMoveCanceled();
 631   void slotMoveResult( KJob * job );
 632 protected:
 633   void setDestFolder( const Akonadi::Collection& folder ) { mDestFolder = folder; }
 634
 635 signals:
 636   void moveDone( KMMoveCommand* );
 637
 638 private:
 639   virtual Result execute();
 640   void completeMove( Result result );
 641
 642   Akonadi::Collection mDestFolder;
 643   KPIM::ProgressItem *mProgressItem;
 644   MessageList::Core::MessageItemSetReference mRef;
 645   bool mCompleteWithAddedMsg;
 646 };
 647
 648 class KMAIL_EXPORT KMTrashMsgCommand : public KMMoveCommand
 649 {
 650   Q_OBJECT
 651
 652 public:
 653   KMTrashMsgCommand( const Akonadi::Collection& srcFolder, const QList<Akonadi::Item> &msgList,MessageList::Core::MessageItemSetReference ref );
 654   KMTrashMsgCommand( const Akonadi::Collection& srcFolder, const Akonadi::Item& msg,MessageList::Core::MessageItemSetReference ref );
 655
 656 private:
 657   static Akonadi::Collection findTrashFolder( const Akonadi::Collection& srcFolder );
 658
 659 };
 660
 661 class KMAIL_EXPORT KMResendMessageCommand : public KMCommand
 662 {
 663   Q_OBJECT
 664
 665 public:
 666   explicit KMResendMessageCommand( QWidget *parent, const Akonadi::Item & msg= Akonadi::Item() );
 667
 668 private:
 669   virtual Result execute();
 670 };
 671
 672 // TODO: Remove this class. There is no reason why the mailing list stuff should be based
 673 //       on KMCommand, they should instead be utilty methods.
 674 class KMAIL_EXPORT KMMailingListCommand : public KMCommand
 675 {
 676   Q_OBJECT
 677 public:
 678   KMMailingListCommand( QWidget *parent, const QSharedPointer<MailCommon::FolderCollection> &parentFolder );
 679 private:
 680   virtual Result execute();
 681 protected:
 682   virtual KUrl::List urls() const =0;
 683 protected:
 684   QSharedPointer<MailCommon::FolderCollection> mFolder;
 685 };
 686
 687 class KMAIL_EXPORT KMMailingListPostCommand : public KMMailingListCommand
 688 {
 689   Q_OBJECT
 690 public:
 691   KMMailingListPostCommand( QWidget *parent, const QSharedPointer<MailCommon::FolderCollection> &parentFolder );
 692 protected:
 693   virtual KUrl::List urls() const;
 694 };
 695
 696 class KMAIL_EXPORT KMMailingListSubscribeCommand : public KMMailingListCommand
 697 {
 698   Q_OBJECT
 699 public:
 700   KMMailingListSubscribeCommand( QWidget *parent, const QSharedPointer<MailCommon::FolderCollection> &parentFolder );
 701 protected:
 702   virtual KUrl::List urls() const;
 703 };
 704
 705 class KMAIL_EXPORT KMMailingListUnsubscribeCommand : public KMMailingListCommand
 706 {
 707   Q_OBJECT
 708 public:
 709   KMMailingListUnsubscribeCommand( QWidget *parent, const QSharedPointer<MailCommon::FolderCollection> &parentFolder );
 710 protected:
 711   virtual KUrl::List urls() const;
 712 };
 713
 714 class KMAIL_EXPORT KMMailingListArchivesCommand : public KMMailingListCommand
 715 {
 716   Q_OBJECT
 717 public:
 718   KMMailingListArchivesCommand( QWidget *parent, const QSharedPointer<MailCommon::FolderCollection> &parentFolder );
 719 protected:
 720   virtual KUrl::List urls() const;
 721 };
 722
 723 class KMAIL_EXPORT KMMailingListHelpCommand : public KMMailingListCommand
 724 {
 725   Q_OBJECT
 726 public:
 727   KMMailingListHelpCommand( QWidget *parent, const QSharedPointer<MailCommon::FolderCollection> &parentFolder );
 728 protected:
 729   virtual KUrl::List urls() const;
 730 };
 731
 732 #endif /*KMCommands_h*/