channels/sig_pri.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 1999 - 2009, Digium, Inc.
   5  *
   6  * Mark Spencer <markster@digium.com>
   7  *
   8  * See http://www.asterisk.org for more information about
   9  * the Asterisk project. Please do not directly contact
  10  * any of the maintainers of this project for assistance;
  11  * the project provides a web site, mailing lists and IRC
  12  * channels for your use.
  13  *
  14  * This program is free software, distributed under the terms of
  15  * the GNU General Public License Version 2. See the LICENSE file
  16  * at the top of the source tree.
  17  */
  18
  19 /*! \file
  20  *
  21  * \brief PRI signaling module
  22  *
  23  * \author Matthew Fredrickson <creslin@digium.com>
  24  */
  25
  26 /*** MODULEINFO
  27         <support_level>core</support_level>
  28  ***/
  29 /*** DOCUMENTATION
  30         <managerEvent language="en_US" name="MCID">
  31                 <managerEventInstance class="EVENT_FLAG_CALL">
  32                         <synopsis>Published when a malicious call ID request arrives.</synopsis>
  33                         <syntax>
  34                                 <channel_snapshot/>
  35                                 <parameter name="MCallerIDNumValid">
  36                                 </parameter>
  37                                 <parameter name="MCallerIDNum">
  38                                 </parameter>
  39                                 <parameter name="MCallerIDton">
  40                                 </parameter>
  41                                 <parameter name="MCallerIDNumPlan">
  42                                 </parameter>
  43                                 <parameter name="MCallerIDNumPres">
  44                                 </parameter>
  45                                 <parameter name="MCallerIDNameValid">
  46                                 </parameter>
  47                                 <parameter name="MCallerIDName">
  48                                 </parameter>
  49                                 <parameter name="MCallerIDNameCharSet">
  50                                 </parameter>
  51                                 <parameter name="MCallerIDNamePres">
  52                                 </parameter>
  53                                 <parameter name="MCallerIDSubaddr">
  54                                 </parameter>
  55                                 <parameter name="MCallerIDSubaddrType">
  56                                 </parameter>
  57                                 <parameter name="MCallerIDSubaddrOdd">
  58                                 </parameter>
  59                                 <parameter name="MCallerIDPres">
  60                                 </parameter>
  61                                 <parameter name="MConnectedIDNumValid">
  62                                 </parameter>
  63                                 <parameter name="MConnectedIDNum">
  64                                 </parameter>
  65                                 <parameter name="MConnectedIDton">
  66                                 </parameter>
  67                                 <parameter name="MConnectedIDNumPlan">
  68                                 </parameter>
  69                                 <parameter name="MConnectedIDNumPres">
  70                                 </parameter>
  71                                 <parameter name="MConnectedIDNameValid">
  72                                 </parameter>
  73                                 <parameter name="MConnectedIDName">
  74                                 </parameter>
  75                                 <parameter name="MConnectedIDNameCharSet">
  76                                 </parameter>
  77                                 <parameter name="MConnectedIDNamePres">
  78                                 </parameter>
  79                                 <parameter name="MConnectedIDSubaddr">
  80                                 </parameter>
  81                                 <parameter name="MConnectedIDSubaddrType">
  82                                 </parameter>
  83                                 <parameter name="MConnectedIDSubaddrOdd">
  84                                 </parameter>
  85                                 <parameter name="MConnectedIDPres">
  86                                 </parameter>
  87                         </syntax>
  88                 </managerEventInstance>
  89         </managerEvent>
  90  ***/
  91
  92 #include "asterisk.h"
  93
  94 #ifdef HAVE_PRI
  95
  96 #include <errno.h>
  97 #include <ctype.h>
  98 #include <signal.h>
  99
 100 #include "asterisk/utils.h"
 101 #include "asterisk/options.h"
 102 #include "asterisk/pbx.h"
 103 #include "asterisk/app.h"
 104 #include "asterisk/file.h"
 105 #include "asterisk/callerid.h"
 106 #include "asterisk/say.h"
 107 #include "asterisk/manager.h"
 108 #include "asterisk/astdb.h"
 109 #include "asterisk/causes.h"
 110 #include "asterisk/musiconhold.h"
 111 #include "asterisk/cli.h"
 112 #include "asterisk/transcap.h"
 113 #include "asterisk/features.h"
 114 #include "asterisk/aoc.h"
 115 #include "asterisk/bridge.h"
 116 #include "asterisk/stasis_channels.h"
 117
 118 #include "sig_pri.h"
 119 #ifndef PRI_EVENT_FACILITY
 120 #error "Upgrade your libpri"
 121 #endif
 122
 123 /*** DOCUMENTATION
 124  ***/
 125
 126
 127 /* define this to send PRI user-user information elements */
 128 #undef SUPPORT_USERUSER
 129
 130 /*!
 131  * Define to make always pick a channel if allowed.  Useful for
 132  * testing channel shifting.
 133  */
 134 //#define ALWAYS_PICK_CHANNEL   1
 135
 136 /*!
 137  * Define to force a RESTART on a channel that returns a cause
 138  * code of PRI_CAUSE_REQUESTED_CHAN_UNAVAIL(44).  If the cause
 139  * is because of a stuck channel on the peer and the channel is
 140  * always the next channel we pick for an outgoing call then
 141  * this can help.
 142  */
 143 #define FORCE_RESTART_UNAVAIL_CHANS             1
 144
 145 #if defined(HAVE_PRI_CCSS)
 146 struct sig_pri_cc_agent_prv {
 147         /*! Asterisk span D channel control structure. */
 148         struct sig_pri_span *pri;
 149         /*! CC id value to use with libpri. -1 if invalid. */
 150         long cc_id;
 151         /*! TRUE if CC has been requested and we are waiting for the response. */
 152         unsigned char cc_request_response_pending;
 153 };
 154
 155 struct sig_pri_cc_monitor_instance {
 156         /*! \brief Asterisk span D channel control structure. */
 157         struct sig_pri_span *pri;
 158         /*! CC id value to use with libpri. (-1 if already canceled). */
 159         long cc_id;
 160         /*! CC core id value. */
 161         int core_id;
 162         /*! Device name(Channel name less sequence number) */
 163         char name[1];
 164 };
 165
 166 /*! Upper level agent/monitor type name. */
 167 static const char *sig_pri_cc_type_name;
 168 /*! Container of sig_pri monitor instances. */
 169 static struct ao2_container *sig_pri_cc_monitors;
 170 #endif  /* defined(HAVE_PRI_CCSS) */
 171
 172 static int pri_matchdigittimeout = 3000;
 173
 174 static int pri_gendigittimeout = 8000;
 175
 176 #define DCHAN_NOTINALARM  (1 << 0)
 177 #define DCHAN_UP          (1 << 1)
 178
 179 /* Defines to help decode the encoded event channel id. */
 180 #define PRI_CHANNEL(p)  ((p) & 0xff)
 181 #define PRI_SPAN(p)             (((p) >> 8) & 0xff)
 182 #define PRI_EXPLICIT    (1 << 16)
 183 #define PRI_CIS_CALL    (1 << 17)       /* Call is using the D channel only. */
 184 #define PRI_HELD_CALL   (1 << 18)
 185
 186
 187 #define DCHAN_AVAILABLE (DCHAN_NOTINALARM | DCHAN_UP)
 188
 189 static int pri_active_dchan_index(struct sig_pri_span *pri);
 190
 191 static const char *sig_pri_call_level2str(enum sig_pri_call_level level)
 192 {
 193         switch (level) {
 194         case SIG_PRI_CALL_LEVEL_IDLE:
 195                 return "Idle";
 196         case SIG_PRI_CALL_LEVEL_SETUP:
 197                 return "Setup";
 198         case SIG_PRI_CALL_LEVEL_OVERLAP:
 199                 return "Overlap";
 200         case SIG_PRI_CALL_LEVEL_PROCEEDING:
 201                 return "Proceeding";
 202         case SIG_PRI_CALL_LEVEL_ALERTING:
 203                 return "Alerting";
 204         case SIG_PRI_CALL_LEVEL_DEFER_DIAL:
 205                 return "DeferDial";
 206         case SIG_PRI_CALL_LEVEL_CONNECT:
 207                 return "Connect";
 208         }
 209         return "Unknown";
 210 }
 211
 212 static inline void pri_rel(struct sig_pri_span *pri)
 213 {
 214         ast_mutex_unlock(&pri->lock);
 215 }
 216
 217 static unsigned int PVT_TO_CHANNEL(struct sig_pri_chan *p)
 218 {
 219         int res = (((p)->prioffset) | ((p)->logicalspan << 8) | (p->mastertrunkgroup ? PRI_EXPLICIT : 0));
 220         ast_debug(5, "prioffset: %d mastertrunkgroup: %d logicalspan: %d result: %d\n",
 221                 p->prioffset, p->mastertrunkgroup, p->logicalspan, res);
 222
 223         return res;
 224 }
 225
 226 static void sig_pri_handle_dchan_exception(struct sig_pri_span *pri, int index)
 227 {
 228         if (sig_pri_callbacks.handle_dchan_exception) {
 229                 sig_pri_callbacks.handle_dchan_exception(pri, index);
 230         }
 231 }
 232
 233 static void sig_pri_set_dialing(struct sig_pri_chan *p, int is_dialing)
 234 {
 235         if (sig_pri_callbacks.set_dialing) {
 236                 sig_pri_callbacks.set_dialing(p->chan_pvt, is_dialing);
 237         }
 238 }
 239
 240 static void sig_pri_set_digital(struct sig_pri_chan *p, int is_digital)
 241 {
 242         p->digital = is_digital;
 243         if (sig_pri_callbacks.set_digital) {
 244                 sig_pri_callbacks.set_digital(p->chan_pvt, is_digital);
 245         }
 246 }
 247
 248 static void sig_pri_set_outgoing(struct sig_pri_chan *p, int is_outgoing)
 249 {
 250         p->outgoing = is_outgoing;
 251         if (sig_pri_callbacks.set_outgoing) {
 252                 sig_pri_callbacks.set_outgoing(p->chan_pvt, is_outgoing);
 253         }
 254 }
 255
 256 void sig_pri_set_alarm(struct sig_pri_chan *p, int in_alarm)
 257 {
 258         if (sig_pri_is_alarm_ignored(p->pri)) {
 259                 /* Always set not in alarm */
 260                 in_alarm = 0;
 261         }
 262
 263         /*
 264          * Clear the channel restart state when the channel alarm
 265          * changes to prevent the state from getting stuck when the link
 266          * goes down.
 267          */
 268         p->resetting = SIG_PRI_RESET_IDLE;
 269
 270         p->inalarm = in_alarm;
 271         if (sig_pri_callbacks.set_alarm) {
 272                 sig_pri_callbacks.set_alarm(p->chan_pvt, in_alarm);
 273         }
 274 }
 275
 276 static const char *sig_pri_get_orig_dialstring(struct sig_pri_chan *p)
 277 {
 278         if (sig_pri_callbacks.get_orig_dialstring) {
 279                 return sig_pri_callbacks.get_orig_dialstring(p->chan_pvt);
 280         }
 281         ast_log(LOG_ERROR, "get_orig_dialstring callback not defined\n");
 282         return "";
 283 }
 284
 285 #if defined(HAVE_PRI_CCSS)
 286 static void sig_pri_make_cc_dialstring(struct sig_pri_chan *p, char *buf, size_t buf_size)
 287 {
 288         if (sig_pri_callbacks.make_cc_dialstring) {
 289                 sig_pri_callbacks.make_cc_dialstring(p->chan_pvt, buf, buf_size);
 290         } else {
 291                 ast_log(LOG_ERROR, "make_cc_dialstring callback not defined\n");
 292                 buf[0] = '\0';
 293         }
 294 }
 295 #endif  /* defined(HAVE_PRI_CCSS) */
 296
 297 static void sig_pri_dial_digits(struct sig_pri_chan *p, const char *dial_string)
 298 {
 299         if (sig_pri_callbacks.dial_digits) {
 300                 sig_pri_callbacks.dial_digits(p->chan_pvt, dial_string);
 301         }
 302 }
 303
 304 /*!
 305  * \internal
 306  * \brief Reevaluate the PRI span device state.
 307  * \since 1.8
 308  *
 309  * \param pri PRI span control structure.
 310  *
 311  * \return Nothing
 312  *
 313  * \note Assumes the pri->lock is already obtained.
 314  */
 315 static void sig_pri_span_devstate_changed(struct sig_pri_span *pri)
 316 {
 317         if (sig_pri_callbacks.update_span_devstate) {
 318                 sig_pri_callbacks.update_span_devstate(pri);
 319         }
 320 }
 321
 322 /*!
 323  * \internal
 324  * \brief Set the caller id information in the parent module.
 325  * \since 1.8
 326  *
 327  * \param p sig_pri channel structure.
 328  *
 329  * \return Nothing
 330  */
 331 static void sig_pri_set_caller_id(struct sig_pri_chan *p)
 332 {
 333         struct ast_party_caller caller;
 334
 335         if (sig_pri_callbacks.set_callerid) {
 336                 ast_party_caller_init(&caller);
 337
 338                 caller.id.name.str = p->cid_name;
 339                 caller.id.name.presentation = p->callingpres;
 340                 caller.id.name.valid = 1;
 341
 342                 caller.id.number.str = p->cid_num;
 343                 caller.id.number.plan = p->cid_ton;
 344                 caller.id.number.presentation = p->callingpres;
 345                 caller.id.number.valid = 1;
 346
 347                 if (!ast_strlen_zero(p->cid_subaddr)) {
 348                         caller.id.subaddress.valid = 1;
 349                         //caller.id.subaddress.type = 0;/* nsap */
 350                         //caller.id.subaddress.odd_even_indicator = 0;
 351                         caller.id.subaddress.str = p->cid_subaddr;
 352                 }
 353                 caller.id.tag = p->user_tag;
 354
 355                 caller.ani.number.str = p->cid_ani;
 356                 //caller.ani.number.plan = p->xxx;
 357                 //caller.ani.number.presentation = p->xxx;
 358                 caller.ani.number.valid = 1;
 359
 360                 caller.ani2 = p->cid_ani2;
 361                 sig_pri_callbacks.set_callerid(p->chan_pvt, &caller);
 362         }
 363 }
 364
 365 /*!
 366  * \internal
 367  * \brief Set the Dialed Number Identifier.
 368  * \since 1.8
 369  *
 370  * \param p sig_pri channel structure.
 371  * \param dnid Dialed Number Identifier string.
 372  *
 373  * \return Nothing
 374  */
 375 static void sig_pri_set_dnid(struct sig_pri_chan *p, const char *dnid)
 376 {
 377         if (sig_pri_callbacks.set_dnid) {
 378                 sig_pri_callbacks.set_dnid(p->chan_pvt, dnid);
 379         }
 380 }
 381
 382 /*!
 383  * \internal
 384  * \brief Set the Redirecting Directory Number Information Service (RDNIS).
 385  * \since 1.8
 386  *
 387  * \param p sig_pri channel structure.
 388  * \param rdnis Redirecting Directory Number Information Service (RDNIS) string.
 389  *
 390  * \return Nothing
 391  */
 392 static void sig_pri_set_rdnis(struct sig_pri_chan *p, const char *rdnis)
 393 {
 394         if (sig_pri_callbacks.set_rdnis) {
 395                 sig_pri_callbacks.set_rdnis(p->chan_pvt, rdnis);
 396         }
 397 }
 398
 399 static void sig_pri_unlock_private(struct sig_pri_chan *p)
 400 {
 401         if (sig_pri_callbacks.unlock_private) {
 402                 sig_pri_callbacks.unlock_private(p->chan_pvt);
 403         }
 404 }
 405
 406 static void sig_pri_lock_private(struct sig_pri_chan *p)
 407 {
 408         if (sig_pri_callbacks.lock_private) {
 409                 sig_pri_callbacks.lock_private(p->chan_pvt);
 410         }
 411 }
 412
 413 static void sig_pri_deadlock_avoidance_private(struct sig_pri_chan *p)
 414 {
 415         if (sig_pri_callbacks.deadlock_avoidance_private) {
 416                 sig_pri_callbacks.deadlock_avoidance_private(p->chan_pvt);
 417         } else {
 418                 /* Fallback to the old way if callback not present. */
 419                 sig_pri_unlock_private(p);
 420                 sched_yield();
 421                 sig_pri_lock_private(p);
 422         }
 423 }
 424
 425 static void pri_grab(struct sig_pri_chan *p, struct sig_pri_span *pri)
 426 {
 427         /* Grab the lock first */
 428         while (ast_mutex_trylock(&pri->lock)) {
 429                 /* Avoid deadlock */
 430                 sig_pri_deadlock_avoidance_private(p);
 431         }
 432         /* Then break the poll */
 433         if (pri->master != AST_PTHREADT_NULL) {
 434                 pthread_kill(pri->master, SIGURG);
 435         }
 436 }
 437
 438 /*!
 439  * \internal
 440  * \brief Convert PRI redirecting reason to asterisk version.
 441  * \since 1.8
 442  *
 443  * \param pri_reason PRI redirecting reason.
 444  *
 445  * \return Equivalent asterisk redirecting reason value.
 446  */
 447 static enum AST_REDIRECTING_REASON pri_to_ast_reason(int pri_reason)
 448 {
 449         enum AST_REDIRECTING_REASON ast_reason;
 450
 451         switch (pri_reason) {
 452         case PRI_REDIR_FORWARD_ON_BUSY:
 453                 ast_reason = AST_REDIRECTING_REASON_USER_BUSY;
 454                 break;
 455         case PRI_REDIR_FORWARD_ON_NO_REPLY:
 456                 ast_reason = AST_REDIRECTING_REASON_NO_ANSWER;
 457                 break;
 458         case PRI_REDIR_DEFLECTION:
 459                 ast_reason = AST_REDIRECTING_REASON_DEFLECTION;
 460                 break;
 461         case PRI_REDIR_UNCONDITIONAL:
 462                 ast_reason = AST_REDIRECTING_REASON_UNCONDITIONAL;
 463                 break;
 464         case PRI_REDIR_UNKNOWN:
 465         default:
 466                 ast_reason = AST_REDIRECTING_REASON_UNKNOWN;
 467                 break;
 468         }
 469
 470         return ast_reason;
 471 }
 472
 473 /*!
 474  * \internal
 475  * \brief Convert asterisk redirecting reason to PRI version.
 476  * \since 1.8
 477  *
 478  * \param ast_reason Asterisk redirecting reason.
 479  *
 480  * \return Equivalent PRI redirecting reason value.
 481  */
 482 static int ast_to_pri_reason(enum AST_REDIRECTING_REASON ast_reason)
 483 {
 484         int pri_reason;
 485
 486         switch (ast_reason) {
 487         case AST_REDIRECTING_REASON_USER_BUSY:
 488                 pri_reason = PRI_REDIR_FORWARD_ON_BUSY;
 489                 break;
 490         case AST_REDIRECTING_REASON_NO_ANSWER:
 491                 pri_reason = PRI_REDIR_FORWARD_ON_NO_REPLY;
 492                 break;
 493         case AST_REDIRECTING_REASON_UNCONDITIONAL:
 494                 pri_reason = PRI_REDIR_UNCONDITIONAL;
 495                 break;
 496         case AST_REDIRECTING_REASON_DEFLECTION:
 497                 pri_reason = PRI_REDIR_DEFLECTION;
 498                 break;
 499         case AST_REDIRECTING_REASON_UNKNOWN:
 500         default:
 501                 pri_reason = PRI_REDIR_UNKNOWN;
 502                 break;
 503         }
 504
 505         return pri_reason;
 506 }
 507
 508 /*!
 509  * \internal
 510  * \brief Convert PRI number presentation to asterisk version.
 511  * \since 1.8
 512  *
 513  * \param pri_presentation PRI number presentation.
 514  *
 515  * \return Equivalent asterisk number presentation value.
 516  */
 517 static int pri_to_ast_presentation(int pri_presentation)
 518 {
 519         int ast_presentation;
 520
 521         switch (pri_presentation) {
 522         case PRI_PRES_ALLOWED | PRI_PRES_USER_NUMBER_UNSCREENED:
 523                 ast_presentation = AST_PRES_ALLOWED | AST_PRES_USER_NUMBER_UNSCREENED;
 524                 break;
 525         case PRI_PRES_ALLOWED | PRI_PRES_USER_NUMBER_PASSED_SCREEN:
 526                 ast_presentation = AST_PRES_ALLOWED | AST_PRES_USER_NUMBER_PASSED_SCREEN;
 527                 break;
 528         case PRI_PRES_ALLOWED | PRI_PRES_USER_NUMBER_FAILED_SCREEN:
 529                 ast_presentation = AST_PRES_ALLOWED | AST_PRES_USER_NUMBER_FAILED_SCREEN;
 530                 break;
 531         case PRI_PRES_ALLOWED | PRI_PRES_NETWORK_NUMBER:
 532                 ast_presentation = AST_PRES_ALLOWED | AST_PRES_NETWORK_NUMBER;
 533                 break;
 534
 535         case PRI_PRES_RESTRICTED | PRI_PRES_USER_NUMBER_UNSCREENED:
 536                 ast_presentation = AST_PRES_RESTRICTED | AST_PRES_USER_NUMBER_UNSCREENED;
 537                 break;
 538         case PRI_PRES_RESTRICTED | PRI_PRES_USER_NUMBER_PASSED_SCREEN:
 539                 ast_presentation = AST_PRES_RESTRICTED | AST_PRES_USER_NUMBER_PASSED_SCREEN;
 540                 break;
 541         case PRI_PRES_RESTRICTED | PRI_PRES_USER_NUMBER_FAILED_SCREEN:
 542                 ast_presentation = AST_PRES_RESTRICTED | AST_PRES_USER_NUMBER_FAILED_SCREEN;
 543                 break;
 544         case PRI_PRES_RESTRICTED | PRI_PRES_NETWORK_NUMBER:
 545                 ast_presentation = AST_PRES_RESTRICTED | AST_PRES_NETWORK_NUMBER;
 546                 break;
 547
 548         case PRI_PRES_UNAVAILABLE | PRI_PRES_USER_NUMBER_UNSCREENED:
 549         case PRI_PRES_UNAVAILABLE | PRI_PRES_USER_NUMBER_PASSED_SCREEN:
 550         case PRI_PRES_UNAVAILABLE | PRI_PRES_USER_NUMBER_FAILED_SCREEN:
 551         case PRI_PRES_UNAVAILABLE | PRI_PRES_NETWORK_NUMBER:
 552                 ast_presentation = AST_PRES_NUMBER_NOT_AVAILABLE;
 553                 break;
 554
 555         default:
 556                 ast_presentation = AST_PRES_RESTRICTED | AST_PRES_USER_NUMBER_UNSCREENED;
 557                 break;
 558         }
 559
 560         return ast_presentation;
 561 }
 562
 563 /*!
 564  * \internal
 565  * \brief Convert asterisk number presentation to PRI version.
 566  * \since 1.8
 567  *
 568  * \param ast_presentation Asterisk number presentation.
 569  *
 570  * \return Equivalent PRI number presentation value.
 571  */
 572 static int ast_to_pri_presentation(int ast_presentation)
 573 {
 574         int pri_presentation;
 575
 576         switch (ast_presentation) {
 577         case AST_PRES_ALLOWED | AST_PRES_USER_NUMBER_UNSCREENED:
 578                 pri_presentation = PRI_PRES_ALLOWED | PRI_PRES_USER_NUMBER_UNSCREENED;
 579                 break;
 580         case AST_PRES_ALLOWED | AST_PRES_USER_NUMBER_PASSED_SCREEN:
 581                 pri_presentation = PRI_PRES_ALLOWED | PRI_PRES_USER_NUMBER_PASSED_SCREEN;
 582                 break;
 583         case AST_PRES_ALLOWED | AST_PRES_USER_NUMBER_FAILED_SCREEN:
 584                 pri_presentation = PRI_PRES_ALLOWED | PRI_PRES_USER_NUMBER_FAILED_SCREEN;
 585                 break;
 586         case AST_PRES_ALLOWED | AST_PRES_NETWORK_NUMBER:
 587                 pri_presentation = PRI_PRES_ALLOWED | PRI_PRES_NETWORK_NUMBER;
 588                 break;
 589
 590         case AST_PRES_RESTRICTED | AST_PRES_USER_NUMBER_UNSCREENED:
 591                 pri_presentation = PRI_PRES_RESTRICTED | PRI_PRES_USER_NUMBER_UNSCREENED;
 592                 break;
 593         case AST_PRES_RESTRICTED | AST_PRES_USER_NUMBER_PASSED_SCREEN:
 594                 pri_presentation = PRI_PRES_RESTRICTED | PRI_PRES_USER_NUMBER_PASSED_SCREEN;
 595                 break;
 596         case AST_PRES_RESTRICTED | AST_PRES_USER_NUMBER_FAILED_SCREEN:
 597                 pri_presentation = PRI_PRES_RESTRICTED | PRI_PRES_USER_NUMBER_FAILED_SCREEN;
 598                 break;
 599         case AST_PRES_RESTRICTED | AST_PRES_NETWORK_NUMBER:
 600                 pri_presentation = PRI_PRES_RESTRICTED | PRI_PRES_NETWORK_NUMBER;
 601                 break;
 602
 603         case AST_PRES_UNAVAILABLE | AST_PRES_USER_NUMBER_UNSCREENED:
 604         case AST_PRES_UNAVAILABLE | AST_PRES_USER_NUMBER_PASSED_SCREEN:
 605         case AST_PRES_UNAVAILABLE | AST_PRES_USER_NUMBER_FAILED_SCREEN:
 606         case AST_PRES_UNAVAILABLE | AST_PRES_NETWORK_NUMBER:
 607                 pri_presentation = PRES_NUMBER_NOT_AVAILABLE;
 608                 break;
 609
 610         default:
 611                 pri_presentation = PRI_PRES_RESTRICTED | PRI_PRES_USER_NUMBER_UNSCREENED;
 612                 break;
 613         }
 614
 615         return pri_presentation;
 616 }
 617
 618 /*!
 619  * \internal
 620  * \brief Convert PRI name char_set to asterisk version.
 621  * \since 1.8
 622  *
 623  * \param pri_char_set PRI name char_set.
 624  *
 625  * \return Equivalent asterisk name char_set value.
 626  */
 627 static enum AST_PARTY_CHAR_SET pri_to_ast_char_set(int pri_char_set)
 628 {
 629         enum AST_PARTY_CHAR_SET ast_char_set;
 630
 631         switch (pri_char_set) {
 632         default:
 633         case PRI_CHAR_SET_UNKNOWN:
 634                 ast_char_set = AST_PARTY_CHAR_SET_UNKNOWN;
 635                 break;
 636         case PRI_CHAR_SET_ISO8859_1:
 637                 ast_char_set = AST_PARTY_CHAR_SET_ISO8859_1;
 638                 break;
 639         case PRI_CHAR_SET_WITHDRAWN:
 640                 ast_char_set = AST_PARTY_CHAR_SET_WITHDRAWN;
 641                 break;
 642         case PRI_CHAR_SET_ISO8859_2:
 643                 ast_char_set = AST_PARTY_CHAR_SET_ISO8859_2;
 644                 break;
 645         case PRI_CHAR_SET_ISO8859_3:
 646                 ast_char_set = AST_PARTY_CHAR_SET_ISO8859_3;
 647                 break;
 648         case PRI_CHAR_SET_ISO8859_4:
 649                 ast_char_set = AST_PARTY_CHAR_SET_ISO8859_4;
 650                 break;
 651         case PRI_CHAR_SET_ISO8859_5:
 652                 ast_char_set = AST_PARTY_CHAR_SET_ISO8859_5;
 653                 break;
 654         case PRI_CHAR_SET_ISO8859_7:
 655                 ast_char_set = AST_PARTY_CHAR_SET_ISO8859_7;
 656                 break;
 657         case PRI_CHAR_SET_ISO10646_BMPSTRING:
 658                 ast_char_set = AST_PARTY_CHAR_SET_ISO10646_BMPSTRING;
 659                 break;
 660         case PRI_CHAR_SET_ISO10646_UTF_8STRING:
 661                 ast_char_set = AST_PARTY_CHAR_SET_ISO10646_UTF_8STRING;
 662                 break;
 663         }
 664
 665         return ast_char_set;
 666 }
 667
 668 /*!
 669  * \internal
 670  * \brief Convert asterisk name char_set to PRI version.
 671  * \since 1.8
 672  *
 673  * \param ast_char_set Asterisk name char_set.
 674  *
 675  * \return Equivalent PRI name char_set value.
 676  */
 677 static int ast_to_pri_char_set(enum AST_PARTY_CHAR_SET ast_char_set)
 678 {
 679         int pri_char_set;
 680
 681         switch (ast_char_set) {
 682         default:
 683         case AST_PARTY_CHAR_SET_UNKNOWN:
 684                 pri_char_set = PRI_CHAR_SET_UNKNOWN;
 685                 break;
 686         case AST_PARTY_CHAR_SET_ISO8859_1:
 687                 pri_char_set = PRI_CHAR_SET_ISO8859_1;
 688                 break;
 689         case AST_PARTY_CHAR_SET_WITHDRAWN:
 690                 pri_char_set = PRI_CHAR_SET_WITHDRAWN;
 691                 break;
 692         case AST_PARTY_CHAR_SET_ISO8859_2:
 693                 pri_char_set = PRI_CHAR_SET_ISO8859_2;
 694                 break;
 695         case AST_PARTY_CHAR_SET_ISO8859_3:
 696                 pri_char_set = PRI_CHAR_SET_ISO8859_3;
 697                 break;
 698         case AST_PARTY_CHAR_SET_ISO8859_4:
 699                 pri_char_set = PRI_CHAR_SET_ISO8859_4;
 700                 break;
 701         case AST_PARTY_CHAR_SET_ISO8859_5:
 702                 pri_char_set = PRI_CHAR_SET_ISO8859_5;
 703                 break;
 704         case AST_PARTY_CHAR_SET_ISO8859_7:
 705                 pri_char_set = PRI_CHAR_SET_ISO8859_7;
 706                 break;
 707         case AST_PARTY_CHAR_SET_ISO10646_BMPSTRING:
 708                 pri_char_set = PRI_CHAR_SET_ISO10646_BMPSTRING;
 709                 break;
 710         case AST_PARTY_CHAR_SET_ISO10646_UTF_8STRING:
 711                 pri_char_set = PRI_CHAR_SET_ISO10646_UTF_8STRING;
 712                 break;
 713         }
 714
 715         return pri_char_set;
 716 }
 717
 718 #if defined(HAVE_PRI_SUBADDR)
 719 /*!
 720  * \internal
 721  * \brief Fill in the asterisk party subaddress from the given PRI party subaddress.
 722  * \since 1.8
 723  *
 724  * \param ast_subaddress Asterisk party subaddress structure.
 725  * \param pri_subaddress PRI party subaddress structure.
 726  *
 727  * \return Nothing
 728  *
 729  */
 730 static void sig_pri_set_subaddress(struct ast_party_subaddress *ast_subaddress, const struct pri_party_subaddress *pri_subaddress)
 731 {
 732         ast_free(ast_subaddress->str);
 733         if (pri_subaddress->length <= 0) {
 734                 ast_party_subaddress_init(ast_subaddress);
 735                 return;
 736         }
 737
 738         if (!pri_subaddress->type) {
 739                 /* NSAP */
 740                 ast_subaddress->str = ast_strdup((char *) pri_subaddress->data);
 741         } else {
 742                 char *cnum;
 743                 char *ptr;
 744                 int x;
 745                 int len;
 746
 747                 /* User Specified */
 748                 cnum = ast_malloc(2 * pri_subaddress->length + 1);
 749                 if (!cnum) {
 750                         ast_party_subaddress_init(ast_subaddress);
 751                         return;
 752                 }
 753
 754                 ptr = cnum;
 755                 len = pri_subaddress->length - 1; /* -1 account for zero based indexing */
 756                 for (x = 0; x < len; ++x) {
 757                         ptr += sprintf(ptr, "%02hhx", (unsigned char)pri_subaddress->data[x]);
 758                 }
 759
 760                 if (pri_subaddress->odd_even_indicator) {
 761                         /* ODD */
 762                         sprintf(ptr, "%01hhx", (unsigned char)((pri_subaddress->data[len]) >> 4));
 763                 } else {
 764                         /* EVEN */
 765                         sprintf(ptr, "%02hhx", (unsigned char)pri_subaddress->data[len]);
 766                 }
 767                 ast_subaddress->str = cnum;
 768         }
 769         ast_subaddress->type = pri_subaddress->type;
 770         ast_subaddress->odd_even_indicator = pri_subaddress->odd_even_indicator;
 771         ast_subaddress->valid = 1;
 772 }
 773 #endif  /* defined(HAVE_PRI_SUBADDR) */
 774
 775 #if defined(HAVE_PRI_SUBADDR)
 776 static unsigned char ast_pri_pack_hex_char(char c)
 777 {
 778         unsigned char res;
 779
 780         if (c < '0') {
 781                 res = 0;
 782         } else if (c < ('9' + 1)) {
 783                 res = c - '0';
 784         } else if (c < 'A') {
 785                 res = 0;
 786         } else if (c < ('F' + 1)) {
 787                 res = c - 'A' + 10;
 788         } else if (c < 'a') {
 789                 res = 0;
 790         } else if (c < ('f' + 1)) {
 791                 res = c - 'a' + 10;
 792         } else {
 793                 res = 0;
 794         }
 795         return res;
 796 }
 797 #endif  /* defined(HAVE_PRI_SUBADDR) */
 798
 799 #if defined(HAVE_PRI_SUBADDR)
 800 /*!
 801  * \internal
 802  * \brief Convert a null terminated hexadecimal string to a packed hex byte array.
 803  * \details left justified, with 0 padding if odd length.
 804  * \since 1.8
 805  *
 806  * \param dst pointer to packed byte array.
 807  * \param src pointer to null terminated hexadecimal string.
 808  * \param maxlen destination array size.
 809  *
 810  * \return Length of byte array
 811  *
 812  * \note The dst is not an ASCIIz string.
 813  * \note The src is an ASCIIz hex string.
 814  */
 815 static int ast_pri_pack_hex_string(unsigned char *dst, char *src, int maxlen)
 816 {
 817         int res = 0;
 818         int len = strlen(src);
 819
 820         if (len > (2 * maxlen)) {
 821                 len = 2 * maxlen;
 822         }
 823
 824         res = len / 2 + len % 2;
 825
 826         while (len > 1) {
 827                 *dst = ast_pri_pack_hex_char(*src) << 4;
 828                 src++;
 829                 *dst |= ast_pri_pack_hex_char(*src);
 830                 dst++, src++;
 831                 len -= 2;
 832         }
 833         if (len) { /* 1 left */
 834                 *dst = ast_pri_pack_hex_char(*src) << 4;
 835         }
 836         return res;
 837 }
 838 #endif  /* defined(HAVE_PRI_SUBADDR) */
 839
 840 #if defined(HAVE_PRI_SUBADDR)
 841 /*!
 842  * \internal
 843  * \brief Fill in the PRI party subaddress from the given asterisk party subaddress.
 844  * \since 1.8
 845  *
 846  * \param pri_subaddress PRI party subaddress structure.
 847  * \param ast_subaddress Asterisk party subaddress structure.
 848  *
 849  * \return Nothing
 850  *
 851  * \note Assumes that pri_subaddress has been previously memset to zero.
 852  */
 853 static void sig_pri_party_subaddress_from_ast(struct pri_party_subaddress *pri_subaddress, const struct ast_party_subaddress *ast_subaddress)
 854 {
 855         if (ast_subaddress->valid && !ast_strlen_zero(ast_subaddress->str)) {
 856                 pri_subaddress->type = ast_subaddress->type;
 857                 if (!ast_subaddress->type) {
 858                         /* 0 = NSAP */
 859                         ast_copy_string((char *) pri_subaddress->data, ast_subaddress->str,
 860                                 sizeof(pri_subaddress->data));
 861                         pri_subaddress->length = strlen((char *) pri_subaddress->data);
 862                         pri_subaddress->odd_even_indicator = 0;
 863                         pri_subaddress->valid = 1;
 864                 } else {
 865                         /* 2 = User Specified */
 866                         /*
 867                          * Copy HexString to packed HexData,
 868                          * if odd length then right pad trailing byte with 0
 869                          */
 870                         int length = ast_pri_pack_hex_string(pri_subaddress->data,
 871                                 ast_subaddress->str, sizeof(pri_subaddress->data));
 872
 873                         pri_subaddress->length = length; /* packed data length */
 874
 875                         length = strlen(ast_subaddress->str);
 876                         if (length > 2 * sizeof(pri_subaddress->data)) {
 877                                 pri_subaddress->odd_even_indicator = 0;
 878                         } else {
 879                                 pri_subaddress->odd_even_indicator = (length & 1);
 880                         }
 881                         pri_subaddress->valid = 1;
 882                 }
 883         }
 884 }
 885 #endif  /* defined(HAVE_PRI_SUBADDR) */
 886
 887 /*!
 888  * \internal
 889  * \brief Fill in the PRI party name from the given asterisk party name.
 890  * \since 1.8
 891  *
 892  * \param pri_name PRI party name structure.
 893  * \param ast_name Asterisk party name structure.
 894  *
 895  * \return Nothing
 896  *
 897  * \note Assumes that pri_name has been previously memset to zero.
 898  */
 899 static void sig_pri_party_name_from_ast(struct pri_party_name *pri_name, const struct ast_party_name *ast_name)
 900 {
 901         if (!ast_name->valid) {
 902                 return;
 903         }
 904         pri_name->valid = 1;
 905         pri_name->presentation = ast_to_pri_presentation(ast_name->presentation);
 906         pri_name->char_set = ast_to_pri_char_set(ast_name->char_set);
 907         if (!ast_strlen_zero(ast_name->str)) {
 908                 ast_copy_string(pri_name->str, ast_name->str, sizeof(pri_name->str));
 909         }
 910 }
 911
 912 /*!
 913  * \internal
 914  * \brief Fill in the PRI party number from the given asterisk party number.
 915  * \since 1.8
 916  *
 917  * \param pri_number PRI party number structure.
 918  * \param ast_number Asterisk party number structure.
 919  *
 920  * \return Nothing
 921  *
 922  * \note Assumes that pri_number has been previously memset to zero.
 923  */
 924 static void sig_pri_party_number_from_ast(struct pri_party_number *pri_number, const struct ast_party_number *ast_number)
 925 {
 926         if (!ast_number->valid) {
 927                 return;
 928         }
 929         pri_number->valid = 1;
 930         pri_number->presentation = ast_to_pri_presentation(ast_number->presentation);
 931         pri_number->plan = ast_number->plan;
 932         if (!ast_strlen_zero(ast_number->str)) {
 933                 ast_copy_string(pri_number->str, ast_number->str, sizeof(pri_number->str));
 934         }
 935 }
 936
 937 /*!
 938  * \internal
 939  * \brief Fill in the PRI party id from the given asterisk party id.
 940  * \since 1.8
 941  *
 942  * \param pri_id PRI party id structure.
 943  * \param ast_id Asterisk party id structure.
 944  *
 945  * \return Nothing
 946  *
 947  * \note Assumes that pri_id has been previously memset to zero.
 948  */
 949 static void sig_pri_party_id_from_ast(struct pri_party_id *pri_id, const struct ast_party_id *ast_id)
 950 {
 951         sig_pri_party_name_from_ast(&pri_id->name, &ast_id->name);
 952         sig_pri_party_number_from_ast(&pri_id->number, &ast_id->number);
 953 #if defined(HAVE_PRI_SUBADDR)
 954         sig_pri_party_subaddress_from_ast(&pri_id->subaddress, &ast_id->subaddress);
 955 #endif  /* defined(HAVE_PRI_SUBADDR) */
 956 }
 957
 958 /*!
 959  * \internal
 960  * \brief Update the PRI redirecting information for the current call.
 961  * \since 1.8
 962  *
 963  * \param pvt sig_pri private channel structure.
 964  * \param ast Asterisk channel
 965  *
 966  * \return Nothing
 967  *
 968  * \note Assumes that the PRI lock is already obtained.
 969  */
 970 static void sig_pri_redirecting_update(struct sig_pri_chan *pvt, struct ast_channel *ast)
 971 {
 972         struct pri_party_redirecting pri_redirecting;
 973         const struct ast_party_redirecting *ast_redirecting;
 974         struct ast_party_id redirecting_from = ast_channel_redirecting_effective_from(ast);
 975         struct ast_party_id redirecting_to = ast_channel_redirecting_effective_to(ast);
 976         struct ast_party_id redirecting_orig = ast_channel_redirecting_effective_orig(ast);
 977
 978         memset(&pri_redirecting, 0, sizeof(pri_redirecting));
 979         ast_redirecting = ast_channel_redirecting(ast);
 980         sig_pri_party_id_from_ast(&pri_redirecting.from, &redirecting_from);
 981         sig_pri_party_id_from_ast(&pri_redirecting.to, &redirecting_to);
 982         sig_pri_party_id_from_ast(&pri_redirecting.orig_called, &redirecting_orig);
 983         pri_redirecting.count = ast_redirecting->count;
 984         pri_redirecting.orig_reason = ast_to_pri_reason(ast_redirecting->orig_reason.code);
 985         pri_redirecting.reason = ast_to_pri_reason(ast_redirecting->reason.code);
 986
 987         pri_redirecting_update(pvt->pri->pri, pvt->call, &pri_redirecting);
 988 }
 989
 990 /*!
 991  * \internal
 992  * \brief Reset DTMF detector.
 993  * \since 1.8
 994  *
 995  * \param p sig_pri channel structure.
 996  *
 997  * \return Nothing
 998  */
 999 static void sig_pri_dsp_reset_and_flush_digits(struct sig_pri_chan *p)
