ossimCurlHttpRequest Class Reference

#include <ossimCurlHttpRequest.h>

Inheritance diagram for ossimCurlHttpRequest:

Public Member Functions
	ossimCurlHttpRequest ()
virtual	~ossimCurlHttpRequest ()
virtual ossimRefPtr< ossimWebResponse >	getResponse ()
virtual bool	supportsProtocol (const ossimString &protocol) const
ossim_int64	getContentLength () const
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
Public Member Functions inherited from ossimHttpRequest
	ossimHttpRequest ()
bool	set (const ossimUrl &url, const ossimKeywordlist &headerOptions, HttpMethodType methodType=HTTP_METHOD_GET)
virtual	~ossimHttpRequest ()
void	setHeaderOptions (const ossimKeywordlist &options)
void	addHeaderOption (const ossimString &name, const ossimString &value)
void	clearHeaderOptions ()
ossimKeywordlist &	getHeaderOptions ()
const ossimKeywordlist &	getHeaderOptions () const
virtual ossimString	getLastError () const
Public Member Functions inherited from ossimWebRequest
	ossimWebRequest ()
	ossimWebRequest (const ossimUrl &url)
const ossimUrl &	getUrl () const
virtual bool	setUrl (const ossimUrl &url)
void	clearLastError ()
void	clearLastError () const
const ossimString	getLastError ()
Public Member Functions inherited from ossimObject
	ossimObject ()
virtual	~ossimObject ()
virtual ossimObject *	dup () const
virtual ossimString	getShortName () const
virtual ossimString	getLongName () const
virtual ossimString	getDescription () const
virtual ossimString	getClassName () const
virtual RTTItypeid	getType () const
virtual bool	canCastTo (ossimObject *obj) const
virtual bool	canCastTo (const RTTItypeid &id) const
virtual bool	canCastTo (const ossimString &parentClassName) const
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...
virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
virtual void	accept (ossimVisitor &visitor)
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const

Static Public Member Functions
static int	curlWriteResponseBody (void *buffer, size_t size, size_t nmemb, void *stream)
static int	curlWriteResponseHeader (void *buffer, size_t size, size_t nmemb, void *stream)

Protected Member Functions
void	setDefaultSSL (CURL *curl) const
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
CURL *	m_curl
ossimRefPtr< ossimCurlHttpResponse >	m_response
Protected Attributes inherited from ossimHttpRequest
ossimKeywordlist	m_headerOptions
HttpMethodType	m_methodType
	TYPE_DATA
Protected Attributes inherited from ossimWebRequest
ossimUrl	m_url
ossimString	m_lastError
	TYPE_DATA

Additional Inherited Members
Public Types inherited from ossimHttpRequest
enum	HttpMethodType { HTTP_METHOD_UNKNOWN = 0, HTTP_METHOD_GET = 1, HTTP_METHOD_POST = 2 }

Detailed Description

Definition at line 13 of file ossimCurlHttpRequest.h.

Constructor & Destructor Documentation

ossimCurlHttpRequest()

ossimCurlHttpRequest::ossimCurlHttpRequest ( )

inline

Definition at line 16 of file ossimCurlHttpRequest.h.

References m_curl.

   :m_curl(0)
   {
      m_curl = curl_easy_init();
   }

~ossimCurlHttpRequest()

virtual ossimCurlHttpRequest::~ossimCurlHttpRequest ( )

inlinevirtual

Definition at line 21 of file ossimCurlHttpRequest.h.

References m_curl.

   {
      if(m_curl)
      {
         curl_easy_cleanup(m_curl);
         m_curl = 0;
      }
   }

Member Function Documentation

curlWriteResponseBody()

int ossimCurlHttpRequest::curlWriteResponseBody ( void *  buffer, size_t  size, size_t  nmemb, void *  stream  )

static

Definition at line 96 of file ossimCurlHttpRequest.cpp.

References ossimHttpResponse::bodyStream(), and size.

Referenced by getContentLength(), and getResponse().

{
   ossimHttpResponse* cStream = static_cast<ossimHttpResponse*>(stream);

   if(cStream)
   {
      cStream->bodyStream().write((char*)buffer, nmemb*size);
      return nmemb*size;
   }
   
   return 0;
}

curlWriteResponseHeader()

int ossimCurlHttpRequest::curlWriteResponseHeader ( void *  buffer, size_t  size, size_t  nmemb, void *  stream  )

static

Definition at line 109 of file ossimCurlHttpRequest.cpp.

References ossimHttpResponse::headerStream(), and size.

Referenced by getContentLength(), and getResponse().

{
   ossimHttpResponse* cStream = static_cast<ossimHttpResponse*>(stream);
   if(cStream)
   {
      cStream->headerStream().write((char*)buffer, nmemb*size);
      return nmemb*size;
   }
   
   return 0;
}

getContentLength()

ossim_int64 ossimCurlHttpRequest::getContentLength

(

)

const

Definition at line 121 of file ossimCurlHttpRequest.cpp.

