dateformatter.cpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2001 the KMime authors.
// SPDX-License-Identifier: LGPL-2.0-or-later
 
/**
  @file
  This file is part of the API for handling @ref MIME data and
  defines the DateFormatter class.
 
  @brief
  Defines the DateFormatter class.
 
  @authors the KMime authors (see AUTHORS file)
*/
 
#include "dateformatter.h"
 
#include <KLocalizedString>
 
using namespace MessageCore;
 
namespace MessageCore
{
 
class DateFormatterPrivate
{
public:
    DateFormatterPrivate()
    {
    }
 
    /**
      Returns a QString containing the specified time @p t formatted
      using the #Fancy #FormatType.
 
      @param t is the time to use for formatting.
    */
    QString fancy(const QDateTime &t);
 
    /**
      Returns a QString containing the specified time @p t formatted
      using the #Localized #FormatType.
 
      @param t is the time to use for formatting.
      @param shortFormat if true, create the short version of the date string.
      @param lang is a QString containing the language to use.
    */
    static QString localized(const QDateTime &t, bool shortFormat = true, const QString &lang = QString());
 
    /**
      Returns a QString containing the specified time @p t formatted
      with the ctime() function.
 
      @param t is the time to use for formatting.
    */
    static QString cTime(const QDateTime &t);
 
    /**
      Returns a QString containing the specified time @p t formatted
      with a previously specified custom format.
 
      @param t time used for formatting
    */
    QString custom(const QDateTime &t) const;
 
    /**
      Returns a QString that identifies the timezone (eg."-0500")
      of the specified time @p t.
 
      @param t time to compute timezone from.
    */
    static QByteArray zone(const QDateTime &t);
 
    DateFormatter::FormatType mFormat;
    QDateTime mTodayOneMillisecondBeforeMidnight;
    QString mCustomFormat;
};
 
}
 
DateFormatter::DateFormatter(FormatType ftype)
    : d(new DateFormatterPrivate)
{
    d->mFormat = ftype;
}
 
DateFormatter::~DateFormatter() = default;
 
DateFormatter::FormatType DateFormatter::format() const
{
    return d->mFormat;
}
 
void DateFormatter::setFormat(FormatType ftype)
{
    d->mFormat = ftype;
}
 
QString DateFormatter::dateString(const QDateTime &dt, const QString &lang, bool shortFormat) const
{
    switch (d->mFormat) {
    case Fancy:
        return d->fancy(dt);
    case Localized:
        return d->localized(dt, shortFormat, lang);
    case CTime:
        return d->cTime(dt);
    case Custom:
        return d->custom(dt);
    }
    return {};
}
 
QString DateFormatterPrivate::custom(const QDateTime &t) const
{
    if (mCustomFormat.isEmpty()) {
        return {};
    }
 
    int z = mCustomFormat.indexOf(QLatin1Char('Z'));
    QDateTime dt;
    QString ret = mCustomFormat;
 
    if (z != -1) {
        ret.replace(z, 1, QLatin1StringView(zone(t)));
    }
 
    ret = t.toString(ret);
 
    return ret;
}
 
void DateFormatter::setCustomFormat(const QString &format)
{
    d->mCustomFormat = format;
    d->mFormat = Custom;
}
 
QString DateFormatter::customFormat() const
{
    return d->mCustomFormat;
}
 
void DateFormatter::invalidateReferenceDate() const
{
    d->mTodayOneMillisecondBeforeMidnight = QDateTime();
}
 
QByteArray DateFormatterPrivate::zone(const QDateTime &t)
{
    const auto secs = t.offsetFromUtc();
    const auto hours = std::abs(secs / 3600);
    const auto mins = std::abs((secs - hours * 3600) / 60);
 
    QByteArray ret(6, 0);
    qsnprintf(ret.data(), ret.size(), "%c%.2d%.2d", (secs < 0) ? '-' : '+', hours, mins);
    ret.chop(1);
    return ret;
}
 
QString DateFormatterPrivate::fancy(const QDateTime &t)
{
    if (!t.isValid()) {
        return i18nc("invalid time specified", "unknown");
    }
 
    if (!mTodayOneMillisecondBeforeMidnight.isValid()) {
        // determine time of today 23:59:59.999
        mTodayOneMillisecondBeforeMidnight = QDateTime(QDate::currentDate(), QTime(23, 59, 59, 999));
    }
 
    if (mTodayOneMillisecondBeforeMidnight >= t) {
        const auto diffDays = t.daysTo(mTodayOneMillisecondBeforeMidnight);
        if (diffDays < 7) {
            if (diffDays == 0) {
                return i18n("Today %1", QLocale().toString(t.time(), QLocale::ShortFormat));
            }
            if (diffDays == 1) {
                return i18n("Yesterday %1", QLocale().toString(t.time(), QLocale::ShortFormat));
            }
            for (int i = 2; i < 7; i++) {
                if (diffDays == i) {
                    return i18nc("1. weekday, 2. time",
                                 "%1 %2",
                                 QLocale().dayName(t.date().dayOfWeek(), QLocale::LongFormat),
                                 QLocale().toString(t.time(), QLocale::ShortFormat));
                }
            }
        }
    }
 
    return QLocale().toString(t, QLocale::ShortFormat);
}
 
QString DateFormatterPrivate::localized(const QDateTime &t, bool shortFormat, const QString &lang)
{
    QString ret;
 
    if (!lang.isEmpty()) {
        ret = QLocale(lang).toString(t, (shortFormat ? QLocale::ShortFormat : QLocale::LongFormat));
    } else {
        ret = QLocale().toString(t, (shortFormat ? QLocale::ShortFormat : QLocale::LongFormat));
    }
 
    return ret;
}
 
QString DateFormatterPrivate::cTime(const QDateTime &t)
{
    return t.toString(QStringLiteral("ddd MMM dd hh:mm:ss yyyy"));
}
 
QString DateFormatter::formatDate(FormatType ftype, const QDateTime &t, const QString &data, bool shortFormat)
{
    DateFormatter f(ftype);
    if (ftype == Custom) {
        f.setCustomFormat(data);
    }
    return f.dateString(t, data, shortFormat);
}
 
QString DateFormatter::formatCurrentDate(FormatType ftype, const QString &data, bool shortFormat)
{
    DateFormatter f(ftype);
    if (ftype == Custom) {
        f.setCustomFormat(data);
    }
    return f.dateString(QDateTime::currentDateTime(), data, shortFormat);
}