106 lines
3.9 KiB
C
106 lines
3.9 KiB
C
/******************************************************************************
|
|
* $Id: cpl_http.h 33666 2016-03-07 05:21:07Z goatbar $
|
|
*
|
|
* Project: Common Portability Library
|
|
* Purpose: Function wrapper for libcurl HTTP access.
|
|
* Author: Frank Warmerdam, warmerdam@pobox.com
|
|
*
|
|
******************************************************************************
|
|
* Copyright (c) 2006, Frank Warmerdam
|
|
* Copyright (c) 2009, Even Rouault <even dot rouault at mines-paris dot org>
|
|
*
|
|
* 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 CPL_HTTP_H_INCLUDED
|
|
#define CPL_HTTP_H_INCLUDED
|
|
|
|
#include "cpl_conv.h"
|
|
#include "cpl_string.h"
|
|
#include "cpl_vsi.h"
|
|
|
|
/**
|
|
* \file cpl_http.h
|
|
*
|
|
* Interface for downloading HTTP, FTP documents
|
|
*/
|
|
|
|
CPL_C_START
|
|
|
|
/*! Describe a part of a multipart message */
|
|
typedef struct {
|
|
/*! NULL terminated array of headers */ char **papszHeaders;
|
|
|
|
/*! Buffer with data of the part */ GByte *pabyData;
|
|
/*! Buffer length */ int nDataLen;
|
|
} CPLMimePart;
|
|
|
|
/*! Describe the result of a CPLHTTPFetch() call */
|
|
typedef struct {
|
|
/*! cURL error code : 0=success, non-zero if request failed */
|
|
int nStatus;
|
|
|
|
/*! Content-Type of the response */
|
|
char *pszContentType;
|
|
|
|
/*! Error message from curl, or NULL */
|
|
char *pszErrBuf;
|
|
|
|
/*! Length of the pabyData buffer */
|
|
int nDataLen;
|
|
int nDataAlloc;
|
|
|
|
/*! Buffer with downloaded data */
|
|
GByte *pabyData;
|
|
|
|
/*! Headers returned */
|
|
char **papszHeaders;
|
|
|
|
/*! Number of parts in a multipart message */
|
|
int nMimePartCount;
|
|
|
|
/*! Array of parts (resolved by CPLHTTPParseMultipartMime()) */
|
|
CPLMimePart *pasMimePart;
|
|
|
|
} CPLHTTPResult;
|
|
|
|
int CPL_DLL CPLHTTPEnabled( void );
|
|
CPLHTTPResult CPL_DLL *CPLHTTPFetch( const char *pszURL, char **papszOptions);
|
|
void CPL_DLL CPLHTTPCleanup( void );
|
|
void CPL_DLL CPLHTTPDestroyResult( CPLHTTPResult *psResult );
|
|
int CPL_DLL CPLHTTPParseMultipartMime( CPLHTTPResult *psResult );
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/* The following is related to OAuth2 authorization around */
|
|
/* google services like fusion tables, and potentially others */
|
|
/* in the future. Code in cpl_google_oauth2.cpp. */
|
|
/* */
|
|
/* These services are built on CPL HTTP services. */
|
|
/* -------------------------------------------------------------------- */
|
|
|
|
char CPL_DLL *GOA2GetAuthorizationURL( const char *pszScope );
|
|
char CPL_DLL *GOA2GetRefreshToken( const char *pszAuthToken,
|
|
const char *pszScope );
|
|
char CPL_DLL *GOA2GetAccessToken( const char *pszRefreshToken,
|
|
const char *pszScope );
|
|
|
|
CPL_C_END
|
|
|
|
#endif /* ndef CPL_HTTP_H_INCLUDED */
|