curl_tools.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
#ifndef GRASSROOTS_CURL_TOOLS_H
#define GRASSROOTS_CURL_TOOLS_H
 
#include <stdio.h>
 
#include <curl/curl.h>
 
#include "jansson.h"
 
#include "typedefs.h"
#include "network_library.h"
#include "byte_buffer.h"
 
 
typedef enum CurlMode
{
  CM_MEMORY,
 
  CM_FILE,
 
  CM_NUM_MODES
} CurlMode;
 
 
typedef struct TemporaryFile
{
  FILE *tf_temp_f;
 
  char *tf_temp_file_contents_s;
 
  size_t tf_temp_file_size;
 
} TemporaryFile;
 
 
typedef struct CurlTool
{
  CURL *ct_curl_p;
 
 
  char *ct_username_s;
 
  char *ct_password_s;
 
 
  CurlMode ct_mode;
 
  ByteBuffer *ct_buffer_p;
 
  TemporaryFile *ct_temp_file_p;
 
  struct curl_httppost *ct_form_p;
 
  struct curl_httppost *ct_last_field_p;
 
  struct curl_slist *ct_headers_list_p;
} CurlTool;
 
 
 
#ifdef __cplusplus
  extern "C" {
#endif
 
 
 
GRASSROOTS_NETWORK_API void FreeCurlTool (CurlTool *curl_p);
 
 
GRASSROOTS_NETWORK_LOCAL void FreeCurl (CURL *curl_p);
 
GRASSROOTS_NETWORK_API bool SetSSLEngine (CurlTool *curl_p, const char *cryptograph_engine_name_s);
 
 
GRASSROOTS_NETWORK_API bool CallSecureUrl (const char *url_s, const char *header_data_s, const char *ca_cert_name_s, const char * const cert_name_s, const char *key_name_s, const bool verify_certs, ByteBuffer *buffer_p);
 
 
GRASSROOTS_NETWORK_API bool AddCurlCallback (CurlTool *curl_tool_p, curl_write_callback callback_fn, void *callback_data_p);
 
 
GRASSROOTS_NETWORK_API bool SetUriForCurlTool (CurlTool *tool_p, const char * const uri_s);
 
 
GRASSROOTS_NETWORK_API CURLcode RunCurlTool (CurlTool *tool_p);
 
 
GRASSROOTS_NETWORK_API bool SetCurlToolForJSONPost (CurlTool *tool_p);
 
 
GRASSROOTS_NETWORK_API const char *GetCurlToolData (CurlTool * const tool_p);
 
 
 
GRASSROOTS_NETWORK_API size_t GetCurlToolDataSize (CurlTool * const tool_p);
 
 
GRASSROOTS_NETWORK_API bool MakeRemoteJSONCallFromCurlTool (CurlTool *tool_p, const json_t *req_p);
 
 
GRASSROOTS_NETWORK_API bool SetCurlToolHeader (CurlTool *tool_p, const char *key_s, const char *value_s);
 
 
GRASSROOTS_NETWORK_API bool SetCurlToolAuth (CurlTool *tool_p, const char *username_s, const char *password_s);
 
 
GRASSROOTS_NETWORK_API void ClearCurlToolAuth (CurlTool *tool_p);
 
 
 
GRASSROOTS_NETWORK_API char *GetURLEscapedString (CurlTool *tool_p, const char *src_s);
 
 
GRASSROOTS_NETWORK_API void FreeURLEscapedString (char *value_s);
 
 
 
GRASSROOTS_NETWORK_API CurlTool *AllocateFileCurlTool (const char * const filename_s);
 
 
 
GRASSROOTS_NETWORK_API CurlTool *AllocateMemoryCurlTool (const size_t buffer_size);
 
 
GRASSROOTS_NETWORK_API char *GetWebData (const char *url_s);
 
 
 
GRASSROOTS_NETWORK_API void SetCurlToolTimeout (CurlTool *tool_p, const long timeout);
 
 
GRASSROOTS_NETWORK_LOCAL TemporaryFile *AllocateTemporaryFile (const char * const filename_s);
 
 
 
GRASSROOTS_NETWORK_LOCAL void FreeTemporaryFile (TemporaryFile *temp_p);
 
 
GRASSROOTS_NETWORK_LOCAL char *GetTemporaryFileContentsAsString (TemporaryFile *temp_p);
 
 
GRASSROOTS_NETWORK_API void ClearCurlToolData (CurlTool *tool_p);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif    /* #ifndef GRASSROOTS_CURL_TOOLS_H */