app_queue.c File Reference

True call queues with optional send URL on answer. More...

#include "asterisk.h"
#include <sys/time.h>
#include <sys/signal.h>
#include <netinet/in.h>
#include <ctype.h>
#include "asterisk/lock.h"
#include "asterisk/file.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.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"
#include "asterisk/global_datastores.h"
#include "asterisk/taskprocessor.h"
#include "asterisk/callerid.h"
#include "asterisk/cel.h"

Include dependency graph for app_queue.c:

Go to the source code of this file.

Data Structures
struct	call_queue
struct	callattempt
	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. More...
struct	member
struct	penalty_rule
struct	queue_end_bridge
struct	queue_ent
struct	queue_transfer_ds
struct	rule_list
struct	rule_lists
struct	statechange
struct	strategy
Defines
#define	ANNOUNCEHOLDTIME_ALWAYS   1
#define	ANNOUNCEHOLDTIME_ONCE   2
#define	ANNOUNCEPOSITION_LIMIT   4
#define	ANNOUNCEPOSITION_MORE_THAN   3
#define	ANNOUNCEPOSITION_NO   2
#define	ANNOUNCEPOSITION_YES   1
#define	AST_MAX_WATCHERS   256
#define	DEFAULT_MIN_ANNOUNCE_FREQUENCY   15
#define	DEFAULT_RETRY   5
#define	DEFAULT_TIMEOUT   15
#define	MAX_PERIODIC_ANNOUNCEMENTS   10
#define	MAX_QUEUE_BUCKETS   53
#define	PM_MAX_LEN   8192
#define	QUEUE_EVENT_VARIABLES   3
#define	RECHECK   1
#define	RES_EXISTS   (-1)
#define	RES_NOSUCHQUEUE   (-3)
#define	RES_NOT_DYNAMIC   (-4)
#define	RES_OKAY   0
#define	RES_OUTOFMEMORY   (-2)
Enumerations
enum	{   QUEUE_STRATEGY_RINGALL = 0, QUEUE_STRATEGY_LEASTRECENT, QUEUE_STRATEGY_FEWESTCALLS, QUEUE_STRATEGY_RANDOM,   QUEUE_STRATEGY_RRMEMORY, QUEUE_STRATEGY_LINEAR, QUEUE_STRATEGY_WRANDOM }
enum	agent_complete_reason { CALLER, AGENT, TRANSFER }
enum	empty_conditions {   QUEUE_EMPTY_PENALTY = (1 << 0), QUEUE_EMPTY_PAUSED = (1 << 1), QUEUE_EMPTY_INUSE = (1 << 2), QUEUE_EMPTY_RINGING = (1 << 3),   QUEUE_EMPTY_UNAVAILABLE = (1 << 4), QUEUE_EMPTY_INVALID = (1 << 5), QUEUE_EMPTY_UNKNOWN = (1 << 6), QUEUE_EMPTY_WRAPUP = (1 << 7) }
enum	queue_reload_mask { QUEUE_RELOAD_PARAMETERS = (1 << 0), QUEUE_RELOAD_MEMBER = (1 << 1), QUEUE_RELOAD_RULES = (1 << 2), QUEUE_RESET_STATS = (1 << 3) }
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 }
enum	queue_timeout_priority { TIMEOUT_PRIORITY_APP, TIMEOUT_PRIORITY_CONF }
Functions
static char *	__queues_show (struct mansession *s, int fd, int argc, const char *const *argv)
	Show queue(s) status and statistics.
static void	__reg_module (void)
static void	__unreg_module (void)
static int	add_to_queue (const char *queuename, const char *interface, const char *membername, int penalty, int paused, int dump, const char *state_interface)
	Add member to queue.
static struct call_queue *	alloc_queue (const char *queuename)
static int	aqm_exec (struct ast_channel *chan, const char *data)
	AddQueueMember application.
static int	attended_transfer_occurred (struct ast_channel *chan)
	mechanism to tell if a queue caller was atxferred by a queue member.
static int	calc_metric (struct call_queue *q, struct member *mem, int pos, struct queue_ent *qe, struct callattempt *tmp)
	Calculate the metric of each member in the outgoing callattempts.
static void	clear_queue (struct call_queue *q)
static int	clear_stats (const char *queuename)
	Facilitates resetting statistics for a queue.
static int	compare_weight (struct call_queue *rq, struct member *member)
static char *	complete_queue (const char *line, const char *word, int pos, int state)
static char *	complete_queue_add_member (const char *line, const char *word, int pos, int state)
static char *	complete_queue_pause_member (const char *line, const char *word, int pos, int state)
static char *	complete_queue_remove_member (const char *line, const char *word, int pos, int state)
static char *	complete_queue_rule_show (const char *line, const char *word, int pos, int state)
static char *	complete_queue_set_member_penalty (const char *line, const char *word, int pos, int state)
static char *	complete_queue_show (const char *line, const char *word, int pos, int state)
static int	compress_char (const char c)
static void	copy_rules (struct queue_ent *qe, const char *rulename)
	Copy rule from global list into specified queue.
static struct member *	create_queue_member (const char *interface, const char *membername, int penalty, int paused, const char *state_interface)
	allocate space for new queue member and set fields based on parameters passed
static void	destroy_queue (void *obj)
	Free queue's member list then its string fields.
static void	device_state_cb (const struct ast_event *event, void *unused)
static void	do_hang (struct callattempt *o)
	common hangup actions
static void	do_print (struct mansession *s, int fd, const char *str)
	direct ouput to manager or cli with proper terminator
static void	dump_queue_members (struct call_queue *pm_queue)
	Dump all members in a specific queue to the database.
static void	end_bridge_callback (void *data)
static void	end_bridge_callback_data_fixup (struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator)
static struct callattempt *	find_best (struct callattempt *outgoing)
	find the entry with the best metric, or NULL
static struct call_queue *	find_queue_by_name_rt (const char *queuename, struct ast_variable *queue_vars, struct ast_config *member_config)
	Reload a single queue via realtime.
static void	free_members (struct call_queue *q, int all)
	Iterate through queue's member list and delete them.
static int	get_member_penalty (char *queuename, char *interface)
static int	get_member_status (struct call_queue *q, int max_penalty, int min_penalty, enum empty_conditions conditions)
	Check if members are available.
