* Added experimental binary search API function: xml_binsearch
* Added content parameter to `clicon_rpc_get` (-1 or CONTENT_ALL is default) * Reverted change in clixon-lib.yang
This commit is contained in:
parent
8b7b7b0f60
commit
10a2dbe8ec
17 changed files with 137 additions and 250 deletions
|
|
@ -26,8 +26,6 @@
|
||||||
* The main example explains how to implement a Yang extension in a backend plugin.
|
* The main example explains how to implement a Yang extension in a backend plugin.
|
||||||
|
|
||||||
### API changes on existing features (you may need to change your code)
|
### API changes on existing features (you may need to change your code)
|
||||||
* New clixon-lib@2019-08-13.yang revision
|
|
||||||
* Added new rpc: `get-state` to get only state info in the internal Restconf/backend communication
|
|
||||||
* Netconf edit-config "operation" attribute namespace check is enforced
|
* Netconf edit-config "operation" attribute namespace check is enforced
|
||||||
* This is enforced: `<a xmlns="uri:example" nc:operation="merge" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
|
* This is enforced: `<a xmlns="uri:example" nc:operation="merge" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
|
||||||
* This was previously allowed: `<a xmlns="uri:example" operation="merge">
|
* This was previously allowed: `<a xmlns="uri:example" operation="merge">
|
||||||
|
|
@ -49,6 +47,8 @@
|
||||||
* Other empty values remain as `null`
|
* Other empty values remain as `null`
|
||||||
|
|
||||||
### Minor changes
|
### Minor changes
|
||||||
|
* Added experimental binary search API function: `xml_binsearch`
|
||||||
|
* Added content parameter to `clicon_rpc_get` (-1 or CONTENT_ALL is default)
|
||||||
* Removed unnecessary configure dependencies
|
* Removed unnecessary configure dependencies
|
||||||
* libnsl, libcrypt, if_vlan,...
|
* libnsl, libcrypt, if_vlan,...
|
||||||
* pseudo-plugin added, to enable callbacks also for main programs. Useful for extensions
|
* pseudo-plugin added, to enable callbacks also for main programs. Useful for extensions
|
||||||
|
|
|
||||||
|
|
@ -856,7 +856,7 @@ from_client_unlock(clicon_handle h,
|
||||||
* @retval 0 OK
|
* @retval 0 OK
|
||||||
* @retval -1 Error
|
* @retval -1 Error
|
||||||
*
|
*
|
||||||
* @see from_client_get_config
|
* @see from_client_get_config
|
||||||
*/
|
*/
|
||||||
static int
|
static int
|
||||||
from_client_get(clicon_handle h,
|
from_client_get(clicon_handle h,
|
||||||
|
|
@ -875,6 +875,8 @@ from_client_get(clicon_handle h,
|
||||||
cxobj *xnacm = NULL;
|
cxobj *xnacm = NULL;
|
||||||
char *username;
|
char *username;
|
||||||
cvec *nsc = NULL; /* Create a netconf namespace context from filter */
|
cvec *nsc = NULL; /* Create a netconf namespace context from filter */
|
||||||
|
char *attr;
|
||||||
|
netconf_content content = CONTENT_ALL;
|
||||||
|
|
||||||
username = clicon_username_get(h);
|
username = clicon_username_get(h);
|
||||||
if ((xfilter = xml_find(xe, "filter")) != NULL){
|
if ((xfilter = xml_find(xe, "filter")) != NULL){
|
||||||
|
|
@ -888,24 +890,31 @@ from_client_get(clicon_handle h,
|
||||||
if (xml_nsctx_node(xfilter, &nsc) < 0)
|
if (xml_nsctx_node(xfilter, &nsc) < 0)
|
||||||
goto done;
|
goto done;
|
||||||
}
|
}
|
||||||
/* Get config
|
if ((attr = xml_find_value(xe, "content")) != NULL)
|
||||||
* Note xret can be pruned by nacm below and change name and
|
content = netconf_content_str2int(attr);
|
||||||
* metrged with state data, so zero-copy cant be used
|
|
||||||
* Also, must use external namespace context here due to <filter stmt
|
if (content != CONTENT_NONCONFIG){
|
||||||
*/
|
/* Get config
|
||||||
if (xmldb_get0(h, "running", nsc, xpath, 1, &xret, NULL) < 0) {
|
* Note xret can be pruned by nacm below and change name and
|
||||||
if (netconf_operation_failed(cbret, "application", "read registry")< 0)
|
* metrged with state data, so zero-copy cant be used
|
||||||
goto done;
|
* Also, must use external namespace context here due to <filter stmt
|
||||||
goto ok;
|
*/
|
||||||
|
if (xmldb_get0(h, "running", nsc, xpath, 1, &xret, NULL) < 0) {
|
||||||
|
if (netconf_operation_failed(cbret, "application", "read registry")< 0)
|
||||||
|
goto done;
|
||||||
|
goto ok;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
/* Get state data from plugins as defined by plugin_statedata(), if any */
|
if (content != CONTENT_CONFIG){
|
||||||
clicon_err_reset();
|
/* Get state data from plugins as defined by plugin_statedata(), if any */
|
||||||
if ((ret = client_statedata(h, xpath, nsc, &xret)) < 0)
|
clicon_err_reset();
|
||||||
goto done;
|
if ((ret = client_statedata(h, xpath, nsc, &xret)) < 0)
|
||||||
if (ret == 0){ /* Error from callback (error in xret) */
|
|
||||||
if (clicon_xml2cbuf(cbret, xret, 0, 0) < 0)
|
|
||||||
goto done;
|
goto done;
|
||||||
goto ok;
|
if (ret == 0){ /* Error from callback (error in xret) */
|
||||||
|
if (clicon_xml2cbuf(cbret, xret, 0, 0) < 0)
|
||||||
|
goto done;
|
||||||
|
goto ok;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
/* Pre-NACM access step */
|
/* Pre-NACM access step */
|
||||||
if ((ret = nacm_access_pre(h, username, NACM_DATA, &xnacm)) < 0)
|
if ((ret = nacm_access_pre(h, username, NACM_DATA, &xnacm)) < 0)
|
||||||
|
|
@ -942,94 +951,6 @@ from_client_get(clicon_handle h,
|
||||||
return retval;
|
return retval;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*! Retrieve device state information only
|
|
||||||
*
|
|
||||||
* This is a CLIXON specific RPC
|
|
||||||
* @param[in] h Clicon handle
|
|
||||||
* @param[in] xe Request: <rpc><xn></rpc>
|
|
||||||
* @param[out] cbret Return xml tree, eg <rpc-reply>..., <rpc-error..
|
|
||||||
* @param[in] arg client-entry
|
|
||||||
* @param[in] regarg User argument given at rpc_callback_register()
|
|
||||||
* @retval 0 OK
|
|
||||||
* @retval -1 Error
|
|
||||||
*
|
|
||||||
* @see from_client_get
|
|
||||||
*/
|
|
||||||
static int
|
|
||||||
from_client_get_state(clicon_handle h,
|
|
||||||
cxobj *xe,
|
|
||||||
cbuf *cbret,
|
|
||||||
void *arg,
|
|
||||||
void *regarg)
|
|
||||||
{
|
|
||||||
int retval = -1;
|
|
||||||
cxobj *xfilter;
|
|
||||||
char *xpath = "/";
|
|
||||||
cxobj *xret = NULL;
|
|
||||||
int ret;
|
|
||||||
cxobj **xvec = NULL;
|
|
||||||
size_t xlen;
|
|
||||||
cxobj *xnacm = NULL;
|
|
||||||
char *username;
|
|
||||||
cvec *nsc = NULL; /* Create a netconf namespace context from filter */
|
|
||||||
|
|
||||||
username = clicon_username_get(h);
|
|
||||||
if ((xfilter = xml_find(xe, "filter")) != NULL){
|
|
||||||
if ((xpath = xml_find_value(xfilter, "select"))==NULL)
|
|
||||||
xpath="/";
|
|
||||||
/* Create namespace context for xpath from <filter>
|
|
||||||
* The set of namespace declarations are those in scope on the
|
|
||||||
* <filter> element.
|
|
||||||
*/
|
|
||||||
else
|
|
||||||
if (xml_nsctx_node(xfilter, &nsc) < 0)
|
|
||||||
goto done;
|
|
||||||
}
|
|
||||||
/* Get state data from plugins as defined by plugin_statedata(), if any */
|
|
||||||
clicon_err_reset();
|
|
||||||
if ((ret = client_statedata(h, xpath, nsc, &xret)) < 0)
|
|
||||||
goto done;
|
|
||||||
if (ret == 0){ /* Error from callback (error in xret) */
|
|
||||||
if (clicon_xml2cbuf(cbret, xret, 0, 0) < 0)
|
|
||||||
goto done;
|
|
||||||
goto ok;
|
|
||||||
}
|
|
||||||
/* Pre-NACM access step */
|
|
||||||
if ((ret = nacm_access_pre(h, username, NACM_DATA, &xnacm)) < 0)
|
|
||||||
goto done;
|
|
||||||
if (ret == 0){ /* Do NACM validation */
|
|
||||||
if (xpath_vec_nsc(xret, nsc, "%s", &xvec, &xlen, xpath?xpath:"/") < 0)
|
|
||||||
goto done;
|
|
||||||
/* NACM datanode/module read validation */
|
|
||||||
if (nacm_datanode_read(xret, xvec, xlen, username, xnacm) < 0)
|
|
||||||
goto done;
|
|
||||||
}
|
|
||||||
cprintf(cbret, "<rpc-reply>"); /* OK */
|
|
||||||
if (xret==NULL)
|
|
||||||
cprintf(cbret, "<data/>");
|
|
||||||
else{
|
|
||||||
if (xml_name_set(xret, "data") < 0)
|
|
||||||
goto done;
|
|
||||||
if (clicon_xml2cbuf(cbret, xret, 0, 0) < 0)
|
|
||||||
goto done;
|
|
||||||
}
|
|
||||||
cprintf(cbret, "</rpc-reply>");
|
|
||||||
ok:
|
|
||||||
retval = 0;
|
|
||||||
done:
|
|
||||||
clicon_debug(1, "%s retval:%d", __FUNCTION__, retval);
|
|
||||||
if (xnacm)
|
|
||||||
xml_free(xnacm);
|
|
||||||
if (xvec)
|
|
||||||
free(xvec);
|
|
||||||
if (nsc)
|
|
||||||
xml_nsctx_free(nsc);
|
|
||||||
if (xret)
|
|
||||||
xml_free(xret);
|
|
||||||
return retval;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/*! Request graceful termination of a NETCONF session.
|
/*! Request graceful termination of a NETCONF session.
|
||||||
* @param[in] h Clicon handle
|
* @param[in] h Clicon handle
|
||||||
* @param[in] xe Request: <rpc><xn></rpc>
|
* @param[in] xe Request: <rpc><xn></rpc>
|
||||||
|
|
@ -1512,9 +1433,6 @@ backend_rpc_init(clicon_handle h)
|
||||||
"urn:ietf:params:xml:ns:netmod:notification", "create-subscription") < 0)
|
"urn:ietf:params:xml:ns:netmod:notification", "create-subscription") < 0)
|
||||||
goto done;
|
goto done;
|
||||||
/* Clixon RPC */
|
/* Clixon RPC */
|
||||||
if (rpc_callback_register(h, from_client_get_state, NULL,
|
|
||||||
"http://clicon.org/lib", "get-state") < 0)
|
|
||||||
goto done;
|
|
||||||
if (rpc_callback_register(h, from_client_debug, NULL,
|
if (rpc_callback_register(h, from_client_debug, NULL,
|
||||||
"http://clicon.org/lib", "debug") < 0)
|
"http://clicon.org/lib", "debug") < 0)
|
||||||
goto done;
|
goto done;
|
||||||
|
|
|
||||||
|
|
@ -472,7 +472,7 @@ cli_show_config1(clicon_handle h,
|
||||||
clicon_err(OE_FATAL, 0, "Show state only for running database, not %s", db);
|
clicon_err(OE_FATAL, 0, "Show state only for running database, not %s", db);
|
||||||
goto done;
|
goto done;
|
||||||
}
|
}
|
||||||
if (clicon_rpc_get(h, cbuf_get(cbxpath), namespace, &xt) < 0)
|
if (clicon_rpc_get(h, cbuf_get(cbxpath), namespace, CONTENT_ALL, &xt) < 0)
|
||||||
goto done;
|
goto done;
|
||||||
}
|
}
|
||||||
if ((xerr = xpath_first(xt, "/rpc-error")) != NULL){
|
if ((xerr = xpath_first(xt, "/rpc-error")) != NULL){
|
||||||
|
|
@ -723,7 +723,7 @@ cli_show_auto1(clicon_handle h,
|
||||||
clicon_err(OE_FATAL, 0, "Show state only for running database, not %s", db);
|
clicon_err(OE_FATAL, 0, "Show state only for running database, not %s", db);
|
||||||
goto done;
|
goto done;
|
||||||
}
|
}
|
||||||
if (clicon_rpc_get(h, xpath, namespace, &xt) < 0)
|
if (clicon_rpc_get(h, xpath, namespace, CONTENT_ALL, &xt) < 0)
|
||||||
goto done;
|
goto done;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -153,16 +153,6 @@ static const map_str2int http_media_map[] = {
|
||||||
{NULL, -1}
|
{NULL, -1}
|
||||||
};
|
};
|
||||||
|
|
||||||
/* See RFC 8040 4.8.1
|
|
||||||
* @see query_content_str2int
|
|
||||||
*/
|
|
||||||
static const map_str2int query_content_map[] = {
|
|
||||||
{"config", CONTENT_CONFIG},
|
|
||||||
{"nonconfig", CONTENT_NONCONFIG},
|
|
||||||
{"all", CONTENT_ALL},
|
|
||||||
{NULL, -1}
|
|
||||||
};
|
|
||||||
|
|
||||||
int
|
int
|
||||||
restconf_err2code(char *tag)
|
restconf_err2code(char *tag)
|
||||||
{
|
{
|
||||||
|
|
@ -187,18 +177,6 @@ restconf_media_int2str(restconf_media media)
|
||||||
return clicon_int2str(http_media_map, media);
|
return clicon_int2str(http_media_map, media);
|
||||||
}
|
}
|
||||||
|
|
||||||
const query_content
|
|
||||||
query_content_str2int(char *str)
|
|
||||||
{
|
|
||||||
return clicon_str2int(query_content_map, str);
|
|
||||||
}
|
|
||||||
|
|
||||||
const char *
|
|
||||||
query_content_int2str(query_content nr)
|
|
||||||
{
|
|
||||||
return clicon_int2str(query_content_map, nr);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*! Return media_in from Content-Type, -1 if not found or unrecognized
|
/*! Return media_in from Content-Type, -1 if not found or unrecognized
|
||||||
* @note media-type syntax does not support parameters
|
* @note media-type syntax does not support parameters
|
||||||
* @see RFC7231 Sec 3.1.1.1 for media-type syntax type:
|
* @see RFC7231 Sec 3.1.1.1 for media-type syntax type:
|
||||||
|
|
|
||||||
|
|
@ -57,16 +57,6 @@ enum restconf_media{
|
||||||
};
|
};
|
||||||
typedef enum restconf_media restconf_media;
|
typedef enum restconf_media restconf_media;
|
||||||
|
|
||||||
/*! Content query parameter RFC 8040 Sec 4.8.1
|
|
||||||
*/
|
|
||||||
enum query_content{
|
|
||||||
CONTENT_CONFIG,
|
|
||||||
CONTENT_NONCONFIG,
|
|
||||||
CONTENT_ALL /* default */
|
|
||||||
|
|
||||||
};
|
|
||||||
typedef enum query_content query_content;
|
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Prototypes (also in clixon_restconf.h)
|
* Prototypes (also in clixon_restconf.h)
|
||||||
*/
|
*/
|
||||||
|
|
@ -76,8 +66,6 @@ const char *restconf_code2reason(int code);
|
||||||
const restconf_media restconf_media_str2int(char *media);
|
const restconf_media restconf_media_str2int(char *media);
|
||||||
const char *restconf_media_int2str(restconf_media media);
|
const char *restconf_media_int2str(restconf_media media);
|
||||||
restconf_media restconf_content_type(FCGX_Request *r);
|
restconf_media restconf_content_type(FCGX_Request *r);
|
||||||
const query_content query_content_str2int(char *str);
|
|
||||||
const char *query_content_int2str(query_content nr);
|
|
||||||
int restconf_badrequest(FCGX_Request *r);
|
int restconf_badrequest(FCGX_Request *r);
|
||||||
int restconf_unauthorized(FCGX_Request *r);
|
int restconf_unauthorized(FCGX_Request *r);
|
||||||
int restconf_forbidden(FCGX_Request *r);
|
int restconf_forbidden(FCGX_Request *r);
|
||||||
|
|
|
||||||
|
|
@ -115,7 +115,7 @@ api_data_get2(clicon_handle h,
|
||||||
char *namespace = NULL;
|
char *namespace = NULL;
|
||||||
cvec *nsc = NULL;
|
cvec *nsc = NULL;
|
||||||
char *str;
|
char *str;
|
||||||
query_content content = CONTENT_ALL;
|
netconf_content content = CONTENT_ALL;
|
||||||
|
|
||||||
clicon_debug(1, "%s", __FUNCTION__);
|
clicon_debug(1, "%s", __FUNCTION__);
|
||||||
if ((yspec = clicon_dbspec_yang(h)) == NULL){
|
if ((yspec = clicon_dbspec_yang(h)) == NULL){
|
||||||
|
|
@ -125,7 +125,7 @@ api_data_get2(clicon_handle h,
|
||||||
/* Check for content attribute */
|
/* Check for content attribute */
|
||||||
if ((str = cvec_find_str(qvec, "content")) != NULL){
|
if ((str = cvec_find_str(qvec, "content")) != NULL){
|
||||||
clicon_debug(1, "%s content=%s", __FUNCTION__, str);
|
clicon_debug(1, "%s content=%s", __FUNCTION__, str);
|
||||||
if ((content = query_content_str2int(str)) == -1){
|
if ((content = netconf_content_str2int(str)) == -1){
|
||||||
if (netconf_bad_attribute_xml(&xerr, "application",
|
if (netconf_bad_attribute_xml(&xerr, "application",
|
||||||
"<bad-attribute>content</bad-attribute>", "Unrecognized value of content attribute") < 0)
|
"<bad-attribute>content</bad-attribute>", "Unrecognized value of content attribute") < 0)
|
||||||
goto done;
|
goto done;
|
||||||
|
|
@ -168,10 +168,10 @@ api_data_get2(clicon_handle h,
|
||||||
ret = clicon_rpc_get_config(h, "running", xpath, namespace, &xret);
|
ret = clicon_rpc_get_config(h, "running", xpath, namespace, &xret);
|
||||||
break;
|
break;
|
||||||
case CONTENT_NONCONFIG:
|
case CONTENT_NONCONFIG:
|
||||||
ret = clicon_rpc_get_state(h, xpath, namespace, &xret);
|
ret = clicon_rpc_get(h, xpath, namespace, CONTENT_NONCONFIG, &xret);
|
||||||
break;
|
break;
|
||||||
case CONTENT_ALL:
|
case CONTENT_ALL:
|
||||||
ret = clicon_rpc_get(h, xpath, namespace, &xret);
|
ret = clicon_rpc_get(h, xpath, namespace, CONTENT_ALL, &xret);
|
||||||
break;
|
break;
|
||||||
default:
|
default:
|
||||||
clicon_err(OE_XML, EINVAL, "Invalid content attribute %d", content);
|
clicon_err(OE_XML, EINVAL, "Invalid content attribute %d", content);
|
||||||
|
|
|
||||||
|
|
@ -80,6 +80,7 @@
|
||||||
#include <clixon/clixon_yang_module.h>
|
#include <clixon/clixon_yang_module.h>
|
||||||
#include <clixon/clixon_stream.h>
|
#include <clixon/clixon_stream.h>
|
||||||
#include <clixon/clixon_proto.h>
|
#include <clixon/clixon_proto.h>
|
||||||
|
#include <clixon/clixon_netconf_lib.h>
|
||||||
#include <clixon/clixon_proto_client.h>
|
#include <clixon/clixon_proto_client.h>
|
||||||
#include <clixon/clixon_plugin.h>
|
#include <clixon/clixon_plugin.h>
|
||||||
#include <clixon/clixon_options.h>
|
#include <clixon/clixon_options.h>
|
||||||
|
|
@ -90,7 +91,6 @@
|
||||||
#include <clixon/clixon_xpath_ctx.h>
|
#include <clixon/clixon_xpath_ctx.h>
|
||||||
#include <clixon/clixon_xpath.h>
|
#include <clixon/clixon_xpath.h>
|
||||||
#include <clixon/clixon_json.h>
|
#include <clixon/clixon_json.h>
|
||||||
#include <clixon/clixon_netconf_lib.h>
|
|
||||||
#include <clixon/clixon_nacm.h>
|
#include <clixon/clixon_nacm.h>
|
||||||
#include <clixon/clixon_xml_changelog.h>
|
#include <clixon/clixon_xml_changelog.h>
|
||||||
#include <clixon/clixon_xml_nsctx.h>
|
#include <clixon/clixon_xml_nsctx.h>
|
||||||
|
|
|
||||||
|
|
@ -38,6 +38,20 @@
|
||||||
#ifndef _CLIXON_NETCONF_LIB_H
|
#ifndef _CLIXON_NETCONF_LIB_H
|
||||||
#define _CLIXON_NETCONF_LIB_H
|
#define _CLIXON_NETCONF_LIB_H
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Types
|
||||||
|
*/
|
||||||
|
/*! Content query parameter RFC 8040 Sec 4.8.1
|
||||||
|
* Clixon extention: content so that RFC8040 content attribute can be conveyed
|
||||||
|
* internally used in <get>
|
||||||
|
*/
|
||||||
|
enum netconf_content{
|
||||||
|
CONTENT_CONFIG, /* config data only */
|
||||||
|
CONTENT_NONCONFIG, /* state data only */
|
||||||
|
CONTENT_ALL /* default */
|
||||||
|
};
|
||||||
|
typedef enum netconf_content netconf_content;
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Prototypes
|
* Prototypes
|
||||||
*/
|
*/
|
||||||
|
|
@ -77,5 +91,7 @@ int netconf_module_features(clicon_handle h);
|
||||||
int netconf_module_load(clicon_handle h);
|
int netconf_module_load(clicon_handle h);
|
||||||
char *netconf_db_find(cxobj *xn, char *name);
|
char *netconf_db_find(cxobj *xn, char *name);
|
||||||
int netconf_err2cb(cxobj *xerr, cbuf **cberr);
|
int netconf_err2cb(cxobj *xerr, cbuf **cberr);
|
||||||
|
const netconf_content netconf_content_str2int(char *str);
|
||||||
|
const char *netconf_content_int2str(netconf_content nr);
|
||||||
|
|
||||||
#endif /* _CLIXON_NETCONF_LIB_H */
|
#endif /* _CLIXON_NETCONF_LIB_H */
|
||||||
|
|
|
||||||
|
|
@ -52,8 +52,7 @@ int clicon_rpc_copy_config(clicon_handle h, char *db1, char *db2);
|
||||||
int clicon_rpc_delete_config(clicon_handle h, char *db);
|
int clicon_rpc_delete_config(clicon_handle h, char *db);
|
||||||
int clicon_rpc_lock(clicon_handle h, char *db);
|
int clicon_rpc_lock(clicon_handle h, char *db);
|
||||||
int clicon_rpc_unlock(clicon_handle h, char *db);
|
int clicon_rpc_unlock(clicon_handle h, char *db);
|
||||||
int clicon_rpc_get(clicon_handle h, char *xpath, char *namespace, cxobj **xret);
|
int clicon_rpc_get(clicon_handle h, char *xpath, char *namespace, netconf_content content, cxobj **xret);
|
||||||
int clicon_rpc_get_state(clicon_handle h, char *xpath, char *namespace, cxobj **xret);
|
|
||||||
int clicon_rpc_close_session(clicon_handle h);
|
int clicon_rpc_close_session(clicon_handle h);
|
||||||
int clicon_rpc_kill_session(clicon_handle h, int session_id);
|
int clicon_rpc_kill_session(clicon_handle h, int session_id);
|
||||||
int clicon_rpc_validate(clicon_handle h, char *db);
|
int clicon_rpc_validate(clicon_handle h, char *db);
|
||||||
|
|
|
||||||
|
|
@ -45,5 +45,6 @@ int xml_sort(cxobj *x0, void *arg);
|
||||||
int xml_insert(cxobj *xp, cxobj *xc, enum insert_type ins, char *key_val);
|
int xml_insert(cxobj *xp, cxobj *xc, enum insert_type ins, char *key_val);
|
||||||
int xml_sort_verify(cxobj *x, void *arg);
|
int xml_sort_verify(cxobj *x, void *arg);
|
||||||
int match_base_child(cxobj *x0, cxobj *x1c, yang_stmt *yc, cxobj **x0cp);
|
int match_base_child(cxobj *x0, cxobj *x1c, yang_stmt *yc, cxobj **x0cp);
|
||||||
|
cxobj *xml_binsearch(cxobj *xp, char *name, char *keyname, char *keyval);
|
||||||
|
|
||||||
#endif /* _CLIXON_XML_SORT_H */
|
#endif /* _CLIXON_XML_SORT_H */
|
||||||
|
|
|
||||||
|
|
@ -216,7 +216,7 @@ clicon_conf_xml_set(clicon_handle h,
|
||||||
|
|
||||||
/*! Get authorized user name
|
/*! Get authorized user name
|
||||||
* @param[in] h Clicon handle
|
* @param[in] h Clicon handle
|
||||||
* @retval xh XMLDB storage handle. If not connected return NULL
|
* @retval username
|
||||||
*/
|
*/
|
||||||
char *
|
char *
|
||||||
clicon_username_get(clicon_handle h)
|
clicon_username_get(clicon_handle h)
|
||||||
|
|
@ -228,7 +228,7 @@ clicon_username_get(clicon_handle h)
|
||||||
|
|
||||||
/*! Set authorized user name
|
/*! Set authorized user name
|
||||||
* @param[in] h Clicon handle
|
* @param[in] h Clicon handle
|
||||||
* @param[in] xh XMLDB storage handle. If NULL reset it
|
* @param[in] username
|
||||||
* @note Just keep note of it, dont allocate it or so.
|
* @note Just keep note of it, dont allocate it or so.
|
||||||
*/
|
*/
|
||||||
int
|
int
|
||||||
|
|
|
||||||
|
|
@ -1375,3 +1375,25 @@ netconf_err2cb(cxobj *xerr,
|
||||||
done:
|
done:
|
||||||
return retval;
|
return retval;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* See RFC 8040 4.8.1
|
||||||
|
* @see netconf_content_str2int
|
||||||
|
*/
|
||||||
|
static const map_str2int netconf_content_map[] = {
|
||||||
|
{"config", CONTENT_CONFIG},
|
||||||
|
{"nonconfig", CONTENT_NONCONFIG},
|
||||||
|
{"all", CONTENT_ALL},
|
||||||
|
{NULL, -1}
|
||||||
|
};
|
||||||
|
|
||||||
|
const netconf_content
|
||||||
|
netconf_content_str2int(char *str)
|
||||||
|
{
|
||||||
|
return clicon_str2int(netconf_content_map, str);
|
||||||
|
}
|
||||||
|
|
||||||
|
const char *
|
||||||
|
netconf_content_int2str(netconf_content nr)
|
||||||
|
{
|
||||||
|
return clicon_int2str(netconf_content_map, nr);
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -541,6 +541,7 @@ clicon_rpc_unlock(clicon_handle h,
|
||||||
* @param[in] h Clicon handle
|
* @param[in] h Clicon handle
|
||||||
* @param[in] xpath XPath in a filter stmt (or NULL/"" for no filter)
|
* @param[in] xpath XPath in a filter stmt (or NULL/"" for no filter)
|
||||||
* @param[in] namespace Namespace associated w xpath
|
* @param[in] namespace Namespace associated w xpath
|
||||||
|
* @param[in] content CLixon extension: all, config, noconfig. -1 means all
|
||||||
* @param[out] xt XML tree. Free with xml_free.
|
* @param[out] xt XML tree. Free with xml_free.
|
||||||
* Either <config> or <rpc-error>.
|
* Either <config> or <rpc-error>.
|
||||||
* @retval 0 OK
|
* @retval 0 OK
|
||||||
|
|
@ -549,7 +550,7 @@ clicon_rpc_unlock(clicon_handle h,
|
||||||
* namespace will be used which is most probably wrong.
|
* namespace will be used which is most probably wrong.
|
||||||
* @code
|
* @code
|
||||||
* cxobj *xt = NULL;
|
* cxobj *xt = NULL;
|
||||||
* if (clicon_rpc_get(h, "/hello/world", "urn:example:hello", &xt) < 0)
|
* if (clicon_rpc_get(h, "/hello/world", "urn:example:hello", CONTENT_ALL, &xt) < 0)
|
||||||
* err;
|
* err;
|
||||||
* if ((xerr = xpath_first(xt, "/rpc-error")) != NULL){
|
* if ((xerr = xpath_first(xt, "/rpc-error")) != NULL){
|
||||||
* clicon_rpc_generate_error(xerr);
|
* clicon_rpc_generate_error(xerr);
|
||||||
|
|
@ -558,13 +559,15 @@ clicon_rpc_unlock(clicon_handle h,
|
||||||
* if (xt)
|
* if (xt)
|
||||||
* xml_free(xt);
|
* xml_free(xt);
|
||||||
* @endcode
|
* @endcode
|
||||||
|
* @see clicon_rpc_get_config which is almost the same as with content=config, but you can also select dbname
|
||||||
* @see clicon_rpc_generate_error
|
* @see clicon_rpc_generate_error
|
||||||
*/
|
*/
|
||||||
int
|
int
|
||||||
clicon_rpc_get(clicon_handle h,
|
clicon_rpc_get(clicon_handle h,
|
||||||
char *xpath,
|
char *xpath,
|
||||||
char *namespace,
|
char *namespace,
|
||||||
cxobj **xt)
|
netconf_content content,
|
||||||
|
cxobj **xt)
|
||||||
{
|
{
|
||||||
int retval = -1;
|
int retval = -1;
|
||||||
struct clicon_msg *msg = NULL;
|
struct clicon_msg *msg = NULL;
|
||||||
|
|
@ -580,7 +583,13 @@ clicon_rpc_get(clicon_handle h,
|
||||||
cprintf(cb, " username=\"%s\"", username);
|
cprintf(cb, " username=\"%s\"", username);
|
||||||
if (namespace)
|
if (namespace)
|
||||||
cprintf(cb, " xmlns:nc=\"%s\"", NETCONF_BASE_NAMESPACE);
|
cprintf(cb, " xmlns:nc=\"%s\"", NETCONF_BASE_NAMESPACE);
|
||||||
cprintf(cb, "><get>");
|
cprintf(cb, "><get");
|
||||||
|
#if 1
|
||||||
|
/* Clixon extension, content all, config, nonconfig */
|
||||||
|
if (content != -1)
|
||||||
|
cprintf(cb, " content=\"%s\"", netconf_content_int2str(content));
|
||||||
|
#endif
|
||||||
|
cprintf(cb, ">");
|
||||||
if (xpath && strlen(xpath)) {
|
if (xpath && strlen(xpath)) {
|
||||||
if (namespace)
|
if (namespace)
|
||||||
cprintf(cb, "<nc:filter nc:type=\"xpath\" nc:select=\"%s\" xmlns=\"%s\"/>",
|
cprintf(cb, "<nc:filter nc:type=\"xpath\" nc:select=\"%s\" xmlns=\"%s\"/>",
|
||||||
|
|
@ -615,85 +624,6 @@ clicon_rpc_get(clicon_handle h,
|
||||||
return retval;
|
return retval;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*! Get database state data, clixon extension
|
|
||||||
* @param[in] h Clicon handle
|
|
||||||
* @param[in] xpath XPath in a filter stmt (or NULL/"" for no filter)
|
|
||||||
* @param[in] namespace Namespace associated w xpath
|
|
||||||
* @param[out] xt XML tree. Free with xml_free.
|
|
||||||
* Either <config> or <rpc-error>.
|
|
||||||
* @retval 0 OK
|
|
||||||
* @retval -1 Error, fatal or xml
|
|
||||||
* @note if xpath is set but namespace is NULL, the default, netconf base
|
|
||||||
* namespace will be used which is most probably wrong.
|
|
||||||
* @code
|
|
||||||
* cxobj *xt = NULL;
|
|
||||||
* if (clicon_rpc_get_state(h, "/hello/world", "urn:example:hello", &xt) < 0)
|
|
||||||
* err;
|
|
||||||
* if ((xerr = xpath_first(xt, "/rpc-error")) != NULL){
|
|
||||||
* clicon_rpc_generate_error(xerr);
|
|
||||||
* err;
|
|
||||||
* }
|
|
||||||
* if (xt)
|
|
||||||
* xml_free(xt);
|
|
||||||
* @endcode
|
|
||||||
* @see clicon_rpc_generate_error
|
|
||||||
*/
|
|
||||||
int
|
|
||||||
clicon_rpc_get_state(clicon_handle h,
|
|
||||||
char *xpath,
|
|
||||||
char *namespace,
|
|
||||||
cxobj **xt)
|
|
||||||
{
|
|
||||||
int retval = -1;
|
|
||||||
struct clicon_msg *msg = NULL;
|
|
||||||
cbuf *cb = NULL;
|
|
||||||
cxobj *xret = NULL;
|
|
||||||
cxobj *xd;
|
|
||||||
char *username;
|
|
||||||
|
|
||||||
if ((cb = cbuf_new()) == NULL)
|
|
||||||
goto done;
|
|
||||||
cprintf(cb, "<rpc");
|
|
||||||
if ((username = clicon_username_get(h)) != NULL)
|
|
||||||
cprintf(cb, " username=\"%s\"", username);
|
|
||||||
if (namespace)
|
|
||||||
cprintf(cb, " xmlns:nc=\"%s\"", NETCONF_BASE_NAMESPACE);
|
|
||||||
cprintf(cb, "><cl:get-state xmlns:cl=\"http://clicon.org/lib\">");
|
|
||||||
if (xpath && strlen(xpath)) {
|
|
||||||
if (namespace)
|
|
||||||
cprintf(cb, "<nc:filter nc:type=\"xpath\" nc:select=\"%s\" xmlns=\"%s\"/>",
|
|
||||||
xpath, namespace);
|
|
||||||
else /* If xpath != /, this will probably yield an error later */
|
|
||||||
cprintf(cb, "<filter type=\"xpath\" select=\"%s\"/>", xpath);
|
|
||||||
}
|
|
||||||
cprintf(cb, "</cl:get-state></rpc>");
|
|
||||||
if ((msg = clicon_msg_encode("%s", cbuf_get(cb))) == NULL)
|
|
||||||
goto done;
|
|
||||||
if (clicon_rpc_msg(h, msg, &xret, NULL) < 0)
|
|
||||||
goto done;
|
|
||||||
/* Send xml error back: first check error, then ok */
|
|
||||||
if ((xd = xpath_first(xret, "/rpc-reply/rpc-error")) != NULL)
|
|
||||||
xd = xml_parent(xd); /* point to rpc-reply */
|
|
||||||
else if ((xd = xpath_first(xret, "/rpc-reply/data")) == NULL)
|
|
||||||
if ((xd = xml_new("data", NULL, NULL)) == NULL)
|
|
||||||
goto done;
|
|
||||||
if (xt){
|
|
||||||
if (xml_rm(xd) < 0)
|
|
||||||
goto done;
|
|
||||||
*xt = xd;
|
|
||||||
}
|
|
||||||
retval = 0;
|
|
||||||
done:
|
|
||||||
if (cb)
|
|
||||||
cbuf_free(cb);
|
|
||||||
if (xret)
|
|
||||||
xml_free(xret);
|
|
||||||
if (msg)
|
|
||||||
free(msg);
|
|
||||||
return retval;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/*! Close a (user) session
|
/*! Close a (user) session
|
||||||
* @param[in] h CLICON handle
|
* @param[in] h CLICON handle
|
||||||
* @retval 0 OK
|
* @retval 0 OK
|
||||||
|
|
|
||||||
|
|
@ -401,10 +401,9 @@ xml_search_userorder(cxobj *xp,
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
* @param[in] xp Parent xml node.
|
* @param[in] xp Parent xml node.
|
||||||
|
* @param[in] x1 Find this object among xp:s children
|
||||||
|
* @param[in] userorder If x1 is ordered by user
|
||||||
* @param[in] yangi Yang order
|
* @param[in] yangi Yang order
|
||||||
* @param[in] keynr Length of keyvec/keyval vector when applicable
|
|
||||||
* @param[in] keyvec Array of of yang key identifiers
|
|
||||||
* @param[in] keyval Array of of yang key values
|
|
||||||
* @param[in] low Lower bound of childvec search interval
|
* @param[in] low Lower bound of childvec search interval
|
||||||
* @param[in] upper Lower bound of childvec search interval
|
* @param[in] upper Lower bound of childvec search interval
|
||||||
*/
|
*/
|
||||||
|
|
@ -447,10 +446,8 @@ xml_search1(cxobj *xp,
|
||||||
|
|
||||||
/*! Find XML child under xp matching x1 using binary search
|
/*! Find XML child under xp matching x1 using binary search
|
||||||
* @param[in] xp Parent xml node.
|
* @param[in] xp Parent xml node.
|
||||||
* @param[in] yangi Yang child order
|
* @param[in] x1 Find this object among xp:s children
|
||||||
* @param[in] keynr Length of keyvec/keyval vector when applicable
|
* @param[in] yc Yang spec of x1
|
||||||
* @param[in] keyvec Array of of yang key identifiers
|
|
||||||
* @param[in] keyval Array of of yang key values
|
|
||||||
*/
|
*/
|
||||||
static cxobj *
|
static cxobj *
|
||||||
xml_search(cxobj *xp,
|
xml_search(cxobj *xp,
|
||||||
|
|
@ -826,3 +823,37 @@ match_base_child(cxobj *x0,
|
||||||
return retval;
|
return retval;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*! Experimental API for binary search
|
||||||
|
*/
|
||||||
|
cxobj *
|
||||||
|
xml_binsearch(cxobj *xp,
|
||||||
|
char *name,
|
||||||
|
char *keyname,
|
||||||
|
char *keyval)
|
||||||
|
{
|
||||||
|
cxobj *xc = NULL;
|
||||||
|
cxobj *xa = NULL;
|
||||||
|
cxobj *xret = NULL;
|
||||||
|
yang_stmt *yp;
|
||||||
|
yang_stmt *yc;
|
||||||
|
|
||||||
|
if ((yp = xml_spec(xp)) == NULL){
|
||||||
|
clicon_err(OE_YANG, ENOENT, "yang spec not found");
|
||||||
|
goto done;
|
||||||
|
}
|
||||||
|
if ((yc = yang_find(yp, 0, name)) == NULL){
|
||||||
|
clicon_err(OE_YANG, ENOENT, "yang not found");
|
||||||
|
goto done;
|
||||||
|
}
|
||||||
|
if ((xc = xml_new(name, xp, yc)) == NULL)
|
||||||
|
goto done;
|
||||||
|
if ((xa = xml_new(keyname, xc, NULL)) == NULL)
|
||||||
|
goto done;
|
||||||
|
if (xml_value_set(xa, keyval) < 0)
|
||||||
|
goto done;
|
||||||
|
xret = xml_search(xp, xc, yc);
|
||||||
|
done:
|
||||||
|
if (xc)
|
||||||
|
xml_free(xc);
|
||||||
|
return xret;
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -61,7 +61,7 @@ EOF
|
||||||
# Common Jukebox spec (fjukebox must be set)
|
# Common Jukebox spec (fjukebox must be set)
|
||||||
. ./jukebox.sh
|
. ./jukebox.sh
|
||||||
|
|
||||||
new "test params: -f $cfg"
|
new "test params: -f $cfg -- -s"
|
||||||
|
|
||||||
if [ $BE -ne 0 ]; then
|
if [ $BE -ne 0 ]; then
|
||||||
new "kill old backend"
|
new "kill old backend"
|
||||||
|
|
|
||||||
|
|
@ -42,7 +42,7 @@ datarootdir = @datarootdir@
|
||||||
YANG_INSTALLDIR = @YANG_INSTALLDIR@
|
YANG_INSTALLDIR = @YANG_INSTALLDIR@
|
||||||
|
|
||||||
YANGSPECS = clixon-config@2019-06-05.yang
|
YANGSPECS = clixon-config@2019-06-05.yang
|
||||||
YANGSPECS += clixon-lib@2019-08-13.yang
|
YANGSPECS += clixon-lib@2019-06-05.yang
|
||||||
YANGSPECS += clixon-rfc5277@2008-07-01.yang
|
YANGSPECS += clixon-rfc5277@2008-07-01.yang
|
||||||
YANGSPECS += clixon-xml-changelog@2019-03-21.yang
|
YANGSPECS += clixon-xml-changelog@2019-03-21.yang
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -52,6 +52,11 @@ module clixon-lib {
|
||||||
description
|
description
|
||||||
"Released in Clixon 3.9";
|
"Released in Clixon 3.9";
|
||||||
}
|
}
|
||||||
|
import ietf-netconf {
|
||||||
|
description "for the get-state extension";
|
||||||
|
prefix nc;
|
||||||
|
}
|
||||||
|
|
||||||
rpc debug {
|
rpc debug {
|
||||||
description "Set debug level of backend.";
|
description "Set debug level of backend.";
|
||||||
input {
|
input {
|
||||||
|
|
@ -92,5 +97,4 @@ module clixon-lib {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
Loading…
Add table
Add a link
Reference in a new issue