1 /*
2 ** Zabbix
3 ** Copyright (C) 2001-2021 Zabbix SIA
4 **
5 ** This program is free software; you can redistribute it and/or modify
6 ** it under the terms of the GNU General Public License as published by
7 ** the Free Software Foundation; either version 2 of the License, or
8 ** (at your option) any later version.
9 **
10 ** This program is distributed in the hope that it will be useful,
11 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ** GNU General Public License for more details.
14 **
15 ** You should have received a copy of the GNU General Public License
16 ** along with this program; if not, write to the Free Software
17 ** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
18 **/
19 
20 #ifndef ZABBIX_ZBXSERVER_H
21 #define ZABBIX_ZBXSERVER_H
22 
23 #include "common.h"
24 #include "db.h"
25 #include "dbcache.h"
26 #include "zbxjson.h"
27 
28 #define MACRO_TYPE_MESSAGE_NORMAL	0x00000001
29 #define MACRO_TYPE_MESSAGE_RECOVERY	0x00000002
30 #define MACRO_TYPE_TRIGGER_URL		0x00000004
31 #define MACRO_TYPE_TRIGGER_EXPRESSION	0x00000008
32 #define MACRO_TYPE_TRIGGER_DESCRIPTION	0x00000010	/* name */
33 #define MACRO_TYPE_TRIGGER_COMMENTS	0x00000020	/* description */
34 #define MACRO_TYPE_ITEM_KEY		0x00000040
35 #define MACRO_TYPE_INTERFACE_ADDR	0x00000100
36 #define MACRO_TYPE_COMMON		0x00000400
37 #define MACRO_TYPE_PARAMS_FIELD		0x00000800
38 #define MACRO_TYPE_SCRIPT		0x00001000
39 #define MACRO_TYPE_SNMP_OID		0x00002000
40 #define MACRO_TYPE_HTTPTEST_FIELD	0x00004000
41 #define MACRO_TYPE_LLD_FILTER		0x00008000
42 #define MACRO_TYPE_ALERT		0x00010000
43 #define MACRO_TYPE_TRIGGER_TAG		0x00020000
44 #define MACRO_TYPE_JMX_ENDPOINT		0x00040000
45 #define MACRO_TYPE_MESSAGE_ACK		0x00080000
46 #define MACRO_TYPE_HTTP_RAW		0x00100000
47 #define MACRO_TYPE_HTTP_JSON		0x00200000
48 #define MACRO_TYPE_HTTP_XML		0x00400000
49 #define MACRO_TYPE_ALLOWED_HOSTS	0x00800000
50 #define MACRO_TYPE_ITEM_TAG		0x01000000
51 
52 #define MACRO_EXPAND_NO			0
53 #define MACRO_EXPAND_YES		1
54 
55 #define STR_CONTAINS_MACROS(str)	(NULL != strchr(str, '{'))
56 
57 int	get_N_functionid(const char *expression, int N_functionid, zbx_uint64_t *functionid, const char **end);
58 void	get_functionids(zbx_vector_uint64_t *functionids, const char *expression);
59 
60 int	evaluate_function(char **value, DC_ITEM *item, const char *function, const char *parameter,
61 		const zbx_timespec_t *ts, char **error);
62 
63 int	substitute_simple_macros(zbx_uint64_t *actionid, const DB_EVENT *event, const DB_EVENT *r_event,
64 		zbx_uint64_t *userid, const zbx_uint64_t *hostid, const DC_HOST *dc_host, const DC_ITEM *dc_item,
65 		DB_ALERT *alert, const DB_ACKNOWLEDGE *ack, char **data, int macro_type, char *error, int maxerrlen);
66 
67 int	substitute_simple_macros_unmasked(zbx_uint64_t *actionid, const DB_EVENT *event, const DB_EVENT *r_event,
68 		zbx_uint64_t *userid, const zbx_uint64_t *hostid, const DC_HOST *dc_host, const DC_ITEM *dc_item,
69 		DB_ALERT *alert, const DB_ACKNOWLEDGE *ack, char **data, int macro_type, char *error, int maxerrlen);
70 
71 void	evaluate_expressions(zbx_vector_ptr_t *triggers, const zbx_vector_uint64_t *history_itemids,
72 		const DC_ITEM *history_items, const int *history_errcodes);
73 
74 void	zbx_format_value(char *value, size_t max_len, zbx_uint64_t valuemapid,
75 		const char *units, unsigned char value_type);
76 
77 void	zbx_determine_items_in_expressions(zbx_vector_ptr_t *trigger_order, const zbx_uint64_t *itemids, int item_num);
78 
79 void	get_trigger_expression_constant(const char *expression, const zbx_token_reference_t *reference,
80 		char **constant);
81 
82 /* lld macro context */
83 #define ZBX_MACRO_ANY		(ZBX_TOKEN_LLD_MACRO | ZBX_TOKEN_LLD_FUNC_MACRO | ZBX_TOKEN_USER_MACRO)
84 #define ZBX_MACRO_NUMERIC	(ZBX_MACRO_ANY | ZBX_TOKEN_NUMERIC)
85 #define ZBX_MACRO_JSON		(ZBX_MACRO_ANY | ZBX_TOKEN_JSON)
86 #define ZBX_MACRO_SIMPLE	(ZBX_MACRO_ANY | ZBX_TOKEN_SIMPLE_MACRO)
87 #define ZBX_MACRO_FUNC		(ZBX_MACRO_ANY | ZBX_TOKEN_FUNC_MACRO)
88 
89 int	substitute_lld_macros(char **data, const struct zbx_json_parse *jp_row, const zbx_vector_ptr_t *lld_macro_paths,
90 		int flags, char *error, size_t max_error_len);
91 int	substitute_key_macros(char **data, zbx_uint64_t *hostid, DC_ITEM *dc_item, const struct zbx_json_parse *jp_row,
92 		const zbx_vector_ptr_t *lld_macro_paths, int macro_type, char *error, size_t maxerrlen);
93 int	substitute_key_macros_unmasked(char **data, zbx_uint64_t *hostid, DC_ITEM *dc_item,
94 		const struct zbx_json_parse *jp_row, const zbx_vector_ptr_t *lld_macro_paths, int macro_type,
95 		char *error, size_t maxerrlen);
96 int	substitute_function_lld_param(const char *e, size_t len, unsigned char key_in_param,
97 		char **exp, size_t *exp_alloc, size_t *exp_offset, const struct zbx_json_parse *jp_row,
98 		const zbx_vector_ptr_t *lld_macro_paths, char *error, size_t max_error_len);
99 int	substitute_macros_xml(char **data, const DC_ITEM *item, const struct zbx_json_parse *jp_row,
100 		const zbx_vector_ptr_t *lld_macro_paths, char *error, int maxerrlen);
101 int	substitute_macros_xml_unmasked(char **data, const DC_ITEM *item, const struct zbx_json_parse *jp_row,
102 		const zbx_vector_ptr_t *lld_macro_paths, char *error, int maxerrlen);
103 int	zbx_substitute_item_name_macros(DC_ITEM *dc_item, const char *name, char **replace_to);
104 int	substitute_macros_in_json_pairs(char **data, const struct zbx_json_parse *jp_row,
105 		const zbx_vector_ptr_t *lld_macro_paths, char *error, int maxerrlen);
106 int	xml_xpath_check(const char *xpath, char *error, size_t errlen);
107 
108 #endif
109