/*
  This file is part of the kcalutils library.

  Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org>
  Copyright (c) 2004 Reinhold Kainhofer <reinhold@kainhofer.com>
  Copyright (c) 2005 Rafal Rzepecki <divide@users.sourceforge.net>
  Copyright (c) 2009-2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.net>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  This library 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
  Library General Public License for more details.

  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
*/
/**
  @file
  This file is part of the API for handling calendar data and provides
  static functions for formatting Incidences for various purposes.

  @brief
  Provides methods to format Incidences in various ways for display purposes.

  @author Cornelius Schumacher \<schumacher@kde.org\>
  @author Reinhold Kainhofer \<reinhold@kainhofer.com\>
  @author Allen Winter \<allen@kdab.com\>
*/
#include "incidenceformatter.h"
#include "stringify.h"

#include <kcalcore/event.h>
#include <kcalcore/freebusy.h>
#include <kcalcore/icalformat.h>
#include <kcalcore/journal.h>
#include <kcalcore/memorycalendar.h>
#include <kcalcore/todo.h>
#include <kcalcore/visitor.h>
using namespace KCalCore;

#include <kpimutils/email.h>

#include <KCalendarSystem>
#include <KDebug>
#include <KEMailSettings>
#include <KIconLoader>
#include <KLocale>
#include <KMimeType>
#include <KSystemTimeZone>

#include <QtCore/QBitArray>
#include <QtGui/QApplication>
#include <QtGui/QPalette>
#include <QtGui/QTextDocument>

using namespace KCalUtils;
using namespace IncidenceFormatter;

/*******************
 *  General helpers
 *******************/

//@cond PRIVATE
static QString htmlAddLink( const QString &ref, const QString &text,
                            bool newline = true )
{
  QString tmpStr( "<a href=\"" + ref + "\">" + text + "</a>" );
  if ( newline ) {
    tmpStr += '\n';
  }
  return tmpStr;
}

static QString htmlAddMailtoLink( const QString &email, const QString &name )
{
  QString str;

  if ( !email.isEmpty() ) {
    Person person( name, email );
    KUrl mailto;
    mailto.setProtocol( "mailto" );
    mailto.setPath( person.fullName() );
    const QString iconPath =
      KIconLoader::global()->iconPath( "mail-message-new", KIconLoader::Small );
    str = htmlAddLink( mailto.url(), "<img valign=\"top\" src=\"" + iconPath + "\">" );
  }
  return str;
}

static QString htmlAddUidLink( const QString &email, const QString &name, const QString &uid )
{
  QString str;

  if ( !uid.isEmpty() ) {
    // There is a UID, so make a link to the addressbook
    if ( name.isEmpty() ) {
      // Use the email address for text
      str += htmlAddLink( "uid:" + uid, email );
    } else {
      str += htmlAddLink( "uid:" + uid, name );
    }
  }
  return str;
}

static QString htmlAddTag( const QString &tag, const QString &text )
{
  int numLineBreaks = text.count( "\n" );
  QString str = '<' + tag + '>';
  QString tmpText = text;
  QString tmpStr = str;
  if( numLineBreaks >= 0 ) {
    if ( numLineBreaks > 0 ) {
      int pos = 0;
      QString tmp;
      for ( int i = 0; i <= numLineBreaks; ++i ) {
        pos = tmpText.indexOf( "\n" );
        tmp = tmpText.left( pos );
        tmpText = tmpText.right( tmpText.length() - pos - 1 );
        tmpStr += tmp + "<br>";
      }
    } else {
      tmpStr += tmpText;
    }
  }
  tmpStr += "</" + tag + '>';
  return tmpStr;
}

static QPair<QString, QString> searchNameAndUid( const QString &email, const QString &name,
                                                 const QString &uid )
{
  // Yes, this is a silly method now, but it's predecessor was quite useful in e35.
  // For now, please keep this sillyness until e35 is frozen to ease forward porting.
  // -Allen
  QPair<QString, QString>s;
  s.first = name;
  s.second = uid;
  if ( !email.isEmpty() && ( name.isEmpty() || uid.isEmpty() ) ) {
    s.second.clear();
  }
  return s;
}

static QString searchName( const QString &email, const QString &name )
{
  const QString printName = name.isEmpty() ? email : name;
  return printName;
}

static bool iamAttendee( Attendee::Ptr attendee )
{
  // Check if I'm this attendee

  bool iam = false;
  KEMailSettings settings;
  QStringList profiles = settings.profiles();
  for ( QStringList::Iterator it=profiles.begin(); it != profiles.end(); ++it ) {
    settings.setProfile( *it );
    if ( settings.getSetting( KEMailSettings::EmailAddress ) == attendee->email() ) {
      iam = true;
      break;
    }
  }
  return iam;
}

static bool iamOrganizer( Incidence::Ptr incidence )
{
  // Check if I'm the organizer for this incidence

  if ( !incidence ) {
    return false;
  }

  bool iam = false;
  KEMailSettings settings;
  QStringList profiles = settings.profiles();
  for ( QStringList::Iterator it=profiles.begin(); it != profiles.end(); ++it ) {
    settings.setProfile( *it );
    if ( settings.getSetting( KEMailSettings::EmailAddress ) == incidence->organizer()->email() ) {
      iam = true;
      break;
    }
  }
  return iam;
}

static bool senderIsOrganizer( Incidence::Ptr incidence, const QString &sender )
{
  // Check if the specified sender is the organizer

  if ( !incidence || sender.isEmpty() ) {
    return true;
  }

  bool isorg = true;
  QString senderName, senderEmail;
  if ( KPIMUtils::extractEmailAddressAndName( sender, senderEmail, senderName ) ) {
    // for this heuristic, we say the sender is the organizer if either the name or the email match.
    if ( incidence->organizer()->email() != senderEmail &&
         incidence->organizer()->name() != senderName ) {
      isorg = false;
    }
  }
  return isorg;
}

static bool attendeeIsOrganizer( const Incidence::Ptr &incidence, const Attendee::Ptr &attendee )
{
  if ( incidence && attendee &&
       ( incidence->organizer()->email() == attendee->email() ) ) {
    return true;
  } else {
    return false;
  }
}

static QString organizerName( const Incidence::Ptr incidence, const QString &defName )
{
  QString tName;
  if ( !defName.isEmpty() ) {
    tName = defName;
  } else {
    tName = i18n( "Organizer Unknown" );
  }

  QString name;
  if ( incidence ) {
    name = incidence->organizer()->name();
    if ( name.isEmpty() ) {
      name = incidence->organizer()->email();
    }
  }
  if ( name.isEmpty() ) {
    name = tName;
  }
  return name;
}

static QString firstAttendeeName( const Incidence::Ptr &incidence, const QString &defName )
{
  QString tName;
  if ( !defName.isEmpty() ) {
    tName = defName;
  } else {
    tName = i18n( "Sender" );
  }

  QString name;
  if ( incidence ) {
    Attendee::List attendees = incidence->attendees();
    if( attendees.count() > 0 ) {
      Attendee::Ptr attendee = *attendees.begin();
      name = attendee->name();
      if ( name.isEmpty() ) {
        name = attendee->email();
      }
    }
  }
  if ( name.isEmpty() ) {
    name = tName;
  }
  return name;
}

static QString rsvpStatusIconPath( Attendee::PartStat status )
{
  QString iconPath;
  switch ( status ) {
  case Attendee::Accepted:
    iconPath = KIconLoader::global()->iconPath( "dialog-ok-apply", KIconLoader::Small );
    break;
  case Attendee::Declined:
    iconPath = KIconLoader::global()->iconPath( "dialog-cancel", KIconLoader::Small );
    break;
  case Attendee::NeedsAction:
    iconPath = KIconLoader::global()->iconPath( "help-about", KIconLoader::Small );
    break;
  case Attendee::InProcess:
    iconPath = KIconLoader::global()->iconPath( "help-about", KIconLoader::Small );
    break;
  case Attendee::Tentative:
    iconPath = KIconLoader::global()->iconPath( "dialog-ok", KIconLoader::Small );
    break;
  case Attendee::Delegated:
    iconPath = KIconLoader::global()->iconPath( "mail-forward", KIconLoader::Small );
    break;
  case Attendee::Completed:
    iconPath = KIconLoader::global()->iconPath( "mail-mark-read", KIconLoader::Small );
  default:
    break;
  }
  return iconPath;
}

//@endcond

/*******************************************************************
 *  Helper functions for the extensive display (display viewer)
 *******************************************************************/

//@cond PRIVATE
static QString displayViewFormatPerson( const QString &email, const QString &name,
                                        const QString &uid, const QString &iconPath )
{
  // Search for new print name or uid, if needed.
  QPair<QString, QString> s = searchNameAndUid( email, name, uid );
  const QString printName = s.first;
  const QString printUid = s.second;

  QString personString;
  if ( !iconPath.isEmpty() ) {
    personString += "<img valign=\"top\" src=\"" + iconPath + "\">" + "&nbsp;";
  }

  // Make the uid link
  if ( !printUid.isEmpty() ) {
    personString += htmlAddUidLink( email, printName, printUid );
  } else {
    // No UID, just show some text
    personString += ( printName.isEmpty() ? email : printName );
  }

#ifndef KDEPIM_MOBILE_UI
  // Make the mailto link
  if ( !email.isEmpty() ) {
    personString += "&nbsp;" + htmlAddMailtoLink( email, printName );
  }
#endif

  return personString;
}

static QString displayViewFormatPerson( const QString &email, const QString &name,
                                        const QString &uid, Attendee::PartStat status )
{
  return displayViewFormatPerson( email, name, uid, rsvpStatusIconPath( status ) );
}

static bool incOrganizerOwnsCalendar( const Calendar::Ptr &calendar,
                                      const Incidence::Ptr &incidence )
{
  //PORTME!  Look at e35's CalHelper::incOrganizerOwnsCalendar

  // For now, use iamOrganizer() which is only part of the check
  Q_UNUSED( calendar );
  return iamOrganizer( incidence );
}

static QString displayViewFormatAttendeeRoleList( Incidence::Ptr incidence, Attendee::Role role,
                                                  bool showStatus )
{
  QString tmpStr;
  Attendee::List::ConstIterator it;
  Attendee::List attendees = incidence->attendees();

  for ( it = attendees.constBegin(); it != attendees.constEnd(); ++it ) {
    Attendee::Ptr a = *it;
    if ( a->role() != role ) {
      // skip this role
      continue;
    }
    if ( attendeeIsOrganizer( incidence, a ) ) {
      // skip attendee that is also the organizer
      continue;
    }
    tmpStr += displayViewFormatPerson( a->email(), a->name(), a->uid(),
                                       showStatus ? a->status() : Attendee::None );
    if ( !a->delegator().isEmpty() ) {
      tmpStr += i18n( " (delegated by %1)", a->delegator() );
    }
    if ( !a->delegate().isEmpty() ) {
      tmpStr += i18n( " (delegated to %1)", a->delegate() );
    }
    tmpStr += "<br>";
  }
  if ( tmpStr.endsWith( QLatin1String( "<br>" ) ) ) {
    tmpStr.chop( 4 );
  }
  return tmpStr;
}

static QString displayViewFormatAttendees( Calendar::Ptr calendar, Incidence::Ptr incidence )
{
  QString tmpStr, str;

  // Add organizer link
  int attendeeCount = incidence->attendees().count();
  if ( attendeeCount > 1 ||
       ( attendeeCount == 1 &&
         !attendeeIsOrganizer( incidence, incidence->attendees().first() ) ) ) {

    QPair<QString, QString> s = searchNameAndUid( incidence->organizer()->email(),
                                                  incidence->organizer()->name(),
                                                  QString() );
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Organizer:" ) + "</b></td>";
    const QString iconPath =
      KIconLoader::global()->iconPath( "meeting-organizer", KIconLoader::Small );
    tmpStr += "<td>" + displayViewFormatPerson( incidence->organizer()->email(),
                                                s.first, s.second, iconPath ) +
              "</td>";
    tmpStr += "</tr>";
  }

  // Show the attendee status if the incidence's organizer owns the resource calendar,
  // which means they are running the show and have all the up-to-date response info.
  bool showStatus = incOrganizerOwnsCalendar( calendar, incidence );

  // Add "chair"
  str = displayViewFormatAttendeeRoleList( incidence, Attendee::Chair, showStatus );
  if ( !str.isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Chair:" ) + "</b></td>";
    tmpStr += "<td>" + str + "</td>";
    tmpStr += "</tr>";
  }

  // Add required participants
  str = displayViewFormatAttendeeRoleList( incidence, Attendee::ReqParticipant, showStatus );
  if ( !str.isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Required Participants:" ) + "</b></td>";
    tmpStr += "<td>" + str + "</td>";
    tmpStr += "</tr>";
  }

  // Add optional participants
  str = displayViewFormatAttendeeRoleList( incidence, Attendee::OptParticipant, showStatus );
  if ( !str.isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Optional Participants:" ) + "</b></td>";
    tmpStr += "<td>" + str + "</td>";
    tmpStr += "</tr>";
  }

  // Add observers
  str = displayViewFormatAttendeeRoleList( incidence, Attendee::NonParticipant, showStatus );
  if ( !str.isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Observers:" ) + "</b></td>";
    tmpStr += "<td>" + str + "</td>";
    tmpStr += "</tr>";
  }

  return tmpStr;
}

static QString displayViewFormatAttachments( Incidence::Ptr incidence )
{
  QString tmpStr;
  Attachment::List as = incidence->attachments();
  Attachment::List::ConstIterator it;
  int count = 0;
  for ( it = as.constBegin(); it != as.constEnd(); ++it ) {
    count++;
    if ( (*it)->isUri() ) {
      QString name;
      if ( (*it)->uri().startsWith( QLatin1String( "kmail:" ) ) ) {
        name = i18n( "Show mail" );
      } else {
        if ( (*it)->label().isEmpty() ) {
          name = (*it)->uri();
        } else {
          name = (*it)->label();
        }
      }
      tmpStr += htmlAddLink( (*it)->uri(), name );
    } else {
      tmpStr += (*it)->label();
    }
    if ( count < as.count() ) {
      tmpStr += "<br>";
    }
  }
  return tmpStr;
}

static QString displayViewFormatCategories( Incidence::Ptr incidence )
{
  // We do not use Incidence::categoriesStr() since it does not have whitespace
  return incidence->categories().join( ", " );
}

static QString displayViewFormatCreationDate( Incidence::Ptr incidence, KDateTime::Spec spec )
{
  KDateTime kdt = incidence->created().toTimeSpec( spec );
  return i18n( "Creation date: %1", dateTimeToString( incidence->created(), false, true, spec ) );
}

static QString displayViewFormatBirthday( Event::Ptr event )
{
  if ( !event ) {
    return QString();
  }
  if ( event->customProperty( "KABC", "BIRTHDAY" ) != "YES" &&
       event->customProperty( "KABC", "ANNIVERSARY" ) != "YES" ) {
    return QString();
  }

  QString uid_1 = event->customProperty( "KABC", "UID-1" );
  QString name_1 = event->customProperty( "KABC", "NAME-1" );
  QString email_1= event->customProperty( "KABC", "EMAIL-1" );

  QString tmpStr = displayViewFormatPerson( email_1, name_1, uid_1, QString() );
  return tmpStr;
}

static QString displayViewFormatHeader( Incidence::Ptr incidence )
{
  QString tmpStr = "<table><tr>";

  // show icons
  KIconLoader *iconLoader = KIconLoader::global();
  tmpStr += "<td>";

  QString iconPath;
  if ( incidence->customProperty( "KABC", "BIRTHDAY" ) == "YES" ) {
    iconPath = iconLoader->iconPath( "view-calendar-birthday", KIconLoader::Small );
  } else if ( incidence->customProperty( "KABC", "ANNIVERSARY" ) == "YES" ) {
    iconPath = iconLoader->iconPath( "view-calendar-wedding-anniversary", KIconLoader::Small );
  } else {
    iconPath = iconLoader->iconPath( incidence->iconName(), KIconLoader::Small );
  }
  tmpStr += "<img valign=\"top\" src=\"" + iconPath + "\">";

  if ( incidence->hasEnabledAlarms() ) {
    tmpStr += "<img valign=\"top\" src=\"" +
              iconLoader->iconPath( "preferences-desktop-notification-bell", KIconLoader::Small ) +
              "\">";
  }
  if ( incidence->recurs() ) {
    tmpStr += "<img valign=\"top\" src=\"" +
              iconLoader->iconPath( "edit-redo", KIconLoader::Small ) +
              "\">";
  }
  if ( incidence->isReadOnly() ) {
    tmpStr += "<img valign=\"top\" src=\"" +
              iconLoader->iconPath( "object-locked", KIconLoader::Small ) +
              "\">";
  }
  tmpStr += "</td>";

  tmpStr += "<td>";
  tmpStr += "<b><u>" + incidence->richSummary() + "</u></b>";
  tmpStr += "</td>";

  tmpStr += "</tr></table>";

  return tmpStr;
}

