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
|
/*
** Zabbix
** Copyright (C) 2001-2014 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program 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 General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
#include "common.h"
#include "comms.h"
#include "zbxjson.h"
#include "log.h"
/******************************************************************************
* *
* Function: zbx_send_response *
* *
* Purpose: send json SUCCEED or FAIL to socket along with an info message *
* *
* Parameters: sock - [IN] socket descriptor *
* result - [IN] SUCCEED or FAIL *
* info - [IN] info message *
* timeout - [IN] timeout for this operation *
* *
* Return value: SUCCEED - data successfully transmited *
* NETWORK_ERROR - network related error occurred *
* *
* Author: Alexander Vladishev, Alexei Vladishev *
* *
* Comments: *
* *
******************************************************************************/
int zbx_send_response_ext(zbx_sock_t *sock, int result, const char *info, int protocol, int timeout)
{
const char *__function_name = "zbx_send_response";
struct zbx_json json;
const char *resp;
int ret = SUCCEED;
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __function_name);
zbx_json_init(&json, ZBX_JSON_STAT_BUF_LEN);
resp = SUCCEED == result ? ZBX_PROTO_VALUE_SUCCESS : ZBX_PROTO_VALUE_FAILED;
zbx_json_addstring(&json, ZBX_PROTO_TAG_RESPONSE, resp, ZBX_JSON_TYPE_STRING);
if (NULL != info && '\0' != *info)
zbx_json_addstring(&json, ZBX_PROTO_TAG_INFO, info, ZBX_JSON_TYPE_STRING);
zabbix_log(LOG_LEVEL_DEBUG, "%s() '%s'", __function_name, json.buffer);
if (FAIL == (ret = zbx_tcp_send_ext(sock, json.buffer, strlen(json.buffer), protocol, timeout)))
{
zabbix_log(LOG_LEVEL_DEBUG, "Error sending result back: %s", zbx_tcp_strerror());
ret = NETWORK_ERROR;
}
zbx_json_free(&json);
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __function_name, zbx_result_string(ret));
return ret;
}
/******************************************************************************
* *
* Function: zbx_recv_response *
* *
* Purpose: read a response message (in JSON format) from socket, optionally *
* extract "info" value. *
* *
* Parameters: sock - [IN] socket descriptor *
* info - [IN/OUT] pointer to "info" value location or NULL *
* timeout - [IN] timeout for this operation *
* error - [IN/OUT] pointer to error message *
* *
* Return value: SUCCEED - "response":"success" response successfully *
* retrieved *
* NETWORK_ERROR - network related error occurred *
* FAIL - otherwise *
* Comments: *
* Allocates memory. *
* *
* If 'info' parameter is NULL pointer then this function does not *
* examine the response message for "info". *
* *
* If 'info' parameter is not a NULL pointer and: *
* - the "info" value is present in the response message then this *
* function allocates a dynamic memory buffer, copies the "info" *
* value into the buffer and writes the buffer address into location *
* pointed to by "info" parameter. *
* - the "info" value is not present in the response message then this *
* function writes NULL into location pointed to by "info" parameter.*
* *
* If an error occurs, the function allocates dynamic memory for an error *
* message and writes its address into location pointed to by "error" *
* parameter. *
* *
* IMPORTANT: it is a responsibility of the caller to release the "info" *
* and "error" memory ! *
* *
******************************************************************************/
int zbx_recv_response(zbx_sock_t *sock, char **info, int timeout, char **error)
{
const char *__function_name = "zbx_recv_response";
struct zbx_json_parse jp;
char value[16], *info_buf = NULL;
size_t info_buf_alloc = 0;
int ret = SUCCEED, invalid_format = 0;
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __function_name);
if (SUCCEED != (ret = zbx_tcp_recv_to(sock, timeout)))
{
/* since we have successfully sent data earlier, we assume the other */
/* side is just too busy processing our data if there is no response */
*error = zbx_dsprintf(*error, "no response: network error");
zabbix_log(LOG_LEVEL_DEBUG, "did not receive response from host");
ret = NETWORK_ERROR;
goto out;
}
zabbix_log(LOG_LEVEL_DEBUG, "%s() '%s'", __function_name, sock->buffer);
/* deal with empty string here because zbx_json_open() does not produce an error message in this case */
if ('\0' == *sock->buffer)
{
*error = zbx_dsprintf(*error, "invalid response format: empty string received");
invalid_format = 1;
goto out;
}
if (SUCCEED != (ret = zbx_json_open(sock->buffer, &jp)))
{
*error = zbx_dsprintf(*error, "invalid response format: not a valid JSON: %s", zbx_json_strerror());
invalid_format = 1;
goto out;
}
if (SUCCEED != (ret = zbx_json_value_by_name(&jp, ZBX_PROTO_TAG_RESPONSE, value, sizeof(value))))
{
*error = zbx_dsprintf(*error, "invalid response format: no \"" ZBX_PROTO_TAG_RESPONSE "\" tag");
invalid_format = 1;
goto out;
}
if (0 != strcmp(value, ZBX_PROTO_VALUE_SUCCESS))
{
*error = zbx_dsprintf(*error, "negative response: \"%s\"", value);
ret = FAIL;
}
if (NULL != info)
{
if (SUCCEED != zbx_json_value_by_name_dyn(&jp, ZBX_PROTO_TAG_INFO, &info_buf, &info_buf_alloc))
{
*info = NULL;
zbx_free(info_buf);
}
else
*info = info_buf;
}
out:
if (0 != invalid_format)
{
if (NULL != info)
*info = NULL;
ret = FAIL;
}
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __function_name, zbx_result_string(ret));
return ret;
}
|
