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