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