In control command api, rename "object" to "cmddata"

This makes it match control-spec.txt.

diff --git a/src/feature/control/control_cmd.c b/src/feature/control/control_cmd.c
index 7a9af19cd0a5be815872d1fc8837e9955865132c..da9a95fc5d082e425830559b54bdbbc51a6dfd8d 100644 (file)
--- a/src/feature/control/control_cmd.c
+++ b/src/feature/control/control_cmd.c
@@ -76,7 +76,7 @@ control_cmd_args_free_(control_cmd_args_t *args)
     smartlist_free(args->args);
   }
   config_free_lines(args->kwargs);
-  tor_free(args->object);
+  tor_free(args->cmddata);
 
   tor_free(args);
 }
@@ -95,8 +95,8 @@ control_cmd_args_wipe(control_cmd_args_t *args)
     memwipe(line->key, 0, strlen(line->key));
     memwipe(line->value, 0, strlen(line->value));
   }
-  if (args->object)
-    memwipe(args->object, 0, args->object_len);
+  if (args->cmddata)
+    memwipe(args->cmddata, 0, args->cmddata_len);
 }
 
 /**
@@ -140,7 +140,7 @@ control_cmd_parse_args(const char *command,
   }
 
   const char *eol = memchr(body, '\n', body_len);
-  if (syntax->want_object) {
+  if (syntax->want_cmddata) {
     if (! eol || (eol+1) == body+body_len) {
       *error_out = tor_strdup("Empty body");
       goto err;
@@ -148,8 +148,8 @@ control_cmd_parse_args(const char *command,
     cmdline_alloc = tor_memdup_nulterm(body, eol-body);
     cmdline = cmdline_alloc;
     ++eol;
-    result->object_len = read_escaped_data(eol, (body+body_len)-eol,
-                                           &result->object);
+    result->cmddata_len = read_escaped_data(eol, (body+body_len)-eol,
+                                           &result->cmddata);
   } else {
     if (eol && (eol+1) != body+body_len) {
       *error_out = tor_strdup("Unexpected body");
@@ -320,7 +320,7 @@ handle_control_getconf(control_connection_t *conn,
 }
 
 static const control_cmd_syntax_t loadconf_syntax = {
-  .want_object = true
+  .want_cmddata = true
 };
 
 /** Called when we get a +LOADCONF message. */