static char *	handle_queue_add_member (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_queue_pause_member (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_queue_reload (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_queue_remove_member (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_queue_reset (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_queue_rule_show (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_queue_set_member_penalty (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	handle_statechange (void *datap)
	set a member's status based on device state of that member's interface
static void	hangupcalls (struct callattempt *outgoing, struct ast_channel *exception, int cancel_answered_elsewhere)
	Hang up a list of outgoing calls.
static void	init_queue (struct call_queue *q)
	Initialize Queue default values.
static void	insert_entry (struct call_queue *q, struct queue_ent *prev, struct queue_ent *new, int *pos)
	Insert the 'new' entry after the 'prev' entry of queue 'q'.
static int	insert_penaltychange (const char *list_name, const char *content, const int linenum)
	Change queue penalty by adding rule.
static const char *	int2strat (int strategy)
static struct member *	interface_exists (struct call_queue *q, const char *interface)
static int	is_our_turn (struct queue_ent *qe)
	Check if we should start attempting to call queue members.
static int	join_queue (char *queuename, struct queue_ent *qe, enum queue_result *reason, int position)
static int	kill_dead_members (void *obj, void *arg, int flags)
static int	kill_dead_queues (void *obj, void *arg, int flags)
static void	leave_queue (struct queue_ent *qe)
	Caller leaving queue.
static int	load_module (void)
static struct call_queue *	load_realtime_queue (const char *queuename)
static int	manager_add_queue_member (struct mansession *s, const struct message *m)
static int	manager_pause_queue_member (struct mansession *s, const struct message *m)
static int	manager_queue_log_custom (struct mansession *s, const struct message *m)
static int	manager_queue_member_penalty (struct mansession *s, const struct message *m)
static int	manager_queue_reload (struct mansession *s, const struct message *m)
static int	manager_queue_reset (struct mansession *s, const struct message *m)
static int	manager_queue_rule_show (struct mansession *s, const struct message *m)
static int	manager_queues_show (struct mansession *s, const struct message *m)
static int	manager_queues_status (struct mansession *s, const struct message *m)
	Queue status info via AMI.
static int	manager_queues_summary (struct mansession *s, const struct message *m)
	Summary of queue info via the AMI.
static int	manager_remove_queue_member (struct mansession *s, const struct message *m)
static int	mark_dead_and_unfound (void *obj, void *arg, int flags)
static int	mark_member_dead (void *obj, void *arg, int flags)
static int	member_cmp_fn (void *obj1, void *obj2, int flags)
static int	member_hash_fn (const void *obj, const int flags)
static int	num_available_members (struct call_queue *q)
	Get the number of members available to accept a call.
static void	parse_empty_options (const char *value, enum empty_conditions *empty, int joinempty)
static int	play_file (struct ast_channel *chan, const char *filename)
static int	pqm_exec (struct ast_channel *chan, const char *data)
	PauseQueueMember application.
static int	ql_exec (struct ast_channel *chan, const char *data)
	QueueLog application.
static int	queue_cmp_cb (void *obj, void *arg, int flags)
static int	queue_exec (struct ast_channel *chan, const char *data)
	The starting point for all queue calls.
static int	queue_function_memberpenalty_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
	Dialplan function QUEUE_MEMBER_PENALTY() Gets the members penalty.
static int	queue_function_memberpenalty_write (struct ast_channel *chan, const char *cmd, char *data, const char *value)
	Dialplan function QUEUE_MEMBER_PENALTY() Sets the members penalty.
static int	queue_function_qac (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
	Get number either busy / free or total members of a specific queue.
static int	queue_function_qac_dep (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
	Get the total number of members in a specific queue (Deprecated).
static int	queue_function_queuememberlist (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
	Dialplan function QUEUE_MEMBER_LIST() Get list of members in a specific queue.
static int	queue_function_queuewaitingcount (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
	Dialplan function QUEUE_WAITING_COUNT() Get number callers waiting in a specific queue.
static int	queue_function_var (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
	create interface var with all queue details.
static int	queue_hash_cb (const void *obj, const int flags)
static struct call_queue *	queue_ref (struct call_queue *q)
static void	queue_set_global_params (struct ast_config *cfg)
static void	queue_set_param (struct call_queue *q, const char *param, const char *val, int linenum, int failunknown)
	Configure a queue parameter.
static char *	queue_show (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static void	queue_transfer_destroy (void *data)
static void	queue_transfer_fixup (void *data, struct ast_channel *old_chan, struct ast_channel *new_chan)
	Log an attended transfer when a queue caller channel is masqueraded.
static struct call_queue *	queue_unref (struct call_queue *q)
static void	recalc_holdtime (struct queue_ent *qe, int newholdtime)
static void	record_abandoned (struct queue_ent *qe)
	Record that a caller gave up on waiting in queue.
static int	reload (void)
static int	reload_handler (int reload, struct ast_flags *mask, const char *queuename)
	The command center for all reload operations.
static void	reload_queue_members (void)
	Reload dynamic queue members persisted into the astdb.
static int	reload_queue_rules (int reload)
	Reload the rules defined in queuerules.conf.
static int	reload_queues (int reload, struct ast_flags *mask, const char *queuename)
	reload the queues.conf file
static void	reload_single_member (const char *memberdata, struct call_queue *q)
	reload information pertaining to a single member
static void	reload_single_queue (struct ast_config *cfg, struct ast_flags *mask, const char *queuename)
	Reload information pertaining to a particular queue.
static int	remove_from_queue (const char *queuename, const char *interface)
	Remove member from queue.
static int	ring_entry (struct queue_ent *qe, struct callattempt *tmp, int *busies)
	Part 2 of ring_one.
static int	ring_one (struct queue_ent *qe, struct callattempt *outgoing, int *busies)
	Place a call to a queue member.
static void	rna (int rnatime, struct queue_ent *qe, char *interface, char *membername, int pause)
	RNA == Ring No Answer. Common code that is executed when we try a queue member and they don't answer.
static int	rqm_exec (struct ast_channel *chan, const char *data)
	RemoveQueueMember application.
static void	rt_handle_member_record (struct call_queue *q, char *interface, const char *rt_uniqueid, const char *membername, const char *penalty_str, const char *paused_str, const char *state_interface)
	Find rt member record to update otherwise create one.
static int	say_periodic_announcement (struct queue_ent *qe, int ringing)
	Playback announcement to queued members if peroid has elapsed.
static int	say_position (struct queue_ent *qe, int ringing)
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)
	Send out AMI message with member call completion status information.
static int	set_member_paused (const char *queuename, const char *interface, const char *reason, int paused)
static int	set_member_penalty (const char *queuename, const char *interface, int penalty)
static void	set_queue_result (struct ast_channel *chan, enum queue_result res)
	sets the QUEUESTATUS channel variable
static void	set_queue_variables (struct call_queue *q, struct ast_channel *chan)
	Set variables of queue.
static struct ast_datastore *	setup_transfer_datastore (struct queue_ent *qe, struct member *member, time_t starttime, int callcompletedinsl)
	create a datastore for storing relevant info to log attended transfers in the queue_log
static int	store_next_lin (struct queue_ent *qe, struct callattempt *outgoing)
	Search for best metric and add to Linear queue.
static int	store_next_rr (struct queue_ent *qe, struct callattempt *outgoing)
	Search for best metric and add to Round Robbin queue.
static int	strat2int (const char *strategy)
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)
	A large function which calls members, updates statistics, and bridges the caller and a member.
static int	unload_module (void)
static void	update_qe_rule (struct queue_ent *qe)
	update rules for queues
static int	update_queue (struct call_queue *q, struct member *member, int callcompletedinsl, int newtalktime)
	update the queue status
static int	update_realtime_member_field (struct member *mem, const char *queue_name, const char *field, const char *value)
static void	update_realtime_members (struct call_queue *q)
static int	update_status (struct call_queue *q, struct member *m, const int status)
	set a member's status based on device state of that member's state_interface.
static int	upqm_exec (struct ast_channel *chan, const char *data)
	UnPauseQueueMember application.
static int	valid_exit (struct queue_ent *qe, char digit)
	Check for valid exit from queue via goto.
static char *	vars2manager (struct ast_channel *chan, char *vars, size_t len)
	convert "\n" to "\nVariable: " ready for manager to use
static int	wait_a_bit (struct queue_ent *qe)
static struct callattempt *	wait_for_answer (struct queue_ent *qe, struct callattempt *outgoing, int *to, char *digit, int prebusies, int caller_disconnect, int forwardsallowed, int update_connectedline)
	Wait for a member to answer the call.
static int	wait_our_turn (struct queue_ent *qe, int ringing, enum queue_result *reason)
	The waiting areas for callers who are not actively calling members.
Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "True Call Queueing" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .reload = reload, }
static char *	app = "Queue"
static char *	app_aqm = "AddQueueMember"
static char *	app_pqm = "PauseQueueMember"
static char *	app_ql = "QueueLog"
static char *	app_rqm = "RemoveQueueMember"
static char *	app_upqm = "UnpauseQueueMember"
static struct ast_module_info *	ast_module_info = &__mod_info
static int	autofill_default = 0
	queues.conf [general] option
static struct ast_cli_entry	cli_queue []
static struct ast_event_sub *	device_state_sub
	Subscription to device state change events.
static struct ast_taskprocessor *	devicestate_tps
static int	montype_default = 0
	queues.conf [general] option
static const char *const	pm_family = "Queue/PersistentMembers"
	Persistent Members astdb family.
static const char	qpm_cmd_usage []
static const char	qsmp_cmd_usage []
static int	queue_persistent_members = 0
	queues.conf [general] option
struct {
enum queue_result   id
char *   text
}	queue_results []
static struct ast_datastore_info	queue_transfer_info
	a datastore used to help correctly log attended transfers of queue callers
static struct ast_custom_function	queuemembercount_dep
static struct ast_custom_function	queuemembercount_function
static struct ast_custom_function	queuememberlist_function
static struct ast_custom_function	queuememberpenalty_function
static struct ao2_container *	queues
static struct ast_custom_function	queuevar_function
static struct ast_custom_function	queuewaitingcount_function
static const char	qum_cmd_usage []
static int	shared_lastcall = 0
	queues.conf [general] option
static struct strategy	strategies []
static int	update_cdr = 0
	queues.conf [general] option
static int	use_weight = 0
	queues.conf per-queue weight option

---

Detailed Description

True call queues with optional send URL on answer.

Author:

Mark Spencer <markster@digium.com>

• Config in ACD - Queue system configuration queues.conf

Development notes

Note:

2004-11-25: Persistent Dynamic Members added by: NetNation Communications (www.netnation.com) Kevin Lindsay <kevinl@netnation.com>

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).

These features added by David C. Troy <dave@toad.net>:

• 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 <michiel@betel.nl> Added Priority jumping code for adding and removing queue members by Jonathan Stanton <asterisk@doilooklikeicare.com>

Fixed to work with CVS as of 2004-02-25 and released as 1.07a by Matthew Enger <m.enger@xi.com.au>

Definition in file app_queue.c.

---

Define Documentation

#define ANNOUNCEHOLDTIME_ALWAYS   1

Definition at line 855 of file app_queue.c.

Referenced by queue_set_param().

#define ANNOUNCEHOLDTIME_ONCE   2

Definition at line 856 of file app_queue.c.

Referenced by queue_set_param(), and say_position().

#define ANNOUNCEPOSITION_LIMIT   4

We not announce position more than <limit>

Definition at line 871 of file app_queue.c.

Referenced by queue_set_param(), and say_position().

#define ANNOUNCEPOSITION_MORE_THAN   3

We say "Currently there are more than <limit>"

Definition at line 870 of file app_queue.c.

Referenced by queue_set_param(), and say_position().

#define ANNOUNCEPOSITION_NO   2

We don't announce position

Definition at line 869 of file app_queue.c.

Referenced by queue_set_param().

#define ANNOUNCEPOSITION_YES   1

We announce position

Definition at line 868 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and say_position().

#define AST_MAX_WATCHERS   256

Definition at line 3009 of file app_queue.c.

#define DEFAULT_MIN_ANNOUNCE_FREQUENCY   15

The minimum number of seconds between position announcements \ The default value of 15 provides backwards compatibility

Definition at line 691 of file app_queue.c.

Referenced by init_queue().

#define DEFAULT_RETRY   5

Definition at line 687 of file app_queue.c.

Referenced by init_queue(), and queue_set_param().

#define DEFAULT_TIMEOUT   15

Definition at line 688 of file app_queue.c.

Referenced by init_queue(), and queue_set_param().

#define MAX_PERIODIC_ANNOUNCEMENTS   10

The maximum periodic announcements we can have

Definition at line 690 of file app_queue.c.

Referenced by destroy_queue(), init_queue(), and queue_set_param().

#define MAX_QUEUE_BUCKETS   53

Definition at line 693 of file app_queue.c.

Referenced by load_module().

#define PM_MAX_LEN   8192

Definition at line 716 of file app_queue.c.

Referenced by dump_queue_members(), and reload_queue_members().

#define QUEUE_EVENT_VARIABLES   3

Definition at line 857 of file app_queue.c.

Referenced by queue_set_param(), ring_entry(), rna(), send_agent_complete(), and try_calling().

#define RECHECK   1

Recheck every second to see we we're at the top yet

Definition at line 689 of file app_queue.c.

Referenced by wait_our_turn().

#define RES_EXISTS   (-1)

Entry already exists

Definition at line 696 of file app_queue.c.

Referenced by add_to_queue(), aqm_exec(), handle_queue_add_member(), handle_queue_remove_member(), manager_add_queue_member(), manager_remove_queue_member(), remove_from_queue(), and rqm_exec().

#define RES_NOSUCHQUEUE   (-3)

No such queue

Definition at line 698 of file app_queue.c.

Referenced by add_to_queue(), aqm_exec(), handle_queue_add_member(), handle_queue_remove_member(), manager_add_queue_member(), manager_remove_queue_member(), remove_from_queue(), and rqm_exec().

#define RES_NOT_DYNAMIC   (-4)

Member is not dynamic

Definition at line 699 of file app_queue.c.

Referenced by handle_queue_add_member(), handle_queue_remove_member(), manager_remove_queue_member(), remove_from_queue(), and rqm_exec().

#define RES_OKAY   0

Action completed

Definition at line 695 of file app_queue.c.

Referenced by add_to_queue(), aqm_exec(), handle_queue_add_member(), handle_queue_remove_member(), manager_add_queue_member(), manager_remove_queue_member(), remove_from_queue(), and rqm_exec().

#define RES_OUTOFMEMORY   (-2)

Out of memory

Definition at line 697 of file app_queue.c.

Referenced by add_to_queue(), aqm_exec(), handle_queue_add_member(), handle_queue_remove_member(), manager_add_queue_member(), manager_remove_queue_member(), and reload_queue_members().

---

Enumeration Type Documentation

anonymous enum

Please read before modifying this file.

There are three locks which are regularly used throughout this file, the queue list lock, the lock for each individual queue, and the interface list lock. Please be extra careful to always lock in the following order 1) queue list lock 2) individual queue lock 3) interface list lock This order has sort of "evolved" over the lifetime of this application, but it is now in place this way, so please adhere to this order!

Enumerator:

QUEUE_STRATEGY_RINGALL
QUEUE_STRATEGY_LEASTRECENT
QUEUE_STRATEGY_FEWESTCALLS
QUEUE_STRATEGY_RANDOM
QUEUE_STRATEGY_RRMEMORY
QUEUE_STRATEGY_LINEAR
QUEUE_STRATEGY_WRANDOM

Definition at line 654 of file app_queue.c.

     {
   QUEUE_STRATEGY_RINGALL = 0,
   QUEUE_STRATEGY_LEASTRECENT,
   QUEUE_STRATEGY_FEWESTCALLS,
   QUEUE_STRATEGY_RANDOM,
   QUEUE_STRATEGY_RRMEMORY,
   QUEUE_STRATEGY_LINEAR,
   QUEUE_STRATEGY_WRANDOM
};

enum agent_complete_reason

Enumerator:

CALLER
AGENT
TRANSFER

Definition at line 3639 of file app_queue.c.

                           {
   CALLER,
   AGENT,
   TRANSFER
};

enum empty_conditions

Enumerator:

QUEUE_EMPTY_PENALTY
QUEUE_EMPTY_PAUSED
QUEUE_EMPTY_INUSE
QUEUE_EMPTY_RINGING
QUEUE_EMPTY_UNAVAILABLE
QUEUE_EMPTY_INVALID
QUEUE_EMPTY_UNKNOWN
QUEUE_EMPTY_WRAPUP

Definition at line 843 of file app_queue.c.

                      {
   QUEUE_EMPTY_PENALTY = (1 << 0),
   QUEUE_EMPTY_PAUSED = (1 << 1),
   QUEUE_EMPTY_INUSE = (1 << 2),
   QUEUE_EMPTY_RINGING = (1 << 3),
   QUEUE_EMPTY_UNAVAILABLE = (1 << 4),
   QUEUE_EMPTY_INVALID = (1 << 5),
   QUEUE_EMPTY_UNKNOWN = (1 << 6),
   QUEUE_EMPTY_WRAPUP = (1 << 7),
};

enum queue_reload_mask

Enumerator:

QUEUE_RELOAD_PARAMETERS
QUEUE_RELOAD_MEMBER
QUEUE_RELOAD_RULES
QUEUE_RESET_STATS

Definition at line 664 of file app_queue.c.

                       {
   QUEUE_RELOAD_PARAMETERS = (1 << 0),
   QUEUE_RELOAD_MEMBER = (1 << 1),
   QUEUE_RELOAD_RULES = (1 << 2),
   QUEUE_RESET_STATS = (1 << 3),
};

enum queue_result

Enumerator:

QUEUE_UNKNOWN
QUEUE_TIMEOUT
QUEUE_JOINEMPTY
QUEUE_LEAVEEMPTY
QUEUE_JOINUNAVAIL
QUEUE_LEAVEUNAVAIL
QUEUE_FULL
QUEUE_CONTINUE

Definition at line 739 of file app_queue.c.

                  {
   QUEUE_UNKNOWN = 0,
   QUEUE_TIMEOUT = 1,
   QUEUE_JOINEMPTY = 2,
   QUEUE_LEAVEEMPTY = 3,
   QUEUE_JOINUNAVAIL = 4,
   QUEUE_LEAVEUNAVAIL = 5,
   QUEUE_FULL = 6,
   QUEUE_CONTINUE = 7,
};

enum queue_timeout_priority

Enumerator:

TIMEOUT_PRIORITY_APP
TIMEOUT_PRIORITY_CONF

Definition at line 764 of file app_queue.c.

                            {
   TIMEOUT_PRIORITY_APP,
   TIMEOUT_PRIORITY_CONF,
};

---

Function Documentation

static char* __queues_show	(	struct mansession *	s,
		int	fd,
		int	argc,
		const char *const *	argv
	)			[static]

Show queue(s) status and statistics.

List the queues strategy, calls processed, members logged in, other queue statistics such as avg hold time.

Definition at line 6363 of file app_queue.c.

References ao2_container_count(), ao2_iterator_destroy(), AO2_ITERATOR_DONTLOCK, ao2_iterator_init(), ao2_iterator_next, ao2_lock(), ao2_ref, ao2_unlock(), ast_category_browse(), ast_check_realtime(), ast_config_destroy(), ast_devstate2str(), ast_load_realtime_multientry(), ast_str_alloca, ast_str_append(), ast_str_buffer(), ast_str_set(), ast_strlen_zero(), member::calls, call_queue::callsabandoned, call_queue::callscompleted, call_queue::callscompletedinsl, queue_ent::chan, CLI_SHOWUSAGE, CLI_SUCCESS, call_queue::count, do_print(), member::dynamic, call_queue::head, call_queue::holdtime, int2strat(), member::interface, member::lastcall, load_realtime_queue(), call_queue::maxlen, member::membername, call_queue::members, ast_channel::name, call_queue::name, queue_ent::next, member::paused, member::penalty, queue_ent::pos, queue_ent::prio, queue_unref(), queues, member::realtime, call_queue::realtime, SENTINEL, call_queue::servicelevel, queue_ent::start, member::status, call_queue::strategy, call_queue::talktime, and call_queue::weight.

Referenced by manager_queues_show(), and queue_show().

{
   struct call_queue *q;
   struct ast_str *out = ast_str_alloca(240);
   int found = 0;
   time_t now = time(NULL);
   struct ao2_iterator queue_iter;
   struct ao2_iterator mem_iter;

   if (argc != 2 && argc != 3)
      return CLI_SHOWUSAGE;

   if (argc == 3) { /* specific queue */
      if ((q = load_realtime_queue(argv[2]))) {
         queue_unref(q);
      }
   } else if (ast_check_realtime("queues")) {
      /* This block is to find any queues which are defined in realtime but
       * which have not yet been added to the in-core container
       */
      struct ast_config *cfg = ast_load_realtime_multientry("queues", "name LIKE", "%", SENTINEL);
      char *queuename;
      if (cfg) {
         for (queuename = ast_category_browse(cfg, NULL); !ast_strlen_zero(queuename); queuename = ast_category_browse(cfg, queuename)) {
            if ((q = load_realtime_queue(queuename))) {
               queue_unref(q);
            }
         }
         ast_config_destroy(cfg);
      }
   }

   queue_iter = ao2_iterator_init(queues, AO2_ITERATOR_DONTLOCK);
   ao2_lock(queues);
   while ((q = ao2_iterator_next(&queue_iter))) {
      float sl;
      struct call_queue *realtime_queue = NULL;

      ao2_lock(q);
      /* This check is to make sure we don't print information for realtime
       * queues which have been deleted from realtime but which have not yet
       * been deleted from the in-core container
       */
      if (q->realtime && !(realtime_queue = load_realtime_queue(q->name))) {
         ao2_unlock(q);
         queue_unref(q);
         continue;
      } else if (q->realtime) {
         queue_unref(realtime_queue);
      }
      if (argc == 3 && strcasecmp(q->name, argv[2])) {
         ao2_unlock(q);
         queue_unref(q);
         continue;
      }
      found = 1;

      ast_str_set(&out, 0, "%-12.12s has %d calls (max ", q->name, q->count);
      if (q->maxlen)
         ast_str_append(&out, 0, "%d", q->maxlen);
      else
         ast_str_append(&out, 0, "unlimited");
      sl = 0;
      if (q->callscompleted > 0)
         sl = 100 * ((float) q->callscompletedinsl / (float) q->callscompleted);
      ast_str_append(&out, 0, ") in '%s' strategy (%ds holdtime, %ds talktime), W:%d, C:%d, A:%d, SL:%2.1f%% within %ds",
         int2strat(q->strategy), q->holdtime, q->talktime, q->weight,
         q->callscompleted, q->callsabandoned,sl,q->servicelevel);
      do_print(s, fd, ast_str_buffer(out));
      if (!ao2_container_count(q->members))
         do_print(s, fd, "   No Members");
      else {
         struct member *mem;

         do_print(s, fd, "   Members: ");
         mem_iter = ao2_iterator_init(q->members, 0);
         while ((mem = ao2_iterator_next(&mem_iter))) {
            ast_str_set(&out, 0, "      %s", mem->membername);
            if (strcasecmp(mem->membername, mem->interface)) {
               ast_str_append(&out, 0, " (%s)", mem->interface);
            }
            if (mem->penalty)
               ast_str_append(&out, 0, " with penalty %d", mem->penalty);
            ast_str_append(&out, 0, "%s%s%s (%s)",
               mem->dynamic ? " (dynamic)" : "",
               mem->realtime ? " (realtime)" : "",
               mem->paused ? " (paused)" : "",
               ast_devstate2str(mem->status));
            if (mem->calls)
               ast_str_append(&out, 0, " has taken %d calls (last was %ld secs ago)",
                  mem->calls, (long) (time(NULL) - mem->lastcall));
            else
               ast_str_append(&out, 0, " has taken no calls yet");
            do_print(s, fd, ast_str_buffer(out));
            ao2_ref(mem, -1);
         }
         ao2_iterator_destroy(&mem_iter);
      }
      if (!q->head)
         do_print(s, fd, "   No Callers");
      else {
         struct queue_ent *qe;
         int pos = 1;

         do_print(s, fd, "   Callers: ");
         for (qe = q->head; qe; qe = qe->next) {
            ast_str_set(&out, 0, "      %d. %s (wait: %ld:%2.2ld, prio: %d)",
               pos++, qe->chan->name, (long) (now - qe->start) / 60,
               (long) (now - qe->start) % 60, qe->prio);
            do_print(s, fd, ast_str_buffer(out));
         }
      }
      do_print(s, fd, ""); /* blank line between entries */
      ao2_unlock(q);
      queue_unref(q); /* Unref the iterator's reference */
   }
   ao2_iterator_destroy(&queue_iter);
   ao2_unlock(queues);
   if (!found) {
      if (argc == 3)
         ast_str_set(&out, 0, "No such queue: %s.", argv[2]);
      else
         ast_str_set(&out, 0, "No queues.");
      do_print(s, fd, ast_str_buffer(out));
   }
   return CLI_SUCCESS;
}

static void __reg_module

(

void

)

[static]

Definition at line 7573 of file app_queue.c.

static void __unreg_module

(

void

)

[static]

Definition at line 7573 of file app_queue.c.

static int add_to_queue	(	const char *	queuename,
		const char *	interface,
		const char *	membername,
		int	penalty,
		int	paused,
		int	dump,
		const char *	state_interface
	)			[static]

Add member to queue.

Return values:

	RES_NOT_DYNAMIC	when they aren't a RT member
	RES_NOSUCHQUEUE	queue does not exist
	RES_OKAY	added member from queue
	RES_EXISTS	queue exists but no members
	RES_OUT_OF_MEMORY	queue exists but not enough memory to create member

Note:

Ensure the appropriate realtime queue is loaded. Note that this short-circuits if the queue is already in memory.

Definition at line 4733 of file app_queue.c.

References ao2_link, ao2_lock(), ao2_ref, ao2_unlock(), member::calls, create_queue_member(), dump_queue_members(), member::dynamic, EVENT_FLAG_AGENT, member::interface, interface_exists(), member::lastcall, load_realtime_queue(), manager_event, call_queue::membercount, member::membername, call_queue::members, call_queue::name, member::paused, member::penalty, queues, RES_EXISTS, RES_NOSUCHQUEUE, RES_OKAY, RES_OUTOFMEMORY, and member::status.

Referenced by aqm_exec(), handle_queue_add_member(), manager_add_queue_member(), and reload_queue_members().

{
   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) {
      if ((new_member = create_queue_member(interface, membername, penalty, paused, state_interface))) {
         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);
         
         ao2_ref(new_member, -1);
         new_member = NULL;

         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 struct call_queue* alloc_queue

(

const char *

queuename

)

[static, read]

Definition at line 1812 of file app_queue.c.

References ao2_alloc, ao2_ref, ast_string_field_init, ast_string_field_set, and destroy_queue().

Referenced by find_queue_by_name_rt(), and reload_single_queue().

{
   struct call_queue *q;

   if ((q = ao2_alloc(sizeof(*q), destroy_queue))) {
      if (ast_string_field_init(q, 64)) {
         ao2_ref(q, -1);
         return NULL;
      }
      ast_string_field_set(q, name, queuename);
   }
   return q;
}

static int aqm_exec	(	struct ast_channel *	chan,
		const char *	data
	)			[static]

AddQueueMember application.

Definition at line 5170 of file app_queue.c.

References add_to_queue(), AST_APP_ARG, AST_DECLARE_APP_ARGS, ast_log(), ast_queue_log(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), LOG_ERROR, LOG_NOTICE, LOG_WARNING, ast_channel::name, parse(), pbx_builtin_setvar_helper(), RES_EXISTS, RES_NOSUCHQUEUE, RES_OKAY, RES_OUTOFMEMORY, and ast_channel::uniqueid.

Referenced by load_module().

{
   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);
      AST_APP_ARG(state_interface);
   );
   int penalty = 0;

   if (ast_strlen_zero(data)) {
      ast_log(LOG_WARNING, "AddQueueMember requires an argument (queuename[,interface[,penalty[,options[,membername[,stateinterface]]]]])\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, "%30d", &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, args.state_interface)) {
   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 attended_transfer_occurred

(

struct ast_channel *

chan

)

[static]

mechanism to tell if a queue caller was atxferred by a queue member.

When a caller is atxferred, then the queue_transfer_info datastore is removed from the channel. If it's still there after the bridge is broken, then the caller was not atxferred.

Note:

Only call this with chan locked

Definition at line 3743 of file app_queue.c.

References ast_channel_datastore_find(), and queue_transfer_info.

Referenced by try_calling().

{
   return ast_channel_datastore_find(chan, &queue_transfer_info, NULL) ? 0 : 1;
}

static int calc_metric	(	struct call_queue *	q,
		struct member *	mem,
		int	pos,
		struct queue_ent *	qe,
		struct callattempt *	tmp
	)			[static]

Calculate the metric of each member in the outgoing callattempts.

A numeric metric is given to each member depending on the ring strategy used by the queue. Members with lower metrics will be called before members with higher metrics

Return values:

	-1	if penalties are exceeded
	0	otherwise

Definition at line 3582 of file app_queue.c.

References ast_log(), ast_random(), member::calls, member::lastcall, queue_ent::linpos, queue_ent::linwrapped, LOG_WARNING, queue_ent::max_penalty, callattempt::metric, queue_ent::min_penalty, member::penalty, QUEUE_STRATEGY_FEWESTCALLS, QUEUE_STRATEGY_LEASTRECENT, QUEUE_STRATEGY_LINEAR, QUEUE_STRATEGY_RANDOM, QUEUE_STRATEGY_RINGALL, QUEUE_STRATEGY_RRMEMORY, QUEUE_STRATEGY_WRANDOM, call_queue::rrpos, call_queue::strategy, and call_queue::wrapped.

Referenced by try_calling().

{
   if ((qe->max_penalty && (mem->penalty > qe->max_penalty)) || (qe->min_penalty && (mem->penalty < qe->min_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;
}

static void clear_queue

(

struct call_queue *

q

)

[static]

Definition at line 1388 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, member::calls, call_queue::callsabandoned, call_queue::callscompleted, call_queue::callscompletedinsl, call_queue::holdtime, call_queue::members, call_queue::talktime, and call_queue::wrapuptime.

Referenced by clear_stats(), and find_queue_by_name_rt().

{
   q->holdtime = 0;
   q->callscompleted = 0;
   q->callsabandoned = 0;
   q->callscompletedinsl = 0;
   q->wrapuptime = 0;
   q->talktime = 0;

   if (q->members) {
      struct member *mem;
      struct ao2_iterator mem_iter = ao2_iterator_init(q->members, 0);
      while ((mem = ao2_iterator_next(&mem_iter))) {
         mem->calls = 0;
         ao2_ref(mem, -1);
      }
      ao2_iterator_destroy(&mem_iter);
   }
}

static int clear_stats

(

const char *

queuename

)

[static]

Facilitates resetting statistics for a queue.

This function actually does not reset any statistics, but rather finds a call_queue struct which corresponds to the passed-in queue name and passes that structure to the clear_queue function. If no queuename is passed in, then all queues will have their statistics reset.

Parameters:

queuename

The name of the queue to reset the statistics for. If this is NULL or zero-length, then this means to reset the statistics for all queues

Return values:

void

Definition at line 6305 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock(), ao2_unlock(), ast_strlen_zero(), clear_queue(), call_queue::name, and queues.

Referenced by reload_handler().

{
   struct call_queue *q;
   struct ao2_iterator 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))
         clear_queue(q);
      ao2_unlock(q);
   }
   ao2_iterator_destroy(&queue_iter);
   return 0;
}

static int compare_weight	(	struct call_queue *	rq,
		struct member *	member
	)			[static]

Definition at line 2526 of file app_queue.c.

References ao2_find, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock(), ao2_ref, ao2_unlock(), ast_debug, call_queue::count, member::interface, call_queue::members, call_queue::name, num_available_members(), OBJ_POINTER, queue_unref(), queues, and call_queue::weight.

Referenced by ring_entry().

{
   struct call_queue *q;
   struct member *mem;
   int found = 0;
   struct ao2_iterator queue_iter;
   
   /* q's lock and rq's 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 && q->count >= num_available_members(q)) {
               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);
      queue_unref(q);
      if (found) {
         break;
      }
   }
   ao2_iterator_destroy(&queue_iter);
   return found;
}

static char* complete_queue	(	const char *	line,
		const char *	word,
		int	pos,
		int	state
	)			[static]

Definition at line 6491 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ast_strdup, call_queue::name, queue_unref(), and queues.

Referenced by complete_queue_add_member(), complete_queue_pause_member(), complete_queue_remove_member(), complete_queue_set_member_penalty(), complete_queue_show(), handle_queue_reload(), and handle_queue_reset().

{
   struct call_queue *q;
   char *ret = NULL;
   int which = 0;
   int wordlen = strlen(word);
   struct ao2_iterator queue_iter;

   queue_iter = ao2_iterator_init(queues, 0);
   while ((q = ao2_iterator_next(&queue_iter))) {
      if (!strncasecmp(word, q->name, wordlen) && ++which > state) {
         ret = ast_strdup(q->name);
         queue_unref(q);
         break;
      }
      queue_unref(q);
   }
   ao2_iterator_destroy(&queue_iter);

   return ret;
}

static char* complete_queue_add_member	(	const char *	line,
		const char *	word,
		int	pos,
		int	state
	)			[static]

Definition at line 6923 of file app_queue.c.

References ast_malloc, ast_strdup, complete_queue(), and num.

Referenced by handle_queue_add_member().

{
   /* 0 - queue; 1 - add; 2 - member; 3 - <interface>; 4 - to; 5 - <queue>; 6 - penalty; 7 - <penalty>; 8 - as; 9 - <membername> */
   switch (pos) {
   case 3: /* Don't attempt to complete name of interface (infinite possibilities) */
      return NULL;
   case 4: /* only one possible match, "to" */
      return state == 0 ? ast_strdup("to") : NULL;
   case 5: /* <queue> */
      return complete_queue(line, word, pos, state);
   case 6: /* only one possible match, "penalty" */
      return state == 0 ? ast_strdup("penalty") : NULL;
   case 7:
      if (state < 100) {      /* 0-99 */
         char *num;
         if ((num = ast_malloc(3))) {
            sprintf(num, "%d", state);
         }
         return num;
      } else {
         return NULL;
      }
   case 8: /* only one possible match, "as" */
      return state == 0 ? ast_strdup("as") : NULL;
   case 9: /* Don't attempt to complete name of member (infinite possibilities) */
      return NULL;
   default:
      return NULL;
   }
}

static char* complete_queue_pause_member	(	const char *	line,
		const char *	word,
		int	pos,
		int	state
	)			[static]

Definition at line 7144 of file app_queue.c.

References ast_strdup, and complete_queue().

Referenced by handle_queue_pause_member().

{
   /* 0 - queue; 1 - pause; 2 - member; 3 - <interface>; 4 - queue; 5 - <queue>; 6 - reason; 7 - <reason> */
   switch (pos) {
   case 3:  /* Don't attempt to complete name of interface (infinite possibilities) */
      return NULL;
   case 4:  /* only one possible match, "queue" */
      return state == 0 ? ast_strdup("queue") : NULL;
   case 5:  /* <queue> */
      return complete_queue(line, word, pos, state);
   case 6: /* "reason" */
      return state == 0 ? ast_strdup("reason") : NULL;
   case 7: /* Can't autocomplete a reason, since it's 100% customizeable */
      return NULL;
   default:
      return NULL;
   }
}

static char* complete_queue_remove_member	(	const char *	line,
		const char *	word,
		int	pos,
		int	state
	)			[static]

Definition at line 7053 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock(), ao2_ref, ao2_unlock(), ast_strdup, complete_queue(), member::interface, member::membername, call_queue::members, queue_unref(), and queues.

Referenced by handle_queue_remove_member().

{
   int which = 0;
   struct call_queue *q;
   struct member *m;
   struct ao2_iterator queue_iter;
   struct ao2_iterator mem_iter;
   int wordlen = strlen(word);

   /* 0 - queue; 1 - remove; 2 - member; 3 - <member>; 4 - from; 5 - <queue> */
   if (pos > 5 || pos < 3)
      return NULL;
   if (pos == 4)   /* only one possible match, 'from' */
      return (state == 0 ? ast_strdup("from") : NULL);

   if (pos == 5)   /* No need to duplicate code */
      return complete_queue(line, word, pos, state);

   /* here is the case for 3, <member> */
   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 ((m = ao2_iterator_next(&mem_iter))) {
         if (!strncasecmp(word, m->membername, wordlen) && ++which > state) {
            char *tmp;
            ao2_unlock(q);
            tmp = ast_strdup(m->interface);
            ao2_ref(m, -1);
            queue_unref(q);
            ao2_iterator_destroy(&mem_iter);
            ao2_iterator_destroy(&queue_iter);
            return tmp;
         }
         ao2_ref(m, -1);
      }
      ao2_iterator_destroy(&mem_iter);
      ao2_unlock(q);
      queue_unref(q);
   }
   ao2_iterator_destroy(&queue_iter);

   return NULL;
}

static char* complete_queue_rule_show	(	const char *	line,
		const char *	word,
		int	pos,
		int	state
	)			[static]

Definition at line 7277 of file app_queue.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_strdup, and rule_list::name.

Referenced by handle_queue_rule_show().

{
   int which = 0;
   struct rule_list *rl_iter;
   int wordlen = strlen(word);
   char *ret = NULL;
   if (pos != 3) /* Wha? */ {
      return NULL;
   }

   AST_LIST_LOCK(&rule_lists);
   AST_LIST_TRAVERSE(&rule_lists, rl_iter, list) {
      if (!strncasecmp(word, rl_iter->name, wordlen) && ++which > state) {
         ret = ast_strdup(rl_iter->name);
         break;
      }
   }
   AST_LIST_UNLOCK(&rule_lists);

   return ret;
}

static char* complete_queue_set_member_penalty	(	const char *	line,
		const char *	word,
		int	pos,
		int	state
	)			[static]

Definition at line 7214 of file app_queue.c.

References ast_strdup, and complete_queue().

Referenced by handle_queue_set_member_penalty().

{
   /* 0 - queue; 1 - set; 2 - penalty; 3 - <penalty>; 4 - on; 5 - <member>; 6 - in; 7 - <queue>;*/
   switch (pos) {
   case 4:
      if (state == 0) {
         return ast_strdup("on");
      } else {
         return NULL;
      }
   case 6:
      if (state == 0) {
         return ast_strdup("in");
      } else {
         return NULL;
      }
   case 7:
      return complete_queue(line, word, pos, state);
   default:
      return NULL;
   }
}

static char* complete_queue_show	(	const char *	line,
		const char *	word,
		int	pos,
		int	state
	)			[static]

Definition at line 6513 of file app_queue.c.

References complete_queue().

Referenced by queue_show().

{
   if (pos == 2)
      return complete_queue(line, word, pos, state);
   return NULL;
}

static int compress_char

(

const char

c

)

[static]

Definition at line 1287 of file app_queue.c.

Referenced by member_hash_fn().

{
   if (c < 32)
      return 0;
   else if (c > 96)
      return c - 64;
   else
      return c - 32;
}

static void copy_rules	(	struct queue_ent *	qe,
		const char *	rulename
	)			[static]

Copy rule from global list into specified queue.

Definition at line 5267 of file app_queue.c.

References ast_calloc, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), ast_strlen_zero(), call_queue::defaultrule, LOG_ERROR, penalty_rule::max_relative, penalty_rule::max_value, penalty_rule::min_relative, penalty_rule::min_value, rule_list::name, queue_ent::parent, queue_ent::qe_rules, rule_list::rules, and penalty_rule::time.

Referenced by queue_exec().

{
   struct penalty_rule *pr_iter;
   struct rule_list *rl_iter;
   const char *tmp = ast_strlen_zero(rulename) ? qe->parent->defaultrule : rulename;
   AST_LIST_LOCK(&rule_lists);
   AST_LIST_TRAVERSE(&rule_lists, rl_iter, list) {
      if (!strcasecmp(rl_iter->name, tmp))
         break;
   }
   if (rl_iter) {
      AST_LIST_TRAVERSE(&rl_iter->rules, pr_iter, list) {
         struct penalty_rule *new_pr = ast_calloc(1, sizeof(*new_pr));
         if (!new_pr) {
            ast_log(LOG_ERROR, "Memory allocation error when copying penalty rules! Aborting!\n");
            AST_LIST_UNLOCK(&rule_lists);
            break;
         }
         new_pr->time = pr_iter->time;
         new_pr->max_value = pr_iter->max_value;
         new_pr->min_value = pr_iter->min_value;
         new_pr->max_relative = pr_iter->max_relative;
         new_pr->min_relative = pr_iter->min_relative;
         AST_LIST_INSERT_TAIL(&qe->qe_rules, new_pr, list);
      }
   }
   AST_LIST_UNLOCK(&rule_lists);
}

static struct member* create_queue_member	(	const char *	interface,
		const char *	membername,
		int	penalty,
		int	paused,
		const char *	state_interface
	)			[static, read]

allocate space for new queue member and set fields based on parameters passed

Definition at line 1262 of file app_queue.c.

References ao2_alloc, ast_copy_string(), ast_log(), ast_strlen_zero(), member::interface, LOG_WARNING, member::membername, member::paused, member::penalty, member::state_interface, and member::status.

Referenced by add_to_queue(), reload_single_member(), and rt_handle_member_record().

{
   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(state_interface))
         ast_copy_string(cur->state_interface, state_interface, sizeof(cur->state_interface));
      else
         ast_copy_string(cur->state_interface, interface, sizeof(cur->state_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(cur->state_interface);
   }

   return cur;
}

static void destroy_queue

(

void *

obj

)

[static]

Free queue's member list then its string fields.

Definition at line 1798 of file app_queue.c.

References ao2_ref, ast_string_field_free_memory, free, free_members(), MAX_PERIODIC_ANNOUNCEMENTS, call_queue::members, and call_queue::sound_periodicannounce.

Referenced by alloc_queue().

{
   struct call_queue *q = obj;
   int i;

   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 void device_state_cb	(	const struct ast_event *	event,
		void *	unused
	)			[static]

Definition at line 1235 of file app_queue.c.

References ast_calloc, ast_event_get_ie_str(), ast_event_get_ie_uint(), AST_EVENT_IE_DEVICE, AST_EVENT_IE_STATE, ast_free, ast_log(), ast_strlen_zero(), ast_taskprocessor_push(), statechange::dev, handle_statechange(), LOG_ERROR, and statechange::state.

Referenced by load_module(), and load_pbx().

{
   enum ast_device_state state;
   const char *device;
   struct statechange *sc;
   size_t datapsize;

   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;
   }
   datapsize = sizeof(*sc) + strlen(device) + 1;
   if (!(sc = ast_calloc(1, datapsize))) {
      ast_log(LOG_ERROR, "failed to calloc a state change struct\n");
      return;
   }
   sc->state = state;
   strcpy(sc->dev, device);
   if (ast_taskprocessor_push(devicestate_tps, handle_statechange, sc) < 0) {
      ast_free(sc);
   }
}

static void do_hang

(

struct callattempt *

o

)

[static]

common hangup actions

Definition at line 2563 of file app_queue.c.

References ast_hangup(), callattempt::chan, and callattempt::stillgoing.

Referenced by ring_entry(), and wait_for_answer().

{
   o->stillgoing = 0;
   ast_hangup(o->chan);
   o->chan = NULL;
}

static void do_print	(	struct mansession *	s,
		int	fd,
		const char *	str
	)			[static]

direct ouput to manager or cli with proper terminator

Definition at line 6349 of file app_queue.c.

References ast_cli(), and astman_append().

Referenced by __queues_show().

{
   if (s)
      astman_append(s, "%s\r\n", str);
   else
      ast_cli(fd, "%s\n", str);
}

static void dump_queue_members

(

struct call_queue *

pm_queue

)

[static]

Dump all members in a specific queue to the database.

<pm_family>/<queuename> = <interface>;<penalty>;<paused>;<state_interface>[|...]

Definition at line 4634 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_db_del(), ast_db_put(), ast_log(), member::dynamic, member::interface, LOG_WARNING, member::membername, call_queue::members, call_queue::name, member::paused, member::penalty, PM_MAX_LEN, member::state_interface, and value.

Referenced by add_to_queue(), remove_from_queue(), and set_member_paused().

{
   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;%s",
         value_len ? "|" : "", cur_member->interface, cur_member->penalty, cur_member->paused, cur_member->membername, cur_member->state_interface);

      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;
   }
   ao2_iterator_destroy(&mem_iter);
   
   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 void end_bridge_callback

(

void *

data

)

[static]

Definition at line 3790 of file app_queue.c.

References ao2_lock(), ao2_ref, ao2_unlock(), queue_end_bridge::chan, queue_ent::chan, queue_end_bridge::q, queue_unref(), and set_queue_variables().

{
   struct queue_end_bridge *qeb = data;
   struct call_queue *q = qeb->q;
   struct ast_channel *chan = qeb->chan;

   if (ao2_ref(qeb, -1) == 1) {
      ao2_lock(q);
      set_queue_variables(q, chan);
      ao2_unlock(q);
      /* This unrefs the reference we made in try_calling when we allocated qeb */
      queue_unref(q);
   }
}

static void end_bridge_callback_data_fixup	(	struct ast_bridge_config *	bconfig,
		struct ast_channel *	originator,
		struct ast_channel *	terminator
	)			[static]

Definition at line 3783 of file app_queue.c.

References ao2_ref, queue_end_bridge::chan, and ast_bridge_config::end_bridge_callback_data.

{
   struct queue_end_bridge *qeb = bconfig->end_bridge_callback_data;
   ao2_ref(qeb, +1);
   qeb->chan = originator;
}

static struct callattempt* find_best

(

struct callattempt *

outgoing

)

[static, read]

find the entry with the best metric, or NULL

Definition at line 2796 of file app_queue.c.

References callattempt::metric, and callattempt::q_next.

Referenced by ast_cli_command_full(), ring_one(), store_next_lin(), and store_next_rr().

{
   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 struct call_queue* find_queue_by_name_rt	(	const char *	queuename,
		struct ast_variable *	queue_vars,
		struct ast_config *	member_config
	)			[static, read]

Reload a single queue via realtime.

Check for statically defined queue first, check if deleted RT queue, check for new RT queue, if queue vars are not defined init them with defaults. reload RT queue vars, set RT queue members dead and reload them, return finished queue.

Return values:

	the	queue,
	NULL	if it doesn't exist.

Note:

Should be called with the "queues" container locked.

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.

Definition at line 1836 of file app_queue.c.

References alloc_queue(), ao2_find, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_link, ao2_lock(), ao2_ref, ao2_unlink, ao2_unlock(), ast_category_browse(), ast_copy_string(), ast_debug, ast_log(), ast_queue_log(), ast_strlen_zero(), ast_variable_retrieve(), clear_queue(), member::dead, call_queue::dead, init_queue(), member::interface, LOG_WARNING, call_queue::membercount, call_queue::members, ast_variable::name, call_queue::name, ast_variable::next, OBJ_POINTER, queue_set_param(), QUEUE_STRATEGY_RINGALL, queue_unref(), queues, member::realtime, call_queue::realtime, rt_handle_member_record(), S_OR, strat2int(), call_queue::strategy, and ast_variable::value.

Referenced by load_realtime_queue().

{
   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) {
      struct ast_variable *tmpvar = NULL;
      if (!(q = alloc_queue(queuename)))
         return NULL;
      ao2_lock(q);
      clear_queue(q);
      q->realtime = 1;
      q->membercount = 0;
      /*Before we initialize the queue, we need to set the strategy, so that linear strategy
       * will allocate the members properly
       */
      for (tmpvar = queue_vars; tmpvar; tmpvar = tmpvar->next) {
         if (!strcasecmp(tmpvar->name, "strategy")) {
            q->strategy = strat2int(tmpvar->value);
            if (q->strategy < 0) {
               ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
               tmpvar->value, q->name);
               q->strategy = QUEUE_STRATEGY_RINGALL;
            }
            break;
         }
      }
      /* We traversed all variables and didn't find a strategy */
      if (!tmpvar)
         q->strategy = QUEUE_STRATEGY_RINGALL;
      ao2_link(queues, q);
   }
   init_queue(q);    /* Ensure defaults for all parameters not set explicitly. */

   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;

      if (!ast_strlen_zero(v->value)) {
         /* Don't want to try to set the option if the value is empty */
         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);
   }
   ao2_iterator_destroy(&mem_iter);

   while ((interface = ast_category_browse(member_config, interface))) {
      rt_handle_member_record(q, interface,
         ast_variable_retrieve(member_config, interface, "uniqueid"),
         S_OR(ast_variable_retrieve(member_config, interface, "membername"),interface),
         ast_variable_retrieve(member_config, interface, "penalty"),
         ast_variable_retrieve(member_config, interface, "paused"),
         S_OR(ast_variable_retrieve(member_config, interface, "state_interface"),interface));
   }

   /* 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) {
         ast_queue_log(q->name, "REALTIME", m->interface, "REMOVEMEMBER", "%s", "");
         ao2_unlink(q->members, m);
         q->membercount--;
      }
      ao2_ref(m, -1);
   }
   ao2_iterator_destroy(&mem_iter);

   ao2_unlock(q);

   return q;
}

static void free_members	(	struct call_queue *	q,
		int	all
	)			[static]

Iterate through queue's member list and delete them.

Definition at line 1781 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ao2_unlink, member::dynamic, call_queue::membercount, and call_queue::members.

Referenced by destroy_queue().

{
   /* 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);
         q->membercount--;
      }
      ao2_ref(cur, -1);
   }
   ao2_iterator_destroy(&mem_iter);
}

static int get_member_penalty	(	char *	queuename,
		char *	interface
	)			[static]

Definition at line 4912 of file app_queue.c.

References ao2_find, ao2_lock(), ao2_ref, ao2_unlock(), ast_log(), interface_exists(), LOG_ERROR, OBJ_POINTER, member::penalty, queue_unref(), queues, and RESULT_FAILURE.

Referenced by queue_function_memberpenalty_read().

{
   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_ref(mem, -1);
         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;
}

static int get_member_status	(	struct call_queue *	q,
		int	max_penalty,
		int	min_penalty,
		enum empty_conditions	conditions
	)			[static]

Check if members are available.

This function checks to see if members are available to be called. If any member is available, the function immediately returns 0. If no members are available, then -1 is returned.

Definition at line 1096 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock(), ao2_ref, ao2_unlock(), ast_debug, AST_DEVICE_INUSE, AST_DEVICE_INVALID, AST_DEVICE_UNAVAILABLE, AST_DEVICE_UNKNOWN, member::lastcall, member::membername, call_queue::members, member::paused, member::penalty, QUEUE_EMPTY_INUSE, QUEUE_EMPTY_INVALID, QUEUE_EMPTY_PAUSED, QUEUE_EMPTY_PENALTY, QUEUE_EMPTY_UNAVAILABLE, QUEUE_EMPTY_UNKNOWN, QUEUE_EMPTY_WRAPUP, member::status, and call_queue::wrapuptime.

Referenced by join_queue(), queue_exec(), and wait_our_turn().

{
   struct member *member;
   struct ao2_iterator mem_iter;

   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)) || (min_penalty && (member->penalty < min_penalty))) {
         if (conditions & QUEUE_EMPTY_PENALTY) {
            ast_debug(4, "%s is unavailable because his penalty is not between %d and %d\n", member->membername, min_penalty, max_penalty);
            continue;
         }
      }

      switch (member->status) {
      case AST_DEVICE_INVALID:
         if (conditions & QUEUE_EMPTY_INVALID) {
            ast_debug(4, "%s is unavailable because his device state is 'invalid'\n", member->membername);
            break;
         }
      case AST_DEVICE_UNAVAILABLE:
         if (conditions & QUEUE_EMPTY_UNAVAILABLE) {
            ast_debug(4, "%s is unavailable because his device state is 'unavailable'\n", member->membername);
            break;
         }
      case AST_DEVICE_INUSE:
         if (conditions & QUEUE_EMPTY_INUSE) {
            ast_debug(4, "%s is unavailable because his device state is 'inuse'\n", member->membername);
            break;
         }
      case AST_DEVICE_UNKNOWN:
         if (conditions & QUEUE_EMPTY_UNKNOWN) {
            ast_debug(4, "%s is unavailable because his device state is 'unknown'\n", member->membername);
            break;
         }
      default:
         if (member->paused && (conditions & QUEUE_EMPTY_PAUSED)) {
            ast_debug(4, "%s is unavailable because he is paused'\n", member->membername);
            break;
         } else if ((conditions & QUEUE_EMPTY_WRAPUP) && member->lastcall && q->wrapuptime && (time(NULL) - q->wrapuptime < member->lastcall)) {
            ast_debug(4, "%s is unavailable because it has only been %d seconds since his last call (wrapup time is %d)\n", member->membername, (int) (time(NULL) - member->lastcall), q->wrapuptime);
            break;
         } else {
            ao2_unlock(q);
            ao2_ref(member, -1);
            ao2_iterator_destroy(&mem_iter);
            ast_debug(4, "%s is available.\n", member->membername);
            return 0;
         }
         break;
      }
   }
   ao2_iterator_destroy(&mem_iter);

   ao2_unlock(q);
   return -1;
}

static char* handle_queue_add_member	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)			[static]

Definition at line 6979 of file app_queue.c.

References add_to_queue(), ast_cli_args::argc, ast_cli_args::argv, ast_cli(), ast_queue_log(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, complete_queue_add_member(), ast_cli_args::fd, ast_cli_args::line, ast_cli_args::n, ast_cli_args::pos, RES_EXISTS, RES_NOSUCHQUEUE, RES_NOT_DYNAMIC, RES_OKAY, RES_OUTOFMEMORY, ast_cli_entry::usage, and ast_cli_args::word.

{
   const char *queuename, *interface, *membername = NULL, *state_interface = NULL;
   int penalty;

   switch ( cmd ) {
   case CLI_INIT:
      e->command = "queue add member";
      e->usage =
         "Usage: queue add member <channel> to <queue> [[[penalty <penalty>] as <membername>] state_interface <interface>]\n"
         "       Add a channel to a queue with optionally:  a penalty, membername and a state_interface\n";
      return NULL;
   case CLI_GENERATE:
      return complete_queue_add_member(a->line, a->word, a->pos, a->n);
   }

   if ((a->argc != 6) && (a->argc != 8) && (a->argc != 10) && (a->argc != 12)) {
      return CLI_SHOWUSAGE;
   } else if (strcmp(a->argv[4], "to")) {
      return CLI_SHOWUSAGE;
   } else if ((a->argc >= 8) && strcmp(a->argv[6], "penalty")) {
      return CLI_SHOWUSAGE;
   } else if ((a->argc >= 10) && strcmp(a->argv[8], "as")) {
      return CLI_SHOWUSAGE;
   } else if ((a->argc == 12) && strcmp(a->argv[10], "state_interface")) {
      return CLI_SHOWUSAGE;
   }

   queuename = a->argv[5];
   interface = a->argv[3];
   if (a->argc >= 8) {
      if (sscanf(a->argv[7], "%30d", &penalty) == 1) {
         if (penalty < 0) {
            ast_cli(a->fd, "Penalty must be >= 0\n");
            penalty = 0;
         }
      } else {
         ast_cli(a->fd, "Penalty must be an integer >= 0\n");
         penalty = 0;
      }
   } else {
      penalty = 0;
   }

   if (a->argc >= 10) {
      membername = a->argv[9];
   }

   if (a->argc >= 12) {
      state_interface = a->argv[11];
   }

   switch (add_to_queue(queuename, interface, membername, penalty, 0, queue_persistent_members, state_interface)) {
   case RES_OKAY:
      ast_queue_log(queuename, "CLI", interface, "ADDMEMBER", "%s", "");
      ast_cli(a->fd, "Added interface '%s' to queue '%s'\n", interface, queuename);
      return CLI_SUCCESS;
   case RES_EXISTS:
      ast_cli(a->fd, "Unable to add interface '%s' to queue '%s': Already there\n", interface, queuename);
      return CLI_FAILURE;
   case RES_NOSUCHQUEUE:
      ast_cli(a->fd, "Unable to add interface to queue '%s': No such queue\n", queuename);
      return CLI_FAILURE;
   case RES_OUTOFMEMORY:
      ast_cli(a->fd, "Out of memory\n");
      return CLI_FAILURE;
   case RES_NOT_DYNAMIC:
      ast_cli(a->fd, "Member not dynamic\n");
      return CLI_FAILURE;
   default:
      return CLI_FAILURE;
   }
}

static char* handle_queue_pause_member	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)			[static]

Definition at line 7163 of file app_queue.c.

References ast_cli_args::argc, ast_cli_args::argv, ast_cli(), ast_strlen_zero(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, complete_queue_pause_member(), ast_cli_args::fd, ast_cli_args::line, ast_cli_args::n, ast_cli_args::pos, RESULT_SUCCESS, set_member_paused(), ast_cli_entry::usage, and word.

{
   const char *queuename, *interface, *reason;
   int paused;

   switch (cmd) {
   case CLI_INIT:
      e->command = "queue {pause|unpause} member";
      e->usage = 
         "Usage: queue {pause|unpause} member <member> [queue <queue> [reason <reason>]]\n"
         "  Pause or unpause a queue member. Not specifying a particular queue\n"
         "  will pause or unpause a member across all queues to which the member\n"
         "  belongs.\n";
      return NULL;
   case CLI_GENERATE:
      return complete_queue_pause_member(a->line, a-> word, a->pos, a->n);
   }

   if (a->argc < 4 || a->argc == 5 || a->argc == 7 || a->argc > 8) {
      return CLI_SHOWUSAGE;
   } else if (a->argc >= 5 && strcmp(a->argv[4], "queue")) {
      return CLI_SHOWUSAGE;
   } else if (a->argc == 8 && strcmp(a->argv[6], "reason")) {
      return CLI_SHOWUSAGE;
   }


   interface = a->argv[3];
   queuename = a->argc >= 6 ? a->argv[5] : NULL;
   reason = a->argc == 8 ? a->argv[7] : NULL;
   paused = !strcasecmp(a->argv[1], "pause");

   if (set_member_paused(queuename, interface, reason, paused) == RESULT_SUCCESS) {
      ast_cli(a->fd, "%spaused interface '%s'", paused ? "" : "un", interface);
      if (!ast_strlen_zero(queuename))
         ast_cli(a->fd, " in queue '%s'", queuename);
      if (!ast_strlen_zero(reason))
         ast_cli(a->fd, " for reason '%s'", reason);
      ast_cli(a->fd, "\n");
      return CLI_SUCCESS;
   } else {
      ast_cli(a->fd, "Unable to %spause interface '%s'", paused ? "" : "un", interface);
      if (!ast_strlen_zero(queuename))
         ast_cli(a->fd, " in queue '%s'", queuename);
      if (!ast_strlen_zero(reason))
         ast_cli(a->fd, " for reason '%s'", reason);
      ast_cli(a->fd, "\n");
      return CLI_FAILURE;
   }
}

static char* handle_queue_reload	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)			[static]

Definition at line 7372 of file app_queue.c.

References ast_cli_args::argc, ast_cli_args::argv, AST_FLAGS_ALL, ast_set_flag, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, complete_queue(), ast_cli_args::line, ast_cli_args::n, ast_cli_args::pos, QUEUE_RELOAD_MEMBER, QUEUE_RELOAD_PARAMETERS, QUEUE_RELOAD_RULES, reload_handler(), ast_cli_entry::usage, and ast_cli_args::word.

{
   struct ast_flags mask = {0,};
   int i;

   switch (cmd) {
      case CLI_INIT:
         e->command = "queue reload {parameters|members|rules|all}";
         e->usage =
            "Usage: queue reload {parameters|members|rules|all} [<queuenames>]\n"
            "Reload queues. If <queuenames> are specified, only reload information pertaining\n"
            "to <queuenames>. One of 'parameters,' 'members,' 'rules,' or 'all' must be\n"
            "specified in order to know what information to reload. Below is an explanation\n"
            "of each of these qualifiers.\n"
            "\n"
            "\t'members' - reload queue members from queues.conf\n"
            "\t'parameters' - reload all queue options except for queue members\n"
            "\t'rules' - reload the queuerules.conf file\n"
            "\t'all' - reload queue rules, parameters, and members\n"
            "\n"
            "Note: the 'rules' qualifier here cannot actually be applied to a specific queue.\n"
            "Use of the 'rules' qualifier causes queuerules.conf to be reloaded. Even if only\n"
            "one queue is specified when using this command, reloading queue rules may cause\n"
            "other queues to be affected\n";
         return NULL;
      case CLI_GENERATE:
         if (a->pos >= 3) {
            return complete_queue(a->line, a->word, a->pos, a->n);
         } else {
            return NULL;
         }
   }

   if (a->argc < 3)
      return CLI_SHOWUSAGE;

   if (!strcasecmp(a->argv[2], "rules")) {
      ast_set_flag(&mask, QUEUE_RELOAD_RULES);
   } else if (!strcasecmp(a->argv[2], "members")) {
      ast_set_flag(&mask, QUEUE_RELOAD_MEMBER);
   } else if (!strcasecmp(a->argv[2], "parameters")) {
      ast_set_flag(&mask, QUEUE_RELOAD_PARAMETERS);
   } else if (!strcasecmp(a->argv[2], "all")) {
      ast_set_flag(&mask, AST_FLAGS_ALL);
   }

   if (a->argc == 3) {
      reload_handler(1, &mask, NULL);
      return CLI_SUCCESS;
   }

   for (i = 3; i < a->argc; ++i) {
      reload_handler(1, &mask, a->argv[i]);
   }

   return CLI_SUCCESS;
}

static char* handle_queue_remove_member	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)			[static]

Definition at line 7098 of file app_queue.c.

References ast_cli_args::argc, ast_cli_args::argv, ast_cli(), ast_queue_log(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, complete_queue_remove_member(), ast_cli_args::fd, ast_cli_args::line, ast_cli_args::n, ast_cli_args::pos, remove_from_queue(), RES_EXISTS, RES_NOSUCHQUEUE, RES_NOT_DYNAMIC, RES_OKAY, RES_OUTOFMEMORY, ast_cli_entry::usage, and ast_cli_args::word.

{
   const char *queuename, *interface;

   switch (cmd) {
   case CLI_INIT:
      e->command = "queue remove member";
      e->usage = 
         "Usage: queue remove member <channel> from <queue>\n"
         "       Remove a specific channel from a queue.\n";
      return NULL;
   case CLI_GENERATE:
      return complete_queue_remove_member(a->line, a->word, a->pos, a->n);
   }

   if (a->argc != 6) {
      return CLI_SHOWUSAGE;
   } else if (strcmp(a->argv[4], "from")) {
      return CLI_SHOWUSAGE;
   }

   queuename = a->argv[5];
   interface = a->argv[3];

   switch (remove_from_queue(queuename, interface)) {
   case RES_OKAY:
      ast_queue_log(queuename, "CLI", interface, "REMOVEMEMBER", "%s", "");
      ast_cli(a->fd, "Removed interface '%s' from queue '%s'\n", interface, queuename);
      return CLI_SUCCESS;
   case RES_EXISTS:
      ast_cli(a->fd, "Unable to remove interface '%s' from queue '%s': Not there\n", interface, queuename);
      return CLI_FAILURE;
   case RES_NOSUCHQUEUE:
      ast_cli(a->fd, "Unable to remove interface from queue '%s': No such queue\n", queuename);
      return CLI_FAILURE;
   case RES_OUTOFMEMORY:
      ast_cli(a->fd, "Out of memory\n");
      return CLI_FAILURE;
   case RES_NOT_DYNAMIC:
      ast_cli(a->fd, "Unable to remove interface '%s' from queue '%s': Member is not dynamic\n", interface, queuename);
      return CLI_FAILURE;
   default:
      return CLI_FAILURE;
   }
}

static char* handle_queue_reset	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)			[static]

Definition at line 7333 of file app_queue.c.

References ast_cli_args::argc, ast_cli_args::argv, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, complete_queue(), ast_cli_args::line, ast_cli_args::n, ast_cli_args::pos, QUEUE_RESET_STATS, reload_handler(), ast_cli_entry::usage, and ast_cli_args::word.

{
   struct ast_flags mask = {QUEUE_RESET_STATS,};
   int i;

   switch (cmd) {
      case CLI_INIT:
         e->command = "queue reset stats";
         e->usage =
            "Usage: queue reset stats [<queuenames>]\n"
            "\n"
            "Issuing this command will reset statistics for\n"
            "<queuenames>, or for all queues if no queue is\n"
            "specified.\n";
         return NULL;
      case CLI_GENERATE:
         if (a->pos >= 3) {
            return complete_queue(a->line, a->word, a->pos, a->n);
         } else {
            return NULL;
         }
   }

   if (a->argc < 3) {
      return CLI_SHOWUSAGE;
   }

   if (a->argc == 3) {
      reload_handler(1, &mask, NULL);
      return CLI_SUCCESS;
   }

   for (i = 3; i < a->argc; ++i) {
      reload_handler(1, &mask, a->argv[i]);
   }

   return CLI_SUCCESS;
}

static char* handle_queue_rule_show	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)			[static]

Definition at line 7299 of file app_queue.c.

References ast_cli_args::argc, ast_cli_args::argv, ast_cli(), AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_strlen_zero(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, complete_queue_rule_show(), ast_cli_args::fd, ast_cli_args::line, penalty_rule::max_relative, penalty_rule::max_value, penalty_rule::min_relative, penalty_rule::min_value, ast_cli_args::n, rule_list::name, ast_cli_args::pos, rule_list::rules, penalty_rule::time, ast_cli_entry::usage, and ast_cli_args::word.

{
   const char *rule;
   struct rule_list *rl_iter;
   struct penalty_rule *pr_iter;
   switch (cmd) {
   case CLI_INIT:
      e->command = "queue show rules";
      e->usage =
      "Usage: queue show rules [rulename]\n"
      "  Show the list of rules associated with rulename. If no\n"
      "  rulename is specified, list all rules defined in queuerules.conf\n";
      return NULL;
   case CLI_GENERATE:
      return complete_queue_rule_show(a->line, a->word, a->pos, a->n);
   }

   if (a->argc != 3 && a->argc != 4)
      return CLI_SHOWUSAGE;

   rule = a->argc == 4 ? a->argv[3] : "";
   AST_LIST_LOCK(&rule_lists);
   AST_LIST_TRAVERSE(&rule_lists, rl_iter, list) {
      if (ast_strlen_zero(rule) || !strcasecmp(rl_iter->name, rule)) {
         ast_cli(a->fd, "Rule: %s\n", rl_iter->name);
         AST_LIST_TRAVERSE(&rl_iter->rules, pr_iter, list) {
            ast_cli(a->fd, "\tAfter %d seconds, adjust QUEUE_MAX_PENALTY %s %d and adjust QUEUE_MIN_PENALTY %s %d\n", pr_iter->time, pr_iter->max_relative ? "by" : "to", pr_iter->max_value, pr_iter->min_relative ? "by" : "to", pr_iter->min_value);
         }
      }
   }
   AST_LIST_UNLOCK(&rule_lists);
   return CLI_SUCCESS; 
}

static char* handle_queue_set_member_penalty	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)			[static]

Definition at line 7237 of file app_queue.c.

References ast_cli_args::argc, ast_cli_args::argv, ast_cli(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, complete_queue_set_member_penalty(), ast_cli_args::fd, ast_cli_args::line, ast_cli_args::n, ast_cli_args::pos, RESULT_FAILURE, RESULT_SUCCESS, set_member_penalty(), ast_cli_entry::usage, and ast_cli_args::word.

{
   const char *queuename = NULL, *interface;
   int penalty = 0;

   switch (cmd) {
   case CLI_INIT:
      e->command = "queue set penalty";
      e->usage = 
      "Usage: queue set penalty <penalty> on <interface> [in <queue>]\n"
      "  Set a member's penalty in the queue specified. If no queue is specified\n"
      "  then that interface's penalty is set in all queues to which that interface is a member\n";
      return NULL;
   case CLI_GENERATE:
      return complete_queue_set_member_penalty(a->line, a->word, a->pos, a->n);
   }

   if (a->argc != 6 && a->argc != 8) {
      return CLI_SHOWUSAGE;
   } else if (strcmp(a->argv[4], "on") || (a->argc > 6 && strcmp(a->argv[6], "in"))) {
      return CLI_SHOWUSAGE;
   }

   if (a->argc == 8)
      queuename = a->argv[7];
   interface = a->argv[5];
   penalty = atoi(a->argv[3]);

   switch (set_member_penalty(queuename, interface, penalty)) {
   case RESULT_SUCCESS:
      ast_cli(a->fd, "Set penalty on interface '%s' from queue '%s'\n", interface, queuename);
      return CLI_SUCCESS;
   case RESULT_FAILURE:
      ast_cli(a->fd, "Failed to set penalty on interface '%s' from queue '%s'\n", interface, queuename);
      return CLI_FAILURE;
   default:
      return CLI_FAILURE;
   }
}

static int handle_statechange

(

void *

datap

)

[static]

set a member's status based on device state of that member's interface

Definition at line 1191 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock(), ao2_ref, ao2_unlock(), ast_copy_string(), ast_debug, ast_devstate2str(), ast_free, statechange::dev, call_queue::found, call_queue::members, queues, statechange::state, member::state_interface, and update_status().

Referenced by device_state_cb().

{
   struct statechange *sc = datap;
   struct ao2_iterator miter, qiter;
   struct member *m;
   struct call_queue *q;
   char interface[80], *slash_pos;
   int found = 0;

   qiter = ao2_iterator_init(queues, 0);
   while ((q = ao2_iterator_next(&qiter))) {
      ao2_lock(q);

      miter = ao2_iterator_init(q->members, 0);
      for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
         ast_copy_string(interface, m->state_interface, sizeof(interface));

         if ((slash_pos = strchr(interface, '/')))
            if (!strncasecmp(interface, "Local/", 6) && (slash_pos = strchr(slash_pos + 1, '/')))
               *slash_pos = '\0';

         if (!strcasecmp(interface, sc->dev)) {
            found = 1;
            update_status(q, m, sc->state);
            ao2_ref(m, -1);
            break;
         }
      }
      ao2_iterator_destroy(&miter);

      ao2_unlock(q);
      ao2_ref(q, -1);
   }
   ao2_iterator_destroy(&qiter);

   if (found)
      ast_debug(1, "Device '%s' changed to state '%d' (%s)\n", sc->dev, sc->state, ast_devstate2str(sc->state));
   else
      ast_debug(3, "Device '%s' changed to state '%d' (%s) but we don't care because they're not a member of any queue.\n", sc->dev, sc->state, ast_devstate2str(sc->state));

   ast_free(sc);
   return 0;
}

static void hangupcalls	(	struct callattempt *	outgoing,
		struct ast_channel *	exception,
		int	cancel_answered_elsewhere
	)			[static]

Hang up a list of outgoing calls.

Definition at line 2455 of file app_queue.c.

References ao2_ref, AST_FLAG_ANSWERED_ELSEWHERE, ast_free, ast_hangup(), ast_set_flag, callattempt::chan, callattempt::member, and callattempt::q_next.

Referenced by try_calling().

{
   struct callattempt *oo;

   while (outgoing) {
      /* If someone else answered the call we should indicate this in the CANCEL */
      /* Hangup any existing lines we have open */
      if (outgoing->chan && (outgoing->chan != exception || cancel_answered_elsewhere)) {
         if (exception || cancel_answered_elsewhere)
            ast_set_flag(outgoing->chan, AST_FLAG_ANSWERED_ELSEWHERE);
         ast_hangup(outgoing->chan);
      }
      oo = outgoing;
      outgoing = outgoing->q_next;
      if (oo->member)
         ao2_ref(oo->member, -1);
      ast_free(oo);
   }
}

static void init_queue

(

struct call_queue *

q

)

[static]

Initialize Queue default values.

Note:

the queue's lock must be held before executing this function

Definition at line 1319 of file app_queue.c.

References call_queue::announcefrequency, call_queue::announceholdtime, call_queue::announceposition, ANNOUNCEPOSITION_YES, call_queue::announcepositionlimit, ao2_container_alloc, ast_free, AST_LIST_REMOVE_HEAD, ast_str_create(), ast_str_set(), ast_string_field_set, call_queue::autofill, call_queue::dead, DEFAULT_MIN_ANNOUNCE_FREQUENCY, DEFAULT_RETRY, DEFAULT_TIMEOUT, call_queue::eventwhencalled, call_queue::found, call_queue::joinempty, call_queue::leavewhenempty, call_queue::maskmemberstatus, MAX_PERIODIC_ANNOUNCEMENTS, call_queue::maxlen, member_cmp_fn(), member_hash_fn(), call_queue::memberdelay, call_queue::members, call_queue::minannouncefrequency, call_queue::monfmt, call_queue::montype, call_queue::numperiodicannounce, call_queue::periodicannouncefrequency, QUEUE_STRATEGY_LINEAR, call_queue::randomperiodicannounce, call_queue::reportholdtime, call_queue::retry, call_queue::ringinuse, call_queue::roundingseconds, call_queue::rules, call_queue::servicelevel, call_queue::setinterfacevar, call_queue::setqueueentryvar, call_queue::setqueuevar, call_queue::sound_periodicannounce, call_queue::strategy, call_queue::timeout, TIMEOUT_PRIORITY_APP, call_queue::timeoutpriority, call_queue::timeoutrestart, call_queue::weight, and call_queue::wrapuptime.

Referenced by find_queue_by_name_rt(), and reload_single_queue().

{
   int i;
   struct penalty_rule *pr_iter;

   q->dead = 0;
   q->retry = DEFAULT_RETRY;
   q->timeout = DEFAULT_TIMEOUT;
   q->maxlen = 0;
   q->announcefrequency = 0;
   q->minannouncefrequency = DEFAULT_MIN_ANNOUNCE_FREQUENCY;
   q->announceholdtime = 1;
   q->announcepositionlimit = 10; /* Default 10 positions */
   q->announceposition = ANNOUNCEPOSITION_YES; /* Default yes */
   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->reportholdtime = 0;
   q->wrapuptime = 0;
   q->joinempty = 0;
   q->leavewhenempty = 0;
   q->memberdelay = 0;
   q->maskmemberstatus = 0;
   q->eventwhencalled = 0;
   q->weight = 0;
   q->timeoutrestart = 0;
   q->periodicannouncefrequency = 0;
   q->randomperiodicannounce = 0;
   q->numperiodicannounce = 0;
   q->timeoutpriority = TIMEOUT_PRIORITY_APP;
   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->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, queue_quantity1, "queue-quantity1");
   ast_string_field_set(q, queue_quantity2, "queue-quantity2");
   ast_string_field_set(q, sound_holdtime, "queue-holdtime");
   ast_string_field_set(q, sound_minutes, "queue-minutes");
   ast_string_field_set(q, sound_minute, "queue-minute");
   ast_string_field_set(q, sound_seconds, "queue-seconds");
   ast_string_field_set(q, sound_thanks, "queue-thankyou");
   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", "");
   }

   while ((pr_iter = AST_LIST_REMOVE_HEAD(&q->rules,list)))
      ast_free(pr_iter);
}