static QString displayViewFormatEvent( const Calendar::Ptr calendar, const QString &sourceName,
                                       const Event::Ptr &event,
                                       const QDate &date, KDateTime::Spec spec )
{
  if ( !event ) {
    return QString();
  }

  QString tmpStr = displayViewFormatHeader( event );

  tmpStr += "<table>";
  tmpStr += "<col width=\"25%\"/>";
  tmpStr += "<col width=\"75%\"/>";

  const QString calStr = calendar ? resourceString( calendar, event ) : sourceName;
  if ( !calStr.isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Calendar:" ) + "</b></td>";
    tmpStr += "<td>" + calStr + "</td>";
    tmpStr += "</tr>";
  }

  if ( !event->location().isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Location:" ) + "</b></td>";
    tmpStr += "<td>" + event->richLocation() + "</td>";
    tmpStr += "</tr>";
  }

  KDateTime startDt = event->dtStart();
  KDateTime endDt = event->dtEnd();
  if ( event->recurs() ) {
    if ( date.isValid() ) {
      KDateTime kdt( date, QTime( 0, 0, 0 ), KSystemTimeZones::local() );
      int diffDays = startDt.daysTo( kdt );
      kdt = kdt.addSecs( -1 );
      startDt.setDate( event->recurrence()->getNextDateTime( kdt ).date() );
      if ( event->hasEndDate() ) {
        endDt = endDt.addDays( diffDays );
        if ( startDt > endDt ) {
          startDt.setDate( event->recurrence()->getPreviousDateTime( kdt ).date() );
          endDt = startDt.addDays( event->dtStart().daysTo( event->dtEnd() ) );
        }
      }
    }
  }

  tmpStr += "<tr>";
  if ( event->allDay() ) {
    if ( event->isMultiDay() ) {
      tmpStr += "<td><b>" + i18n( "Date:" ) + "</b></td>";
      tmpStr += "<td>" +
                i18nc( "<beginTime> - <endTime>","%1 - %2",
                       dateToString( startDt, false, spec ),
                       dateToString( endDt, false, spec ) ) +
                "</td>";
    } else {
      tmpStr += "<td><b>" + i18n( "Date:" ) + "</b></td>";
      tmpStr += "<td>" +
                i18nc( "date as string","%1",
                       dateToString( startDt, false, spec ) ) +
                "</td>";
    }
  } else {
    if ( event->isMultiDay() ) {
      tmpStr += "<td><b>" + i18n( "Date:" ) + "</b></td>";
      tmpStr += "<td>" +
                i18nc( "<beginTime> - <endTime>","%1 - %2",
                       dateToString( startDt, false, spec ),
                       dateToString( endDt, false, spec ) ) +
                "</td>";
    } else {
      tmpStr += "<td><b>" + i18n( "Date:" ) + "</b></td>";
      tmpStr += "<td>" +
                i18nc( "date as string", "%1",
                       dateToString( startDt, false, spec ) ) +
                "</td>";

      tmpStr += "</tr><tr>";
      tmpStr += "<td><b>" + i18n( "Time:" ) + "</b></td>";
      if ( event->hasEndDate() && startDt != endDt ) {
        tmpStr += "<td>" +
                  i18nc( "<beginTime> - <endTime>","%1 - %2",
                         timeToString( startDt, true, spec ),
                         timeToString( endDt, true, spec ) ) +
                  "</td>";
      } else {
        tmpStr += "<td>" +
                  timeToString( startDt, true, spec ) +
                  "</td>";
      }
    }
  }
  tmpStr += "</tr>";

  QString durStr = durationString( event );
  if ( !durStr.isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Duration:" ) + "</b></td>";
    tmpStr += "<td>" + durStr + "</td>";
    tmpStr += "</tr>";
  }

  if ( event->recurs() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Recurrence:" ) + "</b></td>";
    tmpStr += "<td>" +
              recurrenceString( event ) +
              "</td>";
    tmpStr += "</tr>";
  }

  const bool isBirthday = event->customProperty( "KABC", "BIRTHDAY" ) == "YES";
  const bool isAnniversary = event->customProperty( "KABC", "ANNIVERSARY" ) == "YES";

  if ( isBirthday || isAnniversary ) {
    tmpStr += "<tr>";
    if ( isAnniversary ) {
      tmpStr += "<td><b>" + i18n( "Anniversary:" ) + "</b></td>";
    } else {
      tmpStr += "<td><b>" + i18n( "Birthday:" ) + "</b></td>";
    }
    tmpStr += "<td>" + displayViewFormatBirthday( event ) + "</td>";
    tmpStr += "</tr>";
    tmpStr += "</table>";
    return tmpStr;
  }

  if ( !event->description().isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Description:" ) + "</b></td>";
    tmpStr += "<td>" + event->richDescription() + "</td>";
    tmpStr += "</tr>";
  }

  // TODO: print comments?

  int reminderCount = event->alarms().count();
  if ( reminderCount > 0 && event->hasEnabledAlarms() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" +
              i18np( "Reminder:", "Reminders:", reminderCount ) +
              "</b></td>";
    tmpStr += "<td>" + reminderStringList( event ).join( "<br>" ) + "</td>";
    tmpStr += "</tr>";
  }

  tmpStr += displayViewFormatAttendees( calendar, event );

  int categoryCount = event->categories().count();
  if ( categoryCount > 0 ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>";
    tmpStr += i18np( "Category:", "Categories:", categoryCount ) +
              "</b></td>";
    tmpStr += "<td>" + displayViewFormatCategories( event ) + "</td>";
    tmpStr += "</tr>";
  }

  int attachmentCount = event->attachments().count();
  if ( attachmentCount > 0 ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" +
              i18np( "Attachment:", "Attachments:", attachmentCount ) +
              "</b></td>";
    tmpStr += "<td>" + displayViewFormatAttachments( event ) + "</td>";
    tmpStr += "</tr>";
  }
  tmpStr += "</table>";

  tmpStr += "<p><em>" + displayViewFormatCreationDate( event, spec ) + "</em>";

  return tmpStr;
}

static QString displayViewFormatTodo( const Calendar::Ptr &calendar, const QString &sourceName,
                                      const Todo::Ptr &todo,
                                      const QDate &date, KDateTime::Spec spec )
{
  if ( !todo ) {
    kDebug() << "IncidenceFormatter::displayViewFormatTodo was called without to-do, quiting";
    return QString();
  }

  QString tmpStr = displayViewFormatHeader( todo );

  tmpStr += "<table>";
  tmpStr += "<col width=\"25%\"/>";
  tmpStr += "<col width=\"75%\"/>";

  const QString calStr = calendar ? resourceString( calendar, todo ) : sourceName;
  if ( !calStr.isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Calendar:" ) + "</b></td>";
    tmpStr += "<td>" + calStr + "</td>";
    tmpStr += "</tr>";
  }

  if ( !todo->location().isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Location:" ) + "</b></td>";
    tmpStr += "<td>" + todo->richLocation() + "</td>";
    tmpStr += "</tr>";
  }

  const bool hastStartDate = todo->hasStartDate() && todo->dtStart().isValid();
  const bool hasDueDate = todo->hasDueDate() && todo->dtDue().isValid();

  if ( hastStartDate ) {
    KDateTime startDt = todo->dtStart( true /**first*/ );
    if ( todo->recurs() ) {
      if ( date.isValid() ) {
        if ( hasDueDate ) {
          // In kdepim all recuring to-dos have due date.
          const int length = startDt.daysTo( todo->dtDue( true /**first*/ ) );
          if ( length >= 0 ) {
            startDt.setDate( date.addDays( -length ) );
          } else {
            kError() << "DTSTART is bigger than DTDUE, todo->uid() is " << todo->uid();
            startDt.setDate( date );
          }
        } else {
          kError() << "To-do is recurring but has no DTDUE set, todo->uid() is " << todo->uid();
          startDt.setDate( date );
        }
      }
    }
    tmpStr += "<tr>";
    tmpStr += "<td><b>" +
              i18nc( "to-do start date/time", "Start:" ) +
              "</b></td>";
    tmpStr += "<td>" +
              dateTimeToString( startDt, todo->allDay(), false, spec ) +
              "</td>";
    tmpStr += "</tr>";
  }

  if ( hasDueDate ) {
    KDateTime dueDt = todo->dtDue();
    if ( todo->recurs() ) {
      if ( date.isValid() ) {
        KDateTime kdt( date, QTime( 0, 0, 0 ), KSystemTimeZones::local() );
        kdt = kdt.addSecs( -1 );
        dueDt.setDate( todo->recurrence()->getNextDateTime( kdt ).date() );
      }
    }
    tmpStr += "<tr>";
    tmpStr += "<td><b>" +
              i18nc( "to-do due date/time", "Due:" ) +
              "</b></td>";
    tmpStr += "<td>" +
              dateTimeToString( dueDt, todo->allDay(), false, spec ) +
              "</td>";
    tmpStr += "</tr>";
  }

  QString durStr = durationString( todo );
  if ( !durStr.isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Duration:" ) + "</b></td>";
    tmpStr += "<td>" + durStr + "</td>";
    tmpStr += "</tr>";
  }

  if ( todo->recurs() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Recurrence:" ) + "</b></td>";
    tmpStr += "<td>" +
              recurrenceString( todo ) +
              "</td>";
    tmpStr += "</tr>";
  }

  if ( !todo->description().isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Description:" ) + "</b></td>";
    tmpStr += "<td>" + todo->richDescription() + "</td>";
    tmpStr += "</tr>";
  }

  // TODO: print comments?

  int reminderCount = todo->alarms().count();
  if ( reminderCount > 0 && todo->hasEnabledAlarms() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" +
              i18np( "Reminder:", "Reminders:", reminderCount ) +
              "</b></td>";
    tmpStr += "<td>" + reminderStringList( todo ).join( "<br>" ) + "</td>";
    tmpStr += "</tr>";
  }

  tmpStr += displayViewFormatAttendees( calendar, todo );

  int categoryCount = todo->categories().count();
  if ( categoryCount > 0 ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" +
              i18np( "Category:", "Categories:", categoryCount ) +
              "</b></td>";
    tmpStr += "<td>" + displayViewFormatCategories( todo ) + "</td>";
    tmpStr += "</tr>";
  }

  if ( todo->priority() > 0 ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Priority:" ) + "</b></td>";
    tmpStr += "<td>";
    tmpStr += QString::number( todo->priority() );
    tmpStr += "</td>";
    tmpStr += "</tr>";
  }

  tmpStr += "<tr>";
  if ( todo->isCompleted() ) {
    tmpStr += "<td><b>" + i18nc( "Completed: date", "Completed:" ) + "</b></td>";
    tmpStr += "<td>";
    tmpStr += Stringify::todoCompletedDateTime( todo );
  } else {
    tmpStr += "<td><b>" + i18n( "Percent Done:" ) + "</b></td>";
    tmpStr += "<td>";
    tmpStr += i18n( "%1%", todo->percentComplete() );
  }
  tmpStr += "</td>";
  tmpStr += "</tr>";

  int attachmentCount = todo->attachments().count();
  if ( attachmentCount > 0 ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" +
              i18np( "Attachment:", "Attachments:", attachmentCount ) +
              "</b></td>";
    tmpStr += "<td>" + displayViewFormatAttachments( todo ) + "</td>";
    tmpStr += "</tr>";
  }
  tmpStr += "</table>";

  tmpStr += "<p><em>" + displayViewFormatCreationDate( todo, spec ) + "</em>";

  return tmpStr;
}

static QString displayViewFormatJournal( const Calendar::Ptr &calendar, const QString &sourceName,
                                         const Journal::Ptr &journal, KDateTime::Spec spec )
{
  if ( !journal ) {
    return QString();
  }

  QString tmpStr = displayViewFormatHeader( journal );

  tmpStr += "<table>";
  tmpStr += "<col width=\"25%\"/>";
  tmpStr += "<col width=\"75%\"/>";

  const QString calStr = calendar ? resourceString( calendar, journal ) : sourceName;
  if ( !calStr.isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Calendar:" ) + "</b></td>";
    tmpStr += "<td>" + calStr + "</td>";
    tmpStr += "</tr>";
  }

  tmpStr += "<tr>";
  tmpStr += "<td><b>" + i18n( "Date:" ) + "</b></td>";
  tmpStr += "<td>" +
            dateToString( journal->dtStart(), false, spec ) +
            "</td>";
  tmpStr += "</tr>";

  if ( !journal->description().isEmpty() ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" + i18n( "Description:" ) + "</b></td>";
    tmpStr += "<td>" + journal->richDescription() + "</td>";
    tmpStr += "</tr>";
  }

  int categoryCount = journal->categories().count();
  if ( categoryCount > 0 ) {
    tmpStr += "<tr>";
    tmpStr += "<td><b>" +
              i18np( "Category:", "Categories:", categoryCount ) +
              "</b></td>";
    tmpStr += "<td>" + displayViewFormatCategories( journal ) + "</td>";
    tmpStr += "</tr>";
  }

  tmpStr += "</table>";

  tmpStr += "<p><em>" + displayViewFormatCreationDate( journal, spec ) + "</em>";

  return tmpStr;
}

static QString displayViewFormatFreeBusy( const Calendar::Ptr &calendar, const QString &sourceName,
                                          const FreeBusy::Ptr &fb, KDateTime::Spec spec )
{
  Q_UNUSED( calendar );
  Q_UNUSED( sourceName );
  if ( !fb ) {
    return QString();
  }

  QString tmpStr(
    htmlAddTag(
      "h2", i18n( "Free/Busy information for %1", fb->organizer()->fullName() ) ) );

  tmpStr += htmlAddTag( "h4",
                        i18n( "Busy times in date range %1 - %2:",
                              dateToString( fb->dtStart(), true, spec ),
                              dateToString( fb->dtEnd(), true, spec ) ) );

  QString text =
    htmlAddTag( "em",
                htmlAddTag( "b", i18nc( "tag for busy periods list", "Busy:" ) ) );

  Period::List periods = fb->busyPeriods();
  Period::List::iterator it;
  for ( it = periods.begin(); it != periods.end(); ++it ) {
    Period per = *it;
    if ( per.hasDuration() ) {
      int dur = per.duration().asSeconds();
      QString cont;
      if ( dur >= 3600 ) {
        cont += i18ncp( "hours part of duration", "1 hour ", "%1 hours ", dur / 3600 );
        dur %= 3600;
      }
      if ( dur >= 60 ) {
        cont += i18ncp( "minutes part duration", "1 minute ", "%1 minutes ", dur / 60 );
        dur %= 60;
      }
      if ( dur > 0 ) {
        cont += i18ncp( "seconds part of duration", "1 second", "%1 seconds", dur );
      }
      text += i18nc( "startDate for duration", "%1 for %2",
                     dateTimeToString( per.start(), false, true, spec ),
                     cont );
      text += "<br>";
    } else {
      if ( per.start().date() == per.end().date() ) {
        text += i18nc( "date, fromTime - toTime ", "%1, %2 - %3",
                       dateToString( per.start(), true, spec ),
                       timeToString( per.start(), true, spec ),
                       timeToString( per.end(), true, spec ) );
      } else {
        text += i18nc( "fromDateTime - toDateTime", "%1 - %2",
                       dateTimeToString( per.start(), false, true, spec ),
                       dateTimeToString( per.end(), false, true, spec ) );
      }
      text += "<br>";
    }
  }
  tmpStr += htmlAddTag( "p", text );
  return tmpStr;
}
//@endcond

//@cond PRIVATE
class KCalUtils::IncidenceFormatter::EventViewerVisitor : public Visitor
{
  public:
    EventViewerVisitor()
      : mCalendar( 0 ), mSpec( KDateTime::Spec() ), mResult( "" ) {}

    bool act( const Calendar::Ptr &calendar, IncidenceBase::Ptr incidence, const QDate &date,
              KDateTime::Spec spec=KDateTime::Spec() )
    {
      mCalendar = calendar;
      mSourceName.clear();
      mDate = date;
      mSpec = spec;
      mResult = "";
      return incidence->accept( *this, incidence );
    }

    bool act( const QString &sourceName, IncidenceBase::Ptr incidence, const QDate &date,
              KDateTime::Spec spec=KDateTime::Spec() )
    {
      mSourceName = sourceName;
      mDate = date;
      mSpec = spec;
      mResult = "";
      return incidence->accept( *this, incidence );
    }

    QString result() const { return mResult; }

  protected:
    bool visit( Event::Ptr event )
    {
      mResult = displayViewFormatEvent( mCalendar, mSourceName, event, mDate, mSpec );
      return !mResult.isEmpty();
    }
    bool visit( Todo::Ptr todo )
    {
      mResult = displayViewFormatTodo( mCalendar, mSourceName, todo, mDate, mSpec );
      return !mResult.isEmpty();
    }
    bool visit( Journal::Ptr journal )
    {
      mResult = displayViewFormatJournal( mCalendar, mSourceName, journal, mSpec );
      return !mResult.isEmpty();
    }
    bool visit( FreeBusy::Ptr fb )
    {
      mResult = displayViewFormatFreeBusy( mCalendar, mSourceName, fb, mSpec );
      return !mResult.isEmpty();
    }

  protected:
    Calendar::Ptr mCalendar;
    QString mSourceName;
    QDate mDate;
    KDateTime::Spec mSpec;
    QString mResult;
};
//@endcond

QString IncidenceFormatter::extensiveDisplayStr( const Calendar::Ptr &calendar,
                                                 const IncidenceBase::Ptr &incidence,
                                                 const QDate &date,
                                                 KDateTime::Spec spec )
{
  if ( !incidence ) {
    return QString();
  }

  EventViewerVisitor v;
  if ( v.act( calendar, incidence, date, spec ) ) {
    return v.result();
  } else {
    return QString();
  }
}

QString IncidenceFormatter::extensiveDisplayStr( const QString &sourceName,
                                                 const IncidenceBase::Ptr &incidence,
                                                 const QDate &date,
                                                 KDateTime::Spec spec )
{
  if ( !incidence ) {
    return QString();
  }

  EventViewerVisitor v;
  if ( v.act( sourceName, incidence, date, spec ) ) {
    return v.result();
  } else {
    return QString();
  }
}
/***********************************************************************
 *  Helper functions for the body part formatter of kmail (Invitations)
 ***********************************************************************/

//@cond PRIVATE
static QString string2HTML( const QString &str )
{
  return Qt::convertFromPlainText( str, Qt::WhiteSpaceNormal );
}

static QString cleanHtml( const QString &html )
{
  QRegExp rx( "<body[^>]*>(.*)</body>", Qt::CaseInsensitive );
  rx.indexIn( html );
  QString body = rx.cap( 1 );

  return Qt::escape( body.remove( QRegExp( "<[^>]*>" ) ).trimmed() );
}

static QString invitationSummary( const Incidence::Ptr &incidence, bool noHtmlMode )
{
  QString summaryStr = i18n( "Summary unspecified" );
  if ( !incidence->summary().isEmpty() ) {
    if ( !incidence->summaryIsRich() ) {
      summaryStr = Qt::escape( incidence->summary() );
    } else {
      summaryStr = incidence->richSummary();
      if ( noHtmlMode ) {
        summaryStr = cleanHtml( summaryStr );
      }
    }
  }
  return summaryStr;
}

static QString invitationLocation( const Incidence::Ptr &incidence, bool noHtmlMode )
{
  QString locationStr = i18n( "Location unspecified" );
  if ( !incidence->location().isEmpty() ) {
    if ( !incidence->locationIsRich() ) {
      locationStr = Qt::escape( incidence->location() );
    } else {
      locationStr = incidence->richLocation();
      if ( noHtmlMode ) {
        locationStr = cleanHtml( locationStr );
      }
    }
  }
  return locationStr;
}

static QString eventStartTimeStr( const Event::Ptr &event )
{
  QString tmp;
  if ( !event->allDay() ) {
    tmp =  i18nc( "%1: Start Date, %2: Start Time", "%1 %2",
                  dateToString( event->dtStart(), true, KSystemTimeZones::local() ),
                  timeToString( event->dtStart(), true, KSystemTimeZones::local() ) );
  } else {
    tmp = i18nc( "%1: Start Date", "%1 (all day)",
                 dateToString( event->dtStart(), true, KSystemTimeZones::local() ) );
  }
  return tmp;
}

static QString eventEndTimeStr( const Event::Ptr &event )
{
  QString tmp;
  if ( event->hasEndDate() && event->dtEnd().isValid() ) {
    if ( !event->allDay() ) {
      tmp =  i18nc( "%1: End Date, %2: End Time", "%1 %2",
                    dateToString( event->dtEnd(), true, KSystemTimeZones::local() ),
                    timeToString( event->dtEnd(), true, KSystemTimeZones::local() ) );
    } else {
      tmp = i18nc( "%1: End Date", "%1 (all day)",
                   dateToString( event->dtEnd(), true, KSystemTimeZones::local() ) );
    }
  }
  return tmp;
}

static QString htmlInvitationDetailsBegin()
{
  QString dir = ( QApplication::isRightToLeft() ? "rtl" : "ltr" );
  return QString( "<div dir=\"%1\">\n" ).arg( dir );
}

static QString htmlInvitationDetailsEnd()
{
  return "</div>\n";
}

static QString htmlInvitationDetailsTableBegin()
{
  return "<table cellspacing=\"4\" style=\"border-width:4px; border-style:groove\">";
}

static QString htmlInvitationDetailsTableEnd()
{
  return "</table>\n";
}

static QString diffColor()
{
  // Color for printing comparison differences inside invitations.

//  return  "#DE8519"; // hard-coded color from Outlook2007
  return QColor( Qt::red ).name();  //krazy:exclude=qenums TODO make configurable
}

