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 #define CONTROL_KEY_BUFSIZ 41
  37
  38 typedef struct FCGIValue {
  39         const char *key;
  40         void *value;
  41         unsigned flags;
  42 } FCGIValue;
  43
  44 typedef enum {USER_UNAUTH, USER_NORMAL, USER_ADMIN} UserType;
  45
  46 /**Contextual information related to FCGI requests*/
  47 typedef struct
  48 {
  49         /**The time of last valid user access possessing the control key**/
  50         time_t control_timestamp;
  51         /**A SHA-1 hash that is the control key, determining who is logged in**/
  52         char control_key[CONTROL_KEY_BUFSIZ];
  53         /**The received control key for the current request**/
  54         char received_key[CONTROL_KEY_BUFSIZ];
  55         /**The IPv4 address of the logged-in user**/
  56         char control_ip[16];
  57         /**Determines if the user is an admin or not**/
  58         UserType user_type;
  59         /**Name of the logged in user**/
  60         char user_name[31];
  61         /**User directory for the logged in user**/
  62         char user_dir[BUFSIZ];
  63         /**The name of the current module**/
  64         const char *current_module;
  65         /**For debugging purposes?**/
  66         int response_number;
  67 } FCGIContext;
  68
  69 typedef void (*ModuleHandler) (FCGIContext *context, char *params);
  70
  71 extern bool FCGI_LockControl(FCGIContext *context, const char * user_name, UserType user_type);
  72 extern void FCGI_ReleaseControl(FCGIContext *context);
  73 extern bool FCGI_HasControl(FCGIContext *context);
  74 extern void FCGI_GetControlCookie(char buffer[CONTROL_KEY_BUFSIZ]);
  75 extern void FCGI_SendControlCookie(FCGIContext *context, bool set);
  76 extern char *FCGI_KeyPair(char *in, const char **key, const char **value);
  77 extern bool FCGI_ParseRequest(FCGIContext *context, char *params, FCGIValue values[], size_t count);
  78 extern void FCGI_BeginJSON(FCGIContext *context, StatusCodes status_code);
  79 extern void FCGI_AcceptJSON(FCGIContext *context, const char *description);
  80 extern void FCGI_JSONPair(const char *key, const char *value);
  81 extern void FCGI_JSONLong(const char *key, long value);
  82 extern void FCGI_JSONDouble(const char *key, double value);
  83 extern void FCGI_JSONBool(const char *key, bool value);
  84 extern void FCGI_JSONKey(const char *key);
  85 extern void FCGI_PrintRaw(const char *format, ...);
  86 extern void FCGI_EndJSON();
  87 extern void FCGI_RejectJSONEx(FCGIContext *context, StatusCodes status, const char *description);
  88 extern char *FCGI_URLDecode(char *buf);
  89 extern char *FCGI_EscapeText(char *buf);
  90 extern void *FCGI_RequestLoop (void *data);
  91
  92 extern void FCGI_WriteBinary(void * data, size_t size, size_t num_elem);
  93
  94 /**
  95  * Shortcut to calling FCGI_RejectJSONEx. Sets the error code
  96  * to STATUS_ERROR.
  97  * @param context The context to work in
  98  * @param description A short description of why the request was rejected.
  99  * @see FCGI_RejectJSONEx
 100  */
 101 #define FCGI_RejectJSON(context, description) FCGI_RejectJSONEx(context, STATUS_ERROR, description)
 102
 103 /**
 104  * Custom formatting function for the JSON value. To be used in
 105  * conjunction with FCGI_JSONKey. Care should be taken to ensure
 106  * that valid JSON is produced.
 107  * @see FCGI_PrintRaw for calling syntax
 108  */
 109 #define FCGI_JSONValue FCGI_PrintRaw
 110
 111 #endif
 112
 113