presence_xml.c

Go to the documentation of this file.

/*
 * $Id: presence_xml.c 2006-12-07 18:05:05Z anca_vamanu$
 *
 * presence_xml module - Presence Handling XML bodies module
 *
 * Copyright (C) 2006 Voice Sistem S.R.L.
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * History:
 * --------
 *  2007-04-12  initial version (anca)
 */

/*! \file
 * \brief Kamailio Presence_XML :: Core
 * \ingroup presence_xml
 */

/*! \defgroup presence_xml Presence_xml :: This module implements a range of XML-based SIP event packages for presence
 */


#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <libxml/parser.h>
#include <time.h>

#include "../../sr_module.h"
#include "../../dprint.h"
#include "../../str.h"
#include "../../ut.h"
#include "../../parser/msg_parser.h"
#include "../../parser/parse_uri.h"
#include "../../mem/mem.h"
#include "../presence/bind_presence.h"
#include "../presence/hash.h"
#include "../presence/notify.h"
#include "../xcap_client/xcap_functions.h"
#include "../sl/sl_api.h"
#include "pidf.h"
#include "add_events.h"
#include "presence_xml.h"

MODULE_VERSION
#define S_TABLE_VERSION 3

/** module functions */

static int mod_init(void);
static int child_init(int);
static void destroy(void);
static int pxml_add_xcap_server( modparam_t type, void* val);
static int shm_copy_xcap_list(void);
static void free_xs_list(xcap_serv_t* xs_list, int mem_type);
static int xcap_doc_updated(int doc_type, str xid, char* doc);
static int mi_child_init(void);
static struct mi_root* dum(struct mi_root* cmd, void* param);

/** module variables ***/
add_event_t pres_add_event;
update_watchers_t pres_update_watchers;
pres_get_sphere_t pres_get_sphere;


/* Module parameter variables */
str xcap_table= str_init("xcap");
str db_url = str_init(DEFAULT_DB_URL);
int force_active= 0;
int pidf_manipulation= 0;
int integrated_xcap_server= 0;
xcap_serv_t* xs_list= NULL;
int disable_presence = 0;
int disable_winfo    = 0;
int disable_bla      = 0;

/* SL bind */
struct sl_binds slb;

/* database connection */
db_con_t *pxml_db = NULL;
db_func_t pxml_dbf;

/* functions imported from xcap_client module */

xcapGetNewDoc_t xcap_GetNewDoc;

static param_export_t params[]={
   { "db_url",    STR_PARAM, &db_url.s},
   { "xcap_table",      STR_PARAM, &xcap_table.s},
   { "force_active", INT_PARAM, &force_active },
   { "pidf_manipulation",  INT_PARAM, &pidf_manipulation},
   { "integrated_xcap_server", INT_PARAM, &integrated_xcap_server},
   { "xcap_server",        STR_PARAM|USE_FUNC_PARAM,(void*)pxml_add_xcap_server},
   { "disable_presence",   INT_PARAM, &disable_presence },
   { "disable_winfo",      INT_PARAM, &disable_winfo },
   { "disable_bla",     INT_PARAM, &disable_bla },
   { 0, 0, 0}
};

static mi_export_t mi_cmds[] = {
   { "dum",             dum,          0,  0,  mi_child_init},
   {  0,                0,            0,  0,        0      }
};

/** module exports */
struct module_exports exports= {
   "presence_xml",      /* module name */
    DEFAULT_DLFLAGS, /* dlopen flags */
    0,         /* exported functions */
    params,    /* exported parameters */
    0,            /* exported statistics */
    mi_cmds,      /* exported MI functions */
    0,            /* exported pseudo-variables */
    0,            /* extra processes */
    mod_init,     /* module initialization function */
    0,            /* response handling function */
    destroy,      /* destroy function */
    child_init    /* per-child init function */
};
   
/**
 * init module function
 */
