win32std.c

/*
  +----------------------------------------------------------------------+
  | PHP Version 4                                                        |
  +----------------------------------------------------------------------+
  | Copyright (c) 1997-2002 The PHP Group                                |
  +----------------------------------------------------------------------+
  | This source file is subject to version 3 of the PHP license,      |
  | that is bundled with this package in the file LICENSE, and is        |
  | available at through the world-wide-web at                           |
  | http://www.php.net/license/3_0.txt.                                 |
  | If you did not receive a copy of the PHP license and are unable to   |
  | obtain it through the world-wide-web, please send a note to          |
  | license@php.net so we can mail you a copy immediately.               |
  +----------------------------------------------------------------------+
  | Author: Eric COLINET <e.colinet@laposte.net>                         |
  | Author: Frank M. Kromann <frank@kromann.info>                        |
  +----------------------------------------------------------------------+
*/


#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "php_win32std.h"
#include "ext/standard/info.h"
#include "ext/standard/php_smart_string.h"
#include "win32std_arginfo.h" // Arg info meta

/* Return the Win32 error string for the last called Win32 function */
const char * win32_strerror( char * buffer, long buffer_len)
{
	if( !buffer || !buffer_len ) return NULL;
    *buffer= 0;

    FormatMessage( FORMAT_MESSAGE_FROM_SYSTEM, NULL,
		GetLastError(), 0, buffer, buffer_len, NULL);

	return buffer;
}

/**************************************************************************************/
/**************************************************************************************/
/****************************** Win32 Functions ***************************************/
/**************************************************************************************/
/**************************************************************************************/



/* {{{ proto: play_wav( file[, loop])
	file may be either NULL to stop playback or a file name to start it
	loop can be set to loop playback (default to false)
	module may be opened by res_open a file must represent the resource id (NOT IMPL)
*/
PHP_FUNCTION(win_play_wav)
{
	char *file= NULL;
	size_t  file_len=0;
	int ret;
	int default_flags;
	zend_bool loop= 0;

	//if( zend_parse_parameters( ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &file, &file_len, &loop ) == FAILURE )
	ZEND_PARSE_PARAMETERS_START(1, 2)
		Z_PARAM_STRING(file, file_len)
		Z_PARAM_OPTIONAL
		Z_PARAM_BOOL(loop)
	ZEND_PARSE_PARAMETERS_END();

	if( !*file ) file= NULL;

	default_flags= SND_ASYNC | SND_NOSTOP | SND_NOWAIT;

	if( file==NULL )
		default_flags= SND_PURGE;
	else if( loop )
		default_flags|= SND_LOOP;

	ret= PlaySound( file, NULL, default_flags | SND_FILENAME );
	if( ret )
		RETURN_TRUE;
	RETURN_FALSE;
}
/* }}} */

/* {{{ proto bool win_beep(string type)
    plays the system sound used by default for pre-defined events:
        '*': System Asterisk
        '!': System Exclamation
        'H': System Hand
        '?': System Question
        '1': System Default
        '0': Standard beep using the computer speaker
*/
PHP_FUNCTION(win_beep)
{
	UINT beep_type;
	char * str= "";
	size_t str_len= 0;

	//if( zend_parse_parameters( ZEND_NUM_ARGS() TSRMLS_CC, "|s", &str, &str_len ) == FAILURE )
	ZEND_PARSE_PARAMETERS_START(0, 1)
		Z_PARAM_OPTIONAL
		Z_PARAM_STRING(str, str_len)
	ZEND_PARSE_PARAMETERS_END();

	switch(*str)
	{
	case '*': // System Asterisk
		beep_type= MB_ICONASTERISK;
		break;
	case '!': // System Exclamation
		beep_type= MB_ICONEXCLAMATION;
		break;
	case 'H': // System Hand
		beep_type= MB_ICONHAND;
		break;
	case '?': // System Question
		beep_type= MB_ICONQUESTION;
		break;
	case '1': // System Default
		beep_type= MB_OK;
		break;
	default:
	case '0': // Standard beep using the computer speaker
		beep_type= 0xFFFFFFFF;
		// zend_printf("Default\n");
		break;
	}
	if( !MessageBeep( beep_type ) )
		RETURN_FALSE;

	RETURN_TRUE;
}
/* }}} */


