filterx: add filterx error handling to simple functions argument vali…

…dation This patch does two things: 1) adds FilterXExpr * argument to all simple functions 2) changes msg_error() style error handling to filterx style Signed-off-by: Balazs Scheidler <[email protected]>
axoflow · Jun 9, 2024 · 0ca56f0 · 0ca56f0
1 parent 0badd9c
commit 0ca56f0
Show file tree

Hide file tree

Showing 38 changed files with 157 additions and 162 deletions.
diff --git a/lib/filterx/expr-function.c b/lib/filterx/expr-function.c
@@ -103,7 +103,7 @@ _simple_eval(FilterXExpr *s)
   FilterXSimpleFunctionProto f = self->function_proto;
 
   g_assert(f != NULL);
-  FilterXObject *res = f(args);
+  FilterXObject *res = f(s, args);
 
   if (args != NULL)
     g_ptr_array_free(args, TRUE);

diff --git a/lib/filterx/expr-function.h b/lib/filterx/expr-function.h
@@ -28,7 +28,7 @@
 #include "filterx/filterx-object.h"
 #include "plugin.h"
 
-typedef FilterXObject *(*FilterXSimpleFunctionProto)(GPtrArray *);
+typedef FilterXObject *(*FilterXSimpleFunctionProto)(FilterXExpr *s, GPtrArray *);
 
 void filterx_simple_function_argument_error(FilterXExpr *s, gchar *error_info, gboolean free_info);
 

diff --git a/lib/filterx/filterx-globals.c b/lib/filterx/filterx-globals.c
@@ -33,6 +33,7 @@
 #include "filterx/func-istype.h"
 #include "filterx/func-len.h"
 #include "filterx/func-vars.h"
+#include "filterx/filterx-eval.h"
 
 static GHashTable *filterx_builtin_simple_functions = NULL;
 static GHashTable *filterx_builtin_function_ctors = NULL;
@@ -197,11 +198,12 @@ filterx_global_deinit(void)
   filterx_types_deinit();
 }
 
