2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2006, Digium, Inc.
6 * Mark Spencer <markster@digium.com>
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.
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.
21 * \brief True call queues with optional send URL on answer
23 * \author Mark Spencer <markster@digium.com>
25 * \arg Config in \ref Config_qu queues.conf
27 * \par Development notes
28 * \note 2004-11-25: Persistent Dynamic Members added by:
29 * NetNation Communications (www.netnation.com)
30 * Kevin Lindsay <kevinl@netnation.com>
32 * Each dynamic agent in each queue is now stored in the astdb.
33 * When asterisk is restarted, each agent will be automatically
34 * readded into their recorded queues. This feature can be
35 * configured with the 'persistent_members=<1|0>' setting in the
36 * '[general]' category in queues.conf. The default is on.
38 * \note 2004-06-04: Priorities in queues added by inAccess Networks (work funded by Hellas On Line (HOL) www.hol.gr).
40 * \note These features added by David C. Troy <dave@toad.net>:
41 * - Per-queue holdtime calculation
42 * - Estimated holdtime announcement
43 * - Position announcement
44 * - Abandoned/completed call counters
45 * - Failout timer passed as optional app parameter
46 * - Optional monitoring of calls, started when call is answered
48 * Patch Version 1.07 2003-12-24 01
50 * Added servicelevel statistic by Michiel Betel <michiel@betel.nl>
51 * Added Priority jumping code for adding and removing queue members by Jonathan Stanton <asterisk@doilooklikeicare.com>
53 * Fixed to work with CVS as of 2004-02-25 and released as 1.07a
54 * by Matthew Enger <m.enger@xi.com.au>
56 * \ingroup applications
60 <use type="module">res_monitor</use>
61 <support_level>core</support_level>
66 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
69 #include <sys/signal.h>
70 #include <netinet/in.h>
73 #include "asterisk/lock.h"
74 #include "asterisk/file.h"
75 #include "asterisk/channel.h"
76 #include "asterisk/pbx.h"
77 #include "asterisk/app.h"
78 #include "asterisk/linkedlists.h"
79 #include "asterisk/module.h"
80 #include "asterisk/translate.h"
81 #include "asterisk/say.h"
82 #include "asterisk/features.h"
83 #include "asterisk/musiconhold.h"
84 #include "asterisk/cli.h"
85 #include "asterisk/manager.h"
86 #include "asterisk/config.h"
87 #include "asterisk/monitor.h"
88 #include "asterisk/utils.h"
89 #include "asterisk/causes.h"
90 #include "asterisk/astdb.h"
91 #include "asterisk/devicestate.h"
92 #include "asterisk/stringfields.h"
93 #include "asterisk/event.h"
94 #include "asterisk/astobj2.h"
95 #include "asterisk/strings.h"
96 #include "asterisk/global_datastores.h"
97 #include "asterisk/taskprocessor.h"
98 #include "asterisk/aoc.h"
99 #include "asterisk/callerid.h"
100 #include "asterisk/cel.h"
101 #include "asterisk/data.h"
103 /* Define, to debug reference counts on queues, without debugging reference counts on queue members */
104 /* #define REF_DEBUG_ONLY_QUEUES */
107 * \par Please read before modifying this file.
108 * There are three locks which are regularly used
109 * throughout this file, the queue list lock, the lock
110 * for each individual queue, and the interface list lock.
111 * Please be extra careful to always lock in the following order
113 * 2) individual queue lock
114 * 3) interface list lock
115 * This order has sort of "evolved" over the lifetime of this
116 * application, but it is now in place this way, so please adhere
121 <application name="Queue" language="en_US">
123 Queue a call for a call queue.
126 <parameter name="queuename" required="true" />
127 <parameter name="options">
130 <para>Mark all calls as "answered elsewhere" when cancelled.</para>
133 <para>Continue in the dialplan if the callee hangs up.</para>
136 <para>data-quality (modem) call (minimum delay).</para>
139 <para>Allow <emphasis>callee</emphasis> to hang up by pressing <literal>*</literal>.</para>
142 <para>Allow <emphasis>caller</emphasis> to hang up by pressing <literal>*</literal>.</para>
145 <para>No retries on the timeout; will exit this application and
146 go to the next step.</para>
149 <para>Ignore call forward requests from queue members and do nothing
150 when they are requested.</para>
153 <para>Asterisk will ignore any connected line update requests or any redirecting party
154 update requests it may receive on this dial attempt.</para>
157 <para>Ring instead of playing MOH. Periodic Announcements are still made, if applicable.</para>
160 <para>Ring instead of playing MOH when a member channel is actually ringing.</para>
163 <para>Allow the <emphasis>called</emphasis> user to transfer the calling user.</para>
166 <para>Allow the <emphasis>calling</emphasis> user to transfer the call.</para>
169 <para>Allow the <emphasis>called</emphasis> user to write the conversation to
170 disk via Monitor.</para>
173 <para>Allow the <emphasis>calling</emphasis> user to write the conversation to
174 disk via Monitor.</para>
177 <para>Allow the <emphasis>called</emphasis> party to enable parking of the call by sending
178 the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
181 <para>Allow the <emphasis>calling</emphasis> party to enable parking of the call by sending
182 the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
185 <para>Allow the <emphasis>called</emphasis> user to write the conversation
186 to disk via MixMonitor.</para>
189 <para>Allow the <emphasis>calling</emphasis> user to write the conversation to
190 disk via MixMonitor.</para>
194 <parameter name="URL">
195 <para><replaceable>URL</replaceable> will be sent to the called party if the channel supports it.</para>
197 <parameter name="announceoverride" />
198 <parameter name="timeout">
199 <para>Will cause the queue to fail out after a specified number of
200 seconds, checked between each <filename>queues.conf</filename> <replaceable>timeout</replaceable> and
201 <replaceable>retry</replaceable> cycle.</para>
203 <parameter name="AGI">
204 <para>Will setup an AGI script to be executed on the calling party's channel once they are
205 connected to a queue member.</para>
207 <parameter name="macro">
208 <para>Will run a macro on the calling party's channel once they are connected to a queue member.</para>
210 <parameter name="gosub">
211 <para>Will run a gosub on the calling party's channel once they are connected to a queue member.</para>
213 <parameter name="rule">
214 <para>Will cause the queue's defaultrule to be overridden by the rule specified.</para>
216 <parameter name="position">
217 <para>Attempt to enter the caller into the queue at the numerical position specified. <literal>1</literal>
218 would attempt to enter the caller at the head of the queue, and <literal>3</literal> would attempt to place
219 the caller third in the queue.</para>
223 <para>In addition to transferring the call, a call may be parked and then picked
224 up by another user.</para>
225 <para>This application will return to the dialplan if the queue does not exist, or
226 any of the join options cause the caller to not enter the queue.</para>
227 <para>This application does not automatically answer and should be preceeded
228 by an application such as Answer(), Progress(), or Ringing().</para>
229 <para>This application sets the following channel variable upon completion:</para>
231 <variable name="QUEUESTATUS">
232 <para>The status of the call as a text string.</para>
233 <value name="TIMEOUT" />
234 <value name="FULL" />
235 <value name="JOINEMPTY" />
236 <value name="LEAVEEMPTY" />
237 <value name="JOINUNAVAIL" />
238 <value name="LEAVEUNAVAIL" />
239 <value name="CONTINUE" />
244 <ref type="application">Queue</ref>
245 <ref type="application">QueueLog</ref>
246 <ref type="application">AddQueueMember</ref>
247 <ref type="application">RemoveQueueMember</ref>
248 <ref type="application">PauseQueueMember</ref>
249 <ref type="application">UnpauseQueueMember</ref>
250 <ref type="function">QUEUE_VARIABLES</ref>
251 <ref type="function">QUEUE_MEMBER</ref>
252 <ref type="function">QUEUE_MEMBER_COUNT</ref>
253 <ref type="function">QUEUE_EXISTS</ref>
254 <ref type="function">QUEUE_WAITING_COUNT</ref>
255 <ref type="function">QUEUE_MEMBER_LIST</ref>
256 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
259 <application name="AddQueueMember" language="en_US">
261 Dynamically adds queue members.
264 <parameter name="queuename" required="true" />
265 <parameter name="interface" />
266 <parameter name="penalty" />
267 <parameter name="options" />
268 <parameter name="membername" />
269 <parameter name="stateinterface" />
272 <para>Dynamically adds interface to an existing queue. If the interface is
273 already in the queue it will return an error.</para>
274 <para>This application sets the following channel variable upon completion:</para>
276 <variable name="AQMSTATUS">
277 <para>The status of the attempt to add a queue member as a text string.</para>
278 <value name="ADDED" />
279 <value name="MEMBERALREADY" />
280 <value name="NOSUCHQUEUE" />
285 <ref type="application">Queue</ref>
286 <ref type="application">QueueLog</ref>
287 <ref type="application">AddQueueMember</ref>
288 <ref type="application">RemoveQueueMember</ref>
289 <ref type="application">PauseQueueMember</ref>
290 <ref type="application">UnpauseQueueMember</ref>
291 <ref type="function">QUEUE_VARIABLES</ref>
292 <ref type="function">QUEUE_MEMBER</ref>
293 <ref type="function">QUEUE_MEMBER_COUNT</ref>
294 <ref type="function">QUEUE_EXISTS</ref>
295 <ref type="function">QUEUE_WAITING_COUNT</ref>
296 <ref type="function">QUEUE_MEMBER_LIST</ref>
297 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
300 <application name="RemoveQueueMember" language="en_US">
302 Dynamically removes queue members.
305 <parameter name="queuename" required="true" />
306 <parameter name="interface" />
307 <parameter name="options" />
310 <para>If the interface is <emphasis>NOT</emphasis> in the queue it will return an error.</para>
311 <para>This application sets the following channel variable upon completion:</para>
313 <variable name="RQMSTATUS">
314 <value name="REMOVED" />
315 <value name="NOTINQUEUE" />
316 <value name="NOSUCHQUEUE" />
319 <para>Example: RemoveQueueMember(techsupport,SIP/3000)</para>
322 <ref type="application">Queue</ref>
323 <ref type="application">QueueLog</ref>
324 <ref type="application">AddQueueMember</ref>
325 <ref type="application">RemoveQueueMember</ref>
326 <ref type="application">PauseQueueMember</ref>
327 <ref type="application">UnpauseQueueMember</ref>
328 <ref type="function">QUEUE_VARIABLES</ref>
329 <ref type="function">QUEUE_MEMBER</ref>
330 <ref type="function">QUEUE_MEMBER_COUNT</ref>
331 <ref type="function">QUEUE_EXISTS</ref>
332 <ref type="function">QUEUE_WAITING_COUNT</ref>
333 <ref type="function">QUEUE_MEMBER_LIST</ref>
334 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
337 <application name="PauseQueueMember" language="en_US">
339 Pauses a queue member.
342 <parameter name="queuename" />
343 <parameter name="interface" required="true" />
344 <parameter name="options" />
345 <parameter name="reason">
346 <para>Is used to add extra information to the appropriate queue_log entries and manager events.</para>
350 <para>Pauses (blocks calls for) a queue member. The given interface will be paused in the given queue.
351 This prevents any calls from being sent from the queue to the interface until it is
352 unpaused with UnpauseQueueMember or the manager interface. If no queuename is given,
353 the interface is paused in every queue it is a member of. The application will fail if the
354 interface is not found.</para>
355 <para>This application sets the following channel variable upon completion:</para>
357 <variable name="PQMSTATUS">
358 <para>The status of the attempt to pause a queue member as a text string.</para>
359 <value name="PAUSED" />
360 <value name="NOTFOUND" />
363 <para>Example: PauseQueueMember(,SIP/3000)</para>
366 <ref type="application">Queue</ref>
367 <ref type="application">QueueLog</ref>
368 <ref type="application">AddQueueMember</ref>
369 <ref type="application">RemoveQueueMember</ref>
370 <ref type="application">PauseQueueMember</ref>
371 <ref type="application">UnpauseQueueMember</ref>
372 <ref type="function">QUEUE_VARIABLES</ref>
373 <ref type="function">QUEUE_MEMBER</ref>
374 <ref type="function">QUEUE_MEMBER_COUNT</ref>
375 <ref type="function">QUEUE_EXISTS</ref>
376 <ref type="function">QUEUE_WAITING_COUNT</ref>
377 <ref type="function">QUEUE_MEMBER_LIST</ref>
378 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
381 <application name="UnpauseQueueMember" language="en_US">
383 Unpauses a queue member.
386 <parameter name="queuename" />
387 <parameter name="interface" required="true" />
388 <parameter name="options" />
389 <parameter name="reason">
390 <para>Is used to add extra information to the appropriate queue_log entries and manager events.</para>
394 <para>Unpauses (resumes calls to) a queue member. This is the counterpart to <literal>PauseQueueMember()</literal>
395 and operates exactly the same way, except it unpauses instead of pausing the given interface.</para>
396 <para>This application sets the following channel variable upon completion:</para>
398 <variable name="UPQMSTATUS">
399 <para>The status of the attempt to unpause a queue member as a text string.</para>
400 <value name="UNPAUSED" />
401 <value name="NOTFOUND" />
404 <para>Example: UnpauseQueueMember(,SIP/3000)</para>
407 <ref type="application">Queue</ref>
408 <ref type="application">QueueLog</ref>
409 <ref type="application">AddQueueMember</ref>
410 <ref type="application">RemoveQueueMember</ref>
411 <ref type="application">PauseQueueMember</ref>
412 <ref type="application">UnpauseQueueMember</ref>
413 <ref type="function">QUEUE_VARIABLES</ref>
414 <ref type="function">QUEUE_MEMBER</ref>
415 <ref type="function">QUEUE_MEMBER_COUNT</ref>
416 <ref type="function">QUEUE_EXISTS</ref>
417 <ref type="function">QUEUE_WAITING_COUNT</ref>
418 <ref type="function">QUEUE_MEMBER_LIST</ref>
419 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
422 <application name="QueueLog" language="en_US">
424 Writes to the queue_log file.
427 <parameter name="queuename" required="true" />
428 <parameter name="uniqueid" required="true" />
429 <parameter name="agent" required="true" />
430 <parameter name="event" required="true" />
431 <parameter name="additionalinfo" />
434 <para>Allows you to write your own events into the queue log.</para>
435 <para>Example: QueueLog(101,${UNIQUEID},${AGENT},WENTONBREAK,600)</para>
438 <ref type="application">Queue</ref>
439 <ref type="application">QueueLog</ref>
440 <ref type="application">AddQueueMember</ref>
441 <ref type="application">RemoveQueueMember</ref>
442 <ref type="application">PauseQueueMember</ref>
443 <ref type="application">UnpauseQueueMember</ref>
444 <ref type="function">QUEUE_VARIABLES</ref>
445 <ref type="function">QUEUE_MEMBER</ref>
446 <ref type="function">QUEUE_MEMBER_COUNT</ref>
447 <ref type="function">QUEUE_EXISTS</ref>
448 <ref type="function">QUEUE_WAITING_COUNT</ref>
449 <ref type="function">QUEUE_MEMBER_LIST</ref>
450 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
453 <function name="QUEUE_VARIABLES" language="en_US">
455 Return Queue information in variables.
458 <parameter name="queuename" required="true">
460 <enum name="QUEUEMAX">
461 <para>Maxmimum number of calls allowed.</para>
463 <enum name="QUEUESTRATEGY">
464 <para>The strategy of the queue.</para>
466 <enum name="QUEUECALLS">
467 <para>Number of calls currently in the queue.</para>
469 <enum name="QUEUEHOLDTIME">
470 <para>Current average hold time.</para>
472 <enum name="QUEUECOMPLETED">
473 <para>Number of completed calls for the queue.</para>
475 <enum name="QUEUEABANDONED">
476 <para>Number of abandoned calls.</para>
478 <enum name="QUEUESRVLEVEL">
479 <para>Queue service level.</para>
481 <enum name="QUEUESRVLEVELPERF">
482 <para>Current service level performance.</para>
488 <para>Makes the following queue variables available.</para>
489 <para>Returns <literal>0</literal> if queue is found and setqueuevar is defined, <literal>-1</literal> otherwise.</para>
492 <ref type="application">Queue</ref>
493 <ref type="application">QueueLog</ref>
494 <ref type="application">AddQueueMember</ref>
495 <ref type="application">RemoveQueueMember</ref>
496 <ref type="application">PauseQueueMember</ref>
497 <ref type="application">UnpauseQueueMember</ref>
498 <ref type="function">QUEUE_VARIABLES</ref>
499 <ref type="function">QUEUE_MEMBER</ref>
500 <ref type="function">QUEUE_MEMBER_COUNT</ref>
501 <ref type="function">QUEUE_EXISTS</ref>
502 <ref type="function">QUEUE_WAITING_COUNT</ref>
503 <ref type="function">QUEUE_MEMBER_LIST</ref>
504 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
507 <function name="QUEUE_MEMBER" language="en_US">
509 Count number of members answering a queue.
512 <parameter name="queuename" required="true" />
513 <parameter name="option" required="true">
516 <para>Returns the number of logged-in members for the specified queue.</para>
519 <para>Returns the number of logged-in members for the specified queue that either can take calls or are currently wrapping up after a previous call.</para>
522 <para>Returns the number of logged-in members for the specified queue that are immediately available to answer a call.</para>
525 <para>Returns the total number of members for the specified queue.</para>
527 <enum name="penalty">
528 <para>Gets or sets queue member penalty.</para>
531 <para>Gets or sets queue member paused status.</para>
533 <enum name="ignorebusy">
534 <para>Gets or sets queue member ignorebusy.</para>
538 <parameter name="interface" required="false" />
541 <para>Allows access to queue counts [R] and member information [R/W].</para>
543 <replaceable>queuename</replaceable> is required for all operations
544 <replaceable>interface</replaceable> is required for all member operations.
548 <ref type="application">Queue</ref>
549 <ref type="application">QueueLog</ref>
550 <ref type="application">AddQueueMember</ref>
551 <ref type="application">RemoveQueueMember</ref>
552 <ref type="application">PauseQueueMember</ref>
553 <ref type="application">UnpauseQueueMember</ref>
554 <ref type="function">QUEUE_VARIABLES</ref>
555 <ref type="function">QUEUE_MEMBER</ref>
556 <ref type="function">QUEUE_MEMBER_COUNT</ref>
557 <ref type="function">QUEUE_EXISTS</ref>
558 <ref type="function">QUEUE_WAITING_COUNT</ref>
559 <ref type="function">QUEUE_MEMBER_LIST</ref>
560 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
563 <function name="QUEUE_MEMBER_COUNT" language="en_US">
565 Count number of members answering a queue.
568 <parameter name="queuename" required="true" />
571 <para>Returns the number of members currently associated with the specified <replaceable>queuename</replaceable>.</para>
572 <warning><para>This function has been deprecated in favor of the <literal>QUEUE_MEMBER()</literal> function</para></warning>
575 <ref type="application">Queue</ref>
576 <ref type="application">QueueLog</ref>
577 <ref type="application">AddQueueMember</ref>
578 <ref type="application">RemoveQueueMember</ref>
579 <ref type="application">PauseQueueMember</ref>
580 <ref type="application">UnpauseQueueMember</ref>
581 <ref type="function">QUEUE_VARIABLES</ref>
582 <ref type="function">QUEUE_MEMBER</ref>
583 <ref type="function">QUEUE_MEMBER_COUNT</ref>
584 <ref type="function">QUEUE_EXISTS</ref>
585 <ref type="function">QUEUE_WAITING_COUNT</ref>
586 <ref type="function">QUEUE_MEMBER_LIST</ref>
587 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
590 <function name="QUEUE_EXISTS" language="en_US">
592 Check if a named queue exists on this server
595 <parameter name="queuename" />
598 <para>Returns 1 if the specified queue exists, 0 if it does not</para>
601 <ref type="application">Queue</ref>
602 <ref type="application">QueueLog</ref>
603 <ref type="application">AddQueueMember</ref>
604 <ref type="application">RemoveQueueMember</ref>
605 <ref type="application">PauseQueueMember</ref>
606 <ref type="application">UnpauseQueueMember</ref>
607 <ref type="function">QUEUE_VARIABLES</ref>
608 <ref type="function">QUEUE_MEMBER</ref>
609 <ref type="function">QUEUE_MEMBER_COUNT</ref>
610 <ref type="function">QUEUE_EXISTS</ref>
611 <ref type="function">QUEUE_WAITING_COUNT</ref>
612 <ref type="function">QUEUE_MEMBER_LIST</ref>
613 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
616 <function name="QUEUE_WAITING_COUNT" language="en_US">
618 Count number of calls currently waiting in a queue.
621 <parameter name="queuename" />
624 <para>Returns the number of callers currently waiting in the specified <replaceable>queuename</replaceable>.</para>
627 <ref type="application">Queue</ref>
628 <ref type="application">QueueLog</ref>
629 <ref type="application">AddQueueMember</ref>
630 <ref type="application">RemoveQueueMember</ref>
631 <ref type="application">PauseQueueMember</ref>
632 <ref type="application">UnpauseQueueMember</ref>
633 <ref type="function">QUEUE_VARIABLES</ref>
634 <ref type="function">QUEUE_MEMBER</ref>
635 <ref type="function">QUEUE_MEMBER_COUNT</ref>
636 <ref type="function">QUEUE_EXISTS</ref>
637 <ref type="function">QUEUE_WAITING_COUNT</ref>
638 <ref type="function">QUEUE_MEMBER_LIST</ref>
639 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
642 <function name="QUEUE_MEMBER_LIST" language="en_US">
644 Returns a list of interfaces on a queue.
647 <parameter name="queuename" required="true" />
650 <para>Returns a comma-separated list of members associated with the specified <replaceable>queuename</replaceable>.</para>
653 <ref type="application">Queue</ref>
654 <ref type="application">QueueLog</ref>
655 <ref type="application">AddQueueMember</ref>
656 <ref type="application">RemoveQueueMember</ref>
657 <ref type="application">PauseQueueMember</ref>
658 <ref type="application">UnpauseQueueMember</ref>
659 <ref type="function">QUEUE_VARIABLES</ref>
660 <ref type="function">QUEUE_MEMBER</ref>
661 <ref type="function">QUEUE_MEMBER_COUNT</ref>
662 <ref type="function">QUEUE_EXISTS</ref>
663 <ref type="function">QUEUE_WAITING_COUNT</ref>
664 <ref type="function">QUEUE_MEMBER_LIST</ref>
665 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
668 <function name="QUEUE_MEMBER_PENALTY" language="en_US">
670 Gets or sets queue members penalty.
673 <parameter name="queuename" required="true" />
674 <parameter name="interface" required="true" />
677 <para>Gets or sets queue members penalty.</para>
678 <warning><para>This function has been deprecated in favor of the <literal>QUEUE_MEMBER()</literal> function</para></warning>
681 <ref type="application">Queue</ref>
682 <ref type="application">QueueLog</ref>
683 <ref type="application">AddQueueMember</ref>
684 <ref type="application">RemoveQueueMember</ref>
685 <ref type="application">PauseQueueMember</ref>
686 <ref type="application">UnpauseQueueMember</ref>
687 <ref type="function">QUEUE_VARIABLES</ref>
688 <ref type="function">QUEUE_MEMBER</ref>
689 <ref type="function">QUEUE_MEMBER_COUNT</ref>
690 <ref type="function">QUEUE_EXISTS</ref>
691 <ref type="function">QUEUE_WAITING_COUNT</ref>
692 <ref type="function">QUEUE_MEMBER_LIST</ref>
693 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
696 <manager name="Queues" language="en_US">
705 <manager name="QueueStatus" language="en_US">
710 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
711 <parameter name="Queue" />
712 <parameter name="Member" />
717 <manager name="QueueSummary" language="en_US">
722 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
723 <parameter name="Queue" />
728 <manager name="QueueAdd" language="en_US">
730 Add interface to queue.
733 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
734 <parameter name="Queue" required="true" />
735 <parameter name="Interface" required="true" />
736 <parameter name="Penalty" />
737 <parameter name="Paused" />
738 <parameter name="MemberName" />
739 <parameter name="StateInterface" />
744 <manager name="QueueRemove" language="en_US">
746 Remove interface from queue.
749 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
750 <parameter name="Queue" required="true" />
751 <parameter name="Interface" required="true" />
756 <manager name="QueuePause" language="en_US">
758 Makes a queue member temporarily unavailable.
761 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
762 <parameter name="Interface" required="true" />
763 <parameter name="Paused" required="true" />
764 <parameter name="Queue" />
765 <parameter name="Reason" />
770 <manager name="QueueLog" language="en_US">
772 Adds custom entry in queue_log.
775 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
776 <parameter name="Queue" required="true" />
777 <parameter name="Event" required="true" />
778 <parameter name="Uniqueid" />
779 <parameter name="Interface" />
780 <parameter name="Message" />
785 <manager name="QueuePenalty" language="en_US">
787 Set the penalty for a queue member.
790 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
791 <parameter name="Interface" required="true" />
792 <parameter name="Penalty" required="true" />
793 <parameter name="Queue" />
798 <manager name="QueueRule" language="en_US">
803 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
804 <parameter name="Rule" />
809 <manager name="QueueReload" language="en_US">
811 Reload a queue, queues, or any sub-section of a queue or queues.
814 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
815 <parameter name="Queue" />
816 <parameter name="Members">
822 <parameter name="Rules">
828 <parameter name="Parameters">
838 <manager name="QueueReset" language="en_US">
840 Reset queue statistics.
843 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
844 <parameter name="Queue" />
852 QUEUE_STRATEGY_RINGALL = 0,
853 QUEUE_STRATEGY_LEASTRECENT,
854 QUEUE_STRATEGY_FEWESTCALLS,
855 QUEUE_STRATEGY_RANDOM,
856 QUEUE_STRATEGY_RRMEMORY,
857 QUEUE_STRATEGY_LINEAR,
858 QUEUE_STRATEGY_WRANDOM,
859 QUEUE_STRATEGY_RRORDERED,
863 QUEUE_AUTOPAUSE_OFF = 0,
868 enum queue_reload_mask {
869 QUEUE_RELOAD_PARAMETERS = (1 << 0),
870 QUEUE_RELOAD_MEMBER = (1 << 1),
871 QUEUE_RELOAD_RULES = (1 << 2),
872 QUEUE_RESET_STATS = (1 << 3),
875 static const struct strategy {
879 { QUEUE_STRATEGY_RINGALL, "ringall" },
880 { QUEUE_STRATEGY_LEASTRECENT, "leastrecent" },
881 { QUEUE_STRATEGY_FEWESTCALLS, "fewestcalls" },
882 { QUEUE_STRATEGY_RANDOM, "random" },
883 { QUEUE_STRATEGY_RRMEMORY, "rrmemory" },
884 { QUEUE_STRATEGY_RRMEMORY, "roundrobin" },
885 { QUEUE_STRATEGY_LINEAR, "linear" },
886 { QUEUE_STRATEGY_WRANDOM, "wrandom"},
887 { QUEUE_STRATEGY_RRORDERED, "rrordered"},
890 static const struct autopause {
893 } autopausesmodes [] = {
894 { QUEUE_AUTOPAUSE_OFF,"no" },
895 { QUEUE_AUTOPAUSE_ON, "yes" },
896 { QUEUE_AUTOPAUSE_ALL,"all" },
900 static struct ast_taskprocessor *devicestate_tps;
902 #define DEFAULT_RETRY 5
903 #define DEFAULT_TIMEOUT 15
904 #define RECHECK 1 /*!< Recheck every second to see we we're at the top yet */
905 #define MAX_PERIODIC_ANNOUNCEMENTS 10 /*!< The maximum periodic announcements we can have */
906 #define DEFAULT_MIN_ANNOUNCE_FREQUENCY 15 /*!< The minimum number of seconds between position announcements \
907 The default value of 15 provides backwards compatibility */
908 #define MAX_QUEUE_BUCKETS 53
910 #define RES_OKAY 0 /*!< Action completed */
911 #define RES_EXISTS (-1) /*!< Entry already exists */
912 #define RES_OUTOFMEMORY (-2) /*!< Out of memory */
913 #define RES_NOSUCHQUEUE (-3) /*!< No such queue */
914 #define RES_NOT_DYNAMIC (-4) /*!< Member is not dynamic */
916 static char *app = "Queue";
918 static char *app_aqm = "AddQueueMember" ;
920 static char *app_rqm = "RemoveQueueMember" ;
922 static char *app_pqm = "PauseQueueMember" ;
924 static char *app_upqm = "UnpauseQueueMember" ;
926 static char *app_ql = "QueueLog" ;
928 /*! \brief Persistent Members astdb family */
929 static const char * const pm_family = "Queue/PersistentMembers";
930 /* The maximum length of each persistent member queue database entry */
931 #define PM_MAX_LEN 8192
933 /*! \brief queues.conf [general] option */
934 static int queue_persistent_members = 0;
936 /*! \brief queues.conf per-queue weight option */
937 static int use_weight = 0;
939 /*! \brief queues.conf [general] option */
940 static int autofill_default = 1;
942 /*! \brief queues.conf [general] option */
943 static int montype_default = 0;
945 /*! \brief queues.conf [general] option */
946 static int shared_lastcall = 1;
948 /*! \brief Subscription to device state change events */
949 static struct ast_event_sub *device_state_sub;
951 /*! \brief queues.conf [general] option */
952 static int update_cdr = 0;
954 /*! \brief queues.conf [general] option */
955 static int negative_penalty_invalid = 0;
957 /*! \brief queues.conf [general] option */
958 static int log_membername_as_agent = 0;
960 /*! \brief queues.conf [general] option */
961 static int check_state_unknown = 0;
967 QUEUE_LEAVEEMPTY = 3,
968 QUEUE_JOINUNAVAIL = 4,
969 QUEUE_LEAVEUNAVAIL = 5,
974 static const struct {
975 enum queue_result id;
977 } queue_results[] = {
978 { QUEUE_UNKNOWN, "UNKNOWN" },
979 { QUEUE_TIMEOUT, "TIMEOUT" },
980 { QUEUE_JOINEMPTY,"JOINEMPTY" },
981 { QUEUE_LEAVEEMPTY, "LEAVEEMPTY" },
982 { QUEUE_JOINUNAVAIL, "JOINUNAVAIL" },
983 { QUEUE_LEAVEUNAVAIL, "LEAVEUNAVAIL" },
984 { QUEUE_FULL, "FULL" },
985 { QUEUE_CONTINUE, "CONTINUE" },
988 enum queue_timeout_priority {
989 TIMEOUT_PRIORITY_APP,
990 TIMEOUT_PRIORITY_CONF,
993 /*! \brief We define a custom "local user" structure because we
994 * use it not only for keeping track of what is in use but
995 * also for keeping track of who we're dialing.
997 * There are two "links" defined in this structure, q_next and call_next.
998 * q_next links ALL defined callattempt structures into a linked list. call_next is
999 * a link which allows for a subset of the callattempts to be traversed. This subset
1000 * is used in wait_for_answer so that irrelevant callattempts are not traversed. This
1001 * also is helpful so that queue logs are always accurate in the case where a call to
1002 * a member times out, especially if using the ringall strategy.
1005 struct callattempt {
1006 struct callattempt *q_next;
1007 struct callattempt *call_next;
1008 struct ast_channel *chan;
1009 char interface[256];
1013 struct call_queue *lastqueue;
1014 struct member *member;
1015 /*! Saved connected party info from an AST_CONTROL_CONNECTED_LINE. */
1016 struct ast_party_connected_line connected;
1017 /*! TRUE if an AST_CONTROL_CONNECTED_LINE update was saved to the connected element. */
1018 unsigned int pending_connected_update:1;
1019 /*! TRUE if caller id is not available for connected line */
1020 unsigned int dial_callerid_absent:1;
1021 struct ast_aoc_decoded *aoc_s_rate_list;
1026 struct call_queue *parent; /*!< What queue is our parent */
1027 char moh[80]; /*!< Name of musiconhold to be used */
1028 char announce[PATH_MAX]; /*!< Announcement to play for member when call is answered */
1029 char context[AST_MAX_CONTEXT]; /*!< Context when user exits queue */
1030 char digits[AST_MAX_EXTENSION]; /*!< Digits entered while in queue */
1031 int valid_digits; /*!< Digits entered correspond to valid extension. Exited */
1032 int pos; /*!< Where we are in the queue */
1033 int prio; /*!< Our priority */
1034 int last_pos_said; /*!< Last position we told the user */
1035 int ring_when_ringing; /*!< Should we only use ring indication when a channel is ringing? */
1036 time_t last_periodic_announce_time; /*!< The last time we played a periodic announcement */
1037 int last_periodic_announce_sound; /*!< The last periodic announcement we made */
1038 time_t last_pos; /*!< Last time we told the user their position */
1039 int opos; /*!< Where we started in the queue */
1040 int handled; /*!< Whether our call was handled */
1041 int pending; /*!< Non-zero if we are attempting to call a member */
1042 int max_penalty; /*!< Limit the members that can take this call to this penalty or lower */
1043 int min_penalty; /*!< Limit the members that can take this call to this penalty or higher */
1044 int linpos; /*!< If using linear strategy, what position are we at? */
1045 int linwrapped; /*!< Is the linpos wrapped? */
1046 time_t start; /*!< When we started holding */
1047 time_t expire; /*!< When this entry should expire (time out of queue) */
1048 int cancel_answered_elsewhere; /*!< Whether we should force the CAE flag on this call (C) option*/
1049 struct ast_channel *chan; /*!< Our channel */
1050 AST_LIST_HEAD_NOLOCK(,penalty_rule) qe_rules; /*!< Local copy of the queue's penalty rules */
1051 struct penalty_rule *pr; /*!< Pointer to the next penalty rule to implement */
1052 struct queue_ent *next; /*!< The next queue entry */
1056 char interface[80]; /*!< Technology/Location to dial to reach this member*/
1057 char state_exten[AST_MAX_EXTENSION]; /*!< Extension to get state from (if using hint) */
1058 char state_context[AST_MAX_CONTEXT]; /*!< Context to use when getting state (if using hint) */
1059 char state_interface[80]; /*!< Technology/Location from which to read devicestate changes */
1060 char membername[80]; /*!< Member name to use in queue logs */
1061 int penalty; /*!< Are we a last resort? */
1062 int calls; /*!< Number of calls serviced by this member */
1063 int dynamic; /*!< Are we dynamically added? */
1064 int realtime; /*!< Is this member realtime? */
1065 int status; /*!< Status of queue member */
1066 int paused; /*!< Are we paused (not accepting calls)? */
1067 time_t lastcall; /*!< When last successful call was hungup */
1068 struct call_queue *lastqueue; /*!< Last queue we received a call */
1069 unsigned int dead:1; /*!< Used to detect members deleted in realtime */
1070 unsigned int delme:1; /*!< Flag to delete entry on reload */
1071 char rt_uniqueid[80]; /*!< Unique id of realtime member entry */
1072 unsigned int ignorebusy:1; /*!< Flag to ignore member if the status is not available */
1075 enum empty_conditions {
1076 QUEUE_EMPTY_PENALTY = (1 << 0),
1077 QUEUE_EMPTY_PAUSED = (1 << 1),
1078 QUEUE_EMPTY_INUSE = (1 << 2),
1079 QUEUE_EMPTY_RINGING = (1 << 3),
1080 QUEUE_EMPTY_UNAVAILABLE = (1 << 4),
1081 QUEUE_EMPTY_INVALID = (1 << 5),
1082 QUEUE_EMPTY_UNKNOWN = (1 << 6),
1083 QUEUE_EMPTY_WRAPUP = (1 << 7),
1086 /* values used in multi-bit flags in call_queue */
1087 #define ANNOUNCEHOLDTIME_ALWAYS 1
1088 #define ANNOUNCEHOLDTIME_ONCE 2
1089 #define QUEUE_EVENT_VARIABLES 3
1091 struct penalty_rule {
1092 int time; /*!< Number of seconds that need to pass before applying this rule */
1093 int max_value; /*!< The amount specified in the penalty rule for max penalty */
1094 int min_value; /*!< The amount specified in the penalty rule for min penalty */
1095 int max_relative; /*!< Is the max adjustment relative? 1 for relative, 0 for absolute */
1096 int min_relative; /*!< Is the min adjustment relative? 1 for relative, 0 for absolute */
1097 AST_LIST_ENTRY(penalty_rule) list; /*!< Next penalty_rule */
1100 #define ANNOUNCEPOSITION_YES 1 /*!< We announce position */
1101 #define ANNOUNCEPOSITION_NO 2 /*!< We don't announce position */
1102 #define ANNOUNCEPOSITION_MORE_THAN 3 /*!< We say "Currently there are more than <limit>" */
1103 #define ANNOUNCEPOSITION_LIMIT 4 /*!< We not announce position more than <limit> */
1106 AST_DECLARE_STRING_FIELDS(
1108 AST_STRING_FIELD(name);
1109 /*! Music on Hold class */
1110 AST_STRING_FIELD(moh);
1111 /*! Announcement to play when call is answered */
1112 AST_STRING_FIELD(announce);
1114 AST_STRING_FIELD(context);
1115 /*! Macro to run upon member connection */
1116 AST_STRING_FIELD(membermacro);
1117 /*! Gosub to run upon member connection */
1118 AST_STRING_FIELD(membergosub);
1119 /*! Default rule to use if none specified in call to Queue() */
1120 AST_STRING_FIELD(defaultrule);
1121 /*! Sound file: "Your call is now first in line" (def. queue-youarenext) */
1122 AST_STRING_FIELD(sound_next);
1123 /*! Sound file: "There are currently" (def. queue-thereare) */
1124 AST_STRING_FIELD(sound_thereare);
1125 /*! Sound file: "calls waiting to speak to a representative." (def. queue-callswaiting) */
1126 AST_STRING_FIELD(sound_calls);
1127 /*! Sound file: "Currently there are more than" (def. queue-quantity1) */
1128 AST_STRING_FIELD(queue_quantity1);
1129 /*! Sound file: "callers waiting to speak with a representative" (def. queue-quantity2) */
1130 AST_STRING_FIELD(queue_quantity2);
1131 /*! Sound file: "The current estimated total holdtime is" (def. queue-holdtime) */
1132 AST_STRING_FIELD(sound_holdtime);
1133 /*! Sound file: "minutes." (def. queue-minutes) */
1134 AST_STRING_FIELD(sound_minutes);
1135 /*! Sound file: "minute." (def. queue-minute) */
1136 AST_STRING_FIELD(sound_minute);
1137 /*! Sound file: "seconds." (def. queue-seconds) */
1138 AST_STRING_FIELD(sound_seconds);
1139 /*! Sound file: "Thank you for your patience." (def. queue-thankyou) */
1140 AST_STRING_FIELD(sound_thanks);
1141 /*! Sound file: Custom announce for caller, no default */
1142 AST_STRING_FIELD(sound_callerannounce);
1143 /*! Sound file: "Hold time" (def. queue-reporthold) */
1144 AST_STRING_FIELD(sound_reporthold);
1146 /*! Sound files: Custom announce, no default */
1147 struct ast_str *sound_periodicannounce[MAX_PERIODIC_ANNOUNCEMENTS];
1148 unsigned int dead:1;
1149 unsigned int eventwhencalled:2;
1150 unsigned int ringinuse:1;
1151 unsigned int setinterfacevar:1;
1152 unsigned int setqueuevar:1;
1153 unsigned int setqueueentryvar:1;
1154 unsigned int reportholdtime:1;
1155 unsigned int wrapped:1;
1156 unsigned int timeoutrestart:1;
1157 unsigned int announceholdtime:2;
1158 unsigned int announceposition:3;
1160 unsigned int maskmemberstatus:1;
1161 unsigned int realtime:1;
1162 unsigned int found:1;
1163 unsigned int relativeperiodicannounce:1;
1164 unsigned int autopausebusy:1;
1165 unsigned int autopauseunavail:1;
1166 enum empty_conditions joinempty;
1167 enum empty_conditions leavewhenempty;
1168 int announcepositionlimit; /*!< How many positions we announce? */
1169 int announcefrequency; /*!< How often to announce their position */
1170 int minannouncefrequency; /*!< The minimum number of seconds between position announcements (def. 15) */
1171 int periodicannouncefrequency; /*!< How often to play periodic announcement */
1172 int numperiodicannounce; /*!< The number of periodic announcements configured */
1173 int randomperiodicannounce; /*!< Are periodic announcments randomly chosen */
1174 int roundingseconds; /*!< How many seconds do we round to? */
1175 int holdtime; /*!< Current avg holdtime, based on an exponential average */
1176 int talktime; /*!< Current avg talktime, based on the same exponential average */
1177 int callscompleted; /*!< Number of queue calls completed */
1178 int callsabandoned; /*!< Number of queue calls abandoned */
1179 int servicelevel; /*!< seconds setting for servicelevel*/
1180 int callscompletedinsl; /*!< Number of calls answered with servicelevel*/
1181 char monfmt[8]; /*!< Format to use when recording calls */
1182 int montype; /*!< Monitor type Monitor vs. MixMonitor */
1183 int count; /*!< How many entries */
1184 int maxlen; /*!< Max number of entries */
1185 int wrapuptime; /*!< Wrapup Time */
1186 int penaltymemberslimit; /*!< Disregard penalty when queue has fewer than this many members */
1188 int retry; /*!< Retry calling everyone after this amount of time */
1189 int timeout; /*!< How long to wait for an answer */
1190 int weight; /*!< Respective weight */
1191 int autopause; /*!< Auto pause queue members if they fail to answer */
1192 int autopausedelay; /*!< Delay auto pause for autopausedelay seconds since last call */
1193 int timeoutpriority; /*!< Do we allow a fraction of the timeout to occur for a ring? */
1195 /* Queue strategy things */
1196 int rrpos; /*!< Round Robin - position */
1197 int memberdelay; /*!< Seconds to delay connecting member to caller */
1198 int autofill; /*!< Ignore the head call status and ring an available agent */
1200 struct ao2_container *members; /*!< Head of the list of members */
1201 struct queue_ent *head; /*!< Head of the list of callers */
1202 AST_LIST_ENTRY(call_queue) list; /*!< Next call queue */
1203 AST_LIST_HEAD_NOLOCK(, penalty_rule) rules; /*!< The list of penalty rules to invoke */
1208 AST_LIST_HEAD_NOLOCK(,penalty_rule) rules;
1209 AST_LIST_ENTRY(rule_list) list;
1212 static AST_LIST_HEAD_STATIC(rule_lists, rule_list);
1214 static struct ao2_container *queues;
1216 static void update_realtime_members(struct call_queue *q);
1217 static struct member *interface_exists(struct call_queue *q, const char *interface);
1218 static int set_member_paused(const char *queuename, const char *interface, const char *reason, int paused);
1220 static void queue_transfer_fixup(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan);
1222 static struct member *find_member_by_queuename_and_interface(const char *queuename, const char *interface);
1223 /*! \brief sets the QUEUESTATUS channel variable */
1224 static void set_queue_result(struct ast_channel *chan, enum queue_result res)
1228 for (i = 0; i < ARRAY_LEN(queue_results); i++) {
1229 if (queue_results[i].id == res) {
1230 pbx_builtin_setvar_helper(chan, "QUEUESTATUS", queue_results[i].text);
1236 static const char *int2strat(int strategy)
1240 for (x = 0; x < ARRAY_LEN(strategies); x++) {
1241 if (strategy == strategies[x].strategy)
1242 return strategies[x].name;
1248 static int strat2int(const char *strategy)
1252 for (x = 0; x < ARRAY_LEN(strategies); x++) {
1253 if (!strcasecmp(strategy, strategies[x].name))
1254 return strategies[x].strategy;
1260 static int autopause2int(const char *autopause)
1263 /*This 'double check' that default value is OFF */
1264 if (ast_strlen_zero(autopause))
1265 return QUEUE_AUTOPAUSE_OFF;
1267 /*This 'double check' is to ensure old values works */
1268 if(ast_true(autopause))
1269 return QUEUE_AUTOPAUSE_ON;
1271 for (x = 0; x < ARRAY_LEN(autopausesmodes); x++) {
1272 if (!strcasecmp(autopause, autopausesmodes[x].name))
1273 return autopausesmodes[x].autopause;
1276 /*This 'double check' that default value is OFF */
1277 return QUEUE_AUTOPAUSE_OFF;
1280 static int queue_hash_cb(const void *obj, const int flags)
1282 const struct call_queue *q = obj;
1284 return ast_str_case_hash(q->name);
1287 static int queue_cmp_cb(void *obj, void *arg, int flags)
1289 struct call_queue *q = obj, *q2 = arg;
1290 return !strcasecmp(q->name, q2->name) ? CMP_MATCH | CMP_STOP : 0;
1293 #ifdef REF_DEBUG_ONLY_QUEUES
1294 #define queue_ref(a) __ao2_ref_debug(a,1,"",__FILE__,__LINE__,__PRETTY_FUNCTION__)
1295 #define queue_unref(a) __ao2_ref_debug(a,-1,"",__FILE__,__LINE__,__PRETTY_FUNCTION__)
1296 #define queue_t_ref(a,b) __ao2_ref_debug(a,1,b,__FILE__,__LINE__,__PRETTY_FUNCTION__)
1297 #define queue_t_unref(a,b) __ao2_ref_debug(a,-1,b,__FILE__,__LINE__,__PRETTY_FUNCTION__)
1298 #define queues_t_link(c,q,tag) __ao2_link_debug(c,q,tag,__FILE__,__LINE__,__PRETTY_FUNCTION__)
1299 #define queues_t_unlink(c,q,tag) __ao2_unlink_debug(c,q,tag,__FILE__,__LINE__,__PRETTY_FUNCTION__)
1301 #define queue_t_ref(a,b) queue_ref(a)
1302 #define queue_t_unref(a,b) queue_unref(a)
1303 #define queues_t_link(c,q,tag) ao2_t_link(c,q,tag)
1304 #define queues_t_unlink(c,q,tag) ao2_t_unlink(c,q,tag)
1305 static inline struct call_queue *queue_ref(struct call_queue *q)
1311 static inline struct call_queue *queue_unref(struct call_queue *q)
1318 /*! \brief Set variables of queue */
1319 static void set_queue_variables(struct call_queue *q, struct ast_channel *chan)
1321 char interfacevar[256]="";
1326 if (q->setqueuevar) {
1328 if (q->callscompleted > 0)
1329 sl = 100 * ((float) q->callscompletedinsl / (float) q->callscompleted);
1331 snprintf(interfacevar, sizeof(interfacevar),
1332 "QUEUENAME=%s,QUEUEMAX=%d,QUEUESTRATEGY=%s,QUEUECALLS=%d,QUEUEHOLDTIME=%d,QUEUETALKTIME=%d,QUEUECOMPLETED=%d,QUEUEABANDONED=%d,QUEUESRVLEVEL=%d,QUEUESRVLEVELPERF=%2.1f",
1333 q->name, q->maxlen, int2strat(q->strategy), q->count, q->holdtime, q->talktime, q->callscompleted, q->callsabandoned, q->servicelevel, sl);
1337 pbx_builtin_setvar_multiple(chan, interfacevar);
1343 /*! \brief Insert the 'new' entry after the 'prev' entry of queue 'q' */
1344 static inline void insert_entry(struct call_queue *q, struct queue_ent *prev, struct queue_ent *new, int *pos)
1346 struct queue_ent *cur;
1359 /* every queue_ent must have a reference to it's parent call_queue, this
1360 * reference does not go away until the end of the queue_ent's life, meaning
1361 * that even when the queue_ent leaves the call_queue this ref must remain. */
1364 new->pos = ++(*pos);
1368 /*! \brief Check if members are available
1370 * This function checks to see if members are available to be called. If any member
1371 * is available, the function immediately returns 0. If no members are available,
1372 * then -1 is returned.
1374 static int get_member_status(struct call_queue *q, int max_penalty, int min_penalty, enum empty_conditions conditions)
1376 struct member *member;
1377 struct ao2_iterator mem_iter;
1380 mem_iter = ao2_iterator_init(q->members, 0);
1381 for (; (member = ao2_iterator_next(&mem_iter)); ao2_ref(member, -1)) {
1382 if ((max_penalty && (member->penalty > max_penalty)) || (min_penalty && (member->penalty < min_penalty))) {
1383 if (conditions & QUEUE_EMPTY_PENALTY) {
1384 ast_debug(4, "%s is unavailable because his penalty is not between %d and %d\n", member->membername, min_penalty, max_penalty);
1389 switch (member->status) {
1390 case AST_DEVICE_INVALID:
1391 if (conditions & QUEUE_EMPTY_INVALID) {
1392 ast_debug(4, "%s is unavailable because his device state is 'invalid'\n", member->membername);
1396 case AST_DEVICE_UNAVAILABLE:
1397 if (conditions & QUEUE_EMPTY_UNAVAILABLE) {
1398 ast_debug(4, "%s is unavailable because his device state is 'unavailable'\n", member->membername);
1402 case AST_DEVICE_INUSE:
1403 if (conditions & QUEUE_EMPTY_INUSE) {
1404 ast_debug(4, "%s is unavailable because his device state is 'inuse'\n", member->membername);
1408 case AST_DEVICE_RINGING:
1409 if (conditions & QUEUE_EMPTY_RINGING) {
1410 ast_debug(4, "%s is unavailable because his device state is 'ringing'\n", member->membername);
1414 case AST_DEVICE_UNKNOWN:
1415 if (conditions & QUEUE_EMPTY_UNKNOWN) {
1416 ast_debug(4, "%s is unavailable because his device state is 'unknown'\n", member->membername);
1422 if (member->paused && (conditions & QUEUE_EMPTY_PAUSED)) {
1423 ast_debug(4, "%s is unavailable because he is paused'\n", member->membername);
1425 } else if ((conditions & QUEUE_EMPTY_WRAPUP) && member->lastcall && q->wrapuptime && (time(NULL) - q->wrapuptime < member->lastcall)) {
1426 ast_debug(4, "%s is unavailable because it has only been %d seconds since his last call (wrapup time is %d)\n", member->membername, (int) (time(NULL) - member->lastcall), q->wrapuptime);
1430 ao2_ref(member, -1);
1431 ao2_iterator_destroy(&mem_iter);
1432 ast_debug(4, "%s is available.\n", member->membername);
1438 ao2_iterator_destroy(&mem_iter);
1444 struct statechange {
1445 AST_LIST_ENTRY(statechange) entry;
1450 /*! \brief set a member's status based on device state of that member's state_interface.
1452 * Lock interface list find sc, iterate through each queues queue_member list for member to
1453 * update state inside queues
1455 static int update_status(struct call_queue *q, struct member *m, const int status)
1459 if (q->maskmemberstatus)
1462 manager_event(EVENT_FLAG_AGENT, "QueueMemberStatus",
1465 "MemberName: %s\r\n"
1466 "StateInterface: %s\r\n"
1467 "Membership: %s\r\n"
1469 "CallsTaken: %d\r\n"
1473 q->name, m->interface, m->membername, m->state_interface, m->dynamic ? "dynamic" : m->realtime ? "realtime" : "static",
1474 m->penalty, m->calls, (int)m->lastcall, m->status, m->paused
1480 /*! \brief set a member's status based on device state of that member's interface*/
1481 static int handle_statechange(void *datap)
1483 struct statechange *sc = datap;
1484 struct ao2_iterator miter, qiter;
1486 struct call_queue *q;
1487 char interface[80], *slash_pos;
1490 qiter = ao2_iterator_init(queues, 0);
1491 while ((q = ao2_t_iterator_next(&qiter, "Iterate over queues"))) {
1494 miter = ao2_iterator_init(q->members, 0);
1495 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
1496 ast_copy_string(interface, m->state_interface, sizeof(interface));
1498 if ((slash_pos = strchr(interface, '/')))
1499 if (!strncasecmp(interface, "Local/", 6) && (slash_pos = strchr(slash_pos + 1, '/')))
1502 if (!strcasecmp(interface, sc->dev)) {
1504 update_status(q, m, sc->state);
1509 ao2_iterator_destroy(&miter);
1512 queue_t_unref(q, "Done with iterator");
1514 ao2_iterator_destroy(&qiter);
1517 ast_debug(1, "Device '%s' changed to state '%d' (%s)\n", sc->dev, sc->state, ast_devstate2str(sc->state));
1519 ast_debug(3, "Device '%s' changed to state '%d' (%s) but we don't care because they're not a member of any queue.\n", sc->dev, sc->state, ast_devstate2str(sc->state));
1525 static void device_state_cb(const struct ast_event *event, void *unused)
1527 enum ast_device_state state;
1529 struct statechange *sc;
1532 state = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE);
1533 device = ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE);
1535 if (ast_strlen_zero(device)) {
1536 ast_log(LOG_ERROR, "Received invalid event that had no device IE\n");
1539 datapsize = sizeof(*sc) + strlen(device) + 1;
1540 if (!(sc = ast_calloc(1, datapsize))) {
1541 ast_log(LOG_ERROR, "failed to calloc a state change struct\n");
1545 strcpy(sc->dev, device);
1546 if (ast_taskprocessor_push(devicestate_tps, handle_statechange, sc) < 0) {
1551 /*! \brief Helper function which converts from extension state to device state values */
1552 static int extensionstate2devicestate(int state)
1555 case AST_EXTENSION_NOT_INUSE:
1556 state = AST_DEVICE_NOT_INUSE;
1558 case AST_EXTENSION_INUSE:
1559 state = AST_DEVICE_INUSE;
1561 case AST_EXTENSION_BUSY:
1562 state = AST_DEVICE_BUSY;
1564 case AST_EXTENSION_RINGING:
1565 state = AST_DEVICE_RINGING;
1567 case AST_EXTENSION_ONHOLD:
1568 state = AST_DEVICE_ONHOLD;
1570 case AST_EXTENSION_UNAVAILABLE:
1571 state = AST_DEVICE_UNAVAILABLE;
1573 case AST_EXTENSION_REMOVED:
1574 case AST_EXTENSION_DEACTIVATED:
1576 state = AST_DEVICE_INVALID;
1583 static int extension_state_cb(const char *context, const char *exten, enum ast_extension_states state, void *data)
1585 struct ao2_iterator miter, qiter;
1587 struct call_queue *q;
1588 int found = 0, device_state = extensionstate2devicestate(state);
1590 qiter = ao2_iterator_init(queues, 0);
1591 while ((q = ao2_t_iterator_next(&qiter, "Iterate through queues"))) {
1594 miter = ao2_iterator_init(q->members, 0);
1595 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
1596 if (!strcmp(m->state_context, context) && !strcmp(m->state_exten, exten)) {
1597 update_status(q, m, device_state);
1603 ao2_iterator_destroy(&miter);
1606 queue_t_unref(q, "Done with iterator");
1608 ao2_iterator_destroy(&qiter);
1611 ast_debug(1, "Extension '%s@%s' changed to state '%d' (%s)\n", exten, context, device_state, ast_devstate2str(device_state));
1613 ast_debug(3, "Extension '%s@%s' changed to state '%d' (%s) but we don't care because they're not a member of any queue.\n",
1614 exten, context, device_state, ast_devstate2str(device_state));
1620 /*! \brief Return the current state of a member */
1621 static int get_queue_member_status(struct member *cur)
1623 return ast_strlen_zero(cur->state_exten) ? ast_device_state(cur->state_interface) : extensionstate2devicestate(ast_extension_state(NULL, cur->state_context, cur->state_exten));
1626 /*! \brief allocate space for new queue member and set fields based on parameters passed */
1627 static struct member *create_queue_member(const char *interface, const char *membername, int penalty, int paused, const char *state_interface)
1631 if ((cur = ao2_alloc(sizeof(*cur), NULL))) {
1632 cur->penalty = penalty;
1633 cur->paused = paused;
1634 ast_copy_string(cur->interface, interface, sizeof(cur->interface));
1635 if (!ast_strlen_zero(state_interface)) {
1636 ast_copy_string(cur->state_interface, state_interface, sizeof(cur->state_interface));
1638 ast_copy_string(cur->state_interface, interface, sizeof(cur->state_interface));
1640 if (!ast_strlen_zero(membername)) {
1641 ast_copy_string(cur->membername, membername, sizeof(cur->membername));
1643 ast_copy_string(cur->membername, interface, sizeof(cur->membername));
1645 if (!strchr(cur->interface, '/')) {
1646 ast_log(LOG_WARNING, "No location at interface '%s'\n", interface);
1648 if (!strncmp(cur->state_interface, "hint:", 5)) {
1649 char *tmp = ast_strdupa(cur->state_interface), *context = tmp;
1650 char *exten = strsep(&context, "@") + 5;
1652 ast_copy_string(cur->state_exten, exten, sizeof(cur->state_exten));
1653 ast_copy_string(cur->state_context, S_OR(context, "default"), sizeof(cur->state_context));
1655 cur->status = get_queue_member_status(cur);
1662 static int compress_char(const char c)
1672 static int member_hash_fn(const void *obj, const int flags)
1674 const struct member *mem = obj;
1675 const char *interface = (flags & OBJ_KEY) ? obj : mem->interface;
1676 const char *chname = strchr(interface, '/');
1682 for (i = 0; i < 5 && chname[i]; i++) {
1683 ret += compress_char(chname[i]) << (i * 6);
1688 static int member_cmp_fn(void *obj1, void *obj2, int flags)
1690 struct member *mem1 = obj1;
1691 struct member *mem2 = obj2;
1692 const char *interface = (flags & OBJ_KEY) ? obj2 : mem2->interface;
1694 return strcasecmp(mem1->interface, interface) ? 0 : CMP_MATCH | CMP_STOP;
1698 * \brief Initialize Queue default values.
1699 * \note the queue's lock must be held before executing this function
1701 static void init_queue(struct call_queue *q)
1704 struct penalty_rule *pr_iter;
1707 q->retry = DEFAULT_RETRY;
1708 q->timeout = DEFAULT_TIMEOUT;
1710 q->announcefrequency = 0;
1711 q->minannouncefrequency = DEFAULT_MIN_ANNOUNCE_FREQUENCY;
1712 q->announceholdtime = 1;
1713 q->announcepositionlimit = 10; /* Default 10 positions */
1714 q->announceposition = ANNOUNCEPOSITION_YES; /* Default yes */
1715 q->roundingseconds = 0; /* Default - don't announce seconds */
1716 q->servicelevel = 0;
1718 q->setinterfacevar = 0;
1720 q->setqueueentryvar = 0;
1721 q->autofill = autofill_default;
1722 q->montype = montype_default;
1723 q->monfmt[0] = '\0';
1724 q->reportholdtime = 0;
1726 q->penaltymemberslimit = 0;
1728 q->leavewhenempty = 0;
1730 q->maskmemberstatus = 0;
1731 q->eventwhencalled = 0;
1733 q->timeoutrestart = 0;
1734 q->periodicannouncefrequency = 0;
1735 q->randomperiodicannounce = 0;
1736 q->numperiodicannounce = 0;
1737 q->autopause = QUEUE_AUTOPAUSE_OFF;
1738 q->timeoutpriority = TIMEOUT_PRIORITY_APP;
1739 q->autopausedelay = 0;
1741 if (q->strategy == QUEUE_STRATEGY_LINEAR || q->strategy == QUEUE_STRATEGY_RRORDERED)
1742 /* linear strategy depends on order, so we have to place all members in a single bucket */
1743 q->members = ao2_container_alloc(1, member_hash_fn, member_cmp_fn);
1745 q->members = ao2_container_alloc(37, member_hash_fn, member_cmp_fn);
1749 ast_string_field_set(q, sound_next, "queue-youarenext");
1750 ast_string_field_set(q, sound_thereare, "queue-thereare");
1751 ast_string_field_set(q, sound_calls, "queue-callswaiting");
1752 ast_string_field_set(q, queue_quantity1, "queue-quantity1");
1753 ast_string_field_set(q, queue_quantity2, "queue-quantity2");
1754 ast_string_field_set(q, sound_holdtime, "queue-holdtime");
1755 ast_string_field_set(q, sound_minutes, "queue-minutes");
1756 ast_string_field_set(q, sound_minute, "queue-minute");
1757 ast_string_field_set(q, sound_seconds, "queue-seconds");
1758 ast_string_field_set(q, sound_thanks, "queue-thankyou");
1759 ast_string_field_set(q, sound_reporthold, "queue-reporthold");
1761 if (!q->sound_periodicannounce[0]) {
1762 q->sound_periodicannounce[0] = ast_str_create(32);
1765 if (q->sound_periodicannounce[0]) {
1766 ast_str_set(&q->sound_periodicannounce[0], 0, "queue-periodic-announce");
1769 for (i = 1; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) {
1770 if (q->sound_periodicannounce[i])
1771 ast_str_set(&q->sound_periodicannounce[i], 0, "%s", "");
1774 while ((pr_iter = AST_LIST_REMOVE_HEAD(&q->rules,list)))
1778 static void clear_queue(struct call_queue *q)
1781 q->callscompleted = 0;
1782 q->callsabandoned = 0;
1783 q->callscompletedinsl = 0;
1788 struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
1789 while ((mem = ao2_iterator_next(&mem_iter))) {
1794 ao2_iterator_destroy(&mem_iter);
1799 * \brief Change queue penalty by adding rule.
1801 * Check rule for errors with time or fomatting, see if rule is relative to rest
1802 * of queue, iterate list of rules to find correct insertion point, insert and return.
1803 * \retval -1 on failure
1804 * \retval 0 on success
1805 * \note Call this with the rule_lists locked
1807 static int insert_penaltychange(const char *list_name, const char *content, const int linenum)
1809 char *timestr, *maxstr, *minstr, *contentdup;
1810 struct penalty_rule *rule = NULL, *rule_iter;
1811 struct rule_list *rl_iter;
1812 int penaltychangetime, inserted = 0;
1814 if (!(rule = ast_calloc(1, sizeof(*rule)))) {
1818 contentdup = ast_strdupa(content);
1820 if (!(maxstr = strchr(contentdup, ','))) {
1821 ast_log(LOG_WARNING, "Improperly formatted penaltychange rule at line %d. Ignoring.\n", linenum);
1827 timestr = contentdup;
1829 if ((penaltychangetime = atoi(timestr)) < 0) {
1830 ast_log(LOG_WARNING, "Improper time parameter specified for penaltychange rule at line %d. Ignoring.\n", linenum);
1835 rule->time = penaltychangetime;
1837 if ((minstr = strchr(maxstr,',')))
1840 /* The last check will evaluate true if either no penalty change is indicated for a given rule
1841 * OR if a min penalty change is indicated but no max penalty change is */
1842 if (*maxstr == '+' || *maxstr == '-' || *maxstr == '\0') {
1843 rule->max_relative = 1;
1846 rule->max_value = atoi(maxstr);
1848 if (!ast_strlen_zero(minstr)) {
1849 if (*minstr == '+' || *minstr == '-')
1850 rule->min_relative = 1;
1851 rule->min_value = atoi(minstr);
1852 } else /*there was no minimum specified, so assume this means no change*/
1853 rule->min_relative = 1;
1855 /*We have the rule made, now we need to insert it where it belongs*/
1856 AST_LIST_TRAVERSE(&rule_lists, rl_iter, list){
1857 if (strcasecmp(rl_iter->name, list_name))
1860 AST_LIST_TRAVERSE_SAFE_BEGIN(&rl_iter->rules, rule_iter, list) {
1861 if (rule->time < rule_iter->time) {
1862 AST_LIST_INSERT_BEFORE_CURRENT(rule, list);
1867 AST_LIST_TRAVERSE_SAFE_END;
1870 AST_LIST_INSERT_TAIL(&rl_iter->rules, rule, list);
1877 static void parse_empty_options(const char *value, enum empty_conditions *empty, int joinempty)
1879 char *value_copy = ast_strdupa(value);
1880 char *option = NULL;
1881 while ((option = strsep(&value_copy, ","))) {
1882 if (!strcasecmp(option, "paused")) {
1883 *empty |= QUEUE_EMPTY_PAUSED;
1884 } else if (!strcasecmp(option, "penalty")) {
1885 *empty |= QUEUE_EMPTY_PENALTY;
1886 } else if (!strcasecmp(option, "inuse")) {
1887 *empty |= QUEUE_EMPTY_INUSE;
1888 } else if (!strcasecmp(option, "ringing")) {
1889 *empty |= QUEUE_EMPTY_RINGING;
1890 } else if (!strcasecmp(option, "invalid")) {
1891 *empty |= QUEUE_EMPTY_INVALID;
1892 } else if (!strcasecmp(option, "wrapup")) {
1893 *empty |= QUEUE_EMPTY_WRAPUP;
1894 } else if (!strcasecmp(option, "unavailable")) {
1895 *empty |= QUEUE_EMPTY_UNAVAILABLE;
1896 } else if (!strcasecmp(option, "unknown")) {
1897 *empty |= QUEUE_EMPTY_UNKNOWN;
1898 } else if (!strcasecmp(option, "loose")) {
1899 *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID);
1900 } else if (!strcasecmp(option, "strict")) {
1901 *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED | QUEUE_EMPTY_UNAVAILABLE);
1902 } else if ((ast_false(option) && joinempty) || (ast_true(option) && !joinempty)) {
1903 *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED);
1904 } else if ((ast_false(option) && !joinempty) || (ast_true(option) && joinempty)) {
1907 ast_log(LOG_WARNING, "Unknown option %s for '%s'\n", option, joinempty ? "joinempty" : "leavewhenempty");
1912 /*! \brief Configure a queue parameter.
1914 * The failunknown flag is set for config files (and static realtime) to show
1915 * errors for unknown parameters. It is cleared for dynamic realtime to allow
1916 * extra fields in the tables.
1917 * \note For error reporting, line number is passed for .conf static configuration,
1918 * for Realtime queues, linenum is -1.
1920 static void queue_set_param(struct call_queue *q, const char *param, const char *val, int linenum, int failunknown)
1922 if (!strcasecmp(param, "musicclass") ||
1923 !strcasecmp(param, "music") || !strcasecmp(param, "musiconhold")) {
1924 ast_string_field_set(q, moh, val);
1925 } else if (!strcasecmp(param, "announce")) {
1926 ast_string_field_set(q, announce, val);
1927 } else if (!strcasecmp(param, "context")) {
1928 ast_string_field_set(q, context, val);
1929 } else if (!strcasecmp(param, "timeout")) {
1930 q->timeout = atoi(val);
1932 q->timeout = DEFAULT_TIMEOUT;
1933 } else if (!strcasecmp(param, "ringinuse")) {
1934 q->ringinuse = ast_true(val);
1935 } else if (!strcasecmp(param, "setinterfacevar")) {
1936 q->setinterfacevar = ast_true(val);
1937 } else if (!strcasecmp(param, "setqueuevar")) {
1938 q->setqueuevar = ast_true(val);
1939 } else if (!strcasecmp(param, "setqueueentryvar")) {
1940 q->setqueueentryvar = ast_true(val);
1941 } else if (!strcasecmp(param, "monitor-format")) {
1942 ast_copy_string(q->monfmt, val, sizeof(q->monfmt));
1943 } else if (!strcasecmp(param, "membermacro")) {
1944 ast_string_field_set(q, membermacro, val);
1945 } else if (!strcasecmp(param, "membergosub")) {
1946 ast_string_field_set(q, membergosub, val);
1947 } else if (!strcasecmp(param, "queue-youarenext")) {
1948 ast_string_field_set(q, sound_next, val);
1949 } else if (!strcasecmp(param, "queue-thereare")) {
1950 ast_string_field_set(q, sound_thereare, val);
1951 } else if (!strcasecmp(param, "queue-callswaiting")) {
1952 ast_string_field_set(q, sound_calls, val);
1953 } else if (!strcasecmp(param, "queue-quantity1")) {
1954 ast_string_field_set(q, queue_quantity1, val);
1955 } else if (!strcasecmp(param, "queue-quantity2")) {
1956 ast_string_field_set(q, queue_quantity2, val);
1957 } else if (!strcasecmp(param, "queue-holdtime")) {
1958 ast_string_field_set(q, sound_holdtime, val);
1959 } else if (!strcasecmp(param, "queue-minutes")) {
1960 ast_string_field_set(q, sound_minutes, val);
1961 } else if (!strcasecmp(param, "queue-minute")) {
1962 ast_string_field_set(q, sound_minute, val);
1963 } else if (!strcasecmp(param, "queue-seconds")) {
1964 ast_string_field_set(q, sound_seconds, val);
1965 } else if (!strcasecmp(param, "queue-thankyou")) {
1966 ast_string_field_set(q, sound_thanks, val);
1967 } else if (!strcasecmp(param, "queue-callerannounce")) {
1968 ast_string_field_set(q, sound_callerannounce, val);
1969 } else if (!strcasecmp(param, "queue-reporthold")) {
1970 ast_string_field_set(q, sound_reporthold, val);
1971 } else if (!strcasecmp(param, "announce-frequency")) {
1972 q->announcefrequency = atoi(val);
1973 } else if (!strcasecmp(param, "min-announce-frequency")) {
1974 q->minannouncefrequency = atoi(val);
1975 ast_debug(1, "%s=%s for queue '%s'\n", param, val, q->name);
1976 } else if (!strcasecmp(param, "announce-round-seconds")) {
1977 q->roundingseconds = atoi(val);
1978 /* Rounding to any other values just doesn't make sense... */
1979 if (!(q->roundingseconds == 0 || q->roundingseconds == 5 || q->roundingseconds == 10
1980 || q->roundingseconds == 15 || q->roundingseconds == 20 || q->roundingseconds == 30)) {
1982 ast_log(LOG_WARNING, "'%s' isn't a valid value for %s "
1983 "using 0 instead for queue '%s' at line %d of queues.conf\n",
1984 val, param, q->name, linenum);
1986 ast_log(LOG_WARNING, "'%s' isn't a valid value for %s "
1987 "using 0 instead for queue '%s'\n", val, param, q->name);
1989 q->roundingseconds=0;
1991 } else if (!strcasecmp(param, "announce-holdtime")) {
1992 if (!strcasecmp(val, "once"))
1993 q->announceholdtime = ANNOUNCEHOLDTIME_ONCE;
1994 else if (ast_true(val))
1995 q->announceholdtime = ANNOUNCEHOLDTIME_ALWAYS;
1997 q->announceholdtime = 0;
1998 } else if (!strcasecmp(param, "announce-position")) {
1999 if (!strcasecmp(val, "limit"))
2000 q->announceposition = ANNOUNCEPOSITION_LIMIT;
2001 else if (!strcasecmp(val, "more"))
2002 q->announceposition = ANNOUNCEPOSITION_MORE_THAN;
2003 else if (ast_true(val))
2004 q->announceposition = ANNOUNCEPOSITION_YES;
2006 q->announceposition = ANNOUNCEPOSITION_NO;
2007 } else if (!strcasecmp(param, "announce-position-limit")) {
2008 q->announcepositionlimit = atoi(val);
2009 } else if (!strcasecmp(param, "periodic-announce")) {
2010 if (strchr(val, ',')) {
2011 char *s, *buf = ast_strdupa(val);
2014 while ((s = strsep(&buf, ",|"))) {
2015 if (!q->sound_periodicannounce[i])
2016 q->sound_periodicannounce[i] = ast_str_create(16);
2017 ast_str_set(&q->sound_periodicannounce[i], 0, "%s", s);
2019 if (i == MAX_PERIODIC_ANNOUNCEMENTS)
2022 q->numperiodicannounce = i;
2024 ast_str_set(&q->sound_periodicannounce[0], 0, "%s", val);
2025 q->numperiodicannounce = 1;
2027 } else if (!strcasecmp(param, "periodic-announce-frequency")) {
2028 q->periodicannouncefrequency = atoi(val);
2029 } else if (!strcasecmp(param, "relative-periodic-announce")) {
2030 q->relativeperiodicannounce = ast_true(val);
2031 } else if (!strcasecmp(param, "random-periodic-announce")) {
2032 q->randomperiodicannounce = ast_true(val);
2033 } else if (!strcasecmp(param, "retry")) {
2034 q->retry = atoi(val);
2036 q->retry = DEFAULT_RETRY;
2037 } else if (!strcasecmp(param, "wrapuptime")) {
2038 q->wrapuptime = atoi(val);
2039 } else if (!strcasecmp(param, "penaltymemberslimit")) {
2040 if ((sscanf(val, "%10d", &q->penaltymemberslimit) != 1)) {
2041 q->penaltymemberslimit = 0;
2043 } else if (!strcasecmp(param, "autofill")) {
2044 q->autofill = ast_true(val);
2045 } else if (!strcasecmp(param, "monitor-type")) {
2046 if (!strcasecmp(val, "mixmonitor"))
2048 } else if (!strcasecmp(param, "autopause")) {
2049 q->autopause = autopause2int(val);
2050 } else if (!strcasecmp(param, "autopausedelay")) {
2051 q->autopausedelay = atoi(val);
2052 } else if (!strcasecmp(param, "autopausebusy")) {
2053 q->autopausebusy = ast_true(val);
2054 } else if (!strcasecmp(param, "autopauseunavail")) {
2055 q->autopauseunavail = ast_true(val);
2056 } else if (!strcasecmp(param, "maxlen")) {
2057 q->maxlen = atoi(val);
2060 } else if (!strcasecmp(param, "servicelevel")) {
2061 q->servicelevel= atoi(val);
2062 } else if (!strcasecmp(param, "strategy")) {
2065 /* We are a static queue and already have set this, no need to do it again */
2069 strategy = strat2int(val);
2071 ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
2073 q->strategy = QUEUE_STRATEGY_RINGALL;
2075 if (strategy == q->strategy) {
2078 if (strategy == QUEUE_STRATEGY_LINEAR) {
2079 ast_log(LOG_WARNING, "Changing to the linear strategy currently requires asterisk to be restarted.\n");
2082 q->strategy = strategy;
2083 } else if (!strcasecmp(param, "joinempty")) {
2084 parse_empty_options(val, &q->joinempty, 1);
2085 } else if (!strcasecmp(param, "leavewhenempty")) {
2086 parse_empty_options(val, &q->leavewhenempty, 0);
2087 } else if (!strcasecmp(param, "eventmemberstatus")) {
2088 q->maskmemberstatus = !ast_true(val);
2089 } else if (!strcasecmp(param, "eventwhencalled")) {
2090 if (!strcasecmp(val, "vars")) {
2091 q->eventwhencalled = QUEUE_EVENT_VARIABLES;
2093 q->eventwhencalled = ast_true(val) ? 1 : 0;
2095 } else if (!strcasecmp(param, "reportholdtime")) {
2096 q->reportholdtime = ast_true(val);
2097 } else if (!strcasecmp(param, "memberdelay")) {
2098 q->memberdelay = atoi(val);
2099 } else if (!strcasecmp(param, "weight")) {
2100 q->weight = atoi(val);
2101 } else if (!strcasecmp(param, "timeoutrestart")) {
2102 q->timeoutrestart = ast_true(val);
2103 } else if (!strcasecmp(param, "defaultrule")) {
2104 ast_string_field_set(q, defaultrule, val);
2105 } else if (!strcasecmp(param, "timeoutpriority")) {
2106 if (!strcasecmp(val, "conf")) {
2107 q->timeoutpriority = TIMEOUT_PRIORITY_CONF;
2109 q->timeoutpriority = TIMEOUT_PRIORITY_APP;
2111 } else if (failunknown) {
2113 ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s at line %d of queues.conf\n",
2114 q->name, param, linenum);
2116 ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s\n", q->name, param);
2122 * \brief Find rt member record to update otherwise create one.
2124 * Search for member in queue, if found update penalty/paused state,
2125 * if no member exists create one flag it as a RT member and add to queue member list.
2127 static void rt_handle_member_record(struct call_queue *q, char *interface, struct ast_config *member_config)
2130 struct ao2_iterator mem_iter;
2136 const char *config_val;
2137 const char *rt_uniqueid = ast_variable_retrieve(member_config, interface, "uniqueid");
2138 const char *membername = S_OR(ast_variable_retrieve(member_config, interface, "membername"), interface);
2139 const char *state_interface = S_OR(ast_variable_retrieve(member_config, interface, "state_interface"), interface);
2140 const char *penalty_str = ast_variable_retrieve(member_config, interface, "penalty");
2141 const char *paused_str = ast_variable_retrieve(member_config, interface, "paused");
2143 if (ast_strlen_zero(rt_uniqueid)) {
2144 ast_log(LOG_WARNING, "Realtime field uniqueid is empty for member %s\n", S_OR(membername, "NULL"));
2149 penalty = atoi(penalty_str);
2150 if ((penalty < 0) && negative_penalty_invalid) {
2152 } else if (penalty < 0) {
2158 paused = atoi(paused_str);
2164 if ((config_val = ast_variable_retrieve(member_config, interface, "ignorebusy"))) {
2165 ignorebusy = ast_true(config_val);
2170 /* Find member by realtime uniqueid and update */
2171 mem_iter = ao2_iterator_init(q->members, 0);
2172 while ((m = ao2_iterator_next(&mem_iter))) {
2173 if (!strcasecmp(m->rt_uniqueid, rt_uniqueid)) {
2174 m->dead = 0; /* Do not delete this one. */
2175 ast_copy_string(m->rt_uniqueid, rt_uniqueid, sizeof(m->rt_uniqueid));
2179 if (strcasecmp(state_interface, m->state_interface)) {
2180 ast_copy_string(m->state_interface, state_interface, sizeof(m->state_interface));
2182 m->penalty = penalty;
2183 m->ignorebusy = ignorebusy;
2190 ao2_iterator_destroy(&mem_iter);
2192 /* Create a new member */
2194 if ((m = create_queue_member(interface, membername, penalty, paused, state_interface))) {
2197 m->ignorebusy = ignorebusy;
2198 ast_copy_string(m->rt_uniqueid, rt_uniqueid, sizeof(m->rt_uniqueid));
2199 if (!log_membername_as_agent) {
2200 ast_queue_log(q->name, "REALTIME", m->interface, "ADDMEMBER", "%s", "");
2202 ast_queue_log(q->name, "REALTIME", m->membername, "ADDMEMBER", "%s", "");
2204 ao2_link(q->members, m);
2211 /*! \brief Iterate through queue's member list and delete them */
2212 static void free_members(struct call_queue *q, int all)
2214 /* Free non-dynamic members */
2216 struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
2218 while ((cur = ao2_iterator_next(&mem_iter))) {
2219 if (all || !cur->dynamic) {
2220 ao2_unlink(q->members, cur);
2224 ao2_iterator_destroy(&mem_iter);
2227 /*! \brief Free queue's member list then its string fields */
2228 static void destroy_queue(void *obj)
2230 struct call_queue *q = obj;
2234 ast_string_field_free_memory(q);
2235 for (i = 0; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) {
2236 if (q->sound_periodicannounce[i])
2237 free(q->sound_periodicannounce[i]);
2239 ao2_ref(q->members, -1);
2242 static struct call_queue *alloc_queue(const char *queuename)
2244 struct call_queue *q;
2246 if ((q = ao2_t_alloc(sizeof(*q), destroy_queue, "Allocate queue"))) {
2247 if (ast_string_field_init(q, 64)) {
2248 queue_t_unref(q, "String field allocation failed");
2251 ast_string_field_set(q, name, queuename);
2257 * \brief Reload a single queue via realtime.
2259 * Check for statically defined queue first, check if deleted RT queue,
2260 * check for new RT queue, if queue vars are not defined init them with defaults.
2261 * reload RT queue vars, set RT queue members dead and reload them, return finished queue.
2262 * \retval the queue,
2263 * \retval NULL if it doesn't exist.
2264 * \note Should be called with the "queues" container locked.
2266 static struct call_queue *find_queue_by_name_rt(const char *queuename, struct ast_variable *queue_vars, struct ast_config *member_config)
2268 struct ast_variable *v;
2269 struct call_queue *q, tmpq = {
2273 struct ao2_iterator mem_iter;
2274 char *interface = NULL;
2275 const char *tmp_name;
2277 char tmpbuf[64]; /* Must be longer than the longest queue param name. */
2279 /* Static queues override realtime. */
2280 if ((q = ao2_t_find(queues, &tmpq, OBJ_POINTER, "Check if static queue exists"))) {
2285 queue_t_unref(q, "Queue is dead; can't return it");
2288 ast_log(LOG_WARNING, "Static queue '%s' already exists. Not loading from realtime\n", q->name);
2293 } else if (!member_config) {
2294 /* Not found in the list, and it's not realtime ... */
2297 /* Check if queue is defined in realtime. */
2299 /* Delete queue from in-core list if it has been deleted in realtime. */
2301 /*! \note Hmm, can't seem to distinguish a DB failure from a not
2302 found condition... So we might delete an in-core queue
2303 in case of DB failure. */
2304 ast_debug(1, "Queue %s not found in realtime.\n", queuename);
2307 /* Delete if unused (else will be deleted when last caller leaves). */
2308 queues_t_unlink(queues, q, "Unused; removing from container");
2310 queue_t_unref(q, "Queue is dead; can't return it");
2315 /* Create a new queue if an in-core entry does not exist yet. */
2317 struct ast_variable *tmpvar = NULL;
2318 if (!(q = alloc_queue(queuename))) {
2324 /*Before we initialize the queue, we need to set the strategy, so that linear strategy
2325 * will allocate the members properly
2327 for (tmpvar = queue_vars; tmpvar; tmpvar = tmpvar->next) {
2328 if (!strcasecmp(tmpvar->name, "strategy")) {
2329 q->strategy = strat2int(tmpvar->value);
2330 if (q->strategy < 0) {
2331 ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
2332 tmpvar->value, q->name);
2333 q->strategy = QUEUE_STRATEGY_RINGALL;
2338 /* We traversed all variables and didn't find a strategy */
2340 q->strategy = QUEUE_STRATEGY_RINGALL;
2342 queues_t_link(queues, q, "Add queue to container");
2344 init_queue(q); /* Ensure defaults for all parameters not set explicitly. */
2346 memset(tmpbuf, 0, sizeof(tmpbuf));
2347 for (v = queue_vars; v; v = v->next) {
2348 /* Convert to dashes `-' from underscores `_' as the latter are more SQL friendly. */
2349 if ((tmp = strchr(v->name, '_'))) {
2350 ast_copy_string(tmpbuf, v->name, sizeof(tmpbuf));
2353 while ((tmp = strchr(tmp, '_')))
2358 /* NULL values don't get returned from realtime; blank values should
2359 * still get set. If someone doesn't want a value to be set, they
2360 * should set the realtime column to NULL, not blank. */
2361 queue_set_param(q, tmp_name, v->value, -1, 0);
2364 /* Temporarily set realtime members dead so we can detect deleted ones. */
2365 mem_iter = ao2_iterator_init(q->members, 0);
2366 while ((m = ao2_iterator_next(&mem_iter))) {
2372 ao2_iterator_destroy(&mem_iter);
2374 while ((interface = ast_category_browse(member_config, interface))) {
2375 rt_handle_member_record(q, interface, member_config);
2378 /* Delete all realtime members that have been deleted in DB. */
2379 mem_iter = ao2_iterator_init(q->members, 0);
2380 while ((m = ao2_iterator_next(&mem_iter))) {
2382 if (ast_strlen_zero(m->membername) || !log_membername_as_agent) {
2383 ast_queue_log(q->name, "REALTIME", m->interface, "REMOVEMEMBER", "%s", "");
2385 ast_queue_log(q->name, "REALTIME", m->membername, "REMOVEMEMBER", "%s", "");
2387 ao2_unlink(q->members, m);
2391 ao2_iterator_destroy(&mem_iter);
2398 /*! \note Returns a reference to the loaded realtime queue. */
2399 static struct call_queue *load_realtime_queue(const char *queuename)
2401 struct ast_variable *queue_vars;
2402 struct ast_config *member_config = NULL;
2403 struct call_queue *q = NULL, tmpq = {
2406 int prev_weight = 0;
2408 /* Find the queue in the in-core list first. */
2409 q = ao2_t_find(queues, &tmpq, OBJ_POINTER, "Look for queue in memory first");
2411 if (!q || q->realtime) {
2412 /*! \note Load from realtime before taking the "queues" container lock, to avoid blocking all
2413 queue operations while waiting for the DB.
2415 This will be two separate database transactions, so we might
2416 see queue parameters as they were before another process
2417 changed the queue and member list as it was after the change.
2418 Thus we might see an empty member list when a queue is
2419 deleted. In practise, this is unlikely to cause a problem. */
2421 queue_vars = ast_load_realtime("queues", "name", queuename, SENTINEL);
2423 member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", queuename, SENTINEL);
2424 if (!member_config) {
2425 ast_log(LOG_ERROR, "no queue_members defined in your config (extconfig.conf).\n");
2426 ast_variables_destroy(queue_vars);
2431 prev_weight = q->weight ? 1 : 0;
2432 queue_t_unref(q, "Need to find realtime queue");
2435 q = find_queue_by_name_rt(queuename, queue_vars, member_config);
2436 ast_config_destroy(member_config);
2437 ast_variables_destroy(queue_vars);
2439 /* update the use_weight value if the queue's has gained or lost a weight */
2441 if (!q->weight && prev_weight) {
2442 ast_atomic_fetchadd_int(&use_weight, -1);
2444 if (q->weight && !prev_weight) {
2445 ast_atomic_fetchadd_int(&use_weight, +1);
2448 /* Other cases will end up with the proper value for use_weight */
2450 update_realtime_members(q);
2455 static int update_realtime_member_field(struct member *mem, const char *queue_name, const char *field, const char *value)
2459 if (ast_strlen_zero(mem->rt_uniqueid))
2462 if ((ast_update_realtime("queue_members", "uniqueid", mem->rt_uniqueid, field, value, SENTINEL)) > 0)
2469 static void update_realtime_members(struct call_queue *q)
2471 struct ast_config *member_config = NULL;
2473 char *interface = NULL;
2474 struct ao2_iterator mem_iter;
2476 if (!(member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", q->name , SENTINEL))) {
2477 /*This queue doesn't have realtime members*/
2478 ast_debug(3, "Queue %s has no realtime members defined. No need for update\n", q->name);
2484 /* Temporarily set realtime members dead so we can detect deleted ones.*/
2485 mem_iter = ao2_iterator_init(q->members, 0);
2486 while ((m = ao2_iterator_next(&mem_iter))) {
2491 ao2_iterator_destroy(&mem_iter);
2493 while ((interface = ast_category_browse(member_config, interface))) {
2494 rt_handle_member_record(q, interface, member_config);
2497 /* Delete all realtime members that have been deleted in DB. */
2498 mem_iter = ao2_iterator_init(q->members, 0);
2499 while ((m = ao2_iterator_next(&mem_iter))) {
2501 if (ast_strlen_zero(m->membername) || !log_membername_as_agent) {
2502 ast_queue_log(q->name, "REALTIME", m->interface, "REMOVEMEMBER", "%s", "");
2504 ast_queue_log(q->name, "REALTIME", m->membername, "REMOVEMEMBER", "%s", "");
2506 ao2_unlink(q->members, m);
2510 ao2_iterator_destroy(&mem_iter);
2512 ast_config_destroy(member_config);
2515 static int join_queue(char *queuename, struct queue_ent *qe, enum queue_result *reason, int position)
2517 struct call_queue *q;
2518 struct queue_ent *cur, *prev = NULL;
2523 if (!(q = load_realtime_queue(queuename))) {
2528 /* This is our one */
2531 if ((status = get_member_status(q, qe->max_penalty, qe->min_penalty, q->joinempty))) {
2532 *reason = QUEUE_JOINEMPTY;
2534 queue_t_unref(q, "Done with realtime queue");
2538 if (*reason == QUEUE_UNKNOWN && q->maxlen && (q->count >= q->maxlen))
2539 *reason = QUEUE_FULL;
2540 else if (*reason == QUEUE_UNKNOWN) {
2541 /* There's space for us, put us at the right position inside
2543 * Take into account the priority of the calling user */
2548 /* We have higher priority than the current user, enter
2549 * before him, after all the other users with priority
2550 * higher or equal to our priority. */
2551 if ((!inserted) && (qe->prio > cur->prio)) {
2552 insert_entry(q, prev, qe, &pos);
2555 /* <= is necessary for the position comparison because it may not be possible to enter
2556 * at our desired position since higher-priority callers may have taken the position we want
2558 if (!inserted && (qe->prio >= cur->prio) && position && (position <= pos + 1)) {
2559 insert_entry(q, prev, qe, &pos);
2560 /*pos is incremented inside insert_entry, so don't need to add 1 here*/
2561 if (position < pos) {
2562 ast_log(LOG_NOTICE, "Asked to be inserted at position %d but forced into position %d due to higher priority callers\n", position, pos);
2570 /* No luck, join at the end of the queue */
2572 insert_entry(q, prev, qe, &pos);
2573 ast_copy_string(qe->moh, q->moh, sizeof(qe->moh));
2574 ast_copy_string(qe->announce, q->announce, sizeof(qe->announce));
2575 ast_copy_string(qe->context, q->context, sizeof(qe->context));
2578 ast_manager_event(qe->chan, EVENT_FLAG_CALL, "Join",
2580 "CallerIDNum: %s\r\n"
2581 "CallerIDName: %s\r\n"
2582 "ConnectedLineNum: %s\r\n"
2583 "ConnectedLineName: %s\r\n"
2589 S_COR(qe->chan->caller.id.number.valid, qe->chan->caller.id.number.str, "unknown"),/* XXX somewhere else it is <unknown> */
2590 S_COR(qe->chan->caller.id.name.valid, qe->chan->caller.id.name.str, "unknown"),
2591 S_COR(qe->chan->connected.id.number.valid, qe->chan->connected.id.number.str, "unknown"),/* XXX somewhere else it is <unknown> */
2592 S_COR(qe->chan->connected.id.name.valid, qe->chan->connected.id.name.str, "unknown"),
2593 q->name, qe->pos, q->count, qe->chan->uniqueid );
2594 ast_debug(1, "Queue '%s' Join, Channel '%s', Position '%d'\n", q->name, qe->chan->name, qe->pos );
2597 queue_t_unref(q, "Done with realtime queue");
2602 static int play_file(struct ast_channel *chan, const char *filename)
2606 if (ast_strlen_zero(filename)) {
2610 if (!ast_fileexists(filename, NULL, chan->language)) {
2614 ast_stopstream(chan);
2616 res = ast_streamfile(chan, filename, chan->language);
2618 res = ast_waitstream(chan, AST_DIGIT_ANY);
2620 ast_stopstream(chan);
2626 * \brief Check for valid exit from queue via goto
2627 * \retval 0 if failure
2628 * \retval 1 if successful
2630 static int valid_exit(struct queue_ent *qe, char digit)
2632 int digitlen = strlen(qe->digits);
2634 /* Prevent possible buffer overflow */
2635 if (digitlen < sizeof(qe->digits) - 2) {
2636 qe->digits[digitlen] = digit;
2637 qe->digits[digitlen + 1] = '\0';
2639 qe->digits[0] = '\0';
2643 /* If there's no context to goto, short-circuit */
2644 if (ast_strlen_zero(qe->context))
2647 /* If the extension is bad, then reset the digits to blank */
2648 if (!ast_canmatch_extension(qe->chan, qe->context, qe->digits, 1,
2649 S_COR(qe->chan->caller.id.number.valid, qe->chan->caller.id.number.str, NULL))) {
2650 qe->digits[0] = '\0';
2654 /* We have an exact match */
2655 if (!ast_goto_if_exists(qe->chan, qe->context, qe->digits, 1)) {
2656 qe->valid_digits = 1;
2657 /* Return 1 on a successful goto */
2664 static int say_position(struct queue_ent *qe, int ringing)
2666 int res = 0, avgholdmins, avgholdsecs, announceposition = 0;
2670 /* Let minannouncefrequency seconds pass between the start of each position announcement */
2672 if ((now - qe->last_pos) < qe->parent->minannouncefrequency)
2675 /* If either our position has changed, or we are over the freq timer, say position */
2676 if ((qe->last_pos_said == qe->pos) && ((now - qe->last_pos) < qe->parent->announcefrequency))
2680 ast_indicate(qe->chan,-1);
2682 ast_moh_stop(qe->chan);
2685 if (qe->parent->announceposition == ANNOUNCEPOSITION_YES ||
2686 qe->parent->announceposition == ANNOUNCEPOSITION_MORE_THAN ||
2687 (qe->parent->announceposition == ANNOUNCEPOSITION_LIMIT &&
2688 qe->pos <= qe->parent->announcepositionlimit))
2689 announceposition = 1;
2692 if (announceposition == 1) {
2693 /* Say we're next, if we are */
2695 res = play_file(qe->chan, qe->parent->sound_next);
2701 if (qe->parent->announceposition == ANNOUNCEPOSITION_MORE_THAN && qe->pos > qe->parent->announcepositionlimit){
2703 res = play_file(qe->chan, qe->parent->queue_quantity1);
2706 res = ast_say_number(qe->chan, qe->parent->announcepositionlimit, AST_DIGIT_ANY, qe->chan->language, NULL); /* Needs gender */
2711 res = play_file(qe->chan, qe->parent->sound_thereare);
2714 res = ast_say_number(qe->chan, qe->pos, AST_DIGIT_ANY, qe->chan->language, NULL); /* Needs gender */
2718 if (qe->parent->announceposition == ANNOUNCEPOSITION_MORE_THAN && qe->pos > qe->parent->announcepositionlimit){
2720 res = play_file(qe->chan, qe->parent->queue_quantity2);
2724 res = play_file(qe->chan, qe->parent->sound_calls);
2730 /* Round hold time to nearest minute */
2731 avgholdmins = abs(((qe->parent->holdtime + 30) - (now - qe->start)) / 60);
2733 /* If they have specified a rounding then round the seconds as well */
2734 if (qe->parent->roundingseconds) {
2735 avgholdsecs = (abs(((qe->parent->holdtime + 30) - (now - qe->start))) - 60 * avgholdmins) / qe->parent->roundingseconds;
2736 avgholdsecs *= qe->parent->roundingseconds;
2741 ast_verb(3, "Hold time for %s is %d minute(s) %d seconds\n", qe->parent->name, avgholdmins, avgholdsecs);
2743 /* If the hold time is >1 min, if it's enabled, and if it's not
2744 supposed to be only once and we have already said it, say it */
2745 if ((avgholdmins+avgholdsecs) > 0 && qe->parent->announceholdtime &&
2746 ((qe->parent->announceholdtime == ANNOUNCEHOLDTIME_ONCE && !qe->last_pos) ||
2747 !(qe->parent->announceholdtime == ANNOUNCEHOLDTIME_ONCE))) {
2748 res = play_file(qe->chan, qe->parent->sound_holdtime);
2752 if (avgholdmins >= 1) {
2753 res = ast_say_number(qe->chan, avgholdmins, AST_DIGIT_ANY, qe->chan->language, NULL);
2757 if (avgholdmins == 1) {
2758 res = play_file(qe->chan, qe->parent->sound_minute);
2762 res = play_file(qe->chan, qe->parent->sound_minutes);
2767 if (avgholdsecs >= 1) {
2768 res = ast_say_number(qe->chan, avgholdsecs, AST_DIGIT_ANY, qe->chan->language, NULL);
2772 res = play_file(qe->chan, qe->parent->sound_seconds);
2776 } else if (qe->parent->announceholdtime && !qe->parent->announceposition) {
2781 if (qe->parent->announceposition) {
2782 ast_verb(3, "Told %s in %s their queue position (which was %d)\n",
2783 qe->chan->name, qe->parent->name, qe->pos);
2786 res = play_file(qe->chan, qe->parent->sound_thanks);
2790 if ((res > 0 && !valid_exit(qe, res)))
2793 /* Set our last_pos indicators */
2795 qe->last_pos_said = qe->pos;
2797 /* Don't restart music on hold if we're about to exit the caller from the queue */
2800 ast_indicate(qe->chan, AST_CONTROL_RINGING);
2802 ast_moh_start(qe->chan, qe->moh, NULL);
2808 static void recalc_holdtime(struct queue_ent *qe, int newholdtime)
2812 /* Calculate holdtime using an exponential average */
2813 /* Thanks to SRT for this contribution */
2814 /* 2^2 (4) is the filter coefficient; a higher exponent would give old entries more weight */
2816 ao2_lock(qe->parent);
2817 oldvalue = qe->parent->holdtime;
2818 qe->parent->holdtime = (((oldvalue << 2) - oldvalue) + newholdtime) >> 2;
2819 ao2_unlock(qe->parent);
2822 /*! \brief Caller leaving queue.
2824 * Search the queue to find the leaving client, if found remove from queue
2825 * create manager event, move others up the queue.
2827 static void leave_queue(struct queue_ent *qe)
2829 struct call_queue *q;
2830 struct queue_ent *current, *prev = NULL;
2831 struct penalty_rule *pr_iter;
2834 if (!(q = qe->parent)) {
2837 queue_t_ref(q, "Copy queue pointer from queue entry");
2841 for (current = q->head; current; current = current->next) {
2842 if (current == qe) {
2846 /* Take us out of the queue */
2847 ast_manager_event(qe->chan, EVENT_FLAG_CALL, "Leave",
2848 "Channel: %s\r\nQueue: %s\r\nCount: %d\r\nPosition: %d\r\nUniqueid: %s\r\n",
2849 qe->chan->name, q->name, q->count, qe->pos, qe->chan->uniqueid);
2850 ast_debug(1, "Queue '%s' Leave, Channel '%s'\n", q->name, qe->chan->name );
2851 /* Take us out of the queue */
2853 prev->next = current->next;
2855 q->head = current->next;
2856 /* Free penalty rules */
2857 while ((pr_iter = AST_LIST_REMOVE_HEAD(&qe->qe_rules, list)))
2859 snprintf(posstr, sizeof(posstr), "%d", qe->pos);
2860 pbx_builtin_setvar_helper(qe->chan, "QUEUEPOSITION", posstr);
2862 /* Renumber the people after us in the queue based on a new count */
2863 current->pos = ++pos;
2869 /*If the queue is a realtime queue, check to see if it's still defined in real time*/
2871 struct ast_variable *var;
2872 if (!(var = ast_load_realtime("queues", "name", q->name, SENTINEL))) {
2875 ast_variables_destroy(var);
2880 /* It's dead and nobody is in it, so kill it */
2881 queues_t_unlink(queues, q, "Queue is now dead; remove it from the container");
2883 /* unref the explicit ref earlier in the function */
2884 queue_t_unref(q, "Expire copied reference");
2889 * \brief Destroy the given callattempt structure and free it.
2892 * \param doomed callattempt structure to destroy.
2896 static void callattempt_free(struct callattempt *doomed)
2898 if (doomed->member) {
2899 ao2_ref(doomed->member, -1);
2901 ast_party_connected_line_free(&doomed->connected);
2905 /*! \brief Hang up a list of outgoing calls */
2906 static void hangupcalls(struct callattempt *outgoing, struct ast_channel *exception, int cancel_answered_elsewhere)
2908 struct callattempt *oo;
projects / asterisk/asterisk.git / blob