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