2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2006, Digium, Inc.
6 * Mark Spencer <markster@digium.com>
8 * See http://www.asterisk.org for more information about
9 * the Asterisk project. Please do not directly contact
10 * any of the maintainers of this project for assistance;
11 * the project provides a web site, mailing lists and IRC
12 * channels for your use.
14 * This program is free software, distributed under the terms of
15 * the GNU General Public License Version 2. See the LICENSE file
16 * at the top of the source tree.
21 * \brief True call queues with optional send URL on answer
23 * \author Mark Spencer <markster@digium.com>
25 * \arg Config in \ref Config_qu queues.conf
27 * \par Development notes
28 * \note 2004-11-25: Persistent Dynamic Members added by:
29 * NetNation Communications (www.netnation.com)
30 * Kevin Lindsay <kevinl@netnation.com>
32 * Each dynamic agent in each queue is now stored in the astdb.
33 * When asterisk is restarted, each agent will be automatically
34 * readded into their recorded queues. This feature can be
35 * configured with the 'persistent_members=<1|0>' setting in the
36 * '[general]' category in queues.conf. The default is on.
38 * \note 2004-06-04: Priorities in queues added by inAccess Networks (work funded by Hellas On Line (HOL) www.hol.gr).
40 * \note These features added by David C. Troy <dave@toad.net>:
41 * - Per-queue holdtime calculation
42 * - Estimated holdtime announcement
43 * - Position announcement
44 * - Abandoned/completed call counters
45 * - Failout timer passed as optional app parameter
46 * - Optional monitoring of calls, started when call is answered
48 * Patch Version 1.07 2003-12-24 01
50 * Added servicelevel statistic by Michiel Betel <michiel@betel.nl>
51 * Added Priority jumping code for adding and removing queue members by Jonathan Stanton <asterisk@doilooklikeicare.com>
53 * Fixed to work with CVS as of 2004-02-25 and released as 1.07a
54 * by Matthew Enger <m.enger@xi.com.au>
56 * \ingroup applications
60 <use type="module">res_monitor</use>
61 <support_level>core</support_level>
66 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
69 #include <sys/signal.h>
70 #include <netinet/in.h>
73 #include "asterisk/lock.h"
74 #include "asterisk/file.h"
75 #include "asterisk/channel.h"
76 #include "asterisk/pbx.h"
77 #include "asterisk/app.h"
78 #include "asterisk/linkedlists.h"
79 #include "asterisk/module.h"
80 #include "asterisk/translate.h"
81 #include "asterisk/say.h"
82 #include "asterisk/features.h"
83 #include "asterisk/musiconhold.h"
84 #include "asterisk/cli.h"
85 #include "asterisk/manager.h"
86 #include "asterisk/config.h"
87 #include "asterisk/monitor.h"
88 #include "asterisk/utils.h"
89 #include "asterisk/causes.h"
90 #include "asterisk/astdb.h"
91 #include "asterisk/devicestate.h"
92 #include "asterisk/stringfields.h"
93 #include "asterisk/event.h"
94 #include "asterisk/astobj2.h"
95 #include "asterisk/strings.h"
96 #include "asterisk/global_datastores.h"
97 #include "asterisk/taskprocessor.h"
98 #include "asterisk/aoc.h"
99 #include "asterisk/callerid.h"
100 #include "asterisk/cel.h"
101 #include "asterisk/data.h"
103 /* Define, to debug reference counts on queues, without debugging reference counts on queue members */
104 /* #define REF_DEBUG_ONLY_QUEUES */
107 * \par Please read before modifying this file.
108 * There are three locks which are regularly used
109 * throughout this file, the queue list lock, the lock
110 * for each individual queue, and the interface list lock.
111 * Please be extra careful to always lock in the following order
113 * 2) individual queue lock
114 * 3) interface list lock
115 * This order has sort of "evolved" over the lifetime of this
116 * application, but it is now in place this way, so please adhere
121 <application name="Queue" language="en_US">
123 Queue a call for a call queue.
126 <parameter name="queuename" required="true" />
127 <parameter name="options">
130 <para>Mark all calls as "answered elsewhere" when cancelled.</para>
133 <para>Continue in the dialplan if the callee hangs up.</para>
136 <para>data-quality (modem) call (minimum delay).</para>
138 <option name="F" argsep="^">
139 <argument name="context" required="false" />
140 <argument name="exten" required="false" />
141 <argument name="priority" required="true" />
142 <para>When the caller hangs up, transfer the <emphasis>called member</emphasis>
143 to the specified destination and <emphasis>start</emphasis> execution at that location.</para>
145 <para>Any channel variables you want the called channel to inherit from the caller channel must be
146 prefixed with one or two underbars ('_').</para>
150 <para>When the caller hangs up, transfer the <emphasis>called member</emphasis> to the next priority of
151 the current extension and <emphasis>start</emphasis> execution at that location.</para>
153 <para>Any channel variables you want the called channel to inherit from the caller channel must be
154 prefixed with one or two underbars ('_').</para>
157 <para>Using this option from a Macro() or GoSub() might not make sense as there would be no return points.</para>
161 <para>Allow <emphasis>callee</emphasis> to hang up by pressing <literal>*</literal>.</para>
164 <para>Allow <emphasis>caller</emphasis> to hang up by pressing <literal>*</literal>.</para>
167 <para>No retries on the timeout; will exit this application and
168 go to the next step.</para>
171 <para>Ignore call forward requests from queue members and do nothing
172 when they are requested.</para>
175 <para>Asterisk will ignore any connected line update requests or any redirecting party
176 update requests it may receive on this dial attempt.</para>
179 <para>Ring instead of playing MOH. Periodic Announcements are still made, if applicable.</para>
182 <para>Ring instead of playing MOH when a member channel is actually ringing.</para>
185 <para>Allow the <emphasis>called</emphasis> user to transfer the calling user.</para>
188 <para>Allow the <emphasis>calling</emphasis> user to transfer the call.</para>
191 <para>Allow the <emphasis>called</emphasis> user to write the conversation to
192 disk via Monitor.</para>
195 <para>Allow the <emphasis>calling</emphasis> user to write the conversation to
196 disk via Monitor.</para>
199 <para>Allow the <emphasis>called</emphasis> party to enable parking of the call by sending
200 the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
203 <para>Allow the <emphasis>calling</emphasis> party to enable parking of the call by sending
204 the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
207 <para>Allow the <emphasis>called</emphasis> user to write the conversation
208 to disk via MixMonitor.</para>
211 <para>Allow the <emphasis>calling</emphasis> user to write the conversation to
212 disk via MixMonitor.</para>
216 <parameter name="URL">
217 <para><replaceable>URL</replaceable> will be sent to the called party if the channel supports it.</para>
219 <parameter name="announceoverride" />
220 <parameter name="timeout">
221 <para>Will cause the queue to fail out after a specified number of
222 seconds, checked between each <filename>queues.conf</filename> <replaceable>timeout</replaceable> and
223 <replaceable>retry</replaceable> cycle.</para>
225 <parameter name="AGI">
226 <para>Will setup an AGI script to be executed on the calling party's channel once they are
227 connected to a queue member.</para>
229 <parameter name="macro">
230 <para>Will run a macro on the calling party's channel once they are connected to a queue member.</para>
232 <parameter name="gosub">
233 <para>Will run a gosub on the calling party's channel once they are connected to a queue member.</para>
235 <parameter name="rule">
236 <para>Will cause the queue's defaultrule to be overridden by the rule specified.</para>
238 <parameter name="position">
239 <para>Attempt to enter the caller into the queue at the numerical position specified. <literal>1</literal>
240 would attempt to enter the caller at the head of the queue, and <literal>3</literal> would attempt to place
241 the caller third in the queue.</para>
245 <para>In addition to transferring the call, a call may be parked and then picked
246 up by another user.</para>
247 <para>This application will return to the dialplan if the queue does not exist, or
248 any of the join options cause the caller to not enter the queue.</para>
249 <para>This application does not automatically answer and should be preceeded
250 by an application such as Answer(), Progress(), or Ringing().</para>
251 <para>This application sets the following channel variable upon completion:</para>
253 <variable name="QUEUESTATUS">
254 <para>The status of the call as a text string.</para>
255 <value name="TIMEOUT" />
256 <value name="FULL" />
257 <value name="JOINEMPTY" />
258 <value name="LEAVEEMPTY" />
259 <value name="JOINUNAVAIL" />
260 <value name="LEAVEUNAVAIL" />
261 <value name="CONTINUE" />
266 <ref type="application">Queue</ref>
267 <ref type="application">QueueLog</ref>
268 <ref type="application">AddQueueMember</ref>
269 <ref type="application">RemoveQueueMember</ref>
270 <ref type="application">PauseQueueMember</ref>
271 <ref type="application">UnpauseQueueMember</ref>
272 <ref type="function">QUEUE_VARIABLES</ref>
273 <ref type="function">QUEUE_MEMBER</ref>
274 <ref type="function">QUEUE_MEMBER_COUNT</ref>
275 <ref type="function">QUEUE_EXISTS</ref>
276 <ref type="function">QUEUE_WAITING_COUNT</ref>
277 <ref type="function">QUEUE_MEMBER_LIST</ref>
278 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
281 <application name="AddQueueMember" language="en_US">
283 Dynamically adds queue members.
286 <parameter name="queuename" required="true" />
287 <parameter name="interface" />
288 <parameter name="penalty" />
289 <parameter name="options" />
290 <parameter name="membername" />
291 <parameter name="stateinterface" />
294 <para>Dynamically adds interface to an existing queue. If the interface is
295 already in the queue it will return an error.</para>
296 <para>This application sets the following channel variable upon completion:</para>
298 <variable name="AQMSTATUS">
299 <para>The status of the attempt to add a queue member as a text string.</para>
300 <value name="ADDED" />
301 <value name="MEMBERALREADY" />
302 <value name="NOSUCHQUEUE" />
307 <ref type="application">Queue</ref>
308 <ref type="application">QueueLog</ref>
309 <ref type="application">AddQueueMember</ref>
310 <ref type="application">RemoveQueueMember</ref>
311 <ref type="application">PauseQueueMember</ref>
312 <ref type="application">UnpauseQueueMember</ref>
313 <ref type="function">QUEUE_VARIABLES</ref>
314 <ref type="function">QUEUE_MEMBER</ref>
315 <ref type="function">QUEUE_MEMBER_COUNT</ref>
316 <ref type="function">QUEUE_EXISTS</ref>
317 <ref type="function">QUEUE_WAITING_COUNT</ref>
318 <ref type="function">QUEUE_MEMBER_LIST</ref>
319 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
322 <application name="RemoveQueueMember" language="en_US">
324 Dynamically removes queue members.
327 <parameter name="queuename" required="true" />
328 <parameter name="interface" />
331 <para>If the interface is <emphasis>NOT</emphasis> in the queue it will return an error.</para>
332 <para>This application sets the following channel variable upon completion:</para>
334 <variable name="RQMSTATUS">
335 <value name="REMOVED" />
336 <value name="NOTINQUEUE" />
337 <value name="NOSUCHQUEUE" />
338 <value name="NOTDYNAMIC" />
341 <para>Example: RemoveQueueMember(techsupport,SIP/3000)</para>
344 <ref type="application">Queue</ref>
345 <ref type="application">QueueLog</ref>
346 <ref type="application">AddQueueMember</ref>
347 <ref type="application">RemoveQueueMember</ref>
348 <ref type="application">PauseQueueMember</ref>
349 <ref type="application">UnpauseQueueMember</ref>
350 <ref type="function">QUEUE_VARIABLES</ref>
351 <ref type="function">QUEUE_MEMBER</ref>
352 <ref type="function">QUEUE_MEMBER_COUNT</ref>
353 <ref type="function">QUEUE_EXISTS</ref>
354 <ref type="function">QUEUE_WAITING_COUNT</ref>
355 <ref type="function">QUEUE_MEMBER_LIST</ref>
356 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
359 <application name="PauseQueueMember" language="en_US">
361 Pauses a queue member.
364 <parameter name="queuename" />
365 <parameter name="interface" required="true" />
366 <parameter name="options" />
367 <parameter name="reason">
368 <para>Is used to add extra information to the appropriate queue_log entries and manager events.</para>
372 <para>Pauses (blocks calls for) a queue member. The given interface will be paused in the given queue.
373 This prevents any calls from being sent from the queue to the interface until it is
374 unpaused with UnpauseQueueMember or the manager interface. If no queuename is given,
375 the interface is paused in every queue it is a member of. The application will fail if the
376 interface is not found.</para>
377 <para>This application sets the following channel variable upon completion:</para>
379 <variable name="PQMSTATUS">
380 <para>The status of the attempt to pause a queue member as a text string.</para>
381 <value name="PAUSED" />
382 <value name="NOTFOUND" />
385 <para>Example: PauseQueueMember(,SIP/3000)</para>
388 <ref type="application">Queue</ref>
389 <ref type="application">QueueLog</ref>
390 <ref type="application">AddQueueMember</ref>
391 <ref type="application">RemoveQueueMember</ref>
392 <ref type="application">PauseQueueMember</ref>
393 <ref type="application">UnpauseQueueMember</ref>
394 <ref type="function">QUEUE_VARIABLES</ref>
395 <ref type="function">QUEUE_MEMBER</ref>
396 <ref type="function">QUEUE_MEMBER_COUNT</ref>
397 <ref type="function">QUEUE_EXISTS</ref>
398 <ref type="function">QUEUE_WAITING_COUNT</ref>
399 <ref type="function">QUEUE_MEMBER_LIST</ref>
400 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
403 <application name="UnpauseQueueMember" language="en_US">
405 Unpauses a queue member.
408 <parameter name="queuename" />
409 <parameter name="interface" required="true" />
410 <parameter name="options" />
411 <parameter name="reason">
412 <para>Is used to add extra information to the appropriate queue_log entries and manager events.</para>
416 <para>Unpauses (resumes calls to) a queue member. This is the counterpart to <literal>PauseQueueMember()</literal>
417 and operates exactly the same way, except it unpauses instead of pausing the given interface.</para>
418 <para>This application sets the following channel variable upon completion:</para>
420 <variable name="UPQMSTATUS">
421 <para>The status of the attempt to unpause a queue member as a text string.</para>
422 <value name="UNPAUSED" />
423 <value name="NOTFOUND" />
426 <para>Example: UnpauseQueueMember(,SIP/3000)</para>
429 <ref type="application">Queue</ref>
430 <ref type="application">QueueLog</ref>
431 <ref type="application">AddQueueMember</ref>
432 <ref type="application">RemoveQueueMember</ref>
433 <ref type="application">PauseQueueMember</ref>
434 <ref type="application">UnpauseQueueMember</ref>
435 <ref type="function">QUEUE_VARIABLES</ref>
436 <ref type="function">QUEUE_MEMBER</ref>
437 <ref type="function">QUEUE_MEMBER_COUNT</ref>
438 <ref type="function">QUEUE_EXISTS</ref>
439 <ref type="function">QUEUE_WAITING_COUNT</ref>
440 <ref type="function">QUEUE_MEMBER_LIST</ref>
441 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
444 <application name="QueueLog" language="en_US">
446 Writes to the queue_log file.
449 <parameter name="queuename" required="true" />
450 <parameter name="uniqueid" required="true" />
451 <parameter name="agent" required="true" />
452 <parameter name="event" required="true" />
453 <parameter name="additionalinfo" />
456 <para>Allows you to write your own events into the queue log.</para>
457 <para>Example: QueueLog(101,${UNIQUEID},${AGENT},WENTONBREAK,600)</para>
460 <ref type="application">Queue</ref>
461 <ref type="application">QueueLog</ref>
462 <ref type="application">AddQueueMember</ref>
463 <ref type="application">RemoveQueueMember</ref>
464 <ref type="application">PauseQueueMember</ref>
465 <ref type="application">UnpauseQueueMember</ref>
466 <ref type="function">QUEUE_VARIABLES</ref>
467 <ref type="function">QUEUE_MEMBER</ref>
468 <ref type="function">QUEUE_MEMBER_COUNT</ref>
469 <ref type="function">QUEUE_EXISTS</ref>
470 <ref type="function">QUEUE_WAITING_COUNT</ref>
471 <ref type="function">QUEUE_MEMBER_LIST</ref>
472 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
475 <function name="QUEUE_VARIABLES" language="en_US">
477 Return Queue information in variables.
480 <parameter name="queuename" required="true">
482 <enum name="QUEUEMAX">
483 <para>Maxmimum number of calls allowed.</para>
485 <enum name="QUEUESTRATEGY">
486 <para>The strategy of the queue.</para>
488 <enum name="QUEUECALLS">
489 <para>Number of calls currently in the queue.</para>
491 <enum name="QUEUEHOLDTIME">
492 <para>Current average hold time.</para>
494 <enum name="QUEUECOMPLETED">
495 <para>Number of completed calls for the queue.</para>
497 <enum name="QUEUEABANDONED">
498 <para>Number of abandoned calls.</para>
500 <enum name="QUEUESRVLEVEL">
501 <para>Queue service level.</para>
503 <enum name="QUEUESRVLEVELPERF">
504 <para>Current service level performance.</para>
510 <para>Makes the following queue variables available.</para>
511 <para>Returns <literal>0</literal> if queue is found and setqueuevar is defined, <literal>-1</literal> otherwise.</para>
514 <ref type="application">Queue</ref>
515 <ref type="application">QueueLog</ref>
516 <ref type="application">AddQueueMember</ref>
517 <ref type="application">RemoveQueueMember</ref>
518 <ref type="application">PauseQueueMember</ref>
519 <ref type="application">UnpauseQueueMember</ref>
520 <ref type="function">QUEUE_VARIABLES</ref>
521 <ref type="function">QUEUE_MEMBER</ref>
522 <ref type="function">QUEUE_MEMBER_COUNT</ref>
523 <ref type="function">QUEUE_EXISTS</ref>
524 <ref type="function">QUEUE_WAITING_COUNT</ref>
525 <ref type="function">QUEUE_MEMBER_LIST</ref>
526 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
529 <function name="QUEUE_MEMBER" language="en_US">
531 Count number of members answering a queue.
534 <parameter name="queuename" required="true" />
535 <parameter name="option" required="true">
538 <para>Returns the number of logged-in members for the specified queue.</para>
541 <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>
544 <para>Returns the number of logged-in members for the specified queue that are immediately available to answer a call.</para>
547 <para>Returns the total number of members for the specified queue.</para>
549 <enum name="penalty">
550 <para>Gets or sets queue member penalty.</para>
553 <para>Gets or sets queue member paused status.</para>
555 <enum name="ringinuse">
556 <para>Gets or sets queue member ringinuse.</para>
560 <parameter name="interface" required="false" />
563 <para>Allows access to queue counts [R] and member information [R/W].</para>
565 <replaceable>queuename</replaceable> is required for all operations
566 <replaceable>interface</replaceable> is required for all member operations.
570 <ref type="application">Queue</ref>
571 <ref type="application">QueueLog</ref>
572 <ref type="application">AddQueueMember</ref>
573 <ref type="application">RemoveQueueMember</ref>
574 <ref type="application">PauseQueueMember</ref>
575 <ref type="application">UnpauseQueueMember</ref>
576 <ref type="function">QUEUE_VARIABLES</ref>
577 <ref type="function">QUEUE_MEMBER</ref>
578 <ref type="function">QUEUE_MEMBER_COUNT</ref>
579 <ref type="function">QUEUE_EXISTS</ref>
580 <ref type="function">QUEUE_WAITING_COUNT</ref>
581 <ref type="function">QUEUE_MEMBER_LIST</ref>
582 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
585 <function name="QUEUE_MEMBER_COUNT" language="en_US">
587 Count number of members answering a queue.
590 <parameter name="queuename" required="true" />
593 <para>Returns the number of members currently associated with the specified <replaceable>queuename</replaceable>.</para>
594 <warning><para>This function has been deprecated in favor of the <literal>QUEUE_MEMBER()</literal> function</para></warning>
597 <ref type="application">Queue</ref>
598 <ref type="application">QueueLog</ref>
599 <ref type="application">AddQueueMember</ref>
600 <ref type="application">RemoveQueueMember</ref>
601 <ref type="application">PauseQueueMember</ref>
602 <ref type="application">UnpauseQueueMember</ref>
603 <ref type="function">QUEUE_VARIABLES</ref>
604 <ref type="function">QUEUE_MEMBER</ref>
605 <ref type="function">QUEUE_MEMBER_COUNT</ref>
606 <ref type="function">QUEUE_EXISTS</ref>
607 <ref type="function">QUEUE_WAITING_COUNT</ref>
608 <ref type="function">QUEUE_MEMBER_LIST</ref>
609 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
612 <function name="QUEUE_EXISTS" language="en_US">
614 Check if a named queue exists on this server
617 <parameter name="queuename" />
620 <para>Returns 1 if the specified queue exists, 0 if it does not</para>
623 <ref type="application">Queue</ref>
624 <ref type="application">QueueLog</ref>
625 <ref type="application">AddQueueMember</ref>
626 <ref type="application">RemoveQueueMember</ref>
627 <ref type="application">PauseQueueMember</ref>
628 <ref type="application">UnpauseQueueMember</ref>
629 <ref type="function">QUEUE_VARIABLES</ref>
630 <ref type="function">QUEUE_MEMBER</ref>
631 <ref type="function">QUEUE_MEMBER_COUNT</ref>
632 <ref type="function">QUEUE_EXISTS</ref>
633 <ref type="function">QUEUE_WAITING_COUNT</ref>
634 <ref type="function">QUEUE_MEMBER_LIST</ref>
635 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
638 <function name="QUEUE_WAITING_COUNT" language="en_US">
640 Count number of calls currently waiting in a queue.
643 <parameter name="queuename" />
646 <para>Returns the number of callers currently waiting in the specified <replaceable>queuename</replaceable>.</para>
649 <ref type="application">Queue</ref>
650 <ref type="application">QueueLog</ref>
651 <ref type="application">AddQueueMember</ref>
652 <ref type="application">RemoveQueueMember</ref>
653 <ref type="application">PauseQueueMember</ref>
654 <ref type="application">UnpauseQueueMember</ref>
655 <ref type="function">QUEUE_VARIABLES</ref>
656 <ref type="function">QUEUE_MEMBER</ref>
657 <ref type="function">QUEUE_MEMBER_COUNT</ref>
658 <ref type="function">QUEUE_EXISTS</ref>
659 <ref type="function">QUEUE_WAITING_COUNT</ref>
660 <ref type="function">QUEUE_MEMBER_LIST</ref>
661 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
664 <function name="QUEUE_MEMBER_LIST" language="en_US">
666 Returns a list of interfaces on a queue.
669 <parameter name="queuename" required="true" />
672 <para>Returns a comma-separated list of members associated with the specified <replaceable>queuename</replaceable>.</para>
675 <ref type="application">Queue</ref>
676 <ref type="application">QueueLog</ref>
677 <ref type="application">AddQueueMember</ref>
678 <ref type="application">RemoveQueueMember</ref>
679 <ref type="application">PauseQueueMember</ref>
680 <ref type="application">UnpauseQueueMember</ref>
681 <ref type="function">QUEUE_VARIABLES</ref>
682 <ref type="function">QUEUE_MEMBER</ref>
683 <ref type="function">QUEUE_MEMBER_COUNT</ref>
684 <ref type="function">QUEUE_EXISTS</ref>
685 <ref type="function">QUEUE_WAITING_COUNT</ref>
686 <ref type="function">QUEUE_MEMBER_LIST</ref>
687 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
690 <function name="QUEUE_MEMBER_PENALTY" language="en_US">
692 Gets or sets queue members penalty.
695 <parameter name="queuename" required="true" />
696 <parameter name="interface" required="true" />
699 <para>Gets or sets queue members penalty.</para>
700 <warning><para>This function has been deprecated in favor of the <literal>QUEUE_MEMBER()</literal> function</para></warning>
703 <ref type="application">Queue</ref>
704 <ref type="application">QueueLog</ref>
705 <ref type="application">AddQueueMember</ref>
706 <ref type="application">RemoveQueueMember</ref>
707 <ref type="application">PauseQueueMember</ref>
708 <ref type="application">UnpauseQueueMember</ref>
709 <ref type="function">QUEUE_VARIABLES</ref>
710 <ref type="function">QUEUE_MEMBER</ref>
711 <ref type="function">QUEUE_MEMBER_COUNT</ref>
712 <ref type="function">QUEUE_EXISTS</ref>
713 <ref type="function">QUEUE_WAITING_COUNT</ref>
714 <ref type="function">QUEUE_MEMBER_LIST</ref>
715 <ref type="function">QUEUE_MEMBER_PENALTY</ref>
718 <manager name="Queues" language="en_US">
727 <manager name="QueueStatus" language="en_US">
732 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
733 <parameter name="Queue" />
734 <parameter name="Member" />
739 <manager name="QueueSummary" language="en_US">
744 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
745 <parameter name="Queue" />
750 <manager name="QueueAdd" language="en_US">
752 Add interface to queue.
755 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
756 <parameter name="Queue" required="true" />
757 <parameter name="Interface" required="true" />
758 <parameter name="Penalty" />
759 <parameter name="Paused" />
760 <parameter name="MemberName" />
761 <parameter name="StateInterface" />
766 <manager name="QueueRemove" language="en_US">
768 Remove interface from queue.
771 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
772 <parameter name="Queue" required="true" />
773 <parameter name="Interface" required="true" />
778 <manager name="QueuePause" language="en_US">
780 Makes a queue member temporarily unavailable.
783 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
784 <parameter name="Interface" required="true" />
785 <parameter name="Paused" required="true" />
786 <parameter name="Queue" />
787 <parameter name="Reason" />
792 <manager name="QueueLog" language="en_US">
794 Adds custom entry in queue_log.
797 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
798 <parameter name="Queue" required="true" />
799 <parameter name="Event" required="true" />
800 <parameter name="Uniqueid" />
801 <parameter name="Interface" />
802 <parameter name="Message" />
807 <manager name="QueuePenalty" language="en_US">
809 Set the penalty for a queue member.
812 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
813 <parameter name="Interface" required="true" />
814 <parameter name="Penalty" required="true" />
815 <parameter name="Queue" />
821 <manager name="QueueMemberRingInUse" language="en_US">
823 Set the ringinuse value for a queue member.
826 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
827 <parameter name="Interface" required="true" />
828 <parameter name="RingInUse" required="true" />
829 <parameter name="Queue" />
835 <manager name="QueueRule" language="en_US">
840 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
841 <parameter name="Rule" />
846 <manager name="QueueReload" language="en_US">
848 Reload a queue, queues, or any sub-section of a queue or queues.
851 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
852 <parameter name="Queue" />
853 <parameter name="Members">
859 <parameter name="Rules">
865 <parameter name="Parameters">
875 <manager name="QueueReset" language="en_US">
877 Reset queue statistics.
880 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
881 <parameter name="Queue" />
889 OPT_MARK_AS_ANSWERED = (1 << 0),
890 OPT_GO_ON = (1 << 1),
891 OPT_DATA_QUALITY = (1 << 2),
892 OPT_CALLEE_GO_ON = (1 << 3),
893 OPT_CALLEE_HANGUP = (1 << 4),
894 OPT_CALLER_HANGUP = (1 << 5),
895 OPT_IGNORE_CALL_FW = (1 << 6),
896 OPT_IGNORE_CONNECTEDLINE = (1 << 7),
897 OPT_CALLEE_PARK = (1 << 8),
898 OPT_CALLER_PARK = (1 << 9),
899 OPT_NO_RETRY = (1 << 10),
900 OPT_RINGING = (1 << 11),
901 OPT_RING_WHEN_RINGING = (1 << 12),
902 OPT_CALLEE_TRANSFER = (1 << 13),
903 OPT_CALLER_TRANSFER = (1 << 14),
904 OPT_CALLEE_AUTOMIXMON = (1 << 15),
905 OPT_CALLER_AUTOMIXMON = (1 << 16),
906 OPT_CALLEE_AUTOMON = (1 << 17),
907 OPT_CALLER_AUTOMON = (1 << 18),
911 OPT_ARG_CALLEE_GO_ON = 0,
912 /* note: this entry _MUST_ be the last one in the enum */
916 AST_APP_OPTIONS(queue_exec_options, BEGIN_OPTIONS
917 AST_APP_OPTION('C', OPT_MARK_AS_ANSWERED),
918 AST_APP_OPTION('c', OPT_GO_ON),
919 AST_APP_OPTION('d', OPT_DATA_QUALITY),
920 AST_APP_OPTION_ARG('F', OPT_CALLEE_GO_ON, OPT_ARG_CALLEE_GO_ON),
921 AST_APP_OPTION('h', OPT_CALLEE_HANGUP),
922 AST_APP_OPTION('H', OPT_CALLER_HANGUP),
923 AST_APP_OPTION('i', OPT_IGNORE_CALL_FW),
924 AST_APP_OPTION('I', OPT_IGNORE_CONNECTEDLINE),
925 AST_APP_OPTION('k', OPT_CALLEE_PARK),
926 AST_APP_OPTION('K', OPT_CALLER_PARK),
927 AST_APP_OPTION('n', OPT_NO_RETRY),
928 AST_APP_OPTION('r', OPT_RINGING),
929 AST_APP_OPTION('R', OPT_RING_WHEN_RINGING),
930 AST_APP_OPTION('t', OPT_CALLEE_TRANSFER),
931 AST_APP_OPTION('T', OPT_CALLER_TRANSFER),
932 AST_APP_OPTION('x', OPT_CALLEE_AUTOMIXMON),
933 AST_APP_OPTION('X', OPT_CALLER_AUTOMIXMON),
934 AST_APP_OPTION('w', OPT_CALLEE_AUTOMON),
935 AST_APP_OPTION('W', OPT_CALLER_AUTOMON),
939 QUEUE_STRATEGY_RINGALL = 0,
940 QUEUE_STRATEGY_LEASTRECENT,
941 QUEUE_STRATEGY_FEWESTCALLS,
942 QUEUE_STRATEGY_RANDOM,
943 QUEUE_STRATEGY_RRMEMORY,
944 QUEUE_STRATEGY_LINEAR,
945 QUEUE_STRATEGY_WRANDOM,
946 QUEUE_STRATEGY_RRORDERED,
950 QUEUE_AUTOPAUSE_OFF = 0,
955 enum queue_reload_mask {
956 QUEUE_RELOAD_PARAMETERS = (1 << 0),
957 QUEUE_RELOAD_MEMBER = (1 << 1),
958 QUEUE_RELOAD_RULES = (1 << 2),
959 QUEUE_RESET_STATS = (1 << 3),
962 static const struct strategy {
966 { QUEUE_STRATEGY_RINGALL, "ringall" },
967 { QUEUE_STRATEGY_LEASTRECENT, "leastrecent" },
968 { QUEUE_STRATEGY_FEWESTCALLS, "fewestcalls" },
969 { QUEUE_STRATEGY_RANDOM, "random" },
970 { QUEUE_STRATEGY_RRMEMORY, "rrmemory" },
971 { QUEUE_STRATEGY_RRMEMORY, "roundrobin" },
972 { QUEUE_STRATEGY_LINEAR, "linear" },
973 { QUEUE_STRATEGY_WRANDOM, "wrandom"},
974 { QUEUE_STRATEGY_RRORDERED, "rrordered"},
977 static const struct autopause {
980 } autopausesmodes [] = {
981 { QUEUE_AUTOPAUSE_OFF,"no" },
982 { QUEUE_AUTOPAUSE_ON, "yes" },
983 { QUEUE_AUTOPAUSE_ALL,"all" },
987 static struct ast_taskprocessor *devicestate_tps;
989 #define DEFAULT_RETRY 5
990 #define DEFAULT_TIMEOUT 15
991 #define RECHECK 1 /*!< Recheck every second to see we we're at the top yet */
992 #define MAX_PERIODIC_ANNOUNCEMENTS 10 /*!< The maximum periodic announcements we can have */
993 #define DEFAULT_MIN_ANNOUNCE_FREQUENCY 15 /*!< The minimum number of seconds between position announcements \
994 The default value of 15 provides backwards compatibility */
995 #define MAX_QUEUE_BUCKETS 53
997 #define RES_OKAY 0 /*!< Action completed */
998 #define RES_EXISTS (-1) /*!< Entry already exists */
999 #define RES_OUTOFMEMORY (-2) /*!< Out of memory */
1000 #define RES_NOSUCHQUEUE (-3) /*!< No such queue */
1001 #define RES_NOT_DYNAMIC (-4) /*!< Member is not dynamic */
1003 static char *app = "Queue";
1005 static char *app_aqm = "AddQueueMember" ;
1007 static char *app_rqm = "RemoveQueueMember" ;
1009 static char *app_pqm = "PauseQueueMember" ;
1011 static char *app_upqm = "UnpauseQueueMember" ;
1013 static char *app_ql = "QueueLog" ;
1015 /*! \brief Persistent Members astdb family */
1016 static const char * const pm_family = "Queue/PersistentMembers";
1017 /* The maximum length of each persistent member queue database entry */
1018 #define PM_MAX_LEN 8192
1020 /*! \brief queues.conf [general] option */
1021 static int queue_persistent_members = 0;
1023 /*! \brief queues.conf per-queue weight option */
1024 static int use_weight = 0;
1026 /*! \brief queues.conf [general] option */
1027 static int autofill_default = 1;
1029 /*! \brief queues.conf [general] option */
1030 static int montype_default = 0;
1032 /*! \brief queues.conf [general] option */
1033 static int shared_lastcall = 1;
1035 /*! \brief Subscription to device state change events */
1036 static struct ast_event_sub *device_state_sub;
1038 /*! \brief queues.conf [general] option */
1039 static int update_cdr = 0;
1041 /*! \brief queues.conf [general] option */
1042 static int negative_penalty_invalid = 0;
1044 /*! \brief queues.conf [general] option */
1045 static int log_membername_as_agent = 0;
1047 /*! \brief queues.conf [general] option */
1048 static int check_state_unknown = 0;
1050 /*! \brief name of the ringinuse field in the realtime database */
1051 static char *realtime_ringinuse_field;
1056 QUEUE_JOINEMPTY = 2,
1057 QUEUE_LEAVEEMPTY = 3,
1058 QUEUE_JOINUNAVAIL = 4,
1059 QUEUE_LEAVEUNAVAIL = 5,
1064 static const struct {
1065 enum queue_result id;
1067 } queue_results[] = {
1068 { QUEUE_UNKNOWN, "UNKNOWN" },
1069 { QUEUE_TIMEOUT, "TIMEOUT" },
1070 { QUEUE_JOINEMPTY,"JOINEMPTY" },
1071 { QUEUE_LEAVEEMPTY, "LEAVEEMPTY" },
1072 { QUEUE_JOINUNAVAIL, "JOINUNAVAIL" },
1073 { QUEUE_LEAVEUNAVAIL, "LEAVEUNAVAIL" },
1074 { QUEUE_FULL, "FULL" },
1075 { QUEUE_CONTINUE, "CONTINUE" },
1078 enum queue_timeout_priority {
1079 TIMEOUT_PRIORITY_APP,
1080 TIMEOUT_PRIORITY_CONF,
1083 /*! \brief We define a custom "local user" structure because we
1084 * use it not only for keeping track of what is in use but
1085 * also for keeping track of who we're dialing.
1087 * There are two "links" defined in this structure, q_next and call_next.
1088 * q_next links ALL defined callattempt structures into a linked list. call_next is
1089 * a link which allows for a subset of the callattempts to be traversed. This subset
1090 * is used in wait_for_answer so that irrelevant callattempts are not traversed. This
1091 * also is helpful so that queue logs are always accurate in the case where a call to
1092 * a member times out, especially if using the ringall strategy.
1095 struct callattempt {
1096 struct callattempt *q_next;
1097 struct callattempt *call_next;
1098 struct ast_channel *chan;
1099 char interface[256]; /*!< An Asterisk dial string (not a channel name) */
1102 struct call_queue *lastqueue;
1103 struct member *member;
1104 /*! Saved connected party info from an AST_CONTROL_CONNECTED_LINE. */
1105 struct ast_party_connected_line connected;
1106 /*! TRUE if an AST_CONTROL_CONNECTED_LINE update was saved to the connected element. */
1107 unsigned int pending_connected_update:1;
1108 /*! TRUE if the connected line update is blocked. */
1109 unsigned int block_connected_update:1;
1110 /*! TRUE if caller id is not available for connected line */
1111 unsigned int dial_callerid_absent:1;
1112 /*! TRUE if the call is still active */
1113 unsigned int stillgoing:1;
1114 struct ast_aoc_decoded *aoc_s_rate_list;
1119 struct call_queue *parent; /*!< What queue is our parent */
1120 char moh[MAX_MUSICCLASS]; /*!< Name of musiconhold to be used */
1121 char announce[PATH_MAX]; /*!< Announcement to play for member when call is answered */
1122 char context[AST_MAX_CONTEXT]; /*!< Context when user exits queue */
1123 char digits[AST_MAX_EXTENSION]; /*!< Digits entered while in queue */
1124 int valid_digits; /*!< Digits entered correspond to valid extension. Exited */
1125 int pos; /*!< Where we are in the queue */
1126 int prio; /*!< Our priority */
1127 int last_pos_said; /*!< Last position we told the user */
1128 int ring_when_ringing; /*!< Should we only use ring indication when a channel is ringing? */
1129 time_t last_periodic_announce_time; /*!< The last time we played a periodic announcement */
1130 int last_periodic_announce_sound; /*!< The last periodic announcement we made */
1131 time_t last_pos; /*!< Last time we told the user their position */
1132 int opos; /*!< Where we started in the queue */
1133 int handled; /*!< Whether our call was handled */
1134 int pending; /*!< Non-zero if we are attempting to call a member */
1135 int max_penalty; /*!< Limit the members that can take this call to this penalty or lower */
1136 int min_penalty; /*!< Limit the members that can take this call to this penalty or higher */
1137 int linpos; /*!< If using linear strategy, what position are we at? */
1138 int linwrapped; /*!< Is the linpos wrapped? */
1139 time_t start; /*!< When we started holding */
1140 time_t expire; /*!< When this entry should expire (time out of queue) */
1141 int cancel_answered_elsewhere; /*!< Whether we should force the CAE flag on this call (C) option*/
1142 struct ast_channel *chan; /*!< Our channel */
1143 AST_LIST_HEAD_NOLOCK(,penalty_rule) qe_rules; /*!< Local copy of the queue's penalty rules */
1144 struct penalty_rule *pr; /*!< Pointer to the next penalty rule to implement */
1145 struct queue_ent *next; /*!< The next queue entry */
1149 char interface[AST_CHANNEL_NAME]; /*!< Technology/Location to dial to reach this member*/
1150 char state_exten[AST_MAX_EXTENSION]; /*!< Extension to get state from (if using hint) */
1151 char state_context[AST_MAX_CONTEXT]; /*!< Context to use when getting state (if using hint) */
1152 char state_interface[AST_CHANNEL_NAME]; /*!< Technology/Location from which to read devicestate changes */
1153 char membername[80]; /*!< Member name to use in queue logs */
1154 int penalty; /*!< Are we a last resort? */
1155 int calls; /*!< Number of calls serviced by this member */
1156 int dynamic; /*!< Are we dynamically added? */
1157 int realtime; /*!< Is this member realtime? */
1158 int status; /*!< Status of queue member */
1159 int paused; /*!< Are we paused (not accepting calls)? */
1160 time_t lastcall; /*!< When last successful call was hungup */
1161 struct call_queue *lastqueue; /*!< Last queue we received a call */
1162 unsigned int dead:1; /*!< Used to detect members deleted in realtime */
1163 unsigned int delme:1; /*!< Flag to delete entry on reload */
1164 char rt_uniqueid[80]; /*!< Unique id of realtime member entry */
1165 unsigned int ringinuse:1; /*!< Flag to ring queue members even if their status is 'inuse' */
1168 enum empty_conditions {
1169 QUEUE_EMPTY_PENALTY = (1 << 0),
1170 QUEUE_EMPTY_PAUSED = (1 << 1),
1171 QUEUE_EMPTY_INUSE = (1 << 2),
1172 QUEUE_EMPTY_RINGING = (1 << 3),
1173 QUEUE_EMPTY_UNAVAILABLE = (1 << 4),
1174 QUEUE_EMPTY_INVALID = (1 << 5),
1175 QUEUE_EMPTY_UNKNOWN = (1 << 6),
1176 QUEUE_EMPTY_WRAPUP = (1 << 7),
1179 enum member_properties {
1181 MEMBER_RINGINUSE = 1,
1184 /* values used in multi-bit flags in call_queue */
1185 #define ANNOUNCEHOLDTIME_ALWAYS 1
1186 #define ANNOUNCEHOLDTIME_ONCE 2
1187 #define QUEUE_EVENT_VARIABLES 3
1189 struct penalty_rule {
1190 int time; /*!< Number of seconds that need to pass before applying this rule */
1191 int max_value; /*!< The amount specified in the penalty rule for max penalty */
1192 int min_value; /*!< The amount specified in the penalty rule for min penalty */
1193 int max_relative; /*!< Is the max adjustment relative? 1 for relative, 0 for absolute */
1194 int min_relative; /*!< Is the min adjustment relative? 1 for relative, 0 for absolute */
1195 AST_LIST_ENTRY(penalty_rule) list; /*!< Next penalty_rule */
1198 #define ANNOUNCEPOSITION_YES 1 /*!< We announce position */
1199 #define ANNOUNCEPOSITION_NO 2 /*!< We don't announce position */
1200 #define ANNOUNCEPOSITION_MORE_THAN 3 /*!< We say "Currently there are more than <limit>" */
1201 #define ANNOUNCEPOSITION_LIMIT 4 /*!< We not announce position more than <limit> */
1204 AST_DECLARE_STRING_FIELDS(
1206 AST_STRING_FIELD(name);
1207 /*! Music on Hold class */
1208 AST_STRING_FIELD(moh);
1209 /*! Announcement to play when call is answered */
1210 AST_STRING_FIELD(announce);
1212 AST_STRING_FIELD(context);
1213 /*! Macro to run upon member connection */
1214 AST_STRING_FIELD(membermacro);
1215 /*! Gosub to run upon member connection */
1216 AST_STRING_FIELD(membergosub);
1217 /*! Default rule to use if none specified in call to Queue() */
1218 AST_STRING_FIELD(defaultrule);
1219 /*! Sound file: "Your call is now first in line" (def. queue-youarenext) */
1220 AST_STRING_FIELD(sound_next);
1221 /*! Sound file: "There are currently" (def. queue-thereare) */
1222 AST_STRING_FIELD(sound_thereare);
1223 /*! Sound file: "calls waiting to speak to a representative." (def. queue-callswaiting) */
1224 AST_STRING_FIELD(sound_calls);
1225 /*! Sound file: "Currently there are more than" (def. queue-quantity1) */
1226 AST_STRING_FIELD(queue_quantity1);
1227 /*! Sound file: "callers waiting to speak with a representative" (def. queue-quantity2) */
1228 AST_STRING_FIELD(queue_quantity2);
1229 /*! Sound file: "The current estimated total holdtime is" (def. queue-holdtime) */
1230 AST_STRING_FIELD(sound_holdtime);
1231 /*! Sound file: "minutes." (def. queue-minutes) */
1232 AST_STRING_FIELD(sound_minutes);
1233 /*! Sound file: "minute." (def. queue-minute) */
1234 AST_STRING_FIELD(sound_minute);
1235 /*! Sound file: "seconds." (def. queue-seconds) */
1236 AST_STRING_FIELD(sound_seconds);
1237 /*! Sound file: "Thank you for your patience." (def. queue-thankyou) */
1238 AST_STRING_FIELD(sound_thanks);
1239 /*! Sound file: Custom announce for caller, no default */
1240 AST_STRING_FIELD(sound_callerannounce);
1241 /*! Sound file: "Hold time" (def. queue-reporthold) */
1242 AST_STRING_FIELD(sound_reporthold);
1244 /*! Sound files: Custom announce, no default */
1245 struct ast_str *sound_periodicannounce[MAX_PERIODIC_ANNOUNCEMENTS];
1246 unsigned int dead:1;
1247 unsigned int eventwhencalled:2;
1248 unsigned int ringinuse:1;
1249 unsigned int setinterfacevar:1;
1250 unsigned int setqueuevar:1;
1251 unsigned int setqueueentryvar:1;
1252 unsigned int reportholdtime:1;
1253 unsigned int wrapped:1;
1254 unsigned int timeoutrestart:1;
1255 unsigned int announceholdtime:2;
1256 unsigned int announceposition:3;
1258 unsigned int maskmemberstatus:1;
1259 unsigned int realtime:1;
1260 unsigned int found:1;
1261 unsigned int relativeperiodicannounce:1;
1262 unsigned int autopausebusy:1;
1263 unsigned int autopauseunavail:1;
1264 enum empty_conditions joinempty;
1265 enum empty_conditions leavewhenempty;
1266 int announcepositionlimit; /*!< How many positions we announce? */
1267 int announcefrequency; /*!< How often to announce their position */
1268 int minannouncefrequency; /*!< The minimum number of seconds between position announcements (def. 15) */
1269 int periodicannouncefrequency; /*!< How often to play periodic announcement */
1270 int numperiodicannounce; /*!< The number of periodic announcements configured */
1271 int randomperiodicannounce; /*!< Are periodic announcments randomly chosen */
1272 int roundingseconds; /*!< How many seconds do we round to? */
1273 int holdtime; /*!< Current avg holdtime, based on an exponential average */
1274 int talktime; /*!< Current avg talktime, based on the same exponential average */
1275 int callscompleted; /*!< Number of queue calls completed */
1276 int callsabandoned; /*!< Number of queue calls abandoned */
1277 int servicelevel; /*!< seconds setting for servicelevel*/
1278 int callscompletedinsl; /*!< Number of calls answered with servicelevel*/
1279 char monfmt[8]; /*!< Format to use when recording calls */
1280 int montype; /*!< Monitor type Monitor vs. MixMonitor */
1281 int count; /*!< How many entries */
1282 int maxlen; /*!< Max number of entries */
1283 int wrapuptime; /*!< Wrapup Time */
1284 int penaltymemberslimit; /*!< Disregard penalty when queue has fewer than this many members */
1286 int retry; /*!< Retry calling everyone after this amount of time */
1287 int timeout; /*!< How long to wait for an answer */
1288 int weight; /*!< Respective weight */
1289 int autopause; /*!< Auto pause queue members if they fail to answer */
1290 int autopausedelay; /*!< Delay auto pause for autopausedelay seconds since last call */
1291 int timeoutpriority; /*!< Do we allow a fraction of the timeout to occur for a ring? */
1293 /* Queue strategy things */
1294 int rrpos; /*!< Round Robin - position */
1295 int memberdelay; /*!< Seconds to delay connecting member to caller */
1296 int autofill; /*!< Ignore the head call status and ring an available agent */
1298 struct ao2_container *members; /*!< Head of the list of members */
1299 struct queue_ent *head; /*!< Head of the list of callers */
1300 AST_LIST_ENTRY(call_queue) list; /*!< Next call queue */
1301 AST_LIST_HEAD_NOLOCK(, penalty_rule) rules; /*!< The list of penalty rules to invoke */
1306 AST_LIST_HEAD_NOLOCK(,penalty_rule) rules;
1307 AST_LIST_ENTRY(rule_list) list;
1310 static AST_LIST_HEAD_STATIC(rule_lists, rule_list);
1312 static struct ao2_container *queues;
1314 static void update_realtime_members(struct call_queue *q);
1315 static struct member *interface_exists(struct call_queue *q, const char *interface);
1316 static int set_member_paused(const char *queuename, const char *interface, const char *reason, int paused);
1318 static void queue_transfer_fixup(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan);
1320 static struct member *find_member_by_queuename_and_interface(const char *queuename, const char *interface);
1321 /*! \brief sets the QUEUESTATUS channel variable */
1322 static void set_queue_result(struct ast_channel *chan, enum queue_result res)
1326 for (i = 0; i < ARRAY_LEN(queue_results); i++) {
1327 if (queue_results[i].id == res) {
1328 pbx_builtin_setvar_helper(chan, "QUEUESTATUS", queue_results[i].text);
1334 static const char *int2strat(int strategy)
1338 for (x = 0; x < ARRAY_LEN(strategies); x++) {
1339 if (strategy == strategies[x].strategy) {
1340 return strategies[x].name;
1347 static int strat2int(const char *strategy)
1351 for (x = 0; x < ARRAY_LEN(strategies); x++) {
1352 if (!strcasecmp(strategy, strategies[x].name)) {
1353 return strategies[x].strategy;
1360 static int autopause2int(const char *autopause)
1363 /*This 'double check' that default value is OFF */
1364 if (ast_strlen_zero(autopause)) {
1365 return QUEUE_AUTOPAUSE_OFF;
1368 /*This 'double check' is to ensure old values works */
1369 if(ast_true(autopause)) {
1370 return QUEUE_AUTOPAUSE_ON;
1373 for (x = 0; x < ARRAY_LEN(autopausesmodes); x++) {
1374 if (!strcasecmp(autopause, autopausesmodes[x].name)) {
1375 return autopausesmodes[x].autopause;
1379 /*This 'double check' that default value is OFF */
1380 return QUEUE_AUTOPAUSE_OFF;
1383 static int queue_hash_cb(const void *obj, const int flags)
1385 const struct call_queue *q = obj;
1387 return ast_str_case_hash(q->name);
1390 static int queue_cmp_cb(void *obj, void *arg, int flags)
1392 struct call_queue *q = obj, *q2 = arg;
1393 return !strcasecmp(q->name, q2->name) ? CMP_MATCH | CMP_STOP : 0;
1396 #ifdef REF_DEBUG_ONLY_QUEUES
1397 #define queue_ref(q) _queue_ref(q, "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1398 #define queue_unref(q) _queue_unref(q, "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1399 #define queue_t_ref(q, tag) _queue_ref(q, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1400 #define queue_t_unref(q, tag) _queue_unref(q, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1401 #define queues_t_link(c, q, tag) __ao2_link_debug(c, q, 0, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1402 #define queues_t_unlink(c, q, tag) __ao2_unlink_debug(c, q, 0, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1404 static inline struct call_queue *_queue_ref(struct call_queue *q, const char *tag, const char *file, int line, const char *filename)
1406 __ao2_ref_debug(q, 1, tag, file, line, filename);
1410 static inline struct call_queue *_queue_unref(struct call_queue *q, const char *tag, const char *file, int line, const char *filename)
1412 __ao2_ref_debug(q, -1, tag, file, line, filename);
1418 #define queue_t_ref(q, tag) queue_ref(q)
1419 #define queue_t_unref(q, tag) queue_unref(q)
1420 #define queues_t_link(c, q, tag) ao2_t_link(c, q, tag)
1421 #define queues_t_unlink(c, q, tag) ao2_t_unlink(c, q, tag)
1423 static inline struct call_queue *queue_ref(struct call_queue *q)
1429 static inline struct call_queue *queue_unref(struct call_queue *q)
1436 /*! \brief Set variables of queue */
1437 static void set_queue_variables(struct call_queue *q, struct ast_channel *chan)
1439 char interfacevar[256]="";
1444 if (q->setqueuevar) {
1446 if (q->callscompleted > 0) {
1447 sl = 100 * ((float) q->callscompletedinsl / (float) q->callscompleted);
1450 snprintf(interfacevar, sizeof(interfacevar),
1451 "QUEUENAME=%s,QUEUEMAX=%d,QUEUESTRATEGY=%s,QUEUECALLS=%d,QUEUEHOLDTIME=%d,QUEUETALKTIME=%d,QUEUECOMPLETED=%d,QUEUEABANDONED=%d,QUEUESRVLEVEL=%d,QUEUESRVLEVELPERF=%2.1f",
1452 q->name, q->maxlen, int2strat(q->strategy), q->count, q->holdtime, q->talktime, q->callscompleted, q->callsabandoned, q->servicelevel, sl);
1456 pbx_builtin_setvar_multiple(chan, interfacevar);
1462 /*! \brief Insert the 'new' entry after the 'prev' entry of queue 'q' */
1463 static inline void insert_entry(struct call_queue *q, struct queue_ent *prev, struct queue_ent *new, int *pos)
1465 struct queue_ent *cur;
1478 /* every queue_ent must have a reference to it's parent call_queue, this
1479 * reference does not go away until the end of the queue_ent's life, meaning
1480 * that even when the queue_ent leaves the call_queue this ref must remain. */
1483 new->pos = ++(*pos);
1487 /*! \brief Check if members are available
1489 * This function checks to see if members are available to be called. If any member
1490 * is available, the function immediately returns 0. If no members are available,
1491 * then -1 is returned.
1493 static int get_member_status(struct call_queue *q, int max_penalty, int min_penalty, enum empty_conditions conditions)
1495 struct member *member;
1496 struct ao2_iterator mem_iter;
1499 mem_iter = ao2_iterator_init(q->members, 0);
1500 for (; (member = ao2_iterator_next(&mem_iter)); ao2_ref(member, -1)) {
1501 if ((max_penalty && (member->penalty > max_penalty)) || (min_penalty && (member->penalty < min_penalty))) {
1502 if (conditions & QUEUE_EMPTY_PENALTY) {
1503 ast_debug(4, "%s is unavailable because his penalty is not between %d and %d\n", member->membername, min_penalty, max_penalty);
1508 switch (member->status) {
1509 case AST_DEVICE_INVALID:
1510 if (conditions & QUEUE_EMPTY_INVALID) {
1511 ast_debug(4, "%s is unavailable because his device state is 'invalid'\n", member->membername);
1515 case AST_DEVICE_UNAVAILABLE:
1516 if (conditions & QUEUE_EMPTY_UNAVAILABLE) {
1517 ast_debug(4, "%s is unavailable because his device state is 'unavailable'\n", member->membername);
1521 case AST_DEVICE_INUSE:
1522 if (conditions & QUEUE_EMPTY_INUSE) {
1523 ast_debug(4, "%s is unavailable because his device state is 'inuse'\n", member->membername);
1527 case AST_DEVICE_RINGING:
1528 if (conditions & QUEUE_EMPTY_RINGING) {
1529 ast_debug(4, "%s is unavailable because his device state is 'ringing'\n", member->membername);
1533 case AST_DEVICE_UNKNOWN:
1534 if (conditions & QUEUE_EMPTY_UNKNOWN) {
1535 ast_debug(4, "%s is unavailable because his device state is 'unknown'\n", member->membername);
1541 if (member->paused && (conditions & QUEUE_EMPTY_PAUSED)) {
1542 ast_debug(4, "%s is unavailable because he is paused'\n", member->membername);
1544 } else if ((conditions & QUEUE_EMPTY_WRAPUP) && member->lastcall && q->wrapuptime && (time(NULL) - q->wrapuptime < member->lastcall)) {
1545 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);
1548 ao2_ref(member, -1);
1549 ao2_iterator_destroy(&mem_iter);
1551 ast_debug(4, "%s is available.\n", member->membername);
1557 ao2_iterator_destroy(&mem_iter);
1563 struct statechange {
1564 AST_LIST_ENTRY(statechange) entry;
1569 /*! \brief set a member's status based on device state of that member's state_interface.
1571 * Lock interface list find sc, iterate through each queues queue_member list for member to
1572 * update state inside queues
1574 static int update_status(struct call_queue *q, struct member *m, const int status)
1578 if (q->maskmemberstatus) {
1583 <managerEventInstance>
1584 <synopsis>Raised when a Queue member's status has changed.</synopsis>
1586 <parameter name="Queue">
1587 <para>The name of the queue.</para>
1589 <parameter name="Location">
1590 <para>The queue member's channel technology or location.</para>
1592 <parameter name="MemberName">
1593 <para>The name of the queue member.</para>
1595 <parameter name="StateInterface">
1596 <para>Channel technology or location from which to read device state changes.</para>
1598 <parameter name="Membership">
1600 <enum name="dynamic"/>
1601 <enum name="realtime"/>
1602 <enum name="static"/>
1605 <parameter name="Penalty">
1606 <para>The penalty associated with the queue member.</para>
1608 <parameter name="CallsTaken">
1609 <para>The number of calls this queue member has serviced.</para>
1611 <parameter name="LastCall">
1612 <para>The time this member last took call, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
1614 <parameter name="Status">
1615 <para>The status of the queue member. This will be a device state value.</para>
1617 <parameter name="Paused">
1624 </managerEventInstance>
1626 manager_event(EVENT_FLAG_AGENT, "QueueMemberStatus",
1629 "MemberName: %s\r\n"
1630 "StateInterface: %s\r\n"
1631 "Membership: %s\r\n"
1633 "CallsTaken: %d\r\n"
1637 q->name, m->interface, m->membername, m->state_interface, m->dynamic ? "dynamic" : m->realtime ? "realtime" : "static",
1638 m->penalty, m->calls, (int)m->lastcall, m->status, m->paused
1644 /*! \brief set a member's status based on device state of that member's interface*/
1645 static int handle_statechange(void *datap)
1647 struct statechange *sc = datap;
1648 struct ao2_iterator miter, qiter;
1650 struct call_queue *q;
1651 char interface[80], *slash_pos;
1654 qiter = ao2_iterator_init(queues, 0);
1655 while ((q = ao2_t_iterator_next(&qiter, "Iterate over queues"))) {
1658 miter = ao2_iterator_init(q->members, 0);
1659 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
1660 ast_copy_string(interface, m->state_interface, sizeof(interface));
1662 if ((slash_pos = strchr(interface, '/'))) {
1663 if (!strncasecmp(interface, "Local/", 6) && (slash_pos = strchr(slash_pos + 1, '/'))) {
1668 if (!strcasecmp(interface, sc->dev)) {
1670 update_status(q, m, sc->state);
1675 ao2_iterator_destroy(&miter);
1678 queue_t_unref(q, "Done with iterator");
1680 ao2_iterator_destroy(&qiter);
1683 ast_debug(1, "Device '%s' changed to state '%d' (%s)\n", sc->dev, sc->state, ast_devstate2str(sc->state));
1685 ast_debug(3, "Device '%s' changed to state '%d' (%s) but we don't care because they're not a member of any queue.\n", sc->dev, sc->state, ast_devstate2str(sc->state));
1692 static void device_state_cb(const struct ast_event *event, void *unused)
1694 enum ast_device_state state;
1696 struct statechange *sc;
1699 state = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE);
1700 device = ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE);
1702 if (ast_strlen_zero(device)) {
1703 ast_log(LOG_ERROR, "Received invalid event that had no device IE\n");
1706 datapsize = sizeof(*sc) + strlen(device) + 1;
1707 if (!(sc = ast_calloc(1, datapsize))) {
1708 ast_log(LOG_ERROR, "failed to calloc a state change struct\n");
1712 strcpy(sc->dev, device);
1713 if (ast_taskprocessor_push(devicestate_tps, handle_statechange, sc) < 0) {
1718 /*! \brief Helper function which converts from extension state to device state values */
1719 static int extensionstate2devicestate(int state)
1722 case AST_EXTENSION_NOT_INUSE:
1723 state = AST_DEVICE_NOT_INUSE;
1725 case AST_EXTENSION_INUSE:
1726 state = AST_DEVICE_INUSE;
1728 case AST_EXTENSION_BUSY:
1729 state = AST_DEVICE_BUSY;
1731 case AST_EXTENSION_RINGING:
1732 state = AST_DEVICE_RINGING;
1734 case AST_EXTENSION_ONHOLD:
1735 state = AST_DEVICE_ONHOLD;
1737 case AST_EXTENSION_UNAVAILABLE:
1738 state = AST_DEVICE_UNAVAILABLE;
1740 case AST_EXTENSION_REMOVED:
1741 case AST_EXTENSION_DEACTIVATED:
1743 state = AST_DEVICE_INVALID;
1750 static int extension_state_cb(char *context, char *exten, struct ast_state_cb_info *info, void *data)
1752 struct ao2_iterator miter, qiter;
1754 struct call_queue *q;
1755 int state = info->exten_state;
1756 int found = 0, device_state = extensionstate2devicestate(state);
1758 /* only interested in extension state updates involving device states */
1759 if (info->reason != AST_HINT_UPDATE_DEVICE) {
1763 qiter = ao2_iterator_init(queues, 0);
1764 while ((q = ao2_t_iterator_next(&qiter, "Iterate through queues"))) {
1767 miter = ao2_iterator_init(q->members, 0);
1768 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
1769 if (!strcmp(m->state_context, context) && !strcmp(m->state_exten, exten)) {
1770 update_status(q, m, device_state);
1776 ao2_iterator_destroy(&miter);
1779 queue_t_unref(q, "Done with iterator");
1781 ao2_iterator_destroy(&qiter);
1784 ast_debug(1, "Extension '%s@%s' changed to state '%d' (%s)\n", exten, context, device_state, ast_devstate2str(device_state));
1786 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",
1787 exten, context, device_state, ast_devstate2str(device_state));
1793 /*! \brief Return the current state of a member */
1794 static int get_queue_member_status(struct member *cur)
1796 return ast_strlen_zero(cur->state_exten) ? ast_device_state(cur->state_interface) : extensionstate2devicestate(ast_extension_state(NULL, cur->state_context, cur->state_exten));
1799 /*! \brief allocate space for new queue member and set fields based on parameters passed */
1800 static struct member *create_queue_member(const char *interface, const char *membername, int penalty, int paused, const char *state_interface, int ringinuse)
1804 if ((cur = ao2_alloc(sizeof(*cur), NULL))) {
1805 cur->ringinuse = ringinuse;
1806 cur->penalty = penalty;
1807 cur->paused = paused;
1808 ast_copy_string(cur->interface, interface, sizeof(cur->interface));
1809 if (!ast_strlen_zero(state_interface)) {
1810 ast_copy_string(cur->state_interface, state_interface, sizeof(cur->state_interface));
1812 ast_copy_string(cur->state_interface, interface, sizeof(cur->state_interface));
1814 if (!ast_strlen_zero(membername)) {
1815 ast_copy_string(cur->membername, membername, sizeof(cur->membername));
1817 ast_copy_string(cur->membername, interface, sizeof(cur->membername));
1819 if (!strchr(cur->interface, '/')) {
1820 ast_log(LOG_WARNING, "No location at interface '%s'\n", interface);
1822 if (!strncmp(cur->state_interface, "hint:", 5)) {
1823 char *tmp = ast_strdupa(cur->state_interface), *context = tmp;
1824 char *exten = strsep(&context, "@") + 5;
1826 ast_copy_string(cur->state_exten, exten, sizeof(cur->state_exten));
1827 ast_copy_string(cur->state_context, S_OR(context, "default"), sizeof(cur->state_context));
1829 cur->status = get_queue_member_status(cur);
1836 static int compress_char(const char c)
1840 } else if (c > 96) {
1846 static int member_hash_fn(const void *obj, const int flags)
1848 const struct member *mem = obj;
1849 const char *interface = (flags & OBJ_KEY) ? obj : mem->interface;
1850 const char *chname = strchr(interface, '/');
1856 for (i = 0; i < 5 && chname[i]; i++) {
1857 ret += compress_char(chname[i]) << (i * 6);
1862 static int member_cmp_fn(void *obj1, void *obj2, int flags)
1864 struct member *mem1 = obj1;
1865 struct member *mem2 = obj2;
1866 const char *interface = (flags & OBJ_KEY) ? obj2 : mem2->interface;
1868 return strcasecmp(mem1->interface, interface) ? 0 : CMP_MATCH | CMP_STOP;
1872 * \brief Initialize Queue default values.
1873 * \note the queue's lock must be held before executing this function
1875 static void init_queue(struct call_queue *q)
1878 struct penalty_rule *pr_iter;
1881 q->retry = DEFAULT_RETRY;
1882 q->timeout = DEFAULT_TIMEOUT;
1884 q->announcefrequency = 0;
1885 q->minannouncefrequency = DEFAULT_MIN_ANNOUNCE_FREQUENCY;
1886 q->announceholdtime = 1;
1887 q->announcepositionlimit = 10; /* Default 10 positions */
1888 q->announceposition = ANNOUNCEPOSITION_YES; /* Default yes */
1889 q->roundingseconds = 0; /* Default - don't announce seconds */
1890 q->servicelevel = 0;
1892 q->setinterfacevar = 0;
1894 q->setqueueentryvar = 0;
1895 q->autofill = autofill_default;
1896 q->montype = montype_default;
1897 q->monfmt[0] = '\0';
1898 q->reportholdtime = 0;
1900 q->penaltymemberslimit = 0;
1902 q->leavewhenempty = 0;
1904 q->maskmemberstatus = 0;
1905 q->eventwhencalled = 0;
1907 q->timeoutrestart = 0;
1908 q->periodicannouncefrequency = 0;
1909 q->randomperiodicannounce = 0;
1910 q->numperiodicannounce = 0;
1911 q->autopause = QUEUE_AUTOPAUSE_OFF;
1912 q->timeoutpriority = TIMEOUT_PRIORITY_APP;
1913 q->autopausedelay = 0;
1915 if (q->strategy == QUEUE_STRATEGY_LINEAR || q->strategy == QUEUE_STRATEGY_RRORDERED) {
1916 /* linear strategy depends on order, so we have to place all members in a single bucket */
1917 q->members = ao2_container_alloc(1, member_hash_fn, member_cmp_fn);
1919 q->members = ao2_container_alloc(37, member_hash_fn, member_cmp_fn);
1924 ast_string_field_set(q, sound_next, "queue-youarenext");
1925 ast_string_field_set(q, sound_thereare, "queue-thereare");
1926 ast_string_field_set(q, sound_calls, "queue-callswaiting");
1927 ast_string_field_set(q, queue_quantity1, "queue-quantity1");
1928 ast_string_field_set(q, queue_quantity2, "queue-quantity2");
1929 ast_string_field_set(q, sound_holdtime, "queue-holdtime");
1930 ast_string_field_set(q, sound_minutes, "queue-minutes");
1931 ast_string_field_set(q, sound_minute, "queue-minute");
1932 ast_string_field_set(q, sound_seconds, "queue-seconds");
1933 ast_string_field_set(q, sound_thanks, "queue-thankyou");
1934 ast_string_field_set(q, sound_reporthold, "queue-reporthold");
1936 if (!q->sound_periodicannounce[0]) {
1937 q->sound_periodicannounce[0] = ast_str_create(32);
1940 if (q->sound_periodicannounce[0]) {
1941 ast_str_set(&q->sound_periodicannounce[0], 0, "queue-periodic-announce");
1944 for (i = 1; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) {
1945 if (q->sound_periodicannounce[i]) {
1946 ast_str_set(&q->sound_periodicannounce[i], 0, "%s", "");
1950 while ((pr_iter = AST_LIST_REMOVE_HEAD(&q->rules,list))) {
1955 static void clear_queue(struct call_queue *q)
1958 q->callscompleted = 0;
1959 q->callsabandoned = 0;
1960 q->callscompletedinsl = 0;
1965 struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
1966 while ((mem = ao2_iterator_next(&mem_iter))) {
1971 ao2_iterator_destroy(&mem_iter);
1976 * \brief Change queue penalty by adding rule.
1978 * Check rule for errors with time or fomatting, see if rule is relative to rest
1979 * of queue, iterate list of rules to find correct insertion point, insert and return.
1980 * \retval -1 on failure
1981 * \retval 0 on success
1982 * \note Call this with the rule_lists locked
1984 static int insert_penaltychange(const char *list_name, const char *content, const int linenum)
1986 char *timestr, *maxstr, *minstr, *contentdup;
1987 struct penalty_rule *rule = NULL, *rule_iter;
1988 struct rule_list *rl_iter;
1989 int penaltychangetime, inserted = 0;
1991 if (!(rule = ast_calloc(1, sizeof(*rule)))) {
1995 contentdup = ast_strdupa(content);
1997 if (!(maxstr = strchr(contentdup, ','))) {
1998 ast_log(LOG_WARNING, "Improperly formatted penaltychange rule at line %d. Ignoring.\n", linenum);
2004 timestr = contentdup;
2006 if ((penaltychangetime = atoi(timestr)) < 0) {
2007 ast_log(LOG_WARNING, "Improper time parameter specified for penaltychange rule at line %d. Ignoring.\n", linenum);
2012 rule->time = penaltychangetime;
2014 if ((minstr = strchr(maxstr,','))) {
2018 /* The last check will evaluate true if either no penalty change is indicated for a given rule
2019 * OR if a min penalty change is indicated but no max penalty change is */
2020 if (*maxstr == '+' || *maxstr == '-' || *maxstr == '\0') {
2021 rule->max_relative = 1;
2024 rule->max_value = atoi(maxstr);
2026 if (!ast_strlen_zero(minstr)) {
2027 if (*minstr == '+' || *minstr == '-') {
2028 rule->min_relative = 1;
2030 rule->min_value = atoi(minstr);
2031 } else { /*there was no minimum specified, so assume this means no change*/
2032 rule->min_relative = 1;
2035 /*We have the rule made, now we need to insert it where it belongs*/
2036 AST_LIST_TRAVERSE(&rule_lists, rl_iter, list){
2037 if (strcasecmp(rl_iter->name, list_name)) {
2041 AST_LIST_TRAVERSE_SAFE_BEGIN(&rl_iter->rules, rule_iter, list) {
2042 if (rule->time < rule_iter->time) {
2043 AST_LIST_INSERT_BEFORE_CURRENT(rule, list);
2048 AST_LIST_TRAVERSE_SAFE_END;
2051 AST_LIST_INSERT_TAIL(&rl_iter->rules, rule, list);
2059 ast_log(LOG_WARNING, "Unknown rule list name %s; ignoring.\n", list_name);
2066 static void parse_empty_options(const char *value, enum empty_conditions *empty, int joinempty)
2068 char *value_copy = ast_strdupa(value);
2069 char *option = NULL;
2070 while ((option = strsep(&value_copy, ","))) {
2071 if (!strcasecmp(option, "paused")) {
2072 *empty |= QUEUE_EMPTY_PAUSED;
2073 } else if (!strcasecmp(option, "penalty")) {
2074 *empty |= QUEUE_EMPTY_PENALTY;
2075 } else if (!strcasecmp(option, "inuse")) {
2076 *empty |= QUEUE_EMPTY_INUSE;
2077 } else if (!strcasecmp(option, "ringing")) {
2078 *empty |= QUEUE_EMPTY_RINGING;
2079 } else if (!strcasecmp(option, "invalid")) {
2080 *empty |= QUEUE_EMPTY_INVALID;
2081 } else if (!strcasecmp(option, "wrapup")) {
2082 *empty |= QUEUE_EMPTY_WRAPUP;
2083 } else if (!strcasecmp(option, "unavailable")) {
2084 *empty |= QUEUE_EMPTY_UNAVAILABLE;
2085 } else if (!strcasecmp(option, "unknown")) {
2086 *empty |= QUEUE_EMPTY_UNKNOWN;
2087 } else if (!strcasecmp(option, "loose")) {
2088 *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID);
2089 } else if (!strcasecmp(option, "strict")) {
2090 *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED | QUEUE_EMPTY_UNAVAILABLE);
2091 } else if ((ast_false(option) && joinempty) || (ast_true(option) && !joinempty)) {
2092 *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED);
2093 } else if ((ast_false(option) && !joinempty) || (ast_true(option) && joinempty)) {
2096 ast_log(LOG_WARNING, "Unknown option %s for '%s'\n", option, joinempty ? "joinempty" : "leavewhenempty");
2101 /*! \brief Configure a queue parameter.
2103 * The failunknown flag is set for config files (and static realtime) to show
2104 * errors for unknown parameters. It is cleared for dynamic realtime to allow
2105 * extra fields in the tables.
2106 * \note For error reporting, line number is passed for .conf static configuration,
2107 * for Realtime queues, linenum is -1.
2109 static void queue_set_param(struct call_queue *q, const char *param, const char *val, int linenum, int failunknown)
2111 if (!strcasecmp(param, "musicclass") ||
2112 !strcasecmp(param, "music") || !strcasecmp(param, "musiconhold")) {
2113 ast_string_field_set(q, moh, val);
2114 } else if (!strcasecmp(param, "announce")) {
2115 ast_string_field_set(q, announce, val);
2116 } else if (!strcasecmp(param, "context")) {
2117 ast_string_field_set(q, context, val);
2118 } else if (!strcasecmp(param, "timeout")) {
2119 q->timeout = atoi(val);
2120 if (q->timeout < 0) {
2121 q->timeout = DEFAULT_TIMEOUT;
2123 } else if (!strcasecmp(param, "ringinuse")) {
2124 q->ringinuse = ast_true(val);
2125 } else if (!strcasecmp(param, "setinterfacevar")) {
2126 q->setinterfacevar = ast_true(val);
2127 } else if (!strcasecmp(param, "setqueuevar")) {
2128 q->setqueuevar = ast_true(val);
2129 } else if (!strcasecmp(param, "setqueueentryvar")) {
2130 q->setqueueentryvar = ast_true(val);
2131 } else if (!strcasecmp(param, "monitor-format")) {
2132 ast_copy_string(q->monfmt, val, sizeof(q->monfmt));
2133 } else if (!strcasecmp(param, "membermacro")) {
2134 ast_string_field_set(q, membermacro, val);
2135 } else if (!strcasecmp(param, "membergosub")) {
2136 ast_string_field_set(q, membergosub, val);
2137 } else if (!strcasecmp(param, "queue-youarenext")) {
2138 ast_string_field_set(q, sound_next, val);
2139 } else if (!strcasecmp(param, "queue-thereare")) {
2140 ast_string_field_set(q, sound_thereare, val);
2141 } else if (!strcasecmp(param, "queue-callswaiting")) {
2142 ast_string_field_set(q, sound_calls, val);
2143 } else if (!strcasecmp(param, "queue-quantity1")) {
2144 ast_string_field_set(q, queue_quantity1, val);
2145 } else if (!strcasecmp(param, "queue-quantity2")) {
2146 ast_string_field_set(q, queue_quantity2, val);
2147 } else if (!strcasecmp(param, "queue-holdtime")) {
2148 ast_string_field_set(q, sound_holdtime, val);
2149 } else if (!strcasecmp(param, "queue-minutes")) {
2150 ast_string_field_set(q, sound_minutes, val);
2151 } else if (!strcasecmp(param, "queue-minute")) {
2152 ast_string_field_set(q, sound_minute, val);
2153 } else if (!strcasecmp(param, "queue-seconds")) {
2154 ast_string_field_set(q, sound_seconds, val);
2155 } else if (!strcasecmp(param, "queue-thankyou")) {
2156 ast_string_field_set(q, sound_thanks, val);
2157 } else if (!strcasecmp(param, "queue-callerannounce")) {
2158 ast_string_field_set(q, sound_callerannounce, val);
2159 } else if (!strcasecmp(param, "queue-reporthold")) {
2160 ast_string_field_set(q, sound_reporthold, val);
2161 } else if (!strcasecmp(param, "announce-frequency")) {
2162 q->announcefrequency = atoi(val);
2163 } else if (!strcasecmp(param, "min-announce-frequency")) {
2164 q->minannouncefrequency = atoi(val);
2165 ast_debug(1, "%s=%s for queue '%s'\n", param, val, q->name);
2166 } else if (!strcasecmp(param, "announce-round-seconds")) {
2167 q->roundingseconds = atoi(val);
2168 /* Rounding to any other values just doesn't make sense... */
2169 if (!(q->roundingseconds == 0 || q->roundingseconds == 5 || q->roundingseconds == 10
2170 || q->roundingseconds == 15 || q->roundingseconds == 20 || q->roundingseconds == 30)) {
2172 ast_log(LOG_WARNING, "'%s' isn't a valid value for %s "
2173 "using 0 instead for queue '%s' at line %d of queues.conf\n",
2174 val, param, q->name, linenum);
2176 ast_log(LOG_WARNING, "'%s' isn't a valid value for %s "
2177 "using 0 instead for queue '%s'\n", val, param, q->name);
2179 q->roundingseconds=0;
2181 } else if (!strcasecmp(param, "announce-holdtime")) {
2182 if (!strcasecmp(val, "once")) {
2183 q->announceholdtime = ANNOUNCEHOLDTIME_ONCE;
2184 } else if (ast_true(val)) {
2185 q->announceholdtime = ANNOUNCEHOLDTIME_ALWAYS;
2187 q->announceholdtime = 0;
2189 } else if (!strcasecmp(param, "announce-position")) {
2190 if (!strcasecmp(val, "limit")) {
2191 q->announceposition = ANNOUNCEPOSITION_LIMIT;
2192 } else if (!strcasecmp(val, "more")) {
2193 q->announceposition = ANNOUNCEPOSITION_MORE_THAN;
2194 } else if (ast_true(val)) {
2195 q->announceposition = ANNOUNCEPOSITION_YES;
2197 q->announceposition = ANNOUNCEPOSITION_NO;
2199 } else if (!strcasecmp(param, "announce-position-limit")) {
2200 q->announcepositionlimit = atoi(val);
2201 } else if (!strcasecmp(param, "periodic-announce")) {
2202 if (strchr(val, ',')) {
2203 char *s, *buf = ast_strdupa(val);
2206 while ((s = strsep(&buf, ",|"))) {
2207 if (!q->sound_periodicannounce[i]) {
2208 q->sound_periodicannounce[i] = ast_str_create(16);
2210 ast_str_set(&q->sound_periodicannounce[i], 0, "%s", s);
2212 if (i == MAX_PERIODIC_ANNOUNCEMENTS) {
2216 q->numperiodicannounce = i;
2218 ast_str_set(&q->sound_periodicannounce[0], 0, "%s", val);
2219 q->numperiodicannounce = 1;
2221 } else if (!strcasecmp(param, "periodic-announce-frequency")) {
2222 q->periodicannouncefrequency = atoi(val);
2223 } else if (!strcasecmp(param, "relative-periodic-announce")) {
2224 q->relativeperiodicannounce = ast_true(val);
2225 } else if (!strcasecmp(param, "random-periodic-announce")) {
2226 q->randomperiodicannounce = ast_true(val);
2227 } else if (!strcasecmp(param, "retry")) {
2228 q->retry = atoi(val);
2229 if (q->retry <= 0) {
2230 q->retry = DEFAULT_RETRY;
2232 } else if (!strcasecmp(param, "wrapuptime")) {
2233 q->wrapuptime = atoi(val);
2234 } else if (!strcasecmp(param, "penaltymemberslimit")) {
2235 if ((sscanf(val, "%10d", &q->penaltymemberslimit) != 1)) {
2236 q->penaltymemberslimit = 0;
2238 } else if (!strcasecmp(param, "autofill")) {
2239 q->autofill = ast_true(val);
2240 } else if (!strcasecmp(param, "monitor-type")) {
2241 if (!strcasecmp(val, "mixmonitor")) {
2244 } else if (!strcasecmp(param, "autopause")) {
2245 q->autopause = autopause2int(val);
2246 } else if (!strcasecmp(param, "autopausedelay")) {
2247 q->autopausedelay = atoi(val);
2248 } else if (!strcasecmp(param, "autopausebusy")) {
2249 q->autopausebusy = ast_true(val);
2250 } else if (!strcasecmp(param, "autopauseunavail")) {
2251 q->autopauseunavail = ast_true(val);
2252 } else if (!strcasecmp(param, "maxlen")) {
2253 q->maxlen = atoi(val);
2254 if (q->maxlen < 0) {
2257 } else if (!strcasecmp(param, "servicelevel")) {
2258 q->servicelevel= atoi(val);
2259 } else if (!strcasecmp(param, "strategy")) {
2262 /* We are a static queue and already have set this, no need to do it again */
2266 strategy = strat2int(val);
2268 ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
2270 q->strategy = QUEUE_STRATEGY_RINGALL;
2272 if (strategy == q->strategy) {
2275 if (strategy == QUEUE_STRATEGY_LINEAR) {
2276 ast_log(LOG_WARNING, "Changing to the linear strategy currently requires asterisk to be restarted.\n");
2279 q->strategy = strategy;
2280 } else if (!strcasecmp(param, "joinempty")) {
2281 parse_empty_options(val, &q->joinempty, 1);
2282 } else if (!strcasecmp(param, "leavewhenempty")) {
2283 parse_empty_options(val, &q->leavewhenempty, 0);
2284 } else if (!strcasecmp(param, "eventmemberstatus")) {
2285 q->maskmemberstatus = !ast_true(val);
2286 } else if (!strcasecmp(param, "eventwhencalled")) {
2287 if (!strcasecmp(val, "vars")) {
2288 q->eventwhencalled = QUEUE_EVENT_VARIABLES;
2290 q->eventwhencalled = ast_true(val) ? 1 : 0;
2292 } else if (!strcasecmp(param, "reportholdtime")) {
2293 q->reportholdtime = ast_true(val);
2294 } else if (!strcasecmp(param, "memberdelay")) {
2295 q->memberdelay = atoi(val);
2296 } else if (!strcasecmp(param, "weight")) {
2297 q->weight = atoi(val);
2298 } else if (!strcasecmp(param, "timeoutrestart")) {
2299 q->timeoutrestart = ast_true(val);
2300 } else if (!strcasecmp(param, "defaultrule")) {
2301 ast_string_field_set(q, defaultrule, val);
2302 } else if (!strcasecmp(param, "timeoutpriority")) {
2303 if (!strcasecmp(val, "conf")) {
2304 q->timeoutpriority = TIMEOUT_PRIORITY_CONF;
2306 q->timeoutpriority = TIMEOUT_PRIORITY_APP;
2308 } else if (failunknown) {
2310 ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s at line %d of queues.conf\n",
2311 q->name, param, linenum);
2313 ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s\n", q->name, param);
2319 * \brief Find rt member record to update otherwise create one.
2321 * Search for member in queue, if found update penalty/paused state,
2322 * if no member exists create one flag it as a RT member and add to queue member list.
2324 static void rt_handle_member_record(struct call_queue *q, char *interface, struct ast_config *member_config)
2327 struct ao2_iterator mem_iter;
2331 int ringinuse = q->ringinuse;
2333 const char *config_val;
2334 const char *rt_uniqueid = ast_variable_retrieve(member_config, interface, "uniqueid");
2335 const char *membername = S_OR(ast_variable_retrieve(member_config, interface, "membername"), interface);
2336 const char *state_interface = S_OR(ast_variable_retrieve(member_config, interface, "state_interface"), interface);
2337 const char *penalty_str = ast_variable_retrieve(member_config, interface, "penalty");
2338 const char *paused_str = ast_variable_retrieve(member_config, interface, "paused");
2340 if (ast_strlen_zero(rt_uniqueid)) {
2341 ast_log(LOG_WARNING, "Realtime field uniqueid is empty for member %s\n", S_OR(membername, "NULL"));
2346 penalty = atoi(penalty_str);
2347 if ((penalty < 0) && negative_penalty_invalid) {
2349 } else if (penalty < 0) {
2355 paused = atoi(paused_str);
2361 if ((config_val = ast_variable_retrieve(member_config, interface, realtime_ringinuse_field))) {
2362 if (ast_true(config_val)) {
2364 } else if (ast_false(config_val)) {
2367 ast_log(LOG_WARNING, "Invalid value of '%s' field for %s in queue '%s'\n", realtime_ringinuse_field, interface, q->name);
2371 /* Find member by realtime uniqueid and update */
2372 mem_iter = ao2_iterator_init(q->members, 0);
2373 while ((m = ao2_iterator_next(&mem_iter))) {
2374 if (!strcasecmp(m->rt_uniqueid, rt_uniqueid)) {
2375 m->dead = 0; /* Do not delete this one. */
2376 ast_copy_string(m->rt_uniqueid, rt_uniqueid, sizeof(m->rt_uniqueid));
2380 if (strcasecmp(state_interface, m->state_interface)) {
2381 ast_copy_string(m->state_interface, state_interface, sizeof(m->state_interface));
2383 m->penalty = penalty;
2384 m->ringinuse = ringinuse;
2391 ao2_iterator_destroy(&mem_iter);
2393 /* Create a new member */
2395 if ((m = create_queue_member(interface, membername, penalty, paused, state_interface, ringinuse))) {
2398 ast_copy_string(m->rt_uniqueid, rt_uniqueid, sizeof(m->rt_uniqueid));
2399 if (!log_membername_as_agent) {
2400 ast_queue_log(q->name, "REALTIME", m->interface, "ADDMEMBER", "%s", paused ? "PAUSED" : "");
2402 ast_queue_log(q->name, "REALTIME", m->membername, "ADDMEMBER", "%s", paused ? "PAUSED" : "");
2404 ao2_link(q->members, m);
2411 /*! \brief Iterate through queue's member list and delete them */
2412 static void free_members(struct call_queue *q, int all)
2414 /* Free non-dynamic members */
2416 struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
2418 while ((cur = ao2_iterator_next(&mem_iter))) {
2419 if (all || !cur->dynamic) {
2420 ao2_unlink(q->members, cur);
2424 ao2_iterator_destroy(&mem_iter);
2427 /*! \brief Free queue's member list then its string fields */
2428 static void destroy_queue(void *obj)
2430 struct call_queue *q = obj;
2434 ast_string_field_free_memory(q);
2435 for (i = 0; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) {
2436 if (q->sound_periodicannounce[i]) {
2437 free(q->sound_periodicannounce[i]);
2440 ao2_ref(q->members, -1);
2443 static struct call_queue *alloc_queue(const char *queuename)
2445 struct call_queue *q;
2447 if ((q = ao2_t_alloc(sizeof(*q), destroy_queue, "Allocate queue"))) {
2448 if (ast_string_field_init(q, 64)) {
2449 queue_t_unref(q, "String field allocation failed");
2452 ast_string_field_set(q, name, queuename);
2458 * \brief Reload a single queue via realtime.
2460 * Check for statically defined queue first, check if deleted RT queue,
2461 * check for new RT queue, if queue vars are not defined init them with defaults.
2462 * reload RT queue vars, set RT queue members dead and reload them, return finished queue.
2463 * \retval the queue,
2464 * \retval NULL if it doesn't exist.
2465 * \note Should be called with the "queues" container locked.
2467 static struct call_queue *find_queue_by_name_rt(const char *queuename, struct ast_variable *queue_vars, struct ast_config *member_config)
2469 struct ast_variable *v;
2470 struct call_queue *q, tmpq = {
2474 struct ao2_iterator mem_iter;
2475 char *interface = NULL;
2476 const char *tmp_name;
2478 char tmpbuf[64]; /* Must be longer than the longest queue param name. */
2480 /* Static queues override realtime. */
2481 if ((q = ao2_t_find(queues, &tmpq, OBJ_POINTER, "Check if static queue exists"))) {
2486 queue_t_unref(q, "Queue is dead; can't return it");
2489 ast_log(LOG_WARNING, "Static queue '%s' already exists. Not loading from realtime\n", q->name);
2493 } else if (!member_config) {
2494 /* Not found in the list, and it's not realtime ... */
2497 /* Check if queue is defined in realtime. */
2499 /* Delete queue from in-core list if it has been deleted in realtime. */
2501 /*! \note Hmm, can't seem to distinguish a DB failure from a not
2502 found condition... So we might delete an in-core queue
2503 in case of DB failure. */
2504 ast_debug(1, "Queue %s not found in realtime.\n", queuename);
2507 /* Delete if unused (else will be deleted when last caller leaves). */
2508 queues_t_unlink(queues, q, "Unused; removing from container");
2510 queue_t_unref(q, "Queue is dead; can't return it");
2515 /* Create a new queue if an in-core entry does not exist yet. */
2517 struct ast_variable *tmpvar = NULL;
2518 if (!(q = alloc_queue(queuename))) {
2524 /*Before we initialize the queue, we need to set the strategy, so that linear strategy
2525 * will allocate the members properly
2527 for (tmpvar = queue_vars; tmpvar; tmpvar = tmpvar->next) {
2528 if (!strcasecmp(tmpvar->name, "strategy")) {
2529 q->strategy = strat2int(tmpvar->value);
2530 if (q->strategy < 0) {
2531 ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
2532 tmpvar->value, q->name);
2533 q->strategy = QUEUE_STRATEGY_RINGALL;
2538 /* We traversed all variables and didn't find a strategy */
2540 q->strategy = QUEUE_STRATEGY_RINGALL;
2542 queues_t_link(queues, q, "Add queue to container");
2544 init_queue(q); /* Ensure defaults for all parameters not set explicitly. */
2546 memset(tmpbuf, 0, sizeof(tmpbuf));
2547 for (v = queue_vars; v; v = v->next) {
2548 /* Convert to dashes `-' from underscores `_' as the latter are more SQL friendly. */
2549 if (strchr(v->name, '_')) {
2550 ast_copy_string(tmpbuf, v->name, sizeof(tmpbuf));
2553 while ((tmp = strchr(tmp, '_'))) {
2560 /* NULL values don't get returned from realtime; blank values should
2561 * still get set. If someone doesn't want a value to be set, they
2562 * should set the realtime column to NULL, not blank. */
2563 queue_set_param(q, tmp_name, v->value, -1, 0);
2566 /* Temporarily set realtime members dead so we can detect deleted ones. */
2567 mem_iter = ao2_iterator_init(q->members, 0);
2568 while ((m = ao2_iterator_next(&mem_iter))) {
2574 ao2_iterator_destroy(&mem_iter);
2576 while ((interface = ast_category_browse(member_config, interface))) {
2577 rt_handle_member_record(q, interface, member_config);
2580 /* Delete all realtime members that have been deleted in DB. */
2581 mem_iter = ao2_iterator_init(q->members, 0);
2582 while ((m = ao2_iterator_next(&mem_iter))) {
2584 if (ast_strlen_zero(m->membername) || !log_membername_as_agent) {
2585 ast_queue_log(q->name, "REALTIME", m->interface, "REMOVEMEMBER", "%s", "");
2587 ast_queue_log(q->name, "REALTIME", m->membername, "REMOVEMEMBER", "%s", "");
2589 ao2_unlink(q->members, m);
2593 ao2_iterator_destroy(&mem_iter);
2605 * \brief Returns reference to the named queue. If the queue is realtime, it will load the queue as well.
2606 * \param queuename - name of the desired queue
2609 * \retval NULL if it doesn't exist
2611 static struct call_queue *find_load_queue_rt_friendly(const char *queuename)
2613 struct ast_variable *queue_vars;
2614 struct ast_config *member_config = NULL;
2615 struct call_queue *q = NULL, tmpq = {
2618 int prev_weight = 0;
2620 /* Find the queue in the in-core list first. */
2621 q = ao2_t_find(queues, &tmpq, OBJ_POINTER, "Look for queue in memory first");
2623 if (!q || q->realtime) {
2624 /*! \note Load from realtime before taking the "queues" container lock, to avoid blocking all
2625 queue operations while waiting for the DB.
2627 This will be two separate database transactions, so we might
2628 see queue parameters as they were before another process
2629 changed the queue and member list as it was after the change.
2630 Thus we might see an empty member list when a queue is
2631 deleted. In practise, this is unlikely to cause a problem. */
2633 queue_vars = ast_load_realtime("queues", "name", queuename, SENTINEL);
2635 member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", queuename, SENTINEL);
2636 if (!member_config) {
2637 ast_debug(1, "No queue_members defined in config extconfig.conf\n");
2638 member_config = ast_config_new();
2642 prev_weight = q->weight ? 1 : 0;
2643 queue_t_unref(q, "Need to find realtime queue");
2646 q = find_queue_by_name_rt(queuename, queue_vars, member_config);
2647 ast_config_destroy(member_config);
2648 ast_variables_destroy(queue_vars);
2650 /* update the use_weight value if the queue's has gained or lost a weight */
2652 if (!q->weight && prev_weight) {
2653 ast_atomic_fetchadd_int(&use_weight, -1);
2655 if (q->weight && !prev_weight) {
2656 ast_atomic_fetchadd_int(&use_weight, +1);
2659 /* Other cases will end up with the proper value for use_weight */
2661 update_realtime_members(q);
2666 static int update_realtime_member_field(struct member *mem, const char *queue_name, const char *field, const char *value)
2670 if (ast_strlen_zero(mem->rt_uniqueid)) {
2674 if ((ast_update_realtime("queue_members", "uniqueid", mem->rt_uniqueid, field, value, SENTINEL)) > 0) {
2682 static void update_realtime_members(struct call_queue *q)
2684 struct ast_config *member_config = NULL;
2686 char *interface = NULL;
2687 struct ao2_iterator mem_iter;
2689 if (!(member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", q->name , SENTINEL))) {
2690 /* This queue doesn't have realtime members. If the queue still has any realtime
2691 * members in memory, they need to be removed.
2694 mem_iter = ao2_iterator_init(q->members, 0);
2695 while ((m = ao2_iterator_next(&mem_iter))) {
2697 ao2_unlink(q->members, m);
2701 ast_debug(3, "Queue %s has no realtime members defined. No need for update\n", q->name);
2708 /* Temporarily set realtime members dead so we can detect deleted ones.*/
2709 mem_iter = ao2_iterator_init(q->members, 0);
2710 while ((m = ao2_iterator_next(&mem_iter))) {
2716 ao2_iterator_destroy(&mem_iter);
2718 while ((interface = ast_category_browse(member_config, interface))) {
2719 rt_handle_member_record(q, interface, member_config);
2722 /* Delete all realtime members that have been deleted in DB. */
2723 mem_iter = ao2_iterator_init(q->members, 0);
2724 while ((m = ao2_iterator_next(&mem_iter))) {
2726 if (ast_strlen_zero(m->membername) || !log_membername_as_agent) {
2727 ast_queue_log(q->name, "REALTIME", m->interface, "REMOVEMEMBER", "%s", "");
2729 ast_queue_log(q->name, "REALTIME", m->membername, "REMOVEMEMBER", "%s", "");
2731 ao2_unlink(q->members, m);
2735 ao2_iterator_destroy(&mem_iter);
2737 ast_config_destroy(member_config);
2740 static int join_queue(char *queuename, struct queue_ent *qe, enum queue_result *reason, int position)
2742 struct call_queue *q;
2743 struct queue_ent *cur, *prev = NULL;
2748 if (!(q = find_load_queue_rt_friendly(queuename))) {
2753 /* This is our one */
2756 if ((status = get_member_status(q, qe->max_penalty, qe->min_penalty, q->joinempty))) {
2757 *reason = QUEUE_JOINEMPTY;
2759 queue_t_unref(q, "Done with realtime queue");
2763 if (*reason == QUEUE_UNKNOWN && q->maxlen && (q->count >= q->maxlen)) {
2764 *reason = QUEUE_FULL;
2765 } else if (*reason == QUEUE_UNKNOWN) {
2766 /* There's space for us, put us at the right position inside
2768 * Take into account the priority of the calling user */
2773 /* We have higher priority than the current user, enter
2774 * before him, after all the other users with priority
2775 * higher or equal to our priority. */
2776 if ((!inserted) && (qe->prio > cur->prio)) {
2777 insert_entry(q, prev, qe, &pos);
2780 /* <= is necessary for the position comparison because it may not be possible to enter
2781 * at our desired position since higher-priority callers may have taken the position we want
2783 if (!inserted && (qe->prio >= cur->prio) && position && (position <= pos + 1)) {
2784 insert_entry(q, prev, qe, &pos);
2786 /*pos is incremented inside insert_entry, so don't need to add 1 here*/
2787 if (position < pos) {
2788 ast_log(LOG_NOTICE, "Asked to be inserted at position %d but forced into position %d due to higher priority callers\n", position, pos);
2795 /* No luck, join at the end of the queue */
2797 insert_entry(q, prev, qe, &pos);
2799 ast_copy_string(qe->moh, q->moh, sizeof(qe->moh));
2800 ast_copy_string(qe->announce, q->announce, sizeof(qe->announce));
2801 ast_copy_string(qe->context, q->context, sizeof(qe->context));
2805 <managerEventInstance>
2806 <synopsis>Raised when a channel joins a Queue.</synopsis>
2808 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
2809 <parameter name="Position">
2810 <para>This channel's current position in the queue.</para>
2812 <parameter name="Count">
2813 <para>The total number of channels in the queue.</para>
2817 <ref type="managerEvent">Leave</ref>
2818 <ref type="application">Queue</ref>
2820 </managerEventInstance>
2822 ast_manager_event(qe->chan, EVENT_FLAG_CALL, "Join",
2824 "CallerIDNum: %s\r\n"
2825 "CallerIDName: %s\r\n"
2826 "ConnectedLineNum: %s\r\n"
2827 "ConnectedLineName: %s\r\n"
2832 ast_channel_name(qe->chan),
2833 S_COR(ast_channel_caller(qe->chan)->id.number.valid, ast_channel_caller(qe->chan)->id.number.str, "unknown"),/* XXX somewhere else it is <unknown> */
2834 S_COR(ast_channel_caller(qe->chan)->id.name.valid, ast_channel_caller(qe->chan)->id.name.str, "unknown"),
2835 S_COR(ast_channel_connected(qe->chan)->id.number.valid, ast_channel_connected(qe->chan)->id.number.str, "unknown"),/* XXX somewhere else it is <unknown> */
2836 S_COR(ast_channel_connected(qe->chan)->id.name.valid, ast_channel_connected(qe->chan)->id.name.str, "unknown"),
2837 q->name, qe->pos, q->count, ast_channel_uniqueid(qe->chan));
2838 ast_debug(1, "Queue '%s' Join, Channel '%s', Position '%d'\n", q->name, ast_channel_name(qe->chan), qe->pos );
2841 queue_t_unref(q, "Done with realtime queue");
2846 static int play_file(struct ast_channel *chan, const char *filename)
2850 if (ast_strlen_zero(filename)) {
2854 if (!ast_fileexists(filename, NULL, ast_channel_language(chan))) {
2858 ast_stopstream(chan);
2860 res = ast_streamfile(chan, filename, ast_channel_language(chan));
2862 res = ast_waitstream(chan, AST_DIGIT_ANY);
2865 ast_stopstream(chan);
2871 * \brief Check for valid exit from queue via goto
2872 * \retval 0 if failure
2873 * \retval 1 if successful
2875 static int valid_exit(struct queue_ent *qe, char digit)
2877 int digitlen = strlen(qe->digits);
2879 /* Prevent possible buffer overflow */
2880 if (digitlen < sizeof(qe->digits) - 2) {
2881 qe->digits[digitlen] = digit;
2882 qe->digits[digitlen + 1] = '\0';
2884 qe->digits[0] = '\0';
projects / asterisk/asterisk.git / blob