2 Unix SMB/CIFS implementation.
4 utility functions for manipulating mpr variables in ejs calls
6 Copyright (C) Andrew Tridgell 2005
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "lib/appweb/ejs/ejs.h"
24 #include "lib/ldb/include/ldb.h"
25 #include "scripting/ejs/smbcalls.h"
28 return a default mpr object
30 struct MprVar mprObject(const char *name)
32 return ejsCreateObj(name && *name?name:"(NULL)", MPR_DEFAULT_HASH_SIZE);
36 return a empty mpr array
38 struct MprVar mprArray(const char *name)
40 return ejsCreateArray(name && *name?name:"(NULL)", 0);
44 find a mpr component, allowing for sub objects, using the '.' convention
46 NTSTATUS mprGetVar(struct MprVar **v, const char *name)
48 const char *p = strchr(name, '.');
52 *v = mprGetProperty(*v, name, NULL);
54 DEBUG(1,("mprGetVar unable to find '%s'\n", name));
55 return NT_STATUS_INVALID_PARAMETER;
59 objname = talloc_strndup(mprMemCtx(), name, p-name);
60 NT_STATUS_HAVE_NO_MEMORY(objname);
61 *v = mprGetProperty(*v, objname, NULL);
62 NT_STATUS_HAVE_NO_MEMORY(*v);
63 status = mprGetVar(v, p+1);
70 set a mpr component, allowing for sub objects, using the '.' convention
71 destroys 'val' after setting
73 NTSTATUS mprSetVar(struct MprVar *v, const char *name, struct MprVar val)
75 const char *p = strchr(name, '.');
80 v2 = mprSetProperty(v, name, &val);
82 DEBUG(1,("mprSetVar unable to set '%s'\n", name));
83 return NT_STATUS_INVALID_PARAMETER_MIX;
88 objname = talloc_strndup(mprMemCtx(), name, p-name);
89 if (objname == NULL) {
90 return NT_STATUS_NO_MEMORY;
92 v2 = mprGetProperty(v, objname, NULL);
94 mprSetVar(v, objname, mprObject(objname));
95 v2 = mprGetProperty(v, objname, NULL);
97 status = mprSetVar(v2, p+1, val);
105 add an indexed array element to a property
107 void mprAddArray(struct MprVar *var, int i, struct MprVar v)
110 mprItoa(i, idx, sizeof(idx));
111 mprSetVar(var, idx, v);
115 construct a MprVar from a list
117 struct MprVar mprList(const char *name, const char **list)
122 var = mprArray(name);
123 for (i=0;list && list[i];i++) {
124 mprAddArray(&var, i, mprString(list[i]));
130 construct a MprVar from a string, using NULL if needed
132 struct MprVar mprString(const char *s)
135 return mprCreatePtrVar(NULL);
137 return mprCreateStringVar(s, True);
141 construct a string MprVar from a lump of data
143 struct MprVar mprData(const uint8_t *p, size_t length)
146 char *s = talloc_strndup(mprMemCtx(), (const char *)p, length);
148 return mprCreateUndefinedVar();
156 turn a ldb_message into a ejs object variable
158 static struct MprVar mprLdbMessage(struct ldb_context *ldb, struct ldb_message *msg)
162 /* we force some attributes to always be an array in the
163 returned structure. This makes the scripting easier, as you don't
164 need a special case for the single value case */
165 const char *multivalued[] = { "objectClass", "memberOf", "privilege",
168 var = mprObject(ldb_dn_alloc_linearized(msg, msg->dn));
170 for (i=0;i<msg->num_elements;i++) {
171 struct ldb_message_element *el = &msg->elements[i];
173 const struct ldb_schema_attribute *a;
176 a = ldb_schema_attribute_by_name(ldb, el->name);
181 if (el->num_values == 1 &&
182 !str_list_check_ci(multivalued, el->name)) {
183 if (a->syntax->ldif_write_fn(ldb, msg, &el->values[0], &v) != 0) {
186 /* FIXME: nasty hack, remove me when ejs will support
187 * arbitrary string and does not truncate on \0 */
188 if (strlen((char *)v.data) != v.length) {
189 val = mprDataBlob(v);
191 val = mprData(v.data, v.length);
195 val = mprArray(el->name);
196 for (j=0;j<el->num_values;j++) {
197 if (a->syntax->ldif_write_fn(ldb, msg,
198 &el->values[j], &v) != 0) {
201 /* FIXME: nasty hack, remove me when ejs will support
202 * arbitrary string and does not truncate on \0 */
203 if (strlen((char *)v.data) != v.length) {
204 mprAddArray(&val, j, mprDataBlob(v));
206 mprAddArray(&val, j, mprData(v.data, v.length));
210 mprSetVar(&var, el->name, val);
213 /* add the dn if it is not already specified */
214 if (mprGetProperty(&var, "dn", 0) == 0) {
215 mprSetVar(&var, "dn", mprString(ldb_dn_alloc_linearized(msg, msg->dn)));
220 return mprCreateUndefinedVar();
225 build a MprVar result object for ldb operations with lots of funky properties
227 struct MprVar mprLdbResult(struct ldb_context *ldb, int err, struct ldb_result *result)
232 ret = mprObject("ldbret");
234 mprSetVar(&ret, "error", mprCreateIntegerVar(err));
235 mprSetVar(&ret, "errstr", mprString(ldb_errstring(ldb)));
237 ary = mprArray("ldb_message");
241 for (i = 0; i < result->count; i++) {
242 mprAddArray(&ary, i, mprLdbMessage(ldb, result->msgs[i]));
246 mprSetVar(&ret, "msgs", ary);
248 /* TODO: add referrals, exteded ops, and controls */
255 turn a MprVar string variable into a const char *
257 const char *mprToString(struct MprVar *v)
260 mprReadProperty(v, 0);
262 if (!mprVarIsString(v->type)) return NULL;
267 turn a MprVar integer variable into an int
269 int mprToInt(struct MprVar *v)
272 mprReadProperty(v, 0);
274 if (!mprVarIsNumber(v->type)) return 0;
275 return mprVarToNumber(v);
279 turn a MprVar object variable into a string list
280 this assumes the object variable consists only of strings
282 const char **mprToList(TALLOC_CTX *mem_ctx, struct MprVar *v)
284 const char **list = NULL;
287 if (v->type != MPR_TYPE_OBJECT ||
288 v->properties == NULL) {
291 for (el=mprGetFirstProperty(v, MPR_ENUM_DATA);
293 el=mprGetNextProperty(v, el, MPR_ENUM_DATA)) {
294 const char *s = mprToString(el);
296 list = str_list_add(list, s);
299 talloc_steal(mem_ctx, list);
305 turn a MprVar object variable into a string list
306 this assumes the object variable is an array of strings
308 const char **mprToArray(TALLOC_CTX *mem_ctx, struct MprVar *v)
310 const char **list = NULL;
314 len = mprGetProperty(v, "length", NULL);
318 length = mprToInt(len);
320 for (i=0;i<length;i++) {
323 mprItoa(i, idx, sizeof(idx));
324 vs = mprGetProperty(v, idx, NULL);
325 if (vs == NULL || vs->type != MPR_TYPE_STRING) {
329 list = str_list_add(list, mprToString(vs));
331 talloc_steal(mem_ctx, list);
336 turn a NTSTATUS into a MprVar object with lots of funky properties
338 struct MprVar mprNTSTATUS(NTSTATUS status)
342 res = mprObject("ntstatus");
344 mprSetVar(&res, "errstr", mprString(nt_errstr(status)));
345 mprSetVar(&res, "v", mprCreateIntegerVar(NT_STATUS_V(status)));
346 mprSetVar(&res, "is_ok", mprCreateBoolVar(NT_STATUS_IS_OK(status)));
347 mprSetVar(&res, "is_err", mprCreateBoolVar(NT_STATUS_IS_ERR(status)));
353 create a data-blob in a mpr variable
355 struct MprVar mprDataBlob(DATA_BLOB blob)
358 struct datablob *pblob = talloc(mprMemCtx(), struct datablob);
359 *pblob = data_blob_talloc(pblob, blob.data, blob.length);
361 res = mprObject("DATA_BLOB");
363 mprSetVar(&res, "size", mprCreateIntegerVar(blob.length));
364 mprSetPtrChild(&res, "blob", pblob);
370 return a data blob from a mpr var created using mprDataBlob
372 struct datablob *mprToDataBlob(struct MprVar *v)
374 return talloc_get_type(mprGetPtr(v, "blob"), struct datablob);
378 turn a WERROR into a MprVar object with lots of funky properties
380 struct MprVar mprWERROR(WERROR status)
384 res = mprObject("werror");
386 mprSetVar(&res, "errstr", mprString(win_errstr(status)));
387 mprSetVar(&res, "v", mprCreateIntegerVar(W_ERROR_V(status)));
388 mprSetVar(&res, "is_ok", mprCreateBoolVar(W_ERROR_IS_OK(status)));
389 mprSetVar(&res, "is_err", mprCreateBoolVar(!W_ERROR_IS_OK(status)));
396 set a pointer in a existing MprVar
398 void mprSetPtr(struct MprVar *v, const char *propname, const void *p)
400 mprSetVar(v, propname, mprCreatePtrVar(discard_const(p)));
404 set a pointer in a existing MprVar, freeing it when the property goes away
406 void mprSetPtrChild(struct MprVar *v, const char *propname, const void *p)
408 mprSetVar(v, propname, mprCreatePtrVar(discard_const(p)));
409 v = mprGetProperty(v, propname, NULL);
410 v->allocatedData = 1;
411 talloc_steal(mprMemCtx(), p);
415 get a pointer from a MprVar
417 void *mprGetPtr(struct MprVar *v, const char *propname)
420 val = mprGetProperty(v, propname, NULL);
424 if (val->type != MPR_TYPE_PTR) {
431 set the return value then free the variable
433 void mpr_Return(int eid, struct MprVar v)
435 ejsSetReturnValue(eid, v);
440 set the return value then free the variable
442 void mpr_ReturnString(int eid, const char *s)
444 mpr_Return(eid, mprString(s));
449 set a C function in a variable
451 void mprSetCFunction(struct MprVar *obj, const char *name, MprCFunction fn)
453 mprSetVar(obj, name, mprCreateCFunctionVar(fn, obj, MPR_VAR_SCRIPT_HANDLE));
457 set a string C function in a variable
459 void mprSetStringCFunction(struct MprVar *obj, const char *name, MprStringCFunction fn)
461 mprSetVar(obj, name, mprCreateStringCFunctionVar(fn, obj, MPR_VAR_SCRIPT_HANDLE));
465 get a pointer in the current object
467 void *mprGetThisPtr(int eid, const char *name)
469 struct MprVar *this = mprGetProperty(ejsGetLocalObject(eid), "this", 0);
470 return mprGetPtr(this, name);
474 set a pointer as a child of the local object
476 void mprSetThisPtr(int eid, const char *name, void *ptr)
478 struct MprVar *this = mprGetProperty(ejsGetLocalObject(eid), "this", 0);
479 mprSetPtrChild(this, name, ptr);
483 used by object xxx_init() routines to allow for the caller
484 to supply a pre-existing object to add properties to,
485 or create a new object. This makes inheritance easy
487 struct MprVar *mprInitObject(int eid, const char *name, int argc, struct MprVar **argv)
489 if (argc > 0 && mprVarIsObject(argv[0]->type)) {
492 mpr_Return(eid, mprObject(name));
493 return ejsGetReturnValue(eid);