diff options
Diffstat (limited to 'web/server/h2o/libh2o/include/h2o/configurator.h')
-rw-r--r-- | web/server/h2o/libh2o/include/h2o/configurator.h | 181 |
1 files changed, 181 insertions, 0 deletions
diff --git a/web/server/h2o/libh2o/include/h2o/configurator.h b/web/server/h2o/libh2o/include/h2o/configurator.h new file mode 100644 index 000000000..d1a2e2515 --- /dev/null +++ b/web/server/h2o/libh2o/include/h2o/configurator.h @@ -0,0 +1,181 @@ +/* + * Copyright (c) 2014 DeNA Co., Ltd. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ +#ifndef h2o__configurator_h +#define h2o__configurator_h + +#include "yoml.h" + +enum { + H2O_CONFIGURATOR_FLAG_GLOBAL = 0x1, + H2O_CONFIGURATOR_FLAG_HOST = 0x2, + H2O_CONFIGURATOR_FLAG_PATH = 0x4, + H2O_CONFIGURATOR_FLAG_EXTENSION = 0x8, + H2O_CONFIGURATOR_FLAG_ALL_LEVELS = + H2O_CONFIGURATOR_FLAG_GLOBAL | H2O_CONFIGURATOR_FLAG_HOST | H2O_CONFIGURATOR_FLAG_PATH | H2O_CONFIGURATOR_FLAG_EXTENSION, + H2O_CONFIGURATOR_FLAG_EXPECT_SCALAR = 0x100, + H2O_CONFIGURATOR_FLAG_EXPECT_SEQUENCE = 0x200, + H2O_CONFIGURATOR_FLAG_EXPECT_MAPPING = 0x400, + H2O_CONFIGURATOR_FLAG_DEFERRED = 0x1000, + H2O_CONFIGURATOR_FLAG_SEMI_DEFERRED = 0x2000 /* used by file.custom-handler (invoked before hosts,paths,file-dir, etc.) */ +}; + +#define H2O_CONFIGURATOR_NUM_LEVELS 4 + +typedef struct st_h2o_configurator_context_t { + /** + * pointer to globalconf + */ + h2o_globalconf_t *globalconf; + /** + * pointer to hostconf, or NULL if the context is above host level + */ + h2o_hostconf_t *hostconf; + /** + * pointer to pathconf (either at path level or custom handler level), or NULL + */ + h2o_pathconf_t *pathconf; + /** + * pointer to mimemap + */ + h2o_mimemap_t **mimemap; + /** + * pointer to env + */ + h2o_envconf_t *env; + /** + * if is a dry run + */ + int dry_run; + /** + * parent context (or NULL if the context is at global level) + */ + struct st_h2o_configurator_context_t *parent; +} h2o_configurator_context_t; + +typedef int (*h2o_configurator_dispose_cb)(h2o_configurator_t *configurator); +typedef int (*h2o_configurator_enter_cb)(h2o_configurator_t *configurator, h2o_configurator_context_t *ctx, yoml_t *node); +typedef int (*h2o_configurator_exit_cb)(h2o_configurator_t *configurator, h2o_configurator_context_t *ctx, yoml_t *node); +typedef int (*h2o_configurator_command_cb)(h2o_configurator_command_t *cmd, h2o_configurator_context_t *ctx, yoml_t *node); +typedef h2o_headers_command_t **(*h2o_configurator_get_headers_commands_cb)(h2o_configurator_t *conf); + +struct st_h2o_configurator_command_t { + /** + * configurator to which the command belongs + */ + h2o_configurator_t *configurator; + /** + * name of the command handled by the configurator + */ + const char *name; + /** + * flags + */ + int flags; + /** + * mandatory callback called to handle the command + */ + h2o_configurator_command_cb cb; +}; + +/** + * basic structure of a configurator (handles a configuration command) + */ +struct st_h2o_configurator_t { + h2o_linklist_t _link; + /** + * optional callback called when the global config is being disposed + */ + h2o_configurator_dispose_cb dispose; + /** + * optional callback called before the configuration commands are handled + */ + h2o_configurator_enter_cb enter; + /** + * optional callback called after all the configuration commands are handled + */ + h2o_configurator_exit_cb exit; + /** + * list of commands + */ + H2O_VECTOR(h2o_configurator_command_t) commands; +}; + +/** + * registers a configurator + */ +h2o_configurator_t *h2o_configurator_create(h2o_globalconf_t *conf, size_t sz); +/** + * + */ +void h2o_configurator_define_command(h2o_configurator_t *configurator, const char *name, int flags, h2o_configurator_command_cb cb); +/** + * returns a configurator of given command name + * @return configurator for given name or NULL if not found + */ +h2o_configurator_command_t *h2o_configurator_get_command(h2o_globalconf_t *conf, const char *name); +/** + * applies the configuration to the context + * @return 0 if successful, -1 if not + */ +int h2o_configurator_apply(h2o_globalconf_t *config, yoml_t *node, int dry_run); +/** + * + */ +int h2o_configurator_apply_commands(h2o_configurator_context_t *ctx, yoml_t *node, int flags_mask, const char **ignore_commands); +/** + * emits configuration error + */ +void h2o_configurator_errprintf(h2o_configurator_command_t *cmd, yoml_t *node, const char *reason, ...) + __attribute__((format(printf, 3, 4))); +/** + * interprets the configuration value using sscanf, or prints an error upon failure + * @param configurator configurator + * @param node configuration value + * @param fmt scanf-style format string + * @return 0 if successful, -1 if not + */ +int h2o_configurator_scanf(h2o_configurator_command_t *cmd, yoml_t *node, const char *fmt, ...) + __attribute__((format(scanf, 3, 4))); +/** + * interprets the configuration value and returns the index of the matched string within the candidate strings, or prints an error + * upon failure + * @param configurator configurator + * @param node configuration value + * @param candidates a comma-separated list of strings (should not contain whitespaces) + * @return index of the matched string within the given list, or -1 if none of them matched + */ +ssize_t h2o_configurator_get_one_of(h2o_configurator_command_t *cmd, yoml_t *node, const char *candidates); +/** + * returns the absolute paths of supplementary commands + */ +char *h2o_configurator_get_cmd_path(const char *cmd); + +/** + * lib/handler/configurator/headers_util.c + */ +void h2o_configurator_define_headers_commands(h2o_globalconf_t *global_conf, h2o_configurator_t *conf, const char *prefix, + h2o_configurator_get_headers_commands_cb get_commands); + +void h2o_configurator__init_core(h2o_globalconf_t *conf); +void h2o_configurator__dispose_configurators(h2o_globalconf_t *conf); + +#endif |