References ossimString::c_str(), ossimWebRequest::clearLastError(), ossimHttpResponse::convertHeaderStreamToKeywordlist(), curlWriteResponseBody(), curlWriteResponseHeader(), ossimRefPtr< T >::get(), ossimKeywordlist::getMap(), ossimUrl::getProtocol(), ossimWebRequest::getUrl(), m_curl, ossimHttpRequest::m_headerOptions, ossimWebRequest::m_lastError, setDefaultSSL(), and ossimUrl::toString().

{
   double contentLength=-1;
   curl_easy_reset(m_curl);
   clearLastError();
   ossimString urlString = getUrl().toString();
   ossimString protocol = getUrl().getProtocol();
   ossimRefPtr<ossimCurlHttpResponse> response = new ossimCurlHttpResponse();
   
   curl_easy_setopt(m_curl, CURLOPT_HEADERFUNCTION, curlWriteResponseHeader);
   curl_easy_setopt(m_curl, CURLOPT_HEADERDATA, (void*)response.get());
   curl_easy_setopt(m_curl, CURLOPT_WRITEFUNCTION, curlWriteResponseBody);
   curl_easy_setopt(m_curl, CURLOPT_WRITEDATA, (void*)response.get());
   curl_easy_setopt(m_curl, CURLOPT_HEADER, 0); 
   curl_easy_setopt(m_curl, CURLOPT_NOBODY, 1); 
   curl_easy_setopt(m_curl, CURLOPT_RANGE, "");

   const ossimKeywordlist::KeywordMap& headerMap = m_headerOptions.getMap();
   struct curl_slist *headers=0; /* init to NULL is important */
   
   ossimKeywordlist::KeywordMap::const_iterator iter = headerMap.begin();
   while(iter != headerMap.end())
   {
//      std::cout << ((*iter).first + ":"+(*iter).second).c_str() << std::endl;
      headers = curl_slist_append(headers, ((*iter).first + ":"+(*iter).second).c_str());
      ++iter;
   }
   curl_easy_setopt(m_curl, CURLOPT_URL, urlString.c_str());
   if(protocol == "https")
   {
      setDefaultSSL(m_curl);
   }
   int rc = curl_easy_perform(m_curl);
         
   //rc = curl_easy_getinfo(m_curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &contentLength);
   if(rc == CURLE_SSL_CONNECT_ERROR)
   {
      // try default if an error for SSL connect ocurred
      curl_easy_setopt(m_curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_SSLv3);
      rc = curl_easy_perform(m_curl);   
   }
   bool result = (rc < 1);
   if(result)
   {
      response->convertHeaderStreamToKeywordlist();
      rc = curl_easy_getinfo(m_curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &contentLength);
   //if(rc>=1) contentLength = -1;
   // response->convertHeaderStreamToKeywordlist();
   //std::cout << response->headerKwl() << "\n";
   }
   else
   {
      m_lastError = curl_easy_strerror((CURLcode)rc);
      //std::cout << curl_easy_strerror((CURLcode)rc) << std::endl;
   }

   return static_cast<ossim_int64> (contentLength);
}

getResponse()

ossimRefPtr< ossimWebResponse > ossimCurlHttpRequest::getResponse ( )

virtual

Reimplemented from ossimWebRequest.

Definition at line 4 of file ossimCurlHttpRequest.cpp.

References ossimString::c_str(), ossimWebRequest::clearLastError(), ossimHttpResponse::convertHeaderStreamToKeywordlist(), curlWriteResponseBody(), curlWriteResponseHeader(), ossimKeywordlist::find(), ossimRefPtr< T >::get(), ossimUrl::getProtocol(), ossimWebRequest::getUrl(), ossimHttpRequest::HTTP_METHOD_GET, m_curl, ossimHttpRequest::m_headerOptions, ossimWebRequest::m_lastError, ossimHttpRequest::m_methodType, setDefaultSSL(), ossimString::substitute(), supportsProtocol(), and ossimUrl::toString().

