X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=server%2Ffastcgi.h;h=09884d1a729aca863937c3be224eac3ece208a20;hb=HEAD;hp=269bb94a5d00f972207e78d42de89f1e54f5430d;hpb=826791abc3a3bb383c2908d7d39618b99ad7665c;p=matches%2FMCTX3420.git diff --git a/server/fastcgi.h b/server/fastcgi.h index 269bb94..09884d1 100644 --- a/server/fastcgi.h +++ b/server/fastcgi.h @@ -33,38 +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; +/** 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[41]; + 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]; - /**A friendly name for the logged-in user. Max length 30**/ - char friendly_name[31]; + /**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 bool 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, const char *cookie); +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); @@ -73,6 +94,7 @@ 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);