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=NULL;
96 if (obj->reg_proxy!=NULL) ms_free(obj->reg_proxy);
99 if (server_addr!=NULL && strlen(server_addr)>0){
100 if (strstr(server_addr,"sip:")==NULL){
101 modified=ms_strdup_printf("sip:%s",server_addr);
102 addr=linphone_address_new(modified);
106 addr=linphone_address_new(server_addr);
108 obj->reg_proxy=linphone_address_as_string_uri_only(addr);
109 linphone_address_destroy(addr);
111 ms_warning("Could not parse %s",server_addr);
119 * Sets the user identity as a SIP address.
121 * This identity is normally formed with display name, username and domain, such
123 * Alice <sip:alice@example.net>
124 * The REGISTER messages will have from and to set to this identity.
127 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity){
128 LinphoneAddress *addr;
129 if (identity!=NULL && strlen(identity)>0){
130 addr=linphone_address_new(identity);
131 if (!addr || linphone_address_get_username(addr)==NULL){
132 ms_warning("Invalid sip identity: %s",identity);
134 linphone_address_destroy(addr);
137 if (obj->reg_identity!=NULL) {
138 ms_free(obj->reg_identity);
139 obj->reg_identity=NULL;
141 obj->reg_identity=ms_strdup(identity);
145 obj->realm=ms_strdup(linphone_address_get_domain(addr));
146 linphone_address_destroy(addr);
153 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg){
159 * When a route is set, all outgoing calls will go to the route's destination if this proxy
160 * is the default one (see linphone_core_set_default_proxy() ).
162 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route)
164 if (obj->reg_route!=NULL){
165 ms_free(obj->reg_route);
169 /*try to prepend 'sip:' */
170 if (strstr(route,"sip:")==NULL){
171 obj->reg_route=ms_strdup_printf("sip:%s",route);
172 }else obj->reg_route=ms_strdup(route);
177 bool_t linphone_proxy_config_check(LinphoneCore *lc, LinphoneProxyConfig *obj){
178 if (obj->reg_proxy==NULL){
179 if (lc->vtable.display_warning)
180 lc->vtable.display_warning(lc,_("The sip proxy address you entered is invalid, it must start with \"sip:\""
181 " followed by a hostname."));
184 if (obj->reg_identity==NULL){
185 if (lc->vtable.display_warning)
186 lc->vtable.display_warning(lc,_("The sip identity you entered is invalid.\nIt should look like "
187 "sip:username@proxydomain, such as sip:alice@example.net"));
194 * Indicates whether a REGISTER request must be sent to the proxy.
196 void linphone_proxy_config_enableregister(LinphoneProxyConfig *obj, bool_t val){
197 obj->reg_sendregister=val;
201 * Sets the registration expiration time in seconds.
203 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int val){
208 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val){
213 * Starts editing a proxy configuration.
215 * Because proxy configuration must be consistent, applications MUST
216 * call linphone_proxy_config_edit() before doing any attempts to modify
217 * proxy configuration (such as identity, proxy address and so on).
218 * Once the modifications are done, then the application must call
219 * linphone_proxy_config_done() to commit the changes.
221 void linphone_proxy_config_edit(LinphoneProxyConfig *obj){
222 if (obj->reg_sendregister){
224 if (obj->registered) {
225 sal_unregister(obj->op);
226 obj->registered=FALSE;
231 void linphone_proxy_config_apply(LinphoneProxyConfig *obj,LinphoneCore *lc)
234 linphone_proxy_config_done(obj);
237 static char *guess_contact_for_register(LinphoneProxyConfig *obj){
238 LinphoneAddress *proxy=linphone_address_new(obj->reg_proxy);
241 if (proxy==NULL) return NULL;
242 host=linphone_address_get_domain (proxy);
244 LinphoneAddress *contact;
245 char localip[LINPHONE_IPADDR_SIZE];
247 linphone_core_get_local_ip(obj->lc,host,localip);
248 contact=linphone_address_new(obj->reg_identity);
249 linphone_address_set_domain (contact,localip);
250 linphone_address_set_port_int(contact,linphone_core_get_sip_port(obj->lc));
251 linphone_address_set_display_name(contact,NULL);
253 linphone_core_get_sip_transports(obj->lc,&tr);
254 if (tr.udp_port <= 0 && tr.tcp_port>0) {
255 sal_address_add_param(contact,"transport","tcp");
257 ret=linphone_address_as_string(contact);
258 linphone_address_destroy(contact);
260 linphone_address_destroy (proxy);
264 static void linphone_proxy_config_register(LinphoneProxyConfig *obj){
267 if (obj->reg_identity!=NULL) id_str=obj->reg_identity;
268 else id_str=linphone_core_get_primary_contact(obj->lc);
269 if (obj->reg_sendregister){
272 sal_op_release(obj->op);
273 obj->op=sal_op_new(obj->lc->sal);
274 contact=guess_contact_for_register(obj);
275 sal_op_set_contact(obj->op,contact);
277 sal_op_set_user_pointer(obj->op,obj);
278 if (sal_register(obj->op,obj->reg_proxy,obj->reg_identity,obj->expires)==0) {
279 linphone_proxy_config_set_state(obj,LinphoneRegistrationProgress,"Registration in progress");
281 linphone_proxy_config_set_state(obj,LinphoneRegistrationFailed,"Registration failed");
288 * Sets a dialing prefix to be automatically prepended when inviting a number with
289 * #linphone_core_invite.
292 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix){
293 if (cfg->dial_prefix!=NULL){
294 ms_free(cfg->dial_prefix);
295 cfg->dial_prefix=NULL;
297 if (prefix && prefix[0]!='\0') cfg->dial_prefix=ms_strdup(prefix);
301 * Returns dialing prefix.
305 const char *linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg){
306 return cfg->dial_prefix;
310 * Sets whether liblinphone should replace "+" by "00" in dialed numbers (passed to
311 * #linphone_core_invite ).
314 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val){
315 cfg->dial_escape_plus=val;
319 * Returns whether liblinphone should replace "+" by "00" in dialed numbers (passed to
320 * #linphone_core_invite ).
323 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg){
324 return cfg->dial_escape_plus;
328 static bool_t is_a_phone_number(const char *username){
330 for(p=username;*p!='\0';++p){
343 static char *flatten_number(const char *number){
344 char *result=ms_malloc0(strlen(number)+1);
347 for(r=number;*r!='\0';++r){
348 if (*r=='+' || isdigit(*r)){
356 static void copy_result(const char *src, char *dest, size_t destlen, bool_t escape_plus){
359 if (escape_plus && src[0]=='+' && destlen>2){
366 for(;(i<destlen-1) && *src!='\0';++i){
374 static char *append_prefix(const char *number, const char *prefix){
375 char *res=ms_malloc(strlen(number)+strlen(prefix)+1);
377 return strcat(res,number);
380 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len){
383 if (is_a_phone_number(username)){
384 flatten=flatten_number(username);
385 ms_message("Flattened number is '%s'",flatten);
386 numlen=strlen(flatten);
387 if (numlen>10 || flatten[0]=='+' || proxy->dial_prefix==NULL || proxy->dial_prefix[0]=='\0'){
388 ms_message("No need to add a prefix");
389 /* prefix is already there */
390 copy_result(flatten,result,result_len,proxy->dial_escape_plus);
393 }else if (proxy->dial_prefix && proxy->dial_prefix[0]!='\0'){
396 ms_message("Need to prefix with %s",proxy->dial_prefix);
398 /*remove initial number before prepending prefix*/
401 prefixed=append_prefix(flatten+skipped,proxy->dial_prefix);
403 copy_result(prefixed,result,result_len,proxy->dial_escape_plus);
406 }else strncpy(result,username,result_len);
411 * Commits modification made to the proxy configuration.
413 int linphone_proxy_config_done(LinphoneProxyConfig *obj)
415 if (!linphone_proxy_config_check(obj->lc,obj)) return -1;
417 linphone_proxy_config_write_all_to_config_file(obj->lc);
421 void linphone_proxy_config_set_realm(LinphoneProxyConfig *cfg, const char *realm)
423 if (cfg->realm!=NULL) {
427 if (realm!=NULL) cfg->realm=ms_strdup(realm);
430 int linphone_proxy_config_send_publish(LinphoneProxyConfig *proxy,
431 LinphoneOnlineStatus presence_mode){
433 SalOp *op=sal_op_new(proxy->lc->sal);
434 err=sal_publish(op,linphone_proxy_config_get_identity(proxy),
435 linphone_proxy_config_get_identity(proxy),linphone_online_status_to_sal(presence_mode));
441 * Returns the route set for this proxy configuration.
443 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj){
444 return obj->reg_route;
448 * Returns the SIP identity that belongs to this proxy configuration.
450 * The SIP identity is a SIP address (Display Name <sip:username@domain> )
452 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj){
453 return obj->reg_identity;
457 * Returns TRUE if PUBLISH request is enabled for this proxy.
459 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj){
464 * Returns the proxy's SIP address.
466 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj){
467 return obj->reg_proxy;
471 * Returns the duration of registration.
473 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj){
478 * Returns TRUE if registration to the proxy is enabled.
480 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj){
481 return obj->reg_sendregister;
484 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj){
489 * Add a proxy configuration.
490 * This will start registration on the proxy, if registration is enabled.
492 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *cfg){
493 if (!linphone_proxy_config_check(lc,cfg)) return -1;
494 if (ms_list_find(lc->sip_conf.proxies,cfg)!=NULL){
495 ms_warning("ProxyConfig already entered, ignored.");
498 lc->sip_conf.proxies=ms_list_append(lc->sip_conf.proxies,(void *)cfg);
499 linphone_proxy_config_apply(cfg,lc);
504 * Removes a proxy configuration.
506 * LinphoneCore will then automatically unregister and place the proxy configuration
507 * on a deleted list. For that reason, a removed proxy does NOT need to be freed.
509 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *cfg){
510 lc->sip_conf.proxies=ms_list_remove(lc->sip_conf.proxies,(void *)cfg);
511 /* add to the list of destroyed proxies, so that the possible unREGISTER request can succeed authentication */
512 lc->sip_conf.deleted_proxies=ms_list_append(lc->sip_conf.deleted_proxies,(void *)cfg);
513 cfg->deletion_date=ms_time(NULL);
514 /* this will unREGISTER */
515 linphone_proxy_config_edit(cfg);
516 if (lc->default_proxy==cfg){
517 lc->default_proxy=NULL;
521 * Erase all proxies from config.
525 void linphone_core_clear_proxy_config(LinphoneCore *lc){
526 MSList* list=ms_list_copy(linphone_core_get_proxy_config_list((const LinphoneCore*)lc));
527 for(;list!=NULL;list=list->next){
528 linphone_core_remove_proxy_config(lc,(LinphoneProxyConfig *)list->data);
533 * Sets the default proxy.
535 * This default proxy must be part of the list of already entered LinphoneProxyConfig.
536 * Toggling it as default will make LinphoneCore use the identity associated with
537 * the proxy configuration in all incoming and outgoing calls.
539 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config){
540 /* check if this proxy is in our list */
542 if (ms_list_find(lc->sip_conf.proxies,config)==NULL){
543 ms_warning("Bad proxy address: it is not in the list !");
544 lc->default_proxy=NULL;
548 lc->default_proxy=config;
552 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index){
553 if (index<0) linphone_core_set_default_proxy(lc,NULL);
554 else linphone_core_set_default_proxy(lc,ms_list_nth_data(lc->sip_conf.proxies,index));
558 * Returns the default proxy configuration, that is the one used to determine the current identity.
560 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config){
562 if (config!=NULL) *config=lc->default_proxy;
563 if (lc->default_proxy!=NULL){
564 pos=ms_list_position(lc->sip_conf.proxies,ms_list_find(lc->sip_conf.proxies,(void *)lc->default_proxy));
570 * Returns an unmodifiable list of entered proxy configurations.
572 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc){
573 return lc->sip_conf.proxies;
576 void linphone_proxy_config_write_to_config_file(LpConfig *config, LinphoneProxyConfig *obj, int index)
580 sprintf(key,"proxy_%i",index);
581 lp_config_clean_section(config,key);
585 if (obj->type!=NULL){
586 lp_config_set_string(config,key,"type",obj->type);
588 if (obj->reg_proxy!=NULL){
589 lp_config_set_string(config,key,"reg_proxy",obj->reg_proxy);
591 if (obj->reg_route!=NULL){
592 lp_config_set_string(config,key,"reg_route",obj->reg_route);
594 if (obj->reg_identity!=NULL){
595 lp_config_set_string(config,key,"reg_identity",obj->reg_identity);
597 lp_config_set_int(config,key,"reg_expires",obj->expires);
598 lp_config_set_int(config,key,"reg_sendregister",obj->reg_sendregister);
599 lp_config_set_int(config,key,"publish",obj->publish);
600 lp_config_set_int(config,key,"dial_escape_plus",obj->dial_escape_plus);
601 lp_config_set_string(config,key,"dial_prefix",obj->dial_prefix);
606 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(LpConfig *config, int index)
609 const char *identity;
611 LinphoneProxyConfig *cfg;
614 sprintf(key,"proxy_%i",index);
616 if (!lp_config_has_section(config,key)){
620 cfg=linphone_proxy_config_new();
622 identity=lp_config_get_string(config,key,"reg_identity",NULL);
623 proxy=lp_config_get_string(config,key,"reg_proxy",NULL);
625 linphone_proxy_config_set_identity(cfg,identity);
626 linphone_proxy_config_set_server_addr(cfg,proxy);
628 tmp=lp_config_get_string(config,key,"reg_route",NULL);
629 if (tmp!=NULL) linphone_proxy_config_set_route(cfg,tmp);
631 linphone_proxy_config_expires(cfg,lp_config_get_int(config,key,"reg_expires",600));
632 linphone_proxy_config_enableregister(cfg,lp_config_get_int(config,key,"reg_sendregister",0));
634 linphone_proxy_config_enable_publish(cfg,lp_config_get_int(config,key,"publish",0));
636 linphone_proxy_config_set_dial_escape_plus(cfg,lp_config_get_int(config,key,"dial_escape_plus",0));
637 linphone_proxy_config_set_dial_prefix(cfg,lp_config_get_string(config,key,"dial_prefix",NULL));
639 tmp=lp_config_get_string(config,key,"type",NULL);
640 if (tmp!=NULL && strlen(tmp)>0)
641 linphone_proxy_config_set_sip_setup(cfg,tmp);
646 static void linphone_proxy_config_activate_sip_setup(LinphoneProxyConfig *cfg){
647 SipSetupContext *ssc;
648 SipSetup *ss=sip_setup_lookup(cfg->type);
649 LinphoneCore *lc=linphone_proxy_config_get_core(cfg);
652 ssc=sip_setup_context_new(ss,cfg);
654 if (cfg->reg_identity==NULL){
655 ms_error("Invalid identity for this proxy configuration.");
658 caps=sip_setup_context_get_capabilities(ssc);
659 if (caps & SIP_SETUP_CAP_ACCOUNT_MANAGER){
660 if (sip_setup_context_login_account(ssc,cfg->reg_identity,NULL)!=0){
661 if (lc->vtable.display_warning){
662 char *tmp=ms_strdup_printf(_("Could not login as %s"),cfg->reg_identity);
663 lc->vtable.display_warning(lc,tmp);
669 if (caps & SIP_SETUP_CAP_PROXY_PROVIDER){
671 if (sip_setup_context_get_proxy(ssc,NULL,proxy,sizeof(proxy))==0){
672 linphone_proxy_config_set_server_addr(cfg,proxy);
674 ms_error("Could not retrieve proxy uri !");
680 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg){
681 if (cfg->ssctx!=NULL) return cfg->ssctx->funcs;
682 if (cfg->type!=NULL){
683 return sip_setup_lookup(cfg->type);
688 void linphone_proxy_config_update(LinphoneProxyConfig *cfg){
689 LinphoneCore *lc=cfg->lc;
691 if (cfg->type && cfg->ssctx==NULL){
692 linphone_proxy_config_activate_sip_setup(cfg);
694 if (lc->sip_conf.register_only_when_network_is_up || lc->network_reachable)
695 linphone_proxy_config_register(cfg);
700 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type){
703 cfg->type=ms_strdup(type);
704 if (linphone_proxy_config_get_addr(cfg)==NULL){
705 /*put a placeholder so that the sip setup gets saved into the config */
706 linphone_proxy_config_set_server_addr(cfg,"sip:undefined");
710 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg){
718 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type){
719 LinphoneAccountCreator *obj;
720 LinphoneProxyConfig *cfg;
721 SipSetup *ss=sip_setup_lookup(type);
722 SipSetupContext *ssctx;
726 if (!(sip_setup_get_capabilities(ss) & SIP_SETUP_CAP_ACCOUNT_MANAGER)){
727 ms_error("%s cannot manage accounts.");
730 obj=ms_new0(LinphoneAccountCreator,1);
731 cfg=linphone_proxy_config_new();
732 ssctx=sip_setup_context_new(ss,cfg);
735 set_string(&obj->domain,sip_setup_context_get_domains(ssctx)[0]);
740 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username){
741 set_string(&obj->username,username);
744 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password){
745 set_string(&obj->password,password);
748 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain){
749 set_string(&obj->domain,domain);
752 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj){
753 return obj->username;
756 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj){
760 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj){
761 SipSetupContext *ssctx=obj->ssctx;
762 char *uri=ms_strdup_printf("%s@%s",obj->username,obj->domain);
763 int err=sip_setup_context_account_exists(ssctx,uri);
768 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj){
769 SipSetupContext *ssctx=obj->ssctx;
770 char *uri=ms_strdup_printf("%s@%s",obj->username,obj->domain);
771 int err=sip_setup_context_create_account(ssctx,uri,obj->password);
775 return sip_setup_context_get_proxy_config(ssctx);
780 void linphone_account_creator_destroy(LinphoneAccountCreator *obj){
782 ms_free(obj->username);
784 ms_free(obj->password);
786 ms_free(obj->domain);
787 if (!obj->succeeded){
788 linphone_proxy_config_destroy(sip_setup_context_get_proxy_config(obj->ssctx));
792 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud) {
796 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr) {
797 return cr->user_data;
800 void linphone_proxy_config_set_state(LinphoneProxyConfig *cfg, LinphoneRegistrationState state, const char *message){
801 LinphoneCore *lc=cfg->lc;
802 if (lc && lc->vtable.registration_state_changed){
803 lc->vtable.registration_state_changed(lc,cfg,state,message);