forked from owncloud/client
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
7 changed files
with
180 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| Change: Option to log HTTP requests and responses | ||
|
|
||
| We now allow to log http requests and responses | ||
|
|
||
| https://github.com/owncloud/client/issues/7873 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| /* | ||
| * Copyright (C) by Hannah von Reth <hannah.vonreth@owncloud.com> | ||
| * | ||
| * 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) any later version. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| #include "httplogger.h" | ||
|
|
||
| #include <QRegularExpression> | ||
| #include <QLoggingCategory> | ||
| #include <QBuffer> | ||
|
|
||
| namespace { | ||
| Q_LOGGING_CATEGORY(lcNetworkJobHttp, "httplogger", QtWarningMsg) | ||
|
|
||
| const qint64 PeekSize = 1024 * 1024; | ||
|
|
||
| bool isTextBody(const QString &s) | ||
| { | ||
| static const QRegularExpression regexp(QStringLiteral("^(text/.*|(application/(xml|json|x-www-form-urlencoded)(;|$)))")); | ||
| return regexp.match(s).hasMatch(); | ||
| } | ||
|
|
||
| void logHttp(bool isRequest, const QByteArray &verb, const QString &url, const QString &contentType, const qint64 &contentLength, const QList<QNetworkReply::RawHeaderPair> &header, QIODevice *device) | ||
| { | ||
| QString msg; | ||
| QTextStream stream(&msg); | ||
| if (isRequest) { | ||
| stream << "Request: " << verb; | ||
| } else { | ||
| stream << "Response: " << verb; | ||
| } | ||
| stream << " " << url << " Header: { "; | ||
| for (const auto &it : header) { | ||
| if (it.first == "Authorization") { | ||
| stream << it.first << ": [redacted], "; | ||
| } else { | ||
| stream << it.first << ": " << it.second << ", "; | ||
| } | ||
| } | ||
| stream << "} Data: ["; | ||
| if (contentLength > 0) { | ||
| if (isTextBody(contentType)) { | ||
| if (!device->isOpen()) { | ||
| Q_ASSERT(dynamic_cast<QBuffer *>(device)); | ||
| // should we close it again? | ||
| device->open(QIODevice::ReadOnly); | ||
| } | ||
| Q_ASSERT(device->pos() == 0); | ||
| stream << device->peek(PeekSize); | ||
| } else { | ||
| stream << "Binary Data"; | ||
| } | ||
| } | ||
| stream << "]"; | ||
| qCInfo(lcNetworkJobHttp) << msg; | ||
| } | ||
| } | ||
|
|
||
|
|
||
| namespace OCC { | ||
|
|
||
|
|
||
| void HttpLogger::logReplyOnFinished(const QNetworkReply *reply) | ||
| { | ||
| if (!lcNetworkJobHttp().isInfoEnabled()) { | ||
| return; | ||
| } | ||
| QObject::connect(reply, &QNetworkReply::finished, reply, [reply] { | ||
| ::logHttp(false, | ||
| requestVerb(*reply), | ||
| reply->url().toString(), | ||
| reply->header(QNetworkRequest::ContentTypeHeader).toString(), | ||
| reply->header(QNetworkRequest::ContentLengthHeader).toInt(), | ||
| reply->rawHeaderPairs(), | ||
| const_cast<QNetworkReply *>(reply)); | ||
| }); | ||
| } | ||
|
|
||
| void HttpLogger::logRequest(const QNetworkRequest &request, QNetworkAccessManager::Operation operation, QIODevice *device) | ||
| { | ||
| if (!lcNetworkJobHttp().isInfoEnabled()) { | ||
| return; | ||
| } | ||
| const auto keys = request.rawHeaderList(); | ||
| QList<QNetworkReply::RawHeaderPair> header; | ||
| header.reserve(keys.size()); | ||
| for (const auto &key : keys) { | ||
| header << qMakePair(key, request.rawHeader(key)); | ||
| } | ||
| ::logHttp(true, | ||
| requestVerb(operation, request), | ||
| request.url().toString(), | ||
| request.header(QNetworkRequest::ContentTypeHeader).toString(), | ||
| device ? device->size() : 0, | ||
| header, | ||
| device); | ||
| } | ||
|
|
||
| QByteArray HttpLogger::requestVerb(QNetworkAccessManager::Operation operation, const QNetworkRequest &request) | ||
| { | ||
| switch (operation) { | ||
| case QNetworkAccessManager::HeadOperation: | ||
| return QByteArrayLiteral("HEAD"); | ||
| case QNetworkAccessManager::GetOperation: | ||
| return QByteArrayLiteral("GET"); | ||
| case QNetworkAccessManager::PutOperation: | ||
| return QByteArrayLiteral("PUT"); | ||
| case QNetworkAccessManager::PostOperation: | ||
| return QByteArrayLiteral("POST"); | ||
| case QNetworkAccessManager::DeleteOperation: | ||
| return QByteArrayLiteral("DELETE"); | ||
| case QNetworkAccessManager::CustomOperation: | ||
| return request.attribute(QNetworkRequest::CustomVerbAttribute).toByteArray(); | ||
| case QNetworkAccessManager::UnknownOperation: | ||
| break; | ||
| } | ||
| Q_UNREACHABLE(); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| /* | ||
| * Copyright (C) by Hannah von Reth <hannah.vonreth@owncloud.com> | ||
| * | ||
| * 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) any later version. | ||
| * | ||
| * 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. | ||
| */ | ||
| #pragma once | ||
|
|
||
| #include "owncloudlib.h" | ||
|
|
||
| #include <QNetworkReply> | ||
| #include <QUrl> | ||
|
|
||
| namespace OCC { | ||
| namespace HttpLogger { | ||
| void OWNCLOUDSYNC_EXPORT logReplyOnFinished(const QNetworkReply *reply); | ||
| void OWNCLOUDSYNC_EXPORT logRequest(const QNetworkRequest &request, QNetworkAccessManager::Operation operation, QIODevice *device); | ||
|
|
||
| /** | ||
| * Helper to construct the HTTP verb used in the request | ||
| */ | ||
| QByteArray OWNCLOUDSYNC_EXPORT requestVerb(QNetworkAccessManager::Operation operation, const QNetworkRequest &request); | ||
| inline QByteArray requestVerb(const QNetworkReply &reply) | ||
| { | ||
| return requestVerb(reply.operation(), reply.request()); | ||
| } | ||
| } | ||
| } |