/* {{{ proto int win_create_link( file, link_file, args, descr, workingdir )
   Create a MS link file (.lnk)
   Don't forget the .lnk at the end of link_file !
*/
PHP_FUNCTION(win_create_link)
{
    char *file, *link, *args=NULL, *descr=NULL, *workingdir=NULL;
    size_t file_len, link_len, args_len, descr_len, workingdir_len;

    //if( zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|sss", &file, &file_len, &link, &link_len, &args, &args_len, &descr, &descr_len, &workingdir, &workingdir_len) == FAILURE )
	ZEND_PARSE_PARAMETERS_START(2, 5)
		Z_PARAM_STRING(file, file_len)
		Z_PARAM_STRING(link, link_len)
		Z_PARAM_OPTIONAL
		Z_PARAM_STRING(args, args_len)
		Z_PARAM_STRING(descr, descr_len)
		Z_PARAM_STRING(workingdir, workingdir_len)
	ZEND_PARSE_PARAMETERS_END();

    if( !php_create_link(file, link, args, descr, workingdir) ) {
        RETURN_FALSE;
    }

    RETURN_TRUE;
}
/* }}} */


/* {{{ proto int win_message_box( text[, type, caption] )
   Prompt a typical Win32 message box.
   Use the Messages Box Constants to modify the appearance of the message box
*/
PHP_FUNCTION(win_message_box)
{
    char *text, *caption= "PHP";
    size_t text_len, caption_len, type=MB_OK;

    //if( zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|ls", &text, &text_len, &type, &caption, &caption_len) == FAILURE )
	ZEND_PARSE_PARAMETERS_START(1, 3)
		Z_PARAM_STRING(text, text_len)
		Z_PARAM_OPTIONAL
		Z_PARAM_LONG(type)
		Z_PARAM_STRING(caption, caption_len)
	ZEND_PARSE_PARAMETERS_END();

    RETURN_LONG(MessageBox(NULL, text, caption, type|MB_TASKMODAL));
}
/* }}} */



/* {{{ proto int win_browse_folder( [string dir, string caption=""] )
   Prompt a "browse for folder" message box
*/
PHP_FUNCTION(win_browse_folder)
{
    char *dir=NULL, *caption=NULL, system_dir[MAX_PATH+1]= "";
    size_t dir_len, caption_len;

    //if( zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|ss", &dir, &dir_len, &caption, &caption_len) == FAILURE )
	ZEND_PARSE_PARAMETERS_START(0, 2)
		Z_PARAM_OPTIONAL
		Z_PARAM_STRING(dir, dir_len)
		Z_PARAM_STRING(caption, caption_len)
	ZEND_PARSE_PARAMETERS_END();

	if( dir ) {
		strncpy( system_dir, dir, MAX_PATH );
		system_dir[MAX_PATH]= 0;
	}

    if( !php_browse_for_folder(NULL, caption, system_dir) ) {
        RETURN_NULL();
    }

    RETVAL_STRING(system_dir);
}
/* }}} */