{
   ossimRefPtr<ossimWebResponse> response;
   ossimString protocol = getUrl().getProtocol();
   if(!supportsProtocol(protocol))
   {
      return 0;
   }
   curl_easy_reset(m_curl);
   clearLastError();
   switch (m_methodType) 
   {
      case ossimHttpRequest::HTTP_METHOD_GET:
      {
         ossimCurlHttpResponse* curlResponse = new ossimCurlHttpResponse();
         response = curlResponse;
         
         curl_easy_setopt(m_curl, CURLOPT_HEADERFUNCTION, curlWriteResponseHeader);
         curl_easy_setopt(m_curl, CURLOPT_HEADERDATA, (void*)response.get());
         curl_easy_setopt(m_curl, CURLOPT_WRITEFUNCTION, curlWriteResponseBody);
         curl_easy_setopt(m_curl, CURLOPT_WRITEDATA, (void*)response.get());
         curl_easy_setopt(m_curl, CURLOPT_HEADER, 0); 
         curl_easy_setopt(m_curl, CURLOPT_NOBODY, 0); 
         //curl_easy_setopt(m_curl, CURLOPT_CONNECT_ONLY, 1);
        // ossimKeywordlist::KeywordMap& headerMap = m_headerOptions.getMap();
        // struct curl_slist *headers=0; /* init to NULL is important */
         ossimString range = m_headerOptions.find("Range");
         range=range.substitute("bytes=", "");
         curl_easy_setopt(m_curl, CURLOPT_RANGE, range.c_str());
         // ossimKeywordlist::KeywordMap::iterator iter = headerMap.begin();
         // while(iter != headerMap.end())
         // {
         //    std::cout << ((*iter).first + ":"+(*iter).second).c_str() << std::endl;
         //    headers = curl_slist_append(headers, ((*iter).first + ":"+(*iter).second).c_str());
         //    ++iter;
         // }
         ossimString urlString = getUrl().toString();
         curl_easy_setopt(m_curl, CURLOPT_URL, urlString.c_str());
         
         
         if(protocol == "https")
         {
            setDefaultSSL(m_curl);
         }
         
         int rc = curl_easy_perform(m_curl);
         
         if(rc == CURLE_SSL_CONNECT_ERROR)
         {
            // try default if an error for SSL connect ocurred
            curl_easy_setopt(m_curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_SSLv3);
            rc = curl_easy_perform(m_curl);
         }
         bool result = (rc < 1);
         if(result)
         {
            curlResponse->convertHeaderStreamToKeywordlist();
         }
         else
         {
            m_lastError = curl_easy_strerror((CURLcode)rc);
            //std::cout << curl_easy_strerror((CURLcode)rc) << std::endl;
            response = 0;
         }
         break;
      }
         
      default:
         break;
   }
   
   return response;
}

loadState()

virtual bool ossimCurlHttpRequest::loadState ( const ossimKeywordlist &  kwl, const char *  prefix = 0  )

inlinevirtual

Method to the load (recreate) the state of the object from a keyword list. Return true if ok or false on error.

Reimplemented from ossimHttpRequest.

Definition at line 34 of file ossimCurlHttpRequest.h.

References ossimHttpRequest::loadState(), and m_response.

   {
      m_response = 0;
      return ossimHttpRequest::loadState(kwl, prefix);
   }

setDefaultSSL()

void ossimCurlHttpRequest::setDefaultSSL ( CURL *  curl ) const

protected

Definition at line 180 of file ossimCurlHttpRequest.cpp.

References ossim::CurlStreamDefaults::m_cacert, ossim::CurlStreamDefaults::m_clientCert, ossim::CurlStreamDefaults::m_clientCertType, ossim::CurlStreamDefaults::m_clientKey, and ossim::CurlStreamDefaults::m_clientKeyPassword.

Referenced by getContentLength(), and getResponse().

{
   curl_easy_setopt(curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_DEFAULT);//);
   if(!ossim::CurlStreamDefaults::m_cacert.empty())
   {
      curl_easy_setopt(curl, CURLOPT_CAINFO, ossim::CurlStreamDefaults::m_cacert.c_str());
      curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 1L);
   } 
   else
   {
     curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);
   }
   if(!ossim::CurlStreamDefaults::m_clientCert.empty())
   {
      curl_easy_setopt(curl, CURLOPT_SSLCERT, ossim::CurlStreamDefaults::m_clientCert.c_str());
   } 
   if(!ossim::CurlStreamDefaults::m_clientCertType.empty())
   {
     curl_easy_setopt(curl, CURLOPT_SSLCERTTYPE, ossim::CurlStreamDefaults::m_clientCertType.c_str()); 
   } 
   if(!ossim::CurlStreamDefaults::m_clientKeyPassword.empty())
   {
     curl_easy_setopt(curl, CURLOPT_SSLKEYPASSWD, ossim::CurlStreamDefaults::m_clientKeyPassword.c_str()); 
   }
   if(!ossim::CurlStreamDefaults::m_clientKey.empty())
   {
      curl_easy_setopt(curl, CURLOPT_SSLKEY, ossim::CurlStreamDefaults::m_clientKey.c_str());
   } 
}

supportsProtocol()

bool ossimCurlHttpRequest::supportsProtocol ( const ossimString &  protocol ) const

virtual

Definition at line 78 of file ossimCurlHttpRequest.cpp.

Referenced by ossimWebPluginRequestFactory::create(), and getResponse().

{
   bool result = false;
   if(protocol == "http")
   {
      result = true;
   }
   else if(protocol == "https")
   {
      curl_version_info_data * vinfo = curl_version_info( CURLVERSION_NOW ); 
      if( vinfo->features & CURL_VERSION_SSL ) 
      { 
         result = true;
      } 
   }
   return result;
}

Member Data Documentation

m_curl

CURL* ossimCurlHttpRequest::m_curl

protected

Definition at line 41 of file ossimCurlHttpRequest.h.

Referenced by getContentLength(), getResponse(), ossimCurlHttpRequest(), and ~ossimCurlHttpRequest().

m_response

ossimRefPtr<ossimCurlHttpResponse> ossimCurlHttpRequest::m_response

mutableprotected

Definition at line 42 of file ossimCurlHttpRequest.h.

Referenced by loadState().

---

The documentation for this class was generated from the following files:

• ossimCurlHttpRequest.h
• ossimCurlHttpRequest.cpp