zend_ini.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  1. /*
  2. +----------------------------------------------------------------------+
  3. | Zend Engine |
  4. +----------------------------------------------------------------------+
  5. | Copyright (c) Zend Technologies Ltd. (http://www.zend.com) |
  6. +----------------------------------------------------------------------+
  7. | This source file is subject to version 2.00 of the Zend license, |
  8. | that is bundled with this package in the file LICENSE, and is |
  9. | available through the world-wide-web at the following url: |
  10. | http://www.zend.com/license/2_00.txt. |
  11. | If you did not receive a copy of the Zend license and are unable to |
  12. | obtain it through the world-wide-web, please send a note to |
  13. | license@zend.com so we can mail you a copy immediately. |
  14. +----------------------------------------------------------------------+
  15. | Author: Zeev Suraski <zeev@php.net> |
  16. +----------------------------------------------------------------------+
  17. */
  18. #ifndef ZEND_INI_H
  19. #define ZEND_INI_H
  20. #define ZEND_INI_USER (1<<0)
  21. #define ZEND_INI_PERDIR (1<<1)
  22. #define ZEND_INI_SYSTEM (1<<2)
  23. #define ZEND_INI_ALL (ZEND_INI_USER|ZEND_INI_PERDIR|ZEND_INI_SYSTEM)
  24. #define ZEND_INI_MH(name) int name(zend_ini_entry *entry, zend_string *new_value, void *mh_arg1, void *mh_arg2, void *mh_arg3, int stage)
  25. #define ZEND_INI_DISP(name) ZEND_COLD void name(zend_ini_entry *ini_entry, int type)
  26. typedef struct _zend_ini_entry_def {
  27. const char *name;
  28. ZEND_INI_MH((*on_modify));
  29. void *mh_arg1;
  30. void *mh_arg2;
  31. void *mh_arg3;
  32. const char *value;
  33. void (*displayer)(zend_ini_entry *ini_entry, int type);
  34. uint32_t value_length;
  35. uint16_t name_length;
  36. uint8_t modifiable;
  37. } zend_ini_entry_def;
  38. struct _zend_ini_entry {
  39. zend_string *name;
  40. ZEND_INI_MH((*on_modify));
  41. void *mh_arg1;
  42. void *mh_arg2;
  43. void *mh_arg3;
  44. zend_string *value;
  45. zend_string *orig_value;
  46. void (*displayer)(zend_ini_entry *ini_entry, int type);
  47. int module_number;
  48. uint8_t modifiable;
  49. uint8_t orig_modifiable;
  50. uint8_t modified;
  51. };
  52. BEGIN_EXTERN_C()
  53. ZEND_API void zend_ini_startup(void);
  54. ZEND_API void zend_ini_shutdown(void);
  55. ZEND_API void zend_ini_global_shutdown(void);
  56. ZEND_API void zend_ini_deactivate(void);
  57. ZEND_API void zend_ini_dtor(HashTable *ini_directives);
  58. ZEND_API void zend_copy_ini_directives(void);
  59. ZEND_API void zend_ini_sort_entries(void);
  60. ZEND_API zend_result zend_register_ini_entries(const zend_ini_entry_def *ini_entry, int module_number);
  61. ZEND_API zend_result zend_register_ini_entries_ex(const zend_ini_entry_def *ini_entry, int module_number, int module_type);
  62. ZEND_API void zend_unregister_ini_entries(int module_number);
  63. ZEND_API void zend_unregister_ini_entries_ex(int module_number, int module_type);
  64. ZEND_API void zend_ini_refresh_caches(int stage);
  65. ZEND_API zend_result zend_alter_ini_entry(zend_string *name, zend_string *new_value, int modify_type, int stage);
  66. ZEND_API zend_result zend_alter_ini_entry_ex(zend_string *name, zend_string *new_value, int modify_type, int stage, bool force_change);
  67. ZEND_API zend_result zend_alter_ini_entry_chars(zend_string *name, const char *value, size_t value_length, int modify_type, int stage);
  68. ZEND_API zend_result zend_alter_ini_entry_chars_ex(zend_string *name, const char *value, size_t value_length, int modify_type, int stage, int force_change);
  69. ZEND_API zend_result zend_restore_ini_entry(zend_string *name, int stage);
  70. ZEND_API void display_ini_entries(zend_module_entry *module);
  71. ZEND_API zend_long zend_ini_long(const char *name, size_t name_length, int orig);
  72. ZEND_API double zend_ini_double(const char *name, size_t name_length, int orig);
  73. ZEND_API char *zend_ini_string(const char *name, size_t name_length, int orig);
  74. ZEND_API char *zend_ini_string_ex(const char *name, size_t name_length, int orig, bool *exists);
  75. ZEND_API zend_string *zend_ini_get_value(zend_string *name);
  76. ZEND_API bool zend_ini_parse_bool(zend_string *str);
  77. ZEND_API zend_result zend_ini_register_displayer(const char *name, uint32_t name_length, void (*displayer)(zend_ini_entry *ini_entry, int type));
  78. ZEND_API ZEND_INI_DISP(zend_ini_boolean_displayer_cb);
  79. ZEND_API ZEND_INI_DISP(zend_ini_color_displayer_cb);
  80. ZEND_API ZEND_INI_DISP(display_link_numbers);
  81. END_EXTERN_C()
  82. #define ZEND_INI_BEGIN() static const zend_ini_entry_def ini_entries[] = {
  83. #define ZEND_INI_END() { NULL, NULL, NULL, NULL, NULL, NULL, NULL, 0, 0, 0} };
  84. #define ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, arg1, arg2, arg3, displayer) \
  85. { name, on_modify, arg1, arg2, arg3, default_value, displayer, sizeof(default_value)-1, sizeof(name)-1, modifiable },
  86. #define ZEND_INI_ENTRY3(name, default_value, modifiable, on_modify, arg1, arg2, arg3) \
  87. ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, arg1, arg2, arg3, NULL)
  88. #define ZEND_INI_ENTRY2_EX(name, default_value, modifiable, on_modify, arg1, arg2, displayer) \
  89. ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, arg1, arg2, NULL, displayer)
  90. #define ZEND_INI_ENTRY2(name, default_value, modifiable, on_modify, arg1, arg2) \
  91. ZEND_INI_ENTRY2_EX(name, default_value, modifiable, on_modify, arg1, arg2, NULL)
  92. #define ZEND_INI_ENTRY1_EX(name, default_value, modifiable, on_modify, arg1, displayer) \
  93. ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, arg1, NULL, NULL, displayer)
  94. #define ZEND_INI_ENTRY1(name, default_value, modifiable, on_modify, arg1) \
  95. ZEND_INI_ENTRY1_EX(name, default_value, modifiable, on_modify, arg1, NULL)
  96. #define ZEND_INI_ENTRY_EX(name, default_value, modifiable, on_modify, displayer) \
  97. ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, NULL, NULL, NULL, displayer)
  98. #define ZEND_INI_ENTRY(name, default_value, modifiable, on_modify) \
  99. ZEND_INI_ENTRY_EX(name, default_value, modifiable, on_modify, NULL)
  100. #ifdef ZTS
  101. #define STD_ZEND_INI_ENTRY(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr) \
  102. ZEND_INI_ENTRY2(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr##_id)
  103. #define STD_ZEND_INI_ENTRY_EX(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr, displayer) \
  104. ZEND_INI_ENTRY2_EX(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr##_id, displayer)
  105. #define STD_ZEND_INI_BOOLEAN(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr) \
  106. ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr##_id, NULL, zend_ini_boolean_displayer_cb)
  107. #else
  108. #define STD_ZEND_INI_ENTRY(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr) \
  109. ZEND_INI_ENTRY2(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr)
  110. #define STD_ZEND_INI_ENTRY_EX(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr, displayer) \
  111. ZEND_INI_ENTRY2_EX(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr, displayer)
  112. #define STD_ZEND_INI_BOOLEAN(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr) \
  113. ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr, NULL, zend_ini_boolean_displayer_cb)
  114. #endif
  115. #define INI_INT(name) zend_ini_long((name), strlen(name), 0)
  116. #define INI_FLT(name) zend_ini_double((name), strlen(name), 0)
  117. #define INI_STR(name) zend_ini_string_ex((name), strlen(name), 0, NULL)
  118. #define INI_BOOL(name) ((bool) INI_INT(name))
  119. #define INI_ORIG_INT(name) zend_ini_long((name), strlen(name), 1)
  120. #define INI_ORIG_FLT(name) zend_ini_double((name), strlen(name), 1)
  121. #define INI_ORIG_STR(name) zend_ini_string((name), strlen(name), 1)
  122. #define INI_ORIG_BOOL(name) ((bool) INI_ORIG_INT(name))
  123. #define REGISTER_INI_ENTRIES() zend_register_ini_entries(ini_entries, module_number)
  124. #define UNREGISTER_INI_ENTRIES() zend_unregister_ini_entries(module_number)
  125. #define DISPLAY_INI_ENTRIES() display_ini_entries(zend_module)
  126. #define REGISTER_INI_DISPLAYER(name, displayer) zend_ini_register_displayer((name), strlen(name), displayer)
  127. #define REGISTER_INI_BOOLEAN(name) REGISTER_INI_DISPLAYER(name, zend_ini_boolean_displayer_cb)
  128. /* Standard message handlers */
  129. BEGIN_EXTERN_C()
  130. ZEND_API ZEND_INI_MH(OnUpdateBool);
  131. ZEND_API ZEND_INI_MH(OnUpdateLong);
  132. ZEND_API ZEND_INI_MH(OnUpdateLongGEZero);
  133. ZEND_API ZEND_INI_MH(OnUpdateReal);
  134. ZEND_API ZEND_INI_MH(OnUpdateString);
  135. ZEND_API ZEND_INI_MH(OnUpdateStringUnempty);
  136. END_EXTERN_C()
  137. #define ZEND_INI_DISPLAY_ORIG 1
  138. #define ZEND_INI_DISPLAY_ACTIVE 2
  139. #define ZEND_INI_STAGE_STARTUP (1<<0)
  140. #define ZEND_INI_STAGE_SHUTDOWN (1<<1)
  141. #define ZEND_INI_STAGE_ACTIVATE (1<<2)
  142. #define ZEND_INI_STAGE_DEACTIVATE (1<<3)
  143. #define ZEND_INI_STAGE_RUNTIME (1<<4)
  144. #define ZEND_INI_STAGE_HTACCESS (1<<5)
  145. #define ZEND_INI_STAGE_IN_REQUEST (ZEND_INI_STAGE_ACTIVATE|ZEND_INI_STAGE_DEACTIVATE|ZEND_INI_STAGE_RUNTIME|ZEND_INI_STAGE_HTACCESS)
  146. /* INI parsing engine */
  147. typedef void (*zend_ini_parser_cb_t)(zval *arg1, zval *arg2, zval *arg3, int callback_type, void *arg);
  148. BEGIN_EXTERN_C()
  149. ZEND_API int zend_parse_ini_file(zend_file_handle *fh, bool unbuffered_errors, int scanner_mode, zend_ini_parser_cb_t ini_parser_cb, void *arg);
  150. ZEND_API int zend_parse_ini_string(char *str, bool unbuffered_errors, int scanner_mode, zend_ini_parser_cb_t ini_parser_cb, void *arg);
  151. END_EXTERN_C()
  152. /* INI entries */
  153. #define ZEND_INI_PARSER_ENTRY 1 /* Normal entry: foo = bar */
  154. #define ZEND_INI_PARSER_SECTION 2 /* Section: [foobar] */
  155. #define ZEND_INI_PARSER_POP_ENTRY 3 /* Offset entry: foo[] = bar */
  156. typedef struct _zend_ini_parser_param {
  157. zend_ini_parser_cb_t ini_parser_cb;
  158. void *arg;
  159. } zend_ini_parser_param;
  160. #ifndef ZTS
  161. # define ZEND_INI_GET_BASE() ((char *) mh_arg2)
  162. #else
  163. # define ZEND_INI_GET_BASE() ((char *) ts_resource(*((int *) mh_arg2)))
  164. #endif
  165. #define ZEND_INI_GET_ADDR() (ZEND_INI_GET_BASE() + (size_t) mh_arg1)
  166. #endif /* ZEND_INI_H */