From 30d82b7f63c9dccc2b6655e6b0bfe5e0dd92f661 Mon Sep 17 00:00:00 2001 From: Bardia Daneshvar Date: Fri, 16 Feb 2018 11:16:19 +0330 Subject: [PATCH 1/3] Add support for make install command --- src/qmake/headerinstall.pri | 10 ++++++++++ src/src.pro | 11 +++++++++++ 2 files changed, 21 insertions(+) create mode 100644 src/qmake/headerinstall.pri diff --git a/src/qmake/headerinstall.pri b/src/qmake/headerinstall.pri new file mode 100644 index 0000000..802faca --- /dev/null +++ b/src/qmake/headerinstall.pri @@ -0,0 +1,10 @@ + +basePath = $${dirname(PWD)} +for(header, INSTALL_HEADERS) { + relPath = $${relative_path($$header, $$basePath)} + path = $${INSTALL_PREFIX}/$${dirname(relPath)} + eval(headers_$${path}.files += $$relPath) + eval(headers_$${path}.path = $$path) + eval(INSTALLS *= headers_$${path}) +} + diff --git a/src/src.pro b/src/src.pro index ac9177c..6e0c26e 100644 --- a/src/src.pro +++ b/src/src.pro @@ -40,3 +40,14 @@ contains(DEFINES, QHTTP_HAS_CLIENT) { qhttpclientresponse.hpp \ qhttpclientrequest.hpp } + +!contains(CONFIG, no_install) { + INSTALL_PREFIX = $$[QT_INSTALL_HEADERS]/qhttp + INSTALL_HEADERS = $$HEADERS + include(qmake/headerinstall.pri) + + target = $$TARGET + target.path = $$[QT_INSTALL_LIBS] + + INSTALLS += target +} From 584e76f204242be2a8f4b31c5ee85ce3b6031997 Mon Sep 17 00:00:00 2001 From: Bardia Daneshvar Date: Sat, 7 Jul 2018 15:14:17 +0430 Subject: [PATCH 2/3] Port it to the QtModule Remove Client classes --- .qmake.conf | 3 + LICENSE | 175 ++++++++++- README.md | 80 +---- commondir.pri | 29 -- example/example.pro | 10 - examples/examples.pro | 3 + .../http}/basic-server/README.md | 0 .../http}/basic-server/basic-server.pro | 0 .../http}/basic-server/main.cpp | 0 .../http}/helloworld/README.md | 0 .../http}/helloworld/helloworld.pro | 0 .../http}/helloworld/main.cpp | 0 examples/http/http.pro | 1 + .../http}/include/ticktock.hxx | 0 .../http}/include/unixcatcher.hpp | 0 .../http}/keep-alive/README.md | 0 .../http}/keep-alive/keep-alive.pro | 0 .../http}/keep-alive/main.cpp | 0 .../http}/postcollector/README.md | 0 .../http}/postcollector/main.cpp | 0 .../http}/postcollector/postcollector.pro | 0 modules/qt_http.pri | 14 + qhttp.pro | 7 +- src/http/http.pro | 35 +++ src/{ => http}/private/httpparser.hxx | 2 +- src/{ => http}/private/httpreader.hxx | 2 +- src/{ => http}/private/httpwriter.hxx | 2 +- .../private/qhttpbase.h} | 4 +- .../private/qhttpserver_private.h} | 8 +- .../private/qhttpserverconnection_private.h} | 10 +- .../private/qhttpserverrequest_private.h} | 4 +- .../private/qhttpserverresponse_private.h} | 6 +- .../qsocket.hpp => http/private/qsocket.h} | 2 +- src/{ => http}/qhttpabstracts.cpp | 2 +- .../qhttpabstracts.h} | 8 +- src/{qhttpfwd.hpp => http/qhttpfwd.h} | 23 +- src/{ => http}/qhttpserver.cpp | 2 +- src/{qhttpserver.hpp => http/qhttpserver.h} | 4 +- src/{ => http}/qhttpserverconnection.cpp | 2 +- .../qhttpserverconnection.h} | 4 +- src/{ => http}/qhttpserverrequest.cpp | 2 +- .../qhttpserverrequest.h} | 4 +- src/{ => http}/qhttpserverresponse.cpp | 2 +- .../qhttpserverresponse.h} | 4 +- src/private/qhttpclient_private.hpp | 196 ------------ src/private/qhttpclientrequest_private.hpp | 57 ---- src/private/qhttpclientresponse_private.hpp | 51 ---- src/qhttpclient.cpp | 284 ------------------ src/qhttpclient.hpp | 182 ----------- src/qhttpclientrequest.cpp | 98 ------ src/qhttpclientrequest.hpp | 67 ----- src/qhttpclientresponse.cpp | 66 ---- src/qhttpclientresponse.hpp | 78 ----- src/qmake/headerinstall.pri | 10 - src/src.pro | 55 +--- sync.profile | 18 ++ tests/auto/auto.pro | 3 + tests/auto/cmake/cmake.pro | 3 + tests/tests.pro | 2 + update-dependencies.sh | 17 -- utils.sh | 61 ---- 61 files changed, 290 insertions(+), 1412 deletions(-) create mode 100644 .qmake.conf delete mode 100755 commondir.pri delete mode 100644 example/example.pro create mode 100644 examples/examples.pro rename {example => examples/http}/basic-server/README.md (100%) rename {example => examples/http}/basic-server/basic-server.pro (100%) rename {example => examples/http}/basic-server/main.cpp (100%) rename {example => examples/http}/helloworld/README.md (100%) rename {example => examples/http}/helloworld/helloworld.pro (100%) rename {example => examples/http}/helloworld/main.cpp (100%) create mode 100644 examples/http/http.pro rename {example => examples/http}/include/ticktock.hxx (100%) rename {example => examples/http}/include/unixcatcher.hpp (100%) rename {example => examples/http}/keep-alive/README.md (100%) rename {example => examples/http}/keep-alive/keep-alive.pro (100%) rename {example => examples/http}/keep-alive/main.cpp (100%) rename {example => examples/http}/postcollector/README.md (100%) rename {example => examples/http}/postcollector/main.cpp (100%) rename {example => examples/http}/postcollector/postcollector.pro (100%) create mode 100644 modules/qt_http.pri create mode 100644 src/http/http.pro rename src/{ => http}/private/httpparser.hxx (99%) rename src/{ => http}/private/httpreader.hxx (98%) rename src/{ => http}/private/httpwriter.hxx (99%) rename src/{private/qhttpbase.hpp => http/private/qhttpbase.h} (96%) rename src/{private/qhttpserver_private.hpp => http/private/qhttpserver_private.h} (94%) rename src/{private/qhttpserverconnection_private.hpp => http/private/qhttpserverconnection_private.h} (96%) rename src/{private/qhttpserverrequest_private.hpp => http/private/qhttpserverrequest_private.h} (94%) rename src/{private/qhttpserverresponse_private.hpp => http/private/qhttpserverresponse_private.h} (94%) rename src/{private/qsocket.hpp => http/private/qsocket.h} (99%) rename src/{ => http}/qhttpabstracts.cpp (99%) rename src/{qhttpabstracts.hpp => http/qhttpabstracts.h} (97%) rename src/{qhttpfwd.hpp => http/qhttpfwd.h} (92%) rename src/{ => http}/qhttpserver.cpp (98%) rename src/{qhttpserver.hpp => http/qhttpserver.h} (98%) rename src/{ => http}/qhttpserverconnection.cpp (99%) rename src/{qhttpserverconnection.hpp => http/qhttpserverconnection.h} (97%) rename src/{ => http}/qhttpserverrequest.cpp (97%) rename src/{qhttpserverrequest.hpp => http/qhttpserverrequest.h} (96%) rename src/{ => http}/qhttpserverresponse.cpp (97%) rename src/{qhttpserverresponse.hpp => http/qhttpserverresponse.h} (95%) delete mode 100644 src/private/qhttpclient_private.hpp delete mode 100644 src/private/qhttpclientrequest_private.hpp delete mode 100644 src/private/qhttpclientresponse_private.hpp delete mode 100644 src/qhttpclient.cpp delete mode 100644 src/qhttpclient.hpp delete mode 100644 src/qhttpclientrequest.cpp delete mode 100644 src/qhttpclientrequest.hpp delete mode 100644 src/qhttpclientresponse.cpp delete mode 100644 src/qhttpclientresponse.hpp delete mode 100644 src/qmake/headerinstall.pri create mode 100644 sync.profile create mode 100644 tests/auto/auto.pro create mode 100644 tests/auto/cmake/cmake.pro create mode 100644 tests/tests.pro delete mode 100755 update-dependencies.sh delete mode 100755 utils.sh diff --git a/.qmake.conf b/.qmake.conf new file mode 100644 index 0000000..6fa4086 --- /dev/null +++ b/.qmake.conf @@ -0,0 +1,3 @@ +load(qt_build_config) + +MODULE_VERSION = 5.0.0 diff --git a/LICENSE b/LICENSE index a7d9ae4..65c5ca8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,22 +1,165 @@ -The MIT License (MIT) + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -Copyright (c) 2014 Amir Zamani + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + 0. Additional Definitions. + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/README.md b/README.md index 79803eb..aefa01f 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ - [Features](#features) - [Setup](#setup) - [Multi-threading](#multi-threading) -- [Source tree](#source-tree) - [Disclaimer](#disclaimer) - [License](#license) @@ -66,46 +65,6 @@ int main(int argc, char** argv) { } ``` -to request weather information by **HTTP client**: -```cpp -int main(int argc, char** argv) { - QCoreApplication app(argc, argv); - - using namespace qhttp::client; - QHttpClient client(&app); - QUrl weatherUrl("http://wttr.in/tehran"); - - client.request(qhttp::EHTTP_GET, weatherUrl, [](QHttpResponse* res) { - // response handler, called when the incoming HTTP headers are ready - - // gather HTTP response data (HTTP body) - res->collectData(); - - // when all data in HTTP response have been read: - res->onEnd([&]() { - writeTo("weather.html", res->collectedData()); - - // done! now quit the application - qApp->quit(); - }); - - // just for fun! print incoming headers: - qDebug("\n[Headers:]"); - res->headers().forEach([](auto cit) { - qDebug("%s : %s", cit.key().constData(), cit.value().constData()); - }); - }); - - // set a timeout for the http connection - client.setConnectingTimeOut(10000, []{ - qDebug("connecting to HTTP server timed out!"); - qApp->quit(); - }); - - return app.exec(); -} -``` - ## Features [TOC](#table-of-contents) @@ -148,18 +107,19 @@ int main(int argc, char** argv) { instructions: ```bash # first clone this repository: -$> git clone https://github.com/azadkuh/qhttp.git +$> git clone https://github.com/Aseman-Land/qhttp.git $> cd qhttp -# prepare dependencies: -$qhttp/> ./update-dependencies.sh - # now build the library and the examples $qhttp/> qmake -r qhttp.pro -$qhttp/> make -j 8 +$qhttp/> make +$qhttp/> make install ``` +And add it using ```Qt += http``` to your project :) + ## Multi-threading + [TOC](#table-of-contents) As `QHttp` is **asynchronous** and **non-blocking**, your app can handle @@ -176,34 +136,6 @@ in some rare scenarios you may want to use multiple handler threads (although other handler threads. -## Source tree -[TOC](#table-of-contents) - - -- **`src/`**: holds the source code of `QHttp`. server classes are prefixed by -`qhttpserver*` and client classes by `qhttpclient*`. - - **`private/`**: Private classes of the library. -- **`3rdparty/`**: will contain `http-parser` source tree as the only -dependency. this directory is created by setup. see also: [setup](#setup). -- **`example/`**: contains some sample applications representing the `QHttp` -usage: - - **`helloworld/`**: the HelloWorld example of `QHttp`, both server + client - are represented. see: [README@helloworld](./example/helloworld/README.md) - - **`basic-server/`**: a basic HTTP server shows how to collect the request - body, and respond to the clients. see: - [README@basic-server](./example/basic-server/README.md) - - **`keep-alive`**: shows how to keep an http connection open and - transmitting many requests/responses. see: - [README@keep-alive](./example/keep-alive/README.md) - - **`post-collector`**: another server example shows how to collect large - data by POST requests. see: - [README@post-collector](./example/postcollector/README.md) -- **`tmp/`**: a temporary directory which is created while `make`ing the -library and holds all the `.o`, `moc files`, etc. -* **`xbin/`**: all the executable and libraries will be placed on this folder by -build system. - - ## Disclaimer [TOC](#table-of-contents) diff --git a/commondir.pri b/commondir.pri deleted file mode 100755 index b896c8e..0000000 --- a/commondir.pri +++ /dev/null @@ -1,29 +0,0 @@ -# specifying common dirs - -# comment following line to build the lib as static library -DEFINES *= QHTTP_DYNAMIC_LIB -# comment following line to trim client classes from build -DEFINES *= QHTTP_HAS_CLIENT -# Qt5.5.1 on OSX needs both c++11 and c++14!! the c++14 is not enough -CONFIG += c++11 c++14 - -unix { - TEMPDIR = $$PRJDIR/tmp/unix/$$TARGET - macx:TEMPDIR = $$PRJDIR/tmp/osx/$$TARGET -} - -win32 { - TEMPDIR = $$PRJDIR/tmp/win32/$$TARGET - DEFINES += _WINDOWS WIN32_LEAN_AND_MEAN NOMINMAX -} - - -DESTDIR = $$PRJDIR/xbin -MOC_DIR = $$TEMPDIR -OBJECTS_DIR = $$TEMPDIR -RCC_DIR = $$TEMPDIR -UI_DIR = $$TEMPDIR/Ui -LIBS += -L$$PRJDIR/xbin - -INCLUDEPATH += . $$PRJDIR/src $$PRJDIR/3rdparty - diff --git a/example/example.pro b/example/example.pro deleted file mode 100644 index 3530640..0000000 --- a/example/example.pro +++ /dev/null @@ -1,10 +0,0 @@ -TEMPLATE = subdirs - -SUBDIRS += helloworld -SUBDIRS += postcollector -SUBDIRS += basic-server - -contains(DEFINES, QHTTP_HAS_CLIENT) { - SUBDIRS += keep-alive -} - diff --git a/examples/examples.pro b/examples/examples.pro new file mode 100644 index 0000000..7f10809 --- /dev/null +++ b/examples/examples.pro @@ -0,0 +1,3 @@ +TEMPLATE = subdirs +SUBDIRS = http + diff --git a/example/basic-server/README.md b/examples/http/basic-server/README.md similarity index 100% rename from example/basic-server/README.md rename to examples/http/basic-server/README.md diff --git a/example/basic-server/basic-server.pro b/examples/http/basic-server/basic-server.pro similarity index 100% rename from example/basic-server/basic-server.pro rename to examples/http/basic-server/basic-server.pro diff --git a/example/basic-server/main.cpp b/examples/http/basic-server/main.cpp similarity index 100% rename from example/basic-server/main.cpp rename to examples/http/basic-server/main.cpp diff --git a/example/helloworld/README.md b/examples/http/helloworld/README.md similarity index 100% rename from example/helloworld/README.md rename to examples/http/helloworld/README.md diff --git a/example/helloworld/helloworld.pro b/examples/http/helloworld/helloworld.pro similarity index 100% rename from example/helloworld/helloworld.pro rename to examples/http/helloworld/helloworld.pro diff --git a/example/helloworld/main.cpp b/examples/http/helloworld/main.cpp similarity index 100% rename from example/helloworld/main.cpp rename to examples/http/helloworld/main.cpp diff --git a/examples/http/http.pro b/examples/http/http.pro new file mode 100644 index 0000000..9671085 --- /dev/null +++ b/examples/http/http.pro @@ -0,0 +1 @@ +TEMPLATE = subdirs diff --git a/example/include/ticktock.hxx b/examples/http/include/ticktock.hxx similarity index 100% rename from example/include/ticktock.hxx rename to examples/http/include/ticktock.hxx diff --git a/example/include/unixcatcher.hpp b/examples/http/include/unixcatcher.hpp similarity index 100% rename from example/include/unixcatcher.hpp rename to examples/http/include/unixcatcher.hpp diff --git a/example/keep-alive/README.md b/examples/http/keep-alive/README.md similarity index 100% rename from example/keep-alive/README.md rename to examples/http/keep-alive/README.md diff --git a/example/keep-alive/keep-alive.pro b/examples/http/keep-alive/keep-alive.pro similarity index 100% rename from example/keep-alive/keep-alive.pro rename to examples/http/keep-alive/keep-alive.pro diff --git a/example/keep-alive/main.cpp b/examples/http/keep-alive/main.cpp similarity index 100% rename from example/keep-alive/main.cpp rename to examples/http/keep-alive/main.cpp diff --git a/example/postcollector/README.md b/examples/http/postcollector/README.md similarity index 100% rename from example/postcollector/README.md rename to examples/http/postcollector/README.md diff --git a/example/postcollector/main.cpp b/examples/http/postcollector/main.cpp similarity index 100% rename from example/postcollector/main.cpp rename to examples/http/postcollector/main.cpp diff --git a/example/postcollector/postcollector.pro b/examples/http/postcollector/postcollector.pro similarity index 100% rename from example/postcollector/postcollector.pro rename to examples/http/postcollector/postcollector.pro diff --git a/modules/qt_http.pri b/modules/qt_http.pri new file mode 100644 index 0000000..cc6c5d2 --- /dev/null +++ b/modules/qt_http.pri @@ -0,0 +1,14 @@ +QT.http.VERSION = 5.0.0 +QT.http.MAJOR_VERSION = 5 +QT.http.MINOR_VERSION = 0 +QT.http.PATCH_VERSION = 0 + +QT.http.name = QtHttp +QT.http.bins = $$QT_MODULE_BIN_BASE +QT.http.includes = $$QT_MODULE_INCLUDE_BASE $$QT_MODULE_INCLUDE_BASE/QtHttp +QT.http.private_includes = $$QT_MODULE_INCLUDE_BASE/QtHttp/$$QT.http.VERSION +QT.http.sources = $$QT_MODULE_BASE/src/http +QT.http.libs = $$QT_MODULE_LIB_BASE +QT.http.plugins = $$QT_MODULE_PLUGIN_BASE +QT.http.imports = $$QT_MODULE_IMPORT_BASE +QT.http.depends = core network diff --git a/qhttp.pro b/qhttp.pro index a97f926..74756c8 100644 --- a/qhttp.pro +++ b/qhttp.pro @@ -1,6 +1 @@ -TEMPLATE = subdirs - -SUBDIRS += src -SUBDIRS += example - -example.depends = src +load(qt_parts) diff --git a/src/http/http.pro b/src/http/http.pro new file mode 100644 index 0000000..587c75e --- /dev/null +++ b/src/http/http.pro @@ -0,0 +1,35 @@ +load(qt_build_config) + +INCLUDEPATH += $$PWD $$PWD/src $$PWD/3rdparty +DEPENDPATH += $$PWD + +QT += core network +QT -= gui + +TARGET = QtHttp +MODULE_PRI = ../../modules/qt_http.pri +MODULE = http + +load(qt_module) + +DEFINES *= QHTTP_MEMORY_LOG=0 +win32:DEFINES *= QHTTP_LIBRARY + +# Joyent http_parser +SOURCES += $$PWD/3rdparty/http-parser/http_parser.c +HEADERS += $$PWD/3rdparty/http-parser/http_parser.h + +SOURCES += \ + qhttpabstracts.cpp \ + qhttpserverconnection.cpp \ + qhttpserverrequest.cpp \ + qhttpserverresponse.cpp \ + qhttpserver.cpp + +HEADERS += \ + qhttpfwd.h \ + qhttpabstracts.h \ + qhttpserverconnection.h \ + qhttpserverrequest.h \ + qhttpserverresponse.h \ + qhttpserver.h diff --git a/src/private/httpparser.hxx b/src/http/private/httpparser.hxx similarity index 99% rename from src/private/httpparser.hxx rename to src/http/private/httpparser.hxx index 6913515..60722d4 100644 --- a/src/private/httpparser.hxx +++ b/src/http/private/httpparser.hxx @@ -10,7 +10,7 @@ #ifndef __QHTTP_HTTPPARSER_HXX__ #define __QHTTP_HTTPPARSER_HXX__ -#include "qhttpbase.hpp" +#include "qhttpbase.h" /////////////////////////////////////////////////////////////////////////////// namespace qhttp { namespace details { diff --git a/src/private/httpreader.hxx b/src/http/private/httpreader.hxx similarity index 98% rename from src/private/httpreader.hxx rename to src/http/private/httpreader.hxx index 174b31a..7b483d7 100644 --- a/src/private/httpreader.hxx +++ b/src/http/private/httpreader.hxx @@ -10,7 +10,7 @@ #ifndef __QHTTP_HTTPREADER_HXX__ #define __QHTTP_HTTPREADER_HXX__ -#include "qhttpbase.hpp" +#include "qhttpbase.h" /////////////////////////////////////////////////////////////////////////////// namespace qhttp { namespace details { diff --git a/src/private/httpwriter.hxx b/src/http/private/httpwriter.hxx similarity index 99% rename from src/private/httpwriter.hxx rename to src/http/private/httpwriter.hxx index 910e845..07f82c3 100644 --- a/src/private/httpwriter.hxx +++ b/src/http/private/httpwriter.hxx @@ -10,7 +10,7 @@ #ifndef __QHTTP_HTTPWRITER_HXX__ #define __QHTTP_HTTPWRITER_HXX__ -#include "qhttpbase.hpp" +#include "qhttpbase.h" /////////////////////////////////////////////////////////////////////////////// namespace qhttp { diff --git a/src/private/qhttpbase.hpp b/src/http/private/qhttpbase.h similarity index 96% rename from src/private/qhttpbase.hpp rename to src/http/private/qhttpbase.h index 81bae4f..1582e67 100644 --- a/src/private/qhttpbase.hpp +++ b/src/http/private/qhttpbase.h @@ -9,9 +9,9 @@ #ifndef QHTTPBASE_HPP #define QHTTPBASE_HPP -#include "qhttpfwd.hpp" +#include "qhttpfwd.h" -#include "qsocket.hpp" +#include "qsocket.h" #include #include diff --git a/src/private/qhttpserver_private.hpp b/src/http/private/qhttpserver_private.h similarity index 94% rename from src/private/qhttpserver_private.hpp rename to src/http/private/qhttpserver_private.h index ff9a1ec..4758793 100644 --- a/src/private/qhttpserver_private.hpp +++ b/src/http/private/qhttpserver_private.h @@ -10,10 +10,10 @@ #define QHTTPSERVER_PRIVATE_HPP /////////////////////////////////////////////////////////////////////////////// -#include "qhttpserver.hpp" -#include "qhttpserverconnection.hpp" -#include "qhttpserverrequest.hpp" -#include "qhttpserverresponse.hpp" +#include "qhttpserver.h" +#include "qhttpserverconnection.h" +#include "qhttpserverrequest.h" +#include "qhttpserverresponse.h" #include #include diff --git a/src/private/qhttpserverconnection_private.hpp b/src/http/private/qhttpserverconnection_private.h similarity index 96% rename from src/private/qhttpserverconnection_private.hpp rename to src/http/private/qhttpserverconnection_private.h index 879881c..935f3f9 100644 --- a/src/private/qhttpserverconnection_private.hpp +++ b/src/http/private/qhttpserverconnection_private.h @@ -10,13 +10,13 @@ #define QHTTPSERVER_CONNECTION_PRIVATE_HPP /////////////////////////////////////////////////////////////////////////////// -#include "qhttpserverconnection.hpp" +#include "qhttpserverconnection.h" #include "httpparser.hxx" -#include "qhttpserverrequest.hpp" -#include "qhttpserverresponse.hpp" +#include "qhttpserverrequest.h" +#include "qhttpserverresponse.h" -#include "private/qhttpserverrequest_private.hpp" -#include "private/qhttpserverresponse_private.hpp" +#include "private/qhttpserverrequest_private.h" +#include "private/qhttpserverresponse_private.h" #include #include diff --git a/src/private/qhttpserverrequest_private.hpp b/src/http/private/qhttpserverrequest_private.h similarity index 94% rename from src/private/qhttpserverrequest_private.hpp rename to src/http/private/qhttpserverrequest_private.h index c101d0b..23cbe3b 100644 --- a/src/private/qhttpserverrequest_private.hpp +++ b/src/http/private/qhttpserverrequest_private.h @@ -11,8 +11,8 @@ /////////////////////////////////////////////////////////////////////////////// #include "httpreader.hxx" -#include "qhttpserverrequest.hpp" -#include "qhttpserverconnection.hpp" +#include "qhttpserverrequest.h" +#include "qhttpserverconnection.h" /////////////////////////////////////////////////////////////////////////////// namespace qhttp { diff --git a/src/private/qhttpserverresponse_private.hpp b/src/http/private/qhttpserverresponse_private.h similarity index 94% rename from src/private/qhttpserverresponse_private.hpp rename to src/http/private/qhttpserverresponse_private.h index 6c1cd4d..d3d548c 100644 --- a/src/private/qhttpserverresponse_private.hpp +++ b/src/http/private/qhttpserverresponse_private.h @@ -10,9 +10,9 @@ #define QHTTPSERVER_RESPONSE_PRIVATE_HPP /////////////////////////////////////////////////////////////////////////////// #include "httpwriter.hxx" -#include "qhttpserverresponse.hpp" -#include "qhttpserver.hpp" -#include "qhttpserverconnection.hpp" +#include "qhttpserverresponse.h" +#include "qhttpserver.h" +#include "qhttpserverconnection.h" #include #include diff --git a/src/private/qsocket.hpp b/src/http/private/qsocket.h similarity index 99% rename from src/private/qsocket.hpp rename to src/http/private/qsocket.h index 11b3082..9a0945c 100644 --- a/src/private/qsocket.hpp +++ b/src/http/private/qsocket.h @@ -10,7 +10,7 @@ #ifndef __QHTTP_SOCKET_HPP__ #define __QHTTP_SOCKET_HPP__ -#include "qhttpfwd.hpp" +#include "qhttpfwd.h" #include #include diff --git a/src/qhttpabstracts.cpp b/src/http/qhttpabstracts.cpp similarity index 99% rename from src/qhttpabstracts.cpp rename to src/http/qhttpabstracts.cpp index 1b106e5..b247319 100644 --- a/src/qhttpabstracts.cpp +++ b/src/http/qhttpabstracts.cpp @@ -1,4 +1,4 @@ -#include "qhttpabstracts.hpp" +#include "qhttpabstracts.h" #include "http-parser/http_parser.h" /////////////////////////////////////////////////////////////////////////////// diff --git a/src/qhttpabstracts.hpp b/src/http/qhttpabstracts.h similarity index 97% rename from src/qhttpabstracts.hpp rename to src/http/qhttpabstracts.h index 005b9ce..fcbfc2c 100644 --- a/src/qhttpabstracts.hpp +++ b/src/http/qhttpabstracts.h @@ -10,7 +10,7 @@ #define QHTTPABSTRACTS_HPP /////////////////////////////////////////////////////////////////////////////// -#include "qhttpfwd.hpp" +#include "qhttpfwd.h" #include #include @@ -19,7 +19,7 @@ namespace qhttp { /////////////////////////////////////////////////////////////////////////////// /** a utility class to give the string representation of qhttp types. */ -class QHTTP_API Stringify +class QHTTP_EXPORT Stringify { public: /** returns the standard message for an HTTP status code. */ @@ -33,7 +33,7 @@ class QHTTP_API Stringify /** an interface for input (incoming) HTTP packets. * server::QHttpRequest or client::QHttpResponse inherit from this class. */ -class QHTTP_API QHttpAbstractInput : public QObject +class QHTTP_EXPORT QHttpAbstractInput : public QObject { Q_OBJECT @@ -118,7 +118,7 @@ class QHTTP_API QHttpAbstractInput : public QObject /** an interface for output (outgoing) HTTP packets. * server::QHttpResponse or client::QHttpRequest inherit from this class. */ -class QHTTP_API QHttpAbstractOutput : public QObject +class QHTTP_EXPORT QHttpAbstractOutput : public QObject { Q_OBJECT diff --git a/src/qhttpfwd.hpp b/src/http/qhttpfwd.h similarity index 92% rename from src/qhttpfwd.hpp rename to src/http/qhttpfwd.h index 534e687..e18aa02 100644 --- a/src/qhttpfwd.hpp +++ b/src/http/qhttpfwd.h @@ -179,27 +179,10 @@ using TServerHandler = std::function; /////////////////////////////////////////////////////////////////////////////// } // namespace server /////////////////////////////////////////////////////////////////////////////// -namespace client { -/////////////////////////////////////////////////////////////////////////////// -class QHttpClient; -class QHttpRequest; -class QHttpResponse; - -// Private classes -class QHttpClientPrivate; -class QHttpRequestPrivate; -class QHttpResponsePrivate; -/////////////////////////////////////////////////////////////////////////////// -} // namespace client -/////////////////////////////////////////////////////////////////////////////// -#ifdef Q_OS_WIN -# if defined(QHTTP_EXPORT) -# define QHTTP_API __declspec(dllexport) -# else -# define QHTTP_API __declspec(dllimport) -# endif +#if defined(QHTTP_LIBRARY) +# define QHTTP_EXPORT Q_DECL_EXPORT #else -# define QHTTP_API +# define QHTTP_EXPORT Q_DECL_IMPORT #endif diff --git a/src/qhttpserver.cpp b/src/http/qhttpserver.cpp similarity index 98% rename from src/qhttpserver.cpp rename to src/http/qhttpserver.cpp index fb126ec..2c6b9b5 100644 --- a/src/qhttpserver.cpp +++ b/src/http/qhttpserver.cpp @@ -1,4 +1,4 @@ -#include "private/qhttpserver_private.hpp" +#include "private/qhttpserver_private.h" /////////////////////////////////////////////////////////////////////////////// namespace qhttp { diff --git a/src/qhttpserver.hpp b/src/http/qhttpserver.h similarity index 98% rename from src/qhttpserver.hpp rename to src/http/qhttpserver.h index 4e492e3..f8bdfa1 100644 --- a/src/qhttpserver.hpp +++ b/src/http/qhttpserver.h @@ -10,7 +10,7 @@ #define QHTTPSERVER_HPP /////////////////////////////////////////////////////////////////////////////// -#include "qhttpfwd.hpp" +#include "qhttpfwd.h" #include #include @@ -20,7 +20,7 @@ namespace server { /////////////////////////////////////////////////////////////////////////////// /** The QHttpServer class is a fast, async (non-blocking) HTTP server. */ -class QHTTP_API QHttpServer : public QObject +class QHTTP_EXPORT QHttpServer : public QObject { Q_OBJECT diff --git a/src/qhttpserverconnection.cpp b/src/http/qhttpserverconnection.cpp similarity index 99% rename from src/qhttpserverconnection.cpp rename to src/http/qhttpserverconnection.cpp index b950c47..f8cb00b 100644 --- a/src/qhttpserverconnection.cpp +++ b/src/http/qhttpserverconnection.cpp @@ -1,4 +1,4 @@ -#include "private/qhttpserverconnection_private.hpp" +#include "private/qhttpserverconnection_private.h" /////////////////////////////////////////////////////////////////////////////// namespace qhttp { diff --git a/src/qhttpserverconnection.hpp b/src/http/qhttpserverconnection.h similarity index 97% rename from src/qhttpserverconnection.hpp rename to src/http/qhttpserverconnection.h index b908665..1b239c7 100644 --- a/src/qhttpserverconnection.hpp +++ b/src/http/qhttpserverconnection.h @@ -9,7 +9,7 @@ #ifndef QHTTPSERVER_CONNECTION_HPP #define QHTTPSERVER_CONNECTION_HPP /////////////////////////////////////////////////////////////////////////////// -#include "qhttpfwd.hpp" +#include "qhttpfwd.h" #include @@ -21,7 +21,7 @@ namespace server { * this class controls the HTTP connetion and handles life cycle and the memory management * of QHttpRequest and QHttpResponse instances autoamtically. */ -class QHTTP_API QHttpConnection : public QObject +class QHTTP_EXPORT QHttpConnection : public QObject { Q_OBJECT diff --git a/src/qhttpserverrequest.cpp b/src/http/qhttpserverrequest.cpp similarity index 97% rename from src/qhttpserverrequest.cpp rename to src/http/qhttpserverrequest.cpp index 87787fa..192e21c 100644 --- a/src/qhttpserverrequest.cpp +++ b/src/http/qhttpserverrequest.cpp @@ -1,4 +1,4 @@ -#include "private/qhttpserverrequest_private.hpp" +#include "private/qhttpserverrequest_private.h" /////////////////////////////////////////////////////////////////////////////// namespace qhttp { diff --git a/src/qhttpserverrequest.hpp b/src/http/qhttpserverrequest.h similarity index 96% rename from src/qhttpserverrequest.hpp rename to src/http/qhttpserverrequest.h index 4001c71..5369ae0 100644 --- a/src/qhttpserverrequest.hpp +++ b/src/http/qhttpserverrequest.h @@ -10,7 +10,7 @@ #define QHTTPSERVER_REQUEST_HPP /////////////////////////////////////////////////////////////////////////////// -#include "qhttpabstracts.hpp" +#include "qhttpabstracts.h" #include /////////////////////////////////////////////////////////////////////////////// @@ -21,7 +21,7 @@ namespace server { * The class is read-only. * @sa QHttpConnection */ -class QHTTP_API QHttpRequest : public QHttpAbstractInput +class QHTTP_EXPORT QHttpRequest : public QHttpAbstractInput { Q_OBJECT diff --git a/src/qhttpserverresponse.cpp b/src/http/qhttpserverresponse.cpp similarity index 97% rename from src/qhttpserverresponse.cpp rename to src/http/qhttpserverresponse.cpp index 5e60746..96b4b89 100644 --- a/src/qhttpserverresponse.cpp +++ b/src/http/qhttpserverresponse.cpp @@ -1,4 +1,4 @@ -#include "private/qhttpserverresponse_private.hpp" +#include "private/qhttpserverresponse_private.h" /////////////////////////////////////////////////////////////////////////////// namespace qhttp { diff --git a/src/qhttpserverresponse.hpp b/src/http/qhttpserverresponse.h similarity index 95% rename from src/qhttpserverresponse.hpp rename to src/http/qhttpserverresponse.h index d066712..d5d499c 100644 --- a/src/qhttpserverresponse.hpp +++ b/src/http/qhttpserverresponse.h @@ -11,7 +11,7 @@ /////////////////////////////////////////////////////////////////////////////// -#include "qhttpabstracts.hpp" +#include "qhttpabstracts.h" /////////////////////////////////////////////////////////////////////////////// namespace qhttp { @@ -20,7 +20,7 @@ namespace server { /** The QHttpResponse class handles sending data back to the client as a response to a request. * @sa QHttpConnection */ -class QHTTP_API QHttpResponse : public QHttpAbstractOutput +class QHTTP_EXPORT QHttpResponse : public QHttpAbstractOutput { Q_OBJECT diff --git a/src/private/qhttpclient_private.hpp b/src/private/qhttpclient_private.hpp deleted file mode 100644 index 7b757cc..0000000 --- a/src/private/qhttpclient_private.hpp +++ /dev/null @@ -1,196 +0,0 @@ -/** private imeplementation. - * https://github.com/azadkuh/qhttp - * - * @author amir zamani - * @version 2.0.0 - * @date 2014-07-11 - */ - -#ifndef QHTTPCLIENT_PRIVATE_HPP -#define QHTTPCLIENT_PRIVATE_HPP -/////////////////////////////////////////////////////////////////////////////// - -#include "qhttpclient.hpp" -#include "httpparser.hxx" -#include "qhttpclientrequest_private.hpp" -#include "qhttpclientresponse_private.hpp" - -/////////////////////////////////////////////////////////////////////////////// -namespace qhttp { -namespace client { -/////////////////////////////////////////////////////////////////////////////// - -class QHttpClientPrivate : - public details::HttpResponseParser -{ - Q_DECLARE_PUBLIC(QHttpClient) - -public: - explicit QHttpClientPrivate(QHttpClient* q) : q_ptr(q) { - QObject::connect( - q_func(), &QHttpClient::disconnected, - [this](){ release(); } - ); - - QHTTP_LINE_DEEPLOG - } - - virtual ~QHttpClientPrivate() { - QHTTP_LINE_DEEPLOG - } - - void release() { - // if socket drops and http_parser can not call messageComplete, - // dispatch the ilastResponse - finalizeConnection(); - - isocket.disconnectAllQtConnections(); - isocket.release(); - - if ( ilastRequest ) { - ilastRequest->deleteLater(); - ilastRequest = nullptr; - } - - if ( ilastResponse ) { - ilastResponse->deleteLater(); - ilastResponse = nullptr; - } - - // must be called! or the later http_parser_execute() may fail - http_parser_init(&iparser, HTTP_RESPONSE); - } - - void initializeSocket() { - if ( isocket.isOpen() ) { - // no need to reconnect. do nothing and simply return - if ( ikeepAlive ) - return; - - // close previous connection now! - // instead being called by emitted disconnected signal - release(); - } - - ikeepAlive = false; - - // create a tcp connection - if ( isocket.ibackendType == ETcpSocket ) { - initTcpSocket(); - - } else if ( isocket.ibackendType == ELocalSocket ) { - initLocalSocket(); - } - } - -public: - int messageBegin(http_parser* parser); - int url(http_parser*, const char*, size_t) { - return 0; // not used in parsing incoming respone. - } - int status(http_parser* parser, const char* at, size_t length) ; - int headerField(http_parser* parser, const char* at, size_t length); - int headerValue(http_parser* parser, const char* at, size_t length); - int headersComplete(http_parser* parser); - int body(http_parser* parser, const char* at, size_t length); - int messageComplete(http_parser* parser); - -protected: - void onConnected() { - iconnectingTimer.stop(); - - if ( itimeOut > 0 ) - itimer.start(itimeOut, Qt::CoarseTimer, q_func()); - - if ( ireqHandler ) - ireqHandler(ilastRequest); - else - q_func()->onRequestReady(ilastRequest); - } - - void onReadyRead() { - while ( isocket.bytesAvailable() > 0 ) { - char buffer[4097] = {0}; - size_t readLength = (size_t) isocket.readRaw(buffer, 4096); - - parse(buffer, readLength); - } - } - - void finalizeConnection() { - if ( ilastResponse == nullptr ) - return; - - ilastResponse->d_func()->finalizeSending([this]{ - emit ilastResponse->end(); - }); - } - -private: - void initTcpSocket() { - QTcpSocket* sok = new QTcpSocket(q_func()); - isocket.itcpSocket = sok; - - QObject::connect( - sok, &QTcpSocket::connected, - [this](){ onConnected(); } - ); - QObject::connect( - sok, &QTcpSocket::readyRead, - [this](){ onReadyRead(); } - ); - QObject::connect( - sok, &QTcpSocket::bytesWritten, - [this](qint64){ - const auto& ts = isocket.itcpSocket; - if ( ts->bytesToWrite() == 0 && ilastRequest ) - emit ilastRequest->allBytesWritten(); - }); - QObject::connect( - sok, &QTcpSocket::disconnected, - q_func(), &QHttpClient::disconnected - ); - } - - void initLocalSocket() { - QLocalSocket* sok = new QLocalSocket(q_func()); - isocket.ilocalSocket = sok; - - QObject::connect( - sok, &QLocalSocket::connected, - [this](){ onConnected(); } - ); - QObject::connect( - sok, &QLocalSocket::readyRead, - [this](){ onReadyRead(); } - ); - QObject::connect( - sok, &QLocalSocket::bytesWritten, - [this](qint64){ - const auto* ls = isocket.ilocalSocket; - if ( ls->bytesToWrite() == 0 && ilastRequest ) - emit ilastRequest->allBytesWritten(); - }); - QObject::connect( - sok, &QLocalSocket::disconnected, - q_func(), &QHttpClient::disconnected - ); - } - -protected: - QHttpClient* const q_ptr; - - QHttpRequest* ilastRequest = nullptr; - QHttpResponse* ilastResponse = nullptr; - TRequstHandler ireqHandler; - TResponseHandler irespHandler; - - QBasicTimer iconnectingTimer; -}; - -/////////////////////////////////////////////////////////////////////////////// -} // namespace client -} // namespace qhttp -/////////////////////////////////////////////////////////////////////////////// - -#endif // QHTTPCLIENT_PRIVATE_HPP diff --git a/src/private/qhttpclientrequest_private.hpp b/src/private/qhttpclientrequest_private.hpp deleted file mode 100644 index 703fcc4..0000000 --- a/src/private/qhttpclientrequest_private.hpp +++ /dev/null @@ -1,57 +0,0 @@ -/** private imeplementation. - * https://github.com/azadkuh/qhttp - * - * @author amir zamani - * @version 2.0.0 - * @date 2014-07-11 - */ - -#ifndef QHTTPCLIENT_REQUEST_PRIVATE_HPP -#define QHTTPCLIENT_REQUEST_PRIVATE_HPP -/////////////////////////////////////////////////////////////////////////////// -#include "httpwriter.hxx" -#include "qhttpclient.hpp" -#include "qhttpclientrequest.hpp" - -#include - -/////////////////////////////////////////////////////////////////////////////// -namespace qhttp { -namespace client { -/////////////////////////////////////////////////////////////////////////////// -class QHttpRequestPrivate : - public details::HttpWriter -{ - Q_DECLARE_PUBLIC(QHttpRequest) - -public: - explicit QHttpRequestPrivate(QHttpClient* cli, QHttpRequest* q) : q_ptr(q), iclient(cli) { - QHTTP_LINE_DEEPLOG - } - - virtual ~QHttpRequestPrivate() { - QHTTP_LINE_DEEPLOG - } - - void initialize() { - iversion = "1.1"; - - isocket.ibackendType = iclient->backendType(); - isocket.itcpSocket = iclient->tcpSocket(); - isocket.ilocalSocket = iclient->localSocket(); - } - - QByteArray makeTitle(); - - void prepareHeadersToWrite(); - -protected: - QHttpRequest* const q_ptr; - QHttpClient* const iclient; -}; - -/////////////////////////////////////////////////////////////////////////////// -} // namespace client -} // namespace qhttp -/////////////////////////////////////////////////////////////////////////////// -#endif // QHTTPCLIENT_REQUEST_PRIVATE_HPP diff --git a/src/private/qhttpclientresponse_private.hpp b/src/private/qhttpclientresponse_private.hpp deleted file mode 100644 index 4c216f1..0000000 --- a/src/private/qhttpclientresponse_private.hpp +++ /dev/null @@ -1,51 +0,0 @@ -/** private imeplementation. - * https://github.com/azadkuh/qhttp - * - * @author amir zamani - * @version 2.0.0 - * @date 2014-07-11 - */ - -#ifndef QHTTPCLIENT_RESPONSE_PRIVATE_HPP -#define QHTTPCLIENT_RESPONSE_PRIVATE_HPP -/////////////////////////////////////////////////////////////////////////////// - -#include "httpreader.hxx" -#include "qhttpclient.hpp" -#include "qhttpclientresponse.hpp" - -/////////////////////////////////////////////////////////////////////////////// -namespace qhttp { -namespace client { -/////////////////////////////////////////////////////////////////////////////// -class QHttpResponsePrivate : - public details::HttpReader -{ - Q_DECLARE_PUBLIC(QHttpResponse) - QHttpResponse* const q_ptr; - -public: - explicit QHttpResponsePrivate(QHttpClient* cli, QHttpResponse* q) - : q_ptr(q), iclient(cli) { - QHTTP_LINE_DEEPLOG - } - - virtual ~QHttpResponsePrivate() { - QHTTP_LINE_DEEPLOG - } - - void initialize() { - } - -public: - QString icustomStatusMessage; - -protected: - QHttpClient* const iclient; -}; - -/////////////////////////////////////////////////////////////////////////////// -} // namespace client -} // namespace qhttp -/////////////////////////////////////////////////////////////////////////////// -#endif // QHTTPCLIENT_RESPONSE_PRIVATE_HPP diff --git a/src/qhttpclient.cpp b/src/qhttpclient.cpp deleted file mode 100644 index 86de8c3..0000000 --- a/src/qhttpclient.cpp +++ /dev/null @@ -1,284 +0,0 @@ -#include "private/qhttpclient_private.hpp" - -#include -/////////////////////////////////////////////////////////////////////////////// -namespace qhttp { -namespace client { -/////////////////////////////////////////////////////////////////////////////// -QHttpClient::QHttpClient(QObject *parent) - : QObject(parent), d_ptr(new QHttpClientPrivate(this)) { - QHTTP_LINE_LOG -} - -QHttpClient::QHttpClient(QHttpClientPrivate &dd, QObject *parent) - : QObject(parent), d_ptr(&dd) { - QHTTP_LINE_LOG -} - -QHttpClient::~QHttpClient() { - QHTTP_LINE_LOG -} - -quint32 -QHttpClient::timeOut() const { - return d_func()->itimeOut; -} - -void -QHttpClient::setTimeOut(quint32 t) { - d_func()->itimeOut = t; -} - -bool -QHttpClient::isOpen() const { - return d_func()->isocket.isOpen(); -} - -void -QHttpClient::killConnection() { - Q_D(QHttpClient); - - d->iconnectingTimer.stop(); - d->itimer.stop(); - d->isocket.close(); -} - -TBackend -QHttpClient::backendType() const { - return d_func()->isocket.ibackendType; -} - -QTcpSocket* -QHttpClient::tcpSocket() const { - return d_func()->isocket.itcpSocket; -} - -QLocalSocket* -QHttpClient::localSocket() const { - return d_func()->isocket.ilocalSocket; -} - -void -QHttpClient::setConnectingTimeOut(quint32 timeout) { - Q_D(QHttpClient); - - if ( timeout == 0 ) { - d->iconnectingTimer.stop(); - - } else { - d->iconnectingTimer.start(timeout, - Qt::CoarseTimer, - this - ); - } -} - -bool -QHttpClient::request(THttpMethod method, QUrl url, - const TRequstHandler &reqHandler, - const TResponseHandler &resHandler) { - Q_D(QHttpClient); - - d->ireqHandler = nullptr; - d->irespHandler = nullptr; - - // if url is a local file (UNIX socket) the host could be empty! - if ( !url.isValid() || url.isEmpty() /*|| url.host().isEmpty()*/ ) - return false; - - // process handlers - if ( resHandler ) { - d->irespHandler = resHandler; - - if ( reqHandler ) - d->ireqHandler = reqHandler; - else - d->ireqHandler = [](QHttpRequest* req) ->void { - req->addHeader("connection", "close"); - req->end(); - }; - } - - auto requestCreator = [this, method, url]() { - // create request object - if ( d_ptr->ilastRequest ) - d_ptr->ilastRequest->deleteLater(); - - d_ptr->ilastRequest = new QHttpRequest(this); - QObject::connect(d_ptr->ilastRequest, &QHttpRequest::done, [this](bool wasTheLastPacket){ - d_ptr->ikeepAlive = !wasTheLastPacket; - }); - - d_ptr->ilastRequest->d_ptr->imethod = method; - d_ptr->ilastRequest->d_ptr->iurl = url; - }; - - // connecting to host/server must be the last thing. (after all function handlers and ...) - // check for type - if ( url.scheme().toLower() == QLatin1String("file") ) { - d->isocket.ibackendType = ELocalSocket; - d->initializeSocket(); - - requestCreator(); - - if ( d->isocket.isOpen() ) - d->onConnected(); - else - d->isocket.connectTo(url); - - } else { - d->isocket.ibackendType = ETcpSocket; - d->initializeSocket(); - - requestCreator(); - - if ( d->isocket.isOpen() ) - d->onConnected(); - else - d->isocket.connectTo(url.host(), url.port(80)); - } - - return true; -} - -void -QHttpClient::timerEvent(QTimerEvent *e) { - Q_D(QHttpClient); - - if ( e->timerId() == d->itimer.timerId() ) { - killConnection(); - - } else if ( e->timerId() == d->iconnectingTimer.timerId() ) { - d->iconnectingTimer.stop(); - emit connectingTimeOut(); - } -} - -void -QHttpClient::onRequestReady(QHttpRequest *req) { - emit httpConnected(req); -} - -void -QHttpClient::onResponseReady(QHttpResponse *res) { - emit newResponse(res); -} - -/////////////////////////////////////////////////////////////////////////////// - -// if server closes the connection, ends the response or by any other reason -// the socket disconnects, then the irequest and iresponse instances may have -// been deleted. In these situations reading more http body or emitting end() -// for incoming request are not possible: -// if ( ilastRequest == nullptr ) -// return 0; - - - -int -QHttpClientPrivate::messageBegin(http_parser*) { - itempHeaderField.clear(); - itempHeaderValue.clear(); - - return 0; -} - -int -QHttpClientPrivate::status(http_parser* parser, const char* at, size_t length) { - if ( ilastResponse ) - ilastResponse->deleteLater(); - - ilastResponse = new QHttpResponse(q_func()); - ilastResponse->d_func()->istatus = static_cast(parser->status_code); - ilastResponse->d_func()->iversion = QString("%1.%2") - .arg(parser->http_major) - .arg(parser->http_minor); - ilastResponse->d_func()->icustomStatusMessage = QString::fromUtf8(at, length); - - return 0; -} - -int -QHttpClientPrivate::headerField(http_parser*, const char* at, size_t length) { - if ( ilastResponse == nullptr ) - return 0; - - // insert the header we parsed previously - // into the header map - if ( !itempHeaderField.isEmpty() && !itempHeaderValue.isEmpty() ) { - // header names are always lower-cased - ilastResponse->d_func()->iheaders.insert( - itempHeaderField.toLower(), - itempHeaderValue.toLower() - ); - // clear header value. this sets up a nice - // feedback loop where the next time - // HeaderValue is called, it can simply append - itempHeaderField.clear(); - itempHeaderValue.clear(); - } - - itempHeaderField.append(at, length); - return 0; -} - -int -QHttpClientPrivate::headerValue(http_parser*, const char* at, size_t length) { - - itempHeaderValue.append(at, length); - return 0; -} - -int -QHttpClientPrivate::headersComplete(http_parser*) { - if ( ilastResponse == nullptr ) - return 0; - - // Insert last remaining header - ilastResponse->d_func()->iheaders.insert( - itempHeaderField.toLower(), - itempHeaderValue.toLower() - ); - - if ( irespHandler ) - irespHandler(ilastResponse); - else - q_func()->onResponseReady(ilastResponse); - - return 0; -} - -int -QHttpClientPrivate::body(http_parser*, const char* at, size_t length) { - if ( ilastResponse == nullptr ) - return 0; - - ilastResponse->d_func()->ireadState = QHttpResponsePrivate::EPartial; - - if ( ilastResponse->d_func()->icollectRequired ) { - if ( !ilastResponse->d_func()->append(at, length) ) { - // forcefully dispatch the ilastResponse - finalizeConnection(); - } - - return 0; - } - - emit ilastResponse->data(QByteArray(at, length)); - return 0; -} - -int -QHttpClientPrivate::messageComplete(http_parser*) { - if ( ilastResponse == nullptr ) - return 0; - - // response is done - finalizeConnection(); - return 0; -} - -/////////////////////////////////////////////////////////////////////////////// -} // namespace client -} // namespace qhttp -/////////////////////////////////////////////////////////////////////////////// diff --git a/src/qhttpclient.hpp b/src/qhttpclient.hpp deleted file mode 100644 index 423b309..0000000 --- a/src/qhttpclient.hpp +++ /dev/null @@ -1,182 +0,0 @@ -/** HTTP client class. - * https://github.com/azadkuh/qhttp - * - * @author amir zamani - * @version 2.0.0 - * @date 2014-07-11 - */ - -#ifndef QHTTPCLIENT_HPP -#define QHTTPCLIENT_HPP - -// configured by src.pro -#if defined(QHTTP_HAS_CLIENT) - -/////////////////////////////////////////////////////////////////////////////// -#include "qhttpfwd.hpp" - -#include -#include - -/////////////////////////////////////////////////////////////////////////////// -namespace qhttp { -namespace client { -/////////////////////////////////////////////////////////////////////////////// -using TRequstHandler = std::function; -using TResponseHandler = std::function; - -/** a simple and async HTTP client class which sends a request to an HTTP server and parses the - * corresponding response. - * This class internally handles the memory management and life cycle of QHttpRequest and - * QHttpResponse instances. you do not have to manually delete or keep their pointers. - * in fact the QHttpRequest and QHttpResponse object will be deleted when the internal socket - * disconnects. - */ -class QHTTP_API QHttpClient : public QObject -{ - Q_OBJECT - - Q_PROPERTY(quint32 timeOut READ timeOut WRITE setTimeOut) - -public: - explicit QHttpClient(QObject *parent = nullptr); - - virtual ~QHttpClient(); - - /** tries to connect to a HTTP server. - * when the connection is made, the reqHandler will be called - * and when the response is ready, resHandler will be called. - * @note httpConnected() and newResponse() won't be emitted. - * - * @param method an HTTP method, ex: GET, POST, ... - * @param url specifies server's address, port and optional path and query strings. - * if url starts with socket:// the request will be made on QLocalSocket, otherwise - * normal QTcpSocket will be used. - * @param resHandler response handler (a lambda, std::function object, ...) - * @return true if the url is valid or false (no connection will be made). - */ - bool request(THttpMethod method, QUrl url, - const TRequstHandler& reqHandler, - const TResponseHandler& resHandler); - - /** tries to connect to a HTTP server. - * when the connection is made, a default request handler is called automatically ( - * simply calls req->end()) and when the response is ready, resHandler will be called. - * @note httpConnected() and newResponse() won't be emitted. - * - * @param method an HTTP method, ex: GET, POST, ... - * @param url specifies server's address, port and optional path and query strings. - * @param resHandler response handler (a lambda, std::function object, ...) - * @return true if the url is valid or false (no connection will be made). - */ - inline bool request(THttpMethod method, QUrl url, const TResponseHandler& resHandler) { - return request(method, url, nullptr, resHandler); - } - - /** tries to connect to a HTTP server. - * when the connection is made, creates and emits a QHttpRequest instance - * by @sa httpConnected(QHttpRequest*). - * @note both httpConnected() and newResponse() may be emitted. - * - * @param method an HTTP method, ex: GET, POST, ... - * @param url specifies server's address, port and optional path and query strings. - * @return true if the url is valid or false (no connection will be made). - */ - inline bool request(THttpMethod method, QUrl url) { - return request(method, url, nullptr, nullptr); - } - - /** checks if the connetion to the server is open. */ - bool isOpen() const; - - /** forcefully close the connection. */ - void killConnection(); - - - /** returns time-out value [mSec] for ESTABLISHED connections (sockets). - * @sa setTimeOut(). */ - quint32 timeOut()const; - - /** set time-out for ESTABLISHED connections in miliseconds [mSec]. - * each (already opened) connection will be forcefully closed after this timeout. - * a zero (0) value disables timer for new connections. */ - void setTimeOut(quint32); - - /** set a time-out [mSec] for making a new connection (make a request). - * if connecting to server takes more than this time-out value, - * the @sa timedOut(quint32) signal will be emitted and connection will be killed. - * 0 (default) timeout value means to disable this timer. - */ - void setConnectingTimeOut(quint32); - - template - void setConnectingTimeOut(quint32 timeout, Handler&& func) { - setConnectingTimeOut(timeout); - QObject::connect(this, &QHttpClient::connectingTimeOut, - std::forward(func) - ); - } - - /** returns the backend type of this client. */ - TBackend backendType() const; - - /** returns tcp socket of the connection if backend() == ETcpSocket. */ - QTcpSocket* tcpSocket() const; - - /** returns local socket of the connection if backend() == ELocalSocket. */ - QLocalSocket* localSocket() const; - -signals: - /** emitted when a new HTTP connection to the server is established. - * if you overload onRequestReady this signal won't be emitted. - * @sa onRequestReady - * @sa QHttpRequest - */ - void httpConnected(QHttpRequest* req); - - /** emitted when a new response is received from the server. - * if you overload onResponseReady this signal won't be emitted. - * @sa onResponseReady - * @sa QHttpResponse - */ - void newResponse(QHttpResponse* res); - - /** emitted when the HTTP connection drops or being disconnected. */ - void disconnected(); - - /// emitted when fails to connect to a HTTP server. @sa setConnectingTimeOut() - void connectingTimeOut(); - - -protected: - /** called when a new HTTP connection is established. - * you can overload this method, the default implementaion only emits connected(). - * @param req use this request instance for assinging the - * request headers and sending optional body. - * @see httpConnected(QHttpRequest*) - */ - virtual void onRequestReady(QHttpRequest* req); - - /** called when a new response is received from the server. - * you can overload this method, the default implementaion only emits newResponse(). - * @param res use this instance for reading incoming response. - * @see newResponse(QHttpResponse*) - */ - virtual void onResponseReady(QHttpResponse* res); - -protected: - explicit QHttpClient(QHttpClientPrivate&, QObject*); - - void timerEvent(QTimerEvent*) override; - - Q_DECLARE_PRIVATE(QHttpClient) - Q_DISABLE_COPY(QHttpClient) - QScopedPointer d_ptr; -}; - -/////////////////////////////////////////////////////////////////////////////// -} // namespace client -} // namespace qhttp -/////////////////////////////////////////////////////////////////////////////// -#endif // QHTTP_HAS_CLIENT -#endif // define QHTTPCLIENT_HPP diff --git a/src/qhttpclientrequest.cpp b/src/qhttpclientrequest.cpp deleted file mode 100644 index 50e1d99..0000000 --- a/src/qhttpclientrequest.cpp +++ /dev/null @@ -1,98 +0,0 @@ -#include "private/qhttpclientrequest_private.hpp" -#include "qhttpclient.hpp" -/////////////////////////////////////////////////////////////////////////////// -namespace qhttp { -namespace client { -/////////////////////////////////////////////////////////////////////////////// -QHttpRequest::QHttpRequest(QHttpClient* cli) - : QHttpAbstractOutput(cli) , d_ptr(new QHttpRequestPrivate(cli, this)) { - d_ptr->initialize(); - QHTTP_LINE_LOG -} - -QHttpRequest::QHttpRequest(QHttpRequestPrivate& dd, QHttpClient* cli) - : QHttpAbstractOutput(cli) , d_ptr(&dd) { - d_ptr->initialize(); - QHTTP_LINE_LOG -} - -QHttpRequest::~QHttpRequest() { - QHTTP_LINE_LOG -} - -void -QHttpRequest::setVersion(const QString &versionString) { - d_func()->iversion = versionString; -} - -void -QHttpRequest::addHeader(const QByteArray &field, const QByteArray &value) { - d_func()->addHeader(field, value); -} - -THeaderHash& -QHttpRequest::headers() { - return d_func()->iheaders; -} - -void -QHttpRequest::write(const QByteArray &data) { - d_func()->writeData(data); -} - -void -QHttpRequest::end(const QByteArray &data) { - Q_D(QHttpRequest); - - if ( d->endPacket(data) ) - emit done(!d->ikeepAlive); -} - -QHttpClient* -QHttpRequest::connection() const { - return d_func()->iclient; -} - -/////////////////////////////////////////////////////////////////////////////// -QByteArray -QHttpRequestPrivate::makeTitle() { - - QByteArray title; - title.reserve(512); - title.append(qhttp::Stringify::toString(imethod)) - .append(" "); - - QByteArray path = iurl.path(QUrl::FullyEncoded).toLatin1(); - if ( path.size() == 0 ) - path = "/"; - title.append(path); - - if ( iurl.hasQuery() ) - title.append("?").append(iurl.query(QUrl::FullyEncoded).toLatin1()); - - - title.append(" HTTP/") - .append(iversion.toLatin1()) - .append("\r\n"); - - return title; -} - -void -QHttpRequestPrivate::prepareHeadersToWrite() { - - if ( !iheaders.contains("host") ) { - quint16 port = iurl.port(); - if ( port == 0 ) - port = 80; - - iheaders.insert("host", - QString("%1:%2").arg(iurl.host()).arg(port).toLatin1() - ); - } -} - -/////////////////////////////////////////////////////////////////////////////// -} // namespace client -} // namespace qhttp -/////////////////////////////////////////////////////////////////////////////// diff --git a/src/qhttpclientrequest.hpp b/src/qhttpclientrequest.hpp deleted file mode 100644 index 53edb9b..0000000 --- a/src/qhttpclientrequest.hpp +++ /dev/null @@ -1,67 +0,0 @@ -/** HTTP request from a client. - * https://github.com/azadkuh/qhttp - * - * @author amir zamani - * @version 2.0.0 - * @date 2014-07-11 - */ - -#ifndef QHTTPCLIENT_REQUEST_HPP -#define QHTTPCLIENT_REQUEST_HPP - -// configured by src.pro -#if defined(QHTTP_HAS_CLIENT) - -/////////////////////////////////////////////////////////////////////////////// -#include "qhttpabstracts.hpp" -#include -/////////////////////////////////////////////////////////////////////////////// -namespace qhttp { -namespace client { -/////////////////////////////////////////////////////////////////////////////// -/** a class for building a new HTTP request. - * the life cycle of this class and the memory management is handled by QHttpClient. - * @sa QHttpClient - */ -class QHTTP_API QHttpRequest : public QHttpAbstractOutput -{ - Q_OBJECT - -public: - virtual ~QHttpRequest(); - -public: // QHttpAbstractOutput methods: - /** @see QHttpAbstractOutput::setVersion(). */ - void setVersion(const QString& versionString) override; - - /** @see QHttpAbstractOutput::addHeader(). */ - void addHeader(const QByteArray& field, const QByteArray& value) override; - - /** @see QHttpAbstractOutput::headers(). */ - THeaderHash& headers() override; - - /** @see QHttpAbstractOutput::write(). */ - void write(const QByteArray &data) override; - - /** @see QHttpAbstractOutput::end(). */ - void end(const QByteArray &data = QByteArray()) override; - -public: - /** returns parent QHttpClient object. */ - QHttpClient* connection() const; - -protected: - explicit QHttpRequest(QHttpClient*); - explicit QHttpRequest(QHttpRequestPrivate&, QHttpClient*); - friend class QHttpClient; - - Q_DECLARE_PRIVATE(QHttpRequest) - QScopedPointer d_ptr; -}; - -/////////////////////////////////////////////////////////////////////////////// -} // namespace client -} // namespace qhttp -/////////////////////////////////////////////////////////////////////////////// -#endif // QHTTP_HAS_CLIENT -#endif // define QHTTPCLIENT_REQUEST_HPP diff --git a/src/qhttpclientresponse.cpp b/src/qhttpclientresponse.cpp deleted file mode 100644 index 182d2b0..0000000 --- a/src/qhttpclientresponse.cpp +++ /dev/null @@ -1,66 +0,0 @@ -#include "private/qhttpclientresponse_private.hpp" -#include "qhttpclient.hpp" -/////////////////////////////////////////////////////////////////////////////// -namespace qhttp { -namespace client { -/////////////////////////////////////////////////////////////////////////////// -QHttpResponse::QHttpResponse(QHttpClient *cli) - : QHttpAbstractInput(cli), d_ptr(new QHttpResponsePrivate(cli, this)) { - d_ptr->initialize(); - QHTTP_LINE_LOG -} - -QHttpResponse::QHttpResponse(QHttpResponsePrivate &dd, QHttpClient *cli) - : QHttpAbstractInput(cli), d_ptr(&dd) { - d_ptr->initialize(); - QHTTP_LINE_LOG -} - -QHttpResponse::~QHttpResponse() { - QHTTP_LINE_LOG -} - -TStatusCode -QHttpResponse::status() const { - return d_func()->istatus; -} - -const QString& -QHttpResponse::statusString() const { - return d_func()->icustomStatusMessage; -} - -const QString& -QHttpResponse::httpVersion() const { - return d_func()->iversion; -} - -const THeaderHash& -QHttpResponse::headers() const { - return d_func()->iheaders; -} - -bool -QHttpResponse::isSuccessful() const { - return d_func()->isuccessful; -} - -void -QHttpResponse::collectData(int atMost) { - d_func()->collectData(atMost); -} - -const QByteArray& -QHttpResponse::collectedData() const { - return d_func()->icollectedData; -} - -QHttpClient* -QHttpResponse::connection() const { - return d_func()->iclient; -} - -/////////////////////////////////////////////////////////////////////////////// -} // namespace client -} // namespace qhttp -/////////////////////////////////////////////////////////////////////////////// diff --git a/src/qhttpclientresponse.hpp b/src/qhttpclientresponse.hpp deleted file mode 100644 index ddfdcb4..0000000 --- a/src/qhttpclientresponse.hpp +++ /dev/null @@ -1,78 +0,0 @@ -/** HTTP response received by client. - * https://github.com/azadkuh/qhttp - * - * @author amir zamani - * @version 2.0.0 - * @date 2014-07-11 - */ - -#ifndef QHTTPCLIENT_RESPONSE_HPP -#define QHTTPCLIENT_RESPONSE_HPP - -// configured by src.pro -#if defined(QHTTP_HAS_CLIENT) - -/////////////////////////////////////////////////////////////////////////////// - -#include "qhttpabstracts.hpp" - -#include -/////////////////////////////////////////////////////////////////////////////// -namespace qhttp { -namespace client { -/////////////////////////////////////////////////////////////////////////////// -/** a class for reading incoming HTTP response from a server. - * the life cycle of this class and the memory management is handled by QHttpClient. - * @sa QHttpClient - */ -class QHTTP_API QHttpResponse : public QHttpAbstractInput -{ - Q_OBJECT - -public: - virtual ~QHttpResponse(); - -public: // QHttpAbstractInput methods: - /** @see QHttpAbstractInput::headers(). */ - const THeaderHash& headers() const override; - - /** @see QHttpAbstractInput::httpVersion(). */ - const QString& httpVersion() const override; - - /** @see QHttpAbstractInput::isSuccessful(). */ - bool isSuccessful() const override; - - /** @see QHttpAbstractInput::collectData(). */ - void collectData(int atMost = -1) override; - - /** @see QHttpAbstractInput::collectedData(). */ - const QByteArray& collectedData()const override; - - -public: - /** The status code of this response. */ - TStatusCode status() const ; - - /** The server status message as string. - * may be slightly different than: @code qhttp::Stringify::toString(status()); @endcode - * depending on implementation of HTTP server. */ - const QString& statusString() const; - - /** returns parent QHttpClient object. */ - QHttpClient* connection() const; - -protected: - explicit QHttpResponse(QHttpClient*); - explicit QHttpResponse(QHttpResponsePrivate&, QHttpClient*); - friend class QHttpClientPrivate; - - Q_DECLARE_PRIVATE(QHttpResponse) - QScopedPointer d_ptr; -}; - -/////////////////////////////////////////////////////////////////////////////// -} // namespace client -} // namespace qhttp -/////////////////////////////////////////////////////////////////////////////// -#endif // QHTTP_HAS_CLIENT -#endif // define QHTTPCLIENT_RESPONSE_HPP diff --git a/src/qmake/headerinstall.pri b/src/qmake/headerinstall.pri deleted file mode 100644 index 802faca..0000000 --- a/src/qmake/headerinstall.pri +++ /dev/null @@ -1,10 +0,0 @@ - -basePath = $${dirname(PWD)} -for(header, INSTALL_HEADERS) { - relPath = $${relative_path($$header, $$basePath)} - path = $${INSTALL_PREFIX}/$${dirname(relPath)} - eval(headers_$${path}.files += $$relPath) - eval(headers_$${path}.path = $$path) - eval(INSTALLS *= headers_$${path}) -} - diff --git a/src/src.pro b/src/src.pro index 6e0c26e..49a342e 100644 --- a/src/src.pro +++ b/src/src.pro @@ -1,53 +1,2 @@ -QT += core network -QT -= gui - -TARGET = qhttp -TEMPLATE = lib - -PRJDIR = .. -include($$PRJDIR/commondir.pri) - -DEFINES *= QHTTP_MEMORY_LOG=0 -win32:DEFINES *= QHTTP_EXPORT - -# Joyent http_parser -SOURCES += $$PRJDIR/3rdparty/http-parser/http_parser.c -HEADERS += $$PRJDIR/3rdparty/http-parser/http_parser.h - -SOURCES += \ - qhttpabstracts.cpp \ - qhttpserverconnection.cpp \ - qhttpserverrequest.cpp \ - qhttpserverresponse.cpp \ - qhttpserver.cpp - -HEADERS += \ - qhttpfwd.hpp \ - qhttpabstracts.hpp \ - qhttpserverconnection.hpp \ - qhttpserverrequest.hpp \ - qhttpserverresponse.hpp \ - qhttpserver.hpp - -contains(DEFINES, QHTTP_HAS_CLIENT) { - SOURCES += \ - qhttpclientrequest.cpp \ - qhttpclientresponse.cpp \ - qhttpclient.cpp - - HEADERS += \ - qhttpclient.hpp \ - qhttpclientresponse.hpp \ - qhttpclientrequest.hpp -} - -!contains(CONFIG, no_install) { - INSTALL_PREFIX = $$[QT_INSTALL_HEADERS]/qhttp - INSTALL_HEADERS = $$HEADERS - include(qmake/headerinstall.pri) - - target = $$TARGET - target.path = $$[QT_INSTALL_LIBS] - - INSTALLS += target -} +TEMPLATE = subdirs +SUBDIRS = http diff --git a/sync.profile b/sync.profile new file mode 100644 index 0000000..65171f6 --- /dev/null +++ b/sync.profile @@ -0,0 +1,18 @@ +%modules = ( + "QtHttp" => "$basedir/src/http", +); +%moduleheaders = ( # restrict the module headers to those found in relative path +); +%classnames = ( +); +%mastercontent = ( + "core" => "#include ", + "network" => "#include " +); +%modulepris = ( + "QtHttp" => "$basedir/modules/qt_http.pri", +); + +%dependencies = ( + "qtbase" => "" +); diff --git a/tests/auto/auto.pro b/tests/auto/auto.pro new file mode 100644 index 0000000..8cded03 --- /dev/null +++ b/tests/auto/auto.pro @@ -0,0 +1,3 @@ +TEMPLATE = subdirs +SUBDIRS = +CONFIG-=create_cmake \ No newline at end of file diff --git a/tests/auto/cmake/cmake.pro b/tests/auto/cmake/cmake.pro new file mode 100644 index 0000000..da13e21 --- /dev/null +++ b/tests/auto/cmake/cmake.pro @@ -0,0 +1,3 @@ +# let cmake do nothing +TEMPLATE = subdirs +SUBDIRS = \ No newline at end of file diff --git a/tests/tests.pro b/tests/tests.pro new file mode 100644 index 0000000..85e4f3a --- /dev/null +++ b/tests/tests.pro @@ -0,0 +1,2 @@ +TEMPLATE = subdirs +SUBDIRS += auto diff --git a/update-dependencies.sh b/update-dependencies.sh deleted file mode 100755 index d5b4b9e..0000000 --- a/update-dependencies.sh +++ /dev/null @@ -1,17 +0,0 @@ -#!/bin/sh - -echo "preparing the latest version of 3rd-party dependencies ...\n" - -mkdir -p 3rdparty -cd 3rdparty - -echo "--> nodejs / http-parser" -if [ -e http-parser ]; then - cd http-parser - git pull origin master -else - git clone https://github.com/nodejs/http-parser.git -fi - -cd .. -echo "\ndone." diff --git a/utils.sh b/utils.sh deleted file mode 100755 index 190c637..0000000 --- a/utils.sh +++ /dev/null @@ -1,61 +0,0 @@ -#!/bin/bash - -CTAGS_EXCLUDES_BASE="--exclude=.git --exclude=tmp --exclude=xbin --exclude=res" -CTAGS_OPTIONS_BASE="--c++-kinds=+cefgnps --fields=+iaS --extra=+fq -R ." -CLOC_EXCLUDES_BASE="--exclude-dir=.git,xbin,tmp,res" -CLOC_EXCLUDES_LANGS="--exclude-lang=Prolog,make" - - -function fn_cloc() { -echo "cloc (exclusive) ..." -cloc $CLOC_EXCLUDES_LANGS $CLOC_EXCLUDES_BASE,3rdparty . -} - -function fn_cloc_all() { -echo "cloc all (inclusive) ..." -cloc $CLOC_EXCLUDES_LANGS $CLOC_EXCLUDES_BASE . -} - -function fn_ctags() { -echo "ctags (exclusive) ..." -ctags --exclude=3rdparty $CTAGS_EXCLUDES_BASE $CTAGS_OPTIONS_BASE -} - -function fn_ctags_all() { -echo "ctags all (inclusive) ..." -ctags $CTAGS_EXCLUDES_BASE $CTAGS_OPTIONS_BASE -} - -if [[ $# -eq 0 ]]; then - fn_ctags - -else - while [[ $# > 0 ]]; do - arg="$1" - - case $arg in - tags|ctags|tag|ctag) - fn_ctags - ;; - - tags_all|ctags_all|tag_all|fn_ctags_all) - fn_ctags_all - ;; - - cloc_all) - fn_cloc_all - ;; - - cloc) - fn_cloc - ;; - - *) - echo "unknown args as $arg" - ;; - - esac - shift - done -fi - From bbde3d895c5c7cc698f9e531845659a3d55241ee Mon Sep 17 00:00:00 2001 From: Bardia Daneshvar Date: Sat, 7 Jul 2018 17:30:25 +0430 Subject: [PATCH 3/3] Bugfix --- .gitignore | 1 - src/http/3rdparty/http-parser/http_parser.c | 2408 +++++++++++++++++++ src/http/3rdparty/http-parser/http_parser.h | 431 ++++ 3 files changed, 2839 insertions(+), 1 deletion(-) create mode 100644 src/http/3rdparty/http-parser/http_parser.c create mode 100644 src/http/3rdparty/http-parser/http_parser.h diff --git a/.gitignore b/.gitignore index 098fa43..55acf9f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,4 @@ # 3rdparty, tmp and build direcotry -3rdparty/ tmp/ xbin/ build/ diff --git a/src/http/3rdparty/http-parser/http_parser.c b/src/http/3rdparty/http-parser/http_parser.c new file mode 100644 index 0000000..8d85124 --- /dev/null +++ b/src/http/3rdparty/http-parser/http_parser.c @@ -0,0 +1,2408 @@ +/* Copyright Joyent, Inc. and other Node contributors. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ +#include "http_parser.h" +#include +#include +#include +#include +#include +#include + +#ifndef ULLONG_MAX +# define ULLONG_MAX ((uint64_t) -1) /* 2^64-1 */ +#endif + +#ifndef MIN +# define MIN(a,b) ((a) < (b) ? (a) : (b)) +#endif + +#ifndef ARRAY_SIZE +# define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) +#endif + +#ifndef BIT_AT +# define BIT_AT(a, i) \ + (!!((unsigned int) (a)[(unsigned int) (i) >> 3] & \ + (1 << ((unsigned int) (i) & 7)))) +#endif + +#ifndef ELEM_AT +# define ELEM_AT(a, i, v) ((unsigned int) (i) < ARRAY_SIZE(a) ? (a)[(i)] : (v)) +#endif + +#define SET_ERRNO(e) \ +do { \ + parser->http_errno = (e); \ +} while(0) + +#define CURRENT_STATE() p_state +#define UPDATE_STATE(V) p_state = (enum state) (V); +#define RETURN(V) \ +do { \ + parser->state = CURRENT_STATE(); \ + return (V); \ +} while (0); +#define REEXECUTE() \ + goto reexecute; \ + + +#ifdef __GNUC__ +# define LIKELY(X) __builtin_expect(!!(X), 1) +# define UNLIKELY(X) __builtin_expect(!!(X), 0) +#else +# define LIKELY(X) (X) +# define UNLIKELY(X) (X) +#endif + + +/* Run the notify callback FOR, returning ER if it fails */ +#define CALLBACK_NOTIFY_(FOR, ER) \ +do { \ + assert(HTTP_PARSER_ERRNO(parser) == HPE_OK); \ + \ + if (LIKELY(settings->on_##FOR)) { \ + parser->state = CURRENT_STATE(); \ + if (UNLIKELY(0 != settings->on_##FOR(parser))) { \ + SET_ERRNO(HPE_CB_##FOR); \ + } \ + UPDATE_STATE(parser->state); \ + \ + /* We either errored above or got paused; get out */ \ + if (UNLIKELY(HTTP_PARSER_ERRNO(parser) != HPE_OK)) { \ + return (ER); \ + } \ + } \ +} while (0) + +/* Run the notify callback FOR and consume the current byte */ +#define CALLBACK_NOTIFY(FOR) CALLBACK_NOTIFY_(FOR, p - data + 1) + +/* Run the notify callback FOR and don't consume the current byte */ +#define CALLBACK_NOTIFY_NOADVANCE(FOR) CALLBACK_NOTIFY_(FOR, p - data) + +/* Run data callback FOR with LEN bytes, returning ER if it fails */ +#define CALLBACK_DATA_(FOR, LEN, ER) \ +do { \ + assert(HTTP_PARSER_ERRNO(parser) == HPE_OK); \ + \ + if (FOR##_mark) { \ + if (LIKELY(settings->on_##FOR)) { \ + parser->state = CURRENT_STATE(); \ + if (UNLIKELY(0 != \ + settings->on_##FOR(parser, FOR##_mark, (LEN)))) { \ + SET_ERRNO(HPE_CB_##FOR); \ + } \ + UPDATE_STATE(parser->state); \ + \ + /* We either errored above or got paused; get out */ \ + if (UNLIKELY(HTTP_PARSER_ERRNO(parser) != HPE_OK)) { \ + return (ER); \ + } \ + } \ + FOR##_mark = NULL; \ + } \ +} while (0) + +/* Run the data callback FOR and consume the current byte */ +#define CALLBACK_DATA(FOR) \ + CALLBACK_DATA_(FOR, p - FOR##_mark, p - data + 1) + +/* Run the data callback FOR and don't consume the current byte */ +#define CALLBACK_DATA_NOADVANCE(FOR) \ + CALLBACK_DATA_(FOR, p - FOR##_mark, p - data) + +/* Set the mark FOR; non-destructive if mark is already set */ +#define MARK(FOR) \ +do { \ + if (!FOR##_mark) { \ + FOR##_mark = p; \ + } \ +} while (0) + +/* Don't allow the total size of the HTTP headers (including the status + * line) to exceed HTTP_MAX_HEADER_SIZE. This check is here to protect + * embedders against denial-of-service attacks where the attacker feeds + * us a never-ending header that the embedder keeps buffering. + * + * This check is arguably the responsibility of embedders but we're doing + * it on the embedder's behalf because most won't bother and this way we + * make the web a little safer. HTTP_MAX_HEADER_SIZE is still far bigger + * than any reasonable request or response so this should never affect + * day-to-day operation. + */ +#define COUNT_HEADER_SIZE(V) \ +do { \ + parser->nread += (V); \ + if (UNLIKELY(parser->nread > (HTTP_MAX_HEADER_SIZE))) { \ + SET_ERRNO(HPE_HEADER_OVERFLOW); \ + goto error; \ + } \ +} while (0) + + +#define PROXY_CONNECTION "proxy-connection" +#define CONNECTION "connection" +#define CONTENT_LENGTH "content-length" +#define TRANSFER_ENCODING "transfer-encoding" +#define UPGRADE "upgrade" +#define CHUNKED "chunked" +#define KEEP_ALIVE "keep-alive" +#define CLOSE "close" + + +static const char *method_strings[] = + { +#define XX(num, name, string) #string, + HTTP_METHOD_MAP(XX) +#undef XX + }; + + +/* Tokens as defined by rfc 2616. Also lowercases them. + * token = 1* + * separators = "(" | ")" | "<" | ">" | "@" + * | "," | ";" | ":" | "\" | <"> + * | "/" | "[" | "]" | "?" | "=" + * | "{" | "}" | SP | HT + */ +static const char tokens[256] = { +/* 0 nul 1 soh 2 stx 3 etx 4 eot 5 enq 6 ack 7 bel */ + 0, 0, 0, 0, 0, 0, 0, 0, +/* 8 bs 9 ht 10 nl 11 vt 12 np 13 cr 14 so 15 si */ + 0, 0, 0, 0, 0, 0, 0, 0, +/* 16 dle 17 dc1 18 dc2 19 dc3 20 dc4 21 nak 22 syn 23 etb */ + 0, 0, 0, 0, 0, 0, 0, 0, +/* 24 can 25 em 26 sub 27 esc 28 fs 29 gs 30 rs 31 us */ + 0, 0, 0, 0, 0, 0, 0, 0, +/* 32 sp 33 ! 34 " 35 # 36 $ 37 % 38 & 39 ' */ + 0, '!', 0, '#', '$', '%', '&', '\'', +/* 40 ( 41 ) 42 * 43 + 44 , 45 - 46 . 47 / */ + 0, 0, '*', '+', 0, '-', '.', 0, +/* 48 0 49 1 50 2 51 3 52 4 53 5 54 6 55 7 */ + '0', '1', '2', '3', '4', '5', '6', '7', +/* 56 8 57 9 58 : 59 ; 60 < 61 = 62 > 63 ? */ + '8', '9', 0, 0, 0, 0, 0, 0, +/* 64 @ 65 A 66 B 67 C 68 D 69 E 70 F 71 G */ + 0, 'a', 'b', 'c', 'd', 'e', 'f', 'g', +/* 72 H 73 I 74 J 75 K 76 L 77 M 78 N 79 O */ + 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', +/* 80 P 81 Q 82 R 83 S 84 T 85 U 86 V 87 W */ + 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', +/* 88 X 89 Y 90 Z 91 [ 92 \ 93 ] 94 ^ 95 _ */ + 'x', 'y', 'z', 0, 0, 0, '^', '_', +/* 96 ` 97 a 98 b 99 c 100 d 101 e 102 f 103 g */ + '`', 'a', 'b', 'c', 'd', 'e', 'f', 'g', +/* 104 h 105 i 106 j 107 k 108 l 109 m 110 n 111 o */ + 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', +/* 112 p 113 q 114 r 115 s 116 t 117 u 118 v 119 w */ + 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', +/* 120 x 121 y 122 z 123 { 124 | 125 } 126 ~ 127 del */ + 'x', 'y', 'z', 0, '|', 0, '~', 0 }; + + +static const int8_t unhex[256] = + {-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1 + ,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1 + ,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1 + , 0, 1, 2, 3, 4, 5, 6, 7, 8, 9,-1,-1,-1,-1,-1,-1 + ,-1,10,11,12,13,14,15,-1,-1,-1,-1,-1,-1,-1,-1,-1 + ,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1 + ,-1,10,11,12,13,14,15,-1,-1,-1,-1,-1,-1,-1,-1,-1 + ,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1 + }; + + +#if HTTP_PARSER_STRICT +# define T(v) 0 +#else +# define T(v) v +#endif + + +static const uint8_t normal_url_char[32] = { +/* 0 nul 1 soh 2 stx 3 etx 4 eot 5 enq 6 ack 7 bel */ + 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0, +/* 8 bs 9 ht 10 nl 11 vt 12 np 13 cr 14 so 15 si */ + 0 | T(2) | 0 | 0 | T(16) | 0 | 0 | 0, +/* 16 dle 17 dc1 18 dc2 19 dc3 20 dc4 21 nak 22 syn 23 etb */ + 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0, +/* 24 can 25 em 26 sub 27 esc 28 fs 29 gs 30 rs 31 us */ + 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0, +/* 32 sp 33 ! 34 " 35 # 36 $ 37 % 38 & 39 ' */ + 0 | 2 | 4 | 0 | 16 | 32 | 64 | 128, +/* 40 ( 41 ) 42 * 43 + 44 , 45 - 46 . 47 / */ + 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128, +/* 48 0 49 1 50 2 51 3 52 4 53 5 54 6 55 7 */ + 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128, +/* 56 8 57 9 58 : 59 ; 60 < 61 = 62 > 63 ? */ + 1 | 2 | 4 | 8 | 16 | 32 | 64 | 0, +/* 64 @ 65 A 66 B 67 C 68 D 69 E 70 F 71 G */ + 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128, +/* 72 H 73 I 74 J 75 K 76 L 77 M 78 N 79 O */ + 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128, +/* 80 P 81 Q 82 R 83 S 84 T 85 U 86 V 87 W */ + 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128, +/* 88 X 89 Y 90 Z 91 [ 92 \ 93 ] 94 ^ 95 _ */ + 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128, +/* 96 ` 97 a 98 b 99 c 100 d 101 e 102 f 103 g */ + 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128, +/* 104 h 105 i 106 j 107 k 108 l 109 m 110 n 111 o */ + 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128, +/* 112 p 113 q 114 r 115 s 116 t 117 u 118 v 119 w */ + 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128, +/* 120 x 121 y 122 z 123 { 124 | 125 } 126 ~ 127 del */ + 1 | 2 | 4 | 8 | 16 | 32 | 64 | 0, }; + +#undef T + +enum state + { s_dead = 1 /* important that this is > 0 */ + + , s_start_req_or_res + , s_res_or_resp_H + , s_start_res + , s_res_H + , s_res_HT + , s_res_HTT + , s_res_HTTP + , s_res_http_major + , s_res_http_dot + , s_res_http_minor + , s_res_http_end + , s_res_first_status_code + , s_res_status_code + , s_res_status_start + , s_res_status + , s_res_line_almost_done + + , s_start_req + + , s_req_method + , s_req_spaces_before_url + , s_req_schema + , s_req_schema_slash + , s_req_schema_slash_slash + , s_req_server_start + , s_req_server + , s_req_server_with_at + , s_req_path + , s_req_query_string_start + , s_req_query_string + , s_req_fragment_start + , s_req_fragment + , s_req_http_start + , s_req_http_H + , s_req_http_HT + , s_req_http_HTT + , s_req_http_HTTP + , s_req_http_major + , s_req_http_dot + , s_req_http_minor + , s_req_http_end + , s_req_line_almost_done + + , s_header_field_start + , s_header_field + , s_header_value_discard_ws + , s_header_value_discard_ws_almost_done + , s_header_value_discard_lws + , s_header_value_start + , s_header_value + , s_header_value_lws + + , s_header_almost_done + + , s_chunk_size_start + , s_chunk_size + , s_chunk_parameters + , s_chunk_size_almost_done + + , s_headers_almost_done + , s_headers_done + + /* Important: 's_headers_done' must be the last 'header' state. All + * states beyond this must be 'body' states. It is used for overflow + * checking. See the PARSING_HEADER() macro. + */ + + , s_chunk_data + , s_chunk_data_almost_done + , s_chunk_data_done + + , s_body_identity + , s_body_identity_eof + + , s_message_done + }; + + +#define PARSING_HEADER(state) (state <= s_headers_done) + + +enum header_states + { h_general = 0 + , h_C + , h_CO + , h_CON + + , h_matching_connection + , h_matching_proxy_connection + , h_matching_content_length + , h_matching_transfer_encoding + , h_matching_upgrade + + , h_connection + , h_content_length + , h_transfer_encoding + , h_upgrade + + , h_matching_transfer_encoding_chunked + , h_matching_connection_token_start + , h_matching_connection_keep_alive + , h_matching_connection_close + , h_matching_connection_upgrade + , h_matching_connection_token + + , h_transfer_encoding_chunked + , h_connection_keep_alive + , h_connection_close + , h_connection_upgrade + }; + +enum http_host_state + { + s_http_host_dead = 1 + , s_http_userinfo_start + , s_http_userinfo + , s_http_host_start + , s_http_host_v6_start + , s_http_host + , s_http_host_v6 + , s_http_host_v6_end + , s_http_host_v6_zone_start + , s_http_host_v6_zone + , s_http_host_port_start + , s_http_host_port +}; + +/* Macros for character classes; depends on strict-mode */ +#define CR '\r' +#define LF '\n' +#define LOWER(c) (unsigned char)(c | 0x20) +#define IS_ALPHA(c) (LOWER(c) >= 'a' && LOWER(c) <= 'z') +#define IS_NUM(c) ((c) >= '0' && (c) <= '9') +#define IS_ALPHANUM(c) (IS_ALPHA(c) || IS_NUM(c)) +#define IS_HEX(c) (IS_NUM(c) || (LOWER(c) >= 'a' && LOWER(c) <= 'f')) +#define IS_MARK(c) ((c) == '-' || (c) == '_' || (c) == '.' || \ + (c) == '!' || (c) == '~' || (c) == '*' || (c) == '\'' || (c) == '(' || \ + (c) == ')') +#define IS_USERINFO_CHAR(c) (IS_ALPHANUM(c) || IS_MARK(c) || (c) == '%' || \ + (c) == ';' || (c) == ':' || (c) == '&' || (c) == '=' || (c) == '+' || \ + (c) == '$' || (c) == ',') + +#define STRICT_TOKEN(c) (tokens[(unsigned char)c]) + +#if HTTP_PARSER_STRICT +#define TOKEN(c) (tokens[(unsigned char)c]) +#define IS_URL_CHAR(c) (BIT_AT(normal_url_char, (unsigned char)c)) +#define IS_HOST_CHAR(c) (IS_ALPHANUM(c) || (c) == '.' || (c) == '-') +#else +#define TOKEN(c) ((c == ' ') ? ' ' : tokens[(unsigned char)c]) +#define IS_URL_CHAR(c) \ + (BIT_AT(normal_url_char, (unsigned char)c) || ((c) & 0x80)) +#define IS_HOST_CHAR(c) \ + (IS_ALPHANUM(c) || (c) == '.' || (c) == '-' || (c) == '_') +#endif + +/** + * Verify that a char is a valid visible (printable) US-ASCII + * character or %x80-FF + **/ +#define IS_HEADER_CHAR(ch) \ + (ch == CR || ch == LF || ch == 9 || ((unsigned char)ch > 31 && ch != 127)) + +#define start_state (parser->type == HTTP_REQUEST ? s_start_req : s_start_res) + + +#if HTTP_PARSER_STRICT +# define STRICT_CHECK(cond) \ +do { \ + if (cond) { \ + SET_ERRNO(HPE_STRICT); \ + goto error; \ + } \ +} while (0) +# define NEW_MESSAGE() (http_should_keep_alive(parser) ? start_state : s_dead) +#else +# define STRICT_CHECK(cond) +# define NEW_MESSAGE() start_state +#endif + + +/* Map errno values to strings for human-readable output */ +#define HTTP_STRERROR_GEN(n, s) { "HPE_" #n, s }, +static struct { + const char *name; + const char *description; +} http_strerror_tab[] = { + HTTP_ERRNO_MAP(HTTP_STRERROR_GEN) +}; +#undef HTTP_STRERROR_GEN + +int http_message_needs_eof(const http_parser *parser); + +/* Our URL parser. + * + * This is designed to be shared by http_parser_execute() for URL validation, + * hence it has a state transition + byte-for-byte interface. In addition, it + * is meant to be embedded in http_parser_parse_url(), which does the dirty + * work of turning state transitions URL components for its API. + * + * This function should only be invoked with non-space characters. It is + * assumed that the caller cares about (and can detect) the transition between + * URL and non-URL states by looking for these. + */ +static enum state +parse_url_char(enum state s, const char ch) +{ + if (ch == ' ' || ch == '\r' || ch == '\n') { + return s_dead; + } + +#if HTTP_PARSER_STRICT + if (ch == '\t' || ch == '\f') { + return s_dead; + } +#endif + + switch (s) { + case s_req_spaces_before_url: + /* Proxied requests are followed by scheme of an absolute URI (alpha). + * All methods except CONNECT are followed by '/' or '*'. + */ + + if (ch == '/' || ch == '*') { + return s_req_path; + } + + if (IS_ALPHA(ch)) { + return s_req_schema; + } + + break; + + case s_req_schema: + if (IS_ALPHA(ch)) { + return s; + } + + if (ch == ':') { + return s_req_schema_slash; + } + + break; + + case s_req_schema_slash: + if (ch == '/') { + return s_req_schema_slash_slash; + } + + break; + + case s_req_schema_slash_slash: + if (ch == '/') { + return s_req_server_start; + } + + break; + + case s_req_server_with_at: + if (ch == '@') { + return s_dead; + } + + /* FALLTHROUGH */ + case s_req_server_start: + case s_req_server: + if (ch == '/') { + return s_req_path; + } + + if (ch == '?') { + return s_req_query_string_start; + } + + if (ch == '@') { + return s_req_server_with_at; + } + + if (IS_USERINFO_CHAR(ch) || ch == '[' || ch == ']') { + return s_req_server; + } + + break; + + case s_req_path: + if (IS_URL_CHAR(ch)) { + return s; + } + + switch (ch) { + case '?': + return s_req_query_string_start; + + case '#': + return s_req_fragment_start; + } + + break; + + case s_req_query_string_start: + case s_req_query_string: + if (IS_URL_CHAR(ch)) { + return s_req_query_string; + } + + switch (ch) { + case '?': + /* allow extra '?' in query string */ + return s_req_query_string; + + case '#': + return s_req_fragment_start; + } + + break; + + case s_req_fragment_start: + if (IS_URL_CHAR(ch)) { + return s_req_fragment; + } + + switch (ch) { + case '?': + return s_req_fragment; + + case '#': + return s; + } + + break; + + case s_req_fragment: + if (IS_URL_CHAR(ch)) { + return s; + } + + switch (ch) { + case '?': + case '#': + return s; + } + + break; + + default: + break; + } + + /* We should never fall out of the switch above unless there's an error */ + return s_dead; +} + +size_t http_parser_execute (http_parser *parser, + const http_parser_settings *settings, + const char *data, + size_t len) +{ + char c, ch; + int8_t unhex_val; + const char *p = data; + const char *header_field_mark = 0; + const char *header_value_mark = 0; + const char *url_mark = 0; + const char *body_mark = 0; + const char *status_mark = 0; + enum state p_state = (enum state) parser->state; + const unsigned int lenient = parser->lenient_http_headers; + + /* We're in an error state. Don't bother doing anything. */ + if (HTTP_PARSER_ERRNO(parser) != HPE_OK) { + return 0; + } + + if (len == 0) { + switch (CURRENT_STATE()) { + case s_body_identity_eof: + /* Use of CALLBACK_NOTIFY() here would erroneously return 1 byte read if + * we got paused. + */ + CALLBACK_NOTIFY_NOADVANCE(message_complete); + return 0; + + case s_dead: + case s_start_req_or_res: + case s_start_res: + case s_start_req: + return 0; + + default: + SET_ERRNO(HPE_INVALID_EOF_STATE); + return 1; + } + } + + + if (CURRENT_STATE() == s_header_field) + header_field_mark = data; + if (CURRENT_STATE() == s_header_value) + header_value_mark = data; + switch (CURRENT_STATE()) { + case s_req_path: + case s_req_schema: + case s_req_schema_slash: + case s_req_schema_slash_slash: + case s_req_server_start: + case s_req_server: + case s_req_server_with_at: + case s_req_query_string_start: + case s_req_query_string: + case s_req_fragment_start: + case s_req_fragment: + url_mark = data; + break; + case s_res_status: + status_mark = data; + break; + default: + break; + } + + for (p=data; p != data + len; p++) { + ch = *p; + + if (PARSING_HEADER(CURRENT_STATE())) + COUNT_HEADER_SIZE(1); + +reexecute: + switch (CURRENT_STATE()) { + + case s_dead: + /* this state is used after a 'Connection: close' message + * the parser will error out if it reads another message + */ + if (LIKELY(ch == CR || ch == LF)) + break; + + SET_ERRNO(HPE_CLOSED_CONNECTION); + goto error; + + case s_start_req_or_res: + { + if (ch == CR || ch == LF) + break; + parser->flags = 0; + parser->content_length = ULLONG_MAX; + + if (ch == 'H') { + UPDATE_STATE(s_res_or_resp_H); + + CALLBACK_NOTIFY(message_begin); + } else { + parser->type = HTTP_REQUEST; + UPDATE_STATE(s_start_req); + REEXECUTE(); + } + + break; + } + + case s_res_or_resp_H: + if (ch == 'T') { + parser->type = HTTP_RESPONSE; + UPDATE_STATE(s_res_HT); + } else { + if (UNLIKELY(ch != 'E')) { + SET_ERRNO(HPE_INVALID_CONSTANT); + goto error; + } + + parser->type = HTTP_REQUEST; + parser->method = HTTP_HEAD; + parser->index = 2; + UPDATE_STATE(s_req_method); + } + break; + + case s_start_res: + { + parser->flags = 0; + parser->content_length = ULLONG_MAX; + + switch (ch) { + case 'H': + UPDATE_STATE(s_res_H); + break; + + case CR: + case LF: + break; + + default: + SET_ERRNO(HPE_INVALID_CONSTANT); + goto error; + } + + CALLBACK_NOTIFY(message_begin); + break; + } + + case s_res_H: + STRICT_CHECK(ch != 'T'); + UPDATE_STATE(s_res_HT); + break; + + case s_res_HT: + STRICT_CHECK(ch != 'T'); + UPDATE_STATE(s_res_HTT); + break; + + case s_res_HTT: + STRICT_CHECK(ch != 'P'); + UPDATE_STATE(s_res_HTTP); + break; + + case s_res_HTTP: + STRICT_CHECK(ch != '/'); + UPDATE_STATE(s_res_http_major); + break; + + case s_res_http_major: + if (UNLIKELY(!IS_NUM(ch))) { + SET_ERRNO(HPE_INVALID_VERSION); + goto error; + } + + parser->http_major = ch - '0'; + UPDATE_STATE(s_res_http_dot); + break; + + case s_res_http_dot: + { + if (UNLIKELY(ch != '.')) { + SET_ERRNO(HPE_INVALID_VERSION); + goto error; + } + + UPDATE_STATE(s_res_http_minor); + break; + } + + case s_res_http_minor: + if (UNLIKELY(!IS_NUM(ch))) { + SET_ERRNO(HPE_INVALID_VERSION); + goto error; + } + + parser->http_minor = ch - '0'; + UPDATE_STATE(s_res_http_end); + break; + + case s_res_http_end: + { + if (UNLIKELY(ch != ' ')) { + SET_ERRNO(HPE_INVALID_VERSION); + goto error; + } + + UPDATE_STATE(s_res_first_status_code); + break; + } + + case s_res_first_status_code: + { + if (!IS_NUM(ch)) { + if (ch == ' ') { + break; + } + + SET_ERRNO(HPE_INVALID_STATUS); + goto error; + } + parser->status_code = ch - '0'; + UPDATE_STATE(s_res_status_code); + break; + } + + case s_res_status_code: + { + if (!IS_NUM(ch)) { + switch (ch) { + case ' ': + UPDATE_STATE(s_res_status_start); + break; + case CR: + case LF: + UPDATE_STATE(s_res_status_start); + REEXECUTE(); + break; + default: + SET_ERRNO(HPE_INVALID_STATUS); + goto error; + } + break; + } + + parser->status_code *= 10; + parser->status_code += ch - '0'; + + if (UNLIKELY(parser->status_code > 999)) { + SET_ERRNO(HPE_INVALID_STATUS); + goto error; + } + + break; + } + + case s_res_status_start: + { + MARK(status); + UPDATE_STATE(s_res_status); + parser->index = 0; + + if (ch == CR || ch == LF) + REEXECUTE(); + + break; + } + + case s_res_status: + if (ch == CR) { + UPDATE_STATE(s_res_line_almost_done); + CALLBACK_DATA(status); + break; + } + + if (ch == LF) { + UPDATE_STATE(s_header_field_start); + CALLBACK_DATA(status); + break; + } + + break; + + case s_res_line_almost_done: + STRICT_CHECK(ch != LF); + UPDATE_STATE(s_header_field_start); + break; + + case s_start_req: + { + if (ch == CR || ch == LF) + break; + parser->flags = 0; + parser->content_length = ULLONG_MAX; + + if (UNLIKELY(!IS_ALPHA(ch))) { + SET_ERRNO(HPE_INVALID_METHOD); + goto error; + } + + parser->method = (enum http_method) 0; + parser->index = 1; + switch (ch) { + case 'A': parser->method = HTTP_ACL; break; + case 'B': parser->method = HTTP_BIND; break; + case 'C': parser->method = HTTP_CONNECT; /* or COPY, CHECKOUT */ break; + case 'D': parser->method = HTTP_DELETE; break; + case 'G': parser->method = HTTP_GET; break; + case 'H': parser->method = HTTP_HEAD; break; + case 'L': parser->method = HTTP_LOCK; /* or LINK */ break; + case 'M': parser->method = HTTP_MKCOL; /* or MOVE, MKACTIVITY, MERGE, M-SEARCH, MKCALENDAR */ break; + case 'N': parser->method = HTTP_NOTIFY; break; + case 'O': parser->method = HTTP_OPTIONS; break; + case 'P': parser->method = HTTP_POST; + /* or PROPFIND|PROPPATCH|PUT|PATCH|PURGE */ + break; + case 'R': parser->method = HTTP_REPORT; /* or REBIND */ break; + case 'S': parser->method = HTTP_SUBSCRIBE; /* or SEARCH */ break; + case 'T': parser->method = HTTP_TRACE; break; + case 'U': parser->method = HTTP_UNLOCK; /* or UNSUBSCRIBE, UNBIND, UNLINK */ break; + default: + SET_ERRNO(HPE_INVALID_METHOD); + goto error; + } + UPDATE_STATE(s_req_method); + + CALLBACK_NOTIFY(message_begin); + + break; + } + + case s_req_method: + { + const char *matcher; + if (UNLIKELY(ch == '\0')) { + SET_ERRNO(HPE_INVALID_METHOD); + goto error; + } + + matcher = method_strings[parser->method]; + if (ch == ' ' && matcher[parser->index] == '\0') { + UPDATE_STATE(s_req_spaces_before_url); + } else if (ch == matcher[parser->index]) { + ; /* nada */ + } else if ((ch >= 'A' && ch <= 'Z') || ch == '-') { + + switch (parser->method << 16 | parser->index << 8 | ch) { +#define XX(meth, pos, ch, new_meth) \ + case (HTTP_##meth << 16 | pos << 8 | ch): \ + parser->method = HTTP_##new_meth; break; + + XX(POST, 1, 'U', PUT) + XX(POST, 1, 'A', PATCH) + XX(POST, 1, 'R', PROPFIND) + XX(PUT, 2, 'R', PURGE) + XX(CONNECT, 1, 'H', CHECKOUT) + XX(CONNECT, 2, 'P', COPY) + XX(MKCOL, 1, 'O', MOVE) + XX(MKCOL, 1, 'E', MERGE) + XX(MKCOL, 1, '-', MSEARCH) + XX(MKCOL, 2, 'A', MKACTIVITY) + XX(MKCOL, 3, 'A', MKCALENDAR) + XX(SUBSCRIBE, 1, 'E', SEARCH) + XX(REPORT, 2, 'B', REBIND) + XX(PROPFIND, 4, 'P', PROPPATCH) + XX(LOCK, 1, 'I', LINK) + XX(UNLOCK, 2, 'S', UNSUBSCRIBE) + XX(UNLOCK, 2, 'B', UNBIND) + XX(UNLOCK, 3, 'I', UNLINK) +#undef XX + default: + SET_ERRNO(HPE_INVALID_METHOD); + goto error; + } + } else { + SET_ERRNO(HPE_INVALID_METHOD); + goto error; + } + + ++parser->index; + break; + } + + case s_req_spaces_before_url: + { + if (ch == ' ') break; + + MARK(url); + if (parser->method == HTTP_CONNECT) { + UPDATE_STATE(s_req_server_start); + } + + UPDATE_STATE(parse_url_char(CURRENT_STATE(), ch)); + if (UNLIKELY(CURRENT_STATE() == s_dead)) { + SET_ERRNO(HPE_INVALID_URL); + goto error; + } + + break; + } + + case s_req_schema: + case s_req_schema_slash: + case s_req_schema_slash_slash: + case s_req_server_start: + { + switch (ch) { + /* No whitespace allowed here */ + case ' ': + case CR: + case LF: + SET_ERRNO(HPE_INVALID_URL); + goto error; + default: + UPDATE_STATE(parse_url_char(CURRENT_STATE(), ch)); + if (UNLIKELY(CURRENT_STATE() == s_dead)) { + SET_ERRNO(HPE_INVALID_URL); + goto error; + } + } + + break; + } + + case s_req_server: + case s_req_server_with_at: + case s_req_path: + case s_req_query_string_start: + case s_req_query_string: + case s_req_fragment_start: + case s_req_fragment: + { + switch (ch) { + case ' ': + UPDATE_STATE(s_req_http_start); + CALLBACK_DATA(url); + break; + case CR: + case LF: + parser->http_major = 0; + parser->http_minor = 9; + UPDATE_STATE((ch == CR) ? + s_req_line_almost_done : + s_header_field_start); + CALLBACK_DATA(url); + break; + default: + UPDATE_STATE(parse_url_char(CURRENT_STATE(), ch)); + if (UNLIKELY(CURRENT_STATE() == s_dead)) { + SET_ERRNO(HPE_INVALID_URL); + goto error; + } + } + break; + } + + case s_req_http_start: + switch (ch) { + case 'H': + UPDATE_STATE(s_req_http_H); + break; + case ' ': + break; + default: + SET_ERRNO(HPE_INVALID_CONSTANT); + goto error; + } + break; + + case s_req_http_H: + STRICT_CHECK(ch != 'T'); + UPDATE_STATE(s_req_http_HT); + break; + + case s_req_http_HT: + STRICT_CHECK(ch != 'T'); + UPDATE_STATE(s_req_http_HTT); + break; + + case s_req_http_HTT: + STRICT_CHECK(ch != 'P'); + UPDATE_STATE(s_req_http_HTTP); + break; + + case s_req_http_HTTP: + STRICT_CHECK(ch != '/'); + UPDATE_STATE(s_req_http_major); + break; + + case s_req_http_major: + if (UNLIKELY(!IS_NUM(ch))) { + SET_ERRNO(HPE_INVALID_VERSION); + goto error; + } + + parser->http_major = ch - '0'; + UPDATE_STATE(s_req_http_dot); + break; + + case s_req_http_dot: + { + if (UNLIKELY(ch != '.')) { + SET_ERRNO(HPE_INVALID_VERSION); + goto error; + } + + UPDATE_STATE(s_req_http_minor); + break; + } + + case s_req_http_minor: + if (UNLIKELY(!IS_NUM(ch))) { + SET_ERRNO(HPE_INVALID_VERSION); + goto error; + } + + parser->http_minor = ch - '0'; + UPDATE_STATE(s_req_http_end); + break; + + case s_req_http_end: + { + if (ch == CR) { + UPDATE_STATE(s_req_line_almost_done); + break; + } + + if (ch == LF) { + UPDATE_STATE(s_header_field_start); + break; + } + + SET_ERRNO(HPE_INVALID_VERSION); + goto error; + break; + } + + /* end of request line */ + case s_req_line_almost_done: + { + if (UNLIKELY(ch != LF)) { + SET_ERRNO(HPE_LF_EXPECTED); + goto error; + } + + UPDATE_STATE(s_header_field_start); + break; + } + + case s_header_field_start: + { + if (ch == CR) { + UPDATE_STATE(s_headers_almost_done); + break; + } + + if (ch == LF) { + /* they might be just sending \n instead of \r\n so this would be + * the second \n to denote the end of headers*/ + UPDATE_STATE(s_headers_almost_done); + REEXECUTE(); + } + + c = TOKEN(ch); + + if (UNLIKELY(!c)) { + SET_ERRNO(HPE_INVALID_HEADER_TOKEN); + goto error; + } + + MARK(header_field); + + parser->index = 0; + UPDATE_STATE(s_header_field); + + switch (c) { + case 'c': + parser->header_state = h_C; + break; + + case 'p': + parser->header_state = h_matching_proxy_connection; + break; + + case 't': + parser->header_state = h_matching_transfer_encoding; + break; + + case 'u': + parser->header_state = h_matching_upgrade; + break; + + default: + parser->header_state = h_general; + break; + } + break; + } + + case s_header_field: + { + const char* start = p; + for (; p != data + len; p++) { + ch = *p; + c = TOKEN(ch); + + if (!c) + break; + + switch (parser->header_state) { + case h_general: + break; + + case h_C: + parser->index++; + parser->header_state = (c == 'o' ? h_CO : h_general); + break; + + case h_CO: + parser->index++; + parser->header_state = (c == 'n' ? h_CON : h_general); + break; + + case h_CON: + parser->index++; + switch (c) { + case 'n': + parser->header_state = h_matching_connection; + break; + case 't': + parser->header_state = h_matching_content_length; + break; + default: + parser->header_state = h_general; + break; + } + break; + + /* connection */ + + case h_matching_connection: + parser->index++; + if (parser->index > sizeof(CONNECTION)-1 + || c != CONNECTION[parser->index]) { + parser->header_state = h_general; + } else if (parser->index == sizeof(CONNECTION)-2) { + parser->header_state = h_connection; + } + break; + + /* proxy-connection */ + + case h_matching_proxy_connection: + parser->index++; + if (parser->index > sizeof(PROXY_CONNECTION)-1 + || c != PROXY_CONNECTION[parser->index]) { + parser->header_state = h_general; + } else if (parser->index == sizeof(PROXY_CONNECTION)-2) { + parser->header_state = h_connection; + } + break; + + /* content-length */ + + case h_matching_content_length: + parser->index++; + if (parser->index > sizeof(CONTENT_LENGTH)-1 + || c != CONTENT_LENGTH[parser->index]) { + parser->header_state = h_general; + } else if (parser->index == sizeof(CONTENT_LENGTH)-2) { + parser->header_state = h_content_length; + } + break; + + /* transfer-encoding */ + + case h_matching_transfer_encoding: + parser->index++; + if (parser->index > sizeof(TRANSFER_ENCODING)-1 + || c != TRANSFER_ENCODING[parser->index]) { + parser->header_state = h_general; + } else if (parser->index == sizeof(TRANSFER_ENCODING)-2) { + parser->header_state = h_transfer_encoding; + } + break; + + /* upgrade */ + + case h_matching_upgrade: + parser->index++; + if (parser->index > sizeof(UPGRADE)-1 + || c != UPGRADE[parser->index]) { + parser->header_state = h_general; + } else if (parser->index == sizeof(UPGRADE)-2) { + parser->header_state = h_upgrade; + } + break; + + case h_connection: + case h_content_length: + case h_transfer_encoding: + case h_upgrade: + if (ch != ' ') parser->header_state = h_general; + break; + + default: + assert(0 && "Unknown header_state"); + break; + } + } + + COUNT_HEADER_SIZE(p - start); + + if (p == data + len) { + --p; + break; + } + + if (ch == ':') { + UPDATE_STATE(s_header_value_discard_ws); + CALLBACK_DATA(header_field); + break; + } + + SET_ERRNO(HPE_INVALID_HEADER_TOKEN); + goto error; + } + + case s_header_value_discard_ws: + if (ch == ' ' || ch == '\t') break; + + if (ch == CR) { + UPDATE_STATE(s_header_value_discard_ws_almost_done); + break; + } + + if (ch == LF) { + UPDATE_STATE(s_header_value_discard_lws); + break; + } + + /* FALLTHROUGH */ + + case s_header_value_start: + { + MARK(header_value); + + UPDATE_STATE(s_header_value); + parser->index = 0; + + c = LOWER(ch); + + switch (parser->header_state) { + case h_upgrade: + parser->flags |= F_UPGRADE; + parser->header_state = h_general; + break; + + case h_transfer_encoding: + /* looking for 'Transfer-Encoding: chunked' */ + if ('c' == c) { + parser->header_state = h_matching_transfer_encoding_chunked; + } else { + parser->header_state = h_general; + } + break; + + case h_content_length: + if (UNLIKELY(!IS_NUM(ch))) { + SET_ERRNO(HPE_INVALID_CONTENT_LENGTH); + goto error; + } + + if (parser->flags & F_CONTENTLENGTH) { + SET_ERRNO(HPE_UNEXPECTED_CONTENT_LENGTH); + goto error; + } + + parser->flags |= F_CONTENTLENGTH; + parser->content_length = ch - '0'; + break; + + case h_connection: + /* looking for 'Connection: keep-alive' */ + if (c == 'k') { + parser->header_state = h_matching_connection_keep_alive; + /* looking for 'Connection: close' */ + } else if (c == 'c') { + parser->header_state = h_matching_connection_close; + } else if (c == 'u') { + parser->header_state = h_matching_connection_upgrade; + } else { + parser->header_state = h_matching_connection_token; + } + break; + + /* Multi-value `Connection` header */ + case h_matching_connection_token_start: + break; + + default: + parser->header_state = h_general; + break; + } + break; + } + + case s_header_value: + { + const char* start = p; + enum header_states h_state = (enum header_states) parser->header_state; + for (; p != data + len; p++) { + ch = *p; + if (ch == CR) { + UPDATE_STATE(s_header_almost_done); + parser->header_state = h_state; + CALLBACK_DATA(header_value); + break; + } + + if (ch == LF) { + UPDATE_STATE(s_header_almost_done); + COUNT_HEADER_SIZE(p - start); + parser->header_state = h_state; + CALLBACK_DATA_NOADVANCE(header_value); + REEXECUTE(); + } + + if (!lenient && !IS_HEADER_CHAR(ch)) { + SET_ERRNO(HPE_INVALID_HEADER_TOKEN); + goto error; + } + + c = LOWER(ch); + + switch (h_state) { + case h_general: + { + const char* p_cr; + const char* p_lf; + size_t limit = data + len - p; + + limit = MIN(limit, HTTP_MAX_HEADER_SIZE); + + p_cr = (const char*) memchr(p, CR, limit); + p_lf = (const char*) memchr(p, LF, limit); + if (p_cr != NULL) { + if (p_lf != NULL && p_cr >= p_lf) + p = p_lf; + else + p = p_cr; + } else if (UNLIKELY(p_lf != NULL)) { + p = p_lf; + } else { + p = data + len; + } + --p; + + break; + } + + case h_connection: + case h_transfer_encoding: + assert(0 && "Shouldn't get here."); + break; + + case h_content_length: + { + uint64_t t; + + if (ch == ' ') break; + + if (UNLIKELY(!IS_NUM(ch))) { + SET_ERRNO(HPE_INVALID_CONTENT_LENGTH); + parser->header_state = h_state; + goto error; + } + + t = parser->content_length; + t *= 10; + t += ch - '0'; + + /* Overflow? Test against a conservative limit for simplicity. */ + if (UNLIKELY((ULLONG_MAX - 10) / 10 < parser->content_length)) { + SET_ERRNO(HPE_INVALID_CONTENT_LENGTH); + parser->header_state = h_state; + goto error; + } + + parser->content_length = t; + break; + } + + /* Transfer-Encoding: chunked */ + case h_matching_transfer_encoding_chunked: + parser->index++; + if (parser->index > sizeof(CHUNKED)-1 + || c != CHUNKED[parser->index]) { + h_state = h_general; + } else if (parser->index == sizeof(CHUNKED)-2) { + h_state = h_transfer_encoding_chunked; + } + break; + + case h_matching_connection_token_start: + /* looking for 'Connection: keep-alive' */ + if (c == 'k') { + h_state = h_matching_connection_keep_alive; + /* looking for 'Connection: close' */ + } else if (c == 'c') { + h_state = h_matching_connection_close; + } else if (c == 'u') { + h_state = h_matching_connection_upgrade; + } else if (STRICT_TOKEN(c)) { + h_state = h_matching_connection_token; + } else if (c == ' ' || c == '\t') { + /* Skip lws */ + } else { + h_state = h_general; + } + break; + + /* looking for 'Connection: keep-alive' */ + case h_matching_connection_keep_alive: + parser->index++; + if (parser->index > sizeof(KEEP_ALIVE)-1 + || c != KEEP_ALIVE[parser->index]) { + h_state = h_matching_connection_token; + } else if (parser->index == sizeof(KEEP_ALIVE)-2) { + h_state = h_connection_keep_alive; + } + break; + + /* looking for 'Connection: close' */ + case h_matching_connection_close: + parser->index++; + if (parser->index > sizeof(CLOSE)-1 || c != CLOSE[parser->index]) { + h_state = h_matching_connection_token; + } else if (parser->index == sizeof(CLOSE)-2) { + h_state = h_connection_close; + } + break; + + /* looking for 'Connection: upgrade' */ + case h_matching_connection_upgrade: + parser->index++; + if (parser->index > sizeof(UPGRADE) - 1 || + c != UPGRADE[parser->index]) { + h_state = h_matching_connection_token; + } else if (parser->index == sizeof(UPGRADE)-2) { + h_state = h_connection_upgrade; + } + break; + + case h_matching_connection_token: + if (ch == ',') { + h_state = h_matching_connection_token_start; + parser->index = 0; + } + break; + + case h_transfer_encoding_chunked: + if (ch != ' ') h_state = h_general; + break; + + case h_connection_keep_alive: + case h_connection_close: + case h_connection_upgrade: + if (ch == ',') { + if (h_state == h_connection_keep_alive) { + parser->flags |= F_CONNECTION_KEEP_ALIVE; + } else if (h_state == h_connection_close) { + parser->flags |= F_CONNECTION_CLOSE; + } else if (h_state == h_connection_upgrade) { + parser->flags |= F_CONNECTION_UPGRADE; + } + h_state = h_matching_connection_token_start; + parser->index = 0; + } else if (ch != ' ') { + h_state = h_matching_connection_token; + } + break; + + default: + UPDATE_STATE(s_header_value); + h_state = h_general; + break; + } + } + parser->header_state = h_state; + + COUNT_HEADER_SIZE(p - start); + + if (p == data + len) + --p; + break; + } + + case s_header_almost_done: + { + if (UNLIKELY(ch != LF)) { + SET_ERRNO(HPE_LF_EXPECTED); + goto error; + } + + UPDATE_STATE(s_header_value_lws); + break; + } + + case s_header_value_lws: + { + if (ch == ' ' || ch == '\t') { + UPDATE_STATE(s_header_value_start); + REEXECUTE(); + } + + /* finished the header */ + switch (parser->header_state) { + case h_connection_keep_alive: + parser->flags |= F_CONNECTION_KEEP_ALIVE; + break; + case h_connection_close: + parser->flags |= F_CONNECTION_CLOSE; + break; + case h_transfer_encoding_chunked: + parser->flags |= F_CHUNKED; + break; + case h_connection_upgrade: + parser->flags |= F_CONNECTION_UPGRADE; + break; + default: + break; + } + + UPDATE_STATE(s_header_field_start); + REEXECUTE(); + } + + case s_header_value_discard_ws_almost_done: + { + STRICT_CHECK(ch != LF); + UPDATE_STATE(s_header_value_discard_lws); + break; + } + + case s_header_value_discard_lws: + { + if (ch == ' ' || ch == '\t') { + UPDATE_STATE(s_header_value_discard_ws); + break; + } else { + switch (parser->header_state) { + case h_connection_keep_alive: + parser->flags |= F_CONNECTION_KEEP_ALIVE; + break; + case h_connection_close: + parser->flags |= F_CONNECTION_CLOSE; + break; + case h_connection_upgrade: + parser->flags |= F_CONNECTION_UPGRADE; + break; + case h_transfer_encoding_chunked: + parser->flags |= F_CHUNKED; + break; + default: + break; + } + + /* header value was empty */ + MARK(header_value); + UPDATE_STATE(s_header_field_start); + CALLBACK_DATA_NOADVANCE(header_value); + REEXECUTE(); + } + } + + case s_headers_almost_done: + { + STRICT_CHECK(ch != LF); + + if (parser->flags & F_TRAILING) { + /* End of a chunked request */ + UPDATE_STATE(s_message_done); + CALLBACK_NOTIFY_NOADVANCE(chunk_complete); + REEXECUTE(); + } + + /* Cannot use chunked encoding and a content-length header together + per the HTTP specification. */ + if ((parser->flags & F_CHUNKED) && + (parser->flags & F_CONTENTLENGTH)) { + SET_ERRNO(HPE_UNEXPECTED_CONTENT_LENGTH); + goto error; + } + + UPDATE_STATE(s_headers_done); + + /* Set this here so that on_headers_complete() callbacks can see it */ + if ((parser->flags & F_UPGRADE) && + (parser->flags & F_CONNECTION_UPGRADE)) { + /* For responses, "Upgrade: foo" and "Connection: upgrade" are + * mandatory only when it is a 101 Switching Protocols response, + * otherwise it is purely informational, to announce support. + */ + parser->upgrade = + (parser->type == HTTP_REQUEST || parser->status_code == 101); + } else { + parser->upgrade = (parser->method == HTTP_CONNECT); + } + + /* Here we call the headers_complete callback. This is somewhat + * different than other callbacks because if the user returns 1, we + * will interpret that as saying that this message has no body. This + * is needed for the annoying case of recieving a response to a HEAD + * request. + * + * We'd like to use CALLBACK_NOTIFY_NOADVANCE() here but we cannot, so + * we have to simulate it by handling a change in errno below. + */ + if (settings->on_headers_complete) { + switch (settings->on_headers_complete(parser)) { + case 0: + break; + + case 2: + parser->upgrade = 1; + + /* FALLTHROUGH */ + case 1: + parser->flags |= F_SKIPBODY; + break; + + default: + SET_ERRNO(HPE_CB_headers_complete); + RETURN(p - data); /* Error */ + } + } + + if (HTTP_PARSER_ERRNO(parser) != HPE_OK) { + RETURN(p - data); + } + + REEXECUTE(); + } + + case s_headers_done: + { + int hasBody; + STRICT_CHECK(ch != LF); + + parser->nread = 0; + + hasBody = parser->flags & F_CHUNKED || + (parser->content_length > 0 && parser->content_length != ULLONG_MAX); + if (parser->upgrade && (parser->method == HTTP_CONNECT || + (parser->flags & F_SKIPBODY) || !hasBody)) { + /* Exit, the rest of the message is in a different protocol. */ + UPDATE_STATE(NEW_MESSAGE()); + CALLBACK_NOTIFY(message_complete); + RETURN((p - data) + 1); + } + + if (parser->flags & F_SKIPBODY) { + UPDATE_STATE(NEW_MESSAGE()); + CALLBACK_NOTIFY(message_complete); + } else if (parser->flags & F_CHUNKED) { + /* chunked encoding - ignore Content-Length header */ + UPDATE_STATE(s_chunk_size_start); + } else { + if (parser->content_length == 0) { + /* Content-Length header given but zero: Content-Length: 0\r\n */ + UPDATE_STATE(NEW_MESSAGE()); + CALLBACK_NOTIFY(message_complete); + } else if (parser->content_length != ULLONG_MAX) { + /* Content-Length header given and non-zero */ + UPDATE_STATE(s_body_identity); + } else { + if (!http_message_needs_eof(parser)) { + /* Assume content-length 0 - read the next */ + UPDATE_STATE(NEW_MESSAGE()); + CALLBACK_NOTIFY(message_complete); + } else { + /* Read body until EOF */ + UPDATE_STATE(s_body_identity_eof); + } + } + } + + break; + } + + case s_body_identity: + { + uint64_t to_read = MIN(parser->content_length, + (uint64_t) ((data + len) - p)); + + assert(parser->content_length != 0 + && parser->content_length != ULLONG_MAX); + + /* The difference between advancing content_length and p is because + * the latter will automaticaly advance on the next loop iteration. + * Further, if content_length ends up at 0, we want to see the last + * byte again for our message complete callback. + */ + MARK(body); + parser->content_length -= to_read; + p += to_read - 1; + + if (parser->content_length == 0) { + UPDATE_STATE(s_message_done); + + /* Mimic CALLBACK_DATA_NOADVANCE() but with one extra byte. + * + * The alternative to doing this is to wait for the next byte to + * trigger the data callback, just as in every other case. The + * problem with this is that this makes it difficult for the test + * harness to distinguish between complete-on-EOF and + * complete-on-length. It's not clear that this distinction is + * important for applications, but let's keep it for now. + */ + CALLBACK_DATA_(body, p - body_mark + 1, p - data); + REEXECUTE(); + } + + break; + } + + /* read until EOF */ + case s_body_identity_eof: + MARK(body); + p = data + len - 1; + + break; + + case s_message_done: + UPDATE_STATE(NEW_MESSAGE()); + CALLBACK_NOTIFY(message_complete); + if (parser->upgrade) { + /* Exit, the rest of the message is in a different protocol. */ + RETURN((p - data) + 1); + } + break; + + case s_chunk_size_start: + { + assert(parser->nread == 1); + assert(parser->flags & F_CHUNKED); + + unhex_val = unhex[(unsigned char)ch]; + if (UNLIKELY(unhex_val == -1)) { + SET_ERRNO(HPE_INVALID_CHUNK_SIZE); + goto error; + } + + parser->content_length = unhex_val; + UPDATE_STATE(s_chunk_size); + break; + } + + case s_chunk_size: + { + uint64_t t; + + assert(parser->flags & F_CHUNKED); + + if (ch == CR) { + UPDATE_STATE(s_chunk_size_almost_done); + break; + } + + unhex_val = unhex[(unsigned char)ch]; + + if (unhex_val == -1) { + if (ch == ';' || ch == ' ') { + UPDATE_STATE(s_chunk_parameters); + break; + } + + SET_ERRNO(HPE_INVALID_CHUNK_SIZE); + goto error; + } + + t = parser->content_length; + t *= 16; + t += unhex_val; + + /* Overflow? Test against a conservative limit for simplicity. */ + if (UNLIKELY((ULLONG_MAX - 16) / 16 < parser->content_length)) { + SET_ERRNO(HPE_INVALID_CONTENT_LENGTH); + goto error; + } + + parser->content_length = t; + break; + } + + case s_chunk_parameters: + { + assert(parser->flags & F_CHUNKED); + /* just ignore this shit. TODO check for overflow */ + if (ch == CR) { + UPDATE_STATE(s_chunk_size_almost_done); + break; + } + break; + } + + case s_chunk_size_almost_done: + { + assert(parser->flags & F_CHUNKED); + STRICT_CHECK(ch != LF); + + parser->nread = 0; + + if (parser->content_length == 0) { + parser->flags |= F_TRAILING; + UPDATE_STATE(s_header_field_start); + } else { + UPDATE_STATE(s_chunk_data); + } + CALLBACK_NOTIFY(chunk_header); + break; + } + + case s_chunk_data: + { + uint64_t to_read = MIN(parser->content_length, + (uint64_t) ((data + len) - p)); + + assert(parser->flags & F_CHUNKED); + assert(parser->content_length != 0 + && parser->content_length != ULLONG_MAX); + + /* See the explanation in s_body_identity for why the content + * length and data pointers are managed this way. + */ + MARK(body); + parser->content_length -= to_read; + p += to_read - 1; + + if (parser->content_length == 0) { + UPDATE_STATE(s_chunk_data_almost_done); + } + + break; + } + + case s_chunk_data_almost_done: + assert(parser->flags & F_CHUNKED); + assert(parser->content_length == 0); + STRICT_CHECK(ch != CR); + UPDATE_STATE(s_chunk_data_done); + CALLBACK_DATA(body); + break; + + case s_chunk_data_done: + assert(parser->flags & F_CHUNKED); + STRICT_CHECK(ch != LF); + parser->nread = 0; + UPDATE_STATE(s_chunk_size_start); + CALLBACK_NOTIFY(chunk_complete); + break; + + default: + assert(0 && "unhandled state"); + SET_ERRNO(HPE_INVALID_INTERNAL_STATE); + goto error; + } + } + + /* Run callbacks for any marks that we have leftover after we ran our of + * bytes. There should be at most one of these set, so it's OK to invoke + * them in series (unset marks will not result in callbacks). + * + * We use the NOADVANCE() variety of callbacks here because 'p' has already + * overflowed 'data' and this allows us to correct for the off-by-one that + * we'd otherwise have (since CALLBACK_DATA() is meant to be run with a 'p' + * value that's in-bounds). + */ + + assert(((header_field_mark ? 1 : 0) + + (header_value_mark ? 1 : 0) + + (url_mark ? 1 : 0) + + (body_mark ? 1 : 0) + + (status_mark ? 1 : 0)) <= 1); + + CALLBACK_DATA_NOADVANCE(header_field); + CALLBACK_DATA_NOADVANCE(header_value); + CALLBACK_DATA_NOADVANCE(url); + CALLBACK_DATA_NOADVANCE(body); + CALLBACK_DATA_NOADVANCE(status); + + RETURN(len); + +error: + if (HTTP_PARSER_ERRNO(parser) == HPE_OK) { + SET_ERRNO(HPE_UNKNOWN); + } + + RETURN(p - data); +} + + +/* Does the parser need to see an EOF to find the end of the message? */ +int +http_message_needs_eof (const http_parser *parser) +{ + if (parser->type == HTTP_REQUEST) { + return 0; + } + + /* See RFC 2616 section 4.4 */ + if (parser->status_code / 100 == 1 || /* 1xx e.g. Continue */ + parser->status_code == 204 || /* No Content */ + parser->status_code == 304 || /* Not Modified */ + parser->flags & F_SKIPBODY) { /* response to a HEAD request */ + return 0; + } + + if ((parser->flags & F_CHUNKED) || parser->content_length != ULLONG_MAX) { + return 0; + } + + return 1; +} + + +int +http_should_keep_alive (const http_parser *parser) +{ + if (parser->http_major > 0 && parser->http_minor > 0) { + /* HTTP/1.1 */ + if (parser->flags & F_CONNECTION_CLOSE) { + return 0; + } + } else { + /* HTTP/1.0 or earlier */ + if (!(parser->flags & F_CONNECTION_KEEP_ALIVE)) { + return 0; + } + } + + return !http_message_needs_eof(parser); +} + + +const char * +http_method_str (enum http_method m) +{ + return ELEM_AT(method_strings, m, ""); +} + + +void +http_parser_init (http_parser *parser, enum http_parser_type t) +{ + void *data = parser->data; /* preserve application data */ + memset(parser, 0, sizeof(*parser)); + parser->data = data; + parser->type = t; + parser->state = (t == HTTP_REQUEST ? s_start_req : (t == HTTP_RESPONSE ? s_start_res : s_start_req_or_res)); + parser->http_errno = HPE_OK; +} + +void +http_parser_settings_init(http_parser_settings *settings) +{ + memset(settings, 0, sizeof(*settings)); +} + +const char * +http_errno_name(enum http_errno err) { + assert(((size_t) err) < ARRAY_SIZE(http_strerror_tab)); + return http_strerror_tab[err].name; +} + +const char * +http_errno_description(enum http_errno err) { + assert(((size_t) err) < ARRAY_SIZE(http_strerror_tab)); + return http_strerror_tab[err].description; +} + +static enum http_host_state +http_parse_host_char(enum http_host_state s, const char ch) { + switch(s) { + case s_http_userinfo: + case s_http_userinfo_start: + if (ch == '@') { + return s_http_host_start; + } + + if (IS_USERINFO_CHAR(ch)) { + return s_http_userinfo; + } + break; + + case s_http_host_start: + if (ch == '[') { + return s_http_host_v6_start; + } + + if (IS_HOST_CHAR(ch)) { + return s_http_host; + } + + break; + + case s_http_host: + if (IS_HOST_CHAR(ch)) { + return s_http_host; + } + + /* FALLTHROUGH */ + case s_http_host_v6_end: + if (ch == ':') { + return s_http_host_port_start; + } + + break; + + case s_http_host_v6: + if (ch == ']') { + return s_http_host_v6_end; + } + + /* FALLTHROUGH */ + case s_http_host_v6_start: + if (IS_HEX(ch) || ch == ':' || ch == '.') { + return s_http_host_v6; + } + + if (s == s_http_host_v6 && ch == '%') { + return s_http_host_v6_zone_start; + } + break; + + case s_http_host_v6_zone: + if (ch == ']') { + return s_http_host_v6_end; + } + + /* FALLTHROUGH */ + case s_http_host_v6_zone_start: + /* RFC 6874 Zone ID consists of 1*( unreserved / pct-encoded) */ + if (IS_ALPHANUM(ch) || ch == '%' || ch == '.' || ch == '-' || ch == '_' || + ch == '~') { + return s_http_host_v6_zone; + } + break; + + case s_http_host_port: + case s_http_host_port_start: + if (IS_NUM(ch)) { + return s_http_host_port; + } + + break; + + default: + break; + } + return s_http_host_dead; +} + +static int +http_parse_host(const char * buf, struct http_parser_url *u, int found_at) { + enum http_host_state s; + + const char *p; + size_t buflen = u->field_data[UF_HOST].off + u->field_data[UF_HOST].len; + + assert(u->field_set & (1 << UF_HOST)); + + u->field_data[UF_HOST].len = 0; + + s = found_at ? s_http_userinfo_start : s_http_host_start; + + for (p = buf + u->field_data[UF_HOST].off; p < buf + buflen; p++) { + enum http_host_state new_s = http_parse_host_char(s, *p); + + if (new_s == s_http_host_dead) { + return 1; + } + + switch(new_s) { + case s_http_host: + if (s != s_http_host) { + u->field_data[UF_HOST].off = p - buf; + } + u->field_data[UF_HOST].len++; + break; + + case s_http_host_v6: + if (s != s_http_host_v6) { + u->field_data[UF_HOST].off = p - buf; + } + u->field_data[UF_HOST].len++; + break; + + case s_http_host_v6_zone_start: + case s_http_host_v6_zone: + u->field_data[UF_HOST].len++; + break; + + case s_http_host_port: + if (s != s_http_host_port) { + u->field_data[UF_PORT].off = p - buf; + u->field_data[UF_PORT].len = 0; + u->field_set |= (1 << UF_PORT); + } + u->field_data[UF_PORT].len++; + break; + + case s_http_userinfo: + if (s != s_http_userinfo) { + u->field_data[UF_USERINFO].off = p - buf ; + u->field_data[UF_USERINFO].len = 0; + u->field_set |= (1 << UF_USERINFO); + } + u->field_data[UF_USERINFO].len++; + break; + + default: + break; + } + s = new_s; + } + + /* Make sure we don't end somewhere unexpected */ + switch (s) { + case s_http_host_start: + case s_http_host_v6_start: + case s_http_host_v6: + case s_http_host_v6_zone_start: + case s_http_host_v6_zone: + case s_http_host_port_start: + case s_http_userinfo: + case s_http_userinfo_start: + return 1; + default: + break; + } + + return 0; +} + +void +http_parser_url_init(struct http_parser_url *u) { + memset(u, 0, sizeof(*u)); +} + +int +http_parser_parse_url(const char *buf, size_t buflen, int is_connect, + struct http_parser_url *u) +{ + enum state s; + const char *p; + enum http_parser_url_fields uf, old_uf; + int found_at = 0; + + u->port = u->field_set = 0; + s = is_connect ? s_req_server_start : s_req_spaces_before_url; + old_uf = UF_MAX; + + for (p = buf; p < buf + buflen; p++) { + s = parse_url_char(s, *p); + + /* Figure out the next field that we're operating on */ + switch (s) { + case s_dead: + return 1; + + /* Skip delimeters */ + case s_req_schema_slash: + case s_req_schema_slash_slash: + case s_req_server_start: + case s_req_query_string_start: + case s_req_fragment_start: + continue; + + case s_req_schema: + uf = UF_SCHEMA; + break; + + case s_req_server_with_at: + found_at = 1; + + /* FALLTHROUGH */ + case s_req_server: + uf = UF_HOST; + break; + + case s_req_path: + uf = UF_PATH; + break; + + case s_req_query_string: + uf = UF_QUERY; + break; + + case s_req_fragment: + uf = UF_FRAGMENT; + break; + + default: + assert(!"Unexpected state"); + return 1; + } + + /* Nothing's changed; soldier on */ + if (uf == old_uf) { + u->field_data[uf].len++; + continue; + } + + u->field_data[uf].off = p - buf; + u->field_data[uf].len = 1; + + u->field_set |= (1 << uf); + old_uf = uf; + } + + /* host must be present if there is a schema */ + /* parsing http:///toto will fail */ + if ((u->field_set & (1 << UF_SCHEMA)) && + (u->field_set & (1 << UF_HOST)) == 0) { + return 1; + } + + if (u->field_set & (1 << UF_HOST)) { + if (http_parse_host(buf, u, found_at) != 0) { + return 1; + } + } + + /* CONNECT requests can only contain "hostname:port" */ + if (is_connect && u->field_set != ((1 << UF_HOST)|(1 << UF_PORT))) { + return 1; + } + + if (u->field_set & (1 << UF_PORT)) { + /* Don't bother with endp; we've already validated the string */ + unsigned long v = strtoul(buf + u->field_data[UF_PORT].off, NULL, 10); + + /* Ports have a max value of 2^16 */ + if (v > 0xffff) { + return 1; + } + + u->port = (uint16_t) v; + } + + return 0; +} + +void +http_parser_pause(http_parser *parser, int paused) { + /* Users should only be pausing/unpausing a parser that is not in an error + * state. In non-debug builds, there's not much that we can do about this + * other than ignore it. + */ + if (HTTP_PARSER_ERRNO(parser) == HPE_OK || + HTTP_PARSER_ERRNO(parser) == HPE_PAUSED) { + SET_ERRNO((paused) ? HPE_PAUSED : HPE_OK); + } else { + assert(0 && "Attempting to pause parser in error state"); + } +} + +int +http_body_is_final(const struct http_parser *parser) { + return parser->state == s_message_done; +} + +unsigned long +http_parser_version(void) { + return HTTP_PARSER_VERSION_MAJOR * 0x10000 | + HTTP_PARSER_VERSION_MINOR * 0x00100 | + HTTP_PARSER_VERSION_PATCH * 0x00001; +} diff --git a/src/http/3rdparty/http-parser/http_parser.h b/src/http/3rdparty/http-parser/http_parser.h new file mode 100644 index 0000000..fd2a564 --- /dev/null +++ b/src/http/3rdparty/http-parser/http_parser.h @@ -0,0 +1,431 @@ +/* Copyright Joyent, Inc. and other Node contributors. All rights reserved. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ +#ifndef http_parser_h +#define http_parser_h +#ifdef __cplusplus +extern "C" { +#endif + +/* Also update SONAME in the Makefile whenever you change these. */ +#define HTTP_PARSER_VERSION_MAJOR 2 +#define HTTP_PARSER_VERSION_MINOR 7 +#define HTTP_PARSER_VERSION_PATCH 1 + +#include +#if defined(_WIN32) && !defined(__MINGW32__) && \ + (!defined(_MSC_VER) || _MSC_VER<1600) && !defined(__WINE__) +#include +typedef __int8 int8_t; +typedef unsigned __int8 uint8_t; +typedef __int16 int16_t; +typedef unsigned __int16 uint16_t; +typedef __int32 int32_t; +typedef unsigned __int32 uint32_t; +typedef __int64 int64_t; +typedef unsigned __int64 uint64_t; +#else +#include +#endif + +/* Compile with -DHTTP_PARSER_STRICT=0 to make less checks, but run + * faster + */ +#ifndef HTTP_PARSER_STRICT +# define HTTP_PARSER_STRICT 1 +#endif + +/* Maximium header size allowed. If the macro is not defined + * before including this header then the default is used. To + * change the maximum header size, define the macro in the build + * environment (e.g. -DHTTP_MAX_HEADER_SIZE=). To remove + * the effective limit on the size of the header, define the macro + * to a very large number (e.g. -DHTTP_MAX_HEADER_SIZE=0x7fffffff) + */ +#ifndef HTTP_MAX_HEADER_SIZE +# define HTTP_MAX_HEADER_SIZE (80*1024) +#endif + +typedef struct http_parser http_parser; +typedef struct http_parser_settings http_parser_settings; + + +/* Callbacks should return non-zero to indicate an error. The parser will + * then halt execution. + * + * The one exception is on_headers_complete. In a HTTP_RESPONSE parser + * returning '1' from on_headers_complete will tell the parser that it + * should not expect a body. This is used when receiving a response to a + * HEAD request which may contain 'Content-Length' or 'Transfer-Encoding: + * chunked' headers that indicate the presence of a body. + * + * Returning `2` from on_headers_complete will tell parser that it should not + * expect neither a body nor any futher responses on this connection. This is + * useful for handling responses to a CONNECT request which may not contain + * `Upgrade` or `Connection: upgrade` headers. + * + * http_data_cb does not return data chunks. It will be called arbitrarily + * many times for each string. E.G. you might get 10 callbacks for "on_url" + * each providing just a few characters more data. + */ +typedef int (*http_data_cb) (http_parser*, const char *at, size_t length); +typedef int (*http_cb) (http_parser*); + + +/* Status Codes */ +#define HTTP_STATUS_MAP(XX) \ + XX(100, CONTINUE, Continue) \ + XX(101, SWITCHING_PROTOCOLS, Switching Protocols) \ + XX(102, PROCESSING, Processing) \ + XX(200, OK, OK) \ + XX(201, CREATED, Created) \ + XX(202, ACCEPTED, Accepted) \ + XX(203, NON_AUTHORITATIVE_INFORMATION, Non-Authoritative Information) \ + XX(204, NO_CONTENT, No Content) \ + XX(205, RESET_CONTENT, Reset Content) \ + XX(206, PARTIAL_CONTENT, Partial Content) \ + XX(207, MULTI_STATUS, Multi-Status) \ + XX(208, ALREADY_REPORTED, Already Reported) \ + XX(226, IM_USED, IM Used) \ + XX(300, MULTIPLE_CHOICES, Multiple Choices) \ + XX(301, MOVED_PERMANENTLY, Moved Permanently) \ + XX(302, FOUND, Found) \ + XX(303, SEE_OTHER, See Other) \ + XX(304, NOT_MODIFIED, Not Modified) \ + XX(305, USE_PROXY, Use Proxy) \ + XX(307, TEMPORARY_REDIRECT, Temporary Redirect) \ + XX(308, PERMANENT_REDIRECT, Permanent Redirect) \ + XX(400, BAD_REQUEST, Bad Request) \ + XX(401, UNAUTHORIZED, Unauthorized) \ + XX(402, PAYMENT_REQUIRED, Payment Required) \ + XX(403, FORBIDDEN, Forbidden) \ + XX(404, NOT_FOUND, Not Found) \ + XX(405, METHOD_NOT_ALLOWED, Method Not Allowed) \ + XX(406, NOT_ACCEPTABLE, Not Acceptable) \ + XX(407, PROXY_AUTHENTICATION_REQUIRED, Proxy Authentication Required) \ + XX(408, REQUEST_TIMEOUT, Request Timeout) \ + XX(409, CONFLICT, Conflict) \ + XX(410, GONE, Gone) \ + XX(411, LENGTH_REQUIRED, Length Required) \ + XX(412, PRECONDITION_FAILED, Precondition Failed) \ + XX(413, PAYLOAD_TOO_LARGE, Payload Too Large) \ + XX(414, URI_TOO_LONG, URI Too Long) \ + XX(415, UNSUPPORTED_MEDIA_TYPE, Unsupported Media Type) \ + XX(416, RANGE_NOT_SATISFIABLE, Range Not Satisfiable) \ + XX(417, EXPECTATION_FAILED, Expectation Failed) \ + XX(421, MISDIRECTED_REQUEST, Misdirected Request) \ + XX(422, UNPROCESSABLE_ENTITY, Unprocessable Entity) \ + XX(423, LOCKED, Locked) \ + XX(424, FAILED_DEPENDENCY, Failed Dependency) \ + XX(426, UPGRADE_REQUIRED, Upgrade Required) \ + XX(428, PRECONDITION_REQUIRED, Precondition Required) \ + XX(429, TOO_MANY_REQUESTS, Too Many Requests) \ + XX(431, REQUEST_HEADER_FIELDS_TOO_LARGE, Request Header Fields Too Large) \ + XX(451, UNAVAILABLE_FOR_LEGAL_REASONS, Unavailable For Legal Reasons) \ + XX(500, INTERNAL_SERVER_ERROR, Internal Server Error) \ + XX(501, NOT_IMPLEMENTED, Not Implemented) \ + XX(502, BAD_GATEWAY, Bad Gateway) \ + XX(503, SERVICE_UNAVAILABLE, Service Unavailable) \ + XX(504, GATEWAY_TIMEOUT, Gateway Timeout) \ + XX(505, HTTP_VERSION_NOT_SUPPORTED, HTTP Version Not Supported) \ + XX(506, VARIANT_ALSO_NEGOTIATES, Variant Also Negotiates) \ + XX(507, INSUFFICIENT_STORAGE, Insufficient Storage) \ + XX(508, LOOP_DETECTED, Loop Detected) \ + XX(510, NOT_EXTENDED, Not Extended) \ + XX(511, NETWORK_AUTHENTICATION_REQUIRED, Network Authentication Required) \ + +enum http_status + { +#define XX(num, name, string) HTTP_STATUS_##name = num, + HTTP_STATUS_MAP(XX) +#undef XX + }; + + +/* Request Methods */ +#define HTTP_METHOD_MAP(XX) \ + XX(0, DELETE, DELETE) \ + XX(1, GET, GET) \ + XX(2, HEAD, HEAD) \ + XX(3, POST, POST) \ + XX(4, PUT, PUT) \ + /* pathological */ \ + XX(5, CONNECT, CONNECT) \ + XX(6, OPTIONS, OPTIONS) \ + XX(7, TRACE, TRACE) \ + /* WebDAV */ \ + XX(8, COPY, COPY) \ + XX(9, LOCK, LOCK) \ + XX(10, MKCOL, MKCOL) \ + XX(11, MOVE, MOVE) \ + XX(12, PROPFIND, PROPFIND) \ + XX(13, PROPPATCH, PROPPATCH) \ + XX(14, SEARCH, SEARCH) \ + XX(15, UNLOCK, UNLOCK) \ + XX(16, BIND, BIND) \ + XX(17, REBIND, REBIND) \ + XX(18, UNBIND, UNBIND) \ + XX(19, ACL, ACL) \ + /* subversion */ \ + XX(20, REPORT, REPORT) \ + XX(21, MKACTIVITY, MKACTIVITY) \ + XX(22, CHECKOUT, CHECKOUT) \ + XX(23, MERGE, MERGE) \ + /* upnp */ \ + XX(24, MSEARCH, M-SEARCH) \ + XX(25, NOTIFY, NOTIFY) \ + XX(26, SUBSCRIBE, SUBSCRIBE) \ + XX(27, UNSUBSCRIBE, UNSUBSCRIBE) \ + /* RFC-5789 */ \ + XX(28, PATCH, PATCH) \ + XX(29, PURGE, PURGE) \ + /* CalDAV */ \ + XX(30, MKCALENDAR, MKCALENDAR) \ + /* RFC-2068, section 19.6.1.2 */ \ + XX(31, LINK, LINK) \ + XX(32, UNLINK, UNLINK) \ + +enum http_method + { +#define XX(num, name, string) HTTP_##name = num, + HTTP_METHOD_MAP(XX) +#undef XX + }; + + +enum http_parser_type { HTTP_REQUEST, HTTP_RESPONSE, HTTP_BOTH }; + + +/* Flag values for http_parser.flags field */ +enum flags + { F_CHUNKED = 1 << 0 + , F_CONNECTION_KEEP_ALIVE = 1 << 1 + , F_CONNECTION_CLOSE = 1 << 2 + , F_CONNECTION_UPGRADE = 1 << 3 + , F_TRAILING = 1 << 4 + , F_UPGRADE = 1 << 5 + , F_SKIPBODY = 1 << 6 + , F_CONTENTLENGTH = 1 << 7 + }; + + +/* Map for errno-related constants + * + * The provided argument should be a macro that takes 2 arguments. + */ +#define HTTP_ERRNO_MAP(XX) \ + /* No error */ \ + XX(OK, "success") \ + \ + /* Callback-related errors */ \ + XX(CB_message_begin, "the on_message_begin callback failed") \ + XX(CB_url, "the on_url callback failed") \ + XX(CB_header_field, "the on_header_field callback failed") \ + XX(CB_header_value, "the on_header_value callback failed") \ + XX(CB_headers_complete, "the on_headers_complete callback failed") \ + XX(CB_body, "the on_body callback failed") \ + XX(CB_message_complete, "the on_message_complete callback failed") \ + XX(CB_status, "the on_status callback failed") \ + XX(CB_chunk_header, "the on_chunk_header callback failed") \ + XX(CB_chunk_complete, "the on_chunk_complete callback failed") \ + \ + /* Parsing-related errors */ \ + XX(INVALID_EOF_STATE, "stream ended at an unexpected time") \ + XX(HEADER_OVERFLOW, \ + "too many header bytes seen; overflow detected") \ + XX(CLOSED_CONNECTION, \ + "data received after completed connection: close message") \ + XX(INVALID_VERSION, "invalid HTTP version") \ + XX(INVALID_STATUS, "invalid HTTP status code") \ + XX(INVALID_METHOD, "invalid HTTP method") \ + XX(INVALID_URL, "invalid URL") \ + XX(INVALID_HOST, "invalid host") \ + XX(INVALID_PORT, "invalid port") \ + XX(INVALID_PATH, "invalid path") \ + XX(INVALID_QUERY_STRING, "invalid query string") \ + XX(INVALID_FRAGMENT, "invalid fragment") \ + XX(LF_EXPECTED, "LF character expected") \ + XX(INVALID_HEADER_TOKEN, "invalid character in header") \ + XX(INVALID_CONTENT_LENGTH, \ + "invalid character in content-length header") \ + XX(UNEXPECTED_CONTENT_LENGTH, \ + "unexpected content-length header") \ + XX(INVALID_CHUNK_SIZE, \ + "invalid character in chunk size header") \ + XX(INVALID_CONSTANT, "invalid constant string") \ + XX(INVALID_INTERNAL_STATE, "encountered unexpected internal state")\ + XX(STRICT, "strict mode assertion failed") \ + XX(PAUSED, "parser is paused") \ + XX(UNKNOWN, "an unknown error occurred") + + +/* Define HPE_* values for each errno value above */ +#define HTTP_ERRNO_GEN(n, s) HPE_##n, +enum http_errno { + HTTP_ERRNO_MAP(HTTP_ERRNO_GEN) +}; +#undef HTTP_ERRNO_GEN + + +/* Get an http_errno value from an http_parser */ +#define HTTP_PARSER_ERRNO(p) ((enum http_errno) (p)->http_errno) + + +struct http_parser { + /** PRIVATE **/ + unsigned int type : 2; /* enum http_parser_type */ + unsigned int flags : 8; /* F_* values from 'flags' enum; semi-public */ + unsigned int state : 7; /* enum state from http_parser.c */ + unsigned int header_state : 7; /* enum header_state from http_parser.c */ + unsigned int index : 7; /* index into current matcher */ + unsigned int lenient_http_headers : 1; + + uint32_t nread; /* # bytes read in various scenarios */ + uint64_t content_length; /* # bytes in body (0 if no Content-Length header) */ + + /** READ-ONLY **/ + unsigned short http_major; + unsigned short http_minor; + unsigned int status_code : 16; /* responses only */ + unsigned int method : 8; /* requests only */ + unsigned int http_errno : 7; + + /* 1 = Upgrade header was present and the parser has exited because of that. + * 0 = No upgrade header present. + * Should be checked when http_parser_execute() returns in addition to + * error checking. + */ + unsigned int upgrade : 1; + + /** PUBLIC **/ + void *data; /* A pointer to get hook to the "connection" or "socket" object */ +}; + + +struct http_parser_settings { + http_cb on_message_begin; + http_data_cb on_url; + http_data_cb on_status; + http_data_cb on_header_field; + http_data_cb on_header_value; + http_cb on_headers_complete; + http_data_cb on_body; + http_cb on_message_complete; + /* When on_chunk_header is called, the current chunk length is stored + * in parser->content_length. + */ + http_cb on_chunk_header; + http_cb on_chunk_complete; +}; + + +enum http_parser_url_fields + { UF_SCHEMA = 0 + , UF_HOST = 1 + , UF_PORT = 2 + , UF_PATH = 3 + , UF_QUERY = 4 + , UF_FRAGMENT = 5 + , UF_USERINFO = 6 + , UF_MAX = 7 + }; + + +/* Result structure for http_parser_parse_url(). + * + * Callers should index into field_data[] with UF_* values iff field_set + * has the relevant (1 << UF_*) bit set. As a courtesy to clients (and + * because we probably have padding left over), we convert any port to + * a uint16_t. + */ +struct http_parser_url { + uint16_t field_set; /* Bitmask of (1 << UF_*) values */ + uint16_t port; /* Converted UF_PORT string */ + + struct { + uint16_t off; /* Offset into buffer in which field starts */ + uint16_t len; /* Length of run in buffer */ + } field_data[UF_MAX]; +}; + + +/* Returns the library version. Bits 16-23 contain the major version number, + * bits 8-15 the minor version number and bits 0-7 the patch level. + * Usage example: + * + * unsigned long version = http_parser_version(); + * unsigned major = (version >> 16) & 255; + * unsigned minor = (version >> 8) & 255; + * unsigned patch = version & 255; + * printf("http_parser v%u.%u.%u\n", major, minor, patch); + */ +unsigned long http_parser_version(void); + +void http_parser_init(http_parser *parser, enum http_parser_type type); + + +/* Initialize http_parser_settings members to 0 + */ +void http_parser_settings_init(http_parser_settings *settings); + + +/* Executes the parser. Returns number of parsed bytes. Sets + * `parser->http_errno` on error. */ +size_t http_parser_execute(http_parser *parser, + const http_parser_settings *settings, + const char *data, + size_t len); + + +/* If http_should_keep_alive() in the on_headers_complete or + * on_message_complete callback returns 0, then this should be + * the last message on the connection. + * If you are the server, respond with the "Connection: close" header. + * If you are the client, close the connection. + */ +int http_should_keep_alive(const http_parser *parser); + +/* Returns a string version of the HTTP method. */ +const char *http_method_str(enum http_method m); + +/* Return a string name of the given error */ +const char *http_errno_name(enum http_errno err); + +/* Return a string description of the given error */ +const char *http_errno_description(enum http_errno err); + +/* Initialize all http_parser_url members to 0 */ +void http_parser_url_init(struct http_parser_url *u); + +/* Parse a URL; return nonzero on failure */ +int http_parser_parse_url(const char *buf, size_t buflen, + int is_connect, + struct http_parser_url *u); + +/* Pause or un-pause the parser; a nonzero value pauses */ +void http_parser_pause(http_parser *parser, int paused); + +/* Checks if this is the final chunk of the body. */ +int http_body_is_final(const http_parser *parser); + +#ifdef __cplusplus +} +#endif +#endif