OW_HTTPSvrConnection.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_HTTPSVRCONNECTION_HPP_INCLUDE_GUARD_
#define OW_HTTPSVRCONNECTION_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_Runnable.hpp"
#include "OW_Mutex.hpp"
#include "OW_MutexLock.hpp"
#include "OW_String.hpp"
#include "OW_HTTPServer.hpp"
#include "OW_HTTPStatusCodes.hpp"
#include "OW_Socket.hpp"
#include "OW_HTTPUtils.hpp"
#include "OW_RequestHandlerIFC.hpp"
#include "OW_CIMProtocolIStreamIFC.hpp"
#include "OW_CommonFwd.hpp"
#include "OW_HttpCommonFwd.hpp"
#include "OW_Reference.hpp"
#include <iosfwd>
#include <fstream>

namespace OW_NAMESPACE
{

class OW_HTTPSVC_API HTTPSvrConnection: public Runnable
{
public:
#ifdef OW_WIN32

   HTTPSvrConnection(const Socket& socket, HTTPServer* htin,
      HANDLE eventArg, const HTTPServer::Options& opts);
#else

   HTTPSvrConnection(const Socket& socket, HTTPServer* htin,
      UnnamedPipeRef& upipe,
      const HTTPServer::Options& opts);
#endif

   ~HTTPSvrConnection();
   virtual void run();
   // these are public so that authentication modules can access them.
   bool headerHasKey(const String& key) const
   {
      return HTTPUtils::headerHasKey(m_requestHeaders, key);
   }
   String getHeaderValue(const String& key) const
   {
      return HTTPUtils::getHeaderValue(m_requestHeaders, key);
   }
   void addHeader(const String& key, const String& value)
   {
      HTTPUtils::addHeader(m_responseHeaders, key, value);
   }
   StringArray getRequestLine() const { return m_requestLine; }
   void setErrorDetails(const String& details) { m_errDetails = details; }
   
   String getHostName();
protected:
private:

#ifdef OW_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

   enum requestMethod_t
   {
      BAD = 0,
      POST,
      M_POST,
      TRACE,
      OPTIONS
   };
   enum httpVerFlag_t
   {
      HTTP_VER_BAD = 0,
      HTTP_VER_10,
      HTTP_VER_11
   };
   StringArray m_requestLine;
   HTTPHeaderMap m_requestHeaders;
   HTTPServer* m_pHTTPServer;
   std::istream* m_pIn;
   std::ofstream m_tempFile;
   Socket m_socket;
   std::ostream& m_ostr;
   int m_resCode;
   bool m_needSendError;
   Array<String> m_responseHeaders;
   httpVerFlag_t m_httpVersion;
   requestMethod_t m_method;
   std::istream& m_istr;
   bool m_isClose;
   Int64 m_contentLength;
   bool m_chunkedIn;
   bool m_deflateCompressionIn;
   bool m_deflateCompressionOut;
   String m_errDetails;
   String m_reqHeaderPrefix;
   String m_respHeaderPrefix;
   bool m_isAuthenticated;
#ifdef OW_WIN32
   HANDLE m_event;
#else
   IntrusiveReference<UnnamedPipe> m_upipe;
#endif
   bool m_chunkedOut;
   String m_userName;
   bool m_clientIsOpenWBEM2;

   RequestHandlerIFCRef m_requestHandler;
   HTTPServer::Options m_options;
   bool m_shutdown;
   
   // Don't switch the order of the next 2 member vars. The order is important, since Deflate may hold a pointer to Chunked,
   // and it's destructor may call functions on Chunked. Yeah, this is a BAD design!
   Reference<HTTPChunkedOStream> m_HTTPChunkedOStreamRef;
#ifdef OW_HAVE_ZLIB_H
   Reference<HTTPDeflateOStream> m_HTTPDeflateOStreamRef;
#endif

   Reference<TempFileStream> m_TempFileStreamRef;

#ifdef OW_WIN32
#pragma warning (pop)
#endif

   int processRequestLine();
   int processHeaders(OperationContext& context);
   void trace();
   void options(OperationContext& context);
   void post(std::istream& istr, OperationContext& context);
   void sendError(int resCode);
   void beginPostResponse();
   void initRespStream(std::ostream*& ostrEntity);
   void sendPostResponse(std::ostream* ostrEntity,
      TempFileStream& ostrError, OperationContext& context);
   int performAuthentication(const String& info, OperationContext& context);
   void sendHeaders(int sc, int len = -1);
   void cleanUpIStreams(const CIMProtocolIStreamIFCRef& istrm);
   CIMProtocolIStreamIFCRef convertToFiniteStream(
         std::istream& istr);
   String getContentLanguage(OperationContext& context, bool& setByProvider,
      bool& clientSpecified);

   void doCooperativeCancel();
};

} // end namespace OW_NAMESPACE

#endif

---