/*******************************************************************************
**
** Filename   : util
** Created on : 03 April, 2005
** Copyright  : (c) 2005 Till Adam
** Email      : <adam@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.
**
**   It 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
**
**   In addition, as a special exception, the copyright holders give
**   permission to link the code of this program with any edition of
**   the Qt library by Trolltech AS, Norway (or with modified versions
**   of Qt that use the same license as Qt), and distribute linked
**   combinations including the two.  You must obey the GNU General
**   Public License in all respects for all of the code used other than
**   Qt.  If you modify this file, you may extend this exception to
**   your version of the file, but you are not obligated to do so.  If
**   you do not wish to do so, delete this exception statement from
**   your version.
**
*******************************************************************************/
#ifndef MAILVIEWERUTIL_H
#define MAILVIEWERUTIL_H

#include "messageviewer_export.h"
#include "kmime/kmime_content.h"
#include <QString>

class KUrl;
class QWidget;
class QStringList;

namespace KMime {
  class Content;
  class Message;
}

namespace Akonadi {
  class Item;
}

namespace MessageViewer {

/**
 * The Util namespace contains a collection of helper functions use in
 * various places.
 */
namespace Util {

    /**
      * Describes the type of the displayed message. This depends on the MIME structure
      * of the mail and on whether HTML mode is enabled (which is decided by htmlMail())
      */
    enum HtmlMode {
      Normal,         ///< A normal plaintext message, non-multipart
      Html,           ///< A HTML message, non-multipart
      MultipartPlain, ///< A multipart/alternative message, the plain text part is currently displayed
      MultipartHtml   ///< A multipart/altervative message, the HTML part is currently displayed
    };

    // return true if we should proceed, false if we should abort
    bool MESSAGEVIEWER_EXPORT checkOverwrite( const KUrl &url, QWidget *w );

    /**
     * Delegates opening a URL to the QDesktopServices mechanisms for that
     * on Windows and MacOSX.
     * Returns false if it did nothing (such as on other platforms).
     */
    bool MESSAGEVIEWER_EXPORT handleUrlWithQDesktopServices( const KUrl& url );

    /**
     * evaluates GlobalSettings->disregardUmask()
     * and returns resulting permissions for storing files
     * @return specific file permissions or -1 for default permissions
     */
    int MESSAGEVIEWER_EXPORT getWritePermissions();

    QList<KMime::Content*> MESSAGEVIEWER_EXPORT allContents( const KMime::Content *message );
    QList<KMime::Content*> MESSAGEVIEWER_EXPORT extractAttachments( const KMime::Message *message );
    bool MESSAGEVIEWER_EXPORT saveContents( QWidget *parent,
                                            const QList<KMime::Content*> &contents );
    bool MESSAGEVIEWER_EXPORT saveContent( QWidget *parent, KMime::Content* content,
                                           const KUrl& url );

    /**
     * Finds the filename of an icon based on the given mimetype or filenames.
     *
     * Always use this functions when looking up icon names for mime types, don't use
     * KMimeType directly.
     *
     * Uses the IconNameCache internally to speed things up.
     *
     * @param mimeType The primary mime type used to find the icon, e.g. "application/zip". Alias
     *                 mimetypes are resolved.
     * @param size Size of the requested icon, e.g. KIconLoader::Desktop
     * @param fallbackFileName(1|2) When the icon is not found by the given mime type, use the file
     *                              name extensions of these file names to look the icon up.
     *                              Example: "test.zip"
     * @return the full file name of the icon file
     */
    QString MESSAGEVIEWER_EXPORT fileNameForMimetype( const QString &mimeType, int iconSize,
                                 const QString &fallbackFileName1 = QString(),
                                 const QString &fallbackFileName2 = QString() );
    bool MESSAGEVIEWER_EXPORT saveMessageInMbox( const QList<Akonadi::Item>& retrievedMsgs, QWidget*parent, bool appendMessages = false);

    bool MESSAGEVIEWER_EXPORT saveAttachments( const KMime::Content::List& contents, QWidget *parent ); 

    bool MESSAGEVIEWER_EXPORT speakSelectedText( const QString& text, QWidget *parent);

}

}

#endif
