#include <ngx_core.h>
#include <ngx_http.h>
-// Module Config Definitions
+/*
+ * Declarations
+ */
+
+/* Main Configuration Structure */
typedef struct {
ngx_array_t *office_hours;
} ngx_http_office_hours_conf_t;
+/* Lifecycle Functions For Module Context */
+
static void *ngx_http_office_hours_create_conf(ngx_conf_t * cf);
-static char *ngx_http_office_hours_merge_conf(ngx_conf_t * cf, void *parent, void *child);
+static char *ngx_http_office_hours_merge_conf(ngx_conf_t * cf,
+ void *parent, void *child);
static ngx_int_t ngx_http_office_hours_init(ngx_conf_t * cf);
-static char *ngx_http_office_hours(ngx_conf_t * cf, ngx_command_t * cmd, void *conf);
+/* Configuration Handler */
+
+static char *ngx_http_office_hours(ngx_conf_t * cf, ngx_command_t * cmd,
+ void *conf);
+
+/* Body Filter Storage */
+
+static ngx_http_output_body_filter_pt ngx_http_next_body_filter;
+
+/*
+ * Module Definitions
+ */
-//Module Directive Definitions
+/* Module Directives */
static ngx_command_t ngx_http_office_hours_commands[] = {
{
- ngx_string("office_hours"),
- NGX_HTTP_SRV_CONF | NGX_HTTP_LOC_CONF | NGX_CONF_1MORE,
- ngx_http_office_hours,
- NGX_HTTP_LOC_CONF_OFFSET,
- offsetof(ngx_http_office_hours_conf_t, office_hours),
- NULL
+ ngx_string("office_hours"),
+ NGX_HTTP_SRV_CONF | NGX_HTTP_LOC_CONF | NGX_CONF_1MORE,
+ ngx_http_office_hours,
+ NGX_HTTP_LOC_CONF_OFFSET,
+ offsetof(ngx_http_office_hours_conf_t, office_hours),
+ NULL
},
ngx_null_command
};
-//Define the module context
+
+/* Module Context */
static ngx_http_module_t ngx_http_office_hours_filter_module_ctx = {
- NULL, //Preconfiguration
- ngx_http_office_hours_init, //Postconfiguration
+ NULL, /* Preconfiguration */
+ ngx_http_office_hours_init, /* Postconfiguration */
- NULL, //Create main configuration
- NULL, //Initialize main configuration
- NULL, //Create server configuration
- NULL, //Merge server configuration
+ NULL, /* Create main configuration */
+ NULL, /* Initialize main configuration */
- ngx_http_office_hours_create_conf, //Create location configuration
- ngx_http_office_hours_merge_conf // Merge location configuration
+ NULL, /* Create server configuration */
+ NULL, /* Merge server configuration */
+
+ ngx_http_office_hours_create_conf, /* Create location configuration */
+ ngx_http_office_hours_merge_conf /* Merge location configuration */
};
-//Define the module
+
+/* Module Definition */
ngx_module_t ngx_http_office_hours_filter_module = {
- NGX_MODULE_V1, //Module Version
- & ngx_http_office_hours_filter_module_ctx, //Module context
- ngx_http_office_hours_commands, //Module commands
- NGX_HTTP_MODULE, //Module Type
- NULL, //Initialize Master
- NULL, //Initialize Module
- NULL, //Initialize Process
- NULL, //Initialize Thread
- NULL, //Exit Thread
- NULL, //Exit Process
- NULL, //Exit Master
- NGX_MODULE_V1_PADDING
+ NGX_MODULE_V1, //Module Version
+ &ngx_http_office_hours_filter_module_ctx, //Module context
+ ngx_http_office_hours_commands, //Module commands
+ NGX_HTTP_MODULE, //Module Type
+ NULL, //Initialize Master
+ NULL, //Initialize Module
+ NULL, //Initialize Process
+ NULL, //Initialize Thread
+ NULL, //Exit Thread
+ NULL, //Exit Process
+ NULL, //Exit Master
+ NGX_MODULE_V1_PADDING
};
-//Main Body Filter
-
-static ngx_http_output_body_filter_pt ngx_http_next_body_filter;
+/*
+ * Main Body Filter
+ * If the current time is within office hours, it goes to the next
+ * handler. Otherwise it returns 403 and the office hour listing.
+ */
static ngx_int_t
- ngx_http_office_hours_body_filter(ngx_http_request_t * r, ngx_chain_t * in)
+ngx_http_office_hours_body_filter(ngx_http_request_t * r, ngx_chain_t * in)
{
ngx_http_office_hours_conf_t *conf;
ngx_uint_t i;
ngx_str_t *hours;
- conf = ngx_http_get_module_loc_conf(r, ngx_http_office_hours_filter_module);
+ conf =
+ ngx_http_get_module_loc_conf(r,
+ ngx_http_office_hours_filter_module);
if (conf->office_hours == NULL) {
-
- ngx_log_error(NGX_LOG_DEBUG, r->connection->log, 0, "Within office hours");
-
- return ngx_http_next_body_filter(r, in);
+ ngx_log_error(NGX_LOG_DEBUG, r->connection->log, 0,
+ "Within office hours");
+ return ngx_http_next_body_filter(r, in);
}
- ngx_log_error(NGX_LOG_DEBUG, r->connection->log, 0, "Outside office hours");
+
+ ngx_log_error(NGX_LOG_DEBUG, r->connection->log, 0,
+ "Outside office hours");
hours = conf->office_hours->elts;
for (i = 0; i < conf->office_hours->nelts; ++i) {
- ngx_log_error(NGX_LOG_DEBUG, r->connection->log, 0, (const char *)hours[i].data);
+ ngx_log_error(NGX_LOG_DEBUG, r->connection->log, 0,
+ (const char *) hours[i].data);
}
r->keepalive = 0;
return NGX_HTTP_FORBIDDEN;
}
-//Read Arguments from config file
+/*
+ * Callback for `office_hours ` directive
+ * Reads the configuration loaded from the config file(cf)
+ * And writes it to the right place in the module configuration(conf)
+ */
-static char *
- ngx_http_office_hours(ngx_conf_t * cf, ngx_command_t * cmd, void *conf)
+static char *ngx_http_office_hours(ngx_conf_t * cf, ngx_command_t * cmd,
+ void *conf)
{
char *conf_structure = conf;
ngx_str_t *value;
ngx_uint_t i;
- //Gets the array from the config structure using the defined
- // offset, and if the
- pointer is unset it creates a new one.
- //
- //(The first element is the directive itself, so we should be
- // offset by 1)
- office_hours = (ngx_array_t **) (conf_structure + cmd->offset);
+ /* Gets the array from the config structure using the defined
+ * offset, and if the pointer is unset it creates a new one.
+ * (The first element is the directive itself, so we should be
+ * offset by 1)
+ */
+ office_hours = (ngx_array_t **) (conf_structure + cmd->offset);
if (*office_hours == NGX_CONF_UNSET_PTR) {
- *office_hours = ngx_array_create(cf->pool, cf->args->nelts - 1,
- sizeof(ngx_str_t));
+ *office_hours = ngx_array_create(cf->pool, cf->args->nelts - 1,
+ sizeof(ngx_str_t));
- if (*office_hours == NULL) {
- return NGX_CONF_ERROR;
- }
+ if (*office_hours == NULL) {
+ return NGX_CONF_ERROR;
+ }
}
value = cf->args->elts;
for (i = 1; i < cf->args->nelts; ++i) {
-
- hours = ngx_array_push(*office_hours);
- if (hours == NULL) {
- return NGX_CONF_ERROR;
- }
- *hours = value[i];
+ hours = ngx_array_push(*office_hours);
+ if (hours == NULL) {
+ return NGX_CONF_ERROR;
+ }
+ *hours = value[i];
}
return NGX_CONF_OK;
}
-//Initialize the Configuration Object
+/*
+ * Config Creator
+ * Initializes the configuration structure
+ */
-static void *
- ngx_http_office_hours_create_conf(ngx_conf_t * cf)
+static void *ngx_http_office_hours_create_conf(ngx_conf_t * cf)
{
ngx_http_office_hours_conf_t *conf;
conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_office_hours_conf_t));
if (conf == NULL) {
- return NULL;
+ return NULL;
}
conf->office_hours = NGX_CONF_UNSET_PTR;
return conf;
}
-//Merge Config Values
+/*
+ * Merge Config Values
+ * Sets the defaults for the configuration and merges
+ * with other configurations
+ */
-static char *
- ngx_http_office_hours_merge_conf(ngx_conf_t * cf, void *parent, void *child)
+static char *ngx_http_office_hours_merge_conf(ngx_conf_t * cf,
+ void *parent, void *child)
{
ngx_http_office_hours_conf_t *prev = parent;
return NGX_CONF_OK;
}
-//Postconfig Initialization Handler
-// Sets the request filter at the top of the chain
+/*
+ * Postconfig Initialization Handler
+ * Sets the request filter at the top of the chain
+ */
-static ngx_int_t
- ngx_http_office_hours_init(ngx_conf_t * cf)
+static ngx_int_t ngx_http_office_hours_init(ngx_conf_t * cf)
{
ngx_http_next_body_filter = ngx_http_top_body_filter;
git.r.bdr.sh / rbdr / ngx_http_office_hours_filter_module / commitdiff