src: Yearly copyright bump
[quassel.git] / src / common / util.cpp
index f52154c..aaf3aca 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-2019 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   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.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
 #include "util.h"
 
+#include <algorithm>
+#include <array>
+#include <utility>
+
 #include <QCoreApplication>
+#include <QDateTime>
 #include <QDebug>
 #include <QTextCodec>
-#include <QTranslator>
+#include <QVector>
 
 #include "quassel.h"
 
-class QMetaMethod;
+// MIBenum values from http://www.iana.org/assignments/character-sets/character-sets.xml#table-character-sets-1
+static QList<int> utf8DetectionBlacklist = QList<int>() << 39 /* ISO-2022-JP */;
 
-QString nickFromMask(QString mask) {
-  return mask.section('!', 0, 0);
+QString nickFromMask(const QString& mask)
+{
+    return mask.left(mask.indexOf('!'));
 }
 
-QString userFromMask(QString mask) {
-  QString userhost = mask.section('!', 1);
-  if(userhost.isEmpty()) return QString();
-  return userhost.section('@', 0, 0);
+QString userFromMask(const QString& mask)
+{
+    const int offset = mask.indexOf('!') + 1;
+    if (offset <= 0)
+        return {};
+    const int length = mask.indexOf('@', offset) - offset;
+    return mask.mid(offset, length >= 0 ? length : -1);
 }
 
-QString hostFromMask(QString mask) {
-  QString userhost = mask.section('!', 1);
-  if(userhost.isEmpty()) return QString();
-  return userhost.section('@', 1);
+QString hostFromMask(const QString& mask)
+{
+    const int excl = mask.indexOf('!');
+    if (excl < 0)
+        return {};
+    const int offset = mask.indexOf('@', excl + 1) + 1;
+    return offset > 0 && offset < mask.size() ? mask.mid(offset) : QString{};
 }
 
-bool isChannelName(QString str) {
-  return QString("#&!+").contains(str[0]);
+bool isChannelName(const QString& str)
+{
+    if (str.isEmpty())
+        return false;
+    static constexpr std::array<quint8, 4> prefixes{{'#', '&', '!', '+'}};
+    return std::any_of(prefixes.cbegin(), prefixes.cend(), [&str](quint8 c) { return c == str[0]; });
 }
 
-QString stripFormatCodes(QString str) {
-  str.remove(QRegExp("\x03(\\d\\d?(,\\d\\d?)?)?"));
-  str.remove('\x02');
-  str.remove('\x0f');
-  str.remove('\x12');
-  str.remove('\x16');
-  str.remove('\x1d');
-  str.remove('\x1f');
-  return str;
+QString stripFormatCodes(QString message)
+{
+    static QRegExp regEx{"\x03(\\d\\d?(,\\d\\d?)?)?|\x04([\\da-fA-F]{6}(,[\\da-fA-F]{6})?)?|[\x02\x0f\x11\x12\x16\x1d\x1e\x1f]"};
+    return message.remove(regEx);
 }
 
-QString decodeString(const QByteArray &input, QTextCodec *codec) {
-  // First, we check if it's utf8. It is very improbable to encounter a string that looks like
-  // valid utf8, but in fact is not. This means that if the input string passes as valid utf8, it
-  // is safe to assume that it is.
-  // Q_ASSERT(sizeof(const char) == sizeof(quint8));  // In God we trust...
-  bool isUtf8 = true;
-  int cnt = 0;
-  for(int i = 0; i < input.size(); i++) {
-    if(cnt) {
-      // We check a part of a multibyte char. These need to be of the form 10yyyyyy.
-      if((input[i] & 0xc0) != 0x80) { isUtf8 = false; break; }
-      cnt--;
-      continue;
+QString stripAcceleratorMarkers(const QString& label_)
+{
+    QString label = label_;
+    int p = 0;
+    forever
+    {
+        p = label.indexOf('&', p);
+        if (p < 0 || p + 1 >= label.length())
+            break;
+
+        if (label.at(p + 1).isLetterOrNumber() || label.at(p + 1) == '&')
+            label.remove(p, 1);
+
+        ++p;
     }
-    if((input[i] & 0x80) == 0x00) continue; // 7 bit is always ok
-    if((input[i] & 0xf8) == 0xf0) { cnt = 3; continue; }  // 4-byte char 11110xxx 10yyyyyy 10zzzzzz 10vvvvvv
-    if((input[i] & 0xf0) == 0xe0) { cnt = 2; continue; }  // 3-byte char 1110xxxx 10yyyyyy 10zzzzzz
-    if((input[i] & 0xe0) == 0xc0) { cnt = 1; continue; }  // 2-byte char 110xxxxx 10yyyyyy
-    isUtf8 = false; break;  // 8 bit char, but not utf8!
-  }
-  if(isUtf8 && cnt == 0) {
-    QString s = QString::fromUtf8(input);
-    //qDebug() << "Detected utf8:" << s;
-    return s;
-  }
-  //QTextCodec *codec = QTextCodec::codecForName(encoding.toAscii());
-  if(!codec) return QString::fromAscii(input);
-  return codec->toUnicode(input);
+    return label;
 }
 
-/* not needed anymore
-void writeDataToDevice(QIODevice *dev, const QVariant &item) {
-  QByteArray block;
-  QDataStream out(&block, QIODevice::WriteOnly);
-  out.setVersion(QDataStream::Qt_4_2);
-  out << (quint32)0 << item;
-  out.device()->seek(0);
-  out << (quint32)(block.size() - sizeof(quint32));
-  dev->write(block);
+QString decodeString(const QByteArray& input, QTextCodec* codec)
+{
+    if (codec && utf8DetectionBlacklist.contains(codec->mibEnum()))
+        return codec->toUnicode(input);
+
+    // First, we check if it's utf8. It is very improbable to encounter a string that looks like
+    // valid utf8, but in fact is not. This means that if the input string passes as valid utf8, it
+    // is safe to assume that it is.
+    // Q_ASSERT(sizeof(const char) == sizeof(quint8));  // In God we trust...
+    bool isUtf8 = true;
+    int cnt = 0;
+    for (uchar c : input) {
+        if (cnt) {
+            // We check a part of a multibyte char. These need to be of the form 10yyyyyy.
+            if ((c & 0xc0) != 0x80) {
+                isUtf8 = false;
+                break;
+            }
+            cnt--;
+            continue;
+        }
+        if ((c & 0x80) == 0x00)
+            continue;  // 7 bit is always ok
+        if ((c & 0xf8) == 0xf0) {
+            cnt = 3;
+            continue;
+        }  // 4-byte char 11110xxx 10yyyyyy 10zzzzzz 10vvvvvv
+        if ((c & 0xf0) == 0xe0) {
+            cnt = 2;
+            continue;
+        }  // 3-byte char 1110xxxx 10yyyyyy 10zzzzzz
+        if ((c & 0xe0) == 0xc0) {
+            cnt = 1;
+            continue;
+        }  // 2-byte char 110xxxxx 10yyyyyy
+        isUtf8 = false;
+        break;  // 8 bit char, but not utf8!
+    }
+    if (isUtf8 && cnt == 0) {
+        QString s = QString::fromUtf8(input);
+        // qDebug() << "Detected utf8:" << s;
+        return s;
+    }
+    // QTextCodec *codec = QTextCodec::codecForName(encoding.toLatin1());
+    if (!codec)
+        return QString::fromLatin1(input);
+    return codec->toUnicode(input);
 }
 
-bool readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item) {
-  QDataStream in(dev);
-  in.setVersion(QDataStream::Qt_4_2);
-
-  if(blockSize == 0) {
-    if(dev->bytesAvailable() < (int)sizeof(quint32)) return false;
-    in >> blockSize;
-  }
-  if(dev->bytesAvailable() < blockSize) return false;
-  in >> item;
-  return true;
+uint editingDistance(const QString& s1, const QString& s2)
+{
+    uint n = s1.size() + 1;
+    uint m = s2.size() + 1;
+    QVector<QVector<uint>> matrix(n, QVector<uint>(m, 0));
+
+    for (uint i = 0; i < n; i++)
+        matrix[i][0] = i;
+
+    for (uint i = 0; i < m; i++)
+        matrix[0][i] = i;
+
+    uint min;
+    for (uint i = 1; i < n; i++) {
+        for (uint j = 1; j < m; j++) {
+            uint deleteChar = matrix[i - 1][j] + 1;
+            uint insertChar = matrix[i][j - 1] + 1;
+
+            if (deleteChar < insertChar)
+                min = deleteChar;
+            else
+                min = insertChar;
+
+            if (s1[i - 1] == s2[j - 1]) {
+                uint inheritChar = matrix[i - 1][j - 1];
+                if (inheritChar < min)
+                    min = inheritChar;
+            }
+
+            matrix[i][j] = min;
+        }
+    }
+    return matrix[n - 1][m - 1];
 }
-*/
-
-uint editingDistance(const QString &s1, const QString &s2) {
-  uint n = s1.size()+1;
-  uint m = s2.size()+1;
-  QVector< QVector< uint > >matrix(n,QVector<uint>(m,0));
 
-  for(uint i = 0; i < n; i++)
-    matrix[i][0] = i;
-
-  for(uint i = 0; i < m; i++)
-    matrix[0][i] = i;
-
-  uint min;
-  for(uint i = 1; i < n; i++) {
-    for(uint j = 1; j < m; j++) {
-      uint deleteChar = matrix[i-1][j] + 1;
-      uint insertChar = matrix[i][j-1] + 1;
-
-      if(deleteChar < insertChar)
-       min = deleteChar;
-      else
-       min = insertChar;
-
-      if(s1[i-1] == s2[j-1]) {
-       uint inheritChar = matrix[i-1][j-1];
-       if(inheritChar < min)
-         min = inheritChar;
-      }
-
-      matrix[i][j] = min;
+QString secondsToString(int timeInSeconds)
+{
+    static QVector<std::pair<int, QString>> timeUnit{std::make_pair(365 * 24 * 60 * 60,
+                                                                    QCoreApplication::translate("Quassel::secondsToString()", "year")),
+                                                     std::make_pair(24 * 60 * 60,
+                                                                    QCoreApplication::translate("Quassel::secondsToString()", "day")),
+                                                     std::make_pair(60 * 60, QCoreApplication::translate("Quassel::secondsToString()", "h")),
+                                                     std::make_pair(60, QCoreApplication::translate("Quassel::secondsToString()", "min")),
+                                                     std::make_pair(1, QCoreApplication::translate("Quassel::secondsToString()", "sec"))};
+
+    if (timeInSeconds != 0) {
+        QStringList returnString;
+        for (const auto& tu : timeUnit) {
+            int n = timeInSeconds / tu.first;
+            if (n > 0) {
+                returnString += QString("%1 %2").arg(QString::number(n), tu.second);
+            }
+            timeInSeconds = timeInSeconds % tu.first;
+        }
+        return returnString.join(", ");
     }
-  }
-  return matrix[n-1][m-1];
-}
 
-QByteArray methodName(const QMetaMethod &method) {
-  QByteArray sig(method.signature());
-  return sig.left(sig.indexOf("("));
+    return QString("%1 %2").arg(QString::number(timeInSeconds), timeUnit.last().second);
 }
 
-QDir quasselDir() {
-  QString quasselDir;
-  if(Quassel::isOptionSet("datadir")) {
-    quasselDir = Quassel::optionValue("datadir");
-  } else {
-    // FIXME use QDesktopServices
-#ifdef Q_OS_WIN32
-    quasselDir = qgetenv("APPDATA") + "/quassel/";
-#elif defined Q_WS_MAC
-    quasselDir = QDir::homePath() + "/Library/Application Support/Quassel/";
-#else
-    quasselDir = QDir::homePath() + "/.quassel/";
-#endif
-  }
+QByteArray prettyDigest(const QByteArray& digest)
+{
+    QByteArray hexDigest = digest.toHex().toUpper();
+    QByteArray prettyDigest;
+    prettyDigest.fill(':', hexDigest.count() + (hexDigest.count() / 2) - 1);
 
-  QDir qDir(quasselDir);
-  if(!qDir.exists(quasselDir)) {
-    if(!qDir.mkpath(quasselDir)) {
-      qCritical() << "Unable to create Quassel data directory:" << qPrintable(qDir.absolutePath());
+    for (int i = 0; i * 2 < hexDigest.count(); i++) {
+        prettyDigest.replace(i * 3, 2, hexDigest.mid(i * 2, 2));
     }
-  }
-
-  return qDir;
+    return prettyDigest;
 }
 
-void loadTranslation(const QLocale &locale) {
-  QTranslator *qtTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QtTr");
-  QTranslator *quasselTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QuasselTr");
-  Q_ASSERT(qtTranslator);
-  Q_ASSERT(quasselTranslator);
-
-  QLocale::setDefault(locale);
+QString formatCurrentDateTimeInString(const QString& formatStr)
+{
+    // Work on a copy of the string to avoid modifying the input string
+    QString formattedStr = QString(formatStr);
+
+    // Exit early if there's nothing to format
+    if (formattedStr.isEmpty())
+        return formattedStr;
+
+    // Find %%<text>%% in string. Replace inside text formatted to QDateTime with the current
+    // timestamp, using %%%% as an escape for multiple %% signs.
+    // For example:
+    // Simple:   "All Quassel clients vanished from the face of the earth... %%hh:mm:ss%%"
+    // > Result:  "All Quassel clients vanished from the face of the earth... 23:20:34"
+    // Complex:  "Away since %%hh:mm%% on %%dd.MM%% - %%%% not here %%%%"
+    // > Result:  "Away since 23:20 on 21.05 - %% not here %%"
+    //
+    // Match groups of double % signs - Some text %%inside here%%, and even %%%%:
+    //   %%(.*)%%
+    //   (...)    marks a capturing group
+    //   .*       matches zero or more characters, not including newlines
+    // Note that '\' must be escaped as '\\'
+    // Helpful interactive website for debugging and explaining:  https://regex101.com/
+    QRegExp regExpMatchTime("%%(.*)%%");
+
+    // Preserve the smallest groups possible to allow for multiple %%blocks%%
+    regExpMatchTime.setMinimal(true);
+
+    // NOTE: Move regExpMatchTime to a static regular expression if used anywhere that performance
+    // matters.
+
+    // Don't allow a runaway regular expression to loop for too long.  This might not happen.. but
+    // when dealing with user input, better to be safe..?
+    int numIterations = 0;
+
+    // Find each group of %%text here%% starting from the beginning
+    int index = regExpMatchTime.indexIn(formattedStr);
+    int matchLength;
+    QString matchedFormat;
+    while (index >= 0 && numIterations < 512) {
+        // Get the total length of the matched expression
+        matchLength = regExpMatchTime.cap(0).length();
+        // Get the format string, e.g. "this text here" from "%%this text here%%"
+        matchedFormat = regExpMatchTime.cap(1);
+        // Check that there's actual characters inside.  A quadruple % (%%%%) represents two %%
+        // signs.
+        if (matchedFormat.length() > 0) {
+            // Format the string according to the current date and time.  Invalid time format
+            // strings are ignored.
+            formattedStr.replace(index, matchLength, QDateTime::currentDateTime().toString(matchedFormat));
+            // Subtract the length of the removed % signs
+            // E.g. "%%h:mm ap%%" turns into "h:mm ap", removing four % signs, thus -4.  This is
+            // used below to determine how far to advance when looking for the next formatting code.
+            matchLength -= 4;
+        }
+        else if (matchLength == 4) {
+            // Remove two of the four percent signs, so '%%%%' escapes to '%%'
+            formattedStr.remove(index, 2);
+            // Subtract the length of the removed % signs, this time removing two % signs, thus -2.
+            matchLength -= 2;
+        }
+        else {
+            // If neither of these match, something went wrong.  Don't modify it to be safe.
+            qDebug() << "Unexpected time format when parsing string, no matchedFormat, matchLength "
+                        "should be 4, actually is"
+                     << matchLength;
+        }
+
+        // Find the next group of %%text here%% starting from where the last group ended
+        index = regExpMatchTime.indexIn(formattedStr, index + matchLength);
+        numIterations++;
+    }
 
-  QCoreApplication::removeTranslator(qtTranslator);
-  QCoreApplication::removeTranslator(quasselTranslator);
+    return formattedStr;
+}
 
-  if(locale.language() == QLocale::C)
-    return;
+QString tryFormatUnixEpoch(const QString& possibleEpochDate, Qt::DateFormat dateFormat, bool useUTC)
+{
+    // Does the string resemble a Unix epoch?  Parse as 64-bit time
+    qint64 secsSinceEpoch = possibleEpochDate.toLongLong();
+    if (secsSinceEpoch == 0) {
+        // Parsing either failed, or '0' was sent.  No need to distinguish; either way, it's not
+        // useful as epoch.
+        // See https://doc.qt.io/qt-5/qstring.html#toLongLong
+        return possibleEpochDate;
+    }
 
-  qtTranslator->load(QString(":i18n/qt_%1").arg(locale.name()));
-  quasselTranslator->load(QString(":i18n/quassel_%1").arg(locale.name()));
+    // Time checks out, parse it
+    QDateTime date;
+#if QT_VERSION >= 0x050800
+    date.setSecsSinceEpoch(secsSinceEpoch);
+#else
+    // toSecsSinceEpoch() was added in Qt 5.8.  Manually downconvert to seconds for now.
+    // See https://doc.qt.io/qt-5/qdatetime.html#toMSecsSinceEpoch
+    date.setMSecsSinceEpoch(secsSinceEpoch * 1000);
+#endif
 
-  QCoreApplication::installTranslator(qtTranslator);
-  QCoreApplication::installTranslator(quasselTranslator);
+    // Return the localized date/time
+    if (useUTC) {
+        // Return UTC time
+        if (dateFormat == Qt::DateFormat::ISODate) {
+            // Replace the "T" date/time separator with " " for readability.  This isn't quite the
+            // ISO 8601 spec (it specifies omitting the "T" entirely), but RFC 3339 allows this.
+            // Go with RFC 3339 for human readability that's still machine-parseable, too.
+            //
+            // Before: 2018-06-21T21:35:52Z
+            // After:  2018-06-21 21:35:52Z
+            //         ..........^ (10th character)
+            //
+            // See https://en.wikipedia.org/wiki/ISO_8601#cite_note-32
+            // And https://www.ietf.org/rfc/rfc3339.txt
+            return date.toUTC().toString(dateFormat).replace(10, 1, " ");
+        }
+        else {
+            return date.toUTC().toString(dateFormat);
+        }
+    }
+    else if (dateFormat == Qt::DateFormat::ISODate) {
+        // Add in ISO local timezone information via special handling below
+        // formatDateTimeToOffsetISO() handles converting "T" to " "
+        return formatDateTimeToOffsetISO(date);
+    }
+    else {
+        // Return local time
+        return date.toString(dateFormat);
+    }
 }
 
-QString secondsToString(int timeInSeconds) {
-    QList< QPair<int, QString> > timeUnit;
-    timeUnit.append(qMakePair(365*24*60*60, QCoreApplication::translate("Quassel::secondsToString()", "year")));
-    timeUnit.append(qMakePair(24*60*60, QCoreApplication::translate("Quassel::secondsToString()", "day")));
-    timeUnit.append(qMakePair(60*60, QCoreApplication::translate("Quassel::secondsToString()", "h")));
-    timeUnit.append(qMakePair(60, QCoreApplication::translate("Quassel::secondsToString()", "min")));
-    timeUnit.append(qMakePair(1, QCoreApplication::translate("Quassel::secondsToString()", "sec")));
-
-    QStringList returnString;
-    for(int i=0; i < timeUnit.size(); i++) {
-      int n = timeInSeconds / timeUnit[i].first;
-      if(n > 0) {
-        returnString += QString("%1 %2").arg(QString::number(n), timeUnit[i].second);
-      }
-      timeInSeconds = timeInSeconds % timeUnit[i].first;
+QString formatDateTimeToOffsetISO(const QDateTime& dateTime)
+{
+    if (!dateTime.isValid()) {
+        // Don't try to do anything with invalid date/time
+        return "formatDateTimeToISO() invalid date/time";
     }
-    return returnString.join(", ");
+
+    // Replace the "T" date/time separator with " " for readability.  This isn't quite the ISO 8601
+    // spec (it specifies omitting the "T" entirely), but RFC 3339 allows this.  Go with RFC 3339
+    // for human readability that's still machine-parseable, too.
+    //
+    // Before: 2018-08-22T18:43:10-05:00
+    // After:  2018-08-22 18:43:10-05:00
+    //         ..........^ (10th character)
+    //
+    // See https://en.wikipedia.org/wiki/ISO_8601#cite_note-32
+    // And https://www.ietf.org/rfc/rfc3339.txt
+
+#if 0
+    // The expected way to get a UTC offset on ISO 8601 dates
+    // Remove the "T" date/time separator
+    return dateTime.toTimeSpec(Qt::OffsetFromUTC).toString(Qt::ISODate).replace(10, 1, " ");
+#else
+    // Work around Qt bug that converts to UTC instead of including timezone information
+    // See https://bugreports.qt.io/browse/QTBUG-26161
+    //
+    // NOTE: Despite the bug report marking as fixed in Qt 5.2.0 (QT_VERSION >= 0x050200), this
+    // still appears broken in Qt 5.5.1.
+    //
+    // Credit to "user362638" for the solution below, modified to fit Quassel's needs
+    // https://stackoverflow.com/questions/18750569/qdatetime-isodate-with-timezone
+
+    // Get the local and UTC time
+    QDateTime local = QDateTime(dateTime);
+    QDateTime utc = local.toUTC();
+    utc.setTimeSpec(Qt::LocalTime);
+
+    // Find the UTC offset
+    int utcOffset = utc.secsTo(local);
+
+    // Force the local time to follow this offset
+    local.setUtcOffset(utcOffset);
+    // Now the output should be correct
+    // Remove the "T" date/time separator
+    return local.toString(Qt::ISODate).replace(10, 1, " ");
+#endif
 }