static QString noteColor()
{
  // Color for printing notes inside invitations.
  return qApp->palette().color( QPalette::Active, QPalette::Highlight ).name();
}

static QString htmlRow( const QString &title, const QString &value )
{
  if ( !value.isEmpty() ) {
    return "<tr><td>" + title + "</td><td>" + value + "</td></tr>\n";
  } else {
    return QString();
  }
}

static QString htmlRow( const QString &title, const QString &value, const QString &oldvalue )
{
  // if 'value' is empty, then print nothing
  if ( value.isEmpty() ) {
    return QString();
  }

  // if 'value' is new or unchanged, then print normally
  if ( oldvalue.isEmpty() || value == oldvalue ) {
    return htmlRow( title, value );
  }

  // if 'value' has changed, then make a special print
  QString color = diffColor();
  QString newtitle = "<font color=\"" + color + "\">" + title + "</font>";
  QString newvalue = "<font color=\"" + color + "\">" + value + "</font>" +
                     "&nbsp;" +
                     "(<strike>" + oldvalue + "</strike>)";
  return htmlRow( newtitle, newvalue );

}

static Attendee::Ptr findDelegatedFromMyAttendee( const Incidence::Ptr &incidence )
{
  // Return the first attendee that was delegated-from me

  Attendee::Ptr attendee;
  if ( !incidence ) {
    return attendee;
  }

  KEMailSettings settings;
  QStringList profiles = settings.profiles();
  for ( QStringList::Iterator it=profiles.begin(); it != profiles.end(); ++it ) {
    settings.setProfile( *it );

    QString delegatorName, delegatorEmail;
    Attendee::List attendees = incidence->attendees();
    Attendee::List::ConstIterator it2;
    for ( it2 = attendees.constBegin(); it2 != attendees.constEnd(); ++it2 ) {
      Attendee::Ptr a = *it2;
      KPIMUtils::extractEmailAddressAndName( a->delegator(), delegatorEmail, delegatorName );
      if ( settings.getSetting( KEMailSettings::EmailAddress ) == delegatorEmail ) {
        attendee = a;
        break;
      }
    }
  }
  return attendee;
}

static Attendee::Ptr findMyAttendee( const Incidence::Ptr &incidence )
{
  // Return the attendee for the incidence that is probably me

  Attendee::Ptr attendee;
  if ( !incidence ) {
    return attendee;
  }

  KEMailSettings settings;
  QStringList profiles = settings.profiles();
  for ( QStringList::Iterator it=profiles.begin(); it != profiles.end(); ++it ) {
    settings.setProfile( *it );

    Attendee::List attendees = incidence->attendees();
    Attendee::List::ConstIterator it2;
    for ( it2 = attendees.constBegin(); it2 != attendees.constEnd(); ++it2 ) {
      Attendee::Ptr a = *it2;
      if ( settings.getSetting( KEMailSettings::EmailAddress ) == a->email() ) {
        attendee = a;
        break;
      }
    }
  }
  return attendee;
}

static Attendee::Ptr findAttendee( const Incidence::Ptr &incidence,
                                   const QString &email )
{
  // Search for an attendee by email address

  Attendee::Ptr attendee;
  if ( !incidence ) {
    return attendee;
  }

  Attendee::List attendees = incidence->attendees();
  Attendee::List::ConstIterator it;
  for ( it = attendees.constBegin(); it != attendees.constEnd(); ++it ) {
    Attendee::Ptr a = *it;
    if ( email == a->email() ) {
      attendee = a;
      break;
    }
  }
  return attendee;
}

static bool rsvpRequested( const Incidence::Ptr &incidence )
{
  if ( !incidence ) {
    return false;
  }

  //use a heuristic to determine if a response is requested.

  bool rsvp = true; // better send superfluously than not at all
  Attendee::List attendees = incidence->attendees();
  Attendee::List::ConstIterator it;
  for ( it = attendees.constBegin(); it != attendees.constEnd(); ++it ) {
    if ( it == attendees.constBegin() ) {
      rsvp = (*it)->RSVP(); // use what the first one has
    } else {
      if ( (*it)->RSVP() != rsvp ) {
        rsvp = true; // they differ, default
        break;
      }
    }
  }
  return rsvp;
}

static QString rsvpRequestedStr( bool rsvpRequested, const QString &role )
{
  if ( rsvpRequested ) {
    if ( role.isEmpty() ) {
      return i18n( "Your response is requested" );
    } else {
      return i18n( "Your response as <b>%1</b> is requested", role );
    }
  } else {
    if ( role.isEmpty() ) {
      return i18n( "No response is necessary" );
    } else {
      return i18n( "No response as <b>%1</b> is necessary", role );
    }
  }
}

static QString myStatusStr( Incidence::Ptr incidence )
{
  QString ret;
  Attendee::Ptr a = findMyAttendee( incidence );
  if ( a &&
       a->status() != Attendee::NeedsAction && a->status() != Attendee::Delegated ) {
    ret = i18n( "(<b>Note</b>: the Organizer preset your response to <b>%1</b>)",
                Stringify::attendeeStatus( a->status() ) );
  }
  return ret;
}

static QString invitationNote( const QString &title, const QString &note,
                               const QString &tag, const QString &color )
{
  QString noteStr;
  if ( !note.isEmpty() ) {
    noteStr += "<table border=\"0\" style=\"margin-top:4px;\">";
    noteStr += "<tr><center><td>";
    if ( !color.isEmpty() ) {
      noteStr += "<font color=\"" + color + "\">";
    }
    if ( !title.isEmpty() ) {
      if ( !tag.isEmpty() ) {
        noteStr += htmlAddTag( tag, title );
      } else {
        noteStr += title;
      }
    }
    noteStr += "&nbsp;" + note;
    if ( !color.isEmpty() ) {
      noteStr += "</font>";
    }
    noteStr += "</td></center></tr>";
    noteStr += "</table>";
  }
  return noteStr;
}

static QString invitationPerson( const QString &email, const QString &name, const QString &uid,
                                 const QString &comment )
{
  QPair<QString, QString> s = searchNameAndUid( email, name, uid );
  const QString printName = s.first;
  const QString printUid = s.second;

  QString personString;
  // Make the uid link
  if ( !printUid.isEmpty() ) {
    personString = htmlAddUidLink( email, printName, printUid );
  } else {
    // No UID, just show some text
    personString = ( printName.isEmpty() ? email : printName );
  }
  if ( !comment.isEmpty() ) {
    personString = i18nc( "name (comment)", "%1 (%2)", personString, comment );
  }
  personString += '\n';

  // Make the mailto link
  if ( !email.isEmpty() ) {
    personString += "&nbsp;" + htmlAddMailtoLink( email, printName );
  }
  personString += '\n';

  return personString;
}

static QString invitationDetailsIncidence( const Incidence::Ptr &incidence, bool noHtmlMode )
{
  // if description and comment -> use both
  // if description, but no comment -> use the desc as the comment (and no desc)
  // if comment, but no description -> use the comment and no description

  QString html;
  QString descr;
  QStringList comments;

  if ( incidence->comments().isEmpty() ) {
    if ( !incidence->description().isEmpty() ) {
      // use description as comments
      if ( !incidence->descriptionIsRich() ) {
        comments << string2HTML( incidence->description() );
      } else {
        comments << incidence->richDescription();
        if ( noHtmlMode ) {
          comments[0] = cleanHtml( comments[0] );
        }
        comments[0] = htmlAddTag( "p", comments[0] );
      }
    }
    //else desc and comments are empty
  } else {
    // non-empty comments
    foreach ( const QString &c, incidence->comments() ) {
      if ( !c.isEmpty() ) {
        // kcalutils doesn't know about richtext comments, so we need to guess
        if ( !Qt::mightBeRichText( c ) ) {
          comments << string2HTML( c );
        } else {
          if ( noHtmlMode ) {
            comments << cleanHtml( cleanHtml( "<body>" + c + "</body>" ) );
          } else {
            comments << c;
          }
        }
      }
    }
    if ( !incidence->description().isEmpty() ) {
      // use description too
      if ( !incidence->descriptionIsRich() ) {
        descr = string2HTML( incidence->description() );
      } else {
        descr = incidence->richDescription();
        if ( noHtmlMode ) {
          descr = cleanHtml( descr );
        }
        descr = htmlAddTag( "p", descr );
      }
    }
  }

  if( !descr.isEmpty() ) {
    html += "<p>";
    html += "<table border=\"0\" style=\"margin-top:4px;\">";
    html += "<tr><td><center>" +
            htmlAddTag( "u", i18n( "Description:" ) ) +
            "</center></td></tr>";
    html += "<tr><td>" + descr + "</td></tr>";
    html += "</table>";
  }

  if ( !comments.isEmpty() ) {
    html += "<p>";
    html += "<table border=\"0\" style=\"margin-top:4px;\">";
    html += "<tr><td><center>" +
            htmlAddTag( "u", i18n( "Comments:" ) ) +
            "</center></td></tr>";
    html += "<tr><td>";
    if ( comments.count() > 1 ) {
      html += "<ul>";
      for ( int i=0; i < comments.count(); ++i ) {
        html += "<li>" + comments[i] + "</li>";
      }
      html += "</ul>";
    } else {
      html += comments[0];
    }
    html += "</td></tr>";
    html += "</table>";
  }
  return html;
}

static QString invitationDetailsEvent( const Event::Ptr &event, bool noHtmlMode,
                                       KDateTime::Spec spec )
{
  // Invitation details are formatted into an HTML table
  if ( !event ) {
    return QString();
  }

  QString html = htmlInvitationDetailsBegin();
  html += htmlInvitationDetailsTableBegin();

  // Invitation summary & location rows
  html += htmlRow( i18n( "What:" ), invitationSummary( event, noHtmlMode ) );
  html += htmlRow( i18n( "Where:" ), invitationLocation( event, noHtmlMode ) );

  // If a 1 day event
  if ( event->dtStart().date() == event->dtEnd().date() ) {
    html += htmlRow( i18n( "Date:" ), dateToString( event->dtStart(), false, spec ) );
    if ( !event->allDay() ) {
      html += htmlRow( i18n( "Time:" ),
                       timeToString( event->dtStart(), true, spec ) +
                       " - " +
                       timeToString( event->dtEnd(), true, spec ) );
    }
  } else {
    html += htmlRow( i18nc( "starting date", "From:" ),
                     dateToString( event->dtStart(), false, spec ) );
    if ( !event->allDay() ) {
      html += htmlRow( i18nc( "starting time", "At:" ),
                       timeToString( event->dtStart(), true, spec ) );
    }
    if ( event->hasEndDate() ) {
      html += htmlRow( i18nc( "ending date", "To:" ),
                       dateToString( event->dtEnd(), false, spec ) );
      if ( !event->allDay() ) {
        html += htmlRow( i18nc( "ending time", "At:" ),
                         timeToString( event->dtEnd(), true, spec ) );
      }
    } else {
      html += htmlRow( i18nc( "ending date", "To:" ), i18n( "no end date specified" ) );
    }
  }

  // Invitation Duration Row
  html += htmlRow( i18n( "Duration:" ), durationString( event ) );

  // Invitation Recurrence Row
  if ( event->recurs() ) {
    html += htmlRow( i18n( "Recurrence:" ), recurrenceString( event ) );
  }

  html += htmlInvitationDetailsTableEnd();
  html += invitationDetailsIncidence( event, noHtmlMode );
  html += htmlInvitationDetailsEnd();

  return html;
}

static QString invitationDetailsEvent( const Event::Ptr &event, const Event::Ptr &oldevent,
                                       const ScheduleMessage::Ptr message, bool noHtmlMode,
                                       KDateTime::Spec spec )
{
  if ( !oldevent ) {
    return invitationDetailsEvent( event, noHtmlMode, spec );
  }

  QString html;

  // Print extra info typically dependent on the iTIP
  if ( message->method() == iTIPDeclineCounter ) {
    html += "<br>";
    html += invitationNote( QString(),
                            i18n( "Please respond again to the original proposal." ),
                            QString(), noteColor() );
  }

  html += htmlInvitationDetailsBegin();
  html += htmlInvitationDetailsTableBegin();

  html += htmlRow( i18n( "What:" ),
                   invitationSummary( event, noHtmlMode ),
                   invitationSummary( oldevent, noHtmlMode ) );

  html += htmlRow( i18n( "Where:" ),
                   invitationLocation( event, noHtmlMode ),
                   invitationLocation( oldevent, noHtmlMode ) );

  // If a 1 day event
  if ( event->dtStart().date() == event->dtEnd().date() ) {
    html += htmlRow( i18n( "Date:" ),
                     dateToString( event->dtStart(), false ),
                     dateToString( oldevent->dtStart(), false ) );
    QString spanStr, oldspanStr;
    if ( !event->allDay() ) {
      spanStr = timeToString( event->dtStart(), true ) +
                " - " +
                timeToString( event->dtEnd(), true );
    }
    if ( !oldevent->allDay() ) {
      oldspanStr = timeToString( oldevent->dtStart(), true ) +
                   " - " +
                   timeToString( oldevent->dtEnd(), true );
    }
    html += htmlRow( i18n( "Time:" ), spanStr, oldspanStr );
  } else {
    html += htmlRow( i18nc( "Starting date of an event", "From:" ),
                     dateToString( event->dtStart(), false ),
                     dateToString( oldevent->dtStart(), false ) );
    QString startStr, oldstartStr;
    if ( !event->allDay() ) {
      startStr = timeToString( event->dtStart(), true );
    }
    if ( !oldevent->allDay() ) {
      oldstartStr = timeToString( oldevent->dtStart(), true );
    }
    html += htmlRow( i18nc( "Starting time of an event", "At:" ), startStr, oldstartStr );
    if ( event->hasEndDate() ) {
      html += htmlRow( i18nc( "Ending date of an event", "To:" ),
                       dateToString( event->dtEnd(), false ),
                       dateToString( oldevent->dtEnd(), false ) );
      QString endStr, oldendStr;
      if ( !event->allDay() ) {
        endStr = timeToString( event->dtEnd(), true );
      }
      if ( !oldevent->allDay() ) {
        oldendStr = timeToString( oldevent->dtEnd(), true );
      }
      html += htmlRow( i18nc( "Starting time of an event", "At:" ), endStr, oldendStr );
    } else {
      QString endStr = i18n( "no end date specified" );
      QString oldendStr;
      if ( !oldevent->hasEndDate() ) {
        oldendStr = i18n( "no end date specified" );
      } else {
        oldendStr = dateTimeToString( oldevent->dtEnd(), oldevent->allDay(), false );
      }
      html += htmlRow( i18nc( "Ending date of an event", "To:" ), endStr, oldendStr );
    }
  }

  html += htmlRow( i18n( "Duration:" ), durationString( event ), durationString( oldevent ) );

  QString recurStr, oldrecurStr;
  if ( event->recurs() ||  oldevent->recurs() ) {
    recurStr = recurrenceString( event );
    oldrecurStr = recurrenceString( oldevent );
  }
  html += htmlRow( i18n( "Recurrence:" ), recurStr, oldrecurStr );

  html += htmlInvitationDetailsTableEnd();
  html += invitationDetailsIncidence( event, noHtmlMode );
  html += htmlInvitationDetailsEnd();

  return html;
}

static QString invitationDetailsTodo( const Todo::Ptr &todo, bool noHtmlMode,
                                      KDateTime::Spec spec )
{
  // To-do details are formatted into an HTML table
  if ( !todo ) {
    return QString();
  }

  QString html = htmlInvitationDetailsBegin();
  html += htmlInvitationDetailsTableBegin();

  // Invitation summary & location rows
  html += htmlRow( i18n( "What:" ), invitationSummary( todo, noHtmlMode ) );
  html += htmlRow( i18n( "Where:" ), invitationLocation( todo, noHtmlMode ) );

  if ( todo->hasStartDate() && todo->dtStart().isValid() ) {
    html += htmlRow( i18n( "Start Date:" ), dateToString( todo->dtStart(), false, spec ) );
    if ( !todo->allDay() ) {
      html += htmlRow( i18n( "Start Time:" ), timeToString( todo->dtStart(), false, spec ) );
    }
  }
  if ( todo->hasDueDate() && todo->dtDue().isValid() ) {
    html += htmlRow( i18n( "Due Date:" ), dateToString( todo->dtDue(), false, spec ) );
    if ( !todo->allDay() ) {
      html += htmlRow( i18n( "Due Time:" ), timeToString( todo->dtDue(), false, spec ) );
    }
  } else {
    html += htmlRow( i18n( "Due Date:" ), i18nc( "Due Date: None", "None" ) );
  }

  // Invitation Duration Row
  html += htmlRow( i18n( "Duration:" ), durationString( todo ) );

  // Completeness
  if ( todo->percentComplete() > 0 ) {
    html += htmlRow( i18n( "Percent Done:" ), i18n( "%1%", todo->percentComplete() ) );
  }

  // Invitation Recurrence Row
  if ( todo->recurs() ) {
    html += htmlRow( i18n( "Recurrence:" ), recurrenceString( todo ) );
  }

  html += htmlInvitationDetailsTableEnd();
  html += invitationDetailsIncidence( todo, noHtmlMode );
  html += htmlInvitationDetailsEnd();

  return html;
}

static QString invitationDetailsTodo( const Todo::Ptr &todo, const Todo::Ptr &oldtodo,
                                      const ScheduleMessage::Ptr message, bool noHtmlMode,
                                      KDateTime::Spec spec )
{
  if ( !oldtodo ) {
    return invitationDetailsTodo( todo, noHtmlMode, spec );
  }

  QString html;

  // Print extra info typically dependent on the iTIP
  if ( message->method() == iTIPDeclineCounter ) {
    html += "<br>";
    html += invitationNote( QString(),
                            i18n( "Please respond again to the original proposal." ),
                            QString(), noteColor() );
  }

  html += htmlInvitationDetailsBegin();
  html += htmlInvitationDetailsTableBegin();

  html += htmlRow( i18n( "What:" ),
                   invitationSummary( todo, noHtmlMode ),
                   invitationSummary( todo, noHtmlMode ) );

  html += htmlRow( i18n( "Where:" ),
                   invitationLocation( todo, noHtmlMode ),
                   invitationLocation( oldtodo, noHtmlMode ) );

  if ( todo->hasStartDate() && todo->dtStart().isValid() ) {
    html += htmlRow( i18n( "Start Date:" ),
                     dateToString( todo->dtStart(), false ),
                     dateToString( oldtodo->dtStart(), false ) );
    QString startTimeStr, oldstartTimeStr;
    if ( !todo->allDay() || !oldtodo->allDay() ) {
      startTimeStr = todo->allDay() ?
                     i18n( "All day" ) : timeToString( todo->dtStart(), false );
      oldstartTimeStr = oldtodo->allDay() ?
                        i18n( "All day" ) : timeToString( oldtodo->dtStart(), false );
    }
    html += htmlRow( i18n( "Start Time:" ), startTimeStr, oldstartTimeStr );
  }
  if ( todo->hasDueDate() && todo->dtDue().isValid() ) {
    html += htmlRow( i18n( "Due Date:" ),
                     dateToString( todo->dtDue(), false ),
                     dateToString( oldtodo->dtDue(), false ) );
    QString endTimeStr, oldendTimeStr;
    if ( !todo->allDay() || !oldtodo->allDay() ) {
      endTimeStr = todo->allDay() ?
                   i18n( "All day" ) : timeToString( todo->dtDue(), false );
      oldendTimeStr = oldtodo->allDay() ?
                      i18n( "All day" ) : timeToString( oldtodo->dtDue(), false );
    }
    html += htmlRow( i18n( "Due Time:" ), endTimeStr, oldendTimeStr );
  } else {
    QString dueStr = i18nc( "Due Date: None", "None" );
    QString olddueStr;
    if ( !oldtodo->hasDueDate() || !oldtodo->dtDue().isValid() ) {
      olddueStr = i18nc( "Due Date: None", "None" );
   } else {
      olddueStr = dateTimeToString( oldtodo->dtDue(), oldtodo->allDay(), false );
    }
    html += htmlRow( i18n( "Due Date:" ), dueStr, olddueStr );
  }

  html += htmlRow( i18n( "Duration:" ), durationString( todo ), durationString( oldtodo ) );

  QString completionStr, oldcompletionStr;
  if ( todo->percentComplete() > 0 || oldtodo->percentComplete() > 0 ) {
    completionStr = i18n( "%1%", todo->percentComplete() );
    oldcompletionStr = i18n( "%1%", oldtodo->percentComplete() );
  }
  html += htmlRow( i18n( "Percent Done:" ), completionStr, oldcompletionStr );

  QString recurStr, oldrecurStr;
  if ( todo->recurs() || oldtodo->recurs() ) {
    recurStr = recurrenceString( todo );
    oldrecurStr = recurrenceString( oldtodo );
  }
  html += htmlRow( i18n( "Recurrence:" ), recurStr, oldrecurStr );

  html += htmlInvitationDetailsTableEnd();
  html += invitationDetailsIncidence( todo, noHtmlMode );

  html += htmlInvitationDetailsEnd();

  return html;
}

