winix/core/request.h

/*
 * This file is a part of CMSLU -- Content Management System like Unix
 * and is not publicly distributed
 * 
 * Copyright (c) 2008-2009, Tomasz Sowa
 * All rights reserved.
 * 
 */
 
#ifndef headerfilecmslucorerequest
#define headerfilecmslucorerequest

#include <fcgiapp.h>
#include <sstream>
#include <vector>
#include <iomanip>

#include "requesttypes.h"
#include "session.h"
#include "item.h"
#include "error.h"
#include "function.h"
#include "thread.h"
#include "compress.h"
#include "acceptencodingparser.h"
#include "htmlfilter.h"
#include "postmultiparser.h"
#include "ticket.h"


struct Request
{
	// request id
	// is incremented for each request and is never 0
	// (from -1 will be incremented twice)
	// it's used for some optimalization e.g. in templates
	size_t id;

	
    FCGX_Stream * in,  * out, * err;
    FCGX_ParamArray env; // defined as 'char **'


	enum Method { get, post, none } method;
	enum Role   { responder, authorizer } role;

	// headers, page and debug
	// notify (for mailing)
	std::ostringstream headers, page, debug, notify;

	
	GetTable      get_table;
	PostTable     post_table;
	PostFileTable post_file_table;
	CookieTable   cookie_table;
	
	// environment variables
	// they are not null -- when the server doesn't have such a variable
	// it will be pointing into 'char_empty' which is default '\0'
	const char * env_request_method;
	const char * env_request_uri;
	const char * env_http_cookie;
	const char * env_remote_addr;
	const char * env_http_host;
	const char * env_http_user_agent;
	const char * env_http_accept_encoding;
	const char * env_fcgi_role;
	const char * env_content_type;
	
	// true if the browser is Microsoft Internet Explorer
	bool browser_msie;
	
    // true if the browser is Konqueror
    bool browser_konqueror;

	// current session
	// is set after calling session_manager.SetSession()
	Session * session;

	// current directory
	std::vector<Item*> dir_table;

	bool is_item;
	
	// this item is used for many purposes such as editing, adding an item etc.
	Item item;

	// null if there is no a function
	Function * pfunction;	
	
	// !! moze nazwac to poprostu param?
	std::vector<std::string*> param_table;
	
	Error status;
	
	// last notify
	int notify_code;

	// items in the current directory
	// maybe without contents?
	std::vector<Item> item_table;

	// current thread (if exists)
	bool is_thread;
	Thread thread;
	std::vector<Thread> thread_tab;

	// current ticket (if exists)
	bool is_ticket;
	Ticket ticket;
	std::vector<Ticket> ticket_tab;

	// if not empty means an address for redirecting to
	std::string redirect_to;

	// send header X-LIGHTTPD-send-file with path to a file
	std::string x_sendfile;

	// send as attachment (causing header: content-disposition: attachment)
	bool send_as_attachment;

	// for debugging
	void PrintGetTable();
	void PrintEnv();
	void PrintIn();
		
	Request();
	void ClearPostFileTmp();
	void Clear();

	void Init();

	bool IsParam(const char * s);

	void SetCookie(const char * name, const char * value, tm * expires = 0);
	void SetCookie(const char * name, long value,         tm * expires = 0);

	bool IsPostVar(const char * var);
	std::string * PostVar(const char * var); // it can return null when there is no such a post variable
	bool PostVar(const char * var, std::string & result);
	bool AllPostVarEmpty(); // returning true if all post vars are empty

	void ReadEnvVariables();
	void CheckMethod();
	void ReadParameters();
	void Read();
	void SendAll();
	void SendNotify();
	
	bool CanChangeUser(const Item & item, long new_user_id);
	bool CanChangeGroup(const Item & item, long new_group_id);
	bool CanChangePrivileges(const Item & item, int new_priv);
	
	bool HasAccess(const Item & item, int mask);
	bool HasReadAccess(const Item & item);
	bool HasWriteAccess(const Item & item);
	bool HasReadWriteAccess(const Item & item);
	bool HasReadExecAccess(const Item & item);
	bool HasReadExecAccessForRoot(const Item & item);

	bool CanCreateThread(bool check_root = false);
	bool CanCreateTicket(bool check_root = false);
	bool CanEditTicket();
	bool CanRemove(const Item & item);
	bool CanUseEmacs(const Item & item, bool check_root = false);
	bool CanUseMkdir(const Item & item, bool check_root = false);
	bool CanUseUpload(const Item & item, bool check_root = false);

	bool CanUseHtml(long user_id);
	bool CanUseBBCode(long user_id);
	bool CanUseRaw(long user_id);

	bool MakePathSimpleFs(std::string & path, bool create_dir = false);
	bool MakePathHashFs(std::string & path, long id, bool create_dir = false);
	bool MakePath(std::string & path, bool create_dir = false);

private:

	enum Header
	{
		h_200,
		h_404,
		h_403
	};

	bool CanUse(long user_id, const char * group_name);

	void SendSessionCookie();
	void CheckIE();
    void CheckKonqueror();

	void SendHeaders(bool compressing, Header header);
	void AddDebugInfo();
	void SendPage(bool compressing, const std::string & source_ref);

	// used to set some env_* variables into it, when the server didn't set that variable
	// it contains '\0'
	const char char_empty;


	PostMultiParser post_multi_parser;

	const char * SetEnvVar(const char * var);
	void StandardLog();
	
	Compress compress;
	AcceptEncodingParser accept_encoding_parser;	
	HTMLFilter html_filter;


	// html after filtering
	std::string clean_html;

};



extern Request request;



#endif