static void insert_entry	(	struct call_queue *	q,
		struct queue_ent *	prev,
		struct queue_ent *	new,
		int *	pos
	)			[inline, static]

Insert the 'new' entry after the 'prev' entry of queue 'q'.

Definition at line 1071 of file app_queue.c.

References call_queue::head, queue_ent::next, and queue_ent::parent.

Referenced by join_queue().

{
   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;
}

static int insert_penaltychange	(	const char *	list_name,
		const char *	content,
		const int	linenum
	)			[static]

Change queue penalty by adding rule.

Check rule for errors with time or fomatting, see if rule is relative to rest of queue, iterate list of rules to find correct insertion point, insert and return.

Return values:

	-1	on failure
	0	on success

Note:

Call this with the rule_lists locked

Definition at line 1417 of file app_queue.c.

References ast_calloc, ast_free, AST_LIST_INSERT_BEFORE_CURRENT, AST_LIST_INSERT_TAIL, AST_LIST_TRAVERSE, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_log(), ast_strdupa, ast_strlen_zero(), LOG_WARNING, penalty_rule::max_relative, penalty_rule::max_value, penalty_rule::min_relative, penalty_rule::min_value, rule_list::name, rule_list::rules, and penalty_rule::time.

Referenced by reload_queue_rules().

