updates.
[silc.git] / lib / silccore / silccommand.c
index cfdf18a05e91c08da97116d66bad4bbaaf18da06..e76ad180f69ee55fa415ef82d8f67edd9de47cd8 100644 (file)
@@ -2,9 +2,9 @@
 
   silccommand.c
 
-  Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
+  Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 1997 - 2000 Pekka Riikonen
+  Copyright (C) 1997 - 2001 Pekka Riikonen
 
   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
   GNU General Public License for more details.
 
 */
-/*
- * $Id$
- * $Log$
- * Revision 1.3  2000/07/06 07:11:06  priikone
- *     Removed status paylaod encoding functions -> not needed anymore.
- *     Added encode_reply_payload_va to encode reply packets only.
- *     Normal encode_payload_va accepts now argument type as variable
- *     argument as well.
- *
- * Revision 1.2  2000/07/05 06:06:35  priikone
- *     Global cosmetic change.
- *
- * Revision 1.1.1.1  2000/06/27 11:36:55  priikone
- *     Imported from internal CVS/Added Log headers.
- *
- *
- */
+/* $Id$ */
 
 #include "silcincludes.h"
 #include "silccommand.h"
 
+/******************************************************************************
+
+                              Command Payload
+
+******************************************************************************/
+
 /* Command Payload structure. Contents of this structure is parsed
    from SILC packets. */
 struct SilcCommandPayloadStruct {
   SilcCommand cmd;
-  unsigned int argc;
-  unsigned char **argv;
-  unsigned int *argv_lens;
-  unsigned int *argv_types;
-  unsigned int pos;
+  uint16 ident;
+  SilcArgumentPayload args;
 };
 
 /* Length of the command payload */
-#define SILC_COMMAND_PAYLOAD_LEN 4
+#define SILC_COMMAND_PAYLOAD_LEN 6
 
 /* Parses command payload returning new command payload structure */
 