static int mod_init(void)
{
   bind_presence_t bind_presence;
   presence_api_t pres;
      
   db_url.len = db_url.s ? strlen(db_url.s) : 0;
   LM_DBG("db_url=%s/%d/%p\n",ZSW(db_url.s),db_url.len, db_url.s);
   xcap_table.len = xcap_table.s ? strlen(xcap_table.s) : 0;
   
   /* binding to mysql module  */
   if (db_bind_mod(&db_url, &pxml_dbf))
   {
      LM_ERR("Database module not found\n");
      return -1;
   }
   
   if (!DB_CAPABILITY(pxml_dbf, DB_CAP_ALL)) {
      LM_ERR("Database module does not implement all functions"
            " needed by the module\n");
      return -1;
   }

   pxml_db = pxml_dbf.init(&db_url);
   if (!pxml_db)
   {
      LM_ERR("while connecting to database\n");
      return -1;
   }

   if(db_check_table_version(&pxml_dbf, pxml_db, &xcap_table, S_TABLE_VERSION) < 0) {
      LM_ERR("error during table version check.\n");
      return -1;
   }
   /* load SL API */
   if(load_sl_api(&slb)==-1)
   {
      LM_ERR("can't load sl functions\n");
      return -1;
   }

   bind_presence= (bind_presence_t)find_export("bind_presence", 1,0);
   if (!bind_presence)
   {
      LM_ERR("Can't bind presence\n");
      return -1;
   }
   if (bind_presence(&pres) < 0)
   {
      LM_ERR("Can't bind module pua\n");
      return -1;
   }
   
   pres_get_sphere= pres.get_sphere;
   pres_add_event= pres.add_event;
   pres_update_watchers= pres.update_watchers_status;
   if (pres_add_event == NULL || pres_update_watchers== NULL)
   {
      LM_ERR("Can't import add_event\n");
      return -1;
   }
   if(xml_add_events()< 0)
   {
      LM_ERR("adding xml events\n");
      return -1;     
   }
   
   if(force_active== 0 && !integrated_xcap_server )
   {
      xcap_api_t xcap_api;
      bind_xcap_t bind_xcap;

      /* bind xcap */
      bind_xcap= (bind_xcap_t)find_export("bind_xcap", 1, 0);
      if (!bind_xcap)
      {
         LM_ERR("Can't bind xcap_client\n");
         return -1;
      }
   
      if (bind_xcap(&xcap_api) < 0)
      {
         LM_ERR("Can't bind xcap_api\n");
         return -1;
      }
      xcap_GetNewDoc= xcap_api.getNewDoc;
      if(xcap_GetNewDoc== NULL)
      {
         LM_ERR("can't import get_elem from xcap_client module\n");
         return -1;
      }
   
      if(xcap_api.register_xcb(PRES_RULES, xcap_doc_updated)< 0)
      {
         LM_ERR("registering xcap callback function\n");
         return -1;
      }
   }

   if(shm_copy_xcap_list()< 0)
   {
      LM_ERR("copying xcap server list in share memory\n");
      return -1;
   }

   if(pxml_db)
      pxml_dbf.close(pxml_db);
   pxml_db = NULL;

   return 0;
}

static int mi_child_init(void)
{  
   if (pxml_dbf.init==0)
   {
      LM_CRIT("database not bound\n");
      return -1;
   }
   pxml_db = pxml_dbf.init(&db_url);
   if (pxml_db== NULL)
   {
      LM_ERR("while connecting database\n");
      return -1;
   }
      
   if (pxml_dbf.use_table(pxml_db, &xcap_table) < 0)
   {
      LM_ERR("in use_table SQL operation\n");
      return -1;
   }
   
   LM_DBG("Database connection opened successfully\n");

   return 0;
}  

static int child_init(int rank)
{
   LM_DBG("[%d]  pid [%d]\n", rank, getpid());
   
   if (pxml_dbf.init==0)
   {
      LM_CRIT("database not bound\n");
      return -1;
   }
   pxml_db = pxml_dbf.init(&db_url);
   if (pxml_db== NULL)
   {
      LM_ERR("child %d: ERROR while connecting database\n",rank);
      return -1;
   }
   if (pxml_dbf.use_table(pxml_db, &xcap_table) < 0)
   {
      LM_ERR("child %d: ERROR in use_table\n", rank);
      return -1;
   }
   
   LM_DBG("child %d: Database connection opened successfully\n",rank);

   return 0;
}  

