/usr/include/QHttpEngine/qhttphandler.h is in libqhttpengine-dev 0.1.0+dfsg1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | /*
* Copyright (c) 2015 Nathan Osman
*
* 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 QHTTPENGINE_QHTTPHANDLER_H
#define QHTTPENGINE_QHTTPHANDLER_H
#include <QObject>
#include <QRegExp>
#include "qhttpengine.h"
#include "qhttpsocket.h"
class QHTTPENGINE_EXPORT QHttpHandlerPrivate;
/**
* @brief Base class for HTTP handlers
* @headerfile qhttphandler.h QHttpEngine/QHttpHandler
*
* When a request is received by a QHttpServer, it invokes the route() method
* of the root handler which is used to determine what happens to the request.
* All HTTP handlers derive from this class and should override the protected
* process() method in order to process the request. Each handler also
* maintains a list of redirects and sub-handlers which are used in place of
* invoking process() when one of the patterns match.
*
* To add a redirect, use the addRedirect() method. The first parameter is a
* QRegExp pattern that the request path will be tested against. If it
* matches, an HTTP 302 redirect will be written to the socket and the request
* closed. For example, to have the root path "/" redirect to "/index.html":
*
* @code
* QHttpHandler handler;
* handler.addRedirect(QRegExp("^$"), "/index.html");
* @endcode
*
* To add a sub-handler, use the addSubHandler() method. Again, the first
* parameter is a QRegExp pattern. If the pattern matches, the portion of the
* path that matched the pattern is removed from the path and it is passed to
* the sub-handler's route() method. For example, to have a sub-handler
* invoked when the path begins with "/api/":
*
* @code
* QHttpHandler handler, subHandler;
* handler.addSubHandler(QRegExp("^api/"), &subHandler);
* @endcode
*
* If the request doesn't match any redirect or sub-handler patterns, it is
* passed along to the process() method, which is expected to either process
* the request or write an error to the socket. The default implementation of
* process() simply returns an HTTP 404 error.
*/
class QHTTPENGINE_EXPORT QHttpHandler : public QObject
{
Q_OBJECT
public:
/**
* @brief Base constructor for a handler
*/
explicit QHttpHandler(QObject *parent = 0);
/**
* @brief Add a redirect for a specific pattern
*
* The pattern and path will be added to an internal list that will be
* used when the route() method is invoked to determine whether the
* request matches any patterns. The order of the list is preserved.
*
* The destination path may use "%1", "%2", etc. to refer to captured
* parts of the pattern. The client will receive an HTTP 302 redirect.
*/
void addRedirect(const QRegExp &pattern, const QString &path);
/**
* @brief Add a handler for a specific pattern
*
* The pattern and handler will be added to an internal list that will be
* used when the route() method is invoked to determine whether the
* request matches any patterns. The order of the list is preserved.
*/
void addSubHandler(const QRegExp &pattern, QHttpHandler *handler);
/**
* @brief Route an incoming request
*/
void route(QHttpSocket *socket, const QString &path);
protected:
/**
* @brief Process a request
*
* This method should process the request either by fulfilling it, sending
* a redirect with QHttpSocket::writeRedirect(), or writing an error to
* the socket using QHttpSocket::writeError().
*/
virtual void process(QHttpSocket *socket, const QString &path);
private:
QHttpHandlerPrivate *const d;
friend class QHttpHandlerPrivate;
};
#endif // QHTTPENGINE_QHTTPHANDLER_H
|