Move around and format code

No functional changes here.

4 files changed, 66 insertions, 51 deletions

diff --git a/lib/connection.cpp b/lib/connection.cpp
index 9f4f7082..efc7163e 100644
--- a/lib/connection.cpp
+++ b/lib/connection.cpp
@@ -20,7 +20,7 @@
 
 #include "connectiondata.h"
 #ifdef Quotient_E2EE_ENABLED
-#include "encryptionmanager.h"
+#    include "encryptionmanager.h"
 #endif // Quotient_E2EE_ENABLED
 #include "room.h"
 #include "settings.h"
@@ -45,7 +45,7 @@
 #include "jobs/syncjob.h"
 
 #ifdef Quotient_E2EE_ENABLED
-#include "account.h" // QtOlm
+#    include "account.h" // QtOlm
 #endif // Quotient_E2EE_ENABLED
 
 #include <QtCore/QCoreApplication>
diff --git a/lib/jobs/basejob.cpp b/lib/jobs/basejob.cpp
index 470250bf..100c05f2 100644
--- a/lib/jobs/basejob.cpp
+++ b/lib/jobs/basejob.cpp
@@ -35,6 +35,47 @@ using namespace Quotient;
 using std::chrono::seconds, std::chrono::milliseconds;
 using namespace std::chrono_literals;
 
