git.sip-router.org Git - sip-router/blob - src/modules/xcap_client/xcap_functions.h

   1 /*
   2  * xcap_client module - XCAP client for Kamailio
   3  *
   4  * Copyright (C) 2007 Voice Sistem S.R.L.
   5  *
   6  * This file is part of Kamailio, a free SIP server.
   7  *
   8  * Kamailio 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  * Kamailio 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  *
  22  */
  23
  24 #ifndef XCAP_FUNC_H
  25 #define XCAP_FUNC_H
  26
  27 #include "xcap_callbacks.h"
  28
  29 #define USERS_TYPE      1
  30 #define GLOBAL_TYPE     2
  31
  32 #define IF_MATCH        1
  33 #define IF_NONE_MATCH    2
  34
  35 /* macros for the entities responsible for handling a record inserted
  36  * in xcap table*/
  37
  38 #define INTEGRATED_SERVER      0
  39 #define XCAP_CL_MOD            1 /* xcap_client module responsibility */
  40
  41
  42 typedef struct xcap_doc_sel
  43 {
  44         str auid;
  45         int doc_type;
  46         int type;
  47         str xid;
  48         str filename;
  49 }xcap_doc_sel_t;
  50
  51 typedef struct ns_list
  52 {
  53         int name;
  54         str value;
  55         struct ns_list* next;
  56 }ns_list_t;
  57
  58 typedef struct step
  59 {
  60         str val;
  61         struct step* next;
  62 }step_t;
  63
  64 typedef struct xcap_node_sel
  65 {
  66         step_t* steps;
  67         step_t* last_step;
  68         int size;
  69         ns_list_t* ns_list;
  70         ns_list_t* last_ns;
  71         int ns_no;
  72
  73 }xcap_node_sel_t;
  74
  75 typedef struct att_test
  76 {
  77         str name;
  78         str value;
  79 }attr_test_t;
  80
  81 typedef struct xcap_get_req
  82 {
  83         char* xcap_root;
  84         unsigned int port;
  85         xcap_doc_sel_t doc_sel;
  86         xcap_node_sel_t* node_sel;
  87         char* etag;
  88         int match_type;
  89 }xcap_get_req_t;
  90
  91 xcap_node_sel_t* xcapInitNodeSel(void);
  92 typedef xcap_node_sel_t* (*xcap_nodeSel_init_t )(void);
  93
  94 xcap_node_sel_t* xcapNodeSelAddStep(xcap_node_sel_t* curr_sel, str* name,
  95                 str* namespace, int pos, attr_test_t*  attr_test, str* extra_sel);
  96
  97 typedef xcap_node_sel_t* (*xcap_nodeSel_add_step_t)(xcap_node_sel_t* curr_sel,
  98         str* name,str* namespace,int pos,attr_test_t*  attr_test,str* extra_sel);
  99
 100 xcap_node_sel_t* xcapNodeSelAddTerminal(xcap_node_sel_t* curr_sel,
 101                 char* attr_sel, char* namespace_sel, char* extra_sel );
 102
 103 typedef xcap_node_sel_t* (*xcap_nodeSel_add_terminal_t)(xcap_node_sel_t* curr_sel,
 104                 char* attr_sel, char* namespace_sel, char* extra_sel );
 105
 106 void xcapFreeNodeSel(xcap_node_sel_t* node);
 107
 108 typedef void (*xcap_nodeSel_free_t)(xcap_node_sel_t* node);
 109
 110 /* specifical function to get a new document, not present in xcap table
 111  * to be updated and handled by the xcap_client module*/
 112 char* xcapGetNewDoc(xcap_get_req_t req, str user, str domain);
 113 typedef char* (*xcapGetNewDoc_t)(xcap_get_req_t req, str user, str domain);
 114
 115 typedef struct xcap_api {
 116         xcap_nodeSel_init_t int_node_sel;
 117         xcap_nodeSel_add_step_t add_step;
 118         xcap_nodeSel_add_terminal_t add_terminal;
 119         xcap_nodeSel_free_t free_node_sel;
 120         xcapGetNewDoc_t getNewDoc;
 121         register_xcapcb_t register_xcb;
 122 }xcap_api_t;
 123
 124 int bind_xcap(xcap_api_t* api);
 125
 126 typedef int (*bind_xcap_t)(xcap_api_t* api);
 127
 128 char* send_http_get(char* path, unsigned int xcap_port, char* match_etag,
 129                 int match_type, char** etag);
 130 #endif