libamxd  6.4.1
Data Model Manager
amxd_action_object_write.c File Reference
#include <stdlib.h>
#include "amxd_priv.h"
#include <amxd/amxd_dm.h>
#include <amxd/amxd_action.h>
#include <amxd/amxd_object.h>
#include <amxd/amxd_path.h>
#include "amxd_assert.h"

Go to the source code of this file.

Functions

static amxd_status_t amxd_can_set_parameter (const amxd_object_t *const object, const amxd_param_t *const param, bool set_read_only, amxd_dm_access_t access)
 
static amxc_var_t * amxd_set_action_get_result (const amxd_object_t *object, amxc_var_t *retval)
 
static void amxd_set_action_add_error (amxc_var_t *result, const char *name, bool required, amxd_status_t status)
 
static void amxd_set_action_add_result (amxc_var_t *result, const char *name, uint32_t type, amxc_var_t *value)
 
static amxd_status_t amxd_action_set_value (amxd_object_t *object, amxd_dm_access_t access, const char *name, amxc_var_t *value, bool ro, bool required, amxc_var_t *ret)
 
bool PRIVATE amxd_param_is_unique (amxd_object_t *const templ, amxd_object_t *const current, amxd_param_t *const param, const amxc_var_t *const value)
 
amxd_status_t PRIVATE amxd_action_set_values (amxd_object_t *const object, amxd_dm_access_t access, bool ro, const amxc_var_t *values, amxc_var_t *ret, bool required)
 
amxd_status_t amxd_action_object_write (amxd_object_t *const object, UNUSED amxd_param_t *const p, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, UNUSED void *priv)
 
amxd_status_t amxd_object_set_params (amxd_object_t *const object, amxc_var_t *const values)
 Sets multiple parameter values in a data model object. More...
 

Function Documentation

◆ amxd_action_object_write()

amxd_status_t amxd_action_object_write ( amxd_object_t *const  object,
UNUSED amxd_param_t *const  p,
amxd_action_t  reason,
const amxc_var_t *const  args,
amxc_var_t *const  retval,
UNUSED void *  priv 
)

Definition at line 220 of file amxd_action_object_write.c.

