khanat-opennel-code/code/ryzom/client/src/interface_v3/group_html.h

// Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
// Copyright (C) 2010  Winch Gate Property Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.




#ifndef CL_GROUP_HTML_H
#define CL_GROUP_HTML_H

#define CURL_STATICLIB 1
#include <curl/curl.h>

#include "nel/misc/types_nl.h"
#include "interface_group.h"
#include "group_scrolltext.h"
#include "group_tree.h"
#include "ctrl_button.h"
#include "group_table.h"

extern "C"
{
#include "WWWInit.h"
}

class CGroupList;
class CCtrlScroll;
class CCtrlButton;
class CDBGroupComboBox;
class CGroupParagraph;

// HTML group
/**
 * Widget to have a resizable scrolltext and its scrollbar
 * \author Cyril 'Hulud' Corvazier
 * \author Nevrax France
 * \date 2002
 */
class CGroupHTML : public CGroupScrollText
{
public:
	friend void TextAdd (struct _HText *me, const char * buf, int len);
	friend void	TextBeginElement (_HText *me, int element_number, const BOOL *present, const char **	value);
	friend void TextEndElement (_HText *me, int element_number);
	friend void TextLink (struct _HText *me, int element_number, int attribute_number, struct _HTChildAnchor *anchor, const BOOL *present, const char **value);
	friend void TextBuild (HText * me, HTextStatus status);
	friend void TextBeginUnparsedElement(HText *me, const char *buffer, int length);
	friend void TextEndUnparsedElement(HText *me, const char *buffer, int length);
	friend int requestTerminater (HTRequest * request, HTResponse * response, void * param, int status);



	// Constructor
	CGroupHTML(const TCtorParam &param);
	~CGroupHTML();

	// CInterfaceGroup Interface
	virtual bool parse (xmlNodePtr cur, CInterfaceGroup *parentGroup);
	virtual void draw ();

	// Events
	virtual bool handleEvent (const CEventDescriptor& eventDesc);

	// Browse
	virtual void browse (const char *url);

	// Refresh
	void refresh();

	// submit form
	void submitForm (uint formId, const char *submitButtonName);

	// Browse error
	void browseError (const char *msg);

	// stop browse
	void stopBrowse ();

	bool isBrowsing();

	void clean() { stopBrowse(); updateRefreshButton(); removeContent(); }

	// Update coords
	void updateCoords();

	// New paragraph
	void newParagraph(uint beginSpace);

	// End of the paragraph
	void endParagraph();

	// Timeout
	void	setTimeout(float tm) {_TimeoutValue= std::max(0.f, tm);}
	float	getTimeout() const {return (float)_TimeoutValue;}

	// Some constants
	NLMISC::CRGBA	BgColor;
	NLMISC::CRGBA	ErrorColor;
	NLMISC::CRGBA	LinkColor;
	NLMISC::CRGBA	TextColor;
	NLMISC::CRGBA	H1Color;
	NLMISC::CRGBA	H2Color;
	NLMISC::CRGBA	H3Color;
	NLMISC::CRGBA	H4Color;
	NLMISC::CRGBA	H5Color;
	NLMISC::CRGBA	H6Color;
	bool			ErrorColorGlobalColor;
	bool			LinkColorGlobalColor;
	bool			TextColorGlobalColor;
	bool			H1ColorGlobalColor;
	bool			H2ColorGlobalColor;
	bool			H3ColorGlobalColor;
	bool			H4ColorGlobalColor;
	bool			H5ColorGlobalColor;
	bool			H6ColorGlobalColor;
	uint			TextFontSize;
	uint			H1FontSize;
	uint			H2FontSize;
	uint			H3FontSize;
	uint			H4FontSize;
	uint			H5FontSize;
	uint			H6FontSize;
	uint			TDBeginSpace;
	uint			PBeginSpace;
	uint			LIBeginSpace;
	uint			ULBeginSpace;
	uint			LIIndent;
	uint			ULIndent;
	float			LineSpaceFontFactor;
	std::string		DefaultButtonGroup;
	std::string		DefaultFormTextGroup;
	std::string		DefaultFormTextAreaGroup;
	std::string		DefaultFormSelectGroup;
	std::string		DefaultCheckBoxBitmapNormal;
	std::string		DefaultCheckBoxBitmapPushed;
	std::string		DefaultCheckBoxBitmapOver;
	std::string		DefaultBackgroundBitmapView;

