path: root/include/m_utils.h

/*

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

Copyright (C) 2012-24 Miranda NG team (https://miranda-ng.org)
Copyright (c) 2000-12 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_UTILS_H__
#define M_UTILS_H__ 1

#ifdef _MSC_VER
	#pragma warning(disable:4201)
#endif

#include <stdio.h>

#if !defined(M_SYSTEM_H__)
#include <m_system.h>
#endif

#if !defined(M_STRING_H__)
#include <m_string.h>
#endif

/////////////////////////////////////////////////////////////////////////////////////////
// Opens a URL in the user's default web browser
//
// bOpenInNewWindow should be zero to open the URL in the browser window the user
// last used, or nonzero to open in a new browser window. If there's no browser
// running, one will be opened to show the URL.

EXTERN_C MIR_CORE_DLL(void) Utils_OpenUrl(const char *pszUrl, bool bOpenInNewWindow = true);
EXTERN_C MIR_CORE_DLL(void) Utils_OpenUrlW(const wchar_t *pszUrl, bool bOpenInNewWindow = true);

/////////////////////////////////////////////////////////////////////////////////////////
// copies a string into clipboard

struct MIR_CORE_EXPORT MClipData : public MNonCopyable
{
	const MClipData *m_pNext = 0;

	MClipData& operator+(const MClipData &);

	virtual void Copy() const = 0;
};

struct MIR_CORE_EXPORT MClipAnsi : public MClipData
{
	const char *m_szString;

	explicit MClipAnsi(const char *pszString);

	void Copy() const override;
};

struct MIR_CORE_EXPORT MClipUnicode : public MClipData
{
	const wchar_t *m_wszString;

	explicit MClipUnicode(const wchar_t *pwszString);

	void Copy() const override;
};

struct MClipUtf8 : public MClipUnicode
{
	explicit MClipUtf8(const char *pszString) :
		MClipUnicode(Utf2T(pszString))
	{}
};

struct MIR_CORE_EXPORT MClipRtf : public MClipData
{
	const char *m_szString;

	explicit MClipRtf(const char *pszString);

	void Copy() const override;
};

MIR_CORE_DLL(void) Utils_ClipboardCopy(const MClipData &pData);

/////////////////////////////////////////////////////////////////////////////////////////
// Resizes a dialog by calling a custom routine to move the individual
// Returns 0 on success, or nonzero on failure
// Does not support dialogtemplateex dialog boxes, and will return failure if you try to resize one
// The dialog itself should have been resized prior to calling this service
// pfnResizer is called once for each control in the dialog
// pfnResizer should return a combination of one rd_anchorx_ and one rd_anchory constant

#define RD_ANCHORX_CUSTOM	0	// function did everything required to the x axis, do no more processing
#define RD_ANCHORX_LEFT 	0	// move the control to keep it constant distance from the left edge of the dialog
#define RD_ANCHORX_RIGHT	1	// move the control to keep it constant distance from the right edge of the dialog
#define RD_ANCHORX_WIDTH	2	// size the control to keep it constant distance from both edges of the dialog
#define RD_ANCHORX_CENTRE	4	// move the control to keep it constant distance from the centre of the dialog
#define RD_ANCHORY_CUSTOM	0
#define RD_ANCHORY_TOP		0
#define RD_ANCHORY_BOTTOM	8
#define RD_ANCHORY_HEIGHT	16
#define RD_ANCHORY_CENTRE	32

struct UTILRESIZECONTROL
{
	int cbSize;
	UINT wId;             // control ID
	RECT rcItem;          // original control rectangle, relative to dialog
	                      // modify in-place to specify the new position
	SIZE dlgOriginalSize; // size of dialog client area in template
	SIZE dlgNewSize;      // current size of dialog client area
};

typedef int (*DIALOGRESIZERPROC)(HWND hwndDlg, LPARAM lParam, UTILRESIZECONTROL *urc);

EXTERN_C MIR_CORE_DLL(int) Utils_ResizeDialog(HWND hwndDlg, HINSTANCE hInstance, LPCSTR lpTemplate, DIALOGRESIZERPROC pfnResizer, LPARAM lParam = 0);

/* Gets the name of a country given its number		v0.1.2.0+
wParam = countryId
lParam = 0
Returns a pointer to the string containing the country name on success,
or NULL on failure
*/
#define MS_UTILS_GETCOUNTRYBYNUMBER "Utils/GetCountryByNumber"