static QString invitationDetailsJournal( const Journal::Ptr &journal, bool noHtmlMode,
                                         KDateTime::Spec spec )
{
  if ( !journal ) {
    return QString();
  }

  QString html = htmlInvitationDetailsBegin();
  html += htmlInvitationDetailsTableBegin();

  html += htmlRow( i18n( "Summary:" ), invitationSummary( journal, noHtmlMode ) );
  html += htmlRow( i18n( "Date:" ), dateToString( journal->dtStart(), false, spec ) );

  html += htmlInvitationDetailsTableEnd();
  html += invitationDetailsIncidence( journal, noHtmlMode );
  html += htmlInvitationDetailsEnd();

  return html;
}

static QString invitationDetailsJournal( const Journal::Ptr &journal,
                                         const Journal::Ptr &oldjournal,
                                         bool noHtmlMode, KDateTime::Spec spec )
{
  if ( !oldjournal ) {
    return invitationDetailsJournal( journal, noHtmlMode, spec );
  }

  QString html = htmlInvitationDetailsBegin();
  html += htmlInvitationDetailsTableBegin();

  html += htmlRow( i18n( "What:" ),
                   invitationSummary( journal, noHtmlMode ),
                   invitationSummary( oldjournal, noHtmlMode ) );

  html += htmlRow( i18n( "Date:" ),
                   dateToString( journal->dtStart(), false, spec ),
                   dateToString( oldjournal->dtStart(), false, spec ) );

  html += htmlInvitationDetailsTableEnd();
  html += invitationDetailsIncidence( journal, noHtmlMode );
  html += htmlInvitationDetailsEnd();

  return html;
}

static QString invitationDetailsFreeBusy( const FreeBusy::Ptr &fb, bool noHtmlMode,
                                          KDateTime::Spec spec )
{
  Q_UNUSED( noHtmlMode );

  if ( !fb ) {
    return QString();
  }

  QString html = htmlInvitationDetailsTableBegin();

  html += htmlRow( i18n( "Person:" ), fb->organizer()->fullName() );
  html += htmlRow( i18n( "Start date:" ), dateToString( fb->dtStart(), true, spec ) );
  html += htmlRow( i18n( "End date:" ), dateToString( fb->dtEnd(), true, spec ) );

  html += "<tr><td colspan=2><hr></td></tr>\n";
  html += "<tr><td colspan=2>Busy periods given in this free/busy object:</td></tr>\n";

  Period::List periods = fb->busyPeriods();
  Period::List::iterator it;
  for ( it = periods.begin(); it != periods.end(); ++it ) {
    Period per = *it;
    if ( per.hasDuration() ) {
      int dur = per.duration().asSeconds();
      QString cont;
      if ( dur >= 3600 ) {
        cont += i18ncp( "hours part of duration", "1 hour ", "%1 hours ", dur / 3600 );
        dur %= 3600;
      }
      if ( dur >= 60 ) {
        cont += i18ncp( "minutes part of duration", "1 minute", "%1 minutes ", dur / 60 );
        dur %= 60;
      }
      if ( dur > 0 ) {
        cont += i18ncp( "seconds part of duration", "1 second", "%1 seconds", dur );
      }
      html += htmlRow( QString(),
                       i18nc( "startDate for duration", "%1 for %2",
                              KGlobal::locale()->formatDateTime(
                                per.start().dateTime(), KLocale::LongDate ),
                              cont ) );
    } else {
      QString cont;
      if ( per.start().date() == per.end().date() ) {
        cont = i18nc( "date, fromTime - toTime ", "%1, %2 - %3",
                      KGlobal::locale()->formatDate( per.start().date() ),
                      KGlobal::locale()->formatTime( per.start().time() ),
                      KGlobal::locale()->formatTime( per.end().time() ) );
      } else {
        cont = i18nc( "fromDateTime - toDateTime", "%1 - %2",
                      KGlobal::locale()->formatDateTime(
                        per.start().dateTime(), KLocale::LongDate ),
                      KGlobal::locale()->formatDateTime(
                        per.end().dateTime(), KLocale::LongDate ) );
      }

      html += htmlRow( QString(), cont );
    }
  }

  html += htmlInvitationDetailsTableEnd();
  return html;
}

static QString invitationDetailsFreeBusy( const FreeBusy::Ptr &fb, const FreeBusy::Ptr &oldfb,
                                          bool noHtmlMode, KDateTime::Spec spec )
{
  Q_UNUSED( oldfb );
  return invitationDetailsFreeBusy( fb, noHtmlMode, spec );
}

static bool replyMeansCounter( const Incidence::Ptr &incidence )
{
  Q_UNUSED( incidence );
  return false;
/**
  see kolab/issue 3665 for an example of when we might use this for something

  bool status = false;
  if ( incidence ) {
    // put code here that looks at the incidence and determines that
    // the reply is meant to be a counter proposal.  We think this happens
    // with Outlook counter proposals, but we aren't sure how yet.
    if ( condition ) {
      status = true;
    }
  }
  return status;
*/
}

static QString invitationHeaderEvent( const Event::Ptr &event,
                                      const Incidence::Ptr &existingIncidence,
                                      ScheduleMessage::Ptr msg, const QString &sender )
{
  if ( !msg || !event ) {
    return QString();
  }

  switch ( msg->method() ) {
  case iTIPPublish:
    return i18n( "This invitation has been published" );
  case iTIPRequest:
    if ( existingIncidence && event->revision() > 0 ) {
      QString orgStr = organizerName( event, sender );
      if ( senderIsOrganizer( event, sender ) ) {
        return i18n( "This invitation has been updated by the organizer %1", orgStr );
      } else {
        return i18n( "This invitation has been updated by %1 as a representative of %2",
                     sender, orgStr );
      }
    }
    if ( iamOrganizer( event ) ) {
      return i18n( "I created this invitation" );
    } else {
      QString orgStr = organizerName( event, sender );
      if ( senderIsOrganizer( event, sender ) ) {
        return i18n( "You received an invitation from %1", orgStr );
      } else {
        return i18n( "You received an invitation from %1 as a representative of %2",
                     sender, orgStr );
      }
    }
  case iTIPRefresh:
    return i18n( "This invitation was refreshed" );
  case iTIPCancel:
    if ( iamOrganizer( event ) ) {
      return i18n( "This invitation has been canceled" );
    } else {
      return i18n( "The organizer has revoked the invitation" );
    }
  case iTIPAdd:
    return i18n( "Addition to the invitation" );
  case iTIPReply:
  {
    if ( replyMeansCounter( event ) ) {
      return i18n( "%1 makes this counter proposal", firstAttendeeName( event, sender ) );
    }

    Attendee::List attendees = event->attendees();
    if( attendees.count() == 0 ) {
      kDebug() << "No attendees in the iCal reply!";
      return QString();
    }
    if ( attendees.count() != 1 ) {
      kDebug() << "Warning: attendeecount in the reply should be 1"
               << "but is" << attendees.count();
    }
    QString attendeeName = firstAttendeeName( event, sender );

    QString delegatorName, dummy;
    Attendee::Ptr attendee = *attendees.begin();
    KPIMUtils::extractEmailAddressAndName( attendee->delegator(), dummy, delegatorName );
    if ( delegatorName.isEmpty() ) {
      delegatorName = attendee->delegator();
    }

    switch( attendee->status() ) {
    case Attendee::NeedsAction:
      return i18n( "%1 indicates this invitation still needs some action", attendeeName );
    case Attendee::Accepted:
      if ( event->revision() > 0 ) {
        if ( !sender.isEmpty() ) {
          return i18n( "This invitation has been updated by attendee %1", sender );
        } else {
          return i18n( "This invitation has been updated by an attendee" );
        }
      } else {
        if ( delegatorName.isEmpty() ) {
          return i18n( "%1 accepts this invitation", attendeeName );
        } else {
          return i18n( "%1 accepts this invitation on behalf of %2",
                       attendeeName, delegatorName );
        }
      }
    case Attendee::Tentative:
      if ( delegatorName.isEmpty() ) {
        return i18n( "%1 tentatively accepts this invitation", attendeeName );
      } else {
        return i18n( "%1 tentatively accepts this invitation on behalf of %2",
                     attendeeName, delegatorName );
      }
    case Attendee::Declined:
      if ( delegatorName.isEmpty() ) {
        return i18n( "%1 declines this invitation", attendeeName );
      } else {
        return i18n( "%1 declines this invitation on behalf of %2",
                     attendeeName, delegatorName );
      }
    case Attendee::Delegated:
    {
      QString delegate, dummy;
      KPIMUtils::extractEmailAddressAndName( attendee->delegate(), dummy, delegate );
      if ( delegate.isEmpty() ) {
        delegate = attendee->delegate();
      }
      if ( !delegate.isEmpty() ) {
        return i18n( "%1 has delegated this invitation to %2", attendeeName, delegate );
      } else {
        return i18n( "%1 has delegated this invitation", attendeeName );
      }
    }
    case Attendee::Completed:
      return i18n( "This invitation is now completed" );
    case Attendee::InProcess:
      return i18n( "%1 is still processing the invitation", attendeeName );
    case Attendee::None:
      return i18n( "Unknown response to this invitation" );
    }
    break;
  }
  case iTIPCounter:
    return i18n( "%1 makes this counter proposal",
                 firstAttendeeName( event, i18n( "Sender" ) ) );

  case iTIPDeclineCounter:
  {
    QString orgStr = organizerName( event, sender );
    if ( senderIsOrganizer( event, sender ) ) {
      return i18n( "%1 declines your counter proposal", orgStr );
    } else {
      return i18n( "%1 declines your counter proposal on behalf of %2", sender, orgStr );
    }
  }

  case iTIPNoMethod:
    return i18n( "Error: Event iTIP message with unknown method" );
  }
  kError() << "encountered an iTIP method that we do not support";
  return QString();
}

static QString invitationHeaderTodo( const Todo::Ptr &todo,
                                     const Incidence::Ptr &existingIncidence,
                                     ScheduleMessage::Ptr msg, const QString &sender )
{
  if ( !msg || !todo ) {
    return QString();
  }

  switch ( msg->method() ) {
  case iTIPPublish:
    return i18n( "This to-do has been published" );
  case iTIPRequest:
    if ( existingIncidence && todo->revision() > 0 ) {
      QString orgStr = organizerName( todo, sender );
      if ( senderIsOrganizer( todo, sender ) ) {
        return i18n( "This to-do has been updated by the organizer %1", orgStr );
      } else {
        return i18n( "This to-do has been updated by %1 as a representative of %2",
                     sender, orgStr );
      }
    } else {
      if ( iamOrganizer( todo ) ) {
        return i18n( "I created this to-do" );
      } else {
        QString orgStr = organizerName( todo, sender );
        if ( senderIsOrganizer( todo, sender ) ) {
          return i18n( "You have been assigned this to-do by %1", orgStr );
        } else {
          return i18n( "You have been assigned this to-do by %1 as a representative of %2",
                       sender, orgStr );
        }
      }
    }
  case iTIPRefresh:
    return i18n( "This to-do was refreshed" );
  case iTIPCancel:
    if ( iamOrganizer( todo ) ) {
      return i18n( "This to-do was canceled" );
    } else {
      return i18n( "The organizer has revoked this to-do" );
    }
  case iTIPAdd:
    return i18n( "Addition to the to-do" );
  case iTIPReply:
  {
    if ( replyMeansCounter( todo ) ) {
      return i18n( "%1 makes this counter proposal", firstAttendeeName( todo, sender ) );
    }

    Attendee::List attendees = todo->attendees();
    if ( attendees.count() == 0 ) {
      kDebug() << "No attendees in the iCal reply!";
      return QString();
    }
    if ( attendees.count() != 1 ) {
      kDebug() << "Warning: attendeecount in the reply should be 1"
               << "but is" << attendees.count();
    }
    QString attendeeName = firstAttendeeName( todo, sender );

    QString delegatorName, dummy;
    Attendee::Ptr attendee = *attendees.begin();
    KPIMUtils::extractEmailAddressAndName( attendee->delegate(), dummy, delegatorName );
    if ( delegatorName.isEmpty() ) {
      delegatorName = attendee->delegator();
    }

    switch( attendee->status() ) {
    case Attendee::NeedsAction:
      return i18n( "%1 indicates this to-do assignment still needs some action",
                   attendeeName );
    case Attendee::Accepted:
      if ( todo->revision() > 0 ) {
        if ( !sender.isEmpty() ) {
          if ( todo->isCompleted() ) {
            return i18n( "This to-do has been completed by assignee %1", sender );
          } else {
            return i18n( "This to-do has been updated by assignee %1", sender );
          }
        } else {
          if ( todo->isCompleted() ) {
            return i18n( "This to-do has been completed by an assignee" );
          } else {
            return i18n( "This to-do has been updated by an assignee" );
          }
        }
      } else {
        if ( delegatorName.isEmpty() ) {
          return i18n( "%1 accepts this to-do", attendeeName );
        } else {
          return i18n( "%1 accepts this to-do on behalf of %2",
                       attendeeName, delegatorName );
        }
      }
    case Attendee::Tentative:
      if ( delegatorName.isEmpty() ) {
        return i18n( "%1 tentatively accepts this to-do", attendeeName );
      } else {
        return i18n( "%1 tentatively accepts this to-do on behalf of %2",
                     attendeeName, delegatorName );
      }
    case Attendee::Declined:
      if ( delegatorName.isEmpty() ) {
        return i18n( "%1 declines this to-do", attendeeName );
      } else {
        return i18n( "%1 declines this to-do on behalf of %2",
                     attendeeName, delegatorName );
      }
    case Attendee::Delegated:
    {
      QString delegate, dummy;
      KPIMUtils::extractEmailAddressAndName( attendee->delegate(), dummy, delegate );
      if ( delegate.isEmpty() ) {
        delegate = attendee->delegate();
      }
      if ( !delegate.isEmpty() ) {
        return i18n( "%1 has delegated this to-do to %2", attendeeName, delegate );
      } else {
        return i18n( "%1 has delegated this to-do", attendeeName );
      }
    }
    case Attendee::Completed:
      return i18n( "The request for this to-do is now completed" );
    case Attendee::InProcess:
      return i18n( "%1 is still processing the to-do", attendeeName );
    case Attendee::None:
      return i18n( "Unknown response to this to-do" );
    }
    break;
  }
  case iTIPCounter:
    return i18n( "%1 makes this counter proposal", firstAttendeeName( todo, sender ) );

  case iTIPDeclineCounter:
  {
    QString orgStr = organizerName( todo, sender );
    if ( senderIsOrganizer( todo, sender ) ) {
      return i18n( "%1 declines the counter proposal", orgStr );
    } else {
      return i18n( "%1 declines the counter proposal on behalf of %2", sender, orgStr );
    }
  }

  case iTIPNoMethod:
    return i18n( "Error: To-do iTIP message with unknown method" );
  }
  kError() << "encountered an iTIP method that we do not support";
  return QString();
}

static QString invitationHeaderJournal( const Journal::Ptr &journal,
                                        ScheduleMessage::Ptr msg )
{
  if ( !msg || !journal ) {
    return QString();
  }

  switch ( msg->method() ) {
  case iTIPPublish:
    return i18n( "This journal has been published" );
  case iTIPRequest:
    return i18n( "You have been assigned this journal" );
  case iTIPRefresh:
    return i18n( "This journal was refreshed" );
  case iTIPCancel:
    return i18n( "This journal was canceled" );
  case iTIPAdd:
    return i18n( "Addition to the journal" );
  case iTIPReply:
  {
    if ( replyMeansCounter( journal ) ) {
      return i18n( "Sender makes this counter proposal" );
    }

    Attendee::List attendees = journal->attendees();
    if ( attendees.count() == 0 ) {
      kDebug() << "No attendees in the iCal reply!";
      return QString();
    }
    if( attendees.count() != 1 ) {
      kDebug() << "Warning: attendeecount in the reply should be 1 "
               << "but is " << attendees.count();
    }
    Attendee::Ptr attendee = *attendees.begin();

    switch( attendee->status() ) {
    case Attendee::NeedsAction:
      return i18n( "Sender indicates this journal assignment still needs some action" );
    case Attendee::Accepted:
      return i18n( "Sender accepts this journal" );
    case Attendee::Tentative:
      return i18n( "Sender tentatively accepts this journal" );
    case Attendee::Declined:
      return i18n( "Sender declines this journal" );
    case Attendee::Delegated:
      return i18n( "Sender has delegated this request for the journal" );
    case Attendee::Completed:
      return i18n( "The request for this journal is now completed" );
    case Attendee::InProcess:
      return i18n( "Sender is still processing the invitation" );
    case Attendee::None:
      return i18n( "Unknown response to this journal" );
    }
    break;
  }
  case iTIPCounter:
    return i18n( "Sender makes this counter proposal" );
  case iTIPDeclineCounter:
    return i18n( "Sender declines the counter proposal" );
  case iTIPNoMethod:
    return i18n( "Error: Journal iTIP message with unknown method" );
  }
  kError() << "encountered an iTIP method that we do not support";
  return QString();
}

