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 called party's channel (the queue member) once the parties are connected.</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">
739 <para>Show queues information.</para>
742 <manager name="QueueStatus" language="en_US">
747 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
748 <parameter name="Queue">
749 <para>Limit the response to the status of the specified queue.</para>
751 <parameter name="Member">
752 <para>Limit the response to the status of the specified member.</para>
756 <para>Check the status of one or more queues.</para>
759 <manager name="QueueSummary" language="en_US">
764 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
765 <parameter name="Queue">
766 <para>Queue for which the summary is requested.</para>
770 <para>Request the manager to send a QueueSummary event.</para>
773 <manager name="QueueAdd" language="en_US">
775 Add interface to queue.
778 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
779 <parameter name="Queue" required="true">
780 <para>Queue's name.</para>
782 <parameter name="Interface" required="true">
783 <para>The name of the interface (tech/name) to add to the queue.</para>
785 <parameter name="Penalty">
786 <para>A penalty (number) to apply to this member. Asterisk will distribute calls to members with higher penalties only after attempting to distribute calls to those with lower penalty.</para>
788 <parameter name="Paused">
789 <para>To pause or not the member initially (true/false or 1/0).</para>
791 <parameter name="MemberName">
792 <para>Text alias for the interface.</para>
794 <parameter name="StateInterface" />
799 <manager name="QueueRemove" language="en_US">
801 Remove interface from queue.
804 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
805 <parameter name="Queue" required="true">
806 <para>The name of the queue to take action on.</para>
808 <parameter name="Interface" required="true">
809 <para>The interface (tech/name) to remove from queue.</para>
815 <manager name="QueuePause" language="en_US">
817 Makes a queue member temporarily unavailable.
820 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
821 <parameter name="Interface" required="true">
822 <para>The name of the interface (tech/name) to pause or unpause.</para>
824 <parameter name="Paused" required="true">
825 <para>Pause or unpause the interface. Set to 'true' to pause the member or 'false' to unpause.</para>
827 <parameter name="Queue">
828 <para>The name of the queue in which to pause or unpause this member. If not specified, the member will be paused or unpaused in all the queues it is a member of.</para>
830 <parameter name="Reason">
831 <para>Text description, returned in the event QueueMemberPaused.</para>
835 <para>Pause or unpause a member in a queue.</para>
838 <manager name="QueueLog" language="en_US">
840 Adds custom entry in queue_log.
843 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
844 <parameter name="Queue" required="true" />
845 <parameter name="Event" required="true" />
846 <parameter name="Uniqueid" />
847 <parameter name="Interface" />
848 <parameter name="Message" />
853 <manager name="QueuePenalty" language="en_US">
855 Set the penalty for a queue member.
858 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
859 <parameter name="Interface" required="true">
860 <para>The interface (tech/name) of the member whose penalty to change.</para>
862 <parameter name="Penalty" required="true">
863 <para>The new penalty (number) for the member. Must be nonnegative.</para>
865 <parameter name="Queue">
866 <para>If specified, only set the penalty for the member of this queue. Otherwise, set the penalty for the member in all queues to which the member belongs.</para>
870 <para>Change the penalty of a queue member</para>
873 <manager name="QueueMemberRingInUse" language="en_US">
875 Set the ringinuse value for a queue member.
878 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
879 <parameter name="Interface" required="true" />
880 <parameter name="RingInUse" required="true" />
881 <parameter name="Queue" />
886 <manager name="QueueRule" language="en_US">
891 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
892 <parameter name="Rule">
893 <para>The name of the rule in queuerules.conf whose contents to list.</para>
897 <para>List queue rules defined in queuerules.conf</para>
900 <manager name="QueueReload" language="en_US">
902 Reload a queue, queues, or any sub-section of a queue or queues.
905 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
906 <parameter name="Queue">
907 <para>The name of the queue to take action on. If no queue name is specified, then all queues are affected.</para>
909 <parameter name="Members">
910 <para>Whether to reload the queue's members.</para>
916 <parameter name="Rules">
917 <para>Whether to reload queuerules.conf</para>
923 <parameter name="Parameters">
924 <para>Whether to reload the other queue options.</para>
934 <manager name="QueueReset" language="en_US">
936 Reset queue statistics.
939 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
940 <parameter name="Queue">
941 <para>The name of the queue on which to reset statistics.</para>
945 <para>Reset the statistics for a queue.</para>
949 <managerEvent language="en_US" name="QueueMemberStatus">
950 <managerEventInstance class="EVENT_FLAG_AGENT">
951 <synopsis>Raised when a Queue member's status has changed.</synopsis>
953 <parameter name="Queue">
954 <para>The name of the queue.</para>
956 <parameter name="MemberName">
957 <para>The name of the queue member.</para>
959 <parameter name="Interface">
960 <para>The queue member's channel technology or location.</para>
962 <parameter name="StateInterface">
963 <para>Channel technology or location from which to read device state changes.</para>
965 <parameter name="Membership">
967 <enum name="dynamic"/>
968 <enum name="realtime"/>
969 <enum name="static"/>
972 <parameter name="Penalty">
973 <para>The penalty associated with the queue member.</para>
975 <parameter name="CallsTaken">
976 <para>The number of calls this queue member has serviced.</para>
978 <parameter name="LastCall">
979 <para>The time this member last took a call, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
981 <parameter name="Status">
982 <para>The numeric device state status of the queue member.</para>
984 <enum name="0"><para>AST_DEVICE_UNKNOWN</para></enum>
985 <enum name="1"><para>AST_DEVICE_NOT_INUSE</para></enum>
986 <enum name="2"><para>AST_DEVICE_INUSE</para></enum>
987 <enum name="3"><para>AST_DEVICE_BUSY</para></enum>
988 <enum name="4"><para>AST_DEVICE_INVALID</para></enum>
989 <enum name="5"><para>AST_DEVICE_UNAVAILABLE</para></enum>
990 <enum name="6"><para>AST_DEVICE_RINGING</para></enum>
991 <enum name="7"><para>AST_DEVICE_RINGINUSE</para></enum>
992 <enum name="8"><para>AST_DEVICE_ONHOLD</para></enum>
995 <parameter name="Paused">
1001 <parameter name="Ringinuse">
1008 </managerEventInstance>
1010 <managerEvent language="en_US" name="QueueMemberAdded">
1011 <managerEventInstance class="EVENT_FLAG_AGENT">
1012 <synopsis>Raised when a member is added to the queue.</synopsis>
1014 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
1017 <ref type="managerEvent">QueueMemberRemoved</ref>
1018 <ref type="application">AddQueueMember</ref>
1020 </managerEventInstance>
1022 <managerEvent language="en_US" name="QueueMemberRemoved">
1023 <managerEventInstance class="EVENT_FLAG_AGENT">
1024 <synopsis>Raised when a member is removed from the queue.</synopsis>
1026 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
1029 <ref type="managerEvent">QueueMemberAdded</ref>
1030 <ref type="application">RemoveQueueMember</ref>
1032 </managerEventInstance>
1034 <managerEvent language="en_US" name="QueueMemberPause">
1035 <managerEventInstance class="EVENT_FLAG_AGENT">
1036 <synopsis>Raised when a member is paused/unpaused in the queue.</synopsis>
1038 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
1039 <parameter name="Reason">
1040 <para>The reason a member was paused.</para>
1044 <ref type="application">PauseQueueMember</ref>
1045 <ref type="application">UnPauseQueueMember</ref>
1047 </managerEventInstance>
1049 <managerEvent language="en_US" name="QueueMemberPenalty">
1050 <managerEventInstance class="EVENT_FLAG_AGENT">
1051 <synopsis>Raised when a member's penalty is changed.</synopsis>
1053 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
1056 <ref type="function">QUEUE_MEMBER</ref>
1058 </managerEventInstance>
1060 <managerEvent language="en_US" name="QueueMemberRinginuse">
1061 <managerEventInstance class="EVENT_FLAG_AGENT">
1062 <synopsis>Raised when a member's ringinuse setting is changed.</synopsis>
1064 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
1067 <ref type="function">QUEUE_MEMBER</ref>
1069 </managerEventInstance>
1071 <managerEvent language="en_US" name="QueueCallerJoin">
1072 <managerEventInstance class="EVENT_FLAG_AGENT">
1073 <synopsis>Raised when a caller joins a Queue.</synopsis>
1076 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1077 <parameter name="Position">
1078 <para>This channel's current position in the queue.</para>
1080 <parameter name="Count">
1081 <para>The total number of channels in the queue.</para>
1085 <ref type="managerEvent">QueueCallerLeave</ref>
1086 <ref type="application">Queue</ref>
1088 </managerEventInstance>
1090 <managerEvent language="en_US" name="QueueCallerLeave">
1091 <managerEventInstance class="EVENT_FLAG_AGENT">
1092 <synopsis>Raised when a caller leaves a Queue.</synopsis>
1095 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1096 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerJoin']/managerEventInstance/syntax/parameter[@name='Count'])" />
1097 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerJoin']/managerEventInstance/syntax/parameter[@name='Position'])" />
1100 <ref type="managerEvent">QueueCallerJoin</ref>
1102 </managerEventInstance>
1104 <managerEvent language="en_US" name="QueueCallerAbandon">
1105 <managerEventInstance class="EVENT_FLAG_AGENT">
1106 <synopsis>Raised when a caller abandons the queue.</synopsis>
1109 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1110 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerJoin']/managerEventInstance/syntax/parameter[@name='Position'])" />
1111 <parameter name="OriginalPosition">
1112 <para>The channel's original position in the queue.</para>
1114 <parameter name="HoldTime">
1115 <para>The time the channel was in the queue, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
1118 </managerEventInstance>
1120 <managerEvent language="en_US" name="AgentCalled">
1121 <managerEventInstance class="EVENT_FLAG_AGENT">
1122 <synopsis>Raised when an queue member is notified of a caller in the queue.</synopsis>
1125 <channel_snapshot prefix="Dest"/>
1126 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1127 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
1128 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
1131 <ref type="managerEvent">AgentRingNoAnswer</ref>
1132 <ref type="managerEvent">AgentComplete</ref>
1133 <ref type="managerEvent">AgentConnect</ref>
1135 </managerEventInstance>
1137 <managerEvent language="en_US" name="AgentRingNoAnswer">
1138 <managerEventInstance class="EVENT_FLAG_AGENT">
1139 <synopsis>Raised when a queue member is notified of a caller in the queue and fails to answer.</synopsis>
1142 <channel_snapshot prefix="Dest"/>
1143 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1144 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
1145 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
1146 <parameter name="RingTime">
1147 <para>The time the queue member was rung, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
1151 <ref type="managerEvent">AgentCalled</ref>
1153 </managerEventInstance>
1155 <managerEvent language="en_US" name="AgentComplete">
1156 <managerEventInstance class="EVENT_FLAG_AGENT">
1157 <synopsis>Raised when a queue member has finished servicing a caller in the queue.</synopsis>
1160 <channel_snapshot prefix="Dest"/>
1161 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1162 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
1163 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
1164 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerAbandon']/managerEventInstance/syntax/parameter[@name='HoldTime'])" />
1165 <parameter name="TalkTime">
1166 <para>The time the queue member talked with the caller in the queue, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
1168 <parameter name="Reason">
1170 <enum name="caller"/>
1171 <enum name="agent"/>
1172 <enum name="transfer"/>
1177 <ref type="managerEvent">AgentCalled</ref>
1178 <ref type="managerEvent">AgentConnect</ref>
1180 </managerEventInstance>
1182 <managerEvent language="en_US" name="AgentDump">
1183 <managerEventInstance class="EVENT_FLAG_AGENT">
1184 <synopsis>Raised when a queue member hangs up on a caller in the queue.</synopsis>
1187 <channel_snapshot prefix="Dest"/>
1188 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1189 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
1190 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
1193 <ref type="managerEvent">AgentCalled</ref>
1194 <ref type="managerEvent">AgentConnect</ref>
1196 </managerEventInstance>
1198 <managerEvent language="en_US" name="AgentConnect">
1199 <managerEventInstance class="EVENT_FLAG_AGENT">
1200 <synopsis>Raised when a queue member answers and is bridged to a caller in the queue.</synopsis>
1203 <channel_snapshot prefix="Dest"/>
1204 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
1205 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
1206 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
1207 <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentRingNoAnswer']/managerEventInstance/syntax/parameter[@name='RingTime'])" />
1208 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerAbandon']/managerEventInstance/syntax/parameter[@name='HoldTime'])" />
1211 <ref type="managerEvent">AgentCalled</ref>
1212 <ref type="managerEvent">AgentComplete</ref>
1213 <ref type="managerEvent">AgentDump</ref>
1215 </managerEventInstance>
1220 OPT_MARK_AS_ANSWERED = (1 << 0),
1221 OPT_GO_ON = (1 << 1),
1222 OPT_DATA_QUALITY = (1 << 2),
1223 OPT_CALLEE_GO_ON = (1 << 3),
1224 OPT_CALLEE_HANGUP = (1 << 4),
1225 OPT_CALLER_HANGUP = (1 << 5),
1226 OPT_IGNORE_CALL_FW = (1 << 6),
1227 OPT_IGNORE_CONNECTEDLINE = (1 << 7),
1228 OPT_CALLEE_PARK = (1 << 8),
1229 OPT_CALLER_PARK = (1 << 9),
1230 OPT_NO_RETRY = (1 << 10),
1231 OPT_RINGING = (1 << 11),
1232 OPT_RING_WHEN_RINGING = (1 << 12),
1233 OPT_CALLEE_TRANSFER = (1 << 13),
1234 OPT_CALLER_TRANSFER = (1 << 14),
1235 OPT_CALLEE_AUTOMIXMON = (1 << 15),
1236 OPT_CALLER_AUTOMIXMON = (1 << 16),
1237 OPT_CALLEE_AUTOMON = (1 << 17),
1238 OPT_CALLER_AUTOMON = (1 << 18),
1242 OPT_ARG_CALLEE_GO_ON = 0,
1243 /* note: this entry _MUST_ be the last one in the enum */
1247 AST_APP_OPTIONS(queue_exec_options, BEGIN_OPTIONS
1248 AST_APP_OPTION('C', OPT_MARK_AS_ANSWERED),
1249 AST_APP_OPTION('c', OPT_GO_ON),
1250 AST_APP_OPTION('d', OPT_DATA_QUALITY),
1251 AST_APP_OPTION_ARG('F', OPT_CALLEE_GO_ON, OPT_ARG_CALLEE_GO_ON),
1252 AST_APP_OPTION('h', OPT_CALLEE_HANGUP),
1253 AST_APP_OPTION('H', OPT_CALLER_HANGUP),
1254 AST_APP_OPTION('i', OPT_IGNORE_CALL_FW),
1255 AST_APP_OPTION('I', OPT_IGNORE_CONNECTEDLINE),
1256 AST_APP_OPTION('k', OPT_CALLEE_PARK),
1257 AST_APP_OPTION('K', OPT_CALLER_PARK),
1258 AST_APP_OPTION('n', OPT_NO_RETRY),
1259 AST_APP_OPTION('r', OPT_RINGING),
1260 AST_APP_OPTION('R', OPT_RING_WHEN_RINGING),
1261 AST_APP_OPTION('t', OPT_CALLEE_TRANSFER),
1262 AST_APP_OPTION('T', OPT_CALLER_TRANSFER),
1263 AST_APP_OPTION('x', OPT_CALLEE_AUTOMIXMON),
1264 AST_APP_OPTION('X', OPT_CALLER_AUTOMIXMON),
1265 AST_APP_OPTION('w', OPT_CALLEE_AUTOMON),
1266 AST_APP_OPTION('W', OPT_CALLER_AUTOMON),
1270 QUEUE_STRATEGY_RINGALL = 0,
1271 QUEUE_STRATEGY_LEASTRECENT,
1272 QUEUE_STRATEGY_FEWESTCALLS,
1273 QUEUE_STRATEGY_RANDOM,
1274 QUEUE_STRATEGY_RRMEMORY,
1275 QUEUE_STRATEGY_LINEAR,
1276 QUEUE_STRATEGY_WRANDOM,
1277 QUEUE_STRATEGY_RRORDERED,
1281 QUEUE_AUTOPAUSE_OFF = 0,
1286 enum queue_reload_mask {
1287 QUEUE_RELOAD_PARAMETERS = (1 << 0),
1288 QUEUE_RELOAD_MEMBER = (1 << 1),
1289 QUEUE_RELOAD_RULES = (1 << 2),
1290 QUEUE_RESET_STATS = (1 << 3),
1293 static const struct strategy {
1297 { QUEUE_STRATEGY_RINGALL, "ringall" },
1298 { QUEUE_STRATEGY_LEASTRECENT, "leastrecent" },
1299 { QUEUE_STRATEGY_FEWESTCALLS, "fewestcalls" },
1300 { QUEUE_STRATEGY_RANDOM, "random" },
1301 { QUEUE_STRATEGY_RRMEMORY, "rrmemory" },
1302 { QUEUE_STRATEGY_RRMEMORY, "roundrobin" },
1303 { QUEUE_STRATEGY_LINEAR, "linear" },
1304 { QUEUE_STRATEGY_WRANDOM, "wrandom"},
1305 { QUEUE_STRATEGY_RRORDERED, "rrordered"},
1308 static const struct autopause {
1311 } autopausesmodes [] = {
1312 { QUEUE_AUTOPAUSE_OFF,"no" },
1313 { QUEUE_AUTOPAUSE_ON, "yes" },
1314 { QUEUE_AUTOPAUSE_ALL,"all" },
1317 #define DEFAULT_RETRY 5
1318 #define DEFAULT_TIMEOUT 15
1319 #define RECHECK 1 /*!< Recheck every second to see we we're at the top yet */
1320 #define MAX_PERIODIC_ANNOUNCEMENTS 10 /*!< The maximum periodic announcements we can have */
1322 * \brief The minimum number of seconds between position announcements.
1323 * \note The default value of 15 provides backwards compatibility.
1325 #define DEFAULT_MIN_ANNOUNCE_FREQUENCY 15
1327 #define MAX_QUEUE_BUCKETS 53
1329 #define RES_OKAY 0 /*!< Action completed */
1330 #define RES_EXISTS (-1) /*!< Entry already exists */
1331 #define RES_OUTOFMEMORY (-2) /*!< Out of memory */
1332 #define RES_NOSUCHQUEUE (-3) /*!< No such queue */
1333 #define RES_NOT_DYNAMIC (-4) /*!< Member is not dynamic */
1335 static char *app = "Queue";
1337 static char *app_aqm = "AddQueueMember" ;
1339 static char *app_rqm = "RemoveQueueMember" ;
1341 static char *app_pqm = "PauseQueueMember" ;
1343 static char *app_upqm = "UnpauseQueueMember" ;
1345 static char *app_ql = "QueueLog" ;
1347 /*! \brief Persistent Members astdb family */
1348 static const char * const pm_family = "Queue/PersistentMembers";
1350 /*! \brief queues.conf [general] option */
1351 static int queue_persistent_members = 0;
1353 /*! \brief queues.conf per-queue weight option */
1354 static int use_weight = 0;
1356 /*! \brief queues.conf [general] option */
1357 static int autofill_default = 1;
1359 /*! \brief queues.conf [general] option */
1360 static int montype_default = 0;
1362 /*! \brief queues.conf [general] option */
1363 static int shared_lastcall = 1;
1365 /*! \brief queuesrules.conf [general] option */
1366 static int realtime_rules = 0;
1368 /*! \brief Subscription to device state change messages */
1369 static struct stasis_subscription *device_state_sub;
1371 /*! \brief queues.conf [general] option */
1372 static int update_cdr = 0;
1374 /*! \brief queues.conf [general] option */
1375 static int negative_penalty_invalid = 0;
1377 /*! \brief queues.conf [general] option */
1378 static int log_membername_as_agent = 0;
1380 /*! \brief name of the ringinuse field in the realtime database */
1381 static char *realtime_ringinuse_field;
1386 QUEUE_JOINEMPTY = 2,
1387 QUEUE_LEAVEEMPTY = 3,
1388 QUEUE_JOINUNAVAIL = 4,
1389 QUEUE_LEAVEUNAVAIL = 5,
1394 static const struct {
1395 enum queue_result id;
1397 } queue_results[] = {
1398 { QUEUE_UNKNOWN, "UNKNOWN" },
1399 { QUEUE_TIMEOUT, "TIMEOUT" },
1400 { QUEUE_JOINEMPTY,"JOINEMPTY" },
1401 { QUEUE_LEAVEEMPTY, "LEAVEEMPTY" },
1402 { QUEUE_JOINUNAVAIL, "JOINUNAVAIL" },
1403 { QUEUE_LEAVEUNAVAIL, "LEAVEUNAVAIL" },
1404 { QUEUE_FULL, "FULL" },
1405 { QUEUE_CONTINUE, "CONTINUE" },
1408 enum queue_timeout_priority {
1409 TIMEOUT_PRIORITY_APP,
1410 TIMEOUT_PRIORITY_CONF,
1413 /*! \brief We define a custom "local user" structure because we
1414 * use it not only for keeping track of what is in use but
1415 * also for keeping track of who we're dialing.
1417 * There are two "links" defined in this structure, q_next and call_next.
1418 * q_next links ALL defined callattempt structures into a linked list. call_next is
1419 * a link which allows for a subset of the callattempts to be traversed. This subset
1420 * is used in wait_for_answer so that irrelevant callattempts are not traversed. This
1421 * also is helpful so that queue logs are always accurate in the case where a call to
1422 * a member times out, especially if using the ringall strategy.
1425 struct callattempt {
1426 struct callattempt *q_next;
1427 struct callattempt *call_next;
1428 struct ast_channel *chan;
1429 char interface[256]; /*!< An Asterisk dial string (not a channel name) */
1432 struct call_queue *lastqueue;
1433 struct member *member;
1434 /*! Saved connected party info from an AST_CONTROL_CONNECTED_LINE. */
1435 struct ast_party_connected_line connected;
1436 /*! TRUE if an AST_CONTROL_CONNECTED_LINE update was saved to the connected element. */
1437 unsigned int pending_connected_update:1;
1438 /*! TRUE if the connected line update is blocked. */
1439 unsigned int block_connected_update:1;
1440 /*! TRUE if caller id is not available for connected line */
1441 unsigned int dial_callerid_absent:1;
1442 /*! TRUE if the call is still active */
1443 unsigned int stillgoing:1;
1444 struct ast_aoc_decoded *aoc_s_rate_list;
1449 struct call_queue *parent; /*!< What queue is our parent */
1450 char moh[MAX_MUSICCLASS]; /*!< Name of musiconhold to be used */
1451 char announce[PATH_MAX]; /*!< Announcement to play for member when call is answered */
1452 char context[AST_MAX_CONTEXT]; /*!< Context when user exits queue */
1453 char digits[AST_MAX_EXTENSION]; /*!< Digits entered while in queue */
1454 int valid_digits; /*!< Digits entered correspond to valid extension. Exited */
1455 int pos; /*!< Where we are in the queue */
1456 int prio; /*!< Our priority */
1457 int last_pos_said; /*!< Last position we told the user */
1458 int ring_when_ringing; /*!< Should we only use ring indication when a channel is ringing? */
1459 time_t last_periodic_announce_time; /*!< The last time we played a periodic announcement */
1460 int last_periodic_announce_sound; /*!< The last periodic announcement we made */
1461 time_t last_pos; /*!< Last time we told the user their position */
1462 int opos; /*!< Where we started in the queue */
1463 int handled; /*!< Whether our call was handled */
1464 int pending; /*!< Non-zero if we are attempting to call a member */
1465 int max_penalty; /*!< Limit the members that can take this call to this penalty or lower */
1466 int min_penalty; /*!< Limit the members that can take this call to this penalty or higher */
1467 int linpos; /*!< If using linear strategy, what position are we at? */
1468 int linwrapped; /*!< Is the linpos wrapped? */
1469 time_t start; /*!< When we started holding */
1470 time_t expire; /*!< When this entry should expire (time out of queue) */
1471 int cancel_answered_elsewhere; /*!< Whether we should force the CAE flag on this call (C) option*/
1472 struct ast_channel *chan; /*!< Our channel */
1473 AST_LIST_HEAD_NOLOCK(,penalty_rule) qe_rules; /*!< Local copy of the queue's penalty rules */
1474 struct penalty_rule *pr; /*!< Pointer to the next penalty rule to implement */
1475 struct queue_ent *next; /*!< The next queue entry */
1479 char interface[AST_CHANNEL_NAME]; /*!< Technology/Location to dial to reach this member*/
1480 char state_exten[AST_MAX_EXTENSION]; /*!< Extension to get state from (if using hint) */
1481 char state_context[AST_MAX_CONTEXT]; /*!< Context to use when getting state (if using hint) */
1482 char state_interface[AST_CHANNEL_NAME]; /*!< Technology/Location from which to read devicestate changes */
1483 char membername[80]; /*!< Member name to use in queue logs */
1484 int penalty; /*!< Are we a last resort? */
1485 int calls; /*!< Number of calls serviced by this member */
1486 int dynamic; /*!< Are we dynamically added? */
1487 int realtime; /*!< Is this member realtime? */
1488 int status; /*!< Status of queue member */
1489 int paused; /*!< Are we paused (not accepting calls)? */
1490 int queuepos; /*!< In what order (pertains to certain strategies) should this member be called? */
1491 time_t lastcall; /*!< When last successful call was hungup */
1492 struct call_queue *lastqueue; /*!< Last queue we received a call */
1493 unsigned int dead:1; /*!< Used to detect members deleted in realtime */
1494 unsigned int delme:1; /*!< Flag to delete entry on reload */
1495 unsigned int call_pending:1; /*!< TRUE if the Q is attempting to place a call to the member. */
1496 char rt_uniqueid[80]; /*!< Unique id of realtime member entry */
1497 unsigned int ringinuse:1; /*!< Flag to ring queue members even if their status is 'inuse' */
1500 enum empty_conditions {
1501 QUEUE_EMPTY_PENALTY = (1 << 0),
1502 QUEUE_EMPTY_PAUSED = (1 << 1),
1503 QUEUE_EMPTY_INUSE = (1 << 2),
1504 QUEUE_EMPTY_RINGING = (1 << 3),
1505 QUEUE_EMPTY_UNAVAILABLE = (1 << 4),
1506 QUEUE_EMPTY_INVALID = (1 << 5),
1507 QUEUE_EMPTY_UNKNOWN = (1 << 6),
1508 QUEUE_EMPTY_WRAPUP = (1 << 7),
1511 enum member_properties {
1513 MEMBER_RINGINUSE = 1,
1516 /* values used in multi-bit flags in call_queue */
1517 #define ANNOUNCEHOLDTIME_ALWAYS 1
1518 #define ANNOUNCEHOLDTIME_ONCE 2
1519 #define QUEUE_EVENT_VARIABLES 3
1521 struct penalty_rule {
1522 int time; /*!< Number of seconds that need to pass before applying this rule */
1523 int max_value; /*!< The amount specified in the penalty rule for max penalty */
1524 int min_value; /*!< The amount specified in the penalty rule for min penalty */
1525 int max_relative; /*!< Is the max adjustment relative? 1 for relative, 0 for absolute */
1526 int min_relative; /*!< Is the min adjustment relative? 1 for relative, 0 for absolute */
1527 AST_LIST_ENTRY(penalty_rule) list; /*!< Next penalty_rule */
1530 #define ANNOUNCEPOSITION_YES 1 /*!< We announce position */
1531 #define ANNOUNCEPOSITION_NO 2 /*!< We don't announce position */
1532 #define ANNOUNCEPOSITION_MORE_THAN 3 /*!< We say "Currently there are more than <limit>" */
1533 #define ANNOUNCEPOSITION_LIMIT 4 /*!< We not announce position more than <limit> */
1536 AST_DECLARE_STRING_FIELDS(
1538 AST_STRING_FIELD(name);
1539 /*! Music on Hold class */
1540 AST_STRING_FIELD(moh);
1541 /*! Announcement to play when call is answered */
1542 AST_STRING_FIELD(announce);
1544 AST_STRING_FIELD(context);
1545 /*! Macro to run upon member connection */
1546 AST_STRING_FIELD(membermacro);
1547 /*! Gosub to run upon member connection */
1548 AST_STRING_FIELD(membergosub);
1549 /*! Default rule to use if none specified in call to Queue() */
1550 AST_STRING_FIELD(defaultrule);
1551 /*! Sound file: "Your call is now first in line" (def. queue-youarenext) */
1552 AST_STRING_FIELD(sound_next);
1553 /*! Sound file: "There are currently" (def. queue-thereare) */
1554 AST_STRING_FIELD(sound_thereare);
1555 /*! Sound file: "calls waiting to speak to a representative." (def. queue-callswaiting) */
1556 AST_STRING_FIELD(sound_calls);
1557 /*! Sound file: "Currently there are more than" (def. queue-quantity1) */
1558 AST_STRING_FIELD(queue_quantity1);
1559 /*! Sound file: "callers waiting to speak with a representative" (def. queue-quantity2) */
1560 AST_STRING_FIELD(queue_quantity2);
1561 /*! Sound file: "The current estimated total holdtime is" (def. queue-holdtime) */
1562 AST_STRING_FIELD(sound_holdtime);
1563 /*! Sound file: "minutes." (def. queue-minutes) */
1564 AST_STRING_FIELD(sound_minutes);
1565 /*! Sound file: "minute." (def. queue-minute) */
1566 AST_STRING_FIELD(sound_minute);
1567 /*! Sound file: "seconds." (def. queue-seconds) */
1568 AST_STRING_FIELD(sound_seconds);
1569 /*! Sound file: "Thank you for your patience." (def. queue-thankyou) */
1570 AST_STRING_FIELD(sound_thanks);
1571 /*! Sound file: Custom announce for caller, no default */
1572 AST_STRING_FIELD(sound_callerannounce);
1573 /*! Sound file: "Hold time" (def. queue-reporthold) */
1574 AST_STRING_FIELD(sound_reporthold);
1576 /*! Sound files: Custom announce, no default */
1577 struct ast_str *sound_periodicannounce[MAX_PERIODIC_ANNOUNCEMENTS];
1578 unsigned int dead:1;
1579 unsigned int ringinuse:1;
1580 unsigned int announce_to_first_user:1; /*!< Whether or not we announce to the first user in a queue */
1581 unsigned int setinterfacevar:1;
1582 unsigned int setqueuevar:1;
1583 unsigned int setqueueentryvar:1;
1584 unsigned int reportholdtime:1;
1585 unsigned int wrapped:1;
1586 unsigned int timeoutrestart:1;
1587 unsigned int announceholdtime:2;
1588 unsigned int announceposition:3;
1590 unsigned int realtime:1;
1591 unsigned int found:1;
1592 unsigned int relativeperiodicannounce:1;
1593 unsigned int autopausebusy:1;
1594 unsigned int autopauseunavail:1;
1595 enum empty_conditions joinempty;
1596 enum empty_conditions leavewhenempty;
1597 int announcepositionlimit; /*!< How many positions we announce? */
1598 int announcefrequency; /*!< How often to announce their position */
1599 int minannouncefrequency; /*!< The minimum number of seconds between position announcements (def. 15) */
1600 int periodicannouncefrequency; /*!< How often to play periodic announcement */
1601 int numperiodicannounce; /*!< The number of periodic announcements configured */
1602 int randomperiodicannounce; /*!< Are periodic announcments randomly chosen */
1603 int roundingseconds; /*!< How many seconds do we round to? */
1604 int holdtime; /*!< Current avg holdtime, based on an exponential average */
1605 int talktime; /*!< Current avg talktime, based on the same exponential average */
1606 int callscompleted; /*!< Number of queue calls completed */
1607 int callsabandoned; /*!< Number of queue calls abandoned */
1608 int servicelevel; /*!< seconds setting for servicelevel*/
1609 int callscompletedinsl; /*!< Number of calls answered with servicelevel*/
1610 char monfmt[8]; /*!< Format to use when recording calls */
1611 int montype; /*!< Monitor type Monitor vs. MixMonitor */
1612 int count; /*!< How many entries */
1613 int maxlen; /*!< Max number of entries */
1614 int wrapuptime; /*!< Wrapup Time */
1615 int penaltymemberslimit; /*!< Disregard penalty when queue has fewer than this many members */
1617 int retry; /*!< Retry calling everyone after this amount of time */
1618 int timeout; /*!< How long to wait for an answer */
1619 int weight; /*!< Respective weight */
1620 int autopause; /*!< Auto pause queue members if they fail to answer */
1621 int autopausedelay; /*!< Delay auto pause for autopausedelay seconds since last call */
1622 int timeoutpriority; /*!< Do we allow a fraction of the timeout to occur for a ring? */
1624 /* Queue strategy things */
1625 int rrpos; /*!< Round Robin - position */
1626 int memberdelay; /*!< Seconds to delay connecting member to caller */
1627 int autofill; /*!< Ignore the head call status and ring an available agent */
1629 struct ao2_container *members; /*!< Head of the list of members */
1630 struct queue_ent *head; /*!< Head of the list of callers */
1631 AST_LIST_ENTRY(call_queue) list; /*!< Next call queue */
1632 AST_LIST_HEAD_NOLOCK(, penalty_rule) rules; /*!< The list of penalty rules to invoke */
1637 AST_LIST_HEAD_NOLOCK(,penalty_rule) rules;
1638 AST_LIST_ENTRY(rule_list) list;
1641 static AST_LIST_HEAD_STATIC(rule_lists, rule_list);
1643 static struct ao2_container *queues;
1645 static void update_realtime_members(struct call_queue *q);
1646 static struct member *interface_exists(struct call_queue *q, const char *interface);
1647 static int set_member_paused(const char *queuename, const char *interface, const char *reason, int paused);
1649 static struct member *find_member_by_queuename_and_interface(const char *queuename, const char *interface);
1650 /*! \brief sets the QUEUESTATUS channel variable */
1651 static void set_queue_result(struct ast_channel *chan, enum queue_result res)
1655 for (i = 0; i < ARRAY_LEN(queue_results); i++) {
1656 if (queue_results[i].id == res) {
1657 pbx_builtin_setvar_helper(chan, "QUEUESTATUS", queue_results[i].text);
1663 static const char *int2strat(int strategy)
1667 for (x = 0; x < ARRAY_LEN(strategies); x++) {
1668 if (strategy == strategies[x].strategy) {
1669 return strategies[x].name;
1676 static int strat2int(const char *strategy)
1680 for (x = 0; x < ARRAY_LEN(strategies); x++) {
1681 if (!strcasecmp(strategy, strategies[x].name)) {
1682 return strategies[x].strategy;
1689 static int autopause2int(const char *autopause)
1692 /*This 'double check' that default value is OFF */
1693 if (ast_strlen_zero(autopause)) {
1694 return QUEUE_AUTOPAUSE_OFF;
1697 /*This 'double check' is to ensure old values works */
1698 if(ast_true(autopause)) {
1699 return QUEUE_AUTOPAUSE_ON;
1702 for (x = 0; x < ARRAY_LEN(autopausesmodes); x++) {
1703 if (!strcasecmp(autopause, autopausesmodes[x].name)) {
1704 return autopausesmodes[x].autopause;
1708 /*This 'double check' that default value is OFF */
1709 return QUEUE_AUTOPAUSE_OFF;
1712 static int queue_hash_cb(const void *obj, const int flags)
1714 const struct call_queue *q = obj;
1716 return ast_str_case_hash(q->name);
1719 static int queue_cmp_cb(void *obj, void *arg, int flags)
1721 struct call_queue *q = obj, *q2 = arg;
1722 return !strcasecmp(q->name, q2->name) ? CMP_MATCH | CMP_STOP : 0;
1726 * \brief ao2_callback, Decreases queuepos of all followers with a queuepos greater than arg.
1727 * \param obj the member being acted on
1728 * \param arg pointer to an integer containing the position value that was removed and requires reduction for anything above
1730 static int queue_member_decrement_followers(void *obj, void *arg, int flag)
1732 struct member *mem = obj;
1733 int *decrement_followers_after = arg;
1735 if (mem->queuepos > *decrement_followers_after) {
1743 * \brief ao2_callback, finds members in a queue marked for deletion and in a cascading fashion runs queue_member_decrement_followers
1744 * on them. This callback should always be ran before performing mass unlinking of delmarked members from queues.
1745 * \param obj member being acted on
1746 * \param arg pointer to the queue members are being removed from
1748 static int queue_delme_members_decrement_followers(void *obj, void *arg, int flag)
1750 struct member *mem = obj;
1751 struct call_queue *queue = arg;
1752 int rrpos = mem->queuepos;
1755 ao2_callback(queue->members, OBJ_NODATA | OBJ_MULTIPLE, queue_member_decrement_followers, &rrpos);
1762 * \brief Use this to decrement followers during removal of a member
1763 * \param queue which queue the member is being removed from
1764 * \param mem which member is being removed from the queue
1766 static void queue_member_follower_removal(struct call_queue *queue, struct member *mem)
1768 int pos = mem->queuepos;
1770 /* 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
1771 * who would have been next otherwise. */
1772 if (pos < queue->rrpos) {
1776 ao2_callback(queue->members, OBJ_NODATA | OBJ_MULTIPLE, queue_member_decrement_followers, &pos);
1779 #ifdef REF_DEBUG_ONLY_QUEUES
1780 #define queue_ref(q) _queue_ref(q, "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1781 #define queue_unref(q) _queue_unref(q, "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1782 #define queue_t_ref(q, tag) _queue_ref(q, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1783 #define queue_t_unref(q, tag) _queue_unref(q, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1784 #define queues_t_link(c, q, tag) __ao2_link_debug(c, q, 0, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1785 #define queues_t_unlink(c, q, tag) __ao2_unlink_debug(c, q, 0, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1787 static inline struct call_queue *_queue_ref(struct call_queue *q, const char *tag, const char *file, int line, const char *filename)
1789 __ao2_ref_debug(q, 1, tag, file, line, filename);
1793 static inline struct call_queue *_queue_unref(struct call_queue *q, const char *tag, const char *file, int line, const char *filename)
1796 __ao2_ref_debug(q, -1, tag, file, line, filename);
1803 #define queue_t_ref(q, tag) queue_ref(q)
1804 #define queue_t_unref(q, tag) queue_unref(q)
1805 #define queues_t_link(c, q, tag) ao2_t_link(c, q, tag)
1806 #define queues_t_unlink(c, q, tag) ao2_t_unlink(c, q, tag)
1808 static inline struct call_queue *queue_ref(struct call_queue *q)
1814 static inline struct call_queue *queue_unref(struct call_queue *q)
1823 /*! \brief Set variables of queue */
1824 static void set_queue_variables(struct call_queue *q, struct ast_channel *chan)
1826 char interfacevar[256]="";
1831 if (q->setqueuevar) {
1833 if (q->callscompleted > 0) {
1834 sl = 100 * ((float) q->callscompletedinsl / (float) q->callscompleted);
1837 snprintf(interfacevar, sizeof(interfacevar),
1838 "QUEUENAME=%s,QUEUEMAX=%d,QUEUESTRATEGY=%s,QUEUECALLS=%d,QUEUEHOLDTIME=%d,QUEUETALKTIME=%d,QUEUECOMPLETED=%d,QUEUEABANDONED=%d,QUEUESRVLEVEL=%d,QUEUESRVLEVELPERF=%2.1f",
1839 q->name, q->maxlen, int2strat(q->strategy), q->count, q->holdtime, q->talktime, q->callscompleted, q->callsabandoned, q->servicelevel, sl);
1843 pbx_builtin_setvar_multiple(chan, interfacevar);
1849 /*! \brief Insert the 'new' entry after the 'prev' entry of queue 'q' */
1850 static inline void insert_entry(struct call_queue *q, struct queue_ent *prev, struct queue_ent *new, int *pos)
1852 struct queue_ent *cur;
1865 /* every queue_ent must have a reference to it's parent call_queue, this
1866 * reference does not go away until the end of the queue_ent's life, meaning
1867 * that even when the queue_ent leaves the call_queue this ref must remain. */
1870 new->pos = ++(*pos);
1874 static struct ast_manager_event_blob *queue_channel_to_ami(const char *type, struct stasis_message *message)
1876 struct ast_channel_blob *obj = stasis_message_data(message);
1877 RAII_VAR(struct ast_str *, channel_string, NULL, ast_free);
1878 RAII_VAR(struct ast_str *, event_string, NULL, ast_free);
1880 channel_string = ast_manager_build_channel_state_string(obj->snapshot);
1881 event_string = ast_manager_str_from_json_object(obj->blob, NULL);
1882 if (!channel_string || !event_string) {
1886 return ast_manager_event_blob_create(EVENT_FLAG_AGENT, type,
1889 ast_str_buffer(channel_string),
1890 ast_str_buffer(event_string));
1893 static struct ast_manager_event_blob *queue_caller_join_to_ami(struct stasis_message *message)
1895 return queue_channel_to_ami("QueueCallerJoin", message);
1898 static struct ast_manager_event_blob *queue_caller_leave_to_ami(struct stasis_message *message)
1900 return queue_channel_to_ami("QueueCallerLeave", message);
1903 static struct ast_manager_event_blob *queue_caller_abandon_to_ami(struct stasis_message *message)
1905 return queue_channel_to_ami("QueueCallerAbandon", message);
1908 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_caller_join_type,
1909 .to_ami = queue_caller_join_to_ami,
1911 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_caller_leave_type,
1912 .to_ami = queue_caller_leave_to_ami,
1914 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_caller_abandon_type,
1915 .to_ami = queue_caller_abandon_to_ami,
1918 static struct ast_manager_event_blob *queue_member_to_ami(const char *type, struct stasis_message *message)
1920 struct ast_json_payload *payload = stasis_message_data(message);
1921 RAII_VAR(struct ast_str *, event_string, NULL, ast_free);
1923 event_string = ast_manager_str_from_json_object(payload->json, NULL);
1924 if (!event_string) {
1928 return ast_manager_event_blob_create(EVENT_FLAG_AGENT, type,
1930 ast_str_buffer(event_string));
1933 static struct ast_manager_event_blob *queue_member_status_to_ami(struct stasis_message *message)
1935 return queue_member_to_ami("QueueMemberStatus", message);
1938 static struct ast_manager_event_blob *queue_member_added_to_ami(struct stasis_message *message)
1940 return queue_member_to_ami("QueueMemberAdded", message);
1943 static struct ast_manager_event_blob *queue_member_removed_to_ami(struct stasis_message *message)
1945 return queue_member_to_ami("QueueMemberRemoved", message);
1948 static struct ast_manager_event_blob *queue_member_pause_to_ami(struct stasis_message *message)
1950 return queue_member_to_ami("QueueMemberPause", message);
1953 static struct ast_manager_event_blob *queue_member_penalty_to_ami(struct stasis_message *message)
1955 return queue_member_to_ami("QueueMemberPenalty", message);
1958 static struct ast_manager_event_blob *queue_member_ringinuse_to_ami(struct stasis_message *message)
1960 return queue_member_to_ami("QueueMemberRinginuse", message);
1963 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_member_status_type,
1964 .to_ami = queue_member_status_to_ami,
1966 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_member_added_type,
1967 .to_ami = queue_member_added_to_ami,
1969 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_member_removed_type,
1970 .to_ami = queue_member_removed_to_ami,
1972 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_member_pause_type,
1973 .to_ami = queue_member_pause_to_ami,
1975 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_member_penalty_type,
1976 .to_ami = queue_member_penalty_to_ami,
1978 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_member_ringinuse_type,
1979 .to_ami = queue_member_ringinuse_to_ami,
1982 static struct ast_manager_event_blob *queue_multi_channel_to_ami(const char *type, struct stasis_message *message)
1984 struct ast_multi_channel_blob *obj = stasis_message_data(message);
1985 struct ast_channel_snapshot *caller;
1986 struct ast_channel_snapshot *agent;
1987 RAII_VAR(struct ast_str *, caller_event_string, NULL, ast_free);
1988 RAII_VAR(struct ast_str *, agent_event_string, NULL, ast_free);
1989 RAII_VAR(struct ast_str *, event_string, NULL, ast_free);
1991 caller = ast_multi_channel_blob_get_channel(obj, "caller");
1993 caller_event_string = ast_manager_build_channel_state_string(caller);
1994 if (!caller_event_string) {
1995 ast_log(LOG_NOTICE, "No caller event string, bailing\n");
2000 agent = ast_multi_channel_blob_get_channel(obj, "agent");
2002 agent_event_string = ast_manager_build_channel_state_string_prefix(agent, "Dest");
2003 if (!agent_event_string) {
2004 ast_log(LOG_NOTICE, "No agent event string, bailing\n");
2009 event_string = ast_manager_str_from_json_object(ast_multi_channel_blob_get_json(obj), NULL);
2010 if (!event_string) {
2014 return ast_manager_event_blob_create(EVENT_FLAG_AGENT, type,
2018 caller_event_string ? ast_str_buffer(caller_event_string) : "",
2019 agent_event_string ? ast_str_buffer(agent_event_string) : "",
2020 ast_str_buffer(event_string));
2023 static struct ast_manager_event_blob *queue_agent_called_to_ami(struct stasis_message *message)
2025 return queue_multi_channel_to_ami("AgentCalled", message);
2028 static struct ast_manager_event_blob *queue_agent_connect_to_ami(struct stasis_message *message)
2030 return queue_multi_channel_to_ami("AgentConnect", message);
2033 static struct ast_manager_event_blob *queue_agent_complete_to_ami(struct stasis_message *message)
2035 return queue_multi_channel_to_ami("AgentComplete", message);
2038 static struct ast_manager_event_blob *queue_agent_dump_to_ami(struct stasis_message *message)
2040 return queue_multi_channel_to_ami("AgentDump", message);
2043 static struct ast_manager_event_blob *queue_agent_ringnoanswer_to_ami(struct stasis_message *message)
2045 return queue_multi_channel_to_ami("AgentRingNoAnswer", message);
2048 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_agent_called_type,
2049 .to_ami = queue_agent_called_to_ami,
2051 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_agent_connect_type,
2052 .to_ami = queue_agent_connect_to_ami,
2054 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_agent_complete_type,
2055 .to_ami = queue_agent_complete_to_ami,
2057 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_agent_dump_type,
2058 .to_ami = queue_agent_dump_to_ami,
2060 STASIS_MESSAGE_TYPE_DEFN_LOCAL(queue_agent_ringnoanswer_type,
2061 .to_ami = queue_agent_ringnoanswer_to_ami,
2064 static void queue_publish_multi_channel_snapshot_blob(struct stasis_topic *topic,
2065 struct ast_channel_snapshot *caller_snapshot,
2066 struct ast_channel_snapshot *agent_snapshot,
2067 struct stasis_message_type *type, struct ast_json *blob)
2069 RAII_VAR(struct ast_multi_channel_blob *, payload, NULL, ao2_cleanup);
2070 RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
2076 payload = ast_multi_channel_blob_create(blob);
2081 ast_multi_channel_blob_add_channel(payload, "caller", caller_snapshot);
2082 if (agent_snapshot) {
2083 ast_multi_channel_blob_add_channel(payload, "agent", agent_snapshot);
2086 msg = stasis_message_create(type, payload);
2091 stasis_publish(topic, msg);
2094 static void queue_publish_multi_channel_blob(struct ast_channel *caller, struct ast_channel *agent,
2095 struct stasis_message_type *type, struct ast_json *blob)
2097 RAII_VAR(struct ast_channel_snapshot *, caller_snapshot, NULL, ao2_cleanup);
2098 RAII_VAR(struct ast_channel_snapshot *, agent_snapshot, NULL, ao2_cleanup);
2100 ast_channel_lock(caller);
2101 caller_snapshot = ast_channel_snapshot_create(caller);
2102 ast_channel_unlock(caller);
2103 ast_channel_lock(agent);
2104 agent_snapshot = ast_channel_snapshot_create(agent);
2105 ast_channel_unlock(agent);
2107 if (!caller_snapshot || !agent_snapshot) {
2111 queue_publish_multi_channel_snapshot_blob(ast_channel_topic(caller), caller_snapshot,
2112 agent_snapshot, type, blob);
2117 * \brief Publish the member blob.
2120 * \param type Stasis message type to publish.
2121 * \param blob The information being published.
2123 * \note The json blob reference is passed to this function.
2127 static void queue_publish_member_blob(struct stasis_message_type *type, struct ast_json *blob)
2129 RAII_VAR(struct ast_json_payload *, payload, NULL, ao2_cleanup);
2130 RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
2132 if (!blob || !type) {
2136 payload = ast_json_payload_create(blob);
2137 ast_json_unref(blob);
2142 msg = stasis_message_create(type, payload);
2147 stasis_publish(ast_manager_get_topic(), msg);
2150 static struct ast_json *queue_member_blob_create(struct call_queue *q, struct member *mem)
2152 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}",
2154 "MemberName", mem->membername,
2155 "Interface", mem->interface,
2156 "StateInterface", mem->state_interface,
2157 "Membership", (mem->dynamic ? "dynamic" : (mem->realtime ? "realtime" : "static")),
2158 "Penalty", mem->penalty,
2159 "CallsTaken", mem->calls,
2160 "LastCall", (int)mem->lastcall,
2161 "Status", mem->status,
2162 "Paused", mem->paused,
2163 "Ringinuse", mem->ringinuse);
2166 /*! \brief Check if members are available
2168 * This function checks to see if members are available to be called. If any member
2169 * is available, the function immediately returns 0. If no members are available,
2170 * then -1 is returned.
2172 static int get_member_status(struct call_queue *q, int max_penalty, int min_penalty, enum empty_conditions conditions, int devstate)
2174 struct member *member;
2175 struct ao2_iterator mem_iter;
2178 mem_iter = ao2_iterator_init(q->members, 0);
2179 for (; (member = ao2_iterator_next(&mem_iter)); ao2_ref(member, -1)) {
2180 if ((max_penalty != INT_MAX && member->penalty > max_penalty) || (min_penalty != INT_MAX && member->penalty < min_penalty)) {
2181 if (conditions & QUEUE_EMPTY_PENALTY) {
2182 ast_debug(4, "%s is unavailable because his penalty is not between %d and %d\n", member->membername, min_penalty, max_penalty);
2187 switch (devstate ? ast_device_state(member->state_interface) : member->status) {
2188 case AST_DEVICE_INVALID:
2189 if (conditions & QUEUE_EMPTY_INVALID) {
2190 ast_debug(4, "%s is unavailable because his device state is 'invalid'\n", member->membername);
2194 case AST_DEVICE_UNAVAILABLE:
2195 if (conditions & QUEUE_EMPTY_UNAVAILABLE) {
2196 ast_debug(4, "%s is unavailable because his device state is 'unavailable'\n", member->membername);
2200 case AST_DEVICE_INUSE:
2201 if (conditions & QUEUE_EMPTY_INUSE) {
2202 ast_debug(4, "%s is unavailable because his device state is 'inuse'\n", member->membername);
2206 case AST_DEVICE_RINGING:
2207 if (conditions & QUEUE_EMPTY_RINGING) {
2208 ast_debug(4, "%s is unavailable because his device state is 'ringing'\n", member->membername);
2212 case AST_DEVICE_UNKNOWN:
2213 if (conditions & QUEUE_EMPTY_UNKNOWN) {
2214 ast_debug(4, "%s is unavailable because his device state is 'unknown'\n", member->membername);
2220 if (member->paused && (conditions & QUEUE_EMPTY_PAUSED)) {
2221 ast_debug(4, "%s is unavailable because he is paused'\n", member->membername);
2223 } else if ((conditions & QUEUE_EMPTY_WRAPUP) && member->lastcall && q->wrapuptime && (time(NULL) - q->wrapuptime < member->lastcall)) {
2224 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);
2227 ao2_ref(member, -1);
2228 ao2_iterator_destroy(&mem_iter);
2230 ast_debug(4, "%s is available.\n", member->membername);
2236 ao2_iterator_destroy(&mem_iter);
2239 if (!devstate && (conditions & QUEUE_EMPTY_RINGING)) {
2240 /* member state still may be RINGING due to lag in event message - check again with device state */
2241 return get_member_status(q, max_penalty, min_penalty, conditions, 1);
2246 /*! \brief set a member's status based on device state of that member's state_interface.
2248 * Lock interface list find sc, iterate through each queues queue_member list for member to
2249 * update state inside queues
2251 static void update_status(struct call_queue *q, struct member *m, const int status)
2255 queue_publish_member_blob(queue_member_status_type(), queue_member_blob_create(q, m));
2260 * \brief Determine if a queue member is available
2261 * \retval 1 if the member is available
2262 * \retval 0 if the member is not available
2264 static int is_member_available(struct call_queue *q, struct member *mem)
2268 switch (mem->status) {
2269 case AST_DEVICE_INVALID:
2270 case AST_DEVICE_UNAVAILABLE:
2272 case AST_DEVICE_INUSE:
2273 case AST_DEVICE_BUSY:
2274 case AST_DEVICE_RINGING:
2275 case AST_DEVICE_RINGINUSE:
2276 case AST_DEVICE_ONHOLD:
2277 if (!mem->ringinuse) {
2280 /* else fall through */
2281 case AST_DEVICE_NOT_INUSE:
2282 case AST_DEVICE_UNKNOWN:
2289 /* Let wrapuptimes override device state availability */
2290 if (mem->lastcall && q->wrapuptime && (time(NULL) - q->wrapuptime < mem->lastcall)) {
2296 /*! \brief set a member's status based on device state of that member's interface*/
2297 static void device_state_cb(void *unused, struct stasis_subscription *sub, struct stasis_message *msg)
2299 struct ao2_iterator miter, qiter;
2300 struct ast_device_state_message *dev_state;
2302 struct call_queue *q;
2303 char interface[80], *slash_pos;
2304 int found = 0; /* Found this member in any queue */
2305 int found_member; /* Found this member in this queue */
2306 int avail = 0; /* Found an available member in this queue */
2308 if (ast_device_state_message_type() != stasis_message_type(msg)) {
2312 dev_state = stasis_message_data(msg);
2313 if (dev_state->eid) {
2314 /* ignore non-aggregate states */
2318 qiter = ao2_iterator_init(queues, 0);
2319 while ((q = ao2_t_iterator_next(&qiter, "Iterate over queues"))) {
2324 miter = ao2_iterator_init(q->members, 0);
2325 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
2326 if (!found_member) {
2327 ast_copy_string(interface, m->state_interface, sizeof(interface));
2329 if ((slash_pos = strchr(interface, '/'))) {
2330 if (!strncasecmp(interface, "Local/", 6) && (slash_pos = strchr(slash_pos + 1, '/'))) {
2335 if (!strcasecmp(interface, dev_state->device)) {
2337 update_status(q, m, dev_state->state);
2341 /* check every member until we find one NOT_INUSE */
2343 avail = is_member_available(q, m);
2345 if (avail && found_member) {
2346 /* early exit as we've found an available member and the member of interest */
2355 ast_devstate_changed(AST_DEVICE_NOT_INUSE, AST_DEVSTATE_CACHABLE, "Queue:%s_avail", q->name);
2357 ast_devstate_changed(AST_DEVICE_INUSE, AST_DEVSTATE_CACHABLE, "Queue:%s_avail", q->name);
2361 ao2_iterator_destroy(&miter);
2364 queue_t_unref(q, "Done with iterator");
2366 ao2_iterator_destroy(&qiter);
2369 ast_debug(1, "Device '%s' changed to state '%u' (%s)\n",
2372 ast_devstate2str(dev_state->state));
2374 ast_debug(3, "Device '%s' changed to state '%u' (%s) but we don't care because they're not a member of any queue.\n",
2377 ast_devstate2str(dev_state->state));
2383 /*! \brief Helper function which converts from extension state to device state values */
2384 static int extensionstate2devicestate(int state)
2387 case AST_EXTENSION_NOT_INUSE:
2388 state = AST_DEVICE_NOT_INUSE;
2390 case AST_EXTENSION_INUSE:
2391 state = AST_DEVICE_INUSE;
2393 case AST_EXTENSION_BUSY:
2394 state = AST_DEVICE_BUSY;
2396 case AST_EXTENSION_RINGING:
2397 state = AST_DEVICE_RINGING;
2399 case AST_EXTENSION_ONHOLD:
2400 state = AST_DEVICE_ONHOLD;
2402 case AST_EXTENSION_UNAVAILABLE:
2403 state = AST_DEVICE_UNAVAILABLE;
2405 case AST_EXTENSION_REMOVED:
2406 case AST_EXTENSION_DEACTIVATED:
2408 state = AST_DEVICE_INVALID;
2415 static int extension_state_cb(char *context, char *exten, struct ast_state_cb_info *info, void *data)
2417 struct ao2_iterator miter, qiter;
2419 struct call_queue *q;
2420 int state = info->exten_state;
2421 int found = 0, device_state = extensionstate2devicestate(state);
2423 /* only interested in extension state updates involving device states */
2424 if (info->reason != AST_HINT_UPDATE_DEVICE) {
2428 qiter = ao2_iterator_init(queues, 0);
2429 while ((q = ao2_t_iterator_next(&qiter, "Iterate through queues"))) {
2432 miter = ao2_iterator_init(q->members, 0);
2433 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
2434 if (!strcmp(m->state_context, context) && !strcmp(m->state_exten, exten)) {
2435 update_status(q, m, device_state);
2441 ao2_iterator_destroy(&miter);
2444 queue_t_unref(q, "Done with iterator");
2446 ao2_iterator_destroy(&qiter);
2449 ast_debug(1, "Extension '%s@%s' changed to state '%d' (%s)\n", exten, context, device_state, ast_devstate2str(device_state));
2451 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",
2452 exten, context, device_state, ast_devstate2str(device_state));
2458 /*! \brief Return the current state of a member */
2459 static int get_queue_member_status(struct member *cur)
2461 return ast_strlen_zero(cur->state_exten) ? ast_device_state(cur->state_interface) : extensionstate2devicestate(ast_extension_state(NULL, cur->state_context, cur->state_exten));
2464 /*! \brief allocate space for new queue member and set fields based on parameters passed */
2465 static struct member *create_queue_member(const char *interface, const char *membername, int penalty, int paused, const char *state_interface, int ringinuse)
2469 if ((cur = ao2_alloc(sizeof(*cur), NULL))) {
2470 cur->ringinuse = ringinuse;
2471 cur->penalty = penalty;
2472 cur->paused = paused;
2473 ast_copy_string(cur->interface, interface, sizeof(cur->interface));
2474 if (!ast_strlen_zero(state_interface)) {
2475 ast_copy_string(cur->state_interface, state_interface, sizeof(cur->state_interface));
2477 ast_copy_string(cur->state_interface, interface, sizeof(cur->state_interface));
2479 if (!ast_strlen_zero(membername)) {
2480 ast_copy_string(cur->membername, membername, sizeof(cur->membername));
2482 ast_copy_string(cur->membername, interface, sizeof(cur->membername));
2484 if (!strchr(cur->interface, '/')) {
2485 ast_log(LOG_WARNING, "No location at interface '%s'\n", interface);
2487 if (!strncmp(cur->state_interface, "hint:", 5)) {
2488 char *tmp = ast_strdupa(cur->state_interface), *context = tmp;
2489 char *exten = strsep(&context, "@") + 5;
2491 ast_copy_string(cur->state_exten, exten, sizeof(cur->state_exten));
2492 ast_copy_string(cur->state_context, S_OR(context, "default"), sizeof(cur->state_context));
2494 cur->status = get_queue_member_status(cur);
2501 static int compress_char(const char c)
2505 } else if (c > 96) {
2511 static int member_hash_fn(const void *obj, const int flags)
2513 const struct member *mem = obj;
2514 const char *interface = (flags & OBJ_KEY) ? obj : mem->interface;
2515 const char *chname = strchr(interface, '/');
2521 for (i = 0; i < 5 && chname[i]; i++) {
2522 ret += compress_char(chname[i]) << (i * 6);
2527 static int member_cmp_fn(void *obj1, void *obj2, int flags)
2529 struct member *mem1 = obj1;
2530 struct member *mem2 = obj2;
2531 const char *interface = (flags & OBJ_KEY) ? obj2 : mem2->interface;
2533 return strcasecmp(mem1->interface, interface) ? 0 : CMP_MATCH | CMP_STOP;
2537 * \brief Initialize Queue default values.
2538 * \note the queue's lock must be held before executing this function
2540 static void init_queue(struct call_queue *q)
2543 struct penalty_rule *pr_iter;
2546 q->retry = DEFAULT_RETRY;
2547 q->timeout = DEFAULT_TIMEOUT;
2549 q->announcefrequency = 0;
2550 q->minannouncefrequency = DEFAULT_MIN_ANNOUNCE_FREQUENCY;
2551 q->announceholdtime = 1;
2552 q->announcepositionlimit = 10; /* Default 10 positions */
2553 q->announceposition = ANNOUNCEPOSITION_YES; /* Default yes */
2554 q->roundingseconds = 0; /* Default - don't announce seconds */
2555 q->servicelevel = 0;
2557 q->announce_to_first_user = 0;
2558 q->setinterfacevar = 0;
2560 q->setqueueentryvar = 0;
2561 q->autofill = autofill_default;
2562 q->montype = montype_default;
2563 q->monfmt[0] = '\0';
2564 q->reportholdtime = 0;
2566 q->penaltymemberslimit = 0;
2568 q->leavewhenempty = 0;
2571 q->timeoutrestart = 0;
2572 q->periodicannouncefrequency = 0;
2573 q->randomperiodicannounce = 0;
2574 q->numperiodicannounce = 0;
2575 q->autopause = QUEUE_AUTOPAUSE_OFF;
2576 q->timeoutpriority = TIMEOUT_PRIORITY_APP;
2577 q->autopausedelay = 0;
2579 if (q->strategy == QUEUE_STRATEGY_LINEAR || q->strategy == QUEUE_STRATEGY_RRORDERED) {
2580 /* linear strategy depends on order, so we have to place all members in a single bucket */
2581 q->members = ao2_container_alloc(1, member_hash_fn, member_cmp_fn);
2583 q->members = ao2_container_alloc(37, member_hash_fn, member_cmp_fn);
2588 ast_string_field_set(q, sound_next, "queue-youarenext");
2589 ast_string_field_set(q, sound_thereare, "queue-thereare");
2590 ast_string_field_set(q, sound_calls, "queue-callswaiting");
2591 ast_string_field_set(q, queue_quantity1, "queue-quantity1");
2592 ast_string_field_set(q, queue_quantity2, "queue-quantity2");
2593 ast_string_field_set(q, sound_holdtime, "queue-holdtime");
2594 ast_string_field_set(q, sound_minutes, "queue-minutes");
2595 ast_string_field_set(q, sound_minute, "queue-minute");
2596 ast_string_field_set(q, sound_seconds, "queue-seconds");
2597 ast_string_field_set(q, sound_thanks, "queue-thankyou");
2598 ast_string_field_set(q, sound_reporthold, "queue-reporthold");
2600 if (!q->sound_periodicannounce[0]) {
2601 q->sound_periodicannounce[0] = ast_str_create(32);
2604 if (q->sound_periodicannounce[0]) {
2605 ast_str_set(&q->sound_periodicannounce[0], 0, "queue-periodic-announce");
2608 for (i = 1; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) {
2609 if (q->sound_periodicannounce[i]) {
2610 ast_str_set(&q->sound_periodicannounce[i], 0, "%s", "");
2614 while ((pr_iter = AST_LIST_REMOVE_HEAD(&q->rules,list))) {
2618 /* On restart assume no members are available.
2619 * The queue_avail hint is a boolean state to indicate whether a member is available or not.
2621 * This seems counter intuitive, but is required to light a BLF
2622 * AST_DEVICE_INUSE indicates no members are available.
2623 * AST_DEVICE_NOT_INUSE indicates a member is available.
2625 ast_devstate_changed(AST_DEVICE_INUSE, AST_DEVSTATE_CACHABLE, "Queue:%s_avail", q->name);
2628 static void clear_queue(struct call_queue *q)
2631 q->callscompleted = 0;
2632 q->callsabandoned = 0;
2633 q->callscompletedinsl = 0;
2638 struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
2639 while ((mem = ao2_iterator_next(&mem_iter))) {
2644 ao2_iterator_destroy(&mem_iter);
2649 * \brief Change queue penalty by adding rule.
2651 * Check rule for errors with time or fomatting, see if rule is relative to rest
2652 * of queue, iterate list of rules to find correct insertion point, insert and return.
2653 * \retval -1 on failure
2654 * \retval 0 on success
2655 * \note Call this with the rule_lists locked
2657 static int insert_penaltychange(const char *list_name, const char *content, const int linenum)
2659 char *timestr, *maxstr, *minstr, *contentdup;
2660 struct penalty_rule *rule = NULL, *rule_iter;
2661 struct rule_list *rl_iter;
2662 int penaltychangetime, inserted = 0;
2664 if (!(rule = ast_calloc(1, sizeof(*rule)))) {
2668 contentdup = ast_strdupa(content);
2670 if (!(maxstr = strchr(contentdup, ','))) {
2671 ast_log(LOG_WARNING, "Improperly formatted penaltychange rule at line %d. Ignoring.\n", linenum);
2677 timestr = contentdup;
2679 if ((penaltychangetime = atoi(timestr)) < 0) {
2680 ast_log(LOG_WARNING, "Improper time parameter specified for penaltychange rule at line %d. Ignoring.\n", linenum);
2685 rule->time = penaltychangetime;
2687 if ((minstr = strchr(maxstr,','))) {
2691 /* The last check will evaluate true if either no penalty change is indicated for a given rule
2692 * OR if a min penalty change is indicated but no max penalty change is */
2693 if (*maxstr == '+' || *maxstr == '-' || *maxstr == '\0') {
2694 rule->max_relative = 1;
2697 rule->max_value = atoi(maxstr);
2699 if (!ast_strlen_zero(minstr)) {
2700 if (*minstr == '+' || *minstr == '-') {
2701 rule->min_relative = 1;
2703 rule->min_value = atoi(minstr);
2704 } else { /*there was no minimum specified, so assume this means no change*/
2705 rule->min_relative = 1;
2708 /*We have the rule made, now we need to insert it where it belongs*/
2709 AST_LIST_TRAVERSE(&rule_lists, rl_iter, list){
2710 if (strcasecmp(rl_iter->name, list_name)) {
2714 AST_LIST_TRAVERSE_SAFE_BEGIN(&rl_iter->rules, rule_iter, list) {
2715 if (rule->time < rule_iter->time) {
2716 AST_LIST_INSERT_BEFORE_CURRENT(rule, list);
2721 AST_LIST_TRAVERSE_SAFE_END;
2724 AST_LIST_INSERT_TAIL(&rl_iter->rules, rule, list);
2732 ast_log(LOG_WARNING, "Unknown rule list name %s; ignoring.\n", list_name);
2740 * \brief Load queue rules from realtime.
2742 * Check rule for errors with time or fomatting, see if rule is relative to rest
2743 * of queue, iterate list of rules to find correct insertion point, insert and return.
2744 * \retval -1 on failure
2745 * \retval 0 on success
2746 * \note Call this with the rule_lists locked
2748 static int load_realtime_rules(void)
2750 struct ast_config *cfg;
2751 struct rule_list *rl_iter, *new_rl;
2752 struct penalty_rule *pr_iter;
2753 char *rulecat = NULL;
2755 if (!ast_check_realtime("queue_rules")) {
2756 ast_log(LOG_WARNING, "Missing \"queue_rules\" in extconfig.conf\n");
2759 if (!(cfg = ast_load_realtime_multientry("queue_rules", "rule_name LIKE", "%", SENTINEL))) {
2760 ast_log(LOG_WARNING, "Failed to load queue rules from realtime\n");
2763 while ((rulecat = ast_category_browse(cfg, rulecat)) && !ast_strlen_zero(rulecat)) {
2764 const char *timestr, *maxstr, *minstr;
2765 int penaltychangetime, rule_exists = 0, inserted = 0;
2766 int max_penalty = 0, min_penalty = 0, min_relative = 0, max_relative = 0;
2767 struct penalty_rule *new_penalty_rule = NULL;
2768 AST_LIST_TRAVERSE(&rule_lists, rl_iter, list) {
2769 if (!(strcasecmp(rl_iter->name, rulecat))) {
2776 if (!(new_rl = ast_calloc(1, sizeof(*new_rl)))) {
2777 ast_config_destroy(cfg);
2780 ast_copy_string(new_rl->name, rulecat, sizeof(new_rl->name));
2781 AST_LIST_INSERT_TAIL(&rule_lists, new_rl, list);
2783 timestr = ast_variable_retrieve(cfg, rulecat, "time");
2784 if (!(timestr) || sscanf(timestr, "%30d", &penaltychangetime) != 1) {
2785 ast_log(LOG_NOTICE, "Failed to parse time (%s) for one of the %s rules, skipping it\n",
2786 (ast_strlen_zero(timestr) ? "invalid value" : timestr), rulecat);
2789 if (!(new_penalty_rule = ast_calloc(1, sizeof(*new_penalty_rule)))) {
2790 ast_config_destroy(cfg);
2793 if (!(maxstr = ast_variable_retrieve(cfg, rulecat, "max_penalty")) ||
2794 ast_strlen_zero(maxstr) || sscanf(maxstr, "%30d", &max_penalty) != 1) {
2798 if (*maxstr == '+' || *maxstr == '-') {
2802 if (!(minstr = ast_variable_retrieve(cfg, rulecat, "min_penalty")) ||
2803 ast_strlen_zero(minstr) || sscanf(minstr, "%30d", &min_penalty) != 1) {
2807 if (*minstr == '+' || *minstr == '-') {
2811 new_penalty_rule->time = penaltychangetime;
2812 new_penalty_rule->max_relative = max_relative;
2813 new_penalty_rule->max_value = max_penalty;
2814 new_penalty_rule->min_relative = min_relative;
2815 new_penalty_rule->min_value = min_penalty;
2816 AST_LIST_TRAVERSE_SAFE_BEGIN(&new_rl->rules, pr_iter, list) {
2817 if (new_penalty_rule->time < pr_iter->time) {
2818 AST_LIST_INSERT_BEFORE_CURRENT(new_penalty_rule, list);
2822 AST_LIST_TRAVERSE_SAFE_END;
2824 AST_LIST_INSERT_TAIL(&new_rl->rules, new_penalty_rule, list);
2828 ast_config_destroy(cfg);
2832 static void parse_empty_options(const char *value, enum empty_conditions *empty, int joinempty)
2834 char *value_copy = ast_strdupa(value);
2835 char *option = NULL;
2836 while ((option = strsep(&value_copy, ","))) {
2837 if (!strcasecmp(option, "paused")) {
2838 *empty |= QUEUE_EMPTY_PAUSED;
2839 } else if (!strcasecmp(option, "penalty")) {
2840 *empty |= QUEUE_EMPTY_PENALTY;
2841 } else if (!strcasecmp(option, "inuse")) {
2842 *empty |= QUEUE_EMPTY_INUSE;
2843 } else if (!strcasecmp(option, "ringing")) {
2844 *empty |= QUEUE_EMPTY_RINGING;
2845 } else if (!strcasecmp(option, "invalid")) {
2846 *empty |= QUEUE_EMPTY_INVALID;
2847 } else if (!strcasecmp(option, "wrapup")) {
2848 *empty |= QUEUE_EMPTY_WRAPUP;
2849 } else if (!strcasecmp(option, "unavailable")) {
2850 *empty |= QUEUE_EMPTY_UNAVAILABLE;
2851 } else if (!strcasecmp(option, "unknown")) {
2852 *empty |= QUEUE_EMPTY_UNKNOWN;
2853 } else if (!strcasecmp(option, "loose")) {
2854 *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID);
2855 } else if (!strcasecmp(option, "strict")) {
2856 *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED | QUEUE_EMPTY_UNAVAILABLE);
2857 } else if ((ast_false(option) && joinempty) || (ast_true(option) && !joinempty)) {
projects / asterisk/asterisk.git / blob