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