/* Gets the name of a country given its ISO code	v0.1.2.0+
wParam = (char*)ISOcode
lParam = 0
Returns a pointer to the string containing the country name on success,
or NULL on failure
*/
#define MS_UTILS_GETCOUNTRYBYISOCODE "Utils/GetCountryByISOCode"

/* Gets the full list of country IDs	 v0.1.2.0+
wParam = (WPARAM)(int*)piCount
lParam = (LPARAM)(struct CountryListEntry**)ppList
Returns 0 always
Neither wParam nor lParam can be NULL.
The list is sorted alphabetically by country name, on the assumption that it's
quicker to search numbers out of order than it is to search names out of order
*/

struct CountryListEntry
{
	int id;
	char ISOcode[3];
	const char *szName;
};

#define MS_UTILS_GETCOUNTRYLIST "Utils/GetCountryList"

/////////////////////////////////////////////////////////////////////////////////////////
///////////////////////////////////// Window lists //////////////////////////////////////

#if defined(MIR_CORE_EXPORTS)
typedef struct TWindowList *MWindowList;
#else
DECLARE_HANDLE(MWindowList);
#endif

/////////////////////////////////////////////////////////////////////////////////////////
// allocates a window list
// returns a handle to the new window list

EXTERN_C MIR_CORE_DLL(MWindowList) WindowList_Create(void);

/////////////////////////////////////////////////////////////////////////////////////////
// destroys a window list

EXTERN_C MIR_CORE_DLL(void) WindowList_Destroy(MWindowList &hList);

/////////////////////////////////////////////////////////////////////////////////////////
// adds a window to the specified window list
// returns 0 on success, nonzero on failure

EXTERN_C MIR_CORE_DLL(int) WindowList_Add(MWindowList hList, HWND hwnd, UINT_PTR param = 0);

/////////////////////////////////////////////////////////////////////////////////////////
// removes a window from the specified window list
// returns 0 on success, nonzero on failure

EXTERN_C MIR_CORE_DLL(int) WindowList_Remove(MWindowList hList, HWND hwnd);

/////////////////////////////////////////////////////////////////////////////////////////
// finds a window by associated parameter's value
// returns the window handle on success, or NULL on failure

EXTERN_C MIR_CORE_DLL(HWND) WindowList_Find(MWindowList hList, UINT_PTR param);

/////////////////////////////////////////////////////////////////////////////////////////
// sends a message to all windows in a list using SendMessage
// returns 0 on success, nonzero on failure

EXTERN_C MIR_CORE_DLL(int) WindowList_Broadcast(MWindowList hList, UINT message, WPARAM wParam, LPARAM lParam);

/////////////////////////////////////////////////////////////////////////////////////////
// sends a message to all windows in a list using PostMessage
// returns 0 on success, nonzero on failure

EXTERN_C MIR_CORE_DLL(int) WindowList_BroadcastAsync(MWindowList hList, UINT message, WPARAM wParam, LPARAM lParam);

/***************************** Hyperlink windows ********************************/

//there aren't any services here, because you don't need them.
#define WNDCLASS_HYPERLINK	 L"Hyperlink"
//the control will obey the SS_LEFT (0), SS_CENTER (1), and SS_RIGHT (2) styles
//the control will send STN_CLICKED via WM_COMMAND when the link itself is clicked