	// Browser home
	std::string		Home;

	// Undo browse: Browse the precedent url browsed. no op if none
	void browseUndo ();
	// Redo browse: Browse the precedent url undoed. no op if none
	void browseRedo ();
	// clear undo/redo
	void clearUndoRedo();


	std::string getURL() const { return _URL; }
	void		setURL(const std::string &url);


	int luaBrowse(CLuaState &ls);
	int luaRefresh(CLuaState &ls);

	REFLECT_EXPORT_START(CGroupHTML, CGroupScrollText)
		REFLECT_LUA_METHOD("browse", luaBrowse)
		REFLECT_LUA_METHOD("refresh", luaRefresh)
		REFLECT_STRING("url", getURL, setURL)
		REFLECT_FLOAT("timeout", getTimeout, setTimeout)
	REFLECT_EXPORT_END

protected :

	// \name callback from libwww

	// Begin of the parsing of a HTML document
	virtual void beginBuild ();

	// End of the parsing of a HTML document
	virtual void endBuild ();

	// A new text block has been parsed
	virtual void addText (const char * buf, int len);

	// A link has been parsed
	virtual void addLink (uint element_number, uint attribute_number, HTChildAnchor *anchor, const BOOL *present, const char **value);

	// A new begin HTML element has been parsed (<IMG> for exemple)
	virtual void beginElement (uint element_number, const BOOL *present, const char **value);

	// A new end HTML element has been parsed (</IMG> for exemple)
	virtual void endElement (uint element_number);

	// A new begin unparsed element has been found
	virtual void beginUnparsedElement(const char *buffer, int length);

	// A new end unparsed element has been found
	virtual void endUnparsedElement(const char *buffer, int length);

	// Add GET params to the url
	virtual void addHTTPGetParams (std::string &url);

	// Add POST params to the libwww list
	virtual void addHTTPPostParams (HTAssocList *formfields);

	// the current request is terminated
	virtual void requestTerminated(HTRequest *request);

	// Get Home URL
	virtual std::string	home();

	// Handle some work at each pass
	virtual void handle ();

	// \name internal methods

	// Add a group in the current parent group
	void addGroup (CInterfaceGroup *group, uint beginSpace);

	// Get the current parent group
	CInterfaceGroup *getCurrentGroup();

	// Update current paragraph dependent data
	void paragraphChange ();

	// Clear the contexts info
	void clearContext();

	// Translate a char
	bool translateChar(ucchar &output, ucchar input, ucchar lastChar) const;

	// Add a string in the current paragraph
	void addString(const ucstring &str);

	// Add an image in the current paragraph
	void addImage(const char *image, bool globalColor);

	// Add a text area in the current paragraph
	CInterfaceGroup *addTextArea (const std::string &templateName, const char *name, uint rows, uint cols, bool multiLine, const ucstring &content);

	// Add a combo box in the current paragraph
	CDBGroupComboBox *addComboBox(const std::string &templateName, const char *name);

	// Add a button in the current paragraph. actionHandler, actionHandlerParams and tooltip can be NULL.
	CCtrlButton *addButton(CCtrlButton::EType type, const std::string &name, const std::string &normalBitmap, const std::string &pushedBitmap,
		const std::string &overBitmap, bool useGlobalColor, const char *actionHandler, const char *actionHandlerParams, const char *tooltip);

	// Set the background color
	void setBackgroundColor (const NLMISC::CRGBA &bgcolor);

