Automatic commit of irc logs

[matches/MCTX3420.git] / server / fastcgi.h

diff --git a/server/fastcgi.h b/server/fastcgi.h
index c1e0b3e..09884d1 100644 (file)
--- a/server/fastcgi.h
+++ b/server/fastcgi.h
@@ -17,7 +17,8 @@ typedef enum StatusCodes {
        STATUS_OK = 1,
        STATUS_ERROR = -1,
        STATUS_UNAUTHORIZED = -2,
-       STATUS_OUTOFRANGE = -3
+       STATUS_NOTRUNNING = -3,
+       STATUS_ALREADYEXISTS = -4
 } StatusCodes;
 
 #define FCGI_PARAM_REQUIRED (1 << 0)
@@ -32,21 +33,59 @@ typedef enum StatusCodes {
 #define FCGI_RECEIVED(x) ((x) & FCGI_PARAM_RECEIVED)
 #define FCGI_TYPE(x) ((x) & ~(FCGI_PARAM_REQUIRED | FCGI_PARAM_RECEIVED))
 
+#define CONTROL_KEY_BUFSIZ 41
+
+/**
+ * An entry that describes an expected user parameter for parsing.
+ * To be used in conjunction with @see FCGI_ParseRequest.
+ */
 typedef struct FCGIValue {
+       /** The name of the key (from key/value pair) [in] **/
        const char *key;
+       /** A pointer to a variable that will hold the parsed value [out] **/
        void *value;
+       /** Bit flags that determine things like if the field is required and if it was received [in/out] **/
        unsigned flags;
 } FCGIValue;
 
-typedef struct FCGIContext FCGIContext;
+/** The type of a user (unauthorised, normal, admin). **/
+typedef enum {USER_UNAUTH, USER_NORMAL, USER_ADMIN} UserType;
+
+/**Contextual information related to FCGI requests*/
+typedef struct  
+{
+       /**The time of last valid user access possessing the control key**/
+       time_t control_timestamp;
+       /**A SHA-1 hash that is the control key, determining who is logged in**/
+       char control_key[CONTROL_KEY_BUFSIZ]; 
+       /**The received control key for the current request**/
+       char received_key[CONTROL_KEY_BUFSIZ];
+       /**The IPv4 address of the logged-in user**/
+       char control_ip[16];
+       /**Determines if the user is an admin or not**/
+       UserType user_type;
+       /**Name of the logged in user**/
+       char user_name[31];
+       /**User directory for the logged in user**/
+       char user_dir[BUFSIZ];
+       /**The name of the current module**/
+       const char *current_module;
+       /**For debugging purposes?**/
+       int response_number;
+} FCGIContext;
+
+/** The type definition of a module handler. **/
 typedef void (*ModuleHandler) (FCGIContext *context, char *params);
 
-extern void FCGI_LockControl(FCGIContext *context, bool force);
+extern bool FCGI_LockControl(FCGIContext *context, const char * user_name, UserType user_type);
 extern void FCGI_ReleaseControl(FCGIContext *context);
-extern bool FCGI_HasControl(FCGIContext *context, const char *key);
+extern bool FCGI_HasControl(FCGIContext *context);
+extern void FCGI_GetControlCookie(char buffer[CONTROL_KEY_BUFSIZ]);
+extern void FCGI_SendControlCookie(FCGIContext *context, bool set);
 extern char *FCGI_KeyPair(char *in, const char **key, const char **value);
 extern bool FCGI_ParseRequest(FCGIContext *context, char *params, FCGIValue values[], size_t count);
 extern void FCGI_BeginJSON(FCGIContext *context, StatusCodes status_code);
+extern void FCGI_AcceptJSON(FCGIContext *context, const char *description);
 extern void FCGI_JSONPair(const char *key, const char *value);
 extern void FCGI_JSONLong(const char *key, long value);
 extern void FCGI_JSONDouble(const char *key, double value);
@@ -55,9 +94,12 @@ extern void FCGI_JSONKey(const char *key);
 extern void FCGI_PrintRaw(const char *format, ...);
 extern void FCGI_EndJSON();
 extern void FCGI_RejectJSONEx(FCGIContext *context, StatusCodes status, const char *description);
+extern char *FCGI_URLDecode(char *buf);
 extern char *FCGI_EscapeText(char *buf);
 extern void *FCGI_RequestLoop (void *data);
 
+extern void FCGI_WriteBinary(void * data, size_t size, size_t num_elem);
+
 /**
  * Shortcut to calling FCGI_RejectJSONEx. Sets the error code
  * to STATUS_ERROR.