sipvoiplink.cpp 57.7 KB
Newer Older
jpbl's avatar
jpbl committed
1
/*
2
 *  Copyright (C) 2004, 2005, 2006, 2008, 2009, 2010 Savoir-Faire Linux Inc.
3 4
 *
 *  Author: Emmanuel Milou <emmanuel.milou@savoirfairelinux.com>
5
 *  Author: Yun Liu <yun.liu@savoirfairelinux.com>
6
 *  Author: Pierre-Luc Bacon <pierre-luc.bacon@savoirfairelinux.com>
7
 *  Author: Alexandre Savard <alexandre.savard@savoirfairelinux.com>
8
 *
jpbl's avatar
jpbl committed
9 10
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
11
 *  the Free Software Foundation; either version 3 of the License, or
jpbl's avatar
jpbl committed
12 13 14 15 16 17 18 19 20 21
 *  (at your option) any later version.
 *
 *  This program 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., 675 Mass Ave, Cambridge, MA 02139, USA.
22 23 24 25 26 27 28 29 30 31 32
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  If you modify this program, or any covered work, by linking or
 *  combining it with the OpenSSL project's OpenSSL library (or a
 *  modified version of that library), containing parts covered by the
 *  terms of the OpenSSL or SSLeay licenses, Savoir-Faire Linux Inc.
 *  grants you additional permission to convey the resulting work.
 *  Corresponding Source for a non-source form of such a combination
 *  shall include the source code for the parts of OpenSSL used as well
 *  as that of the covered work.
jpbl's avatar
jpbl committed
33
 */
Emmanuel Milou's avatar
Emmanuel Milou committed
34

35 36 37 38
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

39

jpbl's avatar
jpbl committed
40
#include "sipvoiplink.h"
41 42
#include "manager.h"

43
#include "sip/sdp.h"
yanmorin's avatar
 
yanmorin committed
44
#include "sipcall.h"
Emmanuel Milou's avatar
nothing  
Emmanuel Milou committed
45
#include "sipaccount.h"
46
#include "eventthread.h"
47
#include "sdes_negotiator.h"
48 49 50

#include "dbus/dbusmanager.h"
#include "dbus/callmanager.h"
51
#include "dbus/configurationmanager.h"
52

53
#include "im/instant_messaging.h"
54

55 56
#include "audio/audiolayer.h"

57
#include "pjsip/sip_endpoint.h"
58
#include "pjsip/sip_transport_tls.h"
59
#include "pjsip/sip_uri.h"
60
#include "pjnath.h"
61

Emmanuel Milou's avatar
Emmanuel Milou committed
62 63 64
#include <netinet/in.h>
#include <arpa/nameser.h>
#include <resolv.h>
65
#include <istream>
66
#include <utility> // for std::pair
Emmanuel Milou's avatar
Emmanuel Milou committed
67

68 69 70 71 72
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <linux/if.h>

73 74
#include <map>

75 76
using namespace sfl;

