-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmod_autorotate.c
1749 lines (1399 loc) · 54.5 KB
/
mod_autorotate.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_autorotate.c,v 10.3 2010/07/02 10:28:26 jascott Exp $
* vi:set tabstop=4 sw=4:
*
* mod_autorotate: Automatically rotate Apache log files
* contact: [email protected]
* see: http://www.poptart.org/bin/view/Poptart/ModAutorotate
*
* Original work Copyright (c) 2010 Morgan Stanley
*
* Requires Apache 2.2
*
* Compiling: apxs -c mod_autorotate.c
* You need a C99 compatible compiler!
* This file is licensed to you under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* -------------------------------------------------------------------------- */
#include "apr_time.h"
#include "apr_strings.h"
#include "httpd.h"
#include "http_config.h"
#include "http_log.h"
#include "mpm_common.h"
#include "scoreboard.h"
#include <unistd.h>
/* --------- Forward declarations ---------------------------------------*/
// Max length of a rotated log file name
#define FORMAT_SZ 256
module AP_MODULE_DECLARE_DATA autorotate_module;
/* --------- Configuration structures --------------------------------------*/
/* Valid rotate periods */
typedef enum
{
HOURLY = 0,
DAILY,
WEEKLY,
MONTHLY,
#if defined(ENABLE_PERMINUTE)
PERMINUTE /* for testing */
#endif
} rotate_interval_t;
/* Map human readable periods to our enum */
typedef struct
{
const char *szPeriod;
rotate_interval_t ePeriod;
} period_map_t;
/* Restart methods */
typedef enum
{
GRACEFUL = 0,
FULL
} restartmethod_t;
typedef struct
{
apr_pool_t *pPool; /* Sub-pool used during compress operations */
apr_proc_t *pProc; /* Gzip process */
const char *szLogPath; /* The log currently being compressed */
/* Queue of log files awaiting compression */
apr_array_header_t *aCompressQueue;
/* Compression program */
const char *szCompressProgram;
/* Nice level */
int nNiceLevel;
} compress_child_info_t;
/* Directives from other modules that define log files */
typedef struct
{
const char *szDirective;
int nArgIndex;
} directive_map_t;
/* List of directives */
typedef struct _directive_map_list
{
directive_map_t sDirective;
struct _directive_map_list *pNext;
} directive_map_list_t;
/* Per-server configuration set */
typedef struct
{
/* Do nothing if we're disabled */
int bEnabled;
/* Rotate period */
rotate_interval_t eInterval;
/* Period offset in microseconds, may be negative */
apr_int64_t nOffset;
/* Rotated logfile suffix format */
char szFormat[FORMAT_SZ + 1];
/* List of log files that we are working with */
apr_array_header_t *aLogFiles;
/* Time that the next rotate is due */
apr_time_t tNextRotate;
/* Don't rotate or compress anything when this is set */
int bIsRotating;
/* How to restart - full or graceful */
restartmethod_t eRestartMethod;
/* Number of logs to keep */
int nKeepLogs;
/*
* Compression related params
*/
/* Path to compress program */
char szCompressProgram[APR_PATH_MAX + 1];
/* Compressed file suffix */
char szCompressSuffix[APR_PATH_MAX + 1];
/* Compress after this number of rotates */
int nCompressAfter;
/* Information about pending compressions */
compress_child_info_t compressInfo;
/* List of extra directives */
directive_map_list_t *pDirectiveList;
} autorotate_config_t;
typedef void child_cb_func_t(int, void *, int);
/* --------- Constants ----------------------------------------------------*/
static const char *DEFAULT_FORMAT = "%Y%m%d-%H:%M:%S";
static const char *DEFAULT_COMPRESS_PROGRAM = "/usr/bin/gzip";
static const char *DEFAULT_COMPRESS_SUFFIX = ".gz";
static const period_map_t PERIOD_MAP[] = {
{"Hourly", HOURLY},
{"Daily", DAILY},
{"Weekly", WEEKLY},
{"Monthly", MONTHLY},
#if defined(ENABLE_PERMINUTE)
{"PerMinute", PERMINUTE},
#endif
{NULL}
};
/* Directives that we know define log files */
static const directive_map_t DIRECTIVE_MAP[] = {
/* Core */
{"ErrorLog", 1},
/* mod_log_config */
{"CustomLog", 1},
{"CookieLog", 1},
{"TransferLog", 1},
/* mod_log_forensic */
{"ForensicLog", 1},
/* mod_rewrite */
{"RewriteLog", 1},
/* mod_cgi */
{"ScriptLog", 1},
{NULL}
};
/* --------- Prototypes ---------------------------------------------------*/
/* Directive handlers and helpers */
static const char *cmd_rotate_enabled(cmd_parms * pCmd, void *pDummy,
int nArg);
static const char *cmd_add_log_directive(cmd_parms * pCmd, void *pDummy,
const char *szArg1,
const char *szArg2);
static const char *cmd_add_log_file(cmd_parms * pCmd, void *pDummy,
const char *szArg1);
static const char *cmd_rotate_period(cmd_parms * pCmd, void *pDummy,
const char *szArg);
static const char *cmd_rotate_offset(cmd_parms * pCmd, void *pDummy,
const char *szArg);
static const char *cmd_rotate_format(cmd_parms * pCmd, void *pDummy,
const char *szArg);
static const char *cmd_rotate_compress(cmd_parms * pCmd, void *pDummy,
const char *szArg);
static const char *cmd_rotate_compresssuffix(cmd_parms * pCmd, void *pDummy,
const char *szArg);
static const char *cmd_rotate_nicelevel(cmd_parms * pCmd, void *pDummy,
const char *szArg);
static const char *cmd_rotate_restartmethod(cmd_parms * pCmd, void *pDummy,
const char *szArg);
static const char *cmd_rotate_keep(cmd_parms * pCmd, void *pDummy,
const char *szArg);
static const char *cmd_rotate_compressafter(cmd_parms * pCmd, void *pDummy,
const char *szArg);
/* Hook handlers */
static int monitor_func(apr_pool_t * p);
static int open_logs_func(apr_pool_t * pconf, apr_pool_t * plog,
apr_pool_t * ptemp, server_rec * s);
/* Module initializers */
static void register_hooks(apr_pool_t * p);
static void *create_autorotate_config(apr_pool_t * pPool,
server_rec * pServer);
/* Utilities */
static void append_log_directive_list(directive_map_list_t ** ppItem,
apr_pool_t * pool,
const char *szDirective, int nPosition);
static apr_time_t period_start(int nCount, rotate_interval_t ePeriod);
static apr_time_t offset_period_start(int nCount, rotate_interval_t ePeriod,
apr_int64_t nOffset);
static char *get_word(apr_pool_t * pool, int nWord, const char *szArgs);
static void find_log_names(autorotate_config_t * pConfig, apr_pool_t * pool,
server_rec * s, apr_table_t * tLogFiles,
ap_directive_t * node);
static int check_logfile_dates(apr_pool_t * ptemp, server_rec * s,
apr_array_header_t * aFiles);
static rotate_interval_t valid_period(const char *szPeriod);
static int is_fully_restarted(apr_pool_t * p);
static int do_rotate(apr_pool_t * p, apr_array_header_t * aList);
static int do_prune(apr_pool_t * p);
static void record_next_rotate_time(apr_pool_t * ptemp,
autorotate_config_t * pConfig);
static void restart_server(apr_pool_t * ptemp, autorotate_config_t * pConfig);
static apr_status_t run_next_compress_child(compress_child_info_t * pData);
static child_cb_func_t compress_cb_func;
static int create_compress_queue(apr_pool_t * pconf, apr_pool_t * ptemp,
autorotate_config_t * pConfig);
/* --------- Configuration directive handlers -----------------------------*/
/* Nasty. The monitor hook doesn't have access to a server_rec so keep this
* global populated
*/
static autorotate_config_t *pgConfigData = NULL;
/* --------- Configuration directive handlers -----------------------------*/
/*
* Returns the rotate period given a string representing that period
* Returns -1 if the given string is invalid
*/
static rotate_interval_t valid_period(const char *szPeriod)
{
const period_map_t *pMap = PERIOD_MAP;
AP_DEBUG_ASSERT(szPeriod != NULL);
/* Iterate the period map looking for a match */
while (pMap->szPeriod) {
if (apr_strnatcasecmp(pMap->szPeriod, szPeriod) == 0) {
return pMap->ePeriod;
}
pMap++;
}
/* No match */
return -1;
}
/*
* Create the per-server config record
*/
static void *create_autorotate_config(apr_pool_t * pPool,
server_rec * pServer)
{
autorotate_config_t *pConfig;
AP_DEBUG_ASSERT(pPool != NULL);
pConfig = apr_pcalloc(pPool, sizeof(autorotate_config_t));
ap_log_error(APLOG_MARK, APLOG_DEBUG, OK, pServer,
"create_rotate_config called for %s server",
pServer->is_virtual ? "vhost" : "main");
pConfig->bEnabled = 0;
pConfig->eInterval = MONTHLY;
pConfig->nOffset = 0;
apr_cpystrn(pConfig->szFormat, DEFAULT_FORMAT, FORMAT_SZ);
apr_cpystrn(pConfig->szCompressProgram, DEFAULT_COMPRESS_PROGRAM,
APR_PATH_MAX);
apr_cpystrn(pConfig->szCompressSuffix, DEFAULT_COMPRESS_SUFFIX,
APR_PATH_MAX);
/* Initialize array of logfile names */
pConfig->aLogFiles = apr_array_make(pPool, 5, sizeof(char *));
pConfig->tNextRotate = 0;
pConfig->bIsRotating = 0;
pConfig->eRestartMethod = GRACEFUL;
pConfig->nKeepLogs = 0;
pConfig->nCompressAfter = 1;
pConfig->compressInfo.pPool = NULL;
pConfig->compressInfo.pProc = NULL;
pConfig->compressInfo.szLogPath = NULL;
pConfig->compressInfo.aCompressQueue = NULL;
pConfig->compressInfo.nNiceLevel = 5;
pConfig->pDirectiveList = NULL;
/* Initialize the directive list from the static mapping */
const directive_map_t *pEntry;
for (pEntry = DIRECTIVE_MAP; pEntry->szDirective; pEntry++) {
append_log_directive_list(&pConfig->pDirectiveList,
pPool,
pEntry->szDirective, pEntry->nArgIndex);
}
return pConfig;
}
/*
* Process the 'AutorotateEnabled' directive
*/
static const char *cmd_rotate_enabled(cmd_parms * pCmd, void *pDummy,
int nArg)
{
autorotate_config_t *pConfig;
AP_DEBUG_ASSERT(pCmd != NULL);
pConfig = ap_get_module_config(pCmd->server->module_config,
&autorotate_module);
AP_DEBUG_ASSERT(pConfig != NULL);
if (pCmd->server->is_virtual) {
return "AutorotateEnabled only supported in the main server";
}
pConfig->bEnabled = nArg;
return NULL;
}
static const char *cmd_add_log_file(cmd_parms * pCmd, void *pDummy,
const char *szArg1)
{
autorotate_config_t *pConfig;
AP_DEBUG_ASSERT(pCmd != NULL);
AP_DEBUG_ASSERT(szArg1 != NULL);
pConfig = ap_get_module_config(pCmd->server->module_config,
&autorotate_module);
AP_DEBUG_ASSERT(pConfig != NULL);
if (pCmd->server->is_virtual) {
return "AutorotateAddLogFile only supported in the main server";
}
*(const char **) apr_array_push(pConfig->aLogFiles) =
apr_pstrdup(pCmd->pool, szArg1);
return NULL;
}
/*
* Process the 'AutorotateAddLogDirective' directive
*/
static const char *cmd_add_log_directive(cmd_parms * pCmd, void *pDummy,
const char *szArg1,
const char *szArg2)
{
autorotate_config_t *pConfig;
AP_DEBUG_ASSERT(pCmd != NULL);
AP_DEBUG_ASSERT(szArg1 != NULL);
AP_DEBUG_ASSERT(szArg2 != NULL);
pConfig = ap_get_module_config(pCmd->server->module_config,
&autorotate_module);
AP_DEBUG_ASSERT(pConfig != NULL);
if (pCmd->server->is_virtual) {
return "AutorotateAddLogDirective only supported in the main server";
}
int nPosition = 1;
if (szArg2) {
char *szEnd;
nPosition = strtol(szArg2, &szEnd, 10);
if (*szArg2 != '\0' && *szEnd == '\0' && nPosition > 0) {
/* OK */
}
else {
return "Invalid position for directive";
}
}
append_log_directive_list(&pConfig->pDirectiveList, pCmd->pool, szArg1,
nPosition);
return NULL;
}
/*
* Append a log directive name/param-position structure to the end of the
* given directive map list
*/
void
append_log_directive_list(directive_map_list_t ** ppItem, apr_pool_t * pool,
const char *szDirective, int nPosition)
{
/* Find the end of the linked list, whilst trying not to get too confused
* about the pointer-to-a-pointer stuff!
*/
while (*ppItem) {
/* for debugging append code
ap_log_perror(APLOG_MARK, APLOG_ERR, OK, pool,
"mod_autorotate: Appending [%s], current item: [%s]",
szDirective, (*ppItem)->sDirective.szDirective );
*/
ppItem = &(*ppItem)->pNext;
}
/* Allocate and populate a new entry */
*ppItem = apr_pcalloc(pool, sizeof(directive_map_list_t));
(*ppItem)->pNext = NULL;
(*ppItem)->sDirective.szDirective = apr_pstrdup(pool, szDirective);
(*ppItem)->sDirective.nArgIndex = nPosition;
}
/*
* Process the 'AutorotatePeriod' directive
*/
static const char *cmd_rotate_period(cmd_parms * pCmd, void *pDummy,
const char *szArg)
{
autorotate_config_t *pConfig;
rotate_interval_t ePeriod;
AP_DEBUG_ASSERT(pCmd != NULL);
AP_DEBUG_ASSERT(szArg != NULL);
pConfig = ap_get_module_config(pCmd->server->module_config,
&autorotate_module);
AP_DEBUG_ASSERT(pConfig != NULL);
if (pCmd->server->is_virtual) {
return "AutorotatePeriod only supported in the main server";
}
/* Turn the string into a period identifier */
ePeriod = valid_period(szArg);
if (ePeriod == -1) {
return apr_psprintf(pCmd->temp_pool,
"Invalid rotate period [%s].", szArg);
}
else {
pConfig->eInterval = ePeriod;
}
return NULL;
}
/*
* Process the 'AutorotateOffset' directive
*/
static const char *cmd_rotate_offset(cmd_parms * pCmd, void *pDummy,
const char *szArg)
{
autorotate_config_t *pConfig;
apr_int64_t nOffset;
AP_DEBUG_ASSERT(pCmd != NULL);
AP_DEBUG_ASSERT(szArg != NULL);
pConfig = ap_get_module_config(pCmd->server->module_config,
&autorotate_module);
AP_DEBUG_ASSERT(pConfig != NULL);
if (pCmd->server->is_virtual) {
return "AutorotateOffset only supported in the main server";
}
nOffset = apr_atoi64(szArg);
if (errno == ERANGE) {
return "AutorotateOffset out of range";
}
pConfig->nOffset = apr_time_from_sec(nOffset);
return NULL;
}
/*
* Process the 'AutorotateFormat' directive
*/
static const char *cmd_rotate_format(cmd_parms * pCmd, void *pDummy,
const char *szArg)
{
autorotate_config_t *pConfig;
AP_DEBUG_ASSERT(pCmd != NULL);
AP_DEBUG_ASSERT(szArg != NULL);
pConfig = ap_get_module_config(pCmd->server->module_config,
&autorotate_module);
AP_DEBUG_ASSERT(pConfig != NULL);
if (pCmd->server->is_virtual) {
return "AutorotateFormat only supported in the main server";
}
apr_cpystrn(pConfig->szFormat, szArg, FORMAT_SZ);
return NULL;
}
/*
* Process the 'AutorotateCompressProgram' directive
*/
static const char *cmd_rotate_compress(cmd_parms * pCmd, void *pDummy,
const char *szArg)
{
autorotate_config_t *pConfig;
AP_DEBUG_ASSERT(pCmd != NULL);
AP_DEBUG_ASSERT(szArg != NULL);
pConfig = ap_get_module_config(pCmd->server->module_config,
&autorotate_module);
AP_DEBUG_ASSERT(pConfig != NULL);
if (pCmd->server->is_virtual) {
return "AutorotateCompressProgram only supported in the main server";
}
apr_cpystrn(pConfig->szCompressProgram, szArg, APR_PATH_MAX);
return NULL;
}
/*
* Process the 'AutorotateCompressSuffix' directive
*/
static const char *cmd_rotate_compresssuffix(cmd_parms * pCmd, void *pDummy,
const char *szArg)
{
autorotate_config_t *pConfig;
AP_DEBUG_ASSERT(pCmd != NULL);
AP_DEBUG_ASSERT(szArg != NULL);
pConfig = ap_get_module_config(pCmd->server->module_config,
&autorotate_module);
AP_DEBUG_ASSERT(pConfig != NULL);
if (pCmd->server->is_virtual) {
return "AutorotateCompressProgram only supported in the main server";
}
apr_cpystrn(pConfig->szCompressSuffix, szArg, APR_PATH_MAX);
return NULL;
}
/*
* Process the 'AutorotateCompressNiceLevel' directive
*/
static const char *cmd_rotate_nicelevel(cmd_parms * pCmd, void *pDummy,
const char *szArg)
{
autorotate_config_t *pConfig;
AP_DEBUG_ASSERT(pCmd != NULL);
AP_DEBUG_ASSERT(szArg != NULL);
pConfig = ap_get_module_config(pCmd->server->module_config,
&autorotate_module);
AP_DEBUG_ASSERT(pConfig != NULL);
if (pCmd->server->is_virtual) {
return
"AutorotateCompressNiceLevel only supported in the main server";
}
char *szEnd;
int nNice = strtol(szArg, &szEnd, 10);
if (*szArg != '\0' && *szEnd == '\0' && nNice >= 0) {
pConfig->compressInfo.nNiceLevel = nNice;
}
else {
return "Invalid compress nice level";
}
return NULL;
}
/*
* Process the 'AutorotateRestartMethod' directive
*/
static const char *cmd_rotate_restartmethod(cmd_parms * pCmd, void *pDummy,
const char *szArg)
{
autorotate_config_t *pConfig;
AP_DEBUG_ASSERT(pCmd != NULL);
AP_DEBUG_ASSERT(szArg != NULL);
pConfig = ap_get_module_config(pCmd->server->module_config,
&autorotate_module);
AP_DEBUG_ASSERT(pConfig != NULL);
if (pCmd->server->is_virtual) {
return "AutorotateRestartMethod only supported in the main server";
}
if (apr_strnatcasecmp(szArg, "Full") == 0) {
pConfig->eRestartMethod = FULL;
return NULL;
}
if (apr_strnatcasecmp(szArg, "Graceful") == 0) {
pConfig->eRestartMethod = GRACEFUL;
return NULL;
}
return "AutorotateRestartMethod must be \"Full\" or \"Graceful\"";
}
/*
* Process the 'AutorotateKeep' directive
*/
static const char *cmd_rotate_keep(cmd_parms * pCmd, void *pDummy,
const char *szArg)
{
autorotate_config_t *pConfig;
AP_DEBUG_ASSERT(pCmd != NULL);
AP_DEBUG_ASSERT(szArg != NULL);
pConfig = ap_get_module_config(pCmd->server->module_config,
&autorotate_module);
AP_DEBUG_ASSERT(pConfig != NULL);
if (pCmd->server->is_virtual) {
return "AutorotateKeep only supported in the main server";
}
apr_int64_t nKeep = apr_atoi64(szArg);
if (errno == ERANGE || nKeep < 0) {
return "AutorotateKeep out of range";
}
pConfig->nKeepLogs = nKeep;
return NULL;
}
/*
* Process the 'AutorotateCompressAfter' directive
*/
static const char *cmd_rotate_compressafter(cmd_parms * pCmd, void *pDummy,
const char *szArg)
{
autorotate_config_t *pConfig;
AP_DEBUG_ASSERT(pCmd != NULL);
AP_DEBUG_ASSERT(szArg != NULL);
pConfig = ap_get_module_config(pCmd->server->module_config,
&autorotate_module);
AP_DEBUG_ASSERT(pConfig != NULL);
if (pCmd->server->is_virtual) {
return "AutorotateCompressAfter only supported in the main server";
}
apr_int64_t nAfter = apr_atoi64(szArg);
if (errno == ERANGE || nAfter < 0) {
return "AutorotateRotateAfter out of range";
}
pConfig->nCompressAfter = nAfter;
return NULL;
}
/*
* Handler for the 'monitor' hook
*
* Runs every 10 seconds in the caretaker process.
* Make sure that this routine is kept light weight!
*/
static int monitor_func(apr_pool_t * p)
{
AP_DEBUG_ASSERT(pgConfigData != NULL);
AP_DEBUG_ASSERT(p != NULL);
/* Why wouldn't we have a valid global config ? */
if (pgConfigData == NULL) {
ap_log_perror(APLOG_MARK, APLOG_ERR, OK, p,
"mod_autorotate: NULL configuration found - bug?");
return HTTP_INTERNAL_SERVER_ERROR;
}
/* Do nothing if we're not enabled */
if (!pgConfigData->bEnabled)
return DECLINED;
/* Do nothing if we're currently rotating */
if (pgConfigData->bIsRotating)
return DECLINED;
/* Don't do anything until the server is fully restarted */
if (!is_fully_restarted(p)) {
return DECLINED;
}
/* Check if a rotate is due */
apr_time_t tNow = apr_time_now();
if (tNow >= pgConfigData->tNextRotate) {
ap_log_perror(APLOG_MARK, APLOG_NOTICE, OK, p,
"mod_autorotate: Log rotation now due");
/* Prune old logs */
do_prune(p);
/* Rotate and record whether we need a restart */
int nNeedRestart = do_rotate(p, NULL);
/* Signal a restart if we rotated any files */
if (nNeedRestart) {
restart_server(p, pgConfigData);
}
record_next_rotate_time(p, pgConfigData);
}
/* Start compressing if something has filled the queue
* and it hasn't started yet */
if ((pgConfigData->compressInfo.aCompressQueue != NULL) &&
(pgConfigData->compressInfo.szLogPath == NULL)) {
pgConfigData->compressInfo.szCompressProgram =
pgConfigData->szCompressProgram;
run_next_compress_child(&pgConfigData->compressInfo);
}
return OK;
}
static void restart_server(apr_pool_t * ptemp, autorotate_config_t * pConfig)
{
AP_DEBUG_ASSERT(pConfig != NULL);
AP_DEBUG_ASSERT(ptemp != NULL);
if (pConfig->eRestartMethod == GRACEFUL) {
ap_log_perror(APLOG_MARK, APLOG_NOTICE, OK, ptemp,
"mod_autorotate: Requesting graceful restart");
kill(getpid(), AP_SIG_GRACEFUL);
}
else {
ap_log_perror(APLOG_MARK, APLOG_NOTICE, OK, ptemp,
"mod_autorotate: Requesting FULL restart");
kill(getpid(), SIGHUP);
}
}
/*
* Remove old log files
*/
static int do_prune(apr_pool_t * p)
{
AP_DEBUG_ASSERT(pgConfigData != NULL);
AP_DEBUG_ASSERT(p != NULL);
/* Decline to prune if KeepLogs is zero */
if (pgConfigData->nKeepLogs == 0) {
ap_log_perror(APLOG_MARK, APLOG_NOTICE, OK, p,
"mod_autorotate: Log pruning disabled");
return OK;
}
pgConfigData->bIsRotating = 1;
ap_log_perror(APLOG_MARK, APLOG_DEBUG, OK, p,
"mod_autorotate: Pruning logs");
char *szSuffix = apr_pcalloc(p, 256);
/* Cycle through the log files */
int i;
char **pszLogFiles = (char **) pgConfigData->aLogFiles->elts;
for (i = 0; i < pgConfigData->aLogFiles->nelts; i++) {
/* File might be relative to server root */
const char *szOrigName = ap_server_root_relative(p, pszLogFiles[i]);
const char *szNewName = NULL;
/* go back one period at a time, decrementing the number to keep
* each time a log exists for that previous period. After we get to
* zero, start deleting for subsequent periods */
int nCurrentPeriod = -1;
int nNumFound = 0;
for (nCurrentPeriod = -1; nCurrentPeriod > -100; nCurrentPeriod--) {
apr_time_t tStart = offset_period_start(nCurrentPeriod,
pgConfigData->eInterval,
pgConfigData->nOffset);
apr_time_exp_t tExp;
apr_time_exp_lt(&tExp, tStart);
apr_size_t nSuffixLen;
apr_strftime(szSuffix, &nSuffixLen, 255,
pgConfigData->szFormat, &tExp);
szNewName = apr_psprintf(p, "%s.%s", szOrigName, szSuffix);
/* Check if a log exists for this previous period */
apr_finfo_t fs;
apr_status_t nStatus =
apr_stat(&fs, szNewName, APR_FINFO_MTIME, p);
if (nStatus == OK) { /* File exists */
nNumFound++;
if (nNumFound >= pgConfigData->nKeepLogs) {
nStatus = apr_file_remove(szNewName, p);
if (nStatus == APR_SUCCESS) {
ap_log_perror(APLOG_MARK, APLOG_NOTICE, OK, p,
"mod_autorotate: Removed %s",
szNewName);
}
else {
ap_log_perror(APLOG_MARK, APLOG_ERR, nStatus, p,
"mod_autorotate: removing %s ",
szNewName);
}
}
}
szNewName = apr_psprintf(p, "%s.%s%s", szOrigName, szSuffix,
pgConfigData->szCompressSuffix);
nStatus = apr_stat(&fs, szNewName, APR_FINFO_MTIME, p);
if (nStatus == OK) { /* File exists */
nNumFound++;
if (nNumFound >= pgConfigData->nKeepLogs) {
nStatus = apr_file_remove(szNewName, p);
if (nStatus == APR_SUCCESS) {
ap_log_perror(APLOG_MARK, APLOG_NOTICE, OK, p,
"mod_autorotate: Removed %s",
szNewName);
}
else {
ap_log_perror(APLOG_MARK, APLOG_ERR, nStatus, p,
"mod_autorotate: removing %s ",
szNewName);
}
}
}
} /* End for (period) */
} /* End for (log file) */
pgConfigData->bIsRotating = 0;
}
/*
* Rotate the log files, and return whether we did anything or not
*/
static int do_rotate(apr_pool_t * p, apr_array_header_t * aList)
{
AP_DEBUG_ASSERT(pgConfigData != NULL);
AP_DEBUG_ASSERT(p != NULL);
int nNumRotated = 0;
apr_status_t nStatus;
ap_log_perror(APLOG_MARK, APLOG_NOTICE, OK, p,
"mod_autorotate: Rotating logs");
pgConfigData->bIsRotating = 1;
/* Start of the current period -+ offset */
apr_time_t tStart = offset_period_start(-1, pgConfigData->eInterval,
pgConfigData->nOffset);
apr_time_exp_t tExp;
apr_time_exp_lt(&tExp, tStart);
/* Suffix to append to log file names */
char *szSuffix = apr_pcalloc(p, 256);
apr_size_t nSuffixLen;
apr_strftime(szSuffix, &nSuffixLen, 255, pgConfigData->szFormat, &tExp);
ap_log_perror(APLOG_MARK, APLOG_DEBUG, OK, p,
"log file suffix: %s", szSuffix);
/* Array of log files to use might be specified */
if (!aList) {
aList = pgConfigData->aLogFiles;
}
/* Cycle through the log files */
char **pszLogFiles = (char **) aList->elts;
int i;
for (i = 0; i < aList->nelts; i++) {
/* File might be relative to server root */
const char *szOrigName = ap_server_root_relative(p, pszLogFiles[i]);
const char *szNewName =
apr_psprintf(p, "%s.%s", szOrigName, szSuffix);
/* Do nothing if the source doesn't exist */
apr_finfo_t fs;
nStatus = apr_stat(&fs, szOrigName, APR_FINFO_MTIME, p);
if (APR_STATUS_IS_ENOENT(nStatus)) { /* File doesn't exist */
ap_log_perror(APLOG_MARK, APLOG_DEBUG, OK, p,
"no file %s to rotate", szOrigName);
continue;
}
/* Do nothing if the destination already exists */
nStatus = apr_stat(&fs, szNewName, APR_FINFO_MTIME, p);
if (nStatus == OK) { /* File exists */
ap_log_perror(APLOG_MARK, APLOG_WARNING, OK, p,
"mod_autorotate: destination already exists: %s ",
szNewName);
continue;
};
nStatus = apr_file_rename(szOrigName, szNewName, p);
if (nStatus == APR_SUCCESS) {
ap_log_perror(APLOG_MARK, APLOG_INFO, OK, p,
"mod_autorotate: Renamed %s to %s ", szOrigName,
szNewName);
nNumRotated++;
}
else {
ap_log_perror(APLOG_MARK, APLOG_ERR, nStatus, p,
"mod_autorotate: renaming %s to %s ", szOrigName,
szNewName);
}
}
pgConfigData->bIsRotating = 0;
return (nNumRotated ? 1 : 0);
}
/*
* Checks whether all children are from the server's current generation
* If they're not then we've just been gracefully restarted and there are
* still some children left finishing old requests
*/