agt_restcmn.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2024, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_agt_restcmn
#define _H_agt_restcmn
 
 
/*  FILE: agt_restcmn.h
*********************************************************************
*                                                                   *
*                         P U R P O S E                             *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                   C H A N G E         H I S T O R Y               *
*                                                                   *
*********************************************************************
 
date             init     comment
----------------------------------------------------------------------
30-jul-15         abb      Begun.
 
 
*********************************************************************
*                                                                   *
*                     I N C L U D E    F I L E S                    *
*                                                                   *
*********************************************************************/
 
#ifndef _H_ses
#include "ses.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_yangapi
#include "yangapi.h"
#endif
 
#ifndef _H_yang_patch
#include "yang_patch.h"
#endif
 
#ifndef _H_getcb
#include "getcb.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/********************************************************************
*                                                                   *
*                       C O N S T A N T S                           *
*                                                                   *
*********************************************************************/
/* YANG-API specific consts */
#define YANG_API_MODULE  NCXMOD_YANG_API
#define YANGAPI_WRAPPER_NODE      NCX_EL_DATA
#define YANGPATCH_WRAPPER_NODE    (const xmlChar *)"yang-patch-status"
#define YANG_API_REVISION NULL
 
#define YANG_API_ROOT             (const xmlChar *)"yang-api"
#define YANG_API_VERSION          (const xmlChar *)"1.0"
#define YANG_YANG                 \
    (const xmlChar *)"Please specify module name and revision"
 
/* RESTCONF specific const */
#define RESTCONF_REVISION         (const xmlChar *)"2017-01-26"
#define RESTCONF_YUMA_REVISION    (const xmlChar *)"2015-12-03"
 
#define RESTCONF_ROOT             (const xmlChar *)"restconf"
#define RESTCONF_QMAX             (const xmlChar *)"1.0"
 
#define RESTCONF_CONTENT_JSON     (const xmlChar *)"application/json"
#define RESTCONF_CONTENT_XML      (const xmlChar *)"application/xml"
#define RESTCONF_CONTENT_TEXT_XML (const xmlChar *)"text/xml"
#define RESTCONF_DEF_ACCEPT_TYPE  (const xmlChar *)"application/yang-data"
#define RESTCONF_HEADER_WILDCARD  (const xmlChar *)"*/*"
 
/* YANG-PATCH const */
#define RESTCONF_CONTENT_PATCH_XML \
    (const xmlChar *)"application/yang-patch+xml"
#define RESTCONF_CONTENT_PATCH_JSON \
    (const xmlChar *)"application/yang-patch+json"
 
/* common consts */
 
/* used by parse_path to URL decode a key value inline
 * instead of mallocing the buffer
 */
#define TEMP_BUFF_SIZE  1024
 
#define YL_FS_SEP                 (const xmlChar *)"/"
 
#define YANG_XRD_MEDIA            (const xmlChar *)"application/xrd"
#define YANG_YANG_MEDIA           (const xmlChar *)"application/yang"
#define YANG_EVENT_MEDIA          (const xmlChar *)"text/event"
#define YANG_STREAM_SUBMEDIA      (const xmlChar *)"stream"
#define YANG_PATCH_SUBMEDIA       (const xmlChar *)"patch"
#define YANG_DATA_SUBMEDIA        (const xmlChar *)"data"
#define YANG_XRD_SUBMEDIA         (const xmlChar *)"xrd"
 
 
#define RESTCONF_YANG_SCHEMA      (const xmlChar *)"schema"
/*
Depricated
#define YANG_API_SUBMEDIA         (const xmlChar *)"api"
#define YANG_DATASTORE_SUBMEDIA   (const xmlChar *)"datastore"
#define YANG_OPERATION_SUBMEDIA   (const xmlChar *)"operation"
#define YANG_ERRORS_SUBMEDIA      (const xmlChar *)"errors"
#define YANG_PATCHSTAT_SUBMEDIA   (const xmlChar *)"patch-status"
#define YANG_PATCHSTAT_MEDIA      (const xmlChar *)"application/yang.patch-status"
*/
 
 
/* heading only */
 
 
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
typedef struct agt_yangapi_context_t_ {
    ncx_module_t     *mod;          
    obj_template_t   *obj;          
    val_value_t      *root;         
    uint32            cap_changes;  
    uint32            requests;     
    boolean           yangapi_enabled; 
    xmlns_id_t        mod_nsid;     
} agt_yangapi_context_t;
 
 
typedef struct agt_restconf_data_t_ {
    ncx_module_t     *mod;          
    ncx_module_t     *yuma_mod;     
    obj_template_t   *obj;          
    val_value_t      *root;         
    uint32            cap_changes;  
    uint32            requests;     
    boolean           restconf_enabled; 
    xmlns_id_t        mod_nsid;     
} agt_restconf_data_t;
 
 
 
/********************************************************************
*                                                                   *
*                        F U N C T I O N S                          *
*                                                                   *
*********************************************************************/
 
 
extern const xmlChar *
    get_launchpoint_name (yangapi_launchpt_t launchpt);
 
 
extern status_t
    agt_restcmn_parse_fragment (yangapi_cb_t *rcb,
                                xmlChar *uri,
                                uint32 *retlen);
 
 
extern status_t
    agt_restcmn_parse_query_string (ses_cb_t *scb,
                                    rpc_msg_t *msg,
                                    yangapi_cb_t *rcb,
                                    xmlChar *uri,
                                    uint32 *retlen);
 
 
