3 Copyright (C) 2000 Simon MORLAT (simon.morlat@linphone.org)
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Library General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 #include "linphonecore.h"
25 #include "mediastreamer2/mediastream.h"
31 void linphone_proxy_config_write_all_to_config_file(LinphoneCore *lc){
34 for(elem=lc->sip_conf.proxies,i=0;elem!=NULL;elem=ms_list_next(elem),i++){
35 LinphoneProxyConfig *cfg=(LinphoneProxyConfig*)elem->data;
36 linphone_proxy_config_write_to_config_file(lc->config,cfg,i);
40 void linphone_proxy_config_init(LinphoneProxyConfig *obj){
41 memset(obj,0,sizeof(LinphoneProxyConfig));
51 * Creates an empty proxy config.
53 LinphoneProxyConfig *linphone_proxy_config_new(){
54 LinphoneProxyConfig *obj=NULL;
55 obj=ms_new(LinphoneProxyConfig,1);
56 linphone_proxy_config_init(obj);
61 * Destroys a proxy config.
63 * @note: LinphoneProxyConfig that have been removed from LinphoneCore with
64 * linphone_core_remove_proxy_config() must not be freed.
66 void linphone_proxy_config_destroy(LinphoneProxyConfig *obj){
67 if (obj->reg_proxy!=NULL) ms_free(obj->reg_proxy);
68 if (obj->reg_identity!=NULL) ms_free(obj->reg_identity);
69 if (obj->reg_route!=NULL) ms_free(obj->reg_route);
70 if (obj->ssctx!=NULL) sip_setup_context_free(obj->ssctx);
71 if (obj->realm!=NULL) ms_free(obj->realm);
72 if (obj->type!=NULL) ms_free(obj->type);
73 if (obj->dial_prefix!=NULL) ms_free(obj->dial_prefix);
74 if (obj->op) sal_op_release(obj->op);
78 * Returns a boolean indicating that the user is sucessfully registered on the proxy.
80 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj){
81 return obj->registered;
85 * Sets the proxy address
87 * Examples of valid sip proxy address are:
88 * - IP address: sip:87.98.157.38
89 * - IP address with port: sip:87.98.157.38:5062
90 * - hostnames : sip:sip.example.net
92 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr){
93 LinphoneAddress *addr;
96 if (obj->reg_proxy!=NULL) ms_free(obj->reg_proxy);
99 if (server_addr!=NULL && strlen(server_addr)>0){
100 addr=linphone_address_new(server_addr);
102 /*try to prepend 'sip:' */
103 if (strstr(server_addr,"sip:")==NULL){
104 try=ms_strdup_printf("sip:%s",server_addr);
105 addr=linphone_address_new(try);
110 obj->reg_proxy=linphone_address_as_string_uri_only(addr);
111 linphone_address_destroy(addr);
113 ms_warning("Could not parse %s",server_addr);
121 * Sets the user identity as a SIP address.
123 * This identity is normally formed with display name, username and domain, such
125 * Alice <sip:alice@example.net>
126 * The REGISTER messages will have from and to set to this identity.
129 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity){
130 LinphoneAddress *addr;
131 if (identity!=NULL && strlen(identity)>0){
132 addr=linphone_address_new(identity);
133 if (!addr || linphone_address_get_username(addr)==NULL){
134 ms_warning("Invalid sip identity: %s",identity);
136 linphone_address_destroy(addr);
139 if (obj->reg_identity!=NULL) {
140 ms_free(obj->reg_identity);
141 obj->reg_identity=NULL;
143 obj->reg_identity=ms_strdup(identity);
147 obj->realm=ms_strdup(linphone_address_get_domain(addr));
148 linphone_address_destroy(addr);
155 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg){
161 * When a route is set, all outgoing calls will go to the route's destination if this proxy
162 * is the default one (see linphone_core_set_default_proxy() ).
164 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route)
166 if (obj->reg_route!=NULL){
167 ms_free(obj->reg_route);
170 obj->reg_route=ms_strdup(route);
174 bool_t linphone_proxy_config_check(LinphoneCore *lc, LinphoneProxyConfig *obj){
175 if (obj->reg_proxy==NULL){
176 if (lc->vtable.display_warning)
177 lc->vtable.display_warning(lc,_("The sip proxy address you entered is invalid, it must start with \"sip:\""
178 " followed by a hostname."));
181 if (obj->reg_identity==NULL){
182 if (lc->vtable.display_warning)
183 lc->vtable.display_warning(lc,_("The sip identity you entered is invalid.\nIt should look like "
184 "sip:username@proxydomain, such as sip:alice@example.net"));
191 * Indicates whether a REGISTER request must be sent to the proxy.
193 void linphone_proxy_config_enableregister(LinphoneProxyConfig *obj, bool_t val){
194 obj->reg_sendregister=val;
198 * Sets the registration expiration time in seconds.
200 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int val){
205 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val){
210 * Starts editing a proxy configuration.
212 * Because proxy configuration must be consistent, applications MUST
213 * call linphone_proxy_config_edit() before doing any attempts to modify
214 * proxy configuration (such as identity, proxy address and so on).
215 * Once the modifications are done, then the application must call
216 * linphone_proxy_config_done() to commit the changes.
218 void linphone_proxy_config_edit(LinphoneProxyConfig *obj){
219 if (obj->reg_sendregister){
221 if (obj->registered) {
222 sal_unregister(obj->op);
223 obj->registered=FALSE;
228 void linphone_proxy_config_apply(LinphoneProxyConfig *obj,LinphoneCore *lc)
231 linphone_proxy_config_done(obj);
234 static char *guess_contact_for_register(LinphoneProxyConfig *obj){
235 LinphoneAddress *proxy=linphone_address_new(obj->reg_proxy);
238 if (proxy==NULL) return NULL;
239 host=linphone_address_get_domain (proxy);
241 LinphoneAddress *contact;
242 char localip[LINPHONE_IPADDR_SIZE];
244 linphone_core_get_local_ip(obj->lc,host,localip);
245 contact=linphone_address_new(obj->reg_identity);
246 linphone_address_set_domain (contact,localip);
247 linphone_address_set_port_int(contact,linphone_core_get_sip_port(obj->lc));
248 linphone_address_set_display_name(contact,NULL);
250 linphone_core_get_sip_transports(obj->lc,&tr);
251 if (tr.udp_port <= 0 && tr.tcp_port>0) {
252 sal_address_add_param(contact,"transport","tcp");
254 ret=linphone_address_as_string(contact);
255 linphone_address_destroy(contact);
257 linphone_address_destroy (proxy);
261 static void linphone_proxy_config_register(LinphoneProxyConfig *obj){
263 if (obj->reg_identity!=NULL) id_str=obj->reg_identity;
264 else id_str=linphone_core_get_primary_contact(obj->lc);
265 if (obj->reg_sendregister){
268 sal_op_release(obj->op);
269 obj->op=sal_op_new(obj->lc->sal);
270 contact=guess_contact_for_register(obj);
271 sal_op_set_contact(obj->op,contact);
273 sal_op_set_user_pointer(obj->op,obj);
274 if (!sal_register(obj->op,obj->reg_proxy,obj->reg_identity,obj->expires)) {
275 gstate_new_state(obj->lc,GSTATE_REG_PENDING,NULL);
277 gstate_new_state(obj->lc,GSTATE_REG_FAILED,NULL);
284 * Sets a dialing prefix to be automatically prepended when inviting a number with
285 * #linphone_core_invite.
288 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix){
289 if (cfg->dial_prefix!=NULL){
290 ms_free(cfg->dial_prefix);
291 cfg->dial_prefix=NULL;
293 if (prefix && prefix[0]!='\0') cfg->dial_prefix=ms_strdup(prefix);
297 * Returns dialing prefix.
301 const char *linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg){
302 return cfg->dial_prefix;
306 * Sets whether liblinphone should replace "+" by "00" in dialed numbers (passed to
307 * #linphone_core_invite ).
310 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val){
311 cfg->dial_escape_plus=val;
315 * Returns whether liblinphone should replace "+" by "00" in dialed numbers (passed to
316 * #linphone_core_invite ).
319 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg){
320 return cfg->dial_escape_plus;
324 static bool_t is_a_phone_number(const char *username){
326 for(p=username;*p!='\0';++p){
339 static char *flatten_number(const char *number){
340 char *result=ms_malloc0(strlen(number)+1);
343 for(r=number;*r!='\0';++r){
344 if (*r=='+' || isdigit(*r)){
352 static void copy_result(const char *src, char *dest, size_t destlen, bool_t escape_plus){
355 if (escape_plus && src[0]=='+' && destlen>2){
362 for(;(i<destlen-1) && *src!='\0';++i){
370 static char *append_prefix(const char *number, const char *prefix){
371 char *res=ms_malloc(strlen(number)+strlen(prefix)+1);
373 return strcat(res,number);
376 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len){
379 if (is_a_phone_number(username)){
380 flatten=flatten_number(username);
381 ms_message("Flattened number is '%s'",flatten);
382 numlen=strlen(flatten);
383 if (numlen>10 || flatten[0]=='+' || proxy->dial_prefix==NULL || proxy->dial_prefix[0]=='\0'){
384 ms_message("No need to add a prefix");
385 /* prefix is already there */
386 copy_result(flatten,result,result_len,proxy->dial_escape_plus);
389 }else if (proxy->dial_prefix && proxy->dial_prefix[0]!='\0'){
392 ms_message("Need to prefix with %s",proxy->dial_prefix);
394 /*remove initial number before prepending prefix*/
397 prefixed=append_prefix(flatten+skipped,proxy->dial_prefix);
399 copy_result(prefixed,result,result_len,proxy->dial_escape_plus);
402 }else strncpy(result,username,result_len);
407 * Commits modification made to the proxy configuration.
409 int linphone_proxy_config_done(LinphoneProxyConfig *obj)
411 if (!linphone_proxy_config_check(obj->lc,obj)) return -1;
413 linphone_proxy_config_write_all_to_config_file(obj->lc);
417 void linphone_proxy_config_set_realm(LinphoneProxyConfig *cfg, const char *realm)
419 if (cfg->realm!=NULL) {
423 if (realm!=NULL) cfg->realm=ms_strdup(realm);
426 int linphone_proxy_config_send_publish(LinphoneProxyConfig *proxy,
427 LinphoneOnlineStatus presence_mode){
429 SalOp *op=sal_op_new(proxy->lc->sal);
430 err=sal_publish(op,linphone_proxy_config_get_identity(proxy),
431 linphone_proxy_config_get_identity(proxy),linphone_online_status_to_sal(presence_mode));
437 * Returns the route set for this proxy configuration.
439 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj){
440 return obj->reg_route;
444 * Returns the SIP identity that belongs to this proxy configuration.
446 * The SIP identity is a SIP address (Display Name <sip:username@domain> )
448 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj){
449 return obj->reg_identity;
453 * Returns TRUE if PUBLISH request is enabled for this proxy.
455 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj){
460 * Returns the proxy's SIP address.
462 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj){
463 return obj->reg_proxy;
467 * Returns the duration of registration.
469 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj){
474 * Returns TRUE if registration to the proxy is enabled.
476 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj){
477 return obj->reg_sendregister;
480 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj){
485 * Add a proxy configuration.
486 * This will start registration on the proxy, if registration is enabled.
488 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *cfg){
489 if (!linphone_proxy_config_check(lc,cfg)) return -1;
490 if (ms_list_find(lc->sip_conf.proxies,cfg)!=NULL){
491 ms_warning("ProxyConfig already entered, ignored.");
494 lc->sip_conf.proxies=ms_list_append(lc->sip_conf.proxies,(void *)cfg);
495 linphone_proxy_config_apply(cfg,lc);
500 * Removes a proxy configuration.
502 * LinphoneCore will then automatically unregister and place the proxy configuration
503 * on a deleted list. For that reason, a removed proxy does NOT need to be freed.
505 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *cfg){
506 lc->sip_conf.proxies=ms_list_remove(lc->sip_conf.proxies,(void *)cfg);
507 /* add to the list of destroyed proxies, so that the possible unREGISTER request can succeed authentication */
508 lc->sip_conf.deleted_proxies=ms_list_append(lc->sip_conf.deleted_proxies,(void *)cfg);
509 cfg->deletion_date=ms_time(NULL);
510 /* this will unREGISTER */
511 linphone_proxy_config_edit(cfg);
512 if (lc->default_proxy==cfg){
513 lc->default_proxy=NULL;
517 * Erase all proxies from config.
521 void linphone_core_clear_proxy_config(LinphoneCore *lc){
522 MSList* list=ms_list_copy(linphone_core_get_proxy_config_list((const LinphoneCore*)lc));
523 for(;list!=NULL;list=list->next){
524 linphone_core_remove_proxy_config(lc,(LinphoneProxyConfig *)list->data);
529 * Sets the default proxy.
531 * This default proxy must be part of the list of already entered LinphoneProxyConfig.
532 * Toggling it as default will make LinphoneCore use the identity associated with
533 * the proxy configuration in all incoming and outgoing calls.
535 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config){
536 /* check if this proxy is in our list */
538 if (ms_list_find(lc->sip_conf.proxies,config)==NULL){
539 ms_warning("Bad proxy address: it is not in the list !");
540 lc->default_proxy=NULL;
544 lc->default_proxy=config;
548 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index){
549 if (index<0) linphone_core_set_default_proxy(lc,NULL);
550 else linphone_core_set_default_proxy(lc,ms_list_nth_data(lc->sip_conf.proxies,index));
554 * Returns the default proxy configuration, that is the one used to determine the current identity.
556 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config){
558 if (config!=NULL) *config=lc->default_proxy;
559 if (lc->default_proxy!=NULL){
560 pos=ms_list_position(lc->sip_conf.proxies,ms_list_find(lc->sip_conf.proxies,(void *)lc->default_proxy));
566 * Returns an unmodifiable list of entered proxy configurations.
568 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc){
569 return lc->sip_conf.proxies;
572 void linphone_proxy_config_write_to_config_file(LpConfig *config, LinphoneProxyConfig *obj, int index)
576 sprintf(key,"proxy_%i",index);
577 lp_config_clean_section(config,key);
581 if (obj->type!=NULL){
582 lp_config_set_string(config,key,"type",obj->type);
584 if (obj->reg_proxy!=NULL){
585 lp_config_set_string(config,key,"reg_proxy",obj->reg_proxy);
587 if (obj->reg_route!=NULL){
588 lp_config_set_string(config,key,"reg_route",obj->reg_route);
590 if (obj->reg_identity!=NULL){
591 lp_config_set_string(config,key,"reg_identity",obj->reg_identity);
593 lp_config_set_int(config,key,"reg_expires",obj->expires);
594 lp_config_set_int(config,key,"reg_sendregister",obj->reg_sendregister);
595 lp_config_set_int(config,key,"publish",obj->publish);
596 lp_config_set_int(config,key,"dial_escape_plus",obj->dial_escape_plus);
597 lp_config_set_string(config,key,"dial_prefix",obj->dial_prefix);
602 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(LpConfig *config, int index)
605 const char *identity;
607 LinphoneProxyConfig *cfg;
610 sprintf(key,"proxy_%i",index);
612 if (!lp_config_has_section(config,key)){
616 cfg=linphone_proxy_config_new();
618 identity=lp_config_get_string(config,key,"reg_identity",NULL);
619 proxy=lp_config_get_string(config,key,"reg_proxy",NULL);
621 linphone_proxy_config_set_identity(cfg,identity);
622 linphone_proxy_config_set_server_addr(cfg,proxy);
624 tmp=lp_config_get_string(config,key,"reg_route",NULL);
625 if (tmp!=NULL) linphone_proxy_config_set_route(cfg,tmp);
627 linphone_proxy_config_expires(cfg,lp_config_get_int(config,key,"reg_expires",600));
628 linphone_proxy_config_enableregister(cfg,lp_config_get_int(config,key,"reg_sendregister",0));
630 linphone_proxy_config_enable_publish(cfg,lp_config_get_int(config,key,"publish",0));
632 linphone_proxy_config_set_dial_escape_plus(cfg,lp_config_get_int(config,key,"dial_escape_plus",0));
633 linphone_proxy_config_set_dial_prefix(cfg,lp_config_get_string(config,key,"dial_prefix",NULL));
635 tmp=lp_config_get_string(config,key,"type",NULL);
636 if (tmp!=NULL && strlen(tmp)>0)
637 linphone_proxy_config_set_sip_setup(cfg,tmp);
642 static void linphone_proxy_config_activate_sip_setup(LinphoneProxyConfig *cfg){
643 SipSetupContext *ssc;
644 SipSetup *ss=sip_setup_lookup(cfg->type);
645 LinphoneCore *lc=linphone_proxy_config_get_core(cfg);
648 ssc=sip_setup_context_new(ss,cfg);
650 if (cfg->reg_identity==NULL){
651 ms_error("Invalid identity for this proxy configuration.");
654 caps=sip_setup_context_get_capabilities(ssc);
655 if (caps & SIP_SETUP_CAP_ACCOUNT_MANAGER){
656 if (sip_setup_context_login_account(ssc,cfg->reg_identity,NULL)!=0){
657 if (lc->vtable.display_warning){
658 char *tmp=ms_strdup_printf(_("Could not login as %s"),cfg->reg_identity);
659 lc->vtable.display_warning(lc,tmp);
665 if (caps & SIP_SETUP_CAP_PROXY_PROVIDER){
667 if (sip_setup_context_get_proxy(ssc,NULL,proxy,sizeof(proxy))==0){
668 linphone_proxy_config_set_server_addr(cfg,proxy);
670 ms_error("Could not retrieve proxy uri !");
676 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg){
677 if (cfg->ssctx!=NULL) return cfg->ssctx->funcs;
678 if (cfg->type!=NULL){
679 return sip_setup_lookup(cfg->type);
684 void linphone_proxy_config_update(LinphoneProxyConfig *cfg){
685 LinphoneCore *lc=cfg->lc;
687 if (cfg->type && cfg->ssctx==NULL){
688 linphone_proxy_config_activate_sip_setup(cfg);
690 if (lc->sip_conf.register_only_when_network_is_up || lc->network_reachable)
691 linphone_proxy_config_register(cfg);
696 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type){
699 cfg->type=ms_strdup(type);
700 if (linphone_proxy_config_get_addr(cfg)==NULL){
701 /*put a placeholder so that the sip setup gets saved into the config */
702 linphone_proxy_config_set_server_addr(cfg,"sip:undefined");
706 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg){
714 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type){
715 LinphoneAccountCreator *obj;
716 LinphoneProxyConfig *cfg;
717 SipSetup *ss=sip_setup_lookup(type);
718 SipSetupContext *ssctx;
722 if (!(sip_setup_get_capabilities(ss) & SIP_SETUP_CAP_ACCOUNT_MANAGER)){
723 ms_error("%s cannot manage accounts.");
726 obj=ms_new0(LinphoneAccountCreator,1);
727 cfg=linphone_proxy_config_new();
728 ssctx=sip_setup_context_new(ss,cfg);
731 set_string(&obj->domain,sip_setup_context_get_domains(ssctx)[0]);
736 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username){
737 set_string(&obj->username,username);
740 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password){
741 set_string(&obj->password,password);
744 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain){
745 set_string(&obj->domain,domain);
748 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj){
749 return obj->username;
752 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj){
756 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj){
757 SipSetupContext *ssctx=obj->ssctx;
758 char *uri=ms_strdup_printf("%s@%s",obj->username,obj->domain);
759 int err=sip_setup_context_account_exists(ssctx,uri);
764 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj){
765 SipSetupContext *ssctx=obj->ssctx;
766 char *uri=ms_strdup_printf("%s@%s",obj->username,obj->domain);
767 int err=sip_setup_context_create_account(ssctx,uri,obj->password);
771 return sip_setup_context_get_proxy_config(ssctx);
776 void linphone_account_creator_destroy(LinphoneAccountCreator *obj){
778 ms_free(obj->username);
780 ms_free(obj->password);
782 ms_free(obj->domain);
783 if (!obj->succeeded){
784 linphone_proxy_config_destroy(sip_setup_context_get_proxy_config(obj->ssctx));
788 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud) {
792 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr) {
793 return cr->user_data;