static QString invitationHeaderFreeBusy( const FreeBusy::Ptr &fb,
                                         ScheduleMessage::Ptr msg )
{
  if ( !msg || !fb ) {
    return QString();
  }

  switch ( msg->method() ) {
  case iTIPPublish:
    return i18n( "This free/busy list has been published" );
  case iTIPRequest:
    return i18n( "The free/busy list has been requested" );
  case iTIPRefresh:
    return i18n( "This free/busy list was refreshed" );
  case iTIPCancel:
    return i18n( "This free/busy list was canceled" );
  case iTIPAdd:
    return i18n( "Addition to the free/busy list" );
  case iTIPReply:
    return i18n( "Reply to the free/busy list" );
  case iTIPCounter:
    return i18n( "Sender makes this counter proposal" );
  case iTIPDeclineCounter:
    return i18n( "Sender declines the counter proposal" );
  case iTIPNoMethod:
    return i18n( "Error: Free/Busy iTIP message with unknown method" );
  }
  kError() << "encountered an iTIP method that we do not support";
  return QString();
}
//@endcond

static QString invitationAttendeeList( const Incidence::Ptr &incidence )
{
  QString tmpStr;
  if ( !incidence ) {
    return tmpStr;
  }
  if ( incidence->type() == Incidence::TypeTodo ) {
    tmpStr += i18n( "Assignees" );
  } else {
    tmpStr += i18n( "Invitation List" );
  }

  int count=0;
  Attendee::List attendees = incidence->attendees();
  if ( !attendees.isEmpty() ) {
    QStringList comments;
    Attendee::List::ConstIterator it;
    for ( it = attendees.constBegin(); it != attendees.constEnd(); ++it ) {
      Attendee::Ptr a = *it;
      if ( !iamAttendee( a ) ) {
        count++;
        if ( count == 1 ) {
          tmpStr += "<table border=\"1\" cellpadding=\"1\" cellspacing=\"0\">";
        }
        tmpStr += "<tr>";
        tmpStr += "<td>";
        comments.clear();
        if ( attendeeIsOrganizer( incidence, a ) ) {
          comments << i18n( "organizer" );
        }
        if ( !a->delegator().isEmpty() ) {
          comments << i18n( " (delegated by %1)", a->delegator() );
        }
        if ( !a->delegate().isEmpty() ) {
          comments << i18n( " (delegated to %1)", a->delegate() );
        }
        tmpStr += invitationPerson( a->email(), a->name(), QString(), comments.join( "," ) );
        tmpStr += "</td>";
        tmpStr += "</tr>";
      }
    }
  }
  if ( count ) {
    tmpStr += "</table>";
  } else {
    tmpStr.clear();
  }

  return tmpStr;
}

static QString invitationRsvpList( const Incidence::Ptr &incidence, const Attendee::Ptr &sender )
{
  QString tmpStr;
  if ( !incidence ) {
    return tmpStr;
  }
  if ( incidence->type() == Incidence::TypeTodo ) {
    tmpStr += i18n( "Assignees" );
  } else {
    tmpStr += i18n( "Invitation List" );
  }

  int count=0;
  Attendee::List attendees = incidence->attendees();
  if ( !attendees.isEmpty() ) {
    QStringList comments;
    Attendee::List::ConstIterator it;
    for ( it = attendees.constBegin(); it != attendees.constEnd(); ++it ) {
      Attendee::Ptr a = *it;
      if ( !attendeeIsOrganizer( incidence, a ) ) {
        QString statusStr = Stringify::attendeeStatus( a->status () );
        if ( sender && ( a->email() == sender->email() ) ) {
          // use the attendee taken from the response incidence,
          // rather than the attendee from the calendar incidence.
          if ( a->status() != sender->status() ) {
            statusStr = i18n( "%1 (<i>unrecorded</i>)",
                              Stringify::attendeeStatus( sender->status() ) );
          }
          a = sender;
        }
        count++;
        if ( count == 1 ) {
          tmpStr += "<table border=\"1\" cellpadding=\"1\" cellspacing=\"0\">";
        }
        tmpStr += "<tr>";
        tmpStr += "<td>";
        comments.clear();
        if ( iamAttendee( a ) ) {
          comments << i18n( "myself" );
        }
        if ( !a->delegator().isEmpty() ) {
          comments << i18n( " (delegated by %1)", a->delegator() );
        }
        if ( !a->delegate().isEmpty() ) {
          comments << i18n( " (delegated to %1)", a->delegate() );
        }
        tmpStr += invitationPerson( a->email(), a->name(), QString(), comments.join( "," ) );
        tmpStr += "</td>";
        tmpStr += "<td>" + statusStr + "</td>";
        tmpStr += "</tr>";
      }
    }
  }
  if ( count ) {
    tmpStr += "</table>";
  } else {
    tmpStr += "<i>" + i18nc( "no attendees", "None" ) + "</i>";
  }

  return tmpStr;
}

static QString invitationAttachments( InvitationFormatterHelper *helper,
                                      const Incidence::Ptr &incidence )
{
  QString tmpStr;
  if ( !incidence ) {
    return tmpStr;
  }

  Attachment::List attachments = incidence->attachments();
  if ( !attachments.isEmpty() ) {
    tmpStr += i18n( "Attached Documents:" ) + "<ol>";

    Attachment::List::ConstIterator it;
    for ( it = attachments.constBegin(); it != attachments.constEnd(); ++it ) {
      Attachment::Ptr a = *it;
      tmpStr += "<li>";
      // Attachment icon
      KMimeType::Ptr mimeType = KMimeType::mimeType( a->mimeType() );
      const QString iconStr = ( mimeType ?
                                mimeType->iconName( a->uri() ) :
                                QString( "application-octet-stream" ) );
      const QString iconPath = KIconLoader::global()->iconPath( iconStr, KIconLoader::Small );
      if ( !iconPath.isEmpty() ) {
        tmpStr += "<img valign=\"top\" src=\"" + iconPath + "\">";
      }
      tmpStr += helper->makeLink( "ATTACH:" + a->label(), a->label() );
      tmpStr += "</li>";
    }
    tmpStr += "</ol>";
  }

  return tmpStr;
}

//@cond PRIVATE
class KCalUtils::IncidenceFormatter::ScheduleMessageVisitor : public Visitor
{
  public:
    ScheduleMessageVisitor() : mMessage( 0 ) { mResult = ""; }
    bool act( const IncidenceBase::Ptr &incidence,
              const Incidence::Ptr &existingIncidence,
              ScheduleMessage::Ptr msg, const QString &sender )
    {
      mExistingIncidence = existingIncidence;
      mMessage = msg;
      mSender = sender;
      return incidence->accept( *this, incidence );
    }
    QString result() const { return mResult; }

  protected:
    QString mResult;
    Incidence::Ptr mExistingIncidence;
    ScheduleMessage::Ptr mMessage;
    QString mSender;
};

class KCalUtils::IncidenceFormatter::InvitationHeaderVisitor :
      public IncidenceFormatter::ScheduleMessageVisitor
{
  protected:
    bool visit( Event::Ptr event )
    {
      mResult = invitationHeaderEvent( event, mExistingIncidence, mMessage, mSender );
      return !mResult.isEmpty();
    }
    bool visit( Todo::Ptr todo )
    {
      mResult = invitationHeaderTodo( todo, mExistingIncidence, mMessage, mSender );
      return !mResult.isEmpty();
    }
    bool visit( Journal::Ptr journal )
    {
      mResult = invitationHeaderJournal( journal, mMessage );
      return !mResult.isEmpty();
    }
    bool visit( FreeBusy::Ptr fb )
    {
      mResult = invitationHeaderFreeBusy( fb, mMessage );
      return !mResult.isEmpty();
    }
};

class KCalUtils::IncidenceFormatter::InvitationBodyVisitor
  : public IncidenceFormatter::ScheduleMessageVisitor
{
  public:
    InvitationBodyVisitor( bool noHtmlMode, KDateTime::Spec spec )
      : ScheduleMessageVisitor(), mNoHtmlMode( noHtmlMode ), mSpec( spec ) {}

  protected:
    bool visit( Event::Ptr event )
    {
      Event::Ptr oldevent = mExistingIncidence.dynamicCast<Event>();
      mResult = invitationDetailsEvent( event, oldevent, mMessage, mNoHtmlMode, mSpec );
      return !mResult.isEmpty();
    }
    bool visit( Todo::Ptr todo )
    {
      Todo::Ptr oldtodo = mExistingIncidence.dynamicCast<Todo>();
      mResult = invitationDetailsTodo( todo, oldtodo, mMessage, mNoHtmlMode, mSpec );
      return !mResult.isEmpty();
    }
    bool visit( Journal::Ptr journal )
    {
      Journal::Ptr oldjournal = mExistingIncidence.dynamicCast<Journal>();
      mResult = invitationDetailsJournal( journal, oldjournal, mNoHtmlMode, mSpec );
      return !mResult.isEmpty();
    }
    bool visit( FreeBusy::Ptr fb )
    {
      mResult = invitationDetailsFreeBusy( fb, FreeBusy::Ptr(), mNoHtmlMode, mSpec );
      return !mResult.isEmpty();
    }

  private:
    bool mNoHtmlMode;
    KDateTime::Spec mSpec;
};
//@endcond

InvitationFormatterHelper::InvitationFormatterHelper()
  : d( 0 )
{
}

InvitationFormatterHelper::~InvitationFormatterHelper()
{
}

QString InvitationFormatterHelper::generateLinkURL( const QString &id )
{
  return id;
}

//@cond PRIVATE
class IncidenceFormatter::IncidenceCompareVisitor : public Visitor
{
  public:
    IncidenceCompareVisitor() {}
    bool act( const IncidenceBase::Ptr &incidence,
              const Incidence::Ptr &existingIncidence )
    {
      if ( !existingIncidence ) {
        return false;
      }
      Incidence::Ptr inc = incidence.staticCast<Incidence>();
      if ( !inc || !existingIncidence ||
           inc->revision() <= existingIncidence->revision() ) {
        return false;
      }
      mExistingIncidence = existingIncidence;
      return incidence->accept( *this, incidence );
    }

    QString result() const
    {
      if ( mChanges.isEmpty() ) {
        return QString();
      }
      QString html = "<div align=\"left\"><ul><li>";
      html += mChanges.join( "</li><li>" );
      html += "</li><ul></div>";
      return html;
    }

  protected:
    bool visit( Event::Ptr event )
    {
      compareEvents( event, mExistingIncidence.dynamicCast<Event>() );
      compareIncidences( event, mExistingIncidence );
      return !mChanges.isEmpty();
    }
    bool visit( Todo::Ptr todo )
    {
      compareTodos( todo, mExistingIncidence.dynamicCast<Todo>() );
      compareIncidences( todo, mExistingIncidence );
      return !mChanges.isEmpty();
    }
    bool visit( Journal::Ptr journal )
    {
      compareIncidences( journal, mExistingIncidence );
      return !mChanges.isEmpty();
    }
    bool visit( FreeBusy::Ptr fb )
    {
      Q_UNUSED( fb );
      return !mChanges.isEmpty();
    }

  private:
    void compareEvents( const Event::Ptr &newEvent,
                        const Event::Ptr &oldEvent )
    {
      if ( !oldEvent || !newEvent ) {
        return;
      }
      if ( oldEvent->dtStart() != newEvent->dtStart() ||
           oldEvent->allDay() != newEvent->allDay() ) {
        mChanges += i18n( "The invitation starting time has been changed from %1 to %2",
                          eventStartTimeStr( oldEvent ), eventStartTimeStr( newEvent ) );
      }
      if ( oldEvent->dtEnd() != newEvent->dtEnd() ||
           oldEvent->allDay() != newEvent->allDay() ) {
        mChanges += i18n( "The invitation ending time has been changed from %1 to %2",
                          eventEndTimeStr( oldEvent ), eventEndTimeStr( newEvent ) );
      }
    }

    void compareTodos( const Todo::Ptr &newTodo,
                       const Todo::Ptr &oldTodo )
    {
      if ( !oldTodo || !newTodo ) {
        return;
      }

      if ( !oldTodo->isCompleted() && newTodo->isCompleted() ) {
        mChanges += i18n( "The to-do has been completed" );
      }
      if ( oldTodo->isCompleted() && !newTodo->isCompleted() ) {
        mChanges += i18n( "The to-do is no longer completed" );
      }
      if ( oldTodo->percentComplete() != newTodo->percentComplete() ) {
        const QString oldPer = i18n( "%1%", oldTodo->percentComplete() );
        const QString newPer = i18n( "%1%", newTodo->percentComplete() );
        mChanges += i18n( "The task completed percentage has changed from %1 to %2",
                          oldPer, newPer );
      }

      if ( !oldTodo->hasStartDate() && newTodo->hasStartDate() ) {
        mChanges += i18n( "A to-do starting time has been added" );
      }
      if ( oldTodo->hasStartDate() && !newTodo->hasStartDate() ) {
        mChanges += i18n( "The to-do starting time has been removed" );
      }
      if ( oldTodo->hasStartDate() && newTodo->hasStartDate() &&
           oldTodo->dtStart() != newTodo->dtStart() ) {
        mChanges += i18n( "The to-do starting time has been changed from %1 to %2",
                          dateTimeToString( oldTodo->dtStart(), oldTodo->allDay(), false ),
                          dateTimeToString( newTodo->dtStart(), newTodo->allDay(), false ) );
      }

      if ( !oldTodo->hasDueDate() && newTodo->hasDueDate() ) {
        mChanges += i18n( "A to-do due time has been added" );
      }
      if ( oldTodo->hasDueDate() && !newTodo->hasDueDate() ) {
        mChanges += i18n( "The to-do due time has been removed" );
      }
      if ( oldTodo->hasDueDate() && newTodo->hasDueDate() &&
           oldTodo->dtDue() != newTodo->dtDue() ) {
        mChanges += i18n( "The to-do due time has been changed from %1 to %2",
                          dateTimeToString( oldTodo->dtDue(), oldTodo->allDay(), false ),
                          dateTimeToString( newTodo->dtDue(), newTodo->allDay(), false ) );
      }
    }

    void compareIncidences( const Incidence::Ptr &newInc,
                            const Incidence::Ptr &oldInc )
    {
      if ( !oldInc || !newInc ) {
        return;
      }

      if ( oldInc->summary() != newInc->summary() ) {
        mChanges += i18n( "The summary has been changed to: \"%1\"",
                          newInc->richSummary() );
      }

      if ( oldInc->location() != newInc->location() ) {
        mChanges += i18n( "The location has been changed to: \"%1\"",
                          newInc->richLocation() );
      }

      if ( oldInc->description() != newInc->description() ) {
        mChanges += i18n( "The description has been changed to: \"%1\"",
                          newInc->richDescription() );
      }

      Attendee::List oldAttendees = oldInc->attendees();
      Attendee::List newAttendees = newInc->attendees();
      for ( Attendee::List::ConstIterator it = newAttendees.constBegin();
            it != newAttendees.constEnd(); ++it ) {
        Attendee::Ptr oldAtt = oldInc->attendeeByMail( (*it)->email() );
        if ( !oldAtt ) {
          mChanges += i18n( "Attendee %1 has been added", (*it)->fullName() );
        } else {
          if ( oldAtt->status() != (*it)->status() ) {
            mChanges += i18n( "The status of attendee %1 has been changed to: %2",
                              (*it)->fullName(), Stringify::attendeeStatus( (*it)->status() ) );
          }
        }
      }

      for ( Attendee::List::ConstIterator it = oldAttendees.constBegin();
            it != oldAttendees.constEnd(); ++it ) {
        if ( !attendeeIsOrganizer( oldInc, (*it) ) ) {
          Attendee::Ptr newAtt = newInc->attendeeByMail( (*it)->email() );
          if ( !newAtt ) {
            mChanges += i18n( "Attendee %1 has been removed", (*it)->fullName() );
          }
        }
      }
    }

  private:
    Incidence::Ptr mExistingIncidence;
    QStringList mChanges;
};
//@endcond

QString InvitationFormatterHelper::makeLink( const QString &id, const QString &text )
{
  if ( !id.startsWith( QLatin1String( "ATTACH:" ) ) ) {
    QString res = QString( "<a href=\"%1\"><b>%2</b></a>" ).
                  arg( generateLinkURL( id ), text );
    return res;
  } else {
    // draw the attachment links in non-bold face
    QString res = QString( "<a href=\"%1\">%2</a>" ).
                  arg( generateLinkURL( id ), text );
    return res;
  }
}

// Check if the given incidence is likely one that we own instead one from
// a shared calendar (Kolab-specific)
static bool incidenceOwnedByMe( const Calendar::Ptr &calendar,
                                const Incidence::Ptr &incidence )
{
  Q_UNUSED( calendar );
  Q_UNUSED( incidence );
  return true;
}

// The open & close table cell tags for the invitation buttons
static QString tdOpen = "<td style=\"border-width:2px;border-style:outset\">";
static QString tdClose = "</td>";

static QString responseButtons( const Incidence::Ptr &inc,
                                bool rsvpReq, bool rsvpRec,
                                InvitationFormatterHelper *helper )
{
  QString html;
  if ( !helper ) {
    return html;
  }

  if ( !rsvpReq && ( inc && inc->revision() == 0 ) ) {
    // Record only
    html += tdOpen;
    html += helper->makeLink( "record", i18n( "[Record]" ) );
    html += tdClose;

    // Move to trash
    html += tdOpen;
    html += helper->makeLink( "delete", i18n( "[Move to Trash]" ) );
    html += tdClose;

  } else {

    // Accept
    html += tdOpen;
    html += helper->makeLink( "accept", i18nc( "accept invitation", "Accept" ) );
    html += tdClose;

    // Tentative
    html += tdOpen;
    html += helper->makeLink( "accept_conditionally",
                              i18nc( "Accept invitation conditionally", "Accept cond." ) );
    html += tdClose;

    // Counter proposal
    html += tdOpen;
    html += helper->makeLink( "counter",
                              i18nc( "invitation counter proposal", "Counter proposal" ) );
    html += tdClose;

    // Decline
    html += tdOpen;
    html += helper->makeLink( "decline",
                              i18nc( "decline invitation", "Decline" ) );
    html += tdClose;
  }

  if ( !rsvpRec || ( inc && inc->revision() > 0 ) ) {
    // Delegate
    html += tdOpen;
    html += helper->makeLink( "delegate",
                              i18nc( "delegate inviation to another", "Delegate" ) );
    html += tdClose;

    // Forward
    html += tdOpen;
    html += helper->makeLink( "forward",
                              i18nc( "forward request to another", "Forward" ) );
    html += tdClose;

    // Check calendar
    if ( inc && inc->type() == Incidence::TypeEvent ) {
      html += tdOpen;
      html += helper->makeLink( "check_calendar",
                                i18nc( "look for scheduling conflicts", "Check my calendar" ) );
      html += tdClose;
    }
  }
  return html;
}

static QString counterButtons( const Incidence::Ptr &incidence,
                               InvitationFormatterHelper *helper )
{
  QString html;
  if ( !helper ) {
    return html;
  }

  // Accept proposal
  html += tdOpen;
  html += helper->makeLink( "accept_counter", i18n( "[Accept]" ) );
  html += tdClose;

  // Decline proposal
  html += tdOpen;
  html += helper->makeLink( "decline_counter", i18n( "[Decline]" ) );
  html += tdClose;

  // Check calendar
  if ( incidence && incidence->type() == Incidence::TypeEvent ) {
    html += tdOpen;
    html += helper->makeLink( "check_calendar", i18n( "[Check my calendar] " ) );
    html += tdClose;
  }
  return html;
}

Calendar::Ptr InvitationFormatterHelper::calendar() const
{
  return Calendar::Ptr();
}