/* {{{ proto string win_browse_file( [open, path, filename, ext, filter] )
    open or save dialog box, starting path, default filename, default extension, filter in M$ format
    Filter exemple: "HTML File\0*.htm;*.html\0INI file\0*.ini\0All files\0*.*\0\0"
	or: array( "HTML File" => "*.htm;*.html", "INI File" => "*.ini", "All file" => "*.*" )
*/
PHP_FUNCTION(win_browse_file)
{
    char *ext= NULL, *path= NULL, *file= NULL;
	zend_string *key;
    size_t open=1, ext_len, path_len, file_len, free_filter= 0, not_string;
	HashPosition key_len;
	zval *zfilter= NULL, **entry;
    char fileBuffer[MAX_PATH]= "";
    OPENFILENAME ofn;
    BOOL res;
	HashTable *target_hash;
 	HashPosition pos;
	smart_string smart_filter= {0};

    //if( zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|lsssz", &open, &path, &path_len, &file, &file_len, &ext, &ext_len, &zfilter) == FAILURE )
	ZEND_PARSE_PARAMETERS_START(0, 5)
		Z_PARAM_OPTIONAL
		Z_PARAM_LONG(open)
		Z_PARAM_STRING(path, path_len)
		Z_PARAM_STRING(file, file_len)
		Z_PARAM_STRING(ext, ext_len)
		Z_PARAM_ZVAL(zfilter)
	ZEND_PARSE_PARAMETERS_END();

	if( file ) { strcpy(fileBuffer, file ); }

    memset(&ofn, 0, sizeof(OPENFILENAME));
    ofn.lStructSize= sizeof(OPENFILENAME);
    ofn.hwndOwner= NULL;
    ofn.lpstrFilter= NULL;
    ofn.lpstrFile= fileBuffer;
    ofn.nMaxFile= MAX_PATH;
    //ofn.lpstrFileTitle
    //ofn.nMaxFileTitle
    ofn.lpstrInitialDir= path;
    //ofn.lpstrTitle= "Choose file";
    ofn.lpstrDefExt= ext;
    ofn.Flags= OFN_CREATEPROMPT|OFN_NOCHANGEDIR|OFN_OVERWRITEPROMPT|OFN_PATHMUSTEXIST|OFN_HIDEREADONLY;
    //OFN_FILEMUSTEXIST

	//php_printf("win_browse_file: file filter hashtable=%p\n", Z_ARRVAL_P(zv_ptr));

	/* Filter */
	free_filter= 0;
	if( zfilter && Z_TYPE_P(zfilter)==IS_ARRAY ) {

		target_hash = HASH_OF(zfilter);
		not_string= 0;
		zend_hash_internal_pointer_reset_ex(target_hash, &pos);
		while (zend_hash_get_current_data_ex(target_hash, &pos) == SUCCESS) {
			
			if( entry = zend_hash_get_current_key_ex(target_hash, &key, &key_len, &pos)!=HASH_KEY_IS_STRING ) { 
				not_string= 1; break; 
			
			}

			if( Z_TYPE_P(*entry)!=IS_STRING ) { /*not_string= 1;*/
				zend_error( E_WARNING, "win_browse_file: filter key '%s' must have a string value", key );
				zend_hash_move_forward_ex(target_hash, &pos);
				continue;
			}

			smart_string_appends( &smart_filter, key );
			smart_string_appendc( &smart_filter, '\0' );
			smart_string_appends( &smart_filter, Z_STRVAL_P(*entry) );
			smart_string_appendc( &smart_filter, '\0' );

			zend_hash_move_forward_ex(target_hash, &pos);
		}
		if(not_string ) {
			zend_error( E_WARNING, "win_browse_file: filter must be an associative array, or just use a string isntead HTML File\0*.htm;*.html\0INI file\0*.ini\0All files\0*.*\0\0" );
			smart_string_free(&smart_filter);
		}
		smart_string_appendc( &smart_filter, '\0' );
		ofn.lpstrFilter= smart_filter.c;
		free_filter= 1;
	}
	else if( zfilter && Z_TYPE_P(zfilter)==IS_STRING ) {
		ofn.lpstrFilter= Z_STRVAL_P(zfilter);
	}
	else if( zfilter ) {
		zend_error( E_WARNING, "win_browse_file: the filter parameter must be an array" );
	}


    if( open ){
        res= GetOpenFileName(&ofn);
	}
    else{
        res= GetSaveFileName(&ofn);
	}

	if( free_filter ){
		smart_string_free(&smart_filter);
	}

    if( !res ){
        RETURN_NULL();
	}
    else{
        RETVAL_STRING(fileBuffer);
	}
}
/* }}} */




/*******************************************************************/
/*******************************************************************/
/************************** PHP EXT STUFF **************************/
/*******************************************************************/
/*******************************************************************/


/* If you declare any globals in php_win32std.h uncomment this:
ZEND_DECLARE_MODULE_GLOBALS(win32std)
*/