77
namespace {
Rafaël Carré's avatar
Rafaël Carré committed
78

79 80
/** A map to retreive SFLphone internal call id
 *  Given a SIP call ID (usefull for transaction sucha as transfer)*/
81
static std::map<std::string, std::string> transferCallID;
82

Emmanuel Milou's avatar
Emmanuel Milou committed
83
/**************** EXTERN VARIABLES AND FUNCTIONS (callbacks) **************************/
jpbl's avatar
jpbl committed
84

85
/**
86 87 88 89
 * Set audio (SDP) configuration for a call
 * localport, localip, localexternalport
 * @param call a SIPCall valid pointer
 */
90
void setCallMediaLocal(SIPCall* call, const std::string &localIP);
91

92 93 94 95
static pj_caching_pool pool_cache, *cp_ = &pool_cache;
static pj_pool_t *pool_;
static pjsip_endpoint *endpt_;
static pjsip_module mod_ua_;
96
static pj_thread_t *thread;
Emmanuel Milou's avatar
Emmanuel Milou committed
97

98
void sdp_media_update_cb(pjsip_inv_session *inv, pj_status_t status);
99 100 101 102 103 104 105
void sdp_request_offer_cb(pjsip_inv_session *inv, const pjmedia_sdp_session *offer);
void sdp_create_offer_cb(pjsip_inv_session *inv, pjmedia_sdp_session **p_offer);
void invite_session_state_changed_cb(pjsip_inv_session *inv, pjsip_event *e);
void outgoing_request_forked_cb(pjsip_inv_session *inv, pjsip_event *e);
void transaction_state_changed_cb(pjsip_inv_session *inv, pjsip_transaction *tsx, pjsip_event *e);
void registration_cb(pjsip_regc_cbparam *param);
pj_bool_t transaction_request_cb(pjsip_rx_data *rdata);
106
pj_bool_t transaction_response_cb(pjsip_rx_data *rdata) ;
Emmanuel Milou's avatar
Emmanuel Milou committed
107

108
void transfer_client_cb(pjsip_evsub *sub, pjsip_event *event);
Emmanuel Milou's avatar
Emmanuel Milou committed
109

110 111 112 113 114 115 116
/**
 * Send a reINVITE inside an active dialog to modify its state
 * Local SDP session should be modified before calling this method
 * @param sip call
 */
int SIPSessionReinvite(SIPCall *);

117 118 119
/**
 * Helper function to process refer function on call transfer
 */
120
void onCallTransfered(pjsip_inv_session *inv, pjsip_rx_data *rdata);
Emmanuel Milou's avatar
Emmanuel Milou committed
121

122 123
pjsip_route_hdr *createRouteSet(const std::string &route, pj_pool_t *hdr_pool)
{
124 125
    int port = 0;
    std::string host;
126 127

    size_t found = route.find(":");
128

129
    if (found != std::string::npos) {
130 131
        host = route.substr(0, found);
        port = atoi(route.substr(found + 1, route.length()).c_str());
132
    } else
133 134 135 136 137
        host = route;

    pjsip_route_hdr *route_set = pjsip_route_hdr_create(hdr_pool);
    pjsip_route_hdr *routing = pjsip_route_hdr_create(hdr_pool);
    pjsip_sip_uri *url = pjsip_sip_uri_create(hdr_pool, 0);
138 139 140 141
    routing->name_addr.uri = (pjsip_uri*) url;
    pj_strdup2(hdr_pool, &url->host, host.c_str());
    url->port = port;

142
    pj_list_push_back(route_set, pjsip_hdr_clone(hdr_pool, routing));
143 144 145 146

    return route_set;
}

147 148 149 150 151 152 153 154 155 156 157
void handleIncomingOptions(pjsip_rx_data *rdata)
{
    pjsip_tx_data *tdata;

    if (pjsip_endpt_create_response(endpt_, rdata, PJSIP_SC_OK, NULL, &tdata) != PJ_SUCCESS)
        return;

#define ADD_HDR(hdr) do { \
    const pjsip_hdr *cap_hdr = hdr; \
    if (cap_hdr) \
    pjsip_msg_add_hdr (tdata->msg, (pjsip_hdr*) pjsip_hdr_clone (tdata->pool, cap_hdr)); \
Tristan Matthews's avatar
Tristan Matthews committed
158
} while (0)
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
#define ADD_CAP(cap) ADD_HDR(pjsip_endpt_get_capability(endpt_, cap, NULL));

    ADD_CAP(PJSIP_H_ALLOW);
    ADD_CAP(PJSIP_H_ACCEPT);
    ADD_CAP(PJSIP_H_SUPPORTED);
    ADD_HDR(pjsip_evsub_get_allow_events_hdr(NULL));

    pjsip_response_addr res_addr;
    pjsip_get_response_addr(tdata->pool, rdata, &res_addr);

    if (pjsip_endpt_send_response(endpt_, &res_addr, tdata, NULL, NULL) != PJ_SUCCESS)
        pjsip_tx_data_dec_ref(tdata);
}

pj_bool_t transaction_response_cb(pjsip_rx_data *rdata)
{
    pjsip_dialog *dlg = pjsip_rdata_get_dlg(rdata);

    if (!dlg)
        return PJ_SUCCESS;

    pjsip_transaction *tsx = pjsip_rdata_get_tsx(rdata);

    if (!tsx or tsx->method.id != PJSIP_INVITE_METHOD)
        return PJ_SUCCESS;

    if (tsx->status_code / 100 == 2) {
        /**
         * Send an ACK message inside a transaction. PJSIP send automatically, non-2xx ACK response.
         * ACK for a 2xx response must be send using this method.
         */
        pjsip_tx_data *tdata;
        pjsip_dlg_create_request(dlg, &pjsip_ack_method, rdata->msg_info.cseq->cseq, &tdata);
        pjsip_dlg_send_request(dlg, tdata, -1, NULL);
    }

    return PJ_SUCCESS;
}

std::string parseDisplayName(const char * buffer)
{
    const char* from_header = strstr(buffer, "From: ");

    if (!from_header)
        return "";

    std::string temp(from_header);
    size_t begin_displayName = temp.find("\"") + 1;
    size_t end_displayName = temp.rfind("\"");
    std::string displayName(temp.substr(begin_displayName, end_displayName - begin_displayName));

    static const size_t MAX_DISPLAY_NAME_SIZE = 25;
    if (displayName.size() > MAX_DISPLAY_NAME_SIZE)
        return "";

    return displayName;
}

