• Skip to content
• Skip to link menu

KDE 4.2 API Reference

• KDE API Reference
• kdepim

• Sitemap
• Contact Us

 

kalarm

alarmtext.cpp

Go to the documentation of this file.

/*
 *  alarmtext.cpp  -  text/email alarm text conversion
 *  Program:  kalarm
 *  Copyright © 2004,2005,2007,2008 by David Jarvie <djarvie@kde.org>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#include "kalarm.h"   //krazy:exclude=includes (kalarm.h must be first)
#include "alarmtext.h"

#include "alarmevent.h"

#include <QStringList>
#include <klocale.h>


QString AlarmText::mFromPrefix;
QString AlarmText::mToPrefix;
QString AlarmText::mCcPrefix;
QString AlarmText::mDatePrefix;
QString AlarmText::mSubjectPrefix;
QString AlarmText::mFromPrefixEn    = QLatin1String("From:");
QString AlarmText::mToPrefixEn      = QLatin1String("To:");
QString AlarmText::mCcPrefixEn      = QLatin1String("Cc:");
QString AlarmText::mDatePrefixEn    = QLatin1String("Date:");
QString AlarmText::mSubjectPrefixEn = QLatin1String("Subject:");


void AlarmText::setText(const QString& text)
{
    mBody     = text;
    mIsScript = text.startsWith(QLatin1String("#!"));
    mIsEmail  = false;
    mTo.clear();
    mFrom.clear();
    mCc.clear();
    mTime.clear();
    mSubject.clear();
    mKMailSerialNum = 0;
}

void AlarmText::setEmail(const QString& to, const QString& from, const QString& cc, const QString& time,
                         const QString& subject, const QString& body, unsigned long kmailSerialNumber)
{
    mIsScript       = false;
    mIsEmail        = true;
    mTo             = to;
    mFrom           = from;
    mCc             = cc;
    mTime           = time;
    mSubject        = subject;
    mBody           = body;
    mKMailSerialNum = kmailSerialNumber;
}

/******************************************************************************
*  Return the text for a text message alarm, in display format.
*/
QString AlarmText::displayText() const
{
    if (mIsEmail)
    {
        // Format the email into a text alarm
        setUpTranslations();
        QString text;
        text = mFromPrefix + '\t' + mFrom + '\n';
        text += mToPrefix + '\t' + mTo + '\n';
        if (!mCc.isEmpty())
            text += mCcPrefix + '\t' + mCc + '\n';
        if (!mTime.isEmpty())
            text += mDatePrefix + '\t' + mTime + '\n';
        text += mSubjectPrefix + '\t' + mSubject;
        if (!mBody.isEmpty())
        {
            text += "\n\n";
            text += mBody;
        }
        return text;
    }
    return mBody;
}

/******************************************************************************
*  Return whether there is any text.
*/
bool AlarmText::isEmpty() const
{
    if (!mBody.isEmpty())
        return false;
    if (!mIsEmail)
        return true;
    return mFrom.isEmpty() && mTo.isEmpty() && mCc.isEmpty() && mTime.isEmpty() && mSubject.isEmpty();
}

/******************************************************************************
*  Check whether a text is an email.
*/
bool AlarmText::checkIfEmail(const QString& text)
{
    QStringList lines = text.split('\n', QString::SkipEmptyParts);
    return emailHeaderCount(lines);
}

/******************************************************************************
*  Check whether a text is an email.
*  Reply = number of email header lines, or 0 if not an email.
*/
int AlarmText::emailHeaderCount(const QStringList& lines)
{
    setUpTranslations();
    int maxn = lines.count();
    if (maxn >= 4
    &&  lines[0].startsWith(mFromPrefix)
    &&  lines[1].startsWith(mToPrefix))
    {
        int n = 2;
        if (lines[2].startsWith(mCcPrefix))
            ++n;
        if (maxn > n + 1
        &&  lines[n].startsWith(mDatePrefix)
        &&  lines[n+1].startsWith(mSubjectPrefix))
            return n+2;
    }
    return 0;
}

/******************************************************************************
*  Check whether a text is an email, and if so return its headers or optionally
*  only its subject line.
*  Reply = headers/subject line, or QString() if not the text of an email.
*/
QString AlarmText::emailHeaders(const QString& text, bool subjectOnly)
{
    QStringList lines = text.split('\n', QString::SkipEmptyParts);
    int n = emailHeaderCount(lines);
    if (!n)
        return QString();
    if (subjectOnly)
        return lines[n-1].mid(mSubjectPrefix.length()).trimmed();
    QString h = lines[0];
    for (int i = 1;  i < n;  ++i)
    {
        h += '\n';
        h += lines[i];
    }
    return h;
}

