Make app_dial and app_queue use new macro and gosub calls.
[asterisk/asterisk.git] / apps / app_queue.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief True call queues with optional send URL on answer
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * \arg Config in \ref Config_qu queues.conf
26  *
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>
31  *
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.
37  *
38  * \note 2004-06-04: Priorities in queues added by inAccess Networks (work funded by Hellas On Line (HOL) www.hol.gr).
39  *
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
47  *
48  * Patch Version 1.07 2003-12-24 01
49  *
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>
52  *
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>
55  *
56  * \ingroup applications
57  */
58
59 /*** MODULEINFO
60         <use type="module">res_monitor</use>
61         <support_level>core</support_level>
62  ***/
63
64 #include "asterisk.h"
65
66 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
67
68 #include <sys/time.h>
69 #include <sys/signal.h>
70 #include <netinet/in.h>
71 #include <ctype.h>
72
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"
102
103 /* Define, to debug reference counts on queues, without debugging reference counts on queue members */
104 /* #define REF_DEBUG_ONLY_QUEUES */
105
106 /*!
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
112  * 1) queue list lock
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
117  * to this order!
118  */
119
120 /*** DOCUMENTATION
121         <application name="Queue" language="en_US">
122                 <synopsis>
123                         Queue a call for a call queue.
124                 </synopsis>
125                 <syntax>
126                         <parameter name="queuename" required="true" />
127                         <parameter name="options">
128                                 <optionlist>
129                                         <option name="C">
130                                                 <para>Mark all calls as "answered elsewhere" when cancelled.</para>
131                                         </option>
132                                         <option name="c">
133                                                 <para>Continue in the dialplan if the callee hangs up.</para>
134                                         </option>
135                                         <option name="d">
136                                                 <para>data-quality (modem) call (minimum delay).</para>
137                                         </option>
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>
144                                                 <note>
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>
147                                                 </note>
148                                         </option>
149                                         <option name="F">
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>
152                                                 <note>
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>
155                                                 </note>
156                                                 <note>
157                                                         <para>Using this option from a Macro() or GoSub() might not make sense as there would be no return points.</para>
158                                                 </note>
159                                         </option>
160                                         <option name="h">
161                                                 <para>Allow <emphasis>callee</emphasis> to hang up by pressing <literal>*</literal>.</para>
162                                         </option>
163                                         <option name="H">
164                                                 <para>Allow <emphasis>caller</emphasis> to hang up by pressing <literal>*</literal>.</para>
165                                         </option>
166                                         <option name="n">
167                                                 <para>No retries on the timeout; will exit this application and
168                                                 go to the next step.</para>
169                                         </option>
170                                         <option name="i">
171                                                 <para>Ignore call forward requests from queue members and do nothing
172                                                 when they are requested.</para>
173                                         </option>
174                                         <option name="I">
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>
177                                         </option>
178                                         <option name="r">
179                                                 <para>Ring instead of playing MOH. Periodic Announcements are still made, if applicable.</para>
180                                         </option>
181                                         <option name="R">
182                                                 <para>Ring instead of playing MOH when a member channel is actually ringing.</para>
183                                         </option>
184                                         <option name="t">
185                                                 <para>Allow the <emphasis>called</emphasis> user to transfer the calling user.</para>
186                                         </option>
187                                         <option name="T">
188                                                 <para>Allow the <emphasis>calling</emphasis> user to transfer the call.</para>
189                                         </option>
190                                         <option name="w">
191                                                 <para>Allow the <emphasis>called</emphasis> user to write the conversation to
192                                                 disk via Monitor.</para>
193                                         </option>
194                                         <option name="W">
195                                                 <para>Allow the <emphasis>calling</emphasis> user to write the conversation to
196                                                 disk via Monitor.</para>
197                                         </option>
198                                         <option name="k">
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>
201                                         </option>
202                                         <option name="K">
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>
205                                         </option>
206                                         <option name="x">
207                                                 <para>Allow the <emphasis>called</emphasis> user to write the conversation
208                                                 to disk via MixMonitor.</para>
209                                         </option>
210                                         <option name="X">
211                                                 <para>Allow the <emphasis>calling</emphasis> user to write the conversation to
212                                                 disk via MixMonitor.</para>
213                                         </option>
214                                 </optionlist>
215                         </parameter>
216                         <parameter name="URL">
217                                 <para><replaceable>URL</replaceable> will be sent to the called party if the channel supports it.</para>
218                         </parameter>
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>
224                         </parameter>
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>
228                         </parameter>
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>
231                         </parameter>
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>
234                         </parameter>
235                         <parameter name="rule">
236                                 <para>Will cause the queue's defaultrule to be overridden by the rule specified.</para>
237                         </parameter>
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>
242                         </parameter>
243                 </syntax>
244                 <description>
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>
252                         <variablelist>
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" />
262                                 </variable>
263                         </variablelist>
264                 </description>
265                 <see-also>
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>
279                 </see-also>
280         </application>
281         <application name="AddQueueMember" language="en_US">
282                 <synopsis>
283                         Dynamically adds queue members.
284                 </synopsis>
285                 <syntax>
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" />
292                 </syntax>
293                 <description>
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>
297                         <variablelist>
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" />
303                                 </variable>
304                         </variablelist>
305                 </description>
306                 <see-also>
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>
320                 </see-also>
321         </application>
322         <application name="RemoveQueueMember" language="en_US">
323                 <synopsis>
324                         Dynamically removes queue members.
325                 </synopsis>
326                 <syntax>
327                         <parameter name="queuename" required="true" />
328                         <parameter name="interface" />
329                         <parameter name="options" />
330                 </syntax>
331                 <description>
332                         <para>If the interface is <emphasis>NOT</emphasis> in the queue it will return an error.</para>
333                         <para>This application sets the following channel variable upon completion:</para>
334                         <variablelist>
335                                 <variable name="RQMSTATUS">
336                                         <value name="REMOVED" />
337                                         <value name="NOTINQUEUE" />
338                                         <value name="NOSUCHQUEUE" />
339                                 </variable>
340                         </variablelist>
341                         <para>Example: RemoveQueueMember(techsupport,SIP/3000)</para>
342                 </description>
343                 <see-also>
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>
357                 </see-also>
358         </application>
359         <application name="PauseQueueMember" language="en_US">
360                 <synopsis>
361                         Pauses a queue member.
362                 </synopsis>
363                 <syntax>
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>
369                         </parameter>
370                 </syntax>
371                 <description>
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>
378                         <variablelist>
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" />
383                                 </variable>
384                         </variablelist>
385                         <para>Example: PauseQueueMember(,SIP/3000)</para>
386                 </description>
387                 <see-also>
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>
401                 </see-also>
402         </application>
403         <application name="UnpauseQueueMember" language="en_US">
404                 <synopsis>
405                         Unpauses a queue member.                
406                 </synopsis>
407                 <syntax>
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>
413                         </parameter>
414                 </syntax>
415                 <description>
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>
419                         <variablelist>
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" />
424                                 </variable>
425                         </variablelist>
426                         <para>Example: UnpauseQueueMember(,SIP/3000)</para>
427                 </description>
428                 <see-also>
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>
442                 </see-also>
443         </application>
444         <application name="QueueLog" language="en_US">
445                 <synopsis>
446                         Writes to the queue_log file.
447                 </synopsis>
448                 <syntax>
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" />
454                 </syntax>
455                 <description>
456                         <para>Allows you to write your own events into the queue log.</para>
457                         <para>Example: QueueLog(101,${UNIQUEID},${AGENT},WENTONBREAK,600)</para>
458                 </description>
459                 <see-also>
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>
473                 </see-also>
474         </application>
475         <function name="QUEUE_VARIABLES" language="en_US">
476                 <synopsis>
477                         Return Queue information in variables.
478                 </synopsis>
479                 <syntax>
480                         <parameter name="queuename" required="true">
481                                 <enumlist>
482                                         <enum name="QUEUEMAX">
483                                                 <para>Maxmimum number of calls allowed.</para>
484                                         </enum>
485                                         <enum name="QUEUESTRATEGY">
486                                                 <para>The strategy of the queue.</para>
487                                         </enum>
488                                         <enum name="QUEUECALLS">
489                                                 <para>Number of calls currently in the queue.</para>
490                                         </enum>
491                                         <enum name="QUEUEHOLDTIME">
492                                                 <para>Current average hold time.</para>
493                                         </enum>
494                                         <enum name="QUEUECOMPLETED">
495                                                 <para>Number of completed calls for the queue.</para>
496                                         </enum>
497                                         <enum name="QUEUEABANDONED">
498                                                 <para>Number of abandoned calls.</para>
499                                         </enum>
500                                         <enum name="QUEUESRVLEVEL">
501                                                 <para>Queue service level.</para>
502                                         </enum>
503                                         <enum name="QUEUESRVLEVELPERF">
504                                                 <para>Current service level performance.</para>
505                                         </enum>
506                                 </enumlist>
507                         </parameter>
508                 </syntax>
509                 <description>
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>
512                 </description>
513                 <see-also>
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>
527                 </see-also>
528         </function>
529         <function name="QUEUE_MEMBER" language="en_US">
530                 <synopsis>
531                         Count number of members answering a queue.
532                 </synopsis>
533                 <syntax>
534                         <parameter name="queuename" required="true" />
535                         <parameter name="option" required="true">
536                                 <enumlist>
537                                         <enum name="logged">
538                                                 <para>Returns the number of logged-in members for the specified queue.</para>
539                                         </enum>
540                                         <enum name="free">
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>
542                                         </enum>
543                                         <enum name="ready">
544                                                 <para>Returns the number of logged-in members for the specified queue that are immediately available to answer a call.</para>
545                                         </enum>
546                                         <enum name="count">
547                                                 <para>Returns the total number of members for the specified queue.</para>
548                                         </enum>
549                                         <enum name="penalty">
550                                                 <para>Gets or sets queue member penalty.</para>
551                                         </enum>
552                                         <enum name="paused">
553                                                 <para>Gets or sets queue member paused status.</para>
554                                         </enum>
555                                         <enum name="ignorebusy">
556                                                 <para>Gets or sets queue member ignorebusy.</para>
557                                         </enum>
558                                 </enumlist>
559                         </parameter>
560                         <parameter name="interface" required="false" />
561                 </syntax>
562                 <description>
563                         <para>Allows access to queue counts [R] and member information [R/W].</para>
564                         <para>
565                                 <replaceable>queuename</replaceable> is required for all operations
566                                 <replaceable>interface</replaceable> is required for all member operations.
567                         </para>
568                 </description>
569                 <see-also>
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>
583                 </see-also>
584         </function>
585         <function name="QUEUE_MEMBER_COUNT" language="en_US">
586                 <synopsis>
587                         Count number of members answering a queue.
588                 </synopsis>
589                 <syntax>
590                         <parameter name="queuename" required="true" />
591                 </syntax>
592                 <description>
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>
595                 </description>
596                 <see-also>
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>
610                 </see-also>
611         </function>
612         <function name="QUEUE_EXISTS" language="en_US">
613                 <synopsis>
614                         Check if a named queue exists on this server
615                 </synopsis>
616                 <syntax>
617                         <parameter name="queuename" />
618                 </syntax>
619                 <description>
620                         <para>Returns 1 if the specified queue exists, 0 if it does not</para>
621                 </description>
622                 <see-also>
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>
636                 </see-also>
637         </function>
638         <function name="QUEUE_WAITING_COUNT" language="en_US">
639                 <synopsis>
640                         Count number of calls currently waiting in a queue.
641                 </synopsis>
642                 <syntax>
643                         <parameter name="queuename" />
644                 </syntax>
645                 <description>
646                         <para>Returns the number of callers currently waiting in the specified <replaceable>queuename</replaceable>.</para>
647                 </description>
648                 <see-also>
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>
662                 </see-also>
663         </function>
664         <function name="QUEUE_MEMBER_LIST" language="en_US">
665                 <synopsis>
666                         Returns a list of interfaces on a queue.
667                 </synopsis>
668                 <syntax>
669                         <parameter name="queuename" required="true" />
670                 </syntax>
671                 <description>
672                         <para>Returns a comma-separated list of members associated with the specified <replaceable>queuename</replaceable>.</para>
673                 </description>
674                 <see-also>
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>
688                 </see-also>
689         </function>
690         <function name="QUEUE_MEMBER_PENALTY" language="en_US">
691                 <synopsis>
692                         Gets or sets queue members penalty.
693                 </synopsis>
694                 <syntax>
695                         <parameter name="queuename" required="true" />
696                         <parameter name="interface" required="true" />
697                 </syntax>
698                 <description>
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>
701                 </description>
702                 <see-also>
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>
716                 </see-also>
717         </function>
718         <manager name="Queues" language="en_US">
719                 <synopsis>
720                         Queues.
721                 </synopsis>
722                 <syntax>
723                 </syntax>
724                 <description>
725                 </description>
726         </manager>
727         <manager name="QueueStatus" language="en_US">
728                 <synopsis>
729                         Show queue status.
730                 </synopsis>
731                 <syntax>
732                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
733                         <parameter name="Queue" />
734                         <parameter name="Member" />
735                 </syntax>
736                 <description>
737                 </description>
738         </manager>
739         <manager name="QueueSummary" language="en_US">
740                 <synopsis>
741                         Show queue summary.
742                 </synopsis>
743                 <syntax>
744                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
745                         <parameter name="Queue" />
746                 </syntax>
747                 <description>
748                 </description>
749         </manager>
750         <manager name="QueueAdd" language="en_US">
751                 <synopsis>
752                         Add interface to queue.
753                 </synopsis>
754                 <syntax>
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" />
762                 </syntax>
763                 <description>
764                 </description>
765         </manager>
766         <manager name="QueueRemove" language="en_US">
767                 <synopsis>
768                         Remove interface from queue.
769                 </synopsis>
770                 <syntax>
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" />
774                 </syntax>
775                 <description>
776                 </description>
777         </manager>
778         <manager name="QueuePause" language="en_US">
779                 <synopsis>
780                         Makes a queue member temporarily unavailable.
781                 </synopsis>
782                 <syntax>
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" />
788                 </syntax>
789                 <description>
790                 </description>
791         </manager>
792         <manager name="QueueLog" language="en_US">
793                 <synopsis>
794                         Adds custom entry in queue_log.
795                 </synopsis>
796                 <syntax>
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" />
803                 </syntax>
804                 <description>
805                 </description>
806         </manager>
807         <manager name="QueuePenalty" language="en_US">
808                 <synopsis>
809                         Set the penalty for a queue member.
810                 </synopsis>
811                 <syntax>
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" />
816                 </syntax>
817                 <description>
818                 </description>
819         </manager>
820         <manager name="QueueRule" language="en_US">
821                 <synopsis>
822                         Queue Rules.
823                 </synopsis>
824                 <syntax>
825                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
826                         <parameter name="Rule" />
827                 </syntax>
828                 <description>
829                 </description>
830         </manager>
831         <manager name="QueueReload" language="en_US">
832                 <synopsis>
833                         Reload a queue, queues, or any sub-section of a queue or queues.
834                 </synopsis>
835                 <syntax>
836                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
837                         <parameter name="Queue" />
838                         <parameter name="Members">
839                                 <enumlist>
840                                         <enum name="yes" />
841                                         <enum name="no" />
842                                 </enumlist>
843                         </parameter>
844                         <parameter name="Rules">
845                                 <enumlist>
846                                         <enum name="yes" />
847                                         <enum name="no" />
848                                 </enumlist>
849                         </parameter>
850                         <parameter name="Parameters">
851                                 <enumlist>
852                                         <enum name="yes" />
853                                         <enum name="no" />
854                                 </enumlist>
855                         </parameter>
856                 </syntax>
857                 <description>
858                 </description>
859         </manager>
860         <manager name="QueueReset" language="en_US">
861                 <synopsis>
862                         Reset queue statistics.
863                 </synopsis>
864                 <syntax>
865                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
866                         <parameter name="Queue" />
867                 </syntax>
868                 <description>
869                 </description>
870         </manager>
871  ***/
872
873 enum {
874         OPT_MARK_AS_ANSWERED =       (1 << 0),
875         OPT_GO_ON =                  (1 << 1),
876         OPT_DATA_QUALITY =           (1 << 2),
877         OPT_CALLEE_GO_ON =           (1 << 3),
878         OPT_CALLEE_HANGUP =          (1 << 4),
879         OPT_CALLER_HANGUP =          (1 << 5),
880         OPT_IGNORE_CALL_FW =         (1 << 6),
881         OPT_UPDATE_CONNECTED =       (1 << 7),
882         OPT_CALLEE_PARK =            (1 << 8),
883         OPT_CALLER_PARK =            (1 << 9),
884         OPT_NO_RETRY =               (1 << 10),
885         OPT_RINGING =                (1 << 11),
886         OPT_RING_WHEN_RINGING =      (1 << 12),
887         OPT_CALLEE_TRANSFER =        (1 << 13),
888         OPT_CALLER_TRANSFER =        (1 << 14),
889         OPT_CALLEE_AUTOMIXMON =      (1 << 15),
890         OPT_CALLER_AUTOMIXMON =      (1 << 16),
891         OPT_CALLEE_AUTOMON =         (1 << 17),
892         OPT_CALLER_AUTOMON =         (1 << 18),
893 };
894
895 enum {
896         OPT_ARG_CALLEE_GO_ON = 0,
897         /* note: this entry _MUST_ be the last one in the enum */
898         OPT_ARG_ARRAY_SIZE
899 };
900
901 AST_APP_OPTIONS(queue_exec_options, BEGIN_OPTIONS
902         AST_APP_OPTION('C', OPT_MARK_AS_ANSWERED),
903         AST_APP_OPTION('c', OPT_GO_ON),
904         AST_APP_OPTION('d', OPT_DATA_QUALITY),
905         AST_APP_OPTION_ARG('F', OPT_CALLEE_GO_ON, OPT_ARG_CALLEE_GO_ON),
906         AST_APP_OPTION('h', OPT_CALLEE_HANGUP),
907         AST_APP_OPTION('H', OPT_CALLER_HANGUP),
908         AST_APP_OPTION('i', OPT_IGNORE_CALL_FW),
909         AST_APP_OPTION('I', OPT_UPDATE_CONNECTED),
910         AST_APP_OPTION('k', OPT_CALLEE_PARK),
911         AST_APP_OPTION('K', OPT_CALLER_PARK),
912         AST_APP_OPTION('n', OPT_NO_RETRY),
913         AST_APP_OPTION('r', OPT_RINGING),
914         AST_APP_OPTION('R', OPT_RING_WHEN_RINGING),
915         AST_APP_OPTION('t', OPT_CALLEE_TRANSFER),
916         AST_APP_OPTION('T', OPT_CALLER_TRANSFER),
917         AST_APP_OPTION('x', OPT_CALLEE_AUTOMIXMON),
918         AST_APP_OPTION('X', OPT_CALLER_AUTOMIXMON),
919         AST_APP_OPTION('w', OPT_CALLEE_AUTOMON),
920         AST_APP_OPTION('W', OPT_CALLER_AUTOMON),
921 END_OPTIONS);
922
923 enum {
924         QUEUE_STRATEGY_RINGALL = 0,
925         QUEUE_STRATEGY_LEASTRECENT,
926         QUEUE_STRATEGY_FEWESTCALLS,
927         QUEUE_STRATEGY_RANDOM,
928         QUEUE_STRATEGY_RRMEMORY,
929         QUEUE_STRATEGY_LINEAR,
930         QUEUE_STRATEGY_WRANDOM,
931         QUEUE_STRATEGY_RRORDERED,
932 };
933
934 enum {
935      QUEUE_AUTOPAUSE_OFF = 0,
936      QUEUE_AUTOPAUSE_ON,
937      QUEUE_AUTOPAUSE_ALL
938 };
939
940 enum queue_reload_mask {
941         QUEUE_RELOAD_PARAMETERS = (1 << 0),
942         QUEUE_RELOAD_MEMBER = (1 << 1),
943         QUEUE_RELOAD_RULES = (1 << 2),
944         QUEUE_RESET_STATS = (1 << 3),
945 };
946
947 static const struct strategy {
948         int strategy;
949         const char *name;
950 } strategies[] = {
951         { QUEUE_STRATEGY_RINGALL, "ringall" },
952         { QUEUE_STRATEGY_LEASTRECENT, "leastrecent" },
953         { QUEUE_STRATEGY_FEWESTCALLS, "fewestcalls" },
954         { QUEUE_STRATEGY_RANDOM, "random" },
955         { QUEUE_STRATEGY_RRMEMORY, "rrmemory" },
956         { QUEUE_STRATEGY_RRMEMORY, "roundrobin" },
957         { QUEUE_STRATEGY_LINEAR, "linear" },
958         { QUEUE_STRATEGY_WRANDOM, "wrandom"},
959         { QUEUE_STRATEGY_RRORDERED, "rrordered"},
960 };
961
962 static const struct autopause {
963         int autopause;
964         const char *name;
965 } autopausesmodes [] = {
966         { QUEUE_AUTOPAUSE_OFF,"no" },
967         { QUEUE_AUTOPAUSE_ON, "yes" },
968         { QUEUE_AUTOPAUSE_ALL,"all" },
969 };
970
971
972 static struct ast_taskprocessor *devicestate_tps;
973
974 #define DEFAULT_RETRY           5
975 #define DEFAULT_TIMEOUT         15
976 #define RECHECK                 1               /*!< Recheck every second to see we we're at the top yet */
977 #define MAX_PERIODIC_ANNOUNCEMENTS 10           /*!< The maximum periodic announcements we can have */
978 #define DEFAULT_MIN_ANNOUNCE_FREQUENCY 15       /*!< The minimum number of seconds between position announcements \
979                                                      The default value of 15 provides backwards compatibility */
980 #define MAX_QUEUE_BUCKETS 53
981
982 #define RES_OKAY        0               /*!< Action completed */
983 #define RES_EXISTS      (-1)            /*!< Entry already exists */
984 #define RES_OUTOFMEMORY (-2)            /*!< Out of memory */
985 #define RES_NOSUCHQUEUE (-3)            /*!< No such queue */
986 #define RES_NOT_DYNAMIC (-4)            /*!< Member is not dynamic */
987
988 static char *app = "Queue";
989
990 static char *app_aqm = "AddQueueMember" ;
991
992 static char *app_rqm = "RemoveQueueMember" ;
993
994 static char *app_pqm = "PauseQueueMember" ;
995
996 static char *app_upqm = "UnpauseQueueMember" ;
997
998 static char *app_ql = "QueueLog" ;
999
1000 /*! \brief Persistent Members astdb family */
1001 static const char * const pm_family = "Queue/PersistentMembers";
1002 /* The maximum length of each persistent member queue database entry */
1003 #define PM_MAX_LEN 8192
1004
1005 /*! \brief queues.conf [general] option */
1006 static int queue_persistent_members = 0;
1007
1008 /*! \brief queues.conf per-queue weight option */
1009 static int use_weight = 0;
1010
1011 /*! \brief queues.conf [general] option */
1012 static int autofill_default = 1;
1013
1014 /*! \brief queues.conf [general] option */
1015 static int montype_default = 0;
1016
1017 /*! \brief queues.conf [general] option */
1018 static int shared_lastcall = 1;
1019
1020 /*! \brief Subscription to device state change events */
1021 static struct ast_event_sub *device_state_sub;
1022
1023 /*! \brief queues.conf [general] option */
1024 static int update_cdr = 0;
1025
1026 /*! \brief queues.conf [general] option */
1027 static int negative_penalty_invalid = 0;
1028
1029 /*! \brief queues.conf [general] option */
1030 static int log_membername_as_agent = 0;
1031
1032 /*! \brief queues.conf [general] option */
1033 static int check_state_unknown = 0;
1034
1035 enum queue_result {
1036         QUEUE_UNKNOWN = 0,
1037         QUEUE_TIMEOUT = 1,
1038         QUEUE_JOINEMPTY = 2,
1039         QUEUE_LEAVEEMPTY = 3,
1040         QUEUE_JOINUNAVAIL = 4,
1041         QUEUE_LEAVEUNAVAIL = 5,
1042         QUEUE_FULL = 6,
1043         QUEUE_CONTINUE = 7,
1044 };
1045
1046 static const struct {
1047         enum queue_result id;
1048         char *text;
1049 } queue_results[] = {
1050         { QUEUE_UNKNOWN, "UNKNOWN" },
1051         { QUEUE_TIMEOUT, "TIMEOUT" },
1052         { QUEUE_JOINEMPTY,"JOINEMPTY" },
1053         { QUEUE_LEAVEEMPTY, "LEAVEEMPTY" },
1054         { QUEUE_JOINUNAVAIL, "JOINUNAVAIL" },
1055         { QUEUE_LEAVEUNAVAIL, "LEAVEUNAVAIL" },
1056         { QUEUE_FULL, "FULL" },
1057         { QUEUE_CONTINUE, "CONTINUE" },
1058 };
1059
1060 enum queue_timeout_priority {
1061         TIMEOUT_PRIORITY_APP,
1062         TIMEOUT_PRIORITY_CONF,
1063 };
1064
1065 /*! \brief We define a custom "local user" structure because we
1066  *  use it not only for keeping track of what is in use but
1067  *  also for keeping track of who we're dialing.
1068  *
1069  *  There are two "links" defined in this structure, q_next and call_next.
1070  *  q_next links ALL defined callattempt structures into a linked list. call_next is
1071  *  a link which allows for a subset of the callattempts to be traversed. This subset
1072  *  is used in wait_for_answer so that irrelevant callattempts are not traversed. This
1073  *  also is helpful so that queue logs are always accurate in the case where a call to 
1074  *  a member times out, especially if using the ringall strategy. 
1075 */
1076
1077 struct callattempt {
1078         struct callattempt *q_next;
1079         struct callattempt *call_next;
1080         struct ast_channel *chan;
1081         char interface[256];
1082         int stillgoing;
1083         int metric;
1084         time_t lastcall;
1085         struct call_queue *lastqueue;
1086         struct member *member;
1087         /*! Saved connected party info from an AST_CONTROL_CONNECTED_LINE. */
1088         struct ast_party_connected_line connected;
1089         /*! TRUE if an AST_CONTROL_CONNECTED_LINE update was saved to the connected element. */
1090         unsigned int pending_connected_update:1;
1091         /*! TRUE if caller id is not available for connected line */
1092         unsigned int dial_callerid_absent:1;
1093         struct ast_aoc_decoded *aoc_s_rate_list;
1094 };
1095
1096
1097 struct queue_ent {
1098         struct call_queue *parent;             /*!< What queue is our parent */
1099         char moh[80];                          /*!< Name of musiconhold to be used */
1100         char announce[PATH_MAX];               /*!< Announcement to play for member when call is answered */
1101         char context[AST_MAX_CONTEXT];         /*!< Context when user exits queue */
1102         char digits[AST_MAX_EXTENSION];        /*!< Digits entered while in queue */
1103         int valid_digits;                      /*!< Digits entered correspond to valid extension. Exited */
1104         int pos;                               /*!< Where we are in the queue */
1105         int prio;                              /*!< Our priority */
1106         int last_pos_said;                     /*!< Last position we told the user */
1107         int ring_when_ringing;                 /*!< Should we only use ring indication when a channel is ringing? */
1108         time_t last_periodic_announce_time;    /*!< The last time we played a periodic announcement */
1109         int last_periodic_announce_sound;      /*!< The last periodic announcement we made */
1110         time_t last_pos;                       /*!< Last time we told the user their position */
1111         int opos;                              /*!< Where we started in the queue */
1112         int handled;                           /*!< Whether our call was handled */
1113         int pending;                           /*!< Non-zero if we are attempting to call a member */
1114         int max_penalty;                       /*!< Limit the members that can take this call to this penalty or lower */
1115         int min_penalty;                       /*!< Limit the members that can take this call to this penalty or higher */
1116         int linpos;                            /*!< If using linear strategy, what position are we at? */
1117         int linwrapped;                        /*!< Is the linpos wrapped? */
1118         time_t start;                          /*!< When we started holding */
1119         time_t expire;                         /*!< When this entry should expire (time out of queue) */
1120         int cancel_answered_elsewhere;         /*!< Whether we should force the CAE flag on this call (C) option*/
1121         struct ast_channel *chan;              /*!< Our channel */
1122         AST_LIST_HEAD_NOLOCK(,penalty_rule) qe_rules; /*!< Local copy of the queue's penalty rules */
1123         struct penalty_rule *pr;               /*!< Pointer to the next penalty rule to implement */
1124         struct queue_ent *next;                /*!< The next queue entry */
1125 };
1126
1127 struct member {
1128         char interface[80];                  /*!< Technology/Location to dial to reach this member*/
1129         char state_exten[AST_MAX_EXTENSION]; /*!< Extension to get state from (if using hint) */
1130         char state_context[AST_MAX_CONTEXT]; /*!< Context to use when getting state (if using hint) */
1131         char state_interface[80];            /*!< Technology/Location from which to read devicestate changes */
1132         char membername[80];                 /*!< Member name to use in queue logs */
1133         int penalty;                         /*!< Are we a last resort? */
1134         int calls;                           /*!< Number of calls serviced by this member */
1135         int dynamic;                         /*!< Are we dynamically added? */
1136         int realtime;                        /*!< Is this member realtime? */
1137         int status;                          /*!< Status of queue member */
1138         int paused;                          /*!< Are we paused (not accepting calls)? */
1139         time_t lastcall;                     /*!< When last successful call was hungup */
1140         struct call_queue *lastqueue;        /*!< Last queue we received a call */
1141         unsigned int dead:1;                 /*!< Used to detect members deleted in realtime */
1142         unsigned int delme:1;                /*!< Flag to delete entry on reload */
1143         char rt_uniqueid[80];                /*!< Unique id of realtime member entry */
1144         unsigned int ignorebusy:1;           /*!< Flag to ignore member if the status is not available */
1145 };
1146
1147 enum empty_conditions {
1148         QUEUE_EMPTY_PENALTY = (1 << 0),
1149         QUEUE_EMPTY_PAUSED = (1 << 1),
1150         QUEUE_EMPTY_INUSE = (1 << 2),
1151         QUEUE_EMPTY_RINGING = (1 << 3),
1152         QUEUE_EMPTY_UNAVAILABLE = (1 << 4),
1153         QUEUE_EMPTY_INVALID = (1 << 5),
1154         QUEUE_EMPTY_UNKNOWN = (1 << 6),
1155         QUEUE_EMPTY_WRAPUP = (1 << 7),
1156 };
1157
1158 /* values used in multi-bit flags in call_queue */
1159 #define ANNOUNCEHOLDTIME_ALWAYS 1
1160 #define ANNOUNCEHOLDTIME_ONCE 2
1161 #define QUEUE_EVENT_VARIABLES 3
1162
1163 struct penalty_rule {
1164         int time;                           /*!< Number of seconds that need to pass before applying this rule */
1165         int max_value;                      /*!< The amount specified in the penalty rule for max penalty */
1166         int min_value;                      /*!< The amount specified in the penalty rule for min penalty */
1167         int max_relative;                   /*!< Is the max adjustment relative? 1 for relative, 0 for absolute */
1168         int min_relative;                   /*!< Is the min adjustment relative? 1 for relative, 0 for absolute */
1169         AST_LIST_ENTRY(penalty_rule) list;  /*!< Next penalty_rule */
1170 };
1171
1172 #define ANNOUNCEPOSITION_YES 1 /*!< We announce position */
1173 #define ANNOUNCEPOSITION_NO 2 /*!< We don't announce position */
1174 #define ANNOUNCEPOSITION_MORE_THAN 3 /*!< We say "Currently there are more than <limit>" */
1175 #define ANNOUNCEPOSITION_LIMIT 4 /*!< We not announce position more than <limit> */
1176
1177 struct call_queue {
1178         AST_DECLARE_STRING_FIELDS(
1179                 /*! Queue name */
1180                 AST_STRING_FIELD(name);
1181                 /*! Music on Hold class */
1182                 AST_STRING_FIELD(moh);
1183                 /*! Announcement to play when call is answered */
1184                 AST_STRING_FIELD(announce);
1185                 /*! Exit context */
1186                 AST_STRING_FIELD(context);
1187                 /*! Macro to run upon member connection */
1188                 AST_STRING_FIELD(membermacro);
1189                 /*! Gosub to run upon member connection */
1190                 AST_STRING_FIELD(membergosub);
1191                 /*! Default rule to use if none specified in call to Queue() */
1192                 AST_STRING_FIELD(defaultrule);
1193                 /*! Sound file: "Your call is now first in line" (def. queue-youarenext) */
1194                 AST_STRING_FIELD(sound_next);
1195                 /*! Sound file: "There are currently" (def. queue-thereare) */
1196                 AST_STRING_FIELD(sound_thereare);
1197                 /*! Sound file: "calls waiting to speak to a representative." (def. queue-callswaiting) */
1198                 AST_STRING_FIELD(sound_calls);
1199                 /*! Sound file: "Currently there are more than" (def. queue-quantity1) */
1200                 AST_STRING_FIELD(queue_quantity1);
1201                 /*! Sound file: "callers waiting to speak with a representative" (def. queue-quantity2) */
1202                 AST_STRING_FIELD(queue_quantity2);
1203                 /*! Sound file: "The current estimated total holdtime is" (def. queue-holdtime) */
1204                 AST_STRING_FIELD(sound_holdtime);
1205                 /*! Sound file: "minutes." (def. queue-minutes) */
1206                 AST_STRING_FIELD(sound_minutes);
1207                 /*! Sound file: "minute." (def. queue-minute) */
1208                 AST_STRING_FIELD(sound_minute);
1209                 /*! Sound file: "seconds." (def. queue-seconds) */
1210                 AST_STRING_FIELD(sound_seconds);
1211                 /*! Sound file: "Thank you for your patience." (def. queue-thankyou) */
1212                 AST_STRING_FIELD(sound_thanks);
1213                 /*! Sound file: Custom announce for caller, no default */
1214                 AST_STRING_FIELD(sound_callerannounce);
1215                 /*! Sound file: "Hold time" (def. queue-reporthold) */
1216                 AST_STRING_FIELD(sound_reporthold);
1217         );
1218         /*! Sound files: Custom announce, no default */
1219         struct ast_str *sound_periodicannounce[MAX_PERIODIC_ANNOUNCEMENTS];
1220         unsigned int dead:1;
1221         unsigned int eventwhencalled:2;
1222         unsigned int ringinuse:1;
1223         unsigned int setinterfacevar:1;
1224         unsigned int setqueuevar:1;
1225         unsigned int setqueueentryvar:1;
1226         unsigned int reportholdtime:1;
1227         unsigned int wrapped:1;
1228         unsigned int timeoutrestart:1;
1229         unsigned int announceholdtime:2;
1230         unsigned int announceposition:3;
1231         int strategy:4;
1232         unsigned int maskmemberstatus:1;
1233         unsigned int realtime:1;
1234         unsigned int found:1;
1235         unsigned int relativeperiodicannounce:1;
1236         unsigned int autopausebusy:1;
1237         unsigned int autopauseunavail:1;
1238         enum empty_conditions joinempty;
1239         enum empty_conditions leavewhenempty;
1240         int announcepositionlimit;          /*!< How many positions we announce? */
1241         int announcefrequency;              /*!< How often to announce their position */
1242         int minannouncefrequency;           /*!< The minimum number of seconds between position announcements (def. 15) */
1243         int periodicannouncefrequency;      /*!< How often to play periodic announcement */
1244         int numperiodicannounce;            /*!< The number of periodic announcements configured */
1245         int randomperiodicannounce;         /*!< Are periodic announcments randomly chosen */
1246         int roundingseconds;                /*!< How many seconds do we round to? */
1247         int holdtime;                       /*!< Current avg holdtime, based on an exponential average */
1248         int talktime;                       /*!< Current avg talktime, based on the same exponential average */
1249         int callscompleted;                 /*!< Number of queue calls completed */
1250         int callsabandoned;                 /*!< Number of queue calls abandoned */
1251         int servicelevel;                   /*!< seconds setting for servicelevel*/
1252         int callscompletedinsl;             /*!< Number of calls answered with servicelevel*/
1253         char monfmt[8];                     /*!< Format to use when recording calls */
1254         int montype;                        /*!< Monitor type  Monitor vs. MixMonitor */
1255         int count;                          /*!< How many entries */
1256         int maxlen;                         /*!< Max number of entries */
1257         int wrapuptime;                     /*!< Wrapup Time */
1258         int penaltymemberslimit;            /*!< Disregard penalty when queue has fewer than this many members */
1259
1260         int retry;                          /*!< Retry calling everyone after this amount of time */
1261         int timeout;                        /*!< How long to wait for an answer */
1262         int weight;                         /*!< Respective weight */
1263         int autopause;                      /*!< Auto pause queue members if they fail to answer */
1264         int autopausedelay;                 /*!< Delay auto pause for autopausedelay seconds since last call */
1265         int timeoutpriority;                /*!< Do we allow a fraction of the timeout to occur for a ring? */
1266
1267         /* Queue strategy things */
1268         int rrpos;                          /*!< Round Robin - position */
1269         int memberdelay;                    /*!< Seconds to delay connecting member to caller */
1270         int autofill;                       /*!< Ignore the head call status and ring an available agent */
1271         
1272         struct ao2_container *members;             /*!< Head of the list of members */
1273         struct queue_ent *head;             /*!< Head of the list of callers */
1274         AST_LIST_ENTRY(call_queue) list;    /*!< Next call queue */
1275         AST_LIST_HEAD_NOLOCK(, penalty_rule) rules; /*!< The list of penalty rules to invoke */
1276 };
1277
1278 struct rule_list {
1279         char name[80];
1280         AST_LIST_HEAD_NOLOCK(,penalty_rule) rules;
1281         AST_LIST_ENTRY(rule_list) list;
1282 };
1283
1284 static AST_LIST_HEAD_STATIC(rule_lists, rule_list);
1285
1286 static struct ao2_container *queues;
1287
1288 static void update_realtime_members(struct call_queue *q);
1289 static struct member *interface_exists(struct call_queue *q, const char *interface);
1290 static int set_member_paused(const char *queuename, const char *interface, const char *reason, int paused);
1291
1292 static void queue_transfer_fixup(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan);
1293
1294 static struct member *find_member_by_queuename_and_interface(const char *queuename, const char *interface);
1295 /*! \brief sets the QUEUESTATUS channel variable */
1296 static void set_queue_result(struct ast_channel *chan, enum queue_result res)
1297 {
1298         int i;
1299
1300         for (i = 0; i < ARRAY_LEN(queue_results); i++) {
1301                 if (queue_results[i].id == res) {
1302                         pbx_builtin_setvar_helper(chan, "QUEUESTATUS", queue_results[i].text);
1303                         return;
1304                 }
1305         }
1306 }
1307
1308 static const char *int2strat(int strategy)
1309 {
1310         int x;
1311
1312         for (x = 0; x < ARRAY_LEN(strategies); x++) {
1313                 if (strategy == strategies[x].strategy)
1314                         return strategies[x].name;
1315         }
1316
1317         return "<unknown>";
1318 }
1319
1320 static int strat2int(const char *strategy)
1321 {
1322         int x;
1323
1324         for (x = 0; x < ARRAY_LEN(strategies); x++) {
1325                 if (!strcasecmp(strategy, strategies[x].name))
1326                         return strategies[x].strategy;
1327         }
1328
1329         return -1;
1330 }
1331
1332 static int autopause2int(const char *autopause)
1333 {
1334         int x;
1335         /*This 'double check' that default value is OFF */
1336         if (ast_strlen_zero(autopause))
1337                 return QUEUE_AUTOPAUSE_OFF;
1338
1339         /*This 'double check' is to ensure old values works */
1340         if(ast_true(autopause))
1341                 return QUEUE_AUTOPAUSE_ON;
1342
1343         for (x = 0; x < ARRAY_LEN(autopausesmodes); x++) {
1344                 if (!strcasecmp(autopause, autopausesmodes[x].name))
1345                         return autopausesmodes[x].autopause;
1346         }
1347
1348         /*This 'double check' that default value is OFF */
1349         return QUEUE_AUTOPAUSE_OFF;
1350 }
1351
1352 static int queue_hash_cb(const void *obj, const int flags)
1353 {
1354         const struct call_queue *q = obj;
1355
1356         return ast_str_case_hash(q->name);
1357 }
1358
1359 static int queue_cmp_cb(void *obj, void *arg, int flags)
1360 {
1361         struct call_queue *q = obj, *q2 = arg;
1362         return !strcasecmp(q->name, q2->name) ? CMP_MATCH | CMP_STOP : 0;
1363 }
1364
1365 #ifdef REF_DEBUG_ONLY_QUEUES
1366 #define queue_ref(q)                            _queue_ref(q, "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1367 #define queue_unref(q)                          _queue_unref(q, "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1368 #define queue_t_ref(q, tag)                     _queue_ref(q, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1369 #define queue_t_unref(q, tag)           _queue_unref(q, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1370 #define queues_t_link(c, q, tag)        __ao2_link_debug(c, q, 0, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1371 #define queues_t_unlink(c, q, tag)      __ao2_unlink_debug(c, q, 0, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1372
1373 static inline struct call_queue *_queue_ref(struct call_queue *q, const char *tag, const char *file, int line, const char *filename)
1374 {
1375         __ao2_ref_debug(q, 1, tag, file, line, filename);
1376         return q;
1377 }
1378
1379 static inline struct call_queue *_queue_unref(struct call_queue *q, const char *tag, const char *file, int line, const char *filename)
1380 {
1381         __ao2_ref_debug(q, -1, tag, file, line, filename);
1382         return NULL;
1383 }
1384
1385 #else
1386
1387 #define queue_t_ref(q, tag)                     queue_ref(q)
1388 #define queue_t_unref(q, tag)           queue_unref(q)
1389 #define queues_t_link(c, q, tag)        ao2_t_link(c, q, tag)
1390 #define queues_t_unlink(c, q, tag)      ao2_t_unlink(c, q, tag)
1391
1392 static inline struct call_queue *queue_ref(struct call_queue *q)
1393 {
1394         ao2_ref(q, 1);
1395         return q;
1396 }
1397
1398 static inline struct call_queue *queue_unref(struct call_queue *q)
1399 {
1400         ao2_ref(q, -1);
1401         return NULL;
1402 }
1403 #endif
1404
1405 /*! \brief Set variables of queue */
1406 static void set_queue_variables(struct call_queue *q, struct ast_channel *chan)
1407 {
1408         char interfacevar[256]="";
1409         float sl = 0;
1410
1411         ao2_lock(q);
1412
1413         if (q->setqueuevar) {
1414                 sl = 0;
1415                 if (q->callscompleted > 0) 
1416                         sl = 100 * ((float) q->callscompletedinsl / (float) q->callscompleted);
1417
1418                 snprintf(interfacevar, sizeof(interfacevar),
1419                         "QUEUENAME=%s,QUEUEMAX=%d,QUEUESTRATEGY=%s,QUEUECALLS=%d,QUEUEHOLDTIME=%d,QUEUETALKTIME=%d,QUEUECOMPLETED=%d,QUEUEABANDONED=%d,QUEUESRVLEVEL=%d,QUEUESRVLEVELPERF=%2.1f",
1420                         q->name, q->maxlen, int2strat(q->strategy), q->count, q->holdtime, q->talktime, q->callscompleted, q->callsabandoned,  q->servicelevel, sl);
1421
1422                 ao2_unlock(q);
1423         
1424                 pbx_builtin_setvar_multiple(chan, interfacevar); 
1425         } else {
1426                 ao2_unlock(q);
1427         }
1428 }
1429
1430 /*! \brief Insert the 'new' entry after the 'prev' entry of queue 'q' */
1431 static inline void insert_entry(struct call_queue *q, struct queue_ent *prev, struct queue_ent *new, int *pos)
1432 {
1433         struct queue_ent *cur;
1434
1435         if (!q || !new)
1436                 return;
1437         if (prev) {
1438                 cur = prev->next;
1439                 prev->next = new;
1440         } else {
1441                 cur = q->head;
1442                 q->head = new;
1443         }
1444         new->next = cur;
1445
1446         /* every queue_ent must have a reference to it's parent call_queue, this
1447          * reference does not go away until the end of the queue_ent's life, meaning
1448          * that even when the queue_ent leaves the call_queue this ref must remain. */
1449         queue_ref(q);
1450         new->parent = q;
1451         new->pos = ++(*pos);
1452         new->opos = *pos;
1453 }
1454
1455 /*! \brief Check if members are available
1456  *
1457  * This function checks to see if members are available to be called. If any member
1458  * is available, the function immediately returns 0. If no members are available,
1459  * then -1 is returned.
1460  */
1461 static int get_member_status(struct call_queue *q, int max_penalty, int min_penalty, enum empty_conditions conditions)
1462 {
1463         struct member *member;
1464         struct ao2_iterator mem_iter;
1465
1466         ao2_lock(q);
1467         mem_iter = ao2_iterator_init(q->members, 0);
1468         for (; (member = ao2_iterator_next(&mem_iter)); ao2_ref(member, -1)) {
1469                 if ((max_penalty && (member->penalty > max_penalty)) || (min_penalty && (member->penalty < min_penalty))) {
1470                         if (conditions & QUEUE_EMPTY_PENALTY) {
1471                                 ast_debug(4, "%s is unavailable because his penalty is not between %d and %d\n", member->membername, min_penalty, max_penalty);
1472                                 continue;
1473                         }
1474                 }
1475
1476                 switch (member->status) {
1477                 case AST_DEVICE_INVALID:
1478                         if (conditions & QUEUE_EMPTY_INVALID) {
1479                                 ast_debug(4, "%s is unavailable because his device state is 'invalid'\n", member->membername);
1480                                 break;
1481                         }
1482                         goto default_case;
1483                 case AST_DEVICE_UNAVAILABLE:
1484                         if (conditions & QUEUE_EMPTY_UNAVAILABLE) {
1485                                 ast_debug(4, "%s is unavailable because his device state is 'unavailable'\n", member->membername);
1486                                 break;
1487                         }
1488                         goto default_case;
1489                 case AST_DEVICE_INUSE:
1490                         if (conditions & QUEUE_EMPTY_INUSE) {
1491                                 ast_debug(4, "%s is unavailable because his device state is 'inuse'\n", member->membername);
1492                                 break;
1493                         }
1494                         goto default_case;
1495                 case AST_DEVICE_RINGING:
1496                         if (conditions & QUEUE_EMPTY_RINGING) {
1497                                 ast_debug(4, "%s is unavailable because his device state is 'ringing'\n", member->membername);
1498                                 break;
1499                         }
1500                         goto default_case;
1501                 case AST_DEVICE_UNKNOWN:
1502                         if (conditions & QUEUE_EMPTY_UNKNOWN) {
1503                                 ast_debug(4, "%s is unavailable because his device state is 'unknown'\n", member->membername);
1504                                 break;
1505                         }
1506                         /* Fall-through */
1507                 default:
1508                 default_case:
1509                         if (member->paused && (conditions & QUEUE_EMPTY_PAUSED)) {
1510                                 ast_debug(4, "%s is unavailable because he is paused'\n", member->membername);
1511                                 break;
1512                         } else if ((conditions & QUEUE_EMPTY_WRAPUP) && member->lastcall && q->wrapuptime && (time(NULL) - q->wrapuptime < member->lastcall)) {
1513                                 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);
1514                                 break;
1515                         } else {
1516                                 ao2_ref(member, -1);
1517                                 ao2_iterator_destroy(&mem_iter);
1518                                 ao2_unlock(q);
1519                                 ast_debug(4, "%s is available.\n", member->membername);
1520                                 return 0;
1521                         }
1522                         break;
1523                 }
1524         }
1525         ao2_iterator_destroy(&mem_iter);
1526
1527         ao2_unlock(q);
1528         return -1;
1529 }
1530
1531 struct statechange {
1532         AST_LIST_ENTRY(statechange) entry;
1533         int state;
1534         char dev[0];
1535 };
1536
1537 /*! \brief set a member's status based on device state of that member's state_interface.
1538  *
1539  * Lock interface list find sc, iterate through each queues queue_member list for member to
1540  * update state inside queues
1541 */
1542 static int update_status(struct call_queue *q, struct member *m, const int status)
1543 {
1544         m->status = status;
1545
1546         if (q->maskmemberstatus)
1547                 return 0;
1548
1549         manager_event(EVENT_FLAG_AGENT, "QueueMemberStatus",
1550                 "Queue: %s\r\n"
1551                 "Location: %s\r\n"
1552                 "MemberName: %s\r\n"
1553                 "StateInterface: %s\r\n"
1554                 "Membership: %s\r\n"
1555                 "Penalty: %d\r\n"
1556                 "CallsTaken: %d\r\n"
1557                 "LastCall: %d\r\n"
1558                 "Status: %d\r\n"
1559                 "Paused: %d\r\n",
1560                 q->name, m->interface, m->membername, m->state_interface, m->dynamic ? "dynamic" : m->realtime ? "realtime" : "static",
1561                 m->penalty, m->calls, (int)m->lastcall, m->status, m->paused
1562         );
1563
1564         return 0;
1565 }
1566
1567 /*! \brief set a member's status based on device state of that member's interface*/
1568 static int handle_statechange(void *datap)
1569 {
1570         struct statechange *sc = datap;
1571         struct ao2_iterator miter, qiter;
1572         struct member *m;
1573         struct call_queue *q;
1574         char interface[80], *slash_pos;
1575         int found = 0;
1576
1577         qiter = ao2_iterator_init(queues, 0);
1578         while ((q = ao2_t_iterator_next(&qiter, "Iterate over queues"))) {
1579                 ao2_lock(q);
1580
1581                 miter = ao2_iterator_init(q->members, 0);
1582                 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
1583                         ast_copy_string(interface, m->state_interface, sizeof(interface));
1584
1585                         if ((slash_pos = strchr(interface, '/')))
1586                                 if (!strncasecmp(interface, "Local/", 6) && (slash_pos = strchr(slash_pos + 1, '/')))
1587                                         *slash_pos = '\0';
1588
1589                         if (!strcasecmp(interface, sc->dev)) {
1590                                 found = 1;
1591                                 update_status(q, m, sc->state);
1592                                 ao2_ref(m, -1);
1593                                 break;
1594                         }
1595                 }
1596                 ao2_iterator_destroy(&miter);
1597
1598                 ao2_unlock(q);
1599                 queue_t_unref(q, "Done with iterator");
1600         }
1601         ao2_iterator_destroy(&qiter);
1602
1603         if (found)
1604                 ast_debug(1, "Device '%s' changed to state '%d' (%s)\n", sc->dev, sc->state, ast_devstate2str(sc->state));
1605         else
1606                 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));
1607
1608         ast_free(sc);
1609         return 0;
1610 }
1611
1612 static void device_state_cb(const struct ast_event *event, void *unused)
1613 {
1614         enum ast_device_state state;
1615         const char *device;
1616         struct statechange *sc;
1617         size_t datapsize;
1618
1619         state = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE);
1620         device = ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE);
1621
1622         if (ast_strlen_zero(device)) {
1623                 ast_log(LOG_ERROR, "Received invalid event that had no device IE\n");
1624                 return;
1625         }
1626         datapsize = sizeof(*sc) + strlen(device) + 1;
1627         if (!(sc = ast_calloc(1, datapsize))) {
1628                 ast_log(LOG_ERROR, "failed to calloc a state change struct\n");
1629                 return;
1630         }
1631         sc->state = state;
1632         strcpy(sc->dev, device);
1633         if (ast_taskprocessor_push(devicestate_tps, handle_statechange, sc) < 0) {
1634                 ast_free(sc);
1635         }
1636 }
1637
1638 /*! \brief Helper function which converts from extension state to device state values */
1639 static int extensionstate2devicestate(int state)
1640 {
1641         switch (state) {
1642         case AST_EXTENSION_NOT_INUSE:
1643                 state = AST_DEVICE_NOT_INUSE;
1644                 break;
1645         case AST_EXTENSION_INUSE:
1646                 state = AST_DEVICE_INUSE;
1647                 break;
1648         case AST_EXTENSION_BUSY:
1649                 state = AST_DEVICE_BUSY;
1650                 break;
1651         case AST_EXTENSION_RINGING:
1652                 state = AST_DEVICE_RINGING;
1653                 break;
1654         case AST_EXTENSION_ONHOLD:
1655                 state = AST_DEVICE_ONHOLD;
1656                 break;
1657         case AST_EXTENSION_UNAVAILABLE:
1658                 state = AST_DEVICE_UNAVAILABLE;
1659                 break;
1660         case AST_EXTENSION_REMOVED:
1661         case AST_EXTENSION_DEACTIVATED:
1662         default:
1663                 state = AST_DEVICE_INVALID;
1664                 break;
1665         }
1666
1667         return state;
1668 }
1669
1670 static int extension_state_cb(const char *context, const char *exten, enum ast_extension_states state, void *data)
1671 {
1672         struct ao2_iterator miter, qiter;
1673         struct member *m;
1674         struct call_queue *q;
1675         int found = 0, device_state = extensionstate2devicestate(state);
1676
1677         qiter = ao2_iterator_init(queues, 0);
1678         while ((q = ao2_t_iterator_next(&qiter, "Iterate through queues"))) {
1679                 ao2_lock(q);
1680
1681                 miter = ao2_iterator_init(q->members, 0);
1682                 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
1683                         if (!strcmp(m->state_context, context) && !strcmp(m->state_exten, exten)) {
1684                                 update_status(q, m, device_state);
1685                                 ao2_ref(m, -1);
1686                                 found = 1;
1687                                 break;
1688                         }
1689                 }
1690                 ao2_iterator_destroy(&miter);
1691
1692                 ao2_unlock(q);
1693                 queue_t_unref(q, "Done with iterator");
1694         }
1695         ao2_iterator_destroy(&qiter);
1696
1697         if (found) {
1698                 ast_debug(1, "Extension '%s@%s' changed to state '%d' (%s)\n", exten, context, device_state, ast_devstate2str(device_state));
1699         } else {
1700                 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",
1701                           exten, context, device_state, ast_devstate2str(device_state));
1702         }
1703
1704         return 0;
1705 }
1706
1707 /*! \brief Return the current state of a member */
1708 static int get_queue_member_status(struct member *cur)
1709 {
1710         return ast_strlen_zero(cur->state_exten) ? ast_device_state(cur->state_interface) : extensionstate2devicestate(ast_extension_state(NULL, cur->state_context, cur->state_exten));
1711 }
1712
1713 /*! \brief allocate space for new queue member and set fields based on parameters passed */
1714 static struct member *create_queue_member(const char *interface, const char *membername, int penalty, int paused, const char *state_interface)
1715 {
1716         struct member *cur;
1717
1718         if ((cur = ao2_alloc(sizeof(*cur), NULL))) {
1719                 cur->ignorebusy = 1;
1720                 cur->penalty = penalty;
1721                 cur->paused = paused;
1722                 ast_copy_string(cur->interface, interface, sizeof(cur->interface));
1723                 if (!ast_strlen_zero(state_interface)) {
1724                         ast_copy_string(cur->state_interface, state_interface, sizeof(cur->state_interface));
1725                 } else {
1726                         ast_copy_string(cur->state_interface, interface, sizeof(cur->state_interface));
1727                 }
1728                 if (!ast_strlen_zero(membername)) {
1729                         ast_copy_string(cur->membername, membername, sizeof(cur->membername));
1730                 } else {
1731                         ast_copy_string(cur->membername, interface, sizeof(cur->membername));
1732                 }
1733                 if (!strchr(cur->interface, '/')) {
1734                         ast_log(LOG_WARNING, "No location at interface '%s'\n", interface);
1735                 }
1736                 if (!strncmp(cur->state_interface, "hint:", 5)) {
1737                         char *tmp = ast_strdupa(cur->state_interface), *context = tmp;
1738                         char *exten = strsep(&context, "@") + 5;
1739
1740                         ast_copy_string(cur->state_exten, exten, sizeof(cur->state_exten));
1741                         ast_copy_string(cur->state_context, S_OR(context, "default"), sizeof(cur->state_context));
1742                 }
1743                 cur->status = get_queue_member_status(cur);
1744         }
1745
1746         return cur;
1747 }
1748
1749
1750 static int compress_char(const char c)
1751 {
1752         if (c < 32)
1753                 return 0;
1754         else if (c > 96)
1755                 return c - 64;
1756         else
1757                 return c - 32;
1758 }
1759
1760 static int member_hash_fn(const void *obj, const int flags)
1761 {
1762         const struct member *mem = obj;
1763         const char *interface = (flags & OBJ_KEY) ? obj : mem->interface;
1764         const char *chname = strchr(interface, '/');
1765         int ret = 0, i;
1766
1767         if (!chname) {
1768                 chname = interface;
1769         }
1770         for (i = 0; i < 5 && chname[i]; i++) {
1771                 ret += compress_char(chname[i]) << (i * 6);
1772         }
1773         return ret;
1774 }
1775
1776 static int member_cmp_fn(void *obj1, void *obj2, int flags)
1777 {
1778         struct member *mem1 = obj1;
1779         struct member *mem2 = obj2;
1780         const char *interface = (flags & OBJ_KEY) ? obj2 : mem2->interface;
1781
1782         return strcasecmp(mem1->interface, interface) ? 0 : CMP_MATCH | CMP_STOP;
1783 }
1784
1785 /*!
1786  * \brief Initialize Queue default values.
1787  * \note the queue's lock  must be held before executing this function
1788 */
1789 static void init_queue(struct call_queue *q)
1790 {
1791         int i;
1792         struct penalty_rule *pr_iter;
1793
1794         q->dead = 0;
1795         q->retry = DEFAULT_RETRY;
1796         q->timeout = DEFAULT_TIMEOUT;
1797         q->maxlen = 0;
1798         q->announcefrequency = 0;
1799         q->minannouncefrequency = DEFAULT_MIN_ANNOUNCE_FREQUENCY;
1800         q->announceholdtime = 1;
1801         q->announcepositionlimit = 10; /* Default 10 positions */
1802         q->announceposition = ANNOUNCEPOSITION_YES; /* Default yes */
1803         q->roundingseconds = 0; /* Default - don't announce seconds */
1804         q->servicelevel = 0;
1805         q->ringinuse = 1;
1806         q->setinterfacevar = 0;
1807         q->setqueuevar = 0;
1808         q->setqueueentryvar = 0;
1809         q->autofill = autofill_default;
1810         q->montype = montype_default;
1811         q->monfmt[0] = '\0';
1812         q->reportholdtime = 0;
1813         q->wrapuptime = 0;
1814         q->penaltymemberslimit = 0;
1815         q->joinempty = 0;
1816         q->leavewhenempty = 0;
1817         q->memberdelay = 0;
1818         q->maskmemberstatus = 0;
1819         q->eventwhencalled = 0;
1820         q->weight = 0;
1821         q->timeoutrestart = 0;
1822         q->periodicannouncefrequency = 0;
1823         q->randomperiodicannounce = 0;
1824         q->numperiodicannounce = 0;
1825         q->autopause = QUEUE_AUTOPAUSE_OFF;
1826         q->timeoutpriority = TIMEOUT_PRIORITY_APP;
1827         q->autopausedelay = 0;
1828         if (!q->members) {
1829                 if (q->strategy == QUEUE_STRATEGY_LINEAR || q->strategy == QUEUE_STRATEGY_RRORDERED)
1830                         /* linear strategy depends on order, so we have to place all members in a single bucket */
1831                         q->members = ao2_container_alloc(1, member_hash_fn, member_cmp_fn);
1832                 else
1833                         q->members = ao2_container_alloc(37, member_hash_fn, member_cmp_fn);
1834         }
1835         q->found = 1;
1836
1837         ast_string_field_set(q, sound_next, "queue-youarenext");
1838         ast_string_field_set(q, sound_thereare, "queue-thereare");
1839         ast_string_field_set(q, sound_calls, "queue-callswaiting");
1840         ast_string_field_set(q, queue_quantity1, "queue-quantity1");
1841         ast_string_field_set(q, queue_quantity2, "queue-quantity2");
1842         ast_string_field_set(q, sound_holdtime, "queue-holdtime");
1843         ast_string_field_set(q, sound_minutes, "queue-minutes");
1844         ast_string_field_set(q, sound_minute, "queue-minute");
1845         ast_string_field_set(q, sound_seconds, "queue-seconds");
1846         ast_string_field_set(q, sound_thanks, "queue-thankyou");
1847         ast_string_field_set(q, sound_reporthold, "queue-reporthold");
1848
1849         if (!q->sound_periodicannounce[0]) {
1850                 q->sound_periodicannounce[0] = ast_str_create(32);
1851         }
1852
1853         if (q->sound_periodicannounce[0]) {
1854                 ast_str_set(&q->sound_periodicannounce[0], 0, "queue-periodic-announce");
1855         }
1856
1857         for (i = 1; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) {
1858                 if (q->sound_periodicannounce[i])
1859                         ast_str_set(&q->sound_periodicannounce[i], 0, "%s", "");
1860         }
1861
1862         while ((pr_iter = AST_LIST_REMOVE_HEAD(&q->rules,list)))
1863                 ast_free(pr_iter);
1864 }
1865
1866 static void clear_queue(struct call_queue *q)
1867 {
1868         q->holdtime = 0;
1869         q->callscompleted = 0;
1870         q->callsabandoned = 0;
1871         q->callscompletedinsl = 0;
1872         q->talktime = 0;
1873
1874         if (q->members) {
1875                 struct member *mem;
1876                 struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
1877                 while ((mem = ao2_iterator_next(&mem_iter))) {
1878                         mem->calls = 0;
1879                         mem->lastcall = 0;
1880                         ao2_ref(mem, -1);
1881                 }
1882                 ao2_iterator_destroy(&mem_iter);
1883         }
1884 }
1885
1886 /*!
1887  * \brief Change queue penalty by adding rule.
1888  *
1889  * Check rule for errors with time or fomatting, see if rule is relative to rest
1890  * of queue, iterate list of rules to find correct insertion point, insert and return.
1891  * \retval -1 on failure
1892  * \retval 0 on success
1893  * \note Call this with the rule_lists locked
1894 */
1895 static int insert_penaltychange(const char *list_name, const char *content, const int linenum)
1896 {
1897         char *timestr, *maxstr, *minstr, *contentdup;
1898         struct penalty_rule *rule = NULL, *rule_iter;
1899         struct rule_list *rl_iter;
1900         int penaltychangetime, inserted = 0;
1901
1902         if (!(rule = ast_calloc(1, sizeof(*rule)))) {
1903                 return -1;
1904         }
1905
1906         contentdup = ast_strdupa(content);
1907         
1908         if (!(maxstr = strchr(contentdup, ','))) {
1909                 ast_log(LOG_WARNING, "Improperly formatted penaltychange rule at line %d. Ignoring.\n", linenum);
1910                 ast_free(rule);
1911                 return -1;
1912         }
1913
1914         *maxstr++ = '\0';
1915         timestr = contentdup;
1916
1917         if ((penaltychangetime = atoi(timestr)) < 0) {
1918                 ast_log(LOG_WARNING, "Improper time parameter specified for penaltychange rule at line %d. Ignoring.\n", linenum);
1919                 ast_free(rule);
1920                 return -1;
1921         }
1922
1923         rule->time = penaltychangetime;
1924
1925         if ((minstr = strchr(maxstr,',')))
1926                 *minstr++ = '\0';
1927         
1928         /* The last check will evaluate true if either no penalty change is indicated for a given rule
1929          * OR if a min penalty change is indicated but no max penalty change is */
1930         if (*maxstr == '+' || *maxstr == '-' || *maxstr == '\0') {
1931                 rule->max_relative = 1;
1932         }
1933
1934         rule->max_value = atoi(maxstr);
1935
1936         if (!ast_strlen_zero(minstr)) {
1937                 if (*minstr == '+' || *minstr == '-')
1938                         rule->min_relative = 1;
1939                 rule->min_value = atoi(minstr);
1940         } else /*there was no minimum specified, so assume this means no change*/
1941                 rule->min_relative = 1;
1942
1943         /*We have the rule made, now we need to insert it where it belongs*/
1944         AST_LIST_TRAVERSE(&rule_lists, rl_iter, list){
1945                 if (strcasecmp(rl_iter->name, list_name))
1946                         continue;
1947
1948                 AST_LIST_TRAVERSE_SAFE_BEGIN(&rl_iter->rules, rule_iter, list) {
1949                         if (rule->time < rule_iter->time) {
1950                                 AST_LIST_INSERT_BEFORE_CURRENT(rule, list);
1951                                 inserted = 1;
1952                                 break;
1953                         }
1954                 }
1955                 AST_LIST_TRAVERSE_SAFE_END;
1956         
1957                 if (!inserted) {
1958                         AST_LIST_INSERT_TAIL(&rl_iter->rules, rule, list);
1959                 }
1960         }
1961
1962         return 0;
1963 }
1964
1965 static void parse_empty_options(const char *value, enum empty_conditions *empty, int joinempty)
1966 {
1967         char *value_copy = ast_strdupa(value);
1968         char *option = NULL;
1969         while ((option = strsep(&value_copy, ","))) {
1970                 if (!strcasecmp(option, "paused")) {
1971                         *empty |= QUEUE_EMPTY_PAUSED;
1972                 } else if (!strcasecmp(option, "penalty")) {
1973                         *empty |= QUEUE_EMPTY_PENALTY;
1974                 } else if (!strcasecmp(option, "inuse")) {
1975                         *empty |= QUEUE_EMPTY_INUSE;
1976                 } else if (!strcasecmp(option, "ringing")) {
1977                         *empty |= QUEUE_EMPTY_RINGING;
1978                 } else if (!strcasecmp(option, "invalid")) {
1979                         *empty |= QUEUE_EMPTY_INVALID;
1980                 } else if (!strcasecmp(option, "wrapup")) {
1981                         *empty |= QUEUE_EMPTY_WRAPUP;
1982                 } else if (!strcasecmp(option, "unavailable")) {
1983                         *empty |= QUEUE_EMPTY_UNAVAILABLE;
1984                 } else if (!strcasecmp(option, "unknown")) {
1985                         *empty |= QUEUE_EMPTY_UNKNOWN;
1986                 } else if (!strcasecmp(option, "loose")) {
1987                         *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID);
1988                 } else if (!strcasecmp(option, "strict")) {
1989                         *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED | QUEUE_EMPTY_UNAVAILABLE);
1990                 } else if ((ast_false(option) && joinempty) || (ast_true(option) && !joinempty)) {
1991                         *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED);
1992                 } else if ((ast_false(option) && !joinempty) || (ast_true(option) && joinempty)) {
1993                         *empty = 0;
1994                 } else {
1995                         ast_log(LOG_WARNING, "Unknown option %s for '%s'\n", option, joinempty ? "joinempty" : "leavewhenempty");
1996                 }
1997         }
1998 }
1999
2000 /*! \brief Configure a queue parameter.
2001  * 
2002  * The failunknown flag is set for config files (and static realtime) to show
2003  * errors for unknown parameters. It is cleared for dynamic realtime to allow
2004  *  extra fields in the tables.
2005  * \note For error reporting, line number is passed for .conf static configuration,
2006  * for Realtime queues, linenum is -1.
2007 */
2008 static void queue_set_param(struct call_queue *q, const char *param, const char *val, int linenum, int failunknown)
2009 {
2010         if (!strcasecmp(param, "musicclass") || 
2011                 !strcasecmp(param, "music") || !strcasecmp(param, "musiconhold")) {
2012                 ast_string_field_set(q, moh, val);
2013         } else if (!strcasecmp(param, "announce")) {
2014                 ast_string_field_set(q, announce, val);
2015         } else if (!strcasecmp(param, "context")) {
2016                 ast_string_field_set(q, context, val);
2017         } else if (!strcasecmp(param, "timeout")) {
2018                 q->timeout = atoi(val);
2019                 if (q->timeout < 0)
2020                         q->timeout = DEFAULT_TIMEOUT;
2021         } else if (!strcasecmp(param, "ringinuse")) {
2022                 q->ringinuse = ast_true(val);
2023         } else if (!strcasecmp(param, "setinterfacevar")) {
2024                 q->setinterfacevar = ast_true(val);
2025         } else if (!strcasecmp(param, "setqueuevar")) {
2026                 q->setqueuevar = ast_true(val);
2027         } else if (!strcasecmp(param, "setqueueentryvar")) {
2028                 q->setqueueentryvar = ast_true(val);
2029         } else if (!strcasecmp(param, "monitor-format")) {
2030                 ast_copy_string(q->monfmt, val, sizeof(q->monfmt));
2031         } else if (!strcasecmp(param, "membermacro")) {
2032                 ast_string_field_set(q, membermacro, val);
2033         } else if (!strcasecmp(param, "membergosub")) {
2034                 ast_string_field_set(q, membergosub, val);
2035         } else if (!strcasecmp(param, "queue-youarenext")) {
2036                 ast_string_field_set(q, sound_next, val);
2037         } else if (!strcasecmp(param, "queue-thereare")) {
2038                 ast_string_field_set(q, sound_thereare, val);
2039         } else if (!strcasecmp(param, "queue-callswaiting")) {
2040                 ast_string_field_set(q, sound_calls, val);
2041         } else if (!strcasecmp(param, "queue-quantity1")) {
2042                 ast_string_field_set(q, queue_quantity1, val);
2043         } else if (!strcasecmp(param, "queue-quantity2")) {
2044                 ast_string_field_set(q, queue_quantity2, val);
2045         } else if (!strcasecmp(param, "queue-holdtime")) {
2046                 ast_string_field_set(q, sound_holdtime, val);
2047         } else if (!strcasecmp(param, "queue-minutes")) {
2048                 ast_string_field_set(q, sound_minutes, val);
2049         } else if (!strcasecmp(param, "queue-minute")) {
2050                 ast_string_field_set(q, sound_minute, val);
2051         } else if (!strcasecmp(param, "queue-seconds")) {
2052                 ast_string_field_set(q, sound_seconds, val);
2053         } else if (!strcasecmp(param, "queue-thankyou")) {
2054                 ast_string_field_set(q, sound_thanks, val);
2055         } else if (!strcasecmp(param, "queue-callerannounce")) {
2056                 ast_string_field_set(q, sound_callerannounce, val);
2057         } else if (!strcasecmp(param, "queue-reporthold")) {
2058                 ast_string_field_set(q, sound_reporthold, val);
2059         } else if (!strcasecmp(param, "announce-frequency")) {
2060                 q->announcefrequency = atoi(val);
2061         } else if (!strcasecmp(param, "min-announce-frequency")) {
2062                 q->minannouncefrequency = atoi(val);
2063                 ast_debug(1, "%s=%s for queue '%s'\n", param, val, q->name);
2064         } else if (!strcasecmp(param, "announce-round-seconds")) {
2065                 q->roundingseconds = atoi(val);
2066                 /* Rounding to any other values just doesn't make sense... */
2067                 if (!(q->roundingseconds == 0 || q->roundingseconds == 5 || q->roundingseconds == 10
2068                         || q->roundingseconds == 15 || q->roundingseconds == 20 || q->roundingseconds == 30)) {
2069                         if (linenum >= 0) {
2070                                 ast_log(LOG_WARNING, "'%s' isn't a valid value for %s "
2071                                         "using 0 instead for queue '%s' at line %d of queues.conf\n",
2072                                         val, param, q->name, linenum);
2073                         } else {
2074                                 ast_log(LOG_WARNING, "'%s' isn't a valid value for %s "
2075                                         "using 0 instead for queue '%s'\n", val, param, q->name);
2076                         }
2077                         q->roundingseconds=0;
2078                 }
2079         } else if (!strcasecmp(param, "announce-holdtime")) {
2080                 if (!strcasecmp(val, "once"))
2081                         q->announceholdtime = ANNOUNCEHOLDTIME_ONCE;
2082                 else if (ast_true(val))
2083                         q->announceholdtime = ANNOUNCEHOLDTIME_ALWAYS;
2084                 else
2085                         q->announceholdtime = 0;
2086         } else if (!strcasecmp(param, "announce-position")) {
2087                 if (!strcasecmp(val, "limit"))
2088                         q->announceposition = ANNOUNCEPOSITION_LIMIT;
2089                 else if (!strcasecmp(val, "more"))
2090                         q->announceposition = ANNOUNCEPOSITION_MORE_THAN;
2091                 else if (ast_true(val))
2092                         q->announceposition = ANNOUNCEPOSITION_YES;
2093                 else
2094                         q->announceposition = ANNOUNCEPOSITION_NO;
2095         } else if (!strcasecmp(param, "announce-position-limit")) {
2096                 q->announcepositionlimit = atoi(val);
2097         } else if (!strcasecmp(param, "periodic-announce")) {
2098                 if (strchr(val, ',')) {
2099                         char *s, *buf = ast_strdupa(val);
2100                         unsigned int i = 0;
2101
2102                         while ((s = strsep(&buf, ",|"))) {
2103                                 if (!q->sound_periodicannounce[i])
2104                                         q->sound_periodicannounce[i] = ast_str_create(16);
2105                                 ast_str_set(&q->sound_periodicannounce[i], 0, "%s", s);
2106                                 i++;
2107                                 if (i == MAX_PERIODIC_ANNOUNCEMENTS)
2108                                         break;
2109                         }
2110                         q->numperiodicannounce = i;
2111                 } else {
2112                         ast_str_set(&q->sound_periodicannounce[0], 0, "%s", val);
2113                         q->numperiodicannounce = 1;
2114                 }
2115         } else if (!strcasecmp(param, "periodic-announce-frequency")) {
2116                 q->periodicannouncefrequency = atoi(val);
2117         } else if (!strcasecmp(param, "relative-periodic-announce")) {
2118                 q->relativeperiodicannounce = ast_true(val);
2119         } else if (!strcasecmp(param, "random-periodic-announce")) {
2120                 q->randomperiodicannounce = ast_true(val);
2121         } else if (!strcasecmp(param, "retry")) {
2122                 q->retry = atoi(val);
2123                 if (q->retry <= 0)
2124                         q->retry = DEFAULT_RETRY;
2125         } else if (!strcasecmp(param, "wrapuptime")) {
2126                 q->wrapuptime = atoi(val);
2127         } else if (!strcasecmp(param, "penaltymemberslimit")) {
2128                 if ((sscanf(val, "%10d", &q->penaltymemberslimit) != 1)) {
2129                         q->penaltymemberslimit = 0;
2130                 }
2131         } else if (!strcasecmp(param, "autofill")) {
2132                 q->autofill = ast_true(val);
2133         } else if (!strcasecmp(param, "monitor-type")) {
2134                 if (!strcasecmp(val, "mixmonitor"))
2135                         q->montype = 1;
2136         } else if (!strcasecmp(param, "autopause")) {
2137                 q->autopause = autopause2int(val);
2138         } else if (!strcasecmp(param, "autopausedelay")) {
2139                 q->autopausedelay = atoi(val);
2140         } else if (!strcasecmp(param, "autopausebusy")) {
2141                 q->autopausebusy = ast_true(val);
2142         } else if (!strcasecmp(param, "autopauseunavail")) {
2143                 q->autopauseunavail = ast_true(val);
2144         } else if (!strcasecmp(param, "maxlen")) {
2145                 q->maxlen = atoi(val);
2146                 if (q->maxlen < 0)
2147                         q->maxlen = 0;
2148         } else if (!strcasecmp(param, "servicelevel")) {
2149                 q->servicelevel= atoi(val);
2150         } else if (!strcasecmp(param, "strategy")) {
2151                 int strategy;
2152
2153                 /* We are a static queue and already have set this, no need to do it again */
2154                 if (failunknown) {
2155                         return;
2156                 }
2157                 strategy = strat2int(val);
2158                 if (strategy < 0) {
2159                         ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
2160                                 val, q->name);
2161                         q->strategy = QUEUE_STRATEGY_RINGALL;
2162                 }
2163                 if (strategy == q->strategy) {
2164                         return;
2165                 }
2166                 if (strategy == QUEUE_STRATEGY_LINEAR) {
2167                         ast_log(LOG_WARNING, "Changing to the linear strategy currently requires asterisk to be restarted.\n");
2168                         return;
2169                 }
2170                 q->strategy = strategy;
2171         } else if (!strcasecmp(param, "joinempty")) {
2172                 parse_empty_options(val, &q->joinempty, 1);
2173         } else if (!strcasecmp(param, "leavewhenempty")) {
2174                 parse_empty_options(val, &q->leavewhenempty, 0);
2175         } else if (!strcasecmp(param, "eventmemberstatus")) {
2176                 q->maskmemberstatus = !ast_true(val);
2177         } else if (!strcasecmp(param, "eventwhencalled")) {
2178                 if (!strcasecmp(val, "vars")) {
2179                         q->eventwhencalled = QUEUE_EVENT_VARIABLES;
2180                 } else {
2181                         q->eventwhencalled = ast_true(val) ? 1 : 0;
2182                 }
2183         } else if (!strcasecmp(param, "reportholdtime")) {
2184                 q->reportholdtime = ast_true(val);
2185         } else if (!strcasecmp(param, "memberdelay")) {
2186                 q->memberdelay = atoi(val);
2187         } else if (!strcasecmp(param, "weight")) {
2188                 q->weight = atoi(val);
2189         } else if (!strcasecmp(param, "timeoutrestart")) {
2190                 q->timeoutrestart = ast_true(val);
2191         } else if (!strcasecmp(param, "defaultrule")) {
2192                 ast_string_field_set(q, defaultrule, val);
2193         } else if (!strcasecmp(param, "timeoutpriority")) {
2194                 if (!strcasecmp(val, "conf")) {
2195                         q->timeoutpriority = TIMEOUT_PRIORITY_CONF;
2196                 } else {
2197                         q->timeoutpriority = TIMEOUT_PRIORITY_APP;
2198                 }
2199         } else if (failunknown) {
2200                 if (linenum >= 0) {
2201                         ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s at line %d of queues.conf\n",
2202                                 q->name, param, linenum);
2203                 } else {
2204                         ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s\n", q->name, param);
2205                 }
2206         }
2207 }
2208
2209 /*!
2210  * \brief Find rt member record to update otherwise create one.
2211  *
2212  * Search for member in queue, if found update penalty/paused state,
2213  * if no member exists create one flag it as a RT member and add to queue member list.
2214 */
2215 static void rt_handle_member_record(struct call_queue *q, char *interface, struct ast_config *member_config)
2216 {
2217         struct member *m;
2218         struct ao2_iterator mem_iter;
2219         int penalty = 0;
2220         int paused  = 0;
2221         int found = 0;
2222         int ignorebusy = 0;
2223
2224         const char *config_val;
2225         const char *rt_uniqueid = ast_variable_retrieve(member_config, interface, "uniqueid");
2226         const char *membername = S_OR(ast_variable_retrieve(member_config, interface, "membername"), interface);
2227         const char *state_interface = S_OR(ast_variable_retrieve(member_config, interface, "state_interface"), interface);
2228         const char *penalty_str = ast_variable_retrieve(member_config, interface, "penalty");
2229         const char *paused_str = ast_variable_retrieve(member_config, interface, "paused");
2230
2231         if (ast_strlen_zero(rt_uniqueid)) {
2232                 ast_log(LOG_WARNING, "Realtime field uniqueid is empty for member %s\n", S_OR(membername, "NULL"));
2233                 return;
2234         }
2235
2236         if (penalty_str) {
2237                 penalty = atoi(penalty_str);
2238                 if ((penalty < 0) && negative_penalty_invalid) {
2239                         return;
2240                 } else if (penalty < 0) {
2241                         penalty = 0;
2242                 }
2243         }
2244
2245         if (paused_str) {
2246                 paused = atoi(paused_str);
2247                 if (paused < 0) {
2248                         paused = 0;
2249                 }
2250         }
2251
2252         if ((config_val = ast_variable_retrieve(member_config, interface, "ignorebusy"))) {
2253                 ignorebusy = ast_true(config_val);
2254         } else {
2255                 ignorebusy = 1;
2256         }
2257
2258         /* Find member by realtime uniqueid and update */
2259         mem_iter = ao2_iterator_init(q->members, 0);
2260         while ((m = ao2_iterator_next(&mem_iter))) {
2261                 if (!strcasecmp(m->rt_uniqueid, rt_uniqueid)) {
2262                         m->dead = 0;    /* Do not delete this one. */
2263                         ast_copy_string(m->rt_uniqueid, rt_uniqueid, sizeof(m->rt_uniqueid));
2264                         if (paused_str) {
2265                                 m->paused = paused;
2266                         }
2267                         if (strcasecmp(state_interface, m->state_interface)) {
2268                                 ast_copy_string(m->state_interface, state_interface, sizeof(m->state_interface));
2269                         }
2270                         m->penalty = penalty;
2271                         m->ignorebusy = ignorebusy;
2272                         found = 1;
2273                         ao2_ref(m, -1);
2274                         break;
2275                 }
2276                 ao2_ref(m, -1);
2277         }
2278         ao2_iterator_destroy(&mem_iter);
2279
2280         /* Create a new member */
2281         if (!found) {
2282                 if ((m = create_queue_member(interface, membername, penalty, paused, state_interface))) {
2283                         m->dead = 0;
2284                         m->realtime = 1;
2285                         m->ignorebusy = ignorebusy;
2286                         ast_copy_string(m->rt_uniqueid, rt_uniqueid, sizeof(m->rt_uniqueid));
2287                         if (!log_membername_as_agent) {
2288                                 ast_queue_log(q->name, "REALTIME", m->interface, "ADDMEMBER", "%s", paused ? "PAUSED" : "");
2289                         } else {
2290                                 ast_queue_log(q->name, "REALTIME", m->membername, "ADDMEMBER", "%s", paused ? "PAUSED" : "");
2291                         }
2292                         ao2_link(q->members, m);
2293                         ao2_ref(m, -1);
2294                         m = NULL;
2295                 }
2296         }
2297 }
2298
2299 /*! \brief Iterate through queue's member list and delete them */
2300 static void free_members(struct call_queue *q, int all)
2301 {
2302         /* Free non-dynamic members */
2303         struct member *cur;
2304         struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
2305
2306         while ((cur = ao2_iterator_next(&mem_iter))) {
2307                 if (all || !cur->dynamic) {
2308                         ao2_unlink(q->members, cur);
2309                 }
2310                 ao2_ref(cur, -1);
2311         }
2312         ao2_iterator_destroy(&mem_iter);
2313 }
2314
2315 /*! \brief Free queue's member list then its string fields */
2316 static void destroy_queue(void *obj)
2317 {
2318         struct call_queue *q = obj;
2319         int i;
2320
2321         free_members(q, 1);
2322         ast_string_field_free_memory(q);
2323         for (i = 0; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) {
2324                 if (q->sound_periodicannounce[i])
2325                         free(q->sound_periodicannounce[i]);
2326         }
2327         ao2_ref(q->members, -1);
2328 }
2329
2330 static struct call_queue *alloc_queue(const char *queuename)
2331 {
2332         struct call_queue *q;
2333
2334         if ((q = ao2_t_alloc(sizeof(*q), destroy_queue, "Allocate queue"))) {
2335                 if (ast_string_field_init(q, 64)) {
2336                         queue_t_unref(q, "String field allocation failed");
2337                         return NULL;
2338                 }
2339                 ast_string_field_set(q, name, queuename);
2340         }
2341         return q;
2342 }
2343
2344 /*!
2345  * \brief Reload a single queue via realtime.
2346  *
2347  * Check for statically defined queue first, check if deleted RT queue,
2348  * check for new RT queue, if queue vars are not defined init them with defaults.
2349  * reload RT queue vars, set RT queue members dead and reload them, return finished queue.
2350  * \retval the queue,
2351  * \retval NULL if it doesn't exist.
2352  * \note Should be called with the "queues" container locked.
2353 */
2354 static struct call_queue *find_queue_by_name_rt(const char *queuename, struct ast_variable *queue_vars, struct ast_config *member_config)
2355 {
2356         struct ast_variable *v;
2357         struct call_queue *q, tmpq = {
2358                 .name = queuename,
2359         };
2360         struct member *m;
2361         struct ao2_iterator mem_iter;
2362         char *interface = NULL;
2363         const char *tmp_name;
2364         char *tmp;
2365         char tmpbuf[64];        /* Must be longer than the longest queue param name. */
2366
2367         /* Static queues override realtime. */
2368         if ((q = ao2_t_find(queues, &tmpq, OBJ_POINTER, "Check if static queue exists"))) {
2369                 ao2_lock(q);
2370                 if (!q->realtime) {
2371                         if (q->dead) {
2372                                 ao2_unlock(q);
2373                                 queue_t_unref(q, "Queue is dead; can't return it");
2374                                 return NULL;
2375                         } else {
2376                                 ast_log(LOG_WARNING, "Static queue '%s' already exists. Not loading from realtime\n", q->name);
2377                                 ao2_unlock(q);
2378                                 return q;
2379                         }
2380                 }
2381         } else if (!member_config) {
2382                 /* Not found in the list, and it's not realtime ... */
2383                 return NULL;
2384         }
2385         /* Check if queue is defined in realtime. */
2386         if (!queue_vars) {
2387                 /* Delete queue from in-core list if it has been deleted in realtime. */
2388                 if (q) {
2389                         /*! \note Hmm, can't seem to distinguish a DB failure from a not
2390                            found condition... So we might delete an in-core queue
2391                            in case of DB failure. */
2392                         ast_debug(1, "Queue %s not found in realtime.\n", queuename);
2393
2394                         q->dead = 1;
2395                         /* Delete if unused (else will be deleted when last caller leaves). */
2396                         queues_t_unlink(queues, q, "Unused; removing from container");
2397                         ao2_unlock(q);
2398                         queue_t_unref(q, "Queue is dead; can't return it");
2399                 }
2400                 return NULL;
2401         }
2402
2403         /* Create a new queue if an in-core entry does not exist yet. */
2404         if (!q) {
2405                 struct ast_variable *tmpvar = NULL;
2406                 if (!(q = alloc_queue(queuename))) {
2407                         return NULL;
2408                 }
2409                 ao2_lock(q);
2410                 clear_queue(q);
2411                 q->realtime = 1;
2412                 /*Before we initialize the queue, we need to set the strategy, so that linear strategy
2413                  * will allocate the members properly
2414                  */
2415                 for (tmpvar = queue_vars; tmpvar; tmpvar = tmpvar->next) {
2416                         if (!strcasecmp(tmpvar->name, "strategy")) {
2417                                 q->strategy = strat2int(tmpvar->value);
2418                                 if (q->strategy < 0) {
2419                                         ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
2420                                         tmpvar->value, q->name);
2421                                         q->strategy = QUEUE_STRATEGY_RINGALL;
2422                                 }
2423                                 break;
2424                         }
2425                 }
2426                 /* We traversed all variables and didn't find a strategy */
2427                 if (!tmpvar) {
2428                         q->strategy = QUEUE_STRATEGY_RINGALL;
2429                 }
2430                 queues_t_link(queues, q, "Add queue to container");
2431         }
2432         init_queue(q);          /* Ensure defaults for all parameters not set explicitly. */
2433
2434         memset(tmpbuf, 0, sizeof(tmpbuf));
2435         for (v = queue_vars; v; v = v->next) {
2436                 /* Convert to dashes `-' from underscores `_' as the latter are more SQL friendly. */
2437                 if ((tmp = strchr(v->name, '_'))) {
2438                         ast_copy_string(tmpbuf, v->name, sizeof(tmpbuf));
2439                         tmp_name = tmpbuf;
2440                         tmp = tmpbuf;
2441                         while ((tmp = strchr(tmp, '_')))
2442                                 *tmp++ = '-';
2443                 } else
2444                         tmp_name = v->name;
2445
2446                 /* NULL values don't get returned from realtime; blank values should
2447                  * still get set.  If someone doesn't want a value to be set, they
2448                  * should set the realtime column to NULL, not blank. */
2449                 queue_set_param(q, tmp_name, v->value, -1, 0);
2450         }
2451
2452         /* Temporarily set realtime members dead so we can detect deleted ones. */
2453         mem_iter = ao2_iterator_init(q->members, 0);
2454         while ((m = ao2_iterator_next(&mem_iter))) {
2455                 if (m->realtime) {
2456                         m->dead = 1;
2457                 }
2458                 ao2_ref(m, -1);
2459         }
2460         ao2_iterator_destroy(&mem_iter);
2461
2462         while ((interface = ast_category_browse(member_config, interface))) {
2463                 rt_handle_member_record(q, interface, member_config);
2464         }
2465
2466         /* Delete all realtime members that have been deleted in DB. */
2467         mem_iter = ao2_iterator_init(q->members, 0);
2468         while ((m = ao2_iterator_next(&mem_iter))) {
2469                 if (m->dead) {
2470                         if (ast_strlen_zero(m->membername) || !log_membername_as_agent) {
2471                                 ast_queue_log(q->name, "REALTIME", m->interface, "REMOVEMEMBER", "%s", "");
2472                         } else {
2473                                 ast_queue_log(q->name, "REALTIME", m->membername, "REMOVEMEMBER", "%s", "");
2474                         }
2475                         ao2_unlink(q->members, m);
2476                 }
2477                 ao2_ref(m, -1);
2478         }
2479         ao2_iterator_destroy(&mem_iter);
2480
2481         ao2_unlock(q);
2482
2483         return q;
2484 }
2485
2486 /*!
2487  * note  */
2488
2489 /*!
2490  * \internal
2491  * \brief Returns reference to the named queue. If the queue is realtime, it will load the queue as well.
2492  * \param queuename - name of the desired queue
2493  *
2494  * \retval the queue
2495  * \retval NULL if it doesn't exist
2496  */
2497 static struct call_queue *find_load_queue_rt_friendly(const char *queuename)
2498 {
2499         struct ast_variable *queue_vars;
2500         struct ast_config *member_config = NULL;
2501         struct call_queue *q = NULL, tmpq = {
2502                 .name = queuename,
2503         };
2504         int prev_weight = 0;
2505
2506         /* Find the queue in the in-core list first. */
2507         q = ao2_t_find(queues, &tmpq, OBJ_POINTER, "Look for queue in memory first");
2508
2509         if (!q || q->realtime) {
2510                 /*! \note Load from realtime before taking the "queues" container lock, to avoid blocking all
2511                    queue operations while waiting for the DB.
2512
2513                    This will be two separate database transactions, so we might
2514                    see queue parameters as they were before another process
2515                    changed the queue and member list as it was after the change.
2516                    Thus we might see an empty member list when a queue is
2517                    deleted. In practise, this is unlikely to cause a problem. */
2518
2519                 queue_vars = ast_load_realtime("queues", "name", queuename, SENTINEL);
2520                 if (queue_vars) {
2521                         member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", queuename, SENTINEL);
2522                         if (!member_config) {
2523                                 ast_debug(1, "No queue_members defined in config extconfig.conf\n");
2524                                 member_config = ast_config_new();
2525                         }
2526                 }
2527                 if (q) {
2528                         prev_weight = q->weight ? 1 : 0;
2529                         queue_t_unref(q, "Need to find realtime queue");
2530                 }
2531
2532                 q = find_queue_by_name_rt(queuename, queue_vars, member_config);
2533                 ast_config_destroy(member_config);
2534                 ast_variables_destroy(queue_vars);
2535
2536                 /* update the use_weight value if the queue's has gained or lost a weight */
2537                 if (q) {
2538                         if (!q->weight && prev_weight) {
2539                                 ast_atomic_fetchadd_int(&use_weight, -1);
2540                         }
2541                         if (q->weight && !prev_weight) {
2542                                 ast_atomic_fetchadd_int(&use_weight, +1);
2543                         }
2544                 }
2545                 /* Other cases will end up with the proper value for use_weight */
2546         } else {
2547                 update_realtime_members(q);
2548         }
2549         return q;
2550 }
2551
2552 static int update_realtime_member_field(struct member *mem, const char *queue_name, const char *field, const char *value)
2553 {
2554         int ret = -1;
2555
2556         if (ast_strlen_zero(mem->rt_uniqueid))
2557                 return ret;
2558
2559         if ((ast_update_realtime("queue_members", "uniqueid", mem->rt_uniqueid, field, value, SENTINEL)) > 0)
2560                 ret = 0;
2561
2562         return ret;
2563 }
2564
2565
2566 static void update_realtime_members(struct call_queue *q)
2567 {
2568         struct ast_config *member_config = NULL;
2569         struct member *m;
2570         char *interface = NULL;
2571         struct ao2_iterator mem_iter;
2572
2573         if (!(member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", q->name , SENTINEL))) {
2574                 /*This queue doesn't have realtime members*/
2575                 ast_debug(3, "Queue %s has no realtime members defined. No need for update\n", q->name);
2576                 return;
2577         }
2578
2579         ao2_lock(q);
2580
2581         /* Temporarily set realtime  members dead so we can detect deleted ones.*/
2582         mem_iter = ao2_iterator_init(q->members, 0);
2583         while ((m = ao2_iterator_next(&mem_iter))) {
2584                 if (m->realtime)
2585                         m->dead = 1;
2586                 ao2_ref(m, -1);
2587         }
2588         ao2_iterator_destroy(&mem_iter);
2589
2590         while ((interface = ast_category_browse(member_config, interface))) {
2591                 rt_handle_member_record(q, interface, member_config);
2592         }
2593
2594         /* Delete all realtime members that have been deleted in DB. */
2595         mem_iter = ao2_iterator_init(q->members, 0);
2596         while ((m = ao2_iterator_next(&mem_iter))) {
2597                 if (m->dead) {
2598                         if (ast_strlen_zero(m->membername) || !log_membername_as_agent) {
2599                                 ast_queue_log(q->name, "REALTIME", m->interface, "REMOVEMEMBER", "%s", "");
2600                         } else {
2601                                 ast_queue_log(q->name, "REALTIME", m->membername, "REMOVEMEMBER", "%s", "");
2602                         }
2603                         ao2_unlink(q->members, m);
2604                 }
2605                 ao2_ref(m, -1);
2606         }
2607         ao2_iterator_destroy(&mem_iter);
2608         ao2_unlock(q);
2609         ast_config_destroy(member_config);
2610 }
2611
2612 static int join_queue(char *queuename, struct queue_ent *qe, enum queue_result *reason, int position)
2613 {
2614         struct call_queue *q;
2615         struct queue_ent *cur, *prev = NULL;
2616         int res = -1;
2617         int pos = 0;
2618         int inserted = 0;
2619
2620         if (!(q = find_load_queue_rt_friendly(queuename))) {
2621                 return res;
2622         }
2623         ao2_lock(q);
2624
2625         /* This is our one */
2626         if (q->joinempty) {
2627                 int status = 0;
2628                 if ((status = get_member_status(q, qe->max_penalty, qe->min_penalty, q->joinempty))) {
2629                         *reason = QUEUE_JOINEMPTY;
2630                         ao2_unlock(q);
2631                         queue_t_unref(q, "Done with realtime queue");
2632                         return res;
2633                 }
2634         }
2635         if (*reason == QUEUE_UNKNOWN && q->maxlen && (q->count >= q->maxlen))
2636                 *reason = QUEUE_FULL;
2637         else if (*reason == QUEUE_UNKNOWN) {
2638                 /* There's space for us, put us at the right position inside
2639                  * the queue.
2640                  * Take into account the priority of the calling user */
2641                 inserted = 0;
2642                 prev = NULL;
2643                 cur = q->head;
2644                 while (cur) {
2645                         /* We have higher priority than the current user, enter
2646                          * before him, after all the other users with priority
2647                          * higher or equal to our priority. */
2648                         if ((!inserted) && (qe->prio > cur->prio)) {
2649                                 insert_entry(q, prev, qe, &pos);
2650                                 inserted = 1;
2651                         }
2652                         /* <= is necessary for the position comparison because it may not be possible to enter
2653                          * at our desired position since higher-priority callers may have taken the position we want
2654                          */
2655                         if (!inserted && (qe->prio >= cur->prio) && position && (position <= pos + 1)) {
2656                                 insert_entry(q, prev, qe, &pos);
2657                                 /*pos is incremented inside insert_entry, so don't need to add 1 here*/
2658                                 if (position < pos) {
2659                                         ast_log(LOG_NOTICE, "Asked to be inserted at position %d but forced into position %d due to higher priority callers\n", position, pos);
2660                                 }
2661                                 inserted = 1;
2662                         }
2663                         cur->pos = ++pos;
2664                         prev = cur;
2665                         cur = cur->next;
2666                 }
2667                 /* No luck, join at the end of the queue */
2668                 if (!inserted)
2669                         insert_entry(q, prev, qe, &pos);
2670                 ast_copy_string(qe->moh, q->moh, sizeof(qe->moh));
2671                 ast_copy_string(qe->announce, q->announce, sizeof(qe->announce));
2672                 ast_copy_string(qe->context, q->context, sizeof(qe->context));
2673                 q->count++;
2674                 res = 0;
2675                 ast_manager_event(qe->chan, EVENT_FLAG_CALL, "Join",
2676                         "Channel: %s\r\n"
2677                         "CallerIDNum: %s\r\n"
2678                         "CallerIDName: %s\r\n"
2679                         "ConnectedLineNum: %s\r\n"
2680                         "ConnectedLineName: %s\r\n"
2681                         "Queue: %s\r\n"
2682                         "Position: %d\r\n"
2683                         "Count: %d\r\n"
2684                         "Uniqueid: %s\r\n",
2685                         ast_channel_name(qe->chan),
2686                         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> */
2687                         S_COR(ast_channel_caller(qe->chan)->id.name.valid, ast_channel_caller(qe->chan)->id.name.str, "unknown"),
2688                         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> */
2689                         S_COR(ast_channel_connected(qe->chan)->id.name.valid, ast_channel_connected(qe->chan)->id.name.str, "unknown"),
2690                         q->name, qe->pos, q->count, ast_channel_uniqueid(qe->chan));
2691                 ast_debug(1, "Queue '%s' Join, Channel '%s', Position '%d'\n", q->name, ast_channel_name(qe->chan), qe->pos );
2692         }
2693         ao2_unlock(q);
2694         queue_t_unref(q, "Done with realtime queue");
2695
2696         return res;
2697 }
2698
2699 static int play_file(struct ast_channel *chan, const char *filename)
2700 {
2701         int res;
2702
2703         if (ast_strlen_zero(filename)) {
2704                 return 0;
2705         }
2706
2707         if (!ast_fileexists(filename, NULL, ast_channel_language(chan))) {
2708                 return 0;
2709         }
2710
2711         ast_stopstream(chan);
2712
2713         res = ast_streamfile(chan, filename, ast_channel_language(chan));
2714         if (!res)
2715                 res = ast_waitstream(chan, AST_DIGIT_ANY);
2716
2717         ast_stopstream(chan);
2718
2719         return res;
2720 }
2721
2722 /*!
2723  * \brief Check for valid exit from queue via goto
2724  * \retval 0 if failure
2725  * \retval 1 if successful
2726 */
2727 static int valid_exit(struct queue_ent *qe, char digit)
2728 {
2729         int digitlen = strlen(qe->digits);
2730
2731         /* Prevent possible buffer overflow */
2732         if (digitlen < sizeof(qe->digits) - 2) {
2733                 qe->digits[digitlen] = digit;
2734                 qe->digits[digitlen + 1] = '\0';
2735         } else {
2736                 qe->digits[0] = '\0';
2737                 return 0;
2738         }
2739
2740         /* If there's no context to goto, short-circuit */
2741         if (ast_strlen_zero(qe->context))
2742                 return 0;
2743
2744         /* If the extension is bad, then reset the digits to blank */
2745         if (!ast_canmatch_extension(qe->chan, qe->context, qe->digits, 1,
2746                 S_COR(ast_channel_caller(qe->chan)->id.number.valid, ast_channel_caller(qe->chan)->id.number.str, NULL))) {
2747                 qe->digits[0] = '\0';
2748                 return 0;
2749         }
2750
2751         /* We have an exact match */
2752         if (!ast_goto_if_exists(qe->chan, qe->context, qe->digits, 1)) {
2753                 qe->valid_digits = 1;
2754                 /* Return 1 on a successful goto */
2755                 return 1;
2756         }
2757
2758         return 0;
2759 }
2760
2761 static int say_position(struct queue_ent *qe, int ringing)
2762 {
2763         int res = 0, avgholdmins, avgholdsecs, announceposition = 0;
2764         int say_thanks = 1;
2765         time_t now;
2766
2767         /* Let minannouncefrequency seconds pass between the start of each position announcement */
2768         time(&now);
2769         if ((now - qe->last_pos) < qe->parent->minannouncefrequency)
2770                 return 0;
2771
2772         /* If either our position has changed, or we are over the freq timer, say position */
2773         if ((qe->last_pos_said == qe->pos) && ((now - qe->last_pos) < qe->parent->announcefrequency))
2774                 return 0;
2775
2776         if (ringing) {
2777                 ast_indicate(qe->chan,-1);
2778         } else {
2779                 ast_moh_stop(qe->chan);
2780         }
2781
2782         if (qe->parent->announceposition == ANNOUNCEPOSITION_YES ||
2783                 qe->parent->announceposition == ANNOUNCEPOSITION_MORE_THAN ||
2784                 (qe->parent->announceposition == ANNOUNCEPOSITION_LIMIT &&
2785                 qe->pos <= qe->parent->announcepositionlimit))
2786                         announceposition = 1;
2787
2788
2789         if (announceposition == 1) {
2790                 /* Say we're next, if we are */
2791                 if (qe->pos == 1) {
2792                         res = play_file(qe->chan, qe->parent->sound_next);
2793                         if (res)
2794                                 goto playout;
2795                         else
2796                                 goto posout;
2797                 } else {
2798                         if (qe->parent->announceposition == ANNOUNCEPOSITION_MORE_THAN && qe->pos > qe->parent->announcepositionlimit){
2799                                 /* More than Case*/
2800                                 res = play_file(qe->chan, qe->parent->queue_quantity1);
2801                                 if (res)
2802                                         goto playout;
2803                                 res = ast_say_number(qe->chan, qe->parent->announcepositionlimit, AST_DIGIT_ANY, ast_channel_language(qe->chan), NULL); /* Needs gender */
2804                                 if (res)
2805                                         goto playout;
2806                         } else {
2807                                 /* Normal Case */
2808                                 res = play_file(qe->chan, qe->parent->sound_thereare);
2809                                 if (res)
2810                                         goto playout;
2811                                 res = ast_say_number(qe->chan, qe->pos, AST_DIGIT_ANY, ast_channel_language(qe->chan), NULL); /* Needs gender */
2812                                 if (res)
2813                                         goto playout;
2814                         }
2815                         if (qe->parent->announceposition == ANNOUNCEPOSITION_MORE_THAN && qe->pos > qe->parent->announcepositionlimit){
2816                                 /* More than Case*/
2817                                 res = play_file(qe->chan, qe->parent->queue_quantity2);
2818                                 if (res)
2819                                         goto playout;
2820                         } else {
2821                                 res = play_file(qe->chan, qe->parent->sound_calls);
2822                                 if (res)
2823                                         goto playout;
2824                         }
2825                 }
2826         }
2827         /* Round hold time to nearest minute */
2828         avgholdmins = abs(((qe->parent->holdtime + 30) - (now - qe->start)) / 60);
2829
2830         /* If they have specified a rounding then round the seconds as well */
2831         if (qe->parent->roundingseconds) {
2832                 avgholdsecs = (abs(((qe->parent->holdtime + 30) - (now - qe->start))) - 60 * avgholdmins) / qe->parent->roundingseconds;
2833                 avgholdsecs *= qe->parent->roundingseconds;
2834         } else {
2835                 avgholdsecs = 0;
2836         }
2837
2838         ast_verb(3, "Hold time for %s is %d minute(s) %d seconds\n", qe->parent->name, avgholdmins, avgholdsecs);
2839
2840         /* If the hold time is >1 min, if it's enabled, and if it's not
2841            supposed to be only once and we have already said it, say it */
2842     if ((avgholdmins+avgholdsecs) > 0 && qe->parent->announceholdtime &&
2843         ((qe->parent->announceholdtime == ANNOUNCEHOLDTIME_ONCE && !qe->last_pos) ||
2844         !(qe->parent->announceholdtime == ANNOUNCEHOLDTIME_ONCE))) {
2845                 res = play_file(qe->chan, qe->parent->sound_holdtime);
2846                 if (res)
2847                         goto playout;
2848
2849                 if (avgholdmins >= 1) {
2850                         res = ast_say_number(qe->chan, avgholdmins, AST_DIGIT_ANY, ast_channel_language(qe->chan), NULL);
2851                         if (res)
2852                                 goto playout;
2853
2854                         if (avgholdmins == 1) {
2855                                 res = play_file(qe->chan, qe->parent->sound_minute);
2856                                 if (res)
2857                                         goto playout;
2858                         } else {
2859                                 res = play_file(qe->chan, qe->parent->sound_minutes);
2860                                 if (res)
2861                                         goto playout;
2862                         }
2863                 }
2864                 if (avgholdsecs >= 1) {
2865                         res = ast_say_number(qe->chan, avgholdsecs, AST_DIGIT_ANY, ast_channel_language(qe->chan), NULL);
2866                         if (res)
2867                                 goto playout;
2868
2869                         res = play_file(qe->chan, qe->parent->sound_seconds);
2870                         if (res)
2871                                 goto playout;
2872                 }
2873         } else if (qe->parent->announceholdtime && !qe->parent->announceposition) {
2874                 say_thanks = 0;
2875         }
2876
2877 posout:
2878         if (qe->parent->announceposition) {
2879                 ast_verb(3, "Told %s in %s their queue position (which was %d)\n",
2880                         ast_channel_name(qe->chan), qe->parent->name, qe->pos);
2881         }
2882         if (say_thanks) {
2883                 res = play_file(qe->chan, qe->parent->sound_thanks);
2884         }
2885 playout:
2886
2887         if ((res > 0 && !valid_exit(qe, res)))
2888                 res = 0;
2889
2890         /* Set our last_pos indicators */
2891        &nb