void stripSipUriPrefix(std::string& sipUri)
{
    // Remove sip: prefix
    static const char SIP_PREFIX[] = "sip:";
    size_t found = sipUri.find(SIP_PREFIX);

    if (found != std::string::npos)
        sipUri.erase(found, found + (sizeof SIP_PREFIX) - 1);

    found = sipUri.find("@");

    if (found != std::string::npos)
        sipUri.erase(found);
}

pj_bool_t transaction_request_cb(pjsip_rx_data *rdata)
{
    pjsip_method *method = &rdata->msg_info.msg->line.req.method;

    if (method->id == PJSIP_ACK_METHOD && pjsip_rdata_get_dlg(rdata))
        return true;

    pjsip_sip_uri *sip_to_uri = (pjsip_sip_uri *) pjsip_uri_get_uri(rdata->msg_info.to->uri);
    pjsip_sip_uri *sip_from_uri = (pjsip_sip_uri *) pjsip_uri_get_uri(rdata->msg_info.from->uri);
    std::string userName(sip_to_uri->user.ptr, sip_to_uri->user.slen);
    std::string server(sip_from_uri->host.ptr, sip_from_uri->host.slen);
    std::string account_id(Manager::instance().getAccountIdFromNameAndServer(userName, server));

    std::string displayName(parseDisplayName(rdata->msg_info.msg_buf));

    if (method->id == PJSIP_OTHER_METHOD) {
        pj_str_t *str = &method->name;
        std::string request(str->ptr, str->slen);

        if (request.find("NOTIFY") != (size_t)-1) {
            int voicemail;

            if (sscanf((const char*)rdata->msg_info.msg->body->data, "Voice-Message: %d/", &voicemail) == 1 && voicemail != 0)
                Manager::instance().startVoiceMessageNotification(account_id, voicemail);
        }

        pjsip_endpt_respond_stateless(endpt_, rdata, PJSIP_SC_OK, NULL, NULL, NULL);

        return true;
    } else if (method->id == PJSIP_OPTIONS_METHOD) {
        handleIncomingOptions(rdata);
        return true;
    } else if (method->id != PJSIP_INVITE_METHOD && method->id != PJSIP_ACK_METHOD) {
        pjsip_endpt_respond_stateless(endpt_, rdata, PJSIP_SC_METHOD_NOT_ALLOWED, NULL, NULL, NULL);
        return true;
    }

    SIPAccount *account = dynamic_cast<SIPAccount *>(Manager::instance().getAccount(account_id));

    pjmedia_sdp_session *r_sdp;
    pjsip_msg_body *body = rdata->msg_info.msg->body;

    if (!body || pjmedia_sdp_parse(rdata->tp_info.pool, (char*) body->data, body->len, &r_sdp) != PJ_SUCCESS)
        r_sdp = NULL;

    if (account->getActiveCodecs().empty()) {
        pjsip_endpt_respond_stateless(endpt_, rdata,
                                      PJSIP_SC_NOT_ACCEPTABLE_HERE, NULL, NULL,
                                      NULL);
        return false;
    }

    // Verify that we can handle the request
    unsigned options = 0;

    if (pjsip_inv_verify_request(rdata, &options, NULL, NULL, endpt_, NULL) != PJ_SUCCESS) {
        pjsip_endpt_respond_stateless(endpt_, rdata, PJSIP_SC_METHOD_NOT_ALLOWED, NULL, NULL, NULL);
        return true;
    }

Tristan Matthews's avatar
Tristan Matthews committed
292
    Manager::instance().hookPreference.runHook(rdata->msg_info.msg);
293 294 295 296 297

    SIPCall* call = new SIPCall(Manager::instance().getNewCallID(), Call::INCOMING, cp_);
    Manager::instance().associateCallToAccount(call->getCallId(), account_id);

    // May use the published address as well
298
    std::string addrToUse = SipTransport::getInterfaceAddrFromName(account->getLocalInterface());
299 300 301 302
    std::string addrSdp = account->isStunEnabled()
                          ? account->getPublishedAddress()
                          : addrToUse;

303
    pjsip_tpselector *tp = SIPVoIPLink::instance()->sipTransport.initTransportSelector(account->transport_, call->getMemoryPool());
304 305

    if (addrToUse == "0.0.0.0")
306
        addrToUse = SipTransport::getSIPLocalIP();
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324

    if (addrSdp == "0.0.0.0")
        addrSdp = addrToUse;

    char tmp[PJSIP_MAX_URL_SIZE];
    int length = pjsip_uri_print(PJSIP_URI_IN_FROMTO_HDR, sip_from_uri, tmp, PJSIP_MAX_URL_SIZE);
    std::string peerNumber(tmp, length);
    stripSipUriPrefix(peerNumber);

    call->setConnectionState(Call::PROGRESSING);
    call->setPeerNumber(peerNumber);
    call->setDisplayName(displayName);
    call->initRecFilename(peerNumber);

    setCallMediaLocal(call, addrToUse);

    call->getLocalSDP()->setLocalIP(addrSdp);

325 326
    call->getAudioRtp().initConfig();
    call->getAudioRtp().initSession();
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342

    if (rdata->msg_info.msg->body) {
        char sdpbuffer[1000];
        int len = rdata->msg_info.msg->body->print_body(rdata->msg_info.msg->body, sdpbuffer, sizeof sdpbuffer);

        if (len == -1) // error
            len = 0;

        std::string sdpoffer(sdpbuffer, len);
        size_t start = sdpoffer.find("a=crypto:");

        // Found crypto header in SDP
        if (start != std::string::npos) {
            CryptoOffer crypto_offer;
            crypto_offer.push_back(std::string(sdpoffer.substr(start, (sdpoffer.size() - start) - 1)));

343
            std::vector<sfl::CryptoSuiteDefinition> localCapabilities;
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411

            for (int i = 0; i < 3; i++)
                localCapabilities.push_back(sfl::CryptoSuites[i]);

            sfl::SdesNegotiator sdesnego(localCapabilities, crypto_offer);

            if (sdesnego.negotiate()) {
                call->getAudioRtp().setRemoteCryptoInfo(sdesnego);
                call->getAudioRtp().initLocalCryptoInfo();
            }
        }
    }

    call->getLocalSDP()->receiveOffer(r_sdp, account->getActiveCodecs());

    sfl::Codec* audiocodec = Manager::instance().audioCodecFactory.instantiateCodec(PAYLOAD_CODEC_ULAW);
    call->getAudioRtp().start(static_cast<sfl::AudioCodec *>(audiocodec));

    pjsip_dialog* dialog;

    if (pjsip_dlg_create_uas(pjsip_ua_instance(), rdata, NULL, &dialog) != PJ_SUCCESS) {
        delete call;
        pjsip_endpt_respond_stateless(endpt_, rdata, PJSIP_SC_INTERNAL_SERVER_ERROR, NULL, NULL, NULL);
        return false;
    }

    pjsip_inv_create_uas(dialog, rdata, call->getLocalSDP()->getLocalSdpSession(), 0, &call->inv);

    PJ_ASSERT_RETURN(pjsip_dlg_set_transport(dialog, tp) == PJ_SUCCESS, 1);

    call->inv->mod_data[mod_ua_.id] = call;

    // Check whether Replaces header is present in the request and process accordingly.
    pjsip_dialog *replaced_dlg;
    pjsip_tx_data *response;

    if (pjsip_replaces_verify_request(rdata, &replaced_dlg, PJ_FALSE, &response) != PJ_SUCCESS) {
        ERROR("Something wrong with Replaces request.");
        pjsip_endpt_respond_stateless(endpt_, rdata, 500 /* internal server error */, NULL, NULL, NULL);
    }

    // Check if call has been transfered
    pjsip_tx_data *tdata;

    if (replaced_dlg) { // If Replace header present
        // Always answer the new INVITE with 200, regardless whether
        // the replaced call is in early or confirmed state.
        if (pjsip_inv_answer(call->inv, 200, NULL, NULL, &response) == PJ_SUCCESS)
            pjsip_inv_send_msg(call->inv, response);

        // Get the INVITE session associated with the replaced dialog.
        pjsip_inv_session *replaced_inv = pjsip_dlg_get_inv_session(replaced_dlg);

        // Disconnect the "replaced" INVITE session.
        if (pjsip_inv_end_session(replaced_inv, PJSIP_SC_GONE, NULL, &tdata) == PJ_SUCCESS && tdata)
            pjsip_inv_send_msg(replaced_inv, tdata);
    } else { // Prooceed with normal call flow
        PJ_ASSERT_RETURN(pjsip_inv_initial_answer(call->inv, rdata, PJSIP_SC_RINGING, NULL, NULL, &tdata) == PJ_SUCCESS, 1);
        PJ_ASSERT_RETURN(pjsip_inv_send_msg(call->inv, tdata) == PJ_SUCCESS, 1);

        call->setConnectionState(Call::RINGING);

        Manager::instance().incomingCall(call, account_id);
        Manager::instance().getAccountLink(account_id)->addCall(call);
    }

    return true;
}
412 413
} // end anonymous namespace