-SilcCommandPayload silc_command_parse_payload(SilcBuffer buffer)
+SilcCommandPayload silc_command_payload_parse(SilcBuffer buffer)
 {
   SilcCommandPayload new;
-  unsigned short payload_len = 0;
-  unsigned char args_num = 0;
-  unsigned char arg_num = 0;
-  unsigned int arg_type = 0;
-  unsigned int pull_len = 0;
-  int i = 0;
+  unsigned char args_num;
+  uint16 payload_len;
+  int ret;
 
   SILC_LOG_DEBUG(("Parsing command payload"));
 
   new = silc_calloc(1, sizeof(*new));
 
   /* Parse the Command Payload */
-  silc_buffer_unformat(buffer, 
-                      SILC_STR_UI_CHAR(&new->cmd),
-                      SILC_STR_UI_CHAR(&args_num),
-                      SILC_STR_UI_SHORT(&payload_len),
-                      SILC_STR_END);
+  ret = silc_buffer_unformat(buffer, 
+                            SILC_STR_UI_SHORT(&payload_len),
+                            SILC_STR_UI_CHAR(&new->cmd),
+                            SILC_STR_UI_CHAR(&args_num),
+                            SILC_STR_UI_SHORT(&new->ident),
+                            SILC_STR_END);
+  if (ret == -1) {
+    silc_free(new);
+    return NULL;
+  }
 
   if (payload_len != buffer->len) {
     SILC_LOG_ERROR(("Incorrect command payload in packet, packet dropped"));
+    silc_free(new);
     return NULL;
   }
 
-  if (new->cmd == 0)
+  if (new->cmd == 0) {
+    silc_free(new);
     return NULL;
+  }
 
-  if (args_num && payload_len) {
-
-    new->argv = silc_calloc(args_num, sizeof(unsigned char *));
-    new->argv_lens = silc_calloc(args_num, sizeof(unsigned int));
-    new->argv_types = silc_calloc(args_num, sizeof(unsigned int));
-
-    silc_buffer_pull(buffer, SILC_COMMAND_PAYLOAD_LEN);
-    pull_len += SILC_COMMAND_PAYLOAD_LEN;
-
-    /* Parse Command Argument Payloads */
-    arg_num = 1;
-    while(arg_num) {
-      silc_buffer_unformat(buffer,
-                          SILC_STR_UI_CHAR(&arg_num),
-                          SILC_STR_UI_CHAR(&arg_type),
-                          SILC_STR_UI_SHORT(&payload_len),
-                          SILC_STR_END);
-
-      /* Check that argument number is correct */
-      if (arg_num != i + 1)
-       goto err;
-
-      new->argv_lens[i] = payload_len;
-      new->argv_types[i] = arg_type;
-
-      /* Get argument data */
-      silc_buffer_pull(buffer, 4);
-      silc_buffer_unformat(buffer,
-                          SILC_STR_UI_XNSTRING_ALLOC(&new->argv[i], 
-                                                     payload_len),
-                          SILC_STR_END);
-      silc_buffer_pull(buffer, payload_len);
-      pull_len += 4 + payload_len;
-
-      i++;
-
-      if (i == args_num)
-       break;
+  silc_buffer_pull(buffer, SILC_COMMAND_PAYLOAD_LEN);
+  if (args_num) {
+    new->args = silc_argument_payload_parse(buffer, args_num);
+    if (!new->args) {
+      silc_free(new);
+      return NULL;
     }
-
-    /* Check the number of arguments */
-    if (arg_num != args_num)
-      goto err;
   }
+  silc_buffer_push(buffer, SILC_COMMAND_PAYLOAD_LEN);
 
-  new->argc = i;
-  new->pos = 0;
+  return new;
+}
 
-  silc_buffer_push(buffer, pull_len);
+/* Encodes Command Payload returning it to SilcBuffer. */
 
-  return new;
+SilcBuffer silc_command_payload_encode(SilcCommand cmd,
+                                      uint32 argc,
+                                      unsigned char **argv,
+                                      uint32 *argv_lens,
+                                      uint32 *argv_types,
+                                      uint16 ident)
+{
+  SilcBuffer buffer;
+  SilcBuffer args = NULL;
+  uint32 len = 0;
 
- err:
-  if (i) {
-    int k;
+  SILC_LOG_DEBUG(("Encoding command payload"));
 
-    for (k = 0; k < i; k++)
-      silc_free(new->argv[k]);
+  if (argc) {
+    args = silc_argument_payload_encode(argc, argv, argv_lens, argv_types);
+    len = args->len;
   }
 
-  silc_free(new->argv);
-  silc_free(new->argv_lens);
-  silc_free(new->argv_types);
+  len += SILC_COMMAND_PAYLOAD_LEN;
+  buffer = silc_buffer_alloc(len);
+  silc_buffer_pull_tail(buffer, SILC_BUFFER_END(buffer));
 
-  if (new)
-    silc_free(new);
+  /* Create Command payload */
+  silc_buffer_format(buffer,
+                    SILC_STR_UI_SHORT(len),
+                    SILC_STR_UI_CHAR(cmd),
+                    SILC_STR_UI_CHAR(argc),
+                    SILC_STR_UI_SHORT(ident),
+                    SILC_STR_END);
+
+  /* Add arguments */
+  if (argc) {
+    silc_buffer_pull(buffer, SILC_COMMAND_PAYLOAD_LEN);
+    silc_buffer_format(buffer,
+                      SILC_STR_UI_XNSTRING(args->data, args->len),
+                      SILC_STR_END);
+    silc_buffer_push(buffer, SILC_COMMAND_PAYLOAD_LEN);
+    silc_free(args);
+  }
 
-  return NULL;
+  return buffer;
 }
 
-/* Encodes Command Payload returning it to SilcBuffer. */
+/* Same as above but encode the buffer from SilcCommandPayload structure
+   instead of raw data. */
 
-SilcBuffer silc_command_encode_payload(SilcCommand cmd,
-                                      unsigned int argc,
-                                      unsigned char **argv,
-                                      unsigned int *argv_lens,
-                                      unsigned int *argv_types)
+SilcBuffer silc_command_payload_encode_payload(SilcCommandPayload payload)
 {
   SilcBuffer buffer;
-  unsigned int len;
-  int i;
+  SilcBuffer args = NULL;
+  uint32 len = 0;
+  uint32 argc = 0;
 
   SILC_LOG_DEBUG(("Encoding command payload"));
 
-  len = 1 + 1 + 2;
-  for (i = 0; i < argc; i++)
-    len += 1 + 1 + 2 + argv_lens[i];
+  if (payload->args) {
+    args = silc_argument_payload_encode_payload(payload->args);
+    len = args->len;
+    argc = silc_argument_get_arg_num(payload->args);
+  }
 
+  len += SILC_COMMAND_PAYLOAD_LEN;
   buffer = silc_buffer_alloc(len);
   silc_buffer_pull_tail(buffer, SILC_BUFFER_END(buffer));
 
   /* Create Command payload */
   silc_buffer_format(buffer,
-                    SILC_STR_UI_CHAR(cmd),
-                    SILC_STR_UI_CHAR(argc),
                     SILC_STR_UI_SHORT(len),
+                    SILC_STR_UI_CHAR(payload->cmd),
+                    SILC_STR_UI_CHAR(argc),
+                    SILC_STR_UI_SHORT(payload->ident),
                     SILC_STR_END);
 
-  /* Put arguments */
-  if (argc) {
-    silc_buffer_pull(buffer, 4);
-   
-    for (i = 0; i < argc; i++) {
-      silc_buffer_format(buffer,
-                        SILC_STR_UI_CHAR(i + 1),
-                        SILC_STR_UI_CHAR(argv_types[i]),
-                        SILC_STR_UI_SHORT(argv_lens[i]),
-                        SILC_STR_UI_XNSTRING(argv[i], argv_lens[i]),
-                        SILC_STR_END);
-      silc_buffer_pull(buffer, 4 + argv_lens[i]);
-    }
-
-    silc_buffer_push(buffer, len);
+  /* Add arguments */
+  if (args) {
+    silc_buffer_pull(buffer, SILC_COMMAND_PAYLOAD_LEN);
+    silc_buffer_format(buffer,
+                      SILC_STR_UI_XNSTRING(args->data, args->len),
+                      SILC_STR_END);
+    silc_buffer_push(buffer, SILC_COMMAND_PAYLOAD_LEN);
+    silc_free(args);
   }
 
   return buffer;
 }
 
 /* Encodes Command payload with variable argument list. The arguments
-   must be: unsigned int, unsigned char *, unsigned int, ... One 
-   {unsigned int, unsigned char * and unsigned int} forms one argument, 
-   thus `argc' in case when sending one {unsigned int, unsigned char * 
-   and unsigned int} equals one (1) and when sending two of those it
+   must be: uint32, unsigned char *, unsigned int, ... One 
+   {uint32, unsigned char * and unsigned int} forms one argument, 
+   thus `argc' in case when sending one {uint32, unsigned char * 
+   and uint32} equals one (1) and when sending two of those it
    equals two (2), and so on. This has to be preserved or bad things
    will happen. The variable arguments is: {type, data, data_len}. */
 
-SilcBuffer silc_command_encode_payload_va(SilcCommand cmd, 
-                                         unsigned int argc, ...)
+SilcBuffer silc_command_payload_encode_va(SilcCommand cmd, 
+                                         uint16 ident, 
+                                         uint32 argc, ...)
 {
   va_list ap;
-  unsigned char **argv;
-  unsigned int *argv_lens = NULL, *argv_types = NULL;
-  unsigned char *x;
-  unsigned int x_len;
-  unsigned int x_type;
   SilcBuffer buffer;
-  int i;
 
   va_start(ap, argc);
+  buffer = silc_command_payload_encode_vap(cmd, ident, argc, ap);
+  va_end(ap);
+
+  return buffer;
+}
+
+/* Same as above but with va_list. */
+
+SilcBuffer silc_command_payload_encode_vap(SilcCommand cmd, 
+                                          uint16 ident, 
+                                          uint32 argc, va_list ap)
+{
+  unsigned char **argv;
+  uint32 *argv_lens = NULL, *argv_types = NULL;
+  unsigned char *x;
+  uint32 x_len;
+  uint32 x_type;
+  SilcBuffer buffer;
+  int i, k;
 
   argv = silc_calloc(argc, sizeof(unsigned char *));
-  argv_lens = silc_calloc(argc, sizeof(unsigned int));
-  argv_types = silc_calloc(argc, sizeof(unsigned int));
+  argv_lens = silc_calloc(argc, sizeof(uint32));
+  argv_types = silc_calloc(argc, sizeof(uint32));
 
-  for (i = 0; i < argc; i++) {
-    x_type = va_arg(ap, unsigned int);
+  for (i = 0, k = 0; i < argc; i++) {
+    x_type = va_arg(ap, uint32);
     x = va_arg(ap, unsigned char *);
-    x_len = va_arg(ap, unsigned int);
+    x_len = va_arg(ap, uint32);
+
+    if (!x_type || !x || !x_len)
+      continue;
 
-    argv[i] = silc_calloc(x_len + 1, sizeof(unsigned char));
-    memcpy(argv[i], x, x_len);
-    argv_lens[i] = x_len;
-    argv_types[i] = x_type;
+    argv[k] = silc_calloc(x_len + 1, sizeof(unsigned char));
+    memcpy(argv[k], x, x_len);
+    argv_lens[k] = x_len;
+    argv_types[k] = x_type;
+    k++;
   }
 
-  buffer = silc_command_encode_payload(cmd, argc, argv
-                                      argv_lens, argv_types);
+  buffer = silc_command_payload_encode(cmd, k, argv, argv_lens
+                                      argv_types, ident);
 
-  for (i = 0; i < argc; i++)
+  for (i = 0; i < k; i++)
     silc_free(argv[i]);
   silc_free(argv);
   silc_free(argv_lens);
@@ -256,26 +249,27 @@ SilcBuffer silc_command_encode_payload_va(SilcCommand cmd,
    as on argument. */
 
 SilcBuffer 
-silc_command_encode_reply_payload_va(SilcCommand cmd, 
+silc_command_reply_payload_encode_va(SilcCommand cmd, 
                                     SilcCommandStatus status,
-                                    unsigned int argc, ...)
+                                    uint16 ident,
+                                    uint32 argc, ...)
 {
   va_list ap;
   unsigned char **argv;
-  unsigned int *argv_lens = NULL, *argv_types = NULL;
+  uint32 *argv_lens = NULL, *argv_types = NULL;
   unsigned char status_data[2];
   unsigned char *x;
-  unsigned int x_len;
-  unsigned int x_type;
+  uint32 x_len;
+  uint32 x_type;
   SilcBuffer buffer;
-  int i;
+  int i, k;
 
   va_start(ap, argc);
 
   argc++;
   argv = silc_calloc(argc, sizeof(unsigned char *));
-  argv_lens = silc_calloc(argc, sizeof(unsigned int));
-  argv_types = silc_calloc(argc, sizeof(unsigned int));
+  argv_lens = silc_calloc(argc, sizeof(uint32));
+  argv_types = silc_calloc(argc, sizeof(uint32));
 
   SILC_PUT16_MSB(status, status_data);
   argv[0] = silc_calloc(sizeof(status_data) + 1, sizeof(unsigned char));
@@ -283,102 +277,78 @@ silc_command_encode_reply_payload_va(SilcCommand cmd,
   argv_lens[0] = sizeof(status_data);
   argv_types[0] = 1;
 
-  for (i = 1; i < argc; i++) {
-    x_type = va_arg(ap, unsigned int);
+  for (i = 1, k = 1; i < argc; i++) {
+    x_type = va_arg(ap, uint32);
     x = va_arg(ap, unsigned char *);
-    x_len = va_arg(ap, unsigned int);
+    x_len = va_arg(ap, uint32);
 
-    argv[i] = silc_calloc(x_len + 1, sizeof(unsigned char));
-    memcpy(argv[i], x, x_len);
-    argv_lens[i] = x_len;
-    argv_types[i] = x_type;
+    if (!x_type || !x || !x_len)
+      continue;
+
+    argv[k] = silc_calloc(x_len + 1, sizeof(unsigned char));
+    memcpy(argv[k], x, x_len);
+    argv_lens[k] = x_len;
+    argv_types[k] = x_type;
+    k++;
   }
 
-  buffer = silc_command_encode_payload(cmd, argc, argv
-                                      argv_lens, argv_types);
+  buffer = silc_command_payload_encode(cmd, k, argv, argv_lens
+                                      argv_types, ident);
 
-  for (i = 0; i < argc; i++)
+  for (i = 0; i < k; i++)
     silc_free(argv[i]);
   silc_free(argv);
   silc_free(argv_lens);
   silc_free(argv_types);
 
+  va_end(ap);
+
   return buffer;
 }
 
-/* Free's Command Payload */
+/* Frees Command Payload */
 
-void silc_command_free_payload(SilcCommandPayload payload)
+void silc_command_payload_free(SilcCommandPayload payload)
 {
-  int i;
-
   if (payload) {
-    for (i = 0; i < payload->argc; i++)
-      silc_free(payload->argv[i]);
-
-    silc_free(payload->argv);
+    silc_argument_payload_free(payload->args);
     silc_free(payload);
   }
 }
 
-/* Returns the command type in payload */
+/* Returns command */
 
 SilcCommand silc_command_get(SilcCommandPayload payload)
 {
   return payload->cmd;
 }
 
-/* Returns number of arguments in payload */
+/* Retuns arguments payload */
 
-unsigned int silc_command_get_arg_num(SilcCommandPayload payload)
+SilcArgumentPayload silc_command_get_args(SilcCommandPayload payload)
 {
-  return payload->argc;
+  return payload->args;
 }
 
-/* Returns first argument from payload. */
+/* Returns identifier */
 
-unsigned char *silc_command_get_first_arg(SilcCommandPayload payload,
-                                         unsigned int *ret_len)
+uint16 silc_command_get_ident(SilcCommandPayload payload)
 {
-  payload->pos = 0;
-
-  if (ret_len)
-    *ret_len = payload->argv_lens[payload->pos];
-
-  return payload->argv[payload->pos++];
+  return payload->ident;
 }
 
-/* Returns next argument from payload or NULL if no more arguments. */
+/* Function to set identifier to already allocated Command Payload. Command
+   payloads are frequentlly resent in SILC and thusly this makes it easy
+   to set the identifier. */
 
-unsigned char *silc_command_get_next_arg(SilcCommandPayload payload,
-                                        unsigned int *ret_len)
+void silc_command_set_ident(SilcCommandPayload payload, uint16 ident)
 {
-  if (payload->pos >= payload->argc)
-    return NULL;
-
-  if (ret_len)
-    *ret_len = payload->argv_lens[payload->pos];
-
-  return payload->argv[payload->pos++];
+  payload->ident = ident;
 }
 
-/* Returns argument which type is `type'. */
+/* Function to set the command to already allocated Command Payload. */
 
-unsigned char *silc_command_get_arg_type(SilcCommandPayload payload,
-                                        unsigned int type,
-                                        unsigned int *ret_len)
+void silc_command_set_command(SilcCommandPayload payload, SilcCommand command)
 {
-  int i;
-
-  for (i = 0; i < payload->argc; i++)
-    if (payload->argv_types[i] == type)
-      break;
-
-  if (i >= payload->argc)
-    return NULL;
-
-  if (ret_len)
-    *ret_len = payload->argv_lens[i];
-
-  return payload->argv[i];
+  payload->cmd = command;
 }