static QString formatICalInvitationHelper( QString invitation,
                                           const MemoryCalendar::Ptr &mCalendar,
                                           InvitationFormatterHelper *helper,
                                           bool noHtmlMode,
                                           KDateTime::Spec spec,
                                           const QString &sender,
                                           bool outlookCompareStyle )
{
  if ( invitation.isEmpty() ) {
    return QString();
  }

  ICalFormat format;
  // parseScheduleMessage takes the tz from the calendar,
  // no need to set it manually here for the format!
  ScheduleMessage::Ptr msg = format.parseScheduleMessage( mCalendar, invitation );

  if( !msg ) {
    kDebug() << "Failed to parse the scheduling message";
    Q_ASSERT( format.exception() );
    kDebug() << Stringify::errorMessage( *format.exception() ); //krazy:exclude=kdebug
    return QString();
  }

  IncidenceBase::Ptr incBase = msg->event();

  incBase->shiftTimes( mCalendar->timeSpec(), KDateTime::Spec::LocalZone() );

  // Determine if this incidence is in my calendar (and owned by me)
  Incidence::Ptr existingIncidence;
  if ( incBase && helper->calendar() ) {
    existingIncidence = helper->calendar()->incidence( incBase->uid() );

    if ( !incidenceOwnedByMe( helper->calendar(), existingIncidence ) ) {
      existingIncidence.clear();
    }
    if ( !existingIncidence ) {
      const Incidence::List list = helper->calendar()->incidences();
      for ( Incidence::List::ConstIterator it = list.begin(), end = list.end(); it != end; ++it ) {
        if ( (*it)->schedulingID() == incBase->uid() &&
             incidenceOwnedByMe( helper->calendar(), *it ) ) {
          existingIncidence = *it;
          break;
        }
      }
    }
  }

  Incidence::Ptr inc = incBase.staticCast<Incidence>();  // the incidence in the invitation email

  // First make the text of the message
  QString html;
  html += "<div align=\"center\" style=\"border:solid 1px;\">";

  IncidenceFormatter::InvitationHeaderVisitor headerVisitor;
  // The InvitationHeaderVisitor returns false if the incidence is somehow invalid, or not handled
  if ( !headerVisitor.act( inc, existingIncidence, msg, sender ) ) {
    return QString();
  }
  html += htmlAddTag( "h3", headerVisitor.result() );

  if ( outlookCompareStyle ||
       msg->method() == iTIPDeclineCounter ) { //use Outlook style for decline
    // use the Outlook 2007 Comparison Style
    IncidenceFormatter::InvitationBodyVisitor bodyVisitor( noHtmlMode, spec );
    bool bodyOk;
    if ( msg->method() == iTIPRequest || msg->method() == iTIPReply ||
         msg->method() == iTIPDeclineCounter ) {
      if ( inc && existingIncidence &&
           inc->revision() < existingIncidence->revision() ) {
        bodyOk = bodyVisitor.act( existingIncidence, inc, msg, sender );
      } else {
        bodyOk = bodyVisitor.act( inc, existingIncidence, msg, sender );
      }
    } else {
      bodyOk = bodyVisitor.act( inc, Incidence::Ptr(), msg, sender );
    }
    if ( bodyOk ) {
      html += bodyVisitor.result();
    } else {
      return QString();
    }
  } else {
    // use our "Classic" Comparison Style
    InvitationBodyVisitor bodyVisitor( noHtmlMode, spec );
    if ( !bodyVisitor.act( inc, Incidence::Ptr(), msg, sender ) ) {
      return QString();
    }
    html += bodyVisitor.result();

    if ( msg->method() == iTIPRequest ) {
      IncidenceFormatter::IncidenceCompareVisitor compareVisitor;
      if ( compareVisitor.act( inc, existingIncidence ) ) {
        html += "<p align=\"left\">";
        if ( senderIsOrganizer( inc, sender ) ) {
          html += i18n( "The following changes have been made by the organizer:" );
        } else if ( !sender.isEmpty() ) {
          html += i18n( "The following changes have been made by %1:", sender );
        } else {
          html += i18n( "The following changes have been made:" );
        }
        html += "</p>";
        html += compareVisitor.result();
      }
    }
    if ( msg->method() == iTIPReply ) {
      IncidenceCompareVisitor compareVisitor;
      if ( compareVisitor.act( inc, existingIncidence ) ) {
        html += "<p align=\"left\">";
        if ( !sender.isEmpty() ) {
          html += i18n( "The following changes have been made by %1:", sender );
        } else {
          html += i18n( "The following changes have been made by an attendee:" );
        }
        html += "</p>";
        html += compareVisitor.result();
      }
    }
  }

  // determine if I am the organizer for this invitation
  bool myInc = iamOrganizer( inc );

  // determine if the invitation response has already been recorded
  bool rsvpRec = false;
  Attendee::Ptr ea;
  if ( !myInc ) {
    Incidence::Ptr rsvpIncidence = existingIncidence;
    if ( !rsvpIncidence && inc && inc->revision() > 0 ) {
      rsvpIncidence = inc;
    }
    if ( rsvpIncidence ) {
      ea = findMyAttendee( rsvpIncidence );
    }
    if ( ea &&
         ( ea->status() == Attendee::Accepted ||
           ea->status() == Attendee::Declined ||
           ea->status() == Attendee::Tentative ) ) {
      rsvpRec = true;
    }
  }

  // determine invitation role
  QString role;
  bool isDelegated = false;
  Attendee::Ptr a = findMyAttendee( inc );
  if ( !a && inc ) {
    if ( !inc->attendees().isEmpty() ) {
      a = inc->attendees().first();
    }
  }
  if ( a ) {
    isDelegated = ( a->status() == Attendee::Delegated );
    role = Stringify::attendeeRole( a->role() );
  }

  // determine if RSVP needed, not-needed, or response already recorded
  bool rsvpReq = rsvpRequested( inc );
  if ( !myInc && a ) {
    html += "<br/>";
    html += "<i><u>";
    if ( rsvpRec && inc ) {
      if ( inc->revision() == 0 ) {
        html += i18n( "Your <b>%1</b> response has been recorded",
                      Stringify::attendeeStatus( ea->status() ) );
      } else {
        html += i18n( "Your status for this invitation is <b>%1</b>",
                      Stringify::attendeeStatus( ea->status() ) );
      }
      rsvpReq = false;
    } else if ( msg->method() == iTIPCancel ) {
      html += i18n( "This invitation was canceled" );
    } else if ( msg->method() == iTIPAdd ) {
      html += i18n( "This invitation was accepted" );
    } else if ( msg->method() == iTIPDeclineCounter ) {
      rsvpReq = true;
      html += rsvpRequestedStr( rsvpReq, role );
    } else {
      if ( !isDelegated ) {
        html += rsvpRequestedStr( rsvpReq, role );
      } else {
        html += i18n( "Awaiting delegation response" );
      }
    }
    html += "</u></i>";
  }

  // Print if the organizer gave you a preset status
  if ( !myInc ) {
    if ( inc && inc->revision() == 0 ) {
      QString statStr = myStatusStr( inc );
      if ( !statStr.isEmpty() ) {
        html += "<br/>";
        html += "<i>";
        html += statStr;
        html += "</i>";
      }
    }
  }

  // Add groupware links

  html += "<p>";
  html += "<table border=\"0\" align=\"center\" cellspacing=\"4\"><tr>";

  switch ( msg->method() ) {
    case iTIPPublish:
    case iTIPRequest:
    case iTIPRefresh:
    case iTIPAdd:
    {
      if ( inc && inc->revision() > 0 && ( existingIncidence || !helper->calendar() ) ) {
        if ( inc->type() == Incidence::TypeTodo ) {
          html += helper->makeLink( "reply", i18n( "[Record invitation in my to-do list]" ) );
        } else {
          html += helper->makeLink( "reply", i18n( "[Record invitation in my calendar]" ) );
        }
      }

      if ( !myInc && a ) {
        html += responseButtons( inc, rsvpReq, rsvpRec, helper );
      }
      break;
    }

    case iTIPCancel:
      // Remove invitation
      if ( inc ) {
        html += tdOpen;
        if ( inc->type() == Incidence::TypeTodo ) {
          html += helper->makeLink( "cancel",
                                    i18n( "Remove invitation from my to-do list" ) );
        } else {
          html += helper->makeLink( "cancel",
                                    i18n( "Remove invitation from my calendar" ) );
        }
        html += tdClose;
      }
      break;

    case iTIPReply:
    {
      // Record invitation response
      Attendee::Ptr a;
      Attendee::Ptr ea;
      if ( inc ) {
        // First, determine if this reply is really a counter in disguise.
        if ( replyMeansCounter( inc ) ) {
          html += "<tr>" + counterButtons( inc, helper ) + "</tr>";
          break;
        }

        // Next, maybe this is a declined reply that was delegated from me?
        // find first attendee who is delegated-from me
        // look a their PARTSTAT response, if the response is declined,
        // then we need to start over which means putting all the action
        // buttons and NOT putting on the [Record response..] button
        a = findDelegatedFromMyAttendee( inc );
        if ( a ) {
          if ( a->status() != Attendee::Accepted ||
               a->status() != Attendee::Tentative ) {
            html += responseButtons( inc, rsvpReq, rsvpRec, helper );
            break;
          }
        }

        // Finally, simply allow a Record of the reply
        if ( !inc->attendees().isEmpty() ) {
          a = inc->attendees().first();
        }
        if ( a && helper->calendar() ) {
          ea = findAttendee( existingIncidence, a->email() );
        }
      }
      if ( ea && ( ea->status() != Attendee::NeedsAction ) && ( ea->status() == a->status() ) ) {
        html += tdOpen;
        html += htmlAddTag( "i", i18n( "The <b>%1</b> response has been recorded",
                                       Stringify::attendeeStatus( ea->status() ) ) );
        html += tdClose;
      } else {
        if ( inc ) {
          if ( inc->type() == Incidence::TypeTodo ) {
            html += helper->makeLink( "reply", i18n( "[Record response in my to-do list]" ) );
          } else {
            html += helper->makeLink( "reply", i18n( "[Record response in my calendar]" ) );
          }
        }
      }
      break;
    }

    case iTIPCounter:
      // Counter proposal
      html += counterButtons( inc, helper );
      break;

    case iTIPDeclineCounter:
      html += responseButtons( inc, rsvpReq, rsvpRec, helper );
      break;

    case iTIPNoMethod:
      break;
  }

  // close the groupware table
  html += "</tr></table>";

  // Add the attendee list
  if ( myInc ) {
    html += invitationRsvpList( existingIncidence, a );
  } else {
    html += invitationAttendeeList( inc );
  }

  // close the top-level table
  html += "</div>";

  // Add the attachment list
  html += invitationAttachments( helper, inc );

  return html;
}
//@endcond

QString IncidenceFormatter::formatICalInvitation( QString invitation,
                                                  const MemoryCalendar::Ptr &calendar,
                                                  InvitationFormatterHelper *helper,
                                                  bool outlookCompareStyle )
{
  return formatICalInvitationHelper( invitation, calendar, helper, false,
                                     KSystemTimeZones::local(), QString(),
                                     outlookCompareStyle );
}

QString IncidenceFormatter::formatICalInvitationNoHtml( const QString &invitation,
                                                        const MemoryCalendar::Ptr &calendar,
                                                        InvitationFormatterHelper *helper,
                                                        const QString &sender,
                                                        bool outlookCompareStyle )
{
  return formatICalInvitationHelper( invitation, calendar, helper, true,
                                     KSystemTimeZones::local(), sender,
                                     outlookCompareStyle );
}

/*******************************************************************
 *  Helper functions for the Incidence tooltips
 *******************************************************************/

//@cond PRIVATE
class KCalUtils::IncidenceFormatter::ToolTipVisitor : public Visitor
{
  public:
    ToolTipVisitor()
      : mRichText( true ), mSpec( KDateTime::Spec() ), mResult( "" ) {}

    bool act( const MemoryCalendar::Ptr &calendar,
              const IncidenceBase::Ptr &incidence,
              const QDate &date=QDate(), bool richText=true,
              KDateTime::Spec spec=KDateTime::Spec() )
    {
      mCalendar = calendar;
      mLocation.clear();
      mDate = date;
      mRichText = richText;
      mSpec = spec;
      mResult = "";
      return incidence ? incidence->accept( *this, incidence ) : false;
    }

    bool act( const QString &location, const IncidenceBase::Ptr &incidence,
              const QDate &date=QDate(), bool richText=true,
              KDateTime::Spec spec=KDateTime::Spec() )
    {
      mLocation = location;
      mDate = date;
      mRichText = richText;
      mSpec = spec;
      mResult = "";
      return incidence ? incidence->accept( *this, incidence ) : false;
    }

    QString result() const { return mResult; }

  protected:
    bool visit( Event::Ptr event );
    bool visit( Todo::Ptr todo );
    bool visit( Journal::Ptr journal );
    bool visit( FreeBusy::Ptr fb );

    QString dateRangeText( const Event::Ptr &event, const QDate &date );
    QString dateRangeText( const Todo::Ptr &todo, const QDate &date );
    QString dateRangeText( const Journal::Ptr &journal );
    QString dateRangeText( const FreeBusy::Ptr &fb );

    QString generateToolTip( const Incidence::Ptr &incidence, QString dtRangeText );

  protected:
    MemoryCalendar::Ptr mCalendar;
    QString mLocation;
    QDate mDate;
    bool mRichText;
    KDateTime::Spec mSpec;
    QString mResult;
};

QString IncidenceFormatter::ToolTipVisitor::dateRangeText( const Event::Ptr &event,
                                                           const QDate &date )
{
  //FIXME: support mRichText==false
  QString ret;
  QString tmp;

  KDateTime startDt = event->dtStart();
  KDateTime endDt = event->dtEnd();
  if ( event->recurs() ) {
    if ( date.isValid() ) {
      KDateTime kdt( date, QTime( 0, 0, 0 ), KSystemTimeZones::local() );
      int diffDays = startDt.daysTo( kdt );
      kdt = kdt.addSecs( -1 );
      startDt.setDate( event->recurrence()->getNextDateTime( kdt ).date() );
      if ( event->hasEndDate() ) {
        endDt = endDt.addDays( diffDays );
        if ( startDt > endDt ) {
          startDt.setDate( event->recurrence()->getPreviousDateTime( kdt ).date() );
          endDt = startDt.addDays( event->dtStart().daysTo( event->dtEnd() ) );
        }
      }
    }
  }

  if ( event->isMultiDay() ) {
    tmp = dateToString( startDt, true, mSpec );
    ret += "<br>" + i18nc( "Event start", "<i>From:</i> %1", tmp );

    tmp = dateToString( endDt, true, mSpec );
    ret += "<br>" + i18nc( "Event end","<i>To:</i> %1", tmp );

  } else {

    ret += "<br>" +
           i18n( "<i>Date:</i> %1", dateToString( startDt, false, mSpec ) );
    if ( !event->allDay() ) {
      const QString dtStartTime = timeToString( startDt, true, mSpec );
      const QString dtEndTime = timeToString( endDt, true, mSpec );
      if ( dtStartTime == dtEndTime ) {
        // to prevent 'Time: 17:00 - 17:00'
        tmp = "<br>" +
              i18nc( "time for event", "<i>Time:</i> %1",
                     dtStartTime );
      } else {
        tmp = "<br>" +
              i18nc( "time range for event",
                     "<i>Time:</i> %1 - %2",
                     dtStartTime, dtEndTime );
      }
      ret += tmp;
    }
  }
  return ret.replace( ' ', "&nbsp;" );
}

QString IncidenceFormatter::ToolTipVisitor::dateRangeText( const Todo::Ptr &todo,
                                                           const QDate &date )
{
  //FIXME: support mRichText==false
  QString ret;
  if ( todo->hasStartDate() && todo->dtStart().isValid() ) {
    KDateTime startDt = todo->dtStart();
    if ( todo->recurs() ) {
      if ( date.isValid() ) {
        startDt.setDate( date );
      }
    }
    ret += "<br>" +
           i18n( "<i>Start:</i> %1", dateToString( startDt, false, mSpec ) );
  }

  if ( todo->hasDueDate() && todo->dtDue().isValid() ) {
    KDateTime dueDt = todo->dtDue();
    if ( todo->recurs() ) {
      if ( date.isValid() ) {
        KDateTime kdt( date, QTime( 0, 0, 0 ), KSystemTimeZones::local() );
        kdt = kdt.addSecs( -1 );
        dueDt.setDate( todo->recurrence()->getNextDateTime( kdt ).date() );
      }
    }
    ret += "<br>" +
           i18n( "<i>Due:</i> %1",
                 dateTimeToString( dueDt, todo->allDay(), false, mSpec ) );
  }

  // Print priority and completed info here, for lack of a better place

  if ( todo->priority() > 0 ) {
    ret += "<br>";
    ret += "<i>" + i18n( "Priority:" ) + "</i>" + "&nbsp;";
    ret += QString::number( todo->priority() );
  }

  ret += "<br>";
  if ( todo->isCompleted() ) {
    ret += "<i>" + i18nc( "Completed: date", "Completed:" ) + "</i>" + "&nbsp;";
    ret += Stringify::todoCompletedDateTime( todo ).replace( ' ', "&nbsp;" );
  } else {
    ret += "<i>" + i18n( "Percent Done:" ) + "</i>" + "&nbsp;";
    ret += i18n( "%1%", todo->percentComplete() );
  }

  return ret.replace( ' ', "&nbsp;" );
}

QString IncidenceFormatter::ToolTipVisitor::dateRangeText( const Journal::Ptr &journal )
{
  //FIXME: support mRichText==false
  QString ret;
  if ( journal->dtStart().isValid() ) {
    ret += "<br>" +
           i18n( "<i>Date:</i> %1", dateToString( journal->dtStart(), false, mSpec ) );
  }
  return ret.replace( ' ', "&nbsp;" );
}

QString IncidenceFormatter::ToolTipVisitor::dateRangeText( const FreeBusy::Ptr &fb )
{
  //FIXME: support mRichText==false
  QString ret;
  ret = "<br>" +
        i18n( "<i>Period start:</i> %1",
              KGlobal::locale()->formatDateTime( fb->dtStart().dateTime() ) );
  ret += "<br>" +
         i18n( "<i>Period start:</i> %1",
               KGlobal::locale()->formatDateTime( fb->dtEnd().dateTime() ) );
  return ret.replace( ' ', "&nbsp;" );
}

bool IncidenceFormatter::ToolTipVisitor::visit( Event::Ptr event )
{
  mResult = generateToolTip( event, dateRangeText( event, mDate ) );
  return !mResult.isEmpty();
}

bool IncidenceFormatter::ToolTipVisitor::visit( Todo::Ptr todo )
{
  mResult = generateToolTip( todo, dateRangeText( todo, mDate ) );
  return !mResult.isEmpty();
}

bool IncidenceFormatter::ToolTipVisitor::visit( Journal::Ptr journal )
{
  mResult = generateToolTip( journal, dateRangeText( journal ) );
  return !mResult.isEmpty();
}

bool IncidenceFormatter::ToolTipVisitor::visit( FreeBusy::Ptr fb )
{
  //FIXME: support mRichText==false
  mResult = "<qt><b>" +
            i18n( "Free/Busy information for %1", fb->organizer()->fullName() ) +
            "</b>";
  mResult += dateRangeText( fb );
  mResult += "</qt>";
  return !mResult.isEmpty();
}

