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