X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Futil.cpp;h=4a9165a3f0fd69222ca1f8c864a4b26486776d9a;hp=b8adb361fb28c3fb9b4561ddfd2e731515bd2879;hb=3a3e844f9fcfd12235a0086af75ecd503b621ef4;hpb=dcd6c362d77ab4cb5ea73b7e54ce944a68aa3f06 diff --git a/src/common/util.cpp b/src/common/util.cpp index b8adb361..4a9165a3 100644 --- a/src/common/util.cpp +++ b/src/common/util.cpp @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2016 by the Quassel Project * + * Copyright (C) 2005-2018 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -20,57 +20,61 @@ #include "util.h" +#include +#include +#include + #include +#include #include -#include #include +#include #include "quassel.h" -class QMetaMethod; - // MIBenum values from http://www.iana.org/assignments/character-sets/character-sets.xml#table-character-sets-1 static QList utf8DetectionBlacklist = QList() << 39 /* ISO-2022-JP */; -QString nickFromMask(QString mask) +QString nickFromMask(const QString &mask) { - return mask.section('!', 0, 0); + return mask.left(mask.indexOf('!')); } -QString userFromMask(QString mask) +QString userFromMask(const QString &mask) { - QString userhost = mask.section('!', 1); - if (userhost.isEmpty()) return QString(); - return userhost.section('@', 0, 0); + 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 hostFromMask(const QString &mask) { - QString userhost = mask.section('!', 1); - if (userhost.isEmpty()) return QString(); - return userhost.section('@', 1); + 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) +bool isChannelName(const QString &str) { - return QString("#&!+").contains(str[0]); + if (str.isEmpty()) + return false; + static constexpr std::array prefixes{{'#', '&', '!', '+'}}; + return std::any_of(prefixes.cbegin(), prefixes.cend(), [&str](quint8 c) { return c == str[0]; }); } -QString stripFormatCodes(QString str) +QString stripFormatCodes(QString message) { - 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; + 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); } @@ -165,12 +169,13 @@ uint editingDistance(const QString &s1, const QString &s2) QString secondsToString(int timeInSeconds) { - QList > 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"))); + static QVector> 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; @@ -201,17 +206,176 @@ QByteArray prettyDigest(const QByteArray &digest) return prettyDigest; } -QString formatCurrentDateTimeInString(QString str) + +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 %%%% 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++; + } + + return formattedStr; +} + + +QString tryFormatUnixEpoch(const QString &possibleEpochDate, Qt::DateFormat dateFormat, bool useUTC) { - /* - * Find %%%% in string. Repleace inside text which is format to QDateTime - * with current timestamp. - */ - QRegExp rx("\\%%(.*)\\%%"); - rx.setMinimal(true); - int s = rx.indexIn(str); - if (s >= 0) - str.replace(s, rx.cap(0).length(), QDateTime::currentDateTime().toString(rx.cap(1))); - - return str; + // 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; + } + + // 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 + + // 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 formatDateTimeToOffsetISO(const QDateTime &dateTime) +{ + if (!dateTime.isValid()) { + // Don't try to do anything with invalid date/time + return "formatDateTimeToISO() invalid date/time"; + } + + // 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 }