path: root/include/m_srmm_int.h

/*

Miranda NG: the free IM client for Microsoft* Windows*

Copyright (C) 2012-24 Miranda NG team (https://miranda-ng.org)
Copyright (c) 2000-08 Miranda ICQ/IM project,
all portions of this codebase are copyrighted to the people
listed in contributors.txt.

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 M_SRMM_INT_H__
#define M_SRMM_INT_H__ 1

#include <shellapi.h>
#include <vector>

#include <m_gui.h>

#define SRMM_MODULE "SRMM"

///////////////////////////////////////////////////////////////////////////////////////////////////////////////
// toolbar button internal representation

#define MIN_CBUTTONID      4000
#define MAX_CBUTTONID      5000

#define BBSF_IMBUTTON		(1<<0)
#define BBSF_CHATBUTTON		(1<<1)
#define BBSF_CANBEHIDDEN	(1<<2)
#define BBSF_NTBSWAPED		(1<<3)
#define BBSF_NTBDESTRUCT	(1<<4)

struct CustomButtonData : public MZeroedObject
{
	~CustomButtonData()
	{}

	int      m_dwPosition;    // default order pos of button, counted from window edge (left or right)

	int      m_dwButtonID;    // id of button used while button creation and to store button info in DB
	ptrA     m_pszModuleName; // module name without spaces and underline symbols (e.g. "tabsrmm")

	int      m_dwButtonCID;   // button's control id
	int      m_dwArrowCID;    // only use with BBBF_ISARROWBUTTON flag

	ptrW     m_pwszText;      // button's text
	ptrW     m_pwszTooltip;   // button's tooltip
	ptrW     m_pwszOptions;   // button's name in options, might be NULL

	int      m_iButtonWidth;  // must be 22 for regular button and 33 for button with arrow
	HANDLE   m_hIcon;         // Handle to icolib registred icon

	bool     m_bIMButton, m_bChatButton;
	bool     m_bCanBeHidden, m_bCantBeHidden, m_bHidden, m_bSeparator, m_bDisabled, m_bPushButton, m_bNoReadonly;
	bool     m_bRSided;
	uint8_t  m_opFlags;
	HPLUGIN  m_pPlugin;
	uint32_t m_dwOrigPosition;
	struct   THotkeyItem *m_hotkey;

	struct {
		bool bit1 : 1, bit2 : 1, bit3 : 1, bit4 : 1;
	} m_dwOrigFlags;
};

// gets the required button or NULL, if i is out of boundaries
MIR_APP_DLL(CustomButtonData*) Srmm_GetNthButton(int i);

// retrieves total number of toolbar buttons
MIR_APP_DLL(int) Srmm_GetButtonCount(void);

// emulates a click on a toolbar button
MIR_APP_DLL(void) Srmm_ClickToolbarIcon(MCONTACT hContact, int idFrom, HWND hwndFrom, BOOL code);

// these messages are sent to the message windows if toolbar buttons are changed
#define WM_CBD_FIRST   (WM_USER+0x600)

// wParam = 0 (ignored)
// lParam = (CustomButtonData*)pointer to button or null if any button can be changed
#define WM_CBD_UPDATED (WM_CBD_FIRST+1)

// wParam = button id
// lParam = (CustomButtonData*)pointer to button
#define WM_CBD_REMOVED (WM_CBD_FIRST+2)

// wParam = 0 (ignored)
// lParam = 0 (ignored)
#define WM_CBD_LOADICONS (WM_CBD_FIRST+3)

// wParam = 0 (ignored)
// lParam = 0 (ignored)
#define WM_CBD_RECREATE (WM_CBD_FIRST+4)

/////////////////////////////////////////////////////////////////////////////////////////
// SRMM log window container

class CMsgDialog;
struct LOGINFO;

class MIR_APP_EXPORT CSrmmLogWindow
{
	CSrmmLogWindow(const CSrmmLogWindow &) = delete;
	CSrmmLogWindow &operator=(const CSrmmLogWindow &) = delete;

protected:
	CMsgDialog &m_pDlg;

	__forceinline CSrmmLogWindow(CMsgDialog &pDlg) :
		m_pDlg(pDlg)
	{}

public:
	virtual ~CSrmmLogWindow() {}

	virtual void     Attach() = 0;
	virtual void     Detach() = 0;
					     
	virtual bool     AtBottom() = 0;
	virtual void     Clear() = 0;
	virtual int      GetType() = 0;
	virtual HWND     GetHwnd() = 0;
	virtual wchar_t* GetSelection() = 0;
	virtual void     LogEvents(MEVENT hDbEventFirst, int count, bool bAppend) = 0;
	virtual void     LogChatEvents(const LOGINFO *lin) = 0;
	virtual void     Resize() = 0;
	virtual void     ScrollToBottom() = 0;
	virtual void     UpdateOptions() {};

	virtual INT_PTR Notify(WPARAM, LPARAM) { return 0; }

	__forceinline CMsgDialog& GetDialog() const
	{	return m_pDlg;
	}
};

typedef CSrmmLogWindow *(MIR_CDECL *pfnSrmmLogCreator)(CMsgDialog &pDlg);

MIR_APP_DLL(HANDLE) RegisterSrmmLog(CMPlugin *pPlugin, const char *pszShortName, const wchar_t *pwszScreenName, pfnSrmmLogCreator fnBuilder);
MIR_APP_DLL(void) UnregisterSrmmLog(HANDLE);

MIR_APP_DLL(bool) Srmm_IsCustomLogUsed(bool forGroupChats);

/////////////////////////////////////////////////////////////////////////////////////////
// SRMM log window class

struct SrmmLogWindowClass
{
	SrmmLogWindowClass(CMPlugin *p1, const char *p2, const wchar_t *p3, pfnSrmmLogCreator p4) :
		pPlugin(p1),
		szShortName(mir_strdup(p2)),
		wszScreenName(mir_wstrdup(p3)),
		pfnBuilder(p4)
	{}

	CMPlugin *pPlugin;
	ptrA szShortName;
	ptrW wszScreenName;
	pfnSrmmLogCreator pfnBuilder;
};

MIR_APP_DLL(SrmmLogWindowClass *) Srmm_GetWindowClass(CMsgDialog *pDlg);

/////////////////////////////////////////////////////////////////////////////////////////
// Simple single-event based logger

class MIR_APP_EXPORT CSimpleLogWindow : public CSrmmLogWindow
{
	CSimpleLogWindow(const CSimpleLogWindow &) = delete;
	CSimpleLogWindow &operator=(const CSimpleLogWindow &) = delete;

	void LogChatEvents(const struct LOGINFO *lin) override;

protected:
	__forceinline CSimpleLogWindow(CMsgDialog &pDlg) :
		CSrmmLogWindow(pDlg)
	{}

	virtual void LogChatEvent(const LOGINFO &lin) = 0;
};

/////////////////////////////////////////////////////////////////////////////////////////
// Standard built-in RTF logger class

struct RtfLogStreamBase
{
	int       iStage;
	MCONTACT  hContact;
	MEVENT    hDbEvent, hDbEventLast;
	int       eventsToInsert;
	bool      isFirst, isEmpty;

	CMStringA buf;
	DB::EventInfo *dbei;
	class CRtfLogWindow *pLog;
};

struct RtfChatLogStreamData
{
	int   iStage = 0, idx = 0;
	bool  bStripFormat, bRedraw, bIsFirst = false;
	
	CMStringA buf;
	struct SESSION_INFO *si;
	const struct LOGINFO *lin;
	class CRtfLogWindow *pLog;
};

#ifdef SRMM_OWN_STRUCTURES
	struct RtfLogStreamData;
#else
	struct RtfLogStreamData : public RtfLogStreamBase {};
#endif

class MIR_APP_EXPORT CRtfLogWindow : public CSrmmLogWindow
{
	HANDLE hevDelete, hevEdited;

protected:
	CCtrlRichEdit &m_rtf;

	void InsertFileLink(CMStringA &buf, MEVENT hEvent, const DB::FILE_BLOB &blob);

public:
	CRtfLogWindow(CMsgDialog &pDlg);
	~CRtfLogWindow() override;

	virtual void AppendUnicodeString(CMStringA &str, const wchar_t *pwszBuf) = 0;

	void StreamRtfEvents(RtfLogStreamData *dat, bool bAppend);
	virtual void CreateRtfHeader(RtfLogStreamData *dat) = 0;
	virtual bool CreateRtfEvent(RtfLogStreamData *dat, DB::EventInfo &dbei) = 0;
	void CreateRtfTail(RtfLogStreamData *dat);

	void StreamChatRtfEvents(RtfChatLogStreamData *dat, bool bRedraw);
	virtual void CreateChatRtfHeader(RtfChatLogStreamData *dat);
	virtual void CreateChatRtfEvent(RtfChatLogStreamData *dat, const struct LOGINFO &lin);
	void CreateChatRtfMessage(RtfChatLogStreamData *dat, const struct LOGINFO &lin, CMStringA &buf);
	void CreateChatRtfTail(RtfChatLogStreamData *dat);

	virtual INT_PTR WndProc(UINT msg, WPARAM wParam, LPARAM lParam);

	////////////////////////////////////////////////////////////////////////////////////////
	void     Attach() override;
	void     Detach() override;
		      
	bool     AtBottom() override;
	void     Clear() override;
	HWND     GetHwnd() override;
	wchar_t* GetSelection() override;
	int      GetType() override;
	void     Resize() override;
	void     ScrollToBottom() override;

	INT_PTR Notify(WPARAM, LPARAM) override;
};

/////////////////////////////////////////////////////////////////////////////////////////
// Basic SRMM window dialog

#include <chat_resource.h>

// message procedures' stubs
EXTERN_C MIR_APP_DLL(LRESULT) CALLBACK stubLogProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
EXTERN_C MIR_APP_DLL(LRESULT) CALLBACK stubMessageProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
EXTERN_C MIR_APP_DLL(LRESULT) CALLBACK stubNicklistProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);

class MIR_APP_EXPORT CSrmmBaseDialog : public CDlgBase
{
	friend class CRtfLogWindow;

	CSrmmBaseDialog(const CSrmmBaseDialog &) = delete;
	CSrmmBaseDialog &operator=(const CSrmmBaseDialog &) = delete;

	void OnNickListTimer(CTimer *);
	void OnRedrawTimer(CTimer *);

	std::vector<MEVENT> m_arDisplayedEvents;

protected:
	CSrmmBaseDialog(CMPluginBase &pPlugin, int idDialog, struct SESSION_INFO *si = nullptr);

	bool OnInitDialog() override;
	void OnDestroy() override;

	INT_PTR DlgProc(UINT msg, WPARAM wParam, LPARAM lParam) override;

	bool AllowTyping() const;
	int  NotifyEvent(int code);
	#ifdef _WINDOWS
	bool ProcessFileDrop(HDROP hDrop, MCONTACT hContact);
	bool PasteFilesAsURL(HDROP hDrop);
	#endif
	bool ProcessHotkeys(int key, bool bShift, bool bCtrl, bool bAlt);
	void RefreshButtonStatus(void);
	void RunUserMenu(HWND hwndOwner, struct USERINFO *ui, const POINT &pt);
	void UpdateChatLog(void);

protected:
	CSrmmLogWindow *m_pLog = nullptr;
	CCtrlRichEdit m_message;
	SESSION_INFO *m_si;
	COLORREF m_clrInputBG, m_clrInputFG;

	// user typing support;
	uint32_t m_nLastTyping = 0;
	uint8_t m_bShowTyping = 0;
	int m_nTypeSecs = 0, m_nTypeMode = 0;
	const USERINFO* m_pUserTyping = nullptr;

	CCtrlListBox m_nickList;
	int m_iNickSearch = -1;
	CMStringW m_wszNickSearch;

	CCtrlBase m_Quote;
	CCtrlMButton m_btnCloseQuote;

	CCtrlButton m_btnColor, m_btnBkColor, m_btnOk;
	CCtrlButton m_btnBold, m_btnItalic, m_btnUnderline;
	CCtrlButton m_btnHistory, m_btnChannelMgr, m_btnNickList, m_btnFilter;

	void onClick_BIU(CCtrlButton *);
	void onClick_Color(CCtrlButton *);
	void onClick_BkColor(CCtrlButton *);

	void onClick_ChanMgr(CCtrlButton *);
	void onClick_History(CCtrlButton *);
	void onClick_CloseQuote(CCtrlButton *);

	void onDblClick_List(CCtrlListBox *);

public:
	MCONTACT m_hContact;
	MEVENT m_hDbEventFirst, m_hQuoteEvent = 0;
	int m_iLogFilterFlags;
	bool m_bFilterEnabled, m_bNicklistEnabled, m_bReadOnly = false;
	bool m_bFGSet, m_bBGSet;
	bool m_bInMenu, m_bActive;
	COLORREF m_iFG, m_iBG;
	CTimer timerFlash, timerType, timerNickList, timerRedraw;

	void ClearLog();
	bool IsSuitableEvent(const LOGINFO &lin) const;
	void MarkEventRead(const DB::EventInfo &dbei);
	void RedrawLog();
	void ScheduleRedrawLog();
	void SetMessageText(const wchar_t *pwszText, bool bAppend = true);
	void SetQuoteEvent(MEVENT hEvent);
	void ShowColorChooser(int iCtrlId);
	void UpdateChatOptions();
	void UpdateNickList(void);

	virtual void AddLog(const LOGINFO &lin);
	virtual void CloseTab() {}
	virtual void DrawNickList(USERINFO *ui, DRAWITEMSTRUCT *dis) = 0;
	virtual void EventAdded(MEVENT, const DB::EventInfo &dbei) = 0;
	virtual bool GetFirstEvent() = 0;
	virtual bool IsActive() const = 0;
	virtual void LoadSettings() = 0;
	virtual void OnOptionsApplied();
	virtual void RemakeLog() = 0;
	virtual void SetStatusText(const wchar_t *, HICON) {}
	virtual void ShowFilterMenu() {}
	virtual void UpdateFilterButton();
	virtual void UpdateStatusBar() {}
	virtual void UpdateTitle() = 0;

	virtual LRESULT WndProc_Message(UINT msg, WPARAM wParam, LPARAM lParam);
	virtual LRESULT WndProc_Nicklist(UINT msg, WPARAM wParam, LPARAM lParam);

	__forceinline bool isChat() const { return m_si != nullptr; }
	__forceinline MWindow GetInput() const { return m_message.GetHwnd(); }
	__forceinline SESSION_INFO *getChat() const { return m_si; }
	__forceinline CSrmmLogWindow *log() const { return m_pLog; }
	
	__forceinline void setTyping(int nSecs, const USERINFO* pUser = nullptr) {
		m_pUserTyping = pUser;
		m_nTypeSecs = nSecs;
	}

	__inline void* operator new(size_t size) { return calloc(1, size); }
	__inline void operator delete(void *p) { free(p); }
};

#ifndef SRMM_OWN_STRUCTURES
class CMsgDialog : public CSrmmBaseDialog {};
#endif 

/////////////////////////////////////////////////////////////////////////////////////////
// adds an event to SRMM message log

MIR_APP_DLL(void) Srmm_AddEvent(MCONTACT hContact, MEVENT hDbEvent);

/////////////////////////////////////////////////////////////////////////////////////////
// tell all SRMM windows that options were changed

MIR_APP_DLL(void) Srmm_ApplyOptions();

/////////////////////////////////////////////////////////////////////////////////////////
// sends a message to all SRMM windows

MIR_APP_DLL(void) Srmm_Broadcast(UINT, WPARAM, LPARAM);

/////////////////////////////////////////////////////////////////////////////////////////
// creates plugin-specific hot key for sending messages

MIR_APP_DLL(void) Srmm_CreateHotkey(const char *pszSection, const char *pszDescription);

/////////////////////////////////////////////////////////////////////////////////////////
// downloads or launches cloud file
// iCommand = combination of OFD_* constants

MIR_APP_DLL(void) Srmm_DownloadOfflineFile(MCONTACT hContact, MEVENT hDbEvent, int iCommand);

/////////////////////////////////////////////////////////////////////////////////////////
// finds a SRMM window using hContact

MIR_APP_DLL(HWND) Srmm_FindWindow(MCONTACT hContact);
MIR_APP_DLL(CMsgDialog*) Srmm_FindDialog(MCONTACT hContact);

/////////////////////////////////////////////////////////////////////////////////////////
// quotes a string

MIR_APP_DLL(CMStringW) Srmm_Quote(const wchar_t *pwzsText, int iWrapWidth = -1);

#endif // M_MESSAGE_H__