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 * \par Development notes
26 * \note 2004-11-25: Persistent Dynamic Members added by:
27 * NetNation Communications (www.netnation.com)
28 * Kevin Lindsay <kevinl@netnation.com>
30 * Each dynamic agent in each queue is now stored in the astdb.
31 * When asterisk is restarted, each agent will be automatically
32 * readded into their recorded queues. This feature can be
33 * configured with the 'persistent_members=<1|0>' setting in the
34 * '[general]' category in queues.conf. The default is on.
36 * \note 2004-06-04: Priorities in queues added by inAccess Networks (work funded by Hellas On Line (HOL) www.hol.gr).
38 * \note These features added by David C. Troy <dave@toad.net>:
39 * - Per-queue holdtime calculation
40 * - Estimated holdtime announcement
41 * - Position announcement
42 * - Abandoned/completed call counters
43 * - Failout timer passed as optional app parameter
44 * - Optional monitoring of calls, started when call is answered
46 * Patch Version 1.07 2003-12-24 01
48 * Added servicelevel statistic by Michiel Betel <michiel@betel.nl>
49 * Added Priority jumping code for adding and removing queue members by Jonathan Stanton <asterisk@doilooklikeicare.com>
51 * Fixed to work with CVS as of 2004-02-25 and released as 1.07a
52 * by Matthew Enger <m.enger@xi.com.au>
54 * \ingroup applications
57 /*! \li \ref app_queues.c uses configuration file \ref queues.conf
58 * \addtogroup configuration_file
61 /*! \page queues.conf queues.conf
62 * \verbinclude queues.conf.sample
66 <use type="module">res_monitor</use>
67 <support_level>core</support_level>
72 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
75 #include <sys/signal.h>
76 #include <netinet/in.h>
79 #include "asterisk/lock.h"
80 #include "asterisk/file.h"
81 #include "asterisk/channel.h"
82 #include "asterisk/pbx.h"
83 #include "asterisk/app.h"
84 #include "asterisk/linkedlists.h"
85 #include "asterisk/module.h"
86 #include "asterisk/translate.h"
87 #include "asterisk/say.h"
88 #include "asterisk/features.h"
89 #include "asterisk/musiconhold.h"
90 #include "asterisk/cli.h"
91 #include "asterisk/manager.h"
92 #include "asterisk/config.h"
93 #include "asterisk/monitor.h"
94 #include "asterisk/utils.h"
95 #include "asterisk/causes.h"
96 #include "asterisk/astdb.h"
97 #include "asterisk/devicestate.h"
98 #include "asterisk/stringfields.h"
99 #include "asterisk/astobj2.h"
100 #include "asterisk/strings.h"
101 #include "asterisk/global_datastores.h"
102 #include "asterisk/taskprocessor.h"
103 #include "asterisk/aoc.h"
104 #include "asterisk/callerid.h"
105 #include "asterisk/data.h"
106 #include "asterisk/term.h"
107 #include "asterisk/dial.h"
108 #include "asterisk/stasis_channels.h"
109 #include "asterisk/stasis_message_router.h"
110 #include "asterisk/bridge_after.h"
111 #include "asterisk/stasis_bridges.h"
112 #include "asterisk/core_local.h"
113 #include "asterisk/mixmonitor.h"
114 #include "asterisk/core_unreal.h"
115 #include "asterisk/bridge_basic.h"
117 /* Define, to debug reference counts on queues, without debugging reference counts on queue members */
118 /* #define REF_DEBUG_ONLY_QUEUES */
121 * \par Please read before modifying this file.
122 * There are three locks which are regularly used
123 * throughout this file, the queue list lock, the lock
124 * for each individual queue, and the interface list lock.
125 * Please be extra careful to always lock in the following order
127 * 2) individual queue lock
128 * 3) interface list lock
129 * This order has sort of "evolved" over the lifetime of this
130 * application, but it is now in place this way, so please adhere
135 <application name="Queue" language="en_US">
137 Queue a call for a call queue.
140 <parameter name="queuename" required="true" />
141 <parameter name="options">
144 <para>Mark all calls as "answered elsewhere" when cancelled.</para>
147 <para>Continue in the dialplan if the callee hangs up.</para>
150 <para>data-quality (modem) call (minimum delay).</para>
152 <option name="F" argsep="^">
153 <argument name="context" required="false" />
154 <argument name="exten" required="false" />
155 <argument name="priority" required="true" />
156 <para>When the caller hangs up, transfer the <emphasis>called member</emphasis>
157 to the specified destination and <emphasis>start</emphasis> execution at that location.</para>
159 <para>Any channel variables you want the called channel to inherit from the caller channel must be
160 prefixed with one or two underbars ('_').</para>
164 <para>When the caller hangs up, transfer the <emphasis>called member</emphasis> to the next priority of
165 the current extension and <emphasis>start</emphasis> execution at that location.</para>
167 <para>Any channel variables you want the called channel to inherit from the caller channel must be
168 prefixed with one or two underbars ('_').</para>
171 <para>Using this option from a Macro() or GoSub() might not make sense as there would be no return points.</para>
175 <para>Allow <emphasis>callee</emphasis> to hang up by pressing <literal>*</literal>.</para>
178 <para>Allow <emphasis>caller</emphasis> to hang up by pressing <literal>*</literal>.</para>
181 <para>No retries on the timeout; will exit this application and
182 go to the next step.</para>
185 <para>Ignore call forward requests from queue members and do nothing
186 when they are requested.</para>
189 <para>Asterisk will ignore any connected line update requests or any redirecting party
190 update requests it may receive on this dial attempt.</para>
193 <para>Ring instead of playing MOH. Periodic Announcements are still made, if applicable.</para>
196 <para>Ring instead of playing MOH when a member channel is actually ringing.</para>
199 <para>Allow the <emphasis>called</emphasis> user to transfer the calling user.</para>
202 <para>Allow the <emphasis>calling</emphasis> user to transfer the call.</para>
205 <para>Allow the <emphasis>called</emphasis> user to write the conversation to
206 disk via Monitor.</para>
209 <para>Allow the <emphasis>calling</emphasis> user to write the conversation to
210 disk via Monitor.</para>
213 <para>Allow the <emphasis>called</emphasis> party to enable parking of the call by sending
214 the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
217 <para>Allow the <emphasis>calling</emphasis> party to enable parking of the call by sending
218 the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
221 <para>Allow the <emphasis>called</emphasis> user to write the conversation
222 to disk via MixMonitor.</para>
225 <para>Allow the <emphasis>calling</emphasis> user to write the conversation to
226 disk via MixMonitor.</para>
230 <parameter name="URL">
231 <para><replaceable>URL</replaceable> will be sent to the called party if the channel supports it.</para>
233 <parameter name="announceoverride" />
234 <parameter name="timeout">
235 <para>Will cause the queue to fail out after a specified number of
236 seconds, checked between each <filename>queues.conf</filename> <replaceable>timeout</replaceable> and
237 <replaceable>retry</replaceable> cycle.</para>
239 <parameter name="AGI">
240 <para>Will setup an AGI script to be executed on the calling party's channel once they are
241 connected to a queue member.</para>
243 <parameter name="macro">
244 <para>Will run a macro on the calling party's channel once they are connected to a queue member.</para>
246 <parameter name="gosub">
247 <para>Will run a gosub on the called party's channel (the queue member) once the parties are connected.</para>
249 <parameter name="rule">
250 <para>Will cause the queue's defaultrule to be overridden by the rule specified.</para>
252 <parameter name="position">
253 <para>Attempt to enter the caller into the queue at the numerical position specified. <literal>1</literal>
254 would attempt to enter the caller at the head of the queue, and <literal>3</literal> would attempt to place
255 the caller third in the queue.</para>
259 <para>In addition to transferring the call, a call may be parked and then picked
260 up by another user.</para>
261 <para>This application will return to the dialplan if the queue does not exist, or
262 any of the join options cause the caller to not enter the queue.</para>
263 <para>This application does not automatically answer and should be preceeded
264 by an application such as Answer(), Progress(), or Ringing().</para>
265 <para>This application sets the following channel variable upon completion:</para>
267 <variable name="QUEUESTATUS">
268 <para>The status of the call as a text string.</para>
269 <value name="TIMEOUT" />
270 <value name="FULL" />
271 <value name="JOINEMPTY" />
272 <value name="LEAVEEMPTY" />
273 <value name="JOINUNAVAIL" />
274 <value name="LEAVEUNAVAIL" />
275 <value name="CONTINUE" />
280 <ref type="application">Queue</ref>
281 <ref type="application">QueueLog</ref>
282 <ref type="application">AddQueueMember</ref>
283 <ref type="application">RemoveQueueMember</ref>
284 <ref type="application">PauseQueueMember</ref>
285 <ref type="application">UnpauseQueueMember</ref>
286 <ref type="function">QUEUE_VARIABLES</ref>
287 <ref type="function">QUEUE_MEMBER</ref>
288 <ref type="function">QUEUE_MEMBER_COUNT</ref>
289 <ref type="function">QUEUE_EXISTS</ref>
290 <ref type="function">QUEUE_WAITING_COUNT</ref>
291 <ref type="function">QUEUE_MEMBER_LIST</ref>
292 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
295 <application name="AddQueueMember" language="en_US">
297 Dynamically adds queue members.
300 <parameter name="queuename" required="true" />
301 <parameter name="interface" />
302 <parameter name="penalty" />
303 <parameter name="options" />
304 <parameter name="membername" />
305 <parameter name="stateinterface" />
308 <para>Dynamically adds interface to an existing queue. If the interface is
309 already in the queue it will return an error.</para>
310 <para>This application sets the following channel variable upon completion:</para>
312 <variable name="AQMSTATUS">
313 <para>The status of the attempt to add a queue member as a text string.</para>
314 <value name="ADDED" />
315 <value name="MEMBERALREADY" />
316 <value name="NOSUCHQUEUE" />
321 <ref type="application">Queue</ref>
322 <ref type="application">QueueLog</ref>
323 <ref type="application">AddQueueMember</ref>
324 <ref type="application">RemoveQueueMember</ref>
325 <ref type="application">PauseQueueMember</ref>
326 <ref type="application">UnpauseQueueMember</ref>
327 <ref type="function">QUEUE_VARIABLES</ref>
328 <ref type="function">QUEUE_MEMBER</ref>
329 <ref type="function">QUEUE_MEMBER_COUNT</ref>
330 <ref type="function">QUEUE_EXISTS</ref>
331 <ref type="function">QUEUE_WAITING_COUNT</ref>
332 <ref type="function">QUEUE_MEMBER_LIST</ref>
333 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
336 <application name="RemoveQueueMember" language="en_US">
338 Dynamically removes queue members.
341 <parameter name="queuename" required="true" />
342 <parameter name="interface" />
345 <para>If the interface is <emphasis>NOT</emphasis> in the queue it will return an error.</para>
346 <para>This application sets the following channel variable upon completion:</para>
348 <variable name="RQMSTATUS">
349 <value name="REMOVED" />
350 <value name="NOTINQUEUE" />
351 <value name="NOSUCHQUEUE" />
352 <value name="NOTDYNAMIC" />
355 <para>Example: RemoveQueueMember(techsupport,SIP/3000)</para>
358 <ref type="application">Queue</ref>
359 <ref type="application">QueueLog</ref>
360 <ref type="application">AddQueueMember</ref>
361 <ref type="application">RemoveQueueMember</ref>
362 <ref type="application">PauseQueueMember</ref>
363 <ref type="application">UnpauseQueueMember</ref>
364 <ref type="function">QUEUE_VARIABLES</ref>
365 <ref type="function">QUEUE_MEMBER</ref>
366 <ref type="function">QUEUE_MEMBER_COUNT</ref>
367 <ref type="function">QUEUE_EXISTS</ref>
368 <ref type="function">QUEUE_WAITING_COUNT</ref>
369 <ref type="function">QUEUE_MEMBER_LIST</ref>
370 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
373 <application name="PauseQueueMember" language="en_US">
375 Pauses a queue member.
378 <parameter name="queuename" />
379 <parameter name="interface" required="true" />
380 <parameter name="options" />
381 <parameter name="reason">
382 <para>Is used to add extra information to the appropriate queue_log entries and manager events.</para>
386 <para>Pauses (blocks calls for) a queue member. The given interface will be paused in the given queue.
387 This prevents any calls from being sent from the queue to the interface until it is
388 unpaused with UnpauseQueueMember or the manager interface. If no queuename is given,
389 the interface is paused in every queue it is a member of. The application will fail if the
390 interface is not found.</para>
391 <para>This application sets the following channel variable upon completion:</para>
393 <variable name="PQMSTATUS">
394 <para>The status of the attempt to pause a queue member as a text string.</para>
395 <value name="PAUSED" />
396 <value name="NOTFOUND" />
399 <para>Example: PauseQueueMember(,SIP/3000)</para>
402 <ref type="application">Queue</ref>
403 <ref type="application">QueueLog</ref>
404 <ref type="application">AddQueueMember</ref>
405 <ref type="application">RemoveQueueMember</ref>
406 <ref type="application">PauseQueueMember</ref>
407 <ref type="application">UnpauseQueueMember</ref>
408 <ref type="function">QUEUE_VARIABLES</ref>
409 <ref type="function">QUEUE_MEMBER</ref>
410 <ref type="function">QUEUE_MEMBER_COUNT</ref>
411 <ref type="function">QUEUE_EXISTS</ref>
412 <ref type="function">QUEUE_WAITING_COUNT</ref>
413 <ref type="function">QUEUE_MEMBER_LIST</ref>
414 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
417 <application name="UnpauseQueueMember" language="en_US">
419 Unpauses a queue member.
422 <parameter name="queuename" />
423 <parameter name="interface" required="true" />
424 <parameter name="options" />
425 <parameter name="reason">
426 <para>Is used to add extra information to the appropriate queue_log entries and manager events.</para>
430 <para>Unpauses (resumes calls to) a queue member. This is the counterpart to <literal>PauseQueueMember()</literal>
431 and operates exactly the same way, except it unpauses instead of pausing the given interface.</para>
432 <para>This application sets the following channel variable upon completion:</para>
434 <variable name="UPQMSTATUS">
435 <para>The status of the attempt to unpause a queue member as a text string.</para>
436 <value name="UNPAUSED" />
437 <value name="NOTFOUND" />
440 <para>Example: UnpauseQueueMember(,SIP/3000)</para>
443 <ref type="application">Queue</ref>
444 <ref type="application">QueueLog</ref>
445 <ref type="application">AddQueueMember</ref>
446 <ref type="application">RemoveQueueMember</ref>
447 <ref type="application">PauseQueueMember</ref>
448 <ref type="application">UnpauseQueueMember</ref>
449 <ref type="function">QUEUE_VARIABLES</ref>
450 <ref type="function">QUEUE_MEMBER</ref>
451 <ref type="function">QUEUE_MEMBER_COUNT</ref>
452 <ref type="function">QUEUE_EXISTS</ref>
453 <ref type="function">QUEUE_WAITING_COUNT</ref>
454 <ref type="function">QUEUE_MEMBER_LIST</ref>
455 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
458 <application name="QueueLog" language="en_US">
460 Writes to the queue_log file.
463 <parameter name="queuename" required="true" />
464 <parameter name="uniqueid" required="true" />
465 <parameter name="agent" required="true" />
466 <parameter name="event" required="true" />
467 <parameter name="additionalinfo" />
470 <para>Allows you to write your own events into the queue log.</para>
471 <para>Example: QueueLog(101,${UNIQUEID},${AGENT},WENTONBREAK,600)</para>
474 <ref type="application">Queue</ref>
475 <ref type="application">QueueLog</ref>
476 <ref type="application">AddQueueMember</ref>
477 <ref type="application">RemoveQueueMember</ref>
478 <ref type="application">PauseQueueMember</ref>
479 <ref type="application">UnpauseQueueMember</ref>
480 <ref type="function">QUEUE_VARIABLES</ref>
481 <ref type="function">QUEUE_MEMBER</ref>
482 <ref type="function">QUEUE_MEMBER_COUNT</ref>
483 <ref type="function">QUEUE_EXISTS</ref>
484 <ref type="function">QUEUE_WAITING_COUNT</ref>
485 <ref type="function">QUEUE_MEMBER_LIST</ref>
486 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
489 <function name="QUEUE_VARIABLES" language="en_US">
491 Return Queue information in variables.
494 <parameter name="queuename" required="true">
496 <enum name="QUEUEMAX">
497 <para>Maxmimum number of calls allowed.</para>
499 <enum name="QUEUESTRATEGY">
500 <para>The strategy of the queue.</para>
502 <enum name="QUEUECALLS">
503 <para>Number of calls currently in the queue.</para>
505 <enum name="QUEUEHOLDTIME">
506 <para>Current average hold time.</para>
508 <enum name="QUEUECOMPLETED">
509 <para>Number of completed calls for the queue.</para>
511 <enum name="QUEUEABANDONED">
512 <para>Number of abandoned calls.</para>
514 <enum name="QUEUESRVLEVEL">
515 <para>Queue service level.</para>
517 <enum name="QUEUESRVLEVELPERF">
518 <para>Current service level performance.</para>
524 <para>Makes the following queue variables available.</para>
525 <para>Returns <literal>0</literal> if queue is found and setqueuevar is defined, <literal>-1</literal> otherwise.</para>
528 <ref type="application">Queue</ref>
529 <ref type="application">QueueLog</ref>
530 <ref type="application">AddQueueMember</ref>
531 <ref type="application">RemoveQueueMember</ref>
532 <ref type="application">PauseQueueMember</ref>
533 <ref type="application">UnpauseQueueMember</ref>
534 <ref type="function">QUEUE_VARIABLES</ref>
535 <ref type="function">QUEUE_MEMBER</ref>
536 <ref type="function">QUEUE_MEMBER_COUNT</ref>
537 <ref type="function">QUEUE_EXISTS</ref>
538 <ref type="function">QUEUE_WAITING_COUNT</ref>
539 <ref type="function">QUEUE_MEMBER_LIST</ref>
540 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
543 <function name="QUEUE_MEMBER" language="en_US">
545 Count number of members answering a queue.
548 <parameter name="queuename" required="true" />
549 <parameter name="option" required="true">
552 <para>Returns the number of logged-in members for the specified queue.</para>
555 <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>
558 <para>Returns the number of logged-in members for the specified queue that are immediately available to answer a call.</para>
561 <para>Returns the total number of members for the specified queue.</para>
563 <enum name="penalty">
564 <para>Gets or sets queue member penalty.</para>
567 <para>Gets or sets queue member paused status.</para>
569 <enum name="ringinuse">
570 <para>Gets or sets queue member ringinuse.</para>
574 <parameter name="interface" required="false" />
577 <para>Allows access to queue counts [R] and member information [R/W].</para>
579 <replaceable>queuename</replaceable> is required for all operations
580 <replaceable>interface</replaceable> is required for all member operations.
584 <ref type="application">Queue</ref>
585 <ref type="application">QueueLog</ref>
586 <ref type="application">AddQueueMember</ref>
587 <ref type="application">RemoveQueueMember</ref>
588 <ref type="application">PauseQueueMember</ref>
589 <ref type="application">UnpauseQueueMember</ref>
590 <ref type="function">QUEUE_VARIABLES</ref>
591 <ref type="function">QUEUE_MEMBER</ref>
592 <ref type="function">QUEUE_MEMBER_COUNT</ref>
593 <ref type="function">QUEUE_EXISTS</ref>
594 <ref type="function">QUEUE_WAITING_COUNT</ref>
595 <ref type="function">QUEUE_MEMBER_LIST</ref>
596 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
599 <function name="QUEUE_MEMBER_COUNT" language="en_US">
601 Count number of members answering a queue.
604 <parameter name="queuename" required="true" />
607 <para>Returns the number of members currently associated with the specified <replaceable>queuename</replaceable>.</para>
608 <warning><para>This function has been deprecated in favor of the <literal>QUEUE_MEMBER()</literal> function</para></warning>
611 <ref type="application">Queue</ref>
612 <ref type="application">QueueLog</ref>
613 <ref type="application">AddQueueMember</ref>
614 <ref type="application">RemoveQueueMember</ref>
615 <ref type="application">PauseQueueMember</ref>
616 <ref type="application">UnpauseQueueMember</ref>
617 <ref type="function">QUEUE_VARIABLES</ref>
618 <ref type="function">QUEUE_MEMBER</ref>
619 <ref type="function">QUEUE_MEMBER_COUNT</ref>
620 <ref type="function">QUEUE_EXISTS</ref>
621 <ref type="function">QUEUE_WAITING_COUNT</ref>
622 <ref type="function">QUEUE_MEMBER_LIST</ref>
623 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
626 <function name="QUEUE_EXISTS" language="en_US">
628 Check if a named queue exists on this server
631 <parameter name="queuename" />
634 <para>Returns 1 if the specified queue exists, 0 if it does not</para>
637 <ref type="application">Queue</ref>
638 <ref type="application">QueueLog</ref>
639 <ref type="application">AddQueueMember</ref>
640 <ref type="application">RemoveQueueMember</ref>
641 <ref type="application">PauseQueueMember</ref>
642 <ref type="application">UnpauseQueueMember</ref>
643 <ref type="function">QUEUE_VARIABLES</ref>
644 <ref type="function">QUEUE_MEMBER</ref>
645 <ref type="function">QUEUE_MEMBER_COUNT</ref>
646 <ref type="function">QUEUE_EXISTS</ref>
647 <ref type="function">QUEUE_WAITING_COUNT</ref>
648 <ref type="function">QUEUE_MEMBER_LIST</ref>
649 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
652 <function name="QUEUE_WAITING_COUNT" language="en_US">
654 Count number of calls currently waiting in a queue.
657 <parameter name="queuename" />
660 <para>Returns the number of callers currently waiting in the specified <replaceable>queuename</replaceable>.</para>
663 <ref type="application">Queue</ref>
664 <ref type="application">QueueLog</ref>
665 <ref type="application">AddQueueMember</ref>
666 <ref type="application">RemoveQueueMember</ref>
667 <ref type="application">PauseQueueMember</ref>
668 <ref type="application">UnpauseQueueMember</ref>
669 <ref type="function">QUEUE_VARIABLES</ref>
670 <ref type="function">QUEUE_MEMBER</ref>
671 <ref type="function">QUEUE_MEMBER_COUNT</ref>
672 <ref type="function">QUEUE_EXISTS</ref>
673 <ref type="function">QUEUE_WAITING_COUNT</ref>
674 <ref type="function">QUEUE_MEMBER_LIST</ref>
675 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
678 <function name="QUEUE_MEMBER_LIST" language="en_US">
680 Returns a list of interfaces on a queue.
683 <parameter name="queuename" required="true" />
686 <para>Returns a comma-separated list of members associated with the specified <replaceable>queuename</replaceable>.</para>
689 <ref type="application">Queue</ref>
690 <ref type="application">QueueLog</ref>
691 <ref type="application">AddQueueMember</ref>
692 <ref type="application">RemoveQueueMember</ref>
693 <ref type="application">PauseQueueMember</ref>
694 <ref type="application">UnpauseQueueMember</ref>
695 <ref type="function">QUEUE_VARIABLES</ref>
696 <ref type="function">QUEUE_MEMBER</ref>
697 <ref type="function">QUEUE_MEMBER_COUNT</ref>
698 <ref type="function">QUEUE_EXISTS</ref>
699 <ref type="function">QUEUE_WAITING_COUNT</ref>
700 <ref type="function">QUEUE_MEMBER_LIST</ref>
701 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
704 <function name="QUEUE_MEMBER_PENALTY" language="en_US">
706 Gets or sets queue members penalty.
709 <parameter name="queuename" required="true" />
710 <parameter name="interface" required="true" />
713 <para>Gets or sets queue members penalty.</para>
714 <warning><para>This function has been deprecated in favor of the <literal>QUEUE_MEMBER()</literal> function</para></warning>
717 <ref type="application">Queue</ref>
718 <ref type="application">QueueLog</ref>
719 <ref type="application">AddQueueMember</ref>
720 <ref type="application">RemoveQueueMember</ref>
721 <ref type="application">PauseQueueMember</ref>
722 <ref type="application">UnpauseQueueMember</ref>
723 <ref type="function">QUEUE_VARIABLES</ref>
724 <ref type="function">QUEUE_MEMBER</ref>
725 <ref type="function">QUEUE_MEMBER_COUNT</ref>
726 <ref type="function">QUEUE_EXISTS</ref>
727 <ref type="function">QUEUE_WAITING_COUNT</ref>
728 <ref type="function">QUEUE_MEMBER_LIST</ref>
729 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
732 <manager name="Queues" language="en_US">
741 <manager name="QueueStatus" language="en_US">
746 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
747 <parameter name="Queue" />
748 <parameter name="Member" />
753 <manager name="QueueSummary" language="en_US">
758 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
759 <parameter name="Queue" />
764 <manager name="QueueAdd" language="en_US">
766 Add interface to queue.
769 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
770 <parameter name="Queue" required="true" />
771 <parameter name="Interface" required="true" />
772 <parameter name="Penalty" />
773 <parameter name="Paused" />
774 <parameter name="MemberName" />
775 <parameter name="StateInterface" />
780 <manager name="QueueRemove" language="en_US">
782 Remove interface from queue.
785 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
786 <parameter name="Queue" required="true" />
787 <parameter name="Interface" required="true" />
792 <manager name="QueuePause" language="en_US">
794 Makes a queue member temporarily unavailable.
797 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
798 <parameter name="Interface" required="true" />
799 <parameter name="Paused" required="true" />
800 <parameter name="Queue" />
801 <parameter name="Reason" />
806 <manager name="QueueLog" language="en_US">
808 Adds custom entry in queue_log.
811 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
812 <parameter name="Queue" required="true" />
813 <parameter name="Event" required="true" />
814 <parameter name="Uniqueid" />
815 <parameter name="Interface" />
816 <parameter name="Message" />
821 <manager name="QueuePenalty" language="en_US">
823 Set the penalty for a queue member.
826 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
827 <parameter name="Interface" required="true" />
828 <parameter name="Penalty" required="true" />
829 <parameter name="Queue" />
834 <manager name="QueueMemberRingInUse" language="en_US">
836 Set the ringinuse value for a queue member.
839 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
840 <parameter name="Interface" required="true" />
841 <parameter name="RingInUse" required="true" />
842 <parameter name="Queue" />
847 <manager name="QueueRule" language="en_US">
852 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
853 <parameter name="Rule" />
858 <manager name="QueueReload" language="en_US">
860 Reload a queue, queues, or any sub-section of a queue or queues.
863 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
864 <parameter name="Queue" />
865 <parameter name="Members">
871 <parameter name="Rules">
877 <parameter name="Parameters">
887 <manager name="QueueReset" language="en_US">
889 Reset queue statistics.
892 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
893 <parameter name="Queue" />
899 <managerEvent language="en_US" name="QueueMemberStatus">
900 <managerEventInstance class="EVENT_FLAG_AGENT">
901 <synopsis>Raised when a Queue member's status has changed.</synopsis>
903 <parameter name="Queue">
904 <para>The name of the queue.</para>
906 <parameter name="MemberName">
907 <para>The name of the queue member.</para>
909 <parameter name="Interface">
910 <para>The queue member's channel technology or location.</para>
912 <parameter name="StateInterface">
913 <para>Channel technology or location from which to read device state changes.</para>
915 <parameter name="Membership">
917 <enum name="dynamic"/>
918 <enum name="realtime"/>
919 <enum name="static"/>
922 <parameter name="Penalty">
923 <para>The penalty associated with the queue member.</para>
925 <parameter name="CallsTaken">
926 <para>The number of calls this queue member has serviced.</para>
928 <parameter name="LastCall">
929 <para>The time this member last took a call, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
931 <parameter name="Status">
932 <para>The numeric device state status of the queue member.</para>
934 <enum name="0"><para>AST_DEVICE_UNKNOWN</para></enum>
935 <enum name="1"><para>AST_DEVICE_NOT_INUSE</para></enum>
936 <enum name="2"><para>AST_DEVICE_INUSE</para></enum>
937 <enum name="3"><para>AST_DEVICE_BUSY</para></enum>
938 <enum name="4"><para>AST_DEVICE_INVALID</para></enum>
939 <enum name="5"><para>AST_DEVICE_UNAVAILABLE</para></enum>
940 <enum name="6"><para>AST_DEVICE_RINGING</para></enum>
941 <enum name="7"><para>AST_DEVICE_RINGINUSE</para></enum>
942 <enum name="8"><para>AST_DEVICE_ONHOLD</para></enum>
945 <parameter name="Paused">
951 <parameter name="Ringinuse">
958 </managerEventInstance>
960 <managerEvent language="en_US" name="QueueMemberAdded">
961 <managerEventInstance class="EVENT_FLAG_AGENT">
962 <synopsis>Raised when a member is added to the queue.</synopsis>
964 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
967 <ref type="managerEvent">QueueMemberRemoved</ref>
968 <ref type="application">AddQueueMember</ref>
970 </managerEventInstance>
972 <managerEvent language="en_US" name="QueueMemberRemoved">
973 <managerEventInstance class="EVENT_FLAG_AGENT">
974 <synopsis>Raised when a member is removed from the queue.</synopsis>
976 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
979 <ref type="managerEvent">QueueMemberAdded</ref>
980 <ref type="application">RemoveQueueMember</ref>
982 </managerEventInstance>
984 <managerEvent language="en_US" name="QueueMemberPaused">
985 <managerEventInstance class="EVENT_FLAG_AGENT">
986 <synopsis>Raised when a member is paused/unpaused in the queue.</synopsis>
988 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
989 <parameter name="Reason">
990 <para>The reason a member was paused.</para>
994 <ref type="application">PauseQueueMember</ref>
995 <ref type="application">UnPauseQueueMember</ref>
997 </managerEventInstance>
999 <managerEvent language="en_US" name="QueueMemberPenalty">
1000 <managerEventInstance class="EVENT_FLAG_AGENT">
1001 <synopsis>Raised when a member's penalty is changed.</synopsis>
1003 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
1006 <ref type="function">QUEUE_MEMBER</ref>
1008 </managerEventInstance>
1010 <managerEvent language="en_US" name="QueueMemberRinginuse">
1011 <managerEventInstance class="EVENT_FLAG_AGENT">
1012 <synopsis>Raised when a member's ringinuse setting is changed.</synopsis>
1014 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
1017 <ref type="function">QUEUE_MEMBER</ref>
1019 </managerEventInstance>
1021 <managerEvent language="en_US" name="QueueCallerJoin">
1022 <managerEventInstance class="EVENT_FLAG_AGENT">
1023 <synopsis>Raised when a caller joins a Queue.</synopsis>
1026 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1027 <parameter name="Position">
1028 <para>This channel's current position in the queue.</para>
1030 <parameter name="Count">
1031 <para>The total number of channels in the queue.</para>
1035 <ref type="managerEvent">QueueCallerLeave</ref>
1036 <ref type="application">Queue</ref>
1038 </managerEventInstance>
1040 <managerEvent language="en_US" name="QueueCallerLeave">
1041 <managerEventInstance class="EVENT_FLAG_AGENT">
1042 <synopsis>Raised when a caller leaves a Queue.</synopsis>
1045 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1046 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerJoin']/managerEventInstance/syntax/parameter[@name='Count'])" />
1047 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerJoin']/managerEventInstance/syntax/parameter[@name='Position'])" />
1050 <ref type="managerEvent">QueueCallerJoin</ref>
1052 </managerEventInstance>
1054 <managerEvent language="en_US" name="QueueCallerAbandon">
1055 <managerEventInstance class="EVENT_FLAG_AGENT">
1056 <synopsis>Raised when a caller abandons the queue.</synopsis>
1059 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1060 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerJoin']/managerEventInstance/syntax/parameter[@name='Position'])" />
1061 <parameter name="OriginalPosition">
1062 <para>The channel's original position in the queue.</para>
1064 <parameter name="HoldTime">
1065 <para>The time the channel was in the queue, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
1068 </managerEventInstance>
1070 <managerEvent language="en_US" name="AgentCalled">
1071 <managerEventInstance class="EVENT_FLAG_AGENT">
1072 <synopsis>Raised when an queue member is notified of a caller in the queue.</synopsis>
1075 <channel_snapshot prefix="Dest"/>
1076 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1077 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
1078 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
1081 <ref type="managerEvent">AgentRingNoAnswer</ref>
1082 <ref type="managerEvent">AgentComplete</ref>
1083 <ref type="managerEvent">AgentConnect</ref>
1085 </managerEventInstance>
1087 <managerEvent language="en_US" name="AgentRingNoAnswer">
1088 <managerEventInstance class="EVENT_FLAG_AGENT">
1089 <synopsis>Raised when a queue member is notified of a caller in the queue and fails to answer.</synopsis>
1092 <channel_snapshot prefix="Dest"/>
1093 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1094 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
1095 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
1096 <parameter name="RingTime">
1097 <para>The time the queue member was rung, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
1101 <ref type="managerEvent">AgentCalled</ref>
1103 </managerEventInstance>
1105 <managerEvent language="en_US" name="AgentComplete">
1106 <managerEventInstance class="EVENT_FLAG_AGENT">
1107 <synopsis>Raised when a queue member has finished servicing a caller in the queue.</synopsis>
1110 <channel_snapshot prefix="Dest"/>
1111 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1112 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
1113 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
1114 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerAbandon']/managerEventInstance/syntax/parameter[@name='HoldTime'])" />
1115 <parameter name="TalkTime">
1116 <para>The time the queue member talked with the caller in the queue, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
1118 <parameter name="Reason">
1120 <enum name="caller"/>
1121 <enum name="agent"/>
1122 <enum name="transfer"/>
1127 <ref type="managerEvent">AgentCalled</ref>
1128 <ref type="managerEvent">AgentConnect</ref>
1130 </managerEventInstance>
1132 <managerEvent language="en_US" name="AgentDump">
1133 <managerEventInstance class="EVENT_FLAG_AGENT">
1134 <synopsis>Raised when a queue member hangs up on a caller in the queue.</synopsis>
1137 <channel_snapshot prefix="Dest"/>
1138 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1139 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
1140 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
1143 <ref type="managerEvent">AgentCalled</ref>
1144 <ref type="managerEvent">AgentConnect</ref>
1146 </managerEventInstance>
1148 <managerEvent language="en_US" name="AgentConnect">
1149 <managerEventInstance class="EVENT_FLAG_AGENT">
1150 <synopsis>Raised when a queue member answers and is bridged to a caller in the queue.</synopsis>
1153 <channel_snapshot prefix="Dest"/>
1154 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1155 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
1156 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
1157 <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentRingNoAnswer']/managerEventInstance/syntax/parameter[@name='RingTime'])" />
1158 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerAbandon']/managerEventInstance/syntax/parameter[@name='HoldTime'])" />
1161 <ref type="managerEvent">AgentCalled</ref>
1162 <ref type="managerEvent">AgentComplete</ref>
1163 <ref type="managerEvent">AgentDump</ref>
1165 </managerEventInstance>
1170 OPT_MARK_AS_ANSWERED = (1 << 0),
1171 OPT_GO_ON = (1 << 1),
1172 OPT_DATA_QUALITY = (1 << 2),
1173 OPT_CALLEE_GO_ON = (1 << 3),
1174 OPT_CALLEE_HANGUP = (1 << 4),
1175 OPT_CALLER_HANGUP = (1 << 5),
1176 OPT_IGNORE_CALL_FW = (1 << 6),
1177 OPT_IGNORE_CONNECTEDLINE = (1 << 7),
1178 OPT_CALLEE_PARK = (1 << 8),
1179 OPT_CALLER_PARK = (1 << 9),
1180 OPT_NO_RETRY = (1 << 10),
1181 OPT_RINGING = (1 << 11),
1182 OPT_RING_WHEN_RINGING = (1 << 12),
1183 OPT_CALLEE_TRANSFER = (1 << 13),
1184 OPT_CALLER_TRANSFER = (1 << 14),
1185 OPT_CALLEE_AUTOMIXMON = (1 << 15),
1186 OPT_CALLER_AUTOMIXMON = (1 << 16),
1187 OPT_CALLEE_AUTOMON = (1 << 17),
1188 OPT_CALLER_AUTOMON = (1 << 18),
1192 OPT_ARG_CALLEE_GO_ON = 0,
1193 /* note: this entry _MUST_ be the last one in the enum */
1197 AST_APP_OPTIONS(queue_exec_options, BEGIN_OPTIONS
1198 AST_APP_OPTION('C', OPT_MARK_AS_ANSWERED),
1199 AST_APP_OPTION('c', OPT_GO_ON),
1200 AST_APP_OPTION('d', OPT_DATA_QUALITY),
1201 AST_APP_OPTION_ARG('F', OPT_CALLEE_GO_ON, OPT_ARG_CALLEE_GO_ON),
1202 AST_APP_OPTION('h', OPT_CALLEE_HANGUP),
1203 AST_APP_OPTION('H', OPT_CALLER_HANGUP),
1204 AST_APP_OPTION('i', OPT_IGNORE_CALL_FW),
1205 AST_APP_OPTION('I', OPT_IGNORE_CONNECTEDLINE),
1206 AST_APP_OPTION('k', OPT_CALLEE_PARK),
1207 AST_APP_OPTION('K', OPT_CALLER_PARK),
1208 AST_APP_OPTION('n', OPT_NO_RETRY),
1209 AST_APP_OPTION('r', OPT_RINGING),
1210 AST_APP_OPTION('R', OPT_RING_WHEN_RINGING),
1211 AST_APP_OPTION('t', OPT_CALLEE_TRANSFER),
1212 AST_APP_OPTION('T', OPT_CALLER_TRANSFER),
1213 AST_APP_OPTION('x', OPT_CALLEE_AUTOMIXMON),
1214 AST_APP_OPTION('X', OPT_CALLER_AUTOMIXMON),
1215 AST_APP_OPTION('w', OPT_CALLEE_AUTOMON),
1216 AST_APP_OPTION('W', OPT_CALLER_AUTOMON),
1220 QUEUE_STRATEGY_RINGALL = 0,
1221 QUEUE_STRATEGY_LEASTRECENT,
1222 QUEUE_STRATEGY_FEWESTCALLS,
1223 QUEUE_STRATEGY_RANDOM,
1224 QUEUE_STRATEGY_RRMEMORY,
1225 QUEUE_STRATEGY_LINEAR,
1226 QUEUE_STRATEGY_WRANDOM,
1227 QUEUE_STRATEGY_RRORDERED,
1231 QUEUE_AUTOPAUSE_OFF = 0,
1236 enum queue_reload_mask {
1237 QUEUE_RELOAD_PARAMETERS = (1 << 0),
1238 QUEUE_RELOAD_MEMBER = (1 << 1),
1239 QUEUE_RELOAD_RULES = (1 << 2),
1240 QUEUE_RESET_STATS = (1 << 3),
1243 static const struct strategy {
1247 { QUEUE_STRATEGY_RINGALL, "ringall" },
1248 { QUEUE_STRATEGY_LEASTRECENT, "leastrecent" },
1249 { QUEUE_STRATEGY_FEWESTCALLS, "fewestcalls" },
1250 { QUEUE_STRATEGY_RANDOM, "random" },
1251 { QUEUE_STRATEGY_RRMEMORY, "rrmemory" },
1252 { QUEUE_STRATEGY_RRMEMORY, "roundrobin" },
1253 { QUEUE_STRATEGY_LINEAR, "linear" },
1254 { QUEUE_STRATEGY_WRANDOM, "wrandom"},
1255 { QUEUE_STRATEGY_RRORDERED, "rrordered"},
1258 static const struct autopause {
1261 } autopausesmodes [] = {
1262 { QUEUE_AUTOPAUSE_OFF,"no" },
1263 { QUEUE_AUTOPAUSE_ON, "yes" },
1264 { QUEUE_AUTOPAUSE_ALL,"all" },
1267 #define DEFAULT_RETRY 5
1268 #define DEFAULT_TIMEOUT 15
1269 #define RECHECK 1 /*!< Recheck every second to see we we're at the top yet */
1270 #define MAX_PERIODIC_ANNOUNCEMENTS 10 /*!< The maximum periodic announcements we can have */
1272 * \brief The minimum number of seconds between position announcements.
1273 * \note The default value of 15 provides backwards compatibility.
1275 #define DEFAULT_MIN_ANNOUNCE_FREQUENCY 15
1277 #define MAX_QUEUE_BUCKETS 53
1279 #define RES_OKAY 0 /*!< Action completed */
1280 #define RES_EXISTS (-1) /*!< Entry already exists */
1281 #define RES_OUTOFMEMORY (-2) /*!< Out of memory */
1282 #define RES_NOSUCHQUEUE (-3) /*!< No such queue */
1283 #define RES_NOT_DYNAMIC (-4) /*!< Member is not dynamic */
1285 static char *app = "Queue";
1287 static char *app_aqm = "AddQueueMember" ;
1289 static char *app_rqm = "RemoveQueueMember" ;
1291 static char *app_pqm = "PauseQueueMember" ;
1293 static char *app_upqm = "UnpauseQueueMember" ;
1295 static char *app_ql = "QueueLog" ;
1297 /*! \brief Persistent Members astdb family */
1298 static const char * const pm_family = "Queue/PersistentMembers";
1300 /*! \brief queues.conf [general] option */
1301 static int queue_persistent_members = 0;
1303 /*! \brief queues.conf per-queue weight option */
1304 static int use_weight = 0;
1306 /*! \brief queues.conf [general] option */
1307 static int autofill_default = 1;
1309 /*! \brief queues.conf [general] option */
1310 static int montype_default = 0;
1312 /*! \brief queues.conf [general] option */
1313 static int shared_lastcall = 1;
1315 /*! \brief Subscription to device state change messages */
1316 static struct stasis_subscription *device_state_sub;
1318 /*! \brief queues.conf [general] option */
1319 static int update_cdr = 0;
1321 /*! \brief queues.conf [general] option */
1322 static int negative_penalty_invalid = 0;
1324 /*! \brief queues.conf [general] option */
1325 static int log_membername_as_agent = 0;
1327 /*! \brief name of the ringinuse field in the realtime database */
1328 static char *realtime_ringinuse_field;
1333 QUEUE_JOINEMPTY = 2,
1334 QUEUE_LEAVEEMPTY = 3,
1335 QUEUE_JOINUNAVAIL = 4,
1336 QUEUE_LEAVEUNAVAIL = 5,
1341 static const struct {
1342 enum queue_result id;
1344 } queue_results[] = {
1345 { QUEUE_UNKNOWN, "UNKNOWN" },
1346 { QUEUE_TIMEOUT, "TIMEOUT" },
1347 { QUEUE_JOINEMPTY,"JOINEMPTY" },
1348 { QUEUE_LEAVEEMPTY, "LEAVEEMPTY" },
1349 { QUEUE_JOINUNAVAIL, "JOINUNAVAIL" },
1350 { QUEUE_LEAVEUNAVAIL, "LEAVEUNAVAIL" },
1351 { QUEUE_FULL, "FULL" },
1352 { QUEUE_CONTINUE, "CONTINUE" },
1355 enum queue_timeout_priority {
1356 TIMEOUT_PRIORITY_APP,
1357 TIMEOUT_PRIORITY_CONF,
1360 /*! \brief We define a custom "local user" structure because we
1361 * use it not only for keeping track of what is in use but
1362 * also for keeping track of who we're dialing.
1364 * There are two "links" defined in this structure, q_next and call_next.
1365 * q_next links ALL defined callattempt structures into a linked list. call_next is
1366 * a link which allows for a subset of the callattempts to be traversed. This subset
1367 * is used in wait_for_answer so that irrelevant callattempts are not traversed. This
1368 * also is helpful so that queue logs are always accurate in the case where a call to
1369 * a member times out, especially if using the ringall strategy.
1372 struct callattempt {
1373 struct callattempt *q_next;
1374 struct callattempt *call_next;
1375 struct ast_channel *chan;
1376 char interface[256]; /*!< An Asterisk dial string (not a channel name) */
1379 struct call_queue *lastqueue;
1380 struct member *member;
1381 /*! Saved connected party info from an AST_CONTROL_CONNECTED_LINE. */
1382 struct ast_party_connected_line connected;
1383 /*! TRUE if an AST_CONTROL_CONNECTED_LINE update was saved to the connected element. */
1384 unsigned int pending_connected_update:1;
1385 /*! TRUE if the connected line update is blocked. */
1386 unsigned int block_connected_update:1;
1387 /*! TRUE if caller id is not available for connected line */
1388 unsigned int dial_callerid_absent:1;
1389 /*! TRUE if the call is still active */
1390 unsigned int stillgoing:1;
1391 struct ast_aoc_decoded *aoc_s_rate_list;
1396 struct call_queue *parent; /*!< What queue is our parent */
1397 char moh[MAX_MUSICCLASS]; /*!< Name of musiconhold to be used */
1398 char announce[PATH_MAX]; /*!< Announcement to play for member when call is answered */
1399 char context[AST_MAX_CONTEXT]; /*!< Context when user exits queue */
1400 char digits[AST_MAX_EXTENSION]; /*!< Digits entered while in queue */
1401 int valid_digits; /*!< Digits entered correspond to valid extension. Exited */
1402 int pos; /*!< Where we are in the queue */
1403 int prio; /*!< Our priority */
1404 int last_pos_said; /*!< Last position we told the user */
1405 int ring_when_ringing; /*!< Should we only use ring indication when a channel is ringing? */
1406 time_t last_periodic_announce_time; /*!< The last time we played a periodic announcement */
1407 int last_periodic_announce_sound; /*!< The last periodic announcement we made */
1408 time_t last_pos; /*!< Last time we told the user their position */
1409 int opos; /*!< Where we started in the queue */
1410 int handled; /*!< Whether our call was handled */
1411 int pending; /*!< Non-zero if we are attempting to call a member */
1412 int max_penalty; /*!< Limit the members that can take this call to this penalty or lower */
1413 int min_penalty; /*!< Limit the members that can take this call to this penalty or higher */
1414 int linpos; /*!< If using linear strategy, what position are we at? */
1415 int linwrapped; /*!< Is the linpos wrapped? */
1416 time_t start; /*!< When we started holding */
1417 time_t expire; /*!< When this entry should expire (time out of queue) */
1418 int cancel_answered_elsewhere; /*!< Whether we should force the CAE flag on this call (C) option*/
1419 struct ast_channel *chan; /*!< Our channel */
1420 AST_LIST_HEAD_NOLOCK(,penalty_rule) qe_rules; /*!< Local copy of the queue's penalty rules */
1421 struct penalty_rule *pr; /*!< Pointer to the next penalty rule to implement */
1422 struct queue_ent *next; /*!< The next queue entry */
1426 char interface[AST_CHANNEL_NAME]; /*!< Technology/Location to dial to reach this member*/
1427 char state_exten[AST_MAX_EXTENSION]; /*!< Extension to get state from (if using hint) */
1428 char state_context[AST_MAX_CONTEXT]; /*!< Context to use when getting state (if using hint) */
1429 char state_interface[AST_CHANNEL_NAME]; /*!< Technology/Location from which to read devicestate changes */
1430 char membername[80]; /*!< Member name to use in queue logs */
1431 int penalty; /*!< Are we a last resort? */
1432 int calls; /*!< Number of calls serviced by this member */
1433 int dynamic; /*!< Are we dynamically added? */
1434 int realtime; /*!< Is this member realtime? */
1435 int status; /*!< Status of queue member */
1436 int paused; /*!< Are we paused (not accepting calls)? */
1437 int queuepos; /*!< In what order (pertains to certain strategies) should this member be called? */
1438 time_t lastcall; /*!< When last successful call was hungup */
1439 struct call_queue *lastqueue; /*!< Last queue we received a call */
1440 unsigned int dead:1; /*!< Used to detect members deleted in realtime */
1441 unsigned int delme:1; /*!< Flag to delete entry on reload */
1442 unsigned int call_pending:1; /*!< TRUE if the Q is attempting to place a call to the member. */
1443 char rt_uniqueid[80]; /*!< Unique id of realtime member entry */
1444 unsigned int ringinuse:1; /*!< Flag to ring queue members even if their status is 'inuse' */
1447 enum empty_conditions {
1448 QUEUE_EMPTY_PENALTY = (1 << 0),
1449 QUEUE_EMPTY_PAUSED = (1 << 1),
1450 QUEUE_EMPTY_INUSE = (1 << 2),
1451 QUEUE_EMPTY_RINGING = (1 << 3),
1452 QUEUE_EMPTY_UNAVAILABLE = (1 << 4),
1453 QUEUE_EMPTY_INVALID = (1 << 5),
1454 QUEUE_EMPTY_UNKNOWN = (1 << 6),
1455 QUEUE_EMPTY_WRAPUP = (1 << 7),
1458 enum member_properties {
1460 MEMBER_RINGINUSE = 1,
1463 /* values used in multi-bit flags in call_queue */
1464 #define ANNOUNCEHOLDTIME_ALWAYS 1
1465 #define ANNOUNCEHOLDTIME_ONCE 2
1466 #define QUEUE_EVENT_VARIABLES 3
1468 struct penalty_rule {
1469 int time; /*!< Number of seconds that need to pass before applying this rule */
1470 int max_value; /*!< The amount specified in the penalty rule for max penalty */
1471 int min_value; /*!< The amount specified in the penalty rule for min penalty */
1472 int max_relative; /*!< Is the max adjustment relative? 1 for relative, 0 for absolute */
1473 int min_relative; /*!< Is the min adjustment relative? 1 for relative, 0 for absolute */
1474 AST_LIST_ENTRY(penalty_rule) list; /*!< Next penalty_rule */
1477 #define ANNOUNCEPOSITION_YES 1 /*!< We announce position */
1478 #define ANNOUNCEPOSITION_NO 2 /*!< We don't announce position */
1479 #define ANNOUNCEPOSITION_MORE_THAN 3 /*!< We say "Currently there are more than <limit>" */
1480 #define ANNOUNCEPOSITION_LIMIT 4 /*!< We not announce position more than <limit> */
1483 AST_DECLARE_STRING_FIELDS(
1485 AST_STRING_FIELD(name);
1486 /*! Music on Hold class */
1487 AST_STRING_FIELD(moh);
1488 /*! Announcement to play when call is answered */
1489 AST_STRING_FIELD(announce);
1491 AST_STRING_FIELD(context);
1492 /*! Macro to run upon member connection */
1493 AST_STRING_FIELD(membermacro);
1494 /*! Gosub to run upon member connection */
1495 AST_STRING_FIELD(membergosub);
1496 /*! Default rule to use if none specified in call to Queue() */
1497 AST_STRING_FIELD(defaultrule);
1498 /*! Sound file: "Your call is now first in line" (def. queue-youarenext) */
1499 AST_STRING_FIELD(sound_next);
1500 /*! Sound file: "There are currently" (def. queue-thereare) */
1501 AST_STRING_FIELD(sound_thereare);
1502 /*! Sound file: "calls waiting to speak to a representative." (def. queue-callswaiting) */
1503 AST_STRING_FIELD(sound_calls);
1504 /*! Sound file: "Currently there are more than" (def. queue-quantity1) */
1505 AST_STRING_FIELD(queue_quantity1);
1506 /*! Sound file: "callers waiting to speak with a representative" (def. queue-quantity2) */
1507 AST_STRING_FIELD(queue_quantity2);
1508 /*! Sound file: "The current estimated total holdtime is" (def. queue-holdtime) */
1509 AST_STRING_FIELD(sound_holdtime);
1510 /*! Sound file: "minutes." (def. queue-minutes) */
1511 AST_STRING_FIELD(sound_minutes);
1512 /*! Sound file: "minute." (def. queue-minute) */
1513 AST_STRING_FIELD(sound_minute);
1514 /*! Sound file: "seconds." (def. queue-seconds) */
1515 AST_STRING_FIELD(sound_seconds);
1516 /*! Sound file: "Thank you for your patience." (def. queue-thankyou) */
1517 AST_STRING_FIELD(sound_thanks);
1518 /*! Sound file: Custom announce for caller, no default */
1519 AST_STRING_FIELD(sound_callerannounce);
1520 /*! Sound file: "Hold time" (def. queue-reporthold) */
1521 AST_STRING_FIELD(sound_reporthold);
1523 /*! Sound files: Custom announce, no default */
1524 struct ast_str *sound_periodicannounce[MAX_PERIODIC_ANNOUNCEMENTS];
1525 unsigned int dead:1;
1526 unsigned int ringinuse:1;
1527 unsigned int announce_to_first_user:1; /*!< Whether or not we announce to the first user in a queue */
1528 unsigned int setinterfacevar:1;
1529 unsigned int setqueuevar:1;
1530 unsigned int setqueueentryvar:1;
1531 unsigned int reportholdtime:1;
1532 unsigned int wrapped:1;
1533 unsigned int timeoutrestart:1;
1534 unsigned int announceholdtime:2;
1535 unsigned int announceposition:3;
1537 unsigned int realtime:1;
1538 unsigned int found:1;
1539 unsigned int relativeperiodicannounce:1;
1540 unsigned int autopausebusy:1;
1541 unsigned int autopauseunavail:1;
1542 enum empty_conditions joinempty;
1543 enum empty_conditions leavewhenempty;
1544 int announcepositionlimit; /*!< How many positions we announce? */
1545 int announcefrequency; /*!< How often to announce their position */
1546 int minannouncefrequency; /*!< The minimum number of seconds between position announcements (def. 15) */
1547 int periodicannouncefrequency; /*!< How often to play periodic announcement */
1548 int numperiodicannounce; /*!< The number of periodic announcements configured */
1549 int randomperiodicannounce; /*!< Are periodic announcments randomly chosen */
1550 int roundingseconds; /*!< How many seconds do we round to? */
1551 int holdtime; /*!< Current avg holdtime, based on an exponential average */
1552 int talktime; /*!< Current avg talktime, based on the same exponential average */
1553 int callscompleted; /*!< Number of queue calls completed */
1554 int callsabandoned; /*!< Number of queue calls abandoned */
1555 int servicelevel; /*!< seconds setting for servicelevel*/
1556 int callscompletedinsl; /*!< Number of calls answered with servicelevel*/
1557 char monfmt[8]; /*!< Format to use when recording calls */
1558 int montype; /*!< Monitor type Monitor vs. MixMonitor */
1559 int count; /*!< How many entries */
1560 int maxlen; /*!< Max number of entries */
1561 int wrapuptime; /*!< Wrapup Time */
1562 int penaltymemberslimit; /*!< Disregard penalty when queue has fewer than this many members */
1564 int retry; /*!< Retry calling everyone after this amount of time */
1565 int timeout; /*!< How long to wait for an answer */
1566 int weight; /*!< Respective weight */
1567 int autopause; /*!< Auto pause queue members if they fail to answer */
1568 int autopausedelay; /*!< Delay auto pause for autopausedelay seconds since last call */
1569 int timeoutpriority; /*!< Do we allow a fraction of the timeout to occur for a ring? */
1571 /* Queue strategy things */
1572 int rrpos; /*!< Round Robin - position */
1573 int memberdelay; /*!< Seconds to delay connecting member to caller */
1574 int autofill; /*!< Ignore the head call status and ring an available agent */
1576 struct ao2_container *members; /*!< Head of the list of members */
1577 struct queue_ent *head; /*!< Head of the list of callers */
1578 AST_LIST_ENTRY(call_queue) list; /*!< Next call queue */
1579 AST_LIST_HEAD_NOLOCK(, penalty_rule) rules; /*!< The list of penalty rules to invoke */
1584 AST_LIST_HEAD_NOLOCK(,penalty_rule) rules;
1585 AST_LIST_ENTRY(rule_list) list;
1588 static AST_LIST_HEAD_STATIC(rule_lists, rule_list);
1590 static struct ao2_container *queues;
1592 static void update_realtime_members(struct call_queue *q);
1593 static struct member *interface_exists(struct call_queue *q, const char *interface);
1594 static int set_member_paused(const char *queuename, const char *interface, const char *reason, int paused);
1596 static struct member *find_member_by_queuename_and_interface(const char *queuename, const char *interface);
1597 /*! \brief sets the QUEUESTATUS channel variable */
1598 static void set_queue_result(struct ast_channel *chan, enum queue_result res)
1602 for (i = 0; i < ARRAY_LEN(queue_results); i++) {
1603 if (queue_results[i].id == res) {
1604 pbx_builtin_setvar_helper(chan, "QUEUESTATUS", queue_results[i].text);
1610 static const char *int2strat(int strategy)
1614 for (x = 0; x < ARRAY_LEN(strategies); x++) {
1615 if (strategy == strategies[x].strategy) {
1616 return strategies[x].name;
1623 static int strat2int(const char *strategy)
1627 for (x = 0; x < ARRAY_LEN(strategies); x++) {
1628 if (!strcasecmp(strategy, strategies[x].name)) {
1629 return strategies[x].strategy;
1636 static int autopause2int(const char *autopause)
1639 /*This 'double check' that default value is OFF */
1640 if (ast_strlen_zero(autopause)) {
1641 return QUEUE_AUTOPAUSE_OFF;
1644 /*This 'double check' is to ensure old values works */
1645 if(ast_true(autopause)) {
1646 return QUEUE_AUTOPAUSE_ON;
1649 for (x = 0; x < ARRAY_LEN(autopausesmodes); x++) {
1650 if (!strcasecmp(autopause, autopausesmodes[x].name)) {
1651 return autopausesmodes[x].autopause;
1655 /*This 'double check' that default value is OFF */
1656 return QUEUE_AUTOPAUSE_OFF;
1659 static int queue_hash_cb(const void *obj, const int flags)
1661 const struct call_queue *q = obj;
1663 return ast_str_case_hash(q->name);
1666 static int queue_cmp_cb(void *obj, void *arg, int flags)
1668 struct call_queue *q = obj, *q2 = arg;
1669 return !strcasecmp(q->name, q2->name) ? CMP_MATCH | CMP_STOP : 0;
1673 * \brief ao2_callback, Decreases queuepos of all followers with a queuepos greater than arg.
1674 * \param obj the member being acted on
1675 * \param arg pointer to an integer containing the position value that was removed and requires reduction for anything above
1677 static int queue_member_decrement_followers(void *obj, void *arg, int flag)
1679 struct member *mem = obj;
1680 int *decrement_followers_after = arg;
1682 if (mem->queuepos > *decrement_followers_after) {
1690 * \brief ao2_callback, finds members in a queue marked for deletion and in a cascading fashion runs queue_member_decrement_followers
1691 * on them. This callback should always be ran before performing mass unlinking of delmarked members from queues.
1692 * \param obj member being acted on
1693 * \param arg pointer to the queue members are being removed from
1695 static int queue_delme_members_decrement_followers(void *obj, void *arg, int flag)
1697 struct member *mem = obj;
1698 struct call_queue *queue = arg;
1699 int rrpos = mem->queuepos;
1702 ao2_callback(queue->members, OBJ_NODATA | OBJ_MULTIPLE, queue_member_decrement_followers, &rrpos);
1709 * \brief Use this to decrement followers during removal of a member
1710 * \param queue which queue the member is being removed from
1711 * \param mem which member is being removed from the queue
1713 static void queue_member_follower_removal(struct call_queue *queue, struct member *mem)
1715 int pos = mem->queuepos;
1717 /* If the position being removed is less than the current place in the queue, reduce the queue position by one so that we don't skip the member
1718 * who would have been next otherwise. */
1719 if (pos < queue->rrpos) {
1723 ao2_callback(queue->members, OBJ_NODATA | OBJ_MULTIPLE, queue_member_decrement_followers, &pos);
1726 #ifdef REF_DEBUG_ONLY_QUEUES
1727 #define queue_ref(q) _queue_ref(q, "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1728 #define queue_unref(q) _queue_unref(q, "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1729 #define queue_t_ref(q, tag) _queue_ref(q, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1730 #define queue_t_unref(q, tag) _queue_unref(q, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1731 #define queues_t_link(c, q, tag) __ao2_link_debug(c, q, 0, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1732 #define queues_t_unlink(c, q, tag) __ao2_unlink_debug(c, q, 0, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1734 static inline struct call_queue *_queue_ref(struct call_queue *q, const char *tag, const char *file, int line, const char *filename)
1736 __ao2_ref_debug(q, 1, tag, file, line, filename);
1740 static inline struct call_queue *_queue_unref(struct call_queue *q, const char *tag, const char *file, int line, const char *filename)
1743 __ao2_ref_debug(q, -1, tag, file, line, filename);
1750 #define queue_t_ref(q, tag) queue_ref(q)
1751 #define queue_t_unref(q, tag) queue_unref(q)
1752 #define queues_t_link(c, q, tag) ao2_t_link(c, q, tag)
1753 #define queues_t_unlink(c, q, tag) ao2_t_unlink(c, q, tag)
1755 static inline struct call_queue *queue_ref(struct call_queue *q)
1761 static inline struct call_queue *queue_unref(struct call_queue *q)
1770 /*! \brief Set variables of queue */
1771 static void set_queue_variables(struct call_queue *q, struct ast_channel *chan)
1773 char interfacevar[256]="";
1778 if (q->setqueuevar) {
1780 if (q->callscompleted > 0) {
1781 sl = 100 * ((float) q->callscompletedinsl / (float) q->callscompleted);
1784 snprintf(interfacevar, sizeof(interfacevar),
1785 "QUEUENAME=%s,QUEUEMAX=%d,QUEUESTRATEGY=%s,QUEUECALLS=%d,QUEUEHOLDTIME=%d,QUEUETALKTIME=%d,QUEUECOMPLETED=%d,QUEUEABANDONED=%d,QUEUESRVLEVEL=%d,QUEUESRVLEVELPERF=%2.1f",
1786 q->name, q->maxlen, int2strat(q->strategy), q->count, q->holdtime, q->talktime, q->callscompleted, q->callsabandoned, q->servicelevel, sl);
1790 pbx_builtin_setvar_multiple(chan, interfacevar);
1796 /*! \brief Insert the 'new' entry after the 'prev' entry of queue 'q' */
1797 static inline void insert_entry(struct call_queue *q, struct queue_ent *prev, struct queue_ent *new, int *pos)
1799 struct queue_ent *cur;
1812 /* every queue_ent must have a reference to it's parent call_queue, this
1813 * reference does not go away until the end of the queue_ent's life, meaning
1814 * that even when the queue_ent leaves the call_queue this ref must remain. */
1817 new->pos = ++(*pos);
1821 static struct ast_manager_event_blob *queue_channel_to_ami(const char *type, struct stasis_message *message)
1823 struct ast_channel_blob *obj = stasis_message_data(message);
1824 RAII_VAR(struct ast_str *, channel_string, NULL, ast_free);
1825 RAII_VAR(struct ast_str *, event_string, NULL, ast_free);
1827 channel_string = ast_manager_build_channel_state_string(obj->snapshot);
1828 event_string = ast_manager_str_from_json_object(obj->blob, NULL);
1829 if (!channel_string || !event_string) {
1833 return ast_manager_event_blob_create(EVENT_FLAG_AGENT, type,
1836 ast_str_buffer(channel_string),
1837 ast_str_buffer(event_string));
1840 static struct ast_manager_event_blob *queue_caller_join_to_ami(struct stasis_message *message)
1842 return queue_channel_to_ami("QueueCallerJoin", message);
1845 static struct ast_manager_event_blob *queue_caller_leave_to_ami(struct stasis_message *message)
1847 return queue_channel_to_ami("QueueCallerLeave", message);
1850 static struct ast_manager_event_blob *queue_caller_abandon_to_ami(struct stasis_message *message)
1852 return queue_channel_to_ami("QueueCallerAbandon", message);
1855 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_caller_join_type,
1856 .to_ami = queue_caller_join_to_ami,
1858 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_caller_leave_type,
1859 .to_ami = queue_caller_leave_to_ami,
1861 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_caller_abandon_type,
1862 .to_ami = queue_caller_abandon_to_ami,
1865 static struct ast_manager_event_blob *queue_member_to_ami(const char *type, struct stasis_message *message)
1867 struct ast_json_payload *payload = stasis_message_data(message);
1868 RAII_VAR(struct ast_str *, event_string, NULL, ast_free);
1870 event_string = ast_manager_str_from_json_object(payload->json, NULL);
1871 if (!event_string) {
1875 return ast_manager_event_blob_create(EVENT_FLAG_AGENT, type,
1877 ast_str_buffer(event_string));
1880 static struct ast_manager_event_blob *queue_member_status_to_ami(struct stasis_message *message)
1882 return queue_member_to_ami("QueueMemberStatus", message);
1885 static struct ast_manager_event_blob *queue_member_added_to_ami(struct stasis_message *message)
1887 return queue_member_to_ami("QueueMemberAdded", message);
1890 static struct ast_manager_event_blob *queue_member_removed_to_ami(struct stasis_message *message)
1892 return queue_member_to_ami("QueueMemberRemoved", message);
1895 static struct ast_manager_event_blob *queue_member_pause_to_ami(struct stasis_message *message)
1897 return queue_member_to_ami("QueueMemberPause", message);
1900 static struct ast_manager_event_blob *queue_member_penalty_to_ami(struct stasis_message *message)
1902 return queue_member_to_ami("QueueMemberPenalty", message);
1905 static struct ast_manager_event_blob *queue_member_ringinuse_to_ami(struct stasis_message *message)
1907 return queue_member_to_ami("QueueMemberRinginuse", message);
1910 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_member_status_type,
1911 .to_ami = queue_member_status_to_ami,
1913 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_member_added_type,
1914 .to_ami = queue_member_added_to_ami,
1916 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_member_removed_type,
1917 .to_ami = queue_member_removed_to_ami,
1919 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_member_pause_type,
1920 .to_ami = queue_member_pause_to_ami,
1922 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_member_penalty_type,
1923 .to_ami = queue_member_penalty_to_ami,
1925 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_member_ringinuse_type,
1926 .to_ami = queue_member_ringinuse_to_ami,
1929 static struct ast_manager_event_blob *queue_multi_channel_to_ami(const char *type, struct stasis_message *message)
1931 struct ast_multi_channel_blob *obj = stasis_message_data(message);
1932 struct ast_channel_snapshot *caller;
1933 struct ast_channel_snapshot *agent;
1934 RAII_VAR(struct ast_str *, caller_event_string, NULL, ast_free);
1935 RAII_VAR(struct ast_str *, agent_event_string, NULL, ast_free);
1936 RAII_VAR(struct ast_str *, event_string, NULL, ast_free);
1938 caller = ast_multi_channel_blob_get_channel(obj, "caller");
1940 caller_event_string = ast_manager_build_channel_state_string(caller);
1941 if (!caller_event_string) {
1942 ast_log(LOG_NOTICE, "No caller event string, bailing\n");
1947 agent = ast_multi_channel_blob_get_channel(obj, "agent");
1949 agent_event_string = ast_manager_build_channel_state_string_prefix(agent, "Dest");
1950 if (!agent_event_string) {
1951 ast_log(LOG_NOTICE, "No agent event string, bailing\n");
1956 event_string = ast_manager_str_from_json_object(ast_multi_channel_blob_get_json(obj), NULL);
1957 if (!event_string) {
1961 return ast_manager_event_blob_create(EVENT_FLAG_AGENT, type,
1965 caller_event_string ? ast_str_buffer(caller_event_string) : "",
1966 agent_event_string ? ast_str_buffer(agent_event_string) : "",
1967 ast_str_buffer(event_string));
1970 static struct ast_manager_event_blob *queue_agent_called_to_ami(struct stasis_message *message)
1972 return queue_multi_channel_to_ami("AgentCalled", message);
1975 static struct ast_manager_event_blob *queue_agent_connect_to_ami(struct stasis_message *message)
1977 return queue_multi_channel_to_ami("AgentConnect", message);
1980 static struct ast_manager_event_blob *queue_agent_complete_to_ami(struct stasis_message *message)
1982 return queue_multi_channel_to_ami("AgentComplete", message);
1985 static struct ast_manager_event_blob *queue_agent_dump_to_ami(struct stasis_message *message)
1987 return queue_multi_channel_to_ami("AgentDump", message);
1990 static struct ast_manager_event_blob *queue_agent_ringnoanswer_to_ami(struct stasis_message *message)
1992 return queue_multi_channel_to_ami("AgentRingNoAnswer", message);
1995 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_agent_called_type,
1996 .to_ami = queue_agent_called_to_ami,
1998 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_agent_connect_type,
1999 .to_ami = queue_agent_connect_to_ami,
2001 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_agent_complete_type,
2002 .to_ami = queue_agent_complete_to_ami,
2004 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_agent_dump_type,
2005 .to_ami = queue_agent_dump_to_ami,
2007 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_agent_ringnoanswer_type,
2008 .to_ami = queue_agent_ringnoanswer_to_ami,
2011 static void queue_publish_multi_channel_snapshot_blob(struct stasis_topic *topic,
2012 struct ast_channel_snapshot *caller_snapshot,
2013 struct ast_channel_snapshot *agent_snapshot,
2014 struct stasis_message_type *type, struct ast_json *blob)
2016 RAII_VAR(struct ast_multi_channel_blob *, payload, NULL, ao2_cleanup);
2017 RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
2019 payload = ast_multi_channel_blob_create(blob);
2024 ast_multi_channel_blob_add_channel(payload, "caller", caller_snapshot);
2025 if (agent_snapshot) {
2026 ast_multi_channel_blob_add_channel(payload, "agent", agent_snapshot);
2029 msg = stasis_message_create(type, payload);
2034 stasis_publish(topic, msg);
2037 static void queue_publish_multi_channel_blob(struct ast_channel *caller, struct ast_channel *agent,
2038 struct stasis_message_type *type, struct ast_json *blob)
2040 RAII_VAR(struct ast_channel_snapshot *, caller_snapshot, NULL, ao2_cleanup);
2041 RAII_VAR(struct ast_channel_snapshot *, agent_snapshot, NULL, ao2_cleanup);
2043 ast_channel_lock(caller);
2044 caller_snapshot = ast_channel_snapshot_create(caller);
2045 ast_channel_unlock(caller);
2046 ast_channel_lock(agent);
2047 agent_snapshot = ast_channel_snapshot_create(agent);
2048 ast_channel_unlock(agent);
2050 if (!caller_snapshot || !agent_snapshot) {
2054 queue_publish_multi_channel_snapshot_blob(ast_channel_topic(caller), caller_snapshot,
2055 agent_snapshot, type, blob);
2060 * \brief Publish the member blob.
2063 * \param type Stasis message type to publish.
2064 * \param blob The information being published.
2066 * \note The json blob reference is passed to this function.
2070 static void queue_publish_member_blob(struct stasis_message_type *type, struct ast_json *blob)
2072 RAII_VAR(struct ast_json_payload *, payload, NULL, ao2_cleanup);
2073 RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
2079 payload = ast_json_payload_create(blob);
2080 ast_json_unref(blob);
2085 msg = stasis_message_create(type, payload);
2090 stasis_publish(ast_manager_get_topic(), msg);
2093 static struct ast_json *queue_member_blob_create(struct call_queue *q, struct member *mem)
2095 return ast_json_pack("{s: s, s: s, s: s, s: s, s: s, s: i, s: i, s: i, s: i, s: i, s: i}",
2097 "MemberName", mem->membername,
2098 "Interface", mem->interface,
2099 "StateInterface", mem->state_interface,
2100 "Membership", (mem->dynamic ? "dynamic" : (mem->realtime ? "realtime" : "static")),
2101 "Penalty", mem->penalty,
2102 "CallsTaken", mem->calls,
2103 "LastCall", (int)mem->lastcall,
2104 "Status", mem->status,
2105 "Paused", mem->paused,
2106 "Ringinuse", mem->ringinuse);
2109 /*! \brief Check if members are available
2111 * This function checks to see if members are available to be called. If any member
2112 * is available, the function immediately returns 0. If no members are available,
2113 * then -1 is returned.
2115 static int get_member_status(struct call_queue *q, int max_penalty, int min_penalty, enum empty_conditions conditions)
2117 struct member *member;
2118 struct ao2_iterator mem_iter;
2121 mem_iter = ao2_iterator_init(q->members, 0);
2122 for (; (member = ao2_iterator_next(&mem_iter)); ao2_ref(member, -1)) {
2123 if ((max_penalty != INT_MAX && member->penalty > max_penalty) || (min_penalty != INT_MAX && member->penalty < min_penalty)) {
2124 if (conditions & QUEUE_EMPTY_PENALTY) {
2125 ast_debug(4, "%s is unavailable because his penalty is not between %d and %d\n", member->membername, min_penalty, max_penalty);
2130 switch (member->status) {
2131 case AST_DEVICE_INVALID:
2132 if (conditions & QUEUE_EMPTY_INVALID) {
2133 ast_debug(4, "%s is unavailable because his device state is 'invalid'\n", member->membername);
2137 case AST_DEVICE_UNAVAILABLE:
2138 if (conditions & QUEUE_EMPTY_UNAVAILABLE) {
2139 ast_debug(4, "%s is unavailable because his device state is 'unavailable'\n", member->membername);
2143 case AST_DEVICE_INUSE:
2144 if (conditions & QUEUE_EMPTY_INUSE) {
2145 ast_debug(4, "%s is unavailable because his device state is 'inuse'\n", member->membername);
2149 case AST_DEVICE_RINGING:
2150 if (conditions & QUEUE_EMPTY_RINGING) {
2151 ast_debug(4, "%s is unavailable because his device state is 'ringing'\n", member->membername);
2155 case AST_DEVICE_UNKNOWN:
2156 if (conditions & QUEUE_EMPTY_UNKNOWN) {
2157 ast_debug(4, "%s is unavailable because his device state is 'unknown'\n", member->membername);
2163 if (member->paused && (conditions & QUEUE_EMPTY_PAUSED)) {
2164 ast_debug(4, "%s is unavailable because he is paused'\n", member->membername);
2166 } else if ((conditions & QUEUE_EMPTY_WRAPUP) && member->lastcall && q->wrapuptime && (time(NULL) - q->wrapuptime < member->lastcall)) {
2167 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);
2170 ao2_ref(member, -1);
2171 ao2_iterator_destroy(&mem_iter);
2173 ast_debug(4, "%s is available.\n", member->membername);
2179 ao2_iterator_destroy(&mem_iter);
2185 /*! \brief set a member's status based on device state of that member's state_interface.
2187 * Lock interface list find sc, iterate through each queues queue_member list for member to
2188 * update state inside queues
2190 static void update_status(struct call_queue *q, struct member *m, const int status)
2194 queue_publish_member_blob(queue_member_status_type(), queue_member_blob_create(q, m));
2199 * \brief Determine if a queue member is available
2200 * \retval 1 if the member is available
2201 * \retval 0 if the member is not available
2203 static int is_member_available(struct call_queue *q, struct member *mem)
2207 switch (mem->status) {
2208 case AST_DEVICE_INVALID:
2209 case AST_DEVICE_UNAVAILABLE:
2211 case AST_DEVICE_INUSE:
2212 case AST_DEVICE_BUSY:
2213 case AST_DEVICE_RINGING:
2214 case AST_DEVICE_RINGINUSE:
2215 case AST_DEVICE_ONHOLD:
2216 if (!mem->ringinuse) {
2219 /* else fall through */
2220 case AST_DEVICE_NOT_INUSE:
2221 case AST_DEVICE_UNKNOWN:
2228 /* Let wrapuptimes override device state availability */
2229 if (mem->lastcall && q->wrapuptime && (time(NULL) - q->wrapuptime < mem->lastcall)) {
2235 /*! \brief set a member's status based on device state of that member's interface*/
2236 static void device_state_cb(void *unused, struct stasis_subscription *sub, struct stasis_message *msg)
2238 struct ao2_iterator miter, qiter;
2239 struct ast_device_state_message *dev_state;
2241 struct call_queue *q;
2242 char interface[80], *slash_pos;
2243 int found = 0; /* Found this member in any queue */
2244 int found_member; /* Found this member in this queue */
2245 int avail = 0; /* Found an available member in this queue */
2247 if (ast_device_state_message_type() != stasis_message_type(msg)) {
2251 dev_state = stasis_message_data(msg);
2252 if (dev_state->eid) {
2253 /* ignore non-aggregate states */
2257 qiter = ao2_iterator_init(queues, 0);
2258 while ((q = ao2_t_iterator_next(&qiter, "Iterate over queues"))) {
2263 miter = ao2_iterator_init(q->members, 0);
2264 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
2265 if (!found_member) {
2266 ast_copy_string(interface, m->state_interface, sizeof(interface));
2268 if ((slash_pos = strchr(interface, '/'))) {
2269 if (!strncasecmp(interface, "Local/", 6) && (slash_pos = strchr(slash_pos + 1, '/'))) {
2274 if (!strcasecmp(interface, dev_state->device)) {
2276 update_status(q, m, dev_state->state);
2280 /* check every member until we find one NOT_INUSE */
2282 avail = is_member_available(q, m);
2284 if (avail && found_member) {
2285 /* early exit as we've found an available member and the member of interest */
2294 ast_devstate_changed(AST_DEVICE_NOT_INUSE, AST_DEVSTATE_CACHABLE, "Queue:%s_avail", q->name);
2296 ast_devstate_changed(AST_DEVICE_INUSE, AST_DEVSTATE_CACHABLE, "Queue:%s_avail", q->name);
2300 ao2_iterator_destroy(&miter);
2303 queue_t_unref(q, "Done with iterator");
2305 ao2_iterator_destroy(&qiter);
2308 ast_debug(1, "Device '%s' changed to state '%d' (%s)\n",
2311 ast_devstate2str(dev_state->state));
2313 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",
2316 ast_devstate2str(dev_state->state));
2322 /*! \brief Helper function which converts from extension state to device state values */
2323 static int extensionstate2devicestate(int state)
2326 case AST_EXTENSION_NOT_INUSE:
2327 state = AST_DEVICE_NOT_INUSE;
2329 case AST_EXTENSION_INUSE:
2330 state = AST_DEVICE_INUSE;
2332 case AST_EXTENSION_BUSY:
2333 state = AST_DEVICE_BUSY;
2335 case AST_EXTENSION_RINGING:
2336 state = AST_DEVICE_RINGING;
2338 case AST_EXTENSION_ONHOLD:
2339 state = AST_DEVICE_ONHOLD;
2341 case AST_EXTENSION_UNAVAILABLE:
2342 state = AST_DEVICE_UNAVAILABLE;
2344 case AST_EXTENSION_REMOVED:
2345 case AST_EXTENSION_DEACTIVATED:
2347 state = AST_DEVICE_INVALID;
2354 static int extension_state_cb(char *context, char *exten, struct ast_state_cb_info *info, void *data)
2356 struct ao2_iterator miter, qiter;
2358 struct call_queue *q;
2359 int state = info->exten_state;
2360 int found = 0, device_state = extensionstate2devicestate(state);
2362 /* only interested in extension state updates involving device states */
2363 if (info->reason != AST_HINT_UPDATE_DEVICE) {
2367 qiter = ao2_iterator_init(queues, 0);
2368 while ((q = ao2_t_iterator_next(&qiter, "Iterate through queues"))) {
2371 miter = ao2_iterator_init(q->members, 0);
2372 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
2373 if (!strcmp(m->state_context, context) && !strcmp(m->state_exten, exten)) {
2374 update_status(q, m, device_state);
2380 ao2_iterator_destroy(&miter);
2383 queue_t_unref(q, "Done with iterator");
2385 ao2_iterator_destroy(&qiter);
2388 ast_debug(1, "Extension '%s@%s' changed to state '%d' (%s)\n", exten, context, device_state, ast_devstate2str(device_state));
2390 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",
2391 exten, context, device_state, ast_devstate2str(device_state));
2397 /*! \brief Return the current state of a member */
2398 static int get_queue_member_status(struct member *cur)
2400 return ast_strlen_zero(cur->state_exten) ? ast_device_state(cur->state_interface) : extensionstate2devicestate(ast_extension_state(NULL, cur->state_context, cur->state_exten));
2403 /*! \brief allocate space for new queue member and set fields based on parameters passed */
2404 static struct member *create_queue_member(const char *interface, const char *membername, int penalty, int paused, const char *state_interface, int ringinuse)
2408 if ((cur = ao2_alloc(sizeof(*cur), NULL))) {
2409 cur->ringinuse = ringinuse;
2410 cur->penalty = penalty;
2411 cur->paused = paused;
2412 ast_copy_string(cur->interface, interface, sizeof(cur->interface));
2413 if (!ast_strlen_zero(state_interface)) {
2414 ast_copy_string(cur->state_interface, state_interface, sizeof(cur->state_interface));
2416 ast_copy_string(cur->state_interface, interface, sizeof(cur->state_interface));
2418 if (!ast_strlen_zero(membername)) {
2419 ast_copy_string(cur->membername, membername, sizeof(cur->membername));
2421 ast_copy_string(cur->membername, interface, sizeof(cur->membername));
2423 if (!strchr(cur->interface, '/')) {
2424 ast_log(LOG_WARNING, "No location at interface '%s'\n", interface);
2426 if (!strncmp(cur->state_interface, "hint:", 5)) {
2427 char *tmp = ast_strdupa(cur->state_interface), *context = tmp;
2428 char *exten = strsep(&context, "@") + 5;
2430 ast_copy_string(cur->state_exten, exten, sizeof(cur->state_exten));
2431 ast_copy_string(cur->state_context, S_OR(context, "default"), sizeof(cur->state_context));
2433 cur->status = get_queue_member_status(cur);
2440 static int compress_char(const char c)
2444 } else if (c > 96) {
2450 static int member_hash_fn(const void *obj, const int flags)
2452 const struct member *mem = obj;
2453 const char *interface = (flags & OBJ_KEY) ? obj : mem->interface;
2454 const char *chname = strchr(interface, '/');
2460 for (i = 0; i < 5 && chname[i]; i++) {
2461 ret += compress_char(chname[i]) << (i * 6);
2466 static int member_cmp_fn(void *obj1, void *obj2, int flags)
2468 struct member *mem1 = obj1;
2469 struct member *mem2 = obj2;
2470 const char *interface = (flags & OBJ_KEY) ? obj2 : mem2->interface;
2472 return strcasecmp(mem1->interface, interface) ? 0 : CMP_MATCH | CMP_STOP;
2476 * \brief Initialize Queue default values.
2477 * \note the queue's lock must be held before executing this function
2479 static void init_queue(struct call_queue *q)
2482 struct penalty_rule *pr_iter;
2485 q->retry = DEFAULT_RETRY;
2486 q->timeout = DEFAULT_TIMEOUT;
2488 q->announcefrequency = 0;
2489 q->minannouncefrequency = DEFAULT_MIN_ANNOUNCE_FREQUENCY;
2490 q->announceholdtime = 1;
2491 q->announcepositionlimit = 10; /* Default 10 positions */
2492 q->announceposition = ANNOUNCEPOSITION_YES; /* Default yes */
2493 q->roundingseconds = 0; /* Default - don't announce seconds */
2494 q->servicelevel = 0;
2496 q->announce_to_first_user = 0;
2497 q->setinterfacevar = 0;
2499 q->setqueueentryvar = 0;
2500 q->autofill = autofill_default;
2501 q->montype = montype_default;
2502 q->monfmt[0] = '\0';
2503 q->reportholdtime = 0;
2505 q->penaltymemberslimit = 0;
2507 q->leavewhenempty = 0;
2510 q->timeoutrestart = 0;
2511 q->periodicannouncefrequency = 0;
2512 q->randomperiodicannounce = 0;
2513 q->numperiodicannounce = 0;
2514 q->autopause = QUEUE_AUTOPAUSE_OFF;
2515 q->timeoutpriority = TIMEOUT_PRIORITY_APP;
2516 q->autopausedelay = 0;
2518 if (q->strategy == QUEUE_STRATEGY_LINEAR || q->strategy == QUEUE_STRATEGY_RRORDERED) {
2519 /* linear strategy depends on order, so we have to place all members in a single bucket */
2520 q->members = ao2_container_alloc(1, member_hash_fn, member_cmp_fn);
2522 q->members = ao2_container_alloc(37, member_hash_fn, member_cmp_fn);
2527 ast_string_field_set(q, sound_next, "queue-youarenext");
2528 ast_string_field_set(q, sound_thereare, "queue-thereare");
2529 ast_string_field_set(q, sound_calls, "queue-callswaiting");
2530 ast_string_field_set(q, queue_quantity1, "queue-quantity1");
2531 ast_string_field_set(q, queue_quantity2, "queue-quantity2");
2532 ast_string_field_set(q, sound_holdtime, "queue-holdtime");
2533 ast_string_field_set(q, sound_minutes, "queue-minutes");
2534 ast_string_field_set(q, sound_minute, "queue-minute");
2535 ast_string_field_set(q, sound_seconds, "queue-seconds");
2536 ast_string_field_set(q, sound_thanks, "queue-thankyou");
2537 ast_string_field_set(q, sound_reporthold, "queue-reporthold");
2539 if (!q->sound_periodicannounce[0]) {
2540 q->sound_periodicannounce[0] = ast_str_create(32);
2543 if (q->sound_periodicannounce[0]) {
2544 ast_str_set(&q->sound_periodicannounce[0], 0, "queue-periodic-announce");
2547 for (i = 1; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) {
2548 if (q->sound_periodicannounce[i]) {
2549 ast_str_set(&q->sound_periodicannounce[i], 0, "%s", "");
2553 while ((pr_iter = AST_LIST_REMOVE_HEAD(&q->rules,list))) {
2557 /* On restart assume no members are available.
2558 * The queue_avail hint is a boolean state to indicate whether a member is available or not.
2560 * This seems counter intuitive, but is required to light a BLF
2561 * AST_DEVICE_INUSE indicates no members are available.
2562 * AST_DEVICE_NOT_INUSE indicates a member is available.
2564 ast_devstate_changed(AST_DEVICE_INUSE, AST_DEVSTATE_CACHABLE, "Queue:%s_avail", q->name);
2567 static void clear_queue(struct call_queue *q)
2570 q->callscompleted = 0;
2571 q->callsabandoned = 0;
2572 q->callscompletedinsl = 0;
2577 struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
2578 while ((mem = ao2_iterator_next(&mem_iter))) {
2583 ao2_iterator_destroy(&mem_iter);
2588 * \brief Change queue penalty by adding rule.
2590 * Check rule for errors with time or fomatting, see if rule is relative to rest
2591 * of queue, iterate list of rules to find correct insertion point, insert and return.
2592 * \retval -1 on failure
2593 * \retval 0 on success
2594 * \note Call this with the rule_lists locked
2596 static int insert_penaltychange(const char *list_name, const char *content, const int linenum)
2598 char *timestr, *maxstr, *minstr, *contentdup;
2599 struct penalty_rule *rule = NULL, *rule_iter;
2600 struct rule_list *rl_iter;
2601 int penaltychangetime, inserted = 0;
2603 if (!(rule = ast_calloc(1, sizeof(*rule)))) {
2607 contentdup = ast_strdupa(content);
2609 if (!(maxstr = strchr(contentdup, ','))) {
2610 ast_log(LOG_WARNING, "Improperly formatted penaltychange rule at line %d. Ignoring.\n", linenum);
2616 timestr = contentdup;
2618 if ((penaltychangetime = atoi(timestr)) < 0) {
2619 ast_log(LOG_WARNING, "Improper time parameter specified for penaltychange rule at line %d. Ignoring.\n", linenum);
2624 rule->time = penaltychangetime;
2626 if ((minstr = strchr(maxstr,','))) {
2630 /* The last check will evaluate true if either no penalty change is indicated for a given rule
2631 * OR if a min penalty change is indicated but no max penalty change is */
2632 if (*maxstr == '+' || *maxstr == '-' || *maxstr == '\0') {
2633 rule->max_relative = 1;
2636 rule->max_value = atoi(maxstr);
2638 if (!ast_strlen_zero(minstr)) {
2639 if (*minstr == '+' || *minstr == '-') {
2640 rule->min_relative = 1;
2642 rule->min_value = atoi(minstr);
2643 } else { /*there was no minimum specified, so assume this means no change*/
2644 rule->min_relative = 1;
2647 /*We have the rule made, now we need to insert it where it belongs*/
2648 AST_LIST_TRAVERSE(&rule_lists, rl_iter, list){
2649 if (strcasecmp(rl_iter->name, list_name)) {
2653 AST_LIST_TRAVERSE_SAFE_BEGIN(&rl_iter->rules, rule_iter, list) {
2654 if (rule->time < rule_iter->time) {
2655 AST_LIST_INSERT_BEFORE_CURRENT(rule, list);
2660 AST_LIST_TRAVERSE_SAFE_END;
2663 AST_LIST_INSERT_TAIL(&rl_iter->rules, rule, list);
2671 ast_log(LOG_WARNING, "Unknown rule list name %s; ignoring.\n", list_name);
2678 static void parse_empty_options(const char *value, enum empty_conditions *empty, int joinempty)
2680 char *value_copy = ast_strdupa(value);
2681 char *option = NULL;
2682 while ((option = strsep(&value_copy, ","))) {
2683 if (!strcasecmp(option, "paused")) {
2684 *empty |= QUEUE_EMPTY_PAUSED;
2685 } else if (!strcasecmp(option, "penalty")) {
2686 *empty |= QUEUE_EMPTY_PENALTY;
2687 } else if (!strcasecmp(option, "inuse")) {
2688 *empty |= QUEUE_EMPTY_INUSE;
2689 } else if (!strcasecmp(option, "ringing")) {
2690 *empty |= QUEUE_EMPTY_RINGING;
2691 } else if (!strcasecmp(option, "invalid")) {
2692 *empty |= QUEUE_EMPTY_INVALID;
2693 } else if (!strcasecmp(option, "wrapup")) {
2694 *empty |= QUEUE_EMPTY_WRAPUP;
2695 } else if (!strcasecmp(option, "unavailable")) {
2696 *empty |= QUEUE_EMPTY_UNAVAILABLE;
2697 } else if (!strcasecmp(option, "unknown")) {
2698 *empty |= QUEUE_EMPTY_UNKNOWN;
2699 } else if (!strcasecmp(option, "loose")) {
2700 *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID);
2701 } else if (!strcasecmp(option, "strict")) {
2702 *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED | QUEUE_EMPTY_UNAVAILABLE);
2703 } else if ((ast_false(option) && joinempty) || (ast_true(option) && !joinempty)) {
2704 *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED);
2705 } else if ((ast_false(option) && !joinempty) || (ast_true(option) && joinempty)) {
2708 ast_log(LOG_WARNING, "Unknown option %s for '%s'\n", option, joinempty ? "joinempty" : "leavewhenempty");
2713 /*! \brief Configure a queue parameter.
2715 * The failunknown flag is set for config files (and static realtime) to show
2716 * errors for unknown parameters. It is cleared for dynamic realtime to allow
2717 * extra fields in the tables.
2718 * \note For error reporting, line number is passed for .conf static configuration,
2719 * for Realtime queues, linenum is -1.
2721 static void queue_set_param(struct call_queue *q, const char *param, const char *val, int linenum, int failunknown)
2723 if (!strcasecmp(param, "musicclass") ||
2724 !strcasecmp(param, "music") || !strcasecmp(param, "musiconhold")) {
2725 ast_string_field_set(q, moh, val);
2726 } else if (!strcasecmp(param, "announce")) {
2727 ast_string_field_set(q, announce, val);
2728 } else if (!strcasecmp(param, "context")) {
2729 ast_string_field_set(q, context, val);
2730 } else if (!strcasecmp(param, "timeout")) {
2731 q->timeout = atoi(val);
2732 if (q->timeout < 0) {
2733 q->timeout = DEFAULT_TIMEOUT;
2735 } else if (!strcasecmp(param, "ringinuse")) {
2736 q->ringinuse = ast_true(val);
2737 } else if (!strcasecmp(param, "setinterfacevar")) {
2738 q->setinterfacevar = ast_true(val);
2739 } else if (!strcasecmp(param, "setqueuevar")) {
2740 q->setqueuevar = ast_true(val);
2741 } else if (!strcasecmp(param, "setqueueentryvar")) {
2742 q->setqueueentryvar = ast_true(val);
2743 } else if (!strcasecmp(param, "monitor-format")) {
2744 ast_copy_string(q->monfmt, val, sizeof(q->monfmt));
2745 } else if (!strcasecmp(param, "membermacro")) {
2746 ast_string_field_set(q, membermacro, val);
2747 } else if (!strcasecmp(param, "membergosub")) {
2748 ast_string_field_set(q, membergosub, val);
2749 } else if (!strcasecmp(param, "queue-youarenext")) {
2750 ast_string_field_set(q, sound_next, val);
2751 } else if (!strcasecmp(param, "queue-thereare")) {
2752 ast_string_field_set(q, sound_thereare, val);
2753 } else if (!strcasecmp(param, "queue-callswaiting")) {
2754 ast_string_field_set(q, sound_calls, val);
2755 } else if (!strcasecmp(param, "queue-quantity1")) {
2756 ast_string_field_set(q, queue_quantity1, val);
2757 } else if (!strcasecmp(param, "queue-quantity2")) {
2758 ast_string_field_set(q, queue_quantity2, val);
2759 } else if (!strcasecmp(param, "queue-holdtime")) {
2760 ast_string_field_set(q, sound_holdtime, val);
2761 } else if (!strcasecmp(param, "queue-minutes")) {
2762 ast_string_field_set(q, sound_minutes, val);
2763 } else if (!strcasecmp(param, "queue-minute")) {
2764 ast_string_field_set(q, sound_minute, val);
2765 } else if (!strcasecmp(param, "queue-seconds")) {
2766 ast_string_field_set(q, sound_seconds, val);
2767 } else if (!strcasecmp(param, "queue-thankyou")) {
2768 ast_string_field_set(q, sound_thanks, val);
2769 } else if (!strcasecmp(param, "queue-callerannounce")) {
2770 ast_string_field_set(q, sound_callerannounce, val);
2771 } else if (!strcasecmp(param, "queue-reporthold")) {
2772 ast_string_field_set(q, sound_reporthold, val);
2773 } else if (!strcasecmp(param, "announce-frequency")) {
2774 q->announcefrequency = atoi(val);
2775 } else if (!strcasecmp(param, "announce-to-first-user")) {
2776 q->announce_to_first_user = ast_true(val);
2777 } else if (!strcasecmp(param, "min-announce-frequency")) {
2778 q->minannouncefrequency = atoi(val);
2779 ast_debug(1, "%s=%s for queue '%s'\n", param, val, q->name);
2780 } else if (!strcasecmp(param, "announce-round-seconds")) {
2781 q->roundingseconds = atoi(val);
2782 /* Rounding to any other values just doesn't make sense... */
2783 if (!(q->roundingseconds == 0 || q->roundingseconds == 5 || q->roundingseconds == 10
2784 || q->roundingseconds == 15 || q->roundingseconds == 20 || q->roundingseconds == 30)) {
2786 ast_log(LOG_WARNING, "'%s' isn't a valid value for %s "
2787 "using 0 instead for queue '%s' at line %d of queues.conf\n",
2788 val, param, q->name, linenum);
2790 ast_log(LOG_WARNING, "'%s' isn't a valid value for %s "
2791 "using 0 instead for queue '%s'\n", val, param, q->name);
2793 q->roundingseconds=0;
2795 } else if (!strcasecmp(param, "announce-holdtime")) {
2796 if (!strcasecmp(val, "once")) {
2797 q->announceholdtime = ANNOUNCEHOLDTIME_ONCE;
2798 } else if (ast_true(val)) {
2799 q->announceholdtime = ANNOUNCEHOLDTIME_ALWAYS;
2801 q->announceholdtime = 0;
2803 } else if (!strcasecmp(param, "announce-position")) {
2804 if (!strcasecmp(val, "limit")) {
2805 q->announceposition = ANNOUNCEPOSITION_LIMIT;
2806 } else if (!strcasecmp(val, "more")) {
2807 q->announceposition = ANNOUNCEPOSITION_MORE_THAN;
2808 } else if (ast_true(val)) {
2809 q->announceposition = ANNOUNCEPOSITION_YES;
2811 q->announceposition = ANNOUNCEPOSITION_NO;
2813 } else if (!strcasecmp(param, "announce-position-limit")) {
2814 q->announcepositionlimit = atoi(val);
2815 } else if (!strcasecmp(param, "periodic-announce")) {
2816 if (strchr(val, ',')) {
2817 char *s, *buf = ast_strdupa(val);
2820 while ((s = strsep(&buf, ",|"))) {
2821 if (!q->sound_periodicannounce[i]) {
2822 q->sound_periodicannounce[i] = ast_str_create(16);
2824 ast_str_set(&q->sound_periodicannounce[i], 0, "%s", s);
2826 if (i == MAX_PERIODIC_ANNOUNCEMENTS) {
2830 q->numperiodicannounce = i;
2832 ast_str_set(&q->sound_periodicannounce[0], 0, "%s", val);
2833 q->numperiodicannounce = 1;
2835 } else if (!strcasecmp(param, "periodic-announce-frequency")) {
2836 q->periodicannouncefrequency = atoi(val);
2837 } else if (!strcasecmp(param, "relative-periodic-announce")) {
2838 q->relativeperiodicannounce = ast_true(val);
2839 } else if (!strcasecmp(param, "random-periodic-announce")) {
2840 q->randomperiodicannounce = ast_true(val);
2841 } else if (!strcasecmp(param, "retry")) {
2842 q->retry = atoi(val);
2843 if (q->retry <= 0) {
2844 q->retry = DEFAULT_RETRY;
2846 } else if (!strcasecmp(param, "wrapuptime")) {
2847 q->wrapuptime = atoi(val);
2848 } else if (!strcasecmp(param, "penaltymemberslimit")) {
2849 if ((sscanf(val, "%10d", &q->penaltymemberslimit) != 1)) {
2850 q->penaltymemberslimit = 0;
2852 } else if (!strcasecmp(param, "autofill")) {
2853 q->autofill = ast_true(val);
2854 } else if (!strcasecmp(param, "monitor-type")) {
2855 if (!strcasecmp(val, "mixmonitor")) {
2858 } else if (!strcasecmp(param, "autopause")) {
2859 q->autopause = autopause2int(val);
2860 } else if (!strcasecmp(param, "autopausedelay")) {
2861 q->autopausedelay = atoi(val);
2862 } else if (!strcasecmp(param, "autopausebusy")) {
2863 q->autopausebusy = ast_true(val);
2864 } else if (!strcasecmp(param, "autopauseunavail")) {
2865 q->autopauseunavail = ast_true(val);
2866 } else if (!strcasecmp(param, "maxlen")) {
2867 q->maxlen = atoi(val);
2868 if (q->maxlen < 0) {
2871 } else if (!strcasecmp(param, "servicelevel")) {
2872 q->servicelevel= atoi(val);
2873 } else if (!strcasecmp(param, "strategy")) {
2876 /* We are a static queue and already have set this, no need to do it again */
2880 strategy = strat2int(val);
2882 ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
2884 q->strategy = QUEUE_STRATEGY_RINGALL;
2886 if (strategy == q->strategy) {
2889 if (strategy == QUEUE_STRATEGY_LINEAR) {
2890 ast_log(LOG_WARNING, "Changing to the linear strategy currently requires asterisk to be restarted.\n");
2893 q->strategy = strategy;
2894 } else if (!strcasecmp(param, "joinempty")) {
2895 parse_empty_options(val, &q->joinempty, 1);
2896 } else if (!strcasecmp(param, "leavewhenempty")) {
2897 parse_empty_options(val, &q->leavewhenempty, 0);
2898 } else if (!strcasecmp(param, "reportholdtime")) {
2899 q->reportholdtime = ast_true(val);
2900 } else if (!strcasecmp(param, "memberdelay")) {
2901 q->memberdelay = atoi(val);
2902 } else if (!strcasecmp(param, "weight")) {
2903 q->weight = atoi(val);
2904 } else if (!strcasecmp(param, "timeoutrestart")) {
2905 q->timeoutrestart = ast_true(val);
2906 } else if (!strcasecmp(param, "defaultrule")) {
2907 ast_string_field_set(q, defaultrule, val);
2908 } else if (!strcasecmp(param, "timeoutpriority")) {
2909 if (!strcasecmp(val, "conf")) {
2910 q->timeoutpriority = TIMEOUT_PRIORITY_CONF;
2912 q->timeoutpriority = TIMEOUT_PRIORITY_APP;
2914 } else if (failunknown) {
2916 ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s at line %d of queues.conf\n",
2917 q->name, param, linenum);
2919 ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s\n", q->name, param);
2925 #define QUEUE_PAUSED_DEVSTATE AST_DEVICE_INUSE
2926 #define QUEUE_UNPAUSED_DEVSTATE AST_DEVICE_NOT_INUSE
2927 #define QUEUE_UNKNOWN_PAUSED_DEVSTATE AST_DEVICE_NOT_INUSE
2930 * \brief If adding a single new member to a queue, use this function instead of ao2_linking.
2931 * This adds round robin queue position data for a fresh member as well as links it.
2932 * \param queue Which queue the member is being added to
2933 * \param mem Which member is being added to the queue
2935 static void member_add_to_queue(struct call_queue *queue, struct member *mem)
2937 ao2_lock(queue->members);
2938 mem->queuepos = ao2_container_count(queue->members);
2939 ao2_link(queue->members, mem);
2940 ast_devstate_changed(mem->paused ? QUEUE_PAUSED_DEVSTATE : QUEUE_UNPAUSED_DEVSTATE,
2941 AST_DEVSTATE_CACHABLE, "Queue:%s_pause_%s", queue->name, mem->interface);
2942 ao2_unlock(queue->members);
2946 * \brief If removing a single member from a queue, use this function instead of ao2_unlinking.
2947 * This will perform round robin queue position reordering for the remaining members.
2948 * \param queue Which queue the member is being removed from
2949 * \param member Which member is being removed from the queue
2951 static void member_remove_from_queue(struct call_queue *queue, struct member *mem)
2953 ao2_lock(queue->members);
2954 ast_devstate_changed(QUEUE_UNKNOWN_PAUSED_DEVSTATE, AST_DEVSTATE_CACHABLE, "Queue:%s_pause_%s", queue->name, mem->interface);
2955 queue_member_follower_removal(queue, mem);
2956 ao2_unlink(queue->members, mem);
2957 ao2_unlock(queue->members);
2961 * \brief Find rt member record to update otherwise create one.
2963 * Search for member in queue, if found update penalty/paused state,
2964 * if no member exists create one flag it as a RT member and add to queue member list.
2966 static void rt_handle_member_record(struct call_queue *q, char *interface, struct ast_config *member_config)
2969 struct ao2_iterator mem_iter;
2973 int ringinuse = q->ringinuse;
2975 const char *config_val;
2976 const char *rt_uniqueid = ast_variable_retrieve(member_config, interface, "uniqueid");
2977 const char *membername = S_OR(ast_variable_retrieve(member_config, interface, "membername"), interface);
2978 const char *state_interface = S_OR(ast_variable_retrieve(member_config, interface, "state_interface"), interface);
2979 const char *penalty_str = ast_variable_retrieve(member_config, interface, "penalty");
2980 const char *paused_str = ast_variable_retrieve(member_config, interface, "paused");
2982 if (ast_strlen_zero(rt_uniqueid)) {
2983 ast_log(LOG_WARNING, "Realtime field uniqueid is empty for member %s\n", S_OR(membername, "NULL"));
2988 penalty = atoi(penalty_str);
2989 if ((penalty < 0) && negative_penalty_invalid) {
2991 } else if (penalty < 0) {
2997 paused = atoi(paused_str);
3003 if ((config_val = ast_variable_retrieve(member_config, interface, realtime_ringinuse_field))) {
3004 if (ast_true(config_val)) {
3006 } else if (ast_false(config_val)) {
3009 ast_log(LOG_WARNING, "Invalid value of '%s' field for %s in queue '%s'\n", realtime_ringinuse_field, interface, q->name);
3013 /* Find member by realtime uniqueid and update */
3014 mem_iter = ao2_iterator_init(q->members, 0);
3015 while ((m = ao2_iterator_next(&mem_iter))) {
3016 if (!strcasecmp(m->rt_uniqueid, rt_uniqueid)) {
3017 m->dead = 0; /* Do not delete this one. */
3018 ast_copy_string(m->rt_uniqueid, rt_uniqueid, sizeof(m->rt_uniqueid));
3021 ast_devstate_changed(m->paused ? QUEUE_PAUSED_DEVSTATE : QUEUE_UNPAUSED_DEVSTATE,
3022 AST_DEVSTATE_CACHABLE, "Queue:%s_pause_%s", q->name, m->interface);
3024 if (strcasecmp(state_interface, m->state_interface)) {
3025 ast_copy_string(m->state_interface, state_interface, sizeof(m->state_interface));
3027 m->penalty = penalty;
3028 m->ringinuse = ringinuse;
3035 ao2_iterator_destroy(&mem_iter);
3037 /* Create a new member */
3039 if ((m = create_queue_member(interface, membername, penalty, paused, state_interface, ringinuse))) {
3042 ast_copy_string(m->rt_uniqueid, rt_uniqueid, sizeof(m->rt_uniqueid));
3043 if (!log_membername_as_agent) {
3044 ast_queue_log(q->name, "REALTIME", m->interface, "ADDMEMBER", "%s", paused ? "PAUSED" : "");
3046 ast_queue_log(q->name, "REALTIME", m->membername, "ADDMEMBER", "%s", paused ? "PAUSED" : "");
3048 member_add_to_queue(q, m);
3055 /*! \brief Iterate through queue's member list and delete them */
3056 static void free_members(struct call_queue *q, int all)
3058 /* Free non-dynamic members */
3060 struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
3062 while ((cur = ao2_iterator_next(&mem_iter))) {
3063 if (all || !cur->dynamic) {
3064 member_remove_from_queue(q, cur);
3068 ao2_iterator_destroy(&mem_iter);
3071 /*! \brief Free queue's member list then its string fields */
3072 static void destroy_queue(void *obj)
3074 struct call_queue *q = obj;
3078 ast_string_field_free_memory(q);
3079 for (i = 0; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) {
3080 if (q->sound_periodicannounce[i]) {
3081 free(q->sound_periodicannounce[i]);
3084 ao2_ref(q->members, -1);
3087 static struct call_queue *alloc_queue(const char *queuename)
3089 struct call_queue *q;
3091 if ((q = ao2_t_alloc(sizeof(*q), destroy_queue, "Allocate queue"))) {
3092 if (ast_string_field_init(q, 64)) {
3093 queue_t_unref(q, "String field allocation failed");
3096 ast_string_field_set(q, name, queuename);
3102 * \brief Reload a single queue via realtime.
3104 * Check for statically defined queue first, check if deleted RT queue,
3105 * check for new RT queue, if queue vars are not defined init them with defaults.
3106 * reload RT queue vars, set RT queue members dead and reload them, return finished queue.
3107 * \retval the queue,
3108 * \retval NULL if it doesn't exist.
3109 * \note Should be called with the "queues" container locked.
3111 static struct call_queue *find_queue_by_name_rt(const char *queuename, struct ast_variable *queue_vars, struct ast_config *member_config)
3113 struct ast_variable *v;
3114 struct call_queue *q, tmpq = {
3118 struct ao2_iterator mem_iter;
3119 char *interface = NULL;
3120 const char *tmp_name;
3122 char tmpbuf[64]; /* Must be longer than the longest queue param name. */
3124 /* Static queues override realtime. */
3125 if ((q = ao2_t_find(queues, &tmpq, OBJ_POINTER, "Check if static queue exists"))) {
3130 queue_t_unref(q, "Queue is dead; can't return it");
3133 ast_log(LOG_WARNING, "Static queue '%s' already exists. Not loading from realtime\n", q->name);
3137 } else if (!member_config) {
3138 /* Not found in the list, and it's not realtime ... */
3141 /* Check if queue is defined in realtime. */
3143 /* Delete queue from in-core list if it has been deleted in realtime. */
3145 /*! \note Hmm, can't seem to distinguish a DB failure from a not
3146 found condition... So we might delete an in-core queue
3147 in case of DB failure. */
3148 ast_debug(1, "Queue %s not found in realtime.\n", queuename);
3151 /* Delete if unused (else will be deleted when last caller leaves). */
3152 queues_t_unlink(queues, q, "Unused; removing from container");
3154 queue_t_unref(q, "Queue is dead; can't return it");
3159 /* Create a new queue if an in-core entry does not exist yet. */
3161 struct ast_variable *tmpvar = NULL;
3162 if (!(q = alloc_queue(queuename))) {
3168 /*Before we initialize the queue, we need to set the strategy, so that linear strategy
3169 * will allocate the members properly
3171 for (tmpvar = queue_vars; tmpvar; tmpvar = tmpvar->next) {
3172 if (!strcasecmp(tmpvar->name, "strategy")) {
3173 q->strategy = strat2int(tmpvar->value);
3174 if (q->strategy < 0) {
3175 ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
3176 tmpvar->value, q->name);
3177 q->strategy = QUEUE_STRATEGY_RINGALL;
3182 /* We traversed all variables and didn't find a strategy */
3184 q->strategy = QUEUE_STRATEGY_RINGALL;
3186 queues_t_link(queues, q, "Add queue to container");
3188 init_queue(q); /* Ensure defaults for all parameters not set explicitly. */
3190 memset(tmpbuf, 0, sizeof(tmpbuf));
3191 for (v = queue_vars; v; v = v->next) {
3192 /* Convert to dashes `-' from underscores `_' as the latter are more SQL friendly. */
3193 if (strchr(v->name, '_')) {
3194 ast_copy_string(tmpbuf, v->name, sizeof(tmpbuf));
3197 while ((tmp = strchr(tmp, '_'))) {
3204 /* NULL values don't get returned from realtime; blank values should
3205 * still get set. If someone doesn't want a value to be set, they
3206 * should set the realtime column to NULL, not blank. */
3207 queue_set_param(q, tmp_name, v->value, -1, 0);
3210 /* Temporarily set realtime members dead so we can detect deleted ones. */
3211 mem_iter = ao2_iterator_init(q->members, 0);
3212 while ((m = ao2_iterator_next(&mem_iter))) {
3218 ao2_iterator_destroy(&mem_iter);
3220 while ((interface = ast_category_browse(member_config, interface))) {
3221 rt_handle_member_record(q, interface, member_config);
3224 /* Delete all realtime members that have been deleted in DB. */
3225 mem_iter = ao2_iterator_init(q->members, 0);
3226 while ((m = ao2_iterator_next(&mem_iter))) {
3228 if (ast_strlen_zero(m->membername) || !log_membername_as_agent) {
3229 ast_queue_log(q->name, "REALTIME", m->interface, "REMOVEMEMBER", "%s", "");
3231 ast_queue_log(q->name, "REALTIME", m->membername, "REMOVEMEMBER", "%s", "");
3233 member_remove_from_queue(q, m);
3237 ao2_iterator_destroy(&mem_iter);
3249 * \brief Returns reference to the named queue. If the queue is realtime, it will load the queue as well.
3250 * \param queuename - name of the desired queue
3253 * \retval NULL if it doesn't exist
3255 static struct call_queue *find_load_queue_rt_friendly(const char *queuename)
3257 struct ast_variable *queue_vars;
3258 struct ast_config *member_config = NULL;
3259 struct call_queue *q = NULL, tmpq = {
3262 int prev_weight = 0;
3264 /* Find the queue in the in-core list first. */
3265 q = ao2_t_find(queues, &tmpq, OBJ_POINTER, "Look for queue in memory first");
3267 if (!q || q->realtime) {
3268 /*! \note Load from realtime before taking the "queues" container lock, to avoid blocking all
3269 queue operations while waiting for the DB.
3271 This will be two separate database transactions, so we might
3272 see queue parameters as they were before another process
3273 changed the queue and member list as it was after the change.
3274 Thus we might see an empty member list when a queue is
3275 deleted. In practise, this is unlikely to cause a problem. */
3277 queue_vars = ast_load_realtime("queues", "name", queuename, SENTINEL);
3279 member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", queuename, SENTINEL);
3280 if (!member_config) {
3281 ast_debug(1, "No queue_members defined in config extconfig.conf\n");
3282 member_config = ast_config_new();
3286 prev_weight = q->weight ? 1 : 0;
3287 queue_t_unref(q, "Need to find realtime queue");
3290 q = find_queue_by_name_rt(queuename, queue_vars, member_config);
projects / asterisk/asterisk.git / blob