src/mod_cml.c

   1 #include "first.h"
   2
   3 #include "buffer.h"
   4 #include "server.h"
   5 #include "log.h"
   6 #include "plugin.h"
   7 #include "response.h"
   8
   9 #include "mod_cml.h"
  10
  11 #include <sys/stat.h>
  12 #include <time.h>
  13
  14 #include <stdlib.h>
  15 #include <string.h>
  16 #include <errno.h>
  17 #include <unistd.h>
  18 #include <stdio.h>
  19
  20 /* init the plugin data */
  21 INIT_FUNC(mod_cml_init) {
  22         plugin_data *p;
  23
  24         p = calloc(1, sizeof(*p));
  25
  26         p->basedir         = buffer_init();
  27         p->baseurl         = buffer_init();
  28         p->trigger_handler = buffer_init();
  29
  30         return p;
  31 }
  32
  33 /* detroy the plugin data */
  34 FREE_FUNC(mod_cml_free) {
  35         plugin_data *p = p_d;
  36
  37         UNUSED(srv);
  38
  39         if (!p) return HANDLER_GO_ON;
  40
  41         if (p->config_storage) {
  42                 size_t i;
  43                 for (i = 0; i < srv->config_context->used; i++) {
  44                         plugin_config *s = p->config_storage[i];
  45
  46                         if (NULL == s) continue;
  47
  48                         buffer_free(s->ext);
  49
  50                         buffer_free(s->mc_namespace);
  51                         buffer_free(s->power_magnet);
  52                         array_free(s->mc_hosts);
  53
  54 #if defined(USE_MEMCACHED)
  55                         if (s->memc) memcached_free(s->memc);
  56 #endif
  57
  58                         free(s);
  59                 }
  60                 free(p->config_storage);
  61         }
  62
  63         buffer_free(p->trigger_handler);
  64         buffer_free(p->basedir);
  65         buffer_free(p->baseurl);
  66
  67         free(p);
  68
  69         return HANDLER_GO_ON;
  70 }
  71
  72 /* handle plugin config and check values */
  73
  74 SETDEFAULTS_FUNC(mod_cml_set_defaults) {
  75         plugin_data *p = p_d;
  76         size_t i = 0;
  77
  78         config_values_t cv[] = {
  79                 { "cml.extension",              NULL, T_CONFIG_STRING, T_CONFIG_SCOPE_CONNECTION },       /* 0 */
  80                 { "cml.memcache-hosts",         NULL, T_CONFIG_ARRAY, T_CONFIG_SCOPE_CONNECTION },        /* 1 */
  81                 { "cml.memcache-namespace",     NULL, T_CONFIG_STRING, T_CONFIG_SCOPE_CONNECTION },       /* 2 */
  82                 { "cml.power-magnet",           NULL, T_CONFIG_STRING, T_CONFIG_SCOPE_CONNECTION },       /* 3 */
  83                 { NULL,                         NULL, T_CONFIG_UNSET, T_CONFIG_SCOPE_UNSET }
  84         };
  85
  86         if (!p) return HANDLER_ERROR;
  87
  88         p->config_storage = calloc(1, srv->config_context->used * sizeof(plugin_config *));
  89
  90         for (i = 0; i < srv->config_context->used; i++) {
  91                 data_config const* config = (data_config const*)srv->config_context->data[i];
  92                 plugin_config *s;
  93
  94                 s = malloc(sizeof(plugin_config));
  95                 s->ext    = buffer_init();
  96                 s->mc_hosts       = array_init();
  97                 s->mc_namespace   = buffer_init();
  98                 s->power_magnet   = buffer_init();
  99 #if defined(USE_MEMCACHED)
 100                 s->memc = NULL;
 101 #endif
 102
 103                 cv[0].destination = s->ext;
 104                 cv[1].destination = s->mc_hosts;
 105                 cv[2].destination = s->mc_namespace;
 106                 cv[3].destination = s->power_magnet;
 107
 108                 p->config_storage[i] = s;
 109
 110                 if (0 != config_insert_values_global(srv, config->value, cv, i == 0 ? T_CONFIG_SCOPE_SERVER : T_CONFIG_SCOPE_CONNECTION)) {
 111                         return HANDLER_ERROR;
 112                 }
 113
 114                 if (s->mc_hosts->used) {
 115 #if defined(USE_MEMCACHED)
 116                         buffer *option_string = buffer_init();
 117                         size_t k;
 118
 119                         {
 120                                 data_string *ds = (data_string *)s->mc_hosts->data[0];
 121
 122                                 buffer_append_string_len(option_string, CONST_STR_LEN("--SERVER="));
 123                                 buffer_append_string_buffer(option_string, ds->value);
 124                         }
 125
 126                         for (k = 1; k < s->mc_hosts->used; k++) {
 127                                 data_string *ds = (data_string *)s->mc_hosts->data[k];
 128
 129                                 buffer_append_string_len(option_string, CONST_STR_LEN(" --SERVER="));
 130                                 buffer_append_string_buffer(option_string, ds->value);
 131                         }
 132
 133                         s->memc = memcached(CONST_BUF_LEN(option_string));
 134
 135                         if (NULL == s->memc) {
 136                                 log_error_write(srv, __FILE__, __LINE__, "sb",
 137                                         "configuring memcached failed for option string:",
 138                                         option_string);
 139                         }
 140                         buffer_free(option_string);
 141
 142                         if (NULL == s->memc) return HANDLER_ERROR;
 143 #else
 144                         log_error_write(srv, __FILE__, __LINE__, "s",
 145                                 "memcache support is not compiled in but cml.memcache-hosts is set, aborting");
 146                         return HANDLER_ERROR;
 147 #endif
 148                 }
 149         }
 150
 151         return HANDLER_GO_ON;
 152 }
 153
 154 #define PATCH(x) \
 155         p->conf.x = s->x;
 156 static int mod_cml_patch_connection(server *srv, connection *con, plugin_data *p) {
 157         size_t i, j;
 158         plugin_config *s = p->config_storage[0];
 159
 160         PATCH(ext);
 161 #if defined(USE_MEMCACHED)
 162         PATCH(memc);
 163 #endif
 164         PATCH(mc_namespace);
 165         PATCH(power_magnet);
 166
 167         /* skip the first, the global context */
 168         for (i = 1; i < srv->config_context->used; i++) {
 169                 data_config *dc = (data_config *)srv->config_context->data[i];
 170                 s = p->config_storage[i];
 171
 172                 /* condition didn't match */
 173                 if (!config_check_cond(srv, con, dc)) continue;
 174
 175                 /* merge config */
 176                 for (j = 0; j < dc->value->used; j++) {
 177                         data_unset *du = dc->value->data[j];
 178
 179                         if (buffer_is_equal_string(du->key, CONST_STR_LEN("cml.extension"))) {
 180                                 PATCH(ext);
 181                         } else if (buffer_is_equal_string(du->key, CONST_STR_LEN("cml.memcache-hosts"))) {
 182 #if defined(USE_MEMCACHED)
 183                                 PATCH(memc);
 184 #endif
 185                         } else if (buffer_is_equal_string(du->key, CONST_STR_LEN("cml.memcache-namespace"))) {
 186                                 PATCH(mc_namespace);
 187                         } else if (buffer_is_equal_string(du->key, CONST_STR_LEN("cml.power-magnet"))) {
 188                                 PATCH(power_magnet);
 189                         }
 190                 }
 191         }
 192
 193         return 0;
 194 }
 195 #undef PATCH
 196
 197 static int cache_call_lua(server *srv, connection *con, plugin_data *p, buffer *cml_file) {
 198         buffer *b;
 199         char *c;
 200
 201         /* cleanup basedir */
 202         b = p->baseurl;
 203         buffer_copy_buffer(b, con->uri.path);
 204         for (c = b->ptr + buffer_string_length(b); c > b->ptr && *c != '/'; c--);
 205
 206         if (*c == '/') {
 207                 buffer_string_set_length(b, c - b->ptr + 1);
 208         }
 209
 210         b = p->basedir;
 211         buffer_copy_buffer(b, con->physical.path);
 212         for (c = b->ptr + buffer_string_length(b); c > b->ptr && *c != '/'; c--);
 213
 214         if (*c == '/') {
 215                 buffer_string_set_length(b, c - b->ptr + 1);
 216         }
 217
 218
 219         /* prepare variables
 220          *   - cookie-based
 221          *   - get-param-based
 222          */
 223         return cache_parse_lua(srv, con, p, cml_file);
 224 }
 225
 226 URIHANDLER_FUNC(mod_cml_power_magnet) {
 227         plugin_data *p = p_d;
 228
 229         mod_cml_patch_connection(srv, con, p);
 230
 231         buffer_reset(p->basedir);
 232         buffer_reset(p->baseurl);
 233         buffer_reset(p->trigger_handler);
 234
 235         if (buffer_string_is_empty(p->conf.power_magnet)) return HANDLER_GO_ON;
 236
 237         /*
 238          * power-magnet:
 239          * cml.power-magnet = server.docroot + "/rewrite.cml"
 240          *
 241          * is called on EACH request, take the original REQUEST_URI and modifies the
 242          * request header as neccesary.
 243          *
 244          * First use:
 245          * if file_exists("/maintainance.html") {
 246          *   output_include = ( "/maintainance.html" )
 247          *   return CACHE_HIT
 248          * }
 249          *
 250          * as we only want to rewrite HTML like requests we should cover it in a conditional
 251          *
 252          * */
 253
 254         switch(cache_call_lua(srv, con, p, p->conf.power_magnet)) {
 255         case -1:
 256                 /* error */
 257                 if (con->conf.log_request_handling) {
 258                         log_error_write(srv, __FILE__, __LINE__, "s", "cache-error");
 259                 }
 260                 con->http_status = 500;
 261                 return HANDLER_COMEBACK;
 262         case 0:
 263                 if (con->conf.log_request_handling) {
 264                         log_error_write(srv, __FILE__, __LINE__, "s", "cache-hit");
 265                 }
 266                 /* cache-hit */
 267                 buffer_reset(con->physical.path);
 268                 return HANDLER_FINISHED;
 269         case 1:
 270                 /* cache miss */
 271                 return HANDLER_GO_ON;
 272         default:
 273                 con->http_status = 500;
 274                 return HANDLER_COMEBACK;
 275         }
 276 }
 277
 278 URIHANDLER_FUNC(mod_cml_is_handled) {
 279         plugin_data *p = p_d;
 280
 281         if (buffer_string_is_empty(con->physical.path)) return HANDLER_ERROR;
 282
 283         mod_cml_patch_connection(srv, con, p);
 284
 285         buffer_reset(p->basedir);
 286         buffer_reset(p->baseurl);
 287         buffer_reset(p->trigger_handler);
 288
 289         if (buffer_string_is_empty(p->conf.ext)) return HANDLER_GO_ON;
 290
 291         if (!buffer_is_equal_right_len(con->physical.path, p->conf.ext, buffer_string_length(p->conf.ext))) {
 292                 return HANDLER_GO_ON;
 293         }
 294
 295         switch(cache_call_lua(srv, con, p, con->physical.path)) {
 296         case -1:
 297                 /* error */
 298                 if (con->conf.log_request_handling) {
 299                         log_error_write(srv, __FILE__, __LINE__, "s", "cache-error");
 300                 }
 301                 con->http_status = 500;
 302                 return HANDLER_COMEBACK;
 303         case 0:
 304                 if (con->conf.log_request_handling) {
 305                         log_error_write(srv, __FILE__, __LINE__, "s", "cache-hit");
 306                 }
 307                 /* cache-hit */
 308                 buffer_reset(con->physical.path);
 309                 return HANDLER_FINISHED;
 310         case 1:
 311                 if (con->conf.log_request_handling) {
 312                         log_error_write(srv, __FILE__, __LINE__, "s", "cache-miss");
 313                 }
 314                 /* cache miss */
 315                 return HANDLER_COMEBACK;
 316         default:
 317                 con->http_status = 500;
 318                 return HANDLER_COMEBACK;
 319         }
 320 }
 321
 322 int mod_cml_plugin_init(plugin *p);
 323 int mod_cml_plugin_init(plugin *p) {
 324         p->version     = LIGHTTPD_VERSION_ID;
 325         p->name        = buffer_init_string("cache");
 326
 327         p->init        = mod_cml_init;
 328         p->cleanup     = mod_cml_free;
 329         p->set_defaults  = mod_cml_set_defaults;
 330
 331         p->handle_subrequest_start = mod_cml_is_handled;
 332         p->handle_physical         = mod_cml_power_magnet;
 333
 334         p->data        = NULL;
 335
 336         return 0;
 337 }