/*

Jabber Protocol Plugin for Miranda NG

Copyright (c) 2002-04  Santithorn Bunchua
Copyright (c) 2005-12  George Hazan
Copyright (c) 2007     Maxim Mluhov
Copyright (c) 2012-18 Miranda NG team

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#ifndef _JABBER_IQ_H_
#define _JABBER_IQ_H_

#include "jabber_xml.h"

class CJabberIqInfo;

struct CJabberProto;
typedef void (*IQ_USER_DATA_FREE_FUNC)(void *pUserData);

// 2 minutes, milliseconds
#define JABBER_DEFAULT_IQ_REQUEST_TIMEOUT		120000

typedef void (CJabberProto::*JABBER_IQ_HANDLER)(HXML iqNode, CJabberIqInfo *pInfo);
typedef BOOL (CJabberProto::*JABBER_PERMANENT_IQ_HANDLER)(HXML iqNode, CJabberIqInfo *pInfo);

#define JABBER_IQ_PARSE_CHILD_TAG_NODE  (1)
#define JABBER_IQ_PARSE_CHILD_TAG_NAME  ((1<<1)|JABBER_IQ_PARSE_CHILD_TAG_NODE)
#define JABBER_IQ_PARSE_CHILD_TAG_XMLNS ((1<<2)|JABBER_IQ_PARSE_CHILD_TAG_NODE)
#define JABBER_IQ_PARSE_FROM             (1<<3)
#define JABBER_IQ_PARSE_HCONTACT        ((1<<4)|JABBER_IQ_PARSE_FROM)
#define JABBER_IQ_PARSE_TO               (1<<5)
#define JABBER_IQ_PARSE_ID_STR           (1<<6)

#define JABBER_IQ_PARSE_DEFAULT (JABBER_IQ_PARSE_CHILD_TAG_NODE | JABBER_IQ_PARSE_CHILD_TAG_NAME | JABBER_IQ_PARSE_CHILD_TAG_XMLNS)

class CJabberIqInfo
{
protected:
	friend class CJabberIqManager;
	JABBER_IQ_HANDLER m_pHandler;

	int      m_nIqId;
	DWORD    m_dwParamsToParse;
	DWORD    m_dwRequestTime;
	DWORD    m_dwTimeout;
	wchar_t *m_szReceiver;
	int      m_iPriority;

public:
	void    *m_pUserData;
	int      m_nIqType;
	wchar_t *m_szFrom;
	wchar_t *m_szChildTagXmlns;
	wchar_t *m_szChildTagName;
	HXML     m_pChildNode;
	MCONTACT m_hContact;
	wchar_t *m_szTo;
	wchar_t *m_szId;

public:
	__forceinline CJabberIqInfo()
	{	memset(this, 0, sizeof(*this));
	}
	__forceinline ~CJabberIqInfo()
	{	mir_free(m_szReceiver);
	}

	__forceinline void SetReceiver(const wchar_t *szReceiver) { replaceStrW(m_szReceiver, szReceiver); }
	__forceinline void SetParamsToParse(DWORD dwParamsToParse) { m_dwParamsToParse = dwParamsToParse; }
	__forceinline void SetTimeout(DWORD dwTimeout) { m_dwTimeout = dwTimeout; }

	__forceinline int      GetIqId() const { return m_nIqId; }
	__forceinline DWORD    GetRequestTime() const { return m_dwRequestTime; }
	__forceinline int      GetIqType() const { return m_nIqType; }	
	__forceinline void*    GetUserData() const {	return m_pUserData; }
	__forceinline wchar_t* GetFrom() const {	return m_szFrom; }
	__forceinline wchar_t* GetTo() const { return m_szTo; }
	__forceinline wchar_t* GetIdStr() const { return m_szId; }
	__forceinline MCONTACT GetHContact() const { return m_hContact; }
	__forceinline HXML     GetChildNode() const { return m_pChildNode; }
	__forceinline wchar_t* GetChildNodeName() const { return m_szChildTagName; }
	__forceinline wchar_t* GetReceiver() const { return m_szReceiver; }
	__forceinline int      GetPriority() const { return m_iPriority; }

	char* GetCharIqType()
	{
		switch (m_nIqType) {
			case JABBER_IQ_TYPE_SET: return "set";
			case JABBER_IQ_TYPE_GET: return "get";
			case JABBER_IQ_TYPE_ERROR: return "error";
			case JABBER_IQ_TYPE_RESULT: return "result";
		}
		return nullptr;
	}
};

class CJabberIqPermanentInfo : public MZeroedObject
{
	friend class CJabberIqManager;

	JABBER_PERMANENT_IQ_HANDLER m_pHandler;
	DWORD m_dwParamsToParse;
	int m_nIqTypes;
	wchar_t *m_szXmlns;
	wchar_t *m_szTag;
	BOOL m_bAllowPartialNs;
	void *m_pUserData;
	IQ_USER_DATA_FREE_FUNC m_pUserDataFree;
	int m_iPriority;

public:
	~CJabberIqPermanentInfo()
	{
		if (m_pUserDataFree)
			m_pUserDataFree(m_pUserData);
		mir_free(m_szXmlns);
		mir_free(m_szTag);
	}

	__forceinline int getPriority() const { return m_iPriority; }
};

class CJabberIqManager
{
protected:
	CJabberProto *ppro;

	mir_cs m_cs;
	DWORD  m_dwLastUsedHandle;

	HANDLE m_hExpirerThread;
	BOOL   m_bExpirerThreadShutdownRequest;

	LIST<CJabberIqInfo> m_arIqs;
	OBJLIST<CJabberIqPermanentInfo> m_arHandlers;

	CJabberIqInfo* DetachInfo();
	CJabberIqInfo* DetachInfo(int nIqId);
	CJabberIqInfo* DetachInfo(void *pUserData);
	CJabberIqInfo* DetachExpired();

	void ExpireInfo(CJabberIqInfo *pInfo);

public:
	CJabberIqManager(CJabberProto *proto);
	~CJabberIqManager();

	bool Start();
	void Shutdown();

	// fucking params, maybe just return CJabberIqRequestInfo pointer ?
	CJabberIqInfo* AddHandler(JABBER_IQ_HANDLER pHandler, int nIqType, const wchar_t *szReceiver, DWORD dwParamsToParse, int nIqId, void *pUserData, int iPriority);
	CJabberIqPermanentInfo* AddPermanentHandler(JABBER_PERMANENT_IQ_HANDLER pHandler, int nIqTypes, DWORD dwParamsToParse, const wchar_t *szXmlns, BOOL bAllowPartialNs, const wchar_t *szTag, void *pUserData = nullptr, IQ_USER_DATA_FREE_FUNC pUserDataFree = nullptr, int iPriority = JH_PRIORITY_DEFAULT);

	// returns TRUE when pInfo found, or FALSE otherwise
	bool DeletePermanentHandler(CJabberIqPermanentInfo *pInfo);
	bool DeleteHandler(CJabberIqInfo *pInfo);

	bool HandleIq(int nIqId, HXML pNode);
	bool HandleIqPermanent(HXML pNode);

	void ExpireIq(int nIqId);
	void ExpirerThread(void);
	bool ExpireByUserData(void *pUserData);
	void ExpireAll();
	void FillPermanentHandlers();
};

#endif