mirror of
https://github.com/pocoproject/poco.git
synced 2025-10-28 19:51:58 +01:00
fixed line endings
This commit is contained in:
Guenter Obiltschnig
@@ -1,158 +1,158 @@
|
||||
//
|
||||
// AbstractHTTPRequestHandler.h
|
||||
//
|
||||
// $Id: //poco/svn/Net/include/Poco/Net/AbstractHTTPRequestHandler.h#2 $
|
||||
//
|
||||
// Library: Net
|
||||
// Package: HTTPServer
|
||||
// Module: AbstractHTTPRequestHandler
|
||||
//
|
||||
// Definition of the AbstractHTTPRequestHandler class.
|
||||
//
|
||||
// Copyright (c) 2007, Applied Informatics Software Engineering GmbH.
|
||||
// and Contributors.
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person or organization
|
||||
// obtaining a copy of the software and accompanying documentation covered by
|
||||
// this license (the "Software") to use, reproduce, display, distribute,
|
||||
// execute, and transmit the Software, and to prepare derivative works of the
|
||||
// Software, and to permit third-parties to whom the Software is furnished to
|
||||
// do so, all subject to the following:
|
||||
//
|
||||
// The copyright notices in the Software and this entire statement, including
|
||||
// the above license grant, this restriction and the following disclaimer,
|
||||
// must be included in all copies of the Software, in whole or in part, and
|
||||
// all derivative works of the Software, unless such copies or derivative
|
||||
// works are solely in the form of machine-executable object code generated by
|
||||
// a source language processor.
|
||||
//
|
||||
// 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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
|
||||
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
|
||||
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
|
||||
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
// DEALINGS IN THE SOFTWARE.
|
||||
//
|
||||
|
||||
|
||||
#ifndef Net_AbstractHTTPRequestHandler_INCLUDED
|
||||
#define Net_AbstractHTTPRequestHandler_INCLUDED
|
||||
|
||||
|
||||
#include "Poco/Net/HTTPRequestHandler.h"
|
||||
#include "Poco/Net/HTTPResponse.h"
|
||||
|
||||
|
||||
namespace Poco {
|
||||
namespace Net {
|
||||
|
||||
|
||||
class HTMLForm;
|
||||
|
||||
|
||||
class Net_API AbstractHTTPRequestHandler: public HTTPRequestHandler
|
||||
/// The abstract base class for AbstractHTTPRequestHandlers
|
||||
/// created by HTTPServer.
|
||||
///
|
||||
/// Derived classes must override the run() method.
|
||||
|
||||
/// Contrary to a HTTPRequestHandler, an AbstractHTTPRequestHandler
|
||||
/// stores request and response as member variables to avoid having
|
||||
/// to pass them around as method parameters. Additionally, a
|
||||
/// HTMLForm object is created for use by subclasses.
|
||||
///
|
||||
/// The run() method must perform the complete handling
|
||||
/// of the HTTP request connection. As soon as the run()
|
||||
/// method returns, the request handler object is destroyed.
|
||||
///
|
||||
/// A new AbstractHTTPRequestHandler object will be created for
|
||||
/// each new HTTP request that is received by the HTTPServer.
|
||||
{
|
||||
public:
|
||||
AbstractHTTPRequestHandler();
|
||||
/// Creates the AbstractHTTPRequestHandler.
|
||||
|
||||
virtual ~AbstractHTTPRequestHandler();
|
||||
/// Destroys the AbstractHTTPRequestHandler.
|
||||
|
||||
void handleRequest(HTTPServerRequest& request, HTTPServerResponse& response);
|
||||
/// This class implements some common behavior,
|
||||
/// before calling run() to actually handle the request:
|
||||
/// - save request and response objects;
|
||||
/// - call authorize();
|
||||
/// - if authorize() returns true call run(),
|
||||
/// else send 401 (Unauthorized) response.
|
||||
///
|
||||
/// If run() throws an exception and the response has not been
|
||||
/// sent yet, sends a 500 (Internal Server Error) response with
|
||||
/// the exception's display text.
|
||||
|
||||
HTTPServerRequest& request();
|
||||
/// Returns the request.
|
||||
|
||||
HTTPServerResponse& response();
|
||||
/// Returns the response.
|
||||
|
||||
HTMLForm& form();
|
||||
/// Returns a HTMLForm for the given request.
|
||||
/// The HTMLForm object is created when this
|
||||
/// member function is executed the first time.
|
||||
|
||||
void sendErrorResponse(HTTPResponse::HTTPStatus status, const std::string& message);
|
||||
/// Sends a HTML error page for the given status code.
|
||||
/// The given message is added to the page:
|
||||
/// <HTML>
|
||||
/// <HEAD>
|
||||
/// <TITLE>status - reason</TITLE>
|
||||
/// </HEAD>
|
||||
/// <BODY>
|
||||
/// <H1>status - reason</H1>
|
||||
/// <P>message</P>
|
||||
/// </BODY>
|
||||
/// </HTML>
|
||||
|
||||
protected:
|
||||
virtual void run() = 0;
|
||||
/// Must be overridden by subclasses.
|
||||
///
|
||||
/// Handles the given request.
|
||||
|
||||
virtual bool authenticate();
|
||||
/// Check authentication; returns true if okay, false if failed to authenticate.
|
||||
/// The default implementation always returns true.
|
||||
///
|
||||
/// Subclasses can override this member function to perform
|
||||
/// some form of client or request authentication before
|
||||
/// the request is actually handled.
|
||||
|
||||
private:
|
||||
HTTPServerRequest* _pRequest;
|
||||
HTTPServerResponse* _pResponse;
|
||||
HTMLForm* _pForm;
|
||||
};
|
||||
|
||||
|
||||
//
|
||||
// inlines
|
||||
//
|
||||
inline HTTPServerRequest& AbstractHTTPRequestHandler::request()
|
||||
{
|
||||
poco_check_ptr (_pRequest);
|
||||
|
||||
return *_pRequest;
|
||||
}
|
||||
|
||||
|
||||
inline HTTPServerResponse& AbstractHTTPRequestHandler::response()
|
||||
{
|
||||
poco_check_ptr (_pResponse);
|
||||
|
||||
return *_pResponse;
|
||||
}
|
||||
|
||||
|
||||
} } // namespace Poco::Net
|
||||
|
||||
|
||||
#endif // Net_AbstractHTTPRequestHandler_INCLUDED
|
||||
//
|
||||
// AbstractHTTPRequestHandler.h
|
||||
//
|
||||
// $Id: //poco/svn/Net/include/Poco/Net/AbstractHTTPRequestHandler.h#2 $
|
||||
//
|
||||
// Library: Net
|
||||
// Package: HTTPServer
|
||||
// Module: AbstractHTTPRequestHandler
|
||||
//
|
||||
// Definition of the AbstractHTTPRequestHandler class.
|
||||
//
|
||||
// Copyright (c) 2007, Applied Informatics Software Engineering GmbH.
|
||||
// and Contributors.
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person or organization
|
||||
// obtaining a copy of the software and accompanying documentation covered by
|
||||
// this license (the "Software") to use, reproduce, display, distribute,
|
||||
// execute, and transmit the Software, and to prepare derivative works of the
|
||||
// Software, and to permit third-parties to whom the Software is furnished to
|
||||
// do so, all subject to the following:
|
||||
//
|
||||
// The copyright notices in the Software and this entire statement, including
|
||||
// the above license grant, this restriction and the following disclaimer,
|
||||
// must be included in all copies of the Software, in whole or in part, and
|
||||
// all derivative works of the Software, unless such copies or derivative
|
||||
// works are solely in the form of machine-executable object code generated by
|
||||
// a source language processor.
|
||||
//
|
||||
// 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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
|
||||
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
|
||||
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
|
||||
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
// DEALINGS IN THE SOFTWARE.
|
||||
//
|
||||
|
||||
|
||||
#ifndef Net_AbstractHTTPRequestHandler_INCLUDED
|
||||
#define Net_AbstractHTTPRequestHandler_INCLUDED
|
||||
|
||||
|
||||
#include "Poco/Net/HTTPRequestHandler.h"
|
||||
#include "Poco/Net/HTTPResponse.h"
|
||||
|
||||
|
||||
namespace Poco {
|
||||
namespace Net {
|
||||
|
||||
|
||||
class HTMLForm;
|
||||
|
||||
|
||||
class Net_API AbstractHTTPRequestHandler: public HTTPRequestHandler
|
||||
/// The abstract base class for AbstractHTTPRequestHandlers
|
||||
/// created by HTTPServer.
|
||||
///
|
||||
/// Derived classes must override the run() method.
|
||||
|
||||
/// Contrary to a HTTPRequestHandler, an AbstractHTTPRequestHandler
|
||||
/// stores request and response as member variables to avoid having
|
||||
/// to pass them around as method parameters. Additionally, a
|
||||
/// HTMLForm object is created for use by subclasses.
|
||||
///
|
||||
/// The run() method must perform the complete handling
|
||||
/// of the HTTP request connection. As soon as the run()
|
||||
/// method returns, the request handler object is destroyed.
|
||||
///
|
||||
/// A new AbstractHTTPRequestHandler object will be created for
|
||||
/// each new HTTP request that is received by the HTTPServer.
|
||||
{
|
||||
public:
|
||||
AbstractHTTPRequestHandler();
|
||||
/// Creates the AbstractHTTPRequestHandler.
|
||||
|
||||
virtual ~AbstractHTTPRequestHandler();
|
||||
/// Destroys the AbstractHTTPRequestHandler.
|
||||
|
||||
void handleRequest(HTTPServerRequest& request, HTTPServerResponse& response);
|
||||
/// This class implements some common behavior,
|
||||
/// before calling run() to actually handle the request:
|
||||
/// - save request and response objects;
|
||||
/// - call authorize();
|
||||
/// - if authorize() returns true call run(),
|
||||
/// else send 401 (Unauthorized) response.
|
||||
///
|
||||
/// If run() throws an exception and the response has not been
|
||||
/// sent yet, sends a 500 (Internal Server Error) response with
|
||||
/// the exception's display text.
|
||||
|
||||
HTTPServerRequest& request();
|
||||
/// Returns the request.
|
||||
|
||||
HTTPServerResponse& response();
|
||||
/// Returns the response.
|
||||
|
||||
HTMLForm& form();
|
||||
/// Returns a HTMLForm for the given request.
|
||||
/// The HTMLForm object is created when this
|
||||
/// member function is executed the first time.
|
||||
|
||||
void sendErrorResponse(HTTPResponse::HTTPStatus status, const std::string& message);
|
||||
/// Sends a HTML error page for the given status code.
|
||||
/// The given message is added to the page:
|
||||
/// <HTML>
|
||||
/// <HEAD>
|
||||
/// <TITLE>status - reason</TITLE>
|
||||
/// </HEAD>
|
||||
/// <BODY>
|
||||
/// <H1>status - reason</H1>
|
||||
/// <P>message</P>
|
||||
/// </BODY>
|
||||
/// </HTML>
|
||||
|
||||
protected:
|
||||
virtual void run() = 0;
|
||||
/// Must be overridden by subclasses.
|
||||
///
|
||||
/// Handles the given request.
|
||||
|
||||
virtual bool authenticate();
|
||||
/// Check authentication; returns true if okay, false if failed to authenticate.
|
||||
/// The default implementation always returns true.
|
||||
///
|
||||
/// Subclasses can override this member function to perform
|
||||
/// some form of client or request authentication before
|
||||
/// the request is actually handled.
|
||||
|
||||
private:
|
||||
HTTPServerRequest* _pRequest;
|
||||
HTTPServerResponse* _pResponse;
|
||||
HTMLForm* _pForm;
|
||||
};
|
||||
|
||||
|
||||
//
|
||||
// inlines
|
||||
//
|
||||
inline HTTPServerRequest& AbstractHTTPRequestHandler::request()
|
||||
{
|
||||
poco_check_ptr (_pRequest);
|
||||
|
||||
return *_pRequest;
|
||||
}
|
||||
|
||||
|
||||
inline HTTPServerResponse& AbstractHTTPRequestHandler::response()
|
||||
{
|
||||
poco_check_ptr (_pResponse);
|
||||
|
||||
return *_pResponse;
|
||||
}
|
||||
|
||||
|
||||
} } // namespace Poco::Net
|
||||
|
||||
|
||||
#endif // Net_AbstractHTTPRequestHandler_INCLUDED
|
||||
|
||||
Reference in New Issue
Block a user