src/lib/event-log.c

	event-log.c revision d1990f6fd7d201b60c47b5e82ab3c9b815345506


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
/* Copyright (c) 2017 Dovecot authors, see the included COPYING file */

#include "lib.h"
#include "str.h"
#include "event-filter.h"
#include "lib-event-private.h"

static struct event_filter *global_debug_log_filter = NULL;
static struct event_filter *global_debug_send_filter = NULL;

#undef e_error
void e_error(struct event *event,
         const char *source_filename, unsigned int source_linenum,
         const char *fmt, ...)
{
    struct event_log_params params = {
        .log_type = LOG_TYPE_ERROR,
        .source_filename = source_filename,
        .source_linenum = source_linenum,
    };
    va_list args;

    va_start(args, fmt);
    event_logv(event, &params, fmt, args);
    va_end(args);
}

#undef e_warning
void e_warning(struct event *event,
           const char *source_filename, unsigned int source_linenum,
           const char *fmt, ...)
{
    struct event_log_params params = {
        .log_type = LOG_TYPE_WARNING,
        .source_filename = source_filename,
        .source_linenum = source_linenum,
    };
    va_list args;

    va_start(args, fmt);
    event_logv(event, &params, fmt, args);
    va_end(args);
}

#undef e_info
void e_info(struct event *event,
        const char *source_filename, unsigned int source_linenum,
        const char *fmt, ...)
{
    struct event_log_params params = {
        .log_type = LOG_TYPE_INFO,
        .source_filename = source_filename,
        .source_linenum = source_linenum,
    };
    va_list args;

    va_start(args, fmt);
    event_logv(event, &params, fmt, args);
    va_end(args);
}

#undef e_debug
void e_debug(struct event *event,
         const char *source_filename, unsigned int source_linenum,
         const char *fmt, ...)
{
    struct event_log_params params = {
        .log_type = LOG_TYPE_DEBUG,
        .source_filename = source_filename,
        .source_linenum = source_linenum,
    };
    va_list args;

    va_start(args, fmt);
    event_logv(event, &params, fmt, args);
    va_end(args);
}

static bool event_get_log_prefix(struct event *event, string_t *log_prefix,
                 bool *replace_prefix)
{
    bool ret = FALSE;

    if (event->log_prefix_replace) {
        /* this event replaces all parent log prefixes */
        *replace_prefix = TRUE;
    } else if (event->parent == NULL) {
        /* append to default log prefix, don't replace it */
    } else {
        if (event_get_log_prefix(event->parent, log_prefix, replace_prefix))
            ret = TRUE;
    }
    if (event->log_prefix != NULL) {
        str_append(log_prefix, event->log_prefix);
        ret = TRUE;
    }
    return ret;
}

void event_log(struct event *event, const struct event_log_params *params,
           const char *fmt, ...)
{
    va_list args;

    va_start(args, fmt);
    event_logv(event, params, fmt, args);
    va_end(args);
}

static bool
event_want_debug_log(struct event *event, const char *source_filename,
             unsigned int source_linenum)
{
    if (event->forced_debug)
        return TRUE;

    return global_debug_log_filter == NULL ? FALSE :
        event_filter_match_source(global_debug_log_filter, event,
                      source_filename, source_linenum);
}

bool event_want_debug(struct event *event, const char *source_filename,
              unsigned int source_linenum)
{
    event->sending_debug_log =
        event_want_debug_log(event, source_filename, source_linenum);
    if (event->sending_debug_log)
        return TRUE;

    /* see if debug send filtering matches */
    if (global_debug_send_filter != NULL) {
        if (event_filter_match_source(global_debug_send_filter, event,
                          source_filename, source_linenum))
            return TRUE;
    }
    return FALSE;
}

static void ATTR_FORMAT(3, 0)
event_logv_type(struct event *event, enum log_type log_type,
        const char *fmt, va_list args)
{
    string_t *log_prefix_str = t_str_new(64);
    bool replace_prefix = FALSE;

    struct failure_context ctx = {
        .type = log_type,
    };

    int old_errno = errno;
    if (!event_get_log_prefix(event, log_prefix_str, &replace_prefix)) {
        /* keep log prefix as it is */
        event_vsend(event, &ctx, fmt, args);
    } else if (replace_prefix) {
        /* event overrides the log prefix (even if it's "") */
        ctx.log_prefix = str_c(log_prefix_str);
        event_vsend(event, &ctx, fmt, args);
    } else {
        /* append to log prefix, but don't fully replace it */
        str_vprintfa(log_prefix_str, fmt, args);
        event_send(event, &ctx, "%s", str_c(log_prefix_str));
    }
    errno = old_errno;
}

void event_logv(struct event *event, const struct event_log_params *params,
        const char *fmt, va_list args)
{
    const char *orig_source_filename = event->source_filename;
    unsigned int orig_source_linenum = event->source_linenum;

    if (params->source_filename != NULL) {
        event_set_source(event, params->source_filename,
                 params->source_linenum, TRUE);
    }

    event_ref(event);
    event_logv_type(event, params->log_type, fmt, args);
    event_set_source(event, orig_source_filename,
             orig_source_linenum, TRUE);
    event_unref(&event);
}

struct event *event_set_forced_debug(struct event *event, bool force)
{
    event->forced_debug = force;
    return event;
}

void event_set_global_debug_log_filter(struct event_filter *filter)
{
    event_unset_global_debug_log_filter();
    global_debug_log_filter = filter;
    event_filter_ref(global_debug_log_filter);
}

struct event_filter *event_get_global_debug_log_filter(void)
{
    return global_debug_log_filter;
}

void event_unset_global_debug_log_filter(void)
{
    if (global_debug_log_filter != NULL)
        event_filter_unref(&global_debug_log_filter);
}

void event_set_global_debug_send_filter(struct event_filter *filter)
{
    event_unset_global_debug_send_filter();
    global_debug_send_filter = filter;
    event_filter_ref(global_debug_send_filter);
}

struct event_filter *event_get_global_debug_send_filter(void)
{
    return global_debug_send_filter;
}

void event_unset_global_debug_send_filter(void)
{
    if (global_debug_send_filter != NULL)
        event_filter_unref(&global_debug_send_filter);
}