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
|
/*
* Copyright (c) 2002-2013 Balabit
* Copyright (c) 1998-2013 Balázs Scheidler
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* As an additional exemption you are allowed to compile & link against the
* OpenSSL libraries as published by the OpenSSL project. See the file
* COPYING for details.
*
*/
#ifndef TEMPLATES_H_INCLUDED
#define TEMPLATES_H_INCLUDED
#include "syslog-ng.h"
#include "common-template-typedefs.h"
#include "timeutils/zoneinfo.h"
#include "type-hinting.h"
#include "atomic.h"
#define LTZ_LOCAL 0
#define LTZ_SEND 1
#define LTZ_MAX 2
#define LOG_TEMPLATE_ERROR log_template_error_quark()
GQuark log_template_error_quark(void);
enum LogTemplateError
{
LOG_TEMPLATE_ERROR_FAILED,
LOG_TEMPLATE_ERROR_COMPILE,
};
typedef enum
{
ON_ERROR_DROP_MESSAGE = 0x01,
ON_ERROR_DROP_PROPERTY = 0x02,
ON_ERROR_FALLBACK_TO_STRING = 0x04, /* Valid for type hinting
only! */
ON_ERROR_SILENT = 0x08
} LogTemplateOnError;
/* structure that represents an expandable syslog-ng template */
typedef struct _LogTemplate
{
GAtomicCounter ref_cnt;
gchar *name;
gchar *template;
GList *compiled_template;
GlobalConfig *cfg;
guint escape:1, def_inline:1, trivial:1;
TypeHint type_hint;
} LogTemplate;
/* template expansion options that can be influenced by the user and
* is static throughout the runtime for a given configuration. There
* are call-site specific options too, those are specified as
* arguments to log_template_format() */
struct _LogTemplateOptions
{
gboolean initialized;
/* timestamp format as specified by ts_format() */
gint ts_format;
/* number of digits in the fraction of a second part, specified using frac_digits() */
gint frac_digits;
gboolean use_fqdn;
/* timezone for LTZ_LOCAL/LTZ_SEND settings */
gchar *time_zone[LTZ_MAX];
TimeZoneInfo *time_zone_info[LTZ_MAX];
/* Template error handling settings */
gint on_error;
};
/* appends the formatted output into result */
void log_template_set_escape(LogTemplate *self, gboolean enable);
gboolean log_template_set_type_hint(LogTemplate *self, const gchar *hint, GError **error);
gboolean log_template_compile(LogTemplate *self, const gchar *template, GError **error);
void log_template_compile_literal_string(LogTemplate *self, const gchar *literal);
gboolean log_template_is_trivial(LogTemplate *self);
const gchar *log_template_get_trivial_value(LogTemplate *self, LogMessage *msg, gssize *value_len);
void log_template_format(LogTemplate *self, LogMessage *lm, const LogTemplateOptions *opts, gint tz, gint32 seq_num,
const gchar *context_id, GString *result);
void log_template_append_format(LogTemplate *self, LogMessage *lm, const LogTemplateOptions *opts, gint tz,
gint32 seq_num, const gchar *context_id, GString *result);
void log_template_append_format_with_context(LogTemplate *self, LogMessage **messages, gint num_messages,
const LogTemplateOptions *opts, gint tz, gint32 seq_num, const gchar *context_id, GString *result);
void log_template_format_with_context(LogTemplate *self, LogMessage **messages, gint num_messages,
const LogTemplateOptions *opts, gint tz, gint32 seq_num, const gchar *context_id, GString *result);
void log_template_set_name(LogTemplate *self, const gchar *name);
LogTemplate *log_template_new(GlobalConfig *cfg, const gchar *name);
LogTemplate *log_template_ref(LogTemplate *s);
void log_template_unref(LogTemplate *s);
void log_template_options_init(LogTemplateOptions *options, GlobalConfig *cfg);
void log_template_options_destroy(LogTemplateOptions *options);
void log_template_options_defaults(LogTemplateOptions *options);
void log_template_global_init(void);
void log_template_global_deinit(void);
gboolean log_template_on_error_parse(const gchar *on_error, gint *out);
void log_template_options_set_on_error(LogTemplateOptions *options, gint on_error);
#endif
|
