419cb4869e3f80332c562e2837f0b82d76b76fe1
[ira/wip.git] / source / scripting / ejs / mprutil.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    utility functions for manipulating mpr variables in ejs calls
5
6    Copyright (C) Andrew Tridgell 2005
7    
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 2 of the License, or
11    (at your option) any later version.
12    
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.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23 #include "includes.h"
24 #include "lib/appweb/ejs/ejs.h"
25 #include "lib/ldb/include/ldb.h"
26 #include "scripting/ejs/smbcalls.h"
27
28 /*
29   return a default mpr object
30 */
31 struct MprVar mprObject(const char *name)
32 {
33         return ejsCreateObj(name && *name?name:"(NULL)", MPR_DEFAULT_HASH_SIZE);
34 }
35
36 /*
37   return a empty mpr array
38 */
39 struct MprVar mprArray(const char *name)
40 {
41         return ejsCreateArray(name && *name?name:"(NULL)", 0);
42 }
43
44 /*
45   find a mpr component, allowing for sub objects, using the '.' convention
46 */
47  NTSTATUS mprGetVar(struct MprVar **v, const char *name)
48 {
49         const char *p = strchr(name, '.');
50         char *objname;
51         NTSTATUS status;
52         if (p == NULL) {
53                 *v = mprGetProperty(*v, name, NULL);
54                 if (*v == NULL) {
55                         DEBUG(1,("mprGetVar unable to find '%s'\n", name));
56                         return NT_STATUS_INVALID_PARAMETER;
57                 }
58                 return NT_STATUS_OK;
59         }
60         objname = talloc_strndup(mprMemCtx(), name, p-name);
61         NT_STATUS_HAVE_NO_MEMORY(objname);
62         *v = mprGetProperty(*v, objname, NULL);
63         NT_STATUS_HAVE_NO_MEMORY(*v);
64         status = mprGetVar(v, p+1);
65         talloc_free(objname);
66         return status;
67 }
68
69
70 /*
71   set a mpr component, allowing for sub objects, using the '.' convention
72   destroys 'val' after setting
73 */
74  NTSTATUS mprSetVar(struct MprVar *v, const char *name, struct MprVar val)
75 {
76         const char *p = strchr(name, '.');
77         char *objname;
78         struct MprVar *v2;
79         NTSTATUS status;
80         if (p == NULL) {
81                 v2 = mprSetProperty(v, name, &val);
82                 if (v2 == NULL) {
83                         DEBUG(1,("mprSetVar unable to set '%s'\n", name));
84                         return NT_STATUS_INVALID_PARAMETER_MIX;
85                 }
86                 mprDestroyVar(&val);
87                 return NT_STATUS_OK;
88         }
89         objname = talloc_strndup(mprMemCtx(), name, p-name);
90         if (objname == NULL) {
91                 return NT_STATUS_NO_MEMORY;
92         }
93         v2 = mprGetProperty(v, objname, NULL);
94         if (v2 == NULL) {
95                 mprSetVar(v, objname, mprObject(objname));
96                 v2 = mprGetProperty(v, objname, NULL);
97         }
98         status = mprSetVar(v2, p+1, val);
99         talloc_free(objname);
100         return status;
101 }
102
103
104
105 /*
106   add an indexed array element to a property
107 */
108  void mprAddArray(struct MprVar *var, int i, struct MprVar v)
109 {
110         char idx[16];
111         mprItoa(i, idx, sizeof(idx));
112         mprSetVar(var, idx, v);
113 }
114
115 /*
116   construct a MprVar from a list
117 */
118 struct MprVar mprList(const char *name, const char **list)
119 {
120         struct MprVar var;
121         int i;
122
123         var = mprArray(name);
124         for (i=0;list && list[i];i++) {
125                 mprAddArray(&var, i, mprString(list[i]));
126         }
127         return var;
128 }
129
130 /*
131   construct a MprVar from a string, using NULL if needed
132 */
133 struct MprVar mprString(const char *s)
134 {
135         if (s == NULL) {
136                 return mprCreatePtrVar(NULL);
137         }
138         return mprCreateStringVar(s, True);
139 }
140
141 /*
142   construct a string MprVar from a lump of data
143 */
144 struct MprVar mprData(const uint8_t *p, size_t length)
145 {
146         struct MprVar var;
147         char *s = talloc_strndup(mprMemCtx(), (const char *)p, length);
148         if (s == NULL) {
149                 return mprCreateUndefinedVar();
150         }
151         var = mprString(s);
152         talloc_free(s);
153         return var;
154 }
155
156 /*
157   turn a ldb_message into a ejs object variable
158 */
159 static struct MprVar mprLdbMessage(struct ldb_context *ldb, struct ldb_message *msg)
160 {
161         struct MprVar var;
162         int i;
163         /* we force some attributes to always be an array in the
164            returned structure. This makes the scripting easier, as you don't 
165            need a special case for the single value case */
166         const char *multivalued[] = { "objectClass", "memberOf", "privilege", 
167                                             "member", NULL };
168
169         var = mprObject(ldb_dn_linearize(msg, msg->dn));
170
171         for (i=0;i<msg->num_elements;i++) {
172                 struct ldb_message_element *el = &msg->elements[i];
173                 struct MprVar val;
174                 const struct ldb_attrib_handler *attr;
175                 struct ldb_val v;
176
177                 attr = ldb_attrib_handler(ldb, el->name);
178                 if (attr == NULL) {
179                         goto failed;
180                 }
181
182                 if (el->num_values == 1 &&
183                     !str_list_check_ci(multivalued, el->name)) {
184                         if (attr->ldif_write_fn(ldb, msg, &el->values[0], &v) != 0) {
185                                 goto failed;
186                         }
187                         val = mprData(v.data, v.length);
188                 } else {
189                         int j;
190                         val = mprArray(el->name);
191                         for (j=0;j<el->num_values;j++) {
192                                 if (attr->ldif_write_fn(ldb, msg, 
193                                                         &el->values[j], &v) != 0) {
194                                         goto failed;
195                                 }
196                                 mprAddArray(&val, j, mprData(v.data, v.length));
197                         }
198                 }
199                 mprSetVar(&var, el->name, val);
200         }
201
202         /* add the dn if it is not already specified */
203         if (mprGetProperty(&var, "dn", 0) == 0) {
204                 mprSetVar(&var, "dn", mprString(ldb_dn_linearize(msg, msg->dn)));
205         }
206         
207         return var;             
208 failed:
209         return mprCreateUndefinedVar();
210 }
211
212
213 /*
214   turn an array of ldb_messages into a ejs object variable
215 */
216 struct MprVar mprLdbArray(struct ldb_context *ldb, 
217                           struct ldb_message **msg, int count, const char *name)
218 {
219         struct MprVar res;
220         int i;
221
222         res = mprArray(name);
223         for (i=0;i<count;i++) {
224                 mprAddArray(&res, i, mprLdbMessage(ldb, msg[i]));
225         }
226         return res;
227 }
228
229
230 /*
231   turn a MprVar string variable into a const char *
232  */
233 const char *mprToString(struct MprVar *v)
234 {
235         if (v->trigger) {
236                 mprReadProperty(v, 0);
237         }
238         if (!mprVarIsString(v->type)) return NULL;
239         return v->string;
240 }
241
242 /*
243   turn a MprVar integer variable into an int
244  */
245 int mprToInt(struct MprVar *v)
246 {
247         if (v->trigger) {
248                 mprReadProperty(v, 0);
249         }
250         if (!mprVarIsNumber(v->type)) return 0;
251         return mprVarToNumber(v);
252 }
253
254 /*
255   turn a MprVar object variable into a string list
256   this assumes the object variable consists only of strings
257 */
258 const char **mprToList(TALLOC_CTX *mem_ctx, struct MprVar *v)
259 {
260         const char **list = NULL;
261         struct MprVar *el;
262
263         if (v->type != MPR_TYPE_OBJECT ||
264             v->properties == NULL) {
265                 return NULL;
266         }
267         for (el=mprGetFirstProperty(v, MPR_ENUM_DATA);
268              el;
269              el=mprGetNextProperty(v, el, MPR_ENUM_DATA)) {
270                 const char *s = mprToString(el);
271                 if (s) {
272                         list = str_list_add(list, s);
273                 }
274         }
275         talloc_steal(mem_ctx, list);
276         return list;
277 }
278
279
280 /*
281   turn a MprVar object variable into a string list
282   this assumes the object variable is an array of strings
283 */
284 const char **mprToArray(TALLOC_CTX *mem_ctx, struct MprVar *v)
285 {
286         const char **list = NULL;
287         struct MprVar *len;
288         int length, i;
289
290         len = mprGetProperty(v, "length", NULL);
291         if (len == NULL) {
292                 return NULL;
293         }
294         length = mprToInt(len);
295
296         for (i=0;i<length;i++) {
297                 char idx[16];
298                 struct MprVar *vs;
299                 mprItoa(i, idx, sizeof(idx));           
300                 vs = mprGetProperty(v, idx, NULL);
301                 if (vs == NULL || vs->type != MPR_TYPE_STRING) {
302                         talloc_free(list);
303                         return NULL;
304                 }
305                 list = str_list_add(list, mprToString(vs));
306         }
307         talloc_steal(mem_ctx, list);
308         return list;
309 }
310
311 /*
312   turn a NTSTATUS into a MprVar object with lots of funky properties
313 */
314 struct MprVar mprNTSTATUS(NTSTATUS status)
315 {
316         struct MprVar res;
317
318         res = mprObject("ntstatus");
319
320         mprSetVar(&res, "errstr", mprString(nt_errstr(status)));
321         mprSetVar(&res, "v", mprCreateIntegerVar(NT_STATUS_V(status)));
322         mprSetVar(&res, "is_ok", mprCreateBoolVar(NT_STATUS_IS_OK(status)));
323         mprSetVar(&res, "is_err", mprCreateBoolVar(NT_STATUS_IS_ERR(status)));
324
325         return res;
326 }
327
328 /*
329   create a data-blob in a mpr variable
330 */
331 struct MprVar mprDataBlob(DATA_BLOB blob)
332 {
333         struct MprVar res;
334         struct datablob *pblob = talloc(mprMemCtx(), struct datablob);
335         *pblob = data_blob_talloc(pblob, blob.data, blob.length);
336
337         res = mprObject("DATA_BLOB");
338
339         mprSetVar(&res, "size", mprCreateIntegerVar(blob.length));
340         mprSetPtrChild(&res, "blob", pblob);
341
342         return res;
343 }
344
345 /*
346   return a data blob from a mpr var created using mprDataBlob
347 */
348 struct datablob *mprToDataBlob(struct MprVar *v)
349 {
350         return talloc_get_type(mprGetPtr(v, "blob"), struct datablob);
351 }
352
353 /*
354   turn a WERROR into a MprVar object with lots of funky properties
355 */
356 struct MprVar mprWERROR(WERROR status)
357 {
358         struct MprVar res;
359
360         res = mprObject("werror");
361
362         mprSetVar(&res, "errstr", mprString(win_errstr(status)));
363         mprSetVar(&res, "v", mprCreateIntegerVar(W_ERROR_V(status)));
364         mprSetVar(&res, "is_ok", mprCreateBoolVar(W_ERROR_IS_OK(status)));
365         mprSetVar(&res, "is_err", mprCreateBoolVar(!W_ERROR_IS_OK(status)));
366
367         return res;
368 }
369
370
371 /*
372   set a pointer in a existing MprVar
373 */
374 void mprSetPtr(struct MprVar *v, const char *propname, const void *p)
375 {
376         mprSetVar(v, propname, mprCreatePtrVar(discard_const(p)));
377 }
378
379 /*
380   set a pointer in a existing MprVar, freeing it when the property goes away
381 */
382 void mprSetPtrChild(struct MprVar *v, const char *propname, const void *p)
383 {
384         mprSetVar(v, propname, mprCreatePtrVar(discard_const(p)));
385         v = mprGetProperty(v, propname, NULL);
386         v->allocatedData = 1;
387         talloc_steal(mprMemCtx(), p);
388 }
389
390 /*
391   get a pointer from a MprVar
392 */
393 void *mprGetPtr(struct MprVar *v, const char *propname)
394 {
395         struct MprVar *val;
396         val = mprGetProperty(v, propname, NULL);
397         if (val == NULL) {
398                 return NULL;
399         }
400         if (val->type != MPR_TYPE_PTR) {
401                 return NULL;
402         }
403         return val->ptr;
404 }
405
406 /*
407   set the return value then free the variable
408 */
409  void mpr_Return(int eid, struct MprVar v)
410
411         ejsSetReturnValue(eid, v);
412         mprDestroyVar(&v);
413 }
414
415 /*
416   set the return value then free the variable
417 */
418 void mpr_ReturnString(int eid, const char *s)
419
420         mpr_Return(eid, mprString(s));
421 }
422
423
424 /*
425   set a C function in a variable
426 */
427  void mprSetCFunction(struct MprVar *obj, const char *name, MprCFunction fn)
428 {
429         mprSetVar(obj, name, mprCreateCFunctionVar(fn, obj, MPR_VAR_SCRIPT_HANDLE));
430 }
431
432 /*
433   set a string C function in a variable
434 */
435  void mprSetStringCFunction(struct MprVar *obj, const char *name, MprStringCFunction fn)
436 {
437         mprSetVar(obj, name, mprCreateStringCFunctionVar(fn, obj, MPR_VAR_SCRIPT_HANDLE));
438 }
439
440 /*
441   get a pointer in the current object
442 */
443 void *mprGetThisPtr(int eid, const char *name)
444 {
445         struct MprVar *this = mprGetProperty(ejsGetLocalObject(eid), "this", 0);
446         return mprGetPtr(this, name);
447 }
448
449 /*
450   set a pointer as a child of the local object
451 */
452 void mprSetThisPtr(int eid, const char *name, void *ptr)
453 {
454         struct MprVar *this = mprGetProperty(ejsGetLocalObject(eid), "this", 0);
455         mprSetPtrChild(this, name, ptr);
456 }
457
458 /*
459   used by object xxx_init() routines to allow for the caller
460   to supply a pre-existing object to add properties to,
461   or create a new object. This makes inheritance easy
462 */
463 struct MprVar *mprInitObject(int eid, const char *name, int argc, struct MprVar **argv)
464 {
465         if (argc > 0 && mprVarIsObject(argv[0]->type)) {
466                 return argv[0];
467         }
468         mpr_Return(eid, mprObject(name));
469         return ejsGetReturnValue(eid);
470 }