5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2001 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
22 #include "silcincludes.h"
23 #include "silccommand.h"
25 /******************************************************************************
29 ******************************************************************************/
31 /* Command Payload structure. Contents of this structure is parsed
33 struct SilcCommandPayloadStruct {
36 SilcArgumentPayload args;
39 /* Length of the command payload */
40 #define SILC_COMMAND_PAYLOAD_LEN 6
42 /* Parses command payload returning new command payload structure */
44 SilcCommandPayload silc_command_payload_parse(SilcBuffer buffer)
46 SilcCommandPayload new;
47 unsigned char args_num;
51 SILC_LOG_DEBUG(("Parsing command payload"));
53 new = silc_calloc(1, sizeof(*new));
55 /* Parse the Command Payload */
56 ret = silc_buffer_unformat(buffer,
57 SILC_STR_UI_SHORT(&payload_len),
58 SILC_STR_UI_CHAR(&new->cmd),
59 SILC_STR_UI_CHAR(&args_num),
60 SILC_STR_UI_SHORT(&new->ident),
67 if (payload_len != buffer->len) {
68 SILC_LOG_ERROR(("Incorrect command payload in packet, packet dropped"));
78 silc_buffer_pull(buffer, SILC_COMMAND_PAYLOAD_LEN);
80 new->args = silc_argument_payload_parse(buffer, args_num);
86 silc_buffer_push(buffer, SILC_COMMAND_PAYLOAD_LEN);
91 /* Encodes Command Payload returning it to SilcBuffer. */
93 SilcBuffer silc_command_payload_encode(SilcCommand cmd,
101 SilcBuffer args = NULL;
104 SILC_LOG_DEBUG(("Encoding command payload"));
107 args = silc_argument_payload_encode(argc, argv, argv_lens, argv_types);
111 len += SILC_COMMAND_PAYLOAD_LEN;
112 buffer = silc_buffer_alloc(len);
113 silc_buffer_pull_tail(buffer, SILC_BUFFER_END(buffer));
115 /* Create Command payload */
116 silc_buffer_format(buffer,
117 SILC_STR_UI_SHORT(len),
118 SILC_STR_UI_CHAR(cmd),
119 SILC_STR_UI_CHAR(argc),
120 SILC_STR_UI_SHORT(ident),
125 silc_buffer_pull(buffer, SILC_COMMAND_PAYLOAD_LEN);
126 silc_buffer_format(buffer,
127 SILC_STR_UI_XNSTRING(args->data, args->len),
129 silc_buffer_push(buffer, SILC_COMMAND_PAYLOAD_LEN);
136 /* Same as above but encode the buffer from SilcCommandPayload structure
137 instead of raw data. */
139 SilcBuffer silc_command_payload_encode_payload(SilcCommandPayload payload)
142 SilcBuffer args = NULL;
146 SILC_LOG_DEBUG(("Encoding command payload"));
149 args = silc_argument_payload_encode_payload(payload->args);
151 argc = silc_argument_get_arg_num(payload->args);
154 len += SILC_COMMAND_PAYLOAD_LEN;
155 buffer = silc_buffer_alloc(len);
156 silc_buffer_pull_tail(buffer, SILC_BUFFER_END(buffer));
158 /* Create Command payload */
159 silc_buffer_format(buffer,
160 SILC_STR_UI_SHORT(len),
161 SILC_STR_UI_CHAR(payload->cmd),
162 SILC_STR_UI_CHAR(argc),
163 SILC_STR_UI_SHORT(payload->ident),
168 silc_buffer_pull(buffer, SILC_COMMAND_PAYLOAD_LEN);
169 silc_buffer_format(buffer,
170 SILC_STR_UI_XNSTRING(args->data, args->len),
172 silc_buffer_push(buffer, SILC_COMMAND_PAYLOAD_LEN);
179 /* Encodes Command payload with variable argument list. The arguments
180 must be: uint32, unsigned char *, unsigned int, ... One
181 {uint32, unsigned char * and unsigned int} forms one argument,
182 thus `argc' in case when sending one {uint32, unsigned char *
183 and uint32} equals one (1) and when sending two of those it
184 equals two (2), and so on. This has to be preserved or bad things
185 will happen. The variable arguments is: {type, data, data_len}. */
187 SilcBuffer silc_command_payload_encode_va(SilcCommand cmd,
195 buffer = silc_command_payload_encode_vap(cmd, ident, argc, ap);
201 /* Same as above but with va_list. */
203 SilcBuffer silc_command_payload_encode_vap(SilcCommand cmd,
205 uint32 argc, va_list ap)
207 unsigned char **argv;
208 uint32 *argv_lens = NULL, *argv_types = NULL;
215 argv = silc_calloc(argc, sizeof(unsigned char *));
216 argv_lens = silc_calloc(argc, sizeof(uint32));
217 argv_types = silc_calloc(argc, sizeof(uint32));
219 for (i = 0, k = 0; i < argc; i++) {
220 x_type = va_arg(ap, uint32);
221 x = va_arg(ap, unsigned char *);
222 x_len = va_arg(ap, uint32);
224 if (!x_type || !x || !x_len)
227 argv[k] = silc_calloc(x_len + 1, sizeof(unsigned char));
228 memcpy(argv[k], x, x_len);
229 argv_lens[k] = x_len;
230 argv_types[k] = x_type;
234 buffer = silc_command_payload_encode(cmd, k, argv, argv_lens,
237 for (i = 0; i < k; i++)
240 silc_free(argv_lens);
241 silc_free(argv_types);
246 /* Same as above except that this is used to encode strictly command
247 reply packets. The command status message to be returned is sent as
248 extra argument to this function. The `argc' must not count `status'
252 silc_command_reply_payload_encode_va(SilcCommand cmd,
253 SilcCommandStatus status,
258 unsigned char **argv;
259 uint32 *argv_lens = NULL, *argv_types = NULL;
260 unsigned char status_data[2];
270 argv = silc_calloc(argc, sizeof(unsigned char *));
271 argv_lens = silc_calloc(argc, sizeof(uint32));
272 argv_types = silc_calloc(argc, sizeof(uint32));
274 SILC_PUT16_MSB(status, status_data);
275 argv[0] = silc_calloc(sizeof(status_data) + 1, sizeof(unsigned char));
276 memcpy(argv[0], status_data, sizeof(status_data));
277 argv_lens[0] = sizeof(status_data);
280 for (i = 1, k = 1; i < argc; i++) {
281 x_type = va_arg(ap, uint32);
282 x = va_arg(ap, unsigned char *);
283 x_len = va_arg(ap, uint32);
285 if (!x_type || !x || !x_len)
288 argv[k] = silc_calloc(x_len + 1, sizeof(unsigned char));
289 memcpy(argv[k], x, x_len);
290 argv_lens[k] = x_len;
291 argv_types[k] = x_type;
295 buffer = silc_command_payload_encode(cmd, k, argv, argv_lens,
298 for (i = 0; i < k; i++)
301 silc_free(argv_lens);
302 silc_free(argv_types);
309 /* Frees Command Payload */
311 void silc_command_payload_free(SilcCommandPayload payload)
314 silc_argument_payload_free(payload->args);
319 /* Returns command */
321 SilcCommand silc_command_get(SilcCommandPayload payload)
326 /* Retuns arguments payload */
328 SilcArgumentPayload silc_command_get_args(SilcCommandPayload payload)
330 return payload->args;
333 /* Returns identifier */
335 uint16 silc_command_get_ident(SilcCommandPayload payload)
337 return payload->ident;
340 /* Function to set identifier to already allocated Command Payload. Command
341 payloads are frequentlly resent in SILC and thusly this makes it easy
342 to set the identifier. */
344 void silc_command_set_ident(SilcCommandPayload payload, uint16 ident)
346 payload->ident = ident;
349 /* Function to set the command to already allocated Command Payload. */
351 void silc_command_set_command(SilcCommandPayload payload, SilcCommand command)
353 payload->cmd = command;