Add get_pseudoVar() and set_pseudoVar() to msg object.

Those functions allow Python code to access and manipulate
pseudo-variables.

PR	#2317
+Documentation by: @sobomax

Author: importos

modules/python/doc/python_admin.xml

@@ -113,10 +113,19 @@
 		</para></listitem>
 		<listitem><para>
 		<emphasis>getHeader()</emphasis> - returns the header of a message
-		the destination address (&osips; address) of the message
 		</para></listitem>
 		<listitem><para>
-		<emphasis>call_function()</emphasis> - calls a function from the script
+		<emphasis>call_function()</emphasis> - calls built-in script function
+		or function exported by other module
+		</para></listitem>
+		<listitem><para>
+		<emphasis>get_pseudoVar(name)</emphasis> - returns the value of the
+		the pseudo-variable specified by the <emphasis>name</emphasis> as
+		Unicode string.
+		</para></listitem>
+		<listitem><para>
+		<emphasis>set_pseudoVar(name, value)</emphasis> - sets pseudo-variable
+		using Unicode string <emphasis>value</emphasis>.
 		</para></listitem>
 		</itemizedlist>
 	</para>
@@ -218,36 +227,35 @@ modparam("python", "child_init_method", "child_initializer")
 
 </section>
 
-
 	<section id="exported_functions" xreflabel="exported_functions">
-	<title>Exported Functions</title>
-	<section id="func_python_exec" xreflabel="python_exec()">
+		<title>Exported Functions</title>
+		<section id="func_python_exec" xreflabel="python_exec()">
 			<title>
 				<function moreinfo="none">python_exec(method_name [, extra_args])</function>
 			</title>
-	<para>
-		Thhis function is used to execute a method from the Python module
-		loaded.
-	</para>
-	<para>
-	    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
-		FAILURE_ROUTE and BRANCH_ROUTE.
-	</para>
-	<para>Meaning of the parameters is as follows:</para>
-	<itemizedlist>
-	    <listitem>
-		<para>
-		    <emphasis>method_name</emphasis> (string) - name of the method called
-		</para>
-	    </listitem>
-	    <listitem>
-		<para>
-		    <emphasis>extra_args</emphasis> (string, optional) - extra arguments that can
-			be passed from the script to the python function.
-		</para>
-	    </listitem>
-	</itemizedlist>
-	</section>
+			<para>
+				This function is used to execute a method from the Python module
+				loaded.
+			</para>
+			<para>
+				This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
+				FAILURE_ROUTE and BRANCH_ROUTE.
+			</para>
+			<para>Meaning of the parameters is as follows:</para>
+			<itemizedlist>
+				<listitem>
+				<para>
+					<emphasis>method_name</emphasis> (string) - name of the method called
+				</para>
+				</listitem>
+				<listitem>
+				<para>
+					<emphasis>extra_args</emphasis> (string, optional) - extra arguments that can
+					be passed from the script to the python function.
+				</para>
+				</listitem>
+			</itemizedlist>
+		</section>
 	</section>
 
 </chapter>

modules/python/python_msgobj.c

@@ -365,6 +365,94 @@ msg_call_function(msgobject *self, PyObject *args)
     return PyLong_FromLong(rval);
 }
 
+static PyObject *
+msg_get_pseudoVar(msgobject *self, PyObject *args)
+{
+    str hmodel,rval;
+    pv_elem_t *model;
+    int buf_size = 4096;
+    char *out;
+    PyObject * res;
+
+    if (self->msg == NULL) {
+        PyErr_SetString(PyExc_RuntimeError, "self->msg is NULL");
+        Py_INCREF(Py_None);
+        return Py_None;
+    }
+
+    if(!PyArg_ParseTuple(args, "s", &hmodel.s)){
+        Py_INCREF(Py_None);
+        return Py_None;
+    }
+
+    hmodel.len = strlen(hmodel.s);
+    if (pv_parse_format(&hmodel, &model) < 0)
+    {
+      Py_INCREF(Py_None);
+      return Py_None;
+    }
+
+    out = pkg_malloc(buf_size);
+    if (!out)
+    {
+        PyErr_SetString(PyExc_RuntimeError, "Not enough memor");
+        Py_INCREF(Py_None);
+        return Py_None;
+    }
+
+    rval.len = pv_printf(self->msg, model, out, &buf_size) ;
+    rval.s = out;
+    rval.len = strlen(rval.s);
+    res = PyUnicode_FromStringAndSize(rval.s, rval.len);
+    pkg_free(out);
+    pv_elem_free_all(model);
+    return res;
+}
+
+static PyObject *
+msg_set_pseudoVar(msgobject *self, PyObject *args)
+{
+    str hmodel;
+    pv_spec_t model;
+    int retval;
+    pv_value_t val;
+ 
+    if (self->msg == NULL) {
+        PyErr_SetString(PyExc_RuntimeError, "self->msg is NULL");
+        Py_INCREF(Py_None);
+        return Py_None;
+    }
+    if(!PyArg_ParseTuple(args, "ss", &hmodel.s,&val.rs.s)){
+        PyErr_SetString(PyExc_RuntimeError, "args is not valid");
+        Py_INCREF(Py_None);
+        return Py_None;
+    }
+
+    hmodel.len = strlen(hmodel.s);
+    val.rs.len = strlen(val.rs.s);
+    if (pv_parse_spec(&hmodel, &model) < 0)
+    {
+        Py_INCREF(Py_None);
+        return Py_None;
+    }
+    if(!pv_is_w(&model)){
+        Py_INCREF(Py_None);
+        return Py_None;
+    }
+    val.flags = PV_VAL_STR;
+    retval = pv_set_value(self->msg, &model, EQ_T, &val);
+    if (retval >= 0){
+        Py_INCREF(Py_None);
+        return Py_None;
+    }else{
+        Py_INCREF(Py_None);
+        return Py_None;
+    }
+    Py_INCREF(Py_None);
+    return Py_None;
+
+}
+
 PyDoc_STRVAR(copy_doc,
 "copy() -> msg object\n\
 \n\
@@ -380,6 +468,10 @@ static PyMethodDef msg_methods[] = {
       "Get SIP header field by name."},
     {"call_function", (PyCFunction)msg_call_function, METH_VARARGS,
       "Invoke function exported by the other module."},
+    {"get_pseudoVar", (PyCFunction)msg_get_pseudoVar, METH_VARARGS,
+      "calc variable "},
+    {"set_pseudoVar", (PyCFunction)msg_set_pseudoVar, METH_VARARGS,
+      "set variable "},
     {NULL, NULL, 0, NULL}                              /* sentinel */
 };