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