+BaseJob::StatusCode BaseJob::Status::fromHttpCode(int httpCode)
+{
+    if (httpCode / 10 == 41) // 41x errors
+        return httpCode == 410 ? IncorrectRequestError : NotFoundError;
+    switch (httpCode) {
+    case 401:
+        return Unauthorised;
+        // clang-format off
+    case 403: case 407: // clang-format on
+        return ContentAccessError;
+    case 404:
+        return NotFoundError;
+        // clang-format off
+    case 400: case 405: case 406: case 426: case 428: case 505: // clang-format on
+    case 494: // Unofficial nginx "Request header too large"
+    case 497: // Unofficial nginx "HTTP request sent to HTTPS port"
+        return IncorrectRequestError;
+    case 429:
+        return TooManyRequestsError;
+    case 501:
+    case 510:
+        return RequestNotImplementedError;
+    case 511:
+        return NetworkAuthRequiredError;
+    default:
+        return NetworkError;
+    }
+}
+
+QDebug BaseJob::Status::dumpToLog(QDebug dbg) const
+{
+    QDebugStateSaver _s(dbg);
+    dbg.noquote().nospace();
+    if (auto* const k = QMetaEnum::fromType<StatusCode>().valueToKey(code)) {
+        const QByteArray b = k;
+        dbg << b.mid(b.lastIndexOf(':'));
+    } else
+        dbg << code;
+    return dbg << ": " << message;
+}
+
 struct NetworkReplyDeleter : public QScopedPointerDeleteLater {
     static inline void cleanup(QNetworkReply* reply)
     {
@@ -316,7 +357,15 @@ void BaseJob::sendRequest()
             << "Request could not start:" << d->dumpRequest();
 }
 
-void BaseJob::checkReply() { setStatus(doCheckReply(d->reply.data())); }
+BaseJob::Status BaseJob::Private::parseJsonDocument()
+{
+    QJsonParseError error { 0, QJsonParseError::MissingObject };
+    jsonResponse = QJsonDocument::fromJson(d->rawResponse, &error);
+    return { error.error == QJsonParseError::NoError
+                 ? BaseJob::NoError
+                 : BaseJob::IncorrectResponse,
+             error.errorString() };
+}
 
 void BaseJob::gotReply()
 {
@@ -363,47 +412,6 @@ bool checkContentType(const QByteArray& type, const QByteArrayList& patterns)
     return false;
 }
 
-BaseJob::StatusCode BaseJob::Status::fromHttpCode(int httpCode)
-{
-    if (httpCode / 10 == 41) // 41x errors
-        return httpCode == 410 ? IncorrectRequestError : NotFoundError;
-    switch (httpCode) {
-    case 401:
-        return Unauthorised;
-    // clang-format off
-    case 403: case 407: // clang-format on
-        return ContentAccessError;
-    case 404:
-        return NotFoundError;
-    // clang-format off
-    case 400: case 405: case 406: case 426: case 428: case 505: // clang-format on
-    case 494: // Unofficial nginx "Request header too large"
-    case 497: // Unofficial nginx "HTTP request sent to HTTPS port"
-        return IncorrectRequestError;
-    case 429:
-        return TooManyRequestsError;
-    case 501: case 510:
-        return RequestNotImplementedError;
-    case 511:
-        return NetworkAuthRequiredError;
-    default:
-        return NetworkError;
-    }
-}
-
-QDebug BaseJob::Status::dumpToLog(QDebug dbg) const
-{
-    QDebugStateSaver _s(dbg);
-    dbg.noquote().nospace();
-    if (auto* const k = QMetaEnum::fromType<StatusCode>().valueToKey(code)) {
-        const QByteArray b = k;
-        dbg << b.mid(b.lastIndexOf(':'));
-    } else
-        dbg << code;
-    return dbg << ": " << message;
-
-}
-
 BaseJob::Status BaseJob::doCheckReply(QNetworkReply* reply) const
 {
     // QNetworkReply error codes seem to be flawed when it comes to HTTP;
@@ -440,6 +448,8 @@ BaseJob::Status BaseJob::doCheckReply(QNetworkReply* reply) const
     return Status::fromHttpCode(httpCode, message);
 }
 
+void BaseJob::checkReply() { setStatus(doCheckReply(d->reply.data())); }
+
 BaseJob::Status BaseJob::parseReply(QNetworkReply* reply)
 {
     d->rawResponse = reply->readAll();
diff --git a/lib/jobs/basejob.h b/lib/jobs/basejob.h
index 2049f59c..954b0777 100644
--- a/lib/jobs/basejob.h
+++ b/lib/jobs/basejob.h
@@ -170,6 +170,8 @@ public:
      * recommended to present a sample of raw data as "details" next to
      * error messages. Note that the default \p bytesAtMost value is
      * also tailored to UI cases.
+     *
+     * \sa rawData
      */
     QString rawDataSample(int bytesAtMost = 65535) const;
 
@@ -322,6 +324,7 @@ protected:
      * on retries.
      */
     virtual void doPrepare();
+
     /*! Postprocessing after the network request has been sent
      *
      * This method is called every time the job receives a running
@@ -331,13 +334,15 @@ protected:
     virtual void onSentRequest(QNetworkReply*);
     virtual void beforeAbandon(QNetworkReply*);
 
-    /**
-     * Used by gotReply() to check the received reply for general
-     * issues such as network errors or access denial.
-     * Returning anything except NoError/Success prevents
-     * further parseReply()/parseJson() invocation.
+    /*! \brief Check the pending or received reply for upfront issues
+     *
+     * This is invoked when headers are first received and also once
+     * the complete reply is obtained; the base implementation checks the HTTP
+     * headers to detect general issues such as network errors or access denial.
+     * It cannot read the response body (use parseReply/parseError to check
+     * for problems in the body). Returning anything except NoError/Success
+     * prevents further processing of the reply.
      *
-     * @param reply the reply received from the server
      * @return the result of checking the reply
      *
      * @see gotReply
diff --git a/lib/syncdata.h b/lib/syncdata.h
index 6e7183ee..41b8186e 100644
--- a/lib/syncdata.h
+++ b/lib/syncdata.h
@@ -75,7 +75,7 @@ public:
     static const QString UnreadCountKey;
 };
 
-// QVector cannot work with non-copiable objects, std::vector can.
+// QVector cannot work with non-copyable objects, std::vector can.
 using SyncDataList = std::vector<SyncRoomData>;
 
 class SyncData {