/
mod_log_sql.c
1283 lines (1150 loc) · 45.6 KB
/
mod_log_sql.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* $Id: mod_log_sql.c 170 2006-11-07 02:31:26Z urkle@drip.ws $ */
#if defined(WITH_APACHE20)
# include "apache20.h"
#elif defined(WITH_APACHE13)
# include "apache13.h"
#else
# error Unsupported Apache version
#endif
#ifdef HAVE_CONFIG_H
/* Undefine these to prevent conflicts between Apache ap_config_auto.h and
* my config.h. Only really needed for Apache < 2.0.48, but it can't hurt.
*/
#undef PACKAGE_BUGREPORT
#undef PACKAGE_NAME
#undef PACKAGE_STRING
#undef PACKAGE_TARNAME
#undef PACKAGE_VERSION
#include "config.h"
#endif
#if APR_HAVE_UNISTD_H
#include <unistd.h>
#endif
#ifdef HAVE_LIMITS_H
#include <limits.h>
#endif
#include "mod_log_sql.h"
/* Configuratino Defaults */
#define DEFAULT_TRANSFER_LOG_FMT "AbHhmRSsTUuv"
#define DEFAULT_NOTES_TABLE_NAME "notes"
#define DEFAULT_HIN_TABLE_NAME "headers_in"
#define DEFAULT_HOUT_TABLE_NAME "headers_out"
#define DEFAULT_COOKIE_TABLE_NAME "cookies"
#define DEFAULT_PRESERVE_FILE "logs/mod_log_sql-preserve"
/* -------------*
* DECLARATIONS *
* -------------*/
/* Declare ourselves so the configuration routines can find and know us. */
module AP_MODULE_DECLARE_DATA log_sql_module;
/* The contents of these are known 'Apache wide' and are not variable
* on a per-virtual-server basis. Every virtual server 'knows' the
* same versions of these variables.
*/
typedef struct {
int massvirtual;
int createtables;
int forcepreserve;
int disablepreserve;
char *machid;
int announce;
logsql_dbconnection db;
logsql_dbdriver *driver;
} global_config_t;
static global_config_t global_config;
/* structure to hold helper function info */
typedef struct {
char key; /* item letter character */
logsql_item_func *func; /* its extraction function */
const char *sql_field_name; /* its column in SQL */
int want_orig_default; /* if it requires the original request prior to internal redirection */
int string_contents; /* if it returns a string */
} logsql_item;
/* But the contents of this structure will vary by virtual server.
* This permits each virtual server to vary its configuration slightly
* for per-server customization.
*
* Each child process has its own segregated copy of this structure.
*/
typedef struct {
apr_array_header_t *transfer_ignore_list;
apr_array_header_t *transfer_accept_list;
apr_array_header_t *remhost_ignore_list;
apr_array_header_t *notes_list;
apr_array_header_t *hout_list;
apr_array_header_t *hin_list;
apr_array_header_t *cookie_list;
const char *notes_table_name;
const char *hout_table_name;
const char *hin_table_name;
const char *cookie_table_name;
const char *transfer_table_name;
const char *transfer_log_format;
apr_pool_t *parsed_pool;
logsql_item **parsed_log_format;
const char *preserve_file;
const char *cookie_name;
} logsql_state;
/* list of "handlers" for log types */
static apr_array_header_t *logsql_item_list;
/* Registration function for extract functions *
* and update parse cache for transfer_log_format *
* this is exported from the module */
LOGSQL_DECLARE(void) log_sql_register_item(server_rec *s, apr_pool_t *p,
char key, logsql_item_func *func, const char *sql_field_name,
int want_orig_default, int string_contents)
{
server_rec *ts;
logsql_item *item;
if (!logsql_item_list)
logsql_item_list = apr_array_make(p,10, sizeof(logsql_item));
item= apr_array_push(logsql_item_list);
item->key = key;
item->func = func;
item->sql_field_name = sql_field_name;
item->want_orig_default = want_orig_default;
item->string_contents = string_contents;
/* some voodoo here to post parse logitems in all servers *
* so a "cached" list is used in the main logging loop for speed */
for (ts = s; ts; ts = ts->next) {
logsql_state *cfg = ap_get_module_config(ts->module_config,
&log_sql_module);
char *pos;
if (cfg->transfer_log_format) {
if ( (pos = ap_strchr_c(cfg->transfer_log_format,key))!=NULL) {
cfg->parsed_log_format[pos - cfg->transfer_log_format] = item;
}
}
}
}
/* Registration function for database drivers */
LOGSQL_DECLARE(void) log_sql_register_driver(apr_pool_t *p,
logsql_dbdriver *driver)
{
global_config.driver = driver;
}
/* Include all the core extract functions */
#include "functions.h"
#if defined(WITH_APACHE13)
# include "functions13.h"
#elif defined(WITH_APACHE20)
# include "functions20.h"
#endif
static logsql_opendb_ret log_sql_opendb_link(server_rec* s)
{
logsql_opendb_ret result;
if (global_config.driver == NULL) {
return LOGSQL_OPENDB_FAIL;
}
if (global_config.forcepreserve) {
//global_config.db.connected = 1;
return LOGSQL_OPENDB_PRESERVE;
}
if (global_config.db.connected) {
return LOGSQL_OPENDB_ALREADY;
}
/* database
host
user
passwd
*/
if (global_config.db.parms) {
result = global_config.driver->connect(s, &global_config.db);
if (result==LOGSQL_OPENDB_FAIL) {
global_config.db.connected = 0;
} else {
global_config.db.connected = 1;
}
return result;
} else {
log_error(APLOG_MARK, APLOG_ERR, 0, s,
"mod_log_sql: insufficient configuration info to establish database link");
return LOGSQL_OPENDB_FAIL;
}
}
static void preserve_entry(request_rec *r, const char *query)
{
logsql_state *cls = ap_get_module_config(r->server->module_config,
&log_sql_module);
#if defined(WITH_APACHE20)
apr_file_t *fp;
apr_status_t result;
#elif defined(WITH_APACHE13)
FILE *fp;
int result;
#endif
/* If preserve file is disabled bail out */
if (global_config.disablepreserve)
return;
#if defined(WITH_APACHE20)
result = apr_file_open(&fp, cls->preserve_file,APR_APPEND | APR_WRITE | APR_CREATE, APR_OS_DEFAULT, r->pool);
#elif defined(WITH_APACHE13)
fp = ap_pfopen(r->pool, cls->preserve_file, "a");
result = (fp)?0:errno;
#endif
if (result != APR_SUCCESS) {
log_error(APLOG_MARK, APLOG_ERR, result, r->server,
"attempted append of local preserve file '%s' but failed.",cls->preserve_file);
} else {
#if defined(WITH_APACHE20)
apr_file_printf(fp,"%s;\n", query);
apr_file_close(fp);
#elif defined(WITH_APACHE13)
fprintf(fp,"%s;\n", query);
ap_pfclose(r->pool, fp);
#endif
log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
"mod_log_sql: entry preserved in %s", cls->preserve_file);
}
}
/* ------------------------------------------------*
* Command handlers that are called according *
* to the directives found at Apache runtime. *
* ------------------------------------------------*/
static const char *set_global_flag_slot(cmd_parms *cmd,
void *struct_ptr,
int flag)
{
void *ptr = &global_config;
int offset = (int)(long)cmd->info;
*(int *)((char *)ptr + offset) = flag ? 1 : 0;
return NULL;
}
static const char *set_global_nmv_flag_slot(cmd_parms *cmd,
void *struct_ptr,
int flag)
{
if (global_config.massvirtual) {
return apr_psprintf(cmd->pool,
"mod_log_sql: do not set %s when LogSQLMassVirtualHosting(%d) is On.%d:%d",
cmd->cmd->name, global_config.massvirtual,
(int)(long)&global_config, (int)(long)struct_ptr);
} else {
return set_global_flag_slot(cmd,struct_ptr,flag);
}
}
static const char *set_global_string_slot(cmd_parms *cmd,
void *struct_ptr,
const char *arg)
{
void *ptr = &global_config;
int offset = (int)(long)cmd->info;
*(const char **)((char *)ptr + offset) = apr_pstrdup(cmd->pool,arg);
return NULL;
}
static const char *set_server_string_slot(cmd_parms *cmd,
void *struct_ptr,
const char *arg)
{
void *ptr = ap_get_module_config(cmd->server->module_config,
&log_sql_module);
int offset = (int)(long)cmd->info;
*(const char **)((char *)ptr + offset) = arg;
return NULL;
}
static const char *set_server_file_slot(cmd_parms *cmd,
void *struct_ptr,
const char *arg)
{
void *ptr = ap_get_module_config(cmd->server->module_config,
&log_sql_module);
int offset = (int)(long)cmd->info;
const char *path;
path = ap_server_root_relative(cmd->pool, (char *)arg);
if (!path) {
return apr_pstrcat(cmd->pool, "Invalid file path ",
arg, NULL);
}
*(const char **)((char*)ptr + offset) = path;
return NULL;
}
static const char *set_logformat_slot(cmd_parms *cmd,
void *struct_ptr,
const char *arg)
{
logsql_state *cfg = ap_get_module_config(cmd->server->module_config,
&log_sql_module);
cfg->transfer_log_format = arg;
/* apr_pool_clear(cfg->parsed_pool);*/
cfg->parsed_log_format = apr_pcalloc(cfg->parsed_pool,
strlen(arg) * sizeof(logsql_item *));
return NULL;
}
static const char *set_server_nmv_string_slot(cmd_parms *parms,
void *struct_ptr,
const char *arg)
{
if (global_config.massvirtual)
return apr_psprintf(parms->pool,
"mod_log_sql: do not set %s when LogSQLMassVirtualHosting is On.",
parms->cmd->name);
else
return set_server_string_slot(parms,struct_ptr,arg);
}
/* Set a DB connection parameter */
static const char *set_dbparam(cmd_parms *cmd,
void *struct_ptr,
const char *key,
const char *val)
{
if (!global_config.db.parms) {
global_config.db.parms = apr_table_make(cmd->pool,5);
}
apr_table_set(global_config.db.parms,key,val);
return NULL;
}
static const char *set_dbparam_slot(cmd_parms *cmd,
void *struct_ptr,
const char *arg)
{
const char *param = (char *)cmd->info;
set_dbparam(cmd,NULL,param,arg);
return NULL;
}
/* Sets basic connection info */
static const char *set_log_sql_info(cmd_parms *cmd, void *dummy,
const char *host, const char *user, const char *pwd)
{
if (!user) { /* user is null, so only one arg passed */
/* TODO: to more error checking/force all params to be set */
apr_uri_t uri;
apr_uri_parse(cmd->pool, host, &uri);
if (uri.scheme) {
set_dbparam(cmd, NULL, "driver", uri.scheme);
}
if (uri.hostname) {
set_dbparam(cmd, NULL, "hostname", uri.hostname);
}
if (uri.user) {
set_dbparam(cmd, NULL, "username", uri.user);
}
if (uri.password) {
set_dbparam(cmd, NULL, "password", uri.password);
}
if (uri.port_str) {
set_dbparam(cmd, NULL, "port", uri.port_str);
}
if (uri.path) {
/* extract Database name */
char *off = ap_strchr(++uri.path,'/');
if (off)
*off='\0';
set_dbparam(cmd, NULL, "database", uri.path);
}
} else {
if (*host != '.') {
set_dbparam(cmd, NULL, "hostname", host);
}
if (*user != '.') {
set_dbparam(cmd, NULL, "username", user);
}
if (*pwd != '.') {
set_dbparam(cmd, NULL, "password", pwd);
}
}
return NULL;
}
static const char *add_server_string_slot(cmd_parms *cmd,
void *struct_ptr,
const char *arg)
{
char **addme;
void *ptr = ap_get_module_config(cmd->server->module_config,
&log_sql_module);
int offset = (int)(long)cmd->info;
apr_array_header_t *ary = *(apr_array_header_t **)((char *)ptr + offset);
addme = apr_array_push(ary);
*addme = apr_pstrdup(ary->pool, arg);
return NULL;
}
/*------------------------------------------------------------*
* Apache-specific hooks into the module code *
* that are defined in the array 'mysql_lgog_module' (at EOF) *
*------------------------------------------------------------*/
/* Closing mysql link: child_exit(1.3), pool registration(2.0) */
#if defined(WITH_APACHE20)
static apr_status_t log_sql_close_link(void *data)
{
if (global_config.driver)
global_config.driver->disconnect(&global_config.db);
return APR_SUCCESS;
}
#elif defined(WITH_APACHE13)
static void log_sql_child_exit(server_rec *s, apr_pool_t *p)
{
if (global_config.driver)
global_config.driver->disconnect(&global_config.db);
}
#endif
/* Child Init */
#if defined(WITH_APACHE20)
static void log_sql_child_init(apr_pool_t *p, server_rec *s)
#elif defined(WITH_APACHE13)
static void log_sql_child_init(server_rec *s, apr_pool_t *p)
#endif
{
logsql_opendb_ret retval;
# if defined(WITH_APACHE20)
/* Register cleanup hook to close DDB connection (apache 2 doesn't have child_exit) */
apr_pool_cleanup_register(p, NULL, log_sql_close_link, log_sql_close_link);
# endif
/* Open a link to the database */
retval = log_sql_opendb_link(s);
switch (retval) {
case LOGSQL_OPENDB_FAIL:
if (global_config.driver==NULL) {
log_error(APLOG_MARK, APLOG_ERR, 0, s,
"mod_log_sql: Driver module not loaded");
} else {
log_error(APLOG_MARK, APLOG_ERR, 0, s,
"mod_log_sql: child spawned but unable to open database link");
}
break;
case LOGSQL_OPENDB_SUCCESS:
case LOGSQL_OPENDB_ALREADY:
log_error(APLOG_MARK,APLOG_DEBUG,0, s,
"mod_log_sql: open_logdb_link successful");
break;
case LOGSQL_OPENDB_PRESERVE:
log_error(APLOG_MARK,APLOG_DEBUG, 0, s,
"mod_log_sql: open_logdb_link said that preservation is forced");
break;
}
}
/* post_config / module_init */
#if defined(WITH_APACHE20)
static int log_sql_post_config(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
#elif defined(WITH_APACHE13)
static void log_sql_module_init(server_rec *s, apr_pool_t *p)
#endif
{
/* TODO: Add local_address, remote_address, server_name, connection_status */
/* Register handlers */
log_sql_register_item(s,p,'A', extract_agent, "agent", 1, 1);
log_sql_register_item(s,p,'a', extract_request_query, "request_args", 1, 1);
log_sql_register_item(s,p,'b', extract_bytes_sent, "bytes_sent", 0, 0);
log_sql_register_item(s,p,'c', extract_cookie, "cookie", 0, 1);
/* TODO: Document */
log_sql_register_item(s,p,'f', extract_request_file, "request_file", 0, 1);
log_sql_register_item(s,p,'H', extract_request_protocol, "request_protocol", 0, 1);
log_sql_register_item(s,p,'h', extract_remote_host, "remote_host", 0, 1);
log_sql_register_item(s,p,'I', extract_unique_id, "id", 0, 1);
log_sql_register_item(s,p,'l', extract_remote_logname, "remote_logname", 0, 1);
log_sql_register_item(s,p,'m', extract_request_method, "request_method", 0, 1);
log_sql_register_item(s,p,'M', extract_machine_id, "machine_id", 0, 1);
log_sql_register_item(s,p,'P', extract_child_pid, "child_pid", 0, 0);
log_sql_register_item(s,p,'p', extract_server_port, "server_port", 0, 0);
log_sql_register_item(s,p,'R', extract_referer, "referer", 1, 1);
log_sql_register_item(s,p,'r', extract_request_line, "request_line", 1, 1);
log_sql_register_item(s,p,'S', extract_request_timestamp, "time_stamp", 0, 0);
log_sql_register_item(s,p,'s', extract_status, "status", 1, 0);
log_sql_register_item(s,p,'T', extract_request_duration, "request_duration", 1, 0);
log_sql_register_item(s,p,'t', extract_request_time, "request_time", 0, 1);
log_sql_register_item(s,p,'u', extract_remote_user, "remote_user", 0, 1);
log_sql_register_item(s,p,'U', extract_request_uri, "request_uri", 1, 1);
log_sql_register_item(s,p,'x', extract_forwarded_for, "remote_host", 0, 1);
log_sql_register_item(s,p,'v', extract_virtual_host, "virtual_host", 0, 1);
log_sql_register_item(s,p,'V', extract_server_name, "virtual_host", 0, 1);
if (global_config.announce) {
ap_add_version_component(p, PACKAGE_NAME"/"PACKAGE_VERSION);
}
/* ap_server_root_relative any default preserve file locations */
{
server_rec *cur_s;
const char *default_p = ap_server_root_relative(p, DEFAULT_PRESERVE_FILE);
for (cur_s = s; cur_s != NULL; cur_s= cur_s->next) {
logsql_state *cls = ap_get_module_config(cur_s->module_config,
&log_sql_module);
if (cls->preserve_file == DEFAULT_PRESERVE_FILE)
cls->preserve_file = default_p;
}
}
global_config.db.p = p;
#if defined(WITH_APACHE20)
return OK;
#endif
}
/* This function handles calling the DB module, handling errors
* of missing tables and lost DB connections, and falling back to
* preserving the DB query.
*
* Parms: request record, table type, table name, and the full SQL command
*/
static logsql_query_ret safe_sql_insert(request_rec *r, logsql_tabletype table_type,
const char *table_name, const char *query) {
logsql_query_ret result;
logsql_state *cls = ap_get_module_config(r->server->module_config,
&log_sql_module);
if (!global_config.db.connected || global_config.driver == NULL) {
/* preserve query */
return LOGSQL_QUERY_NOLINK;
}
result = global_config.driver->insert(r,&global_config.db,query);
/* If we ran the query and it returned an error, try to be robust.
* (After all, the module thought it had a valid mysql_log connection but the query
* could have failed for a number of reasons, so we have to be extra-safe and check.) */
switch (result) {
case LOGSQL_QUERY_SUCCESS:
return LOGSQL_QUERY_SUCCESS;
case LOGSQL_QUERY_NOLINK:
return LOGSQL_QUERY_FAIL;
/* TODO: What do we do here */
case LOGSQL_QUERY_FAIL:
global_config.driver->disconnect(&global_config.db);
global_config.db.connected = 0;
/* re-open the connection and try again */
if (log_sql_opendb_link(r->server) != LOGSQL_OPENDB_FAIL) {
log_error(APLOG_MARK,APLOG_NOTICE,0, r->server,"db reconnect successful");
# if defined(WITH_APACHE20)
apr_sleep(apr_time_from_sec(0.25)); /* pause for a quarter second */
# elif defined(WITH_APACHE13)
# if defined(WIN32)
Sleep((DWORD)0.25);
# else
{
struct timespec delay, remainder;
int nanoret;
delay.tv_sec = 0;
delay.tv_nsec = 250000000; /* pause for a quarter second */
nanoret = nanosleep(&delay, &remainder);
if (nanoret && errno != EINTR) {
log_error(APLOG_MARK,APLOG_ERR, errno, r->server,"nanosleep unsuccessful");
}
}
# endif /* win32 */
# endif
result = global_config.driver->insert(r,&global_config.db,query);
if (result == LOGSQL_QUERY_SUCCESS) {
return LOGSQL_QUERY_SUCCESS;
} else {
log_error(APLOG_MARK,APLOG_ERR,0,r->server,"second attempt failed");
preserve_entry(r, query);
return LOGSQL_QUERY_PRESERVED;
}
} else {
log_error(APLOG_MARK,APLOG_ERR,0,r->server,
"reconnect failed, unable to reach database. SQL logging stopped until child regains a db connection.");
log_error(APLOG_MARK,APLOG_ERR,0,r->server,
"log entries are being preserved in %s",cls->preserve_file);
preserve_entry(r, query);
return LOGSQL_QUERY_PRESERVED;
}
break;
case LOGSQL_QUERY_NOTABLE:
if (global_config.createtables) {
log_error(APLOG_MARK,APLOG_ERR,0,r->server,
"table doesn't exist...creating now");
if ((result = global_config.driver->create_table(r, &global_config.db, table_type,
table_name))!=LOGSQL_TABLE_SUCCESS) {
log_error(APLOG_MARK,APLOG_ERR,result,r->server,
"child attempted but failed to create one or more tables for %s, preserving query", ap_get_server_name(r));
preserve_entry(r, query);
return LOGSQL_QUERY_PRESERVED;
} else {
log_error(APLOG_MARK,APLOG_ERR,result, r->server,
"tables successfully created - retrying query");
if ((result = global_config.driver->insert(r,&global_config.db,query))!=LOGSQL_QUERY_SUCCESS) {
log_error(APLOG_MARK,APLOG_ERR,result, r->server,
"giving up, preserving query");
preserve_entry(r, query);
return LOGSQL_QUERY_PRESERVED;
} else {
log_error(APLOG_MARK,APLOG_NOTICE,0, r->server,
"query successful after table creation");
return LOGSQL_QUERY_SUCCESS;
}
}
} else {
log_error(APLOG_MARK,APLOG_ERR,0,r->server,
"table doesn't exist, creation denied by configuration, preserving query");
preserve_entry(r, query);
return LOGSQL_QUERY_PRESERVED;
}
break;
default:
log_error(APLOG_MARK,APLOG_ERR,0, r->server,
"Invalid return code from mog_log_query");
return LOGSQL_QUERY_FAIL;
break;
}
return LOGSQL_QUERY_FAIL;
}
/* This function gets called to create a per-server configuration
* record. It will always be called for the main server and
* for each virtual server that is established. Each server maintains
* its own state that is separate from the others' states.
*
* The return value is a pointer to the created module-specific
* structure.
*/
static void *log_sql_make_state(apr_pool_t *p, server_rec *s)
{
logsql_state *cls = (logsql_state *) apr_pcalloc(p, sizeof(logsql_state));
/* These defaults are overridable in the httpd.conf file. */
cls->transfer_log_format = DEFAULT_TRANSFER_LOG_FMT;
apr_pool_create(&cls->parsed_pool, p);
cls->parsed_log_format = apr_pcalloc(cls->parsed_pool,
strlen(cls->transfer_log_format) * sizeof(logsql_item *));
cls->notes_table_name = DEFAULT_NOTES_TABLE_NAME;
cls->hin_table_name = DEFAULT_HIN_TABLE_NAME;
cls->hout_table_name = DEFAULT_HOUT_TABLE_NAME;
cls->cookie_table_name = DEFAULT_COOKIE_TABLE_NAME;
cls->preserve_file = DEFAULT_PRESERVE_FILE;
cls->transfer_ignore_list = apr_array_make(p, 1, sizeof(char *));
cls->transfer_accept_list = apr_array_make(p, 1, sizeof(char *));
cls->remhost_ignore_list = apr_array_make(p, 1, sizeof(char *));
cls->notes_list = apr_array_make(p, 1, sizeof(char *));
cls->hin_list = apr_array_make(p, 1, sizeof(char *));
cls->hout_list = apr_array_make(p, 1, sizeof(char *));
cls->cookie_list = apr_array_make(p, 1, sizeof(char *));
return (void *) cls;
}
/* Iterates through an array of char* and searches for a matching element
* Returns 0 if not found, 1 if found */
static int in_array(apr_array_header_t *ary, const char *elem)
{
int itr;
for (itr = 0; itr < ary->nelts; itr++) {
if (!strcmp(elem,((char **)ary->elts)[itr])) {
return 1;
}
}
return 0;
}
/* Parse through cookie lists and merge based on +/- prefixes */
/* TODO: rewrite as a function */
#define DO_MERGE_ARRAY(parent,child,pool) \
if (apr_is_empty_array(child)) { \
apr_array_cat(child, parent); \
} else { \
apr_array_header_t *addlist, *dellist; \
char **elem, **ptr = (char **)(child->elts); \
int itr, overwrite = 0; \
addlist = apr_array_make(pool,5,sizeof(char *)); \
dellist = apr_array_make(subp,5,sizeof(char *)); \
\
for (itr=0; itr<child->nelts; itr++) { \
if (*ptr[itr] == '+') { \
elem = (char **)apr_array_push(addlist); \
*elem = (ptr[itr]+1); \
} else if (*ptr[itr] == '-') { \
elem = (char **)apr_array_push(dellist); \
*elem = (ptr[itr]+1); \
} else { \
overwrite = 1; \
elem = (char **)apr_array_push(addlist); \
*elem = ptr[itr]; \
} \
} \
child = apr_array_make(p,1,sizeof(char *)); \
ptr = (char **)(parent->elts); \
if (overwrite==0) { \
/* if we are not overwriting the existing then prepare for merge */ \
for (itr=0; itr<parent->nelts; itr++) { \
if (!in_array(addlist, ptr[itr]) && !in_array(dellist,ptr[itr])) { \
elem = apr_array_push(child); \
*elem = apr_pstrdup(p, ptr[itr]); \
} \
} \
} \
apr_array_cat(child, addlist); \
}
static void *log_sql_merge_state(apr_pool_t *p, void *basev, void *addv)
{
/* Fetch the two states to merge */
logsql_state *parent = (logsql_state *) basev;
logsql_state *child = (logsql_state *) addv;
apr_pool_t *subp;
apr_pool_create(&subp,p);
/* Child can override these, otherwise they default to parent's choice.
* If the parent didn't set them, create reasonable defaults for the
* ones that should have such default settings. Leave the others null. */
/* No default for transfer_table_name because we want its absence
* to disable logging. */
if (!child->transfer_table_name) {
child->transfer_table_name = parent->transfer_table_name;
}
if (child->transfer_log_format == DEFAULT_TRANSFER_LOG_FMT) {
child->transfer_log_format = parent->transfer_log_format;
/*apr_pool_clear(child->parsed_pool);*/
child->parsed_log_format = apr_pcalloc(child->parsed_pool,
strlen(child->transfer_log_format) * sizeof(logsql_item *));
}
if (child->preserve_file == DEFAULT_PRESERVE_FILE)
child->preserve_file = parent->preserve_file;
/* server_root_relative the preserve file location */
if (child->preserve_file == DEFAULT_PRESERVE_FILE)
child->preserve_file = ap_server_root_relative(p, DEFAULT_PRESERVE_FILE);
if (child->notes_table_name == DEFAULT_NOTES_TABLE_NAME)
child->notes_table_name = parent->notes_table_name;
if (child->hin_table_name == DEFAULT_HIN_TABLE_NAME)
child->hin_table_name = parent->hin_table_name;
if (child->hout_table_name == DEFAULT_HOUT_TABLE_NAME)
child->hout_table_name = parent->hout_table_name;
if (child->cookie_table_name == DEFAULT_COOKIE_TABLE_NAME)
child->cookie_table_name = parent->cookie_table_name;
DO_MERGE_ARRAY(parent->transfer_ignore_list, child->transfer_ignore_list, subp);
DO_MERGE_ARRAY(parent->transfer_accept_list, child->transfer_accept_list, subp);
DO_MERGE_ARRAY(parent->remhost_ignore_list, child->remhost_ignore_list, subp);
DO_MERGE_ARRAY(parent->notes_list, child->notes_list, subp);
DO_MERGE_ARRAY(parent->hin_list, child->hin_list, subp);
DO_MERGE_ARRAY(parent->hout_list, child->hout_list, subp);
DO_MERGE_ARRAY(parent->cookie_list,child->cookie_list, subp);
apr_pool_destroy(subp);
if (!child->cookie_name)
child->cookie_name = parent->cookie_name;
return (void*) child;
}
/* Routine to perform the actual construction and execution of the relevant
* INSERT statements.
*/
static int log_sql_transaction(request_rec *orig)
{
char **ptrptr, **ptrptr2;
logsql_state *cls = ap_get_module_config(orig->server->module_config, &log_sql_module);
const char *access_query;
request_rec *r;
const char *transfer_tablename = cls->transfer_table_name;
const char *notes_tablename = cls->notes_table_name;
const char *hout_tablename = cls->hout_table_name;
const char *hin_tablename = cls->hin_table_name;
const char *cookie_tablename = cls->cookie_table_name;
if (global_config.driver == NULL) {
return OK;
}
/* We handle mass virtual hosting differently. Dynamically determine the name
* of the table from the virtual server's name, and flag it for creation.
*/
if (global_config.massvirtual) {
/* TODO: Make these configurable? */
char *access_base = "access_";
char *notes_base = "notes_";
char *hout_base = "headout_";
char *hin_base = "headin_";
char *cookie_base = "cookies_";
/* Determine the hostname and convert it to all lower-case; */
char *servername = apr_pstrdup(orig->pool,(char *)ap_get_server_name(orig));
char *p=servername;
while (*p) {
*p = apr_tolower(*p);
if (*p == '.') *p = '_';
if (*p == '-') *p = '_';
++p;
}
/* Find memory long enough to hold the table name + \0. */
transfer_tablename = apr_pstrcat(orig->pool, access_base, servername, NULL);
notes_tablename = apr_pstrcat(orig->pool, notes_base, servername, NULL);
hin_tablename = apr_pstrcat(orig->pool, hin_base, servername, NULL);
hout_tablename = apr_pstrcat(orig->pool, hout_base, servername, NULL);
cookie_tablename = apr_pstrcat(orig->pool, cookie_base, servername, NULL);
/* Tell this virtual server its transfer table name, and
* turn on create_tables, which is implied by massvirtual.
*/
global_config.createtables = 1;
}
/* Do we have enough info to log? */
if (!transfer_tablename) {
return DECLINED;
} else {
const char *thehost;
const char *theitem;
char *fields = "", *values = "";
char *itemsets = "";
char *note_query = NULL;
char *hin_query = NULL;
char *hout_query = NULL;
char *cookie_query = NULL;
const char *unique_id;
const char *formatted_item;
int i,length;
int proceed;
for (r = orig; r->next; r = r->next) {
continue;
}
/* The following is a stolen upsetting mess of pointers, I'm sorry.
* Anyone with the motiviation and/or the time should feel free
* to make this cleaner. :) */
ptrptr2 = (char **) (cls->transfer_accept_list->elts + (cls->transfer_accept_list->nelts * cls->transfer_accept_list->elt_size));
/* Go through each element of the accept list and compare it to the
* request_uri. If we don't get a match, return without logging */
if ((r->uri) && (cls->transfer_accept_list->nelts)) {
proceed = 0;
for (ptrptr = (char **) cls->transfer_accept_list->elts; ptrptr < ptrptr2; ptrptr = (char **) ((char *) ptrptr + cls->transfer_accept_list->elt_size))
if (ap_strstr(r->uri, *ptrptr)) {
proceed = 1;
break;
}
if (!proceed)
return OK;
}
/* Go through each element of the ignore list and compare it to the
* request_uri. If we get a match, return without logging */
ptrptr2 = (char **) (cls->transfer_ignore_list->elts + (cls->transfer_ignore_list->nelts * cls->transfer_ignore_list->elt_size));
if (r->uri) {
for (ptrptr = (char **) cls->transfer_ignore_list->elts; ptrptr < ptrptr2; ptrptr = (char **) ((char *) ptrptr + cls->transfer_ignore_list->elt_size))
if (ap_strstr(r->uri, *ptrptr)) {
return OK;
}
}
/* Go through each element of the ignore list and compare it to the
* remote host. If we get a match, return without logging */
ptrptr2 = (char **) (cls->remhost_ignore_list->elts + (cls->remhost_ignore_list->nelts * cls->remhost_ignore_list->elt_size));
thehost = ap_get_remote_host(r->connection, r->per_dir_config, REMOTE_NAME, NULL);
if (thehost) {
for (ptrptr = (char **) cls->remhost_ignore_list->elts; ptrptr < ptrptr2; ptrptr = (char **) ((char *) ptrptr + cls->remhost_ignore_list->elt_size))
if (ap_strstr(thehost, *ptrptr)) {
return OK;
}
}
/* Iterate through the format characters and set up the INSERT string according to
* what the user has configured. */
length = strlen(cls->transfer_log_format);
for (i = 0; i<length; i++) {
logsql_item *item = cls->parsed_log_format[i];
if (item==NULL) {
log_error(APLOG_MARK, APLOG_ERR, 0, orig->server,
"Log Format '%c' unknown",cls->transfer_log_format[i]);
continue;
}
/* Yes, this key is one of the configured keys.
* Call the key's function and put the returned value into 'formatted_item' */
formatted_item = item->func(item->want_orig_default ? orig : r, "");
/* Massage 'formatted_item' for proper SQL eligibility... */
if (!formatted_item) {
formatted_item = "";
} else if (formatted_item[0] == '-' && formatted_item[1] == '\0' && !item->string_contents) {
/* If apache tried to log a '-' character for a numeric field, convert that to a zero
* because the database expects a numeral and will reject the '-' character. */
formatted_item = "0";
}
/* Append the fieldname and value-to-insert to the appropriate strings, quoting stringvals with ' as appropriate */
fields = apr_pstrcat(r->pool, fields, (i ? "," : ""),
item->sql_field_name, NULL);
values = apr_pstrcat(r->pool, values, (i ? "," : ""),
global_config.driver->escape(formatted_item, r->pool,&global_config.db), NULL);
}
/* Work through the list of notes defined by LogSQLWhichNotes */
i = 0;
unique_id = extract_unique_id(r, "");
ptrptr2 = (char **) (cls->notes_list->elts + (cls->notes_list->nelts * cls->notes_list->elt_size));
for (ptrptr = (char **) cls->notes_list->elts; ptrptr < ptrptr2; ptrptr = (char **) ((char *) ptrptr + cls->notes_list->elt_size)) {
/* If the specified note (*ptrptr) exists for the current request... */
if ((theitem = apr_table_get(r->notes, *ptrptr))) {
itemsets = apr_pstrcat(r->pool, itemsets,
(i > 0 ? "," : ""),
"(",
global_config.driver->escape(unique_id, r->pool, &global_config.db),
",",
global_config.driver->escape(*ptrptr, r->pool,&global_config.db),
",",
global_config.driver->escape(theitem, r->pool,&global_config.db),
")",
NULL);
i++;
}
}
if ( *itemsets != '\0' ) {
note_query = apr_psprintf(r->pool, "insert %s into %s (id, item, val) values %s",
/*global_config.insertdelayed?"delayed":*/"", notes_tablename, itemsets);
log_error(APLOG_MARK,APLOG_DEBUG,0, orig->server,"mod_log_sql: note string: %s", note_query);
}
/* Work through the list of headers-out defined by LogSQLWhichHeadersOut*/
i = 0;
itemsets = "";
ptrptr2 = (char **) (cls->hout_list->elts + (cls->hout_list->nelts * cls->hout_list->elt_size));
for (ptrptr = (char **) cls->hout_list->elts; ptrptr < ptrptr2; ptrptr = (char **) ((char *) ptrptr + cls->hout_list->elt_size)) {
/* If the specified header (*ptrptr) exists for the current request... */
if ((theitem = apr_table_get(r->headers_out, *ptrptr))) {
itemsets = apr_pstrcat(r->pool, itemsets,
(i > 0 ? "," : ""),
"(",
global_config.driver->escape(unique_id, r->pool, &global_config.db),
",",
global_config.driver->escape(*ptrptr, r->pool,&global_config.db),
",",
global_config.driver->escape(theitem, r->pool,&global_config.db),
")",
NULL);
i++;
}
}
if ( *itemsets != '\0' ) {
hout_query = apr_psprintf(r->pool, "insert %s into %s (id, item, val) values %s",
/*global_config.insertdelayed?"delayed":*/"", hout_tablename, itemsets);
log_error(APLOG_MARK,APLOG_DEBUG,0, orig->server,"mod_log_sql: header_out string: %s", hout_query);
}
/* Work through the list of headers-in defined by LogSQLWhichHeadersIn */
i = 0;
itemsets = "";
ptrptr2 = (char **) (cls->hin_list->elts + (cls->hin_list->nelts * cls->hin_list->elt_size));
for (ptrptr = (char **) cls->hin_list->elts; ptrptr < ptrptr2; ptrptr = (char **) ((char *) ptrptr + cls->hin_list->elt_size)) {
/* If the specified header (*ptrptr) exists for the current request... */
if ((theitem = apr_table_get(r->headers_in, *ptrptr))) {
itemsets = apr_pstrcat(r->pool, itemsets,
(i > 0 ? "," : ""),
"(",
global_config.driver->escape(unique_id, r->pool, &global_config.db),
",",
global_config.driver->escape(*ptrptr, r->pool,&global_config.db),
",",
global_config.driver->escape(theitem, r->pool,&global_config.db),
")",
NULL);