/////////////////////////////////////////////////////////////////////////////////////////
// Use this in a SendMessage to set the color of the url when control is enabled
// wParam = uint32_t color
// lParam = not used
#define HLK_SETENABLECOLOUR	 (WM_USER+101) // added in 0.3.1

/////////////////////////////////////////////////////////////////////////////////////////
// Use this in a SendMessage to set the color of the url when control is disabled
// wParam = uint32_t color
// lParam = not used
#define HLK_SETDISABLECOLOUR (WM_USER+102) // added in 0.3.1

/////////////////////////////////////////////////////////////////////////////////////////
///////////////////////////////// Window Position Saving ////////////////////////////////

/////////////////////////////////////////////////////////////////////////////////////////
// saves the position of a window in the database
// returns 0 on success, nonzero on failure

EXTERN_C MIR_CORE_DLL(int) Utils_SaveWindowPosition(HWND hwnd, MCONTACT hContact, const char *szModule, const char *szNamePrefix);

/////////////////////////////////////////////////////////////////////////////////////////
// restores the position of a window from the database	 v0.1.1.0+
// wParam = flags
// lParam = (LPARAM)(SAVEWINDOWPOS*)&swp
// returns 0 on success, nonzero on failure
// if no position was found in the database, the function returns 1 and does
// nothing
// the NoSize version won't use stored size information: the window is left the same size.

#define RWPF_NOSIZE 	1  //don't use stored size info: leave dialog same size
#define RWPF_NOMOVE 	2  //don't use stored position
#define RWPF_NOACTIVATE 4  //show but don't activate v0.3.3.0+
#define RWPF_HIDDEN		8  //make it hidden

EXTERN_C MIR_CORE_DLL(int) Utils_RestoreWindowPosition(HWND hwnd, MCONTACT hContact, const char *szModule, const char *szNamePrefix, int flags = 0);

__forceinline int Utils_RestoreWindowPositionNoSize(HWND hwnd, MCONTACT hContact, const char *szModule, const char *szNamePrefix)
{	return Utils_RestoreWindowPosition(hwnd, hContact, szModule, szNamePrefix, RWPF_NOSIZE);
}
__forceinline int Utils_RestoreWindowPositionNoMove(HWND hwnd, MCONTACT hContact, const char *szModule, const char *szNamePrefix)
{	return Utils_RestoreWindowPosition(hwnd, hContact, szModule, szNamePrefix, RWPF_NOMOVE);
}

/////////////////////////////////////////////////////////////////////////////////////////
// Moves a RECT inside screen if it is outside. It works with multiple monitors
// returns < 0 on error, 0 if not changed the rect, 1 if changed the rect

EXTERN_C MIR_CORE_DLL(int) Utils_AssertInsideScreen(RECT *rc);

/////////////////////////////////////////////////////////////////////////////////////////
// corrects font size according to the DPI settings

EXTERN_C MIR_CORE_DLL(int) Utils_CorrectFontSize(int iFontSize);

/************************ Colour Picker Control (0.1.2.1+) **********************/

#define WNDCLASS_COLOURPICKER  "ColourPicker"

#define CPM_SETCOLOUR           0x1000	  //lParam = new colour
#define CPM_GETCOLOUR           0x1001	  //returns colour
#define CPM_SETDEFAULTCOLOUR    0x1002	  //lParam = default, used as first custom colour
#define CPM_GETDEFAULTCOLOUR    0x1003	  //returns colour

#define CPN_COLOURCHANGED 1 //sent through WM_COMMAND

/////////////////////////////////////////////////////////////////////////////////////////
// Gets the filter strings for use in the open file dialog
// See the MSDN under OPENFILENAME.lpstrFilter for the formatting
// An 'All Bitmaps' item is always first and 'All Files' is last.
// The returned string is already translated.

EXTERN_C MIR_CORE_DLL(HBITMAP) Bitmap_Load(const wchar_t *ptszFileName);
EXTERN_C MIR_CORE_DLL(void) Bitmap_GetFilter(wchar_t *dest, size_t destLen);