static void destroy(void)
{  
   LM_DBG("start\n");
   if(pxml_db && pxml_dbf.close)
      pxml_dbf.close(pxml_db);

   free_xs_list(xs_list, SHM_MEM_TYPE);

   return ;
}

static int pxml_add_xcap_server( modparam_t type, void* val)
{
   xcap_serv_t* xs;
   int size;
   char* serv_addr= (char*)val;
   char* sep= NULL;
   unsigned int port= 80;
   str serv_addr_str;
      
   serv_addr_str.s= serv_addr;
   serv_addr_str.len= strlen(serv_addr);

   sep= strchr(serv_addr, ':');
   if(sep)
   {  
      char* sep2= NULL;
      str port_str;
      
      sep2= strchr(sep+ 1, ':');
      if(sep2)
         sep= sep2;
      

      port_str.s= sep+ 1;
      port_str.len= serv_addr_str.len- (port_str.s- serv_addr);

      if(str2int(&port_str, &port)< 0)
      {
         LM_ERR("while converting string to int\n");
         goto error;
      }
      if(port< 0 || port> 65535)
      {
         LM_ERR("wrong port number\n");
         goto error;
      }
      *sep = '\0';
      serv_addr_str.len= sep- serv_addr;
   }

   size= sizeof(xcap_serv_t)+ (serv_addr_str.len+ 1)* sizeof(char);
   xs= (xcap_serv_t*)pkg_malloc(size);
   if(xs== NULL)
   {
      ERR_MEM(PKG_MEM_STR);
   }
   memset(xs, 0, size);
   size= sizeof(xcap_serv_t);

   xs->addr= (char*)xs+ size;
   strcpy(xs->addr, serv_addr);

   xs->port= port;
   /* check for duplicates */
   xs->next= xs_list;
   xs_list= xs;
   return 0;

error:
   free_xs_list(xs_list, PKG_MEM_TYPE);
   return -1;
}

static int shm_copy_xcap_list(void)
{
   xcap_serv_t* xs, *shm_xs, *prev_xs;
   int size;

   xs= xs_list;
   if(xs== NULL)
   {
      if(force_active== 0 && !integrated_xcap_server)
      {
         LM_ERR("no xcap_server parameter set\n");
         return -1;
      }
      return 0;
   }
   xs_list= NULL;
   size= sizeof(xcap_serv_t);
   
   while(xs)
   {
      size+= (strlen(xs->addr)+ 1)* sizeof(char);
      shm_xs= (xcap_serv_t*)shm_malloc(size);
      if(shm_xs== NULL)
      {
         ERR_MEM(SHARE_MEM);
      }
      memset(shm_xs, 0, size);
      size= sizeof(xcap_serv_t);

      shm_xs->addr= (char*)shm_xs+ size;
      strcpy(shm_xs->addr, xs->addr);
      shm_xs->port= xs->port;
      shm_xs->next= xs_list; 
      xs_list= shm_xs;

      prev_xs= xs;
      xs= xs->next;

      pkg_free(prev_xs);
   }
   return 0;

error:
   free_xs_list(xs_list, SHM_MEM_TYPE);
   return -1;
}

static void free_xs_list(xcap_serv_t* xsl, int mem_type)
{
   xcap_serv_t* xs, *prev_xs;

   xs= xsl;

   while(xs)
   {
      prev_xs= xs;
      xs= xs->next;
      if(mem_type & SHM_MEM_TYPE)
         shm_free(prev_xs);
      else
         pkg_free(prev_xs);
   }
   xsl= NULL;
}

static int xcap_doc_updated(int doc_type, str xid, char* doc)
{
   pres_ev_t ev;
   str rules_doc;

   /* call updating watchers */
   ev.name.s= "presence";
   ev.name.len= PRES_LEN;

   rules_doc.s= doc;
   rules_doc.len= strlen(doc);

   if(pres_update_watchers(xid, &ev, &rules_doc)< 0)
   {
      LM_ERR("updating watchers in presence\n");
      return -1;  
   }
   return 0;

}

static struct mi_root* dum(struct mi_root* cmd, void* param)
{
   return 0;
}