Emmanuel Milou's avatar
Emmanuel Milou committed
414 415
/*************************************************************************************************/

416
SIPVoIPLink::SIPVoIPLink() : sipTransport(endpt_, cp_, pool_), evThread_(new EventThread(this))
417 418
{
#define TRY(ret) do { \
419 420
    if (ret != PJ_SUCCESS) \
    throw VoipLinkException(#ret " failed"); \
Tristan Matthews's avatar
Tristan Matthews committed
421
} while (0)
422 423

    srand(time(NULL)); // to get random number for RANDOM_PORT
Emmanuel Milou's avatar
Emmanuel Milou committed
424

425 426
    TRY(pj_init());
    TRY(pjlib_util_init());
427 428
    // From 0 (min) to 6 (max)
    pj_log_set_level(Logger::getDebugMode() ? 6 : 0);
429
    TRY(pjnath_init());
430

431 432
    pj_caching_pool_init(cp_, &pj_pool_factory_default_policy, 0);
    pool_ = pj_pool_create(&cp_->factory, "sflphone", 4000, 4000, NULL);
433

434
    if (!pool_)
435
        throw VoipLinkException("UserAgent: Could not initialize memory pool");
Alexandre Savard's avatar
Alexandre Savard committed
436

437
    TRY(pjsip_endpt_create(&cp_->factory, pj_gethostname()->ptr, &endpt_));
438

439 440 441 442 443
    sipTransport.setEndpoint(endpt_);
    sipTransport.setCachingPool(cp_);
    sipTransport.setPool(pool_);

    if (SipTransport::getSIPLocalIP().empty())
444 445
        throw VoipLinkException("UserAgent: Unable to determine network capabilities");

446 447 448 449
    TRY(pjsip_tsx_layer_init_module(endpt_));
    TRY(pjsip_ua_init_module(endpt_, NULL));
    TRY(pjsip_replaces_init_module(endpt_)); // See the Replaces specification in RFC 3891
    TRY(pjsip_100rel_init_module(endpt_));
450 451

    // Initialize and register sflphone module
452 453 454 455 456 457
    mod_ua_.name = pj_str((char*) PACKAGE);
    mod_ua_.id = -1;
    mod_ua_.priority = PJSIP_MOD_PRIORITY_APPLICATION;
    mod_ua_.on_rx_request = &transaction_request_cb;
    mod_ua_.on_rx_response = &transaction_response_cb;
    TRY(pjsip_endpt_register_module(endpt_, &mod_ua_));
458

459 460
    TRY(pjsip_evsub_init_module(endpt_));
    TRY(pjsip_xfer_init_module(endpt_));
461 462

    static const pjsip_inv_callback inv_cb = {
463 464 465 466 467 468 469 470
        invite_session_state_changed_cb,
        outgoing_request_forked_cb,
        transaction_state_changed_cb,
        sdp_request_offer_cb,
        sdp_create_offer_cb,
        sdp_media_update_cb,
        NULL,
        NULL,
471
    };
472
    TRY(pjsip_inv_usage_init(endpt_, &inv_cb));
473 474

    static const pj_str_t allowed[] = { { (char*) "INFO", 4}, { (char*) "REGISTER", 8}, { (char*) "OPTIONS", 7}, { (char*) "MESSAGE", 7 } };       //  //{"INVITE", 6}, {"ACK",3}, {"BYE",3}, {"CANCEL",6}
475
    pjsip_endpt_add_capability(endpt_, &mod_ua_, PJSIP_H_ALLOW, NULL, PJ_ARRAY_SIZE(allowed), allowed);
476 477

    static const pj_str_t text_plain = { (char*) "text/plain", 10 };
478
    pjsip_endpt_add_capability(endpt_, &mod_ua_, PJSIP_H_ACCEPT, NULL, 1, &text_plain);
479 480

    static const pj_str_t accepted = { (char*) "application/sdp", 15 };
481
    pjsip_endpt_add_capability(endpt_, &mod_ua_, PJSIP_H_ACCEPT, NULL, 1, &accepted);
482

483
    DEBUG("UserAgent: pjsip version %s for %s initialized", pj_get_version(), PJ_OS_NAME);
484

485
    TRY(pjsip_replaces_init_module(endpt_));
Tristan Matthews's avatar
Tristan Matthews committed
486
#undef TRY
487 488

    evThread_->start();
yanmorin's avatar
 
yanmorin committed
489
}
jpbl's avatar
jpbl committed
490