ZEND_FUNCTION(res_get);
ZEND_FUNCTION(res_list);
ZEND_FUNCTION(res_list_type);
ZEND_FUNCTION(res_open);
ZEND_FUNCTION(res_close);
ZEND_FUNCTION(res_set);
ZEND_FUNCTION(res_exists);
ZEND_FUNCTION(win_play_wav);
ZEND_FUNCTION(win_beep);
ZEND_FUNCTION(win_message_box);
ZEND_FUNCTION(win_create_link);
ZEND_FUNCTION(win_browse_folder);
ZEND_FUNCTION(win_browse_file);

/* True global resources - no need for thread safety here */
//static int le_win32std;

// 					See: https://github.com/php/php-src/blob/master/Zend/zend_API.h

/* {{{ win32std_functions[]
 *
 * Every user visible function must have an entry in win32std_functions[].
 */
zend_function_entry win32std_functions[] = {

	/* Res */
	ZEND_FE(res_get,			arginfo_res_get)
	ZEND_FE(res_list,		arginfo_res_list)
	ZEND_FE(res_list_type,	arginfo_res_list_type)
	ZEND_FE(res_open,		arginfo_res_open)
	ZEND_FE(res_close,		arginfo_res_close)
	ZEND_FE(res_set,			arginfo_res_set)
	ZEND_FE(res_exists,		arginfo_res_exists)

	/* Win32 */
	ZEND_FE(win_play_wav,		arginfo_win_play_wav)
	ZEND_FE(win_beep,			arginfo_win_beep)
	ZEND_FE(win_message_box,		arginfo_win_message_box)
	ZEND_FE(win_create_link,		arginfo_win_create_link)
	ZEND_FE(win_browse_folder,	arginfo_win_browse_folder)
	ZEND_FE(win_browse_file,		arginfo_win_browse_file)

    {NULL, NULL, NULL}	/* Must be the last line in win32std_functions[] */
};
/* }}} */

#if ZEND_MODULE_API_NO < 20010901
# error Module made for PHP 4.1.x
#endif

/* {{{ win32std_module_entry
 */
zend_module_entry win32std_module_entry = {
#if ZEND_MODULE_API_NO >= 20010901
	STANDARD_MODULE_HEADER,
#endif
	"win32std",
	win32std_functions,
	ZEND_MINIT(win32std),
	ZEND_MSHUTDOWN(win32std),
	ZEND_RINIT(win32std),		/* Replace with NULL if there's nothing to do at request start */
	ZEND_RSHUTDOWN(win32std),	/* Replace with NULL if there's nothing to do at request end */
#if ZEND_MODULE_API_NO >= 20010901
	ZEND_MINFO(win32std),
#endif
    "0.1", /* Replace with version number for your extension */
	STANDARD_MODULE_PROPERTIES
};
/* }}} */

#ifdef COMPILE_DL_WIN32STD
ZEND_GET_MODULE(win32std)
#endif

/* {{{ PHP_INI
 */
/* Remove comments and fill if you need to have entries in php.ini
PHP_INI_BEGIN()
    STD_PHP_INI_ENTRY("win32std.value",      "42", PHP_INI_ALL, OnUpdateInt, global_value, zend_win32std_globals, win32std_globals)
    STD_PHP_INI_ENTRY("win32std.string", "foobar", PHP_INI_ALL, OnUpdateString, global_string, zend_win32std_globals, win32std_globals)
PHP_INI_END()
*/
/* }}} */

/* {{{ php_win32std_init_globals
 */
/* Uncomment this function if you have INI entries
static void php_win32std_init_globals(zend_win32std_globals *win32std_globals)
{
	win32std_globals->value = 0;
	win32std_globals->string = NULL;
}
*/
/* }}} */


#define WIN32_ZEND_CONST(type, str, val) \
{ \
    zval* result = zend_get_constant_str((str), strlen(str)); \
    if (result == NULL) { \
        REGISTER_##type##_CONSTANT((str), (val), CONST_CS | CONST_PERSISTENT); \
    } else { \
        zval_ptr_dtor(result); \
    } \
}

/* {{{ PHP_MINIT_FUNCTION
 */
ZEND_MINIT_FUNCTION(win32std)
{
	/* If you have INI entries, uncomment these lines
	ZEND_INIT_MODULE_GLOBALS(win32std, php_win32std_init_globals, NULL);
	REGISTER_INI_ENTRIES();
	*/

    /**
    * Resources
    **/
	le_res_resource = zend_register_list_destructors_ex(_php_res_destruction_handler, NULL, le_res_resource_name, module_number);
	php_register_url_stream_wrapper("res", &php_res_stream_wrapper);

    /* Resource type constants */
	WIN32_ZEND_CONST(STRING, "RT_CURSOR", ("#1"));
	WIN32_ZEND_CONST(STRING, "RT_BITMAP", ("#2"));
	WIN32_ZEND_CONST(STRING, "RT_ICON", ("#3"));
	WIN32_ZEND_CONST(STRING, "RT_MENU", ("#4"));
	WIN32_ZEND_CONST(STRING, "RT_DIALOG", ("#5"));
	WIN32_ZEND_CONST(STRING, "RT_STRING", ("#6"));
	WIN32_ZEND_CONST(STRING, "RT_FONTDIR", ("#7"));
	WIN32_ZEND_CONST(STRING, "RT_FONT", ("#8"));
	WIN32_ZEND_CONST(STRING, "RT_ACCELERATOR", ("#9"));
	WIN32_ZEND_CONST(STRING, "RT_RCDATA", ("#10"));
	WIN32_ZEND_CONST(STRING, "RT_MESSAGETABLE", ("#11"));
	WIN32_ZEND_CONST(STRING, "RT_GROUP_CURSOR", ("#12"));
	WIN32_ZEND_CONST(STRING, "RT_GROUP_ICON", ("#14"));
	WIN32_ZEND_CONST(STRING, "RT_VERSION", ("#16"));
	WIN32_ZEND_CONST(STRING, "RT_DLGINCLUDE", ("#17"));
	WIN32_ZEND_CONST(STRING, "RT_PLUGPLAY", ("#19"));
	WIN32_ZEND_CONST(STRING, "RT_VXD", ("#20"));
	WIN32_ZEND_CONST(STRING, "RT_ANICURSOR", ("#21"));
	WIN32_ZEND_CONST(STRING, "RT_ANIICON", ("#22"));
	WIN32_ZEND_CONST(STRING, "RT_HTML", ("#23"));
	WIN32_ZEND_CONST(STRING, "RT_NOT_DOCUMENTED", ("#241"));

    /**
    * Messages box
    **/
    /* Message box type constants */
	WIN32_ZEND_CONST(LONG, "MB_OK", MB_OK);
	WIN32_ZEND_CONST(LONG, "MB_OKCANCEL", MB_OKCANCEL);
	WIN32_ZEND_CONST(LONG, "MB_RETRYCANCEL", MB_RETRYCANCEL);
	WIN32_ZEND_CONST(LONG, "MB_YESNO", MB_YESNO);
	WIN32_ZEND_CONST(LONG, "MB_YESNOCANCEL", MB_YESNOCANCEL);

    /* Message box icon constants */
	WIN32_ZEND_CONST(LONG, "MB_ICONEXCLAMATION", MB_ICONEXCLAMATION);
	WIN32_ZEND_CONST(LONG, "MB_ICONWARNING", MB_ICONWARNING);
	WIN32_ZEND_CONST(LONG, "MB_ICONINFORMATION", MB_ICONINFORMATION);
	WIN32_ZEND_CONST(LONG, "MB_ICONASTERISK", MB_ICONASTERISK);
	WIN32_ZEND_CONST(LONG, "MB_ICONQUESTION", MB_ICONQUESTION);
	WIN32_ZEND_CONST(LONG, "MB_ICONSTOP", MB_ICONSTOP);
	WIN32_ZEND_CONST(LONG, "MB_ICONERROR", MB_ICONERROR);
	WIN32_ZEND_CONST(LONG, "MB_ICONHAND", MB_ICONHAND);
   
    /* Message box default button constants */
	WIN32_ZEND_CONST(LONG, "MB_DEFBUTTON1", MB_DEFBUTTON1);
	WIN32_ZEND_CONST(LONG, "MB_DEFBUTTON2", MB_DEFBUTTON2);
	WIN32_ZEND_CONST(LONG, "MB_DEFBUTTON3", MB_DEFBUTTON3);
	WIN32_ZEND_CONST(LONG, "MB_DEFBUTTON4", MB_DEFBUTTON4);

    /* Message box return constants */
	WIN32_ZEND_CONST(LONG, "MB_IDABORT", IDABORT);
	WIN32_ZEND_CONST(LONG, "MB_IDCANCEL", IDCANCEL);
	WIN32_ZEND_CONST(LONG, "MB_IDNO", IDNO);
	WIN32_ZEND_CONST(LONG, "MB_IDOK", IDOK);
	WIN32_ZEND_CONST(LONG, "MB_IDYES", IDYES);
//    WIN32_ZEND_CONST("MB_IDCONTINUE", IDCONTINUE);
	WIN32_ZEND_CONST(LONG, "MB_IDIGNORE", IDIGNORE);
	WIN32_ZEND_CONST(LONG, "MB_IDRETRY", IDRETRY);
//	WIN32_ZEND_CONST(LONG, "MB_IDTRYAGAIN", IDTRYAGAIN);

	return SUCCESS;
}
/* }}} */

/* {{{ PHP_MSHUTDOWN_FUNCTION
 */
ZEND_MSHUTDOWN_FUNCTION(win32std)
{
	/* uncomment this line if you have INI entries
	UNREGISTER_INI_ENTRIES();
	*/
	return SUCCESS;
}
/* }}} */

/* Remove if there's nothing to do at request start */
/* {{{ PHP_RINIT_FUNCTION
 */
ZEND_RINIT_FUNCTION(win32std)
{
	return SUCCESS;
}
/* }}} */

/* Remove if there's nothing to do at request end */
/* {{{ PHP_RSHUTDOWN_FUNCTION
 */
ZEND_RSHUTDOWN_FUNCTION(win32std)
{
	return SUCCESS;
}
/* }}} */

/* {{{ PHP_MINFO_FUNCTION
 */
ZEND_MINFO_FUNCTION(win32std)
{
	php_info_print_table_start();
	php_info_print_table_header(2, "win32std", "enabled");
	php_info_print_table_row(2, "resource support", "enabled");
	php_info_print_table_row(2, "message box support", "enabled");
	php_info_print_table_end();

	/* Remove comments if you have entries in php.ini
	DISPLAY_INI_ENTRIES();
	*/
}
/* }}} */


/* Remove the following function when you have succesfully modified config.m4
   so that your module can be compiled into PHP, it exists only for testing
   purposes. */

/* Every user-visible function in PHP should document itself in the source */
/* {{{ proto string confirm_win32std_compiled(string arg)
   Return a string to confirm that the module is compiled in */
PHP_FUNCTION(confirm_win32std_compiled)
{
	char *arg = NULL;
	size_t arg_len, len;
	char string[256];

	//if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &arg, &arg_len) == FAILURE)
	ZEND_PARSE_PARAMETERS_START(1, 1)
		Z_PARAM_STRING(arg, arg_len)
	ZEND_PARSE_PARAMETERS_END();

	len = sprintf(string, "Congratulations! You have successfully modified ext/%.78s/config.m4. Module %.78s is now compiled into PHP.", "win32std", arg);
	RETURN_STRINGL(string, len);
}
/* }}} */



/*
BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
{
	switch (fdwReason) {
		case DLL_PROCESS_ATTACH:
			break;
		case DLL_THREAD_ATTACH:
			break;
		case DLL_THREAD_DETACH:
			break;
		case DLL_PROCESS_DETACH:
			break;
	}
	return TRUE;
}*/

//_DEBUG,__WIN32__,ZEND_DEBUG=1,_WINDOWS,_USRDLL,ZTS,ZEND_WIN32,PHP_WIN32,WIN32,_MBCS,USE_WSAPI
//_DEBUG,__WIN32__,USE_TLS,WIN32,_MBCS,ZEND_DEBUG=1,NDEBUG,_WINDOWS,_USRDLL,SBEE_EXPORTS,COMPILE_DL_SBEE,ZTS=1,ZEND_WIN32,PHP_WIN32,HAVE_SBEE=1

/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 * vim600: sw=4 ts=4 tw=78 fdm=marker
 * vim<600: sw=4 ts=4 tw=78
 */