-
Notifications
You must be signed in to change notification settings - Fork 344
/
httprequest.cpp
2403 lines (1951 loc) · 81.6 KB
/
httprequest.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//////////////////////////////////////////////////////////////////////////////
// Program Name: httprequest.cpp
// Created : Oct. 21, 2005
//
// Purpose : Http Request/Response
//
// Copyright (c) 2005 David Blain <dblain@mythtv.org>
//
// Licensed under the GPL v2 or later, see LICENSE for details
//
//////////////////////////////////////////////////////////////////////////////
#include "httprequest.h"
#include <QFile>
#include <QFileInfo>
#include <QHostInfo>
#include <QStringList>
#include <QCryptographicHash>
#include <QDateTime>
#include <Qt>
#include <cerrno>
#include <cstdlib>
#include <fcntl.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h> // for gethostname
// FOR DEBUGGING
#include <iostream>
#ifndef _WIN32
#include <netinet/tcp.h>
#endif
#include "upnp.h"
#include "libmythbase/compat.h"
#include "libmythbase/configuration.h"
#include "libmythbase/mythcorecontext.h"
#include "libmythbase/mythdate.h"
#include "libmythbase/mythlogging.h"
#include "libmythbase/mythtimer.h"
#include "libmythbase/mythversion.h"
#include "libmythbase/unziputil.h"
#include "serializers/xmlSerializer.h"
#include "serializers/soapSerializer.h"
#include "serializers/jsonSerializer.h"
#include "serializers/xmlplistSerializer.h"
#ifndef O_LARGEFILE
#define O_LARGEFILE 0
#endif
static std::array<const MIMETypes,66> g_MIMETypes
{{
// Image Mime Types
{ "gif" , "image/gif" },
{ "ico" , "image/x-icon" },
{ "jpeg", "image/jpeg" },
{ "jpg" , "image/jpeg" },
{ "mng" , "image/x-mng" },
{ "png" , "image/png" },
{ "svg" , "image/svg+xml" },
{ "svgz", "image/svg+xml" },
{ "tif" , "image/tiff" },
{ "tiff", "image/tiff" },
// Text Mime Types
{ "htm" , "text/html" },
{ "html", "text/html" },
{ "qsp" , "text/html" },
{ "txt" , "text/plain" },
{ "xml" , "text/xml" },
{ "qxml", "text/xml" },
{ "xslt", "text/xml" },
{ "css" , "text/css" },
// Application Mime Types
{ "crt" , "application/x-x509-ca-cert" },
{ "doc" , "application/vnd.ms-word" },
{ "gz" , "application/x-tar" },
{ "js" , "application/javascript" },
{ "m3u" , "application/x-mpegurl" }, // HTTP Live Streaming
{ "m3u8", "application/x-mpegurl" }, // HTTP Live Streaming
{ "ogx" , "application/ogg" }, // http://wiki.xiph.org/index.php/MIME_Types_and_File_Extensions
{ "pdf" , "application/pdf" },
{ "pem" , "application/x-x509-ca-cert" },
{ "qjs" , "application/javascript" },
{ "rm" , "application/vnd.rn-realmedia" },
{ "swf" , "application/x-shockwave-flash" },
{ "xls" , "application/vnd.ms-excel" },
{ "zip" , "application/x-tar" },
// Audio Mime Types:
{ "aac" , "audio/mp4" },
{ "ac3" , "audio/vnd.dolby.dd-raw" }, // DLNA?
{ "flac", "audio/x-flac" }, // This may become audio/flac in the future
{ "m4a" , "audio/x-m4a" },
{ "mid" , "audio/midi" },
{ "mka" , "audio/x-matroska" },
{ "mp3" , "audio/mpeg" },
{ "oga" , "audio/ogg" }, // Defined: http://wiki.xiph.org/index.php/MIME_Types_and_File_Extensions
{ "ogg" , "audio/ogg" }, // Defined: http://wiki.xiph.org/index.php/MIME_Types_and_File_Extensions
{ "wav" , "audio/wav" },
{ "wma" , "audio/x-ms-wma" },
// Video Mime Types
{ "3gp" , "video/3gpp" }, // Also audio/3gpp
{ "3g2" , "video/3gpp2" }, // Also audio/3gpp2
{ "asx" , "video/x-ms-asf" },
{ "asf" , "video/x-ms-asf" },
{ "avi" , "video/x-msvideo" }, // Also video/avi
{ "m2p" , "video/mp2p" }, // RFC 3555
{ "m4v" , "video/mp4" },
{ "mpeg", "video/mp2p" }, // RFC 3555
{ "mpeg2","video/mp2p" }, // RFC 3555
{ "mpg" , "video/mp2p" }, // RFC 3555
{ "mpg2", "video/mp2p" }, // RFC 3555
{ "mov" , "video/quicktime" },
{ "mp4" , "video/mp4" },
{ "mkv" , "video/x-matroska" }, // See http://matroska.org/technical/specs/notes.html#MIME (See NOTE 1)
{ "nuv" , "video/nupplevideo" },
{ "ogv" , "video/ogg" }, // Defined: http://wiki.xiph.org/index.php/MIME_Types_and_File_Extensions
{ "ps" , "video/mp2p" }, // RFC 3555
{ "ts" , "video/mp2t" }, // RFC 3555
{ "vob" , "video/mpeg" }, // Also video/dvd
{ "wmv" , "video/x-ms-wmv" },
// Font Mime Types
{ "ttf" , "font/ttf" },
{ "woff" , "font/woff" },
{ "woff2", "font/woff2" }
}};
// NOTE 1
// This formerly was video/x-matroska, but got changed due to #8643
// This was reverted from video/x-mkv, due to #10980
// See http://matroska.org/technical/specs/notes.html#MIME
// If you can't please everyone, may as well be correct as you piss some off
static QString StaticPage =
"<!DOCTYPE html>"
"<HTML>"
"<HEAD>"
"<TITLE>Error %1</TITLE>"
"<META HTTP-EQUIV=\"Content-Type\" CONTENT=\"text/html; charset=ISO-8859-1\">"
"</HEAD>"
"<BODY><H1>%2.</H1></BODY>"
"</HTML>";
const char *HTTPRequest::s_szServerHeaders = "Accept-Ranges: bytes\r\n";
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
QString HTTPRequest::GetLastHeader( const QString &sType ) const
{
QStringList values = m_mapHeaders.values( sType );
if (!values.isEmpty())
return values.last();
return {};
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
HttpRequestType HTTPRequest::SetRequestType( const QString &sType )
{
// HTTP
if (sType == "GET" ) return( m_eType = RequestTypeGet );
if (sType == "HEAD" ) return( m_eType = RequestTypeHead );
if (sType == "POST" ) return( m_eType = RequestTypePost );
if (sType == "OPTIONS" ) return( m_eType = RequestTypeOptions );
// UPnP
if (sType == "M-SEARCH" ) return( m_eType = RequestTypeMSearch );
if (sType == "NOTIFY" ) return( m_eType = RequestTypeNotify );
if (sType == "SUBSCRIBE" ) return( m_eType = RequestTypeSubscribe );
if (sType == "UNSUBSCRIBE") return( m_eType = RequestTypeUnsubscribe );
if (sType.startsWith( QString("HTTP/") )) return( m_eType = RequestTypeResponse );
LOG(VB_HTTP, LOG_INFO,
QString("HTTPRequest::SentRequestType( %1 ) - returning Unknown.")
.arg(sType));
return( m_eType = RequestTypeUnknown);
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
QString HTTPRequest::BuildResponseHeader( long long nSize )
{
QString sHeader;
QString sContentType = (m_eResponseType == ResponseTypeOther) ?
m_sResponseTypeText : GetResponseType();
//-----------------------------------------------------------------------
// Headers describing the connection
//-----------------------------------------------------------------------
// The protocol string
sHeader = QString( "%1 %2\r\n" ).arg(GetResponseProtocol(),
GetResponseStatus());
SetResponseHeader("Date", MythDate::toString(MythDate::current(), MythDate::kRFC822)); // RFC 822
SetResponseHeader("Server", HttpServer::GetServerVersion());
SetResponseHeader("Connection", m_bKeepAlive ? "Keep-Alive" : "Close" );
if (m_bKeepAlive)
{
if (m_nKeepAliveTimeout == 0s) // Value wasn't passed in by the server, so go with the configured value
m_nKeepAliveTimeout = gCoreContext->GetDurSetting<std::chrono::seconds>("HTTP/KeepAliveTimeoutSecs", 10s);
SetResponseHeader("Keep-Alive", QString("timeout=%1").arg(m_nKeepAliveTimeout.count()));
}
//-----------------------------------------------------------------------
// Entity Headers - Describe the content and allowed methods
// RFC 2616 Section 7.1
//-----------------------------------------------------------------------
if (m_eResponseType != ResponseTypeHeader) // No entity headers
{
SetResponseHeader("Content-Language", gCoreContext->GetLanguageAndVariant().replace("_", "-"));
SetResponseHeader("Content-Type", sContentType);
// Default to 'inline' but we should support 'attachment' when it would
// be appropriate i.e. not when streaming a file to a upnp player or browser
// that can support it natively
if (!m_sFileName.isEmpty())
{
// TODO: Add support for utf8 encoding - RFC 5987
QString filename = QFileInfo(m_sFileName).fileName(); // Strip any path
SetResponseHeader("Content-Disposition", QString("inline; filename=\"%2\"").arg(QString(filename.toLatin1())));
}
SetResponseHeader("Content-Length", QString::number(nSize));
// See DLNA 7.4.1.3.11.4.3 Tolerance to unavailable contentFeatures.dlna.org header
//
// It is better not to return this header, than to return it containing
// invalid or incomplete information. We are unable to currently determine
// this information at this stage, so do not return it. Only older devices
// look for it. Newer devices use the information provided in the UPnP
// response
// QString sValue = GetHeaderValue( "getContentFeatures.dlna.org", "0" );
//
// if (sValue == "1")
// sHeader += "contentFeatures.dlna.org: DLNA.ORG_OP=01;DLNA.ORG_CI=0;"
// "DLNA.ORG_FLAGS=01500000000000000000000000000000\r\n";
// DLNA 7.5.4.3.2.33 MT transfer mode indication
QString sTransferMode = GetRequestHeader( "transferMode.dlna.org", "" );
if (sTransferMode.isEmpty())
{
if (m_sResponseTypeText.startsWith("video/") ||
m_sResponseTypeText.startsWith("audio/"))
sTransferMode = "Streaming";
else
sTransferMode = "Interactive";
}
if (sTransferMode == "Streaming")
SetResponseHeader("transferMode.dlna.org", "Streaming");
else if (sTransferMode == "Background")
SetResponseHeader("transferMode.dlna.org", "Background");
else if (sTransferMode == "Interactive")
SetResponseHeader("transferMode.dlna.org", "Interactive");
// HACK Temporary hack for Samsung TVs - Needs to be moved later as it's not entirely DLNA compliant
if (!GetRequestHeader( "getcontentFeatures.dlna.org", "" ).isEmpty())
SetResponseHeader("contentFeatures.dlna.org", "DLNA.ORG_OP=01;DLNA.ORG_CI=0;DLNA.ORG_FLAGS=01500000000000000000000000000000");
}
auto values = m_mapHeaders.values("origin");
for (const auto & value : std::as_const(values))
AddCORSHeaders(value);
if (qEnvironmentVariableIsSet("HTTPREQUEST_DEBUG"))
{
// Dump response header
QMap<QString, QString>::iterator it;
for ( it = m_mapRespHeaders.begin(); it != m_mapRespHeaders.end(); ++it )
{
LOG(VB_HTTP, LOG_INFO, QString("(Response Header) %1: %2").arg(it.key(), it.value()));
}
}
sHeader += GetResponseHeaders();
sHeader += "\r\n";
return sHeader;
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
qint64 HTTPRequest::SendResponse( void )
{
qint64 nBytes = 0;
switch( m_eResponseType )
{
// The following are all eligable for gzip compression
case ResponseTypeUnknown:
case ResponseTypeNone:
LOG(VB_HTTP, LOG_INFO,
QString("HTTPRequest::SendResponse( None ) :%1 -> %2:")
.arg(GetResponseStatus(), GetPeerAddress()));
return( -1 );
case ResponseTypeJS:
case ResponseTypeCSS:
case ResponseTypeText:
case ResponseTypeSVG:
case ResponseTypeXML:
case ResponseTypeHTML:
// If the reponse isn't already in the buffer, then load it
if (m_sFileName.isEmpty() || !m_response.buffer().isEmpty())
break;
{
QFile file(m_sFileName);
if (file.exists() && file.size() < (2LL * 1024 * 1024) && // For security/stability, limit size of files read into buffer to 2MiB
file.open(QIODevice::ReadOnly | QIODevice::Text))
m_response.buffer() = file.readAll();
if (!m_response.buffer().isEmpty())
break;
// Let SendResponseFile try or send a 404
m_eResponseType = ResponseTypeFile;
}
[[fallthrough]];
case ResponseTypeFile: // Binary files
LOG(VB_HTTP, LOG_INFO,
QString("HTTPRequest::SendResponse( File ) :%1 -> %2:")
.arg(GetResponseStatus(), GetPeerAddress()));
return( SendResponseFile( m_sFileName ));
case ResponseTypeOther:
case ResponseTypeHeader:
default:
break;
}
LOG(VB_HTTP, LOG_INFO,
QString("HTTPRequest::SendResponse(xml/html) (%1) :%2 -> %3: %4")
.arg(m_sFileName, GetResponseStatus(), GetPeerAddress(),
QString::number(m_eResponseType)));
// ----------------------------------------------------------------------
// Check for ETag match...
// ----------------------------------------------------------------------
QString sETag = GetRequestHeader( "If-None-Match", "" );
if ( !sETag.isEmpty() && sETag == m_mapRespHeaders[ "ETag" ] )
{
LOG(VB_HTTP, LOG_INFO,
QString("HTTPRequest::SendResponse(%1) - Cached")
.arg(sETag));
m_nResponseStatus = 304;
m_eResponseType = ResponseTypeHeader; // No entity headers
// no content can be returned.
m_response.buffer().clear();
}
// ----------------------------------------------------------------------
int nContentLen = m_response.buffer().length();
QBuffer *pBuffer = &m_response;
// ----------------------------------------------------------------------
// DEBUGGING
if (qEnvironmentVariableIsSet("HTTPREQUEST_DEBUG"))
std::cout << m_response.buffer().constData() << std::endl;
// ----------------------------------------------------------------------
LOG(VB_HTTP, LOG_DEBUG, QString("Reponse Content Length: %1").arg(nContentLen));
// ----------------------------------------------------------------------
// Should we try to return data gzip'd?
// ----------------------------------------------------------------------
QBuffer compBuffer;
auto values = m_mapHeaders.values("accept-encoding");
bool gzip_found = std::any_of(values.cbegin(), values.cend(),
[](const auto & value)
{return value.contains( "gzip" ); });
if (( nContentLen > 0 ) && gzip_found)
{
QByteArray compressed = gzipCompress( m_response.buffer() );
compBuffer.setData( compressed );
if (!compBuffer.buffer().isEmpty())
{
pBuffer = &compBuffer;
SetResponseHeader( "Content-Encoding", "gzip" );
LOG(VB_HTTP, LOG_DEBUG, QString("Reponse Compressed Content Length: %1").arg(compBuffer.buffer().length()));
}
}
// ----------------------------------------------------------------------
// Write out Header.
// ----------------------------------------------------------------------
nContentLen = pBuffer->buffer().length();
QString rHeader = BuildResponseHeader( nContentLen );
QByteArray sHeader = rHeader.toUtf8();
LOG(VB_HTTP, LOG_DEBUG, QString("Response header size: %1 bytes").arg(sHeader.length()));
nBytes = WriteBlock( sHeader.constData(), sHeader.length() );
if (nBytes < sHeader.length())
{
LOG( VB_HTTP, LOG_ERR, QString("HttpRequest::SendResponse(): "
"Incomplete write of header, "
"%1 written of %2")
.arg(nBytes).arg(sHeader.length()));
}
// ----------------------------------------------------------------------
// Write out Response buffer.
// ----------------------------------------------------------------------
if (( m_eType != RequestTypeHead ) &&
( nContentLen > 0 ))
{
qint64 bytesWritten = SendData( pBuffer, 0, nContentLen );
//qint64 bytesWritten = WriteBlock( pBuffer->buffer(), pBuffer->buffer().length() );
if (bytesWritten != nContentLen)
LOG(VB_HTTP, LOG_ERR, "HttpRequest::SendResponse(): Error occurred while writing response body.");
else
nBytes += bytesWritten;
}
return( nBytes );
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
qint64 HTTPRequest::SendResponseFile( const QString& sFileName )
{
qint64 nBytes = 0;
long long llSize = 0;
long long llStart = 0;
long long llEnd = 0;
LOG(VB_HTTP, LOG_INFO, QString("SendResponseFile ( %1 )").arg(sFileName));
m_eResponseType = ResponseTypeOther;
m_sResponseTypeText = "text/plain";
QFile tmpFile( sFileName );
if (tmpFile.exists( ) && tmpFile.open( QIODevice::ReadOnly ))
{
m_sResponseTypeText = TestMimeType( sFileName );
// ------------------------------------------------------------------
// Get File size
// ------------------------------------------------------------------
llSize = llEnd = tmpFile.size( );
m_nResponseStatus = 200;
// ------------------------------------------------------------------
// Process any Range Header
// ------------------------------------------------------------------
bool bRange = false;
QString sRange = GetRequestHeader( "range", "" );
if (!sRange.isEmpty())
{
bRange = ParseRange( sRange, llSize, &llStart, &llEnd );
// Adjust ranges that are too long.
if (llEnd >= llSize)
llEnd = llSize-1;
if ((llSize > llStart) && (llSize > llEnd) && (llEnd > llStart))
{
if (bRange)
{
m_nResponseStatus = 206;
m_mapRespHeaders[ "Content-Range" ] = QString("bytes %1-%2/%3")
.arg( llStart )
.arg( llEnd )
.arg( llSize );
llSize = (llEnd - llStart) + 1;
}
}
else
{
m_nResponseStatus = 416;
// RFC 7233 - A server generating a 416 (Range Not Satisfiable)
// response to a byte-range request SHOULD send a Content-Range
// header field with an unsatisfied-range value
m_mapRespHeaders[ "Content-Range" ] = QString("bytes */%3")
.arg( llSize );
llSize = 0;
LOG(VB_HTTP, LOG_INFO,
QString("HTTPRequest::SendResponseFile(%1) - "
"invalid byte range %2-%3/%4")
.arg(sFileName) .arg(llStart) .arg(llEnd)
.arg(llSize));
}
}
// HACK: D-Link DSM-320
// The following headers are only required by servers which don't support
// http keep alive. We do support it, so we don't need it. Keeping it in
// place to prevent someone re-adding it in future
//m_mapRespHeaders[ "X-User-Agent" ] = "redsonic";
// ------------------------------------------------------------------
//
// ------------------------------------------------------------------
}
else
{
LOG(VB_HTTP, LOG_INFO,
QString("HTTPRequest::SendResponseFile(%1) - cannot find file!")
.arg(sFileName));
m_nResponseStatus = 404;
m_response.write( GetResponsePage() );
}
// -=>TODO: Should set "Content-Length: *" if file is still recording
// ----------------------------------------------------------------------
// Write out Header.
// ----------------------------------------------------------------------
QString rHeader = BuildResponseHeader( llSize );
QByteArray sHeader = rHeader.toUtf8();
LOG(VB_HTTP, LOG_DEBUG, QString("Response header size: %1 bytes").arg(sHeader.length()));
nBytes = WriteBlock( sHeader.constData(), sHeader.length() );
if (nBytes < sHeader.length())
{
LOG( VB_HTTP, LOG_ERR, QString("HttpRequest::SendResponseFile(): "
"Incomplete write of header, "
"%1 written of %2")
.arg(nBytes).arg(sHeader.length()));
}
// ----------------------------------------------------------------------
// Write out File.
// ----------------------------------------------------------------------
#if 0
LOG(VB_HTTP, LOG_DEBUG,
QString("SendResponseFile : size = %1, start = %2, end = %3")
.arg(llSize).arg(llStart).arg(llEnd));
#endif
if (( m_eType != RequestTypeHead ) && (llSize != 0))
{
long long sent = SendFile( tmpFile, llStart, llSize );
if (sent == -1)
{
LOG(VB_HTTP, LOG_INFO,
QString("SendResponseFile( %1 ) Error: %2 [%3]" )
.arg(sFileName) .arg(errno) .arg(strerror(errno)));
nBytes = -1;
}
}
// -=>TODO: Only returns header length...
// should we change to return total bytes?
return nBytes;
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
static constexpr size_t SENDFILE_BUFFER_SIZE { 65536 };
qint64 HTTPRequest::SendData( QIODevice *pDevice, qint64 llStart, qint64 llBytes )
{
bool bShouldClose = false;
qint64 sent = 0;
if (!pDevice->isOpen())
{
pDevice->open( QIODevice::ReadOnly );
bShouldClose = true;
}
// ----------------------------------------------------------------------
// Set out file position to requested start location.
// ----------------------------------------------------------------------
if ( !pDevice->seek( llStart ))
return -1;
std::array<char,SENDFILE_BUFFER_SIZE> aBuffer {};
qint64 llBytesRemaining = llBytes;
qint64 llBytesToRead = 0;
qint64 llBytesRead = 0;
while ((sent < llBytes) && !pDevice->atEnd())
{
llBytesToRead = std::min( (qint64)SENDFILE_BUFFER_SIZE, llBytesRemaining );
llBytesRead = pDevice->read( aBuffer.data(), llBytesToRead );
if ( llBytesRead != -1 )
{
if ( WriteBlock( aBuffer.data(), llBytesRead ) == -1)
return -1;
// -=>TODO: We don't handle the situation where we read more than was sent.
sent += llBytesRead;
llBytesRemaining -= llBytesRead;
}
}
if (bShouldClose)
pDevice->close();
return sent;
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
qint64 HTTPRequest::SendFile( QFile &file, qint64 llStart, qint64 llBytes )
{
qint64 sent = SendData( (QIODevice *)(&file), llStart, llBytes );
return( sent );
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
void HTTPRequest::FormatErrorResponse( bool bServerError,
const QString &sFaultString,
const QString &sDetails )
{
m_eResponseType = ResponseTypeXML;
m_nResponseStatus = 500;
QTextStream stream( &m_response );
stream << R"(<?xml version="1.0" encoding="utf-8"?>)";
QString sWhere = ( bServerError ) ? "s:Server" : "s:Client";
if (m_bSOAPRequest)
{
m_mapRespHeaders[ "EXT" ] = "";
stream << SOAP_ENVELOPE_BEGIN
<< "<s:Fault>"
<< "<faultcode>" << sWhere << "</faultcode>"
<< "<faultstring>" << sFaultString << "</faultstring>";
}
if (!sDetails.isEmpty())
{
stream << "<detail>" << sDetails << "</detail>";
}
if (m_bSOAPRequest)
{
stream << "</s:Fault>" << SOAP_ENVELOPE_END;
}
stream.flush();
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
void HTTPRequest::FormatActionResponse( Serializer *pSer )
{
m_eResponseType = ResponseTypeOther;
m_sResponseTypeText = pSer->GetContentType();
m_nResponseStatus = 200;
pSer->AddHeaders( m_mapRespHeaders );
//m_response << pFormatter->ToString();
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
void HTTPRequest::FormatActionResponse(const NameValues &args)
{
m_eResponseType = ResponseTypeXML;
m_nResponseStatus = 200;
QTextStream stream( &m_response );
stream << "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n";
if (m_bSOAPRequest)
{
m_mapRespHeaders[ "EXT" ] = "";
stream << SOAP_ENVELOPE_BEGIN
<< "<u:" << m_sMethod << "Response xmlns:u=\""
<< m_sNameSpace << "\">\r\n";
}
else
stream << "<" << m_sMethod << "Response>\r\n";
for (const auto & arg : std::as_const(args))
{
stream << "<" << arg.m_sName;
if (arg.m_pAttributes)
{
for (const auto & attr : std::as_const(*arg.m_pAttributes))
{
stream << " " << attr.m_sName << "='"
<< Encode( attr.m_sValue ) << "'";
}
}
stream << ">";
if (m_bSOAPRequest)
stream << Encode( arg.m_sValue );
else
stream << arg.m_sValue;
stream << "</" << arg.m_sName << ">\r\n";
}
if (m_bSOAPRequest)
{
stream << "</u:" << m_sMethod << "Response>\r\n"
<< SOAP_ENVELOPE_END;
}
else
stream << "</" << m_sMethod << "Response>\r\n";
stream.flush();
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
void HTTPRequest::FormatRawResponse(const QString &sXML)
{
m_eResponseType = ResponseTypeXML;
m_nResponseStatus = 200;
QTextStream stream( &m_response );
stream << sXML;
stream.flush();
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
void HTTPRequest::FormatFileResponse( const QString &sFileName )
{
m_sFileName = sFileName;
QFileInfo file(m_sFileName);
if (!m_sFileName.isEmpty() && file.exists())
{
QDateTime ims = QDateTime::fromString(GetRequestHeader("if-modified-since", ""), Qt::RFC2822Date);
ims.setTimeSpec(Qt::OffsetFromUTC);
if (ims.isValid() && ims <= file.lastModified()) // Strong validator
{
m_eResponseType = ResponseTypeHeader;
m_nResponseStatus = 304; // Not Modified
}
else
{
if (m_eResponseType == ResponseTypeUnknown)
m_eResponseType = ResponseTypeFile;
m_nResponseStatus = 200; // OK
SetResponseHeader("Last-Modified", MythDate::toString(file.lastModified(),
(MythDate::kOverrideUTC |
MythDate::kRFC822))); // RFC 822
SetResponseHeader("Cache-Control", "no-cache=\"Ext\", max-age = 7200"); // 2 Hours
}
}
else
{
m_eResponseType = ResponseTypeHTML;
m_nResponseStatus = 404; // Resource not found
m_response.write( GetResponsePage() );
LOG(VB_HTTP, LOG_INFO,
QString("HTTPRequest::FormatFileResponse('%1') - cannot find file")
.arg(sFileName));
}
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
void HTTPRequest::SetRequestProtocol( const QString &sLine )
{
m_sProtocol = sLine.section( '/', 0, 0 ).trimmed();
QString sVersion = sLine.section( '/', 1 ).trimmed();
m_nMajor = sVersion.section( '.', 0, 0 ).toInt();
m_nMinor = sVersion.section( '.', 1 ).toInt();
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
QString HTTPRequest::GetRequestProtocol() const
{
return QString("%1/%2.%3").arg(m_sProtocol,
QString::number(m_nMajor),
QString::number(m_nMinor));
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
QString HTTPRequest::GetResponseProtocol()
{
// RFC 2145
//
// An HTTP server SHOULD send a response version equal to the highest
// version for which the server is at least conditionally compliant, and
// whose major version is less than or equal to the one received in the
// request.
// if (m_nMajor == 1)
// QString("HTTP/1.1");
// else if (m_nMajor == 2)
// QString("HTTP/2.0");
return {"HTTP/1.1"};
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
HttpContentType HTTPRequest::SetContentType( const QString &sType )
{
if ((sType == "application/x-www-form-urlencoded" ) ||
(sType.startsWith("application/x-www-form-urlencoded;")))
return( m_eContentType = ContentType_Urlencoded );
if ((sType == "text/xml" ) ||
(sType.startsWith("text/xml;") ))
return( m_eContentType = ContentType_XML );
if ((sType == "application/json") ||
sType.startsWith("application/json;"))
return( m_eContentType = ContentType_JSON);
return( m_eContentType = ContentType_Unknown );
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
QString HTTPRequest::GetResponseStatus( void ) const
{
switch( m_nResponseStatus )
{
case 200: return( "200 OK" );
case 201: return( "201 Created" );
case 202: return( "202 Accepted" );
case 204: return( "204 No Content" );
case 205: return( "205 Reset Content" );
case 206: return( "206 Partial Content" );
case 300: return( "300 Multiple Choices" );
case 301: return( "301 Moved Permanently" );
case 302: return( "302 Found" );
case 303: return( "303 See Other" );
case 304: return( "304 Not Modified" );
case 305: return( "305 Use Proxy" );
case 307: return( "307 Temporary Redirect" );
case 308: return( "308 Permanent Redirect" );
case 400: return( "400 Bad Request" );
case 401: return( "401 Unauthorized" );
case 403: return( "403 Forbidden" );
case 404: return( "404 Not Found" );
case 405: return( "405 Method Not Allowed" );
case 406: return( "406 Not Acceptable" );
case 408: return( "408 Request Timeout" );
case 410: return( "410 Gone" );
case 411: return( "411 Length Required" );
case 412: return( "412 Precondition Failed" );
case 413: return( "413 Request Entity Too Large" );
case 414: return( "414 Request-URI Too Long" );
case 415: return( "415 Unsupported Media Type" );
case 416: return( "416 Requested Range Not Satisfiable" );
case 417: return( "417 Expectation Failed" );
// I'm a teapot
case 428: return( "428 Precondition Required" ); // RFC 6585
case 429: return( "429 Too Many Requests" ); // RFC 6585
case 431: return( "431 Request Header Fields Too Large" ); // RFC 6585
case 500: return( "500 Internal Server Error" );
case 501: return( "501 Not Implemented" );
case 502: return( "502 Bad Gateway" );
case 503: return( "503 Service Unavailable" );
case 504: return( "504 Gateway Timeout" );
case 505: return( "505 HTTP Version Not Supported" );
case 510: return( "510 Not Extended" );
case 511: return( "511 Network Authentication Required" ); // RFC 6585
}
return( QString( "%1 Unknown" ).arg( m_nResponseStatus ));
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
QByteArray HTTPRequest::GetResponsePage( void )
{
return StaticPage.arg(QString::number(m_nResponseStatus), GetResponseStatus()).toUtf8();
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
QString HTTPRequest::GetResponseType( void ) const
{
switch( m_eResponseType )
{
case ResponseTypeXML : return( "text/xml; charset=\"UTF-8\"" );
case ResponseTypeHTML : return( "text/html; charset=\"UTF-8\"" );
case ResponseTypeCSS : return( "text/css; charset=\"UTF-8\"" );
case ResponseTypeJS : return( "application/javascript" );
case ResponseTypeText : return( "text/plain; charset=\"UTF-8\"" );
case ResponseTypeSVG : return( "image/svg+xml" );
default: break;
}
return( "text/plain" );
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
QString HTTPRequest::GetMimeType( const QString &sFileExtension )
{
QString ext;
for (const auto & type : g_MIMETypes)
{
ext = type.pszExtension;
if ( sFileExtension.compare(ext, Qt::CaseInsensitive) == 0 )
return( type.pszType );
}
return( "text/plain" );
}
/////////////////////////////////////////////////////////////////////////////
//
/////////////////////////////////////////////////////////////////////////////
QStringList HTTPRequest::GetSupportedMimeTypes()
{
QStringList mimeTypes;