summaryrefslogtreecommitdiffstatsabout
path: root/src/mod_log_sql.c
diff options
context:
space:
mode:
authorEdward Rudd <urkle@outoforder.cc>2008-09-21 15:54:12 (GMT)
committer Edward Rudd <urkle@outoforder.cc>2008-09-21 15:54:12 (GMT)
commitba30ceeb705e9b4d40ce0d98f6a4e047d47ce919 (patch)
tree5768679317a303031c80be6cba683b6addeb07ac /src/mod_log_sql.c
parentd33662354f64354c601ae257bd5b1b043c484d97 (diff)
moved all modules source to src subdirectory.. Moved header files into include subdirectory
cleaned up makefiles.
Diffstat (limited to 'src/mod_log_sql.c')
-rw-r--r--src/mod_log_sql.c1578
1 files changed, 1578 insertions, 0 deletions
diff --git a/src/mod_log_sql.c b/src/mod_log_sql.c
new file mode 100644
index 0000000..d319e97
--- /dev/null
+++ b/src/mod_log_sql.c
@@ -0,0 +1,1578 @@
1/* $Id$ */
2
3#if defined(WITH_APACHE20)
4# include "apache20.h"
5#elif defined(WITH_APACHE13)
6# include "apache13.h"
7#else
8# error Unsupported Apache version
9#endif
10
11#ifdef HAVE_CONFIG_H
12/* Undefine these to prevent conflicts between Apache ap_config_auto.h and
13 * my config.h. Only really needed for Apache < 2.0.48, but it can't hurt.
14 */
15#undef PACKAGE_BUGREPORT
16#undef PACKAGE_NAME
17#undef PACKAGE_STRING
18#undef PACKAGE_TARNAME
19#undef PACKAGE_VERSION
20
21#include "config.h"
22#endif
23
24#if APR_HAVE_UNISTD_H
25#include <unistd.h>
26#endif
27#ifdef HAVE_LIMITS_H
28#include <limits.h>
29#endif
30
31#include "mod_log_sql.h"
32
33/* Configuratino Defaults */
34#define DEFAULT_TRANSFER_LOG_FMT "AbHhmRSsTUuv"
35#define DEFAULT_NOTES_TABLE_NAME "notes"
36#define DEFAULT_HIN_TABLE_NAME "headers_in"
37#define DEFAULT_HOUT_TABLE_NAME "headers_out"
38#define DEFAULT_COOKIE_TABLE_NAME "cookies"
39#define DEFAULT_PRESERVE_FILE "logs/mod_log_sql-preserve"
40
41/* -------------*
42 * DECLARATIONS *
43 * -------------*/
44
45/* Declare ourselves so the configuration routines can find and know us. */
46module AP_MODULE_DECLARE_DATA log_sql_module;
47
48/* The contents of these are known 'Apache wide' and are not variable
49 * on a per-virtual-server basis. Every virtual server 'knows' the
50 * same versions of these variables.
51 */
52
53typedef struct {
54 int massvirtual;
55 int createtables;
56 int forcepreserve;
57 int disablepreserve;
58 char *machid;
59 int announce;
60 logsql_dbconnection db;
61 logsql_dbdriver *driver;
62 /** Show config support */
63 char *showconfig;
64 apr_file_t *showconfig_fp;
65} global_config_t;
66
67static global_config_t global_config;
68
69/* structure to hold helper function info */
70typedef struct {
71 const char *alias; /* The function alias */
72 logsql_item_func *func; /* The extraction function pointer */
73 int want_orig_req; /* if it requires the original request prior to internal redirection */
74} logsql_function;
75
76/* list of logsql_functions's for log types */
77static apr_array_header_t *logsql_function_list;
78
79/* structure to hold sqlfield mappings */
80typedef struct {
81 const char *alias; /* long name for item */
82 const char *funcalias; /* The function alias */
83 logsql_function *func; /* its extraction function */
84 char *param; /* Parameter for function */
85 const char *sql_field_name; /* its column in SQL */
86 char string_contents; /* Whether this is a string field or not */
87 logsql_field_datatype datatype; /* the field data type */
88 apr_size_t size; /* The size of the data type */
89} logsql_field;
90
91/* list of logsql_item's for log types */
92static apr_array_header_t *logsql_field_list;
93
94/* But the contents of this structure will vary by virtual server.
95 * This permits each virtual server to vary its configuration slightly
96 * for per-server customization.
97 *
98 * Each child process has its own segregated copy of this structure.
99 */
100typedef struct {
101 apr_array_header_t *transfer_ignore_list;
102 apr_array_header_t *transfer_accept_list;
103 apr_array_header_t *remhost_ignore_list;
104 apr_array_header_t *notes_list;
105 apr_array_header_t *hout_list;
106 apr_array_header_t *hin_list;
107 apr_array_header_t *cookie_list;
108 const char *notes_table_name;
109 const char *hout_table_name;
110 const char *hin_table_name;
111 const char *cookie_table_name;
112 const char *transfer_table_name;
113 apr_array_header_t *transfer_log_format;
114 apr_pool_t *parsed_pool;
115 logsql_field **parsed_log_format;
116 const char *preserve_file;
117 const char *cookie_name;
118} logsql_state;
119
120/** Registration function for extract functions
121 *
122 * This functions registers an alias for a function
123 *
124 * @note This is exported from the module
125 */
126LOGSQL_DECLARE(void) log_sql_register_function(apr_pool_t *p,
127 const char *alias, logsql_item_func *func,
128 logsql_function_req want_orig_req)
129{
130 logsql_function *item;
131 if (!logsql_function_list)
132 logsql_function_list = apr_array_make(p,10, sizeof(logsql_function));
133
134 item = apr_array_push(logsql_function_list);
135 item->alias = alias;
136 item->func = func;
137 item->want_orig_req = want_orig_req;
138 if (global_config.showconfig_fp) {
139 apr_file_printf(global_config.showconfig_fp," Function : %s\n",alias);
140 }
141}
142/** Register a old style sql mapping to the new style
143 *
144 * @note This is exported from the module
145 */
146LOGSQL_DECLARE(void) log_sql_register_alias(server_rec *s, apr_pool_t *p,
147 char key, const char *alias)
148{
149 server_rec *ts;
150 for (ts = s; ts; ts = ts->next) {
151 logsql_state *cfg = ap_get_module_config(ts->module_config,
152 &log_sql_module);
153 int itr;
154 for (itr = 0; itr < cfg->transfer_log_format->nelts; itr++) {
155 const char *logformat = ((const char **)cfg->transfer_log_format->elts)[itr];
156 //log_error(APLOG_MARK, APLOG_DEBUG, 0, s, "Testing Logformat %s against %c for %s",logformat,key,alias);
157 // Check if it is only one character AND it is our key
158 if (logformat[1]=='\0' && logformat[0]==key) {
159 ((const char **)cfg->transfer_log_format->elts)[itr] = alias;
160 }
161 }
162 }
163}
164
165
166/** Registration sqlfield aliases to functions
167 *
168 * And update parse cache for transfer_log_format
169 *
170 * @note This is exported from the module
171 */
172LOGSQL_DECLARE(void) log_sql_register_field(apr_pool_t *p,
173 const char *alias,
174 const char *funcalias, const char *param,
175 const char *sql_field_name,
176 logsql_field_datatype datatype, apr_size_t size)
177{
178 logsql_field *item;
179
180 if (!logsql_field_list)
181 logsql_field_list = apr_array_make(p,10, sizeof(logsql_field));
182
183 item = apr_array_push(logsql_field_list);
184 item->func = NULL;
185 item->alias = apr_pstrdup(p, alias);
186 item->funcalias = apr_pstrdup(p, funcalias);
187 item->param = apr_pstrdup(p, param);
188 item->sql_field_name = apr_pstrdup(p,sql_field_name);
189 item->datatype = datatype;
190 item->string_contents = 0;
191 if (datatype == LOGSQL_DATATYPE_CHAR || datatype == LOGSQL_DATATYPE_VARCHAR) {
192 item->string_contents = 1;
193 }
194 item->size = size;
195}
196
197/**
198 * Links sql field items with their functions
199 */
200LOGSQL_DECLARE(void) log_sql_register_finish(server_rec *s)
201{
202 server_rec *ts;
203 int itr, f;
204 logsql_field *item;
205 logsql_function *func;
206 for (itr = 0; itr < logsql_field_list->nelts; itr++) {
207 item = &((logsql_field *)logsql_field_list->elts)[itr];
208 if (item->func) continue;
209 /* Find function alias in function list */
210 for (f = 0; f < logsql_function_list->nelts; f++) {
211 func = &((logsql_function *)logsql_function_list->elts)[f];
212 if (strcmp(func->alias,item->funcalias)==0) {
213 item->func = func;
214 if (global_config.showconfig_fp) {
215 apr_file_printf(global_config.showconfig_fp," Item : %s using function %s(%s)\n"
216 "\tStoring in field %s of type %s(%"APR_SIZE_T_FMT")\n",
217 item->alias, item->funcalias, item->param,
218 item->sql_field_name, item->string_contents ? "TEXT":"NUMERIC", item->size);
219 }
220 break;
221 }
222 }
223 if (!item->func) {
224 log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
225 "Could not find function %s for item %s",item->funcalias, item->alias);
226 }
227 }
228 /* some voodoo here to post parse logitems in all servers *
229 * so a "cached" list is used in the main logging loop for speed */
230 for (ts = s; ts; ts = ts->next) {
231 logsql_state *cfg = ap_get_module_config(ts->module_config,
232 &log_sql_module);
233
234 if (!cfg->parsed_log_format) {
235 cfg->parsed_log_format = apr_pcalloc(cfg->parsed_pool,
236 cfg->transfer_log_format->nelts * sizeof(logsql_field *));
237 }
238
239 for (itr = 0; itr < cfg->transfer_log_format->nelts; itr++) {
240 const char *logformat = ((char **)cfg->transfer_log_format->elts)[itr];
241 for (f = 0; f < logsql_field_list->nelts; f++) {
242 item = &((logsql_field *)logsql_field_list->elts)[f];
243 if (item->func && strcmp(logformat,item->alias)==0) {
244 cfg->parsed_log_format[itr] = item;
245 break;
246 }
247 }
248 }
249 }
250}
251
252/* Registration function for database drivers */
253LOGSQL_DECLARE(void) log_sql_register_driver(apr_pool_t *p,
254 logsql_dbdriver *driver)
255{
256 global_config.driver = driver;
257}
258
259/* Include all the core extract functions */
260#include "functions.h"
261#if defined(WITH_APACHE13)
262# include "functions13.h"
263#elif defined(WITH_APACHE20)
264# include "functions20.h"
265#endif
266
267static logsql_opendb_ret log_sql_opendb_link(server_rec* s)
268{
269 logsql_opendb_ret result;
270 if (global_config.driver == NULL) {
271 return LOGSQL_OPENDB_FAIL;
272 }
273 if (global_config.forcepreserve) {
274 /*global_config.db.connected = 1;*/
275 return LOGSQL_OPENDB_PRESERVE;
276 }
277 if (global_config.db.connected) {
278 return LOGSQL_OPENDB_ALREADY;
279 }
280 /* database
281 host
282 user
283 passwd
284 */
285 if (global_config.db.parms) {
286 result = global_config.driver->connect(s, &global_config.db);
287 if (result==LOGSQL_OPENDB_FAIL) {
288 global_config.db.connected = 0;
289 } else {
290 global_config.db.connected = 1;
291 }
292 return result;
293 } else {
294 log_error(APLOG_MARK, APLOG_ERR, 0, s,
295 "mod_log_sql: insufficient configuration info to establish database link");
296 return LOGSQL_OPENDB_FAIL;
297 }
298}
299
300static void preserve_entry(request_rec *r, const char *query)
301{
302 logsql_state *cls = ap_get_module_config(r->server->module_config,
303 &log_sql_module);
304 apr_status_t result;
305 apr_file_t *fp;
306
307 /* If preserve file is disabled bail out */
308 if (global_config.disablepreserve)
309 return;
310 #if defined(WITH_APACHE20)
311 result = apr_file_open(&fp, cls->preserve_file,APR_APPEND | APR_WRITE | APR_CREATE, APR_OS_DEFAULT, r->pool);
312 #elif defined(WITH_APACHE13)
313 fp = ap_pfopen(r->pool, cls->preserve_file, "a");
314 result = (fp)?0:errno;
315 #endif
316 if (result != APR_SUCCESS) {
317 log_error(APLOG_MARK, APLOG_ERR, result, r->server,
318 "attempted append of local preserve file '%s' but failed.",cls->preserve_file);
319 } else {
320 apr_file_printf(fp,"%s;\n", query);
321 #if defined(WITH_APACHE20)
322 apr_file_close(fp);
323 #elif defined(WITH_APACHE13)
324 ap_pfclose(r->pool, fp);
325 #endif
326 log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
327 "mod_log_sql: entry preserved in %s", cls->preserve_file);
328 }
329}
330
331
332/* ------------------------------------------------*
333 * Command handlers that are called according *
334 * to the directives found at Apache runtime. *
335 * ------------------------------------------------*/
336
337
338static const char *set_global_flag_slot(cmd_parms *cmd,
339 void *struct_ptr,
340 int flag)
341{
342 void *ptr = &global_config;
343 int offset = (int)(long)cmd->info;
344
345 *(int *)((char *)ptr + offset) = flag ? 1 : 0;
346
347 return NULL;
348}
349
350static const char *set_global_nmv_flag_slot(cmd_parms *cmd,
351 void *struct_ptr,
352 int flag)
353{
354 if (global_config.massvirtual) {
355 return apr_psprintf(cmd->pool,
356 "mod_log_sql: do not set %s when LogSQLMassVirtualHosting(%d) is On.%d:%d",
357 cmd->cmd->name, global_config.massvirtual,
358 (int)(long)&global_config, (int)(long)struct_ptr);
359 } else {
360 return set_global_flag_slot(cmd,struct_ptr,flag);
361 }
362}
363
364static const char *set_global_string_slot(cmd_parms *cmd,
365 void *struct_ptr,
366 const char *arg)
367{
368 void *ptr = &global_config;
369 int offset = (int)(long)cmd->info;
370
371 *(const char **)((char *)ptr + offset) = apr_pstrdup(cmd->pool,arg);
372 return NULL;
373}
374
375static const char *set_server_string_slot(cmd_parms *cmd,
376 void *struct_ptr,
377 const char *arg)
378{
379 void *ptr = ap_get_module_config(cmd->server->module_config,
380 &log_sql_module);
381 int offset = (int)(long)cmd->info;
382
383 *(const char **)((char *)ptr + offset) = arg;
384
385 return NULL;
386}
387
388static const char *set_server_file_slot(cmd_parms *cmd,
389 void *struct_ptr,
390 const char *arg)
391{
392 void *ptr = ap_get_module_config(cmd->server->module_config,
393 &log_sql_module);
394 int offset = (int)(long)cmd->info;
395 const char *path;
396
397 path = ap_server_root_relative(cmd->pool, (char *)arg);
398
399 if (!path) {
400 return apr_pstrcat(cmd->pool, "Invalid file path ",
401 arg, NULL);
402 }
403
404 *(const char **)((char*)ptr + offset) = path;
405
406 return NULL;
407}
408
409static apr_array_header_t *create_logformat_default(apr_pool_t *p)
410{
411 apr_array_header_t *logformat;
412 char **addme;
413
414 logformat = apr_array_make(p, 12, sizeof(char *));
415 addme = apr_array_push(logformat); *addme = "useragent";
416 addme = apr_array_push(logformat); *addme = "bytes_sent";
417 addme = apr_array_push(logformat); *addme = "request_protocol";
418 addme = apr_array_push(logformat); *addme = "remote_host";
419 addme = apr_array_push(logformat); *addme = "request_method";
420 addme = apr_array_push(logformat); *addme = "referer";
421 addme = apr_array_push(logformat); *addme = "timestamp";
422 addme = apr_array_push(logformat); *addme = "status";
423 addme = apr_array_push(logformat); *addme = "request_duration";
424 addme = apr_array_push(logformat); *addme = "request_uri";
425 addme = apr_array_push(logformat); *addme = "remote_user";
426 addme = apr_array_push(logformat); *addme = "virtual_host";
427 return logformat;
428}
429
430static const char *set_server_nmv_string_slot(cmd_parms *parms,
431 void *struct_ptr,
432 const char *arg)
433{
434 if (global_config.massvirtual)
435 return apr_psprintf(parms->pool,
436 "mod_log_sql: do not set %s when LogSQLMassVirtualHosting is On.",
437 parms->cmd->name);
438 else
439 return set_server_string_slot(parms,struct_ptr,arg);
440}
441
442/* Set a DB connection parameter */
443static const char *set_dbparam(cmd_parms *cmd,
444 void *struct_ptr,
445 const char *key,
446 const char *val)
447{
448 if (!global_config.db.parms) {
449 global_config.db.parms = apr_table_make(cmd->pool,5);
450 }
451 apr_table_set(global_config.db.parms,key,val);
452 return NULL;
453}
454
455static const char *set_dbparam_slot(cmd_parms *cmd,
456 void *struct_ptr,
457 const char *arg)
458{
459 const char *param = (char *)cmd->info;
460 set_dbparam(cmd,NULL,param,arg);
461 return NULL;
462}
463
464/* Sets basic connection info */
465static const char *set_log_sql_info(cmd_parms *cmd, void *dummy,
466 const char *host, const char *user, const char *pwd)
467{
468 if (!user) { /* user is null, so only one arg passed */
469 /* TODO: to more error checking/force all params to be set */
470 apr_uri_t uri;
471 apr_uri_parse(cmd->pool, host, &uri);
472 if (uri.scheme) {
473 set_dbparam(cmd, NULL, "driver", uri.scheme);
474 }
475 if (uri.hostname) {
476 set_dbparam(cmd, NULL, "hostname", uri.hostname);
477 }
478 if (uri.user) {
479 set_dbparam(cmd, NULL, "username", uri.user);
480 }
481 if (uri.password) {
482 set_dbparam(cmd, NULL, "password", uri.password);
483 }
484 if (uri.port_str) {
485 set_dbparam(cmd, NULL, "port", uri.port_str);
486 }
487 if (uri.path) {
488 /* extract Database name */
489 char *off = ap_strchr(++uri.path,'/');
490 if (off)
491 *off='\0';
492 set_dbparam(cmd, NULL, "database", uri.path);
493
494 }
495 } else {
496 if (*host != '.') {
497 set_dbparam(cmd, NULL, "hostname", host);
498 }
499 if (*user != '.') {
500 set_dbparam(cmd, NULL, "username", user);
501 }
502 if (*pwd != '.') {
503 set_dbparam(cmd, NULL, "password", pwd);
504 }
505 }
506 return NULL;
507}
508
509static const char *add_server_string_slot(cmd_parms *cmd,
510 void *struct_ptr,
511 const char *arg)
512{
513 char **addme;
514 void *ptr = ap_get_module_config(cmd->server->module_config,
515 &log_sql_module);
516 int offset = (int)(long)cmd->info;
517 apr_array_header_t *ary = *(apr_array_header_t **)((char *)ptr + offset);
518 addme = apr_array_push(ary);
519 *addme = apr_pstrdup(ary->pool, arg);
520
521 return NULL;
522}
523
524static const char *set_logformat_slot(cmd_parms *cmd,
525 void *struct_ptr,
526 const char *arg)
527{
528 const char *t;
529 char t2[2] = {'\0','\0'};
530 for (t = arg; *t != '\0'; t++) {
531 t2[0] = *t;
532 add_server_string_slot(cmd, NULL, t2);
533 }
534 return NULL;
535}
536
537static const char *set_register_field(cmd_parms *cmd,
538 void *struct_ptr,
539 const char *arg)
540{
541 char *alias, *funcalias, *param, *field, *datatype_s, *size_s;
542 logsql_field_datatype datatype;
543 apr_size_t size;
544
545 alias = ap_getword_white(cmd->pool, &arg);
546 funcalias = ap_getword_white(cmd->pool, &arg);
547 param = ap_getword_conf(cmd->pool, &arg);
548 field = ap_getword_white(cmd->pool, &arg);
549 datatype_s = ap_getword_white(cmd->pool, &arg);
550 size_s = ap_getword_white(cmd->pool, &arg);
551
552 if (strcasecmp("VARCHAR",datatype_s)==0) {
553 datatype = LOGSQL_DATATYPE_VARCHAR;
554 } else if (strcasecmp("INT",datatype_s)==0) {
555 datatype = LOGSQL_DATATYPE_INT;
556 } else if (strcasecmp("CHAR",datatype_s)==0) {
557 datatype = LOGSQL_DATATYPE_CHAR;
558 } else if (strcasecmp("SMALLINT",datatype_s)==0) {
559 datatype = LOGSQL_DATATYPE_SMALLINT;
560 } else if (strcasecmp("BIGINT",datatype_s)==0) {
561 datatype = LOGSQL_DATATYPE_BIGINT;
562 } else {
563 return apr_psprintf(cmd->pool, "Unknown data type %s",datatype_s);
564 }
565
566 size = atoi(size_s);
567
568 log_error(APLOG_MARK, APLOG_DEBUG, 0, cmd->server,
569 "%s, %s, %s, %s, %s(%d), %s(%"APR_SIZE_T_FMT")",
570 alias, funcalias, param, field, datatype_s, datatype, size_s, size);
571
572 log_sql_register_field(cmd->pool, alias, funcalias, param,
573 field, datatype, size);
574
575 return NULL;
576}
577
578/*------------------------------------------------------------*
579 * Apache-specific hooks into the module code *
580 * that are defined in the array 'mysql_lgog_module' (at EOF) *
581 *------------------------------------------------------------*/
582/* Closing mysql link: child_exit(1.3), pool registration(2.0) */
583#if defined(WITH_APACHE20)
584static apr_status_t log_sql_close_link(void *data)
585{
586 if (global_config.driver)
587 global_config.driver->disconnect(&global_config.db);
588 return APR_SUCCESS;
589}
590#elif defined(WITH_APACHE13)
591static void log_sql_child_exit(server_rec *s, apr_pool_t *p)
592{
593 if (global_config.driver)
594 global_config.driver->disconnect(&global_config.db);
595}
596#endif
597
598/* Child Init */
599#if defined(WITH_APACHE20)
600static void log_sql_child_init(apr_pool_t *p, server_rec *s)
601#elif defined(WITH_APACHE13)
602static void log_sql_child_init(server_rec *s, apr_pool_t *p)
603#endif
604{
605 logsql_opendb_ret retval;
606# if defined(WITH_APACHE20)
607 /* Register cleanup hook to close DDB connection (apache 2 doesn't have child_exit) */
608 apr_pool_cleanup_register(p, NULL, log_sql_close_link, log_sql_close_link);
609# endif
610 /* Open a link to the database */
611 retval = log_sql_opendb_link(s);
612 switch (retval) {
613 case LOGSQL_OPENDB_FAIL:
614 if (global_config.driver==NULL) {
615 log_error(APLOG_MARK, APLOG_ERR, 0, s,
616 "mod_log_sql: Driver module not loaded");
617 } else {
618 log_error(APLOG_MARK, APLOG_ERR, 0, s,
619 "mod_log_sql: child spawned but unable to open database link");
620 }
621 break;
622 case LOGSQL_OPENDB_SUCCESS:
623 case LOGSQL_OPENDB_ALREADY:
624 log_error(APLOG_MARK,APLOG_DEBUG,0, s,
625 "mod_log_sql: open_logdb_link successful");
626 break;
627 case LOGSQL_OPENDB_PRESERVE:
628 log_error(APLOG_MARK,APLOG_DEBUG, 0, s,
629 "mod_log_sql: open_logdb_link said that preservation is forced");
630 break;
631 }
632}
633
634static apr_array_header_t *do_merge_array(apr_array_header_t *parent, apr_array_header_t *child, apr_pool_t *p);
635
636/* post_config / module_init */
637#if defined(WITH_APACHE20)
638static int log_sql_post_config(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
639#elif defined(WITH_APACHE13)
640static void log_sql_module_init(server_rec *s, apr_pool_t *p)
641#endif
642{
643 server_rec *cur_s;
644 const char *default_p = ap_server_root_relative(p, DEFAULT_PRESERVE_FILE);
645 apr_array_header_t *parent = NULL;
646
647 if (global_config.showconfig != NULL) {
648 const char *tempfile = ap_server_root_relative(p, global_config.showconfig);
649 apr_status_t result;
650 #if defined(WITH_APACHE20)
651 result = apr_file_open(&global_config.showconfig_fp, tempfile,APR_TRUNCATE | APR_WRITE | APR_CREATE, APR_OS_DEFAULT, p);
652 #elif defined(WITH_APACHE13)
653 global_config.showconfig_fp = ap_pfopen(p, tempfile, "w");
654 result = (fp)?0:errno;
655 #endif
656 if (result != APR_SUCCESS) {
657 log_error(APLOG_MARK, APLOG_ERR, result, s,
658 "attempted open of showconfig file '%s' failed.",tempfile);
659 global_config.showconfig_fp = NULL;
660 } else {
661 #if defined(WITH_APACHE20)
662 char temp_time[APR_RFC822_DATE_LEN];
663 apr_rfc822_date(temp_time,apr_time_now());
664 #elif defined(WITH_APACHE13)
665 char *temp_time = ap_get_time());
666 #endif
667 apr_file_printf(global_config.showconfig_fp,"Mod_log_sql Config dump created on %s\n", temp_time);
668 }
669 }
670
671 for (cur_s = s; cur_s != NULL; cur_s= cur_s->next) {
672 logsql_state *cls = ap_get_module_config(cur_s->module_config,
673 &log_sql_module);
674 /* ap_server_root_relative any default preserve file locations */
675 if (cls->preserve_file == DEFAULT_PRESERVE_FILE)
676 cls->preserve_file = default_p;
677
678 /* Post-process logformats */
679 if (!cur_s->is_virtual) {
680 parent = create_logformat_default(p);
681 cls->transfer_log_format = do_merge_array(parent, cls->transfer_log_format, p);
682 parent = cls->transfer_log_format;
683 } else {
684 cls->transfer_log_format = do_merge_array(parent, cls->transfer_log_format, p);
685 }
686 }
687
688 /* TODO: Add local_address, remote_address, connection_status */
689 /** Register functions */
690 /** register_function(p, funcname, func_ptr, which request_rec); */
691 log_sql_register_function(p, "useragent", extract_agent, LOGSQL_FUNCTION_REQ_ORIG);
692 log_sql_register_function(p, "request_args", extract_request_query, LOGSQL_FUNCTION_REQ_ORIG);
693 log_sql_register_function(p, "bytes_sent", extract_bytes_sent, LOGSQL_FUNCTION_REQ_FINAL);
694 log_sql_register_function(p, "cookie", extract_specific_cookie,LOGSQL_FUNCTION_REQ_FINAL);
695 log_sql_register_function(p, "request_file", extract_request_file, LOGSQL_FUNCTION_REQ_FINAL);
696 log_sql_register_function(p, "request_protocol",extract_request_protocol,LOGSQL_FUNCTION_REQ_FINAL);
697 log_sql_register_function(p, "remote_host", extract_remote_host, LOGSQL_FUNCTION_REQ_FINAL);
698 log_sql_register_function(p, "unique_id", extract_unique_id, LOGSQL_FUNCTION_REQ_FINAL);
699 log_sql_register_function(p, "remote_logname", extract_remote_logname, LOGSQL_FUNCTION_REQ_FINAL);
700 log_sql_register_function(p, "request_method", extract_request_method, LOGSQL_FUNCTION_REQ_FINAL);
701 log_sql_register_function(p, "machine_id", extract_machine_id, LOGSQL_FUNCTION_REQ_FINAL);
702 log_sql_register_function(p, "child_pid", extract_child_pid, LOGSQL_FUNCTION_REQ_FINAL);
703 log_sql_register_function(p, "server_port", extract_server_port, LOGSQL_FUNCTION_REQ_FINAL);
704 log_sql_register_function(p, "referrer", extract_referer, LOGSQL_FUNCTION_REQ_ORIG);
705 log_sql_register_function(p, "request_line", extract_request_line, LOGSQL_FUNCTION_REQ_ORIG);
706 log_sql_register_function(p, "timestamp", extract_request_timestamp,LOGSQL_FUNCTION_REQ_FINAL);
707 log_sql_register_function(p, "status", extract_status, LOGSQL_FUNCTION_REQ_ORIG);
708 log_sql_register_function(p, "request_duration",extract_request_duration,LOGSQL_FUNCTION_REQ_ORIG);
709 log_sql_register_function(p, "request_time", extract_request_time, LOGSQL_FUNCTION_REQ_FINAL);
710 log_sql_register_function(p, "remote_user", extract_remote_user, LOGSQL_FUNCTION_REQ_FINAL);
711 log_sql_register_function(p, "request_uri", extract_request_uri, LOGSQL_FUNCTION_REQ_ORIG);
712 log_sql_register_function(p, "virtual_host", extract_virtual_host, LOGSQL_FUNCTION_REQ_FINAL);
713 log_sql_register_function(p, "server_name", extract_server_name, LOGSQL_FUNCTION_REQ_FINAL);
714
715 /** Old style aliases */
716 /** register_alias(s, shortname, longname) */
717 log_sql_register_alias(s,p,'A',"useragent");
718 log_sql_register_alias(s,p,'a',"request_args");
719 log_sql_register_alias(s,p,'b',"bytes_sent");
720 log_sql_register_alias(s,p,'c',"cookie");
721 log_sql_register_alias(s,p,'f',"request_file");
722 log_sql_register_alias(s,p,'H',"request_protocol");
723 log_sql_register_alias(s,p,'h',"remote_host");
724 log_sql_register_alias(s,p,'I',"unique_id");
725 log_sql_register_alias(s,p,'l',"remote_logname");
726 log_sql_register_alias(s,p,'m',"request_method");
727 log_sql_register_alias(s,p,'M',"machine_id");
728 log_sql_register_alias(s,p,'P',"child_pid");
729 log_sql_register_alias(s,p,'p',"server_port");
730 log_sql_register_alias(s,p,'R',"referrer");
731 log_sql_register_alias(s,p,'r',"request_line");
732 log_sql_register_alias(s,p,'S',"timestamp");
733 log_sql_register_alias(s,p,'s',"status");
734 log_sql_register_alias(s,p,'T',"request_duration");
735 log_sql_register_alias(s,p,'t',"request_time");
736 log_sql_register_alias(s,p,'u',"remote_user");
737 log_sql_register_alias(s,p,'U',"request_uri");
738 log_sql_register_alias(s,p,'v',"virtual_host");
739 log_sql_register_alias(s,p,'V',"server_name");
740
741 /* Register handlers */
742 /** register_field(s,p, longname, funcalias, arg,
743 * sqlfieldname, DATATYPE, DATA LENGTH); */
744 log_sql_register_field(p,"useragent", "useragent",NULL,
745 "agent", LOGSQL_DATATYPE_VARCHAR, 0);
746 log_sql_register_field(p,"request_args", "request_args",NULL,
747 "request_args",LOGSQL_DATATYPE_VARCHAR,0);
748 log_sql_register_field(p,"bytes_sent", "bytes_sent",NULL,
749 "bytes_sent",LOGSQL_DATATYPE_INT,0);
750 log_sql_register_field(p,"cookie", "cookie","Apache",
751 "cookie",LOGSQL_DATATYPE_VARCHAR,0);
752 log_sql_register_field(p,"request_file", "request_file",NULL,
753 "request_file",LOGSQL_DATATYPE_VARCHAR,0);
754 log_sql_register_field(p,"request_protocol", "request_protocol",NULL,
755 "request_protocol",LOGSQL_DATATYPE_VARCHAR,0);
756 log_sql_register_field(p,"remote_host", "remote_host",NULL,
757 "remote_host",LOGSQL_DATATYPE_VARCHAR,0);
758 log_sql_register_field(p,"unique_id", "unique_id",NULL,
759 "id",LOGSQL_DATATYPE_VARCHAR,0);
760 log_sql_register_field(p,"remote_logname", "remote_logname",NULL,
761 "remote_logname",LOGSQL_DATATYPE_VARCHAR,0);
762 log_sql_register_field(p,"request_method", "request_method",NULL,
763 "request_method",LOGSQL_DATATYPE_VARCHAR,0);
764 log_sql_register_field(p,"machine_id", "machine_id",NULL,
765 "machine_id",LOGSQL_DATATYPE_VARCHAR,0);
766 log_sql_register_field(p,"child_pid", "child_pid",NULL,
767 "child_pid",LOGSQL_DATATYPE_INT,0);
768 log_sql_register_field(p,"server_port", "server_port",NULL,
769 "server_port",LOGSQL_DATATYPE_INT,0);
770 log_sql_register_field(p,"referer", "referrer",NULL,
771 "referer",LOGSQL_DATATYPE_VARCHAR,0);
772 log_sql_register_field(p,"referrer", "referrer",NULL,
773 "referer",LOGSQL_DATATYPE_VARCHAR,0);
774 log_sql_register_field(p,"request_line", "request_line",NULL,
775 "request_line",LOGSQL_DATATYPE_VARCHAR,0);
776 log_sql_register_field(p,"timestamp", "timestamp",NULL,
777 "time_stamp",LOGSQL_DATATYPE_INT,0);
778 log_sql_register_field(p,"status", "status",NULL,
779 "status",LOGSQL_DATATYPE_INT,0);
780 log_sql_register_field(p,"request_duration", "request_duration",NULL,
781 "request_duration",LOGSQL_DATATYPE_INT,0);
782 log_sql_register_field(p,"request_time", "request_time",NULL,
783 "request_time",LOGSQL_DATATYPE_VARCHAR,0);
784 log_sql_register_field(p,"remote_user", "remote_user",NULL,
785 "remote_user",LOGSQL_DATATYPE_VARCHAR,0);
786 log_sql_register_field(p,"request_uri", "request_uri",NULL,
787 "request_uri",LOGSQL_DATATYPE_VARCHAR,0);
788 log_sql_register_field(p,"virtual_host", "virtual_host",NULL,
789 "virtual_host",LOGSQL_DATATYPE_VARCHAR,0);
790 log_sql_register_field(p,"server_name", "server_name",NULL,
791 "virtual_host",LOGSQL_DATATYPE_VARCHAR,0);
792
793 log_sql_register_finish(s);
794
795 if (global_config.announce) {
796 ap_add_version_component(p, PACKAGE_NAME"/"PACKAGE_VERSION);
797 }
798 global_config.db.p = p;
799
800#if defined(WITH_APACHE20)
801 return OK;
802#endif
803}
804
805/* This function handles calling the DB module, handling errors
806 * of missing tables and lost DB connections, and falling back to
807 * preserving the DB query.
808 *
809 * Parms: request record, table type, table name, and the full SQL command
810 */
811
812static logsql_query_ret safe_sql_insert(request_rec *r, logsql_tabletype table_type,
813 const char *table_name, const char *query) {
814
815 logsql_query_ret result;
816 logsql_state *cls = ap_get_module_config(r->server->module_config,
817 &log_sql_module);
818
819 if (!global_config.db.connected || global_config.driver == NULL) {
820 /* preserve query */
821 return LOGSQL_QUERY_NOLINK;
822 }
823
824 result = global_config.driver->insert(r,&global_config.db,query);
825
826 /* If we ran the query and it returned an error, try to be robust.
827 * (After all, the module thought it had a valid mysql_log connection but the query
828 * could have failed for a number of reasons, so we have to be extra-safe and check.) */
829 switch (result) {
830 case LOGSQL_QUERY_SUCCESS:
831 return LOGSQL_QUERY_SUCCESS;
832 case LOGSQL_QUERY_NOLINK:
833 return LOGSQL_QUERY_FAIL;
834 /* TODO: What do we do here */
835 case LOGSQL_QUERY_FAIL:
836 global_config.driver->disconnect(&global_config.db);
837 global_config.db.connected = 0;
838 /* re-open the connection and try again */
839 if (log_sql_opendb_link(r->server) != LOGSQL_OPENDB_FAIL) {
840 log_error(APLOG_MARK,APLOG_NOTICE,0, r->server,"db reconnect successful");
841# if defined(WITH_APACHE20)
842 apr_sleep(apr_time_from_sec(0.25)); /* pause for a quarter second */
843# elif defined(WITH_APACHE13)
844# if defined(WIN32)
845 Sleep((DWORD)0.25);
846# else
847 {
848 struct timespec delay, remainder;
849 int nanoret;
850 delay.tv_sec = 0;
851 delay.tv_nsec = 250000000; /* pause for a quarter second */
852 nanoret = nanosleep(&delay, &remainder);
853 if (nanoret && errno != EINTR) {
854 log_error(APLOG_MARK,APLOG_ERR, errno, r->server,"nanosleep unsuccessful");
855 }
856 }
857# endif /* win32 */
858# endif
859 result = global_config.driver->insert(r,&global_config.db,query);
860 if (result == LOGSQL_QUERY_SUCCESS) {
861 return LOGSQL_QUERY_SUCCESS;
862 } else {
863 log_error(APLOG_MARK,APLOG_ERR,0,r->server,"second attempt failed");
864 preserve_entry(r, query);
865 return LOGSQL_QUERY_PRESERVED;
866 }
867 } else {
868 log_error(APLOG_MARK,APLOG_ERR,0,r->server,
869 "reconnect failed, unable to reach database. SQL logging stopped until child regains a db connection.");
870 log_error(APLOG_MARK,APLOG_ERR,0,r->server,
871 "log entries are being preserved in %s",cls->preserve_file);
872 preserve_entry(r, query);
873 return LOGSQL_QUERY_PRESERVED;
874 }
875 break;
876 case LOGSQL_QUERY_NOTABLE:
877 if (global_config.createtables) {
878 log_error(APLOG_MARK,APLOG_ERR,0,r->server,
879 "table doesn't exist...creating now");
880 if ((result = global_config.driver->create_table(r, &global_config.db, table_type,
881 table_name))!=LOGSQL_TABLE_SUCCESS) {
882 log_error(APLOG_MARK,APLOG_ERR,result,r->server,
883 "child attempted but failed to create one or more tables for %s, preserving query", ap_get_server_name(r));
884 preserve_entry(r, query);
885 return LOGSQL_QUERY_PRESERVED;
886 } else {
887 log_error(APLOG_MARK,APLOG_ERR,result, r->server,
888 "tables successfully created - retrying query");
889 if ((result = global_config.driver->insert(r,&global_config.db,query))!=LOGSQL_QUERY_SUCCESS) {
890 log_error(APLOG_MARK,APLOG_ERR,result, r->server,
891 "giving up, preserving query");
892 preserve_entry(r, query);
893 return LOGSQL_QUERY_PRESERVED;
894 } else {
895 log_error(APLOG_MARK,APLOG_NOTICE,0, r->server,
896 "query successful after table creation");
897 return LOGSQL_QUERY_SUCCESS;
898 }
899 }
900 } else {
901 log_error(APLOG_MARK,APLOG_ERR,0,r->server,
902 "table doesn't exist, creation denied by configuration, preserving query");
903 preserve_entry(r, query);
904 return LOGSQL_QUERY_PRESERVED;
905 }
906 break;
907 default:
908 log_error(APLOG_MARK,APLOG_ERR,0, r->server,
909 "Invalid return code from mog_log_query");
910 return LOGSQL_QUERY_FAIL;
911 break;
912 }
913 return LOGSQL_QUERY_FAIL;
914}
915
916/* This function gets called to create a per-server configuration
917 * record. It will always be called for the main server and
918 * for each virtual server that is established. Each server maintains
919 * its own state that is separate from the others' states.
920 *
921 * The return value is a pointer to the created module-specific
922 * structure.
923 */
924static void *log_sql_make_state(apr_pool_t *p, server_rec *s)
925{
926 logsql_state *cls = (logsql_state *) apr_pcalloc(p, sizeof(logsql_state));
927
928 /* These defaults are overridable in the httpd.conf file. */
929 cls->transfer_log_format = apr_array_make(p, 1, sizeof(char *));
930 cls->parsed_pool = p;
931
932 cls->notes_table_name = DEFAULT_NOTES_TABLE_NAME;
933 cls->hin_table_name = DEFAULT_HIN_TABLE_NAME;
934 cls->hout_table_name = DEFAULT_HOUT_TABLE_NAME;
935 cls->cookie_table_name = DEFAULT_COOKIE_TABLE_NAME;
936 cls->preserve_file = DEFAULT_PRESERVE_FILE;
937
938 cls->transfer_ignore_list = apr_array_make(p, 1, sizeof(char *));
939 cls->transfer_accept_list = apr_array_make(p, 1, sizeof(char *));
940 cls->remhost_ignore_list = apr_array_make(p, 1, sizeof(char *));
941 cls->notes_list = apr_array_make(p, 1, sizeof(char *));
942 cls->hin_list = apr_array_make(p, 1, sizeof(char *));
943 cls->hout_list = apr_array_make(p, 1, sizeof(char *));
944 cls->cookie_list = apr_array_make(p, 1, sizeof(char *));
945 return (void *) cls;
946}
947
948
949/* Iterates through an array of char* and searches for a matching element
950 * Returns 0 if not found, 1 if found */
951static int in_array(apr_array_header_t *ary, const char *elem)
952{
953 int itr;
954 for (itr = 0; itr < ary->nelts; itr++) {
955 if (!strcmp(elem,((char **)ary->elts)[itr])) {
956 return 1;
957 }
958 }
959 return 0;
960}
961
962
963/* Parse through lists and merge based on +/- prefixes */
964static apr_array_header_t *do_merge_array(apr_array_header_t *parent, apr_array_header_t *child, apr_pool_t *p)
965{
966 apr_array_header_t *ret;
967 ret = apr_array_make(p, 1, sizeof(char *));
968 if (apr_is_empty_array(child)) {
969 apr_array_cat(ret, parent);
970 } else {
971 apr_array_header_t *addlist, *dellist;
972 apr_pool_t *subp;
973 char **elem, **ptr = (char **)(child->elts);
974 int itr, overwrite = 0;
975
976 apr_pool_create(&subp,p);
977
978 addlist = apr_array_make(subp,5,sizeof(char *));
979 dellist = apr_array_make(subp,5,sizeof(char *));
980
981 for (itr=0; itr<child->nelts; itr++) {
982 if (*ptr[itr] == '+') {
983 elem = (char **)apr_array_push(addlist);
984 *elem = (ptr[itr]+1);
985 } else if (*ptr[itr] == '-') {
986 elem = (char **)apr_array_push(dellist);
987 *elem = (ptr[itr]+1);
988 } else {
989 overwrite = 1;
990 elem = (char **)apr_array_push(addlist);
991 *elem = ptr[itr];
992 }
993 }
994 child = apr_array_make(p,1,sizeof(char *));
995 ptr = (char **)(parent->elts);
996 if (overwrite==0) {
997 /* if we are not overwriting the existing then prepare for merge */
998 for (itr=0; itr<parent->nelts; itr++) {
999 if (!in_array(addlist, ptr[itr]) && !in_array(dellist,ptr[itr])) {
1000 elem = apr_array_push(ret);
1001 *elem = apr_pstrdup(p, ptr[itr]);
1002 }
1003 }
1004 }
1005 apr_array_cat(ret, addlist);
1006 apr_pool_destroy(subp);
1007 }
1008 return ret;
1009}
1010
1011static void *log_sql_merge_state(apr_pool_t *p, void *basev, void *addv)
1012{
1013 /* Fetch the two states to merge */
1014 logsql_state *parent = (logsql_state *) basev;
1015 logsql_state *child = (logsql_state *) addv;
1016
1017 /* Child can override these, otherwise they default to parent's choice.
1018 * If the parent didn't set them, create reasonable defaults for the
1019 * ones that should have such default settings. Leave the others null. */
1020
1021 /* No default for transfer_table_name because we want its absence
1022 * to disable logging. */
1023 if (!child->transfer_table_name) {
1024 child->transfer_table_name = parent->transfer_table_name;
1025 }
1026
1027 if (child->preserve_file == DEFAULT_PRESERVE_FILE)
1028 child->preserve_file = parent->preserve_file;
1029 /* server_root_relative the preserve file location */
1030 if (child->preserve_file == DEFAULT_PRESERVE_FILE)
1031 child->preserve_file = ap_server_root_relative(p, DEFAULT_PRESERVE_FILE);
1032
1033 if (child->notes_table_name == DEFAULT_NOTES_TABLE_NAME)
1034 child->notes_table_name = parent->notes_table_name;
1035
1036 if (child->hin_table_name == DEFAULT_HIN_TABLE_NAME)
1037 child->hin_table_name = parent->hin_table_name;
1038
1039 if (child->hout_table_name == DEFAULT_HOUT_TABLE_NAME)
1040 child->hout_table_name = parent->hout_table_name;
1041
1042 if (child->cookie_table_name == DEFAULT_COOKIE_TABLE_NAME)
1043 child->cookie_table_name = parent->cookie_table_name;
1044
1045 child->transfer_ignore_list = do_merge_array(parent->transfer_ignore_list, child->transfer_ignore_list, p);
1046 child->transfer_accept_list = do_merge_array(parent->transfer_accept_list, child->transfer_accept_list, p);
1047 child->remhost_ignore_list = do_merge_array(parent->remhost_ignore_list, child->remhost_ignore_list, p);
1048 child->notes_list = do_merge_array(parent->notes_list, child->notes_list, p);
1049 child->hin_list = do_merge_array(parent->hin_list, child->hin_list, p);
1050 child->hout_list = do_merge_array(parent->hout_list, child->hout_list, p);
1051 child->cookie_list = do_merge_array(parent->cookie_list,child->cookie_list, p);
1052
1053 if (!child->cookie_name)
1054 child->cookie_name = parent->cookie_name;
1055
1056
1057 return (void*) child;
1058}
1059
1060/* Routine to perform the actual construction and execution of the relevant
1061 * INSERT statements.
1062 */
1063static int log_sql_transaction(request_rec *orig)
1064{
1065 char **ptrptr, **ptrptr2;
1066 logsql_state *cls = ap_get_module_config(orig->server->module_config, &log_sql_module);
1067 const char *access_query;
1068 request_rec *r;
1069 const char *transfer_tablename = cls->transfer_table_name;
1070 const char *notes_tablename = cls->notes_table_name;
1071 const char *hout_tablename = cls->hout_table_name;
1072 const char *hin_tablename = cls->hin_table_name;
1073 const char *cookie_tablename = cls->cookie_table_name;
1074 if (global_config.driver == NULL) {
1075 return OK;
1076 }
1077 /* We handle mass virtual hosting differently. Dynamically determine the name
1078 * of the table from the virtual server's name, and flag it for creation.
1079 */
1080 if (global_config.massvirtual) {
1081 /* TODO: Make these configurable? */
1082 char *access_base = "access_";
1083 char *notes_base = "notes_";
1084 char *hout_base = "headout_";
1085 char *hin_base = "headin_";
1086 char *cookie_base = "cookies_";
1087
1088
1089 /* Determine the hostname and convert it to all lower-case; */
1090 char *servername = apr_pstrdup(orig->pool,(char *)ap_get_server_name(orig));
1091
1092 char *p=servername;
1093 while (*p) {
1094 *p = apr_tolower(*p);
1095 if (*p == '.') *p = '_';
1096 if (*p == '-') *p = '_';
1097 ++p;
1098 }
1099
1100 /* Find memory long enough to hold the table name + \0. */
1101 transfer_tablename = apr_pstrcat(orig->pool, access_base, servername, NULL);
1102 notes_tablename = apr_pstrcat(orig->pool, notes_base, servername, NULL);
1103 hin_tablename = apr_pstrcat(orig->pool, hin_base, servername, NULL);
1104 hout_tablename = apr_pstrcat(orig->pool, hout_base, servername, NULL);
1105 cookie_tablename = apr_pstrcat(orig->pool, cookie_base, servername, NULL);
1106
1107 /* Tell this virtual server its transfer table name, and
1108 * turn on create_tables, which is implied by massvirtual.
1109 */
1110
1111 global_config.createtables = 1;
1112 }
1113
1114 /* Do we have enough info to log? */
1115 if (!transfer_tablename) {
1116 return DECLINED;
1117 } else {
1118 const char *thehost;
1119 const char *theitem;
1120 char *fields = "", *values = "";
1121 char *itemsets = "";
1122 char *note_query = NULL;
1123 char *hin_query = NULL;
1124 char *hout_query = NULL;
1125 char *cookie_query = NULL;
1126 const char *unique_id;
1127 const char *formatted_item;
1128 int i, showcomma;
1129 int proceed;
1130
1131 for (r = orig; r->next; r = r->next) {
1132 continue;
1133 }
1134
1135 /* The following is a stolen upsetting mess of pointers, I'm sorry.
1136 * Anyone with the motiviation and/or the time should feel free
1137 * to make this cleaner. :) */
1138 ptrptr2 = (char **) (cls->transfer_accept_list->elts + (cls->transfer_accept_list->nelts * cls->transfer_accept_list->elt_size));
1139
1140 /* Go through each element of the accept list and compare it to the
1141 * request_uri. If we don't get a match, return without logging */
1142 if ((r->uri) && (cls->transfer_accept_list->nelts)) {
1143 proceed = 0;
1144 for (ptrptr = (char **) cls->transfer_accept_list->elts; ptrptr < ptrptr2; ptrptr = (char **) ((char *) ptrptr + cls->transfer_accept_list->elt_size))
1145 if (ap_strstr(r->uri, *ptrptr)) {
1146 proceed = 1;
1147 break;
1148 }
1149 if (!proceed)
1150 return OK;
1151 }
1152
1153 /* Go through each element of the ignore list and compare it to the
1154 * request_uri. If we get a match, return without logging */
1155 ptrptr2 = (char **) (cls->transfer_ignore_list->elts + (cls->transfer_ignore_list->nelts * cls->transfer_ignore_list->elt_size));
1156 if (r->uri) {
1157 for (ptrptr = (char **) cls->transfer_ignore_list->elts; ptrptr < ptrptr2; ptrptr = (char **) ((char *) ptrptr + cls->transfer_ignore_list->elt_size))
1158 if (ap_strstr(r->uri, *ptrptr)) {
1159 return OK;
1160 }
1161 }
1162
1163 /* Go through each element of the ignore list and compare it to the
1164 * remote host. If we get a match, return without logging */
1165 ptrptr2 = (char **) (cls->remhost_ignore_list->elts + (cls->remhost_ignore_list->nelts * cls->remhost_ignore_list->elt_size));
1166 thehost = ap_get_remote_host(r->connection, r->per_dir_config, REMOTE_NAME, NULL);
1167 if (thehost) {
1168 for (ptrptr = (char **) cls->remhost_ignore_list->elts; ptrptr < ptrptr2; ptrptr = (char **) ((char *) ptrptr + cls->remhost_ignore_list->elt_size))
1169 if (ap_strstr_c(thehost, *ptrptr)) {
1170 return OK;
1171 }
1172 }
1173
1174
1175 /* Iterate through the format characters and set up the INSERT string according to
1176 * what the user has configured. */
1177 showcomma = 0;
1178 for (i = 0; i<cls->transfer_log_format->nelts; i++) {
1179 logsql_field *item = cls->parsed_log_format[i];
1180 if (item==NULL || item->func==NULL) {
1181 log_error(APLOG_MARK, APLOG_ERR, 0, orig->server,
1182 "Log Format '%s' unknown or incomplete",((char **)cls->transfer_log_format->elts)[i]);
1183 continue;
1184 }
1185
1186 /* Yes, this key is one of the configured keys.
1187 * Call the key's function and put the returned value into 'formatted_item' */
1188 formatted_item = item->func->func(item->func->want_orig_req ? orig : r,
1189 item->param ? item->param : "");
1190
1191 /* Massage 'formatted_item' for proper SQL eligibility... */
1192 if (!formatted_item) {
1193 formatted_item = "";
1194 } else if (formatted_item[0] == '-' && formatted_item[1] == '\0' && !item->string_contents) {
1195 /* If apache tried to log a '-' character for a numeric field, convert that to a zero
1196 * because the database expects a numeral and will reject the '-' character. */
1197 formatted_item = "0";
1198 }
1199
1200 /* Append the fieldname and value-to-insert to the appropriate strings, quoting stringvals with ' as appropriate */
1201 fields = apr_pstrcat(r->pool, fields, (showcomma ? "," : ""),
1202 item->sql_field_name, NULL);
1203 values = apr_pstrcat(r->pool, values, (showcomma ? "," : ""),
1204 global_config.driver->escape(r, formatted_item, r->pool,&global_config.db), NULL);
1205 showcomma = 1;
1206 }
1207
1208 /* Work through the list of notes defined by LogSQLWhichNotes */
1209 i = 0;
1210 unique_id = extract_unique_id(r, "");
1211
1212 ptrptr2 = (char **) (cls->notes_list->elts + (cls->notes_list->nelts * cls->notes_list->elt_size));
1213 for (ptrptr = (char **) cls->notes_list->elts; ptrptr < ptrptr2; ptrptr = (char **) ((char *) ptrptr + cls->notes_list->elt_size)) {
1214 /* If the specified note (*ptrptr) exists for the current request... */
1215 if ((theitem = apr_table_get(r->notes, *ptrptr))) {
1216 itemsets = apr_pstrcat(r->pool, itemsets,
1217 (i > 0 ? "," : ""),
1218 "(",
1219 global_config.driver->escape(r, unique_id, r->pool, &global_config.db),
1220 ",",
1221 global_config.driver->escape(r, *ptrptr, r->pool,&global_config.db),
1222 ",",
1223 global_config.driver->escape(r, theitem, r->pool,&global_config.db),
1224 ")",
1225 NULL);
1226 i++;
1227 }
1228 }
1229 if ( *itemsets != '\0' ) {
1230 note_query = apr_psprintf(r->pool, "insert %s into %s (id, item, val) values %s",
1231 /*global_config.insertdelayed?"delayed":*/"", notes_tablename, itemsets);
1232
1233 log_error(APLOG_MARK,APLOG_DEBUG,0, orig->server,"mod_log_sql: note string: %s", note_query);
1234 }
1235
1236 /* Work through the list of headers-out defined by LogSQLWhichHeadersOut*/
1237 i = 0;
1238 itemsets = "";
1239
1240 ptrptr2 = (char **) (cls->hout_list->elts + (cls->hout_list->nelts * cls->hout_list->elt_size));
1241 for (ptrptr = (char **) cls->hout_list->elts; ptrptr < ptrptr2; ptrptr = (char **) ((char *) ptrptr + cls->hout_list->elt_size)) {
1242 /* If the specified header (*ptrptr) exists for the current request... */
1243 if ((theitem = apr_table_get(r->headers_out, *ptrptr))) {
1244 itemsets = apr_pstrcat(r->pool, itemsets,
1245 (i > 0 ? "," : ""),
1246 "(",
1247 global_config.driver->escape(r,unique_id, r->pool, &global_config.db),
1248 ",",
1249 global_config.driver->escape(r,*ptrptr, r->pool,&global_config.db),
1250 ",",
1251 global_config.driver->escape(r,theitem, r->pool,&global_config.db),
1252 ")",
1253 NULL);
1254 i++;
1255 }
1256 }
1257 if ( *itemsets != '\0' ) {
1258 hout_query = apr_psprintf(r->pool, "insert %s into %s (id, item, val) values %s",
1259 /*global_config.insertdelayed?"delayed":*/"", hout_tablename, itemsets);
1260
1261 log_error(APLOG_MARK,APLOG_DEBUG,0, orig->server,"mod_log_sql: header_out string: %s", hout_query);
1262 }
1263
1264
1265 /* Work through the list of headers-in defined by LogSQLWhichHeadersIn */
1266 i = 0;
1267 itemsets = "";
1268
1269 ptrptr2 = (char **) (cls->hin_list->elts + (cls->hin_list->nelts * cls->hin_list->elt_size));
1270 for (ptrptr = (char **) cls->hin_list->elts; ptrptr < ptrptr2; ptrptr = (char **) ((char *) ptrptr + cls->hin_list->elt_size)) {
1271 /* If the specified header (*ptrptr) exists for the current request... */
1272 if ((theitem = apr_table_get(r->headers_in, *ptrptr))) {
1273 itemsets = apr_pstrcat(r->pool, itemsets,
1274 (i > 0 ? "," : ""),
1275 "(",
1276 global_config.driver->escape(r,unique_id, r->pool, &global_config.db),
1277 ",",
1278 global_config.driver->escape(r,*ptrptr, r->pool,&global_config.db),
1279 ",",
1280 global_config.driver->escape(r,theitem, r->pool,&global_config.db),
1281 ")",
1282 NULL);
1283 i++;
1284 }
1285 }
1286 if ( *itemsets != '\0' ) {
1287 hin_query = apr_psprintf(r->pool, "insert %s into %s (id, item, val) values %s",
1288 /*global_config.insertdelayed?"delayed":*/"", hin_tablename, itemsets);
1289
1290 log_error(APLOG_MARK,APLOG_DEBUG,0, orig->server,"mod_log_sql: header_in string: %s", hin_query);
1291 }
1292
1293
1294 /* Work through the list of cookies defined by LogSQLWhichCookies */
1295 i = 0;
1296 itemsets = "";
1297
1298 ptrptr2 = (char **) (cls->cookie_list->elts + (cls->cookie_list->nelts * cls->cookie_list->elt_size));
1299 for (ptrptr = (char **) cls->cookie_list->elts; ptrptr < ptrptr2; ptrptr = (char **) ((char *) ptrptr + cls->cookie_list->elt_size)) {
1300 /* If the specified cookie (*ptrptr) exists for the current request... */
1301 if ( strncmp((theitem = extract_specific_cookie(r, *ptrptr)), "-", 1) ) {
1302 itemsets = apr_pstrcat(r->pool, itemsets,
1303 (i > 0 ? "," : ""),
1304 "(",
1305 global_config.driver->escape(r,unique_id, r->pool, &global_config.db),
1306 ",",
1307 global_config.driver->escape(r,*ptrptr, r->pool,&global_config.db),
1308 ",",
1309 global_config.driver->escape(r,theitem, r->pool,&global_config.db),
1310 ")",
1311 NULL);
1312 i++;
1313 }
1314
1315 }
1316 if ( *itemsets != '\0' ) {
1317 cookie_query = apr_psprintf(r->pool, "insert %s into %s (id, item, val) values %s",
1318 /*global_config.insertdelayed?"delayed":*/"", cookie_tablename, itemsets);
1319
1320 log_error(APLOG_MARK,APLOG_DEBUG,0, orig->server,"mod_log_sql: cookie string: %s", cookie_query);
1321 }
1322
1323
1324 /* Set up the actual INSERT statement */
1325 access_query = apr_psprintf(r->pool, "insert %s into %s (%s) values (%s)",
1326 /*global_config.insertdelayed?"delayed":*/"", transfer_tablename, fields, values);
1327
1328 log_error(APLOG_MARK,APLOG_DEBUG,0, r->server,"mod_log_sql: access string: %s", access_query);
1329
1330 /* If the person activated force-preserve, go ahead and push all the entries
1331 * into the preserve file, then return.
1332 */
1333 if (global_config.forcepreserve) {
1334 log_error(APLOG_MARK,APLOG_DEBUG,0, orig->server,"mod_log_sql: preservation forced");
1335 preserve_entry(orig, access_query);
1336 if ( note_query != NULL )
1337 preserve_entry(orig, note_query);
1338 if ( hin_query != NULL )
1339 preserve_entry(orig, hin_query);
1340 if ( hout_query != NULL )
1341 preserve_entry(orig, hout_query);
1342 if ( cookie_query != NULL )
1343 preserve_entry(orig, cookie_query);
1344 return OK;
1345 }
1346
1347 /* How's our mysql link integrity? */
1348 if (!global_config.db.connected) {
1349 if (!global_config.forcepreserve) {
1350 /* Make a try to establish the link */
1351 log_sql_opendb_link(r->server);
1352 }
1353 if (!global_config.db.connected) {
1354 /* Unable to re-establish a DB link, so assume that it's really
1355 * gone and send the entry to the preserve file instead.
1356 * This short-circuits safe_sql_query() during a db outage and therefore
1357 * we don't keep logging the db error over and over.
1358 */
1359 preserve_entry(orig, access_query);
1360 if ( note_query != NULL )
1361 preserve_entry(orig, note_query);
1362 if ( hin_query != NULL )
1363 preserve_entry(orig, hin_query);
1364 if ( hout_query != NULL )
1365 preserve_entry(orig, hout_query);
1366 if ( cookie_query != NULL )
1367 preserve_entry(orig, cookie_query);
1368
1369 return OK;
1370 } else {
1371 /* Whew, we got the DB link back */
1372 log_error(APLOG_MARK,APLOG_NOTICE,0, orig->server,"mod_log_sql: child established database connection");
1373 }
1374 }
1375
1376
1377 /* ---> So as of here we have a non-null value of mysql_log. <--- */
1378 /* ---> i.e. we have a good MySQL connection. <--- */
1379
1380 /* Make the access-table insert */
1381 safe_sql_insert(orig,LOGSQL_TABLE_ACCESS,transfer_tablename,access_query);
1382
1383 /* Log the optional notes, headers, etc. */
1384 if (note_query)
1385 safe_sql_insert(orig, LOGSQL_TABLE_NOTES,notes_tablename,note_query);
1386
1387 if (hout_query)
1388 safe_sql_insert(orig, LOGSQL_TABLE_HEADERSOUT,hout_tablename,hout_query);
1389
1390 if (hin_query)
1391 safe_sql_insert(orig, LOGSQL_TABLE_HEADERSIN,hin_tablename,hin_query);
1392
1393 if (cookie_query)
1394 safe_sql_insert(orig, LOGSQL_TABLE_COOKIES,cookie_tablename,cookie_query);
1395
1396 return OK;
1397 }
1398}
1399
1400
1401/* Setup of the available httpd.conf configuration commands.
1402 * Structure: command, function called, NULL, where available, how many arguments, verbose description
1403 */
1404static const command_rec log_sql_cmds[] = {
1405 AP_INIT_FLAG("LogSQLAnnounce", set_global_flag_slot,
1406 (void *)APR_OFFSETOF(global_config_t, announce), RSRC_CONF,
1407 "Whether to announce that mod_log_sql is loaded in the server header")
1408 ,
1409 /* DB connection parameters */
1410 AP_INIT_TAKE13("LogSQLLoginInfo", set_log_sql_info, NULL, RSRC_CONF,
1411 "The database connection URI in the form &quot;driver://user:password@hostname:port/database&quot;")
1412 ,
1413 AP_INIT_TAKE2("LogSQLDBParam", set_dbparam, NULL, RSRC_CONF,
1414 "First argument is the DB parameter, second is the value to assign")
1415 ,
1416 AP_INIT_FLAG("LogSQLForcePreserve", set_global_flag_slot,
1417 (void *)APR_OFFSETOF(global_config_t, forcepreserve), RSRC_CONF,
1418 "Forces logging to preserve file and bypasses database")
1419 ,
1420 AP_INIT_FLAG("LogSQLDisablePreserve", set_global_flag_slot,
1421 (void *)APR_OFFSETOF(global_config_t, disablepreserve), RSRC_CONF,
1422 "Completely disables use of the preserve file")
1423 ,
1424 AP_INIT_TAKE1("LogSQLPreserveFile", set_server_file_slot,
1425 (void *)APR_OFFSETOF(logsql_state,preserve_file), RSRC_CONF,
1426 "Name of the file to use for data preservation during database downtime")
1427 ,
1428 AP_INIT_FLAG("LogSQLCreateTables", set_global_nmv_flag_slot,
1429 (void *)APR_OFFSETOF(global_config_t, createtables), RSRC_CONF,
1430 "Turn on module's capability to create its SQL tables on the fly")
1431 ,
1432 /* Table names */
1433 AP_INIT_FLAG("LogSQLMassVirtualHosting", set_global_flag_slot,
1434 (void *)APR_OFFSETOF(global_config_t, massvirtual), RSRC_CONF,
1435 "Activates option(s) useful for ISPs performing mass virutal hosting")
1436 ,
1437 AP_INIT_TAKE1("LogSQLTransferLogTable", set_server_nmv_string_slot,
1438 (void *)APR_OFFSETOF(logsql_state, transfer_table_name), RSRC_CONF,
1439 "The database table that holds the transfer log")
1440 ,
1441 AP_INIT_TAKE1("LogSQLNotesLogTable", set_server_nmv_string_slot,
1442 (void *)APR_OFFSETOF(logsql_state, notes_table_name), RSRC_CONF,
1443 "The database table that holds the notes")
1444 ,
1445 AP_INIT_TAKE1("LogSQLHeadersOutLogTable", set_server_nmv_string_slot,
1446 (void *)APR_OFFSETOF(logsql_state, hout_table_name), RSRC_CONF,
1447 "The database table that holds the outbound headers")
1448 ,
1449 AP_INIT_TAKE1("LogSQLHeadersInLogTable", set_server_nmv_string_slot,
1450 (void *)APR_OFFSETOF(logsql_state, hin_table_name), RSRC_CONF,
1451 "The database table that holds the inbound headers")
1452 ,
1453 AP_INIT_TAKE1("LogSQLCookieLogTable", set_server_nmv_string_slot,
1454 (void *)APR_OFFSETOF(logsql_state, cookie_table_name), RSRC_CONF,
1455 "The database table that holds the cookie info")
1456 ,
1457 /* New Log Format */
1458 AP_INIT_ITERATE("LogSQLTransferLogItems", add_server_string_slot,
1459 (void *)APR_OFFSETOF(logsql_state, transfer_log_format), RSRC_CONF,
1460 "What fields to log to the database transfer log")
1461 ,
1462 AP_INIT_RAW_ARGS("LogSQLRegisterItem", set_register_field,
1463 NULL, RSRC_CONF,
1464 "Register a new Item for logging, Arguments: ItemName function argument sqlfield datatype datalen<br>"
1465 "datatypes are INT, SMALLINT, VARCHAR, CHAR<br>")
1466 ,
1467 AP_INIT_TAKE1("LogSQLShowConfig", set_global_string_slot,
1468 (void *)APR_OFFSETOF(global_config_t, showconfig), RSRC_CONF,
1469 "Add this to export the entire running function and dfield configuration to the named file")
1470 ,
1471 /* Machine ID */
1472 AP_INIT_TAKE1("LogSQLMachineID", set_global_string_slot,
1473 (void *)APR_OFFSETOF(global_config_t, machid), RSRC_CONF,
1474 "Machine ID that the module will log, useful in web clusters to differentiate machines")
1475 ,
1476 /* Limits on logging */
1477 AP_INIT_ITERATE("LogSQLRequestAccept", add_server_string_slot,
1478 (void *)APR_OFFSETOF(logsql_state, transfer_accept_list), RSRC_CONF,
1479 "List of URIs to accept for logging. Accesses that don't match will not be logged")
1480 ,
1481 AP_INIT_ITERATE("LogSQLRequestIgnore", add_server_string_slot,
1482 (void *)APR_OFFSETOF(logsql_state, transfer_ignore_list), RSRC_CONF,
1483 "List of URIs to ignore. Accesses that match will not be logged to database")
1484 ,
1485 AP_INIT_ITERATE("LogSQLRemhostIgnore", add_server_string_slot,
1486 (void *)APR_OFFSETOF(logsql_state, remhost_ignore_list), RSRC_CONF,
1487 "List of remote hosts to ignore. Accesses that match will not be logged to database")
1488 ,
1489 /* Special logging table configuration */
1490 AP_INIT_TAKE1("LogSQLWhichCookie", set_server_string_slot,
1491 (void *)APR_OFFSETOF(logsql_state, cookie_name), RSRC_CONF,
1492 "The single cookie that you want logged in the access_log when using the 'c' config directive")
1493 ,
1494 AP_INIT_ITERATE("LogSQLWhichNotes", add_server_string_slot,
1495 (void *)APR_OFFSETOF(logsql_state, notes_list), RSRC_CONF,
1496 "Notes that you would like to log in a separate table")
1497 ,
1498 AP_INIT_ITERATE("LogSQLWhichHeadersOut", add_server_string_slot,
1499 (void *)APR_OFFSETOF(logsql_state, hout_list), RSRC_CONF,
1500 "Outbound headers that you would like to log in a separate table")
1501 ,
1502 AP_INIT_ITERATE("LogSQLWhichHeadersIn", add_server_string_slot,
1503 (void *)APR_OFFSETOF(logsql_state, hin_list), RSRC_CONF,
1504 "Inbound headers that you would like to log in a separate table")
1505 ,
1506 AP_INIT_ITERATE("LogSQLWhichCookies", add_server_string_slot,
1507 (void *)APR_OFFSETOF(logsql_state, cookie_list), RSRC_CONF,
1508 "The cookie(s) that you would like to log in a separate table")
1509 ,
1510 AP_INIT_RAW_ARGS("LogSQLDeprecated", ap_set_deprecated, NULL, RSRC_CONF,
1511 "<br><b>Deprecated</b><br>The following Commands are deprecated and should not be used.. <br>Read the documentation for more information<br><b>Deprecated</b>")
1512 ,
1513 /* Deprecated commands */
1514 AP_INIT_TAKE1("LogSQLTransferLogFormat", set_logformat_slot,
1515 (void *)APR_OFFSETOF(logsql_state, transfer_log_format), RSRC_CONF,
1516 "<b>(Deprecated) Use LogSQLTransferLogItem to specify symbolic log items instead")
1517 ,
1518 AP_INIT_TAKE1("LogSQLDatabase", set_dbparam_slot,
1519 (void *)"database", RSRC_CONF,
1520 "<b>(Deprecated) Use LogSQLDBParam database dbname.</b> The name of the database database for logging")
1521 ,
1522 AP_INIT_TAKE1("LogSQLTableType", set_dbparam_slot,
1523 (void *)"tabletype", RSRC_CONF,
1524 "<b>(Deprecated) Use LogSQLDBParam tabletype type.</b> What kind of table to create (MyISAM, InnoDB,...) when creating tables")
1525 ,
1526 AP_INIT_TAKE1("LogSQLSocketFile", set_dbparam_slot,
1527 (void *)"socketfile", RSRC_CONF,
1528 "<b>(Deprecated) Use LogSQLDBParam socketfile socket.</b> Name of the file to employ for socket connections to database")
1529 ,
1530 AP_INIT_TAKE1("LogSQLTCPPort", set_dbparam_slot,
1531 (void *)"port", RSRC_CONF,
1532 "<b>(Deprecated) Use LogSQLDBParam port port.</b> Port number to use for TCP connections to database, defaults to 3306 if not set")
1533 ,
1534 {NULL}
1535};
1536/* The configuration array that sets up the hooks into the module. */
1537#if defined(WITH_APACHE20)
1538static void register_hooks(apr_pool_t *p) {
1539 ap_hook_post_config(log_sql_post_config, NULL, NULL, APR_HOOK_REALLY_FIRST);
1540 ap_hook_child_init(log_sql_child_init, NULL, NULL, APR_HOOK_MIDDLE);
1541 ap_hook_log_transaction(log_sql_transaction, NULL, NULL, APR_HOOK_MIDDLE);
1542}
1543
1544module AP_MODULE_DECLARE_DATA log_sql_module = {
1545 STANDARD20_MODULE_STUFF,
1546 NULL, /* create per-directory config structures */
1547 NULL, /* merge per-directory config structures */
1548 log_sql_make_state, /* create per-server config structures */
1549 log_sql_merge_state, /* merge per-server config structures */
1550 log_sql_cmds, /* command handlers */
1551 register_hooks /* register hooks */
1552};
1553#elif defined(WITH_APACHE13)
1554module MODULE_VAR_EXPORT log_sql_module = {
1555 STANDARD_MODULE_STUFF,
1556 log_sql_module_init, /* module initializer */
1557 NULL, /* create per-dir config */
1558 NULL, /* merge per-dir config */
1559 log_sql_make_state, /* create server config */
1560 log_sql_merge_state, /* merge server config */
1561 log_sql_cmds, /* config directive table */
1562 NULL, /* [9] content handlers */
1563 NULL, /* [2] URI-to-filename translation */
1564 NULL, /* [5] check/validate user_id */
1565 NULL, /* [6] check authorization */
1566 NULL, /* [4] check access by host */
1567 NULL, /* [7] MIME type checker/setter */
1568 NULL, /* [8] fixups */
1569 log_sql_transaction, /* [10] logger */
1570 NULL /* [3] header parser */
1571#if MODULE_MAGIC_NUMBER >= 19970728 /* 1.3-dev or later support these additionals... */
1572 ,log_sql_child_init, /* child process initializer */
1573 log_sql_child_exit, /* process exit/cleanup */
1574 NULL /* [1] post read-request */
1575#endif
1576
1577};
1578#endif