File indexing completed on 2024-06-16 05:01:51

 /* Copyright (C) 2006 - 2014 Jan Kundrát <jkt@flaska.net>
 
    This file is part of the Trojita Qt IMAP e-mail client,
    http://trojita.flaska.net/
 
    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) version 3 or any later version
    accepted by the membership of KDE e.V. (or its successor approved
    by the membership of KDE e.V.), which shall act as a proxy
    defined in Section 14 of version 3 of the license.
 
    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, see <http://www.gnu.org/licenses/>.
 */
 #include "UiUtils/Formatting.h"
 #include <cmath>
 #include <QSslError>
 #include <QSslKey>
 #include <QStringList>
 #include <QTextDocument>
 #include <QFontInfo>
 #include <QLocale>
 #include "UiUtils/PlainTextFormatter.h"
 
 namespace UiUtils {
 
 Formatting::Formatting(QObject *parent): QObject(parent)
 {
 }
 
 QString Formatting::prettySize(quint64 bytes)
 {
     static const QStringList suffixes = QStringList() << tr("B")
                                                       << tr("kB")
                                                       << tr("MB")
                                                       << tr("GB")
                                                       << tr("TB");
     const int max_order = suffixes.size() - 1;
     double number = bytes;
     int order = 0;
     int frac_digits = 0;
     if (bytes >= 1000) {
         int magnitude = std::log10(number);
         number /= std::pow(10.0, magnitude); // x.yz... * 10^magnitude
         number = qRound(number * 100.0) / 100.0; // round to 3 significant digits
         if (number >= 10.0) { // rounding has caused one increase in magnitude
             magnitude += 1;
             number /= 10.0;
         }
         order = magnitude / 3;
         int rem = magnitude % 3;
         number *= std::pow(10.0, rem); // xy.z * 1000^order
         if (order <= max_order) {
             frac_digits = 2 - rem;
         } else { // shame on you for such large mails
             number *= std::pow(1000.0, order - max_order);
             order = max_order;
         }
     }
     return tr("%1 %2").arg(QString::number(number, 'f', frac_digits), suffixes.at(order));
 }
 
 /** @short Format a QDateTime for compact display in one column of the view */
 QString Formatting::prettyDate(const QDateTime &dateTime)
 {
     // The time is not always synced properly, so better accept even slightly too new messages as "from today"
     QDateTime now = QDateTime::currentDateTime().addSecs(15*60);
     if (dateTime >= now) {
         // Messages from future shall always be shown using full format to prevent nasty surprises.
         return QLocale().toString(dateTime, QLocale::ShortFormat);
     } else if (dateTime.date() == now.date() || dateTime > now.addSecs(-6 * 3600)) {
         // It's a "today's message", i.e. something which is either literally from today or at least something not older than
         // six hours (an arbitraty magic number).
         // Originally, the cut-off time interval was set to 24 hours, but it led to weird things in the GUI like showing mails
         // from yesterday's 18:33 just as "18:33" even though the local time was "18:20" already. In a perfect world, we would
         // also periodically emit dataChanged() in order to force a wrap once the view has been open for too long, but that will
         // have to wait a bit.
         // The time is displayed without seconds to conserve space as well.
         return dateTime.time().toString(tr("hh:mm", "Please do not translate the format specifiers. "
             "You can change their order or the separator to follow the local conventions. "
             "For valid specifiers see http://doc.qt.io/qt-5/qdatetime.html#toString"));
     } else if (dateTime > now.addDays(-7)) {
         // Messages from the last seven days can be formatted just with the weekday name
         return dateTime.toString(tr("ddd hh:mm", "Please do not translate the format specifiers. "
             "You can change their order or the separator to follow the local conventions. "
             "For valid specifiers see http://doc.qt.io/qt-5/qdatetime.html#toString"));
     } else if (dateTime.date().year() == now.date().year() || dateTime > now.addMonths(-6)) {
         // Originally, this used to handle messages fresher than an year old. However, this might get a wee bit confusing
         // when it's September and we're showing a message from November last year.
         // I think that it's OK-ish to assume that unchanged years are OK, but let's be more careful when crossing the year
         // boundary. This is just a number that I pulled out of my sleeve, but a six-month cutoff might do the trick here.
         return dateTime.toString(tr("d MMM hh:mm", "Please do not translate the format specifiers. "
             "You can change their order or the separator to follow the local conventions. "
             "For valid specifiers see http://doc.qt.io/qt-5/qdatetime.html#toString"));
     } else {
         // Old messagees shall have a full date
         return QLocale().toString(dateTime, QLocale::ShortFormat);
     }
 }
 
 QString Formatting::htmlizedTextPart(const QModelIndex &partIndex, const QFont &font,
                                      const QColor &backgroundColor, const QColor &textColor,
                                      const QColor &linkColor, const QColor &visitedLinkColor)
 {
     Q_ASSERT(partIndex.isValid());
     QFontInfo fontInfo(font);
     return UiUtils::htmlizedTextPart(partIndex, fontInfo,
                                      backgroundColor, textColor,
                                      linkColor, visitedLinkColor);
 }
 
 /** @short Produce a properly formatted HTML string which won't overflow the right edge of the display */
 QString Formatting::htmlHexifyByteArray(const QByteArray &rawInput)
 {
     QByteArray inHex = rawInput.toHex();
     QByteArray res;
     const int stepping = 4;
     for (int i = 0; i < inHex.length(); i += stepping) {
         // The individual blocks are formatted separately to allow line breaks to happen
         res.append("<code style=\"font-family: monospace;\">");
         res.append(inHex.mid(i, stepping));
         if (i + stepping < inHex.size()) {
             res.append(":");
         }
         // Produce the smallest possible space. "display: none" won't notice the space at all, leading to overly long lines
         res.append("</code><span style=\"font-size: 1px\"> </span>");
     }
     return QString::fromUtf8(res);
 }
 
 QString Formatting::sslChainToHtml(const QList<QSslCertificate> &sslChain)
 {
     QStringList certificateStrings;
     Q_FOREACH(const QSslCertificate &cert, sslChain) {
         certificateStrings << tr("<li><b>CN</b>: %1,<br/>\n<b>Organization</b>: %2,<br/>\n"
                                  "<b>Serial</b>: %3,<br/>\n"
                                  "<b>SHA1</b>: %4,<br/>\n<b>MD5</b>: %5</li>").arg(
                                   cert.subjectInfo(QSslCertificate::CommonName).join(tr(", ")).toHtmlEscaped(),
                                   cert.subjectInfo(QSslCertificate::Organization).join(tr(", ")).toHtmlEscaped(),
                                   QString::fromUtf8(cert.serialNumber()),
                                   htmlHexifyByteArray(cert.digest(QCryptographicHash::Sha1)),
                                   htmlHexifyByteArray(cert.digest(QCryptographicHash::Md5)));
     }
     return sslChain.isEmpty() ?
                 tr("<p>The remote side doesn't have a certificate.</p>\n") :
                 tr("<p>This is the certificate chain of the connection:</p>\n<ul>%1</ul>\n").arg(certificateStrings.join(tr("\n")));
 }
 
 QString Formatting::sslErrorsToHtml(const QList<QSslError> &sslErrors)
 {
     QStringList sslErrorStrings;
     Q_FOREACH(const QSslError &e, sslErrors) {
         sslErrorStrings << tr("<li>%1</li>").arg(e.errorString().toHtmlEscaped());
     }
     return sslErrors.isEmpty() ?
                 tr("<p>According to your system's policy, this connection is secure.</p>\n") :
                 tr("<p>The connection triggered the following SSL errors:</p>\n<ul>%1</ul>\n").arg(sslErrorStrings.join(tr("\n")));
 }
 
 void Formatting::formatSslState(const QList<QSslCertificate> &sslChain, const QByteArray &oldPubKey,
                                       const QList<QSslError> &sslErrors, QString *title, QString *message, IconType *icon)
 {
     bool pubKeyHasChanged = !oldPubKey.isEmpty() && (sslChain.isEmpty() || sslChain[0].publicKey().toPem() != oldPubKey);
 
     if (pubKeyHasChanged) {
         if (sslErrors.isEmpty()) {
             *icon = IconType::Warning;
             *title = tr("Different SSL certificate");
             *message = tr("<p>The public key of the SSL certificate has changed. "
                           "This should only happen when there was a security incident on the remote server. "
                           "Your system configuration is set to accept such certificates anyway.</p>\n%1\n"
                           "<p>Would you like to connect and remember the new certificate?</p>")
                     .arg(sslChainToHtml(sslChain));
         } else {
             // changed certificate which is not trusted per systemwide policy
             *title = tr("SSL certificate looks fishy");
             *message = tr("<p>The public key of the SSL certificate of the IMAP server has changed since the last time "
                           "and your system doesn't believe that the new certificate is genuine.</p>\n%1\n%2\n"
                           "<p>Would you like to connect anyway and remember the new certificate?</p>").
                     arg(sslChainToHtml(sslChain), sslErrorsToHtml(sslErrors));
             *icon = IconType::Critical;
         }
     } else {
         if (sslErrors.isEmpty()) {
             // this is the first time and the certificate looks valid -> accept
             *title = tr("Accept SSL connection?");
             *message = tr("<p>This is the first time you're connecting to this IMAP server; the certificate is trusted "
                           "by this system.</p>\n%1\n%2\n"
                           "<p>Would you like to connect and remember this certificate's public key for the next time?</p>")
                     .arg(sslChainToHtml(sslChain), sslErrorsToHtml(sslErrors));
             *icon = IconType::Information;
         } else {
             *title = tr("Accept SSL connection?");
             *message = tr("<p>This is the first time you're connecting to this IMAP server and the server certificate failed "
                           "validation test.</p>\n%1\n\n%2\n"
                           "<p>Would you like to connect and remember this certificate's public key for the next time?</p>")
                     .arg(sslChainToHtml(sslChain), sslErrorsToHtml(sslErrors));
             *icon = IconType::Question;
         }
     }
 }
 
 /** @short Input formatted as HTML with proper escaping and forced to be detected as HTML */
 QString Formatting::htmlEscaped(const QString &input)
 {
     if (input.isEmpty())
         return QString();
 
     // HTML entities are escaped, but not auto-detected as HTML
     return QLatin1String("<span>") + input.toHtmlEscaped() + QLatin1String("</span>");
 }
 
 QObject *Formatting::factory(QQmlEngine *engine, QJSEngine *scriptEngine)
 {
     Q_UNUSED(scriptEngine);
 
     // the reinterpret_cast is used to avoid haivng to depend on QtQuick when doing non-QML builds
     Formatting *f = new Formatting(reinterpret_cast<QObject*>(engine));
     return f;
 }
 
 bool elideAddress(QString &address)
 {
     if (address.length() < 66)
         return false;
 
     const int idx = address.lastIndexOf(QLatin1Char('@'));
     auto ellipsis = QStringLiteral("\u2026");
     if (idx > -1) {
         if (idx < 9) // local part is too short to strip anything
             return false;
 
         // do not stash the domain and leave at least 4 chars head and tail of the local part
         const int d = qMax(8, idx - (address.length() - 60))/2;
         address = address.leftRef(d) + ellipsis + address.rightRef(address.length() - idx + d);
     } else {
         // some longer something, just remove the overhead in the center to eg.
         // leave "https://" and "foo/index.html" intact
         address = address.leftRef(30) + ellipsis + address.rightRef(30);
     }
     return true;
 }
 
 }