src/core/sipe-http.h

   1 /**
   2  * @file sipe-http.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2013 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  *
  23  *
  24  * Public interface to HTTP request service
  25  */
  26
  27 /*
  28  * Interface dependencies:
  29  *
  30  * <glib.h>
  31  */
  32
  33 /* Forward declarations */
  34 struct sipe_core_private;
  35 struct sipe_http_request;
  36 struct sipe_http_session;
  37
  38 /**
  39  * HTTP response callback
  40  *
  41  * @param sipe_private  SIPE core private data
  42  * @param status        status code
  43  * @param headers       response headers (@c NULL if request aborted)
  44  * @param body          response body    (@c NULL if request aborted)
  45  * @param callback_data callback data
  46  */
  47 typedef void (sipe_http_response_callback)(struct sipe_core_private *sipe_private,
  48                                            guint status,
  49                                            GSList *headers,
  50                                            const gchar *body,
  51                                            gpointer callback_data);
  52
  53 /* HTTP response status codes */
  54 #define SIPE_HTTP_STATUS_OK                  200
  55 #define SIPE_HTTP_STATUS_REDIRECTION         300 /* - 399 */
  56 #define SIPE_HTTP_STATUS_CLIENT_ERROR        400 /* - 499 */
  57 #define SIPE_HTTP_STATUS_CLIENT_UNAUTHORIZED 401
  58 #define SIPE_HTTP_STATUS_CLIENT_FORBIDDEN    403
  59
  60 /**
  61  * Free HTTP data
  62  *
  63  * @param sipe_private SIPE core private data
  64  */
  65 void sipe_http_free(struct sipe_core_private *sipe_private);
  66
  67 /**
  68  * Start HTTP session
  69  *
  70  * @return pointer to opaque HTTP session data structure
  71  */
  72 struct sipe_http_session *sipe_http_session_start(void);
  73
  74 /**
  75  * Close HTTP session
  76  *
  77  * @param session pointer to opaque HTTP session data structure
  78  */
  79 void sipe_http_session_close(struct sipe_http_session *session);
  80
  81 /**
  82  * Create HTTP GET request
  83  *
  84  * @param sipe_private  SIPE core private data
  85  * @param uri           URI
  86  * @param headers       additional headers (may be @c NULL)
  87  * @param callback      callback function
  88  * @param callback_data callback data
  89  *
  90  * @return pointer to opaque HTTP request data structure (@c NULL if failed)
  91  */
  92 struct sipe_http_request *sipe_http_request_get(struct sipe_core_private *sipe_private,
  93                                                 const gchar *uri,
  94                                                 const gchar *headers,
  95                                                 sipe_http_response_callback *callback,
  96                                                 gpointer callback_data);
  97
  98 /**
  99  * Create HTTP POST request
 100  *
 101  * @param sipe_private  SIPE core private data
 102  * @param uri           URI
 103  * @param headers       additional headers (may be @c NULL)
 104  * @param body          body contents
 105  * @param content_type  body content type
 106  * @param callback      callback function
 107  * @param callback_data callback data
 108  *
 109  * @return pointer to opaque HTTP request data structure (@c NULL if failed)
 110  */
 111 struct sipe_http_request *sipe_http_request_post(struct sipe_core_private *sipe_private,
 112                                                  const gchar *uri,
 113                                                  const gchar *headers,
 114                                                  const gchar *body,
 115                                                  const gchar *content_type,
 116                                                  sipe_http_response_callback *callback,
 117                                                  gpointer callback_data);
 118
 119 /**
 120  * HTTP request is ready to be sent
 121  *
 122  * @param request pointer to opaque HTTP request data structure
 123  */
 124 void sipe_http_request_ready(struct sipe_http_request *request);
 125
 126 /**
 127  * Cancel pending HTTP request
 128  *
 129  * @param request pointer to opaque HTTP request data structure
 130  */
 131 void sipe_http_request_cancel(struct sipe_http_request *request);
 132
 133 /**
 134  * Assign request to HTTP session
 135  *
 136  * @param request pointer to opaque HTTP request data structure
 137  * @param session pointer to opaque HTTP session data structure
 138  */
 139 void sipe_http_request_session(struct sipe_http_request *request,
 140                                struct sipe_http_session *session);
 141
 142 /**
 143  * Allow redirection of HTTP request
 144  *
 145  * @param request pointer to opaque HTTP request data structure
 146  */
 147 void sipe_http_request_allow_redirect(struct sipe_http_request *request);
 148
 149 /**
 150  * Provide authentication information for HTTP request
 151  *
 152  * @param request  pointer to opaque HTTP request data structure
 153  * @param domain   domain name (MUST stay valid for duration of request!)
 154  * @param user     user name   (MUST stay valid for duration of request!)
 155  * @param password Password    (MUST stay valid for duration of request!)
 156  */
 157 void sipe_http_request_authentication(struct sipe_http_request *request,
 158                                       const gchar *domain,
 159                                       const gchar *user,
 160                                       const gchar *password);