/******************************************************************************
*  Translate an alarm calendar text to a display text.
*  Translation is needed for email texts, since the alarm calendar stores
*  untranslated email prefixes.
*  'email' is set to indicate whether it is an email text.
*/
QString AlarmText::fromCalendarText(const QString& text, bool& email)
{
    QStringList lines = text.split('\n', QString::SkipEmptyParts);
    int maxn = lines.count();
    if (maxn >= 4
    &&  lines[0].startsWith(mFromPrefixEn)
    &&  lines[1].startsWith(mToPrefixEn))
    {
        int n = 2;
        if (lines[2].startsWith(mCcPrefixEn))
            ++n;
        if (maxn > n + 1
        &&  lines[n].startsWith(mDatePrefixEn)
        &&  lines[n+1].startsWith(mSubjectPrefixEn))
        {
            setUpTranslations();
            QString dispText;
            dispText = mFromPrefix + lines[0].mid(mFromPrefixEn.length()) + '\n';
            dispText += mToPrefix + lines[1].mid(mToPrefixEn.length()) + '\n';
            if (n == 3)
                dispText += mCcPrefix + lines[2].mid(mCcPrefixEn.length()) + '\n';
            dispText += mDatePrefix + lines[n].mid(mDatePrefixEn.length()) + '\n';
            dispText += mSubjectPrefix + lines[n+1].mid(mSubjectPrefixEn.length());
            int i = text.indexOf(mSubjectPrefixEn);
            i = text.indexOf('\n', i);
            if (i > 0)
                dispText += text.mid(i);
            email = true;
            return dispText;
        }
    }
    email = false;
    return text;
}

/******************************************************************************
*  Return the text for a text message alarm, in alarm calendar format.
*  (The prefix strings are untranslated in the calendar.)
*/
QString AlarmText::toCalendarText(const QString& text)
{
    setUpTranslations();
    QStringList lines = text.split('\n', QString::SkipEmptyParts);
    int maxn = lines.count();
    if (maxn >= 4
    &&  lines[0].startsWith(mFromPrefix)
    &&  lines[1].startsWith(mToPrefix))
    {
        int n = 2;
        if (lines[2].startsWith(mCcPrefix))
            ++n;
        if (maxn > n + 1
        &&  lines[n].startsWith(mDatePrefix)
        &&  lines[n+1].startsWith(mSubjectPrefix))
        {
            // Format the email into a text alarm
            QString calText;
            calText = mFromPrefixEn + lines[0].mid(mFromPrefix.length()) + '\n';
            calText += mToPrefixEn + lines[1].mid(mToPrefix.length()) + '\n';
            if (n == 3)
                calText += mCcPrefixEn + lines[2].mid(mCcPrefix.length()) + '\n';
            calText += mDatePrefixEn + lines[n].mid(mDatePrefix.length()) + '\n';
            calText += mSubjectPrefixEn + lines[n+1].mid(mSubjectPrefix.length());
            int i = text.indexOf(mSubjectPrefix);
            i = text.indexOf('\n', i);
            if (i > 0)
                calText += text.mid(i);
            return calText;
        }
    }
    return text;
}

/******************************************************************************
*  Set up messages used by executeDropEvent() and emailHeaders().
*/
void AlarmText::setUpTranslations()
{
    if (mFromPrefix.isNull())
    {
        mFromPrefix    = i18nc("@info/plain 'From' email address", "From:");
        mToPrefix      = i18nc("@info/plain Email addressee", "To:");
        mCcPrefix      = i18nc("@info/plain Copy-to in email headers", "Cc:");
        mDatePrefix    = i18nc("@info/plain", "Date:");
        mSubjectPrefix = i18nc("@info/plain Email subject", "Subject:");
    }
}

/******************************************************************************
*  Return the alarm summary text for either single line or tooltip display.
*  The maximum number of line returned is determined by 'maxLines'.
*  If 'truncated' is non-null, it will be set true if the text returned has been
*  truncated, other than to strip a trailing newline.
*/
QString AlarmText::summary(const KAEvent* event, int maxLines, bool* truncated)
{
    QString text = (event->action() == KAEvent::EMAIL) ? event->emailSubject() : event->cleanText();
    if (event->action() == KAEvent::MESSAGE)
    {
        // If the message is the text of an email, return its headers or just subject line
        QString subject = emailHeaders(text, (maxLines <= 1));
        if (!subject.isNull())
        {
            if (truncated)
                *truncated = true;
            return subject;
        }
    }
    if (truncated)
        *truncated = false;
    if (text.count('\n') < maxLines)
        return text;
    int newline = -1;
    for (int i = 0;  i < maxLines;  ++i)
    {
        newline = text.indexOf('\n', newline + 1);
        if (newline < 0)
            return text;       // not truncated after all !?!
    }
    if (newline == static_cast<int>(text.length()) - 1)
        return text.left(newline);    // text ends in newline
    if (truncated)
        *truncated = true;
    return text.left(newline + (maxLines <= 1 ? 0 : 1)) + QLatin1String("...");
}

kalarm

Skip menu "kalarm"

• Main Page
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members

kdepim

Skip menu "kdepim"

• akonadi
•   clients
•   kabc
•   kcal
•   kcm
• akregator
• console
•   kabcclient
•   konsolekalendar
• kaddressbook
• kalarm
•   lib
• kdgantt
• kdgantt1
• kjots
• kleopatra
• kmail
• kmobiletools
• knode
• knotes
• kontact
• kontactinterfaces
• korganizer
•   korgac
• kpilot
• ktimetracker
• libkdepim
• libkholidays
• libkleo
• libkpgp
• maildir

Generated for kdepim by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal