From 58b26398de0ecf886049d93dff1924a465a5be74 Mon Sep 17 00:00:00 2001 From: Sascha Schumann Date: Mon, 18 Nov 2002 17:06:05 +0000 Subject: [PATCH] Add FAM support for LGPLed libfam. FAM, the File Alteration Monitor, provides an API that applications can use to be notified when specific files or directories are changed. FAM is being used in Enlightenment, GNOME/Nautilus, and KDE. # Yes, this will be moved to PECL once that is fully usable. Emails about # this issue will likely be redirected to /dev/null. :-) --- ext/fam/CREDITS | 2 + ext/fam/config.m4 | 57 ++++++ ext/fam/fam.c | 442 ++++++++++++++++++++++++++++++++++++++++++++++ ext/fam/php_fam.h | 89 ++++++++++ 4 files changed, 590 insertions(+) create mode 100644 ext/fam/CREDITS create mode 100644 ext/fam/config.m4 create mode 100644 ext/fam/fam.c create mode 100644 ext/fam/php_fam.h diff --git a/ext/fam/CREDITS b/ext/fam/CREDITS new file mode 100644 index 0000000000..60e3234a4c --- /dev/null +++ b/ext/fam/CREDITS @@ -0,0 +1,2 @@ +fam +Sascha Schumann diff --git a/ext/fam/config.m4 b/ext/fam/config.m4 new file mode 100644 index 0000000000..aeca04c6a3 --- /dev/null +++ b/ext/fam/config.m4 @@ -0,0 +1,57 @@ +dnl $Id$ +dnl config.m4 for extension fam + +dnl Comments in this file start with the string 'dnl'. +dnl Remove where necessary. This file will not work +dnl without editing. + +dnl If your extension references something external, use with: + +PHP_ARG_WITH(fam, for fam support, +Make sure that the comment is aligned: +[ --with-fam Include fam support]) + +if test "$PHP_FAM" != "no"; then + dnl Write more examples of tests here... + + dnl # --with-fam -> check with-path +SEARCH_PATH="/usr/local /usr" # you might want to change this +SEARCH_FOR="/include/fam.h" # you most likely want to change this +if test -r $PHP_FAM/$SEARCH_FOR; then # path given as parameter + FAM_DIR=$PHP_FAM +else # search default path list + AC_MSG_CHECKING([for fam files in default path]) + for i in $SEARCH_PATH ; do + if test -r $i/$SEARCH_FOR; then + FAM_DIR=$i + AC_MSG_RESULT(found in $i) + fi + done +fi + +if test -z "$FAM_DIR"; then + AC_MSG_RESULT([not found]) + AC_MSG_ERROR([Please reinstall the fam distribution]) +fi + +# --with-fam -> add include path +PHP_ADD_INCLUDE($FAM_DIR/include) + +# --with-fam -> chech for lib and symbol presence +LIBNAME=fam # you may want to change this +LIBSYMBOL=FAMOpen # you most likely want to change this + +PHP_CHECK_LIBRARY($LIBNAME,$LIBSYMBOL, +[ + PHP_ADD_LIBRARY_WITH_PATH($LIBNAME, $FAM_DIR/lib, FAM_SHARED_LIBADD) + AC_DEFINE(HAVE_FAMLIB,1,[ ]) +],[ + AC_MSG_ERROR([wrong fam lib version or lib not found]) +],[ + -L$FAM_DIR/lib -lm -ldl +]) + +PHP_SUBST(FAM_SHARED_LIBADD) + + PHP_NEW_EXTENSION(fam, fam.c, $ext_shared) +fi diff --git a/ext/fam/fam.c b/ext/fam/fam.c new file mode 100644 index 0000000000..fc8f716810 --- /dev/null +++ b/ext/fam/fam.c @@ -0,0 +1,442 @@ +/* + +----------------------------------------------------------------------+ + | PHP Version 4 | + +----------------------------------------------------------------------+ + | Copyright (c) 1997-2002 The PHP Group | + +----------------------------------------------------------------------+ + | This source file is subject to version 2.02 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/2_02.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: Sascha Schumann | + +----------------------------------------------------------------------+ + + $Id$ +*/ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include "php.h" +#include "php_ini.h" +#include "ext/standard/info.h" +#include "php_fam.h" + +#include + +/* If you declare any globals in php_fam.h uncomment this: +ZEND_DECLARE_MODULE_GLOBALS(fam) +*/ + +/* True global resources - no need for thread safety here */ +static int le_fam, le_fam_r; + +/* {{{ fam_functions[] + * + * Every user visible function must have an entry in fam_functions[]. + */ +function_entry fam_functions[] = { + PHP_FE(fam_open, NULL) + PHP_FE(fam_close, NULL) + PHP_FE(fam_monitor_directory, NULL) + PHP_FE(fam_monitor_file, NULL) + PHP_FE(fam_monitor_collection, NULL) + PHP_FE(fam_suspend_monitor, NULL) + PHP_FE(fam_resume_monitor, NULL) + PHP_FE(fam_cancel_monitor, NULL) + PHP_FE(fam_pending, NULL) + PHP_FE(fam_next_event, NULL) + {NULL, NULL, NULL} /* Must be the last line in fam_functions[] */ +}; +/* }}} */ + +/* {{{ fam_module_entry + */ +zend_module_entry fam_module_entry = { +#if ZEND_MODULE_API_NO >= 20010901 + STANDARD_MODULE_HEADER, +#endif + "fam", + fam_functions, + PHP_MINIT(fam), + PHP_MSHUTDOWN(fam), + PHP_RINIT(fam), /* Replace with NULL if there's nothing to do at request start */ + PHP_RSHUTDOWN(fam), /* Replace with NULL if there's nothing to do at request end */ + PHP_MINFO(fam), +#if ZEND_MODULE_API_NO >= 20010901 + "0.1", /* Replace with version number for your extension */ +#endif + STANDARD_MODULE_PROPERTIES +}; +/* }}} */ + +#ifdef COMPILE_DL_FAM +ZEND_GET_MODULE(fam) +#endif + +/* {{{ PHP_INI + */ +/* Remove comments and fill if you need to have entries in php.ini +PHP_INI_BEGIN() + STD_PHP_INI_ENTRY("fam.global_value", "42", PHP_INI_ALL, OnUpdateInt, global_value, zend_fam_globals, fam_globals) + STD_PHP_INI_ENTRY("fam.global_string", "foobar", PHP_INI_ALL, OnUpdateString, global_string, zend_fam_globals, fam_globals) +PHP_INI_END() +*/ +/* }}} */ + +/* {{{ php_fam_init_globals + */ +/* Uncomment this function if you have INI entries +static void php_fam_init_globals(zend_fam_globals *fam_globals) +{ + fam_globals->global_value = 0; + fam_globals->global_string = NULL; +} +*/ +/* }}} */ + +static void rsrc_close_fam(zend_rsrc_list_entry *rsrc TSRMLS_DC) +{ + FAMConnection *fc = (FAMConnection *) rsrc->ptr; + FAMClose(fc); + efree(fc); +} + +static void rsrc_close_fam_r(zend_rsrc_list_entry *rsrc TSRMLS_DC) +{ + /* No need to close */ + efree(rsrc->ptr); +} + +/* {{{ PHP_MINIT_FUNCTION + */ +PHP_MINIT_FUNCTION(fam) +{ + le_fam = zend_register_list_destructors_ex(rsrc_close_fam, NULL, "fam connections", module_number); + le_fam_r = zend_register_list_destructors_ex(rsrc_close_fam_r, NULL, "fam requests", module_number); + /* If you have INI entries, uncomment these lines + ZEND_INIT_MODULE_GLOBALS(fam, php_fam_init_globals, NULL); + REGISTER_INI_ENTRIES(); + */ + + + REGISTER_LONG_CONSTANT("FAMChanged", FAMChanged, CONST_PERSISTENT); + REGISTER_LONG_CONSTANT("FAMDeleted", FAMDeleted, CONST_PERSISTENT); + REGISTER_LONG_CONSTANT("FAMStartExecuting", FAMStartExecuting, CONST_PERSISTENT); + REGISTER_LONG_CONSTANT("FAMStopExecuting", FAMStopExecuting, CONST_PERSISTENT); + REGISTER_LONG_CONSTANT("FAMCreated", FAMCreated, CONST_PERSISTENT); + REGISTER_LONG_CONSTANT("FAMMoved", FAMMoved, CONST_PERSISTENT); + REGISTER_LONG_CONSTANT("FAMAcknowledge", FAMAcknowledge, CONST_PERSISTENT); + REGISTER_LONG_CONSTANT("FAMExists", FAMExists, CONST_PERSISTENT); + REGISTER_LONG_CONSTANT("FAMEndExist", FAMEndExist, CONST_PERSISTENT); + return SUCCESS; +} +/* }}} */ + +/* {{{ PHP_MSHUTDOWN_FUNCTION + */ +PHP_MSHUTDOWN_FUNCTION(fam) +{ + /* 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 + */ +PHP_RINIT_FUNCTION(fam) +{ + return SUCCESS; +} +/* }}} */ + +/* Remove if there's nothing to do at request end */ +/* {{{ PHP_RSHUTDOWN_FUNCTION + */ +PHP_RSHUTDOWN_FUNCTION(fam) +{ + return SUCCESS; +} +/* }}} */ + +/* {{{ PHP_MINFO_FUNCTION + */ +PHP_MINFO_FUNCTION(fam) +{ + php_info_print_table_start(); + php_info_print_table_header(2, "fam support", "enabled"); + php_info_print_table_end(); + + /* Remove comments if you have entries in php.ini + DISPLAY_INI_ENTRIES(); + */ +} +/* }}} */ + + +/* {{{ proto int fam_open([string appname]) + */ +PHP_FUNCTION(fam_open) +{ + char *appname = NULL; + int argc = ZEND_NUM_ARGS(); + int appname_len; + FAMConnection *fc; + int r; + + if (zend_parse_parameters(argc TSRMLS_CC, "|s", &appname, &appname_len) == FAILURE) + return; + + fc = emalloc(sizeof *fc); + r = FAMOpen2(fc, appname); + + if (r < 0) { + efree(fc); + RETURN_FALSE; + } + + ZEND_REGISTER_RESOURCE(return_value, fc, le_fam); +} +/* }}} */ + +/* {{{ proto boolean fam_close(resource id) + */ +PHP_FUNCTION(fam_close) +{ + int argc = ZEND_NUM_ARGS(); + zval *id; + + if (zend_parse_parameters(argc TSRMLS_CC, "r", &id) == FAILURE) + return; + + zend_list_delete(Z_RESVAL_P(id)); +} +/* }}} */ + +/* {{{ proto int fam_monitor_directory(resource id, string dirname) + */ +PHP_FUNCTION(fam_monitor_directory) +{ + char *dirname = NULL; + int argc = ZEND_NUM_ARGS(); + int dirname_len; + zval *id; + FAMRequest *fr; + FAMConnection *fc; + + if (zend_parse_parameters(argc TSRMLS_CC, "rs", &id, &dirname, &dirname_len) == FAILURE) + return; + + ZEND_FETCH_RESOURCE(fc, FAMConnection *, &id, -1, "fam", le_fam); + ZEND_VERIFY_RESOURCE(fc); + + fr = emalloc(sizeof *fr); + + if (FAMMonitorDirectory(fc, dirname, fr, NULL) < 0) { + efree(fr); + RETURN_FALSE; + } + + ZEND_REGISTER_RESOURCE(return_value, fr, le_fam_r); +} +/* }}} */ + +/* {{{ proto int fam_monitor_file(resource id, string filename) + */ +PHP_FUNCTION(fam_monitor_file) +{ + char *filename = NULL; + int argc = ZEND_NUM_ARGS(); + int filename_len; + zval *id; + FAMRequest *fr; + FAMConnection *fc; + + if (zend_parse_parameters(argc TSRMLS_CC, "rs", &id, &filename, &filename_len) == FAILURE) + return; + + ZEND_FETCH_RESOURCE(fc, FAMConnection *, &id, -1, "fam", le_fam); + ZEND_VERIFY_RESOURCE(fc); + + fr = emalloc(sizeof *fr); + + if (FAMMonitorFile(fc, filename, fr, NULL) < 0) { + efree(fr); + RETURN_FALSE; + } + + ZEND_REGISTER_RESOURCE(return_value, fr, le_fam_r); +} +/* }}} */ + +/* {{{ proto int fam_monitor_collection(resource id, string dirname, int depth, string mask) + */ +PHP_FUNCTION(fam_monitor_collection) +{ + char *dirname = NULL; + char *mask = NULL; + int argc = ZEND_NUM_ARGS(); + int dirname_len; + int mask_len; + zval *id; + long depth; + FAMRequest *fr; + FAMConnection *fc; + + if (zend_parse_parameters(argc TSRMLS_CC, "rsls", &id, &dirname, &dirname_len, &depth, &mask, &mask_len) == FAILURE) + return; + + ZEND_FETCH_RESOURCE(fc, FAMConnection *, &id, -1, "fam", le_fam); + ZEND_VERIFY_RESOURCE(fc); + + fr = emalloc(sizeof *fr); + + if (FAMMonitorCollection(fc, dirname, fr, NULL, depth, mask) < 0) { + efree(fr); + RETURN_FALSE; + } + + ZEND_REGISTER_RESOURCE(return_value, fr, le_fam_r); + +} +/* }}} */ + +/* {{{ proto boolean fam_suspend_monitor(resource id, resource monitor_id) + */ +PHP_FUNCTION(fam_suspend_monitor) +{ + int argc = ZEND_NUM_ARGS(); + zval *id; + zval *monitor_id; + FAMRequest *fr; + FAMConnection *fc; + + if (zend_parse_parameters(argc TSRMLS_CC, "rr", &id, &monitor_id) == FAILURE) + return; + + ZEND_FETCH_RESOURCE(fc, FAMConnection *, &id, -1, "fam", le_fam); + ZEND_VERIFY_RESOURCE(fc); + ZEND_FETCH_RESOURCE(fr, FAMRequest *, &monitor_id, -1, "fam", le_fam_r); + ZEND_VERIFY_RESOURCE(fr); + + if (FAMSuspendMonitor(fc, fr) < 0) + RETURN_FALSE; + RETURN_TRUE; +} +/* }}} */ + +/* {{{ proto boolean fam_resume_monitor(resource id, resource monitor_id) + */ +PHP_FUNCTION(fam_resume_monitor) +{ + int argc = ZEND_NUM_ARGS(); + zval *id; + zval *monitor_id; + FAMRequest *fr; + FAMConnection *fc; + + if (zend_parse_parameters(argc TSRMLS_CC, "rr", &id, &monitor_id) == FAILURE) + return; + + ZEND_FETCH_RESOURCE(fc, FAMConnection *, &id, -1, "fam", le_fam); + ZEND_VERIFY_RESOURCE(fc); + ZEND_FETCH_RESOURCE(fr, FAMRequest *, &monitor_id, -1, "fam", le_fam_r); + ZEND_VERIFY_RESOURCE(fr); + + if (FAMResumeMonitor(fc, fr) < 0) + RETURN_FALSE; + RETURN_TRUE; + +} +/* }}} */ + +/* {{{ proto boolean fam_cancel_monitor(resource id, resource monitor_id) + */ +PHP_FUNCTION(fam_cancel_monitor) +{ + int argc = ZEND_NUM_ARGS(); + zval *id; + zval *monitor_id; + FAMRequest *fr; + FAMConnection *fc; + int r; + + if (zend_parse_parameters(argc TSRMLS_CC, "rr", &id, &monitor_id) == FAILURE) + return; + + ZEND_FETCH_RESOURCE(fc, FAMConnection *, &id, -1, "fam", le_fam); + ZEND_VERIFY_RESOURCE(fc); + ZEND_FETCH_RESOURCE(fr, FAMRequest *, &monitor_id, -1, "fam", le_fam_r); + ZEND_VERIFY_RESOURCE(fr); + + r = FAMCancelMonitor(fc, fr); + + zend_list_delete(Z_RESVAL_P(monitor_id)); + + if (r < 0) + RETURN_FALSE; + RETURN_TRUE; +} +/* }}} */ + +/* {{{ proto int fam_pending(resource id) + */ +PHP_FUNCTION(fam_pending) +{ + int argc = ZEND_NUM_ARGS(); + zval *id; + FAMConnection *fc; + + if (zend_parse_parameters(argc TSRMLS_CC, "r", &id) == FAILURE) + return; + + ZEND_FETCH_RESOURCE(fc, FAMConnection *, &id, -1, "fam", le_fam); + ZEND_VERIFY_RESOURCE(fc); + + RETVAL_LONG(FAMPending(fc)); +} +/* }}} */ + +/* {{{ proto array fam_next_event(resource id) + */ +PHP_FUNCTION(fam_next_event) +{ + int argc = ZEND_NUM_ARGS(); + zval *id; + FAMConnection *fc; + FAMEvent fe; + + if (zend_parse_parameters(argc TSRMLS_CC, "r", &id) == FAILURE) + return; + + ZEND_FETCH_RESOURCE(fc, FAMConnection *, &id, -1, "fam", le_fam); + ZEND_VERIFY_RESOURCE(fc); + + if (FAMNextEvent(fc, &fe) < 0) + RETURN_FALSE; + + array_init(return_value); + if (fe.hostname) + add_assoc_string(return_value, "hostname", fe.hostname, 1); + add_assoc_string(return_value, "filename", fe.filename, 1); + add_assoc_long(return_value, "code", fe.code); +} +/* }}} */ + + +/* + * Local variables: + * tab-width: 4 + * c-basic-offset: 4 + * End: + * vim600: noet sw=4 ts=4 fdm=marker + * vim<600: noet sw=4 ts=4 + */ diff --git a/ext/fam/php_fam.h b/ext/fam/php_fam.h new file mode 100644 index 0000000000..036b3da94c --- /dev/null +++ b/ext/fam/php_fam.h @@ -0,0 +1,89 @@ +/* + +----------------------------------------------------------------------+ + | PHP Version 4 | + +----------------------------------------------------------------------+ + | Copyright (c) 1997-2002 The PHP Group | + +----------------------------------------------------------------------+ + | This source file is subject to version 2.02 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/2_02.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: | + +----------------------------------------------------------------------+ + + $Id$ +*/ + +#ifndef PHP_FAM_H +#define PHP_FAM_H + +extern zend_module_entry fam_module_entry; +#define phpext_fam_ptr &fam_module_entry + +#ifdef PHP_WIN32 +#define PHP_FAM_API __declspec(dllexport) +#else +#define PHP_FAM_API +#endif + +#ifdef ZTS +#include "TSRM.h" +#endif + +PHP_MINIT_FUNCTION(fam); +PHP_MSHUTDOWN_FUNCTION(fam); +PHP_RINIT_FUNCTION(fam); +PHP_RSHUTDOWN_FUNCTION(fam); +PHP_MINFO_FUNCTION(fam); + +PHP_FUNCTION(fam_open); +PHP_FUNCTION(fam_close); +PHP_FUNCTION(fam_monitor_directory); +PHP_FUNCTION(fam_monitor_file); +PHP_FUNCTION(fam_monitor_collection); +PHP_FUNCTION(fam_suspend_monitor); +PHP_FUNCTION(fam_resume_monitor); +PHP_FUNCTION(fam_cancel_monitor); +PHP_FUNCTION(fam_pending); +PHP_FUNCTION(fam_next_event); + +/* + Declare any global variables you may need between the BEGIN + and END macros here: + +ZEND_BEGIN_MODULE_GLOBALS(fam) + int global_value; + char *global_string; +ZEND_END_MODULE_GLOBALS(fam) +*/ + +/* In every utility function you add that needs to use variables + in php_fam_globals, call TSRM_FETCH(); after declaring other + variables used by that function, or better yet, pass in TSRMLS_CC + after the last function argument and declare your utility function + with TSRMLS_DC after the last declared argument. Always refer to + the globals in your function as FAM_G(variable). You are + encouraged to rename these macros something shorter, see + examples in any other php module directory. +*/ + +#ifdef ZTS +#define FAM_G(v) TSRMG(fam_globals_id, zend_fam_globals *, v) +#else +#define FAM_G(v) (fam_globals.v) +#endif + +#endif /* PHP_FAM_H */ + + +/* + * Local variables: + * tab-width: 4 + * c-basic-offset: 4 + * indent-tabs-mode: t + * End: + */ -- 2.40.0