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