225  {
227  amxc_var_t* params = NULL;
229  bool set_read_only = false;
230 
231  when_null(object, exit);
232  when_null_status(args, exit, status = amxd_status_invalid_function_argument);
233  when_true_status(reason != action_object_write,
234  exit,
236 
237  when_true_status(amxc_var_type_of(args) != AMXC_VAR_ID_HTABLE,
238  exit,
240 
241  amxc_var_set_type(retval, AMXC_VAR_ID_HTABLE);
242  access = (amxd_dm_access_t) amxc_var_dyncast(uint32_t, GET_ARG(args, "access"));
243  set_read_only = GET_BOOL(args, "set_read_only");
244 
245  if(amxd_action_verify_access(object, access)) {
246  params = amxc_var_get_key(args, "parameters", AMXC_VAR_FLAG_DEFAULT);
247  if(params != NULL) {
248  when_true_status(amxc_var_type_of(params) != AMXC_VAR_ID_HTABLE,
249  exit,
251  status = amxd_action_set_values(object, access, set_read_only, params, retval, true);
252  when_failed(status, exit);
253  }
254  params = amxc_var_get_key(args, "oparameters", AMXC_VAR_FLAG_DEFAULT);
255  if(params != NULL) {
256  when_true_status(amxc_var_type_of(params) != AMXC_VAR_ID_HTABLE,
257  exit,
259  amxd_action_set_values(object, access, set_read_only, params, retval, false);
260  }
262  } else {
264  }
265 
266 exit:
267  return status;
268 }
amxd_status_t PRIVATE amxd_action_set_values(amxd_object_t *const object, amxd_dm_access_t access, bool ro, const amxc_var_t *values, amxc_var_t *ret, bool required)
bool amxd_action_verify_access(amxd_object_t *object, amxd_dm_access_t access)
@ action_object_write
Definition: amxd_types.h:118
enum _amxd_status amxd_status_t
@ amxd_status_function_not_implemented
Definition: amxd_types.h:83
@ amxd_status_object_not_found
Definition: amxd_types.h:80
@ amxd_status_invalid_function_argument
Definition: amxd_types.h:85
@ amxd_status_ok
Definition: amxd_types.h:78
@ amxd_status_unknown_error
Definition: amxd_types.h:79
enum _amxd_dm_access amxd_dm_access_t
Access level.
@ amxd_dm_access_public
Definition: amxd_types.h:136
static amxd_status_t status

◆ amxd_action_set_value()

static amxd_status_t amxd_action_set_value ( amxd_object_t object,
amxd_dm_access_t  access,
const char *  name,
amxc_var_t *  value,
bool  ro,
bool  required,
amxc_var_t *  ret 
)
static

Definition at line 127 of file amxd_action_object_write.c.

133  {
134  amxc_var_t* obj_result = NULL;
135  amxd_param_t* param = NULL;
137 
138  param = amxd_object_get_param_def(object, name);
139  if(param == NULL) {
140  obj_result = amxd_set_action_get_result(object, ret);
141  amxd_set_action_add_error(obj_result, name, required, amxd_status_parameter_not_found);
143  goto exit;
144  }
145  object = amxd_param_get_owner(param);
146  obj_result = amxd_set_action_get_result(object, ret);
147 
148  status = amxd_can_set_parameter(object, param, ro, access);
149  if(status != amxd_status_ok) {
150  amxd_set_action_add_error(obj_result, name, required, status);
151  goto exit;
152  }
153 
154  status = amxd_param_set_value(param, value);
155  if(status != amxd_status_ok) {
156  amxd_set_action_add_error(obj_result, name, required, status);
157  goto exit;
158  }
159 
160  amxd_set_action_add_result(obj_result, amxd_param_get_name(param), amxd_param_get_type(param), value);
161 
162 exit:
163  return status;
164 }
static amxd_status_t amxd_can_set_parameter(const amxd_object_t *const object, const amxd_param_t *const param, bool set_read_only, amxd_dm_access_t access)
static void amxd_set_action_add_error(amxc_var_t *result, const char *name, bool required, amxd_status_t status)
static amxc_var_t * amxd_set_action_get_result(const amxd_object_t *object, amxc_var_t *retval)
static void amxd_set_action_add_result(amxc_var_t *result, const char *name, uint32_t type, amxc_var_t *value)
const char * amxd_param_get_name(const amxd_param_t *const param)
amxd_status_t amxd_param_set_value(amxd_param_t *const param, const amxc_var_t *const value)
static uint32_t amxd_param_get_type(const amxd_param_t *const param)
amxd_object_t * amxd_param_get_owner(const amxd_param_t *const param)
@ amxd_status_parameter_not_found
Definition: amxd_types.h:82
amxd_param_t * amxd_object_get_param_def(const amxd_object_t *const object, const char *name)
Gets a parameter definition from an object.

◆ amxd_action_set_values()

amxd_status_t PRIVATE amxd_action_set_values ( amxd_object_t *const  object,
amxd_dm_access_t  access,
bool  ro,
const amxc_var_t *  values,
amxc_var_t *  ret,
bool  required 
)

Definition at line 186 of file amxd_action_object_write.c.

191  {
193 
194  amxc_var_for_each(value, values) {
195  const char* name = amxc_var_key(value);
197  if(amxc_var_type_of(value) == AMXC_VAR_ID_HTABLE) {
198  amxd_object_t* instance = NULL;
199  when_true_status(amxd_object_get_type(object) != amxd_object_template,
200  exit,
202  instance = amxd_object_get_instance(object, name, 0);
203  when_null_status(instance, exit, status = amxd_status_object_not_found);
204  ps = amxd_action_set_values(instance, access, ro, value, ret, required);
205  if(ps != amxd_status_ok) {
206  status = ps;
207  }
208  } else {
209  ps = amxd_action_set_value(object, access, name, value, ro, required, ret);
210  if(ps != amxd_status_ok) {
211  status = ps;
212  }
213  }
214  }
215 
216 exit:
217  return status;
218 }
static amxd_status_t amxd_action_set_value(amxd_object_t *object, amxd_dm_access_t access, const char *name, amxc_var_t *value, bool ro, bool required, amxc_var_t *ret)
@ amxd_object_template
Definition: amxd_types.h:183
amxd_object_t * amxd_object_get_instance(const amxd_object_t *object, const char *name, uint32_t index)
Get an instance of the template object.
static amxd_object_type_t amxd_object_get_type(const amxd_object_t *const object)
Returns the object type.
Definition: amxd_object.h:586

◆ amxd_can_set_parameter()

static amxd_status_t amxd_can_set_parameter ( const amxd_object_t *const  object,
const amxd_param_t *const  param,
bool  set_read_only,
amxd_dm_access_t  access 
)
static

Definition at line 66 of file amxd_action_object_write.c.

69  {
71 
72  when_true_status(amxd_param_is_attr_set(param, amxd_pattr_private) &&
73  access != amxd_dm_access_private,
74  exit,
76  when_true_status(object->type == amxd_object_instance &&
78  exit,
80  when_true_status(object->type == amxd_object_template &&
82  exit,
84  when_true_status(amxd_param_is_attr_set(param, amxd_pattr_read_only) &&
85  !set_read_only,
86  exit,
88 
89 exit:
90  return status;
91 }
bool amxd_param_is_attr_set(const amxd_param_t *const param, const amxd_pattr_id_t attr)
@ amxd_pattr_template
Definition: amxd_types.h:355
@ amxd_pattr_private
Definition: amxd_types.h:357
@ amxd_pattr_instance
Definition: amxd_types.h:356
@ amxd_pattr_read_only
Definition: amxd_types.h:358
@ amxd_status_read_only
Definition: amxd_types.h:93
@ amxd_dm_access_private
Definition: amxd_types.h:141
@ amxd_object_instance
Definition: amxd_types.h:186
amxd_object_type_t type
Definition: amxd_types.h:236

◆ amxd_param_is_unique()

bool PRIVATE amxd_param_is_unique ( amxd_object_t *const  templ,
amxd_object_t *const  current,
amxd_param_t *const  param,
const amxc_var_t *const  value 
)

Definition at line 166 of file amxd_action_object_write.c.

169  {
170  bool unique = true;
173  const char* pname = amxd_param_get_name(param);
174  char* v = amxc_var_dyncast(cstring_t, value);
175  amxd_object_t* instance = amxd_object_findf(templ, "[%s == '%s']", pname, v);
176  free(v);
177  if((instance != NULL) && (instance != current)) {
178  unique = false;
179  }
180 
181  }
182 
183  return unique;
184 }
@ amxd_pattr_unique
Definition: amxd_types.h:363
@ amxd_pattr_key
Definition: amxd_types.h:362
amxd_object_t * amxd_object_findf(amxd_object_t *object, const char *rel_path,...) __attribute__((format(printf
Find an object in the data model tree, starting from an object.

◆ amxd_set_action_add_error()

static void amxd_set_action_add_error ( amxc_var_t *  result,
const char *  name,
bool  required,
amxd_status_t  status 
)
static

Definition at line 109 of file amxd_action_object_write.c.

112  {
113  result = amxc_var_add_key(amxc_htable_t, result, name, NULL);
114  amxc_var_add_key(uint32_t, result, "error_code", status);
115  amxc_var_add_key(bool, result, "required", required);
116 }

◆ amxd_set_action_add_result()

static void amxd_set_action_add_result ( amxc_var_t *  result,
const char *  name,
uint32_t  type,
amxc_var_t *  value 
)
static

Definition at line 118 of file amxd_action_object_write.c.

121  {
122  result = amxc_var_add_new_key(result, name);
123  amxc_var_copy(result, value);
124  amxc_var_cast(result, type);
125 }

◆ amxd_set_action_get_result()

static amxc_var_t* amxd_set_action_get_result ( const amxd_object_t object,
amxc_var_t *  retval 
)
static

Definition at line 93 of file amxd_action_object_write.c.

93  {
95  amxc_var_t* result = GET_ARG(retval, path);
96 
97  if(result == NULL) {
98  result = amxc_var_add_new_key(retval, path);
99  amxc_var_set_type(result, AMXC_VAR_ID_HTABLE);
100  result = amxc_var_add_key(amxc_htable_t, result, "parameters", NULL);
101  } else {
102  result = GET_ARG(result, "parameters");
103  }
104 
105  free(path);
106  return result;
107 }
#define AMXD_OBJECT_INDEXED
Name and path format flag - use index for instance objects.
Definition: amxd_object.h:176
#define AMXD_OBJECT_TERMINATE
Path format flag - when set the object path is terminated with a dot.
Definition: amxd_object.h:214
amxd_object_t amxd_status_t amxd_status_t char * amxd_object_get_path(const amxd_object_t *object, const uint32_t flags)
Get the full path of the object.