static QString tooltipPerson( const QString &email, const QString &name, Attendee::PartStat status )
{
  // Search for a new print name, if needed.
  const QString printName = searchName( email, name );

  // Get the icon corresponding to the attendee participation status.
  const QString iconPath = rsvpStatusIconPath( status );

  // Make the return string.
  QString personString;
  if ( !iconPath.isEmpty() ) {
    personString += "<img valign=\"top\" src=\"" + iconPath + "\">" + "&nbsp;";
  }
  if ( status != Attendee::None ) {
    personString += i18nc( "attendee name (attendee status)", "%1 (%2)",
                           printName.isEmpty() ? email : printName,
                           Stringify::attendeeStatus( status ) );
  } else {
    personString += i18n( "%1", printName.isEmpty() ? email : printName );
  }
  return personString;
}

static QString tooltipFormatOrganizer( const QString &email, const QString &name )
{
  // Search for a new print name, if needed
  const QString printName = searchName( email, name );

  // Get the icon for organizer
  const QString iconPath =
    KIconLoader::global()->iconPath( "meeting-organizer", KIconLoader::Small );

  // Make the return string.
  QString personString;
  personString += "<img valign=\"top\" src=\"" + iconPath + "\">" + "&nbsp;";
  personString += ( printName.isEmpty() ? email : printName );
  return personString;
}

static QString tooltipFormatAttendeeRoleList( const Incidence::Ptr &incidence,
                                              Attendee::Role role, bool showStatus )
{
  int maxNumAtts = 8; // maximum number of people to print per attendee role
  const QString etc = i18nc( "elipsis", "..." );

  int i = 0;
  QString tmpStr;
  Attendee::List::ConstIterator it;
  Attendee::List attendees = incidence->attendees();

  for ( it = attendees.constBegin(); it != attendees.constEnd(); ++it ) {
    Attendee::Ptr a = *it;
    if ( a->role() != role ) {
      // skip not this role
      continue;
    }
    if ( attendeeIsOrganizer( incidence, a ) ) {
      // skip attendee that is also the organizer
      continue;
    }
    if ( i == maxNumAtts ) {
      tmpStr += "&nbsp;&nbsp;" + etc;
      break;
    }
    tmpStr += "&nbsp;&nbsp;" + tooltipPerson( a->email(), a->name(),
                                              showStatus ? a->status() : Attendee::None );
    if ( !a->delegator().isEmpty() ) {
      tmpStr += i18n( " (delegated by %1)", a->delegator() );
    }
    if ( !a->delegate().isEmpty() ) {
      tmpStr += i18n( " (delegated to %1)", a->delegate() );
    }
    tmpStr += "<br>";
    i++;
  }
  if ( tmpStr.endsWith( QLatin1String( "<br>" ) ) ) {
    tmpStr.chop( 4 );
  }
  return tmpStr;
}

static QString tooltipFormatAttendees( const Calendar::Ptr &calendar,
                                       const Incidence::Ptr &incidence )
{
  QString tmpStr, str;

  // Add organizer link
  int attendeeCount = incidence->attendees().count();
  if ( attendeeCount > 1 ||
       ( attendeeCount == 1 &&
         !attendeeIsOrganizer( incidence, incidence->attendees().first() ) ) ) {
    tmpStr += "<i>" + i18n( "Organizer:" ) + "</i>" + "<br>";
    tmpStr += "&nbsp;&nbsp;" + tooltipFormatOrganizer( incidence->organizer()->email(),
                                                       incidence->organizer()->name() );
  }

  // Show the attendee status if the incidence's organizer owns the resource calendar,
  // which means they are running the show and have all the up-to-date response info.
  const bool showStatus = attendeeCount > 0 && incOrganizerOwnsCalendar( calendar, incidence );

  // Add "chair"
  str = tooltipFormatAttendeeRoleList( incidence, Attendee::Chair, showStatus );
  if ( !str.isEmpty() ) {
    tmpStr += "<br><i>" + i18n( "Chair:" ) + "</i>" + "<br>";
    tmpStr += str;
  }

  // Add required participants
  str = tooltipFormatAttendeeRoleList( incidence, Attendee::ReqParticipant, showStatus );
  if ( !str.isEmpty() ) {
    tmpStr += "<br><i>" + i18n( "Required Participants:" ) + "</i>" + "<br>";
    tmpStr += str;
  }

  // Add optional participants
  str = tooltipFormatAttendeeRoleList( incidence, Attendee::OptParticipant, showStatus );
  if ( !str.isEmpty() ) {
    tmpStr += "<br><i>" + i18n( "Optional Participants:" ) + "</i>" + "<br>";
    tmpStr += str;
  }

  // Add observers
  str = tooltipFormatAttendeeRoleList( incidence, Attendee::NonParticipant, showStatus );
  if ( !str.isEmpty() ) {
    tmpStr += "<br><i>" + i18n( "Observers:" ) + "</i>" + "<br>";
    tmpStr += str;
  }

  return tmpStr;
}

QString IncidenceFormatter::ToolTipVisitor::generateToolTip( const Incidence::Ptr &incidence,
                                                             QString dtRangeText )
{
  int maxDescLen = 120; // maximum description chars to print (before elipsis)

  //FIXME: support mRichText==false
  if ( !incidence ) {
    return QString();
  }

  QString tmp = "<qt>";

  // header
  tmp += "<b>" + incidence->richSummary() + "</b>";
  tmp += "<hr>";

  QString calStr = mLocation;
  if ( mCalendar ) {
    calStr = resourceString( mCalendar, incidence );
  }
  if ( !calStr.isEmpty() ) {
    tmp += "<i>" + i18n( "Calendar:" ) + "</i>" + "&nbsp;";
    tmp += calStr;
  }

  tmp += dtRangeText;

  if ( !incidence->location().isEmpty() ) {
    tmp += "<br>";
    tmp += "<i>" + i18n( "Location:" ) + "</i>" + "&nbsp;";
    tmp += incidence->richLocation();
  }

  QString durStr = durationString( incidence );
  if ( !durStr.isEmpty() ) {
    tmp += "<br>";
    tmp += "<i>" + i18n( "Duration:" ) + "</i>" + "&nbsp;";
    tmp += durStr;
  }

  if ( incidence->recurs() ) {
    tmp += "<br>";
    tmp += "<i>" + i18n( "Recurrence:" ) + "</i>" + "&nbsp;";
    tmp += recurrenceString( incidence );
  }

  if ( !incidence->description().isEmpty() ) {
    QString desc( incidence->description() );
    if ( !incidence->descriptionIsRich() ) {
      if ( desc.length() > maxDescLen ) {
        desc = desc.left( maxDescLen ) + i18nc( "elipsis", "..." );
      }
      desc = Qt::escape( desc ).replace( '\n', "<br>" );
    } else {
      // TODO: truncate the description when it's rich text
    }
    tmp += "<hr>";
    tmp += "<i>" + i18n( "Description:" ) + "</i>" + "<br>";
    tmp += desc;
    tmp += "<hr>";
  }

  int reminderCount = incidence->alarms().count();
  if ( reminderCount > 0 && incidence->hasEnabledAlarms() ) {
    tmp += "<br>";
    tmp += "<i>" + i18np( "Reminder:", "Reminders:", reminderCount ) + "</i>" + "&nbsp;";
    tmp += reminderStringList( incidence ).join( ", " );
  }

  tmp += "<br>";
  tmp += tooltipFormatAttendees( mCalendar, incidence );

  int categoryCount = incidence->categories().count();
  if ( categoryCount > 0 ) {
    tmp += "<br>";
    tmp += "<i>" + i18np( "Category:", "Categories:", categoryCount ) + "</i>" + "&nbsp;";
    tmp += incidence->categories().join( ", " );
  }

  tmp += "</qt>";
  return tmp;
}
//@endcond

QString IncidenceFormatter::toolTipStr( const QString &sourceName,
                                        const IncidenceBase::Ptr &incidence,
                                        const QDate &date,
                                        bool richText,
                                        KDateTime::Spec spec )
{
  ToolTipVisitor v;
  if ( v.act( sourceName, incidence, date, richText, spec ) ) {
    return v.result();
  } else {
    return QString();
  }
}

/*******************************************************************
 *  Helper functions for the Incidence tooltips
 *******************************************************************/

//@cond PRIVATE
static QString mailBodyIncidence( const Incidence::Ptr &incidence )
{
  QString body;
  if ( !incidence->summary().isEmpty() ) {
    body += i18n( "Summary: %1\n", incidence->richSummary() );
  }
  if ( !incidence->organizer()->isEmpty() ) {
    body += i18n( "Organizer: %1\n", incidence->organizer()->fullName() );
  }
  if ( !incidence->location().isEmpty() ) {
    body += i18n( "Location: %1\n", incidence->richLocation() );
  }
  return body;
}
//@endcond

//@cond PRIVATE
class KCalUtils::IncidenceFormatter::MailBodyVisitor : public Visitor
{
  public:
    MailBodyVisitor()
      : mSpec( KDateTime::Spec() ), mResult( "" ) {}

    bool act( IncidenceBase::Ptr incidence, KDateTime::Spec spec=KDateTime::Spec() )
    {
      mSpec = spec;
      mResult = "";
      return incidence ? incidence->accept( *this, incidence ) : false;
    }
    QString result() const
    {
      return mResult;
    }

  protected:
    bool visit( Event::Ptr event );
    bool visit( Todo::Ptr todo );
    bool visit( Journal::Ptr journal );
    bool visit( FreeBusy::Ptr )
    {
      mResult = i18n( "This is a Free Busy Object" );
      return !mResult.isEmpty();
    }
  protected:
    KDateTime::Spec mSpec;
    QString mResult;
};

bool IncidenceFormatter::MailBodyVisitor::visit( Event::Ptr event )
{
  QString recurrence[]= {
    i18nc( "no recurrence", "None" ),
    i18nc( "event recurs by minutes", "Minutely" ),
    i18nc( "event recurs by hours", "Hourly" ),
    i18nc( "event recurs by days", "Daily" ),
    i18nc( "event recurs by weeks", "Weekly" ),
    i18nc( "event recurs same position (e.g. first monday) each month", "Monthly Same Position" ),
    i18nc( "event recurs same day each month", "Monthly Same Day" ),
    i18nc( "event recurs same month each year", "Yearly Same Month" ),
    i18nc( "event recurs same day each year", "Yearly Same Day" ),
    i18nc( "event recurs same position (e.g. first monday) each year", "Yearly Same Position" )
  };

  mResult = mailBodyIncidence( event );
  mResult += i18n( "Start Date: %1\n", dateToString( event->dtStart(), true, mSpec ) );
  if ( !event->allDay() ) {
    mResult += i18n( "Start Time: %1\n", timeToString( event->dtStart(), true, mSpec ) );
  }
  if ( event->dtStart() != event->dtEnd() ) {
    mResult += i18n( "End Date: %1\n", dateToString( event->dtEnd(), true, mSpec ) );
  }
  if ( !event->allDay() ) {
    mResult += i18n( "End Time: %1\n", timeToString( event->dtEnd(), true, mSpec ) );
  }
  if ( event->recurs() ) {
    Recurrence *recur = event->recurrence();
    // TODO: Merge these two to one of the form "Recurs every 3 days"
    mResult += i18n( "Recurs: %1\n", recurrence[ recur->recurrenceType() ] );
    mResult += i18n( "Frequency: %1\n", event->recurrence()->frequency() );

    if ( recur->duration() > 0 ) {
      mResult += i18np( "Repeats once", "Repeats %1 times", recur->duration() );
      mResult += '\n';
    } else {
      if ( recur->duration() != -1 ) {
// TODO_Recurrence: What to do with all-day
        QString endstr;
        if ( event->allDay() ) {
          endstr = KGlobal::locale()->formatDate( recur->endDate() );
        } else {
          endstr = KGlobal::locale()->formatDateTime( recur->endDateTime().dateTime() );
        }
        mResult += i18n( "Repeat until: %1\n", endstr );
      } else {
        mResult += i18n( "Repeats forever\n" );
      }
    }
  }

  QString details = event->richDescription();
  if ( !details.isEmpty() ) {
    mResult += i18n( "Details:\n%1\n", details );
  }
  return !mResult.isEmpty();
}

bool IncidenceFormatter::MailBodyVisitor::visit( Todo::Ptr todo )
{
  mResult = mailBodyIncidence( todo );

  if ( todo->hasStartDate() && todo->dtStart().isValid() ) {
    mResult += i18n( "Start Date: %1\n", dateToString( todo->dtStart( false ), true, mSpec ) );
    if ( !todo->allDay() ) {
      mResult += i18n( "Start Time: %1\n", timeToString( todo->dtStart( false ), true, mSpec ) );
    }
  }
  if ( todo->hasDueDate() && todo->dtDue().isValid() ) {
    mResult += i18n( "Due Date: %1\n", dateToString( todo->dtDue(), true, mSpec ) );
    if ( !todo->allDay() ) {
      mResult += i18n( "Due Time: %1\n", timeToString( todo->dtDue(), true, mSpec ) );
    }
  }
  QString details = todo->richDescription();
  if ( !details.isEmpty() ) {
    mResult += i18n( "Details:\n%1\n", details );
  }
  return !mResult.isEmpty();
}

bool IncidenceFormatter::MailBodyVisitor::visit( Journal::Ptr journal )
{
  mResult = mailBodyIncidence( journal );
  mResult += i18n( "Date: %1\n", dateToString( journal->dtStart(), true, mSpec ) );
  if ( !journal->allDay() ) {
    mResult += i18n( "Time: %1\n", timeToString( journal->dtStart(), true, mSpec ) );
  }
  if ( !journal->description().isEmpty() ) {
    mResult += i18n( "Text of the journal:\n%1\n", journal->richDescription() );
  }
  return !mResult.isEmpty();
}
//@endcond

QString IncidenceFormatter::mailBodyStr( const IncidenceBase::Ptr &incidence,
                                         KDateTime::Spec spec )
{
  if ( !incidence ) {
    return QString();
  }

  MailBodyVisitor v;
  if ( v.act( incidence, spec ) ) {
    return v.result();
  }
  return QString();
}

//@cond PRIVATE
static QString recurEnd( const Incidence::Ptr &incidence )
{
  QString endstr;
  if ( incidence->allDay() ) {
    endstr = KGlobal::locale()->formatDate( incidence->recurrence()->endDate() );
  } else {
    endstr = KGlobal::locale()->formatDateTime( incidence->recurrence()->endDateTime() );
  }
  return endstr;
}
//@endcond

/************************************
 *  More static formatting functions
 ************************************/

