QGIS API Documentation 4.1.0-Master (ca2ac17535b)
Loading...
Searching...
No Matches
qgsbufferserverresponse.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsbufferserverresponse.cpp
3
4 Define response wrapper for buffer response
5 -------------------
6 begin : 2017-01-03
7 copyright : (C) 2017 by David Marteau
8 email : david dot marteau at 3liz dot com
9 ***************************************************************************/
10
11/***************************************************************************
12 * *
13 * This program is free software; you can redistribute it and/or modify *
14 * it under the terms of the GNU General Public License as published by *
15 * the Free Software Foundation; either version 2 of the License, or *
16 * (at your option) any later version. *
17 * *
18 ***************************************************************************/
19
21
22#include "qgsmessagelog.h"
23
24#include <QString>
25
26using namespace Qt::StringLiterals;
27
28//
29// QgsBufferServerResponse
30//
31
33{
34 mBuffer.open( QIODevice::ReadWrite );
35}
36
37void QgsBufferServerResponse::removeHeader( const QString &key )
38{
39 if ( !mHeadersSent )
40 mHeaders.remove( key );
41}
42
43void QgsBufferServerResponse::setHeader( const QString &key, const QString &value )
44{
45 if ( !mHeadersSent )
46 {
47 mHeaders[key] = QList<QString>() << value;
48 }
49}
50
51void QgsBufferServerResponse::addHeader( const QString &key, const QString &value )
52{
53 if ( !mHeadersSent )
54 {
55 if ( !mHeaders.contains( key ) )
56 {
57 mHeaders[key] = QList<QString>();
58 }
59 mHeaders[key].append( value );
60 }
61}
62
64{
65 mStatusCode = code;
66}
67
68QString QgsBufferServerResponse::header( const QString &key ) const
69{
70 const QList<QString> values = mHeaders.value( key );
71 return values.isEmpty() ? QString() : values.last();
72}
73
74QMap<QString, QString> QgsBufferServerResponse::headers() const
75{
76 QMap<QString, QString> singleHeaders;
77 for ( auto it = mHeaders.keyBegin(); it != mHeaders.keyEnd(); ++it )
78 {
79 singleHeaders.insert( *it, header( *it ) );
80 }
81 return singleHeaders;
82}
83
85{
86 return mHeadersSent;
87}
88
89void QgsBufferServerResponse::sendError( int code, const QString &message )
90{
91 if ( mHeadersSent )
92 {
93 QgsMessageLog::logMessage( "Cannot send error after headers sent" );
94 return;
95 }
96
97 clear();
98 setStatusCode( code );
99 setHeader( u"Content-Type"_s, u"text/plain; charset=utf-8"_s );
100 write( message );
101 finish();
102}
103
105{
106 return &mBuffer;
107}
108
110{
111 if ( mFinished )
112 {
113 QgsMessageLog::logMessage( "finish() called twice" );
114 return;
115 }
116
117 if ( !mHeadersSent )
118 {
119 if ( !mHeaders.contains( "Content-Length" ) )
120 {
121 mHeaders.insert( u"Content-Length"_s, QList<QString>() << QString::number( mBuffer.pos() ) );
122 }
123 }
124 flush();
125 mFinished = true;
126}
127
129{
130 if ( !mHeadersSent )
131 {
132 mHeadersSent = true;
133 }
134
135 mBuffer.seek( 0 );
136 QByteArray &ba = mBuffer.buffer();
137 mBody.append( ba );
138 ba.clear();
139}
140
141
143{
144 mHeaders.clear();
145 mBuffer.seek( 0 );
146 mBuffer.buffer().clear();
147}
148
149
151{
152 return mBuffer.data();
153}
154
155
157{
158 mBuffer.seek( 0 );
159 mBuffer.buffer().clear();
160}
161
162
163QList<QString> QgsBufferServerResponse::fullHeader( const QString &key ) const
164{
165 return mHeaders.value( key );
166}
Q_DECL_DEPRECATED QMap< QString, QString > headers() const override
Returns all the headers as a map: only the last value is returned if multiple values are set for the ...
void setStatusCode(int code) override
Set the http status code.
void flush() override
Flushes the current output buffer to the network.
virtual QList< QString > fullHeader(const QString &key) const override
Returns all the values for a header key.
Q_DECL_DEPRECATED QString header(const QString &key) const override
Returns a single header value, or an empty string if the header is not set.
QByteArray data() const override
Gets the data written so far.
void addHeader(const QString &key, const QString &value) override
Add a header value for the given key, without replacing any existing value for the same key Add Heade...
void finish() override
Finish the response, ending the transaction.
void sendError(int code, const QString &message) override
Send error This method delegates error handling at the server level.
void setHeader(const QString &key, const QString &value) override
Set Header entry Add Header entry to the response Note that it is usually an error to set Header afte...
void clear() override
Reset all headers and content for this response.
bool headersSent() const override
Returns true if the headers have already been sent.
void truncate() override
Truncate data.
void removeHeader(const QString &key) override
Clear header Undo a previous 'setHeader' call.
QIODevice * io() override
Returns the underlying QIODevice.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true, const char *file=__builtin_FILE(), const char *function=__builtin_FUNCTION(), int line=__builtin_LINE(), Qgis::StringFormat format=Qgis::StringFormat::PlainText)
Adds a message to the log instance (and creates it if necessary).
virtual void write(const QString &data)
Write string This is a convenient method that will write directly to the underlying I/O device.