/////////////////////////////////////////////////////////////////////////////////////////
// Path class

class MIR_CORE_EXPORT MFilePath : public CMStringW
{
	class MIR_CORE_EXPORT MFileIterator
	{
		#ifdef _WINDOWS
			WIN32_FIND_DATAW m_data;
			HANDLE m_hFind = INVALID_HANDLE_VALUE;
		#else
			wchar_t m_path[MAX_PATH];
			int m_flags;
		#endif

		class iterator
		{
			MFileIterator *ptr;

		public:
			__inline iterator(MFileIterator *_p) : ptr(_p) {}
			iterator operator++();
			__inline bool operator!=(const iterator &p) { return p.ptr != ptr; }
			__inline operator const MFileIterator*() const { return ptr; }
		};

	public:
		MFileIterator(const wchar_t*);
		~MFileIterator();

		#ifdef _WINDOWS
			__inline const wchar_t* getPath() const { return m_data.cFileName; }
		#else
			__inline const wchar_t* getPath() const { return m_path; }
		#endif

		bool isDir() const;

		__inline iterator begin();
		__inline iterator end() { return iterator(nullptr); }
	};

public:
	MFilePath(): CMStringW() {}
	MFilePath(const wchar_t *init) : CMStringW(init) {}

	CMStringW getExtension() const;

	bool isExecutable() const;
	bool isExist() const;

	bool move(const wchar_t *pwszDest);

	MFileIterator search();
};

/////////////////////////////////////////////////////////////////////////////////////////
// Converts a path to a relative path
// Only saves as a relative path if the file is in the miranda directory (or
// sub directory)
//
// [pszSrc] is the path to convert and [pszOut] is the buffer that
// the new path is copied too. pszOut MUST be at least of the size MAX_PATH.
//
// [pszBase] is the folder that is treated as root for 'relativity'
// by default = path to miranda32.exe
//
// Returns number of chars copied.

#if defined( __cplusplus )
EXTERN_C MIR_CORE_DLL(int) PathToRelative(const char *pszSrc, char *pszOut, const char* pszBase = nullptr);
EXTERN_C MIR_CORE_DLL(int) PathToRelativeW(const wchar_t *pwszSrc, wchar_t *pwszOut, const wchar_t* pwszBase = nullptr);
#else
EXTERN_C MIR_CORE_DLL(int) PathToRelative(const char *pszSrc, char *pszOut, const char* pszBase);
EXTERN_C MIR_CORE_DLL(int) PathToRelativeW(const wchar_t *pwszSrc, wchar_t *pwszOut, const wchar_t* pwszBase);
#endif

/////////////////////////////////////////////////////////////////////////////////////////
// Saves a path to a absolute path (from the miranda directory)
//
// [pszSrc] is the path to convert and [pszOut] is the buffer that
// the new path is copied too. pszOut MUST be of the size MAX_PATH.
//
// [pszBase] is the folder that is treated as root for 'relativity'
// by default = path to miranda32.exe
//
// Returns numbers of chars copied.

#if defined( __cplusplus )
EXTERN_C MIR_CORE_DLL(int) PathToAbsolute(const char *pszSrc, char *pszOut, const char* pszBase = nullptr);
EXTERN_C MIR_CORE_DLL(int) PathToAbsoluteW(const wchar_t *pwszSrc, wchar_t *pwszOut, const wchar_t* pwszBase = nullptr);
#else
EXTERN_C MIR_CORE_DLL(int) PathToAbsolute(const char *pszSrc, char *pszOut, const char* pszBase);
EXTERN_C MIR_CORE_DLL(int) PathToAbsoluteW(const wchar_t *pwszSrc, wchar_t *pwszOut, const wchar_t* pwszBase);
#endif

/////////////////////////////////////////////////////////////////////////////////////////
// Creates a directory tree (even more than one directories levels are missing)
// Returns 0 on success or an error code otherwise

