06e5fc861f91f931aa2026a2b76f64ed2f984036
[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                 </syntax>
330                 <description>
331                         <para>If the interface is <emphasis>NOT</emphasis> in the queue it will return an error.</para>
332                         <para>This application sets the following channel variable upon completion:</para>
333                         <variablelist>
334                                 <variable name="RQMSTATUS">
335                                         <value name="REMOVED" />
336                                         <value name="NOTINQUEUE" />
337                                         <value name="NOSUCHQUEUE" />
338                                         <value name="NOTDYNAMIC" />
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         /*** DOCUMENTATION
1583         <managerEventInstance>
1584                 <synopsis>Raised when a Queue member's status has changed.</synopsis>
1585                 <syntax>
1586                         <parameter name="Queue">
1587                                 <para>The name of the queue.</para>
1588                         </parameter>
1589                         <parameter name="Location">
1590                                 <para>The queue member's channel technology or location.</para>
1591                         </parameter>
1592                         <parameter name="MemberName">
1593                                 <para>The name of the queue member.</para>
1594                         </parameter>
1595                         <parameter name="StateInterface">
1596                                 <para>Channel technology or location from which to read device state changes.</para>
1597                         </parameter>
1598                         <parameter name="Membership">
1599                                 <enumlist>
1600                                         <enum name="dynamic"/>
1601                                         <enum name="realtime"/>
1602                                         <enum name="static"/>
1603                                 </enumlist>
1604                         </parameter>
1605                         <parameter name="Penalty">
1606                                 <para>The penalty associated with the queue member.</para>
1607                         </parameter>
1608                         <parameter name="CallsTaken">
1609                                 <para>The number of calls this queue member has serviced.</para>
1610                         </parameter>
1611                         <parameter name="LastCall">
1612                                 <para>The time this member last took call, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
1613                         </parameter>
1614                         <parameter name="Status">
1615                                 <para>The numeric device state status of the queue member.</para>
1616                                 <enumlist>
1617                                         <enum name="0"><para>AST_DEVICE_UNKNOWN</para></enum>
1618                                         <enum name="1"><para>AST_DEVICE_NOT_INUSE</para></enum>
1619                                         <enum name="2"><para>AST_DEVICE_INUSE</para></enum>
1620                                         <enum name="3"><para>AST_DEVICE_BUSY</para></enum>
1621                                         <enum name="4"><para>AST_DEVICE_INVALID</para></enum>
1622                                         <enum name="5"><para>AST_DEVICE_UNAVAILABLE</para></enum>
1623                                         <enum name="6"><para>AST_DEVICE_RINGING</para></enum>
1624                                         <enum name="7"><para>AST_DEVICE_RINGINUSE</para></enum>
1625                                         <enum name="8"><para>AST_DEVICE_ONHOLD</para></enum>
1626                                 </enumlist>
1627                         </parameter>
1628                         <parameter name="Paused">
1629                                 <enumlist>
1630                                         <enum name="0"/>
1631                                         <enum name="1"/>
1632                                 </enumlist>
1633                         </parameter>
1634                 </syntax>
1635         </managerEventInstance>
1636         ***/
1637         manager_event(EVENT_FLAG_AGENT, "QueueMemberStatus",
1638                 "Queue: %s\r\n"
1639                 "Location: %s\r\n"
1640                 "MemberName: %s\r\n"
1641                 "StateInterface: %s\r\n"
1642                 "Membership: %s\r\n"
1643                 "Penalty: %d\r\n"
1644                 "CallsTaken: %d\r\n"
1645                 "LastCall: %d\r\n"
1646                 "Status: %d\r\n"
1647                 "Paused: %d\r\n",
1648                 q->name, m->interface, m->membername, m->state_interface, m->dynamic ? "dynamic" : m->realtime ? "realtime" : "static",
1649                 m->penalty, m->calls, (int)m->lastcall, m->status, m->paused
1650         );
1651
1652         return 0;
1653 }
1654
1655 /*! \brief set a member's status based on device state of that member's interface*/
1656 static int handle_statechange(void *datap)
1657 {
1658         struct statechange *sc = datap;
1659         struct ao2_iterator miter, qiter;
1660         struct member *m;
1661         struct call_queue *q;
1662         char interface[80], *slash_pos;
1663         int found = 0;
1664
1665         qiter = ao2_iterator_init(queues, 0);
1666         while ((q = ao2_t_iterator_next(&qiter, "Iterate over queues"))) {
1667                 ao2_lock(q);
1668
1669                 miter = ao2_iterator_init(q->members, 0);
1670                 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
1671                         ast_copy_string(interface, m->state_interface, sizeof(interface));
1672
1673                         if ((slash_pos = strchr(interface, '/'))) {
1674                                 if (!strncasecmp(interface, "Local/", 6) && (slash_pos = strchr(slash_pos + 1, '/'))) {
1675                                         *slash_pos = '\0';
1676                                 }
1677                         }
1678
1679                         if (!strcasecmp(interface, sc->dev)) {
1680                                 found = 1;
1681                                 update_status(q, m, sc->state);
1682                                 ao2_ref(m, -1);
1683                                 break;
1684                         }
1685                 }
1686                 ao2_iterator_destroy(&miter);
1687
1688                 ao2_unlock(q);
1689                 queue_t_unref(q, "Done with iterator");
1690         }
1691         ao2_iterator_destroy(&qiter);
1692
1693         if (found) {
1694                 ast_debug(1, "Device '%s' changed to state '%d' (%s)\n", sc->dev, sc->state, ast_devstate2str(sc->state));
1695         } else {
1696                 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));
1697         }
1698
1699         ast_free(sc);
1700         return 0;
1701 }
1702
1703 static void device_state_cb(const struct ast_event *event, void *unused)
1704 {
1705         enum ast_device_state state;
1706         const char *device;
1707         struct statechange *sc;
1708         size_t datapsize;
1709
1710         state = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE);
1711         device = ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE);
1712
1713         if (ast_strlen_zero(device)) {
1714                 ast_log(LOG_ERROR, "Received invalid event that had no device IE\n");
1715                 return;
1716         }
1717         datapsize = sizeof(*sc) + strlen(device) + 1;
1718         if (!(sc = ast_calloc(1, datapsize))) {
1719                 ast_log(LOG_ERROR, "failed to calloc a state change struct\n");
1720                 return;
1721         }
1722         sc->state = state;
1723         strcpy(sc->dev, device);
1724         if (ast_taskprocessor_push(devicestate_tps, handle_statechange, sc) < 0) {
1725                 ast_free(sc);
1726         }
1727 }
1728
1729 /*! \brief Helper function which converts from extension state to device state values */
1730 static int extensionstate2devicestate(int state)
1731 {
1732         switch (state) {
1733         case AST_EXTENSION_NOT_INUSE:
1734                 state = AST_DEVICE_NOT_INUSE;
1735                 break;
1736         case AST_EXTENSION_INUSE:
1737                 state = AST_DEVICE_INUSE;
1738                 break;
1739         case AST_EXTENSION_BUSY:
1740                 state = AST_DEVICE_BUSY;
1741                 break;
1742         case AST_EXTENSION_RINGING:
1743                 state = AST_DEVICE_RINGING;
1744                 break;
1745         case AST_EXTENSION_ONHOLD:
1746                 state = AST_DEVICE_ONHOLD;
1747                 break;
1748         case AST_EXTENSION_UNAVAILABLE:
1749                 state = AST_DEVICE_UNAVAILABLE;
1750                 break;
1751         case AST_EXTENSION_REMOVED:
1752         case AST_EXTENSION_DEACTIVATED:
1753         default:
1754                 state = AST_DEVICE_INVALID;
1755                 break;
1756         }
1757
1758         return state;
1759 }
1760
1761 static int extension_state_cb(char *context, char *exten, struct ast_state_cb_info *info, void *data)
1762 {
1763         struct ao2_iterator miter, qiter;
1764         struct member *m;
1765         struct call_queue *q;
1766         int state = info->exten_state;
1767         int found = 0, device_state = extensionstate2devicestate(state);
1768
1769         /* only interested in extension state updates involving device states */
1770         if (info->reason != AST_HINT_UPDATE_DEVICE) {
1771                 return 0;
1772         }
1773
1774         qiter = ao2_iterator_init(queues, 0);
1775         while ((q = ao2_t_iterator_next(&qiter, "Iterate through queues"))) {
1776                 ao2_lock(q);
1777
1778                 miter = ao2_iterator_init(q->members, 0);
1779                 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
1780                         if (!strcmp(m->state_context, context) && !strcmp(m->state_exten, exten)) {
1781                                 update_status(q, m, device_state);
1782                                 ao2_ref(m, -1);
1783                                 found = 1;
1784                                 break;
1785                         }
1786                 }
1787                 ao2_iterator_destroy(&miter);
1788
1789                 ao2_unlock(q);
1790                 queue_t_unref(q, "Done with iterator");
1791         }
1792         ao2_iterator_destroy(&qiter);
1793
1794         if (found) {
1795                 ast_debug(1, "Extension '%s@%s' changed to state '%d' (%s)\n", exten, context, device_state, ast_devstate2str(device_state));
1796         } else {
1797                 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",
1798                           exten, context, device_state, ast_devstate2str(device_state));
1799         }
1800
1801         return 0;
1802 }
1803
1804 /*! \brief Return the current state of a member */
1805 static int get_queue_member_status(struct member *cur)
1806 {
1807         return ast_strlen_zero(cur->state_exten) ? ast_device_state(cur->state_interface) : extensionstate2devicestate(ast_extension_state(NULL, cur->state_context, cur->state_exten));
1808 }
1809
1810 /*! \brief allocate space for new queue member and set fields based on parameters passed */
1811 static struct member *create_queue_member(const char *interface, const char *membername, int penalty, int paused, const char *state_interface, int ringinuse)
1812 {
1813         struct member *cur;
1814
1815         if ((cur = ao2_alloc(sizeof(*cur), NULL))) {
1816                 cur->ringinuse = ringinuse;
1817                 cur->penalty = penalty;
1818                 cur->paused = paused;
1819                 ast_copy_string(cur->interface, interface, sizeof(cur->interface));
1820                 if (!ast_strlen_zero(state_interface)) {
1821                         ast_copy_string(cur->state_interface, state_interface, sizeof(cur->state_interface));
1822                 } else {
1823                         ast_copy_string(cur->state_interface, interface, sizeof(cur->state_interface));
1824                 }
1825                 if (!ast_strlen_zero(membername)) {
1826                         ast_copy_string(cur->membername, membername, sizeof(cur->membername));
1827                 } else {
1828                         ast_copy_string(cur->membername, interface, sizeof(cur->membername));
1829                 }
1830                 if (!strchr(cur->interface, '/')) {
1831                         ast_log(LOG_WARNING, "No location at interface '%s'\n", interface);
1832                 }
1833                 if (!strncmp(cur->state_interface, "hint:", 5)) {
1834                         char *tmp = ast_strdupa(cur->state_interface), *context = tmp;
1835                         char *exten = strsep(&context, "@") + 5;
1836
1837                         ast_copy_string(cur->state_exten, exten, sizeof(cur->state_exten));
1838                         ast_copy_string(cur->state_context, S_OR(context, "default"), sizeof(cur->state_context));
1839                 }
1840                 cur->status = get_queue_member_status(cur);
1841         }
1842
1843         return cur;
1844 }
1845
1846
1847 static int compress_char(const char c)
1848 {
1849         if (c < 32) {
1850                 return 0;
1851         } else if (c > 96) {
1852                 return c - 64;
1853         } 
1854         return c - 32;
1855 }
1856
1857 static int member_hash_fn(const void *obj, const int flags)
1858 {
1859         const struct member *mem = obj;
1860         const char *interface = (flags & OBJ_KEY) ? obj : mem->interface;
1861         const char *chname = strchr(interface, '/');
1862         int ret = 0, i;
1863
1864         if (!chname) {
1865                 chname = interface;
1866         }
1867         for (i = 0; i < 5 && chname[i]; i++) {
1868                 ret += compress_char(chname[i]) << (i * 6);
1869         }
1870         return ret;
1871 }
1872
1873 static int member_cmp_fn(void *obj1, void *obj2, int flags)
1874 {
1875         struct member *mem1 = obj1;
1876         struct member *mem2 = obj2;
1877         const char *interface = (flags & OBJ_KEY) ? obj2 : mem2->interface;
1878
1879         return strcasecmp(mem1->interface, interface) ? 0 : CMP_MATCH | CMP_STOP;
1880 }
1881
1882 /*!
1883  * \brief Initialize Queue default values.
1884  * \note the queue's lock  must be held before executing this function
1885 */
1886 static void init_queue(struct call_queue *q)
1887 {
1888         int i;
1889         struct penalty_rule *pr_iter;
1890
1891         q->dead = 0;
1892         q->retry = DEFAULT_RETRY;
1893         q->timeout = DEFAULT_TIMEOUT;
1894         q->maxlen = 0;
1895         q->announcefrequency = 0;
1896         q->minannouncefrequency = DEFAULT_MIN_ANNOUNCE_FREQUENCY;
1897         q->announceholdtime = 1;
1898         q->announcepositionlimit = 10; /* Default 10 positions */
1899         q->announceposition = ANNOUNCEPOSITION_YES; /* Default yes */
1900         q->roundingseconds = 0; /* Default - don't announce seconds */
1901         q->servicelevel = 0;
1902         q->ringinuse = 1;
1903         q->setinterfacevar = 0;
1904         q->setqueuevar = 0;
1905         q->setqueueentryvar = 0;
1906         q->autofill = autofill_default;
1907         q->montype = montype_default;
1908         q->monfmt[0] = '\0';
1909         q->reportholdtime = 0;
1910         q->wrapuptime = 0;
1911         q->penaltymemberslimit = 0;
1912         q->joinempty = 0;
1913         q->leavewhenempty = 0;
1914         q->memberdelay = 0;
1915         q->maskmemberstatus = 0;
1916         q->eventwhencalled = 0;
1917         q->weight = 0;
1918         q->timeoutrestart = 0;
1919         q->periodicannouncefrequency = 0;
1920         q->randomperiodicannounce = 0;
1921         q->numperiodicannounce = 0;
1922         q->autopause = QUEUE_AUTOPAUSE_OFF;
1923         q->timeoutpriority = TIMEOUT_PRIORITY_APP;
1924         q->autopausedelay = 0;
1925         if (!q->members) {
1926                 if (q->strategy == QUEUE_STRATEGY_LINEAR || q->strategy == QUEUE_STRATEGY_RRORDERED) {
1927                         /* linear strategy depends on order, so we have to place all members in a single bucket */
1928                         q->members = ao2_container_alloc(1, member_hash_fn, member_cmp_fn);
1929                 } else {
1930                         q->members = ao2_container_alloc(37, member_hash_fn, member_cmp_fn);
1931                 }
1932         }
1933         q->found = 1;
1934
1935         ast_string_field_set(q, sound_next, "queue-youarenext");
1936         ast_string_field_set(q, sound_thereare, "queue-thereare");
1937         ast_string_field_set(q, sound_calls, "queue-callswaiting");
1938         ast_string_field_set(q, queue_quantity1, "queue-quantity1");
1939         ast_string_field_set(q, queue_quantity2, "queue-quantity2");
1940         ast_string_field_set(q, sound_holdtime, "queue-holdtime");
1941         ast_string_field_set(q, sound_minutes, "queue-minutes");
1942         ast_string_field_set(q, sound_minute, "queue-minute");
1943         ast_string_field_set(q, sound_seconds, "queue-seconds");
1944         ast_string_field_set(q, sound_thanks, "queue-thankyou");
1945         ast_string_field_set(q, sound_reporthold, "queue-reporthold");
1946
1947         if (!q->sound_periodicannounce[0]) {
1948                 q->sound_periodicannounce[0] = ast_str_create(32);
1949         }
1950
1951         if (q->sound_periodicannounce[0]) {
1952                 ast_str_set(&q->sound_periodicannounce[0], 0, "queue-periodic-announce");
1953         }
1954
1955         for (i = 1; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) {
1956                 if (q->sound_periodicannounce[i]) {
1957                         ast_str_set(&q->sound_periodicannounce[i], 0, "%s", "");
1958                 }
1959         }
1960
1961         while ((pr_iter = AST_LIST_REMOVE_HEAD(&q->rules,list))) {
1962                 ast_free(pr_iter);
1963         }
1964 }
1965
1966 static void clear_queue(struct call_queue *q)
1967 {
1968         q->holdtime = 0;
1969         q->callscompleted = 0;
1970         q->callsabandoned = 0;
1971         q->callscompletedinsl = 0;
1972         q->talktime = 0;
1973
1974         if (q->members) {
1975                 struct member *mem;
1976                 struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
1977                 while ((mem = ao2_iterator_next(&mem_iter))) {
1978                         mem->calls = 0;
1979                         mem->lastcall = 0;
1980                         ao2_ref(mem, -1);
1981                 }
1982                 ao2_iterator_destroy(&mem_iter);
1983         }
1984 }
1985
1986 /*!
1987  * \brief Change queue penalty by adding rule.
1988  *
1989  * Check rule for errors with time or fomatting, see if rule is relative to rest
1990  * of queue, iterate list of rules to find correct insertion point, insert and return.
1991  * \retval -1 on failure
1992  * \retval 0 on success
1993  * \note Call this with the rule_lists locked
1994 */
1995 static int insert_penaltychange(const char *list_name, const char *content, const int linenum)
1996 {
1997         char *timestr, *maxstr, *minstr, *contentdup;
1998         struct penalty_rule *rule = NULL, *rule_iter;
1999         struct rule_list *rl_iter;
2000         int penaltychangetime, inserted = 0;
2001
2002         if (!(rule = ast_calloc(1, sizeof(*rule)))) {
2003                 return -1;
2004         }
2005
2006         contentdup = ast_strdupa(content);
2007         
2008         if (!(maxstr = strchr(contentdup, ','))) {
2009                 ast_log(LOG_WARNING, "Improperly formatted penaltychange rule at line %d. Ignoring.\n", linenum);
2010                 ast_free(rule);
2011                 return -1;
2012         }
2013
2014         *maxstr++ = '\0';
2015         timestr = contentdup;
2016
2017         if ((penaltychangetime = atoi(timestr)) < 0) {
2018                 ast_log(LOG_WARNING, "Improper time parameter specified for penaltychange rule at line %d. Ignoring.\n", linenum);
2019                 ast_free(rule);
2020                 return -1;
2021         }
2022
2023         rule->time = penaltychangetime;
2024
2025         if ((minstr = strchr(maxstr,','))) {
2026                 *minstr++ = '\0';
2027         }
2028         
2029         /* The last check will evaluate true if either no penalty change is indicated for a given rule
2030          * OR if a min penalty change is indicated but no max penalty change is */
2031         if (*maxstr == '+' || *maxstr == '-' || *maxstr == '\0') {
2032                 rule->max_relative = 1;
2033         }
2034
2035         rule->max_value = atoi(maxstr);
2036
2037         if (!ast_strlen_zero(minstr)) {
2038                 if (*minstr == '+' || *minstr == '-') {
2039                         rule->min_relative = 1;
2040                 }
2041                 rule->min_value = atoi(minstr);
2042         } else { /*there was no minimum specified, so assume this means no change*/
2043                 rule->min_relative = 1;
2044         }
2045
2046         /*We have the rule made, now we need to insert it where it belongs*/
2047         AST_LIST_TRAVERSE(&rule_lists, rl_iter, list){
2048                 if (strcasecmp(rl_iter->name, list_name)) {
2049                         continue;
2050                 }
2051
2052                 AST_LIST_TRAVERSE_SAFE_BEGIN(&rl_iter->rules, rule_iter, list) {
2053                         if (rule->time < rule_iter->time) {
2054                                 AST_LIST_INSERT_BEFORE_CURRENT(rule, list);
2055                                 inserted = 1;
2056                                 break;
2057                         }
2058                 }
2059                 AST_LIST_TRAVERSE_SAFE_END;
2060         
2061                 if (!inserted) {
2062                         AST_LIST_INSERT_TAIL(&rl_iter->rules, rule, list);
2063                         inserted = 1;
2064                 }
2065
2066                 break;
2067         }
2068
2069         if (!inserted) {
2070                 ast_log(LOG_WARNING, "Unknown rule list name %s; ignoring.\n", list_name);
2071                 ast_free(rule);
2072                 return -1;
2073         }
2074         return 0;
2075 }
2076
2077 static void parse_empty_options(const char *value, enum empty_conditions *empty, int joinempty)
2078 {
2079         char *value_copy = ast_strdupa(value);
2080         char *option = NULL;
2081         while ((option = strsep(&value_copy, ","))) {
2082                 if (!strcasecmp(option, "paused")) {
2083                         *empty |= QUEUE_EMPTY_PAUSED;
2084                 } else if (!strcasecmp(option, "penalty")) {
2085                         *empty |= QUEUE_EMPTY_PENALTY;
2086                 } else if (!strcasecmp(option, "inuse")) {
2087                         *empty |= QUEUE_EMPTY_INUSE;
2088                 } else if (!strcasecmp(option, "ringing")) {
2089                         *empty |= QUEUE_EMPTY_RINGING;
2090                 } else if (!strcasecmp(option, "invalid")) {
2091                         *empty |= QUEUE_EMPTY_INVALID;
2092                 } else if (!strcasecmp(option, "wrapup")) {
2093                         *empty |= QUEUE_EMPTY_WRAPUP;
2094                 } else if (!strcasecmp(option, "unavailable")) {
2095                         *empty |= QUEUE_EMPTY_UNAVAILABLE;
2096                 } else if (!strcasecmp(option, "unknown")) {
2097                         *empty |= QUEUE_EMPTY_UNKNOWN;
2098                 } else if (!strcasecmp(option, "loose")) {
2099                         *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID);
2100                 } else if (!strcasecmp(option, "strict")) {
2101                         *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED | QUEUE_EMPTY_UNAVAILABLE);
2102                 } else if ((ast_false(option) && joinempty) || (ast_true(option) && !joinempty)) {
2103                         *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED);
2104                 } else if ((ast_false(option) && !joinempty) || (ast_true(option) && joinempty)) {
2105                         *empty = 0;
2106                 } else {
2107                         ast_log(LOG_WARNING, "Unknown option %s for '%s'\n", option, joinempty ? "joinempty" : "leavewhenempty");
2108                 }
2109         }
2110 }
2111
2112 /*! \brief Configure a queue parameter.
2113  * 
2114  * The failunknown flag is set for config files (and static realtime) to show
2115  * errors for unknown parameters. It is cleared for dynamic realtime to allow
2116  *  extra fields in the tables.
2117  * \note For error reporting, line number is passed for .conf static configuration,
2118  * for Realtime queues, linenum is -1.
2119 */
2120 static void queue_set_param(struct call_queue *q, const char *param, const char *val, int linenum, int failunknown)
2121 {
2122         if (!strcasecmp(param, "musicclass") || 
2123                 !strcasecmp(param, "music") || !strcasecmp(param, "musiconhold")) {
2124                 ast_string_field_set(q, moh, val);
2125         } else if (!strcasecmp(param, "announce")) {
2126                 ast_string_field_set(q, announce, val);
2127         } else if (!strcasecmp(param, "context")) {
2128                 ast_string_field_set(q, context, val);
2129         } else if (!strcasecmp(param, "timeout")) {
2130                 q->timeout = atoi(val);
2131                 if (q->timeout < 0) {
2132                         q->timeout = DEFAULT_TIMEOUT;
2133                 }
2134         } else if (!strcasecmp(param, "ringinuse")) {
2135                 q->ringinuse = ast_true(val);
2136         } else if (!strcasecmp(param, "setinterfacevar")) {
2137                 q->setinterfacevar = ast_true(val);
2138         } else if (!strcasecmp(param, "setqueuevar")) {
2139                 q->setqueuevar = ast_true(val);
2140         } else if (!strcasecmp(param, "setqueueentryvar")) {
2141                 q->setqueueentryvar = ast_true(val);
2142         } else if (!strcasecmp(param, "monitor-format")) {
2143                 ast_copy_string(q->monfmt, val, sizeof(q->monfmt));
2144         } else if (!strcasecmp(param, "membermacro")) {
2145                 ast_string_field_set(q, membermacro, val);
2146         } else if (!strcasecmp(param, "membergosub")) {
2147                 ast_string_field_set(q, membergosub, val);
2148         } else if (!strcasecmp(param, "queue-youarenext")) {
2149                 ast_string_field_set(q, sound_next, val);
2150         } else if (!strcasecmp(param, "queue-thereare")) {
2151                 ast_string_field_set(q, sound_thereare, val);
2152         } else if (!strcasecmp(param, "queue-callswaiting")) {
2153                 ast_string_field_set(q, sound_calls, val);
2154         } else if (!strcasecmp(param, "queue-quantity1")) {
2155                 ast_string_field_set(q, queue_quantity1, val);
2156         } else if (!strcasecmp(param, "queue-quantity2")) {
2157                 ast_string_field_set(q, queue_quantity2, val);
2158         } else if (!strcasecmp(param, "queue-holdtime")) {
2159                 ast_string_field_set(q, sound_holdtime, val);
2160         } else if (!strcasecmp(param, "queue-minutes")) {
2161                 ast_string_field_set(q, sound_minutes, val);
2162         } else if (!strcasecmp(param, "queue-minute")) {
2163                 ast_string_field_set(q, sound_minute, val);
2164         } else if (!strcasecmp(param, "queue-seconds")) {
2165                 ast_string_field_set(q, sound_seconds, val);
2166         } else if (!strcasecmp(param, "queue-thankyou")) {
2167                 ast_string_field_set(q, sound_thanks, val);
2168         } else if (!strcasecmp(param, "queue-callerannounce")) {
2169                 ast_string_field_set(q, sound_callerannounce, val);
2170         } else if (!strcasecmp(param, "queue-reporthold")) {
2171                 ast_string_field_set(q, sound_reporthold, val);
2172         } else if (!strcasecmp(param, "announce-frequency")) {
2173                 q->announcefrequency = atoi(val);
2174         } else if (!strcasecmp(param, "min-announce-frequency")) {
2175                 q->minannouncefrequency = atoi(val);
2176                 ast_debug(1, "%s=%s for queue '%s'\n", param, val, q->name);
2177         } else if (!strcasecmp(param, "announce-round-seconds")) {
2178                 q->roundingseconds = atoi(val);
2179                 /* Rounding to any other values just doesn't make sense... */
2180                 if (!(q->roundingseconds == 0 || q->roundingseconds == 5 || q->roundingseconds == 10
2181                         || q->roundingseconds == 15 || q->roundingseconds == 20 || q->roundingseconds == 30)) {
2182                         if (linenum >= 0) {
2183                                 ast_log(LOG_WARNING, "'%s' isn't a valid value for %s "
2184                                         "using 0 instead for queue '%s' at line %d of queues.conf\n",
2185                                         val, param, q->name, linenum);
2186                         } else {
2187                                 ast_log(LOG_WARNING, "'%s' isn't a valid value for %s "
2188                                         "using 0 instead for queue '%s'\n", val, param, q->name);
2189                         }
2190                         q->roundingseconds=0;
2191                 }
2192         } else if (!strcasecmp(param, "announce-holdtime")) {
2193                 if (!strcasecmp(val, "once")) {
2194                         q->announceholdtime = ANNOUNCEHOLDTIME_ONCE;
2195                 } else if (ast_true(val)) {
2196                         q->announceholdtime = ANNOUNCEHOLDTIME_ALWAYS;
2197                 } else {
2198                         q->announceholdtime = 0;
2199                 }
2200         } else if (!strcasecmp(param, "announce-position")) {
2201                 if (!strcasecmp(val, "limit")) {
2202                         q->announceposition = ANNOUNCEPOSITION_LIMIT;
2203                 } else if (!strcasecmp(val, "more")) {
2204                         q->announceposition = ANNOUNCEPOSITION_MORE_THAN;
2205                 } else if (ast_true(val)) {
2206                         q->announceposition = ANNOUNCEPOSITION_YES;
2207                 } else {
2208                         q->announceposition = ANNOUNCEPOSITION_NO;
2209                 }
2210         } else if (!strcasecmp(param, "announce-position-limit")) {
2211                 q->announcepositionlimit = atoi(val);
2212         } else if (!strcasecmp(param, "periodic-announce")) {
2213                 if (strchr(val, ',')) {
2214                         char *s, *buf = ast_strdupa(val);
2215                         unsigned int i = 0;
2216
2217                         while ((s = strsep(&buf, ",|"))) {
2218                                 if (!q->sound_periodicannounce[i]) {
2219                                         q->sound_periodicannounce[i] = ast_str_create(16);
2220                                 }
2221                                 ast_str_set(&q->sound_periodicannounce[i], 0, "%s", s);
2222                                 i++;
2223                                 if (i == MAX_PERIODIC_ANNOUNCEMENTS) {
2224                                         break;
2225                                 }
2226                         }
2227                         q->numperiodicannounce = i;
2228                 } else {
2229                         ast_str_set(&q->sound_periodicannounce[0], 0, "%s", val);
2230                         q->numperiodicannounce = 1;
2231                 }
2232         } else if (!strcasecmp(param, "periodic-announce-frequency")) {
2233                 q->periodicannouncefrequency = atoi(val);
2234         } else if (!strcasecmp(param, "relative-periodic-announce")) {
2235                 q->relativeperiodicannounce = ast_true(val);
2236         } else if (!strcasecmp(param, "random-periodic-announce")) {
2237                 q->randomperiodicannounce = ast_true(val);
2238         } else if (!strcasecmp(param, "retry")) {
2239                 q->retry = atoi(val);
2240                 if (q->retry <= 0) {
2241                         q->retry = DEFAULT_RETRY;
2242                 }
2243         } else if (!strcasecmp(param, "wrapuptime")) {
2244                 q->wrapuptime = atoi(val);
2245         } else if (!strcasecmp(param, "penaltymemberslimit")) {
2246                 if ((sscanf(val, "%10d", &q->penaltymemberslimit) != 1)) {
2247                         q->penaltymemberslimit = 0;
2248                 }
2249         } else if (!strcasecmp(param, "autofill")) {
2250                 q->autofill = ast_true(val);
2251         } else if (!strcasecmp(param, "monitor-type")) {
2252                 if (!strcasecmp(val, "mixmonitor")) {
2253                         q->montype = 1;
2254                 }
2255         } else if (!strcasecmp(param, "autopause")) {
2256                 q->autopause = autopause2int(val);
2257         } else if (!strcasecmp(param, "autopausedelay")) {
2258                 q->autopausedelay = atoi(val);
2259         } else if (!strcasecmp(param, "autopausebusy")) {
2260                 q->autopausebusy = ast_true(val);
2261         } else if (!strcasecmp(param, "autopauseunavail")) {
2262                 q->autopauseunavail = ast_true(val);
2263         } else if (!strcasecmp(param, "maxlen")) {
2264                 q->maxlen = atoi(val);
2265                 if (q->maxlen < 0) {
2266                         q->maxlen = 0;
2267                 }
2268         } else if (!strcasecmp(param, "servicelevel")) {
2269                 q->servicelevel= atoi(val);
2270         } else if (!strcasecmp(param, "strategy")) {
2271                 int strategy;
2272
2273                 /* We are a static queue and already have set this, no need to do it again */
2274                 if (failunknown) {
2275                         return;
2276                 }
2277                 strategy = strat2int(val);
2278                 if (strategy < 0) {
2279                         ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
2280                                 val, q->name);
2281                         q->strategy = QUEUE_STRATEGY_RINGALL;
2282                 }
2283                 if (strategy == q->strategy) {
2284                         return;
2285                 }
2286                 if (strategy == QUEUE_STRATEGY_LINEAR) {
2287                         ast_log(LOG_WARNING, "Changing to the linear strategy currently requires asterisk to be restarted.\n");
2288                         return;
2289                 }
2290                 q->strategy = strategy;
2291         } else if (!strcasecmp(param, "joinempty")) {
2292                 parse_empty_options(val, &q->joinempty, 1);
2293         } else if (!strcasecmp(param, "leavewhenempty")) {
2294                 parse_empty_options(val, &q->leavewhenempty, 0);
2295         } else if (!strcasecmp(param, "eventmemberstatus")) {
2296                 q->maskmemberstatus = !ast_true(val);
2297         } else if (!strcasecmp(param, "eventwhencalled")) {
2298                 if (!strcasecmp(val, "vars")) {
2299                         q->eventwhencalled = QUEUE_EVENT_VARIABLES;
2300                 } else {
2301                         q->eventwhencalled = ast_true(val) ? 1 : 0;
2302                 }
2303         } else if (!strcasecmp(param, "reportholdtime")) {
2304                 q->reportholdtime = ast_true(val);
2305         } else if (!strcasecmp(param, "memberdelay")) {
2306                 q->memberdelay = atoi(val);
2307         } else if (!strcasecmp(param, "weight")) {
2308                 q->weight = atoi(val);
2309         } else if (!strcasecmp(param, "timeoutrestart")) {
2310                 q->timeoutrestart = ast_true(val);
2311         } else if (!strcasecmp(param, "defaultrule")) {
2312                 ast_string_field_set(q, defaultrule, val);
2313         } else if (!strcasecmp(param, "timeoutpriority")) {
2314                 if (!strcasecmp(val, "conf")) {
2315                         q->timeoutpriority = TIMEOUT_PRIORITY_CONF;
2316                 } else {
2317                         q->timeoutpriority = TIMEOUT_PRIORITY_APP;
2318                 }
2319         } else if (failunknown) {
2320                 if (linenum >= 0) {
2321                         ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s at line %d of queues.conf\n",
2322                                 q->name, param, linenum);
2323                 } else {
2324                         ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s\n", q->name, param);
2325                 }
2326         }
2327 }
2328
2329 /*!
2330  * \brief Find rt member record to update otherwise create one.
2331  *
2332  * Search for member in queue, if found update penalty/paused state,
2333  * if no member exists create one flag it as a RT member and add to queue member list.
2334 */
2335 static void rt_handle_member_record(struct call_queue *q, char *interface, struct ast_config *member_config)
2336 {
2337         struct member *m;
2338         struct ao2_iterator mem_iter;
2339         int penalty = 0;
2340         int paused  = 0;
2341         int found = 0;
2342         int ringinuse = q->ringinuse;
2343
2344         const char *config_val;
2345         const char *rt_uniqueid = ast_variable_retrieve(member_config, interface, "uniqueid");
2346         const char *membername = S_OR(ast_variable_retrieve(member_config, interface, "membername"), interface);
2347         const char *state_interface = S_OR(ast_variable_retrieve(member_config, interface, "state_interface"), interface);
2348         const char *penalty_str = ast_variable_retrieve(member_config, interface, "penalty");
2349         const char *paused_str = ast_variable_retrieve(member_config, interface, "paused");
2350
2351         if (ast_strlen_zero(rt_uniqueid)) {
2352                 ast_log(LOG_WARNING, "Realtime field uniqueid is empty for member %s\n", S_OR(membername, "NULL"));
2353                 return;
2354         }
2355
2356         if (penalty_str) {
2357                 penalty = atoi(penalty_str);
2358                 if ((penalty < 0) && negative_penalty_invalid) {
2359                         return;
2360                 } else if (penalty < 0) {
2361                         penalty = 0;
2362                 }
2363         }
2364
2365         if (paused_str) {
2366                 paused = atoi(paused_str);
2367                 if (paused < 0) {
2368                         paused = 0;
2369                 }
2370         }
2371
2372         if ((config_val = ast_variable_retrieve(member_config, interface, realtime_ringinuse_field))) {
2373                 if (ast_true(config_val)) {
2374                         ringinuse = 1;
2375                 } else if (ast_false(config_val)) {
2376                         ringinuse = 0;
2377                 } else {
2378                         ast_log(LOG_WARNING, "Invalid value of '%s' field for %s in queue '%s'\n", realtime_ringinuse_field, interface, q->name);
2379                 }
2380         }
2381
2382         /* Find member by realtime uniqueid and update */
2383         mem_iter = ao2_iterator_init(q->members, 0);
2384         while ((m = ao2_iterator_next(&mem_iter))) {
2385                 if (!strcasecmp(m->rt_uniqueid, rt_uniqueid)) {
2386                         m->dead = 0;    /* Do not delete this one. */
2387                         ast_copy_string(m->rt_uniqueid, rt_uniqueid, sizeof(m->rt_uniqueid));
2388                         if (paused_str) {
2389                                 m->paused = paused;
2390                         }
2391                         if (strcasecmp(state_interface, m->state_interface)) {
2392                                 ast_copy_string(m->state_interface, state_interface, sizeof(m->state_interface));
2393                         }
2394                         m->penalty = penalty;
2395                         m->ringinuse = ringinuse;
2396                         found = 1;
2397                         ao2_ref(m, -1);
2398                         break;
2399                 }
2400                 ao2_ref(m, -1);
2401         }
2402         ao2_iterator_destroy(&mem_iter);
2403
2404         /* Create a new member */
2405         if (!found) {
2406                 if ((m = create_queue_member(interface, membername, penalty, paused, state_interface, ringinuse))) {
2407                         m->dead = 0;
2408                         m->realtime = 1;
2409                         ast_copy_string(m->rt_uniqueid, rt_uniqueid, sizeof(m->rt_uniqueid));
2410                         if (!log_membername_as_agent) {
2411                                 ast_queue_log(q->name, "REALTIME", m->interface, "ADDMEMBER", "%s", paused ? "PAUSED" : "");
2412                         } else {
2413                                 ast_queue_log(q->name, "REALTIME", m->membername, "ADDMEMBER", "%s", paused ? "PAUSED" : "");
2414                         }
2415                         ao2_link(q->members, m);
2416                         ao2_ref(m, -1);
2417                         m = NULL;
2418                 }
2419         }
2420 }
2421
2422 /*! \brief Iterate through queue's member list and delete them */
2423 static void free_members(struct call_queue *q, int all)
2424 {
2425         /* Free non-dynamic members */
2426         struct member *cur;
2427         struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
2428
2429         while ((cur = ao2_iterator_next(&mem_iter))) {
2430                 if (all || !cur->dynamic) {
2431                         ao2_unlink(q->members, cur);
2432                 }
2433                 ao2_ref(cur, -1);
2434         }
2435         ao2_iterator_destroy(&mem_iter);
2436 }
2437
2438 /*! \brief Free queue's member list then its string fields */
2439 static void destroy_queue(void *obj)
2440 {
2441         struct call_queue *q = obj;
2442         int i;
2443
2444         free_members(q, 1);
2445         ast_string_field_free_memory(q);
2446         for (i = 0; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) {
2447                 if (q->sound_periodicannounce[i]) {
2448                         free(q->sound_periodicannounce[i]);
2449                 }
2450         }
2451         ao2_ref(q->members, -1);
2452 }
2453
2454 static struct call_queue *alloc_queue(const char *queuename)
2455 {
2456         struct call_queue *q;
2457
2458         if ((q = ao2_t_alloc(sizeof(*q), destroy_queue, "Allocate queue"))) {
2459                 if (ast_string_field_init(q, 64)) {
2460                         queue_t_unref(q, "String field allocation failed");
2461                         return NULL;
2462                 }
2463                 ast_string_field_set(q, name, queuename);
2464         }
2465         return q;
2466 }
2467
2468 /*!
2469  * \brief Reload a single queue via realtime.
2470  *
2471  * Check for statically defined queue first, check if deleted RT queue,
2472  * check for new RT queue, if queue vars are not defined init them with defaults.
2473  * reload RT queue vars, set RT queue members dead and reload them, return finished queue.
2474  * \retval the queue,
2475  * \retval NULL if it doesn't exist.
2476  * \note Should be called with the "queues" container locked.
2477 */
2478 static struct call_queue *find_queue_by_name_rt(const char *queuename, struct ast_variable *queue_vars, struct ast_config *member_config)
2479 {
2480         struct ast_variable *v;
2481         struct call_queue *q, tmpq = {
2482                 .name = queuename,
2483         };
2484         struct member *m;
2485         struct ao2_iterator mem_iter;
2486         char *interface = NULL;
2487         const char *tmp_name;
2488         char *tmp;
2489         char tmpbuf[64];        /* Must be longer than the longest queue param name. */
2490
2491         /* Static queues override realtime. */
2492         if ((q = ao2_t_find(queues, &tmpq, OBJ_POINTER, "Check if static queue exists"))) {
2493                 ao2_lock(q);
2494                 if (!q->realtime) {
2495                         if (q->dead) {
2496                                 ao2_unlock(q);
2497                                 queue_t_unref(q, "Queue is dead; can't return it");
2498                                 return NULL;
2499                         } 
2500                         ast_log(LOG_WARNING, "Static queue '%s' already exists. Not loading from realtime\n", q->name);
2501                         ao2_unlock(q);
2502                         return q;
2503                 }
2504         } else if (!member_config) {
2505                 /* Not found in the list, and it's not realtime ... */
2506                 return NULL;
2507         }
2508         /* Check if queue is defined in realtime. */
2509         if (!queue_vars) {
2510                 /* Delete queue from in-core list if it has been deleted in realtime. */
2511                 if (q) {
2512                         /*! \note Hmm, can't seem to distinguish a DB failure from a not
2513                            found condition... So we might delete an in-core queue
2514                            in case of DB failure. */
2515                         ast_debug(1, "Queue %s not found in realtime.\n", queuename);
2516
2517                         q->dead = 1;
2518                         /* Delete if unused (else will be deleted when last caller leaves). */
2519                         queues_t_unlink(queues, q, "Unused; removing from container");
2520                         ao2_unlock(q);
2521                         queue_t_unref(q, "Queue is dead; can't return it");
2522                 }
2523                 return NULL;
2524         }
2525
2526         /* Create a new queue if an in-core entry does not exist yet. */
2527         if (!q) {
2528                 struct ast_variable *tmpvar = NULL;
2529                 if (!(q = alloc_queue(queuename))) {
2530                         return NULL;
2531                 }
2532                 ao2_lock(q);
2533                 clear_queue(q);
2534                 q->realtime = 1;
2535                 /*Before we initialize the queue, we need to set the strategy, so that linear strategy
2536                  * will allocate the members properly
2537                  */
2538                 for (tmpvar = queue_vars; tmpvar; tmpvar = tmpvar->next) {
2539                         if (!strcasecmp(tmpvar->name, "strategy")) {
2540                                 q->strategy = strat2int(tmpvar->value);
2541                                 if (q->strategy < 0) {
2542                                         ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
2543                                         tmpvar->value, q->name);
2544                                         q->strategy = QUEUE_STRATEGY_RINGALL;
2545                                 }
2546                                 break;
2547                         }
2548                 }
2549                 /* We traversed all variables and didn't find a strategy */
2550                 if (!tmpvar) {
2551                         q->strategy = QUEUE_STRATEGY_RINGALL;
2552                 }
2553                 queues_t_link(queues, q, "Add queue to container");
2554         }
2555         init_queue(q);          /* Ensure defaults for all parameters not set explicitly. */
2556
2557         memset(tmpbuf, 0, sizeof(tmpbuf));
2558         for (v = queue_vars; v; v = v->next) {
2559                 /* Convert to dashes `-' from underscores `_' as the latter are more SQL friendly. */
2560                 if (strchr(v->name, '_')) {
2561                         ast_copy_string(tmpbuf, v->name, sizeof(tmpbuf));
2562                         tmp_name = tmpbuf;
2563                         tmp = tmpbuf;
2564                         while ((tmp = strchr(tmp, '_'))) {
2565                                 *tmp++ = '-';
2566                         }
2567                 } else {
2568                         tmp_name = v->name;
2569                 }
2570
2571                 /* NULL values don't get returned from realtime; blank values should
2572                  * still get set.  If someone doesn't want a value to be set, they
2573                  * should set the realtime column to NULL, not blank. */
2574                 queue_set_param(q, tmp_name, v->value, -1, 0);
2575         }
2576
2577         /* Temporarily set realtime members dead so we can detect deleted ones. */
2578         mem_iter = ao2_iterator_init(q->members, 0);
2579         while ((m = ao2_iterator_next(&mem_iter))) {
2580                 if (m->realtime) {
2581                         m->dead = 1;
2582                 }
2583                 ao2_ref(m, -1);
2584         }
2585         ao2_iterator_destroy(&mem_iter);
2586
2587         while ((interface = ast_category_browse(member_config, interface))) {
2588                 rt_handle_member_record(q, interface, member_config);
2589         }
2590
2591         /* Delete all realtime members that have been deleted in DB. */
2592         mem_iter = ao2_iterator_init(q->members, 0);
2593         while ((m = ao2_iterator_next(&mem_iter))) {
2594                 if (m->dead) {
2595                         if (ast_strlen_zero(m->membername) || !log_membername_as_agent) {
2596                                 ast_queue_log(q->name, "REALTIME", m->interface, "REMOVEMEMBER", "%s", "");
2597                         } else {
2598                                 ast_queue_log(q->name, "REALTIME", m->membername, "REMOVEMEMBER", "%s", "");
2599                         }
2600                         ao2_unlink(q->members, m);
2601                 }
2602                 ao2_ref(m, -1);
2603         }
2604         ao2_iterator_destroy(&mem_iter);
2605
2606         ao2_unlock(q);
2607
2608         return q;
2609 }
2610
2611 /*!
2612  * note  */
2613
2614 /*!
2615  * \internal
2616  * \brief Returns reference to the named queue. If the queue is realtime, it will load the queue as well.
2617  * \param queuename - name of the desired queue
2618  *
2619  * \retval the queue
2620  * \retval NULL if it doesn't exist
2621  */
2622 static struct call_queue *find_load_queue_rt_friendly(const char *queuename)
2623 {
2624         struct ast_variable *queue_vars;
2625         struct ast_config *member_config = NULL;
2626         struct call_queue *q = NULL, tmpq = {
2627                 .name = queuename,
2628         };
2629         int prev_weight = 0;
2630
2631         /* Find the queue in the in-core list first. */
2632         q = ao2_t_find(queues, &tmpq, OBJ_POINTER, "Look for queue in memory first");
2633
2634         if (!q || q->realtime) {
2635                 /*! \note Load from realtime before taking the "queues" container lock, to avoid blocking all
2636                    queue operations while waiting for the DB.
2637
2638                    This will be two separate database transactions, so we might
2639                    see queue parameters as they were before another process
2640                    changed the queue and member list as it was after the change.
2641                    Thus we might see an empty member list when a queue is
2642                    deleted. In practise, this is unlikely to cause a problem. */
2643
2644                 queue_vars = ast_load_realtime("queues", "name", queuename, SENTINEL);
2645                 if (queue_vars) {
2646                         member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", queuename, SENTINEL);
2647                         if (!member_config) {
2648                                 ast_debug(1, "No queue_members defined in config extconfig.conf\n");
2649                                 member_config = ast_config_new();
2650                         }
2651                 }
2652                 if (q) {
2653                         prev_weight = q->weight ? 1 : 0;
2654                         queue_t_unref(q, "Need to find realtime queue");
2655                 }
2656
2657                 q = find_queue_by_name_rt(queuename, queue_vars, member_config);
2658                 ast_config_destroy(member_config);
2659                 ast_variables_destroy(queue_vars);
2660
2661                 /* update the use_weight value if the queue's has gained or lost a weight */
2662                 if (q) {
2663                         if (!q->weight && prev_weight) {
2664                                 ast_atomic_fetchadd_int(&use_weight, -1);
2665                         }
2666                         if (q->weight && !prev_weight) {
2667                                 ast_atomic_fetchadd_int(&use_weight, +1);
2668                         }
2669                 }
2670                 /* Other cases will end up with the proper value for use_weight */
2671         } else {
2672                 update_realtime_members(q);
2673         }
2674         return q;
2675 }
2676
2677 static int update_realtime_member_field(struct member *mem, const char *queue_name, const char *field, const char *value)
2678 {
2679         int ret = -1;
2680
2681         if (ast_strlen_zero(mem->rt_uniqueid)) {
2682                 return ret;
2683         }
2684
2685         if ((ast_update_realtime("queue_members", "uniqueid", mem->rt_uniqueid, field, value, SENTINEL)) > 0) {
2686                 ret = 0;
2687         }
2688
2689         return ret;
2690 }
2691
2692
2693 static void update_realtime_members(struct call_queue *q)
2694 {
2695         struct ast_config *member_config = NULL;
2696         struct member *m;
2697         char *interface = NULL;
2698         struct ao2_iterator mem_iter;
2699
2700         if (!(member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", q->name , SENTINEL))) {
2701                 /* This queue doesn't have realtime members. If the queue still has any realtime
2702                  * members in memory, they need to be removed.
2703                  */
2704                 ao2_lock(q);
2705                 mem_iter = ao2_iterator_init(q->members, 0);
2706                 while ((m = ao2_iterator_next(&mem_iter))) {
2707                         if (m->realtime) {
2708                                 ao2_unlink(q->members, m);
2709                         }
2710                         ao2_ref(m, -1);
2711                 }
2712                 ast_debug(3, "Queue %s has no realtime members defined. No need for update\n", q->name);
2713                 ao2_unlock(q);
2714                 return;
2715         }
2716
2717         ao2_lock(q);
2718
2719         /* Temporarily set realtime  members dead so we can detect deleted ones.*/
2720         mem_iter = ao2_iterator_init(q->members, 0);
2721         while ((m = ao2_iterator_next(&mem_iter))) {
2722                 if (m->realtime) {
2723                         m->dead = 1;
2724                 }
2725                 ao2_ref(m, -1);
2726         }
2727         ao2_iterator_destroy(&mem_iter);
2728
2729         while ((interface = ast_category_browse(member_config, interface))) {
2730                 rt_handle_member_record(q, interface, member_config);
2731         }
2732
2733         /* Delete all realtime members that have been deleted in DB. */
2734         mem_iter = ao2_iterator_init(q->members, 0);
2735         while ((m = ao2_iterator_next(&mem_iter))) {
2736                 if (m->dead) {
2737                         if (ast_strlen_zero(m->membername) || !log_membername_as_agent) {
2738                                 ast_queue_log(q->name, "REALTIME", m->interface, "REMOVEMEMBER", "%s", "");
2739                         } else {
2740                                 ast_queue_log(q->name, "REALTIME", m->membername, "REMOVEMEMBER", "%s", "");
2741                         }
2742                         ao2_unlink(q->members, m);
2743                 }
2744                 ao2_ref(m, -1);
2745         }
2746         ao2_iterator_destroy(&mem_iter);
2747         ao2_unlock(q);
2748         ast_config_destroy(member_config);
2749 }
2750
2751 static int join_queue(char *queuename, struct queue_ent *qe, enum queue_result *reason, int position)
2752 {
2753         struct call_queue *q;
2754         struct queue_ent *cur, *prev = NULL;
2755         int res = -1;
2756         int pos = 0;
2757         int inserted = 0;
2758
2759         if (!(q = find_load_queue_rt_friendly(queuename))) {
2760                 return res;
2761         }
2762         ao2_lock(q);
2763
2764         /* This is our one */
2765         if (q->joinempty) {
2766                 int status = 0;
2767                 if ((status = get_member_status(q, qe->max_penalty, qe->min_penalty, q->joinempty))) {
2768                         *reason = QUEUE_JOINEMPTY;
2769                         ao2_unlock(q);
2770                         queue_t_unref(q, "Done with realtime queue");
2771                         return res;
2772                 }
2773         }
2774         if (*reason == QUEUE_UNKNOWN && q->maxlen && (q->count >= q->maxlen)) {
2775                 *reason = QUEUE_FULL;
2776         } else if (*reason == QUEUE_UNKNOWN) {
2777                 /* There's space for us, put us at the right position inside
2778                  * the queue.
2779                  * Take into account the priority of the calling user */
2780                 inserted = 0;
2781                 prev = NULL;
2782                 cur = q->head;
2783                 while (cur) {
2784                         /* We have higher priority than the current user, enter
2785                          * before him, after all the other users with priority
2786                          * higher or equal to our priority. */
2787                         if ((!inserted) && (qe->prio > cur->prio)) {
2788                                 insert_entry(q, prev, qe, &pos);
2789                                 inserted = 1;
2790                         }
2791                         /* <= is necessary for the position comparison because it may not be possible to enter
2792                          * at our desired position since higher-priority callers may have taken the position we want
2793                          */
2794                         if (!inserted && (qe->prio >= cur->prio) && position && (position <= pos + 1)) {
2795                                 insert_entry(q, prev, qe, &pos);
2796                                 inserted = 1;
2797                                 /*pos is incremented inside insert_entry, so don't need to add 1 here*/
2798                                 if (position < pos) {
2799                                         ast_log(LOG_NOTICE, "Asked to be inserted at position %d but forced into position %d due to higher priority callers\n", position, pos);
2800                                 }
2801                         }
2802                         cur->pos = ++pos;
2803                         prev = cur;
2804                         cur = cur->next;
2805                 }
2806                 /* No luck, join at the end of the queue */
2807                 if (!inserted) {
2808                         insert_entry(q, prev, qe, &pos);
2809                 }
2810                 ast_copy_string(qe->moh, q->moh, sizeof(qe->moh));
2811                 ast_copy_string(qe->announce, q->announce, sizeof(qe->announce));
2812                 ast_copy_string(qe->context, q->context, sizeof(qe->context));
2813                 q->count++;
2814                 res = 0;
2815                 /*** DOCUMENTATION
2816                 <managerEventInstance>
2817                         <synopsis>Raised when a channel joins a Queue.</synopsis>
2818                         <syntax>
2819                                 <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
2820                                 <parameter name="Position">
2821                                         <para>This channel's current position in the queue.</para>
2822                                 </parameter>
2823                                 <parameter name="Count">
2824                                         <para>The total number of channels in the queue.</para>
2825                                 </parameter>
2826                         </syntax>
2827                         <see-also>
2828                                 <ref type="managerEvent">Leave</ref>
2829                                 <ref type="application">Queue</ref>
2830                         </see-also>
2831                 </managerEventInstance>
2832                 ***/
2833                 ast_manager_event(qe->chan, EVENT_FLAG_CALL, "Join",
2834                         "Channel: %s\r\n"
2835                         "CallerIDNum: %s\r\n"
2836                         "CallerIDName: %s\r\n"
2837                         "ConnectedLineNum: %s\r\n"
2838                         "ConnectedLineName: %s\r\n"
2839                         "Queue: %s\r\n"
2840                         "Position: %d\r\n"
2841                         "Count: %d\r\n"
2842                         "Uniqueid: %s\r\n",
2843                         ast_channel_name(qe->chan),
2844                         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> */
2845                         S_COR(ast_channel_caller(qe->chan)->id.name.valid, ast_channel_caller(qe->chan)->id.name.str, "unknown"),
2846                         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> */
2847                         S_COR(ast_channel_connected(qe->chan)->id.name.valid, ast_channel_connected(qe->chan)->id.name.str, "unknown"),
2848                         q->name, qe->pos, q->count, ast_channel_uniqueid(qe->chan));
2849                 ast_debug(1, "Queue '%s' Join, Channel '%s', Position '%d'\n", q->name, ast_channel_name(qe->chan), qe->pos );
2850         }
2851         ao2_unlock(q);
2852         queue_t_unref(q, "Done with realtime queue");
2853
2854         return res;
2855 }
2856
2857 static int play_file(struct ast_channel *chan, const char *filename)
2858 {
2859         int res;
2860
2861         if (ast_strlen_zero(filename)) {
2862                 return 0;
2863         }
2864
2865         if (!ast_fileexists(filename, NULL, ast_channel_language(chan))) {
2866                 return 0;
2867         }
2868
2869         ast_stopstream(chan);
2870
2871         res = ast_streamfile(chan, filename, ast_channel_language(chan));
2872         if (!res) {
2873                 res = ast_waitstream(chan, AST_DIGIT_ANY);
2874         }
2875
2876         ast_stopstream(chan);
2877
2878         return res;
2879 }
2880
2881 /*!
2882  * \brief Check for valid exit from queue via goto
2883  * \retval 0 if failure
2884  * \retval 1 if successful
2885 */
2886 static int valid_exit(struct queue_ent *qe, char digit)
2887 {
2888         int digitlen = strlen(qe->digits);
2889
2890         /* Prevent possible buffer overflow */
2891         if (digitlen < sizeof(qe->digits) - 2) {
2892                 qe->digits[digitlen] = digit;
2893                 qe->digits[digitlen + 1] = '\0';
2894         } else {
2895                 qe->digits[0] = '\0';
2896                 return 0;
2897         }
2898
2899         /* If there's no context to goto, short-circuit */
2900         if (ast_strlen_zero(qe->context)) {
2901                 return 0;
2902         }
2903
2904         /* If the extension is bad, then reset the digits to blank */
2905         if (!ast_canmatch_extension(qe->chan, qe->context, qe->digits, 1,
2906                 S_COR(ast_channel_caller(qe->chan)->id.number.valid, ast_channel_caller(qe->chan)->id.number.str, NULL))) {
2907                 qe->digits[0] = '\0';
2908                 return 0;
2909         }
2910
2911         /* We have an exact match */
2912         if (!ast_goto_if_exists(qe->chan, qe->context, qe->digits, 1)) {
2913                 qe->valid_digits = 1;
2914                 /* Return 1 on a successful goto */
2915                 return 1;
2916         }
2917
2918         return 0;
2919 }
2920
2921 static int say_position(struct queue_ent *qe, int ringing)
2922 {
2923         int res = 0, avgholdmins, avgholdsecs, announceposition = 0;
2924         int say_thanks = 1;
2925         time_t now;
2926
2927         /* Let minannouncefrequency seconds pass between the start of each position announcement */
2928         time(&now);
2929         if ((now - qe->last_pos) < qe->parent->minannouncefrequency) {
2930                 return 0;
2931         }
2932
2933         /* If either our position has changed, or we are over the freq timer, say position */
2934         if ((qe->last_pos_said == qe->pos) && ((now - qe->last_pos) < qe->parent->announcefrequency)) {
2935                 return 0;
2936         }
2937
2938         if (ringing) {
2939                 ast_indicate(qe->chan,-1);
2940         } else {
2941                 ast_moh_stop(qe->chan);
2942         }
2943
2944         if (qe->parent->announceposition == ANNOUNCEPOSITION_YES ||
2945                 qe->parent->announceposition == ANNOUNCEPOSITION_MORE_THAN ||
2946                 (qe->parent->announceposition == ANNOUNCEPOSITION_LIMIT &&
2947                 qe->pos <= qe->parent->announcepositionlimit)) {
2948                         announceposition = 1;
2949         }
2950
2951
2952         if (announceposition == 1) {
2953                 /* Say we're next, if we are */
2954                 if (qe->pos == 1) {
2955                         res = play_file(qe->chan, qe->parent->sound_next);
2956                         if (res) {
2957                                 goto playout;
2958                         }
2959                         goto posout;
2960                 } else {
2961                         if (qe->parent->announceposition == ANNOUNCEPOSITION_MORE_THAN && qe->pos > qe->parent->announcepositionlimit){
2962                                 /* More than Case*/
2963                                 res = play_file(qe->chan, qe->parent->queue_quantity1);
2964                                 if (res) {
2965                                         goto playout;
2966                                 }
2967                                 res = ast_say_number(qe->chan, qe->parent->announcepositionlimit, AST_DIGIT_ANY, ast_channel_language(qe->chan), NULL); /* Needs gender */
2968                                 if (res) {
2969                                         goto playout;
2970                                 }
2971                         } else {
2972                                 /* Normal Case */
2973                                 res = play_file(qe->chan, qe->parent->sound_thereare);
2974                                 if (res) {
2975                                         goto playout;
2976                                 }
2977                                 res = ast_say_number(qe->chan, qe->pos, AST_DIGIT_ANY, ast_channel_language(qe->chan), NULL); /* Needs gender */
2978                                 if (res) {
2979                                         goto playout;
2980                                 }
2981                         }
2982                         if (qe->parent->announceposition == ANNOUNCEPOSITION_MORE_THAN && qe->pos > qe->parent->announcepositionlimit){
2983                                 /* More than Case*/
2984                                 res = play_file(qe->chan, qe->parent->queue_quantity2);
2985                                 if (res) {
2986                                         goto playout;
2987                                 }
2988                         } else {
2989                                 res = play_file(qe->chan, qe->parent->sound_calls);
2990                                 if (res) {
2991                                         goto playout;
2992                                 }
2993                         }
2994                 }
2995         }
2996         /* Round hold time to nearest minute */
2997         avgholdmins = abs(((qe->parent->holdtime + 30) - (now - qe->start)) / 60);
2998
2999         /* If they have specified a rounding then round the seconds as well */
3000         if (qe->parent->roundingseconds) {
3001                 avgholdsecs = (abs(((qe->parent->holdtime + 30) - (now - qe->start))) - 60 * avgholdmins) / qe->parent->roundingseconds;
3002                 avgholdsecs *= qe->parent->roundingseconds;
3003         } else {
3004                 avgholdsecs = 0;
3005         }
3006
3007         ast_verb(3, "Hold time for %s is %d minute(s) %d seconds\n", qe->parent->name, avgholdmins, avgholdsecs);
3008
3009         /* If the hold time is >1 min, if it's enabled, and if it's not
3010            supposed to be only once and we have already said it, say it */
3011     if ((avgholdmins+avgholdsecs) > 0 && qe->parent->announceholdtime &&
3012         ((qe->parent->announceholdtime == ANNOUNCEHOLDTIME_ONCE && !qe->last_pos) ||
3013         !(qe->parent->announceholdtime == ANNOUNCEHOLDTIME_ONCE))) {
3014                 res = play_file(qe->chan, qe->parent->sound_holdtime);
3015                 if (res) {
3016                         goto playout;
3017                 }
3018
3019                 if (avgholdmins >= 1) {
3020                         res = ast_say_number(qe->chan, avgholdmins, AST_DIGIT_ANY, ast_channel_language(qe->chan), NULL);
3021                         if (res) {
3022                                 goto playout;
3023                         }
3024
3025                         if (avgholdmins == 1) {
3026                                 res = play_file(qe->chan, qe->parent->sound_minute);
3027                                 if (res) {
3028                                         goto playout;
3029                                 }
3030                         } else {
3031                                 res = play_file(qe->chan, qe->parent->sound_minutes);
3032                                 if (res) {
3033                                         goto playout;
3034                                 }
3035                         }
3036                 }
3037                 if (avgholdsecs >= 1) {
3038                         res = ast_say_number(qe->chan, avgholdsecs, AST_DIGIT_ANY, ast_channel_language(qe->chan), NULL);
3039                         if (res) {
3040                                 goto playout;
3041                         }
3042
3043                         res = play_file(qe->chan, qe->parent->sound_seconds);
3044                         if (res) {
3045                                 goto playout;
3046                         }
3047                 }
3048         } else if (qe->parent->announceholdtime && !qe->parent->announceposition) {
3049                 say_thanks = 0;
3050         }
3051
3052 posout:
3053         if (qe->parent->announceposition) {
3054                 ast_verb(3, "Told %s in %s their queue position (which was %d)\n",
3055                         ast_channel_name(qe->chan), qe->parent->name, qe->pos);
3056         }
3057         if (say_thanks) {
3058                 res = play_file(qe->chan, qe->parent->sound_thanks);
3059         }
3060 playout:
3061
3062         if ((res > 0 && !valid_exit(qe, res))) {
3063                 res = 0;
3064         }
3065
3066         /* Set our last_pos indicators */
3067         qe->last_pos = now;
3068         qe->last_pos_said = qe->pos;
3069
3070         /* Don't restart music on hold if we're about to exit the caller from the queue */
3071         if (!res) {
3072                 if (ringing) {
3073                         ast_indicate(qe->chan, AST_CONTROL_RINGING);
3074                 } else {
3075                         ast_moh_start(qe->chan, qe->moh, NULL);
3076                 }
3077         }
3078         return res;
3079 }
3080
3081 static void recalc_holdtime(struct queue_ent *qe, int newholdtime)
3082 {
3083         int oldvalue;
3084
3085         /* Calculate holdtime using an exponential average */
3086         /* Thanks to SRT for this contribution */
3087         /* 2^2 (4) is the filter coefficient; a higher exponent would give old entries more weight */
3088
3089         ao2_lock(qe->parent);
3090         oldvalue = qe->parent->holdtime;
3091         qe->parent->holdtime = (((oldvalue << 2) - oldvalue) + newholdtime) >> 2;
3092         ao2_unlock(qe->parent);
3093 }
3094
3095 /*! \brief Caller leaving queue.
3096  * 
3097  * Search the queue to find the leaving client, if found remove from queue
3098  * create manager event, move others up the queue.
3099 */
3100 static void leave_queue(struct queue_ent *qe)
3101 {
3102         struct call_queue *q;
3103         struct queue_ent *current, *prev = NULL;
3104         struct penalty_rule *pr_iter;
3105         int pos = 0;
3106
3107         if (!(q = qe->parent)) {
3108                 return;
3109         }
3110         queue_t_ref(q, "Copy queue pointer from queue entry");
3111         ao2_lock(q);
3112
3113         prev = NULL;
3114         for (current = q->head; current; current = current->next) {
3115                 if (current == qe) {
3116                         char posstr[20];
3117                         q->count--;
3118
3119                         /* Take us out of the queue */
3120                         /*** DOCUMENTATION
3121                         <managerEventInstance>
3122                                 <synopsis>Raised when a channel leaves a Queue.</synopsis>
3123                                 <syntax>
3124                                         <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
3125                                         <xi:include xpointer="xpointer(/docs/managerEvent[@name='Join']/managerEventInstance/syntax/parameter[@name='Count'])" />
3126                                         <xi:include xpointer="xpointer(/docs/managerEvent[@name='Join']/managerEventInstance/syntax/parameter[@name='Position'])" />
3127                                 </syntax>
3128                                 <see-also>
3129                                         <ref type="managerEvent">Join</ref>
3130                                 </see-also>
3131                         </managerEventInstance>
3132                         ***/
3133                         ast_manager_event(qe->chan, EVENT_FLAG_CALL, "Leave",
3134                                 "Channel: %s\r\nQueue: %s\r\nCount: %d\r\nPosition: %d\r\nUniqueid: %s\r\n",
3135                                 ast_channel_name(qe->chan), q->name,  q->count, qe->pos, ast_channel_uniqueid(qe->chan));
3136                         ast_debug(1, "Queue '%s' Leave, Channel '%s'\n", q->name, ast_channel_name(qe->chan));
3137                         /* Take us out of the queue */
3138                         if (prev) {
3139                                 prev->next = current->next;
3140                         } else {
3141                                 q->head = current->next;
3142                         }
3143                         /* Free penalty rules */
3144                         while ((pr_iter = AST_LIST_REMOVE_HEAD(&qe->qe_rules, list))) {
3145                                 ast_free(pr_iter);
3146                         }
3147                         snprintf(posstr, sizeof(posstr), "%d", qe->pos);
3148                         pbx_builtin_setvar_helper(qe->chan, "QUEUEPOSITION", posstr);
3149                 } else {
3150                         /* Renumber the people after us in the queue based on a new count */
3151                         current->pos = ++pos;
3152                         prev = current;
3153                 }
3154         }
3155         ao2_unlock(q);
3156
3157         /*If the queue is a realtime queue, check to see if it's still defined in real time*/
3158         if (q->realtime) {
3159                 struct ast_variable *var;
3160                 if (!(var = ast_load_realtime("queues", "name", q->name, SENTINEL))) {
3161                         q->dead = 1;
3162                 } else {
3163                         ast_variables_destroy(var);
3164                 }
3165         }
3166
3167         if (q->dead) {
3168                 /* It's dead and nobody is in it, so kill it */
3169                 queues_t_unlink(queues, q, "Queue is now dead; remove it from the container");
3170         }
3171         /* unref the explicit ref earlier in the function */
3172         queue_t_unref(q, "Expire copied reference");
3173 }
3174
3175 /*!
3176  * \internal
3177  * \brief Destroy the given callattempt structure and free it.
3178  * \since 1.8
3179  *
3180  * \param doomed callattempt structure to destroy.
3181  *
3182  * \return Nothing
3183  */
3184 static void callattempt_free(struct callattempt *doomed)
3185 {
3186         if (doomed->member) {
3187                 ao2_ref(doomed->member, -1);
3188         }
3189         ast_party_connected_line_free(&doomed->connected);
3190         ast_free(doomed);
3191 }
3192
3193 /*! \brief Hang up a list of outgoing calls */
3194 static void hangupcalls(struct callattempt *outgoing, struct ast_channel *exception, int cancel_answered_elsewhere)
3195 {
3196         struct callattempt *oo;
3197
3198         while (outgoing) {
3199                 /* If someone else answered the call we should indicate this in the CANCEL */
3200                 /* Hangup any existing lines we have open */
3201                 if (outgoing->chan && (outgoing->chan != exception)) {
3202                         if (exception || cancel_answered_elsewhere) {
3203                                 ast_channel_hangupcause_set(outgoing->chan, AST_CAUSE_ANSWERED_ELSEWHERE);
3204                         }
3205                         ast_hangup(outgoing->chan);
3206                 }
3207                 oo = outgoing;
3208                 outgoing = outgoing->q_next;
3209                 ast_aoc_destroy_decoded(oo->aoc_s_rate_list);
3210                 callattempt_free(oo);
3211         }
3212 }
3213
3214 /*!
3215  * \brief Get the number of members available to accept a call.
3216  *
3217  * \note The queue passed in should be locked prior to this function call
3218  *
3219  * \param[in] q The queue for which we are couting the number of available members
3220  * \return Return the number of available members in queue q
3221  */
3222 static int num_available_members(struct call_queue *q)
3223 {
3224         struct member *mem;
3225         int avl = 0;
3226         struct ao2_iterator mem_iter;
3227
3228         mem_iter = ao2_iterator_init(q->members, 0);
3229         while ((mem = ao2_iterator_next(&mem_iter))) {
3230                 switch (mem->status) {
3231                         case AST_DEVICE_INVALID:
3232                         case AST_DEVICE_UNAVAILABLE:
3233                                 break;
3234                         case AST_DEVICE_INUSE:
3235                         case AST_DEVICE_BUSY:
3236                         case AST_DEVICE_RINGING:
3237                         case AST_DEVICE_RINGINUSE:
3238                         case AST_DEVICE_ONHOLD:
3239                                 if (!mem->ringinuse) {
3240                                         break;
3241                                 }
3242                                 /* else fall through */
3243                         case AST_DEVICE_NOT_INUSE:
3244                         case AST_DEVICE_UNKNOWN:
3245                                 if (!mem->paused) {
3246                                         avl++;
3247                                 }
3248                                 break;
3249                 }
3250                 ao2_ref(mem, -1);
3251
3252                 /* If autofill is not enabled or if the queue's strategy is ringall, then
3253                  * we really don't care about the number of available members so much as we
3254                  * do that there is at least one available.
3255                  *
3256                  * In fact, we purposely will return from this function stating that only
3257                  * one member is available if either of those conditions hold. That way,
3258                  * functions which determine what action to take based on the number of available
3259                  * members will operate properly. The reasoning is that even if multiple
3260                  * members are available, only the head caller can actually be serviced.
3261                  */
3262                 if ((!q->autofill || q->strategy == QUEUE_STRATEGY_RINGALL) && avl) {
3263                         break;
3264                 }
3265         }
3266         ao2_iterator_destroy(&mem_iter);
3267
3268         return avl;
3269 }
3270
3271 /* traverse all defined queues which have calls waiting and contain this member
3272    return 0 if no other queue has precedence (higher weight) or 1 if found  */
3273 static int compare_weight(struct call_queue *rq, struct member *member)
3274 {
3275         struct call_queue *q;
3276         struct member *mem;
3277         int found = 0;
3278         struct ao2_iterator queue_iter;
3279
3280         queue_iter = ao2_iterator_init(queues, 0);
3281         while ((q = ao2_t_iterator_next(&queue_iter, "Iterate through queues"))) {
3282                 if (q == rq) { /* don't check myself, could deadlock */
3283                         queue_t_unref(q, "Done with iterator");
3284                         continue;
3285                 }
3286                 ao2_lock(q);
3287                 if (q->count && q->members) {
3288                         if ((mem = ao2_find(q->members, member, OBJ_POINTER))) {
3289                                 ast_debug(1, "Found matching member %s in queue '%s'\n", mem->interface, q->name);
3290                                 if (q->weight > rq->weight && q->count >= num_available_members(q)) {
3291                                         ast_debug(1, "Queue '%s' (weight %d, calls %d) is preferred over '%s' (weight %d, calls %d)\n", q->name, q->weight, q->count, rq->name, rq->weight, rq->count);
3292                                         found = 1;
3293                                 }