{
   char *timestr, *maxstr, *minstr, *contentdup;
   struct penalty_rule *rule = NULL, *rule_iter;
   struct rule_list *rl_iter;
   int penaltychangetime, inserted = 0;

   if (!(rule = ast_calloc(1, sizeof(*rule)))) {
      return -1;
   }

   contentdup = ast_strdupa(content);
   
   if (!(maxstr = strchr(contentdup, ','))) {
      ast_log(LOG_WARNING, "Improperly formatted penaltychange rule at line %d. Ignoring.\n", linenum);
      ast_free(rule);
      return -1;
   }

   *maxstr++ = '\0';
   timestr = contentdup;

   if ((penaltychangetime = atoi(timestr)) < 0) {
      ast_log(LOG_WARNING, "Improper time parameter specified for penaltychange rule at line %d. Ignoring.\n", linenum);
      ast_free(rule);
      return -1;
   }

   rule->time = penaltychangetime;

   if ((minstr = strchr(maxstr,',')))
      *minstr++ = '\0';
   
   /* The last check will evaluate true if either no penalty change is indicated for a given rule
    * OR if a min penalty change is indicated but no max penalty change is */
   if (*maxstr == '+' || *maxstr == '-' || *maxstr == '\0') {
      rule->max_relative = 1;
   }

   rule->max_value = atoi(maxstr);

   if (!ast_strlen_zero(minstr)) {
      if (*minstr == '+' || *minstr == '-')
         rule->min_relative = 1;
      rule->min_value = atoi(minstr);
   } else /*there was no minimum specified, so assume this means no change*/
      rule->min_relative = 1;

   /*We have the rule made, now we need to insert it where it belongs*/
   AST_LIST_TRAVERSE(&rule_lists, rl_iter, list){
      if (strcasecmp(rl_iter->name, list_name))
         continue;

      AST_LIST_TRAVERSE_SAFE_BEGIN(&rl_iter->rules, rule_iter, list) {
         if (rule->time < rule_iter->time) {
            AST_LIST_INSERT_BEFORE_CURRENT(rule, list);
            inserted = 1;
            break;
         }
      }
      AST_LIST_TRAVERSE_SAFE_END;
   
      if (!inserted) {
         AST_LIST_INSERT_TAIL(&rl_iter->rules, rule, list);
      }
   }

   return 0;
}

static const char* int2strat

(

int

strategy

)

[static]

Definition at line 1002 of file app_queue.c.

References ARRAY_LEN, strategy::name, and strategies.

Referenced by __queues_show(), manager_queues_status(), queue_function_var(), and set_queue_variables().

{
   int x;

   for (x = 0; x < ARRAY_LEN(strategies); x++) {
      if (strategy == strategies[x].strategy)
         return strategies[x].name;
   }

   return "<unknown>";
}

static struct member* interface_exists	(	struct call_queue *	q,
		const char *	interface
	)			[static, read]

Definition at line 4608 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, member::interface, and call_queue::members.

Referenced by add_to_queue(), get_member_penalty(), set_member_paused(), and set_member_penalty().

{
   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)) {
         ao2_iterator_destroy(&mem_iter);
         return mem;
      }
      ao2_ref(mem, -1);
   }
   ao2_iterator_destroy(&mem_iter);

   return NULL;
}

static int is_our_turn

(

struct queue_ent *

qe

)

[static]

Check if we should start attempting to call queue members.

A simple process, really. Count the number of members who are available to take our call and then see if we are in a position in the queue at which a member could accept our call.

Parameters:

[in]

qe

The caller who wants to know if it is his turn

Return values:

	0	It is not our turn
	1	It is our turn

Definition at line 3385 of file app_queue.c.

References ao2_lock(), ao2_unlock(), ast_debug, queue_ent::chan, call_queue::head, ast_channel::name, queue_ent::next, num_available_members(), queue_ent::parent, and queue_ent::pending.

Referenced by queue_exec(), and wait_our_turn().

