Commit 793906b4 authored by smorlat's avatar smorlat

Import buddylookup xml-rpc plugin.



git-svn-id: svn+ssh://svn.savannah.nongnu.org/linphone/trunk@322 3f6dc0c8-ddfe-455d-9043-3cd528dc4637
parent 76794acc
This diff is collapsed.
Installation Instructions
*************************
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
2006, 2007 Free Software Foundation, Inc.
This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.
Basic Installation
==================
Briefly, the shell commands `./configure; make; make install' should
configure, build, and install this package. The following
more-detailed instructions are generic; see the `README' file for
instructions specific to this package.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for
debugging `configure').
It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring. Caching is
disabled by default to prevent problems with accidental use of stale
cache files.
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
The file `configure.ac' (or `configure.in') is used to create
`configure' by a program called `autoconf'. You need `configure.ac' if
you want to change it or regenerate `configure' using a newer version
of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system.
Running `configure' might take a while. While running, it prints
some messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
documentation.
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
6. Often, you can also type `make uninstall' to remove the installed
files again.
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that the
`configure' script does not know about. Run `./configure --help' for
details on some of the pertinent environment variables.
You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here
is an example:
./configure CC=c99 CFLAGS=-g LIBS=-lposix
*Note Defining Variables::, for more details.
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you can use GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
With a non-GNU `make', it is safer to compile the package for one
architecture at a time in the source code directory. After you have
installed the package for one architecture, use `make distclean' before
reconfiguring for another architecture.
Installation Names
==================
By default, `make install' installs the package's commands under
`/usr/local/bin', include files under `/usr/local/include', etc. You
can specify an installation prefix other than `/usr/local' by giving
`configure' the option `--prefix=PREFIX'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
PREFIX as the prefix for installing programs and libraries.
Documentation and other data files still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=DIR' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
=================
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
==========================
There may be some features `configure' cannot figure out automatically,
but needs to determine by the type of machine the package will run on.
Usually, assuming the package is built to be run on the _same_
architectures, `configure' can figure that out, but if it prints a
message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
CPU-COMPANY-SYSTEM
where SYSTEM can have one of these forms:
OS KERNEL-OS
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the option `--target=TYPE' to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share, you
can create a site shell script called `config.site' that gives default
values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Defining Variables
==================
Variables not defined in a site shell script can be set in the
environment passed to `configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'. For example:
./configure CC=/usr/local2/bin/gcc
causes the specified `gcc' to be used as the C compiler (unless it is
overridden in the site shell script).
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
an Autoconf bug. Until the bug is fixed you can use this workaround:
CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
`configure' Invocation
======================
`configure' recognizes the following options to control how it operates.
`--help'
`-h'
Print a summary of the options to `configure', and exit.
`--version'
`-V'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`--cache-file=FILE'
Enable the cache: use and save the results of the tests in FILE,
traditionally `config.cache'. FILE defaults to `/dev/null' to
disable caching.
`--config-cache'
`-C'
Alias for `--cache-file=config.cache'.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`configure' also accepts some other, not widely useful, options. Run
`configure --help' for more details.
This plugin implements a buddy lookup using a xml-rpc lookup to a distant server.
The server side implementation isn't available here but it is quite simple to implement.
The format of the xml-rpc request defined below:
The function name is "fp.searchUsers"
/**
* Arguments:
* sip_uri: string, mandatory, the SIP username, ie john.doe@example.net
* password: string, mandatory, the SIP password
* criteria: string, mandatory, the key or criteria to search for, multiple keywords should be space separated
* limit: int, optional default 100, the maximum number of results to get back, -1 for all of them (note that -1 would really be limited by a hard limit at the server, something decent in the style of 100 or similar).
* offset: int, optional default 0, where to start in the result list for the given criteria
* domain: string, optional default is the same name as the SIP name, in which domain to search for users
*
* Returns:
* If sip-uri & password is correct, an array where each element is a struct with the following members:
* first_name: string, example: "John"
* last_name: string, example: "Doe"
* display_name: string, example: "John Doe"
* street: string, example: "Paradise Avenue"
* zip: string, example: "7777777"
* city: string, example: "Heaven"
* country: string, example: "SKY"
* email: string, example: "john.doe@example.net"
* sip: string, example "john.doe@example.net"
* domain: string, example: "myjoice.com"
*
* If username || password is incorrect an error with a numeric code and a message is returned.
*
*/
The server uri is configurable in ~/.linphonerc :
[BuddyLookup]
url=https://....
#!/bin/sh
AM_VERSION="1.10"
if ! type aclocal-$AM_VERSION 1>/dev/null 2>&1; then
# automake-1.9 (recommended) is not available on Fedora 8
AUTOMAKE=automake
ACLOCAL=aclocal
else
ACLOCAL=aclocal-${AM_VERSION}
AUTOMAKE=automake-${AM_VERSION}
fi
echo "Generating build scripts in mediastreamer..."
set -x
libtoolize --copy --force
autoheader
$ACLOCAL
$AUTOMAKE --force-missing --add-missing --copy
autoconf
# -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.
AC_PREREQ(2.61)
AC_INIT(buddylookup, 0.0.1, simon dot morlat at linphone dot org)
AC_CONFIG_SRCDIR([src/lookup.c])
AM_INIT_AUTOMAKE([tar-ustar])
AC_CANONICAL_SYSTEM
AC_MSG_CHECKING([warning make an error on compilation])
AC_ARG_ENABLE(strict,
[ --enable-strict Enable error on compilation warning [default=yes]],
[wall_werror=$enableval],
[wall_werror=yes]
)
dnl AC_CONFIG_HEADER([config.h])
# Checks for programs.
AC_PROG_CC
dnl LT_INIT([disable-static])
AC_DISABLE_STATIC
AC_PROG_LIBTOOL
# Checks for libraries.
PKG_CHECK_MODULES(LIBSOUP, libsoup-2.4 >= 2.4.0)
PKG_CHECK_MODULES(LIBLINPHONE, linphone >= 3.0.0)
LINPHONE_PLUGINS_DIR="\$(libdir)/liblinphone/plugins/"
AC_SUBST(LINPHONE_PLUGINS_DIR)
# Checks for header files.
# Checks for typedefs, structures, and compiler characteristics.
# Checks for library functions.
if test "$GCC" = "yes" ; then
CFLAGS="$CFLAGS -Wall"
LDFLAGS="$LDFLAGS -rdynamic "
if test $wall_werror = yes; then
CFLAGS="$CFLAGS -Werror "
fi
fi
AC_OUTPUT(
Makefile
src/Makefile
)
This diff is collapsed.
pluginsdir=$(LINPHONE_PLUGINS_DIR)
plugins_LTLIBRARIES=libbuddylookup.la
libbuddylookup_la_SOURCES=lookup.c
libbuddylookup_la_LIBADD=$(LIBSOUP_LIBS) $(LIBLINPHONE_LIBS)
AM_CFLAGS= $(LIBLINPHONE_CFLAGS) $(LIBSOUP_CFLAGS)
#include <linphone/linphonecore.h>
#include <linphone/lpconfig.h>
#include <libsoup/soup.h>
static bool_t buddy_lookup_init(void){
return TRUE;
}
typedef struct _BuddyLookupState{
SoupSession *session;
BuddyLookupStatus status;
SoupMessage *msg;
ortp_thread_t th;
MSList *results;
bool_t processing;
}BuddyLookupState;
#define get_buddy_lookup_state(ctx) ((BuddyLookupState*)((ctx)->data))
static void buddy_lookup_instance_init(SipSetupContext *ctx){
BuddyLookupState *s=ms_new0(BuddyLookupState,1);
s->session=soup_session_sync_new();
ctx->data=s;
}
static void buddy_lookup_instance_uninit(SipSetupContext *ctx){
BuddyLookupState *s=get_buddy_lookup_state(ctx);
g_object_unref(G_OBJECT(s->session));
ms_free(s);
}
static SoupMessage * build_xmlrpc_request(const char *identity, const char *password, const char *key, const char *domain, const char *url){
SoupMessage * msg;
msg=soup_xmlrpc_request_new(url,
"fp.searchUsers",
G_TYPE_STRING, identity,
G_TYPE_STRING, password ? password : "",
G_TYPE_STRING, key,
G_TYPE_INT , 100,
G_TYPE_INT , 0,
G_TYPE_STRING, domain,
G_TYPE_INVALID);
if (!msg){
ms_error("Fail to create SoupMessage !");
}else{
SoupBuffer *sb=soup_message_body_flatten(msg->request_body);
ms_message("This is the XML-RPC request we are going to send:\n%s\n",sb->data);
soup_buffer_free(sb);
}
return msg;
}
static void got_headers(SipSetupContext *ctx, SoupMessage*msg){
BuddyLookupState *s=get_buddy_lookup_state(ctx);
ms_message("Got headers !");
s->status=BuddyLookupConnected;
}
static void fill_item(GHashTable *ht , const char *name, char *dest, size_t dest_size){
GValue *v=(GValue*)g_hash_table_lookup(ht,(gconstpointer)name);
if (v) {
const char *tmp=g_value_get_string(v);
if (tmp){
strncpy(dest,tmp,dest_size-1);
}
}else ms_warning("no field named '%s'", name);
}
static void fill_buddy_info(BuddyInfo *bi, GHashTable *ht){
char tmp[128];
fill_item(ht,"first_name",bi->firstname,sizeof(bi->firstname));
fill_item(ht,"last_name",bi->lastname,sizeof(bi->lastname));
fill_item(ht,"display_name",bi->displayname,sizeof(bi->displayname));
fill_item(ht,"sip",tmp,sizeof(tmp));
if (strstr(tmp,"sip:")==0){
snprintf(bi->sip_uri,sizeof(bi->sip_uri)-1,"sip:%s",tmp);
}else{
strncpy(bi->sip_uri,tmp,sizeof(bi->sip_uri)-1);
}
fill_item(ht,"street",bi->address.street,sizeof(bi->address.street));
fill_item(ht,"zip",bi->address.zip,sizeof(bi->address.zip));
fill_item(ht,"city",bi->address.town,sizeof(bi->address.town));
fill_item(ht,"country",bi->address.country,sizeof(bi->address.country));
fill_item(ht,"email",bi->email,sizeof(bi->email));
}
static MSList * make_buddy_list(GValue *retval){
MSList *ret=NULL;
if (G_VALUE_TYPE(retval)==G_TYPE_VALUE_ARRAY){
GValueArray *array=(GValueArray*)g_value_get_boxed(retval);
GValue *gelem;
int i;
for(i=0;i<array->n_values;++i){
gelem=g_value_array_get_nth(array,i);
if (G_VALUE_TYPE(gelem)==G_TYPE_HASH_TABLE){
GHashTable *ht=(GHashTable*)g_value_get_boxed(gelem);
BuddyInfo *bi=ms_new0(BuddyInfo,1);
fill_buddy_info(bi,ht);
ret=ms_list_append(ret,bi);
}else{
ms_error("Element is not a hash table");
}
}
}else ms_error("Return value is not an array");
return ret;
}
static int xml_rpc_parse_response(SipSetupContext *ctx, SoupMessage *sm){
BuddyLookupState *s=get_buddy_lookup_state(ctx);
SoupBuffer *sb;
GValue retval;
GError *error=NULL;
sb=soup_message_body_flatten(sm->response_body);
ms_message("This the xml-rpc response:\n%s\n",sb->data);
if (soup_xmlrpc_parse_method_response(sb->data,sb->length,&retval,&error)==FALSE){
if (error!=NULL){
ms_error("xmlrpc fault: %s",error->message);
g_error_free(error);
}else{
ms_error("Could not parse xml-rpc response !");
}
s->status=BuddyLookupFailure;
}else{
ms_message("Extracting values from return type...");
s->results=make_buddy_list(&retval);
g_value_unset(&retval);
s->status=BuddyLookupDone;
}
soup_buffer_free(sb);
return s->status==BuddyLookupDone ? 0 : -1;
}
static void * process_xml_rpc_request(void *up){
SipSetupContext *ctx=(SipSetupContext*)up;
BuddyLookupState *s=get_buddy_lookup_state(ctx);
SoupMessage *sm=s->msg;
int code;
g_signal_connect_swapped(G_OBJECT(sm),"got-headers",(GCallback)got_headers,ctx);
s->status=BuddyLookupConnecting;
code=soup_session_send_message(s->session,sm);
if (code==200){
ms_message("Got a response from server, yeah !");
xml_rpc_parse_response(ctx,sm);
}else{
s->status=BuddyLookupFailure;
}
s->processing=FALSE;
return NULL;
}
static int lookup_buddy(SipSetupContext *ctx, const char *key){
BuddyLookupState *s=get_buddy_lookup_state(ctx);
LinphoneProxyConfig *cfg=sip_setup_context_get_proxy_config(ctx);
LinphoneCore *lc=linphone_proxy_config_get_core(cfg);
LpConfig *config=linphone_core_get_config(lc);
const char *identity=linphone_proxy_config_get_identity(cfg);
const char *url=lp_config_get_string(config,"BuddyLookup","url",NULL);
LinphoneAuthInfo *aa;
SoupMessage *sm;
if (url==NULL){
ms_error("No url defined for BuddyLookup in config file, aborting search.");
return -1;
}
if (s->th!=0){
if (s->processing){
ms_message("Canceling previous request...");
soup_session_cancel_message(s->session,s->msg, SOUP_STATUS_CANCELLED);
}
ortp_thread_join(s->th,NULL);
s->th=0;
g_object_unref(G_OBJECT(s->msg));
}
osip_from_t *from;
osip_from_init(&from);
if (osip_from_parse(from,identity)!=0){
osip_from_free(from);
ms_error("Could not parse identity %s",identity);
return -1;
}
aa=linphone_core_find_auth_info(lc,from->url->host,from->url->username);
if (aa) ms_message("There is a password: %s",aa->passwd);
else ms_message("No password for %s on %s",from->url->username,from->url->host);
sm=build_xmlrpc_request(identity, aa ? aa->passwd : NULL, key, from->url->host, url);
osip_from_free(from);
s->msg=sm;
s->processing=TRUE;
ortp_thread_create(&s->th,NULL,process_xml_rpc_request,ctx);
if (!sm) return -1;
return 0;
}
static BuddyLookupStatus get_buddy_lookup_status(SipSetupContext *ctx){
BuddyLookupState *s=get_buddy_lookup_state(ctx);
return s->status;
}
static int get_buddy_lookup_results(SipSetupContext *ctx, MSList **results){
BuddyLookupState *s=get_buddy_lookup_state(ctx);
if (s->results){
*results=s->results;
s->results=NULL;
}
return 0;
}
static void buddy_lookup_exit(void){
}
static SipSetup buddy_lookup_funcs={
.name="BuddyLookup",
.capabilities=SIP_SETUP_CAP_BUDDY_LOOKUP,
.init=buddy_lookup_init,
.init_instance=buddy_lookup_instance_init,
.lookup_buddy=lookup_buddy,
.get_buddy_lookup_status=get_buddy_lookup_status,
.get_buddy_lookup_results=get_buddy_lookup_results,
.uninit_instance=buddy_lookup_instance_uninit,
.exit=buddy_lookup_exit
};
void libbuddylookup_init(){
sip_setup_register(&buddy_lookup_funcs);
ms_message("Buddylookup plugin registered.");
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment