|
@@ -0,0 +1,910 @@
|
|
|
|
+/**
|
|
|
|
+ * Copyright (C) 2014 Daniel-Constantin Mierla (asipto.com)
|
|
|
|
+ *
|
|
|
|
+ * This file is part of Kamailio, a free SIP server.
|
|
|
|
+ *
|
|
|
|
+ * Kamailio is free software; you can redistribute it and/or modify
|
|
|
|
+ * it under the terms of the GNU General Public License as published by
|
|
|
|
+ * the Free Software Foundation; either version 2 of the License, or
|
|
|
|
+ * (at your option) any later version
|
|
|
|
+ *
|
|
|
|
+ * Kamailio is distributed in the hope that it will be useful,
|
|
|
|
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
+ * GNU General Public License for more details.
|
|
|
|
+ *
|
|
|
|
+ * You should have received a copy of the GNU General Public License
|
|
|
|
+ * along with this program; if not, write to the Free Software
|
|
|
|
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
+ *
|
|
|
|
+ */
|
|
|
|
+
|
|
|
|
+#include <string.h>
|
|
|
|
+#include <stdlib.h>
|
|
|
|
+#include <stdio.h>
|
|
|
|
+#include <stdarg.h>
|
|
|
|
+
|
|
|
|
+#include "../../ver.h"
|
|
|
|
+#include "../../trim.h"
|
|
|
|
+#include "../../sr_module.h"
|
|
|
|
+#include "../../nonsip_hooks.h"
|
|
|
|
+#include "../../modules/xhttp/api.h"
|
|
|
|
+
|
|
|
|
+#include "jsonrpc-s_mod.h"
|
|
|
|
+
|
|
|
|
+/** @addtogroup jsonrpc-s
|
|
|
|
+ * @ingroup modules
|
|
|
|
+ * @{
|
|
|
|
+ *
|
|
|
|
+ * <h1>Overview of Operation</h1>
|
|
|
|
+ * This module provides jsonrpc over http server implementation.
|
|
|
|
+ */
|
|
|
|
+
|
|
|
|
+/** @file
|
|
|
|
+ *
|
|
|
|
+ * This is the main file of jsonrpc-s module which contains all the functions
|
|
|
|
+ * related to http processing, as well as the module interface.
|
|
|
|
+ */
|
|
|
|
+
|
|
|
|
+MODULE_VERSION
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+#define jsonrpc_malloc pkg_malloc
|
|
|
|
+#define jsonrpc_free pkg_free
|
|
|
|
+
|
|
|
|
+str JSONRPC_REASON_OK = str_init("OK");
|
|
|
|
+str JSONRPC_CONTENT_TYPE_HTML = str_init("application/json");
|
|
|
|
+
|
|
|
|
+static int jsonrpc_pretty_format = 0;
|
|
|
|
+
|
|
|
|
+static int jsonrpc_register_rpc(void);
|
|
|
|
+
|
|
|
|
+static int mod_init(void);
|
|
|
|
+static int child_init(int rank);
|
|
|
|
+static int jsonrpc_dispatch(sip_msg_t* msg, char* s1, char* s2);
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+/** The context of the jsonrpc request being processed.
|
|
|
|
+ *
|
|
|
|
+ * This is a global variable that records the context of the jsonrpc request
|
|
|
|
+ * being currently processed.
|
|
|
|
+ * @sa rpc_ctx
|
|
|
|
+ */
|
|
|
|
+static jsonrpc_ctx_t _jsonrpc_ctx;
|
|
|
|
+
|
|
|
|
+static xhttp_api_t xhttp_api;
|
|
|
|
+
|
|
|
|
+/** Pointers to the functions that implement the RPC interface
|
|
|
|
+ * of jsonrpc module
|
|
|
|
+ */
|
|
|
|
+static rpc_t func_param;
|
|
|
|
+
|
|
|
|
+#define JSONRPC_ERROR_REASON_BUF_LEN 128
|
|
|
|
+#define JSONRPC_PRINT_VALUE_BUF_LEN 1024
|
|
|
|
+
|
|
|
|
+char jsonrpc_error_buf[JSONRPC_ERROR_REASON_BUF_LEN];
|
|
|
|
+
|
|
|
|
+static cmd_export_t cmds[] = {
|
|
|
|
+ {"jsonrpc_dispatch", (cmd_function)jsonrpc_dispatch, 0, 0, 0, REQUEST_ROUTE},
|
|
|
|
+ {0, 0, 0, 0, 0, 0}
|
|
|
|
+};
|
|
|
|
+
|
|
|
|
+static param_export_t params[] = {
|
|
|
|
+ {"pretty_format", PARAM_INT, &jsonrpc_pretty_format},
|
|
|
|
+ {0, 0, 0}
|
|
|
|
+};
|
|
|
|
+
|
|
|
|
+/** module exports */
|
|
|
|
+struct module_exports exports= {
|
|
|
|
+ "jsonrpc-s",
|
|
|
|
+ DEFAULT_DLFLAGS, /* dlopen flags */
|
|
|
|
+ cmds,
|
|
|
|
+ params,
|
|
|
|
+ 0, /* exported statistics */
|
|
|
|
+ 0, /* exported MI functions */
|
|
|
|
+ 0, /* exported pseudo-variables */
|
|
|
|
+ 0, /* extra processes */
|
|
|
|
+ mod_init, /* module initialization function */
|
|
|
|
+ 0,
|
|
|
|
+ 0,
|
|
|
|
+ child_init /* per-child init function */
|
|
|
|
+};
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+typedef struct jsonrpc_error {
|
|
|
|
+ int code;
|
|
|
|
+ str text;
|
|
|
|
+} jsonrpc_error_t;
|
|
|
|
+
|
|
|
|
+static jsonrpc_error_t _jsonrpc_error_table[] = {
|
|
|
|
+ { -32700, { "Parse Error", 11 } },
|
|
|
|
+ { -32600, { "Invalid Request", 15 } },
|
|
|
|
+ { -32601, { "Method Not Found", 16 } },
|
|
|
|
+ { -32602, { "Invalid Parameters", 18 } },
|
|
|
|
+ { -32603, { "Internal Error", 14 } },
|
|
|
|
+ { -32000, { "Execution Error", 15 } },
|
|
|
|
+ {0, { 0, 0 } }
|
|
|
|
+};
|
|
|
|
+
|
|
|
|
+/** Implementation of rpc_fault function required by the management API.
|
|
|
|
+ *
|
|
|
|
+ * This function will be called whenever a management function
|
|
|
|
+ * indicates that an error ocurred while it was processing the request. The
|
|
|
|
+ * function takes the reply code and reason phrase as parameters, these will
|
|
|
|
+ * be put in the body of the reply.
|
|
|
|
+ *
|
|
|
|
+ * @param ctx A pointer to the context structure of the request being
|
|
|
|
+ * processed.
|
|
|
|
+ * @param code Reason code.
|
|
|
|
+ * @param fmt Formatting string used to build the reason phrase.
|
|
|
|
+ */
|
|
|
|
+static void jsonrpc_fault(jsonrpc_ctx_t* ctx, int code, char* fmt, ...)
|
|
|
|
+{
|
|
|
|
+ va_list ap;
|
|
|
|
+
|
|
|
|
+ ctx->http_code = code;
|
|
|
|
+ va_start(ap, fmt);
|
|
|
|
+ vsnprintf(jsonrpc_error_buf, JSONRPC_ERROR_REASON_BUF_LEN, fmt, ap);
|
|
|
|
+ va_end(ap);
|
|
|
|
+ ctx->http_text.len = strlen(jsonrpc_error_buf);
|
|
|
|
+ ctx->http_text.s = jsonrpc_error_buf;
|
|
|
|
+ if(ctx->error_code == 0) ctx->error_code = -32000;
|
|
|
|
+
|
|
|
|
+ return;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+/** Initialize jsonrpc reply data structure.
|
|
|
|
+ *
|
|
|
|
+ * This function initializes the data structure that contains all data related
|
|
|
|
+ * to the jsonrpc reply being created. The function must be called before any
|
|
|
|
+ * other function that adds data to the reply.
|
|
|
|
+ * @param ctx jsonrpc_ctx_t structure to be initialized.
|
|
|
|
+ * @return 0 on success, a negative number on error.
|
|
|
|
+ */
|
|
|
|
+static int jsonrpc_init_reply(jsonrpc_ctx_t *ctx)
|
|
|
|
+{
|
|
|
|
+ ctx->http_code = 200;
|
|
|
|
+ ctx->http_text = JSONRPC_REASON_OK;
|
|
|
|
+ ctx->jrpl = srjson_NewDoc(NULL);
|
|
|
|
+ if(ctx->jrpl==NULL) {
|
|
|
|
+ LM_ERR("Failed to init the reply json document\n");
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+ ctx->jrpl->root = srjson_CreateObject(ctx->jrpl);
|
|
|
|
+ if(ctx->jrpl->root==NULL) {
|
|
|
|
+ LM_ERR("Failed to init the reply json root node\n");
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+ srjson_AddStrStrToObject(ctx->jrpl, ctx->jrpl->root,
|
|
|
|
+ "jsonrpc", 7,
|
|
|
|
+ "2.0", 3);
|
|
|
|
+
|
|
|
|
+ return 0;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+/** Implementation of rpc_send function required by the management API.
|
|
|
|
+ *
|
|
|
|
+ * This is the function that will be called whenever a management function
|
|
|
|
+ * asks the management interface to send the reply to the client.
|
|
|
|
+ * The SIP/HTTP reply sent to
|
|
|
|
+ * the client will be always 200 OK, if an error ocurred on the server then it
|
|
|
|
+ * will be indicated in the html document in body.
|
|
|
|
+ *
|
|
|
|
+ * @param ctx A pointer to the context structure of the jsonrpc request that
|
|
|
|
+ * generated the reply.
|
|
|
|
+ * @return 1 if the reply was already sent, 0 on success, a negative number on
|
|
|
|
+ * error
|
|
|
|
+ */
|
|
|
|
+static int jsonrpc_send(jsonrpc_ctx_t* ctx)
|
|
|
|
+{
|
|
|
|
+ srjson_t *nj = NULL;
|
|
|
|
+ int i;
|
|
|
|
+ str rbuf;
|
|
|
|
+
|
|
|
|
+ if (ctx->reply_sent) return 1;
|
|
|
|
+
|
|
|
|
+ ctx->reply_sent = 1;
|
|
|
|
+
|
|
|
|
+ if(ctx->error_code != 0) {
|
|
|
|
+ /* fault handling */
|
|
|
|
+ nj = srjson_CreateObject(ctx->jrpl);
|
|
|
|
+ if(nj!=NULL) {
|
|
|
|
+ srjson_AddNumberToObject(ctx->jrpl, nj, "code",
|
|
|
|
+ ctx->error_code);
|
|
|
|
+ for(i=0; _jsonrpc_error_table[i].code!=0
|
|
|
|
+ && _jsonrpc_error_table[i].code!=ctx->error_code; i++);
|
|
|
|
+ if(_jsonrpc_error_table[i].code!=0) {
|
|
|
|
+ srjson_AddStrStrToObject(ctx->jrpl, nj,
|
|
|
|
+ "message", 7,
|
|
|
|
+ _jsonrpc_error_table[i].text.s,
|
|
|
|
+ _jsonrpc_error_table[i].text.len);
|
|
|
|
+ } else {
|
|
|
|
+ srjson_AddStrStrToObject(ctx->jrpl, nj,
|
|
|
|
+ "message", 7, "Unexpected Error", 16);
|
|
|
|
+ }
|
|
|
|
+ srjson_AddItemToObject(ctx->jrpl, ctx->jrpl->root, "error", nj);
|
|
|
|
+ }
|
|
|
|
+ } else {
|
|
|
|
+ nj = srjson_GetObjectItem(ctx->jrpl, ctx->jrpl->root, "result");
|
|
|
|
+ if(nj==NULL) {
|
|
|
|
+ if(ctx->rpl_node!=NULL) {
|
|
|
|
+ srjson_AddItemToObject(ctx->jrpl, ctx->jrpl->root,
|
|
|
|
+ "result", ctx->rpl_node);
|
|
|
|
+ ctx->rpl_node = 0;
|
|
|
|
+ } else {
|
|
|
|
+ srjson_AddStrStrToObject(ctx->jrpl, ctx->jrpl->root,
|
|
|
|
+ "result", 6, "ok", 2);
|
|
|
|
+ }
|
|
|
|
+ }
|
|
|
|
+ }
|
|
|
|
+ nj = srjson_GetObjectItem(ctx->jreq, ctx->jreq->root, "id");
|
|
|
|
+ if(nj!=NULL) {
|
|
|
|
+ if(nj->valuestring!=NULL) {
|
|
|
|
+ srjson_AddStrStrToObject(ctx->jrpl, ctx->jrpl->root,
|
|
|
|
+ "id", 2,
|
|
|
|
+ nj->valuestring, strlen(nj->valuestring));
|
|
|
|
+ } else {
|
|
|
|
+ srjson_AddNumberToObject(ctx->jrpl, ctx->jrpl->root, "id",
|
|
|
|
+ nj->valueint);
|
|
|
|
+ }
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ if(jsonrpc_pretty_format==0) {
|
|
|
|
+ rbuf.s = srjson_PrintUnformatted(ctx->jrpl, ctx->jrpl->root);
|
|
|
|
+ } else {
|
|
|
|
+ rbuf.s = srjson_Print(ctx->jrpl, ctx->jrpl->root);
|
|
|
|
+ }
|
|
|
|
+ if(rbuf.s!=NULL) {
|
|
|
|
+ rbuf.len = strlen(rbuf.s);
|
|
|
|
+ }
|
|
|
|
+ if (rbuf.s!=NULL) {
|
|
|
|
+ xhttp_api.reply(ctx->msg, ctx->http_code, &ctx->http_text,
|
|
|
|
+ &JSONRPC_CONTENT_TYPE_HTML, &rbuf);
|
|
|
|
+ } else {
|
|
|
|
+ xhttp_api.reply(ctx->msg, ctx->http_code, &ctx->http_text,
|
|
|
|
+ NULL, NULL);
|
|
|
|
+ }
|
|
|
|
+ if (rbuf.s!=NULL) {
|
|
|
|
+ ctx->jrpl->free_fn(rbuf.s);
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ return 0;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+/** Converts the variables provided in parameter ap according to formatting
|
|
|
|
+ * string provided in parameter fmt into HTML format.
|
|
|
|
+ *
|
|
|
|
+ * This function takes the parameters provided in ap parameter and creates
|
|
|
|
+ * HTML formatted parameters that will be put in the html document.
|
|
|
|
+ * The format of input parameters is described in formatting string
|
|
|
|
+ * fmt which follows the syntax of the management API. In the case of
|
|
|
|
+ * an error the function will generate an error reply in err_reply parameter
|
|
|
|
+ * instead.
|
|
|
|
+ * @param ctx An error reply document will be generated here if the
|
|
|
|
+ * function encounters a problem while processing input
|
|
|
|
+ * parameters.
|
|
|
|
+ * @param fmt Formatting string of the management API.
|
|
|
|
+ * @param ap A pointer to the array of input parameters.
|
|
|
|
+ *
|
|
|
|
+ */
|
|
|
|
+static srjson_t* jsonrpc_print_value(jsonrpc_ctx_t* ctx, char fmt, va_list* ap)
|
|
|
|
+
|
|
|
|
+{
|
|
|
|
+ srjson_t *nj = NULL;
|
|
|
|
+ char buf[JSONRPC_PRINT_VALUE_BUF_LEN];
|
|
|
|
+ time_t dt;
|
|
|
|
+ struct tm* t;
|
|
|
|
+ str *sp;
|
|
|
|
+
|
|
|
|
+ switch(fmt) {
|
|
|
|
+ case 'd':
|
|
|
|
+ nj = srjson_CreateNumber(ctx->jrpl, va_arg(*ap, int));
|
|
|
|
+ break;
|
|
|
|
+ case 'f':
|
|
|
|
+ nj = srjson_CreateNumber(ctx->jrpl, va_arg(*ap, double));
|
|
|
|
+ break;
|
|
|
|
+ case 'b':
|
|
|
|
+ nj = srjson_CreateBool(ctx->jrpl, ((va_arg(*ap, int)==0)?0:1));
|
|
|
|
+ break;
|
|
|
|
+ case 't':
|
|
|
|
+ dt = va_arg(*ap, time_t);
|
|
|
|
+ t = gmtime(&dt);
|
|
|
|
+ if (strftime(buf, JSONRPC_PRINT_VALUE_BUF_LEN,
|
|
|
|
+ "%Y%m%dT%H:%M:%S", t) == 0) {
|
|
|
|
+ LM_ERR("Error while converting time\n");
|
|
|
|
+ return NULL;
|
|
|
|
+ }
|
|
|
|
+ nj = srjson_CreateString(ctx->jrpl, buf);
|
|
|
|
+ break;
|
|
|
|
+ case 's':
|
|
|
|
+ nj = srjson_CreateString(ctx->jrpl, va_arg(*ap, char*));
|
|
|
|
+ break;
|
|
|
|
+ case 'S':
|
|
|
|
+ sp = va_arg(*ap, str*);
|
|
|
|
+ nj = srjson_CreateStr(ctx->jrpl, sp->s, sp->len);
|
|
|
|
+ break;
|
|
|
|
+ default:
|
|
|
|
+ LM_ERR("Invalid formatting character [%c]\n", fmt);
|
|
|
|
+ return NULL;
|
|
|
|
+ }
|
|
|
|
+ return nj;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+/** Implementation of rpc_add function required by the management API.
|
|
|
|
+ *
|
|
|
|
+ * This function will be called when an RPC management function calls
|
|
|
|
+ * rpc->add to add a parameter to the jsonrpc reply being generated.
|
|
|
|
+ */
|
|
|
|
+static int jsonrpc_add(jsonrpc_ctx_t* ctx, char* fmt, ...)
|
|
|
|
+{
|
|
|
|
+ srjson_t *nj = NULL;
|
|
|
|
+ void **void_ptr;
|
|
|
|
+ va_list ap;
|
|
|
|
+
|
|
|
|
+ va_start(ap, fmt);
|
|
|
|
+ while(*fmt) {
|
|
|
|
+ if (*fmt == '{' || *fmt == '[') {
|
|
|
|
+ void_ptr = va_arg(ap, void**);
|
|
|
|
+ if (*fmt == '{') {
|
|
|
|
+ nj = srjson_CreateObject(ctx->jrpl);
|
|
|
|
+ } else {
|
|
|
|
+ nj = srjson_CreateArray(ctx->jrpl);
|
|
|
|
+ }
|
|
|
|
+ *void_ptr = nj;
|
|
|
|
+ } else {
|
|
|
|
+ nj = jsonrpc_print_value(ctx, *fmt, &ap);
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ if(nj==NULL) goto err;
|
|
|
|
+ if(ctx->flags & RET_ARRAY) {
|
|
|
|
+ if (ctx->rpl_node==NULL) {
|
|
|
|
+ ctx->rpl_node = srjson_CreateArray(ctx->jrpl);
|
|
|
|
+ if(ctx->rpl_node == 0) {
|
|
|
|
+ LM_ERR("failed to create the root array node\n");
|
|
|
|
+ goto err;
|
|
|
|
+ }
|
|
|
|
+ }
|
|
|
|
+ srjson_AddItemToArray(ctx->jrpl, ctx->rpl_node, nj);
|
|
|
|
+ } else {
|
|
|
|
+ if (ctx->rpl_node) srjson_Delete(ctx->jrpl, ctx->rpl_node);
|
|
|
|
+ ctx->rpl_node = nj;
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ fmt++;
|
|
|
|
+ }
|
|
|
|
+ va_end(ap);
|
|
|
|
+ return 0;
|
|
|
|
+err:
|
|
|
|
+ va_end(ap);
|
|
|
|
+ return -1;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+/** Implementation of rpc->scan function required by the management API.
|
|
|
|
+ *
|
|
|
|
+ * This is the function that will be called whenever a management function
|
|
|
|
+ * calls rpc->scan to get the value of parameter from the jsonrpc
|
|
|
|
+ * request. This function will extract the current parameter from the jsonrpc
|
|
|
|
+ * URL and attempts to convert it to the type requested by the management
|
|
|
|
+ * function that called it.
|
|
|
|
+ */
|
|
|
|
+static int jsonrpc_scan(jsonrpc_ctx_t* ctx, char* fmt, ...)
|
|
|
|
+{
|
|
|
|
+ int *int_ptr;
|
|
|
|
+ char **char_ptr;
|
|
|
|
+ double *double_ptr;
|
|
|
|
+ str *str_ptr;
|
|
|
|
+ int mandatory_param = 1;
|
|
|
|
+ int modifiers = 0;
|
|
|
|
+ int auto_convert = 0;
|
|
|
|
+ char* orig_fmt;
|
|
|
|
+ va_list ap;
|
|
|
|
+
|
|
|
|
+ if(ctx->req_node==NULL)
|
|
|
|
+ return 0;
|
|
|
|
+
|
|
|
|
+ orig_fmt=fmt;
|
|
|
|
+ va_start(ap, fmt);
|
|
|
|
+ while(*fmt && ctx->req_node) {
|
|
|
|
+ switch(*fmt) {
|
|
|
|
+ case '*': /* start of optional parameters */
|
|
|
|
+ mandatory_param = 0;
|
|
|
|
+ modifiers++;
|
|
|
|
+ fmt++;
|
|
|
|
+ continue;
|
|
|
|
+ case '.': /* autoconvert */
|
|
|
|
+ modifiers++;
|
|
|
|
+ fmt++;
|
|
|
|
+ auto_convert = 1;
|
|
|
|
+ continue;
|
|
|
|
+ case 'b': /* Bool */
|
|
|
|
+ case 't': /* Date and time */
|
|
|
|
+ case 'd': /* Integer */
|
|
|
|
+ int_ptr = va_arg(ap, int*);
|
|
|
|
+ *int_ptr = ctx->req_node->valueint;
|
|
|
|
+ break;
|
|
|
|
+ case 'f': /* double */
|
|
|
|
+ double_ptr = va_arg(ap, double*);
|
|
|
|
+ *double_ptr = ctx->req_node->valuedouble;
|
|
|
|
+ break;
|
|
|
|
+ case 's': /* zero terminated string */
|
|
|
|
+ char_ptr = va_arg(ap, char**);
|
|
|
|
+ *char_ptr = ctx->req_node->valuestring;
|
|
|
|
+ break;
|
|
|
|
+ case 'S': /* str structure */
|
|
|
|
+ str_ptr = va_arg(ap, str*);
|
|
|
|
+ str_ptr->s = ctx->req_node->valuestring;
|
|
|
|
+ str_ptr->len = strlen(ctx->req_node->valuestring);
|
|
|
|
+ break;
|
|
|
|
+ case '{':
|
|
|
|
+ case '[':
|
|
|
|
+ LM_ERR("Unsupported param type '%c'\n", *fmt);
|
|
|
|
+ jsonrpc_fault(ctx, 500, "Unsupported param type");
|
|
|
|
+ goto error;
|
|
|
|
+ default:
|
|
|
|
+ LM_ERR("Invalid param type in formatting string: [%c]\n", *fmt);
|
|
|
|
+ jsonrpc_fault(ctx, 500,
|
|
|
|
+ "Internal Server Error (inval formatting str)");
|
|
|
|
+ goto error;
|
|
|
|
+ }
|
|
|
|
+ fmt++;
|
|
|
|
+ auto_convert = 0;
|
|
|
|
+ ctx->req_node = ctx->req_node->next;
|
|
|
|
+ }
|
|
|
|
+ va_end(ap);
|
|
|
|
+ return (int)(fmt-orig_fmt)-modifiers;
|
|
|
|
+error:
|
|
|
|
+ va_end(ap);
|
|
|
|
+ return -((int)(fmt-orig_fmt)-modifiers);
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+/** Implementation of rpc_printf function required by the management API.
|
|
|
|
+ *
|
|
|
|
+ * This function will be called whenever an RPC management function calls
|
|
|
|
+ * rpc-printf to add a parameter to the jsonrpc reply being constructed.
|
|
|
|
+ */
|
|
|
|
+static int jsonrpc_printf(jsonrpc_ctx_t* ctx, char* fmt, ...)
|
|
|
|
+{
|
|
|
|
+ int n, buf_size;
|
|
|
|
+ char *buf = 0;
|
|
|
|
+ char tbuf[JSONRPC_PRINT_VALUE_BUF_LEN];
|
|
|
|
+ va_list ap;
|
|
|
|
+ srjson_t *nj = NULL;
|
|
|
|
+
|
|
|
|
+ buf = tbuf;
|
|
|
|
+ buf_size = JSONRPC_PRINT_VALUE_BUF_LEN;
|
|
|
|
+ while (1) {
|
|
|
|
+ /* try to print in the allocated space. */
|
|
|
|
+ va_start(ap, fmt);
|
|
|
|
+ n = vsnprintf(buf, buf_size, fmt, ap);
|
|
|
|
+ va_end(ap);
|
|
|
|
+ /* if that worked, return the string. */
|
|
|
|
+ if (n > -1 && n < buf_size) {
|
|
|
|
+ nj = srjson_CreateString(ctx->jrpl, buf);
|
|
|
|
+ if(nj==NULL) {
|
|
|
|
+ LM_ERR("failed to create the value node\n");
|
|
|
|
+ if(buf && buf!=tbuf) jsonrpc_free(buf);
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+ if(ctx->flags & RET_ARRAY) {
|
|
|
|
+ if (ctx->rpl_node==NULL) {
|
|
|
|
+ ctx->rpl_node = srjson_CreateArray(ctx->jrpl);
|
|
|
|
+ if(ctx->rpl_node == 0) {
|
|
|
|
+ LM_ERR("failed to create the root array node\n");
|
|
|
|
+ if(buf && buf!=tbuf) jsonrpc_free(buf);
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+ }
|
|
|
|
+ srjson_AddItemToArray(ctx->jrpl, ctx->rpl_node, nj);
|
|
|
|
+ } else {
|
|
|
|
+ if (ctx->rpl_node) srjson_Delete(ctx->jrpl, ctx->rpl_node);
|
|
|
|
+ ctx->rpl_node = nj;
|
|
|
|
+ }
|
|
|
|
+ if(buf && buf!=tbuf) jsonrpc_free(buf);
|
|
|
|
+ return 0;
|
|
|
|
+ }
|
|
|
|
+ /* else try again with more space. */
|
|
|
|
+ if (n > -1) { /* glibc 2.1 */
|
|
|
|
+ buf_size = n + 1; /* precisely what is needed */
|
|
|
|
+ } else { /* glibc 2.0 */
|
|
|
|
+ buf_size *= 2; /* twice the old size */
|
|
|
|
+ }
|
|
|
|
+ if(buf && buf!=tbuf) jsonrpc_free(buf);
|
|
|
|
+ if ((buf = jsonrpc_malloc(buf_size)) == 0) {
|
|
|
|
+ jsonrpc_fault(ctx, 500, "Internal Server Error (No memory left)");
|
|
|
|
+ LM_ERR("no memory left for rpc printf\n");
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+ }
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+/** Adds a new member to structure.
|
|
|
|
+ */
|
|
|
|
+static int jsonrpc_struct_add(srjson_t *jnode, char* fmt, ...)
|
|
|
|
+{
|
|
|
|
+ srjson_t *nj = NULL;
|
|
|
|
+ jsonrpc_ctx_t* ctx;
|
|
|
|
+ va_list ap;
|
|
|
|
+ void **void_ptr;
|
|
|
|
+ str mname;
|
|
|
|
+
|
|
|
|
+ if(jnode==NULL) {
|
|
|
|
+ LM_ERR("invalid json node parameter\n");
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+ if(jnode->type!=srjson_Object) {
|
|
|
|
+ LM_ERR("json node parameter is not object (%d)\n", jnode->type);
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ ctx = &_jsonrpc_ctx;
|
|
|
|
+ if(ctx->jrpl==NULL) {
|
|
|
|
+ LM_ERR("reply object not initialized in rpl context\n");
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ va_start(ap, fmt);
|
|
|
|
+ while(*fmt) {
|
|
|
|
+ mname.s = va_arg(ap, char*);
|
|
|
|
+ mname.len = (mname.s?strlen(mname.s):0);
|
|
|
|
+
|
|
|
|
+ if (*fmt == '{' || *fmt == '[') {
|
|
|
|
+ void_ptr = va_arg(ap, void**);
|
|
|
|
+ if (*fmt == '{') {
|
|
|
|
+ nj = srjson_CreateObject(ctx->jrpl);
|
|
|
|
+ } else {
|
|
|
|
+ nj = srjson_CreateArray(ctx->jrpl);
|
|
|
|
+ }
|
|
|
|
+ *void_ptr = nj;
|
|
|
|
+ } else {
|
|
|
|
+ nj = jsonrpc_print_value(ctx, *fmt, &ap);
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ if(nj==NULL) goto err;
|
|
|
|
+ srjson_AddItemToObject(ctx->jrpl, jnode,
|
|
|
|
+ mname.s, nj);
|
|
|
|
+ fmt++;
|
|
|
|
+ }
|
|
|
|
+ va_end(ap);
|
|
|
|
+ return 0;
|
|
|
|
+err:
|
|
|
|
+ va_end(ap);
|
|
|
|
+ return -1;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+/** Adds a new member to structure.
|
|
|
|
+ */
|
|
|
|
+static int jsonrpc_array_add(srjson_t *jnode, char* fmt, ...)
|
|
|
|
+{
|
|
|
|
+ srjson_t *nj = NULL;
|
|
|
|
+ jsonrpc_ctx_t* ctx;
|
|
|
|
+ va_list ap;
|
|
|
|
+ void **void_ptr;
|
|
|
|
+
|
|
|
|
+ if(jnode==NULL) {
|
|
|
|
+ LM_ERR("invalid json node parameter\n");
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+ if(jnode->type!=srjson_Array) {
|
|
|
|
+ LM_ERR("json node parameter is not array (%d)\n", jnode->type);
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ ctx = &_jsonrpc_ctx;
|
|
|
|
+ if(ctx->jrpl==NULL) {
|
|
|
|
+ LM_ERR("reply object not initialized in rpl context\n");
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ va_start(ap, fmt);
|
|
|
|
+ while(*fmt) {
|
|
|
|
+ if (*fmt == '{' || *fmt == '[') {
|
|
|
|
+ void_ptr = va_arg(ap, void**);
|
|
|
|
+ if (*fmt == '{') {
|
|
|
|
+ nj = srjson_CreateObject(ctx->jrpl);
|
|
|
|
+ } else {
|
|
|
|
+ nj = srjson_CreateArray(ctx->jrpl);
|
|
|
|
+ }
|
|
|
|
+ *void_ptr = nj;
|
|
|
|
+ } else {
|
|
|
|
+ nj = jsonrpc_print_value(ctx, *fmt, &ap);
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ if(nj==NULL) goto err;
|
|
|
|
+ srjson_AddItemToArray(ctx->jrpl, jnode, nj);
|
|
|
|
+ fmt++;
|
|
|
|
+ }
|
|
|
|
+ va_end(ap);
|
|
|
|
+ return 0;
|
|
|
|
+err:
|
|
|
|
+ va_end(ap);
|
|
|
|
+ return -1;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+static int jsonrpc_struct_scan(void* s, char* fmt, ...)
|
|
|
|
+{
|
|
|
|
+ LM_ERR("Not implemented\n");
|
|
|
|
+ return -1;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+/** Create a new member from formatting string and add it to a structure.
|
|
|
|
+ */
|
|
|
|
+static int jsonrpc_struct_printf(srjson_t *jnode, char* mname, char* fmt, ...)
|
|
|
|
+{
|
|
|
|
+ jsonrpc_ctx_t* ctx;
|
|
|
|
+ int n, buf_size;
|
|
|
|
+ char *buf = 0;
|
|
|
|
+ char tbuf[JSONRPC_PRINT_VALUE_BUF_LEN];
|
|
|
|
+ va_list ap;
|
|
|
|
+ srjson_t *nj = NULL;
|
|
|
|
+
|
|
|
|
+ if(jnode==NULL || mname==NULL) {
|
|
|
|
+ LM_ERR("invalid json node or member name parameter (%p/%p)\n",
|
|
|
|
+ jnode, mname);
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+ if(jnode->type!=srjson_Object) {
|
|
|
|
+ LM_ERR("json node parameter is not object (%d)\n", jnode->type);
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ ctx = &_jsonrpc_ctx;
|
|
|
|
+ if(ctx->jrpl==NULL) {
|
|
|
|
+ LM_ERR("reply object not initialized in rpl context\n");
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ buf = tbuf;
|
|
|
|
+ buf_size = JSONRPC_PRINT_VALUE_BUF_LEN;
|
|
|
|
+ while (1) {
|
|
|
|
+ /* try to print in the allocated space. */
|
|
|
|
+ va_start(ap, fmt);
|
|
|
|
+ n = vsnprintf(buf, buf_size, fmt, ap);
|
|
|
|
+ va_end(ap);
|
|
|
|
+ /* if that worked, return the string. */
|
|
|
|
+ if (n > -1 && n < buf_size) {
|
|
|
|
+ nj = srjson_CreateString(ctx->jrpl, buf);
|
|
|
|
+ if(nj==NULL) {
|
|
|
|
+ LM_ERR("failed to create the value node\n");
|
|
|
|
+ if(buf && buf!=tbuf) jsonrpc_free(buf);
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+ srjson_AddItemToObject(ctx->jrpl, jnode, mname, nj);
|
|
|
|
+ if(buf && buf!=tbuf) jsonrpc_free(buf);
|
|
|
|
+ return 0;
|
|
|
|
+ }
|
|
|
|
+ /* else try again with more space. */
|
|
|
|
+ if (n > -1) { /* glibc 2.1 */
|
|
|
|
+ buf_size = n + 1; /* precisely what is needed */
|
|
|
|
+ } else { /* glibc 2.0 */
|
|
|
|
+ buf_size *= 2; /* twice the old size */
|
|
|
|
+ }
|
|
|
|
+ if(buf && buf!=tbuf) jsonrpc_free(buf);
|
|
|
|
+ if ((buf = jsonrpc_malloc(buf_size)) == 0) {
|
|
|
|
+ jsonrpc_fault(ctx, 500, "Internal Server Error (No memory left)");
|
|
|
|
+ LM_ERR("no memory left for rpc printf\n");
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+ }
|
|
|
|
+ return -1;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+/** Returns the RPC capabilities supported by the xmlrpc driver.
|
|
|
|
+ */
|
|
|
|
+static rpc_capabilities_t jsonrpc_capabilities(jsonrpc_ctx_t* ctx)
|
|
|
|
+{
|
|
|
|
+ /* No support for async commands.
|
|
|
|
+ */
|
|
|
|
+ return 0;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+/** Returns a new "delayed reply" context.
|
|
|
|
+ * Creates a new delayed reply context in shm and returns it.
|
|
|
|
+ * @return 0 - not supported, already replied, or no more memory;
|
|
|
|
+ * !=0 pointer to the special delayed ctx.
|
|
|
|
+ * Note1: one should use the returned ctx reply context to build a reply and
|
|
|
|
+ * when finished call rpc_delayed_ctx_close().
|
|
|
|
+ * Note2: adding pieces to the reply in different processes is not supported.
|
|
|
|
+ */
|
|
|
|
+static struct rpc_delayed_ctx* jsonrpc_delayed_ctx_new(jsonrpc_ctx_t* ctx)
|
|
|
|
+{
|
|
|
|
+ return NULL;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+/** Closes a "delayed reply" context and sends the reply.
|
|
|
|
+ * If no reply has been sent the reply will be built and sent automatically.
|
|
|
|
+ * See the notes from rpc_new_delayed_ctx()
|
|
|
|
+ */
|
|
|
|
+static void jsonrpc_delayed_ctx_close(struct rpc_delayed_ctx* dctx)
|
|
|
|
+{
|
|
|
|
+ return;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+static void jsonrpc_clean_context(jsonrpc_ctx_t* ctx)
|
|
|
|
+{
|
|
|
|
+ if (!ctx) return;
|
|
|
|
+ srjson_DeleteDoc(ctx->jreq);
|
|
|
|
+ if(ctx->rpl_node!=NULL) {
|
|
|
|
+ srjson_Delete(ctx->jrpl, ctx->rpl_node);
|
|
|
|
+ ctx->rpl_node = NULL;
|
|
|
|
+ }
|
|
|
|
+ srjson_DeleteDoc(ctx->jrpl);
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+static int mod_init(void)
|
|
|
|
+{
|
|
|
|
+ /* bind the XHTTP API */
|
|
|
|
+ if (xhttp_load_api(&xhttp_api) < 0) {
|
|
|
|
+ LM_ERR("cannot bind to XHTTP API\n");
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ memset(&func_param, 0, sizeof(func_param));
|
|
|
|
+ func_param.send = (rpc_send_f)jsonrpc_send;
|
|
|
|
+ func_param.fault = (rpc_fault_f)jsonrpc_fault;
|
|
|
|
+ func_param.add = (rpc_add_f)jsonrpc_add;
|
|
|
|
+ func_param.scan = (rpc_scan_f)jsonrpc_scan;
|
|
|
|
+ func_param.printf = (rpc_printf_f)jsonrpc_printf;
|
|
|
|
+ func_param.struct_add = (rpc_struct_add_f)jsonrpc_struct_add;
|
|
|
|
+ func_param.array_add = (rpc_struct_add_f)jsonrpc_array_add;
|
|
|
|
+ func_param.struct_scan = (rpc_struct_scan_f)jsonrpc_struct_scan;
|
|
|
|
+ func_param.struct_printf = (rpc_struct_printf_f)jsonrpc_struct_printf;
|
|
|
|
+ func_param.capabilities = (rpc_capabilities_f)jsonrpc_capabilities;
|
|
|
|
+ func_param.delayed_ctx_new = (rpc_delayed_ctx_new_f)jsonrpc_delayed_ctx_new;
|
|
|
|
+ func_param.delayed_ctx_close =
|
|
|
|
+ (rpc_delayed_ctx_close_f)jsonrpc_delayed_ctx_close;
|
|
|
|
+
|
|
|
|
+ jsonrpc_register_rpc();
|
|
|
|
+
|
|
|
|
+ return 0;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+static int child_init(int rank)
|
|
|
|
+{
|
|
|
|
+ if(rank==PROC_MAIN || rank==PROC_TCP_MAIN)
|
|
|
|
+ return 0; /* do nothing for the main process */
|
|
|
|
+
|
|
|
|
+ return 0;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+static int jsonrpc_dispatch(sip_msg_t* msg, char* s1, char* s2)
|
|
|
|
+{
|
|
|
|
+ rpc_export_t* rpce;
|
|
|
|
+ jsonrpc_ctx_t* ctx;
|
|
|
|
+ int ret = 0;
|
|
|
|
+ srjson_t *nj = NULL;
|
|
|
|
+ str val;
|
|
|
|
+
|
|
|
|
+ if(!IS_HTTP(msg)) {
|
|
|
|
+ LM_DBG("Got non HTTP msg\n");
|
|
|
|
+ return NONSIP_MSG_PASS;
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ /* initialize jsonrpc context */
|
|
|
|
+ ctx = &_jsonrpc_ctx;
|
|
|
|
+ memset(ctx, 0, sizeof(jsonrpc_ctx_t));
|
|
|
|
+ ctx->msg = msg;
|
|
|
|
+ /* parse the jsonrpc request */
|
|
|
|
+ ctx->jreq = srjson_NewDoc(NULL);
|
|
|
|
+ if(ctx->jreq==NULL) {
|
|
|
|
+ LM_ERR("Failed to init the json document\n");
|
|
|
|
+ return NONSIP_MSG_PASS;
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ ctx->jreq->buf.s = get_body(msg);
|
|
|
|
+ ctx->jreq->buf.len = strlen(ctx->jreq->buf.s);
|
|
|
|
+ ctx->jreq->root = srjson_Parse(ctx->jreq, ctx->jreq->buf.s);
|
|
|
|
+ if(ctx->jreq->root == NULL)
|
|
|
|
+ {
|
|
|
|
+ LM_ERR("invalid json doc [[%s]]\n", ctx->jreq->buf.s);
|
|
|
|
+ return NONSIP_MSG_PASS;
|
|
|
|
+ }
|
|
|
|
+ if (jsonrpc_init_reply(ctx) < 0) goto send_reply;
|
|
|
|
+
|
|
|
|
+ /* sanity checks on jsonrpc request */
|
|
|
|
+ nj = srjson_GetObjectItem(ctx->jreq, ctx->jreq->root, "jsonrpc");
|
|
|
|
+ if(nj==NULL) {
|
|
|
|
+ LM_ERR("missing jsonrpc field in request\n");
|
|
|
|
+ goto send_reply;
|
|
|
|
+ }
|
|
|
|
+ val.s = nj->valuestring;
|
|
|
|
+ val.len = strlen(val.s);
|
|
|
|
+ if(val.len!=3 || strncmp(val.s, "2.0", 3)!=0) {
|
|
|
|
+ LM_ERR("unsupported jsonrpc version [%.*s]\n", val.len, val.s);
|
|
|
|
+ goto send_reply;
|
|
|
|
+ }
|
|
|
|
+ /* run jsonrpc command */
|
|
|
|
+ nj = srjson_GetObjectItem(ctx->jreq, ctx->jreq->root, "method");
|
|
|
|
+ if(nj==NULL) {
|
|
|
|
+ LM_ERR("missing jsonrpc method field in request\n");
|
|
|
|
+ goto send_reply;
|
|
|
|
+ }
|
|
|
|
+ val.s = nj->valuestring;
|
|
|
|
+ val.len = strlen(val.s);
|
|
|
|
+ ctx->method = val.s;
|
|
|
|
+ rpce = find_rpc_export(ctx->method, 0);
|
|
|
|
+ if (!rpce || !rpce->function) {
|
|
|
|
+ LM_ERR("method callback not found [%.*s]\n", val.len, val.s);
|
|
|
|
+ jsonrpc_fault(ctx, 500, "Method Not Found");
|
|
|
|
+ goto send_reply;
|
|
|
|
+ }
|
|
|
|
+ ctx->flags = rpce->flags;
|
|
|
|
+ nj = srjson_GetObjectItem(ctx->jreq, ctx->jreq->root, "params");
|
|
|
|
+ if(nj!=NULL && nj->type!=srjson_Array && nj->type!=srjson_Object) {
|
|
|
|
+ LM_ERR("params field is not an array or object\n");
|
|
|
|
+ goto send_reply;
|
|
|
|
+ }
|
|
|
|
+ if(nj!=NULL) ctx->req_node = nj->child;
|
|
|
|
+ rpce->function(&func_param, ctx);
|
|
|
|
+
|
|
|
|
+send_reply:
|
|
|
|
+ if (!ctx->reply_sent) {
|
|
|
|
+ ret = jsonrpc_send(ctx);
|
|
|
|
+ }
|
|
|
|
+ jsonrpc_clean_context(ctx);
|
|
|
|
+ if (ret < 0) return -1;
|
|
|
|
+ return 1;
|
|
|
|
+}
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+/**
|
|
|
|
+ *
|
|
|
|
+ */
|
|
|
|
+static const char* jsonrpc_rpc_echo_doc[2] = {
|
|
|
|
+ "Sample echo command",
|
|
|
|
+ 0
|
|
|
|
+};
|
|
|
|
+
|
|
|
|
+/**
|
|
|
|
+ *
|
|
|
|
+ */
|
|
|
|
+static void jsonrpc_rpc_echo(rpc_t* rpc, void* ctx)
|
|
|
|
+{
|
|
|
|
+ str sval;
|
|
|
|
+ int ival = 0;
|
|
|
|
+ int ret;
|
|
|
|
+ ret = rpc->scan(ctx, "S*d", &sval, &ival);
|
|
|
|
+ if(ret>0) {
|
|
|
|
+ LM_DBG("READ STR: %.*s\n", sval.len, sval.s);
|
|
|
|
+ rpc->add(ctx, "S", &sval);
|
|
|
|
+ }
|
|
|
|
+ if(ret>1) {
|
|
|
|
+ LM_DBG("READ INT: %d\n", ival);
|
|
|
|
+ rpc->add(ctx, "d", ival);
|
|
|
|
+ }
|
|
|
|
+}
|
|
|
|
+/**
|
|
|
|
+ *
|
|
|
|
+ */
|
|
|
|
+static rpc_export_t jsonrpc_rpc[] = {
|
|
|
|
+ {"jsonrpc.echo", jsonrpc_rpc_echo, jsonrpc_rpc_echo_doc, RET_ARRAY},
|
|
|
|
+ {0, 0, 0, 0}
|
|
|
|
+};
|
|
|
|
+
|
|
|
|
+/**
|
|
|
|
+ *
|
|
|
|
+ */
|
|
|
|
+static int jsonrpc_register_rpc(void)
|
|
|
|
+{
|
|
|
|
+ if (rpc_register_array(jsonrpc_rpc)!=0)
|
|
|
|
+ {
|
|
|
|
+ LM_ERR("failed to register RPC commands\n");
|
|
|
|
+ return -1;
|
|
|
|
+ }
|
|
|
|
+ return 0;
|
|
|
|
+}
|