{
   struct queue_ent *ch;
   int res;
   int avl;
   int idx = 0;
   /* This needs a lock. How many members are available to be served? */
   ao2_lock(qe->parent);

   avl = num_available_members(qe->parent);

   ch = qe->parent->head;

   ast_debug(1, "There %s %d available %s.\n", avl != 1 ? "are" : "is", avl, avl != 1 ? "members" : "member");

   while ((idx < avl) && (ch) && (ch != qe)) {
      if (!ch->pending)
         idx++;
      ch = ch->next;       
   }

   ao2_unlock(qe->parent);

   /* 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;
   }

   return res;
}

static int join_queue	(	char *	queuename,
		struct queue_ent *	qe,
		enum queue_result *	reason,
		int	position
	)			[static]

Definition at line 2097 of file app_queue.c.

References call_queue::announce, queue_ent::announce, ao2_lock(), ao2_unlock(), ast_copy_string(), ast_debug, ast_log(), queue_ent::chan, ast_channel::cid, ast_callerid::cid_name, ast_callerid::cid_num, call_queue::context, queue_ent::context, call_queue::count, EVENT_FLAG_CALL, get_member_status(), call_queue::head, insert_entry(), call_queue::joinempty, load_realtime_queue(), LOG_NOTICE, manager_event, queue_ent::max_penalty, call_queue::maxlen, queue_ent::min_penalty, call_queue::moh, queue_ent::moh, call_queue::name, ast_channel::name, queue_ent::next, queue_ent::pos, queue_ent::prio, QUEUE_FULL, QUEUE_JOINEMPTY, QUEUE_UNKNOWN, queues, S_OR, status, and ast_channel::uniqueid.

Referenced by queue_exec().

{
   struct call_queue *q;
   struct queue_ent *cur, *prev = NULL;
   int res = -1;
   int pos = 0;
   int inserted = 0;

   if (!(q = load_realtime_queue(queuename)))
      return res;

   ao2_lock(queues);
   ao2_lock(q);

   /* This is our one */
   if (q->joinempty) {
      int status = 0;
      if ((status = get_member_status(q, qe->max_penalty, qe->min_penalty, q->joinempty))) {
         *reason = QUEUE_JOINEMPTY;
         ao2_unlock(q);
         ao2_unlock(queues);
         return res;
      }
   }
   if (*reason == QUEUE_UNKNOWN && q->maxlen && (q->count >= q->maxlen))
      *reason = QUEUE_FULL;
   else if (*reason == QUEUE_UNKNOWN) {
      /* 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;
         }
         /* <= is necessary for the position comparison because it may not be possible to enter
          * at our desired position since higher-priority callers may have taken the position we want
          */
         if (!inserted && (qe->prio <= cur->prio) && position && (position <= pos + 1)) {
            insert_entry(q, prev, qe, &pos);
            /*pos is incremented inside insert_entry, so don't need to add 1 here*/
            if (position < pos) {
               ast_log(LOG_NOTICE, "Asked to be inserted at position %d but forced into position %d due to higher priority callers\n", position, 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\nCallerIDNum: %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 <unknown> */
         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 kill_dead_members	(	void *	obj,
		void *	arg,
		int	flags
	)			[static]

Definition at line 6084 of file app_queue.c.

References CMP_MATCH, member::delme, member::dynamic, call_queue::membercount, member::state_interface, and member::status.

Referenced by reload_single_queue().

{
   struct member *member = obj;
   struct call_queue *q = arg;

   if (!member->delme) {
      if (member->dynamic) {
         /* dynamic members were not counted toward the member count
          * when reloading members from queues.conf, so we do that here
          */
         q->membercount++;
      }
      member->status = ast_device_state(member->state_interface);
      return 0;
   } else {
      q->membercount--;
      return CMP_MATCH;
   }
}

static int kill_dead_queues	(	void *	obj,
		void *	arg,
		int	flags
	)			[static]

Definition at line 6222 of file app_queue.c.

References ast_strlen_zero(), CMP_MATCH, call_queue::dead, and call_queue::name.

Referenced by reload_queues().

{
   struct call_queue *q = obj;
   char *queuename = arg;
   if ((ast_strlen_zero(queuename) || !strcasecmp(queuename, q->name)) && q->dead) {
      return CMP_MATCH;
   } else {
      return 0;
   }
}

static void leave_queue

(

struct queue_ent *

qe

)

[static]

Caller leaving queue.

Search the queue to find the leaving client, if found remove from queue create manager event, move others up the queue.

Definition at line 2395 of file app_queue.c.

References ao2_lock(), ao2_unlink, ao2_unlock(), ast_debug, ast_free, AST_LIST_REMOVE_HEAD, ast_load_realtime(), ast_variables_destroy(), queue_ent::chan, call_queue::count, call_queue::dead, EVENT_FLAG_CALL, call_queue::head, manager_event, call_queue::name, ast_channel::name, queue_ent::next, queue_ent::parent, pbx_builtin_setvar_helper(), queue_ent::pos, queue_ent::qe_rules, queue_ref(), queue_unref(), queues, call_queue::realtime, SENTINEL, ast_channel::uniqueid, and var.

Referenced by queue_exec(), try_calling(), and wait_our_turn().

{
   struct call_queue *q;
   struct queue_ent *current, *prev = NULL;
   struct penalty_rule *pr_iter;
   int pos = 0;

   if (!(q = qe->parent))
      return;
   queue_ref(q);
   ao2_lock(q);

   prev = NULL;
   for (current = q->head; current; current = current->next) {
      if (current == qe) {
         char posstr[20];
         q->count--;

         /* Take us out of the queue */
         manager_event(EVENT_FLAG_CALL, "Leave",
            "Channel: %s\r\nQueue: %s\r\nCount: %d\r\nPosition: %d\r\nUniqueid: %s\r\n",
            qe->chan->name, q->name,  q->count, qe->pos, 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 = current->next;
         else
            q->head = current->next;
         /* Free penalty rules */
         while ((pr_iter = AST_LIST_REMOVE_HEAD(&qe->qe_rules, list)))
            ast_free(pr_iter);
         snprintf(posstr, sizeof(posstr), "%d", qe->pos);
         pbx_builtin_setvar_helper(qe->chan, "QUEUEPOSITION", posstr);
      } else {
         /* Renumber the people after us in the queue based on a new count */
         current->pos = ++pos;
         prev = current;
      }
   }
   ao2_unlock(q);

   /*If the queue is a realtime queue, check to see if it's still defined in real time*/
   if (q->realtime) {
      struct ast_variable *var;
      if (!(var = ast_load_realtime("queues", "name", q->name, SENTINEL))) {
         q->dead = 1;
      } else {
         ast_variables_destroy(var);
      }
   }

   if (q->dead) { 
      /* It's dead and nobody is in it, so kill it */
      ao2_unlink(queues, q);
   }
   /* unref the explicit ref earlier in the function */
   queue_unref(q);
}

static int load_module

(

void

)

[static]

Definition at line 7500 of file app_queue.c.

References ao2_container_alloc, aqm_exec(), ARRAY_LEN, ast_add_extension2(), ast_cli_register_multiple(), ast_context_find_or_create(), ast_custom_function_register, AST_EVENT_DEVICE_STATE, AST_EVENT_IE_END, ast_event_subscribe(), AST_FLAGS_ALL, ast_free_ptr, ast_log(), ast_manager_register_xml, AST_MODULE_LOAD_DECLINE, ast_realtime_require_field(), ast_register_application_xml, ast_strdup, ast_taskprocessor_get(), cli_queue, device_state_cb(), EVENT_FLAG_AGENT, LOG_ERROR, LOG_WARNING, manager_add_queue_member(), manager_pause_queue_member(), manager_queue_log_custom(), manager_queue_member_penalty(), manager_queue_reload(), manager_queue_reset(), manager_queue_rule_show(), manager_queues_show(), manager_queues_status(), manager_queues_summary(), manager_remove_queue_member(), MAX_QUEUE_BUCKETS, pqm_exec(), ql_exec(), queue_cmp_cb(), queue_exec(), queue_hash_cb(), queuemembercount_dep, queuemembercount_function, queuememberlist_function, queuememberpenalty_function, queues, queuevar_function, queuewaitingcount_function, reload_handler(), reload_queue_members(), RQ_INTEGER1, RQ_UINTEGER2, rqm_exec(), SENTINEL, and upqm_exec().

{
   int res;
   struct ast_context *con;
   struct ast_flags mask = {AST_FLAGS_ALL, };

   queues = ao2_container_alloc(MAX_QUEUE_BUCKETS, queue_hash_cb, queue_cmp_cb);

   use_weight = 0;

   if (reload_handler(0, &mask, NULL))
      return AST_MODULE_LOAD_DECLINE;

   con = ast_context_find_or_create(NULL, NULL, "app_queue_gosub_virtual_context", "app_queue");
   if (!con)
      ast_log(LOG_ERROR, "Queue virtual context 'app_queue_gosub_virtual_context' does not exist and unable to create\n");
   else
      ast_add_extension2(con, 1, "s", 1, NULL, NULL, "NoOp", ast_strdup(""), ast_free_ptr, "app_queue");

   if (queue_persistent_members)
      reload_queue_members();

   ast_cli_register_multiple(cli_queue, ARRAY_LEN(cli_queue));
   res = ast_register_application_xml(app, queue_exec);
   res |= ast_register_application_xml(app_aqm, aqm_exec);
   res |= ast_register_application_xml(app_rqm, rqm_exec);
   res |= ast_register_application_xml(app_pqm, pqm_exec);
   res |= ast_register_application_xml(app_upqm, upqm_exec);
   res |= ast_register_application_xml(app_ql, ql_exec);
   res |= ast_manager_register_xml("Queues", 0, manager_queues_show);
   res |= ast_manager_register_xml("QueueStatus", 0, manager_queues_status);
   res |= ast_manager_register_xml("QueueSummary", 0, manager_queues_summary);
   res |= ast_manager_register_xml("QueueAdd", EVENT_FLAG_AGENT, manager_add_queue_member);
   res |= ast_manager_register_xml("QueueRemove", EVENT_FLAG_AGENT, manager_remove_queue_member);
   res |= ast_manager_register_xml("QueuePause", EVENT_FLAG_AGENT, manager_pause_queue_member);
   res |= ast_manager_register_xml("QueueLog", EVENT_FLAG_AGENT, manager_queue_log_custom);
   res |= ast_manager_register_xml("QueuePenalty", EVENT_FLAG_AGENT, manager_queue_member_penalty);
   res |= ast_manager_register_xml("QueueRule", 0, manager_queue_rule_show);
   res |= ast_manager_register_xml("QueueReload", 0, manager_queue_reload);
   res |= ast_manager_register_xml("QueueReset", 0, manager_queue_reset);
   res |= ast_custom_function_register(&queuevar_function);
   res |= ast_custom_function_register(&queuemembercount_function);
   res |= ast_custom_function_register(&queuemembercount_dep);
   res |= ast_custom_function_register(&queuememberlist_function);
   res |= ast_custom_function_register(&queuewaitingcount_function);
   res |= ast_custom_function_register(&queuememberpenalty_function);

   if (!(devicestate_tps = ast_taskprocessor_get("app_queue", 0))) {
      ast_log(LOG_WARNING, "devicestate taskprocessor reference failed - devicestate notifications will not occur\n");
   }

   /* in the following subscribe call, do I use DEVICE_STATE, or DEVICE_STATE_CHANGE? */
   if (!(device_state_sub = ast_event_subscribe(AST_EVENT_DEVICE_STATE, device_state_cb, "AppQueue Device state", NULL, AST_EVENT_IE_END))) {
      res = -1;
   }

   ast_realtime_require_field("queue_members", "paused", RQ_INTEGER1, 1, "uniqueid", RQ_UINTEGER2, 5, SENTINEL);

   return res ? AST_MODULE_LOAD_DECLINE : 0;
}

static struct call_queue* load_realtime_queue

(

const char *

queuename

)

[static, read]

Note:

Load from realtime before taking the "queues" container lock, 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.

Definition at line 1971 of file app_queue.c.

References ao2_find, ao2_lock(), ao2_unlock(), ast_atomic_fetchadd_int(), ast_config_destroy(), ast_load_realtime(), ast_load_realtime_multientry(), ast_log(), ast_variables_destroy(), find_queue_by_name_rt(), LOG_ERROR, call_queue::name, OBJ_POINTER, queues, call_queue::realtime, SENTINEL, update_realtime_members(), and call_queue::weight.

Referenced by __queues_show(), add_to_queue(), join_queue(), queue_function_qac(), queue_function_qac_dep(), and reload_queue_members().

{
   struct ast_variable *queue_vars;
   struct ast_config *member_config = NULL;
   struct call_queue *q = NULL, tmpq = {
      .name = queuename,   
   };
   int prev_weight = 0;

   /* 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 "queues" container lock, 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, SENTINEL);
      if (queue_vars) {
         member_config = ast_load_realtime_multientry("queue_members", "interface LIKE", "%", "queue_name", queuename, SENTINEL);
         if (!member_config) {
            ast_log(LOG_ERROR, "no queue_members defined in your config (extconfig.conf).\n");
            ast_variables_destroy(queue_vars);
            return NULL;
         }
      }
      if (q) {
         prev_weight = q->weight ? 1 : 0;
      }

      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);
      }
      /* update the use_weight value if the queue's has gained or lost a weight */ 
      if (q) {
         if (!q->weight && prev_weight) {
            ast_atomic_fetchadd_int(&use_weight, -1);
         }
         if (q->weight && !prev_weight) {
            ast_atomic_fetchadd_int(&use_weight, +1);
         }
      }
      /* Other cases will end up with the proper value for use_weight */
      ao2_unlock(queues);

   } else {
      update_realtime_members(q);
   }
   return q;
}

static int manager_add_queue_member	(	struct mansession *	s,
		const struct message *	m
	)			[static]

Definition at line 6746 of file app_queue.c.

References add_to_queue(), ast_queue_log(), ast_strlen_zero(), ast_true(), astman_get_header(), astman_send_ack(), astman_send_error(), RES_EXISTS, RES_NOSUCHQUEUE, RES_OKAY, and RES_OUTOFMEMORY.

Referenced by load_module().

{
   const char *queuename, *interface, *penalty_s, *paused_s, *membername, *state_interface;
   int paused, penalty = 0;

   queuename = astman_get_header(m, "Queue");
   interface = astman_get_header(m, "Interface");
   penalty_s = astman_get_header(m, "Penalty");
   paused_s = astman_get_header(m, "Paused");
   membername = astman_get_header(m, "MemberName");
   state_interface = astman_get_header(m, "StateInterface");

   if (ast_strlen_zero(queuename)) {
      astman_send_error(s, m, "'Queue' not specified.");
      return 0;
   }

   if (ast_strlen_zero(interface)) {
      astman_send_error(s, m, "'Interface' not specified.");
      return 0;
   }

   if (ast_strlen_zero(penalty_s))
      penalty = 0;
   else if (sscanf(penalty_s, "%30d", &penalty) != 1 || penalty < 0)
      penalty = 0;

   if (ast_strlen_zero(paused_s))
      paused = 0;
   else
      paused = abs(ast_true(paused_s));

   switch (add_to_queue(queuename, interface, membername, penalty, paused, queue_persistent_members, state_interface)) {
   case RES_OKAY:
      ast_queue_log(queuename, "MANAGER", interface, "ADDMEMBER", "%s", "");
      astman_send_ack(s, m, "Added interface to queue");
      break;
   case RES_EXISTS:
      astman_send_error(s, m, "Unable to add interface: Already there");
      break;
   case RES_NOSUCHQUEUE:
      astman_send_error(s, m, "Unable to add interface to queue: No such queue");
      break;
   case RES_OUTOFMEMORY:
      astman_send_error(s, m, "Out of memory");
      break;
   }

   return 0;
}

static int manager_pause_queue_member	(	struct mansession *	s,
		const struct message *	m
	)			[static]

Definition at line 6831 of file app_queue.c.

References ast_strlen_zero(), ast_true(), astman_get_header(), astman_send_ack(), astman_send_error(), and set_member_paused().

Referenced by load_module().

{
   const char *queuename, *interface, *paused_s, *reason;
   int paused;

   interface = astman_get_header(m, "Interface");
   paused_s = astman_get_header(m, "Paused");
   queuename = astman_get_header(m, "Queue");      /* Optional - if not supplied, pause the given Interface in all queues */
   reason = astman_get_header(m, "Reason");        /* Optional - Only used for logging purposes */

   if (ast_strlen_zero(interface) || ast_strlen_zero(paused_s)) {
      astman_send_error(s, m, "Need 'Interface' and 'Paused' parameters.");
      return 0;
   }

   paused = abs(ast_true(paused_s));

   if (set_member_paused(queuename, interface, reason, paused))
      astman_send_error(s, m, "Interface not found");
   else
      astman_send_ack(s, m, paused ? "Interface paused successfully" : "Interface unpaused successfully");
   return 0;
}

static int manager_queue_log_custom	(	struct mansession *	s,
		const struct message *	m
	)			[static]

Definition at line 6855 of file app_queue.c.

References ast_queue_log(), ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), and S_OR.

Referenced by load_module().

{
   const char *queuename, *event, *message, *interface, *uniqueid;

   queuename = astman_get_header(m, "Queue");
   uniqueid = astman_get_header(m, "UniqueId");
   interface = astman_get_header(m, "Interface");
   event = astman_get_header(m, "Event");
   message = astman_get_header(m, "Message");

   if (ast_strlen_zero(queuename) || ast_strlen_zero(event)) {
      astman_send_error(s, m, "Need 'Queue' and 'Event' parameters.");
      return 0;
   }

   ast_queue_log(queuename, S_OR(uniqueid, "NONE"), interface, event, "%s", message);
   astman_send_ack(s, m, "Event added successfully");

   return 0;
}

static int manager_queue_member_penalty	(	struct mansession *	s,
		const struct message *	m
	)			[static]

Definition at line 6954 of file app_queue.c.

References ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), and set_member_penalty().

Referenced by load_module().

{
   const char *queuename, *interface, *penalty_s;
   int penalty;

   interface = astman_get_header(m, "Interface");
   penalty_s = astman_get_header(m, "Penalty");
   /* Optional - if not supplied, set the penalty value for the given Interface in all queues */
   queuename = astman_get_header(m, "Queue");

   if (ast_strlen_zero(interface) || ast_strlen_zero(penalty_s)) {
      astman_send_error(s, m, "Need 'Interface' and 'Penalty' parameters.");
      return 0;
   }
 
   penalty = atoi(penalty_s);

   if (set_member_penalty((char *)queuename, (char *)interface, penalty))
      astman_send_error(s, m, "Invalid interface, queuename or penalty");
   else
      astman_send_ack(s, m, "Interface penalty set successfully");

   return 0;
}

static int manager_queue_reload	(	struct mansession *	s,
		const struct message *	m
	)			[static]

Definition at line 6876 of file app_queue.c.

References AST_FLAGS_ALL, ast_set_flag, astman_get_header(), astman_send_ack(), astman_send_error(), QUEUE_RELOAD_MEMBER, QUEUE_RELOAD_PARAMETERS, QUEUE_RELOAD_RULES, reload_handler(), and S_OR.

Referenced by load_module().

{
   struct ast_flags mask = {0,};
   const char *queuename = NULL;
   int header_found = 0;

   queuename = astman_get_header(m, "Queue");
   if (!strcasecmp(S_OR(astman_get_header(m, "Members"), ""), "yes")) {
      ast_set_flag(&mask, QUEUE_RELOAD_MEMBER);
      header_found = 1;
   }
   if (!strcasecmp(S_OR(astman_get_header(m, "Rules"), ""), "yes")) {
      ast_set_flag(&mask, QUEUE_RELOAD_RULES);
      header_found = 1;
   }
   if (!strcasecmp(S_OR(astman_get_header(m, "Parameters"), ""), "yes")) {
      ast_set_flag(&mask, QUEUE_RELOAD_PARAMETERS);
      header_found = 1;
   }

   if (!header_found) {
      ast_set_flag(&mask, AST_FLAGS_ALL);
   }

   if (!reload_handler(1, &mask, queuename)) {
      astman_send_ack(s, m, "Queue reloaded successfully");
   } else {
      astman_send_error(s, m, "Error encountered while reloading queue");
   }
   return 0;
}

static int manager_queue_reset	(	struct mansession *	s,
		const struct message *	m
	)			[static]

Definition at line 6908 of file app_queue.c.

References astman_get_header(), astman_send_ack(), astman_send_error(), QUEUE_RESET_STATS, and reload_handler().

Referenced by load_module().

{
   const char *queuename = NULL;
   struct ast_flags mask = {QUEUE_RESET_STATS,};
   
   queuename = astman_get_header(m, "Queue");

   if (!reload_handler(1, &mask, queuename)) {
      astman_send_ack(s, m, "Queue stats reset successfully");
   } else {
      astman_send_error(s, m, "Error encountered while resetting queue stats");
   }
   return 0;
}

static int manager_queue_rule_show	(	struct mansession *	s,
		const struct message *	m
	)			[static]

Definition at line 6549 of file app_queue.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_strlen_zero(), astman_append(), astman_get_header(), penalty_rule::max_relative, penalty_rule::max_value, penalty_rule::min_relative, penalty_rule::min_value, rule_list::name, RESULT_SUCCESS, rule_list::rules, and penalty_rule::time.

Referenced by load_module().

{
   const char *rule = astman_get_header(m, "Rule");
   struct rule_list *rl_iter;
   struct penalty_rule *pr_iter;

   AST_LIST_LOCK(&rule_lists);
   AST_LIST_TRAVERSE(&rule_lists, rl_iter, list) {
      if (ast_strlen_zero(rule) || !strcasecmp(rule, rl_iter->name)) {
         astman_append(s, "RuleList: %s\r\n", rl_iter->name);
         AST_LIST_TRAVERSE(&rl_iter->rules, pr_iter, list) {
            astman_append(s, "Rule: %d,%s%d,%s%d\r\n", pr_iter->time, pr_iter->max_relative && pr_iter->max_value >= 0 ? "+" : "", pr_iter->max_value, pr_iter->min_relative && pr_iter->min_value >= 0 ? "+" : "", pr_iter->min_value );
         }
         if (!ast_strlen_zero(rule))
            break;
      }
   }
   AST_LIST_UNLOCK(&rule_lists);

   astman_append(s, "\r\n\r\n");

   return RESULT_SUCCESS;
}

static int manager_queues_show	(	struct mansession *	s,
		const struct message *	m
	)			[static]

Definition at line 6539 of file app_queue.c.

References __queues_show(), astman_append(), and RESULT_SUCCESS.

Referenced by load_module().

{
   static const char * const a[] = { "queue", "show" };

   __queues_show(s, -1, 2, a);
   astman_append(s, "\r\n\r\n"); /* Properly terminate Manager output */

   return RESULT_SUCCESS;
}

static int manager_queues_status	(	struct mansession *	s,
		const struct message *	m
	)			[static]

Queue status info via AMI.

Definition at line 6649 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock(), ao2_ref, ao2_unlock(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_ack(), member::calls, call_queue::callsabandoned, call_queue::callscompleted, call_queue::callscompletedinsl, queue_ent::chan, ast_channel::cid, ast_callerid::cid_name, ast_callerid::cid_num, call_queue::count, member::dynamic, call_queue::head, call_queue::holdtime, int2strat(), member::interface, member::lastcall, call_queue::maxlen, member::membername, call_queue::members, ast_channel::name, call_queue::name, queue_ent::next, member::paused, member::penalty, queue_ent::pos, queue_unref(), queues, RESULT_SUCCESS, S_OR, call_queue::servicelevel, queue_ent::start, member::status, call_queue::strategy, call_queue::talktime, ast_channel::uniqueid, and call_queue::weight.

Referenced by load_module().

{
   time_t now;
   int pos;
   const char *id = astman_get_header(m,"ActionID");
   const char *queuefilter = astman_get_header(m,"Queue");
   const char *memberfilter = astman_get_header(m,"Member");
   char idText[256] = "";
   struct call_queue *q;
   struct queue_ent *qe;
   float sl = 0;
   struct member *mem;
   struct ao2_iterator queue_iter;
   struct ao2_iterator mem_iter;

   astman_send_ack(s, m, "Queue status will follow");
   time(&now);
   if (!ast_strlen_zero(id))
      snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id);

   queue_iter = ao2_iterator_init(queues, 0);
   while ((q = ao2_iterator_next(&queue_iter))) {
      ao2_lock(q);

      /* List queue properties */
      if (ast_strlen_zero(queuefilter) || !strcmp(q->name, queuefilter)) {
         sl = ((q->callscompleted > 0) ? 100 * ((float)q->callscompletedinsl / (float)q->callscompleted) : 0);
         astman_append(s, "Event: QueueParams\r\n"
            "Queue: %s\r\n"
            "Max: %d\r\n"
            "Strategy: %s\r\n"
            "Calls: %d\r\n"
            "Holdtime: %d\r\n"
            "TalkTime: %d\r\n"
            "Completed: %d\r\n"
            "Abandoned: %d\r\n"
            "ServiceLevel: %d\r\n"
            "ServicelevelPerf: %2.1f\r\n"
            "Weight: %d\r\n"
            "%s"
            "\r\n",
            q->name, q->maxlen, int2strat(q->strategy), q->count, q->holdtime, q->talktime, q->callscompleted,
            q->callsabandoned, q->servicelevel, sl, q->weight, idText);
         /* List Queue Members */
         mem_iter = ao2_iterator_init(q->members, 0);
         while ((mem = ao2_iterator_next(&mem_iter))) {
            if (ast_strlen_zero(memberfilter) || !strcmp(mem->interface, memberfilter) || !strcmp(mem->membername, memberfilter)) {
               astman_append(s, "Event: QueueMember\r\n"
                  "Queue: %s\r\n"
                  "Name: %s\r\n"
                  "Location: %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"
                  "%s"
                  "\r\n",
                  q->name, mem->membername, mem->interface, mem->dynamic ? "dynamic" : "static",
                  mem->penalty, mem->calls, (int)mem->lastcall, mem->status, mem->paused, idText);
            }
            ao2_ref(mem, -1);
         }
         ao2_iterator_destroy(&mem_iter);
         /* List Queue Entries */
         pos = 1;
         for (qe = q->head; qe; qe = qe->next) {
            astman_append(s, "Event: QueueEntry\r\n"
               "Queue: %s\r\n"
               "Position: %d\r\n"
               "Channel: %s\r\n"
               "Uniqueid: %s\r\n"
               "CallerIDNum: %s\r\n"
               "CallerIDName: %s\r\n"
               "Wait: %ld\r\n"
               "%s"
               "\r\n",
               q->name, pos++, qe->chan->name, qe->chan->uniqueid,
               S_OR(qe->chan->cid.cid_num, "unknown"),
               S_OR(qe->chan->cid.cid_name, "unknown"),
               (long) (now - qe->start), idText);
         }
      }
      ao2_unlock(q);
      queue_unref(q);
   }
   ao2_iterator_destroy(&queue_iter);

   astman_append(s,
      "Event: QueueStatusComplete\r\n"
      "%s"
      "\r\n",idText);

   return RESULT_SUCCESS;
}

static int manager_queues_summary	(	struct mansession *	s,
		const struct message *	m
	)			[static]

Summary of queue info via the AMI.

Definition at line 6574 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock(), ao2_ref, ao2_unlock(), AST_DEVICE_INVALID, AST_DEVICE_NOT_INUSE, AST_DEVICE_UNAVAILABLE, AST_DEVICE_UNKNOWN, ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_ack(), call_queue::head, call_queue::holdtime, call_queue::members, call_queue::name, queue_ent::next, member::paused, queue_unref(), queues, RESULT_SUCCESS, queue_ent::start, member::status, and call_queue::talktime.

Referenced by load_module().

{
   time_t now;
   int qmemcount = 0;
   int qmemavail = 0;
   int qchancount = 0;
   int qlongestholdtime = 0;
   const char *id = astman_get_header(m, "ActionID");
   const char *queuefilter = astman_get_header(m, "Queue");
   char idText[256] = "";
   struct call_queue *q;
   struct queue_ent *qe;
   struct member *mem;
   struct ao2_iterator queue_iter;
   struct ao2_iterator mem_iter;

   astman_send_ack(s, m, "Queue summary will follow");
   time(&now);
   if (!ast_strlen_zero(id))
      snprintf(idText, 256, "ActionID: %s\r\n", id);
   queue_iter = ao2_iterator_init(queues, 0);
   while ((q = ao2_iterator_next(&queue_iter))) {
      ao2_lock(q);

      /* List queue properties */
      if (ast_strlen_zero(queuefilter) || !strcmp(q->name, queuefilter)) {
         /* Reset the necessary local variables if no queuefilter is set*/
         qmemcount = 0;
         qmemavail = 0;
         qchancount = 0;
         qlongestholdtime = 0;

         /* List Queue Members */
         mem_iter = ao2_iterator_init(q->members, 0);
         while ((mem = ao2_iterator_next(&mem_iter))) {
            if ((mem->status != AST_DEVICE_UNAVAILABLE) && (mem->status != AST_DEVICE_INVALID)) {
               ++qmemcount;
               if (((mem->status == AST_DEVICE_NOT_INUSE) || (mem->status == AST_DEVICE_UNKNOWN)) && !(mem->paused)) {
                  ++qmemavail;
               }
            }
            ao2_ref(mem, -1);
         }
         ao2_iterator_destroy(&mem_iter);
         for (qe = q->head; qe; qe = qe->next) {
            if ((now - qe->start) > qlongestholdtime) {
               qlongestholdtime = now - qe->start;
            }
            ++qchancount;
         }
         astman_append(s, "Event: QueueSummary\r\n"
            "Queue: %s\r\n"
            "LoggedIn: %d\r\n"
            "Available: %d\r\n"
            "Callers: %d\r\n" 
            "HoldTime: %d\r\n"
            "TalkTime: %d\r\n"
            "LongestHoldTime: %d\r\n"
            "%s"
            "\r\n",
            q->name, qmemcount, qmemavail, qchancount, q->holdtime, q->talktime, qlongestholdtime, idText);
      }
      ao2_unlock(q);
      queue_unref(q);
   }
   ao2_iterator_destroy(&queue_iter);
   astman_append(s,
      "Event: QueueSummaryComplete\r\n"
      "%s"
      "\r\n", idText);

   return RESULT_SUCCESS;
}

static int manager_remove_queue_member	(	struct mansession *	s,
		const struct message *	m
	)			[static]

Definition at line 6797 of file app_queue.c.

References ast_queue_log(), ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), remove_from_queue(), RES_EXISTS, RES_NOSUCHQUEUE, RES_NOT_DYNAMIC, RES_OKAY, and RES_OUTOFMEMORY.

Referenced by load_module().

{
   const char *queuename, *interface;

   queuename = astman_get_header(m, "Queue");
   interface = astman_get_header(m, "Interface");

   if (ast_strlen_zero(queuename) || ast_strlen_zero(interface)) {
      astman_send_error(s, m, "Need 'Queue' and 'Interface' parameters.");
      return 0;
   }

   switch (remove_from_queue(queuename, interface)) {
   case RES_OKAY:
      ast_queue_log(queuename, "MANAGER", interface, "REMOVEMEMBER", "%s", "");
      astman_send_ack(s, m, "Removed interface from queue");
      break;
   case RES_EXISTS:
      astman_send_error(s, m, "Unable to remove interface: Not there");
      break;
   case RES_NOSUCHQUEUE:
      astman_send_error(s, m, "Unable to remove interface from queue: No such queue");
      break;
   case RES_OUTOFMEMORY:
      astman_send_error(s, m, "Out of memory");
      break;
   case RES_NOT_DYNAMIC:
      astman_send_error(s, m, "Member not dynamic");
      break;
   }

   return 0;
}

static int mark_dead_and_unfound	(	void *	obj,
		void *	arg,
		int	flags
	)			[static]

Definition at line 6211 of file app_queue.c.

References ast_strlen_zero(), call_queue::dead, call_queue::found, call_queue::name, and call_queue::realtime.

Referenced by reload_queues().

{
   struct call_queue *q = obj;
   char *queuename = arg;
   if (!q->realtime && (ast_strlen_zero(queuename) || !strcasecmp(queuename, q->name))) {
      q->dead = 1;
      q->found = 0;
   }
   return 0;
}

static int mark_member_dead	(	void *	obj,
		void *	arg,
		int	flags
	)			[static]

Definition at line 6075 of file app_queue.c.

References member::delme, and member::dynamic.

Referenced by reload_single_queue().

{
   struct member *member = obj;
   if (!member->dynamic) {
      member->delme = 1;
   }
   return 0;
}

static int member_cmp_fn	(	void *	obj1,
		void *	obj2,
		int	flags
	)			[static]

Definition at line 1309 of file app_queue.c.

References CMP_MATCH, CMP_STOP, and member::interface.

Referenced by init_queue().

{
   struct member *mem1 = obj1, *mem2 = obj2;
   return strcasecmp(mem1->interface, mem2->interface) ? 0 : CMP_MATCH | CMP_STOP;
}

static int member_hash_fn	(	const void *	obj,
		const int	flags
	)			[static]

Definition at line 1297 of file app_queue.c.

References compress_char(), and member::interface.

Referenced by init_queue().

{
   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 num_available_members

(

struct call_queue *

q

)

[static]

Get the number of members available to accept a call.

Note:

The queue passed in should be locked prior to this function call

Parameters:

[in]

q

The queue for which we are couting the number of available members

Returns:

Return the number of available members in queue q

Definition at line 2483 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, AST_DEVICE_INUSE, AST_DEVICE_NOT_INUSE, AST_DEVICE_UNKNOWN, call_queue::autofill, call_queue::members, member::paused, QUEUE_STRATEGY_RINGALL, call_queue::ringinuse, member::status, and call_queue::strategy.

Referenced by compare_weight(), and is_our_turn().

{
   struct member *mem;
   int avl = 0;
   struct ao2_iterator mem_iter;

   mem_iter = ao2_iterator_init(q->members, 0);
   while ((mem = ao2_iterator_next(&mem_iter))) {
      switch (mem->status) {
      case AST_DEVICE_INUSE:
         if (!q->ringinuse)
            break;
         /* else fall through */
      case AST_DEVICE_NOT_INUSE:
      case AST_DEVICE_UNKNOWN:
         if (!mem->paused) {
            avl++;
         }
         break;
      }
      ao2_ref(mem, -1);

      /* If autofill is not enabled or if the queue's strategy is ringall, then
       * we really don't care about the number of available members so much as we
       * do that there is at least one available.
       *
       * In fact, we purposely will return from this function stating that only
       * one member is available if either of those conditions hold. That way,
       * functions which determine what action to take based on the number of available
       * members will operate properly. The reasoning is that even if multiple
       * members are available, only the head caller can actually be serviced.
       */
      if ((!q->autofill || q->strategy == QUEUE_STRATEGY_RINGALL) && avl) {
         break;
      }
   }
   ao2_iterator_destroy(&mem_iter);

   return avl;
}

static void parse_empty_options	(	const char *	value,
		enum empty_conditions *	empty,
		int	joinempty
	)			[static]

Definition at line 1487 of file app_queue.c.

References ast_false(), ast_log(), ast_strdupa, ast_true(), LOG_WARNING, QUEUE_EMPTY_INUSE, QUEUE_EMPTY_INVALID, QUEUE_EMPTY_PAUSED, QUEUE_EMPTY_PENALTY, QUEUE_EMPTY_RINGING, QUEUE_EMPTY_UNAVAILABLE, QUEUE_EMPTY_UNKNOWN, QUEUE_EMPTY_WRAPUP, and strsep().

Referenced by queue_set_param().

{
   char *value_copy = ast_strdupa(value);
   char *option = NULL;
   while ((option = strsep(&value_copy, ","))) {
      if (!strcasecmp(option, "paused")) {
         *empty |= QUEUE_EMPTY_PAUSED;
      } else if (!strcasecmp(option, "penalty")) {
         *empty |= QUEUE_EMPTY_PENALTY;
      } else if (!strcasecmp(option, "inuse")) {
         *empty |= QUEUE_EMPTY_INUSE;
      } else if (!strcasecmp(option, "ringing")) {
         *empty |= QUEUE_EMPTY_RINGING;
      } else if (!strcasecmp(option, "invalid")) {
         *empty |= QUEUE_EMPTY_INVALID;
      } else if (!strcasecmp(option, "wrapup")) {
         *empty |= QUEUE_EMPTY_WRAPUP;
      } else if (!strcasecmp(option, "unavailable")) {
         *empty |= QUEUE_EMPTY_UNAVAILABLE;
      } else if (!strcasecmp(option, "unknown")) {
         *empty |= QUEUE_EMPTY_UNKNOWN;
      } else if (!strcasecmp(option, "loose")) {
         *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID);
      } else if (!strcasecmp(option, "strict")) {
         *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED | QUEUE_EMPTY_UNAVAILABLE);
      } else if ((ast_false(option) && joinempty) || (ast_true(option) && !joinempty)) {
         *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED);
      } else if ((ast_false(option) && !joinempty) || (ast_true(option) && joinempty)) {
         *empty = 0;
      } else {
         ast_log(LOG_WARNING, "Unknown option %s for '%s'\n", option, joinempty ? "joinempty" : "leavewhenempty");
      }
   }
}

