queues container needs locking when using the OBJ_NOLOCK flag
[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="h">
139                                                 <para>Allow <emphasis>callee</emphasis> to hang up by pressing <literal>*</literal>.</para>
140                                         </option>
141                                         <option name="H">
142                                                 <para>Allow <emphasis>caller</emphasis> to hang up by pressing <literal>*</literal>.</para>
143                                         </option>
144                                         <option name="n">
145                                                 <para>No retries on the timeout; will exit this application and
146                                                 go to the next step.</para>
147                                         </option>
148                                         <option name="i">
149                                                 <para>Ignore call forward requests from queue members and do nothing
150                                                 when they are requested.</para>
151                                         </option>
152                                         <option name="I">
153                                                 <para>Asterisk will ignore any connected line update requests or any redirecting party
154                                                 update requests it may receive on this dial attempt.</para>
155                                         </option>
156                                         <option name="r">
157                                                 <para>Ring instead of playing MOH. Periodic Announcements are still made, if applicable.</para>
158                                         </option>
159                                         <option name="R">
160                                                 <para>Ring instead of playing MOH when a member channel is actually ringing.</para>
161                                         </option>
162                                         <option name="t">
163                                                 <para>Allow the <emphasis>called</emphasis> user to transfer the calling user.</para>
164                                         </option>
165                                         <option name="T">
166                                                 <para>Allow the <emphasis>calling</emphasis> user to transfer the call.</para>
167                                         </option>
168                                         <option name="w">
169                                                 <para>Allow the <emphasis>called</emphasis> user to write the conversation to
170                                                 disk via Monitor.</para>
171                                         </option>
172                                         <option name="W">
173                                                 <para>Allow the <emphasis>calling</emphasis> user to write the conversation to
174                                                 disk via Monitor.</para>
175                                         </option>
176                                         <option name="k">
177                                                 <para>Allow the <emphasis>called</emphasis> party to enable parking of the call by sending
178                                                 the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
179                                         </option>
180                                         <option name="K">
181                                                 <para>Allow the <emphasis>calling</emphasis> party to enable parking of the call by sending
182                                                 the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
183                                         </option>
184                                         <option name="x">
185                                                 <para>Allow the <emphasis>called</emphasis> user to write the conversation
186                                                 to disk via MixMonitor.</para>
187                                         </option>
188                                         <option name="X">
189                                                 <para>Allow the <emphasis>calling</emphasis> user to write the conversation to
190                                                 disk via MixMonitor.</para>
191                                         </option>
192                                 </optionlist>
193                         </parameter>
194                         <parameter name="URL">
195                                 <para><replaceable>URL</replaceable> will be sent to the called party if the channel supports it.</para>
196                         </parameter>
197                         <parameter name="announceoverride" />
198                         <parameter name="timeout">
199                                 <para>Will cause the queue to fail out after a specified number of
200                                 seconds, checked between each <filename>queues.conf</filename> <replaceable>timeout</replaceable> and
201                                 <replaceable>retry</replaceable> cycle.</para>
202                         </parameter>
203                         <parameter name="AGI">
204                                 <para>Will setup an AGI script to be executed on the calling party's channel once they are
205                                 connected to a queue member.</para>
206                         </parameter>
207                         <parameter name="macro">
208                                 <para>Will run a macro on the calling party's channel once they are connected to a queue member.</para>
209                         </parameter>
210                         <parameter name="gosub">
211                                 <para>Will run a gosub on the calling party's channel once they are connected to a queue member.</para>
212                         </parameter>
213                         <parameter name="rule">
214                                 <para>Will cause the queue's defaultrule to be overridden by the rule specified.</para>
215                         </parameter>
216                         <parameter name="position">
217                                 <para>Attempt to enter the caller into the queue at the numerical position specified. <literal>1</literal>
218                                 would attempt to enter the caller at the head of the queue, and <literal>3</literal> would attempt to place
219                                 the caller third in the queue.</para>
220                         </parameter>
221                 </syntax>
222                 <description>
223                         <para>In addition to transferring the call, a call may be parked and then picked
224                         up by another user.</para>
225                         <para>This application will return to the dialplan if the queue does not exist, or
226                         any of the join options cause the caller to not enter the queue.</para>
227                         <para>This application does not automatically answer and should be preceeded
228                         by an application such as Answer(), Progress(), or Ringing().</para>
229                         <para>This application sets the following channel variable upon completion:</para>
230                         <variablelist>
231                                 <variable name="QUEUESTATUS">
232                                         <para>The status of the call as a text string.</para>
233                                         <value name="TIMEOUT" />
234                                         <value name="FULL" />
235                                         <value name="JOINEMPTY" />
236                                         <value name="LEAVEEMPTY" />
237                                         <value name="JOINUNAVAIL" />
238                                         <value name="LEAVEUNAVAIL" />
239                                         <value name="CONTINUE" />
240                                 </variable>
241                         </variablelist>
242                 </description>
243                 <see-also>
244                         <ref type="application">Queue</ref>
245                         <ref type="application">QueueLog</ref>
246                         <ref type="application">AddQueueMember</ref>
247                         <ref type="application">RemoveQueueMember</ref>
248                         <ref type="application">PauseQueueMember</ref>
249                         <ref type="application">UnpauseQueueMember</ref>
250                         <ref type="function">QUEUE_VARIABLES</ref>
251                         <ref type="function">QUEUE_MEMBER</ref>
252                         <ref type="function">QUEUE_MEMBER_COUNT</ref>
253                         <ref type="function">QUEUE_EXISTS</ref>
254                         <ref type="function">QUEUE_WAITING_COUNT</ref>
255                         <ref type="function">QUEUE_MEMBER_LIST</ref>
256                         <ref type="function">QUEUE_MEMBER_PENALTY</ref>
257                 </see-also>
258         </application>
259         <application name="AddQueueMember" language="en_US">
260                 <synopsis>
261                         Dynamically adds queue members.
262                 </synopsis>
263                 <syntax>
264                         <parameter name="queuename" required="true" />
265                         <parameter name="interface" />
266                         <parameter name="penalty" />
267                         <parameter name="options" />
268                         <parameter name="membername" />
269                         <parameter name="stateinterface" />
270                 </syntax>
271                 <description>
272                         <para>Dynamically adds interface to an existing queue. If the interface is
273                         already in the queue it will return an error.</para>
274                         <para>This application sets the following channel variable upon completion:</para>
275                         <variablelist>
276                                 <variable name="AQMSTATUS">
277                                         <para>The status of the attempt to add a queue member as a text string.</para>
278                                         <value name="ADDED" />
279                                         <value name="MEMBERALREADY" />
280                                         <value name="NOSUCHQUEUE" />
281                                 </variable>
282                         </variablelist>
283                 </description>
284                 <see-also>
285                         <ref type="application">Queue</ref>
286                         <ref type="application">QueueLog</ref>
287                         <ref type="application">AddQueueMember</ref>
288                         <ref type="application">RemoveQueueMember</ref>
289                         <ref type="application">PauseQueueMember</ref>
290                         <ref type="application">UnpauseQueueMember</ref>
291                         <ref type="function">QUEUE_VARIABLES</ref>
292                         <ref type="function">QUEUE_MEMBER</ref>
293                         <ref type="function">QUEUE_MEMBER_COUNT</ref>
294                         <ref type="function">QUEUE_EXISTS</ref>
295                         <ref type="function">QUEUE_WAITING_COUNT</ref>
296                         <ref type="function">QUEUE_MEMBER_LIST</ref>
297                         <ref type="function">QUEUE_MEMBER_PENALTY</ref>
298                 </see-also>
299         </application>
300         <application name="RemoveQueueMember" language="en_US">
301                 <synopsis>
302                         Dynamically removes queue members.
303                 </synopsis>
304                 <syntax>
305                         <parameter name="queuename" required="true" />
306                         <parameter name="interface" />
307                         <parameter name="options" />
308                 </syntax>
309                 <description>
310                         <para>If the interface is <emphasis>NOT</emphasis> in the queue it will return an error.</para>
311                         <para>This application sets the following channel variable upon completion:</para>
312                         <variablelist>
313                                 <variable name="RQMSTATUS">
314                                         <value name="REMOVED" />
315                                         <value name="NOTINQUEUE" />
316                                         <value name="NOSUCHQUEUE" />
317                                 </variable>
318                         </variablelist>
319                         <para>Example: RemoveQueueMember(techsupport,SIP/3000)</para>
320                 </description>
321                 <see-also>
322                         <ref type="application">Queue</ref>
323                         <ref type="application">QueueLog</ref>
324                         <ref type="application">AddQueueMember</ref>
325                         <ref type="application">RemoveQueueMember</ref>
326                         <ref type="application">PauseQueueMember</ref>
327                         <ref type="application">UnpauseQueueMember</ref>
328                         <ref type="function">QUEUE_VARIABLES</ref>
329                         <ref type="function">QUEUE_MEMBER</ref>
330                         <ref type="function">QUEUE_MEMBER_COUNT</ref>
331                         <ref type="function">QUEUE_EXISTS</ref>
332                         <ref type="function">QUEUE_WAITING_COUNT</ref>
333                         <ref type="function">QUEUE_MEMBER_LIST</ref>
334                         <ref type="function">QUEUE_MEMBER_PENALTY</ref>
335                 </see-also>
336         </application>
337         <application name="PauseQueueMember" language="en_US">
338                 <synopsis>
339                         Pauses a queue member.
340                 </synopsis>
341                 <syntax>
342                         <parameter name="queuename" />
343                         <parameter name="interface" required="true" />
344                         <parameter name="options" />
345                         <parameter name="reason">
346                                 <para>Is used to add extra information to the appropriate queue_log entries and manager events.</para>
347                         </parameter>
348                 </syntax>
349                 <description>
350                         <para>Pauses (blocks calls for) a queue member. The given interface will be paused in the given queue.
351                         This prevents any calls from being sent from the queue to the interface until it is
352                         unpaused with UnpauseQueueMember or the manager interface.  If no queuename is given,
353                         the interface is paused in every queue it is a member of. The application will fail if the
354                         interface is not found.</para>
355                         <para>This application sets the following channel variable upon completion:</para>
356                         <variablelist>
357                                 <variable name="PQMSTATUS">
358                                         <para>The status of the attempt to pause a queue member as a text string.</para>
359                                         <value name="PAUSED" />
360                                         <value name="NOTFOUND" />
361                                 </variable>
362                         </variablelist>
363                         <para>Example: PauseQueueMember(,SIP/3000)</para>
364                 </description>
365                 <see-also>
366                         <ref type="application">Queue</ref>
367                         <ref type="application">QueueLog</ref>
368                         <ref type="application">AddQueueMember</ref>
369                         <ref type="application">RemoveQueueMember</ref>
370                         <ref type="application">PauseQueueMember</ref>
371                         <ref type="application">UnpauseQueueMember</ref>
372                         <ref type="function">QUEUE_VARIABLES</ref>
373                         <ref type="function">QUEUE_MEMBER</ref>
374                         <ref type="function">QUEUE_MEMBER_COUNT</ref>
375                         <ref type="function">QUEUE_EXISTS</ref>
376                         <ref type="function">QUEUE_WAITING_COUNT</ref>
377                         <ref type="function">QUEUE_MEMBER_LIST</ref>
378                         <ref type="function">QUEUE_MEMBER_PENALTY</ref>
379                 </see-also>
380         </application>
381         <application name="UnpauseQueueMember" language="en_US">
382                 <synopsis>
383                         Unpauses a queue member.                
384                 </synopsis>
385                 <syntax>
386                         <parameter name="queuename" />
387                         <parameter name="interface" required="true" />
388                         <parameter name="options" />
389                         <parameter name="reason">
390                                 <para>Is used to add extra information to the appropriate queue_log entries and manager events.</para>
391                         </parameter>
392                 </syntax>
393                 <description>
394                         <para>Unpauses (resumes calls to) a queue member. This is the counterpart to <literal>PauseQueueMember()</literal>
395                         and operates exactly the same way, except it unpauses instead of pausing the given interface.</para>
396                         <para>This application sets the following channel variable upon completion:</para>
397                         <variablelist>
398                                 <variable name="UPQMSTATUS">
399                                         <para>The status of the attempt to unpause a queue member as a text string.</para>
400                                         <value name="UNPAUSED" />
401                                         <value name="NOTFOUND" />
402                                 </variable>
403                         </variablelist>
404                         <para>Example: UnpauseQueueMember(,SIP/3000)</para>
405                 </description>
406                 <see-also>
407                         <ref type="application">Queue</ref>
408                         <ref type="application">QueueLog</ref>
409                         <ref type="application">AddQueueMember</ref>
410                         <ref type="application">RemoveQueueMember</ref>
411                         <ref type="application">PauseQueueMember</ref>
412                         <ref type="application">UnpauseQueueMember</ref>
413                         <ref type="function">QUEUE_VARIABLES</ref>
414                         <ref type="function">QUEUE_MEMBER</ref>
415                         <ref type="function">QUEUE_MEMBER_COUNT</ref>
416                         <ref type="function">QUEUE_EXISTS</ref>
417                         <ref type="function">QUEUE_WAITING_COUNT</ref>
418                         <ref type="function">QUEUE_MEMBER_LIST</ref>
419                         <ref type="function">QUEUE_MEMBER_PENALTY</ref>
420                 </see-also>
421         </application>
422         <application name="QueueLog" language="en_US">
423                 <synopsis>
424                         Writes to the queue_log file.
425                 </synopsis>
426                 <syntax>
427                         <parameter name="queuename" required="true" />
428                         <parameter name="uniqueid" required="true" />
429                         <parameter name="agent" required="true" />
430                         <parameter name="event" required="true" />
431                         <parameter name="additionalinfo" />
432                 </syntax>
433                 <description>
434                         <para>Allows you to write your own events into the queue log.</para>
435                         <para>Example: QueueLog(101,${UNIQUEID},${AGENT},WENTONBREAK,600)</para>
436                 </description>
437                 <see-also>
438                         <ref type="application">Queue</ref>
439                         <ref type="application">QueueLog</ref>
440                         <ref type="application">AddQueueMember</ref>
441                         <ref type="application">RemoveQueueMember</ref>
442                         <ref type="application">PauseQueueMember</ref>
443                         <ref type="application">UnpauseQueueMember</ref>
444                         <ref type="function">QUEUE_VARIABLES</ref>
445                         <ref type="function">QUEUE_MEMBER</ref>
446                         <ref type="function">QUEUE_MEMBER_COUNT</ref>
447                         <ref type="function">QUEUE_EXISTS</ref>
448                         <ref type="function">QUEUE_WAITING_COUNT</ref>
449                         <ref type="function">QUEUE_MEMBER_LIST</ref>
450                         <ref type="function">QUEUE_MEMBER_PENALTY</ref>
451                 </see-also>
452         </application>
453         <function name="QUEUE_VARIABLES" language="en_US">
454                 <synopsis>
455                         Return Queue information in variables.
456                 </synopsis>
457                 <syntax>
458                         <parameter name="queuename" required="true">
459                                 <enumlist>
460                                         <enum name="QUEUEMAX">
461                                                 <para>Maxmimum number of calls allowed.</para>
462                                         </enum>
463                                         <enum name="QUEUESTRATEGY">
464                                                 <para>The strategy of the queue.</para>
465                                         </enum>
466                                         <enum name="QUEUECALLS">
467                                                 <para>Number of calls currently in the queue.</para>
468                                         </enum>
469                                         <enum name="QUEUEHOLDTIME">
470                                                 <para>Current average hold time.</para>
471                                         </enum>
472                                         <enum name="QUEUECOMPLETED">
473                                                 <para>Number of completed calls for the queue.</para>
474                                         </enum>
475                                         <enum name="QUEUEABANDONED">
476                                                 <para>Number of abandoned calls.</para>
477                                         </enum>
478                                         <enum name="QUEUESRVLEVEL">
479                                                 <para>Queue service level.</para>
480                                         </enum>
481                                         <enum name="QUEUESRVLEVELPERF">
482                                                 <para>Current service level performance.</para>
483                                         </enum>
484                                 </enumlist>
485                         </parameter>
486                 </syntax>
487                 <description>
488                         <para>Makes the following queue variables available.</para>
489                         <para>Returns <literal>0</literal> if queue is found and setqueuevar is defined, <literal>-1</literal> otherwise.</para>
490                 </description>
491                 <see-also>
492                         <ref type="application">Queue</ref>
493                         <ref type="application">QueueLog</ref>
494                         <ref type="application">AddQueueMember</ref>
495                         <ref type="application">RemoveQueueMember</ref>
496                         <ref type="application">PauseQueueMember</ref>
497                         <ref type="application">UnpauseQueueMember</ref>
498                         <ref type="function">QUEUE_VARIABLES</ref>
499                         <ref type="function">QUEUE_MEMBER</ref>
500                         <ref type="function">QUEUE_MEMBER_COUNT</ref>
501                         <ref type="function">QUEUE_EXISTS</ref>
502                         <ref type="function">QUEUE_WAITING_COUNT</ref>
503                         <ref type="function">QUEUE_MEMBER_LIST</ref>
504                         <ref type="function">QUEUE_MEMBER_PENALTY</ref>
505                 </see-also>
506         </function>
507         <function name="QUEUE_MEMBER" language="en_US">
508                 <synopsis>
509                         Count number of members answering a queue.
510                 </synopsis>
511                 <syntax>
512                         <parameter name="queuename" required="true" />
513                         <parameter name="option" required="true">
514                                 <enumlist>
515                                         <enum name="logged">
516                                                 <para>Returns the number of logged-in members for the specified queue.</para>
517                                         </enum>
518                                         <enum name="free">
519                                                 <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>
520                                         </enum>
521                                         <enum name="ready">
522                                                 <para>Returns the number of logged-in members for the specified queue that are immediately available to answer a call.</para>
523                                         </enum>
524                                         <enum name="count">
525                                                 <para>Returns the total number of members for the specified queue.</para>
526                                         </enum>
527                                         <enum name="penalty">
528                                                 <para>Gets or sets queue member penalty.</para>
529                                         </enum>
530                                         <enum name="paused">
531                                                 <para>Gets or sets queue member paused status.</para>
532                                         </enum>
533                                         <enum name="ignorebusy">
534                                                 <para>Gets or sets queue member ignorebusy.</para>
535                                         </enum>
536                                 </enumlist>
537                         </parameter>
538                         <parameter name="interface" required="false" />
539                 </syntax>
540                 <description>
541                         <para>Allows access to queue counts [R] and member information [R/W].</para>
542                         <para>
543                                 <replaceable>queuename</replaceable> is required for all operations
544                                 <replaceable>interface</replaceable> is required for all member operations.
545                         </para>
546                 </description>
547                 <see-also>
548                         <ref type="application">Queue</ref>
549                         <ref type="application">QueueLog</ref>
550                         <ref type="application">AddQueueMember</ref>
551                         <ref type="application">RemoveQueueMember</ref>
552                         <ref type="application">PauseQueueMember</ref>
553                         <ref type="application">UnpauseQueueMember</ref>
554                         <ref type="function">QUEUE_VARIABLES</ref>
555                         <ref type="function">QUEUE_MEMBER</ref>
556                         <ref type="function">QUEUE_MEMBER_COUNT</ref>
557                         <ref type="function">QUEUE_EXISTS</ref>
558                         <ref type="function">QUEUE_WAITING_COUNT</ref>
559                         <ref type="function">QUEUE_MEMBER_LIST</ref>
560                         <ref type="function">QUEUE_MEMBER_PENALTY</ref>
561                 </see-also>
562         </function>
563         <function name="QUEUE_MEMBER_COUNT" language="en_US">
564                 <synopsis>
565                         Count number of members answering a queue.
566                 </synopsis>
567                 <syntax>
568                         <parameter name="queuename" required="true" />
569                 </syntax>
570                 <description>
571                         <para>Returns the number of members currently associated with the specified <replaceable>queuename</replaceable>.</para>
572                         <warning><para>This function has been deprecated in favor of the <literal>QUEUE_MEMBER()</literal> function</para></warning>
573                 </description>
574                 <see-also>
575                         <ref type="application">Queue</ref>
576                         <ref type="application">QueueLog</ref>
577                         <ref type="application">AddQueueMember</ref>
578                         <ref type="application">RemoveQueueMember</ref>
579                         <ref type="application">PauseQueueMember</ref>
580                         <ref type="application">UnpauseQueueMember</ref>
581                         <ref type="function">QUEUE_VARIABLES</ref>
582                         <ref type="function">QUEUE_MEMBER</ref>
583                         <ref type="function">QUEUE_MEMBER_COUNT</ref>
584                         <ref type="function">QUEUE_EXISTS</ref>
585                         <ref type="function">QUEUE_WAITING_COUNT</ref>
586                         <ref type="function">QUEUE_MEMBER_LIST</ref>
587                         <ref type="function">QUEUE_MEMBER_PENALTY</ref>
588                 </see-also>
589         </function>
590         <function name="QUEUE_EXISTS" language="en_US">
591                 <synopsis>
592                         Check if a named queue exists on this server
593                 </synopsis>
594                 <syntax>
595                         <parameter name="queuename" />
596                 </syntax>
597                 <description>
598                         <para>Returns 1 if the specified queue exists, 0 if it does not</para>
599                 </description>
600                 <see-also>
601                         <ref type="application">Queue</ref>
602                         <ref type="application">QueueLog</ref>
603                         <ref type="application">AddQueueMember</ref>
604                         <ref type="application">RemoveQueueMember</ref>
605                         <ref type="application">PauseQueueMember</ref>
606                         <ref type="application">UnpauseQueueMember</ref>
607                         <ref type="function">QUEUE_VARIABLES</ref>
608                         <ref type="function">QUEUE_MEMBER</ref>
609                         <ref type="function">QUEUE_MEMBER_COUNT</ref>
610                         <ref type="function">QUEUE_EXISTS</ref>
611                         <ref type="function">QUEUE_WAITING_COUNT</ref>
612                         <ref type="function">QUEUE_MEMBER_LIST</ref>
613                         <ref type="function">QUEUE_MEMBER_PENALTY</ref>
614                 </see-also>
615         </function>
616         <function name="QUEUE_WAITING_COUNT" language="en_US">
617                 <synopsis>
618                         Count number of calls currently waiting in a queue.
619                 </synopsis>
620                 <syntax>
621                         <parameter name="queuename" />
622                 </syntax>
623                 <description>
624                         <para>Returns the number of callers currently waiting in the specified <replaceable>queuename</replaceable>.</para>
625                 </description>
626                 <see-also>
627                         <ref type="application">Queue</ref>
628                         <ref type="application">QueueLog</ref>
629                         <ref type="application">AddQueueMember</ref>
630                         <ref type="application">RemoveQueueMember</ref>
631                         <ref type="application">PauseQueueMember</ref>
632                         <ref type="application">UnpauseQueueMember</ref>
633                         <ref type="function">QUEUE_VARIABLES</ref>
634                         <ref type="function">QUEUE_MEMBER</ref>
635                         <ref type="function">QUEUE_MEMBER_COUNT</ref>
636                         <ref type="function">QUEUE_EXISTS</ref>
637                         <ref type="function">QUEUE_WAITING_COUNT</ref>
638                         <ref type="function">QUEUE_MEMBER_LIST</ref>
639                         <ref type="function">QUEUE_MEMBER_PENALTY</ref>
640                 </see-also>
641         </function>
642         <function name="QUEUE_MEMBER_LIST" language="en_US">
643                 <synopsis>
644                         Returns a list of interfaces on a queue.
645                 </synopsis>
646                 <syntax>
647                         <parameter name="queuename" required="true" />
648                 </syntax>
649                 <description>
650                         <para>Returns a comma-separated list of members associated with the specified <replaceable>queuename</replaceable>.</para>
651                 </description>
652                 <see-also>
653                         <ref type="application">Queue</ref>
654                         <ref type="application">QueueLog</ref>
655                         <ref type="application">AddQueueMember</ref>
656                         <ref type="application">RemoveQueueMember</ref>
657                         <ref type="application">PauseQueueMember</ref>
658                         <ref type="application">UnpauseQueueMember</ref>
659                         <ref type="function">QUEUE_VARIABLES</ref>
660                         <ref type="function">QUEUE_MEMBER</ref>
661                         <ref type="function">QUEUE_MEMBER_COUNT</ref>
662                         <ref type="function">QUEUE_EXISTS</ref>
663                         <ref type="function">QUEUE_WAITING_COUNT</ref>
664                         <ref type="function">QUEUE_MEMBER_LIST</ref>
665                         <ref type="function">QUEUE_MEMBER_PENALTY</ref>
666                 </see-also>
667         </function>
668         <function name="QUEUE_MEMBER_PENALTY" language="en_US">
669                 <synopsis>
670                         Gets or sets queue members penalty.
671                 </synopsis>
672                 <syntax>
673                         <parameter name="queuename" required="true" />
674                         <parameter name="interface" required="true" />
675                 </syntax>
676                 <description>
677                         <para>Gets or sets queue members penalty.</para>
678                         <warning><para>This function has been deprecated in favor of the <literal>QUEUE_MEMBER()</literal> function</para></warning>
679                 </description>
680                 <see-also>
681                         <ref type="application">Queue</ref>
682                         <ref type="application">QueueLog</ref>
683                         <ref type="application">AddQueueMember</ref>
684                         <ref type="application">RemoveQueueMember</ref>
685                         <ref type="application">PauseQueueMember</ref>
686                         <ref type="application">UnpauseQueueMember</ref>
687                         <ref type="function">QUEUE_VARIABLES</ref>
688                         <ref type="function">QUEUE_MEMBER</ref>
689                         <ref type="function">QUEUE_MEMBER_COUNT</ref>
690                         <ref type="function">QUEUE_EXISTS</ref>
691                         <ref type="function">QUEUE_WAITING_COUNT</ref>
692                         <ref type="function">QUEUE_MEMBER_LIST</ref>
693                         <ref type="function">QUEUE_MEMBER_PENALTY</ref>
694                 </see-also>
695         </function>
696         <manager name="Queues" language="en_US">
697                 <synopsis>
698                         Queues.
699                 </synopsis>
700                 <syntax>
701                 </syntax>
702                 <description>
703                 </description>
704         </manager>
705         <manager name="QueueStatus" language="en_US">
706                 <synopsis>
707                         Show queue status.
708                 </synopsis>
709                 <syntax>
710                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
711                         <parameter name="Queue" />
712                         <parameter name="Member" />
713                 </syntax>
714                 <description>
715                 </description>
716         </manager>
717         <manager name="QueueSummary" language="en_US">
718                 <synopsis>
719                         Show queue summary.
720                 </synopsis>
721                 <syntax>
722                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
723                         <parameter name="Queue" />
724                 </syntax>
725                 <description>
726                 </description>
727         </manager>
728         <manager name="QueueAdd" language="en_US">
729                 <synopsis>
730                         Add interface to queue.
731                 </synopsis>
732                 <syntax>
733                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
734                         <parameter name="Queue" required="true" />
735                         <parameter name="Interface" required="true" />
736                         <parameter name="Penalty" />
737                         <parameter name="Paused" />
738                         <parameter name="MemberName" />
739                         <parameter name="StateInterface" />
740                 </syntax>
741                 <description>
742                 </description>
743         </manager>
744         <manager name="QueueRemove" language="en_US">
745                 <synopsis>
746                         Remove interface from queue.
747                 </synopsis>
748                 <syntax>
749                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
750                         <parameter name="Queue" required="true" />
751                         <parameter name="Interface" required="true" />
752                 </syntax>
753                 <description>
754                 </description>
755         </manager>
756         <manager name="QueuePause" language="en_US">
757                 <synopsis>
758                         Makes a queue member temporarily unavailable.
759                 </synopsis>
760                 <syntax>
761                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
762                         <parameter name="Interface" required="true" />
763                         <parameter name="Paused" required="true" />
764                         <parameter name="Queue" />
765                         <parameter name="Reason" />
766                 </syntax>
767                 <description>
768                 </description>
769         </manager>
770         <manager name="QueueLog" language="en_US">
771                 <synopsis>
772                         Adds custom entry in queue_log.
773                 </synopsis>
774                 <syntax>
775                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
776                         <parameter name="Queue" required="true" />
777                         <parameter name="Event" required="true" />
778                         <parameter name="Uniqueid" />
779                         <parameter name="Interface" />
780                         <parameter name="Message" />
781                 </syntax>
782                 <description>
783                 </description>
784         </manager>
785         <manager name="QueuePenalty" language="en_US">
786                 <synopsis>
787                         Set the penalty for a queue member.
788                 </synopsis>
789                 <syntax>
790                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
791                         <parameter name="Interface" required="true" />
792                         <parameter name="Penalty" required="true" />
793                         <parameter name="Queue" />
794                 </syntax>
795                 <description>
796                 </description>
797         </manager>
798         <manager name="QueueRule" language="en_US">
799                 <synopsis>
800                         Queue Rules.
801                 </synopsis>
802                 <syntax>
803                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
804                         <parameter name="Rule" />
805                 </syntax>
806                 <description>
807                 </description>
808         </manager>
809         <manager name="QueueReload" language="en_US">
810                 <synopsis>
811                         Reload a queue, queues, or any sub-section of a queue or queues.
812                 </synopsis>
813                 <syntax>
814                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
815                         <parameter name="Queue" />
816                         <parameter name="Members">
817                                 <enumlist>
818                                         <enum name="yes" />
819                                         <enum name="no" />
820                                 </enumlist>
821                         </parameter>
822                         <parameter name="Rules">
823                                 <enumlist>
824                                         <enum name="yes" />
825                                         <enum name="no" />
826                                 </enumlist>
827                         </parameter>
828                         <parameter name="Parameters">
829                                 <enumlist>
830                                         <enum name="yes" />
831                                         <enum name="no" />
832                                 </enumlist>
833                         </parameter>
834                 </syntax>
835                 <description>
836                 </description>
837         </manager>
838         <manager name="QueueReset" language="en_US">
839                 <synopsis>
840                         Reset queue statistics.
841                 </synopsis>
842                 <syntax>
843                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
844                         <parameter name="Queue" />
845                 </syntax>
846                 <description>
847                 </description>
848         </manager>
849  ***/
850
851 enum {
852         QUEUE_STRATEGY_RINGALL = 0,
853         QUEUE_STRATEGY_LEASTRECENT,
854         QUEUE_STRATEGY_FEWESTCALLS,
855         QUEUE_STRATEGY_RANDOM,
856         QUEUE_STRATEGY_RRMEMORY,
857         QUEUE_STRATEGY_LINEAR,
858         QUEUE_STRATEGY_WRANDOM,
859         QUEUE_STRATEGY_RRORDERED,
860 };
861
862 enum {
863      QUEUE_AUTOPAUSE_OFF = 0,
864      QUEUE_AUTOPAUSE_ON,
865      QUEUE_AUTOPAUSE_ALL
866 };
867
868 enum queue_reload_mask {
869         QUEUE_RELOAD_PARAMETERS = (1 << 0),
870         QUEUE_RELOAD_MEMBER = (1 << 1),
871         QUEUE_RELOAD_RULES = (1 << 2),
872         QUEUE_RESET_STATS = (1 << 3),
873 };
874
875 static const struct strategy {
876         int strategy;
877         const char *name;
878 } strategies[] = {
879         { QUEUE_STRATEGY_RINGALL, "ringall" },
880         { QUEUE_STRATEGY_LEASTRECENT, "leastrecent" },
881         { QUEUE_STRATEGY_FEWESTCALLS, "fewestcalls" },
882         { QUEUE_STRATEGY_RANDOM, "random" },
883         { QUEUE_STRATEGY_RRMEMORY, "rrmemory" },
884         { QUEUE_STRATEGY_RRMEMORY, "roundrobin" },
885         { QUEUE_STRATEGY_LINEAR, "linear" },
886         { QUEUE_STRATEGY_WRANDOM, "wrandom"},
887         { QUEUE_STRATEGY_RRORDERED, "rrordered"},
888 };
889
890 static const struct autopause {
891         int autopause;
892         const char *name;
893 } autopausesmodes [] = {
894         { QUEUE_AUTOPAUSE_OFF,"no" },
895         { QUEUE_AUTOPAUSE_ON, "yes" },
896         { QUEUE_AUTOPAUSE_ALL,"all" },
897 };
898
899
900 static struct ast_taskprocessor *devicestate_tps;
901
902 #define DEFAULT_RETRY           5
903 #define DEFAULT_TIMEOUT         15
904 #define RECHECK                 1               /*!< Recheck every second to see we we're at the top yet */
905 #define MAX_PERIODIC_ANNOUNCEMENTS 10           /*!< The maximum periodic announcements we can have */
906 #define DEFAULT_MIN_ANNOUNCE_FREQUENCY 15       /*!< The minimum number of seconds between position announcements \
907                                                      The default value of 15 provides backwards compatibility */
908 #define MAX_QUEUE_BUCKETS 53
909
910 #define RES_OKAY        0               /*!< Action completed */
911 #define RES_EXISTS      (-1)            /*!< Entry already exists */
912 #define RES_OUTOFMEMORY (-2)            /*!< Out of memory */
913 #define RES_NOSUCHQUEUE (-3)            /*!< No such queue */
914 #define RES_NOT_DYNAMIC (-4)            /*!< Member is not dynamic */
915
916 static char *app = "Queue";
917
918 static char *app_aqm = "AddQueueMember" ;
919
920 static char *app_rqm = "RemoveQueueMember" ;
921
922 static char *app_pqm = "PauseQueueMember" ;
923
924 static char *app_upqm = "UnpauseQueueMember" ;
925
926 static char *app_ql = "QueueLog" ;
927
928 /*! \brief Persistent Members astdb family */
929 static const char * const pm_family = "Queue/PersistentMembers";
930 /* The maximum length of each persistent member queue database entry */
931 #define PM_MAX_LEN 8192
932
933 /*! \brief queues.conf [general] option */
934 static int queue_persistent_members = 0;
935
936 /*! \brief queues.conf per-queue weight option */
937 static int use_weight = 0;
938
939 /*! \brief queues.conf [general] option */
940 static int autofill_default = 1;
941
942 /*! \brief queues.conf [general] option */
943 static int montype_default = 0;
944
945 /*! \brief queues.conf [general] option */
946 static int shared_lastcall = 1;
947
948 /*! \brief Subscription to device state change events */
949 static struct ast_event_sub *device_state_sub;
950
951 /*! \brief queues.conf [general] option */
952 static int update_cdr = 0;
953
954 /*! \brief queues.conf [general] option */
955 static int negative_penalty_invalid = 0;
956
957 /*! \brief queues.conf [general] option */
958 static int log_membername_as_agent = 0;
959
960 /*! \brief queues.conf [general] option */
961 static int check_state_unknown = 0;
962
963 enum queue_result {
964         QUEUE_UNKNOWN = 0,
965         QUEUE_TIMEOUT = 1,
966         QUEUE_JOINEMPTY = 2,
967         QUEUE_LEAVEEMPTY = 3,
968         QUEUE_JOINUNAVAIL = 4,
969         QUEUE_LEAVEUNAVAIL = 5,
970         QUEUE_FULL = 6,
971         QUEUE_CONTINUE = 7,
972 };
973
974 static const struct {
975         enum queue_result id;
976         char *text;
977 } queue_results[] = {
978         { QUEUE_UNKNOWN, "UNKNOWN" },
979         { QUEUE_TIMEOUT, "TIMEOUT" },
980         { QUEUE_JOINEMPTY,"JOINEMPTY" },
981         { QUEUE_LEAVEEMPTY, "LEAVEEMPTY" },
982         { QUEUE_JOINUNAVAIL, "JOINUNAVAIL" },
983         { QUEUE_LEAVEUNAVAIL, "LEAVEUNAVAIL" },
984         { QUEUE_FULL, "FULL" },
985         { QUEUE_CONTINUE, "CONTINUE" },
986 };
987
988 enum queue_timeout_priority {
989         TIMEOUT_PRIORITY_APP,
990         TIMEOUT_PRIORITY_CONF,
991 };
992
993 /*! \brief We define a custom "local user" structure because we
994  *  use it not only for keeping track of what is in use but
995  *  also for keeping track of who we're dialing.
996  *
997  *  There are two "links" defined in this structure, q_next and call_next.
998  *  q_next links ALL defined callattempt structures into a linked list. call_next is
999  *  a link which allows for a subset of the callattempts to be traversed. This subset
1000  *  is used in wait_for_answer so that irrelevant callattempts are not traversed. This
1001  *  also is helpful so that queue logs are always accurate in the case where a call to 
1002  *  a member times out, especially if using the ringall strategy. 
1003 */
1004
1005 struct callattempt {
1006         struct callattempt *q_next;
1007         struct callattempt *call_next;
1008         struct ast_channel *chan;
1009         char interface[256];
1010         int stillgoing;
1011         int metric;
1012         time_t lastcall;
1013         struct call_queue *lastqueue;
1014         struct member *member;
1015         /*! Saved connected party info from an AST_CONTROL_CONNECTED_LINE. */
1016         struct ast_party_connected_line connected;
1017         /*! TRUE if an AST_CONTROL_CONNECTED_LINE update was saved to the connected element. */
1018         unsigned int pending_connected_update:1;
1019         /*! TRUE if caller id is not available for connected line */
1020         unsigned int dial_callerid_absent:1;
1021         struct ast_aoc_decoded *aoc_s_rate_list;
1022 };
1023
1024
1025 struct queue_ent {
1026         struct call_queue *parent;             /*!< What queue is our parent */
1027         char moh[80];                          /*!< Name of musiconhold to be used */
1028         char announce[PATH_MAX];               /*!< Announcement to play for member when call is answered */
1029         char context[AST_MAX_CONTEXT];         /*!< Context when user exits queue */
1030         char digits[AST_MAX_EXTENSION];        /*!< Digits entered while in queue */
1031         int valid_digits;                      /*!< Digits entered correspond to valid extension. Exited */
1032         int pos;                               /*!< Where we are in the queue */
1033         int prio;                              /*!< Our priority */
1034         int last_pos_said;                     /*!< Last position we told the user */
1035         int ring_when_ringing;                 /*!< Should we only use ring indication when a channel is ringing? */
1036         time_t last_periodic_announce_time;    /*!< The last time we played a periodic announcement */
1037         int last_periodic_announce_sound;      /*!< The last periodic announcement we made */
1038         time_t last_pos;                       /*!< Last time we told the user their position */
1039         int opos;                              /*!< Where we started in the queue */
1040         int handled;                           /*!< Whether our call was handled */
1041         int pending;                           /*!< Non-zero if we are attempting to call a member */
1042         int max_penalty;                       /*!< Limit the members that can take this call to this penalty or lower */
1043         int min_penalty;                       /*!< Limit the members that can take this call to this penalty or higher */
1044         int linpos;                            /*!< If using linear strategy, what position are we at? */
1045         int linwrapped;                        /*!< Is the linpos wrapped? */
1046         time_t start;                          /*!< When we started holding */
1047         time_t expire;                         /*!< When this entry should expire (time out of queue) */
1048         int cancel_answered_elsewhere;         /*!< Whether we should force the CAE flag on this call (C) option*/
1049         struct ast_channel *chan;              /*!< Our channel */
1050         AST_LIST_HEAD_NOLOCK(,penalty_rule) qe_rules; /*!< Local copy of the queue's penalty rules */
1051         struct penalty_rule *pr;               /*!< Pointer to the next penalty rule to implement */
1052         struct queue_ent *next;                /*!< The next queue entry */
1053 };
1054
1055 struct member {
1056         char interface[80];                  /*!< Technology/Location to dial to reach this member*/
1057         char state_exten[AST_MAX_EXTENSION]; /*!< Extension to get state from (if using hint) */
1058         char state_context[AST_MAX_CONTEXT]; /*!< Context to use when getting state (if using hint) */
1059         char state_interface[80];            /*!< Technology/Location from which to read devicestate changes */
1060         char membername[80];                 /*!< Member name to use in queue logs */
1061         int penalty;                         /*!< Are we a last resort? */
1062         int calls;                           /*!< Number of calls serviced by this member */
1063         int dynamic;                         /*!< Are we dynamically added? */
1064         int realtime;                        /*!< Is this member realtime? */
1065         int status;                          /*!< Status of queue member */
1066         int paused;                          /*!< Are we paused (not accepting calls)? */
1067         time_t lastcall;                     /*!< When last successful call was hungup */
1068         struct call_queue *lastqueue;        /*!< Last queue we received a call */
1069         unsigned int dead:1;                 /*!< Used to detect members deleted in realtime */
1070         unsigned int delme:1;                /*!< Flag to delete entry on reload */
1071         char rt_uniqueid[80];                /*!< Unique id of realtime member entry */
1072         unsigned int ignorebusy:1;           /*!< Flag to ignore member if the status is not available */
1073 };
1074
1075 enum empty_conditions {
1076         QUEUE_EMPTY_PENALTY = (1 << 0),
1077         QUEUE_EMPTY_PAUSED = (1 << 1),
1078         QUEUE_EMPTY_INUSE = (1 << 2),
1079         QUEUE_EMPTY_RINGING = (1 << 3),
1080         QUEUE_EMPTY_UNAVAILABLE = (1 << 4),
1081         QUEUE_EMPTY_INVALID = (1 << 5),
1082         QUEUE_EMPTY_UNKNOWN = (1 << 6),
1083         QUEUE_EMPTY_WRAPUP = (1 << 7),
1084 };
1085
1086 /* values used in multi-bit flags in call_queue */
1087 #define ANNOUNCEHOLDTIME_ALWAYS 1
1088 #define ANNOUNCEHOLDTIME_ONCE 2
1089 #define QUEUE_EVENT_VARIABLES 3
1090
1091 struct penalty_rule {
1092         int time;                           /*!< Number of seconds that need to pass before applying this rule */
1093         int max_value;                      /*!< The amount specified in the penalty rule for max penalty */
1094         int min_value;                      /*!< The amount specified in the penalty rule for min penalty */
1095         int max_relative;                   /*!< Is the max adjustment relative? 1 for relative, 0 for absolute */
1096         int min_relative;                   /*!< Is the min adjustment relative? 1 for relative, 0 for absolute */
1097         AST_LIST_ENTRY(penalty_rule) list;  /*!< Next penalty_rule */
1098 };
1099
1100 #define ANNOUNCEPOSITION_YES 1 /*!< We announce position */
1101 #define ANNOUNCEPOSITION_NO 2 /*!< We don't announce position */
1102 #define ANNOUNCEPOSITION_MORE_THAN 3 /*!< We say "Currently there are more than <limit>" */
1103 #define ANNOUNCEPOSITION_LIMIT 4 /*!< We not announce position more than <limit> */
1104
1105 struct call_queue {
1106         AST_DECLARE_STRING_FIELDS(
1107                 /*! Queue name */
1108                 AST_STRING_FIELD(name);
1109                 /*! Music on Hold class */
1110                 AST_STRING_FIELD(moh);
1111                 /*! Announcement to play when call is answered */
1112                 AST_STRING_FIELD(announce);
1113                 /*! Exit context */
1114                 AST_STRING_FIELD(context);
1115                 /*! Macro to run upon member connection */
1116                 AST_STRING_FIELD(membermacro);
1117                 /*! Gosub to run upon member connection */
1118                 AST_STRING_FIELD(membergosub);
1119                 /*! Default rule to use if none specified in call to Queue() */
1120                 AST_STRING_FIELD(defaultrule);
1121                 /*! Sound file: "Your call is now first in line" (def. queue-youarenext) */
1122                 AST_STRING_FIELD(sound_next);
1123                 /*! Sound file: "There are currently" (def. queue-thereare) */
1124                 AST_STRING_FIELD(sound_thereare);
1125                 /*! Sound file: "calls waiting to speak to a representative." (def. queue-callswaiting) */
1126                 AST_STRING_FIELD(sound_calls);
1127                 /*! Sound file: "Currently there are more than" (def. queue-quantity1) */
1128                 AST_STRING_FIELD(queue_quantity1);
1129                 /*! Sound file: "callers waiting to speak with a representative" (def. queue-quantity2) */
1130                 AST_STRING_FIELD(queue_quantity2);
1131                 /*! Sound file: "The current estimated total holdtime is" (def. queue-holdtime) */
1132                 AST_STRING_FIELD(sound_holdtime);
1133                 /*! Sound file: "minutes." (def. queue-minutes) */
1134                 AST_STRING_FIELD(sound_minutes);
1135                 /*! Sound file: "minute." (def. queue-minute) */
1136                 AST_STRING_FIELD(sound_minute);
1137                 /*! Sound file: "seconds." (def. queue-seconds) */
1138                 AST_STRING_FIELD(sound_seconds);
1139                 /*! Sound file: "Thank you for your patience." (def. queue-thankyou) */
1140                 AST_STRING_FIELD(sound_thanks);
1141                 /*! Sound file: Custom announce for caller, no default */
1142                 AST_STRING_FIELD(sound_callerannounce);
1143                 /*! Sound file: "Hold time" (def. queue-reporthold) */
1144                 AST_STRING_FIELD(sound_reporthold);
1145         );
1146         /*! Sound files: Custom announce, no default */
1147         struct ast_str *sound_periodicannounce[MAX_PERIODIC_ANNOUNCEMENTS];
1148         unsigned int dead:1;
1149         unsigned int eventwhencalled:2;
1150         unsigned int ringinuse:1;
1151         unsigned int setinterfacevar:1;
1152         unsigned int setqueuevar:1;
1153         unsigned int setqueueentryvar:1;
1154         unsigned int reportholdtime:1;
1155         unsigned int wrapped:1;
1156         unsigned int timeoutrestart:1;
1157         unsigned int announceholdtime:2;
1158         unsigned int announceposition:3;
1159         int strategy:4;
1160         unsigned int maskmemberstatus:1;
1161         unsigned int realtime:1;
1162         unsigned int found:1;
1163         unsigned int relativeperiodicannounce:1;
1164         unsigned int autopausebusy:1;
1165         unsigned int autopauseunavail:1;
1166         enum empty_conditions joinempty;
1167         enum empty_conditions leavewhenempty;
1168         int announcepositionlimit;          /*!< How many positions we announce? */
1169         int announcefrequency;              /*!< How often to announce their position */
1170         int minannouncefrequency;           /*!< The minimum number of seconds between position announcements (def. 15) */
1171         int periodicannouncefrequency;      /*!< How often to play periodic announcement */
1172         int numperiodicannounce;            /*!< The number of periodic announcements configured */
1173         int randomperiodicannounce;         /*!< Are periodic announcments randomly chosen */
1174         int roundingseconds;                /*!< How many seconds do we round to? */
1175         int holdtime;                       /*!< Current avg holdtime, based on an exponential average */
1176         int talktime;                       /*!< Current avg talktime, based on the same exponential average */
1177         int callscompleted;                 /*!< Number of queue calls completed */
1178         int callsabandoned;                 /*!< Number of queue calls abandoned */
1179         int servicelevel;                   /*!< seconds setting for servicelevel*/
1180         int callscompletedinsl;             /*!< Number of calls answered with servicelevel*/
1181         char monfmt[8];                     /*!< Format to use when recording calls */
1182         int montype;                        /*!< Monitor type  Monitor vs. MixMonitor */
1183         int count;                          /*!< How many entries */
1184         int maxlen;                         /*!< Max number of entries */
1185         int wrapuptime;                     /*!< Wrapup Time */
1186         int penaltymemberslimit;            /*!< Disregard penalty when queue has fewer than this many members */
1187
1188         int retry;                          /*!< Retry calling everyone after this amount of time */
1189         int timeout;                        /*!< How long to wait for an answer */
1190         int weight;                         /*!< Respective weight */
1191         int autopause;                      /*!< Auto pause queue members if they fail to answer */
1192         int autopausedelay;                 /*!< Delay auto pause for autopausedelay seconds since last call */
1193         int timeoutpriority;                /*!< Do we allow a fraction of the timeout to occur for a ring? */
1194
1195         /* Queue strategy things */
1196         int rrpos;                          /*!< Round Robin - position */
1197         int memberdelay;                    /*!< Seconds to delay connecting member to caller */
1198         int autofill;                       /*!< Ignore the head call status and ring an available agent */
1199         
1200         struct ao2_container *members;             /*!< Head of the list of members */
1201         /*! 
1202          * \brief Number of members _logged in_
1203          * \note There will be members in the members container that are not logged
1204          *       in, so this can not simply be replaced with ao2_container_count(). 
1205          */
1206         int membercount;
1207         struct queue_ent *head;             /*!< Head of the list of callers */
1208         AST_LIST_ENTRY(call_queue) list;    /*!< Next call queue */
1209         AST_LIST_HEAD_NOLOCK(, penalty_rule) rules; /*!< The list of penalty rules to invoke */
1210 };
1211
1212 struct rule_list {
1213         char name[80];
1214         AST_LIST_HEAD_NOLOCK(,penalty_rule) rules;
1215         AST_LIST_ENTRY(rule_list) list;
1216 };
1217
1218 static AST_LIST_HEAD_STATIC(rule_lists, rule_list);
1219
1220 static struct ao2_container *queues;
1221
1222 static void update_realtime_members(struct call_queue *q);
1223 static struct member *interface_exists(struct call_queue *q, const char *interface);
1224 static int set_member_paused(const char *queuename, const char *interface, const char *reason, int paused);
1225
1226 static void queue_transfer_fixup(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan);
1227
1228 static struct member *find_member_by_queuename_and_interface(const char *queuename, const char *interface);
1229 /*! \brief sets the QUEUESTATUS channel variable */
1230 static void set_queue_result(struct ast_channel *chan, enum queue_result res)
1231 {
1232         int i;
1233
1234         for (i = 0; i < ARRAY_LEN(queue_results); i++) {
1235                 if (queue_results[i].id == res) {
1236                         pbx_builtin_setvar_helper(chan, "QUEUESTATUS", queue_results[i].text);
1237                         return;
1238                 }
1239         }
1240 }
1241
1242 static const char *int2strat(int strategy)
1243 {
1244         int x;
1245
1246         for (x = 0; x < ARRAY_LEN(strategies); x++) {
1247                 if (strategy == strategies[x].strategy)
1248                         return strategies[x].name;
1249         }
1250
1251         return "<unknown>";
1252 }
1253
1254 static int strat2int(const char *strategy)
1255 {
1256         int x;
1257
1258         for (x = 0; x < ARRAY_LEN(strategies); x++) {
1259                 if (!strcasecmp(strategy, strategies[x].name))
1260                         return strategies[x].strategy;
1261         }
1262
1263         return -1;
1264 }
1265
1266 static int autopause2int(const char *autopause)
1267 {
1268         int x;
1269         /*This 'double check' that default value is OFF */
1270         if (ast_strlen_zero(autopause))
1271                 return QUEUE_AUTOPAUSE_OFF;
1272
1273         /*This 'double check' is to ensure old values works */
1274         if(ast_true(autopause))
1275                 return QUEUE_AUTOPAUSE_ON;
1276
1277         for (x = 0; x < ARRAY_LEN(autopausesmodes); x++) {
1278                 if (!strcasecmp(autopause, autopausesmodes[x].name))
1279                         return autopausesmodes[x].autopause;
1280         }
1281
1282         /*This 'double check' that default value is OFF */
1283         return QUEUE_AUTOPAUSE_OFF;
1284 }
1285
1286 static int queue_hash_cb(const void *obj, const int flags)
1287 {
1288         const struct call_queue *q = obj;
1289
1290         return ast_str_case_hash(q->name);
1291 }
1292
1293 static int queue_cmp_cb(void *obj, void *arg, int flags)
1294 {
1295         struct call_queue *q = obj, *q2 = arg;
1296         return !strcasecmp(q->name, q2->name) ? CMP_MATCH | CMP_STOP : 0;
1297 }
1298
1299 #ifdef REF_DEBUG_ONLY_QUEUES
1300 #define queue_ref(a)    __ao2_ref_debug(a,1,"",__FILE__,__LINE__,__PRETTY_FUNCTION__)
1301 #define queue_unref(a)  __ao2_ref_debug(a,-1,"",__FILE__,__LINE__,__PRETTY_FUNCTION__)
1302 #define queue_t_ref(a,b)        __ao2_ref_debug(a,1,b,__FILE__,__LINE__,__PRETTY_FUNCTION__)
1303 #define queue_t_unref(a,b)      __ao2_ref_debug(a,-1,b,__FILE__,__LINE__,__PRETTY_FUNCTION__)
1304 #define queues_t_link(c,q,tag)  __ao2_link_debug(c,q,tag,__FILE__,__LINE__,__PRETTY_FUNCTION__)
1305 #define queues_t_unlink(c,q,tag)        __ao2_unlink_debug(c,q,tag,__FILE__,__LINE__,__PRETTY_FUNCTION__)
1306 #else
1307 #define queue_t_ref(a,b)        queue_ref(a)
1308 #define queue_t_unref(a,b)      queue_unref(a)
1309 #define queues_t_link(c,q,tag)  ao2_t_link(c,q,tag)
1310 #define queues_t_unlink(c,q,tag)        ao2_t_unlink(c,q,tag)
1311 static inline struct call_queue *queue_ref(struct call_queue *q)
1312 {
1313         ao2_ref(q, 1);
1314         return q;
1315 }
1316
1317 static inline struct call_queue *queue_unref(struct call_queue *q)
1318 {
1319         ao2_ref(q, -1);
1320         return NULL;
1321 }
1322 #endif
1323
1324 /*! \brief Set variables of queue */
1325 static void set_queue_variables(struct call_queue *q, struct ast_channel *chan)
1326 {
1327         char interfacevar[256]="";
1328         float sl = 0;
1329
1330         ao2_lock(q);
1331
1332         if (q->setqueuevar) {
1333                 sl = 0;
1334                 if (q->callscompleted > 0) 
1335                         sl = 100 * ((float) q->callscompletedinsl / (float) q->callscompleted);
1336
1337                 snprintf(interfacevar, sizeof(interfacevar),
1338                         "QUEUENAME=%s,QUEUEMAX=%d,QUEUESTRATEGY=%s,QUEUECALLS=%d,QUEUEHOLDTIME=%d,QUEUETALKTIME=%d,QUEUECOMPLETED=%d,QUEUEABANDONED=%d,QUEUESRVLEVEL=%d,QUEUESRVLEVELPERF=%2.1f",
1339                         q->name, q->maxlen, int2strat(q->strategy), q->count, q->holdtime, q->talktime, q->callscompleted, q->callsabandoned,  q->servicelevel, sl);
1340
1341                 ao2_unlock(q);
1342         
1343                 pbx_builtin_setvar_multiple(chan, interfacevar); 
1344         } else {
1345                 ao2_unlock(q);
1346         }
1347 }
1348
1349 /*! \brief Insert the 'new' entry after the 'prev' entry of queue 'q' */
1350 static inline void insert_entry(struct call_queue *q, struct queue_ent *prev, struct queue_ent *new, int *pos)
1351 {
1352         struct queue_ent *cur;
1353
1354         if (!q || !new)
1355                 return;
1356         if (prev) {
1357                 cur = prev->next;
1358                 prev->next = new;
1359         } else {
1360                 cur = q->head;
1361                 q->head = new;
1362         }
1363         new->next = cur;
1364
1365         /* every queue_ent must have a reference to it's parent call_queue, this
1366          * reference does not go away until the end of the queue_ent's life, meaning
1367          * that even when the queue_ent leaves the call_queue this ref must remain. */
1368         queue_ref(q);
1369         new->parent = q;
1370         new->pos = ++(*pos);
1371         new->opos = *pos;
1372 }
1373
1374 /*! \brief Check if members are available
1375  *
1376  * This function checks to see if members are available to be called. If any member
1377  * is available, the function immediately returns 0. If no members are available,
1378  * then -1 is returned.
1379  */
1380 static int get_member_status(struct call_queue *q, int max_penalty, int min_penalty, enum empty_conditions conditions)
1381 {
1382         struct member *member;
1383         struct ao2_iterator mem_iter;
1384
1385         ao2_lock(q);
1386         mem_iter = ao2_iterator_init(q->members, 0);
1387         for (; (member = ao2_iterator_next(&mem_iter)); ao2_ref(member, -1)) {
1388                 if ((max_penalty && (member->penalty > max_penalty)) || (min_penalty && (member->penalty < min_penalty))) {
1389                         if (conditions & QUEUE_EMPTY_PENALTY) {
1390                                 ast_debug(4, "%s is unavailable because his penalty is not between %d and %d\n", member->membername, min_penalty, max_penalty);
1391                                 continue;
1392                         }
1393                 }
1394
1395                 switch (member->status) {
1396                 case AST_DEVICE_INVALID:
1397                         if (conditions & QUEUE_EMPTY_INVALID) {
1398                                 ast_debug(4, "%s is unavailable because his device state is 'invalid'\n", member->membername);
1399                                 break;
1400                         }
1401                         goto default_case;
1402                 case AST_DEVICE_UNAVAILABLE:
1403                         if (conditions & QUEUE_EMPTY_UNAVAILABLE) {
1404                                 ast_debug(4, "%s is unavailable because his device state is 'unavailable'\n", member->membername);
1405                                 break;
1406                         }
1407                         goto default_case;
1408                 case AST_DEVICE_INUSE:
1409                         if (conditions & QUEUE_EMPTY_INUSE) {
1410                                 ast_debug(4, "%s is unavailable because his device state is 'inuse'\n", member->membername);
1411                                 break;
1412                         }
1413                         goto default_case;
1414                 case AST_DEVICE_RINGING:
1415                         if (conditions & QUEUE_EMPTY_RINGING) {
1416                                 ast_debug(4, "%s is unavailable because his device state is 'ringing'\n", member->membername);
1417                                 break;
1418                         }
1419                         goto default_case;
1420                 case AST_DEVICE_UNKNOWN:
1421                         if (conditions & QUEUE_EMPTY_UNKNOWN) {
1422                                 ast_debug(4, "%s is unavailable because his device state is 'unknown'\n", member->membername);
1423                                 break;
1424                         }
1425                         /* Fall-through */
1426                 default:
1427                 default_case:
1428                         if (member->paused && (conditions & QUEUE_EMPTY_PAUSED)) {
1429                                 ast_debug(4, "%s is unavailable because he is paused'\n", member->membername);
1430                                 break;
1431                         } else if ((conditions & QUEUE_EMPTY_WRAPUP) && member->lastcall && q->wrapuptime && (time(NULL) - q->wrapuptime < member->lastcall)) {
1432                                 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);
1433                                 break;
1434                         } else {
1435                                 ao2_unlock(q);
1436                                 ao2_ref(member, -1);
1437                                 ao2_iterator_destroy(&mem_iter);
1438                                 ast_debug(4, "%s is available.\n", member->membername);
1439                                 return 0;
1440                         }
1441                         break;
1442                 }
1443         }
1444         ao2_iterator_destroy(&mem_iter);
1445
1446         ao2_unlock(q);
1447         return -1;
1448 }
1449
1450 struct statechange {
1451         AST_LIST_ENTRY(statechange) entry;
1452         int state;
1453         char dev[0];
1454 };
1455
1456 /*! \brief set a member's status based on device state of that member's state_interface.
1457  *
1458  * Lock interface list find sc, iterate through each queues queue_member list for member to
1459  * update state inside queues
1460 */
1461 static int update_status(struct call_queue *q, struct member *m, const int status)
1462 {
1463         m->status = status;
1464
1465         if (q->maskmemberstatus)
1466                 return 0;
1467
1468         manager_event(EVENT_FLAG_AGENT, "QueueMemberStatus",
1469                 "Queue: %s\r\n"
1470                 "Location: %s\r\n"
1471                 "MemberName: %s\r\n"
1472                 "StateInterface: %s\r\n"
1473                 "Membership: %s\r\n"
1474                 "Penalty: %d\r\n"
1475                 "CallsTaken: %d\r\n"
1476                 "LastCall: %d\r\n"
1477                 "Status: %d\r\n"
1478                 "Paused: %d\r\n",
1479                 q->name, m->interface, m->membername, m->state_interface, m->dynamic ? "dynamic" : m->realtime ? "realtime" : "static",
1480                 m->penalty, m->calls, (int)m->lastcall, m->status, m->paused
1481         );
1482
1483         return 0;
1484 }
1485
1486 /*! \brief set a member's status based on device state of that member's interface*/
1487 static int handle_statechange(void *datap)
1488 {
1489         struct statechange *sc = datap;
1490         struct ao2_iterator miter, qiter;
1491         struct member *m;
1492         struct call_queue *q;
1493         char interface[80], *slash_pos;
1494         int found = 0;
1495
1496         qiter = ao2_iterator_init(queues, 0);
1497         while ((q = ao2_t_iterator_next(&qiter, "Iterate over queues"))) {
1498                 ao2_lock(q);
1499
1500                 miter = ao2_iterator_init(q->members, 0);
1501                 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
1502                         ast_copy_string(interface, m->state_interface, sizeof(interface));
1503
1504                         if ((slash_pos = strchr(interface, '/')))
1505                                 if (!strncasecmp(interface, "Local/", 6) && (slash_pos = strchr(slash_pos + 1, '/')))
1506                                         *slash_pos = '\0';
1507
1508                         if (!strcasecmp(interface, sc->dev)) {
1509                                 found = 1;
1510                                 update_status(q, m, sc->state);
1511                                 ao2_ref(m, -1);
1512                                 break;
1513                         }
1514                 }
1515                 ao2_iterator_destroy(&miter);
1516
1517                 ao2_unlock(q);
1518                 queue_t_unref(q, "Done with iterator");
1519         }
1520         ao2_iterator_destroy(&qiter);
1521
1522         if (found)
1523                 ast_debug(1, "Device '%s' changed to state '%d' (%s)\n", sc->dev, sc->state, ast_devstate2str(sc->state));
1524         else
1525                 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));
1526
1527         ast_free(sc);
1528         return 0;
1529 }
1530
1531 static void device_state_cb(const struct ast_event *event, void *unused)
1532 {
1533         enum ast_device_state state;
1534         const char *device;
1535         struct statechange *sc;
1536         size_t datapsize;
1537
1538         state = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE);
1539         device = ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE);
1540
1541         if (ast_strlen_zero(device)) {
1542                 ast_log(LOG_ERROR, "Received invalid event that had no device IE\n");
1543                 return;
1544         }
1545         datapsize = sizeof(*sc) + strlen(device) + 1;
1546         if (!(sc = ast_calloc(1, datapsize))) {
1547                 ast_log(LOG_ERROR, "failed to calloc a state change struct\n");
1548                 return;
1549         }
1550         sc->state = state;
1551         strcpy(sc->dev, device);
1552         if (ast_taskprocessor_push(devicestate_tps, handle_statechange, sc) < 0) {
1553                 ast_free(sc);
1554         }
1555 }
1556
1557 /*! \brief Helper function which converts from extension state to device state values */
1558 static int extensionstate2devicestate(int state)
1559 {
1560         switch (state) {
1561         case AST_EXTENSION_NOT_INUSE:
1562                 state = AST_DEVICE_NOT_INUSE;
1563                 break;
1564         case AST_EXTENSION_INUSE:
1565                 state = AST_DEVICE_INUSE;
1566                 break;
1567         case AST_EXTENSION_BUSY:
1568                 state = AST_DEVICE_BUSY;
1569                 break;
1570         case AST_EXTENSION_RINGING:
1571                 state = AST_DEVICE_RINGING;
1572                 break;
1573         case AST_EXTENSION_ONHOLD:
1574                 state = AST_DEVICE_ONHOLD;
1575                 break;
1576         case AST_EXTENSION_UNAVAILABLE:
1577                 state = AST_DEVICE_UNAVAILABLE;
1578                 break;
1579         case AST_EXTENSION_REMOVED:
1580         case AST_EXTENSION_DEACTIVATED:
1581         default:
1582                 state = AST_DEVICE_INVALID;
1583                 break;
1584         }
1585
1586         return state;
1587 }
1588
1589 static int extension_state_cb(const char *context, const char *exten, enum ast_extension_states state, void *data)
1590 {
1591         struct ao2_iterator miter, qiter;
1592         struct member *m;
1593         struct call_queue *q;
1594         int found = 0, device_state = extensionstate2devicestate(state);
1595
1596         qiter = ao2_iterator_init(queues, 0);
1597         while ((q = ao2_t_iterator_next(&qiter, "Iterate through queues"))) {
1598                 ao2_lock(q);
1599
1600                 miter = ao2_iterator_init(q->members, 0);
1601                 for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
1602                         if (!strcmp(m->state_context, context) && !strcmp(m->state_exten, exten)) {
1603                                 update_status(q, m, device_state);
1604                                 ao2_ref(m, -1);
1605                                 found = 1;
1606                                 break;
1607                         }
1608                 }
1609                 ao2_iterator_destroy(&miter);
1610
1611                 ao2_unlock(q);
1612                 queue_t_unref(q, "Done with iterator");
1613         }
1614         ao2_iterator_destroy(&qiter);
1615
1616         if (found) {
1617                 ast_debug(1, "Extension '%s@%s' changed to state '%d' (%s)\n", exten, context, device_state, ast_devstate2str(device_state));
1618         } else {
1619                 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",
1620                           exten, context, device_state, ast_devstate2str(device_state));
1621         }
1622
1623         return 0;
1624 }
1625
1626 /*! \brief Return the current state of a member */
1627 static int get_queue_member_status(struct member *cur)
1628 {
1629         return ast_strlen_zero(cur->state_exten) ? ast_device_state(cur->state_interface) : extensionstate2devicestate(ast_extension_state(NULL, cur->state_context, cur->state_exten));
1630 }
1631
1632 /*! \brief allocate space for new queue member and set fields based on parameters passed */
1633 static struct member *create_queue_member(const char *interface, const char *membername, int penalty, int paused, const char *state_interface)
1634 {
1635         struct member *cur;
1636
1637         if ((cur = ao2_alloc(sizeof(*cur), NULL))) {
1638                 cur->penalty = penalty;
1639                 cur->paused = paused;
1640                 ast_copy_string(cur->interface, interface, sizeof(cur->interface));
1641                 if (!ast_strlen_zero(state_interface)) {
1642                         ast_copy_string(cur->state_interface, state_interface, sizeof(cur->state_interface));
1643                 } else {
1644                         ast_copy_string(cur->state_interface, interface, sizeof(cur->state_interface));
1645                 }
1646                 if (!ast_strlen_zero(membername)) {
1647                         ast_copy_string(cur->membername, membername, sizeof(cur->membername));
1648                 } else {
1649                         ast_copy_string(cur->membername, interface, sizeof(cur->membername));
1650                 }
1651                 if (!strchr(cur->interface, '/')) {
1652                         ast_log(LOG_WARNING, "No location at interface '%s'\n", interface);
1653                 }
1654                 if (!strncmp(cur->state_interface, "hint:", 5)) {
1655                         char *tmp = ast_strdupa(cur->state_interface), *context = tmp;
1656                         char *exten = strsep(&context, "@") + 5;
1657
1658                         ast_copy_string(cur->state_exten, exten, sizeof(cur->state_exten));
1659                         ast_copy_string(cur->state_context, S_OR(context, "default"), sizeof(cur->state_context));
1660                 }
1661                 cur->status = get_queue_member_status(cur);
1662         }
1663
1664         return cur;
1665 }
1666
1667
1668 static int compress_char(const char c)
1669 {
1670         if (c < 32)
1671                 return 0;
1672         else if (c > 96)
1673                 return c - 64;
1674         else
1675                 return c - 32;
1676 }
1677
1678 static int member_hash_fn(const void *obj, const int flags)
1679 {
1680         const struct member *mem = obj;
1681         const char *chname = strchr(mem->interface, '/');
1682         int ret = 0, i;
1683         if (!chname)
1684                 chname = mem->interface;
1685         for (i = 0; i < 5 && chname[i]; i++)
1686                 ret += compress_char(chname[i]) << (i * 6);
1687         return ret;
1688 }
1689
1690 static int member_cmp_fn(void *obj1, void *obj2, int flags)
1691 {
1692         struct member *mem1 = obj1, *mem2 = obj2;
1693         return strcasecmp(mem1->interface, mem2->interface) ? 0 : CMP_MATCH | CMP_STOP;
1694 }
1695
1696 /*!
1697  * \brief Initialize Queue default values.
1698  * \note the queue's lock  must be held before executing this function
1699 */
1700 static void init_queue(struct call_queue *q)
1701 {
1702         int i;
1703         struct penalty_rule *pr_iter;
1704
1705         q->dead = 0;
1706         q->retry = DEFAULT_RETRY;
1707         q->timeout = DEFAULT_TIMEOUT;
1708         q->maxlen = 0;
1709         q->announcefrequency = 0;
1710         q->minannouncefrequency = DEFAULT_MIN_ANNOUNCE_FREQUENCY;
1711         q->announceholdtime = 1;
1712         q->announcepositionlimit = 10; /* Default 10 positions */
1713         q->announceposition = ANNOUNCEPOSITION_YES; /* Default yes */
1714         q->roundingseconds = 0; /* Default - don't announce seconds */
1715         q->servicelevel = 0;
1716         q->ringinuse = 1;
1717         q->setinterfacevar = 0;
1718         q->setqueuevar = 0;
1719         q->setqueueentryvar = 0;
1720         q->autofill = autofill_default;
1721         q->montype = montype_default;
1722         q->monfmt[0] = '\0';
1723         q->reportholdtime = 0;
1724         q->wrapuptime = 0;
1725         q->penaltymemberslimit = 0;
1726         q->joinempty = 0;
1727         q->leavewhenempty = 0;
1728         q->memberdelay = 0;
1729         q->maskmemberstatus = 0;
1730         q->eventwhencalled = 0;
1731         q->weight = 0;
1732         q->timeoutrestart = 0;
1733         q->periodicannouncefrequency = 0;
1734         q->randomperiodicannounce = 0;
1735         q->numperiodicannounce = 0;
1736         q->autopause = QUEUE_AUTOPAUSE_OFF;
1737         q->timeoutpriority = TIMEOUT_PRIORITY_APP;
1738         q->autopausedelay = 0;
1739         if (!q->members) {
1740                 if (q->strategy == QUEUE_STRATEGY_LINEAR || q->strategy == QUEUE_STRATEGY_RRORDERED)
1741                         /* linear strategy depends on order, so we have to place all members in a single bucket */
1742                         q->members = ao2_container_alloc(1, member_hash_fn, member_cmp_fn);
1743                 else
1744                         q->members = ao2_container_alloc(37, member_hash_fn, member_cmp_fn);
1745         }
1746         q->found = 1;
1747
1748         ast_string_field_set(q, sound_next, "queue-youarenext");
1749         ast_string_field_set(q, sound_thereare, "queue-thereare");
1750         ast_string_field_set(q, sound_calls, "queue-callswaiting");
1751         ast_string_field_set(q, queue_quantity1, "queue-quantity1");
1752         ast_string_field_set(q, queue_quantity2, "queue-quantity2");
1753         ast_string_field_set(q, sound_holdtime, "queue-holdtime");
1754         ast_string_field_set(q, sound_minutes, "queue-minutes");
1755         ast_string_field_set(q, sound_minute, "queue-minute");
1756         ast_string_field_set(q, sound_seconds, "queue-seconds");
1757         ast_string_field_set(q, sound_thanks, "queue-thankyou");
1758         ast_string_field_set(q, sound_reporthold, "queue-reporthold");
1759
1760         if (!q->sound_periodicannounce[0]) {
1761                 q->sound_periodicannounce[0] = ast_str_create(32);
1762         }
1763
1764         if (q->sound_periodicannounce[0]) {
1765                 ast_str_set(&q->sound_periodicannounce[0], 0, "queue-periodic-announce");
1766         }
1767
1768         for (i = 1; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) {
1769                 if (q->sound_periodicannounce[i])
1770                         ast_str_set(&q->sound_periodicannounce[i], 0, "%s", "");
1771         }
1772
1773         while ((pr_iter = AST_LIST_REMOVE_HEAD(&q->rules,list)))
1774                 ast_free(pr_iter);
1775 }
1776
1777 static void clear_queue(struct call_queue *q)
1778 {
1779         q->holdtime = 0;
1780         q->callscompleted = 0;
1781         q->callsabandoned = 0;
1782         q->callscompletedinsl = 0;
1783         q->talktime = 0;
1784
1785         if (q->members) {
1786                 struct member *mem;
1787                 struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
1788                 while ((mem = ao2_iterator_next(&mem_iter))) {
1789                         mem->calls = 0;
1790                         mem->lastcall = 0;
1791                         ao2_ref(mem, -1);
1792                 }
1793                 ao2_iterator_destroy(&mem_iter);
1794         }
1795 }
1796
1797 /*!
1798  * \brief Change queue penalty by adding rule.
1799  *
1800  * Check rule for errors with time or fomatting, see if rule is relative to rest
1801  * of queue, iterate list of rules to find correct insertion point, insert and return.
1802  * \retval -1 on failure
1803  * \retval 0 on success
1804  * \note Call this with the rule_lists locked
1805 */
1806 static int insert_penaltychange(const char *list_name, const char *content, const int linenum)
1807 {
1808         char *timestr, *maxstr, *minstr, *contentdup;
1809         struct penalty_rule *rule = NULL, *rule_iter;
1810         struct rule_list *rl_iter;
1811         int penaltychangetime, inserted = 0;
1812
1813         if (!(rule = ast_calloc(1, sizeof(*rule)))) {
1814                 return -1;
1815         }
1816
1817         contentdup = ast_strdupa(content);
1818         
1819         if (!(maxstr = strchr(contentdup, ','))) {
1820                 ast_log(LOG_WARNING, "Improperly formatted penaltychange rule at line %d. Ignoring.\n", linenum);
1821                 ast_free(rule);
1822                 return -1;
1823         }
1824
1825         *maxstr++ = '\0';
1826         timestr = contentdup;
1827
1828         if ((penaltychangetime = atoi(timestr)) < 0) {
1829                 ast_log(LOG_WARNING, "Improper time parameter specified for penaltychange rule at line %d. Ignoring.\n", linenum);
1830                 ast_free(rule);
1831                 return -1;
1832         }
1833
1834         rule->time = penaltychangetime;
1835
1836         if ((minstr = strchr(maxstr,',')))
1837                 *minstr++ = '\0';
1838         
1839         /* The last check will evaluate true if either no penalty change is indicated for a given rule
1840          * OR if a min penalty change is indicated but no max penalty change is */
1841         if (*maxstr == '+' || *maxstr == '-' || *maxstr == '\0') {
1842                 rule->max_relative = 1;
1843         }
1844
1845         rule->max_value = atoi(maxstr);
1846
1847         if (!ast_strlen_zero(minstr)) {
1848                 if (*minstr == '+' || *minstr == '-')
1849                         rule->min_relative = 1;
1850                 rule->min_value = atoi(minstr);
1851         } else /*there was no minimum specified, so assume this means no change*/
1852                 rule->min_relative = 1;
1853
1854         /*We have the rule made, now we need to insert it where it belongs*/
1855         AST_LIST_TRAVERSE(&rule_lists, rl_iter, list){
1856                 if (strcasecmp(rl_iter->name, list_name))
1857                         continue;
1858
1859                 AST_LIST_TRAVERSE_SAFE_BEGIN(&rl_iter->rules, rule_iter, list) {
1860                         if (rule->time < rule_iter->time) {
1861                                 AST_LIST_INSERT_BEFORE_CURRENT(rule, list);
1862                                 inserted = 1;
1863                                 break;
1864                         }
1865                 }
1866                 AST_LIST_TRAVERSE_SAFE_END;
1867         
1868                 if (!inserted) {
1869                         AST_LIST_INSERT_TAIL(&rl_iter->rules, rule, list);
1870                 }
1871         }
1872
1873         return 0;
1874 }
1875
1876 static void parse_empty_options(const char *value, enum empty_conditions *empty, int joinempty)
1877 {
1878         char *value_copy = ast_strdupa(value);
1879         char *option = NULL;
1880         while ((option = strsep(&value_copy, ","))) {
1881                 if (!strcasecmp(option, "paused")) {
1882                         *empty |= QUEUE_EMPTY_PAUSED;
1883                 } else if (!strcasecmp(option, "penalty")) {
1884                         *empty |= QUEUE_EMPTY_PENALTY;
1885                 } else if (!strcasecmp(option, "inuse")) {
1886                         *empty |= QUEUE_EMPTY_INUSE;
1887                 } else if (!strcasecmp(option, "ringing")) {
1888                         *empty |= QUEUE_EMPTY_RINGING;
1889                 } else if (!strcasecmp(option, "invalid")) {
1890                         *empty |= QUEUE_EMPTY_INVALID;
1891                 } else if (!strcasecmp(option, "wrapup")) {
1892                         *empty |= QUEUE_EMPTY_WRAPUP;
1893                 } else if (!strcasecmp(option, "unavailable")) {
1894                         *empty |= QUEUE_EMPTY_UNAVAILABLE;
1895                 } else if (!strcasecmp(option, "unknown")) {
1896                         *empty |= QUEUE_EMPTY_UNKNOWN;
1897                 } else if (!strcasecmp(option, "loose")) {
1898                         *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID);
1899                 } else if (!strcasecmp(option, "strict")) {
1900                         *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED | QUEUE_EMPTY_UNAVAILABLE);
1901                 } else if ((ast_false(option) && joinempty) || (ast_true(option) && !joinempty)) {
1902                         *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED);
1903                 } else if ((ast_false(option) && !joinempty) || (ast_true(option) && joinempty)) {
1904                         *empty = 0;
1905                 } else {
1906                         ast_log(LOG_WARNING, "Unknown option %s for '%s'\n", option, joinempty ? "joinempty" : "leavewhenempty");
1907                 }
1908         }
1909 }
1910
1911 /*! \brief Configure a queue parameter.
1912  * 
1913  * The failunknown flag is set for config files (and static realtime) to show
1914  * errors for unknown parameters. It is cleared for dynamic realtime to allow
1915  *  extra fields in the tables.
1916  * \note For error reporting, line number is passed for .conf static configuration,
1917  * for Realtime queues, linenum is -1.
1918 */
1919 static void queue_set_param(struct call_queue *q, const char *param, const char *val, int linenum, int failunknown)
1920 {
1921         if (!strcasecmp(param, "musicclass") || 
1922                 !strcasecmp(param, "music") || !strcasecmp(param, "musiconhold")) {
1923                 ast_string_field_set(q, moh, val);
1924         } else if (!strcasecmp(param, "announce")) {
1925                 ast_string_field_set(q, announce, val);
1926         } else if (!strcasecmp(param, "context")) {
1927                 ast_string_field_set(q, context, val);
1928         } else if (!strcasecmp(param, "timeout")) {
1929                 q->timeout = atoi(val);
1930                 if (q->timeout < 0)
1931                         q->timeout = DEFAULT_TIMEOUT;
1932         } else if (!strcasecmp(param, "ringinuse")) {
1933                 q->ringinuse = ast_true(val);
1934         } else if (!strcasecmp(param, "setinterfacevar")) {
1935                 q->setinterfacevar = ast_true(val);
1936         } else if (!strcasecmp(param, "setqueuevar")) {
1937                 q->setqueuevar = ast_true(val);
1938         } else if (!strcasecmp(param, "setqueueentryvar")) {
1939                 q->setqueueentryvar = ast_true(val);
1940         } else if (!strcasecmp(param, "monitor-format")) {
1941                 ast_copy_string(q->monfmt, val, sizeof(q->monfmt));
1942         } else if (!strcasecmp(param, "membermacro")) {
1943                 ast_string_field_set(q, membermacro, val);
1944         } else if (!strcasecmp(param, "membergosub")) {
1945                 ast_string_field_set(q, membergosub, val);
1946         } else if (!strcasecmp(param, "queue-youarenext")) {
1947                 ast_string_field_set(q, sound_next, val);
1948         } else if (!strcasecmp(param, "queue-thereare")) {
1949                 ast_string_field_set(q, sound_thereare, val);
1950         } else if (!strcasecmp(param, "queue-callswaiting")) {
1951                 ast_string_field_set(q, sound_calls, val);
1952         } else if (!strcasecmp(param, "queue-quantity1")) {
1953                 ast_string_field_set(q, queue_quantity1, val);
1954         } else if (!strcasecmp(param, "queue-quantity2")) {
1955                 ast_string_field_set(q, queue_quantity2, val);
1956         } else if (!strcasecmp(param, "queue-holdtime")) {
1957                 ast_string_field_set(q, sound_holdtime, val);
1958         } else if (!strcasecmp(param, "queue-minutes")) {
1959                 ast_string_field_set(q, sound_minutes, val);
1960         } else if (!strcasecmp(param, "queue-minute")) {
1961                 ast_string_field_set(q, sound_minute, val);
1962         } else if (!strcasecmp(param, "queue-seconds")) {
1963                 ast_string_field_set(q, sound_seconds, val);
1964         } else if (!strcasecmp(param, "queue-thankyou")) {
1965                 ast_string_field_set(q, sound_thanks, val);
1966         } else if (!strcasecmp(param, "queue-callerannounce")) {
1967                 ast_string_field_set(q, sound_callerannounce, val);
1968         } else if (!strcasecmp(param, "queue-reporthold")) {
1969                 ast_string_field_set(q, sound_reporthold, val);
1970         } else if (!strcasecmp(param, "announce-frequency")) {
1971                 q->announcefrequency = atoi(val);
1972         } else if (!strcasecmp(param, "min-announce-frequency")) {
1973                 q->minannouncefrequency = atoi(val);
1974                 ast_debug(1, "%s=%s for queue '%s'\n", param, val, q->name);
1975         } else if (!strcasecmp(param, "announce-round-seconds")) {
1976                 q->roundingseconds = atoi(val);
1977                 /* Rounding to any other values just doesn't make sense... */
1978                 if (!(q->roundingseconds == 0 || q->roundingseconds == 5 || q->roundingseconds == 10
1979                         || q->roundingseconds == 15 || q->roundingseconds == 20 || q->roundingseconds == 30)) {
1980                         if (linenum >= 0) {
1981                                 ast_log(LOG_WARNING, "'%s' isn't a valid value for %s "
1982                                         "using 0 instead for queue '%s' at line %d of queues.conf\n",
1983                                         val, param, q->name, linenum);
1984                         } else {
1985                                 ast_log(LOG_WARNING, "'%s' isn't a valid value for %s "
1986                                         "using 0 instead for queue '%s'\n", val, param, q->name);
1987                         }
1988                         q->roundingseconds=0;
1989                 }
1990         } else if (!strcasecmp(param, "announce-holdtime")) {
1991                 if (!strcasecmp(val, "once"))
1992                         q->announceholdtime = ANNOUNCEHOLDTIME_ONCE;
1993                 else if (ast_true(val))
1994                         q->announceholdtime = ANNOUNCEHOLDTIME_ALWAYS;
1995                 else
1996                         q->announceholdtime = 0;
1997         } else if (!strcasecmp(param, "announce-position")) {
1998                 if (!strcasecmp(val, "limit"))
1999                         q->announceposition = ANNOUNCEPOSITION_LIMIT;
2000                 else if (!strcasecmp(val, "more"))
2001                         q->announceposition = ANNOUNCEPOSITION_MORE_THAN;
2002                 else if (ast_true(val))
2003                         q->announceposition = ANNOUNCEPOSITION_YES;
2004                 else
2005                         q->announceposition = ANNOUNCEPOSITION_NO;
2006         } else if (!strcasecmp(param, "announce-position-limit")) {
2007                 q->announcepositionlimit = atoi(val);
2008         } else if (!strcasecmp(param, "periodic-announce")) {
2009                 if (strchr(val, ',')) {
2010                         char *s, *buf = ast_strdupa(val);
2011                         unsigned int i = 0;
2012
2013                         while ((s = strsep(&buf, ",|"))) {
2014                                 if (!q->sound_periodicannounce[i])
2015                                         q->sound_periodicannounce[i] = ast_str_create(16);
2016                                 ast_str_set(&q->sound_periodicannounce[i], 0, "%s", s);
2017                                 i++;
2018                                 if (i == MAX_PERIODIC_ANNOUNCEMENTS)
2019                                         break;
2020                         }
2021                         q->numperiodicannounce = i;
2022                 } else {
2023                         ast_str_set(&q->sound_periodicannounce[0], 0, "%s", val);
2024                         q->numperiodicannounce = 1;
2025                 }
2026         } else if (!strcasecmp(param, "periodic-announce-frequency")) {
2027                 q->periodicannouncefrequency = atoi(val);
2028         } else if (!strcasecmp(param, "relative-periodic-announce")) {
2029                 q->relativeperiodicannounce = ast_true(val);
2030         } else if (!strcasecmp(param, "random-periodic-announce")) {
2031                 q->randomperiodicannounce = ast_true(val);
2032         } else if (!strcasecmp(param, "retry")) {
2033                 q->retry = atoi(val);
2034                 if (q->retry <= 0)
2035                         q->retry = DEFAULT_RETRY;
2036         } else if (!strcasecmp(param, "wrapuptime")) {
2037                 q->wrapuptime = atoi(val);
2038         } else if (!strcasecmp(param, "penaltymemberslimit")) {
2039                 if ((sscanf(val, "%10d", &q->penaltymemberslimit) != 1)) {
2040                         q->penaltymemberslimit = 0;
2041                 }
2042         } else if (!strcasecmp(param, "autofill")) {
2043                 q->autofill = ast_true(val);
2044         } else if (!strcasecmp(param, "monitor-type")) {
2045                 if (!strcasecmp(val, "mixmonitor"))
2046                         q->montype = 1;
2047         } else if (!strcasecmp(param, "autopause")) {
2048                 q->autopause = autopause2int(val);
2049         } else if (!strcasecmp(param, "autopausedelay")) {
2050                 q->autopausedelay = atoi(val);
2051         } else if (!strcasecmp(param, "autopausebusy")) {
2052                 q->autopausebusy = ast_true(val);
2053         } else if (!strcasecmp(param, "autopauseunavail")) {
2054                 q->autopauseunavail = ast_true(val);
2055         } else if (!strcasecmp(param, "maxlen")) {
2056                 q->maxlen = atoi(val);
2057                 if (q->maxlen < 0)
2058                         q->maxlen = 0;
2059         } else if (!strcasecmp(param, "servicelevel")) {
2060                 q->servicelevel= atoi(val);
2061         } else if (!strcasecmp(param, "strategy")) {
2062                 int strategy;
2063
2064                 /* We are a static queue and already have set this, no need to do it again */
2065                 if (failunknown) {
2066                         return;
2067                 }
2068                 strategy = strat2int(val);
2069                 if (strategy < 0) {
2070                         ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
2071                                 val, q->name);
2072                         q->strategy = QUEUE_STRATEGY_RINGALL;
2073                 }
2074                 if (strategy == q->strategy) {
2075                         return;
2076                 }
2077                 if (strategy == QUEUE_STRATEGY_LINEAR) {
2078                         ast_log(LOG_WARNING, "Changing to the linear strategy currently requires asterisk to be restarted.\n");
2079                         return;
2080                 }
2081                 q->strategy = strategy;
2082         } else if (!strcasecmp(param, "joinempty")) {
2083                 parse_empty_options(val, &q->joinempty, 1);
2084         } else if (!strcasecmp(param, "leavewhenempty")) {
2085                 parse_empty_options(val, &q->leavewhenempty, 0);
2086         } else if (!strcasecmp(param, "eventmemberstatus")) {
2087                 q->maskmemberstatus = !ast_true(val);
2088         } else if (!strcasecmp(param, "eventwhencalled")) {
2089                 if (!strcasecmp(val, "vars")) {
2090                         q->eventwhencalled = QUEUE_EVENT_VARIABLES;
2091                 } else {
2092                         q->eventwhencalled = ast_true(val) ? 1 : 0;
2093                 }
2094         } else if (!strcasecmp(param, "reportholdtime")) {
2095                 q->reportholdtime = ast_true(val);
2096         } else if (!strcasecmp(param, "memberdelay")) {
2097                 q->memberdelay = atoi(val);
2098         } else if (!strcasecmp(param, "weight")) {
2099                 q->weight = atoi(val);
2100         } else if (!strcasecmp(param, "timeoutrestart")) {
2101                 q->timeoutrestart = ast_true(val);
2102         } else if (!strcasecmp(param, "defaultrule")) {
2103                 ast_string_field_set(q, defaultrule, val);
2104         } else if (!strcasecmp(param, "timeoutpriority")) {
2105                 if (!strcasecmp(val, "conf")) {
2106                         q->timeoutpriority = TIMEOUT_PRIORITY_CONF;
2107                 } else {
2108                         q->timeoutpriority = TIMEOUT_PRIORITY_APP;
2109                 }
2110         } else if (failunknown) {
2111                 if (linenum >= 0) {
2112                         ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s at line %d of queues.conf\n",
2113                                 q->name, param, linenum);
2114                 } else {
2115                         ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s\n", q->name, param);
2116                 }
2117         }
2118 }
2119
2120 /*!
2121  * \brief Find rt member record to update otherwise create one.
2122  *
2123  * Search for member in queue, if found update penalty/paused state,
2124  * if no member exists create one flag it as a RT member and add to queue member list.
2125 */
2126 static void rt_handle_member_record(struct call_queue *q, char *interface, struct ast_config *member_config)
2127 {
2128         struct member *m;
2129         struct ao2_iterator mem_iter;
2130         int penalty = 0;
2131         int paused  = 0;
2132         int found = 0;
2133         int ignorebusy = 0;
2134
2135         const char *config_val;
2136         const char *rt_uniqueid = ast_variable_retrieve(member_config, interface, "uniqueid");
2137         const char *membername = S_OR(ast_variable_retrieve(member_config, interface, "membername"), interface);
2138         const char *state_interface = S_OR(ast_variable_retrieve(member_config, interface, "state_interface"), interface);
2139         const char *penalty_str = ast_variable_retrieve(member_config, interface, "penalty");
2140         const char *paused_str = ast_variable_retrieve(member_config, interface, "paused");
2141
2142         if (ast_strlen_zero(rt_uniqueid)) {
2143                 ast_log(LOG_WARNING, "Realtime field uniqueid is empty for member %s\n", S_OR(membername, "NULL"));
2144                 return;
2145         }
2146
2147         if (penalty_str) {
2148                 penalty = atoi(penalty_str);
2149                 if ((penalty < 0) && negative_penalty_invalid) {
2150                         return;
2151                 } else if (penalty < 0) {
2152                         penalty = 0;
2153                 }
2154         }
2155
2156         if (paused_str) {
2157                 paused = atoi(paused_str);
2158                 if (paused < 0) {
2159                         paused = 0;
2160                 }
2161         }
2162
2163         if ((config_val = ast_variable_retrieve(member_config, interface, "ignorebusy"))) {
2164                 ignorebusy = ast_true(config_val);
2165         } else {
2166                 ignorebusy = 1;
2167         }
2168
2169         /* Find member by realtime uniqueid and update */
2170         mem_iter = ao2_iterator_init(q->members, 0);
2171         while ((m = ao2_iterator_next(&mem_iter))) {
2172                 if (!strcasecmp(m->rt_uniqueid, rt_uniqueid)) {
2173                         m->dead = 0;    /* Do not delete this one. */
2174                         ast_copy_string(m->rt_uniqueid, rt_uniqueid, sizeof(m->rt_uniqueid));
2175                         if (paused_str) {
2176                                 m->paused = paused;
2177                         }
2178                         if (strcasecmp(state_interface, m->state_interface)) {
2179                                 ast_copy_string(m->state_interface, state_interface, sizeof(m->state_interface));
2180                         }
2181                         m->penalty = penalty;
2182                         m->ignorebusy = ignorebusy;
2183                         found = 1;
2184                         ao2_ref(m, -1);
2185                         break;
2186                 }
2187                 ao2_ref(m, -1);
2188         }
2189         ao2_iterator_destroy(&mem_iter);
2190
2191         /* Create a new member */
2192         if (!found) {
2193                 if ((m = create_queue_member(interface, membername, penalty, paused, state_interface))) {
2194                         m->dead = 0;
2195                         m->realtime = 1;
2196                         m->ignorebusy = ignorebusy;
2197                         ast_copy_string(m->rt_uniqueid, rt_uniqueid, sizeof(m->rt_uniqueid));
2198                         if (!log_membername_as_agent) {
2199                                 ast_queue_log(q->name, "REALTIME", m->interface, "ADDMEMBER", "%s", "");
2200                         } else {
2201                                 ast_queue_log(q->name, "REALTIME", m->membername, "ADDMEMBER", "%s", "");
2202                         }
2203                         ao2_link(q->members, m);
2204                         ao2_ref(m, -1);
2205                         m = NULL;
2206                         q->membercount++;
2207                 }
2208         }
2209 }
2210
2211 /*! \brief Iterate through queue's member list and delete them */
2212 static void free_members(struct call_queue *q, int all)
2213 {
2214         /* Free non-dynamic members */
2215         struct member *cur;
2216         struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
2217
2218         while ((cur = ao2_iterator_next(&mem_iter))) {
2219                 if (all || !cur->dynamic) {
2220                         ao2_unlink(q->members, cur);
2221                         q->membercount--;
2222                 }
2223                 ao2_ref(cur, -1);
2224         }
2225         ao2_iterator_destroy(&mem_iter);
2226 }
2227
2228 /*! \brief Free queue's member list then its string fields */
2229 static void destroy_queue(void *obj)
2230 {
2231         struct call_queue *q = obj;
2232         int i;
2233
2234         free_members(q, 1);
2235         ast_string_field_free_memory(q);
2236         for (i = 0; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) {
2237                 if (q->sound_periodicannounce[i])
2238                         free(q->sound_periodicannounce[i]);
2239         }
2240         ao2_ref(q->members, -1);
2241 }
2242
2243 static struct call_queue *alloc_queue(const char *queuename)
2244 {
2245         struct call_queue *q;
2246
2247         if ((q = ao2_t_alloc(sizeof(*q), destroy_queue, "Allocate queue"))) {
2248                 if (ast_string_field_init(q, 64)) {
2249                         queue_t_unref(q, "String field allocation failed");
2250                         return NULL;
2251                 }
2252                 ast_string_field_set(q, name, queuename);
2253         }
2254         return q;
2255 }
2256
2257 /*!
2258  * \brief Reload a single queue via realtime.
2259  *
2260  * Check for statically defined queue first, check if deleted RT queue,
2261  * check for new RT queue, if queue vars are not defined init them with defaults.
2262  * reload RT queue vars, set RT queue members dead and reload them, return finished queue.
2263  * \retval the queue,
2264  * \retval NULL if it doesn't exist.
2265  * \note Should be called with the "queues" container locked.
2266 */
2267 static struct call_queue *find_queue_by_name_rt(const char *queuename, struct ast_variable *queue_vars, struct ast_config *member_config)
2268 {
2269         struct ast_variable *v;
2270         struct call_queue *q, tmpq = {
2271                 .name = queuename,
2272         };
2273         struct member *m;
2274         struct ao2_iterator mem_iter;
2275         char *interface = NULL;
2276         const char *tmp_name;
2277         char *tmp;
2278         char tmpbuf[64];        /* Must be longer than the longest queue param name. */
2279
2280         /* Static queues override realtime. */
2281         if ((q = ao2_t_find(queues, &tmpq, OBJ_POINTER, "Check if static queue exists"))) {
2282                 ao2_lock(q);
2283                 if (!q->realtime) {
2284                         if (q->dead) {
2285                                 ao2_unlock(q);
2286                                 queue_t_unref(q, "Queue is dead; can't return it");
2287                                 return NULL;
2288                         } else {
2289                                 ast_log(LOG_WARNING, "Static queue '%s' already exists. Not loading from realtime\n", q->name);
2290                                 ao2_unlock(q);
2291                                 return q;
2292                         }
2293                 }
2294         } else if (!member_config) {
2295                 /* Not found in the list, and it's not realtime ... */
2296                 return NULL;
2297         }
2298         /* Check if queue is defined in realtime. */
2299         if (!queue_vars) {
2300                 /* Delete queue from in-core list if it has been deleted in realtime. */
2301                 if (q) {
2302                         /*! \note Hmm, can't seem to distinguish a DB failure from a not
2303                            found condition... So we might delete an in-core queue
2304                            in case of DB failure. */
2305                         ast_debug(1, "Queue %s not found in realtime.\n", queuename);
2306
2307                         q->dead = 1;
2308                         /* Delete if unused (else will be deleted when last caller leaves). */
2309                         queues_t_unlink(queues, q, "Unused; removing from container");
2310                         ao2_unlock(q);
2311                         queue_t_unref(q, "Queue is dead; can't return it");
2312                 }
2313                 return NULL;
2314         }
2315
2316         /* Create a new queue if an in-core entry does not exist yet. */
2317         if (!q) {
2318                 struct ast_variable *tmpvar = NULL;
2319                 if (!(q = alloc_queue(queuename))) {
2320                         return NULL;
2321                 }
2322                 ao2_lock(q);
2323                 clear_queue(q);
2324                 q->realtime = 1;
2325                 q->membercount = 0;
2326                 /*Before we initialize the queue, we need to set the strategy, so that linear strategy
2327                  * will allocate the members properly
2328                  */
2329                 for (tmpvar = queue_vars; tmpvar; tmpvar = tmpvar->next) {
2330                         if (!strcasecmp(tmpvar->name, "strategy")) {
2331                                 q->strategy = strat2int(tmpvar->value);
2332                                 if (q->strategy < 0) {
2333                                         ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
2334                                         tmpvar->value, q->name);
2335                                         q->strategy = QUEUE_STRATEGY_RINGALL;
2336                                 }
2337                                 break;
2338                         }
2339                 }
2340                 /* We traversed all variables and didn't find a strategy */
2341                 if (!tmpvar) {
2342                         q->strategy = QUEUE_STRATEGY_RINGALL;
2343                 }
2344                 queues_t_link(queues, q, "Add queue to container");
2345         }
2346         init_queue(q);          /* Ensure defaults for all parameters not set explicitly. */
2347
2348         memset(tmpbuf, 0, sizeof(tmpbuf));
2349         for (v = queue_vars; v; v = v->next) {
2350                 /* Convert to dashes `-' from underscores `_' as the latter are more SQL friendly. */
2351                 if ((tmp = strchr(v->name, '_'))) {
2352                         ast_copy_string(tmpbuf, v->name, sizeof(tmpbuf));
2353                         tmp_name = tmpbuf;
2354                         tmp = tmpbuf;
2355                         while ((tmp = strchr(tmp, '_')))
2356                                 *tmp++ = '-';
2357                 } else
2358                         tmp_name = v->name;
2359
2360                 /* NULL values don't get returned from realtime; blank values should
2361                  * still get set.  If someone doesn't want a value to be set, they
2362                  * should set the realtime column to NULL, not blank. */
2363                 queue_set_param(q, tmp_name, v->value, -1, 0);
2364         }
2365
2366         /* Temporarily set realtime members dead so we can detect deleted ones.
2367          * Also set the membercount correctly for realtime*/
2368         mem_iter = ao2_iterator_init(q->members, 0);
2369         while ((m = ao2_iterator_next(&mem_iter))) {
2370                 q->membercount++;
2371                 if (m->realtime) {
2372                         m->dead = 1;
2373                 }
2374                 ao2_ref(m, -1);
2375         }
2376         ao2_iterator_destroy(&mem_iter);
2377
2378         while ((interface = ast_category_browse(member_config, interface))) {
2379                 rt_handle_member_record(q, interface, member_config);
2380         }
2381
2382         /* Delete all realtime members that have been deleted in DB. */
2383         mem_iter = ao2_iterator_init(q->members, 0);
2384         while ((m = ao2_iterator_next(&mem_iter))) {
2385                 if (m->dead) {
2386                         if (ast_strlen_zero(m->membername) || !log_membername_as_agent) {
2387                                 ast_queue_log(q->name, "REALTIME", m->interface, "REMOVEMEMBER", "%s", "");
2388                         } else {
2389                                 ast_queue_log(q->name, "REALTIME", m->membername, "REMOVEMEMBER", "%s", "");
2390                         }
2391                         ao2_unlink(q->members, m);
2392                         q->membercount--;
2393                 }
2394                 ao2_ref(m, -1);
2395         }
2396         ao2_iterator_destroy(&mem_iter);
2397
2398         ao2_unlock(q);
2399
2400         return q;
2401 }
2402
2403 /*! \note Returns a reference to the loaded realtime queue. */
2404 static struct call_queue *load_realtime_queue(const char *queuename)
2405 {
2406         struct ast_variable *queue_vars;
2407         struct ast_config *member_config = NULL;
2408         struct call_queue *q = NULL, tmpq = {
2409                 .name = queuename,
2410         };
2411         int prev_weight = 0;
2412
2413         /* Find the queue in the in-core list first. */
2414         q = ao2_t_find(queues, &tmpq, OBJ_POINTER, "Look for queue in memory first");
2415
2416         if (!q || q->realtime) {
2417                 /*! \note Load from realtime before taking the "queues" container lock, to avoid blocking all
2418                    queue operations while waiting for the DB.
2419
2420                    This will be two separate database transactions, so we might
2421                    see queue parameters as they were before another process
2422                    changed the queue and member list as it was after the change.
2423                    Thus we might see an empty member list when a queue is
2424                    deleted. In practise, this is unlikely to cause a problem. */
2425
2426                 queue_vars = ast_load_realtime("queues", "name", queuename, SENTINEL);
2427                 if (queue_vars) {
2428                         member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", queuename, SENTINEL);
2429                         if (!member_config) {
2430                                 ast_log(LOG_ERROR, "no queue_members defined in your config (extconfig.conf).\n");
2431                                 ast_variables_destroy(queue_vars);
2432                                 return NULL;
2433                         }
2434                 }
2435                 if (q) {
2436                         prev_weight = q->weight ? 1 : 0;
2437                         queue_t_unref(q, "Need to find realtime queue");
2438                 }
2439
2440                 q = find_queue_by_name_rt(queuename, queue_vars, member_config);
2441                 ast_config_destroy(member_config);
2442                 ast_variables_destroy(queue_vars);
2443
2444                 /* update the use_weight value if the queue's has gained or lost a weight */
2445                 if (q) {
2446                         if (!q->weight && prev_weight) {
2447                                 ast_atomic_fetchadd_int(&use_weight, -1);
2448                         }
2449                         if (q->weight && !prev_weight) {
2450                                 ast_atomic_fetchadd_int(&use_weight, +1);
2451                         }
2452                 }
2453                 /* Other cases will end up with the proper value for use_weight */
2454         } else {
2455                 update_realtime_members(q);
2456         }
2457         return q;
2458 }
2459
2460 static int update_realtime_member_field(struct member *mem, const char *queue_name, const char *field, const char *value)
2461 {
2462         int ret = -1;
2463
2464         if (ast_strlen_zero(mem->rt_uniqueid))
2465                 return ret;
2466
2467         if ((ast_update_realtime("queue_members", "uniqueid", mem->rt_uniqueid, field, value, SENTINEL)) > 0)
2468                 ret = 0;
2469
2470         return ret;
2471 }
2472
2473
2474 static void update_realtime_members(struct call_queue *q)
2475 {
2476         struct ast_config *member_config = NULL;
2477         struct member *m;
2478         char *interface = NULL;
2479         struct ao2_iterator mem_iter;
2480
2481         if (!(member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", q->name , SENTINEL))) {
2482                 /*This queue doesn't have realtime members*/
2483                 ast_debug(3, "Queue %s has no realtime members defined. No need for update\n", q->name);
2484                 return;
2485         }
2486
2487         ao2_lock(q);
2488
2489         /* Temporarily set realtime  members dead so we can detect deleted ones.*/
2490         mem_iter = ao2_iterator_init(q->members, 0);
2491         while ((m = ao2_iterator_next(&mem_iter))) {
2492                 if (m->realtime)
2493                         m->dead = 1;
2494                 ao2_ref(m, -1);
2495         }
2496         ao2_iterator_destroy(&mem_iter);
2497
2498         while ((interface = ast_category_browse(member_config, interface))) {
2499                 rt_handle_member_record(q, interface, member_config);
2500         }
2501
2502         /* Delete all realtime members that have been deleted in DB. */
2503         mem_iter = ao2_iterator_init(q->members, 0);
2504         while ((m = ao2_iterator_next(&mem_iter))) {
2505                 if (m->dead) {
2506                         if (ast_strlen_zero(m->membername) || !log_membername_as_agent) {
2507                                 ast_queue_log(q->name, "REALTIME", m->interface, "REMOVEMEMBER", "%s", "");
2508                         } else {
2509                                 ast_queue_log(q->name, "REALTIME", m->membername, "REMOVEMEMBER", "%s", "");
2510                         }
2511                         ao2_unlink(q->members, m);
2512                         q->membercount--;
2513                 }
2514                 ao2_ref(m, -1);
2515         }
2516         ao2_iterator_destroy(&mem_iter);
2517         ao2_unlock(q);
2518         ast_config_destroy(member_config);
2519 }
2520
2521 static int join_queue(char *queuename, struct queue_ent *qe, enum queue_result *reason, int position)
2522 {
2523         struct call_queue *q;
2524         struct queue_ent *cur, *prev = NULL;
2525         int res = -1;
2526         int pos = 0;
2527         int inserted = 0;
2528
2529         if (!(q = load_realtime_queue(queuename))) {
2530                 return res;
2531         }
2532         ao2_lock(q);
2533
2534         /* This is our one */
2535         if (q->joinempty) {
2536                 int status = 0;
2537                 if ((status = get_member_status(q, qe->max_penalty, qe->min_penalty, q->joinempty))) {
2538                         *reason = QUEUE_JOINEMPTY;
2539                         ao2_unlock(q);
2540                         queue_t_unref(q, "Done with realtime queue");
2541                         return res;
2542                 }
2543         }
2544         if (*reason == QUEUE_UNKNOWN && q->maxlen && (q->count >= q->maxlen))
2545                 *reason = QUEUE_FULL;
2546         else if (*reason == QUEUE_UNKNOWN) {
2547                 /* There's space for us, put us at the right position inside
2548                  * the queue.
2549                  * Take into account the priority of the calling user */
2550                 inserted = 0;
2551                 prev = NULL;
2552                 cur = q->head;
2553                 while (cur) {
2554                         /* We have higher priority than the current user, enter
2555                          * before him, after all the other users with priority
2556                          * higher or equal to our priority. */
2557                         if ((!inserted) && (qe->prio > cur->prio)) {
2558                                 insert_entry(q, prev, qe, &pos);
2559                                 inserted = 1;
2560                         }
2561                         /* <= is necessary for the position comparison because it may not be possible to enter
2562                          * at our desired position since higher-priority callers may have taken the position we want
2563                          */
2564                         if (!inserted && (qe->prio >= cur->prio) && position && (position <= pos + 1)) {
2565                                 insert_entry(q, prev, qe, &pos);
2566                                 /*pos is incremented inside insert_entry, so don't need to add 1 here*/
2567                                 if (position < pos) {
2568                                         ast_log(LOG_NOTICE, "Asked to be inserted at position %d but forced into position %d due to higher priority callers\n", position, pos);
2569                                 }
2570                                 inserted = 1;
2571                         }
2572                         cur->pos = ++pos;
2573                         prev = cur;
2574                         cur = cur->next;
2575                 }
2576                 /* No luck, join at the end of the queue */
2577                 if (!inserted)
2578                         insert_entry(q, prev, qe, &pos);
2579                 ast_copy_string(qe->moh, q->moh, sizeof(qe->moh));
2580                 ast_copy_string(qe->announce, q->announce, sizeof(qe->announce));
2581                 ast_copy_string(qe->context, q->context, sizeof(qe->context));
2582                 q->count++;
2583                 res = 0;
2584                 ast_manager_event(qe->chan, EVENT_FLAG_CALL, "Join",
2585                         "Channel: %s\r\n"
2586                         "CallerIDNum: %s\r\n"
2587                         "CallerIDName: %s\r\n"
2588                         "ConnectedLineNum: %s\r\n"
2589                         "ConnectedLineName: %s\r\n"
2590                         "Queue: %s\r\n"
2591                         "Position: %d\r\n"
2592                         "Count: %d\r\n"
2593                         "Uniqueid: %s\r\n",
2594                         qe->chan->name,
2595                         S_COR(qe->chan->caller.id.number.valid, qe->chan->caller.id.number.str, "unknown"),/* XXX somewhere else it is <unknown> */
2596                         S_COR(qe->chan->caller.id.name.valid, qe->chan->caller.id.name.str, "unknown"),
2597                         S_COR(qe->chan->connected.id.number.valid, qe->chan->connected.id.number.str, "unknown"),/* XXX somewhere else it is <unknown> */
2598                         S_COR(qe->chan->connected.id.name.valid, qe->chan->connected.id.name.str, "unknown"),
2599                         q->name, qe->pos, q->count, qe->chan->uniqueid );
2600                 ast_debug(1, "Queue '%s' Join, Channel '%s', Position '%d'\n", q->name, qe->chan->name, qe->pos );
2601         }
2602         ao2_unlock(q);
2603         queue_t_unref(q, "Done with realtime queue");
2604
2605         return res;
2606 }
2607
2608 static int play_file(struct ast_channel *chan, const char *filename)
2609 {
2610         int res;
2611
2612         if (ast_strlen_zero(filename)) {
2613                 return 0;
2614         }
2615
2616         if (!ast_fileexists(filename, NULL, chan->language)) {
2617                 return 0;
2618         }
2619
2620         ast_stopstream(chan);
2621
2622         res = ast_streamfile(chan, filename, chan->language);
2623         if (!res)
2624                 res = ast_waitstream(chan, AST_DIGIT_ANY);
2625
2626         ast_stopstream(chan);
2627
2628         return res;
2629 }
2630
2631 /*!
2632  * \brief Check for valid exit from queue via goto
2633  * \retval 0 if failure
2634  * \retval 1 if successful
2635 */
2636 static int valid_exit(struct queue_ent *qe, char digit)
2637 {
2638         int digitlen = strlen(qe->digits);
2639
2640         /* Prevent possible buffer overflow */
2641         if (digitlen < sizeof(qe->digits) - 2) {
2642                 qe->digits[digitlen] = digit;
2643                 qe->digits[digitlen + 1] = '\0';
2644         } else {
2645                 qe->digits[0] = '\0';
2646                 return 0;
2647         }
2648
2649         /* If there's no context to goto, short-circuit */
2650         if (ast_strlen_zero(qe->context))
2651                 return 0;
2652
2653         /* If the extension is bad, then reset the digits to blank */
2654         if (!ast_canmatch_extension(qe->chan, qe->context, qe->digits, 1,
2655                 S_COR(qe->chan->caller.id.number.valid, qe->chan->caller.id.number.str, NULL))) {
2656                 qe->digits[0] = '\0';
2657                 return 0;
2658         }
2659
2660         /* We have an exact match */
2661         if (!ast_goto_if_exists(qe->chan, qe->context, qe->digits, 1)) {
2662                 qe->valid_digits = 1;
2663                 /* Return 1 on a successful goto */
2664                 return 1;
2665         }
2666
2667         return 0;
2668 }
2669
2670 static int say_position(struct queue_ent *qe, int ringing)
2671 {
2672         int res = 0, avgholdmins, avgholdsecs, announceposition = 0;
2673         int say_thanks = 1;
2674         time_t now;
2675
2676         /* Let minannouncefrequency seconds pass between the start of each position announcement */
2677         time(&now);
2678         if ((now - qe->last_pos) < qe->parent->minannouncefrequency)
2679                 return 0;
2680
2681         /* If either our position has changed, or we are over the freq timer, say position */
2682         if ((qe->last_pos_said == qe->pos) && ((now - qe->last_pos) < qe->parent->announcefrequency))
2683                 return 0;
2684
2685         if (ringing) {
2686                 ast_indicate(qe->chan,-1);
2687         } else {
2688                 ast_moh_stop(qe->chan);
2689         }
2690
2691         if (qe->parent->announceposition == ANNOUNCEPOSITION_YES ||
2692                 qe->parent->announceposition == ANNOUNCEPOSITION_MORE_THAN ||
2693                 (qe->parent->announceposition == ANNOUNCEPOSITION_LIMIT &&
2694                 qe->pos <= qe->parent->announcepositionlimit))
2695                         announceposition = 1;
2696
2697
2698         if (announceposition == 1) {
2699                 /* Say we're next, if we are */
2700                 if (qe->pos == 1) {
2701                         res = play_file(qe->chan, qe->parent->sound_next);
2702                         if (res)
2703                                 goto playout;
2704                         else
2705                                 goto posout;
2706                 } else {
2707                         if (qe->parent->announceposition == ANNOUNCEPOSITION_MORE_THAN && qe->pos > qe->parent->announcepositionlimit){
2708                                 /* More than Case*/
2709                                 res = play_file(qe->chan, qe->parent->queue_quantity1);
2710                                 if (res)
2711                                         goto playout;
2712                                 res = ast_say_number(qe->chan, qe->parent->announcepositionlimit, AST_DIGIT_ANY, qe->chan->language, NULL); /* Needs gender */
2713                                 if (res)
2714                                         goto playout;
2715                         } else {
2716                                 /* Normal Case */
2717                                 res = play_file(qe->chan, qe->parent->sound_thereare);
2718                                 if (res)
2719                                         goto playout;
2720                                 res = ast_say_number(qe->chan, qe->pos, AST_DIGIT_ANY, qe->chan->language, NULL); /* Needs gender */
2721                                 if (res)
2722                                         goto playout;
2723                         }
2724                         if (qe->parent->announceposition == ANNOUNCEPOSITION_MORE_THAN && qe->pos > qe->parent->announcepositionlimit){
2725                                 /* More than Case*/
2726                                 res = play_file(qe->chan, qe->parent->queue_quantity2);
2727                                 if (res)
2728                                         goto playout;
2729                         } else {
2730                                 res = play_file(qe->chan, qe->parent->sound_calls);
2731                                 if (res)
2732                                         goto playout;
2733                         }
2734                 }
2735         }
2736         /* Round hold time to nearest minute */
2737         avgholdmins = abs(((qe->parent->holdtime + 30) - (now - qe->start)) / 60);
2738
2739         /* If they have specified a rounding then round the seconds as well */
2740         if (qe->parent->roundingseconds) {
2741                 avgholdsecs = (abs(((qe->parent->holdtime + 30) - (now - qe->start))) - 60 * avgholdmins) / qe->parent->roundingseconds;
2742                 avgholdsecs *= qe->parent->roundingseconds;
2743         } else {
2744                 avgholdsecs = 0;
2745         }
2746
2747         ast_verb(3, "Hold time for %s is %d minute(s) %d seconds\n", qe->parent->name, avgholdmins, avgholdsecs);
2748
2749         /* If the hold time is >1 min, if it's enabled, and if it's not
2750            supposed to be only once and we have already said it, say it */
2751     if ((avgholdmins+avgholdsecs) > 0 && qe->parent->announceholdtime &&
2752         ((qe->parent->announceholdtime == ANNOUNCEHOLDTIME_ONCE && !qe->last_pos) ||
2753         !(qe->parent->announceholdtime == ANNOUNCEHOLDTIME_ONCE))) {
2754                 res = play_file(qe->chan, qe->parent->sound_holdtime);
2755                 if (res)
2756                         goto playout;
2757
2758                 if (avgholdmins >= 1) {
2759                         res = ast_say_number(qe->chan, avgholdmins, AST_DIGIT_ANY, qe->chan->language, NULL);
2760                         if (res)
2761                                 goto playout;
2762
2763                         if (avgholdmins == 1) {
2764                                 res = play_file(qe->chan, qe->parent->sound_minute);
2765                                 if (res)
2766                                         goto playout;
2767                         } else {
2768                                 res = play_file(qe->chan, qe->parent->sound_minutes);
2769                                 if (res)
2770                                         goto playout;
2771                         }
2772                 }
2773                 if (avgholdsecs >= 1) {
2774                         res = ast_say_number(qe->chan, avgholdsecs, AST_DIGIT_ANY, qe->chan->language, NULL);
2775                         if (res)
2776                                 goto playout;
2777
2778                         res = play_file(qe->chan, qe->parent->sound_seconds);
2779                         if (res)
2780                                 goto playout;
2781                 }
2782         } else if (qe->parent->announceholdtime && !qe->parent->announceposition) {
2783                 say_thanks = 0;
2784         }
2785
2786 posout:
2787         if (qe->parent->announceposition) {
2788                 ast_verb(3, "Told %s in %s their queue position (which was %d)\n",
2789                         qe->chan->name, qe->parent->name, qe->pos);
2790         }
2791         if (say_thanks) {
2792                 res = play_file(qe->chan, qe->parent->sound_thanks);
2793         }
2794 playout:
2795
2796         if ((res > 0 && !valid_exit(qe, res)))
2797                 res = 0;
2798
2799         /* Set our last_pos indicators */
2800         qe->last_pos = now;
2801         qe->last_pos_said = qe->pos;
2802
2803         /* Don't restart music on hold if we're about to exit the caller from the queue */
2804         if (!res) {
2805                 if (ringing) {
2806                         ast_indicate(qe->chan, AST_CONTROL_RINGING);
2807                 } else {
2808                         ast_moh_start(qe->chan, qe->moh, NULL);
2809                 }
2810         }
2811         return res;
2812 }
2813
2814 static void recalc_holdtime(struct queue_ent *qe, int newholdtime)
2815 {
2816         int oldvalue;
2817
2818         /* Calculate holdtime using an exponential average */
2819         /* Thanks to SRT for this contribution */
2820         /* 2^2 (4) is the filter coefficient; a higher exponent would give old entries more weight */
2821
2822         ao2_lock(qe->parent);
2823         oldvalue = qe->parent->holdtime;
2824         qe->parent->holdtime = (((oldvalue << 2) - oldvalue) + newholdtime) >> 2;
2825         ao2_unlock(qe->parent);
2826 }
2827
2828 /*! \brief Caller leaving queue.
2829  * 
2830  * Search the queue to find the leaving client, if found remove from queue
2831  * create manager event, move others up the queue.
2832 */
2833 static void leave_queue(struct queue_ent *qe)
2834 {
2835         struct call_queue *q;
2836         struct queue_ent *current, *prev = NULL;
2837         struct penalty_rule *pr_iter;
2838         int pos = 0;
2839
2840         if (!(q = qe->parent)) {
2841                 return;
2842         }
2843         queue_t_ref(q, "Copy queue pointer from queue entry");
2844         ao2_lock(q);
2845
2846         prev = NULL;
2847         for (current = q->head; current; current = current->next) {
2848                 if (current == qe) {
2849                         char posstr[20];
2850                         q->count--;
2851
2852                         /* Take us out of the queue */
2853                         ast_manager_event(qe->chan, EVENT_FLAG_CALL, "Leave",
2854                                 "Channel: %s\r\nQueue: %s\r\nCount: %d\r\nPosition: %d\r\nUniqueid: %s\r\n",
2855                                 qe->chan->name, q->name,  q->count, qe->pos, qe->chan->uniqueid);
2856                         ast_debug(1, "Queue '%s' Leave, Channel '%s'\n", q->name, qe->chan->name );
2857                         /* Take us out of the queue */
2858                         if (prev)
2859                                 prev->next = current->next;
2860                         else
2861                                 q->head = current->next;
2862                         /* Free penalty rules */
2863                         while ((pr_iter = AST_LIST_REMOVE_HEAD(&qe->qe_rules, list)))
2864                                 ast_free(pr_iter);
2865                         snprintf(posstr, sizeof(posstr), "%d", qe->pos);
2866                         pbx_builtin_setvar_helper(qe->chan, "QUEUEPOSITION", posstr);
2867                 } else {
2868                         /* Renumber the people after us in the queue based on a new count */
2869                         current->pos = ++pos;
2870                         prev = current;
2871                 }
2872         }
2873         ao2_unlock(q);
2874
2875         /*If the queue is a realtime queue, check to see if it's still defined in real time*/
2876         if (q->realtime) {
2877                 struct ast_variable *var;
2878                 if (!(var = ast_load_realtime("queues", "name", q->name, SENTINEL))) {
2879                         q->dead = 1;
2880                 } else {
2881                         ast_variables_destroy(var);
2882                 }
2883         }
2884
2885         if (q->dead) {
2886                 /* It's dead and nobody is in it, so kill it */
2887                 queues_t_unlink(queues, q, "Queue is now dead; remove it from the container");
2888         }
2889         /* unref the explicit ref earlier in the function */
2890         queue_t_unref(q, "Expire copied reference");
2891 }
2892
2893 /*!
2894  * \internal
2895  * \brief Destroy the given callattempt structure and free it.
2896  * \since 1.8
2897  *
2898  * \param doomed callattempt structure to destroy.
2899  *
2900  * \return Nothing
2901  */
2902 static void callattempt_free(struct callattempt *doomed)
2903 {
2904         if (doomed->member) {
2905                 ao2_ref(doomed->member, -1);
2906         }
2907         ast_party_connected_line_free(&doomed->connected);
2908         ast_free(doomed);
2909 }
2910
2911 /*! \brief Hang up a list of outgoing calls */
2912 static void hangupcalls(struct callattempt *outgoing, struct ast_channel *exception, int cancel_answered_elsewhere)
2913 {
2914         struct callattempt *oo;
2915
2916         while (outgoing) {
2917                 /* If someone else answered the call we should indicate this in the CANCEL */
2918                 /* Hangup any existing lines we have open */
2919                 if (outgoing->chan && (outgoing->chan != exception)) {
2920                         if (exception || cancel_answered_elsewhere)
2921                                 ast_set_flag(outgoing->chan, AST_FLAG_ANSWERED_ELSEWHERE);
2922                         ast_hangup(outgoing->chan);
2923                 }
2924                 oo = outgoing;
2925                 outgoing = outgoing->q_next;
2926                 ast_aoc_destroy_decoded(oo->aoc_s_rate_list);
2927                 callattempt_free(oo);
2928         }
2929 }
2930
2931 /*!
2932  * \brief Get the number of members available to accept a call.
2933  *
2934  * \note The queue passed in should be locked prior to this function call
2935  *
2936  * \param[in] q The queue for which we are couting the number of available members
2937  * \return Return the number of available members in queue q
2938  */
2939 static int num_available_members(struct call_queue *q)
2940 {
2941         struct member *mem;
2942         int avl = 0;
2943         struct ao2_iterator mem_iter;
2944
2945         mem_iter = ao2_iterator_init(q->members, 0);
2946         while ((mem = ao2_iterator_next(&mem_iter))) {
2947                 switch (mem->status) {
2948                         case AST_DEVICE_INVALID:
2949                         case AST_DEVICE_UNAVAILABLE:
2950                                 break;
2951                         case AST_DEVICE_INUSE:
2952                         case AST_DEVICE_BUSY:
2953                         case AST_DEVICE_RINGING:
2954                         case AST_DEVICE_RINGINUSE:
2955                         case AST_DEVICE_ONHOLD:
2956                                 if ((!q->ringinuse) || (!mem->ignorebusy)) {
2957                                         break;
2958                                 }
2959                                 /* else fall through */
2960                         case AST_DEVICE_NOT_INUSE:
2961                         case AST_DEVICE_UNKNOWN:
2962                                 if (!mem->paused) {
2963                                         avl++;
2964                                 }
2965                                 break;
2966                 }
2967                 ao2_ref(mem, -1);
2968
2969                 /* If autofill is not enabled or if the queue's strategy is ringall, then
2970                  * we really don't care about the number of available members so much as we
2971                  * do that there is at least one available.
2972                  *
2973                  * In fact, we purposely will return from this function stating that only
2974                  * one member is available if either of those conditions hold. That way,
2975                  * functions which determine what action to take based on the number of available
2976                  * members will operate properly. The reasoning is that even if multiple
2977                  * members are available, only the head caller can actually be serviced.
2978                  */
2979                 if ((!q->autofill || q->strategy == QUEUE_STRATEGY_RINGALL) && avl) {
2980                         break;
2981                 }
2982         }
2983         ao2_iterator_destroy(&mem_iter);
2984
2985         return avl;
2986 }
2987
2988 /* traverse all defined queues which have calls waiting and contain this member
2989    return 0 if no other queue has precedence (higher weight) or 1 if found  */
2990 static int compare_weight(struct call_queue *rq, struct member *member)
2991 {
2992         struct call_queue *q;
2993         struct member *mem;
2994         int found = 0;
2995         struct ao2_iterator queue_iter;
2996
2997         queue_iter = ao2_iterator_init(queues, 0);
2998         while ((q = ao2_t_iterator_next(&queue_iter, "Iterate through queues"))) {
2999                 if (q == rq) { /* don't check myself, could deadlock */
3000                         queue_t_unref(q, "Done with iterator");
3001                         continue;
3002                 }
3003                 ao2_lock(q);
3004                 if (q->count && q->members) {
3005                         if ((mem = ao2_find(q->members, member, OBJ_POINTER))) {
3006                                 ast_debug(1, "Found matching member %s in queue '%s'\n", mem->interface, q->name);
3007                                 if (q->weight > rq->weight && q->count >= num_available_members(q)) {
3008                                         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);
3009                                         found = 1;
3010                                 }
3011                                 ao2_ref(mem, -1);
3012                         }
3013                 }
3014                 ao2_unlock(q);
3015                 queue_t_unref(q, "Done with iterator");
3016                 if (found) {
3017                         break;
3018                 }
3019         }
3020         ao2_iterator_destroy(&queue_iter);
3021         return found;
3022 }
3023
3024 /*! \brief common hangup actions */
3025 static void do_hang(struct callattempt *o)
3026 {
3027         o->stillgoing = 0;
3028         ast_hangup(o->chan);
3029         o->chan = NULL;
3030 }
3031
3032 /*! \brief convert "\n" to "\nVariable: " ready for manager to use */
3033 static char *vars2manager(struct ast_channel *chan, char *vars, size_t len)
3034 {
3035         struct ast_str *buf = ast_str_thread_get(&ast_str_thread_global_buf, len + 1);
3036         const char *tmp;
3037
3038         if (pbx_builtin_serialize_variables(chan, &buf)) {
3039                 int i, j;
3040
3041                 /* convert "\n" to "\nVariable: " */
3042                 strcpy(vars, "Variable: ");
3043                 tmp = ast_str_buffer(buf);
3044
3045                 for (i = 0, j = 10; (i < len - 1) && (j < len - 1); i++, j++) {
3046                         vars[j] = tmp[i];
3047
3048                         if (tmp[i + 1] == '\0')
3049                                 break;
3050                         if (tmp[i] == '\n') {
3051                                 vars[j++] = '\r';
3052                                 vars[j++] = '\n';
3053
3054                                 ast_copy_string(&(vars[j]), "Variable: ", len - j);
3055                                 j += 9;
3056                         }
3057                 }
3058                 if (j > len - 3)
3059                         j = len - 3;
3060                 vars[j++] = '\r';
3061                 vars[j++] = '\n';
3062                 vars[j] = '\0';
3063         } else {
3064                 /* there are no channel variables; leave it blank */
3065                 *vars = '\0';
3066         }
3067         return vars;
3068 }
3069
3070 /*! 
3071  * \brief Part 2 of ring_one
3072  *
3073  * Does error checking before attempting to request a channel and call a member. 
3074  * This function is only called from ring_one(). 
3075  * Failure can occur if:
3076  * - Agent on call
3077  * - Agent is paused
3078  * - Wrapup time not expired
3079  * - Priority by another queue
3080  *
3081  * \retval 1 on success to reach a free agent
3082  * \retval 0 on failure to get agent.
3083  */
3084 static int ring_entry(struct queue_ent *qe, struct callattempt *tmp, int *busies)
3085 {
3086         int res;
3087         int status;
3088         char tech[256];
3089         char *location;
3090         const char *macrocontext, *macroexten;
3091         enum ast_device_state newstate;
3092
3093         /* on entry here, we know that tmp->chan == NULL */
3094         if (tmp->member->paused) {
3095                 ast_debug(1, "%s paused, can't receive call\n", tmp->interface);
3096                 if (qe->chan->cdr) {
3097                         ast_cdr_busy(qe->chan->cdr);
3098                 }
3099                 tmp->stillgoing = 0;
3100                 return 0;
3101         }
3102
3103         if ((tmp->lastqueue && tmp->lastqueue->wrapuptime && (time(NULL) - tmp->lastcall < tmp->lastqueue->wrapuptime)) ||
3104                 (!tmp->lastqueue && qe->parent->wrapuptime && (time(NULL) - tmp->lastcall < qe->parent->wrapuptime))) {
3105                 ast_debug(1, "Wrapuptime not yet expired on queue %s for %s\n",
3106                                 (tmp->lastqueue ? tmp->lastqueue->name : qe->parent->name), tmp->interface);
3107                 if (qe->chan->cdr) {
3108                         ast_cdr_busy(qe->chan->cdr);
3109                 }
3110                 tmp->stillgoing = 0;
3111                 (*busies)++;
3112                 return 0;
3113         }
3114
3115         if (!qe->parent->ringinuse || !tmp->member->ignorebusy) {
3116                 if (check_state_unknown && (tmp->member->status == AST_DEVICE_UNKNOWN)) {
3117                         newstate = ast_device_state(tmp->member->interface);
3118                         if (newstate != tmp->member->status) {
3119                                 ast_log(LOG_WARNING, "Found a channel matching iterface %s while status was %s changed to %s\n",
3120                                         tmp->member->interface, ast_devstate2str(tmp->member->status), ast_devstate2str(newstate));
3121                                 ast_devstate_changed_literal(newstate, tmp->member->interface);
3122                         }
3123                 }
3124                 if ((tmp->member->status != AST_DEVICE_NOT_INUSE) && (tmp->member->status != AST_DEVICE_UNKNOWN)) {
3125                         ast_debug(1, "%s in use, can't receive call\n", tmp->interface);
3126                         if (qe->chan->cdr) {
3127                                 ast_cdr_busy(qe->chan->cdr);
3128                         }
3129                         tmp->stillgoing = 0;
3130                         return 0;
3131                 }
3132         }
3133
3134         if (use_weight && compare_weight(qe->parent,tmp->member)) {
3135                 ast_debug(1, "Priority queue delaying call to %s:%s\n", qe->parent->name, tmp->interface);
3136                 if (qe->chan->cdr) {
3137                         ast_cdr_busy(qe->chan->cdr);
3138                 }
3139                 tmp->stillgoing = 0;
3140                 (*busies)++;
3141                 return 0;
3142         }
3143
3144         ast_copy_string(tech, tmp->interface, sizeof(tech));
3145         if ((location = strchr(tech, '/')))
3146                 *location++ = '\0';
3147         else
3148                 location = "";
3149
3150         /* Request the peer */
3151         tmp->chan = ast_request(tech, qe->chan->nativeformats, qe->chan, location, &status);
3152         if (!tmp->chan) {                       /* If we can't, just go on to the next call */
3153                 if (qe->chan->cdr) {
3154                         ast_cdr_busy(qe->chan->cdr);
3155                 }
3156                 tmp->stillgoing = 0;
3157
3158                 ao2_lock(qe->parent);
3159                 update_status(qe->parent, tmp->member, get_queue_member_status(tmp->member));
3160                 qe->parent->rrpos++;
3161                 qe->linpos++;
3162                 ao2_unlock(qe->parent);
3163
3164                 (*busies)++;
3165                 return 0;
3166         }
3167
3168         ast_channel_lock(tmp->chan);
3169         while (ast_channel_trylock(qe->chan)) {
3170                 CHANNEL_DEADLOCK_AVOIDANCE(tmp->chan);
3171         }
3172
3173         if (qe->cancel_answered_elsewhere) {
3174                 ast_set_flag(tmp->chan, AST_FLAG_ANSWERED_ELSEWHERE);
3175         }
3176         tmp->chan->appl = "AppQueue";
3177         tmp->chan->data = "(Outgoing Line)";
3178         memset(&tmp->chan->whentohangup, 0, sizeof(tmp->chan->whentohangup));
3179
3180         /* If the new channel has no callerid, try to guess what it should be */
3181         if (!tmp->chan->caller.id.number.valid) {
3182                 if (qe->chan->connected.id.number.valid) {
3183                         struct ast_party_caller caller;
3184
3185                         ast_party_caller_set_init(&caller, &tmp->chan->caller);
3186                         caller.id = qe->chan->connected.id;
3187                         caller.ani = qe->chan->connected.ani;
3188                         ast_channel_set_caller_event(tmp->chan, &caller, NULL);
3189                 } else if (!ast_strlen_zero(qe->chan->dialed.number.str)) {
3190                         ast_set_callerid(tmp->chan, qe->chan->dialed.number.str, NULL, NULL);
3191                 } else if (!ast_strlen_zero(S_OR(qe->chan->macroexten, qe->chan->exten))) {
3192                         ast_set_callerid(tmp->chan, S_OR(qe->chan->macroexten, qe->chan->exten), NULL, NULL); 
3193                 }
3194                 tmp->dial_callerid_absent = 1;
3195         }
3196
3197         ast_party_redirecting_copy(&tmp->chan->redirecting, &qe->chan->redirecting);
3198
3199         tmp->chan->dialed.transit_network_select = qe->chan->dialed.transit_network_select;
3200
3201         ast_connected_line_copy_from_caller(&tmp->chan->connected, &qe->chan->caller);
3202
3203         /* Inherit specially named variables from parent channel */
3204         ast_channel_inherit_variables(qe->chan, tmp->chan);
3205         ast_channel_datastore_inherit(qe->chan, tmp->chan);
3206
3207         /* Presense of ADSI CPE on outgoing channel follows ours */
3208         tmp->chan->adsicpe = qe->chan->adsicpe;
3209
3210         /* Inherit context and extension */
3211         macrocontext = pbx_builtin_getvar_helper(qe->chan, "MACRO_CONTEXT");
3212         ast_string_field_set(tmp->chan, dialcontext, ast_strlen_zero(macrocontext) ? qe->chan->context : macrocontext);
3213         macroexten = pbx_builtin_getvar_helper(qe->chan, "MACRO_EXTEN");
3214         if (!ast_strlen_zero(macroexten))
3215                 ast_copy_string(tmp->chan->exten, macroexten, sizeof(tmp->chan->exten));
3216         else
3217                 ast_copy_string(tmp->chan->exten, qe->chan->exten, sizeof(tmp->chan->exten));
3218         if (ast_cdr_isset_unanswered()) {
3219                 /* they want to see the unanswered dial attempts! */
3220                 /* set up the CDR fields on all the CDRs to give sensical information */
3221                 ast_cdr_setdestchan(tmp->chan->cdr, tmp->chan->name);
3222                 strcpy(tmp->chan->cdr->clid, qe->chan->cdr->clid);
3223                 strcpy(tmp->chan->cdr->channel, qe->chan->cdr->channel);
3224                 strcpy(tmp->chan->cdr->src, qe->chan->cdr->src);
3225                 strcpy(tmp->chan->cdr->dst, qe->chan->exten);
3226                 strcpy(tmp->chan->cdr->dcontext, qe->chan->context);
3227                 strcpy(tmp->chan->cdr->lastapp, qe->chan->cdr->lastapp);
3228                 strcpy(tmp->chan->cdr->lastdata, qe->chan->cdr->lastdata);
3229                 tmp->chan->cdr->amaflags = qe->chan->cdr->amaflags;
3230                 strcpy(tmp->chan->cdr->accountcode, qe->chan->cdr->accountcode);
3231                 strcpy(tmp->chan->cdr->userfield, qe->chan->cdr->userfield);
3232         }
3233
3234         /* Place the call, but don't wait on the answer */
3235         if ((res = ast_call(tmp->chan, location, 0))) {
3236                 /* Again, keep going even if there's an error */
3237                 ast_debug(1, "ast call on peer returned %d\n", res);
3238                 ast_verb(3, "Couldn't call %s\n", tmp->interface);
3239                 ast_channel_unlock(tmp->chan);
3240                 ast_channel_unlock(qe->chan);
3241                 do_hang(tmp);
3242                 (*busies)++;
3243                 update_status(qe->parent, tmp->member, get_queue_member_status(tmp->member));
3244                 return 0;
3245         } else if (qe->parent->eventwhencalled) {
3246                 char vars[2048];
3247
3248                 manager_event(EVENT_FLAG_AGENT, "AgentCalled",
3249                         "Queue: %s\r\n"
3250                         "AgentCalled: %s\r\n"
3251                         "AgentName: %s\r\n"
3252                         "ChannelCalling: %s\r\n"
3253                         "DestinationChannel: %s\r\n"
3254                         "CallerIDNum: %s\r\n"
3255                         "CallerIDName: %s\r\n"
3256                         "ConnectedLineNum: %s\r\n"
3257                         "ConnectedLineName: %s\r\n"
3258                         "Context: %s\r\n"
3259                         "Extension: %s\r\n"
3260                         "Priority: %d\r\n"
3261                         "Uniqueid: %s\r\n"
3262                         "%s",
3263                         qe->parent->name, tmp->interface, tmp->member->membername, qe->chan->name, tmp->chan->name,
3264                         S_COR(tmp->chan->caller.id.number.valid, tmp->chan->caller.id.number.str, "unknown"),
3265                         S_COR(tmp->chan->caller.id.name.valid, tmp->chan->caller.id.name.str, "unknown"),
3266                         S_COR(tmp->chan->connected.id.number.valid, tmp->chan->connected.id.number.str, "unknown"),
3267                         S_COR(tmp->chan->connected.id.name.valid, tmp->chan->connected.id.name.str, "unknown"),
3268                         qe->chan->context, qe->chan->exten, qe->chan->priority, qe->chan->uniqueid,
3269                         qe->parent->eventwhencalled == QUEUE_EVENT_VARIABLES ? vars2manager(qe->chan, vars, sizeof(vars)) : "");
3270                 ast_verb(3, "Called %s\n", tmp->interface);
3271         }
3272         ast_channel_unlock(tmp->chan);
3273         ast_channel_unlock(qe->chan);
3274
3275         update_status(qe->parent, tmp->member, get_queue_member_status(tmp->member));
3276         return 1;
3277 }
3278
3279 /*! \brief find the entry with the best metric, or NULL */
3280 static struct callattempt *find_best(struct callattempt *outgoing)
3281 {
3282         struct callattempt *best = NULL, *cur;
3283
3284         for (cur = outgoing; cur; cur = cur->q_next) {
3285                 if (cur->stillgoing &&                                  /* Not already done */
3286                         !cur->chan &&                                   /* Isn't already going */
3287                         (!best || cur->metric < best->metric)) {                /* We haven't found one yet, or it's better */
3288                         best = cur;
3289                 }
3290         }
3291
3292         return best;
3293 }
3294
3295 /*! 
3296  * \brief Place a call to a queue member.
3297  *
3298  * Once metrics have been calculated for each member, this function is used
3299  * to place a call to the appropriate member (or members). The low-level
3300  * channel-handling and error detection is handled in ring_entry
3301  *
3302  * \retval 1 if a member was called successfully
3303  * \retval 0 otherwise
3304  */
3305 static int ring_one(struct queue_ent *qe, struct callattempt *outgoing, int *busies)
3306 {
3307         int ret = 0;
3308
3309         while (ret == 0) {
3310                 struct callattempt *best = find_best(outgoing);
3311                 if (!best) {
3312                         ast_debug(1, "Nobody left to try ringing in queue\n");
3313                         break;
3314                 }
3315                 if (qe->parent->strategy == QUEUE_STRATEGY_RINGALL) {
3316                         struct callattempt *cur;
3317                         /* Ring everyone who shares this best metric (for ringall) */