/* * Asterisk -- An open source telephony toolkit. * * Copyright (C) 1999 - 2006, Digium, Inc. * * Mark Spencer * * See http://www.asterisk.org for more information about * the Asterisk project. Please do not directly contact * any of the maintainers of this project for assistance; * the project provides a web site, mailing lists and IRC * channels for your use. * * This program is free software, distributed under the terms of * the GNU General Public License Version 2. See the LICENSE file * at the top of the source tree. */ /*! \file * * \brief True call queues with optional send URL on answer * * \author Mark Spencer * * \arg Config in \ref Config_qu queues.conf * * \par Development notes * \note 2004-11-25: Persistent Dynamic Members added by: * NetNation Communications (www.netnation.com) * Kevin Lindsay * * Each dynamic agent in each queue is now stored in the astdb. * When asterisk is restarted, each agent will be automatically * readded into their recorded queues. This feature can be * configured with the 'persistent_members=<1|0>' setting in the * '[general]' category in queues.conf. The default is on. * * \note 2004-06-04: Priorities in queues added by inAccess Networks (work funded by Hellas On Line (HOL) www.hol.gr). * * \note These features added by David C. Troy : * - Per-queue holdtime calculation * - Estimated holdtime announcement * - Position announcement * - Abandoned/completed call counters * - Failout timer passed as optional app parameter * - Optional monitoring of calls, started when call is answered * * Patch Version 1.07 2003-12-24 01 * * Added servicelevel statistic by Michiel Betel * Added Priority jumping code for adding and removing queue members by Jonathan Stanton * * Fixed to work with CVS as of 2004-02-25 and released as 1.07a * by Matthew Enger * * \ingroup applications */ #include "asterisk.h" ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include #include #include #include #include "asterisk/lock.h" #include "asterisk/file.h" #include "asterisk/logger.h" #include "asterisk/channel.h" #include "asterisk/pbx.h" #include "asterisk/options.h" #include "asterisk/app.h" #include "asterisk/linkedlists.h" #include "asterisk/module.h" #include "asterisk/translate.h" #include "asterisk/say.h" #include "asterisk/features.h" #include "asterisk/musiconhold.h" #include "asterisk/cli.h" #include "asterisk/manager.h" #include "asterisk/config.h" #include "asterisk/monitor.h" #include "asterisk/utils.h" #include "asterisk/causes.h" #include "asterisk/astdb.h" #include "asterisk/devicestate.h" #include "asterisk/stringfields.h" #include "asterisk/event.h" #include "asterisk/astobj2.h" #include "asterisk/strings.h" enum { QUEUE_STRATEGY_RINGALL = 0, QUEUE_STRATEGY_LEASTRECENT, QUEUE_STRATEGY_FEWESTCALLS, QUEUE_STRATEGY_RANDOM, QUEUE_STRATEGY_RRMEMORY, QUEUE_STRATEGY_LINEAR, QUEUE_STRATEGY_WRANDOM }; static struct strategy { int strategy; char *name; } strategies[] = { { QUEUE_STRATEGY_RINGALL, "ringall" }, { QUEUE_STRATEGY_LEASTRECENT, "leastrecent" }, { QUEUE_STRATEGY_FEWESTCALLS, "fewestcalls" }, { QUEUE_STRATEGY_RANDOM, "random" }, { QUEUE_STRATEGY_RRMEMORY, "rrmemory" }, { QUEUE_STRATEGY_LINEAR, "linear" }, { QUEUE_STRATEGY_WRANDOM, "wrandom"}, }; #define DEFAULT_RETRY 5 #define DEFAULT_TIMEOUT 15 #define RECHECK 1 /* Recheck every second to see we we're at the top yet */ #define MAX_PERIODIC_ANNOUNCEMENTS 10 /* The maximum periodic announcements we can have */ #define DEFAULT_MIN_ANNOUNCE_FREQUENCY 15 /* The minimum number of seconds between position announcements The default value of 15 provides backwards compatibility */ #define MAX_QUEUE_BUCKETS 53 #define RES_OKAY 0 /* Action completed */ #define RES_EXISTS (-1) /* Entry already exists */ #define RES_OUTOFMEMORY (-2) /* Out of memory */ #define RES_NOSUCHQUEUE (-3) /* No such queue */ #define RES_NOT_DYNAMIC (-4) /* Member is not dynamic */ static char *app = "Queue"; static char *synopsis = "Queue a call for a call queue"; static char *descrip = " Queue(queuename[,options[,URL][,announceoverride][,timeout][,AGI][,macro][,gosub]):\n" "Queues an incoming call in a particular call queue as defined in queues.conf.\n" "This application will return to the dialplan if the queue does not exist, or\n" "any of the join options cause the caller to not enter the queue.\n" "The option string may contain zero or more of the following characters:\n" " 'c' -- continue in the dialplan if the callee hangs up.\n" " 'd' -- data-quality (modem) call (minimum delay).\n" " 'h' -- allow callee to hang up by pressing *.\n" " 'H' -- allow caller to hang up by pressing *.\n" " 'n' -- no retries on the timeout; will exit this application and \n" " go to the next step.\n" " 'i' -- ignore call forward requests from queue members and do nothing\n" " when they are requested.\n" " 'r' -- ring instead of playing MOH. Periodic Announcements are still made, if applicable.\n" " 't' -- allow the called user to transfer the calling user.\n" " 'T' -- allow the calling user to transfer the call.\n" " 'w' -- allow the called user to write the conversation to disk via Monitor.\n" " 'W' -- allow the calling user to write the conversation to disk via Monitor.\n" " 'k' -- Allow the called party to enable parking of the call by sending\n" " the DTMF sequence defined for call parking in features.conf.\n" " 'K' -- Allow the calling party to enable parking of the call by sending\n" " the DTMF sequence defined for call parking in features.conf.\n" " In addition to transferring the call, a call may be parked and then picked\n" "up by another user.\n" " The optional URL will be sent to the called party if the channel supports\n" "it.\n" " The optional AGI parameter will setup an AGI script to be executed on the \n" "calling party's channel once they are connected to a queue member.\n" " The optional macro parameter will run a macro on the \n" "calling party's channel once they are connected to a queue member.\n" " The optional gosub parameter will run a gosub on the \n" "calling party's channel once they are connected to a queue member.\n" " The timeout will cause the queue to fail out after a specified number of\n" "seconds, checked between each queues.conf 'timeout' and 'retry' cycle.\n" " This application sets the following channel variable upon completion:\n" " QUEUESTATUS The status of the call as a text string, one of\n" " TIMEOUT | FULL | JOINEMPTY | LEAVEEMPTY | JOINUNAVAIL | LEAVEUNAVAIL | CONTINUE\n"; static char *app_aqm = "AddQueueMember" ; static char *app_aqm_synopsis = "Dynamically adds queue members" ; static char *app_aqm_descrip = " AddQueueMember(queuename[,interface[,penalty[,options[,membername]]]]):\n" "Dynamically adds interface to an existing queue.\n" "If the interface is already in the queue it will return an error.\n" " This application sets the following channel variable upon completion:\n" " AQMSTATUS The status of the attempt to add a queue member as a \n" " text string, one of\n" " ADDED | MEMBERALREADY | NOSUCHQUEUE \n" "Example: AddQueueMember(techsupport,SIP/3000)\n" ""; static char *app_rqm = "RemoveQueueMember" ; static char *app_rqm_synopsis = "Dynamically removes queue members" ; static char *app_rqm_descrip = " RemoveQueueMember(queuename[,interface[,options]]):\n" "Dynamically removes interface to an existing queue\n" "If the interface is NOT in the queue it will return an error.\n" " This application sets the following channel variable upon completion:\n" " RQMSTATUS The status of the attempt to remove a queue member as a\n" " text string, one of\n" " REMOVED | NOTINQUEUE | NOSUCHQUEUE \n" "Example: RemoveQueueMember(techsupport,SIP/3000)\n" ""; static char *app_pqm = "PauseQueueMember" ; static char *app_pqm_synopsis = "Pauses a queue member" ; static char *app_pqm_descrip = " PauseQueueMember([queuename],interface[,options[,reason]]):\n" "Pauses (blocks calls for) a queue member.\n" "The given interface will be paused in the given queue. This prevents\n" "any calls from being sent from the queue to the interface until it is\n" "unpaused with UnpauseQueueMember or the manager interface. If no\n" "queuename is given, the interface is paused in every queue it is a\n" "member of. The application will fail if the interface is not found.\n" "The reason string is entirely optional and is used to add extra information\n" "to the appropriate queue_log entries and manager events.\n" " This application sets the following channel variable upon completion:\n" " PQMSTATUS The status of the attempt to pause a queue member as a\n" " text string, one of\n" " PAUSED | NOTFOUND\n" "Example: PauseQueueMember(,SIP/3000)\n"; static char *app_upqm = "UnpauseQueueMember" ; static char *app_upqm_synopsis = "Unpauses a queue member" ; static char *app_upqm_descrip = " UnpauseQueueMember([queuename],interface[,options[,reason]]):\n" "Unpauses (resumes calls to) a queue member.\n" "This is the counterpart to PauseQueueMember and operates exactly the\n" "same way, except it unpauses instead of pausing the given interface.\n" "The reason string is entirely optional and is used to add extra information\n" "to the appropriate queue_log entries and manager events.\n" " This application sets the following channel variable upon completion:\n" " UPQMSTATUS The status of the attempt to unpause a queue \n" " member as a text string, one of\n" " UNPAUSED | NOTFOUND\n" "Example: UnpauseQueueMember(,SIP/3000)\n"; static char *app_ql = "QueueLog" ; static char *app_ql_synopsis = "Writes to the queue_log" ; static char *app_ql_descrip = " QueueLog(queuename,uniqueid,agent,event[,additionalinfo]):\n" "Allows you to write your own events into the queue log\n" "Example: QueueLog(101,${UNIQUEID},${AGENT},WENTONBREAK,600)\n"; /*! \brief Persistent Members astdb family */ static const char *pm_family = "Queue/PersistentMembers"; /* The maximum length of each persistent member queue database entry */ #define PM_MAX_LEN 8192 /*! \brief queues.conf [general] option */ static int queue_keep_stats = 0; /*! \brief queues.conf [general] option */ static int queue_persistent_members = 0; /*! \brief queues.conf per-queue weight option */ static int use_weight = 0; /*! \brief queues.conf [general] option */ static int autofill_default = 0; /*! \brief queues.conf [general] option */ static int montype_default = 0; /*! \brief queues.conf [general] option */ static int shared_lastcall = 0; /*! \brief Subscription to device state change events */ static struct ast_event_sub *device_state_sub; /*! \brief queues.conf [general] option */ static int update_cdr = 0; enum queue_result { QUEUE_UNKNOWN = 0, QUEUE_TIMEOUT = 1, QUEUE_JOINEMPTY = 2, QUEUE_LEAVEEMPTY = 3, QUEUE_JOINUNAVAIL = 4, QUEUE_LEAVEUNAVAIL = 5, QUEUE_FULL = 6, QUEUE_CONTINUE = 7, }; const struct { enum queue_result id; char *text; } queue_results[] = { { QUEUE_UNKNOWN, "UNKNOWN" }, { QUEUE_TIMEOUT, "TIMEOUT" }, { QUEUE_JOINEMPTY,"JOINEMPTY" }, { QUEUE_LEAVEEMPTY, "LEAVEEMPTY" }, { QUEUE_JOINUNAVAIL, "JOINUNAVAIL" }, { QUEUE_LEAVEUNAVAIL, "LEAVEUNAVAIL" }, { QUEUE_FULL, "FULL" }, { QUEUE_CONTINUE, "CONTINUE" }, }; /*! \brief We define a custom "local user" structure because we use it not only for keeping track of what is in use but also for keeping track of who we're dialing. */ struct callattempt { struct callattempt *q_next; struct ast_channel *chan; char interface[256]; int stillgoing; int metric; int oldstatus; time_t lastcall; struct call_queue *lastqueue; struct member *member; }; struct queue_ent { struct call_queue *parent; /*!< What queue is our parent */ char moh[80]; /*!< Name of musiconhold to be used */ char announce[80]; /*!< Announcement to play for member when call is answered */ char context[AST_MAX_CONTEXT]; /*!< Context when user exits queue */ char digits[AST_MAX_EXTENSION]; /*!< Digits entered while in queue */ int valid_digits; /*!< Digits entered correspond to valid extension. Exited */ int pos; /*!< Where we are in the queue */ int prio; /*!< Our priority */ int last_pos_said; /*!< Last position we told the user */ time_t last_periodic_announce_time; /*!< The last time we played a periodic announcement */ int last_periodic_announce_sound; /*!< The last periodic announcement we made */ time_t last_pos; /*!< Last time we told the user their position */ int opos; /*!< Where we started in the queue */ int handled; /*!< Whether our call was handled */ int max_penalty; /*!< Limit the members that can take this call to this penalty or lower */ int linpos; /*!< If using linear strategy, what position are we at? */ int linwrapped; /*!< Is the linpos wrapped? */ time_t start; /*!< When we started holding */ time_t expire; /*!< When this entry should expire (time out of queue) */ struct ast_channel *chan; /*!< Our channel */ struct queue_ent *next; /*!< The next queue entry */ }; struct member { char interface[80]; /*!< Technology/Location */ char membername[80]; /*!< Member name to use in queue logs */ int penalty; /*!< Are we a last resort? */ int calls; /*!< Number of calls serviced by this member */ int dynamic; /*!< Are we dynamically added? */ int realtime; /*!< Is this member realtime? */ int status; /*!< Status of queue member */ int paused; /*!< Are we paused (not accepting calls)? */ time_t lastcall; /*!< When last successful call was hungup */ struct call_queue *lastqueue; /*!< Last queue we received a call */ unsigned int dead:1; /*!< Used to detect members deleted in realtime */ unsigned int delme:1; /*!< Flag to delete entry on reload */ }; struct member_interface { char interface[80]; AST_LIST_ENTRY(member_interface) list; /*!< Next call queue */ }; static AST_LIST_HEAD_STATIC(interfaces, member_interface); /* values used in multi-bit flags in call_queue */ #define QUEUE_EMPTY_NORMAL 1 #define QUEUE_EMPTY_STRICT 2 #define QUEUE_EMPTY_LOOSE 3 #define ANNOUNCEHOLDTIME_ALWAYS 1 #define ANNOUNCEHOLDTIME_ONCE 2 #define QUEUE_EVENT_VARIABLES 3 struct call_queue { AST_DECLARE_STRING_FIELDS( /*! Queue name */ AST_STRING_FIELD(name); /*! Music on Hold class */ AST_STRING_FIELD(moh); /*! Announcement to play when call is answered */ AST_STRING_FIELD(announce); /*! Exit context */ AST_STRING_FIELD(context); /*! Macro to run upon member connection */ AST_STRING_FIELD(membermacro); /*! Gosub to run upon member connection */ AST_STRING_FIELD(membergosub); /*! Sound file: "Your call is now first in line" (def. queue-youarenext) */ AST_STRING_FIELD(sound_next); /*! Sound file: "There are currently" (def. queue-thereare) */ AST_STRING_FIELD(sound_thereare); /*! Sound file: "calls waiting to speak to a representative." (def. queue-callswaiting) */ AST_STRING_FIELD(sound_calls); /*! Sound file: "The current estimated total holdtime is" (def. queue-holdtime) */ AST_STRING_FIELD(sound_holdtime); /*! Sound file: "minutes." (def. queue-minutes) */ AST_STRING_FIELD(sound_minutes); /*! Sound file: "less-than" (def. queue-lessthan) */ AST_STRING_FIELD(sound_lessthan); /*! Sound file: "seconds." (def. queue-seconds) */ AST_STRING_FIELD(sound_seconds); /*! Sound file: "Thank you for your patience." (def. queue-thankyou) */ AST_STRING_FIELD(sound_thanks); /*! Sound file: Custom announce for caller, no default */ AST_STRING_FIELD(sound_callerannounce); /*! Sound file: "Hold time" (def. queue-reporthold) */ AST_STRING_FIELD(sound_reporthold); ); /*! Sound files: Custom announce, no default */ struct ast_str *sound_periodicannounce[MAX_PERIODIC_ANNOUNCEMENTS]; unsigned int dead:1; unsigned int joinempty:2; unsigned int eventwhencalled:2; unsigned int leavewhenempty:2; unsigned int ringinuse:1; unsigned int setinterfacevar:1; unsigned int setqueuevar:1; unsigned int setqueueentryvar:1; unsigned int reportholdtime:1; unsigned int wrapped:1; unsigned int timeoutrestart:1; unsigned int announceholdtime:2; unsigned int announceposition:1; int strategy:4; unsigned int maskmemberstatus:1; unsigned int realtime:1; unsigned int found:1; int announcefrequency; /*!< How often to announce their position */ int minannouncefrequency; /*!< The minimum number of seconds between position announcements (def. 15) */ int periodicannouncefrequency; /*!< How often to play periodic announcement */ int roundingseconds; /*!< How many seconds do we round to? */ int holdtime; /*!< Current avg holdtime, based on recursive boxcar filter */ int callscompleted; /*!< Number of queue calls completed */ int callsabandoned; /*!< Number of queue calls abandoned */ int servicelevel; /*!< seconds setting for servicelevel*/ int callscompletedinsl; /*!< Number of calls answered with servicelevel*/ char monfmt[8]; /*!< Format to use when recording calls */ int montype; /*!< Monitor type Monitor vs. MixMonitor */ int count; /*!< How many entries */ int maxlen; /*!< Max number of entries */ int wrapuptime; /*!< Wrapup Time */ int retry; /*!< Retry calling everyone after this amount of time */ int timeout; /*!< How long to wait for an answer */ int weight; /*!< Respective weight */ int autopause; /*!< Auto pause queue members if they fail to answer */ /* Queue strategy things */ int rrpos; /*!< Round Robin - position */ int memberdelay; /*!< Seconds to delay connecting member to caller */ int autofill; /*!< Ignore the head call status and ring an available agent */ struct ao2_container *members; /*!< Head of the list of members */ /*! * \brief Number of members _logged in_ * \note There will be members in the members container that are not logged * in, so this can not simply be replaced with ao2_container_count(). */ int membercount; struct queue_ent *head; /*!< Head of the list of callers */ AST_LIST_ENTRY(call_queue) list; /*!< Next call queue */ }; static struct ao2_container *queues; static void update_realtime_members(struct call_queue *q); static int set_member_paused(const char *queuename, const char *interface, const char *reason, int paused); static void set_queue_result(struct ast_channel *chan, enum queue_result res) { int i; for (i = 0; i < sizeof(queue_results) / sizeof(queue_results[0]); i++) { if (queue_results[i].id == res) { pbx_builtin_setvar_helper(chan, "QUEUESTATUS", queue_results[i].text); return; } } } static char *int2strat(int strategy) { int x; for (x = 0; x < sizeof(strategies) / sizeof(strategies[0]); x++) { if (strategy == strategies[x].strategy) return strategies[x].name; } return ""; } static int strat2int(const char *strategy) { int x; for (x = 0; x < sizeof(strategies) / sizeof(strategies[0]); x++) { if (!strcasecmp(strategy, strategies[x].name)) return strategies[x].strategy; } return -1; } static int queue_hash_cb(const void *obj, const int flags) { const struct call_queue *q = obj; return ast_str_hash(q->name); } static int queue_cmp_cb(void *obj, void *arg, int flags) { struct call_queue *q = obj, *q2 = arg; return !strcasecmp(q->name, q2->name) ? CMP_MATCH : 0; } static inline struct call_queue *queue_ref(struct call_queue *q) { ao2_ref(q, 1); return q; } static inline struct call_queue *queue_unref(struct call_queue *q) { ao2_ref(q, -1); return q; } static void set_queue_variables(struct queue_ent *qe) { char interfacevar[256]=""; float sl = 0; if (qe->parent->setqueuevar) { sl = 0; if (qe->parent->callscompleted > 0) sl = 100 * ((float) qe->parent->callscompletedinsl / (float) qe->parent->callscompleted); snprintf(interfacevar,sizeof(interfacevar), "QUEUEMAX=%d|QUEUESTRATEGY=%s|QUEUECALLS=%d|QUEUEHOLDTIME=%d|QUEUECOMPLETED=%d|QUEUEABANDONED=%d|QUEUESRVLEVEL=%d|QUEUESRVLEVELPERF=%2.1f", qe->parent->maxlen, int2strat(qe->parent->strategy), qe->parent->count, qe->parent->holdtime, qe->parent->callscompleted, qe->parent->callsabandoned, qe->parent->servicelevel, sl); pbx_builtin_setvar(qe->chan, interfacevar); } } /*! \brief Insert the 'new' entry after the 'prev' entry of queue 'q' */ static inline void insert_entry(struct call_queue *q, struct queue_ent *prev, struct queue_ent *new, int *pos) { struct queue_ent *cur; if (!q || !new) return; if (prev) { cur = prev->next; prev->next = new; } else { cur = q->head; q->head = new; } new->next = cur; new->parent = q; new->pos = ++(*pos); new->opos = *pos; } enum queue_member_status { QUEUE_NO_MEMBERS, QUEUE_NO_REACHABLE_MEMBERS, QUEUE_NO_UNPAUSED_REACHABLE_MEMBERS, QUEUE_NORMAL }; static enum queue_member_status get_member_status(struct call_queue *q, int max_penalty) { struct member *member; struct ao2_iterator mem_iter; enum queue_member_status result = QUEUE_NO_MEMBERS; ao2_lock(q); mem_iter = ao2_iterator_init(q->members, 0); for (; (member = ao2_iterator_next(&mem_iter)); ao2_ref(member, -1)) { if (max_penalty && (member->penalty > max_penalty)) continue; switch (member->status) { case AST_DEVICE_INVALID: /* nothing to do */ break; case AST_DEVICE_UNAVAILABLE: if (result != QUEUE_NO_UNPAUSED_REACHABLE_MEMBERS) result = QUEUE_NO_REACHABLE_MEMBERS; break; default: if (member->paused) { result = QUEUE_NO_UNPAUSED_REACHABLE_MEMBERS; } else { ao2_unlock(q); ao2_ref(member, -1); return QUEUE_NORMAL; } break; } } ao2_unlock(q); return result; } struct statechange { AST_LIST_ENTRY(statechange) entry; int state; char dev[0]; }; static void *handle_statechange(struct statechange *sc) { struct call_queue *q; struct member *cur; struct ao2_iterator mem_iter; struct member_interface *curint; struct ao2_iterator queue_iter; char *loc; char *technology; technology = ast_strdupa(sc->dev); loc = strchr(technology, '/'); if (loc) { *loc++ = '\0'; } else { return NULL; } AST_LIST_LOCK(&interfaces); AST_LIST_TRAVERSE(&interfaces, curint, list) { char *interface; char *slash_pos; interface = ast_strdupa(curint->interface); if ((slash_pos = strchr(interface, '/'))) if ((slash_pos = strchr(slash_pos + 1, '/'))) *slash_pos = '\0'; if (!strcasecmp(interface, sc->dev)) break; } AST_LIST_UNLOCK(&interfaces); if (!curint) { ast_debug(3, "Device '%s/%s' changed to state '%d' (%s) but we don't care because they're not a member of any queue.\n", technology, loc, sc->state, devstate2str(sc->state)); return NULL; } ast_debug(1, "Device '%s/%s' changed to state '%d' (%s)\n", technology, loc, sc->state, devstate2str(sc->state)); queue_iter = ao2_iterator_init(queues, 0); while ((q = ao2_iterator_next(&queue_iter))) { ao2_lock(q); mem_iter = ao2_iterator_init(q->members, 0); while ((cur = ao2_iterator_next(&mem_iter))) { char *interface; char *slash_pos; interface = ast_strdupa(cur->interface); if ((slash_pos = strchr(interface, '/'))) if ((slash_pos = strchr(slash_pos + 1, '/'))) *slash_pos = '\0'; if (strcasecmp(sc->dev, interface)) { ao2_ref(cur, -1); continue; } if (cur->status != sc->state) { cur->status = sc->state; if (q->maskmemberstatus) { ao2_ref(cur, -1); continue; } manager_event(EVENT_FLAG_AGENT, "QueueMemberStatus", "Queue: %s\r\n" "Location: %s\r\n" "MemberName: %s\r\n" "Membership: %s\r\n" "Penalty: %d\r\n" "CallsTaken: %d\r\n" "LastCall: %d\r\n" "Status: %d\r\n" "Paused: %d\r\n", q->name, cur->interface, cur->membername, cur->dynamic ? "dynamic" : cur->realtime ? "realtime" : "static", cur->penalty, cur->calls, (int)cur->lastcall, cur->status, cur->paused); } ao2_ref(cur, -1); } queue_unref(q); ao2_unlock(q); } return NULL; } /*! * \brief Data used by the device state thread */ static struct { /*! Set to 1 to stop the thread */ unsigned int stop:1; /*! The device state monitoring thread */ pthread_t thread; /*! Lock for the state change queue */ ast_mutex_t lock; /*! Condition for the state change queue */ ast_cond_t cond; /*! Queue of state changes */ AST_LIST_HEAD_NOLOCK(, statechange) state_change_q; } device_state = { .thread = AST_PTHREADT_NULL, }; static void *device_state_thread(void *data) { struct statechange *sc = NULL; while (!device_state.stop) { ast_mutex_lock(&device_state.lock); if (!(sc = AST_LIST_REMOVE_HEAD(&device_state.state_change_q, entry))) { ast_cond_wait(&device_state.cond, &device_state.lock); sc = AST_LIST_REMOVE_HEAD(&device_state.state_change_q, entry); } ast_mutex_unlock(&device_state.lock); /* Check to see if we were woken up to see the request to stop */ if (device_state.stop) break; if (!sc) continue; handle_statechange(sc); free(sc); sc = NULL; } if (sc) free(sc); while ((sc = AST_LIST_REMOVE_HEAD(&device_state.state_change_q, entry))) free(sc); return NULL; } static int statechange_queue(const char *dev, enum ast_device_state state) { struct statechange *sc; if (!(sc = ast_calloc(1, sizeof(*sc) + strlen(dev) + 1))) return 0; sc->state = state; strcpy(sc->dev, dev); ast_mutex_lock(&device_state.lock); AST_LIST_INSERT_TAIL(&device_state.state_change_q, sc, entry); ast_cond_signal(&device_state.cond); ast_mutex_unlock(&device_state.lock); return 0; } static void device_state_cb(const struct ast_event *event, void *unused) { enum ast_device_state state; const char *device; state = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE); device = ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE); if (ast_strlen_zero(device)) { ast_log(LOG_ERROR, "Received invalid event that had no device IE\n"); return; } statechange_queue(device, state); } static struct member *create_queue_member(const char *interface, const char *membername, int penalty, int paused) { struct member *cur; if ((cur = ao2_alloc(sizeof(*cur), NULL))) { cur->penalty = penalty; cur->paused = paused; ast_copy_string(cur->interface, interface, sizeof(cur->interface)); if(!ast_strlen_zero(membername)) ast_copy_string(cur->membername, membername, sizeof(cur->membername)); else ast_copy_string(cur->membername, interface, sizeof(cur->membername)); if (!strchr(cur->interface, '/')) ast_log(LOG_WARNING, "No location at interface '%s'\n", interface); cur->status = ast_device_state(interface); } return cur; } static int compress_char(const char c) { if (c < 32) return 0; else if (c > 96) return c - 64; else return c - 32; } static int member_hash_fn(const void *obj, const int flags) { const struct member *mem = obj; const char *chname = strchr(mem->interface, '/'); int ret = 0, i; if (!chname) chname = mem->interface; for (i = 0; i < 5 && chname[i]; i++) ret += compress_char(chname[i]) << (i * 6); return ret; } static int member_cmp_fn(void *obj1, void *obj2, int flags) { struct member *mem1 = obj1, *mem2 = obj2; return strcasecmp(mem1->interface, mem2->interface) ? 0 : CMP_MATCH; } static void init_queue(struct call_queue *q) { int i; q->dead = 0; q->retry = DEFAULT_RETRY; q->timeout = -1; q->maxlen = 0; q->announcefrequency = 0; q->minannouncefrequency = DEFAULT_MIN_ANNOUNCE_FREQUENCY; q->announceholdtime = 0; q->announceholdtime = 1; q->roundingseconds = 0; /* Default - don't announce seconds */ q->servicelevel = 0; q->ringinuse = 1; q->setinterfacevar = 0; q->setqueuevar = 0; q->setqueueentryvar = 0; q->autofill = autofill_default; q->montype = montype_default; q->monfmt[0] = '\0'; q->periodicannouncefrequency = 0; if(!q->members) { if(q->strategy == QUEUE_STRATEGY_LINEAR) /* linear strategy depends on order, so we have to place all members in a single bucket */ q->members = ao2_container_alloc(1, member_hash_fn, member_cmp_fn); else q->members = ao2_container_alloc(37, member_hash_fn, member_cmp_fn); } q->membercount = 0; q->found = 1; ast_string_field_set(q, sound_next, "queue-youarenext"); ast_string_field_set(q, sound_thereare, "queue-thereare"); ast_string_field_set(q, sound_calls, "queue-callswaiting"); ast_string_field_set(q, sound_holdtime, "queue-holdtime"); ast_string_field_set(q, sound_minutes, "queue-minutes"); ast_string_field_set(q, sound_seconds, "queue-seconds"); ast_string_field_set(q, sound_thanks, "queue-thankyou"); ast_string_field_set(q, sound_lessthan, "queue-less-than"); ast_string_field_set(q, sound_reporthold, "queue-reporthold"); if ((q->sound_periodicannounce[0] = ast_str_create(32))) ast_str_set(&q->sound_periodicannounce[0], 0, "queue-periodic-announce"); for (i = 1; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) { if (q->sound_periodicannounce[i]) ast_str_set(&q->sound_periodicannounce[i], 0, "%s", ""); } } static void clear_queue(struct call_queue *q) { q->holdtime = 0; q->callscompleted = 0; q->callsabandoned = 0; q->callscompletedinsl = 0; q->wrapuptime = 0; } static int add_to_interfaces(const char *interface) { struct member_interface *curint; AST_LIST_LOCK(&interfaces); AST_LIST_TRAVERSE(&interfaces, curint, list) { if (!strcasecmp(curint->interface, interface)) break; } if (curint) { AST_LIST_UNLOCK(&interfaces); return 0; } ast_debug(1, "Adding %s to the list of interfaces that make up all of our queue members.\n", interface); if ((curint = ast_calloc(1, sizeof(*curint)))) { ast_copy_string(curint->interface, interface, sizeof(curint->interface)); AST_LIST_INSERT_HEAD(&interfaces, curint, list); } AST_LIST_UNLOCK(&interfaces); return 0; } static int interface_exists_global(const char *interface) { struct call_queue *q; struct member *mem, tmpmem; struct ao2_iterator queue_iter; int ret = 0; ast_copy_string(tmpmem.interface, interface, sizeof(tmpmem.interface)); queue_iter = ao2_iterator_init(queues, 0); while ((q = ao2_iterator_next(&queue_iter))) { ao2_lock(q); if ((mem = ao2_find(q->members, &tmpmem, OBJ_POINTER))) { ao2_ref(mem, -1); ao2_unlock(q); queue_unref(q); ret = 1; break; } ao2_unlock(q); queue_unref(q); } return ret; } static int remove_from_interfaces(const char *interface) { struct member_interface *curint; AST_LIST_LOCK(&interfaces); AST_LIST_TRAVERSE_SAFE_BEGIN(&interfaces, curint, list) { if (!strcasecmp(curint->interface, interface)) { if (!interface_exists_global(interface)) { ast_debug(1, "Removing %s from the list of interfaces that make up all of our queue members.\n", interface); AST_LIST_REMOVE_CURRENT(list); ast_free(curint); } break; } } AST_LIST_TRAVERSE_SAFE_END; AST_LIST_UNLOCK(&interfaces); return 0; } static void clear_and_free_interfaces(void) { struct member_interface *curint; AST_LIST_LOCK(&interfaces); while ((curint = AST_LIST_REMOVE_HEAD(&interfaces, list))) ast_free(curint); AST_LIST_UNLOCK(&interfaces); } /*! \brief Configure a queue parameter. \par For error reporting, line number is passed for .conf static configuration. For Realtime queues, linenum is -1. The failunknown flag is set for config files (and static realtime) to show errors for unknown parameters. It is cleared for dynamic realtime to allow extra fields in the tables. */ static void queue_set_param(struct call_queue *q, const char *param, const char *val, int linenum, int failunknown) { if (!strcasecmp(param, "musicclass") || !strcasecmp(param, "music") || !strcasecmp(param, "musiconhold")) { ast_string_field_set(q, moh, val); } else if (!strcasecmp(param, "announce")) { ast_string_field_set(q, announce, val); } else if (!strcasecmp(param, "context")) { ast_string_field_set(q, context, val); } else if (!strcasecmp(param, "timeout")) { q->timeout = atoi(val); if (q->timeout < 0) q->timeout = DEFAULT_TIMEOUT; } else if (!strcasecmp(param, "ringinuse")) { q->ringinuse = ast_true(val); } else if (!strcasecmp(param, "setinterfacevar")) { q->setinterfacevar = ast_true(val); } else if (!strcasecmp(param, "setqueuevar")) { q->setqueuevar = ast_true(val); } else if (!strcasecmp(param, "setqueueentryvar")) { q->setqueueentryvar = ast_true(val); } else if (!strcasecmp(param, "monitor-format")) { ast_copy_string(q->monfmt, val, sizeof(q->monfmt)); } else if (!strcasecmp(param, "membermacro")) { ast_string_field_set(q, membermacro, val); } else if (!strcasecmp(param, "membergosub")) { ast_string_field_set(q, membergosub, val); } else if (!strcasecmp(param, "queue-youarenext")) { ast_string_field_set(q, sound_next, val); } else if (!strcasecmp(param, "queue-thereare")) { ast_string_field_set(q, sound_thereare, val); } else if (!strcasecmp(param, "queue-callswaiting")) { ast_string_field_set(q, sound_calls, val); } else if (!strcasecmp(param, "queue-holdtime")) { ast_string_field_set(q, sound_holdtime, val); } else if (!strcasecmp(param, "queue-minutes")) { ast_string_field_set(q, sound_minutes, val); } else if (!strcasecmp(param, "queue-seconds")) { ast_string_field_set(q, sound_seconds, val); } else if (!strcasecmp(param, "queue-lessthan")) { ast_string_field_set(q, sound_lessthan, val); } else if (!strcasecmp(param, "queue-thankyou")) { ast_string_field_set(q, sound_thanks, val); } else if (!strcasecmp(param, "queue-callerannounce")) { ast_string_field_set(q, sound_callerannounce, val); } else if (!strcasecmp(param, "queue-reporthold")) { ast_string_field_set(q, sound_reporthold, val); } else if (!strcasecmp(param, "announce-frequency")) { q->announcefrequency = atoi(val); } else if (!strcasecmp(param, "min-announce-frequency")) { q->minannouncefrequency = atoi(val); ast_debug(1, "%s=%s for queue '%s'\n", param, val, q->name); } else if (!strcasecmp(param, "announce-round-seconds")) { q->roundingseconds = atoi(val); /* Rounding to any other values just doesn't make sense... */ if (!(q->roundingseconds == 0 || q->roundingseconds == 1 || q->roundingseconds == 5 || q->roundingseconds == 10 || q->roundingseconds == 15 || q->roundingseconds == 20 || q->roundingseconds == 30)) { if (linenum >= 0) { ast_log(LOG_WARNING, "'%s' isn't a valid value for %s " "using 0 instead for queue '%s' at line %d of queues.conf\n", val, param, q->name, linenum); } else { ast_log(LOG_WARNING, "'%s' isn't a valid value for %s " "using 0 instead for queue '%s'\n", val, param, q->name); } q->roundingseconds=0; } } else if (!strcasecmp(param, "announce-holdtime")) { if (!strcasecmp(val, "once")) q->announceholdtime = ANNOUNCEHOLDTIME_ONCE; else if (ast_true(val)) q->announceholdtime = ANNOUNCEHOLDTIME_ALWAYS; else q->announceholdtime = 0; } else if (!strcasecmp(param, "announce-position")) { q->announceposition = ast_true(val); } else if (!strcasecmp(param, "periodic-announce")) { if (strchr(val, ',')) { char *s, *buf = ast_strdupa(val); unsigned int i = 0; while ((s = strsep(&buf, ",|"))) { if (!q->sound_periodicannounce[i]) q->sound_periodicannounce[i] = ast_str_create(16); ast_str_set(&q->sound_periodicannounce[i], 0, s); i++; if (i == MAX_PERIODIC_ANNOUNCEMENTS) break; } } else { ast_str_set(&q->sound_periodicannounce[0], 0, val); } } else if (!strcasecmp(param, "periodic-announce-frequency")) { q->periodicannouncefrequency = atoi(val); } else if (!strcasecmp(param, "retry")) { q->retry = atoi(val); if (q->retry <= 0) q->retry = DEFAULT_RETRY; } else if (!strcasecmp(param, "wrapuptime")) { q->wrapuptime = atoi(val); } else if (!strcasecmp(param, "autofill")) { q->autofill = ast_true(val); } else if (!strcasecmp(param, "monitor-type")) { if (!strcasecmp(val, "mixmonitor")) q->montype = 1; } else if (!strcasecmp(param, "autopause")) { q->autopause = ast_true(val); } else if (!strcasecmp(param, "maxlen")) { q->maxlen = atoi(val); if (q->maxlen < 0) q->maxlen = 0; } else if (!strcasecmp(param, "servicelevel")) { q->servicelevel= atoi(val); } else if (!strcasecmp(param, "strategy")) { /* We already have set this, no need to do it again */ return; } else if (!strcasecmp(param, "joinempty")) { if (!strcasecmp(val, "loose")) q->joinempty = QUEUE_EMPTY_LOOSE; else if (!strcasecmp(val, "strict")) q->joinempty = QUEUE_EMPTY_STRICT; else if (ast_true(val)) q->joinempty = QUEUE_EMPTY_NORMAL; else q->joinempty = 0; } else if (!strcasecmp(param, "leavewhenempty")) { if (!strcasecmp(val, "loose")) q->leavewhenempty = QUEUE_EMPTY_LOOSE; else if (!strcasecmp(val, "strict")) q->leavewhenempty = QUEUE_EMPTY_STRICT; else if (ast_true(val)) q->leavewhenempty = QUEUE_EMPTY_NORMAL; else q->leavewhenempty = 0; } else if (!strcasecmp(param, "eventmemberstatus")) { q->maskmemberstatus = !ast_true(val); } else if (!strcasecmp(param, "eventwhencalled")) { if (!strcasecmp(val, "vars")) { q->eventwhencalled = QUEUE_EVENT_VARIABLES; } else { q->eventwhencalled = ast_true(val); } } else if (!strcasecmp(param, "reportholdtime")) { q->reportholdtime = ast_true(val); } else if (!strcasecmp(param, "memberdelay")) { q->memberdelay = atoi(val); } else if (!strcasecmp(param, "weight")) { q->weight = atoi(val); if (q->weight) use_weight++; /* With Realtime queues, if the last queue using weights is deleted in realtime, we will not see any effect on use_weight until next reload. */ } else if (!strcasecmp(param, "timeoutrestart")) { q->timeoutrestart = ast_true(val); } else if (failunknown) { if (linenum >= 0) { ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s at line %d of queues.conf\n", q->name, param, linenum); } else { ast_log(LOG_WARNING, "Unknown keyword in queue '%s': %s\n", q->name, param); } } } static void rt_handle_member_record(struct call_queue *q, char *interface, const char *membername, const char *penalty_str, const char *paused_str) { struct member *m, tmpmem; int penalty = 0; int paused = 0; if (penalty_str) { penalty = atoi(penalty_str); if (penalty < 0) penalty = 0; } if (paused_str) { paused = atoi(paused_str); if (paused < 0) paused = 0; } /* Find the member, or the place to put a new one. */ ast_copy_string(tmpmem.interface, interface, sizeof(tmpmem.interface)); m = ao2_find(q->members, &tmpmem, OBJ_POINTER); /* Create a new one if not found, else update penalty */ if (!m) { if ((m = create_queue_member(interface, membername, penalty, paused))) { m->dead = 0; m->realtime = 1; add_to_interfaces(interface); ao2_link(q->members, m); q->membercount++; } } else { m->dead = 0; /* Do not delete this one. */ if (paused_str) m->paused = paused; m->penalty = penalty; ao2_ref(m, -1); } } static void free_members(struct call_queue *q, int all) { /* Free non-dynamic members */ struct member *cur; struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0); while ((cur = ao2_iterator_next(&mem_iter))) { if (all || !cur->dynamic) { ao2_unlink(q->members, cur); remove_from_interfaces(cur->interface); q->membercount--; } ao2_ref(cur, -1); } } static void destroy_queue(void *obj) { struct call_queue *q = obj; int i; ast_debug(0, "Queue destructor called for queue '%s'!\n", q->name); free_members(q, 1); ast_string_field_free_memory(q); for (i = 0; i < MAX_PERIODIC_ANNOUNCEMENTS; i++) { if (q->sound_periodicannounce[i]) free(q->sound_periodicannounce[i]); } ao2_ref(q->members, -1); } static struct call_queue *alloc_queue(const char *queuename) { struct call_queue *q; if ((q = ao2_alloc(sizeof(*q), destroy_queue))) { if (ast_string_field_init(q, 64)) { free(q); return NULL; } ast_string_field_set(q, name, queuename); } return q; } /*!\brief Reload a single queue via realtime. \return Return the queue, or NULL if it doesn't exist. \note Should be called with the global qlock locked. */ static struct call_queue *find_queue_by_name_rt(const char *queuename, struct ast_variable *queue_vars, struct ast_config *member_config) { struct ast_variable *v; struct call_queue *q, tmpq = { .name = queuename, }; struct member *m; struct ao2_iterator mem_iter; char *interface = NULL; const char *tmp_name; char *tmp; char tmpbuf[64]; /* Must be longer than the longest queue param name. */ /* Static queues override realtime. */ if ((q = ao2_find(queues, &tmpq, OBJ_POINTER))) { ao2_lock(q); if (!q->realtime) { if (q->dead) { ao2_unlock(q); queue_unref(q); return NULL; } else { ast_log(LOG_WARNING, "Static queue '%s' already exists. Not loading from realtime\n", q->name); ao2_unlock(q); return q; } } queue_unref(q); } else if (!member_config) /* Not found in the list, and it's not realtime ... */ return NULL; /* Check if queue is defined in realtime. */ if (!queue_vars) { /* Delete queue from in-core list if it has been deleted in realtime. */ if (q) { /*! \note Hmm, can't seem to distinguish a DB failure from a not found condition... So we might delete an in-core queue in case of DB failure. */ ast_debug(1, "Queue %s not found in realtime.\n", queuename); q->dead = 1; /* Delete if unused (else will be deleted when last caller leaves). */ ao2_unlink(queues, q); ao2_unlock(q); queue_unref(q); } return NULL; } /* Create a new queue if an in-core entry does not exist yet. */ if (!q) { if (!(q = alloc_queue(queuename))) return NULL; ao2_lock(q); clear_queue(q); q->realtime = 1; init_queue(q); /* Ensure defaults for all parameters not set explicitly. */ ao2_link(queues, q); queue_ref(q); } memset(tmpbuf, 0, sizeof(tmpbuf)); for (v = queue_vars; v; v = v->next) { /* Convert to dashes `-' from underscores `_' as the latter are more SQL friendly. */ if ((tmp = strchr(v->name, '_'))) { ast_copy_string(tmpbuf, v->name, sizeof(tmpbuf)); tmp_name = tmpbuf; tmp = tmpbuf; while ((tmp = strchr(tmp, '_'))) *tmp++ = '-'; } else tmp_name = v->name; queue_set_param(q, tmp_name, v->value, -1, 0); } /* Temporarily set realtime members dead so we can detect deleted ones. * Also set the membercount correctly for realtime*/ mem_iter = ao2_iterator_init(q->members, 0); while ((m = ao2_iterator_next(&mem_iter))) { q->membercount++; if (m->realtime) m->dead = 1; ao2_ref(m, -1); } while ((interface = ast_category_browse(member_config, interface))) { rt_handle_member_record(q, interface, ast_variable_retrieve(member_config, interface, "membername"), ast_variable_retrieve(member_config, interface, "penalty"), ast_variable_retrieve(member_config, interface, "paused")); } /* Delete all realtime members that have been deleted in DB. */ mem_iter = ao2_iterator_init(q->members, 0); while ((m = ao2_iterator_next(&mem_iter))) { if (m->dead) { ao2_unlink(q->members, m); ao2_unlock(q); remove_from_interfaces(m->interface); ao2_lock(q); q->membercount--; } ao2_ref(m, -1); } ao2_unlock(q); return q; } static struct call_queue *load_realtime_queue(const char *queuename) { struct ast_variable *queue_vars; struct ast_config *member_config = NULL; struct call_queue *q = NULL, tmpq = { .name = queuename, }; /* Find the queue in the in-core list first. */ q = ao2_find(queues, &tmpq, OBJ_POINTER); if (!q || q->realtime) { /*! \note Load from realtime before taking the global qlock, to avoid blocking all queue operations while waiting for the DB. This will be two separate database transactions, so we might see queue parameters as they were before another process changed the queue and member list as it was after the change. Thus we might see an empty member list when a queue is deleted. In practise, this is unlikely to cause a problem. */ queue_vars = ast_load_realtime("queues", "name", queuename, NULL); if (queue_vars) { member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", queuename, NULL); if (!member_config) { ast_log(LOG_ERROR, "no queue_members defined in your config (extconfig.conf).\n"); return NULL; } } ao2_lock(queues); q = find_queue_by_name_rt(queuename, queue_vars, member_config); if (member_config) ast_config_destroy(member_config); if (queue_vars) ast_variables_destroy(queue_vars); ao2_unlock(queues); } else { update_realtime_members(q); } return q; } static int update_realtime_member_field(struct member *mem, const char *queue_name, const char *field, const char *value) { struct ast_variable *var; int ret = -1; if(!(var = ast_load_realtime("queue_members", "interface", mem->interface, "queue_name", queue_name, NULL))) return ret; while (var) { if(!strcmp(var->name, "uniqueid")) break; var = var->next; } if(var && !ast_strlen_zero(var->value)) { if ((ast_update_realtime("queue_members", "uniqueid", var->value, field, value, NULL)) > -1) ret = 0; } return ret; } static void update_realtime_members(struct call_queue *q) { struct ast_config *member_config = NULL; struct member *m; char *interface = NULL; struct ao2_iterator mem_iter; member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", q->name , NULL); if (!member_config) { /*This queue doesn't have realtime members*/ ast_debug(3, "Queue %s has no realtime members defined. No need for update\n", q->name); return; } ao2_lock(q); /* Temporarily set realtime members dead so we can detect deleted ones.*/ mem_iter = ao2_iterator_init(q->members, 0); while ((m = ao2_iterator_next(&mem_iter))) { if (m->realtime) m->dead = 1; ao2_ref(m, -1); } while ((interface = ast_category_browse(member_config, interface))) { rt_handle_member_record(q, interface, S_OR(ast_variable_retrieve(member_config, interface, "membername"), interface), ast_variable_retrieve(member_config, interface, "penalty"), ast_variable_retrieve(member_config, interface, "paused")); } /* Delete all realtime members that have been deleted in DB. */ mem_iter = ao2_iterator_init(q->members, 0); while ((m = ao2_iterator_next(&mem_iter))) { if (m->dead) { ao2_unlink(q->members, m); ao2_unlock(q); remove_from_interfaces(m->interface); ao2_lock(q); q->membercount--; } ao2_ref(m, -1); } ao2_unlock(q); } static int join_queue(char *queuename, struct queue_ent *qe, enum queue_result *reason) { struct call_queue *q; struct queue_ent *cur, *prev = NULL; int res = -1; int pos = 0; int inserted = 0; enum queue_member_status stat; if (!(q = load_realtime_queue(queuename))) return res; ao2_lock(queues); ao2_lock(q); /* This is our one */ stat = get_member_status(q, qe->max_penalty); if (!q->joinempty && (stat == QUEUE_NO_MEMBERS)) *reason = QUEUE_JOINEMPTY; else if ((q->joinempty == QUEUE_EMPTY_STRICT) && (stat == QUEUE_NO_REACHABLE_MEMBERS || stat == QUEUE_NO_UNPAUSED_REACHABLE_MEMBERS)) *reason = QUEUE_JOINUNAVAIL; else if ((q->joinempty == QUEUE_EMPTY_LOOSE) && (stat == QUEUE_NO_REACHABLE_MEMBERS)) *reason = QUEUE_JOINUNAVAIL; else if (q->maxlen && (q->count >= q->maxlen)) *reason = QUEUE_FULL; else { /* There's space for us, put us at the right position inside * the queue. * Take into account the priority of the calling user */ inserted = 0; prev = NULL; cur = q->head; while (cur) { /* We have higher priority than the current user, enter * before him, after all the other users with priority * higher or equal to our priority. */ if ((!inserted) && (qe->prio > cur->prio)) { insert_entry(q, prev, qe, &pos); inserted = 1; } cur->pos = ++pos; prev = cur; cur = cur->next; } /* No luck, join at the end of the queue */ if (!inserted) insert_entry(q, prev, qe, &pos); ast_copy_string(qe->moh, q->moh, sizeof(qe->moh)); ast_copy_string(qe->announce, q->announce, sizeof(qe->announce)); ast_copy_string(qe->context, q->context, sizeof(qe->context)); q->count++; res = 0; manager_event(EVENT_FLAG_CALL, "Join", "Channel: %s\r\nCallerID: %s\r\nCallerIDName: %s\r\nQueue: %s\r\nPosition: %d\r\nCount: %d\r\nUniqueid: %s\r\n", qe->chan->name, S_OR(qe->chan->cid.cid_num, "unknown"), /* XXX somewhere else it is */ S_OR(qe->chan->cid.cid_name, "unknown"), q->name, qe->pos, q->count, qe->chan->uniqueid ); ast_debug(1, "Queue '%s' Join, Channel '%s', Position '%d'\n", q->name, qe->chan->name, qe->pos ); } ao2_unlock(q); ao2_unlock(queues); return res; } static int play_file(struct ast_channel *chan, const char *filename) { int res; ast_stopstream(chan); res = ast_streamfile(chan, filename, chan->language); if (!res) res = ast_waitstream(chan, AST_DIGIT_ANY); ast_stopstream(chan); return res; } static int valid_exit(struct queue_ent *qe, char digit) { int digitlen = strlen(qe->digits); /* Prevent possible buffer overflow */ if (digitlen < sizeof(qe->digits) - 2) { qe->digits[digitlen] = digit; qe->digits[digitlen + 1] = '\0'; } else { qe->digits[0] = '\0'; return 0; } /* If there's no context to goto, short-circuit */ if (ast_strlen_zero(qe->context)) return 0; /* If the extension is bad, then reset the digits to blank */ if (!ast_canmatch_extension(qe->chan, qe->context, qe->digits, 1, qe->chan->cid.cid_num)) { qe->digits[0] = '\0'; return 0; } /* We have an exact match */ if (!ast_goto_if_exists(qe->chan, qe->context, qe->digits, 1)) { qe->valid_digits = 1; /* Return 1 on a successful goto */ return 1; } return 0; } static int say_position(struct queue_ent *qe, int ringing) { int res = 0, avgholdmins, avgholdsecs; time_t now; /* Let minannouncefrequency seconds pass between the start of each position announcement */ time(&now); if ((now - qe->last_pos) < qe->parent->minannouncefrequency) return 0; /* If either our position has changed, or we are over the freq timer, say position */ if ((qe->last_pos_said == qe->pos) && ((now - qe->last_pos) < qe->parent->announcefrequency)) return 0; if (ringing) { ast_indicate(qe->chan,-1); } else { ast_moh_stop(qe->chan); } if (qe->parent->announceposition) { /* Say we're next, if we are */ if (qe->pos == 1) { res = play_file(qe->chan, qe->parent->sound_next); if (res) goto playout; else goto posout; } else { res = play_file(qe->chan, qe->parent->sound_thereare); if (res) goto playout; res = ast_say_number(qe->chan, qe->pos, AST_DIGIT_ANY, qe->chan->language, (char *) NULL); /* Needs gender */ if (res) goto playout; res = play_file(qe->chan, qe->parent->sound_calls); if (res) goto playout; } } /* Round hold time to nearest minute */ avgholdmins = abs(((qe->parent->holdtime + 30) - (now - qe->start)) / 60); /* If they have specified a rounding then round the seconds as well */ if (qe->parent->roundingseconds) { avgholdsecs = (abs(((qe->parent->holdtime + 30) - (now - qe->start))) - 60 * avgholdmins) / qe->parent->roundingseconds; avgholdsecs *= qe->parent->roundingseconds; } else { avgholdsecs = 0; } ast_verb(3, "Hold time for %s is %d minutes %d seconds\n", qe->parent->name, avgholdmins, avgholdsecs); /* If the hold time is >1 min, if it's enabled, and if it's not supposed to be only once and we have already said it, say it */ if ((avgholdmins+avgholdsecs) > 0 && (qe->parent->announceholdtime) && (!(qe->parent->announceholdtime == ANNOUNCEHOLDTIME_ONCE) && qe->last_pos)) { res = play_file(qe->chan, qe->parent->sound_holdtime); if (res) goto playout; if (avgholdmins > 0) { if (avgholdmins < 2) { res = play_file(qe->chan, qe->parent->sound_lessthan); if (res) goto playout; res = ast_say_number(qe->chan, 2, AST_DIGIT_ANY, qe->chan->language, NULL); if (res) goto playout; } else { res = ast_say_number(qe->chan, avgholdmins, AST_DIGIT_ANY, qe->chan->language, NULL); if (res) goto playout; } res = play_file(qe->chan, qe->parent->sound_minutes); if (res) goto playout; } if (avgholdsecs>0) { res = ast_say_number(qe->chan, avgholdsecs, AST_DIGIT_ANY, qe->chan->language, NULL); if (res) goto playout; res = play_file(qe->chan, qe->parent->sound_seconds); if (res) goto playout; } } posout: if (qe->parent->announceposition) { ast_verb(3, "Told %s in %s their queue position (which was %d)\n", qe->chan->name, qe->parent->name, qe->pos); } res = play_file(qe->chan, qe->parent->sound_thanks); playout: if ((res > 0 && !valid_exit(qe, res)) || res < 0) res = 0; /* Set our last_pos indicators */ qe->last_pos = now; qe->last_pos_said = qe->pos; /* Don't restart music on hold if we're about to exit the caller from the queue */ if (!res) { if (ringing) ast_indicate(qe->chan, AST_CONTROL_RINGING); else ast_moh_start(qe->chan, qe->moh, NULL); } return res; } static void recalc_holdtime(struct queue_ent *qe, int newholdtime) { int oldvalue; /* Calculate holdtime using a recursive boxcar filter */ /* Thanks to SRT for this contribution */ /* 2^2 (4) is the filter coefficient; a higher exponent would give old entries more weight */ ao2_lock(qe->parent); oldvalue = qe->parent->holdtime; qe->parent->holdtime = (((oldvalue << 2) - oldvalue) + newholdtime) >> 2; ao2_unlock(qe->parent); } static void leave_queue(struct queue_ent *qe) { struct call_queue *q; struct queue_ent *cur, *prev = NULL; int pos = 0; if (!(q = qe->parent)) return; queue_ref(q); ao2_lock(q); prev = NULL; for (cur = q->head; cur; cur = cur->next) { if (cur == qe) { q->count--; /* Take us out of the queue */ manager_event(EVENT_FLAG_CALL, "Leave", "Channel: %s\r\nQueue: %s\r\nCount: %d\r\nUniqueid: %s\r\n", qe->chan->name, q->name, q->count, qe->chan->uniqueid); ast_debug(1, "Queue '%s' Leave, Channel '%s'\n", q->name, qe->chan->name ); /* Take us out of the queue */ if (prev) prev->next = cur->next; else q->head = cur->next; } else { /* Renumber the people after us in the queue based on a new count */ cur->pos = ++pos; prev = cur; } } ao2_unlock(q); /*If the queue is a realtime queue, check to see if it's still defined in real time*/ if(q->realtime) { if(!ast_load_realtime("queues", "name", q->name, NULL)) q->dead = 1; } if (q->dead) { /* It's dead and nobody is in it, so kill it */ ao2_unlink(queues, q); queue_unref(q); } queue_unref(q); } /* Hang up a list of outgoing calls */ static void hangupcalls(struct callattempt *outgoing, struct ast_channel *exception) { struct callattempt *oo; while (outgoing) { /* Hangup any existing lines we have open */ if (outgoing->chan && (outgoing->chan != exception)) ast_hangup(outgoing->chan); oo = outgoing; outgoing = outgoing->q_next; if (oo->member) ao2_ref(oo->member, -1); ast_free(oo); } } static int update_status(struct call_queue *q, struct member *member, int status) { struct member *cur; struct ao2_iterator mem_iter; /* Since a reload could have taken place, we have to traverse the list to be sure it's still valid */ ao2_lock(q); mem_iter = ao2_iterator_init(q->members, 0); while ((cur = ao2_iterator_next(&mem_iter))) { if (member != cur) { ao2_ref(cur, -1); continue; } cur->status = status; if (!q->maskmemberstatus) { manager_event(EVENT_FLAG_AGENT, "QueueMemberStatus", "Queue: %s\r\n" "Location: %s\r\n" "MemberName: %s\r\n" "Membership: %s\r\n" "Penalty: %d\r\n" "CallsTaken: %d\r\n" "LastCall: %d\r\n" "Status: %d\r\n" "Paused: %d\r\n", q->name, cur->interface, cur->membername, cur->dynamic ? "dynamic" : cur->realtime ? "realtime": "static", cur->penalty, cur->calls, (int)cur->lastcall, cur->status, cur->paused); } ao2_ref(cur, -1); } ao2_unlock(q); return 0; } static int update_dial_status(struct call_queue *q, struct member *member, int status) { if (status == AST_CAUSE_BUSY) status = AST_DEVICE_BUSY; else if (status == AST_CAUSE_UNREGISTERED) status = AST_DEVICE_UNAVAILABLE; else if (status == AST_CAUSE_NOSUCHDRIVER) status = AST_DEVICE_INVALID; else status = AST_DEVICE_UNKNOWN; return update_status(q, member, status); } /* traverse all defined queues which have calls waiting and contain this member return 0 if no other queue has precedence (higher weight) or 1 if found */ static int compare_weight(struct call_queue *rq, struct member *member) { struct call_queue *q; struct member *mem; int found = 0; struct ao2_iterator queue_iter; /* &qlock and &rq->lock already set by try_calling() * to solve deadlock */ queue_iter = ao2_iterator_init(queues, 0); while ((q = ao2_iterator_next(&queue_iter))) { if (q == rq) { /* don't check myself, could deadlock */ queue_unref(q); continue; } ao2_lock(q); if (q->count && q->members) { if ((mem = ao2_find(q->members, member, OBJ_POINTER))) { ast_debug(1, "Found matching member %s in queue '%s'\n", mem->interface, q->name); if (q->weight > rq->weight) { 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); found = 1; } ao2_ref(mem, -1); } } ao2_unlock(q); if (found) { queue_unref(q); break; } queue_unref(q); } return found; } /*! \brief common hangup actions */ static void do_hang(struct callattempt *o) { o->stillgoing = 0; ast_hangup(o->chan); o->chan = NULL; } static char *vars2manager(struct ast_channel *chan, char *vars, size_t len) { struct ast_str *buf = ast_str_alloca(len + 1); char *tmp; if (pbx_builtin_serialize_variables(chan, &buf)) { int i, j; /* convert "\n" to "\nVariable: " */ strcpy(vars, "Variable: "); tmp = buf->str; for (i = 0, j = 10; (i < len - 1) && (j < len - 1); i++, j++) { vars[j] = tmp[i]; if (tmp[i + 1] == '\0') break; if (tmp[i] == '\n') { vars[j] = '\r'; vars[++j] = '\n'; ast_copy_string(&(vars[j]), "Variable: ", len - j); j += 9; } } if (j > len - 1) j = len - 1; vars[j - 2] = '\r'; vars[j - 1] = '\n'; vars[j] = '\0'; } else { /* there are no channel variables; leave it blank */ *vars = '\0'; } return vars; } static int ring_entry(struct queue_ent *qe, struct callattempt *tmp, int *busies) { int res; int status; char tech[256]; char *location; /* on entry here, we know that tmp->chan == NULL */ if ((tmp->lastqueue && tmp->lastqueue->wrapuptime && (time(NULL) - tmp->lastcall < tmp->lastqueue->wrapuptime)) || (!tmp->lastqueue && qe->parent->wrapuptime && (time(NULL) - tmp->lastcall < qe->parent->wrapuptime))) { ast_debug(1, "Wrapuptime not yet expired on queue %s for %s\n", (tmp->lastqueue ? tmp->lastqueue->name : qe->parent->name), tmp->interface); if (qe->chan->cdr) ast_cdr_busy(qe->chan->cdr); tmp->stillgoing = 0; (*busies)++; return 0; } if (!qe->parent->ringinuse && (tmp->member->status != AST_DEVICE_NOT_INUSE) && (tmp->member->status != AST_DEVICE_UNKNOWN)) { ast_debug(1, "%s in use, can't receive call\n", tmp->interface); if (qe->chan->cdr) ast_cdr_busy(qe->chan->cdr); tmp->stillgoing = 0; return 0; } if (tmp->member->paused) { ast_debug(1, "%s paused, can't receive call\n", tmp->interface); if (qe->chan->cdr) ast_cdr_busy(qe->chan->cdr); tmp->stillgoing = 0; return 0; } if (use_weight && compare_weight(qe->parent,tmp->member)) { ast_debug(1, "Priority queue delaying call to %s:%s\n", qe->parent->name, tmp->interface); if (qe->chan->cdr) ast_cdr_busy(qe->chan->cdr); tmp->stillgoing = 0; (*busies)++; return 0; } ast_copy_string(tech, tmp->interface, sizeof(tech)); if ((location = strchr(tech, '/'))) *location++ = '\0'; else location = ""; /* Request the peer */ tmp->chan = ast_request(tech, qe->chan->nativeformats, location, &status); if (!tmp->chan) { /* If we can't, just go on to the next call */ if (qe->chan->cdr) ast_cdr_busy(qe->chan->cdr); tmp->stillgoing = 0; update_dial_status(qe->parent, tmp->member, status); ao2_lock(qe->parent); qe->parent->rrpos++; qe->linpos++; ao2_unlock(qe->parent); (*busies)++; return 0; } else if (status != tmp->oldstatus) update_dial_status(qe->parent, tmp->member, status); tmp->chan->appl = "AppQueue"; tmp->chan->data = "(Outgoing Line)"; tmp->chan->whentohangup = 0; if (tmp->chan->cid.cid_num) ast_free(tmp->chan->cid.cid_num); tmp->chan->cid.cid_num = ast_strdup(qe->chan->cid.cid_num); if (tmp->chan->cid.cid_name) ast_free(tmp->chan->cid.cid_name); tmp->chan->cid.cid_name = ast_strdup(qe->chan->cid.cid_name); if (tmp->chan->cid.cid_ani) ast_free(tmp->chan->cid.cid_ani); tmp->chan->cid.cid_ani = ast_strdup(qe->chan->cid.cid_ani); /* Inherit specially named variables from parent channel */ ast_channel_inherit_variables(qe->chan, tmp->chan); /* Presense of ADSI CPE on outgoing channel follows ours */ tmp->chan->adsicpe = qe->chan->adsicpe; /* Place the call, but don't wait on the answer */ if ((res = ast_call(tmp->chan, location, 0))) { /* Again, keep going even if there's an error */ ast_debug(1, "ast call on peer returned %d\n", res); ast_verb(3, "Couldn't call %s\n", tmp->interface); do_hang(tmp); (*busies)++; return 0; } else if (qe->parent->eventwhencalled) { char vars[2048]; manager_event(EVENT_FLAG_AGENT, "AgentCalled", "Queue: %s\r\n" "AgentCalled: %s\r\n" "AgentName: %s\r\n" "ChannelCalling: %s\r\n" "DestinationChannel: %s\r\n" "CallerIDNum: %s\r\n" "CallerIDName: %s\r\n" "Context: %s\r\n" "Extension: %s\r\n" "Priority: %d\r\n" "%s", qe->parent->name, tmp->interface, tmp->member->membername, qe->chan->name, tmp->chan->name, tmp->chan->cid.cid_num ? tmp->chan->cid.cid_num : "unknown", tmp->chan->cid.cid_name ? tmp->chan->cid.cid_name : "unknown", qe->chan->context, qe->chan->exten, qe->chan->priority, qe->parent->eventwhencalled == QUEUE_EVENT_VARIABLES ? vars2manager(qe->chan, vars, sizeof(vars)) : ""); ast_verb(3, "Called %s\n", tmp->interface); } return 1; } /*! \brief find the entry with the best metric, or NULL */ static struct callattempt *find_best(struct callattempt *outgoing) { struct callattempt *best = NULL, *cur; for (cur = outgoing; cur; cur = cur->q_next) { if (cur->stillgoing && /* Not already done */ !cur->chan && /* Isn't already going */ (!best || cur->metric < best->metric)) { /* We haven't found one yet, or it's better */ best = cur; } } return best; } static int ring_one(struct queue_ent *qe, struct callattempt *outgoing, int *busies) { int ret = 0; while (ret == 0) { struct callattempt *best = find_best(outgoing); if (!best) { ast_debug(1, "Nobody left to try ringing in queue\n"); break; } if (qe->parent->strategy == QUEUE_STRATEGY_RINGALL) { struct callattempt *cur; /* Ring everyone who shares this best metric (for ringall) */ for (cur = outgoing; cur; cur = cur->q_next) { if (cur->stillgoing && !cur->chan && cur->metric <= best->metric) { ast_debug(1, "(Parallel) Trying '%s' with metric %d\n", cur->interface, cur->metric); ring_entry(qe, cur, busies); } } } else { /* Ring just the best channel */ ast_debug(1, "Trying '%s' with metric %d\n", best->interface, best->metric); ring_entry(qe, best, busies); } if (best->chan) /* break out with result = 1 */ ret = 1; } return ret; } static int store_next_rr(struct queue_ent *qe, struct callattempt *outgoing) { struct callattempt *best = find_best(outgoing); if (best) { /* Ring just the best channel */ ast_debug(1, "Next is '%s' with metric %d\n", best->interface, best->metric); qe->parent->rrpos = best->metric % 1000; } else { /* Just increment rrpos */ if (qe->parent->wrapped) { /* No more channels, start over */ qe->parent->rrpos = 0; } else { /* Prioritize next entry */ qe->parent->rrpos++; } } qe->parent->wrapped = 0; return 0; } static int store_next_lin(struct queue_ent *qe, struct callattempt *outgoing) { struct callattempt *best = find_best(outgoing); if (best) { /* Ring just the best channel */ ast_debug(1, "Next is '%s' with metric %d\n", best->interface, best->metric); qe->linpos = best->metric % 1000; } else { /* Just increment rrpos */ if (qe->linwrapped) { /* No more channels, start over */ qe->linpos = 0; } else { /* Prioritize next entry */ qe->linpos++; } } qe->linwrapped = 0; return 0; } static int say_periodic_announcement(struct queue_ent *qe, int ringing) { int res = 0; time_t now; /* Get the current time */ time(&now); /* Check to see if it is time to announce */ if ((now - qe->last_periodic_announce_time) < qe->parent->periodicannouncefrequency) return 0; /* Stop the music on hold so we can play our own file */ if (ringing) ast_indicate(qe->chan,-1); else ast_moh_stop(qe->chan); ast_verb(3, "Playing periodic announcement\n"); /* Check to make sure we have a sound file. If not, reset to the first sound file */ if (qe->last_periodic_announce_sound >= MAX_PERIODIC_ANNOUNCEMENTS || !qe->parent->sound_periodicannounce[qe->last_periodic_announce_sound] || ast_strlen_zero(qe->parent->sound_periodicannounce[qe->last_periodic_announce_sound]->str)) { qe->last_periodic_announce_sound = 0; } /* play the announcement */ res = play_file(qe->chan, qe->parent->sound_periodicannounce[qe->last_periodic_announce_sound]->str); if ((res > 0 && !valid_exit(qe, res)) || res < 0) res = 0; /* Resume Music on Hold if the caller is going to stay in the queue */ if (!res) { if (ringing) ast_indicate(qe->chan, AST_CONTROL_RINGING); else ast_moh_start(qe->chan, qe->moh, NULL); } /* update last_periodic_announce_time */ qe->last_periodic_announce_time = now; /* Update the current periodic announcement to the next announcement */ qe->last_periodic_announce_sound++; return res; } static void record_abandoned(struct queue_ent *qe) { ao2_lock(qe->parent); set_queue_variables(qe); manager_event(EVENT_FLAG_AGENT, "QueueCallerAbandon", "Queue: %s\r\n" "Uniqueid: %s\r\n" "Position: %d\r\n" "OriginalPosition: %d\r\n" "HoldTime: %d\r\n", qe->parent->name, qe->chan->uniqueid, qe->pos, qe->opos, (int)(time(NULL) - qe->start)); qe->parent->callsabandoned++; ao2_unlock(qe->parent); } /*! \brief RNA == Ring No Answer. Common code that is executed when we try a queue member and they don't answer. */ static void rna(int rnatime, struct queue_ent *qe, char *interface, char *membername) { ast_verb(3, "Nobody picked up in %d ms\n", rnatime); ast_queue_log(qe->parent->name, qe->chan->uniqueid, membername, "RINGNOANSWER", "%d", rnatime); if (qe->parent->autopause) { if (!set_member_paused(qe->parent->name, interface, "Auto-Pause", 1)) { ast_verb(3, "Auto-Pausing Queue Member %s in queue %s since they failed to answer.\n", interface, qe->parent->name); } else { ast_verb(3, "Failed to pause Queue Member %s in queue %s!\n", interface, qe->parent->name); } } return; } #define AST_MAX_WATCHERS 256 static struct callattempt *wait_for_answer(struct queue_ent *qe, struct callattempt *outgoing, int *to, char *digit, int prebusies, int caller_disconnect, int forwardsallowed) { const char *queue = qe->parent->name; struct callattempt *o; int status; int sentringing = 0; int numbusies = prebusies; int numnochan = 0; int stillgoing = 0; int orig = *to; struct ast_frame *f; struct callattempt *peer = NULL; struct ast_channel *winner; struct ast_channel *in = qe->chan; char on[80] = ""; char membername[80] = ""; long starttime = 0; long endtime = 0; #ifdef HAVE_EPOLL struct callattempt *epollo; #endif starttime = (long) time(NULL); #ifdef HAVE_EPOLL for (epollo = outgoing; epollo; epollo = epollo->q_next) { if(epollo->chan) ast_poll_channel_add(in, epollo->chan); } #endif while (*to && !peer) { int numlines, retry, pos = 1; struct ast_channel *watchers[AST_MAX_WATCHERS]; watchers[0] = in; for (retry = 0; retry < 2; retry++) { numlines = 0; for (o = outgoing; o; o = o->q_next) { /* Keep track of important channels */ if (o->stillgoing) { /* Keep track of important channels */ stillgoing = 1; if (o->chan) watchers[pos++] = o->chan; } numlines++; } if (pos > 1 /* found */ || !stillgoing /* nobody listening */ || (qe->parent->strategy != QUEUE_STRATEGY_RINGALL) /* ring would not be delivered */) break; /* On "ringall" strategy we only move to the next penalty level when *all* ringing phones are done in the current penalty level */ ring_one(qe, outgoing, &numbusies); /* and retry... */ } if (pos == 1 /* not found */) { if (numlines == (numbusies + numnochan)) { ast_debug(1, "Everyone is busy at this time\n"); } else { ast_log(LOG_NOTICE, "No one is answering queue '%s' (%d/%d/%d)\n", queue, numlines, numbusies, numnochan); } *to = 0; return NULL; } winner = ast_waitfor_n(watchers, pos, to); for (o = outgoing; o; o = o->q_next) { if (o->stillgoing && (o->chan) && (o->chan->_state == AST_STATE_UP)) { if (!peer) { ast_verb(3, "%s answered %s\n", o->chan->name, in->name); peer = o; } } else if (o->chan && (o->chan == winner)) { ast_copy_string(on, o->member->interface, sizeof(on)); ast_copy_string(membername, o->member->membername, sizeof(membername)); if (!ast_strlen_zero(o->chan->call_forward) && !forwardsallowed) { ast_verb(3, "Forwarding %s to '%s' prevented.\n", in->name, o->chan->call_forward); numnochan++; do_hang(o); winner = NULL; continue; } else if (!ast_strlen_zero(o->chan->call_forward)) { char tmpchan[256]; char *stuff; char *tech; ast_copy_string(tmpchan, o->chan->call_forward, sizeof(tmpchan)); if ((stuff = strchr(tmpchan, '/'))) { *stuff++ = '\0'; tech = tmpchan; } else { snprintf(tmpchan, sizeof(tmpchan), "%s@%s", o->chan->call_forward, o->chan->context); stuff = tmpchan; tech = "Local"; } /* Before processing channel, go ahead and check for forwarding */ ast_verb(3, "Now forwarding %s to '%s/%s' (thanks to %s)\n", in->name, tech, stuff, o->chan->name); /* Setup parameters */ o->chan = ast_request(tech, in->nativeformats, stuff, &status); if (status != o->oldstatus) update_dial_status(qe->parent, o->member, status); if (!o->chan) { ast_log(LOG_NOTICE, "Unable to create local channel for call forward to '%s/%s'\n", tech, stuff); o->stillgoing = 0; numnochan++; } else { ast_channel_inherit_variables(in, o->chan); if (o->chan->cid.cid_num) ast_free(o->chan->cid.cid_num); o->chan->cid.cid_num = ast_strdup(in->cid.cid_num); if (o->chan->cid.cid_name) ast_free(o->chan->cid.cid_name); o->chan->cid.cid_name = ast_strdup(in->cid.cid_name); ast_string_field_set(o->chan, accountcode, in->accountcode); o->chan->cdrflags = in->cdrflags; if (in->cid.cid_ani) { if (o->chan->cid.cid_ani) ast_free(o->chan->cid.cid_ani); o->chan->cid.cid_ani = ast_strdup(in->cid.cid_ani); } if (o->chan->cid.cid_rdnis) ast_free(o->chan->cid.cid_rdnis); o->chan->cid.cid_rdnis = ast_strdup(S_OR(in->macroexten, in->exten)); if (ast_call(o->chan, tmpchan, 0)) { ast_log(LOG_NOTICE, "Failed to dial on local channel for call forward to '%s'\n", tmpchan); do_hang(o); numnochan++; } } /* Hangup the original channel now, in case we needed it */ ast_hangup(winner); continue; } f = ast_read(winner); if (f) { if (f->frametype == AST_FRAME_CONTROL) { switch (f->subclass) { case AST_CONTROL_ANSWER: /* This is our guy if someone answered. */ if (!peer) { ast_verb(3, "%s answered %s\n", o->chan->name, in->name); peer = o; } break; case AST_CONTROL_BUSY: ast_verb(3, "%s is busy\n", o->chan->name); if (in->cdr) ast_cdr_busy(in->cdr); do_hang(o); endtime = (long) time(NULL); endtime -= starttime; rna(endtime*1000, qe, on, membername); if (qe->parent->strategy != QUEUE_STRATEGY_RINGALL) { if (qe->parent->timeoutrestart) *to = orig; ring_one(qe, outgoing, &numbusies); } numbusies++; break; case AST_CONTROL_CONGESTION: ast_verb(3, "%s is circuit-busy\n", o->chan->name); if (in->cdr) ast_cdr_busy(in->cdr); endtime = (long) time(NULL); endtime -= starttime; rna(endtime*1000, qe, on, membername); do_hang(o); if (qe->parent->strategy != QUEUE_STRATEGY_RINGALL) { if (qe->parent->timeoutrestart) *to = orig; ring_one(qe, outgoing, &numbusies); } numbusies++; break; case AST_CONTROL_RINGING: ast_verb(3, "%s is ringing\n", o->chan->name); if (!sentringing) { #if 0 ast_indicate(in, AST_CONTROL_RINGING); #endif sentringing++; } break; case AST_CONTROL_OFFHOOK: /* Ignore going off hook */ break; default: ast_debug(1, "Dunno what to do with control type %d\n", f->subclass); } } ast_frfree(f); } else { endtime = (long) time(NULL) - starttime; rna(endtime * 1000, qe, on, membername); do_hang(o); if (qe->parent->strategy != QUEUE_STRATEGY_RINGALL) { if (qe->parent->timeoutrestart) *to = orig; ring_one(qe, outgoing, &numbusies); } } } } if (winner == in) { f = ast_read(in); if (!f || ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_HANGUP))) { /* Got hung up */ *to = -1; if (f) { ast_frfree(f); } return NULL; } if ((f->frametype == AST_FRAME_DTMF) && caller_disconnect && (f->subclass == '*')) { ast_verb(3, "User hit %c to disconnect call.\n", f->subclass); *to = 0; ast_frfree(f); return NULL; } if ((f->frametype == AST_FRAME_DTMF) && valid_exit(qe, f->subclass)) { ast_verb(3, "User pressed digit: %c\n", f->subclass); *to = 0; *digit = f->subclass; ast_frfree(f); return NULL; } ast_frfree(f); } if (!*to) rna(orig, qe, on, membername); } #ifdef HAVE_EPOLL for(epollo = outgoing; epollo; epollo = epollo->q_next) { if(epollo->chan) ast_poll_channel_del(in, epollo->chan); } #endif return peer; } static int is_our_turn(struct queue_ent *qe) { struct queue_ent *ch; struct member *cur; int avl = 0; int idx = 0; int res; if (!qe->parent->autofill) { /* Atomically read the parent head -- does not need a lock */ ch = qe->parent->head; /* If we are now at the top of the head, break out */ if (ch == qe) { ast_debug(1, "It's our turn (%s).\n", qe->chan->name); res = 1; } else { ast_debug(1, "It's not our turn (%s).\n", qe->chan->name); res = 0; } } else { /* This needs a lock. How many members are available to be served? */ ao2_lock(qe->parent); ch = qe->parent->head; if (qe->parent->strategy == QUEUE_STRATEGY_RINGALL) { ast_debug(1, "Even though there are %d available members, the strategy is ringall so only the head call is allowed in\n", avl); avl = 1; } else { struct ao2_iterator mem_iter = ao2_iterator_init(qe->parent->members, 0); while ((cur = ao2_iterator_next(&mem_iter))) { switch (cur->status) { case AST_DEVICE_NOT_INUSE: case AST_DEVICE_UNKNOWN: if (!cur->paused) avl++; break; } ao2_ref(cur, -1); } } ast_debug(1, "There are %d available members.\n", avl); while ((idx < avl) && (ch) && (ch != qe)) { idx++; ch = ch->next; } /* If the queue entry is within avl [the number of available members] calls from the top ... */ if (ch && idx < avl) { ast_debug(1, "It's our turn (%s).\n", qe->chan->name); res = 1; } else { ast_debug(1, "It's not our turn (%s).\n", qe->chan->name); res = 0; } ao2_unlock(qe->parent); } return res; } static int wait_our_turn(struct queue_ent *qe, int ringing, enum queue_result *reason) { int res = 0; /* This is the holding pen for callers 2 through maxlen */ for (;;) { enum queue_member_status stat; if (is_our_turn(qe)) break; /* If we have timed out, break out */ if (qe->expire && (time(NULL) > qe->expire)) { *reason = QUEUE_TIMEOUT; break; } stat = get_member_status(qe->parent, qe->max_penalty); /* leave the queue if no agents, if enabled */ if (qe->parent->leavewhenempty && (stat == QUEUE_NO_MEMBERS)) { *reason = QUEUE_LEAVEEMPTY; ast_queue_log(qe->parent->name, qe->chan->uniqueid, "NONE", "EXITEMPTY", "%d|%d|%ld", qe->pos, qe->opos, (long) time(NULL) - qe->start); leave_queue(qe); break; } /* leave the queue if no reachable agents, if enabled */ if ((qe->parent->leavewhenempty == QUEUE_EMPTY_STRICT) && (stat == QUEUE_NO_REACHABLE_MEMBERS || stat == QUEUE_NO_UNPAUSED_REACHABLE_MEMBERS)) { *reason = QUEUE_LEAVEUNAVAIL; ast_queue_log(qe->parent->name, qe->chan->uniqueid, "NONE", "EXITEMPTY", "%d|%d|%ld", qe->pos, qe->opos, (long) time(NULL) - qe->start); leave_queue(qe); break; } if ((qe->parent->leavewhenempty == QUEUE_EMPTY_LOOSE) && (stat == QUEUE_NO_REACHABLE_MEMBERS)) { *reason = QUEUE_LEAVEUNAVAIL; ast_queue_log(qe->parent->name, qe->chan->uniqueid, "NONE", "EXITEMPTY", "%d|%d|%ld", qe->pos, qe->opos, (long) time(NULL) - qe->start); leave_queue(qe); break; } /* Make a position announcement, if enabled */ if (qe->parent->announcefrequency && (res = say_position(qe,ringing))) break; /* Make a periodic announcement, if enabled */ if (qe->parent->periodicannouncefrequency && (res = say_periodic_announcement(qe,ringing))) break; /* Wait a second before checking again */ if ((res = ast_waitfordigit(qe->chan, RECHECK * 1000))) { if (res > 0 && !valid_exit(qe, res)) res = 0; else break; } } return res; } static int update_queue(struct call_queue *q, struct member *member, int callcompletedinsl) { struct member *mem; struct call_queue *qtmp; struct ao2_iterator queue_iter; if (shared_lastcall) { queue_iter = ao2_iterator_init(queues, 0); while ((qtmp = ao2_iterator_next(&queue_iter))) { ao2_lock(qtmp); if ((mem = ao2_find(qtmp->members, member, OBJ_POINTER))) { time(&mem->lastcall); mem->calls++; mem->lastqueue = q; ao2_ref(mem, -1); } ao2_unlock(qtmp); ao2_ref(qtmp, -1); } } else { ao2_lock(q); time(&member->lastcall); member->calls++; member->lastqueue = q; ao2_unlock(q); } ao2_lock(q); q->callscompleted++; if (callcompletedinsl) q->callscompletedinsl++; ao2_unlock(q); return 0; } static int calc_metric(struct call_queue *q, struct member *mem, int pos, struct queue_ent *qe, struct callattempt *tmp) { if (qe->max_penalty && (mem->penalty > qe->max_penalty)) return -1; switch (q->strategy) { case QUEUE_STRATEGY_RINGALL: /* Everyone equal, except for penalty */ tmp->metric = mem->penalty * 1000000; break; case QUEUE_STRATEGY_LINEAR: if (pos < qe->linpos) { tmp->metric = 1000 + pos; } else { if (pos > qe->linpos) /* Indicate there is another priority */ qe->linwrapped = 1; tmp->metric = pos; } tmp->metric += mem->penalty * 1000000; break; case QUEUE_STRATEGY_RRMEMORY: if (pos < q->rrpos) { tmp->metric = 1000 + pos; } else { if (pos > q->rrpos) /* Indicate there is another priority */ q->wrapped = 1; tmp->metric = pos; } tmp->metric += mem->penalty * 1000000; break; case QUEUE_STRATEGY_RANDOM: tmp->metric = ast_random() % 1000; tmp->metric += mem->penalty * 1000000; break; case QUEUE_STRATEGY_WRANDOM: tmp->metric = ast_random() % ((1 + mem->penalty) * 1000); break; case QUEUE_STRATEGY_FEWESTCALLS: tmp->metric = mem->calls; tmp->metric += mem->penalty * 1000000; break; case QUEUE_STRATEGY_LEASTRECENT: if (!mem->lastcall) tmp->metric = 0; else tmp->metric = 1000000 - (time(NULL) - mem->lastcall); tmp->metric += mem->penalty * 1000000; break; default: ast_log(LOG_WARNING, "Can't calculate metric for unknown strategy %d\n", q->strategy); break; } return 0; } enum agent_complete_reason { CALLER, AGENT, TRANSFER }; static void send_agent_complete(const struct queue_ent *qe, const char *queuename, const struct ast_channel *peer, const struct member *member, time_t callstart, char *vars, size_t vars_len, enum agent_complete_reason rsn) { const char *reason = NULL; /* silence dumb compilers */ if (!qe->parent->eventwhencalled) return; switch (rsn) { case CALLER: reason = "caller"; break; case AGENT: reason = "agent"; break; case TRANSFER: reason = "transfer"; break; } manager_event(EVENT_FLAG_AGENT, "AgentComplete", "Queue: %s\r\n" "Uniqueid: %s\r\n" "Channel: %s\r\n" "Member: %s\r\n" "MemberName: %s\r\n" "HoldTime: %ld\r\n" "TalkTime: %ld\r\n" "Reason: %s\r\n" "%s", queuename, qe->chan->uniqueid, peer->name, member->interface, member->membername, (long)(callstart - qe->start), (long)(time(NULL) - callstart), reason, qe->parent->eventwhencalled == QUEUE_EVENT_VARIABLES ? vars2manager(qe->chan, vars, vars_len) : ""); } static int try_calling(struct queue_ent *qe, const char *options, char *announceoverride, const char *url, int *tries, int *noption, const char *agi, const char *macro, const char *gosub, int ringing) { struct member *cur; struct callattempt *outgoing = NULL; /* the list of calls we are building */ int to, orig; char oldexten[AST_MAX_EXTENSION]=""; char oldcontext[AST_MAX_CONTEXT]=""; char queuename[256]=""; char interfacevar[256]=""; struct ast_channel *peer; struct ast_channel *which; struct callattempt *lpeer; struct member *member; struct ast_app *app; int res = 0, bridge = 0; int numbusies = 0; int x=0; char *announce = NULL; char digit = 0; time_t callstart; time_t now = time(NULL); struct ast_bridge_config bridge_config; char nondataquality = 1; char *agiexec = NULL; char *macroexec = NULL; char *gosubexec = NULL; int ret = 0; const char *monitorfilename; const char *monitor_exec; const char *monitor_options; char tmpid[256], tmpid2[256]; char meid[1024], meid2[1024]; char mixmonargs[1512]; struct ast_app *mixmonapp = NULL; char *p; char vars[2048]; int forwardsallowed = 1; int callcompletedinsl; struct ao2_iterator memi; memset(&bridge_config, 0, sizeof(bridge_config)); tmpid[0] = 0; meid[0] = 0; time(&now); for (; options && *options; options++) switch (*options) { case 't': ast_set_flag(&(bridge_config.features_callee), AST_FEATURE_REDIRECT); break; case 'T': ast_set_flag(&(bridge_config.features_caller), AST_FEATURE_REDIRECT); break; case 'w': ast_set_flag(&(bridge_config.features_callee), AST_FEATURE_AUTOMON); break; case 'W': ast_set_flag(&(bridge_config.features_caller), AST_FEATURE_AUTOMON); break; case 'd': nondataquality = 0; break; case 'h': ast_set_flag(&(bridge_config.features_callee), AST_FEATURE_DISCONNECT); break; case 'H': ast_set_flag(&(bridge_config.features_caller), AST_FEATURE_DISCONNECT); break; case 'k': ast_set_flag(&(bridge_config.features_callee), AST_FEATURE_PARKCALL); break; case 'K': ast_set_flag(&(bridge_config.features_caller), AST_FEATURE_PARKCALL); break; case 'n': if (qe->parent->strategy == QUEUE_STRATEGY_RRMEMORY || qe->parent->strategy == QUEUE_STRATEGY_LINEAR) (*tries)++; else *tries = qe->parent->membercount; *noption = 1; break; case 'i': forwardsallowed = 0; break; } /* Hold the lock while we setup the outgoing calls */ if (use_weight) ao2_lock(queues); ao2_lock(qe->parent); ast_debug(1, "%s is trying to call a queue member.\n", qe->chan->name); ast_copy_string(queuename, qe->parent->name, sizeof(queuename)); if (!ast_strlen_zero(qe->announce)) announce = qe->announce; if (!ast_strlen_zero(announceoverride)) announce = announceoverride; memi = ao2_iterator_init(qe->parent->members, 0); while ((cur = ao2_iterator_next(&memi))) { struct callattempt *tmp = ast_calloc(1, sizeof(*tmp)); if (!tmp) { ao2_ref(cur, -1); ao2_unlock(qe->parent); if (use_weight) ao2_unlock(queues); goto out; } tmp->stillgoing = -1; tmp->member = cur; tmp->oldstatus = cur->status; tmp->lastcall = cur->lastcall; tmp->lastqueue = cur->lastqueue; ast_copy_string(tmp->interface, cur->interface, sizeof(tmp->interface)); /* Special case: If we ring everyone, go ahead and ring them, otherwise just calculate their metric for the appropriate strategy */ if (!calc_metric(qe->parent, cur, x++, qe, tmp)) { /* Put them in the list of outgoing thingies... We're ready now. XXX If we're forcibly removed, these outgoing calls won't get hung up XXX */ tmp->q_next = outgoing; outgoing = tmp; /* If this line is up, don't try anybody else */ if (outgoing->chan && (outgoing->chan->_state == AST_STATE_UP)) break; } else { ao2_ref(cur, -1); free(tmp); } } if (qe->expire && (!qe->parent->timeout || (qe->expire - now) <= qe->parent->timeout)) to = (qe->expire - now) * 1000; else to = (qe->parent->timeout) ? qe->parent->timeout * 1000 : -1; orig = to; ring_one(qe, outgoing, &numbusies); ao2_unlock(qe->parent); if (use_weight) ao2_unlock(queues); lpeer = wait_for_answer(qe, outgoing, &to, &digit, numbusies, ast_test_flag(&(bridge_config.features_caller), AST_FEATURE_DISCONNECT), forwardsallowed); ao2_lock(qe->parent); if (qe->parent->strategy == QUEUE_STRATEGY_RRMEMORY) { store_next_rr(qe, outgoing); } if (qe->parent->strategy == QUEUE_STRATEGY_LINEAR) { store_next_lin(qe, outgoing); } ao2_unlock(qe->parent); peer = lpeer ? lpeer->chan : NULL; if (!peer) { if (to) { /* Must gotten hung up */ res = -1; } else { /* User exited by pressing a digit */ res = digit; } if (res == -1) ast_debug(1, "%s: Nobody answered.\n", qe->chan->name); } else { /* peer is valid */ /* Ah ha! Someone answered within the desired timeframe. Of course after this we will always return with -1 so that it is hung up properly after the conversation. */ qe->handled++; if (!strcmp(qe->chan->tech->type, "Zap")) ast_channel_setoption(qe->chan, AST_OPTION_TONE_VERIFY, &nondataquality, sizeof(nondataquality), 0); if (!strcmp(peer->tech->type, "Zap")) ast_channel_setoption(peer, AST_OPTION_TONE_VERIFY, &nondataquality, sizeof(nondataquality), 0); /* Update parameters for the queue */ time(&now); recalc_holdtime(qe, (now - qe->start)); ao2_lock(qe->parent); callcompletedinsl = ((now - qe->start) <= qe->parent->servicelevel); ao2_unlock(qe->parent); member = lpeer->member; /* Increment the refcount for this member, since we're going to be using it for awhile in here. */ ao2_ref(member, 1); hangupcalls(outgoing, peer); outgoing = NULL; if (announce || qe->parent->reportholdtime || qe->parent->memberdelay) { int res2; res2 = ast_autoservice_start(qe->chan); if (!res2) { if (qe->parent->memberdelay) { ast_log(LOG_NOTICE, "Delaying member connect for %d seconds\n", qe->parent->memberdelay); res2 |= ast_safe_sleep(peer, qe->parent->memberdelay * 1000); } if (!res2 && announce) { play_file(peer, announce); } if (!res2 && qe->parent->reportholdtime) { if (!play_file(peer, qe->parent->sound_reporthold)) { int holdtime; time(&now); holdtime = abs((now - qe->start) / 60); if (holdtime < 2) { play_file(peer, qe->parent->sound_lessthan); ast_say_number(peer, 2, AST_DIGIT_ANY, peer->language, NULL); } else ast_say_number(peer, holdtime, AST_DIGIT_ANY, peer->language, NULL); play_file(peer, qe->parent->sound_minutes); } } } res2 |= ast_autoservice_stop(qe->chan); if (ast_check_hangup(peer)) { /* Agent must have hung up */ ast_log(LOG_WARNING, "Agent on %s hungup on the customer.\n", peer->name); ast_queue_log(queuename, qe->chan->uniqueid, member->membername, "AGENTDUMP", "%s", ""); record_abandoned(qe); if (qe->parent->eventwhencalled) manager_event(EVENT_FLAG_AGENT, "AgentDump", "Queue: %s\r\n" "Uniqueid: %s\r\n" "Channel: %s\r\n" "Member: %s\r\n" "MemberName: %s\r\n" "%s", queuename, qe->chan->uniqueid, peer->name, member->interface, member->membername, qe->parent->eventwhencalled == QUEUE_EVENT_VARIABLES ? vars2manager(qe->chan, vars, sizeof(vars)) : ""); ast_hangup(peer); ao2_ref(member, -1); goto out; } else if (res2) { /* Caller must have hung up just before being connected*/ ast_log(LOG_NOTICE, "Caller was about to talk to agent on %s but the caller hungup.\n", peer->name); ast_queue_log(queuename, qe->chan->uniqueid, member->membername, "ABANDON", "%d|%d|%ld", qe->pos, qe->opos, (long) time(NULL) - qe->start); record_abandoned(qe); ast_hangup(peer); ao2_ref(member, -1); return -1; } } /* Stop music on hold */ if (ringing) ast_indicate(qe->chan,-1); else ast_moh_stop(qe->chan); /* If appropriate, log that we have a destination channel */ if (qe->chan->cdr) ast_cdr_setdestchan(qe->chan->cdr, peer->name); /* Make sure channels are compatible */ res = ast_channel_make_compatible(qe->chan, peer); if (res < 0) { ast_queue_log(queuename, qe->chan->uniqueid, member->membername, "SYSCOMPAT", "%s", ""); ast_log(LOG_WARNING, "Had to drop call because I couldn't make %s compatible with %s\n", qe->chan->name, peer->name); record_abandoned(qe); ast_hangup(peer); ao2_ref(member, -1); return -1; } /* Play announcement to the caller telling it's his turn if defined */ if (!ast_strlen_zero(qe->parent->sound_callerannounce)) { if (play_file(qe->chan, qe->parent->sound_callerannounce)) ast_log(LOG_WARNING, "Announcement file '%s' is unavailable, continuing anyway...\n", qe->parent->sound_callerannounce); } ao2_lock(qe->parent); /* if setinterfacevar is defined, make member variables available to the channel */ /* use pbx_builtin_setvar to set a load of variables with one call */ if (qe->parent->setinterfacevar) { snprintf(interfacevar,sizeof(interfacevar), "MEMBERINTERFACE=%s|MEMBERNAME=%s|MEMBERCALLS=%d|MEMBERLASTCALL=%ld|MEMBERPENALTY=%d|MEMBERDYNAMIC=%d|MEMBERREALTIME=%d", member->interface, member->membername, member->calls, (long)member->lastcall, member->penalty, member->dynamic, member->realtime); pbx_builtin_setvar(qe->chan, interfacevar); } /* if setqueueentryvar is defined, make queue entry (i.e. the caller) variables available to the channel */ /* use pbx_builtin_setvar to set a load of variables with one call */ if (qe->parent->setqueueentryvar) { snprintf(interfacevar,sizeof(interfacevar), "QEHOLDTIME=%ld|QEORIGINALPOS=%d", (long) time(NULL) - qe->start, qe->opos); pbx_builtin_setvar(qe->chan, interfacevar); } /* try to set queue variables if configured to do so*/ set_queue_variables(qe); ao2_unlock(qe->parent); /* Begin Monitoring */ if (qe->parent->monfmt && *qe->parent->monfmt) { if (!qe->parent->montype) { ast_debug(1, "Starting Monitor as requested.\n"); monitorfilename = pbx_builtin_getvar_helper(qe->chan, "MONITOR_FILENAME"); if (pbx_builtin_getvar_helper(qe->chan, "MONITOR_EXEC") || pbx_builtin_getvar_helper(qe->chan, "MONITOR_EXEC_ARGS")) which = qe->chan; else which = peer; if (monitorfilename) ast_monitor_start(which, qe->parent->monfmt, monitorfilename, 1, X_REC_IN | X_REC_OUT); else if (qe->chan->cdr) ast_monitor_start(which, qe->parent->monfmt, qe->chan->cdr->uniqueid, 1, X_REC_IN | X_REC_OUT); else { /* Last ditch effort -- no CDR, make up something */ snprintf(tmpid, sizeof(tmpid), "chan-%lx", ast_random()); ast_monitor_start(which, qe->parent->monfmt, tmpid, 1, X_REC_IN | X_REC_OUT); } } else { ast_debug(1, "Starting MixMonitor as requested.\n"); monitorfilename = pbx_builtin_getvar_helper(qe->chan, "MONITOR_FILENAME"); if (!monitorfilename) { if (qe->chan->cdr) ast_copy_string(tmpid, qe->chan->cdr->uniqueid, sizeof(tmpid)); else snprintf(tmpid, sizeof(tmpid), "chan-%lx", ast_random()); } else { const char *m = monitorfilename; for (p = tmpid2; p < tmpid2 + sizeof(tmpid2) - 1; p++, m++) { switch (*m) { case '^': if (*(m + 1) == '{') *p = '$'; break; case ',': *p++ = '\\'; /* Fall through */ default: *p = *m; } if (*m == '\0') break; } if (p == tmpid2 + sizeof(tmpid2)) tmpid2[sizeof(tmpid2) - 1] = '\0'; pbx_substitute_variables_helper(qe->chan, tmpid2, tmpid, sizeof(tmpid) - 1); } monitor_exec = pbx_builtin_getvar_helper(qe->chan, "MONITOR_EXEC"); monitor_options = pbx_builtin_getvar_helper(qe->chan, "MONITOR_OPTIONS"); if (monitor_exec) { const char *m = monitor_exec; for (p = meid2; p < meid2 + sizeof(meid2) - 1; p++, m++) { switch (*m) { case '^': if (*(m + 1) == '{') *p = '$'; break; case ',': *p++ = '\\'; /* Fall through */ default: *p = *m; } if (*m == '\0') break; } if (p == meid2 + sizeof(meid2)) meid2[sizeof(meid2) - 1] = '\0'; pbx_substitute_variables_helper(qe->chan, meid2, meid, sizeof(meid) - 1); } snprintf(tmpid2, sizeof(tmpid2), "%s.%s", tmpid, qe->parent->monfmt); mixmonapp = pbx_findapp("MixMonitor"); if (!monitor_options) monitor_options = ""; if (mixmonapp) { if (!ast_strlen_zero(monitor_exec)) snprintf(mixmonargs, sizeof(mixmonargs), "%s,b%s,%s", tmpid2, monitor_options, monitor_exec); else snprintf(mixmonargs, sizeof(mixmonargs), "%s,b%s", tmpid2, monitor_options); ast_debug(1, "Arguments being passed to MixMonitor: %s\n", mixmonargs); /* We purposely lock the CDR so that pbx_exec does not update the application data */ if (qe->chan->cdr) ast_set_flag(qe->chan->cdr, AST_CDR_FLAG_LOCKED); ret = pbx_exec(qe->chan, mixmonapp, mixmonargs); if (qe->chan->cdr) ast_clear_flag(qe->chan->cdr, AST_CDR_FLAG_LOCKED); } else ast_log(LOG_WARNING, "Asked to run MixMonitor on this call, but cannot find the MixMonitor app!\n"); } } /* Drop out of the queue at this point, to prepare for next caller */ leave_queue(qe); if (!ast_strlen_zero(url) && ast_channel_supports_html(peer)) { ast_debug(1, "app_queue: sendurl=%s.\n", url); ast_channel_sendurl(peer, url); } /* run a macro for this connection if defined. The macro simply returns, no action is taken on the result */ /* use macro from dialplan if passed as a option, otherwise use the default queue macro */ if (!ast_strlen_zero(macro)) { macroexec = ast_strdupa(macro); } else { if (qe->parent->membermacro) macroexec = ast_strdupa(qe->parent->membermacro); } if (!ast_strlen_zero(macroexec)) { ast_debug(1, "app_queue: macro=%s.\n", macroexec); res = ast_autoservice_start(qe->chan); if (res) { ast_log(LOG_ERROR, "Unable to start autoservice on calling channel\n"); res = -1; } app = pbx_findapp("Macro"); if (app) { res = pbx_exec(qe->chan, app, macroexec); ast_debug(1, "Macro exited with status %d\n", res); res = 0; } else { ast_log(LOG_ERROR, "Could not find application Macro\n"); res = -1; } if (ast_autoservice_stop(qe->chan) < 0) { ast_log(LOG_ERROR, "Could not stop autoservice on calling channel\n"); res = -1; } } /* run a gosub for this connection if defined. The gosub simply returns, no action is taken on the result */ /* use gosub from dialplan if passed as a option, otherwise use the default queue gosub */ if (!ast_strlen_zero(gosub)) { gosubexec = ast_strdupa(gosub); } else { if (qe->parent->membergosub) gosubexec = ast_strdupa(qe->parent->membergosub); } if (!ast_strlen_zero(gosubexec)) { if (option_debug) ast_log(LOG_DEBUG, "app_queue: gosub=%s.\n", gosubexec); res = ast_autoservice_start(qe->chan); if (res) { ast_log(LOG_ERROR, "Unable to start autoservice on calling channel\n"); res = -1; } app = pbx_findapp("Gosub"); if (app) { char *gosub_args, *gosub_argstart; /* Set where we came from */ ast_copy_string(qe->chan->context, "app_dial_gosub_virtual_context", sizeof(qe->chan->context)); ast_copy_string(qe->chan->exten, "s", sizeof(qe->chan->exten)); qe->chan->priority = 0; gosub_argstart = strchr(gosubexec, ','); if (gosub_argstart) { *gosub_argstart = 0; asprintf(&gosub_args, "%s,s,1(%s)", gosubexec, gosub_argstart + 1); *gosub_argstart = '|'; } else { asprintf(&gosub_args, "%s,s,1", gosubexec); } if (gosub_args) { res = pbx_exec(qe->chan, app, gosub_args); ast_pbx_run(qe->chan); free(gosub_args); if (option_debug) ast_log(LOG_DEBUG, "Gosub exited with status %d\n", res); } else ast_log(LOG_ERROR, "Could not Allocate string for Gosub arguments -- Gosub Call Aborted!\n"); res = 0; } else { ast_log(LOG_ERROR, "Could not find application Gosub\n"); res = -1; } if (ast_autoservice_stop(qe->chan) < 0) { ast_log(LOG_ERROR, "Could not stop autoservice on calling channel\n"); res = -1; } } if (!ast_strlen_zero(agi)) { ast_debug(1, "app_queue: agi=%s.\n", agi); app = pbx_findapp("agi"); if (app) { agiexec = ast_strdupa(agi); ret = pbx_exec(qe->chan, app, agiexec); } else ast_log(LOG_WARNING, "Asked to execute an AGI on this channel, but could not find application (agi)!\n"); } ast_queue_log(queuename, qe->chan->uniqueid, member->membername, "CONNECT", "%ld|%s|%ld", (long) time(NULL) - qe->start, peer->uniqueid, (long)(orig - to > 0 ? (orig - to) / 1000 : 0)); if (update_cdr && qe->chan->cdr) ast_copy_string(qe->chan->cdr->dstchannel, member->membername, sizeof(qe->chan->cdr->dstchannel)); if (qe->parent->eventwhencalled) manager_event(EVENT_FLAG_AGENT, "AgentConnect", "Queue: %s\r\n" "Uniqueid: %s\r\n" "Channel: %s\r\n" "Member: %s\r\n" "MemberName: %s\r\n" "Holdtime: %ld\r\n" "BridgedChannel: %s\r\n" "Ringtime: %ld\r\n" "%s", queuename, qe->chan->uniqueid, peer->name, member->interface, member->membername, (long) time(NULL) - qe->start, peer->uniqueid, (long)(orig - to > 0 ? (orig - to) / 1000 : 0), qe->parent->eventwhencalled == QUEUE_EVENT_VARIABLES ? vars2manager(qe->chan, vars, sizeof(vars)) : ""); ast_copy_string(oldcontext, qe->chan->context, sizeof(oldcontext)); ast_copy_string(oldexten, qe->chan->exten, sizeof(oldexten)); time(&callstart); bridge = ast_bridge_call(qe->chan,peer, &bridge_config); if (strcasecmp(oldcontext, qe->chan->context) || strcasecmp(oldexten, qe->chan->exten)) { ast_queue_log(queuename, qe->chan->uniqueid, member->membername, "TRANSFER", "%s|%s|%ld|%ld", qe->chan->exten, qe->chan->context, (long) (callstart - qe->start), (long) (time(NULL) - callstart)); send_agent_complete(qe, queuename, peer, member, callstart, vars, sizeof(vars), TRANSFER); } else if (ast_check_hangup(qe->chan)) { ast_queue_log(queuename, qe->chan->uniqueid, member->membername, "COMPLETECALLER", "%ld|%ld|%d", (long) (callstart - qe->start), (long) (time(NULL) - callstart), qe->opos); send_agent_complete(qe, queuename, peer, member, callstart, vars, sizeof(vars), CALLER); } else { ast_queue_log(queuename, qe->chan->uniqueid, member->membername, "COMPLETEAGENT", "%ld|%ld|%d", (long) (callstart - qe->start), (long) (time(NULL) - callstart), qe->opos); send_agent_complete(qe, queuename, peer, member, callstart, vars, sizeof(vars), AGENT); } if (bridge != AST_PBX_NO_HANGUP_PEER) ast_hangup(peer); update_queue(qe->parent, member, callcompletedinsl); res = bridge ? bridge : 1; ao2_ref(member, -1); } out: hangupcalls(outgoing, NULL); return res; } static int wait_a_bit(struct queue_ent *qe) { /* Don't need to hold the lock while we setup the outgoing calls */ int retrywait = qe->parent->retry * 1000; int res = ast_waitfordigit(qe->chan, retrywait); if (res > 0 && !valid_exit(qe, res)) res = 0; return res; } static struct member *interface_exists(struct call_queue *q, const char *interface) { struct member *mem; struct ao2_iterator mem_iter; if (!q) return NULL; mem_iter = ao2_iterator_init(q->members, 0); while ((mem = ao2_iterator_next(&mem_iter))) { if (!strcasecmp(interface, mem->interface)) return mem; ao2_ref(mem, -1); } return NULL; } /* Dump all members in a specific queue to the database * * / = ;;[|...] * */ static void dump_queue_members(struct call_queue *pm_queue) { struct member *cur_member; char value[PM_MAX_LEN]; int value_len = 0; int res; struct ao2_iterator mem_iter; memset(value, 0, sizeof(value)); if (!pm_queue) return; mem_iter = ao2_iterator_init(pm_queue->members, 0); while ((cur_member = ao2_iterator_next(&mem_iter))) { if (!cur_member->dynamic) { ao2_ref(cur_member, -1); continue; } res = snprintf(value + value_len, sizeof(value) - value_len, "%s%s;%d;%d;%s", value_len ? "|" : "", cur_member->interface, cur_member->penalty, cur_member->paused, cur_member->membername); ao2_ref(cur_member, -1); if (res != strlen(value + value_len)) { ast_log(LOG_WARNING, "Could not create persistent member string, out of space\n"); break; } value_len += res; } if (value_len && !cur_member) { if (ast_db_put(pm_family, pm_queue->name, value)) ast_log(LOG_WARNING, "failed to create persistent dynamic entry!\n"); } else /* Delete the entry if the queue is empty or there is an error */ ast_db_del(pm_family, pm_queue->name); } static int remove_from_queue(const char *queuename, const char *interface) { struct call_queue *q, tmpq = { .name = queuename, }; struct member *mem, tmpmem; int res = RES_NOSUCHQUEUE; ast_copy_string(tmpmem.interface, interface, sizeof(tmpmem.interface)); if ((q = ao2_find(queues, &tmpq, OBJ_POINTER))) { ao2_lock(q); if ((mem = ao2_find(q->members, &tmpmem, OBJ_POINTER))) { /* XXX future changes should beware of this assumption!! */ if(!mem->dynamic) { ao2_ref(mem, -1); ao2_unlock(q); return RES_NOT_DYNAMIC; } q->membercount--; manager_event(EVENT_FLAG_AGENT, "QueueMemberRemoved", "Queue: %s\r\n" "Location: %s\r\n" "MemberName: %s\r\n", q->name, mem->interface, mem->membername); ao2_unlink(q->members, mem); ao2_ref(mem, -1); if (queue_persistent_members) dump_queue_members(q); res = RES_OKAY; } else { res = RES_EXISTS; } ao2_unlock(q); queue_unref(q); } if (res == RES_OKAY) remove_from_interfaces(interface); return res; } static int add_to_queue(const char *queuename, const char *interface, const char *membername, int penalty, int paused, int dump) { struct call_queue *q; struct member *new_member, *old_member; int res = RES_NOSUCHQUEUE; /* \note Ensure the appropriate realtime queue is loaded. Note that this * short-circuits if the queue is already in memory. */ if (!(q = load_realtime_queue(queuename))) return res; ao2_lock(queues); ao2_lock(q); if ((old_member = interface_exists(q, interface)) == NULL) { add_to_interfaces(interface); if ((new_member = create_queue_member(interface, membername, penalty, paused))) { new_member->dynamic = 1; ao2_link(q->members, new_member); q->membercount++; manager_event(EVENT_FLAG_AGENT, "QueueMemberAdded", "Queue: %s\r\n" "Location: %s\r\n" "MemberName: %s\r\n" "Membership: %s\r\n" "Penalty: %d\r\n" "CallsTaken: %d\r\n" "LastCall: %d\r\n" "Status: %d\r\n" "Paused: %d\r\n", q->name, new_member->interface, new_member->membername, "dynamic", new_member->penalty, new_member->calls, (int) new_member->lastcall, new_member->status, new_member->paused); if (dump) dump_queue_members(q); res = RES_OKAY; } else { res = RES_OUTOFMEMORY; } } else { ao2_ref(old_member, -1); res = RES_EXISTS; } ao2_unlock(q); ao2_unlock(queues); return res; } static int set_member_paused(const char *queuename, const char *interface, const char *reason, int paused) { int found = 0; struct call_queue *q; struct member *mem; struct ao2_iterator queue_iter; /* Special event for when all queues are paused - individual events still generated */ /* XXX In all other cases, we use the membername, but since this affects all queues, we cannot */ if (ast_strlen_zero(queuename)) ast_queue_log("NONE", "NONE", interface, (paused ? "PAUSEALL" : "UNPAUSEALL"), "%s", ""); queue_iter = ao2_iterator_init(queues, 0); while((q = ao2_iterator_next(&queue_iter))) { ao2_lock(q); if (ast_strlen_zero(queuename) || !strcasecmp(q->name, queuename)) { if ((mem = interface_exists(q, interface))) { found++; if (mem->paused == paused) { ast_debug(1, "%spausing already-%spaused queue member %s:%s\n", (paused ? "" : "un"), (paused ? "" : "un"), q->name, interface); } mem->paused = paused; if (queue_persistent_members) dump_queue_members(q); if(mem->realtime) update_realtime_member_field(mem, q->name, "paused", paused ? "1" : "0"); ast_queue_log(q->name, "NONE", mem->membername, (paused ? "PAUSE" : "UNPAUSE"), "%s", S_OR(reason, "")); if (!ast_strlen_zero(reason)) { manager_event(EVENT_FLAG_AGENT, "QueueMemberPaused", "Queue: %s\r\n" "Location: %s\r\n" "MemberName: %s\r\n" "Paused: %d\r\n" "Reason: %s\r\n", q->name, mem->interface, mem->membername, paused, reason); } else { manager_event(EVENT_FLAG_AGENT, "QueueMemberPaused", "Queue: %s\r\n" "Location: %s\r\n" "MemberName: %s\r\n" "Paused: %d\r\n", q->name, mem->interface, mem->membername, paused); } ao2_ref(mem, -1); } } ao2_unlock(q); queue_unref(q); } return found ? RESULT_SUCCESS : RESULT_FAILURE; } /* \brief Sets members penalty, if queuename=NULL we set member penalty in all the queues. */ static int set_member_penalty(char *queuename, char *interface, int penalty) { int foundinterface = 0, foundqueue = 0; struct call_queue *q; struct member *mem; struct ao2_iterator queue_iter; queue_iter = ao2_iterator_init(queues, 0); while ((q = ao2_iterator_next(&queue_iter))) { ao2_lock(q); if (ast_strlen_zero(queuename) || !strcasecmp(q->name, queuename)) { foundqueue++; if ((mem = interface_exists(q, interface))) { foundinterface++; mem->penalty = penalty; ast_queue_log(q->name, "NONE", interface, "PENALTY", "%d", penalty); manager_event(EVENT_FLAG_AGENT, "QueueMemberPenalty", "Queue: %s\r\n" "Location: %s\r\n" "Penalty: %d\r\n", q->name, mem->interface, penalty); } } ao2_unlock(q); queue_unref(q); } if (foundinterface) { return RESULT_SUCCESS; } else if (foundqueue) { ast_log (LOG_ERROR, "Invalid queuename\n"); } else { ast_log (LOG_ERROR, "Invalid interface\n"); } return RESULT_FAILURE; } /* \brief Gets members penalty. * * \return Return the members penalty or RESULT_FAILURE on error. */ static int get_member_penalty(char *queuename, char *interface) { int foundqueue = 0, penalty; struct call_queue *q, tmpq = { .name = queuename, }; struct member *mem; if ((q = ao2_find(queues, &tmpq, OBJ_POINTER))) { foundqueue = 1; ao2_lock(q); if ((mem = interface_exists(q, interface))) { penalty = mem->penalty; ao2_unlock(q); queue_unref(q); return penalty; } ao2_unlock(q); queue_unref(q); } /* some useful debuging */ if (foundqueue) ast_log (LOG_ERROR, "Invalid queuename\n"); else ast_log (LOG_ERROR, "Invalid interface\n"); return RESULT_FAILURE; } /* Reload dynamic queue members persisted into the astdb */ static void reload_queue_members(void) { char *cur_ptr; const char *queue_name; char *member; char *interface; char *membername = NULL; char *penalty_tok; int penalty = 0; char *paused_tok; int paused = 0; struct ast_db_entry *db_tree; struct ast_db_entry *entry; struct call_queue *cur_queue; char queue_data[PM_MAX_LEN]; ao2_lock(queues); /* Each key in 'pm_family' is the name of a queue */ db_tree = ast_db_gettree(pm_family, NULL); for (entry = db_tree; entry; entry = entry->next) { queue_name = entry->key + strlen(pm_family) + 2; { struct call_queue tmpq = { .name = queue_name, }; cur_queue = ao2_find(queues, &tmpq, OBJ_POINTER); } if (!cur_queue) cur_queue = load_realtime_queue(queue_name); if (!cur_queue) { /* If the queue no longer exists, remove it from the * database */ ast_log(LOG_WARNING, "Error loading persistent queue: '%s': it does not exist\n", queue_name); ast_db_del(pm_family, queue_name); continue; } if (ast_db_get(pm_family, queue_name, queue_data, PM_MAX_LEN)) { queue_unref(cur_queue); continue; } cur_ptr = queue_data; while ((member = strsep(&cur_ptr, ",|"))) { if (ast_strlen_zero(member)) continue; interface = strsep(&member, ";"); penalty_tok = strsep(&member, ";"); paused_tok = strsep(&member, ";"); membername = strsep(&member, ";"); if (!penalty_tok) { ast_log(LOG_WARNING, "Error parsing persistent member string for '%s' (penalty)\n", queue_name); break; } penalty = strtol(penalty_tok, NULL, 10); if (errno == ERANGE) { ast_log(LOG_WARNING, "Error converting penalty: %s: Out of range.\n", penalty_tok); break; } if (!paused_tok) { ast_log(LOG_WARNING, "Error parsing persistent member string for '%s' (paused)\n", queue_name); break; } paused = strtol(paused_tok, NULL, 10); if ((errno == ERANGE) || paused < 0 || paused > 1) { ast_log(LOG_WARNING, "Error converting paused: %s: Expected 0 or 1.\n", paused_tok); break; } if (ast_strlen_zero(membername)) membername = interface; ast_debug(1, "Reload Members: Queue: %s Member: %s Name: %s Penalty: %d Paused: %d\n", queue_name, interface, membername, penalty, paused); if (add_to_queue(queue_name, interface, membername, penalty, paused, 0) == RES_OUTOFMEMORY) { ast_log(LOG_ERROR, "Out of Memory when reloading persistent queue member\n"); break; } } queue_unref(cur_queue); } ao2_unlock(queues); if (db_tree) { ast_log(LOG_NOTICE, "Queue members successfully reloaded from database.\n"); ast_db_freetree(db_tree); } } static int pqm_exec(struct ast_channel *chan, void *data) { char *parse; AST_DECLARE_APP_ARGS(args, AST_APP_ARG(queuename); AST_APP_ARG(interface); AST_APP_ARG(options); AST_APP_ARG(reason); ); if (ast_strlen_zero(data)) { ast_log(LOG_WARNING, "PauseQueueMember requires an argument ([queuename]|interface[|options][|reason])\n"); return -1; } parse = ast_strdupa(data); AST_STANDARD_APP_ARGS(args, parse); if (ast_strlen_zero(args.interface)) { ast_log(LOG_WARNING, "Missing interface argument to PauseQueueMember ([queuename]|interface[|options[|reason]])\n"); return -1; } if (set_member_paused(args.queuename, args.interface, args.reason, 1)) { ast_log(LOG_WARNING, "Attempt to pause interface %s, not found\n", args.interface); pbx_builtin_setvar_helper(chan, "PQMSTATUS", "NOTFOUND"); return -1; } pbx_builtin_setvar_helper(chan, "PQMSTATUS", "PAUSED"); return 0; } static int upqm_exec(struct ast_channel *chan, void *data) { char *parse; AST_DECLARE_APP_ARGS(args, AST_APP_ARG(queuename); AST_APP_ARG(interface); AST_APP_ARG(options); AST_APP_ARG(reason); ); if (ast_strlen_zero(data)) { ast_log(LOG_WARNING, "UnpauseQueueMember requires an argument ([queuename]|interface[|options[|reason]])\n"); return -1; } parse = ast_strdupa(data); AST_STANDARD_APP_ARGS(args, parse); if (ast_strlen_zero(args.interface)) { ast_log(LOG_WARNING, "Missing interface argument to PauseQueueMember ([queuename]|interface[|options[|reason]])\n"); return -1; } if (set_member_paused(args.queuename, args.interface, args.reason, 0)) { ast_log(LOG_WARNING, "Attempt to unpause interface %s, not found\n", args.interface); pbx_builtin_setvar_helper(chan, "UPQMSTATUS", "NOTFOUND"); return -1; } pbx_builtin_setvar_helper(chan, "UPQMSTATUS", "UNPAUSED"); return 0; } static int rqm_exec(struct ast_channel *chan, void *data) { int res=-1; char *parse, *temppos = NULL; AST_DECLARE_APP_ARGS(args, AST_APP_ARG(queuename); AST_APP_ARG(interface); AST_APP_ARG(options); ); if (ast_strlen_zero(data)) { ast_log(LOG_WARNING, "RemoveQueueMember requires an argument (queuename[|interface[|options]])\n"); return -1; } parse = ast_strdupa(data); AST_STANDARD_APP_ARGS(args, parse); if (ast_strlen_zero(args.interface)) { args.interface = ast_strdupa(chan->name); temppos = strrchr(args.interface, '-'); if (temppos) *temppos = '\0'; } switch (remove_from_queue(args.queuename, args.interface)) { case RES_OKAY: ast_queue_log(args.queuename, chan->uniqueid, args.interface, "REMOVEMEMBER", "%s", ""); ast_log(LOG_NOTICE, "Removed interface '%s' from queue '%s'\n", args.interface, args.queuename); pbx_builtin_setvar_helper(chan, "RQMSTATUS", "REMOVED"); res = 0; break; case RES_EXISTS: ast_debug(1, "Unable to remove interface '%s' from queue '%s': Not there\n", args.interface, args.queuename); pbx_builtin_setvar_helper(chan, "RQMSTATUS", "NOTINQUEUE"); res = 0; break; case RES_NOSUCHQUEUE: ast_log(LOG_WARNING, "Unable to remove interface from queue '%s': No such queue\n", args.queuename); pbx_builtin_setvar_helper(chan, "RQMSTATUS", "NOSUCHQUEUE"); res = 0; break; case RES_NOT_DYNAMIC: ast_log(LOG_WARNING, "Unable to remove interface from queue '%s': '%s' is not a dynamic member\n", args.queuename, args.interface); pbx_builtin_setvar_helper(chan, "RQMSTATUS", "NOTDYNAMIC"); res = 0; break; } return res; } static int aqm_exec(struct ast_channel *chan, void *data) { int res=-1; char *parse, *temppos = NULL; AST_DECLARE_APP_ARGS(args, AST_APP_ARG(queuename); AST_APP_ARG(interface); AST_APP_ARG(penalty); AST_APP_ARG(options); AST_APP_ARG(membername); ); int penalty = 0; if (ast_strlen_zero(data)) { ast_log(LOG_WARNING, "AddQueueMember requires an argument (queuename[|[interface]|[penalty][|options][|membername]])\n"); return -1; } parse = ast_strdupa(data); AST_STANDARD_APP_ARGS(args, parse); if (ast_strlen_zero(args.interface)) { args.interface = ast_strdupa(chan->name); temppos = strrchr(args.interface, '-'); if (temppos) *temppos = '\0'; } if (!ast_strlen_zero(args.penalty)) { if ((sscanf(args.penalty, "%d", &penalty) != 1) || penalty < 0) { ast_log(LOG_WARNING, "Penalty '%s' is invalid, must be an integer >= 0\n", args.penalty); penalty = 0; } } switch (add_to_queue(args.queuename, args.interface, args.membername, penalty, 0, queue_persistent_members)) { case RES_OKAY: ast_queue_log(args.queuename, chan->uniqueid, args.interface, "ADDMEMBER", "%s", ""); ast_log(LOG_NOTICE, "Added interface '%s' to queue '%s'\n", args.interface, args.queuename); pbx_builtin_setvar_helper(chan, "AQMSTATUS", "ADDED"); res = 0; break; case RES_EXISTS: ast_log(LOG_WARNING, "Unable to add interface '%s' to queue '%s': Already there\n", args.interface, args.queuename); pbx_builtin_setvar_helper(chan, "AQMSTATUS", "MEMBERALREADY"); res = 0; break; case RES_NOSUCHQUEUE: ast_log(LOG_WARNING, "Unable to add interface to queue '%s': No such queue\n", args.queuename); pbx_builtin_setvar_helper(chan, "AQMSTATUS", "NOSUCHQUEUE"); res = 0; break; case RES_OUTOFMEMORY: ast_log(LOG_ERROR, "Out of memory adding member %s to queue %s\n", args.interface, args.queuename); break; } return res; } static int ql_exec(struct ast_channel *chan, void *data) { char *parse; AST_DECLARE_APP_ARGS(args, AST_APP_ARG(queuename); AST_APP_ARG(uniqueid); AST_APP_ARG(membername); AST_APP_ARG(event); AST_APP_ARG(params); ); if (ast_strlen_zero(data)) { ast_log(LOG_WARNING, "QueueLog requires arguments (queuename|uniqueid|membername|event[|additionalinfo]\n"); return -1; } parse = ast_strdupa(data); AST_STANDARD_APP_ARGS(args, parse); if (ast_strlen_zero(args.queuename) || ast_strlen_zero(args.uniqueid) || ast_strlen_zero(args.membername) || ast_strlen_zero(args.event)) { ast_log(LOG_WARNING, "QueueLog requires arguments (queuename|uniqueid|membername|event[|additionalinfo])\n"); return -1; } ast_queue_log(args.queuename, args.uniqueid, args.membername, args.event, "%s", args.params ? args.params : ""); return 0; } static int queue_exec(struct ast_channel *chan, void *data) { int res=-1; int ringing=0; const char *user_priority; const char *max_penalty_str; int prio; int qcontinue = 0; int max_penalty; enum queue_result reason = QUEUE_UNKNOWN; /* whether to exit Queue application after the timeout hits */ int tries = 0; int noption = 0; char *parse; int makeannouncement = 0; AST_DECLARE_APP_ARGS(args, AST_APP_ARG(queuename); AST_APP_ARG(options); AST_APP_ARG(url); AST_APP_ARG(announceoverride); AST_APP_ARG(queuetimeoutstr); AST_APP_ARG(agi); AST_APP_ARG(macro); AST_APP_ARG(gosub); ); /* Our queue entry */ struct queue_ent qe; if (ast_strlen_zero(data)) { ast_log(LOG_WARNING, "Queue requires an argument: queuename[|options[|URL[|announceoverride[|timeout[|agi]]]]]\n"); return -1; } parse = ast_strdupa(data); AST_STANDARD_APP_ARGS(args, parse); /* Setup our queue entry */ memset(&qe, 0, sizeof(qe)); qe.start = time(NULL); /* set the expire time based on the supplied timeout; */ if (args.queuetimeoutstr) qe.expire = qe.start + atoi(args.queuetimeoutstr); else qe.expire = 0; /* Get the priority from the variable ${QUEUE_PRIO} */ user_priority = pbx_builtin_getvar_helper(chan, "QUEUE_PRIO"); if (user_priority) { if (sscanf(user_priority, "%d", &prio) == 1) { ast_debug(1, "%s: Got priority %d from ${QUEUE_PRIO}.\n", chan->name, prio); } else { ast_log(LOG_WARNING, "${QUEUE_PRIO}: Invalid value (%s), channel %s.\n", user_priority, chan->name); prio = 0; } } else { ast_debug(3, "NO QUEUE_PRIO variable found. Using default.\n"); prio = 0; } /* Get the maximum penalty from the variable ${QUEUE_MAX_PENALTY} */ if ((max_penalty_str = pbx_builtin_getvar_helper(chan, "QUEUE_MAX_PENALTY"))) { if (sscanf(max_penalty_str, "%d", &max_penalty) == 1) { ast_debug(1, "%s: Got max penalty %d from ${QUEUE_MAX_PENALTY}.\n", chan->name, max_penalty); } else { ast_log(LOG_WARNING, "${QUEUE_MAX_PENALTY}: Invalid value (%s), channel %s.\n", max_penalty_str, chan->name); max_penalty = 0; } } else { max_penalty = 0; } if (args.options && (strchr(args.options, 'r'))) ringing = 1; if (args.options && (strchr(args.options, 'c'))) qcontinue = 1; ast_debug(1, "queue: %s, options: %s, url: %s, announce: %s, expires: %ld, priority: %d\n", args.queuename, args.options, args.url, args.announceoverride, (long)qe.expire, prio); qe.chan = chan; qe.prio = prio; qe.max_penalty = max_penalty; qe.last_pos_said = 0; qe.last_pos = 0; qe.last_periodic_announce_time = time(NULL); qe.last_periodic_announce_sound = 0; qe.valid_digits = 0; if (!join_queue(args.queuename, &qe, &reason)) { ast_queue_log(args.queuename, chan->uniqueid, "NONE", "ENTERQUEUE", "%s|%s", S_OR(args.url, ""), S_OR(chan->cid.cid_num, "")); check_turns: if (ringing) { ast_indicate(chan, AST_CONTROL_RINGING); } else { ast_moh_start(chan, qe.moh, NULL); } /* This is the wait loop for callers 2 through maxlen */ res = wait_our_turn(&qe, ringing, &reason); if (res) { goto stop; } makeannouncement = 0; for (;;) { /* This is the wait loop for the head caller*/ /* To exit, they may get their call answered; */ /* they may dial a digit from the queue context; */ /* or, they may timeout. */ enum queue_member_status stat; /* Leave if we have exceeded our queuetimeout */ if (qe.expire && (time(NULL) > qe.expire)) { record_abandoned(&qe); reason = QUEUE_TIMEOUT; res = 0; ast_queue_log(args.queuename, chan->uniqueid,"NONE", "EXITWITHTIMEOUT", "%d|%d|%ld", qe.pos, qe.opos, (long) time(NULL) - qe.start); break; } if (makeannouncement) { /* Make a position announcement, if enabled */ if (qe.parent->announcefrequency) if ((res = say_position(&qe,ringing))) goto stop; } makeannouncement = 1; /* Make a periodic announcement, if enabled */ if (qe.parent->periodicannouncefrequency) if ((res = say_periodic_announcement(&qe,ringing))) goto stop; /* Try calling all queue members for 'timeout' seconds */ res = try_calling(&qe, args.options, args.announceoverride, args.url, &tries, &noption, args.agi, args.macro, args.gosub, ringing); if (res) { goto stop; } stat = get_member_status(qe.parent, qe.max_penalty); /* exit after 'timeout' cycle if 'n' option enabled */ if (noption && tries >= qe.parent->membercount) { ast_verb(3, "Exiting on time-out cycle\n"); ast_queue_log(args.queuename, chan->uniqueid, "NONE", "EXITWITHTIMEOUT", "%d", qe.pos); record_abandoned(&qe); reason = QUEUE_TIMEOUT; res = 0; break; } /* leave the queue if no agents, if enabled */ if (qe.parent->leavewhenempty && (stat == QUEUE_NO_MEMBERS)) { record_abandoned(&qe); reason = QUEUE_LEAVEEMPTY; ast_queue_log(args.queuename, chan->uniqueid, "NONE", "EXITEMPTY", "%d|%d|%ld", qe.pos, qe.opos, (long)(time(NULL) - qe.start)); res = 0; break; } /* leave the queue if no reachable agents, if enabled */ if ((qe.parent->leavewhenempty == QUEUE_EMPTY_STRICT) && (stat == QUEUE_NO_REACHABLE_MEMBERS || stat == QUEUE_NO_UNPAUSED_REACHABLE_MEMBERS)) { record_abandoned(&qe); reason = QUEUE_LEAVEUNAVAIL; ast_queue_log(args.queuename, chan->uniqueid, "NONE", "EXITEMPTY", "%d|%d|%ld", qe.pos, qe.opos, (long)(time(NULL) - qe.start)); res = 0; break; } if ((qe.parent->leavewhenempty == QUEUE_EMPTY_LOOSE) && (stat == QUEUE_NO_REACHABLE_MEMBERS)) { record_abandoned(&qe); reason = QUEUE_LEAVEUNAVAIL; res = 0; break; } /* Leave if we have exceeded our queuetimeout */ if (qe.expire && (time(NULL) > qe.expire)) { record_abandoned(&qe); reason = QUEUE_TIMEOUT; res = 0; ast_queue_log(qe.parent->name, qe.chan->uniqueid,"NONE", "EXITWITHTIMEOUT", "%d|%d|%ld", qe.pos, qe.opos, (long) time(NULL) - qe.start); break; } /* If using dynamic realtime members, we should regenerate the member list for this queue */ update_realtime_members(qe.parent); /* OK, we didn't get anybody; wait for 'retry' seconds; may get a digit to exit with */ res = wait_a_bit(&qe); if (res) goto stop; /* Since this is a priority queue and * it is not sure that we are still at the head * of the queue, go and check for our turn again. */ if (!is_our_turn(&qe)) { ast_debug(1, "Darn priorities, going back in queue (%s)!\n", qe.chan->name); goto check_turns; } } stop: if (res) { if (res < 0) { if (!qe.handled) { record_abandoned(&qe); ast_queue_log(args.queuename, chan->uniqueid, "NONE", "ABANDON", "%d|%d|%ld", qe.pos, qe.opos, (long) time(NULL) - qe.start); } res = -1; } else if (qe.valid_digits) { ast_queue_log(args.queuename, chan->uniqueid, "NONE", "EXITWITHKEY", "%s|%d", qe.digits, qe.pos); } } /* Don't allow return code > 0 */ if (res >= 0 && res != AST_PBX_KEEPALIVE) { res = 0; if (ringing) { ast_indicate(chan, -1); } else { ast_moh_stop(chan); } ast_stopstream(chan); } set_queue_variables(&qe); leave_queue(&qe); if (reason != QUEUE_UNKNOWN) set_queue_result(chan, reason); } else { ast_log(LOG_WARNING, "Unable to join queue '%s'\n", args.queuename); set_queue_result(chan, reason); res = 0; } return res; } static int queue_function_var(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) { int res = -1; struct call_queue *q, tmpq = { .name = data, }; char interfacevar[256]=""; float sl = 0; if (ast_strlen_zero(data)) { ast_log(LOG_ERROR, "%s requires an argument: queuename\n", cmd); return -1; } if ((q = ao2_find(queues, &tmpq, OBJ_POINTER))) { ao2_lock(q); if (q->setqueuevar) { sl = 0; res = 0; if (q->callscompleted > 0) sl = 100 * ((float) q->callscompletedinsl / (float) q->callscompleted); snprintf(interfacevar,sizeof(interfacevar), "QUEUEMAX=%d|QUEUESTRATEGY=%s|QUEUECALLS=%d|QUEUEHOLDTIME=%d|QUEUECOMPLETED=%d|QUEUEABANDONED=%d|QUEUESRVLEVEL=%d|QUEUESRVLEVELPERF=%2.1f", q->maxlen, int2strat(q->strategy), q->count, q->holdtime, q->callscompleted, q->callsabandoned, q->servicelevel, sl); pbx_builtin_setvar(chan, interfacevar); } ao2_unlock(q); queue_unref(q); } else ast_log(LOG_WARNING, "queue %s was not found\n", data); snprintf(buf, len, "%d", res); return 0; } static int queue_function_qac(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) { int count = 0; struct member *m; struct ao2_iterator mem_iter; struct call_queue *q; char *option; if (ast_strlen_zero(data)) { ast_log(LOG_ERROR, "%s requires an argument: queuename\n", cmd); return -1; } if ((option = strchr(data, ','))) *option++ = '\0'; else option = "logged"; if ((q = load_realtime_queue(data))) { ao2_lock(q); if(!strcasecmp(option, "logged")) { mem_iter = ao2_iterator_init(q->members, 0); while ((m = ao2_iterator_next(&mem_iter))) { /* Count the agents who are logged in and presently answering calls */ if ((m->status != AST_DEVICE_UNAVAILABLE) && (m->status != AST_DEVICE_INVALID)) { count++; } ao2_ref(m, -1); } } else if(!strcasecmp(option, "free")) { mem_iter = ao2_iterator_init(q->members, 0); while ((m = ao2_iterator_next(&mem_iter))) { /* Count the agents who are logged in and presently answering calls */ if ((m->status == AST_DEVICE_NOT_INUSE) && (!m->paused)) { count++; } ao2_ref(m, -1); } } else /* must be "count" */ count = q->membercount; ao2_unlock(q); queue_unref(q); } else ast_log(LOG_WARNING, "queue %s was not found\n", data); snprintf(buf, len, "%d", count); return 0; } static int queue_function_qac_dep(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) { int count = 0; struct member *m; struct call_queue *q; struct ao2_iterator mem_iter; static int depflag = 1; if (depflag) { depflag = 0; ast_log(LOG_NOTICE, "The function QUEUE_MEMBER_COUNT has been deprecated in favor of the QUEUE_MEMBER function and will not be in further releases.\n"); } if (ast_strlen_zero(data)) { ast_log(LOG_ERROR, "%s requires an argument: queuename\n", cmd); return -1; } if((q = load_realtime_queue(data))) { ao2_lock(q); mem_iter = ao2_iterator_init(q->members, 0); while ((m = ao2_iterator_next(&mem_iter))) { /* Count the agents who are logged in and presently answering calls */ if ((m->status != AST_DEVICE_UNAVAILABLE) && (m->status != AST_DEVICE_INVALID)) { count++; } ao2_ref(m, -1); } ao2_unlock(q); queue_unref(q); } else ast_log(LOG_WARNING, "queue %s was not found\n", data); snprintf(buf, len, "%d", count); return 0; } static int queue_function_queuewaitingcount(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) { int count = 0; struct call_queue *q, tmpq = { .name = data, }; buf[0] = '\0'; if (ast_strlen_zero(data)) { ast_log(LOG_ERROR, "%s requires an argument: queuename\n", cmd); return -1; } if ((q = ao2_find(queues, &tmpq, OBJ_POINTER))) { ao2_lock(q); count = q->count; ao2_unlock(q); queue_unref(q); } else ast_log(LOG_WARNING, "queue %s was not found\n", data); snprintf(buf, len, "%d", count); return 0; } static int queue_function_queuememberlist(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) { struct call_queue *q, tmpq = { .name = data, }; struct member *m; /* Ensure an otherwise empty list doesn't return garbage */ buf[0] = '\0'; if (ast_strlen_zero(data)) { ast_log(LOG_ERROR, "QUEUE_MEMBER_LIST requires an argument: queuename\n"); return -1; } if ((q = ao2_find(queues, &tmpq, OBJ_POINTER))) { int buflen = 0, count = 0; struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0); ao2_lock(q); while ((m = ao2_iterator_next(&mem_iter))) { /* strcat() is always faster than printf() */ if (count++) { strncat(buf + buflen, ",", len - buflen - 1); buflen++; } strncat(buf + buflen, m->membername, len - buflen - 1); buflen += strlen(m->membername); /* Safeguard against overflow (negative length) */ if (buflen >= len - 2) { ao2_ref(m, -1); ast_log(LOG_WARNING, "Truncating list\n"); break; } ao2_ref(m, -1); } ao2_unlock(q); queue_unref(q); } else ast_log(LOG_WARNING, "queue %s was not found\n", data); /* We should already be terminated, but let's make sure. */ buf[len - 1] = '\0'; return 0; } /*! \brief Dialplan function QUEUE_MEMBER_PENALTY() * Gets the members penalty. */ static int queue_function_memberpenalty_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) { struct ast_module_user *lu; int penalty; AST_DECLARE_APP_ARGS(args, AST_APP_ARG(queuename); AST_APP_ARG(interface); ); /* Make sure the returned value on error is NULL. */ buf[0] = '\0'; if (ast_strlen_zero(data)) { ast_log(LOG_ERROR, "Missing argument. QUEUE_MEMBER_PENALTY(,)\n"); return -1; } lu = ast_module_user_add(chan); AST_STANDARD_APP_ARGS(args, data); if (args.argc < 2) { ast_log(LOG_ERROR, "Missing argument. QUEUE_MEMBER_PENALTY(,)\n"); ast_module_user_remove(lu); return -1; } penalty = get_member_penalty (args.queuename, args.interface); if (penalty >= 0) /* remember that buf is already '\0' */ snprintf (buf, len, "%d", penalty); ast_module_user_remove(lu); return 0; } /*! Dialplan function QUEUE_MEMBER_PENALTY() * Sets the members penalty. */ static int queue_function_memberpenalty_write(struct ast_channel *chan, const char *cmd, char *data, const char *value) { struct ast_module_user *lu; int penalty; AST_DECLARE_APP_ARGS(args, AST_APP_ARG(queuename); AST_APP_ARG(interface); ); if (ast_strlen_zero(data)) { ast_log(LOG_ERROR, "Missing argument. QUEUE_MEMBER_PENALTY(,)\n"); return -1; } lu = ast_module_user_add(chan); AST_STANDARD_APP_ARGS(args, data); if (args.argc < 2) { ast_log(LOG_ERROR, "Missing argument. QUEUE_MEMBER_PENALTY(,)\n"); ast_module_user_remove(lu); return -1; } penalty = atoi(value); if (penalty < 0) { ast_log(LOG_ERROR, "Invalid penalty\n"); ast_module_user_remove(lu); return -1; } if (ast_strlen_zero(args.interface)) { ast_log (LOG_ERROR, " parameter can't be null\n"); ast_module_user_remove(lu); return -1; } /* if queuename = NULL then penalty will be set for interface in all the queues. */ set_member_penalty(args.queuename, args.interface, penalty); ast_module_user_remove(lu); return 0; } static struct ast_custom_function queuevar_function = { .name = "QUEUE_VARIABLES", .synopsis = "Return Queue information in variables", .syntax = "QUEUE_VARIABLES()", .desc = "Makes the following queue variables available.\n" "QUEUEMAX maxmimum number of calls allowed\n" "QUEUESTRATEGY the strategy of the queue\n" "QUEUECALLS number of calls currently in the queue\n" "QUEUEHOLDTIME current average hold time\n" "QUEUECOMPLETED number of completed calls for the queue\n" "QUEUEABANDONED number of abandoned calls\n" "QUEUESRVLEVEL queue service level\n" "QUEUESRVLEVELPERF current service level performance\n" "Returns 0 if queue is found and setqueuevar is defined, -1 otherwise", .read = queue_function_var, }; static struct ast_custom_function queuemembercount_function = { .name = "QUEUE_MEMBER", .synopsis = "Count number of members answering a queue", .syntax = "QUEUE_MEMBER(,