static int play_file	(	struct ast_channel *	chan,
		const char *	filename
	)			[static]

Definition at line 2175 of file app_queue.c.

References AST_DIGIT_ANY, ast_stopstream(), ast_streamfile(), ast_strlen_zero(), ast_waitstream(), and ast_channel::language.

Referenced by say_periodic_announcement(), say_position(), and try_calling().

{
   int res;

   if (ast_strlen_zero(filename)) {
      return 0;
   }

   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 pqm_exec	(	struct ast_channel *	chan,
		const char *	data
	)			[static]

PauseQueueMember application.

Definition at line 5041 of file app_queue.c.

References AST_APP_ARG, AST_DECLARE_APP_ARGS, ast_log(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), LOG_WARNING, parse(), pbx_builtin_setvar_helper(), and set_member_paused().

Referenced by load_module().

{
   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 0;
   }

   pbx_builtin_setvar_helper(chan, "PQMSTATUS", "PAUSED");

   return 0;
}

static int ql_exec	(	struct ast_channel *	chan,
		const char *	data
	)			[static]

QueueLog application.

Definition at line 5233 of file app_queue.c.

References AST_APP_ARG, AST_DECLARE_APP_ARGS, ast_log(), ast_queue_log(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), LOG_WARNING, and parse().

Referenced by load_module().

{
   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_cmp_cb	(	void *	obj,
		void *	arg,
		int	flags
	)			[static]

Definition at line 1033 of file app_queue.c.

References CMP_MATCH, CMP_STOP, and call_queue::name.

Referenced by load_module().

{
   struct call_queue *q = obj, *q2 = arg;
   return !strcasecmp(q->name, q2->name) ? CMP_MATCH | CMP_STOP : 0;
}

static int queue_exec	(	struct ast_channel *	chan,
		const char *	data
	)			[static]

The starting point for all queue calls.

The process involved here is to 1. Parse the options specified in the call to Queue() 2. Join the queue 3. Wait in a loop until it is our turn to try calling a queue member 4. Attempt to call a queue member 5. If 4. did not result in a bridged call, then check for between call options such as periodic announcements etc. 6. Try 4 again unless some condition (such as an expiration time) causes us to exit the queue.

Definition at line 5308 of file app_queue.c.

References call_queue::announcefrequency, AST_APP_ARG, ast_cdr_noanswer(), ast_channel_lock, ast_channel_unlock, AST_CONTROL_RINGING, ast_debug, AST_DECLARE_APP_ARGS, ast_indicate(), AST_LIST_FIRST, ast_log(), ast_moh_start(), ast_moh_stop(), ast_queue_log(), AST_STANDARD_APP_ARGS, ast_stopstream(), ast_strdupa, ast_strlen_zero(), ast_verb, ast_channel::cdr, queue_ent::chan, ast_channel::cid, ast_callerid::cid_num, copy_rules(), queue_ent::digits, queue_ent::expire, get_member_status(), queue_ent::handled, is_our_turn(), join_queue(), queue_ent::last_periodic_announce_sound, queue_ent::last_periodic_announce_time, queue_ent::last_pos, queue_ent::last_pos_said, leave_queue(), call_queue::leavewhenempty, LOG_WARNING, queue_ent::max_penalty, call_queue::membercount, queue_ent::min_penalty, queue_ent::moh, call_queue::name, ast_channel::name, queue_ent::opos, queue_ent::parent, parse(), pbx_builtin_getvar_helper(), call_queue::periodicannouncefrequency, queue_ent::pos, queue_ent::pr, queue_ent::prio, queue_ent::qe_rules, QUEUE_CONTINUE, QUEUE_LEAVEEMPTY, QUEUE_TIMEOUT, QUEUE_UNKNOWN, record_abandoned(), S_OR, say_periodic_announcement(), say_position(), set_queue_result(), set_queue_variables(), queue_ent::start, status, stop, penalty_rule::time, try_calling(), ast_channel::uniqueid, update_qe_rule(), update_realtime_members(), url, queue_ent::valid_digits, wait_a_bit(), and wait_our_turn().

Referenced by load_module().

{
   int res=-1;
   int ringing=0;
   const char *user_priority;
   const char *max_penalty_str;
   const char *min_penalty_str;
   int prio;
   int qcontinue = 0;
   int max_penalty, min_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;
   int position = 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);
      AST_APP_ARG(rule);
      AST_APP_ARG(position);
   );
   /* 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[,macro[,gosub[,rule[,position]]]]]]]]]\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 (!ast_strlen_zero(args.queuetimeoutstr))
      qe.expire = qe.start + atoi(args.queuetimeoutstr);
   else
      qe.expire = 0;

   /* Get the priority from the variable ${QUEUE_PRIO} */
   ast_channel_lock(chan);
   user_priority = pbx_builtin_getvar_helper(chan, "QUEUE_PRIO");
   if (user_priority) {
      if (sscanf(user_priority, "%30d", &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, "%30d", &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 ((min_penalty_str = pbx_builtin_getvar_helper(chan, "QUEUE_MIN_PENALTY"))) {
      if (sscanf(min_penalty_str, "%30d", &min_penalty) == 1) {
         ast_debug(1, "%s: Got min penalty %d from ${QUEUE_MIN_PENALTY}.\n", chan->name, min_penalty);
      } else {
         ast_log(LOG_WARNING, "${QUEUE_MIN_PENALTY}: Invalid value (%s), channel %s.\n",
            min_penalty_str, chan->name);
         min_penalty = 0;
      }
   } else {
      min_penalty = 0;
   }
   ast_channel_unlock(chan);

   if (args.options && (strchr(args.options, 'r')))
      ringing = 1;

   if (args.options && (strchr(args.options, 'c')))
      qcontinue = 1;

   if (args.position) {
      position = atoi(args.position);
      if (position < 0) {
         ast_log(LOG_WARNING, "Invalid position '%s' given for call to queue '%s'. Assuming no preference for position\n", args.position, args.queuename);
         position = 0;
      }
   }

   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.min_penalty = min_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, position)) {
      ast_log(LOG_WARNING, "Unable to join queue '%s'\n", args.queuename);
      set_queue_result(chan, reason);
      return 0;
   }
   ast_queue_log(args.queuename, chan->uniqueid, "NONE", "ENTERQUEUE", "%s|%s|%d", S_OR(args.url, ""),
      S_OR(chan->cid.cid_num, ""), qe.opos);
   copy_rules(&qe, args.rule);
   qe.pr = AST_LIST_FIRST(&qe.qe_rules);
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. */

      /* Leave if we have exceeded our queuetimeout */
      if (qe.expire && (time(NULL) >= qe.expire)) {
         record_abandoned(&qe);
         ast_cdr_noanswer(qe.chan->cdr);
         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;
   
      /* Leave if we have exceeded our queuetimeout */
      if (qe.expire && (time(NULL) >= qe.expire)) {
         record_abandoned(&qe);
         ast_cdr_noanswer(qe.chan->cdr);
         reason = QUEUE_TIMEOUT;
         res = 0;
         ast_queue_log(args.queuename, chan->uniqueid, "NONE", "EXITWITHTIMEOUT", "%d", qe.pos);
         break;
      }

      /* see if we need to move to the next penalty level for this queue */
      while (qe.pr && ((time(NULL) - qe.start) > qe.pr->time)) {
         update_qe_rule(&qe);
      }

      /* 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;
      }

      if (qe.parent->leavewhenempty) {
         int status = 0;
         if ((status = get_member_status(qe.parent, qe.max_penalty, qe.min_penalty, qe.parent->leavewhenempty))) {
            record_abandoned(&qe);
            ast_cdr_noanswer(qe.chan->cdr);
            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;
         }
      }

      /* 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);
         ast_cdr_noanswer(qe.chan->cdr);
         reason = QUEUE_TIMEOUT;
         res = 0;
         break;
      }

      
      /* Leave if we have exceeded our queuetimeout */
      if (qe.expire && (time(NULL) >= qe.expire)) {
         record_abandoned(&qe);
         ast_cdr_noanswer(qe.chan->cdr);
         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_cdr_noanswer(qe.chan->cdr);
            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 (qcontinue) {
            reason = QUEUE_CONTINUE;
            res = 0;
         }
      } 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 = 0; 
      if (ringing) {
         ast_indicate(chan, -1);
      } else {
         ast_moh_stop(chan);
      }        
      ast_stopstream(chan);
   }

   set_queue_variables(qe.parent, qe.chan);

   leave_queue(&qe);
   if (reason != QUEUE_UNKNOWN)
      set_queue_result(chan, reason);

   return res;
}

static int queue_function_memberpenalty_read	(	struct ast_channel *	chan,
		const char *	cmd,
		char *	data,
		char *	buf,
		size_t	len
	)			[static]

Dialplan function QUEUE_MEMBER_PENALTY() Gets the members penalty.

Definition at line 5827 of file app_queue.c.

References AST_APP_ARG, AST_DECLARE_APP_ARGS, ast_log(), AST_STANDARD_APP_ARGS, ast_strlen_zero(), get_member_penalty(), and LOG_ERROR.

{
   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(<queuename>,<interface>)\n");
      return -1;
   }

   AST_STANDARD_APP_ARGS(args, data);

   if (args.argc < 2) {
      ast_log(LOG_ERROR, "Missing argument. QUEUE_MEMBER_PENALTY(<queuename>,<interface>)\n");
      return -1;
   }

   penalty = get_member_penalty (args.queuename, args.interface);
   
   if (penalty >= 0) /* remember that buf is already '\0' */
      snprintf (buf, len, "%d", penalty);

   return 0;
}

static int queue_function_memberpenalty_write	(	struct ast_channel *	chan,
		const char *	cmd,
		char *	data,
		const char *	value
	)			[static]

Dialplan function QUEUE_MEMBER_PENALTY() Sets the members penalty.

Definition at line 5858 of file app_queue.c.

References AST_APP_ARG, AST_DECLARE_APP_ARGS, ast_log(), AST_STANDARD_APP_ARGS, ast_strlen_zero(), LOG_ERROR, and set_member_penalty().

{
   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(<queuename>,<interface>)\n");
      return -1;
   }

   AST_STANDARD_APP_ARGS(args, data);

   if (args.argc < 2) {
      ast_log(LOG_ERROR, "Missing argument. QUEUE_MEMBER_PENALTY(<queuename>,<interface>)\n");
      return -1;
   }

   penalty = atoi(value);

   if (ast_strlen_zero(args.interface)) {
      ast_log (LOG_ERROR, "<interface> parameter can't be null\n");
      return -1;
   }

   /* if queuename = NULL then penalty will be set for interface in all the queues. */
   if (set_member_penalty(args.queuename, args.interface, penalty)) {
      ast_log(LOG_ERROR, "Invalid interface, queue or penalty\n");
      return -1;
   }

   return 0;
}

static int queue_function_qac	(	struct ast_channel *	chan,
		const char *	cmd,
		char *	data,
		char *	buf,
		size_t	len
	)			[static]

Get number either busy / free or total members of a specific queue.

Return values:

	number	of members (busy / free / total)
	-1	on error