Emmanuel Milou's avatar
[#2402]  
Emmanuel Milou committed
491 492
SIPVoIPLink::~SIPVoIPLink()
{
493 494 495
    delete evThread_;
    pj_thread_join(thread);
    pj_thread_destroy(thread);
496 497

    const pj_time_val tv = {0, 10};
498 499
    pjsip_endpt_handle_events(endpt_, &tv);
    pjsip_endpt_destroy(endpt_);
500

501 502
    pj_pool_release(pool_);
    pj_caching_pool_destroy(cp_);
503 504

    pj_shutdown();
505 506
}

507
SIPVoIPLink* SIPVoIPLink::instance()
Emmanuel Milou's avatar
[#2402]  
Emmanuel Milou committed
508
{
509 510
    static SIPVoIPLink* instance = NULL;

511 512
    if (!instance)
        instance = new SIPVoIPLink;
Emmanuel Milou's avatar
Emmanuel Milou committed
513

514
    return instance;
yanmorin's avatar
 
yanmorin committed
515 516
}

517
void
Emmanuel Milou's avatar
[#2402]  
Emmanuel Milou committed
518 519
SIPVoIPLink::getEvent()
{
520
    static pj_thread_desc desc;
521

522
    // We have to register the external thread so it could access the pjsip frameworks
523
    if (!pj_thread_is_registered())
524
        pj_thread_register(NULL, desc, &thread);
yanmorin's avatar
 
yanmorin committed
525

Rafaël Carré's avatar
Rafaël Carré committed
526
    static const pj_time_val timeout = {0, 10};
527
    pjsip_endpt_handle_events(endpt_, &timeout);
528
}
529

530
void SIPVoIPLink::sendRegister(Account *a)
Emmanuel Milou's avatar
[#2402]  
Emmanuel Milou committed
531
{
532
    SIPAccount *account = dynamic_cast<SIPAccount*>(a);
533
    sipTransport.createSipTransport(account);
534

535 536
    account->setRegister(true);
    account->setRegistrationState(Trying);
537

538
    pjsip_regc *regc = account->getRegistrationInfo();
539

540
    if (pjsip_regc_create(endpt_, (void *) account, &registration_cb, &regc) != PJ_SUCCESS)
541 542 543
        throw VoipLinkException("UserAgent: Unable to create regc structure.");

    std::string srvUri(account->getServerUri());
544

545 546 547
    // std::string address, port;
    // findLocalAddressFromUri(srvUri, account->transport_, address, port);
    pj_str_t pjSrv = pj_str((char*) srvUri.c_str());
548

549
    // Generate the FROM header
550
    std::string from(account->getFromUri());
551
    pj_str_t pjFrom = pj_str((char*) from.c_str());
552

553
    // Get the contact header for this account
554
    std::string contact(account->getContactHeader());
555
    pj_str_t pjContact = pj_str((char*) contact.c_str());
556

557 558
    if (pjsip_regc_init(regc, &pjSrv, &pjFrom, &pjFrom, 1, &pjContact, account->getRegistrationExpire()) != PJ_SUCCESS)
        throw VoipLinkException("Unable to initialize account registration structure");
559

560
    if (!account->getServiceRoute().empty())
561
        pjsip_regc_set_route_set(regc, createRouteSet(account->getServiceRoute(), pool_));
562

563
    pjsip_regc_set_credentials(regc, account->getCredentialCount(), account->getCredInfo());
564

565
    pjsip_hdr hdr_list;
566 567
    pj_list_init(&hdr_list);
    std::string useragent(account->getUserAgentName());
568
    pj_str_t pJuseragent = pj_str((char*) useragent.c_str());
569
    const pj_str_t STR_USER_AGENT = { (char*) "User-Agent", 10 };
570

571
    pjsip_generic_string_hdr *h = pjsip_generic_string_hdr_create(pool_, &STR_USER_AGENT, &pJuseragent);
572 573
    pj_list_push_back(&hdr_list, (pjsip_hdr*) h);
    pjsip_regc_add_headers(regc, &hdr_list);
jpbl's avatar
jpbl committed
574

575

576
    pjsip_tx_data *tdata;
Emmanuel Milou's avatar
Emmanuel Milou committed
577

578 579
    if (pjsip_regc_register(regc, PJ_TRUE, &tdata) != PJ_SUCCESS)
        throw VoipLinkException("Unable to initialize transaction data for account registration");
Emmanuel Milou's avatar
Emmanuel Milou committed
580

581
    if (pjsip_regc_set_transport(regc, sipTransport.initTransportSelector(account->transport_, pool_)) != PJ_SUCCESS)
582
        throw VoipLinkException("Unable to set transport");
583

584 585
    // decrease transport's ref count, counter incrementation is managed when acquiring transport
    pjsip_transport_dec_ref(account->transport_);
586

587 588 589
    // pjsip_regc_send increment the transport ref count by one,
    if (pjsip_regc_send(regc, tdata) != PJ_SUCCESS)
        throw VoipLinkException("Unable to send account registration request");
590

591 592 593 594 595 596
    // Decrease transport's ref count, since coresponding reference counter decrementation
    // is performed in pjsip_regc_destroy. This function is never called in SFLphone as the
    // regc data structure is permanently associated to the account at first registration.
    pjsip_transport_dec_ref(account->transport_);

    account->setRegistrationInfo(regc);
597 598 599 600

    // start the periodic registration request based on Expire header
    // account determines itself if a keep alive is required
    account->startKeepAliveTimer();
601 602
}

603
void SIPVoIPLink::sendUnregister(Account *a)
Emmanuel Milou's avatar
[#2402]  
Emmanuel Milou committed
604
{
605
    SIPAccount *account = dynamic_cast<SIPAccount *>(a);
606

607
    // This may occurs if account failed to register and is in state INVALID
608
    if (!account->isRegistered()) {
609
        account->setRegistrationState(Unregistered);
610
        return;
611 612
    }

613 614 615
    // Make sure to cancel any ongoing timers before unregister
    account->stopKeepAliveTimer();

616
    pjsip_regc *regc = account->getRegistrationInfo();
617

618
    if (!regc)
619
        throw VoipLinkException("Registration structure is NULL");
620

621
    pjsip_tx_data *tdata = NULL;
622 623

    if (pjsip_regc_unregister(regc, &tdata) != PJ_SUCCESS)
624
        throw VoipLinkException("Unable to unregister sip account");
625

626
    if (pjsip_regc_send(regc, tdata) != PJ_SUCCESS)
627
        throw VoipLinkException("Unable to send request to unregister sip account");
628

629
    account->setRegister(false);
jpbl's avatar
jpbl committed
630 631
}

632
void SIPVoIPLink::registerKeepAliveTimer(pj_timer_entry &timer, pj_time_val &delay)
633
{
634
    if (timer.id == -1)
635 636
        WARN("UserAgent: Timer already scheduled");

637 638 639 640 641 642 643 644 645 646 647 648
    switch (pjsip_endpt_schedule_timer(endpt_, &timer, &delay)) {
        case PJ_SUCCESS:
            break;
        default:
            ERROR("UserAgent: Could not schedule new timer in pjsip endpoint");
            /* fallthrough */
        case PJ_EINVAL:
            ERROR("UserAgent: Invalid timer or delay entry");
            break;
        case PJ_EINVALIDOP:
            ERROR("Invalid timer entry, maybe already scheduled");
            break;
649
    }
650 651 652 653
}

void SIPVoIPLink::cancelKeepAliveTimer(pj_timer_entry& timer)
{
654
    pjsip_endpt_cancel_timer(endpt_, &timer);
655 656
}

657
Call *SIPVoIPLink::newOutgoingCall(const std::string& id, const std::string& toUrl)
Emmanuel Milou's avatar
[#2402]  
Emmanuel Milou committed
658
{
659 660
    SIPAccount *account = dynamic_cast<SIPAccount *>(Manager::instance().getAccount(Manager::instance().getAccountFromCall(id)));

661
    if (account == NULL) // TODO: We should investigate how we could get rid of this error and create a IP2IP call instead
662
        throw VoipLinkException("Could not get account for this call");
663

664
    SIPCall* call = new SIPCall(id, Call::OUTGOING, cp_);
Emmanuel Milou's avatar
Emmanuel Milou committed
665

666
    // If toUri is not a well formatted sip URI, use account information to process it
667
    std::string toUri;
668

669 670
    if (toUrl.find("sip:") != std::string::npos or
        toUrl.find("sips:") != std::string::npos)
671
        toUri = toUrl;
672
    else
673
        toUri = account->getToUri(toUrl);
674

675
    call->setPeerNumber(toUri);
676
    std::string localAddr(SipTransport::getInterfaceAddrFromName(account->getLocalInterface()));
677

678
    if (localAddr == "0.0.0.0")
679
        localAddr = SipTransport::getSIPLocalIP();
680

681
    setCallMediaLocal(call, localAddr);
Emmanuel Milou's avatar
Emmanuel Milou committed
682

683
    // May use the published address as well
684
    std::string addrSdp = account->isStunEnabled() ?
685
    account->getPublishedAddress() :
686
    SipTransport::getInterfaceAddrFromName(account->getLocalInterface());
687

688
    if (addrSdp == "0.0.0.0")
689
        addrSdp = SipTransport::getSIPLocalIP();
Emmanuel Milou's avatar
Emmanuel Milou committed
690

691 692 693
    // Initialize the session using ULAW as default codec in case of early media
    // The session should be ready to receive media once the first INVITE is sent, before
    // the session initialization is completed
694 695
    sfl::Codec* audiocodec = Manager::instance().audioCodecFactory.instantiateCodec(PAYLOAD_CODEC_ULAW);

696
    if (audiocodec == NULL) {
697 698
        delete call;
        throw VoipLinkException("Could not instantiate codec for early media");
699
    }
700

701
    try {
702 703
        call->getAudioRtp().initConfig();
        call->getAudioRtp().initSession();
704 705
        call->getAudioRtp().initLocalCryptoInfo();
        call->getAudioRtp().start(static_cast<sfl::AudioCodec *>(audiocodec));
706
    } catch (...) {
707
        delete call;
708 709
        throw VoipLinkException("Could not start rtp session for early media");
    }
710

711
    call->initRecFilename(toUrl);
712

713 714
    call->getLocalSDP()->setLocalIP(addrSdp);
    call->getLocalSDP()->createOffer(account->getActiveCodecs());
715

716 717 718 719
    if (!SIPStartCall(call)) {
        delete call;
        throw VoipLinkException("Could not send outgoing INVITE request for new call");
    }
jpbl's avatar
jpbl committed
720

721
    return call;
722
}
723

724
void
725
SIPVoIPLink::answer(Call *call)
Emmanuel Milou's avatar
[#2402]  
Emmanuel Milou committed
726
{
727
    if (!call)
728
        return;
729
    call->answer();
Yun Liu's avatar
Yun Liu committed
730 731
}

732
void
733
SIPVoIPLink::hangup(const std::string& id)
Emmanuel Milou's avatar
[#2402]  
Emmanuel Milou committed
734
{
735
    SIPCall* call = getSIPCall(id);
736

737
    std::string account_id(Manager::instance().getAccountFromCall(id));
738 739
    SIPAccount *account = dynamic_cast<SIPAccount *>(Manager::instance().getAccount(account_id));

740
    if (account == NULL)
741
        throw VoipLinkException("Could not find account for this call");
742

743
    pjsip_inv_session *inv = call->inv;
744

745
    if (inv == NULL)
746
        throw VoipLinkException("No invite session for this call");
747

748
    // Looks for sip routes
Tristan Matthews's avatar
Tristan Matthews committed
749
    if (not account->getServiceRoute().empty()) {
750
        pjsip_route_hdr *route_set = createRouteSet(account->getServiceRoute(), inv->pool);
751
        pjsip_dlg_set_route_set(inv->dlg, route_set);
752
    }
753

754
    pjsip_tx_data *tdata = NULL;
755

756
    // User hangup current call. Notify peer
757
    if (pjsip_inv_end_session(inv, 404, NULL, &tdata) != PJ_SUCCESS || !tdata)
758
        return;
759

760
    if (pjsip_inv_send_msg(inv, tdata) != PJ_SUCCESS)
761
        return;
762

763
    // Make sure user data is NULL in callbacks
764
    inv->mod_data[mod_ua_.id] = NULL;
765

766
    if (Manager::instance().isCurrentCall(id))
767
        call->getAudioRtp().stop();
768

769
    removeCall(id);
alexandresavard's avatar
alexandresavard committed
770 771
}

772
void
773
SIPVoIPLink::peerHungup(const std::string& id)
Emmanuel Milou's avatar
[#2402]  
Emmanuel Milou committed
774
{
775
    SIPCall* call = getSIPCall(id);
Alexandre Savard's avatar
Alexandre Savard committed
776

777
    // User hangup current call. Notify peer
778
    pjsip_tx_data *tdata = NULL;
779 780

    if (pjsip_inv_end_session(call->inv, 404, NULL, &tdata) != PJ_SUCCESS || !tdata)
781
        return;
782

783
    if (pjsip_inv_send_msg(call->inv, tdata) != PJ_SUCCESS)
784
        return;
785

786
    // Make sure user data is NULL in callbacks
787
    call->inv->mod_data[mod_ua_.id ] = NULL;
788

789
    if (Manager::instance().isCurrentCall(id))
790
        call->getAudioRtp().stop();
791

792
    removeCall(id);
793 794
}

795
void
796
SIPVoIPLink::onhold(const std::string& id)
Emmanuel Milou's avatar
[#2402]  
Emmanuel Milou committed
797
{
798
    SIPCall *call = getSIPCall(id);
799
    call->setState(Call::HOLD);
800
    call->getAudioRtp().stop();
801 802

    Sdp *sdpSession = call->getLocalSDP();
803

804
    if (!sdpSession)
805
        throw VoipLinkException("Could not find sdp session");
806 807 808 809 810

    sdpSession->removeAttributeFromLocalAudioMedia("sendrecv");
    sdpSession->removeAttributeFromLocalAudioMedia("sendonly");
    sdpSession->addAttributeToLocalAudioMedia("sendonly");

811
    SIPSessionReinvite(call);
812 813
}

814
void
815
SIPVoIPLink::offhold(const std::string& id)
816
{
817 818 819
    SIPCall *call = getSIPCall(id);

    Sdp *sdpSession = call->getLocalSDP();
820

821
    if (sdpSession == NULL)
822
        throw VoipLinkException("Could not find sdp session");
823

824
    try {
825
        int pl = PAYLOAD_CODEC_ULAW;
826
        sfl::Codec *sessionMedia = sdpSession->getSessionMedia();
827

828
        if (sessionMedia)
829
            pl = sessionMedia->getPayloadType();
830