extern xmlChar *
    agt_restcmn_get_param (yangapi_cb_t *rcb,
                           const xmlChar *name,
                           boolean *found);
 
 
extern yangapi_param_t *
    agt_restcmn_get_first_param (yangapi_cb_t *rcb);
 
 
extern yangapi_param_t *
    agt_restcmn_get_next_param (yangapi_param_t *param);
 
 
extern status_t
    agt_restcmn_validate_query_string (ses_cb_t *scb,
                                       rpc_msg_t *msg,
                                       yangapi_cb_t *rcb);
 
 
extern status_t
    agt_restcmn_parse_path (ses_cb_t *scb,
                            rpc_msg_t *msg,
                            yangapi_cb_t *rcb,
                            val_value_t *root,
                            const xmlChar *path);
 
 
extern status_t
    agt_restcmn_get_http_input (ses_cb_t *scb,
                                yangapi_cb_t *rcb,
                                rpc_msg_t *msg,
                                int content_len);
 
 
extern status_t
    agt_restcmn_set_content_encoding (ses_cb_t *scb,
                                      yangapi_cb_t *rcb,
                                      rpc_msg_t *msg);
 
 
extern boolean
    agt_restcmn_check_unmodified_return (yangapi_cb_t *rcb);
 
 
extern status_t
    agt_restcmn_setup_notifications (ses_cb_t *scb,
                                     yangapi_cb_t *rcb,
                                     rpc_msg_t *msg);
 
 
extern status_t
    agt_restcmn_setup_read_params (ses_cb_t *scb,
                                   yangapi_cb_t *rcb,
                                   rpc_msg_t *msg);
 
 
extern boolean
    agt_restcmn_operation_supports_json (obj_template_t *rpcobj);
 
 
extern status_t
    agt_restcmn_get_operations (ses_cb_t *scb,
                                getcb_mode_t cbmode,
                                const val_value_t *virval,
                                val_value_t  *dstval);
 
 
extern int
    agt_restcmn_get_content_len (yangapi_cb_t *rcb);
 
 
extern status_t
    agt_restcmn_validate_method (ses_cb_t *scb,
                                 yangapi_cb_t *rcb,
                                 rpc_msg_t *msg);
 
 
extern status_t
    agt_restcmn_check_metpar_error (ses_cb_t *scb,
                                    yangapi_cb_t *rcb,
                                    rpc_msg_t *msg,
                                    const xmlChar *parmname);
 
 
extern yangapi_method_t
    agt_restcmn_get_method (const xmlChar *method);
 
 
extern boolean
    agt_restcmn_method_is_read (yangapi_method_t method);
 
 
 
extern boolean
    agt_restcmn_validate_accept_header (ses_cb_t *scb,
                                        yangapi_cb_t *rcb,
                                        rpc_msg_t *msg,
                                        boolean error_recorded,
                                        status_t *res);
 
 
extern xmlns_id_t
    agt_restcmn_get_nsid (ncx_protocol_t proto);
 
 
extern void
    agt_restcmn_free_msg (rpc_msg_t *msg);
 
 
extern void
   agt_restcmn_print_debug_line (ses_cb_t *scb,
                                 yangapi_cb_t *rcb);
 
 
extern boolean
    agt_restcmn_get_config_parm (yangapi_cb_t *rcb,
                                 val_value_t *context_node);
 
 
extern val_value_t *
    agt_restcmn_new_config_wrapper (void);
 
 
extern xmlChar *
    agt_restcmn_make_uri (ses_cb_t *scb,
                          const xmlChar *target,
                          const xmlChar *edit_target);
 
 
extern xmlChar *
    agt_restcmn_decode_url (const xmlChar *url,
                            status_t *res);
 
 
extern void
    agt_restcmn_record_obj_error (ses_cb_t *scb,
                                  rpc_msg_t *msg,
                                  status_t res,
                                  obj_template_t *errobj,
                                  const xmlChar *badval);
 
 
extern void
    agt_restcmn_record_error (ses_cb_t *scb,
                              xml_msg_hdr_t *mhdr,
                              status_t res,
                              val_value_t *errnode,
                              const xmlChar *badval);
 
 
extern void
    agt_restcmn_record_error_errinfo (ses_cb_t *scb,
                                      xml_msg_hdr_t *mhdr,
                                      status_t res,
                                      val_value_t *errnode,
                                      const xmlChar *badval,
                                      const ncx_errinfo_t *errinfo);
 
 
extern void
    agt_restcmn_obj_error (ses_cb_t *scb,
                           xml_msg_hdr_t *mhdr,
                           status_t res,
                           obj_template_t *errobj,
                           const xmlChar *badval);
 
 
extern void
    agt_restcmn_val_error (ses_cb_t *scb,
                           xml_msg_hdr_t *mhdr,
                           status_t res,
                           val_value_t *errval,
                           const xmlChar *badval);
 
 
extern const xmlChar *
    agt_restcmn_entry_point (void);
 
 
extern void
    agt_restcmn_setup_launch_point (yangapi_cb_t *rcb);
 
 
extern status_t
    agt_rescmn_setup_action_request (ses_cb_t *scb,
                                     rpc_msg_t *msg,
                                     yangapi_cb_t *rcb);
 
 
extern val_value_t *
    agt_restcmn_get_active_root (yangapi_cb_t *rcb);
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif            /* _H_agt_restcmn */