EXTERN_C MIR_CORE_DLL(int) CreateDirectoryTree(const char *pszDir);
EXTERN_C MIR_CORE_DLL(int) CreateDirectoryTreeW(const wchar_t *pwszDir);

/////////////////////////////////////////////////////////////////////////////////////////
// Deletes a directory recursively
// Returns 0 on success or an error code otherwise

EXTERN_C MIR_CORE_DLL(int) DeleteDirectoryTreeW(const wchar_t *pwszDir, bool bAllowUndo = false);

/////////////////////////////////////////////////////////////////////////////////////////
// Creates all subdirectories required to create a file with the file name given
// Returns 0 on success or an error code otherwise

EXTERN_C MIR_CORE_DLL(int) CreatePathToFile(const char *wszFilePath);
EXTERN_C MIR_CORE_DLL(int) CreatePathToFileW(const wchar_t *wszFilePath);

/////////////////////////////////////////////////////////////////////////////////////////
// Checks if a file name is absolute or not
// returns TRUE if yes or FALSE if not

EXTERN_C MIR_CORE_DLL(int) PathIsAbsolute(const char *pSrc);
EXTERN_C MIR_CORE_DLL(int) PathIsAbsoluteW(const wchar_t *pSrc);

/////////////////////////////////////////////////////////////////////////////////////////
// Generates Random number of any length
// cbLen = length of the random number to generate
// pszDest = pointer to array to fill with random number

EXTERN_C MIR_CORE_DLL(void) Utils_GetRandom(void *pszDest, size_t cbLen);

/////////////////////////////////////////////////////////////////////////////////////////
// Checks if a string is RTL

EXTERN_C MIR_CORE_DLL(bool) Utils_IsRtl(const wchar_t *pszwText);

/////////////////////////////////////////////////////////////////////////////////////////
// Unzip memory buffer

MIR_APP_DLL(MBinBuffer) Utils_Unzip(const void *pData, size_t cbLen);

__forceinline MBinBuffer Utils_Unzip(const MBinBuffer &buf) {
	return Utils_Unzip(buf.data(), buf.length());
}

/////////////////////////////////////////////////////////////////////////////////////////
// Replace variables in text
// wParam = (char*/wchar_t*/wchar_t*)string (depends on RVF_UNICODE/RVF_TCHAR flag)
// lParam = (REPLACEVARSDATA *) data about variables, item with key = 0 terminates the list
// returns new string, use mir_free to destroy

// variables known by the core:
// ----------------------------
// %miranda_profilesdir%  -> same as MS_DB_GETPROFILEPATH, base folder for all profiles
// %miranda_userdata% -> the active profile folder (home of the .dat file and all
//                       profile data)
// %miranda_path%     -> home path of the miranda installation (installation path
//                       of miranda32/64.exe
// %miranda_profilename% -> Name of the profile in use. Essentially, the name of the
//                          .dat file without file name extension. Also: the folder name
//                          relative to %miranda_profilesdir% where all profile data is stored.
// %miranda_logpath%     -> base folder for log files. This is \Logs relative to the
//                          current profile folder.
// %miranda_avatarcache% -> base folder for all protocol avatars. internal use only.
//
// the following variables operate on contacts. REPLACEVARSDATA::hContact must be
// supplied by the caller.
//
// %nick%                -> a contact nick name.
// %proto%               -> internal protocol name for a given contact. NOT the user-
//                          defined account name.
// %accountname%         -> user-defined account name for a given contact.
// %userid%              -> Unique ID for a given contact (UIN, JID etc.)

// the following variables are system variables - unrelated to miranda profiles.

// %appdata%			-> same as %APPDATA% environment variable.
// %destkop%            -> location of the desktop folder in a user's profile.
// %mydocuments%        -> location of the "My Documents" shell folder.

struct REPLACEVARSARRAY
{
	MAllStrings key, value;
};