@@ -332,7 +332,7 @@ handle_control_loadconf(control_connection_t *conn,
   char *errstring = NULL;
   const char *msg = NULL;
 
-  retval = options_init_from_string(NULL, args->object,
+  retval = options_init_from_string(NULL, args->cmddata,
                                     CMD_RUN_TOR, NULL, &errstring);
 
   if (retval != SETOPT_OK)
@@ -1013,7 +1013,7 @@ static const control_cmd_syntax_t postdescriptor_syntax = {
   .max_args = 0,
   .accept_keywords = true,
   .allowed_keywords = postdescriptor_keywords,
-  .want_object = true,
+  .want_cmddata = true,
 };
 
 /** Called when we get a POSTDESCRIPTOR message.  Try to learn the provided
@@ -1047,7 +1047,7 @@ handle_control_postdescriptor(control_connection_t *conn,
     }
   }
 
-  switch (router_load_single_router(args->object, purpose, cache, &msg)) {
+  switch (router_load_single_router(args->cmddata, purpose, cache, &msg)) {
   case -1:
     if (!msg) msg = "Could not parse descriptor";
     connection_printf_to_buf(conn, "554 %s\r\n", msg);
@@ -1366,7 +1366,7 @@ static const control_cmd_syntax_t hsfetch_syntax = {
   .min_args = 1, .max_args = 1,
   .accept_keywords = true,
   .allowed_keywords = hsfetch_keywords,
-  .want_object = true,
+  .want_cmddata = true,
 };
 
 /** Implementation for the HSFETCH command. */
@@ -1420,7 +1420,7 @@ handle_control_hsfetch(control_connection_t *conn,
         goto done;
       }
       if (!hsdirs) {
-        /* Stores routerstatus_t object for each specified server. */
+        /* Stores routerstatus_t cmddata for each specified server. */
         hsdirs = smartlist_new();
       }
       /* Valid server, add it to our local list. */
@@ -1473,7 +1473,7 @@ static const char *hspost_keywords[] = {
 static const control_cmd_syntax_t hspost_syntax = {
   .min_args = 0, .max_args = 0,
   .accept_keywords = true,
-  .want_object = true,
+  .want_cmddata = true,
   .allowed_keywords = hspost_keywords
 };
 
@@ -1483,8 +1483,8 @@ handle_control_hspost(control_connection_t *conn,
                       const control_cmd_args_t *args)
 {
   smartlist_t *hs_dirs = NULL;
-  const char *encoded_desc = args->object;
-  size_t encoded_desc_len = args->object_len;
+  const char *encoded_desc = args->cmddata;
+  size_t encoded_desc_len = args->cmddata_len;
   const char *onion_address = NULL;
   const config_line_t *line;
 

diff --git a/src/feature/control/control_cmd.h b/src/feature/control/control_cmd.h
index 986718887c31009ca78c7fd9754123508d09b5c0..5c3d1a1cec435e1b1aa49188522c4750cd5d73cb 100644 (file)
--- a/src/feature/control/control_cmd.h
+++ b/src/feature/control/control_cmd.h
@@ -64,7 +64,7 @@ typedef struct control_cmd_syntax_t {
   /**
    * True iff this command wants to be followed by a multiline object.
    **/
-  bool want_object;
+  bool want_cmddata;
   /**
    * True iff this command needs access to the raw body of the input.
    *

diff --git a/src/feature/control/control_cmd_args_st.h b/src/feature/control/control_cmd_args_st.h
index fb4fe64a0812bb923cbd438827d5f376402497a2..8d7a4f55b33296529eab2d58a69c110d9f9b142b 100644 (file)
--- a/src/feature/control/control_cmd_args_st.h
+++ b/src/feature/control/control_cmd_args_st.h
@@ -36,13 +36,13 @@ struct control_cmd_args_t {
    **/
   struct config_line_t *kwargs;
   /**
-   * Number of bytes in <b>object</b>; 0 if <b>object</b> is not set.
+   * Number of bytes in <b>cmddata</b>; 0 if <b>cmddata</b> is not set.
    **/
-  size_t object_len;
+  size_t cmddata_len;
   /**
    * A multiline object passed with this command.
    **/
-  char *object;
+  char *cmddata;
   /**
    * If set, a nul-terminated string containing the raw unparsed arguments.
    **/

diff --git a/src/test/test_controller.c b/src/test/test_controller.c
index fd4f26f08630e7beb92bd3980ef5f98acee14ca5..c130248592474b96fbb861f7350943aa89b9eae8 100644 (file)
--- a/src/test/test_controller.c
+++ b/src/test/test_controller.c
@@ -56,9 +56,9 @@ control_cmd_dump_args(const control_cmd_args_t *result)
     } SMARTLIST_FOREACH_END(s);
   }
   buf_add_string(buf, "]");
-  if (result->object) {
+  if (result->cmddata) {
     buf_add_string(buf, ", obj=");
-    buf_add_string(buf, escaped(result->object));
+    buf_add_string(buf, escaped(result->cmddata));
   }
   if (result->kwargs) {
     buf_add_string(buf, ", { ");
@@ -160,7 +160,7 @@ static const parser_testcase_t no_args_one_obj_tests[] = {
 };
 static const control_cmd_syntax_t no_args_one_obj_syntax = {
    .min_args=0, .max_args=0,
-   .want_object=true,
+   .want_cmddata=true,
 };
 static const parse_test_params_t parse_no_args_one_obj_params =
   TESTPARAMS( no_args_one_obj_syntax, no_args_one_obj_tests );