server/fastcgi.h

   1 /**
   2  * @file fastcgi.h
   3  * @brief Headers for the fastcgi web interface
   4  */
   5
   6 #ifndef _FASTCGI_H
   7 #define _FASTCGI_H
   8
   9 /**
  10  * Status codes that fcgi module handlers can return
  11  * Success status codes have values > 0
  12  * Failure status codes have values <(=) 0
  13  * Note: 0 is counted as an error code to minimise confusion
  14  * with in-browser JSON parsing error codes
  15  */
  16 typedef enum StatusCodes {
  17         STATUS_OK = 1,
  18         STATUS_ERROR = -1,
  19         STATUS_UNAUTHORIZED = -2,
  20         STATUS_NOTRUNNING = -3,
  21         STATUS_ALREADYEXISTS = -4
  22 } StatusCodes;
  23
  24 #define FCGI_PARAM_REQUIRED (1 << 0)
  25 #define FCGI_PARAM_RECEIVED (1 << 1)
  26 #define FCGI_BOOL_T (1 << 2)
  27 #define FCGI_INT_T      (1 << 3)
  28 #define FCGI_LONG_T (1 << 4)
  29 #define FCGI_DOUBLE_T (1 << 5)
  30 #define FCGI_STRING_T (1 << 6)
  31 #define FCGI_REQUIRED(x) ((x) | FCGI_PARAM_REQUIRED)
  32 #define FCGI_IS_REQUIRED(x) ((x) & FCGI_PARAM_REQUIRED)
  33 #define FCGI_RECEIVED(x) ((x) & FCGI_PARAM_RECEIVED)
  34 #define FCGI_TYPE(x) ((x) & ~(FCGI_PARAM_REQUIRED | FCGI_PARAM_RECEIVED))
  35
  36 typedef struct FCGIValue {
  37         const char *key;
  38         void *value;
  39         unsigned flags;
  40 } FCGIValue;
  41
  42 /**Contextual information related to FCGI requests*/
  43 typedef struct
  44 {
  45         /**The time of last valid user access possessing the control key**/
  46         time_t control_timestamp;
  47         /**A SHA-1 hash that is the control key, determining who is logged in**/
  48         char control_key[41];
  49         /**The IPv4 address of the logged-in user**/
  50         char control_ip[16];
  51         /**A friendly name for the logged-in user. Max length 30**/
  52         char friendly_name[31];
  53         /**The name of the current module**/
  54         const char *current_module;
  55         /**For debugging purposes?**/
  56         int response_number;
  57 } FCGIContext;
  58
  59 typedef void (*ModuleHandler) (FCGIContext *context, char *params);
  60
  61 extern bool FCGI_LockControl(FCGIContext *context, bool force);
  62 extern void FCGI_ReleaseControl(FCGIContext *context);
  63 extern bool FCGI_HasControl(FCGIContext *context, const char *key);
  64 extern char *FCGI_KeyPair(char *in, const char **key, const char **value);
  65 extern bool FCGI_ParseRequest(FCGIContext *context, char *params, FCGIValue values[], size_t count);
  66 extern void FCGI_BeginJSON(FCGIContext *context, StatusCodes status_code);
  67 extern void FCGI_AcceptJSON(FCGIContext *context, const char *description, const char *cookie);
  68 extern void FCGI_JSONPair(const char *key, const char *value);
  69 extern void FCGI_JSONLong(const char *key, long value);
  70 extern void FCGI_JSONDouble(const char *key, double value);
  71 extern void FCGI_JSONBool(const char *key, bool value);
  72 extern void FCGI_JSONKey(const char *key);
  73 extern void FCGI_PrintRaw(const char *format, ...);
  74 extern void FCGI_EndJSON();
  75 extern void FCGI_RejectJSONEx(FCGIContext *context, StatusCodes status, const char *description);
  76 extern char *FCGI_EscapeText(char *buf);
  77 extern void *FCGI_RequestLoop (void *data);
  78
  79 extern void FCGI_WriteBinary(void * data, size_t size, size_t num_elem);
  80
  81 /**
  82  * Shortcut to calling FCGI_RejectJSONEx. Sets the error code
  83  * to STATUS_ERROR.
  84  * @param context The context to work in
  85  * @param description A short description of why the request was rejected.
  86  * @see FCGI_RejectJSONEx
  87  */
  88 #define FCGI_RejectJSON(context, description) FCGI_RejectJSONEx(context, STATUS_ERROR, description)
  89
  90 /**
  91  * Custom formatting function for the JSON value. To be used in
  92  * conjunction with FCGI_JSONKey. Care should be taken to ensure
  93  * that valid JSON is produced.
  94  * @see FCGI_PrintRaw for calling syntax
  95  */
  96 #define FCGI_JSONValue FCGI_PrintRaw
  97
  98 #endif
  99
 100