EXTERN_C MIR_APP_DLL(char*) Utils_ReplaceVars(const char *szData, MCONTACT hContact = 0, REPLACEVARSARRAY *vars = nullptr);
EXTERN_C MIR_APP_DLL(wchar_t*) Utils_ReplaceVarsW(const wchar_t *szData, MCONTACT hContact = 0, REPLACEVARSARRAY *vars = nullptr);

#if defined(__cplusplus)
	#if !defined(M_SYSTEM_H__)
		#include "m_system.h"
	#endif

	struct VARSW : public ptrW
	{
		__forceinline VARSW(const wchar_t *str) :
			ptrW(Utils_ReplaceVarsW(str))
		{}
	};
#endif

/////////////////////////////////////////////////////////////////////////////////////////
// delays execution of the required action

struct MIR_APP_EXPORT MAsyncObject : public MNonCopyable
{
	virtual ~MAsyncObject() {}

	virtual void Invoke() = 0;
};

MIR_APP_DLL(void) Utils_InvokeAsync(MAsyncObject *pObj);

/////////////////////////////////////////////////////////////////////////////////////////
// compatibility functions

#ifndef _WINDOWS
MIR_CORE_DLL(int) GetShortPathNameW(const wchar_t*, wchar_t*, int);
MIR_CORE_DLL(int) MessageBoxW(HWND, const wchar_t*, const wchar_t*, int);
MIR_CORE_DLL(int) WritePrivateProfileString(const wchar_t*, const wchar_t*, const wchar_t*, const wchar_t*);
#endif

/////////////////////////////////////////////////////////////////////////////////////////
// enters one string
// returns TRUE on pressing OK or FALSE if Cancel was pressed

#define ESF_MULTILINE 1
#define ESF_COMBO     2
#define ESF_RICHEDIT  3
#define ESF_PASSWORD  4

struct ENTER_STRING
{
	LPCSTR szModuleName;   // module name to save window size and combobox strings
	LPCSTR szDataPrefix;   // prefix for stored database variables
	LPCWSTR caption;       // window caption
	union {
		LPCWSTR ptszInitVal; // initial value (note: the core DOES NOT free it)
		LPWSTR  ptszResult;  // result entered (must be freed via mir_free)
	};
	
	int type;           // one of ESF_* constants
	int recentCount;    // number of combobox strings to store
	int timeout;        // timeout for the form auto-close
};

EXTERN_C MIR_APP_DLL(bool) EnterString(ENTER_STRING *pForm);

/////////////////////////////////////////////////////////////////////////////////////////
// pu_stub utilities

namespace PU
{
	// Checks if we're working via pu_stub or not
	MIR_APP_DLL(bool) IsDirect();
	
	// Checks if Miranda's folder is writeable
	MIR_APP_DLL(bool) IsMirandaFolderWritable();

	// Checks if a process has enough rights to write into Miranda's folder
	MIR_APP_DLL(bool) IsProcessElevated();
	
	// Launches pu_stub.exe with elevated priviledges if needed
	MIR_APP_DLL(bool) PrepareEscalation(const wchar_t *pwszFile = nullptr);
	
	MIR_APP_DLL(int) SafeCopyFile(const wchar_t *pSrc, const wchar_t *pDst);
	MIR_APP_DLL(int) SafeMoveFile(const wchar_t *pSrc, const wchar_t *pDst);
	MIR_APP_DLL(int) SafeDeleteFile(const wchar_t *pwszFile);
	MIR_APP_DLL(int) SafeRecycleBin(const wchar_t *pwszFile);
	MIR_APP_DLL(int) SafeCreateDirectory(const wchar_t *pwszFolder);
	MIR_APP_DLL(int) SafeDeleteDirectory(const wchar_t *pwszDirName);
	MIR_APP_DLL(int) SafeCreateFilePath(const wchar_t *pwszFolder);
};

#endif // M_UTILS_H__