1000 {
1001         if (sig_pri_callbacks.dsp_reset_and_flush_digits) {
1002                 sig_pri_callbacks.dsp_reset_and_flush_digits(p->chan_pvt);
1003         }
1004 }
1005
1006 static int sig_pri_set_echocanceller(struct sig_pri_chan *p, int enable)
1007 {
1008         if (sig_pri_callbacks.set_echocanceller) {
1009                 return sig_pri_callbacks.set_echocanceller(p->chan_pvt, enable);
1010         } else {
1011                 return -1;
1012         }
1013 }
1014
1015 static void sig_pri_fixup_chans(struct sig_pri_chan *old_chan, struct sig_pri_chan *new_chan)
1016 {
1017         if (sig_pri_callbacks.fixup_chans) {
1018                 sig_pri_callbacks.fixup_chans(old_chan->chan_pvt, new_chan->chan_pvt);
1019         }
1020 }
1021
1022 static int sig_pri_play_tone(struct sig_pri_chan *p, enum sig_pri_tone tone)
1023 {
1024         if (sig_pri_callbacks.play_tone) {
1025                 return sig_pri_callbacks.play_tone(p->chan_pvt, tone);
1026         } else {
1027                 return -1;
1028         }
1029 }
1030
1031 static struct ast_channel *sig_pri_new_ast_channel(struct sig_pri_chan *p, int state,
1032         enum sig_pri_law law, int transfercapability, char *exten,
1033         const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor)
1034 {
1035         struct ast_channel *c;
1036
1037         if (sig_pri_callbacks.new_ast_channel) {
1038                 c = sig_pri_callbacks.new_ast_channel(p->chan_pvt, state, law, exten, assignedids, requestor);
1039         } else {
1040                 return NULL;
1041         }
1042         if (!c) {
1043                 return NULL;
1044         }
1045
1046         ast_assert(p->owner == NULL || p->owner == c);
1047         p->owner = c;
1048         p->isidlecall = 0;
1049         p->alreadyhungup = 0;
1050         ast_channel_transfercapability_set(c, transfercapability);
1051         pbx_builtin_setvar_helper(c, "TRANSFERCAPABILITY",
1052                 ast_transfercapability2str(transfercapability));
1053         if (transfercapability & AST_TRANS_CAP_DIGITAL) {
1054                 sig_pri_set_digital(p, 1);
1055         }
1056         if (p->pri) {
1057                 ast_mutex_lock(&p->pri->lock);
1058                 sig_pri_span_devstate_changed(p->pri);
1059                 ast_mutex_unlock(&p->pri->lock);
1060         }
1061
1062         return c;
1063 }
1064
1065 /*!
1066  * \internal
1067  * \brief Open the PRI channel media path.
1068  * \since 1.8
1069  *
1070  * \param p Channel private control structure.
1071  *
1072  * \return Nothing
1073  */
1074 static void sig_pri_open_media(struct sig_pri_chan *p)
1075 {
1076         if (p->no_b_channel) {
1077                 return;
1078         }
1079
1080         if (sig_pri_callbacks.open_media) {
1081                 sig_pri_callbacks.open_media(p->chan_pvt);
1082         }
1083 }
1084
1085 /*!
1086  * \internal
1087  * \brief Post an AMI B channel association event.
1088  * \since 1.8
1089  *
1090  * \param p Channel private control structure.
1091  *
1092  * \note Assumes the private and owner are locked.
1093  *
1094  * \return Nothing
1095  */
1096 static void sig_pri_ami_channel_event(struct sig_pri_chan *p)
1097 {
1098         if (sig_pri_callbacks.ami_channel_event) {
1099                 sig_pri_callbacks.ami_channel_event(p->chan_pvt, p->owner);
1100         }
1101 }
1102
1103 struct ast_channel *sig_pri_request(struct sig_pri_chan *p, enum sig_pri_law law,
1104         const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor,
1105         int transfercapability)
1106 {
1107         struct ast_channel *ast;
1108
1109         ast_debug(1, "%s %d\n", __FUNCTION__, p->channel);
1110
1111         sig_pri_set_outgoing(p, 1);
1112         ast = sig_pri_new_ast_channel(p, AST_STATE_RESERVED, law, transfercapability,
1113                 p->exten, assignedids, requestor);
1114         if (!ast) {
1115                 sig_pri_set_outgoing(p, 0);
1116         }
1117         return ast;
1118 }
1119
1120 int pri_is_up(struct sig_pri_span *pri)
1121 {
1122         int x;
1123         for (x = 0; x < SIG_PRI_NUM_DCHANS; x++) {
1124                 if (pri->dchanavail[x] == DCHAN_AVAILABLE)
1125                         return 1;
1126         }
1127         return 0;
1128 }
1129
1130 static const char *pri_order(int level)
1131 {
1132         switch (level) {
1133         case 0:
1134                 return "Primary";
1135         case 1:
1136                 return "Secondary";
1137         case 2:
1138                 return "Tertiary";
1139         case 3:
1140                 return "Quaternary";
1141         default:
1142                 return "<Unknown>";
1143         }
1144 }
1145
1146 /* Returns index of the active dchan */
1147 static int pri_active_dchan_index(struct sig_pri_span *pri)
1148 {
1149         int x;
1150
1151         for (x = 0; x < SIG_PRI_NUM_DCHANS; x++) {
1152                 if ((pri->dchans[x] == pri->pri))
1153                         return x;
1154         }
1155
1156         ast_log(LOG_WARNING, "No active dchan found!\n");
1157         return -1;
1158 }
1159
1160 static void pri_find_dchan(struct sig_pri_span *pri)
1161 {
1162         struct pri *old;
1163         int oldslot = -1;
1164         int newslot = -1;
1165         int idx;
1166
1167         old = pri->pri;
1168         for (idx = 0; idx < SIG_PRI_NUM_DCHANS; ++idx) {
1169                 if (!pri->dchans[idx]) {
1170                         /* No more D channels defined on the span. */
1171                         break;
1172                 }
1173                 if (pri->dchans[idx] == old) {
1174                         oldslot = idx;
1175                 }
1176                 if (newslot < 0 && pri->dchanavail[idx] == DCHAN_AVAILABLE) {
1177                         newslot = idx;
1178                 }
1179         }
1180         /* At this point, idx is a count of how many D-channels are defined on the span. */
1181
1182         if (1 < idx) {
1183                 /* We have several D-channels defined on the span.  (NFAS PRI setup) */
1184                 if (newslot < 0) {
1185                         /* No D-channels available.  Default to the primary D-channel. */
1186                         newslot = 0;
1187
1188                         if (!pri->no_d_channels) {
1189                                 pri->no_d_channels = 1;
1190                                 if (old && oldslot != newslot) {
1191                                         ast_log(LOG_WARNING,
1192                                                 "Span %d: No D-channels up!  Switching selected D-channel from %s to %s.\n",
1193                                                 pri->span, pri_order(oldslot), pri_order(newslot));
1194                                 } else {
1195                                         ast_log(LOG_WARNING, "Span %d: No D-channels up!\n", pri->span);
1196                                 }
1197                         }
1198                 } else {
1199                         pri->no_d_channels = 0;
1200                 }
1201                 if (old && oldslot != newslot) {
1202                         ast_log(LOG_NOTICE,
1203                                 "Switching selected D-channel from %s (fd %d) to %s (fd %d)!\n",
1204                                 pri_order(oldslot), pri->fds[oldslot],
1205                                 pri_order(newslot), pri->fds[newslot]);
1206                 }
1207         } else {
1208                 if (newslot < 0) {
1209                         /* The only D-channel is not up. */
1210                         newslot = 0;
1211
1212                         if (!pri->no_d_channels) {
1213                                 pri->no_d_channels = 1;
1214
1215                                 /*
1216                                  * This is annoying to see on non-persistent layer 2
1217                                  * connections.  Let's not complain in that case.
1218                                  */
1219                                 if (pri->sig != SIG_BRI_PTMP) {
1220                                         ast_log(LOG_WARNING, "Span %d: D-channel is down!\n", pri->span);
1221                                 }
1222                         }
1223                 } else {
1224                         pri->no_d_channels = 0;
1225                 }
1226         }
1227         pri->pri = pri->dchans[newslot];
1228 }
1229
1230 /*!
1231  * \internal
1232  * \brief Determine if a private channel structure is in use.
1233  * \since 1.8
1234  *
1235  * \param pvt Channel to determine if in use.
1236  *
1237  * \return TRUE if the channel is in use.
1238  */
1239 static int sig_pri_is_chan_in_use(struct sig_pri_chan *pvt)
1240 {
1241         return pvt->owner || pvt->call || pvt->allocated || pvt->inalarm
1242                 || pvt->resetting != SIG_PRI_RESET_IDLE;
1243 }
1244
1245 /*!
1246  * \brief Determine if a private channel structure is available.
1247  * \since 1.8
1248  *
1249  * \param pvt Channel to determine if available.
1250  *
1251  * \return TRUE if the channel is available.
1252  */
1253 int sig_pri_is_chan_available(struct sig_pri_chan *pvt)
1254 {
1255         return !sig_pri_is_chan_in_use(pvt)
1256 #if defined(HAVE_PRI_SERVICE_MESSAGES)
1257                 /* And not out-of-service */
1258                 && !pvt->service_status
1259 #endif  /* defined(HAVE_PRI_SERVICE_MESSAGES) */
1260                 ;
1261 }
1262
1263 /*!
1264  * \internal
1265  * \brief Obtain the sig_pri owner channel lock if the owner exists.
1266  * \since 1.8
1267  *
1268  * \param pri PRI span control structure.
1269  * \param chanpos Channel position in the span.
1270  *
1271  * \note Assumes the pri->lock is already obtained.
1272  * \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
1273  *
1274  * \return Nothing
1275  */
1276 static void sig_pri_lock_owner(struct sig_pri_span *pri, int chanpos)
1277 {
1278         for (;;) {
1279                 if (!pri->pvts[chanpos]->owner) {
1280                         /* There is no owner lock to get. */
1281                         break;
1282                 }
1283                 if (!ast_channel_trylock(pri->pvts[chanpos]->owner)) {
1284                         /* We got the lock */
1285                         break;
1286                 }
1287
1288                 /* Avoid deadlock */
1289                 sig_pri_unlock_private(pri->pvts[chanpos]);
1290                 DEADLOCK_AVOIDANCE(&pri->lock);
1291                 sig_pri_lock_private(pri->pvts[chanpos]);
1292         }
1293 }
1294
1295 /*!
1296  * \internal
1297  * \brief Queue the given frame onto the owner channel.
1298  * \since 1.8
1299  *
1300  * \param pri PRI span control structure.
1301  * \param chanpos Channel position in the span.
1302  * \param frame Frame to queue onto the owner channel.
1303  *
1304  * \note Assumes the pri->lock is already obtained.
1305  * \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
1306  *
1307  * \return Nothing
1308  */
1309 static void pri_queue_frame(struct sig_pri_span *pri, int chanpos, struct ast_frame *frame)
1310 {
1311         sig_pri_lock_owner(pri, chanpos);
1312         if (pri->pvts[chanpos]->owner) {
1313                 ast_queue_frame(pri->pvts[chanpos]->owner, frame);
1314                 ast_channel_unlock(pri->pvts[chanpos]->owner);
1315         }
1316 }
1317
1318 /*!
1319  * \internal
1320  * \brief Queue a hold frame onto the owner channel.
1321  * \since 12
1322  *
1323  * \param pri PRI span control structure.
1324  * \param chanpos Channel position in the span.
1325  *
1326  * \note Assumes the pri->lock is already obtained.
1327  * \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
1328  *
1329  * \return Nothing
1330  */
1331 static void sig_pri_queue_hold(struct sig_pri_span *pri, int chanpos)
1332 {
1333         sig_pri_lock_owner(pri, chanpos);
1334         if (pri->pvts[chanpos]->owner) {
1335                 ast_queue_hold(pri->pvts[chanpos]->owner, NULL);
1336                 ast_channel_unlock(pri->pvts[chanpos]->owner);
1337         }
1338 }
1339
1340 /*!
1341  * \internal
1342  * \brief Queue an unhold frame onto the owner channel.
1343  * \since 12
1344  *
1345  * \param pri PRI span control structure.
1346  * \param chanpos Channel position in the span.
1347  *
1348  * \note Assumes the pri->lock is already obtained.
1349  * \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
1350  *
1351  * \return Nothing
1352  */
1353 static void sig_pri_queue_unhold(struct sig_pri_span *pri, int chanpos)
1354 {
1355         sig_pri_lock_owner(pri, chanpos);
1356         if (pri->pvts[chanpos]->owner) {
1357                 ast_queue_unhold(pri->pvts[chanpos]->owner);
1358                 ast_channel_unlock(pri->pvts[chanpos]->owner);
1359         }
1360 }
1361
1362 /*!
1363  * \internal
1364  * \brief Queue a control frame of the specified subclass onto the owner channel.
1365  * \since 1.8
1366  *
1367  * \param pri PRI span control structure.
1368  * \param chanpos Channel position in the span.
1369  * \param subclass Control frame subclass to queue onto the owner channel.
1370  *
1371  * \note Assumes the pri->lock is already obtained.
1372  * \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
1373  *
1374  * \return Nothing
1375  */
1376 static void pri_queue_control(struct sig_pri_span *pri, int chanpos, int subclass)
1377 {
1378         struct ast_frame f = {AST_FRAME_CONTROL, };
1379         struct sig_pri_chan *p = pri->pvts[chanpos];
1380
1381         if (sig_pri_callbacks.queue_control) {
1382                 sig_pri_callbacks.queue_control(p->chan_pvt, subclass);
1383         }
1384
1385         f.subclass.integer = subclass;
1386         pri_queue_frame(pri, chanpos, &f);
1387 }
1388
1389 /*!
1390  * \internal
1391  * \brief Queue a PVT_CAUSE_CODE frame onto the owner channel.
1392  * \since 11
1393  *
1394  * \param pri PRI span control structure.
1395  * \param chanpos Channel position in the span.
1396  * \param cause String describing the cause to be placed into the frame.
1397  *
1398  * \note Assumes the pri->lock is already obtained.
1399  * \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
1400  *
1401  * \return Nothing
1402  */
1403 static void pri_queue_pvt_cause_data(struct sig_pri_span *pri, int chanpos, const char *cause, int ast_cause)
1404 {
1405         struct ast_channel *chan;
1406         struct ast_control_pvt_cause_code *cause_code;
1407
1408         sig_pri_lock_owner(pri, chanpos);
1409         chan = pri->pvts[chanpos]->owner;
1410         if (chan) {
1411                 int datalen = sizeof(*cause_code) + strlen(cause);
1412                 cause_code = ast_alloca(datalen);
1413                 memset(cause_code, 0, datalen);
1414                 cause_code->ast_cause = ast_cause;
1415                 ast_copy_string(cause_code->chan_name, ast_channel_name(chan), AST_CHANNEL_NAME);
1416                 ast_copy_string(cause_code->code, cause, datalen + 1 - sizeof(*cause_code));
1417                 ast_queue_control_data(chan, AST_CONTROL_PVT_CAUSE_CODE, cause_code, datalen);
1418                 ast_channel_hangupcause_hash_set(chan, cause_code, datalen);
1419                 ast_channel_unlock(chan);
1420         }
1421 }
1422
1423 /*!
1424  * \internal
1425  * \brief Find the channel associated with the libpri call.
1426  * \since 10.0
1427  *
1428  * \param pri PRI span control structure.
1429  * \param call LibPRI opaque call pointer to find.
1430  *
1431  * \note Assumes the pri->lock is already obtained.
1432  *
1433  * \retval array-index into private pointer array on success.
1434  * \retval -1 on error.
1435  */
1436 static int pri_find_principle_by_call(struct sig_pri_span *pri, q931_call *call)
1437 {
1438         int idx;
1439
1440         if (!call) {
1441                 /* Cannot find a call without a call. */
1442                 return -1;
1443         }
1444         for (idx = 0; idx < pri->numchans; ++idx) {
1445                 if (pri->pvts[idx] && pri->pvts[idx]->call == call) {
1446                         /* Found the principle */
1447                         return idx;
1448                 }
1449         }
1450         return -1;
1451 }
1452
1453 /*!
1454  * \internal
1455  * \brief Queue the span for destruction
1456  * \since 13.0
1457  *
1458  * \param pri PRI span control structure.
1459  *
1460  * Asks the channel driver to queue the span for destruction at a
1461  * possibly later time, if (e.g.) locking considerations don't allow
1462  * destroying it right now.
1463  *
1464  * \return Nothing
1465  */
1466 static void pri_destroy_later(struct sig_pri_span *pri)
1467 {
1468         if (!sig_pri_callbacks.destroy_later) {
1469                 return;
1470         }
1471         sig_pri_callbacks.destroy_later(pri);
1472 }
1473
1474 /*!
1475  * \internal
1476  * \brief Kill the call.
1477  * \since 10.0
1478  *
1479  * \param pri PRI span control structure.
1480  * \param call LibPRI opaque call pointer to find.
1481  * \param cause Reason call was killed.
1482  *
1483  * \note Assumes the pvt->pri->lock is already obtained.
1484  *
1485  * \return Nothing
1486  */
1487 static void sig_pri_kill_call(struct sig_pri_span *pri, q931_call *call, int cause)
1488 {
1489         int chanpos;
1490
1491         chanpos = pri_find_principle_by_call(pri, call);
1492         if (chanpos < 0) {
1493                 pri_hangup(pri->pri, call, cause);
1494                 return;
1495         }
1496         sig_pri_lock_private(pri->pvts[chanpos]);
1497         if (!pri->pvts[chanpos]->owner) {
1498                 pri_hangup(pri->pri, call, cause);
1499                 pri->pvts[chanpos]->call = NULL;
1500                 sig_pri_unlock_private(pri->pvts[chanpos]);
1501                 sig_pri_span_devstate_changed(pri);
1502                 return;
1503         }
1504         ast_channel_hangupcause_set(pri->pvts[chanpos]->owner, cause);
1505         pri_queue_control(pri, chanpos, AST_CONTROL_HANGUP);
1506         sig_pri_unlock_private(pri->pvts[chanpos]);
1507 }
1508
1509 /*!
1510  * \internal
1511  * \brief Find the private structure for the libpri call.
1512  *
1513  * \param pri PRI span control structure.
1514  * \param channel LibPRI encoded channel ID.
1515  * \param call LibPRI opaque call pointer.
1516  *
1517  * \note Assumes the pri->lock is already obtained.
1518  *
1519  * \retval array-index into private pointer array on success.
1520  * \retval -1 on error.
1521  */
1522 static int pri_find_principle(struct sig_pri_span *pri, int channel, q931_call *call)
1523 {
1524         int x;
1525         int span;
1526         int principle;
1527         int prioffset;
1528
1529         if (channel < 0) {
1530                 /* Channel is not picked yet. */
1531                 return -1;
1532         }
1533
1534         prioffset = PRI_CHANNEL(channel);
1535         if (!prioffset || (channel & PRI_HELD_CALL)) {
1536                 /* Find the call waiting call or held call. */
1537                 return pri_find_principle_by_call(pri, call);
1538         }
1539
1540         span = PRI_SPAN(channel);
1541         if (!(channel & PRI_EXPLICIT)) {
1542                 int index;
1543
1544                 index = pri_active_dchan_index(pri);
1545                 if (index == -1) {
1546                         return -1;
1547                 }
1548                 span = pri->dchan_logical_span[index];
1549         }
1550
1551         principle = -1;
1552         for (x = 0; x < pri->numchans; x++) {
1553                 if (pri->pvts[x]
1554                         && pri->pvts[x]->prioffset == prioffset
1555                         && pri->pvts[x]->logicalspan == span
1556                         && !pri->pvts[x]->no_b_channel) {
1557                         principle = x;
1558                         break;
1559                 }
1560         }
1561
1562         return principle;
1563 }
1564
1565 /*!
1566  * \internal
1567  * \brief Fixup the private structure associated with the libpri call.
1568  *
1569  * \param pri PRI span control structure.
1570  * \param principle Array-index into private array to move call to if not already there.
1571  * \param call LibPRI opaque call pointer to find if need to move call.
1572  *
1573  * \note Assumes the pri->lock is already obtained.
1574  *
1575  * \retval principle on success.
1576  * \retval -1 on error.
1577  */
1578 static int pri_fixup_principle(struct sig_pri_span *pri, int principle, q931_call *call)
1579 {
1580         int x;
1581
1582         if (principle < 0 || pri->numchans <= principle) {
1583                 /* Out of rannge */
1584                 return -1;
1585         }
1586         if (!call) {
1587                 /* No call */
1588                 return principle;
1589         }
1590         if (pri->pvts[principle] && pri->pvts[principle]->call == call) {
1591                 /* Call is already on the specified principle. */
1592                 return principle;
1593         }
1594
1595         /* Find the old principle location. */
1596         for (x = 0; x < pri->numchans; x++) {
1597                 struct sig_pri_chan *new_chan;
1598                 struct sig_pri_chan *old_chan;
1599
1600                 if (!pri->pvts[x] || pri->pvts[x]->call != call) {
1601                         continue;
1602                 }
1603
1604                 /* Found our call */
1605                 new_chan = pri->pvts[principle];
1606                 old_chan = pri->pvts[x];
1607
1608                 /* Get locks to safely move to the new private structure. */
1609                 sig_pri_lock_private(old_chan);
1610                 sig_pri_lock_owner(pri, x);
1611                 sig_pri_lock_private(new_chan);
1612
1613                 ast_verb(3, "Moving call (%s) from channel %d to %d.\n",
1614                         old_chan->owner ? ast_channel_name(old_chan->owner) : "",
1615                         old_chan->channel, new_chan->channel);
1616                 if (!sig_pri_is_chan_available(new_chan)) {
1617                         ast_log(LOG_WARNING,
1618                                 "Can't move call (%s) from channel %d to %d.  It is already in use.\n",
1619                                 old_chan->owner ? ast_channel_name(old_chan->owner) : "",
1620                                 old_chan->channel, new_chan->channel);
1621                         sig_pri_unlock_private(new_chan);
1622                         if (old_chan->owner) {
1623                                 ast_channel_unlock(old_chan->owner);
1624                         }
1625                         sig_pri_unlock_private(old_chan);
1626                         return -1;
1627                 }
1628
1629                 sig_pri_fixup_chans(old_chan, new_chan);
1630
1631                 /* Fix it all up now */
1632                 new_chan->owner = old_chan->owner;
1633                 old_chan->owner = NULL;
1634
1635                 new_chan->call = old_chan->call;
1636                 old_chan->call = NULL;
1637
1638                 /* Transfer flags from the old channel. */
1639 #if defined(HAVE_PRI_AOC_EVENTS)
1640                 new_chan->aoc_s_request_invoke_id_valid = old_chan->aoc_s_request_invoke_id_valid;
1641                 new_chan->waiting_for_aoce = old_chan->waiting_for_aoce;
1642                 new_chan->holding_aoce = old_chan->holding_aoce;
1643 #endif  /* defined(HAVE_PRI_AOC_EVENTS) */
1644                 new_chan->alreadyhungup = old_chan->alreadyhungup;
1645                 new_chan->isidlecall = old_chan->isidlecall;
1646                 new_chan->progress = old_chan->progress;
1647                 new_chan->allocated = old_chan->allocated;
1648                 new_chan->outgoing = old_chan->outgoing;
1649                 new_chan->digital = old_chan->digital;
1650 #if defined(HAVE_PRI_CALL_WAITING)
1651                 new_chan->is_call_waiting = old_chan->is_call_waiting;
1652 #endif  /* defined(HAVE_PRI_CALL_WAITING) */
1653 #if defined(HAVE_PRI_SETUP_ACK_INBAND)
1654                 new_chan->no_dialed_digits = old_chan->no_dialed_digits;
1655 #endif  /* defined(HAVE_PRI_SETUP_ACK_INBAND) */
1656
1657 #if defined(HAVE_PRI_AOC_EVENTS)
1658                 old_chan->aoc_s_request_invoke_id_valid = 0;
1659                 old_chan->waiting_for_aoce = 0;
1660                 old_chan->holding_aoce = 0;
1661 #endif  /* defined(HAVE_PRI_AOC_EVENTS) */
1662                 old_chan->alreadyhungup = 0;
1663                 old_chan->isidlecall = 0;
1664                 old_chan->progress = 0;
1665                 old_chan->allocated = 0;
1666                 old_chan->outgoing = 0;
1667                 old_chan->digital = 0;
1668 #if defined(HAVE_PRI_CALL_WAITING)
1669                 old_chan->is_call_waiting = 0;
1670 #endif  /* defined(HAVE_PRI_CALL_WAITING) */
1671 #if defined(HAVE_PRI_SETUP_ACK_INBAND)
1672                 old_chan->no_dialed_digits = 0;
1673 #endif  /* defined(HAVE_PRI_SETUP_ACK_INBAND) */
1674
1675                 /* More stuff to transfer to the new channel. */
1676                 new_chan->call_level = old_chan->call_level;
1677                 old_chan->call_level = SIG_PRI_CALL_LEVEL_IDLE;
1678 #if defined(HAVE_PRI_REVERSE_CHARGE)
1679                 new_chan->reverse_charging_indication = old_chan->reverse_charging_indication;
1680 #endif  /* defined(HAVE_PRI_REVERSE_CHARGE) */
1681 #if defined(HAVE_PRI_SETUP_KEYPAD)
1682                 strcpy(new_chan->keypad_digits, old_chan->keypad_digits);
1683 #endif  /* defined(HAVE_PRI_SETUP_KEYPAD) */
1684                 strcpy(new_chan->deferred_digits, old_chan->deferred_digits);
1685                 strcpy(new_chan->moh_suggested, old_chan->moh_suggested);
1686                 new_chan->moh_state = old_chan->moh_state;
1687                 old_chan->moh_state = SIG_PRI_MOH_STATE_IDLE;
1688 #if defined(HAVE_PRI_TRANSFER)
1689                 new_chan->xfer_data = old_chan->xfer_data;
1690                 old_chan->xfer_data = NULL;
1691 #endif  /* defined(HAVE_PRI_TRANSFER) */
1692
1693 #if defined(HAVE_PRI_AOC_EVENTS)
1694                 new_chan->aoc_s_request_invoke_id = old_chan->aoc_s_request_invoke_id;
1695                 new_chan->aoc_e = old_chan->aoc_e;
1696 #endif  /* defined(HAVE_PRI_AOC_EVENTS) */
1697                 strcpy(new_chan->user_tag, old_chan->user_tag);
1698
1699                 if (new_chan->no_b_channel) {
1700                         /* Copy the real channel configuration to the no B channel interface. */
1701                         new_chan->hidecallerid = old_chan->hidecallerid;
1702                         new_chan->hidecalleridname = old_chan->hidecalleridname;
1703                         new_chan->immediate = old_chan->immediate;
1704                         new_chan->priexclusive = old_chan->priexclusive;
1705                         new_chan->priindication_oob = old_chan->priindication_oob;
1706                         new_chan->use_callerid = old_chan->use_callerid;
1707                         new_chan->use_callingpres = old_chan->use_callingpres;
1708                         new_chan->stripmsd = old_chan->stripmsd;
1709                         strcpy(new_chan->context, old_chan->context);
1710                         strcpy(new_chan->mohinterpret, old_chan->mohinterpret);
1711
1712                         /* Become a member of the old channel span/trunk-group. */
1713                         new_chan->logicalspan = old_chan->logicalspan;
1714                         new_chan->mastertrunkgroup = old_chan->mastertrunkgroup;
1715                 } else if (old_chan->no_b_channel) {
1716                         /*
1717                          * We are transitioning from a held/call-waiting channel to a
1718                          * real channel so we need to make sure that the media path is
1719                          * open.  (Needed especially if the channel is natively
1720                          * bridged.)
1721                          */
1722                         sig_pri_open_media(new_chan);
1723                 }
1724
1725                 if (new_chan->owner) {
1726                         sig_pri_ami_channel_event(new_chan);
1727                 }
1728
1729                 sig_pri_unlock_private(old_chan);
1730                 if (new_chan->owner) {
1731                         ast_channel_unlock(new_chan->owner);
1732                 }
1733                 sig_pri_unlock_private(new_chan);
1734
1735                 return principle;
1736         }
1737         ast_verb(3, "Call specified, but not found.\n");
1738         return -1;
1739 }
1740
1741 /*!
1742  * \internal
1743  * \brief Find and fixup the private structure associated with the libpri call.
1744  *
1745  * \param pri PRI span control structure.
1746  * \param channel LibPRI encoded channel ID.
1747  * \param call LibPRI opaque call pointer.
1748  *
1749  * \details
1750  * This is a combination of pri_find_principle() and pri_fixup_principle()
1751  * to reduce code redundancy and to make handling several PRI_EVENT_xxx's
1752  * consistent for the current architecture.
1753  *
1754  * \note Assumes the pri->lock is already obtained.
1755  *
1756  * \retval array-index into private pointer array on success.
1757  * \retval -1 on error.
1758  */
1759 static int pri_find_fixup_principle(struct sig_pri_span *pri, int channel, q931_call *call)
1760 {
1761         int chanpos;
1762
1763         chanpos = pri_find_principle(pri, channel, call);
1764         if (chanpos < 0) {
1765                 ast_log(LOG_WARNING, "Span %d: PRI requested channel %d/%d is unconfigured.\n",
1766                         pri->span, PRI_SPAN(channel), PRI_CHANNEL(channel));
1767                 sig_pri_kill_call(pri, call, PRI_CAUSE_IDENTIFIED_CHANNEL_NOTEXIST);
1768                 return -1;
1769         }
1770         chanpos = pri_fixup_principle(pri, chanpos, call);
1771         if (chanpos < 0) {
1772                 ast_log(LOG_WARNING, "Span %d: PRI requested channel %d/%d is not available.\n",
1773                         pri->span, PRI_SPAN(channel), PRI_CHANNEL(channel));
1774                 /*
1775                  * Using Q.931 section 5.2.3.1 b) as the reason for picking
1776                  * PRI_CAUSE_CHANNEL_UNACCEPTABLE.  Receiving a
1777                  * PRI_CAUSE_REQUESTED_CHAN_UNAVAIL would cause us to restart
1778                  * that channel (which is not specified by Q.931) and kill some
1779                  * other call which would be bad.
1780                  */
1781                 sig_pri_kill_call(pri, call, PRI_CAUSE_CHANNEL_UNACCEPTABLE);
1782                 return -1;
1783         }
1784         return chanpos;
1785 }
1786
1787 static char * redirectingreason2str(int redirectingreason)
1788 {
1789         switch (redirectingreason) {
1790         case 0:
1791                 return "UNKNOWN";
1792         case 1:
1793                 return "BUSY";
1794         case 2:
1795                 return "NO_REPLY";
1796         case 0xF:
1797                 return "UNCONDITIONAL";
1798         default:
1799                 return "NOREDIRECT";
1800         }
1801 }
1802
1803 static char *dialplan2str(int dialplan)
1804 {
1805         if (dialplan == -1) {
1806                 return("Dynamically set dialplan in ISDN");
1807         }
1808         return (pri_plan2str(dialplan));
1809 }
1810
1811 /*!
1812  * \internal
1813  * \brief Apply numbering plan prefix to the given number.
1814  *
1815  * \param buf Buffer to put number into.
1816  * \param size Size of given buffer.
1817  * \param pri PRI span control structure.
1818  * \param number Number to apply numbering plan.
1819  * \param plan Numbering plan to apply.
1820  *
1821  * \return Nothing
1822  */
1823 static void apply_plan_to_number(char *buf, size_t size, const struct sig_pri_span *pri, const char *number, int plan)
1824 {
1825         switch (plan) {
1826         case PRI_INTERNATIONAL_ISDN:            /* Q.931 dialplan == 0x11 international dialplan => prepend international prefix digits */
1827                 snprintf(buf, size, "%s%s", pri->internationalprefix, number);
1828                 break;
1829         case PRI_NATIONAL_ISDN:                 /* Q.931 dialplan == 0x21 national dialplan => prepend national prefix digits */
1830                 snprintf(buf, size, "%s%s", pri->nationalprefix, number);
1831                 break;
1832         case PRI_LOCAL_ISDN:                    /* Q.931 dialplan == 0x41 local dialplan => prepend local prefix digits */
1833                 snprintf(buf, size, "%s%s", pri->localprefix, number);
1834                 break;
1835         case PRI_PRIVATE:                       /* Q.931 dialplan == 0x49 private dialplan => prepend private prefix digits */
1836                 snprintf(buf, size, "%s%s", pri->privateprefix, number);
1837                 break;
1838         case PRI_UNKNOWN:                       /* Q.931 dialplan == 0x00 unknown dialplan => prepend unknown prefix digits */
1839                 snprintf(buf, size, "%s%s", pri->unknownprefix, number);
1840                 break;
1841         default:                                /* other Q.931 dialplan => don't twiddle with callingnum */
1842                 snprintf(buf, size, "%s", number);
1843                 break;
1844         }
1845 }
1846
1847 /*!
1848  * \internal
1849  * \brief Apply numbering plan prefix to the given number if the number exists.
1850  *
1851  * \param buf Buffer to put number into.
1852  * \param size Size of given buffer.
1853  * \param pri PRI span control structure.
1854  * \param number Number to apply numbering plan.
1855  * \param plan Numbering plan to apply.
1856  *
1857  * \return Nothing
1858  */
1859 static void apply_plan_to_existing_number(char *buf, size_t size, const struct sig_pri_span *pri, const char *number, int plan)
1860 {
1861         /* Make sure a number exists so the prefix isn't placed on an empty string. */
1862         if (ast_strlen_zero(number)) {
1863                 if (size) {
1864                         *buf = '\0';
1865                 }
1866                 return;
1867         }
1868         apply_plan_to_number(buf, size, pri, number, plan);
1869 }
1870
1871 /*!
1872  * \internal
1873  * \brief Restart the next channel we think is idle on the span.
1874  *
1875  * \param pri PRI span control structure.
1876  *
1877  * \note Assumes the pri->lock is already obtained.
1878  *
1879  * \return Nothing
1880  */
1881 static void pri_check_restart(struct sig_pri_span *pri)
1882 {
1883 #if defined(HAVE_PRI_SERVICE_MESSAGES)
1884         unsigned why;
1885 #endif  /* defined(HAVE_PRI_SERVICE_MESSAGES) */
1886
1887         for (++pri->resetpos; pri->resetpos < pri->numchans; ++pri->resetpos) {
1888                 if (!pri->pvts[pri->resetpos]
1889                         || pri->pvts[pri->resetpos]->no_b_channel
1890                         || sig_pri_is_chan_in_use(pri->pvts[pri->resetpos])) {
1891                         continue;
1892                 }
1893 #if defined(HAVE_PRI_SERVICE_MESSAGES)
1894                 why = pri->pvts[pri->resetpos]->service_status;
1895                 if (why) {
1896                         ast_log(LOG_NOTICE,
1897                                 "Span %d: channel %d out-of-service (reason: %s), not sending RESTART\n",
1898                                 pri->span, pri->pvts[pri->resetpos]->channel,
1899                                 (why & SRVST_FAREND) ? (why & SRVST_NEAREND) ? "both ends" : "far end" : "near end");
1900                         continue;
1901                 }
1902 #endif  /* defined(HAVE_PRI_SERVICE_MESSAGES) */
1903                 break;
1904         }
1905         if (pri->resetpos < pri->numchans) {
1906                 /* Mark the channel as resetting and restart it */
1907                 pri->pvts[pri->resetpos]->resetting = SIG_PRI_RESET_ACTIVE;
1908                 pri_reset(pri->pri, PVT_TO_CHANNEL(pri->pvts[pri->resetpos]));
1909         } else {
1910                 pri->resetting = 0;
1911                 time(&pri->lastreset);
1912                 sig_pri_span_devstate_changed(pri);
1913         }
1914 }
1915
1916 #if defined(HAVE_PRI_CALL_WAITING)
1917 /*!
1918  * \internal
1919  * \brief Init the private channel configuration using the span controller.
1920  * \since 1.8
1921  *
1922  * \param pvt Channel to init the configuration.
1923  * \param pri PRI span control structure.
1924  *
1925  * \note Assumes the pri->lock is already obtained.
1926  *
1927  * \return Nothing
1928  */
1929 static void sig_pri_init_config(struct sig_pri_chan *pvt, struct sig_pri_span *pri)
1930 {
1931         pvt->stripmsd = pri->ch_cfg.stripmsd;
1932         pvt->hidecallerid = pri->ch_cfg.hidecallerid;
1933         pvt->hidecalleridname = pri->ch_cfg.hidecalleridname;
1934         pvt->immediate = pri->ch_cfg.immediate;
1935         pvt->priexclusive = pri->ch_cfg.priexclusive;
1936         pvt->priindication_oob = pri->ch_cfg.priindication_oob;
1937         pvt->use_callerid = pri->ch_cfg.use_callerid;
1938         pvt->use_callingpres = pri->ch_cfg.use_callingpres;
1939         ast_copy_string(pvt->context, pri->ch_cfg.context, sizeof(pvt->context));
1940         ast_copy_string(pvt->mohinterpret, pri->ch_cfg.mohinterpret, sizeof(pvt->mohinterpret));
1941
1942         if (sig_pri_callbacks.init_config) {
1943                 sig_pri_callbacks.init_config(pvt->chan_pvt, pri);
1944         }
1945 }
1946 #endif  /* defined(HAVE_PRI_CALL_WAITING) */
1947
1948 /*!
1949  * \internal
1950  * \brief Find an empty B-channel interface to use.
1951  *
1952  * \param pri PRI span control structure.
1953  * \param backwards TRUE if the search starts from higher channels.
1954  *
1955  * \note Assumes the pri->lock is already obtained.
1956  *
1957  * \retval array-index into private pointer array on success.
1958  * \retval -1 on error.
1959  */
1960 static int pri_find_empty_chan(struct sig_pri_span *pri, int backwards)
1961 {
1962         int x;
1963         if (backwards)
1964                 x = pri->numchans;
1965         else
1966                 x = 0;
1967         for (;;) {
1968                 if (backwards && (x < 0))
1969                         break;
1970                 if (!backwards && (x >= pri->numchans))
1971                         break;
1972                 if (pri->pvts[x]
1973                         && !pri->pvts[x]->no_b_channel
1974                         && sig_pri_is_chan_available(pri->pvts[x])) {
1975                         ast_debug(1, "Found empty available channel %d/%d\n",
1976                                 pri->pvts[x]->logicalspan, pri->pvts[x]->prioffset);
1977                         return x;
1978                 }
1979                 if (backwards)
1980                         x--;
1981                 else
1982                         x++;
1983         }
1984         return -1;
1985 }
1986
1987 #if defined(HAVE_PRI_CALL_HOLD)
1988 /*!
1989  * \internal
1990  * \brief Find or create an empty no-B-channel interface to use.
1991  * \since 1.8
1992  *
1993  * \param pri PRI span control structure.
1994  *
1995  * \note Assumes the pri->lock is already obtained.
1996  *
1997  * \retval array-index into private pointer array on success.
1998  * \retval -1 on error.
1999  */
2000 static int pri_find_empty_nobch(struct sig_pri_span *pri)
2001 {
2002         int idx;
2003
2004         for (idx = 0; idx < pri->numchans; ++idx) {
2005                 if (pri->pvts[idx]
2006                         && pri->pvts[idx]->no_b_channel
2007                         && sig_pri_is_chan_available(pri->pvts[idx])) {
2008                         ast_debug(1, "Found empty available no B channel interface\n");
2009                         return idx;
2010                 }
2011         }
2012
2013         /* Need to create a new interface. */
2014         if (sig_pri_callbacks.new_nobch_intf) {
2015                 idx = sig_pri_callbacks.new_nobch_intf(pri);
2016         } else {
2017                 idx = -1;
2018         }
2019         return idx;
2020 }
2021 #endif  /* defined(HAVE_PRI_CALL_HOLD) */
2022
2023 static void *do_idle_thread(void *v_pvt)
2024 {
2025         struct sig_pri_chan *pvt = v_pvt;
2026         struct ast_channel *chan = pvt->owner;
2027         struct ast_frame *f;
2028         char ex[80];
2029         /* Wait up to 30 seconds for an answer */
2030         int timeout_ms = 30000;
2031         int ms;
2032         struct timeval start;
2033         ast_callid callid;
2034
2035         if ((callid = ast_channel_callid(chan))) {
2036                 ast_callid_threadassoc_add(callid);
2037         }
2038
2039         ast_verb(3, "Initiating idle call on channel %s\n", ast_channel_name(chan));
2040         snprintf(ex, sizeof(ex), "%d/%s", pvt->channel, pvt->pri->idledial);
2041         if (ast_call(chan, ex, 0)) {
2042                 ast_log(LOG_WARNING, "Idle dial failed on '%s' to '%s'\n", ast_channel_name(chan), ex);
2043                 ast_hangup(chan);
2044                 return NULL;
2045         }
2046         start = ast_tvnow();
2047         while ((ms = ast_remaining_ms(start, timeout_ms))) {
2048                 if (ast_waitfor(chan, ms) <= 0) {
2049                         break;
2050                 }
2051
2052                 f = ast_read(chan);
2053                 if (!f) {
2054                         /* Got hangup */
2055                         break;
2056                 }
2057                 if (f->frametype == AST_FRAME_CONTROL) {
2058                         switch (f->subclass.integer) {
2059                         case AST_CONTROL_ANSWER:
2060                                 /* Launch the PBX */
2061                                 ast_channel_exten_set(chan, pvt->pri->idleext);
2062                                 ast_channel_context_set(chan, pvt->pri->idlecontext);
2063                                 ast_channel_priority_set(chan, 1);
2064                                 ast_verb(4, "Idle channel '%s' answered, sending to %s@%s\n", ast_channel_name(chan), ast_channel_exten(chan), ast_channel_context(chan));
2065                                 ast_pbx_run(chan);
2066                                 /* It's already hungup, return immediately */
2067                                 return NULL;
2068                         case AST_CONTROL_BUSY:
2069                                 ast_verb(4, "Idle channel '%s' busy, waiting...\n", ast_channel_name(chan));
2070                                 break;
2071                         case AST_CONTROL_CONGESTION:
2072                                 ast_verb(4, "Idle channel '%s' congested, waiting...\n", ast_channel_name(chan));
2073                                 break;
2074                         };
2075                 }
2076                 ast_frfree(f);
2077         }
2078         /* Hangup the channel since nothing happend */
2079         ast_hangup(chan);
2080         return NULL;
2081 }
2082
2083 static void *pri_ss_thread(void *data)
2084 {
2085         struct sig_pri_chan *p = data;
2086         struct ast_channel *chan = p->owner;
2087         char exten[AST_MAX_EXTENSION];
2088         int res;
2089         int len;
2090         int timeout;
2091         ast_callid callid;
2092
2093         if (!chan) {
2094                 /* We lost the owner before we could get started. */
2095                 return NULL;
2096         }
2097
2098         if ((callid = ast_channel_callid(chan))) {
2099                 ast_callid_threadassoc_add(callid);
2100         }
2101
2102         /*
2103          * In the bizarre case where the channel has become a zombie before we
2104          * even get started here, abort safely.
2105          */
2106         if (!ast_channel_tech_pvt(chan)) {
2107                 ast_log(LOG_WARNING, "Channel became a zombie before simple switch could be started (%s)\n", ast_channel_name(chan));
2108                 ast_hangup(chan);
2109                 return NULL;
2110         }
2111
2112         ast_verb(3, "Starting simple switch on '%s'\n", ast_channel_name(chan));
2113
2114         sig_pri_dsp_reset_and_flush_digits(p);
2115
2116         /* Now loop looking for an extension */
2117         ast_copy_string(exten, p->exten, sizeof(exten));
2118         len = strlen(exten);
2119         res = 0;
2120         while ((len < AST_MAX_EXTENSION-1) && ast_matchmore_extension(chan, ast_channel_context(chan), exten, 1, p->cid_num)) {
2121                 if (len && !ast_ignore_pattern(ast_channel_context(chan), exten))
2122                         sig_pri_play_tone(p, -1);
2123                 else
2124                         sig_pri_play_tone(p, SIG_PRI_TONE_DIALTONE);
2125                 if (ast_exists_extension(chan, ast_channel_context(chan), exten, 1, p->cid_num))
2126                         timeout = pri_matchdigittimeout;
2127                 else
2128                         timeout = pri_gendigittimeout;
2129                 res = ast_waitfordigit(chan, timeout);
2130                 if (res < 0) {
2131                         ast_debug(1, "waitfordigit returned < 0...\n");
2132                         ast_hangup(chan);
2133                         return NULL;
2134                 } else if (res) {
2135                         exten[len++] = res;
2136                         exten[len] = '\0';
2137                 } else
2138                         break;
2139         }
2140         /* if no extension was received ('unspecified') on overlap call, use the 's' extension */
2141         if (ast_strlen_zero(exten)) {
2142                 ast_verb(3, "Going to extension s|1 because of empty extension received on overlap call\n");
2143                 exten[0] = 's';
2144                 exten[1] = '\0';
2145         } else {
2146                 ast_free(ast_channel_dialed(chan)->number.str);
2147                 ast_channel_dialed(chan)->number.str = ast_strdup(exten);
2148
2149                 if (p->pri->append_msn_to_user_tag && p->pri->nodetype != PRI_NETWORK) {
2150                         /*
2151                          * Update the user tag for party id's from this device for this call
2152                          * now that we have a complete MSN from the network.
2153                          */
2154                         snprintf(p->user_tag, sizeof(p->user_tag), "%s_%s", p->pri->initial_user_tag,
2155                                 exten);
2156                         ast_free(ast_channel_caller(chan)->id.tag);
2157                         ast_channel_caller(chan)->id.tag = ast_strdup(p->user_tag);
2158                 }
2159         }
2160         sig_pri_play_tone(p, -1);
2161         if (ast_exists_extension(chan, ast_channel_context(chan), exten, 1, p->cid_num)) {
2162                 /* Start the real PBX */
2163                 ast_channel_exten_set(chan, exten);
2164                 sig_pri_dsp_reset_and_flush_digits(p);
2165 #if defined(JIRA_ASTERISK_15594)
2166                 /*
2167                  * Conditionaled out this code to effectively revert the JIRA
2168                  * ASTERISK-15594 change.  It breaks overlap dialing through
2169                  * Asterisk.  There is not enough information available at this
2170                  * point to know if dialing is complete.  The
2171                  * ast_exists_extension(), ast_matchmore_extension(), and
2172                  * ast_canmatch_extension() calls are not adequate to detect a
2173                  * dial through extension pattern of "_9!".
2174                  *
2175                  * Workaround is to use the dialplan Proceeding() application
2176                  * early on non-dial through extensions.
2177                  */
2178                 if ((p->pri->overlapdial & DAHDI_OVERLAPDIAL_INCOMING)
2179                         && !ast_matchmore_extension(chan, ast_channel_context(chan), exten, 1, p->cid_num)) {
2180                         sig_pri_lock_private(p);
2181                         if (p->pri->pri) {
2182                                 pri_grab(p, p->pri);
2183                                 if (p->call_level < SIG_PRI_CALL_LEVEL_PROCEEDING) {
2184                                         p->call_level = SIG_PRI_CALL_LEVEL_PROCEEDING;
2185                                 }
2186                                 pri_proceeding(p->pri->pri, p->call, PVT_TO_CHANNEL(p), 0);
2187                                 pri_rel(p->pri);
2188                         }
2189                         sig_pri_unlock_private(p);
2190                 }
2191 #endif  /* defined(JIRA_ASTERISK_15594) */
2192
2193                 sig_pri_set_echocanceller(p, 1);
2194                 ast_channel_lock(chan);
2195                 ast_setstate(chan, AST_STATE_RING);
2196                 ast_channel_unlock(chan);
2197                 res = ast_pbx_run(chan);
2198                 if (res) {
2199                         ast_log(LOG_WARNING, "PBX exited non-zero!\n");
2200                 }
2201         } else {
2202                 ast_debug(1, "No such possible extension '%s' in context '%s'\n", exten, ast_channel_context(chan));
2203                 ast_channel_hangupcause_set(chan, AST_CAUSE_UNALLOCATED);
2204                 ast_hangup(chan);
2205                 p->exten[0] = '\0';
2206                 /* Since we send release complete here, we won't get one */
2207                 p->call = NULL;
2208                 ast_mutex_lock(&p->pri->lock);
2209                 sig_pri_span_devstate_changed(p->pri);
2210                 ast_mutex_unlock(&p->pri->lock);
2211         }
2212         return NULL;
2213 }
2214
2215 void pri_event_alarm(struct sig_pri_span *pri, int index, int before_start_pri)
2216 {
2217         pri->dchanavail[index] &= ~(DCHAN_NOTINALARM | DCHAN_UP);
2218         if (!before_start_pri) {
2219                 pri_find_dchan(pri);
2220         }
2221 }
2222
2223 void pri_event_noalarm(struct sig_pri_span *pri, int index, int before_start_pri)
2224 {
2225         pri->dchanavail[index] |= DCHAN_NOTINALARM;
2226         if (!before_start_pri)
2227                 pri_restart(pri->dchans[index]);
2228 }
2229
2230 /*!
2231  * \internal
2232  * \brief Convert libpri party name into asterisk party name.
2233  * \since 1.8
2234  *
2235  * \param ast_name Asterisk party name structure to fill.  Must already be set initialized.
2236  * \param pri_name libpri party name structure containing source information.
2237  *
2238  * \note The filled in ast_name structure needs to be destroyed by
2239  * ast_party_name_free() when it is no longer needed.
2240  *
2241  * \return Nothing
2242  */
2243 static void sig_pri_party_name_convert(struct ast_party_name *ast_name, const struct pri_party_name *pri_name)
2244 {
2245         ast_name->str = ast_strdup(pri_name->str);
2246         ast_name->char_set = pri_to_ast_char_set(pri_name->char_set);
2247         ast_name->presentation = pri_to_ast_presentation(pri_name->presentation);
2248         ast_name->valid = 1;
2249 }
2250
2251 /*!
2252  * \internal
2253  * \brief Convert libpri party number into asterisk party number.
2254  * \since 1.8
2255  *
2256  * \param ast_number Asterisk party number structure to fill.  Must already be set initialized.
2257  * \param pri_number libpri party number structure containing source information.
2258  * \param pri PRI span control structure.
2259  *
2260  * \note The filled in ast_number structure needs to be destroyed by
2261  * ast_party_number_free() when it is no longer needed.
2262  *
2263  * \return Nothing
2264  */
2265 static void sig_pri_party_number_convert(struct ast_party_number *ast_number, const struct pri_party_number *pri_number, struct sig_pri_span *pri)
2266 {
2267         char number[AST_MAX_EXTENSION];
2268
2269         apply_plan_to_existing_number(number, sizeof(number), pri, pri_number->str,
2270                 pri_number->plan);
2271         ast_number->str = ast_strdup(number);
2272         ast_number->plan = pri_number->plan;
2273         ast_number->presentation = pri_to_ast_presentation(pri_number->presentation);
2274         ast_number->valid = 1;
2275 }
2276
2277 /*!
2278  * \internal
2279  * \brief Convert libpri party id into asterisk party id.
2280  * \since 1.8
2281  *
2282  * \param ast_id Asterisk party id structure to fill.  Must already be set initialized.
2283  * \param pri_id libpri party id structure containing source information.
2284  * \param pri PRI span control structure.
2285  *
2286  * \note The filled in ast_id structure needs to be destroyed by
2287  * ast_party_id_free() when it is no longer needed.
2288  *
2289  * \return Nothing
2290  */
2291 static void sig_pri_party_id_convert(struct ast_party_id *ast_id, const struct pri_party_id *pri_id, struct sig_pri_span *pri)
2292 {
2293         if (pri_id->name.valid) {
2294                 sig_pri_party_name_convert(&ast_id->name, &pri_id->name);
2295         }
2296         if (pri_id->number.valid) {
2297                 sig_pri_party_number_convert(&ast_id->number, &pri_id->number, pri);
2298         }
2299 #if defined(HAVE_PRI_SUBADDR)
2300         if (pri_id->subaddress.valid) {
2301                 sig_pri_set_subaddress(&ast_id->subaddress, &pri_id->subaddress);
2302         }
2303 #endif  /* defined(HAVE_PRI_SUBADDR) */
2304 }
2305
2306 /*!
2307  * \internal
2308  * \brief Convert libpri redirecting information into asterisk redirecting information.
2309  * \since 1.8
2310  *
2311  * \param ast_redirecting Asterisk redirecting structure to fill.
2312  * \param pri_redirecting libpri redirecting structure containing source information.
2313  * \param ast_guide Asterisk redirecting structure to use as an initialization guide.
2314  * \param pri PRI span control structure.
2315  *
2316  * \note The filled in ast_redirecting structure needs to be destroyed by
2317  * ast_party_redirecting_free() when it is no longer needed.
2318  *
2319  * \return Nothing
2320  */
2321 static void sig_pri_redirecting_convert(struct ast_party_redirecting *ast_redirecting,
2322         const struct pri_party_redirecting *pri_redirecting,
2323         const struct ast_party_redirecting *ast_guide,
2324         struct sig_pri_span *pri)
2325 {
2326         ast_party_redirecting_set_init(ast_redirecting, ast_guide);
2327
2328         sig_pri_party_id_convert(&ast_redirecting->orig, &pri_redirecting->orig_called, pri);
2329         sig_pri_party_id_convert(&ast_redirecting->from, &pri_redirecting->from, pri);
2330         sig_pri_party_id_convert(&ast_redirecting->to, &pri_redirecting->to, pri);
2331         ast_redirecting->count = pri_redirecting->count;
2332         ast_redirecting->reason.code = pri_to_ast_reason(pri_redirecting->reason);
2333         ast_redirecting->orig_reason.code = pri_to_ast_reason(pri_redirecting->orig_reason);
2334 }
2335
2336 /*!
2337  * \internal
2338  * \brief Determine if the given extension matches one of the MSNs in the pattern list.
2339  * \since 1.8
2340  *
2341  * \param msn_patterns Comma separated list of MSN patterns to match.
2342  * \param exten Extension to match in the MSN list.
2343  *
2344  * \retval 1 if matches.
2345  * \retval 0 if no match.
2346  */
2347 static int sig_pri_msn_match(const char *msn_patterns, const char *exten)
2348 {
2349         char *pattern;
2350         char *msn_list;
2351         char *list_tail;
2352
2353         msn_list = ast_strdupa(msn_patterns);
2354
2355         list_tail = NULL;
2356         pattern = strtok_r(msn_list, ",", &list_tail);
2357         while (pattern) {
2358                 pattern = ast_strip(pattern);
2359                 if (!ast_strlen_zero(pattern) && ast_extension_match(pattern, exten)) {
2360                         /* Extension matched the pattern. */
2361                         return 1;
2362                 }
2363                 pattern = strtok_r(NULL, ",", &list_tail);
2364         }
2365         /* Did not match any pattern in the list. */
2366         return 0;
2367 }
2368
2369 #if defined(HAVE_PRI_MCID)
2370 static void party_number_json_to_ami(struct ast_str **msg, const char *prefix, struct ast_json *number)
2371 {
2372         const char *num_txt, *pres_txt;
2373         int plan, pres;
2374         if (!number) {
2375                 ast_str_append(msg, 0,
2376                         "%sNumValid: 0\r\n"
2377                         "%sNum: \r\n"
2378                         "%ston: 0\r\n",
2379                         prefix, prefix, prefix);
2380                 return;
2381         }
2382
2383         num_txt = ast_json_string_get(ast_json_object_get(number, "number"));
2384         plan = ast_json_integer_get(ast_json_object_get(number, "plan"));
2385         pres = ast_json_integer_get(ast_json_object_get(number, "presentation"));
2386         pres_txt = ast_json_string_get(ast_json_object_get(number, "presentation_txt"));
2387
2388         ast_str_append(msg, 0, "%sNumValid: 1\r\n", prefix);
2389         ast_str_append(msg, 0, "%sNum: %s\r\n", prefix, num_txt);
2390         ast_str_append(msg, 0, "%ston: %d\r\n", prefix, plan);
2391         ast_str_append(msg, 0, "%sNumPlan: %d\r\n", prefix, plan);
2392         ast_str_append(msg, 0, "%sNumPres: %d (%s)\r\n", prefix, pres, pres_txt);
2393 }
2394
2395 static void party_name_json_to_ami(struct ast_str **msg, const char *prefix, struct ast_json *name)
2396 {
2397         const char *name_txt, *pres_txt, *charset;
2398         int pres;
2399         if (!name) {
2400                 ast_str_append(msg, 0,
2401                         "%sNameValid: 0\r\n"
2402                         "%sName: \r\n",
2403                         prefix, prefix);
2404                 return;
2405         }
2406
2407         name_txt = ast_json_string_get(ast_json_object_get(name, "name"));
2408         charset = ast_json_string_get(ast_json_object_get(name, "character_set"));
2409         pres = ast_json_integer_get(ast_json_object_get(name, "presentation"));
2410         pres_txt = ast_json_string_get(ast_json_object_get(name, "presentation_txt"));
2411
2412         ast_str_append(msg, 0, "%sNameValid: 1\r\n", prefix);
2413         ast_str_append(msg, 0, "%sName: %s\r\n", prefix, name_txt);
2414         ast_str_append(msg, 0, "%sNameCharSet: %s\r\n", prefix, charset);
2415         ast_str_append(msg, 0, "%sNamePres: %d (%s)\r\n", prefix, pres, pres_txt);
2416 }
2417
2418 static void party_subaddress_json_to_ami(struct ast_str **msg, const char *prefix, struct ast_json *subaddress)
2419 {
2420         const char *subaddress_txt, *type_txt;
2421         int odd;
2422         if (!subaddress) {
2423                 return;
2424         }
2425
2426         subaddress_txt = ast_json_string_get(ast_json_object_get(subaddress, "subaddress"));
2427         type_txt = ast_json_string_get(ast_json_object_get(subaddress, "type"));
2428         odd = ast_json_is_true(ast_json_object_get(subaddress, "odd")) ? 1 : 0;
2429
2430         ast_str_append(msg, 0, "%sSubaddr: %s\r\n", prefix, subaddress_txt);
2431         ast_str_append(msg, 0, "%sSubaddrType: %s\r\n", prefix, type_txt);
2432         ast_str_append(msg, 0, "%sSubaddrOdd: %d\r\n", prefix, odd);
2433 }
2434
2435 /*!
2436  * \internal
2437  * \brief Append the given JSON party id to the event string.
2438  * \since 1.8
2439  *
2440  * \param msg Event message string being built.
2441  * \param prefix Prefix to add to the party id lines.
2442  * \param party Party information to encode.
2443  *
2444  * \return Nothing
2445  */
2446 static void party_json_to_ami(struct ast_str **msg, const char *prefix, struct ast_json *party)
2447 {
2448         struct ast_json *presentation = ast_json_object_get(party, "presentation");
2449         struct ast_json *presentation_txt = ast_json_object_get(party, "presentation_txt");
2450         struct ast_json *name = ast_json_object_get(party, "name");
2451         struct ast_json *number = ast_json_object_get(party, "number");
2452         struct ast_json *subaddress = ast_json_object_get(party, "subaddress");
2453
2454         /* Combined party presentation */
2455         ast_str_append(msg, 0, "%sPres: %jd (%s)\r\n", prefix,
2456                 ast_json_integer_get(presentation),
2457                 ast_json_string_get(presentation_txt));
2458
2459         /* Party number */
2460         party_number_json_to_ami(msg, prefix, number);
2461
2462         /* Party name */
2463         party_name_json_to_ami(msg, prefix, name);
2464
2465         /* Party subaddress */
2466         party_subaddress_json_to_ami(msg, prefix, subaddress);
2467 }
2468
2469 static struct ast_manager_event_blob *mcid_to_ami(struct stasis_message *msg)
2470 {
2471         RAII_VAR(struct ast_str *, channel_string, NULL, ast_free);
2472         RAII_VAR(struct ast_str *, party_string, ast_str_create(256), ast_free);
2473         struct ast_channel_blob *obj = stasis_message_data(msg);
2474
2475         if (obj->snapshot) {
2476                 channel_string = ast_manager_build_channel_state_string(obj->snapshot);
2477                 if (!channel_string) {
2478                         return NULL;
2479                 }
2480         }
2481
2482         party_json_to_ami(&party_string, "MCallerID", ast_json_object_get(obj->blob, "caller"));
2483         party_json_to_ami(&party_string, "MConnectedID", ast_json_object_get(obj->blob, "connected"));
2484
2485         return ast_manager_event_blob_create(EVENT_FLAG_CALL, "MCID",
2486                 "%s"
2487                 "%s",
2488                 S_COR(obj->snapshot, ast_str_buffer(channel_string), ""), ast_str_buffer(party_string));
2489 }
2490
2491 STASIS_MESSAGE_TYPE_DEFN_LOCAL(mcid_type,
2492         .to_ami = mcid_to_ami,
2493         );
2494
2495 static void send_mcid(struct ast_channel *chan, struct ast_party_id *caller, struct ast_party_id *connected)
2496 {
2497         RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
2498
2499         ast_assert(caller != NULL);
2500         ast_assert(connected != NULL);
2501
2502         blob = ast_json_pack("{s: o, s: o}",
2503                 "caller", ast_json_party_id(caller),
2504                 "connected", ast_json_party_id(connected));
2505         if (!blob) {
2506                 return;
2507         }
2508
2509         ast_channel_publish_blob(chan, mcid_type(), blob);
2510 }
2511
2512 /*!
2513  * \internal
2514  * \brief Handle the MCID event.
2515  * \since 1.8
2516  *
2517  * \param pri PRI span control structure.
2518  * \param mcid MCID event parameters.
2519  * \param owner Asterisk channel associated with the call.
2520  * NULL if Asterisk no longer has the ast_channel struct.
2521  *
2522  * \note Assumes the pri->lock is already obtained.
2523  * \note Assumes the owner channel lock is already obtained if still present.
2524  *
2525  * \return Nothing
2526  */
2527 static void sig_pri_mcid_event(struct sig_pri_span *pri, const struct pri_subcmd_mcid_req *mcid, struct ast_channel *owner)
2528 {
2529         struct ast_party_id caller_party;
2530         struct ast_party_id connected_party;
2531
2532         /* Always use libpri's called party information. */
2533         ast_party_id_init(&connected_party);
2534         sig_pri_party_id_convert(&connected_party, &mcid->answerer, pri);
2535         if (owner) {
2536                 /*
2537                  * The owner channel is present.
2538                  * Pass the event to the peer as well.
2539                  */
2540                 ast_queue_control(owner, AST_CONTROL_MCID);
2541
2542                 send_mcid(owner, &ast_channel_connected(owner)->id, &connected_party);
2543         } else {
2544                 /*
2545                  * Since we no longer have an owner channel,
2546                  * we have to use the caller information supplied by libpri.
2547                  */
2548                 ast_party_id_init(&caller_party);
2549                 sig_pri_party_id_convert(&caller_party, &mcid->originator, pri);
2550                 send_mcid(owner, &caller_party, &connected_party);
2551                 ast_party_id_free(&caller_party);
2552         }
2553         ast_party_id_free(&connected_party);
2554 }
2555 #endif  /* defined(HAVE_PRI_MCID) */
2556
2557 #if defined(HAVE_PRI_TRANSFER)
2558 struct xfer_rsp_data {
2559         struct sig_pri_span *pri;
2560         /*! Call to send transfer success/fail response over. */
2561         q931_call *call;
2562         /*! Invocation ID to use when sending a reply to the transfer request. */
2563         int invoke_id;
2564         /*! TRUE if the transfer response has been made. */
2565         int responded;
2566 };
2567 #endif  /* defined(HAVE_PRI_TRANSFER) */
2568
2569 #if defined(HAVE_PRI_TRANSFER)
2570 /*!
2571  * \internal
2572  * \brief Send the transfer success/fail response message.
2573  * \since 1.8
2574  *
2575  * \param rsp Transfer response data.
2576  * \param is_successful TRUE if the transfer was successful.
2577  *
2578  * \note Assumes the rsp->pri->lock is already obtained.
2579  *
2580  * \return Nothing
2581  */
2582 static void sig_pri_transfer_rsp(struct xfer_rsp_data *rsp, int is_successful)
2583 {
2584         if (rsp->responded) {
2585                 return;
2586         }
2587         rsp->responded = 1;
2588
2589         pri_transfer_rsp(rsp->pri->pri, rsp->call, rsp->invoke_id, is_successful);
2590 }
2591 #endif  /* defined(HAVE_PRI_TRANSFER) */
2592
2593 #if defined(HAVE_PRI_CALL_HOLD) || defined(HAVE_PRI_TRANSFER)
2594 /*!
2595  * \internal
2596  * \brief Attempt to transfer the two calls to each other.
2597  * \since 1.8
2598  *
2599  * \param pri PRI span control structure.
2600  * \param call_1_pri First call involved in the transfer. (transferee; usually on hold)
2601  * \param call_1_held TRUE if call_1_pri is on hold.
2602  * \param call_2_pri Second call involved in the transfer. (target; usually active/ringing)
2603  * \param call_2_held TRUE if call_2_pri is on hold.
2604  * \param xfer_data Transfer response data if non-NULL.
2605  *
2606  * \note Assumes the pri->lock is already obtained.
2607  *
2608  * \retval 0 on success.
2609  * \retval -1 on error.
2610  */
2611 static int sig_pri_attempt_transfer(struct sig_pri_span *pri, q931_call *call_1_pri, int call_1_held, q931_call *call_2_pri, int call_2_held, struct xfer_rsp_data *xfer_data)
2612 {
2613         struct attempt_xfer_call {
2614                 q931_call *pri;
2615                 struct ast_channel *ast;
2616                 int held;
2617                 int chanpos;
2618         };
2619         int retval;
2620         enum ast_transfer_result xfer_res;
2621         struct attempt_xfer_call *call_1;
2622         struct attempt_xfer_call *call_2;
2623         struct attempt_xfer_call c1;
2624         struct attempt_xfer_call c2;
2625
2626         c1.pri = call_1_pri;
2627         c1.held = call_1_held;
2628         call_1 = &c1;
2629
2630         c2.pri = call_2_pri;
2631         c2.held = call_2_held;
2632         call_2 = &c2;
2633
2634         call_1->chanpos = pri_find_principle_by_call(pri, call_1->pri);
2635         call_2->chanpos = pri_find_principle_by_call(pri, call_2->pri);
2636         if (call_1->chanpos < 0 || call_2->chanpos < 0) {
2637                 /* Calls not found in span control. */
2638 #if defined(HAVE_PRI_TRANSFER)
2639                 if (xfer_data) {
2640                         /* Transfer failed. */
2641                         sig_pri_transfer_rsp(xfer_data, 0);
2642                 }
2643 #endif  /* defined(HAVE_PRI_TRANSFER) */
2644                 return -1;
2645         }
2646
2647         /* Get call_1 owner. */
2648         sig_pri_lock_private(pri->pvts[call_1->chanpos]);
2649         sig_pri_lock_owner(pri, call_1->chanpos);
2650         call_1->ast = pri->pvts[call_1->chanpos]->owner;
2651         if (call_1->ast) {
2652                 ast_channel_ref(call_1->ast);
2653                 ast_channel_unlock(call_1->ast);
2654         }
2655         sig_pri_unlock_private(pri->pvts[call_1->chanpos]);
2656
2657         /* Get call_2 owner. */
2658         sig_pri_lock_private(pri->pvts[call_2->chanpos]);
2659         sig_pri_lock_owner(pri, call_2->chanpos);
2660         call_2->ast = pri->pvts[call_2->chanpos]->owner;
2661         if (call_2->ast) {
2662                 ast_channel_ref(call_2->ast);
2663                 ast_channel_unlock(call_2->ast);
2664         }
2665         sig_pri_unlock_private(pri->pvts[call_2->chanpos]);
2666
2667         if (!call_1->ast || !call_2->ast) {
2668                 /* At least one owner is not present. */
2669                 if (call_1->ast) {
2670                         ast_channel_unref(call_1->ast);
2671                 }
2672                 if (call_2->ast) {
2673                         ast_channel_unref(call_2->ast);
2674                 }
2675 #if defined(HAVE_PRI_TRANSFER)
2676                 if (xfer_data) {
2677                         /* Transfer failed. */
2678                         sig_pri_transfer_rsp(xfer_data, 0);
2679                 }
2680 #endif  /* defined(HAVE_PRI_TRANSFER) */
2681                 return -1;
2682         }
2683
2684         ast_verb(3, "TRANSFERRING %s to %s\n",
2685                 ast_channel_name(call_1->ast), ast_channel_name(call_2->ast));
2686
2687 #if defined(HAVE_PRI_TRANSFER)
2688         if (xfer_data) {
2689                 /*
2690                  * Add traps on the transferer channels in case threading causes
2691                  * them to hangup before ast_bridge_transfer_attended() returns
2692                  * and we can get the pri->lock back.
2693                  */
2694                 sig_pri_lock_private(pri->pvts[call_1->chanpos]);
2695                 pri->pvts[call_1->chanpos]->xfer_data = xfer_data;
2696                 sig_pri_unlock_private(pri->pvts[call_1->chanpos]);
2697                 sig_pri_lock_private(pri->pvts[call_2->chanpos]);
2698                 pri->pvts[call_2->chanpos]->xfer_data = xfer_data;
2699                 sig_pri_unlock_private(pri->pvts[call_2->chanpos]);
2700         }
2701 #endif  /* defined(HAVE_PRI_TRANSFER) */
2702
2703         ast_mutex_unlock(&pri->lock);
2704         xfer_res = ast_bridge_transfer_attended(call_1->ast, call_2->ast);
2705         ast_mutex_lock(&pri->lock);
2706         retval = (xfer_res != AST_BRIDGE_TRANSFER_SUCCESS) ? -1 : 0;
2707
2708 #if defined(HAVE_PRI_TRANSFER)
2709         if (xfer_data) {
2710                 int rsp_chanpos;
2711
2712                 /*
2713                  * Remove the transferrer channel traps.
2714                  *
2715                  * We must refind chanpos because we released pri->lock.
2716                  */
2717                 rsp_chanpos = pri_find_principle_by_call(pri, call_1->pri);
2718                 if (0 <= rsp_chanpos) {
2719                         sig_pri_lock_private(pri->pvts[rsp_chanpos]);
2720                         pri->pvts[rsp_chanpos]->xfer_data = NULL;
2721                         sig_pri_unlock_private(pri->pvts[rsp_chanpos]);
2722                 }
2723                 rsp_chanpos = pri_find_principle_by_call(pri, call_2->pri);
2724                 if (0 <= rsp_chanpos) {
2725                         sig_pri_lock_private(pri->pvts[rsp_chanpos]);
2726                         pri->pvts[rsp_chanpos]->xfer_data = NULL;
2727                         sig_pri_unlock_private(pri->pvts[rsp_chanpos]);
2728                 }
2729
2730                 /* Report transfer status. */
2731                 sig_pri_transfer_rsp(xfer_data, retval ? 0 : 1);
2732         }
2733 #endif  /* defined(HAVE_PRI_TRANSFER) */
2734         ast_channel_unref(call_1->ast);
2735         ast_channel_unref(call_2->ast);
2736         return retval;
2737 }
2738 #endif  /* defined(HAVE_PRI_CALL_HOLD) || defined(HAVE_PRI_TRANSFER) */
2739
2740 #if defined(HAVE_PRI_CCSS)
2741 /*!
2742  * \internal
2743  * \brief Compare the CC agent private data by libpri cc_id.
2744  * \since 1.8
2745  *
2746  * \param obj pointer to the (user-defined part) of an object.
2747  * \param arg callback argument from ao2_callback()
2748  * \param flags flags from ao2_callback()
2749  *
2750  * \return values are a combination of enum _cb_results.
2751  */
2752 static int sig_pri_cc_agent_cmp_cc_id(void *obj, void *arg, int flags)
2753 {
2754         struct ast_cc_agent *agent_1 = obj;
2755         struct sig_pri_cc_agent_prv *agent_prv_1 = agent_1->private_data;
2756         struct sig_pri_cc_agent_prv *agent_prv_2 = arg;
2757
2758         return (agent_prv_1 && agent_prv_1->pri == agent_prv_2->pri
2759                 && agent_prv_1->cc_id == agent_prv_2->cc_id) ? CMP_MATCH | CMP_STOP : 0;
2760 }
2761 #endif  /* defined(HAVE_PRI_CCSS) */
2762
2763 #if defined(HAVE_PRI_CCSS)
2764 /*!
2765  * \internal
2766  * \brief Find the CC agent by libpri cc_id.
2767  * \since 1.8
2768  *
2769  * \param pri PRI span control structure.
2770  * \param cc_id CC record ID to find.
2771  *
2772  * \note
2773  * Since agents are refcounted, and this function returns
2774  * a reference to the agent, it is imperative that you decrement
2775  * the refcount of the agent once you have finished using it.
2776  *
2777  * \retval agent on success.
2778  * \retval NULL not found.
2779  */
2780 static struct ast_cc_agent *sig_pri_find_cc_agent_by_cc_id(struct sig_pri_span *pri, long cc_id)
2781 {
2782         struct sig_pri_cc_agent_prv finder = {
2783                 .pri = pri,
2784                 .cc_id = cc_id,
2785         };
2786
2787         return ast_cc_agent_callback(0, sig_pri_cc_agent_cmp_cc_id, &finder,
2788                 sig_pri_cc_type_name);
2789 }
2790 #endif  /* defined(HAVE_PRI_CCSS) */
2791
2792 #if defined(HAVE_PRI_CCSS)
2793 /*!
2794  * \internal
2795  * \brief Compare the CC monitor instance by libpri cc_id.
2796  * \since 1.8
2797  *
2798  * \param obj pointer to the (user-defined part) of an object.
2799  * \param arg callback argument from ao2_callback()
2800  * \param flags flags from ao2_callback()
2801  *
2802  * \return values are a combination of enum _cb_results.
2803  */
2804 static int sig_pri_cc_monitor_cmp_cc_id(void *obj, void *arg, int flags)
2805 {
2806         struct sig_pri_cc_monitor_instance *monitor_1 = obj;
2807         struct sig_pri_cc_monitor_instance *monitor_2 = arg;
2808
2809         return (monitor_1->pri == monitor_2->pri
2810                 && monitor_1->cc_id == monitor_2->cc_id) ? CMP_MATCH | CMP_STOP : 0;
2811 }
2812 #endif  /* defined(HAVE_PRI_CCSS) */
2813
2814 #if defined(HAVE_PRI_CCSS)
2815 /*!
2816  * \internal
2817  * \brief Find the CC monitor instance by libpri cc_id.
2818  * \since 1.8
2819  *
2820  * \param pri PRI span control structure.
2821  * \param cc_id CC record ID to find.
2822  *
2823  * \note
2824  * Since monitor_instances are refcounted, and this function returns
2825  * a reference to the instance, it is imperative that you decrement
2826  * the refcount of the instance once you have finished using it.
2827  *
2828  * \retval monitor_instance on success.
2829  * \retval NULL not found.
2830  */
2831 static struct sig_pri_cc_monitor_instance *sig_pri_find_cc_monitor_by_cc_id(struct sig_pri_span *pri, long cc_id)
2832 {
2833         struct sig_pri_cc_monitor_instance finder = {
2834                 .pri = pri,
2835                 .cc_id = cc_id,
2836         };
2837
2838         return ao2_callback(sig_pri_cc_monitors, 0, sig_pri_cc_monitor_cmp_cc_id, &finder);
2839 }
2840 #endif  /* defined(HAVE_PRI_CCSS) */
2841
2842 #if defined(HAVE_PRI_CCSS)
2843 /*!
2844  * \internal
2845  * \brief Destroy the given monitor instance.
2846  * \since 1.8
2847  *
2848  * \param data Monitor instance to destroy.
2849  *
2850  * \return Nothing
2851  */
2852 static void sig_pri_cc_monitor_instance_destroy(void *data)
2853 {
2854         struct sig_pri_cc_monitor_instance *monitor_instance = data;
2855
2856         if (monitor_instance->cc_id != -1) {
2857                 ast_mutex_lock(&monitor_instance->pri->lock);
2858                 pri_cc_cancel(monitor_instance->pri->pri, monitor_instance->cc_id);
2859                 ast_mutex_unlock(&monitor_instance->pri->lock);
2860         }
2861         sig_pri_callbacks.module_unref();
2862 }
2863 #endif  /* defined(HAVE_PRI_CCSS) */
2864
2865 #if defined(HAVE_PRI_CCSS)
2866 /*!
2867  * \internal
2868  * \brief Construct a new monitor instance.
2869  * \since 1.8
2870  *
2871  * \param core_id CC core ID.
2872  * \param pri PRI span control structure.
2873  * \param cc_id CC record ID.
2874  * \param device_name Name of device (Asterisk channel name less sequence number).
2875  *
2876  * \note
2877  * Since monitor_instances are refcounted, and this function returns
2878  * a reference to the instance, it is imperative that you decrement
2879  * the refcount of the instance once you have finished using it.
2880  *
2881  * \retval monitor_instance on success.
2882  * \retval NULL on error.
2883  */
2884 static struct sig_pri_cc_monitor_instance *sig_pri_cc_monitor_instance_init(int core_id, struct sig_pri_span *pri, long cc_id, const char *device_name)
2885 {
2886         struct sig_pri_cc_monitor_instance *monitor_instance;
2887
2888         if (!sig_pri_callbacks.module_ref || !sig_pri_callbacks.module_unref) {
2889                 return NULL;
2890         }
2891
2892         monitor_instance = ao2_alloc(sizeof(*monitor_instance) + strlen(device_name),
2893                 sig_pri_cc_monitor_instance_destroy);
2894         if (!monitor_instance) {
2895                 return NULL;
2896         }
2897
2898         monitor_instance->cc_id = cc_id;
2899         monitor_instance->pri = pri;
2900         monitor_instance->core_id = core_id;
2901         strcpy(monitor_instance->name, device_name);
2902
2903         sig_pri_callbacks.module_ref();
2904
2905         ao2_link(sig_pri_cc_monitors, monitor_instance);
2906         return monitor_instance;
2907 }
2908 #endif  /* defined(HAVE_PRI_CCSS) */
2909
2910 #if defined(HAVE_PRI_CCSS)
2911 /*!
2912  * \internal
2913  * \brief Announce to the CC core that protocol CC monitor is available for this call.
2914  * \since 1.8
2915  *
2916  * \param pri PRI span control structure.
2917  * \param chanpos Channel position in the span.
2918  * \param cc_id CC record ID.
2919  * \param service CCBS/CCNR indication.
2920  *
2921  * \note Assumes the pri->lock is already obtained.
2922  * \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
2923  * \note Assumes the sig_pri_lock_owner(pri, chanpos) is already obtained.
2924  *
2925  * \retval 0 on success.
2926  * \retval -1 on error.
2927  */
2928 static int sig_pri_cc_available(struct sig_pri_span *pri, int chanpos, long cc_id, enum ast_cc_service_type service)
2929 {
2930         struct sig_pri_chan *pvt;
2931         struct ast_cc_config_params *cc_params;
2932         struct sig_pri_cc_monitor_instance *monitor;
2933         enum ast_cc_monitor_policies monitor_policy;
2934         int core_id;
2935         int res;
2936         char device_name[AST_CHANNEL_NAME];
2937         char dialstring[AST_CHANNEL_NAME];
2938
2939         pvt = pri->pvts[chanpos];
2940
2941         core_id = ast_cc_get_current_core_id(pvt->owner);
2942         if (core_id == -1) {
2943                 return -1;
2944         }
2945
2946         cc_params = ast_channel_get_cc_config_params(pvt->owner);
2947         if (!cc_params) {
2948                 return -1;
2949         }
2950
2951         res = -1;
2952         monitor_policy = ast_get_cc_monitor_policy(cc_params);
2953         switch (monitor_policy) {
2954         case AST_CC_MONITOR_NEVER:
2955                 /* CCSS is not enabled. */
2956                 break;
2957         case AST_CC_MONITOR_NATIVE:
2958         case AST_CC_MONITOR_ALWAYS:
2959                 /*
2960                  * If it is AST_CC_MONITOR_ALWAYS and native fails we will attempt the fallback
2961                  * later in the call to sig_pri_cc_generic_check().
2962                  */
2963                 ast_channel_get_device_name(pvt->owner, device_name, sizeof(device_name));
2964                 sig_pri_make_cc_dialstring(pvt, dialstring, sizeof(dialstring));
2965                 monitor = sig_pri_cc_monitor_instance_init(core_id, pri, cc_id, device_name);
2966                 if (!monitor) {
2967                         break;
2968                 }
2969                 res = ast_queue_cc_frame(pvt->owner, sig_pri_cc_type_name, dialstring, service,
2970                         monitor);
2971                 if (res) {
2972                         monitor->cc_id = -1;
2973                         ao2_unlink(sig_pri_cc_monitors, monitor);
2974                         ao2_ref(monitor, -1);
2975                 }
2976                 break;
2977         case AST_CC_MONITOR_GENERIC:
2978                 ast_queue_cc_frame(pvt->owner, AST_CC_GENERIC_MONITOR_TYPE,
2979                         sig_pri_get_orig_dialstring(pvt), service, NULL);
2980                 /* Say it failed to force caller to cancel native CC. */
2981                 break;
2982         }
2983         return res;
2984 }
2985 #endif  /* defined(HAVE_PRI_CCSS) */
2986
2987 /*!
2988  * \internal
2989  * \brief Check if generic CC monitor is needed and request it.
2990  * \since 1.8
2991  *
2992  * \param pri PRI span control structure.
2993  * \param chanpos Channel position in the span.
2994  * \param service CCBS/CCNR indication.
2995  *
2996  * \note Assumes the pri->lock is already obtained.
2997  * \note Assumes the sig_pri_lock_private(pri->pvts[chanpos]) is already obtained.
2998  *
2999  * \return Nothing
3000  */
3001 static void sig_pri_cc_generic_check(struct sig_pri_span *pri, int chanpos, enum ast_cc_service_type service)
3002 {
3003         struct ast_channel *owner;
3004         struct ast_cc_config_params *cc_params;
3005 #if defined(HAVE_PRI_CCSS)
3006         struct ast_cc_monitor *monitor;
3007         char device_name[AST_CHANNEL_NAME];
3008 #endif  /* defined(HAVE_PRI_CCSS) */
3009         enum ast_cc_monitor_policies monitor_policy;
3010         int core_id;
3011
3012         if (!pri->pvts[chanpos]->outgoing) {
3013                 /* This is not an outgoing call so it cannot be CC monitor. */
3014                 return;
3015         }
3016
3017         sig_pri_lock_owner(pri, chanpos);
3018         owner = pri->pvts[chanpos]->owner;
3019         if (!owner) {
3020                 return;
3021         }
3022         core_id = ast_cc_get_current_core_id(owner);
3023         if (core_id == -1) {
3024                 /* No CC core setup */
3025                 goto done;
3026         }
3027
3028         cc_params = ast_channel_get_cc_config_params(owner);
3029         if (!cc_params) {
3030                 /* Could not get CC config parameters. */
3031                 goto done;
3032         }
3033
3034 #if defined(HAVE_PRI_CCSS)
3035         ast_channel_get_device_name(owner, device_name, sizeof(device_name));
3036         monitor = ast_cc_get_monitor_by_recall_core_id(core_id, device_name);
3037         if (monitor) {
3038                 /* CC monitor is already present so no need for generic CC. */
3039                 ao2_ref(monitor, -1);
3040                 goto done;
3041         }
3042 #endif  /* defined(HAVE_PRI_CCSS) */
3043
3044         monitor_policy = ast_get_cc_monitor_policy(cc_params);
3045         switch (monitor_policy) {
3046         case AST_CC_MONITOR_NEVER:
3047                 /* CCSS is not enabled. */
3048                 break;
3049         case AST_CC_MONITOR_NATIVE:
3050                 if (pri->sig == SIG_BRI_PTMP && pri->nodetype == PRI_NETWORK) {
3051                         /* Request generic CC monitor. */
3052                         ast_queue_cc_frame(owner, AST_CC_GENERIC_MONITOR_TYPE,
3053                                 sig_pri_get_orig_dialstring(pri->pvts[chanpos]), service, NULL);
3054                 }
3055                 break;
3056         case AST_CC_MONITOR_ALWAYS:
3057                 if (pri->sig == SIG_BRI_PTMP && pri->nodetype != PRI_NETWORK) {
3058                         /*
3059                          * Cannot monitor PTMP TE side since this is not defined.
3060                          * We are playing the roll of a phone in this case and
3061                          * a phone cannot monitor a party over the network without
3062                          * protocol help.
3063                          */
3064                         break;
3065                 }
3066                 /*
3067                  * We are either falling back or this is a PTMP NT span.
3068                  * Request generic CC monitor.
3069                  */
3070                 ast_queue_cc_frame(owner, AST_CC_GENERIC_MONITOR_TYPE,
3071                         sig_pri_get_orig_dialstring(pri->pvts[chanpos]), service, NULL);
3072                 break;
3073         case AST_CC_MONITOR_GENERIC:
3074                 if (pri->sig == SIG_BRI_PTMP && pri->nodetype == PRI_NETWORK) {
3075                         /* Request generic CC monitor. */
3076                         ast_queue_cc_frame(owner, AST_CC_GENERIC_MONITOR_TYPE,
3077                                 sig_pri_get_orig_dialstring(pri->pvts[chanpos]), service, NULL);
3078                 }
3079                 break;
3080         }
3081
3082 done:
3083         ast_channel_unlock(owner);
3084 }
3085
3086 #if defined(HAVE_PRI_CCSS)
3087 /*!
3088  * \internal
3089  * \brief The CC link canceled the CC instance.
3090  * \since 1.8
3091  *
3092  * \param pri PRI span control structure.
3093  * \param cc_id CC record ID.
3094  * \param is_agent TRUE if the cc_id is for an agent.
3095  *
3096  * \return Nothing
3097  */
3098 static void sig_pri_cc_link_canceled(struct sig_pri_span *pri, long cc_id, int is_agent)
3099 {
3100         if (is_agent) {
3101                 struct ast_cc_agent *agent;
3102
3103                 agent = sig_pri_find_cc_agent_by_cc_id(pri, cc_id);
3104                 if (!agent) {
3105                         return;
3106                 }
3107                 ast_cc_failed(agent->core_id, "%s agent got canceled by link",
3108                         sig_pri_cc_type_name);
3109                 ao2_ref(agent, -1);
3110         } else {
3111                 struct sig_pri_cc_monitor_instance *monitor;
3112
3113                 monitor = sig_pri_find_cc_monitor_by_cc_id(pri, cc_id);
3114                 if (!monitor) {
3115                         return;
3116                 }
3117                 monitor->cc_id = -1;
3118                 ast_cc_monitor_failed(monitor->core_id, monitor->name,
3119                         "%s monitor got canceled by link", sig_pri_cc_type_name);
3120                 ao2_ref(monitor, -1);
3121         }
3122 }
3123 #endif  /* defined(HAVE_PRI_CCSS) */
3124
3125 #if defined(HAVE_PRI_AOC_EVENTS)
3126 /*!
3127  * \internal
3128  * \brief Convert ast_aoc_charged_item to PRI_AOC_CHARGED_ITEM .
3129  * \since 1.8
3130  *
3131  * \param value Value to convert to string.
3132  *
3133  * \return PRI_AOC_CHARGED_ITEM
3134  */
3135 static enum PRI_AOC_CHARGED_ITEM sig_pri_aoc_charged_item_to_pri(enum PRI_AOC_CHARGED_ITEM value)
3136 {
3137         switch (value) {
3138         case AST_AOC_CHARGED_ITEM_NA:
3139                 return PRI_AOC_CHARGED_ITEM_NOT_AVAILABLE;
3140         case AST_AOC_CHARGED_ITEM_SPECIAL_ARRANGEMENT:
3141                 return PRI_AOC_CHARGED_ITEM_SPECIAL_ARRANGEMENT;
3142         case AST_AOC_CHARGED_ITEM_BASIC_COMMUNICATION:
3143                 return PRI_AOC_CHARGED_ITEM_BASIC_COMMUNICATION;
3144         case AST_AOC_CHARGED_ITEM_CALL_ATTEMPT:
3145                 return PRI_AOC_CHARGED_ITEM_CALL_ATTEMPT;
3146         case AST_AOC_CHARGED_ITEM_CALL_SETUP:
3147                 return PRI_AOC_CHARGED_ITEM_CALL_SETUP;
3148         case AST_AOC_CHARGED_ITEM_USER_USER_INFO:
3149                 return PRI_AOC_CHARGED_ITEM_USER_USER_INFO;
3150         case AST_AOC_CHARGED_ITEM_SUPPLEMENTARY_SERVICE:
3151                 return PRI_AOC_CHARGED_ITEM_SUPPLEMENTARY_SERVICE;
3152         }
3153         return PRI_AOC_CHARGED_ITEM_NOT_AVAILABLE;
3154 }
3155 #endif  /* defined(HAVE_PRI_AOC_EVENTS) */
3156
3157 #if defined(HAVE_PRI_AOC_EVENTS)
3158 /*!
3159  * \internal
3160  * \brief Convert PRI_AOC_CHARGED_ITEM to ast_aoc_charged_item.
3161  * \since 1.8
3162  *
3163  * \param value Value to convert to string.
3164  *
3165  * \return ast_aoc_charged_item
3166  */
3167 static enum ast_aoc_s_charged_item sig_pri_aoc_charged_item_to_ast(enum PRI_AOC_CHARGED_ITEM value)
3168 {
3169         switch (value) {
3170         case PRI_AOC_CHARGED_ITEM_NOT_AVAILABLE:
3171                 return AST_AOC_CHARGED_ITEM_NA;
3172         case PRI_AOC_CHARGED_ITEM_SPECIAL_ARRANGEMENT:
3173                 return AST_AOC_CHARGED_ITEM_SPECIAL_ARRANGEMENT;
3174         case PRI_AOC_CHARGED_ITEM_BASIC_COMMUNICATION:
3175                 return AST_AOC_CHARGED_ITEM_BASIC_COMMUNICATION;
3176         case PRI_AOC_CHARGED_ITEM_CALL_ATTEMPT:
3177                 return AST_AOC_CHARGED_ITEM_CALL_ATTEMPT;
3178         case PRI_AOC_CHARGED_ITEM_CALL_SETUP:
3179                 return AST_AOC_CHARGED_ITEM_CALL_SETUP;
3180         case PRI_AOC_CHARGED_ITEM_USER_USER_INFO:
3181                 return AST_AOC_CHARGED_ITEM_USER_USER_INFO;
3182         case PRI_AOC_CHARGED_ITEM_SUPPLEMENTARY_SERVICE:
3183                 return AST_AOC_CHARGED_ITEM_SUPPLEMENTARY_SERVICE;
3184         }
3185         return AST_AOC_CHARGED_ITEM_NA;
3186 }
3187 #endif  /* defined(HAVE_PRI_AOC_EVENTS) */
3188
3189 #if defined(HAVE_PRI_AOC_EVENTS)
3190 /*!
3191  * \internal
3192  * \brief Convert AST_AOC_MULTIPLER to PRI_AOC_MULTIPLIER.
3193  * \since 1.8
3194  *
3195  * \return pri enum equivalent.
3196  */
3197 static int sig_pri_aoc_multiplier_from_ast(enum ast_aoc_currency_multiplier mult)
3198 {
3199         switch (mult) {
3200         case AST_AOC_MULT_ONETHOUSANDTH:
3201                 return PRI_AOC_MULTIPLIER_THOUSANDTH;
3202         case AST_AOC_MULT_ONEHUNDREDTH:
3203                 return PRI_AOC_MULTIPLIER_HUNDREDTH;
3204         case AST_AOC_MULT_ONETENTH:
3205                 return PRI_AOC_MULTIPLIER_TENTH;
3206         case AST_AOC_MULT_ONE:
3207                 return PRI_AOC_MULTIPLIER_ONE;
3208         case AST_AOC_MULT_TEN:
3209                 return PRI_AOC_MULTIPLIER_TEN;
3210         case AST_AOC_MULT_HUNDRED:
3211                 return PRI_AOC_MULTIPLIER_HUNDRED;
3212         case AST_AOC_MULT_THOUSAND:
3213                 return PRI_AOC_MULTIPLIER_THOUSAND;
3214         default:
3215                 return PRI_AOC_MULTIPLIER_ONE;
3216         }
3217 }
3218 #endif  /* defined(HAVE_PRI_AOC_EVENTS) */
3219
3220 #if defined(HAVE_PRI_AOC_EVENTS)
3221 /*!
3222  * \internal
3223  * \brief Convert PRI_AOC_MULTIPLIER to AST_AOC_MULTIPLIER
3224  * \since 1.8
3225  *
3226  * \return ast enum equivalent.
3227  */
3228 static int sig_pri_aoc_multiplier_from_pri(const int mult)
3229 {
3230         switch (mult) {
3231         case PRI_AOC_MULTIPLIER_THOUSANDTH:
3232                 return AST_AOC_MULT_ONETHOUSANDTH;
3233         case PRI_AOC_MULTIPLIER_HUNDREDTH:
3234                 return AST_AOC_MULT_ONEHUNDREDTH;
3235         case PRI_AOC_MULTIPLIER_TENTH:
3236                 return AST_AOC_MULT_ONETENTH;
3237         case PRI_AOC_MULTIPLIER_ONE:
3238                 return AST_AOC_MULT_ONE;
3239         case PRI_AOC_MULTIPLIER_TEN:
3240                 return AST_AOC_MULT_TEN;
3241         case PRI_AOC_MULTIPLIER_HUNDRED:
3242                 return AST_AOC_MULT_HUNDRED;
3243         case PRI_AOC_MULTIPLIER_THOUSAND:
3244                 return AST_AOC_MULT_THOUSAND;
3245         default:
3246                 return AST_AOC_MULT_ONE;
3247         }
3248 }
3249 #endif  /* defined(HAVE_PRI_AOC_EVENTS) */
3250
3251 #if defined(HAVE_PRI_AOC_EVENTS)
3252 /*!
3253  * \internal
3254  * \brief Convert ast_aoc_time_scale representation to PRI_AOC_TIME_SCALE
3255  * \since 1.8
3256  *
3257  * \param value Value to convert to ast representation
3258  *
3259  * \return PRI_AOC_TIME_SCALE
3260  */
3261 static enum PRI_AOC_TIME_SCALE sig_pri_aoc_scale_to_pri(enum ast_aoc_time_scale value)
3262 {
3263         switch (value) {
3264         default:
3265         case AST_AOC_TIME_SCALE_HUNDREDTH_SECOND:
3266                 return PRI_AOC_TIME_SCALE_HUNDREDTH_SECOND;
3267         case AST_AOC_TIME_SCALE_TENTH_SECOND:
3268                 return PRI_AOC_TIME_SCALE_TENTH_SECOND;
3269         case AST_AOC_TIME_SCALE_SECOND:
3270                 return PRI_AOC_TIME_SCALE_SECOND;
3271         case AST_AOC_TIME_SCALE_TEN_SECOND:
3272                 return PRI_AOC_TIME_SCALE_TEN_SECOND;
3273         case AST_AOC_TIME_SCALE_MINUTE:
3274                 return PRI_AOC_TIME_SCALE_MINUTE;
3275         case AST_AOC_TIME_SCALE_HOUR:
3276                 return PRI_AOC_TIME_SCALE_HOUR;
3277         case AST_AOC_TIME_SCALE_DAY:
3278                 return PRI_AOC_TIME_SCALE_DAY;
3279         }
3280 }
3281 #endif  /* defined(HAVE_PRI_AOC_EVENTS) */
3282
3283 #if defined(HAVE_PRI_AOC_EVENTS)
3284 /*!
3285  * \internal
3286  * \brief Convert PRI_AOC_TIME_SCALE to ast aoc representation
3287  * \since 1.8
3288  *
3289  * \param value Value to convert to ast representation
3290  *
3291  * \return ast aoc time scale
3292  */
3293 static enum ast_aoc_time_scale sig_pri_aoc_scale_to_ast(enum PRI_AOC_TIME_SCALE value)
3294 {
3295         switch (value) {
3296         default:
3297         case PRI_AOC_TIME_SCALE_HUNDREDTH_SECOND:
3298                 return AST_AOC_TIME_SCALE_HUNDREDTH_SECOND;
3299         case PRI_AOC_TIME_SCALE_TENTH_SECOND:
3300                 return AST_AOC_TIME_SCALE_TENTH_SECOND;
3301         case PRI_AOC_TIME_SCALE_SECOND:
3302                 return AST_AOC_TIME_SCALE_SECOND;
3303         case PRI_AOC_TIME_SCALE_TEN_SECOND:
3304                 return AST_AOC_TIME_SCALE_TEN_SECOND;
3305         case PRI_AOC_TIME_SCALE_MINUTE:
3306                 return AST_AOC_TIME_SCALE_MINUTE;
3307         case PRI_AOC_TIME_SCALE_HOUR:
3308                 return AST_AOC_TIME_SCALE_HOUR;
3309         case PRI_AOC_TIME_SCALE_DAY:
3310                 return AST_AOC_TIME_SCALE_DAY;
3311         }
3312         return AST_AOC_TIME_SCALE_HUNDREDTH_SECOND;
3313 }
3314 #endif  /* defined(HAVE_PRI_AOC_EVENTS) */
3315
3316 #if defined(HAVE_PRI_AOC_EVENTS)
3317 /*!
3318  * \internal
3319  * \brief Handle AOC-S control frame
3320  * \since 1.8
3321  *
3322  * \param aoc_s AOC-S event parameters.
3323  * \param owner Asterisk channel associated with the call.
3324  * \param passthrough indicating if this message should be queued on the ast channel
3325  *
3326  * \note Assumes the pri->lock is already obtained.
3327  * \note Assumes the sig_pri private is locked
3328  * \note Assumes the owner channel lock is already obtained.
3329  *
3330  * \return Nothing
3331  */
3332 static void sig_pri_aoc_s_from_pri(const struct pri_subcmd_aoc_s *aoc_s, struct ast_channel *owner, int passthrough)
3333 {
3334         struct ast_aoc_decoded *decoded = NULL;
3335         struct ast_aoc_encoded *encoded = NULL;
3336         size_t encoded_size = 0;
3337         int idx;
3338
3339         if (!owner || !aoc_s) {
3340                 return;
3341         }
3342
3343         if (!(decoded = ast_aoc_create(AST_AOC_S, 0, 0))) {
3344                 return;
3345         }
3346
3347         for (idx = 0; idx < aoc_s->num_items; ++idx) {
3348                 enum ast_aoc_s_charged_item charged_item;
3349
3350                 charged_item = sig_pri_aoc_charged_item_to_ast(aoc_s->item[idx].chargeable);
3351                 if (charged_item == AST_AOC_CHARGED_ITEM_NA) {
3352                         /* Delete the unknown charged item from the list. */
3353                         continue;
3354                 }
3355                 switch (aoc_s->item[idx].rate_type) {
3356                 case PRI_AOC_RATE_TYPE_DURATION:
3357                         ast_aoc_s_add_rate_duration(decoded,
3358                                 charged_item,
3359                                 aoc_s->item[idx].rate.duration.amount.cost,
3360                                 sig_pri_aoc_multiplier_from_pri(aoc_s->item[idx].rate.duration.amount.multiplier),
3361                                 aoc_s->item[idx].rate.duration.currency,
3362                                 aoc_s->item[idx].rate.duration.time.length,
3363                                 sig_pri_aoc_scale_to_ast(aoc_s->item[idx].rate.duration.time.scale),
3364                                 aoc_s->item[idx].rate.duration.granularity.length,
3365                                 sig_pri_aoc_scale_to_ast(aoc_s->item[idx].rate.duration.granularity.scale),
3366                                 aoc_s->item[idx].rate.duration.charging_type);
3367                         break;
3368                 case PRI_AOC_RATE_TYPE_FLAT:
3369                         ast_aoc_s_add_rate_flat(decoded,
3370                                 charged_item,
3371                                 aoc_s->item[idx].rate.flat.amount.cost,
3372