	// Force the current string to be in a single string
	void flushString();

	// Set the title
	void setTitle (const ucstring &title);

	// Lookup a url in local file system
	bool lookupLocalFile (std::string &result, const char *url, bool isUrl);

	// Delete page content and prepare next page
	void removeContent ();

	// Current URL
	std::string		_URL;

	// Title prefix
	ucstring		_TitlePrefix;

	// Title string
	ucstring		_TitleString;

	// Need to browse next update coords..
	bool			_BrowseNextTime;
	bool			_PostNextTime;
	uint			_PostFormId;
	std::string		_PostFormSubmitButton;

	// Browsing..
	bool			_Browsing;
	bool			_Connecting;
	double			_TimeoutValue;			// the timeout in seconds
	double			_ConnectingTimeout;

	// minimal embeded lua script support
	// Note : any embeded script is executed immediately after the closing
	// element has been found
	// True when the <lua> element has been encountered
	bool			_ParsingLua;
	// the script to execute
	std::string		_LuaScript;


	// Someone is conecting. We got problem with libwww : 2 connection requests can deadlock the client.
	static CGroupHTML *_ConnectingLock;

	// LibWWW data
	class CLibWWWData	*_LibWWW;

	// Current paragraph
	CGroupParagraph*	_Paragraph;
	inline CGroupParagraph *getParagraph()
	{
		return _Paragraph;
		/*if (_Paragraph.empty())
			return NULL;
		return _Paragraph.back();*/
	}

	// PRE mode
	std::vector<bool>	_PRE;
	inline bool getPRE() const
	{
		if (_PRE.empty())
			return false;
		return _PRE.back();
	}

	// UL mode
	std::vector<bool>	_UL;
	inline bool getUL() const
	{
		if (_UL.empty())
			return false;
		return _UL.back();
	}

	// A mode
	std::vector<bool>	_A;
	inline bool getA() const
	{
		if (_A.empty())
			return false;
		return _A.back();
	}

	// IL mode
	bool _LI;

	// Current text color
	std::vector<NLMISC::CRGBA>	_TextColor;
	inline const NLMISC::CRGBA &getTextColor() const
	{
		if (_TextColor.empty())
			return TextColor;
		return _TextColor.back();
	}

	// Current global color flag
	std::vector<bool>	_GlobalColor;
	inline bool getGlobalColor() const
	{
		if (_GlobalColor.empty())
			return false;
		return _GlobalColor.back();
	}

	// Current font size
	std::vector<uint>			_FontSize;
	inline uint getFontSize() const
	{
		if (_FontSize.empty())
			return TextFontSize;
		return _FontSize.back();
	}

	// Current link
	std::vector<std::string>	_Link;
	inline const char *getLink() const
	{
		if (_Link.empty())
			return "";
		return _Link.back().c_str();
	}

	// Tables
	std::vector<class CGroupTable*>	_Tables;
	inline CGroupTable *getTable() const
	{
		if (_Tables.empty())
			return NULL;
		return _Tables.back();
	}

	// Cells
	std::vector<class CGroupCell*>	_Cells;

	// TR
	std::vector<bool>	_TR;
	inline bool getTR() const
	{
		if (_TR.empty())
			return false;
		return _TR.back();
	}

	// Forms
	class CForm
	{
	public:

		class CEntry
		{
		public:
			CEntry ()
			{
				TextArea = NULL;
				Checkbox = NULL;
				ComboBox = NULL;
				InitialSelection = 0;
			}

			// Variable name
			std::string		Name;

			// Variable value
			ucstring		Value;

			// Text area group
			CInterfaceGroup *TextArea;

			// Checkbox
			CCtrlButton *Checkbox;

			// Combobox group
			CDBGroupComboBox *ComboBox;

			// select values (for the <select> tag)
			std::vector<std::string> SelectValues;
			sint					 InitialSelection; // initial selection for the combo box
		};