Definition at line 5646 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock(), ao2_ref, ao2_unlock(), AST_DEVICE_INVALID, AST_DEVICE_NOT_INUSE, AST_DEVICE_UNAVAILABLE, ast_log(), ast_strlen_zero(), call_queue::count, load_realtime_queue(), LOG_ERROR, LOG_WARNING, call_queue::membercount, call_queue::members, member::paused, queue_unref(), and member::status.

{
   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);
         }
         ao2_iterator_destroy(&mem_iter);
      } 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);
         }
         ao2_iterator_destroy(&mem_iter);
      } 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
	)			[static]

Get the total number of members in a specific queue (Deprecated).

Return values:

	number	of members
	-1	on error

Definition at line 5702 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock(), ao2_ref, ao2_unlock(), AST_DEVICE_INVALID, AST_DEVICE_UNAVAILABLE, ast_log(), ast_strlen_zero(), call_queue::count, load_realtime_queue(), LOG_ERROR, LOG_NOTICE, LOG_WARNING, call_queue::members, queue_unref(), and member::status.

{
   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_iterator_destroy(&mem_iter);
      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
	)			[static]

Dialplan function QUEUE_MEMBER_LIST() Get list of members in a specific queue.

Definition at line 5778 of file app_queue.c.

References ao2_find, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock(), ao2_ref, ao2_unlock(), ast_log(), ast_strlen_zero(), member::interface, LOG_ERROR, LOG_WARNING, call_queue::members, OBJ_POINTER, queue_unref(), and queues.

{
   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->interface, len - buflen - 1);
         buflen += strlen(m->interface);
         /* 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_iterator_destroy(&mem_iter);
      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;
}

static int queue_function_queuewaitingcount	(	struct ast_channel *	chan,
		const char *	cmd,
		char *	data,
		char *	buf,
		size_t	len
	)			[static]

Dialplan function QUEUE_WAITING_COUNT() Get number callers waiting in a specific queue.

Definition at line 5742 of file app_queue.c.

References ao2_find, ao2_lock(), ao2_unlock(), ast_load_realtime(), ast_log(), ast_strlen_zero(), ast_variables_destroy(), call_queue::count, LOG_ERROR, LOG_WARNING, OBJ_POINTER, queue_unref(), queues, SENTINEL, and var.

{
   int count = 0;
   struct call_queue *q, tmpq = {
      .name = data,  
   };
   struct ast_variable *var = NULL;

   buf[0] = '\0';
   
   if (ast_strlen_zero(data)) {
      ast_log(LOG_ERROR, "QUEUE_WAITING_COUNT requires an argument: queuename\n");
      return -1;
   }

   if ((q = ao2_find(queues, &tmpq, OBJ_POINTER))) {
      ao2_lock(q);
      count = q->count;
      ao2_unlock(q);
      queue_unref(q);
   } else if ((var = ast_load_realtime("queues", "name", data, SENTINEL))) {
      /* if the queue is realtime but was not found in memory, this
       * means that the queue had been deleted from memory since it was 
       * "dead." This means it has a 0 waiting count
       */
      count = 0;
      ast_variables_destroy(var);
   } else
      ast_log(LOG_WARNING, "queue %s was not found\n", data);

   snprintf(buf, len, "%d", count);

   return 0;
}

static int queue_function_var	(	struct ast_channel *	chan,
		const char *	cmd,
		char *	data,
		char *	buf,
		size_t	len
	)			[static]

create interface var with all queue details.

Return values:

	0	on success
	-1	on error

Definition at line 5598 of file app_queue.c.

References ao2_find, ao2_lock(), ao2_unlock(), ast_log(), ast_strlen_zero(), call_queue::callsabandoned, call_queue::callscompleted, call_queue::callscompletedinsl, call_queue::count, call_queue::holdtime, int2strat(), LOG_ERROR, LOG_WARNING, call_queue::maxlen, OBJ_POINTER, pbx_builtin_setvar_multiple(), queue_unref(), queues, call_queue::servicelevel, call_queue::setqueuevar, call_queue::strategy, and call_queue::talktime.

{
   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,QUEUETALKTIME=%d,QUEUECOMPLETED=%d,QUEUEABANDONED=%d,QUEUESRVLEVEL=%d,QUEUESRVLEVELPERF=%2.1f",
            q->maxlen, int2strat(q->strategy), q->count, q->holdtime, q->talktime, q->callscompleted, q->callsabandoned,  q->servicelevel, sl);

         pbx_builtin_setvar_multiple(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_hash_cb	(	const void *	obj,
		const int	flags
	)			[static]

Definition at line 1026 of file app_queue.c.

References ast_str_case_hash(), and call_queue::name.

Referenced by load_module().

{
   const struct call_queue *q = obj;

   return ast_str_case_hash(q->name);
}

static struct call_queue* queue_ref

(

struct call_queue *

q

)

[static, read]

Definition at line 1039 of file app_queue.c.

References ao2_ref.

Referenced by leave_queue(), and try_calling().

{
   ao2_ref(q, 1);
   return q;
}

static void queue_set_global_params

(

struct ast_config *

cfg

)

[static]

Set the global queue parameters as defined in the "general" section of queues.conf

Definition at line 5979 of file app_queue.c.

References ast_true(), and ast_variable_retrieve().

Referenced by reload_queues().

{
   const char *general_val = NULL;
   queue_persistent_members = 0;
   if ((general_val = ast_variable_retrieve(cfg, "general", "persistentmembers")))
      queue_persistent_members = ast_true(general_val);
   autofill_default = 0;
   if ((general_val = ast_variable_retrieve(cfg, "general", "autofill")))
      autofill_default = ast_true(general_val);
   montype_default = 0;
   if ((general_val = ast_variable_retrieve(cfg, "general", "monitor-type"))) {
      if (!strcasecmp(general_val, "mixmonitor"))
         montype_default = 1;
   }
   update_cdr = 0;
   if ((general_val = ast_variable_retrieve(cfg, "general", "updatecdr")))
      update_cdr = ast_true(general_val);
   shared_lastcall = 0;
   if ((general_val = ast_variable_retrieve(cfg, "general", "shared_lastcall")))
      shared_lastcall = ast_true(general_val);
}

static void queue_set_param	(	struct call_queue *	q,
		const char *	param,
		const char *	val,
		int	linenum,
		int	failunknown
	)			[static]

Configure a queue parameter.

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.

Note:

For error reporting, line number is passed for .conf static configuration, for Realtime queues, linenum is -1.

Definition at line 1530 of file app_queue.c.

References queue_ent::announce, call_queue::announcefrequency, call_queue::announceholdtime, ANNOUNCEHOLDTIME_ALWAYS, ANNOUNCEHOLDTIME_ONCE, call_queue::announceposition, ANNOUNCEPOSITION_LIMIT, ANNOUNCEPOSITION_MORE_THAN, ANNOUNCEPOSITION_NO, ANNOUNCEPOSITION_YES, call_queue::announcepositionlimit, ast_copy_string(), ast_debug, ast_log(), ast_str_create(), ast_str_set(), ast_strdupa, ast_string_field_set, ast_true(), call_queue::autofill, call_queue::autopause, buf, queue_ent::context, DEFAULT_RETRY, DEFAULT_TIMEOUT, call_queue::eventwhencalled, call_queue::joinempty, call_queue::leavewhenempty, LOG_WARNING, call_queue::maskmemberstatus, MAX_PERIODIC_ANNOUNCEMENTS, call_queue::maxlen, call_queue::memberdelay, call_queue::minannouncefrequency, queue_ent::moh, call_queue::monfmt, call_queue::montype, call_queue::name, call_queue::numperiodicannounce, parse_empty_options(), call_queue::periodicannouncefrequency, QUEUE_EVENT_VARIABLES, QUEUE_STRATEGY_LINEAR, QUEUE_STRATEGY_RINGALL, call_queue::randomperiodicannounce, call_queue::reportholdtime, call_queue::retry, call_queue::ringinuse, call_queue::roundingseconds, s, call_queue::servicelevel, call_queue::setinterfacevar, call_queue::setqueueentryvar, call_queue::setqueuevar, call_queue::sound_periodicannounce, strat2int(), call_queue::strategy, strsep(), call_queue::timeout, TIMEOUT_PRIORITY_APP, TIMEOUT_PRIORITY_CONF, call_queue::timeoutpriority, call_queue::timeoutrestart, call_queue::weight, and call_queue::wrapuptime.

Referenced by find_queue_by_name_rt(), and reload_single_queue().

{
   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-quantity1")) {
      ast_string_field_set(q, queue_quantity1, val);
   } else if (!strcasecmp(param, "queue-quantity2")) {
      ast_string_field_set(q, queue_quantity2, 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-minute")) {
      ast_string_field_set(q, sound_minute, val);
   } else if (!strcasecmp(param, "queue-seconds")) {
      ast_string_field_set(q, sound_seconds, 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 == 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")) {
      if (!strcasecmp(val, "limit"))
         q->announceposition = ANNOUNCEPOSITION_LIMIT;
      else if (!strcasecmp(val, "more"))
         q->announceposition = ANNOUNCEPOSITION_MORE_THAN;
      else if (ast_true(val))
         q->announceposition = ANNOUNCEPOSITION_YES;
      else
         q->announceposition = ANNOUNCEPOSITION_NO;
   } else if (!strcasecmp(param, "announce-position-limit")) {
      q->announcepositionlimit = atoi(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", s);
            i++;
            if (i == MAX_PERIODIC_ANNOUNCEMENTS)
               break;
         }
         q->numperiodicannounce = i;
      } else {
         ast_str_set(&q->sound_periodicannounce[0], 0, "%s", val);
         q->numperiodicannounce = 1;
      }
   } else if (!strcasecmp(param, "periodic-announce-frequency")) {
      q->periodicannouncefrequency = atoi(val);
   } else if (!strcasecmp(param, "random-periodic-announce")) {
      q->randomperiodicannounce = ast_true(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")) {
      int strategy;

      /* We are a static queue and already have set this, no need to do it again */
      if (failunknown) {
         return;
      }
      strategy = strat2int(val);
      if (strategy < 0) {
         ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
            val, q->name);
         q->strategy = QUEUE_STRATEGY_RINGALL;
      }
      if (strategy == q->strategy) {
         return;
      }
      if (strategy == QUEUE_STRATEGY_LINEAR) {
         ast_log(LOG_WARNING, "Changing to the linear strategy currently requires asterisk to be restarted.\n");
         return;
      }
      q->strategy = strategy;
   } else if (!strcasecmp(param, "joinempty")) {
      parse_empty_options(val, &q->joinempty, 1);
   } else if (!strcasecmp(param, "leavewhenempty")) {
      parse_empty_options(val, &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) ? 1 : 0;
      }
   } 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);
   } else if (!strcasecmp(param, "timeoutrestart")) {
      q->timeoutrestart = ast_true(val);
   } else if (!strcasecmp(param, "defaultrule")) {
      ast_string_field_set(q, defaultrule, val);
   } else if (!strcasecmp(param, "timeoutpriority")) {
      if (!strcasecmp(val, "conf")) {
         q->timeoutpriority = TIMEOUT_PRIORITY_CONF;
      } else {
         q->timeoutpriority = TIMEOUT_PRIORITY_APP;
      }
   } 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 char* queue_show	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)			[static]

Definition at line 6520 of file app_queue.c.

References __queues_show(), ast_cli_args::argc, ast_cli_args::argv, CLI_GENERATE, CLI_INIT, ast_cli_entry::command, complete_queue_show(), ast_cli_args::fd, ast_cli_args::line, ast_cli_args::n, ast_cli_args::pos, ast_cli_entry::usage, and ast_cli_args::word.

{
   switch ( cmd ) {
   case CLI_INIT:
      e->command = "queue show";
      e->usage =
         "Usage: queue show\n"
         "       Provides summary information on a specified queue.\n";
      return NULL;
   case CLI_GENERATE:
      return complete_queue_show(a->line, a->word, a->pos, a->n); 
   }

   return __queues_show(NULL, a->fd, a->argc, a->argv);
}

static void queue_transfer_destroy

(

void *

data

)

[static]

Definition at line 3689 of file app_queue.c.

References ast_free.

{
   struct queue_transfer_ds *qtds = data;
   ast_free(qtds);
}

static void queue_transfer_fixup	(	void *	data,
		struct ast_channel *	old_chan,
		struct ast_channel *	new_chan
	)			[static]

Log an attended transfer when a queue caller channel is masqueraded.

When a caller is masqueraded, we want to log a transfer. Fixup time is the closest we can come to when the actual transfer occurs. This happens during the masquerade after datastores are moved from old_chan to new_chan. This is why new_chan is referenced for exten, context, and datastore information.

At the end of this, we want to remove the datastore so that this fixup function is not called on any future masquerades of the caller during the current call.

Definition at line 3712 of file app_queue.c.

References ast_channel_datastore_find(), ast_channel_datastore_remove(), ast_log(), ast_queue_log(), queue_transfer_ds::callcompletedinsl, queue_ent::chan, ast_channel::context, ast_channel::exten, LOG_WARNING, queue_transfer_ds::member, member::membername, call_queue::name, queue_ent::opos, queue_ent::parent, queue_transfer_ds::qe, queue_transfer_info, queue_ent::start, queue_transfer_ds::starttime, ast_channel::uniqueid, and update_queue().

{
   struct queue_transfer_ds *qtds = data;
   struct queue_ent *qe = qtds->qe;
   struct member *member = qtds->member;
   time_t callstart = qtds->starttime;
   int callcompletedinsl = qtds->callcompletedinsl;
   struct ast_datastore *datastore;

   ast_queue_log(qe->parent->name, qe->chan->uniqueid, member->membername, "TRANSFER", "%s|%s|%ld|%ld|%d",
            new_chan->exten, new_chan->context, (long) (callstart - qe->start),
            (long) (time(NULL) - callstart), qe->opos);

   update_queue(qe->parent, member, callcompletedinsl, (time(NULL) - callstart));
   
   /* No need to lock the channels because they are already locked in ast_do_masquerade */
   if ((datastore = ast_channel_datastore_find(old_chan, &queue_transfer_info, NULL))) {
      ast_channel_datastore_remove(old_chan, datastore);
   } else {
      ast_log(LOG_WARNING, "Can't find the queue_transfer datastore.\n");
   }
}

static struct call_queue* queue_unref

(

struct call_queue *

q

)

[static, read]

Definition at line 1045 of file app_queue.c.

References ao2_ref.

Referenced by __queues_show(), compare_weight(), complete_queue(), complete_queue_remove_member(), end_bridge_callback(), find_queue_by_name_rt(), get_member_penalty(), leave_queue(), manager_queues_status(), manager_queues_summary(), queue_function_qac(), queue_function_qac_dep(), queue_function_queuememberlist(), queue_function_queuewaitingcount(), queue_function_var(), reload_queue_members(), reload_single_queue(), remove_from_queue(), set_member_paused(), set_member_penalty(), and unload_module().

{
   ao2_ref(q, -1);
   return q;
}

static void recalc_holdtime	(	struct queue_ent *	qe,
		int	newholdtime
	)			[static]

Definition at line 2376 of file app_queue.c.

References ao2_lock(), ao2_unlock(), call_queue::holdtime, and queue_ent::parent.

Referenced by try_calling().

{
   int oldvalue;

   /* Calculate holdtime using an exponential average */
   /* 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 record_abandoned

(

struct queue_ent *

qe

)

[static]

Record that a caller gave up on waiting in queue.

Definition at line 2959 of file app_queue.c.

References ao2_lock(), ao2_unlock(), call_queue::callsabandoned, queue_ent::chan, EVENT_FLAG_AGENT, manager_event, call_queue::name, queue_ent::opos, queue_ent::parent, queue_ent::pos, set_queue_variables(), queue_ent::start, and ast_channel::uniqueid.

Referenced by queue_exec(), and try_calling().

{
   ao2_lock(qe->parent);
   set_queue_variables(qe->parent, qe->chan);
   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);
}

static int reload

(

void

)

[static]

Definition at line 7561 of file app_queue.c.

References AST_FLAGS_ALL, ast_unload_realtime(), and reload_handler().

{
   struct ast_flags mask = {AST_FLAGS_ALL,};
   ast_unload_realtime("queue_members");
   reload_handler(1, &mask, NULL);
   return 0;
}

static int reload_handler	(	int	reload,
		struct ast_flags *	mask,
		const char *	queuename
	)			[static]

The command center for all reload operations.

Whenever any piece of queue information is to be reloaded, this function is called. It interprets the flags set in the mask parameter and acts based on how they are set.

Parameters:

	reload	True if we are reloading information, false if we are loading information for the first time.
	mask	A bitmask which tells the handler what actions to take
	queuename	The name of the queue on which we wish to take action

Return values:

	0	All reloads were successful
	non-zero	There was a failure

Definition at line 6332 of file app_queue.c.

References ast_test_flag, clear_stats(), QUEUE_RELOAD_MEMBER, QUEUE_RELOAD_PARAMETERS, QUEUE_RELOAD_RULES, QUEUE_RESET_STATS, reload_queue_rules(), and reload_queues().

Referenced by handle_queue_reload(), handle_queue_reset(), load_module(), manager_queue_reload(), manager_queue_reset(), and reload().

{
   int res = 0;

   if (ast_test_flag(mask, QUEUE_RELOAD_RULES)) {
      res |= reload_queue_rules(reload);
   }
   if (ast_test_flag(mask, QUEUE_RESET_STATS)) {
      res |= clear_stats(queuename);
   }
   if (ast_test_flag(mask, (QUEUE_RELOAD_PARAMETERS | QUEUE_RELOAD_MEMBER))) {
      res |= reload_queues(reload, mask, queuename);
   }
   return res;
}

static void reload_queue_members

(

void

)

[static]

Reload dynamic queue members persisted into the astdb.

Definition at line 4944 of file app_queue.c.

References add_to_queue(), ao2_find, ao2_lock(), ao2_unlock(), ast_db_del(), ast_db_freetree(), ast_db_get(), ast_db_gettree(), ast_debug, ast_log(), ast_strlen_zero(), ERANGE, errno, member::interface, ast_db_entry::key, load_realtime_queue(), LOG_ERROR, LOG_NOTICE, LOG_WARNING, member::membername, call_queue::name, ast_db_entry::next, OBJ_POINTER, member::paused, member::penalty, PM_MAX_LEN, queue_unref(), queues, RES_OUTOFMEMORY, member::state_interface, and strsep().

Referenced by load_module().

{
   char *cur_ptr;
   const char *queue_name;
   char *member;
   char *interface;
   char *membername = NULL;
   char *state_interface;
   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, ";");
         state_interface = 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;
         }

         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, state_interface) == 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 reload_queue_rules

(

int

reload

)

[static]

Reload the rules defined in queuerules.conf.

Parameters:

reload

If 1, then only process queuerules.conf if the file has changed since the last time we inspected it.

Returns:

Always returns AST_MODULE_LOAD_SUCCESS

Definition at line 5931 of file app_queue.c.

References ast_calloc, ast_category_browse(), ast_config_destroy(), ast_config_load, ast_copy_string(), ast_free, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_REMOVE_HEAD, AST_LIST_UNLOCK, ast_log(), AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_SUCCESS, ast_variable_browse(), CONFIG_FLAG_FILEUNCHANGED, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEUNCHANGED, insert_penaltychange(), ast_variable::lineno, LOG_ERROR, LOG_NOTICE, LOG_WARNING, ast_variable::name, rule_list::name, ast_variable::next, rule_list::rules, and ast_variable::value.

Referenced by reload_handler().

{
   struct ast_config *cfg;
   struct rule_list *rl_iter, *new_rl;
   struct penalty_rule *pr_iter;
   char *rulecat = NULL;
   struct ast_variable *rulevar = NULL;
   struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
   
   if (!(cfg = ast_config_load("queuerules.conf", config_flags))) {
      ast_log(LOG_NOTICE, "No queuerules.conf file found, queues will not follow penalty rules\n");
      return AST_MODULE_LOAD_SUCCESS;
   } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
      ast_log(LOG_NOTICE, "queuerules.conf has not changed since it was last loaded. Not taking any action.\n");
      return AST_MODULE_LOAD_SUCCESS;
   } else if (cfg == CONFIG_STATUS_FILEINVALID) {
      ast_log(LOG_ERROR, "Config file queuerules.conf is in an invalid format.  Aborting.\n");
      return AST_MODULE_LOAD_SUCCESS;
   }

   AST_LIST_LOCK(&rule_lists);
   while ((rl_iter = AST_LIST_REMOVE_HEAD(&rule_lists, list))) {
      while ((pr_iter = AST_LIST_REMOVE_HEAD(&rl_iter->rules, list)))
         ast_free(pr_iter);
      ast_free(rl_iter);
   }
   while ((rulecat = ast_category_browse(cfg, rulecat))) {
      if (!(new_rl = ast_calloc(1, sizeof(*new_rl)))) {
         AST_LIST_UNLOCK(&rule_lists);
         return AST_MODULE_LOAD_FAILURE;
      } else {
         ast_copy_string(new_rl->name, rulecat, sizeof(new_rl->name));
         AST_LIST_INSERT_TAIL(&rule_lists, new_rl, list);
         for (rulevar = ast_variable_browse(cfg, rulecat); rulevar; rulevar = rulevar->next)
            if(!strcasecmp(rulevar->name, "penaltychange"))
               insert_penaltychange(new_rl->name, rulevar->value, rulevar->lineno);
            else
               ast_log(LOG_WARNING, "Don't know how to handle rule type '%s' on line %d\n", rulevar->name, rulevar->lineno);
      }
   }
   AST_LIST_UNLOCK(&rule_lists);

   ast_config_destroy(cfg);

   return AST_MODULE_LOAD_SUCCESS;
}

static int reload_queues	(	int	reload,
		struct ast_flags *	mask,
		const char *	queuename
	)			[static]

reload the queues.conf file

This function reloads the information in the general section of the queues.conf file and potentially more, depending on the value of mask.

Parameters:

	reload	0 if we are calling this the first time, 1 every other time
	mask	Gives flags telling us what information to actually reload
	queuename	If set to a non-zero string, then only reload information from that particular queue. Otherwise inspect all queues

Return values:

	-1	Failure occurred
	0	All clear!

Definition at line 6245 of file app_queue.c.

References ao2_callback, ao2_lock(), ao2_unlock(), ast_category_browse(), ast_config_destroy(), ast_config_load, ast_log(), ast_strlen_zero(), ast_test_flag, CONFIG_FLAG_FILEUNCHANGED, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEUNCHANGED, kill_dead_queues(), LOG_ERROR, LOG_NOTICE, mark_dead_and_unfound(), OBJ_MULTIPLE, OBJ_NODATA, OBJ_UNLINK, QUEUE_RELOAD_PARAMETERS, queue_set_global_params(), queues, and reload_single_queue().

Referenced by reload_handler().

{
   struct ast_config *cfg;
   char *cat;
   struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
   const int queue_reload = ast_test_flag(mask, QUEUE_RELOAD_PARAMETERS);

   if (!(cfg = ast_config_load("queues.conf", config_flags))) {
      ast_log(LOG_NOTICE, "No call queueing config file (queues.conf), so no call queues\n");
      return -1;
   } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
      return 0;
   } else if (cfg == CONFIG_STATUS_FILEINVALID) {
      ast_log(LOG_ERROR, "Config file queues.conf is in an invalid format.  Aborting.\n");
      return -1;
   }

   /* We've made it here, so it looks like we're doing operations on all queues. */
   ao2_lock(queues);
   
   /* Mark all queues as dead for the moment if we're reloading queues.
    * For clarity, we could just be reloading members, in which case we don't want to mess
    * with the other queue parameters at all*/
   if (queue_reload) {
      ao2_callback(queues, OBJ_NODATA, mark_dead_and_unfound, (char *) queuename);
   }

   /* Chug through config file */
   cat = NULL;
   while ((cat = ast_category_browse(cfg, cat)) ) {
      if (!strcasecmp(cat, "general") && queue_reload) {
         queue_set_global_params(cfg);
         continue;
      }
      if (ast_strlen_zero(queuename) || !strcasecmp(cat, queuename))
         reload_single_queue(cfg, mask, cat);
   }

   ast_config_destroy(cfg);
   /* Unref all the dead queues if we were reloading queues */
   if (queue_reload) {
      ao2_callback(queues, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, kill_dead_queues, (char *) queuename);
   }
   ao2_unlock(queues);
   return 0;
}