QString IncidenceFormatter::recurrenceString( const Incidence::Ptr &incidence )
{
  if ( !incidence->recurs() ) {
    return i18n( "No recurrence" );
  }
  static QStringList dayList;
  if ( dayList.isEmpty() ) {
    dayList.append( i18n( "31st Last" ) );
    dayList.append( i18n( "30th Last" ) );
    dayList.append( i18n( "29th Last" ) );
    dayList.append( i18n( "28th Last" ) );
    dayList.append( i18n( "27th Last" ) );
    dayList.append( i18n( "26th Last" ) );
    dayList.append( i18n( "25th Last" ) );
    dayList.append( i18n( "24th Last" ) );
    dayList.append( i18n( "23rd Last" ) );
    dayList.append( i18n( "22nd Last" ) );
    dayList.append( i18n( "21st Last" ) );
    dayList.append( i18n( "20th Last" ) );
    dayList.append( i18n( "19th Last" ) );
    dayList.append( i18n( "18th Last" ) );
    dayList.append( i18n( "17th Last" ) );
    dayList.append( i18n( "16th Last" ) );
    dayList.append( i18n( "15th Last" ) );
    dayList.append( i18n( "14th Last" ) );
    dayList.append( i18n( "13th Last" ) );
    dayList.append( i18n( "12th Last" ) );
    dayList.append( i18n( "11th Last" ) );
    dayList.append( i18n( "10th Last" ) );
    dayList.append( i18n( "9th Last" ) );
    dayList.append( i18n( "8th Last" ) );
    dayList.append( i18n( "7th Last" ) );
    dayList.append( i18n( "6th Last" ) );
    dayList.append( i18n( "5th Last" ) );
    dayList.append( i18n( "4th Last" ) );
    dayList.append( i18n( "3rd Last" ) );
    dayList.append( i18n( "2nd Last" ) );
    dayList.append( i18nc( "last day of the month", "Last" ) );
    dayList.append( i18nc( "unknown day of the month", "unknown" ) ); //#31 - zero offset from UI
    dayList.append( i18n( "1st" ) );
    dayList.append( i18n( "2nd" ) );
    dayList.append( i18n( "3rd" ) );
    dayList.append( i18n( "4th" ) );
    dayList.append( i18n( "5th" ) );
    dayList.append( i18n( "6th" ) );
    dayList.append( i18n( "7th" ) );
    dayList.append( i18n( "8th" ) );
    dayList.append( i18n( "9th" ) );
    dayList.append( i18n( "10th" ) );
    dayList.append( i18n( "11th" ) );
    dayList.append( i18n( "12th" ) );
    dayList.append( i18n( "13th" ) );
    dayList.append( i18n( "14th" ) );
    dayList.append( i18n( "15th" ) );
    dayList.append( i18n( "16th" ) );
    dayList.append( i18n( "17th" ) );
    dayList.append( i18n( "18th" ) );
    dayList.append( i18n( "19th" ) );
    dayList.append( i18n( "20th" ) );
    dayList.append( i18n( "21st" ) );
    dayList.append( i18n( "22nd" ) );
    dayList.append( i18n( "23rd" ) );
    dayList.append( i18n( "24th" ) );
    dayList.append( i18n( "25th" ) );
    dayList.append( i18n( "26th" ) );
    dayList.append( i18n( "27th" ) );
    dayList.append( i18n( "28th" ) );
    dayList.append( i18n( "29th" ) );
    dayList.append( i18n( "30th" ) );
    dayList.append( i18n( "31st" ) );
  }

  const int weekStart = KGlobal::locale()->weekStartDay();
  QString dayNames;
  const KCalendarSystem *calSys = KGlobal::locale()->calendar();

  Recurrence *recur = incidence->recurrence();

  QString txt, recurStr;
  static QString noRecurrence = i18n( "No recurrence" );
  switch ( recur->recurrenceType() ) {
  case Recurrence::rNone:
    return noRecurrence;

  case Recurrence::rMinutely:
    if ( recur->duration() != -1 ) {
      recurStr = i18np( "Recurs every minute until %2",
                        "Recurs every %1 minutes until %2",
                        recur->frequency(), recurEnd( incidence ) );
      if ( recur->duration() >  0 ) {
        recurStr += i18nc( "number of occurrences",
                           " (<numid>%1</numid> occurrences)",
                           recur->duration() );
      }
    } else {
      recurStr = i18np( "Recurs every minute",
                        "Recurs every %1 minutes", recur->frequency() );
    }
    break;

  case Recurrence::rHourly:
    if ( recur->duration() != -1 ) {
      recurStr = i18np( "Recurs hourly until %2",
                        "Recurs every %1 hours until %2",
                        recur->frequency(), recurEnd( incidence ) );
      if ( recur->duration() >  0 ) {
        recurStr += i18nc( "number of occurrences",
                           " (<numid>%1</numid> occurrences)",
                           recur->duration() );
      }
    } else {
      recurStr = i18np( "Recurs hourly", "Recurs every %1 hours", recur->frequency() );
    }
    break;

  case Recurrence::rDaily:
    if ( recur->duration() != -1 ) {
      recurStr = i18np( "Recurs daily until %2",
                       "Recurs every %1 days until %2",
                       recur->frequency(), recurEnd( incidence ) );
      if ( recur->duration() >  0 ) {
        recurStr += i18nc( "number of occurrences",
                           " (<numid>%1</numid> occurrences)",
                           recur->duration() );
      }
    } else {
      recurStr = i18np( "Recurs daily", "Recurs every %1 days", recur->frequency() );
    }
    break;

  case Recurrence::rWeekly:
  {
    bool addSpace = false;
    for ( int i = 0; i < 7; ++i ) {
      if ( recur->days().testBit( ( i + weekStart + 6 ) % 7 ) ) {
        if ( addSpace ) {
          dayNames.append( i18nc( "separator for list of days", ", " ) );
        }
        dayNames.append( calSys->weekDayName( ( ( i + weekStart + 6 ) % 7 ) + 1,
                                              KCalendarSystem::ShortDayName ) );
        addSpace = true;
      }
    }
    if ( dayNames.isEmpty() ) {
      dayNames = i18nc( "Recurs weekly on no days", "no days" );
    }
    if ( recur->duration() != -1 ) {
      recurStr = i18ncp( "Recurs weekly on [list of days] until end-date",
                         "Recurs weekly on %2 until %3",
                         "Recurs every <numid>%1</numid> weeks on %2 until %3",
                         recur->frequency(), dayNames, recurEnd( incidence ) );
      if ( recur->duration() >  0 ) {
        recurStr += i18nc( "number of occurrences",
                           " (<numid>%1</numid> occurrences)",
                           recur->duration() );
      }
    } else {
      recurStr = i18ncp( "Recurs weekly on [list of days]",
                         "Recurs weekly on %2",
                         "Recurs every <numid>%1</numid> weeks on %2",
                         recur->frequency(), dayNames );
    }
    break;
  }
  case Recurrence::rMonthlyPos:
  {
    if ( !recur->monthPositions().isEmpty() ) {
      RecurrenceRule::WDayPos rule = recur->monthPositions()[0];
      if ( recur->duration() != -1 ) {
        recurStr = i18ncp( "Recurs every N months on the [2nd|3rd|...]"
                           " weekdayname until end-date",
                           "Recurs every month on the %2 %3 until %4",
                           "Recurs every <numid>%1</numid> months on the %2 %3 until %4",
                           recur->frequency(),
                           dayList[rule.pos() + 31],
                           calSys->weekDayName( rule.day(), KCalendarSystem::LongDayName ),
                           recurEnd( incidence ) );
        if ( recur->duration() >  0 ) {
          recurStr += i18nc( "number of occurrences",
                             " (<numid>%1</numid> occurrences)",
                             recur->duration() );
        }
      } else {
        recurStr = i18ncp( "Recurs every N months on the [2nd|3rd|...] weekdayname",
                           "Recurs every month on the %2 %3",
                           "Recurs every %1 months on the %2 %3",
                           recur->frequency(),
                           dayList[rule.pos() + 31],
                           calSys->weekDayName( rule.day(), KCalendarSystem::LongDayName ) );
      }
    }
    break;
  }
  case Recurrence::rMonthlyDay:
  {
    if ( !recur->monthDays().isEmpty() ) {
      int days = recur->monthDays()[0];
      if ( recur->duration() != -1 ) {
        recurStr = i18ncp( "Recurs monthly on the [1st|2nd|...] day until end-date",
                           "Recurs monthly on the %2 day until %3",
                           "Recurs every %1 months on the %2 day until %3",
                           recur->frequency(),
                           dayList[days + 31],
                           recurEnd( incidence ) );
        if ( recur->duration() >  0 ) {
          recurStr += i18nc( "number of occurrences",
                             " (<numid>%1</numid> occurrences)",
                             recur->duration() );
        }
      } else {
        recurStr = i18ncp( "Recurs monthly on the [1st|2nd|...] day",
                           "Recurs monthly on the %2 day",
                           "Recurs every <numid>%1</numid> month on the %2 day",
                           recur->frequency(),
                           dayList[days + 31] );
      }
    }
    break;
  }
  case Recurrence::rYearlyMonth:
  {
    if ( recur->duration() != -1 ) {
      if ( !recur->yearDates().isEmpty() && !recur->yearMonths().isEmpty() ) {
        recurStr = i18ncp( "Recurs Every N years on month-name [1st|2nd|...]"
                           " until end-date",
                           "Recurs yearly on %2 %3 until %4",
                           "Recurs every %1 years on %2 %3 until %4",
                           recur->frequency(),
                           calSys->monthName( recur->yearMonths()[0], recur->startDate().year() ),
                           dayList[ recur->yearDates()[0] + 31 ],
                           recurEnd( incidence ) );
        if ( recur->duration() >  0 ) {
          recurStr += i18nc( "number of occurrences",
                             " (<numid>%1</numid> occurrences)",
                             recur->duration() );
        }
      }
    } else {
      if ( !recur->yearDates().isEmpty() && !recur->yearMonths().isEmpty() ) {
        recurStr = i18ncp( "Recurs Every N years on month-name [1st|2nd|...]",
                           "Recurs yearly on %2 %3",
                           "Recurs every %1 years on %2 %3",
                           recur->frequency(),
                           calSys->monthName( recur->yearMonths()[0],
                                              recur->startDate().year() ),
                           dayList[ recur->yearDates()[0] + 31 ] );
      } else {
        if (!recur->yearMonths().isEmpty() ) {
          recurStr = i18nc( "Recurs Every year on month-name [1st|2nd|...]",
                            "Recurs yearly on %1 %2",
                            calSys->monthName( recur->yearMonths()[0],
                                               recur->startDate().year() ),
                            dayList[ recur->startDate().day() + 31 ] );
        } else {
          recurStr = i18nc( "Recurs Every year on month-name [1st|2nd|...]",
                            "Recurs yearly on %1 %2",
                            calSys->monthName( recur->startDate().month(),
                                               recur->startDate().year() ),
                            dayList[ recur->startDate().day() + 31 ] );
        }
      }
    }
    break;
  }
  case Recurrence::rYearlyDay:
    if ( !recur->yearDays().isEmpty() ) {
      if ( recur->duration() != -1 ) {
        recurStr = i18ncp( "Recurs every N years on day N until end-date",
                           "Recurs every year on day <numid>%2</numid> until %3",
                           "Recurs every <numid>%1</numid> years"
                           " on day <numid>%2</numid> until %3",
                           recur->frequency(),
                           recur->yearDays()[0],
                           recurEnd( incidence ) );
        if ( recur->duration() >  0 ) {
          recurStr += i18nc( "number of occurrences",
                             " (<numid>%1</numid> occurrences)",
                             recur->duration() );
        }
      } else {
        recurStr = i18ncp( "Recurs every N YEAR[S] on day N",
                           "Recurs every year on day <numid>%2</numid>",
                           "Recurs every <numid>%1</numid> years"
                           " on day <numid>%2</numid>",
                           recur->frequency(), recur->yearDays()[0] );
      }
    }
    break;
  case Recurrence::rYearlyPos:
  {
    if ( !recur->yearMonths().isEmpty() && !recur->yearPositions().isEmpty() ) {
      RecurrenceRule::WDayPos rule = recur->yearPositions()[0];
      if ( recur->duration() != -1 ) {
        recurStr = i18ncp( "Every N years on the [2nd|3rd|...] weekdayname "
                           "of monthname until end-date",
                           "Every year on the %2 %3 of %4 until %5",
                           "Every <numid>%1</numid> years on the %2 %3 of %4"
                           " until %5",
                           recur->frequency(),
                           dayList[rule.pos() + 31],
                           calSys->weekDayName( rule.day(), KCalendarSystem::LongDayName ),
                           calSys->monthName( recur->yearMonths()[0], recur->startDate().year() ),
                           recurEnd( incidence ) );
        if ( recur->duration() >  0 ) {
          recurStr += i18nc( "number of occurrences",
                             " (<numid>%1</numid> occurrences)",
                             recur->duration() );
        }
      } else {
        recurStr = i18ncp( "Every N years on the [2nd|3rd|...] weekdayname "
                           "of monthname",
                           "Every year on the %2 %3 of %4",
                           "Every <numid>%1</numid> years on the %2 %3 of %4",
                           recur->frequency(),
                           dayList[rule.pos() + 31],
                           calSys->weekDayName( rule.day(), KCalendarSystem::LongDayName ),
                           calSys->monthName( recur->yearMonths()[0], recur->startDate().year() ) );
      }
    }
  }
  break;
  }

  if ( recurStr.isEmpty() ) {
    recurStr = i18n( "Incidence recurs" );
  }

  // Now, append the EXDATEs
  DateTimeList l = recur->exDateTimes();
  DateTimeList::ConstIterator il;
  QStringList exStr;
  for ( il = l.constBegin(); il != l.constEnd(); ++il ) {
    switch ( recur->recurrenceType() ) {
    case Recurrence::rMinutely:
      exStr << i18n( "minute %1", (*il).time().minute() );
      break;
    case Recurrence::rHourly:
      exStr << KGlobal::locale()->formatTime( (*il).time() );
      break;
    case Recurrence::rDaily:
      exStr << KGlobal::locale()->formatDate( (*il).date(), KLocale::ShortDate );
      break;
    case Recurrence::rWeekly:
      exStr << calSys->weekDayName( (*il).date(), KCalendarSystem::ShortDayName );
      break;
    case Recurrence::rMonthlyPos:
      exStr << KGlobal::locale()->formatDate( (*il).date(), KLocale::ShortDate );
      break;
    case Recurrence::rMonthlyDay:
      exStr << KGlobal::locale()->formatDate( (*il).date(), KLocale::ShortDate );
      break;
    case Recurrence::rYearlyMonth:
      exStr << calSys->monthName( (*il).date(), KCalendarSystem::LongName );
      break;
    case Recurrence::rYearlyDay:
      exStr << KGlobal::locale()->formatDate( (*il).date(), KLocale::ShortDate );
      break;
    case Recurrence::rYearlyPos:
      exStr << KGlobal::locale()->formatDate( (*il).date(), KLocale::ShortDate );
      break;
    }
  }

  DateList d = recur->exDates();
  DateList::ConstIterator dl;
  for ( dl = d.constBegin(); dl != d.constEnd(); ++dl ) {
    switch ( recur->recurrenceType() ) {
    case Recurrence::rDaily:
      exStr << KGlobal::locale()->formatDate( (*dl), KLocale::ShortDate );
      break;
    case Recurrence::rWeekly:
      exStr << calSys->weekDayName( (*dl), KCalendarSystem::ShortDayName );
      break;
    case Recurrence::rMonthlyPos:
      exStr << KGlobal::locale()->formatDate( (*dl), KLocale::ShortDate );
      break;
    case Recurrence::rMonthlyDay:
      exStr << KGlobal::locale()->formatDate( (*dl), KLocale::ShortDate );
      break;
    case Recurrence::rYearlyMonth:
      exStr << calSys->monthName( (*dl), KCalendarSystem::LongName );
      break;
    case Recurrence::rYearlyDay:
      exStr << KGlobal::locale()->formatDate( (*dl), KLocale::ShortDate );
      break;
    case Recurrence::rYearlyPos:
      exStr << KGlobal::locale()->formatDate( (*dl), KLocale::ShortDate );
      break;
    }
  }

  if ( !exStr.isEmpty() ) {
    recurStr = i18n( "%1 (excluding %2)", recurStr, exStr.join( "," ) );
  }

  return recurStr;
}

QString IncidenceFormatter::timeToString( const KDateTime &date,
                                          bool shortfmt,
                                          const KDateTime::Spec &spec )
{
  if ( spec.isValid() ) {

    QString timeZone;
    if ( spec.timeZone() != KSystemTimeZones::local() ) {
      timeZone = ' ' + spec.timeZone().name();
    }

    return KGlobal::locale()->formatTime( date.toTimeSpec( spec ).time(), !shortfmt ) + timeZone;
  } else {
    return KGlobal::locale()->formatTime( date.time(), !shortfmt );
  }
}

QString IncidenceFormatter::dateToString( const KDateTime &date,
                                          bool shortfmt,
                                          const KDateTime::Spec &spec )
{
  if ( spec.isValid() ) {

    QString timeZone;
    if ( spec.timeZone() != KSystemTimeZones::local() ) {
      timeZone = ' ' + spec.timeZone().name();
    }

    return
      KGlobal::locale()->formatDate( date.toTimeSpec( spec ).date(),
                                     ( shortfmt ? KLocale::ShortDate : KLocale::LongDate ) ) +
      timeZone;
  } else {
    return
      KGlobal::locale()->formatDate( date.date(),
                                     ( shortfmt ? KLocale::ShortDate : KLocale::LongDate ) );
  }
}

QString IncidenceFormatter::dateTimeToString( const KDateTime &date,
                                              bool allDay,
                                              bool shortfmt,
                                              const KDateTime::Spec &spec )
{
  if ( allDay ) {
    return dateToString( date, shortfmt, spec );
  }

  if ( spec.isValid() ) {
    QString timeZone;
    if ( spec.timeZone() != KSystemTimeZones::local() ) {
      timeZone = ' ' + spec.timeZone().name();
    }

    return KGlobal::locale()->formatDateTime(
      date.toTimeSpec( spec ).dateTime(),
      ( shortfmt ? KLocale::ShortDate : KLocale::LongDate ) ) + timeZone;
  } else {
    return  KGlobal::locale()->formatDateTime(
      date.dateTime(),
      ( shortfmt ? KLocale::ShortDate : KLocale::LongDate ) );
  }
}

QString IncidenceFormatter::resourceString( const Calendar::Ptr &calendar,
                                            const Incidence::Ptr &incidence )
{
  Q_UNUSED( calendar );
  Q_UNUSED( incidence );
  return QString();
}

static QString secs2Duration( int secs )
{
  QString tmp;
  int days = secs / 86400;
  if ( days > 0 ) {
    tmp += i18np( "1 day", "%1 days", days );
    tmp += ' ';
    secs -= ( days * 86400 );
  }
  int hours = secs / 3600;
  if ( hours > 0 ) {
    tmp += i18np( "1 hour", "%1 hours", hours );
    tmp += ' ';
    secs -= ( hours * 3600 );
  }
  int mins = secs / 60;
  if ( mins > 0 ) {
    tmp += i18np( "1 minute", "%1 minutes", mins );
  }
  return tmp;
}

QString IncidenceFormatter::durationString( const Incidence::Ptr &incidence )
{
  QString tmp;
  if ( incidence->type() == Incidence::TypeEvent ) {
    Event::Ptr event = incidence.staticCast<Event>();
    if ( event->hasEndDate() ) {
      if ( !event->allDay() ) {
        tmp = secs2Duration( event->dtStart().secsTo( event->dtEnd() ) );
      } else {
        tmp = i18np( "1 day", "%1 days",
                     event->dtStart().date().daysTo( event->dtEnd().date() ) + 1 );
      }
    } else {
      tmp = i18n( "forever" );
    }
  } else if ( incidence->type() == Incidence::TypeTodo ) {
    Todo::Ptr todo = incidence.staticCast<Todo>();
    if ( todo->hasDueDate() ) {
      if ( todo->hasStartDate() ) {
        if ( !todo->allDay() ) {
          tmp = secs2Duration( todo->dtStart().secsTo( todo->dtDue() ) );
        } else {
          tmp = i18np( "1 day", "%1 days",
                       todo->dtStart().date().daysTo( todo->dtDue().date() ) + 1 );
        }
      }
    }
  }
  return tmp;
}

QStringList IncidenceFormatter::reminderStringList( const Incidence::Ptr &incidence,
                                                    bool shortfmt )
{
  //TODO: implement shortfmt=false
  Q_UNUSED( shortfmt );

  QStringList reminderStringList;

  if ( incidence ) {
    Alarm::List alarms = incidence->alarms();
    Alarm::List::ConstIterator it;
    for ( it = alarms.constBegin(); it != alarms.constEnd(); ++it ) {
      Alarm::Ptr alarm = *it;
      int offset = 0;
      QString remStr, atStr, offsetStr;
      if ( alarm->hasTime() ) {
        offset = 0;
        if ( alarm->time().isValid() ) {
          atStr = KGlobal::locale()->formatDateTime( alarm->time() );
        }
      } else if ( alarm->hasStartOffset() ) {
        offset = alarm->startOffset().asSeconds();
        if ( offset < 0 ) {
          offset = -offset;
          offsetStr = i18nc( "N days/hours/minutes before the start datetime",
                             "%1 before the start", secs2Duration( offset ) );
        } else if ( offset > 0 ) {
          offsetStr = i18nc( "N days/hours/minutes after the start datetime",
                             "%1 after the start", secs2Duration( offset ) );
        } else { //offset is 0
          if ( incidence->dtStart().isValid() ) {
            atStr = KGlobal::locale()->formatDateTime( incidence->dtStart() );
          }
        }
      } else if ( alarm->hasEndOffset() ) {
        offset = alarm->endOffset().asSeconds();
        if ( offset < 0 ) {
          offset = -offset;
          if ( incidence->type() == Incidence::TypeTodo ) {
            offsetStr = i18nc( "N days/hours/minutes before the due datetime",
                               "%1 before the to-do is due", secs2Duration( offset ) );
          } else {
            offsetStr = i18nc( "N days/hours/minutes before the end datetime",
                               "%1 before the end", secs2Duration( offset ) );
          }
        } else if ( offset > 0 ) {
          if ( incidence->type() == Incidence::TypeTodo ) {
            offsetStr = i18nc( "N days/hours/minutes after the due datetime",
                               "%1 after the to-do is due", secs2Duration( offset ) );
          } else {
            offsetStr = i18nc( "N days/hours/minutes after the end datetime",
                               "%1 after the end", secs2Duration( offset ) );
          }
        } else { //offset is 0
          if ( incidence->type() == Incidence::TypeTodo ) {
            Todo::Ptr t = incidence.staticCast<Todo>();
            if ( t->dtDue().isValid() ) {
              atStr = KGlobal::locale()->formatDateTime( t->dtDue() );
            }
          } else {
            Event::Ptr e = incidence.staticCast<Event>();
            if ( e->dtEnd().isValid() ) {
              atStr = KGlobal::locale()->formatDateTime( e->dtEnd() );
            }
          }
        }
      }
      if ( offset == 0 ) {
        if ( !atStr.isEmpty() ) {
          remStr = i18nc( "reminder occurs at datetime", "at %1", atStr );
        }
      } else {
        remStr = offsetStr;
      }

      if ( alarm->repeatCount() > 0 ) {
        QString countStr = i18np( "repeats once", "repeats %1 times", alarm->repeatCount() );
        QString intervalStr = i18nc( "interval is N days/hours/minutes",
                                     "interval is %1",
                                     secs2Duration( alarm->snoozeTime().asSeconds() ) );
        QString repeatStr = i18nc( "(repeat string, interval string)",
                                   "(%1, %2)", countStr, intervalStr );
        remStr = remStr + ' ' + repeatStr;

      }
      reminderStringList << remStr;
    }
  }

  return reminderStringList;
}
