Classes | Functions

cpl_http.h File Reference

#include "cpl_conv.h"
#include "cpl_string.h"
#include "cpl_vsi.h"

Go to the source code of this file.

Classes

struct  CPLMimePart
struct  CPLHTTPResult

Functions

int CPLHTTPEnabled (void)
 Return if CPLHTTP services can be usefull.
CPLHTTPResultCPLHTTPFetch (const char *pszURL, char **papszOptions)
 Fetch a document from an url and return in a string.
void CPLHTTPCleanup (void)
 Cleanup function to call at application termination.
void CPLHTTPDestroyResult (CPLHTTPResult *psResult)
 Clean the memory associated with the return value of CPLHTTPFetch().
int CPLHTTPParseMultipartMime (CPLHTTPResult *psResult)
 Parses a a MIME multipart message.
char * GOA2GetAuthorizationURL (const char *pszScope)
char * GOA2GetRefreshToken (const char *pszAuthToken, const char *pszScope)
char * GOA2GetAccessToken (const char *pszRefreshToken, const char *pszScope)

Detailed Description

Interface for downloading HTTP, FTP documents


Function Documentation

void CPLHTTPDestroyResult ( CPLHTTPResult psResult  ) 
int CPLHTTPEnabled ( void   ) 

Return if CPLHTTP services can be usefull.

Those services depend on GDAL being build with libcurl support.

Returns:
TRUE if libcurl support is enabled
CPLHTTPResult* CPLHTTPFetch ( const char *  pszURL,
char **  papszOptions 
)

Fetch a document from an url and return in a string.

Parameters:
pszURL valid URL recognized by underlying download library (libcurl)
papszOptions option list as a NULL-terminated array of strings. May be NULL. The following options are handled :

  • TIMEOUT=val, where val is in seconds
  • HEADERS=val, where val is an extra header to use when getting a web page. For example "Accept: application/x-ogcwkt"
  • HTTPAUTH=[BASIC/NTLM/GSSNEGOTIATE/ANY] to specify an authentication scheme to use.
  • USERPWD=userid:password to specify a user and password for authentication
  • POSTFIELDS=val, where val is a nul-terminated string to be passed to the server with a POST request.
  • PROXY=val, to make requests go through a proxy server, where val is of the form proxy.server.com:port_number
  • PROXYUSERPWD=val, where val is of the form username:password
  • PROXYAUTH=[BASIC/NTLM/DIGEST/ANY] to specify an proxy authentication scheme to use.
  • NETRC=[YES/NO] to enable or disable use of $HOME/.netrc, default YES.
  • CUSTOMREQUEST=val, where val is GET, PUT, POST, DELETE, etc.. (GDAL >= 1.9.0)

Alternatively, if not defined in the papszOptions arguments, the PROXY, PROXYUSERPWD, PROXYAUTH and NETRC values are searched in the configuration options named GDAL_HTTP_PROXY, GDAL_HTTP_PROXYUSERPWD, GDAL_PROXY_AUTH and GDAL_HTTP_NETRC, as proxy configuration belongs to networking setup and makes more sense at the configuration option level than at the connection level.

Returns:
a CPLHTTPResult* structure that must be freed by CPLHTTPDestroyResult(), or NULL if libcurl support is disabled

References CPLHTTPResult::nDataLen, CPLHTTPResult::nStatus, CPLHTTPResult::papszHeaders, CPLHTTPResult::pszContentType, and CPLHTTPResult::pszErrBuf.

int CPLHTTPParseMultipartMime ( CPLHTTPResult psResult  ) 

Parses a a MIME multipart message.

This function will iterate over each part and put it in a separate element of the pasMimePart array of the provided psResult structure.

Parameters:
psResult pointer to the return value of CPLHTTPFetch()
Returns:
TRUE if the message contains MIME multipart message.

References CPLMimePart::nDataLen, CPLHTTPResult::nDataLen, CPLHTTPResult::nMimePartCount, CPLMimePart::pabyData, CPLHTTPResult::pabyData, CPLMimePart::papszHeaders, CPLHTTPResult::pasMimePart, and CPLHTTPResult::pszContentType.

char* GOA2GetAccessToken ( const char *  pszRefreshToken,
const char *  pszScope 
)

Fetch access token using refresh token.

The permanent refresh token is used to fetch a temporary (usually one hour) access token using Google OAuth2 web services.

A CPLError will be reported if the request fails for some reason. Common reasons include the refresh token having been revoked by the user or http connection problems.

Parameters:
pszRefreshToken the refresh token from GOA2GetRefreshToken().
pszScope the scope for which it is valid.
Returns:
access token, to be freed with CPLFree(), null on failure.

References CPLStringList::AddString(), CPLStringList::FetchNameValueDef(), CPLHTTPResult::pabyData, and CPLHTTPResult::pszErrBuf.

char* GOA2GetAuthorizationURL ( const char *  pszScope  ) 

Return authorization url for a given scope.

Returns the URL that a user should visit, and use for authentication in order to get an "auth token" indicating their willingness to use a service.

Note that when the user visits this url they will be asked to login (using a google/gmail/etc) account, and to authorize use of the requested scope for the application "GDAL/OGR". Once they have done so, they will be presented with a lengthy string they should "enter into their application". This is the "auth token" to be passed to GOA2GetRefreshToken(). The "auth token" can only be used once.

This function should never fail.

Parameters:
pszScope the service being requested, not yet URL encoded, such as "https://www.googleapis.com/auth/fusiontables".
Returns:
the URL to visit - should be freed with CPLFree().
char* GOA2GetRefreshToken ( const char *  pszAuthToken,
const char *  pszScope 
)

Turn Auth Token into a Refresh Token.

A one time "auth token" provided by the user is turned into a reusable "refresh token" using a google oauth2 web service.

A CPLError will be reported if the translation fails for some reason. Common reasons include the auth token already having been used before, it not being appropriate for the passed scope and configured client api or http connection problems. NULL is returned on error.

Parameters:
pszAuthToken the authorization token from the user.
pszScope the scope for which it is valid.
Returns:
refresh token, to be freed with CPLFree(), null on failure.

References CPLStringList::AddString(), CPLStringList::FetchNameValueDef(), CPLHTTPResult::pabyData, and CPLHTTPResult::pszErrBuf.


Generated for GDAL by doxygen 1.7.1.