static void reload_single_member	(	const char *	memberdata,
		struct call_queue *	q
	)			[static]

reload information pertaining to a single member

This function is called when a member = line is encountered in queues.conf.

Parameters:

	memberdata	The part after member = in the config file
	q	The queue to which this member belongs

Definition at line 6009 of file app_queue.c.

References ao2_find, ao2_link, ao2_ref, AST_APP_ARG, ast_copy_string(), AST_DECLARE_APP_ARGS, ast_log(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strip(), ast_strlen_zero(), create_queue_member(), member::interface, LOG_WARNING, call_queue::membercount, call_queue::members, OBJ_POINTER, OBJ_UNLINK, parse(), member::paused, and member::penalty.

Referenced by reload_single_queue().

{
   char *membername, *interface, *state_interface, *tmp;
   char *parse;
   struct member *cur, *newm;
   struct member tmpmem;
   int penalty;
   AST_DECLARE_APP_ARGS(args,
      AST_APP_ARG(interface);
      AST_APP_ARG(penalty);
      AST_APP_ARG(membername);
      AST_APP_ARG(state_interface);
   );

   if (ast_strlen_zero(memberdata)) {
      ast_log(LOG_WARNING, "Empty queue member definition. Moving on!\n");
      return;
   }

   /* Add a new member */
   parse = ast_strdupa(memberdata);
            
   AST_STANDARD_APP_ARGS(args, parse);

   interface = args.interface;
   if (!ast_strlen_zero(args.penalty)) {
      tmp = args.penalty;
      ast_strip(tmp);
      penalty = atoi(tmp);
      if (penalty < 0) {
         penalty = 0;
      }
   } else {
      penalty = 0;
   }

   if (!ast_strlen_zero(args.membername)) {
      membername = args.membername;
      ast_strip(membername);
   } else {
      membername = interface;
   }

   if (!ast_strlen_zero(args.state_interface)) {
      state_interface = args.state_interface;
      ast_strip(state_interface);
   } else {
      state_interface = interface;
   }

   /* Find the old position in the list */
   ast_copy_string(tmpmem.interface, interface, sizeof(tmpmem.interface));
   cur = ao2_find(q->members, &tmpmem, OBJ_POINTER | OBJ_UNLINK);
   if ((newm = create_queue_member(interface, membername, penalty, cur ? cur->paused : 0, state_interface))) {
      ao2_link(q->members, newm);
      ao2_ref(newm, -1);
   }
   newm = NULL;

   if (cur) {
      ao2_ref(cur, -1);
   } else {
      q->membercount++;
   }
}

static void reload_single_queue	(	struct ast_config *	cfg,
		struct ast_flags *	mask,
		const char *	queuename
	)			[static]

Reload information pertaining to a particular queue.

Once we have isolated a queue within reload_queues, we call this. This will either reload information for the queue or if we're just reloading member information, we'll just reload that without touching other settings within the queue

Parameters:

	cfg	The configuration which we are reading
	mask	Tells us what information we need to reload
	queuename	The name of the queue we are reloading information from

Return values:

void

Definition at line 6115 of file app_queue.c.

References alloc_queue(), ao2_callback, ao2_find, ao2_link, ao2_lock(), ao2_unlock(), ast_atomic_fetchadd_int(), ast_log(), ast_test_flag, ast_variable_browse(), ast_variable_retrieve(), call_queue::found, init_queue(), kill_dead_members(), ast_variable::lineno, LOG_WARNING, mark_member_dead(), call_queue::membercount, call_queue::members, ast_variable::name, call_queue::name, ast_variable::next, OBJ_MULTIPLE, OBJ_NODATA, OBJ_POINTER, OBJ_UNLINK, QUEUE_RELOAD_MEMBER, QUEUE_RELOAD_PARAMETERS, queue_set_param(), QUEUE_STRATEGY_RINGALL, queue_unref(), queues, reload_single_member(), strat2int(), call_queue::strategy, ast_variable::value, var, and call_queue::weight.

Referenced by reload_queues().

{
   int new;
   struct call_queue *q = NULL;
   /*We're defining a queue*/
   struct call_queue tmpq = {
      .name = queuename,
   };
   const char *tmpvar;
   const int queue_reload = ast_test_flag(mask, QUEUE_RELOAD_PARAMETERS);
   const int member_reload = ast_test_flag(mask, QUEUE_RELOAD_MEMBER);
   int prev_weight = 0;
   struct ast_variable *var;
   if (!(q = ao2_find(queues, &tmpq, OBJ_POINTER))) {
      if (queue_reload) {
         /* Make one then */
         if (!(q = alloc_queue(queuename))) {
            return;
         }
      } else {
         /* Since we're not reloading queues, this means that we found a queue
          * in the configuration file which we don't know about yet. Just return.
          */
         return;
      }
      new = 1;
   } else {
      new = 0;
   }
   
   if (!new) {
      ao2_lock(q);
      prev_weight = q->weight ? 1 : 0;
   }
   /* Check if we already found a queue with this name in the config file */
   if (q->found) {
      ast_log(LOG_WARNING, "Queue '%s' already defined! Skipping!\n", queuename);
      if (!new) {
         /* It should be impossible to *not* hit this case*/
         ao2_unlock(q);
      }
      queue_unref(q);
      return;
   }
   /* Due to the fact that the "linear" strategy will have a different allocation
    * scheme for queue members, we must devise the queue's strategy before other initializations.
    * To be specific, the linear strategy needs to function like a linked list, meaning the ao2
    * container used will have only a single bucket instead of the typical number.
    */
   if (queue_reload) {
      if ((tmpvar = ast_variable_retrieve(cfg, queuename, "strategy"))) {
         q->strategy = strat2int(tmpvar);
         if (q->strategy < 0) {
            ast_log(LOG_WARNING, "'%s' isn't a valid strategy for queue '%s', using ringall instead\n",
            tmpvar, q->name);
            q->strategy = QUEUE_STRATEGY_RINGALL;
         }
      } else {
         q->strategy = QUEUE_STRATEGY_RINGALL;
      }
      init_queue(q);
   }
   if (member_reload) {
      q->membercount = 0;
      ao2_callback(q->members, OBJ_NODATA, mark_member_dead, NULL);
   }
   for (var = ast_variable_browse(cfg, queuename); var; var = var->next) {
      if (member_reload && !strcasecmp(var->name, "member")) {
         reload_single_member(var->value, q);
      } else if (queue_reload) {
         queue_set_param(q, var->name, var->value, var->lineno, 1);
      }
   }
   /* At this point, we've determined if the queue has a weight, so update use_weight
    * as appropriate
    */
   if (!q->weight && prev_weight) {
      ast_atomic_fetchadd_int(&use_weight, -1);
   }
   else if (q->weight && !prev_weight) {
      ast_atomic_fetchadd_int(&use_weight, +1);
   }

   /* Free remaining members marked as delme */
   if (member_reload) {
      ao2_callback(q->members, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, kill_dead_members, q);
   }

   if (new) {
      ao2_link(queues, q);
   } else {
      ao2_unlock(q);
   }
   queue_unref(q);
}

static int remove_from_queue	(	const char *	queuename,
		const char *	interface
	)			[static]

Remove member from queue.

Return values:

	RES_NOT_DYNAMIC	when they aren't a RT member
	RES_NOSUCHQUEUE	queue does not exist
	RES_OKAY	removed member from queue
	RES_EXISTS	queue exists but no members

Definition at line 4681 of file app_queue.c.

References ao2_find, ao2_lock(), ao2_ref, ao2_unlink, ao2_unlock(), ast_copy_string(), dump_queue_members(), member::dynamic, EVENT_FLAG_AGENT, member::interface, manager_event, call_queue::membercount, member::membername, call_queue::members, call_queue::name, OBJ_POINTER, queue_unref(), queues, RES_EXISTS, RES_NOSUCHQUEUE, RES_NOT_DYNAMIC, and RES_OKAY.

Referenced by attempt_thread(), handle_queue_remove_member(), manager_remove_queue_member(), rqm_exec(), and scan_service().

{
   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(queues);
      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);
            queue_unref(q);
            ao2_unlock(queues);
            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);
      ao2_unlock(queues);
      queue_unref(q);
   }

   return res;
}

static int ring_entry	(	struct queue_ent *	qe,
		struct callattempt *	tmp,
		int *	busies
	)			[static]

Part 2 of ring_one.

Does error checking before attempting to request a channel and call a member. This function is only called from ring_one(). Failure can occur if:

• Agent on call
• Agent is paused
• Wrapup time not expired
• Priority by another queue

Return values:

	1	on success to reach a free agent
	0	on failure to get agent.

Definition at line 2622 of file app_queue.c.

References ast_cdr::accountcode, ast_channel::adsicpe, ast_cdr::amaflags, ast_party_connected_line::ani, ao2_lock(), ao2_unlock(), ast_channel::appl, ast_call(), ast_cdr_busy(), ast_cdr_isset_unanswered(), ast_cdr_setdestchan(), ast_channel_datastore_inherit(), ast_channel_inherit_variables(), ast_channel_lock, ast_channel_trylock, ast_channel_unlock, ast_connected_line_copy_from_caller(), ast_copy_string(), ast_debug, AST_DEVICE_NOT_INUSE, AST_DEVICE_UNKNOWN, AST_FLAG_ANSWERED_ELSEWHERE, ast_free, ast_party_redirecting_copy(), ast_request(), ast_set_callerid(), ast_set_flag, ast_strdup, ast_string_field_set, ast_strlen_zero(), ast_verb, queue_ent::cancel_answered_elsewhere, ast_channel::cdr, callattempt::chan, queue_ent::chan, ast_cdr::channel, CHANNEL_DEADLOCK_AVOIDANCE, ast_channel::cid, ast_callerid::cid_dnid, ast_callerid::cid_name, ast_callerid::cid_num, ast_callerid::cid_pres, ast_callerid::cid_rdnis, ast_callerid::cid_tns, ast_cdr::clid, compare_weight(), ast_channel::connected, ast_channel::context, ast_channel::data, ast_cdr::dcontext, dialcontext, do_hang(), ast_cdr::dst, EVENT_FLAG_AGENT, call_queue::eventwhencalled, ast_channel::exten, ast_party_connected_line::id, callattempt::interface, ast_cdr::lastapp, callattempt::lastcall, ast_cdr::lastdata, callattempt::lastqueue, queue_ent::linpos, ast_channel::macroexten, manager_event, callattempt::member, member::membername, ast_channel::name, ast_party_id::name, call_queue::name, ast_channel::nativeformats, ast_party_id::number, ast_party_id::number_presentation, queue_ent::parent, member::paused, pbx_builtin_getvar_helper(), ast_channel::priority, QUEUE_EVENT_VARIABLES, ast_channel::redirecting, call_queue::ringinuse, call_queue::rrpos, S_OR, ast_cdr::src, member::state_interface, member::status, status, callattempt::stillgoing, ast_channel::uniqueid, callattempt::update_connectedline, update_status(), ast_cdr::userfield, vars2manager(), ast_channel::whentohangup, and call_queue::wrapuptime.

Referenced by ring_one().

{
   int res;
   int status;
   char tech[256];
   char *location;
   const char *macrocontext, *macroexten;

   /* 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, qe->chan, 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; 

      ao2_lock(qe->parent);
      update_status(qe->parent, tmp->member, ast_device_state(tmp->member->state_interface));
      qe->parent->rrpos++;
      qe->linpos++;
      ao2_unlock(qe->parent);

      (*busies)++;
      return 0;
   }

   ast_channel_lock(tmp->chan);
   while (ast_channel_trylock(qe->chan)) {
      CHANNEL_DEADLOCK_AVOIDANCE(tmp->chan);
   }

   if (qe->cancel_answered_elsewhere) {
      ast_set_flag(tmp->chan, AST_FLAG_ANSWERED_ELSEWHERE);
   }
   tmp->chan->appl = "AppQueue";
   tmp->chan->data = "(Outgoing Line)";
   memset(&tmp->chan->whentohangup, 0, sizeof(tmp->chan->whentohangup));

   /* If the new channel has no callerid, try to guess what it should be */
   if (ast_strlen_zero(tmp->chan->cid.cid_num)) {
      if (!ast_strlen_zero(qe->chan->connected.id.number)) {
         ast_set_callerid(tmp->chan, qe->chan->connected.id.number, qe->chan->connected.id.name, qe->chan->connected.ani);
         tmp->chan->cid.cid_pres = qe->chan->connected.id.number_presentation;
      } else if (!ast_strlen_zero(qe->chan->cid.cid_dnid)) {
         ast_set_callerid(tmp->chan, qe->chan->cid.cid_dnid, NULL, NULL);
      } else if (!ast_strlen_zero(S_OR(qe->chan->macroexten, qe->chan->exten))) {
         ast_set_callerid(tmp->chan, S_OR(qe->chan->macroexten, qe->chan->exten), NULL, NULL); 
      }
      tmp->update_connectedline = 0;
   }

   if (tmp->chan->cid.cid_rdnis)
      ast_free(tmp->chan->cid.cid_rdnis);
   tmp->chan->cid.cid_rdnis = ast_strdup(qe->chan->cid.cid_rdnis);
   ast_party_redirecting_copy(&tmp->chan->redirecting, &qe->chan->redirecting);

   tmp->chan->cid.cid_tns = qe->chan->cid.cid_tns;

   ast_connected_line_copy_from_caller(&tmp->chan->connected, &qe->chan->cid);

   /* Inherit specially named variables from parent channel */
   ast_channel_inherit_variables(qe->chan, tmp->chan);
   ast_channel_datastore_inherit(qe->chan, tmp->chan);

   /* Presense of ADSI CPE on outgoing channel follows ours */
   tmp->chan->adsicpe = qe->chan->adsicpe;

   /* Inherit context and extension */
   macrocontext = pbx_builtin_getvar_helper(qe->chan, "MACRO_CONTEXT");
   ast_string_field_set(tmp->chan, dialcontext, ast_strlen_zero(macrocontext) ? qe->chan->context : macrocontext);
   macroexten = pbx_builtin_getvar_helper(qe->chan, "MACRO_EXTEN");
   if (!ast_strlen_zero(macroexten))
      ast_copy_string(tmp->chan->exten, macroexten, sizeof(tmp->chan->exten));
   else
      ast_copy_string(tmp->chan->exten, qe->chan->exten, sizeof(tmp->chan->exten));
   if (ast_cdr_isset_unanswered()) {
      /* they want to see the unanswered dial attempts! */
      /* set up the CDR fields on all the CDRs to give sensical information */
      ast_cdr_setdestchan(tmp->chan->cdr, tmp->chan->name);
      strcpy(tmp->chan->cdr->clid, qe->chan->cdr->clid);
      strcpy(tmp->chan->cdr->channel, qe->chan->cdr->channel);
      strcpy(tmp->chan->cdr->src, qe->chan->cdr->src);
      strcpy(tmp->chan->cdr->dst, qe->chan->exten);
      strcpy(tmp->chan->cdr->dcontext, qe->chan->context);
      strcpy(tmp->chan->cdr->lastapp, qe->chan->cdr->lastapp);
      strcpy(tmp->chan->cdr->lastdata, qe->chan->cdr->lastdata);
      tmp->chan->cdr->amaflags = qe->chan->cdr->amaflags;
      strcpy(tmp->chan->cdr->accountcode, qe->chan->cdr->accountcode);
      strcpy(tmp->chan->cdr->userfield, qe->chan->cdr->userfield);
   }

   /* 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);
      ast_channel_unlock(tmp->chan);
      ast_channel_unlock(qe->chan);
      do_hang(tmp);
      (*busies)++;
      update_status(qe->parent, tmp->member, ast_device_state(tmp->member->state_interface));
      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"
               "Uniqueid: %s\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->chan->uniqueid,
               qe->parent->eventwhencalled == QUEUE_EVENT_VARIABLES ? vars2manager(qe->chan, vars, sizeof(vars)) : "");
      ast_verb(3, "Called %s\n", tmp->interface);
   }
   ast_channel_unlock(tmp->chan);
   ast_channel_unlock(qe->chan);

   update_status(qe->parent, tmp->member, ast_device_state(tmp->member->state_interface));
   return 1;
}

static int ring_one	(	struct queue_ent *	qe,
		struct callattempt *	outgoing,
		int *	busies
	)			[static]

Place a call to a queue member.

Once metrics have been calculated for each member, this function is used to place a call to the appropriate member (or members). The low-level channel-handling and error detection is handled in ring_entry

Return values:

	1	if a member was called successfully
	0	otherwise

Definition at line 2821 of file app_queue.c.

References ast_debug, callattempt::chan, queue_ent::expire, find_best(), callattempt::interface, callattempt::metric, queue_ent::parent, callattempt::q_next, QUEUE_STRATEGY_RINGALL, ring_entry(), callattempt::stillgoing, and call_queue::strategy.

Referenced by try_calling(), and wait_for_answer().

{
   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);
               ret |= ring_entry(qe, cur, busies);
            }
         }
      } else {
         /* Ring just the best channel */
         ast_debug(1, "Trying '%s' with metric %d\n", best->interface, best->metric);
         ret = ring_entry(qe, best, busies);
      }
      
      /* If we have timed out, break out */
      if (qe->expire && (time(NULL) >= qe->expire)) {
         ast_debug(1, "Queue timed out while ringing members.\n");
         ret = 0;
         break;
      }
   }

   return ret;
}

static void rna	(	int	rnatime,
		struct queue_ent *	qe,
		char *	interface,
		char *	membername,
		int	pause
	)			[static]

RNA == Ring No Answer. Common code that is executed when we try a queue member and they don't answer.

Definition at line 2976 of file app_queue.c.

References ast_queue_log(), ast_verb, call_queue::autopause, queue_ent::chan, EVENT_FLAG_AGENT, call_queue::eventwhencalled, manager_event, ast_channel::name, call_queue::name, queue_ent::parent, QUEUE_EVENT_VARIABLES, set_member_paused(), ast_channel::uniqueid, and vars2manager().

Referenced by wait_for_answer().

{
   ast_verb(3, "Nobody picked up in %d ms\n", rnatime);
   if (qe->parent->eventwhencalled) {
      char vars[2048];

      manager_event(EVENT_FLAG_AGENT, "AgentRingNoAnswer",
                  "Queue: %s\r\n"
                  "Uniqueid: %s\r\n"
                  "Channel: %s\r\n"
                  "Member: %s\r\n"
                  "MemberName: %s\r\n"
                  "Ringtime: %d\r\n"
                  "%s",
                  qe->parent->name,
                  qe->chan->uniqueid,
                  qe->chan->name,
                  interface,
                  membername,
                  rnatime,
                  qe->parent->eventwhencalled == QUEUE_EVENT_VARIABLES ? vars2manager(qe->chan, vars, sizeof(vars)) : "");
   }
   ast_queue_log(qe->parent->name, qe->chan->uniqueid, membername, "RINGNOANSWER", "%d", rnatime);
   if (qe->parent->autopause && pause) {
      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;
}

static int rqm_exec	(	struct ast_channel *	chan,
		const char *	data
	)			[static]

RemoveQueueMember application.

Definition at line 5113 of file app_queue.c.

References AST_APP_ARG, ast_debug, AST_DECLARE_APP_ARGS, ast_log(), ast_queue_log(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), LOG_NOTICE, LOG_WARNING, ast_channel::name, parse(), pbx_builtin_setvar_helper(), remove_from_queue(), RES_EXISTS, RES_NOSUCHQUEUE, RES_NOT_DYNAMIC, RES_OKAY, and ast_channel::uniqueid.

Referenced by load_module().

{
   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';
   }

   ast_debug(1, "queue: %s, member: %s\n", args.queuename, args.interface);

   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 void rt_handle_member_record	(	struct call_queue *	q,
		char *	interface,
		const char *	rt_uniqueid,
		const char *	membername,
		const char *	penalty_str,
		const char *	paused_str,
		const char *	state_interface
	)			[static]

Find rt member record to update otherwise create one.

Search for member in queue, if found update penalty/paused state, if no memeber exists create one flag it as a RT member and add to queue member list.

Definition at line 1725 of file app_queue.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_link, ao2_ref, ast_copy_string(), ast_queue_log(), create_queue_member(), member::dead, member::interface, call_queue::membercount, call_queue::members, call_queue::name, member::paused, member::penalty, member::realtime, member::rt_uniqueid, and member::state_interface.

Referenced by find_queue_by_name_rt(), and update_realtime_members().

{
   struct member *m;
   struct ao2_iterator mem_iter;
   int penalty = 0;
   int paused  = 0;
   int found = 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 member by realtime uniqueid and update */
   mem_iter = ao2_iterator_init(q->members, 0);
   while ((m = ao2_iterator_next(&mem_iter))) {
      if (!strcasecmp(m->rt_