common: Unify Date/Time formatting, UTC offset
[quassel.git] / src / common / util.cpp
index d9b9d2a..d7e83d8 100644 (file)
@@ -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  *
@@ -280,3 +280,157 @@ QString formatCurrentDateTimeInString(const QString &formatStr)
 
     return formattedStr;
 }
+
+
+bool scopeMatch(const QString &string, const QString &scopeRule, const bool &isRegEx,
+                const bool &isCaseSensitive)
+{
+    // When isRegEx is false:
+    // A match happens when the string does NOT match ANY inverted rules and matches AT LEAST one
+    // normal rule, unless no normal rules exist (implicit wildcard match).  This gives inverted
+    // rules higher priority regardless of ordering.
+    //
+    // When isRegEx is true:
+    // A match happens when the normal regular expression matches.  If prefixed with '!', the match
+    // happens UNLESS the following regular expression matches.
+
+    // TODO: After switching to Qt 5, use of this should be split into two parts, one part that
+    // would generate compiled QRegularExpressions for match/inverted match, regenerating it on any
+    // rule changes, and another part that would check each message against these compiled rules.
+
+    // Cache case sensitivity
+    Qt::CaseSensitivity ruleExactCase = (isCaseSensitive ? Qt::CaseSensitive : Qt::CaseInsensitive);
+
+    if (isRegEx) {
+        // Regular expression tests
+        // -------
+        // Check if this is an inverted rule (starts with '!')
+        if (scopeRule.startsWith("!")) {
+            // Take the reminder of the string
+            QRegExp ruleRx(scopeRule.mid(1), ruleExactCase);
+            // Matching an inverted rule: matched (true) implies rule failure (false)
+            return !ruleRx.exactMatch(string);
+        } else {
+            QRegExp ruleRx(scopeRule, ruleExactCase);
+            // Matching a normal rule: matched (true) implies rule success (true)
+            return ruleRx.exactMatch(string);
+        }
+    } else {
+        // Wildcard expression tests
+        // -------
+        // Keep track if any matches are found
+        bool matches = false;
+        // Keep track if normal rules and inverted rules are found, allowing for implicit wildcard
+        bool normalRuleFound = false, invertedRuleFound = false;
+
+        // Split each scope rule by separator, ignoring empty parts
+        foreach(QString rule, scopeRule.split(";", QString::SkipEmptyParts)) {
+            // Trim whitespace from the start/end of the rule
+            rule = rule.trimmed();
+            // Ignore empty rules
+            if (rule.isEmpty())
+                continue;
+
+            // Check if this is an inverted rule (starts with '!')
+            if (rule.startsWith("!")) {
+                // Inverted rule found
+                invertedRuleFound = true;
+
+                // Take the reminder of the string
+                QRegExp ruleRx(rule.mid(1), ruleExactCase);
+                ruleRx.setPatternSyntax(QRegExp::Wildcard);
+                if (ruleRx.exactMatch(string)) {
+                    // Matches an inverted rule, full rule cannot match
+                    return false;
+                }
+            } else {
+                // Normal rule found
+                normalRuleFound = true;
+
+                QRegExp ruleRx(rule, ruleExactCase);
+                ruleRx.setPatternSyntax(QRegExp::Wildcard);
+                if (ruleRx.exactMatch(string)) {
+                    // Matches a normal rule, full rule might match
+                    matches = true;
+                    // Continue checking in case other inverted rules negate this
+                }
+            }
+        }
+        // No inverted rules matched, okay to match normally
+        // Return true if...
+        // ...we found a normal match
+        // ...implicit wildcard: we had inverted rules (that didn't match) and no normal rules
+        return matches || (invertedRuleFound && !normalRuleFound);
+    }
+}
+
+
+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;
+    }
+
+    // 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
+        return date.toUTC().toString(dateFormat);
+    } else if (dateFormat == Qt::DateFormat::ISODate) {
+        // Add in ISO local timezone information via special handling below
+        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";
+    }
+
+#if 0
+    // The expected way to get a UTC offset on ISO8601 dates
+    return dateTime.toTimeSpec(Qt::OffsetFromUTC).toString(Qt::ISODate);
+#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
+    return local.toString(Qt::ISODate);
+#endif
+}