-FilterXObject *filterx_typecast_get_arg(GPtrArray *args, gchar *alt_msg)
+FilterXObject *
+filterx_typecast_get_arg(FilterXExpr *s, GPtrArray *args)
 {
   if (args == NULL || args->len != 1)
     {
-      msg_error(alt_msg ? alt_msg : "filterx: typecast functions must have exactly 1 argument");
+      filterx_simple_function_argument_error(s, "Requires exactly one argument", FALSE);
       return NULL;
     }
 

diff --git a/lib/filterx/filterx-globals.h b/lib/filterx/filterx-globals.h
@@ -41,6 +41,6 @@ FilterXType *filterx_type_lookup(const gchar *type_name);
 gboolean filterx_type_register(const gchar *type_name, FilterXType *fxtype);
 
 // Helpers
-FilterXObject *filterx_typecast_get_arg(GPtrArray *args, gchar *alt_msg);
+FilterXObject *filterx_typecast_get_arg(FilterXExpr *s, GPtrArray *args);
 
 #endif
diff --git a/lib/filterx/func-len.c b/lib/filterx/func-len.c
@@ -23,15 +23,16 @@
 
 #include "filterx/func-len.h"
 #include "filterx/object-primitive.h"
+#include "filterx/filterx-eval.h"
 
 #define FILTERX_FUNC_LEN_USAGE "Usage: len(object)"
 
 FilterXObject *
-filterx_simple_function_len(GPtrArray *args)
+filterx_simple_function_len(FilterXExpr *s, GPtrArray *args)
 {
   if (args == NULL || args->len != 1)
     {
-      msg_error("FilterX: len: invalid number of arguments. " FILTERX_FUNC_LEN_USAGE);
+      filterx_simple_function_argument_error(s, "Requires exactly one argument", FALSE);
       return NULL;
     }
 
@@ -41,8 +42,7 @@ filterx_simple_function_len(GPtrArray *args)
   gboolean success = filterx_object_len(object, &len);
   if (!success)
     {
-      msg_error("FilterX: len: object type is not supported",
-                evt_tag_str("type", object->type->name));
+      filterx_eval_push_error("Object does not support len()", s, object);
       return NULL;
     }
 

diff --git a/lib/filterx/func-len.h b/lib/filterx/func-len.h
@@ -26,6 +26,6 @@
 
 #include "filterx/expr-function.h"
 
-FilterXObject *filterx_simple_function_len(GPtrArray *args);
+FilterXObject *filterx_simple_function_len(FilterXExpr *s, GPtrArray *args);
 
 #endif
diff --git a/lib/filterx/func-vars.c b/lib/filterx/func-vars.c
@@ -47,11 +47,11 @@ _add_to_dict(FilterXVariable *variable, gpointer user_data)
 }
 
 FilterXObject *
-filterx_simple_function_vars(GPtrArray *args)
+filterx_simple_function_vars(FilterXExpr *s, GPtrArray *args)
 {
   if (args && args->len != 0)
     {
-      msg_error("filterx: vars() function does not take any arguments");
+      filterx_simple_function_argument_error(s, "Incorrect number of arguments", FALSE);
       return NULL;
     }
 

diff --git a/lib/filterx/func-vars.h b/lib/filterx/func-vars.h
@@ -26,6 +26,6 @@
 
 #include "filterx/expr-function.h"
 
-FilterXObject *filterx_simple_function_vars(GPtrArray *args);
+FilterXObject *filterx_simple_function_vars(FilterXExpr *s, GPtrArray *args);
 
 #endif
diff --git a/lib/filterx/object-datetime.c b/lib/filterx/object-datetime.c
@@ -115,11 +115,9 @@ filterx_datetime_get_value(FilterXObject *s)
 
 
 FilterXObject *
-filterx_typecast_datetime(GPtrArray *args)
+filterx_typecast_datetime(FilterXExpr *s, GPtrArray *args)
 {
-  FilterXObject *object = filterx_typecast_get_arg(args,
-                                                   "FilterX: Failed to create datetime object: invalid number of arguments. "
-                                                   "Usage: datetime($isodate_str), datetime($unix_int_ms) or datetime($unix_float_s)");
+  FilterXObject *object = filterx_typecast_get_arg(s, args);
   if (!object)
     return NULL;
 
@@ -144,7 +142,7 @@ filterx_typecast_datetime(GPtrArray *args)
     }
   else if (filterx_object_is_type(object, &FILTERX_TYPE_NAME(string)))
     {
-      return filterx_typecast_datetime_isodate(args);
+      return filterx_typecast_datetime_isodate(s, args);
     }
   msg_error("filterx: invalid typecast",
             evt_tag_str("from", object->type->name),
@@ -153,11 +151,9 @@ filterx_typecast_datetime(GPtrArray *args)
 }
 
 FilterXObject *
-filterx_typecast_datetime_isodate(GPtrArray *args)
+filterx_typecast_datetime_isodate(FilterXExpr *s, GPtrArray *args)
 {
-  FilterXObject *object = filterx_typecast_get_arg(args,
-                                                   "FilterX: Failed to create datetime object: invalid number of arguments. "
-                                                   "Usage: datetime($isodate_str), datetime($unix_int_ms) or datetime($unix_float_s)");
+  FilterXObject *object = filterx_typecast_get_arg(s, args);
   if (!object)
     return NULL;
 

diff --git a/lib/filterx/object-datetime.h b/lib/filterx/object-datetime.h
@@ -32,8 +32,8 @@ FILTERX_DECLARE_TYPE(datetime);
 
 FilterXObject *filterx_datetime_new(const UnixTime *ut);
 UnixTime filterx_datetime_get_value(FilterXObject *s);
-FilterXObject *filterx_typecast_datetime(GPtrArray *args);
-FilterXObject *filterx_typecast_datetime_isodate(GPtrArray *args);
+FilterXObject *filterx_typecast_datetime(FilterXExpr *s, GPtrArray *args);
+FilterXObject *filterx_typecast_datetime_isodate(FilterXExpr *, GPtrArray *args);
 FilterXFunction *filterx_function_strptime_new(const gchar *function_name, FilterXFunctionArgs *args, GError **error);
 
 gboolean datetime_repr(const UnixTime *ut, GString *repr);

diff --git a/lib/filterx/object-json-array.c b/lib/filterx/object-json-array.c
@@ -27,6 +27,8 @@
 #include "filterx/object-message-value.h"
 #include "filterx/filterx-weakrefs.h"
 #include "filterx/object-list-interface.h"
+#include "filterx/expr-function.h"
+#include "filterx/filterx-eval.h"
 
 #include "scanner/list-scanner/list-scanner.h"
 #include "str-repr/encode.h"
@@ -304,15 +306,14 @@ filterx_json_array_new_from_syslog_ng_list(const gchar *repr, gssize repr_len)
 }
 
 FilterXObject *
-filterx_json_array_new_from_args(GPtrArray *args)
+filterx_json_array_new_from_args(FilterXExpr *s, GPtrArray *args)
 {
   if (!args || args->len == 0)
     return filterx_json_array_new_empty();
 
   if (args->len != 1)
     {
-      msg_error("FilterX: Failed to create JSON array: invalid number of arguments. "
-                "Usage: json_array() or json_array($raw_json_string) or json_array($existing_json_array)");
+      filterx_simple_function_argument_error(s, "Requires zero or one argument", FALSE);
       return NULL;
     }
 
@@ -338,10 +339,8 @@ filterx_json_array_new_from_args(GPtrArray *args)
     return filterx_json_array_new_from_repr(repr, repr_len);
 
 error:
-  msg_error("FilterX: Failed to create JSON object: invalid argument type. "
-            "Usage: json_array() or json_array($raw_json_string) or json_array($syslog_ng_list) or "
-            "json_array($existing_json_array)",
-            evt_tag_str("type", arg->type->name));
+  filterx_eval_push_error_info("Argument must be a json array, a string or a syslog-ng list", s,
+                               g_strdup_printf("got \"%s\" instead", arg->type->name), TRUE);
   return NULL;
 }
 

diff --git a/lib/filterx/object-json.c b/lib/filterx/object-json.c
@@ -162,15 +162,14 @@ filterx_json_new_from_repr(const gchar *repr, gssize repr_len)
 }
 
 FilterXObject *
-filterx_json_new_from_args(GPtrArray *args)
+filterx_json_new_from_args(FilterXExpr *s, GPtrArray *args)
 {
   if (!args || args->len == 0)
     return filterx_json_object_new_empty();
 
   if (args->len != 1)
     {
-      msg_error("FilterX: Failed to create JSON object: invalid number of arguments. "
-                "Usage: json() or json($raw_json_string) or json($existing_json)");
+      filterx_eval_push_error("Too many arguments", s, NULL);
       return NULL;
     }
 
@@ -220,9 +219,7 @@ filterx_json_new_from_args(GPtrArray *args)
     return filterx_json_new_from_repr(repr, repr_len);
 
 error:
-  msg_error("FilterX: Failed to create JSON object: invalid argument type. "
-            "Usage: json() or json($raw_json_string) or json($syslog_ng_list) or json($existing_json)",
-            evt_tag_str("type", arg->type->name));
+  filterx_eval_push_error_info("Argument must be a json, a string or a syslog-ng list", s, g_strdup_printf("got \"%s\" instead", arg->type->name), TRUE);
   return NULL;
 }
 

diff --git a/lib/filterx/object-json.h b/lib/filterx/object-json.h
@@ -41,8 +41,8 @@ FilterXObject *filterx_json_array_new_from_syslog_ng_list(const gchar *repr, gss
 FilterXObject *filterx_json_object_new_empty(void);
 FilterXObject *filterx_json_array_new_empty(void);
 
-FilterXObject *filterx_json_new_from_args(GPtrArray *args);
-FilterXObject *filterx_json_array_new_from_args(GPtrArray *args);
+FilterXObject *filterx_json_new_from_args(FilterXExpr *s, GPtrArray *args);
+FilterXObject *filterx_json_array_new_from_args(FilterXExpr *s, GPtrArray *args);
 
 FilterXObject *filterx_json_new_from_object(struct json_object *object);
 

diff --git a/lib/filterx/object-primitive.c b/lib/filterx/object-primitive.c
@@ -231,9 +231,9 @@ filterx_primitive_get_value(FilterXObject *s)
 }
 
 FilterXObject *
-filterx_typecast_boolean(GPtrArray *args)
+filterx_typecast_boolean(FilterXExpr *s, GPtrArray *args)
 {
-  FilterXObject *object = filterx_typecast_get_arg(args, NULL);
+  FilterXObject *object = filterx_typecast_get_arg(s, args);
   if (!object)
     return NULL;
 
@@ -247,9 +247,9 @@ filterx_typecast_boolean(GPtrArray *args)
 }
 
 FilterXObject *
-filterx_typecast_integer(GPtrArray *args)
+filterx_typecast_integer(FilterXExpr *s, GPtrArray *args)
 {
-  FilterXObject *object = filterx_typecast_get_arg(args, NULL);
+  FilterXObject *object = filterx_typecast_get_arg(s, args);
   if (!object)
     return NULL;
 
@@ -281,9 +281,9 @@ filterx_typecast_integer(GPtrArray *args)
 }
 
 FilterXObject *
-filterx_typecast_double(GPtrArray *args)
+filterx_typecast_double(FilterXExpr *s, GPtrArray *args)
 {
-  FilterXObject *object = filterx_typecast_get_arg(args, NULL);
+  FilterXObject *object = filterx_typecast_get_arg(s, args);
   if (!object)
     return NULL;
 

diff --git a/lib/filterx/object-primitive.h b/lib/filterx/object-primitive.h
@@ -48,9 +48,9 @@ FilterXObject *filterx_boolean_new(gboolean value);
 FilterXObject *filterx_enum_new(GlobalConfig *cfg, const gchar *namespace_name, const gchar *enum_name);
 GenericNumber filterx_primitive_get_value(FilterXObject *s);
 
-FilterXObject *filterx_typecast_boolean(GPtrArray *args);
-FilterXObject *filterx_typecast_integer(GPtrArray *args);
-FilterXObject *filterx_typecast_double(GPtrArray *args);
+FilterXObject *filterx_typecast_boolean(FilterXExpr *s, GPtrArray *args);
+FilterXObject *filterx_typecast_integer(FilterXExpr *s, GPtrArray *args);
+FilterXObject *filterx_typecast_double(FilterXExpr *s, GPtrArray *args);
 
 gboolean bool_repr(gboolean bool_val, GString *repr);
 gboolean double_repr(double val, GString *repr);

diff --git a/lib/filterx/object-string.c b/lib/filterx/object-string.c
@@ -209,9 +209,9 @@ filterx_protobuf_new(const gchar *mem, gssize mem_len)
 }
 
 FilterXObject *
-filterx_typecast_string(GPtrArray *args)
+filterx_typecast_string(FilterXExpr *s, GPtrArray *args)
 {
-  FilterXObject *object = filterx_typecast_get_arg(args, NULL);
+  FilterXObject *object = filterx_typecast_get_arg(s, args);
   if (!object)
     return NULL;
 
@@ -235,9 +235,9 @@ filterx_typecast_string(GPtrArray *args)
 }
 
 FilterXObject *
-filterx_typecast_bytes(GPtrArray *args)
+filterx_typecast_bytes(FilterXExpr *s, GPtrArray *args)
 {
-  FilterXObject *object = filterx_typecast_get_arg(args, NULL);
+  FilterXObject *object = filterx_typecast_get_arg(s, args);
   if (!object)
     return NULL;
 
@@ -268,9 +268,9 @@ filterx_typecast_bytes(GPtrArray *args)
 }
 
 FilterXObject *
-filterx_typecast_protobuf(GPtrArray *args)
+filterx_typecast_protobuf(FilterXExpr *s, GPtrArray *args)
 {
-  FilterXObject *object = filterx_typecast_get_arg(args, NULL);
+  FilterXObject *object = filterx_typecast_get_arg(s, args);
   if (!object)
     return NULL;
 

diff --git a/lib/filterx/object-string.h b/lib/filterx/object-string.h
@@ -32,9 +32,9 @@ FILTERX_DECLARE_TYPE(protobuf);
 const gchar *filterx_string_get_value(FilterXObject *s, gsize *length);
 const gchar *filterx_bytes_get_value(FilterXObject *s, gsize *length);
 const gchar *filterx_protobuf_get_value(FilterXObject *s, gsize *length);
-FilterXObject *filterx_typecast_string(GPtrArray *args);
-FilterXObject *filterx_typecast_bytes(GPtrArray *args);
-FilterXObject *filterx_typecast_protobuf(GPtrArray *args);
+FilterXObject *filterx_typecast_string(FilterXExpr *s, GPtrArray *args);
+FilterXObject *filterx_typecast_bytes(FilterXExpr *s, GPtrArray *args);
+FilterXObject *filterx_typecast_protobuf(FilterXExpr *s, GPtrArray *args);
 
 FilterXObject *filterx_string_new(const gchar *str, gssize str_len);
 FilterXObject *filterx_bytes_new(const gchar *str, gssize str_len);

diff --git a/lib/filterx/tests/test_builtin_functions.c b/lib/filterx/tests/test_builtin_functions.c
@@ -46,7 +46,7 @@
 #define TEST_BUILTIN_FUNCTION_NAME "TEST_BUILTIN_DUMMY_KEY"
 
 FilterXObject *
-test_builtin_simple_dummy_function(GPtrArray *args)
+test_builtin_simple_dummy_function(FilterXExpr *s, GPtrArray *args)
 {
   return filterx_string_new("test-builtin-functions", -1);
 }
@@ -82,7 +82,7 @@ Test(builtin_functions, test_builtin_simple_functions_lookup)
   cr_assert(func != NULL);
 
   // check dummy function as result
-  FilterXObject *res = func(NULL);
+  FilterXObject *res = func(NULL, NULL);
   cr_assert(res != NULL);
   cr_assert(filterx_object_is_type(res, &FILTERX_TYPE_NAME(string)));
   gsize len;

diff --git a/lib/filterx/tests/test_expr_condition.c b/lib/filterx/tests/test_expr_condition.c
@@ -346,7 +346,7 @@ Test(expr_condition, test_condition_do_not_allow_to_add_else_into_else, .signal=
 }
 
 FilterXObject *
-_fail_func(GPtrArray *args)
+_fail_func(FilterXExpr *s, GPtrArray *args)
 {
   return NULL;
 }
@@ -365,7 +365,7 @@ Test(expr_condition, test_condition_return_null_on_illegal_expr)
 }
 
 FilterXObject *
-_dummy_func(GPtrArray *args)
+_dummy_func(FilterXExpr *s, GPtrArray *args)
 {
   return filterx_string_new("foobar", -1);
 }

diff --git a/lib/filterx/tests/test_expr_function.c b/lib/filterx/tests/test_expr_function.c
@@ -43,7 +43,7 @@
 #include "apphook.h"
 #include "scratch-buffers.h"
 
-FilterXObject *test_dummy_function(GPtrArray *args)
+FilterXObject *test_dummy_function(FilterXExpr *s, GPtrArray *args)
 {
   GString *repr = scratch_buffers_alloc();
   GString *out = scratch_buffers_alloc();