		// The action the form has to perform
		std::string Action;

		// The text area associated with the form
		std::vector<CEntry>	Entries;
	};
	std::vector<CForm>	_Forms;

	// Cells parameters
	class CCellParams
	{
	public:
		CCellParams () : BgColor(0,0,0,0)
		{
			Align = CGroupCell::Left;
			VAlign = CGroupCell::Top;
			LeftMargin = 0;
			NoWrap = false;
		}
		NLMISC::CRGBA	BgColor;
		CGroupCell::TAlign	Align;
		CGroupCell::TVAlign	VAlign;
		sint32	LeftMargin;
		bool	NoWrap;
	};
	std::vector<CCellParams>	_CellParams;

	// Indentation
	uint	_Indent;

	// Current node is a title
	bool			_Title;

	// Current node must be localized
	bool			_Localize;

	// Current node is a text area
	bool			_TextArea;
	std::string		_TextAreaTemplate;
	ucstring		_TextAreaContent;
	std::string		_TextAreaName;
	uint			_TextAreaRow;
	uint			_TextAreaCols;

	// current mode is in select option
	bool			_SelectOption;
	ucstring		_SelectOptionStr;

	// Get last char
	ucchar getLastChar() const;

	// Current link view
	class CViewLink			*_CurrentViewLink;
	class CViewBitmap		*_CurrentViewImage;

	// Current group table
	class CGroupCell *_CurrentCell;

	// The main group
	class CGroupListAdaptor *_GroupListAdaptor;

	// For auto selecting the node in a BrowseTree bound to this HTML web page
	std::string		_BrowseTree;
	// select the tree node that has the correct url
	const std::string &selectTreeNodeRecurs(CGroupTree::SNode *node, const std::string &url);
	// search if the action / params match the url. look recurs into procedures
	bool	actionLaunchUrlRecurs(const std::string &ah, const std::string &params, const std::string &url);

	// Browse undo and redo
	enum	{MaxUrlUndoRedo= 256};
	std::string		_BrowseUndoButton;
	std::string		_BrowseRedoButton;
	std::string		_BrowseRefreshButton;
	// _BrowseUrl is different from _URL, in that _URL may change in handle()
	std::string		_AskedUrl;
	std::deque<std::string>		_BrowseUndo;
	std::deque<std::string>		_BrowseRedo;
	void	pushUrlUndoRedo(const std::string &url);
	void	doBrowse(const char *url);
	void	updateUndoRedoButtons();
	void	updateRefreshButton();

	// For Killing request. Associate each CGroupHTML object with a unique ID.
	uint32				_GroupHtmlUID;
	static uint32		_GroupHtmlUIDPool;
	typedef std::map<uint32, NLMISC::CRefPtr<CGroupHTML> >	TGroupHtmlByUIDMap;
	static TGroupHtmlByUIDMap _GroupHtmlByUID;

private:

	// decode all HTML entities
	static ucstring decodeHTMLEntities(const ucstring &str);

	// ImageDownload system

	struct CImageDownload
	{
		CImageDownload(CURL *c, const std::string &u, FILE *f, CViewBase *i) : curl(c), url(u), fp(f) { imgs.push_back(i); }
		CURL *curl;
		std::string url;
		FILE *fp;
		std::vector<CViewBase *> imgs;
	};

	std::vector<CImageDownload> Curls;
	CURLM *MultiCurl;
	int RunningCurls;

	void initImageDownload();
	void releaseImageDownload();
	void checkImageDownload();
	void addImageDownload(const std::string &url, CViewBase *img);
	std::string localImageName(const std::string &url);
};

// adapter group that store y offset for inputs inside an html form
class CGroupHTMLInputOffset : public CInterfaceGroup
{
public:
	sint32 Offset;
	CGroupHTMLInputOffset(const TCtorParam &param);
	virtual bool parse (xmlNodePtr cur, CInterfaceGroup *parentGroup);
};


#endif